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 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() { catch "$@" || true; }
128

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

    
132
fi # load new aliases
133
if self_being_included; then
134

    
135

    
136
#### integers
137

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

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

    
143

    
144
#### floats
145

    
146
int_part() { echo "${1%%.*}"; }
147

    
148
dec_suffix() { echo "${1#$(int_part "$1")}"; }
149

    
150
round_down() { int_part "$1"; }
151

    
152
float+int() { echo "$(($(int_part "$1")+$2))$(dec_suffix "$1")"; }
153

    
154

    
155
#### strings
156

    
157
repeat() # usage: str=... n=... repeat
158
{
159
	: "${str?}" "${n:?}"; local result= n="$n" # n will be modified in function
160
	for (( ; n > 0; n-- )); do result="$result$str"; done
161
	echo "$result"
162
}
163

    
164
sed_cmd="command sed -`case "$(uname)" in Darwin) echo E;; *) echo r;; esac`"
165
alias sed="$sed_cmd"
166

    
167
fi # load new aliases
168
if self_being_included; then
169

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

    
172

    
173
#### arrays
174

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

    
177
reverse() # usage: array=($(reverse args...))
178
{
179
	local i
180
	for (( i=$#; i > 0; i-- )); do printf '%q ' "${!i}"; done
181
}
182

    
183
contains() # usage: contains value in_array...
184
{
185
	local value="$1"; shift
186
	local elem
187
	for elem in "$@"; do if test "$elem" = "$value"; then return 0; fi; done
188
	return 1
189
}
190

    
191

    
192
#### verbose output
193

    
194

    
195
err_fd=2 # stderr
196

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

    
199

    
200
### log++
201

    
202
log_fd=2 # initially stderr
203

    
204
if test "$explicit_errors_only"; then verbosity=0; fi # hide startup logging
205

    
206
# set verbosity
207
if isset verbose; then : "${verbosity:=$(bool2int "$verbose")}"; fi
208
if isset vb; then : "${verbosity:=$vb}"; fi
209
: "${verbosity=1}" # default
210
: "${verbosity:=0}" # ensure non-empty
211
export verbosity # propagate to invoked commands
212
export PS4 # follows verbosity, so also propagate this
213

    
214
verbosity_int() { round_down "$verbosity"; }
215

    
216
# verbosities (and `make` equivalents):
217
# 0: just print errors. useful for cron jobs.
218
#    vs. make: equivalent to --silent, but suppresses external command output
219
# 1: also external commands run. useful for running at the command line.
220
#    vs. make: not provided (but sorely needed to avoid excessive output)
221
# 2: full graphical call tree. useful for determining where error occurred.
222
#    vs. make: equivalent to default verbosity, but with much-needed indents
223
# 3: also values of kw params and variables. useful for low-level debugging.
224
#    vs. make: not provided; need to manually use $(error $(var))
225
# 4: also variables in util.sh commands. useful for debugging util.sh.
226
#    vs. make: somewhat similar to --print-data-base
227
# 5: also variables in logging commands themselves. useful for debugging echo_*.
228
#    vs. make: not provided; need to search Makefile for @ at beginning of cmd
229
# 6+: not currently used (i.e. same as 5)
230

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

    
236
fi # load new aliases
237
if self_being_included; then
238

    
239
# usage: in func:      log++; ...         OR  log_local; "log++"; ...
240
#        outside func: log++; ...; log--
241
#        before cmd:   log++ cmd...
242
# without a cmd, "$@" expands to nothing and assignments are applied to caller
243
# "${@:2}" expands to all of $@ after *1st* arg, not 2nd ($@ indexes start at 1)
244
log+()
245
{
246
	# no local vars because w/o cmd, assignments should be applied to caller
247
	PS4="$(if test "$1" -gt 0; then echo "$(str="${PS4:0:1}" n="$1" repeat)$PS4"
248
else echo "${PS4:$((-$1))}"; fi)" \
249
	verbosity="$(float+int "$verbosity" "-$1")" "${@:2}"
250
}
251
log++() { log+  1 "$@"; }
252
log--() { log+ -1 "$@"; }
253
alias log_local='declare PS4="$PS4" verbosity="$verbosity"'
254
alias log+='log_local; "log+"' # don't expand next word because it's not a cmd
255
alias log++='log_local; "log++" ' # last space alias-expands next word
256
alias log--='log_local; "log--" ' # last space alias-expands next word
257

    
258
verbosity_min() # usage: verbosity_min min
259
{ if test "$(verbosity_int)" -lt "$1"; then verbosity="$1"; fi; }
260
alias verbosity_min='log_local; "verbosity_min"'
261

    
262

    
263
# indent for call tree. this is *not* the log_level (below).
264
: "${log_indent_step=| }" "${log_indent=}"
265
export log_indent_step log_indent # propagate to invoked commands
266

    
267
__caller_indent='log_indent="$log_indent$log_indent_step"'
268
alias caller_indent="$__caller_indent"
269
alias indent="declare $__caller_indent"
270

    
271

    
272
fi # load new aliases
273
if self_being_included; then
274

    
275
can_log() { test "$(verbosity_int)" -gt 0; }
276
	# verbosity=0 turns off all logging
277

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

    
280
log_custom() # usage: symbol=... log_custom msg
281
{ log_indent="${log_indent//[^ ]/$symbol}" PS4="${PS4//[^ ]/$symbol}" log "$@";}
282

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

    
285
log_info() { symbol=: log_custom "$@"; }
286

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

    
290
die_e() # usage: cmd || [benign_error=1] die_e [|| handle error]
291
{
292
	save_e; kw_params benign_error
293
	if test "$benign_error"; then log++; fi
294
	type="${benign_error:+info}" die "command exited with \
295
$(if test "$benign_error"; then echo status; else echo error; fi) $e"
296
	rethrow
297
}
298

    
299

    
300
#### functions
301

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

    
304
copy_func() # usage: from=... to=... copy_func
305
# $to must not exist. to get around the no-clobber restriction, use `unset -f`.
306
{
307
	: "${from:?}" "${to:?}"
308
	func_exists "$from" || die "function does not exist: $from"
309
	! func_exists "$to" || die "function already exists: $to"
310
	local from_def="$(declare -f "$from")"
311
	eval "$to${from_def#$from}"
312
}
313

    
314
func_override() # usage: func_override old_name__suffix
315
{ from="${1%%__*}" to="$1" copy_func; }
316

    
317
ensure_nested_func() # usage: func__nested_func() { ensure_nested_func; ... }
318
{
319
	local nested_func="${FUNCNAME[1]}"
320
	local func="${nested_func%%__*}"
321
	contains "$func" "${FUNCNAME[@]}" || \
322
		die "$nested_func() must be used by $func()"
323
}
324

    
325

    
326
#### paths
327

    
328
# cache realpath
329
: "${realpath_cache=}" # default off because slower than without
330
if test "$realpath_cache"; then
331
func_override realpath__no_cache
332
realpath() # caches the last result for efficiency
333
{
334
	local cache_key="$*"; load_cache
335
	if ! cached; then save_cache "$(realpath__no_cache "$@")" || return; fi
336
	echo_cached_value
337
}
338
fi
339

    
340
rel_path() # usage: base_dir=... path=... rel_path
341
{
342
	log++; kw_params base_dir path
343
	: "${base_dir:?}" "${path:?}"
344
	
345
	local path="$path/" # add *extra* / to match path when exactly = base_dir
346
	path="${path#$base_dir/}" # remove prefix shared with base_dir
347
	path="${path%/}" # remove any remaining extra trailing /
348
	
349
	if test ! "$path"; then path=.; fi # ensure non-empty
350
	
351
	echo_vars path
352
	echo "$path"
353
}
354

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

    
358
canon_rel_path()
359
{
360
	local path; path="$(realpath "$1")" || return
361
	base_dir="$PWD" rel_path
362
}
363

    
364
# makes $1 a canon_rel_path if it's a filesystem path
365
alias cmd2rel_path="$(cat <<'EOF'
366
if test "$(type -t "$1")" = file && test -e "$1"; then # not relative to PATH
367
	declare _1="$1"; shift
368
	_1="$(canon_rel_path "$_1")" || return
369
	set -- "$_1" "$@"
370
fi
371
EOF
372
)"
373

    
374

    
375
#### verbose output
376

    
377

    
378
### command echoing
379

    
380
alias echo_params='log "$*"'
381

    
382
fi # load new aliases
383
if self_being_included; then
384

    
385
echo_cmd() { echo_params; }
386

    
387
echo_eval() { echo_params; builtin eval "$@"; }
388

    
389
## vars
390

    
391
echo_vars() # usage: echo_vars var...
392
{
393
	log+ 2
394
	if can_log; then
395
		local var
396
		for var in "${@%%=*}"; do
397
			if isset "$var"; then log "$(declare -p "$var")"; fi
398
		done
399
	fi
400
}
401

    
402
echo_export() { builtin export "$@"; echo_vars "$@"; }
403

    
404
alias export="echo_export" # automatically echo env vars when they are set
405

    
406
func_override kw_params__lang
407
kw_params() { kw_params__lang "$@"; echo_vars "$@"; } # echo all keyword params
408

    
409
## functions
410

    
411
# usage: local func=...; set_func_loc; use $file, $line
412
alias set_func_loc="$(cat <<'EOF'
413
: "${func:?}"
414
local func_info="$(shopt -s extdebug; declare -F "$func")" # 'func line file'
415
func_info="${func_info#$func }"
416
local line="${func_info%% *}"
417
local file="${func_info#$line }"
418
EOF
419
)"
420

    
421
fi # load new aliases
422
if self_being_included; then
423

    
424
func_loc() # gets where function declared in the format file:line
425
{
426
	local func="$1"; set_func_loc
427
	file="$(canon_rel_path "$file")" || return
428
	echo "$file:$line"
429
}
430

    
431
# usage: func() { [minor=1] echo_func; ... }
432
function echo_func()
433
# usage: [minor=1] "echo_func" "$FUNCNAME" "$@" && indent || true
434
# exit status: whether function call was echoed
435
{
436
	kw_params minor
437
	local func="$1"; shift
438
	
439
	log++; if test "$minor"; then log++; fi
440
	local loc; loc="$(func_loc "$func")" || return
441
	echo_cmd "$loc" "$func" "$@"
442
	can_log
443
}
444
alias echo_func='"echo_func" "$FUNCNAME" "$@" && indent || true'
445

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

    
449

    
450
#### streams
451

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

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

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

    
459
fd_set_default() # usage: fd_set_default 'dest[<>]src'
460
{
461
	echo_func
462
	local dest="${1%%[<>]*}"
463
	require_fd_not_exists "$dest" || return 0
464
	set_fds "$1"
465
}
466

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

    
469
setup_log_fd() # view logging output at verbosity >= 5
470
{
471
	log+ 4; log-- echo_func 
472
	fd_set_default '30>&2' || true # stdlog
473
	log_fd=30 # stdlog
474
}
475
setup_log_fd
476

    
477
set_global_fds()
478
# allows commands to access global stdin/stdout/stderr using fd 20/21/22
479
# this works even when /dev/tty isn't available
480
# view logging output at verbosity >= 3
481
{
482
	log+ 2; log-- echo_func
483
	# ignore errors if a source fd isn't open
484
	fd_set_default '20<&0' || true
485
	fd_set_default '21>&1' || true
486
	fd_set_default '22>&2' || true
487
}
488
set_global_fds
489
err_fd=22 # global stderr
490

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

    
498

    
499
#### paths
500

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

    
504
set_paths()
505
{
506
	top_script="$(canon_rel_path "$top_script_abs")" || return
507
		echo_vars top_script
508
	top_dir="$(dirname "$top_script")" || return; echo_vars top_dir
509
}
510
set_paths
511

    
512

    
513
#### verbose output
514

    
515

    
516
## internal commands
517

    
518
.()
519
{
520
	cmd2rel_path; set -- "$FUNCNAME" "$@"
521
	if (log++; echo_params; can_log); then indent; fi
522
	builtin "$@"
523
}
524

    
525
cd() # indent is permanent within subshell cd was used in
526
{
527
	log++ echo_func
528
	cmd2rel_path; echo_cmd "$FUNCNAME" "$@"
529
	if can_log; then caller_indent; fi
530
	# -P: expand symlinks so $PWD matches the output of realpath
531
	builtin "$FUNCNAME" -P "$@"
532
	
533
	func=realpath clear_cache
534
	set_paths
535
}
536

    
537
## external commands
538

    
539
disable_logging() { set_fds "$log_fd>/dev/null"; }
540

    
541
function command()
542
# usage: [cmd_log_fd=|1|2|#] [redirs=...] [verbosity_min=] command extern_cmd...
543
# to view only explicitly-displayed errors: explicit_errors_only=1 script...
544
{
545
	log++ echo_func; kw_params cmd_log_fd redirs verbosity_min
546
	# if no cmd_log_fd, limit log_fd in case command uses util.sh
547
	local cmd_log_fd="${cmd_log_fd-$log_fd}"
548
	local redirs=("${redirs[@]}")
549
	
550
	# determine redirections now so they can be logged along with the command
551
	# the following redirections must happen in exactly this order
552
	if test "$cmd_log_fd"; then
553
		if can_log; then
554
			if test "$cmd_log_fd" != "$log_fd"; then
555
				redirs+=("$cmd_log_fd>&$log_fd")
556
			fi # else no redir needed
557
		else redirs+=("$cmd_log_fd>/dev/null");
558
		fi
559
	fi
560
	
561
	cmd2rel_path; echo_cmd "$@" "${redirs[@]}"
562
	
563
	# add after echoing command so it isn't echoed at the end of every command
564
	if test "$cmd_log_fd" != 2; then # fd 2 not used for logging
565
		redirs+=("2>&$err_fd") # assume fd 2 used for errors
566
	fi
567
	
568
	(
569
		if can_log; then indent; fi
570
		log++ set_fds "${redirs[@]}"
571
		
572
		if test "$verbosity_min"; then verbosity_min "$verbosity_min"; fi
573
		
574
		exec -- "$@" # -- so cmd name not treated as `exec` option
575
	) || die_e
576
}
577

    
578
# auto-echo common external commands
579
for cmd in env rm; do alias "$cmd=command $cmd"; done; unset cmd
580

    
581

    
582
### external command input/output
583

    
584
pipe_delay() # usage: cmd1 | { pipe_delay; cmd2; }
585
{ sleep 0.1; } # s; display after leading output of cmd1
586

    
587
fi # load new aliases
588
if self_being_included; then
589

    
590
echo_stdin() # usage: input|echo_stdin|cmd
591
{
592
	if can_log; then
593
		pipe_delay
594
		echo ----- >&"$log_fd"
595
		tee -a /dev/fd/"$log_fd";
596
		echo ----- >&"$log_fd"
597
	else cat
598
	fi
599
}
600

    
601
echo_stdout() { echo_stdin; } # usage: cmd|echo_stdout
602

    
603

    
604
#### commands
605

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

    
609
function to_file() # usage: stdout=... [if_not_exists=1] to_file cmd...
610
# auto-removes a command's output file on error (like make's .DELETE_ON_ERROR)
611
{
612
	echo_func; kw_params stdout
613
	: "${stdout?}"
614
	if test "$if_not_exists"; then require_not_exists "$stdout" || return 0; fi
615
	
616
	log ">$stdout"
617
	"$@" >"$stdout" || { save_e; rm "$stdout"; rethrow; }
618
}
619
alias to_file='"to_file" ' # last space alias-expands next word
620

    
621
run_args_cmd() # runs the command line args command
622
{
623
	eval set -- "$(reverse "${BASH_ARGV[@]}")"
624
	test $# -ge 1 || set -- all
625
	echo_cmd "$top_script" "$@"; "$@"
626
}
627

    
628
fwd() # usage: subdirs=(...); fwd "$FUNCNAME" "$@"
629
{
630
	echo_func
631
	: "${subdirs?}"
632
	
633
	for subdir in "${subdirs[@]}"; do "$top_dir"/"$subdir"/run "$@"; done
634
}
635

    
636

    
637
#### URLs
638

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

    
641
fi
(5-5/5)