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