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

Diff of /eclass/webapp.eclass

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

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

Legend:
Removed from v.1.4  
changed lines
  Added in v.1.66

  ViewVC Help
Powered by ViewVC 1.1.20