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.37 2008/02/02 14:31:42 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 providing
# information about where certain interfaces are located.
#
# @NOTE: If you use this, be sure you use the need_* 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.

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 need_apache functions.

# @ECLASS-VARIABLE: APXS
# @DESCRIPTION:
# Paths to the apxs tool

# @ECLASS-VARIABLE: APACHECTL
# @DESCRIPTION:
# Path to the apachectl tool

# @ECLASS-VARIABLE: APACHE_BASEDIR
# @DESCRIPTION:
# Path to the server root directory

# @ECLASS-VARIABLE: APACHE_CONFDIR
# @DESCRIPTION:
# Path to the configuration file directory

# @ECLASS-VARIABLE: APACHE_MODULES_CONFDIR
# @DESCRIPTION:
# Path where module configuration files are kept

# @ECLASS-VARIABLE: APACHE_VHOSTS_CONFDIR
# @DESCRIPTION:
# Path where virtual host configuration files are kept

# @ECLASS-VARIABLE: APACHE_MODULESDIR
# @DESCRIPTION:
# Path where we install modules

# @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: WANT_APACHE_DEPEND
# @DESCRIPTION:
# Dependency magic based on useflag to use the right DEPEND
WANT_APACHE_DEPEND="apache2? ( ${APACHE_DEPEND} )"

# @ECLASS-VARIABLE: WANT_APACHE2_DEPEND
# @DESCRIPTION:
# Dependency magic based on useflag to use the right DEPEND
WANT_APACHE2_DEPEND="apache2? ( ${APACHE2_DEPEND} )"

# @ECLASS-VARIABLE: WANT_APACHE2_2_DEPEND
# @DESCRIPTION:
# Dependency magic based on useflag to use the right DEPEND
WANT_APACHE2_2_DEPEND="apache2? ( ${APACHE2_2_DEPEND} )"

# ==============================================================================
# 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
# @DESCRIPTION:
# An ebuild calls this to get the dependency information for optional apache-2.x
# support.
want_apache2() {
        debug-print-function $FUNCNAME $*

        IUSE="${IUSE} apache2"
        DEPEND="${DEPEND} ${WANT_APACHE2_DEPEND}"
        RDEPEND="${RDEPEND} ${WANT_APACHE2_DEPEND}"

        if use apache2 ; then
                _init_apache2
        else
                _init_no_apache
        fi
}

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

        IUSE="${IUSE} apache2"
        DEPEND="${DEPEND} ${WANT_APACHE2_2_DEPEND}"
        RDEPEND="${RDEPEND} ${WANT_APACHE2_2_DEPEND}"

        if use apache2 ; then
                _init_apache2
        else
                _init_no_apache
        fi
}

# @FUNCTION: want_apache
# @DESCRIPTION:
# An ebuild calls this to get the dependency information for optional apache
# support.
want_apache() {
        want_apache2
}

