[16.0][ADD] base_force_record_noupdate

pull/2946/head
SilvioC2C 2024-05-20 17:52:09 +02:00
parent f4562f612a
commit c3e9d49822
16 changed files with 724 additions and 0 deletions

View File

@ -0,0 +1,71 @@
======================
Force Record No-update
======================
..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:da312318da6a5b90118144f6d5b265f86380b4c6d6c26eb129b5a534839bdc0e
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |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-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-SilvioC2C%2Fserver--tools-lightgray.png?logo=github
:target: https://github.com/SilvioC2C/server-tools/tree/16.0-new-base_force_record_noupdate/base_force_record_noupdate
:alt: SilvioC2C/server-tools
|badge1| |badge2| |badge3|
This module adds a boolean field on models form view, allowing to force
``noupdate=True`` to data linked to those models.
Upon setting the field to ``True`` on a given model, ``noupdate=True`` will be set upon
existing data linked to it. When creating new data linked to that model, they will
always have ``noupdate=True`` (unless the field is reset on the model itself).
**Table of contents**
.. contents::
:local:
Usage
=====
To use this module, you need to open the models' form view and check field "Force No-Update"
Bug Tracker
===========
Bugs are tracked on `GitHub Issues <https://github.com/SilvioC2C/server-tools/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/SilvioC2C/server-tools/issues/new?body=module:%20base_force_record_noupdate%0Aversion:%2016.0-new-base_force_record_noupdate%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
~~~~~~~
* Camtocamp
Contributors
~~~~~~~~~~~~
* Italo Lopes <italo.lopes@camptocamp.com>
* Silvio Gregorini <silvio.gregorini@camptocamp.com>
Maintainers
~~~~~~~~~~~
This module is part of the `SilvioC2C/server-tools <https://github.com/SilvioC2C/server-tools/tree/16.0-new-base_force_record_noupdate/base_force_record_noupdate>`_ project on GitHub.
You are welcome to contribute.

View File

@ -0,0 +1,22 @@
from . import models
def post_init_hook(cr, registry):
"""Configure a list of models having ``force_noupdate`` set by default"""
from odoo import SUPERUSER_ID, api
env = api.Environment(cr, SUPERUSER_ID, {})
mods = env["ir.model"].sudo()
for model_name in [
"res.lang",
"ir.rule",
"ir.model.access",
"res.groups",
"mail.template",
"res.users.role", # Don't care if the module providing this is installed
]:
mod = env["ir.model"]._get(model_name)
if mod and mod.exists():
mods |= mod
if mods:
mods.write({"force_noupdate": True})

View File

@ -0,0 +1,16 @@
# Copyright 2024 Camptocamp (https://www.camptocamp.com).
# License LGPL-3.0 or later (https://www.gnu.org/licenses/lgpl.html)
{
"name": "Force Record No-update",
"summary": "Manually force noupdate=True on models",
"author": "Camtocamp, Odoo Community Association (OCA)",
"website": "https://github.com/OCA/server-tools",
"category": "Hidden",
"version": "16.0.1.0.0",
"license": "AGPL-3",
"depends": ["base"],
"data": ["views/ir_model.xml"],
"installable": True,
"post_init_hook": "post_init_hook",
}

View File

@ -0,0 +1,2 @@
from . import ir_model
from . import ir_model_data

View File

@ -0,0 +1,53 @@
# Copyright 2024 Camptocamp (https://www.camptocamp.com).
# License LGPL-3.0 or later (https://www.gnu.org/licenses/lgpl.html)
from odoo import api, fields, models
from odoo.tools.cache import ormcache
class Model(models.Model):
_inherit = "ir.model"
force_noupdate = fields.Boolean("Force No-Update")
@api.model_create_multi
def create(self, vals_list):
mods = super().create(vals_list)
type(self)._get_noupdate_model_ids.clear_cache(self.browse())
self._propagate_noupdate_to_model_data()
return mods
def write(self, vals):
res = super().write(vals)
if "force_noupdate" in vals:
type(self)._get_noupdate_model_ids.clear_cache(self.browse())
self._propagate_noupdate_to_model_data()
return res
def unlink(self):
res = super().unlink()
type(self)._get_noupdate_model_ids.clear_cache(self.browse())
return res
def _get_noupdate_models(self):
return self.browse(self._get_noupdate_model_ids())
@ormcache()
def _get_noupdate_model_ids(self):
return self.search([("force_noupdate", "=", True)]).ids
@api.model
def _propagate_noupdate_to_model_data(self):
noupdate = self._get_noupdate_models().mapped("model")
imd = self.env["ir.model.data"].sudo()
model_data = imd.search([("model", "in", noupdate), ("noupdate", "=", False)])
if model_data:
model_data.write({"noupdate": True})
def toggle_force_noupdate(self):
true_to_false = self.filtered("force_noupdate")
if true_to_false:
true_to_false.write({"force_noupdate": False})
false_to_true = self - true_to_false
if false_to_true:
false_to_true.write({"force_noupdate": True})

