gentoo-x86/eclass/depend.php.eclass

# Copyright 1999-2007 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
# $Header: /var/cvsroot/gentoo-x86/eclass/depend.php.eclass,v 1.27 2010/10/02 15:23:57 olemarkus Exp $

# Author: Stuart Herbert <stuart@gentoo.org>
# Author: Luca Longinotti <chtekk@gentoo.org>
# Author: Jakub Moc <jakub@gentoo.org> (documentation)

# @ECLASS: depend.php.eclass
# @MAINTAINER:
# Gentoo PHP team <php-bugs@gentoo.org>
# @BLURB: Functions to allow ebuilds to depend on php5 and check for specific features.
# @DESCRIPTION:
# This eclass provides functions that allow ebuilds to depend on php5 and check
# for specific PHP features, SAPIs etc. Also provides dodoc-php wrapper to install
# documentation for PHP packages to php-specific location.


inherit eutils phpconfutils

# PHP5-only depend functions

# @FUNCTION: need_php5_cli
# @DESCRIPTION:
# Set this after setting DEPEND/RDEPEND in your ebuild if the ebuild requires PHP5
# with cli SAPI.
need_php5_cli() {
        DEPEND="${DEPEND} =virtual/php-5*"
        RDEPEND="${RDEPEND} =virtual/php-5*"
        PHP_VERSION="5"
}

# @FUNCTION: need_php5_httpd
# @DESCRIPTION:
# Set this after setting DEPEND/RDEPEND in your ebuild if the ebuild requires PHP5
# with either cgi or apache2 SAPI.
need_php5_httpd() {
        DEPEND="${DEPEND} =virtual/httpd-php-5*"
        RDEPEND="${RDEPEND} =virtual/httpd-php-5*"
        PHP_VERSION="5"
}

# @FUNCTION: need_php5
# @DESCRIPTION:
# Set this after setting DEPEND/RDEPEND in your ebuild if the ebuild requires PHP5
# (with any SAPI).
need_php5() {
        DEPEND="${DEPEND} =dev-lang/php-5*"
        RDEPEND="${RDEPEND} =dev-lang/php-5*"
        PHP_VERSION="5"
        PHP_SHARED_CAT="php5"
}

# common settings go in here
uses_php5() {
        # cache this
        libdir=$(get_libdir)

        PHPIZE="/usr/${libdir}/php5/bin/phpize"
        PHPCONFIG="/usr/${libdir}/php5/bin/php-config"
        PHPCLI="/usr/${libdir}/php5/bin/php"
        PHPCGI="/usr/${libdir}/php5/bin/php-cgi"
        PHP_PKG="$(best_version =dev-lang/php-5*)"
        PHPPREFIX="/usr/${libdir}/php5"
        EXT_DIR="$(${PHPCONFIG} --extension-dir 2>/dev/null)"

        einfo
        einfo "Using ${PHP_PKG}"
        einfo
}

# general PHP depend functions

# @FUNCTION: need_php_cli
# @DESCRIPTION:
# Set this after setting DEPEND/RDEPEND in your ebuild if the ebuild requires PHP
# (any version) with cli SAPI.
need_php_cli() {
        DEPEND="${DEPEND} virtual/php"
        RDEPEND="${RDEPEND} virtual/php"
}

# @FUNCTION: need_php_httpd
# @DESCRIPTION:
# Set this after setting DEPEND/RDEPEND in your ebuild if the ebuild requires PHP
# (any version) with either cgi or apache2 SAPI.
need_php_httpd() {
        DEPEND="${DEPEND} virtual/httpd-php"
        RDEPEND="${RDEPEND} virtual/httpd-php"
}

# @FUNCTION: need_php
# @DESCRIPTION:
# Set this after setting DEPEND/RDEPEND in your ebuild if the ebuild requires PHP
# (any version with any SAPI).
need_php() {
        DEPEND="${DEPEND} dev-lang/php"
        RDEPEND="${RDEPEND} dev-lang/php"
        PHP_SHARED_CAT="php"
}

# @FUNCTION: need_php_by_category
# @DESCRIPTION:
# Set this after setting DEPEND/RDEPEND in your ebuild to depend on PHP version
# determined by ${CATEGORY} - any PHP version or PHP5 for dev-php or
# dev-php5, respectively.
need_php_by_category() {
        case "${CATEGORY}" in
                dev-php) need_php ;;
                dev-php5) need_php5 ;;
                *) die "Version of PHP required by packages in category ${CATEGORY} unknown"
        esac
}


# @FUNCTION: has_php
# @DESCRIPTION:
# Call this function from your pkg_setup, src_compile, src_install etc. if you
# need to know which PHP version is being used and where the PHP binaries/data
# are installed.
has_php() {
        # Detect which PHP version we have installed
        if has_version '=dev-lang/php-5*' ; then
                PHP_VERSION="5"
        else
                die "Unable to find an installed dev-lang/php package"
        fi

        # If we get here, then PHP_VERSION tells us which version of PHP we
        # want to use
        uses_php${PHP_VERSION}
}

# @FUNCTION: require_php_sapi_from
# @USAGE: <list of SAPIs>
# @DESCRIPTION:
# Call this function from pkg_setup if your package only works with
# specific SAPI(s) and specify a list of PHP SAPI USE flags that are
# required (one or more from cli, cgi, apache2) as arguments.
# Returns if any of the listed SAPIs have been installed, dies if none
# of them is available.
#
# Unfortunately, if you want to be really sure that the required SAPI is
# provided by PHP, you will have to use this function or similar ones (like
# require_php_cli or require_php_cgi) in pkg_setup until we are able to
# depend on USE flags being enabled. The above described need_php[45]_cli
# and need_php[45]_httpd functions cannot guarantee these requirements.
# See Bug 2272 for details.
require_php_sapi_from() {
        has_php

        local has_sapi="0"
        local x

        einfo "Checking for compatible SAPI(s)"

        for x in $@ ; do
                if built_with_use =${PHP_PKG} ${x} || phpconfutils_built_with_use =${PHP_PKG} ${x} ; then
                        einfo "  Discovered compatible SAPI ${x}"
                        has_sapi="1"
                fi
        done

        if [[ "${has_sapi}" == "1" ]] ; then
                return
        fi

        eerror
        eerror "${PHP_PKG} needs to be re-installed with one of the following"
        eerror "USE flags enabled:"
        eerror
        eerror "  $@"
        eerror
        die "No compatible PHP SAPIs found"
}

