allow specifying thumbnail with the original filename

fix #476

Author: saimn

docs/changelog.rst

@@ -14,6 +14,8 @@ Sigal now requires Python 3.11+.
 - Fix issue with latest version of feedgenerator.
 - Fix compat with click 8.2.0.
 - Fix theme URL for photoswipe.
+- Thumbnail can now be set in ``index.md`` either with the original filename or
+  with the thumbnail name after format conversion [:issue:`476`].
 
 Version 2.5
 ~~~~~~~~~~~

src/sigal/gallery.py

@@ -52,7 +52,7 @@
     get_size,
     process_image,
 )
-from .settings import Status, get_thumb
+from .settings import IMG_EXTENSIONS, Status, get_thumb
 from .utils import (
     Devnull,
     check_or_create_dir,
@@ -246,15 +246,10 @@ def __init__(self, filename, path, settings):
         super().__init__(filename, path, settings)
         imgformat = settings.get("img_format")
 
-        # Register all formats
-        PILImage.init()
-
-        if imgformat and PILImage.EXTENSION[self.src_ext] != imgformat.upper():
+        if imgformat and IMG_EXTENSIONS.ext2format[self.src_ext] != imgformat.upper():
             # Find the extension that should match img_format
-            extensions = {v: k for k, v in PILImage.EXTENSION.items()}
-            ext = extensions[imgformat.upper()]
+            ext = IMG_EXTENSIONS.format2ext[imgformat.upper()]
             self.dst_filename = self.basename + ext
-            self.thumb_name = get_thumb(self.settings, self.dst_filename)
 
     @cached_property
     def date(self):
@@ -593,76 +588,76 @@ def thumbnail(self):
         # Test the thumbnail from the Markdown file.
         thumbnail = self.meta.get("thumbnail", [""])[0]
 
-        if thumbnail and isfile(join(self.src_path, thumbnail)):
-            self._thumbnail = url_from_path(
-                join(self.name, get_thumb(self.settings, thumbnail))
-            )
+        if thumbnail:
+            # if thumbnail is set in the markdown, it can be either the
+            # original filename or the generated name after format conversion
+            if isfile(join(self.src_path, thumbnail)):
+                thumbnail = get_thumb(self.settings, thumbnail)
+            self._thumbnail = url_from_path(join(self.name, thumbnail))
             self.logger.debug("Thumbnail for %r : %s", self, self._thumbnail)
             return self._thumbnail
-        else:
-            # find and return the first landscape image
-            for f in self.medias:
-                ext = splitext(f.dst_filename)[1]
-                if ext.lower() not in self.settings["img_extensions"]:
-                    continue
-
-                # Use f.size if available as it is quicker (in cache), but
-                # fallback to the size of src_path if dst_path is missing
-                size = f.input_size
-                if size is None:
-                    size = f.file_metadata["size"]
-
-                if size["width"] > size["height"]:
+
+        # find and return the first landscape image
+        for f in self.medias:
+            ext = splitext(f.dst_filename)[1]
+            if ext.lower() not in self.settings["img_extensions"]:
+                continue
+
+            # Use f.size if available as it is quicker (in cache), but
+            # fallback to the size of src_path if dst_path is missing
+            size = f.input_size
+            if size is None:
+                size = f.file_metadata["size"]
+
+            if size["width"] > size["height"]:
+                try:
+                    self._thumbnail = url_quote(self.name) + "/" + f.thumbnail
+                except Exception as e:
+                    self.logger.info(
+                        "Failed to get thumbnail for %s: %s", f.dst_filename, e
+                    )
+                else:
+                    self.logger.debug(
+                        "Use 1st landscape image as thumbnail for %r : %s",
+                        self,
+                        self._thumbnail,
+                    )
+                    return self._thumbnail
+
+        # else simply return the 1st media file
+        if not self._thumbnail and self.medias:
+            for media in self.medias:
+                if media.thumbnail is not None:
                     try:
-                        self._thumbnail = url_quote(self.name) + "/" + f.thumbnail
+                        self._thumbnail = url_quote(self.name) + "/" + media.thumbnail
                     except Exception as e:
                         self.logger.info(
-                            "Failed to get thumbnail for %s: %s", f.dst_filename, e
+                            "Failed to get thumbnail for %s: %s",
+                            media.dst_filename,
+                            e,
                         )
                     else:
-                        self.logger.debug(
-                            "Use 1st landscape image as thumbnail for %r : %s",
-                            self,
-                            self._thumbnail,
-                        )
-                        return self._thumbnail
-
-            # else simply return the 1st media file
-            if not self._thumbnail and self.medias:
-                for media in self.medias:
-                    if media.thumbnail is not None:
-                        try:
-                            self._thumbnail = (
-                                url_quote(self.name) + "/" + media.thumbnail
-                            )
-                        except Exception as e:
-                            self.logger.info(
-                                "Failed to get thumbnail for %s: %s",
-                                media.dst_filename,
-                                e,
-                            )
-                        else:
-                            break
-                else:
-                    self.logger.warning("No thumbnail found for %r", self)
-                    return
+                        break
+            else:
+                self.logger.warning("No thumbnail found for %r", self)
+                return
 
-                self.logger.debug(
-                    "Use the 1st image as thumbnail for %r : %s", self, self._thumbnail
-                )
-                return self._thumbnail
-
-            # use the thumbnail of their sub-directories
-            if not self._thumbnail:
-                for path, album in self.gallery.get_albums(self.path):
-                    if album.thumbnail:
-                        self._thumbnail = url_quote(self.name) + "/" + album.thumbnail
-                        self.logger.debug(
-                            "Using thumbnail from sub-directory for %r : %s",
-                            self,
-                            self._thumbnail,
-                        )
-                        return self._thumbnail
+            self.logger.debug(
+                "Use the 1st image as thumbnail for %r : %s", self, self._thumbnail
+            )
+            return self._thumbnail
+
+        # use the thumbnail of their sub-directories
+        if not self._thumbnail:
+            for path, album in self.gallery.get_albums(self.path):
+                if album.thumbnail:
+                    self._thumbnail = url_quote(self.name) + "/" + album.thumbnail
+                    self.logger.debug(
+                        "Using thumbnail from sub-directory for %r : %s",
+                        self,
+                        self._thumbnail,
+                    )
+                    return self._thumbnail
 
         self.logger.error("Thumbnail not found for %r", self)
 

src/sigal/settings.py

@@ -26,6 +26,8 @@
 from os.path import abspath, isabs, join, normpath
 from pprint import pformat
 
+from PIL import Image as PILImage
+
 _DEFAULT_CONFIG = {
     "albums_sort_attr": "name",
     "albums_sort_reverse": False,
@@ -112,6 +114,20 @@ class Status:
     FAILURE = 1
 
 
+class _ImgExtensions:
+    def __init__(self):
+        # Register all formats
+        PILImage.init()
+
+        self.ext2format = PILImage.EXTENSION
+        self.format2ext = {v: k for k, v in PILImage.EXTENSION.items()}
+        self.format2ext["JPEG"] = ".jpg"  # prefered ext for jpg
+        self.format2ext["PNG"] = ".png"  # prefered ext for png
+
+
+IMG_EXTENSIONS = _ImgExtensions()
+
+
 def get_thumb(settings, filename):
     """Return the path to the thumb.
 
@@ -132,6 +148,11 @@ def get_thumb(settings, filename):
 
     if ext.lower() in settings["video_extensions"]:
         ext = ".jpg"
+
+    imgformat = settings.get("img_format")
+    if imgformat:
+        ext = IMG_EXTENSIONS.format2ext[imgformat]
+
     return join(
         path,
         settings["thumb_dir"],

tests/sample/sigal.conf.py

@@ -4,7 +4,7 @@
 thumb_suffix = ".tn"
 keep_orig = True
 thumb_video_delay = 5
-# img_format = 'jpeg'
+# img_format = "JPEG"
 
 links = [
     ("Example link", "http://example.org"),

tests/test_gallery.py

@@ -2,6 +2,7 @@
 import logging
 import os
 import re
+import shutil
 from os.path import join
 
 import pytest
@@ -151,14 +152,14 @@ def test_media_iptc_override(settings):
 
 
 def test_media_img_format(settings):
-    settings["img_format"] = "jpeg"
+    settings["img_format"] = "JPEG"
     m = Image("11.tiff", "dir1/test1", settings)
     path = join("dir1", "test1")
-    thumb = join("thumbnails", "11.tn.jpeg")
+    thumb = join("thumbnails", "11.tn.jpg")
 
-    assert m.dst_filename == "11.jpeg"
+    assert m.dst_filename == "11.jpg"
     assert m.src_path == join(settings["source"], path, "11.tiff")
-    assert m.dst_path == join(settings["destination"], path, "11.jpeg")
+    assert m.dst_path == join(settings["destination"], path, "11.jpg")
     assert m.thumb_name == thumb
     assert m.thumb_path == join(settings["destination"], path, thumb)
     assert m.title == "Foo Bar"
@@ -430,3 +431,27 @@ def test_ignores(settings, tmp_path):
     assert not (tmp_path / "test2").exists()
     assert not (tmp_path / "test1" / "example.gif").exists()
     assert not (tmp_path / "test1" / "CMB_Timeline300_no_WMAP.jpg").exists()
+
+
+@pytest.mark.parametrize("thumbnail", ["outdoor.heic", "outdoor.tn.jpg"])
+def test_thumbnail_with_img_format(settings, tmp_path, thumbnail):
+    """Test that outdoor.heic is correctly converted as jpg and used as thumbnail"""
+    src_path = tmp_path / "pictures"
+    src_path.mkdir()
+    shutil.copytree(
+        os.path.join(settings["source"], "dir1", "test1"), src_path / "test1"
+    )
+    desc = (src_path / "test1" / "index.md").read_text()
+    desc = desc.replace("Thumbnail: 11.jpg", f"Thumbnail: {thumbnail}")
+    (src_path / "test1" / "index.md").write_text(desc)
+
+    settings["img_format"] = "JPEG"
+    settings["thumb_dir"] = ""
+    settings["source"] = str(src_path)
+    settings["destination"] = str(tmp_path / "build")
+    gal = Gallery(settings, ncpu=1)
+    gal.build()
+
+    assert (tmp_path / "build" / "test1" / "outdoor.tn.jpg").is_file()
+    index = (tmp_path / "build" / "index.html").read_text()
+    assert 'src="test1/outdoor.tn.jpg" class="album_thumb"' in index