gentoo-x86/eclass/depend.apache.eclass

# Copyright 1999-2007 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
# $Header: /var/cvsroot/gentoo-x86/eclass/depend.apache.eclass,v 1.39 2008/02/03 14:12:44 hollow 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
# @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:
# Paths 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*"

# ==============================================================================
# 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"
        # legacy alias
        APACHECTL="${APACHE_CTL}"
        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: 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.
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.
want_apache2() {
        debug-print-function $FUNCNAME $*

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

        if use ${myiuse} ; then
                _init_apache2
        else
                _init_no_apache
        fi
}

# @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.
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} )"

        if use ${myiuse} ; then
                _init_apache2
        else
                _init_no_apache
        fi
}

# @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
}
1	# Copyright 1999-2007 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.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 provides information
10	# about where certain binaries and configuration files are located.
11	#
12	# To make use of this eclass simply call one of the need/want_apache functions
13	# described below. Make sure you use the need/want_apache call after you have
14	# defined DEPEND and RDEPEND. Also note that you can not rely on the automatic
15	# RDEPEND=DEPEND that portage does if you use this eclass.
16	#
17	# See Bug 107127 for more information.
18	#
19	# @EXAMPLE:
20	#
21	# Here is an example of an ebuild depending on apache:
22	#
23	# @CODE
24	# DEPEND="virtual/Perl-CGI"
25	# RDEPEND="${DEPEND}"
26	# need_apache2
27	# @CODE
28	#
29	# Another example which demonstrates non-standard IUSE options for optional
30	# apache support:
31	#
32	# @CODE
33	# DEPEND="server? ( virtual/Perl-CGI )"
34	# RDEPEND="${DEPEND}"
35	# want_apache2 server
36	# @CODE
37
38	inherit multilib
39
40	# ==============================================================================
41	# INTERNAL VARIABLES
42	# ==============================================================================
43
44	# @ECLASS-VARIABLE: APACHE_VERSION
45	# @DESCRIPTION:
46	# Stores the version of apache we are going to be ebuilding.
47	# This variable is set by the want/need_apache functions.
48
49	# @ECLASS-VARIABLE: APXS
50	# @DESCRIPTION:
51	# Paths to the apxs tool.
52	# This variable is set by the want/need_apache functions.
53
54	# @ECLASS-VARIABLE: APACHE_BIN
55	# @DESCRIPTION:
56	# Path to the apache binary.
57	# This variable is set by the want/need_apache functions.
58
59	# @ECLASS-VARIABLE: APACHE_CTL
60	# @DESCRIPTION:
61	# Path to the apachectl tool.
62	# This variable is set by the want/need_apache functions.
63
64	# @ECLASS-VARIABLE: APACHE_BASEDIR
65	# @DESCRIPTION:
66	# Path to the server root directory.
67	# This variable is set by the want/need_apache functions.
68
69	# @ECLASS-VARIABLE: APACHE_CONFDIR
70	# @DESCRIPTION:
71	# Path to the configuration file directory.
72	# This variable is set by the want/need_apache functions.
73
74	# @ECLASS-VARIABLE: APACHE_MODULES_CONFDIR
75	# @DESCRIPTION:
76	# Path where module configuration files are kept.
77	# This variable is set by the want/need_apache functions.
78
79	# @ECLASS-VARIABLE: APACHE_VHOSTS_CONFDIR
80	# @DESCRIPTION:
81	# Path where virtual host configuration files are kept.
82	# This variable is set by the want/need_apache functions.
83
84	# @ECLASS-VARIABLE: APACHE_MODULESDIR
85	# @DESCRIPTION:
86	# Path where we install modules.
87	# This variable is set by the want/need_apache functions.
88
89	# @ECLASS-VARIABLE: APACHE_DEPEND
90	# @DESCRIPTION:
91	# Dependencies for Apache
92	APACHE_DEPEND="www-servers/apache"
93
94	# @ECLASS-VARIABLE: APACHE2_DEPEND
95	# @DESCRIPTION:
96	# Dependencies for Apache 2.x
97	APACHE2_DEPEND="=www-servers/apache-2*"
98
99	# @ECLASS-VARIABLE: APACHE2_2_DEPEND
100	# @DESCRIPTION:
101	# Dependencies for Apache 2.2.x
102	APACHE2_2_DEPEND="=www-servers/apache-2.2*"
103
104	# ==============================================================================
105	# INTERNAL FUNCTIONS
106	# ==============================================================================
107
108	_init_apache2() {
109	debug-print-function $FUNCNAME $*
110
111	# WARNING: Do not use these variables with anything that is put
112	# into the dependency cache (DEPEND/RDEPEND/etc)
113	APACHE_VERSION="2"
114	APXS="/usr/sbin/apxs2"
115	APACHE_BIN="/usr/sbin/apache2"
116	APACHE_CTL="/usr/sbin/apache2ctl"
117	# legacy alias
118	APACHECTL="${APACHE_CTL}"
119	APACHE_BASEDIR="/usr/$(get_libdir)/apache2"
120	APACHE_CONFDIR="/etc/apache2"
121	APACHE_MODULES_CONFDIR="${APACHE_CONFDIR}/modules.d"
122	APACHE_VHOSTS_CONFDIR="${APACHE_CONFDIR}/vhosts.d"
123	APACHE_MODULESDIR="${APACHE_BASEDIR}/modules"
124	}
125
126	_init_no_apache() {
127	debug-print-function $FUNCNAME $*
128	APACHE_VERSION="0"
129	}
130
131	# ==============================================================================
132	# PUBLIC FUNCTIONS
133	# ==============================================================================
134
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.
140	want_apache() {
141	debug-print-function $FUNCNAME $*
142	want_apache2 "$@"
143	}
144
145	# @FUNCTION: want_apache2
146	# @USAGE: [myiuse]
147	# @DESCRIPTION:
148	# An ebuild calls this to get the dependency information for optional apache-2.x
149	# support. If the myiuse parameter is not given it defaults to apache2.
150	want_apache2() {
151	debug-print-function $FUNCNAME $*
152
153	local myiuse=${1:-apache2}
154	IUSE="${IUSE} ${myiuse}"
155	DEPEND="${DEPEND} ${myiuse}? ( ${APACHE2_DEPEND} )"
156	RDEPEND="${RDEPEND} ${myiuse}? ( ${APACHE2_DEPEND} )"
157
158	if use ${myiuse} ; then
159	_init_apache2
160	else
161	_init_no_apache
162	fi
163	}
164
165	# @FUNCTION: want_apache2_2
166	# @USAGE: [myiuse]
167	# @DESCRIPTION:
168	# An ebuild calls this to get the dependency information for optional
169	# apache-2.2.x support. If the myiuse parameter is not given it defaults to
170	# apache2.
171	want_apache2_2() {
172	debug-print-function $FUNCNAME $*
173
174	local myiuse=${1:-apache2}
175	IUSE="${IUSE} ${myiuse}"
176	DEPEND="${DEPEND} ${myiuse}? ( ${APACHE2_2_DEPEND} )"
177	RDEPEND="${RDEPEND} ${myiuse}? ( ${APACHE2_2_DEPEND} )"
178
179	if use ${myiuse} ; then
180	_init_apache2
181	else
182	_init_no_apache
183	fi
184	}
185
186	# @FUNCTION: need_apache
187	# @DESCRIPTION:
188	# An ebuild calls this to get the dependency information for apache.
189	need_apache() {
190	debug-print-function $FUNCNAME $*
191	need_apache2
192	}
193
194	# @FUNCTION: need_apache2
195	# @DESCRIPTION:
196	# An ebuild calls this to get the dependency information for apache-2.x.
197	need_apache2() {
198	debug-print-function $FUNCNAME $*
199
200	DEPEND="${DEPEND} ${APACHE2_DEPEND}"
201	RDEPEND="${RDEPEND} ${APACHE2_DEPEND}"
202	_init_apache2
203	}
204
205	# @FUNCTION: need_apache2_2
206	# @DESCRIPTION:
207	# An ebuild calls this to get the dependency information for apache-2.2.x.
208	need_apache2_2() {
209	debug-print-function $FUNCNAME $*
210
211	DEPEND="${DEPEND} ${APACHE2_2_DEPEND}"
212	RDEPEND="${RDEPEND} ${APACHE2_2_DEPEND}"
213	_init_apache2
214	}