Project

General

Profile

1
#!/bin/bash -e
2
realpath () { readlink -f -- "$1"; }
3

    
4
include_guard_var () { realpath "$1"|sed 's/[^a-zA-Z0-9_]/_/g'; }
5

    
6
self_not_included () # usage: if self_not_included; then ... fi
7
{
8
	test "$#" -ge 1 || set -- "${BASH_SOURCE[1]}"
9
	local include_guard="$(include_guard_var "$1")"
10
	alias self_being_included=false
11
	test -z "${!include_guard+t}" && \
12
	{ eval "$include_guard"=1; alias self_being_included=true; }
13
}
14

    
15
# to load newly-defined aliases for use in functions in the same file:
16
## fi # load new aliases
17
## if self_being_included; then
18
# this is needed because aliases defined inside an if statement are not
19
# available inside that if statement
20

    
21
if self_not_included "${BASH_SOURCE[0]}"; then
22

    
23
shopt -s expand_aliases
24

    
25
unalias () { builtin unalias "$@" 2>&- || true; } # no error if undefined
26

    
27
function extern () { (unset -f "$1"; "$@") || exit; }
28

    
29
#### exceptions
30

    
31
# usage: try cmd...; ignore status; if catch status; then ...; fi; end_try
32

    
33
try_ () { { "$@"; e="$?";} || true; }
34
alias try='declare e; try_ ' # trailing space alias-expands next word
35

    
36
catch () { test "$e" -eq "$1"; e=0; }
37

    
38
ignore () { catch "$@" || true; }
39

    
40
alias end_try='return "$e"'
41
alias end_try_subshell='exit "$e"'
42

    
43
#### integers
44

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

    
48
#### arrays
49

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

    
52
reverse () # usage: array=($(reverse args...))
53
{
54
	local i
55
	for (( i=$#; i >= 1; i-- )); do printf '%q ' "${!i}"; done
56
}
57

    
58
#### verbose output
59

    
60
: "${verbosity:=$verbose}" "${verbosity:=0}"
61

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

    
64
# usage: in func:      inc_log_level; ...
65
#        outside func: inc_log_level; ...; dec_log_level
66
alias inc_log_level='declare verbosity="$verbosity"; let verbosity--'
67
alias dec_log_level='declare verbosity="$verbosity"; let verbosity++'
68

    
69
# usage: (log_stderr; cmd...) || exit
70
# `|| exit` needed on Mac because of bug where -e doesn't apply to ()
71
log_stderr () { if ! can_log; then exec 2>/dev/null; fi; }
72

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

    
75
echo_run () { echo_cmd "$@"; "$@"; }
76

    
77
echo_run_extern () { (log_stderr; echo_run extern "$@") || exit; }
78

    
79
alias extern="echo_run_extern" # automatically echo external commands
80

    
81
# commands that are always external
82
for cmd in env; do alias "$cmd=extern $cmd"; done; unset cmd
83

    
84
canon_rel_path ()
85
{
86
	local path="$1"
87
	path="$(realpath "$path")" # canonicalize
88
	path="${path#$(pwd -P)/}" # remove any shared prefix with the current dir
89
	echo "$path"
90
}
91

    
92
fi # allow unalias to take effect
93
unalias echo_func
94
if self_being_included; then
95

    
96
echo_func ()
97
{
98
	inc_log_level
99
	local script="$(canon_rel_path "${BASH_SOURCE[1]}")"
100
	echo_cmd "$script:${BASH_LINENO[0]}" "${FUNCNAME[1]}" "$@"
101
}
102

    
103
fi # always restore the alias
104
alias echo_func='"echo_func" "$@"' # usage: func () { echo_func; ...; }
105
if self_being_included; then
106

    
107
echo_stdin () # usage: input|echo_stdin|cmd
108
{
109
	inc_log_level
110
	if can_log; then
111
		echo ----- >&2
112
		tee -a /dev/stderr;
113
		echo ----- >&2
114
	else cat
115
	fi
116
}
117

    
118
echo_vars () # usage: echo_vars var...
119
{
120
	inc_log_level
121
	if can_log; then { echo -n "$PS4"; declare -p "${@%%=*}";} >&2; fi
122
}
123

    
124
echo_export ()
125
{
126
	builtin export "$@"
127
	echo_vars "$@"
128
}
129

    
130
if test "$verbosity" -ge 2; then
131
	alias export="echo_export" # automatically echo env vars when they are set
132
fi
133

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

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

    
139
#### strings
140

    
141
sed_ere_flag="$(test "$(uname)" = Darwin && echo E || echo r)"
142

    
143
sed () { env sed -"$sed_ere_flag" "$@";}
144

    
145
#### vars
146

    
147
set_var () { eval "$1"'="$2"'; }
148

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

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

    
154
# usage: local prefix=..._; import_vars
155
alias import_vars="$(cat <<'EOF'
156
: "${prefix:?}"
157
local src_var dest_var
158
for src_var in $(eval echo '${!'$prefix'*}'); do
159
	dest_var="${src_var#$prefix}"
160
	local "$dest_var=${!src_var}"; echo_vars "$dest_var"
161
done
162
EOF
163
)"
164

    
165
#### commands
166

    
167
top_dir="$(dirname "$0")" # outermost script
168

    
169
run_args_cmd () # runs the command line args command
170
{
171
	test "$?" -eq 0 || return
172
	eval set -- "$(reverse "${BASH_ARGV[@]}")"
173
	test "$#" -ge 1 || set -- all
174
	echo_cmd "$(canon_rel_path "$0")" "$@"; "$@"
175
}
176

    
177
fwd () # usage: subdirs=(...); fwd "$FUNCNAME" "$@"
178
{
179
	echo_func
180
	: "${subdirs?}"
181
	
182
	for subdir in "${subdirs[@]}"; do
183
		"$(dirname "${BASH_SOURCE[1]}")"/"$subdir"/run "$@"
184
	done
185
}
186

    
187
#### make
188

    
189
# usage: target_filename/command () { echo_func; set_make_vars; ...; }
190
alias set_make_vars="$(cat <<'EOF'
191
local command="${FUNCNAME##*/}"; echo_vars command
192
local target_filename="${FUNCNAME%/*}"; echo_vars target_filename
193
local target="$top_dir/$target_filename"; echo_vars target
194
EOF
195
)"
196

    
197
make ()
198
{
199
	echo_func
200
	env make --directory="$top_dir" "$@"
201
}
202

    
203
if false; then ## usage:
204
inline_make 3<<'EOF'
205
target:
206
	$(self_dir)/cmd >$@
