path: root/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.34 2007/09/08 14:06:12 hollow Exp $

inherit multilib

# 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.

######
## Apache Common Variables
##
## These are internal variables used by this, and other apache-related eclasses,
## and thus should not need to be used by the ebuilds themselves (the ebuilds
## should know what version of Apache they are building against).
######

####
## APACHE_VERSION
##
## Stores the version of apache we are going to be ebuilding. This variable is
## set by the need_apache{|1|2} functions.
##
####
#APACHE_VERSION="2"

####
## APXS1, APXS2
##
## Paths to the apxs tools
####
APXS1="/usr/sbin/apxs"
APXS2="/usr/sbin/apxs2"

####
## APACHECTL1, APACHECTL2
##
## Paths to the apachectl tools
####
APACHECTL1="/usr/sbin/apachectl"
APACHECTL2="/usr/sbin/apache2ctl"

####
## APACHE1_BASEDIR, APACHE2_BASEDIR
##
## Paths to the server root directories
####
APACHE1_BASEDIR="/usr/$(get_libdir)/apache"
APACHE2_BASEDIR="/usr/$(get_libdir)/apache2"

####
## APACHE1_CONFDIR, APACHE2_CONFDIR
##
## Paths to the configuration file directories
####
APACHE1_CONFDIR="/etc/apache"
APACHE2_CONFDIR="/etc/apache2"

####
## APACHE1_MODULES_CONFDIR, APACHE2_MODULES_CONFDIR
##
## Paths where module configuration files are kept
####
APACHE1_MODULES_CONFDIR="${APACHE1_CONFDIR}/modules.d"
APACHE2_MODULES_CONFDIR="${APACHE2_CONFDIR}/modules.d"

####
## APACHE1_VHOSTDIR, APACHE2_VHOSTDIR
##
## Paths where virtual host configuration files are kept
####
APACHE1_VHOSTDIR="${APACHE1_CONFDIR}/vhosts.d"
APACHE2_VHOSTDIR="${APACHE2_CONFDIR}/vhosts.d"

####
## APACHE1_MODULESDIR, APACHE2_MODULESDIR
##
## Paths where we install modules
####
APACHE1_MODULESDIR="${APACHE1_BASEDIR}/modules"
APACHE2_MODULESDIR="${APACHE2_BASEDIR}/modules"

####
## APACHE1_DEPEND, APACHE2_DEPEND
## APACHE2_0_DEPEND, APACHE2_2_DEPEND
##
## Dependencies for Apache 1.x and Apache 2.x
####
APACHE1_DEPEND="=www-servers/apache-1*"
APACHE2_DEPEND="=www-servers/apache-2*"
APACHE2_0_DEPEND="=www-servers/apache-2.0*"
APACHE2_2_DEPEND="=www-servers/apache-2.2*"

####
## NEED_APACHE_DEPEND
##
## Dependency magic based on useflags to use the right DEPEND
## If you change this, please check the DEPENDS in need_apache()
####

NEED_APACHE_DEPEND="${APACHE2_DEPEND}"
WANT_APACHE_DEPEND="apache2? ( ${APACHE2_DEPEND} )"

####
## apr_config/apu_config
##
## Version magic to get the correct apr-config/apu-config
## based on the (probably) installed version of apache.
## This is needed to get modules to link to the same apr/apu
## as apache (i.e. link 0.9 for 2.0, 1.x for 2.2)
####
apr_config() {
	local default="${1:-1}"
	if [[ "${USE_APACHE}" == "2" ]]; then
		if has_version ${APACHE2_0_DEPEND}; then
			echo apr-config
		else
			echo apr-1-config
		fi
	else
		if [[ "${default}" == "0" ]]; then
			echo apr-config
		elif [[ "${default}" == "1" ]]; then
			echo apr-1-config
		else
			die "Unknown version specifier: ${default}"
		fi
	fi
}

apu_config() {
	local default="${1:-1}"
	if [[ "${USE_APACHE}" == "2" ]]; then
		if has_version ${APACHE2_0_DEPEND}; then
			echo apu-config
		else
			echo apu-1-config
		fi
	else
		if [[ "${default}" == "0" ]]; then
			echo apu-config
		elif [[ "${default}" == "1" ]]; then
			echo apu-1-config
		else
			die "Unknown version specifier: ${default}"
		fi
	fi
}

####
# uses_apache1() - !!! DEPRECATED !!!
####

