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

Contents of /eclass/depend.php.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.29 - (show annotations) (download)
Fri Mar 18 15:59:25 2011 UTC (3 years, 3 months ago) by olemarkus
Branch: MAIN
Changes since 1.28: +5 -5 lines
Changed deps to virtual/php to dev-lang/php

1 # Copyright 1999-2007 Gentoo Foundation
2 # Distributed under the terms of the GNU General Public License v2
3 # $Header: /var/cvsroot/gentoo-x86/eclass/depend.php.eclass,v 1.28 2010/10/12 19:34:49 olemarkus Exp $
4
5 # Author: Stuart Herbert <stuart@gentoo.org>
6 # Author: Luca Longinotti <chtekk@gentoo.org>
7 # 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 # @DESCRIPTION:
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
16 # documentation for PHP packages to php-specific location.
17
18
19 inherit eutils phpconfutils
20
21 # 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.
27 need_php5_cli() {
28 DEPEND="${DEPEND} =dev-lang/php-5*"
29 RDEPEND="${RDEPEND} =dev-lang/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.
37 need_php5_httpd() {
38 DEPEND="${DEPEND} =virtual/httpd-php-5*"
39 RDEPEND="${RDEPEND} =virtual/httpd-php-5*"
40 PHP_VERSION="5"
41 }
42
43 # @FUNCTION: need_php5
44 # @DESCRIPTION:
45 # Set this after setting DEPEND/RDEPEND in your ebuild if the ebuild requires PHP5
46 # (with any SAPI).
47 need_php5() {
48 DEPEND="${DEPEND} =dev-lang/php-5*"
49 RDEPEND="${RDEPEND} =dev-lang/php-5*"
50 PHP_VERSION="5"
51 PHP_SHARED_CAT="php5"
52 }
53
54 # common settings go in here
55 uses_php5() {
56 # cache this
57 libdir=$(get_libdir)
58
59 PHPIZE="/usr/${libdir}/php5/bin/phpize"
60 PHPCONFIG="/usr/${libdir}/php5/bin/php-config"
61 PHPCLI="/usr/${libdir}/php5/bin/php"
62 PHPCGI="/usr/${libdir}/php5/bin/php-cgi"
63 PHP_PKG="$(best_version =dev-lang/php-5*)"
64 PHPPREFIX="/usr/${libdir}/php5"
65 EXT_DIR="$(${PHPCONFIG} --extension-dir 2>/dev/null)"
66
67 einfo
68 einfo "Using ${PHP_PKG}"
69 einfo
70 }
71
72 # general PHP depend functions
73
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.
78 need_php_cli() {
79 DEPEND="${DEPEND} dev-lang/php"
80 RDEPEND="${RDEPEND} dev-lang/php"
81 }
82
83 # @FUNCTION: need_php_httpd
84 # @DESCRIPTION:
85 # Set this after setting DEPEND/RDEPEND in your ebuild if the ebuild requires PHP
86 # (any version) with either cgi or apache2 SAPI.
87 need_php_httpd() {
88 DEPEND="${DEPEND} virtual/httpd-php"
89 RDEPEND="${RDEPEND} virtual/httpd-php"
90 }
91
92 # @FUNCTION: need_php
93 # @DESCRIPTION:
94 # Set this after setting DEPEND/RDEPEND in your ebuild if the ebuild requires PHP
95 # (any version with any SAPI).
96 need_php() {
97 DEPEND="${DEPEND} dev-lang/php"
98 RDEPEND="${RDEPEND} dev-lang/php"
99 PHP_SHARED_CAT="php"
100 }
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.
107 need_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
116 # @FUNCTION: has_php
117 # @DESCRIPTION:
118 # 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
120 # are installed.
121 has_php() {
122 # Detect which PHP version we have installed
123 if has_version '=dev-lang/php-5*' ; then
124 PHP_VERSION="5"
125 else
126 die "Unable to find an installed dev-lang/php package"
127 fi
128
129 # If we get here, then PHP_VERSION tells us which version of PHP we
130 # want to use
131 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.
149 require_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 }
176
177 # @FUNCTION: require_php_with_use
178 # @USAGE: <list of USE flags>
179 # @DESCRIPTION:
180 # Call this function from pkg_setup if your package requires PHP compiled
181 # with specific USE flags. Returns if all of the listed USE flags are enabled.
182 # Dies if any of the listed USE flags are disabled.
183
184 # @VARIABLE: PHPCHECKNODIE
185 # @DESCRIPTION:
186 # You can set PHPCHECKNODIE to non-empty value in your ebuild to chain multiple
187 # require_php_with_(any)_use checks without making the ebuild die on every failure.
188 # This is useful in cases when certain PHP features are only required if specific
189 # USE flag(s) are enabled for that ebuild.
190 # @CODE
191 # Example:
192 #
193 # local flags="pcre session snmp sockets wddx"
194 # use mysql && flags="${flags} mysql"
195 # use postgres && flags="${flags} postgres"
196 # if ! PHPCHECKNODIE="yes" require_php_with_use ${flags} \
197 # || ! PHPCHECKNODIE="yes" require_php_with_any_use gd gd-external ; then
198 # die "Re-install ${PHP_PKG} with ${flags} and either gd or gd-external"
199 # fi
200 # @CODE
201 require_php_with_use() {
202 has_php
203
204 local missing_use=""
205 local x
206
207 einfo "Checking for required PHP feature(s) ..."
208
209 for x in $@ ; do
210 case $x in
211 pcre|spl|reflection|mhash)
212 eqawarn "require_php_with_use MUST NOT check for the pcre, spl, mhash 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
219 if ! built_with_use =${PHP_PKG} ${x} && ! phpconfutils_built_with_use =${PHP_PKG} ${x} ; then
220 einfo " Discovered missing USE flag: ${x}"
221 missing_use="${missing_use} ${x}"
222 fi
223 done
224
225 if [[ -z "${missing_use}" ]] ; then
226 if [[ -z "${PHPCHECKNODIE}" ]] ; then
227 return
228 else
229 return 0
230 fi
231 fi
232
233 if [[ -z "${PHPCHECKNODIE}" ]] ; then
234 eerror
235 eerror "${PHP_PKG} needs to be re-installed with all of the following"
236 eerror "USE flags enabled:"
237 eerror
238 eerror " $@"
239 eerror
240 die "Missing PHP USE flags found"
241 else
242 return 1
243 fi
244 }
245
246 # @FUNCTION: require_php_with_any_use
247 # @USAGE: <list of USE flags>
248 # @DESCRIPTION:
249 # Call this function from pkg_setup if your package requires PHP compiled with
250 # any of specified USE flags. Returns if any of the listed USE flags are enabled.
251 # Dies if all of the listed USE flags are disabled.
252 require_php_with_any_use() {
253 has_php
254
255 local missing_use=""
256 local x
257
258 einfo "Checking for required PHP feature(s) ..."
259
260 for x in $@ ; do
261 if built_with_use =${PHP_PKG} ${x} || phpconfutils_built_with_use =${PHP_PKG} ${x} ; then
262 einfo " USE flag ${x} is enabled, ok ..."
263 return
264 else
265 missing_use="${missing_use} ${x}"
266 fi
267 done
268
269 if [[ -z "${missing_use}" ]] ; then
270 if [[ -z "${PHPCHECKNODIE}" ]] ; then
271 return
272 else
273 return 0
274 fi
275 fi
276
277 if [[ -z "${PHPCHECKNODIE}" ]] ; then
278 eerror
279 eerror "${PHP_PKG} needs to be re-installed with any of the following"
280 eerror "USE flags enabled:"
281 eerror
282 eerror " $@"
283 eerror
284 die "Missing PHP USE flags found"
285 else
286 return 1
287 fi
288 }
289
290 # ========================================================================
291 # has_*() functions
292 #
293 # These functions return 0 if the condition is satisfied, 1 otherwise
294 # ========================================================================
295
296 # @FUNCTION: has_zts
297 # @DESCRIPTION:
298 # Check if our PHP was compiled with ZTS (Zend Thread Safety) enabled.
299 # @RETURN: 0 if true, 1 otherwise
300 has_zts() {
301 has_php
302
303 if built_with_use =${PHP_PKG} apache2 threads || phpconfutils_built_with_use =${PHP_PKG} apache2 threads ; then
304 return 0
305 fi
306
307 return 1
308 }
309
310 # @FUNCTION: has_debug
311 # @DESCRIPTION:
312 # Check if our PHP was built with debug support enabled.
313 # @RETURN: 0 if true, 1 otherwise
314 has_debug() {
315 has_php
316
317 if built_with_use =${PHP_PKG} debug || phpconfutils_built_with_use =${PHP_PKG} debug ; then
318 return 0
319 fi
320
321 return 1
322 }
323
324 # @FUNCTION: has_concurrentmodphp
325 # @DESCRIPTION:
326 # Check if our PHP was built with the concurrentmodphp support enabled.
327 # @RETURN: 0 if true, 1 otherwise
328 has_concurrentmodphp() {
329 has_php
330
331 if built_with_use =${PHP_PKG} apache2 concurrentmodphp || phpconfutils_built_with_use =${PHP_PKG} apache2 concurrentmodphp ; then
332 return 0
333 fi
334
335 return 1
336 }
337
338 # ========================================================================
339 # require_*() functions
340 #
341 # These functions die() if PHP was built without the required features
342 # ========================================================================
343
344 # @FUNCTION: require_pdo
345 # @DESCRIPTION:
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.
350 # @RETURN: die if feature is missing
351 require_pdo() {
352 has_php
353
354 # Was PHP5 compiled with internal PDO support?
355 if built_with_use =${PHP_PKG} pdo || phpconfutils_built_with_use =${PHP_PKG} pdo ; then
356 return
357 else
358 eerror
359 eerror "No PDO extension for PHP found."
360 eerror "Please note that PDO only exists for PHP 5."
361 eerror "Please install a PDO extension for PHP 5."
362 eerror "You must install >=dev-lang/php-5.1 with USE=\"pdo\"."
363 eerror
364 die "No PDO extension for PHP 5 found"
365 fi
366 }
367
368 # @FUNCTION: require_php_cli
369 # @DESCRIPTION:
370 # Determines which installed PHP version has the CLI SAPI enabled.
371 # Useful for PEAR stuff, or anything which needs to run PHP script
372 # depending on the CLI SAPI.
373 # @RETURN: die if feature is missing
374 require_php_cli() {
375 # If PHP_PKG is set, then we have remembered our PHP settings
376 # from last time
377 if [[ -n ${PHP_PKG} ]] ; then
378 return
379 fi
380
381 local PHP_PACKAGE_FOUND=""
382
383 if has_version '=dev-lang/php-5*' ; then
384 PHP_PACKAGE_FOUND="1"
385 pkg="$(best_version '=dev-lang/php-5*')"
386 if built_with_use =${pkg} cli || phpconfutils_built_with_use =${pkg} cli ; then
387 PHP_VERSION="5"
388 fi
389 fi
390
391 if [[ -z ${PHP_PACKAGE_FOUND} ]] ; then
392 die "Unable to find an installed dev-lang/php package"
393 fi
394
395 if [[ -z ${PHP_VERSION} ]] ; then
396 die "No PHP CLI installed. Re-emerge dev-lang/php with USE=cli."
397 fi
398
399 # If we get here, then PHP_VERSION tells us which version of PHP we
400 # want to use
401 uses_php${PHP_VERSION}
402 }
403
404 # @FUNCTION: require_php_cgi
405 # @DESCRIPTION:
406 # Determines which installed PHP version has the CGI SAPI enabled.
407 # Useful for anything which needs to run PHP scripts depending on the CGI SAPI.
408 # @RETURN: die if feature is missing
409 require_php_cgi() {
410 # If PHP_PKG is set, then we have remembered our PHP settings
411 # from last time
412 if [[ -n ${PHP_PKG} ]] ; then
413 return
414 fi
415
416 local PHP_PACKAGE_FOUND=""
417
418 if has_version '=dev-lang/php-5*' ; then
419 PHP_PACKAGE_FOUND="1"
420 pkg="$(best_version '=dev-lang/php-5*')"
421 if built_with_use =${pkg} cgi || phpconfutils_built_with_use =${pkg} cgi ; then
422 PHP_VERSION="5"
423 fi
424 fi
425
426 if [[ -z ${PHP_PACKAGE_FOUND} ]] ; then
427 die "Unable to find an installed dev-lang/php package"
428 fi
429
430 if [[ -z ${PHP_VERSION} ]] ; then
431 die "No PHP CGI installed. Re-emerge dev-lang/php with USE=cgi."
432 fi
433
434 # If we get here, then PHP_VERSION tells us which version of PHP we
435 # want to use
436 uses_php${PHP_VERSION}
437 }
438
439 # @FUNCTION: require_sqlite
440 # @DESCRIPTION:
441 # Require a PHP built with SQLite support
442 # @RETURN: die if feature is missing
443 require_sqlite() {
444 has_php
445
446 # Has our PHP been built with SQLite support?
447 if built_with_use =${PHP_PKG} sqlite || phpconfutils_built_with_use =${PHP_PKG} sqlite ; then
448 return
449 fi
450
451 # If we get here, then we don't have any SQLite support for PHP installed
452 eerror
453 eerror "No SQLite extension for PHP found."
454 eerror "Please install an SQLite extension for PHP,"
455 eerror "this is done best by simply adding the"
456 eerror "'sqlite' USE flag when emerging dev-lang/php."
457 eerror
458 die "No SQLite extension for PHP found"
459 }
460
461 # @FUNCTION: require_gd
462 # @DESCRIPTION:
463 # Require a PHP built with GD support
464 # @RETURN: die if feature is missing
465 require_gd() {
466 has_php
467
468 # Do we have the internal GD support installed?
469 if built_with_use =${PHP_PKG} gd || phpconfutils_built_with_use =${PHP_PKG} gd ; then
470 return
471 fi
472
473 # Ok, maybe GD was built using the external library support?
474 if built_with_use =${PHP_PKG} gd-external || phpconfutils_built_with_use =${PHP_PKG} gd-external ; then
475 return
476 fi
477
478 # If we get here, then we have no GD support
479 eerror
480 eerror "No GD support for PHP found."
481 eerror "Please install the GD support for PHP,"
482 eerror "you must install dev-lang/php with either"
483 eerror "the 'gd' or the 'gd-external' USE flags"
484 eerror "turned on."
485 eerror
486 die "No GD support found for PHP"
487 }
488
489 # ========================================================================
490 # Misc functions
491 #
492 # These functions provide miscellaneous checks and functionality.
493 # ========================================================================
494
495 # @FUNCTION: php_binary_extension
496 # @DESCRIPTION:
497 # Executes some checks needed when installing a binary PHP extension.
498 php_binary_extension() {
499 has_php
500
501 local PUSE_ENABLED=""
502
503 # Binary extensions do not support the change of PHP
504 # API version, so they can't be installed when USE flags
505 # are enabled which change the PHP API version, they also
506 # don't provide correctly versioned symbols for our use
507
508 if has_debug ; then
509 eerror
510 eerror "You cannot install binary PHP extensions"
511 eerror "when the 'debug' USE flag is enabled!"
512 eerror "Please reemerge dev-lang/php with the"
513 eerror "'debug' USE flag turned off."
514 eerror
515 PUSE_ENABLED="1"
516 fi
517
518 if has_concurrentmodphp ; then
519 eerror
520 eerror "You cannot install binary PHP extensions when"
521 eerror "the 'concurrentmodphp' USE flag is enabled!"
522 eerror "Please reemerge dev-lang/php with the"
523 eerror "'concurrentmodphp' USE flag turned off."
524 eerror
525 PUSE_ENABLED="1"
526 fi
527
528 if [[ -n ${PUSE_ENABLED} ]] ; then
529 die "'debug' and/or 'concurrentmodphp' USE flags turned on!"
530 fi
531 }
532
533 # @FUNCTION: dodoc-php
534 # @USAGE: <list of docs>
535 # @DESCRIPTION:
536 # Alternative to dodoc function for use in our PHP eclasses and ebuilds.
537 # Stored here because depend.php gets always sourced everywhere in the PHP
538 # ebuilds and eclasses. It simply is dodoc with a changed path to the docs.
539 # NOTE: No support for docinto is provided!
540 dodoc-php() {
541 if [[ $# -lt 1 ]] ; then
542 echo "$0: at least one argument needed" 1>&2
543 exit 1
544 fi
545
546 phpdocdir="/usr/share/doc/${CATEGORY}/${PF}/"
547
548 for x in $@ ; do
549 if [[ -s "${x}" ]] ; then
550 insinto "${phpdocdir}"
551 doins "${x}"
552 gzip -f -9 "${D}/${phpdocdir}/${x##*/}"
553 elif [[ ! -e "${x}" ]] ; then
554 echo "dodoc-php: ${x} does not exist" 1>&2
555 fi
556 done
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!
566 dohtml-php() {
567 if [[ $# -lt 1 ]] ; then
568 echo "$0: at least one argument needed" 1>&2
569 exit 1
570 fi
571
572 phphtmldir="/usr/share/doc/${CATEGORY}/${PF}/html"
573
574 for 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
581 done
582 }

  ViewVC Help
Powered by ViewVC 1.1.20