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
#### arrays
41

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

    
44
reverse () # usage: array=($(reverse args...))
45
{
46
	local i
47
	for (( i=$#; i >= 1; i-- )); do printf '%q ' "${!i}"; done
48
}
49

    
50
#### verbose output
51

    
52
: "${verbosity:=$verbose}" "${verbosity:=0}"
53

    
54
log_level=1 # must always be > 0 so verbosity=0 turns off all logging
55

    
56
can_log () { test "$log_level" -le "$verbosity"; }
57

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

    
60
echo_run () { echo_cmd "$@"; "$@"; }
61

    
62
if test "$verbosity" -ge 1; then
63
	alias env="echo_run env" # automatically echo commands that use env
64
fi
65

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

    
74
fi # allow unalias to take effect
75
unalias echo_func
76
if self_being_included; then
77

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

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

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

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

    
101
echo_export ()
102
{
103
	builtin export "$@"
104
	echo_vars "$@"
105
}
106

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

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

    
113
fi # load new aliases
114
if self_being_included; then
115

    
116
#### strings
117

    
118
sed_ere_flag="$(test "$(uname)" = Darwin && echo E || echo r)"
119

    
120
sed () { env sed -"$sed_ere_flag" "$@";}
121

    
122
#### vars
123

    
124
set_var () { eval "$1"'="$2"'; }
125

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

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

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

    
142
#### commands
143

    
144
top_dir="$(dirname "$0")" # outermost script
145

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

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

    
164
#### make
165

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

    
174
make ()
175
{
176
	echo_func
177
	env make --directory="$top_dir" "$@"
178
}
179

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

    
204
#### compression
205

    
206
### zip
207

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

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

    
221
#### databases
222

    
223
# using prefixed connection vars
224
alias use_local="declare prefix=local_; import_vars"
225
alias use_remote="declare prefix=remote_; import_vars"
226
alias use_local_remote="use_local; use_remote"
227

    
228
quote='"'
229

    
230
esc_name () { echo "$quote${1//$quote/$quote$quote}$quote"; }
231

    
232
mk_esc_name () { set_var "$1"_esc "$(esc_name "${!1}")"; }
233

    
234
alias mk_schema_esc="declare schema_esc; mk_esc_name schema"
235
alias mk_table_esc="declare table_esc; mk_esc_name table"
236

    
237
fi # load new aliases
238
if self_being_included; then
239

    
240
log_sql () { test "$verbosity" -ge 2; }
241

    
242
### MySQL
243

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

    
260
mysql ()
261
{
262
	echo_func
263
	mysql_cmd --verbose "$@"
264
}
265

    
266
mysql_ANSI ()
267
{
268
	echo_func
269
	(echo "SET sql_mode = 'ANSI';"; cat)|mysql "$@"
270
}
271

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

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

    
286
### PostgreSQL
287

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

    
302
pg_header ()
303
{
304
	echo_func
305
	local pg_copy_format="CSV HEADER" limit=0
306
	pg_copy_to "$@"|echo_stdin
307
}
308

    
309
pg_export_table_no_header ()
310
{
311
	echo_func
312
	local pg_copy_format="CSV"
313
	pg_copy_to "$@"
314
}
315

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

    
324
fi
(46-46/51)