rgee2: Extra functions for R Google Earth Engine

.ee_extract <- function (x, y, fun = ee$Reducer$mean(), scale = NULL, sf = FALSE,
    via = "getInfo", container = "rgee_backup", dsn = NULL, lazy = FALSE,
    quiet = FALSE, ...)
{
    rgee:::ee_check_packages("ee_extract", c("geojsonio", "sf"))
    if (!quiet & is.null(scale)) {
        scale <- 1000
        message(sprintf("The image scale is set to %s.",
            scale))
    }
    if (!any(class(x) %in% rgee:::ee_get_spatial_objects("i+ic"))) {
        stop("x is neither an ee$Image nor ee$ImageCollection")
    }
    if (any(class(x) %in% "ee.imagecollection.ImageCollection")) {
        x <- ee$ImageCollection$toBands(x)
    }
    oauth_func_path <- system.file("python/ee_extract.py", package = "rgee")
    extract_py <- rgee:::ee_source_python(oauth_func_path)
    sp_objects <- rgee:::ee_get_spatial_objects("Table")
    if (!any(class(y) %in% c("sf", "sfc", sp_objects))) {
        stop("y is not a sf, sfc, ee$Geometry, ee$Feature or ee$FeatureCollection object.")
    }
    if (any("sf" %in% class(y))) {
        sf_y <- y
        ee_y <- sf_as_ee(y[["geometry"]], quiet = TRUE)
    }
    else if (any("sfc" %in% class(y))) {
        sf_y <- sf::st_sf(id = seq_along(y), geometry = y)
        ee_y <- sf_as_ee(y, quiet = TRUE)
    }
    else if (any(rgee:::ee_get_spatial_objects("Table") %in% class(y))) {
        ee_y <- ee$FeatureCollection(y)
        sf_y <- ee_as_sf(y, quiet = TRUE)
    }
    ee_add_rows <- function(f) {
        f_prop <- ee$Feature$get(f, "system:index")
        ee$Feature(ee$Feature$set(f, "ee_ID", f_prop))
    }
    ee_y <- ee$FeatureCollection(ee_y) %>% ee$FeatureCollection$map(ee_add_rows)
    fun_name <- gsub("Reducer.", "", (ee$Reducer$getInfo(fun))[["type"]])
    x_ic <- rgee:::bands_to_image_collection(x)
    create_tripplets <- function(img) {
        img_reduce_regions <- ee$Image$reduceRegions(image = img,
            collection = ee_y, reducer = fun, scale = scale, ...)
        ee$FeatureCollection$map(img_reduce_regions, function(f) {
            ee$Feature$set(f, "imageId", ee$Image$get(img, "system:index"))
        })
    }
    triplets <- x_ic %>% ee$ImageCollection$map(create_tripplets) %>%
        ee$ImageCollection$flatten()
    table <- extract_py$table_format(triplets, "ee_ID",
        "imageId", fun_name)$map(function(feature) {
        ee$Feature$setGeometry(feature, NULL)
    })

    if (is.null(dsn)) {
        table_id = basename(tempfile("rgee_file_"))
        dsn <- sprintf("%s/%s.csv", tempdir(), table_id)
    } else {
        table_id = basename(dsn) %>% gsub(".csv", "", .)
    }

    if (via %in% c("drive", "gcs"))  {
        ee_user <- ee_exist_credentials()
    }

    if (via == "drive") {
        table_task <- rgee2:::.ee_init_task_drive_fc(x_fc = table, dsn = dsn,
            container = container, table_id = table_id, ee_user = ee_user,
            selectors = NULL, timePrefix = FALSE, quiet = quiet)

        if (lazy) {
            prev_plan <- future::plan(future::sequential, .skip = TRUE)
            on.exit(future::plan(prev_plan, .skip = TRUE), add = TRUE)
            future::future({
                ee_extract_to_lazy_exp_drive(table_task, dsn, quiet, sf, sf_y)
            }, lazy = TRUE)
        } else {
            ee_extract_to_lazy_exp_drive(table_task, dsn, quiet, sf, sf_y)
        }
    } else if (via == "gcs") {
        table_task <- ee_init_task_gcs_fc(x_fc = table, dsn = dsn,
            container = container, table_id = table_id, ee_user = ee_user,
            selectors = NULL, timePrefix = TRUE, quiet = quiet)
        if (lazy) {
            prev_plan <- future::plan(future::sequential, .skip = TRUE)
            on.exit(future::plan(prev_plan, .skip = TRUE), add = TRUE)
            future::future({
                rgee:::ee_extract_to_lazy_exp_gcs(table_task, dsn, quiet,
                  sf, sf_y)
            }, lazy = TRUE)
        }
        else {
            ee_extract_to_lazy_exp_gcs(table_task, dsn, quiet,
                sf, sf_y)
        }
    }
    else {
        table_geojson <- table %>% ee$FeatureCollection$getInfo() %>%
            ee_utils_py_to_r()
        class(table_geojson) <- "geo_list"
        table_sf <- geojsonio::geojson_sf(table_geojson)
        sf::st_geometry(table_sf) <- NULL
        table_sf <- table_sf[, order(names(table_sf))]
        table_sf["id"] <- NULL
        table_sf["ee_ID"] <- NULL
        if (isTRUE(sf)) {
            table_geometry <- sf::st_geometry(sf_y)
            table_sf <- sf_y %>% sf::st_drop_geometry() %>% cbind(table_sf) %>%
                sf::st_sf(geometry = table_geometry)
        }
        else {
            table_sf <- sf_y %>% sf::st_drop_geometry() %>% cbind(table_sf)
        }
        table_sf
    }
}

