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+t}" && \
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:=$verbose}" "${verbosity:=0}"
87

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

    
90
: "${log_indent=  }"
91

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

    
99
# usage: (log_stderr; cmd...) || return
100
# `|| return` needed on Mac because of bug where -e doesn't apply to ()
101
log_stderr () { if ! can_log; then exec 2>/dev/null; fi; }
102

    
103
log_stderr_cmd () # usage: [stdout2stderr=1] log_stderr_cmd cmd...
104
{
105
	(log_stderr
106
		if test -n "$stdout2stderr"; then stdout2stderr; fi
107
		"$@"
108
	) || return
109
}
110

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

    
113
echo_run () { echo_cmd "$@"; "$@"; }
114

    
115
# auto-echo common external commands
116
for cmd in rm; do alias "$cmd=echo_run $cmd"; done; unset cmd
117

    
118
alias echo_run_extern='echo_run log_stderr_cmd "extern" '
119
	# last space alias-expands next word
120

    
121
# automatically echo external commands
122
alias extern="echo_run_extern " # last space alias-expands next word
123

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

    
126
# commands that are always external
127
for cmd in env; do alias "$cmd=extern $cmd"; done; unset cmd
128

    
129
canon_rel_path ()
130
{
131
	local path="$1"
132
	path="$(realpath "$path")" # canonicalize
133
	path="${path#$(pwd -P)/}" # remove any shared prefix with the current dir
134
	echo "$path"
135
}
136

    
137
fi # load new aliases
138
if self_being_included; then
139

    
140
function echo_func ()
141
{
142
	inc_log_level
143
	local script="$(canon_rel_path "${BASH_SOURCE[1]}")"
144
	echo_cmd "$script:${BASH_LINENO[0]}" "${FUNCNAME[1]}" "$@"
145
}
146

    
147
echo_stdin () # usage: input|echo_stdin|cmd
148
{
149
	inc_log_level
150
	if can_log; then
151
		sleep 0.1 # s; display after leading output of the echoed-to command
152
		echo ----- >&2
153
		tee -a /dev/stderr;
154
		echo ----- >&2
155
	else cat
156
	fi
157
}
158

    
159
echo_vars () # usage: echo_vars var...
160
{
161
	inc_log_level; inc_log_level
162
	if can_log; then
163
		local var
164
		for var in "${@%%=*}"; do { echo -n "$PS4"; declare -p "$var";} >&2;done
165
	fi
166
}
167

    
168
echo_export ()
169
{
170
	builtin export "$@"
171
	echo_vars "$@"
172
}
173

    
174
if test "$verbosity" -ge 2; then
175
	alias export="echo_export" # automatically echo env vars when they are set
176
fi
177

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

    
180
fi # load new aliases
181
if self_being_included; then
182

    
183
#### strings
184

    
185
sed_ere_flag="$(test "$(uname)" = Darwin && echo E || echo r)"
186

    
187
sed () { self -"$sed_ere_flag" "$@";}
188

    
189
#### vars
190

    
191
set_var () { eval "$1"'="$2"'; }
192

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

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

    
198
# usage: local prefix=..._; import_vars
199
alias import_vars="$(cat <<'EOF'
200
: "${prefix:?}"
201
local src_var dest_var
202
for src_var in $(eval echo '${!'$prefix'*}'); do
203
	dest_var="${src_var#$prefix}"
204
	local "$dest_var=${!src_var}"; echo_vars "$dest_var"
205
done
206
EOF
207
)"
208

    
209
#### commands
210

    
211
top_script="$0" # outermost script
212
top_dir="$(dirname "$top_script")"
213
top_file="${top_script%.run}"
214
top_filename="$(basename "$top_file")"
215

    
216
run_args_cmd () # runs the command line args command
217
{
218
	test $? -eq 0 || return
219
	eval set -- "$(reverse "${BASH_ARGV[@]}")"
220
	test $# -ge 1 || set -- all
221
	echo_cmd "$(canon_rel_path "$0")" "$@"; "$@"
222
}
223

    
224
fwd () # usage: subdirs=(...); fwd "$FUNCNAME" "$@"
225
{
226
	echo_func
227
	: "${subdirs?}"
228
	
229
	for subdir in "${subdirs[@]}"; do
230
		"$(dirname "${BASH_SOURCE[1]}")"/"$subdir"/run "$@"
231
	done
232
}
233

    
234
#### make
235

    
236
# usage: target_filename/command () { echo_func; set_make_vars; ...; }
237
alias set_make_vars="$(cat <<'EOF'
238
local command="${FUNCNAME##*/}"; echo_vars command
239
local target_filename="${FUNCNAME%/*}"; echo_vars target_filename
240
local target="$top_dir/$target_filename"; echo_vars target
241
EOF
242
)"
243

    
244
make () { echo_func; stdout2stderr=1 self "$@"; }
245

    
246
if false; then ## usage:
247
inline_make 3<<'EOF'
248
target:
249
	$(self_dir)/cmd >$@
