/[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.20 Revision 1.40
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.20 2005/09/04 10:54:53 stuart Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/depend.apache.eclass,v 1.40 2008/02/06 08:33:47 hollow Exp $
4 4
5###### 5# @ECLASS: depend.apache.eclass
6## Apache Common Variables 6# @MAINTAINER: apache-devs@gentoo.org
7## 7# @BLURB: Functions to allow ebuilds to depend on apache
8## These are internal variables used by this, and other apache-related eclasses, 8# @DESCRIPTION:
9## 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
10## should know what version of Apache they are building against). 10# about where certain binaries and configuration files are located.
11###### 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
12 37
13#### 38inherit multilib
14## APACHE_VERSION 39
15## 40# ==============================================================================
41# INTERNAL VARIABLES
42# ==============================================================================
43
44# @ECLASS-VARIABLE: APACHE_VERSION
45# @DESCRIPTION:
16## 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.
17## set by the need_apache{|1|2} functions. 47# This variable is set by the want/need_apache functions.
18##
19## This needs to stay as '1' until apache2 is on by default -- although it
20## doesn't matter much as it's set by the need_apache functions.
21####
22APACHE_VERSION='1'
23 48
24#### 49# @ECLASS-VARIABLE: APXS
25## APXS1, APXS2 50# @DESCRIPTION:
26##
27## Paths to the apxs tools 51# Paths 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 # legacy alias
118 APACHECTL="${APACHE_CTL}"
119 APACHE_BASEDIR="/usr/$(get_libdir)/apache2"
120 APACHE_CONFDIR="/etc/apache2"
121 APACHE_MODULES_CONFDIR="${APACHE_CONFDIR}/modules.d"
122 APACHE_VHOSTS_CONFDIR="${APACHE_CONFDIR}/vhosts.d"
78APACHE1_MODULESDIR="${APACHE1_BASEDIR}/modules" 123 APACHE_MODULESDIR="${APACHE_BASEDIR}/modules"
79APACHE2_MODULESDIR="${APACHE2_BASEDIR}/modules"
80
81####
82## APACHE1_DEPEND, APACHE2_DEPEND
83##
84## Dependencies for apache 1.x and apache 2.x
85## - apache2 must be at least version 2.0.52-r3, this is lowest version
86## containing our new overall changes -- trapni (Jan 21 2005)
87## - apache1 must be at least version 1.3.33-r1, but how to
88## define the DEPEND here? (FIXME) -- trapni (Jan 21 2005)
89## - currently not possible - bug #4315 -- vericgar (Jan 21 2005)
90####
91APACHE1_DEPEND="=net-www/apache-1*"
92APACHE2_DEPEND=">=net-www/apache-2.0.54-r10"
93
94####
95## APACHE_DEPEND
96##
97## Dependency magic based on useflags to use the right DEPEND
98####
99
100NEED_APACHE_DEPEND="apache2? ( ${APACHE2_DEPEND} ) !apache2? ( ${APACHE1_DEPEND} )"
101WANT_APACHE_DEPEND="apache2? ( ${APACHE2_DEPEND} ) !apache2? ( apache? ( ${APACHE1_DEPEND} ) )"
102
103####
104# uses_apache1()
105#
106# sets up all of the environment variables required by an apache1 module
107####
108
109uses_apache1() {
110 APACHE_VERSION='1'
111 APXS="$APXS1"
112 USE_APACHE2=
113 APACHECTL="${APACHECTL1}"
114 APACHE_BASEDIR="${APACHE1_BASEDIR}"
115 APACHE_CONFDIR="${APACHE1_CONFDIR}"
116 APACHE_MODULES_CONFDIR="${APACHE1_MODULES_CONFDIR}"
117 APACHE_VHOSTSDIR="${APACHE1_VHOSTSDIR}"
118 APACHE_MODULESDIR="${APACHE1_MODULESDIR}"
119} 124}
120 125
121#### 126_init_no_apache() {
122# uses_apache2() 127 debug-print-function $FUNCNAME $*
123#
124# sets up all of the environment variables required by an apache2 module
125####
126
127uses_apache2() {
128 APACHE_VERSION='2'
129 USE_APACHE2=2
130 APXS="$APXS2"
131 APACHECTL="${APACHECTL2}"
132 APACHE_BASEDIR="${APACHE2_BASEDIR}"
133 APACHE_CONFDIR="${APACHE2_CONFDIR}"
134 APACHE_MODULES_CONFDIR="${APACHE2_MODULES_CONFDIR}"
135 APACHE_VHOSTSDIR="${APACHE2_VHOSTSDIR}"
136 APACHE_MODULESDIR="${APACHE2_MODULESDIR}"
137}
138
139doesnt_use_apache() {
140 APACHE_VERSION='0' 128 APACHE_VERSION="0"
141 USE_APACHE=
142} 129}
143 130
144#### 131# ==============================================================================
145## need_apache1 132# PUBLIC FUNCTIONS
146## 133# ==============================================================================
134
135# @FUNCTION: want_apache
136# @USAGE: [myiuse]
137# @DESCRIPTION:
138# An ebuild calls this to get the dependency information for optional apache
139# support. If the myiuse parameter is not given it defaults to apache2.
140want_apache() {
141 debug-print-function $FUNCNAME $*
142 want_apache2 "$@"
143}
144
145# @FUNCTION: want_apache2
146# @USAGE: [myiuse]
147# @DESCRIPTION:
148# An ebuild calls this to get the dependency information for optional apache-2.x
149# support. If the myiuse parameter is not given it defaults to apache2.
150want_apache2() {
151 debug-print-function $FUNCNAME $*
152
153 local myiuse=${1:-apache2}
154 IUSE="${IUSE} ${myiuse}"
155 DEPEND="${DEPEND} ${myiuse}? ( ${APACHE2_DEPEND} )"
156 RDEPEND="${RDEPEND} ${myiuse}? ( ${APACHE2_DEPEND} )"
157
158 if use ${myiuse} ; then
159 _init_apache2
160 else
161 _init_no_apache
162 fi
163}
164
165# @FUNCTION: want_apache2_2
166# @USAGE: [myiuse]
167# @DESCRIPTION:
168# An ebuild calls this to get the dependency information for optional
169# apache-2.2.x support. If the myiuse parameter is not given it defaults to
170# apache2.
171want_apache2_2() {
172 debug-print-function $FUNCNAME $*
173
174 local myiuse=${1:-apache2}
175 IUSE="${IUSE} ${myiuse}"
176 DEPEND="${DEPEND} ${myiuse}? ( ${APACHE2_2_DEPEND} )"
177 RDEPEND="${RDEPEND} ${myiuse}? ( ${APACHE2_2_DEPEND} )"
178
179 if use ${myiuse} ; then
180 _init_apache2
181 else
182 _init_no_apache
183 fi
184}
185
186# @FUNCTION: need_apache
187# @DESCRIPTION:
147## An ebuild calls this to get the dependency information 188# An ebuild calls this to get the dependency information for apache.
148## for apache-1.x. An ebuild should use this in order for
149## future changes to the build infrastructure to happen
150## seamlessly. All an ebuild needs to do is include the
151## line need_apache1 somewhere.
152####
153need_apache1() { 189need_apache() {
154 debug-print-function need_apache1 190 debug-print-function $FUNCNAME $*
155
156 DEPEND="${DEPEND} ${APACHE1_DEPEND}"
157 RDEPEND="${RDEPEND} ${APACHE1_DEPEND}"
158 APACHE_VERSION='1'
159}
160
161####
162## need_apache2 191 need_apache2
163## 192}
193
194# @FUNCTION: need_apache2
195# @DESCRIPTION:
164## An ebuild calls this to get the dependency information 196# An ebuild calls this to get the dependency information for apache-2.x.
165## for apache-2.x. An ebuild should use this in order for
166## future changes to the build infrastructure to happen
167## seamlessly. All an ebuild needs to do is include the
168## line need_apache1 somewhere.
169####
170need_apache2() { 197need_apache2() {
171 debug-print-function need_apache2 198 debug-print-function $FUNCNAME $*
172 199
173 DEPEND="${DEPEND} ${APACHE2_DEPEND}" 200 DEPEND="${DEPEND} ${APACHE2_DEPEND}"
174 RDEPEND="${RDEPEND} ${APACHE2_DEPEND}" 201 RDEPEND="${RDEPEND} ${APACHE2_DEPEND}"
175 APACHE_VERSION='2' 202 _init_apache2
176} 203}
177 204
178#### 205# @FUNCTION: need_apache2_2
179## DO NOT CHANGE THIS FUNCTION UNLESS YOU UNDERSTAND THE CONSEQUENCES IT 206# @DESCRIPTION:
180## WILL HAVE ON THE CACHE! There MUST be a apache2? () block in DEPEND for 207# An ebuild calls this to get the dependency information for apache-2.2.x.
181## things to work correct in the dependency calculation stage.
182####
183need_apache() { 208need_apache2_2() {
184 debug-print-function need_apache 209 debug-print-function $FUNCNAME $*
185 210
186 IUSE="${IUSE} apache2"
187 DEPEND="${DEPEND} ${NEED_APACHE_DEPEND}" 211 DEPEND="${DEPEND} ${APACHE2_2_DEPEND}"
188 RDEPEND="${RDEPEND} ${NEED_APACHE_DEPEND}" 212 RDEPEND="${RDEPEND} ${APACHE2_2_DEPEND}"
189 if useq apache2; then 213 _init_apache2
190 uses_apache2
191 else
192 uses_apache1
193 fi
194} 214}
195
196want_apache() {
197 debug-print-function want_apache
198
199 IUSE="${IUSE} apache apache2"
200 DEPEND="${DEPEND} ${WANT_APACHE_DEPEND}"
201 RDEPEND="${DEPEND} ${WANT_APACHE_DEPEND}"
202 if useq apache2 ; then
203 uses_apache2
204 elif useq apache ; then
205 uses_apache1
206 else
207 doesnt_use_apache
208 fi
209}

Legend:
Removed from v.1.20  
changed lines
  Added in v.1.40

  ViewVC Help
Powered by ViewVC 1.1.20