View File

@ -0,0 +1,18 @@
# Copyright 2024 Camptocamp (https://www.camptocamp.com).
# License LGPL-3.0 or later (https://www.gnu.org/licenses/lgpl.html)
from odoo import api, models
class IrModelData(models.Model):
_inherit = "ir.model.data"
@api.model_create_multi
def create(self, vals_list):
noupdate_models = self.env["ir.model"].sudo()._get_noupdate_models()
if noupdate_models:
noupdate_model_names = set(noupdate_models.mapped("model"))
for vals in vals_list:
if vals.get("model") in noupdate_model_names:
vals["noupdate"] = True
return super().create(vals_list)

View File

@ -0,0 +1,2 @@
* Italo Lopes <italo.lopes@camptocamp.com>
* Silvio Gregorini <silvio.gregorini@camptocamp.com>

View File

@ -0,0 +1,6 @@
This module adds a boolean field on models form view, allowing to force
``noupdate=True`` to data linked to those models.
Upon setting the field to ``True`` on a given model, ``noupdate=True`` will be set upon
existing data linked to it. When creating new data linked to that model, they will
always have ``noupdate=True`` (unless the field is reset on the model itself).

View File

@ -0,0 +1 @@
To use this module, you need to open the models' form view and check field "Force No-Update"

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.2 KiB

View File