250
EOF
251
# target will be run automatically because it's first in the makefile
252
fi ##
253
inline_make ()
254
{
255
	echo_func
256
	local self="$(readlink -f "${BASH_SOURCE[1]}")"
257
	local self_dir="$(dirname "$self")"
258
	export self self_dir
259
	
260
	make --makefile=<((
261
		cat /dev/fd/3
262
		echo -n "
263
.SUFFIXES: # turn off built-in suffix rules
264
.SECONDARY: # don't automatically delete intermediate files
265
.DELETE_ON_ERROR: # delete target if recipe fails
266
"
267
	)|echo_stdin) "$@"
268
}
269

    
270
#### compression
271

    
272
### zip
273

    
274
zip ()
275
{
276
	stdout2stderr=1 try self "$@"
277
	ignore 12 # "zip has nothing to do" (`man zip`)
278
	end_try
279
}
280

    
281
unzip () { stdout2stderr=1 self "$@"; }
282

    
283
set_inv force
284
alias zip_newer='zip ${no_force:+-u }'
285
alias unzip_newer='unzip ${no_force:+-u }-o'
286
	# -o is safe because -u only extracts newer files
287

    
288
#### URLs
289

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

    
292
#### databases
293

    
294
# using prefixed connection vars
295
alias use_local='declare prefix=local_; import_vars'
296
alias use_remote='declare prefix=remote_; import_vars'
297
alias use_local_remote='use_local; use_remote'
298

    
299
quote='"'
300

    
301
esc_name () { echo "$quote${1//$quote/$quote$quote}$quote"; }
302

    
303
mk_esc_name () { set_var "$1"_esc "$(esc_name "${!1}")"; }
304

    
305
alias mk_schema_esc='declare schema_esc; mk_esc_name schema'
306
alias mk_table_esc='declare table_esc; mk_esc_name table'
307

    
308
fi # load new aliases
309
if self_being_included; then
310

    
311
log_sql () { test "$verbosity" -ge 2; }
312

    
313
### MySQL
314

    
315
# auto-adds connection/login opts when specified
316
mysql_cmd () # usage: mysql* () { ...; mysql_cmd "$@"; }
317
{
318
	echo_func
319
	local ssh_server="$(localize_url "$ssh_server")"
320
	local server="$(localize_url "$server")"
321
	if test -n "$ssh_server"; then
322
		local ssh_dest="${ssh_dest-${ssh_user:+$ssh_user@}$ssh_server}"
323
	fi
324
	if test -n "$schema"; then local database="${database-$schema}"; fi
325
	
326
	local var=ssh_dest; local_inv
327
	extern ${ssh_dest:+ssh "$ssh_dest" }"${FUNCNAME[1]}" \
328
${server:+ --host="$server" }${user:+--user="$user" } --password\
329
${password+="$password"} ${database:+--databases "$database" --tables } "$@"
330
}
331

    
332
mysql () { echo_func; mysql_cmd --verbose "$@"; }
333

    
334
mysql_ANSI ()
335
{
336
	echo_func
337
	(echo "SET sql_mode = 'ANSI';"; cat)|mysql "$@"
338
}
339

    
340
mysqldump () # usage: [schema=1 | data=1] mysqldump db [table...]
341
{
342
	echo_func
343
	mysql_cmd --quick --lock-tables=false --set-charset \
344
${postgres_compat:+--compatible=postgresql --add-locks=false }\
345
${schema:+--no-data }${data:+--no-create-info }"$@"
346
}
347

    
348
mysqldump_diffable ()
349
{
350
	echo_func
351
	mysqldump "$@"|sed 's/^(-- Dump completed).*$/\1/'
352
}
353

    
354
### PostgreSQL
355

    
356
pg_copy_to ()
357
{
358
	echo_func
359
	if test -z "$source"; then
360
		: "${table:?}"; mk_table_esc
361
		if test -z "$limit"; then local source="$table_esc"
362
		else local source="(SELECT * FROM $table_esc LIMIT $limit)"
363
		fi
364
	fi
365
	local pg_copy_format="${pg_copy_format-CSV HEADER}"
366
	
367
	psql "$@" <<<"COPY $source TO STDOUT $pg_copy_format;"
368
}
369

    
370
pg_header ()
371
{
372
	echo_func
373
	local pg_copy_format="CSV HEADER" limit=0
374
	pg_copy_to "$@"|echo_stdin
375
}
376

    
377
pg_export_table_no_header ()
378
{
379
	echo_func
380
	local pg_copy_format="CSV"
381
	pg_copy_to "$@"
382
}
383

    
384
pg_export_table_to_dir_no_header ()
385
{
386
	echo_func
387
	local table="$1"; shift; mk_table_esc
388
	local cols="$(pg_header)"
389
	pg_export_table_no_header "$@" >"$exports_dir/$table.no_header.cols=$cols.csv"
390
}
391

    
392
fi
(46-46/51)