photo-objects 0.5.0__tar.gz → 0.7.0__tar.gz

{photo_objects-0.5.0 → photo_objects-0.7.0}/PKG-INFO

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

{photo_objects-0.5.0 → photo_objects-0.7.0}/photo_objects/django/api/photo.py

@@ -17,6 +17,7 @@ from photo_objects.img import photo_details
 from .auth import check_album_access, check_photo_access
 from .utils import (
     FormValidationFailed,
+    UploadPhotosFailed,
     JsonProblem,
     check_permissions,
     parse_input_data,
@@ -57,7 +58,7 @@ def _upload_photo(album_key: str, photo_file: UploadedFile):
         photo.delete()
 
         msg = objsto.with_error_code(
-            "Could not save photo to object storage", e)
+            "Could not save photo to object storage.", e)
         logger.error(f"{msg}: {str(e)}")
         raise JsonProblem(f"{msg}.", 500) from e
 
@@ -73,6 +74,17 @@ def upload_photo(request: HttpRequest, album_key: str):
     return _upload_photo(album_key, photo_file)
 
 
+def _join_errors(errors: dict) -> str:
+    messages = []
+    for _, errs in errors.items():
+        for err in errs:
+            try:
+                messages.append(err.get('message'))
+            except AttributeError:
+                messages.append(str(err))
+    return " ".join(messages) if messages else "Unknown error."
+
+
 def upload_photos(request: HttpRequest, album_key: str):
     check_permissions(
         request,
@@ -92,12 +104,18 @@ def upload_photos(request: HttpRequest, album_key: str):
     for photo_file in f.cleaned_data["photos"]:
         try:
             photos.append(_upload_photo(album_key, photo_file))
-        except JsonProblem:
-            # TODO: include error type in the message
-            f.add_error("photos", f"Failed to upload {photo_file.name}.")
+        except FormValidationFailed as e:
+            message = _join_errors(e.form.errors.get_json_data())
+            f.add_error(
+                "photos",
+                f"Failed to upload {photo_file.name}. {message}")
+        except JsonProblem as e:
+            f.add_error(
+                "photos",
+                f"Failed to upload {photo_file.name}. {e.title}")
 
     if not f.is_valid():
-        raise FormValidationFailed(f)
+        raise UploadPhotosFailed(f, [i.filename for i in photos])
 
     return photos
 

{photo_objects-0.5.0 → photo_objects-0.7.0}/photo_objects/django/api/utils.py

@@ -129,6 +129,12 @@ class FormValidationFailed(JsonProblem):
         self.form = form
 
 
+class UploadPhotosFailed(FormValidationFailed):
+    def __init__(self, form: ModelForm, uploaded_photos: list[str]):
+        super().__init__(form)
+        self.uploaded_photos = uploaded_photos
+
+
 def check_permissions(request: HttpRequest, *permissions: str):
     if not request.user.is_authenticated:
         raise Unauthorized()

{photo_objects-0.5.0 → photo_objects-0.7.0}/photo_objects/django/conf.py

@@ -30,20 +30,25 @@ class PhotoSizeDimensions:
     max_width: int = None
     max_height: int = None
     max_aspect_ratio: float = None
+    image_format: str = None
 
 
 DEFAULT_SM = dict(
     max_width=512,
     max_height=512,
-    max_aspect_ratio=1.5
+    max_aspect_ratio=1.5,
+    image_format='WEBP'
 )
 DEFAULT_MD = dict(
-    max_width=2048,
-    max_height=2048
+    max_width=1024,
+    max_height=1024,
+    max_aspect_ratio=1.5,
+    image_format="JPEG"
 )
 DEFAULT_LG = dict(
-    max_width=4096,
-    max_height=4096
+    max_width=2048,
+    max_height=2048,
+    image_format='WEBP'
 )
 
 

photo_objects-0.7.0/photo_objects/django/context_processors.py

@@ -0,0 +1,13 @@
+from importlib.metadata import PackageNotFoundError, version
+
+
+class Metadata:
+    def __init__(self):
+        try:
+            self.version = version('photo_objects')
+        except PackageNotFoundError:
+            self.version = None
+
+
+def metadata(_):
+    return {"photo_objects_metadata": Metadata()}

{photo_objects-0.5.0 → photo_objects-0.7.0}/photo_objects/django/forms.py

@@ -195,7 +195,11 @@ class CreatePhotoForm(ModelForm):
         error_messages = {
             'album': {
                 'invalid_choice': _('Album with %(value)s key does not exist.')
-            }
+            },
+            'key': {
+                'unique': _(
+                    'Photo with this filename already exists in the album.'),
+            },
         }
 
 

{photo_objects-0.5.0 → photo_objects-0.7.0}/photo_objects/django/objsto.py

@@ -2,6 +2,7 @@ from dataclasses import asdict
 from io import BytesIO
 import json
 import mimetypes
+import re
 import urllib3
 
 from minio import Minio, S3Error
