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
#### exceptions
28

    
29
# usage: try cmd...; ignore status; if catch status; then ...; fi; end_try
30

    
31
try_ () { { "$@"; e="$?";} || true; }
32
alias try='declare e; try_ ' # trailing space alias-expands next word
33

    
34
catch () { test "$e" -eq "$1"; e=0; }
35

    
36
ignore () { catch "$@" || true; }
37

    
38
alias end_try='return "$e"'
39

    
40
#### integers
41

    
42
let () { builtin let "$@" || true; }
43
	# "If the last ARG evaluates to 0, let returns 1" (`help let`)
44

    
45
#### arrays
46

    
47
join () { local IFS="$delim"; echo "$*"; } # usage: delim=... join elems...
48

    
49
reverse () # usage: array=($(reverse args...))
50
{
51
	local i
52
	for (( i=$#; i >= 1; i-- )); do printf '%q ' "${!i}"; done
53
}
54

    
55
#### verbose output
56

    
57
: "${verbosity:=$verbose}" "${verbosity:=0}"
58

    
59
can_log () { test "$verbosity" -gt 0; } # verbosity=0 turns off all logging
60

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

    
63
echo_run () { echo_cmd "$@"; "$@"; }
64

    
65
if test "$verbosity" -ge 1; then
66
	alias env="echo_run env" # automatically echo commands that use env
67
fi
68

    
69
canon_rel_path ()
70
{
71
	local path="$1"
72
	path="$(realpath "$path")" # canonicalize
73
	path="${path#$(pwd -P)/}" # remove any shared prefix with the current dir
74
	echo "$path"
75
}
76

    
77
fi # allow unalias to take effect
78
unalias echo_func
79
if self_being_included; then
80

    
81
echo_func ()
82
{
83
	local script="$(canon_rel_path "${BASH_SOURCE[1]}")"
84
	echo_cmd "$script:${BASH_LINENO[0]}" "${FUNCNAME[1]}" "$@"
85
}
86

    
87
fi # always restore the alias
88
alias echo_func='"echo_func" "$@"' # usage: func () { echo_func; ...; }
89
if self_being_included; then
90

    
91
echo_stdin () # usage: input|echo_stdin|cmd
92
{
93
	if can_log; then
94
		echo ----- >&2
95
		tee -a /dev/stderr;
96
		echo ----- >&2
97
	else cat
98
	fi
99
}
100

    
101
echo_vars () # usage: echo_vars var...
102
{ if can_log; then { echo -n "$PS4"; declare -p "${@%%=*}";} >&2; fi; }
103

    
104
echo_export ()
105
{
106
	builtin export "$@"
107
	echo_vars "$@"
108
}
109

    
110
if test "$verbosity" -ge 2; then
111
	alias export="echo_export" # automatically echo env vars when they are set
112
fi
113

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

    
116
fi # load new aliases
117
if self_being_included; then
118

    
119
#### strings
120

    
121
sed_ere_flag="$(test "$(uname)" = Darwin && echo E || echo r)"
122

    
123
sed () { env sed -"$sed_ere_flag" "$@";}
124

    
125
#### vars
126

    
127
set_var () { eval "$1"'="$2"'; }
128

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

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

    
134
# usage: local prefix=..._; import_vars
135
alias import_vars="$(cat <<'EOF'
136
: "${prefix:?}"
137
local src_var dest_var
138
for src_var in $(eval echo '${!'$prefix'*}'); do
139
	dest_var="${src_var#$prefix}"
140
	local "$dest_var=${!src_var}"; echo_vars "$dest_var"
141
done
142
EOF
143
)"
144

    
145
#### commands
146

    
147
top_dir="$(dirname "$0")" # outermost script
148

    
149
run_args_cmd () # runs the command line args command
150
{
151
	test "$?" -eq 0 || return
152
	eval set -- "$(reverse "${BASH_ARGV[@]}")"
153
	test "$#" -ge 1 || set -- all
154
	echo_cmd "$(canon_rel_path "$0")" "$@"; "$@"
155
}
156

    
157
fwd () # usage: subdirs=(...); fwd "$FUNCNAME" "$@"
158
{
159
	echo_func
160
	: "${subdirs?}"
161
	
162
	for subdir in "${subdirs[@]}"; do
163
		"$(dirname "${BASH_SOURCE[1]}")"/"$subdir"/run "$@"
164
	done
165
}
166

    
167
#### make
168

    
169
# usage: target_filename/command () { echo_func; set_make_vars; ...; }
170
alias set_make_vars="$(cat <<'EOF'
171
local command="${FUNCNAME##*/}"; echo_vars command
172
local target_filename="${FUNCNAME%/*}"; echo_vars target_filename
173
local target="$top_dir/$target_filename"; echo_vars target
174
EOF
175
)"
176

    
177
make ()
178
{
179
	echo_func
180
	env make --directory="$top_dir" "$@"
181
}
182

    
183
if false; then ## usage:
184
inline_make 3<<'EOF'
185
target:
186
	$(self_dir)/cmd >$@
