Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ADD] dms_partner_attachment_link: add module #349

Open
wants to merge 4 commits into
base: 16.0
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 92 additions & 0 deletions dms_partner_attachment_link/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
====================================
DMS Partner related attachments Link
====================================

..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:a61f8d1ea1456465ff0a0f416e59e8ba923a39072c6350bdc369a5e0fc6f0870
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |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-OCA%2Fdms-lightgray.png?logo=github
:target: https://github.com/OCA/dms/tree/16.0/dms_partner_attachment_link
:alt: OCA/dms
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/dms-16-0/dms-16-0-dms_partner_attachment_link
: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/dms&target_branch=16.0
:alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

This module adds a DMS Attachment smart button to the partner form,
which opens a view containing a list of all DMS files stored in the
attachment storages and related to the Odoo records associated with the
selected partner.

**Table of contents**

.. contents::
:local:

Use Cases / Context
===================

Sometimes we need to collect all files related to a partner in one
place. In OCA DMS, we can collect at least the files stored in the
attachment storages.

Usage
=====

Open the partner form view and click the button to see a list of files
stored in the attachment stores and related to the current partner.

Known issues / Roadmap
======================

- Add related folders to the view

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/dms/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/dms/issues/new?body=module:%20dms_partner_attachment_link%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
-------

* Cetmix

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.

