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

  ViewVC Help
Powered by ViewVC 1.1.20