diff --git a/setup/web_notify/odoo/addons/web_notify b/setup/web_notify/odoo/addons/web_notify new file mode 120000 index 000000000..f778fe739 --- /dev/null +++ b/setup/web_notify/odoo/addons/web_notify @@ -0,0 +1 @@ +../../../../web_notify \ No newline at end of file diff --git a/setup/web_notify/setup.py b/setup/web_notify/setup.py new file mode 100644 index 000000000..28c57bb64 --- /dev/null +++ b/setup/web_notify/setup.py @@ -0,0 +1,6 @@ +import setuptools + +setuptools.setup( + setup_requires=['setuptools-odoo'], + odoo_addon=True, +) diff --git a/web_notify/README.rst b/web_notify/README.rst new file mode 100644 index 000000000..e0e875fb3 --- /dev/null +++ b/web_notify/README.rst @@ -0,0 +1,140 @@ +========== +Web Notify +========== + +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Production%2FStable-green.png + :target: https://odoo-community.org/page/development-status + :alt: Production/Stable +.. |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/15.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-15-0/web-15-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/15.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. + +* Success: Displayed in a `success` theme color flying popup div +* Danger: Displayed in a `danger` theme color flying popup div +* Warning: Displayed in a `warning` theme color flying popup div +* Information: Displayed in a `info` theme color flying popup div +* Default: Displayed in a `default` theme color 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_success(message='My success message') + +or + +.. code-block:: python + + self.env.user.notify_danger(message='My danger message') + +or + +.. code-block:: python + + self.env.user.notify_warning(message='My warning message') + +or + +.. code-block:: python + + self.env.user.notify_info(message='My information message') + +or + +.. code-block:: python + + self.env.user.notify_default(message='My default message') + +.. figure:: https://raw.githubusercontent.com/OCA/web/15.0/web_notify/static/description/notifications_screenshot.gif + :scale: 80 % + :alt: Sample notifications + +You can test the behaviour of the notifications by installing this module in a demo database. +Access the users form through Settings -> Users & Companies. You'll see a tab called "Test web notify", here you'll find two buttons that'll allow you test the module. + +.. figure:: https://raw.githubusercontent.com/OCA/web/15.0/web_notify/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 +* Shepilov Vladislav +* Kevin Khao +* `Tecnativa `_: + + * David Vidal + +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 000000000..3379be95a --- /dev/null +++ b/web_notify/__init__.py @@ -0,0 +1,4 @@ +# pylint: disable=missing-docstring +# 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 000000000..87b21d879 --- /dev/null +++ b/web_notify/__manifest__.py @@ -0,0 +1,22 @@ +# pylint: disable=missing-docstring +# 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": "15.0.1.0.0", + "license": "AGPL-3", + "author": "ACSONE SA/NV," "AdaptiveCity," "Odoo Community Association (OCA)", + "development_status": "Production/Stable", + "website": "https://github.com/OCA/web", + "depends": ["web", "bus", "base", "mail"], + "assets": { + "web.assets_backend": [ + "web_notify/static/src/js/services/*.js", + ] + }, + "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 000000000..a5751dc39 --- /dev/null +++ b/web_notify/i18n/da.po @@ -0,0 +1,113 @@ +# 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:0 +#, python-format +msgid "Danger" +msgstr "" + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:0 +#, python-format +msgid "Default" +msgstr "" + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:0 +#, python-format +msgid "Information" +msgstr "" + +#. module: web_notify +#: model:ir.model.fields,field_description:web_notify.field_res_users__notify_danger_channel_name +msgid "Notify Danger Channel Name" +msgstr "" + +#. module: web_notify +#: model:ir.model.fields,field_description:web_notify.field_res_users__notify_default_channel_name +msgid "Notify Default Channel Name" +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_success_channel_name +msgid "Notify Success 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:0 +#, python-format +msgid "Sending a notification to another user is forbidden." +msgstr "" + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:0 +#, python-format +msgid "Success" +msgstr "" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test danger notification" +msgstr "" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test default notification" +msgstr "" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test info notification" +msgstr "" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test success notification" +msgstr "" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test warning notification" +msgstr "" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test web notify" +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:0 +#, 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 000000000..2b6c697f1 --- /dev/null +++ b/web_notify/i18n/de.po @@ -0,0 +1,116 @@ +# 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: 2020-07-22 12:19+0000\n" +"Last-Translator: c2cdidier \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" +"X-Generator: Weblate 3.10\n" + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:0 +#, python-format +msgid "Danger" +msgstr "Gefahr" + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:0 +#, python-format +msgid "Default" +msgstr "Standard" + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:0 +#, python-format +msgid "Information" +msgstr "Information" + +#. module: web_notify +#: model:ir.model.fields,field_description:web_notify.field_res_users__notify_danger_channel_name +msgid "Notify Danger Channel Name" +msgstr "Name Gefahrenkanal Benachritigung" + +#. module: web_notify +#: model:ir.model.fields,field_description:web_notify.field_res_users__notify_default_channel_name +msgid "Notify Default Channel Name" +msgstr "Name Standardkanal Benachritigung" + +#. module: web_notify +#: model:ir.model.fields,field_description:web_notify.field_res_users__notify_info_channel_name +msgid "Notify Info Channel Name" +msgstr "Name Informationskanal Benachritigung" + +#. module: web_notify +#: model:ir.model.fields,field_description:web_notify.field_res_users__notify_success_channel_name +msgid "Notify Success Channel Name" +msgstr "Name Erfolgskanal Benachrichtigung" + +#. module: web_notify +#: model:ir.model.fields,field_description:web_notify.field_res_users__notify_warning_channel_name +msgid "Notify Warning Channel Name" +msgstr "Name Warnungskanal Benachritigung" + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:0 +#, python-format +msgid "Sending a notification to another user is forbidden." +msgstr "Es ist verboten eine Nachricht an einem anderen Benutzer zu senden." + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:0 +#, python-format +msgid "Success" +msgstr "Erfolg" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test danger notification" +msgstr "Test Gefahrenmeldung" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test default notification" +msgstr "Standardbenachrichtigung testen" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test info notification" +msgstr "Test Info Benachrichtigung" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test success notification" +msgstr "Test Erfolgsbenarichtigung" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test warning notification" +msgstr "Test Warnungsbenachritigung" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test web notify" +msgstr "Test Webbenachrichtigung" + +#. 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:0 +#, 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 000000000..b895cdd33 --- /dev/null +++ b/web_notify/i18n/es.po @@ -0,0 +1,120 @@ +# 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:0 +#, python-format +msgid "Danger" +msgstr "" + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:0 +#, python-format +msgid "Default" +msgstr "" + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:0 +#, python-format +msgid "Information" +msgstr "Información" + +#. module: web_notify +#: model:ir.model.fields,field_description:web_notify.field_res_users__notify_danger_channel_name +#, fuzzy +msgid "Notify Danger Channel Name" +msgstr "Nombre del canal de avisos notificados" + +#. module: web_notify +#: model:ir.model.fields,field_description:web_notify.field_res_users__notify_default_channel_name +#, fuzzy +msgid "Notify Default 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_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_success_channel_name +#, fuzzy +msgid "Notify Success 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 +#: code:addons/web_notify/models/res_users.py:0 +#, python-format +msgid "Sending a notification to another user is forbidden." +msgstr "" + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:0 +#, python-format +msgid "Success" +msgstr "" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test danger notification" +msgstr "" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test default notification" +msgstr "" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test info notification" +msgstr "" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test success notification" +msgstr "" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test warning notification" +msgstr "" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test web notify" +msgstr "" + +#. 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:0 +#, 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 000000000..4fdd5f700 --- /dev/null +++ b/web_notify/i18n/hr.po @@ -0,0 +1,121 @@ +# 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:0 +#, python-format +msgid "Danger" +msgstr "" + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:0 +#, python-format +msgid "Default" +msgstr "" + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:0 +#, python-format +msgid "Information" +msgstr "Informacija" + +#. module: web_notify +#: model:ir.model.fields,field_description:web_notify.field_res_users__notify_danger_channel_name +#, fuzzy +msgid "Notify Danger Channel Name" +msgstr "Naziv kanala upozorenja" + +#. module: web_notify +#: model:ir.model.fields,field_description:web_notify.field_res_users__notify_default_channel_name +#, fuzzy +msgid "Notify Default Channel Name" +msgstr "Naziv kanala 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_success_channel_name +#, fuzzy +msgid "Notify Success 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 +#: code:addons/web_notify/models/res_users.py:0 +#, python-format +msgid "Sending a notification to another user is forbidden." +msgstr "" + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:0 +#, python-format +msgid "Success" +msgstr "" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test danger notification" +msgstr "" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test default notification" +msgstr "" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test info notification" +msgstr "" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test success notification" +msgstr "" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test warning notification" +msgstr "" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test web notify" +msgstr "" + +#. 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:0 +#, python-format +msgid "Warning" +msgstr "Upozorenje" diff --git a/web_notify/i18n/nl.po b/web_notify/i18n/nl.po new file mode 100644 index 000000000..ddc2ea005 --- /dev/null +++ b/web_notify/i18n/nl.po @@ -0,0 +1,128 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * web_notify +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 14.0\n" +"Report-Msgid-Bugs-To: \n" +"PO-Revision-Date: 2021-05-17 20:47+0000\n" +"Last-Translator: Bosd \n" +"Language-Team: none\n" +"Language: 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" +"X-Generator: Weblate 4.3.2\n" + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:0 +#, python-format +msgid "Danger" +msgstr "Gevaar" + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:0 +#, python-format +msgid "Default" +msgstr "Standaard" + +#. module: web_notify +#: model:ir.model.fields,field_description:web_notify.field_res_users__display_name +msgid "Display Name" +msgstr "Weergavenaam" + +#. module: web_notify +#: model:ir.model.fields,field_description:web_notify.field_res_users__id +msgid "ID" +msgstr "ID" + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:0 +#, python-format +msgid "Information" +msgstr "Informatie" + +#. module: web_notify +#: model:ir.model.fields,field_description:web_notify.field_res_users____last_update +msgid "Last Modified on" +msgstr "Laatst Gewijzigd op" + +#. module: web_notify +#: model:ir.model.fields,field_description:web_notify.field_res_users__notify_danger_channel_name +msgid "Notify Danger Channel Name" +msgstr "" + +#. module: web_notify +#: model:ir.model.fields,field_description:web_notify.field_res_users__notify_default_channel_name +msgid "Notify Default Channel Name" +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_success_channel_name +msgid "Notify Success 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:0 +#, python-format +msgid "Sending a notification to another user is forbidden." +msgstr "" + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:0 +#, python-format +msgid "Success" +msgstr "Success" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test danger notification" +msgstr "" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test default notification" +msgstr "" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test info notification" +msgstr "" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test success notification" +msgstr "" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test warning notification" +msgstr "" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test web notify" +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:0 +#, python-format +msgid "Warning" +msgstr "Waarschuwing" diff --git a/web_notify/i18n/nl_NL.po b/web_notify/i18n/nl_NL.po new file mode 100644 index 000000000..14d9972d4 --- /dev/null +++ b/web_notify/i18n/nl_NL.po @@ -0,0 +1,116 @@ +# 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:0 +#, python-format +msgid "Danger" +msgstr "" + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:0 +#, python-format +msgid "Default" +msgstr "" + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:0 +#, python-format +msgid "Information" +msgstr "Informatie" + +#. module: web_notify +#: model:ir.model.fields,field_description:web_notify.field_res_users__notify_danger_channel_name +msgid "Notify Danger Channel Name" +msgstr "" + +#. module: web_notify +#: model:ir.model.fields,field_description:web_notify.field_res_users__notify_default_channel_name +msgid "Notify Default Channel Name" +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_success_channel_name +msgid "Notify Success 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:0 +#, python-format +msgid "Sending a notification to another user is forbidden." +msgstr "" + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:0 +#, python-format +msgid "Success" +msgstr "" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test danger notification" +msgstr "" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test default notification" +msgstr "" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test info notification" +msgstr "" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test success notification" +msgstr "" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test warning notification" +msgstr "" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test web notify" +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:0 +#, 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 000000000..d29f95267 --- /dev/null +++ b/web_notify/i18n/pt_BR.po @@ -0,0 +1,117 @@ +# 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: 2019-08-30 15:23+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.8\n" + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:0 +#, python-format +msgid "Danger" +msgstr "Perigo" + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:0 +#, python-format +msgid "Default" +msgstr "Padrão" + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:0 +#, python-format +msgid "Information" +msgstr "Informação" + +#. module: web_notify +#: model:ir.model.fields,field_description:web_notify.field_res_users__notify_danger_channel_name +msgid "Notify Danger Channel Name" +msgstr "Notificar o nome do canal de perigo" + +#. module: web_notify +#: model:ir.model.fields,field_description:web_notify.field_res_users__notify_default_channel_name +msgid "Notify Default Channel Name" +msgstr "Notificar o nome do canal padrã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_success_channel_name +msgid "Notify Success Channel Name" +msgstr "Notificar o nome do canal de sucesso" + +#. 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 +#: code:addons/web_notify/models/res_users.py:0 +#, python-format +msgid "Sending a notification to another user is forbidden." +msgstr "É proibido enviar uma notificação para outro usuário." + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:0 +#, python-format +msgid "Success" +msgstr "Sucesso" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test danger notification" +msgstr "Notificação de teste de perigo" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test default notification" +msgstr "Notificação de Teste padrão" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test info notification" +msgstr "Notificação de Teste informativo" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test success notification" +msgstr "Notificação de Teste de sucesso" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test warning notification" +msgstr "Notificação de Teste de alerta" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test web notify" +msgstr "Notificação de Web Teste" + +#. 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:0 +#, 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 000000000..b81562063 --- /dev/null +++ b/web_notify/i18n/web_notify.pot @@ -0,0 +1,125 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * web_notify +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 14.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:0 +#, python-format +msgid "Danger" +msgstr "" + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:0 +#, python-format +msgid "Default" +msgstr "" + +#. module: web_notify +#: model:ir.model.fields,field_description:web_notify.field_res_users__display_name +msgid "Display Name" +msgstr "" + +#. module: web_notify +#: model:ir.model.fields,field_description:web_notify.field_res_users__id +msgid "ID" +msgstr "" + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:0 +#, python-format +msgid "Information" +msgstr "" + +#. module: web_notify +#: model:ir.model.fields,field_description:web_notify.field_res_users____last_update +msgid "Last Modified on" +msgstr "" + +#. module: web_notify +#: model:ir.model.fields,field_description:web_notify.field_res_users__notify_danger_channel_name +msgid "Notify Danger Channel Name" +msgstr "" + +#. module: web_notify +#: model:ir.model.fields,field_description:web_notify.field_res_users__notify_default_channel_name +msgid "Notify Default Channel Name" +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_success_channel_name +msgid "Notify Success 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:0 +#, python-format +msgid "Sending a notification to another user is forbidden." +msgstr "" + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:0 +#, python-format +msgid "Success" +msgstr "" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test danger notification" +msgstr "" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test default notification" +msgstr "" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test info notification" +msgstr "" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test success notification" +msgstr "" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test warning notification" +msgstr "" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test web notify" +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:0 +#, python-format +msgid "Warning" +msgstr "" diff --git a/web_notify/i18n/zh_CN.po b/web_notify/i18n/zh_CN.po new file mode 100644 index 000000000..9c0d991a3 --- /dev/null +++ b/web_notify/i18n/zh_CN.po @@ -0,0 +1,113 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * web_notify +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 12.0\n" +"Report-Msgid-Bugs-To: \n" +"PO-Revision-Date: 2019-09-01 12:52+0000\n" +"Last-Translator: 黎伟杰 <674416404@qq.com>\n" +"Language-Team: none\n" +"Language: zh_CN\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: nplurals=1; plural=0;\n" +"X-Generator: Weblate 3.8\n" + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:0 +#, python-format +msgid "Danger" +msgstr "危险" + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:0 +#, python-format +msgid "Default" +msgstr "默认" + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:0 +#, python-format +msgid "Information" +msgstr "信息" + +#. module: web_notify +#: model:ir.model.fields,field_description:web_notify.field_res_users__notify_danger_channel_name +msgid "Notify Danger Channel Name" +msgstr "通知危险频道名称" + +#. module: web_notify +#: model:ir.model.fields,field_description:web_notify.field_res_users__notify_default_channel_name +msgid "Notify Default Channel Name" +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_success_channel_name +msgid "Notify Success 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:0 +#, python-format +msgid "Sending a notification to another user is forbidden." +msgstr "禁止向其他用户发送通知。" + +#. module: web_notify +#: code:addons/web_notify/models/res_users.py:0 +#, python-format +msgid "Success" +msgstr "成功" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test danger notification" +msgstr "测试危险通知" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test default notification" +msgstr "测试默认通知" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test info notification" +msgstr "测试信息通知" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test success notification" +msgstr "测试成功通知" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test warning notification" +msgstr "测试警告通知" + +#. module: web_notify +#: model_terms:ir.ui.view,arch_db:web_notify.view_users_form_simple_modif_inherit +msgid "Test web notify" +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:0 +#, python-format +msgid "Warning" +msgstr "警告" diff --git a/web_notify/models/__init__.py b/web_notify/models/__init__.py new file mode 100644 index 000000000..883516533 --- /dev/null +++ b/web_notify/models/__init__.py @@ -0,0 +1 @@ +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 000000000..1cb7b5d66 --- /dev/null +++ b/web_notify/models/res_users.py @@ -0,0 +1,98 @@ +# Copyright 2016 ACSONE SA/NV +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). +from odoo import _, api, exceptions, fields, models + +from odoo.addons.bus.models.bus import channel_with_db, json_dump + +DEFAULT_MESSAGE = "Default message" + +SUCCESS = "success" +DANGER = "danger" +WARNING = "warning" +INFO = "info" +DEFAULT = "default" + + +class ResUsers(models.Model): + _inherit = "res.users" + + @api.depends("create_date") + def _compute_channel_names(self): + for record in self: + record.notify_success_channel_name = json_dump( + channel_with_db(self.env.cr.dbname, record.partner_id) + ) + record.notify_danger_channel_name = json_dump( + channel_with_db(self.env.cr.dbname, record.partner_id) + ) + record.notify_warning_channel_name = json_dump( + channel_with_db(self.env.cr.dbname, record.partner_id) + ) + record.notify_info_channel_name = json_dump( + channel_with_db(self.env.cr.dbname, record.partner_id) + ) + record.notify_default_channel_name = json_dump( + channel_with_db(self.env.cr.dbname, record.partner_id) + ) + + notify_success_channel_name = fields.Char(compute="_compute_channel_names") + notify_danger_channel_name = fields.Char(compute="_compute_channel_names") + notify_warning_channel_name = fields.Char(compute="_compute_channel_names") + notify_info_channel_name = fields.Char(compute="_compute_channel_names") + notify_default_channel_name = fields.Char(compute="_compute_channel_names") + + def notify_success( + self, message="Default message", title=None, sticky=False, target=None + ): + title = title or _("Success") + self._notify_channel(SUCCESS, message, title, sticky, target) + + def notify_danger( + self, message="Default message", title=None, sticky=False, target=None + ): + title = title or _("Danger") + self._notify_channel(DANGER, message, title, sticky, target) + + def notify_warning( + self, message="Default message", title=None, sticky=False, target=None + ): + title = title or _("Warning") + self._notify_channel(WARNING, message, title, sticky, target) + + def notify_info( + self, message="Default message", title=None, sticky=False, target=None + ): + title = title or _("Information") + self._notify_channel(INFO, message, title, sticky, target) + + def notify_default( + self, message="Default message", title=None, sticky=False, target=None + ): + title = title or _("Default") + self._notify_channel(DEFAULT, message, title, sticky, target) + + def _notify_channel( + self, + type_message=DEFAULT, + message=DEFAULT_MESSAGE, + title=None, + sticky=False, + target=None, + ): + 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.") + ) + if not target: + target = self.env.user.partner_id + bus_message = { + "type": type_message, + "message": message, + "title": title, + "sticky": sticky, + } + + notifications = [[partner, "web.notify", [bus_message]] for partner in target] + 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 000000000..77bb03c5e --- /dev/null +++ b/web_notify/readme/CONTRIBUTORS.rst @@ -0,0 +1,8 @@ +* Laurent Mignon +* Serpent Consulting Services Pvt. Ltd. +* Aitor Bouzas +* Shepilov Vladislav +* Kevin Khao +* `Tecnativa `_: + + * David Vidal diff --git a/web_notify/readme/DESCRIPTION.rst b/web_notify/readme/DESCRIPTION.rst new file mode 100644 index 000000000..2cd897801 --- /dev/null +++ b/web_notify/readme/DESCRIPTION.rst @@ -0,0 +1,10 @@ +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. + +* Success: Displayed in a `success` theme color flying popup div +* Danger: Displayed in a `danger` theme color flying popup div +* Warning: Displayed in a `warning` theme color flying popup div +* Information: Displayed in a `info` theme color flying popup div +* Default: Displayed in a `default` theme color flying popup div diff --git a/web_notify/readme/INSTALL.rst b/web_notify/readme/INSTALL.rst new file mode 100644 index 000000000..b47aebb79 --- /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. diff --git a/web_notify/readme/USAGE.rst b/web_notify/readme/USAGE.rst new file mode 100644 index 000000000..f31a5341f --- /dev/null +++ b/web_notify/readme/USAGE.rst @@ -0,0 +1,41 @@ + +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_success(message='My success message') + +or + +.. code-block:: python + + self.env.user.notify_danger(message='My danger message') + +or + +.. code-block:: python + + self.env.user.notify_warning(message='My warning message') + +or + +.. code-block:: python + + self.env.user.notify_info(message='My information message') + +or + +.. code-block:: python + + self.env.user.notify_default(message='My default message') + +.. figure:: static/description/notifications_screenshot.gif + :scale: 80 % + :alt: Sample notifications + +You can test the behaviour of the notifications by installing this module in a demo database. +Access the users form through Settings -> Users & Companies. You'll see a tab called "Test web notify", here you'll find two buttons that'll allow you test the module. + +.. 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 000000000..3e7d0bd7e 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 000000000..2add67c8a --- /dev/null +++ b/web_notify/static/description/index.html @@ -0,0 +1,474 @@ + + + + + + +Web Notify + + + +
+

