###
### common shell include for dbconfig-common aware packages.
###
# usage: /usr/share/dbconfig-common/dpkg/common $package $dpkg_argv
# (where $dpkg_argv is $@ as passed to the maintainer scripts)

#set -x

# get some internal helper functions, like _dbc_sanity_check
. /usr/share/dbconfig-common/internal/common

dbc_config(){
	###
	### some global variables
	###
	dbc_share="/usr/share/dbconfig-common"
	dbc_package="$1"
	dbc_command="$2"
	dbc_oldversion="$3"

	if ! _dbc_sanity_check package command; then
		dbc_install_error "determining package or command";
	fi

	dbc_confdir="/etc/dbconfig-common"
	dbc_globalconfig="$dbc_confdir/config"
	dbc_packageconfig="$dbc_confdir/$dbc_package.conf"

	###
	### some internal variables
	###
	# templates common to all database types
	dbc_standard_templates="database-type dbconfig-install dbconfig-upgrade dbconfig-remove password-confirm app-password-confirm purge upgrade-backup passwords-do-not-match install-error upgrade-error remove-error import-oldsettings performing_upgrade"

	# templates common to mysql database types
	dbc_mysql_templates="mysql/method remote/host remote/newhost mysql/app-pass mysql/admin-user mysql/admin-pass remote/port db/dbname db/app-user"

	# templates common to postgresql database types
	dbc_pgsql_templates="pgsql/method remote/host remote/newhost pgsql/app-pass pgsql/admin-user pgsql/admin-pass remote/port pgsql/authmethod-admin pgsql/authmethod-user pgsql/changeconf pgsql/manualconf db/dbname db/app-user pgsql/no-empty-passwords"

	# all dbtypes supported by dbconfig-common
	dbc_all_supported_dbtypes="mysql pgsql"

	###
	### source the pre-existing config, if it exists
	###
	if [ -f $dbc_globalconfig ]; then
		. $dbc_globalconfig
	fi
	# and the package config
	dbc_read_package_config

	# if dbtype isn't set, but dbc_hardcoded_dbtype is set, set dbtype to that
	if [ "$dbc_hardcoded_dbtype" ]; then
		dbc_dbtype="$dbc_hardcoded_dbtype"
	# likewise for dbc_prompted_dbtype (result from debconf not yet written to disk)
	elif [ "$dbc_prompted_dbtype" ]; then
		dbc_dbtype="$dbc_prompted_dbtype"
	fi

	###
	### dbtype-specific variable section
	###

	# now set some variables based on the dbtype
	case $dbc_dbtype in
	mysql)
		. /usr/share/dbconfig-common/internal/mysql
		dbc_createuser_cmd='dbc_mysql_createuser'
		dbc_checkuser_cmd='dbc_mysql_check_user'
		dbc_createdb_cmd='dbc_mysql_createdb'
		dbc_dropdb_cmd='dbc_mysql_dropdb'
		dbc_dropuser_cmd='dbc_mysql_dropuser'
		dbc_sqlexec_cmd='dbc_mysql_exec_command'
		dbc_sqlfile_cmd='dbc_mysql_exec_file'
		dbc_dump_cmd='dbc_mysql_dump'
		dbc_register_templates="$dbc_standard_templates $dbc_mysql_templates"
		dbc_default_admin="root"
		dbc_default_dbuser=`echo $dbc_package | tr -d +. | cut -c -16`;
		dbc_dbvendor="MySQL"
	;;
	pgsql)
		. /usr/share/dbconfig-common/internal/pgsql
		dbc_createuser_cmd='dbc_pgsql_createuser'
		dbc_checkuser_cmd='dbc_pgsql_check_user'
		dbc_createdb_cmd='dbc_pgsql_createdb'
		dbc_dropdb_cmd='dbc_pgsql_dropdb'
		dbc_dropuser_cmd='dbc_pgsql_dropuser'
		dbc_sqlexec_cmd='dbc_pgsql_exec_command'
		dbc_sqlfile_cmd='dbc_pgsql_exec_file'
		dbc_dump_cmd='dbc_pgsql_dump'
		dbc_register_templates="$dbc_standard_templates $dbc_pgsql_templates"
		dbc_default_admin="postgres"
		dbc_default_dbuser=`echo $dbc_package | tr -d +-.`;
		dbc_use_dbuser="false"
		dbc_dbvendor="PostgreSQL"
	;;
	*)
		dbc_register_templates="$dbc_standard_templates $dbc_mysql_templates $dbc_pgsql_templates"
	;;
	esac
}


