django-pfx 1.4.dev100__tar.gz → 1.4.dev104__tar.gz

{django_pfx-1.4.dev100 → django_pfx-1.4.dev104}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: django-pfx
-Version: 1.4.dev100
+Version: 1.4.dev104
 Summary: Django PFX is a toolkit designed to streamline the development of RESTful APIs using the Django framework.
 Author: Hervé Martinet
 Author-email: herve.martinet@gmail.com

{django_pfx-1.4.dev100 → django_pfx-1.4.dev104}/django_pfx.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: django-pfx
-Version: 1.4.dev100
+Version: 1.4.dev104
 Summary: Django PFX is a toolkit designed to streamline the development of RESTful APIs using the Django framework.
 Author: Hervé Martinet
 Author-email: herve.martinet@gmail.com

{django_pfx-1.4.dev100 → django_pfx-1.4.dev104}/django_pfx.egg-info/SOURCES.txt

@@ -79,6 +79,8 @@ pfx/pfxcore/models/user_filtered_queryset_mixin.py
 pfx/pfxcore/serializers/__init__.py
 pfx/pfxcore/serializers/json.py
 pfx/pfxcore/storage/__init__.py
+pfx/pfxcore/storage/exceptions.py
+pfx/pfxcore/storage/local_storage.py
 pfx/pfxcore/storage/s3_storage.py
 pfx/pfxcore/templates/registration/otp_code_email.txt
 pfx/pfxcore/templates/registration/otp_code_subject.txt
@@ -91,6 +93,7 @@ pfx/pfxcore/views/authentication_views.py
 pfx/pfxcore/views/fields.py
 pfx/pfxcore/views/filters_views.py
 pfx/pfxcore/views/locale_views.py
+pfx/pfxcore/views/media_rest_view_mixin.py
 pfx/pfxcore/views/ordered_rest_view_mixin.py
 pfx/pfxcore/views/rest_views.py
 pfx/pfxcore/views/parameters/__init__.py

{django_pfx-1.4.dev100 → django_pfx-1.4.dev104}/pfx/pfxcore/default_settings.py

@@ -21,6 +21,8 @@ PFX_OPENAPI_TEMPLATE = {}
 PFX_PROFILING_SQL = ""
 PFX_PROFILING_CPROFILE = ""
 
+STORAGE_DEFAULT = None
+
 STORAGE_S3_AWS_REGION = None
 STORAGE_S3_AWS_ACCESS_KEY = None
 STORAGE_S3_AWS_SECRET_KEY = None
@@ -29,6 +31,9 @@ STORAGE_S3_AWS_S3_BUCKET = None
 STORAGE_S3_AWS_PUT_URL_EXPIRE = None
 STORAGE_S3_AWS_GET_URL_EXPIRE = None
 
+STORAGE_LOCAL_ROOT = None
+STORAGE_LOCAL_X_ACCEL_REDIRECT = False
+
 PFX_TEST_MODE = False
 
 PFX_AUTH_GROUPS_CREATE_ONLY = False

{django_pfx-1.4.dev100 → django_pfx-1.4.dev104}/pfx/pfxcore/fields.py

@@ -1,6 +1,7 @@
 import logging
 import re
 from datetime import timedelta
+from importlib import import_module
 
 from django.core.exceptions import ValidationError
 from django.db import models
@@ -8,17 +9,26 @@ from django.db.models.signals import post_delete
 from django.dispatch import receiver
 from django.utils.translation import gettext_lazy as _
 
-from pfx.pfxcore.storage import DefaultStorage
+from pfx.pfxcore.shortcuts import settings
 
 logger = logging.getLogger(__name__)
 
 
+def get_storage_class(class_path):
+    ps = class_path.split('.')
+    return getattr(import_module('.'.join(ps[:-1])), ps[-1])()
+
+
 class MediaField(models.JSONField):
     def __init__(
             self, *args, max_length=255, get_key=None, storage=None,
             auto_delete=False, **kwargs):
         self.get_key = get_key or self.get_default_key
