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

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

  ViewVC Help
Powered by ViewVC 1.1.20