gentoo-x86/eclass/webapp.eclass

# Copyright 1999-2006 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
# $Header: /var/cvsroot/gentoo-x86/eclass/webapp.eclass,v 1.55 2008/02/22 14:33:35 hollow Exp $
#
# @ECLASS: webapp.eclass
# @MAINTAINER:
# web-apps@gentoo.org
# @BLURB: functions for installing applications to run under a web server
# @DESCRIPTION:
# The webapp eclass contains functions to handle web applications with
# webapp-config. Part of the implementation of GLEP #11

SLOT="${PVR}"
IUSE="vhosts"
DEPEND=">=app-admin/webapp-config-1.50.15"
RDEPEND="${DEPEND}"

EXPORT_FUNCTIONS pkg_postinst pkg_setup src_install pkg_prerm

INSTALL_DIR="/${PN}"
IS_UPGRADE=0
IS_REPLACE=0

INSTALL_CHECK_FILE="installed_by_webapp_eclass"

ETC_CONFIG="${ROOT}etc/vhosts/webapp-config"
WEBAPP_CONFIG="${ROOT}usr/sbin/webapp-config"
WEBAPP_CLEANER="${ROOT}usr/sbin/webapp-cleaner"

# ==============================================================================
# INTERNAL FUNCTIONS
# ==============================================================================

# Load the config file /etc/vhosts/webapp-config
# Supports both the old bash version, and the new python version
webapp_read_config() {
        debug-print-function $FUNCNAME $*

        if has_version '>=app-admin/webapp-config-1.50'; then
                ENVVAR=$(${WEBAPP_CONFIG} --query ${PN} ${PVR}) || die "Could not read settings from webapp-config!"
                eval ${ENVVAR}
        else
                . ${ETC_CONFIG} || die "Unable to read ${ETC_CONFIG}"
        fi
}

# Check whether a specified file exists in the given directory (`.' by default)
webapp_checkfileexists() {
        debug-print-function $FUNCNAME $*

        local my_prefix=${2:+${2}/}

        if [[ ! -e "${my_prefix}${1}" ]]; then
                msg="ebuild fault: file '${1}' not found"
                eerror "$msg"
                eerror "Please report this as a bug at http://bugs.gentoo.org/"
                die "$msg"
        fi
}

webapp_check_installedat() {
        debug-print-function $FUNCNAME $*
        ${WEBAPP_CONFIG} --show-installed -h localhost -d "${INSTALL_DIR}" 2> /dev/null
}

webapp_strip_appdir() {
        debug-print-function $FUNCNAME $*
        echo "${1#${MY_APPDIR}/}"
}

webapp_strip_d() {
        debug-print-function $FUNCNAME $*
        echo "${1#${D}}"
}

webapp_strip_cwd() {
        debug-print-function $FUNCNAME $*
        echo "${1/#.\///}"
}

webapp_getinstalltype() {
        debug-print-function $FUNCNAME $*
        use vhosts && return

        local my_output
        my_output="$(webapp_check_installedat)"

        if [[ $? -eq 0 ]]; then
                # something is already installed there
                # make sure it isn't the same version

                local my_pn="$(echo ${my_output} | awk '{ print $1 }')"
                local my_pvr="$(echo ${my_output} | awk '{ print $2 }')"

                REMOVE_PKG="${my_pn}-${my_pvr}"

                if [[ "${my_pn}" == "${PN}" ]]; then
                        if [[ "${my_pvr}" != "${PVR}" ]]; then
                                elog "This is an upgrade"
                                IS_UPGRADE=1
                        else
                                elog "This is a re-installation"
                                IS_REPLACE=1
                        fi
                else
                        elog "${my_output} is installed there"
                fi
        else
                elog "This is an installation"
        fi
}

# ==============================================================================
# PUBLIC FUNCTIONS
# ==============================================================================

# @FUNCTION: webapp_configfile
# @USAGE: <file> [more files ...]
# @DESCRIPTION:
# Mark a file config-protected for a web-based application.
webapp_configfile() {
        debug-print-function $FUNCNAME $*

        local m
        for m in "$@"; do
                webapp_checkfileexists "${m}" "${D}"

                local my_file="$(webapp_strip_appdir "${m}")"
                my_file="$(webapp_strip_cwd "${my_file}")"

                elog "(config) ${my_file}"
                echo "${my_file}" >> ${D}/${WA_CONFIGLIST}
        done
}

# @FUNCTION: webapp_hook_script
# @USAGE: <file>
# @DESCRIPTION:
# Install a script that will run after a virtual copy is created, and
# before a virtual copy has been removed.
webapp_hook_script() {
        debug-print-function $FUNCNAME $*

        webapp_checkfileexists "${1}"

        elog "(hook) ${1}"
        cp "${1}" "${D}/${MY_HOOKSCRIPTSDIR}/$(basename "${1}")" || die "Unable to install ${1} into ${D}/${MY_HOOKSCRIPTSDIR}/"
        chmod 555 "${D}/${MY_HOOKSCRIPTSDIR}/$(basename "${1}")"
}

