/[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.3 Revision 1.12
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.3 2007/12/15 14:00:19 hollow Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/apache-2.eclass,v 1.12 2008/08/29 13:22:21 hollow 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
… …
25# @DESCRIPTION: 25# @DESCRIPTION:
26# This internal variable contains the working directory where patches and config 26# This internal variable contains the working directory where patches and config
27# files are located 27# files are located
28GENTOO_PATCHDIR="${WORKDIR}/${GENTOO_PATCHNAME}" 28GENTOO_PATCHDIR="${WORKDIR}/${GENTOO_PATCHNAME}"
29 29
30# @ECLASS-VARIABLE: GENTOO_DEVELOPER 30# @VARIABLE: GENTOO_DEVELOPER
31# @DESCRIPTION: 31# @DESCRIPTION:
32# This variable needs to be set in the ebuild and contains the name of the 32# This variable needs to be set in the ebuild and contains the name of the
33# gentoo developer who created the patch tarball 33# gentoo developer who created the patch tarball
34 34
35# @ECLASS-VARIABLE: GENTOO_PATCHSTAMP 35# @VARIABLE: GENTOO_PATCHSTAMP
36# @DESCRIPTION: 36# @DESCRIPTION:
37# This variable needs to be set in the ebuild and contains the date the patch 37# This variable needs to be set in the ebuild and contains the date the patch
38# tarball was created at in YYMMDD format 38# tarball was created at in YYYYMMDD format
39 39
40SRC_URI="mirror://apache/httpd/httpd-${PV}.tar.bz2 40SRC_URI="mirror://apache/httpd/httpd-${PV}.tar.bz2
41 http://dev.gentoo.org/~${GENTOO_DEVELOPER}/dist/apache/${GENTOO_PATCHNAME}-${GENTOO_PATCHSTAMP}.tar.bz2" 41 http://dev.gentoo.org/~${GENTOO_DEVELOPER}/dist/apache/${GENTOO_PATCHNAME}-${GENTOO_PATCHSTAMP}.tar.bz2"
42 42
43# @ECLASS-VARIABLE: IUSE_MPMS_FORK 43# @VARIABLE: IUSE_MPMS_FORK
44# @DESCRIPTION: 44# @DESCRIPTION:
45# This variable needs to be set in the ebuild and contains a list of forking 45# This variable needs to be set in the ebuild and contains a list of forking
46# (i.e. non-threaded) MPMS 46# (i.e. non-threaded) MPMs
47 47
48# @ECLASS-VARIABLE: IUSE_MPMS_THREAD 48# @VARIABLE: IUSE_MPMS_THREAD
49# @DESCRIPTION: 49# @DESCRIPTION:
50# This variable needs to be set in the ebuild and contains a list of threaded 50# This variable needs to be set in the ebuild and contains a list of threaded
51# MPMS 51# MPMs
52 52
53# @ECLASS-VARIABLE: IUSE_MODULES 53# @VARIABLE: IUSE_MODULES
54# @DESCRIPTION: 54# @DESCRIPTION:
55# This variable needs to be set in the ebuild and contains a list of available 55# This variable needs to be set in the ebuild and contains a list of available
56# built-in modules 56# built-in modules
57 57
58IUSE_MPMS="${IUSE_MPMS_FORK} ${IUSE_MPMS_THREAD}" 58IUSE_MPMS="${IUSE_MPMS_FORK} ${IUSE_MPMS_THREAD}"
… …
70 =dev-libs/apr-1* 70 =dev-libs/apr-1*
71 =dev-libs/apr-util-1* 71 =dev-libs/apr-util-1*
72 dev-libs/libpcre 72 dev-libs/libpcre
73 ldap? ( =net-nds/openldap-2* ) 73 ldap? ( =net-nds/openldap-2* )
74 selinux? ( sec-policy/selinux-apache ) 74 selinux? ( sec-policy/selinux-apache )
75 ssl? ( dev-libs/openssl ) 75 ssl? ( >=dev-libs/openssl-0.9.8f )
76 !=www-servers/apache-1*" 76 !=www-servers/apache-1*"
77RDEPEND="${DEPEND}" 77RDEPEND="${DEPEND}"
78PDEPEND="~app-admin/apache-tools-${PV}" 78PDEPEND="~app-admin/apache-tools-${PV}"
79 79
80S="${WORKDIR}/httpd-${PV}" 80S="${WORKDIR}/httpd-${PV}"
… …
82# ============================================================================== 82# ==============================================================================
83# INTERNAL FUNCTIONS 83# INTERNAL FUNCTIONS
84# ============================================================================== 84# ==============================================================================
85 85
86# @ECLASS-VARIABLE: MY_MPM 86# @ECLASS-VARIABLE: MY_MPM
87# DESCRIPTION: 87# @DESCRIPTION:
88# This internal variable contains the selected MPM after a call to setup_mpm() 88# This internal variable contains the selected MPM after a call to setup_mpm()
89 89
90# @FUNCTION: setup_mpm 90# @FUNCTION: setup_mpm
91# @DESCRIPTION: 91# @DESCRIPTION:
92# This internal function makes sure that only one of APACHE2_MPMS was selected 92# This internal function makes sure that only one of APACHE2_MPMS was selected
93# or a default based on USE=threads is selected if APACHE2_MPMS is empty 93# or a default based on USE=threads is selected if APACHE2_MPMS is empty
94setup_mpm() { 94setup_mpm() {
95 MY_MPM=""
95 for x in ${IUSE_MPMS} ; do 96 for x in ${IUSE_MPMS} ; do
96 if use apache2_mpms_${x} ; then 97 if use apache2_mpms_${x} ; then
97 if [[ -z "${MY_MPM}" ]] ; then 98 if [[ -z "${MY_MPM}" ]] ; then
98 MY_MPM=${x} 99 MY_MPM=${x}
99 elog 100 elog
… …
130 eerror "You have selected a non-threaded MPM but USE=threads is enabled" 131 eerror "You have selected a non-threaded MPM but USE=threads is enabled"
131 die "invalid use flag combination" 132 die "invalid use flag combination"
132 fi 133 fi
133} 134}
134 135
135# @ECLASS-VARIABLE: MODULE_CRITICAL 136# @VARIABLE: MODULE_CRITICAL
136# @DESCRIPTION: 137# @DESCRIPTION:
137# This variable needs to be set in the ebuild and contains a space-separated 138# This variable needs to be set in the ebuild and contains a space-separated
138# list of modules critical for the default apache. A user may still 139# list of modules critical for the default apache. A user may still
139# disable these modules for custom minimal installation at their own risk. 140# disable these modules for custom minimal installation at their own risk.
140 141
… …
161 ewarn 162 ewarn
162 ebeep 10 163 ebeep 10
163 fi 164 fi
164} 165}
165 166
166# @ECLASS-VARIABLE: MODULE_DEPENDS 167# @VARIABLE: MODULE_DEPENDS
167# @DESCRIPTION: 168# @DESCRIPTION:
168# This variable needs to be set in the ebuild and contains a space-separated 169# This variable needs to be set in the ebuild and contains a space-separated
169# list of dependency tokens each with a module and the module it depends on 170# list of dependency tokens each with a module and the module it depends on
170# separated by a colon 171# separated by a colon
171 172
… …
176check_module_depends() { 177check_module_depends() {
177 local err=0 178 local err=0
178 179
179 for m in ${MY_MODS} ; do 180 for m in ${MY_MODS} ; do
180 for dep in ${MODULE_DEPENDS} ; do 181 for dep in ${MODULE_DEPENDS} ; do
181 if [[ "${m}" == "${dep%:*}" ]]; then 182 if [[ "${m}" == "${dep%:*}" ]] ; then
182 if ! use apache2_modules_${dep#*:} ; then 183 if ! use apache2_modules_${dep#*:} ; then
183 eerror "Module '${m}' depends on '${dep#*:}'" 184 eerror "Module '${m}' depends on '${dep#*:}'"
184 err=1 185 err=1
185 fi 186 fi
186 fi 187 fi
… …
191 die "invalid use flag combination" 192 die "invalid use flag combination"
192 fi 193 fi
193} 194}
194 195
195# @ECLASS-VARIABLE: MY_CONF 196# @ECLASS-VARIABLE: MY_CONF
196# DESCRIPTION: 197# @DESCRIPTION:
197# This internal variable contains the econf options for the current module 198# This internal variable contains the econf options for the current module
198# selection after a call to setup_modules() 199# selection after a call to setup_modules()
199 200
200# @ECLASS-VARIABLE: MY_MODS 201# @ECLASS-VARIABLE: MY_MODS
201# DESCRIPTION: 202# @DESCRIPTION:
202# This internal variable contains a sorted, space separated list of currently 203# This internal variable contains a sorted, space separated list of currently
203# selected modules after a call to setup_modules() 204# selected modules after a call to setup_modules()
204 205
205# @FUNCTION: setup_modules 206# @FUNCTION: setup_modules
206# @DESCRIPTION: 207# @DESCRIPTION:
… …
216 fi 217 fi
217 218
218 MY_CONF="--enable-so=static" 219 MY_CONF="--enable-so=static"
219 220
220 if use ldap ; then 221 if use ldap ; then
221 if ! built_with_use 'dev-libs/apr-util' ldap ; then 222 confutils_use_depend_built_with_all ldap dev-libs/apr-util ldap
222 eerror "dev-libs/apr-util is missing LDAP support. For apache to have"
223 eerror "ldap support, apr-util must be built with the ldap USE-flag"
224 eerror "enabled."
225 die "ldap USE-flag enabled while not supported in apr-util"
226 fi
227 MY_CONF="${MY_CONF} --enable-authnz_ldap=${mod_type} --enable-ldap=${mod_type}" 223 MY_CONF="${MY_CONF} --enable-authnz_ldap=${mod_type} --enable-ldap=${mod_type}"
228 MY_MODS="${MY_MODS} ldap authnz_ldap" 224 MY_MODS="${MY_MODS} ldap authnz_ldap"
229 else 225 else
230 MY_CONF="${MY_CONF} --disable-authnz_ldap --disable-ldap" 226 MY_CONF="${MY_CONF} --disable-authnz_ldap --disable-ldap"
231 fi 227 fi
… …
287 MY_MODS=$(echo ${MY_MODS} | tr ' ' '\n' | sort -u) 283 MY_MODS=$(echo ${MY_MODS} | tr ' ' '\n' | sort -u)
288 check_module_depends 284 check_module_depends
289 check_module_critical 285 check_module_critical
290} 286}
291 287
292# @ECLASS-VARIABLE: MODULE_DEFINES 288# @VARIABLE: MODULE_DEFINES
293# @DESCRIPTION: 289# @DESCRIPTION:
294# This variable needs to be set in the ebuild and contains a space-separated 290# This variable needs to be set in the ebuild and contains a space-separated
295# list of tokens each mapping a module to a runtime define which can be 291# list of tokens each mapping a module to a runtime define which can be
296# specified in APACHE2_OPTS in /etc/conf.d/apache2 to enable this particular 292# specified in APACHE2_OPTS in /etc/conf.d/apache2 to enable this particular
297# module. 293# module.
… …
299# @FUNCTION: generate_load_module 295# @FUNCTION: generate_load_module
300# @DESCRIPTION: 296# @DESCRIPTION:
301# This internal function generates the LoadModule lines for httpd.conf based on 297# This internal function generates the LoadModule lines for httpd.conf based on
302# the current module selection and MODULE_DEFINES 298# the current module selection and MODULE_DEFINES
303generate_load_module() { 299generate_load_module() {
304 local endit=0 mod_lines= mod_dir="${D}${APACHE2_MODULESDIR}" 300 local endit=0 mod_lines= mod_dir="${D}/usr/$(get_libdir)/apache2/modules"
305 301
306 if use static; then 302 if use static; then
307 sed -i -e "/%%LOAD_MODULE%%/d" \ 303 sed -i -e "/%%LOAD_MODULE%%/d" \
308 "${GENTOO_PATCHDIR}"/conf/httpd.conf 304 "${GENTOO_PATCHDIR}"/conf/httpd.conf
309 return 305 return
… …
361# creates the apache user and group and informs about CONFIG_SYSVIPC being 357# creates the apache user and group and informs about CONFIG_SYSVIPC being
362# needed (we don't depend on kernel sources and therefore cannot check). 358# needed (we don't depend on kernel sources and therefore cannot check).
363apache-2_pkg_setup() { 359apache-2_pkg_setup() {
364 check_upgrade 360 check_upgrade
365 361
366 setup_mpm
367 setup_modules
368
369 if use debug; then
370 MY_CONF="${MY_CONF} --enable-maintainer-mode --enable-exception-hook"
371 fi
372
373 # setup apache user and group 362 # setup apache user and group
374 enewgroup apache 81 363 enewgroup apache 81
375 enewuser apache 81 -1 /var/www apache 364 enewuser apache 81 -1 /var/www apache
376 365
366 setup_mpm
367 setup_modules
368
369 if use debug; then
370 MY_CONF="${MY_CONF} --enable-maintainer-mode --enable-exception-hook"
371 fi
372
377 elog "Please note that you need SysV IPC support in your kernel." 373 elog "Please note that you need SysV IPC support in your kernel."
378 elog "Make sure CONFIG_SYSVIPC=y is set." 374 elog "Make sure CONFIG_SYSVIPC=y is set."
379 elog 375 elog
376
377 if use userland_BSD; then
378 elog "On BSD systems you need to add the following line to /boot/loader.conf:"
379 elog " accf_http_load=\"YES\""
380 elog
381 fi
380} 382}
381 383
382# @FUNCTION: apache-2_src_unpack 384# @FUNCTION: apache-2_src_unpack
383# @DESCRIPTION: 385# @DESCRIPTION:
384# This function applies patches, configures a custom file-system layout and 386# This function applies patches, configures a custom file-system layout and
… …
429 --libexecdir=/usr/$(get_libdir)/apache2/modules \ 431 --libexecdir=/usr/$(get_libdir)/apache2/modules \
430 --datadir=/var/www/localhost \ 432 --datadir=/var/www/localhost \
431 --sysconfdir=/etc/apache2 \ 433 --sysconfdir=/etc/apache2 \
432 --localstatedir=/var \ 434 --localstatedir=/var \
433 --with-mpm=${MY_MPM} \ 435 --with-mpm=${MY_MPM} \
434 --with-perl=/usr/bin/perl \
435 --with-apr=/usr \ 436 --with-apr=/usr \
436 --with-apr-util=/usr \ 437 --with-apr-util=/usr \
437 --with-pcre=/usr \ 438 --with-pcre=/usr \
438 --with-z=/usr \ 439 --with-z=/usr \
439 --with-port=80 \ 440 --with-port=80 \
… …
446 emake || die "emake failed" 447 emake || die "emake failed"
447} 448}
448 449
449# @FUNCTION: apache-2_src_install 450# @FUNCTION: apache-2_src_install
450# @DESCRIPTION: 451# @DESCRIPTION:
451# This function runs emake install and generates, install and adapts the gentoo 452# This function runs `emake install' and generates, installs and adapts the gentoo
452# specific configuration files found in the tarball 453# specific configuration files found in the tarball
453apache-2_src_install() { 454apache-2_src_install() {
454 emake DESTDIR="${D}" install || die "emake install failed" 455 make DESTDIR="${D}" install || die "make install failed"
455 456
456 # install our configuration files 457 # install our configuration files
457 keepdir /etc/apache2/vhosts.d 458 keepdir /etc/apache2/vhosts.d
458 keepdir /etc/apache2/modules.d 459 keepdir /etc/apache2/modules.d
459 460
… …
478 newinitd "${GENTOO_PATCHDIR}"/init/apache2.initd apache2 479 newinitd "${GENTOO_PATCHDIR}"/init/apache2.initd apache2
479 480
480 # link apache2ctl to the init script 481 # link apache2ctl to the init script
481 dosym /etc/init.d/apache2 /usr/sbin/apache2ctl 482 dosym /etc/init.d/apache2 /usr/sbin/apache2ctl
482 483
483 # provide symlinks for all the stuff we no longer rename, bug 177697 484 # provide legacy symlink for apxs, bug 177697
484 for i in suexec apxs; do
485 dosym /usr/sbin/${i} /usr/sbin/${i}2 485 dosym /usr/sbin/apxs /usr/sbin/apxs2
486 done
487 486
488 # install some thirdparty scripts 487 # install some thirdparty scripts
489 exeinto /usr/sbin 488 exeinto /usr/sbin
490 use ssl && doexe "${GENTOO_PATCHDIR}"/scripts/gentestcrt.sh 489 use ssl && doexe "${GENTOO_PATCHDIR}"/scripts/gentestcrt.sh
491 490
… …
499 else 498 else
500 rm -f "${D}/etc/apache2/modules.d/00_apache_manual.conf" 499 rm -f "${D}/etc/apache2/modules.d/00_apache_manual.conf"
501 rm -Rf "${D}/usr/share/doc/${PF}/manual" 500 rm -Rf "${D}/usr/share/doc/${PF}/manual"
502 fi 501 fi
503 502
504 # the default webroot gets stored in /usr/share/doc 503 # the default webroot gets stored in /usr/share/${PF}/webroot
505 ebegin "Installing default webroot to /usr/share/doc/${PF}" 504 ebegin "Installing default webroot to /usr/share/${PF}/webroot"
505 dodir /usr/share/${PF}
506 mv -f "${D}/var/www/localhost" "${D}/usr/share/doc/${PF}/webroot" 506 mv -f "${D}/var/www/localhost" "${D}/usr/share/${PF}/webroot"
507 eend $? 507 eend $?
508 keepdir /var/www/localhost/htdocs
509 508
510 # set some sane permissions for suexec 509 # set some sane permissions for suexec
511 if use suexec ; then 510 if use suexec ; then
512 fowners 0:apache /usr/sbin/suexec 511 fowners 0:apache /usr/sbin/suexec
513 fperms 4710 /usr/sbin/suexec 512 fperms 4710 /usr/sbin/suexec
513 # provide legacy symlink for suexec, bug 177697
514 dosym /usr/sbin/suexec /usr/sbin/suexec2
514 fi 515 fi
515 516
516 # empty dirs 517 # empty dirs
517 for i in /var/lib/dav /var/log/apache2 /var/cache/apache2 ; do 518 for i in /var/lib/dav /var/log/apache2 /var/cache/apache2 ; do
518 keepdir ${i} 519 keepdir ${i}
… …
525} 526}
526 527
527# @FUNCTION: apache-2_pkg_postinst 528# @FUNCTION: apache-2_pkg_postinst
528# @DESCRIPTION: 529# @DESCRIPTION:
529# This function creates test certificates if SSL is enabled and installs the 530# This function creates test certificates if SSL is enabled and installs the
530# default webroot if /var/www/localhost does not exist. We do this here because 531# default webroot to /var/www/localhost if it does not exist. We do this here
531# the default webroot is a copy of the files that exist elsewhere and we don't 532# because the default webroot is a copy of the files that exist elsewhere and we
532# want them to be managed/removed by portage when apache is upgraded. 533# don't want them to be managed/removed by portage when apache is upgraded.
533apache-2_pkg_postinst() { 534apache-2_pkg_postinst() {
535 einfo
536
534 if use ssl && [[ ! -e "${ROOT}/etc/apache2/ssl/server.crt" ]] ; then 537 if use ssl && [[ ! -e "${ROOT}/etc/apache2/ssl/server.crt" ]] ; then
535 cd "${ROOT}"/etc/apache2/ssl 538 cd "${ROOT}"/etc/apache2/ssl
536 einfo
537 einfo "Generating self-signed test certificate in ${ROOT}etc/apache2/ssl ..." 539 einfo "Generating self-signed test certificate in ${ROOT}etc/apache2/ssl ..."
538 yes "" 2>/dev/null | \ 540 yes "" 2>/dev/null | \
539 "${ROOT}"/usr/sbin/gentestcrt.sh >/dev/null 2>&1 || \ 541 "${ROOT}"/usr/sbin/gentestcrt.sh >/dev/null 2>&1 || \
540 die "gentestcrt.sh failed" 542 die "gentestcrt.sh failed"
541 einfo 543 einfo
… …
550 elog "emerge --config =${PF}" 552 elog "emerge --config =${PF}"
551 elog 553 elog
552 else 554 else
553 einfo "Installing default webroot to ${ROOT}var/www/localhost" 555 einfo "Installing default webroot to ${ROOT}var/www/localhost"
554 mkdir -p "${ROOT}"/var/www/localhost 556 mkdir -p "${ROOT}"/var/www/localhost
555 cp -R "${ROOT}"/usr/share/doc/${PF}/webroot/* "${ROOT}"/var/www/localhost 557 cp -R "${ROOT}"/usr/share/${PF}/webroot/* "${ROOT}"/var/www/localhost/
556 chown -R apache:0 "${ROOT}"/var/www/localhost 558 einfo
557 fi 559 fi
558} 560}
559 561
560# @FUNCTION: apache-2_pkg_config 562# @FUNCTION: apache-2_pkg_config
561# @DESCRIPTION: 563# @DESCRIPTION:
562# This function installs -- and removes a previously existing -- default webroot 564# This function installs -- and overwrites -- the default webroot to
563# to /var/www/localhost 565# /var/www/localhost
564apache-2_pkg_config() { 566apache-2_pkg_config() {
565 einfo "Installing default webroot to ${ROOT}var/www/localhost" 567 einfo "Installing default webroot to ${ROOT}var/www/localhost"
566 mkdir "${ROOT}"var{,/www{,/localhost}} 568 mkdir -p "${ROOT}"/var/www/localhost
567 cp -R "${ROOT}"usr/share/doc/${PF}/webroot/* "${ROOT}"var/www/localhost/ 569 cp -R "${ROOT}"/usr/share/${PF}/webroot/* "${ROOT}"/var/www/localhost/
568} 570}
569 571
570EXPORT_FUNCTIONS pkg_setup src_unpack src_compile src_install pkg_postinst pkg_config 572EXPORT_FUNCTIONS pkg_setup src_unpack src_compile src_install pkg_postinst pkg_config
Legend:
Removed from v.1.3  
changed lines
  Added in v.1.12
  ViewVC Help
Powered by ViewVC 1.1.17