Project

General

Profile

1
#!/bin/bash -e
2
set -o errexit # in case caller did not have -e in #! line
3

    
4
function extern () { (exec "$@") || return; }
5

    
6
realpath () { readlink -f -- "$1"; }
7

    
8
include_guard_var () { realpath "$1"|"extern" sed 's/[^a-zA-Z0-9_]/_/g'; }
9

    
10
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
	alias self_being_included=false
15
	test -z "${!include_guard+t}" && \
16
	{ eval "$include_guard"=1; alias self_being_included=true; }
17
}
18

    
19
# 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
if self_not_included "${BASH_SOURCE[0]}"; then
26

    
27
shopt -s expand_aliases
28

    
29
unalias () { builtin unalias "$@" 2>&- || true; } # no error if undefined
30

    
31
#### exceptions
32

    
33
alias rethrow='return "$e"'
34
alias rethrow_subshell='exit "$e"'
35

    
36
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
function log_e () # usage: log_e cmd... [ || use $e (or $?) ]
44
{
45
	if ! "save_e" "$@"; then
46
		echo "! $*" >&2
47
		echo "! command exited with error $e" >&2
48
		rethrow
49
	fi
50
}
51
alias log_e='declare e; log_e ' # last space alias-expands next word
52

    
53
# usage: try cmd...; ignore status; if catch status; then ...; fi; end_try
54

    
55
function try () { "save_e" "$@" || true; }
56
alias try='declare e; try ' # last space alias-expands next word
57

    
58
catch () { test "$e" -eq "$1"; e=0; }
59

    
60
ignore () { catch "$@" || true; }
61

    
62
alias end_try='rethrow'
63
alias end_try_subshell='rethrow_subshell'
64

    
65
#### integers
66

    
67
let () { builtin let "$@" || true; }
68
	# "If the last ARG evaluates to 0, let returns 1" (`help let`)
