|
| 1 | +# Copyright 2025 Ledo Enterprises LLC |
| 2 | +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). |
| 3 | +""" |
| 4 | +Controller for cell writeback: edit list cells to update Odoo records. |
| 5 | +
|
| 6 | +The JS list cell-edit handler POSTs here with: |
| 7 | + spreadsheet_id — int |
| 8 | + model — str (e.g. "sale.order") |
| 9 | + record_id — int |
| 10 | + field_name — str (e.g. "name") |
| 11 | + new_value — any (JSON-decoded by Odoo's JSON-RPC dispatcher) |
| 12 | +
|
| 13 | +Returns a JSON-serialisable dict: |
| 14 | + {'success': True, 'old_value': str, 'new_value': str, 'log_id': int} |
| 15 | + or |
| 16 | + {'error': '<message>'} |
| 17 | +
|
| 18 | +All exceptions are caught so a writeback failure never results in a |
| 19 | +500 error reaching the browser. |
| 20 | +""" |
| 21 | + |
| 22 | +import logging |
| 23 | + |
| 24 | +from odoo import _ |
| 25 | +from odoo.exceptions import AccessError |
| 26 | +from odoo.http import Controller, request, route |
| 27 | + |
| 28 | +_logger = logging.getLogger(__name__) |
| 29 | + |
| 30 | + |
| 31 | +class SpreadsheetWriteback(Controller): |
| 32 | + @route( |
| 33 | + "/spreadsheet/writeback", |
| 34 | + type="json", |
| 35 | + auth="user", |
| 36 | + methods=["POST"], |
| 37 | + ) |
| 38 | + def writeback(self, spreadsheet_id, model, record_id, field_name, new_value): |
| 39 | + """ |
| 40 | + Write a single field value to an Odoo record on behalf of the |
| 41 | + spreadsheet's List cell-edit handler. |
| 42 | +
|
| 43 | + Security checks (in order): |
| 44 | + 1. spreadsheet.writeback_enabled must be True. |
| 45 | + 2. Current user must have read access on the spreadsheet record. |
| 46 | + 3. model must be a registered model in this environment. |
| 47 | + 4. The target record must exist. |
| 48 | + 5. Current user must have write access on the target record. |
| 49 | +
|
| 50 | + The old value is captured before the write and stored in the audit |
| 51 | + log. For relational fields str() is used which may not be |
| 52 | + directly re-writable; see the model docstring for details. |
| 53 | + """ |
| 54 | + log_vals_base = { |
| 55 | + "spreadsheet_id": spreadsheet_id, |
| 56 | + "res_model": model, |
| 57 | + "record_id": record_id, |
| 58 | + "field_name": field_name, |
| 59 | + "new_value": str(new_value), |
| 60 | + } |
| 61 | + |
| 62 | + try: |
| 63 | + # 1. Load spreadsheet and check writeback_enabled |
| 64 | + spreadsheet = request.env["spreadsheet.spreadsheet"].browse(spreadsheet_id) |
| 65 | + if not spreadsheet.exists(): |
| 66 | + return {"error": "Spreadsheet not found."} |
| 67 | + |
| 68 | + if not spreadsheet.writeback_enabled: |
| 69 | + return {"error": "Writeback not enabled for this spreadsheet."} |
| 70 | + |
| 71 | + # 2. Check spreadsheet read access |
| 72 | + try: |
| 73 | + spreadsheet.check_access("read") |
| 74 | + except AccessError: |
| 75 | + return {"error": "Access denied to spreadsheet."} |
| 76 | + |
| 77 | + # 3. Validate model |
| 78 | + if model not in request.env: |
| 79 | + return {"error": f"Model {model!r} is not available."} |
| 80 | + |
| 81 | + # 4. Load and check record existence |
| 82 | + record = request.env[model].browse(record_id) |
| 83 | + if not record.exists(): |
| 84 | + return {"error": f"Record {model}({record_id}) not found."} |
| 85 | + |
| 86 | + # 5. Check write access on the target record |
| 87 | + try: |
| 88 | + record.check_access("write") |
| 89 | + except AccessError: |
| 90 | + _logger.warning( |
| 91 | + "Writeback: user %d denied write on %s(%d)", |
| 92 | + request.env.uid, |
| 93 | + model, |
| 94 | + record_id, |
| 95 | + ) |
| 96 | + return {"error": "Access denied: no write access on record."} |
| 97 | + |
| 98 | + # 6. Validate field_name exists and is writable |
| 99 | + model_fields = request.env[model]._fields |
| 100 | + if field_name not in model_fields: |
| 101 | + return { |
| 102 | + "error": _( |
| 103 | + "Field %(field)s does not exist on model %(model)s.", |
| 104 | + field=field_name, |
| 105 | + model=model, |
| 106 | + ) |
| 107 | + } |
| 108 | + field_obj = model_fields[field_name] |
| 109 | + if field_obj.readonly or field_obj.compute: |
| 110 | + return { |
| 111 | + "error": _( |
| 112 | + "Field %(field)s on %(model)s is computed or readonly" |
| 113 | + " and cannot be written to.", |
| 114 | + field=field_name, |
| 115 | + model=model, |
| 116 | + ) |
| 117 | + } |
| 118 | + |
| 119 | + # Capture old value before writing |
| 120 | + old_value = record[field_name] |
| 121 | + old_value_str = str(old_value) |
| 122 | + |
| 123 | + # Perform the write |
| 124 | + record.write({field_name: new_value}) |
| 125 | + |
| 126 | + # Create audit log (sudo so the log can always be written |
| 127 | + # regardless of the user's access on spreadsheet.writeback.log) |
| 128 | + log = ( |
| 129 | + request.env["spreadsheet.writeback.log"] |
| 130 | + .sudo() |
| 131 | + .create( |
| 132 | + dict( |
| 133 | + log_vals_base, |
| 134 | + old_value=old_value_str, |
| 135 | + status="ok", |
| 136 | + ) |
| 137 | + ) |
| 138 | + ) |
| 139 | + |
| 140 | + # Post a brief chatter note on the spreadsheet |
| 141 | + spreadsheet.sudo().message_post( |
| 142 | + body=_( |
| 143 | + "Writeback: field <b>%(field)s</b> on " |
| 144 | + "<b>%(model)s</b> #%(record_id)d changed " |
| 145 | + "from <b>%(old)s</b> to <b>%(new)s</b>.", |
| 146 | + field=field_name, |
| 147 | + model=model, |
| 148 | + record_id=record_id, |
| 149 | + old=old_value_str, |
| 150 | + new=str(new_value), |
| 151 | + ), |
| 152 | + subtype_xmlid="mail.mt_note", |
| 153 | + ) |
| 154 | + |
| 155 | + return { |
| 156 | + "success": True, |
| 157 | + "old_value": old_value_str, |
| 158 | + "new_value": str(new_value), |
| 159 | + "log_id": log.id, |
| 160 | + } |
| 161 | + |
| 162 | + except Exception as exc: |
| 163 | + _logger.exception( |
| 164 | + "Writeback error: spreadsheet=%d model=%s record=%d field=%s", |
| 165 | + spreadsheet_id, |
| 166 | + model, |
| 167 | + record_id, |
| 168 | + field_name, |
| 169 | + ) |
| 170 | + # Attempt to write an error log (best effort — use sudo and |
| 171 | + # ignore any secondary failure so the route always returns JSON) |
| 172 | + try: |
| 173 | + request.env["spreadsheet.writeback.log"].sudo().create( |
| 174 | + dict( |
| 175 | + log_vals_base, |
| 176 | + status="error", |
| 177 | + error_message=str(exc)[:255], |
| 178 | + ) |
| 179 | + ) |
| 180 | + except Exception: |
| 181 | + _logger.exception("Failed to create writeback error log") |
| 182 | + |
| 183 | + return {"error": str(exc)} |
0 commit comments