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

Diff of /eclass/webapp.eclass

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

Revision 1.56 Revision 1.72
1# Copyright 1999-2006 Gentoo Foundation 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.56 2008/02/22 14:44:16 hollow 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: 6# @MAINTAINER:
7# web-apps@gentoo.org 7# web-apps@gentoo.org
8# @BLURB: functions for installing applications to run under a web server 8# @BLURB: functions for installing applications to run under a web server
9# @DESCRIPTION: 9# @DESCRIPTION:
10# The webapp eclass contains functions to handle web applications with 10# The webapp eclass contains functions to handle web applications with
11# webapp-config. Part of the implementation of GLEP #11 11# webapp-config. Part of the implementation of GLEP #11
12 12
13# @ECLASS-VARIABLE: WEBAPP_DEPEND
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"
13SLOT="${PVR}" 32 SLOT="${PVR}"
14IUSE="vhosts" 33 DEPEND="${WEBAPP_DEPEND}"
15DEPEND=">=app-admin/webapp-config-1.50.15"
16RDEPEND="${DEPEND}" 34 RDEPEND="${DEPEND}"
35fi
17 36
18EXPORT_FUNCTIONS pkg_postinst pkg_setup src_install pkg_prerm 37EXPORT_FUNCTIONS pkg_postinst pkg_setup src_install pkg_prerm
19 38
20INSTALL_DIR="/${PN}" 39INSTALL_DIR="/${PN}"
21IS_UPGRADE=0 40IS_UPGRADE=0
22IS_REPLACE=0 41IS_REPLACE=0
23 42
24INSTALL_CHECK_FILE="installed_by_webapp_eclass" 43INSTALL_CHECK_FILE="installed_by_webapp_eclass"
44SETUP_CHECK_FILE="setup_by_webapp_eclass"
25 45
26ETC_CONFIG="${ROOT}etc/vhosts/webapp-config" 46ETC_CONFIG="${ROOT}etc/vhosts/webapp-config"
27WEBAPP_CONFIG="${ROOT}usr/sbin/webapp-config" 47WEBAPP_CONFIG="${ROOT}usr/sbin/webapp-config"
28WEBAPP_CLEANER="${ROOT}usr/sbin/webapp-cleaner" 48WEBAPP_CLEANER="${ROOT}usr/sbin/webapp-cleaner"
29 49
37 debug-print-function $FUNCNAME $* 57 debug-print-function $FUNCNAME $*
38 58
39 if has_version '>=app-admin/webapp-config-1.50'; then 59 if has_version '>=app-admin/webapp-config-1.50'; then
40 ENVVAR=$(${WEBAPP_CONFIG} --query ${PN} ${PVR}) || die "Could not read settings from webapp-config!" 60 ENVVAR=$(${WEBAPP_CONFIG} --query ${PN} ${PVR}) || die "Could not read settings from webapp-config!"
41 eval ${ENVVAR} 61 eval ${ENVVAR}
42 else 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
43 . ${ETC_CONFIG} || die "Unable to read ${ETC_CONFIG}" 68 . ${ETC_CONFIG} || die "Unable to read ${ETC_CONFIG}"
44 fi 69 fi
45} 70}
46 71
47# Check whether a specified file exists in the given directory (`.' by default) 72# Check whether a specified file exists in the given directory (`.' by default)
78 echo "${1/#.\///}" 103 echo "${1/#.\///}"
79} 104}
80 105
81webapp_getinstalltype() { 106webapp_getinstalltype() {
82 debug-print-function $FUNCNAME $* 107 debug-print-function $FUNCNAME $*
83 use vhosts && return 108
109 if ! has vhosts ${IUSE} || use vhosts; then
110 return
111 fi
84 112
85 local my_output 113 local my_output
86 my_output="$(webapp_check_installedat)" 114 my_output="$(webapp_check_installedat)"
87 115
88 if [[ $? -eq 0 ]]; then 116 if [[ $? -eq 0 ]]; then
96 124
97 if [[ "${my_pn}" == "${PN}" ]]; then 125 if [[ "${my_pn}" == "${PN}" ]]; then
98 if [[ "${my_pvr}" != "${PVR}" ]]; then 126 if [[ "${my_pvr}" != "${PVR}" ]]; then
99 elog "This is an upgrade" 127 elog "This is an upgrade"
100 IS_UPGRADE=1 128 IS_UPGRADE=1
129 # for binpkgs, reset status, var declared in global scope
130 IS_REPLACE=0
101 else 131 else
102 elog "This is a re-installation" 132 elog "This is a re-installation"
103 IS_REPLACE=1 133 IS_REPLACE=1
134 # for binpkgs, reset status, var declared in global scope
135 IS_UPGRADE=0
104 fi 136 fi
105 else 137 else
106 elog "${my_output} is installed there" 138 elog "${my_output} is installed there"
107 fi 139 fi
108 else 140 else
141 # for binpkgs, reset status, var declared in global scope
142 IS_REPLACE=0
143 IS_UPGRADE=0
109 elog "This is an installation" 144 elog "This is an installation"
110 fi 145 fi
111} 146}
112 147
113# ============================================================================== 148# ==============================================================================
114# PUBLIC FUNCTIONS 149# PUBLIC FUNCTIONS
115# ============================================================================== 150# ==============================================================================
151
152# @FUNCTION: need_httpd
153# @DESCRIPTION:
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 )"
159}
160
161# @FUNCTION: need_httpd_cgi
162# @DESCRIPTION:
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 )"
168}
169
170# @FUNCTION: need_httpd_fastcgi
171# @DESCRIPTION:
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"
177}
116 178
117# @FUNCTION: webapp_configfile 179# @FUNCTION: webapp_configfile
118# @USAGE: <file> [more files ...] 180# @USAGE: <file> [more files ...]
119# @DESCRIPTION: 181# @DESCRIPTION:
120# Mark a file config-protected for a web-based application. 182# Mark a file config-protected for a web-based application.
269# You need to call this function in src_install() BEFORE anything else has run. 331# You need to call this function in src_install() BEFORE anything else has run.
270# For now we just create required webapp-config directories. 332# For now we just create required webapp-config directories.
271webapp_src_preinst() { 333webapp_src_preinst() {
272 debug-print-function $FUNCNAME $* 334 debug-print-function $FUNCNAME $*
273 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.
274 dodir "${MY_HTDOCSDIR}" 352 dodir "${MY_HTDOCSDIR}"
275 dodir "${MY_HOSTROOTDIR}" 353 dodir "${MY_HOSTROOTDIR}"
276 dodir "${MY_CGIBINDIR}" 354 dodir "${MY_CGIBINDIR}"
277 dodir "${MY_ICONSDIR}" 355 dodir "${MY_ICONSDIR}"
278 dodir "${MY_ERRORSDIR}" 356 dodir "${MY_ERRORSDIR}"
283 361
284# ============================================================================== 362# ==============================================================================
285# EXPORTED FUNCTIONS 363# EXPORTED FUNCTIONS
286# ============================================================================== 364# ==============================================================================
287 365
288# @FUNCTION: webapp_src_install
289# @DESCRIPTION:
290# This is the default src_install(). For now, we just make sure that root owns
291# everything, and that there are no setuid files.
292#
293# You need to call this function AFTER everything else has run in your custom
294# src_install().
295webapp_src_install() {
296 debug-print-function $FUNCNAME $*
297
298 chown -R "${VHOST_DEFAULT_UID}:${VHOST_DEFAULT_GID}" "${D}/"
299 chmod -R u-s "${D}/"
300 chmod -R g-s "${D}/"
301
302 keepdir "${MY_PERSISTDIR}"
303 fowners "root:0" "${MY_PERSISTDIR}"
304 fperms 755 "${MY_PERSISTDIR}"
305
306 # to test whether or not the ebuild has correctly called this function
307 # we add an empty file to the filesystem
308 #
309 # we used to just set a variable in the shell script, but we can
310 # no longer rely on Portage calling both webapp_src_install() and
311 # webapp_pkg_postinst() within the same shell process
312
313 touch "${D}/${MY_APPDIR}/${INSTALL_CHECK_FILE}"
314}
315
316# @FUNCTION: webapp_pkg_setup 366# @FUNCTION: webapp_pkg_setup
317# @DESCRIPTION: 367# @DESCRIPTION:
318# The default pkg_setup() for this eclass. This will gather required variables 368# The default pkg_setup() for this eclass. This will gather required variables
319# from webapp-config and check if there is an application installed to 369# from webapp-config and check if there is an application installed to
320# `${ROOT}/var/www/localhost/htdocs/${PN}/' if USE=vhosts is not set. 370# `${ROOT}/var/www/localhost/htdocs/${PN}/' if USE=vhosts is not set.
322# You need to call this function BEFORE anything else has run in your custom 372# You need to call this function BEFORE anything else has run in your custom
323# pkg_setup(). 373# pkg_setup().
324webapp_pkg_setup() { 374webapp_pkg_setup() {
325 debug-print-function $FUNCNAME $* 375 debug-print-function $FUNCNAME $*
326 376
377 # to test whether or not the ebuild has correctly called this function
378 # we add an empty file to the filesystem
379 #
380 # we used to just set a variable in the shell script, but we can
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}"
384
327 # special case - some ebuilds *do* need to overwride the SLOT 385 # special case - some ebuilds *do* need to overwride the SLOT
328 if [[ "${SLOT}+" != "${PVR}+" && "${WEBAPP_MANUAL_SLOT}" != "yes" ]]; then 386 if [[ "${SLOT}+" != "${PVR}+" && "${WEBAPP_MANUAL_SLOT}" != "yes" ]]; then
329 die "Set WEBAPP_MANUAL_SLOT=\"yes\" if you need to SLOT manually" 387 die "Set WEBAPP_MANUAL_SLOT=\"yes\" if you need to SLOT manually"
330 fi 388 fi
331 389
334 webapp_read_config 392 webapp_read_config
335 393
336 local my_dir="${ROOT}${VHOST_ROOT}/${MY_HTDOCSBASE}/${PN}" 394 local my_dir="${ROOT}${VHOST_ROOT}/${MY_HTDOCSBASE}/${PN}"
337 395
338 # if USE=vhosts is enabled OR no application is installed we're done here 396 # if USE=vhosts is enabled OR no application is installed we're done here
339 use vhosts || [[ ! -d "${my_dir}" ]] && return 397 if ! has vhosts ${IUSE} || use vhosts || [[ ! -d "${my_dir}" ]]; then
398 return
399 fi
340 400
341 local my_output 401 local my_output
342 my_output="$(webapp_check_installedat)" 402 my_output="$(webapp_check_installedat)"
343 403
344 if [[ $? -ne 0 ]]; then 404 if [[ $? -ne 0 ]]; then
351 ewarn "compatible with webapp-config." 411 ewarn "compatible with webapp-config."
352 ewarn 412 ewarn
353 ewarn "This ebuild may be overwriting important files." 413 ewarn "This ebuild may be overwriting important files."
354 ewarn 414 ewarn
355 echo 415 echo
416 if has "${EAPI:-0}" 0 1 2; then
356 ebeep 10 417 ebeep 10
418 fi
357 elif [[ "$(echo ${my_output} | awk '{ print $1 }')" != "${PN}" ]]; then 419 elif [[ "$(echo ${my_output} | awk '{ print $1 }')" != "${PN}" ]]; then
358 echo 420 echo
359 eerror "You already have ${my_output} installed in ${my_dir}" 421 eerror "You already have ${my_output} installed in ${my_dir}"
360 eerror 422 eerror
361 eerror "I cannot upgrade a different application" 423 eerror "I cannot upgrade a different application"
362 eerror 424 eerror
363 echo 425 echo
364 die "Cannot upgrade contents of ${my_dir}" 426 die "Cannot upgrade contents of ${my_dir}"
365 fi 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.
435#
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}"
366} 456}
367 457
368# @FUNCTION: webapp_pkg_postinst 458# @FUNCTION: webapp_pkg_postinst
369# @DESCRIPTION: 459# @DESCRIPTION:
370# The default pkg_postinst() for this eclass. This installs the web application to 460# The default pkg_postinst() for this eclass. This installs the web application to
390 eerror "installation is incomplete" 480 eerror "installation is incomplete"
391 eerror 481 eerror
392 die "Ebuild did not call webapp_src_install() - report to http://bugs.gentoo.org" 482 die "Ebuild did not call webapp_src_install() - report to http://bugs.gentoo.org"
393 fi 483 fi
394 484
485 if has vhosts ${IUSE}; then
395 if ! use vhosts; then 486 if ! use vhosts; then
396 echo 487 echo
397 elog "vhosts USE flag not set - auto-installing using webapp-config" 488 elog "vhosts USE flag not set - auto-installing using webapp-config"
398 489
399 G_HOSTNAME="localhost" 490 G_HOSTNAME="localhost"
400 webapp_read_config 491 webapp_read_config
401 492
402 local my_mode=-I 493 local my_mode=-I
403 webapp_getinstalltype 494 webapp_getinstalltype
404 495
405 if [[ "${IS_REPLACE}" == "1" ]]; then 496 if [[ "${IS_REPLACE}" == "1" ]]; then
406 elog "${PN}-${PVR} is already installed - replacing" 497 elog "${PN}-${PVR} is already installed - replacing"
407 my_mode=-I 498 my_mode=-I
408 elif [[ "${IS_UPGRADE}" == "1" ]]; then 499 elif [[ "${IS_UPGRADE}" == "1" ]]; then
409 elog "${REMOVE_PKG} is already installed - upgrading" 500 elog "${REMOVE_PKG} is already installed - upgrading"
410 my_mode=-U 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}
411 else 514 else
412 elog "${PN}-${PVR} is not installed - using install mode" 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"
413 fi 525 fi
414
415 my_cmd="${WEBAPP_CONFIG} ${my_mode} -h localhost -u root -d ${INSTALL_DIR} ${PN} ${PVR}"
416 elog "Running ${my_cmd}"
417 ${my_cmd}
418
419 echo
420 local cleaner="${WEBAPP_CLEANER} -p -C ${PN}"
421 einfo "Running ${cleaner}"
422 ${cleaner}
423 else 526 else
424 elog 527 elog
425 elog "The 'vhosts' USE flag is switched ON" 528 elog "This ebuild does not support the 'vhosts' USE flag."
426 elog "This means that Portage will not automatically run webapp-config to" 529 elog "This means that Portage will not automatically run webapp-config to"
427 elog "complete the installation." 530 elog "complete the installation."
428 elog 531 elog
429 elog "To install ${PN}-${PVR} into a virtual host, run the following command:" 532 elog "To install ${PN}-${PVR} into a virtual host, run the following command:"
430 elog 533 elog
445 local my_output= 548 local my_output=
446 my_output="$(${WEBAPP_CONFIG} --list-installs ${PN} ${PVR})" 549 my_output="$(${WEBAPP_CONFIG} --list-installs ${PN} ${PVR})"
447 [[ $? -ne 0 ]] && return 550 [[ $? -ne 0 ]] && return
448 551
449 local x 552 local x
450 if ! use vhosts; then 553 if has vhosts ${IUSE} && ! use vhosts; then
451 echo "${my_output}" | while read x; do 554 echo "${my_output}" | while read x; do
452 if [[ -f "${x}"/.webapp ]]; then 555 if [[ -f "${x}"/.webapp ]]; then
453 . "${x}"/.webapp 556 . "${x}"/.webapp
454 if [[ -n "${WEB_HOSTNAME}" && -n "${WEB_INSTALLDIR}" ]]; then 557 if [[ -n "${WEB_HOSTNAME}" && -n "${WEB_INSTALLDIR}" ]]; then
455 ${WEBAPP_CONFIG} -C -h ${WEB_HOSTNAME} -d ${WEB_INSTALLDIR} 558 ${WEBAPP_CONFIG} -C -h ${WEB_HOSTNAME} -d ${WEB_INSTALLDIR} ${PN} ${PVR}
456 fi 559 fi
457 else 560 else
458 ewarn "Cannot find file ${x}/.webapp" 561 ewarn "Cannot find file ${x}/.webapp"
459 fi 562 fi
460 done 563 done

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

  ViewVC Help
Powered by ViewVC 1.1.20