R/get_version_info.R

In KWB-R/kwb.nextcloud: R Package for Accessing Nextcloud Using WebDAV API

# get_version_info ------------------------------------------------------------

#' Get Version Information on Files of Given IDs
#'
#' @param file_ids vector of integer representing file ids (values returned in
#'   column \code{fileid}) by \code{\link{list_files}}
#' @param user nextcloud user
#' @param ignore pattern matching columns to be excluded from the result. Set
#'   to \code{NULL} to see what columns are available.
#' @param dbg logical indicating whether or not to print debug messages
#' @return data frame with one row per version. There seems to be only an entry
#'   if the corresponding file as more than one version.
#' @importFrom kwb.utils catAndRun excludeNULL safeRowBindAll
#' @export
#'
get_version_info <- function(
  file_ids,
  user = nextcloud_user(),
  ignore = "^(status|quota|getcontent|resource)",
  dbg = TRUE
)
{
  #user <- "hsonne"

  results <- lapply(file_ids, function(fileid) {

    kwb.utils::catAndRun(
      paste("Getting version info for fileid =", fileid),
      get_one_version_info(fileid, ignore = ignore, user = user),
      dbg = dbg
    )
  })

  results <- kwb.utils::excludeNULL(results, dbg = FALSE)

  if (length(results) == 0L) {
    message("No versions available for given file IDs.")
    return()
  }

  rename_properties(kwb.utils::safeRowBindAll(results))
}

# get_one_version_info ---------------------------------------------------------

#' @importFrom kwb.utils isTryError orderBy selectColumns
#' @keywords internal
get_one_version_info <- function(
  fileid, ignore = NULL, user = nextcloud_user(), auth = nextcloud_auth(),
  silent = TRUE
)
{
  href <- fileid_to_version_href(fileid, user)

  result <- try(silent = silent, {

    content <- nextcloud_request(
      href, verb = "PROPFIND", auth = auth, body = NULL, as = "parsed"
    )

    info <- parse_xml_content(content)

    info <- info[kwb.utils::selectColumns(info, "resourcetype") != "list()", ]

    if (! is.null(x <- info$getlastmodified)) {

      info$getlastmodified <- to_posix(x)

      info <- kwb.utils::orderBy(info, "getlastmodified")
    }

    if (! is.null(ignore)) {

      info <- info[, ! grepl(ignore, names(info)), drop = FALSE]
    }

    n_versions <- nrow(info)

    cbind.data.frame(
      fileid = rep(fileid, n_versions),
      version = seq_len(n_versions),
      info,
      stringsAsFactors = FALSE
    )
  })

  if (kwb.utils::isTryError(result)) {
    return(NULL)
  }

  result
}