Merge commit 'refs/pull/2310/head' of https://github.com/oca/web into…

… 15.0-72

setup/web_pwa_oca/odoo/addons/web_pwa_oca

@@ -0,0 +1 @@
+../../../../web_pwa_oca

setup/web_pwa_oca/setup.py

@@ -0,0 +1,6 @@
+import setuptools
+
+setuptools.setup(
+    setup_requires=['setuptools-odoo'],
+    odoo_addon=True,
+)

web_pwa_oca/README.rst

@@ -0,0 +1,192 @@
+===========================
+Progressive web application
+===========================
+
+.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! 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-LGPL--3-blue.png
+    :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
+    :alt: License: LGPL-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_pwa_oca
+    :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_pwa_oca
+    :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| 
+
+Make Odoo an installable Progressive Web Application.
+
+Progressive Web Apps provide an installable, app-like experience on desktop and mobile that are built and delivered directly via the web.
+They're web apps that are fast and reliable. And most importantly, they're web apps that work in any browser.
+If you're building a web app today, you're already on the path towards building a Progressive Web App.
+
+
++ Developers Info.
+
+The service worker is contructed using 'Odoo Class' to have the same class inheritance behaviour that in the 'user pages'. Be noticed
+that 'Odoo Bootstrap' is not supported so, you can't use 'require' here.
+
+All service worker content can be found in 'static/src/js/worker'. The management between 'user pages' and service worker is done in
+'pwa_manager.js'.
+
+The purpose of this module is give a base to make PWA applications.
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Installation
+============
+
+After having installed this module, browsing your odoo on mobile you will be able to install it as a PWA.
+
+It is strongly recommended to use this module with a responsive layout, like the one provided by web_responsive.
+
+This module is intended to be used by Odoo back-end users (employees).
+
+When a Progressive Web App is installed, it looks and behaves like all of the other installed apps.
+It launches from the same place that other apps launch. It runs in an app without an address bar or other browser UI.
+And like all other installed apps, it's a top level app in the task switcher.
+
+In Chrome, a Progressive Web App can either be installed through the three-dot context menu.
+
+In case you previously installed `web_pwa`, run the following steps with `odoo shell`, after having installed `openupgradelib`:
+
+
+>>> from openupgradelib import openupgrade
+>>> openupgrade.update_module_names(env.cr, [('web_pwa', 'web_pwa_oca')], merge_modules=False)
+>>> env.cr.commit()
+
+Configuration
+=============
+
+This module allows you to set the following parameters under settings to customize the appearance of the application
+
+* PWA Name (defaults to "Odoo PWA")
+* PWA Short Name (defaults to "Odoo PWA")
+* PWA Icon (**SVG**) (defaults to "/web_pwa_oca/static/img/icons/odoo-logo.svg")
+
+To configure your PWA:
+
+#. Go to **Settings > General Settings > Progressive Web App**.
+#. Set the parameters (*Note:* Icon **must be a SVG file**)
+#. **Save**
+
+Usage
+=====
+
+To use your PWA:
+
+#. Open the Odoo web app using a supported browser (See https://caniuse.com/?search=A2HS)
+#. Open the browser options
+#. Click on 'Add to Home screen' (or 'Install' in other browsers)
+
+** Maybe you need refresh the page to load the service worker after using the option.
+
+Known issues / Roadmap
+======================
+
+* Integrate `Notification API <https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerRegistration/showNotification>`_
+* Integrate `Web Share API <https://web.dev/web-share/>`_
+* Create ``portal_pwa`` module, intended to be used by front-end users (customers, suppliers...)
+* Current *John Resig's inheritance* implementation doesn't support ``async``
+  functions because ``this._super`` can't be called inside a promise. So we
+  need to use the following workaround:
+
+  - Natural 'async/await' example (This breaks "_super" call):
+
+    .. code-block:: javascript
+
+        var MyClass = OdooClass.extend({
+            myFunc: async function() {
+                const mydata = await ...do await stuff...
+                return mydata;
+            }
+        });
+
+  - Same code with the workaround:
+
+    .. code-block:: javascript
+
+        var MyClass = OdooClass.extend({
+            myFunc: function() {
+                return new Promise(async (resolve, reject) => {
+                    const mydata = await ...do await stuff...
+                    return resolve(mydata);
+                });
+            }
+        });
+
+* Fix issue when trying to run in localhost with several databases. The browser
+  doesn't send the cookie and web manifest returns 404.
+* Firefox can't detect 'standalone' mode. See https://bugzilla.mozilla.org/show_bug.cgi?id=1285858
+* Firefox disable service worker in private mode. See https://bugzilla.mozilla.org/show_bug.cgi?id=1601916
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/web/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 <https://github.com/OCA/web/issues/new?body=module:%20web_pwa_oca%0Aversion:%2015.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+
+Do not contact contributors directly about support or help with technical issues.
+
+Credits
+=======
+
+Authors
+~~~~~~~
+
+* TAKOBI
+* Tecnativa
+
+Contributors
+~~~~~~~~~~~~
+
+* `TAKOBI <https://takobi.online>`_:
+
+  * Lorenzo Battistini
+
+* `Tecnativa <https://tecnativa.com>`_:
+
+  * Alexandre D. Díaz
+  * João Marques
+  * Sergio Teruel
+
+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.
+
+.. |maintainer-eLBati| image:: https://github.com/eLBati.png?size=40px
+    :target: https://github.com/eLBati
+    :alt: eLBati
+
+Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
+
+|maintainer-eLBati| 
+
+This module is part of the `OCA/web <https://github.com/OCA/web/tree/15.0/web_pwa_oca>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

web_pwa_oca/__init__.py

@@ -0,0 +1,2 @@
+from . import controllers
+from . import models

web_pwa_oca/__manifest__.py

@@ -0,0 +1,27 @@
+# Copyright 2020 Lorenzo Battistini @ TAKOBI
+# Copyright 2020 Tecnativa - Alexandre D. Díaz
+# Copyright 2020 Tecnativa - João Marques
+# License LGPL-3.0 or later (https://www.gnu.org/licenses/lgpl).
+
+{
+    "name": "Progressive web application",
+    "summary": "Make Odoo a PWA",
+    "version": "15.0.1.0.0",
+    "development_status": "Beta",
+    "category": "Website",
+    "website": "https://github.com/OCA/web",
+    "author": "TAKOBI, Tecnativa, Odoo Community Association (OCA)",
+    "maintainers": ["eLBati"],
+    "license": "LGPL-3",
+    "application": True,
+    "installable": True,
+    "depends": ["web", "mail"],
+    "data": ["templates/assets.xml", "views/res_config_settings_views.xml"],
+    "assets": {
+        "web.assets_backend": [
+            "/web_pwa_oca/static/src/js/pwa_manager.js",
+            "/web_pwa_oca/static/src/js/webclient.js",
+        ]
+    },
+    "images": ["static/description/pwa.png"],
+}

web_pwa_oca/controllers/__init__.py

@@ -0,0 +1,4 @@
+# Copyright 2020 Lorenzo Battistini @ TAKOBI
+# License LGPL-3.0 or later (https://www.gnu.org/licenses/lgpl).
+from . import main
+from . import service_worker

web_pwa_oca/controllers/main.py

@@ -0,0 +1,120 @@
+# Copyright 2020 Lorenzo Battistini @ TAKOBI
+# Copyright 2020 Tecnativa - Alexandre D. Díaz
+# Copyright 2020 Tecnativa - João Marques
+# License LGPL-3.0 or later (https://www.gnu.org/licenses/lgpl).
+import json
+
+from odoo.http import Controller, request, route
+
+
+class PWA(Controller):
+    def _get_pwa_scripts(self):
+        """Scripts to be imported in the service worker (Order is important)"""
+        return [
+            "/web/static/lib/underscore/underscore.js",
+            "/web_pwa_oca/static/src/js/worker/jquery-sw-compat.js",
+            "/web/static/src/legacy/js/promise_extension.js",
+            "/web/static/src/boot.js",
+            "/web/static/src/legacy/js/core/class.js",
+            "/web_pwa_oca/static/src/js/worker/pwa.js",
+        ]
+
+    @route("/service-worker.js", type="http", auth="public")
+    def render_service_worker(self):
+        """Route to register the service worker in the 'main' scope ('/')"""
+        return request.render(
+            "web_pwa_oca.service_worker",
+            {
+                "pwa_scripts": self._get_pwa_scripts(),
+                "pwa_params": self._get_pwa_params(),
+            },
+            headers=[("Content-Type", "text/javascript;charset=utf-8")],
+        )
+
+    def _get_pwa_params(self):
+        """Get javascript PWA class initialzation params"""
+        return {}
+
+    def _get_pwa_manifest_icons(self, pwa_icon):
+        icons = []
+        if not pwa_icon:
+            for size in [
+                (128, 128),
+                (144, 144),
+                (152, 152),
+                (192, 192),
+                (256, 256),
+                (512, 512),
+            ]:
+                icons.append(
+                    {
+                        "src": "/web_pwa_oca/static/img/icons/icon-%sx%s.png"
+                        % (str(size[0]), str(size[1])),
+                        "sizes": "{}x{}".format(str(size[0]), str(size[1])),
+                        "type": "image/png",
+                        "purpose": "any maskable",
+                    }
+                )
+        elif not pwa_icon.mimetype.startswith("image/svg"):
+            all_icons = (
+                request.env["ir.attachment"]
+                .sudo()
+                .search(
+                    [
+                        ("url", "like", "/web_pwa_oca/icon"),
+                        (
+                            "url",
+                            "not like",
+                            "/web_pwa_oca/icon.",
+                        ),  # Get only resized icons
+                    ]
+                )
+            )
+            for icon in all_icons:
+                icon_size_name = icon.url.split("/")[-1].lstrip("icon").split(".")[0]
+                icons.append(
+                    {"src": icon.url, "sizes": icon_size_name, "type": icon.mimetype}
+                )
+        else:
+            icons = [
+                {
+                    "src": pwa_icon.url,
+                    "sizes": "128x128 144x144 152x152 192x192 256x256 512x512",
+                    "type": pwa_icon.mimetype,
+                }
+            ]
+        return icons
+
+    def _get_pwa_manifest(self):
+        """Webapp manifest"""
+        config_param_sudo = request.env["ir.config_parameter"].sudo()
+        pwa_name = config_param_sudo.get_param("pwa.manifest.name", "Odoo PWA")
+        pwa_short_name = config_param_sudo.get_param(
+            "pwa.manifest.short_name", "Odoo PWA"
+        )
+        pwa_icon = (
+            request.env["ir.attachment"]
+            .sudo()
+            .search([("url", "like", "/web_pwa_oca/icon.")])
+        )
+        background_color = config_param_sudo.get_param(
+            "pwa.manifest.background_color", "#2E69B5"
+        )
+        theme_color = config_param_sudo.get_param("pwa.manifest.theme_color", "#2E69B5")
+        return {
+            "name": pwa_name,
+            "short_name": pwa_short_name,
+            "icons": self._get_pwa_manifest_icons(pwa_icon),
+            "start_url": "/web",
+            "display": "standalone",
+            "background_color": background_color,
+            "theme_color": theme_color,
+        }
+
+    @route("/web_pwa_oca/manifest.webmanifest", type="http", auth="public")
+    def pwa_manifest(self):
+        """Returns the manifest used to install the page as app"""
+        return request.make_response(
+            json.dumps(self._get_pwa_manifest()),
+            headers=[("Content-Type", "application/json;charset=utf-8")],
+        )