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