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