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

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

  ViewVC Help
Powered by ViewVC 1.1.20