cas_browse.R

#' Open in a browser a URL stored in the local database
#'
#' This function is typically used to check a web page when extracting links
#' from index, or contents from contents pages.
#'
#' @param remote Defaults to TRUE. If TRUE, opens relevant url online. If FALSE,
#'   it opens the locally stored file.
#' @param sample Defaults to 1. By default, it opens one random url.
#'
#' @inheritParams cas_download
#'
#' @return
#' @export
#'
#' @examples
cas_browse <- function(index = FALSE,
                       remote = TRUE,
                       id = NULL,
                       batch = NULL,
                       index_group = NULL,
                       file_format = "html",
                       sample = 1,
                       disconnect_db = TRUE,
                       ...) {
  type <- dplyr::if_else(condition = index,
    true = "index",
    false = "contents"
  )

  db <- cas_connect_to_db(
    read_only = TRUE,
    ...
  )

  if (remote == FALSE) {
    local_files <- cas_get_path_to_files(
      id = id,
      index = index,
      file_format = file_format,
      db_connection = db,
      sample = sample,
      disconnect_db = FALSE,
      ...
    )

    url_to_open_v <- local_files %>%
      dplyr::pull("path")
  } else {
    if (index == TRUE) {
      if (is.null(index_group)) {
        if (is.null(id)) {
          url_to_open_v <- cas_read_db_index(
            db_connection = db,
            ...
          ) %>%
            dplyr::slice_sample(n = sample) %>%
            dplyr::pull("url")
        } else {
          current_id <- id
          url_to_open_v <- cas_read_db_index(
            db_connection = db,
            ...
          ) %>%
            dplyr::filter(id == as.numeric(current_id)) %>%
            dplyr::pull("url")
        }
      } else {
        index_group_to_filter <- index_group

        url_to_open_v <- cas_read_db_index(
          db_connection = db,
          disconnect_db = FALSE,
          ...
        ) %>%
          dplyr::filter(index_group == index_group_to_filter) %>%
          dplyr::slice_sample(n = sample) %>%
          dplyr::pull("url")
      }
    } else {
      if (is.null(id) == FALSE) {
        current_id <- id
        url_to_open_v <- cas_read_db_contents_id(
          db_connection = db,
          disconnect_db = FALSE,
          ...
        ) %>%
          dplyr::filter(id == current_id) %>%
          dplyr::pull("url")
      } else {
        url_to_open_v <- cas_read_db_contents_id(
          db_connection = db,
          disconnect_db = FALSE,
          ...
        ) %>%
          dplyr::slice_sample(n = sample) %>%
          dplyr::pull("url")
      }
    }
  }

  cas_disconnect_from_db(
    db_connection = db,
    disconnect_db = disconnect_db
  )

  browseURL(url_to_open_v)
}