/[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.1.1.1 Revision 1.35
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.1.1.1 2005/11/30 09:59:27 chriswhite Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/depend.apache.eclass,v 1.35 2007/11/25 14:27:52 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###### 20# ==============================================================================
8## Apache Common Variables 21# INTERNAL VARIABLES
9## 22# ==============================================================================
10## These are internal variables used by this, and other apache-related eclasses,
11## and thus should not need to be used by the ebuilds themselves (the ebuilds
12## should know what version of Apache they are building against).
13######
14 23
15#### 24# @ECLASS-VARIABLE: APACHE_VERSION
16## APACHE_VERSION 25# @DESCRIPTION:
17##
18## Stores the version of apache we are going to be ebuilding. This variable is 26# Stores the version of apache we are going to be ebuilding. This variable is
19## set by the need_apache{|1|2} functions. 27# set by the need_apache functions.
20##
21## This needs to stay as '1' until apache2 is on by default -- although it
22## doesn't matter much as it's set by the need_apache functions.
23####
24APACHE_VERSION='1' 28#APACHE_VERSION="2"
25 29
26#### 30# @ECLASS-VARIABLE: APXS2
27## APXS1, APXS2 31# @DESCRIPTION:
28##
29## Paths to the apxs tools 32# Paths to the apxs tool
30####
31APXS1="/usr/sbin/apxs"
32APXS2="/usr/sbin/apxs2" 33APXS2="/usr/sbin/apxs2"
33 34
34#### 35# @ECLASS-VARIABLE: APACHECTL2
35## APACHECTL1, APACHECTL2 36# @DESCRIPTION:
36##
37## Paths to the apachectl tools 37# Path to the apachectl tool
38####
39APACHECTL1="/usr/sbin/apachectl"
40APACHECTL2="/usr/sbin/apache2ctl" 38APACHECTL2="/usr/sbin/apache2ctl"
41 39
42#### 40# @ECLASS-VARIABLE: APACHE2_BASEDIR
43## APACHE1_BASEDIR, APACHE2_BASEDIR 41# @DESCRIPTION:
44##
45## Paths to the server root directories 42# Path to the server root directory
46####
47APACHE1_BASEDIR="/usr/$(get_libdir)/apache"
48APACHE2_BASEDIR="/usr/$(get_libdir)/apache2" 43APACHE2_BASEDIR="/usr/$(get_libdir)/apache2"
49 44
50#### 45# @ECLASS-VARIABLE: APACHE2_CONFDIR
51## APACHE1_CONFDIR, APACHE2_CONFDIR 46# @DESCRIPTION:
52##
53## Paths to the configuration file directories (usually under 47# Path to the configuration file directory
54## $APACHE?_BASEDIR/conf)
55####
56APACHE1_CONFDIR="/etc/apache"
57APACHE2_CONFDIR="/etc/apache2" 48APACHE2_CONFDIR="/etc/apache2"
58 49
59#### 50# @ECLASS-VARIABLE: APACHE2_MODULES_CONFDIR
60## APACHE1_MODULES_CONFDIR, APACHE2_MODULES_CONFDIR 51# @DESCRIPTION:
61##
62## Paths where module configuration files are kept 52# Path where module configuration files are kept
63####
64APACHE1_MODULES_CONFDIR="${APACHE1_CONFDIR}/modules.d"
65APACHE2_MODULES_CONFDIR="${APACHE2_CONFDIR}/modules.d" 53APACHE2_MODULES_CONFDIR="${APACHE2_CONFDIR}/modules.d"
66 54
67#### 55# @ECLASS-VARIABLE: APACHE2_VHOSTDIR
68## APACHE1_VHOSTDIR, APACHE2_VHOSTDIR 56# @DESCRIPTION:
69##
70## Paths where virtual host configuration files are kept 57# Path where virtual host configuration files are kept
71####
72APACHE1_VHOSTDIR="${APACHE1_CONFDIR}/vhosts.d"
73APACHE2_VHOSTDIR="${APACHE2_CONFDIR}/vhosts.d" 58APACHE2_VHOSTDIR="${APACHE2_CONFDIR}/vhosts.d"
74 59
75#### 60# @ECLASS-VARIABLE: APACHE2_MODULESDIR
76## APACHE1_MODULESDIR, APACHE2_MODULESDIR 61# @DESCRIPTION:
77##
78## Paths where we install modules 62# Path where we install modules
79####
80APACHE1_MODULESDIR="${APACHE1_BASEDIR}/modules"
81APACHE2_MODULESDIR="${APACHE2_BASEDIR}/modules" 63APACHE2_MODULESDIR="${APACHE2_BASEDIR}/modules"
82 64
83#### 65# @ECLASS-VARIABLE: APACHE2_DEPEND
84## APACHE1_DEPEND, APACHE2_DEPEND 66# @DESCRIPTION:
85##
86## Dependencies for apache 1.x and apache 2.x 67# Dependencies for Apache 2.x
87## - apache2 must be at least version 2.0.54-r30, this is lowest version
88## containing our new overall changes -- trapni (Jan 21 2005)
89## - apache1 must be at least version 1.3.33-r10, but how to
90## define the DEPEND here? (FIXME) -- trapni (Jan 21 2005)
91## - currently not possible - bug #4315 -- vericgar (Jan 21 2005)
92####
93APACHE1_DEPEND="=net-www/apache-1*" 68APACHE2_DEPEND="=www-servers/apache-2*"
94APACHE2_DEPEND=">=net-www/apache-2.0.54-r30"
95 69
96#### 70# @ECLASS-VARIABLE: APACHE2_0_DEPEND
97## APACHE_DEPEND 71# @DESCRIPTION:
98## 72# Dependencies for Apache 2.0.x
73APACHE2_0_DEPEND="=www-servers/apache-2.0*"
74
75# @ECLASS-VARIABLE: APACHE2_2_DEPEND
76# @DESCRIPTION:
77# Dependencies for Apache 2.2.x
78APACHE2_2_DEPEND="=www-servers/apache-2.2*"
79
80# @ECLASS-VARIABLE: WANT_APACHE_DEPEND
81# @DESCRIPTION:
99## Dependency magic based on useflags to use the right DEPEND 82# Dependency magic based on useflag to use the right DEPEND
100#### 83WANT_APACHE_DEPEND="apache2? ( ${APACHE2_DEPEND} )"
101 84
102NEED_APACHE_DEPEND="apache2? ( ${APACHE2_DEPEND} ) !apache2? ( ${APACHE1_DEPEND} )" 85# ==============================================================================
103WANT_APACHE_DEPEND="apache2? ( ${APACHE2_DEPEND} ) !apache2? ( apache? ( ${APACHE1_DEPEND} ) )" 86# INTERNAL FUNCTIONS
87# ==============================================================================
104 88
105#### 89# @FUNCTION: uses_apache2
106# uses_apache1() 90# @DESCRIPTION:
107#
108# sets up all of the environment variables required by an apache1 module
109####
110
111uses_apache1() {
112 APACHE_VERSION='1'
113 APXS="$APXS1"
114 USE_APACHE2=
115 APACHECTL="${APACHECTL1}"
116 APACHE_BASEDIR="${APACHE1_BASEDIR}"
117 APACHE_CONFDIR="${APACHE1_CONFDIR}"
118 APACHE_MODULES_CONFDIR="${APACHE1_MODULES_CONFDIR}"
119 APACHE_VHOSTSDIR="${APACHE1_VHOSTSDIR}"
120 APACHE_MODULESDIR="${APACHE1_MODULESDIR}"
121}
122
123####
124# uses_apache2()
125#
126# sets up all of the environment variables required by an apache2 module 91# sets up all of the environment variables required for an apache2 module
127####
128
129uses_apache2() { 92uses_apache2() {
93 debug-print-function $FUNCNAME $*
94
95 # WARNING: Do not use these variables with anything that is put
96 # into the dependency cache (DEPEND/RDEPEND/etc)
130 APACHE_VERSION='2' 97 APACHE_VERSION="2"
131 USE_APACHE2=2 98 USE_APACHE="2"
132 APXS="$APXS2" 99 APXS="${APXS2}"
133 APACHECTL="${APACHECTL2}" 100 APACHECTL="${APACHECTL2}"
134 APACHE_BASEDIR="${APACHE2_BASEDIR}" 101 APACHE_BASEDIR="${APACHE2_BASEDIR}"
135 APACHE_CONFDIR="${APACHE2_CONFDIR}" 102 APACHE_CONFDIR="${APACHE2_CONFDIR}"
136 APACHE_MODULES_CONFDIR="${APACHE2_MODULES_CONFDIR}" 103 APACHE_MODULES_CONFDIR="${APACHE2_MODULES_CONFDIR}"
137 APACHE_VHOSTSDIR="${APACHE2_VHOSTSDIR}" 104 APACHE_VHOSTSDIR="${APACHE2_VHOSTSDIR}"
138 APACHE_MODULESDIR="${APACHE2_MODULESDIR}" 105 APACHE_MODULESDIR="${APACHE2_MODULESDIR}"
139} 106}
140 107
108# @FUNCTION: doesnt_use_apache
109# @DESCRIPTION:
110# sets up all of the environment variables required for optional apache usage
141doesnt_use_apache() { 111doesnt_use_apache() {
112 debug-print-function $FUNCNAME $*
113
142 APACHE_VERSION='0' 114 APACHE_VERSION="0"
143 USE_APACHE= 115 USE_APACHE="0"
144} 116}
145 117
146#### 118# ==============================================================================
147## need_apache1 119# PUBLIC FUNCTIONS
148## 120# ==============================================================================
121
122# @FUNCTION: want_apache
123# @DESCRIPTION:
149## An ebuild calls this to get the dependency information 124# An ebuild calls this to get the dependency information for optional apache-2.x
150## for apache-1.x. An ebuild should use this in order for 125# support.
151## future changes to the build infrastructure to happen
152## seamlessly. All an ebuild needs to do is include the
153## line need_apache1 somewhere.
154####
155need_apache1() {
156 debug-print-function need_apache1
157
158 DEPEND="${DEPEND} ${APACHE1_DEPEND}"
159 RDEPEND="${RDEPEND} ${APACHE1_DEPEND}"
160 APACHE_VERSION='1'
161}
162
163####
164## need_apache2
165##
166## An ebuild calls this to get the dependency information
167## for apache-2.x. An ebuild should use this in order for
168## future changes to the build infrastructure to happen
169## seamlessly. All an ebuild needs to do is include the
170## line need_apache1 somewhere.
171####
172need_apache2() {
173 debug-print-function need_apache2
174
175 DEPEND="${DEPEND} ${APACHE2_DEPEND}"
176 RDEPEND="${RDEPEND} ${APACHE2_DEPEND}"
177 APACHE_VERSION='2'
178}
179
180####
181## DO NOT CHANGE THIS FUNCTION UNLESS YOU UNDERSTAND THE CONSEQUENCES IT
182## WILL HAVE ON THE CACHE! There MUST be a apache2? () block in DEPEND for
183## things to work correct in the dependency calculation stage.
184####
185need_apache() { 126want_apache() {
186 debug-print-function need_apache 127 debug-print-function $FUNCNAME $*
187 128
188 IUSE="${IUSE} apache2" 129 IUSE="${IUSE} apache2"
189 DEPEND="${DEPEND} ${NEED_APACHE_DEPEND}" 130 DEPEND="${DEPEND} ${WANT_APACHE_DEPEND}"
190 RDEPEND="${RDEPEND} ${NEED_APACHE_DEPEND}" 131 RDEPEND="${RDEPEND} ${WANT_APACHE_DEPEND}"
132
191 if useq apache2; then 133 if use apache2 ; then
192 uses_apache2 134 uses_apache2
193 else
194 uses_apache1
195 fi
196}
197
198want_apache() {
199 debug-print-function want_apache
200
201 IUSE="${IUSE} apache apache2"
202 DEPEND="${DEPEND} ${WANT_APACHE_DEPEND}"
203 RDEPEND="${DEPEND} ${WANT_APACHE_DEPEND}"
204 if useq apache2 ; then
205 uses_apache2
206 elif useq apache ; then
207 uses_apache1
208 else 135 else
209 doesnt_use_apache 136 doesnt_use_apache
210 fi 137 fi
211} 138}
139
140# @FUNCTION: need_apache2
141# @DESCRIPTION:
142# An ebuild calls this to get the dependency information for apache-2.x. An
143# ebuild should use this in order for future changes to the build infrastructure
144# to happen seamlessly. All an ebuild needs to do is include the line
145# need_apache2 somewhere.
146need_apache2() {
147 debug-print-function $FUNCNAME $*
148
149 DEPEND="${DEPEND} ${APACHE2_DEPEND}"
150 RDEPEND="${RDEPEND} ${APACHE2_DEPEND}"
151 uses_apache2
152}
153
154# @FUNCTION: need_apache2_0
155# @DESCRIPTION:
156# Works like need_apache2 above, but its used by modules that only support
157# apache 2.0 and do not work with higher versions.
158need_apache2_0() {
159 debug-print-function $FUNCNAME $*
160
161 DEPEND="${DEPEND} ${APACHE2_0_DEPEND}"
162 RDEPEND="${RDEPEND} ${APACHE2_0_DEPEND}"
163 uses_apache2
164}
165
166# @FUNCTION: need_apache2_2
167# @DESCRIPTION:
168# Works like need_apache2 above, but its used by modules that only support
169# apache 2.2 and do not work with lower versions.
170need_apache2_2() {
171 debug-print-function $FUNCNAME $*
172
173 DEPEND="${DEPEND} ${APACHE2_2_DEPEND}"
174 RDEPEND="${RDEPEND} ${APACHE2_2_DEPEND}"
175 uses_apache2
176}
177
178# @FUNCTION: need_apache
179# @DESCRIPTION:
180# Legacy alias for need_apache2
181need_apache() {
182 need_apache2
183}
184
185# @FUNCTION: apr_config
186# @DESCRIPTION:
187# Version magic to get the correct apr-config binary based on the (probably)
188# installed version of apache. This is needed to get modules to link to the
189# same apr/apu as apache (i.e. link 0.9 for 2.0, 1.x for 2.2)
190apr_config() {
191 debug-print-function $FUNCNAME $*
192
193 local default="${1:-1}"
194 if [[ "${USE_APACHE}" == "2" ]]; then
195 if has_version ${APACHE2_0_DEPEND}; then
196 echo apr-config
197 else
198 echo apr-1-config
199 fi
200 else
201 if [[ "${default}" == "0" ]]; then
202 echo apr-config
203 elif [[ "${default}" == "1" ]]; then
204 echo apr-1-config
205 else
206 die "Unknown version specifier: ${default}"
207 fi
208 fi
209}
210
211# @FUNCTION: apu_config
212# @DESCRIPTION:
213# Version magic to get the correct apu-config binary based on the (probably)
214# installed version of apache. This is needed to get modules to link to the
215# same apr/apu as apache (i.e. link 0.9 for 2.0, 1.x for 2.2)
216apu_config() {
217 debug-print-function $FUNCNAME $*
218
219 local default="${1:-1}"
220 if [[ "${USE_APACHE}" == "2" ]]; then
221 if has_version ${APACHE2_0_DEPEND}; then
222 echo apu-config
223 else
224 echo apu-1-config
225 fi
226 else
227 if [[ "${default}" == "0" ]]; then
228 echo apu-config
229 elif [[ "${default}" == "1" ]]; then
230 echo apu-1-config
231 else
232 die "Unknown version specifier: ${default}"
233 fi
234 fi
235}

Legend:
Removed from v.1.1.1.1  
changed lines
  Added in v.1.35

  ViewVC Help
Powered by ViewVC 1.1.20