Merge lp:~therp-nl/server-env-tools/7.0-add_email_template_conditional_attachment into lp:~server-env-tools-core-editors/server-env-tools/7.0

[Stefan Rijnhart (Opener)]

See the description in __openerp__.py

[Pedro Manuel Baeza (pedro.baeza)]

I suppose that you mean 'object' instead of 'invoice' in the module description in the part "...as a regular domain expression against the invoice model."

Regards.

[Stefan Rijnhart (Opener) (stefan-opener)]

Hi Pedro, thanks for having a look! This part of the text is a real world example on invoices, so I do mean 'invoice model' here. Of course the functionality is generic so the expression is always against the model of the template.

[Graeme Gellatly (gdgellatly)]

Hi I reviewed code only

All looks good and useful. Only comments for improvement are

Line 215, I know it is extremely unlikely/impossible in current modules but for futureproofing consider

if res_id and res:

rather than just if res_id.

From a usability standpoint it would be useful to have the reverse view. i.e. If you have an attachment you wish to attach to multiple templates being able to specify in the attachment rather than going in to each email template. I think of the use case of say a new product launch or an important change which needs to go with many emails. But that is new feature rather than complaint.

review: Abstain (code review, no test)

[lp:~therp-nl/server-env-tools/7.0-add_email_template_conditional_attachment]

63. By Stefan Rijnhart (Opener) on 2014-01-24

[ADD] Allow configuration from the attachment itself
 Thanks to Graeme Gellatly for this suggestion

[Stefan Rijnhart (Opener) (stefan-opener)]

Hi Graeme,

thank you for the review!

I checked generate_email() in email_template/email_template.py and like you say, it is impossible not to have a return value that is not an email dictionary so I prefer to leave it like this to reflect that. If this changes in the future we can adapt then.

As for your usability suggestion, I just committed this as I think this is a very welcome improvement. Thank you for bringing this up!

[Stefan Rijnhart (Opener) (stefan-opener)]

And the above should say: *impossible to have a return value that is not an email dictionary*

[Nicolas Bessi - Camptocamp (nbessi-c2c-deactivatedaccount)]

Hello,

Some neat picks:
PEP8 in __openerp__.py
Some trailing white space here and there.

