Merge pull request #40 from KWB-R/dev

New release v0.4.0

Author: hsonne

.github/workflows/R-CMD-check.yaml

@@ -22,9 +22,9 @@ jobs:
       fail-fast: false
       matrix:
         config:
-          - {os: macOS-latest, r: 'release'}      
-          - {os: ubuntu-20.04, r: 'release', rspm: "https://packagemanager.rstudio.com/cran/__linux__/focal/latest"}      
-          - {os: windows-latest, r: 'devel'}          
+          - {os: macOS-latest, r: 'release'}
+          - {os: ubuntu-20.04, r: 'release', rspm: "https://packagemanager.rstudio.com/cran/__linux__/focal/latest"}
+          - {os: windows-latest, r: 'devel'}
           - {os: windows-latest, r: 'oldrel'}
           - {os: windows-latest, r: 'release'}
 
@@ -39,11 +39,11 @@ jobs:
     steps:
       - uses: actions/checkout@v2
 
-      - uses: r-lib/actions/setup-r@master
+      - uses: r-lib/actions/setup-r@v2
         with:
           r-version: ${{ matrix.config.r }}
 
-      - uses: r-lib/actions/setup-pandoc@master
+      - uses: r-lib/actions/setup-pandoc@v2
 
       - name: Query dependencies
         run: |
@@ -59,14 +59,6 @@ jobs:
           key: ${{ runner.os }}-r-${{ matrix.config.r }}-3-${{ hashFiles('depends.Rds') }}
           restore-keys: ${{ runner.os }}-r-${{ matrix.config.r }}-3-
 
-      - name: Install system dependencies
-        if: runner.os == 'Linux'
-        env:
-          RHUB_PLATFORM: linux-x86_64-ubuntu-gcc
-        run: |
-          Rscript -e "remotes::install_github('r-hub/sysreqs')"
-          sysreqs=$(Rscript -e "cat(sysreqs::sysreq_commands('DESCRIPTION'))")
-          sudo -s eval "$sysreqs"
       - name: Install dependencies
         run: |
           remotes::install_deps(dependencies = TRUE)
@@ -79,7 +71,7 @@ jobs:
 
       - name: Upload check results
         if: failure()
-        uses: actions/upload-artifact@master
+        uses: actions/upload-artifact@v4
         with:
           name: ${{ runner.os }}-r${{ matrix.config.r }}-results
           path: check

.github/workflows/pkgdown.yaml

@@ -18,9 +18,9 @@ jobs:
     steps:
       - uses: actions/checkout@v2
 
-      - uses: r-lib/actions/setup-r@master
+      - uses: r-lib/actions/setup-r@v2
 
-      - uses: r-lib/actions/setup-pandoc@master
+      - uses: r-lib/actions/setup-pandoc@v2
 
       - name: Query dependencies
         run: |

.github/workflows/pr-commands.yaml

@@ -11,10 +11,10 @@ jobs:
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
     steps:
       - uses: actions/checkout@v2
-      - uses: r-lib/actions/pr-fetch@master
+      - uses: r-lib/actions/pr-fetch@v2
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
-      - uses: r-lib/actions/setup-r@master
+      - uses: r-lib/actions/setup-r@v2
       - name: Install dependencies
         run: Rscript -e 'install.packages(c("remotes", "roxygen2"))' -e 'remotes::install_deps(dependencies = TRUE)'
       - name: Document
@@ -23,7 +23,7 @@ jobs:
         run: |
           git add man/\* NAMESPACE
           git commit -m 'Document'
-      - uses: r-lib/actions/pr-push@master
+      - uses: r-lib/actions/pr-push@v2
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
   style:
@@ -34,10 +34,10 @@ jobs:
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
     steps:
       - uses: actions/checkout@v2
-      - uses: r-lib/actions/pr-fetch@master
+      - uses: r-lib/actions/pr-fetch@v2
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
-      - uses: r-lib/actions/setup-r@master
+      - uses: r-lib/actions/setup-r@v2
       - name: Install dependencies
         run: Rscript -e 'install.packages("styler")'
       - name: Style
@@ -46,6 +46,6 @@ jobs:
         run: |
           git add \*.R
           git commit -m 'Style'
-      - uses: r-lib/actions/pr-push@master
+      - uses: r-lib/actions/pr-push@v2
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/test-coverage.yaml

@@ -21,9 +21,9 @@ jobs:
     steps:
       - uses: actions/checkout@v2
 
