Skip to content

Commit

Permalink
[ADD] Module multisearch_field
Browse files Browse the repository at this point in the history
  • Loading branch information
TB-Ph35 committed Nov 14, 2024
1 parent e0f9c79 commit 42d551e
Show file tree
Hide file tree
Showing 16 changed files with 745 additions and 0 deletions.
112 changes: 112 additions & 0 deletions multisearch_field/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
================================
Field MultiSearch with separator
================================

..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:4e881a9a949e292e686e878b42bcb228e59c8ba22eca33e3cf454f32c9b95e96
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |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%2Fserver--ux-lightgray.png?logo=github
:target: https://github.com/OCA/server-ux/tree/16.0/multisearch_field
: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-16-0/server-ux-16-0-multisearch_field
: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/server-ux&target_branch=16.0
:alt: Try me on Runboat

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

This module allows mulit_searching for all search.
For that, it add code before the search function.

It will allow you to search for multiple values separated by the character you
have configured.
* It will split the value like this:
[("name", "ilike","/Hart|perry;kelly")] => ['|', '|', '|', '|', '|' ("name", "ilike","Hart|perry;kelly"), ("name", "ilike","Hart|perry"), ("name", "ilike","Hart"), ("name", "ilike","perry;kelly"), ("name", "ilike","kelly"), ("name", "ilike","kelly"), ("name", "ilike", "/Hart|perry;kelly")]
**Table of contents**

.. contents::
:local:

Configuration
=============

To configure the separator you must:
* be in dev_mode
* go to Settings / technical / system parameter
* search multi_search_separator
* add/rm the separator
* available separators must be set like this : \|; for "|" and ";"
Usage
=====

To use mulit_search you must put an "/" before the value you want to search.
like this "/Kelly perry hart"
Do not put a separator between the first value and "/".

* Before:
searching "/kelly|perry;hart" in employee, will give a none result.

.. image:: https://raw.githubusercontent.com/OCA/server-ux/16.0/multisearch_field/static/description/img/Before_multi_search.png

* After:
Searching "/kelly|perry;hart" in employee, will give "Kelly", "Perry"
and "Hart"

.. image:: https://raw.githubusercontent.com/OCA/server-ux/16.0/multisearch_field/static/description/img/After_multi_search.png

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

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

* Akretion

Contributors
~~~~~~~~~~~~

* Akretion
* Thomas BONNERUE <[email protected]>
* Benoit GUILLOT <[email protected]>

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/server-ux <https://github.com/OCA/server-ux/tree/16.0/multisearch_field>`_ 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 multisearch_field/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
from . import monkeypatching
15 changes: 15 additions & 0 deletions multisearch_field/__manifest__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"name": "Field MultiSearch with separator",
"license": "AGPL-3",
"summary": "add modification on search to search multi_value with separator",
"version": "16.0.1.0.0",
"author": "Akretion, Odoo Community Association (OCA)",
"website": "https://github.com/OCA/server-ux",
"depends": [
"base",
],
"application": False,
"data": [
"data/multi_search_data.xml",
],
}
6 changes: 6 additions & 0 deletions multisearch_field/data/multi_search_data.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<odoo noupdate="1">
<record id="multi_search_separator" model="ir.config_parameter">
<field name="key">multi_search_separator</field>
<field name="value">|; ,</field>
</record>
</odoo>
54 changes: 54 additions & 0 deletions multisearch_field/monkeypatching.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Copyright 2024 Akretion (http://www.akretion.com).
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).

import re

from odoo.models import BaseModel
from odoo.osv import expression

search_original = BaseModel.search


def search(self, domain, offset=0, limit=None, order=None, count=False):
"""Override of the Python method to remove the dependency of the unit
fields"""
if self.env["ir.model.access"].check_access_rights("read", raise_exception=False):
list_separator = self.env["ir.config_parameter"].get_param(
"multi_search_separator"
)
else:
list_separator = False
if not list_separator or not domain:
return search_original(self, domain, offset, limit, order, count)

domain_list = []
domain_value = []
nlist_sep = []
for sep in list_separator:
nlist_sep.append(sep)
for dom in domain:
if (
len(dom) == 3
and isinstance(dom[2], str)
and dom[2].startswith("/")
and any(separator in dom[2] for separator in list_separator)
):
text_search = dom[2].replace("/", "", 1)
value_list = re.split("{}".format(nlist_sep), text_search)
value_list.append(text_search)
value_list.append(dom[2])
value_list_set = set(value_list)
for separator in list_separator:
value_list_set = value_list_set.union(text_search.split(separator))
for value in value_list_set:
domain_search_field = [(dom[0], dom[1], value)]
domain_value.append(domain_search_field)
else:
domain_list.append(dom)
if domain_value:
domain_list = expression.OR(domain_value)
res = search_original(self, domain_list, offset, limit, order, count)
return res


BaseModel.search = search
6 changes: 6 additions & 0 deletions multisearch_field/readme/CONFIGURE.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
To configure the separator you must:
* be in dev_mode
* go to Settings / technical / system parameter
* search multi_search_separator
* add/rm the separator
* available separators must be set like this : \|; for "|" and ";"
3 changes: 3 additions & 0 deletions multisearch_field/readme/CONTRIBUTORS.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
* Akretion
* Thomas BONNERUE <[email protected]>
* Benoit GUILLOT <[email protected]>
7 changes: 7 additions & 0 deletions multisearch_field/readme/DESCRIPTION.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
This module allows mulit_searching for all search.
For that, it add code before the search function.

It will allow you to search for multiple values separated by the character you
have configured.
* It will split the value like this:
[("name", "ilike","/Hart|perry;kelly")] => ['|', '|', '|', '|', '|' ("name", "ilike","Hart|perry;kelly"), ("name", "ilike","Hart|perry"), ("name", "ilike","Hart"), ("name", "ilike","perry;kelly"), ("name", "ilike","kelly"), ("name", "ilike","kelly"), ("name", "ilike", "/Hart|perry;kelly")]
14 changes: 14 additions & 0 deletions multisearch_field/readme/USAGE.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
To use mulit_search you must put an "/" before the value you want to search.
like this "/Kelly perry hart"
Do not put a separator between the first value and "/".

* Before:
searching "/kelly|perry;hart" in employee, will give a none result.

.. image:: ../static/description/img/Before_multi_search.png

* After:
Searching "/kelly|perry;hart" in employee, will give "Kelly", "Perry"
and "Hart"

.. image:: ../static/description/img/After_multi_search.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 42d551e

Please sign in to comment.