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
fi # load new aliases
100
if self_being_included; then
101

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

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

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

    
116
echo_run () { echo_cmd "$@"; "$@"; }
117

    
118
# auto-echo common external commands
119
for cmd in rm; do alias "$cmd=echo_run $cmd"; done; unset cmd
120

    
121
# limits stderr of (and echoes) an external command
122
alias limit_stderr_extern='echo_run limit_stderr_cmd "extern" '
123
	# last space alias-expands next word
124

    
125
# echo and limit stderr of all external commands
126
alias extern="limit_stderr_extern " # last space alias-expands next word
127

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

    
130
# commands that are always external
131
for cmd in env; do alias "$cmd=extern $cmd"; done; unset cmd
132

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

    
141
fi # load new aliases
142
if self_being_included; then
143

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

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

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

    
172
echo_export ()
173
{
174
	builtin export "$@"
175
	echo_vars "$@"
176
}
177

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

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

    
184
fi # load new aliases
185
if self_being_included; then
186

    
187
#### strings
188

    
189
sed_ere_flag="$(test "$(uname)" = Darwin && echo E || echo r)"
190

    
191
sed () { self -"$sed_ere_flag" "$@";}
192

    
193
#### vars
194

    
195
set_var () { eval "$1"'="$2"'; }
196

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

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

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

    
213
#### commands
214

    
215
top_script="$0" # outermost script
216
top_dir="$(dirname "$top_script")"
217

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

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

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

    
241
#### make
242

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

    
251
# usage: set_make_vars; check_target_exists
252
alias check_target_exists='! test -e "$target" || return 0'
253

    
254
# usage: set_make_vars; to_target cmd...
255
alias to_target='stdout="$target" to_file ' # last space alias-expands next word
256

    
257
make () { echo_func; stdout2stderr=1 self "$@"; }
258

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

    
283
#### compression
284

    
285
### zip
286

    
287
zip ()
288
{
289
	stdout2stderr=1 try self "$@"
290
	ignore 12 # "zip has nothing to do" (`man zip`)
291
	end_try
292
}
293

    
294
unzip () { stdout2stderr=1 self "$@"; }
295

    
296
set_inv force
297
alias zip_newer='zip ${no_force:+-u }'
298
alias unzip_newer='unzip ${no_force:+-u }-o'
299
	# -o is safe because -u only extracts newer files
300

    
301
#### URLs
302

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

    
305
#### databases
306

    
307
# using prefixed connection vars
308
alias use_local='declare prefix=local_; import_vars'
309
alias use_remote='declare prefix=remote_; import_vars'
310
alias use_local_remote='use_local; use_remote'
311

    
312
quote='"'
313

    
314
esc_name () { echo "$quote${1//$quote/$quote$quote}$quote"; }
315

    
316
mk_esc_name () { set_var "$1"_esc "$(esc_name "${!1}")"; }
317

    
318
alias mk_schema_esc='declare schema_esc; mk_esc_name schema'
319
alias mk_table_esc='declare table_esc; mk_esc_name table'
320

    
321
fi # load new aliases
322
if self_being_included; then
323

    
324
log_sql () { test "$verbosity" -ge 2; }
325

    
326
### MySQL
327

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

    
345
mysql () { echo_func; mysql_cmd --verbose "$@"; }
346

    
347
mysql_ANSI ()
348
{
349
	echo_func
350
	(echo "SET sql_mode = 'ANSI';"; cat)|mysql "$@"
351
}
352

    
353
mysqldump () # usage: [schema=1 | data=1] mysqldump db [table...]
354
{
355
	echo_func
356
	mysql_cmd --quick --lock-tables=false --set-charset \
357
${postgres_compat:+--compatible=postgresql --add-locks=false }\
358
${schema:+--no-data }${data:+--no-create-info }"$@"
359
}
360

    
361
mysqldump_diffable ()
362
{
363
	echo_func
364
	mysqldump "$@"|sed 's/^(-- Dump completed).*$/\1/'
365
}
366

    
367
### PostgreSQL
368

    
369
pg_copy_to ()
370
{
371
	echo_func
372
	if test -z "$source"; then
373
		: "${table:?}"; mk_table_esc
374
		if test -z "$limit"; then local source="$table_esc"
375
		else local source="(SELECT * FROM $table_esc LIMIT $limit)"
376
		fi
377
	fi
378
	local pg_copy_format="${pg_copy_format-CSV HEADER}"
379
	
380
	psql "$@" <<<"COPY $source TO STDOUT $pg_copy_format;"
381
}
382

    
383
pg_header ()
384
{
385
	echo_func
386
	local pg_copy_format="CSV HEADER" limit=0
387
	pg_copy_to "$@"|echo_stdin
388
}
389

    
390
pg_export_table_no_header ()
391
{
392
	echo_func
393
	local pg_copy_format="CSV"
394
	pg_copy_to "$@"
395
}
396

    
397
pg_export_table_to_dir_no_header ()
398
{
399
	echo_func
400
	local table="$1"; shift; mk_table_esc
401
	local cols="$(pg_header)"
402
	pg_export_table_no_header "$@" >"$exports_dir/$table.no_header.cols=$cols.csv"
403
}
404

    
405
fi
(46-46/51)