File: dbconfig-generate-include

package info (click to toggle)
dbconfig-common 2.0.19
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 3,180 kB
  • sloc: sh: 1,490; makefile: 51; sql: 40; perl: 12
file content (438 lines) | stat: -rwxr-xr-x 12,656 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
#!/bin/sh

# set some defaults
format="sh"
dbuser_varname="dbuser"
dbpass_varname="dbpass"
dbname_varname="dbname"
dbserver_varname="dbserver"
dbport_varname="dbport"
dbtype_varname="dbtype"
basepath_varname="basepath"

# the version will always be < the package version
VERSION="2.0"

version(){
	prog=$(basename $0)
	cat << EOF

$prog v$VERSION 
copyright (c) 2005 sean finney <seanius@debian.org>

EOF
}

usage(){
	version
	cat << EOF
usage: $prog [-hv] [-f format] [-a] [-d[varname]] [-u[varname]] [-p[varname]] [-s[varname]] [-P[varname]] [-t[varname]] [-C[comment]] [-O owner[:group]] [-m mode] [-U] infile [outfile]

	infile            use the given dbconfig-common config file as input
	outfile           use the given file as input (default: stdout)
	-f|--format       use the given output format (default: sh)
	-o|--options		provide output-format-specific options
	-a|--all          include all information in output (default)
	-b|--basepath     include the basepath in the output
	-d|--dbname       include the dbname in the output
	-p|--dbpass       include the dbpass in the output
	-s|--dbserver     include the dbserver in the output
	-P|--dbport       include the dbport in the output
	-u|--dbuser       include the dbuser in the output
	-t|--dbtype       include the dbtype in the output
	-C|--comment      comment out unset variables
	-O|--owner        set the owner:group of the output file
	-m|--mode         set the permissions on the output file
	-U|--ucf          register the outputfile with ucf
	-h|--help         display this helpful message
	-v|--version      output the version and exit

	format is one of a list of include-file style formats for various
	programming languages.  the current list includes:
		sh - /bin/sh style include file
		perl - perl parseable include file
		php - php parseable include file
		template - perform pattern substitution on a pre-existing template
		cpp - c-style header file, using #define'd constants

EOF
}

check_permissions(){
	local line
	if dpkg-statoverride --list "$outputfile" >/dev/null; then
		line=$(dpkg-statoverride --list "$outputfile")
		owner=$(echo $line | cut -d' ' -f1,2 | tr ' ' ':')
		perms=$(echo $line | cut -d' ' -f3)
	fi
}

# Protect strings for use in the right hand side of a sed "s" command
#
# Without protection, double backslashes are interpreted as one
# protected backslash, therefore "\\" -> "\\\\"
# Without protection, an & "refers to that portion of the pattern
# space which matched", therefore "&" -> "\\&"
# The / is used as the seperator, so it needs escaping too,
# therefore "/" -> "\\/"
sed_rhs_escape(){
    sed -e 's/\\/\\&/g' -e 's/&/\\&/g' -e 's,/,\\&,g' << EOF
$1
EOF
}

# Protect strings for use in shell files where the variable is
# quoted in single quotes
sh_sq_escape(){
	sed -e "s,','\\\\'',g" << EOF
$1
EOF
}

# Protect strings for use in php files where the variable is
# quoted in single quotes
php_sq_escape(){
	sed -e 's/\\/\\&/g' -e "s,',' . \"'\" . ',g" << EOF
$1
EOF
}

# Protect strings for use in perl files where the variable is
# quoted in single quotes
perl_sq_escape(){
	php_sq_escape "$1"
}


TEMP=$(getopt -o af:hb::d::m:o:p::u::s::t::C::O:P::Uv --long help,dbuser::,dbname::,dbpass::,dbport::,dbserver::,dbtype::,basepath::,output:,format:,options:,comment::,owner:,mode:,ucf,version -n $0 -- "$@")

if [ $? != 0 ] ; then usage >&2 ; exit 1 ; fi

eval set -- "$TEMP"

