Merge pull request #51 from yelizariev/8.0-mail_private

8.0 mail private

mail_private/README.rst

@@ -0,0 +1,29 @@
+====================
+ Internal Messaging
+====================
+
+Send private messages to specified recipients, regardless of who are in followers list.
+
+Credits
+=======
+
+Contributors
+------------
+* Pavel Romanchenko <romanchenko@it-projects.info>
+
+Sponsors
+--------
+* `IT-Projects LLC <https://it-projects.info>`_
+
+Further information
+===================
+
+Demo: http://runbot.it-projects.info/demo/mail-addons/8.0
+
+HTML Description: https://apps.odoo.com/apps/modules/8.0/mail_private/
+
+Usage instructions: `<doc/index.rst>`_
+
+Changelog: `<doc/changelog.rst>`_
+
+Tested on Odoo 8.0 0af32f3f84bae07b11abb8538d02e35c7369a348

mail_private/__init__.py

@@ -0,0 +1,3 @@
+# -*- coding: utf-8 -*-
+
+import models

mail_private/__openerp__.py

@@ -0,0 +1,35 @@
+# -*- coding: utf-8 -*-
+{
+    "name": """Internal Messaging""",
+    "summary": """Send private messages to specified recipients, regardless of who are in followers list.""",
+    "category": "Discuss",
+    "images": ['images/mail_private_image.png'],
+    "version": "1.0.0",
+    "application": False,
+
+    "author": "IT-Projects LLC, Pavel Romanchenko",
+    "website": "https://it-projects.info",
+    "license": "GPL-3",
+    "price": 90.00,
+    "currency": "EUR",
+
+    "depends": [
+        "mail",
+    ],
+    "external_dependencies": {"python": [], "bin": []},
+    "data": [
+        'template.xml',
+        'view.xml',
+    ],
+    "qweb": [
+        'static/src/xml/mail_private.xml',
+    ],
+    "demo": [],
+
+    "post_load": None,
+    "pre_init_hook": None,
+    "post_init_hook": None,
+
+    "auto_install": False,
+    "installable": True,
+}

mail_private/doc/changelog.rst

@@ -0,0 +1,7 @@
+Changelog
+=========
+
+`1.0.0`
+-------
+
+- Init version

mail_private/doc/index.rst

@@ -0,0 +1,26 @@
+====================
+ Internal Messaging
+====================
+
+Installation
+============
+
+Nothing special is needed to install this module.
+
+Usage
+=====
+
+To send a message to specified recipients:
+
+* Click on the ``[Send internal message]``.
+
+* Choose the recipients that should receive a message by ticking the checkboxes.
+
+* To add more recipients click on the ``[Open the full mail composer]`` on the right upper corner of the message block and choose recipients in the **Recipient** field.
+
+* Click on the ``[Send]`` button.
+
+Uninstallation
+==============
+
+Nothing special is needed to uninstall this module.

mail_private/models.py

@@ -0,0 +1,13 @@
+# -*- coding: utf-8 -*-
+
+from openerp import api
+from openerp.osv import osv, fields
+from openerp import SUPERUSER_ID
+
+
+class mail_compose_message(osv.TransientModel):
+    _inherit = 'mail.compose.message'
+
+    _columns = {
+        'private': fields.boolean('Send Internal Message'),
+    }

mail_private/static/description/index.html