# @FUNCTION: need_apache2
# @DESCRIPTION:
# Works like need_apache, but its used by modules that only support
# apache 2.x and do not work with other versions.
need_apache2() {
        debug-print-function $FUNCNAME $*

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

# @FUNCTION: need_apache2_2
# @DESCRIPTION:
# Works like need_apache, but its used by modules that only support
# apache 2.2.x and do not work with other versions.
need_apache2_2() {
        debug-print-function $FUNCNAME $*

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

# @FUNCTION: need_apache
# @DESCRIPTION:
# An ebuild calls this to get the dependency information for apache. An
# ebuild should use this in order for future changes to the build infrastructure
# to happen seamlessly. All an ebuild needs to do is include the line
# need_apache somewhere.
need_apache() {
        need_apache2
}
1	chtekk	1.30	# Copyright 1999-2007 Gentoo Foundation
2	stuart	1.20	# Distributed under the terms of the GNU General Public License v2
3	hollow	1.38	# $Header: /var/cvsroot/gentoo-x86/eclass/depend.apache.eclass,v 1.37 2008/02/02 14:31:42 hollow Exp $
4	stuart	1.2
5	hollow	1.35	# @ECLASS: depend.apache.eclass
6			# @MAINTAINER: apache-devs@gentoo.org
7			# @BLURB: Functions to allow ebuilds to depend on apache
8			# @DESCRIPTION:
9	vericgar	1.25	# This eclass handles depending on apache in a sane way and providing
10			# information about where certain interfaces are located.
11	hollow	1.35	#
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.
17	vericgar	1.25
18	hollow	1.35	inherit multilib
19	vericgar	1.25
20	hollow	1.35	# ==============================================================================
21			# INTERNAL VARIABLES
22			# ==============================================================================
23
24			# @ECLASS-VARIABLE: APACHE_VERSION
25			# @DESCRIPTION:
26			# Stores the version of apache we are going to be ebuilding. This variable is
27			# set by the need_apache functions.
28	urilith	1.6
29	hollow	1.36	# @ECLASS-VARIABLE: APXS
30	hollow	1.35	# @DESCRIPTION:
31			# Paths to the apxs tool
32	urilith	1.6
33	hollow	1.36	# @ECLASS-VARIABLE: APACHECTL
34	hollow	1.35	# @DESCRIPTION:
35			# Path to the apachectl tool
36	urilith	1.6
37	hollow	1.36	# @ECLASS-VARIABLE: APACHE_BASEDIR
38	hollow	1.35	# @DESCRIPTION:
39			# Path to the server root directory
40	urilith	1.6
41	hollow	1.36	# @ECLASS-VARIABLE: APACHE_CONFDIR
42	hollow	1.35	# @DESCRIPTION:
43			# Path to the configuration file directory
44	urilith	1.6
45	hollow	1.36	# @ECLASS-VARIABLE: APACHE_MODULES_CONFDIR
46	hollow	1.35	# @DESCRIPTION:
47			# Path where module configuration files are kept
48	urilith	1.6
49	hollow	1.36	# @ECLASS-VARIABLE: APACHE_VHOSTS_CONFDIR
50	hollow	1.35	# @DESCRIPTION:
51			# Path where virtual host configuration files are kept
52	urilith	1.6
53	hollow	1.36	# @ECLASS-VARIABLE: APACHE_MODULESDIR
54	hollow	1.35	# @DESCRIPTION:
55			# Path where we install modules
56	urilith	1.6
57	hollow	1.37	# @ECLASS-VARIABLE: APACHE_DEPEND
58			# @DESCRIPTION:
59			# Dependencies for Apache
60			APACHE_DEPEND="www-servers/apache"
61
62	hollow	1.35	# @ECLASS-VARIABLE: APACHE2_DEPEND
63			# @DESCRIPTION:
64			# Dependencies for Apache 2.x
65	phreak	1.33	APACHE2_DEPEND="=www-servers/apache-2*"
66	hollow	1.35
67			# @ECLASS-VARIABLE: APACHE2_2_DEPEND
68			# @DESCRIPTION:
69			# Dependencies for Apache 2.2.x
70	phreak	1.33	APACHE2_2_DEPEND="=www-servers/apache-2.2*"
71	vericgar	1.7
72	hollow	1.35	# @ECLASS-VARIABLE: WANT_APACHE_DEPEND
73			# @DESCRIPTION:
74			# Dependency magic based on useflag to use the right DEPEND
75	hollow	1.37	WANT_APACHE_DEPEND="apache2? ( ${APACHE_DEPEND} )"
76
77			# @ECLASS-VARIABLE: WANT_APACHE2_DEPEND
78			# @DESCRIPTION:
79			# Dependency magic based on useflag to use the right DEPEND
80			WANT_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
85			WANT_APACHE2_2_DEPEND="apache2? ( ${APACHE2_2_DEPEND} )"
86	stuart	1.20
87	hollow	1.35	# ==============================================================================
88			# INTERNAL FUNCTIONS
89			# ==============================================================================
90
91	hollow	1.37	_init_apache2() {
92	vericgar	1.28	debug-print-function $FUNCNAME $*
93	stuart	1.20
94	vericgar	1.28	# WARNING: Do not use these variables with anything that is put
95			# into the dependency cache (DEPEND/RDEPEND/etc)
96	chtekk	1.30	APACHE_VERSION="2"
97	hollow	1.36	APXS="/usr/sbin/apxs2"
98	hollow	1.38	APACHE_BIN="/usr/sbin/apache2"
99			APACHE_CTL="/usr/sbin/apache2ctl"
100			# legacy alias
101			APACHECTL="${APACHE_CTL}"
102	hollow	1.36	APACHE_BASEDIR="/usr/$(get_libdir)/apache2"
103			APACHE_CONFDIR="/etc/apache2"
104			APACHE_MODULES_CONFDIR="${APACHE_CONFDIR}/modules.d"
105			APACHE_VHOSTS_CONFDIR="${APACHE_CONFDIR}/vhosts.d"
106			APACHE_MODULESDIR="${APACHE_BASEDIR}/modules"
107	stuart	1.20	}
108
109	hollow	1.37	_init_no_apache() {
110	vericgar	1.28	debug-print-function $FUNCNAME $*
111	chtekk	1.30	APACHE_VERSION="0"
112	stuart	1.20	}
113	vericgar	1.9
114	hollow	1.35	# ==============================================================================
115			# PUBLIC FUNCTIONS
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.
122	hollow	1.37	want_apache2() {
123	vericgar	1.28	debug-print-function $FUNCNAME $*
124	stuart	1.1
125	hollow	1.35	IUSE="${IUSE} apache2"
126	hollow	1.37	DEPEND="${DEPEND} ${WANT_APACHE2_DEPEND}"
127			RDEPEND="${RDEPEND} ${WANT_APACHE2_DEPEND}"
128	hollow	1.35
129			if use apache2 ; then
130	hollow	1.37	_init_apache2
131	hollow	1.35	else
132	hollow	1.37	_init_no_apache
133	hollow	1.35	fi
134	stuart	1.1	}
135
136	hollow	1.37	# @FUNCTION: want_apache
137	hollow	1.35	# @DESCRIPTION:
138	hollow	1.37	# An ebuild calls this to get the dependency information for optional
139			# apache-2.2.x support.
140			want_apache2_2() {
141	vericgar	1.28	debug-print-function $FUNCNAME $*
142	stuart	1.1
143	hollow	1.37	IUSE="${IUSE} apache2"
144			DEPEND="${DEPEND} ${WANT_APACHE2_2_DEPEND}"
145			RDEPEND="${RDEPEND} ${WANT_APACHE2_2_DEPEND}"
146
147			if use apache2 ; then
148			_init_apache2
149			else
150			_init_no_apache
151			fi
152			}
153
154			# @FUNCTION: want_apache
155			# @DESCRIPTION:
156			# An ebuild calls this to get the dependency information for optional apache
157			# support.
158			want_apache() {
159			want_apache2
160	stuart	1.1	}
161
162	hollow	1.37	# @FUNCTION: need_apache2
163	hollow	1.35	# @DESCRIPTION:
164	hollow	1.37	# Works like need_apache, but its used by modules that only support
165			# apache 2.x and do not work with other versions.
166			need_apache2() {
167	vericgar	1.28	debug-print-function $FUNCNAME $*
168
169	hollow	1.37	DEPEND="${DEPEND} ${APACHE2_DEPEND}"
170			RDEPEND="${RDEPEND} ${APACHE2_DEPEND}"
171			_init_apache2
172	vericgar	1.28	}
173
174	hollow	1.35	# @FUNCTION: need_apache2_2
175			# @DESCRIPTION:
176	hollow	1.37	# Works like need_apache, but its used by modules that only support
177			# apache 2.2.x and do not work with other versions.
178	vericgar	1.28	need_apache2_2() {
179			debug-print-function $FUNCNAME $*
180
181			DEPEND="${DEPEND} ${APACHE2_2_DEPEND}"
182			RDEPEND="${RDEPEND} ${APACHE2_2_DEPEND}"
183	hollow	1.37	_init_apache2
184	vericgar	1.28	}
185
186	hollow	1.35	# @FUNCTION: need_apache
187			# @DESCRIPTION:
188	hollow	1.37	# 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.
192	urilith	1.6	need_apache() {
193	hollow	1.35	need_apache2
194			}