while true; do
	case "$1" in
	-a|--all)
		use_all="yes"
		shift
	;;
	-b|--basepath)
		use_basepath="yes"
		if [ ! -z "$2" ]; then
			basepath_varname="$2"
		fi
		shift 2
	;;
	-d|--dbname)
		use_dbname="yes"
		if [ ! -z "$2" ]; then
			dbname_varname="$2"
		fi
		shift 2
	;;
	-u|--dbuser)
		use_dbuser="yes"
		if [ ! -z "$2" ]; then
			dbuser_varname="$2"
		fi
		shift 2
	;;
	-p|--dbpass)
		use_dbpass="yes"
		if [ ! -z "$2" ]; then
			dbpass_varname="$2"
		fi
		shift 2
	;;
	-s|--dbserver)
		use_dbserver="yes"
		if [ ! -z "$2" ]; then
			dbserver_varname="$2"
		fi
		shift 2
	;;
	-P|--dbport)
		use_dbport="yes"
		if [ ! -z "$2" ]; then
			dbport_varname="$2"
		fi
		shift 2
	;;
	-t|--dbtype)
		use_dbtype="yes"
		if [ ! -z "$2" ]; then
			dbtype_varname="$2"
		fi
		shift 2
	;;
	-f|--format)
		format="$2"
		shift 2
	;;
	-C|--comment)
		use_comment="yes"
		if [ ! -z "$2" ]; then
			comment_string="$2"
		fi
		shift 2
	;;		
	-O|--owner)
		owner="$2"
		shift 2
	;;		
	-m|--mode)
		perms="$2"
		shift 2
	;;	
	-h|--help)
		usage
		exit
	;;
	-v|--version)
		version
		exit
	;;
	-U|--ucf)
		do_ucf=1
		shift
	;;
	-o|--options)
		eval $2
		shift 2
	;;
	--)
		shift
		break
	;;
	*)
		echo "eh? $1" >&2
		exit 1
	;;
	esac
done

# if they asked for all vars, or didn't ask for anything (which defaults to all)
if [ "$use_all" ] || [ ! "${use_dbuser}${use_dbpass}${use_basepath}${use_dbname}${use_dbserver}${use_dbtype}${use_dbport}" ]; then
		use_dbuser="yes"
		use_dbpass="yes"
		use_basepath="yes"
		use_dbname="yes"
		use_dbserver="yes"
		use_dbport="yes"
		use_dbtype="yes"
fi

inputfile=$1
outputfile=$2

if [ ! "$inputfile" ]; then
	echo "you must specify an inputfile" >&2
	usage >&2
	exit 1
fi

if [ "$outputfile" ]; then
	tmpout=$(mktemp -t dbconfig-generate-include.XXXXXX)
	if [ ! -f "$tmpout" ]; then
		echo "unable to create temporary file $tmpout" >&2
		exit 1
	fi
	exec > $tmpout
fi

if [ ! -f "$inputfile" ] || [ ! -r "$inputfile" ]; then
	echo "unable to read input file $inputfile" >&2
	exit 1
fi

if ! . $inputfile ; then
	echo "error processing $inputfile, check file contents" >&2
	exit 1
fi

# if commenting-out is enabled
if [ "$use_comment" ]; then
	# if a comment string was not explicitly specified set a default
	if [ ! "$comment_string" ]; then
		case $format in
		sh|php|perl)
			comment_string="#"
		;;
		cpp)
			comment_string="//"
		;;
		template)
			echo "E: must specify a comment string for 'template' format" >&2
			exit 1
		;;
		esac
	fi
	# now determine which things should be commented out if any
	[ ! "$dbc_dbuser" ] && comment_dbuser="${comment_string}"
	[ ! "$dbc_dbpass" ] && comment_dbpass="${comment_string}"
	[ ! "$dbc_basepath" ] && comment_basepath="${comment_string}"
	[ ! "$dbc_dbname" ] && comment_dbname="${comment_string}"
	[ ! "$dbc_dbserver" ] && comment_dbserver="${comment_string}"
	[ ! "$dbc_dbport" ] && comment_dbport="${comment_string}"
	[ ! "$dbc_dbtype" ] && comment_dbtype="${comment_string}"
fi

case $format in
sh)
	cat << EOF 
