|
| 1 | +# Copyright 2025 Akretion (http://www.akretion.com). |
| 2 | +# @author Florian Mounier <florian.mounier@akretion.com> |
| 3 | +# Copyright 2025 Simone Rubino - PyTech |
| 4 | +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). |
| 5 | + |
| 6 | +import base64 |
| 7 | +import json |
| 8 | +import time |
| 9 | +from traceback import format_exception |
| 10 | + |
| 11 | +from werkzeug.exceptions import HTTPException as WerkzeugHTTPException |
| 12 | + |
| 13 | +from odoo import api, fields, models |
| 14 | + |
| 15 | + |
| 16 | +class APILog(models.Model): |
| 17 | + _name = "api.log" |
| 18 | + _description = "Log for API" |
| 19 | + _order = "id desc" |
| 20 | + |
| 21 | + collection_ref = fields.Reference( |
| 22 | + selection="_selection_collection_ref", |
| 23 | + ) |
| 24 | + collection_model = fields.Char( |
| 25 | + compute="_compute_collection", |
| 26 | + store=True, |
| 27 | + index=True, |
| 28 | + ) |
| 29 | + collection_id = fields.Integer( |
| 30 | + compute="_compute_collection", |
| 31 | + store=True, |
| 32 | + index=True, |
| 33 | + ) |
| 34 | + |
| 35 | + # Request |
| 36 | + request_url = fields.Char() |
| 37 | + request_method = fields.Char() |
| 38 | + request_headers = fields.Json() |
| 39 | + request_body = fields.Binary(attachment=False) |
| 40 | + request_date = fields.Datetime() |
| 41 | + request_time = fields.Float() |
| 42 | + |
| 43 | + # Response |
| 44 | + response_status_code = fields.Integer() |
| 45 | + response_headers = fields.Json() |
| 46 | + response_body = fields.Binary(attachment=False) |
| 47 | + response_date = fields.Datetime() |
| 48 | + response_time = fields.Float() |
| 49 | + |
| 50 | + stack_trace = fields.Text() |
| 51 | + |
| 52 | + # Derived fields |
| 53 | + name = fields.Char(compute="_compute_name", store=True) |
| 54 | + time = fields.Float(compute="_compute_time", store=True) |
| 55 | + request_preview = fields.Text(compute="_compute_request_preview") |
| 56 | + response_preview = fields.Text(compute="_compute_response_preview") |
| 57 | + # Binary fields are useful to download the payload in case of file download/upload |
| 58 | + request_b64 = fields.Binary( |
| 59 | + string="Request Content", compute="_compute_request_b64" |
| 60 | + ) |
| 61 | + response_b64 = fields.Binary( |
| 62 | + string="Response Content", compute="_compute_response_b64" |
| 63 | + ) |
| 64 | + request_headers_preview = fields.Text(compute="_compute_headers_preview") |
| 65 | + response_headers_preview = fields.Text(compute="_compute_headers_preview") |
| 66 | + request_content_type = fields.Char( |
| 67 | + compute="_compute_request_headers_derived", store=True |
| 68 | + ) |
| 69 | + request_content_length = fields.Integer( |
| 70 | + compute="_compute_request_headers_derived", store=True |
| 71 | + ) |
| 72 | + referrer = fields.Char(compute="_compute_request_headers_derived", store=True) |
| 73 | + response_content_type = fields.Char( |
| 74 | + compute="_compute_response_headers_derived", store=True |
| 75 | + ) |
| 76 | + response_content_length = fields.Integer( |
| 77 | + compute="_compute_response_headers_derived", store=True |
| 78 | + ) |
| 79 | + |
| 80 | + @api.model |
| 81 | + def _selection_collection_ref(self): |
| 82 | + return [] |
| 83 | + |
| 84 | + @api.depends( |
| 85 | + "collection_ref", |
| 86 | + ) |
| 87 | + def _compute_collection(self): |
| 88 | + for log in self: |
| 89 | + collection = log.collection_ref |
| 90 | + if collection: |
| 91 | + collection_model = collection._name |
| 92 | + collection_id = collection.id |
| 93 | + else: |
| 94 | + collection_model = False |
| 95 | + collection_id = False |
| 96 | + log.collection_model = collection_model |
| 97 | + log.collection_id = collection_id |
| 98 | + |
| 99 | + @api.model |
| 100 | + def _headers_hidden_keys(self): |
| 101 | + """Header keys that should not be logged. |
| 102 | +
|
| 103 | + They might contains sensitive data. |
| 104 | + """ |
| 105 | + return ( |
| 106 | + "Api-Key", |
| 107 | + "Cookie", |
| 108 | + ) |
| 109 | + |
| 110 | + @api.model |
| 111 | + def _sanitize_headers_dict(self, headers_dict): |
| 112 | + keys_to_hide = self._headers_hidden_keys() |
| 113 | + for key in headers_dict: |
| 114 | + if key in keys_to_hide: |
| 115 | + headers_dict[key] = "<redacted>" |
| 116 | + return headers_dict |
| 117 | + |
| 118 | + @api.model |
| 119 | + def _headers_to_dict(self, headers): |
| 120 | + headers_dict = {key: value for key, value in headers.items()} |
| 121 | + return self._sanitize_headers_dict(headers_dict) |
| 122 | + |
| 123 | + def _current_time(self): |
| 124 | + return time.time_ns() / 1e9 |
| 125 | + |
| 126 | + @api.model |
| 127 | + def _get_http_request(self, request): |
| 128 | + return request.httprequest |
| 129 | + |
| 130 | + @api.model |
| 131 | + def _get_request_body(self, request): |
| 132 | + """Take extra care with the request's body because it might get consumed.""" |
| 133 | + httprequest = self._get_http_request(request) |
| 134 | + return httprequest.data |
| 135 | + |
| 136 | + @api.model |
| 137 | + def _prepare_log_request(self, request): |
| 138 | + httprequest = self._get_http_request(request) |
| 139 | + log_request_values = { |
| 140 | + "request_url": httprequest.url, |
| 141 | + "request_method": httprequest.method, |
| 142 | + "request_headers": self._headers_to_dict(httprequest.headers), |
| 143 | + "request_body": self._get_request_body(request), |
| 144 | + "request_date": fields.Datetime.now(), |
| 145 | + "request_time": self._current_time(), |
| 146 | + } |
| 147 | + return log_request_values |
| 148 | + |
| 149 | + @api.model |
| 150 | + def log_request(self, request, override_log_values=None): |
| 151 | + log_request_values = self._prepare_log_request(request) |
| 152 | + log_request_values.update(override_log_values or {}) |
| 153 | + return self.sudo().create(log_request_values) |
| 154 | + |
| 155 | + def _inject_log_entry(self, values_dict): |
| 156 | + values_dict["API-Log-Entry-ID"] = str(self.id) |
| 157 | + return values_dict |
| 158 | + |
| 159 | + def _prepare_log_response(self, response): |
| 160 | + self._inject_log_entry(response.headers) |
| 161 | + headers_dict = self._headers_to_dict(response.headers) |
| 162 | + return { |
| 163 | + "response_status_code": response.status_code, |
| 164 | + "response_headers": headers_dict, |
| 165 | + "response_body": response.data, |
| 166 | + "response_date": fields.Datetime.now(), |
| 167 | + "response_time": self._current_time(), |
| 168 | + } |
| 169 | + |
| 170 | + def log_response(self, response): |
| 171 | + log_response_values = self._prepare_log_response(response) |
| 172 | + return self.sudo().write(log_response_values) |
| 173 | + |
| 174 | + def _prepare_log_exception(self, exception): |
| 175 | + exception.headers = getattr(exception, "headers", {}) |
| 176 | + values = { |
| 177 | + "stack_trace": "".join(format_exception(exception)), |
| 178 | + "response_headers": self._inject_log_entry(exception.headers), |
| 179 | + "response_body": str(exception), |
| 180 | + "response_date": fields.Datetime.now(), |
| 181 | + "response_time": self._current_time(), |
| 182 | + } |
| 183 | + |
| 184 | + if isinstance(exception, WerkzeugHTTPException): |
| 185 | + values.update( |
| 186 | + { |
| 187 | + "response_status_code": exception.code, |
| 188 | + "response_headers": self._headers_to_dict(exception.get_headers()), |
| 189 | + "response_body": exception.get_body(), |
| 190 | + } |
| 191 | + ) |
| 192 | + return values |
| 193 | + |
| 194 | + def log_exception(self, exception): |
| 195 | + try: |
| 196 | + exc_handling_response = self.env.registry["ir.http"]._handle_error( |
| 197 | + exception |
| 198 | + ) |
| 199 | + self.log_response(exc_handling_response) |
| 200 | + except Exception as handling_exception: |
| 201 | + exception = handling_exception |
| 202 | + log_exception_values = self._prepare_log_exception(exception) |
| 203 | + return self.sudo().write(log_exception_values) |
| 204 | + |
| 205 | + @api.depends("request_url", "request_method", "request_date") |
| 206 | + def _compute_name(self): |
| 207 | + for log in self: |
| 208 | + log.name = ( |
| 209 | + f"{log.request_date.isoformat()} - " |
| 210 | + f"[{log.request_method}] {log.request_url}" |
| 211 | + ) |
| 212 | + |
| 213 | + @api.depends("request_time", "response_time") |
| 214 | + def _compute_time(self): |
| 215 | + for log in self: |
| 216 | + if log.request_time and log.response_time: |
| 217 | + log.time = log.response_time - log.request_time |
| 218 | + else: |
| 219 | + log.time = 0 |
| 220 | + |
| 221 | + @api.depends("request_headers") |
| 222 | + def _compute_request_headers_derived(self): |
| 223 | + for log in self: |
| 224 | + headers = log.request_headers or {} |
| 225 | + log.request_content_type = headers.get("content-type", "") |
| 226 | + log.request_content_length = headers.get("content-length", 0) |
| 227 | + log.referrer = headers.get("referer", "") |
| 228 | + |
| 229 | + @api.depends("response_headers") |
| 230 | + def _compute_response_headers_derived(self): |
| 231 | + for log in self: |
| 232 | + headers = log.response_headers or {} |
| 233 | + log.response_content_type = headers.get("content-type", "") |
| 234 | + log.response_content_length = headers.get("content-length", 0) |
| 235 | + |
| 236 | + @api.depends("request_body") |
| 237 | + def _compute_request_preview(self): |
| 238 | + for log in self.with_context(bin_size=False): |
| 239 | + log.request_preview = log._body_preview(log.request_body) |
| 240 | + |
| 241 | + @api.depends("response_body") |
| 242 | + def _compute_response_preview(self): |
| 243 | + for log in self.with_context(bin_size=False): |
| 244 | + log.response_preview = log._body_preview(log.response_body) |
| 245 | + |
| 246 | + def _body_preview(self, body): |
| 247 | + # Display the first 1000 characters of the body if it's a text content |
| 248 | + body_preview = False |
| 249 | + if body: |
| 250 | + try: |
| 251 | + body_preview = body.decode("utf-8", errors="ignore") |
| 252 | + if len(body_preview) > 1000: |
| 253 | + body_preview = body_preview[:1000] + "...\n(...)" |
| 254 | + except UnicodeDecodeError: |
| 255 | + body_preview = False |
| 256 | + return body_preview |
| 257 | + |
| 258 | + @api.depends("request_headers", "response_headers") |
| 259 | + def _compute_headers_preview(self): |
| 260 | + for log in self: |
| 261 | + log.request_headers_preview = log._headers_preview(log.request_headers) |
| 262 | + log.response_headers_preview = log._headers_preview(log.response_headers) |
| 263 | + |
| 264 | + def _headers_preview(self, headers): |
| 265 | + return json.dumps(headers, sort_keys=True, indent=4) if headers else False |
| 266 | + |
| 267 | + @api.depends("request_body") |
| 268 | + def _compute_request_b64(self): |
| 269 | + for log in self: |
| 270 | + log.request_b64 = base64.b64encode(log.request_body or b"") |
| 271 | + |
| 272 | + @api.depends("response_body") |
| 273 | + def _compute_response_b64(self): |
| 274 | + for log in self: |
| 275 | + log.response_b64 = base64.b64encode(log.response_body or b"") |
0 commit comments