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

Legend:
Removed from v.1.23  
changed lines
  Added in v.1.38

  ViewVC Help
Powered by ViewVC 1.1.20