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

Diff of /eclass/depend.apache.eclass

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

Revision 1.16 Revision 1.36
1# Copyright 2004-2005 Gentoo Foundation 1# Copyright 1999-2007 Gentoo Foundation
2# Distributed under the terms of the GNU General Public License, v2 or later 2# Distributed under the terms of the GNU General Public License v2
3# $Header: /var/cvsroot/gentoo-x86/eclass/depend.apache.eclass,v 1.16 2005/07/06 20:20:03 agriffis Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/depend.apache.eclass,v 1.36 2008/02/02 12:53:52 hollow Exp $
4INHERITED="$INHERITED $ECLASS"
5 4
6###### 5# @ECLASS: depend.apache.eclass
7## Apache Common Variables 6# @MAINTAINER: apache-devs@gentoo.org
8## 7# @BLURB: Functions to allow ebuilds to depend on apache
9## These are internal variables used by this, and other apache-related eclasses, 8# @DESCRIPTION:
10## and thus should not need to be used by the ebuilds themselves (the ebuilds 9# This eclass handles depending on apache in a sane way and providing
11## should know what version of Apache they are building against). 10# information about where certain interfaces are located.
12###### 11#
12# @NOTE: If you use this, be sure you use the need_* call after you have defined
13# DEPEND and RDEPEND. Also note that you can not rely on the automatic
14# RDEPEND=DEPEND that portage does if you use this eclass.
15#
16# See bug 107127 for more information.
13 17
14#### 18inherit multilib
15## APACHE_VERSION
16##
17## Stores the version of apache we are going to be ebuilding. This variable is
18## set by the need_apache{|1|2} functions.
19##
20## This needs to stay as '1' until apache2 is on by default -- although it
21## doesn't matter much as it's set by the need_apache functions.
22####
23APACHE_VERSION='1'
24 19
25#### 20# ==============================================================================
26## APXS1, APXS2 21# INTERNAL VARIABLES
27## 22# ==============================================================================
28## Paths to the apxs tools
29####
30APXS1="/usr/sbin/apxs"
31APXS2="/usr/sbin/apxs2"
32 23
33#### 24# @ECLASS-VARIABLE: APACHE_VERSION
34## APACHECTL1, APACHECTL2 25# @DESCRIPTION:
35## 26# Stores the version of apache we are going to be ebuilding. This variable is
36## Paths to the apachectl tools 27# set by the need_apache functions.
37####
38APACHECTL1="/usr/sbin/apachectl"
39APACHECTL2="/usr/sbin/apache2ctl"
40 28
41#### 29# @ECLASS-VARIABLE: APXS
42## APACHE1_BASEDIR, APACHE2_BASEDIR 30# @DESCRIPTION:
43## 31# Paths to the apxs tool
44## Paths to the server root directories
45####
46APACHE1_BASEDIR="/usr/lib/apache"
47APACHE2_BASEDIR="/usr/lib/apache2"
48 32
49#### 33# @ECLASS-VARIABLE: APACHECTL
50## APACHE1_CONFDIR, APACHE2_CONFDIR 34# @DESCRIPTION:
51## 35# Path to the apachectl tool
52## Paths to the configuration file directories (usually under
53## $APACHE?_BASEDIR/conf)
54####
55APACHE1_CONFDIR="/etc/apache"
56APACHE2_CONFDIR="/etc/apache2"
57 36
58#### 37# @ECLASS-VARIABLE: APACHE_BASEDIR
59## APACHE1_MODULES_CONFDIR, APACHE2_MODULES_CONFDIR 38# @DESCRIPTION:
60## 39# Path to the server root directory
61## Paths where module configuration files are kept
62####
63APACHE1_MODULES_CONFDIR="${APACHE1_CONFDIR}/modules.d"
64APACHE2_MODULES_CONFDIR="${APACHE2_CONFDIR}/modules.d"
65 40
66#### 41# @ECLASS-VARIABLE: APACHE_CONFDIR
67## APACHE1_MODULES_VHOSTDIR, APACHE2_MODULES_VHOSTDIR 42# @DESCRIPTION:
68## 43# Path to the configuration file directory
69## Paths where virtual host configuration files are kept
70####
71APACHE1_VHOSTDIR="${APACHE1_CONFDIR}/vhosts.d"
72APACHE2_VHOSTDIR="${APACHE2_CONFDIR}/vhosts.d"
73 44
74#### 45# @ECLASS-VARIABLE: APACHE_MODULES_CONFDIR
75## APACHE1_MODULESDIR, APACHE2_MODULESDIR 46# @DESCRIPTION:
76## 47# Path where module configuration files are kept
77## Paths where we install modules
78####
79APACHE1_MODULESDIR="${APACHE1_BASEDIR}/modules"
80APACHE2_MODULESDIR="${APACHE2_BASEDIR}/modules"
81 48
82#### 49# @ECLASS-VARIABLE: APACHE_VHOSTS_CONFDIR
83## APACHE1_DEPEND, APACHE2_DEPEND 50# @DESCRIPTION:
84## 51# Path where virtual host configuration files are kept
85## Dependencies for apache 1.x and apache 2.x
86## - apache2 must be at least version 2.0.52-r3, this is lowest version
87## containing our new overall changes -- trapni (Jan 21 2005)
88## - apache1 must be at least version 1.3.33-r1, but how to
89## define the DEPEND here? (FIXME) -- trapni (Jan 21 2005)
90## - currently not possible - bug #4315 -- vericgar (Jan 21 2005)
91####
92APACHE1_DEPEND="=net-www/apache-1*"
93APACHE2_DEPEND=">=net-www/apache-2.0.54-r10"
94 52
53# @ECLASS-VARIABLE: APACHE_MODULESDIR
54# @DESCRIPTION:
55# Path where we install modules
95 56
96#### 57# @ECLASS-VARIABLE: APACHE2_DEPEND
97## APACHE_DEPEND 58# @DESCRIPTION:
98## 59# Dependencies for Apache 2.x
99## Dependency magic based on useflags to use the right DEPEND 60APACHE2_DEPEND="=www-servers/apache-2*"
100####
101 61
102APACHE_DEPEND="apache2? ( ${APACHE2_DEPEND} ) !apache2? ( ${APACHE1_DEPEND} )" 62# @ECLASS-VARIABLE: APACHE2_0_DEPEND
63# @DESCRIPTION:
64# Dependencies for Apache 2.0.x
65APACHE2_0_DEPEND="=www-servers/apache-2.0*"
103 66
104#### 67# @ECLASS-VARIABLE: APACHE2_2_DEPEND
105## need_apache1 68# @DESCRIPTION:
106## 69# Dependencies for Apache 2.2.x
107## An ebuild calls this to get the dependency information 70APACHE2_2_DEPEND="=www-servers/apache-2.2*"
108## for apache-1.x. An ebuild should use this in order for
109## future changes to the build infrastructure to happen
110## seamlessly. All an ebuild needs to do is include the
111## line need_apache1 somewhere.
112####
113need_apache1() {
114 debug-print-function need_apache1
115 71
116 DEPEND="${DEPEND} ${APACHE1_DEPEND}" 72# @ECLASS-VARIABLE: WANT_APACHE_DEPEND
117 RDEPEND="${RDEPEND} ${APACHE1_DEPEND}" 73# @DESCRIPTION:
74# Dependency magic based on useflag to use the right DEPEND
75WANT_APACHE_DEPEND="apache2? ( ${APACHE2_DEPEND} )"
76
77# ==============================================================================
78# INTERNAL FUNCTIONS
79# ==============================================================================
80
81# @FUNCTION: uses_apache2
82# @DESCRIPTION:
83# sets up all of the environment variables required for an apache2 module
84uses_apache2() {
85 debug-print-function $FUNCNAME $*
86
87 # WARNING: Do not use these variables with anything that is put
88 # into the dependency cache (DEPEND/RDEPEND/etc)
118 APACHE_VERSION='1' 89 APACHE_VERSION="2"
90 APXS="/usr/sbin/apxs2"
91 APACHECTL="/usr/sbin/apache2ctl"
92 APACHE_BASEDIR="/usr/$(get_libdir)/apache2"
93 APACHE_CONFDIR="/etc/apache2"
94 APACHE_MODULES_CONFDIR="${APACHE_CONFDIR}/modules.d"
95 APACHE_VHOSTS_CONFDIR="${APACHE_CONFDIR}/vhosts.d"
96 APACHE_MODULESDIR="${APACHE_BASEDIR}/modules"
119} 97}
120 98
121#### 99# @FUNCTION: doesnt_use_apache
122## need_apache2 100# @DESCRIPTION:
123## 101# sets up all of the environment variables required for optional apache usage
102doesnt_use_apache() {
103 debug-print-function $FUNCNAME $*
104
105 APACHE_VERSION="0"
106 USE_APACHE="0"
107}
108
109# ==============================================================================
110# PUBLIC FUNCTIONS
111# ==============================================================================
112
113# @FUNCTION: want_apache
114# @DESCRIPTION:
115# An ebuild calls this to get the dependency information for optional apache-2.x
116# support.
117want_apache() {
118 debug-print-function $FUNCNAME $*
119
120 IUSE="${IUSE} apache2"
121 DEPEND="${DEPEND} ${WANT_APACHE_DEPEND}"
122 RDEPEND="${RDEPEND} ${WANT_APACHE_DEPEND}"
123
124 if use apache2 ; then
125 uses_apache2
126 else
127 doesnt_use_apache
128 fi
129}
130
131# @FUNCTION: need_apache2
132# @DESCRIPTION:
124## An ebuild calls this to get the dependency information 133# An ebuild calls this to get the dependency information for apache-2.x. An
125## for apache-2.x. An ebuild should use this in order for 134# ebuild should use this in order for future changes to the build infrastructure
126## future changes to the build infrastructure to happen
127## seamlessly. All an ebuild needs to do is include the 135# to happen seamlessly. All an ebuild needs to do is include the line
128## line need_apache1 somewhere. 136# need_apache2 somewhere.
129####
130need_apache2() { 137need_apache2() {
131 debug-print-function need_apache2 138 debug-print-function $FUNCNAME $*
132 139
133 DEPEND="${DEPEND} ${APACHE2_DEPEND}" 140 DEPEND="${DEPEND} ${APACHE2_DEPEND}"
134 RDEPEND="${RDEPEND} ${APACHE2_DEPEND}" 141 RDEPEND="${RDEPEND} ${APACHE2_DEPEND}"
135 APACHE_VERSION='2' 142 uses_apache2
136} 143}
137 144
138#### 145# @FUNCTION: need_apache2_0
139## DO NOT CHANGE THIS FUNCTION UNLESS YOU UNDERSTAND THE CONSEQUENCES IT 146# @DESCRIPTION:
140## WILL HAVE ON THE CACHE! There MUST be a apache2? () block in DEPEND for 147# Works like need_apache2 above, but its used by modules that only support
141## things to work correct in the dependency calculation stage. 148# apache 2.0 and do not work with higher versions.
142#### 149need_apache2_0() {
150 debug-print-function $FUNCNAME $*
151
152 DEPEND="${DEPEND} ${APACHE2_0_DEPEND}"
153 RDEPEND="${RDEPEND} ${APACHE2_0_DEPEND}"
154 uses_apache2
155}
156
157# @FUNCTION: need_apache2_2
158# @DESCRIPTION:
159# Works like need_apache2 above, but its used by modules that only support
160# apache 2.2 and do not work with lower versions.
161need_apache2_2() {
162 debug-print-function $FUNCNAME $*
163
164 DEPEND="${DEPEND} ${APACHE2_2_DEPEND}"
165 RDEPEND="${RDEPEND} ${APACHE2_2_DEPEND}"
166 uses_apache2
167}
168
169# @FUNCTION: need_apache
170# @DESCRIPTION:
171# Legacy alias for need_apache2
143need_apache() { 172need_apache() {
144 debug-print-function need_apache 173 need_apache2
145
146 IUSE="${IUSE} apache2"
147 DEPEND="${DEPEND} ${APACHE_DEPEND}"
148 RDEPEND="${RDEPEND} ${APACHE_DEPEND}"
149 if useq apache2; then
150 APACHE_VERSION='2'
151 USE_APACHE2=2
152 APXS="$APXS2"
153 APACHECTL="${APACHECTL2}"
154 APACHE_BASEDIR="${APACHE2_BASEDIR}"
155 APACHE_CONFDIR="${APACHE2_CONFDIR}"
156 APACHE_MODULES_CONFDIR="${APACHE2_MODULES_CONFDIR}"
157 APACHE_VHOSTSDIR="${APACHE2_VHOSTSDIR}"
158 APACHE_MODULESDIR="${APACHE2_MODULESDIR}"
159 else
160 APACHE_VERSION='1'
161 APXS="$APXS1"
162 USE_APACHE2=
163 APACHECTL="${APACHECTL1}"
164 APACHE_BASEDIR="${APACHE1_BASEDIR}"
165 APACHE_CONFDIR="${APACHE1_CONFDIR}"
166 APACHE_MODULES_CONFDIR="${APACHE1_MODULES_CONFDIR}"
167 APACHE_VHOSTSDIR="${APACHE1_VHOSTSDIR}"
168 APACHE_MODULESDIR="${APACHE1_MODULESDIR}"
169 fi
170} 174}
Legend:
Removed from v.1.16  
changed lines
  Added in v.1.36
  ViewVC Help
Powered by ViewVC 1.1.13