-      - uses: r-lib/actions/setup-r@master
+      - uses: r-lib/actions/setup-r@v2
 
-      - uses: r-lib/actions/setup-pandoc@master
+      - uses: r-lib/actions/setup-pandoc@v2
 
       - name: Query dependencies
         run: |

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: kwb.nextcloud
 Title: R Package for Accessing Nextcloud Using WebDAV API
-Version: 0.3.0
+Version: 0.4.0
 Authors@R: c(
     person("Michael", "Rustler", , "[email protected]", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0003-0647-7726")),
@@ -16,9 +16,9 @@ License: MIT + file LICENSE
 URL: https://github.com/KWB-R/kwb.nextcloud
 BugReports: https://github.com/KWB-R/kwb.nextcloud/issues
 Imports:
-    httr (>= 1.4.1),
+    httr (>= 1.4.6),
     kwb.file (>= 0.3.1),
-    kwb.utils (>= 0.6.0),
+    kwb.utils (>= 0.13.0),
     xml2 (>= 1.3.2)
 Suggests: 
     covr,
@@ -33,4 +33,4 @@ Remotes:
 Encoding: UTF-8
 LazyData: true
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.1.2
+RoxygenNote: 7.3.1

NAMESPACE

@@ -5,10 +5,13 @@ export(compare_file_info_files)
 export(create_folder)
 export(delete_file_or_folder)
 export(download_files)
+export(file_exists)
+export(get_file_versions)
 export(get_version_info)
 export(list_file_versions)
 export(list_files)
 export(move_file_or_folder)
+export(path_to_file_href)
 export(upload_file)
 importFrom(httr,GET)
 importFrom(httr,VERB)
@@ -17,18 +20,23 @@ importFrom(httr,headers)
 importFrom(httr,http_error)
 importFrom(kwb.file,remove_common_root)
 importFrom(kwb.utils,catAndRun)
+importFrom(kwb.utils,createDirectories)
 importFrom(kwb.utils,createDirectory)
 importFrom(kwb.utils,defaultIfNULL)
 importFrom(kwb.utils,excludeNULL)
+importFrom(kwb.utils,indent)
+importFrom(kwb.utils,isTryError)
 importFrom(kwb.utils,listToDepth)
 importFrom(kwb.utils,moveColumnsToFront)
 importFrom(kwb.utils,noFactorDataFrame)
 importFrom(kwb.utils,orderBy)
+importFrom(kwb.utils,removeLeadingSlashes)
 importFrom(kwb.utils,renameColumns)
 importFrom(kwb.utils,safeRowBindAll)
 importFrom(kwb.utils,selectColumns)
 importFrom(kwb.utils,stringList)
 importFrom(kwb.utils,toLookupList)
+importFrom(kwb.utils,uniqueDirnames)
 importFrom(utils,read.csv2)
 importFrom(utils,read.table)
 importFrom(utils,write.csv2)

NEWS.md

@@ -1,3 +1,13 @@
+# [kwb.nextcloud 0.4.0](https://github.com/KWB-R/kwb.nextcloud/releases/tag/v0.4.0) <small>2024-10-15</small>
+
+* Add `file_exists()`
+* Add `get_file_versions()`
+* Fix bug in `path_to_file_href()` that occurred when a user name contained 
+  spaces. Document and export this function.
+* `download_files()`: Add argument `dbg`
+* `get_version_info()`: Add argument `dbg`
+* Deprecate `list_file_versions()`
+
 # [kwb.nextcloud 0.3.0](https://github.com/KWB-R/kwb.nextcloud/releases/tag/v0.3.0) <small>2021-06-03</small>
 
 * Add `move_file_or_folder()`: see [Moving files and folders](https://docs.nextcloud.com/server/latest/developer_manual/client_apis/WebDAV/basic.html#moving-files-and-folders-rfc4918)

R/download_files.R

@@ -12,16 +12,18 @@
 #'   \code{kwb.nextcloud:::nextcloud_user}
 #' @param auth authentication as returned by
 #'   \code{kwb.nextcloud:::nextcloud_user}
-#' @importFrom kwb.utils defaultIfNULL
+#' @param dbg logical indicating whether or not to show debug messages
+#' @importFrom kwb.utils createDirectories defaultIfNULL uniqueDirnames
 #' @importFrom kwb.file remove_common_root
 #' @export
 #'
 download_files <- function(
   hrefs = NULL,
-  target_dir = create_download_dir("nextcloud_"),
+  target_dir = create_download_dir("nextcloud_", dbg = dbg),
   paths = NULL,
   user = nextcloud_user(),
-  auth = nextcloud_auth()
+  auth = nextcloud_auth(),
+  dbg = TRUE
 )
 {
   #kwb.utils::assignPackageObjects("kwb.nextcloud")
@@ -44,10 +46,13 @@ download_files <- function(
   }
 
   # Keep only the necessary tree structure
-  target_paths <- kwb.file::remove_common_root(paths_decoded)
+  target_paths <- kwb.file::remove_common_root(paths_decoded, dbg = FALSE)
 
   # Create required target folders
-  create_directories(file.path(target_dir, unique_dirnames(target_paths)))
+  kwb.utils::createDirectories(
+    file.path(target_dir, kwb.utils::uniqueDirnames(target_paths)),
+    dbg = dbg
+  )
 
   # Create the full paths to the target files
   target_files <- file.path(target_dir, target_paths)
@@ -56,7 +61,7 @@ download_files <- function(
     FUN = download_from_href,
     hrefs,
     target_files,
-    MoreArgs = list(auth = auth),
+    MoreArgs = list(auth = auth, dbg = dbg),
     SIMPLIFY = FALSE,
     USE.NAMES = FALSE
   ))
@@ -66,12 +71,17 @@ download_files <- function(
 
 #' @importFrom kwb.utils catAndRun
 #' @keywords internal
-download_from_href <- function(href, target_file, auth = nextcloud_auth())
+download_from_href <- function(
+    href,
+    target_file,
+    auth = nextcloud_auth(),
+    dbg = TRUE
+)
 {
   # Expect the target directory to exist
   stopifnot(file.exists(dirname(target_file)))
 
-  kwb.utils::catAndRun(paste("Downloading", href), {
+  kwb.utils::catAndRun(paste("Downloading", href), dbg = dbg, {
 
     response <- nextcloud_request(href, "GET", auth)
 
@@ -82,14 +92,15 @@ download_from_href <- function(href, target_file, auth = nextcloud_auth())
 # write_content_to_file --------------------------------------------------------
 
 #' @importFrom httr content headers
+#' @importFrom kwb.utils isTryError
 #' @keywords internal
 write_content_to_file <- function(response, target_file)
 {
   content <- httr::content(response, type = "application/octet-stream")
 
   result <- try(writeBin(content, target_file))
 
-  if (is_try_error(result)) {
+  if (kwb.utils::isTryError(result)) {
 
     stop(
       "Could not write the response data with writeBin(). ",

R/file_exists.R

@@ -0,0 +1,11 @@
+#' Does a File Exist on the Nextcloud Server?
+#'
+#' @param path path to the file
+#' @return \code{TRUE} if the file exists, else \code{FALSE}
+#' @export
+file_exists <- function(path)
+{
+  stopifnot(is.character(path), length(path) == 1L)
+
+  basename(path) %in% list_files(dirname(path), silent = TRUE)
+}

R/get_file_versions.R

@@ -0,0 +1,41 @@
+# get_file_versions ------------------------------------------------------------
+
+#' Get Information on Versions of Given Files
+#'
+#' @param file_info data frame as returned by \code{\link{list_files}} when
+#'   being called with \code{full_info = TRUE}
+#' @returns data frame
+#' @importFrom kwb.utils moveColumnsToFront selectColumns
+#' @export
+get_file_versions <- function(file_info)
+{
+  # Remove information on directories
+  file_info <- file_info[!kwb.utils::selectColumns(file_info, "isdir"), ]
+
+  if (nrow(file_info) == 0L) {
+    message("There are no (non-directory) files within file_info.")
+    return()
+  }
+
+  # Get version information for the remaining files
+  file_ids <- kwb.utils::selectColumns(file_info, "fileid")
+  version_info <- get_version_info(file_ids, dbg = FALSE)
+
+  if (is.null(version_info)) {
+    return()
+  }
+
+  columns_file_info <- c("fileid", "file", "lastmodified", "etag")
+  columns_version_info <- c("fileid", "version", "href")
+
+  result <- merge(
+    x = kwb.utils::selectColumns(file_info, columns_file_info),
+    y = kwb.utils::selectColumns(version_info, columns_version_info),
+    by = "fileid"
+  )
+
+  kwb.utils::moveColumnsToFront(
+    result,
+    columns = c("fileid", "file", "version")
+  )
+}