/[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.7 Revision 1.17
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.7 2008/01/19 10:59:08 hollow Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/apache-2.eclass,v 1.17 2009/07/05 16:05:25 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
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 name and version (including revision) of the package.
23# If you want to override this in an ebuild, use:
24# ORIG_PR="(revision of Gentoo stuff you want)"
25# GENTOO_PATCHNAME="gentoo-${PN}-${PV}${ORIG_PR:+-${ORIG_PR}}"
26[[ -n "$GENTOO_PATCHNAME" ]] || GENTOO_PATCHNAME="gentoo-${PF}"
23 27
24# @ECLASS-VARIABLE: GENTOO_PATCHDIR 28# @ECLASS-VARIABLE: GENTOO_PATCHDIR
25# @DESCRIPTION: 29# @DESCRIPTION:
26# This internal variable contains the working directory where patches and config 30# This internal variable contains the working directory where patches and config
27# files are located 31# files are located.
32# Defaults to the patchset name appended to the working directory.
28GENTOO_PATCHDIR="${WORKDIR}/${GENTOO_PATCHNAME}" 33[[ -n "$GENTOO_PATCHDIR" ]] || GENTOO_PATCHDIR="${WORKDIR}/${GENTOO_PATCHNAME}"
29 34
30# @ECLASS-VARIABLE: GENTOO_DEVELOPER 35# @VARIABLE: GENTOO_DEVELOPER
31# @DESCRIPTION: 36# @DESCRIPTION:
32# This variable needs to be set in the ebuild and contains the name of the 37# This variable needs to be set in the ebuild and contains the name of the
33# gentoo developer who created the patch tarball 38# gentoo developer who created the patch tarball
34 39
35# @ECLASS-VARIABLE: GENTOO_PATCHSTAMP 40# @VARIABLE: GENTOO_PATCHSTAMP
36# @DESCRIPTION: 41# @DESCRIPTION:
37# This variable needs to be set in the ebuild and contains the date the patch 42# This variable needs to be set in the ebuild and contains the date the patch
38# tarball was created at in YYYYMMDD format 43# tarball was created at in YYYYMMDD format
39 44
45# @VARIABLE: GENTOO_PATCH_A
46# @DESCRIPTION:
47# This variable should contain the entire filename of patch tarball.
48# Defaults to the name of the patchset, with a datestamp.
49[[ -n "$GENTOO_PATCH_A" ]] || GENTOO_PATCH_A="${GENTOO_PATCHNAME}-${GENTOO_PATCHSTAMP}.tar.bz2"
50
40SRC_URI="mirror://apache/httpd/httpd-${PV}.tar.bz2 51SRC_URI="mirror://apache/httpd/httpd-${PV}.tar.bz2
41 http://dev.gentoo.org/~${GENTOO_DEVELOPER}/dist/apache/${GENTOO_PATCHNAME}-${GENTOO_PATCHSTAMP}.tar.bz2" 52 http://dev.gentoo.org/~${GENTOO_DEVELOPER}/dist/apache/${GENTOO_PATCH_A}"
42 53
43# @ECLASS-VARIABLE: IUSE_MPMS_FORK 54# @VARIABLE: IUSE_MPMS_FORK
44# @DESCRIPTION: 55# @DESCRIPTION:
45# This variable needs to be set in the ebuild and contains a list of forking 56# This variable needs to be set in the ebuild and contains a list of forking
46# (i.e. non-threaded) MPMS 57# (i.e. non-threaded) MPMs
47 58
48# @ECLASS-VARIABLE: IUSE_MPMS_THREAD 59# @VARIABLE: IUSE_MPMS_THREAD
49# @DESCRIPTION: 60# @DESCRIPTION:
50# This variable needs to be set in the ebuild and contains a list of threaded 61# This variable needs to be set in the ebuild and contains a list of threaded
51# MPMS 62# MPMs
52 63
53# @ECLASS-VARIABLE: IUSE_MODULES 64# @VARIABLE: IUSE_MODULES
54# @DESCRIPTION: 65# @DESCRIPTION:
55# This variable needs to be set in the ebuild and contains a list of available 66# This variable needs to be set in the ebuild and contains a list of available
56# built-in modules 67# built-in modules
57 68
58IUSE_MPMS="${IUSE_MPMS_FORK} ${IUSE_MPMS_THREAD}" 69IUSE_MPMS="${IUSE_MPMS_FORK} ${IUSE_MPMS_THREAD}"
131 eerror "You have selected a non-threaded MPM but USE=threads is enabled" 142 eerror "You have selected a non-threaded MPM but USE=threads is enabled"
132 die "invalid use flag combination" 143 die "invalid use flag combination"
133 fi 144 fi
134} 145}
135 146
136# @ECLASS-VARIABLE: MODULE_CRITICAL 147# @VARIABLE: MODULE_CRITICAL
137# @DESCRIPTION: 148# @DESCRIPTION:
138# This variable needs to be set in the ebuild and contains a space-separated 149# 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 150# list of modules critical for the default apache. A user may still
140# disable these modules for custom minimal installation at their own risk. 151# disable these modules for custom minimal installation at their own risk.
141 152
162 ewarn 173 ewarn
163 ebeep 10 174 ebeep 10
164 fi 175 fi
165} 176}
166 177
167# @ECLASS-VARIABLE: MODULE_DEPENDS 178# @VARIABLE: MODULE_DEPENDS
168# @DESCRIPTION: 179# @DESCRIPTION:
169# This variable needs to be set in the ebuild and contains a space-separated 180# 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 181# list of dependency tokens each with a module and the module it depends on
171# separated by a colon 182# separated by a colon
172 183
192 die "invalid use flag combination" 203 die "invalid use flag combination"
193 fi 204 fi
194} 205}
195 206
196# @ECLASS-VARIABLE: MY_CONF 207# @ECLASS-VARIABLE: MY_CONF
197# DESCRIPTION: 208# @DESCRIPTION:
198# This internal variable contains the econf options for the current module 209# This internal variable contains the econf options for the current module
199# selection after a call to setup_modules() 210# selection after a call to setup_modules()
200 211
201# @ECLASS-VARIABLE: MY_MODS 212# @ECLASS-VARIABLE: MY_MODS
202# DESCRIPTION: 213# @DESCRIPTION:
203# This internal variable contains a sorted, space separated list of currently 214# This internal variable contains a sorted, space separated list of currently
204# selected modules after a call to setup_modules() 215# selected modules after a call to setup_modules()
205 216
206# @FUNCTION: setup_modules 217# @FUNCTION: setup_modules
207# @DESCRIPTION: 218# @DESCRIPTION:
217 fi 228 fi
218 229
219 MY_CONF="--enable-so=static" 230 MY_CONF="--enable-so=static"
220 231
221 if use ldap ; then 232 if use ldap ; then
222 if ! built_with_use 'dev-libs/apr-util' ldap ; then 233 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}" 234 MY_CONF="${MY_CONF} --enable-authnz_ldap=${mod_type} --enable-ldap=${mod_type}"
229 MY_MODS="${MY_MODS} ldap authnz_ldap" 235 MY_MODS="${MY_MODS} ldap authnz_ldap"
230 else 236 else
231 MY_CONF="${MY_CONF} --disable-authnz_ldap --disable-ldap" 237 MY_CONF="${MY_CONF} --disable-authnz_ldap --disable-ldap"
232 fi 238 fi
288 MY_MODS=$(echo ${MY_MODS} | tr ' ' '\n' | sort -u) 294 MY_MODS=$(echo ${MY_MODS} | tr ' ' '\n' | sort -u)
289 check_module_depends 295 check_module_depends
290 check_module_critical 296 check_module_critical
291} 297}
292 298
293# @ECLASS-VARIABLE: MODULE_DEFINES 299# @VARIABLE: MODULE_DEFINES
294# @DESCRIPTION: 300# @DESCRIPTION:
295# This variable needs to be set in the ebuild and contains a space-separated 301# 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 302# 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 303# specified in APACHE2_OPTS in /etc/conf.d/apache2 to enable this particular
298# module. 304# module.
300# @FUNCTION: generate_load_module 306# @FUNCTION: generate_load_module
301# @DESCRIPTION: 307# @DESCRIPTION:
302# This internal function generates the LoadModule lines for httpd.conf based on 308# This internal function generates the LoadModule lines for httpd.conf based on
303# the current module selection and MODULE_DEFINES 309# the current module selection and MODULE_DEFINES
304generate_load_module() { 310generate_load_module() {
305 local endit=0 mod_lines= mod_dir="${D}${APACHE2_MODULESDIR}" 311 local endit=0 mod_lines= mod_dir="${D}/usr/$(get_libdir)/apache2/modules"
306 312
307 if use static; then 313 if use static; then
308 sed -i -e "/%%LOAD_MODULE%%/d" \ 314 sed -i -e "/%%LOAD_MODULE%%/d" \
309 "${GENTOO_PATCHDIR}"/conf/httpd.conf 315 "${GENTOO_PATCHDIR}"/conf/httpd.conf
310 return 316 return
362# creates the apache user and group and informs about CONFIG_SYSVIPC being 368# 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). 369# needed (we don't depend on kernel sources and therefore cannot check).
364apache-2_pkg_setup() { 370apache-2_pkg_setup() {
365 check_upgrade 371 check_upgrade
366 372
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 373 # setup apache user and group
375 enewgroup apache 81 374 enewgroup apache 81
376 enewuser apache 81 -1 /var/www apache 375 enewuser apache 81 -1 /var/www apache
377 376
377 setup_mpm
378 setup_modules
379
380 if use debug; then
381 MY_CONF="${MY_CONF} --enable-maintainer-mode --enable-exception-hook"
382 fi
383
378 elog "Please note that you need SysV IPC support in your kernel." 384 elog "Please note that you need SysV IPC support in your kernel."
379 elog "Make sure CONFIG_SYSVIPC=y is set." 385 elog "Make sure CONFIG_SYSVIPC=y is set."
380 elog 386 elog
387
388 if use userland_BSD; then
389 elog "On BSD systems you need to add the following line to /boot/loader.conf:"
390 elog " accf_http_load=\"YES\""
391 elog
392 fi
381} 393}
382 394
383# @FUNCTION: apache-2_src_unpack 395# @FUNCTION: apache-2_src_unpack
384# @DESCRIPTION: 396# @DESCRIPTION:
385# This function applies patches, configures a custom file-system layout and 397# This function applies patches, configures a custom file-system layout and
386# rebuilds the configure scripts. 398# rebuilds the configure scripts.
387apache-2_src_unpack() { 399apache-2_src_unpack() {
388 unpack ${A} 400 unpack ${A}
389 cd "${S}" 401 cd "${S}"
390 402
403 # 03_all_gentoo-apache-tools.patch injects -Wl,-z,now, which is not a good
404 # idea for everyone
405 case ${CHOST} in
406 *-linux-gnu|*-solaris*|*-freebsd*)
407 # do nothing, these use GNU binutils
408 :
409 ;;
410 *-darwin*)
411 sed -i -e 's/-Wl,-z,now/-Wl,-bind_at_load/g' \
412 "${GENTOO_PATCHDIR}"/patches/03_all_gentoo_apache-tools.patch
413 ;;
414 *)
415 # patch it out to be like upstream
416 sed -i -e 's/-Wl,-z,now//g' \
417 "${GENTOO_PATCHDIR}"/patches/03_all_gentoo_apache-tools.patch
418 ;;
419 esac
420
391 # Use correct multilib libdir in gentoo patches 421 # Use correct multilib libdir in gentoo patches
392 sed -i -e "s:/usr/lib:/usr/$(get_libdir):g" \ 422 sed -i -e "s:/usr/lib:/usr/$(get_libdir):g" \
393 "${GENTOO_PATCHDIR}"/{conf/httpd.conf,init/*,patches/config.layout} \ 423 "${GENTOO_PATCHDIR}"/{conf/httpd.conf,init/*,patches/config.layout} \
394 || die "libdir sed failed" 424 || die "libdir sed failed"
395 425
414# This function adds compiler flags and runs econf and emake based on MY_MPM and 444# This function adds compiler flags and runs econf and emake based on MY_MPM and
415# MY_CONF 445# MY_CONF
416apache-2_src_compile() { 446apache-2_src_compile() {
417 # Instead of filtering --as-needed (bug #128505), append --no-as-needed 447 # Instead of filtering --as-needed (bug #128505), append --no-as-needed
418 # Thanks to Harald van Dijk 448 # Thanks to Harald van Dijk
449 # ... but only on platforms that use a GNU linker!
450 case ${CHOST} in
451 *-solaris* | *-*bsd* | *-linux-gnu)
419 append-ldflags -Wl,--no-as-needed 452 append-ldflags -Wl,--no-as-needed
453 ;;
454 esac
420 455
421 # peruser MPM debugging with -X is nearly impossible 456 # peruser MPM debugging with -X is nearly impossible
422 if has peruser ${IUSE_MPMS} && use apache2_mpms_peruser ; then 457 if has peruser ${IUSE_MPMS} && use apache2_mpms_peruser ; then
423 use debug && append-flags -DMPM_PERUSER_DEBUG 458 use debug && append-flags -DMPM_PERUSER_DEBUG
424 fi 459 fi
430 --libexecdir=/usr/$(get_libdir)/apache2/modules \ 465 --libexecdir=/usr/$(get_libdir)/apache2/modules \
431 --datadir=/var/www/localhost \ 466 --datadir=/var/www/localhost \
432 --sysconfdir=/etc/apache2 \ 467 --sysconfdir=/etc/apache2 \
433 --localstatedir=/var \ 468 --localstatedir=/var \
434 --with-mpm=${MY_MPM} \ 469 --with-mpm=${MY_MPM} \
435 --with-perl=/usr/bin/perl \
436 --with-apr=/usr \ 470 --with-apr=/usr \
437 --with-apr-util=/usr \ 471 --with-apr-util=/usr \
438 --with-pcre=/usr \ 472 --with-pcre=/usr \
439 --with-z=/usr \ 473 --with-z=/usr \
440 --with-port=80 \ 474 --with-port=80 \
447 emake || die "emake failed" 481 emake || die "emake failed"
448} 482}
449 483
450# @FUNCTION: apache-2_src_install 484# @FUNCTION: apache-2_src_install
451# @DESCRIPTION: 485# @DESCRIPTION:
452# This function runs emake install and generates, installs and adapts the gentoo 486# This function runs `emake install' and generates, installs and adapts the gentoo
453# specific configuration files found in the tarball 487# specific configuration files found in the tarball
454apache-2_src_install() { 488apache-2_src_install() {
455 make DESTDIR="${D}" install || die "make install failed" 489 make DESTDIR="${D}" install || die "make install failed"
456 490
457 # install our configuration files 491 # install our configuration files
476 "${GENTOO_PATCHDIR}"/init/apache2.confd || die "sed failed" 510 "${GENTOO_PATCHDIR}"/init/apache2.confd || die "sed failed"
477 511
478 newconfd "${GENTOO_PATCHDIR}"/init/apache2.confd apache2 512 newconfd "${GENTOO_PATCHDIR}"/init/apache2.confd apache2
479 newinitd "${GENTOO_PATCHDIR}"/init/apache2.initd apache2 513 newinitd "${GENTOO_PATCHDIR}"/init/apache2.initd apache2
480 514
481 # link apache2ctl to the init script 515 # install apache2ctl wrapper for our init script if available
516 if test -e "${GENTOO_PATCHDIR}"/scripts/apache2ctl; then
517 exeinto /usr/sbin
518 doexe "${GENTOO_PATCHDIR}"/scripts/apache2ctl
519 else
482 dosym /etc/init.d/apache2 /usr/sbin/apache2ctl 520 dosym /etc/init.d/apache2 /usr/sbin/apache2ctl
521 fi
483 522
484 # provide legacy symlink for apxs, bug 177697 523 # provide legacy symlink for apxs, bug 177697
485 dosym /usr/sbin/apxs /usr/sbin/apxs2 524 dosym /usr/sbin/apxs /usr/sbin/apxs2
486 525
487 # install some thirdparty scripts 526 # install some thirdparty scripts
498 else 537 else
499 rm -f "${D}/etc/apache2/modules.d/00_apache_manual.conf" 538 rm -f "${D}/etc/apache2/modules.d/00_apache_manual.conf"
500 rm -Rf "${D}/usr/share/doc/${PF}/manual" 539 rm -Rf "${D}/usr/share/doc/${PF}/manual"
501 fi 540 fi
502 541
503 # the default webroot gets stored in /usr/share/doc 542 # the default webroot gets stored in /usr/share/${PF}/webroot
504 ebegin "Installing default webroot to /usr/share/doc/${PF}" 543 ebegin "Installing default webroot to /usr/share/${PF}/webroot"
544 dodir /usr/share/${PF}
505 mv -f "${D}/var/www/localhost" "${D}/usr/share/doc/${PF}/webroot" 545 mv -f "${D}/var/www/localhost" "${D}/usr/share/${PF}/webroot"
506 eend $? 546 eend $?
507 keepdir /var/www/localhost/htdocs
508 547
509 # set some sane permissions for suexec 548 # set some sane permissions for suexec
510 if use suexec ; then 549 if use suexec ; then
511 fowners 0:apache /usr/sbin/suexec 550 fowners 0:${SUEXEC_CALLER:-apache} /usr/sbin/suexec
512 fperms 4710 /usr/sbin/suexec 551 fperms 4710 /usr/sbin/suexec
513 # provide legacy symlink for suexec, bug 177697 552 # provide legacy symlink for suexec, bug 177697
514 dosym /usr/sbin/suexec /usr/sbin/suexec2 553 dosym /usr/sbin/suexec /usr/sbin/suexec2
515 fi 554 fi
516 555
526} 565}
527 566
528# @FUNCTION: apache-2_pkg_postinst 567# @FUNCTION: apache-2_pkg_postinst
529# @DESCRIPTION: 568# @DESCRIPTION:
530# This function creates test certificates if SSL is enabled and installs the 569# 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 570# 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 571# 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. 572# don't want them to be managed/removed by portage when apache is upgraded.
534apache-2_pkg_postinst() { 573apache-2_pkg_postinst() {
574 einfo
575
535 if use ssl && [[ ! -e "${ROOT}/etc/apache2/ssl/server.crt" ]] ; then 576 if use ssl && [[ ! -e "${ROOT}/etc/apache2/ssl/server.crt" ]] ; then
536 cd "${ROOT}"/etc/apache2/ssl 577 cd "${ROOT}"/etc/apache2/ssl
537 einfo
538 einfo "Generating self-signed test certificate in ${ROOT}etc/apache2/ssl ..." 578 einfo "Generating self-signed test certificate in ${ROOT}etc/apache2/ssl ..."
539 yes "" 2>/dev/null | \ 579 yes "" 2>/dev/null | \
540 "${ROOT}"/usr/sbin/gentestcrt.sh >/dev/null 2>&1 || \ 580 "${ROOT}"/usr/sbin/gentestcrt.sh >/dev/null 2>&1 || \
541 die "gentestcrt.sh failed" 581 die "gentestcrt.sh failed"
542 einfo 582 einfo
551 elog "emerge --config =${PF}" 591 elog "emerge --config =${PF}"
552 elog 592 elog
553 else 593 else
554 einfo "Installing default webroot to ${ROOT}var/www/localhost" 594 einfo "Installing default webroot to ${ROOT}var/www/localhost"
555 mkdir -p "${ROOT}"/var/www/localhost 595 mkdir -p "${ROOT}"/var/www/localhost
556 cp -R "${ROOT}"/usr/share/doc/${PF}/webroot/* "${ROOT}"/var/www/localhost 596 cp -R "${ROOT}"/usr/share/${PF}/webroot/* "${ROOT}"/var/www/localhost/
557 chown -R apache:0 "${ROOT}"/var/www/localhost 597 einfo
558 fi 598 fi
559} 599}
560 600
561# @FUNCTION: apache-2_pkg_config 601# @FUNCTION: apache-2_pkg_config
562# @DESCRIPTION: 602# @DESCRIPTION:
563# This function installs -- and removes a previously existing -- default webroot 603# This function installs -- and overwrites -- the default webroot to
564# to /var/www/localhost 604# /var/www/localhost
565apache-2_pkg_config() { 605apache-2_pkg_config() {
566 einfo "Installing default webroot to ${ROOT}var/www/localhost" 606 einfo "Installing default webroot to ${ROOT}var/www/localhost"
567 mkdir "${ROOT}"var{,/www{,/localhost}} 607 mkdir -p "${ROOT}"/var/www/localhost
568 cp -R "${ROOT}"usr/share/doc/${PF}/webroot/* "${ROOT}"var/www/localhost/ 608 cp -R "${ROOT}"/usr/share/${PF}/webroot/* "${ROOT}"/var/www/localhost/
569} 609}
570 610
571EXPORT_FUNCTIONS pkg_setup src_unpack src_compile src_install pkg_postinst pkg_config 611EXPORT_FUNCTIONS pkg_setup src_unpack src_compile src_install pkg_postinst pkg_config

Legend:
Removed from v.1.7  
changed lines
  Added in v.1.17

  ViewVC Help
Powered by ViewVC 1.1.20