diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 47238b1507..c017e7255b 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -15,8 +15,8 @@ exclude: | # You don't usually want a bot to modify your legal texts (LICENSE.*|COPYING.*) default_language_version: - python: python3.8 node: "14.13.0" + python: python3.8 repos: - repo: local hooks: diff --git a/requirements.txt b/requirements.txt index 5f267f8cae..3243739914 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,5 @@ # generated from manifests external_dependencies +openupgradelib pdf2image python-stdnum pyzbar diff --git a/server_action_merge/README.rst b/server_action_merge/README.rst new file mode 100644 index 0000000000..cb5c2b32dd --- /dev/null +++ b/server_action_merge/README.rst @@ -0,0 +1,110 @@ +============= +Merge records +============= + +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Alpha-red.png + :target: https://odoo-community.org/page/development-status + :alt: Alpha +.. |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-OCA%2Fserver--ux-lightgray.png?logo=github + :target: https://github.com/OCA/server-ux/tree/13.0/server_action_merge + :alt: OCA/server-ux +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/server-ux-13-0/server-ux-13-0-server_action_merge + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/250/13.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module allows users to merge records of arbitrary models. + +.. IMPORTANT:: + This is an alpha version, the data model and design can change at any time without warning. + Only for development or testing purpose, do not use in production. + `More details on development status `_ + +**Table of contents** + +.. contents:: + :local: + +Configuration +============= + +To configure this module, you need to: + +#. Go to Settings/Technical/Server actions +#. Create a server action of type `Merge` (field `Action To Do`) +#. Click `Create Contextual Action` to make the action accessible for users + +Usage +===== + +To use this module, you need to: + +#. Go to a list view of a model for which you have created a merge server action +#. Mark at least two records and start your merge action +#. Select the record to merge into +#. Click `Merge` + +Known issues / Roadmap +====================== + +* add a cronjob that merges records based on some field(s) configured on the server action + +Bug Tracker +=========== + +Bugs are tracked on `GitHub Issues `_. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +~~~~~~~ + +* Hunki Enterprises BV + +Contributors +~~~~~~~~~~~~ + +* Holger Brunn (https://hunki-enterprises.com) + +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-hbrunn| image:: https://github.com/hbrunn.png?size=40px + :target: https://github.com/hbrunn + :alt: hbrunn + +Current `maintainer `__: + +|maintainer-hbrunn| + +This module is part of the `OCA/server-ux `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/server_action_merge/__init__.py b/server_action_merge/__init__.py new file mode 100644 index 0000000000..aee8895e7a --- /dev/null +++ b/server_action_merge/__init__.py @@ -0,0 +1,2 @@ +from . import models +from . import wizards diff --git a/server_action_merge/__manifest__.py b/server_action_merge/__manifest__.py new file mode 100644 index 0000000000..e4db6406e3 --- /dev/null +++ b/server_action_merge/__manifest__.py @@ -0,0 +1,18 @@ +# Copyright 2023 Hunki Enterprises BV +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl-3.0) + +{ + "name": "Merge records", + "summary": "Allows you to configure a wizard to merge records of arbitrary models", + "version": "13.0.1.0.0", + "development_status": "Alpha", + "category": "Extra Tools", + "website": "https://github.com/OCA/server-ux", + "author": "Hunki Enterprises BV, Odoo Community Association (OCA)", + "maintainers": ["hbrunn"], + "license": "AGPL-3", + "external_dependencies": {"python": ["openupgradelib"]}, + "depends": ["base"], + "data": ["wizards/server_action_merge_wizard.xml", "views/ir_actions_server.xml"], + "demo": ["demo/ir_actions_server.xml"], +} diff --git a/server_action_merge/demo/ir_actions_server.xml b/server_action_merge/demo/ir_actions_server.xml new file mode 100644 index 0000000000..36e1a5d479 --- /dev/null +++ b/server_action_merge/demo/ir_actions_server.xml @@ -0,0 +1,19 @@ + + + + + + Merge users + merge + + + + + + + diff --git a/server_action_merge/models/__init__.py b/server_action_merge/models/__init__.py new file mode 100644 index 0000000000..4ab5cb105f --- /dev/null +++ b/server_action_merge/models/__init__.py @@ -0,0 +1 @@ +from . import ir_actions_server diff --git a/server_action_merge/models/ir_actions_server.py b/server_action_merge/models/ir_actions_server.py new file mode 100644 index 0000000000..8d54cab754 --- /dev/null +++ b/server_action_merge/models/ir_actions_server.py @@ -0,0 +1,36 @@ +# Copyright 2023 Hunki Enterprises BV +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl-3.0) + + +from odoo import fields, models + + +class IrActionsServer(models.Model): + _inherit = "ir.actions.server" + + state = fields.Selection(selection_add=[("merge", "Merge records")]) + merge_method = fields.Selection( + [("orm", "ORM"), ("sql", "SQL")], default="orm", string="Merge method" + ) + merge_handling = fields.Selection( + [("delete", "Delete"), ("deactivate", "Deactivate"), ("none", "Do nothing")], + string="Merged records handling", + default="delete", + help="This determines what to do with records that have been merged into " + "another one, default is to delete them", + ) + merge_sudo = fields.Boolean("Run merge as superuser", default=False) + + def run_action_merge_multi(self, action, eval_context=None): + """Return the merge wizard""" + wizard = self.env["server.action.merge.wizard"].create({"action_id": action.id}) + wizard._onchange_line_ids() + return { + "type": "ir.actions.act_window", + "name": action.name, + "res_model": wizard._name, + "res_id": wizard.id, + "target": "new", + "view_mode": "form", + "context": self.env.context, + } diff --git a/server_action_merge/readme/CONFIGURE.rst b/server_action_merge/readme/CONFIGURE.rst new file mode 100644 index 0000000000..d59a4c6458 --- /dev/null +++ b/server_action_merge/readme/CONFIGURE.rst @@ -0,0 +1,5 @@ +To configure this module, you need to: + +#. Go to Settings/Technical/Server actions +#. Create a server action of type `Merge` (field `Action To Do`) +#. Click `Create Contextual Action` to make the action accessible for users diff --git a/server_action_merge/readme/CONTRIBUTORS.rst b/server_action_merge/readme/CONTRIBUTORS.rst new file mode 100644 index 0000000000..33b6eb2c3f --- /dev/null +++ b/server_action_merge/readme/CONTRIBUTORS.rst @@ -0,0 +1 @@ +* Holger Brunn (https://hunki-enterprises.com) diff --git a/server_action_merge/readme/DESCRIPTION.rst b/server_action_merge/readme/DESCRIPTION.rst new file mode 100644 index 0000000000..42c595e8b3 --- /dev/null +++ b/server_action_merge/readme/DESCRIPTION.rst @@ -0,0 +1 @@ +This module allows users to merge records of arbitrary models. diff --git a/server_action_merge/readme/ROADMAP.rst b/server_action_merge/readme/ROADMAP.rst new file mode 100644 index 0000000000..af00850771 --- /dev/null +++ b/server_action_merge/readme/ROADMAP.rst @@ -0,0 +1 @@ +* add a cronjob that merges records based on some field(s) configured on the server action diff --git a/server_action_merge/readme/USAGE.rst b/server_action_merge/readme/USAGE.rst new file mode 100644 index 0000000000..cdaa47588d --- /dev/null +++ b/server_action_merge/readme/USAGE.rst @@ -0,0 +1,6 @@ +To use this module, you need to: + +#. Go to a list view of a model for which you have created a merge server action +#. Mark at least two records and start your merge action +#. Select the record to merge into +#. Click `Merge` diff --git a/server_action_merge/readme/newsfragments/.gitkeep b/server_action_merge/readme/newsfragments/.gitkeep new file mode 100644 index 0000000000..e69de29bb2 diff --git a/server_action_merge/static/description/icon.png b/server_action_merge/static/description/icon.png new file mode 100644 index 0000000000..3a0328b516 Binary files /dev/null and b/server_action_merge/static/description/icon.png differ diff --git a/server_action_merge/static/description/index.html b/server_action_merge/static/description/index.html new file mode 100644 index 0000000000..f015155a6b --- /dev/null +++ b/server_action_merge/static/description/index.html @@ -0,0 +1,455 @@ + + + + + + +Merge records + + + +
+

