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

Diff of /eclass/webapp.eclass

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

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

Legend:
Removed from v.1.13  
changed lines
  Added in v.1.58

  ViewVC Help
Powered by ViewVC 1.1.20