[12.0][BKP] webservice

setup/webservice/odoo/addons/webservice

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

setup/webservice/setup.py

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

test-requirements.txt

@@ -2,3 +2,4 @@ invoice2data==0.3.5
 freezegun
 odoo_test_helper
 pypdf>=3.15.0,<5.0
+httpretty

webservice/README.rst

@@ -0,0 +1,87 @@
+==========
+WebService
+==========
+
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:c507ac3d223fcff3d1e2326f1bc4f9545c332e0adc575150a75a0dbdad6b6de8
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |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--api-lightgray.png?logo=github
+    :target: https://github.com/OCA/web-api/tree/16.0/webservice
+    :alt: OCA/web-api
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/web-api-16-0/web-api-16-0-webservice
+    :alt: Translate me on Weblate
+.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
+    :target: https://runboat.odoo-community.org/builds?repo=OCA/web-api&target_branch=16.0
+    :alt: Try me on Runboat
+
+|badge1| |badge2| |badge3| |badge4| |badge5|
+
+This module creates WebService frameworks to be used globally.
+
+The module introduces support for HTTP Request protocol. The webservice HTTP call returns by default the content of the response. A context 'content_only' can be passed to get the full response object.
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/web-api/issues>`_.
+In case of trouble, please check there if your issue has already been reported.
+If you spotted it first, help us to smash it by providing a detailed and welcomed
+`feedback <https://github.com/OCA/web-api/issues/new?body=module:%20webservice%0Aversion:%2016.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
+~~~~~~~
+
+* Creu Blanca
+* Camptocamp
+
+Contributors
+~~~~~~~~~~~~
+
+* Enric Tobella <[email protected]>
+
+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-etobella| image:: https://github.com/etobella.png?size=40px
+    :target: https://github.com/etobella
+    :alt: etobella
+
+Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
+
+|maintainer-etobella| 
+
+This module is part of the `OCA/web-api <https://github.com/OCA/web-api/tree/16.0/webservice>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

webservice/__init__.py

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

webservice/__manifest__.py

@@ -0,0 +1,24 @@
+# Copyright 2020 Creu Blanca
+# Copyright 2022 Camptocamp SA
+# @author Simone Orsi <[email protected]>
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+
+{
+    "name": "WebService",
+    "summary": """
+        Defines webservice abstract definition to be used generally""",
+    "version": "12.0.1.0.0",
+    "license": "AGPL-3",
+    "development_status": "Production/Stable",
+    "maintainers": ["etobella"],
+    "author": "Creu Blanca, Camptocamp, Odoo Community Association (OCA)",
+    "website": "https://github.com/OCA/edi",
+    "depends": ["component", "server_environment"],
+    "data": [
+        "security/ir.model.access.csv",
+        "security/ir_rule.xml",
+        "views/webservice_backend.xml",
+    ],
+    "demo": [],
+}

webservice/components/__init__.py

@@ -0,0 +1,2 @@
+from . import base_adapter
+from . import request_adapter

webservice/components/base_adapter.py

@@ -0,0 +1,19 @@
+# Copyright 2020 Creu Blanca
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+from odoo.addons.component.core import AbstractComponent
+
+
+class BaseWebServiceAdapter(AbstractComponent):
+    _name = "base.webservice.adapter"
+    _collection = "webservice.backend"
+    _webservice_protocol = False
+    _usage = "webservice.request"
+
+    @classmethod
+    def _component_match(cls, work, usage=None, model_name=None, **kw):
+        """Override to customize match.
+        Registry lookup filtered by usage and model_name when landing here.
+        Now, narrow match to `_match_attrs` attributes.
+        """
+        return kw.get("webservice_protocol") in (None, cls._webservice_protocol)

webservice/components/request_adapter.py

@@ -0,0 +1,81 @@
+# Copyright 2020 Creu Blanca
+# Copyright 2022 Camptocamp SA
+# @author Simone Orsi <[email protected]>
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+import requests
+
+from odoo.addons.component.core import Component
+
+
+class BaseRestRequestsAdapter(Component):
+    _name = "base.requests"
+    _webservice_protocol = "http"
+    _inherit = "base.webservice.adapter"
+
+    # TODO: url and url_params could come from work_ctx
+    def _request(self, method, url=None, url_params=None, **kwargs):
+        url = self._get_url(url=url, url_params=url_params)
+        content_only = kwargs.pop("content_only", True)
+        new_kwargs = kwargs.copy()
+        new_kwargs.update(
+            {
+                "auth": self._get_auth(**kwargs),
+                "headers": self._get_headers(**kwargs),
+                "timeout": None,
+            }
+        )
+        # pylint: disable=E8106
+        request = requests.request(method, url, **new_kwargs)
+        request.raise_for_status()
+        if content_only:
+            return request.content
+        return request
+
+    def get(self, **kwargs):
+        return self._request("get", **kwargs)
+
+    def post(self, **kwargs):
+        return self._request("post", **kwargs)
+
+    def put(self, **kwargs):
+        return self._request("put", **kwargs)
+
+    def _get_auth(self, auth=False, **kwargs):
+        if auth:
+            return auth
+        handler = getattr(self, "_get_auth_for_" + self.collection.auth_type, None)
+        return handler(**kwargs) if handler else None
+
+    def _get_auth_for_user_pwd(self, **kw):
+        if self.collection.username and self.collection.password:
+            return self.collection.username, self.collection.password
+        return None
+
+    def _get_headers(self, content_type=False, headers=False, **kwargs):
+        headers = headers or {}
+        result = {
+            "Content-Type": content_type or self.collection.content_type,
+        }
+        handler = getattr(self, "_get_headers_for_" + self.collection.auth_type, None)
+        if handler:
+            headers.update(handler(**kwargs))
+        result.update(headers)
+        return result
+
+    def _get_headers_for_api_key(self, **kw):
+        return {self.collection.api_key_header: self.collection.api_key}
+
+    def _get_url(self, url=None, url_params=None, **kwargs):
+        if not url:
+            url = self.collection.url
+        elif not url.startswith(self.collection.url):
+            if not url.startswith("http"):
+                url = f"{self.collection.url.rstrip('/')}/{url.lstrip('/')}"
+            else:
+                # TODO: if url is given, we should validate the domain
+                # to avoid abusing a webservice backend for different calls.
+                pass
+
+        url_params = url_params or kwargs
+        return url.format(**url_params)

webservice/controllers/oauth2.py

@@ -0,0 +1,58 @@
+# Copyright 2024 Camptocamp SA
+# @author Alexandre Fayolle <[email protected]>
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+import json
+import logging
+
+from oauthlib.oauth2.rfc6749 import errors
+from werkzeug.urls import url_encode
+
+from odoo import http
+from odoo.http import request
+
+_logger = logging.getLogger(__name__)
+
+
+class OAuth2Controller(http.Controller):
+    @http.route(
+        "/webservice/<int:backend_id>/oauth2/redirect",
+        type="http",
+        auth="public",
+        csrf=False,
+    )
+    def redirect(self, backend_id, **params):
+        backend = request.env["webservice.backend"].browse(backend_id).sudo()
+        if backend.auth_type != "oauth2" or backend.oauth2_flow != "web_application":
+            _logger.error("unexpected backed config for backend %d", backend_id)
+            raise errors.MismatchingRedirectURIError()
+        expected_state = backend.oauth2_state
+        state = params.get("state")
+        if state != expected_state:
+            _logger.error("unexpected state: %s", state)
+            raise errors.MismatchingStateError()
+        code = params.get("code")
+        adapter = (
+            backend._get_adapter()
+        )  # we expect an adapter that supports web_application
+        token = adapter._fetch_token_from_authorization(code)
+        backend.write({"oauth2_token": json.dumps(token), "oauth2_state": False})
+        # after saving the token, redirect to the backend form view
+        uid = request.session.uid
+        user = request.env["res.users"].sudo().browse(uid)
+        cids = request.httprequest.cookies.get("cids", str(user.company_id.id))
+        cids = [int(cid) for cid in cids.split(",")]
+        record_action = backend.get_access_action()
+        url_params = {
+            "model": backend._name,
+            "id": backend.id,
+            "active_id": backend.id,
+            "action": record_action.get("id"),
+        }
+        view_id = backend.get_formview_id()
+        if view_id:
+            url_params["view_id"] = view_id
+
+        if cids:
+            url_params["cids"] = ",".join([str(cid) for cid in cids])
+        url = "/web?#%s" % url_encode(url_params)
+        return request.redirect(url)