Web Notify

+ + +

Production/Stable 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.

+
    +
  • Success: Displayed in a success theme color flying popup div
    • +
  • Danger: Displayed in a danger theme color flying popup div
    • +
  • Warning: Displayed in a warning theme color flying popup div
    • +
  • Information: Displayed in a info theme color flying popup div
    • +
  • Default: Displayed in a default theme color 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_success(message='My success message')
+
+

or

+
+self.env.user.notify_danger(message='My danger message')
+
+

or

+
+self.env.user.notify_warning(message='My warning message')
+
+

or

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

or

+
+self.env.user.notify_default(message='My default message')
+
+
+Sample notifications +
+

You can test the behaviour of the notifications by installing this module in a demo database. +Access the users form through Settings -> Users & Companies. You’ll see a tab called “Test web notify”, here you’ll find two buttons that’ll allow you test the module.

+
+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.gif b/web_notify/static/description/notifications_screenshot.gif new file mode 100644 index 000000000..c82aa3e7e Binary files /dev/null and b/web_notify/static/description/notifications_screenshot.gif 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 000000000..9047fba01 Binary files /dev/null and b/web_notify/static/description/test_notifications_demo.png differ diff --git a/web_notify/static/src/js/services/notification.esm.js b/web_notify/static/src/js/services/notification.esm.js new file mode 100644 index 000000000..489faddd3 --- /dev/null +++ b/web_notify/static/src/js/services/notification.esm.js @@ -0,0 +1,12 @@ +/** @odoo-module */ +import {Notification} from "@web/core/notifications/notification"; +import {patch} from "web.utils"; + +patch(Notification.props, "webNotifyProps", { + type: { + type: String, + optional: true, + validate: (t) => + ["warning", "danger", "success", "info", "default"].includes(t), + }, +}); diff --git a/web_notify/static/src/js/services/notification_services.esm.js b/web_notify/static/src/js/services/notification_services.esm.js new file mode 100644 index 000000000..65a0d3276 --- /dev/null +++ b/web_notify/static/src/js/services/notification_services.esm.js @@ -0,0 +1,45 @@ +/** @odoo-module **/ +import {browser} from "@web/core/browser/browser"; +import {registry} from "@web/core/registry"; + +export const webNotificationService = { + dependencies: ["notification"], + + start(env, {notification}) { + let webNotifTimeouts = {}; + /** + * Displays the web notification on user's screen + */ + + function displaywebNotification(notifications) { + Object.values(webNotifTimeouts).forEach((notif) => + browser.clearTimeout(notif) + ); + webNotifTimeouts = {}; + + notifications.forEach(function (notif) { + browser.setTimeout(function () { + notification.add(notif.message, { + title: notif.title, + type: notif.type, + sticky: notif.sticky, + className: notif.className, + }); + }); + }); + } + env.bus.on("WEB_CLIENT_READY", null, async () => { + const legacyEnv = owl.Component.env; + legacyEnv.services.bus_service.onNotification(this, (notifications) => { + for (const {payload, type} of notifications) { + if (type === "web.notify") { + displaywebNotification(payload); + } + } + }); + legacyEnv.services.bus_service.startPolling(); + }); + }, +}; + +registry.category("services").add("webNotification", webNotificationService); diff --git a/web_notify/tests/__init__.py b/web_notify/tests/__init__.py new file mode 100644 index 000000000..f759b968b --- /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 000000000..6f3f34493 --- /dev/null +++ b/web_notify/tests/test_res_users.py @@ -0,0 +1,89 @@ +# Copyright 2016 ACSONE SA/NV +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +import json + +from odoo import exceptions +from odoo.tests import common + +from ..models.res_users import DANGER, DEFAULT, INFO, SUCCESS, WARNING + + +class TestResUsers(common.TransactionCase): + def test_notify_success(self): + bus_bus = self.env["bus.bus"] + domain = [("channel", "=", self.env.user.notify_success_channel_name)] + existing = bus_bus.search(domain) + test_msg = {"message": "message", "title": "title", "sticky": True} + self.env.user.notify_success(**test_msg) + news = bus_bus.search(domain) - existing + self.assertEqual(1, len(news)) + test_msg.update({"type": SUCCESS}) + payload = json.loads(news.message)["payload"][0] + self.assertDictEqual(test_msg, payload) + + def test_notify_danger(self): + bus_bus = self.env["bus.bus"] + domain = [("channel", "=", self.env.user.notify_danger_channel_name)] + existing = bus_bus.search(domain) + test_msg = {"message": "message", "title": "title", "sticky": True} + self.env.user.notify_danger(**test_msg) + news = bus_bus.search(domain) - existing + self.assertEqual(1, len(news)) + test_msg.update({"type": DANGER}) + payload = json.loads(news.message)["payload"][0] + self.assertDictEqual(test_msg, payload) + + def test_notify_warning(self): + bus_bus = self.env["bus.bus"] + domain = [("channel", "=", 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)) + test_msg.update({"type": WARNING}) + payload = json.loads(news.message)["payload"][0] + self.assertDictEqual(test_msg, payload) + + def test_notify_info(self): + bus_bus = self.env["bus.bus"] + domain = [("channel", "=", 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)) + test_msg.update({"type": INFO}) + payload = json.loads(news.message)["payload"][0] + self.assertDictEqual(test_msg, payload) + + def test_notify_default(self): + bus_bus = self.env["bus.bus"] + domain = [("channel", "=", self.env.user.notify_default_channel_name)] + existing = bus_bus.search(domain) + test_msg = {"message": "message", "title": "title", "sticky": True} + self.env.user.notify_default(**test_msg) + news = bus_bus.search(domain) - existing + self.assertEqual(1, len(news)) + test_msg.update({"type": DEFAULT}) + payload = json.loads(news.message)["payload"][0] + self.assertDictEqual(test_msg, payload) + + def test_notify_many(self): + # check that the notification of a list of users is done with + # a single call to the bus + users = self.env.user.search([(1, "=", 1)]) + + self.assertTrue(len(users) > 1) + self.env.user.notify_warning(message="message", target=users.partner_id) + + def test_notify_other_user(self): + other_user = self.env.ref("base.user_demo") + other_user_model = self.env["res.users"].with_user(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 000000000..d8f286ef0 --- /dev/null +++ b/web_notify/views/res_users_demo.xml @@ -0,0 +1,62 @@ + + + + + res.users.form.simple.view.modif.inherit + res.users + + + + + + +