/[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.16 Revision 1.44
1# Copyright 2004-2005 Gentoo Foundation 1# Copyright 1999-2007 Gentoo Foundation
2# Distributed under the terms of the GNU General Public License, v2 or later 2# Distributed under the terms of the GNU General Public License v2
3# $Header: /var/cvsroot/gentoo-x86/eclass/depend.apache.eclass,v 1.16 2005/07/06 20:20:03 agriffis Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/depend.apache.eclass,v 1.44 2008/03/04 10:59:27 hollow Exp $
4INHERITED="$INHERITED $ECLASS"
5 4
6###### 5# @ECLASS: depend.apache.eclass
7## Apache Common Variables 6# @MAINTAINER:
8## 7# apache-devs@gentoo.org
9## These are internal variables used by this, and other apache-related eclasses, 8# @BLURB: Functions to allow ebuilds to depend on apache
10## and thus should not need to be used by the ebuilds themselves (the ebuilds 9# @DESCRIPTION:
11## should know what version of Apache they are building against). 10# This eclass handles depending on apache in a sane way and provides information
12###### 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
13 38
14#### 39inherit multilib
15## APACHE_VERSION 40
16## 41# ==============================================================================
42# INTERNAL VARIABLES
43# ==============================================================================
44
45# @ECLASS-VARIABLE: APACHE_VERSION
46# @DESCRIPTION:
17## 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.
18## set by the need_apache{|1|2} functions. 48# This variable is set by the want/need_apache functions.
19##
20## This needs to stay as '1' until apache2 is on by default -- although it
21## doesn't matter much as it's set by the need_apache functions.
22####
23APACHE_VERSION='1'
24 49
25#### 50# @ECLASS-VARIABLE: APXS
26## APXS1, APXS2 51# @DESCRIPTION:
27##
28## Paths to the apxs tools 52# Path to the apxs tool.
29#### 53# This variable is set by the want/need_apache functions.
30APXS1="/usr/sbin/apxs"
31APXS2="/usr/sbin/apxs2"
32 54
33#### 55# @ECLASS-VARIABLE: APACHE_BIN
34## APACHECTL1, APACHECTL2 56# @DESCRIPTION:
35## 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:
36## Paths to the apachectl tools 62# Path to the apachectl tool.
37#### 63# This variable is set by the want/need_apache functions.
38APACHECTL1="/usr/sbin/apachectl"
39APACHECTL2="/usr/sbin/apache2ctl"
40 64
41#### 65# @ECLASS-VARIABLE: APACHE_BASEDIR
42## APACHE1_BASEDIR, APACHE2_BASEDIR 66# @DESCRIPTION:
43##
44## Paths to the server root directories 67# Path to the server root directory.
45#### 68# This variable is set by the want/need_apache functions.
46APACHE1_BASEDIR="/usr/lib/apache"
47APACHE2_BASEDIR="/usr/lib/apache2"
48 69
49#### 70# @ECLASS-VARIABLE: APACHE_CONFDIR
50## APACHE1_CONFDIR, APACHE2_CONFDIR 71# @DESCRIPTION:
51##
52## Paths to the configuration file directories (usually under 72# Path to the configuration file directory.
53## $APACHE?_BASEDIR/conf) 73# This variable is set by the want/need_apache functions.
54####
55APACHE1_CONFDIR="/etc/apache"
56APACHE2_CONFDIR="/etc/apache2"
57 74
58#### 75# @ECLASS-VARIABLE: APACHE_MODULES_CONFDIR
59## APACHE1_MODULES_CONFDIR, APACHE2_MODULES_CONFDIR 76# @DESCRIPTION:
60##
61## Paths where module configuration files are kept 77# Path where module configuration files are kept.
62#### 78# This variable is set by the want/need_apache functions.
63APACHE1_MODULES_CONFDIR="${APACHE1_CONFDIR}/modules.d"
64APACHE2_MODULES_CONFDIR="${APACHE2_CONFDIR}/modules.d"
65 79
66#### 80# @ECLASS-VARIABLE: APACHE_VHOSTS_CONFDIR
67## APACHE1_MODULES_VHOSTDIR, APACHE2_MODULES_VHOSTDIR 81# @DESCRIPTION:
68##
69## Paths where virtual host configuration files are kept 82# Path where virtual host configuration files are kept.
70#### 83# This variable is set by the want/need_apache functions.
71APACHE1_VHOSTDIR="${APACHE1_CONFDIR}/vhosts.d"
72APACHE2_VHOSTDIR="${APACHE2_CONFDIR}/vhosts.d"
73 84
74#### 85# @ECLASS-VARIABLE: APACHE_MODULESDIR
75## APACHE1_MODULESDIR, APACHE2_MODULESDIR 86# @DESCRIPTION:
76##
77## Paths where we install modules 87# Path where we install modules.
78#### 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"
79APACHE1_MODULESDIR="${APACHE1_BASEDIR}/modules" 123 APACHE_MODULESDIR="${APACHE_BASEDIR}/modules"
80APACHE2_MODULESDIR="${APACHE2_BASEDIR}/modules" 124}
81 125
82#### 126_init_no_apache() {
83## APACHE1_DEPEND, APACHE2_DEPEND 127 debug-print-function $FUNCNAME $*
84## 128 APACHE_VERSION="0"
85## Dependencies for apache 1.x and apache 2.x 129}
86## - apache2 must be at least version 2.0.52-r3, this is lowest version
87## containing our new overall changes -- trapni (Jan 21 2005)
88## - apache1 must be at least version 1.3.33-r1, but how to
89## define the DEPEND here? (FIXME) -- trapni (Jan 21 2005)
90## - currently not possible - bug #4315 -- vericgar (Jan 21 2005)
91####
92APACHE1_DEPEND="=net-www/apache-1*"
93APACHE2_DEPEND=">=net-www/apache-2.0.54-r10"
94 130
131# ==============================================================================
132# PUBLIC FUNCTIONS
133# ==============================================================================
95 134
96#### 135# @FUNCTION: want_apache
97## APACHE_DEPEND 136# @USAGE: [myiuse]
98## 137# @DESCRIPTION:
99## Dependency magic based on useflags to use the right DEPEND 138# An ebuild calls this to get the dependency information for optional apache
100#### 139# support. If the myiuse parameter is not given it defaults to apache2.
140want_apache() {
141 debug-print-function $FUNCNAME $*
142 want_apache2 "$@"
143}
101 144
102APACHE_DEPEND="apache2? ( ${APACHE2_DEPEND} ) !apache2? ( ${APACHE1_DEPEND} )" 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 $*
103 152
104#### 153 local myiuse=${1:-apache2}
105## need_apache1 154 IUSE="${IUSE} ${myiuse}"
106## 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:
107## An ebuild calls this to get the dependency information 188# An ebuild calls this to get the dependency information for apache.
108## for apache-1.x. An ebuild should use this in order for
109## future changes to the build infrastructure to happen
110## seamlessly. All an ebuild needs to do is include the
111## line need_apache1 somewhere.
112####
113need_apache1() { 189need_apache() {
114 debug-print-function need_apache1 190 debug-print-function $FUNCNAME $*
115
116 DEPEND="${DEPEND} ${APACHE1_DEPEND}"
117 RDEPEND="${RDEPEND} ${APACHE1_DEPEND}"
118 APACHE_VERSION='1'
119}
120
121####
122## need_apache2 191 need_apache2
123## 192}
193
194# @FUNCTION: need_apache2
195# @DESCRIPTION:
124## An ebuild calls this to get the dependency information 196# An ebuild calls this to get the dependency information for apache-2.x.
125## for apache-2.x. An ebuild should use this in order for
126## future changes to the build infrastructure to happen
127## seamlessly. All an ebuild needs to do is include the
128## line need_apache1 somewhere.
129####
130need_apache2() { 197need_apache2() {
131 debug-print-function need_apache2 198 debug-print-function $FUNCNAME $*
132 199
133 DEPEND="${DEPEND} ${APACHE2_DEPEND}" 200 DEPEND="${DEPEND} ${APACHE2_DEPEND}"
134 RDEPEND="${RDEPEND} ${APACHE2_DEPEND}" 201 RDEPEND="${RDEPEND} ${APACHE2_DEPEND}"
135 APACHE_VERSION='2' 202 _init_apache2
136} 203}
137 204
138#### 205# @FUNCTION: need_apache2_2
139## DO NOT CHANGE THIS FUNCTION UNLESS YOU UNDERSTAND THE CONSEQUENCES IT 206# @DESCRIPTION:
140## 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.
141## things to work correct in the dependency calculation stage.
142####
143need_apache() { 208need_apache2_2() {
144 debug-print-function need_apache 209 debug-print-function $FUNCNAME $*
145 210
146 IUSE="${IUSE} apache2"
147 DEPEND="${DEPEND} ${APACHE_DEPEND}" 211 DEPEND="${DEPEND} ${APACHE2_2_DEPEND}"
148 RDEPEND="${RDEPEND} ${APACHE_DEPEND}" 212 RDEPEND="${RDEPEND} ${APACHE2_2_DEPEND}"
149 if useq apache2; then 213 _init_apache2
150 APACHE_VERSION='2' 214}
151 USE_APACHE2=2 215
152 APXS="$APXS2" 216# @FUNCTION: has_apache
153 APACHECTL="${APACHECTL2}" 217# @DESCRIPTION:
154 APACHE_BASEDIR="${APACHE2_BASEDIR}" 218# An ebuild calls this to get runtime variables for an indirect apache
155 APACHE_CONFDIR="${APACHE2_CONFDIR}" 219# dependency without USE-flag, in which case want_apache does not work.
156 APACHE_MODULES_CONFDIR="${APACHE2_MODULES_CONFDIR}" 220# DO NOT call this function in global scope.
157 APACHE_VHOSTSDIR="${APACHE2_VHOSTSDIR}" 221has_apache() {
158 APACHE_MODULESDIR="${APACHE2_MODULESDIR}" 222 debug-print-function $FUNCNAME $*
223
224 if has_version '>=www-servers/apache-2'; then
225 _init_apache2
159 else 226 else
160 APACHE_VERSION='1' 227 _init_no_apache
161 APXS="$APXS1"
162 USE_APACHE2=
163 APACHECTL="${APACHECTL1}"
164 APACHE_BASEDIR="${APACHE1_BASEDIR}"
165 APACHE_CONFDIR="${APACHE1_CONFDIR}"
166 APACHE_MODULES_CONFDIR="${APACHE1_MODULES_CONFDIR}"
167 APACHE_VHOSTSDIR="${APACHE1_VHOSTSDIR}"
168 APACHE_MODULESDIR="${APACHE1_MODULESDIR}"
169 fi 228 fi
170} 229}
230
231# @FUNCTION: has_apache_threads
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 $*
239
240 if ! built_with_use www-servers/apache threads; then
241 return
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
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.16  
changed lines
  Added in v.1.44

  ViewVC Help
Powered by ViewVC 1.1.20