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=3}"
87

    
88
: "${verbosity:=$verbose}" "${verbosity:=0}"
89

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

    
92
: "${log_indent=  }"
93

    
94
# usage: in func:      inc_log_level; ...
95
#        outside func: inc_log_level; ...; dec_log_level
96
alias inc_log_level='declare verbosity="$verbosity" PS4="$log_indent$PS4"
97
let verbosity--'
98
alias dec_log_level='declare verbosity="$verbosity" PS4="${PS4#$log_indent}"
99
let verbosity++'
100

    
101
fi # load new aliases
102
if self_being_included; then
103

    
104
# usage: (limit_stderr; cmd...) || return
105
# `|| return` needed on Mac because of bug where -e doesn't apply to ()
106
limit_stderr () { inc_log_level; if ! can_log; then exec 2>/dev/null; fi; }
107

    
108
limit_stderr_cmd () # usage: [stdout2stderr=1] limit_stderr_cmd cmd...
109
{
110
	echo_cmd "$@"
111
	(limit_stderr
112
		if test -n "$stdout2stderr"; then stdout2stderr; fi
113
		"$@"
114
	) || return
115
}
116

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

    
119
echo_run () { echo_cmd "$@"; "$@"; }
120

    
121
# auto-echo common external commands
122
for cmd in rm; do alias "$cmd=echo_run $cmd"; done; unset cmd
123

    
124
# limits stderr of (and echoes) an external command
125
alias limit_stderr_extern='limit_stderr_cmd "extern" '
126
	# last space alias-expands next word
127

    
128
# echo and limit stderr of all external commands
129
alias extern="limit_stderr_extern " # last space alias-expands next word
130

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

    
133
# commands that are always external
134
for cmd in env; do alias "$cmd=extern $cmd"; done; unset cmd
135

    
136
canon_rel_path ()
137
{
138
	local path="$1"
139
	path="$(realpath "$path")" # canonicalize
140
	path="${path#$(pwd -P)/}" # remove any shared prefix with the current dir
141
	echo "$path"
142
}
143

    
144
fi # load new aliases
145
if self_being_included; then
146

    
147
function echo_func ()
148
{
149
	inc_log_level
150
	local script="$(canon_rel_path "${BASH_SOURCE[1]}")"
151
	echo_cmd "$script:${BASH_LINENO[0]}" "${FUNCNAME[1]}" "$@"
152
}
153

    
154
# usage: cmd1 | { pipe_delay; cmd2; }
155
alias pipe_delay='sleep 0.1' # s; display after leading output of cmd1
156

    
157
fi # load new aliases
158
if self_being_included; then
159

    
160
echo_stdin () # usage: input|echo_stdin|cmd
161
{
162
	inc_log_level
163
	if can_log; then
164
		pipe_delay
165
		echo ----- >&2
166
		tee -a /dev/stderr;
167
		echo ----- >&2
168
	else cat
169
	fi
170
}
171

    
172
echo_vars () # usage: echo_vars var...
173
{
174
	inc_log_level; inc_log_level
175
	if can_log; then
176
		local var
177
		for var in "${@%%=*}"; do { echo -n "$PS4"; declare -p "$var";} >&2;done
178
	fi
179
}
180

    
181
echo_export ()
182
{
183
	builtin export "$@"
184
	echo_vars "$@"
185
}
186

    
187
if test "$verbosity" -ge 2; then
188
	alias export="echo_export" # automatically echo env vars when they are set
189
fi
190

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

    
193
fi # load new aliases
194
if self_being_included; then
195

    
196
#### strings
197

    
198
sed_ere_flag="$(test "$(uname)" = Darwin && echo E || echo r)"
199

    
200
sed () { self -"$sed_ere_flag" "$@";}
201

    
202
#### vars
203

    
204
set_var () { eval "$1"'="$2"'; }
205

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

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

    
211
# usage: local prefix=..._; import_vars
212
alias import_vars="$(cat <<'EOF'
213
: "${prefix:?}"
214
local src_var dest_var
215
for src_var in $(eval echo '${!'$prefix'*}'); do
216
	dest_var="${src_var#$prefix}"
217
	local "$dest_var=${!src_var}"; echo_vars "$dest_var"
218
done
219
EOF
220
)"
221

    
222
#### commands
223

    
224
top_script="$0" # outermost script
225
top_dir="$(dirname "$top_script")"
226

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

    
232
run_args_cmd () # runs the command line args command
233
{
234
	test $? -eq 0 || return
235
	eval set -- "$(reverse "${BASH_ARGV[@]}")"
236
	test $# -ge 1 || set -- all
237
	echo_cmd "$(canon_rel_path "$0")" "$@"; "$@"
238
}
239

    
240
fwd () # usage: subdirs=(...); fwd "$FUNCNAME" "$@"
241
{
242
	echo_func
243
	: "${subdirs?}"
244
	
245
	for subdir in "${subdirs[@]}"; do
246
		"$(dirname "${BASH_SOURCE[1]}")"/"$subdir"/run "$@"
247
	done
248
}
249

    
250
#### make
251

    
252
# usage: target_filename/command () { echo_func; set_make_vars; ...; }
253
alias set_make_vars="$(cat <<'EOF'
254
local command="${FUNCNAME##*/}"; echo_vars command
255
local target_filename="${FUNCNAME%/*}"; echo_vars target_filename
256
local target="$top_dir/$target_filename"; echo_vars target
257
EOF
258
)"
259

    
260
# usage: set_make_vars; check_target_exists
261
alias check_target_exists='! test -e "$target" || return 0'
262

    
263
# usage: set_make_vars; to_target cmd...
264
alias to_target='stdout="$target" to_file ' # last space alias-expands next word
265

    
266
make () { echo_func; stdout2stderr=1 self "$@"; }
267

    
268
if false; then ## usage:
269
inline_make 3<<'EOF'
270
target:
271
	$(self_dir)/cmd >$@
