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+isset}" && \
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=3}"
87

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

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

    
93
: "${log_indent=  }"
94

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

    
102
fi # load new aliases
103
if self_being_included; then
104

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

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

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

    
120
echo_run () { echo_cmd "$@"; "$@"; }
121

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

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

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

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

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

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

    
145
fi # load new aliases
146
if self_being_included; then
147

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

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

    
158
fi # load new aliases
159
if self_being_included; then
160

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

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

    
182
echo_export ()
183
{
184
	builtin export "$@"
185
	echo_vars "$@"
186
}
187

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

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

    
194
fi # load new aliases
195
if self_being_included; then
196

    
197
#### strings
198

    
199
sed_ere_flag="$(test "$(uname)" = Darwin && echo E || echo r)"
200

    
201
sed () { self -"$sed_ere_flag" "$@";}
202

    
203
#### vars
204

    
205
set_var () { eval "$1"'="$2"'; }
206

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

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

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

    
223
#### commands
224

    
225
top_script="$0" # outermost script
226
top_dir="$(dirname "$top_script")"
227

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

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

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

    
251
#### make
252

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

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

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

    
267
make () { echo_func; stdout2stderr=1 self "$@"; }
268

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

    
293
#### compression
294

    
295
### zip
296

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

    
304
unzip () { stdout2stderr=1 self "$@"; }
305

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

    
311
#### URLs
312

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

    
315
#### databases
316

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

    
322
quote='"'
323

    
324
esc_name () { echo "$quote${1//$quote/$quote$quote}$quote"; }
325

    
326
mk_esc_name () { set_var "$1"_esc "$(esc_name "${!1}")"; }
327

    
328
alias mk_schema_esc='declare schema_esc; mk_esc_name schema'
329
alias mk_table_esc='declare table_esc; mk_esc_name table'
330

    
331
fi # load new aliases
332
if self_being_included; then
333

    
334
log_sql () { test "$verbosity" -ge 2; }
335

    
336
### MySQL
337

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

    
355
mysql () { echo_func; mysql_cmd --verbose "$@"; }
356

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

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

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

    
377
### PostgreSQL
378

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

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

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

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

    
415
fi
(46-46/51)