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

Contents of /eclass/depend.php.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.22 - (show annotations) (download)
Mon Dec 24 12:29:36 2007 UTC (6 years, 3 months ago) by armin76
Branch: MAIN
Changes since 1.21: +22 -33 lines
Changes from the php-overlay

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.21 2007/09/01 15:58:17 jokey 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 php[45] and check for specific features.
13 # @DESCRIPTION:
14 # This eclass provides functions that allow ebuilds to depend on php[45] 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 # 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.
27 need_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.
37 need_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).
47 need_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
55 uses_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
72 # 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.
78 need_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.
88 need_php5_httpd() {
89 DEPEND="${DEPEND} =virtual/httpd-php-5*"
90 RDEPEND="${RDEPEND} =virtual/httpd-php-5*"
91 PHP_VERSION="5"
92 }
93
94 # @FUNCTION: need_php5
95 # @DESCRIPTION:
96 # Set this after setting DEPEND/RDEPEND in your ebuild if the ebuild requires PHP5
97 # (with any SAPI).
98 need_php5() {
99 DEPEND="${DEPEND} =dev-lang/php-5*"
100 RDEPEND="${RDEPEND} =dev-lang/php-5*"
101 PHP_VERSION="5"
102 PHP_SHARED_CAT="php5"
103 }
104
105 # common settings go in here
106 uses_php5() {
107 # cache this
108 libdir=$(get_libdir)
109
110 PHPIZE="/usr/${libdir}/php5/bin/phpize"
111 PHPCONFIG="/usr/${libdir}/php5/bin/php-config"
112 PHPCLI="/usr/${libdir}/php5/bin/php"
113 PHPCGI="/usr/${libdir}/php5/bin/php-cgi"
114 PHP_PKG="$(best_version =dev-lang/php-5*)"
115 PHPPREFIX="/usr/${libdir}/php5"
116 EXT_DIR="$(${PHPCONFIG} --extension-dir 2>/dev/null)"
117
118 einfo
119 einfo "Using ${PHP_PKG}"
120 einfo
121 }
122
123 # general PHP depend functions
124
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.
129 need_php_cli() {
130 DEPEND="${DEPEND} virtual/php"
131 RDEPEND="${RDEPEND} virtual/php"
132 }
133
134 # @FUNCTION: need_php_httpd
135 # @DESCRIPTION:
136 # Set this after setting DEPEND/RDEPEND in your ebuild if the ebuild requires PHP
137 # (any version) with either cgi or apache2 SAPI.
138 need_php_httpd() {
139 DEPEND="${DEPEND} virtual/httpd-php"
140 RDEPEND="${RDEPEND} virtual/httpd-php"
141 }
142
143 # @FUNCTION: need_php
144 # @DESCRIPTION:
145 # Set this after setting DEPEND/RDEPEND in your ebuild if the ebuild requires PHP
146 # (any version with any SAPI).
147 need_php() {
148 DEPEND="${DEPEND} dev-lang/php"
149 RDEPEND="${RDEPEND} dev-lang/php"
150 PHP_SHARED_CAT="php"
151 }
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.
158 need_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
168 # @FUNCTION: has_php
169 # @DESCRIPTION:
170 # 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
172 # are installed.
173 has_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
182 if has_version '=dev-lang/php-5*' ; then
183 PHP_VERSION="5"
184 elif has_version '=dev-lang/php-4*' ; then
185 PHP_VERSION="4"
186 else
187 die "Unable to find an installed dev-lang/php package"
188 fi
189 fi
190
191 # If we get here, then PHP_VERSION tells us which version of PHP we
192 # want to use
193 uses_php${PHP_VERSION}
194 }
195
196 # @FUNCTION: require_php_sapi_from
197 # @USAGE: <list of SAPIs>
198 # @DESCRIPTION:
199 # Call this function from pkg_setup if your package only works with
200 # specific SAPI(s) and specify a list of PHP SAPI USE flags that are
201 # required (one or more from cli, cgi, apache2) as arguments.
202 # Returns if any of the listed SAPIs have been installed, dies if none
203 # of them is available.
204 #
205 # 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
207 # 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
209 # and need_php[45]_httpd functions cannot guarantee these requirements.
210 # See Bug 2272 for details.
211 require_php_sapi_from() {
212 has_php
213
214 local has_sapi="0"
215 local x
216
217 einfo "Checking for compatible SAPI(s)"
218
219 for x in $@ ; do
220 if built_with_use =${PHP_PKG} ${x} || phpconfutils_built_with_use =${PHP_PKG} ${x} ; then
221 einfo " Discovered compatible SAPI ${x}"
222 has_sapi="1"
223 fi
224 done
225
226 if [[ "${has_sapi}" == "1" ]] ; then
227 return
228 fi
229
230 eerror
231 eerror "${PHP_PKG} needs to be re-installed with one of the following"
232 eerror "USE flags enabled:"
233 eerror
234 eerror " $@"
235 eerror
236 die "No compatible PHP SAPIs found"
237 }
238
239 # @FUNCTION: require_php_with_use
240 # @USAGE: <list of USE flags>
241 # @DESCRIPTION:
242 # Call this function from pkg_setup if your package requires PHP compiled
243 # with specific USE flags. Returns if all of the listed USE flags are enabled.
244 # Dies if any of the listed USE flags are disabled.
245
246 # @VARIABLE: PHPCHECKNODIE
247 # @DESCRIPTION:
248 # 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.
250 # This is useful in cases when certain PHP features are only required if specific
251 # USE flag(s) are enabled for that ebuild.
252 # @CODE
253 # Example:
254 #
255 # local flags="pcre session snmp sockets wddx"
256 # use mysql && flags="${flags} mysql"
257 # use postgres && flags="${flags} postgres"
258 # if ! PHPCHECKNODIE="yes" require_php_with_use ${flags} \
259 # || ! PHPCHECKNODIE="yes" require_php_with_any_use gd gd-external ; then
260 # die "Re-install ${PHP_PKG} with ${flags} and either gd or gd-external"
261 # fi
262 # @CODE
263 require_php_with_use() {
264 has_php
265
266 local missing_use=""
267 local x
268
269 einfo "Checking for required PHP feature(s) ..."
270
271 for x in $@ ; do
272 if ! built_with_use =${PHP_PKG} ${x} && ! phpconfutils_built_with_use =${PHP_PKG} ${x} ; then
273 einfo " Discovered missing USE flag: ${x}"
274 missing_use="${missing_use} ${x}"
275 fi
276 done
277
278 if [[ -z "${missing_use}" ]] ; then
279 if [[ -z "${PHPCHECKNODIE}" ]] ; then
280 return
281 else
282 return 0
283 fi
284 fi
285
286 if [[ -z "${PHPCHECKNODIE}" ]] ; then
287 eerror
288 eerror "${PHP_PKG} needs to be re-installed with all of the following"
289 eerror "USE flags enabled:"
290 eerror
291 eerror " $@"
292 eerror
293 die "Missing PHP USE flags found"
294 else
295 return 1
296 fi
297 }
298
299 # @FUNCTION: require_php_with_any_use
300 # @USAGE: <list of USE flags>
301 # @DESCRIPTION:
302 # Call this function from pkg_setup if your package requires PHP compiled with
303 # any of specified USE flags. Returns if any of the listed USE flags are enabled.
304 # Dies if all of the listed USE flags are disabled.
305 require_php_with_any_use() {
306 has_php
307
308 local missing_use=""
309 local x
310
311 einfo "Checking for required PHP feature(s) ..."
312
313 for x in $@ ; do
314 if built_with_use =${PHP_PKG} ${x} || phpconfutils_built_with_use =${PHP_PKG} ${x} ; then
315 einfo " USE flag ${x} is enabled, ok ..."
316 return
317 else
318 missing_use="${missing_use} ${x}"
319 fi
320 done
321
322 if [[ -z "${missing_use}" ]] ; then
323 if [[ -z "${PHPCHECKNODIE}" ]] ; then
324 return
325 else
326 return 0
327 fi
328 fi
329
330 if [[ -z "${PHPCHECKNODIE}" ]] ; then
331 eerror
332 eerror "${PHP_PKG} needs to be re-installed with any of the following"
333 eerror "USE flags enabled:"
334 eerror
335 eerror " $@"
336 eerror
337 die "Missing PHP USE flags found"
338 else
339 return 1
340 fi
341 }
342
343 # ========================================================================
344 # has_*() functions
345 #
346 # These functions return 0 if the condition is satisfied, 1 otherwise
347 # ========================================================================
348
349 # @FUNCTION: has_zts
350 # @DESCRIPTION:
351 # Check if our PHP was compiled with ZTS (Zend Thread Safety) enabled.
352 # @RETURN: 0 if true, 1 otherwise
353 has_zts() {
354 has_php
355
356 if built_with_use =${PHP_PKG} apache2 threads || phpconfutils_built_with_use =${PHP_PKG} apache2 threads ; then
357 return 0
358 fi
359
360 return 1
361 }
362
363 # @FUNCTION: has_debug
364 # @DESCRIPTION:
365 # Check if our PHP was built with debug support enabled.
366 # @RETURN: 0 if true, 1 otherwise
367 has_debug() {
368 has_php
369
370 if built_with_use =${PHP_PKG} debug || phpconfutils_built_with_use =${PHP_PKG} debug ; then
371 return 0
372 fi
373
374 return 1
375 }
376
377 # @FUNCTION: has_concurrentmodphp
378 # @DESCRIPTION:
379 # Check if our PHP was built with the concurrentmodphp support enabled.
380 # @RETURN: 0 if true, 1 otherwise
381 has_concurrentmodphp() {
382 has_php
383
384 if built_with_use =${PHP_PKG} apache2 concurrentmodphp || phpconfutils_built_with_use =${PHP_PKG} apache2 concurrentmodphp ; then
385 return 0
386 fi
387
388 return 1
389 }
390
391 # ========================================================================
392 # require_*() functions
393 #
394 # These functions die() if PHP was built without the required features
395 # ========================================================================
396
397 # @FUNCTION: require_pdo
398 # @DESCRIPTION:
399 # Require a PHP built with PDO support (PHP5 only).
400 # This function is now redundant and DEPRECATED since
401 # pdo-external use flag and pecl-pdo-* ebuilds were removed.
402 # You should use require_php_with_use pdo instead now.
403 # @RETURN: die if feature is missing
404 require_pdo() {
405 has_php
406
407 # Do we have PHP5 installed?
408 if [[ "${PHP_VERSION}" == "4" ]] ; then
409 eerror
410 eerror "This package requires PDO."
411 eerror "PDO is only available for PHP 5."
412 eerror "You must install >=dev-lang/php-5.1 with USE=\"pdo\"."
413 eerror "pdo USE flags turned on."
414 eerror
415 die "PHP 5 not installed"
416 fi
417
418 # Was PHP5 compiled with internal PDO support?
419 if built_with_use =${PHP_PKG} pdo || phpconfutils_built_with_use =${PHP_PKG} pdo ; then
420 return
421 else
422 eerror
423 eerror "No PDO extension for PHP found."
424 eerror "Please note that PDO only exists for PHP 5."
425 eerror "Please install a PDO extension for PHP 5."
426 eerror "You must install >=dev-lang/php-5.1 with USE=\"pdo\"."
427 eerror
428 die "No PDO extension for PHP 5 found"
429 fi
430 }
431
432 # @FUNCTION: require_php_cli
433 # @DESCRIPTION:
434 # Determines which installed PHP version has the CLI SAPI enabled.
435 # Useful for PEAR stuff, or anything which needs to run PHP script
436 # depending on the CLI SAPI.
437 # @RETURN: die if feature is missing
438 require_php_cli() {
439 # If PHP_PKG is set, then we have remembered our PHP settings
440 # from last time
441 if [[ -n ${PHP_PKG} ]] ; then
442 return
443 fi
444
445 local PHP_PACKAGE_FOUND=""
446
447 # Detect which PHP version we have installed
448 if has_version '=dev-lang/php-4*' ; then
449 PHP_PACKAGE_FOUND="1"
450 pkg="$(best_version '=dev-lang/php-4*')"
451 if built_with_use =${pkg} cli || phpconfutils_built_with_use =${pkg} cli ; then
452 PHP_VERSION="4"
453 fi
454 fi
455
456 if has_version '=dev-lang/php-5*' ; then
457 PHP_PACKAGE_FOUND="1"
458 pkg="$(best_version '=dev-lang/php-5*')"
459 if built_with_use =${pkg} cli || phpconfutils_built_with_use =${pkg} cli ; then
460 PHP_VERSION="5"
461 fi
462 fi
463
464 if [[ -z ${PHP_PACKAGE_FOUND} ]] ; then
465 die "Unable to find an installed dev-lang/php package"
466 fi
467
468 if [[ -z ${PHP_VERSION} ]] ; then
469 die "No PHP CLI installed. Re-emerge dev-lang/php with USE=cli."
470 fi
471
472 # If we get here, then PHP_VERSION tells us which version of PHP we
473 # want to use
474 uses_php${PHP_VERSION}
475 }
476
477 # @FUNCTION: require_php_cgi
478 # @DESCRIPTION:
479 # Determines which installed PHP version has the CGI SAPI enabled.
480 # Useful for anything which needs to run PHP scripts depending on the CGI SAPI.
481 # @RETURN: die if feature is missing
482 require_php_cgi() {
483 # If PHP_PKG is set, then we have remembered our PHP settings
484 # from last time
485 if [[ -n ${PHP_PKG} ]] ; then
486 return
487 fi
488
489 local PHP_PACKAGE_FOUND=""
490
491 # Detect which PHP version we have installed
492 if has_version '=dev-lang/php-4*' ; then
493 PHP_PACKAGE_FOUND="1"
494 pkg="$(best_version '=dev-lang/php-4*')"
495 if built_with_use =${pkg} cgi || phpconfutils_built_with_use =${pkg} cgi ; then
496 PHP_VERSION="4"
497 fi
498 fi
499
500 if has_version '=dev-lang/php-5*' ; then
501 PHP_PACKAGE_FOUND="1"
502 pkg="$(best_version '=dev-lang/php-5*')"
503 if built_with_use =${pkg} cgi || phpconfutils_built_with_use =${pkg} cgi ; then
504 PHP_VERSION="5"
505 fi
506 fi
507
508 if [[ -z ${PHP_PACKAGE_FOUND} ]] ; then
509 die "Unable to find an installed dev-lang/php package"
510 fi
511
512 if [[ -z ${PHP_VERSION} ]] ; then
513 die "No PHP CGI installed. Re-emerge dev-lang/php with USE=cgi."
514 fi
515
516 # If we get here, then PHP_VERSION tells us which version of PHP we
517 # want to use
518 uses_php${PHP_VERSION}
519 }
520
521 # @FUNCTION: require_sqlite
522 # @DESCRIPTION:
523 # Require a PHP built with SQLite support
524 # @RETURN: die if feature is missing
525 require_sqlite() {
526 has_php
527
528 # Has our PHP been built with SQLite support?
529 if built_with_use =${PHP_PKG} sqlite || phpconfutils_built_with_use =${PHP_PKG} sqlite ; then
530 return
531 fi
532
533 # Do we have pecl-sqlite installed for PHP4?
534 if [[ "${PHP_VERSION}" == "4" ]] ; then
535 if has_version 'dev-php4/pecl-sqlite' ; then
536 return
537 fi
538 fi
539
540 # If we get here, then we don't have any SQLite support for PHP installed
541 eerror
542 eerror "No SQLite extension for PHP found."
543 eerror "Please install an SQLite extension for PHP,"
544 eerror "this is done best by simply adding the"
545 eerror "'sqlite' USE flag when emerging dev-lang/php."
546 eerror
547 die "No SQLite extension for PHP found"
548 }
549
550 # @FUNCTION: require_gd
551 # @DESCRIPTION:
552 # Require a PHP built with GD support
553 # @RETURN: die if feature is missing
554 require_gd() {
555 has_php
556
557 # Do we have the internal GD support installed?
558 if built_with_use =${PHP_PKG} gd || phpconfutils_built_with_use =${PHP_PKG} gd ; then
559 return
560 fi
561
562 # Ok, maybe GD was built using the external library support?
563 if built_with_use =${PHP_PKG} gd-external || phpconfutils_built_with_use =${PHP_PKG} gd-external ; then
564 return
565 fi
566
567 # If we get here, then we have no GD support
568 eerror
569 eerror "No GD support for PHP found."
570 eerror "Please install the GD support for PHP,"
571 eerror "you must install dev-lang/php with either"
572 eerror "the 'gd' or the 'gd-external' USE flags"
573 eerror "turned on."
574 eerror
575 die "No GD support found for PHP"
576 }
577
578 # ========================================================================
579 # Misc functions
580 #
581 # These functions provide miscellaneous checks and functionality.
582 # ========================================================================
583
584 # @FUNCTION: php_binary_extension
585 # @DESCRIPTION:
586 # Executes some checks needed when installing a binary PHP extension.
587 php_binary_extension() {
588 has_php
589
590 local PUSE_ENABLED=""
591
592 # Binary extensions do not support the change of PHP
593 # API version, so they can't be installed when USE flags
594 # are enabled which change the PHP API version, they also
595 # don't provide correctly versioned symbols for our use
596
597 if has_debug ; then
598 eerror
599 eerror "You cannot install binary PHP extensions"
600 eerror "when the 'debug' USE flag is enabled!"
601 eerror "Please reemerge dev-lang/php with the"
602 eerror "'debug' USE flag turned off."
603 eerror
604 PUSE_ENABLED="1"
605 fi
606
607 if has_concurrentmodphp ; then
608 eerror
609 eerror "You cannot install binary PHP extensions when"
610 eerror "the 'concurrentmodphp' USE flag is enabled!"
611 eerror "Please reemerge dev-lang/php with the"
612 eerror "'concurrentmodphp' USE flag turned off."
613 eerror
614 PUSE_ENABLED="1"
615 fi
616
617 if [[ -n ${PUSE_ENABLED} ]] ; then
618 die "'debug' and/or 'concurrentmodphp' USE flags turned on!"
619 fi
620 }
621
622 # @FUNCTION: dodoc-php
623 # @USAGE: <list of docs>
624 # @DESCRIPTION:
625 # Alternative to dodoc function for use in our PHP eclasses and ebuilds.
626 # Stored here because depend.php gets always sourced everywhere in the PHP
627 # ebuilds and eclasses. It simply is dodoc with a changed path to the docs.
628 # NOTE: No support for docinto is provided!
629 dodoc-php() {
630 if [[ $# -lt 1 ]] ; then
631 echo "$0: at least one argument needed" 1>&2
632 exit 1
633 fi
634
635 phpdocdir="${D}/usr/share/doc/${CATEGORY}/${PF}/"
636
637 if [[ ! -d "${phpdocdir}" ]] ; then
638 install -d "${phpdocdir}"
639 fi
640
641 for x in $@ ; do
642 if [[ -s "${x}" ]] ; then
643 install -m0644 "${x}" "${phpdocdir}"
644 gzip -f -9 "${phpdocdir}/${x##*/}"
645 elif [[ ! -e "${x}" ]] ; then
646 echo "dodoc-php: ${x} does not exist" 1>&2
647 fi
648 done
649 }

  ViewVC Help
Powered by ViewVC 1.1.20