Merge pull request #62 from ktt-ol/feature/better-albums

feat: previous/next on albums and reproducible results

Author: lordiii

albums.py

@@ -4,14 +4,14 @@
 import os
 import shutil
 import tempfile
-import time
-from datetime import datetime
+from datetime import datetime, timedelta
 from os.path import join as join_path
 from threading import Thread
 
 import requests
 from slugify import slugify
 
+albums_web_path = "images/albums"
 albums_path = "content/images/albums"
 cover_path = "album_covers"
 albums_url = "https://www.mainframe.io/media/album-images"
@@ -26,7 +26,14 @@ def join_folder_path(path_components: list[str]) -> str:
     return os.path.sep.join(slugged_path_components)
 
 
-def join_web_path(path_components: list[str]) -> str:
+def join_web_path(path_components: list[str], use_slug: bool = False) -> str:
+    if use_slug:
+        slugged = []
+        for component in path_components:
+            slugged.append(slugify(component))
+
+        path_components = slugged
+
     return '/'.join(path_components)
 
 
@@ -70,7 +77,7 @@ def create_index_md(path_components: list[str], tmp_folder_albums: str, tmp_fold
     f.write('title = "' + title + '"\n')
     f.write('template = "album/album-list.html"\n')
     f.write('sort_by = "date"\n')
-    f.write('weight = ' + str(int(time.mktime(created_at.timetuple()))) + '\n')
+    f.write('weight = ' + str(int(created_at.timestamp() * 1000)) + '\n')
 
     f.write('[extra]\n')
     f.write('display_name = "' + title + '"\n')
@@ -84,18 +91,22 @@ def create_index_md(path_components: list[str], tmp_folder_albums: str, tmp_fold
     f.close()
 
 
+def generate_image_filename(path_components: list[str], lang: str, index: int) -> str:
+    filename = f"img{index:03d}" + lang + ".md"
+    path = join_path(join_folder_path(path_components), filename)
+
+    return path
+
+
 def create_image_md(path_components: list[str], tmp_folder_albums: str, metadata: dict, created_at: datetime,
-                    lang: str) -> None:
+                    lang: str, index: int, image_count: int) -> None:
     if lang != "":
         lang = "." + lang
 
     base_uri = join_web_path(path_components)
 
-    date_str = created_at.strftime("%Y-%m-%d")
-    time_str = created_at.strftime("%H:%M:%S")
-
-    page_filename = date_str + "-" + slugify(metadata["filename"]) + lang + ".md"
-    image_file_path = join_path(tmp_folder_albums, join_folder_path(path_components), page_filename)
+    filename = generate_image_filename(path_components, lang, index)
+    image_file_path = join_path(tmp_folder_albums, filename)
 
     if os.path.exists(image_file_path):
         raise FileExistsError(image_file_path)
@@ -105,56 +116,129 @@ def create_image_md(path_components: list[str], tmp_folder_albums: str, metadata
     image_file.write("+++\n")
     image_file.write('title = "' + metadata["filename"] + '"\n')
     image_file.write('template = "album/album-single.html"\n')
-    image_file.write('sort_by = "title"\n')
-    image_file.write('date = ' + date_str + "T" + time_str + '\n')
+    image_file.write('date = "' + created_at.strftime("%Y-%m-%dT%H:%M:%S") + '"\n')
+
+    # add old path as alias
+    alias = "/".join([albums_web_path, join_web_path(path_components, True), slugify(metadata["filename"])])
+    image_file.write('aliases = ["/' + alias + '"]\n')
 
     image_file.write('[extra]\n')
     image_file.write('filename = "' + metadata["filename"] + '"\n')
     image_file.write('height = ' + str(metadata["height"]) + "\n")
     image_file.write('width = ' + str(metadata["width"]) + "\n")
     image_file.write('file_uri = "' + albums_url + "/" + base_uri + "/" + metadata["filename"] + '"\n')
-    image_file.write('file_uri_300 = "' + albums_url + "/" + base_uri + "/.thumbs/300-" + metadata["filename"] + '"\n')
 
     # Albums do not have 750 pixel thumbnail, use 1200 instead
-    image_file.write('file_uri_750 = "' + albums_url + "/" + base_uri + "/.thumbs/1200-" + metadata["filename"] + '"\n')
-    image_file.write(
-        'file_uri_1200 = "' + albums_url + "/" + base_uri + "/.thumbs/1200-" + metadata["filename"] + '"\n')
+    thumbs_base = albums_url + "/" + base_uri + "/.thumbs/"
+    image_file.write('file_uri_300 = "' + thumbs_base + "300-" + metadata["filename"] + '"\n')
+    image_file.write('file_uri_750 = "' + thumbs_base + "1200-" + metadata["filename"] + '"\n')
+    image_file.write('file_uri_1200 = "' + thumbs_base + "1200-" + metadata["filename"] + '"\n')
+
+    if index > 0:
+        prev_filename_web = generate_image_filename(path_components, lang, index - 1).replace(os.path.sep, "/")
+        image_file.write(
+            'previous = "/' + albums_web_path + "/" + prev_filename_web + '"\n')
+
+    if (index + 1) < image_count:
+        next_filename_web = generate_image_filename(path_components, lang, index + 1).replace(os.path.sep, "/")
+        image_file.write(
+            'next = "/' + albums_web_path + "/" + next_filename_web + '"\n')
+
     image_file.write("+++\n")
     image_file.close()
 
 
+def normalize_images(images_metadata: list[dict]) -> list[tuple[dict, datetime]]:
+    images = []
+    current_date = None
+
+    for image_metadata in images_metadata:
+        if image_metadata["exif"]["time"] is not None:
+            new_date = datetime.fromtimestamp(int(image_metadata["exif"]["time"]) / 1000)
+
+            if current_date is None or new_date > current_date:
+                current_date = new_date
+
+        if current_date is None:
+            image_created_at = datetime.fromtimestamp(0)
+        else:
+            image_created_at = current_date
+
+        images.append((image_metadata, image_created_at))
+
+    images.sort(key=lambda x: (x[1], x[0]["filename"]))
+
+    return images
+
+
+def normalize_folders(folder_metadata: list[dict]) -> list[tuple[dict, datetime]]:
+    folders = []
+
+    for folder in folder_metadata:
+        if folder["time"] is not None:
+            new_date = datetime.fromtimestamp(folder["time"] / 1000)
+        else:
+            print("'" + folder["title"] + "' is missing a date")
+            new_date = datetime.fromtimestamp(0)
+
+        folders.append((folder, new_date))
+
+    folders.sort(key=lambda x: (x[1], x[0]["foldername"]))
+
+    # Ensure that each album has its own unique timestamp associated with it to allow unique stubs and
+    # deterministic list outputs in zola as it does not support sorting by more than one property
+    unique_folders = []
+    last_timestamp = None
+    last_folder = None
+    for folder, ts in folders:
+        if last_folder is None:
+            last_folder = folder
+        if last_timestamp is not None and ts <= last_timestamp:
+            new_ts = last_timestamp + timedelta(hours=1)
+            print("Adjusting '" + folder["title"] + "' from '" + str(ts) + "' (cause: '"
+                  + last_folder["title"] + "') to '" + str(new_ts) + "'")
+            ts = new_ts
+        else:
+            last_folder = folder
+
+        unique_folders.append((folder, ts))
+        last_timestamp = ts
+        folder["time"] = ts
+
+    folders.sort(key=lambda x: (x[1], x[0]["foldername"]))
+
+    return unique_folders
+
+
 def create_album_folder(path_components: list[str], tmp_folder_albums: str, tmp_folder_covers: str,
                         metadata: dict) -> None:
     path_components = path_components.copy()
     path_components.append(metadata["foldername"])
 
-    if metadata['time'] is not None:
-        album_created_at = datetime.fromtimestamp(int(metadata["time"]) / 1000)
-    else:
-        print("Album has no creation date: ", path_components)
-        album_created_at = datetime.fromtimestamp(0)
-
     joined_path = join_folder_path(path_components)
 
     album_folder = join_path(tmp_folder_albums, joined_path)
     os.makedirs(album_folder)
 
-    create_index_md(path_components, tmp_folder_albums, tmp_folder_covers, metadata, album_created_at, "")
+    create_index_md(path_components, tmp_folder_albums, tmp_folder_covers, metadata, metadata["time"], "")
 
     current_metadata = get_url_metadata(path_components)
-    for image_metadata in current_metadata["images"]:
-        if image_metadata['exif']['time'] is not None:
-            image_created_at = datetime.fromtimestamp(int(image_metadata['exif']['time']) / 1000)
-        else:
-            image_created_at = datetime.fromtimestamp(0)
 
-        create_image_md(path_components, tmp_folder_albums, image_metadata, image_created_at, "")
+    images = normalize_images(current_metadata["images"])
+
+    for i, (image_metadata, image_created_at) in enumerate(images):
+        create_image_md(path_components, tmp_folder_albums, image_metadata, image_created_at, "", i, len(images))
 
     sub_threads = []
 
-    for sub_directory in current_metadata["subDirs"]:
+    sub_folders = normalize_folders(current_metadata["subDirs"])
+
+    for (sub_folder, timestamp) in sub_folders:
+        # Use the normalized timestamp for the subfolder so that album_created_at
+        # is based on the adjusted, uniqueness-enforced value in recursive calls.
+        sub_folder["time"] = timestamp
         sub_thread = Thread(target=create_album_folder,
-                            args=(path_components, tmp_folder_albums, tmp_folder_covers, sub_directory))
+                            args=(path_components, tmp_folder_albums, tmp_folder_covers, sub_folder))
         sub_thread.start()
         sub_threads.append(sub_thread)
 
@@ -168,9 +252,12 @@ def create_album_folder(path_components: list[str], tmp_folder_albums: str, tmp_
 tmp_ktt_ol_cover = tempfile.mkdtemp(prefix="ktt_ol_cover")
 
 threads = []
-for directory in base_metadata["subDirs"]:
+
+base_sub_folders = normalize_folders(base_metadata["subDirs"])
+
+for (base_sub_folder, timestamp) in base_sub_folders:
     thread = Thread(target=create_album_folder,
-                    args=([], tmp_ktt_ol_albums, tmp_ktt_ol_cover, directory)
+                    args=([], tmp_ktt_ol_albums, tmp_ktt_ol_cover, base_sub_folder)
                     )
     thread.start()
     threads.append(thread)

templates/album/album-list.html

@@ -57,7 +57,7 @@ <h3 class="d-flex justify-content-between">
 
                     {% set scaling = 200 / latest_page.extra.height %}
                     {% set height = 200 %}
-                    {% set width = latest_page.extra.width * scaling %}
+                    {% set width = latest_page.extra.width * scaling  %}
 
                     {% if width > 1150 %}
                         {% set image_uri = latest_page.extra.file_uri %}
@@ -70,6 +70,8 @@ <h3 class="d-flex justify-content-between">
                     {% endif %}
                 {% endif %}
 
+                {% set width = width | round(method="ceil", precision=0) %}
+
                 <a href="{{ macros::rel_url(path=subsection_data.path, lang=lang) }}"
                    class="text-decoration-none rounded-1 p-0 overflow-hidden border border-1"
                    style="height: {{ height }}px; width: {{ width }}px;">
@@ -119,6 +121,8 @@ <h3 class="p-0 m-0 text-white border-0"><span
                 {% set image_uri = page.extra.file_uri_300 %}
             {% endif %}
 
+            {% set width = width | round(method="ceil", precision=0) %}
+
             <a class="text-decoration-none" href="{{ macros::rel_url(path=page.path, lang=lang) }}"
                style="height: {{ height }}px; width: {{ width }}px;">
                 <img alt=""