/[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.163 - (show annotations) (download)
Mon Jun 15 21:09:06 2015 UTC (4 years, 1 month ago) by chewi
Branch: MAIN
Changes since 1.162: +32 -1 lines
Add java-pkg_addres function for adding resource files to an existing
jar.

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

  ViewVC Help
Powered by ViewVC 1.1.20