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
bool2int () { save_e test -z "$1"; echo "$e"; } # empty->0; non-empty->1
73

    
74
#### arrays
75

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

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

    
84
#### verbose output
85

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

    
90
if isset verbose; then : "${verbosity:=$(bool2int "$verbose")}"; fi
91

    
92
: "${verbosity=3}"
93

    
94
: "${verbosity:=0}"
95
export verbosity # propagate the verbosity to invoked commands
96

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

    
99
: "${log_indent=  }"
100

    
101
# usage: in func:      inc_log_level; ...
102
#        outside func: inc_log_level; ...; dec_log_level
103
alias inc_log_level='declare verbosity="$verbosity" PS4="$log_indent$PS4"
104
let verbosity--'
105
alias dec_log_level='declare verbosity="$verbosity" PS4="${PS4#$log_indent}"
106
let verbosity++'
107

    
108
fi # load new aliases
109
if self_being_included; then
110

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

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

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

    
126
echo_run () { echo_cmd "$@"; "$@"; }
127

    
128
# auto-echo common external commands
129
for cmd in rm; do alias "$cmd=echo_run $cmd"; done; unset cmd
130

    
131
# limits stderr of (and echoes) an external command
132
alias limit_stderr_extern='limit_stderr_cmd "extern" '
133
	# last space alias-expands next word
134

    
135
# echo and limit stderr of all external commands
136
alias extern="limit_stderr_extern " # last space alias-expands next word
137

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

    
140
# commands that are always external
141
for cmd in env; do alias "$cmd=extern $cmd"; done; unset cmd
142

    
143
canon_rel_path ()
144
{
145
	local path="$1"
146
	path="$(realpath "$path")" # canonicalize
147
	path="${path#$(pwd -P)/}" # remove any shared prefix with the current dir
148
	echo "$path"
149
}
150

    
151
fi # load new aliases
152
if self_being_included; then
153

    
154
function echo_func ()
155
{
156
	inc_log_level
157
	local script="$(canon_rel_path "${BASH_SOURCE[1]}")"
158
	echo_cmd "$script:${BASH_LINENO[0]}" "${FUNCNAME[1]}" "$@"
159
}
160

    
161
# usage: cmd1 | { pipe_delay; cmd2; }
162
alias pipe_delay='sleep 0.1' # s; display after leading output of cmd1
163

    
164
fi # load new aliases
165
if self_being_included; then
166

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

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

    
188
echo_export ()
189
{
190
	builtin export "$@"
191
	echo_vars "$@"
192
}
193

    
194
if test "$verbosity" -ge 2; then
195
	alias export="echo_export" # automatically echo env vars when they are set
196
fi
197

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

    
200
fi # load new aliases
201
if self_being_included; then
202

    
203
#### strings
204

    
205
sed_ere_flag="$(test "$(uname)" = Darwin && echo E || echo r)"
206

    
207
sed () { self -"$sed_ere_flag" "$@";}
208

    
209
#### vars
210

    
211
set_var () { eval "$1"'="$2"'; }
212

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

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

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

    
229
#### commands
230

    
231
top_script="$0" # outermost script
232
top_dir="$(dirname "$top_script")"
233

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

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

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

    
257
#### make
258

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

    
267
# usage: set_make_vars; check_target_exists
268
alias check_target_exists='! test -e "$target" || return 0'
269

    
270
# usage: set_make_vars; to_target cmd...
271
alias to_target='stdout="$target" to_file ' # last space alias-expands next word
272

    
273
make () { echo_func; stdout2stderr=1 self "$@"; }
274

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

    
299
#### compression
300

    
301
### zip
302

    
303
zip ()
304
{
305
	stdout2stderr=1 try self "$@"
306
	ignore 12 # "zip has nothing to do" (`man zip`)
307
	end_try
308
}
309

    
310
unzip () { stdout2stderr=1 self "$@"; }
311

    
312
set_inv force
313
alias zip_newer='zip ${no_force:+-u }'
314
alias unzip_newer='unzip ${no_force:+-u }-o'
315
	# -o is safe because -u only extracts newer files
316

    
317
#### URLs
318

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

    
321
#### databases
322

    
323
# using prefixed connection vars
324
alias use_local='declare prefix=local_; import_vars'
325
alias use_remote='declare prefix=remote_; import_vars'
326
alias use_local_remote='use_local; use_remote'
327

    
328
quote='"'
329

    
330
esc_name () { echo "$quote${1//$quote/$quote$quote}$quote"; }
331

    
332
mk_esc_name () { set_var "$1"_esc "$(esc_name "${!1}")"; }
333

    
334
alias mk_schema_esc='declare schema_esc; mk_esc_name schema'
335
alias mk_table_esc='declare table_esc; mk_esc_name table'
336

    
337
fi # load new aliases
338
if self_being_included; then
339

    
340
log_sql () { test "$verbosity" -ge 2; }
341

    
342
### MySQL
343

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

    
361
mysql () { echo_func; mysql_cmd --verbose "$@"; }
362

    
363
mysql_ANSI ()
364
{
365
	echo_func
366
	(echo "SET sql_mode = 'ANSI';"; cat)|mysql "$@"
367
}
368

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

    
377
mysqldump_diffable ()
378
{
379
	echo_func
380
	mysqldump "$@"|sed 's/^(-- Dump completed).*$/\1/'
381
}
382

    
383
### PostgreSQL
384

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

    
399
pg_header ()
400
{
401
	echo_func
402
	local pg_copy_format="CSV HEADER" limit=0
403
	pg_copy_to "$@"|echo_stdin
404
}
405

    
406
pg_export_table_no_header ()
407
{
408
	echo_func
409
	local pg_copy_format="CSV"
410
	pg_copy_to "$@"
411
}
412

    
413
pg_export_table_to_dir_no_header ()
414
{
415
	echo_func
416
	local table="$1"; shift; mk_table_esc
417
	local cols="$(pg_header)"
418
	pg_export_table_no_header "$@" >"$exports_dir/$table.no_header.cols=$cols.csv"
419
}
420

    
421
fi
(46-46/51)