@@ -0,0 +1,67 @@
+<section class="oe_container">
+    <div class="oe_row oe_spaced">
+        <div class="oe_span12">
+            <h2 class="oe_slogan">Internal Messaging</h2>
+            <h3 class="oe_slogan">Send private messages to specified recipients, regardless of who are in followers list.</h3>
+        </div>
+    </div>
+</section>
+
+<section class="oe_container">
+    <div class="oe_row oe_spaced">
+      <div class="oe_span12">
+          <blockquote>
+              The module will be available for Odoo 9.0 soon. You have time to buy Internal Messaging before price increase! (When you purchase 8.0 version, you get a right to download 9.0 and any further module versions).
+          </blockquote>
+
+        <p class="oe_mt32">
+          By default, to send a private message to specific recipient(s) you need to delete other followers included to the same document. The module allows to send private messages to recipients you specified, regardless of who are in the followers list.
+		</p>
+		<p>
+		  It simplify internal communication in leads, when you need to send some private messages to your colleagues before reply to customer.
+It helps in records like project tasks too. In a task with many participants, you can easily send message and only specified colleagues will be notified. It allows to have clean inbox for everybody. It's very essential, because people often neglect important message in Inbox full of useless messages.
+		</p>
+	  </div>
+	</div>
+</section>
+
+<section class="oe_container oe_dark">
+  <div class="oe_row oe_spaced">
+	<div class="oe_span12">
+	  <h3 class="oe_slogan">How it works</h3>
+	  <p class="oe_mt32">
+		Click on the "Send internal message" and choose the recipient(s). Then type any message and click on the "Send" button.
+	  </p>
+      <div class="oe_demo oe_picture oe_screenshot">
+        <img src="check_recipients.png"/>
+      </div>
+    </div>
+  </div>
+</section>
+
+<section class="oe_container">
+    <div class="oe_row oe_spaced">
+      <div class="oe_span12">
+        <p class="oe_mt32">
+          As a result you can see the message with a dark background, which is sent to the corresponding recipient(s). Other followers of the document will not receive your message.
+		</p>
+        <div class="oe_demo oe_picture oe_screenshot">
+          <img src="result_message.png"/>
+        </div>
+      </div>
+    </div>
+</section>
+
+
+<section class="oe_container">
+  <div class="oe_row oe_spaced">
+    <div class="oe_span12">
+      <h2>Need our service?</h2>
+      <p class="oe_mt32">Contact us by <a href="mailto:it@it-projects.info">email</a> or fill out <a href="https://www.it-projects.info/page/website.contactus " target="_blank">request form</a></p>
+      <ul>
+        <li><a href="mailto:it@it-projects.info">it@it-projects.info <i class="fa fa-envelope-o"></i></a></li>
+        <li><a href="https://www.it-projects.info/page/website.contactus " target="_blank">https://www.it-projects.info/page/website.contactus <i class="fa fa-list-alt"></i></a></li>
+      </ul>
+    </div>
+  </div>
+</section>

mail_private/static/src/js/mail_private.js