Here I'm not sure of this expression:

                domain = (
                    ['&', ('id', '=', res_id)] +
                    literal_eval(attachment.domain)

Why do you use ast.literal_eval instead of openerp safe_eval ?

review: Needs Fixing (no test, code review)

[lp:~therp-nl/server-env-tools/7.0-add_email_template_conditional_attachment]

64. By Stefan Rijnhart (Opener) on 2014-01-27

[FIX] Pep8

[Stefan Rijnhart (Opener) (stefan-opener)]

Hi Nicolas, thanks for the review! I fixed up __openerp__.py.

Using ast.literal_eval here because its functionality is a subset of safe_eval and it is standard python functionality. So it should be safer than safe_eval in this case. Can you live with that?

[Holger Brunn (Therp) (hbrunn)]

I'd also prefer OpenERP's API, so +1 for safe_eval.

But more picking on this line: The '&' makes your code crash for an empty attachment domain ('[]') and adds no benefit I can see. Do I overlook some benefit?

Generally, I think it's safer to use osv.expression.normalize and osv.expression.combine where applicable.

Further: What purpose does conditional_attachment_ids on ir.attachment serve?

review: Needs Fixing (code review)

[Nicolas Bessi - Camptocamp (nbessi-c2c-deactivatedaccount)]

Hello,

In this case I prefere safe eval it is the standard way to do it and should be more portable.

Regards

[Nicolas Bessi - Camptocamp (nbessi-c2c-deactivatedaccount)]

Hello,

Any news about safe eval ?

[Stefan Rijnhart (Opener) (stefan-opener)]

Thanks for the comments. Setting to work in progress as I'm currently thinking about whether or not to reset the m2m relationship when attachments are copied as this currently leads to duplicate attachments on the template (which is useful when you are configuring multiple attachments on the same template but rather disturbing when you are not.

Unmerged revisions

64. By Stefan Rijnhart (Opener) on 2014-01-27

[FIX] Pep8

63. By Stefan Rijnhart (Opener) on 2014-01-24

[ADD] Allow configuration from the attachment itself
 Thanks to Graeme Gellatly for this suggestion

62. By Stefan Rijnhart (Opener) on 2014-01-22

[IMP] Module description

61. By Stefan Rijnhart (Opener) on 2014-01-22

[IMP] Manifest

60. By Stefan Rijnhart (Opener) on 2014-01-22

[FIX] XML indentation
[ADD] Model access rules
[IMP] Translation
[IMP] Docstring

59. By Stefan Rijnhart (Opener) on 2014-01-22

[IMP] Module description

58. By Stefan Rijnhart (Opener) on 2014-01-22

[IMP] Module description

57. By Stefan Rijnhart (Opener) on 2014-01-22

[ADD] Module for conditional attachments on email templates

=== added directory 'email_template_conditional_attachment'
=== added file 'email_template_conditional_attachment/__init__.py'
--- email_template_conditional_attachment/__init__.py	1970-01-01 00:00:00 +0000
+++ email_template_conditional_attachment/__init__.py	2014-01-27 10:03:19 +0000
@@ -0,0 +1,1 @@
+from . import model
 
=== added file 'email_template_conditional_attachment/__openerp__.py'
--- email_template_conditional_attachment/__openerp__.py	1970-01-01 00:00:00 +0000
+++ email_template_conditional_attachment/__openerp__.py	2014-01-27 10:03:19 +0000
@@ -0,0 +1,58 @@
+# -*- coding: utf-8 -*-
+##############################################################################
+#
+#    OpenERP, Open Source Management Solution
+#    This module copyright (C) 2014 Therp BV (<http://therp.nl>).
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as
+#    published by the Free Software Foundation, either version 3 of the
+#    License, or (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+##############################################################################
+{
+    'name': 'Conditional attachments on email templates',
+    'version': '0.1',
+    'author': 'Therp BV',
+    'category': 'Email',
+    'website': 'http://therp.nl',
+    'depends': [
+        'email_template',
+        ],
+    'data': [
+        'view/email_template.xml',
+        'view/ir_attachment.xml',
+        'security/ir.model.access.csv',
+        ],
+    'description': """
+This module allows you to configure a set of static attachments on an email
+template that appear on generated emails conditionally. Conditions are
+specified in the technical *domain* notation that is widely used in OpenERP.
+
+For instance, if you want
+a specific attachment to only be sent out with invoices to Dutch speaking
+customers of a specific company, you can encode this on the template for
+outgoing invoices as a regular domain expression against the invoice model:
+
+    [('company_id', '=', 1), ('partner_id.lang', '=', 'nl_NL')]
+
+Generated emails will then only contain the attachment if the associated
+invoice meets these requirements.
+
+You can configure the conditional attachments on the *Advanced* tab of the
+email template form view.
+
+Again, only static attachments (so no dynamically generated reports) are
+currently supported. An example of usage is attaching a document containing
+general terms and conditions in various languages which can vary per company
+or customer region.
+""",
+}
 
=== added directory 'email_template_conditional_attachment/i18n'
=== added file 'email_template_conditional_attachment/i18n/email_template_conditional_attachment.pot'
--- email_template_conditional_attachment/i18n/email_template_conditional_attachment.pot	1970-01-01 00:00:00 +0000
+++ email_template_conditional_attachment/i18n/email_template_conditional_attachment.pot	2014-01-27 10:03:19 +0000
@@ -0,0 +1,52 @@
+# Translation of OpenERP Server.
+# This file contains the translation of the following modules:
+# 	* email_template_conditional_attachment
+#
+msgid ""
+msgstr ""
+
+#. module: email_template_conditional_attachment
+#: field:ir.attachment,conditional_attachment_ids:0
+msgid "Conditionally attach to email templates"
+msgstr ""
+
+#. module: email_template_conditional_attachment
+#: field:email.template.conditional.attachment,domain:0
+msgid "Domain"
+msgstr ""
+
+#. module: email_template_conditional_attachment
+#: field:email.template.conditional.attachment,template_id:0
+msgid "Email template"
+msgstr ""
+
+#. module: email_template_conditional_attachment
+#: model:ir.model,name:email_template_conditional_attachment.model_email_template
+msgid "Email Templates"
+msgstr ""
+
+#. module: email_template_conditional_attachment
+#: model:ir.model,name:email_template_conditional_attachment.model_email_template_conditional_attachment
+msgid "email.template.conditional.attachment"
+msgstr ""
+
+#. module: email_template_conditional_attachment
+#: model:ir.model,name:email_template_conditional_attachment.model_ir_attachment
+msgid "ir.attachment"
+msgstr ""
+
+#. module: email_template_conditional_attachment
+#: field:email.template.conditional.attachment,attachment_id:0
+msgid "Attachment"
+msgstr ""
+
+#. module: email_template_conditional_attachment
+#: view:email.template:0 field:email.template,conditional_attachment_ids:0
+#: view:ir.attachment:0
+msgid "Conditional attachments"
+msgstr ""
+
+#. module: email_template_conditional_attachment
+#: view:ir.attachment:0
+msgid "Email templates to conditionally attach to"
+msgstr ""
 
=== added file 'email_template_conditional_attachment/i18n/nl.po'
--- email_template_conditional_attachment/i18n/nl.po	1970-01-01 00:00:00 +0000
+++ email_template_conditional_attachment/i18n/nl.po	2014-01-27 10:03:19 +0000
@@ -0,0 +1,64 @@
+# Translation of OpenERP Server.
+# This file contains the translation of the following modules:
+#	* email_template_conditional_attachment
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: OpenERP Server 7.0\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2014-01-24 14:04+0000\n"
+"PO-Revision-Date: 2014-01-24 14:04+0000\n"
+"Last-Translator: <>\n"
+"Language-Team: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Plural-Forms: \n"
+
+#. module: email_template_conditional_attachment
+#: field:ir.attachment,conditional_attachment_ids:0
+msgid "Conditionally attach to email templates"
+msgstr "Voorwaardelijke bijlage bij emailsjabloon"
+
+#. module: email_template_conditional_attachment
+#: field:email.template.conditional.attachment,domain:0
+msgid "Domain"
+msgstr "Domein"
+
+#. module: email_template_conditional_attachment
+#: field:email.template.conditional.attachment,template_id:0
+msgid "Email template"
+msgstr "Emailsjabloon"
+
+#. module: email_template_conditional_attachment
+#: model:ir.model,name:email_template_conditional_attachment.model_email_template
+msgid "Email Templates"
+msgstr "Email-sjablonen"
+
+#. module: email_template_conditional_attachment
+#: model:ir.model,name:email_template_conditional_attachment.model_email_template_conditional_attachment
+msgid "email.template.conditional.attachment"
+msgstr "email.template.conditional.attachment"
+
+#. module: email_template_conditional_attachment
+#: model:ir.model,name:email_template_conditional_attachment.model_ir_attachment
+msgid "ir.attachment"
+msgstr "ir.attachment"
+
+#. module: email_template_conditional_attachment
+#: field:email.template.conditional.attachment,attachment_id:0
+msgid "Attachment"
+msgstr "Bijlage"
+
+#. module: email_template_conditional_attachment
+#: view:email.template:0
+#: field:email.template,conditional_attachment_ids:0
+#: view:ir.attachment:0
+msgid "Conditional attachments"
+msgstr "Conditionele bijlagen"
+
+#. module: email_template_conditional_attachment
+#: view:ir.attachment:0
+msgid "Email templates to conditionally attach to"
+msgstr "Voorwaardelijke bijlage bij emailsjablonen"
+
 
=== added directory 'email_template_conditional_attachment/model'
=== added file 'email_template_conditional_attachment/model/__init__.py'
--- email_template_conditional_attachment/model/__init__.py	1970-01-01 00:00:00 +0000
+++ email_template_conditional_attachment/model/__init__.py	2014-01-27 10:03:19 +0000
@@ -0,0 +1,3 @@
+from . import email_template_conditional_attachment
+from . import email_template
+from . import ir_attachment
 
=== added file 'email_template_conditional_attachment/model/email_template.py'
--- email_template_conditional_attachment/model/email_template.py	1970-01-01 00:00:00 +0000
+++ email_template_conditional_attachment/model/email_template.py	2014-01-27 10:03:19 +0000
@@ -0,0 +1,51 @@
+# -*- coding: utf-8 -*-
+##############################################################################
+#
+#    OpenERP, Open Source Management Solution
+#    This module copyright (C) 2014 Therp BV (<http://therp.nl>).
+#            
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as
+#    published by the Free Software Foundation, either version 3 of the
+#    License, or (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+##############################################################################
+from ast import literal_eval
+from openerp.osv import orm, fields
+
+
+class EmailTemplate(orm.Model):
+    _inherit = 'email.template'
+    _columns = {
+        'conditional_attachment_ids': fields.one2many(
+            'email.template.conditional.attachment',
+            'template_id', 'Conditional attachments'),
+        }
+
+    def generate_email(self, cr, uid, template_id, res_id, context=None):
+        """
+        Go through the conditional attachments and select those
+        of which the domain matches the resource.
+        """
+        res = super(EmailTemplate, self).generate_email(
+            cr, uid, template_id, res_id, context=context)
+        if res_id:
+            template = self.browse(cr, uid, template_id, context=context)
+            for attachment in template.conditional_attachment_ids:
+                domain = (
+                    ['&', ('id', '=', res_id)] +
+                    literal_eval(attachment.domain))
+                if self.pool.get(template.model).search(
+                        cr, uid, domain, context=context):
+                    res['attachment_ids'].append(
+                        attachment.attachment_id.id)
+        return res
+            
 
=== added file 'email_template_conditional_attachment/model/email_template_conditional_attachment.py'
--- email_template_conditional_attachment/model/email_template_conditional_attachment.py	1970-01-01 00:00:00 +0000
+++ email_template_conditional_attachment/model/email_template_conditional_attachment.py	2014-01-27 10:03:19 +0000
@@ -0,0 +1,35 @@
+# -*- coding: utf-8 -*-
+##############################################################################
+#
+#    OpenERP, Open Source Management Solution
+#    This module copyright (C) 2014 Therp BV (<http://therp.nl>).
+#            
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as
+#    published by the Free Software Foundation, either version 3 of the
+#    License, or (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+##############################################################################
+from openerp.osv import orm, fields
+
+
+class EmailTemplateConditionalAttachment(orm.Model):
+    _name = 'email.template.conditional.attachment'
+    
+    _columns = {
+        'template_id': fields.many2one(
+            'email.template', 'Email template', required=True,
+            ondelete='CASCADE'),
+        'attachment_id': fields.many2one(
+            'ir.attachment', 'Attachment', required=True),
+        'domain': fields.char(
+            size=256, string='Domain', required=True),
+        }
 
=== added file 'email_template_conditional_attachment/model/ir_attachment.py'
--- email_template_conditional_attachment/model/ir_attachment.py	1970-01-01 00:00:00 +0000
+++ email_template_conditional_attachment/model/ir_attachment.py	2014-01-27 10:03:19 +0000
@@ -0,0 +1,30 @@
+# -*- coding: utf-8 -*-
+##############################################################################
+#
+#    OpenERP, Open Source Management Solution
+#    This module copyright (C) 2014 Therp BV (<http://therp.nl>).
+#            
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as
+#    published by the Free Software Foundation, either version 3 of the
+#    License, or (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+##############################################################################
+from openerp.osv import orm, fields
+
+
+class IrAttachment(orm.Model):
+    _inherit = 'ir.attachment'
+    _columns = {
+        'conditional_attachment_ids': fields.one2many(
+            'email.template.conditional.attachment',
+            'attachment_id', 'Conditionally attach to email templates'),
+        }
 
=== added directory 'email_template_conditional_attachment/security'
=== added file 'email_template_conditional_attachment/security/ir.model.access.csv'
--- email_template_conditional_attachment/security/ir.model.access.csv	1970-01-01 00:00:00 +0000
+++ email_template_conditional_attachment/security/ir.model.access.csv	2014-01-27 10:03:19 +0000
@@ -0,0 +1,3 @@
+id,name,model_id:id,group_id:id,perm_read,perm_write,perm_create,perm_unlink
+access_email_template_conditional_attachment,email.template,model_email_template_conditional_attachment,,1,1,1,0
+access_email_template_conditional_attachment_system,email.template system,model_email_template_conditional_attachment,base.group_system,1,1,1,1
 
=== added directory 'email_template_conditional_attachment/static'
=== added directory 'email_template_conditional_attachment/static/src'
=== added directory 'email_template_conditional_attachment/static/src/img'
=== added file 'email_template_conditional_attachment/static/src/img/icon.png'
 Binary files email_template_conditional_attachment/static/src/img/icon.png	1970-01-01 00:00:00 +0000 and email_template_conditional_attachment/static/src/img/icon.png	2014-01-27 10:03:19 +0000 differ
=== added directory 'email_template_conditional_attachment/view'
=== added file 'email_template_conditional_attachment/view/email_template.xml'
--- email_template_conditional_attachment/view/email_template.xml	1970-01-01 00:00:00 +0000
+++ email_template_conditional_attachment/view/email_template.xml	2014-01-27 10:03:19 +0000
@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="utf-8"?>
+<openerp>
+    <data>
+        
+        <record model="ir.ui.view" id="email_template_form">
+            <field name="name">Add list of conditional attachments to email template form</field>
+            <field name="model">email.template</field>
+            <field name="inherit_id" ref="email_template.email_template_form" />
+            <field name="arch" type="xml">
+                <field name="attachment_ids" position="after">
+                    <field name="conditional_attachment_ids" colspan="4">
+                        <tree string="Conditional attachments" editable="bottom">
+                            <field name="attachment_id" />
+                            <field name="domain" />
+                        </tree>
+                    </field>
+                </field>
+            </field>
+        </record>
+        
+    </data>
+</openerp>
 
=== added file 'email_template_conditional_attachment/view/ir_attachment.xml'
--- email_template_conditional_attachment/view/ir_attachment.xml	1970-01-01 00:00:00 +0000
+++ email_template_conditional_attachment/view/ir_attachment.xml	2014-01-27 10:03:19 +0000
@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="utf-8"?>
+<openerp>
+    <data>
+        
+        <record id="view_attachment_form" model="ir.ui.view">
+            <field name="name">Conditional attachment onto email template</field>
+            <field name="model">ir.attachment</field>
+            <field name="inherit_id" ref="base.view_attachment_form" />
+            <field name="arch" type="xml">
+                <group name="description_group" position="after">
+                    <group name="conditionally_attach"
+                           string ="Email templates to conditionally attach to" 
+                           />
+                    <field name="conditional_attachment_ids"
+                           nolabel="1" colspan="4">
+                        <tree string="Conditional attachments" editable="bottom">
+                            <field name="template_id" />
+                            <field name="domain" />
+                        </tree>
+                    </field>
+                </group>
+            </field>
+        </record>
+        
+    </data>
+</openerp>