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
# 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
# usage: in func:      inc_log_level; ...
69
#        outside func: inc_log_level; ...; dec_log_level
70
alias inc_log_level='declare verbosity="$verbosity"; let verbosity--'
71
alias dec_log_level='declare verbosity="$verbosity"; let verbosity++'
72

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

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

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

    
87
echo_run () { echo_cmd "$@"; "$@"; }
88

    
89
alias echo_run_extern='echo_run log_stderr_cmd "extern"'
90

    
91
alias extern="echo_run_extern" # automatically echo external commands
92

    
93
# commands that are always external
94
for cmd in env; do alias "$cmd=extern $cmd"; done; unset cmd
95

    
96
canon_rel_path ()
97
{
98
	local path="$1"
99
	path="$(realpath "$path")" # canonicalize
100
	path="${path#$(pwd -P)/}" # remove any shared prefix with the current dir
101
	echo "$path"
102
}
103

    
104
fi # load new aliases
105
if self_being_included; then
106

    
107
function echo_func ()
108
{
109
	inc_log_level
110
	local script="$(canon_rel_path "${BASH_SOURCE[1]}")"
111
	echo_cmd "$script:${BASH_LINENO[0]}" "${FUNCNAME[1]}" "$@"
112
}
113

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

    
125
echo_vars () # usage: echo_vars var...
126
{
127
	inc_log_level
128
	if can_log; then { echo -n "$PS4"; declare -p "${@%%=*}";} >&2; fi
129
}
130

    
131
echo_export ()
132
{
133
	builtin export "$@"
134
	echo_vars "$@"
135
}
136

    
137
if test "$verbosity" -ge 2; then
138
	alias export="echo_export" # automatically echo env vars when they are set
139
fi
140

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

    
143
fi # load new aliases
144
if self_being_included; then
145

    
146
#### strings
147

    
148
sed_ere_flag="$(test "$(uname)" = Darwin && echo E || echo r)"
149

    
150
sed () { extern sed -"$sed_ere_flag" "$@";}
151

    
152
#### vars
153

    
154
set_var () { eval "$1"'="$2"'; }
155

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

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

    
161
# usage: local prefix=..._; import_vars
162
alias import_vars="$(cat <<'EOF'
163
: "${prefix:?}"
164
local src_var dest_var
165
for src_var in $(eval echo '${!'$prefix'*}'); do
166
	dest_var="${src_var#$prefix}"
167
	local "$dest_var=${!src_var}"; echo_vars "$dest_var"
168
done
169
EOF
170
)"
171

    
172
#### commands
173

    
174
top_dir="$(dirname "$0")" # outermost script
175

    
176
run_args_cmd () # runs the command line args command
177
{
178
	test "$?" -eq 0 || return
179
	eval set -- "$(reverse "${BASH_ARGV[@]}")"
180
	test "$#" -ge 1 || set -- all
181
	echo_cmd "$(canon_rel_path "$0")" "$@"; "$@"
182
}
183

    
184
fwd () # usage: subdirs=(...); fwd "$FUNCNAME" "$@"
185
{
186
	echo_func
187
	: "${subdirs?}"
188
	
189
	for subdir in "${subdirs[@]}"; do
190
		"$(dirname "${BASH_SOURCE[1]}")"/"$subdir"/run "$@"
191
	done
192
}
193

    
194
#### make
195

    
196
# usage: target_filename/command () { echo_func; set_make_vars; ...; }
197
alias set_make_vars="$(cat <<'EOF'
198
local command="${FUNCNAME##*/}"; echo_vars command
199
local target_filename="${FUNCNAME%/*}"; echo_vars target_filename
200
local target="$top_dir/$target_filename"; echo_vars target
201
EOF
202
)"
203

    
204
make ()
205
{
206
	echo_func
207
	extern make --directory="$top_dir" "$@"
208
}
209

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

    
234
#### compression
235

    
236
### zip
237

    
238
zip ()
239
{
240
	try extern zip "$@" >&2
241
	ignore 12 # "zip has nothing to do" (`man zip`)
242
	end_try
243
}
244

    
245
unzip () { extern unzip "$@" >&2; }
246

    
247
set_inv force
248
alias zip_newer="zip${no_force:+ -u}"
249
alias unzip_newer="unzip${no_force:+ -u} -o"
250
	# -o is safe because -u only extracts newer files
251

    
252
#### databases
253

    
254
# using prefixed connection vars
255
alias use_local="declare prefix=local_; import_vars"
256
alias use_remote="declare prefix=remote_; import_vars"
257
alias use_local_remote="use_local; use_remote"
258

    
259
quote='"'
260

    
261
esc_name () { echo "$quote${1//$quote/$quote$quote}$quote"; }
262

    
263
mk_esc_name () { set_var "$1"_esc "$(esc_name "${!1}")"; }
264

    
265
alias mk_schema_esc="declare schema_esc; mk_esc_name schema"
266
alias mk_table_esc="declare table_esc; mk_esc_name table"
267

    
268
fi # load new aliases
269
if self_being_included; then
270

    
271
log_sql () { test "$verbosity" -ge 2; }
272

    
273
### MySQL
274

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

    
291
mysql ()
292
{
293
	echo_func
294
	mysql_cmd --verbose "$@"
295
}
296

    
297
mysql_ANSI ()
298
{
299
	echo_func
300
	(echo "SET sql_mode = 'ANSI';"; cat)|mysql "$@"
301
}
302

    
303
mysqldump () # usage: [schema=1 | data=1] mysqldump db [table...]
304
{
305
	echo_func
306
	mysql_cmd --quick --lock-tables=false --set-charset \
307
${postgres_compat:+--compatible=postgresql --add-locks=false }\
308
${schema:+--no-data }${data:+--no-create-info }"$@"
309
}
310

    
311
mysqldump_diffable ()
312
{
313
	echo_func
314
	mysqldump "$@"|sed 's/^(-- Dump completed).*$/\1/'
315
}
316

    
317
### PostgreSQL
318

    
319
pg_copy_to ()
320
{
321
	echo_func
322
	if test -z "$source"; then
323
		: "${table:?}"; mk_table_esc
324
		if test -z "$limit"; then local source="$table_esc"
325
		else local source="(SELECT * FROM $table_esc LIMIT $limit)"
326
		fi
327
	fi
328
	local pg_copy_format="${pg_copy_format-CSV HEADER}"
329
	
330
	psql "$@" <<<"COPY $source TO STDOUT $pg_copy_format;"
331
}
332

    
333
pg_header ()
334
{
335
	echo_func
336
	local pg_copy_format="CSV HEADER" limit=0
337
	pg_copy_to "$@"|echo_stdin
338
}
339

    
340
pg_export_table_no_header ()
341
{
342
	echo_func
343
	local pg_copy_format="CSV"
344
	pg_copy_to "$@"
345
}
346

    
347
pg_export_table_to_dir_no_header ()
348
{
349
	echo_func
350
	local table="$1"; shift; mk_table_esc
351
	local cols="$(pg_header)"
352
	pg_export_table_no_header "$@" >"$exports_dir/$table.no_header.cols=$cols.csv"
353
}
354

    
355
fi
(46-46/51)