R/binman_utils.R

In ropensci/binman: A Binary Download Manager

#' List app versions
#'
#' List app versions by platform
#'
#' @param appname A character string giving the name of the application
#' @param platform A character vector of platforms to list. Defaults to
#'     "ALL"
#'
#' @return A list of platforms with version directories
#' @export
#'
#' @examples
#' \dontrun{
#' appdir <- app_dir("superduperapp", FALSE)
#' platforms <- LETTERS[1:4]
#' versions <- LETTERS[5:7]
#' mkdirs <- file.path(appdir, outer(platforms, versions, file.path))
#' chk <- vapply(mkdirs, dir.create, logical(1), recursive = TRUE)
#' expect_true(all(chk))
#' res <- list_versions("superduperapp")
#' unlink(appdir, recursive = TRUE)
#' }
#'
list_versions <- function(appname, platform = c("ALL")) {
  assert_that(is_string(appname))
  assert_that(is_character(platform))
  appdir <- app_dir(appname)
  platforms <- list.dirs(appdir, full.names = FALSE, recursive = FALSE)
  platforms <- if (!identical(platform, "ALL")) {
    platind <- platforms %in% platform
    if (!any(platind)) {
      stop(
        "No platforms found for ", appname, " in ",
        paste(platform, collapse = ",")
      )
    }
    platforms[platind]
  } else {
    platforms
  }
  res <- lapply(platforms, function(platform) {
    list.dirs(file.path(appdir, platform),
      full.names = FALSE,
      recursive = FALSE
    )
  })
  setNames(res, platforms)
}

#' Remove application platform
#'
#' Remove application files/directories for a given platform
#'
#' @param appname A character string giving the name of the application
#' @param platform A character vector indicating the platform to remove.
#'     Defaults to "ALL"
#'
#' @return Returns a logical vector indicating whether the removal of
#'     platform was successful. Return is invisible.
#' @export
#'
#' @examples
#' \dontrun{
#' appdir <- app_dir(appname, FALSE)
#' platforms <- LETTERS[1:4]
#' versions <- LETTERS[5:7]
#' mkdirs <- file.path(appdir, outer(platforms, versions, file.path))
#' chk <- vapply(mkdirs, dir.create, logical(1), recursive = TRUE)
#' appver <- list_versions(appname)
#' rm_platform(appname, platforms[2:3])
#' unlink(appdir, recursive = TRUE)
#' }
#'
rm_platform <- function(appname, platform = c("ALL")) {
  assert_that(is_string(appname))
  assert_that(is_character(platform))
  appdir <- app_dir(appname)
  platforms <- list.dirs(appdir, full.names = FALSE, recursive = FALSE)
  platforms <- if (!identical(platform, "ALL")) {
    platind <- platforms %in% platform
    if (!any(platind)) {
      stop(
        "No platforms found for ", appname, " in ",
        paste(platform, collapse = ",")
      )
    }
    platforms[platind]
  } else {
    platforms
  }
  res <- vapply(platforms, function(platform) {
    dirpath <- file.path(appdir, platform)
    message("Removing platform: ", platform)
    unlink(dirpath, recursive = TRUE)
  }, integer(1))
  invisible(!as.logical(res))
}


#' Remove application version
#'
#' Remove application version for a given platform
#'
#' @param appname A character string giving the name of the application
#' @param platform A character string indicating the platform.
#' @param version A character vector of versions to remove. Defaults to
#'     "ALL"
#'
#' @return Returns a logical vector indicating whether the removal of
#'     version was successful. Return is invisible.
#' @export
#'
#' @examples
#' \dontrun{
#' appdir <- app_dir(appname, FALSE)
#' platforms <- LETTERS[1:4]
#' versions <- LETTERS[5:7]
#' mkdirs <- file.path(appdir, outer(platforms, versions, file.path))
#' chk <- vapply(mkdirs, dir.create, logical(1), recursive = TRUE)
#' appver <- list_versions(appname)
#' rm_version(appname, platforms[2], versions[1:2])
#' unlink(appdir, recursive = TRUE)
#' }
#'
rm_version <- function(appname, platform, version = c("ALL")) {
  assert_that(is_string(appname))
  assert_that(is_string(platform))
  assert_that(is_character(version))
  appdir <- app_dir(appname)
  versions <- list_versions(appname, platform)[[platform]]
  versions <- if (!identical(version, "ALL")) {
    verind <- versions %in% version
    if (!any(verind)) {
      stop(
        "No versions found for ", appname, " in ",
        paste(version, collapse = ",")
      )
    }
    versions[verind]
  } else {
    versions
  }
  res <- vapply(versions, function(version) {
    dirpath <- file.path(appdir, platform, version)
    message("Removing version: ", version, " from platorm: ", platform)
    unlink(dirpath, recursive = TRUE)
  }, integer(1))
  invisible(!as.logical(res))
}

#' Get application directory
#'
#' Get application directory
#'
#' @param appname A character string giving the name of the application
#' @param check check whether the app given by appname exists or not.
#'
#' @return A character string giving the path of the directory
#' @export
#'
#' @examples
#' \dontrun{
#' appdir <- app_dir("superduperapp", FALSE)
#' }
#'
app_dir <- function(appname, check = TRUE) {
  assert_that(is_string(appname))
  assert_that(is_logical(check))
  appdir <- rappdirs::user_data_dir(paste0("binman_", appname), "binman")
  if (check) {
    assert_that(app_dir_exists(appdir))
  }
  invisible(appdir)
}