Allow to customize email publication template in setup (senaite#2063)

* Implemented SENAITE Registry

* Allow to set publication email body text in Setup

* Implemented SENAITE RichTextField

* Use new RichTextField for registry

* Use body text for email from setup

* send HTML Emails

* Test fixture

* Added test for HTML email

* Added upgrade step

* Fix bypassed default factory

* Description changed

* Added SENAITE Setup Object

* Proxy to SENAITE setup

* Moved to SENAITE Setup

* WYSIWYG Support

* Handle default value

* Added test for API

* Added test for setup

* Changelog updated

Author: ramonski

CHANGES.rst

@@ -5,6 +5,7 @@ Changelog
 2.3.0 (unreleased)
 ------------------
 
+- #2063 Allow to customize email publication template in setup
 - #2062 Fix listing not updated after instrument assignment in Worksheet's view
 - #2061 Fire notifications when UID references are created/destroyed
 - #2058 Filter 'Interpretation templates' in sample view by template and type

src/bika/lims/api/__init__.py

@@ -120,6 +120,13 @@ def get_bika_setup():
     return get_setup()
 
 
+def get_senaite_setup():
+    """Fetch the new DX `setup` folder.
+    """
+    portal = get_portal()
+    return portal.get("setup")
+
+
 def create(container, portal_type, *args, **kwargs):
     """Creates an object in Bika LIMS
 

src/bika/lims/api/mail.py

@@ -106,7 +106,12 @@ def to_email_body_text(body, **kw):
     :returns: MIMEText
     """
     body_template = Template(safe_unicode(body)).safe_substitute(**kw)
-    return MIMEText(body_template, _subtype="plain", _charset="utf8")
+    subtype = "plain"
+    # Allow to send HTML messages
+    # https://docs.python.org/2/library/email-examples.html#id5
+    if kw.get("html", False):
+        subtype = "html"
+    return MIMEText(body_template, _subtype=subtype, _charset="utf8")
 
 
 def to_email_attachment(filedata, filename="", **kw):

src/bika/lims/browser/publish/emailview.py

@@ -56,7 +56,6 @@ class EmailView(BrowserView):
     implements(IPublishTraverse)
 
     template = ViewPageTemplateFile("templates/email.pt")
-    email_template = ViewPageTemplateFile("templates/email_template.pt")
 
     def __init__(self, context, request):
         super(EmailView, self).__init__(context, request)
@@ -300,7 +299,14 @@ def email_body(self):
         body = self.request.get("body", None)
         if body is not None:
             return body
-        return self.context.translate(_(self.email_template(self)))
+        setup = api.get_setup()
+        body = setup.getEmailBodySamplePublication()
+        template_context = {
+            "client_name": self.client_name,
+        }
+        rendered_body = self.render_email_template(
+            body, template_context=template_context)
+        return rendered_body
 
     @property
     def email_attachments(self):
@@ -468,7 +474,7 @@ def publish(self, sample):
         except WorkflowException as e:
             logger.error(e)
 
-    def render_email_template(self, template):
+    def render_email_template(self, template, template_context=None):
         """Return the rendered email template
 
         This method interpolates the $recipients variable with the selected
@@ -478,10 +484,13 @@ def render_email_template(self, template):
         :returns: Rendered email template
         """
 
+        # allow to add translation for initial template
+        template = self.context.translate(template)
         recipients = self.email_recipients_and_responsibles
-        template_context = {
-            "recipients": "\n".join(recipients)
-        }
+        if template_context is None:
+            template_context = {
+                "recipients": "\n".join(recipients),
+            }
 
         email_template = Template(safe_unicode(template)).safe_substitute(
             **template_context)
@@ -510,7 +519,8 @@ def send_email(self, recipients, subject, body, attachments=None):
                                              to_address,
                                              subject,
                                              email_body,
-                                             attachments=attachments)
+                                             attachments=attachments,
+                                             html=True)
             sent = mailapi.send_email(mime_msg)
             if not sent:
                 msg = _("Could not send email to {0} ({1})").format(pair[0],

src/bika/lims/browser/publish/templates/email.pt

@@ -114,8 +114,8 @@
 
           <div class="form-group">
             <label i18n:translate="" for="body">Text</label>
-            <textarea name="body" class="form-control" rows="12"
-                      tal:content="view/email_body">
+            <textarea name="body" class="richTextWidget form-control" rows="12"
+                      tal:content="structure view/email_body">
             </textarea>
             <p i18n:translate="" class="help-block discreet">
               The variable <code i18n:name="recipients">$recipients</code> will

src/bika/lims/browser/publish/templates/email_template.pt

@@ -30,11 +30,11 @@
 from bika.lims.browser.worksheet.tools import getWorksheetLayouts
 from bika.lims.config import CURRENCIES
 from bika.lims.config import DECIMAL_MARKS
+from bika.lims.config import DEFAULT_WORKSHEET_LAYOUT
 from bika.lims.config import MULTI_VERIFICATION_TYPE
 from bika.lims.config import PROJECTNAME
 from bika.lims.config import SCINOTATION_OPTIONS
 from bika.lims.config import WEEKDAYS
-from bika.lims.config import DEFAULT_WORKSHEET_LAYOUT
 from bika.lims.content.bikaschema import BikaFolderSchema
 from bika.lims.interfaces import IBikaSetup
 from bika.lims.numbergenerator import INumberGenerator
@@ -53,12 +53,12 @@
 from Products.Archetypes.atapi import StringField
 from Products.Archetypes.atapi import TextAreaWidget
 from Products.Archetypes.atapi import registerType
-from Products.Archetypes.Field import BooleanField
 from Products.Archetypes.Field import TextField
 from Products.Archetypes.utils import DisplayList
 from Products.Archetypes.utils import IntDisplayList
 from Products.Archetypes.Widget import RichWidget
 from Products.CMFCore.utils import getToolByName
+from senaite.core import registry as senaite_registry
 from senaite.core.api import geo
 from senaite.core.browser.fields.records import RecordsField
 from senaite.core.interfaces import IHideActionsMenu
@@ -575,6 +575,25 @@ def getCounterTypes(self, instance=None):
                 "in the sample types setup"),
         )
     ),
