/[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.31 Revision 1.37
1# Copyright 1999-2011 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.31 2011/12/14 23:10:51 mabi 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
5# @ECLASS: depend.php.eclass 6# @ECLASS: depend.php.eclass
6# @MAINTAINER: 7# @MAINTAINER:
7# Gentoo PHP team <php-bugs@gentoo.org> 8# Gentoo PHP team <php-bugs@gentoo.org>
8# @AUTHOR: 9# @AUTHOR:
9# Author: Stuart Herbert <stuart@gentoo.org> 10# Author: Stuart Herbert <stuart@gentoo.org>
12# @BLURB: Functions to allow ebuilds to depend on php5 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 php5 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
18inherit eutils phpconfutils 20inherit eutils multilib
19 21
20# PHP5-only depend functions 22# PHP5-only depend functions
21
22# @FUNCTION: need_php5_cli
23# @DESCRIPTION:
24# Set this after setting DEPEND/RDEPEND in your ebuild if the ebuild requires PHP5
25# with cli SAPI.
26need_php5_cli() {
27 DEPEND="${DEPEND} =dev-lang/php-5*"
28 RDEPEND="${RDEPEND} =dev-lang/php-5*"
29 PHP_VERSION="5"
30}
31
32# @FUNCTION: need_php5_httpd
33# @DESCRIPTION:
34# Set this after setting DEPEND/RDEPEND in your ebuild if the ebuild requires PHP5
35# with either cgi or apache2 SAPI.
36need_php5_httpd() {
37 DEPEND="${DEPEND} =virtual/httpd-php-5*"
38 RDEPEND="${RDEPEND} =virtual/httpd-php-5*"
39 PHP_VERSION="5"
40}
41 23
42# @FUNCTION: need_php5 24# @FUNCTION: need_php5
43# @DESCRIPTION: 25# @DESCRIPTION:
44# 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
45# (with any SAPI). 27# (with any SAPI).
68 einfo 50 einfo
69} 51}
70 52
71# general PHP depend functions 53# general PHP depend functions
72 54
73# @FUNCTION: need_php_cli
74# @DESCRIPTION:
75# Set this after setting DEPEND/RDEPEND in your ebuild if the ebuild requires PHP
76# (any version) with cli SAPI.
77need_php_cli() {
78 DEPEND="${DEPEND} dev-lang/php"
79 RDEPEND="${RDEPEND} dev-lang/php"
80}
81
82# @FUNCTION: need_php_httpd 55# @FUNCTION: need_php_httpd
83# @DESCRIPTION: 56# @DESCRIPTION:
84# 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
85# (any version) with either cgi or apache2 SAPI. 58# (any version) with either cgi or apache2 SAPI.
86need_php_httpd() { 59need_php_httpd() {
95need_php() { 68need_php() {
96 DEPEND="${DEPEND} dev-lang/php" 69 DEPEND="${DEPEND} dev-lang/php"
97 RDEPEND="${RDEPEND} dev-lang/php" 70 RDEPEND="${RDEPEND} dev-lang/php"
98 PHP_SHARED_CAT="php" 71 PHP_SHARED_CAT="php"
99} 72}
100
101# @FUNCTION: need_php_by_category
102# @DESCRIPTION:
103# Set this after setting DEPEND/RDEPEND in your ebuild to depend on PHP version
104# determined by ${CATEGORY} - any PHP version or PHP5 for dev-php or
105# dev-php5, respectively.
106need_php_by_category() {
107 case "${CATEGORY}" in
108 dev-php) need_php ;;
109 *) die "Version of PHP required by packages in category ${CATEGORY} unknown"
110 esac
111}
112
113 73
114# @FUNCTION: has_php 74# @FUNCTION: has_php
115# @DESCRIPTION: 75# @DESCRIPTION:
116# 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
117# 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
125 fi 85 fi
126 86
127 # 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
128 # want to use 88 # want to use
129 uses_php${PHP_VERSION} 89 uses_php${PHP_VERSION}
130}
131
132# @FUNCTION: require_php_sapi_from
133# @USAGE: <list of SAPIs>
134# @DESCRIPTION:
135# Call this function from pkg_setup if your package only works with
136# specific SAPI(s) and specify a list of PHP SAPI USE flags that are
137# required (one or more from cli, cgi, apache2) as arguments.
138# Returns if any of the listed SAPIs have been installed, dies if none
139# of them is available.
140#
141# Unfortunately, if you want to be really sure that the required SAPI is
142# provided by PHP, you will have to use this function or similar ones (like
143# require_php_cli or require_php_cgi) in pkg_setup until we are able to
144# depend on USE flags being enabled. The above described need_php[45]_cli
145# and need_php[45]_httpd functions cannot guarantee these requirements.
146# See Bug 2272 for details.
147require_php_sapi_from() {
148 has_php
149
150 local has_sapi="0"
151 local x
152
153 einfo "Checking for compatible SAPI(s)"
154
155 for x in $@ ; do
156 if built_with_use =${PHP_PKG} ${x} || phpconfutils_built_with_use =${PHP_PKG} ${x} ; then
157 einfo " Discovered compatible SAPI ${x}"
158 has_sapi="1"
159 fi
160 done
161
162 if [[ "${has_sapi}" == "1" ]] ; then
163 return
164 fi
165
166 eerror
167 eerror "${PHP_PKG} needs to be re-installed with one of the following"
168 eerror "USE flags enabled:"
169 eerror
170 eerror " $@"
171 eerror
172 die "No compatible PHP SAPIs found"
173} 90}
174 91
175# @FUNCTION: require_php_with_use 92# @FUNCTION: require_php_with_use
176# @USAGE: <list of USE flags> 93# @USAGE: <list of USE flags>
177# @DESCRIPTION: 94# @DESCRIPTION:
212 eqawarn "if you check the USE flags against PHP 5.3 ebuilds." 129 eqawarn "if you check the USE flags against PHP 5.3 ebuilds."
213 eqawarn "Please use USE dependencies from EAPI 2 instead" 130 eqawarn "Please use USE dependencies from EAPI 2 instead"
214 ;; 131 ;;
215 esac 132 esac
216 133
217 if ! built_with_use =${PHP_PKG} ${x} && ! phpconfutils_built_with_use =${PHP_PKG} ${x} ; then 134 if ! built_with_use =${PHP_PKG} ${x} ; then
218 einfo " Discovered missing USE flag: ${x}" 135 einfo " Discovered missing USE flag: ${x}"
219 missing_use="${missing_use} ${x}" 136 missing_use="${missing_use} ${x}"
220 fi 137 fi
221 done 138 done
222 139
239 else 156 else
240 return 1 157 return 1
241 fi 158 fi
242} 159}
243 160
244# @FUNCTION: require_php_with_any_use
245# @USAGE: <list of USE flags>
246# @DESCRIPTION:
247# Call this function from pkg_setup if your package requires PHP compiled with
248# any of specified USE flags. Returns if any of the listed USE flags are enabled.
249# Dies if all of the listed USE flags are disabled.
250require_php_with_any_use() {
251 has_php
252
253 local missing_use=""
254 local x
255
256 einfo "Checking for required PHP feature(s) ..."
257
258 for x in $@ ; do
259 if built_with_use =${PHP_PKG} ${x} || phpconfutils_built_with_use =${PHP_PKG} ${x} ; then
260 einfo " USE flag ${x} is enabled, ok ..."
261 return
262 else
263 missing_use="${missing_use} ${x}"
264 fi
265 done
266
267 if [[ -z "${missing_use}" ]] ; then
268 if [[ -z "${PHPCHECKNODIE}" ]] ; then
269 return
270 else
271 return 0
272 fi
273 fi
274
275 if [[ -z "${PHPCHECKNODIE}" ]] ; then
276 eerror
277 eerror "${PHP_PKG} needs to be re-installed with any of the following"
278 eerror "USE flags enabled:"
279 eerror
280 eerror " $@"
281 eerror
282 die "Missing PHP USE flags found"
283 else
284 return 1
285 fi
286}
287
288# ========================================================================
289# has_*() functions
290#
291# These functions return 0 if the condition is satisfied, 1 otherwise
292# ========================================================================
293
294# @FUNCTION: has_zts
295# @DESCRIPTION:
296# Check if our PHP was compiled with ZTS (Zend Thread Safety) enabled.
297# @RETURN: 0 if true, 1 otherwise
298has_zts() {
299 has_php
300
301 if built_with_use =${PHP_PKG} apache2 threads || phpconfutils_built_with_use =${PHP_PKG} apache2 threads ; then
302 return 0
303 fi
304
305 return 1
306}
307
308# @FUNCTION: has_debug
309# @DESCRIPTION:
310# Check if our PHP was built with debug support enabled.
311# @RETURN: 0 if true, 1 otherwise
312has_debug() {
313 has_php
314
315 if built_with_use =${PHP_PKG} debug || phpconfutils_built_with_use =${PHP_PKG} debug ; then
316 return 0
317 fi
318
319 return 1
320}
321
322# @FUNCTION: has_concurrentmodphp
323# @DESCRIPTION:
324# Check if our PHP was built with the concurrentmodphp support enabled.
325# @RETURN: 0 if true, 1 otherwise
326has_concurrentmodphp() {
327 has_php
328
329 if built_with_use =${PHP_PKG} apache2 concurrentmodphp || phpconfutils_built_with_use =${PHP_PKG} apache2 concurrentmodphp ; then
330 return 0
331 fi
332
333 return 1
334}
335 161
336# ======================================================================== 162# ========================================================================
337# require_*() functions 163# require_*() functions
338# 164#
339# These functions die() if PHP was built without the required features 165# These functions die() if PHP was built without the required features
340# ======================================================================== 166# ========================================================================
341
342# @FUNCTION: require_pdo
343# @DESCRIPTION:
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.
348# @RETURN: die if feature is missing
349require_pdo() {
350 has_php
351
352 # Was PHP5 compiled with internal PDO support?
353 if built_with_use =${PHP_PKG} pdo || phpconfutils_built_with_use =${PHP_PKG} pdo ; then
354 return
355 else
356 eerror
357 eerror "No PDO extension for PHP found."
358 eerror "Please note that PDO only exists for PHP 5."
359 eerror "Please install a PDO extension for PHP 5."
360 eerror "You must install >=dev-lang/php-5.1 with USE=\"pdo\"."
361 eerror
362 die "No PDO extension for PHP 5 found"
363 fi
364}
365
366# @FUNCTION: require_php_cli
367# @DESCRIPTION:
368# Determines which installed PHP version has the CLI SAPI enabled.
369# Useful for PEAR stuff, or anything which needs to run PHP script
370# depending on the CLI SAPI.
371# @RETURN: die if feature is missing
372require_php_cli() {
373 # If PHP_PKG is set, then we have remembered our PHP settings
374 # from last time
375 if [[ -n ${PHP_PKG} ]] ; then
376 return
377 fi
378
379 local PHP_PACKAGE_FOUND=""
380
381 if has_version '=dev-lang/php-5*' ; then
382 PHP_PACKAGE_FOUND="1"
383 pkg="$(best_version '=dev-lang/php-5*')"
384 if built_with_use =${pkg} cli || phpconfutils_built_with_use =${pkg} cli ; then
385 PHP_VERSION="5"
386 fi
387 fi
388
389 if [[ -z ${PHP_PACKAGE_FOUND} ]] ; then
390 die "Unable to find an installed dev-lang/php package"
391 fi
392
393 if [[ -z ${PHP_VERSION} ]] ; then
394 die "No PHP CLI installed. Re-emerge dev-lang/php with USE=cli."
395 fi
396
397 # If we get here, then PHP_VERSION tells us which version of PHP we
398 # want to use
399 uses_php${PHP_VERSION}
400}
401 167
402# @FUNCTION: require_php_cgi 168# @FUNCTION: require_php_cgi
403# @DESCRIPTION: 169# @DESCRIPTION:
404# Determines which installed PHP version has the CGI SAPI enabled. 170# Determines which installed PHP version has the CGI SAPI enabled.
405# 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.
414 local PHP_PACKAGE_FOUND="" 180 local PHP_PACKAGE_FOUND=""
415 181
416 if has_version '=dev-lang/php-5*' ; then 182 if has_version '=dev-lang/php-5*' ; then
417 PHP_PACKAGE_FOUND="1" 183 PHP_PACKAGE_FOUND="1"
418 pkg="$(best_version '=dev-lang/php-5*')" 184 pkg="$(best_version '=dev-lang/php-5*')"
419 if built_with_use =${pkg} cgi || phpconfutils_built_with_use =${pkg} cgi ; then 185 if built_with_use =${pkg} cgi ; then
420 PHP_VERSION="5" 186 PHP_VERSION="5"
421 fi 187 fi
422 fi 188 fi
423 189
424 if [[ -z ${PHP_PACKAGE_FOUND} ]] ; then 190 if [[ -z ${PHP_PACKAGE_FOUND} ]] ; then
432 # 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
433 # want to use 199 # want to use
434 uses_php${PHP_VERSION} 200 uses_php${PHP_VERSION}
435} 201}
436 202
437# @FUNCTION: require_sqlite
438# @DESCRIPTION:
439# Require a PHP built with SQLite support
440# @RETURN: die if feature is missing
441require_sqlite() {
442 has_php
443
444 # Has our PHP been built with SQLite support?
445 if built_with_use =${PHP_PKG} sqlite || phpconfutils_built_with_use =${PHP_PKG} sqlite ; then
446 return
447 fi
448
449 # If we get here, then we don't have any SQLite support for PHP installed
450 eerror
451 eerror "No SQLite extension for PHP found."
452 eerror "Please install an SQLite extension for PHP,"
453 eerror "this is done best by simply adding the"
454 eerror "'sqlite' USE flag when emerging dev-lang/php."
455 eerror
456 die "No SQLite extension for PHP found"
457}
458
459# @FUNCTION: require_gd
460# @DESCRIPTION:
461# Require a PHP built with GD support
462# @RETURN: die if feature is missing
463require_gd() {
464 has_php
465
466 # Do we have the internal GD support installed?
467 if built_with_use =${PHP_PKG} gd || phpconfutils_built_with_use =${PHP_PKG} gd ; then
468 return
469 fi
470
471 # Ok, maybe GD was built using the external library support?
472 if built_with_use =${PHP_PKG} gd-external || phpconfutils_built_with_use =${PHP_PKG} gd-external ; then
473 return
474 fi
475
476 # If we get here, then we have no GD support
477 eerror
478 eerror "No GD support for PHP found."
479 eerror "Please install the GD support for PHP,"
480 eerror "you must install dev-lang/php with either"
481 eerror "the 'gd' or the 'gd-external' USE flags"
482 eerror "turned on."
483 eerror
484 die "No GD support found for PHP"
485}
486
487# ======================================================================== 203# ========================================================================
488# Misc functions 204# Misc functions
489# 205#
490# These functions provide miscellaneous checks and functionality. 206# These functions provide miscellaneous checks and functionality.
491# ======================================================================== 207# ========================================================================
492
493# @FUNCTION: php_binary_extension
494# @DESCRIPTION:
495# Executes some checks needed when installing a binary PHP extension.
496php_binary_extension() {
497 has_php
498
499 local PUSE_ENABLED=""
500
501 # Binary extensions do not support the change of PHP
502 # API version, so they can't be installed when USE flags
503 # are enabled which change the PHP API version, they also
504 # don't provide correctly versioned symbols for our use
505
506 if has_debug ; then
507 eerror
508 eerror "You cannot install binary PHP extensions"
509 eerror "when the 'debug' USE flag is enabled!"
510 eerror "Please reemerge dev-lang/php with the"
511 eerror "'debug' USE flag turned off."
512 eerror
513 PUSE_ENABLED="1"
514 fi
515
516 if has_concurrentmodphp ; then
517 eerror
518 eerror "You cannot install binary PHP extensions when"
519 eerror "the 'concurrentmodphp' USE flag is enabled!"
520 eerror "Please reemerge dev-lang/php with the"
521 eerror "'concurrentmodphp' USE flag turned off."
522 eerror
523 PUSE_ENABLED="1"
524 fi
525
526 if [[ -n ${PUSE_ENABLED} ]] ; then
527 die "'debug' and/or 'concurrentmodphp' USE flags turned on!"
528 fi
529}
530 208
531# @FUNCTION: dodoc-php 209# @FUNCTION: dodoc-php
532# @USAGE: <list of docs> 210# @USAGE: <list of docs>
533# @DESCRIPTION: 211# @DESCRIPTION:
534# 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.31  
changed lines
  Added in v.1.37

  ViewVC Help
Powered by ViewVC 1.1.20