gentoo-x86/eclass/depend.apache.eclass

# Copyright 1999-2012 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
# $Header: /var/cvsroot/gentoo-x86/eclass/depend.apache.eclass,v 1.46 2012/04/20 07:19:49 patrick Exp $

# @ECLASS: depend.apache.eclass
# @MAINTAINER:
# apache-devs@gentoo.org
# @BLURB: Functions to allow ebuilds to depend on apache
# @DESCRIPTION:
# This eclass handles depending on apache in a sane way and provides information
# about where certain binaries and configuration files are located.
#
# To make use of this eclass simply call one of the need/want_apache functions
# described below. Make sure you use the need/want_apache call after you have
# defined DEPEND and RDEPEND. Also note that you can not rely on the automatic
# RDEPEND=DEPEND that portage does if you use this eclass.
#
# See Bug 107127 for more information.
#
# @EXAMPLE:
#
# Here is an example of an ebuild depending on apache:
#
# @CODE
# DEPEND="virtual/Perl-CGI"
# RDEPEND="${DEPEND}"
# need_apache2
# @CODE
#
# Another example which demonstrates non-standard IUSE options for optional
# apache support:
#
# @CODE
# DEPEND="server? ( virtual/Perl-CGI )"
# RDEPEND="${DEPEND}"
# want_apache2 server
#
# pkg_setup() {
#       depend.apache_pkg_setup server
# }
# @CODE

inherit multilib

# ==============================================================================
# INTERNAL VARIABLES
# ==============================================================================

# @ECLASS-VARIABLE: APACHE_VERSION
# @DESCRIPTION:
# Stores the version of apache we are going to be ebuilding.
# This variable is set by the want/need_apache functions.

# @ECLASS-VARIABLE: APXS
# @DESCRIPTION:
# Path to the apxs tool.
# This variable is set by the want/need_apache functions.

# @ECLASS-VARIABLE: APACHE_BIN
# @DESCRIPTION:
# Path to the apache binary.
# This variable is set by the want/need_apache functions.

# @ECLASS-VARIABLE: APACHE_CTL
# @DESCRIPTION:
# Path to the apachectl tool.
# This variable is set by the want/need_apache functions.

# @ECLASS-VARIABLE: APACHE_BASEDIR
# @DESCRIPTION:
# Path to the server root directory.
# This variable is set by the want/need_apache functions.

# @ECLASS-VARIABLE: APACHE_CONFDIR
# @DESCRIPTION:
# Path to the configuration file directory.
# This variable is set by the want/need_apache functions.

# @ECLASS-VARIABLE: APACHE_MODULES_CONFDIR
# @DESCRIPTION:
# Path where module configuration files are kept.
# This variable is set by the want/need_apache functions.

# @ECLASS-VARIABLE: APACHE_VHOSTS_CONFDIR
# @DESCRIPTION:
# Path where virtual host configuration files are kept.
# This variable is set by the want/need_apache functions.

# @ECLASS-VARIABLE: APACHE_MODULESDIR
# @DESCRIPTION:
# Path where we install modules.
# This variable is set by the want/need_apache functions.

# @ECLASS-VARIABLE: APACHE_DEPEND
# @DESCRIPTION:
# Dependencies for Apache
APACHE_DEPEND="www-servers/apache"

# @ECLASS-VARIABLE: APACHE2_DEPEND
# @DESCRIPTION:
# Dependencies for Apache 2.x
APACHE2_DEPEND="=www-servers/apache-2*"

# @ECLASS-VARIABLE: APACHE2_2_DEPEND
# @DESCRIPTION:
# Dependencies for Apache 2.2.x
APACHE2_2_DEPEND="=www-servers/apache-2.2*"

# @ECLASS-VARIABLE: APACHE2_4_DEPEND
# @DESCRIPTION:
# Dependencies for Apache 2.4.x
APACHE2_4_DEPEND="=www-servers/apache-2.4*"


# ==============================================================================
# INTERNAL FUNCTIONS
# ==============================================================================

_init_apache2() {
        debug-print-function $FUNCNAME $*

        # WARNING: Do not use these variables with anything that is put
        # into the dependency cache (DEPEND/RDEPEND/etc)
        APACHE_VERSION="2"
        APXS="/usr/sbin/apxs2"
        APACHE_BIN="/usr/sbin/apache2"
        APACHE_CTL="/usr/sbin/apache2ctl"
        APACHE_INCLUDEDIR="/usr/include/apache2"
        APACHE_BASEDIR="/usr/$(get_libdir)/apache2"
        APACHE_CONFDIR="/etc/apache2"
        APACHE_MODULES_CONFDIR="${APACHE_CONFDIR}/modules.d"
        APACHE_VHOSTS_CONFDIR="${APACHE_CONFDIR}/vhosts.d"
        APACHE_MODULESDIR="${APACHE_BASEDIR}/modules"
}

