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