This module is part of the `OCA/dms <https://github.com/OCA/dms/tree/16.0/dms_partner_attachment_link>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
1 change: 1 addition & 0 deletions dms_partner_attachment_link/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
from . import models
19 changes: 19 additions & 0 deletions dms_partner_attachment_link/__manifest__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Copyright (C) 2024 Cetmix OÜ
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).


{
"name": "DMS Partner related attachments Link",
"summary": """
This module adds a button to the Partner form, linking to
related files stored in the attachment storage.
""",
"version": "16.0.1.0.0",
"license": "AGPL-3",
"author": "Cetmix, Odoo Community Association (OCA)",
"website": "https://github.com/OCA/dms",
"depends": ["dms"],
"data": [
"views/res_partner_views.xml",
],
}
1 change: 1 addition & 0 deletions dms_partner_attachment_link/models/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
from . import res_partner
106 changes: 106 additions & 0 deletions dms_partner_attachment_link/models/res_partner.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
# Copyright (C) 2024 Cetmix OÜ
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
from odoo import api, fields, models


class Partner(models.Model):
_inherit = "res.partner"

dms_file_ids = fields.Many2many(
comodel_name="dms.file",
string="DMS Attachments",
compute="_compute_dms_files",
)
dms_file_count = fields.Integer(compute="_compute_dms_files")

@api.model
def _get_partner_relations_in_models(self, models):
"""
Finds all m2o fields with comodel 'res.partner' in
a given list of models

:param models: List of model names
:type models: list[str]

:return: Dictionary where key is model name
and value is list of m2o field names
"""
partner_relations = {}

Check warning on line 28 in dms_partner_attachment_link/models/res_partner.py

View check run for this annotation

Codecov / codecov/patch

dms_partner_attachment_link/models/res_partner.py#L28

Added line #L28 was not covered by tests
for model in models:
fields = self.env[model]._fields

Check warning on line 30 in dms_partner_attachment_link/models/res_partner.py

View check run for this annotation

Codecov / codecov/patch

dms_partner_attachment_link/models/res_partner.py#L30

Added line #L30 was not covered by tests
partner_relations[model] = [
field_name
for field_name, field in fields.items()
if field.type == "many2one" and field.comodel_name == "res.partner"
]
return partner_relations

Check warning on line 36 in dms_partner_attachment_link/models/res_partner.py

View check run for this annotation

Codecov / codecov/patch

dms_partner_attachment_link/models/res_partner.py#L36

Added line #L36 was not covered by tests

@api.model
def _map_partner_dms_files(self, files: list, relations: dict):
"""
Map all found files to partner ids

:param files: List of attachment files
:type files: list[dict]
:param relations: Dictionary where key is model name
and value is list of m2o field names

:return: Dictionary where key is partner id
and value is list of file ids
"""
partner_files = {}

Check warning on line 51 in dms_partner_attachment_link/models/res_partner.py

View check run for this annotation

Codecov / codecov/patch

dms_partner_attachment_link/models/res_partner.py#L51

Added line #L51 was not covered by tests
for file in files:
if file["res_model"] == "res.partner":
if file["res_id"] not in partner_files:
partner_files[file["res_id"]] = []
partner_files[file["res_id"]].append(file["id"])

Check warning on line 56 in dms_partner_attachment_link/models/res_partner.py

View check run for this annotation

Codecov / codecov/patch

dms_partner_attachment_link/models/res_partner.py#L55-L56

Added lines #L55 - L56 were not covered by tests

elif file["res_model"] in relations:
linked_record = self.env[file["res_model"]].browse(file["res_id"])

Check warning on line 59 in dms_partner_attachment_link/models/res_partner.py

View check run for this annotation

Codecov / codecov/patch

dms_partner_attachment_link/models/res_partner.py#L59

Added line #L59 was not covered by tests
for field_name in relations[file["res_model"]]:
partner_id = linked_record[field_name].id

Check warning on line 61 in dms_partner_attachment_link/models/res_partner.py

View check run for this annotation

Codecov / codecov/patch

dms_partner_attachment_link/models/res_partner.py#L61

Added line #L61 was not covered by tests
if partner_id:
if partner_id not in partner_files:
partner_files[partner_id] = []
partner_files[partner_id].append(file["id"])

Check warning on line 65 in dms_partner_attachment_link/models/res_partner.py

View check run for this annotation

Codecov / codecov/patch

dms_partner_attachment_link/models/res_partner.py#L64-L65

Added lines #L64 - L65 were not covered by tests

partner_id = file["res_id"]

Check warning on line 67 in dms_partner_attachment_link/models/res_partner.py

View check run for this annotation

Codecov / codecov/patch

dms_partner_attachment_link/models/res_partner.py#L67

Added line #L67 was not covered by tests
if partner_id not in partner_files:
partner_files[partner_id] = []
partner_files[partner_id].append(file["id"])
return partner_files

Check warning on line 71 in dms_partner_attachment_link/models/res_partner.py

View check run for this annotation

Codecov / codecov/patch

dms_partner_attachment_link/models/res_partner.py#L69-L71

Added lines #L69 - L71 were not covered by tests

def _compute_dms_files(self):
"""
Compute DMS files
related to these partners
"""
dms_storage_obj = self.env["dms.storage"]
attachment_storages = dms_storage_obj.search([("save_type", "=", "attachment")])
attachment_files = attachment_storages.mapped("storage_file_ids").read(

Check warning on line 80 in dms_partner_attachment_link/models/res_partner.py

View check run for this annotation

Codecov / codecov/patch

dms_partner_attachment_link/models/res_partner.py#L78-L80

Added lines #L78 - L80 were not covered by tests
["res_id", "res_model"]
)
partner_relations = self._get_partner_relations_in_models(
list(set(map(lambda x: x["res_model"], attachment_files)))
)
partner_files = self._map_partner_dms_files(attachment_files, partner_relations)

Check warning on line 86 in dms_partner_attachment_link/models/res_partner.py

View check run for this annotation

Codecov / codecov/patch

dms_partner_attachment_link/models/res_partner.py#L86

Added line #L86 was not covered by tests
for partner in self:
partner.dms_file_ids = self.env["dms.file"].browse(

Check warning on line 88 in dms_partner_attachment_link/models/res_partner.py

View check run for this annotation

Codecov / codecov/patch

dms_partner_attachment_link/models/res_partner.py#L88

Added line #L88 was not covered by tests
partner_files.get(partner.id, [])
)
partner.dms_file_count = len(partner.dms_file_ids)

Check warning on line 91 in dms_partner_attachment_link/models/res_partner.py

View check run for this annotation

Codecov / codecov/patch

dms_partner_attachment_link/models/res_partner.py#L91

Added line #L91 was not covered by tests

def action_open_dms_attachments(self):
"""
Open action windows for DMS attachments
related to this partner

:return: Action Window
:rtype: dict
"""
self.ensure_one()
action = self.env.ref("dms.action_dms_file").read()[0]
action["domain"] = [

Check warning on line 103 in dms_partner_attachment_link/models/res_partner.py

View check run for this annotation

Codecov / codecov/patch

dms_partner_attachment_link/models/res_partner.py#L101-L103

Added lines #L101 - L103 were not covered by tests
("id", "in", self.dms_file_ids.ids),
]
return action

Check warning on line 106 in dms_partner_attachment_link/models/res_partner.py

View check run for this annotation

Codecov / codecov/patch

dms_partner_attachment_link/models/res_partner.py#L106

Added line #L106 was not covered by tests
1 change: 1 addition & 0 deletions dms_partner_attachment_link/readme/CONTEXT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Sometimes we need to collect all files related to a partner in one place. In OCA DMS, we can collect at least the files stored in the attachment storages.
1 change: 1 addition & 0 deletions dms_partner_attachment_link/readme/DESCRIPTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This module adds a DMS Attachment smart button to the partner form, which opens a view containing a list of all DMS files stored in the attachment storages and related to the Odoo records associated with the selected partner.
1 change: 1 addition & 0 deletions dms_partner_attachment_link/readme/ROADMAP.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* Add related folders to the view
1 change: 1 addition & 0 deletions dms_partner_attachment_link/readme/USAGE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Open the partner form view and click the button to see a list of files stored in the attachment stores and related to the current partner.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading