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