@@ -0,0 +1,201 @@
+openerp.mail_private = function(instance){
+
+    var mail = instance.mail;
+
+    instance.mail.ThreadComposeMessage.include({
+        init: function (parent, datasets, options) {
+            this._super.apply(this, arguments);
+            this.private = false;
+        },
+        bind_events: function(){
+            var self = this;
+            this.$('.oe_compose_post_private').on('click', self.on_toggle_quick_composer_private);
+            this._super.apply(this, arguments);
+        },
+        on_compose_fullmail: function (default_composition_mode) {
+            var self = this;
+            if(!this.do_check_attachment_upload()) {
+                return false;
+            }
+            var recipient_done = $.Deferred();
+            if (this.is_log) {
+                recipient_done.resolve([]);
+            }
+            else {
+                recipient_done = this.check_recipient_partners();
+            }
+            $.when(recipient_done).done(function (partner_ids) {
+                var context = {
+                    'default_parent_id': self.id,
+                    'default_body': mail.ChatterUtils.get_text2html(self.$el ? (self.$el.find('textarea:not(.oe_compact)').val() || '') : ''),
+                    'default_attachment_ids': _.map(self.attachment_ids, function (file) {return file.id;}),
+                    'default_partner_ids': partner_ids,
+                    'default_is_log': self.is_log,
+                    'default_private': self.private,
+                    'mail_post_autofollow': true,
+                    'mail_post_autofollow_partner_ids': partner_ids,
+                    'is_private': self.is_private
+                };
+                if (default_composition_mode != 'reply' && self.context.default_model && self.context.default_res_id) {
+                    context.default_model = self.context.default_model;
+                    context.default_res_id = self.context.default_res_id;
+                }
+
+                var action = {
+                    type: 'ir.actions.act_window',
+                    res_model: 'mail.compose.message',
+                    view_mode: 'form',
+                    view_type: 'form',
+                    views: [[false, 'form']],
+                    target: 'new',
+                    context: context,
+                };
+
+                self.do_action(action, {
+                    'on_close': function(){ !self.parent_thread.options.view_inbox && self.parent_thread.message_fetch() }
+                });
+                self.on_cancel();
+            });
+
+        },
+        do_send_message_post: function (partner_ids, log) {
+            var self = this;
+            var values = {
+                'body': this.$('textarea').val(),
+                'subject': false,
+                'parent_id': this.context.default_parent_id,
+                'attachment_ids': _.map(this.attachment_ids, function (file) {return file.id;}),
+                'partner_ids': partner_ids,
+                'context': _.extend(this.parent_thread.context, {
+                    'mail_post_autofollow': true,
+                    'mail_post_autofollow_partner_ids': partner_ids,
+                    'default_private': self.private
+                }),
+                'type': 'comment',
+                'content_subtype': 'plaintext',
+            };
+            if (log || self.private) {
+                values['subtype'] = false;
+            }
+            else {
+                values['subtype'] = 'mail.mt_comment';
+            }
+            this.parent_thread.ds_thread._model.call('message_post', [this.context.default_res_id], values).done(function (message_id) {
+                var thread = self.parent_thread;
+                var root = thread == self.options.root_thread;
+                if (self.options.display_indented_thread < self.thread_level && thread.parent_message) {
+                    var thread = thread.parent_message.parent_thread;
+                }
+                // create object and attach to the thread object
+                thread.message_fetch([["id", "=", message_id]], false, [message_id], function (arg, data) {
+                    var message = thread.create_message_object( data.slice(-1)[0] );
+                    // insert the message on dom
+                    thread.insert_message( message, root ? undefined : self.$el, root );
+                });
+                self.on_cancel();
+                self.flag_post = false;
+            });
+        },
+        on_toggle_quick_composer: function (event) {
+            if (event.target.className == 'oe_compose_post') {
+                this.recipients = [];
+                this.private = false;
+            }
+            this._super.apply(this, arguments);
+        },
+        on_toggle_quick_composer_private: function (event) {
+            this.recipients = [];
+            var self = this;
+            var $input = $(event.target);
+            this.compute_emails_from();
+            var email_addresses = _.pluck(this.recipients, 'email_address');
+            var suggested_partners = $.Deferred();
+
+            // if clicked: call for suggested recipients
+            if (event.type == 'click') {
+                this.private = $input.hasClass('oe_compose_post_private');
+                this.is_log = false;
+                suggested_partners = this.parent_thread.get_recipients_for_internal_message([this.context.default_res_id], this.context)
+                    .done(function (additional_recipients) {
+                        var thread_recipients = additional_recipients[self.context.default_res_id];
+                        _.each(thread_recipients, function (recipient) {
+                            var parsed_email = mail.ChatterUtils.parse_email(recipient[1]);
+                            if (_.indexOf(email_addresses, parsed_email[1]) == -1) {
+                                self.recipients.push({
+                                    'checked': false,
+                                    'partner_id': recipient[0],
+                                    'full_name': recipient[1],
+                                    'name': parsed_email[0],
+                                    'email_address': parsed_email[1],
+                                    'reason': recipient[2],
+                                })
+                            }
+                        });
+                    });
+            }
+            else {
+                suggested_partners.resolve({});
+            }
+            // uncheck partners from compute_emails_from
+            _.each(this.recipients, function(r){
+                if (!r.partner_id){
+                    r.checked = false;
+                }
+            })
+
+            // when call for suggested partners finished: re-render the widget
+            $.when(suggested_partners).pipe(function (additional_recipients) {
+                if ((!self.stay_open || (event && event.type == 'click')) && (!self.show_composer || !self.$('textarea:not(.oe_compact)').val().match(/\S+/) && !self.attachment_ids.length)) {
+                    self.show_composer = !self.show_composer || self.stay_open;
+                    self.reinit();
+                }
+                if (!self.stay_open && self.show_composer && (!event || event.type != 'blur')) {
+                    self.$('textarea:not(.oe_compact):first').focus();
+                }
+            });
+
+            return suggested_partners;
+        }
+    });
+    
+    instance.mail.Thread.include({
+        get_recipients_for_internal_message: function(ids, context){
+            var self = this;
+            self.result = {};
+            return new instance.web.Model(context.default_model).call(
+                'read', [ids, ['message_follower_ids', 'partner_id'], context]
+            ).then(function (thread) {
+                for (var i = 0; i < thread.length; i++) {
+                    var res_id = thread[i].id;
+                    var recipient_ids = thread[i].message_follower_ids;
+                    self.result[res_id] = [];
+
+                    // Add customer
+                    self.customer = thread[i].partner_id;
+                    if (self.customer && !recipient_ids.includes(self.customer[0])) {
+                        recipient_ids.splice(0, 0, self.customer[0]);
+                    }
+
+                    return new instance.web.Model('res.partner').call(
+                        'read', [recipient_ids, ['name', 'email', 'user_ids']]
+                    ).then(function (res_partners){
+                        for (var j = 0; j < res_partners.length; j++) {
+                            var partner = res_partners[j];
+                            if (!_.include(partner.user_ids, self.session.uid)){
+                                var reason = 'Follower';
+                                if (self.customer && partner.id == self.customer[0]){
+                                    reason = 'Partner';
+                                }
+                                self.result[res_id].push(
+                                    [partner.id, partner.name + '<' + partner.email + '>', reason]
+                                );
+                            }
+                        }
+                        return self.result;
+                    });
+                }
+                return self.result;
+            });
+        }
+    });
+};

