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
# usage: try cmd...; ignore status; if catch status; then ...; fi; end_try
37

    
38
try_ () { { "$@"; e=$?;} || true; }
39
alias try='declare e; try_ ' # last space alias-expands next word
40

    
41
catch () { test "$e" -eq "$1"; e=0; }
42

    
43
ignore () { catch "$@" || true; }
44

    
45
alias end_try='return "$e"'
46
alias end_try_subshell='exit "$e"'
47

    
48
#### integers
49

    
50
let () { builtin let "$@" || true; }
51
	# "If the last ARG evaluates to 0, let returns 1" (`help let`)
52

    
53
#### arrays
54

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

    
57
reverse () # usage: array=($(reverse args...))
58
{
59
	local i
60
	for (( i=$#; i >= 1; i-- )); do printf '%q ' "${!i}"; done
61
}
62

    
63
#### verbose output
64

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

    
69
: "${verbosity:=$verbose}" "${verbosity:=0}"
70

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

    
73
: "${log_indent=  }"
74

    
75
# usage: in func:      inc_log_level; ...
76
#        outside func: inc_log_level; ...; dec_log_level
77
alias inc_log_level='declare verbosity="$verbosity" PS4="$log_indent$PS4"
78
let verbosity--'
79
alias dec_log_level='declare verbosity="$verbosity" PS4="${PS4#$log_indent}"
80
let verbosity++'
81

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

    
86
log_stderr_cmd () # usage: [stdout2stderr=1] log_stderr_cmd cmd...
87
{
88
	(log_stderr
89
		if test -n "$stdout2stderr"; then stdout2stderr; fi
90
		"$@"
91
	) || return
92
}
93

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

    
96
echo_run () { echo_cmd "$@"; "$@"; }
97

    
98
alias echo_run_extern='echo_run log_stderr_cmd "extern"'
99

    
100
alias extern="echo_run_extern" # automatically echo external commands
101

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

    
104
# commands that are always external
105
for cmd in env; do alias "$cmd=extern $cmd"; done; unset cmd
106

    
107
canon_rel_path ()
108
{
109
	local path="$1"
110
	path="$(realpath "$path")" # canonicalize
111
	path="${path#$(pwd -P)/}" # remove any shared prefix with the current dir
112
	echo "$path"
113
}
114

    
115
fi # load new aliases
116
if self_being_included; then
117

    
118
function echo_func ()
119
{
120
	inc_log_level
121
	local script="$(canon_rel_path "${BASH_SOURCE[1]}")"
122
	echo_cmd "$script:${BASH_LINENO[0]}" "${FUNCNAME[1]}" "$@"
123
}
124

    
125
echo_stdin () # usage: input|echo_stdin|cmd
126
{
127
	inc_log_level
128
	if can_log; then
129
		sleep 0.1 # s; display after leading output of the echoed-to command
130
		echo ----- >&2
131
		tee -a /dev/stderr;
132
		echo ----- >&2
133
	else cat
134
	fi
135
}
136

    
137
echo_vars () # usage: echo_vars var...
138
{
139
	inc_log_level; inc_log_level
140
	if can_log; then
141
		local var
142
		for var in "${@%%=*}"; do { echo -n "$PS4"; declare -p "$var";} >&2;done
143
	fi
144
}
145

    
146
echo_export ()
147
{
148
	builtin export "$@"
149
	echo_vars "$@"
150
}
151

    
152
if test "$verbosity" -ge 2; then
153
	alias export="echo_export" # automatically echo env vars when they are set
154
fi
155

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

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

    
161
#### strings
162

    
163
sed_ere_flag="$(test "$(uname)" = Darwin && echo E || echo r)"
164

    
165
sed () { self -"$sed_ere_flag" "$@";}
166

    
167
#### vars
168

    
169
set_var () { eval "$1"'="$2"'; }
170

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

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

    
176
# usage: local prefix=..._; import_vars
177
alias import_vars="$(cat <<'EOF'
178
: "${prefix:?}"
179
local src_var dest_var
180
for src_var in $(eval echo '${!'$prefix'*}'); do
181
	dest_var="${src_var#$prefix}"
182
	local "$dest_var=${!src_var}"; echo_vars "$dest_var"
183
done
184
EOF
185
)"
186

    
187
#### commands
188

    
189
top_script="$0" # outermost script
190
top_dir="$(dirname "$top_script")"
191
top_file="${top_script%.run}"
192
top_filename="$(basename "$top_file")"
193

    
194
run_args_cmd () # runs the command line args command
195
{
196
	test $? -eq 0 || return
197
	eval set -- "$(reverse "${BASH_ARGV[@]}")"
198
	test $# -ge 1 || set -- all
199
	echo_cmd "$(canon_rel_path "$0")" "$@"; "$@"
200
}
201

    
202
fwd () # usage: subdirs=(...); fwd "$FUNCNAME" "$@"
203
{
204
	echo_func
205
	: "${subdirs?}"
206
	
207
	for subdir in "${subdirs[@]}"; do
208
		"$(dirname "${BASH_SOURCE[1]}")"/"$subdir"/run "$@"
209
	done
210
}
211

    
212
#### make
213

    
214
# usage: target_filename/command () { echo_func; set_make_vars; ...; }
215
alias set_make_vars="$(cat <<'EOF'
216
local command="${FUNCNAME##*/}"; echo_vars command
217
local target_filename="${FUNCNAME%/*}"; echo_vars target_filename
218
local target="$top_dir/$target_filename"; echo_vars target
219
EOF
220
)"
221

    
222
make () { echo_func; stdout2stderr=1 self "$@"; }
223

    
224
if false; then ## usage:
225
inline_make 3<<'EOF'
226
target:
227
	$(self_dir)/cmd >$@
