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
can_log () { test "$verbosity" -gt 0; } # verbosity=0 turns off all logging
55

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

    
58
echo_run () { echo_cmd "$@"; "$@"; }
59

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

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

    
72
fi # allow unalias to take effect
73
unalias echo_func
74
if self_being_included; then
75

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

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

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

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

    
99
echo_export ()
100
{
101
	builtin export "$@"
102
	echo_vars "$@"
103
}
104

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

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

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

    
114
#### strings
115

    
116
sed_ere_flag="$(test "$(uname)" = Darwin && echo E || echo r)"
117

    
118
sed () { env sed -"$sed_ere_flag" "$@";}
119

    
120
#### vars
121

    
122
set_var () { eval "$1"'="$2"'; }
123

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

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

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

    
140
#### commands
141

    
142
top_dir="$(dirname "$0")" # outermost script
143

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

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

    
162
#### make
163

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

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

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

    
202
#### compression
203

    
204
### zip
205

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

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

    
219
#### databases
220

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

    
226
quote='"'
227

    
228
esc_name () { echo "$quote${1//$quote/$quote$quote}$quote"; }
229

    
230
mk_esc_name () { set_var "$1"_esc "$(esc_name "${!1}")"; }
231

    
232
alias mk_schema_esc="declare schema_esc; mk_esc_name schema"
233
alias mk_table_esc="declare table_esc; mk_esc_name table"
234

    
235
fi # load new aliases
236
if self_being_included; then
237

    
238
log_sql () { test "$verbosity" -ge 2; }
239

    
240
### MySQL
241

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

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

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

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

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

    
284
### PostgreSQL
285

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

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

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

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

    
322
fi
(46-46/51)