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

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

  ViewVC Help
Powered by ViewVC 1.1.20