+    # NOTE: This is a Proxy Field which delegates to the SENAITE Registry!
+    TextField(
+        "EmailBodySamplePublication",
+        default_content_type="text/html",
+        default_output_type="text/x-html-safe",
+        schemata="Notifications",
+        # Needed to fetch the default value from the registry
+        edit_accessor="getEmailBodySamplePublication",
+        widget=RichWidget(
+            label=_("Email body for Sample publication notifications"),
+            description=_(
+                "The default text that is used for the publication email. "
+                " sending publication reports."),
+            default_mime_type="text/x-html",
+            output_mime_type="text/x-html",
+            allow_file_upload=False,
+            rows=15,
+        ),
+    ),
     BooleanField(
         'NotifyOnSampleRejection',
         schemata="Notifications",
@@ -966,5 +985,17 @@ def getIDServerValuesHTML(self):
             results.append('%s: %s' % (keys[i], values[i]))
         return "\n".join(results)
 
+    def getEmailBodySamplePublication(self):
+        """Get the value from the senaite setup
+        """
+        setup = api.get_senaite_setup()
+        return setup.getEmailBodySamplePublication()
+
+    def setEmailBodySamplePublication(self, value):
+        """Set the value in the senaite setup
+        """
+        setup = api.get_senaite_setup()
+        setup.setEmailBodySamplePublication(value)
+
 
 registerType(BikaSetup, PROJECTNAME)

src/bika/lims/content/bikasetup.py

@@ -31,6 +31,7 @@
   <include package=".modals"/>
   <include package=".portlets"/>
   <include package=".samples"/>
+  <include package=".setup"/>
   <include package=".viewlets"/>
   <include package=".widgets"/>
 

src/senaite/core/browser/configure.zcml

@@ -0,0 +1,5 @@
+<configure
+    xmlns="http://namespaces.zope.org/zope"
+    xmlns:browser="http://namespaces.zope.org/browser">
+
+</configure>

src/senaite/core/browser/setup/__init__.py

@@ -0,0 +1,29 @@
+<tal:template
+  tal:define="laboratory python:context.laboratory"
+  i18n:domain="senaite.core">
+
+  <p i18n:translate="">
+    Thank you for your analysis request.
+  </p>
+
+  <p i18n:translate="">
+    Please find attached the analysis result(s) for
+    <tal:client i18n:name="client_name" tal:content="options/client_name|default">$client_name</tal:client>
+  </p>
+
+  <p i18n:translate="">
+    This report was sent to the following contacts:
+  </p>
+
+  $recipients
+
+  <p i18n:translate="">
+    With best regards
+  </p>
+  <tal:laboratory tal:replace="python:laboratory.getName() or 'SENAITE LIMS'"/>
+
+  <p i18n:translate="">
+    *** This is an automatically generated email, please do not reply to this message. ***
+  </p>
+
+</tal:template>

src/senaite/core/browser/setup/configure.zcml

@@ -20,6 +20,7 @@
   <include package=".migration" />
   <include package=".patches" />
   <include package=".permissions" />
+  <include package=".registry" />
   <include package=".schema" />
   <include package=".upgrade" />
   <include package=".z3cform" />

src/senaite/core/browser/setup/templates/email_body_sample_publication.pt

@@ -0,0 +1,59 @@
+# -*- coding: utf-8 -*-
+
+from AccessControl import ClassSecurityInfo
+from bika.lims import api
+from plone.dexterity.content import Container as BaseContainer
+from plone.dexterity.content import Item as BaseItem
+from senaite.core.interfaces import IContainer
+from senaite.core.interfaces import IItem
+from zope.interface import implementer
+
+
+@implementer(IContainer)
+class Container(BaseContainer):
+    """Base class for SENAITE folderish contents
+    """
+    security = ClassSecurityInfo()
+
+    @security.private
+    def accessor(self, fieldname):
+        """Return the field accessor for the fieldname
+        """
+        schema = api.get_schema(self)
+        if fieldname not in schema:
+            return None
+        return schema[fieldname].get
+
+    @security.private
+    def mutator(self, fieldname):
+        """Return the field mutator for the fieldname
+        """
+        schema = api.get_schema(self)
+        if fieldname not in schema:
+            return None
+        return schema[fieldname].set
+
+
+@implementer(IItem)
+class Item(BaseItem):
+    """Base class for SENAITE contentish contents
+    """
+    security = ClassSecurityInfo()
+
+    @security.private
+    def accessor(self, fieldname):
+        """Return the field accessor for the fieldname
+        """
+        schema = api.get_schema(self)
+        if fieldname not in schema:
+            return None
+        return schema[fieldname].get
+
+    @security.private
+    def mutator(self, fieldname):
+        """Return the field mutator for the fieldname
+        """
+        schema = api.get_schema(self)
+        if fieldname not in schema:
+            return None
+        return schema[fieldname].set