/[gentoo-x86]/eclass/php-ext-source-r2.eclass
Gentoo

Contents of /eclass/php-ext-source-r2.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.15 - (hide annotations) (download)
Mon Aug 22 04:46:32 2011 UTC (3 years, 4 months ago) by vapier
Branch: MAIN
Changes since 1.14: +10 -10 lines
fix random bugs in eclass documentation, and convert to new @AUTHOR tag

1 vapier 1.15 # Copyright 1999-2011 Gentoo Foundation
2 olemarkus 1.1 # Distributed under the terms of the GNU General Public License v2
3 vapier 1.15 # $Header: /var/cvsroot/gentoo-x86/eclass/php-ext-source-r2.eclass,v 1.14 2011/08/19 09:15:51 olemarkus Exp $
4    
5     # @ECLASS: php-ext-source-r2.eclass
6     # @MAINTAINER:
7     # Gentoo PHP team <php-bugs@gentoo.org>
8     # @AUTHOR:
9 olemarkus 1.1 # Author: Tal Peer <coredumb@gentoo.org>
10     # Author: Stuart Herbert <stuart@gentoo.org>
11     # Author: Luca Longinotti <chtekk@gentoo.org>
12     # Author: Jakub Moc <jakub@gentoo.org> (documentation)
13     # Author: Ole Markus With <olemarkus@gentoo.org>
14     # @BLURB: A unified interface for compiling and installing standalone PHP extensions.
15     # @DESCRIPTION:
16     # This eclass provides a unified interface for compiling and installing standalone
17     # PHP extensions (modules).
18    
19 olemarkus 1.5 inherit flag-o-matic autotools
20 olemarkus 1.1
21 olemarkus 1.4 EXPORT_FUNCTIONS src_unpack src_prepare src_configure src_compile src_install
22 olemarkus 1.1
23     # @ECLASS-VARIABLE: PHP_EXT_NAME
24     # @DESCRIPTION:
25     # The extension name. This must be set, otherwise the eclass dies.
26     # Only automagically set by php-ext-pecl-r1.eclass, so unless your ebuild
27     # inherits that eclass, you must set this manually before inherit.
28     [[ -z "${PHP_EXT_NAME}" ]] && die "No module name specified for the php-ext-source-r2 eclass"
29    
30     DEPEND=">=sys-devel/m4-1.4.3
31     >=sys-devel/libtool-1.5.18"
32     RDEPEND=""
33    
34     # Because of USE deps, we require at least EAPI 2
35     case ${EAPI} in
36     2|3) ;;
37     *)
38     die "php-ext-source-r2 is not compatible with EAPI=${EAPI}"
39     esac
40    
41     # @ECLASS-VARIABLE: PHP_EXT_NAME
42     # @DESCRIPTION:
43     # The extension name. This must be set, otherwise the eclass dies.
44     # Only automagically set by php-ext-pecl-r2.eclass, so unless your ebuild
45     # inherits that eclass, you must set this manually before inherit.
46     [[ -z "${PHP_EXT_NAME}" ]] && die "No module name specified for the php-ext-source-r2 eclass"
47    
48     # @ECLASS-VARIABLE: PHP_EXT_INI
49     # @DESCRIPTION:
50     # Controls whether or not to add a line to php.ini for the extension.
51     # Defaults to "yes" and should not be changed in most cases.
52     [[ -z "${PHP_EXT_INI}" ]] && PHP_EXT_INI="yes"
53    
54     # @ECLASS-VARIABLE: PHP_EXT_ZENDEXT
55     # @DESCRIPTION:
56     # Controls whether the extension is a ZendEngine extension or not.
57     # Defaults to "no" and if you don't know what is it, you don't need it.
58     [[ -z "${PHP_EXT_ZENDEXT}" ]] && PHP_EXT_ZENDEXT="no"
59    
60     # @ECLASS-VARIABLE: USE_PHP
61     # @DESCRIPTION:
62     # Lists the PHP slots compatibile the extension is compatibile with
63 olemarkus 1.10 [[ -z "${USE_PHP}" ]] && USE_PHP="php5-3 php5-2"
64 olemarkus 1.1
65 robbat2 1.7 # @ECLASS-VARIABLE: PHP_EXT_OPTIONAL_USE
66     # @DESCRIPTION:
67     # If set, this is the USE flag that the PHP dependencies are behind
68     # Most commonly set as PHP_EXT_OPTIONAL_USE=php to get the dependencies behind
69     # USE=php.
70    
71 olemarkus 1.8 # @ECLASS-VARIABLE: PHP_EXT_S
72     # @DESCRIPTION:
73     # The relative location of the temporary build directory for the PHP extension within
74     # the source package. This is useful for packages that bundle the PHP extension.
75     # Defaults to ${S}
76     [[ -z "${PHP_EXT_S}" ]] && PHP_EXT_S="${S}"
77    
78 olemarkus 1.2 #Make sure at least one target is installed. Abuses USE dependencies.
79 olemarkus 1.3 for target in ${USE_PHP}; do
80     IUSE="${IUSE} php_targets_${target}"
81 olemarkus 1.1 target=${target/+}
82 olemarkus 1.3 SELFDEPEND="${SELFDEPEND} =${CATEGORY}/${PF}[php_targets_${target}]"
83 olemarkus 1.1 slot=${target/php}
84     slot=${slot/-/.}
85 darkside 1.6 PHPDEPEND="${PHPDEPEND}
86 olemarkus 1.3 php_targets_${target}? ( dev-lang/php:${slot} )"
87 olemarkus 1.1 done
88 darkside 1.6
89     RDEPEND="${RDEPEND}
90 robbat2 1.7 ${PHP_EXT_OPTIONAL_USE}${PHP_EXT_OPTIONAL_USE:+? ( }
91 olemarkus 1.3 || ( ${SELFDEPEND} )
92 robbat2 1.7 ${PHPDEPEND}
93     ${PHP_EXT_OPTIONAL_USE:+ )}"
94 olemarkus 1.1
95    
96     # @FUNCTION: php-ext-source-r2_src_unpack
97     # @DESCRIPTION:
98     # runs standard src_unpack + _phpize
99 vapier 1.15
100 olemarkus 1.1 # @VARIABLE: PHP_EXT_SKIP_PHPIZE
101     # @DESCRIPTION:
102     # phpize will be run by default for all ebuilds that use
103 darkside 1.6 # php-ext-source-r2_src_unpack
104 olemarkus 1.1 # Set PHP_EXT_SKIP_PHPIZE="yes" in your ebuild if you do not want to run phpize.
105     php-ext-source-r2_src_unpack() {
106     unpack ${A}
107 olemarkus 1.8 local slot orig_s="${PHP_EXT_S}"
108 olemarkus 1.1 for slot in $(php_get_slots); do
109 olemarkus 1.3 cp -r "${orig_s}" "${WORKDIR}/${slot}"
110 olemarkus 1.4 done
111     }
112    
113     php-ext-source-r2_src_prepare() {
114 olemarkus 1.8 local slot orig_s="${PHP_EXT_S}"
115 olemarkus 1.4 for slot in $(php_get_slots); do
116 olemarkus 1.3 php_init_slot_env ${slot}
117 olemarkus 1.4 php-ext-source-r2_phpize
118 olemarkus 1.1 done
119     }
120    
121 vapier 1.15 # @FUNCTION: php-ext-source-r2_phpize
122 olemarkus 1.1 # @DESCRIPTION:
123     # Runs phpize and autotools in addition to the standard src_unpack
124     php-ext-source-r2_phpize() {
125 olemarkus 1.4 if [[ "${PHP_EXT_SKIP_PHPIZE}" != 'yes' ]] ; then
126     # Create configure out of config.m4
127     # I wish I could run this to solve #329071, but I cannot
128     #autotools_run_tool ${PHPIZE}
129     ${PHPIZE}
130     # force run of libtoolize and regeneration of related autotools
131     # files (bug 220519)
132     rm aclocal.m4
133     eautoreconf
134 darkside 1.6 fi
135 olemarkus 1.1 }
136    
137     # @FUNCTION: php-ext-source-r2_src_configure
138     # @DESCRIPTION:
139     # Takes care of standard configure for PHP extensions (modules).
140 vapier 1.15
141 olemarkus 1.1 # @VARIABLE: my_conf
142     # @DESCRIPTION:
143     # Set this in the ebuild to pass configure options to econf.
144     php-ext-source-r2_src_configure() {
145     local slot
146     for slot in $(php_get_slots); do
147 olemarkus 1.3 php_init_slot_env ${slot}
148 olemarkus 1.1 # Set the correct config options
149 olemarkus 1.14 econf --with-php-config=${PHPCONFIG} ${my_conf} || die "Unable to configure code to compile"
150 olemarkus 1.1 done
151     }
152    
153     # @FUNCTION: php-ext-source-r2_src_compile
154     # @DESCRIPTION:
155     # Takes care of standard compile for PHP extensions (modules).
156     php-ext-source-r2_src_compile() {
157     # net-snmp creates this file #324739
158     addpredict /usr/share/snmp/mibs/.index
159     # shm extension createss a semaphore file #173574
160     addpredict /session_mm_cli0.sem
161 darkside 1.6 local slot
162 olemarkus 1.1 for slot in $(php_get_slots); do
163 olemarkus 1.3 php_init_slot_env ${slot}
164 olemarkus 1.1 emake || die "Unable to make code"
165    
166     done
167     }
168    
169     # @FUNCTION: php-ext-source-r1_src_install
170     # @DESCRIPTION:
171     # Takes care of standard install for PHP extensions (modules).
172    
173     # @VARIABLE: DOCS
174     # @DESCRIPTION:
175     # Set in ebuild if you wish to install additional, package-specific documentation.
176     php-ext-source-r2_src_install() {
177     local slot
178     for slot in $(php_get_slots); do
179 olemarkus 1.3 php_init_slot_env ${slot}
180 olemarkus 1.1
181     # Let's put the default module away
182     insinto "${EXT_DIR}"
183     newins "modules/${PHP_EXT_NAME}.so" "${PHP_EXT_NAME}.so" || die "Unable to install extension"
184    
185 olemarkus 1.3 local doc
186 olemarkus 1.1 for doc in ${DOCS} ; do
187     [[ -s ${doc} ]] && dodoc ${doc}
188     done
189    
190 olemarkus 1.14 INSTALL_ROOT="${D}" emake install-headers
191 olemarkus 1.1 done
192     php-ext-source-r2_createinifiles
193     }
194    
195    
196     php_get_slots() {
197 olemarkus 1.3 local s slot
198     for slot in ${USE_PHP}; do
199     use php_targets_${slot} && s+=" ${slot/-/.}"
200 olemarkus 1.1 done
201     echo $s
202     }
203    
204     php_init_slot_env() {
205     libdir=$(get_libdir)
206    
207 olemarkus 1.3 PHPIZE="/usr/${libdir}/${1}/bin/phpize"
208     PHPCONFIG="/usr/${libdir}/${1}/bin/php-config"
209     PHPCLI="/usr/${libdir}/${1}/bin/php"
210     PHPCGI="/usr/${libdir}/${1}/bin/php-cgi"
211 olemarkus 1.1 PHP_PKG="$(best_version =dev-lang/php-${1:3}*)"
212 olemarkus 1.3 PHPPREFIX="/usr/${libdir}/${slot}"
213 olemarkus 1.1 EXT_DIR="$(${PHPCONFIG} --extension-dir 2>/dev/null)"
214 olemarkus 1.5 PHP_CURRENTSLOT=${1:3}
215 olemarkus 1.1
216 olemarkus 1.8 PHP_EXT_S="${WORKDIR}/${1}"
217     cd "${PHP_EXT_S}"
218 olemarkus 1.1 }
219    
220     php-ext-source-r2_buildinilist() {
221     # Work out the list of <ext>.ini files to edit/add to
222     if [[ -z "${PHPSAPILIST}" ]] ; then
223     PHPSAPILIST="apache2 cli cgi fpm"
224     fi
225    
226 olemarkus 1.12 PHPINIFILELIST=""
227 olemarkus 1.3 local x
228 olemarkus 1.1 for x in ${PHPSAPILIST} ; do
229     if [[ -f "/etc/php/${x}-${1}/php.ini" ]] ; then
230     PHPINIFILELIST="${PHPINIFILELIST} etc/php/${x}-${1}/ext/${PHP_EXT_NAME}.ini"
231     fi
232     done
233 olemarkus 1.12 PHPFULLINIFILELIST="${PHPFULLINIFILELIST} ${PHPINIFILELIST}"
234 olemarkus 1.1 }
235    
236     # @FUNCTION: php-ext-source-r2_createinifiles
237     # @DESCRIPTION:
238     # Builds ini files for every enabled slot and SAPI
239     php-ext-source-r2_createinifiles() {
240     local slot
241 darkside 1.6 for slot in $(php_get_slots); do
242 olemarkus 1.3 php_init_slot_env ${slot}
243 olemarkus 1.1 # Pull in the PHP settings
244    
245     # Build the list of <ext>.ini files to edit/add to
246 olemarkus 1.3 php-ext-source-r2_buildinilist ${slot}
247 olemarkus 1.1
248 olemarkus 1.13
249 olemarkus 1.1 # Add the needed lines to the <ext>.ini files
250 olemarkus 1.13 local file
251 olemarkus 1.1 if [[ "${PHP_EXT_INI}" = "yes" ]] ; then
252 olemarkus 1.13 for file in ${PHPINIFILELIST}; do
253     php-ext-source-r2_addextension "${PHP_EXT_NAME}.so" "${file}"
254     done
255 olemarkus 1.1 fi
256 olemarkus 1.12
257 olemarkus 1.1
258     # Symlink the <ext>.ini files from ext/ to ext-active/
259 olemarkus 1.13 local inifile
260 olemarkus 1.1 for inifile in ${PHPINIFILELIST} ; do
261 olemarkus 1.12 if [[ -n "${PHP_EXT_INIFILE}" ]]; then
262 olemarkus 1.13 cat "${FILESDIR}/${PHP_EXT_INIFILE}" > "${inifile}"
263 olemarkus 1.12 einfo "Added content of ${FILESDIR}/${PHP_EXT_INIFILE} to ${inifile}"
264     fi
265    
266    
267    
268    
269 olemarkus 1.1 inidir="${inifile/${PHP_EXT_NAME}.ini/}"
270     inidir="${inidir/ext/ext-active}"
271     dodir "/${inidir}"
272     dosym "/${inifile}" "/${inifile/ext/ext-active}"
273     done
274    
275     # Add support for installing PHP files into a version dependant directory
276     PHP_EXT_SHARED_DIR="/usr/share/php/${PHP_EXT_NAME}"
277     done
278 olemarkus 1.12
279 olemarkus 1.1 }
280    
281     php-ext-source-r2_addextension() {
282     if [[ "${PHP_EXT_ZENDEXT}" = "yes" ]] ; then
283     # We need the full path for ZendEngine extensions
284     # and we need to check for debugging enabled!
285 olemarkus 1.5 if has_version "dev-lang/php:${PHP_CURRENTSLOT}[threads]" ; then
286     if has_version "dev-lang/php:${PHP_CURRENTSLOT}[debug]" ; then
287 olemarkus 1.1 ext_type="zend_extension_debug_ts"
288     else
289     ext_type="zend_extension_ts"
290     fi
291 olemarkus 1.3 ext_file="${EXT_DIR}/${1}"
292 olemarkus 1.1 else
293 olemarkus 1.5 if has_version "dev-lang/php:${PHP_CURRENTSLOT}[debug]"; then
294 olemarkus 1.1 ext_type="zend_extension_debug"
295     else
296     ext_type="zend_extension"
297     fi
298 olemarkus 1.3 ext_file="${EXT_DIR}/${1}"
299 olemarkus 1.1 fi
300    
301     # php-5.3 unifies zend_extension loading and just requires the
302     # zend_extension keyword with no suffix
303     # TODO: drop previous code and this check once <php-5.3 support is
304     # discontinued
305     if has_version '>=dev-lang/php-5.3' ; then
306     ext_type="zend_extension"
307     fi
308     else
309     # We don't need the full path for normal extensions!
310     ext_type="extension"
311 olemarkus 1.3 ext_file="${1}"
312 olemarkus 1.1 fi
313    
314 olemarkus 1.13 php-ext-source-r2_addtoinifile "${ext_type}" "${ext_file}" "${2}" "Extension added"
315 olemarkus 1.1 }
316    
317     # $1 - Setting name
318     # $2 - Setting value
319     # $3 - File to add to
320     # $4 - Sanitized text to output
321     php-ext-source-r2_addtoinifile() {
322 olemarkus 1.13 local inifile="${WORKDIR}/${3}"
323     if [[ ! -d $(dirname ${inifile}) ]] ; then
324     mkdir -p $(dirname ${inifile})
325 olemarkus 1.1 fi
326    
327     # Are we adding the name of a section?
328     if [[ ${1:0:1} == "[" ]] ; then
329 olemarkus 1.13 echo "${1}" >> "${inifile}"
330 olemarkus 1.3 my_added="${1}"
331 olemarkus 1.1 else
332 olemarkus 1.13 echo "${1}=${2}" >> "${inifile}"
333 olemarkus 1.3 my_added="${1}=${2}"
334 olemarkus 1.1 fi
335    
336 olemarkus 1.3 if [[ -z "${4}" ]] ; then
337     einfo "Added '${my_added}' to /${3}"
338 olemarkus 1.1 else
339 olemarkus 1.3 einfo "${4} to /${3}"
340 olemarkus 1.1 fi
341    
342 olemarkus 1.3 insinto /$(dirname ${3})
343 olemarkus 1.13 doins "${inifile}"
344 olemarkus 1.1 }
345    
346     # @FUNCTION: php-ext-source-r2_addtoinifiles
347     # @USAGE: <setting name> <setting value> [message to output]; or just [section name]
348     # @DESCRIPTION:
349     # Add value settings to php.ini file installed by the extension (module).
350     # You can also add a [section], see examples below.
351     #
352     # @CODE
353     # Add some settings for the extension:
354     #
355     # php-ext-source-r2_addtoinifiles "zend_optimizer.optimization_level" "15"
356     # php-ext-source-r2_addtoinifiles "zend_optimizer.enable_loader" "0"
357     # php-ext-source-r2_addtoinifiles "zend_optimizer.disable_licensing" "0"
358     #
359     # Adding values to a section in php.ini file installed by the extension:
360     #
361     # php-ext-source-r2_addtoinifiles "[Debugger]"
362     # php-ext-source-r2_addtoinifiles "debugger.enabled" "on"
363     # php-ext-source-r2_addtoinifiles "debugger.profiler_enabled" "on"
364     # @CODE
365     php-ext-source-r2_addtoinifiles() {
366 olemarkus 1.3 local x
367 olemarkus 1.12 for x in ${PHPFULLINIFILELIST} ; do
368 olemarkus 1.3 php-ext-source-r2_addtoinifile "${1}" "${2}" "${x}" "${3}"
369 olemarkus 1.1 done
370     }

  ViewVC Help
Powered by ViewVC 1.1.20