###
### functions
###

###
### dump global configuration to a config file
###
dbc_write_global_config(){
	cat << EOF > $dbc_globalconfig
# automatically generated by the maintainer scripts of dbconfig-common
# any changes you make to configuration options in this file will be
# preserved, though your comments will be lost!  

# dbc_remember_admin_pass: should we cache administrative passwords?
#	set to "true" to keep admin passwords cached in debconf
dbc_remember_admin_pass="$dbc_remember_admin_pass"

EOF
}

dbc_read_package_config(){
	_dbc_sanity_check package packageconfig || dbc_install_error
	if [ -f $dbc_packageconfig ]; then
		. $dbc_packageconfig
	fi
}

###
### this function is responsible for setting all debconf values based
### on the contents of on-system config files, so that we can avoid
### the "Debconf is Not a Registry" dilemma.
###
dbc_preseed_package_debconf(){
	_dbc_sanity_check package packageconfig || dbc_install_error

	# if the package configuration does not exist then there is
	# nothing to preseed.
	if [ ! -f "$dbc_packageconfig" ]; then
		return 0
	fi

	# set whether they want our help
	db_set $dbc_package/dbconfig-install "$dbc_install"
	db_set $dbc_package/dbconfig-upgrade "$dbc_upgrade"
	db_set $dbc_package/dbconfig-remove "$dbc_remove"

	# set the dbtype
	db_set $dbc_package/database-type "$dbc_dbtype"

	# set app user
	db_set $dbc_package/db/app-user "$dbc_dbuser"

	# set the app user password
	db_set $dbc_package/$dbc_dbtype/app-pass "$dbc_dbpass"

	# set the remote server/port
	db_set $dbc_package/remote/host "$dbc_dbserver"
	db_set $dbc_package/remote/port "$dbc_dbport"

	# set the name of the database to be created
	db_set $dbc_package/db/dbname "$dbc_dbname"

	# set the database administrator name
	db_set $dbc_package/$dbc_dbtype/admin-user "$dbc_dbadmin"

	# a few db-specific things
	case $dbc_dbtype in
	"pgsql")
		# get the psql authentication method
		db_set $dbc_package/pgsql/authmethod-admin "$dbc_authmethod_admin"
		db_set $dbc_package/pgsql/authmethod-user "$dbc_authmethod_user"

		# ident based auth doesn't need a password
		if [ "$dbc_authmethod_admin" != "ident" ]; then
			# set the database administrator pass
			db_set $dbc_package/pgsql/admin-pass "$dbc_dbadmpass"
		fi
		if [ "$dbc_authmethod_user" != "ident" ]; then
			# set the database user pass
			db_set $dbc_package/pgsql/app-pass "$dbc_dbpass"
		fi

		# set whether or not they want to force SSL
		if [ "$dbc_ssl" = "true" ]; then
			db_set $dbc_package/pgsql/method "tcp/ip + ssl"
		fi
	;;
	esac
}