@@ -60,8 +61,30 @@ def photo_path(album_key, photo_key, size_key):
     return f"{size_key}/{album_key}/{photo_key}"
 
 
-def put_photo(album_key, photo_key, size_key, photo_file):
-    content_type = mimetypes.guess_type(photo_key)[0]
+def _photo_filename(photo_key: str, image_format: str = None) -> str:
+    if image_format:
+        filename = re.sub(r'\.[^.]+$', '', photo_key)
+        return f"{filename}.{image_format.lower()}"
+
+    return photo_key
+
+
+def photo_content_headers(
+    photo_key: str,
+    image_format: str = None,
+) -> tuple[str, dict[str, str]]:
+    filename = _photo_filename(photo_key, image_format)
+
+    content_type = mimetypes.guess_type(filename, strict=False)[0]
+    headers = {
+        "Content-Disposition": f"inline; filename={filename}"
+    }
+
+    return content_type, headers
+
+
+def put_photo(album_key, photo_key, size_key, photo_file, image_format=None):
+    content_type, headers = photo_content_headers(photo_key, image_format)
 
     client, bucket = _objsto_access()
     return client.put_object(
@@ -71,6 +94,7 @@ def put_photo(album_key, photo_key, size_key, photo_file):
         length=-1,
         part_size=10 * MEGABYTE,
         content_type=content_type,
+        metadata=headers
     )
 
 

photo_objects-0.7.0/photo_objects/django/tests/test_og_meta.py

@@ -0,0 +1,60 @@
+from django.contrib.sites.models import Site
+
+from photo_objects.django.models import Album, Photo, SiteSettings
+
+from .utils import TestCase, create_dummy_photo, temp_static_files
+
+
+PHOTOS_DIRECTORY = "photos"
+
+
+class OgMetaTests(TestCase):
+    @classmethod
+    def setUpTestData(cls):
+        album = Album.objects.create(
+            key="paris", visibility=Album.Visibility.PUBLIC)
+
+        create_dummy_photo(album, "tower.jpeg")
+
+    @temp_static_files
+    def test_albums_og_meta(self):
+        og_title = '<meta property="og:title" content="Test" />'
+
+        response = self.client.get("/albums")
+        self.assertNotContains(
+            response,
+            og_title,
+            status_code=200,
+            html=True)
+
+        site = Site.objects.get(id=1)
+        site.name = "Test"
+        site.domain = "test.example.com"
+        site.save()
+
+        response = self.client.get("/albums")
+        self.assertNotContains(
+            response,
+            og_title,
+            status_code=200,
+            html=True)
+
+        site_settings = SiteSettings.objects.get(site=site)
+        site_settings.description = "Description"
+        site_settings.preview_image = Photo.objects.get(key="paris/tower.jpeg")
+        site_settings.save()
+
+        tags = [
+            og_title,
+            '<meta property="og:description" content="Description" />',
+            '<meta property="og:image" content="https://test.example.com/img/paris/tower.jpeg/md"/>',  # noqa: E501
+            '<meta property="og:url" content="https://test.example.com/albums" />',  # noqa: E501
+        ]
+
+        response = self.client.get("/albums")
+        for tag in tags:
+            self.assertContains(
+                response,
+                tag,
+                status_code=200,
+                html=True)

{photo_objects-0.5.0 → photo_objects-0.7.0}/photo_objects/django/tests/test_photo.py

@@ -184,6 +184,15 @@ class PhotoViewTests(TestCase):
                 {filename: file})
         self.assertStatus(response, 500)
 
+        response = self.client.get(
+            "/api/albums/test-photo-a/photos/tower.jpg")
+        self.assertStatus(response, 404)
+
+        response = self.client.get(
+            "/api/albums/test-photo-a/photos")
+        self.assertStatus(response, 200)
+        self.assertEqual(len(response.json()), 0)
+
     def test_get_image_scales_the_image(self):
         login_success = self.client.login(
             username='has_permission', password='test')

{photo_objects-0.5.0 → photo_objects-0.7.0}/photo_objects/django/tests/utils.py

@@ -1,7 +1,11 @@
 from dataclasses import dataclass
+from io import StringIO
 import os
+import shutil
+import tempfile
 
 from django.conf import settings
+from django.core.management import call_command
 from django.test import TestCase as DjangoTestCase, override_settings
 from django.utils import timezone
 from django.utils.dateparse import parse_datetime
@@ -120,3 +124,20 @@ def parse_timestamps(data):
     return Timestamps(
         created_at=data.get('created_at'),
         updated_at=data.get('updated_at'))
+
+
+# Based on https://stackoverflow.com/a/76745063
+def temp_static_files(func):
+    '''Decorator that creates a temporary directory, configures that as
+    STATIC_ROOT, and collects static files there.'''
+    def wrapper(*args, **kwargs):
+        static_root = tempfile.mkdtemp(prefix="test_static_")
+        with override_settings(STATIC_ROOT=static_root):
+            try:
+                out = StringIO()
+                call_command("collectstatic", "--noinput", stdout=out)
+                func(*args, **kwargs)
+            finally:
+                shutil.rmtree(static_root)
+
+    return wrapper

