Project

General

Profile

1 8291 aaronmk
#!/bin/bash -e
2 8952 aaronmk
set -o errexit # in case caller did not have -e in #! line
3
4 8957 aaronmk
function extern () { (exec "$@") || return; }
5 8917 aaronmk
6 9002 aaronmk
isset () { test -n "${!1+isset}"; }
7
8 8716 aaronmk
realpath () { readlink -f -- "$1"; }
9 8703 aaronmk
10 8917 aaronmk
include_guard_var () { realpath "$1"|"extern" sed 's/[^a-zA-Z0-9_]/_/g'; }
11 8716 aaronmk
12 8703 aaronmk
self_not_included () # usage: if self_not_included; then ... fi
13
{
14 8971 aaronmk
	test $# -ge 1 || set -- "${BASH_SOURCE[1]}"
15 8703 aaronmk
	local include_guard="$(include_guard_var "$1")"
16 8793 aaronmk
	alias self_being_included=false
17 9003 aaronmk
	! isset "$include_guard" && \
18 8793 aaronmk
	{ eval "$include_guard"=1; alias self_being_included=true; }
19 8703 aaronmk
}
20
21 8793 aaronmk
# to load newly-defined aliases for use in functions in the same file:
22
## fi # load new aliases
23
## if self_being_included; then
24
# this is needed because aliases defined inside an if statement are not
25
# available inside that if statement
26
27 8704 aaronmk
if self_not_included "${BASH_SOURCE[0]}"; then
28
29 8709 aaronmk
shopt -s expand_aliases
30
31 8889 aaronmk
unalias () { builtin unalias "$@" 2>&- || true; } # no error if undefined
32
33 8886 aaronmk
#### exceptions
34
35 8976 aaronmk
alias rethrow='return "$e"'
36
alias rethrow_subshell='exit "$e"'
37
38 8978 aaronmk
fi # load new aliases
39
if self_being_included; then
40
41
# usage: save_e cmd... || use $e (or $?)
42
function save_e () { "$@"; e=$?; rethrow; } # rethrow because e= clears $?
43
alias save_e='declare e; save_e ' # last space alias-expands next word
44
45 8981 aaronmk
function log_e () # usage: log_e cmd... [ || use $e (or $?) ]
46
{
47 8982 aaronmk
	if ! "save_e" "$@"; then
48 8981 aaronmk
		echo "! $*" >&2
49
		echo "! command exited with error $e" >&2
50
		rethrow
51
	fi
52
}
53 8982 aaronmk
alias log_e='declare e; log_e ' # last space alias-expands next word
54 8981 aaronmk
55 8886 aaronmk
# usage: try cmd...; ignore status; if catch status; then ...; fi; end_try
56
57 8980 aaronmk
function try () { "save_e" "$@" || true; }
58
alias try='declare e; try ' # last space alias-expands next word
59 8886 aaronmk
60
catch () { test "$e" -eq "$1"; e=0; }
61
62
ignore () { catch "$@" || true; }
63
64 8977 aaronmk
alias end_try='rethrow'
65
alias end_try_subshell='rethrow_subshell'
66 8886 aaronmk
67 8899 aaronmk
#### integers
68
69
let () { builtin let "$@" || true; }
70
	# "If the last ARG evaluates to 0, let returns 1" (`help let`)
