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

Contents of /eclass/depend.php.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.31 - (show annotations) (download)
Wed Dec 14 23:10:51 2011 UTC (2 years, 10 months ago) by mabi
Branch: MAIN
Changes since 1.30: +1 -2 lines
Merge category dev-php5 into dev-php (bug #324665)

1 # Copyright 1999-2011 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.30 2011/08/22 04:46:31 vapier Exp $
4
5 # @ECLASS: depend.php.eclass
6 # @MAINTAINER:
7 # Gentoo PHP team <php-bugs@gentoo.org>
8 # @AUTHOR:
9 # Author: Stuart Herbert <stuart@gentoo.org>
10 # Author: Luca Longinotti <chtekk@gentoo.org>
11 # Author: Jakub Moc <jakub@gentoo.org> (documentation)
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 inherit eutils phpconfutils
19
20 # 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.
26 need_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.
36 need_php5_httpd() {
37 DEPEND="${DEPEND} =virtual/httpd-php-5*"
38 RDEPEND="${RDEPEND} =virtual/httpd-php-5*"
39 PHP_VERSION="5"
40 }
41
42 # @FUNCTION: need_php5
43 # @DESCRIPTION:
44 # Set this after setting DEPEND/RDEPEND in your ebuild if the ebuild requires PHP5
45 # (with any SAPI).
46 need_php5() {
47 DEPEND="${DEPEND} =dev-lang/php-5*"
48 RDEPEND="${RDEPEND} =dev-lang/php-5*"
49 PHP_VERSION="5"
50 PHP_SHARED_CAT="php5"
51 }
52
53 # common settings go in here
54 uses_php5() {
55 # cache this
56 libdir=$(get_libdir)
57
58 PHPIZE="/usr/${libdir}/php5/bin/phpize"
59 PHPCONFIG="/usr/${libdir}/php5/bin/php-config"
60 PHPCLI="/usr/${libdir}/php5/bin/php"
61 PHPCGI="/usr/${libdir}/php5/bin/php-cgi"
62 PHP_PKG="$(best_version =dev-lang/php-5*)"
63 PHPPREFIX="/usr/${libdir}/php5"
64 EXT_DIR="$(${PHPCONFIG} --extension-dir 2>/dev/null)"
65
66 einfo
67 einfo "Using ${PHP_PKG}"
68 einfo
69 }
70
71 # general PHP depend functions
72
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.
77 need_php_cli() {
78 DEPEND="${DEPEND} dev-lang/php"
79 RDEPEND="${RDEPEND} dev-lang/php"
80 }
81
82 # @FUNCTION: need_php_httpd
83 # @DESCRIPTION:
84 # Set this after setting DEPEND/RDEPEND in your ebuild if the ebuild requires PHP
85 # (any version) with either cgi or apache2 SAPI.
86 need_php_httpd() {
87 DEPEND="${DEPEND} virtual/httpd-php"
88 RDEPEND="${RDEPEND} virtual/httpd-php"
89 }
90
91 # @FUNCTION: need_php
92 # @DESCRIPTION:
93 # Set this after setting DEPEND/RDEPEND in your ebuild if the ebuild requires PHP
94 # (any version with any SAPI).
95 need_php() {
96 DEPEND="${DEPEND} dev-lang/php"
97 RDEPEND="${RDEPEND} dev-lang/php"
98 PHP_SHARED_CAT="php"
99 }
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.
106 need_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
114 # @FUNCTION: has_php
115 # @DESCRIPTION:
116 # 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
118 # are installed.
119 has_php() {
120 # Detect which PHP version we have installed
121 if has_version '=dev-lang/php-5*' ; then
122 PHP_VERSION="5"
123 else
124 die "Unable to find an installed dev-lang/php package"
125 fi
126
127 # If we get here, then PHP_VERSION tells us which version of PHP we
128 # want to use
129 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.
147 require_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 }
174
175 # @FUNCTION: require_php_with_use
176 # @USAGE: <list of USE flags>
177 # @DESCRIPTION:
178 # Call this function from pkg_setup if your package requires PHP compiled
179 # with specific USE flags. Returns if all of the listed USE flags are enabled.
180 # Dies if any of the listed USE flags are disabled.
181
182 # @VARIABLE: PHPCHECKNODIE
183 # @DESCRIPTION:
184 # You can set PHPCHECKNODIE to non-empty value in your ebuild to chain multiple
185 # require_php_with_(any)_use checks without making the ebuild die on every failure.
186 # This is useful in cases when certain PHP features are only required if specific
187 # USE flag(s) are enabled for that ebuild.
188 # @CODE
189 # Example:
190 #
191 # local flags="pcre session snmp sockets wddx"
192 # use mysql && flags="${flags} mysql"
193 # use postgres && flags="${flags} postgres"
194 # if ! PHPCHECKNODIE="yes" require_php_with_use ${flags} \
195 # || ! PHPCHECKNODIE="yes" require_php_with_any_use gd gd-external ; then
196 # die "Re-install ${PHP_PKG} with ${flags} and either gd or gd-external"
197 # fi
198 # @CODE
199 require_php_with_use() {
200 has_php
201
202 local missing_use=""
203 local x
204
205 einfo "Checking for required PHP feature(s) ..."
206
207 for x in $@ ; do
208 case $x in
209 pcre|spl|reflection|mhash)
210 eqawarn "require_php_with_use MUST NOT check for the pcre, spl, mhash or reflection USE flag."
211 eqawarn "These USE flags are removed from >=dev-lang/php-5.3 and your ebuild will break"
212 eqawarn "if you check the USE flags against PHP 5.3 ebuilds."
213 eqawarn "Please use USE dependencies from EAPI 2 instead"
214 ;;
215 esac
216
217 if ! built_with_use =${PHP_PKG} ${x} && ! phpconfutils_built_with_use =${PHP_PKG} ${x} ; then
218 einfo " Discovered missing USE flag: ${x}"
219 missing_use="${missing_use} ${x}"
220 fi
221 done
222
223 if [[ -z "${missing_use}" ]] ; then
224 if [[ -z "${PHPCHECKNODIE}" ]] ; then
225 return
226 else
227 return 0
228 fi
229 fi
230
231 if [[ -z "${PHPCHECKNODIE}" ]] ; then
232 eerror
233 eerror "${PHP_PKG} needs to be re-installed with all of the following"
234 eerror "USE flags enabled:"
235 eerror
236 eerror " $@"
237 eerror
238 die "Missing PHP USE flags found"
239 else
240 return 1
241 fi
242 }
243
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.
250 require_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
298 has_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
312 has_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
326 has_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
336 # ========================================================================
337 # require_*() functions
338 #
339 # These functions die() if PHP was built without the required features
340 # ========================================================================
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
349 require_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
372 require_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
402 # @FUNCTION: require_php_cgi
403 # @DESCRIPTION:
404 # 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.
406 # @RETURN: die if feature is missing
407 require_php_cgi() {
408 # If PHP_PKG is set, then we have remembered our PHP settings
409 # from last time
410 if [[ -n ${PHP_PKG} ]] ; then
411 return
412 fi
413
414 local PHP_PACKAGE_FOUND=""
415
416 if has_version '=dev-lang/php-5*' ; then
417 PHP_PACKAGE_FOUND="1"
418 pkg="$(best_version '=dev-lang/php-5*')"
419 if built_with_use =${pkg} cgi || phpconfutils_built_with_use =${pkg} cgi ; then
420 PHP_VERSION="5"
421 fi
422 fi
423
424 if [[ -z ${PHP_PACKAGE_FOUND} ]] ; then
425 die "Unable to find an installed dev-lang/php package"
426 fi
427
428 if [[ -z ${PHP_VERSION} ]] ; then
429 die "No PHP CGI installed. Re-emerge dev-lang/php with USE=cgi."
430 fi
431
432 # If we get here, then PHP_VERSION tells us which version of PHP we
433 # want to use
434 uses_php${PHP_VERSION}
435 }
436
437 # @FUNCTION: require_sqlite
438 # @DESCRIPTION:
439 # Require a PHP built with SQLite support
440 # @RETURN: die if feature is missing
441 require_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
463 require_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 # ========================================================================
488 # Misc functions
489 #
490 # These functions provide miscellaneous checks and functionality.
491 # ========================================================================
492
493 # @FUNCTION: php_binary_extension
494 # @DESCRIPTION:
495 # Executes some checks needed when installing a binary PHP extension.
496 php_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
531 # @FUNCTION: dodoc-php
532 # @USAGE: <list of docs>
533 # @DESCRIPTION:
534 # Alternative to dodoc function for use in our PHP eclasses and ebuilds.
535 # Stored here because depend.php gets always sourced everywhere in the PHP
536 # ebuilds and eclasses. It simply is dodoc with a changed path to the docs.
537 # NOTE: No support for docinto is provided!
538 dodoc-php() {
539 if [[ $# -lt 1 ]] ; then
540 echo "$0: at least one argument needed" 1>&2
541 exit 1
542 fi
543
544 phpdocdir="/usr/share/doc/${CATEGORY}/${PF}/"
545
546 for x in $@ ; do
547 if [[ -s "${x}" ]] ; then
548 insinto "${phpdocdir}"
549 doins "${x}"
550 gzip -f -9 "${D}/${phpdocdir}/${x##*/}"
551 elif [[ ! -e "${x}" ]] ; then
552 echo "dodoc-php: ${x} does not exist" 1>&2
553 fi
554 done
555 }
556
557 # @FUNCTION: dohtml-php
558 # @USAGE: <list of html docs>
559 # @DESCRIPTION:
560 # Alternative to dohtml function for use in our PHP eclasses and ebuilds.
561 # Stored here because depend.php gets always sourced everywhere in the PHP
562 # ebuilds and eclasses. It simply is dohtml with a changed path to the docs.
563 # NOTE: No support for [-a|-A|-p|-x] options is provided!
564 dohtml-php() {
565 if [[ $# -lt 1 ]] ; then
566 echo "$0: at least one argument needed" 1>&2
567 exit 1
568 fi
569
570 phphtmldir="/usr/share/doc/${CATEGORY}/${PF}/html"
571
572 for x in $@ ; do
573 if [[ -s "${x}" ]] ; then
574 insinto "${phphtmldir}"
575 doins "${x}"
576 elif [[ ! -e "${x}" ]] ; then
577 echo "dohtml-php: ${x} does not exist" 1>&2
578 fi
579 done
580 }

  ViewVC Help
Powered by ViewVC 1.1.20