/[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.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.23 2005/09/19 00:03:55 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###### 40# ==============================================================================
8## Apache Common Variables 41# INTERNAL VARIABLES
9## 42# ==============================================================================
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 43
15#### 44# @ECLASS-VARIABLE: APACHE_VERSION
16## APACHE_VERSION 45# @DESCRIPTION:
17##
18## 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.
19## set by the need_apache{|1|2} functions. 47# 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 48
26#### 49# @ECLASS-VARIABLE: APXS
27## APXS1, APXS2 50# @DESCRIPTION:
28##
29## Paths to the apxs tools 51# Path to the apxs tool.
30#### 52# This variable is set by the want/need_apache functions.
31APXS1="/usr/sbin/apxs"
32APXS2="/usr/sbin/apxs2"
33 53
34#### 54# @ECLASS-VARIABLE: APACHE_BIN
35## APACHECTL1, APACHECTL2 55# @DESCRIPTION:
36## 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:
37## Paths to the apachectl tools 61# Path to the apachectl tool.
38#### 62# This variable is set by the want/need_apache functions.
39APACHECTL1="/usr/sbin/apachectl"
40APACHECTL2="/usr/sbin/apache2ctl"
41 63
42#### 64# @ECLASS-VARIABLE: APACHE_BASEDIR
43## APACHE1_BASEDIR, APACHE2_BASEDIR 65# @DESCRIPTION:
44##
45## Paths to the server root directories 66# Path to the server root directory.
46#### 67# 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 68
52#### 69# @ECLASS-VARIABLE: APACHE_CONFDIR
53## APACHE1_CONFDIR, APACHE2_CONFDIR 70# @DESCRIPTION:
54##
55## Paths to the configuration file directories (usually under 71# Path to the configuration file directory.
56## $APACHE?_BASEDIR/conf) 72# This variable is set by the want/need_apache functions.
57####
58APACHE1_CONFDIR="/etc/apache"
59APACHE2_CONFDIR="/etc/apache2"
60 73
61#### 74# @ECLASS-VARIABLE: APACHE_MODULES_CONFDIR
62## APACHE1_MODULES_CONFDIR, APACHE2_MODULES_CONFDIR 75# @DESCRIPTION:
63##
64## Paths where module configuration files are kept 76# Path where module configuration files are kept.
65#### 77# 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 78
69#### 79# @ECLASS-VARIABLE: APACHE_VHOSTS_CONFDIR
70## APACHE1_VHOSTDIR, APACHE2_VHOSTDIR 80# @DESCRIPTION:
71##
72## Paths where virtual host configuration files are kept 81# Path where virtual host configuration files are kept.
73#### 82# This variable is set by the want/need_apache functions.
74APACHE1_VHOSTDIR="${APACHE1_CONFDIR}/vhosts.d"
75APACHE2_VHOSTDIR="${APACHE2_CONFDIR}/vhosts.d"
76 83
77#### 84# @ECLASS-VARIABLE: APACHE_MODULESDIR
78## APACHE1_MODULESDIR, APACHE2_MODULESDIR 85# @DESCRIPTION:
79##
80## Paths where we install modules 86# Path where we install modules.
81#### 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"
114 APXS="/usr/sbin/apxs2"
115 APACHE_BIN="/usr/sbin/apache2"
116 APACHE_CTL="/usr/sbin/apache2ctl"
117 APACHE_INCLUDEDIR="/usr/include/apache2"
118 APACHE_BASEDIR="/usr/$(get_libdir)/apache2"
119 APACHE_CONFDIR="/etc/apache2"
120 APACHE_MODULES_CONFDIR="${APACHE_CONFDIR}/modules.d"
121 APACHE_VHOSTS_CONFDIR="${APACHE_CONFDIR}/vhosts.d"
82APACHE1_MODULESDIR="${APACHE1_BASEDIR}/modules" 122 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} 123}
124 124
125#### 125_init_no_apache() {
126# uses_apache2() 126 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' 127 APACHE_VERSION="0"
145 USE_APACHE=
146} 128}
147 129
148#### 130# ==============================================================================
149## need_apache1 131# PUBLIC FUNCTIONS
150## 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:
151## An ebuild calls this to get the dependency information 187# 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() { 188need_apache() {
158 debug-print-function need_apache1 189 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 190 need_apache2
167## 191}
192
193# @FUNCTION: need_apache2
194# @DESCRIPTION:
168## An ebuild calls this to get the dependency information 195# 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() { 196need_apache2() {
175 debug-print-function need_apache2 197 debug-print-function $FUNCNAME $*
176 198
177 DEPEND="${DEPEND} ${APACHE2_DEPEND}" 199 DEPEND="${DEPEND} ${APACHE2_DEPEND}"
178 RDEPEND="${RDEPEND} ${APACHE2_DEPEND}" 200 RDEPEND="${RDEPEND} ${APACHE2_DEPEND}"
179 APACHE_VERSION='2' 201 _init_apache2
180} 202}
181 203
182#### 204# @FUNCTION: need_apache2_2
183## DO NOT CHANGE THIS FUNCTION UNLESS YOU UNDERSTAND THE CONSEQUENCES IT 205# @DESCRIPTION:
184## 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.
185## things to work correct in the dependency calculation stage.
186####
187need_apache() { 207need_apache2_2() {
188 debug-print-function need_apache 208 debug-print-function $FUNCNAME $*
189 209
190 IUSE="${IUSE} apache2"
191 DEPEND="${DEPEND} ${NEED_APACHE_DEPEND}" 210 DEPEND="${DEPEND} ${APACHE2_2_DEPEND}"
192 RDEPEND="${RDEPEND} ${NEED_APACHE_DEPEND}" 211 RDEPEND="${RDEPEND} ${APACHE2_2_DEPEND}"
193 if useq apache2; then 212 _init_apache2
194 uses_apache2
195 else
196 uses_apache1
197 fi
198} 213}
199 214
200want_apache() { 215# @FUNCTION: check_apache_threads
201 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 $*
202 223
203 IUSE="${IUSE} apache apache2" 224 if ! built_with_use www-servers/apache threads ; then
204 DEPEND="${DEPEND} ${WANT_APACHE_DEPEND}" 225 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 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
213} 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.23  
changed lines
  Added in v.1.42

  ViewVC Help
Powered by ViewVC 1.1.20