datatable

.coveragerc

@@ -6,6 +6,7 @@ include =
     */src/collective/*
 omit =
     */test*
+    */upgrades*
     /home/*/.buildout/eggs/*
     /home/travis/buildout-cache/eggs/*
     /home/travis/virtualenv/*
@@ -16,4 +17,4 @@ omit =
     */lib/*
     *.txt
     *.rst
-    */upgrades.py
+    */upgrades.py

CHANGES.rst

@@ -4,6 +4,14 @@ Changelog
 3.2.4 (unreleased)
 ------------------
 
+- Save attachments as blobfile in the storage adapter, add a view to download them, returns
+  attachment info in the restapi @form-data endpoint.
+  [mamico]
+- Fix: if there are multiple forms on a page, each csv button downloads the record of all the forms,
+  now if there is a block_id parameter, the csv is filtered on that.
+  [mamico]
+- Subject templating
+  [folix-01]
 - Do not set values in __init__ in *SubmitPost* because the user there is not already set and can lead to problems.
   [cekk]
 

README.rst

@@ -146,7 +146,7 @@ If block is set to store data, we store it into the content that has that block
 
 The store is an adapter registered for *IFormDataStore* interface, so you can override it easily.
 
-Only fields that are also in block settings are stored. Missing ones will be skipped.
+Only fields that are also in block settings are stored (also attachments). Missing ones will be skipped.
 
 Each Record stores also two *service* attributes:
 
@@ -155,6 +155,12 @@ Each Record stores also two *service* attributes:
 
 We store these attributes because the form can change over time and we want to have a snapshot of the fields in the Record.
 
+When an attachment is stored, there is a view (@@download) that allow to download the file from the context, for example::
+
+    https://nohost/page/saved_data/@@download/record_id/field_id/filename
+
+This view is accessible only for users that can edit the context (Modify portal content permission).
+
 Data ID Mapping
 ^^^^^^^^^^^^^^^
 

setup.py

@@ -27,7 +27,6 @@
         "Framework :: Plone :: 5.2",
         "Framework :: Plone :: 6.0",
         "Programming Language :: Python",
-        "Programming Language :: Python :: 3.7",
         "Programming Language :: Python :: 3.8",
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
@@ -50,7 +49,7 @@
     package_dir={"": "src"},
     include_package_data=True,
     zip_safe=False,
-    python_requires=">=3.7",
+    python_requires=">=3.8",
     install_requires=[
         "setuptools",
         "z3c.jbot",
@@ -59,6 +58,7 @@
         "plone.dexterity",
         "plone.i18n",
         "plone.memoize",
+        "plone.namedfile",
         "plone.protect",
         "plone.registry",
         "plone.restapi>=8.36.0",

src/collective/volto/formsupport/adapters/post.py

@@ -14,6 +14,7 @@
 from zope.interface import implementer
 from zope.interface import Interface
 
+import base64
 import math
 import os
 
@@ -118,7 +119,7 @@ def validate_form(self):
                 )
             )
 