_init_no_apache() {
        debug-print-function $FUNCNAME $*
        APACHE_VERSION="0"
}

# ==============================================================================
# PUBLIC FUNCTIONS
# ==============================================================================

# @FUNCTION: depend.apache_pkg_setup
# @USAGE: [myiuse]
# @DESCRIPTION:
# An ebuild calls this in pkg_setup() to initialize variables for optional
# apache-2.x support. If the myiuse parameter is not given it defaults to
# apache2.
depend.apache_pkg_setup() {
        debug-print-function $FUNCNAME $*

        if [[ "${EBUILD_PHASE}" != "setup" ]]; then
                die "$FUNCNAME() should be called in pkg_setup()"
        fi

        local myiuse=${1:-apache2}
        if has ${myiuse} ${IUSE}; then
                if use ${myiuse}; then
                        _init_apache2
                else
                        _init_no_apache
                fi
        fi
}

# @FUNCTION: want_apache
# @USAGE: [myiuse]
# @DESCRIPTION:
# An ebuild calls this to get the dependency information for optional apache
# support. If the myiuse parameter is not given it defaults to apache2.
# An ebuild should additionally call depend.apache_pkg_setup() in pkg_setup()
# with the same myiuse parameter.
want_apache() {
        debug-print-function $FUNCNAME $*
        want_apache2 "$@"
}

# @FUNCTION: want_apache2
# @USAGE: [myiuse]
# @DESCRIPTION:
# An ebuild calls this to get the dependency information for optional apache-2.x
# support. If the myiuse parameter is not given it defaults to apache2.
# An ebuild should additionally call depend.apache_pkg_setup() in pkg_setup()
# with the same myiuse parameter.
want_apache2() {
        debug-print-function $FUNCNAME $*

        local myiuse=${1:-apache2}
        IUSE="${IUSE} ${myiuse}"
        DEPEND="${DEPEND} ${myiuse}? ( ${APACHE2_DEPEND} )"
        RDEPEND="${RDEPEND} ${myiuse}? ( ${APACHE2_DEPEND} )"
}

# @FUNCTION: want_apache2_2
# @USAGE: [myiuse]
# @DESCRIPTION:
# An ebuild calls this to get the dependency information for optional
# apache-2.2.x support. If the myiuse parameter is not given it defaults to
# apache2.
# An ebuild should additionally call depend.apache_pkg_setup() in pkg_setup()
# with the same myiuse parameter.
want_apache2_2() {
        debug-print-function $FUNCNAME $*

        local myiuse=${1:-apache2}
        IUSE="${IUSE} ${myiuse}"
        DEPEND="${DEPEND} ${myiuse}? ( ${APACHE2_2_DEPEND} )"
        RDEPEND="${RDEPEND} ${myiuse}? ( ${APACHE2_2_DEPEND} )"
}

# @FUNCTION: need_apache
# @DESCRIPTION:
# An ebuild calls this to get the dependency information for apache.
need_apache() {
        debug-print-function $FUNCNAME $*
        need_apache2
}

# @FUNCTION: need_apache2
# @DESCRIPTION:
# An ebuild calls this to get the dependency information for apache-2.x.
need_apache2() {
        debug-print-function $FUNCNAME $*

        DEPEND="${DEPEND} ${APACHE2_DEPEND}"
        RDEPEND="${RDEPEND} ${APACHE2_DEPEND}"
        _init_apache2
}

# @FUNCTION: need_apache2_2
# @DESCRIPTION:
# An ebuild calls this to get the dependency information for apache-2.2.x.
need_apache2_2() {
        debug-print-function $FUNCNAME $*

        DEPEND="${DEPEND} ${APACHE2_2_DEPEND}"
        RDEPEND="${RDEPEND} ${APACHE2_2_DEPEND}"
        _init_apache2
}

# @FUNCTION: need_apache2_4
# @DESCRIPTION:
# An ebuild calls this to get the dependency information for apache-2.4.x.
need_apache2_4() {
        debug-print-function $FUNCNAME $*

        DEPEND="${DEPEND} ${APACHE2_4_DEPEND}"
        RDEPEND="${RDEPEND} ${APACHE2_4_DEPEND}"
        _init_apache2
}

