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

Diff of /eclass/webapp.eclass

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

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

Legend:
Removed from v.1.41  
changed lines
  Added in v.1.55

  ViewVC Help
Powered by ViewVC 1.1.20