Project

General

Profile

1
#!/bin/bash -e
2
function extern () { (unset -f "$1"; "$@" || exit) || exit; }
3

    
4
realpath () { readlink -f -- "$1"; }
5

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

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

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

    
23
if self_not_included "${BASH_SOURCE[0]}"; then
24

    
25
shopt -s expand_aliases
26

    
27
unalias () { builtin unalias "$@" 2>&- || true; } # no error if undefined
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
# usage: (stdout2stderr; cmd...) || exit
61
# `|| exit` needed on Mac because of bug where -e doesn't apply to ()
62
stdout2stderr () { exec >&2; }
63

    
64
: "${verbosity:=$verbose}" "${verbosity:=0}"
65

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

    
68
: "${log_indent=  }"
69

    
70
# usage: in func:      inc_log_level; ...
71
#        outside func: inc_log_level; ...; dec_log_level
72
alias inc_log_level='declare verbosity="$verbosity" PS4="$log_indent$PS4"
73
let verbosity--'
74
alias dec_log_level='declare verbosity="$verbosity" PS4="${PS4#$log_indent}"
75
let verbosity++'
76

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

    
81
log_stderr_cmd () # usage: [stdout2stderr=1] log_stderr_cmd cmd...
82
{
83
	(log_stderr
84
		if test -n "$stdout2stderr"; then stdout2stderr; fi
85
		"$@"
86
	) || exit
87
}
88

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

    
91
echo_run () { echo_cmd "$@"; "$@"; }
92

    
93
alias echo_run_extern='echo_run log_stderr_cmd "extern"'
94

    
95
alias extern="echo_run_extern" # automatically echo external commands
96

    
97
# commands that are always external
98
for cmd in env; do alias "$cmd=extern $cmd"; done; unset cmd
99

    
100
canon_rel_path ()
101
{
102
	local path="$1"
103
	path="$(realpath "$path")" # canonicalize
104
	path="${path#$(pwd -P)/}" # remove any shared prefix with the current dir
105
	echo "$path"
106
}
107

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

    
111
function echo_func ()
112
{
113
	inc_log_level
114
	local script="$(canon_rel_path "${BASH_SOURCE[1]}")"
115
	echo_cmd "$script:${BASH_LINENO[0]}" "${FUNCNAME[1]}" "$@"
116
}
117

    
118
echo_stdin () # usage: input|echo_stdin|cmd
119
{
120
	inc_log_level
121
	if can_log; then
122
		echo ----- >&2
123
		tee -a /dev/stderr;
124
		echo ----- >&2
125
	else cat
126
	fi
127
}
128

    
129
echo_vars () # usage: echo_vars var...
130
{
131
	inc_log_level; inc_log_level
132
	if can_log; then
133
		local var
134
		for var in "${@%%=*}"; do { echo -n "$PS4"; declare -p "$var";} >&2;done
135
	fi
136
}
137

    
138
echo_export ()
139
{
140
	builtin export "$@"
141
	echo_vars "$@"
142
}
143

    
144
if test "$verbosity" -ge 2; then
145
	alias export="echo_export" # automatically echo env vars when they are set
146
fi
147

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

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

    
153
#### strings
154

    
155
sed_ere_flag="$(test "$(uname)" = Darwin && echo E || echo r)"
156

    
157
sed () { extern sed -"$sed_ere_flag" "$@";}
158

    
159
#### vars
160

    
161
set_var () { eval "$1"'="$2"'; }
162

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

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

    
168
# usage: local prefix=..._; import_vars
169
alias import_vars="$(cat <<'EOF'
170
: "${prefix:?}"
171
local src_var dest_var
172
for src_var in $(eval echo '${!'$prefix'*}'); do
173
	dest_var="${src_var#$prefix}"
174
	local "$dest_var=${!src_var}"; echo_vars "$dest_var"
