photo-objects 0.0.6__tar.gz → 0.0.7__tar.gz

{photo_objects-0.0.6 → photo_objects-0.0.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: photo-objects
-Version: 0.0.6
+Version: 0.0.7
 Summary: Application for storing photos in S3 compatible object-storage.
 Author: Toni Kangas
 License: MIT License

photo_objects-0.0.7/photo_objects/django/views/ui/configuration.py

@@ -0,0 +1,188 @@
+from dataclasses import dataclass
+
+from django.http import HttpRequest
+from django.shortcuts import render
+from django.urls import reverse
+from django.utils.translation import gettext_lazy as _
+
+from photo_objects.django.models import Album
+from photo_objects.django.views.utils import BackLink, render_markdown
+
+from .utils import json_problem_as_html
+
+
+@dataclass
+class Validation:
+    check: str
+    status: str
+    detail: str = None
+
+    def __post_init__(self):
+        self.detail = render_markdown(self.detail)
+
+
+def status(ok: bool, warning=False) -> str:
+    if ok:
+        return _("OK")
+    if warning:
+        return _("Warning")
+    return _("Error")
+
+
+def uses_https(request: HttpRequest) -> Validation:
+    ok = request.is_secure()
+    warning = False
+    detail = (
+        'The request received by the API server was '
+        f'{"" if ok else "not "}secure.')
+
+    if not ok:
+        referer = request.META.get("HTTP_REFERER", "")
+        if request.site.domain in referer and referer.startswith("https://"):
+            warning = True
+
+            detail += _(
+                ' If you are running the API server behind a reverse proxy or '
+                'a load-balancer, ensure that HTTPS termination is configured '
+                f'correctly. ({request.META})')
+
+    return Validation(
+        check=_("Site is served over HTTPS"),
+        status=status(ok, warning),
+        detail=detail
+    )
+
+
+def site_is_configured(request: HttpRequest) -> Validation:
+    detail = (
+        'Site domain is configured to a non-default value: '
+        f'`{request.site.domain}`'
+    )
+    try:
+        ok = request.site.domain != "example.com"
+        if not ok:
+            detail = (
+                'Site domain is set to `example.com`. This is a placeholder '
+                'domain and should be changed to the actual domain of the '
+                'site.')
+    except Exception as e:
+        ok = False
+        detail = (
+            f"Failed to resolve site domain: got `{str(e)}`. Check that sites "
+            "framework is installed, site middleware is configured, and that "
+            "the site exists in the database.")
+
+    return Validation(
+        check=_("Site is configured"),
+        status=status(ok),
+        detail=detail,
+    )
+
+
+def domain_matches_request(request: HttpRequest) -> Validation:
+    detail = None
+    try:
+        host = request.get_host().lower()
+        domain = request.site.domain.lower()
+        ok = request.get_host() == request.site.domain
+        if not ok:
+            detail = (
+                'Host in the request does not match domain configured for '
+                f'the site: expected `{domain}`, got `{host}`.')
+        else:
+            detail = (
+                f'Host in the request, `{host}`, matches domain configured '
+                f'for the site, `{domain}`.'
+            )
+    except Exception as e:
+        ok = False
+        detail = (
+            f"Failed to resolve host or domain: got `{str(e)}`. Check that "
+            "sites framework is installed, site middleware is configured, "
+            "and that the site exists in the database.")
+
+    return Validation(
+        check=_("Configured domain matches host in request"),
+        status=status(ok),
+        detail=detail,
+    )
+
+
+def site_preview_configured(
+        request: HttpRequest,
+        album: Album | Exception) -> Validation:
+    detail = None
+
+    if isinstance(album, Exception):
+        ok = False
+        detail = f'Failed to resolve site or album: `{str(album)}`'
+    else:
+        ok = album.cover_photo is not None
+        if ok:
+            detail = (
+                f'The `{album.key}` album has a cover photo configured. This '
+                'photo will be used as the site preview image.'
+            )
+        else:
+            detail = (
+                f'Set cover photo for `{album.key}` album to configure '
+                'the preview image.')
+
+    return Validation(
+        check=_("Site has a default preview image"),
+        status=status(ok),
+        detail=detail,
+    )
+
+
+def site_description_configured(
+        request: HttpRequest,
+        album: Album | Exception) -> Validation:
+    detail = None
+
+    if isinstance(album, Exception):
+        ok = False
+        detail = f'Failed to resolve site or album: `{str(album)}`'
+    else:
+        ok = album.description is not None and len(album.description) > 0
+        if ok:
+            detail = (
+                f'The `{album.key}` album has a description. This description '
+                'will be used as the site description.'
+            )
+        else:
+            detail = (
+                f'Set description for `{album.key}` album to configure '
+                'the site description.')
+
+    return Validation(
+        check=_("Site has a default description"),
+        status=status(ok),
+        detail=detail,
+    )
+
+
+@json_problem_as_html
+def configuration(request: HttpRequest):
+    try:
+        site_id = request.site.id
+        album_key = f"_site_{site_id}"
+        album = Album.objects.get(key=album_key)
+    except Exception as e:
+        album = e
+
+    validations = [
+        uses_https(request),
+        site_is_configured(request),
+        domain_matches_request(request),
+        site_preview_configured(request, album),
+        site_description_configured(request, album),
+    ]
+
+    back = BackLink("Back to albums", reverse('photo_objects:list_albums'))
+
+    return render(request, "photo_objects/configuration.html", {
+        "title": "Configuration",
+        "validations": validations,
+        "back": back,
+    })

{photo_objects-0.0.6 → photo_objects-0.0.7}/photo_objects/django/views/ui/photo.py

@@ -44,9 +44,9 @@ def upload_photos(request: HttpRequest, album_key: str):
 def _camera(photo: Photo):
     if photo.camera_make or photo.camera_model:
         return " ".join(i for i in [
-                photo.camera_make,
-                photo.camera_model,
-            ] if i)
+            photo.camera_make,
+            photo.camera_model,
+        ] if i)
     return None
 
 