228
EOF
229
# target will be run automatically because it's first in the makefile
230
fi ##
231
inline_make ()
232
{
233
	echo_func
234
	local self="$(readlink -f "${BASH_SOURCE[1]}")"
235
	local self_dir="$(dirname "$self")"
236
	export self self_dir
237
	
238
	make --makefile=<((
239
		cat /dev/fd/3
240
		echo -n "
241
.SUFFIXES: # turn off built-in suffix rules
242
.SECONDARY: # don't automatically delete intermediate files
243
.DELETE_ON_ERROR: # delete target if recipe fails
244
"
245
	)|echo_stdin) "$@"
246
}
247

    
248
#### compression
249

    
250
### zip
251

    
252
zip ()
253
{
254
	stdout2stderr=1 try self "$@"
255
	ignore 12 # "zip has nothing to do" (`man zip`)
256
	end_try
257
}
258

    
259
unzip () { stdout2stderr=1 self "$@"; }
260

    
261
set_inv force
262
alias zip_newer='zip ${no_force:+-u }'
263
alias unzip_newer='unzip ${no_force:+-u }-o'
264
	# -o is safe because -u only extracts newer files
265

    
266
#### URLs
267

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

    
270
#### databases
271

    
272
# using prefixed connection vars
273
alias use_local='declare prefix=local_; import_vars'
274
alias use_remote='declare prefix=remote_; import_vars'
275
alias use_local_remote='use_local; use_remote'
276

    
277
quote='"'
278

    
279
esc_name () { echo "$quote${1//$quote/$quote$quote}$quote"; }
280

    
281
mk_esc_name () { set_var "$1"_esc "$(esc_name "${!1}")"; }
282

    
283
alias mk_schema_esc='declare schema_esc; mk_esc_name schema'
284
alias mk_table_esc='declare table_esc; mk_esc_name table'
285

    
286
fi # load new aliases
287
if self_being_included; then
288

    
289
log_sql () { test "$verbosity" -ge 2; }
290

    
291
### MySQL
292

    
293
# auto-adds connection/login opts when specified
294
mysql_cmd () # usage: mysql* () { ...; mysql_cmd "$@"; }
295
{
296
	echo_func
297
	local ssh_server="$(localize_url "$ssh_server")"
298
	local server="$(localize_url "$server")"
299
	if test -n "$ssh_server"; then
300
		local ssh_dest="${ssh_dest-${ssh_user:+$ssh_user@}$ssh_server}"
301
	fi
302
	if test -n "$schema"; then local database="${database-$schema}"; fi
303
	
304
	local var=ssh_dest; local_inv
305
	extern ${ssh_dest:+ssh "$ssh_dest" }"${FUNCNAME[1]}" \
306
${server:+ --host="$server" }${user:+--user="$user" } --password\
307
${password+="$password"} ${database:+--databases "$database" --tables } "$@"
308
}
309

    
310
mysql () { echo_func; mysql_cmd --verbose "$@"; }
311

    
312
mysql_ANSI ()
313
{
314
	echo_func
315
	(echo "SET sql_mode = 'ANSI';"; cat)|mysql "$@"
316
}
317

    
318
mysqldump () # usage: [schema=1 | data=1] mysqldump db [table...]
319
{
320
	echo_func
321
	mysql_cmd --quick --lock-tables=false --set-charset \
322
${postgres_compat:+--compatible=postgresql --add-locks=false }\
323
${schema:+--no-data }${data:+--no-create-info }"$@"
324
}
325

    
326
mysqldump_diffable ()
327
{
328
	echo_func
329
	mysqldump "$@"|sed 's/^(-- Dump completed).*$/\1/'
330
}
331

    
332
### PostgreSQL
333

    
334
pg_copy_to ()
335
{
336
	echo_func
337
	if test -z "$source"; then
338
		: "${table:?}"; mk_table_esc
339
		if test -z "$limit"; then local source="$table_esc"
340
		else local source="(SELECT * FROM $table_esc LIMIT $limit)"
341
		fi
342
	fi
343
	local pg_copy_format="${pg_copy_format-CSV HEADER}"
344
	
345
	psql "$@" <<<"COPY $source TO STDOUT $pg_copy_format;"
346
}
347

    
348
pg_header ()
349
{
350
	echo_func
351
	local pg_copy_format="CSV HEADER" limit=0
352
	pg_copy_to "$@"|echo_stdin
353
}
354

    
355
pg_export_table_no_header ()
356
{
357
	echo_func
358
	local pg_copy_format="CSV"
359
	pg_copy_to "$@"
360
}
361

    
362
pg_export_table_to_dir_no_header ()
363
{
364
	echo_func
365
	local table="$1"; shift; mk_table_esc
366
	local cols="$(pg_header)"
367
	pg_export_table_no_header "$@" >"$exports_dir/$table.no_header.cols=$cols.csv"
368
}
369

    
370
fi
(46-46/51)