meringue 1.2.0.dev6__tar.gz → 1.2.0.dev8__tar.gz

{meringue-1.2.0.dev6 → meringue-1.2.0.dev8}/.gitignore

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

{meringue-1.2.0.dev6 → meringue-1.2.0.dev8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: meringue
-Version: 1.2.0.dev6
+Version: 1.2.0.dev8
 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.dev6 → meringue-1.2.0.dev8}/meringue/__init__.py

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

{meringue-1.2.0.dev6 → meringue-1.2.0.dev8}/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.dev6 → meringue-1.2.0.dev8}/meringue/conf/default_settings.py

@@ -123,5 +123,11 @@ PROTECTED_SERVE_WITH_NGINX: Final[bool] = not settings.DEBUG
 The option implies the distribution of protected files by nginx. Instead of serving the file in
 response.
 
-The view [protected_file_view][meringue.protected.views.protected_file_view] adds the X-Accel-Redirect header with a link to the file.
+The view [x_accel_redirect_view][meringue.protected.views.x_accel_redirect_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.dev6 → meringue-1.2.0.dev8}/meringue/protected/fields.py

@@ -9,16 +9,23 @@ try:
 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(
@@ -30,8 +37,20 @@ class ProtectedFileMixin:
             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)
 
@@ -49,18 +68,27 @@ class ProtectedFileField(FileField):
 
     def __init__(
         self,
+        view_name,
         verbose_name=None,
         name=None,
         upload_to="protected",
         storage=None,
-        protected_view_name="meringue-protected-file",
-        protected_host_name=None,
+        host_name=None,
+        disposition="attachment",
+        nginx_location_getter=m_settings.PROTECTED_NGINX_LOCATION_GETTER,
         **kwargs,
     ):
-        self.m_protected_view_name = protected_view_name
-        self.m_protected_host_name = protected_host_name
+        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
@@ -75,15 +103,24 @@ class ProtectedImageField(ImageField):
 
     def __init__(
         self,
+        view_name,
         verbose_name=None,
         name=None,
         width_field=None,
         height_field=None,
-        protected_view_name="meringue-protected-file",
-        protected_host_name=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 = protected_view_name
-        self.m_protected_host_name = protected_host_name
+        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.dev8/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.dev6 → meringue-1.2.0.dev8}/meringue/protected/views.py

@@ -15,7 +15,7 @@ from meringue.protected.fields import ProtectedFieldFile
 from meringue.protected.fields import ProtectedImageFieldFile
 
 
-def protected_file_view(request, cid, field, pk):
+def x_accel_redirect_view(request, cid, field, pk, disp="inline"):
     """
     The view checks the user's access to view and serves the file.
 
@@ -41,14 +41,17 @@ def protected_file_view(request, cid, 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
+            redirect_url = file.redirect_url
         else:
             redirect_url = file.url
 
         response["X-Accel-Redirect"] = redirect_url
         return response
 
-    return FileResponse(open(file.path, "rb"))
+    return FileResponse(
+        open(file.path, "rb"),
+        as_attachment = disp == "attachment",
+    )