Add duplicate action for outgoing mails WIP

Author: chris-adam

imio/dms/mail/browser/actionspanel.py

@@ -184,6 +184,7 @@ def __init__(self, context, request):
         self.ACCEPTABLE_ACTIONS = ["delete"]
         self.SECTIONS_TO_RENDER += (
             "render_create_from_template_button",
+            "render_duplicate_button",
             "render_create_new_message",
             "render_send_email",
         )
@@ -207,6 +208,18 @@ def render_create_from_template_button(self):
             return ViewPageTemplateFile("templates/actions_panel_create_from_template.pt")(self)
         return ""
 
+    def may_duplicate(self):
+        """
+        Method that check if special 'duplicate' action has to be displayed.
+        """
+        # TODO define permissions for duplicate
+        return True
+
+    def render_duplicate_button(self):
+        if self.may_duplicate():
+            return ViewPageTemplateFile("templates/actions_panel_duplicate.pt")(self)
+        return ""
+
     def may_create_new_message(self):
         if (
             self.context.is_email()

imio/dms/mail/browser/configure.zcml

@@ -18,6 +18,13 @@
         class=".views.CreateFromTemplateForm"
         />
 
+    <browser:page
+        name="duplicate"
+        for="imio.dms.mail.dmsmail.IImioDmsOutgoingMail"
+        permission="zope2.View"
+        class=".views.DuplicateForm"
+        />
+
     <browser:page
         name="imiodmsmail-settings"
         for="Products.CMFPlone.interfaces.IPloneSiteRoot"

imio/dms/mail/browser/settings.py

@@ -453,6 +453,12 @@ class IImioDmsMailConfig(model.Schema):
             "omail_post_mailing",
             "omail_fields",
             "omail_group_encoder",
+            "omail_duplicate_default_keep_category",
+            "omail_duplicate_default_keep_folder",
+            "omail_duplicate_default_keep_linked_mails",
+            "omail_duplicate_default_keep_dms_files",
+            "omail_duplicate_default_keep_annexes",
+            "omail_duplicate_default_link_to_original",
         ],
     )
 
@@ -533,6 +539,32 @@ class IImioDmsMailConfig(model.Schema):
         default=False,
     )
 
