/[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.43
1# Copyright 2004 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# 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.43 2008/02/06 23:45:13 hollow Exp $
5ECLASS=depend.apache
6INHERITED="$INHERITED $ECLASS"
7 4
8###### 5# @ECLASS: depend.apache.eclass
9## Apache Common Variables 6# @MAINTAINER: apache-devs@gentoo.org
10## 7# @BLURB: Functions to allow ebuilds to depend on apache
11## These are internal variables used by this, and other apache-related eclasses, 8# @DESCRIPTION:
12## 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
13## should know what version of Apache they are building against). 10# about where certain binaries and configuration files are located.
14###### 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
15 37
16#### 38inherit multilib
17## APACHE_VERSION 39
18## 40# ==============================================================================
41# INTERNAL VARIABLES
42# ==============================================================================
43
44# @ECLASS-VARIABLE: APACHE_VERSION
45# @DESCRIPTION:
19## 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.
20## set by the need_apache{|1|2} functions. 47# This variable is set by the want/need_apache functions.
21####
22APACHE_VERSION='2'
23 48
24#### 49# @ECLASS-VARIABLE: APXS
25## APXS1, APXS2 50# @DESCRIPTION:
26##
27## Paths to the apxs tools 51# Path to the apxs tool.
28#### 52# This variable is set by the want/need_apache functions.
29APXS1="/usr/sbin/apxs"
30APXS2="/usr/sbin/apxs2"
31 53
32#### 54# @ECLASS-VARIABLE: APACHE_BIN
33## APACHECTL1, APACHECTL2 55# @DESCRIPTION:
34## 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:
35## Paths to the apachectl tools 61# Path to the apachectl tool.
36#### 62# This variable is set by the want/need_apache functions.
37APACHECTL1="/usr/sbin/apachectl"
38APACHECTL2="/usr/sbin/apache2ctl"
39 63
40#### 64# @ECLASS-VARIABLE: APACHE_BASEDIR
41## APACHE1_BASEDIR, APACHE2_BASEDIR 65# @DESCRIPTION:
42##
43## Paths to the server root directories 66# Path to the server root directory.
44#### 67# This variable is set by the want/need_apache functions.
45APACHE1_BASEDIR="/usr/lib/apache"
46APACHE2_BASEDIR="/usr/lib/apache2"
47 68
48#### 69# @ECLASS-VARIABLE: APACHE_CONFDIR
49## APACHE1_CONFDIR, APACHE2_CONFDIR 70# @DESCRIPTION:
50##
51## Paths to the configuration file directories (usually under 71# Path to the configuration file directory.
52## $APACHE?_BASEDIR/conf) 72# This variable is set by the want/need_apache functions.
53####
54APACHE1_CONFDIR="/etc/apache"
55APACHE2_CONFDIR="/etc/apache2"
56 73
57#### 74# @ECLASS-VARIABLE: APACHE_MODULES_CONFDIR
58## APACHE1_MODULES_CONFDIR, APACHE2_MODULES_CONFDIR 75# @DESCRIPTION:
59##
60## Paths where module configuration files are kept 76# Path where module configuration files are kept.
61#### 77# 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 78
65#### 79# @ECLASS-VARIABLE: APACHE_VHOSTS_CONFDIR
66## APACHE1_MODULES_VHOSTDIR, APACHE2_MODULES_VHOSTDIR 80# @DESCRIPTION:
67##
68## Paths where virtual host configuration files are kept 81# Path where virtual host configuration files are kept.
69#### 82# This variable is set by the want/need_apache functions.
70APACHE1_VHOSTDIR="${APACHE1_CONFDIR}/vhosts.d"
71APACHE2_VHOSTDIR="${APACHE2_CONFDIR}/vhosts.d"
72 83
73#### 84# @ECLASS-VARIABLE: APACHE_MODULESDIR
74## APACHE1_MODULESDIR, APACHE2_MODULESDIR 85# @DESCRIPTION:
75##
76## Paths where we install modules 86# Path where we install modules.
77#### 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"
78APACHE1_MODULESDIR="${APACHE1_BASEDIR}/modules" 122 APACHE_MODULESDIR="${APACHE_BASEDIR}/modules"
79APACHE2_MODULESDIR="${APACHE2_BASEDIR}/modules" 123}
80 124
81#### 125_init_no_apache() {
82## APACHE1_DEPEND, APACHE2_DEPEND 126 debug-print-function $FUNCNAME $*
83## 127 APACHE_VERSION="0"
84## Dependencies for apache 1.x and apache 2.x 128}
85####
86APACHE1_DEPEND="=net-www/apache-1*"
87APACHE2_DEPEND="=net-www/apache-2*"
88 129
89#### 130# ==============================================================================
90## need_apache1 131# PUBLIC FUNCTIONS
91## 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:
92## An ebuild calls this to get the dependency information 187# 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() { 188need_apache() {
99 debug-print-function need_apache1 189 debug-print-function $FUNCNAME $*
100
101 DEPEND="${DEPEND} ${APACHE1_DEPEND}"
102 APACHE_VERSION='1'
103}
104
105####
106## need_apache2 190 need_apache2
107## 191}
192
193# @FUNCTION: need_apache2
194# @DESCRIPTION:
108## An ebuild calls this to get the dependency information 195# 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() { 196need_apache2() {
115 debug-print-function need_apache2 197 debug-print-function $FUNCNAME $*
116 198
117 DEPEND="${DEPEND} ${APACHE2_DEPEND}" 199 DEPEND="${DEPEND} ${APACHE2_DEPEND}"
118 APACHE_VERSION='2' 200 RDEPEND="${RDEPEND} ${APACHE2_DEPEND}"
201 _init_apache2
119} 202}
120 203
204# @FUNCTION: need_apache2_2
205# @DESCRIPTION:
206# An ebuild calls this to get the dependency information for apache-2.2.x.
121need_apache() { 207need_apache2_2() {
122 debug-print-function need_apache 208 debug-print-function $FUNCNAME $*
123 209
124 IUSE="${IUSE} apache2" 210 DEPEND="${DEPEND} ${APACHE2_2_DEPEND}"
125 if useq apache2; then 211 RDEPEND="${RDEPEND} ${APACHE2_2_DEPEND}"
126 need_apache2 212 _init_apache2
127 else
128 need_apache1
129 fi
130} 213}
131 214
215# @FUNCTION: has_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.
221has_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: has_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.
244has_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.6  
changed lines
  Added in v.1.43
  ViewVC Help
Powered by ViewVC 1.1.13