207
EOF
208
# target will be run automatically because it's first in the makefile
209
fi ##
210
inline_make ()
211
{
212
	echo_func
213
	local self="$(readlink -f "${BASH_SOURCE[1]}")"
214
	local self_dir="$(dirname "$self")"
215
	export self self_dir
216
	
217
	make --makefile=<((
218
		cat /dev/fd/3
219
		echo -n "
220
.SUFFIXES: # turn off built-in suffix rules
221
.SECONDARY: # don't automatically delete intermediate files
222
.DELETE_ON_ERROR: # delete target if recipe fails
223
"
224
	)|echo_stdin) "$@"
225
}
226

    
227
#### compression
228

    
229
### zip
230

    
231
zip ()
232
{
233
	try env zip "$@" >&2
234
	ignore 12 # "zip has nothing to do" (`man zip`)
235
	end_try
236
}
237

    
238
unzip () { env unzip "$@" >&2; }
239

    
240
set_inv force
241
alias zip_newer="zip${no_force:+ -u}"
242
alias unzip_newer="unzip${no_force:+ -u} -o"
243
	# -o is safe because -u only extracts newer files
244

    
245
#### databases
246

    
247
# using prefixed connection vars
248
alias use_local="declare prefix=local_; import_vars"
249
alias use_remote="declare prefix=remote_; import_vars"
250
alias use_local_remote="use_local; use_remote"
251

    
252
quote='"'
253

    
254
esc_name () { echo "$quote${1//$quote/$quote$quote}$quote"; }
255

    
256
mk_esc_name () { set_var "$1"_esc "$(esc_name "${!1}")"; }
257

    
258
alias mk_schema_esc="declare schema_esc; mk_esc_name schema"
259
alias mk_table_esc="declare table_esc; mk_esc_name table"
260

    
261
fi # load new aliases
262
if self_being_included; then
263

    
264
log_sql () { test "$verbosity" -ge 2; }
265

    
266
### MySQL
267

    
268
# auto-adds connection/login opts when specified
269
mysql_cmd () # usage: mysql* () { ...; mysql_cmd "$@"; }
270
{
271
	echo_func
272
	if test _"$ssh_server" = _"$(hostname -f)"; then local ssh_server=; fi
273
	if test -n "$ssh_server"; then
274
		local ssh_dest="${ssh_dest-${ssh_user:+$ssh_user@}$ssh_server}"
275
	fi
276
	if test -n "$schema"; then local database="${database-$schema}"; fi
277
	
278
	local var=ssh_dest; local_inv
279
	echo_run ${no_ssh_dest:+env }${ssh_dest:+ssh "$ssh_dest" }"${FUNCNAME[1]}" \
280
${server:+ --host="$server" }${user:+--user="$user" } --password\
281
${password+="$password"} ${database:+--databases "$database" --tables } "$@"
282
}
283

    
284
mysql ()
285
{
286
	echo_func
287
	mysql_cmd --verbose "$@"
288
}
289

    
290
mysql_ANSI ()
291
{
292
	echo_func
293
	(echo "SET sql_mode = 'ANSI';"; cat)|mysql "$@"
294
}
295

    
296
mysqldump () # usage: [schema=1 | data=1] mysqldump db [table...]
297
{
298
	echo_func
299
	mysql_cmd --quick --lock-tables=false --set-charset \
300
${postgres_compat:+--compatible=postgresql --add-locks=false }\
301
${schema:+--no-data }${data:+--no-create-info }"$@"
302
}
303

    
304
mysqldump_diffable ()
305
{
306
	echo_func
307
	mysqldump "$@"|sed 's/^(-- Dump completed).*$/\1/'
308
}
309

    
310
### PostgreSQL
311

    
312
pg_copy_to ()
313
{
314
	echo_func
315
	if test -z "$source"; then
316
		: "${table:?}"; mk_table_esc
317
		if test -z "$limit"; then local source="$table_esc"
318
		else local source="(SELECT * FROM $table_esc LIMIT $limit)"
319
		fi
320
	fi
321
	local pg_copy_format="${pg_copy_format-CSV HEADER}"
322
	
323
	psql "$@" <<<"COPY $source TO STDOUT $pg_copy_format;"
324
}
325

    
326
pg_header ()
327
{
328
	echo_func
329
	local pg_copy_format="CSV HEADER" limit=0
330
	pg_copy_to "$@"|echo_stdin
331
}
332

    
333
pg_export_table_no_header ()
334
{
335
	echo_func
336
	local pg_copy_format="CSV"
337
	pg_copy_to "$@"
338
}
339

    
340
pg_export_table_to_dir_no_header ()
341
{
342
	echo_func
343
	local table="$1"; shift; mk_table_esc
344
	local cols="$(pg_header)"
345
	pg_export_table_no_header "$@" >"$exports_dir/$table.no_header.cols=$cols.csv"
346
}
347

    
348
fi
(46-46/51)