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
: "${verbosity=3}"
91

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

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

    
97
: "${log_indent=  }"
98

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

    
106
fi # load new aliases
107
if self_being_included; then
108

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

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

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

    
124
echo_run () { echo_cmd "$@"; "$@"; }
125

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

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

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

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

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

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

    
149
fi # load new aliases
150
if self_being_included; then
151

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

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

    
162
fi # load new aliases
163
if self_being_included; then
164

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

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

    
186
echo_export ()
187
{
188
	builtin export "$@"
189
	echo_vars "$@"
190
}
191

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

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

    
198
fi # load new aliases
199
if self_being_included; then
200

    
201
#### strings
202

    
203
sed_ere_flag="$(test "$(uname)" = Darwin && echo E || echo r)"
204

    
205
sed () { self -"$sed_ere_flag" "$@";}
206

    
207
#### vars
208

    
209
set_var () { eval "$1"'="$2"'; }
210

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

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

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

    
227
#### commands
228

    
229
top_script="$0" # outermost script
230
top_dir="$(dirname "$top_script")"
231

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

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

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

    
255
#### make
256

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

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

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

    
271
make () { echo_func; stdout2stderr=1 self "$@"; }
272

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

    
297
#### compression
298

    
299
### zip
300

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

    
308
unzip () { stdout2stderr=1 self "$@"; }
309

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

    
315
#### URLs
316

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

    
319
#### databases
320

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

    
326
quote='"'
327

    
328
esc_name () { echo "$quote${1//$quote/$quote$quote}$quote"; }
329

    
330
mk_esc_name () { set_var "$1"_esc "$(esc_name "${!1}")"; }
331

    
332
alias mk_schema_esc='declare schema_esc; mk_esc_name schema'
333
alias mk_table_esc='declare table_esc; mk_esc_name table'
334

    
335
fi # load new aliases
336
if self_being_included; then
337

    
338
log_sql () { test "$verbosity" -ge 2; }
339

    
340
### MySQL
341

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

    
359
mysql () { echo_func; mysql_cmd --verbose "$@"; }
360

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

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

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

    
381
### PostgreSQL
382

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

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

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

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

    
419
fi
(46-46/51)