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
#### strings
143

    
144
repeat() # usage: str=... n=... repeat
145
{
146
	: "${str?}" "${n:?}"; local result= n="$n" # n will be modified in function
147
	for (( ; n > 0; n-- )); do result="$result$str"; done
148
	echo "$result"
149
}
150

    
151
sed_ere_flag="$(test "$(uname)" = Darwin && echo E || echo r)"
152

    
153
sed() { self -"$sed_ere_flag" "$@";}
154

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

    
157

    
158
#### arrays
159

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

    
162
reverse() # usage: array=($(reverse args...))
163
{
164
	local i
165
	for (( i=$#; i > 0; i-- )); do printf '%q ' "${!i}"; done
166
}
167

    
168
contains() # usage: contains value in_array...
169
{
170
	local value="$1"; shift
171
	local elem
172
	for elem in "$@"; do if test "$elem" = "$value"; then return 0; fi; done
173
	return 1
174
}
175

    
176

    
177
#### verbose output
178

    
179

    
180
err_fd=2 # stderr
181

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

    
184

    
185
### logging
186

    
187
log_fd=2 # stderr
188

    
189
if test "$explicit_errors_only"; then verbosity=0; fi # hide startup logging
190

    
191
# set verbosity
192
if isset verbose; then : "${verbosity:=$(bool2int "$verbose")}"; fi
193
if isset vb; then : "${verbosity:=$vb}"; fi
194
: "${verbosity=1}" # default
195
: "${verbosity:=0}" # ensure non-empty
196
export verbosity # propagate to invoked commands
197

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

    
203
alias PS4_prefix_n='str="${PS4:0:1}" n=$1 repeat'
204

    
205
fi # load new aliases
206
if self_being_included; then
207

    
208
# usage: in func:      log++; ...         OR  log_local; "log++"; ...
209
#        outside func: log++; ...; log--
210
#        before cmd:   log++ cmd...
211
# without a cmd, "$@" expands to nothing and assignments are applied to caller
212
# "${@:2}" expands to all of $@ after *1st* arg, not 2nd ($@ indexes start at 1)
213
log+()  { PS4="$(PS4_prefix_n)$PS4" verbosity=$((verbosity-$1)) "${@:2}"; }
214
log-()  { PS4="${PS4:$1}"           verbosity=$((verbosity+$1)) "${@:2}"; }
215
log++() { log+ 1 "$@"; }
216
log--() { log- 1 "$@"; }
217
alias log_local='declare PS4="$PS4" verbosity="$verbosity"'
218
alias log+='log_local; "log+" ' # last space alias-expands next word
219
alias log-='log_local; "log-" ' # last space alias-expands next word
220
alias log++='log_local; "log++" ' # last space alias-expands next word
221
alias log--='log_local; "log--" ' # last space alias-expands next word
222

    
223

    
224
# indent for call tree. this is *not* the log_level (below).
225
: "${log_level_indent=| }" "${log_indent=}"
226
export log_level_indent log_indent # propagate to invoked commands
227

    
228
__caller_indent='log_indent="$log_indent$log_level_indent"'
229
alias caller_indent="$__caller_indent"
230
alias indent="declare $__caller_indent"
231

    
232

    
233
fi # load new aliases
234
if self_being_included; then
235

    
236
can_log() { test "$verbosity" -gt 0; } # verbosity=0 turns off all logging
237

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

    
240
log_custom() # usage: symbol=... log_custom msg
241
{ log_indent="${log_indent//[^ ]/$symbol}" PS4="${PS4//[^ ]/$symbol}" log "$@";}
242

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

    
245
log_info() { symbol=: log_custom "$@"; }
246

    
247
log_e() # usage: cmd || { save_e; log_e; ...; rethrow; }
248
{ log_err "command exited with error $e"; }
249

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

    
253

    
254
#### functions
255

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

    
258
copy_func() # usage: from=... to=... copy_func
259
# $to must not exist. to get around the no-clobber restriction, use `unset -f`.
260
{
261
	: "${from:?}" "${to:?}"
262
	func_exists "$from" || die "function does not exist: $from"
263
	! func_exists "$to" || die "function already exists: $to"
264
	local from_def="$(declare -f "$from")"
265
	eval "$to${from_def#$from}"
266
}
267

    
268
func_override() # usage: func_override old_name__suffix
269
{ from="${1%%__*}" to="$1" copy_func; }
270

    
271
ensure_nested_func() # usage: func__nested_func() { ensure_nested_func; ... }
272
{
273
	local nested_func="${FUNCNAME[1]}"
274
	local func="${nested_func%%__*}"
275
	contains "$func" "${FUNCNAME[@]}" || \
276
		die "$nested_func() must be used by $func()"
277
}
278

    
279

    
280
#### paths
281

    
282
# cache realpath
283
: "${realpath_cache=}" # default off because slower than without
284
if test "$realpath_cache"; then
285
func_override realpath__no_cache
286
realpath() # caches the last result for efficiency
287
{
288
	local cache_key="$*"; load_cache
289
	if ! cached; then save_cache "$(realpath__no_cache "$@")" || return; fi
290
	echo_cached_value
291
}
292
fi
293

    
294
rel_path() # usage: base_dir=... path=... rel_path
295
{
296
	log++; kw_params base_dir path
297
	: "${base_dir:?}" "${path:?}"
298
	
299
	local path="$path/" # add *extra* / to match path when exactly = base_dir
300
	path="${path#$base_dir/}" # remove prefix shared with base_dir
301
	path="${path%/}" # remove any remaining extra trailing /
302
	
303
	if test ! "$path"; then path=.; fi # ensure non-empty
304
	
305
	echo_vars path
306
	echo "$path"
307
}
308

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

    
312
canon_rel_path()
313
{
314
	local path; path="$(realpath "$1")" || return
315
	base_dir="$PWD" rel_path
316
}
317

    
318
# makes $1 a canon_rel_path if it's a filesystem path
319
alias cmd2rel_path="$(cat <<'EOF'
320
if test "$(type -t "$1")" = file && test -e "$1"; then # not relative to PATH
321
	declare _1="$1"; shift
322
	_1="$(canon_rel_path "$_1")" || return
323
	set -- "$_1" "$@"
324
fi
325
EOF
326
)"
327

    
328

    
329
#### verbose output
330

    
331

    
332
### command echoing
333

    
334
alias echo_params='log "$*"'
335

    
336
fi # load new aliases
337
if self_being_included; then
338

    
339
echo_cmd() { echo_params; }
340

    
341
echo_eval() { echo_params; builtin eval "$@"; }
342

    
343
## vars
344

    
345
echo_vars() # usage: echo_vars var...
346
{
347
	log+ 2
348
	if can_log; then
349
		local var
350
		for var in "${@%%=*}"; do
351
			if isset "$var"; then log "$(declare -p "$var")"; fi
352
		done
353
	fi
354
}
355

    
356
echo_export() { builtin export "$@"; echo_vars "$@"; }
357

    
358
if test "$verbosity" -ge 2; then
359
	alias export="echo_export" # automatically echo env vars when they are set
360
fi
361

    
362
func_override kw_params__lang
363
kw_params() { kw_params__lang "$@"; echo_vars "$@"; } # echo all keyword params
364

    
365
## functions
366

    
367
# usage: local func=...; set_func_loc; use $file, $line
368
alias set_func_loc="$(cat <<'EOF'
369
: "${func:?}"
370
local func_info="$(shopt -s extdebug; declare -F "$func")" # 'func line file'
371
func_info="${func_info#$func }"
372
local line="${func_info%% *}"
373
local file="${func_info#$line }"
374
EOF
375
)"
376

    
377
fi # load new aliases
378
if self_being_included; then
379

    
380
func_loc() # gets where function declared in the format file:line
381
{
382
	local func="$1"; set_func_loc
383
	file="$(canon_rel_path "$file")" || return
384
	echo "$file:$line"
385
}
386

    
387
# usage: func() { [minor=1] echo_func; ... }
388
function echo_func()
389
# usage: [minor=1] "echo_func" "$FUNCNAME" "$@" && indent || true
390
# exit status: whether function call was echoed
391
{
392
	kw_params minor
393
	local func="$1"; shift
394
	
395
	log++; if test "$minor"; then log++; fi
396
	local loc; loc="$(func_loc "$func")" || return
397
	echo_cmd "$loc" "$func" "$@"
398
	can_log
399
}
400
alias echo_func='"echo_func" "$FUNCNAME" "$@" && indent || true'
401

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

    
405

    
406
#### streams
407

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

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

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

    
415
fd_set_default() # usage: fd_set_default 'dest[<>]src'
416
{
417
	echo_func
418
	local dest="${1%%[<>]*}"
419
	require_fd_not_exists "$dest" || return 0
420
	set_fds "$1"
421
}
422

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

    
425
setup_log_fd() # view logging output at verbosity >= 5
426
{
427
	log+ 4; log-- echo_func 
428
	fd_set_default '30>&2' || true # stdlog
429
	log_fd=30 # stdlog
430
}
431
setup_log_fd
432

    
433
set_global_fds()
434
# allows commands to access global stdin/stdout/stderr using fd 20/21/22
435
# this works even when /dev/tty isn't available
436
# view logging output at verbosity >= 3
437
{
438
	log+ 2; log-- echo_func
439
	# ignore errors if a source fd isn't open
440
	fd_set_default '20<&0' || true
441
	fd_set_default '21>&1' || true
442
	fd_set_default '22>&2' || true
443
}
444
set_global_fds
445
err_fd=22 # global stderr
446

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

    
454

    
455
#### paths
456

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

    
460
set_paths()
461
{
462
	top_script="$(canon_rel_path "$top_script_abs")" || return
463
		echo_vars top_script
464
	top_dir="$(dirname "$top_script")" || return; echo_vars top_dir
465
}
466
set_paths
467

    
468

    
469
#### verbose output
470

    
471

    
472
## internal commands
473

    
474
.()
475
{
476
	cmd2rel_path; set -- "$FUNCNAME" "$@"
477
	(log++; echo_params; can_log) && indent || true
478
	builtin "$@"
479
}
480

    
481
cd() # indent is permanent within subshell cd was used in
482
{
483
	cmd2rel_path; echo_cmd "$FUNCNAME" "$@"
484
	can_log && caller_indent || true
485
	# -P: expand symlinks so $PWD matches the output of realpath
486
	builtin "$FUNCNAME" -P "$@"
487
	
488
	func=realpath clear_cache
489
	set_paths
490
}
491

    
492
## external commands
493

    
494
disable_logging() { set_fds "$log_fd>/dev/null"; }
495

    
496
function command() # usage: [cmd_log_fd=|1|2|#] command extern_cmd...
497
# to view only explicitly-displayed errors: explicit_errors_only=1 script...
498
{
499
	kw_params cmd_log_fd
500
	# if no cmd_log_fd, limit log_fd in case command uses util.sh
501
	local cmd_log_fd="${cmd_log_fd-$log_fd}"
502
	
503
	cmd2rel_path; (echo_params; can_log) && indent || true
504
	(
505
		# the following redirections must happen in exactly this order
506
		if test "$cmd_log_fd"; then command__set_fds; fi
507
		if test "$cmd_log_fd" != 2; then # fd 2 not used for logging
508
			exec 2>&"$err_fd" # assume fd 2 used for errors
509
		fi
510
		
511
		exec -- "$@" # -- so cmd name not treated as `exec` option
512
	) || return
513
}
514
function command__set_fds()
515
{
516
	ensure_nested_func
517
	if can_log; then
518
		if test "$cmd_log_fd" = "$log_fd"; then return 0; fi # no redir needed
519
		local src="&$log_fd"
520
	else local src=/dev/null
521
	fi
522
	set_fds "$cmd_log_fd>$src"
523
}
524

    
525
# auto-echo common external commands
526
for cmd in env rm; do alias "$cmd=command $cmd"; done; unset cmd
527

    
528

    
529
### external command input/output
530

    
531
pipe_delay() # usage: cmd1 | { pipe_delay; cmd2; }
532
{ sleep 0.1; } # s; display after leading output of cmd1
533

    
534
fi # load new aliases
535
if self_being_included; then
536

    
537
echo_stdin() # usage: input|echo_stdin|cmd
538
{
539
	if can_log; then
540
		pipe_delay
541
		echo ----- >&"$log_fd"
542
		tee -a /dev/fd/"$log_fd";
543
		echo ----- >&"$log_fd"
544
	else cat
545
	fi
546
}
547

    
548
echo_stdout() { echo_stdin; } # usage: cmd|echo_stdout
549

    
550

    
551
#### commands
552

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

    
556
function to_file() # usage: stdout=... [if_not_exists=1] to_file cmd...
557
# auto-removes a command's output file on error (like make's .DELETE_ON_ERROR)
558
{
559
	echo_func; kw_params stdout
560
	: "${stdout?}"
561
	test ! "$if_not_exists" || require_not_exists "$stdout" || return 0
562
	"$@" >"$stdout" || { save_e; log_e; rm "$stdout"; rethrow; }
563
}
564
alias to_file='"to_file" ' # last space alias-expands next word
565

    
566
run_args_cmd() # runs the command line args command
567
{
568
	eval set -- "$(reverse "${BASH_ARGV[@]}")"
569
	test $# -ge 1 || set -- all
570
	echo_cmd "$top_script" "$@"; "$@"
571
}
572

    
573
fwd() # usage: subdirs=(...); fwd "$FUNCNAME" "$@"
574
{
575
	echo_func
576
	: "${subdirs?}"
577
	
578
	for subdir in "${subdirs[@]}"; do "$top_dir"/"$subdir"/run "$@"; done
579
}
580

    
581

    
582
#### URLs
583

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

    
586
fi
(5-5/5)