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

Diff of /eclass/webapp.eclass

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

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

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

  ViewVC Help
Powered by ViewVC 1.1.20