/[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.24 Revision 1.39
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.24 2005/09/19 00:21:20 vericgar 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###### 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'
25 28
26#### 29# @ECLASS-VARIABLE: APXS
27## APXS1, APXS2 30# @DESCRIPTION:
28##
29## Paths to the apxs tools 31# Paths to the apxs tool
30####
31APXS1="/usr/sbin/apxs"
32APXS2="/usr/sbin/apxs2"
33 32
34#### 33# @ECLASS-VARIABLE: APACHECTL
35## APACHECTL1, APACHECTL2 34# @DESCRIPTION:
36##
37## Paths to the apachectl tools 35# Path to the apachectl tool
38####
39APACHECTL1="/usr/sbin/apachectl"
40APACHECTL2="/usr/sbin/apache2ctl"
41 36
42#### 37# @ECLASS-VARIABLE: APACHE_BASEDIR
43## APACHE1_BASEDIR, APACHE2_BASEDIR 38# @DESCRIPTION:
44##
45## Paths to the server root directories 39# Path to the server root directory
46####
47APACHE1_BASEDIR="/usr/$(get_libdir)/apache"
48APACHE2_BASEDIR="/usr/$(get_libdir)/apache2"
49 40
50#### 41# @ECLASS-VARIABLE: APACHE_CONFDIR
51## APACHE1_CONFDIR, APACHE2_CONFDIR 42# @DESCRIPTION:
52##
53## Paths to the configuration file directories (usually under 43# Path to the configuration file directory
54## $APACHE?_BASEDIR/conf)
55####
56APACHE1_CONFDIR="/etc/apache"
57APACHE2_CONFDIR="/etc/apache2"
58 44
59#### 45# @ECLASS-VARIABLE: APACHE_MODULES_CONFDIR
60## APACHE1_MODULES_CONFDIR, APACHE2_MODULES_CONFDIR 46# @DESCRIPTION:
61##
62## Paths where module configuration files are kept 47# Path where module configuration files are kept
63####
64APACHE1_MODULES_CONFDIR="${APACHE1_CONFDIR}/modules.d"
65APACHE2_MODULES_CONFDIR="${APACHE2_CONFDIR}/modules.d"
66 48
67#### 49# @ECLASS-VARIABLE: APACHE_VHOSTS_CONFDIR
68## APACHE1_VHOSTDIR, APACHE2_VHOSTDIR 50# @DESCRIPTION:
69##
70## Paths where virtual host configuration files are kept 51# Path where virtual host configuration files are kept
71####
72APACHE1_VHOSTDIR="${APACHE1_CONFDIR}/vhosts.d"
73APACHE2_VHOSTDIR="${APACHE2_CONFDIR}/vhosts.d"
74 52
75#### 53# @ECLASS-VARIABLE: APACHE_MODULESDIR
76## APACHE1_MODULESDIR, APACHE2_MODULESDIR 54# @DESCRIPTION:
77##
78## Paths where we install modules 55# Path where we install modules
79####
80APACHE1_MODULESDIR="${APACHE1_BASEDIR}/modules"
81APACHE2_MODULESDIR="${APACHE2_BASEDIR}/modules"
82 56
83#### 57# @ECLASS-VARIABLE: APACHE_DEPEND
84## APACHE1_DEPEND, APACHE2_DEPEND 58# @DESCRIPTION:
85## 59# Dependencies for Apache
86## Dependencies for apache 1.x and 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*" 60APACHE_DEPEND="www-servers/apache"
94APACHE2_DEPEND=">=net-www/apache-2.0.54-r30"
95 61
96#### 62# @ECLASS-VARIABLE: APACHE2_DEPEND
97## APACHE_DEPEND 63# @DESCRIPTION:
98## 64# Dependencies for Apache 2.x
99## Dependency magic based on useflags to use the right DEPEND 65APACHE2_DEPEND="=www-servers/apache-2*"
100####
101 66
102NEED_APACHE_DEPEND="apache2? ( ${APACHE2_DEPEND} ) !apache2? ( ${APACHE1_DEPEND} )" 67# @ECLASS-VARIABLE: APACHE2_2_DEPEND
103WANT_APACHE_DEPEND="apache2? ( ${APACHE2_DEPEND} ) !apache2? ( apache? ( ${APACHE1_DEPEND} ) )" 68# @DESCRIPTION:
69# Dependencies for Apache 2.2.x
70APACHE2_2_DEPEND="=www-servers/apache-2.2*"
104 71
105#### 72# ==============================================================================
106# uses_apache1() 73# INTERNAL FUNCTIONS
107# 74# ==============================================================================
108# sets up all of the environment variables required by an apache1 module
109####
110 75
111uses_apache1() { 76_init_apache2() {
77 debug-print-function $FUNCNAME $*
78
79 # WARNING: Do not use these variables with anything that is put
80 # into the dependency cache (DEPEND/RDEPEND/etc)
112 APACHE_VERSION='1' 81 APACHE_VERSION="2"
113 APXS="$APXS1" 82 APXS="/usr/sbin/apxs2"
114 USE_APACHE2= 83 APACHE_BIN="/usr/sbin/apache2"
84 APACHE_CTL="/usr/sbin/apache2ctl"
85 # legacy alias
115 APACHECTL="${APACHECTL1}" 86 APACHECTL="${APACHE_CTL}"
116 APACHE_BASEDIR="${APACHE1_BASEDIR}" 87 APACHE_BASEDIR="/usr/$(get_libdir)/apache2"
117 APACHE_CONFDIR="${APACHE1_CONFDIR}" 88 APACHE_CONFDIR="/etc/apache2"
118 APACHE_MODULES_CONFDIR="${APACHE1_MODULES_CONFDIR}" 89 APACHE_MODULES_CONFDIR="${APACHE_CONFDIR}/modules.d"
119 APACHE_VHOSTSDIR="${APACHE1_VHOSTSDIR}" 90 APACHE_VHOSTS_CONFDIR="${APACHE_CONFDIR}/vhosts.d"
120 APACHE_MODULESDIR="${APACHE1_MODULESDIR}" 91 APACHE_MODULESDIR="${APACHE_BASEDIR}/modules"
121} 92}
122 93
123#### 94_init_no_apache() {
124# uses_apache2() 95 debug-print-function $FUNCNAME $*
125#
126# sets up all of the environment variables required by an apache2 module
127####
128
129uses_apache2() {
130 APACHE_VERSION='2' 96 APACHE_VERSION="0"
131 USE_APACHE2=2
132 APXS="$APXS2"
133 APACHECTL="${APACHECTL2}"
134 APACHE_BASEDIR="${APACHE2_BASEDIR}"
135 APACHE_CONFDIR="${APACHE2_CONFDIR}"
136 APACHE_MODULES_CONFDIR="${APACHE2_MODULES_CONFDIR}"
137 APACHE_VHOSTSDIR="${APACHE2_VHOSTSDIR}"
138 APACHE_MODULESDIR="${APACHE2_MODULESDIR}"
139} 97}
140 98
141doesnt_use_apache() { 99# ==============================================================================
142 APACHE_VERSION='0' 100# PUBLIC FUNCTIONS
143 USE_APACHE= 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
117 else
118 _init_no_apache
119 fi
144} 120}
145 121
146#### 122# @FUNCTION: want_apache
147## need_apache1 123# @DESCRIPTION:
148##
149## An ebuild calls this to get the dependency information 124# An ebuild calls this to get the dependency information for optional
150## for apache-1.x. An ebuild should use this in order for 125# apache-2.2.x support.
151## future changes to the build infrastructure to happen 126want_apache2_2() {
152## seamlessly. All an ebuild needs to do is include the 127 debug-print-function $FUNCNAME $*
153## line need_apache1 somewhere.
154####
155need_apache1() {
156 debug-print-function need_apache1
157 128
129 local myiuse=${1:-apache2}
130 IUSE="${IUSE} ${myiuse}"
158 DEPEND="${DEPEND} ${APACHE1_DEPEND}" 131 DEPEND="${DEPEND} ${myiuse}? ( ${APACHE2_2_DEPEND} )"
159 RDEPEND="${RDEPEND} ${APACHE1_DEPEND}" 132 RDEPEND="${RDEPEND} ${myiuse}? ( ${APACHE2_2_DEPEND} )"
160 APACHE_VERSION='1' 133
134 if use ${myiuse} ; then
135 _init_apache2
136 else
137 _init_no_apache
138 fi
161} 139}
162 140
163#### 141# @FUNCTION: want_apache
164## need_apache2 142# @DESCRIPTION:
165##
166## An ebuild calls this to get the dependency information 143# An ebuild calls this to get the dependency information for optional apache
167## for apache-2.x. An ebuild should use this in order for 144# support.
168## future changes to the build infrastructure to happen 145want_apache() {
169## seamlessly. All an ebuild needs to do is include the 146 debug-print-function $FUNCNAME $*
170## line need_apache1 somewhere. 147 want_apache2 "$@"
171#### 148}
149
150# @FUNCTION: need_apache2
151# @DESCRIPTION:
152# Works like need_apache, but its used by modules that only support
153# apache 2.x and do not work with other versions.
172need_apache2() { 154need_apache2() {
173 debug-print-function need_apache2 155 debug-print-function $FUNCNAME $*
174 156
175 DEPEND="${DEPEND} ${APACHE2_DEPEND}" 157 DEPEND="${DEPEND} ${APACHE2_DEPEND}"
176 RDEPEND="${RDEPEND} ${APACHE2_DEPEND}" 158 RDEPEND="${RDEPEND} ${APACHE2_DEPEND}"
177 APACHE_VERSION='2' 159 _init_apache2
178} 160}
179 161
180#### 162# @FUNCTION: need_apache2_2
181## DO NOT CHANGE THIS FUNCTION UNLESS YOU UNDERSTAND THE CONSEQUENCES IT 163# @DESCRIPTION:
182## WILL HAVE ON THE CACHE! There MUST be a apache2? () block in DEPEND for 164# Works like need_apache, but its used by modules that only support
183## things to work correct in the dependency calculation stage. 165# apache 2.2.x and do not work with other versions.
184####
185need_apache() { 166need_apache2_2() {
186 debug-print-function need_apache 167 debug-print-function $FUNCNAME $*
187 168
188 IUSE="${IUSE} apache2"
189 DEPEND="${DEPEND} ${NEED_APACHE_DEPEND}" 169 DEPEND="${DEPEND} ${APACHE2_2_DEPEND}"
190 RDEPEND="${RDEPEND} ${NEED_APACHE_DEPEND}" 170 RDEPEND="${RDEPEND} ${APACHE2_2_DEPEND}"
191 if useq apache2; then 171 _init_apache2
192 uses_apache2
193 else
194 uses_apache1
195 fi
196} 172}
197 173
174# @FUNCTION: need_apache
175# @DESCRIPTION:
176# An ebuild calls this to get the dependency information for apache. An
177# ebuild should use this in order for future changes to the build infrastructure
178# to happen seamlessly. All an ebuild needs to do is include the line
179# need_apache somewhere.
198want_apache() { 180need_apache() {
199 debug-print-function want_apache 181 debug-print-function $FUNCNAME $*
200 182 need_apache2
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
209 doesnt_use_apache
210 fi
211} 183}

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

  ViewVC Help
Powered by ViewVC 1.1.20