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

Diff of /eclass/webapp.eclass

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

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

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

  ViewVC Help
Powered by ViewVC 1.1.20