major internal rework, sdkman

Author: e-kotov

DESCRIPTION

@@ -49,11 +49,13 @@ Imports:
     checkmate,
     cli,
     curl,
-    jsonlite,
+    digest,
     memoise,
+    RcppSimdJson,
     rlang,
     utils,
-    withr
+    withr,
+    yaml
 Suggests: 
     callr,
     quarto,

NAMESPACE

@@ -6,6 +6,9 @@ export(java_check_compatibility)
 export(java_check_version_cmd)
 export(java_check_version_rjava)
 export(java_clear)
+export(java_clear_distrib)
+export(java_clear_installed)
+export(java_clear_project)
 export(java_download)
 export(java_ensure)
 export(java_env_set)
@@ -14,6 +17,10 @@ export(java_find_system)
 export(java_get_home)
 export(java_install)
 export(java_list)
+export(java_list_available)
+export(java_list_distrib)
+export(java_list_installed)
+export(java_list_project)
 export(java_quick_install)
 export(java_resolve)
 export(java_unpack)

R/global_params.R

@@ -72,3 +72,46 @@ rjava_path_locking_note <- function() {
 global_use_cache_param <- function(.use_cache) {
   # this is just a placeholder for global .use_cache parameter
 }
+
+#' @title Global Version Parameter
+#'
+#' @description
+#' Documentation for the `version` parameter, used for specifying Java versions.
+#'
+#' @param version Java version specification. Accepts:
+#'   \itemize{
+#'     \item **Major version** (e.g., `21`, `17`): Downloads the latest release for that major version.
+#'     \item **Specific version** (e.g., `"21.0.9"`, `"11.0.29"`): Downloads the exact version.
+#'     \item **SDKMAN identifier** (e.g., `"25.0.1-amzn"`, `"24.0.2-open"`): Uses the SDKMAN
+#'       backend automatically. When an identifier is detected, the `distribution` and `backend`
+#'       arguments are **ignored** and derived from the identifier. Find available identifiers
+#'       in the `identifier` column of \code{\link{java_list_available}(backend = "sdkman")}.
+#'   }
+#' @keywords internal
+global_version_param <- function(version) {
+  # this is just a placeholder for global version parameter
+}
+
+#' @title SDKMAN References
+#'
+#' @description
+#' Standard references for SDKMAN attribution.
+#'
+#' @references
+#' SDKMAN! - The Software Development Kit Manager: \url{https://github.com/sdkman}
+#' @keywords internal
+global_sdkman_references <- function() {
+  # this is just a placeholder for SDKMAN references
+}
+
+#' @title Global Backend Parameter
+#'
+#' @description
+#' Documentation for the `backend` parameter, used for specifying the download source.
+#'
+#' @param backend Download backend to use. One of "native" (vendor APIs) or "sdkman".
+#'   Defaults to "native". Can also be set globally via `options(rJavaEnv.backend = "sdkman")`.
+#' @keywords internal
+global_backend_param <- function(backend) {
+  # this is just a placeholder for global backend parameter
+}

R/internal_utilities.R

@@ -57,7 +57,33 @@ java_urls_load <- function() {
   if (json_file == "") {
     cli::cli_abort("Configuration file not found")
   }
-  jsonlite::fromJSON(json_file, simplifyVector = FALSE)
+  RcppSimdJson::fload(json_file, max_simplify_lvl = "list")
+}
+
+#' Read JSON from a URL
+#'
+#' Helper function to read JSON from a URL using RcppSimdJson for fast parsing
+#'
+#' @param url URL to read JSON from
+#' @param max_simplify_lvl Simplification level (default: "data_frame")
+#' @return Parsed JSON object
+#' @keywords internal
+read_json_url <- function(url, max_simplify_lvl = "data_frame") {
+  content <- rawToChar(curl::curl_fetch_memory(url)$content)
+  RcppSimdJson::fparse(content, max_simplify_lvl = max_simplify_lvl)
+}
+
+#' Read lines from a URL or file
+#'
+#' Helper function to read lines, mainly for testability.
+#'
+#' @param path Path or URL
+#' @param warn Logical. Whether to warn.
+#' @return Character vector of lines
+#' @keywords internal
+#' @noRd
+rje_read_lines <- function(path, warn = FALSE) {
+  readLines(path, warn = warn)
 }
 
 #' Test all Java URLs

R/java_download.R

@@ -1,13 +1,15 @@
 #' Download a Java distribution
 #'
-#' @param version `Integer` or `character` vector of length 1 for major version of Java to download or install. If not specified, defaults to the latest LTS version. Can be "8", and "11" to "24" (or the same version numbers in `integer`) or any newer version if it is available for the selected distribution. For `macOS` on `aarch64` architecture (Apple Silicon) certain `Java` versions are not available.
-#' @param distribution The Java distribution to download. If not specified, defaults to "Amazon Corretto". Currently only \href{https://aws.amazon.com/corretto/}{"Amazon Corretto"} is supported.
+#' @inheritParams global_version_param
+#' @param distribution The Java distribution to download. One of "Corretto", "Temurin", or "Zulu". Defaults to "Corretto". Ignored if `version` is a SDKMAN identifier.
+#' @inheritParams global_backend_param
 #' @param cache_path The destination directory to download the Java distribution to. Defaults to a user-specific data directory.
 #' @param platform The platform for which to download the Java distribution. Defaults to the current platform.
 #' @param arch The architecture for which to download the Java distribution. Defaults to the current architecture.
 #' @param force A logical. Whether the distribution file should be overwritten or not. Defaults to `FALSE`.
 #' @param temp_dir A logical. Whether the file should be saved in a temporary directory. Defaults to `FALSE`.
 #' @inheritParams global_quiet_param
+#' @inheritParams global_sdkman_references
 #'
 #' @return The path to the downloaded Java distribution file.
 #' @export
@@ -20,18 +22,22 @@
 #'
 #' # download default Java distribution (version 21)
 #' java_download(temp_dir = TRUE)
+#'
+#' # download using SDKMAN backend
+#' java_download(version = "21", backend = "sdkman", temp_dir = TRUE)
 #' }
 java_download <- function(
   version = 21,
   distribution = "Corretto",
+  backend = getOption("rJavaEnv.backend", "native"),
   cache_path = getOption("rJavaEnv.cache_path"),
   platform = platform_detect()$os,
   arch = platform_detect()$arch,
   quiet = FALSE,
   force = FALSE,
   temp_dir = FALSE
 ) {
-  # override cache_path if temp_dir is set to TRUE
+  # Override cache_path if temp_dir is set to TRUE
   if (temp_dir) {
     temp_dir <- tempdir()
     setwd(temp_dir)
@@ -41,45 +47,35 @@ java_download <- function(
     cache_path <- file.path(temp_dir, "rJavaEnv_cache")
   }
 
-  # rje_consent_check() # disabling consent check for now
-  java_urls <- java_urls_load()
-
-  valid_distributions <- names(java_urls)
-  valid_platforms <- names(java_urls[[distribution]])
-  valid_architectures <- names(java_urls[[distribution]][[platform]])
-
-  # Checks for the parameters
-  checkmate::check_vector(version, len = 1)
+  # Validate version
   version <- as.character(version)
+  checkmate::check_vector(version, len = 1)
 
-  # Optimized validation: check fast list first, only hit network if needed
-  if (!version %in% java_valid_versions_fast()) {
-    # Version not in fast/offline list, check if it's a new version online
-    checkmate::assert_choice(
-      version,
-      java_valid_versions(
-        distribution = distribution,
-        platform = platform,
-        arch = arch
+  # Auto-detect SDKMAN identifier
+  if (is_sdkman_identifier(version)) {
+    if (!quiet) {
+      cli::cli_alert_info(
+        "Detected SDKMAN identifier {.val {version}}. Using sdkman backend."
       )
-    )
+    }
+    backend <- "sdkman"
+    distribution <- sdkman_vendor_to_distribution(sdkman_vendor_code(version))
+    if (!quiet) {
+      cli::cli_alert_info("Distribution: {.val {distribution}}")
+    }
   }
 
-  checkmate::assert_choice(distribution, valid_distributions)
-
-  # Create the distrib subfolder within the destination directory
-  cache_path <- file.path(cache_path, "distrib")
-  if (!dir.exists(cache_path)) {
-    dir.create(cache_path, recursive = TRUE)
+  # Validate distribution (only for native backend)
+  if (backend == "native") {
+    valid_distributions <- c("Corretto", "Temurin", "Zulu")
+    checkmate::assert_choice(distribution, valid_distributions)
   }
-  checkmate::assert_directory_exists(cache_path, access = "rw", add = TRUE)
 
-  checkmate::assert_choice(platform, valid_platforms)
-  checkmate::assert_choice(arch, valid_architectures)
-  checkmate::assert_flag(quiet)
-  checkmate::assert_flag(force)
+  # Validate backend
+  valid_backends <- c("native", "sdkman")
+  checkmate::assert_choice(backend, valid_backends)
 
-  # Print out the detected platform and architecture
+  # Print detected platform and architecture
   if (!quiet) {
     cli::cli_inform(c(
       "Detected platform: {.strong {platform}}",
@@ -88,91 +84,94 @@ java_download <- function(
     ))
   }
 
-  if (!distribution %in% names(java_urls)) {
-    cli::cli_abort(
-      "Unsupported distribution: {.val {distribution}}",
-      .envir = environment()
-    )
-  }
-
-  if (!platform %in% names(java_urls[[distribution]])) {
-    cli::cli_abort(
-      "Unsupported platform: {.val {platform}}",
-      .envir = environment()
-    )
-  }
+  # Resolve metadata
+  build <- resolve_java_metadata(version, distribution, platform, arch, backend)
 
-  if (!arch %in% names(java_urls[[distribution]][[platform]])) {
-    cli::cli_abort(
-      "Unsupported architecture: {.val {arch}}",
-      .envir = environment()
-    )
+  # Prepare destination directory
+  dest_dir <- file.path(cache_path, "distrib")
+  if (!dir.exists(dest_dir)) {
+    dir.create(dest_dir, recursive = TRUE)
   }
+  dest <- file.path(dest_dir, build$filename)
 
-  url_template <- java_urls[[distribution]][[platform]][[arch]]
-  url <- gsub("\\{version\\}", version, url_template)
-  url_md5 <- gsub("latest/", "latest_checksum/", url)
+  # Download and verify
+  result_path <- download_java_with_checksum(build, dest, quiet, force)
 
-  dest_file <- file.path(cache_path, basename(url))
-  dest_file_md5 <- paste0(file.path(cache_path, basename(url_md5)), ".md5")
+  # Attach metadata attributes for downstream functions
+  attr(result_path, "distribution") <- distribution
+  attr(result_path, "backend") <- backend
+  attr(result_path, "version") <- version
+  attr(result_path, "platform") <- platform
+  attr(result_path, "arch") <- arch
 
-  if (!quiet) {
-    cli::cli_inform(
-      "Downloading Java {version} ({distribution}) for {platform} {arch} to {dest_file}",
-      .envir = environment()
-    )
-  }
+  result_path
+}
 
-  if (file.exists(dest_file) & !force) {
+#' Download and verify checksum
+#'
+#' Internal function to download a Java distribution and verify its checksum
+#'
+#' @param build A java_build object containing download metadata
+#' @param dest Destination file path
+#' @param quiet Logical, suppress messages
+#' @param force Logical, overwrite existing files
+#'
+#' @return Path to downloaded file
+#' @keywords internal
+download_java_with_checksum <- function(build, dest, quiet, force) {
+  # Check if file already exists
+  if (file.exists(dest) && !force) {
     if (!quiet) {
-      cli::cli_inform(
-        "File already exists. Skipping download.",
-        .envir = environment()
-      )
+      cli::cli_inform("File already cached: {basename(dest)}")
     }
-    return(dest_file)
+    return(dest)
   }
 
-  if (file.exists(dest_file) & force) {
+  # Remove existing file if force=TRUE
+  if (file.exists(dest) && force) {
     if (!quiet) {
-      cli::cli_inform("Removing existing installation.", .envir = environment())
+      cli::cli_inform("Removing existing file...")
     }
-    file.remove(dest_file)
+    unlink(dest)
   }
 
-  download_dist_with_md5_check(url, dest_file, url_md5, dest_file_md5, quiet)
-
-  return(dest_file)
-}
-
-# Helper function to download a distribution and verify its MD5 checksum
-download_dist_with_md5_check <- function(
-  url,
-  dest_file,
-  url_md5,
-  dest_file_md5,
-  quiet
-) {
-  # Perform downloads
-  curl::curl_download(url, dest_file, quiet = quiet)
-  curl::curl_download(url_md5, dest_file_md5, quiet = quiet)
-
+  # Download
   if (!quiet) {
-    cli::cli_inform("Download completed.")
+    cli::cli_inform("Downloading {build$vendor} Java {build$major}...")
   }
+  curl::curl_download(build$download_url, dest, quiet = quiet)
 
-  # Verify checksum
-  md5sum_actual <- tools::md5sum(dest_file)
-  md5sum_expected <- readLines(dest_file_md5, warn = FALSE)
+  # Verify checksum if available
+  if (!is.null(build$checksum) && !is.null(build$checksum_type)) {
+    if (!quiet) {
+      cli::cli_inform("Verifying {build$checksum_type} checksum...")
+    }
 
-  if (md5sum_actual != md5sum_expected) {
-    unlink(dest_file) # Clean up failed download
-    cli::cli_abort(
-      "MD5 checksum mismatch. Please try downloading the file again."
+    actual <- switch(
+      build$checksum_type,
+      "md5" = tools::md5sum(dest),
+      "sha256" = digest::digest(dest, algo = "sha256", file = TRUE),
+      "sha512" = digest::digest(dest, algo = "sha512", file = TRUE),
+      NULL
     )
-  }
 
-  if (!quiet) {
-    cli::cli_inform("MD5 checksum verified.")
+    if (!is.null(actual) && actual != build$checksum) {
+      unlink(dest)
+      cli::cli_abort("{build$checksum_type} checksum mismatch! File deleted.")
+    }
+
+    if (!quiet) cli::cli_inform("Checksum verified.")
+  } else if (build$backend == "sdkman") {
+    if (!quiet) {
+      cli::cli_alert_warning("Skipping checksum (unavailable for SDKMAN)")
+    }
   }
+
+  dest
+}
+
+#' Get extension for platform
+#' @keywords internal
+get_java_archive_extension <- function(platform) {
+  if (platform == "windows") "zip" else "tar.gz"
 }