###
### this function is responsible for reading in everything 
### with respect to the package's configuration and dbconfig-common.  
###
dbc_read_package_debconf(){
	_dbc_sanity_check package || dbc_install_error

	# gracefully fetch this to support multi-dbtype packages
	db_get $dbc_package/database-type && dbc_prompted_dbtype="$RET"
	# dbconfig needs to be reloaded at this point for multi-dbtype apps
	dbc_config $@

	# just to make sure...
	_dbc_sanity_check dbtype || dbc_install_error

	# get whether they want our help with various stuff
	db_get $dbc_package/dbconfig-install && dbc_install="$RET"
	db_get $dbc_package/dbconfig-upgrade && dbc_upgrade="$RET"
	db_get $dbc_package/dbconfig-remove && dbc_remove="$RET"

	# get app user
	db_get $dbc_package/db/app-user && dbc_dbuser="$RET"

	# get the app user password
	db_get $dbc_package/$dbc_dbtype/app-pass && dbc_dbpass="$RET"

	# get the db server/port
	db_get $dbc_package/remote/host && dbc_dbserver="$RET"
	db_get $dbc_package/remote/port && dbc_dbport="$RET"

	# get the name of the database to be created
	db_get $dbc_package/db/dbname && dbc_dbname="$RET"

	# get the database administrator name
	db_get $dbc_package/$dbc_dbtype/admin-user && dbc_dbadmin="$RET"

	# get the database administrator pass
	db_get $dbc_package/$dbc_dbtype/admin-pass && dbc_dbadmpass="$RET"

	# a few db-specific things
	case $dbc_dbtype in
	"pgsql")
		# get the psql authentication method
		db_get $dbc_package/pgsql/authmethod-admin && dbc_authmethod_admin="$RET"
		db_get $dbc_package/pgsql/authmethod-user && dbc_authmethod_user="$RET"

		# get whether or not they want to force SSL
		db_get $dbc_package/pgsql/method && dbc_method="$RET"
		if [ "$dbc_method" = "tcp/ip + ssl" ]; then
			dbc_ssl="true"
		fi
	;;
	esac
}

###
### dump package configuration to a config file
###
dbc_write_package_config(){
	local iformat ofile warn tfile
	_dbc_sanity_check packageconfig || dbc_install_error
	echo "dbconfig-common: writing config to $dbc_packageconfig" >&2

	tfile=`mktemp -t dbconfig-package-config.XXXXXX`

	# a quick check if this is a multi-dbtype app
	if [ "$dbc_prompted_dbtype" ]; then
		dbc_chosen_dbtype=$dbc_prompted_dbtype; 
	elif [ "$dbc_hardcoded_dbtype" ]; then
		dbc_chosen_dbtype="$dbc_hardcoded_dbtype"
		warn="yes"
	fi
	# yes, the single quotes here are intentional
	if [ "$dbc_chosen_dbtype" = '${database_type}' ]; then
		dbc_chosen_dbtype=""
	fi
	# and a check for ssl
	if [ "$dbc_method" = "tcp/ip + ssl" ]; then
		dbc_ssl="true"
	fi

	cat << EOF > $tfile
# automatically generated by the maintainer scripts of $dbc_package
# any changes you make will be preserved, though your comments
# will be lost!  to change your settings you should edit this
# file and then run "dpkg-reconfigure $dbc_package"

# dbc_install: configure database with dbconfig-common?
#              set to anything but "true" to opt out of assistance
dbc_install="$dbc_install"

# dbc_upgrade: upgrade database with dbconfig-common?
#              set to anything but "true" to opt out of assistance
dbc_upgrade="$dbc_upgrade"

# dbc_remove: deconfigure database with dbconfig-common?
#             set to anything but "true" to opt out of assistance
dbc_remove="$dbc_remove"

# dbc_dbtype: type of underlying database to use
#	this exists primarily to let dbconfig-common know what database
#	type to use when a package supports multiple database types.  
#	don't change this value unless you know for certain that this
#	package supports multiple database types
dbc_dbtype="$dbc_chosen_dbtype"

# dbc_dbuser: database user
#	the name of the user who we will use to connect to the database.
dbc_dbuser="$dbc_dbuser"

# dbc_dbpass: database user password
#	the password to use with the above username when connecting
#	to a database, if one is required
dbc_dbpass="$dbc_dbpass"

# dbc_dbserver: database host.  
#	leave unset to use localhost (or a more efficient local method
#	if it exists).
dbc_dbserver="$dbc_dbserver"

# dbc_dbport: remote database port
#	leave unset to use the default.  only applicable if you are
#	using a remote database.
dbc_dbport="$dbc_dbport"

# dbc_dbname: name of database
#	this is the name of your application's database.
dbc_dbname="$dbc_dbname"

# dbc_dbadmin: name of the administrative user
#	this is the administrative user that is used to create all of the above
dbc_dbadmin="$dbc_dbadmin"

##
## postgresql specific settings.  if you don't use postgresql,
## you can safely ignore all of these
##

# dbc_ssl: should we require ssl?
#	set to "true" to require that connections use ssl
dbc_ssl="$dbc_ssl"

# dbc_authmethod_admin: authentication method for admin
# dbc_authmethod_user: authentication method for dbuser
#	see the section titled "AUTHENTICATION METHODS" in
#	/usr/share/doc/dbconfig-common/README.pgsql for more info
dbc_authmethod_admin="$dbc_authmethod_admin"
dbc_authmethod_user="$dbc_authmethod_user"

##
## end postgresql specific settings
##

EOF
	ucf "$tfile" "$dbc_packageconfig"
	rm -f "$tfile"
	if [ "$dbc_generate_include" ]; then
		if [ "$dbc_generate_include_owner" ]; then
			dbc_generate_include_args="$dbc_generate_include_args -O $dbc_generate_include_owner"
		fi
		if [ "$dbc_generate_include_perms" ]; then
			dbc_generate_include_args="$dbc_generate_include_args -m $dbc_generate_include_perms"
		fi

		if echo $dbc_generate_include | grep -q -E "^[^:]*:"; then
			iformat=`echo $dbc_generate_include | cut -d: -f1`
			ofile=`echo $dbc_generate_include | cut -d: -f2`
			dbconfig-generate-include -a -f "$iformat" $dbc_generate_include_args -U "$dbc_packageconfig" "$ofile"
		else
			dbc_error="maintainer did not properly set dbc_generate_include"
			dbc_install_error "writing package config"
		fi
	fi
}

