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

Diff of /eclass/webapp.eclass

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

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

Legend:
Removed from v.1.47  
changed lines
  Added in v.1.51

  ViewVC Help
Powered by ViewVC 1.1.20