odoo-addon-api-log 16.0.1.0.0.7__py3-none-any.whl

odoo/addons/api_log/README.rst

@@ -0,0 +1,97 @@
+.. image:: https://odoo-community.org/readme-banner-image
+   :target: https://odoo-community.org/get-involved?utm_source=readme
+   :alt: Odoo Community Association
+
+=======
+API Log
+=======
+
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:a1948d1ff8b66338522f1c1a2988d5ab8b0a7ff97fcbe9589879bd67b30719ce
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |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/license-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%2Frest--framework-lightgray.png?logo=github
+    :target: https://github.com/OCA/rest-framework/tree/16.0/api_log
+    :alt: OCA/rest-framework
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/rest-framework-16-0/rest-framework-16-0-api_log
+    :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/rest-framework&target_branch=16.0
+    :alt: Try me on Runboat
+
+|badge1| |badge2| |badge3| |badge4| |badge5|
+
+This module allows to store request and response logs for any API.
+
+When a response is logged, the header ``API_LOG_ENTRY_ID`` is injected
+in the response header. This header stores the identifier of the log
+record produced from the response.
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/rest-framework/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/rest-framework/issues/new?body=module:%20api_log%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
+-------
+
+* Akretion
+
+Contributors
+------------
+
+- Florian Mounier florian.mounier@akretion.com
+- Guewen Baconnier guewen.baconnier@camptocamp.com
+- Simone Orsi simahawk@gmail.com
+- `PyTech <https://www.pytech.it>`__:
+
+  - Simone Rubino <simone.rubino@pytech.it>
+
+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-paradoxxxzero| image:: https://github.com/paradoxxxzero.png?size=40px
+    :target: https://github.com/paradoxxxzero
+    :alt: paradoxxxzero
+
+Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
+
+|maintainer-paradoxxxzero| 
+
+This module is part of the `OCA/rest-framework <https://github.com/OCA/rest-framework/tree/16.0/api_log>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

odoo/addons/api_log/__init__.py

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

odoo/addons/api_log/__manifest__.py

@@ -0,0 +1,20 @@
+# Copyright 2025 Akretion (http://www.akretion.com).
+# @author Florian Mounier <florian.mounier@akretion.com>
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+{
+    "name": "API Log",
+    "version": "16.0.1.0.0",
+    "author": "Akretion, Odoo Community Association (OCA)",
+    "license": "AGPL-3",
+    "summary": "Log API requests in database",
+    "category": "Tools",
+    "depends": ["web"],
+    "website": "https://github.com/OCA/rest-framework",
+    "data": [
+        "security/res_groups.xml",
+        "security/ir_model_access.xml",
+        "views/api_log_views.xml",
+    ],
+    "maintainers": ["paradoxxxzero"],
+}

odoo/addons/api_log/i18n/api_log.pot

@@ -0,0 +1,246 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+# 	* api_log
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 16.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: api_log
+#: model:ir.actions.act_window,name:api_log.api_log_action
+#: model:ir.ui.menu,name:api_log.menu_api_log
+msgid "API Log"
+msgstr ""
+
+#. module: api_log
+#: model:res.groups,name:api_log.group_api_log
+msgid "API Log Access"
+msgstr ""
+
+#. module: api_log
+#: model:ir.model.fields,field_description:api_log.field_api_log__collection_id
+#: model_terms:ir.ui.view,arch_db:api_log.api_log_view_search
+msgid "Collection"
+msgstr ""
+
+#. module: api_log
+#: model:ir.model.fields,field_description:api_log.field_api_log__collection_model
+msgid "Collection Model"
+msgstr ""
+
+#. module: api_log
+#: model:ir.model.fields,field_description:api_log.field_api_log__collection_ref
+msgid "Collection Ref"
+msgstr ""
+
+#. module: api_log
+#: model:ir.model,name:api_log.model_api_log_collection_mixin
+msgid "Collection of API logs"
+msgstr ""
+
+#. module: api_log
+#: model:ir.model.fields,field_description:api_log.field_api_log__create_uid
+msgid "Created by"
+msgstr ""
+
+#. module: api_log
+#: model:ir.model.fields,field_description:api_log.field_api_log__create_date
+msgid "Created on"
+msgstr ""
+
+#. module: api_log
+#: model:ir.model.fields,field_description:api_log.field_api_log__display_name
+msgid "Display Name"
+msgstr ""
+
+#. module: api_log
+#: model_terms:ir.ui.view,arch_db:api_log.api_log_view_search
+msgid "Error"
+msgstr ""
+
+#. module: api_log
+#: model:ir.model.fields,field_description:api_log.field_api_log__id
+msgid "ID"
+msgstr ""
+
+#. module: api_log
+#: model:ir.model.fields,field_description:api_log.field_api_log____last_update
+msgid "Last Modified on"
+msgstr ""
+
+#. module: api_log
+#: model:ir.model.fields,field_description:api_log.field_api_log__write_uid
+msgid "Last Updated by"
+msgstr ""
+
+#. module: api_log
+#: model:ir.model.fields,field_description:api_log.field_api_log__write_date
+msgid "Last Updated on"
+msgstr ""
+
+#. module: api_log
+#: model:ir.model.fields,field_description:api_log.field_api_log_collection_mixin__log_requests
+msgid "Log Requests"
+msgstr ""
+
+#. module: api_log
+#: model:ir.model,name:api_log.model_api_log
+msgid "Log for API"
+msgstr ""
+
+#. module: api_log
+#: model:ir.model.fields,help:api_log.field_api_log_collection_mixin__log_requests
+msgid "Log requests in database."
+msgstr ""
+
+#. module: api_log
+#: model:ir.model.fields,field_description:api_log.field_api_log_collection_mixin__log_ids
+msgid "Logs"
+msgstr ""
+
+#. module: api_log
+#: model_terms:ir.ui.view,arch_db:api_log.api_log_view_search
+msgid "Method"
+msgstr ""
+
+#. module: api_log
+#: model:ir.model.fields,field_description:api_log.field_api_log__name
+msgid "Name"
+msgstr ""
+
+#. module: api_log
+#: model:ir.model.fields,field_description:api_log.field_api_log__referrer
+msgid "Referrer"
+msgstr ""
+
+#. module: api_log
+#: model:ir.model.fields,field_description:api_log.field_api_log__request_body
+msgid "Request Body"
+msgstr ""
+
+#. module: api_log
+#: model:ir.model.fields,field_description:api_log.field_api_log__request_b64
+msgid "Request Content"
+msgstr ""
+
+#. module: api_log
+#: model:ir.model.fields,field_description:api_log.field_api_log__request_content_length
+msgid "Request Content Length"
+msgstr ""
+
+#. module: api_log
+#: model:ir.model.fields,field_description:api_log.field_api_log__request_content_type
+msgid "Request Content Type"
+msgstr ""
+
+#. module: api_log
+#: model:ir.model.fields,field_description:api_log.field_api_log__request_date
+msgid "Request Date"
+msgstr ""
+
+#. module: api_log
+#: model:ir.model.fields,field_description:api_log.field_api_log__request_headers
+msgid "Request Headers"
+msgstr ""
+
+#. module: api_log
+#: model:ir.model.fields,field_description:api_log.field_api_log__request_headers_preview
+msgid "Request Headers Preview"
+msgstr ""
+
+#. module: api_log
+#: model:ir.model.fields,field_description:api_log.field_api_log__request_method
+msgid "Request Method"
+msgstr ""
+
+#. module: api_log
+#: model:ir.model.fields,field_description:api_log.field_api_log__request_preview
+msgid "Request Preview"
+msgstr ""
+
+#. module: api_log
+#: model:ir.model.fields,field_description:api_log.field_api_log__request_time
+msgid "Request Time"
+msgstr ""
+
+#. module: api_log
+#: model:ir.model.fields,field_description:api_log.field_api_log__request_url
+msgid "Request Url"
+msgstr ""
+
+#. module: api_log
+#: model:ir.model.fields,field_description:api_log.field_api_log__response_body
+msgid "Response Body"
+msgstr ""
+
+#. module: api_log
+#: model:ir.model.fields,field_description:api_log.field_api_log__response_b64
+msgid "Response Content"
+msgstr ""
+
+#. module: api_log
+#: model:ir.model.fields,field_description:api_log.field_api_log__response_content_length
+msgid "Response Content Length"
+msgstr ""
+
+#. module: api_log
+#: model:ir.model.fields,field_description:api_log.field_api_log__response_content_type
+msgid "Response Content Type"
+msgstr ""
+
+#. module: api_log
+#: model:ir.model.fields,field_description:api_log.field_api_log__response_date
+msgid "Response Date"
+msgstr ""
+
+#. module: api_log
+#: model:ir.model.fields,field_description:api_log.field_api_log__response_headers
+msgid "Response Headers"
+msgstr ""
+
+#. module: api_log
+#: model:ir.model.fields,field_description:api_log.field_api_log__response_headers_preview
+msgid "Response Headers Preview"
+msgstr ""
+
+#. module: api_log
+#: model:ir.model.fields,field_description:api_log.field_api_log__response_preview
+msgid "Response Preview"
+msgstr ""
+
+#. module: api_log
+#: model:ir.model.fields,field_description:api_log.field_api_log__response_status_code
+msgid "Response Status Code"
+msgstr ""
+
+#. module: api_log
+#: model:ir.model.fields,field_description:api_log.field_api_log__response_time
+msgid "Response Time"
+msgstr ""
+
+#. module: api_log
+#: model:ir.model.fields,field_description:api_log.field_api_log__stack_trace
+msgid "Stack Trace"
+msgstr ""
+
+#. module: api_log
+#: model_terms:ir.ui.view,arch_db:api_log.api_log_view_search
+msgid "Success"
+msgstr ""
+
+#. module: api_log
+#: model:ir.model.fields,field_description:api_log.field_api_log__time
+msgid "Time"
+msgstr ""
+
+#. module: api_log
+#: model_terms:ir.ui.view,arch_db:api_log.api_log_view_search
+msgid "Url"
+msgstr ""

odoo/addons/api_log/models/__init__.py

@@ -0,0 +1,2 @@
+from . import api_log_collection
+from . import api_log

odoo/addons/api_log/models/api_log.py

@@ -0,0 +1,277 @@
+# Copyright 2025 Akretion (http://www.akretion.com).
+# @author Florian Mounier <florian.mounier@akretion.com>
+# Copyright 2025 Simone Rubino - PyTech
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+import base64
+import json
+import time
+from datetime import date
+from traceback import format_exception
+
+from werkzeug.exceptions import HTTPException as WerkzeugHTTPException
+
+from odoo import api, fields, models
+
+
+class APILog(models.Model):
+    _name = "api.log"
+    _description = "Log for API"
+    _order = "id desc"
+
+    collection_ref = fields.Reference(
+        selection="_selection_collection_ref",
+    )
+    collection_model = fields.Char(
+        compute="_compute_collection",
+        store=True,
+        index=True,
+    )
+    collection_id = fields.Integer(
+        compute="_compute_collection",
+        store=True,
+        index=True,
+    )
+
+    # Request
+    request_url = fields.Char()
+    request_method = fields.Char()
+    request_headers = fields.Json()
+    request_body = fields.Binary(attachment=False)
+    request_date = fields.Datetime()
+    request_time = fields.Float()
+
+    # Response
+    response_status_code = fields.Integer()
+    response_headers = fields.Json()
+    response_body = fields.Binary(attachment=False)
+    response_date = fields.Datetime()
+    response_time = fields.Float()
+
+    stack_trace = fields.Text()
+
+    # Derived fields
+    name = fields.Char(compute="_compute_name", store=True)
+    time = fields.Float(compute="_compute_time", store=True)
+    request_preview = fields.Text(compute="_compute_request_preview")
+    response_preview = fields.Text(compute="_compute_response_preview")
+    # Binary fields are useful to download the payload in case of file download/upload
+    request_b64 = fields.Binary(
+        string="Request Content", compute="_compute_request_b64"
+    )
+    response_b64 = fields.Binary(
+        string="Response Content", compute="_compute_response_b64"
+    )
+    request_headers_preview = fields.Text(compute="_compute_headers_preview")
+    response_headers_preview = fields.Text(compute="_compute_headers_preview")
+    request_content_type = fields.Char(
+        compute="_compute_request_headers_derived", store=True
+    )
+    request_content_length = fields.Integer(
+        compute="_compute_request_headers_derived", store=True
+    )
+    referrer = fields.Char(compute="_compute_request_headers_derived", store=True)
+    response_content_type = fields.Char(
+        compute="_compute_response_headers_derived", store=True
+    )
+    response_content_length = fields.Integer(
+        compute="_compute_response_headers_derived", store=True
+    )
+
+    @api.model
+    def _selection_collection_ref(self):
+        return []
+
+    @api.depends(
+        "collection_ref",
+    )
+    def _compute_collection(self):
+        for log in self:
+            collection = log.collection_ref
+            if collection:
+                collection_model = collection._name
+                collection_id = collection.id
+            else:
+                collection_model = False
+                collection_id = False
+            log.collection_model = collection_model
+            log.collection_id = collection_id
+
+    @api.model
+    def _headers_hidden_keys(self):
+        """Header keys that should not be logged.
+
+        They might contains sensitive data.
+        """
+        return (
+            "Api-Key",
+            "Cookie",
+        )
+
+    @api.model
+    def _sanitize_headers_dict(self, headers_dict):
+        keys_to_hide = self._headers_hidden_keys()
+        for key in headers_dict:
+            if key in keys_to_hide:
+                headers_dict[key] = "<redacted>"
+        return headers_dict
+
+    @api.model
+    def _headers_to_dict(self, headers):
+        headers_dict = {key: value for key, value in headers.items()}
+        return self._sanitize_headers_dict(headers_dict)
+
+    def _current_time(self):
+        return time.time_ns() / 1e9
+
+    @api.model
+    def _get_http_request(self, request):
+        return request.httprequest
+
+    @api.model
+    def _get_request_body(self, request):
+        """Take extra care with the request's body because it might get consumed."""
+        httprequest = self._get_http_request(request)
+        return httprequest.data
+
+    @api.model
+    def _prepare_log_request(self, request):
+        httprequest = self._get_http_request(request)
+        log_request_values = {
+            "request_url": httprequest.url,
+            "request_method": httprequest.method,
+            "request_headers": self._headers_to_dict(httprequest.headers),
+            "request_body": self._get_request_body(request),
+            "request_date": fields.Datetime.now(),
+            "request_time": self._current_time(),
+        }
+        return log_request_values
+
+    @api.model
+    def log_request(self, request, override_log_values=None):
+        log_request_values = self._prepare_log_request(request)
+        log_request_values.update(override_log_values or {})
+        return self.sudo().create(log_request_values)
+
+    def _inject_log_entry(self, values_dict):
+        values_dict["API-Log-Entry-ID"] = str(self.id)
+        return values_dict
+
+    def _prepare_log_response(self, response):
+        self._inject_log_entry(response.headers)
+        headers_dict = self._headers_to_dict(response.headers)
+        return {
+            "response_status_code": response.status_code,
+            "response_headers": headers_dict,
+            "response_body": response.data,
+            "response_date": fields.Datetime.now(),
+            "response_time": self._current_time(),
+        }
+
+    def log_response(self, response):
+        log_response_values = self._prepare_log_response(response)
+        return self.sudo().write(log_response_values)
+
+    def _prepare_log_exception(self, exception):
+        if not hasattr(exception, "headers"):
+            exception.headers = dict()
+        values = {
+            "stack_trace": "".join(format_exception(exception)),
+            "response_headers": self._inject_log_entry(exception.headers),
+            "response_body": str(exception),
+            "response_date": fields.Datetime.now(),
+            "response_time": self._current_time(),
+        }
+
+        if isinstance(exception, WerkzeugHTTPException):
+            values.update(
+                {
+                    "response_status_code": exception.code,
+                    "response_headers": self._headers_to_dict(exception.get_headers()),
+                    "response_body": exception.get_body(),
+                }
+            )
+        return values
+
+    def log_exception(self, exception):
+        try:
+            exc_handling_response = self.env.registry["ir.http"]._handle_error(
+                exception
+            )
+            self.log_response(exc_handling_response)
+        except Exception as handling_exception:
+            exception = handling_exception
+        log_exception_values = self._prepare_log_exception(exception)
+        return self.sudo().write(log_exception_values)
+
+    @api.depends("request_url", "request_method", "request_date")
+    def _compute_name(self):
+        for log in self:
+            log.name = (
+                f"{(log.request_date or date.min).isoformat()} - "
+                f"[{log.request_method or ''}] {log.request_url or ''}"
+            )
+
+    @api.depends("request_time", "response_time")
+    def _compute_time(self):
+        for log in self:
+            if log.request_time and log.response_time:
+                log.time = log.response_time - log.request_time
+            else:
+                log.time = 0
+
+    @api.depends("request_headers")
+    def _compute_request_headers_derived(self):
+        for log in self:
+            headers = log.request_headers or {}
+            log.request_content_type = headers.get("content-type", "")
+            log.request_content_length = headers.get("content-length", 0)
+            log.referrer = headers.get("referer", "")
+
+    @api.depends("response_headers")
+    def _compute_response_headers_derived(self):
+        for log in self:
+            headers = log.response_headers or {}
+            log.response_content_type = headers.get("content-type", "")
+            log.response_content_length = headers.get("content-length", 0)
+
+    @api.depends("request_body")
+    def _compute_request_preview(self):
+        for log in self.with_context(bin_size=False):
+            log.request_preview = log._body_preview(log.request_body)
+
+    @api.depends("response_body")
+    def _compute_response_preview(self):
+        for log in self.with_context(bin_size=False):
+            log.response_preview = log._body_preview(log.response_body)
+
+    def _body_preview(self, body):
+        # Display the first 1000 characters of the body if it's a text content
+        body_preview = False
+        if body:
+            try:
+                body_preview = body.decode("utf-8", errors="ignore")
+                if len(body_preview) > 1000:
+                    body_preview = body_preview[:1000] + "...\n(...)"
+            except UnicodeDecodeError:
+                body_preview = False
+        return body_preview
+
+    @api.depends("request_headers", "response_headers")
+    def _compute_headers_preview(self):
+        for log in self:
+            log.request_headers_preview = log._headers_preview(log.request_headers)
+            log.response_headers_preview = log._headers_preview(log.response_headers)
+
+    def _headers_preview(self, headers):
+        return json.dumps(headers, sort_keys=True, indent=4) if headers else False
+
+    @api.depends("request_body")
+    def _compute_request_b64(self):
+        for log in self:
+            log.request_b64 = base64.b64encode(log.request_body or b"")
+
+    @api.depends("response_body")
+    def _compute_response_b64(self):
+        for log in self:
+            log.response_b64 = base64.b64encode(log.response_body or b"")

odoo/addons/api_log/models/api_log_collection.py

@@ -0,0 +1,55 @@
+# Copyright 2025 Simone Rubino - PyTech
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+
+from odoo import fields, models
+
+
+class APILogCollection(models.AbstractModel):
+    _name = "api.log_collection.mixin"
+    _description = "Collection of API logs"
+
+    log_requests = fields.Boolean(
+        help="Log requests in database.",
+    )
+
+    log_ids = fields.One2many(
+        comodel_name="api.log",
+        compute="_compute_log_ids",
+        string="Logs",
+    )
+
+    def _get_logs_domain(self):
+        """Domain to find the logs in `self`."""
+        return [
+            ("collection_model", "=", self._name),
+            ("collection_id", "in", self.ids),
+        ]
+
+    def _compute_log_ids(self):
+        all_logs = self.env["api.log"].search_read(
+            domain=self._get_logs_domain(),
+            fields=[
+                "collection_id",
+            ],
+            load=None,
+        )
+        log_ids_by_collection_id = {}
+        for log in all_logs:
+            log_ids_by_collection_id.setdefault(log["collection_id"], []).append(
+                log["id"]
+            )
+
+        for collection in self:
+            collection.log_ids = log_ids_by_collection_id.get(collection.id)
+
+    def action_logs(self):
+        return {
+            "type": "ir.actions.act_window",
+            "res_model": "api.log",
+            "name": "Logs",
+            "view_type": "form",
+            "view_mode": "tree,form",
+            "target": "current",
+            "domain": self._get_logs_domain(),
+            "context": dict(self.env.context),
+        }