# @FUNCTION: webapp_postinst_txt
# @USAGE: <lang> <file>
# @DESCRIPTION:
# Install a text file containing post-installation instructions.
webapp_postinst_txt() {
        debug-print-function $FUNCNAME $*

        webapp_checkfileexists "${2}"

        elog "(info) ${2} (lang: ${1})"
        cp "${2}" "${D}/${MY_APPDIR}/postinst-${1}.txt"
}

# @FUNCTION: webapp_postupgrade_txt
# @USAGE: <lang> <file>
# @DESCRIPTION:
# Install a text file containing post-upgrade instructions.
webapp_postupgrade_txt() {
        debug-print-function $FUNCNAME $*

        webapp_checkfileexists "${2}"

        elog "(info) ${2} (lang: ${1})"
        cp "${2}" "${D}/${MY_APPDIR}/postupgrade-${1}.txt"
}

# helper for webapp_serverowned()
_webapp_serverowned() {
        debug-print-function $FUNCNAME $*

        webapp_checkfileexists "${1}" "${D}"
        local my_file="$(webapp_strip_appdir "${1}")"
        my_file="$(webapp_strip_cwd "${my_file}")"

        elog "(server owned) ${my_file}"
        echo "${my_file}" >> "${D}/${WA_SOLIST}"
}

# @FUNCTION: webapp_serverowned
# @USAGE: [-R] <file> [more files ...]
# @DESCRIPTION:
# Identify a file which must be owned by the webserver's user:group settings.
# The ownership of the file is NOT set until the application is installed using
# the webapp-config tool. If -R is given directories are handled recursively.
webapp_serverowned() {
        debug-print-function $FUNCNAME $*

        local a m
        if [[ "${1}" == "-R" ]]; then
                shift
                for m in "$@"; do
                        find "${D}${m}" | while read a; do
                                a=$(webapp_strip_d "${a}")
                                _webapp_serverowned "${a}"
                        done
                done
        else
                for m in "$@"; do
                        _webapp_serverowned "${m}"
                done
        fi
}

# @FUNCTION: webapp_server_configfile
# @USAGE: <server> <file> [new name]
# @DESCRIPTION:
# Install a configuration file for the webserver.  You need to specify a
# webapp-config supported <server>.  if no new name is given `basename $2' is
# used by default. Note: this function will automagically prepend $1 to the
# front of your config file's name.
webapp_server_configfile() {
        debug-print-function $FUNCNAME $*

        webapp_checkfileexists "${2}"

        # WARNING:
        #
        # do NOT change the naming convention used here without changing all
        # the other scripts that also rely upon these names

        local my_file="${1}-${3:-$(basename "${2}")}"

        elog "(${1}) config file '${my_file}'"
        cp "${2}" "${D}/${MY_SERVERCONFIGDIR}/${my_file}"
}

# @FUNCTION: webapp_sqlscript
# @USAGE: <db> <file> [version]
# @DESCRIPTION:
# Install a SQL script that creates/upgrades a database schema for the web
# application. Currently supported database engines are mysql and postgres.
# If a version is given the script should upgrade the database schema from
# the given version to $PVR.
webapp_sqlscript() {
        debug-print-function $FUNCNAME $*

        webapp_checkfileexists "${2}"

        dodir "${MY_SQLSCRIPTSDIR}/${1}"

        # WARNING:
        #
        # do NOT change the naming convention used here without changing all
        # the other scripts that also rely upon these names

        if [[ -n "${3}" ]]; then
                elog "(${1}) upgrade script for ${PN}-${3} to ${PVR}"
                cp "${2}" "${D}${MY_SQLSCRIPTSDIR}/${1}/${3}_to_${PVR}.sql"
                chmod 600 "${D}${MY_SQLSCRIPTSDIR}/${1}/${3}_to_${PVR}.sql"
        else
                elog "(${1}) create script for ${PN}-${PVR}"
                cp "${2}" "${D}/${MY_SQLSCRIPTSDIR}/${1}/${PVR}_create.sql"
                chmod 600 "${D}/${MY_SQLSCRIPTSDIR}/${1}/${PVR}_create.sql"
        fi
}

# @FUNCTION: webapp_src_preinst
# @DESCRIPTION:
# You need to call this function in src_install() BEFORE anything else has run.
# For now we just create required webapp-config directories.
webapp_src_preinst() {
        debug-print-function $FUNCNAME $*

        dodir "${MY_HTDOCSDIR}"
        dodir "${MY_HOSTROOTDIR}"
        dodir "${MY_CGIBINDIR}"
        dodir "${MY_ICONSDIR}"
        dodir "${MY_ERRORSDIR}"
        dodir "${MY_SQLSCRIPTSDIR}"
        dodir "${MY_HOOKSCRIPTSDIR}"
        dodir "${MY_SERVERCONFIGDIR}"
}

# ==============================================================================
# EXPORTED FUNCTIONS
# ==============================================================================

