/[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.33 Revision 1.37
1# Copyright 1999-2007 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.33 2007/07/29 16:36:23 phreak Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/depend.apache.eclass,v 1.37 2008/02/02 14:31:42 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 providing
10# information about where certain interfaces are located.
11#
12# @NOTE: If you use this, be sure you use the need_* call after you have defined
13# DEPEND and RDEPEND. Also note that you can not rely on the automatic
14# RDEPEND=DEPEND that portage does if you use this eclass.
15#
16# See bug 107127 for more information.
4 17
5inherit multilib 18inherit multilib
6 19
7# This eclass handles depending on apache in a sane way and providing 20# ==============================================================================
8# information about where certain interfaces are located. 21# INTERNAL VARIABLES
22# ==============================================================================
9 23
10# NOTE: If you use this, be sure you use the need_* call after you have 24# @ECLASS-VARIABLE: APACHE_VERSION
11# defined DEPEND and RDEPEND. Also note that you can not rely on the 25# @DESCRIPTION:
12# automatic RDEPEND=DEPEND that portage does if you use this eclass. 26# Stores the version of apache we are going to be ebuilding. This variable is
13# See bug 107127 for more information. 27# set by the need_apache functions.
14 28
15###### 29# @ECLASS-VARIABLE: APXS
16## Apache Common Variables 30# @DESCRIPTION:
17## 31# Paths to the apxs tool
18## These are internal variables used by this, and other apache-related eclasses,
19## and thus should not need to be used by the ebuilds themselves (the ebuilds
20## should know what version of Apache they are building against).
21######
22 32
23#### 33# @ECLASS-VARIABLE: APACHECTL
24## APACHE_VERSION 34# @DESCRIPTION:
25## 35# Path to the apachectl tool
26## Stores the version of apache we are going to be ebuilding. This variable is
27## set by the need_apache{|1|2} functions.
28##
29####
30#APACHE_VERSION="2"
31 36
32#### 37# @ECLASS-VARIABLE: APACHE_BASEDIR
33## APXS1, APXS2 38# @DESCRIPTION:
34## 39# Path to the server root directory
35## Paths to the apxs tools
36####
37APXS1="/usr/sbin/apxs"
38APXS2="/usr/sbin/apxs2"
39 40
40#### 41# @ECLASS-VARIABLE: APACHE_CONFDIR
41## APACHECTL1, APACHECTL2 42# @DESCRIPTION:
42## 43# Path to the configuration file directory
43## Paths to the apachectl tools
44####
45APACHECTL1="/usr/sbin/apachectl"
46APACHECTL2="/usr/sbin/apache2ctl"
47 44
48#### 45# @ECLASS-VARIABLE: APACHE_MODULES_CONFDIR
49## APACHE1_BASEDIR, APACHE2_BASEDIR 46# @DESCRIPTION:
50## 47# Path where module configuration files are kept
51## Paths to the server root directories
52####
53APACHE1_BASEDIR="/usr/$(get_libdir)/apache"
54APACHE2_BASEDIR="/usr/$(get_libdir)/apache2"
55 48
56#### 49# @ECLASS-VARIABLE: APACHE_VHOSTS_CONFDIR
57## APACHE1_CONFDIR, APACHE2_CONFDIR 50# @DESCRIPTION:
58## 51# Path where virtual host configuration files are kept
59## Paths to the configuration file directories
60####
61APACHE1_CONFDIR="/etc/apache"
62APACHE2_CONFDIR="/etc/apache2"
63 52
64#### 53# @ECLASS-VARIABLE: APACHE_MODULESDIR
65## APACHE1_MODULES_CONFDIR, APACHE2_MODULES_CONFDIR 54# @DESCRIPTION:
66## 55# Path where we install modules
67## Paths where module configuration files are kept
68####
69APACHE1_MODULES_CONFDIR="${APACHE1_CONFDIR}/modules.d"
70APACHE2_MODULES_CONFDIR="${APACHE2_CONFDIR}/modules.d"
71 56
72#### 57# @ECLASS-VARIABLE: APACHE_DEPEND
73## APACHE1_VHOSTDIR, APACHE2_VHOSTDIR 58# @DESCRIPTION:
74## 59# Dependencies for Apache
75## Paths where virtual host configuration files are kept 60APACHE_DEPEND="www-servers/apache"
76####
77APACHE1_VHOSTDIR="${APACHE1_CONFDIR}/vhosts.d"
78APACHE2_VHOSTDIR="${APACHE2_CONFDIR}/vhosts.d"
79 61
80#### 62# @ECLASS-VARIABLE: APACHE2_DEPEND
81## APACHE1_MODULESDIR, APACHE2_MODULESDIR 63# @DESCRIPTION:
82## 64# Dependencies for Apache 2.x
83## Paths where we install modules 65APACHE2_DEPEND="=www-servers/apache-2*"
84####
85APACHE1_MODULESDIR="${APACHE1_BASEDIR}/modules"
86APACHE2_MODULESDIR="${APACHE2_BASEDIR}/modules"
87 66
88#### 67# @ECLASS-VARIABLE: APACHE2_2_DEPEND
89## APACHE1_DEPEND, APACHE2_DEPEND 68# @DESCRIPTION:
90## APACHE2_0_DEPEND, APACHE2_2_DEPEND
91##
92## Dependencies for Apache 1.x and Apache 2.x 69# Dependencies for Apache 2.2.x
93####
94APACHE1_DEPEND="=www-servers/apache-1*"
95APACHE2_DEPEND="=www-servers/apache-2*"
96APACHE2_0_DEPEND="=www-servers/apache-2.0*"
97APACHE2_2_DEPEND="=www-servers/apache-2.2*" 70APACHE2_2_DEPEND="=www-servers/apache-2.2*"
98 71
99#### 72# @ECLASS-VARIABLE: WANT_APACHE_DEPEND
100## NEED_APACHE_DEPEND 73# @DESCRIPTION:
101##
102## Dependency magic based on useflags to use the right DEPEND 74# Dependency magic based on useflag to use the right DEPEND
103## If you change this, please check the DEPENDS in need_apache() 75WANT_APACHE_DEPEND="apache2? ( ${APACHE_DEPEND} )"
104####
105 76
106NEED_APACHE_DEPEND="${APACHE2_DEPEND}" 77# @ECLASS-VARIABLE: WANT_APACHE2_DEPEND
78# @DESCRIPTION:
79# Dependency magic based on useflag to use the right DEPEND
107WANT_APACHE_DEPEND="apache2? ( ${APACHE2_DEPEND} )" 80WANT_APACHE2_DEPEND="apache2? ( ${APACHE2_DEPEND} )"
108 81
109#### 82# @ECLASS-VARIABLE: WANT_APACHE2_2_DEPEND
110# uses_apache1() - !!! DEPRECATED !!! 83# @DESCRIPTION:
111#### 84# Dependency magic based on useflag to use the right DEPEND
85WANT_APACHE2_2_DEPEND="apache2? ( ${APACHE2_2_DEPEND} )"
112 86
113uses_apache1() { 87# ==============================================================================
88# INTERNAL FUNCTIONS
89# ==============================================================================
90
91_init_apache2() {
114 debug-print-function $FUNCNAME $* 92 debug-print-function $FUNCNAME $*
115 # WARNING: Do not use these variables with anything that is put
116 # into the dependency cache (DEPEND/RDEPEND/etc)
117 APACHE_VERSION="1"
118 APXS="${APXS1}"
119 USE_APACHE2=""
120 APACHECTL="${APACHECTL1}"
121 APACHE_BASEDIR="${APACHE1_BASEDIR}"
122 APACHE_CONFDIR="${APACHE1_CONFDIR}"
123 APACHE_MODULES_CONFDIR="${APACHE1_MODULES_CONFDIR}"
124 APACHE_VHOSTSDIR="${APACHE1_VHOSTSDIR}"
125 APACHE_MODULESDIR="${APACHE1_MODULESDIR}"
126}
127 93
128####
129# uses_apache2()
130#
131# sets up all of the environment variables required by an apache2 module
132####
133
134uses_apache2() {
135 debug-print-function $FUNCNAME $*
136 # WARNING: Do not use these variables with anything that is put 94 # WARNING: Do not use these variables with anything that is put
137 # into the dependency cache (DEPEND/RDEPEND/etc) 95 # into the dependency cache (DEPEND/RDEPEND/etc)
138 APACHE_VERSION="2" 96 APACHE_VERSION="2"
139 USE_APACHE2="2" 97 APXS="/usr/sbin/apxs2"
140 APXS="${APXS2}" 98 APACHECTL="/usr/sbin/apache2ctl"
141 APACHECTL="${APACHECTL2}" 99 APACHE_BASEDIR="/usr/$(get_libdir)/apache2"
142 APACHE_BASEDIR="${APACHE2_BASEDIR}" 100 APACHE_CONFDIR="/etc/apache2"
143 APACHE_CONFDIR="${APACHE2_CONFDIR}"
144 APACHE_MODULES_CONFDIR="${APACHE2_MODULES_CONFDIR}" 101 APACHE_MODULES_CONFDIR="${APACHE_CONFDIR}/modules.d"
145 APACHE_VHOSTSDIR="${APACHE2_VHOSTSDIR}" 102 APACHE_VHOSTS_CONFDIR="${APACHE_CONFDIR}/vhosts.d"
146 APACHE_MODULESDIR="${APACHE2_MODULESDIR}" 103 APACHE_MODULESDIR="${APACHE_BASEDIR}/modules"
147} 104}
148 105
149doesnt_use_apache() { 106_init_no_apache() {
150 debug-print-function $FUNCNAME $* 107 debug-print-function $FUNCNAME $*
151 APACHE_VERSION="0" 108 APACHE_VERSION="0"
152 USE_APACHE=""
153} 109}
154 110
155#### 111# ==============================================================================
156## need_apache1 - !!! DEPRECATED !!! 112# PUBLIC FUNCTIONS
157#### 113# ==============================================================================
114
115# @FUNCTION: want_apache
116# @DESCRIPTION:
117# An ebuild calls this to get the dependency information for optional apache-2.x
118# support.
158need_apache1() { 119want_apache2() {
159 debug-print-function $FUNCNAME $* 120 debug-print-function $FUNCNAME $*
160 121
122 IUSE="${IUSE} apache2"
161 DEPEND="${DEPEND} ${APACHE1_DEPEND}" 123 DEPEND="${DEPEND} ${WANT_APACHE2_DEPEND}"
162 RDEPEND="${RDEPEND} ${APACHE1_DEPEND}" 124 RDEPEND="${RDEPEND} ${WANT_APACHE2_DEPEND}"
163 APACHE_VERSION="1" 125
126 if use apache2 ; then
127 _init_apache2
128 else
129 _init_no_apache
130 fi
164} 131}
165 132
166#### 133# @FUNCTION: want_apache
167## need_apache2 134# @DESCRIPTION:
168##
169## An ebuild calls this to get the dependency information 135# An ebuild calls this to get the dependency information for optional
170## for apache-2.x. An ebuild should use this in order for 136# apache-2.2.x support.
171## future changes to the build infrastructure to happen 137want_apache2_2() {
172## seamlessly. All an ebuild needs to do is include the 138 debug-print-function $FUNCNAME $*
173## line need_apache2 somewhere. 139
174#### 140 IUSE="${IUSE} apache2"
141 DEPEND="${DEPEND} ${WANT_APACHE2_2_DEPEND}"
142 RDEPEND="${RDEPEND} ${WANT_APACHE2_2_DEPEND}"
143
144 if use apache2 ; then
145 _init_apache2
146 else
147 _init_no_apache
148 fi
149}
150
151# @FUNCTION: want_apache
152# @DESCRIPTION:
153# An ebuild calls this to get the dependency information for optional apache
154# support.
155want_apache() {
156 want_apache2
157}
158
159# @FUNCTION: need_apache2
160# @DESCRIPTION:
161# Works like need_apache, but its used by modules that only support
162# apache 2.x and do not work with other versions.
175need_apache2() { 163need_apache2() {
176 debug-print-function $FUNCNAME $* 164 debug-print-function $FUNCNAME $*
177 165
178 DEPEND="${DEPEND} ${APACHE2_DEPEND}" 166 DEPEND="${DEPEND} ${APACHE2_DEPEND}"
179 RDEPEND="${RDEPEND} ${APACHE2_DEPEND}" 167 RDEPEND="${RDEPEND} ${APACHE2_DEPEND}"
180 APACHE_VERSION="2" 168 _init_apache2
181} 169}
182 170
183#### 171# @FUNCTION: need_apache2_2
184## need_apache2_0 172# @DESCRIPTION:
185##
186## Works like need_apache2 above, but its used by modules 173# Works like need_apache, but its used by modules that only support
187## that only support apache 2.0 and do not work with 174# apache 2.2.x and do not work with other versions.
188## higher versions.
189##
190####
191need_apache2_0() {
192 debug-print-function $FUNCNAME $*
193
194 DEPEND="${DEPEND} ${APACHE2_0_DEPEND}"
195 RDEPEND="${RDEPEND} ${APACHE2_0_DEPEND}"
196 APACHE_VERSION="2"
197}
198
199####
200## need_apache2_2
201##
202## Works like need_apache2 above, but its used by modules
203## that only support apache 2.2 and do not work with
204## lower versions.
205##
206####
207need_apache2_2() { 175need_apache2_2() {
208 debug-print-function $FUNCNAME $* 176 debug-print-function $FUNCNAME $*
209 177
210 DEPEND="${DEPEND} ${APACHE2_2_DEPEND}" 178 DEPEND="${DEPEND} ${APACHE2_2_DEPEND}"
211 RDEPEND="${RDEPEND} ${APACHE2_2_DEPEND}" 179 RDEPEND="${RDEPEND} ${APACHE2_2_DEPEND}"
212 APACHE_VERSION="2" 180 _init_apache2
213} 181}
214 182
215#### 183# @FUNCTION: need_apache
216## DO NOT CHANGE THIS FUNCTION UNLESS YOU UNDERSTAND THE CONSEQUENCES IT 184# @DESCRIPTION:
217## WILL HAVE ON THE CACHE! 185# An ebuild calls this to get the dependency information for apache. An
218## 186# ebuild should use this in order for future changes to the build infrastructure
219## This function can take a variable amount of arguments specifying the 187# to happen seamlessly. All an ebuild needs to do is include the line
220## versions of apache the ebuild supports 188# need_apache somewhere.
221##
222## If no arguments are specified, then all versions are assumed to be supported
223##
224## Currently supported versions: 2.0 2.2 2.x
225####
226need_apache() { 189need_apache() {
227 debug-print-function $FUNCNAME $*
228
229 local supports2x supports20 supports22
230
231 if [[ $# -eq 0 ]] ; then
232 supports2x="yes"
233 else
234 while [[ $# -gt 0 ]] ; do
235 case "$1" in
236 2.0) supports20="yes"; shift;;
237 2.2) supports22="yes"; shift;;
238 2.x) supports2x="yes"; shift;;
239 *) die "Unknown version specifier: $1";;
240 esac
241 done
242 fi
243
244 if [[ "${supports20}" == "yes" ]] && [[ "${supports22}" == "yes" ]] ; then
245 supports2x="yes"
246 fi
247
248 debug-print "supports20: ${supports20}"
249 debug-print "supports22: ${supports22}"
250 debug-print "supports2x: ${supports2x}"
251
252 if [[ "${supports2x}" == "yes" ]] ; then
253 need_apache2 190 need_apache2
254 elif [[ "${supports20}" == "yes" ]] ; then
255 need_apache2_0
256 elif [[ "${supports22}" == "yes" ]] ; then
257 need_apache2_2
258 fi
259
260 uses_apache2
261} 191}
262
263want_apache() {
264 debug-print-function $FUNCNAME $*
265
266 IUSE="${IUSE} apache2"
267 DEPEND="${DEPEND} ${WANT_APACHE_DEPEND}"
268 RDEPEND="${RDEPEND} ${WANT_APACHE_DEPEND}"
269 if use apache2 ; then
270 uses_apache2
271 else
272 doesnt_use_apache
273 fi
274}

Legend:
Removed from v.1.33  
changed lines
  Added in v.1.37

  ViewVC Help
Powered by ViewVC 1.1.20