[12.0][BKP] endpoint & endpoint_route_handler

endpoint/README.rst

@@ -0,0 +1,102 @@
+========
+Endpoint
+========
+
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:2da9c7b7ea950dc9d9b00ebf3d2464b02005513cfb12202d9bc8b4b329f2af70
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |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--api-lightgray.png?logo=github
+    :target: https://github.com/OCA/web-api/tree/14.0/endpoint
+    :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-14-0/web-api-14-0-endpoint
+    :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=14.0
+    :alt: Try me on Runboat
+
+|badge1| |badge2| |badge3| |badge4| |badge5|
+
+Provide an endpoint framework allowing users to define their own custom endpoint.
+
+Thanks to endpoint mixin the endpoint records are automatically registered as real Odoo routes.
+
+You can easily code what you want in the code snippet.
+
+NOTE: for security reasons any kind of RPC call is blocked on endpoint records.
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Configuration
+=============
+
+Go to "Technical -> Endpoints" and create a new endpoint.
+
+Known issues / Roadmap
+======================
+
+* add validation of request data
+* add api docs generation
+* handle multiple routes per endpoint
+
+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:%20endpoint%0Aversion:%2014.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
+~~~~~~~
+
+* Camptocamp
+
+Contributors
+~~~~~~~~~~~~
+
+* Simone Orsi <[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-simahawk| image:: https://github.com/simahawk.png?size=40px
+    :target: https://github.com/simahawk
+    :alt: simahawk
+
+Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
+
+|maintainer-simahawk| 
+
+This module is part of the `OCA/web-api <https://github.com/OCA/web-api/tree/14.0/endpoint>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

endpoint/__init__.py

@@ -0,0 +1,4 @@
+from .hooks import post_init_hook
+from . import controllers
+from . import models
+from . import tools

endpoint/__manifest__.py

@@ -0,0 +1,21 @@
+# Copyright 2021 Camptocamp SA
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
+
+{
+    "name": "Endpoint",
+    "summary": """Provide custom endpoint machinery.""",
+    "version": "12.0.1.0.0",
+    "license": "LGPL-3",
+    "development_status": "Beta",
+    "author": "Camptocamp,Odoo Community Association (OCA)",
+    "maintainers": ["simahawk"],
+    "website": "https://github.com/OCA/web-api",
+    "depends": ["endpoint_route_handler", "rpc_helper"],
+    "data": [
+        "security/ir.model.access.csv",
+        "security/ir_rule.xml",
+        "views/endpoint_view.xml",
+    ],
+    "demo": ["demo/endpoint_demo.xml"],
+    "post_init_hook": "post_init_hook",
+}

endpoint/controllers/__init__.py

@@ -0,0 +1 @@
+from . import main

endpoint/controllers/main.py

@@ -0,0 +1,57 @@
+# Copyright 2021 Camptocamp SA
+# @author: Simone Orsi <[email protected]>
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
+
+
+import json
+
+from werkzeug.exceptions import NotFound
+
+from odoo import http
+from odoo.http import Response, request
+
+
+class EndpointControllerMixin:
+    def _handle_endpoint(self, env, model, endpoint_route, **params):
+        endpoint = self._find_endpoint(env, model, endpoint_route)
+        if not endpoint:
+            raise NotFound()
+        endpoint._validate_request(request)
+        result = endpoint._handle_request(request)
+        return self._handle_result(result)
+
+    def _handle_result(self, result):
+        response = result.get("response")
+        if isinstance(response, Response):
+            # Full response already provided
+            return response
+        payload = result.get("payload", "")
+        status = result.get("status_code", 200)
+        headers = result.get("headers", {})
+        return self._make_json_response(payload, headers=headers, status=status)
+
+    # TODO: probably not needed anymore as controllers are automatically registered
+    def _make_json_response(self, payload, headers=None, status=200, **kw):
+        # TODO: guess out type?
+        data = json.dumps(payload)
+        if headers is None:
+            headers = {}
+        headers["Content-Type"] = "application/json"
+        if request._request_type == "http":
+            resp = request.make_response(data, headers=headers)
+        else:
+            resp = request._json_response(data)
+        resp.status = str(status)
+        return resp
+
+    def _find_endpoint(self, env, model, endpoint_route):
+        return env[model]._find_endpoint(endpoint_route)
+
+    def auto_endpoint(self, model, endpoint_route, **params):
+        """Default method to handle auto-generated endpoints"""
+        env = request.env
+        return self._handle_endpoint(env, model, endpoint_route, **params)
+
+
+class EndpointController(http.Controller, EndpointControllerMixin):
+    pass

endpoint/demo/endpoint_demo.xml

@@ -0,0 +1,86 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<odoo noupdate="1">
+
+    <record id="endpoint_demo_1" model="endpoint.endpoint">
+        <field name="name">Demo Endpoint 1</field>
+        <field name="route">/demo/one</field>
+        <field name="request_method">GET</field>
+        <field name="exec_mode">code</field>
+        <field name="code_snippet">
+result = {"response": Response("ok")}
+        </field>
+    </record>
+
+    <record id="endpoint_demo_2" model="endpoint.endpoint">
+        <field name="name">Demo Endpoint 2</field>
+        <field name="route">/demo/as_demo_user</field>
+        <field name="request_method">GET</field>
+        <field name="auth_type">public</field>
+        <field name="exec_as_user_id" ref="base.user_demo" />
+        <field name="exec_mode">code</field>
+        <field name="code_snippet">
+result = {"response": Response("My name is: " + user.name)}
+        </field>
+    </record>
+
+    <record id="endpoint_demo_3" model="endpoint.endpoint">
+        <field name="name">Demo Endpoint 3</field>
+        <field name="route">/demo/json_data</field>
+        <field name="request_method">GET</field>
+        <field name="auth_type">public</field>
+        <field name="exec_as_user_id" ref="base.user_demo" />
+        <field name="exec_mode">code</field>
+        <field name="code_snippet">
+result = {"payload": {"a": 1, "b": 2}}
+        </field>
+    </record>
+
+    <record id="endpoint_demo_4" model="endpoint.endpoint">
+        <field name="name">Demo Endpoint 4</field>
+        <field name="route">/demo/raise_not_found</field>
+        <field name="request_method">GET</field>
+        <field name="auth_type">public</field>
+        <field name="exec_as_user_id" ref="base.user_demo" />
+        <field name="exec_mode">code</field>
+        <field name="code_snippet">
+raise werkzeug.exceptions.NotFound()
+        </field>
+    </record>
+
+    <record id="endpoint_demo_5" model="endpoint.endpoint">
+        <field name="name">Demo Endpoint 5</field>
+        <field name="route">/demo/raise_validation_error</field>
+        <field name="request_method">GET</field>
+        <field name="auth_type">public</field>
+        <field name="exec_as_user_id" ref="base.user_demo" />
+        <field name="exec_mode">code</field>
+        <field name="code_snippet">
+raise exceptions.ValidationError("Sorry, you cannot do this!")
+        </field>
+    </record>
+
+    <record id="endpoint_demo_6" model="endpoint.endpoint">
+        <field name="name">Demo Endpoint 6</field>
+        <field name="route">/demo/value_from_request</field>
+        <field name="request_method">GET</field>
+        <field name="auth_type">public</field>
+        <field name="exec_as_user_id" ref="base.user_demo" />
+        <field name="exec_mode">code</field>
+        <field name="code_snippet">
+result = {"response": Response(request.params.get("your_name", ""))}
+        </field>
+    </record>
+
+    <record id="endpoint_demo_7" model="endpoint.endpoint">
+        <field name="name">Demo Endpoint 7</field>
+        <field name="route">/demo/bad_method</field>
+        <field name="request_method">GET</field>
+        <field name="exec_mode">code</field>
+        <field name="auth_type">public</field>
+        <field name="exec_as_user_id" ref="base.user_demo" />
+        <field name="code_snippet">
+result = {"payload": "Method used:" + request.httprequest.method}
+        </field>
+    </record>
+
+</odoo>

endpoint/hooks.py

@@ -0,0 +1,70 @@
+# Copyright 2021 Camptocamp SA
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl)
+
+import logging
+
+from odoo import SUPERUSER_ID, api, tools
+
+from odoo.addons.base.models.ir_model import query_insert
+
+_logger = logging.getLogger(__file__)
+
+
+def post_init_hook(cr, registry):
+    env = api.Environment(cr, SUPERUSER_ID, {})
+    _init_server_action(env)
+
+
+def _init_server_action(env):
+    """Create server action if missing."""
+    # This is actually a trick to work around this error:
+    #
+    #   psycopg2.IntegrityError: null value in column "activity_user_type"
+    #   violates not-null constraint
+    #
+    # which happens when `mail` is installed,
+    # since it adds this field as required in DB.
+    #
+    # We DO NOT want to depend on mail for this problem...
+    # hence, here we go with this crazy dance :S
+    #
+    # Moreover, we are forced to use a query for this
+    # because if you use `model.create` you get
+    #
+    #   ValueError: Invalid field 'activity_user_type' on model 'ir.actions.server'
+    #
+    # because the field is not yet in the env if the mail modules is not loaded 1st.
+    xid = "endpoint.server_action_registry_sync"
+    rec = env.ref(xid, False)
+    if rec:
+        return
+    model = env.ref("endpoint.model_endpoint_endpoint")
+    values = {
+        "name": "Sync registry",
+        "type": "ir.actions.server",
+        "model_id": model.id,
+        "model_name": model.model,
+        "binding_model_id": model.id,
+        "binding_type": "action",
+        "usage": "ir_actions_server",
+        "state": "code",
+        "code": """
+records.filtered(lambda x: not x.registry_sync).write({"registry_sync": True})
+""",
+    }
+    if tools.sql.column_exists(env.cr, "ir_act_server", "activity_user_type"):
+        values["activity_user_type"] = "specific"
+    ids = query_insert(env.cr, "ir_act_server", [values])
+
+    # Finally add an xmlid
+    module, id_ = xid.split(".", 1)
+    env["ir.model.data"].create(
+        {
+            "name": id_,
+            "module": module,
+            "model": "ir.actions.server",
+            "res_id": ids[0],
+            "noupdate": True,
+        }
+    )
+    _logger.info("Server action created")