R/util.R

In conflr: Client for 'Confluence' API

# Copyright (C) 2019 LINE Corporation
#
# conflr is free software; you can redistribute it and/or modify it under the
# terms of the GNU General Public License as published by the Free Software
# Foundation, version 3.
#
# conflr is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
# A PARTICULAR PURPOSE. See <http://www.gnu.org/licenses/> for more details.


# Util
`%||%` <- function(lhs, rhs) {
  if (is.null(lhs)) rhs else lhs
}

`%|""|%` <- function(lhs, rhs) {
  if (is.null(lhs) || identical(lhs, "")) rhs else lhs
}

ask_secret <- function(message) {
  if (!interactive()) {
    abort("Please set up environmental variables before running non-interactive session.")
  }

  askpass::askpass(message)
}

ask_non_secret <- function(title, message, default = NULL) {
  if (!interactive()) {
    abort("Please set up environmental variables before running non-interactive session.")
  }

  if (rstudioapi::isAvailable()) {
    return(rstudioapi::showPrompt(title, message, default))
  }

  # Fallback to the readline
  readline(message)
}

ask_confluence_url <- function() ask_non_secret("URL", "Base URL of Confluence API: ", default = "https://")
ask_confluence_username <- function() ask_non_secret("Username", "Username for Confluence: ", default = "")
ask_confluence_password <- function() ask_secret("Password for Confluence: ")

confl_verb <- function(verb, path, ...) {
  base_url <- Sys.getenv("CONFLUENCE_URL") %|""|% ask_confluence_url()
  # remove trailing /
  base_url <- stringi::stri_replace_last_regex(base_url, "/$", "")
  # remove /rest/api
  base_url <- stringi::stri_replace_last_regex(base_url, "/rest/api$", "")

  username <- Sys.getenv("CONFLUENCE_USERNAME") %|""|% ask_confluence_username()
  password <- Sys.getenv("CONFLUENCE_PASSWORD") %|""|% ask_confluence_password()

  res <- httr::VERB(
    verb = verb,
    url = glue::glue("{base_url}/rest/api{path}"),
    httr::authenticate(username, password),
    ...
  )

  if (httr::status_code(res) >= 300) {
    abort(paste(
      httr::http_condition(res, type = "error"),
      httr::content(res)
    ))
  }

  Sys.setenv(CONFLUENCE_URL = base_url)
  Sys.setenv(CONFLUENCE_USERNAME = username)
  Sys.setenv(CONFLUENCE_PASSWORD = password)

  res
}

# TODO: should modify only inside img tags.
embed_images <- function(html_text, imgs, imgs_realpath) {
  for (i in seq_along(imgs)) {
    locs <- stringi::stri_locate_all_fixed(html_text, imgs[[i]])[[1]]
    for (loc in rev(split(locs, row(locs)))) {
      stringi::stri_sub(html_text, loc[1], loc[2]) <- knitr::image_uri(imgs_realpath[[i]])
    }
  }

  html_text
}

abort_if_null <- function(...) {
  x <- quos(..., .named = TRUE)
  nulls <- purrr::map_lgl(x, ~ is.null(eval_tidy(.)))
  null_variables <- names(x)[nulls]

  if (length(null_variables) == 0) {
    return(invisible(NULL))
  }

  null_variables <- glue::glue("`{null_variables}`")
  null_variables <- glue::glue_collapse(null_variables, sep = ", ", last = " and ")
  abort(glue::glue("Please provide {null_variables}!"))
}