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

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

  ViewVC Help
Powered by ViewVC 1.1.20