@ -0,0 +1,425 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils: https://docutils.sourceforge.io/" />
<title>Force Record No-update</title>
<style type="text/css">
/*
:Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 8954 2022-01-20 10:10:25Z milde $
:Copyright: This stylesheet has been placed in the public domain.
Default cascading style sheet for the HTML output of Docutils.
See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/
/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
border: 0 }
table.borderless td, table.borderless th {
/* Override padding for "table.docutils td" with "! important".
The right padding separates the table cells. */
padding: 0 0.5em 0 0 ! important }
.first {
/* Override more specific margin styles with "! important". */
margin-top: 0 ! important }
.last, .with-subtitle {
margin-bottom: 0 ! important }
.hidden {
display: none }
.subscript {
vertical-align: sub;
font-size: smaller }
.superscript {
vertical-align: super;
font-size: smaller }
a.toc-backref {
text-decoration: none ;
color: black }
blockquote.epigraph {
margin: 2em 5em ; }
dl.docutils dd {
margin-bottom: 0.5em }
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
overflow: hidden;
}
/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
font-weight: bold }
*/
div.abstract {
margin: 2em 5em }
div.abstract p.topic-title {
font-weight: bold ;
text-align: center }
div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
margin: 2em ;
border: medium outset ;
padding: 1em }
div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
font-weight: bold ;
font-family: sans-serif }
div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title, .code .error {
color: red ;
font-weight: bold ;
font-family: sans-serif }
/* Uncomment (and remove this text!) to get reduced vertical space in
compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
margin-bottom: 0.5em }
div.compound .compound-last, div.compound .compound-middle {
margin-top: 0.5em }
*/
div.dedication {
margin: 2em 5em ;
text-align: center ;
font-style: italic }
div.dedication p.topic-title {
font-weight: bold ;
font-style: normal }
div.figure {
margin-left: 2em ;
margin-right: 2em }
div.footer, div.header {
clear: both;
font-size: smaller }
div.line-block {
display: block ;
margin-top: 1em ;
margin-bottom: 1em }
div.line-block div.line-block {
margin-top: 0 ;
margin-bottom: 0 ;
margin-left: 1.5em }
div.sidebar {
margin: 0 0 0.5em 1em ;
border: medium outset ;
padding: 1em ;
background-color: #ffffee ;
width: 40% ;
float: right ;
clear: right }
div.sidebar p.rubric {
font-family: sans-serif ;
font-size: medium }
div.system-messages {
margin: 5em }
div.system-messages h1 {
color: red }
div.system-message {
border: medium outset ;
padding: 1em }
div.system-message p.system-message-title {
color: red ;
font-weight: bold }
div.topic {
margin: 2em }
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
margin-top: 0.4em }
h1.title {
text-align: center }
h2.subtitle {
text-align: center }
hr.docutils {
width: 75% }
img.align-left, .figure.align-left, object.align-left, table.align-left {
clear: left ;
float: left ;
margin-right: 1em }
img.align-right, .figure.align-right, object.align-right, table.align-right {
clear: right ;
float: right ;
margin-left: 1em }
img.align-center, .figure.align-center, object.align-center {
display: block;
margin-left: auto;
margin-right: auto;
}
table.align-center {
margin-left: auto;
margin-right: auto;
}
.align-left {
text-align: left }
.align-center {
clear: both ;
text-align: center }
.align-right {
text-align: right }
/* reset inner alignment in figures */
div.align-right {
text-align: inherit }
/* div.align-center * { */
/* text-align: left } */
.align-top {
vertical-align: top }
.align-middle {
vertical-align: middle }
.align-bottom {
vertical-align: bottom }
ol.simple, ul.simple {
margin-bottom: 1em }
ol.arabic {
list-style: decimal }
ol.loweralpha {
list-style: lower-alpha }
ol.upperalpha {
list-style: upper-alpha }
ol.lowerroman {
list-style: lower-roman }
ol.upperroman {
list-style: upper-roman }
p.attribution {
text-align: right ;
margin-left: 50% }
p.caption {
font-style: italic }
p.credits {
font-style: italic ;
font-size: smaller }
p.label {
white-space: nowrap }
p.rubric {
font-weight: bold ;
font-size: larger ;
color: maroon ;
text-align: center }
p.sidebar-title {
font-family: sans-serif ;
font-weight: bold ;
font-size: larger }
p.sidebar-subtitle {
font-family: sans-serif ;
font-weight: bold }
p.topic-title {
font-weight: bold }
pre.address {
margin-bottom: 0 ;
margin-top: 0 ;
font: inherit }
pre.literal-block, pre.doctest-block, pre.math, pre.code {
margin-left: 2em ;
margin-right: 2em }
pre.code .ln { color: grey; } /* line numbers */
pre.code, code { background-color: #eeeeee }
pre.code .comment, code .comment { color: #5C6576 }
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
pre.code .literal.string, code .literal.string { color: #0C5404 }
pre.code .name.builtin, code .name.builtin { color: #352B84 }
pre.code .deleted, code .deleted { background-color: #DEB0A1}
pre.code .inserted, code .inserted { background-color: #A3D289}
span.classifier {
font-family: sans-serif ;
font-style: oblique }
span.classifier-delimiter {
font-family: sans-serif ;
font-weight: bold }
span.interpreted {
font-family: sans-serif }
span.option {
white-space: nowrap }
span.pre {
white-space: pre }
span.problematic {
color: red }
span.section-subtitle {
/* font-size relative to parent (h1..h6 element) */
font-size: 80% }
table.citation {
border-left: solid 1px gray;
margin-left: 1px }
table.docinfo {
margin: 2em 4em }
table.docutils {
margin-top: 0.5em ;
margin-bottom: 0.5em }
table.footnote {
border-left: solid 1px black;
margin-left: 1px }
table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
padding-left: 0.5em ;
padding-right: 0.5em ;
vertical-align: top }
table.docutils th.field-name, table.docinfo th.docinfo-name {
font-weight: bold ;
text-align: left ;
white-space: nowrap ;
padding-left: 0 }
/* "booktabs" style (no vertical lines) */
table.docutils.booktabs {
border: 0px;
border-top: 2px solid;
border-bottom: 2px solid;
border-collapse: collapse;
}
table.docutils.booktabs * {
border: 0px;
}
table.docutils.booktabs th {
border-bottom: thin solid;
text-align: left;
}
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
font-size: 100% }
ul.auto-toc {
list-style-type: none }
</style>
</head>
<body>
<div class="document" id="force-record-no-update">
<h1 class="title">Force Record No-update</h1>
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:da312318da6a5b90118144f6d5b265f86380b4c6d6c26eb129b5a534839bdc0e
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/SilvioC2C/server-tools/tree/16.0-new-base_force_record_noupdate/base_force_record_noupdate"><img alt="SilvioC2C/server-tools" src="https://img.shields.io/badge/github-SilvioC2C%2Fserver--tools-lightgray.png?logo=github" /></a></p>
<p>This module adds a boolean field on models form view, allowing to force
<tt class="docutils literal">noupdate=True</tt> to data linked to those models.</p>
<p>Upon setting the field to <tt class="docutils literal">True</tt> on a given model, <tt class="docutils literal">noupdate=True</tt> will be set upon
existing data linked to it. When creating new data linked to that model, they will
always have <tt class="docutils literal">noupdate=True</tt> (unless the field is reset on the model itself).</p>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#usage" id="toc-entry-1">Usage</a></li>
<li><a class="reference internal" href="#bug-tracker" id="toc-entry-2">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="toc-entry-3">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="toc-entry-4">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="toc-entry-5">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="toc-entry-6">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="usage">
<h1><a class="toc-backref" href="#toc-entry-1">Usage</a></h1>
<p>To use this module, you need to open the models form view and check field “Force No-Update”</p>
</div>
<div class="section" id="bug-tracker">
<h1><a class="toc-backref" href="#toc-entry-2">Bug Tracker</a></h1>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/SilvioC2C/server-tools/issues">GitHub Issues</a>.
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
<a class="reference external" href="https://github.com/SilvioC2C/server-tools/issues/new?body=module:%20base_force_record_noupdate%0Aversion:%2016.0-new-base_force_record_noupdate%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<p>Do not contact contributors directly about support or help with technical issues.</p>
</div>
<div class="section" id="credits">
<h1><a class="toc-backref" href="#toc-entry-3">Credits</a></h1>
<div class="section" id="authors">
<h2><a class="toc-backref" href="#toc-entry-4">Authors</a></h2>
<ul class="simple">
<li>Camtocamp</li>
</ul>
</div>
<div class="section" id="contributors">
<h2><a class="toc-backref" href="#toc-entry-5">Contributors</a></h2>
<ul class="simple">
<li>Italo Lopes &lt;<a class="reference external" href="mailto:italo.lopes&#64;camptocamp.com">italo.lopes&#64;camptocamp.com</a>&gt;</li>
<li>Silvio Gregorini &lt;<a class="reference external" href="mailto:silvio.gregorini&#64;camptocamp.com">silvio.gregorini&#64;camptocamp.com</a>&gt;</li>
</ul>
</div>
<div class="section" id="maintainers">
<h2><a class="toc-backref" href="#toc-entry-6">Maintainers</a></h2>
<p>This module is part of the <a class="reference external" href="https://github.com/SilvioC2C/server-tools/tree/16.0-new-base_force_record_noupdate/base_force_record_noupdate">SilvioC2C/server-tools</a> project on GitHub.</p>
<p>You are welcome to contribute.</p>
</div>
</div>
</div>
</body>
</html>

View File

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

View File

@ -0,0 +1,75 @@
# Copyright 2024 Camptocamp (https://www.camptocamp.com).
# License LGPL-3.0 or later (https://www.gnu.org/licenses/lgpl.html)
from odoo.tests import TransactionCase
MODULE = "base_force_record_noupdate"
class TestBaseForceRecordNoupdate(TransactionCase):
def test_00_test_model_create_noupdate_propagation(self):
# NB: we're only testing models created through UI, the feature is not
# supported yet for models created by the code itself
imd = self.env["ir.model.data"].create(
{
"module": MODULE,
"name": "test_ir_model_data_record",
"model": "x_my.model.test.00",
"noupdate": False,
}
)
self.env["ir.model"].create(
{
"name": "My Model Test 00",
"state": "manual",
"model": "x_my.model.test.00",
"force_noupdate": True,
}
)
self.assertTrue(imd.noupdate)
def test_01_test_model_write_noupdate_propagation(self):
my_model = self.env["ir.model"].create(
{
"name": "My Model Test 01",
"state": "manual",
"model": "x_my.model.test.01",
"force_noupdate": False,
}
)
imd = self.env["ir.model.data"].create(
{
"module": MODULE,
"name": "test_ir_model_data_record",
"model": "x_my.model.test.01",
"noupdate": False,
}
)
my_model.force_noupdate = True
self.assertTrue(imd.noupdate)
def test_02_test_model_data_create_noupdate(self):
self.env["ir.model"].create(
[
{
"name": f"My Model Test 02.{n}",
"state": "manual",
"model": f"x_my.model.test.02.{n}",
"force_noupdate": force_noupdate,
}
for n, force_noupdate in [(1, True), (2, False)]
]
)
imd1, imd2 = self.env["ir.model.data"].create(
[
{
"module": MODULE,
"name": f"test_ir_model_data_record_{n}",
"model": f"x_my.model.test.02.{n}",
"noupdate": False,
}
for n in (1, 2)
]
)
self.assertTrue(imd1.noupdate)
self.assertFalse(imd2.noupdate)

View File

@ -0,0 +1,25 @@
<?xml version="1.0" encoding="UTF-8" ?>
<odoo>
<record id="base_view_model_form_inherit" model="ir.ui.view">
<field name="model">ir.model</field>
<field name="inherit_id" ref="base.view_model_form" />
<field name="arch" type="xml">
<field name="transient" position="after">
<field name="force_noupdate" />
</field>
</field>
</record>
<record id="action_run_ir_action_todo" model="ir.actions.server">
<field name="name">Toggle Force Noupdate</field>
<field name="type">ir.actions.server</field>
<field name="model_id" ref="base.model_ir_model" />
<field name="state">code</field>
<field name="code">
if records:
records.toggle_force_noupdate()
</field>
</record>
</odoo>

View File

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

View File

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