Merge pull request #964 from gethinode/develop

Enable rewrite of CDN origin images

data/structures/image-adapter-rewrite.yml

@@ -0,0 +1,29 @@
+comment: >-
+  Rewrites an origin URL to a target URL as supported by a CDN image adapter.
+arguments:
+  account:
+    type: string
+    optional: true
+    comment: Account name of the origin server.
+  container:
+    type: string
+    optional: true
+    comment: Container name of the origin server.
+  host:
+    type: string
+    optional: true
+    comment: >-
+      Host of an URL. For example, the host of the URL
+      'https://example.com/first/second/third.webp' equals 'example.com'.
+  dir:
+    type: string
+    optional: true
+    comment: >-
+      All but the last element of an URL extension. For example, the dir of the
+      URL 'https://example.com/first/second/third.webp' equals '/first/second/'.
+  file:
+    type: string
+    optional: false
+    comment: >-
+      The last element of an URL extension. For example, the file of the
+      URL 'https://example.com/first/second/third.webp' equals 'third.webp'.

layouts/partials/assets/adapters/hugo.html

@@ -27,7 +27,7 @@
     {{ $url = urls.JoinPath "https://" $host $url }}
 {{ end }}
 
-<!-- Initialize image if needed -->
+<!-- Initialize image if needed, do not raise additional warnings -->
 {{ $format := .format | default "webp" }}
 {{ if and (not $img) (ne $format "svg") }}
     {{- $res := partial "utilities/GetImage.html" (dict "url" $url "page" page) -}}
@@ -37,7 +37,6 @@
     {{ end }}
 
     {{ if not $img }}
-        {{ errorf "partial [assets/adapter/hugo.html] - Expected 'img' argument" -}}
         {{ $error = true }}
     {{ end }}
 {{ end }}

layouts/partials/assets/adapters/imagekit-rewrite.html

@@ -0,0 +1,30 @@
+<!-- 
+    Copyright © 2024 The Hinode Team / Mark Dumay. All rights reserved.
+    Use of this source code is governed by The MIT License (MIT) that can be found in the LICENSE file.
+    Visit gethinode.com/license for more details.
+-->
+
+{{ $error := false }}
+
+<!-- Validate arguments -->
+{{ if partial "utilities/IsInvalidArgs.html" (dict "structure" "image-adapter-rewrite" "args" . "group" "partial") }}
+    {{ errorf "partial [assets/adapter/imagekit-rewrite.html] - Invalid arguments" -}}
+    {{ $error = true }}
+{{ end }}
+
+<!-- Initialize arguments -->
+{{ $account :=  .account }}
+{{ $container := trim .container "/" }}
+{{ $host := .host }}
+{{ $dir := .dir }}
+{{ $file := .file }}
+{{ $element := "" }}
+{{ with $container }}{{ $dir = strings.TrimPrefix (printf "/%s" .) $dir }}{{ end }}
+
+{{ if ne $host "ik.imagekit.io" }}
+    {{ $element = urls.JoinPath (slice "https://ik.imagekit.io" $account $dir $file) }}
+{{ else }}
+    {{ $element = urls.JoinPath (slice "https://" $host $dir $file) }}
+{{ end }}
+
+{{ return $element }}

layouts/partials/assets/helpers/image-definition.html

@@ -32,17 +32,28 @@
 
 <!-- Identify image provider -->
 {{ $hook := "" }}
+{{ $account := "" }}
+{{ $container := "" }}
+{{ $rewrite := false }}
 {{ range $provider, $val := site.Params.images }}
     {{ if not $hook }}    
         {{ with index $val "host" }}
             {{ if (findRE . (urls.Parse $url).Hostname) }}
                 {{ $hook = $provider }}
+                {{ with index $val "account" }}{{ $account = . }}{{ end }}
+                {{ with index $val "rewrite" }}{{ $rewrite = . }}{{ end }}
+                {{ with index $val "container" }}{{ $container = . }}{{ end }}
             {{ end }}
         {{ end }}
     {{ end }}
 {{ end }}
 {{ if not $hook }}{{ $hook = "hugo" }}{{ end }}
 
+<!-- Rewrite the origin URL if applicable -->
+{{ if $rewrite }}
+    {{ $url = partial "assets/helpers/image-rewrite.html" (dict "url" $url "account" $account "container" $container "hook" $hook) }}
+{{ end }}
+
 <!-- Define image dimensions -->
 {{ $dims := slice }}
 {{- $res := "" -}}

layouts/partials/assets/helpers/image-rewrite.html

@@ -0,0 +1,29 @@
+{{- $url := .url -}}
+{{- $account := .account -}}
+{{- $container := .container -}}
+{{ $hook := .hook }}
+
+{{ $host := (urls.Parse $url).Hostname }}
+{{ $dir := (urls.Parse $url).Path }}
+{{ $file := index ((split $dir "/") | collections.Reverse) 0 }}
+{{ $dir = strings.TrimSuffix $file $dir }}
+{{ $error := false }}
+
+{{ $adapter := (printf "assets/adapters/%s-rewrite.html" $hook) }}
+{{ if not (fileExists (path.Join "/layouts/partials" $adapter)) }}
+    {{ warnf "Cannot find adapter: %s" (path.Join "/layouts/partials" $adapter) }}
+    {{ $error = true }}
+{{ end }}
+
+{{ $result := $url }}
+{{ if not $error }}
+    {{ $result = partial $adapter (dict 
+        "account" $account
+        "container" $container
+        "host" $host
+        "dir" $dir
+        "file" $file
+    )}}
+{{ end }}
+
+{{ return $result }}

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "@gethinode/hinode",
-  "version": "0.24.0-beta6",
+  "version": "0.24.0-beta7",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@gethinode/hinode",
-      "version": "0.24.0-beta6",
+      "version": "0.24.0-beta7",
       "license": "MIT",
       "devDependencies": {
         "@fullhuman/postcss-purgecss": "^6.0.0",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gethinode/hinode",
-  "version": "0.24.0-beta6",
+  "version": "0.24.0-beta7",
   "description": "Hinode is a clean documentation and blog theme for Hugo, an open-source static site generator",
   "keywords": [
     "hugo",