diff --git a/web_notify/README.rst b/web_notify/README.rst new file mode 100644 index 00000000..243dc229 --- /dev/null +++ b/web_notify/README.rst @@ -0,0 +1,114 @@ +========== +Web Notify +========== + +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png + :target: https://odoo-community.org/page/development-status + :alt: Beta +.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html + :alt: License: AGPL-3 +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github + :target: https://github.com/OCA/web/tree/12.0/web_notify + :alt: OCA/web +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/web-12-0/web-12-0-web_notify + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/162/12.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + +Send instant notification messages to the user in live. + +This technical module allows you to send instant notification messages from the server to the user in live. +Two kinds of notification are supported. + +* Warning: Displayed in a red flying popup div +* Information: Displayed in a light yellow flying popup div + +**Table of contents** + +.. contents:: + :local: + +Installation +============ + +This module is based on the Instant Messaging Bus. To work properly, the server must be launched in gevent mode. + +Usage +===== + + +To send a notification to the user you just need to call one of the new methods defined on res.users: + +.. code-block:: python + + self.env.user.notify_info(message='My information message') + +or + +.. code-block:: python + + self.env.user.notify_warning(message='My marning message') + +.. figure:: static/description/notifications_screenshot.png + :scale: 80 % + :alt: Sample notifications + +You can test the behaviour of the notifications by installing this module in a demo database. + Click in your user logo in the top right corner of the screen then click "Preferences". + +.. figure:: static/description/test_notifications_demo.png + :scale: 80 % + :alt: Sample notifications + +Bug Tracker +=========== + +Bugs are tracked on `GitHub Issues `_. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +~~~~~~~ + +* ACSONE SA/NV +* AdaptiveCity + +Contributors +~~~~~~~~~~~~ + +* Laurent Mignon +* Serpent Consulting Services Pvt. Ltd. +* Aitor Bouzas + +Maintainers +~~~~~~~~~~~ + +This module is maintained by the OCA. + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use. + +This module is part of the `OCA/web `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/web_notify/__init__.py b/web_notify/__init__.py new file mode 100644 index 00000000..31660d6a --- /dev/null +++ b/web_notify/__init__.py @@ -0,0 +1,3 @@ +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +from . import models diff --git a/web_notify/__manifest__.py b/web_notify/__manifest__.py new file mode 100644 index 00000000..0643b87d --- /dev/null +++ b/web_notify/__manifest__.py @@ -0,0 +1,27 @@ +# Copyright 2016 ACSONE SA/NV +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +{ + 'name': 'Web Notify', + 'summary': """ + Send notification messages to user""", + 'version': '12.0.1.0.0', + 'description': 'Web Notify', + 'license': 'AGPL-3', + 'author': 'ACSONE SA/NV,' + 'AdaptiveCity,' + 'Odoo Community Association (OCA)', + 'website': 'https://github.com/OCA/web', + 'depends': [ + 'web', + 'bus', + 'base', + ], + 'data': [ + 'views/web_notify.xml' + ], + 'demo': [ + 'views/res_users_demo.xml' + ], + 'installable': True, +} diff --git a/web_notify/i18n/da.po b/web_notify/i18n/da.po new file mode 100644 index 00000000..c55bc857 --- /dev/null +++ b/web_notify/i18n/da.po @@ -0,0 +1,44 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * web_notify +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 11.0\n" +"Report-Msgid-Bugs-To: \n" +"PO-Revision-Date: 2018-09-02 05:11+0000\n" +"Last-Translator: Hans Henrik Gabelgaard \n" +"Language-Team: none\n" +"Language: da\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: nplurals=2; plural=n != 1;\n" +"X-Generator: Weblate 3.1.1\n" + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:26 +#, python-format +msgid "Information" +msgstr "" + +#. module: web_notify +#: model:ir.model.fields,field_description:web_notify.field_res_users_notify_info_channel_name +msgid "Notify Info Channel Name" +msgstr "" + +#. module: web_notify +#: model:ir.model.fields,field_description:web_notify.field_res_users_notify_warning_channel_name +msgid "Notify Warning Channel Name" +msgstr "" + +#. module: web_notify +#: model:ir.model,name:web_notify.model_res_users +msgid "Users" +msgstr "Brugere" + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:32 +#, python-format +msgid "Warning" +msgstr "Advarsel" diff --git a/web_notify/i18n/de.po b/web_notify/i18n/de.po new file mode 100644 index 00000000..4cbcc877 --- /dev/null +++ b/web_notify/i18n/de.po @@ -0,0 +1,48 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * web_notify +# +# Translators: +# Niki Waibel , 2017 +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 10.0\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2017-02-03 01:37+0000\n" +"PO-Revision-Date: 2017-02-03 01:37+0000\n" +"Last-Translator: Niki Waibel , 2017\n" +"Language-Team: German (https://www.transifex.com/oca/teams/23907/de/)\n" +"Language: de\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: nplurals=2; plural=(n != 1);\n" + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:26 +#, python-format +msgid "Information" +msgstr "Information" + +#. module: web_notify +#: model:ir.model.fields,field_description:web_notify.field_res_users_notify_info_channel_name +#, fuzzy +msgid "Notify Info Channel Name" +msgstr "Name des Informationen-Kanals" + +#. module: web_notify +#: model:ir.model.fields,field_description:web_notify.field_res_users_notify_warning_channel_name +#, fuzzy +msgid "Notify Warning Channel Name" +msgstr "Name des Warnungen-Kanals" + +#. module: web_notify +#: model:ir.model,name:web_notify.model_res_users +msgid "Users" +msgstr "Benutzer" + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:32 +#, python-format +msgid "Warning" +msgstr "Warnung" diff --git a/web_notify/i18n/es.po b/web_notify/i18n/es.po new file mode 100644 index 00000000..0775ce56 --- /dev/null +++ b/web_notify/i18n/es.po @@ -0,0 +1,48 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * web_notify +# +# Translators: +# Pedro M. Baeza , 2016 +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 10.0\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2016-12-23 02:13+0000\n" +"PO-Revision-Date: 2016-12-23 02:13+0000\n" +"Last-Translator: Pedro M. Baeza , 2016\n" +"Language-Team: Spanish (https://www.transifex.com/oca/teams/23907/es/)\n" +"Language: es\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: nplurals=2; plural=(n != 1);\n" + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:26 +#, python-format +msgid "Information" +msgstr "Información" + +#. module: web_notify +#: model:ir.model.fields,field_description:web_notify.field_res_users_notify_info_channel_name +#, fuzzy +msgid "Notify Info Channel Name" +msgstr "Nombre del canal de información notificada" + +#. module: web_notify +#: model:ir.model.fields,field_description:web_notify.field_res_users_notify_warning_channel_name +#, fuzzy +msgid "Notify Warning Channel Name" +msgstr "Nombre del canal de avisos notificados" + +#. module: web_notify +#: model:ir.model,name:web_notify.model_res_users +msgid "Users" +msgstr "Usuarios" + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:32 +#, python-format +msgid "Warning" +msgstr "Aviso" diff --git a/web_notify/i18n/hr.po b/web_notify/i18n/hr.po new file mode 100644 index 00000000..036b5550 --- /dev/null +++ b/web_notify/i18n/hr.po @@ -0,0 +1,49 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * web_notify +# +# Translators: +# Bole , 2017 +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 10.0\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2017-04-28 18:03+0000\n" +"PO-Revision-Date: 2017-04-28 18:03+0000\n" +"Last-Translator: Bole , 2017\n" +"Language-Team: Croatian (https://www.transifex.com/oca/teams/23907/hr/)\n" +"Language: hr\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: nplurals=3; plural=n%10==1 && n%100!=11 ? 0 : n%10>=2 && n" +"%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2;\n" + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:26 +#, python-format +msgid "Information" +msgstr "Informacija" + +#. module: web_notify +#: model:ir.model.fields,field_description:web_notify.field_res_users_notify_info_channel_name +#, fuzzy +msgid "Notify Info Channel Name" +msgstr "Naziv kanala informacija" + +#. module: web_notify +#: model:ir.model.fields,field_description:web_notify.field_res_users_notify_warning_channel_name +#, fuzzy +msgid "Notify Warning Channel Name" +msgstr "Naziv kanala upozorenja" + +#. module: web_notify +#: model:ir.model,name:web_notify.model_res_users +msgid "Users" +msgstr "Korisnici" + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:32 +#, python-format +msgid "Warning" +msgstr "Upozorenje" diff --git a/web_notify/i18n/nl_NL.po b/web_notify/i18n/nl_NL.po new file mode 100644 index 00000000..289ed1db --- /dev/null +++ b/web_notify/i18n/nl_NL.po @@ -0,0 +1,47 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * web_notify +# +# Translators: +# Peter Hageman , 2017 +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 10.0\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2017-07-13 16:07+0000\n" +"PO-Revision-Date: 2017-07-13 16:07+0000\n" +"Last-Translator: Peter Hageman , 2017\n" +"Language-Team: Dutch (Netherlands) (https://www.transifex.com/oca/" +"teams/23907/nl_NL/)\n" +"Language: nl_NL\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: nplurals=2; plural=(n != 1);\n" + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:26 +#, python-format +msgid "Information" +msgstr "Informatie" + +#. module: web_notify +#: model:ir.model.fields,field_description:web_notify.field_res_users_notify_info_channel_name +msgid "Notify Info Channel Name" +msgstr "" + +#. module: web_notify +#: model:ir.model.fields,field_description:web_notify.field_res_users_notify_warning_channel_name +msgid "Notify Warning Channel Name" +msgstr "" + +#. module: web_notify +#: model:ir.model,name:web_notify.model_res_users +msgid "Users" +msgstr "Gebruikers" + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:32 +#, python-format +msgid "Warning" +msgstr "Waarschuwing" diff --git a/web_notify/i18n/pt_BR.po b/web_notify/i18n/pt_BR.po new file mode 100644 index 00000000..ba699536 --- /dev/null +++ b/web_notify/i18n/pt_BR.po @@ -0,0 +1,48 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * web_notify +# +# Translators: +# Rodrigo de Almeida Sottomaior Macedo , 2017 +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 10.0\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2017-06-22 08:27+0000\n" +"PO-Revision-Date: 2018-08-03 13:18+0000\n" +"Last-Translator: Rodrigo Macedo \n" +"Language-Team: Portuguese (Brazil) (https://www.transifex.com/oca/teams/" +"23907/pt_BR/)\n" +"Language: pt_BR\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: nplurals=2; plural=n > 1;\n" +"X-Generator: Weblate 3.1.1\n" + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:26 +#, python-format +msgid "Information" +msgstr "Informação" + +#. module: web_notify +#: model:ir.model.fields,field_description:web_notify.field_res_users_notify_info_channel_name +msgid "Notify Info Channel Name" +msgstr "Notificar o nome do canal de informações" + +#. module: web_notify +#: model:ir.model.fields,field_description:web_notify.field_res_users_notify_warning_channel_name +msgid "Notify Warning Channel Name" +msgstr "Notificar o nome do canal de alerta" + +#. module: web_notify +#: model:ir.model,name:web_notify.model_res_users +msgid "Users" +msgstr "Usuários" + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:32 +#, python-format +msgid "Warning" +msgstr "Alerta" diff --git a/web_notify/i18n/web_notify.pot b/web_notify/i18n/web_notify.pot new file mode 100644 index 00000000..b951b00b --- /dev/null +++ b/web_notify/i18n/web_notify.pot @@ -0,0 +1,48 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * web_notify +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 11.0\n" +"Report-Msgid-Bugs-To: \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: web_notify +#: code:addons/web_notify/models/res_users.py:26 +#, python-format +msgid "Information" +msgstr "" + +#. module: web_notify +#: model:ir.model.fields,field_description:web_notify.field_res_users_notify_info_channel_name +msgid "Notify Info Channel Name" +msgstr "" + +#. module: web_notify +#: model:ir.model.fields,field_description:web_notify.field_res_users_notify_warning_channel_name +msgid "Notify Warning Channel Name" +msgstr "" + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:41 +#, python-format +msgid "Sending a notification to another user is forbidden." +msgstr "" + +#. module: web_notify +#: model:ir.model,name:web_notify.model_res_users +msgid "Users" +msgstr "" + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:32 +#, python-format +msgid "Warning" +msgstr "" + diff --git a/web_notify/models/__init__.py b/web_notify/models/__init__.py new file mode 100644 index 00000000..c39e40a1 --- /dev/null +++ b/web_notify/models/__init__.py @@ -0,0 +1,3 @@ +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +from . import res_users diff --git a/web_notify/models/res_users.py b/web_notify/models/res_users.py new file mode 100644 index 00000000..9e1f2f04 --- /dev/null +++ b/web_notify/models/res_users.py @@ -0,0 +1,46 @@ +# Copyright 2016 ACSONE SA/NV +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from odoo import api, exceptions, fields, models, _ + + +class ResUsers(models.Model): + _inherit = 'res.users' + + @api.depends('create_date') + def _compute_channel_names(self): + for record in self: + res_id = record.id + record.notify_info_channel_name = 'notify_info_%s' % res_id + record.notify_warning_channel_name = 'notify_warning_%s' % res_id + + notify_info_channel_name = fields.Char( + compute='_compute_channel_names') + notify_warning_channel_name = fields.Char( + compute='_compute_channel_names') + + def notify_info(self, message="Default message", title=None, sticky=False): + title = title or _('Information') + self._notify_channel( + 'notify_info_channel_name', message, title, sticky) + + def notify_warning(self, message="Default message", + title=None, sticky=False): + title = title or _('Warning') + self._notify_channel( + 'notify_warning_channel_name', message, title, sticky) + + def _notify_channel(self, channel_name_field, message, title, sticky): + if (not self.env.user._is_admin() + and any(user.id != self.env.uid for user in self)): + raise exceptions.UserError( + _('Sending a notification to another user is forbidden.') + ) + bus_message = { + 'message': message, + 'title': title, + 'sticky': sticky + } + notifications = [(record[channel_name_field], bus_message) + for record in self] + self.env['bus.bus'].sendmany(notifications) diff --git a/web_notify/readme/CONTRIBUTORS.rst b/web_notify/readme/CONTRIBUTORS.rst new file mode 100644 index 00000000..70f99b04 --- /dev/null +++ b/web_notify/readme/CONTRIBUTORS.rst @@ -0,0 +1,3 @@ +* Laurent Mignon +* Serpent Consulting Services Pvt. Ltd. +* Aitor Bouzas \ No newline at end of file diff --git a/web_notify/readme/DESCRIPTION.rst b/web_notify/readme/DESCRIPTION.rst new file mode 100644 index 00000000..7d7528a3 --- /dev/null +++ b/web_notify/readme/DESCRIPTION.rst @@ -0,0 +1,7 @@ +Send instant notification messages to the user in live. + +This technical module allows you to send instant notification messages from the server to the user in live. +Two kinds of notification are supported. + +* Warning: Displayed in a red flying popup div +* Information: Displayed in a light yellow flying popup div \ No newline at end of file diff --git a/web_notify/readme/INSTALL.rst b/web_notify/readme/INSTALL.rst new file mode 100644 index 00000000..a27ef894 --- /dev/null +++ b/web_notify/readme/INSTALL.rst @@ -0,0 +1 @@ +This module is based on the Instant Messaging Bus. To work properly, the server must be launched in gevent mode. \ No newline at end of file diff --git a/web_notify/readme/USAGE.rst b/web_notify/readme/USAGE.rst new file mode 100644 index 00000000..3570a486 --- /dev/null +++ b/web_notify/readme/USAGE.rst @@ -0,0 +1,23 @@ + +To send a notification to the user you just need to call one of the new methods defined on res.users: + +.. code-block:: python + + self.env.user.notify_info(message='My information message') + +or + +.. code-block:: python + + self.env.user.notify_warning(message='My marning message') + +.. figure:: static/description/notifications_screenshot.png + :scale: 80 % + :alt: Sample notifications + +You can test the behaviour of the notifications by installing this module in a demo database. + Click in your user logo in the top right corner of the screen then click "Preferences". + +.. figure:: static/description/test_notifications_demo.png + :scale: 80 % + :alt: Sample notifications diff --git a/web_notify/static/description/icon.png b/web_notify/static/description/icon.png new file mode 100644 index 00000000..3a0328b5 Binary files /dev/null and b/web_notify/static/description/icon.png differ diff --git a/web_notify/static/description/index.html b/web_notify/static/description/index.html new file mode 100644 index 00000000..26f951bd --- /dev/null +++ b/web_notify/static/description/index.html @@ -0,0 +1,455 @@ + + + + + + +Web Notify + + + +
+

