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_inv() { set_var no_"$1" "$(test "${!1}" || echo 1)"; }
46

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

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

    
53
alias local_export='declare -x' # combines effects of local and export
54

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

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

    
69

    
70
#### caching
71

    
72
## shell-variable-based caching
73

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

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

    
85
fi # load new aliases
86
if self_being_included; then
87

    
88

    
89
#### aliases
90

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

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

    
97

    
98
#### functions
99

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

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

    
106

    
107
#### exceptions
108

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

    
115
fi # load new aliases
116
if self_being_included; then
117

    
118
# usage: try cmd...; ignore status; if catch status; then ...; fi; end_try
119

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

    
123
catch() { test "$e" -eq "$1"; e=0; }
124

    
125
ignore() { catch "$@" || true; }
126

    
127
alias end_try='rethrow'
128
alias end_try_subshell='rethrow_subshell'
129

    
130
fi # load new aliases
131
if self_being_included; then
132

    
133

    
134
#### integers
135

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

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

    
141

    
142
#### floats
143

    
144
int_part() { echo "${1%%.*}"; }
145

    
146
dec_suffix() { echo "${1#$(int_part "$1")}"; }
147

    
148
round_down() { int_part "$1"; }
149

    
150
float+int() { echo "$(($(int_part "$1")+$2))$(dec_suffix "$1")"; }
151

    
152

    
153
#### strings
154

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

    
162
sed_cmd="command sed -$(test "$(uname)" = Darwin && echo E || echo r)"
163
alias sed="$sed_cmd"
164

    
165
fi # load new aliases
166
if self_being_included; then
167

    
168
rtrim() { sed 's/[[:space:]]+$//' <<<"$1"; }
169

    
170

    
171
#### arrays
172

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

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

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

    
189

    
190
#### verbose output
191

    
192

    
193
err_fd=2 # stderr
194

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

    
197

    
198
### logging
199

    
200
log_fd=2 # initially stderr
201

    
202
if test "$explicit_errors_only"; then verbosity=0; fi # hide startup logging
203

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

    
212
verbosity_int() { round_down "$verbosity"; }
213

    
214
# verbosities:
215
# 0: just print errors. useful for cron jobs.
216
# 1: also external commands run. useful for running at the command line.
217
# 2: full graphical call tree. useful for determining where error occurred.
218
# 3: also values of kw params and variables. useful for low-level debugging.
219
# 4: also variables in util.sh commands. useful for debugging util.sh.
220
# 5: also variables in logging commands themselves. useful for debugging echo_*.
221
# 6+: not currently used (i.e. same as 5)
222

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

    
228
fi # load new aliases
229
if self_being_included; then
230

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

    
250
verbosity_min() # usage: verbosity_min min
251
{ if test "$(verbosity_int)" -lt "$1"; then verbosity="$1"; fi; }
252
alias verbosity_min='log_local; "verbosity_min"'
253

    
254

    
255
# indent for call tree. this is *not* the log_level (below).
256
: "${log_indent_step=| }" "${log_indent=}"
257
export log_indent_step log_indent # propagate to invoked commands
258

    
259
__caller_indent='log_indent="$log_indent$log_indent_step"'
260
alias caller_indent="$__caller_indent"
261
alias indent="declare $__caller_indent"
262

    
263

    
264
fi # load new aliases
265
if self_being_included; then
266

    
267
can_log() { test "$(verbosity_int)" -gt 0; }
268
	# verbosity=0 turns off all logging
