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

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

  ViewVC Help
Powered by ViewVC 1.1.20