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

Diff of /eclass/webapp.eclass

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

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

Legend:
Removed from v.1.5  
changed lines
  Added in v.1.72

  ViewVC Help
Powered by ViewVC 1.1.20