# @FUNCTION: require_php_with_use
# @USAGE: <list of USE flags>
# @DESCRIPTION:
# Call this function from pkg_setup if your package requires PHP compiled
# with specific USE flags. Returns if all of the listed USE flags are enabled.
# Dies if any of the listed USE flags are disabled.

# @VARIABLE: PHPCHECKNODIE
# @DESCRIPTION:
# You can set PHPCHECKNODIE to non-empty value in your ebuild to chain multiple
# require_php_with_(any)_use checks without making the ebuild die on every failure.
# This is useful in cases when certain PHP features are only required if specific
# USE flag(s) are enabled for that ebuild.
# @CODE
# Example:
#
# local flags="pcre session snmp sockets wddx"
# use mysql && flags="${flags} mysql"
# use postgres && flags="${flags} postgres"
# if ! PHPCHECKNODIE="yes" require_php_with_use ${flags} \
#       || ! PHPCHECKNODIE="yes" require_php_with_any_use gd gd-external ; then
#       die "Re-install ${PHP_PKG} with ${flags} and either gd or gd-external"
# fi
# @CODE
require_php_with_use() {
        has_php

        local missing_use=""
        local x

        einfo "Checking for required PHP feature(s) ..."

        for x in $@ ; do
                case $x in
                        pcre|spl|reflection|mhash)
                                eqawarn "require_php_with_use MUST NOT check for the pcre, spl, mhash or reflection USE flag."
                                eqawarn "These USE flags are removed from >=dev-lang/php-5.3 and your ebuild will break"
                                eqawarn "if you check the USE flags against PHP 5.3 ebuilds."
                                eqawarn "Please use USE dependencies from EAPI 2 instead"
                                ;;
                esac

                if ! built_with_use =${PHP_PKG} ${x} && ! phpconfutils_built_with_use =${PHP_PKG} ${x} ; then
                        einfo "  Discovered missing USE flag: ${x}"
                        missing_use="${missing_use} ${x}"
                fi
        done

        if [[ -z "${missing_use}" ]] ; then
                if [[ -z "${PHPCHECKNODIE}" ]] ; then
                        return
                else
                        return 0
                fi
        fi

        if [[ -z "${PHPCHECKNODIE}" ]] ; then
                eerror
                eerror "${PHP_PKG} needs to be re-installed with all of the following"
                eerror "USE flags enabled:"
                eerror
                eerror "  $@"
                eerror
                die "Missing PHP USE flags found"
        else
                return 1
        fi
}

# @FUNCTION: require_php_with_any_use
# @USAGE: <list of USE flags>
# @DESCRIPTION:
# Call this function from pkg_setup if your package requires PHP compiled with
# any of specified USE flags. Returns if any of the listed USE flags are enabled.
# Dies if all of the listed USE flags are disabled.
require_php_with_any_use() {
        has_php

        local missing_use=""
        local x

        einfo "Checking for required PHP feature(s) ..."

        for x in $@ ; do
                if built_with_use =${PHP_PKG} ${x} || phpconfutils_built_with_use =${PHP_PKG} ${x} ; then
                        einfo "  USE flag ${x} is enabled, ok ..."
                        return
                else
                        missing_use="${missing_use} ${x}"
                fi
        done

        if [[ -z "${missing_use}" ]] ; then
                if [[ -z "${PHPCHECKNODIE}" ]] ; then
                        return
                else
                        return 0
                fi
        fi

        if [[ -z "${PHPCHECKNODIE}" ]] ; then
                eerror
                eerror "${PHP_PKG} needs to be re-installed with any of the following"
                eerror "USE flags enabled:"
                eerror
                eerror "  $@"
                eerror
                die "Missing PHP USE flags found"
        else
                return 1
        fi
}

# ========================================================================
# has_*() functions
#
# These functions return 0 if the condition is satisfied, 1 otherwise
# ========================================================================

# @FUNCTION: has_zts
# @DESCRIPTION:
# Check if our PHP was compiled with ZTS (Zend Thread Safety) enabled.
# @RETURN: 0 if true, 1 otherwise
has_zts() {
        has_php

        if built_with_use =${PHP_PKG} apache2 threads || phpconfutils_built_with_use =${PHP_PKG} apache2 threads ; then
                return 0
        fi

        return 1
}

# @FUNCTION: has_debug
# @DESCRIPTION:
# Check if our PHP was built with debug support enabled.
# @RETURN: 0 if true, 1 otherwise
has_debug() {
        has_php

        if built_with_use =${PHP_PKG} debug || phpconfutils_built_with_use =${PHP_PKG} debug ; then
                return 0
        fi

        return 1
}

# @FUNCTION: has_concurrentmodphp
# @DESCRIPTION:
# Check if our PHP was built with the concurrentmodphp support enabled.
# @RETURN: 0 if true, 1 otherwise
has_concurrentmodphp() {
        has_php

        if built_with_use =${PHP_PKG} apache2 concurrentmodphp || phpconfutils_built_with_use =${PHP_PKG} apache2 concurrentmodphp ; then
                return 0
        fi

        return 1
}

# ========================================================================
# require_*() functions
#
# These functions die() if PHP was built without the required features
# ========================================================================

