sigal 2.4__py3-none-any.whl → 2.6__py3-none-any.whl

sigal/plugins/zip_gallery.py

@@ -18,7 +18,7 @@
 # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 # IN THE SOFTWARE.
 
-""" This plugin controls the generation of a ZIP archive for a gallery
+"""This plugin controls the generation of a ZIP archive for a gallery
 
 If the ``zip_gallery`` setting is set, it contains the location of a zip
 archive with all original images of the corresponding directory.

sigal/settings.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2009-2023 - Simon Conseil
+# Copyright (c) 2009-2026 - Simon Conseil
 # Copyright (c) 2013      - Christophe-Marie Duquesne
 # Copyright (c) 2017      - Mate Lakat
 # Copyright (c) 2021      - Keith Feldman
@@ -26,13 +26,17 @@ import os
 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,
     "autorotate_images": True,
+    "autoplay": False,
     "colorbox_column_size": 3,
     "copy_exif_data": False,
     "datetime_format": "%c",
+    "display_timestamp": False,
     "destination": "_build",
     "files_to_copy": (),
     "galleria_theme": "classic",
@@ -40,7 +44,16 @@ _DEFAULT_CONFIG = {
     "google_tag_manager": "",
     "ignore_directories": [],
     "ignore_files": [],
-    "img_extensions": [".jpg", ".jpeg", ".png", ".gif", ".tif", ".tiff", ".webp"],
+    "img_extensions": [
+        ".jpg",
+        ".jpeg",
+        ".png",
+        ".gif",
+        ".heic",
+        ".tif",
+        ".tiff",
+        ".webp",
+    ],
     "img_processor": "ResizeToFit",
     "img_size": (640, 480),
     "img_format": None,
@@ -101,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.
 
@@ -121,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"],
@@ -162,7 +194,7 @@ def read_settings(filename=None):
                 settings[p] = abspath(normpath(join(settings_path, path)))
                 logger.debug("Rewrite %s : %s -> %s", p, path, settings[p])
 
-    for key in ("img_size", "thumb_size", "video_size"):
+    for key in ("img_size", "video_size"):
         if settings[key]:
             w, h = settings[key]
             if h > w:

sigal/templates/sigal.conf.py

@@ -39,6 +39,9 @@ theme = "galleria"
 # Path to a CSS file that can be used to customize themes
 # user_css =
 
+# Enable autoplay (galleria only)
+# autoplay = False
+
 # ----------------
 # Image processing (ignored if use_orig = True)
 # ----------------
@@ -63,7 +66,7 @@ img_size = (800, 600)
 # map_height = '500px'
 
 # File extensions that should be treated as images
-# img_extensions = ['.jpg', '.jpeg', '.png', '.gif']
+# img_extensions = [".jpg", ".jpeg", ".png", ".gif", ".heic", ".tif", ".tiff", ".webp"]
 
 # Pilkit processor used to resize the image
 # (see http://pilkit.readthedocs.org/en/latest/#processors)
@@ -86,6 +89,9 @@ img_size = (800, 600)
 # https://docs.python.org/3/library/datetime.html#strftime-strptime-behavior
 # datetime_format = '%c'
 
+# Display generated datetime in the resulting output
+# display_timestamp = False
+
 # Jpeg options
 # jpg_options = {'quality': 85,
 #                'optimize': True,
@@ -128,7 +134,7 @@ thumb_size = (280, 210)
 # thumb_video_black_max_colors = 4
 
 # Keep original image (default: False)
-# keep_orig = True
+# keep_orig = False
 
 # Subdirectory for original images
 # orig_dir = 'original'
@@ -158,7 +164,7 @@ thumb_size = (280, 210)
 # Filter directories and files.
 # The settings take a list of patterns matched with the fnmatch module on the
 # path relative to the source directory:
-# http://docs.python.org/2/library/fnmatch.html
+# http://docs.python.org/3/library/fnmatch.html
 ignore_directories = []
 ignore_files = []
 
@@ -281,7 +287,6 @@ ignore_files = []
 #     'sigal.plugins.media_page',
 #     'sigal.plugins.nomedia',
 #     'sigal.plugins.nonmedia_files',
-#     'sigal.plugins.upload_s3',
 #     'sigal.plugins.watermark',
 #     'sigal.plugins.zip_gallery',
 # ]
@@ -317,13 +322,6 @@ ignore_files = []
 #     'thumb_font_size': 40, # only applies when a font is selected
 # }
 
-# Settings for upload to s3 plugin
-# upload_s3_options = {
-# 	'bucket': 'my-bucket',
-# 	'policy': 'public-read',
-# 	'overwrite': False
-# }
-
 # Set zip_gallery to either False or a file name. The file name can
 # be formatted python style with an 'album' variable, for example
 # '{album.name}.zip'. The final archive will contain all resized or

sigal/themes/colorbox/templates/album.html

@@ -16,47 +16,49 @@
 
   {% include 'map.html' %}
   <div id="gallery">
-    {% for media in album.medias | selectattr("type", "in", ("image", "video")) %}
+    {% for media in album.medias %}
       {% if loop.index % nb_columns == 1 %}
-      <div id="albums" class="row">
+    <div id="albums" class="row">
       {% endif%}
-      {% if media.type == "image" %}
+      {% if media.thumbnail %}
       <div class="{{ column_size_t }} columns thumbnail">
+      {% if media.type == "image" %}
+        <a class="gallery" title="{{ media.title }}" {{ img_description(media) }}
+        {% if 'sigal.plugins.media_page' in settings.plugins %}
+           href="{{ media.url }}.html" data-href="{{ media.url }}"
+        {% else %}
+           href="{{ media.url }}"
+        {% endif %}
+      {% elif media.type == "video" %}
+        {% set mhash = media.url|replace('.', '')|replace(' ', '') %}
         {% if 'sigal.plugins.media_page' in settings.plugins %}
-        <a href="{{ media.url}}.html" class="gallery"
-          title="{{ media.title }}"
-          data-href="{{ media.url }}" {{ img_description(media) }}>
+        <a href="{{ media.url }}.html" data-href="#{{ mhash }}"
         {% else %}
-        <a href="{{ media.url }}" class="gallery" title="{{ media.title }}"
-          {{ img_description(media) }}>
+        <a href="#{{ mhash }}" class="gallery" inline='yes' title="{{ media.url }}"
         {% endif %}
+        {% if media.big %} data-big="{{ media.big_url }}"{% endif %}
+      {% else %}
+        <a href="{{ media.url }}" title="{{ media.title }}"
+      {% endif %}
+        >
           <img src="{{ media.thumbnail }}" alt="{{ media.url }}"
-              title="{{ media.title }}" /></a>
+               title="{{ media.title }}">
+        </a>
       </div>
       {% endif %}
+
       {% if media.type == "video" %}
-        {% set mhash = media.url|replace('.', '')|replace(' ', '') %}
-        <div class="{{ column_size_t }} columns thumbnail">
-          {% if 'sigal.plugins.media_page' in settings.plugins %}
-          <a href="{{ media.url }}.html" data-href="#{{ mhash }}"
-          {% else %}
-          <a href="#{{ mhash }}" class="gallery" inline='yes' title="{{ media.url }}"
-          {% endif %}
-            {% if media.big %} data-big="{{ media.big_url }}"{% endif %}>
-            <img src="{{ media.thumbnail }}" alt="{{ media.url }}"
-                title="{{ media.title }}" /></a>
-        </div>
-        <!-- This contains the hidden content for the video -->
-        <div style='display:none'>
-          <div id="{{ mhash }}">
-            <video controls>
-            <source src='{{ media.url }}' type='{{ media.mime }}' />
-            </video>
-          </div>
+      <!-- This contains the hidden content for the video -->
+      <div style='display:none'>
+        <div id="{{ mhash }}">
+          <video controls>
+          <source src='{{ media.url }}' type='{{ media.mime }}' />
+          </video>
         </div>
+      </div>
       {% endif %}
       {% if loop.last or loop.index % nb_columns == 0 %}
-      </div>
+    </div>
       {% endif%}
     {% endfor %}
   </div>

sigal/themes/default/templates/description.html

@@ -0,0 +1,29 @@
+{% macro img_description(media, with_big=True) -%}
+  {%- if with_big and media.big -%}
+    <a href='{{ media.big_url }}'>Full size</a>
+  {%- endif -%}
+  {%- if media.description -%}
+    <br>{{ media.description }}
+  {%- endif -%}
+  {%- if media.exif -%}
+    <div class='film-meta'>
+      {%- if media.exif.iso -%}
+        <abbr title='film speed'>{{ media.exif.iso }}</abbr> {%- endif -%}
+      {%- if media.exif.exposure -%}
+        <abbr title='exposure'>{{ media.exif.exposure }}</abbr> {%- endif -%}
+      {%- if media.exif.fstop -%}
+        <abbr title='aperture'>{{ media.exif.fstop }}</abbr> {%- endif -%}
+      {%- if media.exif.focal -%}
+        <abbr title='focal length'>{{ media.exif.focal }}</abbr> {%- endif -%}
+    </div>
+    {%- if media.exif.gps -%}
+      <a title='location' href='https://www.openstreetmap.org/?mlat={{ media.exif.gps.lat }}&amp;mlon={{ media.exif.gps.lon}}&amp;zoom=12&amp;layers=M' target='_blank' class='map' >{{ 'N{:.6f}'.format(media.exif.gps.lat) if media.exif.gps.lat > 0 else 'S{:.6f}'.format(-media.exif.gps.lat) }}{{ 'E{:.6f}'.format(media.exif.gps.lon) if media.exif.gps.lon > 0 else 'W{:.6f}'.format(-media.exif.gps.lon) }}</a>
+    {%- endif -%}
+    {%- if media.exif.Make or media.exif.Model -%}
+      <abbr title='camera make and model'>{{ media.exif.Make }} {{ media.exif.Model }}</abbr>
+    {%- endif -%}
+    {%- if media.exif.datetime -%}
+      <abbr title='date'>{{ media.exif.datetime }}</abbr>
+    {%- endif -%}
+  {% endif %}
+{%- endmacro %}

sigal/themes/default/templates/footer.html

@@ -12,5 +12,8 @@
         <span><a href={{ settings.atom_feed.feed_url }}>Atom Feed</a></span>
       {% endif %}
     {% endif %}
+    {% if settings.display_timestamp %}
+        @ {{ generated_timestamp }}
+    {% endif %}
   </p>
 </footer>

sigal/themes/galleria/templates/album_items.html

@@ -1,3 +1,4 @@
+{% from 'description.html' import img_description %}
 <div class="icons">
   <a id="fullscreen"><img src="{{ theme.url }}/img/fullscreen.png"
                           title="Fullscreen" alt="Fullscreen (f)" /></a>
@@ -17,29 +18,6 @@
 
 {% block late_js %}
   {% if album.medias %}
-    {% macro img_description(media) -%}
-      {%- if media.big -%}<a href='{{ media.big_url }}'>Full size</a>{%- endif -%}
-      {# clean up tags and whitespace, including newlines, in the description #}
-      {%- if media.description -%}<br>{{ media.description | striptags }}{%- endif -%}
-      {%- if media.exif -%}
-        <div class='film-meta'>
-        {%- if media.exif.iso -%}<abbr title='film speed'>{{ media.exif.iso }}</abbr> {%- endif -%}
-        {%- if media.exif.exposure -%}<abbr title='exposure'>{{ media.exif.exposure }}</abbr> {%- endif -%}
-        {%- if media.exif.fstop -%}<abbr title='aperture'>{{ media.exif.fstop }}</abbr> {%- endif -%}
-        {%- if media.exif.focal -%}<abbr title='focal length'>{{ media.exif.focal }}</abbr> {%- endif -%}
-        </div>
-        {%- if media.exif.gps -%}
-          <a title='location' href='https://www.openstreetmap.org/?mlat={{ media.exif.gps.lat }}&amp;mlon={{ media.exif.gps.lon}}&amp;zoom=12&amp;layers=M' target='_blank' class='map' >{{ 'N{:.6f}'.format(media.exif.gps.lat) if media.exif.gps.lat > 0 else 'S{:.6f}'.format(-media.exif.gps.lat) }}{{ 'E{:.6f}'.format(media.exif.gps.lon) if media.exif.gps.lon > 0 else 'W{:.6f}'.format(-media.exif.gps.lon) }}</a>
-        {%- endif -%}
-        {%- if media.exif.Make or media.exif.Model -%}
-          <abbr title='camera make and model'>{{ media.exif.Make }} {{ media.exif.Model }}</abbr>
-        {%- endif -%}
-        {%- if media.exif.datetime -%}
-          <abbr title='date'>{{ media.exif.datetime }}</abbr>
-        {%- endif -%}
-      {% endif %}
-    {%- endmacro %}
-
     <script src="{{ theme.url }}/jquery-3.3.1.min.js"></script>
     <script src="{{ theme.url }}/galleria.min.js"></script>
     <script src="{{ theme.url }}/themes/{{ settings.galleria_theme }}/galleria.{{ settings.galleria_theme }}.min.js"></script>
@@ -49,7 +27,7 @@
       {% for media in album.medias -%}
       {
         title: "{{ media.title }}",
-        description: "{{ img_description(media) | e }}",
+        description: {{ img_description(media) | tojson }},
         thumb: "{{ media.thumbnail }}",
         {% if media.big %}
         big: "{{ media.big_url }}",
@@ -93,6 +71,7 @@
     });
 
     Galleria.configure({
+        {% if settings.autoplay %}autoplay: true,{% endif %}
         imageCrop: false,
         transition: "fade",
         thumbnails: "lazy"