# @FUNCTION: webapp_src_install
# @DESCRIPTION:
# This is the default src_install(). For now, we just make sure that root owns
# everything, and that there are no setuid files.
#
# You need to call this function AFTER everything else has run in your custom
# src_install().
webapp_src_install() {
        debug-print-function $FUNCNAME $*

        chown -R "${VHOST_DEFAULT_UID}:${VHOST_DEFAULT_GID}" "${D}/"
        chmod -R u-s "${D}/"
        chmod -R g-s "${D}/"

        keepdir "${MY_PERSISTDIR}"
        fowners "root:0" "${MY_PERSISTDIR}"
        fperms 755 "${MY_PERSISTDIR}"

        # to test whether or not the ebuild has correctly called this function
        # we add an empty file to the filesystem
        #
        # we used to just set a variable in the shell script, but we can
        # no longer rely on Portage calling both webapp_src_install() and
        # webapp_pkg_postinst() within the same shell process

        touch "${D}/${MY_APPDIR}/${INSTALL_CHECK_FILE}"
}

# @FUNCTION: webapp_pkg_setup
# @DESCRIPTION:
# The default pkg_setup() for this eclass. This will gather required variables
# from webapp-config and check if there is an application installed to
# `${ROOT}/var/www/localhost/htdocs/${PN}/' if USE=vhosts is not set.
#
# You need to call this function BEFORE anything else has run in your custom
# pkg_setup().
webapp_pkg_setup() {
        debug-print-function $FUNCNAME $*

        # special case - some ebuilds *do* need to overwride the SLOT
        if [[ "${SLOT}+" != "${PVR}+" && "${WEBAPP_MANUAL_SLOT}" != "yes" ]]; then
                die "Set WEBAPP_MANUAL_SLOT=\"yes\" if you need to SLOT manually"
        fi

        # pull in the shared configuration file
        G_HOSTNAME="localhost"
        webapp_read_config

        local my_dir="${ROOT}${VHOST_ROOT}/${MY_HTDOCSBASE}/${PN}"

        # if USE=vhosts is enabled OR no application is installed we're done here
        use vhosts || [[ ! -d "${my_dir}" ]] && return

        local my_output
        my_output="$(webapp_check_installedat)"

        if [[ $? -ne 0 ]]; then
                # okay, whatever is there, it isn't webapp-config-compatible
                echo
                ewarn
                ewarn "You already have something installed in ${my_dir}"
                ewarn
                ewarn "Whatever is in ${my_dir}, it's not"
                ewarn "compatible with webapp-config."
                ewarn
                ewarn "This ebuild may be overwriting important files."
                ewarn
                echo
                ebeep 10
        elif [[ "$(echo ${my_output} | awk '{ print $1 }')" != "${PN}" ]]; then
                echo
                eerror "You already have ${my_output} installed in ${my_dir}"
                eerror
                eerror "I cannot upgrade a different application"
                eerror
                echo
                die "Cannot upgrade contents of ${my_dir}"
        fi
}

# @FUNCTION: webapp_pkg_postinst
# @DESCRIPTION:
# The default pkg_postinst() for this eclass. This installs the web application to
# `${ROOT}/var/www/localhost/htdocs/${PN}/' if USE=vhosts is not set. Otherwise
# display a short notice how to install this application with webapp-config.
#
# You need to call this function AFTER everything else has run in your custom
# pkg_postinst().
webapp_pkg_postinst() {
        debug-print-function $FUNCNAME $*

        webapp_read_config

        # sanity checks, to catch bugs in the ebuild
        if [[ ! -f "${ROOT}${MY_APPDIR}/${INSTALL_CHECK_FILE}" ]]; then
                eerror
                eerror "This ebuild did not call webapp_src_install() at the end"
                eerror "of the src_install() function"
                eerror
                eerror "Please log a bug on http://bugs.gentoo.org"
                eerror
                eerror "You should use emerge -C to remove this package, as the"
                eerror "installation is incomplete"
                eerror
                die "Ebuild did not call webapp_src_install() - report to http://bugs.gentoo.org"
        fi

        if ! use vhosts; then
                echo
                elog "vhosts USE flag not set - auto-installing using webapp-config"

                G_HOSTNAME="localhost"
                webapp_read_config

                local my_mode=-I
                webapp_getinstalltype

                if [[ "${IS_REPLACE}" == "1" ]]; then
                        elog "${PN}-${PVR} is already installed - replacing"
                        my_mode=-I
                elif [[ "${IS_UPGRADE}" == "1" ]]; then
                        elog "${REMOVE_PKG} is already installed - upgrading"
                        my_mode=-U
                else
                        elog "${PN}-${PVR} is not installed - using install mode"
                fi

                my_cmd="${WEBAPP_CONFIG} ${my_mode} -h localhost -u root -d ${INSTALL_DIR} ${PN} ${PVR}"
                elog "Running ${my_cmd}"
                ${my_cmd}

                echo
                local cleaner="${WEBAPP_CLEANER} -p -C ${PN}"
                einfo "Running ${cleaner}"
                ${cleaner}
        else
                elog
                elog "The 'vhosts' USE flag is switched ON"
                elog "This means that Portage will not automatically run webapp-config to"
                elog "complete the installation."
                elog
                elog "To install ${PN}-${PVR} into a virtual host, run the following command:"
                elog
                elog "    webapp-config -I -h <host> -d ${PN} ${PN} ${PVR}"
                elog
                elog "For more details, see the webapp-config(8) man page"
        fi
}

