/[gentoo-x86]/eclass/webapp.eclass
Gentoo

Diff of /eclass/webapp.eclass

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

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

Legend:
Removed from v.1.1  
changed lines
  Added in v.1.54

  ViewVC Help
Powered by ViewVC 1.1.20