69

    
70
#### arrays
71

    
72
join () { local IFS="$delim"; echo "$*"; } # usage: delim=... join elems...
73

    
74
reverse () # usage: array=($(reverse args...))
75
{
76
	local i
77
	for (( i=$#; i >= 1; i-- )); do printf '%q ' "${!i}"; done
78
}
79

    
80
#### verbose output
81

    
82
# usage: (stdout2stderr; cmd...) || return
83
# `|| return` needed on Mac because of bug where -e doesn't apply to ()
84
stdout2stderr () { exec >&2; }
85

    
86
: "${verbosity:=$verbose}" "${verbosity:=0}"
87

    
88
can_log () { test "$verbosity" -gt 0; } # verbosity=0 turns off all logging
89

    
90
: "${log_indent=  }"
91

    
92
# usage: in func:      inc_log_level; ...
93
#        outside func: inc_log_level; ...; dec_log_level
94
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

    
99
# usage: (log_stderr; cmd...) || return
100
# `|| return` needed on Mac because of bug where -e doesn't apply to ()
101
log_stderr () { if ! can_log; then exec 2>/dev/null; fi; }
102

    
103
log_stderr_cmd () # usage: [stdout2stderr=1] log_stderr_cmd cmd...
104
{
105
	(log_stderr
106
		if test -n "$stdout2stderr"; then stdout2stderr; fi
107
		"$@"
108
	) || return
109
}
110

    
111
echo_cmd () { if can_log; then echo "$PS4$*" >&2; fi; }
112

    
113
echo_run () { echo_cmd "$@"; "$@"; }
114

    
115
# auto-echo common external commands
116
for cmd in rm; do alias "$cmd=echo_run $cmd"; done; unset cmd
117

    
118
# echoes and controls stderr of an external command
119
alias echo_run_extern='echo_run log_stderr_cmd "extern" '
120
	# last space alias-expands next word
121

    
122
# echo and control stderr of all external commands
123
alias extern="echo_run_extern " # last space alias-expands next word
124

    
125
alias self='extern "$FUNCNAME"' # usage: wrapper () { self ...; }
126

    
127
# commands that are always external
128
for cmd in env; do alias "$cmd=extern $cmd"; done; unset cmd
129

    
130
canon_rel_path ()
131
{
132
	local path="$1"
133
	path="$(realpath "$path")" # canonicalize
134
	path="${path#$(pwd -P)/}" # remove any shared prefix with the current dir
135
	echo "$path"
136
}
137

    
138
fi # load new aliases
139
if self_being_included; then
140

    
141
function echo_func ()
142
{
143
	inc_log_level
144
	local script="$(canon_rel_path "${BASH_SOURCE[1]}")"
145
	echo_cmd "$script:${BASH_LINENO[0]}" "${FUNCNAME[1]}" "$@"
146
}
147

    
148
echo_stdin () # usage: input|echo_stdin|cmd
149
{
150
	inc_log_level
151
	if can_log; then
152
		sleep 0.1 # s; display after leading output of the echoed-to command
153
		echo ----- >&2
154
		tee -a /dev/stderr;
155
		echo ----- >&2
156
	else cat
157
	fi
158
}
159

    
160
echo_vars () # usage: echo_vars var...
161
{
162
	inc_log_level; inc_log_level
163
	if can_log; then
164
		local var
165
		for var in "${@%%=*}"; do { echo -n "$PS4"; declare -p "$var";} >&2;done
166
	fi
167
}
168

    
169
echo_export ()
170
{
171
	builtin export "$@"
172
	echo_vars "$@"
173
}
174

    
175
if test "$verbosity" -ge 2; then
176
	alias export="echo_export" # automatically echo env vars when they are set
177
fi
178

    
179
usage () { echo "Usage: $1" >&2; (exit 2); }
180

    
181
fi # load new aliases
182
if self_being_included; then
183

    
184
#### strings
185

    
186
sed_ere_flag="$(test "$(uname)" = Darwin && echo E || echo r)"
187

    
188
sed () { self -"$sed_ere_flag" "$@";}
189

    
190
#### vars
191

    
192
set_var () { eval "$1"'="$2"'; }
193

    
194
set_inv () { set_var no_"$1" "$(test -n "${!1}" || echo 1)"; }
195

    
196
# usage: local var=...; local_inv
197
alias local_inv='declare "no_$var=$(test -n "${!var}" || echo 1)"'
198

    
199
# usage: local prefix=..._; import_vars
200
alias import_vars="$(cat <<'EOF'
201
: "${prefix:?}"
202
local src_var dest_var
203
for src_var in $(eval echo '${!'$prefix'*}'); do
204
	dest_var="${src_var#$prefix}"
205
	local "$dest_var=${!src_var}"; echo_vars "$dest_var"
206
done
207
EOF
208
)"
209

    
210
#### commands
211

    
212
top_script="$0" # outermost script
213
top_dir="$(dirname "$top_script")"
214

    
215
# auto-removes a command's output file on error (like make's .DELETE_ON_ERROR)
216
function to_file () # usage: stdout=... to_file cmd...
217
{ : "${stdout?}"; log_e "$@" >"$stdout" || { rm "$stdout"; rethrow; }; }
218
alias to_file='to_file ' # last space alias-expands next word
219

    
220
run_args_cmd () # runs the command line args command
221
{
222
	test $? -eq 0 || return
223
	eval set -- "$(reverse "${BASH_ARGV[@]}")"
224
	test $# -ge 1 || set -- all
225
	echo_cmd "$(canon_rel_path "$0")" "$@"; "$@"
226
}
227

    
228
fwd () # usage: subdirs=(...); fwd "$FUNCNAME" "$@"
229
{
230
	echo_func
231
	: "${subdirs?}"
232
	
233
	for subdir in "${subdirs[@]}"; do
234
		"$(dirname "${BASH_SOURCE[1]}")"/"$subdir"/run "$@"
235
	done
236
}
237

    
238
#### make
239

    
240
# usage: target_filename/command () { echo_func; set_make_vars; ...; }
241
alias set_make_vars="$(cat <<'EOF'
242
local command="${FUNCNAME##*/}"; echo_vars command
243
local target_filename="${FUNCNAME%/*}"; echo_vars target_filename
244
local target="$top_dir/$target_filename"; echo_vars target
245
EOF
246
)"
247

    
248
# usage: set_make_vars; to_target cmd...
249
alias to_target='stdout="$target" to_file ' # last space alias-expands next word
250

    
251
make () { echo_func; stdout2stderr=1 self "$@"; }
252

    
253
if false; then ## usage:
254
inline_make 3<<'EOF'
255
target:
256
	$(self_dir)/cmd >$@
