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
isset () { test -n "${!1+isset}"; }
7

    
8
realpath () { readlink -f -- "$1"; }
9

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

    
12
self_not_included () # usage: if self_not_included; then ... fi
13
{
14
	test $# -ge 1 || set -- "${BASH_SOURCE[1]}"
15
	local include_guard="$(include_guard_var "$1")"
16
	alias self_being_included=false
17
	! isset "$include_guard" && \
18
	{ eval "$include_guard"=1; alias self_being_included=true; }
19
}
20

    
21
# to load newly-defined aliases for use in functions in the same file:
22
## fi # load new aliases
23
## if self_being_included; then
24
# this is needed because aliases defined inside an if statement are not
25
# available inside that if statement
26

    
27
if self_not_included "${BASH_SOURCE[0]}"; then
28

    
29
shopt -s expand_aliases
30

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

    
33
#### exceptions
34

    
35
alias rethrow='return "$e"'
36
alias rethrow_subshell='exit "$e"'
37

    
38
fi # load new aliases
39
if self_being_included; then
40

    
41
# usage: save_e cmd... || use $e (or $?)
42
function save_e () { "$@"; e=$?; rethrow; } # rethrow because e= clears $?
43
alias save_e='declare e; save_e ' # last space alias-expands next word
44

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

    
55
# usage: try cmd...; ignore status; if catch status; then ...; fi; end_try
56

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

    
60
catch () { test "$e" -eq "$1"; e=0; }
61

    
62
ignore () { catch "$@" || true; }
63

    
64
alias end_try='rethrow'
65
alias end_try_subshell='rethrow_subshell'
66

    
67
#### integers
68

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

    
72
#### arrays
73

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

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

    
82
#### verbose output
83

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

    
88
: "${verbosity=3}"
89

    
90
: "${verbosity:=$verbose}" "${verbosity:=0}"
91
export verbosity # propagate the verbosity to invoked commands
92

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

    
95
: "${log_indent=  }"
96

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

    
104
fi # load new aliases
105
if self_being_included; then
106

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

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

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

    
122
echo_run () { echo_cmd "$@"; "$@"; }
123

    
124
# auto-echo common external commands
125
for cmd in rm; do alias "$cmd=echo_run $cmd"; done; unset cmd
126

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

    
131
# echo and limit stderr of all external commands
132
alias extern="limit_stderr_extern " # last space alias-expands next word
133

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

    
136
# commands that are always external
137
for cmd in env; do alias "$cmd=extern $cmd"; done; unset cmd
138

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

    
147
fi # load new aliases
148
if self_being_included; then
149

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

    
157
# usage: cmd1 | { pipe_delay; cmd2; }
158
alias pipe_delay='sleep 0.1' # s; display after leading output of cmd1
159

    
160
fi # load new aliases
161
if self_being_included; then
162

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

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

    
184
echo_export ()
185
{
186
	builtin export "$@"
187
	echo_vars "$@"
188
}
189

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

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

    
196
fi # load new aliases
197
if self_being_included; then
198

    
199
#### strings
200

    
201
sed_ere_flag="$(test "$(uname)" = Darwin && echo E || echo r)"
202

    
203
sed () { self -"$sed_ere_flag" "$@";}
204

    
205
#### vars
206

    
207
set_var () { eval "$1"'="$2"'; }
208

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

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

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

    
225
#### commands
226

    
227
top_script="$0" # outermost script
228
top_dir="$(dirname "$top_script")"
229

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

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

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

    
253
#### make
254

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

    
263
# usage: set_make_vars; check_target_exists
264
alias check_target_exists='! test -e "$target" || return 0'
265

    
266
# usage: set_make_vars; to_target cmd...
267
alias to_target='stdout="$target" to_file ' # last space alias-expands next word
268

    
269
make () { echo_func; stdout2stderr=1 self "$@"; }
270

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

    
295
#### compression
296

    
297
### zip
298

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

    
306
unzip () { stdout2stderr=1 self "$@"; }
307

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

    
313
#### URLs
314

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

    
317
#### databases
318

    
319
# using prefixed connection vars
320
alias use_local='declare prefix=local_; import_vars'
321
alias use_remote='declare prefix=remote_; import_vars'
322
alias use_local_remote='use_local; use_remote'
323

    
324
quote='"'
325

    
326
esc_name () { echo "$quote${1//$quote/$quote$quote}$quote"; }
327

    
328
mk_esc_name () { set_var "$1"_esc "$(esc_name "${!1}")"; }
329

    
330
alias mk_schema_esc='declare schema_esc; mk_esc_name schema'
331
alias mk_table_esc='declare table_esc; mk_esc_name table'
332

    
333
fi # load new aliases
334
if self_being_included; then
335

    
336
log_sql () { test "$verbosity" -ge 2; }
337

    
338
### MySQL
339

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

    
357
mysql () { echo_func; mysql_cmd --verbose "$@"; }
358

    
359
mysql_ANSI ()
360
{
361
	echo_func
362
	(echo "SET sql_mode = 'ANSI';"; cat)|mysql "$@"
363
}
364

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

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

    
379
### PostgreSQL
380

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

    
395
pg_header ()
396
{
397
	echo_func
398
	local pg_copy_format="CSV HEADER" limit=0
399
	pg_copy_to "$@"|echo_stdin
400
}
401

    
402
pg_export_table_no_header ()
403
{
404
	echo_func
405
	local pg_copy_format="CSV"
406
	pg_copy_to "$@"
407
}
408

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

    
417
fi
(46-46/51)