##
## what to do when something goes wrong during install
##
dbc_install_error(){
	echo "error encountered $1:" >&2
	echo $dbc_error >&2
	if [ "$_dbc_no_act" ]; then
		return 0;
	fi
	db_fset $dbc_package/install-error seen false
	db_subst $dbc_package/install-error error $dbc_error
	db_input critical $dbc_package/install-error || true
	db_go || true
	db_get $dbc_package/install-error
	_dbc_on_error_option="$RET"
	
	if [ "$_dbc_on_error_option" = "abort" ]; then
		# forget that we've seen all the debconf questions
		for f in $dbc_register_templates; do
			db_fset $dbc_package/$f seen false
		done
		
		echo "dbconfig-common: $dbc_package $dbc_command: aborted." >&2
		dbc_postinst_cleanup
		return 1
	fi
	
	if [ "$_dbc_on_error_option" = "retry" ]; then
		# forget that we've seen all the debconf questions
		for f in $dbc_register_templates; do
			db_fset $dbc_package/$f seen false
		done
		
		echo "dbconfig-common: $dbc_package $dbc_command: trying again." >&2
                . /usr/share/dbconfig-common/dpkg/config
                dbc_go $dbc_package configure $dbc_oldversion
                . /usr/share/dbconfig-common/dpkg/postinst
		dbc_go $dbc_package $dbc_command $dbc_oldversion 
		dbc_tried_again="yes"
	fi
	
	if [ "$_dbc_on_error_option" = "retry (skip questions)" ]; then
		echo "dbconfig-common: $dbc_package $dbc_command: trying again (skip questions)." >&2
                . /usr/share/dbconfig-common/dpkg/postinst
		dbc_go $dbc_package $dbc_command $dbc_oldversion 
		dbc_tried_again="yes"
	fi

	if [ "$_dbc_on_error_option" = "ignore" ]; then
		echo "dbconfig-common: $dbc_package $dbc_command: ignoring errors from here forwards" 2>&1
		# XXX this would be better
		_dbc_no_act="true"
		dbc_checkuser_cmd=true
		dbc_createdb_cmd=true
		dbc_createuser_cmd=true
		dbc_dbvendor=true
		dbc_default_admin=true
		dbc_default_dbuser=true
		dbc_dropdb_cmd=true
		dbc_dropuser_cmd=true
		dbc_dump_cmd=true
		dbc_register_templates=true
		dbc_sqlexec_cmd=true
		dbc_sqlfile_cmd=true
		dbc_use_dbuser=true
		return 0
	fi
}

