photo-objects 0.9.5__tar.gz → 0.10.0__tar.gz

{photo_objects-0.9.5 → photo_objects-0.10.0}/PKG-INFO

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

{photo_objects-0.9.5 → photo_objects-0.10.0}/photo_objects/django/api/photo.py

@@ -9,7 +9,6 @@ from photo_objects.django import objsto
 from photo_objects.django.forms import (
     CreatePhotoForm,
     ModifyPhotoForm,
-    UploadPhotosForm,
     slugify,
 )
 from photo_objects.img import photo_details
@@ -17,7 +16,6 @@ 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,
@@ -74,52 +72,6 @@ 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,
-        'photo_objects.add_photo',
-        'photo_objects.change_album')
-
-    f = UploadPhotosForm(request.POST, request.FILES)
-    if not f.is_valid():
-        raise FormValidationFailed(f)
-
-    photo_files = f.cleaned_data["photos"]
-    if len(photo_files) < 1:
-        f.add_error("photos", "Expected at least one file, got 0.")
-        raise FormValidationFailed(f)
-
-    photos = []
-    for photo_file in f.cleaned_data["photos"]:
-        try:
-            photos.append(_upload_photo(album_key, photo_file))
-        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 UploadPhotosFailed(f, [i.filename for i in photos])
-
-    return photos
-
-
 def modify_photo(request: HttpRequest, album_key: str, photo_key: str):
     check_permissions(request, 'photo_objects.change_photo')
     photo = check_photo_access(request, album_key, photo_key, 'xs')

{photo_objects-0.9.5 → photo_objects-0.10.0}/photo_objects/django/api/utils.py

@@ -53,7 +53,8 @@ class JsonProblem(PhotoObjectsError):
                 'Albums',
                 reverse_lazy('photo_objects:list_albums')),
             "problem_title": self.title,
-            "status": self.status
+            "status": self.status,
+            "width": "narrow",
         }, status=self.status)
 
 
@@ -137,12 +138,6 @@ 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.9.5 → photo_objects-0.10.0}/photo_objects/django/forms.py

@@ -3,9 +3,6 @@ import random
 from django import forms
 from django.forms import (
     CharField,
-    ClearableFileInput,
-    FileField,
-    Form,
     HiddenInput,
     ModelForm,
     RadioSelect,
@@ -220,26 +217,3 @@ class ReviewPhotoChangeRequestForm(ModelForm):
         help_texts = {
             'alt_text': ALT_TEXT_HELP,
         }
-
-
-class MultipleFileInput(ClearableFileInput):
-    allow_multiple_selected = True
-
-
-class MultipleFileField(FileField):
-    def __init__(self, *args, **kwargs):
-        kwargs.setdefault('widget', MultipleFileInput())
-        super().__init__(*args, **kwargs)
-
-    def clean(self, data, initial=None):
-        single_file_clean = super().clean
-        if isinstance(data, (list, tuple)):
-            result = [single_file_clean(d, initial) for d in data]
-        else:
-            result = [single_file_clean(data, initial)]
-        return result
-
-
-class UploadPhotosForm(Form):
-    photos = MultipleFileField(label=_(
-        'Drag and drop photos here or click to open upload dialog.'))

{photo_objects-0.9.5 → photo_objects-0.10.0}/photo_objects/django/tests/test_utils.py

@@ -56,8 +56,9 @@ class TestUtils(TestCase):
              "Plain text description"),
             (md_multi_p,
              "Description with bold and italics..."),
-            (None,
-             "A simple self-hosted photo server."),
+            # TODO: Test default description and description from site-settings
+            # (None,
+            #  "A simple self-hosted photo server."),
         ]
 
         for description, expected in testdata:

{photo_objects-0.9.5 → photo_objects-0.10.0}/photo_objects/django/urls.py