-        self.storage = storage or DefaultStorage()
+        if not storage and not settings.STORAGE_DEFAULT:
+            raise Exception(
+                "Missing storage. You have to set a storage "
+                "class on the field or define STORAGE_DEFAULT settings.")
+        self.storage = storage or get_storage_class(settings.STORAGE_DEFAULT)
         self.auto_delete = auto_delete
         super().__init__(
             *args, max_length=max_length,
@@ -44,8 +54,7 @@ class MediaField(models.JSONField):
 
     def upload(self, obj, file, filename, **kwargs):
         key = self.get_key(obj, filename)
-        self.storage.upload(key, file, **kwargs)
-        return self.to_python(dict(key=key))
+        return self.to_python(self.storage.upload(key, file, **kwargs))
 
 
 @receiver(post_delete)

{django_pfx-1.4.dev100 → django_pfx-1.4.dev104}/pfx/pfxcore/locale/fr/LC_MESSAGES/django.po

@@ -7,7 +7,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: \n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2025-02-17 15:16+0100\n"
+"POT-Creation-Date: 2025-03-05 17:31+0100\n"
 "PO-Revision-Date: 2021-06-22 23:31+0200\n"
 "Last-Translator: \n"
 "Language-Team: \n"
@@ -47,11 +47,11 @@ msgstr "Interdit"
 msgid "Resource not found"
 msgstr "Ressource non trouvée"
 
-#: fields.py:77
+#: fields.py:86
 msgid "Invalid value."
 msgstr "Valeur invalide."
 
-#: fields.py:92
+#: fields.py:101
 msgid ""
 "Invalid format, it can be a number in hours, “1:05”, “:05”, “1h 5m”, “1.5h” "
 "or “30m”."
@@ -267,6 +267,10 @@ msgstr "Un nouveau code d'authentification a été envoyé par e-mail."
 msgid "Invalid value for {filter} filter"
 msgstr "Valeur invalide pour le filtre {filter}"
 
+#: views/media_rest_view_mixin.py:95 views/media_rest_view_mixin.py:143
+msgid "Unexpected storage error"
+msgstr "Erreur de stockage inattendue"
+
 #: views/ordered_rest_view_mixin.py:32
 #, python-brace-format
 msgid "object parameter is mandatory for move={move}."
@@ -277,27 +281,23 @@ msgstr "Le paramètre object est requis pour move={move}."
 msgid "object {pk} does not exists in this move context."
 msgstr "object {pk} n'existe pas dans ce contexte de déplacement."
 
-#: views/rest_views.py:246
+#: views/rest_views.py:239
 #, python-brace-format
 msgid "{obj} cannot be deleted because it is referenced by other objects."
 msgstr ""
 "{obj} ne peut pas être supprimé car il est référencé par d’autres objets."
 
-#: views/rest_views.py:331
+#: views/rest_views.py:324
 #, python-brace-format
 msgid "{model} {obj} created."
 msgstr "{model} {obj} créé."
 
-#: views/rest_views.py:332
+#: views/rest_views.py:325
 #, python-brace-format
 msgid "{model} {obj} updated."
 msgstr "{model} {obj} modifié."
 
-#: views/rest_views.py:1177
+#: views/rest_views.py:1170
 #, python-brace-format
 msgid "{model} {obj} deleted."
 msgstr "{model} {obj} supprimé."
-
-#: views/rest_views.py:1276 views/rest_views.py:1316
-msgid "Unexpected storage error"
-msgstr "Erreur de stockage inattendue"

django_pfx-1.4.dev104/pfx/pfxcore/storage/__init__.py

@@ -0,0 +1,3 @@
+from .exceptions import StorageException
+from .local_storage import LocalStorage
+from .s3_storage import S3Storage

django_pfx-1.4.dev104/pfx/pfxcore/storage/exceptions.py

@@ -0,0 +1,3 @@
+
+class StorageException(Exception):
+    pass

django_pfx-1.4.dev104/pfx/pfxcore/storage/local_storage.py

@@ -0,0 +1,56 @@
+import hashlib
+import logging
+from pathlib import Path
+
+from django.http import FileResponse
+
+from pfx.pfxcore.shortcuts import settings
+
+logger = logging.getLogger(__name__)
+
+
+class LocalStorage:
+    direct = True
+
+    def to_python(self, value):
+        return value
+
+    def get_url(self, request, key):
+        return Path(settings.STORAGE_LOCAL_ROOT, key)
+
+    def upload(self, key, file, **kwargs):
+        key_list = key.split('/')
+        filename = key_list[-1]
+        relative_path = Path(*key_list[:-1])
+        dirname = Path(settings.STORAGE_LOCAL_ROOT, relative_path)
+        dirname.mkdir(parents=True, exist_ok=True)
+        ext = ''.join(filename.partition('.')[-2:])
+        hashname = f'{hashlib.sha1(file).hexdigest()}{ext}'
+        final_key = str(Path(relative_path, hashname))
+        with open(Path(dirname, hashname), 'wb') as f:
+            f.write(file)
+        with open(Path(dirname, hashname), 'rb') as f:
+            response = FileResponse(
+                f, as_attachment=True, filename=filename)
+            return {
+                'key': final_key,
+                'name': filename,
+                'content-length': response.get('Content-Length'),
+                'content-type': response.get('Content-Type'),
+            }
+
+    def delete(self, value):
+        if 'key' not in value:
+            return value  # pragma: no cover
+        path = Path(settings.STORAGE_LOCAL_ROOT, value['key'])
+        path.unlink(missing_ok=True)
+        while True:
+            path = path.parent
+            if path == Path(settings.STORAGE_LOCAL_ROOT):
+                break
+            if any(path.iterdir()):
+                break
+            try:
+                path.rmdir()
+            except FileNotFoundError:
+                pass

{django_pfx-1.4.dev100 → django_pfx-1.4.dev104}/pfx/pfxcore/storage/s3_storage.py

@@ -6,14 +6,14 @@ from botocore.exceptions import ClientError
 
 from pfx.pfxcore.shortcuts import settings
 
-logger = logging.getLogger(__name__)
-
+from .exceptions import StorageException
 
-class StorageException(Exception):
-    pass
+logger = logging.getLogger(__name__)
 
 
 class S3Storage:
+    direct = False
+
     @staticmethod
     def s3_client():
         return boto3.client(
@@ -60,15 +60,16 @@ class S3Storage:
     def upload(self, key, file, **kwargs):
         try:
             if isinstance(file, IOBase):
-                return self.s3_client().upload_fileobj(
+                self.s3_client().upload_fileobj(
                     file, settings.STORAGE_S3_AWS_S3_BUCKET, key,
                     ExtraArgs=kwargs)
             else:
-                return self.s3_client().upload_file(
+                self.s3_client().upload_file(
                     file, settings.STORAGE_S3_AWS_S3_BUCKET, key,
                     ExtraArgs=kwargs)
         except ClientError:
             raise StorageException
+        return dict(key=key)
 
     def delete(self, value):
         if 'key' not in value:

{django_pfx-1.4.dev100 → django_pfx-1.4.dev104}/pfx/pfxcore/views/__init__.py

@@ -8,6 +8,7 @@ from .authentication_views import (
 from .fields import VF, FieldType, ViewField, ViewModelField
 from .filters_views import Filter, FilterGroup, ModelFilter
 from .locale_views import LocaleRestView
+from .media_rest_view_mixin import MediaPermsRestViewMixin, MediaRestViewMixin
 from .ordered_rest_view_mixin import OrderedRestViewMixin
 from .rest_views import (
     BaseRestView,
@@ -20,8 +21,6 @@ from .rest_views import (
     DetailRestViewMixin,
     ListPermsRestViewMixin,
     ListRestViewMixin,
-    MediaPermsRestViewMixin,
-    MediaRestViewMixin,
     ModelBodyMixin,
     ModelMixin,
     ModelResponseMixin,
@@ -30,6 +29,7 @@ from .rest_views import (
     SecuredRestViewMixin,
     SlugDetailRestViewMixin,
     SlugPermsDetailRestViewMixin,
+    UpdatePermsRestViewMixin,
     UpdateRestViewMixin,
     resource_not_found,
 )

django_pfx-1.4.dev104/pfx/pfxcore/views/media_rest_view_mixin.py

@@ -0,0 +1,171 @@
+import logging
+
+from django.core.exceptions import FieldDoesNotExist
+from django.http import FileResponse, HttpResponse
+from django.shortcuts import redirect
+from django.utils.translation import gettext_lazy as _
+
+from pfx.pfxcore.decorator import rest_api
+from pfx.pfxcore.exceptions import APIError, NotFoundError
+from pfx.pfxcore.fields import MediaField
+from pfx.pfxcore.http import JsonResponse
+from pfx.pfxcore.shortcuts import get_bool, settings
+from pfx.pfxcore.storage.s3_storage import StorageException
+
+from . import parameters
+from .rest_views import ModelMixin
+
+logger = logging.getLogger(__name__)
+
+
+class MediaRestViewMixin(ModelMixin):
+    """Extension mixin to manage media fields."""
+
+    def _get_model_field(self, field):
+        try:
+            model_field = self.model._meta.get_field(field)
+            if not isinstance(model_field, MediaField):
+                raise NotFoundError  # pragma: no cover
+        except FieldDoesNotExist:  # pragma: no cover
+            raise NotFoundError
+        return model_field
+
+    @rest_api(
+        "/<int:pk>/<str:field>/upload-url/<str:filename>", method="get",
+        priority_doc=-8)
+    def field_media_upload_url(self, pk, field, filename, *args, **kwargs):
+        """Entrypoint for
+        :code:`GET /<int:pk>/<str:field>/upload-url/<str:filename>` route.
+
+        Get the upload URL for a media file.
+
+        :param pk: The object pk
+        :param field: The field name
+        :param filename: The file name
+        :returns: The JSON response
+        :rtype: :class:`JsonResponse`
+        ---
+        get:
+            summary: Get upload URL
+            description: |
+                Get upload URL for a `MediaField` field.
+
+                You can upload a file ont the received URL. When the upload
+                query is done, you have to confirm the process with an
+                update request (`PUT`) on {model}. The body of this request
+                must contain the name of the `MediaField` with the contents
+                of the `file` value in the response of this request.
+
+                1. `GET /<int:pk>/<str:field>/upload-url/<str:filename>`
+                    → `data`
+                2. `PUT data.url aFile Content-Type: aFile.type`
+                3. `PUT /<int:pk> {{field: data.file}}`
+            parameters extras:
+                pk: The {model} pk.
+                field: The {model} field name. Must be the name of
+                    a `MediaField` field.
+                filename: The desired filename.
+            responses:
+                200:
+                    description: The upload URL
+                    content:
+                        application/json:
+                            schema:
+                                properties:
+                                    url:
+                                        type: string
+                                        format: uri
+                                    file:
+                                        type: object
+                                        properties:
+                                            name:
+                                                type: string
+                                            key:
+                                                type: string
+        """
+        obj = self.get_object(pk=pk)
+        mediaField = self._get_model_field(field)
+        if mediaField.storage.direct:
+            raise APIError("Unavailable for direct storage")
+        try:
+            res = self._get_model_field(field).get_upload_url(
+                self.request, obj, filename)
+        except StorageException as e:  # pragma: no cover
+            logger.exception(e)
+            raise APIError(_("Unexpected storage error", status=500))
+        return JsonResponse(res)
+
+    @rest_api(
+        "/<int:pk>/<str:field>", method="get",
+        parameters=[parameters.MediaRedirect], priority_doc=-9)
+    def field_media_get(self, pk, field, *args, **kwargs):
+        """Entrypoint for :code:`GET /<int:pk>/<str:field>` route.
+
+        Get the download URL for a media file.
+
+        :param pk: The object pk
+        :param field: The field name
+        :returns: The JSON response
+        :rtype: :class:`JsonResponse`
+        ---
+        get:
+            summary: Get {model} file
+            description: Get the URL for a media field file.
+            parameters extras:
+                pk: the {model} pk
+                field: the {model} field name
+            responses:
+                200:
+                    description: |
+                        The file stream if storage is direct,
+                        otherwise the file URL, only if `redirect` is `false`.
+                    content:
+                        application/json:
+                            schema:
+                                properties:
+                                    url:
+                                        type: string
+                                        format: uri
+                        application/octet-stream:
+                            schema:
+                                type: file
+                302:
+                    description: |
+                        The redirect, for undirect storage
+                        if `redirect` is `true`.
+        """
+        obj = self.get_object(pk=pk)
+        mediaField = self._get_model_field(field)
+        try:
+            url = mediaField.get_url(self.request, obj)
+        except StorageException as e:  # pragma: no cover
+            logger.exception(e)
+            raise APIError(_("Unexpected storage error", status=500))
+
+        if mediaField.storage.direct:
+            filename = getattr(obj, field).get('name')
+            if settings.STORAGE_LOCAL_X_ACCEL_REDIRECT:
+                response = HttpResponse()
+                response["Content-Disposition"] = (
+                    f"attachment; filename={filename}")
+                response['X-Accel-Redirect'] = (
+                    f"/filestore/{getattr(obj, field).get('key')}")
+                return response
+            response = FileResponse(
+                open(mediaField.get_url(self.request, obj), 'rb'),
+                as_attachment=True, filename=getattr(obj, field).get('name'))
+            return response
+
+        if get_bool(self.request.GET, 'redirect'):
+            return redirect(url)
+        return JsonResponse(dict(url=url))
+
+
+class MediaPermsRestViewMixin(MediaRestViewMixin):
+    """Extension mixin to check permissions."""
+
+    def field_media_upload_url_perm(self, *args, **kwargs):
+        return self.request.user.has_perm(*self.get_model_perms('change'))
+
+    def field_media_get_perm(self, *args, **kwargs):
+        return self.request.user.has_perm(*self.get_model_perms('view'))

{django_pfx-1.4.dev100 → django_pfx-1.4.dev104}/pfx/pfxcore/views/rest_views.py

@@ -5,15 +5,10 @@ from json import JSONDecodeError
 
 from django.conf import settings
 from django.core.cache import cache
-from django.core.exceptions import (
-    FieldDoesNotExist,
-    FieldError,
-    ValidationError,
-)
+from django.core.exceptions import FieldError, ValidationError
 from django.db import IntegrityError, transaction
 from django.db.models import ForeignKey, Model, Q
 from django.db.models.fields import AutoFieldMixin
-from django.shortcuts import redirect
 from django.urls import path
 from django.utils.translation import gettext_lazy as _
 from django.views import View
@@ -31,7 +26,6 @@ from pfx.pfxcore.exceptions import (
     NotFoundError,
     UnauthorizedError,
 )
-from pfx.pfxcore.fields import MediaField
 from pfx.pfxcore.http import JsonResponse
 from pfx.pfxcore.models import JSONReprMixin, UserFilteredQuerySetMixin
 from pfx.pfxcore.shortcuts import (
@@ -42,7 +36,6 @@ from pfx.pfxcore.shortcuts import (
     get_object,
     model_permissions,
 )
-from pfx.pfxcore.storage.s3_storage import StorageException
 
 from . import parameters
 from .fields import VF
@@ -1202,133 +1195,6 @@ class DeletePermsRestViewMixin(DeleteRestViewMixin):
         return self.request.user.has_perm(*self.get_model_perms('delete'))
 
 
-class MediaRestViewMixin(ModelMixin):
-    """Extension mixin to manage media fields."""
-
-    def _get_model_field(self, field):
-        try:
-            model_field = self.model._meta.get_field(field)
-            if not isinstance(model_field, MediaField):
-                raise NotFoundError  # pragma: no cover
-        except FieldDoesNotExist:  # pragma: no cover
-            raise NotFoundError
-        return model_field
-
-    @rest_api(
-        "/<int:pk>/<str:field>/upload-url/<str:filename>", method="get",
-        priority_doc=-8)
-    def field_media_upload_url(self, pk, field, filename, *args, **kwargs):
-        """Entrypoint for
-        :code:`GET /<int:pk>/<str:field>/upload-url/<str:filename>` route.
-
-        Get the upload URL for a media file.
-
-        :param pk: The object pk
-        :param field: The field name
-        :param filename: The file name
-        :returns: The JSON response
-        :rtype: :class:`JsonResponse`
-        ---
-        get:
-            summary: Get upload URL
-            description: |
-                Get upload URL for a `MediaField` field.
-
-                You can upload a file ont the received URL. When the upload
-                query is done, you have to confirm the process with an
-                update request (`PUT`) on {model}. The body of this request
-                must contain the name of the `MediaField` with the contents
-                of the `file` value in the response of this request.
-
-                1. `GET /<int:pk>/<str:field>/upload-url/<str:filename>`
-                    → `data`
-                2. `PUT data.url aFile Content-Type: aFile.type`
-                3. `PUT /<int:pk> {{field: data.file}}`
-            parameters extras:
-                pk: The {model} pk.
-                field: The {model} field name. Must be the name of
-                    a `MediaField` field.
-                filename: The desired filename.
-            responses:
-                200:
-                    description: The upload URL
-                    content:
-                        application/json:
-                            schema:
-                                properties:
-                                    url:
-                                        type: string
-                                        format: uri
-                                    file:
-                                        type: object
-                                        properties:
-                                            name:
-                                                type: string
-                                            key:
-                                                type: string
-        """
-        obj = self.get_object(pk=pk)
-        try:
-            res = self._get_model_field(field).get_upload_url(
-                self.request, obj, filename)
-        except StorageException as e:  # pragma: no cover
-            logger.exception(e)
-            raise APIError(_("Unexpected storage error", status=500))
-        return JsonResponse(res)
-
-    @rest_api(
-        "/<int:pk>/<str:field>", method="get",
-        parameters=[parameters.MediaRedirect], priority_doc=-9)
-    def field_media_get(self, pk, field, *args, **kwargs):
-        """Entrypoint for :code:`GET /<int:pk>/<str:field>` route.
-
-        Get the download URL for a media file.
-
-        :param pk: The object pk
-        :param field: The field name
-        :returns: The JSON response
-        :rtype: :class:`JsonResponse`
-        ---
-        get:
-            summary: Get {model} file
-            description: Get the URL for a media field file.
-            parameters extras:
-                pk: the {model} pk
-                field: the {model} field name
-            responses:
-                200:
-                    description: The file URL, if `redirect` is `false`.
-                    content:
-                        application/json:
-                            schema:
-                                properties:
-                                    url:
-                                        type: string
-                                        format: uri
-                302:
-                    description: The redirect, if `redirect` is `true`.
-        """
-        obj = self.get_object(pk=pk)
-        try:
-            url = self._get_model_field(field).get_url(self.request, obj)
-        except StorageException as e:  # pragma: no cover
-            logger.exception(e)
-            raise APIError(_("Unexpected storage error", status=500))
-        if get_bool(self.request.GET, 'redirect'):
-            return redirect(url)
-        return JsonResponse(dict(url=url))
-
-
-class MediaPermsRestViewMixin(MediaRestViewMixin):
-    """Extension mixin to check permissions."""
-
-    def field_media_upload_url_perm(self, *args, **kwargs):
-        return self.request.user.has_perm(*self.get_model_perms('change'))
-
-    def field_media_get_perm(self, *args, **kwargs):
-        return self.request.user.has_perm(*self.get_model_perms('view'))
-
-
 class SecuredRestViewMixin(View):
     """A view mixin to manage service permissions.
 

{django_pfx-1.4.dev100 → django_pfx-1.4.dev104}/tests/settings/common.py

@@ -45,6 +45,8 @@ PFX_RESET_PASSWORD_URL = (
     'http://localhost:8000/test?token={token}&uidb64={uidb64}')
 PFX_SITE_NAME = 'Books Demo'
 
+STORAGE_DEFAULT = 'pfx.pfxcore.storage.S3Storage'
+
 # Build paths inside the project like this: os.path.join(BASE_DIR, ...)
 BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
 

django_pfx-1.4.dev100/pfx/pfxcore/storage/__init__.py

@@ -1,3 +0,0 @@
-from .s3_storage import S3Storage
-
-DefaultStorage = S3Storage