{photo_objects-0.5.0 → photo_objects-0.7.0}/photo_objects/django/views/api/photo.py

@@ -91,14 +91,23 @@ def get_img(request: HttpRequest, album_key: str, photo_key: str):
                 404 if code == "NoSuchKey" else 500,
             ).json_response
 
-        sizes = photo_sizes()
+        size_params = getattr(photo_sizes(), size)
         # TODO: handle error
         scaled_photo = scale_photo(
-            original_photo, photo_key, **asdict(getattr(sizes, size)))
+            original_photo, photo_key, **asdict(size_params))
 
         # TODO: handle error
         scaled_photo.seek(0)
-        objsto.put_photo(album_key, photo_key, size, scaled_photo)
+        objsto.put_photo(
+            album_key,
+            photo_key,
+            size,
+            scaled_photo,
+            size_params.image_format)
+
+        content_type, headers = objsto.photo_content_headers(
+            photo_key, size_params.image_format)
 
         scaled_photo.seek(0)
-        return HttpResponse(scaled_photo.read(), content_type=content_type)
+        return HttpResponse(
+            scaled_photo.read(), content_type=content_type, headers=headers)

{photo_objects-0.5.0 → photo_objects-0.7.0}/photo_objects/django/views/ui/photo.py

@@ -3,7 +3,11 @@ from django.shortcuts import render
 from django.urls import reverse
 
 from photo_objects.django import api
-from photo_objects.django.api.utils import AlbumNotFound, FormValidationFailed
+from photo_objects.django.api.utils import (
+    AlbumNotFound,
+    FormValidationFailed,
+    UploadPhotosFailed,
+)
 from photo_objects.django.forms import ModifyPhotoForm, UploadPhotosForm
 from photo_objects.django.models import Photo
 from photo_objects.django.views.utils import (
@@ -24,10 +28,17 @@ def upload_photos(request: HttpRequest, album_key: str):
                 reverse(
                     'photo_objects:show_album',
                     kwargs={"album_key": album_key}))
-        except FormValidationFailed as e:
+        except UploadPhotosFailed as e:
             form = e.form
+            uploaded_count = len(e.uploaded_photos)
+            if uploaded_count > 0:
+                plural = 's' if uploaded_count != 1 else ''
+                info = f"Successfully uploaded {uploaded_count} photo{plural}."
+            else:
+                info = None
     else:
         form = UploadPhotosForm()
+        info = None
 
     album = api.check_album_access(request, album_key)
     target = album.title or album.key
@@ -38,6 +49,7 @@ def upload_photos(request: HttpRequest, album_key: str):
 
     return render(request, 'photo_objects/photo/upload.html', {
         "form": form,
+        "info": info,
         "title": "Upload photos",
         "back": back,
         "photo": album.cover_photo,

{photo_objects-0.5.0 → photo_objects-0.7.0}/photo_objects/img.py

@@ -66,7 +66,10 @@ def _read_camera_setup_and_settings(image: Image) -> dict:
         raise e
 
 
-def _image_format(filename):
+def _image_format(image_format, filename):
+    if image_format:
+        return image_format
+
     image_format = filename.split('.')[-1].upper()
 
     if image_format == "JPG":
@@ -131,7 +134,8 @@ def scale_photo(
         filename,
         max_width=None,
         max_height=None,
-        max_aspect_ratio=None):
+        max_aspect_ratio=None,
+        image_format=None):
     image = Image.open(photo_file)
     width, height = image.size
 
@@ -164,5 +168,5 @@ def scale_photo(
         resized = image.resize(new_size, Image.Resampling.LANCZOS)
 
     b = BytesIO()
-    resized.save(b, _image_format(filename))
+    resized.save(b, _image_format(image_format, filename))
     return b

{photo_objects-0.5.0 → photo_objects-0.7.0}/photo_objects.egg-info/PKG-INFO

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

{photo_objects-0.5.0 → photo_objects-0.7.0}/photo_objects.egg-info/SOURCES.txt

@@ -43,6 +43,7 @@ photo_objects/django/tests/test_album.py
 photo_objects/django/tests/test_auth.py
 photo_objects/django/tests/test_commands.py
 photo_objects/django/tests/test_img.py
+photo_objects/django/tests/test_og_meta.py
 photo_objects/django/tests/test_photo.py
 photo_objects/django/tests/test_utils.py
 photo_objects/django/tests/utils.py

{photo_objects-0.5.0 → photo_objects-0.7.0}/pyproject.toml

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

photo_objects-0.5.0/photo_objects/django/context_processors.py

@@ -1,9 +0,0 @@
-from importlib.metadata import version
-
-
-class Metadata:
-    version = version('photo_objects')
-
-
-def metadata(_):
-    return {"photo_objects_metadata": Metadata()}