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
log_stderr_cmd () { (log_stderr; "$@") || exit; } # usage: log_stderr_cmd cmd...
74

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

    
77
echo_run () { echo_cmd "$@"; "$@"; }
78

    
79
echo_run_extern () { (log_stderr; echo_run extern "$@") || exit; }
80

    
81
alias extern="echo_run_extern" # automatically echo external commands
82

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

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

    
94
fi # load new aliases
95
if self_being_included; then
96

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

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

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

    
121
echo_export ()
122
{
123
	builtin export "$@"
124
	echo_vars "$@"
125
}
126

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

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

    
133
fi # load new aliases
134
if self_being_included; then
135

    
136
#### strings
137

    
138
sed_ere_flag="$(test "$(uname)" = Darwin && echo E || echo r)"
139

    
140
sed () { extern sed -"$sed_ere_flag" "$@";}
141

    
142
#### vars
143

    
144
set_var () { eval "$1"'="$2"'; }
145

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

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

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

    
162
#### commands
163

    
164
top_dir="$(dirname "$0")" # outermost script
165

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

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

    
184
#### make
185

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

    
194
make ()
195
{
196
	echo_func
197
	extern make --directory="$top_dir" "$@"
198
}
199

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

    
224
#### compression
225

    
226
### zip
227

    
228
zip ()
229
{
230
	try extern zip "$@" >&2
231
	ignore 12 # "zip has nothing to do" (`man zip`)
232
	end_try
233
}
234

    
235
unzip () { extern unzip "$@" >&2; }
236

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

    
242
#### databases
243

    
244
# using prefixed connection vars
245
alias use_local="declare prefix=local_; import_vars"
246
alias use_remote="declare prefix=remote_; import_vars"
247
alias use_local_remote="use_local; use_remote"
248

    
249
quote='"'
250

    
251
esc_name () { echo "$quote${1//$quote/$quote$quote}$quote"; }
252

    
253
mk_esc_name () { set_var "$1"_esc "$(esc_name "${!1}")"; }
254

    
255
alias mk_schema_esc="declare schema_esc; mk_esc_name schema"
256
alias mk_table_esc="declare table_esc; mk_esc_name table"
257

    
258
fi # load new aliases
259
if self_being_included; then
260

    
261
log_sql () { test "$verbosity" -ge 2; }
262

    
263
### MySQL
264

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

    
281
mysql ()
282
{
283
	echo_func
284
	mysql_cmd --verbose "$@"
285
}
286

    
287
mysql_ANSI ()
288
{
289
	echo_func
290
	(echo "SET sql_mode = 'ANSI';"; cat)|mysql "$@"
291
}
292

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

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

    
307
### PostgreSQL
308

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

    
323
pg_header ()
324
{
325
	echo_func
326
	local pg_copy_format="CSV HEADER" limit=0
327
	pg_copy_to "$@"|echo_stdin
328
}
329

    
330
pg_export_table_no_header ()
331
{
332
	echo_func
333
	local pg_copy_format="CSV"
334
	pg_copy_to "$@"
335
}
336

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

    
345
fi
(46-46/51)