/[gentoo-x86]/eclass/depend.php.eclass
Gentoo

Diff of /eclass/depend.php.eclass

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.21 Revision 1.32
1# Copyright 1999-2007 Gentoo Foundation 1# Copyright 1999-2012 Gentoo Foundation
2# Distributed under the terms of the GNU General Public License v2 2# Distributed under the terms of the GNU General Public License v2
3# $Header: /var/cvsroot/gentoo-x86/eclass/depend.php.eclass,v 1.21 2007/09/01 15:58:17 jokey Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/depend.php.eclass,v 1.32 2012/06/02 19:16:31 zmedico Exp $
4 4
5# @ECLASS: depend.php.eclass
6# @MAINTAINER:
7# Gentoo PHP team <php-bugs@gentoo.org>
8# @AUTHOR:
5# Author: Stuart Herbert <stuart@gentoo.org> 9# Author: Stuart Herbert <stuart@gentoo.org>
6# Author: Luca Longinotti <chtekk@gentoo.org> 10# Author: Luca Longinotti <chtekk@gentoo.org>
7# Author: Jakub Moc <jakub@gentoo.org> (documentation) 11# Author: Jakub Moc <jakub@gentoo.org> (documentation)
8
9# @ECLASS: depend.php.eclass
10# @MAINTAINER:
11# Gentoo PHP team <php-bugs@gentoo.org>
12# @BLURB: Functions to allow ebuilds to depend on php[45] and check for specific features. 12# @BLURB: Functions to allow ebuilds to depend on php5 and check for specific features.
13# @DESCRIPTION: 13# @DESCRIPTION:
14# This eclass provides functions that allow ebuilds to depend on php[45] and check 14# This eclass provides functions that allow ebuilds to depend on php5 and check
15# for specific PHP features, SAPIs etc. Also provides dodoc-php wrapper to install 15# for specific PHP features, SAPIs etc. Also provides dodoc-php wrapper to install
16# documentation for PHP packages to php-specific location. 16# documentation for PHP packages to php-specific location.
17 17
18
19inherit eutils phpconfutils 18inherit eutils multilib phpconfutils
20
21# PHP4-only depend functions
22
23# @FUNCTION: need_php4_cli
24# @DESCRIPTION:
25# Set this after setting DEPEND/RDEPEND in your ebuild if the ebuild requires PHP4
26# with cli SAPI.
27need_php4_cli() {
28 DEPEND="${DEPEND} =virtual/php-4*"
29 RDEPEND="${RDEPEND} =virtual/php-4*"
30 PHP_VERSION="4"
31}
32
33# @FUNCTION: need_php4_httpd
34# @DESCRIPTION:
35# Set this after setting DEPEND/RDEPEND in your ebuild if the ebuild requires PHP4
36# with either cgi or apache2 SAPI.
37need_php4_httpd() {
38 DEPEND="${DEPEND} =virtual/httpd-php-4*"
39 RDEPEND="${RDEPEND} =virtual/httpd-php-4*"
40 PHP_VERSION="4"
41}
42
43# @FUNCTION: need_php4
44# @DESCRIPTION:
45# Set this after setting DEPEND/RDEPEND in your ebuild if the ebuild requires PHP4
46# (with any SAPI).
47need_php4() {
48 DEPEND="${DEPEND} =dev-lang/php-4*"
49 RDEPEND="${RDEPEND} =dev-lang/php-4*"
50 PHP_VERSION="4"
51 PHP_SHARED_CAT="php4"
52}
53
54# common settings go in here
55uses_php4() {
56 # cache this
57 libdir=$(get_libdir)
58
59 PHPIZE="/usr/${libdir}/php4/bin/phpize"
60 PHPCONFIG="/usr/${libdir}/php4/bin/php-config"
61 PHPCLI="/usr/${libdir}/php4/bin/php"
62 PHPCGI="/usr/${libdir}/php4/bin/php-cgi"
63 PHP_PKG="`best_version =dev-lang/php-4*`"
64 PHPPREFIX="/usr/${libdir}/php4"
65 EXT_DIR="`${PHPCONFIG} --extension-dir 2>/dev/null`"
66
67 einfo
68 einfo "Using ${PHP_PKG}"
69 einfo
70}
71 19
72# PHP5-only depend functions 20# PHP5-only depend functions
73 21
74# @FUNCTION: need_php5_cli 22# @FUNCTION: need_php5_cli
75# @DESCRIPTION: 23# @DESCRIPTION:
76# Set this after setting DEPEND/RDEPEND in your ebuild if the ebuild requires PHP5 24# Set this after setting DEPEND/RDEPEND in your ebuild if the ebuild requires PHP5
77# with cli SAPI. 25# with cli SAPI.
78need_php5_cli() { 26need_php5_cli() {
79 DEPEND="${DEPEND} =virtual/php-5*" 27 DEPEND="${DEPEND} =dev-lang/php-5*"
80 RDEPEND="${RDEPEND} =virtual/php-5*" 28 RDEPEND="${RDEPEND} =dev-lang/php-5*"
81 PHP_VERSION="5" 29 PHP_VERSION="5"
82} 30}
83 31
84# @FUNCTION: need_php5_httpd 32# @FUNCTION: need_php5_httpd
85# @DESCRIPTION: 33# @DESCRIPTION:
109 57
110 PHPIZE="/usr/${libdir}/php5/bin/phpize" 58 PHPIZE="/usr/${libdir}/php5/bin/phpize"
111 PHPCONFIG="/usr/${libdir}/php5/bin/php-config" 59 PHPCONFIG="/usr/${libdir}/php5/bin/php-config"
112 PHPCLI="/usr/${libdir}/php5/bin/php" 60 PHPCLI="/usr/${libdir}/php5/bin/php"
113 PHPCGI="/usr/${libdir}/php5/bin/php-cgi" 61 PHPCGI="/usr/${libdir}/php5/bin/php-cgi"
114 PHP_PKG="`best_version =dev-lang/php-5*`" 62 PHP_PKG="$(best_version =dev-lang/php-5*)"
115 PHPPREFIX="/usr/${libdir}/php5" 63 PHPPREFIX="/usr/${libdir}/php5"
116 EXT_DIR="`${PHPCONFIG} --extension-dir 2>/dev/null`" 64 EXT_DIR="$(${PHPCONFIG} --extension-dir 2>/dev/null)"
117 65
118 einfo 66 einfo
119 einfo "Using ${PHP_PKG}" 67 einfo "Using ${PHP_PKG}"
120 einfo 68 einfo
121} 69}
125# @FUNCTION: need_php_cli 73# @FUNCTION: need_php_cli
126# @DESCRIPTION: 74# @DESCRIPTION:
127# Set this after setting DEPEND/RDEPEND in your ebuild if the ebuild requires PHP 75# Set this after setting DEPEND/RDEPEND in your ebuild if the ebuild requires PHP
128# (any version) with cli SAPI. 76# (any version) with cli SAPI.
129need_php_cli() { 77need_php_cli() {
130 DEPEND="${DEPEND} virtual/php" 78 DEPEND="${DEPEND} dev-lang/php"
131 RDEPEND="${RDEPEND} virtual/php" 79 RDEPEND="${RDEPEND} dev-lang/php"
132} 80}
133 81
134# @FUNCTION: need_php_httpd 82# @FUNCTION: need_php_httpd
135# @DESCRIPTION: 83# @DESCRIPTION:
136# Set this after setting DEPEND/RDEPEND in your ebuild if the ebuild requires PHP 84# Set this after setting DEPEND/RDEPEND in your ebuild if the ebuild requires PHP
151} 99}
152 100
153# @FUNCTION: need_php_by_category 101# @FUNCTION: need_php_by_category
154# @DESCRIPTION: 102# @DESCRIPTION:
155# Set this after setting DEPEND/RDEPEND in your ebuild to depend on PHP version 103# Set this after setting DEPEND/RDEPEND in your ebuild to depend on PHP version
156# determined by ${CATEGORY} - any PHP version, PHP4 or PHP5 for dev-php, dev-php4 and 104# determined by ${CATEGORY} - any PHP version or PHP5 for dev-php or
157# dev-php5, respectively. 105# dev-php5, respectively.
158need_php_by_category() { 106need_php_by_category() {
159 case "${CATEGORY}" in 107 case "${CATEGORY}" in
160 dev-php) need_php ;; 108 dev-php) need_php ;;
161 dev-php4) need_php4 ;;
162 dev-php5) need_php5 ;;
163 *) die "Version of PHP required by packages in category ${CATEGORY} unknown" 109 *) die "Version of PHP required by packages in category ${CATEGORY} unknown"
164 esac 110 esac
165} 111}
166 112
167 113
168# @FUNCTION: has_php 114# @FUNCTION: has_php
169# @DESCRIPTION: 115# @DESCRIPTION:
170# Call this function from your pkg_setup, src_compile, src_install etc. if you 116# Call this function from your pkg_setup, src_compile, src_install etc. if you
171# need to know which PHP version is being used and where the PHP binaries/data 117# need to know which PHP version is being used and where the PHP binaries/data
172# are installed. 118# are installed.
173has_php() { 119has_php() {
174 # If PHP_PKG is already set, then we have remembered our PHP settings
175 # from last time
176 if [[ -n ${PHP_PKG} ]] ; then
177 return
178 fi
179
180 if [[ -z ${PHP_VERSION} ]] ; then
181 # Detect which PHP version we have installed 120 # Detect which PHP version we have installed
182 if has_version '=dev-lang/php-5*' ; then 121 if has_version '=dev-lang/php-5*' ; then
183 PHP_VERSION="5" 122 PHP_VERSION="5"
184 elif has_version '=dev-lang/php-4*' ; then
185 PHP_VERSION="4"
186 else 123 else
187 die "Unable to find an installed dev-lang/php package" 124 die "Unable to find an installed dev-lang/php package"
188 fi
189 fi 125 fi
190 126
191 # If we get here, then PHP_VERSION tells us which version of PHP we 127 # If we get here, then PHP_VERSION tells us which version of PHP we
192 # want to use 128 # want to use
193 uses_php${PHP_VERSION} 129 uses_php${PHP_VERSION}
203# of them is available. 139# of them is available.
204# 140#
205# Unfortunately, if you want to be really sure that the required SAPI is 141# Unfortunately, if you want to be really sure that the required SAPI is
206# provided by PHP, you will have to use this function or similar ones (like 142# provided by PHP, you will have to use this function or similar ones (like
207# require_php_cli or require_php_cgi) in pkg_setup until we are able to 143# require_php_cli or require_php_cgi) in pkg_setup until we are able to
208# depend on USE flags being enabled. The above described need_php[45]_cli 144# depend on USE flags being enabled. The above described need_php[45]_cli
209# and need_php[45]_httpd functions cannot guarantee these requirements. 145# and need_php[45]_httpd functions cannot guarantee these requirements.
210# See Bug 2272 for details. 146# See Bug 2272 for details.
211require_php_sapi_from() { 147require_php_sapi_from() {
212 has_php 148 has_php
213 149
245 181
246# @VARIABLE: PHPCHECKNODIE 182# @VARIABLE: PHPCHECKNODIE
247# @DESCRIPTION: 183# @DESCRIPTION:
248# You can set PHPCHECKNODIE to non-empty value in your ebuild to chain multiple 184# You can set PHPCHECKNODIE to non-empty value in your ebuild to chain multiple
249# require_php_with_(any)_use checks without making the ebuild die on every failure. 185# require_php_with_(any)_use checks without making the ebuild die on every failure.
250# This is useful in cases when certain PHP features are only required if specific 186# This is useful in cases when certain PHP features are only required if specific
251# USE flag(s) are enabled for that ebuild. 187# USE flag(s) are enabled for that ebuild.
252# @CODE 188# @CODE
253# Example: 189# Example:
254# 190#
255# local flags="pcre session snmp sockets wddx" 191# local flags="pcre session snmp sockets wddx"
267 local x 203 local x
268 204
269 einfo "Checking for required PHP feature(s) ..." 205 einfo "Checking for required PHP feature(s) ..."
270 206
271 for x in $@ ; do 207 for x in $@ ; do
208 case $x in
209 pcre|spl|reflection|mhash)
210 eqawarn "require_php_with_use MUST NOT check for the pcre, spl, mhash or reflection USE flag."
211 eqawarn "These USE flags are removed from >=dev-lang/php-5.3 and your ebuild will break"
212 eqawarn "if you check the USE flags against PHP 5.3 ebuilds."
213 eqawarn "Please use USE dependencies from EAPI 2 instead"
214 ;;
215 esac
216
272 if ! built_with_use =${PHP_PKG} ${x} && ! phpconfutils_built_with_use =${PHP_PKG} ${x} ; then 217 if ! built_with_use =${PHP_PKG} ${x} && ! phpconfutils_built_with_use =${PHP_PKG} ${x} ; then
273 einfo " Discovered missing USE flag: ${x}" 218 einfo " Discovered missing USE flag: ${x}"
274 missing_use="${missing_use} ${x}" 219 missing_use="${missing_use} ${x}"
275 fi 220 fi
276 done 221 done
395# ======================================================================== 340# ========================================================================
396 341
397# @FUNCTION: require_pdo 342# @FUNCTION: require_pdo
398# @DESCRIPTION: 343# @DESCRIPTION:
399# Require a PHP built with PDO support (PHP5 only). 344# Require a PHP built with PDO support (PHP5 only).
345# This function is now redundant and DEPRECATED since
346# pdo-external use flag and pecl-pdo-* ebuilds were removed.
347# You should use require_php_with_use pdo instead now.
400# @RETURN: die if feature is missing 348# @RETURN: die if feature is missing
401require_pdo() { 349require_pdo() {
402 has_php 350 has_php
403 351
404 # Do we have PHP5 installed?
405 if [[ "${PHP_VERSION}" == "4" ]] ; then
406 eerror
407 eerror "This package requires PDO."
408 eerror "PDO is only available for PHP 5."
409 eerror "You must install >=dev-lang/php-5.1 with"
410 eerror "either the 'pdo' or the 'pdo-external'"
411 eerror "USE flags turned on."
412 eerror
413 die "PHP 5 not installed"
414 fi
415
416 # Was PHP5 compiled with internal PDO support? 352 # Was PHP5 compiled with internal PDO support?
417 if built_with_use =${PHP_PKG} pdo || phpconfutils_built_with_use =${PHP_PKG} pdo ; then 353 if built_with_use =${PHP_PKG} pdo || phpconfutils_built_with_use =${PHP_PKG} pdo ; then
418 return 354 return
419 fi 355 else
420
421 # Ok, maybe PDO was built as an external extension?
422 if ( built_with_use =${PHP_PKG} pdo-external || phpconfutils_built_with_use =${PHP_PKG} pdo-external ) && has_version 'dev-php5/pecl-pdo' ; then
423 return
424 fi
425
426 # Ok, as last resort, it suffices that pecl-pdo was installed to have PDO support
427 if has_version 'dev-php5/pecl-pdo' ; then
428 return
429 fi
430
431 # If we get here, then we don't have PDO support
432 eerror 356 eerror
433 eerror "No PDO extension for PHP found." 357 eerror "No PDO extension for PHP found."
434 eerror "Please note that PDO only exists for PHP 5." 358 eerror "Please note that PDO only exists for PHP 5."
435 eerror "Please install a PDO extension for PHP 5," 359 eerror "Please install a PDO extension for PHP 5."
436 eerror "you must install >=dev-lang/php-5.1 with" 360 eerror "You must install >=dev-lang/php-5.1 with USE=\"pdo\"."
437 eerror "either the 'pdo' or the 'pdo-external'"
438 eerror "USE flags turned on."
439 eerror 361 eerror
440 die "No PDO extension for PHP 5 found" 362 die "No PDO extension for PHP 5 found"
363 fi
441} 364}
442 365
443# @FUNCTION: require_php_cli 366# @FUNCTION: require_php_cli
444# @DESCRIPTION: 367# @DESCRIPTION:
445# Determines which installed PHP version has the CLI SAPI enabled. 368# Determines which installed PHP version has the CLI SAPI enabled.
453 return 376 return
454 fi 377 fi
455 378
456 local PHP_PACKAGE_FOUND="" 379 local PHP_PACKAGE_FOUND=""
457 380
458 # Detect which PHP version we have installed
459 if has_version '=dev-lang/php-4*' ; then
460 PHP_PACKAGE_FOUND="1"
461 pkg="`best_version '=dev-lang/php-4*'`"
462 if built_with_use =${pkg} cli || phpconfutils_built_with_use =${pkg} cli ; then
463 PHP_VERSION="4"
464 fi
465 fi
466
467 if has_version '=dev-lang/php-5*' ; then 381 if has_version '=dev-lang/php-5*' ; then
468 PHP_PACKAGE_FOUND="1" 382 PHP_PACKAGE_FOUND="1"
469 pkg="`best_version '=dev-lang/php-5*'`" 383 pkg="$(best_version '=dev-lang/php-5*')"
470 if built_with_use =${pkg} cli || phpconfutils_built_with_use =${pkg} cli ; then 384 if built_with_use =${pkg} cli || phpconfutils_built_with_use =${pkg} cli ; then
471 PHP_VERSION="5" 385 PHP_VERSION="5"
472 fi 386 fi
473 fi 387 fi
474 388
497 return 411 return
498 fi 412 fi
499 413
500 local PHP_PACKAGE_FOUND="" 414 local PHP_PACKAGE_FOUND=""
501 415
502 # Detect which PHP version we have installed
503 if has_version '=dev-lang/php-4*' ; then
504 PHP_PACKAGE_FOUND="1"
505 pkg="`best_version '=dev-lang/php-4*'`"
506 if built_with_use =${pkg} cgi || phpconfutils_built_with_use =${pkg} cgi ; then
507 PHP_VERSION="4"
508 fi
509 fi
510
511 if has_version '=dev-lang/php-5*' ; then 416 if has_version '=dev-lang/php-5*' ; then
512 PHP_PACKAGE_FOUND="1" 417 PHP_PACKAGE_FOUND="1"
513 pkg="`best_version '=dev-lang/php-5*'`" 418 pkg="$(best_version '=dev-lang/php-5*')"
514 if built_with_use =${pkg} cgi || phpconfutils_built_with_use =${pkg} cgi ; then 419 if built_with_use =${pkg} cgi || phpconfutils_built_with_use =${pkg} cgi ; then
515 PHP_VERSION="5" 420 PHP_VERSION="5"
516 fi 421 fi
517 fi 422 fi
518 423
537 has_php 442 has_php
538 443
539 # Has our PHP been built with SQLite support? 444 # Has our PHP been built with SQLite support?
540 if built_with_use =${PHP_PKG} sqlite || phpconfutils_built_with_use =${PHP_PKG} sqlite ; then 445 if built_with_use =${PHP_PKG} sqlite || phpconfutils_built_with_use =${PHP_PKG} sqlite ; then
541 return 446 return
542 fi
543
544 # Do we have pecl-sqlite installed for PHP4?
545 if [[ "${PHP_VERSION}" == "4" ]] ; then
546 if has_version 'dev-php4/pecl-sqlite' ; then
547 return
548 fi
549 fi 447 fi
550 448
551 # If we get here, then we don't have any SQLite support for PHP installed 449 # If we get here, then we don't have any SQLite support for PHP installed
552 eerror 450 eerror
553 eerror "No SQLite extension for PHP found." 451 eerror "No SQLite extension for PHP found."
632 530
633# @FUNCTION: dodoc-php 531# @FUNCTION: dodoc-php
634# @USAGE: <list of docs> 532# @USAGE: <list of docs>
635# @DESCRIPTION: 533# @DESCRIPTION:
636# Alternative to dodoc function for use in our PHP eclasses and ebuilds. 534# Alternative to dodoc function for use in our PHP eclasses and ebuilds.
637# Stored here because depend.php gets always sourced everywhere in the PHP 535# Stored here because depend.php gets always sourced everywhere in the PHP
638# ebuilds and eclasses. It simply is dodoc with a changed path to the docs. 536# ebuilds and eclasses. It simply is dodoc with a changed path to the docs.
639# NOTE: No support for docinto is provided! 537# NOTE: No support for docinto is provided!
640dodoc-php() { 538dodoc-php() {
641if [[ $# -lt 1 ]] ; then 539if [[ $# -lt 1 ]] ; then
642 echo "$0: at least one argument needed" 1>&2 540 echo "$0: at least one argument needed" 1>&2
643 exit 1 541 exit 1
644fi 542fi
645 543
646phpdocdir="${D}/usr/share/doc/${CATEGORY}/${PF}/" 544phpdocdir="/usr/share/doc/${CATEGORY}/${PF}/"
647
648if [[ ! -d "${phpdocdir}" ]] ; then
649 install -d "${phpdocdir}"
650fi
651 545
652for x in $@ ; do 546for x in $@ ; do
653 if [[ -s "${x}" ]] ; then 547 if [[ -s "${x}" ]] ; then
654 install -m0644 "${x}" "${phpdocdir}" 548 insinto "${phpdocdir}"
549 doins "${x}"
655 gzip -f -9 "${phpdocdir}/${x##*/}" 550 gzip -f -9 "${D}/${phpdocdir}/${x##*/}"
656 elif [[ ! -e "${x}" ]] ; then 551 elif [[ ! -e "${x}" ]] ; then
657 echo "dodoc-php: ${x} does not exist" 1>&2 552 echo "dodoc-php: ${x} does not exist" 1>&2
658 fi 553 fi
659done 554done
660} 555}
556
557# @FUNCTION: dohtml-php
558# @USAGE: <list of html docs>
559# @DESCRIPTION:
560# Alternative to dohtml function for use in our PHP eclasses and ebuilds.
561# Stored here because depend.php gets always sourced everywhere in the PHP
562# ebuilds and eclasses. It simply is dohtml with a changed path to the docs.
563# NOTE: No support for [-a|-A|-p|-x] options is provided!
564dohtml-php() {
565if [[ $# -lt 1 ]] ; then
566 echo "$0: at least one argument needed" 1>&2
567 exit 1
568fi
569
570phphtmldir="/usr/share/doc/${CATEGORY}/${PF}/html"
571
572for x in $@ ; do
573 if [[ -s "${x}" ]] ; then
574 insinto "${phphtmldir}"
575 doins "${x}"
576 elif [[ ! -e "${x}" ]] ; then
577 echo "dohtml-php: ${x} does not exist" 1>&2
578 fi
579done
580}

Legend:
Removed from v.1.21  
changed lines
  Added in v.1.32

  ViewVC Help
Powered by ViewVC 1.1.20