forked from r-lib/pkgdown
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Now turn them into HTML dependencies objects, caching them in the user cache directory. Fixes r-lib#2099. --------- Co-authored-by: Hadley Wickham <[email protected]>
- Loading branch information
Showing
8 changed files
with
184 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,125 @@ | ||
| external_dependencies <- function() { | ||
| list( | ||
| fontawesome::fa_html_dependency(), | ||
| cached_dependency( | ||
| name = "headroom", | ||
| version = "0.11.0", | ||
| files = list( | ||
| list( | ||
| url = "https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js", | ||
| integrity = "sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" | ||
| ), | ||
| list( | ||
| url = "https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js", | ||
| integrity = "sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" | ||
| ) | ||
| ) | ||
| ), | ||
| cached_dependency( | ||
| name = "bootstrap-toc", | ||
| version = "1.0.1", | ||
| files = list( | ||
| list( | ||
| url = "https://cdn.jsdelivr.net/gh/afeld/[email protected]/dist/bootstrap-toc.min.js", | ||
| integrity = "sha256-4veVQbu7//Lk5TSmc7YV48MxtMy98e26cf5MrgZYnwo=" | ||
| ) | ||
| ) | ||
| ), | ||
| cached_dependency( | ||
| name = "clipboard.js", | ||
| version = "2.0.11", | ||
| files = list( | ||
| list( | ||
| url = "https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.11/clipboard.min.js", | ||
| integrity = "sha512-7O5pXpc0oCRrxk8RUfDYFgn0nO1t+jLuIOQdOMRp4APB7uZ4vSjspzp5y6YDtDs4VzUSTbWzBFZ/LKJhnyFOKw==" | ||
| ) | ||
| ) | ||
| ), | ||
| cached_dependency( | ||
| name = "search", | ||
| version = "1.0.0", | ||
| files = list( | ||
| list( | ||
| url = "https://cdnjs.cloudflare.com/ajax/libs/fuse.js/6.4.6/fuse.min.js", | ||
| integrity = "sha512-KnvCNMwWBGCfxdOtUpEtYgoM59HHgjHnsVGSxxgz7QH1DYeURk+am9p3J+gsOevfE29DV0V+/Dd52ykTKxN5fA==" | ||
| ), | ||
| list( | ||
| url = "https://cdnjs.cloudflare.com/ajax/libs/autocomplete.js/0.38.0/autocomplete.jquery.min.js", | ||
| integrity = "sha512-GU9ayf+66Xx2TmpxqJpliWbT5PiGYxpaG8rfnBEk1LL8l1KGkRShhngwdXK1UgqhAzWpZHSiYPc09/NwDQIGyg==" | ||
| ), | ||
| list( | ||
| url = "https://cdnjs.cloudflare.com/ajax/libs/mark.js/8.11.1/mark.min.js", | ||
| integrity = "sha512-5CYOlHXGh6QpOFA/TeTylKLWfB3ftPsde7AnmhuitiTX4K5SqCLBeKro6sPS8ilsz1Q4NRx3v8Ko2IBiszzdww==" | ||
| ) | ||
| ) | ||
| ), | ||
| cached_dependency( | ||
| name = "MathJax", | ||
| version = "2.7.5", | ||
| files = list( | ||
| list( | ||
| url = "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js", | ||
| integrity = "sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" | ||
| ), | ||
| list( | ||
| url = "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js", | ||
| integrity = "sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" | ||
| ) | ||
| ) | ||
| ) | ||
| ) | ||
| } | ||
|
|
||
| cached_dependency <- function(name, version, files) { | ||
| cache_dir <- path(tools::R_user_dir("pkgdown", "cache"), name, version) | ||
| dir_create(cache_dir) | ||
|
|
||
| for (file in files) { | ||
| cache_path <- path(cache_dir, path_file(file$url)) | ||
| if (!file_exists(cache_path)) { | ||
| download.file(file$url, cache_path, quiet = TRUE, mode = "wb") | ||
| check_integrity(cache_path, file$integrity) | ||
| } | ||
| } | ||
| dep_files <- path_rel(dir_ls(cache_dir), cache_dir) | ||
|
|
||
| htmltools::htmlDependency( | ||
| name = name, | ||
| version = version, | ||
| src = cache_dir, | ||
| script = dep_files[path_ext(dep_files) == "js"], | ||
| stylesheet = dep_files[path_ext(dep_files) == "css"] | ||
| ) | ||
| } | ||
|
|
||
| check_integrity <- function(path, integrity) { | ||
| parsed <- parse_integrity(integrity) | ||
| if (!parsed$size %in% c(256L, 384L, 512L)) { | ||
| cli::cli_abort( | ||
| "{.field integrity} must use SHA-256, SHA-384, or SHA-512", | ||
| .internal = TRUE | ||
| ) | ||
| } | ||
|
|
||
| hash <- compute_hash(path, parsed$size) | ||
| if (hash != parsed$hash) { | ||
| cli::cli_abort( | ||
| "Downloaded asset does not match known integrity", | ||
| .internal = TRUE | ||
| ) | ||
| } | ||
|
|
||
| invisible() | ||
| } | ||
|
|
||
| compute_hash <- function(path, size) { | ||
| con <- file(path, encoding = "UTF-8") | ||
| openssl::base64_encode(openssl::sha2(con, size)) | ||
| } | ||
|
|
||
| parse_integrity <- function(x) { | ||
| size <- as.integer(regmatches(x, regexpr("(?<=^sha)\\d{3}", x, perl = TRUE))) | ||
| hash <- regmatches(x, regexpr("(?<=^sha\\d{3}-).+", x, perl = TRUE)) | ||
|
|
||
| list(size = size, hash = hash) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -19,24 +19,6 @@ | |
| {{/has_favicons}} | ||
|
|
||
| {{{headdeps}}} | ||
| <!-- Font Awesome icons --> | ||
| <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous" /> | ||
| <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous" /> | ||
|
|
||
| <!-- bootstrap-toc --> | ||
| <script src="https://cdn.jsdelivr.net/gh/afeld/[email protected]/dist/bootstrap-toc.min.js" integrity="sha256-4veVQbu7//Lk5TSmc7YV48MxtMy98e26cf5MrgZYnwo=" crossorigin="anonymous"></script> | ||
|
|
||
| <!-- headroom.js --> | ||
| <script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script> | ||
| <script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script> | ||
|
|
||
| <!-- clipboard.js --> | ||
| <script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.11/clipboard.min.js" integrity="sha512-7O5pXpc0oCRrxk8RUfDYFgn0nO1t+jLuIOQdOMRp4APB7uZ4vSjspzp5y6YDtDs4VzUSTbWzBFZ/LKJhnyFOKw==" crossorigin="anonymous" referrerpolicy="no-referrer"></script> | ||
|
|
||
| <!-- search --> | ||
| <script src="https://cdnjs.cloudflare.com/ajax/libs/fuse.js/6.4.6/fuse.js" integrity="sha512-zv6Ywkjyktsohkbp9bb45V6tEMoWhzFzXis+LrMehmJZZSys19Yxf1dopHx7WzIKxr5tK2dVcYmaCk2uqdjF4A==" crossorigin="anonymous"></script> | ||
| <script src="https://cdnjs.cloudflare.com/ajax/libs/autocomplete.js/0.38.0/autocomplete.jquery.min.js" integrity="sha512-GU9ayf+66Xx2TmpxqJpliWbT5PiGYxpaG8rfnBEk1LL8l1KGkRShhngwdXK1UgqhAzWpZHSiYPc09/NwDQIGyg==" crossorigin="anonymous"></script> | ||
| <script src="https://cdnjs.cloudflare.com/ajax/libs/mark.js/8.11.1/mark.min.js" integrity="sha512-5CYOlHXGh6QpOFA/TeTylKLWfB3ftPsde7AnmhuitiTX4K5SqCLBeKro6sPS8ilsz1Q4NRx3v8Ko2IBiszzdww==" crossorigin="anonymous"></script> | ||
|
|
||
| <!-- pkgdown --> | ||
| <script src="{{#site}}{{root}}{{/site}}pkgdown.js"></script> | ||
|
|
@@ -80,10 +62,6 @@ | |
| <meta name="google-site-verification" content="{{{.}}}" /> | ||
| {{/google_site_verification}}{{/yaml}} | ||
|
|
||
| <!-- mathjax --> | ||
| <script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script> | ||
| <script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script> | ||
|
|
||
| {{#yaml}}{{#ganalytics}} | ||
| <!-- Global site tag (gtag.js) - Google Analytics --> | ||
| <script async src="https://www.googletagmanager.com/gtag/js?id={{.}}"></script> | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| # check integrity validates integrity | ||
|
|
||
| Code | ||
| check_integrity(temp, "sha123-abc") | ||
| Condition | ||
| Error in `check_integrity()`: | ||
| ! integrity must use SHA-256, SHA-384, or SHA-512 | ||
| i This is an internal error that was detected in the pkgdown package. | ||
| Please report it at <https://github.com/r-lib/pkgdown/issues> with a reprex (<https://tidyverse.org/help/>) and the full backtrace. | ||
| Code | ||
| check_integrity(temp, "sha256-abc") | ||
| Condition | ||
| Error in `check_integrity()`: | ||
| ! Downloaded asset does not match known integrity | ||
| i This is an internal error that was detected in the pkgdown package. | ||
| Please report it at <https://github.com/r-lib/pkgdown/issues> with a reprex (<https://tidyverse.org/help/>) and the full backtrace. | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| test_that("check integrity validates integrity", { | ||
| temp <- withr::local_tempfile(lines = letters) | ||
|
|
||
| expect_snapshot(error = TRUE, { | ||
| check_integrity(temp, "sha123-abc") | ||
| check_integrity(temp, "sha256-abc") | ||
| }) | ||
|
|
||
| integrity <- paste0("sha256-", compute_hash(temp, 256L)) | ||
| expect_no_error(check_integrity(temp, integrity)) | ||
| }) | ||
|
|
||
| test_that("can parse integrity", { | ||
| expect_equal(parse_integrity("sha256-abc"), list(size = 256L, hash = "abc")) | ||
| }) |