/[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.26 Revision 1.42
1# Copyright 1999-2005 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/depend.apache.eclass,v 1.26 2006/06/10 16:19:54 swegener Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/depend.apache.eclass,v 1.42 2008/02/06 21:20:41 hollow Exp $
4
5# @ECLASS: depend.apache.eclass
6# @MAINTAINER: apache-devs@gentoo.org
7# @BLURB: Functions to allow ebuilds to depend on apache
8# @DESCRIPTION:
9# This eclass handles depending on apache in a sane way and provides information
10# about where certain binaries and configuration files are located.
11#
12# To make use of this eclass simply call one of the need/want_apache functions
13# described below. Make sure you use the need/want_apache call after you have
14# defined DEPEND and RDEPEND. Also note that you can not rely on the automatic
15# RDEPEND=DEPEND that portage does if you use this eclass.
16#
17# See Bug 107127 for more information.
18#
19# @EXAMPLE:
20#
21# Here is an example of an ebuild depending on apache:
22#
23# @CODE
24# DEPEND="virtual/Perl-CGI"
25# RDEPEND="${DEPEND}"
26# need_apache2
27# @CODE
28#
29# Another example which demonstrates non-standard IUSE options for optional
30# apache support:
31#
32# @CODE
33# DEPEND="server? ( virtual/Perl-CGI )"
34# RDEPEND="${DEPEND}"
35# want_apache2 server
36# @CODE
4 37
5inherit multilib 38inherit multilib
6 39
7# This eclass handles depending on apache in a sane way and providing 40# ==============================================================================
8# information about where certain interfaces are located. 41# INTERNAL VARIABLES
42# ==============================================================================
9 43
10# NOTE: If you use this, be sure you use the need_* call after you have 44# @ECLASS-VARIABLE: APACHE_VERSION
11# defined DEPEND and RDEPEND. Also note that you can not rely on the 45# @DESCRIPTION:
12# automatic RDEPEND=DEPEND that portage does if you use this eclass.
13# See bug 107127 for more information.
14
15######
16## Apache Common Variables
17##
18## These are internal variables used by this, and other apache-related eclasses,
19## and thus should not need to be used by the ebuilds themselves (the ebuilds
20## should know what version of Apache they are building against).
21######
22
23####
24## APACHE_VERSION
25##
26## Stores the version of apache we are going to be ebuilding. This variable is 46# Stores the version of apache we are going to be ebuilding.
27## set by the need_apache{|1|2} functions. 47# This variable is set by the want/need_apache functions.
28##
29## This needs to stay as '1' until apache2 is on by default -- although it
30## doesn't matter much as it's set by the need_apache functions.
31####
32APACHE_VERSION='1'
33 48
34#### 49# @ECLASS-VARIABLE: APXS
35## APXS1, APXS2 50# @DESCRIPTION:
36##
37## Paths to the apxs tools 51# Path to the apxs tool.
38#### 52# This variable is set by the want/need_apache functions.
39APXS1="/usr/sbin/apxs" 53
54# @ECLASS-VARIABLE: APACHE_BIN
55# @DESCRIPTION:
56# Path to the apache binary.
57# This variable is set by the want/need_apache functions.
58
59# @ECLASS-VARIABLE: APACHE_CTL
60# @DESCRIPTION:
61# Path to the apachectl tool.
62# This variable is set by the want/need_apache functions.
63
64# @ECLASS-VARIABLE: APACHE_BASEDIR
65# @DESCRIPTION:
66# Path to the server root directory.
67# This variable is set by the want/need_apache functions.
68
69# @ECLASS-VARIABLE: APACHE_CONFDIR
70# @DESCRIPTION:
71# Path to the configuration file directory.
72# This variable is set by the want/need_apache functions.
73
74# @ECLASS-VARIABLE: APACHE_MODULES_CONFDIR
75# @DESCRIPTION:
76# Path where module configuration files are kept.
77# This variable is set by the want/need_apache functions.
78
79# @ECLASS-VARIABLE: APACHE_VHOSTS_CONFDIR
80# @DESCRIPTION:
81# Path where virtual host configuration files are kept.
82# This variable is set by the want/need_apache functions.
83
84# @ECLASS-VARIABLE: APACHE_MODULESDIR
85# @DESCRIPTION:
86# Path where we install modules.
87# This variable is set by the want/need_apache functions.
88
89# @ECLASS-VARIABLE: APACHE_DEPEND
90# @DESCRIPTION:
91# Dependencies for Apache
92APACHE_DEPEND="www-servers/apache"
93
94# @ECLASS-VARIABLE: APACHE2_DEPEND
95# @DESCRIPTION:
96# Dependencies for Apache 2.x
97APACHE2_DEPEND="=www-servers/apache-2*"
98
99# @ECLASS-VARIABLE: APACHE2_2_DEPEND
100# @DESCRIPTION:
101# Dependencies for Apache 2.2.x
102APACHE2_2_DEPEND="=www-servers/apache-2.2*"
103
104# ==============================================================================
105# INTERNAL FUNCTIONS
106# ==============================================================================
107
108_init_apache2() {
109 debug-print-function $FUNCNAME $*
110
111 # WARNING: Do not use these variables with anything that is put
112 # into the dependency cache (DEPEND/RDEPEND/etc)
113 APACHE_VERSION="2"
40APXS2="/usr/sbin/apxs2" 114 APXS="/usr/sbin/apxs2"
41
42####
43## APACHECTL1, APACHECTL2
44##
45## Paths to the apachectl tools
46####
47APACHECTL1="/usr/sbin/apachectl" 115 APACHE_BIN="/usr/sbin/apache2"
48APACHECTL2="/usr/sbin/apache2ctl" 116 APACHE_CTL="/usr/sbin/apache2ctl"
49 117 APACHE_INCLUDEDIR="/usr/include/apache2"
50####
51## APACHE1_BASEDIR, APACHE2_BASEDIR
52##
53## Paths to the server root directories
54####
55APACHE1_BASEDIR="/usr/$(get_libdir)/apache"
56APACHE2_BASEDIR="/usr/$(get_libdir)/apache2" 118 APACHE_BASEDIR="/usr/$(get_libdir)/apache2"
57
58####
59## APACHE1_CONFDIR, APACHE2_CONFDIR
60##
61## Paths to the configuration file directories (usually under
62## $APACHE?_BASEDIR/conf)
63####
64APACHE1_CONFDIR="/etc/apache"
65APACHE2_CONFDIR="/etc/apache2" 119 APACHE_CONFDIR="/etc/apache2"
66
67####
68## APACHE1_MODULES_CONFDIR, APACHE2_MODULES_CONFDIR
69##
70## Paths where module configuration files are kept
71####
72APACHE1_MODULES_CONFDIR="${APACHE1_CONFDIR}/modules.d" 120 APACHE_MODULES_CONFDIR="${APACHE_CONFDIR}/modules.d"
73APACHE2_MODULES_CONFDIR="${APACHE2_CONFDIR}/modules.d"
74
75####
76## APACHE1_VHOSTDIR, APACHE2_VHOSTDIR
77##
78## Paths where virtual host configuration files are kept
79####
80APACHE1_VHOSTDIR="${APACHE1_CONFDIR}/vhosts.d" 121 APACHE_VHOSTS_CONFDIR="${APACHE_CONFDIR}/vhosts.d"
81APACHE2_VHOSTDIR="${APACHE2_CONFDIR}/vhosts.d"
82
83####
84## APACHE1_MODULESDIR, APACHE2_MODULESDIR
85##
86## Paths where we install modules
87####
88APACHE1_MODULESDIR="${APACHE1_BASEDIR}/modules" 122 APACHE_MODULESDIR="${APACHE_BASEDIR}/modules"
89APACHE2_MODULESDIR="${APACHE2_BASEDIR}/modules"
90
91####
92## APACHE1_DEPEND, APACHE2_DEPEND
93##
94## Dependencies for apache 1.x and apache 2.x
95## - apache2 must be at least version 2.0.54-r30, this is lowest version
96## containing our new overall changes -- trapni (Jan 21 2005)
97## - apache1 must be at least version 1.3.33-r10, but how to
98## define the DEPEND here? (FIXME) -- trapni (Jan 21 2005)
99## - currently not possible - bug #4315 -- vericgar (Jan 21 2005)
100####
101APACHE1_DEPEND="=net-www/apache-1*"
102APACHE2_DEPEND=">=net-www/apache-2.0.54-r30"
103
104####
105## APACHE_DEPEND
106##
107## Dependency magic based on useflags to use the right DEPEND
108####
109
110NEED_APACHE_DEPEND="apache2? ( ${APACHE2_DEPEND} ) !apache2? ( ${APACHE1_DEPEND} )"
111WANT_APACHE_DEPEND="apache2? ( ${APACHE2_DEPEND} ) !apache2? ( apache? ( ${APACHE1_DEPEND} ) )"
112
113####
114# uses_apache1()
115#
116# sets up all of the environment variables required by an apache1 module
117####
118
119uses_apache1() {
120 APACHE_VERSION='1'
121 APXS="$APXS1"
122 USE_APACHE2=
123 APACHECTL="${APACHECTL1}"
124 APACHE_BASEDIR="${APACHE1_BASEDIR}"
125 APACHE_CONFDIR="${APACHE1_CONFDIR}"
126 APACHE_MODULES_CONFDIR="${APACHE1_MODULES_CONFDIR}"
127 APACHE_VHOSTSDIR="${APACHE1_VHOSTSDIR}"
128 APACHE_MODULESDIR="${APACHE1_MODULESDIR}"
129} 123}
130 124
131#### 125_init_no_apache() {
132# uses_apache2() 126 debug-print-function $FUNCNAME $*
133#
134# sets up all of the environment variables required by an apache2 module
135####
136
137uses_apache2() {
138 APACHE_VERSION='2'
139 USE_APACHE2=2
140 APXS="$APXS2"
141 APACHECTL="${APACHECTL2}"
142 APACHE_BASEDIR="${APACHE2_BASEDIR}"
143 APACHE_CONFDIR="${APACHE2_CONFDIR}"
144 APACHE_MODULES_CONFDIR="${APACHE2_MODULES_CONFDIR}"
145 APACHE_VHOSTSDIR="${APACHE2_VHOSTSDIR}"
146 APACHE_MODULESDIR="${APACHE2_MODULESDIR}"
147}
148
149doesnt_use_apache() {
150 APACHE_VERSION='0' 127 APACHE_VERSION="0"
151 USE_APACHE=
152} 128}
153 129
154#### 130# ==============================================================================
155## need_apache1 131# PUBLIC FUNCTIONS
156## 132# ==============================================================================
133
134# @FUNCTION: want_apache
135# @USAGE: [myiuse]
136# @DESCRIPTION:
137# An ebuild calls this to get the dependency information for optional apache
138# support. If the myiuse parameter is not given it defaults to apache2.
139want_apache() {
140 debug-print-function $FUNCNAME $*
141 want_apache2 "$@"
142}
143
144# @FUNCTION: want_apache2
145# @USAGE: [myiuse]
146# @DESCRIPTION:
147# An ebuild calls this to get the dependency information for optional apache-2.x
148# support. If the myiuse parameter is not given it defaults to apache2.
149want_apache2() {
150 debug-print-function $FUNCNAME $*
151
152 local myiuse=${1:-apache2}
153 IUSE="${IUSE} ${myiuse}"
154 DEPEND="${DEPEND} ${myiuse}? ( ${APACHE2_DEPEND} )"
155 RDEPEND="${RDEPEND} ${myiuse}? ( ${APACHE2_DEPEND} )"
156
157 if use ${myiuse} ; then
158 _init_apache2
159 else
160 _init_no_apache
161 fi
162}
163
164# @FUNCTION: want_apache2_2
165# @USAGE: [myiuse]
166# @DESCRIPTION:
167# An ebuild calls this to get the dependency information for optional
168# apache-2.2.x support. If the myiuse parameter is not given it defaults to
169# apache2.
170want_apache2_2() {
171 debug-print-function $FUNCNAME $*
172
173 local myiuse=${1:-apache2}
174 IUSE="${IUSE} ${myiuse}"
175 DEPEND="${DEPEND} ${myiuse}? ( ${APACHE2_2_DEPEND} )"
176 RDEPEND="${RDEPEND} ${myiuse}? ( ${APACHE2_2_DEPEND} )"
177
178 if use ${myiuse} ; then
179 _init_apache2
180 else
181 _init_no_apache
182 fi
183}
184
185# @FUNCTION: need_apache
186# @DESCRIPTION:
157## An ebuild calls this to get the dependency information 187# An ebuild calls this to get the dependency information for apache.
158## for apache-1.x. An ebuild should use this in order for
159## future changes to the build infrastructure to happen
160## seamlessly. All an ebuild needs to do is include the
161## line need_apache1 somewhere.
162####
163need_apache1() { 188need_apache() {
164 debug-print-function need_apache1 189 debug-print-function $FUNCNAME $*
165
166 DEPEND="${DEPEND} ${APACHE1_DEPEND}"
167 RDEPEND="${RDEPEND} ${APACHE1_DEPEND}"
168 APACHE_VERSION='1'
169}
170
171####
172## need_apache2 190 need_apache2
173## 191}
192
193# @FUNCTION: need_apache2
194# @DESCRIPTION:
174## An ebuild calls this to get the dependency information 195# An ebuild calls this to get the dependency information for apache-2.x.
175## for apache-2.x. An ebuild should use this in order for
176## future changes to the build infrastructure to happen
177## seamlessly. All an ebuild needs to do is include the
178## line need_apache1 somewhere.
179####
180need_apache2() { 196need_apache2() {
181 debug-print-function need_apache2 197 debug-print-function $FUNCNAME $*
182 198
183 DEPEND="${DEPEND} ${APACHE2_DEPEND}" 199 DEPEND="${DEPEND} ${APACHE2_DEPEND}"
184 RDEPEND="${RDEPEND} ${APACHE2_DEPEND}" 200 RDEPEND="${RDEPEND} ${APACHE2_DEPEND}"
185 APACHE_VERSION='2' 201 _init_apache2
186} 202}
187 203
188#### 204# @FUNCTION: need_apache2_2
189## DO NOT CHANGE THIS FUNCTION UNLESS YOU UNDERSTAND THE CONSEQUENCES IT 205# @DESCRIPTION:
190## WILL HAVE ON THE CACHE! There MUST be a apache2? () block in DEPEND for 206# An ebuild calls this to get the dependency information for apache-2.2.x.
191## things to work correct in the dependency calculation stage.
192####
193need_apache() { 207need_apache2_2() {
194 debug-print-function need_apache 208 debug-print-function $FUNCNAME $*
195 209
196 IUSE="${IUSE} apache2"
197 DEPEND="${DEPEND} ${NEED_APACHE_DEPEND}" 210 DEPEND="${DEPEND} ${APACHE2_2_DEPEND}"
198 RDEPEND="${RDEPEND} ${NEED_APACHE_DEPEND}" 211 RDEPEND="${RDEPEND} ${APACHE2_2_DEPEND}"
199 if useq apache2; then 212 _init_apache2
200 uses_apache2
201 else
202 uses_apache1
203 fi
204} 213}
205 214
206want_apache() { 215# @FUNCTION: check_apache_threads
207 debug-print-function want_apache 216# @USAGE: [myflag]
217# @DESCRIPTION:
218# An ebuild calls this to make sure thread-safety is enabled if apache has been
219# built with a threaded MPM. If the myflag parameter is not given it defaults to
220# threads.
221check_apache_threads() {
222 debug-print-function $FUNCNAME $*
208 223
209 IUSE="${IUSE} apache apache2" 224 if ! built_with_use www-servers/apache threads ; then
210 DEPEND="${DEPEND} ${WANT_APACHE_DEPEND}" 225 return
211 RDEPEND="${DEPEND} ${WANT_APACHE_DEPEND}"
212 if useq apache2 ; then
213 uses_apache2
214 elif useq apache ; then
215 uses_apache1
216 else
217 doesnt_use_apache
218 fi 226 fi
227
228 local myflag="${1:-threads}"
229
230 if ! use ${myflag} ; then
231 echo
232 eerror "You need to enable USE flag '${myflag}' to build a thread-safe version"
233 eerror "of ${CATEGORY}/${PN} for use with www-servers/apache"
234 die "Need missing USE flag '${myflag}'"
235 fi
219} 236}
237
238# @FUNCTION: check_apache_threads_in
239# @USAGE: <myforeign> [myflag]
240# @DESCRIPTION:
241# An ebuild calls this to make sure thread-safety is enabled in a foreign
242# package if apache has been built with a threaded MPM. If the myflag parameter
243# is not given it defaults to threads.
244check_apache_threads_in() {
245 debug-print-function $FUNCNAME $*
246
247 if ! built_with_use www-servers/apache threads ; then
248 return
249 fi
250
251 local myforeign="$1"
252 local myflag="${2:-threads}"
253
254 if ! built_with_use ${myforeign} ${myflag} ; then
255 echo
256 eerror "You need to enable USE flag '${myflag}' in ${myforeign} to"
257 eerror "build a thread-safe version of ${CATEGORY}/${PN} for use"
258 eerror "with www-servers/apache"
259 die "Need missing USE flag '${myflag}' in ${myforeign}"
260 fi
261}

Legend:
Removed from v.1.26  
changed lines
  Added in v.1.42

  ViewVC Help
Powered by ViewVC 1.1.20