Web Notify

+ + +

Beta License: AGPL-3 OCA/web Translate me on Weblate Try me on Runbot

+

Send instant notification messages to the user in live.

+

This technical module allows you to send instant notification messages from the server to the user in live. +Two kinds of notification are supported.

+
    +
  • Warning: Displayed in a red flying popup div
  • +
  • Information: Displayed in a light yellow flying popup div
  • +
+

Table of contents

+ +
+

Installation

+

This module is based on the Instant Messaging Bus. To work properly, the server must be launched in gevent mode.

+
+
+

Usage

+

To send a notification to the user you just need to call one of the new methods defined on res.users:

+
+self.env.user.notify_info(message='My information message')
+
+

or

+
+self.env.user.notify_warning(message='My marning message')
+
+
+Sample notifications +
+
+
You can test the behaviour of the notifications by installing this module in a demo database.
+
Click in your user logo in the top right corner of the screen then click “Preferences”.
+
+
+Sample notifications +
+
+
+

Bug Tracker

+

Bugs are tracked on GitHub Issues. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed +feedback.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • ACSONE SA/NV
  • +
  • AdaptiveCity
  • +
+
+
+

Contributors

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+Odoo Community Association +

OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use.

+

This module is part of the OCA/web project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ + diff --git a/web_notify/static/description/notifications_screenshot.png b/web_notify/static/description/notifications_screenshot.png new file mode 100644 index 00000000..1a1062cd Binary files /dev/null and b/web_notify/static/description/notifications_screenshot.png differ diff --git a/web_notify/static/description/test_notifications_demo.png b/web_notify/static/description/test_notifications_demo.png new file mode 100644 index 00000000..fb2e4c3c Binary files /dev/null and b/web_notify/static/description/test_notifications_demo.png differ diff --git a/web_notify/static/src/js/web_client.js b/web_notify/static/src/js/web_client.js new file mode 100644 index 00000000..c9b0139f --- /dev/null +++ b/web_notify/static/src/js/web_client.js @@ -0,0 +1,44 @@ +odoo.define('web_notify.WebClient', function (require) { +"use strict"; + +var WebClient = require('web.WebClient'); +var base_bus = require('bus.Longpolling'); +var session = require('web.session'); +require('bus.BusService'); + + +WebClient.include({ + show_application: function() { + var res = this._super(); + this.start_polling(); + return res + }, + start_polling: function() { + this.channel_warning = 'notify_warning_' + session.uid; + this.channel_info = 'notify_info_' + session.uid; + this.call('bus_service', 'addChannel', this.channel_warning); + this.call('bus_service', 'addChannel', this.channel_info); + this.call('bus_service', 'on', 'notification', this, this.bus_notification); + this.call('bus_service', 'startPolling'); + }, + bus_notification: function(notifications) { + var self = this; + _.each(notifications, function (notification) { + var channel = notification[0]; + var message = notification[1]; + if (channel === self.channel_warning) { + self.on_message_warning(message); + } else if (channel === self.channel_info) { + self.on_message_info(message); + } + }); + }, + on_message_warning: function(message){ + this.do_warn(message.title, message.message, message.sticky); + }, + on_message_info: function(message){ + this.do_notify(message.title, message.message, message.sticky); + } +}); + +}); diff --git a/web_notify/tests/__init__.py b/web_notify/tests/__init__.py new file mode 100644 index 00000000..f759b968 --- /dev/null +++ b/web_notify/tests/__init__.py @@ -0,0 +1,3 @@ +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +from . import test_res_users diff --git a/web_notify/tests/test_res_users.py b/web_notify/tests/test_res_users.py new file mode 100644 index 00000000..80a1a937 --- /dev/null +++ b/web_notify/tests/test_res_users.py @@ -0,0 +1,68 @@ +# Copyright 2016 ACSONE SA/NV +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from odoo import exceptions +from odoo.tests import common +from odoo.addons.bus.models.bus import json_dump +import json +import mock + + +class TestResUsers(common.TransactionCase): + + def test_notify_info(self): + bus_bus = self.env['bus.bus'] + domain = [ + ('channel', '=', + json_dump(self.env.user.notify_info_channel_name)) + ] + existing = bus_bus.search(domain) + test_msg = {'message': 'message', 'title': 'title', 'sticky': True} + self.env.user.notify_info(**test_msg) + news = bus_bus.search(domain) - existing + self.assertEqual(1, len(news)) + self.assertEqual(test_msg, json.loads(news.message)) + + def test_notify_warning(self): + bus_bus = self.env['bus.bus'] + domain = [ + ('channel', '=', + json_dump(self.env.user.notify_warning_channel_name)) + ] + existing = bus_bus.search(domain) + test_msg = {'message': 'message', 'title': 'title', 'sticky': True} + self.env.user.notify_warning(**test_msg) + news = bus_bus.search(domain) - existing + self.assertEqual(1, len(news)) + self.assertEqual(test_msg, json.loads(news.message)) + + def test_notify_many(self): + # check that the notification of a list of users is done with + # a single call to the bus + with mock.patch('odoo.addons.bus.models.bus.ImBus.sendmany' + ) as mockedSendMany: + users = self.env.user.search([(1, "=", 1)]) + self.assertTrue(len(users) > 1) + users.notify_warning(message='message') + + self.assertEqual(1, mockedSendMany.call_count) + + # call_args is a tuple with args (tuple) & kwargs (dict). We check + # positional arguments (args), hence the [0]. + pos_call_args = mockedSendMany.call_args[0] + + # Ensure the first positional argument is a list with as many + # elements as we had users. + first_pos_call_args = pos_call_args[0] + self.assertIsInstance(first_pos_call_args, list) + self.assertEqual(len(users), len(first_pos_call_args)) + + def test_notify_other_user(self): + other_user = self.env.ref('base.user_demo') + other_user_model = self.env['res.users'].sudo(other_user) + with self.assertRaises(exceptions.UserError): + other_user_model.browse(self.env.uid).notify_info(message='hello') + + def test_notify_admin_allowed_other_user(self): + other_user = self.env.ref('base.user_demo') + other_user.notify_info(message='hello') diff --git a/web_notify/views/res_users_demo.xml b/web_notify/views/res_users_demo.xml new file mode 100644 index 00000000..4ca9f422 --- /dev/null +++ b/web_notify/views/res_users_demo.xml @@ -0,0 +1,30 @@ + + + + + res.users.form.simple.view.modif.inherit + res.users + + + + + + +