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

Diff of /eclass/webapp.eclass

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

Revision 1.4 Revision 1.70
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.4 2004/03/03 18:44:34 stuart Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/webapp.eclass,v 1.70 2011/12/27 17:55:12 fauli 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}"
23G_HASCONFIG=1 34 RDEPEND="${DEPEND}"
24
25if [ -f /etc/conf.d/webapp-config ] ; then
26 . /etc/conf.d/webapp-config
27else
28 G_HASCONFIG=0
29fi 35fi
30 36
31EXPORT_FUNCTIONS pkg_config pkg_setup src_install 37EXPORT_FUNCTIONS pkg_postinst pkg_setup src_install pkg_prerm
32 38
33# ------------------------------------------------------------------------ 39INSTALL_DIR="/${PN}"
34# INTERNAL FUNCTION - USED BY THIS ECLASS ONLY 40IS_UPGRADE=0
35# 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
36# Check whether a specified file exists within the image/ directory 72# Check whether a specified file exists in the given directory (`.' by default)
37# or not.
38#
39# @param $1 - file to look for
40# @param $2 - prefix directory to use
41# @return 0 on success, never returns on an error
42# ------------------------------------------------------------------------
43
44function webapp_checkfileexists () 73webapp_checkfileexists() {
45{ 74 debug-print-function $FUNCNAME $*
46 if [ ! -e $1 ]; then 75
76 local my_prefix=${2:+${2}/}
77
78 if [[ ! -e "${my_prefix}${1}" ]]; then
47 msg="ebuild fault: file $1 not found" 79 msg="ebuild fault: file '${1}' not found"
48 eerror "$msg" 80 eerror "$msg"
49 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/"
50 die "$msg" 82 die "$msg"
51 fi 83 fi
52} 84}
53 85
54# ------------------------------------------------------------------------ 86webapp_check_installedat() {
55# INTERNAL FUNCTION - USED BY THIS ECLASS ONLY 87 debug-print-function $FUNCNAME $*
56# ------------------------------------------------------------------------ 88 ${WEBAPP_CONFIG} --show-installed -h localhost -d "${INSTALL_DIR}" 2> /dev/null
89}
57 90
58function webapp_import_config () 91webapp_strip_appdir() {
59{ 92 debug-print-function $FUNCNAME $*
60 if [ -z "${MY_HTDOCSDIR}" ]; then 93 echo "${1#${MY_APPDIR}/}"
61 . /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"
62 fi 139 fi
63 140 else
64 if [ -z "${MY_HTDOCSDIR}" ]; then 141 # for binpkgs, reset status, var declared in global scope
65 libsh_edie "/etc/conf.d/webapp-config not imported" 142 IS_REPLACE=0
143 IS_UPGRADE=0
144 elog "This is an installation"
66 fi 145 fi
67} 146}
68 147
69# ------------------------------------------------------------------------ 148# ==============================================================================
70# INTERNAL FUNCTION - USED BY THIS ECLASS ONLY 149# PUBLIC FUNCTIONS
71# 150# ==============================================================================
72# ------------------------------------------------------------------------
73 151
74function webapp_strip_appdir () 152# @FUNCTION: need_httpd
75{ 153# @DESCRIPTION:
76 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 )"
77} 159}
78 160
79function webapp_strip_d () 161# @FUNCTION: need_httpd_cgi
80{ 162# @DESCRIPTION:
81 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 )"
82} 168}
83 169
84function webapp_strip_cwd () 170# @FUNCTION: need_httpd_fastcgi
85{ 171# @DESCRIPTION:
86 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"
87} 177}
88 178
89# ------------------------------------------------------------------------ 179# @FUNCTION: webapp_configfile
90# EXPORTED FUNCTION - FOR USE IN EBUILDS 180# @USAGE: <file> [more files ...]
91# 181# @DESCRIPTION:
92# Identify a config file for a web-based application. 182# Mark a file config-protected for a web-based application.
93#
94# @param $1 - config file
95# ------------------------------------------------------------------------
96
97function webapp_configfile () 183webapp_configfile() {
98{ 184 debug-print-function $FUNCNAME $*
185
186 local m
187 for m in "$@"; do
99 webapp_checkfileexists "$1" "$D" 188 webapp_checkfileexists "${m}" "${D}"
100 local MY_FILE="`webapp_strip_appdir $1`"
101 189
102 einfo "(config) $MY_FILE" 190 local my_file="$(webapp_strip_appdir "${m}")"
103 echo "$MY_FILE" >> $WA_CONFIGLIST 191 my_file="$(webapp_strip_cwd "${my_file}")"
104}
105 192
106# ------------------------------------------------------------------------ 193 elog "(config) ${my_file}"
107# EXPORTED FUNCTION - FOR USE IN EBUILDS 194 echo "${my_file}" >> ${D}/${WA_CONFIGLIST}
108# 195 done
109# Identify a script file (usually, but not always PHP or Perl) which is
110#
111# Files in this list may be modified to #! the required CGI engine when
112# installed by webapp-config tool in the future.
113#
114# @param $1 - the cgi engine to use
115# @param $2 - the script file that could run under a cgi-bin
116#
117# ------------------------------------------------------------------------
118
119function webapp_runbycgibin ()
120{
121 webapp_checkfileexists "$2" "$D"
122 local MY_FILE="`webapp_strip_appdir $2`"
123 MY_FILE="`webapp_strip_cwd $MY_FILE`"
124
125 einfo "(cgi-bin) $1 - $MY_FILE"
126 echo "$1 $MY_FILE" >> $WA_RUNBYCGIBINLIST
127} 196}
128 197
129# ------------------------------------------------------------------------ 198# @FUNCTION: webapp_hook_script
130# EXPORTED FUNCTION - FOR USE IN EBUILDS 199# @USAGE: <file>
131# 200# @DESCRIPTION:
132# Identify a file which must be owned by the webserver's user:group 201# Install a script that will run after a virtual copy is created, and
133# settings. 202# before a virtual copy has been removed.
134# 203webapp_hook_script() {
135# The ownership of the file is NOT set until the application is installed 204 debug-print-function $FUNCNAME $*
136# using the webapp-config tool.
137#
138# @param $1 - file to be owned by the webserver user:group combo
139#
140# ------------------------------------------------------------------------
141 205
142function webapp_serverowned ()
143{
144 webapp_checkfileexists "$1" "$D" 206 webapp_checkfileexists "${1}"
145 local MY_FILE="`webapp_strip_appdir $1`"
146
147 einfo "(server owned) $MY_FILE"
148 echo "$MY_FILE" >> $WA_SOLIST
149}
150 207
151# ------------------------------------------------------------------------ 208 elog "(hook) ${1}"
152# EXPORTED FUNCTION - FOR USE IN EBUILDS 209 cp "${1}" "${D}/${MY_HOOKSCRIPTSDIR}/$(basename "${1}")" || die "Unable to install ${1} into ${D}/${MY_HOOKSCRIPTSDIR}/"
153# 210 chmod 555 "${D}/${MY_HOOKSCRIPTSDIR}/$(basename "${1}")"
154# 211}
155# @param $1 - the db engine that the script is for
156# (one of: mysql|postgres)
157# @param $2 - the sql script to be installed
158# @param $3 - the older version of the app that this db script
159# will upgrade from
160# (do not pass this option if your SQL script only creates
161# a new db from scratch)
162# ------------------------------------------------------------------------
163 212
164function webapp_sqlscript () 213# @FUNCTION: webapp_postinst_txt
165{ 214# @USAGE: <lang> <file>
215# @DESCRIPTION:
216# Install a text file containing post-installation instructions.
217webapp_postinst_txt() {
218 debug-print-function $FUNCNAME $*
219
166 webapp_checkfileexists "$2" 220 webapp_checkfileexists "${2}"
167 221
168 # create the directory where this script will go 222 elog "(info) ${2} (lang: ${1})"
169 # 223 cp "${2}" "${D}/${MY_APPDIR}/postinst-${1}.txt"
170 # scripts for specific database engines go into their own subdirectory 224}
171 # just to keep things readable on the filesystem
172 225
173 if [ ! -d "${MY_SQLSCRIPTSDIR}/$1" ]; then 226# @FUNCTION: webapp_postupgrade_txt
174 mkdir -p "${MY_SQLSCRIPTSDIR}/$1" || libsh_die "unable to create directory ${MY_SQLSCRIPTSDIR}/$1" 227# @USAGE: <lang> <file>
175 fi 228# @DESCRIPTION:
229# Install a text file containing post-upgrade instructions.
230webapp_postupgrade_txt() {
231 debug-print-function $FUNCNAME $*
176 232
177 # warning: 233 webapp_checkfileexists "${2}"
234
235 elog "(info) ${2} (lang: ${1})"
236 cp "${2}" "${D}/${MY_APPDIR}/postupgrade-${1}.txt"
237}
238
239# helper for webapp_serverowned()
240_webapp_serverowned() {
241 debug-print-function $FUNCNAME $*
242
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:
178 # 289 #
179 # do NOT change the naming convention used here without changing all 290 # do NOT change the naming convention used here without changing all
180 # the other scripts that also rely upon these names 291 # the other scripts that also rely upon these names
181 292
182 # 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
183 if [ -n "$3" ]; then 318 if [[ -n "${3}" ]]; then
184 # yes we are
185 einfo "($1) upgrade script from ${PN}-${PVR} to $3" 319 elog "(${1}) upgrade script for ${PN}-${3} to ${PVR}"
186 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"
187 else 322 else
188 # no, we are not
189 einfo "($1) create script for ${PN}-${PVR}" 323 elog "(${1}) create script for ${PN}-${PVR}"
190 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"
191 fi 326 fi
192} 327}
193 328
194# ------------------------------------------------------------------------ 329# @FUNCTION: webapp_src_preinst
195# EXPORTED FUNCTION - call from inside your ebuild's src_install AFTER 330# @DESCRIPTION:
196# 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.
197# 371#
198# 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
199# are no setuid files. I'm sure this will change significantly before 373# pkg_setup().
200# the final version! 374webapp_pkg_setup() {
201# ------------------------------------------------------------------------ 375 debug-print-function $FUNCNAME $*
202 376
203function webapp_src_install () 377 # to test whether or not the ebuild has correctly called this function
204{ 378 # we add an empty file to the filesystem
205 chown -R root:root ${D}/ 379 #
206 chmod -R u-s ${D}/ 380 # we used to just set a variable in the shell script, but we can
207 chmod -R g-s ${D}/ 381 # no longer rely on Portage calling both webapp_pkg_setup() and
208} 382 # webapp_src_install() within the same shell process
383 touch "${T}/${SETUP_CHECK_FILE}"
209 384
210# ------------------------------------------------------------------------ 385 # special case - some ebuilds *do* need to overwride the SLOT
211# EXPORTED FUNCTION - call from inside your ebuild's pkg_config AFTER 386 if [[ "${SLOT}+" != "${PVR}+" && "${WEBAPP_MANUAL_SLOT}" != "yes" ]]; then
212# everything else has run 387 die "Set WEBAPP_MANUAL_SLOT=\"yes\" if you need to SLOT manually"
388 fi
389
390 # pull in the shared configuration file
391 G_HOSTNAME="localhost"
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 ebeep 10
417 elif [[ "$(echo ${my_output} | awk '{ print $1 }')" != "${PN}" ]]; then
418 echo
419 eerror "You already have ${my_output} installed in ${my_dir}"
420 eerror
421 eerror "I cannot upgrade a different application"
422 eerror
423 echo
424 die "Cannot upgrade contents of ${my_dir}"
425 fi
426
427}
428
429# @FUNCTION: webapp_src_install
430# @DESCRIPTION:
431# This is the default src_install(). For now, we just make sure that root owns
432# everything, and that there are no setuid files.
213# 433#
214# If 'vhosts' USE flag is not set, auto-install this app 434# You need to call this function AFTER everything else has run in your custom
435# src_install().
436webapp_src_install() {
437 debug-print-function $FUNCNAME $*
438
439 # to test whether or not the ebuild has correctly called this function
440 # we add an empty file to the filesystem
441 #
442 # we used to just set a variable in the shell script, but we can
443 # no longer rely on Portage calling both webapp_src_install() and
444 # webapp_pkg_postinst() within the same shell process
445 touch "${D}/${MY_APPDIR}/${INSTALL_CHECK_FILE}"
446
447 chown -R "${VHOST_DEFAULT_UID}:${VHOST_DEFAULT_GID}" "${D}/"
448 chmod -R u-s "${D}/"
449 chmod -R g-s "${D}/"
450
451 keepdir "${MY_PERSISTDIR}"
452 fowners "root:0" "${MY_PERSISTDIR}"
453 fperms 755 "${MY_PERSISTDIR}"
454}
455
456# @FUNCTION: webapp_pkg_postinst
457# @DESCRIPTION:
458# The default pkg_postinst() for this eclass. This installs the web application to
459# `${ROOT}/var/www/localhost/htdocs/${PN}/' if USE=vhosts is not set. Otherwise
460# display a short notice how to install this application with webapp-config.
215# 461#
216# ------------------------------------------------------------------------ 462# You need to call this function AFTER everything else has run in your custom
463# pkg_postinst().
464webapp_pkg_postinst() {
465 debug-print-function $FUNCNAME $*
217 466
218function webapp_pkg_setup () 467 webapp_read_config
219{
220 # we do have the config file, right?
221 468
222 if [ "$G_HASCONFIG" = "0" ]; then 469 # sanity checks, to catch bugs in the ebuild
223 die "/etc/conf.d/webapp-config missing" 470 if [[ ! -f "${ROOT}${MY_APPDIR}/${INSTALL_CHECK_FILE}" ]]; then
471 eerror
472 eerror "This ebuild did not call webapp_src_install() at the end"
473 eerror "of the src_install() function"
474 eerror
475 eerror "Please log a bug on http://bugs.gentoo.org"
476 eerror
477 eerror "You should use emerge -C to remove this package, as the"
478 eerror "installation is incomplete"
479 eerror
480 die "Ebuild did not call webapp_src_install() - report to http://bugs.gentoo.org"
481 fi
482
483 if has vhosts ${IUSE}; then
484 if ! use vhosts; then
485 echo
486 elog "vhosts USE flag not set - auto-installing using webapp-config"
487
488 G_HOSTNAME="localhost"
489 webapp_read_config
490
491 local my_mode=-I
492 webapp_getinstalltype
493
494 if [[ "${IS_REPLACE}" == "1" ]]; then
495 elog "${PN}-${PVR} is already installed - replacing"
496 my_mode=-I
497 elif [[ "${IS_UPGRADE}" == "1" ]]; then
498 elog "${REMOVE_PKG} is already installed - upgrading"
499 my_mode=-U
500 else
501 elog "${PN}-${PVR} is not installed - using install mode"
502 fi
503
504 my_cmd="${WEBAPP_CONFIG} ${my_mode} -h localhost -u root -d ${INSTALL_DIR} ${PN} ${PVR}"
505 elog "Running ${my_cmd}"
506 ${my_cmd}
507
508 echo
509 local cleaner="${WEBAPP_CLEANER} -p -C /${PN}"
510 einfo "Running ${cleaner}"
511 ${cleaner}
512 else
513 elog
514 elog "The 'vhosts' USE flag is switched ON"
515 elog "This means that Portage will not automatically run webapp-config to"
516 elog "complete the installation."
517 elog
518 elog "To install ${PN}-${PVR} into a virtual host, run the following command:"
519 elog
520 elog " webapp-config -I -h <host> -d ${PN} ${PN} ${PVR}"
521 elog
522 elog "For more details, see the webapp-config(8) man page"
224 fi 523 fi
524 else
525 elog
526 elog "This ebuild does not support the 'vhosts' USE flag."
527 elog "This means that Portage will not automatically run webapp-config to"
528 elog "complete the installation."
529 elog
530 elog "To install ${PN}-${PVR} into a virtual host, run the following command:"
531 elog
532 elog " webapp-config -I -h <host> -d ${PN} ${PN} ${PVR}"
533 elog
534 elog "For more details, see the webapp-config(8) man page"
535 fi
536}
225 537
226 # are we emerging something that is already installed? 538# @FUNCTION: webapp_pkg_prerm
539# @DESCRIPTION:
540# This is the default pkg_prerm() for this eclass. If USE=vhosts is not set
541# remove all installed copies of this web application. Otherwise instruct the
542# user to manually remove those copies. See bug #136959.
543webapp_pkg_prerm() {
544 debug-print-function $FUNCNAME $*
227 545
228 if [ -d "${MY_APPROOT}/${MY_APPSUFFIX}" ]; then 546 local my_output=
229 # yes we are 547 my_output="$(${WEBAPP_CONFIG} --list-installs ${PN} ${PVR})"
230 ewarn "Removing existing copy of ${PN}-${PVR}" 548 [[ $? -ne 0 ]] && return
231 rm -rf "${MY_APPROOT}/${MY_APPSUFFIX}" 549
550 local x
551 if has vhosts ${IUSE} && ! use vhosts; then
552 echo "${my_output}" | while read x; do
553 if [[ -f "${x}"/.webapp ]]; then
554 . "${x}"/.webapp
555 if [[ -n "${WEB_HOSTNAME}" && -n "${WEB_INSTALLDIR}" ]]; then
556 ${WEBAPP_CONFIG} -C -h ${WEB_HOSTNAME} -d ${WEB_INSTALLDIR} ${PN} ${PVR}
557 fi
558 else
559 ewarn "Cannot find file ${x}/.webapp"
232 fi 560 fi
561 done
562 elif [[ "${my_output}" != "" ]]; then
563 echo
564 ewarn
565 ewarn "Don't forget to use webapp-config to remove any copies of"
566 ewarn "${PN}-${PVR} installed in"
567 ewarn
233 568
234 # create the directories that we need 569 echo "${my_output}" | while read x; do
570 if [[ -f "${x}"/.webapp ]]; then
571 ewarn " ${x}"
572 else
573 ewarn "Cannot find file ${x}/.webapp"
574 fi
575 done
235 576
236 mkdir -p ${MY_HTDOCSDIR} 577 ewarn
237 mkdir -p ${MY_HOSTROOTDIR} 578 echo
238 mkdir -p ${MY_CGIBINDIR} 579 fi
239 mkdir -p ${MY_ICONSDIR}
240 mkdir -p ${MY_ERRORSDIR}
241 mkdir -p ${MY_SQLSCRIPTSDIR}
242} 580}
243
244function webapp_pkg_config ()
245{
246 use vhosts || webapp-config -u root -d /var/www/localhost/htdocs/${PN}/ ${PN}
247}

Legend:
Removed from v.1.4  
changed lines
  Added in v.1.70

  ViewVC Help
Powered by ViewVC 1.1.20