/[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.25 Revision 1.37
1# Copyright 1999-2007 Gentoo Foundation 1# Copyright 1999-2015 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.25 2008/02/26 16:26:08 armin76 Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/depend.php.eclass,v 1.37 2015/07/17 18:29:39 grknight Exp $
4 4
5# @DEAD
6# @ECLASS: depend.php.eclass
7# @MAINTAINER:
8# Gentoo PHP team <php-bugs@gentoo.org>
9# @AUTHOR:
5# Author: Stuart Herbert <stuart@gentoo.org> 10# Author: Stuart Herbert <stuart@gentoo.org>
6# Author: Luca Longinotti <chtekk@gentoo.org> 11# Author: Luca Longinotti <chtekk@gentoo.org>
7# Author: Jakub Moc <jakub@gentoo.org> (documentation) 12# 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. 13# @BLURB: Functions to allow ebuilds to depend on php5 and check for specific features.
13# @DESCRIPTION: 14# @DESCRIPTION:
14# This eclass provides functions that allow ebuilds to depend on php[45] and check 15# 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 16# for specific PHP features, SAPIs etc. Also provides dodoc-php wrapper to install
16# documentation for PHP packages to php-specific location. 17# documentation for PHP packages to php-specific location.
18# This eclass is deprecated and is set to be removed 30 days after bug 552836 is resolved
17 19
18
19inherit eutils phpconfutils 20inherit eutils multilib
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 21
72# PHP5-only depend functions 22# PHP5-only depend functions
73
74# @FUNCTION: need_php5_cli
75# @DESCRIPTION:
76# Set this after setting DEPEND/RDEPEND in your ebuild if the ebuild requires PHP5
77# with cli SAPI.
78need_php5_cli() {
79 DEPEND="${DEPEND} =virtual/php-5*"
80 RDEPEND="${RDEPEND} =virtual/php-5*"
81 PHP_VERSION="5"
82}
83
84# @FUNCTION: need_php5_httpd
85# @DESCRIPTION:
86# Set this after setting DEPEND/RDEPEND in your ebuild if the ebuild requires PHP5
87# with either cgi or apache2 SAPI.
88need_php5_httpd() {
89 DEPEND="${DEPEND} =virtual/httpd-php-5*"
90 RDEPEND="${RDEPEND} =virtual/httpd-php-5*"
91 PHP_VERSION="5"
92}
93 23
94# @FUNCTION: need_php5 24# @FUNCTION: need_php5
95# @DESCRIPTION: 25# @DESCRIPTION:
96# Set this after setting DEPEND/RDEPEND in your ebuild if the ebuild requires PHP5 26# Set this after setting DEPEND/RDEPEND in your ebuild if the ebuild requires PHP5
97# (with any SAPI). 27# (with any SAPI).
120 einfo 50 einfo
121} 51}
122 52
123# general PHP depend functions 53# general PHP depend functions
124 54
125# @FUNCTION: need_php_cli
126# @DESCRIPTION:
127# Set this after setting DEPEND/RDEPEND in your ebuild if the ebuild requires PHP
128# (any version) with cli SAPI.
129need_php_cli() {
130 DEPEND="${DEPEND} virtual/php"
131 RDEPEND="${RDEPEND} virtual/php"
132}
133
134# @FUNCTION: need_php_httpd 55# @FUNCTION: need_php_httpd
135# @DESCRIPTION: 56# @DESCRIPTION:
136# Set this after setting DEPEND/RDEPEND in your ebuild if the ebuild requires PHP 57# Set this after setting DEPEND/RDEPEND in your ebuild if the ebuild requires PHP
137# (any version) with either cgi or apache2 SAPI. 58# (any version) with either cgi or apache2 SAPI.
138need_php_httpd() { 59need_php_httpd() {
147need_php() { 68need_php() {
148 DEPEND="${DEPEND} dev-lang/php" 69 DEPEND="${DEPEND} dev-lang/php"
149 RDEPEND="${RDEPEND} dev-lang/php" 70 RDEPEND="${RDEPEND} dev-lang/php"
150 PHP_SHARED_CAT="php" 71 PHP_SHARED_CAT="php"
151} 72}
152
153# @FUNCTION: need_php_by_category
154# @DESCRIPTION:
155# 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
157# dev-php5, respectively.
158need_php_by_category() {
159 case "${CATEGORY}" in
160 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"
164 esac
165}
166
167 73
168# @FUNCTION: has_php 74# @FUNCTION: has_php
169# @DESCRIPTION: 75# @DESCRIPTION:
170# Call this function from your pkg_setup, src_compile, src_install etc. if you 76# 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 77# need to know which PHP version is being used and where the PHP binaries/data
172# are installed. 78# are installed.
173has_php() { 79has_php() {
174 # Detect which PHP version we have installed 80 # Detect which PHP version we have installed
175 if has_version '=dev-lang/php-5*' ; then 81 if has_version '=dev-lang/php-5*' ; then
176 PHP_VERSION="5" 82 PHP_VERSION="5"
177 elif has_version '=dev-lang/php-4*' ; then
178 PHP_VERSION="4"
179 else 83 else
180 die "Unable to find an installed dev-lang/php package" 84 die "Unable to find an installed dev-lang/php package"
181 fi 85 fi
182 86
183 # If we get here, then PHP_VERSION tells us which version of PHP we 87 # If we get here, then PHP_VERSION tells us which version of PHP we
184 # want to use 88 # want to use
185 uses_php${PHP_VERSION} 89 uses_php${PHP_VERSION}
186}
187
188# @FUNCTION: require_php_sapi_from
189# @USAGE: <list of SAPIs>
190# @DESCRIPTION:
191# Call this function from pkg_setup if your package only works with
192# specific SAPI(s) and specify a list of PHP SAPI USE flags that are
193# required (one or more from cli, cgi, apache2) as arguments.
194# Returns if any of the listed SAPIs have been installed, dies if none
195# of them is available.
196#
197# Unfortunately, if you want to be really sure that the required SAPI is
198# provided by PHP, you will have to use this function or similar ones (like
199# require_php_cli or require_php_cgi) in pkg_setup until we are able to
200# depend on USE flags being enabled. The above described need_php[45]_cli
201# and need_php[45]_httpd functions cannot guarantee these requirements.
202# See Bug 2272 for details.
203require_php_sapi_from() {
204 has_php
205
206 local has_sapi="0"
207 local x
208
209 einfo "Checking for compatible SAPI(s)"
210
211 for x in $@ ; do
212 if built_with_use =${PHP_PKG} ${x} || phpconfutils_built_with_use =${PHP_PKG} ${x} ; then
213 einfo " Discovered compatible SAPI ${x}"
214 has_sapi="1"
215 fi
216 done
217
218 if [[ "${has_sapi}" == "1" ]] ; then
219 return
220 fi
221
222 eerror
223 eerror "${PHP_PKG} needs to be re-installed with one of the following"
224 eerror "USE flags enabled:"
225 eerror
226 eerror " $@"
227 eerror
228 die "No compatible PHP SAPIs found"
229} 90}
230 91
231# @FUNCTION: require_php_with_use 92# @FUNCTION: require_php_with_use
232# @USAGE: <list of USE flags> 93# @USAGE: <list of USE flags>
233# @DESCRIPTION: 94# @DESCRIPTION:
259 local x 120 local x
260 121
261 einfo "Checking for required PHP feature(s) ..." 122 einfo "Checking for required PHP feature(s) ..."
262 123
263 for x in $@ ; do 124 for x in $@ ; do
264 if ! built_with_use =${PHP_PKG} ${x} && ! phpconfutils_built_with_use =${PHP_PKG} ${x} ; then 125 case $x in
126 pcre|spl|reflection|mhash)
127 eqawarn "require_php_with_use MUST NOT check for the pcre, spl, mhash or reflection USE flag."
128 eqawarn "These USE flags are removed from >=dev-lang/php-5.3 and your ebuild will break"
129 eqawarn "if you check the USE flags against PHP 5.3 ebuilds."
130 eqawarn "Please use USE dependencies from EAPI 2 instead"
131 ;;
132 esac
133
134 if ! built_with_use =${PHP_PKG} ${x} ; then
265 einfo " Discovered missing USE flag: ${x}" 135 einfo " Discovered missing USE flag: ${x}"
266 missing_use="${missing_use} ${x}" 136 missing_use="${missing_use} ${x}"
267 fi 137 fi
268 done 138 done
269 139
286 else 156 else
287 return 1 157 return 1
288 fi 158 fi
289} 159}
290 160
291# @FUNCTION: require_php_with_any_use
292# @USAGE: <list of USE flags>
293# @DESCRIPTION:
294# Call this function from pkg_setup if your package requires PHP compiled with
295# any of specified USE flags. Returns if any of the listed USE flags are enabled.
296# Dies if all of the listed USE flags are disabled.
297require_php_with_any_use() {
298 has_php
299
300 local missing_use=""
301 local x
302
303 einfo "Checking for required PHP feature(s) ..."
304
305 for x in $@ ; do
306 if built_with_use =${PHP_PKG} ${x} || phpconfutils_built_with_use =${PHP_PKG} ${x} ; then
307 einfo " USE flag ${x} is enabled, ok ..."
308 return
309 else
310 missing_use="${missing_use} ${x}"
311 fi
312 done
313
314 if [[ -z "${missing_use}" ]] ; then
315 if [[ -z "${PHPCHECKNODIE}" ]] ; then
316 return
317 else
318 return 0
319 fi
320 fi
321
322 if [[ -z "${PHPCHECKNODIE}" ]] ; then
323 eerror
324 eerror "${PHP_PKG} needs to be re-installed with any of the following"
325 eerror "USE flags enabled:"
326 eerror
327 eerror " $@"
328 eerror
329 die "Missing PHP USE flags found"
330 else
331 return 1
332 fi
333}
334
335# ========================================================================
336# has_*() functions
337#
338# These functions return 0 if the condition is satisfied, 1 otherwise
339# ========================================================================
340
341# @FUNCTION: has_zts
342# @DESCRIPTION:
343# Check if our PHP was compiled with ZTS (Zend Thread Safety) enabled.
344# @RETURN: 0 if true, 1 otherwise
345has_zts() {
346 has_php
347
348 if built_with_use =${PHP_PKG} apache2 threads || phpconfutils_built_with_use =${PHP_PKG} apache2 threads ; then
349 return 0
350 fi
351
352 return 1
353}
354
355# @FUNCTION: has_debug
356# @DESCRIPTION:
357# Check if our PHP was built with debug support enabled.
358# @RETURN: 0 if true, 1 otherwise
359has_debug() {
360 has_php
361
362 if built_with_use =${PHP_PKG} debug || phpconfutils_built_with_use =${PHP_PKG} debug ; then
363 return 0
364 fi
365
366 return 1
367}
368
369# @FUNCTION: has_concurrentmodphp
370# @DESCRIPTION:
371# Check if our PHP was built with the concurrentmodphp support enabled.
372# @RETURN: 0 if true, 1 otherwise
373has_concurrentmodphp() {
374 has_php
375
376 if built_with_use =${PHP_PKG} apache2 concurrentmodphp || phpconfutils_built_with_use =${PHP_PKG} apache2 concurrentmodphp ; then
377 return 0
378 fi
379
380 return 1
381}
382 161
383# ======================================================================== 162# ========================================================================
384# require_*() functions 163# require_*() functions
385# 164#
386# These functions die() if PHP was built without the required features 165# These functions die() if PHP was built without the required features
387# ======================================================================== 166# ========================================================================
388
389# @FUNCTION: require_pdo
390# @DESCRIPTION:
391# Require a PHP built with PDO support (PHP5 only).
392# This function is now redundant and DEPRECATED since
393# pdo-external use flag and pecl-pdo-* ebuilds were removed.
394# You should use require_php_with_use pdo instead now.
395# @RETURN: die if feature is missing
396require_pdo() {
397 has_php
398
399 # Do we have PHP5 installed?
400 if [[ "${PHP_VERSION}" == "4" ]] ; then
401 eerror
402 eerror "This package requires PDO."
403 eerror "PDO is only available for PHP 5."
404 eerror "You must install >=dev-lang/php-5.1 with USE=\"pdo\"."
405 eerror "pdo USE flags turned on."
406 eerror
407 die "PHP 5 not installed"
408 fi
409
410 # Was PHP5 compiled with internal PDO support?
411 if built_with_use =${PHP_PKG} pdo || phpconfutils_built_with_use =${PHP_PKG} pdo ; then
412 return
413 else
414 eerror
415 eerror "No PDO extension for PHP found."
416 eerror "Please note that PDO only exists for PHP 5."
417 eerror "Please install a PDO extension for PHP 5."
418 eerror "You must install >=dev-lang/php-5.1 with USE=\"pdo\"."
419 eerror
420 die "No PDO extension for PHP 5 found"
421 fi
422}
423
424# @FUNCTION: require_php_cli
425# @DESCRIPTION:
426# Determines which installed PHP version has the CLI SAPI enabled.
427# Useful for PEAR stuff, or anything which needs to run PHP script
428# depending on the CLI SAPI.
429# @RETURN: die if feature is missing
430require_php_cli() {
431 # If PHP_PKG is set, then we have remembered our PHP settings
432 # from last time
433 if [[ -n ${PHP_PKG} ]] ; then
434 return
435 fi
436
437 local PHP_PACKAGE_FOUND=""
438
439 # Detect which PHP version we have installed
440 if has_version '=dev-lang/php-4*' ; then
441 PHP_PACKAGE_FOUND="1"
442 pkg="$(best_version '=dev-lang/php-4*')"
443 if built_with_use =${pkg} cli || phpconfutils_built_with_use =${pkg} cli ; then
444 PHP_VERSION="4"
445 fi
446 fi
447
448 if has_version '=dev-lang/php-5*' ; then
449 PHP_PACKAGE_FOUND="1"
450 pkg="$(best_version '=dev-lang/php-5*')"
451 if built_with_use =${pkg} cli || phpconfutils_built_with_use =${pkg} cli ; then
452 PHP_VERSION="5"
453 fi
454 fi
455
456 if [[ -z ${PHP_PACKAGE_FOUND} ]] ; then
457 die "Unable to find an installed dev-lang/php package"
458 fi
459
460 if [[ -z ${PHP_VERSION} ]] ; then
461 die "No PHP CLI installed. Re-emerge dev-lang/php with USE=cli."
462 fi
463
464 # If we get here, then PHP_VERSION tells us which version of PHP we
465 # want to use
466 uses_php${PHP_VERSION}
467}
468 167
469# @FUNCTION: require_php_cgi 168# @FUNCTION: require_php_cgi
470# @DESCRIPTION: 169# @DESCRIPTION:
471# Determines which installed PHP version has the CGI SAPI enabled. 170# Determines which installed PHP version has the CGI SAPI enabled.
472# Useful for anything which needs to run PHP scripts depending on the CGI SAPI. 171# Useful for anything which needs to run PHP scripts depending on the CGI SAPI.
478 return 177 return
479 fi 178 fi
480 179
481 local PHP_PACKAGE_FOUND="" 180 local PHP_PACKAGE_FOUND=""
482 181
483 # Detect which PHP version we have installed
484 if has_version '=dev-lang/php-4*' ; then
485 PHP_PACKAGE_FOUND="1"
486 pkg="$(best_version '=dev-lang/php-4*')"
487 if built_with_use =${pkg} cgi || phpconfutils_built_with_use =${pkg} cgi ; then
488 PHP_VERSION="4"
489 fi
490 fi
491
492 if has_version '=dev-lang/php-5*' ; then 182 if has_version '=dev-lang/php-5*' ; then
493 PHP_PACKAGE_FOUND="1" 183 PHP_PACKAGE_FOUND="1"
494 pkg="$(best_version '=dev-lang/php-5*')" 184 pkg="$(best_version '=dev-lang/php-5*')"
495 if built_with_use =${pkg} cgi || phpconfutils_built_with_use =${pkg} cgi ; then 185 if built_with_use =${pkg} cgi ; then
496 PHP_VERSION="5" 186 PHP_VERSION="5"
497 fi 187 fi
498 fi 188 fi
499 189
500 if [[ -z ${PHP_PACKAGE_FOUND} ]] ; then 190 if [[ -z ${PHP_PACKAGE_FOUND} ]] ; then
508 # If we get here, then PHP_VERSION tells us which version of PHP we 198 # If we get here, then PHP_VERSION tells us which version of PHP we
509 # want to use 199 # want to use
510 uses_php${PHP_VERSION} 200 uses_php${PHP_VERSION}
511} 201}
512 202
513# @FUNCTION: require_sqlite
514# @DESCRIPTION:
515# Require a PHP built with SQLite support
516# @RETURN: die if feature is missing
517require_sqlite() {
518 has_php
519
520 # Has our PHP been built with SQLite support?
521 if built_with_use =${PHP_PKG} sqlite || phpconfutils_built_with_use =${PHP_PKG} sqlite ; then
522 return
523 fi
524
525 # Do we have pecl-sqlite installed for PHP4?
526 if [[ "${PHP_VERSION}" == "4" ]] ; then
527 if has_version 'dev-php4/pecl-sqlite' ; then
528 return
529 fi
530 fi
531
532 # If we get here, then we don't have any SQLite support for PHP installed
533 eerror
534 eerror "No SQLite extension for PHP found."
535 eerror "Please install an SQLite extension for PHP,"
536 eerror "this is done best by simply adding the"
537 eerror "'sqlite' USE flag when emerging dev-lang/php."
538 eerror
539 die "No SQLite extension for PHP found"
540}
541
542# @FUNCTION: require_gd
543# @DESCRIPTION:
544# Require a PHP built with GD support
545# @RETURN: die if feature is missing
546require_gd() {
547 has_php
548
549 # Do we have the internal GD support installed?
550 if built_with_use =${PHP_PKG} gd || phpconfutils_built_with_use =${PHP_PKG} gd ; then
551 return
552 fi
553
554 # Ok, maybe GD was built using the external library support?
555 if built_with_use =${PHP_PKG} gd-external || phpconfutils_built_with_use =${PHP_PKG} gd-external ; then
556 return
557 fi
558
559 # If we get here, then we have no GD support
560 eerror
561 eerror "No GD support for PHP found."
562 eerror "Please install the GD support for PHP,"
563 eerror "you must install dev-lang/php with either"
564 eerror "the 'gd' or the 'gd-external' USE flags"
565 eerror "turned on."
566 eerror
567 die "No GD support found for PHP"
568}
569
570# ======================================================================== 203# ========================================================================
571# Misc functions 204# Misc functions
572# 205#
573# These functions provide miscellaneous checks and functionality. 206# These functions provide miscellaneous checks and functionality.
574# ======================================================================== 207# ========================================================================
575
576# @FUNCTION: php_binary_extension
577# @DESCRIPTION:
578# Executes some checks needed when installing a binary PHP extension.
579php_binary_extension() {
580 has_php
581
582 local PUSE_ENABLED=""
583
584 # Binary extensions do not support the change of PHP
585 # API version, so they can't be installed when USE flags
586 # are enabled which change the PHP API version, they also
587 # don't provide correctly versioned symbols for our use
588
589 if has_debug ; then
590 eerror
591 eerror "You cannot install binary PHP extensions"
592 eerror "when the 'debug' USE flag is enabled!"
593 eerror "Please reemerge dev-lang/php with the"
594 eerror "'debug' USE flag turned off."
595 eerror
596 PUSE_ENABLED="1"
597 fi
598
599 if has_concurrentmodphp ; then
600 eerror
601 eerror "You cannot install binary PHP extensions when"
602 eerror "the 'concurrentmodphp' USE flag is enabled!"
603 eerror "Please reemerge dev-lang/php with the"
604 eerror "'concurrentmodphp' USE flag turned off."
605 eerror
606 PUSE_ENABLED="1"
607 fi
608
609 if [[ -n ${PUSE_ENABLED} ]] ; then
610 die "'debug' and/or 'concurrentmodphp' USE flags turned on!"
611 fi
612}
613 208
614# @FUNCTION: dodoc-php 209# @FUNCTION: dodoc-php
615# @USAGE: <list of docs> 210# @USAGE: <list of docs>
616# @DESCRIPTION: 211# @DESCRIPTION:
617# Alternative to dodoc function for use in our PHP eclasses and ebuilds. 212# Alternative to dodoc function for use in our PHP eclasses and ebuilds.

Legend:
Removed from v.1.25  
changed lines
  Added in v.1.37

  ViewVC Help
Powered by ViewVC 1.1.20