@@ -9,7 +9,11 @@ urlpatterns = [
     path("_auth", api.has_permission),
     path("api/albums", api.albums),
     path("api/albums/<str:album_key>", api.album),
-    path("api/albums/<str:album_key>/photos", api.photos),
+    path(
+        "api/albums/<str:album_key>/photos",
+        api.photos,
+        name="api_photos",
+    ),
     path("api/albums/<str:album_key>/photos/<str:photo_key>", api.photo),
     path(
         "api/albums/<str:album_key>/photos/<str:photo_key>/change-requests",

{photo_objects-0.9.5 → photo_objects-0.10.0}/photo_objects/django/views/ui/album.py

@@ -9,11 +9,12 @@ from photo_objects.django.forms import CreateAlbumForm, ModifyAlbumForm
 from photo_objects.django.models import Album
 from photo_objects.django.views.utils import (
     BackLink,
+    Preview,
     meta_description,
 )
 from photo_objects.utils import render_markdown
 
-from .utils import json_problem_as_html
+from .utils import json_problem_as_html, preview_helptext
 
 
 @json_problem_as_html
@@ -46,6 +47,7 @@ def new_album(request: HttpRequest):
         "form": form,
         "title": "Create album",
         "back": back,
+        "width": "narrow",
     })
 
 
@@ -106,14 +108,24 @@ def edit_album(request: HttpRequest, album_key: str):
         reverse(
             'photo_objects:show_album',
             kwargs={"album_key": album_key}))
-
-    return render(request, 'photo_objects/form.html', {
-        "form": form,
-        "title": "Edit album",
-        "back": back,
-        "photo": album.cover_photo,
-        "info": get_info(request, album_key),
-    })
+    empty = album.cover_photo is None
+
+    return render(
+        request,
+        'photo_objects/form.html',
+        {
+            "form": form,
+            "title": "Edit album",
+            "back": back,
+            "info": get_info(
+                request,
+                album_key),
+            "width": "narrow",
+            "preview": Preview(
+                request,
+                album,
+                preview_helptext("album", empty)),
+        })
 
 
 @json_problem_as_html
@@ -140,10 +152,14 @@ def delete_album(request: HttpRequest, album_key: str):
             error = {'error': _(
                 'This album is managed by the system and can not be deleted.')}
 
+    empty = album.cover_photo is None
+
     return render(request, 'photo_objects/delete.html', {
         "title": "Delete album",
         "back": back,
         "photo": album.cover_photo,
         "resource": target,
+        "width": "narrow",
+        "preview": Preview(request, album, preview_helptext("album", empty)),
         **error,
     })

{photo_objects-0.9.5 → photo_objects-0.10.0}/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.api.utils import JsonProblem
-from photo_objects.django.views.utils import BackLink
+from photo_objects.django.views.utils import BackLink, Preview
 from photo_objects.utils import render_markdown
 
 from .utils import json_problem_as_html
@@ -169,8 +169,18 @@ def configuration(request: HttpRequest):
 
     back = BackLink("Albums", reverse('photo_objects:list_albums'))
 
-    return render(request, "photo_objects/configuration.html", {
-        "title": "Configuration",
-        "validations": validations,
-        "back": back,
-    })
+    return render(
+        request,
+        "photo_objects/configuration.html",
+        {
+            "title": "Configuration",
+            "validations": validations,
+            "back": back,
+            "width": "narrow",
+            "preview": Preview(
+                request,
+                None,
+                "This is an example on how the site will appear by default "
+                "when sharing in social media. Note that individual albums "
+                "and photos override this default preview."),
+        })

{photo_objects-0.9.5 → photo_objects-0.10.0}/photo_objects/django/views/ui/photo.py

@@ -6,53 +6,36 @@ from photo_objects.django import api
 from photo_objects.django.api.utils import (
     AlbumNotFound,
     FormValidationFailed,
-    UploadPhotosFailed,
 )
-from photo_objects.django.forms import ModifyPhotoForm, UploadPhotosForm
+from photo_objects.django.forms import ModifyPhotoForm
 from photo_objects.django.models import Photo
 from photo_objects.django.views.utils import (
     BackLink,
+    Preview,
     meta_description,
 )
 from photo_objects.utils import render_markdown
 
-from .utils import json_problem_as_html
+from .utils import json_problem_as_html, preview_helptext
 
 
 @json_problem_as_html
 def upload_photos(request: HttpRequest, album_key: str):
-    if request.method == "POST":
-        try:
-            api.upload_photos(request, album_key)
-            return HttpResponseRedirect(
-                reverse(
-                    'photo_objects:show_album',
-                    kwargs={"album_key": album_key}))
-        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
     back = BackLink(
         target, reverse(
             'photo_objects:show_album', kwargs={
                 "album_key": album_key}))
+    empty = album.cover_photo is None
 
     return render(request, 'photo_objects/photo/upload.html', {
-        "form": form,
-        "info": info,
         "title": "Upload photos",
         "back": back,
+        "album": album,
         "photo": album.cover_photo,
+        "width": "narrow",
+        "preview": Preview(request, album, preview_helptext("album", empty)),
     })
 
 