+    # the duplicate-form default fields
+    omail_duplicate_default_keep_category = schema.Bool(
+        title=_(u"Default value when duplicating an outgoing mail for 'Keep classification category'"),
+        default=True,
+    )
+    omail_duplicate_default_keep_folder = schema.Bool(
+        title=_(u"Default value when duplicating an outgoing mail for 'Keep classification folder'"),
+        default=True,
+    )
+    omail_duplicate_default_keep_linked_mails = schema.Bool(
+        title=_(u"Default value when duplicating an outgoing mail for 'Keep linked mails'"),
+        default=True,
+    )
+    omail_duplicate_default_keep_dms_files = schema.Bool(
+        title=_(u"Default value when duplicating an outgoing mail for 'Keep DMS files'"),
+        default=True,
+    )
+    omail_duplicate_default_keep_annexes = schema.Bool(
+        title=_(u"Default value when duplicating an outgoing mail for 'Keep annexes'"),
+        default=True,
+    )
+    omail_duplicate_default_link_to_original = schema.Bool(
+        title=_(u"Default value when duplicating an outgoing mail for 'Link to original'"),
+        default=True,
+    )
+
     # FIELDSET OEM
     model.fieldset(
         "outgoing_email",

imio/dms/mail/browser/static/copy.svg

@@ -0,0 +1,10 @@
+<td class="noPadding" i18n:domain="imio.dms.mail">
+  <a tal:attributes="href string:${context/absolute_url}/@@duplicate"
+     target="_parent"
+     class="overlay"
+     tal:define="dummy view/saveHasActions;">
+     <input tal:condition="not:view/useIcons" type="button" value="Duplicate" class="apButton apButtonAction apButtonAction_duplicate" i18n:attributes="value" />
+     <img tal:condition="view/useIcons" i18n:attributes="title" title="Dupliquer" tal:attributes="src string: ${view/portal_url}/++resource++imio.dms.mail/copy.svg;"/>
+  </a>
+</td>
+<td class="noPadding">

imio/dms/mail/browser/templates/actions_panel_duplicate.pt

@@ -1,11 +1,15 @@
 # -*- coding: utf-8 -*-
 from AccessControl import getSecurityManager
 from collective.ckeditortemplates.cktemplate import ICKTemplate
+from collective.dms.basecontent.dmsfile import IDmsAppendixFile
+from collective.dms.mailcontent.dmsmail import internalReferenceOutgoingMailDefaultValue
 from datetime import datetime
+from DateTime import DateTime
 from eea.faceted.vocabularies.autocomplete import IAutocompleteSuggest
 from imio.dms.mail import _
 from imio.dms.mail import _tr
 from imio.dms.mail import PMH_ENABLED
+from imio.dms.mail.browser.settings import IImioDmsMailConfig
 from imio.dms.mail.browser.table import CKTemplatesTable
 from imio.dms.mail.browser.table import PersonnelTable
 from imio.dms.mail.dmsfile import IImioDmsFile
@@ -20,14 +24,22 @@
 from imio.helpers.workflow import do_transitions
 from imio.helpers.xhtml import object_link
 from plone import api
+from plone.supermodel import model
 from Products.CMFPlone.utils import safe_unicode
 from Products.Five import BrowserView
 from Products.PageTemplates.Expressions import SecureModuleImporter
 from unidecode import unidecode  # unidecode_expect_nonascii not yet available in used version
+from z3c.form import button
+from z3c.form.field import Fields
+from z3c.form.form import Form
+from z3c.relationfield import RelationValue
+from zope import schema
 from zope.annotation import IAnnotations
 from zope.component import getMultiAdapter
+from zope.component import getUtility
 from zope.i18n import translate
 from zope.interface import implements
+from zope.intid.interfaces import IIntIds
 from zope.lifecycleevent import modified
 from zope.pagetemplate.pagetemplate import PageTemplate
 
@@ -70,6 +82,111 @@ def redirect_url(self, uid):
         return "{}/persistent-document-generation?{}".format(url, "&".join(params))
 
 
+class IDuplicateFormSchema(model.Schema):
+
+    keep_category = schema.Bool(
+        title=_(u"Keep classification category"),
+        description=u'',
+        default=True,
+    )
+
+    keep_folder = schema.Bool(
+        title=_(u"Keep classification folder"),
+        description=u'',
+        default=True,
+    )
+
+    keep_linked_mails = schema.Bool(
+        title=_(u"Keep linked mails"),
+        description=u'',
+        default=True,
+    )
+
+    keep_dms_files = schema.Bool(
+        title=_(u"Keep DMS files"),
+        description=u'',
+        default=True,
+    )
+
+    keep_annexes = schema.Bool(
+        title=_(u"Keep annexes"),
+        description=u'',
+        default=True,
+    )
+
+    link_to_original = schema.Bool(
+        title=_(u"Link to original"),
+        description=u'',
+        default=True,
+    )
+
+
+class DuplicateForm(Form):
+
+    """Duplicate an outgoing mail."""
+    label = _(u"Duplicate mail")
+    fields = Fields(IDuplicateFormSchema)
+    ignoreContext = True
+
+    @button.buttonAndHandler(_('Duplicate'), name='duplicate')
+    def handleApply(self, action):
+        data, errors = self.extractData()
+
+        if errors:
+            self.status = self.formErrorsMessage
+            return
+
+        # Duplicate the mail
+        parent = self.context.aq_parent
+        clipboard = parent.manage_copyObjects([self.context.getId()])
+        result = parent.manage_pasteObjects(clipboard)
+        duplicated_mail = parent[result[0]['new_id']]
+        duplicated_mail.creation_date = DateTime()
+        duplicated_mail.reindexObject(idxs=['created'])
+        duplicated_mail.internal_reference_no = internalReferenceOutgoingMailDefaultValue(self)
+        duplicated_mail.due_date = None
+        duplicated_mail.outgoing_date = None
+        duplicated_mail.mail_date = None
+
+        # TODO hide category and folder fields if not enabled
+        if not data['keep_category']:
+            duplicated_mail.classification_categories = None
+
+        if not data['keep_folder']:
+            duplicated_mail.classification_folders = None
+
+        if not data['keep_linked_mails']:
+            duplicated_mail.reply_to = None
+
+        if not data['keep_dms_files']:
+            dms_files = [sub_content.getId() for sub_content in duplicated_mail.values() if IImioDmsFile.providedBy(sub_content)]
+            if dms_files:
+                duplicated_mail.manage_delObjects(dms_files)
+
+        if not data['keep_annexes']:
+            annexes = [sub_content.getId() for sub_content in duplicated_mail.values() if IDmsAppendixFile.providedBy(sub_content)]
+            if annexes:
+                duplicated_mail.manage_delObjects(annexes)
+
+        if data['link_to_original']:
+            intids = getUtility(IIntIds)
+            rel_id = intids.getId(self.context)
+            if duplicated_mail.reply_to is None:
+                duplicated_mail.reply_to = []
+            duplicated_mail.reply_to.append(RelationValue(rel_id))
+
+        self.request.response.redirect(duplicated_mail.absolute_url()+"/edit")
+
+    def updateWidgets(self):
+        super(DuplicateForm, self).updateWidgets()
+        self.widgets["keep_category"].value = ['selected'] if api.portal.get_registry_record("omail_duplicate_default_keep_category", IImioDmsMailConfig, True) else []
+        self.widgets["keep_folder"].value = ['selected'] if api.portal.get_registry_record("omail_duplicate_default_keep_folder", IImioDmsMailConfig, True) else []
+        self.widgets["keep_linked_mails"].value = ['selected'] if api.portal.get_registry_record("omail_duplicate_default_keep_linked_mails", IImioDmsMailConfig, True) else []
+        self.widgets["keep_dms_files"].value = ['selected'] if api.portal.get_registry_record("omail_duplicate_default_keep_dms_files", IImioDmsMailConfig, True) else []
+        self.widgets["keep_annexes"].value = ['selected'] if api.portal.get_registry_record("omail_duplicate_default_keep_annexes", IImioDmsMailConfig, True) else []
+        self.widgets["link_to_original"].value = ['selected'] if api.portal.get_registry_record("omail_duplicate_default_link_to_original", IImioDmsMailConfig, True) else []
+
+
 def parse_query(text):
     """Copied from plone.app.vocabularies.catalog.parse_query but cleaned."""
     for char in "?-+*()":

imio/dms/mail/browser/views.py

@@ -1330,3 +1330,60 @@ msgstr "Templates"
 #: ./browser/viewlets.py:107
 msgid "zip_code"
 msgstr ""
+
+#: ./browser/settings.py:556
+msgid "Default value when duplicating an outgoing mail for 'Keep DMS files'"
+msgstr ""
+
+#: ./browser/settings.py:560
+msgid "Default value when duplicating an outgoing mail for 'Keep annexes'"
+msgstr ""
+
+#: ./browser/settings.py:544
+msgid "Default value when duplicating an outgoing mail for 'Keep classification category'"
+msgstr ""
+
+#: ./browser/settings.py:548
+msgid "Default value when duplicating an outgoing mail for 'Keep classification folder'"
+msgstr ""
+
+#: ./browser/settings.py:552
+msgid "Default value when duplicating an outgoing mail for 'Keep linked mails'"
+msgstr ""
+
+#: ./browser/settings.py:564
+msgid "Default value when duplicating an outgoing mail for 'Link to original'"
+msgstr ""
+
+#: ./browser/views.py:108
+msgid "Keep DMS files"
+msgstr ""
+
+#: ./browser/views.py:115
+msgid "Keep annexes"
+msgstr ""
+
+#: ./browser/views.py:87
+msgid "Keep classification category"
+msgstr ""
+
+#: ./browser/views.py:94
+msgid "Keep classification folder"
+msgstr ""
+
+#: ./browser/views.py:101
+msgid "Keep linked mails"
+msgstr ""
+
+#: ./browser/views.py:122
+msgid "Link to original"
+msgstr ""
+
+#: ./browser/templates/actions_panel_duplicate.pt:6
+#: ./browser/views.py:136
+msgid "Duplicate"
+msgstr ""
+
+#: ./browser/views.py:132
+msgid "Duplicate mail"
+msgstr ""

imio/dms/mail/locales/en/LC_MESSAGES/imio.dms.mail.po

@@ -1332,3 +1332,60 @@ msgstr "Modèles"
 #: ./browser/viewlets.py:107
 msgid "zip_code"
 msgstr "Code postal"
+
+#: ./browser/settings.py:556
+msgid "Default value when duplicating an outgoing mail for 'Keep DMS files'"
+msgstr "Valeur par défault pour le champ 'Garder les fichiers GED' lorsqu'on duplique un courrier sortant"
+
+#: ./browser/settings.py:560
+msgid "Default value when duplicating an outgoing mail for 'Keep annexes'"
+msgstr "Valeur par défault pour le champ 'Garder les annexes' lorsqu'on duplique un courrier sortant"
+
+#: ./browser/settings.py:544
+msgid "Default value when duplicating an outgoing mail for 'Keep classification category'"
+msgstr "Valeur par défault pour le champ 'Garder les catégories' lorsqu'on duplique un courrier sortant"
+
+#: ./browser/settings.py:548
+msgid "Default value when duplicating an outgoing mail for 'Keep classification folder'"
+msgstr "Valeur par défault pour le champ 'Garder les dossiers' lorsqu'on duplique un courrier sortant"
+
+#: ./browser/settings.py:552
+msgid "Default value when duplicating an outgoing mail for 'Keep linked mails'"
+msgstr "Valeur par défault pour le champ 'Garder les courrier liés' lorsqu'on duplique un courrier sortant"
+
+#: ./browser/settings.py:564
+msgid "Default value when duplicating an outgoing mail for 'Link to original'"
+msgstr "Valeur par défault pour le champ 'Lier le courrier dupliqué à l'original' lorsqu'on duplique un courrier sortant"
+
+#: ./browser/views.py:108
+msgid "Keep DMS files"
+msgstr "Garder les fichiers GED"
+
+#: ./browser/views.py:115
+msgid "Keep annexes"
+msgstr "Garder les annexes"
+
+#: ./browser/views.py:87
+msgid "Keep classification category"
+msgstr "Garder les catégories"
+
+#: ./browser/views.py:94
+msgid "Keep classification folder"
+msgstr "Garder les dossiers"
+
+#: ./browser/views.py:101
+msgid "Keep linked mails"
+msgstr "Garder les courrier liés"
+
+#: ./browser/views.py:122
+msgid "Link to original"
+msgstr "Lier le courrier dupliqué à l'original"
+
+#: ./browser/templates/actions_panel_duplicate.pt:6
+#: ./browser/views.py:136
+msgid "Duplicate"
+msgstr "Dupliquer"
+
+#: ./browser/views.py:132
+msgid "Duplicate mail"
+msgstr "Dupliquer le courrier"