187
EOF
188
# target will be run automatically because it's first in the makefile
189
fi ##
190
inline_make ()
191
{
192
	echo_func
193
	local self="$(readlink -f "${BASH_SOURCE[1]}")"
194
	local self_dir="$(dirname "$self")"
195
	export self self_dir
196
	
197
	make --makefile=<((
198
		cat /dev/fd/3
199
		echo -n "
200
.SUFFIXES: # turn off built-in suffix rules
201
.SECONDARY: # don't automatically delete intermediate files
202
.DELETE_ON_ERROR: # delete target if recipe fails
203
"
204
	)|echo_stdin) "$@"
205
}
206

    
207
#### compression
208

    
209
### zip
210

    
211
zip ()
212
{
213
	try env zip "$@"
214
	ignore 12 # "zip has nothing to do" (`man zip`)
215
	end_try
216
}
217

    
218
alias unzip="echo_run unzip"
219
set_inv force
220
alias zip_newer="zip${no_force:+ -u}"
221
alias unzip_newer="unzip${no_force:+ -u} -o"
222
	# -o is safe because -u only extracts newer files
223

    
224
#### databases
225

    
226
# using prefixed connection vars
227
alias use_local="declare prefix=local_; import_vars"
228
alias use_remote="declare prefix=remote_; import_vars"
229
alias use_local_remote="use_local; use_remote"
230

    
231
quote='"'
232

    
233
esc_name () { echo "$quote${1//$quote/$quote$quote}$quote"; }
234

    
235
mk_esc_name () { set_var "$1"_esc "$(esc_name "${!1}")"; }
236

    
237
alias mk_schema_esc="declare schema_esc; mk_esc_name schema"
238
alias mk_table_esc="declare table_esc; mk_esc_name table"
239

    
240
fi # load new aliases
241
if self_being_included; then
242

    
243
log_sql () { test "$verbosity" -ge 2; }
244

    
245
### MySQL
246

    
247
# auto-adds connection/login opts when specified
248
mysql_cmd () # usage: mysql* () { ...; mysql_cmd "$@"; }
249
{
250
	echo_func
251
	if test _"$ssh_server" = _"$(hostname -f)"; then local ssh_server=; fi
252
	if test -n "$ssh_server"; then
253
		local ssh_dest="${ssh_dest-${ssh_user:+$ssh_user@}$ssh_server}"
254
	fi
255
	if test -n "$schema"; then local database="${database-$schema}"; fi
256
	
257
	local var=ssh_dest; local_inv
258
	echo_run ${no_ssh_dest:+env }${ssh_dest:+ssh "$ssh_dest" }"${FUNCNAME[1]}" \
259
${server:+ --host="$server" }${user:+--user="$user" } --password\
260
${password+="$password"} ${database:+--databases "$database" --tables } "$@"
261
}
262

    
263
mysql ()
264
{
265
	echo_func
266
	mysql_cmd --verbose "$@"
267
}
268

    
269
mysql_ANSI ()
270
{
271
	echo_func
272
	(echo "SET sql_mode = 'ANSI';"; cat)|mysql "$@"
273
}
274

    
275
mysqldump () # usage: [schema=1 | data=1] mysqldump db [table...]
276
{
277
	echo_func
278
	mysql_cmd --quick --lock-tables=false --set-charset \
279
${postgres_compat:+--compatible=postgresql --add-locks=false }\
280
${schema:+--no-data }${data:+--no-create-info }"$@"
281
}
282

    
283
mysqldump_diffable ()
284
{
285
	echo_func
286
	mysqldump "$@"|sed 's/^(-- Dump completed).*$/\1/'
287
}
288

    
289
### PostgreSQL
290

    
291
pg_copy_to ()
292
{
293
	echo_func
294
	if test -z "$source"; then
295
		: "${table:?}"; mk_table_esc
296
		if test -z "$limit"; then local source="$table_esc"
297
		else local source="(SELECT * FROM $table_esc LIMIT $limit)"
298
		fi
299
	fi
300
	local pg_copy_format="${pg_copy_format-CSV HEADER}"
301
	
302
	psql "$@" <<<"COPY $source TO STDOUT $pg_copy_format;"
303
}
304

    
305
pg_header ()
306
{
307
	echo_func
308
	local pg_copy_format="CSV HEADER" limit=0
309
	pg_copy_to "$@"|echo_stdin
310
}
311

    
312
pg_export_table_no_header ()
313
{
314
	echo_func
315
	local pg_copy_format="CSV"
316
	pg_copy_to "$@"
317
}
318

    
319
pg_export_table_to_dir_no_header ()
320
{
321
	echo_func
322
	local table="$1"; shift; mk_table_esc
323
	local cols="$(pg_header)"
324
	pg_export_table_no_header "$@" >"$exports_dir/$table.no_header.cols=$cols.csv"
325
}
326

    
327
fi
(46-46/51)