71
72 9004 aaronmk
bool2int () { save_e test -z "$1"; echo "$e"; } # empty->0; non-empty->1
73
74 8854 aaronmk
#### arrays
75 8694 aaronmk
76 8833 aaronmk
join () { local IFS="$delim"; echo "$*"; } # usage: delim=... join elems...
77 8816 aaronmk
78 8691 aaronmk
reverse () # usage: array=($(reverse args...))
79
{
80
	local i
81
	for (( i=$#; i >= 1; i-- )); do printf '%q ' "${!i}"; done
82
}
83
84 8854 aaronmk
#### verbose output
85
86 8973 aaronmk
# usage: (stdout2stderr; cmd...) || return
87
# `|| return` needed on Mac because of bug where -e doesn't apply to ()
88 8914 aaronmk
stdout2stderr () { exec >&2; }
89
90 8999 aaronmk
: "${verbosity=3}"
91
92 8713 aaronmk
: "${verbosity:=$verbose}" "${verbosity:=0}"
93 9000 aaronmk
export verbosity # propagate the verbosity to invoked commands
94 8710 aaronmk
95 8898 aaronmk
can_log () { test "$verbosity" -gt 0; } # verbosity=0 turns off all logging
96 8895 aaronmk
97 8920 aaronmk
: "${log_indent=  }"
98 8919 aaronmk
99 8900 aaronmk
# usage: in func:      inc_log_level; ...
100
#        outside func: inc_log_level; ...; dec_log_level
101 8919 aaronmk
alias inc_log_level='declare verbosity="$verbosity" PS4="$log_indent$PS4"
102
let verbosity--'
103
alias dec_log_level='declare verbosity="$verbosity" PS4="${PS4#$log_indent}"
104
let verbosity++'
105 8900 aaronmk
106 8995 aaronmk
fi # load new aliases
107
if self_being_included; then
108
109 8994 aaronmk
# usage: (limit_stderr; cmd...) || return
110 8973 aaronmk
# `|| return` needed on Mac because of bug where -e doesn't apply to ()
111 8995 aaronmk
limit_stderr () { inc_log_level; if ! can_log; then exec 2>/dev/null; fi; }
112 8904 aaronmk
113 8994 aaronmk
limit_stderr_cmd () # usage: [stdout2stderr=1] limit_stderr_cmd cmd...
114 8915 aaronmk
{
115 8996 aaronmk
	echo_cmd "$@"
116 8994 aaronmk
	(limit_stderr
117 8915 aaronmk
		if test -n "$stdout2stderr"; then stdout2stderr; fi
118
		"$@"
119 8955 aaronmk
	) || return
120 8915 aaronmk
}
121 8911 aaronmk
122 8897 aaronmk
echo_cmd () { if can_log; then echo "$PS4$*" >&2; fi; }
123 8272 aaronmk
124 8278 aaronmk
echo_run () { echo_cmd "$@"; "$@"; }
125
126 8984 aaronmk
# auto-echo common external commands
127
for cmd in rm; do alias "$cmd=echo_run $cmd"; done; unset cmd
128
129 8994 aaronmk
# limits stderr of (and echoes) an external command
130 8996 aaronmk
alias limit_stderr_extern='limit_stderr_cmd "extern" '
131 8983 aaronmk
	# last space alias-expands next word
132 8906 aaronmk
133 8994 aaronmk
# echo and limit stderr of all external commands
134
alias extern="limit_stderr_extern " # last space alias-expands next word
135 8907 aaronmk
136 8929 aaronmk
alias self='extern "$FUNCNAME"' # usage: wrapper () { self ...; }
137
138 8908 aaronmk
# commands that are always external
139
for cmd in env; do alias "$cmd=extern $cmd"; done; unset cmd
140 8872 aaronmk
141 8646 aaronmk
canon_rel_path ()
142
{
143
	local path="$1"
144 8716 aaronmk
	path="$(realpath "$path")" # canonicalize
145 8773 aaronmk
	path="${path#$(pwd -P)/}" # remove any shared prefix with the current dir
146 8646 aaronmk
	echo "$path"
147
}
148
149 8909 aaronmk
fi # load new aliases
150 8884 aaronmk
if self_being_included; then
151
152 8909 aaronmk
function echo_func ()
153 8463 aaronmk
{
154 8901 aaronmk
	inc_log_level
155 8647 aaronmk
	local script="$(canon_rel_path "${BASH_SOURCE[1]}")"
156
	echo_cmd "$script:${BASH_LINENO[0]}" "${FUNCNAME[1]}" "$@"
157 8463 aaronmk
}
158 8885 aaronmk
159 8997 aaronmk
# usage: cmd1 | { pipe_delay; cmd2; }
160
alias pipe_delay='sleep 0.1' # s; display after leading output of cmd1
161
162
fi # load new aliases
163
if self_being_included; then
164
165 8702 aaronmk
echo_stdin () # usage: input|echo_stdin|cmd
166
{
167 8901 aaronmk
	inc_log_level
168 8897 aaronmk
	if can_log; then
169 8998 aaronmk
		pipe_delay
170 8897 aaronmk
		echo ----- >&2
171
		tee -a /dev/stderr;
172
		echo ----- >&2
173
	else cat
174
	fi
175 8702 aaronmk
}
176 8275 aaronmk
177 8856 aaronmk
echo_vars () # usage: echo_vars var...
178 8901 aaronmk
{
179 8922 aaronmk
	inc_log_level; inc_log_level
180 8921 aaronmk
	if can_log; then
181
		local var
182
		for var in "${@%%=*}"; do { echo -n "$PS4"; declare -p "$var";} >&2;done
183
	fi
184 8901 aaronmk
}
185 8641 aaronmk
186
echo_export ()
187
{
188 8700 aaronmk
	builtin export "$@"
189 8641 aaronmk
	echo_vars "$@"
190
}
191
192 8713 aaronmk
if test "$verbosity" -ge 2; then
193 8711 aaronmk
	alias export="echo_export" # automatically echo env vars when they are set
194
fi
195 8642 aaronmk
196 8272 aaronmk
usage () { echo "Usage: $1" >&2; (exit 2); }
197
198 8873 aaronmk
fi # load new aliases
199
if self_being_included; then
200
201 8871 aaronmk
#### strings
202
203
sed_ere_flag="$(test "$(uname)" = Darwin && echo E || echo r)"
204
205 8930 aaronmk
sed () { self -"$sed_ere_flag" "$@";}
206 8871 aaronmk
207 8854 aaronmk
#### vars
208
209
set_var () { eval "$1"'="$2"'; }
210
211 8857 aaronmk
set_inv () { set_var no_"$1" "$(test -n "${!1}" || echo 1)"; }
212
213 8859 aaronmk
# usage: local var=...; local_inv
214 8888 aaronmk
alias local_inv='declare "no_$var=$(test -n "${!var}" || echo 1)"'
215 8859 aaronmk
216 8863 aaronmk
# usage: local prefix=..._; import_vars
217
alias import_vars="$(cat <<'EOF'
218
: "${prefix:?}"
219
local src_var dest_var
220
for src_var in $(eval echo '${!'$prefix'*}'); do
221
	dest_var="${src_var#$prefix}"
222
	local "$dest_var=${!src_var}"; echo_vars "$dest_var"
223
done
224
EOF
225
)"
226
227 8854 aaronmk
#### commands
228
229 8934 aaronmk
top_script="$0" # outermost script
230
top_dir="$(dirname "$top_script")"
231 8272 aaronmk
232 8986 aaronmk
# auto-removes a command's output file on error (like make's .DELETE_ON_ERROR)
233
function to_file () # usage: stdout=... to_file cmd...
234
{ : "${stdout?}"; log_e "$@" >"$stdout" || { rm "$stdout"; rethrow; }; }
235
alias to_file='to_file ' # last space alias-expands next word
236
237 8465 aaronmk
run_args_cmd () # runs the command line args command
238 8272 aaronmk
{
239 8971 aaronmk
	test $? -eq 0 || return
240 8693 aaronmk
	eval set -- "$(reverse "${BASH_ARGV[@]}")"
241 8971 aaronmk
	test $# -ge 1 || set -- all
242 8648 aaronmk
	echo_cmd "$(canon_rel_path "$0")" "$@"; "$@"
243 8272 aaronmk
}
244
245 8284 aaronmk
fwd () # usage: subdirs=(...); fwd "$FUNCNAME" "$@"
246 8272 aaronmk
{
247 8881 aaronmk
	echo_func
248 8284 aaronmk
	: "${subdirs?}"
249
250 8272 aaronmk
	for subdir in "${subdirs[@]}"; do
251 8280 aaronmk
		"$(dirname "${BASH_SOURCE[1]}")"/"$subdir"/run "$@"
252 8272 aaronmk
	done
253
}
254
255 8854 aaronmk
#### make
256
257 8881 aaronmk
# usage: target_filename/command () { echo_func; set_make_vars; ...; }
258 8880 aaronmk
alias set_make_vars="$(cat <<'EOF'
259
local command="${FUNCNAME##*/}"; echo_vars command
260
local target_filename="${FUNCNAME%/*}"; echo_vars target_filename
261
local target="$top_dir/$target_filename"; echo_vars target
262
EOF
263
)"
264
265 8989 aaronmk
# usage: set_make_vars; check_target_exists
266
alias check_target_exists='! test -e "$target" || return 0'
267
268 8987 aaronmk
# usage: set_make_vars; to_target cmd...
269
alias to_target='stdout="$target" to_file ' # last space alias-expands next word
270
271 8959 aaronmk
make () { echo_func; stdout2stderr=1 self "$@"; }
272 8272 aaronmk
273 8276 aaronmk
if false; then ## usage:
274 8652 aaronmk
inline_make 3<<'EOF'
275 8276 aaronmk
target:
276
	$(self_dir)/cmd >$@
