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

Diff of /eclass/webapp.eclass

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

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

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

  ViewVC Help
Powered by ViewVC 1.1.20