Merge records

+ + +

Alpha License: AGPL-3 OCA/server-ux Translate me on Weblate Try me on Runbot

+

This module allows users to merge records of arbitrary models.

+
+

Important

+

This is an alpha version, the data model and design can change at any time without warning. +Only for development or testing purpose, do not use in production. +More details on development status

+
+

Table of contents

+ +
+

Configuration

+

To configure this module, you need to:

+
    +
  1. Go to Settings/Technical/Server actions
    2. +
  2. Create a server action of type Merge (field Action To Do)
    3. +
  3. Click Create Contextual Action to make the action accessible for users
    4. +
+
+
+

Usage

+

To use this module, you need to:

+
    +
  1. Go to a list view of a model for which you have created a merge server action
    2. +
  2. Mark at least two records and start your merge action
    3. +
  3. Select the record to merge into
    4. +
  4. Click Merge
    5. +
+
+
+

Known issues / Roadmap

+
    +
  • add a cronjob that merges records based on some field(s) configured on the server action
    • +
+
+
+

Bug Tracker

+

Bugs are tracked on GitHub Issues. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed +feedback.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • Hunki Enterprises BV
    • +
+
+ +
+

Maintainers

+

This module is maintained by the OCA.

+Odoo Community Association +

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.

+

Current maintainer:

