Use realfavicongenerator API to build high-res PNG favicons

DESCRIPTION

@@ -54,7 +54,6 @@ Suggests:
     jsonlite,
     knitr,
     leaflet,
-    magick,
     testthat,
     rticles
 VignetteBuilder: knitr

NAMESPACE

@@ -106,6 +106,7 @@ export(as_pkgdown)
 export(autolink_html)
 export(build_article)
 export(build_articles)
+export(build_favicon)
 export(build_home)
 export(build_news)
 export(build_reference)

NEWS.md

@@ -1,5 +1,11 @@
 # pkgdown 1.1.0.9000
 
+* New function `build_favicon()` creates high resolution favicons, which are 
+  better suited for modern web usage (e.g. retina display screens, desktop
+  shortcuts, etc.).  For this, it uses the <http://realfavicongenerator.net>
+  API. As a side effect, this change also removes the dependency to the
+  magick package (@bisaloo, #883).
+
 * Navbar version now gets class "version" so you can more easily control the
   display if you want (#680).
 

R/build-home.R

@@ -28,7 +28,7 @@
 #' # pkgdown <img src="man/figures/logo.png" align="right" />
 #' ```
 #'
-#' [init_site()] will also automatically create a favicon.ico from your package
+#' [init_site()] will also automatically create a favicon set from your package
 #' logo.
 #'
 #' @section YAML config - home:

R/build-logo.R

@@ -1,29 +1,111 @@
 build_logo <- function(pkg = ".") {
+
   pkg <- as_pkgdown(pkg)
 
-  logo_path <- find_logo(pkg$src_path)
-  if (is.null(logo_path))
+  if (!dir_exists(path(pkg$src_path, "pkgdown", "favicon"))) {
     return()
+  }
+
+  dir_copy_to(pkg, path(pkg$src_path, "pkgdown", "favicon"), pkg$dst_path)
 
-  file_copy_to(pkg, logo_path, from_dir = path_dir(logo_path))
+}
 
-  if (!requireNamespace("magick", quietly = TRUE)) {
-    message("magick not available, using default pkgdown favicon.ico")
 
-    if (!file_exists(path(pkg$dst_path, "favicon.ico"))) {
-      file_copy(path_pkgdown("assets", "favicon.ico"), pkg$dst_path)
-    }
-    return()
+#' Create a complete set of favicons with different sizes from your package logo
+#'
+#' This function auto-detects the location of your package logo (with the name
+#' `logo.csv` (recommended format) or `logo.png`) and runs it through the
+#' <https://realfavicongenerator.net> API to build a complete set of favicons
+#' with different sizes, as needed for modern web usage.
+#'
+#' You only need to run the function once. The favicon set will be stored in
+#' `pkgdown/favicon` and copied by [init_site()] to the relevant location each
+#' time the website is rebuilt.
+#'
+#' @inheritParams as_pkgdown
+#'
+#' @export
+build_favicon <- function(pkg = ".") {
+
+  pkg <- as_pkgdown(pkg)
+
+  logo_path <- find_logo(pkg$src_path)
+
+  if (is.null(logo_path)) {
+    stop("Package logo could not be found. Aborting favicon creation.",
+         call. = FALSE)
+  }
+
+  logo <- readBin(logo_path, what = "raw", n = fs::file_info(logo_path)$size)
+
+  json_request <- list(
+    "favicon_generation" = list(
+      "api_key" = "87d5cd739b05c00416c4a19cd14a8bb5632ea563",
+      "master_picture" = list(
+        "type"= "inline",
+        "content"= openssl::base64_encode(logo)
+      ),
+      "favicon_design" = list(
+        "desktop_browser" = list(),
+        "ios" = list(
+          "picture_aspect" = "no_change",
+          "assets" = list(
+            "ios6_and_prior_icons" = FALSE,
+            "ios7_and_later_icons" = TRUE,
+            "precomposed_icons" = FALSE,
+            "declare_only_default_icon" = TRUE
+          )
+        )
+      )
+    )
+  )
+
+  # It may take some time to generate the whole favicon set so we need to set
+  # a high timeout value.
+  request <- httr::POST("https://realfavicongenerator.net/api/favicon",
+                        body = json_request, encode = "json",
+                        httr::timeout(10000)
+                        )
+
+  if (httr::http_error(request)) {
+    stop("The API could not be reached. Please check your internet connection ",
+         "or try again later.",
+         call. = FALSE
+         )
+  }
+
+  api_answer <- httr::content(request)
+
+  if (!identical(api_answer$favicon_generation_result$result$status, "success")) {
+    stop("API request failed: please check that you are using supported file ",
+         "formats",
+         call. = FALSE
+    )
   }
 
-  cat_line("Creating ", dst_path("favicon.ico"))
-  magick::image_read(logo_path) %>%
-	  magick::image_scale("32x32") %>%
-	  magick::image_write(path(pkg$dst_path, "favicon.ico"), format = "png")
+  tmp <- tempfile()
+
+  result <- httr::GET(api_answer$favicon_generation_result$favicon$package_url,
+                      httr::write_disk(tmp)
+                      )
+
+  utils::unzip(tmp, exdir = path(pkg$src_path, "pkgdown", "favicon"))
+
+  unlink(tmp)
+
 }
 
 
 find_logo <- function(path) {
+
+  logo_path <- path(path, "logo.svg")
+  if (file_exists(logo_path))
+    return(logo_path)
+
+  logo_path <- path(path, "man", "figures", "logo.svg")
+  if (file_exists(logo_path))
+    return(logo_path)
+
   logo_path <- path(path, "logo.png")
   if (file_exists(logo_path))
     return(logo_path)

R/init.R

@@ -1,8 +1,7 @@
 #' Initialise site infrastructure
 #'
-#' This creates the output directory (`docs/`), `favicon.ico` (from the package
-#' logo), a machine readable description of the site, and copies CSS/JS
-#' assets and extra files.
+#' This creates the output directory (`docs/`), a machine readable description
+#' of the site, and copies CSS/JS assets and extra files.
 #'
 #' @section Build-ignored files:
 #' We recommend using `usethis::use_pkgdown()` to build-ignore `docs/` and
@@ -18,9 +17,9 @@
 #' `<HEAD>` after the default pkgdown CSS and JS.
 #'
 #' @section Favicon:
-#' If you include you package logo in the standard location of
-#' `man/figures/logo.png`, a favicon will be automatically created for
-#' you.
+#' You should manually run [build_favicon()] once to generate the favicon set
+#' from your logo. The result is stored in `pkgdown/favicon` and will
+#' automatically be copied to the relevant location when you run [init_site()].
 #'
 #' @inheritParams build_articles
 #' @export

inst/templates/head.html

@@ -4,7 +4,12 @@
 
 <title>{{{pagetitle}}} • {{#site}}{{title}}{{/site}}</title>
 
-<link rel="shortcut icon" type="image/x-icon" href="{{#site}}{{root}}{{/site}}favicon.ico">
+<link rel="icon" type="image/png" sizes="16x16" href="{{#site}}{{root}}{{/site}}favicon-16x16.png">
+<link rel="icon" type="image/png" sizes="32x32" href="{{#site}}{{root}}{{/site}}favicon-32x32.png">
+<link rel="apple-touch-icon" type="image/png" sizes="180x180" href="{{#site}}{{root}}{{/site}}apple-touch-icon.png" />
+<link rel="apple-touch-icon" type="image/png" sizes="120x120" href="{{#site}}{{root}}{{/site}}apple-touch-icon-120x120.png" />
+<link rel="apple-touch-icon" type="image/png" sizes="76x76" href="{{#site}}{{root}}{{/site}}apple-touch-icon-76x76.png" />
+<link rel="apple-touch-icon" type="image/png" sizes="60x60" href="{{#site}}{{root}}{{/site}}apple-touch-icon-60x60.png" />
 
 <!-- jquery -->
 <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script>