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

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

  ViewVC Help
Powered by ViewVC 1.1.20