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

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

  ViewVC Help
Powered by ViewVC 1.1.20