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

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

  ViewVC Help
Powered by ViewVC 1.1.20