@@ -177,12 +160,16 @@ def edit_photo(request: HttpRequest, album_key: str, photo_key: str):
                 "album_key": album_key,
                 "photo_key": photo_key}))
 
-    return render(request, 'photo_objects/form.html', {
-        "form": form,
-        "title": "Edit photo",
-        "back": back,
-        "photo": photo,
-    })
+    return render(
+        request,
+        'photo_objects/form.html',
+        {
+            "form": form,
+            "title": "Edit photo",
+            "back": back,
+            "width": "narrow",
+            "preview": Preview(request, photo, preview_helptext("photo")),
+        })
 
 
 @json_problem_as_html
@@ -208,4 +195,6 @@ def delete_photo(request: HttpRequest, album_key: str, photo_key: str):
         "back": back,
         "photo": photo,
         "resource": target,
+        "width": "narrow",
+        "preview": Preview(request, photo, preview_helptext("photo")),
     })

{photo_objects-0.9.5 → photo_objects-0.10.0}/photo_objects/django/views/ui/photo_change_request.py

@@ -7,7 +7,7 @@ from photo_objects.django.api.utils import (
     FormValidationFailed,
 )
 from photo_objects.django.forms import ReviewPhotoChangeRequestForm
-from photo_objects.django.views.utils import BackLink
+from photo_objects.django.views.utils import BackLink, Preview
 from photo_objects.utils import render_markdown
 
 from .utils import json_problem_as_html
@@ -49,13 +49,14 @@ def review_photo_change_request(request: HttpRequest, cr_id: str):
 
     back = BackLink("Albums", reverse('photo_objects:list_albums'))
 
+    helptext = render_markdown(
+        f'The current alt text for `{photo.key}` is: _"{photo.alt_text}"_.')
+
     return render(request, 'photo_objects/form.html', {
         "form": form,
         "title": "Review photo change request",
         "back": back,
-        "photo": photo,
         "info": info,
-        "instructions": render_markdown(
-            f'The current alt text for `{photo.key}` is: '
-            f'_"{photo.alt_text}"_.'),
+        "width": "narrow",
+        "preview": Preview(request, photo, helptext),
     })

{photo_objects-0.9.5 → photo_objects-0.10.0}/photo_objects/django/views/ui/users.py

@@ -2,22 +2,20 @@ from django.contrib.auth import views as auth_views
 from django.http import HttpRequest
 from django.urls import reverse_lazy
 
-from photo_objects.django.models import SiteSettings
-from photo_objects.django.views.utils import BackLink
+from photo_objects.django.views.utils import BackLink, Preview
 
 
 def login(request: HttpRequest):
-    settings = SiteSettings.objects.get(request.site)
-
     return auth_views.LoginView.as_view(
         template_name="photo_objects/form.html",
         extra_context={
             "title": "Login",
-            "photo": settings.preview_image,
             "action": "Login",
             "back": BackLink(
                 'Albums',
                 reverse_lazy('photo_objects:list_albums')),
-            "class": "login"
+            "class": "login",
+            "width": "narrow",
+            "preview": Preview(request, None),
         },
     )(request)

photo_objects-0.10.0/photo_objects/django/views/ui/utils.py

@@ -0,0 +1,25 @@
+from photo_objects.django.api.utils import JsonProblem
+
+
+def json_problem_as_html(func):
+    def wrapper(*args, **kwargs):
+        try:
+            return func(*args, **kwargs)
+        except JsonProblem as e:
+            return e.html_response(args[0])
+    return wrapper
+
+
+def preview_helptext(resource_type: str, empty: bool = False) -> str:
+    if resource_type == "album" and empty:
+        return (
+            f"This is an example on how the {resource_type} would appear "
+            "when sharing on social media. Upload photos and select a cover "
+            "photo to use this album specific preview instead of the server "
+            "level default preview."
+        )
+
+    return (
+        f"This is an example on how the {resource_type} will currently appear "
+        "when sharing on social media."
+    )

photo_objects-0.10.0/photo_objects/django/views/utils.py

