Project

General

Profile

1
#!/bin/bash -e
2
set -o errexit -o pipefail # errexit in case caller's #! line missing -e
3

    
4
if test ! "$_util_sh_include_guard_utils"; then
5
_util_sh_include_guard_utils=1
6

    
7
isset() { test "${!1+isset}"; }
8

    
9
realpath() { readlink -f -- "$1"; }
10

    
11
str2varname() { echo "${1//[^a-zA-Z0-9_]/_}"; }
12

    
13
include_guard_var() { str2varname "$(realpath "$1")"; }
14

    
15
self_not_included() # usage: if self_not_included; then ... fi
16
{
17
	test $# -ge 1 || set -- "${BASH_SOURCE[1]}"
18
	local include_guard="$(include_guard_var "$1")"
19
	alias self_being_included=false
20
	! isset "$include_guard" && \
21
	{ eval "$include_guard"=1; alias self_being_included=true; }
22
}
23

    
24
# to load newly-defined aliases for use in functions in the same file:
25
## fi # load new aliases
26
## if self_being_included; then
27
# this is needed because aliases defined inside an if statement are not
28
# available inside that if statement
29

    
30
fi
31

    
32

    
33
if self_not_included "${BASH_SOURCE[0]}"; then
34

    
35

    
36
#### options
37

    
38
shopt -s expand_aliases
39

    
40

    
41
#### vars
42

    
43
set_var() { eval "$1"'="$2"'; }
44

    
45
set_default() { if ! isset "$1"; then set_var "$@"; fi; }
46

    
47
set_inv() { set_var no_"$1" "$(test "${!1}" || echo 1)"; }
48

    
49
# usage: local var=...; local_inv
50
alias local_inv='declare "no_$var=$(test "${!var}" || echo 1)"'
51

    
52
unexport() { export -n "$@"; }
53
	# `declare +x` won't work because it defines the var if it isn't set
54

    
55
alias local_export='declare -x' # combines effects of local and export
56

    
57
get_prefix_vars() { : "${prefix:?}"; eval echo '${!'$prefix'*}'; }
58

    
59
# usage: local prefix=..._; import_vars
60
# when used inside another alias 2+ levels deep, *must* be run inside a function
61
alias import_vars="$(cat <<'EOF'
62
: "${prefix:?}"
63
declare src_var dest_var
64
for src_var in $(get_prefix_vars); do
65
	dest_var="${src_var#$prefix}"
66
	declare "$dest_var=${!src_var}"; echo_vars "$dest_var"
67
done
68
EOF
69
)"
70

    
71

    
72
#### caching
73

    
74
## shell-variable-based caching
75

    
76
# usage: local cache_key=...; load_cache; \
77
# if ! cached; then save_cache value || return; fi; echo_cached_value
78
# cache_key for function inputs: "$(declare -p kw_param...) $*"
79
alias load_cache='declare cache_var="$(str2varname "${FUNCNAME}___$cache_key")"'
80
alias cached='isset "$cache_var"'
81
alias save_cache='set_var "$cache_var"'
82
alias echo_cached_value='echo "${!cache_var}"'
83

    
84
clear_cache() # usage: func=... clear_cache
85
{ : "${func:?}"; unset $(prefix="${func}___" get_prefix_vars); }
86

    
87
fi # load new aliases
88
if self_being_included; then
89

    
90

    
91
#### aliases
92

    
93
unalias() { builtin unalias "$@" 2>&- || true; } # no error if undefined
94

    
95
# usage: alias alias_='var=value run_cmd '
96
function run_cmd() { "$@"; }
97
alias run_cmd='"run_cmd" ' # last space alias-expands next word
98

    
99

    
100
#### functions
101

    
102
kw_params() # usage: func() { kw_params param_var...; }; ...; param_var=... cmd
103
# removes keyword-param-only vars from the environment
104
{ unexport "$@"; }
105

    
106
alias self='command "$FUNCNAME"' # usage: wrapper() { self ...; }
107

    
108

    
109
#### exceptions
110

    
111
# usage: cmd || { save_e; ...; rethrow; }
112
alias export_e='e=$?'
113
alias save_e='declare e=$?'
114
alias rethrow='return "$e"'
115
alias rethrow_subshell='exit "$e"'
116

    
117
fi # load new aliases
118
if self_being_included; then
119

    
120
# usage: try cmd...; ignore_e status; if catch status; then ...; fi; end_try
121

    
122
function try() { e=0; benign_error=1 "$@" || { export_e; true; }; }
123
alias try='declare e; "try" ' # last space alias-expands next word
124

    
125
catch() { test "$e" -eq "$1" && e=0; }
126

    
127
ignore_e() { catch "$@" || true; }
128

    
129
alias end_try='rethrow'
130
alias end_try_subshell='rethrow_subshell'
131

    
132
ignore() { save_e; ignore_e "$@"; rethrow; } # usage: try cmd || ignore status
133

    
134
### signals
135

    
136
sig_e() { echo $(( 128+$(kill -l "$1") )); } # usage: sig_e SIGINT, etc.
137

    
138
ignore_sig() { ignore "$(sig_e "$1")"; }
139

    
140
# usage: piped_cmd cmd1...|cmd2... (which doesn't read all its input)
141
function piped_cmd() { "$@" || ignore_sig SIGPIPE; }
142
alias piped_cmd='"piped_cmd" ' # last space alias-expands next word
143

    
144
fi # load new aliases
145
if self_being_included; then
146

    
147

    
148
#### integers
149

    
150
let!() { let "$@" || true; } # always returns true; safe to use for setting
151
	# "If the last ARG evaluates to 0, let returns 1" (`help let`)
