/[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.6 Revision 1.45
1# Copyright 2004 Gentoo Foundation 1# Copyright 1999-2009 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# Author Michael Tindal <urilith@gentoo.org>
4# $Header: /var/cvsroot/gentoo-x86/eclass/depend.apache.eclass,v 1.6 2004/11/21 01:51:58 urilith Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/depend.apache.eclass,v 1.45 2009/05/26 16:41:56 arfrever Exp $
5ECLASS=depend.apache
6INHERITED="$INHERITED $ECLASS"
7 4
8###### 5# @ECLASS: depend.apache.eclass
9## Apache Common Variables 6# @MAINTAINER:
10## 7# apache-devs@gentoo.org
11## These are internal variables used by this, and other apache-related eclasses, 8# @BLURB: Functions to allow ebuilds to depend on apache
12## and thus should not need to be used by the ebuilds themselves (the ebuilds 9# @DESCRIPTION:
13## should know what version of Apache they are building against). 10# This eclass handles depending on apache in a sane way and provides information
14###### 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
15 42
16#### 43inherit multilib
17## APACHE_VERSION 44
18## 45# ==============================================================================
46# INTERNAL VARIABLES
47# ==============================================================================
48
49# @ECLASS-VARIABLE: APACHE_VERSION
50# @DESCRIPTION:
19## 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.
20## set by the need_apache{|1|2} functions. 52# This variable is set by the want/need_apache functions.
21####
22APACHE_VERSION='2'
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_MODULES_VHOSTDIR, APACHE2_MODULES_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# ==============================================================================
110# INTERNAL FUNCTIONS
111# ==============================================================================
112
113_init_apache2() {
114 debug-print-function $FUNCNAME $*
115
116 # WARNING: Do not use these variables with anything that is put
117 # into the dependency cache (DEPEND/RDEPEND/etc)
118 APACHE_VERSION="2"
119 APXS="/usr/sbin/apxs2"
120 APACHE_BIN="/usr/sbin/apache2"
121 APACHE_CTL="/usr/sbin/apache2ctl"
122 APACHE_INCLUDEDIR="/usr/include/apache2"
123 APACHE_BASEDIR="/usr/$(get_libdir)/apache2"
124 APACHE_CONFDIR="/etc/apache2"
125 APACHE_MODULES_CONFDIR="${APACHE_CONFDIR}/modules.d"
126 APACHE_VHOSTS_CONFDIR="${APACHE_CONFDIR}/vhosts.d"
78APACHE1_MODULESDIR="${APACHE1_BASEDIR}/modules" 127 APACHE_MODULESDIR="${APACHE_BASEDIR}/modules"
79APACHE2_MODULESDIR="${APACHE2_BASEDIR}/modules" 128}
80 129
81#### 130_init_no_apache() {
82## APACHE1_DEPEND, APACHE2_DEPEND 131 debug-print-function $FUNCNAME $*
83## 132 APACHE_VERSION="0"
84## Dependencies for apache 1.x and apache 2.x 133}
85####
86APACHE1_DEPEND="=net-www/apache-1*"
87APACHE2_DEPEND="=net-www/apache-2*"
88 134
89#### 135# ==============================================================================
90## need_apache1 136# PUBLIC FUNCTIONS
91## 137# ==============================================================================
138
139# @FUNCTION: depend.apache_pkg_setup
140# @USAGE: [myiuse]
141# @DESCRIPTION:
142# An ebuild calls this in pkg_setup() to initialize variables for optional
143# apache-2.x support. If the myiuse parameter is not given it defaults to
144# apache2.
145depend.apache_pkg_setup() {
146 debug-print-function $FUNCNAME $*
147
148 if [[ "${EBUILD_PHASE}" != "setup" ]]; then
149 die "$FUNCNAME() should be called in pkg_setup()"
150 fi
151
152 local myiuse=${1:-apache2}
153 if has ${myiuse} ${IUSE}; then
154 if use ${myiuse}; then
155 _init_apache2
156 else
157 _init_no_apache
158 fi
159 fi
160}
161
162# @FUNCTION: want_apache
163# @USAGE: [myiuse]
164# @DESCRIPTION:
165# An ebuild calls this to get the dependency information for optional apache
166# support. If the myiuse parameter is not given it defaults to apache2.
167# An ebuild should additionally call depend.apache_pkg_setup() in pkg_setup()
168# with the same myiuse parameter.
169want_apache() {
170 debug-print-function $FUNCNAME $*
171 want_apache2 "$@"
172}
173
174# @FUNCTION: want_apache2
175# @USAGE: [myiuse]
176# @DESCRIPTION:
177# An ebuild calls this to get the dependency information for optional apache-2.x
178# support. If the myiuse parameter is not given it defaults to apache2.
179# An ebuild should additionally call depend.apache_pkg_setup() in pkg_setup()
180# with the same myiuse parameter.
181want_apache2() {
182 debug-print-function $FUNCNAME $*
183
184 local myiuse=${1:-apache2}
185 IUSE="${IUSE} ${myiuse}"
186 DEPEND="${DEPEND} ${myiuse}? ( ${APACHE2_DEPEND} )"
187 RDEPEND="${RDEPEND} ${myiuse}? ( ${APACHE2_DEPEND} )"
188}
189
190# @FUNCTION: want_apache2_2
191# @USAGE: [myiuse]
192# @DESCRIPTION:
193# An ebuild calls this to get the dependency information for optional
194# apache-2.2.x support. If the myiuse parameter is not given it defaults to
195# apache2.
196# An ebuild should additionally call depend.apache_pkg_setup() in pkg_setup()
197# with the same myiuse parameter.
198want_apache2_2() {
199 debug-print-function $FUNCNAME $*
200
201 local myiuse=${1:-apache2}
202 IUSE="${IUSE} ${myiuse}"
203 DEPEND="${DEPEND} ${myiuse}? ( ${APACHE2_2_DEPEND} )"
204 RDEPEND="${RDEPEND} ${myiuse}? ( ${APACHE2_2_DEPEND} )"
205}
206
207# @FUNCTION: need_apache
208# @DESCRIPTION:
92## An ebuild calls this to get the dependency information 209# An ebuild calls this to get the dependency information for apache.
93## for apache-1.x. An ebuild should use this in order for
94## future changes to the build infrastructure to happen
95## seamlessly. All an ebuild needs to do is include the
96## line need_apache1 somewhere.
97####
98need_apache1() { 210need_apache() {
99 debug-print-function need_apache1 211 debug-print-function $FUNCNAME $*
100
101 DEPEND="${DEPEND} ${APACHE1_DEPEND}"
102 APACHE_VERSION='1'
103}
104
105####
106## need_apache2 212 need_apache2
107## 213}
214
215# @FUNCTION: need_apache2
216# @DESCRIPTION:
108## An ebuild calls this to get the dependency information 217# An ebuild calls this to get the dependency information for apache-2.x.
109## for apache-2.x. An ebuild should use this in order for
110## future changes to the build infrastructure to happen
111## seamlessly. All an ebuild needs to do is include the
112## line need_apache1 somewhere.
113####
114need_apache2() { 218need_apache2() {
115 debug-print-function need_apache2 219 debug-print-function $FUNCNAME $*
116 220
117 DEPEND="${DEPEND} ${APACHE2_DEPEND}" 221 DEPEND="${DEPEND} ${APACHE2_DEPEND}"
118 APACHE_VERSION='2' 222 RDEPEND="${RDEPEND} ${APACHE2_DEPEND}"
223 _init_apache2
119} 224}
120 225
226# @FUNCTION: need_apache2_2
227# @DESCRIPTION:
228# An ebuild calls this to get the dependency information for apache-2.2.x.
121need_apache() { 229need_apache2_2() {
122 debug-print-function need_apache 230 debug-print-function $FUNCNAME $*
123 231
124 IUSE="${IUSE} apache2" 232 DEPEND="${DEPEND} ${APACHE2_2_DEPEND}"
125 if useq apache2; then 233 RDEPEND="${RDEPEND} ${APACHE2_2_DEPEND}"
234 _init_apache2
235}
236
237# @FUNCTION: has_apache
238# @DESCRIPTION:
239# An ebuild calls this to get runtime variables for an indirect apache
240# dependency without USE-flag, in which case want_apache does not work.
241# DO NOT call this function in global scope.
242has_apache() {
243 debug-print-function $FUNCNAME $*
244
245 if has_version '>=www-servers/apache-2'; then
126 need_apache2 246 _init_apache2
127 else 247 else
128 need_apache1 248 _init_no_apache
129 fi 249 fi
130} 250}
131 251
252# @FUNCTION: has_apache_threads
253# @USAGE: [myflag]
254# @DESCRIPTION:
255# An ebuild calls this to make sure thread-safety is enabled if apache has been
256# built with a threaded MPM. If the myflag parameter is not given it defaults to
257# threads.
258has_apache_threads() {
259 debug-print-function $FUNCNAME $*
260
261 if ! built_with_use www-servers/apache threads; then
262 return
263 fi
264
265 local myflag="${1:-threads}"
266
267 if ! use ${myflag}; then
268 echo
269 eerror "You need to enable USE flag '${myflag}' to build a thread-safe version"
270 eerror "of ${CATEGORY}/${PN} for use with www-servers/apache"
271 die "Need missing USE flag '${myflag}'"
272 fi
273}
274
275# @FUNCTION: has_apache_threads_in
276# @USAGE: <myforeign> [myflag]
277# @DESCRIPTION:
278# An ebuild calls this to make sure thread-safety is enabled in a foreign
279# package if apache has been built with a threaded MPM. If the myflag parameter
280# is not given it defaults to threads.
281has_apache_threads_in() {
282 debug-print-function $FUNCNAME $*
283
284 if ! built_with_use www-servers/apache threads; then
285 return
286 fi
287
288 local myforeign="$1"
289 local myflag="${2:-threads}"
290
291 if ! built_with_use ${myforeign} ${myflag}; then
292 echo
293 eerror "You need to enable USE flag '${myflag}' in ${myforeign} to"
294 eerror "build a thread-safe version of ${CATEGORY}/${PN} for use"
295 eerror "with www-servers/apache"
296 die "Need missing USE flag '${myflag}' in ${myforeign}"
297 fi
298}
299
300EXPORT_FUNCTIONS pkg_setup

Legend:
Removed from v.1.6  
changed lines
  Added in v.1.45

  ViewVC Help
Powered by ViewVC 1.1.20