/[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.36 - (show annotations) (download)
Mon May 4 20:02:26 2015 UTC (12 months, 3 weeks ago) by grknight
Branch: MAIN
CVS Tags: HEAD
Changes since 1.35: +6 -4 lines
Fix documentation of 3 variables in php-ext-source-r2 eclass

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

  ViewVC Help
Powered by ViewVC 1.1.20