# @FUNCTION: has_apache
# @DESCRIPTION:
# An ebuild calls this to get runtime variables for an indirect apache
# dependency without USE-flag, in which case want_apache does not work.
# DO NOT call this function in global scope.
has_apache() {
        debug-print-function $FUNCNAME $*

        if has_version '>=www-servers/apache-2'; then
                _init_apache2
        else
                _init_no_apache
        fi
}

# @FUNCTION: has_apache_threads
# @USAGE: [myflag]
# @DESCRIPTION:
# An ebuild calls this to make sure thread-safety is enabled if apache has been
# built with a threaded MPM. If the myflag parameter is not given it defaults to
# threads.
has_apache_threads() {
        debug-print-function $FUNCNAME $*

        if ! built_with_use www-servers/apache threads; then
                return
        fi

        local myflag="${1:-threads}"

        if ! use ${myflag}; then
                echo
                eerror "You need to enable USE flag '${myflag}' to build a thread-safe version"
                eerror "of ${CATEGORY}/${PN} for use with www-servers/apache"
                die "Need missing USE flag '${myflag}'"
        fi
}

# @FUNCTION: has_apache_threads_in
# @USAGE: <myforeign> [myflag]
# @DESCRIPTION:
# An ebuild calls this to make sure thread-safety is enabled in a foreign
# package if apache has been built with a threaded MPM. If the myflag parameter
# is not given it defaults to threads.
has_apache_threads_in() {
        debug-print-function $FUNCNAME $*

        if ! built_with_use www-servers/apache threads; then
                return
        fi

        local myforeign="$1"
        local myflag="${2:-threads}"

        if ! built_with_use ${myforeign} ${myflag}; then
                echo
                eerror "You need to enable USE flag '${myflag}' in ${myforeign} to"
                eerror "build a thread-safe version of ${CATEGORY}/${PN} for use"
                eerror "with www-servers/apache"
                die "Need missing USE flag '${myflag}' in ${myforeign}"
        fi
}