{photo_objects-0.0.6 → photo_objects-0.0.7}/photo_objects.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: photo-objects
-Version: 0.0.6
+Version: 0.0.7
 Summary: Application for storing photos in S3 compatible object-storage.
 Author: Toni Kangas
 License: MIT License

{photo_objects-0.0.6 → photo_objects-0.0.7}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "photo-objects"
-version = "0.0.6"
+version = "0.0.7"
 dependencies = [
     "markdown~=3.7",
     "minio~=7.2",

photo_objects-0.0.6/photo_objects/django/views/ui/configuration.py

@@ -1,117 +0,0 @@
-from dataclasses import dataclass
-
-from django.http import HttpRequest
-from django.shortcuts import render
-from django.urls import reverse
-from django.utils.translation import gettext_lazy as _
-
-from photo_objects.django.models import Album
-from photo_objects.django.views.utils import BackLink
-
-from .utils import json_problem_as_html
-
-
-@dataclass
-class Validation:
-    check: str
-    status: str
-    detail: str = None
-
-
-def status(b: bool) -> str:
-    return _("OK") if b else _("Error")
-
-
-def uses_https(request: HttpRequest) -> Validation:
-    return Validation(
-        check=_("Site is served over HTTPS"),
-        status=status(request.is_secure()),
-    )
-
-
-def site_is_configured(request: HttpRequest) -> Validation:
-    detail = None
-    try:
-        ok = request.site.domain != "example.com"
-        if not ok:
-            detail = (
-                f'Site domain is set to "example.com". This is a placeholder '
-                'domain and should be changed to the actual domain of the '
-                'site.')
-    except Exception as e:
-        ok = False
-        detail = (
-            f"Failed to resolve site domain: {str(e)}. Check that sites "
-            "framework is installed, site middleware is configured, and that "
-            "the site exists in the database.")
-
-    return Validation(
-        check=_("Site is configured"),
-        status=status(ok),
-        detail=detail,
-    )
-
-
-def domain_matches_request(request: HttpRequest) -> Validation:
-    detail = None
-    try:
-        host = request.get_host().lower()
-        domain = request.site.domain.lower()
-        ok = request.get_host() == request.site.domain
-        if not ok:
-            detail = (
-                'Host in the request does not match domain configured for '
-                f'the site: expected "{domain}", got "{host}".')
-    except Exception as e:
-        ok = False
-        detail = (
-            f"Failed to resolve host or domain: {str(e)}. Check that "
-            "sites framework is installed, site middleware is configured, "
-            "and that the site exists in the database.")
-
-    return Validation(
-        check=_("Configured domain matches host in request"),
-        status=status(ok),
-        detail=detail,
-    )
-
-
-def site_preview_configured(request: HttpRequest) -> Validation:
-    detail = None
-
-    try:
-        site_id = request.site.id
-        album_key = f"_site_{site_id}"
-        album = Album.objects.get(key=album_key)
-        ok = album.cover_photo is not None
-        if not ok:
-            detail = (
-                f'Set cover photo for "{album_key}" album to configure '
-                'the preview image.')
-    except Exception as e:
-        ok = False
-        detail = f'Failed to resolve site or album: {str(e)}'
-
-    return Validation(
-        check=_("Site has a default preview image"),
-        status=status(ok),
-        detail=detail,
-    )
-
-
-@json_problem_as_html
-def configuration(request: HttpRequest):
-    validations = [
-        uses_https(request),
-        site_is_configured(request),
-        domain_matches_request(request),
-        site_preview_configured(request),
-    ]
-
-    back = BackLink("Back to albums", reverse('photo_objects:list_albums'))
-
-    return render(request, "photo_objects/configuration.html", {
-        "title": "Configuration",
-        "validations": validations,
-        "back": back,
-    })