269

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

    
272
log_custom() # usage: symbol=... log_custom msg
273
{ log_indent="${log_indent//[^ ]/$symbol}" PS4="${PS4//[^ ]/$symbol}" log "$@";}
274

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

    
277
log_info() { symbol=: log_custom "$@"; }
278

    
279
log_e() # usage: cmd || { save_e; log_e; ...; rethrow; }
280
{ log_err "command exited with error $e"; }
281

    
282
die() # usage: cmd || [type=...] die msg
283
{ save_e; kw_params type; "log_${type:-err}" "$1"; rethrow; }
284

    
285

    
286
#### functions
287

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

    
290
copy_func() # usage: from=... to=... copy_func
291
# $to must not exist. to get around the no-clobber restriction, use `unset -f`.
292
{
293
	: "${from:?}" "${to:?}"
294
	func_exists "$from" || die "function does not exist: $from"
295
	! func_exists "$to" || die "function already exists: $to"
296
	local from_def="$(declare -f "$from")"
297
	eval "$to${from_def#$from}"
298
}
299

    
300
func_override() # usage: func_override old_name__suffix
301
{ from="${1%%__*}" to="$1" copy_func; }
302

    
303
ensure_nested_func() # usage: func__nested_func() { ensure_nested_func; ... }
304
{
305
	local nested_func="${FUNCNAME[1]}"
306
	local func="${nested_func%%__*}"
307
	contains "$func" "${FUNCNAME[@]}" || \
308
		die "$nested_func() must be used by $func()"
309
}
310

    
311

    
312
#### paths
313

    
314
# cache realpath
315
: "${realpath_cache=}" # default off because slower than without
316
if test "$realpath_cache"; then
317
func_override realpath__no_cache
318
realpath() # caches the last result for efficiency
319
{
320
	local cache_key="$*"; load_cache
321
	if ! cached; then save_cache "$(realpath__no_cache "$@")" || return; fi
322
	echo_cached_value
323
}
324
fi
325

    
326
rel_path() # usage: base_dir=... path=... rel_path
327
{
328
	log++; kw_params base_dir path
329
	: "${base_dir:?}" "${path:?}"
330
	
331
	local path="$path/" # add *extra* / to match path when exactly = base_dir
332
	path="${path#$base_dir/}" # remove prefix shared with base_dir
333
	path="${path%/}" # remove any remaining extra trailing /
334
	
335
	if test ! "$path"; then path=.; fi # ensure non-empty
336
	
337
	echo_vars path
338
	echo "$path"
339
}
340

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

    
344
canon_rel_path()
345
{
346
	local path; path="$(realpath "$1")" || return
347
	base_dir="$PWD" rel_path
348
}
349

    
350
# makes $1 a canon_rel_path if it's a filesystem path
351
alias cmd2rel_path="$(cat <<'EOF'
352
if test "$(type -t "$1")" = file && test -e "$1"; then # not relative to PATH
353
	declare _1="$1"; shift
354
	_1="$(canon_rel_path "$_1")" || return
355
	set -- "$_1" "$@"
