/[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.39 Revision 1.44
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.39 2008/02/03 14:12:44 hollow Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/depend.apache.eclass,v 1.44 2008/03/04 10:59:27 hollow Exp $
4 4
5# @ECLASS: depend.apache.eclass 5# @ECLASS: depend.apache.eclass
6# @MAINTAINER:
6# @MAINTAINER: apache-devs@gentoo.org 7# apache-devs@gentoo.org
7# @BLURB: Functions to allow ebuilds to depend on apache 8# @BLURB: Functions to allow ebuilds to depend on apache
8# @DESCRIPTION: 9# @DESCRIPTION:
9# This eclass handles depending on apache in a sane way and providing 10# This eclass handles depending on apache in a sane way and provides information
10# information about where certain interfaces are located. 11# about where certain binaries and configuration files are located.
11# 12#
12# @NOTE: If you use this, be sure you use the need_* call after you have defined 13# To make use of this eclass simply call one of the need/want_apache functions
14# described below. Make sure you use the need/want_apache call after you have
13# DEPEND and RDEPEND. Also note that you can not rely on the automatic 15# defined DEPEND and RDEPEND. Also note that you can not rely on the automatic
14# RDEPEND=DEPEND that portage does if you use this eclass. 16# RDEPEND=DEPEND that portage does if you use this eclass.
15# 17#
16# See bug 107127 for more information. 18# See Bug 107127 for more information.
19#
20# @EXAMPLE:
21#
22# Here is an example of an ebuild depending on apache:
23#
24# @CODE
25# DEPEND="virtual/Perl-CGI"
26# RDEPEND="${DEPEND}"
27# need_apache2
28# @CODE
29#
30# Another example which demonstrates non-standard IUSE options for optional
31# apache support:
32#
33# @CODE
34# DEPEND="server? ( virtual/Perl-CGI )"
35# RDEPEND="${DEPEND}"
36# want_apache2 server
37# @CODE
17 38
18inherit multilib 39inherit multilib
19 40
20# ============================================================================== 41# ==============================================================================
21# INTERNAL VARIABLES 42# INTERNAL VARIABLES
22# ============================================================================== 43# ==============================================================================
23 44
24# @ECLASS-VARIABLE: APACHE_VERSION 45# @ECLASS-VARIABLE: APACHE_VERSION
25# @DESCRIPTION: 46# @DESCRIPTION:
26# Stores the version of apache we are going to be ebuilding. This variable is 47# Stores the version of apache we are going to be ebuilding.
27# set by the need_apache functions. 48# This variable is set by the want/need_apache functions.
28 49
29# @ECLASS-VARIABLE: APXS 50# @ECLASS-VARIABLE: APXS
30# @DESCRIPTION: 51# @DESCRIPTION:
31# Paths to the apxs tool 52# Path to the apxs tool.
53# This variable is set by the want/need_apache functions.
32 54
55# @ECLASS-VARIABLE: APACHE_BIN
56# @DESCRIPTION:
57# Path to the apache binary.
58# This variable is set by the want/need_apache functions.
59
33# @ECLASS-VARIABLE: APACHECTL 60# @ECLASS-VARIABLE: APACHE_CTL
34# @DESCRIPTION: 61# @DESCRIPTION:
35# Path to the apachectl tool 62# Path to the apachectl tool.
63# This variable is set by the want/need_apache functions.
36 64
37# @ECLASS-VARIABLE: APACHE_BASEDIR 65# @ECLASS-VARIABLE: APACHE_BASEDIR
38# @DESCRIPTION: 66# @DESCRIPTION:
39# Path to the server root directory 67# Path to the server root directory.
68# This variable is set by the want/need_apache functions.
40 69
41# @ECLASS-VARIABLE: APACHE_CONFDIR 70# @ECLASS-VARIABLE: APACHE_CONFDIR
42# @DESCRIPTION: 71# @DESCRIPTION:
43# Path to the configuration file directory 72# Path to the configuration file directory.
73# This variable is set by the want/need_apache functions.
44 74
45# @ECLASS-VARIABLE: APACHE_MODULES_CONFDIR 75# @ECLASS-VARIABLE: APACHE_MODULES_CONFDIR
46# @DESCRIPTION: 76# @DESCRIPTION:
47# Path where module configuration files are kept 77# Path where module configuration files are kept.
78# This variable is set by the want/need_apache functions.
48 79
49# @ECLASS-VARIABLE: APACHE_VHOSTS_CONFDIR 80# @ECLASS-VARIABLE: APACHE_VHOSTS_CONFDIR
50# @DESCRIPTION: 81# @DESCRIPTION:
51# Path where virtual host configuration files are kept 82# Path where virtual host configuration files are kept.
83# This variable is set by the want/need_apache functions.
52 84
53# @ECLASS-VARIABLE: APACHE_MODULESDIR 85# @ECLASS-VARIABLE: APACHE_MODULESDIR
54# @DESCRIPTION: 86# @DESCRIPTION:
55# Path where we install modules 87# Path where we install modules.
88# This variable is set by the want/need_apache functions.
56 89
57# @ECLASS-VARIABLE: APACHE_DEPEND 90# @ECLASS-VARIABLE: APACHE_DEPEND
58# @DESCRIPTION: 91# @DESCRIPTION:
59# Dependencies for Apache 92# Dependencies for Apache
60APACHE_DEPEND="www-servers/apache" 93APACHE_DEPEND="www-servers/apache"
80 # into the dependency cache (DEPEND/RDEPEND/etc) 113 # into the dependency cache (DEPEND/RDEPEND/etc)
81 APACHE_VERSION="2" 114 APACHE_VERSION="2"
82 APXS="/usr/sbin/apxs2" 115 APXS="/usr/sbin/apxs2"
83 APACHE_BIN="/usr/sbin/apache2" 116 APACHE_BIN="/usr/sbin/apache2"
84 APACHE_CTL="/usr/sbin/apache2ctl" 117 APACHE_CTL="/usr/sbin/apache2ctl"
85 # legacy alias 118 APACHE_INCLUDEDIR="/usr/include/apache2"
86 APACHECTL="${APACHE_CTL}"
87 APACHE_BASEDIR="/usr/$(get_libdir)/apache2" 119 APACHE_BASEDIR="/usr/$(get_libdir)/apache2"
88 APACHE_CONFDIR="/etc/apache2" 120 APACHE_CONFDIR="/etc/apache2"
89 APACHE_MODULES_CONFDIR="${APACHE_CONFDIR}/modules.d" 121 APACHE_MODULES_CONFDIR="${APACHE_CONFDIR}/modules.d"
90 APACHE_VHOSTS_CONFDIR="${APACHE_CONFDIR}/vhosts.d" 122 APACHE_VHOSTS_CONFDIR="${APACHE_CONFDIR}/vhosts.d"
91 APACHE_MODULESDIR="${APACHE_BASEDIR}/modules" 123 APACHE_MODULESDIR="${APACHE_BASEDIR}/modules"
99# ============================================================================== 131# ==============================================================================
100# PUBLIC FUNCTIONS 132# PUBLIC FUNCTIONS
101# ============================================================================== 133# ==============================================================================
102 134
103# @FUNCTION: want_apache 135# @FUNCTION: want_apache
136# @USAGE: [myiuse]
137# @DESCRIPTION:
138# An ebuild calls this to get the dependency information for optional apache
139# support. If the myiuse parameter is not given it defaults to apache2.
140want_apache() {
141 debug-print-function $FUNCNAME $*
142 want_apache2 "$@"
143}
144
145# @FUNCTION: want_apache2
146# @USAGE: [myiuse]
104# @DESCRIPTION: 147# @DESCRIPTION:
105# An ebuild calls this to get the dependency information for optional apache-2.x 148# An ebuild calls this to get the dependency information for optional apache-2.x
106# support. 149# support. If the myiuse parameter is not given it defaults to apache2.
107want_apache2() { 150want_apache2() {
108 debug-print-function $FUNCNAME $* 151 debug-print-function $FUNCNAME $*
109 152
110 local myiuse=${1:-apache2} 153 local myiuse=${1:-apache2}
111 IUSE="${IUSE} ${myiuse}" 154 IUSE="${IUSE} ${myiuse}"
112 DEPEND="${DEPEND} ${myiuse}? ( ${APACHE2_DEPEND} )" 155 DEPEND="${DEPEND} ${myiuse}? ( ${APACHE2_DEPEND} )"
113 RDEPEND="${RDEPEND} ${myiuse}? ( ${APACHE2_DEPEND} )" 156 RDEPEND="${RDEPEND} ${myiuse}? ( ${APACHE2_DEPEND} )"
114 157
115 if use ${myiuse} ; then 158 if use ${myiuse}; then
116 _init_apache2 159 _init_apache2
117 else 160 else
118 _init_no_apache 161 _init_no_apache
119 fi 162 fi
120} 163}
121 164
122# @FUNCTION: want_apache 165# @FUNCTION: want_apache2_2
166# @USAGE: [myiuse]
123# @DESCRIPTION: 167# @DESCRIPTION:
124# An ebuild calls this to get the dependency information for optional 168# An ebuild calls this to get the dependency information for optional
125# apache-2.2.x support. 169# apache-2.2.x support. If the myiuse parameter is not given it defaults to
170# apache2.
126want_apache2_2() { 171want_apache2_2() {
127 debug-print-function $FUNCNAME $* 172 debug-print-function $FUNCNAME $*
128 173
129 local myiuse=${1:-apache2} 174 local myiuse=${1:-apache2}
130 IUSE="${IUSE} ${myiuse}" 175 IUSE="${IUSE} ${myiuse}"
131 DEPEND="${DEPEND} ${myiuse}? ( ${APACHE2_2_DEPEND} )" 176 DEPEND="${DEPEND} ${myiuse}? ( ${APACHE2_2_DEPEND} )"
132 RDEPEND="${RDEPEND} ${myiuse}? ( ${APACHE2_2_DEPEND} )" 177 RDEPEND="${RDEPEND} ${myiuse}? ( ${APACHE2_2_DEPEND} )"
133 178
134 if use ${myiuse} ; then 179 if use ${myiuse}; then
135 _init_apache2 180 _init_apache2
136 else 181 else
137 _init_no_apache 182 _init_no_apache
138 fi 183 fi
139} 184}
140 185
141# @FUNCTION: want_apache 186# @FUNCTION: need_apache
142# @DESCRIPTION: 187# @DESCRIPTION:
143# An ebuild calls this to get the dependency information for optional apache 188# An ebuild calls this to get the dependency information for apache.
144# support.
145want_apache() { 189need_apache() {
146 debug-print-function $FUNCNAME $* 190 debug-print-function $FUNCNAME $*
147 want_apache2 "$@" 191 need_apache2
148} 192}
149 193
150# @FUNCTION: need_apache2 194# @FUNCTION: need_apache2
151# @DESCRIPTION: 195# @DESCRIPTION:
152# Works like need_apache, but its used by modules that only support 196# An ebuild calls this to get the dependency information for apache-2.x.
153# apache 2.x and do not work with other versions.
154need_apache2() { 197need_apache2() {
155 debug-print-function $FUNCNAME $* 198 debug-print-function $FUNCNAME $*
156 199
157 DEPEND="${DEPEND} ${APACHE2_DEPEND}" 200 DEPEND="${DEPEND} ${APACHE2_DEPEND}"
158 RDEPEND="${RDEPEND} ${APACHE2_DEPEND}" 201 RDEPEND="${RDEPEND} ${APACHE2_DEPEND}"
159 _init_apache2 202 _init_apache2
160} 203}
161 204
162# @FUNCTION: need_apache2_2 205# @FUNCTION: need_apache2_2
163# @DESCRIPTION: 206# @DESCRIPTION:
164# Works like need_apache, but its used by modules that only support 207# An ebuild calls this to get the dependency information for apache-2.2.x.
165# apache 2.2.x and do not work with other versions.
166need_apache2_2() { 208need_apache2_2() {
167 debug-print-function $FUNCNAME $* 209 debug-print-function $FUNCNAME $*
168 210
169 DEPEND="${DEPEND} ${APACHE2_2_DEPEND}" 211 DEPEND="${DEPEND} ${APACHE2_2_DEPEND}"
170 RDEPEND="${RDEPEND} ${APACHE2_2_DEPEND}" 212 RDEPEND="${RDEPEND} ${APACHE2_2_DEPEND}"
171 _init_apache2 213 _init_apache2
172} 214}
173 215
174# @FUNCTION: need_apache 216# @FUNCTION: has_apache
175# @DESCRIPTION: 217# @DESCRIPTION:
176# An ebuild calls this to get the dependency information for apache. An 218# An ebuild calls this to get runtime variables for an indirect apache
177# ebuild should use this in order for future changes to the build infrastructure 219# dependency without USE-flag, in which case want_apache does not work.
178# to happen seamlessly. All an ebuild needs to do is include the line 220# DO NOT call this function in global scope.
179# need_apache somewhere.
180need_apache() { 221has_apache() {
181 debug-print-function $FUNCNAME $* 222 debug-print-function $FUNCNAME $*
182 need_apache2 223
224 if has_version '>=www-servers/apache-2'; then
225 _init_apache2
226 else
227 _init_no_apache
228 fi
183} 229}
230
231# @FUNCTION: has_apache_threads
232# @USAGE: [myflag]
233# @DESCRIPTION:
234# An ebuild calls this to make sure thread-safety is enabled if apache has been
235# built with a threaded MPM. If the myflag parameter is not given it defaults to
236# threads.
237has_apache_threads() {
238 debug-print-function $FUNCNAME $*
239
240 if ! built_with_use www-servers/apache threads; then
241 return
242 fi
243
244 local myflag="${1:-threads}"
245
246 if ! use ${myflag}; then
247 echo
248 eerror "You need to enable USE flag '${myflag}' to build a thread-safe version"
249 eerror "of ${CATEGORY}/${PN} for use with www-servers/apache"
250 die "Need missing USE flag '${myflag}'"
251 fi
252}
253
254# @FUNCTION: has_apache_threads_in
255# @USAGE: <myforeign> [myflag]
256# @DESCRIPTION:
257# An ebuild calls this to make sure thread-safety is enabled in a foreign
258# package if apache has been built with a threaded MPM. If the myflag parameter
259# is not given it defaults to threads.
260has_apache_threads_in() {
261 debug-print-function $FUNCNAME $*
262
263 if ! built_with_use www-servers/apache threads; then
264 return
265 fi
266
267 local myforeign="$1"
268 local myflag="${2:-threads}"
269
270 if ! built_with_use ${myforeign} ${myflag}; then
271 echo
272 eerror "You need to enable USE flag '${myflag}' in ${myforeign} to"
273 eerror "build a thread-safe version of ${CATEGORY}/${PN} for use"
274 eerror "with www-servers/apache"
275 die "Need missing USE flag '${myflag}' in ${myforeign}"
276 fi
277}

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

  ViewVC Help
Powered by ViewVC 1.1.20