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

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

  ViewVC Help
Powered by ViewVC 1.1.20