##
## what to do when something goes wrong during upgrade
##
dbc_upgrade_error(){
	echo "error encountered $1:" >&2
	echo $dbc_error >&2
	db_fset $dbc_package/upgrade-error seen false
	db_subst $dbc_package/upgrade-error error $dbc_error
	db_subst $dbc_package/upgrade-error dbfile $dbc_dbfile
	db_input critical $dbc_package/upgrade-error || true
	db_go || true
        db_get $dbc_package/upgrade-error
        _dbc_on_error_option="$RET"

        if [ "$_dbc_on_error_option" = "abort" ]; then
        	# forget that we've seen all the debconf questions
        	for f in $dbc_register_templates; do
               		db_fset $dbc_package/$f seen false
        	done
		echo "dbconfig-common: $dbc_package $dbc_command: aborted." >&2
		dbc_postinst_cleanup
		return 1
        fi

        if [ "$_dbc_on_error_option" = "retry" ]; then
        	# forget that we've seen all the debconf questions
        	for f in $dbc_register_templates; do
               		db_fset $dbc_package/$f seen false
        	done
		echo "dbconfig-common: $dbc_package $dbc_command: retrying." >&2
                . /usr/share/dbconfig-common/dpkg/config
                dbc_go $dbc_package configure $dbc_oldversion
                . /usr/share/dbconfig-common/dpkg/postinst
		dbc_go $dbc_package $dbc_command $dbc_oldversion
		dbc_tried_again="yes"
        fi

	if [ "$_dbc_on_error_option" = "retry (skip questions)" ]; then
		echo "dbconfig-common: $dbc_package $dbc_command: trying again." >&2
                . /usr/share/dbconfig-common/dpkg/postinst
		dbc_go $dbc_package $dbc_command $dbc_oldversion 
		dbc_tried_again="yes"
	fi
}

##
## what to do when something goes wrong during remove
##
dbc_remove_error(){
	echo "error encountered $1:" >&2
	echo $dbc_error >&2
	db_fset $dbc_package/remove-error seen false
	db_subst $dbc_package/remove-error error $dbc_error
	db_input critical $dbc_package/remove-error || true
	db_go || true

        db_get $dbc_package/remove-error
        _dbc_on_error_option="$RET"

	if [ "$_dbc_on_error_option" = "abort" ]; then
        	# forget that we've seen all the debconf questions
        	for f in $dbc_register_templates; do
               		db_fset $dbc_package/$f seen false
        	done
		echo "dbconfig-common: $dbc_package $dbc_command: aborted." >&2
		dbc_postinst_cleanup
		return 1
        fi

        if [ "$_dbc_on_error_option" = "retry" ]; then
        	# forget that we've seen all the debconf questions
        	for f in $dbc_register_templates; do
               		db_fset $dbc_package/$f seen false
        	done
		echo "dbconfig-common: $dbc_package $dbc_command: retrying." >&2
		. /usr/share/dbconfig-common/dpkg/config
		dbc_go $dbc_package configure $dbc_oldversion
		. /usr/share/dbconfig-common/dpkg/postinst
		dbc_go $dbc_package $dbc_command $dbc_oldversion
		dbc_tried_again="yes"
        fi
}

##
## exactly what you'd think
##
dbc_forget_dbadmin_password(){
	echo dbconfig-common: flushing administrative password >&2
	db_reset $dbc_package/$dbc_dbtype/admin-pass 
	db_fset $dbc_package/$dbc_dbtype/admin-pass seen false 
	db_reset $dbc_package/password-confirm
	db_fset $dbc_package/password-confirm seen false 
}

##
## exactly what you'd think
##
dbc_forget_app_password(){
	db_reset $dbc_package/$dbc_dbtype/app-pass || true
	db_fset $dbc_package/$dbc_dbtype/app-pass seen false || true
	db_reset $dbc_package/app-password-confirm || true
	db_fset $dbc_package/app-password-confirm seen false || true
}

