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

Legend:
Removed from v.1.23  
changed lines
  Added in v.1.44

  ViewVC Help
Powered by ViewVC 1.1.20