/[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.42
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.42 2008/02/06 21:20:41 hollow Exp $
4INHERITED="$INHERITED $ECLASS"
5 4
6###### 5# @ECLASS: depend.apache.eclass
7## Apache Common Variables 6# @MAINTAINER: apache-devs@gentoo.org
8## 7# @BLURB: Functions to allow ebuilds to depend on apache
9## These are internal variables used by this, and other apache-related eclasses, 8# @DESCRIPTION:
10## and thus should not need to be used by the ebuilds themselves (the ebuilds 9# This eclass handles depending on apache in a sane way and provides information
11## should know what version of Apache they are building against). 10# about where certain binaries and configuration files are located.
12###### 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
13 37
14#### 38inherit multilib
15## APACHE_VERSION 39
16## 40# ==============================================================================
41# INTERNAL VARIABLES
42# ==============================================================================
43
44# @ECLASS-VARIABLE: APACHE_VERSION
45# @DESCRIPTION:
17## 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.
18## set by the need_apache{|1|2} functions. 47# 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 48
25#### 49# @ECLASS-VARIABLE: APXS
26## APXS1, APXS2 50# @DESCRIPTION:
27##
28## Paths to the apxs tools 51# Path to the apxs tool.
29#### 52# This variable is set by the want/need_apache functions.
30APXS1="/usr/sbin/apxs"
31APXS2="/usr/sbin/apxs2"
32 53
33#### 54# @ECLASS-VARIABLE: APACHE_BIN
34## APACHECTL1, APACHECTL2 55# @DESCRIPTION:
35## 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:
36## Paths to the apachectl tools 61# Path to the apachectl tool.
37#### 62# This variable is set by the want/need_apache functions.
38APACHECTL1="/usr/sbin/apachectl"
39APACHECTL2="/usr/sbin/apache2ctl"
40 63
41#### 64# @ECLASS-VARIABLE: APACHE_BASEDIR
42## APACHE1_BASEDIR, APACHE2_BASEDIR 65# @DESCRIPTION:
43##
44## Paths to the server root directories 66# Path to the server root directory.
45#### 67# This variable is set by the want/need_apache functions.
46APACHE1_BASEDIR="/usr/lib/apache"
47APACHE2_BASEDIR="/usr/lib/apache2"
48 68
49#### 69# @ECLASS-VARIABLE: APACHE_CONFDIR
50## APACHE1_CONFDIR, APACHE2_CONFDIR 70# @DESCRIPTION:
51##
52## Paths to the configuration file directories (usually under 71# Path to the configuration file directory.
53## $APACHE?_BASEDIR/conf) 72# This variable is set by the want/need_apache functions.
54####
55APACHE1_CONFDIR="/etc/apache"
56APACHE2_CONFDIR="/etc/apache2"
57 73
58#### 74# @ECLASS-VARIABLE: APACHE_MODULES_CONFDIR
59## APACHE1_MODULES_CONFDIR, APACHE2_MODULES_CONFDIR 75# @DESCRIPTION:
60##
61## Paths where module configuration files are kept 76# Path where module configuration files are kept.
62#### 77# 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 78
66#### 79# @ECLASS-VARIABLE: APACHE_VHOSTS_CONFDIR
67## APACHE1_MODULES_VHOSTDIR, APACHE2_MODULES_VHOSTDIR 80# @DESCRIPTION:
68##
69## Paths where virtual host configuration files are kept 81# Path where virtual host configuration files are kept.
70#### 82# This variable is set by the want/need_apache functions.
71APACHE1_VHOSTDIR="${APACHE1_CONFDIR}/vhosts.d"
72APACHE2_VHOSTDIR="${APACHE2_CONFDIR}/vhosts.d"
73 83
74#### 84# @ECLASS-VARIABLE: APACHE_MODULESDIR
75## APACHE1_MODULESDIR, APACHE2_MODULESDIR 85# @DESCRIPTION:
76##
77## Paths where we install modules 86# Path where we install modules.
78#### 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"
79APACHE1_MODULESDIR="${APACHE1_BASEDIR}/modules" 122 APACHE_MODULESDIR="${APACHE_BASEDIR}/modules"
80APACHE2_MODULESDIR="${APACHE2_BASEDIR}/modules" 123}
81 124
82#### 125_init_no_apache() {
83## APACHE1_DEPEND, APACHE2_DEPEND 126 debug-print-function $FUNCNAME $*
84## 127 APACHE_VERSION="0"
85## Dependencies for apache 1.x and apache 2.x 128}
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 129
130# ==============================================================================
131# PUBLIC FUNCTIONS
132# ==============================================================================
95 133
96#### 134# @FUNCTION: want_apache
97## APACHE_DEPEND 135# @USAGE: [myiuse]
98## 136# @DESCRIPTION:
99## Dependency magic based on useflags to use the right DEPEND 137# An ebuild calls this to get the dependency information for optional apache
100#### 138# support. If the myiuse parameter is not given it defaults to apache2.
139want_apache() {
140 debug-print-function $FUNCNAME $*
141 want_apache2 "$@"
142}
101 143
102APACHE_DEPEND="apache2? ( ${APACHE2_DEPEND} ) !apache2? ( ${APACHE1_DEPEND} )" 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 $*
103 151
104#### 152 local myiuse=${1:-apache2}
105## need_apache1 153 IUSE="${IUSE} ${myiuse}"
106## 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:
107## An ebuild calls this to get the dependency information 187# 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() { 188need_apache() {
114 debug-print-function need_apache1 189 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 190 need_apache2
123## 191}
192
193# @FUNCTION: need_apache2
194# @DESCRIPTION:
124## An ebuild calls this to get the dependency information 195# 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() { 196need_apache2() {
131 debug-print-function need_apache2 197 debug-print-function $FUNCNAME $*
132 198
133 DEPEND="${DEPEND} ${APACHE2_DEPEND}" 199 DEPEND="${DEPEND} ${APACHE2_DEPEND}"
134 RDEPEND="${RDEPEND} ${APACHE2_DEPEND}" 200 RDEPEND="${RDEPEND} ${APACHE2_DEPEND}"
135 APACHE_VERSION='2' 201 _init_apache2
136} 202}
137 203
138#### 204# @FUNCTION: need_apache2_2
139## DO NOT CHANGE THIS FUNCTION UNLESS YOU UNDERSTAND THE CONSEQUENCES IT 205# @DESCRIPTION:
140## 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.
141## things to work correct in the dependency calculation stage.
142####
143need_apache() { 207need_apache2_2() {
144 debug-print-function need_apache 208 debug-print-function $FUNCNAME $*
145 209
146 IUSE="${IUSE} apache2"
147 DEPEND="${DEPEND} ${APACHE_DEPEND}" 210 DEPEND="${DEPEND} ${APACHE2_2_DEPEND}"
148 RDEPEND="${RDEPEND} ${APACHE_DEPEND}" 211 RDEPEND="${RDEPEND} ${APACHE2_2_DEPEND}"
149 if useq apache2; then 212 _init_apache2
150 APACHE_VERSION='2'
151 USE_APACHE2=2
152 APXS="$APXS2"
153 APACHECTL="${APACHECTL2}"
154 APACHE_BASEDIR="${APACHE2_BASEDIR}"
155 APACHE_CONFDIR="${APACHE2_CONFDIR}"
156 APACHE_MODULES_CONFDIR="${APACHE2_MODULES_CONFDIR}"
157 APACHE_VHOSTSDIR="${APACHE2_VHOSTSDIR}"
158 APACHE_MODULESDIR="${APACHE2_MODULESDIR}"
159 else
160 APACHE_VERSION='1'
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
170} 213}
214
215# @FUNCTION: check_apache_threads
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 $*
223
224 if ! built_with_use www-servers/apache threads ; then
225 return
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
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.16  
changed lines
  Added in v.1.42

  ViewVC Help
Powered by ViewVC 1.1.20