##
## database access settings in /bin/sh format
## automatically generated from $inputfile
## by $0
##
## by default this file is managed via ucf, so you shouldn't have to
## worry about manual changes being silently discarded.  *however*,
## you'll probably also want to edit the configuration file mentioned
## above too.
##

EOF
	[ "$use_dbuser" ] && echo "${comment_dbuser}$dbuser_varname='$(sh_sq_escape "$dbc_dbuser")'"
	[ "$use_dbpass" ] && echo "${comment_dbpass}$dbpass_varname='$(sh_sq_escape "$dbc_dbpass")'"
	[ "$use_basepath" ] && echo "${comment_basepath}$basepath_varname='$(sh_sq_escape "$dbc_basepath")'"
	[ "$use_dbname" ] && echo "${comment_dbname}$dbname_varname='$(sh_sq_escape "$dbc_dbname")'"
	[ "$use_dbserver" ] && echo "${comment_dbserver}$dbserver_varname='$(sh_sq_escape "$dbc_dbserver")'"
	[ "$use_dbport" ] && echo "${comment_dbport}$dbport_varname='$(sh_sq_escape "$dbc_dbport")'"
	[ "$use_dbtype" ] && echo "${comment_dbtype}$dbtype_varname='$(sh_sq_escape "$dbc_dbtype")'"
;;

php)
	cat << EOF 
<?php
##
## database access settings in php format
## automatically generated from $inputfile
## by $0
##
## by default this file is managed via ucf, so you shouldn't have to
## worry about manual changes being silently discarded.  *however*,
## you'll probably also want to edit the configuration file mentioned
## above too.
##
EOF
	[ "$use_dbuser" ] && echo "${comment_dbuser}\$$dbuser_varname='$(php_sq_escape "$dbc_dbuser")';"
	[ "$use_dbpass" ] && echo "${comment_dbpass}\$$dbpass_varname='$(php_sq_escape "$dbc_dbpass")';"
	[ "$use_basepath" ] && echo "${comment_basepath}\$$basepath_varname='$(php_sq_escape "$dbc_basepath")';"
	[ "$use_dbname" ] && echo "${comment_dbname}\$$dbname_varname='$(php_sq_escape "$dbc_dbname")';"
	[ "$use_dbserver" ] && echo "${comment_dbserver}\$$dbserver_varname='$(php_sq_escape "$dbc_dbserver")';"
	[ "$use_dbport" ] && echo "${comment_dbport}\$$dbport_varname='$(php_sq_escape "$dbc_dbport")';"
	[ "$use_dbtype" ] && echo "${comment_dbtype}\$$dbtype_varname='$(php_sq_escape "$dbc_dbtype")';"
	cat << EOF 
EOF
;;

perl)
	cat << EOF 
##
## database access settings in perl format
## automatically generated from $inputfile
## by $0
##
## by default this file is managed via ucf, so you shouldn't have to
## worry about manual changes being silently discarded.  *however*,
## you'll probably also want to edit the configuration file mentioned
## above too.
##
EOF
	[ "$use_dbuser" ] && echo "${comment_dbuser}our \$$dbuser_varname='$(perl_sq_escape "$dbc_dbuser")';"
	[ "$use_dbpass" ] && echo "${comment_dbpass}our \$$dbpass_varname='$(perl_sq_escape "$dbc_dbpass")';"
	[ "$use_basepath" ] && echo "${comment_basepath}our \$$basepath_varname='$(perl_sq_escape "$dbc_basepath")';"
	[ "$use_dbname" ] && echo "${comment_dbname}our \$$dbname_varname='$(perl_sq_escape "$dbc_dbname")';"
	[ "$use_dbserver" ] && echo "${comment_dbserver}our \$$dbserver_varname='$(perl_sq_escape "$dbc_dbserver")';"
	[ "$use_dbport" ] && echo "${comment_dbport}our \$$dbport_varname='$(perl_sq_escape "$dbc_dbport")';"
	[ "$use_dbtype" ] && echo "${comment_dbtype}our \$$dbtype_varname='$(perl_sq_escape "$dbc_dbtype")';"
	cat << EOF 
1;
EOF
;;
cpp)
	cat << EOF 