-        if not self.form_data.get("data", []):
+        if not self.form_data.get("data", []) and not self.form_data.get("attachments"):
             raise BadRequest(
                 translate(
                     _(
@@ -207,14 +208,21 @@ def validate_bcc(self):
                 )
 
     def validate_attachments(self):
+        """
+        * validate attachments size (total size of all attachments must be less
+          than FORM_ATTACHMENTS_LIMIT)
+        """
         attachments_limit = os.environ.get("FORM_ATTACHMENTS_LIMIT", "")
         if not attachments_limit:
             return
         attachments = self.form_data.get("attachments", {})
         attachments_len = 0
-        for attachment in attachments.values():
-            data = attachment.get("data", "")
-            attachments_len += (len(data) * 3) / 4 - data.count("=", -2)
+        for value in attachments.values():
+            data = value.get("data", "")
+            if value.get("encoding") == "base64":
+                attachments_len += len(base64.b64decode(data))
+            else:
+                attachments_len += len(data)
         if attachments_len > float(attachments_limit) * pow(1024, 2):
             size_name = ("B", "KB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB")
             i = int(math.floor(math.log(attachments_len, 1024)))
@@ -239,6 +247,7 @@ def validate_attachments(self):
     def filter_parameters(self):
         """
         do not send attachments fields.
+        Used for email message body, and xml attachment (?)
         """
         result = []
 
@@ -258,16 +267,17 @@ def format_fields(self):
         field_ids = [field.get("field_id") for field in self.block.get("subblocks", [])]
 
         for field in fields:
-            field_id = field.get("field_id", "")
+            field_data = deepcopy(field)
+            field_id = field_data.get("field_id", "")
 
             if field_id:
                 field_index = field_ids.index(field_id)
-                value = field.get("value", "")
+                value = field_data.get("value", "")
                 if isinstance(value, list):
-                    field["value"] = ", ".join(value)
+                    field_data["value"] = ", ".join(value)
                 if self.block["subblocks"][field_index].get("field_type") == "date":
-                    field["value"] = api.portal.get_localized_time(value)
+                    field_data["value"] = api.portal.get_localized_time(value)
 
-            formatted_fields.append(field)
+            formatted_fields.append(field_data)
 
         return formatted_fields

src/collective/volto/formsupport/browser/configure.zcml

@@ -35,4 +35,18 @@
       permission="zope2.View"
       />
 
+  <browser:page
+      name="saved_data"
+      for="plone.dexterity.interfaces.IDexterityContent"
+      class=".saved_data.SavedData"
+      permission="cmf.ModifyPortalContent"
+      />
+
+  <browser:page
+      name="download"
+      for=".saved_data.ISavedDataTraverse"
+      class=".saved_data.AttachmentDownload"
+      permission="cmf.ModifyPortalContent"
+      />
+
 </configure>

src/collective/volto/formsupport/browser/saved_data.py

@@ -0,0 +1,55 @@
+from collective.volto.formsupport.interfaces import IFormDataStore
+from plone.namedfile.utils import set_headers
+from plone.namedfile.utils import stream_data
+from Products.Five.browser import BrowserView
+from zExceptions import NotFound
+from zope.component import getMultiAdapter
+from zope.interface import implementer
+from zope.publisher.interfaces import IPublishTraverse
+
+
+class ISavedDataTraverse(IPublishTraverse):
+    pass
+
+
+@implementer(ISavedDataTraverse)
+class SavedData(BrowserView):
+    pass
+
+
+@implementer(IPublishTraverse)
+class AttachmentDownload(BrowserView):
+    def __init__(self, context, request):
+        super().__init__(context, request)
+        self.record_id = None
+        self.field_id = None
+        self.filename = None
+
+    def publishTraverse(self, request, name):
+        """
+        e.g.
+            https://nohost/page/saved_data/@@download/record_id/field_id/filename
+        """
+        if self.record_id is None:
+            self.record_id = int(name)
+        elif self.field_id is None:
+            self.field_id = name
+        elif self.filename is None:
+            self.filename = name
+        else:
+            raise NotFound("Not found")
+        return self
+
+    def __call__(self):
+        store = getMultiAdapter((self.context.context, self.request), IFormDataStore)
+        # data = FormData(self.context, self.request)
+        try:
+            record = store.soup.get(self.record_id)
+        except KeyError:
+            raise NotFound("Record not found")
+        try:
+            field = record.attrs.get(self.field_id)
+        except KeyError:
+            raise NotFound("Field not found")
+        set_headers(field, self.request.response, filename=field.filename)
+        return stream_data(field)

src/collective/volto/formsupport/datamanager/catalog.py

@@ -1,9 +1,11 @@
+from base64 import b64decode
 from collective.volto.formsupport import logger
 from collective.volto.formsupport.interfaces import IFormDataStore
 from collective.volto.formsupport.utils import get_blocks
 from copy import deepcopy
 from datetime import datetime
 from plone.dexterity.interfaces import IDexterityContent
+from plone.namedfile import NamedBlobFile
 from plone.restapi.deserializer import json_body
 from repoze.catalog.catalog import Catalog
 from repoze.catalog.indexes.field import CatalogFieldIndex
@@ -79,25 +81,48 @@ def add(self, data):
             return None
 
         fields = {
-            x["field_id"]: x.get("custom_field_id", x.get("label", x["field_id"]))
-            for x in form_fields
+            f["field_id"]: {
+                "label": f.get("custom_field_id", f.get("label", f["field_id"])),
+                "type": f.get("field_type", "text"),
+            }
+            for f in form_fields
         }
+
         record = Record()
         fields_labels = {}
         fields_order = []
+        fields_types = {}
         for field_data in data:
             field_id = field_data.get("field_id", "")
             value = field_data.get("value", "")
             if field_id in fields:
-                record.attrs[field_id] = value
-                fields_labels[field_id] = fields[field_id]
+                field = fields[field_id]
+                record.attrs[field_id] = self.storedValue(value, field["type"])
+                fields_types[field_id] = field.get("type", "")
+                fields_labels[field_id] = field["label"]
                 fields_order.append(field_id)
+            # else: skip the field
         record.attrs["fields_labels"] = fields_labels
         record.attrs["fields_order"] = fields_order
+        record.attrs["fields_types"] = fields_types
         record.attrs["date"] = datetime.now()
         record.attrs["block_id"] = self.block_id
         return self.soup.add(record)
 
+    def storedValue(self, value, type):
+        if type == "attachment":
+            if value:
+                if value.get("encoding") == "base64":
+                    data = b64decode(value["data"])
+                else:
+                    data = value["data"]
+                return NamedBlobFile(
+                    data=data,
+                    filename=value.get("filename"),
+                    contentType=value.get("content-type", "application/octet-stream"),
+                )
+        return value
+
     def length(self):
         return len([x for x in self.soup.data.values()])
 

src/collective/volto/formsupport/restapi/services/form_data/csv.py

@@ -2,8 +2,10 @@
 from collective.volto.formsupport.utils import get_blocks
 from copy import deepcopy
 from io import StringIO
+from plone.namedfile import NamedBlobFile
 from plone.restapi.serializer.converters import json_compatible
 from plone.restapi.services import Service
+from zExceptions import NotFound
 from zope.component import getMultiAdapter
 
 import csv
@@ -16,12 +18,15 @@ class FormDataExportGet(Service):
     def __init__(self, context, request):
         super().__init__(context, request)
         self.form_fields_order = []
-        self.form_block = {}
+        self.form_block = None
+        self.block_id = self.request.get("block_id")
 
         blocks = getattr(context, "blocks", {})
         if not blocks:
-            return
+            raise NotFound("No blocks found")
         for id, block in blocks.items():
+            if self.block_id and id != self.block_id:
+                continue
             block_type = block.get("@type", "")
             if block_type == "form":
                 self.form_block = block
@@ -105,6 +110,8 @@ def get_data(self):
         fields_labels = self.get_fields_labels()
 
         for item in store.search():
+            if self.block_id and item.attrs.get("block_id") != self.block_id:
+                continue
             data = {}
 
             for k in self.get_ordered_keys(item):
@@ -119,7 +126,10 @@ def get_data(self):
                 if k not in self.form_fields_order and label not in legacy_columns:
                     legacy_columns.append(label)
 
-                data[label] = json_compatible(value)
+                if isinstance(value, NamedBlobFile):
+                    data[label] = value.filename
+                else:
+                    data[label] = json_compatible(value)
 
             for k in fixed_columns:
                 # add fixed columns values