257
EOF
258
# target will be run automatically because it's first in the makefile
259
fi ##
260
inline_make ()
261
{
262
	echo_func
263
	local self="$(readlink -f "${BASH_SOURCE[1]}")"
264
	local self_dir="$(dirname "$self")"
265
	export self self_dir
266
	
267
	make --makefile=<((
268
		cat /dev/fd/3
269
		echo -n "
270
.SUFFIXES: # turn off built-in suffix rules
271
.SECONDARY: # don't automatically delete intermediate files
272
.DELETE_ON_ERROR: # delete target if recipe fails
273
"
274
	)|echo_stdin) "$@"
275
}
276

    
277
#### compression
278

    
279
### zip
280

    
281
zip ()
282
{
283
	stdout2stderr=1 try self "$@"
284
	ignore 12 # "zip has nothing to do" (`man zip`)
285
	end_try
286
}
287

    
288
unzip () { stdout2stderr=1 self "$@"; }
289

    
290
set_inv force
291
alias zip_newer='zip ${no_force:+-u }'
292
alias unzip_newer='unzip ${no_force:+-u }-o'
293
	# -o is safe because -u only extracts newer files
294

    
295
#### URLs
296

    
297
localize_url () { test _"$1" = _"$(hostname -f)" || echo "$1"; }
298

    
299
#### databases
300

    
301
# using prefixed connection vars
302
alias use_local='declare prefix=local_; import_vars'
303
alias use_remote='declare prefix=remote_; import_vars'
304
alias use_local_remote='use_local; use_remote'
305

    
306
quote='"'
307

    
308
esc_name () { echo "$quote${1//$quote/$quote$quote}$quote"; }
309

    
310
mk_esc_name () { set_var "$1"_esc "$(esc_name "${!1}")"; }
311

    
312
alias mk_schema_esc='declare schema_esc; mk_esc_name schema'
313
alias mk_table_esc='declare table_esc; mk_esc_name table'
314

    
315
fi # load new aliases
316
if self_being_included; then
317

    
318
log_sql () { test "$verbosity" -ge 2; }
319

    
320
### MySQL
321

    
322
# auto-adds connection/login opts when specified
323
mysql_cmd () # usage: mysql* () { ...; mysql_cmd "$@"; }
324
{
325
	echo_func
326
	local ssh_server="$(localize_url "$ssh_server")"
327
	local server="$(localize_url "$server")"
328
	if test -n "$ssh_server"; then
329
		local ssh_dest="${ssh_dest-${ssh_user:+$ssh_user@}$ssh_server}"
330
	fi
331
	if test -n "$schema"; then local database="${database-$schema}"; fi
332
	
333
	local var=ssh_dest; local_inv
334
	extern ${ssh_dest:+ssh "$ssh_dest" }"${FUNCNAME[1]}" \
335
${server:+ --host="$server" }${user:+--user="$user" } --password\
336
${password+="$password"} ${database:+--databases "$database" --tables } "$@"
337
}
338

    
339
mysql () { echo_func; mysql_cmd --verbose "$@"; }
340

    
341
mysql_ANSI ()
342
{
343
	echo_func
344
	(echo "SET sql_mode = 'ANSI';"; cat)|mysql "$@"
345
}
346

    
347
mysqldump () # usage: [schema=1 | data=1] mysqldump db [table...]
348
{
349
	echo_func
350
	mysql_cmd --quick --lock-tables=false --set-charset \
351
${postgres_compat:+--compatible=postgresql --add-locks=false }\
352
${schema:+--no-data }${data:+--no-create-info }"$@"
353
}
354

    
355
mysqldump_diffable ()
356
{
357
	echo_func
358
	mysqldump "$@"|sed 's/^(-- Dump completed).*$/\1/'
359
}
360

    
361
### PostgreSQL
362

    
363
pg_copy_to ()
364
{
365
	echo_func
366
	if test -z "$source"; then
367
		: "${table:?}"; mk_table_esc
368
		if test -z "$limit"; then local source="$table_esc"
369
		else local source="(SELECT * FROM $table_esc LIMIT $limit)"
370
		fi
371
	fi
372
	local pg_copy_format="${pg_copy_format-CSV HEADER}"
373
	
374
	psql "$@" <<<"COPY $source TO STDOUT $pg_copy_format;"
375
}
376

    
377
pg_header ()
378
{
379
	echo_func
380
	local pg_copy_format="CSV HEADER" limit=0
381
	pg_copy_to "$@"|echo_stdin
382
}
383

    
384
pg_export_table_no_header ()
385
{
386
	echo_func
387
	local pg_copy_format="CSV"
388
	pg_copy_to "$@"
389
}
390

    
391
pg_export_table_to_dir_no_header ()
392
{
393
	echo_func
394
	local table="$1"; shift; mk_table_esc
395
	local cols="$(pg_header)"
396
	pg_export_table_no_header "$@" >"$exports_dir/$table.no_header.cols=$cols.csv"
397
}
398

    
399
fi
(46-46/51)