152

    
153
bool2int() { try test ! "$1"; echo "$e"; } # empty->0; non-empty->1
154

    
155
int2bool() { (( "$1" != 0 )); }
156

    
157

    
158
#### floats
159

    
160
int_part() { echo "${1%%.*}"; }
161

    
162
dec_suffix() { echo "${1#$(int_part "$1")}"; }
163

    
164
round_down() { int_part "$1"; }
165

    
166
float+int() { echo "$(($(int_part "$1")+$2))$(dec_suffix "$1")"; }
167

    
168
float_set_min() { if (($(int_part $1) >= $2)); then echo $1; else echo $2; fi; }
169

    
170

    
171
#### strings
172

    
173
repeat() # usage: str=... n=... repeat
174
{
175
	: "${str?}" "${n:?}"; local result= n="$n" # n will be modified in function
176
	for (( ; n > 0; n-- )); do result="$result$str"; done
177
	echo "$result"
178
}
179

    
180
sed_cmd="sed -`case "$(uname)" in Darwin) echo E;; *) echo r;; esac`"
181
alias sed="$sed_cmd"
182

    
183
fi # load new aliases
184
if self_being_included; then
185

    
186
rtrim() { log+ 3; sed 's/[[:space:]]+$//' <<<"$1"; }
187

    
188

    
189
#### arrays
190

    
191
join() { local IFS="$delim"; echo "$*"; } # usage: delim=... join elems...
192

    
193
reverse() # usage: array=($(reverse args...))
194
{
195
	local i
196
	for (( i=$#; i > 0; i-- )); do printf '%q ' "${!i}"; done
197
}
198

    
199
contains() # usage: contains value in_array...
200
{
201
	local value="$1"; shift
202
	local elem
203
	for elem in "$@"; do if test "$elem" = "$value"; then return 0; fi; done
204
	return 1
205
}
206

    
207

    
208
#### verbose output
209

    
210

    
211
err_fd=2 # stderr
212

    
213
usage() { echo "Usage: $1" >&2; return 2; }
214

    
215

    
216
### log++
217

    
218
log_fd=2 # initially stderr
219

    
220
if test "$explicit_errors_only"; then verbosity=0; fi # hide startup logging
221

    
222
# set verbosity
223
if isset verbose; then : "${verbosity:=$(bool2int "$verbose")}"; fi
224
if isset vb; then : "${verbosity:=$vb}"; fi
225
: "${verbosity=1}" # default
226
: "${verbosity:=0}" # ensure non-empty
227
export verbosity # propagate to invoked commands
228
export PS4 # follows verbosity, so also propagate this
229

    
230
# set log_level
231
: "${log_level=$(( ${#PS4}-1 ))}" # defaults to # non-space symbols in PS4
232
export log_level # propagate to invoked commands
233

    
234
verbosity_int() { round_down "$verbosity"; }
235

    
236
# verbosities (and `make` equivalents):
237
# 0: just print errors. useful for cron jobs.
238
#    vs. make: equivalent to --silent, but suppresses external command output
239
# 1: also external commands run. useful for running at the command line.
240
#    vs. make: not provided (but sorely needed to avoid excessive output)
241
# 2: full graphical call tree. useful for determining where error occurred.
242
#    vs. make: equivalent to default verbosity, but with much-needed indents
243
# 3: also values of kw params and variables. useful for low-level debugging.
244
#    vs. make: not provided; need to manually use $(error $(var))
245
# 4: also variables in util.sh commands. useful for debugging util.sh.
246
#    vs. make: somewhat similar to --print-data-base
247
# 5: also variables in logging commands themselves. useful for debugging echo_*.
248
#    vs. make: not provided; need to search Makefile for @ at beginning of cmd
249
# 6+: not currently used (i.e. same as 5)
250

    
251
# definition: the log_level is the minimum verbosity needed to display a message
252
# for messages that use can_log(), the log_level starts with *1*, not 0
253
# for unfiltered messages, the log_level is 0 (i.e. still output at verbosity=0)
254
# to view a message's log_level, count the # of + signs before it in the output
255

    
256
fi # load new aliases
257
if self_being_included; then
258

    
259
# usage: in func:      log++; ...         OR  log_local; "log++"; ...
260
#        outside func: log++; ...; log--
261
#        before cmd:   log++ cmd...
262
# without a cmd, "$@" expands to nothing and assignments are applied to caller
263
# "${@:2}" expands to all of $@ after *1st* arg, not 2nd ($@ indexes start at 1)
264
log+()
265
{
266
	# no local vars because w/o cmd, assignments should be applied to caller
267
	PS4="$(str="${PS4:0:1}" n=$((log_level+$1-1)) repeat)${PS4: -2}"; \
268
	log_level=$((log_level+$1)) \
269
	verbosity="$(float+int "$verbosity" "-$1")" "${@:2}"
270
}
271
log++() { log+  1 "$@"; }
272
log--() { log+ -1 "$@"; }
273
alias log_local=\
274
'declare PS4="$PS4" log_level="$log_level" verbosity="$verbosity"'
275
alias log+='log_local; "log+"' # don't expand next word because it's not a cmd
276
alias log++='log_local; "log++" ' # last space alias-expands next word
277
alias log--='log_local; "log--" ' # last space alias-expands next word
278

    
279
verbosity_min() # usage: verbosity_min min
280
{ if test "$(verbosity_int)" -lt "$1"; then verbosity="$1"; fi; }
281
alias verbosity_min='log_local; "verbosity_min"'
282

    
283

    
284
# indent for call tree. this is *not* the log_level (below).
285
: "${log_indent_step=| }" "${log_indent=}"
286
export log_indent_step log_indent # propagate to invoked commands
287

    
288
__caller_indent='log_indent="$log_indent$log_indent_step"'
289
alias caller_indent="$__caller_indent"
290
alias indent="declare $__caller_indent"
291

    
292

    
293
fi # load new aliases
294
if self_being_included; then
295

    
296
can_log() { test "$(verbosity_int)" -gt 0; }
297
	# verbosity=0 turns off all logging
298

    
299
log() { if can_log; then echo "$log_indent$PS4$1" >&"$log_fd"; fi; }
300

    
301
log_custom() # usage: symbol=... log_custom msg
302
{ log_indent="${log_indent//[^ ]/$symbol}" PS4="${PS4//[^ ]/$symbol}" log "$@";}
303

    
304
log_err() { symbol='#' verbosity=1 log_fd="$err_fd" log_custom "$@"; }
305

    
306
log_info() { symbol=: log_custom "$@"; }
307

    
308
die() # usage: cmd || [type=...] die msg (msg can use $? but not $())
309
{ save_e; kw_params type; "log_${type:-err}" "$1"; rethrow; }
310

    
311
die_e() # usage: cmd || [benign_error=1] die_e [|| handle error]
312
{
313
	save_e; kw_params benign_error
314
	if test "$benign_error"; then log++; fi
315
	type="${benign_error:+info}" die "command exited with \
316
$(if test "$benign_error"; then echo status; else echo error; fi) $e"
317
	rethrow
318
}
319

    
320

    
321
#### functions
322

    
323
func_exists() { declare -f "$1" >/dev/null; }
324

    
325
copy_func() # usage: from=... to=... copy_func
326
# $to must not exist. to get around the no-clobber restriction, use `unset -f`.
327
{
328
	: "${from:?}" "${to:?}"
329
	func_exists "$from" || die "function does not exist: $from"
330
	! func_exists "$to" || die "function already exists: $to"
331
	local from_def="$(declare -f "$from")"
332
	eval "$to${from_def#$from}"
333
}
334

    
335
func_override() # usage: func_override old_name__suffix
336
{ from="${1%__*}" to="$1" copy_func; }
337

    
338
ensure_nested_func() # usage: func__nested_func() { ensure_nested_func; ... }
339
{
340
	local nested_func="${FUNCNAME[1]}"
341
	local func="${nested_func%%__*}"
342
	contains "$func" "${FUNCNAME[@]}" || \
343
		die "$nested_func() must be used by $func()"
344
}
345

    
346

    
347
#### paths
348

    
349
# cache realpath
350
: "${realpath_cache=}" # default off because slower than without
351
if test "$realpath_cache"; then
352
func_override realpath__no_cache
353
realpath() # caches the last result for efficiency
354
{
355
	local cache_key="$*"; load_cache
356
	if ! cached; then save_cache "$(realpath__no_cache "$@")" || return; fi
357
	echo_cached_value
358
}
359
fi
360

    
361
rel_path() # usage: base_dir=... path=... rel_path
362
{
363
	log++; kw_params base_dir path
364
	: "${base_dir:?}" "${path:?}"
365
	
366
	local path="$path/" # add *extra* / to match path when exactly = base_dir
367
	path="${path#$base_dir/}" # remove prefix shared with base_dir
368
	path="${path%/}" # remove any remaining extra trailing /
369
	
370
	if test ! "$path"; then path=.; fi # ensure non-empty
371
	
372
	echo_vars path
373
	echo "$path"
374
}
375

    
376
cd -P . # expand symlinks in $PWD so it matches the output of realpath
377
# do before setting $top_script_abs so realpath has less symlinks to resolve
378

    
379
canon_rel_path()
380
{
381
	local path; path="$(realpath "$1")" || return
382
	base_dir="$PWD" rel_path
383
}
384

    
385
# makes $1 a canon_rel_path if it's a filesystem path
386
alias cmd2rel_path="$(cat <<'EOF'
387
if test "$(type -t "$1")" = file && test -e "$1"; then # not relative to PATH
388
	declare _1="$1"; shift
389
	_1="$(canon_rel_path "$_1")" || return
390
	set -- "$_1" "$@"
391
fi
392
EOF
393
)"
394

    
395

    
396
#### verbose output
397

    
398

    
399
### command echoing
400

    
401
alias echo_params='log "$*"'
402

    
403
fi # load new aliases
404
if self_being_included; then
405

    
406
echo_cmd() { echo_params; }
407

    
408
function echo_run() { echo_params; "$@"; }
409
alias echo_run='"echo_run" ' # last space alias-expands next word
410

    
411
echo_eval() { echo_params; builtin eval "$@"; }
412

    
413
## vars
414

    
415
echo_vars() # usage: echo_vars var...
416
{
417
	log+ 2
418
	if can_log; then
419
		local var
420
		for var in "${@%%=*}"; do
421
			if isset "$var"; then log "$(declare -p "$var")"; fi
422
		done
423
	fi
424
}
425

    
426
echo_export() { builtin export "$@"; echo_vars "$@"; }
427

    
428
alias export="echo_export" # automatically echo env vars when they are set
429

    
430
func_override kw_params__lang
431
kw_params() { kw_params__lang "$@"; echo_vars "$@"; } # echo all keyword params
432

    
433
## functions
434

    
435
# usage: local func=...; set_func_loc; use $file, $line
436
alias set_func_loc="$(cat <<'EOF'
437
: "${func:?}"
438
local func_info="$(shopt -s extdebug; declare -F "$func")" # 'func line file'
439
func_info="${func_info#$func }"
440
local line="${func_info%% *}"
441
local file="${func_info#$line }"
442
EOF
443
)"
444

    
445
fi # load new aliases
446
if self_being_included; then
447

    
448
func_loc() # gets where function declared in the format file:line
449
{
450
	local func="$1"; set_func_loc
451
	file="$(canon_rel_path "$file")" || return
452
	echo "$file:$line"
453
}
454

    
455
# usage: func() { [minor=1] echo_func; ... }
456
function echo_func()
457
# usage: [minor=1] "echo_func" "$FUNCNAME" "$@" && indent || true
458
# exit status: whether function call was echoed
459
{
460
	kw_params minor
461
	local func="$1"; shift
462
	
463
	log++; if test "$minor"; then log++; fi
464
	local loc; loc="$(func_loc "$func")" || return
465
	echo_cmd "$loc" "$func" "$@"
466
	can_log
467
}
468
alias echo_func='"echo_func" "$FUNCNAME" "$@" && indent || true'
469

    
470
fi # load new aliases
471
if self_being_included; then
472

    
473

    
474
#### streams
475

    
476
fd_exists() { (: <&"$1") 2>/dev/null; }
477

    
478
require_fd_not_exists() # usage: require_fd_not_exists fd || return 0
479
{ ! fd_exists "$1" || type=info die "fd $1 already exists, skipping"; }
480

    
481
set_fds() { echo_func; echo_eval exec "$@"; } # usage: set_fds redirect...
482

    
483
fd_set_default() # usage: fd_set_default 'dest[<>]src'
484
{
485
	echo_func
486
	local dest="${1%%[<>]*}"
487
	require_fd_not_exists "$dest" || return 0
488
	set_fds "$1"
489
}
490

    
491
# convention: use fd 10/11/12 for command-specific alternate stdin/stdout/stderr
492

    
493
setup_log_fd() # view logging output at verbosity >= 5
494
{
495
	log+ 4; log-- echo_func 
496
	fd_set_default '30>&2' || true # stdlog
497
	log_fd=30 # stdlog
498
}
499
setup_log_fd
500

    
501
set_global_fds()
502
# allows commands to access global stdin/stdout/stderr using fd 20/21/22
503
# this works even when /dev/tty isn't available
504
# view logging output at verbosity >= 3
505
{
506
	log+ 2; log-- echo_func
507
	# ignore errors if a source fd isn't open
508
	fd_set_default '20<&0' || true
509
	fd_set_default '21>&1' || true
510
	fd_set_default '22>&2' || true
511
}
512
set_global_fds
513
err_fd=22 # global stderr
514

    
515
# usage: explicit_errors_only=1 script...
516
# show only explicitly-displayed errors (which have been redirected to fd 22)
517
# most of the time this has the same effect as `verbosity=0 script...`,
518
# which displays everything that isn't explicitly hidden
519
# this option should only be used for testing the explicit error displaying
520
if test "$explicit_errors_only"; then disable_logging; fi
521

    
522

    
523
#### paths
524

    
525
top_script_abs="$(realpath "$0")"; echo_vars top_script_abs # outermost script
526
	# realpath this before doing any cd so this points to the right place
