f2.8gallery.py

#!/usr/bin/env python3
import argparse
import datetime
import os
import re
import shutil
import sys
from jinja2 import Environment, FileSystemLoader
from pprint import pprint
from urllib.request import urlretrieve

# PIL may be installed as "Pil" or similar on case-insensitive filesytems
try:
    from PIL import Image, ImageOps
except ImportError:
    try:
        from Pil import Image, ImageOps
    except ImportError:
        from pil import Image, ImageOps


def regex_replace(s, find, replace):
    """Implement a regex filter for jinja2"""
    return re.sub(find, replace, s)


def create_if_not_exists(dir):
    """Create a directory if it does not exist"""
    if not os.path.isdir(dir):
        os.mkdir(path=dir, mode=0o755)


def main():
    parser = argparse.ArgumentParser(description="f2.8gallery static site generator")
    parser.add_argument(
        "-c",
        "--clean",
        help="Clean the output directory before building",
        required=False,
        action="store_true",
    )
    parser.add_argument(
        "-t",
        "--title",
        help="Title of the site",
        required=False,
        default="John Smith's Portfolio",
    )
    parser.add_argument(
        "-a",
        "--author",
        help="Name of the photographer",
        required=False,
        default="John Smith",
    )
    parser.add_argument(
        "-w",
        "--thumbwidth",
        help="Width of thumbnails in the gallery (in pixels)",
        required=False,
        default=400,
        type=int,
    )
    parser.add_argument(
        "-d",
        "--debug",
        help="Enable debug messages",
        required=False,
        action="store_true",
    )
    parser.add_argument("galleries", help="Path to the input directory of galleries")
    parser.add_argument(
        "output",
        help="Path to the directory where the output files should be generated",
    )
    args = parser.parse_args()

    if args.clean is not None and args.clean:
        print(f"cleaning {args.output}")
        shutil.rmtree(args.output, ignore_errors=True)

    if not os.path.isdir(args.galleries):
        print(f"Error: cannot find galleries directory: {args.galleries}")
        sys.exit(1)

    # create necessary directories if they don't exist
    create_if_not_exists(args.output)
    thumbnails_dir = f"{args.output}{os.path.sep}thumbnails"
    create_if_not_exists(thumbnails_dir)
    create_if_not_exists(f"{args.output}{os.path.sep}assets")
    create_if_not_exists(f"{args.output}{os.path.sep}assets{os.path.sep}img")
    create_if_not_exists(f"{args.output}{os.path.sep}assets{os.path.sep}js")
    create_if_not_exists(f"{args.output}{os.path.sep}assets{os.path.sep}css")
    create_if_not_exists(
        f"{args.output}{os.path.sep}assets{os.path.sep}css{os.path.sep}font"
    )

    shutil.copytree(
        args.galleries, f"{args.output}{os.path.sep}galleries", dirs_exist_ok=True
    )
    shutil.copytree(
        f"assets{os.path.sep}img",
        f"{args.output}{os.path.sep}assets{os.path.sep}img",
        dirs_exist_ok=True,
    )
    shutil.copytree(
        f"assets{os.path.sep}css",
        f"{args.output}{os.path.sep}assets{os.path.sep}css",
        dirs_exist_ok=True,
    )
    shutil.copytree(f"assets{os.path.sep}root", f"{args.output}", dirs_exist_ok=True)

    thumbnail_size_scaled_up = (
        args.thumbwidth * 1.2
    )  # comes from "scale120" hover effect
    thumbnail_wh = (thumbnail_size_scaled_up, thumbnail_size_scaled_up)
    gallery_names = []
    galleries = {}

    print("generating thumbnails")
    gallery_paths = [x[0] for x in os.walk(args.galleries)]
    for path in gallery_paths:
        if path != args.galleries:
            gallery_name = path.split(os.path.sep)[-1]
            thumbnail_dir = f"{thumbnails_dir}{os.path.sep}{gallery_name}"
            galleries[gallery_name] = {}
            galleries[gallery_name]["gallery_dir"] = path
            galleries[gallery_name]["thumbnail_dir"] = thumbnail_dir
            galleries[gallery_name]["gallery_url"] = f"galleries/{gallery_name}"
            galleries[gallery_name]["thumbnail_url"] = f"thumbnails/{gallery_name}"
            galleries[gallery_name]["files"] = []
            create_if_not_exists(thumbnail_dir)
            for file in os.listdir(path):
                gallery_names.append(gallery_name)
                galleries[gallery_name]["files"].append(file)
                thumbnail = f"{thumbnail_dir}{os.path.sep}{file}"
                if not os.path.isfile(thumbnail):
                    if args.debug:
                        print(f"Creating thumbnail for {file} as {thumbnail}")
                    image = Image.open(f"{path}{os.path.sep}{file}")
                    image = ImageOps.exif_transpose(image)
                    image.thumbnail(thumbnail_wh)
                    image.save(thumbnail)

    if args.debug:
        pprint(galleries)

    print("generating HTML page")
    env = Environment(loader=FileSystemLoader("."))
    env.filters["regex_replace"] = regex_replace
    template = env.get_template("index.j2")
    index = open(f"{args.output}{os.path.sep}index.html", "w")
    index.write(
        template.render(
            webpage_name=args.title,
            author=args.author,
            thumbwidth=args.thumbwidth,
            now=datetime.datetime.now(),
            base=args.galleries,
            galleries=galleries,
            output=args.output,
        )
    )
    index.close()

    print("downloading required libraries")
    urlretrieve(
        "https://code.jquery.com/jquery-3.7.1.slim.min.js",
        f"{args.output}{os.path.sep}assets{os.path.sep}js{os.path.sep}jquery.min.js",
    )
    urlretrieve(
        "https://raw.githubusercontent.com/nanostudio-org/nanogallery2/master/dist/css/nanogallery2.min.css",
        f"{args.output}{os.path.sep}assets{os.path.sep}css{os.path.sep}nanogallery2.min.css",
    )
    urlretrieve(
        "https://raw.githubusercontent.com/nanostudio-org/nanogallery2/master/dist/jquery.nanogallery2.min.js",
        f"{args.output}{os.path.sep}assets{os.path.sep}js{os.path.sep}jquery.nanogallery2.min.js",
    )
    urlretrieve(
        "https://raw.githubusercontent.com/kylefox/jquery-modal/v0.9.1/jquery.modal.min.js",
        f"{args.output}{os.path.sep}assets{os.path.sep}js{os.path.sep}jquery.modal.min.js",
    )
    urlretrieve(
        "https://raw.githubusercontent.com/kylefox/jquery-modal/v0.9.1/jquery.modal.min.css",
        f"{args.output}{os.path.sep}assets{os.path.sep}css{os.path.sep}jquery.modal.min.css",
    )
    urlretrieve(
        "https://cdn.jsdelivr.net/npm/purecss@3.0.0/build/pure-min.css",
        f"{args.output}{os.path.sep}assets{os.path.sep}css{os.path.sep}pure-min.css",
    )
    urlretrieve(
        "https://cdn.jsdelivr.net/npm/purecss@3.0.0/build/grids-responsive-min.css",
        f"{args.output}{os.path.sep}assets{os.path.sep}css{os.path.sep}grids-responsive-min.css",
    )
    urlretrieve(
        "https://github.com/nanostudio-org/nanogallery2/raw/master/dist/css/font/ngy2_icon_font.woff",
        f"{args.output}{os.path.sep}assets{os.path.sep}css{os.path.sep}font{os.path.sep}ngy2_icon_font.woff",
    )
    urlretrieve(
        "https://github.com/nanostudio-org/nanogallery2/raw/master/dist/css/font/ngy2_icon_font.woff2",
        f"{args.output}{os.path.sep}assets{os.path.sep}css{os.path.sep}font{os.path.sep}ngy2_icon_font.woff2",
    )
    print(f"site successfully generated at {args.output}!")


if __name__ == "__main__":
    main()