277
EOF
278
# target will be run automatically because it's first in the makefile
279
fi ##
280
inline_make ()
281
{
282 8881 aaronmk
	echo_func
283 8640 aaronmk
	local self="$(readlink -f "${BASH_SOURCE[1]}")"
284
	local self_dir="$(dirname "$self")"
285 8645 aaronmk
	export self self_dir
286 8640 aaronmk
287 8651 aaronmk
	make --makefile=<((
288 8652 aaronmk
		cat /dev/fd/3
289 8651 aaronmk
		echo -n "
290 8276 aaronmk
.SUFFIXES: # turn off built-in suffix rules
291
.SECONDARY: # don't automatically delete intermediate files
292
.DELETE_ON_ERROR: # delete target if recipe fails
293 8651 aaronmk
"
294
	)|echo_stdin) "$@"
295 8276 aaronmk
}
296 8658 aaronmk
297 8854 aaronmk
#### compression
298
299
### zip
300
301 8887 aaronmk
zip ()
302
{
303 8930 aaronmk
	stdout2stderr=1 try self "$@"
304 8887 aaronmk
	ignore 12 # "zip has nothing to do" (`man zip`)
305
	end_try
306
}
307
308 8930 aaronmk
unzip () { stdout2stderr=1 self "$@"; }
309 8902 aaronmk
310 8858 aaronmk
set_inv force
311 8974 aaronmk
alias zip_newer='zip ${no_force:+-u }'
312
alias unzip_newer='unzip ${no_force:+-u }-o'
313 8858 aaronmk
	# -o is safe because -u only extracts newer files