# @FUNCTION: webapp_pkg_prerm
# @DESCRIPTION:
# This is the default pkg_prerm() for this eclass. If USE=vhosts is not set
# remove all installed copies of this web application. Otherwise instruct the
# user to manually remove those copies. See bug #136959.
webapp_pkg_prerm() {
        debug-print-function $FUNCNAME $*

        local my_output=
        my_output="$(${WEBAPP_CONFIG} --list-installs ${PN} ${PVR})"
        [[ $? -ne 0 ]] && return

        local x
        if ! use vhosts; then
                echo "${my_output}" | while read x; do
                        if [[ -f "${x}"/.webapp ]]; then
                                . "${x}"/.webapp
                                if [[ -n "${WEB_HOSTNAME}" && -n "${WEB_INSTALLDIR}" ]]; then
                                        ${WEBAPP_CONFIG} -C -h ${WEB_HOSTNAME} -d ${WEB_INSTALLDIR}
                                fi
                        else
                                ewarn "Cannot find file ${x}/.webapp"
                        fi
                done
        elif [[ "${my_output}" != "" ]]; then
                echo
                ewarn
                ewarn "Don't forget to use webapp-config to remove any copies of"
                ewarn "${PN}-${PVR} installed in"
                ewarn

                echo "${my_output}" | while read x; do
                        if [[ -f "${x}"/.webapp ]]; then
                                ewarn "    ${x}"
                        else
                                ewarn "Cannot find file ${x}/.webapp"
                        fi
                done

                ewarn
                echo
        fi
}
1	rl03	1.39	# Copyright 1999-2006 Gentoo Foundation
2	stuart	1.1	# Distributed under the terms of the GNU General Public License v2
3	hollow	1.56	# $Header: /var/cvsroot/gentoo-x86/eclass/webapp.eclass,v 1.55 2008/02/22 14:33:35 hollow Exp $
4	stuart	1.1	#
5	hollow	1.49	# @ECLASS: webapp.eclass
6			# @MAINTAINER:
7			# web-apps@gentoo.org
8			# @BLURB: functions for installing applications to run under a web server
9			# @DESCRIPTION:
10			# The webapp eclass contains functions to handle web applications with
11			# webapp-config. Part of the implementation of GLEP #11
12	stuart	1.1
13			SLOT="${PVR}"
14	swegener	1.36	IUSE="vhosts"
15	rl03	1.47	DEPEND=">=app-admin/webapp-config-1.50.15"
16	stuart	1.37	RDEPEND="${DEPEND}"
17	stuart	1.1
18	stuart	1.18	EXPORT_FUNCTIONS pkg_postinst pkg_setup src_install pkg_prerm
19	stuart	1.1
20	stuart	1.37	INSTALL_DIR="/${PN}"
21	stuart	1.14	IS_UPGRADE=0
22			IS_REPLACE=0
23
24	stuart	1.19	INSTALL_CHECK_FILE="installed_by_webapp_eclass"
25
26	hollow	1.51	ETC_CONFIG="${ROOT}etc/vhosts/webapp-config"
27			WEBAPP_CONFIG="${ROOT}usr/sbin/webapp-config"
28			WEBAPP_CLEANER="${ROOT}usr/sbin/webapp-cleaner"
29	stuart	1.37
30	hollow	1.49	# ==============================================================================
31			# INTERNAL FUNCTIONS
32			# ==============================================================================
33
34	stuart	1.37	# Load the config file /etc/vhosts/webapp-config
35			# Supports both the old bash version, and the new python version
36	hollow	1.49	webapp_read_config() {
37	hollow	1.51	debug-print-function $FUNCNAME $*
38
39	stuart	1.37	if has_version '>=app-admin/webapp-config-1.50'; then
40			ENVVAR=$(${WEBAPP_CONFIG} --query ${PN} ${PVR}) \|\| die "Could not read settings from webapp-config!"
41			eval ${ENVVAR}
42			else
43			. ${ETC_CONFIG} \|\| die "Unable to read ${ETC_CONFIG}"
44			fi
45			}
46	stuart	1.21
47	hollow	1.49	# Check whether a specified file exists in the given directory (`.' by default)
48			webapp_checkfileexists() {
49	hollow	1.51	debug-print-function $FUNCNAME $*
50
51	hollow	1.52	local my_prefix=${2:+${2}/}
52	stuart	1.9
53	hollow	1.53	if [[ ! -e "${my_prefix}${1}" ]]; then
54	stuart	1.37	msg="ebuild fault: file '${1}' not found"
55	stuart	1.1	eerror "$msg"
56			eerror "Please report this as a bug at http://bugs.gentoo.org/"
57			die "$msg"
58			fi
59			}
60
61	hollow	1.49	webapp_check_installedat() {
62	hollow	1.51	debug-print-function $FUNCNAME $*
63	stuart	1.37	${WEBAPP_CONFIG} --show-installed -h localhost -d "${INSTALL_DIR}" 2> /dev/null
64	stuart	1.3	}
65
66	hollow	1.49	webapp_strip_appdir() {
67	hollow	1.51	debug-print-function $FUNCNAME $*
68	hollow	1.52	echo "${1#${MY_APPDIR}/}"
69	stuart	1.3	}
70
71	hollow	1.49	webapp_strip_d() {
72	hollow	1.51	debug-print-function $FUNCNAME $*
73	hollow	1.52	echo "${1#${D}}"
74	stuart	1.3	}
75
76	hollow	1.49	webapp_strip_cwd() {
77	hollow	1.51	debug-print-function $FUNCNAME $*
78	hollow	1.52	echo "${1/#.\///}"
79	stuart	1.1	}
80
81	hollow	1.50	webapp_getinstalltype() {
82	hollow	1.51	debug-print-function $FUNCNAME $*
83	hollow	1.54	use vhosts && return
84	hollow	1.50
85	hollow	1.54	local my_output
86			my_output="$(webapp_check_installedat)"
87
88			if [[ $? -eq 0 ]]; then
89			# something is already installed there
90			# make sure it isn't the same version
91
92			local my_pn="$(echo ${my_output} \| awk '{ print $1 }')"
93			local my_pvr="$(echo ${my_output} \| awk '{ print $2 }')"
94	hollow	1.50
95	hollow	1.54	REMOVE_PKG="${my_pn}-${my_pvr}"
96	hollow	1.50
97	hollow	1.54	if [[ "${my_pn}" == "${PN}" ]]; then
98			if [[ "${my_pvr}" != "${PVR}" ]]; then
99			elog "This is an upgrade"
100			IS_UPGRADE=1
101	hollow	1.50	else
102	hollow	1.54	elog "This is a re-installation"
103			IS_REPLACE=1
104	hollow	1.50	fi
105			else
106	hollow	1.54	elog "${my_output} is installed there"
107	hollow	1.50	fi
108	hollow	1.54	else
109			elog "This is an installation"
110	hollow	1.50	fi
111			}
112
113	hollow	1.49	# ==============================================================================
114			# PUBLIC FUNCTIONS
115			# ==============================================================================
116
117			# @FUNCTION: webapp_configfile
118			# @USAGE: <file> [more files ...]
119			# @DESCRIPTION:
120			# Mark a file config-protected for a web-based application.
121			webapp_configfile() {
122	hollow	1.51	debug-print-function $FUNCNAME $*
123
124	hollow	1.54	local m
125	hollow	1.53	for m in "$@"; do
126	rl03	1.39	webapp_checkfileexists "${m}" "${D}"
127	stuart	1.27
128	hollow	1.54	local my_file="$(webapp_strip_appdir "${m}")"
129			my_file="$(webapp_strip_cwd "${my_file}")"
130	stuart	1.3
131	hollow	1.54	elog "(config) ${my_file}"
132			echo "${my_file}" >> ${D}/${WA_CONFIGLIST}
133	rl03	1.39	done
134	stuart	1.1	}
135
136	hollow	1.49	# @FUNCTION: webapp_hook_script
137			# @USAGE: <file>
138			# @DESCRIPTION:
139	stuart	1.18	# Install a script that will run after a virtual copy is created, and
140	hollow	1.49	# before a virtual copy has been removed.
141			webapp_hook_script() {
142	hollow	1.51	debug-print-function $FUNCNAME $*
143
144	stuart	1.37	webapp_checkfileexists "${1}"
145	stuart	1.18
146	rl03	1.43	elog "(hook) ${1}"
147	wrobel	1.40	cp "${1}" "${D}/${MY_HOOKSCRIPTSDIR}/$(basename "${1}")" \|\| die "Unable to install ${1} into ${D}/${MY_HOOKSCRIPTSDIR}/"
148			chmod 555 "${D}/${MY_HOOKSCRIPTSDIR}/$(basename "${1}")"
149	stuart	1.18	}
150
151	hollow	1.49	# @FUNCTION: webapp_postinst_txt
152			# @USAGE: <lang> <file>
153			# @DESCRIPTION:
154	stuart	1.5	# Install a text file containing post-installation instructions.
155	hollow	1.49	webapp_postinst_txt() {
156	hollow	1.51	debug-print-function $FUNCNAME $*
157
158	stuart	1.37	webapp_checkfileexists "${2}"
159	stuart	1.5
160	rl03	1.43	elog "(info) ${2} (lang: ${1})"
161	stuart	1.37	cp "${2}" "${D}/${MY_APPDIR}/postinst-${1}.txt"
162	stuart	1.5	}
163
164	hollow	1.49	# @FUNCTION: webapp_postupgrade_txt
165			# @USAGE: <lang> <file>
166			# @DESCRIPTION:
167	stuart	1.31	# Install a text file containing post-upgrade instructions.
168	hollow	1.49	webapp_postupgrade_txt() {
169	hollow	1.51	debug-print-function $FUNCNAME $*
170
171	stuart	1.37	webapp_checkfileexists "${2}"
172	stuart	1.31
173	rl03	1.43	elog "(info) ${2} (lang: ${1})"
174	stuart	1.37	cp "${2}" "${D}/${MY_APPDIR}/postupgrade-${1}.txt"
175	stuart	1.3	}
176
177	hollow	1.55	# helper for webapp_serverowned()
178			_webapp_serverowned() {
179			debug-print-function $FUNCNAME $*
180
181			webapp_checkfileexists "${1}" "${D}"
182			local my_file="$(webapp_strip_appdir "${1}")"
183			my_file="$(webapp_strip_cwd "${my_file}")"
184
185			elog "(server owned) ${my_file}"
186			echo "${my_file}" >> "${D}/${WA_SOLIST}"
187			}
188
189	hollow	1.49	# @FUNCTION: webapp_serverowned
190			# @USAGE: [-R] <file> [more files ...]
191			# @DESCRIPTION:
192			# Identify a file which must be owned by the webserver's user:group settings.
193			# The ownership of the file is NOT set until the application is installed using
194			# the webapp-config tool. If -R is given directories are handled recursively.
195			webapp_serverowned() {
196	hollow	1.51	debug-print-function $FUNCNAME $*
197
198	hollow	1.54	local a m
199	hollow	1.53	if [[ "${1}" == "-R" ]]; then
200	rl03	1.39	shift
201	hollow	1.53	for m in "$@"; do
202	hollow	1.55	find "${D}${m}" \| while read a; do
203			a=$(webapp_strip_d "${a}")
204			_webapp_serverowned "${a}"
205	rl03	1.39	done
206			done
207			else
208	hollow	1.53	for m in "$@"; do
209	hollow	1.55	_webapp_serverowned "${m}"
210	rl03	1.39	done
211			fi
212	stuart	1.3	}
213
214	hollow	1.49	# @FUNCTION: webapp_server_configfile
215			# @USAGE: <server> <file> [new name]
216			# @DESCRIPTION:
217			# Install a configuration file for the webserver. You need to specify a
218			# webapp-config supported <server>. if no new name is given `basename $2' is
219			# used by default. Note: this function will automagically prepend $1 to the
220			# front of your config file's name.
221			webapp_server_configfile() {
222	hollow	1.51	debug-print-function $FUNCNAME $*
223
224	stuart	1.37	webapp_checkfileexists "${2}"
225	stuart	1.18
226	hollow	1.51	# WARNING:
227			#
228			# do NOT change the naming convention used here without changing all
229			# the other scripts that also rely upon these names
230	stuart	1.18
231	hollow	1.52	local my_file="${1}-${3:-$(basename "${2}")}"
232	stuart	1.18
233	rl03	1.43	elog "(${1}) config file '${my_file}'"
234	stuart	1.37	cp "${2}" "${D}/${MY_SERVERCONFIGDIR}/${my_file}"
235	stuart	1.18	}
236
237	hollow	1.49	# @FUNCTION: webapp_sqlscript
238			# @USAGE: <db> <file> [version]
239			# @DESCRIPTION:
240			# Install a SQL script that creates/upgrades a database schema for the web
241			# application. Currently supported database engines are mysql and postgres.
242			# If a version is given the script should upgrade the database schema from
243			# the given version to $PVR.
244			webapp_sqlscript() {
245	hollow	1.51	debug-print-function $FUNCNAME $*
246
247	stuart	1.37	webapp_checkfileexists "${2}"
248	stuart	1.3
249	hollow	1.54	dodir "${MY_SQLSCRIPTSDIR}/${1}"
250	stuart	1.3
251	hollow	1.51	# WARNING:
252	stuart	1.3	#
253			# do NOT change the naming convention used here without changing all
254			# the other scripts that also rely upon these names
255	swegener	1.38
256	hollow	1.53	if [[ -n "${3}" ]]; then
257			elog "(${1}) upgrade script for ${PN}-${3} to ${PVR}"
258	stuart	1.37	cp "${2}" "${D}${MY_SQLSCRIPTSDIR}/${1}/${3}_to_${PVR}.sql"
259			chmod 600 "${D}${MY_SQLSCRIPTSDIR}/${1}/${3}_to_${PVR}.sql"
260	stuart	1.3	else
261	rl03	1.43	elog "(${1}) create script for ${PN}-${PVR}"
262	stuart	1.37	cp "${2}" "${D}/${MY_SQLSCRIPTSDIR}/${1}/${PVR}_create.sql"
263			chmod 600 "${D}/${MY_SQLSCRIPTSDIR}/${1}/${PVR}_create.sql"
264	stuart	1.3	fi
265	stuart	1.1	}
266
267	hollow	1.50	# @FUNCTION: webapp_src_preinst
268			# @DESCRIPTION:
269			# You need to call this function in src_install() BEFORE anything else has run.
270			# For now we just create required webapp-config directories.
271			webapp_src_preinst() {
272	hollow	1.51	debug-print-function $FUNCNAME $*
273
274	hollow	1.50	dodir "${MY_HTDOCSDIR}"
275			dodir "${MY_HOSTROOTDIR}"
276			dodir "${MY_CGIBINDIR}"
277			dodir "${MY_ICONSDIR}"
278			dodir "${MY_ERRORSDIR}"
279			dodir "${MY_SQLSCRIPTSDIR}"
280			dodir "${MY_HOOKSCRIPTSDIR}"
281			dodir "${MY_SERVERCONFIGDIR}"
282			}
283
284	hollow	1.49	# ==============================================================================
285			# EXPORTED FUNCTIONS
286			# ==============================================================================
287
288			# @FUNCTION: webapp_src_install
289			# @DESCRIPTION:
290	hollow	1.50	# This is the default src_install(). For now, we just make sure that root owns
291			# everything, and that there are no setuid files.
292			#
293			# You need to call this function AFTER everything else has run in your custom
294			# src_install().
295	hollow	1.49	webapp_src_install() {
296	hollow	1.51	debug-print-function $FUNCNAME $*
297
298	stuart	1.22	chown -R "${VHOST_DEFAULT_UID}:${VHOST_DEFAULT_GID}" "${D}/"
299			chmod -R u-s "${D}/"
300			chmod -R g-s "${D}/"
301
302			keepdir "${MY_PERSISTDIR}"
303	flameeyes	1.41	fowners "root:0" "${MY_PERSISTDIR}"
304	stuart	1.22	fperms 755 "${MY_PERSISTDIR}"
305	stuart	1.15
306	stuart	1.19	# to test whether or not the ebuild has correctly called this function
307			# we add an empty file to the filesystem
308			#
309			# we used to just set a variable in the shell script, but we can
310			# no longer rely on Portage calling both webapp_src_install() and
311			# webapp_pkg_postinst() within the same shell process
312
313	stuart	1.22	touch "${D}/${MY_APPDIR}/${INSTALL_CHECK_FILE}"
314	stuart	1.1	}
315
316	hollow	1.49	# @FUNCTION: webapp_pkg_setup
317			# @DESCRIPTION:
318	hollow	1.50	# The default pkg_setup() for this eclass. This will gather required variables
319			# from webapp-config and check if there is an application installed to
320			# `${ROOT}/var/www/localhost/htdocs/${PN}/' if USE=vhosts is not set.
321			#
322			# You need to call this function BEFORE anything else has run in your custom
323			# pkg_setup().
324	hollow	1.49	webapp_pkg_setup() {
325	hollow	1.51	debug-print-function $FUNCNAME $*
326	stuart	1.15
327	rl03	1.44	# special case - some ebuilds do need to overwride the SLOT
328			if [[ "${SLOT}+" != "${PVR}+" && "${WEBAPP_MANUAL_SLOT}" != "yes" ]]; then
329			die "Set WEBAPP_MANUAL_SLOT=\"yes\" if you need to SLOT manually"
330	stuart	1.15	fi
331
332	stuart	1.8	# pull in the shared configuration file
333	stuart	1.18	G_HOSTNAME="localhost"
334	stuart	1.37	webapp_read_config
335	stuart	1.18
336	hollow	1.54	local my_dir="${ROOT}${VHOST_ROOT}/${MY_HTDOCSBASE}/${PN}"
337
338			# if USE=vhosts is enabled OR no application is installed we're done here
339			use vhosts \|\| [[ ! -d "${my_dir}" ]] && return
340	stuart	1.18
341	hollow	1.54	local my_output
342			my_output="$(webapp_check_installedat)"
343	stuart	1.18
344	hollow	1.54	if [[ $? -ne 0 ]]; then
345			# okay, whatever is there, it isn't webapp-config-compatible
346	hollow	1.55	echo
347			ewarn
348	hollow	1.54	ewarn "You already have something installed in ${my_dir}"
349			ewarn
350			ewarn "Whatever is in ${my_dir}, it's not"
351			ewarn "compatible with webapp-config."
352			ewarn
353			ewarn "This ebuild may be overwriting important files."
354			ewarn
355	hollow	1.55	echo
356			ebeep 10
357	hollow	1.54	elif [[ "$(echo ${my_output} \| awk '{ print $1 }')" != "${PN}" ]]; then
358	hollow	1.55	echo
359			eerror "You already have ${my_output} installed in ${my_dir}"
360			eerror
361			eerror "I cannot upgrade a different application"
362			eerror
363			echo
364	hollow	1.54	die "Cannot upgrade contents of ${my_dir}"
365	stuart	1.18	fi
366	stuart	1.14	}
367	stuart	1.6
368	hollow	1.50	# @FUNCTION: webapp_pkg_postinst
369			# @DESCRIPTION:
370			# The default pkg_postinst() for this eclass. This installs the web application to
371			# `${ROOT}/var/www/localhost/htdocs/${PN}/' if USE=vhosts is not set. Otherwise
372			# display a short notice how to install this application with webapp-config.
373			#
374			# You need to call this function AFTER everything else has run in your custom
375			# pkg_postinst().
376	hollow	1.49	webapp_pkg_postinst() {
377	hollow	1.51	debug-print-function $FUNCNAME $*
378
379	stuart	1.37	webapp_read_config
380	stuart	1.21
381	stuart	1.15	# sanity checks, to catch bugs in the ebuild
382	hollow	1.53	if [[ ! -f "${ROOT}${MY_APPDIR}/${INSTALL_CHECK_FILE}" ]]; then
383	stuart	1.15	eerror
384			eerror "This ebuild did not call webapp_src_install() at the end"
385			eerror "of the src_install() function"
386			eerror
387			eerror "Please log a bug on http://bugs.gentoo.org"
388			eerror
389			eerror "You should use emerge -C to remove this package, as the"
390			eerror "installation is incomplete"
391			eerror
392			die "Ebuild did not call webapp_src_install() - report to http://bugs.gentoo.org"
393			fi
394
395	hollow	1.53	if ! use vhosts; then
396	stuart	1.14	echo
397	rl03	1.43	elog "vhosts USE flag not set - auto-installing using webapp-config"
398	stuart	1.11
399	hollow	1.55	G_HOSTNAME="localhost"
400			webapp_read_config
401	stuart	1.14
402	stuart	1.10	local my_mode=-I
403	hollow	1.55	webapp_getinstalltype
404	stuart	1.10
405	hollow	1.53	if [[ "${IS_REPLACE}" == "1" ]]; then
406	rl03	1.43	elog "${PN}-${PVR} is already installed - replacing"
407	stuart	1.27	my_mode=-I
408	hollow	1.53	elif [[ "${IS_UPGRADE}" == "1" ]]; then
409	rl03	1.43	elog "${REMOVE_PKG} is already installed - upgrading"
410	stuart	1.14	my_mode=-U
411	stuart	1.11	else
412	rl03	1.43	elog "${PN}-${PVR} is not installed - using install mode"
413	stuart	1.10	fi
414	swegener	1.38
415	stuart	1.37	my_cmd="${WEBAPP_CONFIG} ${my_mode} -h localhost -u root -d ${INSTALL_DIR} ${PN} ${PVR}"
416	rl03	1.43	elog "Running ${my_cmd}"
417	stuart	1.37	${my_cmd}
418	stuart	1.14
419	rl03	1.47	echo
420			local cleaner="${WEBAPP_CLEANER} -p -C ${PN}"
421			einfo "Running ${cleaner}"
422			${cleaner}
423	stuart	1.18	else
424	rl03	1.43	elog
425			elog "The 'vhosts' USE flag is switched ON"
426			elog "This means that Portage will not automatically run webapp-config to"
427			elog "complete the installation."
428			elog
429			elog "To install ${PN}-${PVR} into a virtual host, run the following command:"
430			elog
431			elog " webapp-config -I -h <host> -d ${PN} ${PN} ${PVR}"
432			elog
433			elog "For more details, see the webapp-config(8) man page"
434	stuart	1.10	fi
435	stuart	1.2	}
436	stuart	1.18
437	hollow	1.50	# @FUNCTION: webapp_pkg_prerm
438			# @DESCRIPTION:
439			# This is the default pkg_prerm() for this eclass. If USE=vhosts is not set
440			# remove all installed copies of this web application. Otherwise instruct the
441	hollow	1.51	# user to manually remove those copies. See bug #136959.
442	hollow	1.49	webapp_pkg_prerm() {
443	hollow	1.51	debug-print-function $FUNCNAME $*
444	stuart	1.18
445	hollow	1.53	local my_output=
446	stuart	1.37	my_output="$(${WEBAPP_CONFIG} --list-installs ${PN} ${PVR})"
447	hollow	1.53	[[ $? -ne 0 ]] && return
448	stuart	1.18
449	hollow	1.53	local x
450			if ! use vhosts; then
451	hollow	1.56	echo "${my_output}" \| while read x; do
452			if [[ -f "${x}"/.webapp ]]; then
453			. "${x}"/.webapp
454			if [[ -n "${WEB_HOSTNAME}" && -n "${WEB_INSTALLDIR}" ]]; then
455			${WEBAPP_CONFIG} -C -h ${WEB_HOSTNAME} -d ${WEB_INSTALLDIR}
456			fi
457			else
458			ewarn "Cannot find file ${x}/.webapp"
459	rl03	1.48	fi
460			done
461	hollow	1.56	elif [[ "${my_output}" != "" ]]; then
462			echo
463			ewarn
464	rl03	1.48	ewarn "Don't forget to use webapp-config to remove any copies of"
465			ewarn "${PN}-${PVR} installed in"
466			ewarn
467	stuart	1.18
468	hollow	1.56	echo "${my_output}" \| while read x; do
469			if [[ -f "${x}"/.webapp ]]; then
470			ewarn " ${x}"
471			else
472			ewarn "Cannot find file ${x}/.webapp"
473			fi
474	rl03	1.48	done
475	hollow	1.56
476			ewarn
477			echo
478	rl03	1.48	fi
479	stuart	1.18	}