/[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.27
1# Copyright 1999-2007 Gentoo Foundation 1# Copyright 1999-2007 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.27 2010/10/02 15:23:57 olemarkus Exp $
4 4
5# Author: Stuart Herbert <stuart@gentoo.org> 5# Author: Stuart Herbert <stuart@gentoo.org>
6# Author: Luca Longinotti <chtekk@gentoo.org> 6# Author: Luca Longinotti <chtekk@gentoo.org>
7# Author: Jakub Moc <jakub@gentoo.org> (documentation) 7# Author: Jakub Moc <jakub@gentoo.org> (documentation)
8 8
9# @ECLASS: depend.php.eclass 9# @ECLASS: depend.php.eclass
10# @MAINTAINER: 10# @MAINTAINER:
11# Gentoo PHP team <php-bugs@gentoo.org> 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 18
19inherit eutils phpconfutils 19inherit eutils 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 20
72# PHP5-only depend functions 21# PHP5-only depend functions
73 22
74# @FUNCTION: need_php5_cli 23# @FUNCTION: need_php5_cli
75# @DESCRIPTION: 24# @DESCRIPTION:
109 58
110 PHPIZE="/usr/${libdir}/php5/bin/phpize" 59 PHPIZE="/usr/${libdir}/php5/bin/phpize"
111 PHPCONFIG="/usr/${libdir}/php5/bin/php-config" 60 PHPCONFIG="/usr/${libdir}/php5/bin/php-config"
112 PHPCLI="/usr/${libdir}/php5/bin/php" 61 PHPCLI="/usr/${libdir}/php5/bin/php"
113 PHPCGI="/usr/${libdir}/php5/bin/php-cgi" 62 PHPCGI="/usr/${libdir}/php5/bin/php-cgi"
114 PHP_PKG="`best_version =dev-lang/php-5*`" 63 PHP_PKG="$(best_version =dev-lang/php-5*)"
115 PHPPREFIX="/usr/${libdir}/php5" 64 PHPPREFIX="/usr/${libdir}/php5"
116 EXT_DIR="`${PHPCONFIG} --extension-dir 2>/dev/null`" 65 EXT_DIR="$(${PHPCONFIG} --extension-dir 2>/dev/null)"
117 66
118 einfo 67 einfo
119 einfo "Using ${PHP_PKG}" 68 einfo "Using ${PHP_PKG}"
120 einfo 69 einfo
121} 70}
151} 100}
152 101
153# @FUNCTION: need_php_by_category 102# @FUNCTION: need_php_by_category
154# @DESCRIPTION: 103# @DESCRIPTION:
155# Set this after setting DEPEND/RDEPEND in your ebuild to depend on PHP version 104# 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 105# determined by ${CATEGORY} - any PHP version or PHP5 for dev-php or
157# dev-php5, respectively. 106# dev-php5, respectively.
158need_php_by_category() { 107need_php_by_category() {
159 case "${CATEGORY}" in 108 case "${CATEGORY}" in
160 dev-php) need_php ;; 109 dev-php) need_php ;;
161 dev-php4) need_php4 ;;
162 dev-php5) need_php5 ;; 110 dev-php5) need_php5 ;;
163 *) die "Version of PHP required by packages in category ${CATEGORY} unknown" 111 *) die "Version of PHP required by packages in category ${CATEGORY} unknown"
164 esac 112 esac
165} 113}
166 114
167 115
168# @FUNCTION: has_php 116# @FUNCTION: has_php
169# @DESCRIPTION: 117# @DESCRIPTION:
170# Call this function from your pkg_setup, src_compile, src_install etc. if you 118# 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 119# need to know which PHP version is being used and where the PHP binaries/data
172# are installed. 120# are installed.
173has_php() { 121has_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 122 # Detect which PHP version we have installed
182 if has_version '=dev-lang/php-5*' ; then 123 if has_version '=dev-lang/php-5*' ; then
183 PHP_VERSION="5" 124 PHP_VERSION="5"
184 elif has_version '=dev-lang/php-4*' ; then
185 PHP_VERSION="4"
186 else 125 else
187 die "Unable to find an installed dev-lang/php package" 126 die "Unable to find an installed dev-lang/php package"
188 fi
189 fi 127 fi
190 128
191 # If we get here, then PHP_VERSION tells us which version of PHP we 129 # If we get here, then PHP_VERSION tells us which version of PHP we
192 # want to use 130 # want to use
193 uses_php${PHP_VERSION} 131 uses_php${PHP_VERSION}
203# of them is available. 141# of them is available.
204# 142#
205# Unfortunately, if you want to be really sure that the required SAPI is 143# 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 144# 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 145# 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 146# depend on USE flags being enabled. The above described need_php[45]_cli
209# and need_php[45]_httpd functions cannot guarantee these requirements. 147# and need_php[45]_httpd functions cannot guarantee these requirements.
210# See Bug 2272 for details. 148# See Bug 2272 for details.
211require_php_sapi_from() { 149require_php_sapi_from() {
212 has_php 150 has_php
213 151
245 183
246# @VARIABLE: PHPCHECKNODIE 184# @VARIABLE: PHPCHECKNODIE
247# @DESCRIPTION: 185# @DESCRIPTION:
248# You can set PHPCHECKNODIE to non-empty value in your ebuild to chain multiple 186# 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. 187# 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 188# This is useful in cases when certain PHP features are only required if specific
251# USE flag(s) are enabled for that ebuild. 189# USE flag(s) are enabled for that ebuild.
252# @CODE 190# @CODE
253# Example: 191# Example:
254# 192#
255# local flags="pcre session snmp sockets wddx" 193# local flags="pcre session snmp sockets wddx"
267 local x 205 local x
268 206
269 einfo "Checking for required PHP feature(s) ..." 207 einfo "Checking for required PHP feature(s) ..."
270 208
271 for x in $@ ; do 209 for x in $@ ; do
210 case $x in
211 pcre|spl|reflection)
212 eqawarn "require_php_with_use MUST NOT check for the pcre, spl or reflection USE flag."
213 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
272 if ! built_with_use =${PHP_PKG} ${x} && ! phpconfutils_built_with_use =${PHP_PKG} ${x} ; then 219 if ! built_with_use =${PHP_PKG} ${x} && ! phpconfutils_built_with_use =${PHP_PKG} ${x} ; then
273 einfo " Discovered missing USE flag: ${x}" 220 einfo " Discovered missing USE flag: ${x}"
274 missing_use="${missing_use} ${x}" 221 missing_use="${missing_use} ${x}"
275 fi 222 fi
276 done 223 done
395# ======================================================================== 342# ========================================================================
396 343
397# @FUNCTION: require_pdo 344# @FUNCTION: require_pdo
398# @DESCRIPTION: 345# @DESCRIPTION:
399# Require a PHP built with PDO support (PHP5 only). 346# Require a PHP built with PDO support (PHP5 only).
347# 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.
400# @RETURN: die if feature is missing 350# @RETURN: die if feature is missing
401require_pdo() { 351require_pdo() {
402 has_php 352 has_php
403 353
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? 354 # Was PHP5 compiled with internal PDO support?
417 if built_with_use =${PHP_PKG} pdo || phpconfutils_built_with_use =${PHP_PKG} pdo ; then 355 if built_with_use =${PHP_PKG} pdo || phpconfutils_built_with_use =${PHP_PKG} pdo ; then
418 return 356 return
419 fi 357 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 358 eerror
433 eerror "No PDO extension for PHP found." 359 eerror "No PDO extension for PHP found."
434 eerror "Please note that PDO only exists for PHP 5." 360 eerror "Please note that PDO only exists for PHP 5."
435 eerror "Please install a PDO extension for PHP 5," 361 eerror "Please install a PDO extension for PHP 5."
436 eerror "you must install >=dev-lang/php-5.1 with" 362 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 363 eerror
440 die "No PDO extension for PHP 5 found" 364 die "No PDO extension for PHP 5 found"
365 fi
441} 366}
442 367
443# @FUNCTION: require_php_cli 368# @FUNCTION: require_php_cli
444# @DESCRIPTION: 369# @DESCRIPTION:
445# Determines which installed PHP version has the CLI SAPI enabled. 370# Determines which installed PHP version has the CLI SAPI enabled.
453 return 378 return
454 fi 379 fi
455 380
456 local PHP_PACKAGE_FOUND="" 381 local PHP_PACKAGE_FOUND=""
457 382
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 383 if has_version '=dev-lang/php-5*' ; then
468 PHP_PACKAGE_FOUND="1" 384 PHP_PACKAGE_FOUND="1"
469 pkg="`best_version '=dev-lang/php-5*'`" 385 pkg="$(best_version '=dev-lang/php-5*')"
470 if built_with_use =${pkg} cli || phpconfutils_built_with_use =${pkg} cli ; then 386 if built_with_use =${pkg} cli || phpconfutils_built_with_use =${pkg} cli ; then
471 PHP_VERSION="5" 387 PHP_VERSION="5"
472 fi 388 fi
473 fi 389 fi
474 390
497 return 413 return
498 fi 414 fi
499 415
500 local PHP_PACKAGE_FOUND="" 416 local PHP_PACKAGE_FOUND=""
501 417
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 418 if has_version '=dev-lang/php-5*' ; then
512 PHP_PACKAGE_FOUND="1" 419 PHP_PACKAGE_FOUND="1"
513 pkg="`best_version '=dev-lang/php-5*'`" 420 pkg="$(best_version '=dev-lang/php-5*')"
514 if built_with_use =${pkg} cgi || phpconfutils_built_with_use =${pkg} cgi ; then 421 if built_with_use =${pkg} cgi || phpconfutils_built_with_use =${pkg} cgi ; then
515 PHP_VERSION="5" 422 PHP_VERSION="5"
516 fi 423 fi
517 fi 424 fi
518 425
537 has_php 444 has_php
538 445
539 # Has our PHP been built with SQLite support? 446 # Has our PHP been built with SQLite support?
540 if built_with_use =${PHP_PKG} sqlite || phpconfutils_built_with_use =${PHP_PKG} sqlite ; then 447 if built_with_use =${PHP_PKG} sqlite || phpconfutils_built_with_use =${PHP_PKG} sqlite ; then
541 return 448 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 449 fi
550 450
551 # If we get here, then we don't have any SQLite support for PHP installed 451 # If we get here, then we don't have any SQLite support for PHP installed
552 eerror 452 eerror
553 eerror "No SQLite extension for PHP found." 453 eerror "No SQLite extension for PHP found."
632 532
633# @FUNCTION: dodoc-php 533# @FUNCTION: dodoc-php
634# @USAGE: <list of docs> 534# @USAGE: <list of docs>
635# @DESCRIPTION: 535# @DESCRIPTION:
636# Alternative to dodoc function for use in our PHP eclasses and ebuilds. 536# 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 537# 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. 538# ebuilds and eclasses. It simply is dodoc with a changed path to the docs.
639# NOTE: No support for docinto is provided! 539# NOTE: No support for docinto is provided!
640dodoc-php() { 540dodoc-php() {
641if [[ $# -lt 1 ]] ; then 541if [[ $# -lt 1 ]] ; then
642 echo "$0: at least one argument needed" 1>&2 542 echo "$0: at least one argument needed" 1>&2
643 exit 1 543 exit 1
644fi 544fi
645 545
646phpdocdir="${D}/usr/share/doc/${CATEGORY}/${PF}/" 546phpdocdir="/usr/share/doc/${CATEGORY}/${PF}/"
647
648if [[ ! -d "${phpdocdir}" ]] ; then
649 install -d "${phpdocdir}"
650fi
651 547
652for x in $@ ; do 548for x in $@ ; do
653 if [[ -s "${x}" ]] ; then 549 if [[ -s "${x}" ]] ; then
654 install -m0644 "${x}" "${phpdocdir}" 550 insinto "${phpdocdir}"
551 doins "${x}"
655 gzip -f -9 "${phpdocdir}/${x##*/}" 552 gzip -f -9 "${D}/${phpdocdir}/${x##*/}"
656 elif [[ ! -e "${x}" ]] ; then 553 elif [[ ! -e "${x}" ]] ; then
657 echo "dodoc-php: ${x} does not exist" 1>&2 554 echo "dodoc-php: ${x} does not exist" 1>&2
658 fi 555 fi
659done 556done
660} 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!
566dohtml-php() {
567if [[ $# -lt 1 ]] ; then
568 echo "$0: at least one argument needed" 1>&2
569 exit 1
570fi
571
572phphtmldir="/usr/share/doc/${CATEGORY}/${PF}/html"
573
574for x in $@ ; do
575 if [[ -s "${x}" ]] ; then
576 insinto "${phphtmldir}"
577 doins "${x}"
578 elif [[ ! -e "${x}" ]] ; then
579 echo "dohtml-php: ${x} does not exist" 1>&2
580 fi
581done
582}

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

  ViewVC Help
Powered by ViewVC 1.1.20