#
# utils.R
#
# Copyright (C) 2022-2025 Posit Software, PBC. All rights reserved.
#
#

#' @export
.ps.inspect <- function(item) {
    .Internal(inspect(item))
}

#' @export
.ps.objectId <- function(object) {
    .ps.Call("ps_object_id", object)
}

#' @export
.ps.recursiveSearch <- function(object, callback, ...) {
    result <- callback(object, ...)
    if (!is.null(result)) {
        return(result)
    }

    if (is.recursive(object)) {
        for (i in seq_along(object)) {
            result <- .ps.recursiveSearch(object[[i]], callback, ...)
            if (!is.null(result)) {
                return(result)
            }
        }
    }
}

#' @export
.ps.ark.version <- function() {
    # Read the version information from Ark
    ark_version <- .ps.Call("ps_ark_version")

    # Format the date into the current timezone for display
    if (nzchar(ark_version['date'])) {
        utc_date <- as.POSIXct(
            ark_version['date'],
            format = "%Y-%m-%dT%H:%M:%SZ",
            tz = "UTC"
        )
        local_date <- format(
            utc_date,
            format = "%Y-%m-%d %H:%M:%S",
            usetz = TRUE,
            tz = Sys.timezone()
        )
        ark_version['date'] <- local_date
    }

    ark_version
}

# Return the active (in flight) execute_request data structure; useful for
# inspecting what metadata has been sent from the front end.
#
# Internal utility; invoke with: `.ps.internal(active_request())`
active_request <- function() {
    .ps.Call("ps_get_active_request")
}

# Returns the current session mode: "console", "notebook", or "background".
session_mode <- function() {
    .ps.Call("ps_session_mode")
}

# Sleep that doesn't check for interrupts to test an unresponsive runtime.
#' @export
.ps.deep_sleep <- function(secs) {
    .ps.Call("ps_deep_sleep", secs)
}


# Converts an R object to JSON (returned as a string)
#' @export
.ps.to_json <- function(object) {
    .ps.Call("ps_to_json", object)
}

# Evaluate expression in positron's namespace (which includes access to the
# private modules). Any features accessible from `.ps.internal()` are
# subject to change without notice.
#
# If `expr` is a function call, the function is retrieved from the namespace
# but the call (and thus arguments) are evaluated in the calling frame.
#' @export
.ps.internal <- function(expr) {
    expr <- substitute(expr)
    ns <- parent.env(environment())

    if (is.call(expr)) {
        # We evaluate function calls in two different
        # environments.

        # Fist retrieve function from internal namespace
        expr[[1]] <- eval(expr[[1]], ns)

        # Now evaluate call and arguments in calling frame
        eval(expr, parent.frame())
    } else {
        # Simple symbols (and literals) are evaluated
        # in the namespace
        eval(expr, ns)
    }
}

# Alias for the Ark namespace, useful for `.ps.internal(ark_ns)`
ark_ns <- environment()

# From `rlang::env_name()`
#' @export
.ps.env_name <- function(env) {
    if (typeof(env) != "environment") {
        return(NULL)
    }

    if (identical(env, globalenv())) {
        return("global")
    }
    if (identical(env, baseenv())) {
        return("package:base")
    }
    if (identical(env, emptyenv())) {
        return("empty")
    }

    nm <- environmentName(env)

    if (isNamespace(env)) {
        return(paste0("namespace:", nm))
    }

    if (nzchar(nm)) {
        nm
    } else {
        NULL
    }
}

node_poke_cdr <- function(node, cdr) {
    .ps.Call("ark_node_poke_cdr", node, cdr)
}

# Detect if ark is running under a debug build or not
#
# - Debug: `cargo build`
# - Release: `cargo build --release`
is_debug_build <- function() {
    .ps.Call("ark_is_debug_build")
}

# Alias to make intent clear. We store values in symbols so they are reachable
# via `base::`.
base_bind <- function(sym, value) {
    stopifnot(is.symbol(sym))

    # The CDR corresponds to SYMVALUE
    node_poke_cdr(sym, value)
}

is_string <- function(x) {
    is.character(x) && length(x) == 1 && !is.na(x)
}

is_bool <- function(x) {
    is.logical(x) && length(x) == 1 && !is.na(x)
}

is_http_url <- function(x) {
    is_string(x) && grepl("^https?://", x)
}

obj_address <- function(x) {
    .ps.Call("ps_obj_address", x)
}

paste_line <- function(x) {
    paste(x, collapse = "\n")
}

set_names <- function(x, names = x) {
    names(x) <- names
    x
}

# From rlang
is_on_disk <- function(pkg) {
    system_path(pkg) != ""
}

system_path <- function(pkg) {
    # Important for this to be first because packages loaded with pkgload
    # will have a different path than the one in `.libPaths()` (if any).
    #
    # Note that this will not work for the base package, since we can't call
    # getNamespaceInfo on it.
    if (isNamespaceLoaded(pkg) && !identical(pkg, "base")) {
        return(.getNamespaceInfo(asNamespace(pkg), "path"))
    }

    for (path in file.path(.libPaths(), pkg)) {
        if (file.exists(path)) {
            return(path)
        }
    }

    ""
}

# Convert a file path to a file:// URI
path_to_file_uri <- function(path) {
    # `winslash` takes care of Windows backslashes
    path <- tryCatch(
        normalizePath(path, winslash = "/", mustWork = TRUE),
        error = function(e) NULL
    )
    if (is.null(path)) {
        return(NULL)
    }

    # On Windows, paths like "C:/foo" need to become "file:///C:/foo"
    # On Unix, paths like "/foo" need to become "file:///foo"

    # Detect Windows by drive letter pattern (e.g. "C:")
    if (grepl("^[A-Za-z]:", path)) {
        paste0("file:///", path)
    } else {
        paste0("file://", path)
    }
}


# `NULL` if successful, otherwise an error condition
try_load_namespace <- function(package) {
    tryCatch(
        expr = {
            loadNamespace(package)
            NULL
        },
        error = function(cnd) {
            cnd
        }
    )
}

log_cant_load_namespace <- function(package, cnd) {
    message <- conditionMessage(cnd)
    message <- sprintf(
        "Failed to load '%s' due to: %s",
        package,
        message
    )
    log_error(message)
}

log_trace <- function(msg) {
    stopifnot(is_string(msg))
    .Call("ark_log_trace", msg)
}

log_warning <- function(msg) {
    stopifnot(is_string(msg))
    .Call("ark_log_warning", msg)
}

log_error <- function(msg) {
    stopifnot(is_string(msg))
    .Call("ark_log_error", msg)
}

paste_line <- function(x) {
    paste0(x, collapse = "\n")
}