EXPORT_FUNCTIONS pkg_setup
1	# Copyright 1999-2012 Gentoo Foundation
2	# Distributed under the terms of the GNU General Public License v2
3	# $Header: /var/cvsroot/gentoo-x86/eclass/depend.apache.eclass,v 1.46 2012/04/20 07:19:49 patrick Exp $
4
5	# @ECLASS: depend.apache.eclass
6	# @MAINTAINER:
7	# apache-devs@gentoo.org
8	# @BLURB: Functions to allow ebuilds to depend on apache
9	# @DESCRIPTION:
10	# This eclass handles depending on apache in a sane way and provides information
11	# about where certain binaries and configuration files are located.
12	#
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
15	# defined DEPEND and RDEPEND. Also note that you can not rely on the automatic
16	# RDEPEND=DEPEND that portage does if you use this eclass.
17	#
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	#
38	# pkg_setup() {
39	# depend.apache_pkg_setup server
40	# }
41	# @CODE
42
43	inherit multilib
44
45	# ==============================================================================
46	# INTERNAL VARIABLES
47	# ==============================================================================
48
49	# @ECLASS-VARIABLE: APACHE_VERSION
50	# @DESCRIPTION:
51	# Stores the version of apache we are going to be ebuilding.
52	# This variable is set by the want/need_apache functions.
53
54	# @ECLASS-VARIABLE: APXS
55	# @DESCRIPTION:
56	# Path to the apxs tool.
57	# This variable is set by the want/need_apache functions.
58
59	# @ECLASS-VARIABLE: APACHE_BIN
60	# @DESCRIPTION:
61	# Path to the apache binary.
62	# This variable is set by the want/need_apache functions.
63
64	# @ECLASS-VARIABLE: APACHE_CTL
65	# @DESCRIPTION:
66	# Path to the apachectl tool.
67	# This variable is set by the want/need_apache functions.
68
69	# @ECLASS-VARIABLE: APACHE_BASEDIR
70	# @DESCRIPTION:
71	# Path to the server root directory.
72	# This variable is set by the want/need_apache functions.
73
74	# @ECLASS-VARIABLE: APACHE_CONFDIR
75	# @DESCRIPTION:
76	# Path to the configuration file directory.
77	# This variable is set by the want/need_apache functions.
78
79	# @ECLASS-VARIABLE: APACHE_MODULES_CONFDIR
80	# @DESCRIPTION:
81	# Path where module configuration files are kept.
82	# This variable is set by the want/need_apache functions.
83
84	# @ECLASS-VARIABLE: APACHE_VHOSTS_CONFDIR
85	# @DESCRIPTION:
86	# Path where virtual host configuration files are kept.
87	# This variable is set by the want/need_apache functions.
88
89	# @ECLASS-VARIABLE: APACHE_MODULESDIR
90	# @DESCRIPTION:
91	# Path where we install modules.
92	# This variable is set by the want/need_apache functions.
93
94	# @ECLASS-VARIABLE: APACHE_DEPEND
95	# @DESCRIPTION:
96	# Dependencies for Apache
97	APACHE_DEPEND="www-servers/apache"
98
99	# @ECLASS-VARIABLE: APACHE2_DEPEND
100	# @DESCRIPTION:
101	# Dependencies for Apache 2.x
102	APACHE2_DEPEND="=www-servers/apache-2*"
103
104	# @ECLASS-VARIABLE: APACHE2_2_DEPEND
105	# @DESCRIPTION:
106	# Dependencies for Apache 2.2.x
107	APACHE2_2_DEPEND="=www-servers/apache-2.2*"
108
109	# @ECLASS-VARIABLE: APACHE2_4_DEPEND
110	# @DESCRIPTION:
111	# Dependencies for Apache 2.4.x
112	APACHE2_4_DEPEND="=www-servers/apache-2.4*"
113
114
115	# ==============================================================================
116	# INTERNAL FUNCTIONS
117	# ==============================================================================
118
119	_init_apache2() {
120	debug-print-function $FUNCNAME $*
121
122	# WARNING: Do not use these variables with anything that is put
123	# into the dependency cache (DEPEND/RDEPEND/etc)
124	APACHE_VERSION="2"
125	APXS="/usr/sbin/apxs2"
126	APACHE_BIN="/usr/sbin/apache2"
127	APACHE_CTL="/usr/sbin/apache2ctl"
128	APACHE_INCLUDEDIR="/usr/include/apache2"
129	APACHE_BASEDIR="/usr/$(get_libdir)/apache2"
130	APACHE_CONFDIR="/etc/apache2"
131	APACHE_MODULES_CONFDIR="${APACHE_CONFDIR}/modules.d"
132	APACHE_VHOSTS_CONFDIR="${APACHE_CONFDIR}/vhosts.d"
133	APACHE_MODULESDIR="${APACHE_BASEDIR}/modules"
134	}
135
136	_init_no_apache() {
137	debug-print-function $FUNCNAME $*
138	APACHE_VERSION="0"
139	}
140
141	# ==============================================================================
142	# PUBLIC FUNCTIONS
143	# ==============================================================================
144
145	# @FUNCTION: depend.apache_pkg_setup
146	# @USAGE: [myiuse]
147	# @DESCRIPTION:
148	# An ebuild calls this in pkg_setup() to initialize variables for optional
149	# apache-2.x support. If the myiuse parameter is not given it defaults to
150	# apache2.
151	depend.apache_pkg_setup() {
152	debug-print-function $FUNCNAME $*
153
154	if [[ "${EBUILD_PHASE}" != "setup" ]]; then
155	die "$FUNCNAME() should be called in pkg_setup()"
156	fi
157
158	local myiuse=${1:-apache2}
159	if has ${myiuse} ${IUSE}; then
160	if use ${myiuse}; then
161	_init_apache2
162	else
163	_init_no_apache
164	fi
165	fi
166	}
167
168	# @FUNCTION: want_apache
169	# @USAGE: [myiuse]
170	# @DESCRIPTION:
171	# An ebuild calls this to get the dependency information for optional apache
172	# support. If the myiuse parameter is not given it defaults to apache2.
173	# An ebuild should additionally call depend.apache_pkg_setup() in pkg_setup()
174	# with the same myiuse parameter.
175	want_apache() {
176	debug-print-function $FUNCNAME $*
177	want_apache2 "$@"
178	}
179
180	# @FUNCTION: want_apache2
181	# @USAGE: [myiuse]
182	# @DESCRIPTION:
183	# An ebuild calls this to get the dependency information for optional apache-2.x
184	# support. If the myiuse parameter is not given it defaults to apache2.
185	# An ebuild should additionally call depend.apache_pkg_setup() in pkg_setup()
186	# with the same myiuse parameter.
187	want_apache2() {
188	debug-print-function $FUNCNAME $*
189
190	local myiuse=${1:-apache2}
191	IUSE="${IUSE} ${myiuse}"
192	DEPEND="${DEPEND} ${myiuse}? ( ${APACHE2_DEPEND} )"
193	RDEPEND="${RDEPEND} ${myiuse}? ( ${APACHE2_DEPEND} )"
194	}
195
196	# @FUNCTION: want_apache2_2
197	# @USAGE: [myiuse]
198	# @DESCRIPTION:
199	# An ebuild calls this to get the dependency information for optional
200	# apache-2.2.x support. If the myiuse parameter is not given it defaults to
201	# apache2.
202	# An ebuild should additionally call depend.apache_pkg_setup() in pkg_setup()
203	# with the same myiuse parameter.
204	want_apache2_2() {
205	debug-print-function $FUNCNAME $*
206
207	local myiuse=${1:-apache2}
208	IUSE="${IUSE} ${myiuse}"
209	DEPEND="${DEPEND} ${myiuse}? ( ${APACHE2_2_DEPEND} )"
210	RDEPEND="${RDEPEND} ${myiuse}? ( ${APACHE2_2_DEPEND} )"
211	}
212
213	# @FUNCTION: need_apache
214	# @DESCRIPTION:
215	# An ebuild calls this to get the dependency information for apache.
216	need_apache() {
217	debug-print-function $FUNCNAME $*
218	need_apache2
219	}
220
221	# @FUNCTION: need_apache2
222	# @DESCRIPTION:
223	# An ebuild calls this to get the dependency information for apache-2.x.
224	need_apache2() {
225	debug-print-function $FUNCNAME $*
226
227	DEPEND="${DEPEND} ${APACHE2_DEPEND}"
228	RDEPEND="${RDEPEND} ${APACHE2_DEPEND}"
229	_init_apache2
230	}
231
232	# @FUNCTION: need_apache2_2
233	# @DESCRIPTION:
234	# An ebuild calls this to get the dependency information for apache-2.2.x.
235	need_apache2_2() {
236	debug-print-function $FUNCNAME $*
237
238	DEPEND="${DEPEND} ${APACHE2_2_DEPEND}"
239	RDEPEND="${RDEPEND} ${APACHE2_2_DEPEND}"
240	_init_apache2
241	}
242
243	# @FUNCTION: need_apache2_4
244	# @DESCRIPTION:
245	# An ebuild calls this to get the dependency information for apache-2.4.x.
246	need_apache2_4() {
247	debug-print-function $FUNCNAME $*
248
249	DEPEND="${DEPEND} ${APACHE2_4_DEPEND}"
250	RDEPEND="${RDEPEND} ${APACHE2_4_DEPEND}"
251	_init_apache2
252	}
253
254	# @FUNCTION: has_apache
255	# @DESCRIPTION:
256	# An ebuild calls this to get runtime variables for an indirect apache
257	# dependency without USE-flag, in which case want_apache does not work.
258	# DO NOT call this function in global scope.
259	has_apache() {
260	debug-print-function $FUNCNAME $*
261
262	if has_version '>=www-servers/apache-2'; then
263	_init_apache2
264	else
265	_init_no_apache
266	fi
267	}
268
269	# @FUNCTION: has_apache_threads
270	# @USAGE: [myflag]
271	# @DESCRIPTION:
272	# An ebuild calls this to make sure thread-safety is enabled if apache has been
273	# built with a threaded MPM. If the myflag parameter is not given it defaults to
274	# threads.
275	has_apache_threads() {
276	debug-print-function $FUNCNAME $*
277
278	if ! built_with_use www-servers/apache threads; then
279	return
280	fi
281
282	local myflag="${1:-threads}"
283
284	if ! use ${myflag}; then
285	echo
286	eerror "You need to enable USE flag '${myflag}' to build a thread-safe version"
287	eerror "of ${CATEGORY}/${PN} for use with www-servers/apache"
288	die "Need missing USE flag '${myflag}'"
289	fi
290	}
291
292	# @FUNCTION: has_apache_threads_in
293	# @USAGE: <myforeign> [myflag]
294	# @DESCRIPTION:
295	# An ebuild calls this to make sure thread-safety is enabled in a foreign
296	# package if apache has been built with a threaded MPM. If the myflag parameter
297	# is not given it defaults to threads.
298	has_apache_threads_in() {
299	debug-print-function $FUNCNAME $*
300
301	if ! built_with_use www-servers/apache threads; then
302	return
303	fi
304
305	local myforeign="$1"
306	local myflag="${2:-threads}"
307
308	if ! built_with_use ${myforeign} ${myflag}; then
309	echo
310	eerror "You need to enable USE flag '${myflag}' in ${myforeign} to"
311	eerror "build a thread-safe version of ${CATEGORY}/${PN} for use"
312	eerror "with www-servers/apache"
313	die "Need missing USE flag '${myflag}' in ${myforeign}"
314	fi
315	}
316
317	EXPORT_FUNCTIONS pkg_setup