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

Diff of /eclass/webapp.eclass

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

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

Legend:
Removed from v.1.21  
changed lines
  Added in v.1.49

  ViewVC Help
Powered by ViewVC 1.1.20