# @FUNCTION: require_pdo
# @DESCRIPTION:
# Require a PHP built with PDO support (PHP5 only).
# This function is now redundant and DEPRECATED since
# pdo-external use flag and pecl-pdo-* ebuilds were removed.
# You should use require_php_with_use pdo instead now.
# @RETURN: die if feature is missing
require_pdo() {
        has_php

        # Was PHP5 compiled with internal PDO support?
        if built_with_use =${PHP_PKG} pdo || phpconfutils_built_with_use =${PHP_PKG} pdo ; then
                return
        else
                eerror
                eerror "No PDO extension for PHP found."
                eerror "Please note that PDO only exists for PHP 5."
                eerror "Please install a PDO extension for PHP 5."
                eerror "You must install >=dev-lang/php-5.1 with USE=\"pdo\"."
                eerror
                die "No PDO extension for PHP 5 found"
        fi
}

# @FUNCTION: require_php_cli
# @DESCRIPTION:
# Determines which installed PHP version has the CLI SAPI enabled.
# Useful for PEAR stuff, or anything which needs to run PHP script
# depending on the CLI SAPI.
# @RETURN: die if feature is missing
require_php_cli() {
        # If PHP_PKG is set, then we have remembered our PHP settings
        # from last time
        if [[ -n ${PHP_PKG} ]] ; then
                return
        fi

        local PHP_PACKAGE_FOUND=""

        if has_version '=dev-lang/php-5*' ; then
                PHP_PACKAGE_FOUND="1"
                pkg="$(best_version '=dev-lang/php-5*')"
                if built_with_use =${pkg} cli || phpconfutils_built_with_use =${pkg} cli ; then
                        PHP_VERSION="5"
                fi
        fi

        if [[ -z ${PHP_PACKAGE_FOUND} ]] ; then
                die "Unable to find an installed dev-lang/php package"
        fi

        if [[ -z ${PHP_VERSION} ]] ; then
                die "No PHP CLI installed. Re-emerge dev-lang/php with USE=cli."
        fi

        # If we get here, then PHP_VERSION tells us which version of PHP we
        # want to use
        uses_php${PHP_VERSION}
}

# @FUNCTION: require_php_cgi
# @DESCRIPTION:
# Determines which installed PHP version has the CGI SAPI enabled.
# Useful for anything which needs to run PHP scripts depending on the CGI SAPI.
# @RETURN: die if feature is missing
require_php_cgi() {
        # If PHP_PKG is set, then we have remembered our PHP settings
        # from last time
        if [[ -n ${PHP_PKG} ]] ; then
                return
        fi

        local PHP_PACKAGE_FOUND=""

        if has_version '=dev-lang/php-5*' ; then
                PHP_PACKAGE_FOUND="1"
                pkg="$(best_version '=dev-lang/php-5*')"
                if built_with_use =${pkg} cgi || phpconfutils_built_with_use =${pkg} cgi ; then
                        PHP_VERSION="5"
                fi
        fi

        if [[ -z ${PHP_PACKAGE_FOUND} ]] ; then
                die "Unable to find an installed dev-lang/php package"
        fi

        if [[ -z ${PHP_VERSION} ]] ; then
                die "No PHP CGI installed. Re-emerge dev-lang/php with USE=cgi."
        fi

        # If we get here, then PHP_VERSION tells us which version of PHP we
        # want to use
        uses_php${PHP_VERSION}
}

# @FUNCTION: require_sqlite
# @DESCRIPTION:
# Require a PHP built with SQLite support
# @RETURN: die if feature is missing
require_sqlite() {
        has_php

        # Has our PHP been built with SQLite support?
        if built_with_use =${PHP_PKG} sqlite || phpconfutils_built_with_use =${PHP_PKG} sqlite ; then
                return
        fi

        # If we get here, then we don't have any SQLite support for PHP installed
        eerror
        eerror "No SQLite extension for PHP found."
        eerror "Please install an SQLite extension for PHP,"
        eerror "this is done best by simply adding the"
        eerror "'sqlite' USE flag when emerging dev-lang/php."
        eerror
        die "No SQLite extension for PHP found"
}

# @FUNCTION: require_gd
# @DESCRIPTION:
# Require a PHP built with GD support
# @RETURN: die if feature is missing
require_gd() {
        has_php

        # Do we have the internal GD support installed?
        if built_with_use =${PHP_PKG} gd || phpconfutils_built_with_use =${PHP_PKG} gd ; then
                return
        fi

        # Ok, maybe GD was built using the external library support?
        if built_with_use =${PHP_PKG} gd-external || phpconfutils_built_with_use =${PHP_PKG} gd-external ; then
                return
        fi

        # If we get here, then we have no GD support
        eerror
        eerror "No GD support for PHP found."
        eerror "Please install the GD support for PHP,"
        eerror "you must install dev-lang/php with either"
        eerror "the 'gd' or the 'gd-external' USE flags"
        eerror "turned on."
        eerror
        die "No GD support found for PHP"
}

# ========================================================================
# Misc functions
#
# These functions provide miscellaneous checks and functionality.
# ========================================================================

# @FUNCTION: php_binary_extension
# @DESCRIPTION:
# Executes some checks needed when installing a binary PHP extension.
php_binary_extension() {
        has_php

        local PUSE_ENABLED=""

        # Binary extensions do not support the change of PHP
        # API version, so they can't be installed when USE flags
        # are enabled which change the PHP API version, they also
        # don't provide correctly versioned symbols for our use

        if has_debug ; then
                eerror
                eerror "You cannot install binary PHP extensions"
                eerror "when the 'debug' USE flag is enabled!"
                eerror "Please reemerge dev-lang/php with the"
                eerror "'debug' USE flag turned off."
                eerror
                PUSE_ENABLED="1"
        fi

        if has_concurrentmodphp ; then
                eerror
                eerror "You cannot install binary PHP extensions when"
                eerror "the 'concurrentmodphp' USE flag is enabled!"
                eerror "Please reemerge dev-lang/php with the"
                eerror "'concurrentmodphp' USE flag turned off."
                eerror
                PUSE_ENABLED="1"
        fi

        if [[ -n ${PUSE_ENABLED} ]] ; then
                die "'debug' and/or 'concurrentmodphp' USE flags turned on!"
        fi
}

