/[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.156 - (show annotations) (download)
Wed Apr 9 21:55:12 2014 UTC (3 months ago) by radhermit
Branch: MAIN
CVS Tags: HEAD
Changes since 1.155: +3 -3 lines
Only refer to DESTTREE within the src_install phase.

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

  ViewVC Help
Powered by ViewVC 1.1.20