/[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.34 Revision 1.39
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.34 2007/09/08 14:06:12 hollow Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/depend.apache.eclass,v 1.39 2008/02/03 14:12:44 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# ==============================================================================
100## NEED_APACHE_DEPEND 73# INTERNAL FUNCTIONS
101## 74# ==============================================================================
102## Dependency magic based on useflags to use the right DEPEND
103## If you change this, please check the DEPENDS in need_apache()
104####
105 75
106NEED_APACHE_DEPEND="${APACHE2_DEPEND}" 76_init_apache2() {
107WANT_APACHE_DEPEND="apache2? ( ${APACHE2_DEPEND} )" 77 debug-print-function $FUNCNAME $*
108 78
109#### 79 # WARNING: Do not use these variables with anything that is put
110## apr_config/apu_config 80 # into the dependency cache (DEPEND/RDEPEND/etc)
111## 81 APACHE_VERSION="2"
112## Version magic to get the correct apr-config/apu-config 82 APXS="/usr/sbin/apxs2"
113## based on the (probably) installed version of apache. 83 APACHE_BIN="/usr/sbin/apache2"
114## This is needed to get modules to link to the same apr/apu 84 APACHE_CTL="/usr/sbin/apache2ctl"
115## as apache (i.e. link 0.9 for 2.0, 1.x for 2.2) 85 # legacy alias
116#### 86 APACHECTL="${APACHE_CTL}"
117apr_config() { 87 APACHE_BASEDIR="/usr/$(get_libdir)/apache2"
118 local default="${1:-1}" 88 APACHE_CONFDIR="/etc/apache2"
119 if [[ "${USE_APACHE}" == "2" ]]; then 89 APACHE_MODULES_CONFDIR="${APACHE_CONFDIR}/modules.d"
120 if has_version ${APACHE2_0_DEPEND}; then 90 APACHE_VHOSTS_CONFDIR="${APACHE_CONFDIR}/vhosts.d"
121 echo apr-config 91 APACHE_MODULESDIR="${APACHE_BASEDIR}/modules"
122 else 92}
123 echo apr-1-config 93
124 fi 94_init_no_apache() {
95 debug-print-function $FUNCNAME $*
96 APACHE_VERSION="0"
97}
98
99# ==============================================================================
100# PUBLIC FUNCTIONS
101# ==============================================================================
102
103# @FUNCTION: want_apache
104# @DESCRIPTION:
105# An ebuild calls this to get the dependency information for optional apache-2.x
106# support.
107want_apache2() {
108 debug-print-function $FUNCNAME $*
109
110 local myiuse=${1:-apache2}
111 IUSE="${IUSE} ${myiuse}"
112 DEPEND="${DEPEND} ${myiuse}? ( ${APACHE2_DEPEND} )"
113 RDEPEND="${RDEPEND} ${myiuse}? ( ${APACHE2_DEPEND} )"
114
115 if use ${myiuse} ; then
116 _init_apache2
125 else 117 else
126 if [[ "${default}" == "0" ]]; then 118 _init_no_apache
127 echo apr-config
128 elif [[ "${default}" == "1" ]]; then
129 echo apr-1-config
130 else
131 die "Unknown version specifier: ${default}"
132 fi
133 fi 119 fi
134} 120}
135 121
136apu_config() { 122# @FUNCTION: want_apache
137 local default="${1:-1}" 123# @DESCRIPTION:
138 if [[ "${USE_APACHE}" == "2" ]]; then 124# An ebuild calls this to get the dependency information for optional
139 if has_version ${APACHE2_0_DEPEND}; then 125# apache-2.2.x support.
140 echo apu-config 126want_apache2_2() {
141 else 127 debug-print-function $FUNCNAME $*
142 echo apu-1-config 128
143 fi 129 local myiuse=${1:-apache2}
130 IUSE="${IUSE} ${myiuse}"
131 DEPEND="${DEPEND} ${myiuse}? ( ${APACHE2_2_DEPEND} )"
132 RDEPEND="${RDEPEND} ${myiuse}? ( ${APACHE2_2_DEPEND} )"
133
134 if use ${myiuse} ; then
135 _init_apache2
144 else 136 else
145 if [[ "${default}" == "0" ]]; then 137 _init_no_apache
146 echo apu-config
147 elif [[ "${default}" == "1" ]]; then
148 echo apu-1-config
149 else
150 die "Unknown version specifier: ${default}"
151 fi
152 fi 138 fi
153} 139}
154 140
155#### 141# @FUNCTION: want_apache
156# uses_apache1() - !!! DEPRECATED !!! 142# @DESCRIPTION:
157#### 143# An ebuild calls this to get the dependency information for optional apache
158 144# support.
159uses_apache1() { 145want_apache() {
160 debug-print-function $FUNCNAME $* 146 debug-print-function $FUNCNAME $*
161 # WARNING: Do not use these variables with anything that is put 147 want_apache2 "$@"
162 # into the dependency cache (DEPEND/RDEPEND/etc)
163 APACHE_VERSION="1"
164 APXS="${APXS1}"
165 USE_APACHE="1"
166 APACHECTL="${APACHECTL1}"
167 APACHE_BASEDIR="${APACHE1_BASEDIR}"
168 APACHE_CONFDIR="${APACHE1_CONFDIR}"
169 APACHE_MODULES_CONFDIR="${APACHE1_MODULES_CONFDIR}"
170 APACHE_VHOSTSDIR="${APACHE1_VHOSTSDIR}"
171 APACHE_MODULESDIR="${APACHE1_MODULESDIR}"
172} 148}
173 149
174#### 150# @FUNCTION: need_apache2
175# uses_apache2() 151# @DESCRIPTION:
176# 152# Works like need_apache, but its used by modules that only support
177# sets up all of the environment variables required by an apache2 module 153# apache 2.x and do not work with other versions.
178####
179
180uses_apache2() {
181 debug-print-function $FUNCNAME $*
182 # WARNING: Do not use these variables with anything that is put
183 # into the dependency cache (DEPEND/RDEPEND/etc)
184 APACHE_VERSION="2"
185 USE_APACHE="2"
186 APXS="${APXS2}"
187 APACHECTL="${APACHECTL2}"
188 APACHE_BASEDIR="${APACHE2_BASEDIR}"
189 APACHE_CONFDIR="${APACHE2_CONFDIR}"
190 APACHE_MODULES_CONFDIR="${APACHE2_MODULES_CONFDIR}"
191 APACHE_VHOSTSDIR="${APACHE2_VHOSTSDIR}"
192 APACHE_MODULESDIR="${APACHE2_MODULESDIR}"
193}
194
195doesnt_use_apache() {
196 debug-print-function $FUNCNAME $*
197 APACHE_VERSION="0"
198 USE_APACHE="0"
199}
200
201####
202## need_apache1 - !!! DEPRECATED !!!
203####
204need_apache1() {
205 debug-print-function $FUNCNAME $*
206
207 DEPEND="${DEPEND} ${APACHE1_DEPEND}"
208 RDEPEND="${RDEPEND} ${APACHE1_DEPEND}"
209 APACHE_VERSION="1"
210}
211
212####
213## need_apache2
214##
215## An ebuild calls this to get the dependency information
216## for apache-2.x. An ebuild should use this in order for
217## future changes to the build infrastructure to happen
218## seamlessly. All an ebuild needs to do is include the
219## line need_apache2 somewhere.
220####
221need_apache2() { 154need_apache2() {
222 debug-print-function $FUNCNAME $* 155 debug-print-function $FUNCNAME $*
223 156
224 DEPEND="${DEPEND} ${APACHE2_DEPEND}" 157 DEPEND="${DEPEND} ${APACHE2_DEPEND}"
225 RDEPEND="${RDEPEND} ${APACHE2_DEPEND}" 158 RDEPEND="${RDEPEND} ${APACHE2_DEPEND}"
226 APACHE_VERSION="2" 159 _init_apache2
227} 160}
228 161
229#### 162# @FUNCTION: need_apache2_2
230## need_apache2_0 163# @DESCRIPTION:
231##
232## Works like need_apache2 above, but its used by modules 164# Works like need_apache, but its used by modules that only support
233## that only support apache 2.0 and do not work with 165# apache 2.2.x and do not work with other versions.
234## higher versions.
235##
236####
237need_apache2_0() {
238 debug-print-function $FUNCNAME $*
239
240 DEPEND="${DEPEND} ${APACHE2_0_DEPEND}"
241 RDEPEND="${RDEPEND} ${APACHE2_0_DEPEND}"
242 APACHE_VERSION="2"
243}
244
245####
246## need_apache2_2
247##
248## Works like need_apache2 above, but its used by modules
249## that only support apache 2.2 and do not work with
250## lower versions.
251##
252####
253need_apache2_2() { 166need_apache2_2() {
254 debug-print-function $FUNCNAME $* 167 debug-print-function $FUNCNAME $*
255 168
256 DEPEND="${DEPEND} ${APACHE2_2_DEPEND}" 169 DEPEND="${DEPEND} ${APACHE2_2_DEPEND}"
257 RDEPEND="${RDEPEND} ${APACHE2_2_DEPEND}" 170 RDEPEND="${RDEPEND} ${APACHE2_2_DEPEND}"
258 APACHE_VERSION="2" 171 _init_apache2
259} 172}
260 173
261#### 174# @FUNCTION: need_apache
262## DO NOT CHANGE THIS FUNCTION UNLESS YOU UNDERSTAND THE CONSEQUENCES IT 175# @DESCRIPTION:
263## WILL HAVE ON THE CACHE! 176# An ebuild calls this to get the dependency information for apache. An
264## 177# ebuild should use this in order for future changes to the build infrastructure
265## This function can take a variable amount of arguments specifying the 178# to happen seamlessly. All an ebuild needs to do is include the line
266## versions of apache the ebuild supports 179# need_apache somewhere.
267##
268## If no arguments are specified, then all versions are assumed to be supported
269##
270## Currently supported versions: 2.0 2.2 2.x
271####
272need_apache() { 180need_apache() {
273 debug-print-function $FUNCNAME $* 181 debug-print-function $FUNCNAME $*
274
275 local supports2x supports20 supports22
276
277 if [[ $# -eq 0 ]] ; then
278 supports2x="yes"
279 else
280 while [[ $# -gt 0 ]] ; do
281 case "$1" in
282 2.0) supports20="yes"; shift;;
283 2.2) supports22="yes"; shift;;
284 2.x) supports2x="yes"; shift;;
285 *) die "Unknown version specifier: $1";;
286 esac
287 done
288 fi
289
290 if [[ "${supports20}" == "yes" ]] && [[ "${supports22}" == "yes" ]] ; then
291 supports2x="yes"
292 fi
293
294 debug-print "supports20: ${supports20}"
295 debug-print "supports22: ${supports22}"
296 debug-print "supports2x: ${supports2x}"
297
298 if [[ "${supports2x}" == "yes" ]] ; then
299 need_apache2 182 need_apache2
300 elif [[ "${supports20}" == "yes" ]] ; then
301 need_apache2_0
302 elif [[ "${supports22}" == "yes" ]] ; then
303 need_apache2_2
304 fi
305
306 uses_apache2
307} 183}
308
309want_apache() {
310 debug-print-function $FUNCNAME $*
311
312 IUSE="${IUSE} apache2"
313 DEPEND="${DEPEND} ${WANT_APACHE_DEPEND}"
314 RDEPEND="${RDEPEND} ${WANT_APACHE_DEPEND}"
315 if use apache2 ; then
316 uses_apache2
317 else
318 doesnt_use_apache
319 fi
320}

Legend:
Removed from v.1.34  
changed lines
  Added in v.1.39

  ViewVC Help
Powered by ViewVC 1.1.20