-
Notifications
You must be signed in to change notification settings - Fork 152
/
install.R
292 lines (218 loc) · 8.06 KB
/
install.R
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
#' Install Packages
#'
#' Install one or more \R packages.
#'
#' `install()` uses the same machinery as [restore()] when installing packages.
#' In particular, this means that the local cache of package installations is
#' used when possible. This helps to avoid re-downloading packages that have
#' already been downloaded before, and re-compiling packages from source when
#' a binary copy of that package is already available.
#'
#' Note that this interface is subject to change -- the goal is to hook into
#' separate package installation backends in the future.
#'
#' @inheritParams renv-params
#'
#' @param packages A character vector of \R packages to install. Required
#' package dependencies (`Depends`, `Imports`, `LinkingTo`) will be installed
#' as required.
#'
#' @export
install <- function(packages, project = NULL) {
project <- project %||% renv_project()
library <- renv_paths_library(project = project)
records <- renv_snapshot_r_packages(library = library)
remotes <- lapply(packages, renv_remotes_parse)
packages <- extract_chr(remotes, "Package")
names(remotes) <- packages
records[names(remotes)] <- remotes
renv_restore_begin(records, packages)
on.exit(renv_restore_end(), add = TRUE)
# retrieve packages
records <- renv_retrieve(packages, records)
records <- Filter(renv_install_required, records)
renv_install(project, records)
renv_snapshot_auto(project = project)
invisible(records)
}
renv_install <- function(project, records) {
# save active library
library <- renv_libpaths_default()
renv_global_set("install.library", library)
on.exit(renv_global_clear("install.library"), add = TRUE)
# set up a dummy library path for installation
templib <- tempfile("renv-templib-")
ensure_directory(templib)
on.exit(unlink(templib), add = TRUE)
renv_scope_libpaths(c(templib, .libPaths()))
# figure out whether we can use the cache during install
linkable <-
settings$use.cache() &&
identical(library, renv_paths_library(project = project))
linker <- if (linkable) renv_file_link else renv_file_copy
# iterate through records and install
for (record in records)
renv_install_impl(record, linker)
# migrate packages into true library
sources <- list.files(templib, full.names = TRUE)
targets <- file.path(library, basename(sources))
names(targets) <- sources
enumerate(targets, renv_file_move, overwrite = TRUE)
}
renv_install_impl <- function(record, linker = renv_file_copy) {
# skip installation if the requested record matches
# the already-installed record
if (renv_install_package_skip(record))
return(TRUE)
# check for cache entry and install if there
cache <- renv_cache_package_path(record)
if (file.exists(cache))
return(renv_install_package_cache(record, cache, linker))
# report that we're about to start installation
fmt <- "Installing %s [%s] from %s ..."
with(record, vwritef(fmt, Package, Version, renv_alias(Source)))
# otherwise, install
status <- catch(renv_install_package_local(record))
renv_install_report_status(record, status)
}
renv_install_package_skip <- function(record) {
# don't skip if installation was explicitly requested
state <- renv_restore_state()
if (record$Package %in% state$packages)
return(FALSE)
# check for existing package install
library <- renv_global_get("install.library")
target <- file.path(library, record$Package)
if (!file.exists(target))
return(FALSE)
# attempt to read DESCRIPTION
current <- catch(as.list(renv_description_read(target)))
if (inherits(current, "error"))
return(FALSE)
# check for matching records
source <- tolower(record$Source %||% record$RemoteType)
if (empty(source))
return(FALSE)
# check for an up-to-date version from CRAN
if (identical(source, "cran")) {
fields <- c("Package", "Version")
if (identical(record[fields], current[fields]))
return(TRUE)
}
# otherwise, match on remote fields
fields <- c("Package", "Version", grep("^Remote", names(record), value = TRUE))
if (identical(record[fields], current[fields]))
return(TRUE)
FALSE
}
renv_install_package_cache <- function(record, cache, linker) {
if (renv_install_package_cache_skip(record, cache))
return(TRUE)
library <- renv_libpaths_default()
target <- file.path(library, record$Package)
# back up the previous installation if needed
callback <- renv_file_scoped_backup(target)
on.exit(callback(), add = TRUE)
# report successful link to user
fmt <- "Installing %s [%s] ..."
with(record, vwritef(fmt, Package, Version))
status <- catch(linker(cache, target))
if (inherits(status, "error"))
return(status)
type <- case(
identical(linker, renv_file_copy) ~ "copied",
identical(linker, renv_file_link) ~ "linked"
)
vwritef("\tOK (%s cache)", type)
return(TRUE)
}
renv_install_package_cache_skip <- function(record, cache) {
state <- renv_restore_state()
# don't skip if installation was explicitly requested
if (record$Package %in% state$packages)
return(FALSE)
# check for matching cache + target paths
library <- renv_global_get("install.library")
target <- file.path(library, record$Package)
renv_file_same(cache, target)
}
renv_install_package_local <- function(record, quiet = TRUE) {
package <- record$Package
# get user-defined options to apply during installation
options <- renv_install_package_options(package)
# run user-defined hooks before, after install
before <- options$before.install %||% identity
after <- options$after.install %||% identity
before(package)
on.exit(after(package), add = TRUE)
library <- renv_libpaths_default()
path <- record$Path
destination <- file.path(library, package)
callback <- renv_file_scoped_backup(destination)
on.exit(callback(), add = TRUE)
# install the package
renv_install_package_local_impl(package, path, library)
# augment the DESCRIPTION after install
installpath <- file.path(library, package)
renv_description_augment(installpath, record)
# return the path to the package
invisible(installpath)
}
renv_install_package_local_impl <- function(package, path, library) {
library <- normalizePath(library, winslash = "/", mustWork = TRUE)
path <- normalizePath(path, winslash = "/", mustWork = TRUE)
r_cmd_install(package, path, library)
}
renv_install_package_options <- function(package) {
options <- getOption("renv.install.package.options")
options[[package]]
}
renv_install_report_status <- function(record, status) {
if (inherits(status, "error")) {
vwritef("\tFAILED\n")
stop(status)
}
feedback <- if (endswith(record$Path, ".tar.gz"))
"built from source"
else
"installed binary"
vwritef("\tOK (%s)", feedback)
if (settings$use.cache())
renv_cache_synchronize(record)
return(TRUE)
}
# NOTE: this routine does a very primitive sort of dependency validation;
# it simply checks if the package is too old and requests an install
# if that's the case. e.g. if pkg A requires pkgB >= 1.1, but pkgB 1.0
# is installed, then this routine marks pkgB as requiring install
renv_install_required <- function(record) {
state <- renv_restore_state()
# if installation of this package was explicitly requested, keep it
package <- record$Package
if (package %in% state$packages)
return(TRUE)
# check to see if this package is already installed; if it's not
# installed then we need to install it
records <- state$records
if (is.null(records[[record$Package]]))
return(TRUE)
# check and see if the installed version satisfies all requirements
requirements <- state$requirements[[package]]
if (is.null(requirements))
return(FALSE)
data <- bind_list(requirements$data())
explicit <- data[nzchar(data$Require) & nzchar(data$Version), ]
if (nrow(explicit) == 0)
return(FALSE)
exprs <- sprintf(
"numeric_version('%s') %s '%s'",
record$Version,
explicit$Require,
explicit$Version
)
expr <- paste(exprs, collapse = " && ")
satisfied <- catch(eval(parse(text = expr)), envir = baseenv())
if (inherits(satisfied, "error"))
warning(satisfied)
!identical(satisfied, TRUE)
}