mail_private/static/src/xml/mail_private.xml

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<template>
+    <t t-extend="mail.compose_message">
+		<t t-jquery="a[title='Send a message to all followers of the document']" t-operation="after">
+			<span class="oe_grey oe_sep_word">or</span><a class="oe_compose_post_private" t-if="!widget.options.compose_placeholder and !widget.options.view_mailbox" title="Send a message to specified recipients only">Send internal message</a>
+		</t>
+	</t>
+  <t t-extend="mail.thread.list_recipients">
+      <t t-jquery="[t-if='!widget.is_private']" t-operation="replace">
+            <t t-if="!widget.is_private and !widget.private">
+                <span class="oe_all_follower">
+                    <t t-if="widget.parent_thread.parent_message.record_name">
+                        Followers of <t t-raw="'&quot;' + widget.parent_thread.parent_message.record_name + '&quot;'"/>
+                    </t>
+                    <t t-if="!widget.parent_thread.parent_message.record_name and widget.options.view_inbox">My Followers</t>
+                    <t t-if="!widget.parent_thread.parent_message.record_name and !widget.options.view_inbox">Followers of this document</t>
+                </span>
+            </t>
+      </t>
+  </t>
+</template>

mail_private/template.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="utf-8"?>
+<openerp>
+    <data>
+        <template
+                id="assets_backend"
+                name="mail_private_assets_backend"
+                inherit_id="web.assets_backend">
+            <xpath expr="." position="inside">
+                <script
+                        type="text/javascript"
+                        src="/mail_private/static/src/js/mail_private.js"></script>
+            </xpath>
+        </template>
+    </data>
+</openerp>

mail_private/view.xml

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="utf-8"?>
+<openerp>
+    <data>
+        <record id="mail_private_email_compose_message_wizard_form" model="ir.ui.view">
+            <field name="name">mail.private.mail.compose.message.form</field>
+            <field name="model">mail.compose.message</field>
+            <field name="inherit_id" ref="mail.email_compose_message_wizard_form"/>
+            <field name="arch" type="xml">
+                <xpath expr="//div[@groups='base.group_user']" position="replace">
+                    <div groups="base.group_user" attrs="{'invisible': [('is_log', '=', True)]}">
+                        <field name="private" invisible="1"/>
+                        <!--<field name="private"/>-->
+                        <span attrs="{'invisible': [('composition_mode', '!=', 'mass_mail')]}">
+                            <strong>Email mass mailing</strong> on
+                            <span attrs="{'invisible': [('use_active_domain', '=', True)]}">the selected records</span>
+                            <span attrs="{'invisible': [('use_active_domain', '=', False)]}">the current search filter</span>.
+                        </span>
+                        <span attrs="{'invisible':['|', ('composition_mode', '!=', 'comment'), ('private', '=', True)]}">Followers of the document and</span>
+                        <field name="partner_ids" widget="many2many_tags_email" placeholder="Add contacts to notify..."
+                            context="{'force_email':True, 'show_email':True}"
+                            attrs="{'invisible': [('composition_mode', '!=', 'comment')]}"/>
+                    </div>
+                </xpath>
+            </field>
+        </record>
+    </data>
+</openerp>