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
alias self='extern "$FUNCNAME"' # usage: wrapper () { self ...; }
98

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

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

    
110
fi # load new aliases
111
if self_being_included; then
112

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

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

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

    
140
echo_export ()
141
{
142
	builtin export "$@"
143
	echo_vars "$@"
144
}
145

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

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

    
152
fi # load new aliases
153
if self_being_included; then
154

    
155
#### strings
156

    
157
sed_ere_flag="$(test "$(uname)" = Darwin && echo E || echo r)"
158

    
159
sed () { self -"$sed_ere_flag" "$@";}
160

    
161
#### vars
162

    
163
set_var () { eval "$1"'="$2"'; }
164

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

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

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

    
181
#### commands
182

    
183
top_dir="$(dirname "$0")" # outermost script
184

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

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

    
203
#### make
204

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

    
213
make ()
214
{
215
	echo_func
216
	stdout2stderr=1 self --directory="$top_dir" "$@"
217
}
218

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

    
243
#### compression
244

    
245
### zip
246

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

    
254
unzip () { stdout2stderr=1 self "$@"; }
255

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

    
261
#### databases
262

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

    
268
quote='"'
269

    
270
esc_name () { echo "$quote${1//$quote/$quote$quote}$quote"; }
271

    
272
mk_esc_name () { set_var "$1"_esc "$(esc_name "${!1}")"; }
273

    
274
alias mk_schema_esc="declare schema_esc; mk_esc_name schema"
275
alias mk_table_esc="declare table_esc; mk_esc_name table"
276

    
277
fi # load new aliases
278
if self_being_included; then
279

    
280
log_sql () { test "$verbosity" -ge 2; }
281

    
282
### MySQL
283

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

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

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

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

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

    
326
### PostgreSQL
327

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

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

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

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

    
364
fi
(46-46/51)