175
done
176
EOF
177
)"
178

    
179
#### commands
180

    
181
top_dir="$(dirname "$0")" # outermost script
182

    
183
run_args_cmd () # runs the command line args command
184
{
185
	test "$?" -eq 0 || return
186
	eval set -- "$(reverse "${BASH_ARGV[@]}")"
187
	test "$#" -ge 1 || set -- all
188
	echo_cmd "$(canon_rel_path "$0")" "$@"; "$@"
189
}
190

    
191
fwd () # usage: subdirs=(...); fwd "$FUNCNAME" "$@"
192
{
193
	echo_func
194
	: "${subdirs?}"
195
	
196
	for subdir in "${subdirs[@]}"; do
197
		"$(dirname "${BASH_SOURCE[1]}")"/"$subdir"/run "$@"
198
	done
199
}
200

    
201
#### make
202

    
203
# usage: target_filename/command () { echo_func; set_make_vars; ...; }
204
alias set_make_vars="$(cat <<'EOF'
205
local command="${FUNCNAME##*/}"; echo_vars command
206
local target_filename="${FUNCNAME%/*}"; echo_vars target_filename
207
local target="$top_dir/$target_filename"; echo_vars target
208
EOF
209
)"
210

    
211
make ()
212
{
213
	echo_func
214
	stdout2stderr=1 extern make --directory="$top_dir" "$@"
215
}
216

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

    
241
#### compression
242

    
243
### zip
244

    
245
zip ()
246
{
247
	stdout2stderr=1 try extern zip "$@"
248
	ignore 12 # "zip has nothing to do" (`man zip`)
249
	end_try
250
}
251

    
252
unzip () { stdout2stderr=1 extern unzip "$@"; }
253

    
254
set_inv force
255
alias zip_newer="zip${no_force:+ -u}"
256
alias unzip_newer="unzip${no_force:+ -u} -o"
257
	# -o is safe because -u only extracts newer files
258

    
259
#### databases
260

    
261
# using prefixed connection vars
262
alias use_local="declare prefix=local_; import_vars"
263
alias use_remote="declare prefix=remote_; import_vars"
264
alias use_local_remote="use_local; use_remote"
265

    
266
quote='"'
267

    
268
esc_name () { echo "$quote${1//$quote/$quote$quote}$quote"; }
269

    
270
mk_esc_name () { set_var "$1"_esc "$(esc_name "${!1}")"; }
271

    
272
alias mk_schema_esc="declare schema_esc; mk_esc_name schema"
273
alias mk_table_esc="declare table_esc; mk_esc_name table"
274

    
275
fi # load new aliases
276
if self_being_included; then
277

    
278
log_sql () { test "$verbosity" -ge 2; }
279

    
280
### MySQL
281

    
282
# auto-adds connection/login opts when specified
283
mysql_cmd () # usage: mysql* () { ...; mysql_cmd "$@"; }
284
{
285
	echo_func
286
	if test _"$ssh_server" = _"$(hostname -f)"; then local ssh_server=; fi
287
	if test -n "$ssh_server"; then
288
		local ssh_dest="${ssh_dest-${ssh_user:+$ssh_user@}$ssh_server}"
289
	fi
290
	if test -n "$schema"; then local database="${database-$schema}"; fi
291
	
292
	local var=ssh_dest; local_inv
293
	extern ${ssh_dest:+ssh "$ssh_dest" }"${FUNCNAME[1]}" \
294
${server:+ --host="$server" }${user:+--user="$user" } --password\
295
${password+="$password"} ${database:+--databases "$database" --tables } "$@"
296
}
297

    
298
mysql ()
299
{
300
	echo_func
301
	mysql_cmd --verbose "$@"
302
}
303

    
304
mysql_ANSI ()
305
{
306
	echo_func
307
	(echo "SET sql_mode = 'ANSI';"; cat)|mysql "$@"
308
}
309

    
310
mysqldump () # usage: [schema=1 | data=1] mysqldump db [table...]
311
{
312
	echo_func
313
	mysql_cmd --quick --lock-tables=false --set-charset \
314
${postgres_compat:+--compatible=postgresql --add-locks=false }\
315
${schema:+--no-data }${data:+--no-create-info }"$@"
316
}
317

    
318
mysqldump_diffable ()
319
{
320
	echo_func
321
	mysqldump "$@"|sed 's/^(-- Dump completed).*$/\1/'
322
}
323

    
324
### PostgreSQL
325

    
326
pg_copy_to ()
327
{
328
	echo_func
329
	if test -z "$source"; then
330
		: "${table:?}"; mk_table_esc
331
		if test -z "$limit"; then local source="$table_esc"
332
		else local source="(SELECT * FROM $table_esc LIMIT $limit)"
333
		fi
334
	fi
335
	local pg_copy_format="${pg_copy_format-CSV HEADER}"
336
	
337
	psql "$@" <<<"COPY $source TO STDOUT $pg_copy_format;"
338
}
339

    
340
pg_header ()
341
{
342
	echo_func
343
	local pg_copy_format="CSV HEADER" limit=0
344
	pg_copy_to "$@"|echo_stdin
345
}
346

    
347
pg_export_table_no_header ()
348
{
349
	echo_func
350
	local pg_copy_format="CSV"
351
	pg_copy_to "$@"
352
}
353

    
354
pg_export_table_to_dir_no_header ()
355
{
356
	echo_func
357
	local table="$1"; shift; mk_table_esc
358
	local cols="$(pg_header)"
359
	pg_export_table_no_header "$@" >"$exports_dir/$table.no_header.cols=$cols.csv"
360
}
361

    
362
fi
(46-46/51)