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 # load new aliases
93
if self_being_included; then
94

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

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

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

    
119
echo_export ()
120
{
121
	builtin export "$@"
122
	echo_vars "$@"
123
}
124

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

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

    
131
fi # load new aliases
132
if self_being_included; then
133

    
134
#### strings
135

    
136
sed_ere_flag="$(test "$(uname)" = Darwin && echo E || echo r)"
137

    
138
sed () { extern sed -"$sed_ere_flag" "$@";}
139

    
140
#### vars
141

    
142
set_var () { eval "$1"'="$2"'; }
143

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

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

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

    
160
#### commands
161

    
162
top_dir="$(dirname "$0")" # outermost script
163

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

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

    
182
#### make
183

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

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

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

    
222
#### compression
223

    
224
### zip
225

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

    
233
unzip () { extern unzip "$@" >&2; }
234

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

    
240
#### databases
241

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

    
247
quote='"'
248

    
249
esc_name () { echo "$quote${1//$quote/$quote$quote}$quote"; }
250

    
251
mk_esc_name () { set_var "$1"_esc "$(esc_name "${!1}")"; }
252

    
253
alias mk_schema_esc="declare schema_esc; mk_esc_name schema"
254
alias mk_table_esc="declare table_esc; mk_esc_name table"
255

    
256
fi # load new aliases
257
if self_being_included; then
258

    
259
log_sql () { test "$verbosity" -ge 2; }
260

    
261
### MySQL
262

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

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

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

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

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

    
305
### PostgreSQL
306

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

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

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

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

    
343
fi
(46-46/51)