272
EOF
273
# target will be run automatically because it's first in the makefile
274
fi ##
275
inline_make ()
276
{
277
	echo_func
278
	local self="$(readlink -f "${BASH_SOURCE[1]}")"
279
	local self_dir="$(dirname "$self")"
280
	export self self_dir
281
	
282
	make --makefile=<((
283
		cat /dev/fd/3
284
		echo -n "
285
.SUFFIXES: # turn off built-in suffix rules
286
.SECONDARY: # don't automatically delete intermediate files
287
.DELETE_ON_ERROR: # delete target if recipe fails
288
"
289
	)|echo_stdin) "$@"
290
}
291

    
292
#### compression
293

    
294
### zip
295

    
296
zip ()
297
{
298
	stdout2stderr=1 try self "$@"
299
	ignore 12 # "zip has nothing to do" (`man zip`)
300
	end_try
301
}
302

    
303
unzip () { stdout2stderr=1 self "$@"; }
304

    
305
set_inv force
306
alias zip_newer='zip ${no_force:+-u }'
307
alias unzip_newer='unzip ${no_force:+-u }-o'
308
	# -o is safe because -u only extracts newer files
309

    
310
#### URLs
311

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

    
314
#### databases
315

    
316
# using prefixed connection vars
317
alias use_local='declare prefix=local_; import_vars'
318
alias use_remote='declare prefix=remote_; import_vars'
319
alias use_local_remote='use_local; use_remote'
320

    
321
quote='"'
322

    
323
esc_name () { echo "$quote${1//$quote/$quote$quote}$quote"; }
324

    
325
mk_esc_name () { set_var "$1"_esc "$(esc_name "${!1}")"; }
326

    
327
alias mk_schema_esc='declare schema_esc; mk_esc_name schema'
328
alias mk_table_esc='declare table_esc; mk_esc_name table'
329

    
330
fi # load new aliases
331
if self_being_included; then
332

    
333
log_sql () { test "$verbosity" -ge 2; }
334

    
335
### MySQL
336

    
337
# auto-adds connection/login opts when specified
338
mysql_cmd () # usage: mysql* () { ...; mysql_cmd "$@"; }
339
{
340
	echo_func
341
	local ssh_server="$(localize_url "$ssh_server")"
342
	local server="$(localize_url "$server")"
343
	if test -n "$ssh_server"; then
344
		local ssh_dest="${ssh_dest-${ssh_user:+$ssh_user@}$ssh_server}"
345
	fi
346
	if test -n "$schema"; then local database="${database-$schema}"; fi
347
	
348
	local var=ssh_dest; local_inv
349
	extern ${ssh_dest:+ssh "$ssh_dest" }"${FUNCNAME[1]}" \
350
${server:+ --host="$server" }${user:+--user="$user" } --password\
351
${password+="$password"} ${database:+--databases "$database" --tables } "$@"
352
}
353

    
354
mysql () { echo_func; mysql_cmd --verbose "$@"; }
355

    
356
mysql_ANSI ()
357
{
358
	echo_func
359
	(echo "SET sql_mode = 'ANSI';"; cat)|mysql "$@"
360
}
361

    
362
mysqldump () # usage: [schema=1 | data=1] mysqldump db [table...]
363
{
364
	echo_func
365
	mysql_cmd --quick --lock-tables=false --set-charset \
366
${postgres_compat:+--compatible=postgresql --add-locks=false }\
367
${schema:+--no-data }${data:+--no-create-info }"$@"
368
}
369

    
370
mysqldump_diffable ()
371
{
372
	echo_func
373
	mysqldump "$@"|sed 's/^(-- Dump completed).*$/\1/'
374
}
375

    
376
### PostgreSQL
377

    
378
pg_copy_to ()
379
{
380
	echo_func
381
	if test -z "$source"; then
382
		: "${table:?}"; mk_table_esc
383
		if test -z "$limit"; then local source="$table_esc"
384
		else local source="(SELECT * FROM $table_esc LIMIT $limit)"
385
		fi
386
	fi
387
	local pg_copy_format="${pg_copy_format-CSV HEADER}"
388
	
389
	psql "$@" <<<"COPY $source TO STDOUT $pg_copy_format;"
390
}
391

    
392
pg_header ()
393
{
394
	echo_func
395
	local pg_copy_format="CSV HEADER" limit=0
396
	pg_copy_to "$@"|echo_stdin
397
}
398

    
399
pg_export_table_no_header ()
400
{
401
	echo_func
402
	local pg_copy_format="CSV"
403
	pg_copy_to "$@"
404
}
405

    
406
pg_export_table_to_dir_no_header ()
407
{
408
	echo_func
409
	local table="$1"; shift; mk_table_esc
410
	local cols="$(pg_header)"
411
	pg_export_table_no_header "$@" >"$exports_dir/$table.no_header.cols=$cols.csv"
412
}
413

    
414
fi
(46-46/51)