/[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.28 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.28 2006/11/26 21:25:28 vericgar 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####
30#APACHE_VERSION='2'
31 48
32#### 49# @ECLASS-VARIABLE: APXS
33## APXS1, APXS2 50# @DESCRIPTION:
34##
35## Paths to the apxs tools 51# Path to the apxs tool.
36#### 52# This variable is set by the want/need_apache functions.
37APXS1="/usr/sbin/apxs"
38APXS2="/usr/sbin/apxs2"
39 53
40#### 54# @ECLASS-VARIABLE: APACHE_BIN
41## APACHECTL1, APACHECTL2 55# @DESCRIPTION:
42## 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:
43## Paths to the apachectl tools 61# Path to the apachectl tool.
44#### 62# This variable is set by the want/need_apache functions.
45APACHECTL1="/usr/sbin/apachectl"
46APACHECTL2="/usr/sbin/apache2ctl"
47 63
48#### 64# @ECLASS-VARIABLE: APACHE_BASEDIR
49## APACHE1_BASEDIR, APACHE2_BASEDIR 65# @DESCRIPTION:
50##
51## Paths to the server root directories 66# Path to the server root directory.
52#### 67# This variable is set by the want/need_apache functions.
53APACHE1_BASEDIR="/usr/$(get_libdir)/apache"
54APACHE2_BASEDIR="/usr/$(get_libdir)/apache2"
55 68
56#### 69# @ECLASS-VARIABLE: APACHE_CONFDIR
57## APACHE1_CONFDIR, APACHE2_CONFDIR 70# @DESCRIPTION:
58##
59## Paths to the configuration file directories (usually under 71# Path to the configuration file directory.
60## $APACHE?_BASEDIR/conf) 72# This variable is set by the want/need_apache functions.
61####
62APACHE1_CONFDIR="/etc/apache"
63APACHE2_CONFDIR="/etc/apache2"
64 73
65#### 74# @ECLASS-VARIABLE: APACHE_MODULES_CONFDIR
66## APACHE1_MODULES_CONFDIR, APACHE2_MODULES_CONFDIR 75# @DESCRIPTION:
67##
68## Paths where module configuration files are kept 76# Path where module configuration files are kept.
69#### 77# This variable is set by the want/need_apache functions.
70APACHE1_MODULES_CONFDIR="${APACHE1_CONFDIR}/modules.d"
71APACHE2_MODULES_CONFDIR="${APACHE2_CONFDIR}/modules.d"
72 78
73#### 79# @ECLASS-VARIABLE: APACHE_VHOSTS_CONFDIR
74## APACHE1_VHOSTDIR, APACHE2_VHOSTDIR 80# @DESCRIPTION:
75##
76## Paths where virtual host configuration files are kept 81# Path where virtual host configuration files are kept.
77#### 82# This variable is set by the want/need_apache functions.
78APACHE1_VHOSTDIR="${APACHE1_CONFDIR}/vhosts.d"
79APACHE2_VHOSTDIR="${APACHE2_CONFDIR}/vhosts.d"
80 83
81#### 84# @ECLASS-VARIABLE: APACHE_MODULESDIR
82## APACHE1_MODULESDIR, APACHE2_MODULESDIR 85# @DESCRIPTION:
83##
84## Paths where we install modules 86# Path where we install modules.
85#### 87# This variable is set by the want/need_apache functions.
86APACHE1_MODULESDIR="${APACHE1_BASEDIR}/modules"
87APACHE2_MODULESDIR="${APACHE2_BASEDIR}/modules"
88 88
89#### 89# @ECLASS-VARIABLE: APACHE_DEPEND
90## APACHE1_DEPEND, APACHE2_DEPEND 90# @DESCRIPTION:
91## APACHE2_0_DEPEND, APACHE2_2_DEPEND 91# Dependencies for Apache
92## 92APACHE_DEPEND="www-servers/apache"
93
94# @ECLASS-VARIABLE: APACHE2_DEPEND
95# @DESCRIPTION:
93## Dependencies for apache 1.x and apache 2.x 96# Dependencies for Apache 2.x
94####
95APACHE1_DEPEND="=net-www/apache-1*"
96APACHE2_DEPEND="=net-www/apache-2*" 97APACHE2_DEPEND="=www-servers/apache-2*"
97APACHE2_0_DEPEND="=net-www/apache-2.0*" 98
99# @ECLASS-VARIABLE: APACHE2_2_DEPEND
100# @DESCRIPTION:
101# Dependencies for Apache 2.2.x
98APACHE2_2_DEPEND="=net-www/apache-2.2*" 102APACHE2_2_DEPEND="=www-servers/apache-2.2*"
99 103
100#### 104# ==============================================================================
101## NEED_APACHE_DEPEND 105# INTERNAL FUNCTIONS
102## 106# ==============================================================================
103## Dependency magic based on useflags to use the right DEPEND
104## If you change this, please check the DEPENDS in need_apache()
105####
106 107
107NEED_APACHE_DEPEND="apache2? ( ${APACHE2_DEPEND} ) !apache2? ( ${APACHE1_DEPEND} )" 108_init_apache2() {
108WANT_APACHE_DEPEND="apache2? ( ${APACHE2_DEPEND} ) !apache2? ( apache? ( ${APACHE1_DEPEND} ) )"
109
110####
111# uses_apache1()
112#
113# sets up all of the environment variables required by an apache1 module
114####
115
116uses_apache1() {
117 debug-print-function $FUNCNAME $* 109 debug-print-function $FUNCNAME $*
110
118 # WARNING: Do not use these variables with anything that is put 111 # WARNING: Do not use these variables with anything that is put
119 # into the dependency cache (DEPEND/RDEPEND/etc) 112 # into the dependency cache (DEPEND/RDEPEND/etc)
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}
130
131####
132# uses_apache2()
133#
134# sets up all of the environment variables required by an apache2 module
135####
136
137uses_apache2() {
138 debug-print-function $FUNCNAME $*
139 # WARNING: Do not use these variables with anything that is put
140 # into the dependency cache (DEPEND/RDEPEND/etc)
141 APACHE_VERSION='2' 113 APACHE_VERSION="2"
142 USE_APACHE2=2 114 APXS="/usr/sbin/apxs2"
143 APXS="$APXS2" 115 APACHE_BIN="/usr/sbin/apache2"
144 APACHECTL="${APACHECTL2}" 116 APACHE_CTL="/usr/sbin/apache2ctl"
145 APACHE_BASEDIR="${APACHE2_BASEDIR}" 117 APACHE_INCLUDEDIR="/usr/include/apache2"
146 APACHE_CONFDIR="${APACHE2_CONFDIR}" 118 APACHE_BASEDIR="/usr/$(get_libdir)/apache2"
119 APACHE_CONFDIR="/etc/apache2"
147 APACHE_MODULES_CONFDIR="${APACHE2_MODULES_CONFDIR}" 120 APACHE_MODULES_CONFDIR="${APACHE_CONFDIR}/modules.d"
148 APACHE_VHOSTSDIR="${APACHE2_VHOSTSDIR}" 121 APACHE_VHOSTS_CONFDIR="${APACHE_CONFDIR}/vhosts.d"
149 APACHE_MODULESDIR="${APACHE2_MODULESDIR}" 122 APACHE_MODULESDIR="${APACHE_BASEDIR}/modules"
150} 123}
151 124
152doesnt_use_apache() { 125_init_no_apache() {
153 debug-print-function $FUNCNAME $* 126 debug-print-function $FUNCNAME $*
154 APACHE_VERSION='0' 127 APACHE_VERSION="0"
155 USE_APACHE=
156} 128}
157 129
158#### 130# ==============================================================================
159## need_apache1 131# PUBLIC FUNCTIONS
160## 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:
161## An ebuild calls this to get the dependency information 187# An ebuild calls this to get the dependency information for apache.
162## for apache-1.x. An ebuild should use this in order for
163## future changes to the build infrastructure to happen
164## seamlessly. All an ebuild needs to do is include the
165## line need_apache1 somewhere.
166####
167need_apache1() { 188need_apache() {
168 debug-print-function $FUNCNAME $* 189 debug-print-function $FUNCNAME $*
169
170 DEPEND="${DEPEND} ${APACHE1_DEPEND}"
171 RDEPEND="${RDEPEND} ${APACHE1_DEPEND}"
172 APACHE_VERSION='1'
173}
174
175####
176## need_apache2 190 need_apache2
177## 191}
192
193# @FUNCTION: need_apache2
194# @DESCRIPTION:
178## An ebuild calls this to get the dependency information 195# An ebuild calls this to get the dependency information for apache-2.x.
179## for apache-2.x. An ebuild should use this in order for
180## future changes to the build infrastructure to happen
181## seamlessly. All an ebuild needs to do is include the
182## line need_apache2 somewhere.
183####
184need_apache2() { 196need_apache2() {
185 debug-print-function $FUNCNAME $* 197 debug-print-function $FUNCNAME $*
186 198
187 DEPEND="${DEPEND} ${APACHE2_DEPEND}" 199 DEPEND="${DEPEND} ${APACHE2_DEPEND}"
188 RDEPEND="${RDEPEND} ${APACHE2_DEPEND}" 200 RDEPEND="${RDEPEND} ${APACHE2_DEPEND}"
189 APACHE_VERSION='2' 201 _init_apache2
190} 202}
191 203
192#### 204# @FUNCTION: need_apache2_2
193## need_apache2_0 205# @DESCRIPTION:
194## 206# An ebuild calls this to get the dependency information for apache-2.2.x.
195## Works like need_apache2 above, but its used by modules
196## that only support apache 2.0 and do not work with
197## higher versions
198##
199####
200need_apache2_0() {
201 debug-print-function $FUNCNAME $*
202
203 DEPEND="${DEPEND} ${APACHE2_0_DEPEND}"
204 RDEPEND="${RDEPEND} ${APACHE2_0_DEPEND}"
205 APACHE_VERSION='2'
206}
207
208####
209## need_apache2_2
210##
211## Works like need_apache2 above, but its used by modules
212## that only support apache 2.2.
213##
214####
215need_apache2_2() { 207need_apache2_2() {
216 debug-print-function $FUNCNAME $* 208 debug-print-function $FUNCNAME $*
217 209
218 DEPEND="${DEPEND} ${APACHE2_2_DEPEND}" 210 DEPEND="${DEPEND} ${APACHE2_2_DEPEND}"
219 RDEPEND="${RDEPEND} ${APACHE2_2_DEPEND}" 211 RDEPEND="${RDEPEND} ${APACHE2_2_DEPEND}"
220 APACHE_VERSION='2' 212 _init_apache2
221} 213}
222 214
223#### 215# @FUNCTION: check_apache_threads
224## DO NOT CHANGE THIS FUNCTION UNLESS YOU UNDERSTAND THE CONSEQUENCES IT 216# @USAGE: [myflag]
225## WILL HAVE ON THE CACHE! There MUST be a apache2? () block in DEPEND for 217# @DESCRIPTION:
226## things to work correct in the dependency calculation stage. 218# An ebuild calls this to make sure thread-safety is enabled if apache has been
227## 219# built with a threaded MPM. If the myflag parameter is not given it defaults to
228## This function can take a variable amount of arguments specifying the 220# threads.
229## versions of apache the ebuild supports 221check_apache_threads() {
230##
231## If no arguments are specified, then all versions are assumed to be supported
232##
233## If both 1.3 and 2.x are specified, the apache2 USE-flag will be used in
234## DEPEND/RDEPEND to determine which version to use.
235##
236## Currently supported versions: 1.3 2.0 2.2 2.x
237need_apache() {
238 debug-print-function $FUNCNAME $* 222 debug-print-function $FUNCNAME $*
239 223
240 local supports13 supports20 supports22 supports2x 224 if ! built_with_use www-servers/apache threads ; then
241 225 return
242 if [ $# -eq 0 ]; then
243 supports13=yes
244 supports2x=yes
245 else
246 while [ $# -gt 0 ]; do
247 case "$1" in
248 1.3) supports13=yes; shift;;
249 2.0) supports20=yes; shift;;
250 2.2) supports22=yes; shift;;
251 2.x) supports2x=yes; shift;;
252 *) die "Unknown version specifier: $1";;
253 esac
254 done
255 fi
256
257 if [[ "${supports20}" == "yes" && "${supports22}" == "yes" ]]; then
258 supports2x=yes;
259 fi
260
261 debug-print "supports13: ${supports13}"
262 debug-print "supports20: ${supports20}"
263 debug-print "supports22: ${supports22}"
264 debug-print "supports2x: ${supports2x}"
265
266 if [ "${supports13}" != "yes" ]; then
267 if [ "${supports2x}" == "yes" ]; then
268 need_apache2
269 elif [ "${supports20}" == "yes" ]; then
270 need_apache2_0
271 elif [ "${supports22}" == "yes" ]; then
272 need_apache2_2
273 fi 226 fi
274 elif [ "${supports13}" == "yes" ]; then
275 if [[ "${supports2x}" == "yes" ||
276 "${supports20}" == "yes" ||
277 "${supports22}" == "yes" ]]; then
278 227
279 # we support both apache-1.3 and apache-2.*, set up USE-flag based 228 local myflag="${1:-threads}"
280 # DEPEND and RDEPEND, determined by which apache-2.x we support
281 229
282 IUSE="${IUSE} apache2" 230 if ! use ${myflag} ; then
283 231 echo
284 if [ "${supports2x}" != "yes" ]; then 232 eerror "You need to enable USE flag '${myflag}' to build a thread-safe version"
285 if [ "${supports20}" == "yes" ]; then 233 eerror "of ${CATEGORY}/${PN} for use with www-servers/apache"
286 NEED_APACHE_DEPEND="apache2? ( ${APACHE2_0_DEPEND} ) !apache2? ( ${APACHE1_DEPEND} )" 234 die "Need missing USE flag '${myflag}'"
287 elif [ "${supports22}" == "yes" ]; then
288 NEED_APACHE_DEPEND="apache2? ( ${APACHE2_2_DEPEND} ) !apache2? ( ${APACHE1_DEPEND} )"
289 fi
290 fi
291
292 DEPEND="${DEPEND} ${NEED_APACHE_DEPEND}"
293 RDEPEND="${RDEPEND} ${NEED_APACHE_DEPEND}"
294
295 if useq apache2; then
296 uses_apache2
297 else
298 uses_apache1
299 fi
300 else
301 need_apache1
302 fi 235 fi
303 fi
304
305} 236}
306 237
307want_apache() { 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() {
308 debug-print-function $FUNCNAME $* 245 debug-print-function $FUNCNAME $*
309 246
310 IUSE="${IUSE} apache apache2" 247 if ! built_with_use www-servers/apache threads ; then
311 DEPEND="${DEPEND} ${WANT_APACHE_DEPEND}" 248 return
312 RDEPEND="${RDEPEND} ${WANT_APACHE_DEPEND}"
313 if useq apache2 ; then
314 uses_apache2
315 elif useq apache ; then
316 uses_apache1
317 else
318 doesnt_use_apache
319 fi 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
320} 261}

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

  ViewVC Help
Powered by ViewVC 1.1.20