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

Legend:
Removed from v.1.19  
changed lines
  Added in v.1.46

  ViewVC Help
Powered by ViewVC 1.1.20