/[gentoo-x86]/eclass/java-utils-2.eclass
Gentoo

Contents of /eclass/java-utils-2.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.162 - (show annotations) (download)
Sun May 24 22:44:37 2015 UTC (3 years, 5 months ago) by chewi
Branch: MAIN
Changes since 1.161: +1 -13 lines
The depend-java-query wrapper is raising readonly variable warnings
for USE in Portage 2.2.20. As best I can tell, this wrapper just isn't
needed any more because USE is already exported. I guess it wasn't
back in 2006?

1 # Base eclass for Java packages
2 #
3 # Copyright (c) 2004-2005, Thomas Matthijs <axxo@gentoo.org>
4 # Copyright (c) 2004, Karl Trygve Kalleberg <karltk@gentoo.org>
5 # Copyright (c) 2004-2015, Gentoo Foundation
6 #
7 # Licensed under the GNU General Public License, v2
8 #
9 # $Header: /var/cvsroot/gentoo-x86/eclass/java-utils-2.eclass,v 1.161 2015/05/09 22:20:44 chewi Exp $
10
11 # @ECLASS: java-utils-2.eclass
12 # @MAINTAINER:
13 # java@gentoo.org
14 # @AUTHOR:
15 # Thomas Matthijs <axxo@gentoo.org>, Karl Trygve Kalleberg <karltk@gentoo.org>
16 # @BLURB: Base eclass for Java packages
17 # @DESCRIPTION:
18 # This eclass provides functionality which is used by java-pkg-2.eclass,
19 # java-pkg-opt-2.eclass and java-ant-2 eclass, as well as from ebuilds.
20 #
21 # This eclass should not be inherited this directly from an ebuild. Instead,
22 # you should inherit java-pkg-2 for Java packages or java-pkg-opt-2 for packages
23 # that have optional Java support. In addition you can inherit java-ant-2 for
24 # Ant-based packages.
25 inherit eutils versionator multilib
26
27 IUSE="elibc_FreeBSD"
28
29 # Make sure we use java-config-2
30 export WANT_JAVA_CONFIG="2"
31
32 # @VARIABLE: JAVA_PKG_PORTAGE_DEP
33 # @INTERNAL
34 # @DESCRIPTION:
35 # The version of portage we need to function properly. Previously it was
36 # portage with phase hooks support but now we use a version with proper env
37 # saving. For EAPI 2 we have new enough stuff so let's have cleaner deps.
38 has "${EAPI}" 0 1 && JAVA_PKG_PORTAGE_DEP=">=sys-apps/portage-2.1.2.7"
39
40 # @VARIABLE: JAVA_PKG_E_DEPEND
41 # @INTERNAL
42 # @DESCRIPTION:
43 # This is a convience variable to be used from the other java eclasses. This is
44 # the version of java-config we want to use. Usually the latest stable version
45 # so that ebuilds can use new features without depending on specific versions.
46 JAVA_PKG_E_DEPEND=">=dev-java/java-config-2.2.0 ${JAVA_PKG_PORTAGE_DEP}"
47 has source ${JAVA_PKG_IUSE} && JAVA_PKG_E_DEPEND="${JAVA_PKG_E_DEPEND} source? ( app-arch/zip )"
48
49 # @ECLASS-VARIABLE: JAVA_PKG_WANT_BOOTCLASSPATH
50 # @DEFAULT_UNSET
51 # @DESCRIPTION:
52 # The version of bootclasspath the package needs to work. Translates to a proper
53 # dependency. The bootclasspath can then be obtained by java-ant_rewrite-bootclasspath
54 if [[ -n "${JAVA_PKG_WANT_BOOTCLASSPATH}" ]]; then
55 if [[ "${JAVA_PKG_WANT_BOOTCLASSPATH}" == "1.5" ]]; then
56 JAVA_PKG_E_DEPEND="${JAVA_PKG_E_DEPEND} >=dev-java/gnu-classpath-0.98-r1:0.98"
57 else
58 eerror "Unknown value of JAVA_PKG_WANT_BOOTCLASSPATH"
59 # since die in global scope doesn't work, this will make repoman fail
60 JAVA_PKG_E_DEPEND="${JAVA_PKG_E_DEPEND} BAD_JAVA_PKG_WANT_BOOTCLASSPATH"
61 fi
62 fi
63
64 # @ECLASS-VARIABLE: JAVA_PKG_ALLOW_VM_CHANGE
65 # @DESCRIPTION:
66 # Allow this eclass to change the active VM?
67 # If your system VM isn't sufficient for the package, the build will fail
68 # instead of trying to switch to another VM.
69 #
70 # Overriding the default can be useful for testing specific VMs locally, but
71 # should not be used in the final ebuild.
72 JAVA_PKG_ALLOW_VM_CHANGE=${JAVA_PKG_ALLOW_VM_CHANGE:="yes"}
73
74 # @ECLASS-VARIABLE: JAVA_PKG_FORCE_VM
75 # @DEFAULT_UNSET
76 # @DESCRIPTION:
77 # Explicitly set a particular VM to use. If its not valid, it'll fall back to
78 # whatever /etc/java-config-2/build/jdk.conf would elect to use.
79 #
80 # Should only be used for testing and debugging.
81 #
82 # Example: use sun-jdk-1.5 to emerge foo:
83 # @CODE
84 # JAVA_PKG_FORCE_VM=sun-jdk-1.5 emerge foo
85 # @CODE
86
87 # @ECLASS-VARIABLE: JAVA_PKG_WANT_BUILD_VM
88 # @DEFAULT_UNSET
89 # @DESCRIPTION:
90 # A list of VM handles to choose a build VM from. If the list contains the
91 # currently active VM use that one, otherwise step through the list till a
92 # usable/installed VM is found.
93 #
94 # This allows to use an explicit list of JDKs in DEPEND instead of a virtual.
95 # Users of this variable must make sure at least one of the listed handles is
96 # covered by DEPEND.
97 # Requires JAVA_PKG_WANT_SOURCE and JAVA_PKG_WANT_TARGET to be set as well.
98
99 # @ECLASS-VARIABLE: JAVA_PKG_WANT_SOURCE
100 # @DEFAULT_UNSET
101 # @DESCRIPTION:
102 # Specify a non-standard Java source version for compilation (via javac -source
103 # parameter or Ant equivalent via build.xml rewriting done by java-ant-2 eclass).
104 # Normally this is determined from the jdk version specified in DEPEND.
105 # See java-pkg_get-source function below.
106 #
107 # Should generally only be used for testing and debugging.
108 #
109 # Use 1.4 source to emerge baz
110 # @CODE
111 # JAVA_PKG_WANT_SOURCE=1.4 emerge baz
112 # @CODE
113
114 # @ECLASS-VARIABLE: JAVA_PKG_WANT_TARGET
115 # @DEFAULT_UNSET
116 # @DESCRIPTION:
117 # Same as JAVA_PKG_WANT_SOURCE (see above) but for javac -target parameter,
118 # which affects the version of generated bytecode.
119 # Normally this is determined from the jre/jdk version specified in RDEPEND.
120 # See java-pkg_get-target function below.
121 #
122 # Should generallyonly be used for testing and debugging.
123 #
124 # emerge bar to be compatible with 1.3
125 # @CODE
126 # JAVA_PKG_WANT_TARGET=1.3 emerge bar
127 # @CODE
128
129 # @VARIABLE: JAVA_PKG_COMPILER_DIR
130 # @INTERNAL
131 # @DESCRIPTION:
132 # Directory where compiler settings are saved, without trailing slash.
133 # You probably shouldn't touch this variable except local testing.
134 JAVA_PKG_COMPILER_DIR=${JAVA_PKG_COMPILER_DIR:="/usr/share/java-config-2/compiler"}
135
136 # @VARIABLE: JAVA_PKG_COMPILERS_CONF
137 # @INTERNAL
138 # @DESCRIPTION:
139 # Path to file containing information about which compiler to use.
140 # Can be overloaded, but it should be overloaded only for local testing.
141 JAVA_PKG_COMPILERS_CONF=${JAVA_PKG_COMPILERS_CONF:="/etc/java-config-2/build/compilers.conf"}
142
143 # @ECLASS-VARIABLE: JAVA_PKG_FORCE_COMPILER
144 # @INTERNAL
145 # @DEFAULT_UNSET
146 # @DESCRIPTION:
147 # Explicitly set a list of compilers to choose from. This is normally read from
148 # JAVA_PKG_COMPILERS_CONF.
149 #
150 # Useful for local testing.
151 #
152 # Use jikes and javac, in that order
153 # @CODE
154 # JAVA_PKG_FORCE_COMPILER="jikes javac"
155 # @CODE
156
157 # @ECLASS-VARIABLE: JAVA_PKG_FORCE_ANT_TASKS
158 # @DEFAULT_UNSET
159 # @DESCRIPTION:
160 # An $IFS separated list of ant tasks. Can be set in environment before calling
161 # emerge/ebuild to override variables set in ebuild, mainly for testing before
162 # putting the resulting (WANT_)ANT_TASKS into ebuild. Affects only ANT_TASKS in
163 # eant() call, not the dependencies specified in WANT_ANT_TASKS.
164 #
165 # @CODE
166 # JAVA_PKG_FORCE_ANT_TASKS="ant-junit ant-trax" \
167 # ebuild foo.ebuild compile
168 # @CODE
169
170 # TODO document me
171 JAVA_PKG_QA_VIOLATIONS=0
172
173 # @FUNCTION: java-pkg_doexamples
174 # @USAGE: [--subdir <subdir>] <file1/dir1> [<file2> ...]
175 # @DESCRIPTION:
176 # Installs given arguments to /usr/share/doc/${PF}/examples
177 # If you give it only one parameter and it is a directory it will install
178 # everything in that directory to the examples directory.
179 #
180 # @CODE
181 # Parameters:
182 # --subdir - If the examples need a certain directory structure
183 # $* - list of files to install
184 #
185 # Examples:
186 # java-pkg_doexamples demo
187 # java-pkg_doexamples demo/* examples/*
188 # @CODE
189 java-pkg_doexamples() {
190 debug-print-function ${FUNCNAME} $*
191
192 [[ ${#} -lt 1 ]] && die "At least one argument needed"
193
194 java-pkg_check-phase install
195 java-pkg_init_paths_
196
197 local dest=/usr/share/doc/${PF}/examples
198 if [[ ${1} == --subdir ]]; then
199 local dest=${dest}/${2}
200 dodir ${dest}
201 shift 2
202 fi
203
204 if [[ ${#} = 1 && -d ${1} ]]; then
205 ( # dont want to pollute calling env
206 insinto "${dest}"
207 doins -r ${1}/*
208 ) || die "Installing examples failed"
209 else
210 ( # dont want to pollute calling env
211 insinto "${dest}"
212 doins -r "$@"
213 ) || die "Installing examples failed"
214 fi
215
216 # Let's make a symlink to the directory we have everything else under
217 dosym "${dest}" "${JAVA_PKG_SHAREPATH}/examples" || die
218 }
219
220 # @FUNCTION: java-pkg_dojar
221 # @USAGE: <jar1> [<jar2> ...]
222 # @DESCRIPTION:
223 # Installs any number of jars.
224 # Jar's will be installed into /usr/share/${PN}(-${SLOT})/lib/ by default.
225 # You can use java-pkg_jarinto to change this path.
226 # You should never install a jar with a package version in the filename.
227 # Instead, use java-pkg_newjar defined below.
228 #
229 # @CODE
230 # java-pkg_dojar dist/${PN}.jar dist/${PN}-core.jar
231 # @CODE
232 #
233 # @param $* - list of jars to install
234 java-pkg_dojar() {
235 debug-print-function ${FUNCNAME} $*
236
237 [[ ${#} -lt 1 ]] && die "At least one argument needed"
238
239 java-pkg_check-phase install
240 java-pkg_init_paths_
241
242 # Create JARDEST if it doesn't exist
243 dodir ${JAVA_PKG_JARDEST}
244
245 local jar
246 # for each jar
247 for jar in "${@}"; do
248 local jar_basename=$(basename "${jar}")
249
250 java-pkg_check-versioned-jar ${jar_basename}
251
252 # check if it exists
253 if [[ -e "${jar}" ]] ; then
254 # Don't overwrite if jar has already been installed with the same
255 # name
256 local dest="${D}${JAVA_PKG_JARDEST}/${jar_basename}"
257 if [[ -e "${dest}" ]]; then
258 ewarn "Overwriting ${dest}"
259 fi
260
261 # install it into JARDEST if it's a non-symlink
262 if [[ ! -L "${jar}" ]] ; then
263 #but first check class version when in strict mode.
264 is-java-strict && java-pkg_verify-classes "${jar}"
265
266 INSDESTTREE="${JAVA_PKG_JARDEST}" \
267 doins "${jar}" || die "failed to install ${jar}"
268 java-pkg_append_ JAVA_PKG_CLASSPATH "${JAVA_PKG_JARDEST}/${jar_basename}"
269 debug-print "installed ${jar} to ${D}${JAVA_PKG_JARDEST}"
270 # make a symlink to the original jar if it's symlink
271 else
272 # TODO use dosym, once we find something that could use it
273 # -nichoj
274 ln -s "$(readlink "${jar}")" "${D}${JAVA_PKG_JARDEST}/${jar_basename}"
275 debug-print "${jar} is a symlink, linking accordingly"
276 fi
277 else
278 die "${jar} does not exist"
279 fi
280 done
281
282 java-pkg_do_write_
283 }
284
285 # @FUNCTION: java-pkg_regjar
286 # @USAGE: </path/to/installed/jar>
287 # @DESCRIPTION:
288 # Records an already installed (in ${D}) jar in the package.env
289 # This would mostly be used if the package has make or a custom script to
290 # install things.
291 #
292 # WARNING:
293 # if you want to use shell expansion, you have to use ${D}/... as the for in
294 # this function will not be able to expand the path, here's an example:
295 #
296 # @CODE
297 # java-pkg_regjar ${D}/opt/my-java/lib/*.jar
298 # @CODE
299 #
300
301 # TODO should we be making sure the jar is present on ${D} or wherever?
302 java-pkg_regjar() {
303 debug-print-function ${FUNCNAME} $*
304
305 java-pkg_check-phase install
306
307 [[ ${#} -lt 1 ]] && die "at least one argument needed"
308
309 java-pkg_init_paths_
310
311 local jar jar_dir jar_file
312 for jar in "${@}"; do
313 # TODO use java-pkg_check-versioned-jar
314 if [[ -e "${jar}" || -e "${D}${jar}" ]]; then
315 [[ -d "${jar}" || -d "${D}${jar}" ]] \
316 && die "Called ${FUNCNAME} on a directory $*"
317
318 #check that class version correct when in strict mode
319 is-java-strict && java-pkg_verify-classes "${jar}"
320
321 # nelchael: we should strip ${D} in this case too, here's why:
322 # imagine such call:
323 # java-pkg_regjar ${D}/opt/java/*.jar
324 # such call will fall into this case (-e ${jar}) and will
325 # record paths with ${D} in package.env
326 java-pkg_append_ JAVA_PKG_CLASSPATH "${jar#${D}}"
327 else
328 if [[ ${jar} = *\** ]]; then
329 eerror "The argument ${jar} to ${FUNCNAME}"
330 eerror "has * in it. If you want it to glob in"
331 eerror '${D} add ${D} to the argument.'
332 fi
333 debug-print "${jar} or ${D}${jar} not found"
334 die "${jar} does not exist"
335 fi
336 done
337
338 java-pkg_do_write_
339 }
340
341 # @FUNCTION: java-pkg_newjar
342 # @USAGE: <path/to/oldname.jar> [<newname.jar>]
343 # @DESCRIPTION:
344 # Installs a jar with a new name (defaults to $PN.jar)
345 #
346 # For example, installs a versioned jar without the version
347 java-pkg_newjar() {
348 debug-print-function ${FUNCNAME} $*
349
350 local original_jar="${1}"
351 local new_jar="${2:-${PN}.jar}"
352 local new_jar_dest="${T}/${new_jar}"
353
354 [[ -z ${original_jar} ]] && die "Must specify a jar to install"
355 [[ ! -f ${original_jar} ]] \
356 && die "${original_jar} does not exist or is not a file!"
357
358 rm -f "${new_jar_dest}" || die "Failed to remove ${new_jar_dest}"
359 cp "${original_jar}" "${new_jar_dest}" \
360 || die "Failed to copy ${original_jar} to ${new_jar_dest}"
361 java-pkg_dojar "${new_jar_dest}"
362 }
363
364 # @FUNCTION: java-pkg_addcp
365 # @USAGE: <classpath>
366 # @DESCRIPTION:
367 # Add something to the package's classpath. For jars, you should use dojar,
368 # newjar, or regjar. This is typically used to add directories to the classpath.
369 # The parameters of this function are appended to JAVA_PKG_CLASSPATH
370 java-pkg_addcp() {
371 java-pkg_append_ JAVA_PKG_CLASSPATH "${@}"
372 java-pkg_do_write_
373 }
374
375 # @FUNCTION: java-pkg_doso
376 # @USAGE: <path/to/file1.so> [...]
377 # @DESCRIPTION:
378 # Installs any number of JNI libraries
379 # They will be installed into /usr/lib by default, but java-pkg_sointo
380 # can be used change this path
381 #
382 # @CODE
383 # Example:
384 # java-pkg_doso *.so
385 # @CODE
386 java-pkg_doso() {
387 debug-print-function ${FUNCNAME} $*
388
389 java-pkg_check-phase install
390
391 [[ ${#} -lt 1 ]] && die "${FUNCNAME} requires at least one argument"
392
393 java-pkg_init_paths_
394
395 local lib
396 # for each lib
397 for lib in "$@" ; do
398 # if the lib exists...
399 if [[ -e "${lib}" ]] ; then
400 # install if it isn't a symlink
401 if [[ ! -L "${lib}" ]] ; then
402 INSDESTTREE="${JAVA_PKG_LIBDEST}" \
403 INSOPTIONS="-m0755" \
404 doins "${lib}" || die "failed to install ${lib}"
405 java-pkg_append_ JAVA_PKG_LIBRARY "${JAVA_PKG_LIBDEST}"
406 debug-print "Installing ${lib} to ${JAVA_PKG_LIBDEST}"
407 # otherwise make a symlink to the symlink's origin
408 else
409 dosym "$(readlink "${lib}")" "${JAVA_PKG_LIBDEST}/${lib##*/}"
410 debug-print "${lib} is a symlink, linking accordantly"
411 fi
412 # otherwise die
413 else
414 die "${lib} does not exist"
415 fi
416 done
417
418 java-pkg_do_write_
419 }
420
421 # @FUNCTION: java-pkg_regso
422 # @USAGE: <file1.so> [...]
423 # @DESCRIPTION:
424 # Registers an already installed JNI library in package.env.
425 #
426 # @CODE
427 # Parameters:
428 # $@ - JNI libraries to register
429 #
430 # Example:
431 # java-pkg_regso *.so /path/*.so
432 # @CODE
433 java-pkg_regso() {
434 debug-print-function ${FUNCNAME} $*
435
436 java-pkg_check-phase install
437
438 [[ ${#} -lt 1 ]] && die "${FUNCNAME} requires at least one argument"
439
440 java-pkg_init_paths_
441
442 local lib target_dir
443 for lib in "$@" ; do
444 # Check the absolute path of the lib
445 if [[ -e "${lib}" ]] ; then
446 target_dir="$(java-pkg_expand_dir_ ${lib})"
447 java-pkg_append_ JAVA_PKG_LIBRARY "/${target_dir#${D}}"
448 # Check the path of the lib relative to ${D}
449 elif [[ -e "${D}${lib}" ]]; then
450 target_dir="$(java-pkg_expand_dir_ ${D}${lib})"
451 java-pkg_append_ JAVA_PKG_LIBRARY "${target_dir}"
452 else
453 die "${lib} does not exist"
454 fi
455 done
456
457 java-pkg_do_write_
458 }
459
460 # @FUNCTION: java-pkg_jarinto
461 # @USAGE: </path/to/install/jars/into>
462 # @DESCRIPTION:
463 # Changes the path jars are installed into via subsequent java-pkg_dojar calls.
464 java-pkg_jarinto() {
465 debug-print-function ${FUNCNAME} $*
466
467 JAVA_PKG_JARDEST="${1}"
468 }
469
470 # @FUNCTION: java-pkg_sointo
471 # @USAGE: </path/to/install/sofiles/into>
472 # @DESCRIPTION:
473 # Changes the path that JNI libraries are installed into via subsequent
474 # java-pkg_doso calls.
475 java-pkg_sointo() {
476 debug-print-function ${FUNCNAME} $*
477
478 JAVA_PKG_LIBDEST="${1}"
479 }
480
481 # @FUNCTION: java-pkg_dohtml
482 # @USAGE: <path/to/javadoc/documentation> [...]
483 # @DESCRIPTION:
484 # Install Javadoc HTML documentation. Usage of java-pkg_dojavadoc is preferred.
485 #
486 # @CODE
487 # java-pkg_dohtml dist/docs/
488 # @CODE
489 java-pkg_dohtml() {
490 debug-print-function ${FUNCNAME} $*
491
492 [[ ${#} -lt 1 ]] && die "At least one argument required for ${FUNCNAME}"
493
494 # from /usr/lib/portage/bin/dohtml -h
495 # -f Set list of allowed extensionless file names.
496 dohtml -f package-list "$@"
497
498 # this probably shouldn't be here but it provides
499 # a reasonable way to catch # docs for all of the
500 # old ebuilds.
501 java-pkg_recordjavadoc
502 }
503
504 # @FUNCTION: java-pkg_dojavadoc
505 # @USAGE: [--symlink destination] <path/to/javadocs/root>
506 # @DESCRIPTION:
507 # Installs javadoc documentation. This should be controlled by the doc use flag.
508 #
509 # @CODE
510 # Parameters:
511 # $1: optional --symlink creates to symlink like this for html
512 # documentation bundles.
513 # $2: - The javadoc root directory.
514 #
515 # Examples:
516 # java-pkg_dojavadoc docs/api
517 # java-pkg_dojavadoc --symlink apidocs docs/api
518 # @CODE
519 java-pkg_dojavadoc() {
520 debug-print-function ${FUNCNAME} $*
521
522 # For html documentation bundles that link to Javadoc
523 local symlink
524 if [[ ${1} = --symlink ]]; then
525 symlink=${2}
526 shift 2
527 fi
528
529 local dir="$1"
530 local dest=/usr/share/doc/${PF}/html
531
532 # QA checks
533
534 java-pkg_check-phase install
535 java-pkg_init_paths_
536
537 [[ -z "${dir}" ]] && die "Must specify a directory!"
538 [[ ! -d "${dir}" ]] && die "${dir} does not exist, or isn't a directory!"
539 if [[ ! -e "${dir}/index.html" ]]; then
540 local msg="No index.html in javadoc directory"
541 ewarn "${msg}"
542 is-java-strict && die "${msg}"
543 fi
544
545 if [[ -e ${D}/${dest}/api ]]; then
546 eerror "${dest} already exists. Will not overwrite."
547 die "${dest}"
548 fi
549
550 # Renaming to match our directory layout
551
552 local dir_to_install="${dir}"
553 if [[ "$(basename "${dir}")" != "api" ]]; then
554 dir_to_install="${T}/api"
555 # TODO use doins
556 cp -r "${dir}" "${dir_to_install}" || die "cp failed"
557 fi
558
559 # Actual installation
560
561 java-pkg_dohtml -r "${dir_to_install}"
562
563 # Let's make a symlink to the directory we have everything else under
564 dosym ${dest}/api "${JAVA_PKG_SHAREPATH}/api" || die
565
566 if [[ ${symlink} ]]; then
567 debug-print "symlinking ${dest}/{api,${symlink}}"
568 dosym ${dest}/{api,${symlink}} || die
569 fi
570 }
571
572 # @FUNCTION: java-pkg_dosrc
573 # @USAGE: <path/to/sources> [...]
574 # @DESCRIPTION:
575 # Installs a zip containing the source for a package, so it can used in
576 # from IDEs like eclipse and netbeans.
577 # Ebuild needs to DEPEND on app-arch/zip to use this. It also should be controlled by USE=source.
578 #
579 # @CODE
580 # Example:
581 # java-pkg_dosrc src/*
582 # @CODE
583
584 # TODO change so it the arguments it takes are the base directories containing
585 # source -nichoj
586 #
587 # TODO should we be able to handle multiple calls to dosrc? -nichoj
588 #
589 # TODO maybe we can take an existing zip/jar? -nichoj
590 #
591 # FIXME apparently this fails if you give it an empty directories
592 java-pkg_dosrc() {
593 debug-print-function ${FUNCNAME} $*
594
595 [ ${#} -lt 1 ] && die "At least one argument needed"
596
597 java-pkg_check-phase install
598
599 [[ ${#} -lt 1 ]] && die "At least one argument needed"
600
601 if ! [[ ${DEPEND} = *app-arch/zip* ]]; then
602 local msg="${FUNCNAME} called without app-arch/zip in DEPEND"
603 java-pkg_announce-qa-violation ${msg}
604 fi
605
606 java-pkg_init_paths_
607
608 local zip_name="${PN}-src.zip"
609 local zip_path="${T}/${zip_name}"
610 local dir
611 for dir in "${@}"; do
612 local dir_parent=$(dirname "${dir}")
613 local dir_name=$(basename "${dir}")
614 pushd ${dir_parent} > /dev/null || die "problem entering ${dir_parent}"
615 zip -q -r ${zip_path} ${dir_name} -i '*.java'
616 local result=$?
617 # 12 means zip has nothing to do
618 if [[ ${result} != 12 && ${result} != 0 ]]; then
619 die "failed to zip ${dir_name}"
620 fi
621 popd >/dev/null
622 done
623
624 # Install the zip
625 INSDESTTREE=${JAVA_PKG_SOURCESPATH} \
626 doins ${zip_path} || die "Failed to install source"
627
628 JAVA_SOURCES="${JAVA_PKG_SOURCESPATH}/${zip_name}"
629 java-pkg_do_write_
630 }
631
632 # @FUNCTION: java-pkg_dolauncher
633 # @USAGE: <filename> [options]
634 # @DESCRIPTION:
635 # Make a wrapper script to lauch/start this package
636 # If necessary, the wrapper will switch to the appropriate VM.
637 #
638 # Can be called without parameters if the package installs only one jar
639 # that has the Main-class attribute set. The wrapper will be named ${PN}.
640 #
641 # @CODE
642 # Parameters:
643 # $1 - filename of launcher to create
644 # $2 - options, as follows:
645 # --main the.main.class.to.start
646 # --jar /the/jar/too/launch.jar or just <name>.jar
647 # --java_args 'Extra arguments to pass to java'
648 # --pkg_args 'Extra arguments to pass to the package'
649 # --pwd Directory the launcher changes to before executing java
650 # -into Directory to install the launcher to, instead of /usr/bin
651 # -pre Prepend contents of this file to the launcher
652 # @CODE
653 java-pkg_dolauncher() {
654 debug-print-function ${FUNCNAME} $*
655
656 java-pkg_check-phase install
657 java-pkg_init_paths_
658
659 if [[ ${#} = 0 ]]; then
660 local name="${PN}"
661 else
662 local name="${1}"
663 shift
664 fi
665
666 # TODO rename to launcher
667 local target="${T}/${name}"
668 local var_tmp="${T}/launcher_variables_tmp"
669 local target_dir pre
670
671 # Process the other the rest of the arguments
672 while [[ -n "${1}" && -n "${2}" ]]; do
673 local var="${1}" value="${2}"
674 if [[ "${var:0:2}" == "--" ]]; then
675 local var=${var:2}
676 echo "gjl_${var}=\"${value}\"" >> "${var_tmp}"
677 local gjl_${var}="${value}"
678 elif [[ "${var}" == "-into" ]]; then
679 target_dir="${value}"
680 elif [[ "${var}" == "-pre" ]]; then
681 pre="${value}"
682 fi
683 shift 2
684 done
685
686 # Test if no --jar and --main arguments were given and
687 # in that case check if the package only installs one jar
688 # and use that jar.
689 if [[ -z "${gjl_jar}" && -z "${gjl_main}" ]]; then
690 local cp="${JAVA_PKG_CLASSPATH}"
691 if [[ "${cp/:}" = "${cp}" && "${cp%.jar}" != "${cp}" ]]; then
692 echo "gjl_jar=\"${JAVA_PKG_CLASSPATH}\"" >> "${var_tmp}"
693 else
694 local msg="Not enough information to create a launcher given."
695 msg="${msg} Please give --jar or --main argument to ${FUNCNAME}."
696 die "${msg}"
697 fi
698 fi
699
700 # Write the actual script
701 echo "#!/bin/bash" > "${target}"
702 if [[ -n "${pre}" ]]; then
703 if [[ -f "${pre}" ]]; then
704 cat "${pre}" >> "${target}"
705 else
706 die "-pre specified file '${pre}' does not exist"
707 fi
708 fi
709 echo "gjl_package=${JAVA_PKG_NAME}" >> "${target}"
710 cat "${var_tmp}" >> "${target}"
711 rm -f "${var_tmp}"
712 echo "source /usr/share/java-config-2/launcher/launcher.bash" >> "${target}"
713
714 if [[ -n "${target_dir}" ]]; then
715 DESTTREE="${target_dir}" dobin "${target}"
716 local ret=$?
717 return ${ret}
718 else
719 dobin "${target}"
720 fi
721 }
722
723 # @FUNCTION: java-pkg_dowar
724 # @DESCRIPTION:
725 # Install war files.
726 # TODO document
727 java-pkg_dowar() {
728 debug-print-function ${FUNCNAME} $*
729
730 # Check for arguments
731 [[ ${#} -lt 1 ]] && die "At least one argument needed"
732 java-pkg_check-phase install
733
734 java-pkg_init_paths_
735
736 local war
737 for war in $* ; do
738 local warpath
739 # TODO evaluate if we want to handle symlinks differently -nichoj
740 # Check for symlink
741 if [[ -L "${war}" ]] ; then
742 cp "${war}" "${T}"
743 warpath="${T}$(basename "${war}")"
744 # Check for directory
745 # TODO evaluate if we want to handle directories differently -nichoj
746 elif [[ -d "${war}" ]] ; then
747 echo "dowar: warning, skipping directory ${war}"
748 continue
749 else
750 warpath="${war}"
751 fi
752
753 # Install those files like you mean it
754 INSOPTIONS="-m 0644" \
755 INSDESTTREE=${JAVA_PKG_WARDEST} \
756 doins ${warpath}
757 done
758 }
759
760 # @FUNCTION: java-pkg_recordjavadoc
761 # @INTERNAL
762 # @DESCRIPTION:
763 # Scan for JavaDocs, and record their existence in the package.env file
764
765 # TODO make sure this in the proper section
766 java-pkg_recordjavadoc()
767 {
768 debug-print-function ${FUNCNAME} $*
769 # the find statement is important
770 # as some packages include multiple trees of javadoc
771 JAVADOC_PATH="$(find ${D}/usr/share/doc/ -name allclasses-frame.html -printf '%h:')"
772 # remove $D - TODO: check this is ok with all cases of the above
773 JAVADOC_PATH="${JAVADOC_PATH//${D}}"
774 if [[ -n "${JAVADOC_PATH}" ]] ; then
775 debug-print "javadocs found in ${JAVADOC_PATH%:}"
776 java-pkg_do_write_
777 else
778 debug-print "No javadocs found"
779 fi
780 }
781
782
783 # @FUNCTION: java-pkg_jar-from
784 # @USAGE: [--build-only] [--with-dependencies] [--virtual] [--into dir] <package> [<package.jar>] [<destination.jar>]
785 # @DESCRIPTION:
786 # Makes a symlink to a jar from a certain package
787 # A lot of java packages include dependencies in a lib/ directory
788 # You can use this function to replace these bundled dependencies.
789 # The dependency is recorded into package.env DEPEND line, unless "--build-only"
790 # is passed as the very first argument, for jars that have to be present only
791 # at build time and are not needed on runtime (junit testing etc).
792 #
793 # @CODE
794 # Example: get all jars from xerces slot 2
795 # java-pkg_jar-from xerces-2
796 #
797 # Example: get a specific jar from xerces slot 2
798 # java-pkg_jar-from xerces-2 xml-apis.jar
799 #
800 # Example: get a specific jar from xerces slot 2, and name it diffrently
801 # java-pkg_jar-from xerces-2 xml-apis.jar xml.jar
802 #
803 # Example: get junit.jar which is needed only for building
804 # java-pkg_jar-from --build-only junit junit.jar
805 # @CODE
806 #
807 # @CODE
808 # Parameters
809 # --build-only - makes the jar(s) not added into package.env DEPEND line.
810 # (assumed automatically when called inside src_test)
811 # --with-dependencies - get jars also from requested package's dependencies
812 # transitively.
813 # --virtual - Packages passed to this function are to be handled as virtuals
814 # and will not have individual jar dependencies recorded.
815 # --into $dir - symlink jar(s) into $dir (must exist) instead of .
816 # $1 - Package to get jars from, or comma-separated list of packages in
817 # case other parameters are not used.
818 # $2 - jar from package. If not specified, all jars will be used.
819 # $3 - When a single jar is specified, destination filename of the
820 # symlink. Defaults to the name of the jar.
821 # @CODE
822
823 # TODO could probably be cleaned up a little
824 java-pkg_jar-from() {
825 debug-print-function ${FUNCNAME} $*
826
827 local build_only=""
828 local destdir="."
829 local deep=""
830 local virtual=""
831 local record_jar=""
832
833 [[ "${EBUILD_PHASE}" == "test" ]] && build_only="build"
834
835 while [[ "${1}" == --* ]]; do
836 if [[ "${1}" = "--build-only" ]]; then
837 build_only="build"
838 elif [[ "${1}" = "--with-dependencies" ]]; then
839 deep="--with-dependencies"
840 elif [[ "${1}" = "--virtual" ]]; then
841 virtual="true"
842 elif [[ "${1}" = "--into" ]]; then
843 destdir="${2}"
844 shift
845 else
846 die "java-pkg_jar-from called with unknown parameter: ${1}"
847 fi
848 shift
849 done
850
851 local target_pkg="${1}" target_jar="${2}" destjar="${3}"
852
853 [[ -z ${target_pkg} ]] && die "Must specify a package"
854
855 if [[ "${EAPI}" == "1" ]]; then
856 target_pkg="${target_pkg//:/-}"
857 fi
858
859 # default destjar to the target jar
860 [[ -z "${destjar}" ]] && destjar="${target_jar}"
861
862 local error_msg="There was a problem getting the classpath for ${target_pkg}."
863 local classpath
864 classpath="$(java-config ${deep} --classpath=${target_pkg})"
865 [[ $? != 0 ]] && die ${error_msg}
866
867 # When we have commas this functions is called to bring jars from multiple
868 # packages. This affects recording of dependencencies performed later
869 # which expects one package only, so we do it here.
870 if [[ ${target_pkg} = *,* ]]; then
871 for pkg in ${target_pkg//,/ }; do
872 java-pkg_ensure-dep "${build_only}" "${pkg}"
873 [[ -z "${build_only}" ]] && java-pkg_record-jar_ "${pkg}"
874 done
875 # setting this disables further record-jar_ calls later
876 record_jar="true"
877 else
878 java-pkg_ensure-dep "${build_only}" "${target_pkg}"
879 fi
880
881 # Record the entire virtual as a dependency so that
882 # no jars are missed.
883 if [[ -z "${build_only}" && -n "${virtual}" ]]; then
884 java-pkg_record-jar_ "${target_pkg}"
885 # setting this disables further record-jars_ calls later
886 record_jar="true"
887 fi
888
889 pushd ${destdir} > /dev/null \
890 || die "failed to change directory to ${destdir}"
891
892 local jar
893 for jar in ${classpath//:/ }; do
894 local jar_name=$(basename "${jar}")
895 if [[ ! -f "${jar}" ]] ; then
896 debug-print "${jar} from ${target_pkg} does not exist"
897 die "Installation problems with jars in ${target_pkg} - is it installed?"
898 fi
899 # If no specific target jar was indicated, link it
900 if [[ -z "${target_jar}" ]] ; then
901 [[ -f "${target_jar}" ]] && rm "${target_jar}"
902 ln -snf "${jar}" \
903 || die "Failed to make symlink from ${jar} to ${jar_name}"
904 if [[ -z "${record_jar}" ]]; then
905 if [[ -z "${build_only}" ]]; then
906 java-pkg_record-jar_ "${target_pkg}" "${jar}"
907 else
908 java-pkg_record-jar_ --build-only "${target_pkg}" "${jar}"
909 fi
910 fi
911 # otherwise, if the current jar is the target jar, link it
912 elif [[ "${jar_name}" == "${target_jar}" ]] ; then
913 [[ -f "${destjar}" ]] && rm "${destjar}"
914 ln -snf "${jar}" "${destjar}" \
915 || die "Failed to make symlink from ${jar} to ${destjar}"
916 if [[ -z "${record_jar}" ]]; then
917 if [[ -z "${build_only}" ]]; then
918 java-pkg_record-jar_ "${target_pkg}" "${jar}"
919 else
920 java-pkg_record-jar_ --build-only "${target_pkg}" "${jar}"
921 fi
922 fi
923 popd > /dev/null
924 return 0
925 fi
926 done
927 popd > /dev/null
928 # if no target was specified, we're ok
929 if [[ -z "${target_jar}" ]] ; then
930 return 0
931 # otherwise, die bitterly
932 else
933 die "Failed to find ${target_jar:-jar} in ${target_pkg}"
934 fi
935 }
936
937 # @FUNCTION: java-pkg_jarfrom
938 # @DESCRIPTION:
939 # See java-pkg_jar-from
940 java-pkg_jarfrom() {
941 java-pkg_jar-from "$@"
942 }
943
944 # @FUNCTION: java-pkg_getjars
945 # @USAGE: [--build-only] [--with-dependencies] <package1>[,<package2>...]
946 # @DESCRIPTION:
947 # Get the classpath provided by any number of packages
948 # Among other things, this can be passed to 'javac -classpath' or 'ant -lib'.
949 # The providing packages are recorded as dependencies into package.env DEPEND
950 # line, unless "--build-only" is passed as the very first argument, for jars
951 # that have to be present only at build time and are not needed on runtime
952 # (junit testing etc).
953 #
954 # @CODE
955 # Example: Get the classpath for xerces-2 and xalan,
956 # java-pkg_getjars xerces-2,xalan
957 #
958 # Example Return:
959 # /usr/share/xerces-2/lib/xml-apis.jar:/usr/share/xerces-2/lib/xmlParserAPIs.jar:/usr/share/xalan/lib/xalan.jar
960 #
961 #
962 # Parameters:
963 # --build-only - makes the jar(s) not added into package.env DEPEND line.
964 # (assumed automatically when called inside src_test)
965 # --with-dependencies - get jars also from requested package's dependencies
966 # transitively.
967 # $1 - list of packages to get jars from
968 # (passed to java-config --classpath)
969 # @CODE
970 java-pkg_getjars() {
971 debug-print-function ${FUNCNAME} $*
972
973 local build_only=""
974 local deep=""
975
976 [[ "${EBUILD_PHASE}" == "test" ]] && build_only="build"
977
978 while [[ "${1}" == --* ]]; do
979 if [[ "${1}" = "--build-only" ]]; then
980 build_only="build"
981 elif [[ "${1}" = "--with-dependencies" ]]; then
982 deep="--with-dependencies"
983 else
984 die "java-pkg_jar-from called with unknown parameter: ${1}"
985 fi
986 shift
987 done
988
989 [[ ${#} -ne 1 ]] && die "${FUNCNAME} takes only one argument besides --*"
990
991
992 local pkgs="${1}"
993
994 if [[ "${EAPI}" == "1" ]]; then
995 pkgs="${pkgs//:/-}"
996 fi
997
998 jars="$(java-config ${deep} --classpath=${pkgs})"
999 [[ $? != 0 ]] && die "java-config --classpath=${pkgs} failed"
1000 debug-print "${pkgs}:${jars}"
1001
1002 for pkg in ${pkgs//,/ }; do
1003 java-pkg_ensure-dep "${build_only}" "${pkg}"
1004 done
1005
1006 for pkg in ${pkgs//,/ }; do
1007 if [[ -z "${build_only}" ]]; then
1008 java-pkg_record-jar_ "${pkg}"
1009 else
1010 java-pkg_record-jar_ --build-only "${pkg}"
1011 fi
1012 done
1013
1014 echo "${jars}"
1015 }
1016
1017 # @FUNCTION: java-pkg_getjar
1018 # @USAGE: [--build-only] [--virtual] <package> <jarfile>
1019 # @DESCRIPTION:
1020 # Get the complete path of a single jar from a package
1021 # The providing package is recorded as runtime dependency into package.env
1022 # DEPEND line, unless "--build-only" is passed as the very first argument, for
1023 # jars that have to be present only at build time and are not needed on runtime
1024 # (junit testing etc).
1025 #
1026 # @CODE
1027 # Example:
1028 # java-pkg_getjar xerces-2 xml-apis.jar
1029 # returns
1030 # /usr/share/xerces-2/lib/xml-apis.jar
1031 #
1032 # Parameters:
1033 # --build-only - makes the jar not added into package.env DEPEND line.
1034 # --virtual - Packages passed to this function are to be handled as virtuals
1035 # and will not have individual jar dependencies recorded.
1036 # $1 - package to use
1037 # $2 - jar to get
1038 # @CODE
1039 java-pkg_getjar() {
1040 debug-print-function ${FUNCNAME} $*
1041
1042 local build_only=""
1043 local virtual=""
1044 local record_jar=""
1045
1046 [[ "${EBUILD_PHASE}" == "test" ]] && build_only="build"
1047
1048 while [[ "${1}" == --* ]]; do
1049 if [[ "${1}" = "--build-only" ]]; then
1050 build_only="build"
1051 elif [[ "${1}" == "--virtual" ]]; then
1052 virtual="true"
1053 else
1054 die "java-pkg_getjar called with unknown parameter: ${1}"
1055 fi
1056 shift
1057 done
1058
1059 [[ ${#} -ne 2 ]] && die "${FUNCNAME} takes only two arguments besides --*"
1060
1061 local pkg="${1}" target_jar="${2}" jar
1062
1063 if [[ "${EAPI}" == "1" ]]; then
1064 pkg="${pkg//:/-}"
1065 fi
1066
1067 [[ -z ${pkg} ]] && die "Must specify package to get a jar from"
1068 [[ -z ${target_jar} ]] && die "Must specify jar to get"
1069
1070 local error_msg="Could not find classpath for ${pkg}. Are you sure its installed?"
1071 local classpath
1072 classpath=$(java-config --classpath=${pkg})
1073 [[ $? != 0 ]] && die ${error_msg}
1074
1075 java-pkg_ensure-dep "${build_only}" "${pkg}"
1076
1077 # Record the package(Virtual) as a dependency and then set build_only
1078 # So that individual jars are not recorded.
1079 if [[ -n "${virtual}" ]]; then
1080 if [[ -z "${build_only}" ]]; then
1081 java-pkg_record-jar_ "${pkg}"
1082 else
1083 java-pkg_record-jar_ --build-only "${pkg}"
1084 fi
1085 record_jar="true"
1086 fi
1087
1088 for jar in ${classpath//:/ }; do
1089 if [[ ! -f "${jar}" ]] ; then
1090 die "Installation problem with jar ${jar} in ${pkg} - is it installed?"
1091 fi
1092
1093 if [[ "$(basename ${jar})" == "${target_jar}" ]] ; then
1094 # Only record jars that aren't build-only
1095 if [[ -z "${record_jar}" ]]; then
1096 if [[ -z "${build_only}" ]]; then
1097 java-pkg_record-jar_ "${pkg}" "${jar}"
1098 else
1099 java-pkg_record-jar_ --build-only "${pkg}" "${jar}"
1100 fi
1101 fi
1102 echo "${jar}"
1103 return 0
1104 fi
1105 done
1106
1107 die "Could not find ${target_jar} in ${pkg}"
1108 return 1
1109 }
1110
1111 # @FUNCTION: java-pkg_register-dependency
1112 # @USAGE: <package>[,<package2>...] [<jarfile>]
1113 # @DESCRIPTION:
1114 # Registers runtime dependency on a package, list of packages, or a single jar
1115 # from a package, into package.env DEPEND line. Can only be called in
1116 # src_install phase.
1117 # Intended for binary packages where you don't need to symlink the jars or get
1118 # their classpath during build. As such, the dependencies only need to be
1119 # specified in ebuild's RDEPEND, and should be omitted in DEPEND.
1120 #
1121 # @CODE
1122 # Parameters:
1123 # $1 - comma-separated list of packages, or a single package
1124 # $2 - if param $1 is a single package, optionally specify the jar
1125 # to depend on
1126 #
1127 # Examples:
1128 # Record the dependency on whole xerces-2 and xalan,
1129 # java-pkg_register-dependency xerces-2,xalan
1130 #
1131 # Record the dependency on ant.jar from ant-core
1132 # java-pkg_register-dependency ant-core ant.jar
1133 # @CODE
1134 #
1135 # Note: Passing both list of packages as the first parameter AND specifying the
1136 # jar as the second is not allowed and will cause the function to die. We assume
1137 # that there's more chance one passes such combination as a mistake, than that
1138 # there are more packages providing identically named jar without class
1139 # collisions.
1140 java-pkg_register-dependency() {
1141 debug-print-function ${FUNCNAME} $*
1142
1143 java-pkg_check-phase install
1144
1145 [[ ${#} -gt 2 ]] && die "${FUNCNAME} takes at most two arguments"
1146
1147 local pkgs="${1}"
1148 local jar="${2}"
1149
1150 [[ -z "${pkgs}" ]] && die "${FUNCNAME} called with no package(s) specified"
1151
1152 if [[ "${EAPI}" == "1" ]]; then
1153 pkgs="${pkgs//:/-}"
1154 fi
1155
1156 if [[ -z "${jar}" ]]; then
1157 for pkg in ${pkgs//,/ }; do
1158 java-pkg_ensure-dep runtime "${pkg}"
1159 java-pkg_record-jar_ "${pkg}"
1160 done
1161 else
1162 [[ ${pkgs} == *,* ]] && \
1163 die "${FUNCNAME} called with both package list and jar name"
1164 java-pkg_ensure-dep runtime "${pkgs}"
1165 java-pkg_record-jar_ "${pkgs}" "${jar}"
1166 fi
1167
1168 java-pkg_do_write_
1169 }
1170
1171 # @FUNCTION: java-pkg_register-optional-dependency
1172 # @USAGE: <package>[,<package2>...] [<jarfile>]
1173 # @DESCRIPTION:
1174 # Registers optional runtime dependency on a package, list of packages, or a
1175 # single jar from a package, into package.env OPTIONAL_DEPEND line. Can only be
1176 # called in src_install phase.
1177 # Intended for packages that can use other packages when those are in classpath.
1178 # Will be put on classpath by launcher if they are installed. Typical case is
1179 # JDBC implementations for various databases. It's better than having USE flag
1180 # for each implementation triggering hard dependency.
1181 #
1182 # @CODE
1183 # Parameters:
1184 # $1 - comma-separated list of packages, or a single package
1185 # $2 - if param $1 is a single package, optionally specify the jar to depend on
1186 #
1187 # Example:
1188 # Record the optional dependency on some jdbc providers
1189 # java-pkg_register-optional-dependency jdbc-jaybird,jtds-1.2,jdbc-mysql
1190 # @CODE
1191 #
1192 # Note: Passing both list of packages as the first parameter AND specifying the
1193 # jar as the second is not allowed and will cause the function to die. We assume
1194 # that there's more chance one passes such combination as a mistake, than that
1195 # there are more packages providing identically named jar without class
1196 # collisions.
1197 java-pkg_register-optional-dependency() {
1198 debug-print-function ${FUNCNAME} $*
1199
1200 java-pkg_check-phase install
1201
1202 [[ ${#} -gt 2 ]] && die "${FUNCNAME} takes at most two arguments"
1203
1204 local pkgs="${1}"
1205 local jar="${2}"
1206
1207 [[ -z "${pkgs}" ]] && die "${FUNCNAME} called with no package(s) specified"
1208
1209 if [[ "${EAPI}" == "1" ]]; then
1210 pkgs="${pkgs//:/-}"
1211 fi
1212
1213 if [[ -z "${jar}" ]]; then
1214 for pkg in ${pkgs//,/ }; do
1215 java-pkg_record-jar_ --optional "${pkg}"
1216 done
1217 else
1218 [[ ${pkgs} == *,* ]] && \
1219 die "${FUNCNAME} called with both package list and jar name"
1220 java-pkg_record-jar_ --optional "${pkgs}" "${jar}"
1221 fi
1222
1223 java-pkg_do_write_
1224 }
1225
1226 # @FUNCTION: java-pkg_register-environment-variable
1227 # @USAGE: <name> <value>
1228 # @DESCRIPTION:
1229 # Register an arbitrary environment variable into package.env. The gjl launcher
1230 # for this package or any package depending on this will export it into
1231 # environement before executing java command.
1232 # Must only be called in src_install phase.
1233 JAVA_PKG_EXTRA_ENV="${T}/java-pkg-extra-env"
1234 JAVA_PKG_EXTRA_ENV_VARS=""
1235 java-pkg_register-environment-variable() {
1236 debug-print-function ${FUNCNAME} $*
1237
1238 java-pkg_check-phase install
1239
1240 [[ ${#} != 2 ]] && die "${FUNCNAME} takes two arguments"
1241
1242 echo "${1}=\"${2}\"" >> ${JAVA_PKG_EXTRA_ENV}
1243 JAVA_PKG_EXTRA_ENV_VARS="${JAVA_PKG_EXTRA_ENV_VARS} ${1}"
1244
1245 java-pkg_do_write_
1246 }
1247
1248 # @FUNCTION: java-pkg_get-bootclasspath
1249 # @USAGE: <version>
1250 # @DESCRIPTION:
1251 # Returns classpath of a given bootclasspath-providing package version.
1252 #
1253 # @param $1 - the version of bootclasspath (e.g. 1.5), 'auto' for bootclasspath
1254 # of the current JDK
1255 java-pkg_get-bootclasspath() {
1256 local version="${1}"
1257
1258 local bcp
1259 case "${version}" in
1260 auto)
1261 bcp="$(java-config -g BOOTCLASSPATH)"
1262 ;;
1263 1.5)
1264 bcp="$(java-pkg_getjars --build-only gnu-classpath-0.98)"
1265 ;;
1266 *)
1267 eerror "unknown parameter of java-pkg_get-bootclasspath"
1268 die "unknown parameter of java-pkg_get-bootclasspath"
1269 ;;
1270 esac
1271
1272 echo "${bcp}"
1273 }
1274
1275
1276 # This function reads stdin, and based on that input, figures out how to
1277 # populate jars from the filesystem.
1278 # Need to figure out a good way of making use of this, ie be able to use a
1279 # string that was built instead of stdin
1280 # NOTE: this isn't quite ready for primetime.
1281 #java-pkg_populate-jars() {
1282 # local line
1283 #
1284 # read line
1285 # while [[ -n "${line}" ]]; do
1286 # # Ignore comments
1287 # [[ ${line%%#*} == "" ]] && continue
1288 #
1289 # # get rid of any spaces
1290 # line="${line// /}"
1291 #
1292 # # format: path=jarinfo
1293 # local path=${line%%=*}
1294 # local jarinfo=${line##*=}
1295 #
1296 # # format: jar@package
1297 # local jar=${jarinfo%%@*}.jar
1298 # local package=${jarinfo##*@}
1299 # if [[ -n ${replace_only} ]]; then
1300 # [[ ! -f $path ]] && die "No jar exists at ${path}"
1301 # fi
1302 # if [[ -n ${create_parent} ]]; then
1303 # local parent=$(dirname ${path})
1304 # mkdir -p "${parent}"
1305 # fi
1306 # java-pkg_jar-from "${package}" "${jar}" "${path}"
1307 #
1308 # read line
1309 # done
1310 #}
1311
1312 # @FUNCTION: java-pkg_find-normal-jars
1313 # @USAGE: [<path/to/directory>]
1314 # @DESCRIPTION:
1315 # Find the files with suffix .jar file in the given directory (default: $WORKDIR)
1316 java-pkg_find-normal-jars() {
1317 local dir=$1
1318 [[ "${dir}" ]] || dir="${WORKDIR}"
1319 local found
1320 for jar in $(find "${dir}" -name "*.jar" -type f); do
1321 echo "${jar}"
1322 found="true"
1323 done
1324 [[ "${found}" ]]
1325 return $?
1326 }
1327
1328 # @FUNCTION: java-pkg_ensure-no-bundled-jars
1329 # @DESCRIPTION:
1330 # Try to locate bundled jar files in ${WORKDIR} and die if found.
1331 # This function should be called after WORKDIR has been populated with symlink
1332 # to system jar files or bundled jars removed.
1333 java-pkg_ensure-no-bundled-jars() {
1334 debug-print-function ${FUNCNAME} $*
1335
1336 local bundled_jars=$(java-pkg_find-normal-jars)
1337 if [[ -n ${bundled_jars} ]]; then
1338 echo "Bundled jars found:"
1339 local jar
1340 for jar in ${bundled_jars}; do
1341 echo $(pwd)${jar/./}
1342 done
1343 die "Bundled jars found!"
1344 fi
1345 }
1346
1347 # @FUNCTION: java-pkg_ensure-vm-version-sufficient
1348 # @INTERNAL
1349 # @DESCRIPTION:
1350 # Checks if we have a sufficient VM and dies if we don't.
1351 java-pkg_ensure-vm-version-sufficient() {
1352 debug-print-function ${FUNCNAME} $*
1353
1354 if ! java-pkg_is-vm-version-sufficient; then
1355 debug-print "VM is not suffient"
1356 eerror "Current Java VM cannot build this package"
1357 einfo "Please use java-config -S to set the correct one"
1358 die "Active Java VM cannot build this package"
1359 fi
1360 }
1361
1362 # @FUNCTION: java-pkg_is-vm-version-sufficient
1363 # @INTERNAL
1364 # @DESCRIPTION:
1365 # @RETURN: zero - VM is sufficient; non-zero - VM is not sufficient
1366 java-pkg_is-vm-version-sufficient() {
1367 debug-print-function ${FUNCNAME} $*
1368
1369 depend-java-query --is-sufficient "${DEPEND}" > /dev/null
1370 return $?
1371 }
1372
1373 # @FUNCTION: java-pkg_ensure-vm-version-eq
1374 # @INTERNAL
1375 # @DESCRIPTION:
1376 # Die if the current VM is not equal to the argument passed.
1377 #
1378 # @param $@ - Desired VM version to ensure
1379 java-pkg_ensure-vm-version-eq() {
1380 debug-print-function ${FUNCNAME} $*
1381
1382 if ! java-pkg_is-vm-version-eq $@ ; then
1383 debug-print "VM is not suffient"
1384 eerror "This package requires a Java VM version = $@"
1385 einfo "Please use java-config -S to set the correct one"
1386 die "Active Java VM too old"
1387 fi
1388 }
1389
1390 # @FUNCTION: java-pkg_is-vm-version-eq
1391 # @USAGE: <version>
1392 # @INTERNAL
1393 # @RETURN: zero - VM versions are equal; non-zero - VM version are not equal
1394 java-pkg_is-vm-version-eq() {
1395 debug-print-function ${FUNCNAME} $*
1396
1397 local needed_version="$@"
1398
1399 [[ -z "${needed_version}" ]] && die "need an argument"
1400
1401 local vm_version="$(java-pkg_get-vm-version)"
1402
1403 vm_version="$(get_version_component_range 1-2 "${vm_version}")"
1404 needed_version="$(get_version_component_range 1-2 "${needed_version}")"
1405
1406 if [[ -z "${vm_version}" ]]; then
1407 debug-print "Could not get JDK version from DEPEND"
1408 return 1
1409 else
1410 if [[ "${vm_version}" == "${needed_version}" ]]; then
1411 debug-print "Detected a JDK(${vm_version}) = ${needed_version}"
1412 return 0
1413 else
1414 debug-print "Detected a JDK(${vm_version}) != ${needed_version}"
1415 return 1
1416 fi
1417 fi
1418 }
1419
1420 # @FUNCTION: java-pkg_ensure-vm-version-ge
1421 # @INTERNAL
1422 # @DESCRIPTION:
1423 # Die if the current VM is not greater than the desired version
1424 #
1425 # @param $@ - VM version to compare current to
1426 java-pkg_ensure-vm-version-ge() {
1427 debug-print-function ${FUNCNAME} $*
1428
1429 if ! java-pkg_is-vm-version-ge "$@" ; then
1430 debug-print "vm is not suffient"
1431 eerror "This package requires a Java VM version >= $@"
1432 einfo "Please use java-config -S to set the correct one"
1433 die "Active Java VM too old"
1434 fi
1435 }
1436
1437 # @FUNCTION: java-pkg_is-vm-version-ge
1438 # @INTERNAL
1439 # @DESCRIPTION:
1440 # @CODE
1441 # Parameters:
1442 # $@ - VM version to compare current VM to
1443 # @CODE
1444 # @RETURN: zero - current VM version is greater than checked version;
1445 # non-zero - current VM version is not greater than checked version
1446 java-pkg_is-vm-version-ge() {
1447 debug-print-function ${FUNCNAME} $*
1448
1449 local needed_version=$@
1450 local vm_version=$(java-pkg_get-vm-version)
1451 if [[ -z "${vm_version}" ]]; then
1452 debug-print "Could not get JDK version from DEPEND"
1453 return 1
1454 else
1455 if version_is_at_least "${needed_version}" "${vm_version}"; then
1456 debug-print "Detected a JDK(${vm_version}) >= ${needed_version}"
1457 return 0
1458 else
1459 debug-print "Detected a JDK(${vm_version}) < ${needed_version}"
1460 return 1
1461 fi
1462 fi
1463 }
1464
1465 java-pkg_set-current-vm() {
1466 export GENTOO_VM=${1}
1467 }
1468
1469 java-pkg_get-current-vm() {
1470 echo ${GENTOO_VM}
1471 }
1472
1473 java-pkg_current-vm-matches() {
1474 has $(java-pkg_get-current-vm) ${@}
1475 return $?
1476 }
1477
1478 # @FUNCTION: java-pkg_get-source
1479 # @DESCRIPTION:
1480 # Determines what source version should be used, for passing to -source.
1481 # Unless you want to break things you probably shouldn't set _WANT_SOURCE
1482 #
1483 # @RETURN: string - Either the lowest possible source, or JAVA_PKG_WANT_SOURCE
1484 java-pkg_get-source() {
1485 echo ${JAVA_PKG_WANT_SOURCE:-$(depend-java-query --get-lowest "${DEPEND} ${RDEPEND}")}
1486 }
1487
1488 # @FUNCTION: java-pkg_get-target
1489 # @DESCRIPTION:
1490 # Determines what target version should be used, for passing to -target.
1491 # If you don't care about lower versions, you can set _WANT_TARGET to the
1492 # version of your JDK.
1493 #
1494 # @RETURN: string - Either the lowest possible target, or JAVA_PKG_WANT_TARGET
1495 java-pkg_get-target() {
1496 echo ${JAVA_PKG_WANT_TARGET:-$(depend-java-query --get-lowest "${DEPEND} ${RDEPEND}")}
1497 }
1498
1499 # @FUNCTION: java-pkg_get-javac
1500 # @DESCRIPTION:
1501 # Returns the compiler executable
1502 java-pkg_get-javac() {
1503 debug-print-function ${FUNCNAME} $*
1504
1505
1506 local compiler="${GENTOO_COMPILER}"
1507
1508 local compiler_executable
1509 if [[ "${compiler}" = "javac" ]]; then
1510 # nothing fancy needs to be done for javac
1511 compiler_executable="javac"
1512 else
1513 # for everything else, try to determine from an env file
1514
1515 local compiler_env="/usr/share/java-config-2/compiler/${compiler}"
1516 if [[ -f ${compiler_env} ]]; then
1517 local old_javac=${JAVAC}
1518 unset JAVAC
1519 # try to get value of JAVAC
1520 compiler_executable="$(source ${compiler_env} 1>/dev/null 2>&1; echo ${JAVAC})"
1521 export JAVAC=${old_javac}
1522
1523 if [[ -z ${compiler_executable} ]]; then
1524 echo "JAVAC is empty or undefined in ${compiler_env}"
1525 return 1
1526 fi
1527
1528 # check that it's executable
1529 if [[ ! -x ${compiler_executable} ]]; then
1530 echo "${compiler_executable} doesn't exist, or isn't executable"
1531 return 1
1532 fi
1533 else
1534 echo "Could not find environment file for ${compiler}"
1535 return 1
1536 fi
1537 fi
1538 echo ${compiler_executable}
1539 }
1540
1541 # @FUNCTION: java-pkg_javac-args
1542 # @DESCRIPTION:
1543 # If an ebuild uses javac directly, instead of using ejavac, it should call this
1544 # to know what -source/-target to use.
1545 #
1546 # @RETURN: string - arguments to pass to javac, complete with -target and -source
1547 java-pkg_javac-args() {
1548 debug-print-function ${FUNCNAME} $*
1549
1550 local want_source="$(java-pkg_get-source)"
1551 local want_target="$(java-pkg_get-target)"
1552
1553 local source_str="-source ${want_source}"
1554 local target_str="-target ${want_target}"
1555
1556 debug-print "want source: ${want_source}"
1557 debug-print "want target: ${want_target}"
1558
1559 if [[ -z "${want_source}" || -z "${want_target}" ]]; then
1560 debug-print "could not find valid -source/-target values for javac"
1561 echo "Could not find valid -source/-target values for javac"
1562 return 1
1563 else
1564 if java-pkg_is-vm-version-ge "1.4"; then
1565 echo "${source_str} ${target_str}"
1566 else
1567 echo "${target_str}"
1568 fi
1569 fi
1570 }
1571
1572 # @FUNCTION: java-pkg_get-jni-cflags
1573 # @DESCRIPTION:
1574 # Echos the CFLAGS for JNI compilations
1575 java-pkg_get-jni-cflags() {
1576 local flags="-I${JAVA_HOME}/include"
1577
1578 local platform="linux"
1579 use elibc_FreeBSD && platform="freebsd"
1580
1581 # TODO do a check that the directories are valid
1582 flags="${flags} -I${JAVA_HOME}/include/${platform}"
1583
1584 echo ${flags}
1585 }
1586
1587 java-pkg_ensure-gcj() {
1588 # was enforcing sys-devel/gcc[gcj]
1589 die "${FUNCNAME} was removed. Use use-deps available as of EAPI 2 instead. #261562"
1590 }
1591
1592 java-pkg_ensure-test() {
1593 # was enforcing USE=test if FEATURES=test
1594 die "${FUNCNAME} was removed. Package mangers handle this already. #278965"
1595 }
1596
1597 # @FUNCTION: java-pkg_register-ant-task
1598 # @USAGE: [--version x.y] [<name>]
1599 # @DESCRIPTION:
1600 # Register this package as ant task, so that ant will load it when no specific
1601 # ANT_TASKS are specified. Note that even without this registering, all packages
1602 # specified in ANT_TASKS will be loaded. Mostly used by the actual ant tasks
1603 # packages, but can be also used by other ebuilds that used to symlink their
1604 # .jar into /usr/share/ant-core/lib to get autoloaded, for backwards
1605 # compatibility.
1606 #
1607 # @CODE
1608 # Parameters
1609 # --version x.y Register only for ant version x.y (otherwise for any ant
1610 # version). Used by the ant-* packages to prevent loading of mismatched
1611 # ant-core ant tasks after core was updated, before the tasks are updated,
1612 # without a need for blockers.
1613 # $1 Name to register as. Defaults to JAVA_PKG_NAME ($PN[-$SLOT])
1614 # @CODE
1615 java-pkg_register-ant-task() {
1616 local TASKS_DIR="tasks"
1617
1618 # check for --version x.y parameters
1619 while [[ -n "${1}" && -n "${2}" ]]; do
1620 local var="${1#--}"
1621 local val="${2}"
1622 if [[ "${var}" == "version" ]]; then
1623 TASKS_DIR="tasks-${val}"
1624 else
1625 die "Unknown parameter passed to java-pkg_register-ant-tasks: ${1} ${2}"
1626 fi
1627 shift 2
1628 done
1629
1630 local TASK_NAME="${1:-${JAVA_PKG_NAME}}"
1631
1632 dodir /usr/share/ant/${TASKS_DIR}
1633 touch "${D}/usr/share/ant/${TASKS_DIR}/${TASK_NAME}"
1634 }
1635
1636 # @FUNCTION: java-pkg_ant-tasks-depend
1637 # @INTERNAL
1638 # @DESCRIPTION:
1639 # Translates the WANT_ANT_TASKS variable into valid dependencies.
1640 java-pkg_ant-tasks-depend() {
1641 debug-print-function ${FUNCNAME} ${WANT_ANT_TASKS}
1642
1643 if [[ -n "${WANT_ANT_TASKS}" ]]; then
1644 local DEP=""
1645 for i in ${WANT_ANT_TASKS}
1646 do
1647 if [[ ${i} = ant-* ]]; then
1648 DEP="${DEP}dev-java/${i} "
1649 elif [[ ${i} = */*:* ]]; then
1650 DEP="${DEP}${i} "
1651 else
1652 echo "Invalid atom in WANT_ANT_TASKS: ${i}"
1653 return 1
1654 fi
1655 done
1656 echo ${DEP}
1657 return 0
1658 else
1659 return 0
1660 fi
1661 }
1662
1663
1664 # @FUNCTION: ejunit_
1665 # @INTERNAL
1666 # @DESCRIPTION:
1667 # Internal Junit wrapper function. Makes it easier to run the tests and checks for
1668 # dev-java/junit in DEPEND. Launches the tests using junit.textui.TestRunner.
1669 # @CODE
1670 # Parameters:
1671 # $1 - junit package (junit or junit-4)
1672 # $2 - -cp or -classpath
1673 # $3 - classpath; junit and recorded dependencies get appended
1674 # $@ - the rest of the parameters are passed to java
1675 # @CODE
1676 ejunit_() {
1677 debug-print-function ${FUNCNAME} $*
1678
1679 local pkgs
1680 if [[ -f ${JAVA_PKG_DEPEND_FILE} ]]; then
1681 for atom in $(cat ${JAVA_PKG_DEPEND_FILE} | tr : ' '); do
1682 pkgs=${pkgs},$(echo ${atom} | sed -re "s/^.*@//")
1683 done
1684 fi
1685
1686 local junit=${1}
1687 shift 1
1688
1689 local cp=$(java-pkg_getjars --with-dependencies ${junit}${pkgs})
1690 if [[ ${1} = -cp || ${1} = -classpath ]]; then
1691 cp="${2}:${cp}"
1692 shift 2
1693 else
1694 cp=".:${cp}"
1695 fi
1696
1697 local runner=junit.textui.TestRunner
1698 if [[ "${junit}" == "junit-4" ]] ; then
1699 runner=org.junit.runner.JUnitCore
1700 fi
1701 debug-print "Calling: java -cp \"${cp}\" -Djava.awt.headless=true ${runner} ${@}"
1702 java -cp "${cp}" -Djava.awt.headless=true ${runner} "${@}" || die "Running junit failed"
1703 }
1704
1705 # @FUNCTION: ejunit
1706 # @DESCRIPTION:
1707 # Junit wrapper function. Makes it easier to run the tests and checks for
1708 # dev-java/junit in DEPEND. Launches the tests using org.junit.runner.JUnitCore.
1709 #
1710 # @CODE
1711 # Parameters:
1712 # $1 - -cp or -classpath
1713 # $2 - classpath; junit and recorded dependencies get appended
1714 # $@ - the rest of the parameters are passed to java
1715 #
1716 # Examples:
1717 # ejunit -cp build/classes org.blinkenlights.jid3.test.AllTests
1718 # ejunit org.blinkenlights.jid3.test.AllTests
1719 # ejunit org.blinkenlights.jid3.test.FirstTest org.blinkenlights.jid3.test.SecondTest
1720 # @CODE
1721 ejunit() {
1722 debug-print-function ${FUNCNAME} $*
1723
1724 ejunit_ "junit" "${@}"
1725 }
1726
1727 # @FUNCTION: ejunit4
1728 # @DESCRIPTION:
1729 # Junit4 wrapper function. Makes it easier to run the tests and checks for
1730 # dev-java/junit:4 in DEPEND. Launches the tests using junit.textui.TestRunner.
1731 #
1732 # @CODE
1733 # Parameters:
1734 # $1 - -cp or -classpath
1735 # $2 - classpath; junit and recorded dependencies get appended
1736 # $@ - the rest of the parameters are passed to java
1737 #
1738 # Examples:
1739 # ejunit4 -cp build/classes org.blinkenlights.jid3.test.AllTests
1740 # ejunit4 org.blinkenlights.jid3.test.AllTests
1741 # ejunit4 org.blinkenlights.jid3.test.FirstTest \
1742 # org.blinkenlights.jid3.test.SecondTest
1743 # @CODE
1744 ejunit4() {
1745 debug-print-function ${FUNCNAME} $*
1746
1747 ejunit_ "junit-4" "${@}"
1748 }
1749
1750 # @FUNCTION: java-utils-2_src_prepare
1751 # @DESCRIPTION:
1752 # src_prepare Searches for bundled jars
1753 # Don't call directly, but via java-pkg-2_src_prepare!
1754 java-utils-2_src_prepare() {
1755 [[ ${EBUILD_PHASE} == prepare ]] &&
1756 java-pkg_func-exists java_prepare && java_prepare
1757
1758 # Remember that eant will call this unless called via Portage
1759 if [[ ! -e "${T}/java-utils-2_src_prepare-run" ]] && is-java-strict; then
1760 echo "Searching for bundled jars:"
1761 java-pkg_find-normal-jars || echo "None found."
1762 echo "Searching for bundled classes (no output if none found):"
1763 find "${WORKDIR}" -name "*.class"
1764 echo "Search done."
1765 fi
1766 touch "${T}/java-utils-2_src_prepare-run"
1767 }
1768
1769 # @FUNCTION: java-utils-2_pkg_preinst
1770 # @DESCRIPTION:
1771 # pkg_preinst Searches for missing and unneeded dependencies
1772 # Don't call directly, but via java-pkg-2_pkg_preinst!
1773 java-utils-2_pkg_preinst() {
1774 if is-java-strict; then
1775 if [[ ! -e "${JAVA_PKG_ENV}" ]] || has ant-tasks ${INHERITED}; then
1776 return
1777 fi
1778
1779 if has_version dev-java/java-dep-check; then
1780 local output=$(GENTOO_VM= java-dep-check --image "${D}" "${JAVA_PKG_ENV}")
1781 [[ ${output} ]] && ewarn "${output}"
1782 else
1783 eerror "Install dev-java/java-dep-check for dependency checking"
1784 fi
1785 fi
1786 }
1787
1788 # @FUNCTION: eant
1789 # @USAGE: <ant_build_target(s)>
1790 # @DESCRIPTION:
1791 # Ant wrapper function. Will use the appropriate compiler, based on user-defined
1792 # compiler. Will also set proper ANT_TASKS from the variable ANT_TASKS,
1793 # variables:
1794 #
1795 # @CODE
1796 # Variables:
1797 # EANT_GENTOO_CLASSPATH - calls java-pkg_getjars for the value and adds to the
1798 # gentoo.classpath property. Be sure to call java-ant_rewrite-classpath in src_unpack.
1799 # EANT_NEEDS_TOOLS - add tools.jar to the gentoo.classpath. Should only be used
1800 # for build-time purposes, the dependency is not recorded to
1801 # package.env!
1802 # ANT_TASKS - used to determine ANT_TASKS before calling Ant.
1803 # @CODE
1804 eant() {
1805 debug-print-function ${FUNCNAME} $*
1806
1807 if [[ ${EBUILD_PHASE} = compile ]]; then
1808 java-ant-2_src_configure
1809 java-utils-2_src_prepare
1810 fi
1811
1812 if ! has java-ant-2 ${INHERITED}; then
1813 local msg="You should inherit java-ant-2 when using eant"
1814 java-pkg_announce-qa-violation "${msg}"
1815 fi
1816
1817 local antflags="-Dnoget=true -Dmaven.mode.offline=true -Dbuild.sysclasspath=ignore"
1818
1819 java-pkg_init-compiler_
1820 local compiler="${GENTOO_COMPILER}"
1821
1822 local compiler_env="${JAVA_PKG_COMPILER_DIR}/${compiler}"
1823 local build_compiler="$(source ${compiler_env} 1>/dev/null 2>&1; echo ${ANT_BUILD_COMPILER})"
1824 if [[ "${compiler}" != "javac" && -z "${build_compiler}" ]]; then
1825 die "ANT_BUILD_COMPILER undefined in ${compiler_env}"
1826 fi
1827
1828 if [[ ${compiler} != "javac" ]]; then
1829 antflags="${antflags} -Dbuild.compiler=${build_compiler}"
1830 # Figure out any extra stuff to put on the classpath for compilers aside
1831 # from javac
1832 # ANT_BUILD_COMPILER_DEPS should be something that could be passed to
1833 # java-config -p
1834 local build_compiler_deps="$(source ${JAVA_PKG_COMPILER_DIR}/${compiler} 1>/dev/null 2>&1; echo ${ANT_BUILD_COMPILER_DEPS})"
1835 if [[ -n ${build_compiler_deps} ]]; then
1836 antflags="${antflags} -lib $(java-config -p ${build_compiler_deps})"
1837 fi
1838 fi
1839
1840 for arg in "${@}"; do
1841 if [[ ${arg} = -lib ]]; then
1842 if is-java-strict; then
1843 eerror "You should not use the -lib argument to eant because it will fail"
1844 eerror "with JAVA_PKG_STRICT. Please use for example java-pkg_jar-from"
1845 eerror "or ant properties to make dependencies available."
1846 eerror "For ant tasks use WANT_ANT_TASKS or ANT_TASKS from."
1847 eerror "split ant (>=dev-java/ant-core-1.7)."
1848 die "eant -lib is deprecated/forbidden"
1849 else
1850 echo "eant -lib is deprecated. Turn JAVA_PKG_STRICT on for"
1851 echo "more info."
1852 fi
1853 fi
1854 done
1855
1856 # parse WANT_ANT_TASKS for atoms
1857 local want_ant_tasks
1858 for i in ${WANT_ANT_TASKS}; do
1859 if [[ ${i} = */*:* ]]; then
1860 i=${i#*/}
1861 i=${i%:0}
1862 want_ant_tasks+="${i/:/-} "
1863 else
1864 want_ant_tasks+="${i} "
1865 fi
1866 done
1867 # default ANT_TASKS to WANT_ANT_TASKS, if ANT_TASKS is not set explicitly
1868 ANT_TASKS="${ANT_TASKS:-${want_ant_tasks% }}"
1869
1870 # override ANT_TASKS with JAVA_PKG_FORCE_ANT_TASKS if it's set
1871 ANT_TASKS="${JAVA_PKG_FORCE_ANT_TASKS:-${ANT_TASKS}}"
1872
1873 # if ant-tasks is not set by ebuild or forced, use none
1874 ANT_TASKS="${ANT_TASKS:-none}"
1875
1876 # at this point, ANT_TASKS should be "all", "none" or explicit list
1877 if [[ "${ANT_TASKS}" == "all" ]]; then
1878 einfo "Using all available ANT_TASKS"
1879 elif [[ "${ANT_TASKS}" == "none" ]]; then
1880 einfo "Disabling all optional ANT_TASKS"
1881 else
1882 einfo "Using following ANT_TASKS: ${ANT_TASKS}"
1883 fi
1884
1885 export ANT_TASKS
1886
1887 [[ -n ${JAVA_PKG_DEBUG} ]] && antflags="${antflags} --execdebug -debug"
1888 [[ -n ${PORTAGE_QUIET} ]] && antflags="${antflags} -q"
1889
1890 local gcp="${EANT_GENTOO_CLASSPATH}"
1891 local getjarsarg=""
1892
1893 if [[ ${EBUILD_PHASE} = "test" ]]; then
1894 antflags="${antflags} -DJunit.present=true"
1895 getjarsarg="--with-dependencies"
1896
1897 local re="\bant-junit4?([-:]\S+)?\b"
1898 [[ ${ANT_TASKS} =~ ${re} ]] && gcp+=" ${BASH_REMATCH[0]}"
1899 else
1900 antflags="${antflags} -Dmaven.test.skip=true"
1901 fi
1902
1903 local cp
1904
1905 for atom in ${gcp}; do
1906 cp="${cp}:$(java-pkg_getjars ${getjarsarg} ${atom})"
1907 done
1908
1909 [[ -n "${EANT_NEEDS_TOOLS}" ]] && cp="${cp}:$(java-config --tools)"
1910
1911 if [[ ${cp} ]]; then
1912 # It seems ant does not like single quotes around ${cp}
1913 cp=${cp#:}
1914 [[ ${EANT_GENTOO_CLASSPATH_EXTRA} ]] && \
1915 cp="${cp}:${EANT_GENTOO_CLASSPATH_EXTRA}"
1916 antflags="${antflags} -Dgentoo.classpath=\"${cp}\""
1917 fi
1918
1919 [[ -n ${JAVA_PKG_DEBUG} ]] && echo ant ${antflags} "${@}"
1920 debug-print "Calling ant (GENTOO_VM: ${GENTOO_VM}): ${antflags} ${@}"
1921 ant ${antflags} "${@}" || die "eant failed"
1922 }
1923
1924 # @FUNCTION: ejavac
1925 # @USAGE: <javac_arguments>
1926 # @DESCRIPTION:
1927 # Javac wrapper function. Will use the appropriate compiler, based on
1928 # /etc/java-config/compilers.conf
1929 ejavac() {
1930 debug-print-function ${FUNCNAME} $*
1931
1932 java-pkg_init-compiler_
1933
1934 local compiler_executable
1935 compiler_executable=$(java-pkg_get-javac)
1936 if [[ ${?} != 0 ]]; then
1937 eerror "There was a problem determining compiler: ${compiler_executable}"
1938 die "get-javac failed"
1939 fi
1940
1941 local javac_args
1942 javac_args="$(java-pkg_javac-args)"
1943 if [[ ${?} != 0 ]]; then
1944 eerror "There was a problem determining JAVACFLAGS: ${javac_args}"
1945 die "java-pkg_javac-args failed"
1946 fi
1947
1948 [[ -n ${JAVA_PKG_DEBUG} ]] && echo ${compiler_executable} ${javac_args} "${@}"
1949 ${compiler_executable} ${javac_args} "${@}" || die "ejavac failed"
1950 }
1951
1952 # @FUNCTION: ejavadoc
1953 # @USAGE: <javadoc_arguments>
1954 # @DESCRIPTION:
1955 # javadoc wrapper function. Will set some flags based on the VM version
1956 # due to strict javadoc rules in 1.8.
1957 ejavadoc() {
1958 debug-print-function ${FUNCNAME} $*
1959
1960 local javadoc_args=""
1961
1962 if java-pkg_is-vm-version-ge "1.8" ; then
1963 javadoc_args="-Xdoclint:none"
1964 fi
1965
1966 javadoc ${javadoc_args} "${@}" || die "ejavadoc failed"
1967 }
1968
1969 # @FUNCTION: java-pkg_filter-compiler
1970 # @USAGE: <compiler(s)_to_filter>
1971 # @DESCRIPTION:
1972 # Used to prevent the use of some compilers. Should be used in src_compile.
1973 # Basically, it just appends onto JAVA_PKG_FILTER_COMPILER
1974 java-pkg_filter-compiler() {
1975 JAVA_PKG_FILTER_COMPILER="${JAVA_PKG_FILTER_COMPILER} $@"
1976 }
1977
1978 # @FUNCTION: java-pkg_force-compiler
1979 # @USAGE: <compiler(s)_to_force>
1980 # @DESCRIPTION:
1981 # Used to force the use of particular compilers. Should be used in src_compile.
1982 # A common use of this would be to force ecj-3.1 to be used on amd64, to avoid
1983 # OutOfMemoryErrors that may come up.
1984 java-pkg_force-compiler() {
1985 JAVA_PKG_FORCE_COMPILER="$@"
1986 }
1987
1988 # @FUNCTION: use_doc
1989 # @DESCRIPTION:
1990 #
1991 # Helper function for getting ant to build javadocs. If the user has USE=doc,
1992 # then 'javadoc' or the argument are returned. Otherwise, there is no return.
1993 #
1994 # The output of this should be passed to ant.
1995 # @CODE
1996 # Parameters:
1997 # $@ - Option value to return. Defaults to 'javadoc'
1998 #
1999 # Examples:
2000 # build javadocs by calling 'javadoc' target
2001 # eant $(use_doc)
2002 #
2003 # build javadocs by calling 'apidoc' target
2004 # eant $(use_doc apidoc)
2005 # @CODE
2006 # @RETURN string - Name of the target to create javadocs
2007 use_doc() {
2008 use doc && echo ${@:-javadoc}
2009 }
2010
2011
2012 # @FUNCTION: java-pkg_init
2013 # @INTERNAL
2014 # @DESCRIPTION:
2015 # The purpose of this function, as the name might imply, is to initialize the
2016 # Java environment. It ensures that that there aren't any environment variables
2017 # that'll muss things up. It initializes some variables, which are used
2018 # internally. And most importantly, it'll switch the VM if necessary.
2019 #
2020 # This shouldn't be used directly. Instead, java-pkg and java-pkg-opt will
2021 # call it during each of the phases of the merge process.
2022 java-pkg_init() {
2023 debug-print-function ${FUNCNAME} $*
2024
2025 # Don't set up build environment if installing from binary. #206024 #258423
2026 [[ "${MERGE_TYPE}" == "binary" ]] && return
2027 # Also try Portage's nonstandard EMERGE_FROM for old EAPIs, if it doesn't
2028 # work nothing is lost.
2029 has ${EAPI:-0} 0 1 2 3 && [[ "${EMERGE_FROM}" == "binary" ]] && return
2030
2031 unset JAVAC
2032 unset JAVA_HOME
2033
2034 java-config --help >/dev/null || {
2035 eerror ""
2036 eerror "Can't run java-config --help"
2037 eerror "Have you upgraded python recently but haven't"
2038 eerror "run python-updater yet?"
2039 die "Can't run java-config --help"
2040 }
2041
2042 # People do all kinds of weird things.
2043 # http://forums.gentoo.org/viewtopic-p-3943166.html
2044 local silence="${SILENCE_JAVA_OPTIONS_WARNING}"
2045 local accept="${I_WANT_GLOBAL_JAVA_OPTIONS}"
2046 if [[ -n ${_JAVA_OPTIONS} && -z ${accept} && -z ${silence} ]]; then
2047 ewarn "_JAVA_OPTIONS changes what java -version outputs at least for"
2048 ewarn "sun-jdk vms and and as such break configure scripts that"
2049 ewarn "use it (for example app-office/openoffice) so we filter it out."
2050 ewarn "Use SILENCE_JAVA_OPTIONS_WARNING=true in the environment (use"
2051 ewarn "make.conf for example) to silence this warning or"
2052 ewarn "I_WANT_GLOBAL_JAVA_OPTIONS to not filter it."
2053 fi
2054
2055 if [[ -z ${accept} ]]; then
2056 # export _JAVA_OPTIONS= doesn't work because it will show up in java
2057 # -version output
2058 unset _JAVA_OPTIONS
2059 # phase hooks make this run many times without this
2060 I_WANT_GLOBAL_JAVA_OPTIONS="true"
2061 fi
2062
2063 if java-pkg_func-exists ant_src_unpack; then
2064 java-pkg_announce-qa-violation "Using old ant_src_unpack. Should be src_unpack"
2065 fi
2066
2067 java-pkg_switch-vm
2068 PATH=${JAVA_HOME}/bin:${PATH}
2069
2070 # TODO we will probably want to set JAVAC and JAVACFLAGS
2071
2072 # Do some QA checks
2073 java-pkg_check-jikes
2074
2075 # Can't use unset here because Portage does not save the unset
2076 # see https://bugs.gentoo.org/show_bug.cgi?id=189417#c11
2077
2078 # When users have crazy classpaths some packages can fail to compile.
2079 # and everything should work with empty CLASSPATH.
2080 # This also helps prevent unexpected dependencies on random things
2081 # from the CLASSPATH.
2082 export CLASSPATH=
2083
2084 # Unset external ANT_ stuff
2085 export ANT_TASKS=
2086 export ANT_OPTS=
2087 export ANT_RESPECT_JAVA_HOME=
2088 }
2089
2090 # @FUNCTION: java-pkg-init-compiler_
2091 # @INTERNAL
2092 # @DESCRIPTION:
2093 # This function attempts to figure out what compiler should be used. It does
2094 # this by reading the file at JAVA_PKG_COMPILERS_CONF, and checking the
2095 # COMPILERS variable defined there.
2096 # This can be overridden by a list in JAVA_PKG_FORCE_COMPILER
2097 #
2098 # It will go through the list of compilers, and verify that it supports the
2099 # target and source that are needed. If it is not suitable, then the next
2100 # compiler is checked. When JAVA_PKG_FORCE_COMPILER is defined, this checking
2101 # isn't done.
2102 #
2103 # Once the which compiler to use has been figured out, it is set to
2104 # GENTOO_COMPILER.
2105 #
2106 # If you hadn't guessed, JAVA_PKG_FORCE_COMPILER is for testing only.
2107 #
2108 # If the user doesn't defined anything in JAVA_PKG_COMPILERS_CONF, or no
2109 # suitable compiler was found there, then the default is to use javac provided
2110 # by the current VM.
2111 #
2112 #
2113 # @RETURN name of the compiler to use
2114 java-pkg_init-compiler_() {
2115 debug-print-function ${FUNCNAME} $*
2116
2117 if [[ -n ${GENTOO_COMPILER} ]]; then
2118 debug-print "GENTOO_COMPILER already set"
2119 return
2120 fi
2121
2122 local compilers;
2123 if [[ -z ${JAVA_PKG_FORCE_COMPILER} ]]; then
2124 compilers="$(source ${JAVA_PKG_COMPILERS_CONF} 1>/dev/null 2>&1; echo ${COMPILERS})"
2125 else
2126 compilers=${JAVA_PKG_FORCE_COMPILER}
2127 fi
2128
2129 debug-print "Read \"${compilers}\" from ${JAVA_PKG_COMPILERS_CONF}"
2130
2131 # Figure out if we should announce what compiler we're using
2132 local compiler
2133 for compiler in ${compilers}; do
2134 debug-print "Checking ${compiler}..."
2135 # javac should always be alright
2136 if [[ ${compiler} = "javac" ]]; then
2137 debug-print "Found javac... breaking"
2138 export GENTOO_COMPILER="javac"
2139 break
2140 fi
2141
2142 if has ${compiler} ${JAVA_PKG_FILTER_COMPILER}; then
2143 if [[ -z ${JAVA_PKG_FORCE_COMPILER} ]]; then
2144 einfo "Filtering ${compiler}"
2145 continue
2146 fi
2147 fi
2148
2149 # for non-javac, we need to make sure it supports the right target and
2150 # source
2151 local compiler_env="${JAVA_PKG_COMPILER_DIR}/${compiler}"
2152 if [[ -f ${compiler_env} ]]; then
2153 local desired_target="$(java-pkg_get-target)"
2154 local desired_source="$(java-pkg_get-source)"
2155
2156
2157 # Verify that the compiler supports target
2158 local supported_target=$(source ${compiler_env} 1>/dev/null 2>&1; echo ${SUPPORTED_TARGET})
2159 if ! has ${desired_target} ${supported_target}; then
2160 ewarn "${compiler} does not support -target ${desired_target}, skipping"
2161 continue
2162 fi
2163
2164 # -source was introduced in 1.3, so only check 1.3 and on
2165 if version_is_at_least "${desired_soure}" "1.3"; then
2166 # Verify that the compiler supports source
2167 local supported_source=$(source ${compiler_env} 1>/dev/null 2>&1; echo ${SUPPORTED_SOURCE})
2168 if ! has ${desired_source} ${supported_source}; then
2169 ewarn "${compiler} does not support -source ${desired_source}, skipping"
2170 continue
2171 fi
2172 fi
2173
2174 # if you get here, then the compiler should be good to go
2175 export GENTOO_COMPILER="${compiler}"
2176 break
2177 else
2178 ewarn "Could not find configuration for ${compiler}, skipping"
2179 ewarn "Perhaps it is not installed?"
2180 continue
2181 fi
2182 done
2183
2184 # If it hasn't been defined already, default to javac
2185 if [[ -z ${GENTOO_COMPILER} ]]; then
2186 if [[ -n ${compilers} ]]; then
2187 einfo "No suitable compiler found: defaulting to JDK default for compilation"
2188 else
2189 # probably don't need to notify users about the default.
2190 :;#einfo "Defaulting to javac for compilation"
2191 fi
2192 if java-config -g GENTOO_COMPILER 2> /dev/null; then
2193 export GENTOO_COMPILER=$(java-config -g GENTOO_COMPILER)
2194 else
2195 export GENTOO_COMPILER=javac
2196 fi
2197 else
2198 einfo "Using ${GENTOO_COMPILER} for compilation"
2199 fi
2200
2201 }
2202
2203 # @FUNCTION: init_paths_
2204 # @INTERNAL
2205 # @DESCRIPTION:
2206 # Initializes some variables that will be used. These variables are mostly used
2207 # to determine where things will eventually get installed.
2208 java-pkg_init_paths_() {
2209 debug-print-function ${FUNCNAME} $*
2210
2211 local pkg_name
2212 if [[ "${SLOT%/*}" == "0" ]] ; then
2213 JAVA_PKG_NAME="${PN}"
2214 else
2215 JAVA_PKG_NAME="${PN}-${SLOT%/*}"
2216 fi
2217
2218 JAVA_PKG_SHAREPATH="${DESTTREE}/share/${JAVA_PKG_NAME}"
2219 JAVA_PKG_SOURCESPATH="${JAVA_PKG_SHAREPATH}/sources/"
2220 JAVA_PKG_ENV="${D}${JAVA_PKG_SHAREPATH}/package.env"
2221 JAVA_PKG_VIRTUALS_PATH="${DESTTREE}/share/java-config-2/virtuals"
2222 JAVA_PKG_VIRTUAL_PROVIDER="${D}/${JAVA_PKG_VIRTUALS_PATH}/${JAVA_PKG_NAME}"
2223
2224 [[ -z "${JAVA_PKG_JARDEST}" ]] && JAVA_PKG_JARDEST="${JAVA_PKG_SHAREPATH}/lib"
2225 [[ -z "${JAVA_PKG_LIBDEST}" ]] && JAVA_PKG_LIBDEST="${DESTTREE}/$(get_libdir)/${JAVA_PKG_NAME}"
2226 [[ -z "${JAVA_PKG_WARDEST}" ]] && JAVA_PKG_WARDEST="${JAVA_PKG_SHAREPATH}/webapps"
2227
2228 # TODO maybe only print once?
2229 debug-print "JAVA_PKG_SHAREPATH: ${JAVA_PKG_SHAREPATH}"
2230 debug-print "JAVA_PKG_ENV: ${JAVA_PKG_ENV}"
2231 debug-print "JAVA_PKG_JARDEST: ${JAVA_PKG_JARDEST}"
2232 debug-print "JAVA_PKG_LIBDEST: ${JAVA_PKG_LIBDEST}"
2233 debug-print "JAVA_PKG_WARDEST: ${JAVA_PKG_WARDEST}"
2234 }
2235
2236 # @FUNCTION: java-pkg_do_write_
2237 # @INTERNAL
2238 # @DESCRIPTION:
2239 # Writes the package.env out to disk.
2240 #
2241 # TODO change to do-write, to match everything else
2242 java-pkg_do_write_() {
2243 debug-print-function ${FUNCNAME} $*
2244 java-pkg_init_paths_
2245 # Create directory for package.env
2246 dodir "${JAVA_PKG_SHAREPATH}"
2247 if [[ -n "${JAVA_PKG_CLASSPATH}" || -n "${JAVA_PKG_LIBRARY}" || -f \
2248 "${JAVA_PKG_DEPEND_FILE}" || -f \
2249 "${JAVA_PKG_OPTIONAL_DEPEND_FILE}" ]]; then
2250 # Create package.env
2251 (
2252 echo "DESCRIPTION=\"${DESCRIPTION}\""
2253 echo "GENERATION=\"2\""
2254 echo "SLOT=\"${SLOT}\""
2255 echo "CATEGORY=\"${CATEGORY}\""
2256 echo "PVR=\"${PVR}\""
2257
2258 [[ -n "${JAVA_PKG_CLASSPATH}" ]] && echo "CLASSPATH=\"${JAVA_PKG_CLASSPATH}\""
2259 [[ -n "${JAVA_PKG_LIBRARY}" ]] && echo "LIBRARY_PATH=\"${JAVA_PKG_LIBRARY}\""
2260 [[ -n "${JAVA_PROVIDE}" ]] && echo "PROVIDES=\"${JAVA_PROVIDE}\""
2261 [[ -f "${JAVA_PKG_DEPEND_FILE}" ]] \
2262 && echo "DEPEND=\"$(sort -u "${JAVA_PKG_DEPEND_FILE}" | tr '\n' ':')\""
2263 [[ -f "${JAVA_PKG_OPTIONAL_DEPEND_FILE}" ]] \
2264 && echo "OPTIONAL_DEPEND=\"$(sort -u "${JAVA_PKG_OPTIONAL_DEPEND_FILE}" | tr '\n' ':')\""
2265 echo "VM=\"$(echo ${RDEPEND} ${DEPEND} | sed -e 's/ /\n/g' | sed -n -e '/virtual\/\(jre\|jdk\)/ { p;q }')\"" # TODO cleanup !
2266 [[ -f "${JAVA_PKG_BUILD_DEPEND_FILE}" ]] \
2267 && echo "BUILD_DEPEND=\"$(sort -u "${JAVA_PKG_BUILD_DEPEND_FILE}" | tr '\n' ':')\""
2268 ) > "${JAVA_PKG_ENV}"
2269
2270 # register target/source
2271 local target="$(java-pkg_get-target)"
2272 local source="$(java-pkg_get-source)"
2273 [[ -n ${target} ]] && echo "TARGET=\"${target}\"" >> "${JAVA_PKG_ENV}"
2274 [[ -n ${source} ]] && echo "SOURCE=\"${source}\"" >> "${JAVA_PKG_ENV}"
2275
2276 # register javadoc info
2277 [[ -n ${JAVADOC_PATH} ]] && echo "JAVADOC_PATH=\"${JAVADOC_PATH}\"" \
2278 >> ${JAVA_PKG_ENV}
2279 # register source archives
2280 [[ -n ${JAVA_SOURCES} ]] && echo "JAVA_SOURCES=\"${JAVA_SOURCES}\"" \
2281 >> ${JAVA_PKG_ENV}
2282
2283
2284 echo "MERGE_VM=\"${GENTOO_VM}\"" >> "${JAVA_PKG_ENV}"
2285 [[ -n ${GENTOO_COMPILER} ]] && echo "MERGE_COMPILER=\"${GENTOO_COMPILER}\"" >> "${JAVA_PKG_ENV}"
2286
2287 # extra env variables
2288 if [[ -n "${JAVA_PKG_EXTRA_ENV_VARS}" ]]; then
2289 cat "${JAVA_PKG_EXTRA_ENV}" >> "${JAVA_PKG_ENV}" || die
2290 # nested echo to remove leading/trailing spaces
2291 echo "ENV_VARS=\"$(echo ${JAVA_PKG_EXTRA_ENV_VARS})\"" \
2292 >> "${JAVA_PKG_ENV}" || die
2293 fi
2294
2295 # Strip unnecessary leading and trailing colons
2296 # TODO try to cleanup if possible
2297 sed -e "s/=\":/=\"/" -e "s/:\"$/\"/" -i "${JAVA_PKG_ENV}" || die "Did you forget to call java_init ?"
2298 else
2299 debug-print "JAVA_PKG_CLASSPATH, JAVA_PKG_LIBRARY, JAVA_PKG_DEPEND_FILE"
2300 debug-print "or JAVA_PKG_OPTIONAL_DEPEND_FILE not defined so can't"
2301 debug-print "write package.env."
2302 fi
2303 }
2304
2305 # @FUNCTION: java-pkg_record-jar_
2306 # @INTERNAL
2307 # @DESCRIPTION:
2308 # Record an (optional) dependency to the package.env
2309 # @CODE
2310 # Parameters:
2311 # --optional - record dependency as optional
2312 # --build - record dependency as build_only
2313 # $1 - package to record
2314 # $2 - (optional) jar of package to record
2315 # @CODE
2316 JAVA_PKG_DEPEND_FILE="${T}/java-pkg-depend"
2317 JAVA_PKG_OPTIONAL_DEPEND_FILE="${T}/java-pkg-optional-depend"
2318 JAVA_PKG_BUILD_DEPEND_FILE="${T}/java-pkg-build-depend"
2319
2320 java-pkg_record-jar_() {
2321 debug-print-function ${FUNCNAME} $*
2322
2323 local depend_file="${JAVA_PKG_DEPEND_FILE}"
2324 case "${1}" in
2325 "--optional") depend_file="${JAVA_PKG_OPTIONAL_DEPEND_FILE}"; shift;;
2326 "--build-only") depend_file="${JAVA_PKG_BUILD_DEPEND_FILE}"; shift;;
2327 esac
2328
2329 local pkg=${1} jar=${2} append
2330 if [[ -z "${jar}" ]]; then
2331 append="${pkg}"
2332 else
2333 append="$(basename ${jar})@${pkg}"
2334 fi
2335
2336 echo "${append}" >> "${depend_file}"
2337 }
2338
2339 # @FUNCTION: java-pkg_append_
2340 # @INTERNAL
2341 # @DESCRIPTION:
2342 # Appends a value to a variable
2343 #
2344 # @CODE
2345 # Parameters:
2346 # $1 variable name to modify
2347 # $2 value to append
2348 #
2349 # Examples:
2350 # java-pkg_append_ CLASSPATH foo.jar
2351 # @CODE
2352 java-pkg_append_() {
2353 debug-print-function ${FUNCNAME} $*
2354
2355 local var="${1}" value="${2}"
2356 if [[ -z "${!var}" ]] ; then
2357 export ${var}="${value}"
2358 else
2359 local oldIFS=${IFS} cur haveit
2360 IFS=':'
2361 for cur in ${!var}; do
2362 if [[ ${cur} == ${value} ]]; then
2363 haveit="yes"
2364 break
2365 fi
2366 done
2367 [[ -z ${haveit} ]] && export ${var}="${!var}:${value}"
2368 IFS=${oldIFS}
2369 fi
2370 }
2371
2372 # @FUNCTION: java-pkg_expand_dir_
2373 # @INTERNAL
2374 # @DESCRIPTION:
2375 # Gets the full path of the file/directory's parent.
2376 # @CODE
2377 # Parameters:
2378 # $1 - file/directory to find parent directory for
2379 # @CODE
2380 # @RETURN: path to $1's parent directory
2381 java-pkg_expand_dir_() {
2382 pushd "$(dirname "${1}")" >/dev/null 2>&1
2383 pwd
2384 popd >/dev/null 2>&1
2385 }
2386
2387 # @FUNCTION: java-pkg_func-exists
2388 # @INTERNAL
2389 # @DESCRIPTION:
2390 # Does the indicated function exist?
2391 # @RETURN: 0 - function is declared, 1 - function is undeclared
2392 java-pkg_func-exists() {
2393 declare -F ${1} > /dev/null
2394 }
2395
2396 # @FUNCTION: java-pkg_setup-vm
2397 # @INTERNAL
2398 # @DESCRIPTION:
2399 # Sets up the environment for a specific VM
2400 java-pkg_setup-vm() {
2401 debug-print-function ${FUNCNAME} $*
2402
2403 local vendor="$(java-pkg_get-vm-vendor)"
2404 if [[ "${vendor}" == "sun" ]] && java-pkg_is-vm-version-ge "1.5" ; then
2405 addpredict "/dev/random"
2406 elif [[ "${vendor}" == "ibm" ]]; then
2407 addpredict "/proc/self/maps"
2408 addpredict "/proc/cpuinfo"
2409 addpredict "/proc/self/coredump_filter"
2410 elif [[ "${vendor}" == "oracle" ]]; then
2411 addpredict "/dev/random"
2412 addpredict "/proc/self/coredump_filter"
2413 elif [[ "${vendor}" == icedtea* ]] && java-pkg_is-vm-version-ge "1.7" ; then
2414 addpredict "/dev/random"
2415 addpredict "/proc/self/coredump_filter"
2416 elif [[ "${vendor}" == "jrockit" ]]; then
2417 addpredict "/proc/cpuinfo"
2418 fi
2419 }
2420
2421 # @FUNCTION: java-pkg_needs-vm
2422 # @INTERNAL
2423 # @DESCRIPTION:
2424 # Does the current package depend on virtual/jdk or does it set
2425 # JAVA_PKG_WANT_BUILD_VM?
2426 #
2427 # @RETURN: 0 - Package depends on virtual/jdk; 1 - Package does not depend on virtual/jdk
2428 java-pkg_needs-vm() {
2429 debug-print-function ${FUNCNAME} $*
2430
2431 if [[ -n "$(echo ${JAVA_PKG_NV_DEPEND:-${DEPEND}} | sed -e '\:virtual/jdk:!d')" ]]; then
2432 return 0
2433 fi
2434
2435 [[ -n "${JAVA_PKG_WANT_BUILD_VM}" ]] && return 0
2436
2437 return 1
2438 }
2439
2440 # @FUNCTION: java-pkg_get-current-vm
2441 # @INTERNAL
2442 # @RETURN - The current VM being used
2443 java-pkg_get-current-vm() {
2444 java-config -f
2445 }
2446
2447 # @FUNCTION: java-pkg_get-vm-vendor
2448 # @INTERNAL
2449 # @RETURN - The vendor of the current VM
2450 java-pkg_get-vm-vendor() {
2451 debug-print-function ${FUNCNAME} $*
2452
2453 local vm="$(java-pkg_get-current-vm)"
2454 vm="${vm/-*/}"
2455 echo "${vm}"
2456 }
2457
2458 # @FUNCTION: java-pkg_get-vm-version
2459 # @INTERNAL
2460 # @RETURN - The version of the current VM
2461 java-pkg_get-vm-version() {
2462 debug-print-function ${FUNCNAME} $*
2463
2464 java-config -g PROVIDES_VERSION
2465 }
2466
2467 # @FUNCTION: java-pkg_build-vm-from-handle
2468 # @INTERNAL
2469 # @DESCRIPTION:
2470 # Selects a build vm from a list of vm handles. First checks for the system-vm
2471 # beeing usable, then steps through the listed handles till a suitable vm is
2472 # found.
2473 #
2474 # @RETURN - VM handle of an available JDK
2475 java-pkg_build-vm-from-handle() {
2476 debug-print-function ${FUNCNAME} "$*"
2477
2478 local vm
2479 vm=$(java-pkg_get-current-vm 2>/dev/null)
2480 if [[ $? -eq 0 ]]; then
2481 if has ${vm} ${JAVA_PKG_WANT_BUILD_VM}; then
2482 echo ${vm}
2483 return 0
2484 fi
2485 fi
2486
2487 for vm in ${JAVA_PKG_WANT_BUILD_VM}; do
2488 if java-config-2 --select-vm=${vm} 2>/dev/null; then
2489 echo ${vm}
2490 return 0
2491 fi
2492 done
2493
2494 eerror "${FUNCNAME}: No vm found for handles: ${JAVA_PKG_WANT_BUILD_VM}"
2495 return 1
2496 }
2497
2498 # @FUNCTION: java-pkg_switch-vm
2499 # @INTERNAL
2500 # @DESCRIPTION:
2501 # Switch VM if we're allowed to (controlled by JAVA_PKG_ALLOW_VM_CHANGE), and
2502 # verify that the current VM is sufficient.
2503 # Setup the environment for the VM being used.
2504 java-pkg_switch-vm() {
2505 debug-print-function ${FUNCNAME} $*
2506
2507 if java-pkg_needs-vm; then
2508 # Use the VM specified by JAVA_PKG_FORCE_VM
2509 if [[ -n "${JAVA_PKG_FORCE_VM}" ]]; then
2510 # If you're forcing the VM, I hope you know what your doing...
2511 debug-print "JAVA_PKG_FORCE_VM used: ${JAVA_PKG_FORCE_VM}"
2512 export GENTOO_VM="${JAVA_PKG_FORCE_VM}"
2513 # if we're allowed to switch the vm...
2514 elif [[ "${JAVA_PKG_ALLOW_VM_CHANGE}" == "yes" ]]; then
2515 # if there is an explicit list of handles to choose from
2516 if [[ -n "${JAVA_PKG_WANT_BUILD_VM}" ]]; then
2517 debug-print "JAVA_PKG_WANT_BUILD_VM used: ${JAVA_PKG_WANT_BUILD_VM}"
2518 GENTOO_VM=$(java-pkg_build-vm-from-handle)
2519 if [[ $? != 0 ]]; then
2520 eerror "${FUNCNAME}: No VM found for handles: ${JAVA_PKG_WANT_BUILD_VM}"
2521 die "${FUNCNAME}: Failed to determine VM for building"
2522 fi
2523 # JAVA_PKG_WANT_SOURCE and JAVA_PKG_WANT_TARGET are required as
2524 # they can't be deduced from handles.
2525 if [[ -z "${JAVA_PKG_WANT_SOURCE}" ]]; then
2526 eerror "JAVA_PKG_WANT_BUILD_VM specified but not JAVA_PKG_WANT_SOURCE"
2527 die "Specify JAVA_PKG_WANT_SOURCE"
2528 fi
2529 if [[ -z "${JAVA_PKG_WANT_TARGET}" ]]; then
2530 eerror "JAVA_PKG_WANT_BUILD_VM specified but not JAVA_PKG_WANT_TARGET"
2531 die "Specify JAVA_PKG_WANT_TARGET"
2532 fi
2533 # otherwise determine a vm from dep string
2534 else
2535 debug-print "depend-java-query: NV_DEPEND: ${JAVA_PKG_NV_DEPEND:-${DEPEND}}"
2536 GENTOO_VM="$(depend-java-query --get-vm "${JAVA_PKG_NV_DEPEND:-${DEPEND}}")"
2537 if [[ -z "${GENTOO_VM}" || "${GENTOO_VM}" == "None" ]]; then
2538 eerror "Unable to determine VM for building from dependencies:"
2539 echo "NV_DEPEND: ${JAVA_PKG_NV_DEPEND:-${DEPEND}}"
2540 die "Failed to determine VM for building."
2541 fi
2542 fi
2543 export GENTOO_VM
2544 # otherwise just make sure the current VM is sufficient
2545 else
2546 java-pkg_ensure-vm-version-sufficient
2547 fi
2548 debug-print "Using: $(java-config -f)"
2549
2550 java-pkg_setup-vm
2551
2552 export JAVA=$(java-config --java)
2553 export JAVAC=$(java-config --javac)
2554 JAVACFLAGS="$(java-pkg_javac-args)"
2555 if [[ ${?} != 0 ]]; then
2556 eerror "There was a problem determining JAVACFLAGS: ${JAVACFLAGS}"
2557 die "java-pkg_javac-args failed"
2558 fi
2559 [[ -n ${JAVACFLAGS_EXTRA} ]] && JAVACFLAGS="${JAVACFLAGS_EXTRA} ${JAVACFLAGS}"
2560 export JAVACFLAGS
2561
2562 export JAVA_HOME="$(java-config -g JAVA_HOME)"
2563 export JDK_HOME=${JAVA_HOME}
2564
2565 #TODO If you know a better solution let us know.
2566 java-pkg_append_ LD_LIBRARY_PATH "$(java-config -g LDPATH)"
2567
2568 local tann="${T}/announced-vm"
2569 # With the hooks we should only get here once from pkg_setup but better safe than sorry
2570 # if people have for example modified eclasses some where
2571 if [[ -n "${JAVA_PKG_DEBUG}" ]] || [[ ! -f "${tann}" ]] ; then
2572 einfo "Using: $(java-config -f)"
2573 [[ ! -f "${tann}" ]] && touch "${tann}"
2574 fi
2575
2576 else
2577 [[ -n "${JAVA_PKG_DEBUG}" ]] && ewarn "!!! This package inherits java-pkg but doesn't depend on a JDK. -bin or broken dependency!!!"
2578 fi
2579 }
2580
2581 # @FUNCTION: java-pkg_die
2582 # @INTERNAL
2583 # @DESCRIPTION:
2584 # Enhanced die for Java packages, which displays some information that may be
2585 # useful for debugging bugs on bugzilla.
2586 #register_die_hook java-pkg_die
2587 if ! has java-pkg_die ${EBUILD_DEATH_HOOKS}; then
2588 EBUILD_DEATH_HOOKS="${EBUILD_DEATH_HOOKS} java-pkg_die"
2589 fi
2590
2591 java-pkg_die() {
2592 echo "!!! When you file a bug report, please include the following information:" >&2
2593 echo "GENTOO_VM=${GENTOO_VM} CLASSPATH=\"${CLASSPATH}\" JAVA_HOME=\"${JAVA_HOME}\"" >&2
2594 echo "JAVACFLAGS=\"${JAVACFLAGS}\" COMPILER=\"${GENTOO_COMPILER}\"" >&2
2595 echo "and of course, the output of emerge --info =${P}" >&2
2596 }
2597
2598
2599 # TODO document
2600 # List jars in the source directory, ${S}
2601 java-pkg_jar-list() {
2602 if [[ -n "${JAVA_PKG_DEBUG}" ]]; then
2603 einfo "Linked Jars"
2604 find "${S}" -type l -name '*.jar' -print0 | xargs -0 -r -n 500 ls -ald | sed -e "s,${WORKDIR},\${WORKDIR},"
2605 einfo "Jars"
2606 find "${S}" -type f -name '*.jar' -print0 | xargs -0 -r -n 500 ls -ald | sed -e "s,${WORKDIR},\${WORKDIR},"
2607 einfo "Classes"
2608 find "${S}" -type f -name '*.class' -print0 | xargs -0 -r -n 500 ls -ald | sed -e "s,${WORKDIR},\${WORKDIR},"
2609 fi
2610 }
2611
2612 # @FUNCTION: java-pkg_verify-classes
2613 # @INTERNAL
2614 # @DESCRIPTION:
2615 # Verify that the classes were compiled for the right source / target. Dies if
2616 # not.
2617 # @CODE
2618 # $1 (optional) - the file to check, otherwise checks whole ${D}
2619 # @CODE
2620 java-pkg_verify-classes() {
2621 #$(find ${D} -type f -name '*.jar' -o -name '*.class')
2622
2623 local version_verify="/usr/bin/class-version-verify.py"
2624
2625 if [[ ! -x "${version_verify}" ]]; then
2626 version_verify="/usr/$(get_libdir)/javatoolkit/bin/class-version-verify.py"
2627 fi
2628
2629 if [[ ! -x "${version_verify}" ]]; then
2630 ewarn "Unable to perform class version checks as"
2631 ewarn "class-version-verify.py is unavailable"
2632 ewarn "Please install dev-java/javatoolkit."
2633 return
2634 fi
2635
2636 local target=$(java-pkg_get-target)
2637 local result
2638 local log="${T}/class-version-verify.log"
2639 if [[ -n "${1}" ]]; then
2640 ${version_verify} -v -t ${target} "${1}" > "${log}"
2641 result=$?
2642 else
2643 ebegin "Verifying java class versions (target: ${target})"
2644 ${version_verify} -v -t ${target} -r "${D}" > "${log}"
2645 result=$?
2646 eend ${result}
2647 fi
2648 [[ -n ${JAVA_PKG_DEBUG} ]] && cat "${log}"
2649 if [[ ${result} != 0 ]]; then
2650 eerror "Incorrect bytecode version found"
2651 [[ -n "${1}" ]] && eerror "in file: ${1}"
2652 eerror "See ${log} for more details."
2653 die "Incorrect bytecode found"
2654 fi
2655 }
2656
2657 # @FUNCTION: java-pkg_ensure-dep
2658 # @INTERNAL
2659 # @DESCRIPTION:
2660 # Check that a package being used in jarfrom, getjars and getjar is contained
2661 # within DEPEND or RDEPEND with the correct SLOT. See this mail for details:
2662 # https://archives.gentoo.org/gentoo-dev/message/dcb644f89520f4bbb61cc7bbe45fdf6e
2663 # @CODE
2664 # Parameters:
2665 # $1 - empty - check both vars; "runtime" or "build" - check only
2666 # RDEPEND, resp. DEPEND
2667 # $2 - Package name and slot.
2668 # @CODE
2669 java-pkg_ensure-dep() {
2670 debug-print-function ${FUNCNAME} $*
2671
2672 local limit_to="${1}"
2673 local target_pkg="${2}"
2674 local dev_error=""
2675
2676 # Transform into a regular expression to look for a matching package
2677 # and SLOT. SLOTs don't have to be numeric so foo-bar could either
2678 # mean foo-bar:0 or foo:bar. So you want to get your head around the
2679 # line below?
2680 #
2681 # * The target package first has any dots escaped, e.g. foo-1.2
2682 # becomes foo-1\.2.
2683 #
2684 # * sed then looks at the component following the last - or :
2685 # character, or the whole string if there is no - or :
2686 # character. It uses this to build a new regexp with two
2687 # significant branches.
2688 #
2689 # * The first checks for the whole target package string, optionally
2690 # followed by a version number, and then :0.
2691 #
2692 # * The second checks for the first part of the target package
2693 # string, optionally followed by a version number, followed by the
2694 # aforementioned component, treating that as a SLOT.
2695 #
2696 local stripped_pkg=/$(sed -r 's/[-:]?([^-:]+)$/(\0(-[^:]+)?:0|(-[^:]+)?:\1)/' <<< "${target_pkg//./\\.}")\\b
2697
2698 debug-print "Matching against: ${stripped_pkg}"
2699
2700 # Uncomment the lines below once we've dealt with more of these
2701 # otherwise we'll be tempted to turn JAVA_PKG_STRICT off while
2702 # getting hit with a wave of bug reports. :(
2703
2704 if [[ ${limit_to} != runtime && ! ( "${DEPEND}" =~ $stripped_pkg ) ]]; then
2705 dev_error="The ebuild is attempting to use ${target_pkg}, which is not "
2706 dev_error+="declared with a SLOT in DEPEND."
2707 # if is-java-strict; then
2708 # die "${dev_error}"
2709 # else
2710 eqawarn "java-pkg_ensure-dep: ${dev_error}"
2711 # eerror "Because you have ${target_pkg} installed,"
2712 # eerror "the package will build without problems, but please"
2713 # eerror "report this to http://bugs.gentoo.org."
2714 # fi
2715 elif [[ ${limit_to} != build && ! ( "${RDEPEND}${PDEPEND}" =~ ${stripped_pkg} ) ]]; then
2716 dev_error="The ebuild is attempting to use ${target_pkg}, which is not "
2717 dev_error+="declared with a SLOT in [RP]DEPEND and --build-only wasn't given."
2718 # if is-java-strict; then
2719 # die "${dev_error}"
2720 # else
2721 eqawarn "java-pkg_ensure-dep: ${dev_error}"
2722 # eerror "The package will build without problems, but may fail to run"
2723 # eerror "if you don't have ${target_pkg} installed,"
2724 # eerror "so please report this to http://bugs.gentoo.org."
2725 # fi
2726 fi
2727 }
2728
2729 java-pkg_check-phase() {
2730 local phase=${1}
2731 local funcname=${FUNCNAME[1]}
2732 if [[ ${EBUILD_PHASE} != ${phase} ]]; then
2733 local msg="${funcname} used outside of src_${phase}"
2734 java-pkg_announce-qa-violation "${msg}"
2735 fi
2736 }
2737
2738 java-pkg_check-versioned-jar() {
2739 local jar=${1}
2740
2741 if [[ ${jar} =~ ${PV} ]]; then
2742 java-pkg_announce-qa-violation "installing versioned jar '${jar}'"
2743 fi
2744 }
2745
2746 java-pkg_check-jikes() {
2747 if has jikes ${IUSE}; then
2748 java-pkg_announce-qa-violation "deprecated USE flag 'jikes' in IUSE"
2749 fi
2750 }
2751
2752 java-pkg_announce-qa-violation() {
2753 local nodie
2754 if [[ ${1} == "--nodie" ]]; then
2755 nodie="true"
2756 shift
2757 fi
2758 echo "Java QA Notice: $@" >&2
2759 increment-qa-violations
2760 [[ -z "${nodie}" ]] && is-java-strict && die "${@}"
2761 }
2762
2763 increment-qa-violations() {
2764 let "JAVA_PKG_QA_VIOLATIONS+=1"
2765 export JAVA_PKG_QA_VIOLATIONS
2766 }
2767
2768 is-java-strict() {
2769 [[ -n ${JAVA_PKG_STRICT} ]]
2770 return $?
2771 }

  ViewVC Help
Powered by ViewVC 1.1.20