photo-objects 0.0.6__py3-none-any.whl → 0.0.7__py3-none-any.whl

photo_objects/django/views/ui/configuration.py

@@ -6,7 +6,7 @@ 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 photo_objects.django.views.utils import BackLink, render_markdown
 
 from .utils import json_problem_as_html
 
@@ -17,31 +17,58 @@ class Validation:
     status: str
     detail: str = None
 
+    def __post_init__(self):
+        self.detail = render_markdown(self.detail)
 
-def status(b: bool) -> str:
-    return _("OK") if b else _("Error")
+
+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(request.is_secure()),
+        status=status(ok, warning),
+        detail=detail
     )
 
 
 def site_is_configured(request: HttpRequest) -> Validation:
-    detail = None
+    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 = (
-                f'Site domain is set to "example.com". This is a placeholder '
+                '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 "
+            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.")
 
@@ -61,11 +88,16 @@ def domain_matches_request(request: HttpRequest) -> Validation:
         if not ok:
             detail = (
                 'Host in the request does not match domain configured for '
-                f'the site: expected "{domain}", got "{host}".')
+                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: {str(e)}. Check that "
+            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.")
 
@@ -76,21 +108,25 @@ def domain_matches_request(request: HttpRequest) -> Validation:
     )
 
 
-def site_preview_configured(request: HttpRequest) -> Validation:
+def site_preview_configured(
+        request: HttpRequest,
+        album: Album | Exception) -> Validation:
     detail = None
 
-    try:
-        site_id = request.site.id
-        album_key = f"_site_{site_id}"
-        album = Album.objects.get(key=album_key)
+    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 not ok:
+        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 '
+                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"),
@@ -99,13 +135,48 @@ def site_preview_configured(request: HttpRequest) -> Validation:
     )
 
 
+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),
+        site_preview_configured(request, album),
+        site_description_configured(request, album),
     ]
 
     back = BackLink("Back to albums", reverse('photo_objects:list_albums'))

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.dist-info → photo_objects-0.0.7.dist-info}/METADATA

@@ -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.dist-info → photo_objects-0.0.7.dist-info}/RECORD

@@ -42,11 +42,11 @@ photo_objects/django/views/api/photo.py,sha256=52UMP1r6TN_xfu8fHE25yOUiTa6W1F2Xb
 photo_objects/django/views/api/utils.py,sha256=uQzKdSKHRAux5OZzqgWQr0gsK_FeweQP0cg_67OWA_Y,264
 photo_objects/django/views/ui/__init__.py,sha256=vbFXPj5liue-M_CXQGP5PKhD98Z5ev53yKLPU8zWpUs,71
 photo_objects/django/views/ui/album.py,sha256=bgFPg9ipkQFqZK7cQgYT9gqpUgdSJ_1NTHlszsfclKU,5010
-photo_objects/django/views/ui/configuration.py,sha256=yDKlJUx5LexmpvvTPEZTH3RPtxMgXVInmNCFS-0sZv8,3375
-photo_objects/django/views/ui/photo.py,sha256=F7tqI_mtGFnelROTQbGmkK21OylheavoRzFgjlah1j0,6052
+photo_objects/django/views/ui/configuration.py,sha256=bkckPtQHf7FYwEUIemtMTA1jaDHi7B7VA4ucO_4qt5E,5593
+photo_objects/django/views/ui/photo.py,sha256=4NJSN5X_NcVcUEPaoGEGmXRDAgI5_KsOlHr7j-yo2QY,6040
 photo_objects/django/views/ui/utils.py,sha256=YV_YcUbX-zUkdFnBlezPChR6aPDhZJ9loSOHBSzF6Cc,273
-photo_objects-0.0.6.dist-info/licenses/LICENSE,sha256=V3w6hTjXfP65F4r_mejveHcV5igHrblxao3-2RlfVlA,1068
-photo_objects-0.0.6.dist-info/METADATA,sha256=bT0yaZdgZxa1XF8V1ABndbeJerRaU0g02PDXH6wRPKQ,3671
-photo_objects-0.0.6.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-photo_objects-0.0.6.dist-info/top_level.txt,sha256=SZeL8mhf-WMGdhRtTGFvZc3aIRBboQls9O0cFDMGdQ0,14
-photo_objects-0.0.6.dist-info/RECORD,,
+photo_objects-0.0.7.dist-info/licenses/LICENSE,sha256=V3w6hTjXfP65F4r_mejveHcV5igHrblxao3-2RlfVlA,1068
+photo_objects-0.0.7.dist-info/METADATA,sha256=xYOJTlRMBdsnYh_0AHAzGcHybbiUodE4SY8Xvc0E85g,3671
+photo_objects-0.0.7.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+photo_objects-0.0.7.dist-info/top_level.txt,sha256=SZeL8mhf-WMGdhRtTGFvZc3aIRBboQls9O0cFDMGdQ0,14
+photo_objects-0.0.7.dist-info/RECORD,,