##
## exactly what you'd think
##
##	usage: dbc_get_admin_pass package dbtype
##
dbc_get_admin_pass(){
	local have_admin_pass pass1

	db_fget $dbc_package/$dbc_dbtype/admin-pass seen 
	if [ "$RET" = "true" ]; then
		have_admin_pass="yes"
	fi

	# make sure the passwords are the same, safely
	while [ ! "$have_admin_pass" ]; do
		# get the administrative password
		db_input high $dbc_package/$dbc_dbtype/admin-pass || true
		db_go || true
		db_get $dbc_package/$dbc_dbtype/admin-pass
		pass1="$RET"

		if [ "$dbc_dbtype" = "pgsql" -a ! "$pass1" ]; then
			db_input high $dbc_package/pgsql/no-empty-passwords || true
			db_reset $dbc_package/$dbc_dbtype/admin-pass
			db_fset $dbc_package/$dbc_dbtype/admin-pass seen false
			db_go || true
		else
			have_admin_pass="yes"
		fi
	done

	db_get $dbc_package/$dbc_dbtype/admin-pass
	dbc_dbadmpass="$RET"
}

##
## exactly what you'd think
##
##	usage: dbc_get_app_pass package dbtype
##
dbc_get_app_pass(){
	local have_app_pass pass1 pass2

	db_fget $dbc_package/$dbc_dbtype/app-pass seen 
	if [ "$RET" = "true" ]; then
		have_app_pass="yes"
		db_get $dbc_package/$dbc_dbtype/app-pass
		dbc_dbpass="$RET"
	fi

	# make sure the passwords are the same, safely
	while [ ! "$have_app_pass" ]; do
		# forget the password-confirm question first, as it's shared
		db_reset $dbc_package/app-password-confirm
		db_fset $dbc_package/app-password-confirm seen false

		# get the appistrative password
		db_input high $dbc_package/$dbc_dbtype/app-pass || true
		db_go || true
		db_get $dbc_package/$dbc_dbtype/app-pass
		pass1="$RET"

		# get the password again, if it is not empty
		if [ "$pass1" ]; then
			db_input high $dbc_package/app-password-confirm || true
			db_go || true
			db_get $dbc_package/app-password-confirm
			pass2="$RET"
		fi

		# test to see if the passwords match
		if [ "$pass1" = "$pass2" ]; then
			dbc_dbpass="$pass1"
			have_app_pass="yes"
		else
			# tell them the passwords didn't match, loop again
			db_reset $dbc_package/$dbc_dbtype/app-pass
			db_fset $dbc_package/$dbc_dbtype/app-pass seen false
			db_input high $dbc_package/passwords-do-not-match || true
			db_go || true
		fi
	done

	if [ ! "$dbc_dbpass" ]; then
		dbc_dbpass=`pwgen -cn -N1 -s 12`
		db_set $dbc_package/$dbc_dbtype/app-pass "$dbc_dbpass"
		db_set $dbc_package/app-password-confirm "$dbc_dbpass"
	fi
}

##
## perform any necessary cleanup before exiting the postinst
##
dbc_postinst_cleanup(){
	if [ "$dbc_remember_admin_pass" != "true" ]; then
		dbc_forget_dbadmin_password
	fi
	if [ "$dbc_remember_app_pass" != "true" ]; then
		dbc_forget_app_password
	fi
}

##
## determine whether a db is supported by a package and installed on the system
##
dbc_detect_dbtype(){
	local query_dbtype
	query_dbtype=$1
	dbc_dbtype_supported="no"
	dbc_dbtype_installed="no"
	# see if the package says it's supported
	if echo $dbc_dbconfig_dbtypes | grep -qE "(^|,[[:space:]]*)$query_dbtype(\$|,)"; then
		dbc_dbtype_supported="yes"
	fi

	# see if the dbtype is already installed.  this is not 100% accurate
	if [ "$dbc_dbtype_supported" = "yes" ]; then
		 case $query_dbtype in 
		 "mysql")
		 	if [ -f /usr/bin/mysql ]; then
				dbc_dbtype_installed="yes"
			fi
		 ;;
		 "pgsql")
		 	if [ -f /usr/bin/psql ]; then
				dbc_dbtype_installed="yes"
			fi
		 ;;
		 "")
		 ;;
		 esac
	fi
}

###
### register all the necessary debconf templates
###
dbc_register_debconf(){
	local f
	for f in $dbc_register_templates; do
		# perform some basic customizing substitutions
		db_register dbconfig-common/$f $dbc_package/$f
		db_subst $dbc_package/$f pkg $dbc_package
		if [ "$dbc_dbvendor" ]; then
			db_subst $dbc_package/$f dbvendor $dbc_dbvendor
		fi
	done
}
