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

Contents of /eclass/depend.php.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.26 - (show annotations) (download)
Tue Jul 13 23:48:46 2010 UTC (4 years, 2 months ago) by mabi
Branch: MAIN
Changes since 1.25: +4 -94 lines
remove php4 left-overs

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.25 2008/02/26 16:26:08 armin76 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} =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.
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} virtual/php"
80 RDEPEND="${RDEPEND} virtual/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 if ! built_with_use =${PHP_PKG} ${x} && ! phpconfutils_built_with_use =${PHP_PKG} ${x} ; then
211 einfo " Discovered missing USE flag: ${x}"
212 missing_use="${missing_use} ${x}"
213 fi
214 done
215
216 if [[ -z "${missing_use}" ]] ; then
217 if [[ -z "${PHPCHECKNODIE}" ]] ; then
218 return
219 else
220 return 0
221 fi
222 fi
223
224 if [[ -z "${PHPCHECKNODIE}" ]] ; then
225 eerror
226 eerror "${PHP_PKG} needs to be re-installed with all of the following"
227 eerror "USE flags enabled:"
228 eerror
229 eerror " $@"
230 eerror
231 die "Missing PHP USE flags found"
232 else
233 return 1
234 fi
235 }
236
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.
243 require_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
291 has_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
305 has_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
319 has_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
329 # ========================================================================
330 # require_*() functions
331 #
332 # These functions die() if PHP was built without the required features
333 # ========================================================================
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
342 require_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
365 require_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
395 # @FUNCTION: require_php_cgi
396 # @DESCRIPTION:
397 # 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.
399 # @RETURN: die if feature is missing
400 require_php_cgi() {
401 # If PHP_PKG is set, then we have remembered our PHP settings
402 # from last time
403 if [[ -n ${PHP_PKG} ]] ; then
404 return
405 fi
406
407 local PHP_PACKAGE_FOUND=""
408
409 if has_version '=dev-lang/php-5*' ; then
410 PHP_PACKAGE_FOUND="1"
411 pkg="$(best_version '=dev-lang/php-5*')"
412 if built_with_use =${pkg} cgi || phpconfutils_built_with_use =${pkg} cgi ; then
413 PHP_VERSION="5"
414 fi
415 fi
416
417 if [[ -z ${PHP_PACKAGE_FOUND} ]] ; then
418 die "Unable to find an installed dev-lang/php package"
419 fi
420
421 if [[ -z ${PHP_VERSION} ]] ; then
422 die "No PHP CGI installed. Re-emerge dev-lang/php with USE=cgi."
423 fi
424
425 # If we get here, then PHP_VERSION tells us which version of PHP we
426 # want to use
427 uses_php${PHP_VERSION}
428 }
429
430 # @FUNCTION: require_sqlite
431 # @DESCRIPTION:
432 # Require a PHP built with SQLite support
433 # @RETURN: die if feature is missing
434 require_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
456 require_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 # ========================================================================
481 # Misc functions
482 #
483 # These functions provide miscellaneous checks and functionality.
484 # ========================================================================
485
486 # @FUNCTION: php_binary_extension
487 # @DESCRIPTION:
488 # Executes some checks needed when installing a binary PHP extension.
489 php_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
524 # @FUNCTION: dodoc-php
525 # @USAGE: <list of docs>
526 # @DESCRIPTION:
527 # Alternative to dodoc function for use in our PHP eclasses and ebuilds.
528 # Stored here because depend.php gets always sourced everywhere in the PHP
529 # ebuilds and eclasses. It simply is dodoc with a changed path to the docs.
530 # NOTE: No support for docinto is provided!
531 dodoc-php() {
532 if [[ $# -lt 1 ]] ; then
533 echo "$0: at least one argument needed" 1>&2
534 exit 1
535 fi
536
537 phpdocdir="/usr/share/doc/${CATEGORY}/${PF}/"
538
539 for x in $@ ; do
540 if [[ -s "${x}" ]] ; then
541 insinto "${phpdocdir}"
542 doins "${x}"
543 gzip -f -9 "${D}/${phpdocdir}/${x##*/}"
544 elif [[ ! -e "${x}" ]] ; then
545 echo "dodoc-php: ${x} does not exist" 1>&2
546 fi
547 done
548 }
549
550 # @FUNCTION: dohtml-php
551 # @USAGE: <list of html docs>
552 # @DESCRIPTION:
553 # Alternative to dohtml function for use in our PHP eclasses and ebuilds.
554 # Stored here because depend.php gets always sourced everywhere in the PHP
555 # ebuilds and eclasses. It simply is dohtml with a changed path to the docs.
556 # NOTE: No support for [-a|-A|-p|-x] options is provided!
557 dohtml-php() {
558 if [[ $# -lt 1 ]] ; then
559 echo "$0: at least one argument needed" 1>&2
560 exit 1
561 fi
562
563 phphtmldir="/usr/share/doc/${CATEGORY}/${PF}/html"
564
565 for x in $@ ; do
566 if [[ -s "${x}" ]] ; then
567 insinto "${phphtmldir}"
568 doins "${x}"
569 elif [[ ! -e "${x}" ]] ; then
570 echo "dohtml-php: ${x} does not exist" 1>&2
571 fi
572 done
573 }

  ViewVC Help
Powered by ViewVC 1.1.20