.ee_init_task_drive_fc <- function(x_fc, dsn, container, table_id,
                                  ee_user, selectors, timePrefix, quiet) {
    # Create description (Human-readable name of the task)
    # Relevant for either drive or gcs.
    time_format <- format(Sys.time(), "%Y_%m_%d_%H_%M_%S")
    if (timePrefix) {
        ee_description <- time_format
        file_name <- paste0(table_id, "_", time_format)
    } else {
        ee_description <- table_id
        file_name <- table_id
    }

    # Are GD credentials loaded?
    if (is.na(ee_user$drive_cre)) {
        drive_credential <- rgee:::ee_create_credentials_drive(ee_user$email)
        rgee:::ee_save_credential(pdrive = drive_credential)
        # ee_Initialize(email = ee_user$email, drive = TRUE)
        message(
            "\nNOTE: Google Drive credentials were not loaded.",
            " Running ee_Initialize(email = '", ee_user$email, "', drive = TRUE)",
            " to fix."
        )
    }

    # The file format specified in dsn exist and it is suppoted by GEE?
    table_format <- rgee:::ee_get_table_format(dsn)
    if (is.na(table_format)) {
        stop(
            'sf_as_ee(..., via = \"drive\"), only support the ',
            'following output format: "CSV", "GeoJSON", "KML", "KMZ", "SHP"',
            ". Use ee_table_to_drive and ee_drive_to_local to save in a TFRecord format."
        )
    }

    table_task <- ee_table_to_drive(
        collection = x_fc,
        description = ee_description,
        folder = container,
        fileNamePrefix = file_name,
        fileFormat = table_format,
        selectors = selectors,
        timePrefix = FALSE
    )

    if (!quiet) {
        cat(
            "\n- download parameters (Google Drive)\n",
            "Table ID    :", table_id, "\n",
            "Google user :", ee_user[["email"]], "\n",
            "Folder name :", container, "\n",
            "Date        :", time_format, "\n"
        )
    }
    ee$batch$Task$start(table_task)
    table_task
}

environment(.ee_extract) <- environment(rgee::ee_extract)
# environment(.ee_init_task_drive_fc) <- environment(rgee::ee_extract)