+

hbrunn

+

This module is part of the OCA/server-ux project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ + diff --git a/server_action_merge/tests/__init__.py b/server_action_merge/tests/__init__.py new file mode 100644 index 0000000000..808782bdf0 --- /dev/null +++ b/server_action_merge/tests/__init__.py @@ -0,0 +1 @@ +from . import test_server_action_merge diff --git a/server_action_merge/tests/test_server_action_merge.py b/server_action_merge/tests/test_server_action_merge.py new file mode 100644 index 0000000000..4c83e87bc8 --- /dev/null +++ b/server_action_merge/tests/test_server_action_merge.py @@ -0,0 +1,54 @@ +# Copyright 2023 Hunki Enterprises BV +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl-3.0) + + +from odoo import exceptions +from odoo.tests.common import TransactionCase + + +class TestServerActionMerge(TransactionCase): + def setUp(self): + super().setUp() + self.user_demo = self.env.ref("base.user_demo") + self.user_demo.phone = False + self.user_test = self.env["res.users"].create( + {"login": "testuser", "name": "testuser", "phone": "from testuser"} + ) + self.partner_test = self.user_test.partner_id + + def _get_wizard(self, records, merge_action): + wizard_action = merge_action.with_context( + active_model=records._name, + active_id=records[:1].id, + active_ids=records.ids, + ).run() + return self.env[wizard_action["res_model"]].browse(wizard_action["res_id"]) + + def test_user_merge(self): + """Test we can merge users""" + wizard = self._get_wizard( + self.user_test + self.env.ref("base.user_demo"), + self.env.ref("server_action_merge.server_action_merge_users"), + ) + self.assertEqual(wizard.target_line_id.record, self.user_demo) + self.assertEqual(wizard.target_line_xmlid, "base.user_demo") + self.assertEqual(wizard.xmlid_count, 1) + wizard.action_id.groups_id = self.env.ref("base.group_portal") + with self.assertRaises(exceptions.AccessError): + wizard.action_merge() + wizard.action_id.groups_id = False + wizard.action_merge() + self.assertEqual(self.user_demo.phone, "from testuser") + self.assertFalse(self.user_test.exists()) + self.assertFalse(self.partner_test.exists()) + + def test_user_merge_deactivate(self): + action = self.env.ref("server_action_merge.server_action_merge_users") + action.merge_handling = "deactivate" + wizard = self._get_wizard( + self.user_test + self.env.ref("base.user_demo"), + self.env.ref("server_action_merge.server_action_merge_users"), + ) + wizard.action_merge() + self.assertTrue(self.user_test.exists()) + self.assertFalse(self.user_test.active) diff --git a/server_action_merge/views/ir_actions_server.xml b/server_action_merge/views/ir_actions_server.xml new file mode 100644 index 0000000000..fe9fb5ae24 --- /dev/null +++ b/server_action_merge/views/ir_actions_server.xml @@ -0,0 +1,26 @@ + + + + + + ir.actions.server + + + + + + + + + + + + + + + diff --git a/server_action_merge/wizards/__init__.py b/server_action_merge/wizards/__init__.py new file mode 100644 index 0000000000..73f11c09ff --- /dev/null +++ b/server_action_merge/wizards/__init__.py @@ -0,0 +1 @@ +from . import server_action_merge_wizard diff --git a/server_action_merge/wizards/server_action_merge_wizard.py b/server_action_merge/wizards/server_action_merge_wizard.py new file mode 100644 index 0000000000..c1a59dd8c0 --- /dev/null +++ b/server_action_merge/wizards/server_action_merge_wizard.py @@ -0,0 +1,151 @@ +# Copyright 2023 Hunki Enterprises BV +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl-3.0) + + +from openupgradelib.openupgrade_merge_records import merge_records + +from odoo import _, api, exceptions, fields, models + + +class ServerActionMergeWizard(models.TransientModel): + _name = "server.action.merge.wizard" + _description = "Merge records" + + action_id = fields.Many2one("ir.actions.server", required=True, ondelete="cascade") + model_id = fields.Many2one( + "ir.model", + default=lambda self: self.env["ir.model"].search( + [("model", "=", self.env.context.get("active_model"))] + ), + ondelte="cascade", + ) + target_line_id = fields.Many2one("server.action.merge.wizard.line", string="Target") + target_line_xmlid = fields.Char(related="target_line_id.xmlid") + line_ids = fields.One2many( + "server.action.merge.wizard.line", + "wizard_id", + string="Merge records", + required=True, + default=lambda self: self._default_line_ids(), + ) + xmlid_count = fields.Integer(compute="_compute_xmlid_count") + + def action_merge(self): + """Merge records in line_ids into the one selected in target_line_id""" + self.ensure_one() + if self.action_id.groups_id and not ( + self.action_id.groups_id & self.env.user.groups_id + ): + raise exceptions.AccessError( + _("You don't have enough access rights to run this action.") + ) + + records = self.line_ids.mapped("record") - self.target_line_id.record + self._merge_records(self.target_line_id.record, records) + + return { + "type": "ir.actions.act_window", + "name": _("Merge result"), + "res_model": self.target_line_id.record._name, + "res_id": self.target_line_id.record.id, + "view_mode": "form", + } + + def _merge_records(self, target, records, delete=True): + """Merge records, possibly merging records the model inherits from""" + to_delete = {} + for field_name in target._inherits.values(): + inherit_target = target[field_name] + inherit_records = records.mapped(field_name) - inherit_target + if inherit_target and inherit_records: + to_delete.update( + **self._merge_records(inherit_target, inherit_records, False) + ) + + merge_records( + self.env(*(self.env.args[:3] + tuple([self.action_id.merge_sudo]))), + records._name, + records.ids, + target.id, + method=self.action_id.merge_method, + delete=False, + model_table=records._table, + # TODO: allow this to be configured in the server action + field_spec={ + name: "first_not_null" + for name, field in target._fields.items() + if field.type == "char" + }, + ) + if self.action_id.merge_handling in ("delete", "deactivate"): + to_delete.setdefault(target._name, target.browse([])) + to_delete[target._name] += records + + if delete: + for records in to_delete.values(): + if self.action_id.merge_handling == "deactivate": + records.write({"active": False}) + else: + records.unlink() + + return to_delete + + def _default_line_ids(self): + active_model = self.env.context.get("active_model") + active_ids = self.env.context.get("active_ids", []) + return [ + (0, 0, {"record": "%s,%d" % (active_model, active_id)}) + for active_id in active_ids + if active_model + ] + + @api.depends("line_ids") + def _compute_xmlid_count(self): + for this in self: + this.xmlid_count = len(this.line_ids.filtered("xmlid")) + + @api.onchange("line_ids") + def _onchange_line_ids(self): + record = ( + self.target_line_id + if getattr(self.target_line_id.id, "origin", self.target_line_id.id) + in [getattr(record.id, "origin", record.id) for record in self.line_ids] + else self.line_ids.filtered("xmlid")[:1] or self.line_ids[:1] + ) + self.target_line_id = getattr(record.id, "origin", record.id or False) + + +class ServerActionMergeWizardLine(models.TransientModel): + _name = "server.action.merge.wizard.line" + _description = "Merge record line" + _rec_name = "record" + + sequence = fields.Integer("Sequence") + record = fields.Reference( + selection=lambda self: self.env["ir.model"] + .search([]) + .mapped(lambda model: (model.model, model.name)), + string="Record", + required=True, + readonly=True, + ) + wizard_id = fields.Many2one( + "server.action.merge.wizard", required=True, ondelete="cascade" + ) + xmlid = fields.Char("XMLID", compute="_compute_xmlid") + + @api.depends("record") + def _compute_xmlid(self): + for this in self: + this.xmlid = ( + self.env["ir.model.data"] + .search( + [ + ("module", "not like", "\\_\\_%\\_\\_"), + ("model", "=", this.record._name), + ("res_id", "=", this.record.id), + ], + limit=1, + ) + .complete_name + ) diff --git a/server_action_merge/wizards/server_action_merge_wizard.xml b/server_action_merge/wizards/server_action_merge_wizard.xml new file mode 100644 index 0000000000..63115f004d --- /dev/null +++ b/server_action_merge/wizards/server_action_merge_wizard.xml @@ -0,0 +1,56 @@ + + + + + + server.action.merge.wizard + +
+ + + + + + + + + + + + + + + + + +
 + + diff --git a/setup/server_action_merge/odoo/addons/server_action_merge b/setup/server_action_merge/odoo/addons/server_action_merge new file mode 120000 index 0000000000..e7eb40a18b --- /dev/null +++ b/setup/server_action_merge/odoo/addons/server_action_merge @@ -0,0 +1 @@ +../../../../server_action_merge \ No newline at end of file diff --git a/setup/server_action_merge/setup.py b/setup/server_action_merge/setup.py new file mode 100644 index 0000000000..28c57bb640 --- /dev/null +++ b/setup/server_action_merge/setup.py @@ -0,0 +1,6 @@ +import setuptools + +setuptools.setup( + setup_requires=['setuptools-odoo'], + odoo_addon=True, +)