/[gentoo-x86]/eclass/apache-2.eclass
Gentoo

Diff of /eclass/apache-2.eclass

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

Revision 1.6 Revision 1.14
1# Copyright 1999-2007 Gentoo Foundation 1# Copyright 1999-2007 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/apache-2.eclass,v 1.6 2008/01/16 10:47:45 hollow Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/apache-2.eclass,v 1.14 2008/12/10 01:06:12 robbat2 Exp $
4 4
5# @ECLASS: apache-2 5# @ECLASS: apache-2.eclass
6# @MAINTAINER:
6# @MAINTAINER: apache-devs@gentoo.org 7# apache-devs@gentoo.org
7# @BLURB: Provides a common set of functions for >=apache-2.2* ebuilds 8# @BLURB: Provides a common set of functions for apache-2.x ebuilds
8# @DESCRIPTION: 9# @DESCRIPTION:
9# This eclass handles common apache ebuild functions in a sane way and providing 10# This eclass handles apache-2.x ebuild functions such as LoadModule generation
10# information about where certain interfaces are located such as LoadModule
11# generation and inter-module dependency checking. 11# and inter-module dependency checking.
12 12
13inherit depend.apache eutils flag-o-matic multilib autotools 13inherit autotools confutils eutils flag-o-matic multilib
14 14
15# ============================================================================== 15# ==============================================================================
16# INTERNAL VARIABLES 16# INTERNAL VARIABLES
17# ============================================================================== 17# ==============================================================================
18 18
19# @ECLASS-VARIABLE: GENTOO_PATCHNAME 19# @ECLASS-VARIABLE: GENTOO_PATCHNAME
20# @DESCRIPTION: 20# @DESCRIPTION:
21# This internal variable contains the prefix for the patch tarball 21# This internal variable contains the prefix for the patch tarball.
22GENTOO_PATCHNAME="gentoo-${PF}" 22# Defaults to the full version (including revision) of the package.
23[[ -n "$GENTOO_PATCHNAME" ]] || GENTOO_PATCHNAME="gentoo-${PF}"
23 24
24# @ECLASS-VARIABLE: GENTOO_PATCHDIR 25# @ECLASS-VARIABLE: GENTOO_PATCHDIR
25# @DESCRIPTION: 26# @DESCRIPTION:
26# This internal variable contains the working directory where patches and config 27# This internal variable contains the working directory where patches and config
27# files are located 28# files are located.
29# Defaults to the patchset name appended to the working directory.
28GENTOO_PATCHDIR="${WORKDIR}/${GENTOO_PATCHNAME}" 30[[ -n "$GENTOO_PATCHDIR" ]] || GENTOO_PATCHDIR="${WORKDIR}/${GENTOO_PATCHNAME}"
29 31
30# @ECLASS-VARIABLE: GENTOO_DEVELOPER 32# @VARIABLE: GENTOO_DEVELOPER
31# @DESCRIPTION: 33# @DESCRIPTION:
32# This variable needs to be set in the ebuild and contains the name of the 34# This variable needs to be set in the ebuild and contains the name of the
33# gentoo developer who created the patch tarball 35# gentoo developer who created the patch tarball
34 36
35# @ECLASS-VARIABLE: GENTOO_PATCHSTAMP 37# @VARIABLE: GENTOO_PATCHSTAMP
36# @DESCRIPTION: 38# @DESCRIPTION:
37# This variable needs to be set in the ebuild and contains the date the patch 39# This variable needs to be set in the ebuild and contains the date the patch
38# tarball was created at in YYMMDD format 40# tarball was created at in YYYYMMDD format
41
42# @VARIABLE: GENTOO_PATCH_A
43# @DESCRIPTION:
44# This variable should contain the entire filename of patch tarball.
45# Defaults to the name of the patchset, with a datestamp.
46[[ -n "$GENTOO_PATCH_A" ]] || GENTOO_PATCH_A="${GENTOO_PATCHNAME}-${GENTOO_PATCHSTAMP}.tar.bz2"
39 47
40SRC_URI="mirror://apache/httpd/httpd-${PV}.tar.bz2 48SRC_URI="mirror://apache/httpd/httpd-${PV}.tar.bz2
41 http://dev.gentoo.org/~${GENTOO_DEVELOPER}/dist/apache/${GENTOO_PATCHNAME}-${GENTOO_PATCHSTAMP}.tar.bz2" 49 http://dev.gentoo.org/~${GENTOO_DEVELOPER}/dist/apache/${GENTOO_PATCH_A}"
42 50
43# @ECLASS-VARIABLE: IUSE_MPMS_FORK 51# @VARIABLE: IUSE_MPMS_FORK
44# @DESCRIPTION: 52# @DESCRIPTION:
45# This variable needs to be set in the ebuild and contains a list of forking 53# This variable needs to be set in the ebuild and contains a list of forking
46# (i.e. non-threaded) MPMS 54# (i.e. non-threaded) MPMs
47 55
48# @ECLASS-VARIABLE: IUSE_MPMS_THREAD 56# @VARIABLE: IUSE_MPMS_THREAD
49# @DESCRIPTION: 57# @DESCRIPTION:
50# This variable needs to be set in the ebuild and contains a list of threaded 58# This variable needs to be set in the ebuild and contains a list of threaded
51# MPMS 59# MPMs
52 60
53# @ECLASS-VARIABLE: IUSE_MODULES 61# @VARIABLE: IUSE_MODULES
54# @DESCRIPTION: 62# @DESCRIPTION:
55# This variable needs to be set in the ebuild and contains a list of available 63# This variable needs to be set in the ebuild and contains a list of available
56# built-in modules 64# built-in modules
57 65
58IUSE_MPMS="${IUSE_MPMS_FORK} ${IUSE_MPMS_THREAD}" 66IUSE_MPMS="${IUSE_MPMS_FORK} ${IUSE_MPMS_THREAD}"
70 =dev-libs/apr-1* 78 =dev-libs/apr-1*
71 =dev-libs/apr-util-1* 79 =dev-libs/apr-util-1*
72 dev-libs/libpcre 80 dev-libs/libpcre
73 ldap? ( =net-nds/openldap-2* ) 81 ldap? ( =net-nds/openldap-2* )
74 selinux? ( sec-policy/selinux-apache ) 82 selinux? ( sec-policy/selinux-apache )
75 ssl? ( dev-libs/openssl ) 83 ssl? ( >=dev-libs/openssl-0.9.8f )
76 !=www-servers/apache-1*" 84 !=www-servers/apache-1*"
77RDEPEND="${DEPEND}" 85RDEPEND="${DEPEND}"
78PDEPEND="~app-admin/apache-tools-${PV}" 86PDEPEND="~app-admin/apache-tools-${PV}"
79 87
80S="${WORKDIR}/httpd-${PV}" 88S="${WORKDIR}/httpd-${PV}"
82# ============================================================================== 90# ==============================================================================
83# INTERNAL FUNCTIONS 91# INTERNAL FUNCTIONS
84# ============================================================================== 92# ==============================================================================
85 93
86# @ECLASS-VARIABLE: MY_MPM 94# @ECLASS-VARIABLE: MY_MPM
87# DESCRIPTION: 95# @DESCRIPTION:
88# This internal variable contains the selected MPM after a call to setup_mpm() 96# This internal variable contains the selected MPM after a call to setup_mpm()
89 97
90# @FUNCTION: setup_mpm 98# @FUNCTION: setup_mpm
91# @DESCRIPTION: 99# @DESCRIPTION:
92# This internal function makes sure that only one of APACHE2_MPMS was selected 100# This internal function makes sure that only one of APACHE2_MPMS was selected
131 eerror "You have selected a non-threaded MPM but USE=threads is enabled" 139 eerror "You have selected a non-threaded MPM but USE=threads is enabled"
132 die "invalid use flag combination" 140 die "invalid use flag combination"
133 fi 141 fi
134} 142}
135 143
136# @ECLASS-VARIABLE: MODULE_CRITICAL 144# @VARIABLE: MODULE_CRITICAL
137# @DESCRIPTION: 145# @DESCRIPTION:
138# This variable needs to be set in the ebuild and contains a space-separated 146# This variable needs to be set in the ebuild and contains a space-separated
139# list of modules critical for the default apache. A user may still 147# list of modules critical for the default apache. A user may still
140# disable these modules for custom minimal installation at their own risk. 148# disable these modules for custom minimal installation at their own risk.
141 149
162 ewarn 170 ewarn
163 ebeep 10 171 ebeep 10
164 fi 172 fi
165} 173}
166 174
167# @ECLASS-VARIABLE: MODULE_DEPENDS 175# @VARIABLE: MODULE_DEPENDS
168# @DESCRIPTION: 176# @DESCRIPTION:
169# This variable needs to be set in the ebuild and contains a space-separated 177# This variable needs to be set in the ebuild and contains a space-separated
170# list of dependency tokens each with a module and the module it depends on 178# list of dependency tokens each with a module and the module it depends on
171# separated by a colon 179# separated by a colon
172 180
177check_module_depends() { 185check_module_depends() {
178 local err=0 186 local err=0
179 187
180 for m in ${MY_MODS} ; do 188 for m in ${MY_MODS} ; do
181 for dep in ${MODULE_DEPENDS} ; do 189 for dep in ${MODULE_DEPENDS} ; do
182 if [[ "${m}" == "${dep%:*}" ]]; then 190 if [[ "${m}" == "${dep%:*}" ]] ; then
183 if ! use apache2_modules_${dep#*:} ; then 191 if ! use apache2_modules_${dep#*:} ; then
184 eerror "Module '${m}' depends on '${dep#*:}'" 192 eerror "Module '${m}' depends on '${dep#*:}'"
185 err=1 193 err=1
186 fi 194 fi
187 fi 195 fi
192 die "invalid use flag combination" 200 die "invalid use flag combination"
193 fi 201 fi
194} 202}
195 203
196# @ECLASS-VARIABLE: MY_CONF 204# @ECLASS-VARIABLE: MY_CONF
197# DESCRIPTION: 205# @DESCRIPTION:
198# This internal variable contains the econf options for the current module 206# This internal variable contains the econf options for the current module
199# selection after a call to setup_modules() 207# selection after a call to setup_modules()
200 208
201# @ECLASS-VARIABLE: MY_MODS 209# @ECLASS-VARIABLE: MY_MODS
202# DESCRIPTION: 210# @DESCRIPTION:
203# This internal variable contains a sorted, space separated list of currently 211# This internal variable contains a sorted, space separated list of currently
204# selected modules after a call to setup_modules() 212# selected modules after a call to setup_modules()
205 213
206# @FUNCTION: setup_modules 214# @FUNCTION: setup_modules
207# @DESCRIPTION: 215# @DESCRIPTION:
217 fi 225 fi
218 226
219 MY_CONF="--enable-so=static" 227 MY_CONF="--enable-so=static"
220 228
221 if use ldap ; then 229 if use ldap ; then
222 if ! built_with_use 'dev-libs/apr-util' ldap ; then 230 confutils_use_depend_built_with_all ldap dev-libs/apr-util ldap
223 eerror "dev-libs/apr-util is missing LDAP support. For apache to have"
224 eerror "ldap support, apr-util must be built with the ldap USE-flag"
225 eerror "enabled."
226 die "ldap USE-flag enabled while not supported in apr-util"
227 fi
228 MY_CONF="${MY_CONF} --enable-authnz_ldap=${mod_type} --enable-ldap=${mod_type}" 231 MY_CONF="${MY_CONF} --enable-authnz_ldap=${mod_type} --enable-ldap=${mod_type}"
229 MY_MODS="${MY_MODS} ldap authnz_ldap" 232 MY_MODS="${MY_MODS} ldap authnz_ldap"
230 else 233 else
231 MY_CONF="${MY_CONF} --disable-authnz_ldap --disable-ldap" 234 MY_CONF="${MY_CONF} --disable-authnz_ldap --disable-ldap"
232 fi 235 fi
288 MY_MODS=$(echo ${MY_MODS} | tr ' ' '\n' | sort -u) 291 MY_MODS=$(echo ${MY_MODS} | tr ' ' '\n' | sort -u)
289 check_module_depends 292 check_module_depends
290 check_module_critical 293 check_module_critical
291} 294}
292 295
293# @ECLASS-VARIABLE: MODULE_DEFINES 296# @VARIABLE: MODULE_DEFINES
294# @DESCRIPTION: 297# @DESCRIPTION:
295# This variable needs to be set in the ebuild and contains a space-separated 298# This variable needs to be set in the ebuild and contains a space-separated
296# list of tokens each mapping a module to a runtime define which can be 299# list of tokens each mapping a module to a runtime define which can be
297# specified in APACHE2_OPTS in /etc/conf.d/apache2 to enable this particular 300# specified in APACHE2_OPTS in /etc/conf.d/apache2 to enable this particular
298# module. 301# module.
300# @FUNCTION: generate_load_module 303# @FUNCTION: generate_load_module
301# @DESCRIPTION: 304# @DESCRIPTION:
302# This internal function generates the LoadModule lines for httpd.conf based on 305# This internal function generates the LoadModule lines for httpd.conf based on
303# the current module selection and MODULE_DEFINES 306# the current module selection and MODULE_DEFINES
304generate_load_module() { 307generate_load_module() {
305 local endit=0 mod_lines= mod_dir="${D}${APACHE2_MODULESDIR}" 308 local endit=0 mod_lines= mod_dir="${D}/usr/$(get_libdir)/apache2/modules"
306 309
307 if use static; then 310 if use static; then
308 sed -i -e "/%%LOAD_MODULE%%/d" \ 311 sed -i -e "/%%LOAD_MODULE%%/d" \
309 "${GENTOO_PATCHDIR}"/conf/httpd.conf 312 "${GENTOO_PATCHDIR}"/conf/httpd.conf
310 return 313 return
362# creates the apache user and group and informs about CONFIG_SYSVIPC being 365# creates the apache user and group and informs about CONFIG_SYSVIPC being
363# needed (we don't depend on kernel sources and therefore cannot check). 366# needed (we don't depend on kernel sources and therefore cannot check).
364apache-2_pkg_setup() { 367apache-2_pkg_setup() {
365 check_upgrade 368 check_upgrade
366 369
367 setup_mpm
368 setup_modules
369
370 if use debug; then
371 MY_CONF="${MY_CONF} --enable-maintainer-mode --enable-exception-hook"
372 fi
373
374 # setup apache user and group 370 # setup apache user and group
375 enewgroup apache 81 371 enewgroup apache 81
376 enewuser apache 81 -1 /var/www apache 372 enewuser apache 81 -1 /var/www apache
377 373
374 setup_mpm
375 setup_modules
376
377 if use debug; then
378 MY_CONF="${MY_CONF} --enable-maintainer-mode --enable-exception-hook"
379 fi
380
378 elog "Please note that you need SysV IPC support in your kernel." 381 elog "Please note that you need SysV IPC support in your kernel."
379 elog "Make sure CONFIG_SYSVIPC=y is set." 382 elog "Make sure CONFIG_SYSVIPC=y is set."
380 elog 383 elog
384
385 if use userland_BSD; then
386 elog "On BSD systems you need to add the following line to /boot/loader.conf:"
387 elog " accf_http_load=\"YES\""
388 elog
389 fi
381} 390}
382 391
383# @FUNCTION: apache-2_src_unpack 392# @FUNCTION: apache-2_src_unpack
384# @DESCRIPTION: 393# @DESCRIPTION:
385# This function applies patches, configures a custom file-system layout and 394# This function applies patches, configures a custom file-system layout and
430 --libexecdir=/usr/$(get_libdir)/apache2/modules \ 439 --libexecdir=/usr/$(get_libdir)/apache2/modules \
431 --datadir=/var/www/localhost \ 440 --datadir=/var/www/localhost \
432 --sysconfdir=/etc/apache2 \ 441 --sysconfdir=/etc/apache2 \
433 --localstatedir=/var \ 442 --localstatedir=/var \
434 --with-mpm=${MY_MPM} \ 443 --with-mpm=${MY_MPM} \
435 --with-perl=/usr/bin/perl \
436 --with-apr=/usr \ 444 --with-apr=/usr \
437 --with-apr-util=/usr \ 445 --with-apr-util=/usr \
438 --with-pcre=/usr \ 446 --with-pcre=/usr \
439 --with-z=/usr \ 447 --with-z=/usr \
440 --with-port=80 \ 448 --with-port=80 \
447 emake || die "emake failed" 455 emake || die "emake failed"
448} 456}
449 457
450# @FUNCTION: apache-2_src_install 458# @FUNCTION: apache-2_src_install
451# @DESCRIPTION: 459# @DESCRIPTION:
452# This function runs emake install and generates, install and adapts the gentoo 460# This function runs `emake install' and generates, installs and adapts the gentoo
453# specific configuration files found in the tarball 461# specific configuration files found in the tarball
454apache-2_src_install() { 462apache-2_src_install() {
455 make DESTDIR="${D}" install || die "make install failed" 463 make DESTDIR="${D}" install || die "make install failed"
456 464
457 # install our configuration files 465 # install our configuration files
476 "${GENTOO_PATCHDIR}"/init/apache2.confd || die "sed failed" 484 "${GENTOO_PATCHDIR}"/init/apache2.confd || die "sed failed"
477 485
478 newconfd "${GENTOO_PATCHDIR}"/init/apache2.confd apache2 486 newconfd "${GENTOO_PATCHDIR}"/init/apache2.confd apache2
479 newinitd "${GENTOO_PATCHDIR}"/init/apache2.initd apache2 487 newinitd "${GENTOO_PATCHDIR}"/init/apache2.initd apache2
480 488
481 # link apache2ctl to the init script 489 # install apache2ctl wrapper for our init script if available
490 if test -e "${GENTOO_PATCHDIR}"/scripts/apache2ctl; then
491 exeinto /usr/sbin
492 doexe "${GENTOO_PATCHDIR}"/scripts/apache2ctl
493 else
482 dosym /etc/init.d/apache2 /usr/sbin/apache2ctl 494 dosym /etc/init.d/apache2 /usr/sbin/apache2ctl
495 fi
483 496
484 # provide legacy symlink for apxs, bug 177697 497 # provide legacy symlink for apxs, bug 177697
485 dosym /usr/sbin/apxs /usr/sbin/apxs2 498 dosym /usr/sbin/apxs /usr/sbin/apxs2
486 499
487 # install some thirdparty scripts 500 # install some thirdparty scripts
498 else 511 else
499 rm -f "${D}/etc/apache2/modules.d/00_apache_manual.conf" 512 rm -f "${D}/etc/apache2/modules.d/00_apache_manual.conf"
500 rm -Rf "${D}/usr/share/doc/${PF}/manual" 513 rm -Rf "${D}/usr/share/doc/${PF}/manual"
501 fi 514 fi
502 515
503 # the default webroot gets stored in /usr/share/doc 516 # the default webroot gets stored in /usr/share/${PF}/webroot
504 ebegin "Installing default webroot to /usr/share/doc/${PF}" 517 ebegin "Installing default webroot to /usr/share/${PF}/webroot"
518 dodir /usr/share/${PF}
505 mv -f "${D}/var/www/localhost" "${D}/usr/share/doc/${PF}/webroot" 519 mv -f "${D}/var/www/localhost" "${D}/usr/share/${PF}/webroot"
506 eend $? 520 eend $?
507 keepdir /var/www/localhost/htdocs
508 521
509 # set some sane permissions for suexec 522 # set some sane permissions for suexec
510 if use suexec ; then 523 if use suexec ; then
511 fowners 0:apache /usr/sbin/suexec 524 fowners 0:apache /usr/sbin/suexec
512 fperms 4710 /usr/sbin/suexec 525 fperms 4710 /usr/sbin/suexec
526} 539}
527 540
528# @FUNCTION: apache-2_pkg_postinst 541# @FUNCTION: apache-2_pkg_postinst
529# @DESCRIPTION: 542# @DESCRIPTION:
530# This function creates test certificates if SSL is enabled and installs the 543# This function creates test certificates if SSL is enabled and installs the
531# default webroot if /var/www/localhost does not exist. We do this here because 544# default webroot to /var/www/localhost if it does not exist. We do this here
532# the default webroot is a copy of the files that exist elsewhere and we don't 545# because the default webroot is a copy of the files that exist elsewhere and we
533# want them to be managed/removed by portage when apache is upgraded. 546# don't want them to be managed/removed by portage when apache is upgraded.
534apache-2_pkg_postinst() { 547apache-2_pkg_postinst() {
548 einfo
549
535 if use ssl && [[ ! -e "${ROOT}/etc/apache2/ssl/server.crt" ]] ; then 550 if use ssl && [[ ! -e "${ROOT}/etc/apache2/ssl/server.crt" ]] ; then
536 cd "${ROOT}"/etc/apache2/ssl 551 cd "${ROOT}"/etc/apache2/ssl
537 einfo
538 einfo "Generating self-signed test certificate in ${ROOT}etc/apache2/ssl ..." 552 einfo "Generating self-signed test certificate in ${ROOT}etc/apache2/ssl ..."
539 yes "" 2>/dev/null | \ 553 yes "" 2>/dev/null | \
540 "${ROOT}"/usr/sbin/gentestcrt.sh >/dev/null 2>&1 || \ 554 "${ROOT}"/usr/sbin/gentestcrt.sh >/dev/null 2>&1 || \
541 die "gentestcrt.sh failed" 555 die "gentestcrt.sh failed"
542 einfo 556 einfo
551 elog "emerge --config =${PF}" 565 elog "emerge --config =${PF}"
552 elog 566 elog
553 else 567 else
554 einfo "Installing default webroot to ${ROOT}var/www/localhost" 568 einfo "Installing default webroot to ${ROOT}var/www/localhost"
555 mkdir -p "${ROOT}"/var/www/localhost 569 mkdir -p "${ROOT}"/var/www/localhost
556 cp -R "${ROOT}"/usr/share/doc/${PF}/webroot/* "${ROOT}"/var/www/localhost 570 cp -R "${ROOT}"/usr/share/${PF}/webroot/* "${ROOT}"/var/www/localhost/
557 chown -R apache:0 "${ROOT}"/var/www/localhost 571 einfo
558 fi 572 fi
559} 573}
560 574
561# @FUNCTION: apache-2_pkg_config 575# @FUNCTION: apache-2_pkg_config
562# @DESCRIPTION: 576# @DESCRIPTION:
563# This function installs -- and removes a previously existing -- default webroot 577# This function installs -- and overwrites -- the default webroot to
564# to /var/www/localhost 578# /var/www/localhost
565apache-2_pkg_config() { 579apache-2_pkg_config() {
566 einfo "Installing default webroot to ${ROOT}var/www/localhost" 580 einfo "Installing default webroot to ${ROOT}var/www/localhost"
567 mkdir "${ROOT}"var{,/www{,/localhost}} 581 mkdir -p "${ROOT}"/var/www/localhost
568 cp -R "${ROOT}"usr/share/doc/${PF}/webroot/* "${ROOT}"var/www/localhost/ 582 cp -R "${ROOT}"/usr/share/${PF}/webroot/* "${ROOT}"/var/www/localhost/
569} 583}
570 584
571EXPORT_FUNCTIONS pkg_setup src_unpack src_compile src_install pkg_postinst pkg_config 585EXPORT_FUNCTIONS pkg_setup src_unpack src_compile src_install pkg_postinst pkg_config

Legend:
Removed from v.1.6  
changed lines
  Added in v.1.14

  ViewVC Help
Powered by ViewVC 1.1.20