Project

General

Profile

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