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
# set verbosity
91
if isset verbose; then : "${verbosity:=$(bool2int "$verbose")}"; fi
92
: "${verbosity=3}" # default
93
: "${verbosity:=0}" # ensure non-empty
94
export verbosity # propagate the verbosity to invoked commands
95

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

    
98
: "${log_indent=  }"
99

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    
202
#### strings
203

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

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

    
208
#### vars
209

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

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

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

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

    
228
#### commands
229

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

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

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

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

    
256
#### make
257

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

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

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

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

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

    
298
#### compression
299

    
300
### zip
301

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

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

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

    
316
#### URLs
317

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

    
320
#### databases
321

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

    
327
quote='"'
328

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

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

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

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

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

    
341
### MySQL
342

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

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

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

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

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

    
382
### PostgreSQL
383

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

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

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

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

    
420
fi
(46-46/51)