meringue 1.2.0.dev5__tar.gz → 1.2.0.dev7__tar.gz

{meringue-1.2.0.dev5 → meringue-1.2.0.dev7}/.gitignore

@@ -11,4 +11,5 @@ dist
 /build
 /stuff
 /venv
+/media
 /_readthedocs

{meringue-1.2.0.dev5 → meringue-1.2.0.dev7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: meringue
-Version: 1.2.0.dev5
+Version: 1.2.0.dev7
 Summary: A set of various functionality for a Django based web application.
 Project-URL: Documentation, https://dd.github.io/Meringue
 Project-URL: Repository, https://github.com/dd/Meringue

{meringue-1.2.0.dev5 → meringue-1.2.0.dev7}/meringue/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "1.2.0.dev5"
+__version__ = "1.2.0.dev7"
 """
 To update the version, use [hatch version](https://hatch.pypa.io/latest/version/#updating)
 

{meringue-1.2.0.dev5 → meringue-1.2.0.dev7}/meringue/conf/__init__.py

@@ -43,6 +43,7 @@ PARAMS_TO_IMPORT: Final[list[str]] = [
     "THUMBNAIL_IMAGE_CLASS",
     "THUMBNAIL_PROPERTIES",
     "THUMBNAIL_ACTIONS",
+    "PROTECTED_NGINX_LOCATION_GETTER",
 ]
 """
 List of options that contain the path to the module and must be imported.

{meringue-1.2.0.dev5 → meringue-1.2.0.dev7}/meringue/conf/default_settings.py

@@ -125,3 +125,8 @@ response.
 
 The view [protected_file_view][meringue.protected.views.protected_file_view] adds the X-Accel-Redirect header with a link to the file.
 """
+
+PROTECTED_NGINX_LOCATION_GETTER: Final[str] = "meringue.protected.utils.nginx_location_getter"
+"""
+Default getter for the link to the file where nginx should serve it after access verification.
+"""

meringue-1.2.0.dev7/meringue/protected/fields.py

@@ -0,0 +1,126 @@
+from django.contrib.contenttypes.models import ContentType
+from django.db.models.fields.files import FileField
+from django.db.models.fields.files import FieldFile
+from django.db.models.fields.files import ImageField
+from django.db.models.fields.files import ImageFieldFile
+from django.urls import reverse
+try:
+    from django_hosts.resolvers import reverse as hosts_reverse
+except ImportError:
+    hosts_reverse = None
+
+from meringue.conf import m_settings
+
+
+class ProtectedFileMixin:
+    @property
+    def url(self):
+        """
+        Link to the view with access verification to the file
+        """
+
+        self._require_file()
+
+        reverse_kwargs = {
+            "cid": ContentType.objects.get_for_model(self.instance.__class__).id,
+            "field": self.field.name,
+            "pk": self.instance.pk,
+            "disp": self.field.m_protected_disposition,
+        }
+        if self.field.m_protected_host_name:
+            result_url = hosts_reverse(
+                self.field.m_protected_view_name,
+                kwargs=reverse_kwargs,
+                host=self.field.m_protected_host_name,
+            )
+        else:
+            result_url = reverse(self.field.m_protected_view_name, kwargs=reverse_kwargs)
+        return result_url
+
+    @property
+    def redirect_url(self):
+        """
+        Link to the file where nginx should serve it after access verification.
+        """
+
+        return self.field.m_protected_nginx_location_getter(self)
+
+    @property
+    def original_url(self):
+        """
+        The original link to the file.
+        """
+
+        self._require_file()
+        return self.storage.url(self.name)
+
+
+class ProtectedFieldFile(ProtectedFileMixin, FieldFile):
+    pass
+
+
+class ProtectedFileField(FileField):
+    """
+    A field that adds the mechanism of a protected file.
+    """
+
+    attr_class = ProtectedFieldFile
+
+    def __init__(
+        self,
+        view_name,
+        verbose_name=None,
+        name=None,
+        upload_to="protected",
+        storage=None,
+        host_name=None,
+        disposition="attachment",
+        nginx_location_getter=m_settings.PROTECTED_NGINX_LOCATION_GETTER,
+        **kwargs,
+    ):
+        self.m_protected_view_name = view_name
+        self.m_protected_host_name = host_name
+        self.m_protected_disposition = disposition
+        self.m_protected_nginx_location_getter = nginx_location_getter
+        super().__init__(verbose_name, name, upload_to, storage, **kwargs)
+
+    def deconstruct(self):
+        name, path, args, kwargs = super().deconstruct()
+        kwargs['view_name'] = self.m_protected_view_name
+        return name, path, args, kwargs
+
+
+class ProtectedImageFieldFile(ProtectedFileMixin, ImageFieldFile):
+    pass
+
+
+class ProtectedImageField(ImageField):
+    """
+    A field that adds the mechanism of a protected image.
+    """
+
+    attr_class = ProtectedImageFieldFile
+
+    def __init__(
+        self,
+        view_name,
+        verbose_name=None,
+        name=None,
+        width_field=None,
+        height_field=None,
+        host_name=None,
+        disposition="attachment",
+        nginx_location_getter=m_settings.PROTECTED_NGINX_LOCATION_GETTER,
+        **kwargs,
+    ):
+        kwargs.setdefault("upload_to", "protected")
+        self.m_protected_view_name = view_name
+        self.m_protected_host_name = host_name
+        self.m_protected_disposition = disposition
+        self.m_protected_nginx_location_getter = nginx_location_getter
+        super().__init__(verbose_name, name, width_field, height_field, **kwargs)
+
+    def deconstruct(self):
+        name, path, args, kwargs = super().deconstruct()
+        kwargs['view_name'] = self.m_protected_view_name
+        return name, path, args, kwargs

meringue-1.2.0.dev7/meringue/protected/utils.py

@@ -0,0 +1,6 @@
+def nginx_location_getter(field_file):
+    """
+    Getter for the link to the file where nginx should serve it after access verification
+    """
+
+    return field_file.original_url

{meringue-1.2.0.dev5 → meringue-1.2.0.dev7}/meringue/protected/views.py

@@ -15,21 +15,18 @@ from meringue.protected.fields import ProtectedFieldFile
 from meringue.protected.fields import ProtectedImageFieldFile
 
 
-def protected_file_view(request, contenttype_id, field, pk):
+def x_accel_redirect_view(request, cid, field, pk, disp="inline"):
     """
-    В продакшен моде вьха редиректит на урл файла, где нжинкс отдаёт этот файл
-    Защита работает за счёт параметра internal
-    https://nginx.org/en/docs/http/ngx_http_core_module.html#internal
-
-    ```conf
-    location /media/protected/ {
-        internal;
-        alias /home/rpl/rpl-2023-back/public/media/protected/;
-    }
-    ```
+    The view checks the user's access to view and serves the file.
+
+    If you enable the parameter
+    [PROTECTED_SERVE_WITH_NGINX][meringue.conf.default_settings.PROTECTED_SERVE_WITH_NGINX], the
+    file will not be served; instead, the response will contain the X-Accel-Redirect header
+    pointing to the original file. It is expected that nginx will return the file using the
+    [internal](https://nginx.org/en/docs/http/ngx_http_core_module.html#internal) parameter.
     """
 
-    contenttype = ContentType.objects.get(id=contenttype_id)
+    contenttype = ContentType.objects.get(id=cid)
 
     if not request.user.has_perm(f"{contenttype.app_label}.view_{contenttype.model}"):
         raise PermissionDenied()
@@ -44,7 +41,7 @@ def protected_file_view(request, contenttype_id, field, pk):
         file_name = Path(file.name).name
         response = HttpResponse()
         response["Content-Type"] = mimetypes.guess_type(file.path)[0]
-        response["Content-Disposition"] = f"inline; filename={quote(file_name)}"
+        response["Content-Disposition"] = f"{disp}; filename={quote(file_name)}"
 
         if isinstance(file, ProtectedFieldFile | ProtectedImageFieldFile):
             redirect_url = file.original_url
@@ -54,4 +51,7 @@ def protected_file_view(request, contenttype_id, field, pk):
         response["X-Accel-Redirect"] = redirect_url
         return response
 
-    return FileResponse(open(file.path, "rb"))
+    return FileResponse(
+        open(file.path, "rb"),
+        as_attachment = disp == "attachment",
+    )

{meringue-1.2.0.dev5 → meringue-1.2.0.dev7}/pyproject.toml

@@ -157,6 +157,7 @@ dependencies = [
 	"djangorestframework-simplejwt==5.3.1",
 	"drf-spectacular==0.26.4",
 	"pillow==10.3.0",
+	"django_hosts==5.2",
 ]
 [tool.hatch.envs.test.env-vars]
 DJANGO_SETTINGS_MODULE = "test_project.settings"
@@ -177,6 +178,7 @@ dependencies = [
 	"pycryptodome==3.20.0",
 	"drf-spectacular==0.26.4",
 	"pillow==10.3.0",
+	"django_hosts==5.2",
 ]
 [tool.hatch.envs.mtest.overrides]
 matrix.django.dependencies = [

meringue-1.2.0.dev5/meringue/protected/fields.py

@@ -1,75 +0,0 @@
-from django.contrib.contenttypes.models import ContentType
-from django.db.models.fields.files import FileField
-from django.db.models.fields.files import FieldFile
-from django.db.models.fields.files import ImageField
-from django.db.models.fields.files import ImageFieldFile
-from django.urls import reverse
-
-
-class ProtectedFileMixin:
-    @property
-    def url(self):
-        self._require_file()
-        result_url = reverse(
-            self.field.m_protected_view_name,
-            kwargs={
-                "contenttype_id": ContentType.objects.get_for_model(self.instance.__class__).id,
-                "field": self.field.name,
-                "pk": self.instance.pk,
-            },
-        )
-        return result_url
-
-    @property
-    def original_url(self):
-        self._require_file()
-        return self.storage.url(self.name)
-
-
-class ProtectedFieldFile(ProtectedFileMixin, FieldFile):
-    pass
-
-
-class ProtectedFileField(FileField):
-    """
-    A field that adds the mechanism of a protected file.
-    """
-
-    attr_class = ProtectedFieldFile
-
-    def __init__(
-        self,
-        verbose_name=None,
-        name=None,
-        upload_to="protected",
-        storage=None,
-        protected_view_name="meringue-protected-file",
-        **kwargs,
-    ):
-        self.m_protected_view_name = protected_view_name
-        super().__init__(verbose_name, name, upload_to, storage, **kwargs)
-
-
-class ProtectedImageFieldFile(ProtectedFileMixin, ImageFieldFile):
-    pass
-
-
-class ProtectedImageField(ImageField):
-    """
-    A field that adds the mechanism of a protected image.
-    """
-
-    attr_class = ProtectedImageFieldFile
-
-    def __init__(
-        self,
-        verbose_name=None,
-        name=None,
-        width_field=None,
-        height_field=None,
-        protected_view_name="meringue-protected-file",
-        **kwargs,
-    ):
-        kwargs.setdefault("upload_to", "protected")
-        self.m_protected_view_name = protected_view_name
-        super().__init__(verbose_name, name, width_field, height_field, **kwargs)