356
fi
357
EOF
358
)"
359

    
360

    
361
#### verbose output
362

    
363

    
364
### command echoing
365

    
366
alias echo_params='log "$*"'
367

    
368
fi # load new aliases
369
if self_being_included; then
370

    
371
echo_cmd() { echo_params; }
372

    
373
echo_eval() { echo_params; builtin eval "$@"; }
374

    
375
## vars
376

    
377
echo_vars() # usage: echo_vars var...
378
{
379
	log+ 2
380
	if can_log; then
381
		local var
382
		for var in "${@%%=*}"; do
383
			if isset "$var"; then log "$(declare -p "$var")"; fi
384
		done
385
	fi
386
}
387

    
388
echo_export() { builtin export "$@"; echo_vars "$@"; }
389

    
390
alias export="echo_export" # automatically echo env vars when they are set
391

    
392
func_override kw_params__lang
393
kw_params() { kw_params__lang "$@"; echo_vars "$@"; } # echo all keyword params
394

    
395
## functions
396

    
397
# usage: local func=...; set_func_loc; use $file, $line
398
alias set_func_loc="$(cat <<'EOF'
399
: "${func:?}"
400
local func_info="$(shopt -s extdebug; declare -F "$func")" # 'func line file'
401
func_info="${func_info#$func }"
402
local line="${func_info%% *}"
403
local file="${func_info#$line }"
404
EOF
405
)"
406

    
407
fi # load new aliases
408
if self_being_included; then
409

    
410
func_loc() # gets where function declared in the format file:line
411
{
412
	local func="$1"; set_func_loc
413
	file="$(canon_rel_path "$file")" || return
414
	echo "$file:$line"
415
}
416

    
417
# usage: func() { [minor=1] echo_func; ... }
418
function echo_func()
419
# usage: [minor=1] "echo_func" "$FUNCNAME" "$@" && indent || true
420
# exit status: whether function call was echoed
421
{
422
	kw_params minor
423
	local func="$1"; shift
424
	
425
	log++; if test "$minor"; then log++; fi
426
	local loc; loc="$(func_loc "$func")" || return
427
	echo_cmd "$loc" "$func" "$@"
428
	can_log
429
}
430
alias echo_func='"echo_func" "$FUNCNAME" "$@" && indent || true'
431

    
432
fi # load new aliases
433
if self_being_included; then
434

    
435

    
436
#### streams
437

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

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

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

    
445
fd_set_default() # usage: fd_set_default 'dest[<>]src'
446
{
447
	echo_func
448
	local dest="${1%%[<>]*}"
449
	require_fd_not_exists "$dest" || return 0
450
	set_fds "$1"
451
}
452

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

    
455
setup_log_fd() # view logging output at verbosity >= 5
456
{
457
	log+ 4; log-- echo_func 
458
	fd_set_default '30>&2' || true # stdlog
459
	log_fd=30 # stdlog
460
}
461
setup_log_fd
462

    
463
set_global_fds()
464
# allows commands to access global stdin/stdout/stderr using fd 20/21/22
465
# this works even when /dev/tty isn't available
466
# view logging output at verbosity >= 3
467
{
468
	log+ 2; log-- echo_func
469
	# ignore errors if a source fd isn't open
470
	fd_set_default '20<&0' || true
471
	fd_set_default '21>&1' || true
472
	fd_set_default '22>&2' || true
473
}
474
set_global_fds
475
err_fd=22 # global stderr
476

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

    
484

    
485
#### paths
486

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

    
490
set_paths()
491
{
492
	top_script="$(canon_rel_path "$top_script_abs")" || return
493
		echo_vars top_script
494
	top_dir="$(dirname "$top_script")" || return; echo_vars top_dir
495
}
496
set_paths
497

    
498

    
499
#### verbose output
500

    
501

    
502
## internal commands
503

    
504
.()
505
{
506
	cmd2rel_path; set -- "$FUNCNAME" "$@"
507
	(log++; echo_params; can_log) && indent || true
508
	builtin "$@"
509
}
510

    
511
cd() # indent is permanent within subshell cd was used in
512
{
513
	log++ echo_func
514
	cmd2rel_path; echo_cmd "$FUNCNAME" "$@"
515
	can_log && caller_indent || true
516
	# -P: expand symlinks so $PWD matches the output of realpath
517
	builtin "$FUNCNAME" -P "$@"
518
	
519
	func=realpath clear_cache
520
	set_paths
521
}
522

    
523
## external commands
524

    
525
disable_logging() { set_fds "$log_fd>/dev/null"; }
526

    
527
function command()
528
# usage: [cmd_log_fd=|1|2|#] [verbosity_min=] command extern_cmd...
529
# to view only explicitly-displayed errors: explicit_errors_only=1 script...
530
{
531
	kw_params cmd_log_fd verbosity_min
532
	# if no cmd_log_fd, limit log_fd in case command uses util.sh
533
	local cmd_log_fd="${cmd_log_fd-$log_fd}"
534
	
535
	cmd2rel_path; (echo_params; can_log) && indent || true
536
	(
537
		# the following redirections must happen in exactly this order
538
		if test "$cmd_log_fd"; then command__set_fds; fi
539
		if test "$cmd_log_fd" != 2; then # fd 2 not used for logging
540
			exec 2>&"$err_fd" # assume fd 2 used for errors
541
		fi
542
		
543
		if test "$verbosity_min"; then verbosity_min "$verbosity_min"; fi
544
		
545
		exec -- "$@" # -- so cmd name not treated as `exec` option
546
	) || return
547
}
548
function command__set_fds()
549
{
550
	ensure_nested_func
551
	if can_log; then
552
		if test "$cmd_log_fd" = "$log_fd"; then return 0; fi # no redir needed
553
		local src="&$log_fd"
554
	else local src=/dev/null
555
	fi
556
	log++ set_fds "$cmd_log_fd>$src"
557
}
558

    
559
# auto-echo common external commands
560
for cmd in env rm; do alias "$cmd=command $cmd"; done; unset cmd
561

    
562

    
563
### external command input/output
564

    
565
pipe_delay() # usage: cmd1 | { pipe_delay; cmd2; }
566
{ sleep 0.1; } # s; display after leading output of cmd1
567

    
568
fi # load new aliases
569
if self_being_included; then
570

    
571
echo_stdin() # usage: input|echo_stdin|cmd
572
{
573
	if can_log; then
574
		pipe_delay
575
		echo ----- >&"$log_fd"
576
		tee -a /dev/fd/"$log_fd";
577
		echo ----- >&"$log_fd"
578
	else cat
579
	fi
580
}
581

    
582
echo_stdout() { echo_stdin; } # usage: cmd|echo_stdout
583

    
584

    
585
#### commands
586

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

    
590
function to_file() # usage: stdout=... [if_not_exists=1] to_file cmd...
591
# auto-removes a command's output file on error (like make's .DELETE_ON_ERROR)
592
{
593
	echo_func; kw_params stdout
594
	: "${stdout?}"
595
	test ! "$if_not_exists" || require_not_exists "$stdout" || return 0
596
	"$@" >"$stdout" || { save_e; log_e; rm "$stdout"; rethrow; }
597
}
598
alias to_file='"to_file" ' # last space alias-expands next word
599

    
600
run_args_cmd() # runs the command line args command
601
{
602
	eval set -- "$(reverse "${BASH_ARGV[@]}")"
603
	test $# -ge 1 || set -- all
604
	echo_cmd "$top_script" "$@"; "$@"
605
}
606

    
607
fwd() # usage: subdirs=(...); fwd "$FUNCNAME" "$@"
608
{
609
	echo_func
610
	: "${subdirs?}"
611
	
612
	for subdir in "${subdirs[@]}"; do "$top_dir"/"$subdir"/run "$@"; done
613
}
614

    
615

    
616
#### URLs
617

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

    
620
fi
(5-5/5)