/*
 * database access settings in cpp header format
 * why you would ever need this, who knows? :)
 * automatically generated from $inputfile
 * by $0
 *
 * by default this file is managed via ucf, so you shouldn't have to
 * worry about manual changes being silently discarded.  *however*,
 * you'll probably also want to edit the configuration file mentioned
 * above too.
 *
 */
#ifndef _DBCONFIG_COMMON_CONFIG_
 #define _DBCONFIG_COMMON_CONFIG_
EOF
	[ "$use_dbuser" ] && echo " ${comment_dbuser}#define $dbuser_varname \"$dbc_dbuser\";"
	[ "$use_dbpass" ] && echo " ${comment_dbpass}#define $dbpass_varname \"$dbc_dbpass\";"
	[ "$use_basepath" ] && echo "${comment_basepath}#define $basepath_varname \"$dbc_basepath\";"
	[ "$use_dbname" ] && echo " ${comment_dbname}#define $dbname_varname \"$dbc_dbname\";"
	[ "$use_dbserver" ] && echo " ${comment_dbserver}#define $dbserver_varname \"$dbc_dbserver\";"
	[ "$use_dbport" ] && echo " ${comment_dbport}#define $dbport_varname \"$dbc_dbport\";"
	[ "$use_dbtype" ] && echo " ${comment_dbtype}#define $dbtype_varname \"$dbc_dbtype\";"
	cat << EOF 
#endif /* _DBCONFIG_COMMON_CONFIG_ */
EOF
;;
template)
	if [ ! "$template_infile" ]; then
		cat << EOF >&2
error: you must specify a template file. for example: '-o template_infile=foo'
EOF
		exit 1
	elif [ ! -f "$template_infile" ]; then
		echo "error: template infile $template_infile does not exist" >&2
		exit 1
	fi
	sedtmp=$(mktemp -t dbconfig-generate-include.sed.XXXXXX)
	if [ ! -f "$sedtmp" ]; then
		echo "unable to create temporary file $sedtmp" >&2
		exit 1
	fi
	# we do not want _DBC_DBSERVER_ to be expanded to "" (which means "use
	# the best available method to connect to the local db): expand it to
	# "localhost" if needed
	if [ -z "$dbc_dbserver" ] ; then
		_dbc_dbserver="localhost"
	else
		_dbc_dbserver="$dbc_dbserver"
	fi
	cat << EOF > "$sedtmp"
s/^\(.*\)_DBC_DBUSER_/${comment_dbuser}\1$(sed_rhs_escape "$dbc_dbuser")/g
s/^\(.*\)_DBC_DBPASS_/${comment_dbpass}\1$(sed_rhs_escape "$dbc_dbpass")/g
s/^\(.*\)_DBC_BASEPATH_/${comment_basepath}\1$(sed_rhs_escape "$dbc_basepath")/g
s/^\(.*\)_DBC_DBNAME_/${comment_dbname}\1$(sed_rhs_escape "$dbc_dbname")/g
s/^\(.*\)_DBC_DBSERVER_/${comment_dbserver}\1$(sed_rhs_escape "$_dbc_dbserver")/g
s/^\(.*\)_DBC_DBPORT_/${comment_dbport}\1$(sed_rhs_escape "$dbc_dbport")/g
s/^\(.*\)_DBC_DBTYPE_/${comment_dbtype}\1$(sed_rhs_escape "$dbc_dbtype")/g
EOF
	sed -f "$sedtmp" < "$template_infile" 
	rm -f "$sedtmp"
;;
esac

if [ "$outputfile" ]; then
	if [ -e "$outputfile" ] ; then
		# In order to preserve all local attributes of the
		# original file, copy them to the tmpout file, so that
		# later on they are copied back (by ucf or mv command).
		cp --preserve=all --attributes-only "$outputfile" "$tmpout"
	fi
	if [ "$do_ucf" ]; then
		ucf --debconf-ok "$tmpout" "$outputfile" >&2
		rm -f "$tmpout"
	else
		mv "$tmpout" "$outputfile"
	fi
	check_permissions
	if [ -e "$outputfile" ] ; then
	    [ "$owner" ] && chown $owner $outputfile
	    [ "$perms" ] && chmod $perms $outputfile
	fi
fi

exit 0