527

    
528
set_paths()
529
{
530
	top_script="$(canon_rel_path "$top_script_abs")" || return
531
		echo_vars top_script
532
	top_dir="$(dirname "$top_script")" || return; echo_vars top_dir
533
}
534
set_paths
535

    
536

    
537
#### verbose output
538

    
539

    
540
## internal commands
541

    
542
.()
543
{
544
	cmd2rel_path; set -- "$FUNCNAME" "$@"
545
	if (log++; echo_params; can_log); then indent; fi
546
	builtin "$@"
547
}
548

    
549
cd() # indent is permanent within subshell cd was used in
550
{
551
	log++ echo_func
552
	cmd2rel_path; echo_cmd "$FUNCNAME" "$@"
553
	if can_log; then caller_indent; fi
554
	# -P: expand symlinks so $PWD matches the output of realpath
555
	builtin "$FUNCNAME" -P "$@"
556
	
557
	func=realpath clear_cache
558
	set_paths
559
}
560

    
561
## external commands
562

    
563
disable_logging() { set_fds "$log_fd>/dev/null"; }
564

    
565
function command()
566
# usage: [cmd_log_fd=|1|2|#] [redirs=...] [verbosity_min=] command extern_cmd...
567
# to view only explicitly-displayed errors: explicit_errors_only=1 script...
568
{
569
	log++ echo_func; kw_params cmd_log_fd redirs verbosity_min
570
	# if no cmd_log_fd, limit log_fd in case command uses util.sh
571
	local cmd_log_fd="${cmd_log_fd-$log_fd}"
572
	local redirs=("${redirs[@]}")
573
	
574
	# determine redirections now so they can be logged along with the command
575
	# the following redirections must happen in exactly this order
576
	if test "$cmd_log_fd"; then
577
		if can_log; then
578
			if test "$cmd_log_fd" != "$log_fd"; then
579
				redirs+=("$cmd_log_fd>&$log_fd")
580
			fi # else no redir needed
581
		else redirs+=("$cmd_log_fd>/dev/null");
582
		fi
583
	fi
584
	
585
	cmd2rel_path; echo_cmd "$@" "${redirs[@]}"
586
	
587
	# add after echoing command so it isn't echoed at the end of every command
588
	if test "$cmd_log_fd" != 2; then # fd 2 not used for logging
589
		redirs+=("2>&$err_fd") # assume fd 2 used for errors
590
	fi
591
	
592
	(
593
		if can_log; then indent; fi
594
		log++ set_fds "${redirs[@]}"
595
		
596
		if test "$verbosity_min"; then verbosity_min "$verbosity_min"; fi
597
		
598
		exec -- "$@" # -- so cmd name not treated as `exec` option
599
	) || die_e
600
}
601

    
602
# auto-echo common external commands
603
for cmd in env rm; do alias "$cmd=command $cmd"; done; unset cmd
604

    
605

    
606
### external command input/output
607

    
608
pipe_delay() # usage: cmd1 | { pipe_delay; cmd2; }
609
{ sleep 0.1; } # s; display after leading output of cmd1
610

    
611
fi # load new aliases
612
if self_being_included; then
613

    
614
echo_stdin() # usage: input|echo_stdin|cmd
615
{
616
	if can_log; then
617
		pipe_delay
618
		echo ----- >&"$log_fd"
619
		tee -a /dev/fd/"$log_fd";
620
		echo ----- >&"$log_fd"
621
	else cat
622
	fi
623
}
624

    
625
echo_stdout() { echo_stdin; } # usage: cmd|echo_stdout
626

    
627

    
628
#### commands
629

    
630
require_not_exists() # usage: require_not_exists file || return 0
631
{ test ! -e "$1" || type=info die "file "$1" already exists, skipping"; }
632

    
633
function to_file() # usage: stdout=... [if_not_exists=1] to_file cmd...
634
# auto-removes a command's output file on error (like make's .DELETE_ON_ERROR)
635
{
636
	echo_func; kw_params stdout
637
	: "${stdout?}"
638
	if test "$if_not_exists"; then require_not_exists "$stdout" || return 0; fi
639
	
640
	log ">$stdout"
641
	"$@" >"$stdout" || { save_e; rm "$stdout"; rethrow; }
642
}
643
alias to_file='"to_file" ' # last space alias-expands next word
644

    
645
run_args_cmd() # runs the command line args command
646
{
647
	eval set -- "$(reverse "${BASH_ARGV[@]}")"
648
	test $# -ge 1 || set -- all
649
	echo_cmd "$top_script" "$@"; "$@"
650
}
651

    
652
fwd() # usage: subdirs=(...); fwd "$FUNCNAME" "$@"
653
{
654
	echo_func
655
	: "${subdirs?}"
656
	
657
	for subdir in "${subdirs[@]}"; do "$top_dir"/"$subdir"/run "$@"; done
658
}
659

    
660

    
661
#### filesystem
662

    
663
alias file_size=\
664
"stat `case "$(uname)" in Darwin) echo -f %z;; *) echo --format=%s;; esac`"
665

    
666

    
667
#### URLs
668

    
669
localize_url() { test _"$1" = _"$(hostname -f)" || echo "$1"; }
670

    
671
fi
(7-7/7)