# @FUNCTION: dodoc-php
# @USAGE: <list of docs>
# @DESCRIPTION:
# Alternative to dodoc function for use in our PHP eclasses and ebuilds.
# Stored here because depend.php gets always sourced everywhere in the PHP
# ebuilds and eclasses. It simply is dodoc with a changed path to the docs.
# NOTE: No support for docinto is provided!
dodoc-php() {
if [[ $# -lt 1 ]] ; then
        echo "$0: at least one argument needed" 1>&2
        exit 1
fi

phpdocdir="/usr/share/doc/${CATEGORY}/${PF}/"

for x in $@ ; do
        if [[ -s "${x}" ]] ; then
                insinto "${phpdocdir}"
                doins "${x}"
                gzip -f -9 "${D}/${phpdocdir}/${x##*/}"
        elif [[ ! -e "${x}" ]] ; then
                echo "dodoc-php: ${x} does not exist" 1>&2
        fi
done
}

# @FUNCTION: dohtml-php
# @USAGE: <list of html docs>
# @DESCRIPTION:
# Alternative to dohtml function for use in our PHP eclasses and ebuilds.
# Stored here because depend.php gets always sourced everywhere in the PHP
# ebuilds and eclasses. It simply is dohtml with a changed path to the docs.
# NOTE: No support for [-a|-A|-p|-x] options is provided!
dohtml-php() {
if [[ $# -lt 1 ]] ; then
        echo "$0: at least one argument needed" 1>&2
        exit 1
fi

phphtmldir="/usr/share/doc/${CATEGORY}/${PF}/html"

for x in $@ ; do
        if [[ -s "${x}" ]] ; then
                insinto "${phphtmldir}"
                doins "${x}"
        elif [[ ! -e "${x}" ]] ; then
                echo "dohtml-php: ${x} does not exist" 1>&2
        fi
done
}
1	chtekk	1.18	# Copyright 1999-2007 Gentoo Foundation
2	stuart	1.1	# Distributed under the terms of the GNU General Public License v2
3	olemarkus	1.28	# $Header: /var/cvsroot/gentoo-x86/eclass/depend.php.eclass,v 1.27 2010/10/02 15:23:57 olemarkus Exp $
4	jokey	1.21
5			# Author: Stuart Herbert <stuart@gentoo.org>
6			# Author: Luca Longinotti <chtekk@gentoo.org>
7			# Author: Jakub Moc <jakub@gentoo.org> (documentation)
8
9			# @ECLASS: depend.php.eclass
10			# @MAINTAINER:
11			# Gentoo PHP team <php-bugs@gentoo.org>
12	mabi	1.26	# @BLURB: Functions to allow ebuilds to depend on php5 and check for specific features.
13	jokey	1.21	# @DESCRIPTION:
14	mabi	1.26	# This eclass provides functions that allow ebuilds to depend on php5 and check
15	jokey	1.21	# for specific PHP features, SAPIs etc. Also provides dodoc-php wrapper to install
16			# documentation for PHP packages to php-specific location.
17	chtekk	1.18
18	stuart	1.1
19	chtekk	1.12	inherit eutils phpconfutils
20	stuart	1.1
21	trapni	1.4	# PHP5-only depend functions
22	jokey	1.21
23			# @FUNCTION: need_php5_cli
24			# @DESCRIPTION:
25			# Set this after setting DEPEND/RDEPEND in your ebuild if the ebuild requires PHP5
26			# with cli SAPI.
27	chtekk	1.12	need_php5_cli() {
28	stuart	1.1	DEPEND="${DEPEND} =virtual/php-5*"
29			RDEPEND="${RDEPEND} =virtual/php-5*"
30	chtekk	1.12	PHP_VERSION="5"
31	stuart	1.1	}
32
33	jokey	1.21	# @FUNCTION: need_php5_httpd
34			# @DESCRIPTION:
35			# Set this after setting DEPEND/RDEPEND in your ebuild if the ebuild requires PHP5
36			# with either cgi or apache2 SAPI.
37	chtekk	1.12	need_php5_httpd() {
38	stuart	1.1	DEPEND="${DEPEND} =virtual/httpd-php-5*"
39			RDEPEND="${RDEPEND} =virtual/httpd-php-5*"
40	chtekk	1.12	PHP_VERSION="5"
41	stuart	1.1	}
42
43	jokey	1.21	# @FUNCTION: need_php5
44			# @DESCRIPTION:
45			# Set this after setting DEPEND/RDEPEND in your ebuild if the ebuild requires PHP5
46			# (with any SAPI).
47	chtekk	1.12	need_php5() {
48	stuart	1.1	DEPEND="${DEPEND} =dev-lang/php-5*"
49			RDEPEND="${RDEPEND} =dev-lang/php-5*"
50	chtekk	1.12	PHP_VERSION="5"
51	stuart	1.1	PHP_SHARED_CAT="php5"
52			}
53
54			# common settings go in here
55	chtekk	1.12	uses_php5() {
56	stuart	1.1	# cache this
57			libdir=$(get_libdir)
58
59			PHPIZE="/usr/${libdir}/php5/bin/phpize"
60			PHPCONFIG="/usr/${libdir}/php5/bin/php-config"
61			PHPCLI="/usr/${libdir}/php5/bin/php"
62			PHPCGI="/usr/${libdir}/php5/bin/php-cgi"
63	armin76	1.22	PHP_PKG="$(best_version =dev-lang/php-5*)"
64	stuart	1.1	PHPPREFIX="/usr/${libdir}/php5"
65	armin76	1.22	EXT_DIR="$(${PHPCONFIG} --extension-dir 2>/dev/null)"
66	stuart	1.1
67			einfo
68			einfo "Using ${PHP_PKG}"
69			einfo
70			}
71
72	trapni	1.4	# general PHP depend functions
73	jokey	1.21
74			# @FUNCTION: need_php_cli
75			# @DESCRIPTION:
76			# Set this after setting DEPEND/RDEPEND in your ebuild if the ebuild requires PHP
77			# (any version) with cli SAPI.
78	chtekk	1.12	need_php_cli() {
79	trapni	1.4	DEPEND="${DEPEND} virtual/php"
80			RDEPEND="${RDEPEND} virtual/php"
81			}
82
83	jokey	1.21	# @FUNCTION: need_php_httpd
84			# @DESCRIPTION:
85			# Set this after setting DEPEND/RDEPEND in your ebuild if the ebuild requires PHP
86			# (any version) with either cgi or apache2 SAPI.
87	chtekk	1.12	need_php_httpd() {
88	trapni	1.4	DEPEND="${DEPEND} virtual/httpd-php"
89			RDEPEND="${RDEPEND} virtual/httpd-php"
90			}
91
92	jokey	1.21	# @FUNCTION: need_php
93			# @DESCRIPTION:
94			# Set this after setting DEPEND/RDEPEND in your ebuild if the ebuild requires PHP
95			# (any version with any SAPI).
96	chtekk	1.12	need_php() {
97	stuart	1.1	DEPEND="${DEPEND} dev-lang/php"
98			RDEPEND="${RDEPEND} dev-lang/php"
99			PHP_SHARED_CAT="php"
100			}
101
102	jokey	1.21	# @FUNCTION: need_php_by_category
103			# @DESCRIPTION:
104			# Set this after setting DEPEND/RDEPEND in your ebuild to depend on PHP version
105	mabi	1.26	# determined by ${CATEGORY} - any PHP version or PHP5 for dev-php or
106	jokey	1.21	# dev-php5, respectively.
107	chtekk	1.12	need_php_by_category() {
108	stuart	1.1	case "${CATEGORY}" in
109			dev-php) need_php ;;
110			dev-php5) need_php5 ;;
111	chtekk	1.18	*) die "Version of PHP required by packages in category ${CATEGORY} unknown"
112	stuart	1.1	esac
113			}
114
115	chtekk	1.12
116	jokey	1.21	# @FUNCTION: has_php
117			# @DESCRIPTION:
118			# Call this function from your pkg_setup, src_compile, src_install etc. if you
119	swegener	1.23	# need to know which PHP version is being used and where the PHP binaries/data
120	jokey	1.21	# are installed.
121	chtekk	1.12	has_php() {
122	armin76	1.25	# Detect which PHP version we have installed
123			if has_version '=dev-lang/php-5*' ; then
124			PHP_VERSION="5"
125			else
126			die "Unable to find an installed dev-lang/php package"
127	chtekk	1.12	fi
128
129			# If we get here, then PHP_VERSION tells us which version of PHP we
130			# want to use
131			uses_php${PHP_VERSION}
132			}
133
134	jokey	1.21	# @FUNCTION: require_php_sapi_from
135			# @USAGE: <list of SAPIs>
136			# @DESCRIPTION:
137	chtekk	1.12	# Call this function from pkg_setup if your package only works with
138	jokey	1.21	# specific SAPI(s) and specify a list of PHP SAPI USE flags that are
139			# required (one or more from cli, cgi, apache2) as arguments.
140			# Returns if any of the listed SAPIs have been installed, dies if none
141			# of them is available.
142			#
143			# Unfortunately, if you want to be really sure that the required SAPI is
144			# provided by PHP, you will have to use this function or similar ones (like
145			# require_php_cli or require_php_cgi) in pkg_setup until we are able to
146	swegener	1.23	# depend on USE flags being enabled. The above described need_php[45]_cli
147	jokey	1.21	# and need_php[45]_httpd functions cannot guarantee these requirements.
148			# See Bug 2272 for details.
149	chtekk	1.12	require_php_sapi_from() {
150	stuart	1.1	has_php
151
152	chtekk	1.12	local has_sapi="0"
153	stuart	1.1	local x
154
155			einfo "Checking for compatible SAPI(s)"
156
157			for x in $@ ; do
158	chtekk	1.13	if built_with_use =${PHP_PKG} ${x} \|\| phpconfutils_built_with_use =${PHP_PKG} ${x} ; then
159	stuart	1.1	einfo " Discovered compatible SAPI ${x}"
160	chtekk	1.12	has_sapi="1"
161	stuart	1.1	fi
162			done
163
164	chtekk	1.12	if [[ "${has_sapi}" == "1" ]] ; then
165	stuart	1.1	return
166			fi
167
168			eerror
169			eerror "${PHP_PKG} needs to be re-installed with one of the following"
170			eerror "USE flags enabled:"
171			eerror
172			eerror " $@"
173			eerror
174	chtekk	1.12	die "No compatible PHP SAPIs found"
175	stuart	1.1	}
176
177	jokey	1.21	# @FUNCTION: require_php_with_use
178			# @USAGE: <list of USE flags>
179			# @DESCRIPTION:
180	chtekk	1.12	# Call this function from pkg_setup if your package requires PHP compiled
181	jokey	1.21	# with specific USE flags. Returns if all of the listed USE flags are enabled.
182			# Dies if any of the listed USE flags are disabled.
183	stuart	1.1
184	jokey	1.21	# @VARIABLE: PHPCHECKNODIE
185			# @DESCRIPTION:
186			# You can set PHPCHECKNODIE to non-empty value in your ebuild to chain multiple
187			# require_php_with_(any)_use checks without making the ebuild die on every failure.
188	swegener	1.23	# This is useful in cases when certain PHP features are only required if specific
189	jokey	1.21	# USE flag(s) are enabled for that ebuild.
190			# @CODE
191			# Example:
192			#
193			# local flags="pcre session snmp sockets wddx"
194			# use mysql && flags="${flags} mysql"
195			# use postgres && flags="${flags} postgres"
196			# if ! PHPCHECKNODIE="yes" require_php_with_use ${flags} \
197			# \|\| ! PHPCHECKNODIE="yes" require_php_with_any_use gd gd-external ; then
198			# die "Re-install ${PHP_PKG} with ${flags} and either gd or gd-external"
199			# fi
200			# @CODE
201	chtekk	1.12	require_php_with_use() {
202	stuart	1.1	has_php
203
204	chtekk	1.11	local missing_use=""
205	stuart	1.1	local x
206
207	chtekk	1.14	einfo "Checking for required PHP feature(s) ..."
208	stuart	1.1
209			for x in $@ ; do
210	olemarkus	1.27	case $x in
211	olemarkus	1.28	pcre\|spl\|reflection\|mhash)
212			eqawarn "require_php_with_use MUST NOT check for the pcre, spl, mhash or reflection USE flag."
213	olemarkus	1.27	eqawarn "These USE flags are removed from >=dev-lang/php-5.3 and your ebuild will break"
214			eqawarn "if you check the USE flags against PHP 5.3 ebuilds."
215			eqawarn "Please use USE dependencies from EAPI 2 instead"
216			;;
217			esac
218
219	chtekk	1.12	if ! built_with_use =${PHP_PKG} ${x} && ! phpconfutils_built_with_use =${PHP_PKG} ${x} ; then
220	chtekk	1.14	einfo " Discovered missing USE flag: ${x}"
221	stuart	1.1	missing_use="${missing_use} ${x}"
222			fi
223			done
224
225	chtekk	1.15	if [[ -z "${missing_use}" ]] ; then
226			if [[ -z "${PHPCHECKNODIE}" ]] ; then
227			return
228			else
229			return 0
230			fi
231	stuart	1.1	fi
232
233	chtekk	1.15	if [[ -z "${PHPCHECKNODIE}" ]] ; then
234			eerror
235			eerror "${PHP_PKG} needs to be re-installed with all of the following"
236			eerror "USE flags enabled:"
237			eerror
238			eerror " $@"
239			eerror
240			die "Missing PHP USE flags found"
241			else
242			return 1
243			fi
244	stuart	1.1	}
245
246	jokey	1.21	# @FUNCTION: require_php_with_any_use
247			# @USAGE: <list of USE flags>
248			# @DESCRIPTION:
249			# Call this function from pkg_setup if your package requires PHP compiled with
250			# any of specified USE flags. Returns if any of the listed USE flags are enabled.
251			# Dies if all of the listed USE flags are disabled.
252	chtekk	1.12	require_php_with_any_use() {
253			has_php
254	stuart	1.1
255	chtekk	1.12	local missing_use=""
256			local x
257	hollow	1.3
258	chtekk	1.14	einfo "Checking for required PHP feature(s) ..."
259	stuart	1.1
260	chtekk	1.12	for x in $@ ; do
261			if built_with_use =${PHP_PKG} ${x} \|\| phpconfutils_built_with_use =${PHP_PKG} ${x} ; then
262			einfo " USE flag ${x} is enabled, ok ..."
263			return
264	stuart	1.1	else
265	chtekk	1.12	missing_use="${missing_use} ${x}"
266	stuart	1.1	fi
267	chtekk	1.12	done
268
269	chtekk	1.15	if [[ -z "${missing_use}" ]] ; then
270			if [[ -z "${PHPCHECKNODIE}" ]] ; then
271			return
272			else
273			return 0
274			fi
275	stuart	1.1	fi
276
277	chtekk	1.15	if [[ -z "${PHPCHECKNODIE}" ]] ; then
278			eerror
279			eerror "${PHP_PKG} needs to be re-installed with any of the following"
280			eerror "USE flags enabled:"
281			eerror
282			eerror " $@"
283			eerror
284			die "Missing PHP USE flags found"
285			else
286			return 1
287			fi
288	stuart	1.1	}
289
290			# ========================================================================
291			# has_*() functions
292			#
293	chtekk	1.12	# These functions return 0 if the condition is satisfied, 1 otherwise
294	stuart	1.1	# ========================================================================
295
296	jokey	1.21	# @FUNCTION: has_zts
297			# @DESCRIPTION:
298			# Check if our PHP was compiled with ZTS (Zend Thread Safety) enabled.
299			# @RETURN: 0 if true, 1 otherwise
300	chtekk	1.12	has_zts() {
301	stuart	1.1	has_php
302
303	chtekk	1.13	if built_with_use =${PHP_PKG} apache2 threads \|\| phpconfutils_built_with_use =${PHP_PKG} apache2 threads ; then
304	stuart	1.1	return 0
305			fi
306
307			return 1
308			}
309
310	jokey	1.21	# @FUNCTION: has_debug
311			# @DESCRIPTION:
312			# Check if our PHP was built with debug support enabled.
313			# @RETURN: 0 if true, 1 otherwise
314	chtekk	1.18	has_debug() {
315	hollow	1.3	has_php
316
317	chtekk	1.18	if built_with_use =${PHP_PKG} debug \|\| phpconfutils_built_with_use =${PHP_PKG} debug ; then
318	hollow	1.3	return 0
319			fi
320
321			return 1
322			}
323
324	jokey	1.21	# @FUNCTION: has_concurrentmodphp
325			# @DESCRIPTION:
326			# Check if our PHP was built with the concurrentmodphp support enabled.
327			# @RETURN: 0 if true, 1 otherwise
328	chtekk	1.18	has_concurrentmodphp() {
329	chtekk	1.12	has_php
330
331	chtekk	1.18	if built_with_use =${PHP_PKG} apache2 concurrentmodphp \|\| phpconfutils_built_with_use =${PHP_PKG} apache2 concurrentmodphp ; then
332	chtekk	1.12	return 0
333			fi
334
335			return 1
336			}
337
338	stuart	1.1	# ========================================================================
339			# require_*() functions
340			#
341	chtekk	1.12	# These functions die() if PHP was built without the required features
342	stuart	1.1	# ========================================================================
343
344	jokey	1.21	# @FUNCTION: require_pdo
345			# @DESCRIPTION:
346			# Require a PHP built with PDO support (PHP5 only).
347	armin76	1.22	# This function is now redundant and DEPRECATED since
348			# pdo-external use flag and pecl-pdo-* ebuilds were removed.
349			# You should use require_php_with_use pdo instead now.
350	jokey	1.21	# @RETURN: die if feature is missing
351	chtekk	1.12	require_pdo() {
352	stuart	1.1	has_php
353
354	chtekk	1.12	# Was PHP5 compiled with internal PDO support?
355	chtekk	1.13	if built_with_use =${PHP_PKG} pdo \|\| phpconfutils_built_with_use =${PHP_PKG} pdo ; then
356	stuart	1.1	return
357	armin76	1.22	else
358			eerror
359			eerror "No PDO extension for PHP found."
360			eerror "Please note that PDO only exists for PHP 5."
361			eerror "Please install a PDO extension for PHP 5."
362			eerror "You must install >=dev-lang/php-5.1 with USE=\"pdo\"."
363			eerror
364			die "No PDO extension for PHP 5 found"
365	stuart	1.1	fi
366			}
367
368	jokey	1.21	# @FUNCTION: require_php_cli
369			# @DESCRIPTION:
370			# Determines which installed PHP version has the CLI SAPI enabled.
371			# Useful for PEAR stuff, or anything which needs to run PHP script
372			# depending on the CLI SAPI.
373			# @RETURN: die if feature is missing
374	chtekk	1.12	require_php_cli() {
375			# If PHP_PKG is set, then we have remembered our PHP settings
376	stuart	1.1	# from last time
377	chtekk	1.11	if [[ -n ${PHP_PKG} ]] ; then
378	stuart	1.1	return
379			fi
380
381	chtekk	1.12	local PHP_PACKAGE_FOUND=""
382
383	sebastian	1.10	if has_version '=dev-lang/php-5*' ; then
384	chtekk	1.12	PHP_PACKAGE_FOUND="1"
385	armin76	1.22	pkg="$(best_version '=dev-lang/php-5*')"
386	chtekk	1.13	if built_with_use =${pkg} cli \|\| phpconfutils_built_with_use =${pkg} cli ; then
387	chtekk	1.12	PHP_VERSION="5"
388	stuart	1.1	fi
389	sebastian	1.10	fi
390
391	chtekk	1.11	if [[ -z ${PHP_PACKAGE_FOUND} ]] ; then
392	stuart	1.1	die "Unable to find an installed dev-lang/php package"
393			fi
394
395	chtekk	1.11	if [[ -z ${PHP_VERSION} ]] ; then
396	hoffie	1.20	die "No PHP CLI installed. Re-emerge dev-lang/php with USE=cli."
397	stuart	1.1	fi
398
399	chtekk	1.12	# If we get here, then PHP_VERSION tells us which version of PHP we
400	stuart	1.1	# want to use
401	hollow	1.3	uses_php${PHP_VERSION}
402			}
403
404	jokey	1.21	# @FUNCTION: require_php_cgi
405			# @DESCRIPTION:
406			# Determines which installed PHP version has the CGI SAPI enabled.
407			# Useful for anything which needs to run PHP scripts depending on the CGI SAPI.
408			# @RETURN: die if feature is missing
409	chtekk	1.12	require_php_cgi() {
410			# If PHP_PKG is set, then we have remembered our PHP settings
411	hollow	1.3	# from last time
412	chtekk	1.11	if [[ -n ${PHP_PKG} ]] ; then
413	hollow	1.3	return
414			fi
415
416	chtekk	1.12	local PHP_PACKAGE_FOUND=""
417
418	sebastian	1.9	if has_version '=dev-lang/php-5*' ; then
419	chtekk	1.12	PHP_PACKAGE_FOUND="1"
420	armin76	1.22	pkg="$(best_version '=dev-lang/php-5*')"
421	chtekk	1.13	if built_with_use =${pkg} cgi \|\| phpconfutils_built_with_use =${pkg} cgi ; then
422	chtekk	1.12	PHP_VERSION="5"
423	hollow	1.3	fi
424	sebastian	1.9	fi
425	chtekk	1.11
426			if [[ -z ${PHP_PACKAGE_FOUND} ]] ; then
427	hollow	1.3	die "Unable to find an installed dev-lang/php package"
428			fi
429
430	chtekk	1.11	if [[ -z ${PHP_VERSION} ]] ; then
431	hoffie	1.20	die "No PHP CGI installed. Re-emerge dev-lang/php with USE=cgi."
432	hollow	1.3	fi
433
434	chtekk	1.12	# If we get here, then PHP_VERSION tells us which version of PHP we
435	hollow	1.3	# want to use
436	stuart	1.1	uses_php${PHP_VERSION}
437			}
438
439	jokey	1.21	# @FUNCTION: require_sqlite
440			# @DESCRIPTION:
441	chtekk	1.12	# Require a PHP built with SQLite support
442	jokey	1.21	# @RETURN: die if feature is missing
443	chtekk	1.12	require_sqlite() {
444	stuart	1.1	has_php
445
446	chtekk	1.12	# Has our PHP been built with SQLite support?
447			if built_with_use =${PHP_PKG} sqlite \|\| phpconfutils_built_with_use =${PHP_PKG} sqlite ; then
448	stuart	1.1	return
449			fi
450
451	chtekk	1.12	# If we get here, then we don't have any SQLite support for PHP installed
452	stuart	1.1	eerror
453	chtekk	1.12	eerror "No SQLite extension for PHP found."
454			eerror "Please install an SQLite extension for PHP,"
455	stuart	1.1	eerror "this is done best by simply adding the"
456			eerror "'sqlite' USE flag when emerging dev-lang/php."
457			eerror
458	chtekk	1.12	die "No SQLite extension for PHP found"
459	stuart	1.1	}
460	hollow	1.3
461	jokey	1.21	# @FUNCTION: require_gd
462			# @DESCRIPTION:
463	chtekk	1.12	# Require a PHP built with GD support
464	jokey	1.21	# @RETURN: die if feature is missing
465	chtekk	1.12	require_gd() {
466	hollow	1.3	has_php
467
468	chtekk	1.12	# Do we have the internal GD support installed?
469			if built_with_use =${PHP_PKG} gd \|\| phpconfutils_built_with_use =${PHP_PKG} gd ; then
470	hollow	1.3	return
471			fi
472
473	chtekk	1.12	# Ok, maybe GD was built using the external library support?
474			if built_with_use =${PHP_PKG} gd-external \|\| phpconfutils_built_with_use =${PHP_PKG} gd-external ; then
475	hollow	1.3	return
476			fi
477
478	chtekk	1.12	# If we get here, then we have no GD support
479	hollow	1.3	eerror
480			eerror "No GD support for PHP found."
481			eerror "Please install the GD support for PHP,"
482			eerror "you must install dev-lang/php with either"
483			eerror "the 'gd' or the 'gd-external' USE flags"
484			eerror "turned on."
485			eerror
486			die "No GD support found for PHP"
487			}
488	chtekk	1.6
489			# ========================================================================
490			# Misc functions
491			#
492			# These functions provide miscellaneous checks and functionality.
493			# ========================================================================
494
495	jokey	1.21	# @FUNCTION: php_binary_extension
496			# @DESCRIPTION:
497			# Executes some checks needed when installing a binary PHP extension.
498	chtekk	1.6	php_binary_extension() {
499			has_php
500
501	chtekk	1.12	local PUSE_ENABLED=""
502
503			# Binary extensions do not support the change of PHP
504	chtekk	1.6	# API version, so they can't be installed when USE flags
505	chtekk	1.16	# are enabled which change the PHP API version, they also
506			# don't provide correctly versioned symbols for our use
507	chtekk	1.6
508	chtekk	1.18	if has_debug ; then
509	chtekk	1.6	eerror
510			eerror "You cannot install binary PHP extensions"
511			eerror "when the 'debug' USE flag is enabled!"
512			eerror "Please reemerge dev-lang/php with the"
513			eerror "'debug' USE flag turned off."
514			eerror
515	chtekk	1.12	PUSE_ENABLED="1"
516			fi
517
518	chtekk	1.18	if has_concurrentmodphp ; then
519	chtekk	1.16	eerror
520			eerror "You cannot install binary PHP extensions when"
521			eerror "the 'concurrentmodphp' USE flag is enabled!"
522			eerror "Please reemerge dev-lang/php with the"
523			eerror "'concurrentmodphp' USE flag turned off."
524			eerror
525			PUSE_ENABLED="1"
526			fi
527
528	chtekk	1.12	if [[ -n ${PUSE_ENABLED} ]] ; then
529	chtekk	1.18	die "'debug' and/or 'concurrentmodphp' USE flags turned on!"
530	chtekk	1.6	fi
531			}
532
533	jokey	1.21	# @FUNCTION: dodoc-php
534			# @USAGE: <list of docs>
535			# @DESCRIPTION:
536			# Alternative to dodoc function for use in our PHP eclasses and ebuilds.
537	swegener	1.23	# Stored here because depend.php gets always sourced everywhere in the PHP
538	jokey	1.21	# ebuilds and eclasses. It simply is dodoc with a changed path to the docs.
539			# NOTE: No support for docinto is provided!
540	chtekk	1.12	dodoc-php() {
541			if [[ $# -lt 1 ]] ; then
542	chtekk	1.6	echo "$0: at least one argument needed" 1>&2
543			exit 1
544			fi
545
546	armin76	1.24	phpdocdir="/usr/share/doc/${CATEGORY}/${PF}/"
547	chtekk	1.6
548	armin76	1.24	for x in $@ ; do
549			if [[ -s "${x}" ]] ; then
550			insinto "${phpdocdir}"
551			doins "${x}"
552			gzip -f -9 "${D}/${phpdocdir}/${x##*/}"
553			elif [[ ! -e "${x}" ]] ; then
554			echo "dodoc-php: ${x} does not exist" 1>&2
555			fi
556			done
557			}
558
559			# @FUNCTION: dohtml-php
560			# @USAGE: <list of html docs>
561			# @DESCRIPTION:
562			# Alternative to dohtml function for use in our PHP eclasses and ebuilds.
563			# Stored here because depend.php gets always sourced everywhere in the PHP
564			# ebuilds and eclasses. It simply is dohtml with a changed path to the docs.
565			# NOTE: No support for [-a\|-A\|-p\|-x] options is provided!
566			dohtml-php() {
567			if [[ $# -lt 1 ]] ; then
568			echo "$0: at least one argument needed" 1>&2
569			exit 1
570	chtekk	1.6	fi
571
572	armin76	1.24	phphtmldir="/usr/share/doc/${CATEGORY}/${PF}/html"
573
574	chtekk	1.12	for x in $@ ; do
575			if [[ -s "${x}" ]] ; then
576	armin76	1.24	insinto "${phphtmldir}"
577			doins "${x}"
578	chtekk	1.12	elif [[ ! -e "${x}" ]] ; then
579	armin76	1.24	echo "dohtml-php: ${x} does not exist" 1>&2
580	chtekk	1.6	fi
581			done
582			}