314 8704 aaronmk
315 8966 aaronmk
#### URLs
316
317
localize_url () { test _"$1" = _"$(hostname -f)" || echo "$1"; }
318
319 8775 aaronmk
#### databases
320
321 8868 aaronmk
# using prefixed connection vars
322 8975 aaronmk
alias use_local='declare prefix=local_; import_vars'
323
alias use_remote='declare prefix=remote_; import_vars'
324
alias use_local_remote='use_local; use_remote'
325 8864 aaronmk
326 8775 aaronmk
quote='"'
327
328
esc_name () { echo "$quote${1//$quote/$quote$quote}$quote"; }
329
330
mk_esc_name () { set_var "$1"_esc "$(esc_name "${!1}")"; }
331
332 8975 aaronmk
alias mk_schema_esc='declare schema_esc; mk_esc_name schema'
333
alias mk_table_esc='declare table_esc; mk_esc_name table'
334 8796 aaronmk
335
fi # load new aliases
336
if self_being_included; then
337
338
log_sql () { test "$verbosity" -ge 2; }
339
340
### MySQL
341
342 8862 aaronmk
# auto-adds connection/login opts when specified
343 8865 aaronmk
mysql_cmd () # usage: mysql* () { ...; mysql_cmd "$@"; }
344 8860 aaronmk
{
345 8881 aaronmk
	echo_func
346 8967 aaronmk
	local ssh_server="$(localize_url "$ssh_server")"
347 8968 aaronmk
	local server="$(localize_url "$server")"
348 8869 aaronmk
	if test -n "$ssh_server"; then
349
		local ssh_dest="${ssh_dest-${ssh_user:+$ssh_user@}$ssh_server}"
350
	fi
351 8875 aaronmk
	if test -n "$schema"; then local database="${database-$schema}"; fi
352 8869 aaronmk
353 8860 aaronmk
	local var=ssh_dest; local_inv
354 8910 aaronmk
	extern ${ssh_dest:+ssh "$ssh_dest" }"${FUNCNAME[1]}" \
355 8879 aaronmk
${server:+ --host="$server" }${user:+--user="$user" } --password\
356
${password+="$password"} ${database:+--databases "$database" --tables } "$@"
357 8860 aaronmk
}
358
359 8959 aaronmk
mysql () { echo_func; mysql_cmd --verbose "$@"; }
360 8775 aaronmk
361
mysql_ANSI ()
362
{
363 8881 aaronmk
	echo_func
364 8775 aaronmk
	(echo "SET sql_mode = 'ANSI';"; cat)|mysql "$@"
365
}
366
367 8866 aaronmk
mysqldump () # usage: [schema=1 | data=1] mysqldump db [table...]
368
{
369 8881 aaronmk
	echo_func
370 8866 aaronmk
	mysql_cmd --quick --lock-tables=false --set-charset \
371
${postgres_compat:+--compatible=postgresql --add-locks=false }\
372
${schema:+--no-data }${data:+--no-create-info }"$@"
373
}
374
375 8867 aaronmk
mysqldump_diffable ()
376
{
377 8881 aaronmk
	echo_func
378 8867 aaronmk
	mysqldump "$@"|sed 's/^(-- Dump completed).*$/\1/'
379
}
380
381 8796 aaronmk
### PostgreSQL
382
383
pg_copy_to ()
384
{
385 8881 aaronmk
	echo_func
386 8805 aaronmk
	if test -z "$source"; then
387
		: "${table:?}"; mk_table_esc
388 8834 aaronmk
		if test -z "$limit"; then local source="$table_esc"
389
		else local source="(SELECT * FROM $table_esc LIMIT $limit)"
390 8805 aaronmk
		fi
391
	fi
392 8834 aaronmk
	local pg_copy_format="${pg_copy_format-CSV HEADER}"
393 8805 aaronmk
394 8807 aaronmk
	psql "$@" <<<"COPY $source TO STDOUT $pg_copy_format;"
395 8796 aaronmk
}
396
397
pg_header ()
398
{
399 8881 aaronmk
	echo_func
400 8806 aaronmk
	local pg_copy_format="CSV HEADER" limit=0
401 8807 aaronmk
	pg_copy_to "$@"|echo_stdin
402 8796 aaronmk
}
403
404
pg_export_table_no_header ()
405
{
406 8881 aaronmk
	echo_func
407 8796 aaronmk
	local pg_copy_format="CSV"
408 8807 aaronmk
	pg_copy_to "$@"
409 8796 aaronmk
}
410
411
pg_export_table_to_dir_no_header ()
412
{
413 8881 aaronmk
	echo_func
414 8796 aaronmk
	local table="$1"; shift; mk_table_esc
415 8807 aaronmk
	local cols="$(pg_header)"
416 8796 aaronmk
	pg_export_table_no_header "$@" >"$exports_dir/$table.no_header.cols=$cols.csv"
417
}
418
419 8704 aaronmk
fi