new option cache_user_dir for both available.packages() and install.packages()

git-svn-id: https://svn.r-project.org/R/trunk@87274 00db46b3-68df-0310-9c12-caf00c1e9a41

Author: maechler

doc/NEWS.Rd

@@ -114,6 +114,9 @@
       \item More R level messages use a common format containing
       \code{"character string"} for more consistency and less translation
       work.
+
+      \item \code{available.packages()} and \code{install.packages()} get
+      an optional switch \code{cache_user_dir}, somewhat experimentally.
     }
   }
 

src/library/utils/R/packages.R

@@ -22,7 +22,8 @@ function(contriburl = contrib.url(repos, type), method,
          type = getOption("pkgType"), filters = NULL,
          repos = getOption("repos"),
          ignore_repo_cache = FALSE, max_repo_cache_age,
-         quiet = TRUE, ...)
+         cache_user_dir = str2logical(Sys.getenv("R_PACKAGES_CACHE_USER_DIR", FALSE)),
+         quiet = TRUE, verbose = FALSE, ...)
 {
     if (!is.character(type))
         stop(gettextf("'%s' must be a character string", "type"), domain = NA)
@@ -67,7 +68,8 @@ function(contriburl = contrib.url(repos, type), method,
             if(ignore_repo_cache) {
                 dest <- tempfile()
             } else {
-                dest <- file.path(tempdir(),
+                dest <- file.path(if(cache_user_dir) tools::R_user_dir("base", "cache")
+                                  else tempdir(),
                                   paste0("repos_", URLencode(repos, TRUE), ".rds"))
                 if(file.exists(dest)) {
                     age <- difftime(timestamp, file.mtime(dest), units = "secs")
@@ -169,6 +171,8 @@ function(contriburl = contrib.url(repos, type), method,
             res0 <- cbind(res0[, fields, drop = FALSE], Repository = rp)
             res <- rbind(res, res0, deparse.level = 0L)
         }
+        if(verbose) cat("added", NROW(res0), "packages, from repos", sQuote(repos),
+                        "to a total of", NROW(res), "\n")
     } ## end  for(repos in *)
 
     if(!length(res)) return(res)
@@ -628,6 +632,7 @@ new.packages <- function(lib.loc = NULL, repos = getOption("repos"),
 
 installed.packages <-
     function(lib.loc = NULL, priority = NULL, noCache = FALSE,
+             cache_user_dir = str2logical(Sys.getenv("R_PACKAGES_CACHE_USER_DIR", FALSE)),
              fields = NULL, subarch = .Platform$r_arch, ...)
 {
     if(is.null(lib.loc))
@@ -652,7 +657,9 @@ installed.packages <-
             ## add length and 64-bit CRC in hex (in theory, seems
             ## it is actually 32-bit on some systems)
             enc <- sprintf("%d_%s", nchar(base), .Call(C_crc64, base))
-            dest <- file.path(tempdir(), paste0("libloc_", enc, ".rds"))
+            dest <- file.path(if(cache_user_dir) tools::R_user_dir("base", "cache")
+                              else tempdir(),
+                              paste0("libloc_", enc, ".rds"))
             test <- file.exists(dest) &&
                 file.mtime(dest) > file.mtime(lib) &&
                 (val <- readRDS(dest))$base == base
@@ -664,6 +671,8 @@ installed.packages <-
                 if(length(ret0)) {
                     retval <- rbind(retval, ret0, deparse.level = 0L)
                     ## save the cache file
+                    dir.create(dirname(dest), recursive = TRUE,
+                               showWarnings = FALSE)
                     saveRDS(list(base = base, value = ret0), dest)
                 } else unlink(dest)
             }

src/library/utils/man/available.packages.Rd

@@ -20,7 +20,8 @@ available.packages(contriburl = contrib.url(repos, type), method,
                    type = getOption("pkgType"), filters = NULL,
                    repos = getOption("repos"),
                    ignore_repo_cache = FALSE, max_repo_cache_age,
-                   quiet = TRUE, \dots)
+                   cache_user_dir = str2logical(Sys.getenv("R_PACKAGES_CACHE_USER_DIR", FALSE)),
+                   quiet = TRUE, verbose = FALSE, \dots)
 }
 \arguments{
   \item{contriburl}{
@@ -55,8 +56,14 @@ available.packages(contriburl = contrib.url(repos, type), method,
   \item{max_repo_cache_age}{any cached values older than this in seconds
     will be ignored. See \sQuote{Details}.
   }
+  \item{cache_user_dir}{\code{\link{logical}} indicating if caching should
+    happen in \pkg{tools}' \code{\link[tools]{R_user_dir}("base", "cache")}
+    instead of \code{\link{tempdir}()}.}
   \item{quiet}{logical, passed to \code{\link{download.file}()}; change
     only if you know what you are doing.}
+  \item{verbose}{logical indicating if a \dQuote{progress report} line
+    should be printed about the number of packages found in each repos.}
+  % before filtering (TODO: *during* filt.)
   \item{\dots}{
     allow additional arguments to be passed from callers (which might be
     arguments to future versions of this function).  Currently these are

src/library/utils/man/installed.packages.Rd

@@ -1,6 +1,6 @@
 % File src/library/utils/man/installed.packages.Rd
 % Part of the R package, https://www.R-project.org
-% Copyright 1995-2022 R Core Team
+% Copyright 1995-2024 R Core Team
 % Distributed under GPL 2 or later
 
 \name{installed.packages}
@@ -12,7 +12,9 @@
 }
 \usage{
 installed.packages(lib.loc = NULL, priority = NULL,
-                   noCache = FALSE, fields = NULL,
+                   noCache = FALSE,
+                   cache_user_dir = str2logical(Sys.getenv("R_PACKAGES_CACHE_USER_DIR", FALSE)),
+                   fields = NULL,
                    subarch = .Platform$r_arch, \dots)
 }
 \arguments{
@@ -27,7 +29,10 @@ installed.packages(lib.loc = NULL, priority = NULL,
     \code{c("base", "recommended")}.  To select all packages without an
     assigned priority use \code{priority = NA_character_}.
   }
-  \item{noCache}{Do not use cached information, nor cache it.}
+  \item{noCache}{do not use cached information, nor cache it.}
+  \item{cache_user_dir}{\code{\link{logical}} indicating if caching should
+    happen in \pkg{tools}' \code{\link[tools]{R_user_dir}("base", "cache")}
+    instead of \code{\link{tempdir}()}.}
 
   \item{fields}{a character vector giving the fields to extract from
     each package's \file{DESCRIPTION} file in addition to the default