Project

General

Profile

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