uses_apache1() {
	debug-print-function $FUNCNAME $*
	# WARNING: Do not use these variables with anything that is put
	# into the dependency cache (DEPEND/RDEPEND/etc)
	APACHE_VERSION="1"
	APXS="${APXS1}"
	USE_APACHE="1"
	APACHECTL="${APACHECTL1}"
	APACHE_BASEDIR="${APACHE1_BASEDIR}"
	APACHE_CONFDIR="${APACHE1_CONFDIR}"
	APACHE_MODULES_CONFDIR="${APACHE1_MODULES_CONFDIR}"
	APACHE_VHOSTSDIR="${APACHE1_VHOSTSDIR}"
	APACHE_MODULESDIR="${APACHE1_MODULESDIR}"
}

####
# uses_apache2()
#
# sets up all of the environment variables required by an apache2 module
####

uses_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"
	USE_APACHE="2"
	APXS="${APXS2}"
	APACHECTL="${APACHECTL2}"
	APACHE_BASEDIR="${APACHE2_BASEDIR}"
	APACHE_CONFDIR="${APACHE2_CONFDIR}"
	APACHE_MODULES_CONFDIR="${APACHE2_MODULES_CONFDIR}"
	APACHE_VHOSTSDIR="${APACHE2_VHOSTSDIR}"
	APACHE_MODULESDIR="${APACHE2_MODULESDIR}"
}

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

####
## need_apache1 - !!! DEPRECATED !!!
####
need_apache1() {
	debug-print-function $FUNCNAME $*

	DEPEND="${DEPEND} ${APACHE1_DEPEND}"
	RDEPEND="${RDEPEND} ${APACHE1_DEPEND}"
	APACHE_VERSION="1"
}

####
## need_apache2
##
## An ebuild calls this to get the dependency information
## for apache-2.x. 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_apache2 somewhere.
####
need_apache2() {
	debug-print-function $FUNCNAME $*

	DEPEND="${DEPEND} ${APACHE2_DEPEND}"
	RDEPEND="${RDEPEND} ${APACHE2_DEPEND}"
	APACHE_VERSION="2"
}

####
## need_apache2_0
##
## Works like need_apache2 above, but its used by modules
## that only support apache 2.0 and do not work with
## higher versions.
##
####
need_apache2_0() {
	debug-print-function $FUNCNAME $*

	DEPEND="${DEPEND} ${APACHE2_0_DEPEND}"
	RDEPEND="${RDEPEND} ${APACHE2_0_DEPEND}"
	APACHE_VERSION="2"
}

####
## need_apache2_2
##
## Works like need_apache2 above, but its used by modules
## that only support apache 2.2 and do not work with
## lower versions.
##
####
need_apache2_2() {
	debug-print-function $FUNCNAME $*

	DEPEND="${DEPEND} ${APACHE2_2_DEPEND}"
	RDEPEND="${RDEPEND} ${APACHE2_2_DEPEND}"
	APACHE_VERSION="2"
}

####
## DO NOT CHANGE THIS FUNCTION UNLESS YOU UNDERSTAND THE CONSEQUENCES IT
## WILL HAVE ON THE CACHE!
##
## This function can take a variable amount of arguments specifying the
## versions of apache the ebuild supports
##
## If no arguments are specified, then all versions are assumed to be supported
##
## Currently supported versions: 2.0 2.2 2.x
####
need_apache() {
	debug-print-function $FUNCNAME $*

	local supports2x supports20 supports22

	if [[ $# -eq 0 ]] ; then
		supports2x="yes"
	else
		while [[ $# -gt 0 ]] ; do
			case "$1" in
				2.0) supports20="yes"; shift;;
				2.2) supports22="yes"; shift;;
				2.x) supports2x="yes"; shift;;
				*) die "Unknown version specifier: $1";;
			esac
		done
	fi

	if [[ "${supports20}" == "yes" ]] && [[ "${supports22}" == "yes" ]] ; then
		supports2x="yes"
	fi

	debug-print "supports20: ${supports20}"
	debug-print "supports22: ${supports22}"
	debug-print "supports2x: ${supports2x}"

	if [[ "${supports2x}" == "yes" ]] ; then
		need_apache2
	elif [[ "${supports20}" == "yes" ]] ; then
		need_apache2_0
	elif [[ "${supports22}" == "yes" ]] ; then
		need_apache2_2
	fi

	uses_apache2
}

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

	IUSE="${IUSE} apache2"
	DEPEND="${DEPEND} ${WANT_APACHE_DEPEND}"
	RDEPEND="${RDEPEND} ${WANT_APACHE_DEPEND}"
	if use apache2 ; then
		uses_apache2
	else
		doesnt_use_apache
	fi
}