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

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

  ViewVC Help
Powered by ViewVC 1.1.20