r-lib · hadley · May 28, 2024 · Dec 5, 2022 · Dec 5, 2022 · Dec 5, 2022
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -31,6 +31,7 @@ Imports:
     jsonlite,
     magrittr,
     memoise,
+    openssl,
     purrr (>= 1.0.0),
     ragg,
     rlang (>= 1.0.0),
@@ -49,7 +50,6 @@ Suggests:
     knitr,
     lifecycle,
     methods,
-    openssl,
     pkgload (>= 1.0.2),
     rsconnect,
     rstudioapi,

diff --git a/NEWS.md b/NEWS.md
@@ -1,6 +1,10 @@
 # pkgdown (development version)
 
 * The article index now sorts vignettes and non-vignette articles alphabetically by their filename (literally, their `basename()`), by default (@jennybc, #2253).
+* All external assets (JS, CSS, fonts) are now directly included in the site
+  instead of being fetched from external CDNs if the [Bootstrap 5 template is
+  used](https://pkgdown.r-lib.org/index.html#pkgdown-200-and-bootstrap-5).
+  (@salim-b, #2249)
 
 # pkgdown 2.0.7
 

diff --git a/R/build.R b/R/build.R
@@ -152,23 +152,23 @@
 #'         noindex: true
 #'     ```
 #'
-#' * `google_site_verification` allows you to verify your site with google:
+#' *   `google_site_verification` allows you to verify your site with google:
 #'
-#'      ```yaml
-#'      template:
-#'        params:
-#'          google_site_verification: _nn6ile-a6x6lctOW
-#'      ```
+#'     ```yaml
+#'     template:
+#'       params:
+#'         google_site_verification: _nn6ile-a6x6lctOW
+#'     ```
 #'
 #' *   `trailing_slash_redirect: true` will automatically redirect
 #'     `your-package-url.com` to `your-package-url.com/`, using a JS script
-#'      added to the `<head>` of the home page. This is useful in certain
-#'      redirect scenarios.
+#'     added to the `<head>` of the home page. This is useful in certain
+#'     redirect scenarios.
 #'
-#'      ```yaml
-#'      template:
-#'        trailing_slash_redirect: true
-#'      ```
+#'     ```yaml
+#'     template:
+#'       trailing_slash_redirect: true
+#'     ```
 #'
 #' @section Analytics:
 #'

diff --git a/R/theme.R b/R/theme.R
@@ -3,29 +3,111 @@ build_bslib <- function(pkg = ".") {
   bs_theme <- bs_theme(pkg)
 
   deps <- bslib::bs_theme_dependencies(bs_theme)
-  deps <- lapply(deps, htmltools::copyDependencyToDir, file.path(pkg$dst_path, "deps"))
+  deps <- lapply(deps, htmltools::copyDependencyToDir, path_deps(pkg))
   deps <- lapply(deps, htmltools::makeDependencyRelative, pkg$dst_path)
 
   head <- htmltools::renderDependencies(deps, srcType = "file")
-  write_lines(head, data_deps_path(pkg))
+
+  # include additional external assets
+  head <- paste(
+    head,
+    paste0(assemble_ext_assets(pkg), collapse = "\n"),
+    sep = "\n"
+  )
+
+  write_lines(head, path_data_deps(pkg))
+}
+
+assemble_ext_assets <- function(pkg) {
+  path_assets_yaml <- path_pkgdown(paste0("BS", pkg$bs_version), "assets_external.yaml")
+  deps_ext <- yaml::read_yaml(path_assets_yaml)
+
+  purrr::map_chr(deps_ext, ~ {
+    # download external resource
+    path <- path_deps(pkg, basename(.x$url))
+    download.file(.x$url, path, quiet = TRUE, mode = "wb")
+
+    # check file integrity
+    sha_size <- as.integer(regmatches(
+      .x$integrity,
+      regexpr("(?<=^sha)\\d{3}", .x$integrity, perl = TRUE)
+    ))
+    if (!(sha_size %in% c(256L, 384L, 512L))) {
+      cli::cli_abort(paste0(
+        "Invalid {.field integrity} value set in {.file ",
+        "{path_assets_yaml}}: {.val {(.x$integrity)}} Allowed are only ",
+        "SHA-256, SHA-384 and SHA-512."
+      ))
+    }
+    con <- file(path, encoding = "UTF-8")
+    hash <- openssl::base64_encode(openssl::sha2(con, sha_size))
+    hash_target <- regmatches(
+      .x$integrity,
+      regexpr("(?<=^sha\\d{3}-).+", .x$integrity, perl = TRUE)
+    )
+
+    if (hash != hash_target) {
+      cli::cli_abort(paste0(
+        "Hash of downloaded {(.x$type)} asset doesn't match {.field ",
+        "integrity} value of {.val {(.x$integrity)}}. Asset URL is: {.url ",
+        "{(.x$url)}}"
+      ))
+    }
+
+    # download subresources (webfonts etc.) if necessary
+    if (isTRUE(.x$has_subresources)) {
+      file_content <- read_file(path)
+      pos <- gregexpr("(?<=\\burl\\((?!(data|https?):))[^)?#]*", file_content, perl = TRUE)
+      urls <- unique(unlist(regmatches(file_content, pos)))
+      subdirs <- unique(fs::path_dir(urls))
+      fs::dir_create(
+        fs::path_norm(fs::path(path_deps(pkg), subdirs)),
+        recurse = TRUE
+      )
+      url_parsed <- xml2::url_parse(.x$url)
+      url_excl_scheme <- fs::path(url_parsed$server, url_parsed$path)
+      remote_urls <- paste0(
+        url_parsed$scheme, "://",
+        fs::path_norm(fs::path(fs::path_dir(url_excl_scheme), urls))
+      )
+      purrr::walk2(
+        remote_urls,
+        urls,
+        ~ download.file(.x, fs::path_norm(path_deps(pkg, .y)), quiet = TRUE, mode = "wb")
+      )
+    }
+    .x$url <- fs::path_rel(path, pkg$dst_path)
+
+    # assemble HTML tag
+    switch(
+      .x$type,
+      "stylesheet" = sprintf('<link rel="stylesheet" href="%s" />', .x$url),
+      "script" = sprintf('<script src="%s"></script>', .x$url),
+      cli::cli_abort("Unknown asset type {.val {.x$type}} defined in {.file path_assets_yaml}.")
+    )
+  })
 }
 
 data_deps <- function(pkg, depth) {
-  if (!file.exists(data_deps_path(pkg))) {
+  if (!file.exists(path_data_deps(pkg))) {
     abort("Run pkgdown::init_site() first.")
   }
 
   deps_path <- paste0(up_path(depth), "deps")
 
-  data_deps <- read_lines(data_deps_path(pkg))
+  data_deps <- read_lines(path_data_deps(pkg))
   data_deps <- gsub('src="deps', sprintf('src="%s', deps_path), data_deps)
   data_deps <- gsub('href="deps', sprintf('href="%s', deps_path), data_deps)
 
   paste0(data_deps, collapse = "")
 }
 
-data_deps_path <- function(pkg) {
-  file.path(pkg$dst_path, "deps", "data-deps.txt")
+path_deps <- function(pkg, ...) {
+  file.path(pkg$dst_path, "deps", ...)
+}
+
+path_data_deps <- function(pkg) {
+  file.path(path_deps(pkg), "data-deps.txt")
 }
 
 bs_theme <- function(pkg = ".") {

diff --git a/inst/BS5/assets_external.yaml b/inst/BS5/assets_external.yaml
@@ -0,0 +1,45 @@
+# Font Awesome icons
+- type: "stylesheet"
+  url: "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css"
+  integrity: "sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk="
+  has_subresources: true
+- type: "stylesheet"
+  url: "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css"
+  integrity: "sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw="
+
+# bootstrap-toc
+- type: "script"
+  url: "https://cdn.jsdelivr.net/gh/afeld/[email protected]/dist/bootstrap-toc.min.js"
+  integrity: "sha256-4veVQbu7//Lk5TSmc7YV48MxtMy98e26cf5MrgZYnwo="
+
+# headroom.js
+- type: "script"
+  url: "https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js"
+  integrity: "sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0="
+- type: "script"
+  url: "https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js"
+  integrity: "sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4="
+
+# clipboard.js
+- type: "script"
+  url: "https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js"
+  integrity: "sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI="
+
+# search
+- type: "script"
+  url: "https://cdnjs.cloudflare.com/ajax/libs/fuse.js/6.4.6/fuse.min.js"
+  integrity: "sha512-KnvCNMwWBGCfxdOtUpEtYgoM59HHgjHnsVGSxxgz7QH1DYeURk+am9p3J+gsOevfE29DV0V+/Dd52ykTKxN5fA=="
+- type: "script"
+  url: "https://cdnjs.cloudflare.com/ajax/libs/autocomplete.js/0.38.0/autocomplete.jquery.min.js"
+  integrity: "sha512-GU9ayf+66Xx2TmpxqJpliWbT5PiGYxpaG8rfnBEk1LL8l1KGkRShhngwdXK1UgqhAzWpZHSiYPc09/NwDQIGyg=="
+- type: "script"
+  url: "https://cdnjs.cloudflare.com/ajax/libs/mark.js/8.11.1/mark.min.js"
+  integrity: "sha512-5CYOlHXGh6QpOFA/TeTylKLWfB3ftPsde7AnmhuitiTX4K5SqCLBeKro6sPS8ilsz1Q4NRx3v8Ko2IBiszzdww=="
+
+# MathJax
+- type: "script"
+  url: "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"
+  integrity: "sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k="
+- type: "script"
+  url: "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js"
+  integrity: "sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA="
diff --git a/inst/BS5/templates/head.html b/inst/BS5/templates/head.html
@@ -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.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></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>
-
 <!--[if lt IE 9]>
 <script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
 <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>

diff --git a/man/build_site.Rd b/man/build_site.Rd