/[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.47
1# Copyright 1999-2005 Gentoo Foundation 1# Copyright 1999-2012 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.47 2012/04/20 07:22:47 patrick 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#
38# pkg_setup() {
39# depend.apache_pkg_setup server
40# }
41# @CODE
4 42
5inherit multilib 43inherit multilib
6 44
7###### 45# ==============================================================================
8## Apache Common Variables 46# INTERNAL VARIABLES
9## 47# ==============================================================================
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 48
15#### 49# @ECLASS-VARIABLE: APACHE_VERSION
16## APACHE_VERSION 50# @DESCRIPTION:
17##
18## 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.
19## set by the need_apache{|1|2} functions. 52# 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 53
26#### 54# @ECLASS-VARIABLE: APXS
27## APXS1, APXS2 55# @DESCRIPTION:
28##
29## Paths to the apxs tools 56# Path to the apxs tool.
30#### 57# This variable is set by the want/need_apache functions.
31APXS1="/usr/sbin/apxs"
32APXS2="/usr/sbin/apxs2"
33 58
34#### 59# @ECLASS-VARIABLE: APACHE_BIN
35## APACHECTL1, APACHECTL2 60# @DESCRIPTION:
36## 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:
37## Paths to the apachectl tools 66# Path to the apachectl tool.
38#### 67# This variable is set by the want/need_apache functions.
39APACHECTL1="/usr/sbin/apachectl"
40APACHECTL2="/usr/sbin/apache2ctl"
41 68
42#### 69# @ECLASS-VARIABLE: APACHE_BASEDIR
43## APACHE1_BASEDIR, APACHE2_BASEDIR 70# @DESCRIPTION:
44##
45## Paths to the server root directories 71# Path to the server root directory.
46#### 72# 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 73
52#### 74# @ECLASS-VARIABLE: APACHE_CONFDIR
53## APACHE1_CONFDIR, APACHE2_CONFDIR 75# @DESCRIPTION:
54##
55## Paths to the configuration file directories (usually under 76# Path to the configuration file directory.
56## $APACHE?_BASEDIR/conf) 77# This variable is set by the want/need_apache functions.
57####
58APACHE1_CONFDIR="/etc/apache"
59APACHE2_CONFDIR="/etc/apache2"
60 78
61#### 79# @ECLASS-VARIABLE: APACHE_MODULES_CONFDIR
62## APACHE1_MODULES_CONFDIR, APACHE2_MODULES_CONFDIR 80# @DESCRIPTION:
63##
64## Paths where module configuration files are kept 81# Path where module configuration files are kept.
65#### 82# 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 83
69#### 84# @ECLASS-VARIABLE: APACHE_VHOSTS_CONFDIR
70## APACHE1_VHOSTDIR, APACHE2_VHOSTDIR 85# @DESCRIPTION:
71##
72## Paths where virtual host configuration files are kept 86# Path where virtual host configuration files are kept.
73#### 87# This variable is set by the want/need_apache functions.
74APACHE1_VHOSTDIR="${APACHE1_CONFDIR}/vhosts.d"
75APACHE2_VHOSTDIR="${APACHE2_CONFDIR}/vhosts.d"
76 88
77#### 89# @ECLASS-VARIABLE: APACHE_MODULESDIR
78## APACHE1_MODULESDIR, APACHE2_MODULESDIR 90# @DESCRIPTION:
79##
80## Paths where we install modules 91# Path where we install modules.
81#### 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_4_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"
82APACHE1_MODULESDIR="${APACHE1_BASEDIR}/modules" 133 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} 134}
124 135
125#### 136_init_no_apache() {
126# uses_apache2() 137 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' 138 APACHE_VERSION="0"
145 USE_APACHE=
146} 139}
147 140
148#### 141# ==============================================================================
149## need_apache1 142# PUBLIC FUNCTIONS
150## 143# ==============================================================================
144
145# @FUNCTION: depend.apache_pkg_setup
146# @USAGE: [myiuse]
147# @DESCRIPTION:
148# An ebuild calls this in pkg_setup() to initialize variables for optional
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 $*
153
154 if [[ "${EBUILD_PHASE}" != "setup" ]]; then
155 die "$FUNCNAME() should be called in pkg_setup()"
156 fi
157
158 local myiuse=${1:-apache2}
159 if has ${myiuse} ${IUSE}; then
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:
151## An ebuild calls this to get the dependency information 215# 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() { 216need_apache() {
158 debug-print-function need_apache1 217 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 218 need_apache2
167## 219}
220
221# @FUNCTION: need_apache2
222# @DESCRIPTION:
168## An ebuild calls this to get the dependency information 223# 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() { 224need_apache2() {
175 debug-print-function need_apache2 225 debug-print-function $FUNCNAME $*
176 226
177 DEPEND="${DEPEND} ${APACHE2_DEPEND}" 227 DEPEND="${DEPEND} ${APACHE2_DEPEND}"
178 RDEPEND="${RDEPEND} ${APACHE2_DEPEND}" 228 RDEPEND="${RDEPEND} ${APACHE2_DEPEND}"
179 APACHE_VERSION='2' 229 _init_apache2
180} 230}
181 231
182#### 232# @FUNCTION: need_apache2_2
183## DO NOT CHANGE THIS FUNCTION UNLESS YOU UNDERSTAND THE CONSEQUENCES IT 233# @DESCRIPTION:
184## 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.
185## things to work correct in the dependency calculation stage.
186####
187need_apache() { 235need_apache2_2() {
188 debug-print-function need_apache 236 debug-print-function $FUNCNAME $*
189 237
190 IUSE="${IUSE} apache2"
191 DEPEND="${DEPEND} ${NEED_APACHE_DEPEND}" 238 DEPEND="${DEPEND} ${APACHE2_2_DEPEND}"
192 RDEPEND="${RDEPEND} ${NEED_APACHE_DEPEND}" 239 RDEPEND="${RDEPEND} ${APACHE2_2_DEPEND}"
193 if useq apache2; then 240 _init_apache2
194 uses_apache2 241}
242
243# @FUNCTION: need_apache2_4
244# @DESCRIPTION:
245# An ebuild calls this to get the dependency information for apache-2.4.x.
246need_apache2_4() {
247 debug-print-function $FUNCNAME $*
248
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
195 else 264 else
196 uses_apache1 265 _init_no_apache
197 fi 266 fi
198} 267}
199 268
200want_apache() { 269# @FUNCTION: has_apache_threads
201 debug-print-function want_apache 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 $*
202 277
203 IUSE="${IUSE} apache apache2" 278 if ! built_with_use www-servers/apache threads; then
204 DEPEND="${DEPEND} ${WANT_APACHE_DEPEND}" 279 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 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
213} 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.23  
changed lines
  Added in v.1.47

  ViewVC Help
Powered by ViewVC 1.1.20