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

Diff of /eclass/webapp.eclass

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

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

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

  ViewVC Help
Powered by ViewVC 1.1.20