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
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
if test "$verbosity" -ge 1; then
80
	alias env="echo_run env" # automatically echo commands that use env
81
fi
82

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

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

    
95
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
fi # always restore the alias
103
alias echo_func='"echo_func" "$@"' # usage: func () { echo_func; ...; }
104
if self_being_included; then
105

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

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

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

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

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

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

    
138
#### strings
139

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

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

    
144
#### vars
145

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

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

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

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

    
164
#### commands
165

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

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

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

    
186
#### make
187

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

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

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

    
226
#### compression
227

    
228
### zip
229

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

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

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

    
244
#### databases
245

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

    
251
quote='"'
252

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

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

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

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

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

    
265
### MySQL
266

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

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

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

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

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

    
309
### PostgreSQL
310

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

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

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

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

    
347
fi
(46-46/51)