from __future__ import annotations import os import shutil import subprocess from pathlib import Path from briefcase.exceptions import ( BriefcaseCommandError, IncompatibleToolError, MissingToolError, ) from briefcase.integrations.base import ManagedTool, ToolCache class JDK(ManagedTool): name = "java" full_name = "Java JDK" # Latest OpenJDK as of January 2025: https://adoptium.net/temurin/releases/ JDK_MAJOR_VER = "17" JDK_RELEASE = "17.0.15" JDK_BUILD = "6" JDK_INSTALL_DIR_NAME = f"java{JDK_MAJOR_VER}" def __init__(self, tools: ToolCache, java_home: Path): super().__init__(tools=tools) self.java_home = java_home @property def OpenJDK_download_url(self): """The OpenJDK download URL appropriate for the current machine.""" system_arch = self.tools.host_arch # use a 32bit JDK if using 32bit Python on 64bit hardware if self.tools.is_32bit_python and self.tools.host_arch == "aarch64": system_arch = "armv7l" try: platform, arch, extension = { "Darwin": { "arm64": ("mac", "aarch64", "tar.gz"), "x86_64": ("mac", "x64", "tar.gz"), }, "Linux": { "armv7l": ("linux", "arm", "tar.gz"), "armv8l": ("linux", "arm", "tar.gz"), "aarch64": ("linux", "aarch64", "tar.gz"), "x86_64": ("linux", "x64", "tar.gz"), }, "Windows": { "AMD64": ("windows", "x64", "zip"), }, }[self.tools.host_os][system_arch] except KeyError as e: raise IncompatibleToolError(tool=self.full_name, env_var="JAVA_HOME") from e return ( f"https://github.com/adoptium/temurin{self.JDK_MAJOR_VER}-binaries/" f"releases/download/jdk-{self.JDK_RELEASE}+{self.JDK_BUILD}/" f"OpenJDK{self.JDK_MAJOR_VER}U-jdk_{arch}_{platform}_hotspot_" f"{self.JDK_RELEASE}_{self.JDK_BUILD}.{extension}" ) @classmethod def version_from_path(cls, tools: ToolCache, java_path: str | Path) -> str: """Return a JDK's version from a path by running ``/bin/javac``. This will fail if the path contains a JRE instead of a JDK. Several exceptions can be raised for issues: - OSError - the ``javac`` executable doesn't exist - CalledProcessError - ``javac`` returned a non-zero value - IndexError - unparsable version value from ``javac`` :param tools: ToolCache of available tools :param java_path: File path to a candidate JDK install :return: JDK release version; e.g. "17.0.X" """ output = tools.subprocess.check_output( [Path(java_path) / "bin/javac", "-version"] ) # javac's output should look like "javac 17.0.X\n" return output.strip("\n").split(" ")[1] @classmethod def verify_install(cls, tools: ToolCache, install: bool = True, **kwargs) -> JDK: """Verify that a Java JDK exists. If ``JAVA_HOME`` is set, try that version. If it is a JRE, or its *not* a Java JDK, download one. On macOS, also try invoking /usr/libexec/java_home. If that location points to a Java JDK, use it. Otherwise, download a JDK from OpenJDK and unpack it into the briefcase data directory. :param tools: ToolCache of available tools :param install: Should the tool be installed if it is not found? :returns: A valid Java JDK wrapper. If a JDK is not available, and was not installed, raises MissingToolError. """ # short circuit since already verified and available if hasattr(tools, "java"): return tools.java java = None install_message = None if java_home := tools.os.environ.get("JAVA_HOME", ""): tools.console.debug("Evaluating JAVA_HOME...", prefix=cls.full_name) tools.console.debug(f"JAVA_HOME={java_home}") try: version_str = cls.version_from_path(tools, java_home) if version_str.split(".")[0] == cls.JDK_MAJOR_VER: java = JDK(tools, java_home=Path(java_home)) else: install_message = f""" ************************************************************************* ** WARNING: JAVA_HOME does not point to a Java {cls.JDK_MAJOR_VER} JDK ** ************************************************************************* Android requires a Java {cls.JDK_MAJOR_VER} JDK, but the location pointed to by the JAVA_HOME environment variable: {java_home} isn't a Java {cls.JDK_MAJOR_VER} JDK (it appears to be Java {version_str}). Briefcase will proceed using its own JDK instance. ************************************************************************* """ except OSError: install_message = f""" ************************************************************************* ** WARNING: JAVA_HOME does not point to a JDK ** ************************************************************************* The location pointed to by the JAVA_HOME environment variable: {java_home} does not appear to be a JDK. It may be a Java Runtime Environment. If JAVA_HOME is a JDK, ensure it is the root directory of the JDK instance such that $JAVA_HOME/bin/javac is a valid filepath. Briefcase will proceed using its own JDK instance. ************************************************************************* """ except subprocess.CalledProcessError: install_message = f""" ************************************************************************* ** WARNING: Unable to invoke the Java compiler ** ************************************************************************* Briefcase received an unexpected error when trying to invoke javac, the Java compiler, at the location indicated by the JAVA_HOME environment variable. Briefcase will continue by downloading and using its own JDK. Please report this as a bug at: https://github.com/beeware/briefcase/issues/new In your report, please including the output from running: {java_home}/bin/javac -version from the command prompt. ************************************************************************* """ except IndexError: install_message = f""" ************************************************************************* ** WARNING: Unable to determine the version of Java that is installed ** ************************************************************************* Briefcase was unable to interpret the version information returned by the Java compiler at the location indicated by the JAVA_HOME environment variable. Briefcase will continue by downloading and using its own JDK. Please report this as a bug at: https://github.com/beeware/briefcase/issues/new In your report, please including the output from running: {java_home}/bin/javac -version from the command prompt. ************************************************************************* """ # macOS has a helpful system utility to determine JAVA_HOME. Try it. elif tools.host_os == "Darwin": tools.console.debug( "Evaluating /usr/libexec/java_home...", prefix=cls.full_name ) try: # If /usr/libexec/java_home doesn't exist, OSError will be raised # If no JRE/JDK is installed, /usr/libexec/java_home raises an error java_home = tools.subprocess.check_output( ["/usr/libexec/java_home"], quiet=1, ).strip("\n") except (OSError, subprocess.CalledProcessError): tools.console.debug("An existing JDK/JRE was not returned") else: try: version_str = cls.version_from_path(tools, java_home) if version_str.split(".")[0] == cls.JDK_MAJOR_VER: java = JDK(tools, java_home=Path(java_home)) except (OSError, subprocess.CalledProcessError, IndexError): pass # do not alert user if macOS found an unqualified JDK if java is None: # Inform the user if the user-specified JDK wasn't valid if install_message: tools.console.warning(install_message) # Use the Briefcase JDK install java_home = tools.base_path / cls.JDK_INSTALL_DIR_NAME # The macOS download has a weird layout (inherited from the official Oracle # release). The actual JAVA_HOME is deeper inside the directory structure. if tools.host_os == "Darwin": java_home = java_home / "Contents/Home" java = JDK(tools=tools, java_home=java_home) if not java.exists(): if install: tools.console.info( f"A Java {cls.JDK_MAJOR_VER} JDK was not found; downloading and installing...", prefix=cls.name, ) tools.console.info( f"To use an existing JDK {cls.JDK_MAJOR_VER} instance, " f"specify its root directory path in the JAVA_HOME environment variable." ) tools.console.info() java.install() else: raise MissingToolError("Java") tools.console.debug(f"Using JDK at {java.java_home}") tools.java = java return java def exists(self) -> bool: return (self.java_home / "bin").exists() @property def managed_install(self) -> bool: try: # Determine if java_home is relative to the briefcase data directory. # If java_home isn't inside this directory, this will raise a ValueError, # indicating it is a non-managed install. self.java_home.relative_to(self.tools.base_path) return True except ValueError: return False def install(self): """Download and install a JDK.""" jdk_zip_path = self.tools.file.download( url=self.OpenJDK_download_url, download_path=self.tools.base_path, role=f"Java {self.JDK_MAJOR_VER} JDK", ) with self.tools.console.wait_bar("Installing OpenJDK..."): try: self.tools.file.unpack_archive( os.fsdecode(jdk_zip_path), extract_dir=os.fsdecode(self.tools.base_path), ) except (shutil.ReadError, EOFError) as e: raise BriefcaseCommandError( f"""\ Unable to unpack OpenJDK ZIP file. The download may have been interrupted or corrupted. Delete {jdk_zip_path} and run briefcase again. """ ) from e jdk_zip_path.unlink() # Zip file no longer needed once unpacked. # The tarball will unpack into /tools/jdk-17.0.X+7 # (or whatever name matches the current release). # We turn this into /tools/java so we have a consistent name. java_unpack_path = ( self.tools.base_path / f"jdk-{self.JDK_RELEASE}+{self.JDK_BUILD}" ) java_unpack_path.rename(self.tools.base_path / self.JDK_INSTALL_DIR_NAME) def uninstall(self): """Uninstall a JDK.""" try: with self.tools.console.wait_bar("Removing old JDK install..."): if self.tools.host_os == "Darwin": jdk_location = self.java_home.parent.parent else: jdk_location = self.java_home self.tools.shutil.rmtree(jdk_location) except PermissionError as e: raise BriefcaseCommandError( f"""\ Permission denied when trying to remove {jdk_location!r} Ensure no Java processes are running and try again. """ ) from e