@@ -0,0 +1,86 @@
+from django.http import HttpRequest
+from django.utils.dateformat import format as format_date
+
+from photo_objects.django.models import Album, Photo, SiteSettings
+from photo_objects.utils import first_paragraph_textcontent
+
+
+class BackLink:
+    def __init__(self, text: str, url: str):
+        self.text = text
+        self.url = url
+
+
+# TODO: Use this also for meta-og tags
+class Preview:
+    def __init__(
+            self,
+            request: HttpRequest,
+            resource: Album | Photo = None,
+            helptext: str = None):
+        self.description = meta_description(request, resource)
+        self.photo = meta_photo(request, resource)
+        self.title = meta_title(request, resource)
+        self.helptext = helptext
+
+
+def _default_album_description(request: HttpRequest, album: Album) -> str:
+    count = album.photo_set.count()
+    plural = 's' if count != 1 else ''
+    return f"Album with {count} photo{plural} in {request.site.name}."
+
+
+def _default_photo_description(photo: Photo) -> str:
+    date_str = format_date(photo.timestamp, "F Y")
+    return f"Photo from {date_str} in {photo.album.title} album."
+
+
+def meta_description(
+        request: HttpRequest,
+        resource: Album | Photo | str = None) -> str:
+    text = None
+    if isinstance(resource, Album):
+        return (
+            first_paragraph_textcontent(resource.description) or
+            _default_album_description(request, resource))
+
+    if isinstance(resource, Photo):
+        return (
+            first_paragraph_textcontent(resource.description) or
+            _default_photo_description(resource))
+
+    if isinstance(resource, str):
+        return first_paragraph_textcontent(resource)
+
+    settings = SiteSettings.objects.get(request.site)
+    text = first_paragraph_textcontent(settings.description)
+    return text or "A simple self-hosted photo server."
+
+
+def meta_photo(
+        request: HttpRequest,
+        resource: Album | Photo = None) -> Photo:
+    if isinstance(resource, Photo):
+        return resource
+
+    if isinstance(resource, Album):
+        return resource.cover_photo
+
+    settings = SiteSettings.objects.get(request.site)
+    return settings.preview_image
+
+
+def meta_title(
+        request: HttpRequest,
+        resource: Album | Photo | str = None) -> str:
+    text = None
+    if isinstance(resource, Album):
+        text = resource.title
+
+    if isinstance(resource, Photo):
+        text = resource.title or resource.filename
+
+    if isinstance(resource, str):
+        text = resource
+
+    return text or request.site.name

{photo_objects-0.9.5 → photo_objects-0.10.0}/photo_objects.egg-info/PKG-INFO

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

{photo_objects-0.9.5 → photo_objects-0.10.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "photo-objects"
-version = "0.9.5"
+version = "0.10.0"
 dependencies = [
     "markdown~=3.7",
     "minio>=7.2.0,<7.2.19",

photo_objects-0.9.5/photo_objects/django/views/ui/utils.py

@@ -1,10 +0,0 @@
-from photo_objects.django.api.utils import JsonProblem
-
-
-def json_problem_as_html(func):
-    def wrapper(*args, **kwargs):
-        try:
-            return func(*args, **kwargs)
-        except JsonProblem as e:
-            return e.html_response(args[0])
-    return wrapper

photo_objects-0.9.5/photo_objects/django/views/utils.py

@@ -1,42 +0,0 @@
-from django.http import HttpRequest
-from django.utils.dateformat import format as format_date
-
-from photo_objects.django.models import Album, Photo
-from photo_objects.utils import first_paragraph_textcontent
-
-
-class BackLink:
-    def __init__(self, text: str, url: str):
-        self.text = text
-        self.url = url
-
-
-def _default_album_description(request: HttpRequest, album: Album) -> str:
-    count = album.photo_set.count()
-    plural = 's' if count != 1 else ''
-    return f"Album with {count} photo{plural} in {request.site.name}."
-
-
-def _default_photo_description(photo: Photo) -> str:
-    date_str = format_date(photo.timestamp, "F Y")
-    return f"Photo from {date_str} in {photo.album.title} album."
-
-
-def meta_description(
-        request: HttpRequest,
-        resource: Album | Photo | str | None) -> str:
-    text = None
-    if isinstance(resource, Album):
-        text = (
-            first_paragraph_textcontent(resource.description) or
-            _default_album_description(request, resource))
-
-    if isinstance(resource, Photo):
-        text = (
-            first_paragraph_textcontent(resource.description) or
-            _default_photo_description(resource))
-
-    if isinstance(resource, str):
-        text = first_paragraph_textcontent(resource)
-
-    return text or "A simple self-hosted photo server."