/[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.1.1.1 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.1.1.1 2005/11/30 09:59:27 chriswhite 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" 53
54# @ECLASS-VARIABLE: APACHE_BIN
55# @DESCRIPTION:
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:
61# Path to the apachectl tool.
62# This variable is set by the want/need_apache functions.
63
64# @ECLASS-VARIABLE: APACHE_BASEDIR
65# @DESCRIPTION:
66# Path to the server root directory.
67# This variable is set by the want/need_apache functions.
68
69# @ECLASS-VARIABLE: APACHE_CONFDIR
70# @DESCRIPTION:
71# Path to the configuration file directory.
72# This variable is set by the want/need_apache functions.
73
74# @ECLASS-VARIABLE: APACHE_MODULES_CONFDIR
75# @DESCRIPTION:
76# Path where module configuration files are kept.
77# This variable is set by the want/need_apache functions.
78
79# @ECLASS-VARIABLE: APACHE_VHOSTS_CONFDIR
80# @DESCRIPTION:
81# Path where virtual host configuration files are kept.
82# This variable is set by the want/need_apache functions.
83
84# @ECLASS-VARIABLE: APACHE_MODULESDIR
85# @DESCRIPTION:
86# Path where we install modules.
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"
32APXS2="/usr/sbin/apxs2" 114 APXS="/usr/sbin/apxs2"
33
34####
35## APACHECTL1, APACHECTL2
36##
37## Paths to the apachectl tools
38####
39APACHECTL1="/usr/sbin/apachectl" 115 APACHE_BIN="/usr/sbin/apache2"
40APACHECTL2="/usr/sbin/apache2ctl" 116 APACHE_CTL="/usr/sbin/apache2ctl"
41 117 APACHE_INCLUDEDIR="/usr/include/apache2"
42####
43## APACHE1_BASEDIR, APACHE2_BASEDIR
44##
45## Paths to the server root directories
46####
47APACHE1_BASEDIR="/usr/$(get_libdir)/apache"
48APACHE2_BASEDIR="/usr/$(get_libdir)/apache2" 118 APACHE_BASEDIR="/usr/$(get_libdir)/apache2"
49
50####
51## APACHE1_CONFDIR, APACHE2_CONFDIR
52##
53## Paths to the configuration file directories (usually under
54## $APACHE?_BASEDIR/conf)
55####
56APACHE1_CONFDIR="/etc/apache"
57APACHE2_CONFDIR="/etc/apache2" 119 APACHE_CONFDIR="/etc/apache2"
58
59####
60## APACHE1_MODULES_CONFDIR, APACHE2_MODULES_CONFDIR
61##
62## Paths where module configuration files are kept
63####
64APACHE1_MODULES_CONFDIR="${APACHE1_CONFDIR}/modules.d" 120 APACHE_MODULES_CONFDIR="${APACHE_CONFDIR}/modules.d"
65APACHE2_MODULES_CONFDIR="${APACHE2_CONFDIR}/modules.d"
66
67####
68## APACHE1_VHOSTDIR, APACHE2_VHOSTDIR
69##
70## Paths where virtual host configuration files are kept
71####
72APACHE1_VHOSTDIR="${APACHE1_CONFDIR}/vhosts.d" 121 APACHE_VHOSTS_CONFDIR="${APACHE_CONFDIR}/vhosts.d"
73APACHE2_VHOSTDIR="${APACHE2_CONFDIR}/vhosts.d"
74
75####
76## APACHE1_MODULESDIR, APACHE2_MODULESDIR
77##
78## Paths where we install modules
79####
80APACHE1_MODULESDIR="${APACHE1_BASEDIR}/modules" 122 APACHE_MODULESDIR="${APACHE_BASEDIR}/modules"
81APACHE2_MODULESDIR="${APACHE2_BASEDIR}/modules"
82
83####
84## APACHE1_DEPEND, APACHE2_DEPEND
85##
86## Dependencies for apache 1.x and apache 2.x
87## - apache2 must be at least version 2.0.54-r30, this is lowest version
88## containing our new overall changes -- trapni (Jan 21 2005)
89## - apache1 must be at least version 1.3.33-r10, but how to
90## define the DEPEND here? (FIXME) -- trapni (Jan 21 2005)
91## - currently not possible - bug #4315 -- vericgar (Jan 21 2005)
92####
93APACHE1_DEPEND="=net-www/apache-1*"
94APACHE2_DEPEND=">=net-www/apache-2.0.54-r30"
95
96####
97## APACHE_DEPEND
98##
99## Dependency magic based on useflags to use the right DEPEND
100####
101
102NEED_APACHE_DEPEND="apache2? ( ${APACHE2_DEPEND} ) !apache2? ( ${APACHE1_DEPEND} )"
103WANT_APACHE_DEPEND="apache2? ( ${APACHE2_DEPEND} ) !apache2? ( apache? ( ${APACHE1_DEPEND} ) )"
104
105####
106# uses_apache1()
107#
108# sets up all of the environment variables required by an apache1 module
109####
110
111uses_apache1() {
112 APACHE_VERSION='1'
113 APXS="$APXS1"
114 USE_APACHE2=
115 APACHECTL="${APACHECTL1}"
116 APACHE_BASEDIR="${APACHE1_BASEDIR}"
117 APACHE_CONFDIR="${APACHE1_CONFDIR}"
118 APACHE_MODULES_CONFDIR="${APACHE1_MODULES_CONFDIR}"
119 APACHE_VHOSTSDIR="${APACHE1_VHOSTSDIR}"
120 APACHE_MODULESDIR="${APACHE1_MODULESDIR}"
121} 123}
122 124
123#### 125_init_no_apache() {
124# uses_apache2() 126 debug-print-function $FUNCNAME $*
125#
126# sets up all of the environment variables required by an apache2 module
127####
128
129uses_apache2() {
130 APACHE_VERSION='2'
131 USE_APACHE2=2
132 APXS="$APXS2"
133 APACHECTL="${APACHECTL2}"
134 APACHE_BASEDIR="${APACHE2_BASEDIR}"
135 APACHE_CONFDIR="${APACHE2_CONFDIR}"
136 APACHE_MODULES_CONFDIR="${APACHE2_MODULES_CONFDIR}"
137 APACHE_VHOSTSDIR="${APACHE2_VHOSTSDIR}"
138 APACHE_MODULESDIR="${APACHE2_MODULESDIR}"
139}
140
141doesnt_use_apache() {
142 APACHE_VERSION='0' 127 APACHE_VERSION="0"
143 USE_APACHE=
144} 128}
145 129
146#### 130# ==============================================================================
147## need_apache1 131# PUBLIC FUNCTIONS
148## 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:
149## An ebuild calls this to get the dependency information 187# An ebuild calls this to get the dependency information for apache.
150## for apache-1.x. An ebuild should use this in order for
151## future changes to the build infrastructure to happen
152## seamlessly. All an ebuild needs to do is include the
153## line need_apache1 somewhere.
154####
155need_apache1() { 188need_apache() {
156 debug-print-function need_apache1 189 debug-print-function $FUNCNAME $*
157
158 DEPEND="${DEPEND} ${APACHE1_DEPEND}"
159 RDEPEND="${RDEPEND} ${APACHE1_DEPEND}"
160 APACHE_VERSION='1'
161}
162
163####
164## need_apache2 190 need_apache2
165## 191}
192
193# @FUNCTION: need_apache2
194# @DESCRIPTION:
166## An ebuild calls this to get the dependency information 195# An ebuild calls this to get the dependency information for apache-2.x.
167## for apache-2.x. An ebuild should use this in order for
168## future changes to the build infrastructure to happen
169## seamlessly. All an ebuild needs to do is include the
170## line need_apache1 somewhere.
171####
172need_apache2() { 196need_apache2() {
173 debug-print-function need_apache2 197 debug-print-function $FUNCNAME $*
174 198
175 DEPEND="${DEPEND} ${APACHE2_DEPEND}" 199 DEPEND="${DEPEND} ${APACHE2_DEPEND}"
176 RDEPEND="${RDEPEND} ${APACHE2_DEPEND}" 200 RDEPEND="${RDEPEND} ${APACHE2_DEPEND}"
177 APACHE_VERSION='2' 201 _init_apache2
178} 202}
179 203
180#### 204# @FUNCTION: need_apache2_2
181## DO NOT CHANGE THIS FUNCTION UNLESS YOU UNDERSTAND THE CONSEQUENCES IT 205# @DESCRIPTION:
182## 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.
183## things to work correct in the dependency calculation stage.
184####
185need_apache() { 207need_apache2_2() {
186 debug-print-function need_apache 208 debug-print-function $FUNCNAME $*
187 209
188 IUSE="${IUSE} apache2"
189 DEPEND="${DEPEND} ${NEED_APACHE_DEPEND}" 210 DEPEND="${DEPEND} ${APACHE2_2_DEPEND}"
190 RDEPEND="${RDEPEND} ${NEED_APACHE_DEPEND}" 211 RDEPEND="${RDEPEND} ${APACHE2_2_DEPEND}"
191 if useq apache2; then 212 _init_apache2
192 uses_apache2
193 else
194 uses_apache1
195 fi
196} 213}
197 214
198want_apache() { 215# @FUNCTION: check_apache_threads
199 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 $*
200 223
201 IUSE="${IUSE} apache apache2" 224 if ! built_with_use www-servers/apache threads ; then
202 DEPEND="${DEPEND} ${WANT_APACHE_DEPEND}" 225 return
203 RDEPEND="${DEPEND} ${WANT_APACHE_DEPEND}"
204 if useq apache2 ; then
205 uses_apache2
206 elif useq apache ; then
207 uses_apache1
208 else
209 doesnt_use_apache
210 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
211} 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.1.1.1  
changed lines
  Added in v.1.42

  ViewVC Help
Powered by ViewVC 1.1.20