[IMP] base: move view related methods out of odoo/models.py
By definition, views are useless without the web client. The web client is in the module `web`. Therefore, in a perfect world, the `get_views` model method and any related method should be within the `web` module, as without it they are useless. Let's imagine you would like to use fully in command-line, without web client, all those view related methods are useless. Maybe excepted for reports, as you might still like to be able to print reports while using odoo fully in command line. Views related method therefore shouldn't be in `odoo/models.py`. Also, when you think about it, `get_views` related methods do not make sense without the model `ir.ui.view`, which is loaded after the `get_views` related methods, which also doesn't make sense. However, moving these methods fully in the `web` module is an harder work. For instance, there are base models, such as res.partner, already overriding `get_view` in the `base` module, and therefore relying on these view related methods. As a first step, we move view related methods direcly in the `odoo/addons/base/models/ir_ui_view.py` file, where the `ir.ui.view` model is loaded. This is not only a design / cleaning change, but a required change to be able to use content of `odoo.tools.config`, which is loaded after `odoo/models.py`. For instance, if you want to configure a conditional decorator based on the config `odoo.tools.config['dev_mode']`, it is not possible to do so in `odoo/models.py` because the config is parsed/loaded after `odoo/models.py`. The config is loaded here: https://github.com/odoo/odoo/blob/31de2b0a7a0921cab3c6c54045d15da46c8e6d8a/odoo/cli/server.py#L127 While, within the same file, `odoo/models.py` gets loaded through the `import odoo` https://github.com/odoo/odoo/blob/31de2b0a7a0921cab3c6c54045d15da46c8e6d8a/odoo/cli/server.py#L26 And we would like to put such a decorator based on `odoo.tools.config['dev_mode']` on `_get_view_cache`, to not cache the back-end views when `--dev xml` is passed in the server arguments. X-original-commit: 0901adc38a724aec75676285977f1905a84ed8ee Part-of: odoo/odoo#102117
This commit is contained in:
Denis Ledoux
@@ -20,7 +20,7 @@ from lxml.builder import E
|
||||
|
||||
import odoo
|
||||
from odoo import api, fields, models, tools, _
|
||||
from odoo.exceptions import ValidationError, AccessError
|
||||
from odoo.exceptions import ValidationError, AccessError, UserError
|
||||
from odoo.http import request
|
||||
from odoo.modules.module import get_resource_from_path, get_resource_path
|
||||
from odoo.tools import config, ConstantMapping, get_diff, pycompat, apply_inheritance_specs, locate_node, str2bool
|
||||
@@ -2244,6 +2244,529 @@ class ResetViewArchWizard(models.TransientModel):
|
||||
return {'type': 'ir.actions.act_window_close'}
|
||||
|
||||
|
||||
class Model(models.AbstractModel):
|
||||
_inherit = 'base'
|
||||
|
||||
_date_name = 'date' #: field to use for default calendar view
|
||||
|
||||
def _get_access_action(self, access_uid=None, force_website=False):
|
||||
""" Return an action to open the document. This method is meant to be
|
||||
overridden in addons that want to give specific access to the document.
|
||||
By default, it opens the formview of the document.
|
||||
|
||||
:param integer access_uid: optional access_uid being the user that
|
||||
accesses the document. May be different from the current user as we
|
||||
may compute an access for someone else.
|
||||
:param integer force_website: force frontend redirection if available
|
||||
on self. Used in overrides, notably with portal / website addons.
|
||||
"""
|
||||
self.ensure_one()
|
||||
return self.get_formview_action(access_uid=access_uid)
|
||||
|
||||
@api.model
|
||||
def get_empty_list_help(self, help_message):
|
||||
""" Hook method to customize the help message in empty list/kanban views.
|
||||
|
||||
By default, it returns the help received as parameter.
|
||||
|
||||
:param str help: ir.actions.act_window help content
|
||||
:return: help message displayed when there is no result to display
|
||||
in a list/kanban view (by default, it returns the action help)
|
||||
:rtype: str
|
||||
"""
|
||||
return help_message
|
||||
|
||||
#
|
||||
# Override this method if you need a window title that depends on the context
|
||||
#
|
||||
@api.model
|
||||
def view_header_get(self, view_id=None, view_type='form'):
|
||||
return False
|
||||
|
||||
@api.model
|
||||
def _get_default_form_view(self):
|
||||
""" Generates a default single-line form view using all fields
|
||||
of the current model.
|
||||
|
||||
:returns: a form view as an lxml document
|
||||
:rtype: etree._Element
|
||||
"""
|
||||
group = E.group(col="4")
|
||||
for fname, field in self._fields.items():
|
||||
if field.automatic:
|
||||
continue
|
||||
elif field.type in ('one2many', 'many2many', 'text', 'html'):
|
||||
group.append(E.newline())
|
||||
group.append(E.field(name=fname, colspan="4"))
|
||||
group.append(E.newline())
|
||||
else:
|
||||
group.append(E.field(name=fname))
|
||||
group.append(E.separator())
|
||||
return E.form(E.sheet(group, string=self._description))
|
||||
|
||||
@api.model
|
||||
def _get_default_search_view(self):
|
||||
""" Generates a single-field search view, based on _rec_name.
|
||||
|
||||
:returns: a tree view as an lxml document
|
||||
:rtype: etree._Element
|
||||
"""
|
||||
element = E.field(name=self._rec_name_fallback())
|
||||
return E.search(element, string=self._description)
|
||||
|
||||
@api.model
|
||||
def _get_default_tree_view(self):
|
||||
""" Generates a single-field tree view, based on _rec_name.
|
||||
|
||||
:returns: a tree view as an lxml document
|
||||
:rtype: etree._Element
|
||||
"""
|
||||
element = E.field(name=self._rec_name_fallback())
|
||||
return E.tree(element, string=self._description)
|
||||
|
||||
@api.model
|
||||
def _get_default_pivot_view(self):
|
||||
""" Generates an empty pivot view.
|
||||
|
||||
:returns: a pivot view as an lxml document
|
||||
:rtype: etree._Element
|
||||
"""
|
||||
return E.pivot(string=self._description)
|
||||
|
||||
@api.model
|
||||
def _get_default_kanban_view(self):
|
||||
""" Generates a single-field kanban view, based on _rec_name.
|
||||
|
||||
:returns: a kanban view as an lxml document
|
||||
:rtype: etree._Element
|
||||
"""
|
||||
|
||||
field = E.field(name=self._rec_name_fallback())
|
||||
content_div = E.div(field, {'class': "o_kanban_card_content"})
|
||||
card_div = E.div(content_div, {'t-attf-class': "oe_kanban_card oe_kanban_global_click"})
|
||||
kanban_box = E.t(card_div, {'t-name': "kanban-box"})
|
||||
templates = E.templates(kanban_box)
|
||||
return E.kanban(templates, string=self._description)
|
||||
|
||||
@api.model
|
||||
def _get_default_graph_view(self):
|
||||
""" Generates a single-field graph view, based on _rec_name.
|
||||
|
||||
:returns: a graph view as an lxml document
|
||||
:rtype: etree._Element
|
||||
"""
|
||||
element = E.field(name=self._rec_name_fallback())
|
||||
return E.graph(element, string=self._description)
|
||||
|
||||
@api.model
|
||||
def _get_default_calendar_view(self):
|
||||
""" Generates a default calendar view by trying to infer
|
||||
calendar fields from a number of pre-set attribute names
|
||||
|
||||
:returns: a calendar view
|
||||
:rtype: etree._Element
|
||||
"""
|
||||
def set_first_of(seq, in_, to):
|
||||
"""Sets the first value of ``seq`` also found in ``in_`` to
|
||||
the ``to`` attribute of the ``view`` being closed over.
|
||||
|
||||
Returns whether it's found a suitable value (and set it on
|
||||
the attribute) or not
|
||||
"""
|
||||
for item in seq:
|
||||
if item in in_:
|
||||
view.set(to, item)
|
||||
return True
|
||||
return False
|
||||
|
||||
view = E.calendar(string=self._description)
|
||||
view.append(E.field(name=self._rec_name_fallback()))
|
||||
|
||||
if not set_first_of([self._date_name, 'date', 'date_start', 'x_date', 'x_date_start'],
|
||||
self._fields, 'date_start'):
|
||||
raise UserError(_("Insufficient fields for Calendar View!"))
|
||||
|
||||
set_first_of(["user_id", "partner_id", "x_user_id", "x_partner_id"],
|
||||
self._fields, 'color')
|
||||
|
||||
if not set_first_of(["date_stop", "date_end", "x_date_stop", "x_date_end"],
|
||||
self._fields, 'date_stop'):
|
||||
if not set_first_of(["date_delay", "planned_hours", "x_date_delay", "x_planned_hours"],
|
||||
self._fields, 'date_delay'):
|
||||
raise UserError(_(
|
||||
"Insufficient fields to generate a Calendar View for %s, missing a date_stop or a date_delay",
|
||||
self._name
|
||||
))
|
||||
|
||||
return view
|
||||
|
||||
@api.model
|
||||
def get_views(self, views, options=None):
|
||||
""" Returns the fields_views of given views, along with the fields of
|
||||
the current model, and optionally its filters for the given action.
|
||||
|
||||
:param views: list of [view_id, view_type]
|
||||
:param dict options: a dict optional boolean flags, set to enable:
|
||||
|
||||
``toolbar``
|
||||
includes contextual actions when loading fields_views
|
||||
``load_filters``
|
||||
returns the model's filters
|
||||
``action_id``
|
||||
id of the action to get the filters, otherwise loads the global
|
||||
filters or the model
|
||||
|
||||
:return: dictionary with fields_views, fields and optionally filters
|
||||
"""
|
||||
options = options or {}
|
||||
result = {}
|
||||
|
||||
result['views'] = {
|
||||
v_type: self.get_view(
|
||||
v_id, v_type if v_type != 'list' else 'tree',
|
||||
**options
|
||||
)
|
||||
for [v_id, v_type] in views
|
||||
}
|
||||
|
||||
models = {}
|
||||
for view in result['views'].values():
|
||||
for model, model_fields in view.pop('models').items():
|
||||
models.setdefault(model, set()).update(model_fields)
|
||||
|
||||
result['models'] = {}
|
||||
|
||||
for model, model_fields in models.items():
|
||||
result['models'][model] = self.env[model].fields_get(
|
||||
allfields=model_fields, attributes=self._get_view_field_attributes()
|
||||
)
|
||||
|
||||
# Add related action information if asked
|
||||
if options.get('toolbar'):
|
||||
for view in result['views'].values():
|
||||
view['toolbar'] = {}
|
||||
|
||||
bindings = self.env['ir.actions.actions'].get_bindings(self._name)
|
||||
for action_type, key in (('report', 'print'), ('action', 'action')):
|
||||
for action in bindings.get(action_type, []):
|
||||
view_types = (
|
||||
action['binding_view_types'].split(',')
|
||||
if action.get('binding_view_types')
|
||||
else result['views'].keys()
|
||||
)
|
||||
for view_type in view_types:
|
||||
view_type = view_type if view_type != 'tree' else 'list'
|
||||
if view_type in result['views']:
|
||||
result['views'][view_type]['toolbar'].setdefault(key, []).append(action)
|
||||
|
||||
if options.get('load_filters') and 'search' in result['views']:
|
||||
result['views']['search']['filters'] = self.env['ir.filters'].get_filters(
|
||||
self._name, options.get('action_id')
|
||||
)
|
||||
|
||||
return result
|
||||
|
||||
@api.model
|
||||
def _get_view(self, view_id=None, view_type='form', **options):
|
||||
"""_get_view([view_id | view_type='form'])
|
||||
|
||||
Get the model view combined architecture (the view along all its inheriting views).
|
||||
|
||||
:param int view_id: id of the view or None
|
||||
:param str view_type: type of the view to return if view_id is None ('form', 'tree', ...)
|
||||
:param dict options: bool options to return additional features:
|
||||
- bool mobile: true if the web client is currently using the responsive mobile view
|
||||
(to use kanban views instead of list views for x2many fields)
|
||||
:return: architecture of the view as an etree node, and the browse record of the view used
|
||||
:rtype: tuple
|
||||
:raise AttributeError:
|
||||
|
||||
* if no view exists for that model, and no method `_get_default_[view_type]_view` exists for the view type
|
||||
|
||||
"""
|
||||
View = self.env['ir.ui.view'].sudo()
|
||||
|
||||
# try to find a view_id if none provided
|
||||
if not view_id:
|
||||
# <view_type>_view_ref in context can be used to override the default view
|
||||
view_ref_key = view_type + '_view_ref'
|
||||
view_ref = self._context.get(view_ref_key)
|
||||
if view_ref:
|
||||
if '.' in view_ref:
|
||||
module, view_ref = view_ref.split('.', 1)
|
||||
query = "SELECT res_id FROM ir_model_data WHERE model='ir.ui.view' AND module=%s AND name=%s"
|
||||
self._cr.execute(query, (module, view_ref))
|
||||
view_ref_res = self._cr.fetchone()
|
||||
if view_ref_res:
|
||||
view_id = view_ref_res[0]
|
||||
else:
|
||||
_logger.warning(
|
||||
'%r requires a fully-qualified external id (got: %r for model %s). '
|
||||
'Please use the complete `module.view_id` form instead.', view_ref_key, view_ref,
|
||||
self._name
|
||||
)
|
||||
|
||||
if not view_id:
|
||||
# otherwise try to find the lowest priority matching ir.ui.view
|
||||
view_id = View.default_view(self._name, view_type)
|
||||
|
||||
if view_id:
|
||||
# read the view with inherited views applied
|
||||
view = View.browse(view_id)
|
||||
arch = view._get_combined_arch()
|
||||
else:
|
||||
# fallback on default views methods if no ir.ui.view could be found
|
||||
view = View.browse()
|
||||
try:
|
||||
arch = getattr(self, '_get_default_%s_view' % view_type)()
|
||||
except AttributeError:
|
||||
raise UserError(_("No default view of type '%s' could be found !", view_type))
|
||||
return arch, view
|
||||
|
||||
@api.model
|
||||
def _get_view_cache_key(self, view_id=None, view_type='form', **options):
|
||||
""" Get the key to use for caching `_get_view_cache`.
|
||||
|
||||
This method is meant to be overriden by models needing additional keys.
|
||||
|
||||
:param int view_id: id of the view or None
|
||||
:param str view_type: type of the view to return if view_id is None ('form', 'tree', ...)
|
||||
:param dict options: bool options to return additional features:
|
||||
- bool mobile: true if the web client is currently using the responsive mobile view
|
||||
(to use kanban views instead of list views for x2many fields)
|
||||
:return: a cache key
|
||||
:rtype: tuple
|
||||
"""
|
||||
return (view_id, view_type, options.get('mobile'), self.env.lang) + tuple(
|
||||
(key, value) for key, value in self.env.context.items() if key.endswith('_view_ref')
|
||||
)
|
||||
|
||||
@api.model
|
||||
@tools.ormcache('self._get_view_cache_key(view_id, view_type, **options)')
|
||||
def _get_view_cache(self, view_id=None, view_type='form', **options):
|
||||
""" Get the view information ready to be cached
|
||||
|
||||
The cached view includes the postprocessed view, including inherited views, for all groups.
|
||||
The blocks restricted to groups must therefore be removed after calling this method
|
||||
for users not part of the given groups.
|
||||
|
||||
:param int view_id: id of the view or None
|
||||
:param str view_type: type of the view to return if view_id is None ('form', 'tree', ...)
|
||||
:param dict options: boolean options to return additional features:
|
||||
- bool mobile: true if the web client is currently using the responsive mobile view
|
||||
(to use kanban views instead of list views for x2many fields)
|
||||
:return: a dictionnary including
|
||||
- string arch: the architecture of the view (including inherited views, postprocessed, for all groups)
|
||||
- int id: the view id
|
||||
- string model: the view model
|
||||
- dict models: the fields of the models used in the view (including sub-views)
|
||||
:rtype: dict
|
||||
"""
|
||||
# Get the view arch and all other attributes describing the composition of the view
|
||||
arch, view = self._get_view(view_id, view_type, **options)
|
||||
|
||||
# Apply post processing, groups and modifiers etc...
|
||||
arch, models = view.postprocess_and_fields(arch, model=self._name, **options)
|
||||
models = self._get_view_fields(view_type or view.type, models)
|
||||
result = {
|
||||
'arch': arch,
|
||||
# TODO: only `web_studio` seems to require this. I guess this is acceptable to keep it.
|
||||
'id': view.id,
|
||||
# TODO: only `web_studio` seems to require this. But this one on the other hand should be eliminated:
|
||||
# you just called `get_views` for that model, so obviously the web client already knows the model.
|
||||
'model': self._name,
|
||||
# Set a frozendict and tuple for the field list to make sure the value in cache cannot be updated.
|
||||
'models': frozendict({model: tuple(fields) for model, fields in models.items()}),
|
||||
}
|
||||
|
||||
return frozendict(result)
|
||||
|
||||
@api.model
|
||||
def get_view(self, view_id=None, view_type='form', **options):
|
||||
""" get_view([view_id | view_type='form'])
|
||||
|
||||
Get the detailed composition of the requested view like model, view architecture
|
||||
|
||||
:param int view_id: id of the view or None
|
||||
:param str view_type: type of the view to return if view_id is None ('form', 'tree', ...)
|
||||
:param dict options: boolean options to return additional features:
|
||||
- bool mobile: true if the web client is currently using the responsive mobile view
|
||||
(to use kanban views instead of list views for x2many fields)
|
||||
:return: composition of the requested view (including inherited views and extensions)
|
||||
:rtype: dict
|
||||
:raise AttributeError:
|
||||
|
||||
* if the inherited view has unknown position to work with other than 'before', 'after', 'inside', 'replace'
|
||||
* if some tag other than 'position' is found in parent view
|
||||
|
||||
:raise Invalid ArchitectureError: if there is view type other than form, tree, calendar, search etc... defined on the structure
|
||||
"""
|
||||
self.check_access_rights('read')
|
||||
|
||||
result = dict(self._get_view_cache(view_id, view_type, **options))
|
||||
|
||||
node = etree.fromstring(result['arch'])
|
||||
node = self.env['ir.ui.view']._postprocess_access_rights(node)
|
||||
node = self.env['ir.ui.view']._postprocess_context_dependent(node)
|
||||
result['arch'] = etree.tostring(node, encoding="unicode").replace('\t', '')
|
||||
|
||||
return result
|
||||
|
||||
@api.model
|
||||
def _get_view_fields(self, view_type, models):
|
||||
""" Returns the field names required by the web client to load the views according to the view type.
|
||||
|
||||
The method is meant to be overridden by modules extending web client features and requiring additional
|
||||
fields.
|
||||
|
||||
:param string view_type: type of the view
|
||||
:param dict models: dict holding the models and fields used in the view architecture.
|
||||
:return: dict holding the models and field required by the web client given the view type.
|
||||
:rtype: list
|
||||
"""
|
||||
if view_type in ('kanban', 'tree', 'form'):
|
||||
for model_fields in models.values():
|
||||
model_fields.update({'id', self.CONCURRENCY_CHECK_FIELD})
|
||||
elif view_type == 'search':
|
||||
models[self._name] = list(self._fields.keys())
|
||||
elif view_type == 'graph':
|
||||
models[self._name].union(fname for fname, field in self._fields.items() if field.type in ('integer', 'float'))
|
||||
elif view_type == 'pivot':
|
||||
models[self._name].union(fname for fname, field in self._fields.items() if field.groupable)
|
||||
return models
|
||||
|
||||
@api.model
|
||||
def _get_view_field_attributes(self):
|
||||
""" Returns the field attributes required by the web client to load the views.
|
||||
|
||||
The method is meant to be overridden by modules extending web client features and requiring additional
|
||||
field attributes.
|
||||
|
||||
:return: string list of field attribute names
|
||||
:rtype: list
|
||||
"""
|
||||
return [
|
||||
'context', 'currency_field', 'definition_record', 'digits', 'domain', 'group_operator', 'groups', 'help',
|
||||
'name', 'readonly', 'related', 'relation', 'relation_field', 'required', 'searchable', 'selection', 'size',
|
||||
'sortable', 'store', 'string', 'translate', 'trim', 'type',
|
||||
]
|
||||
|
||||
@api.model
|
||||
def load_views(self, views, options=None):
|
||||
warnings.warn(
|
||||
'`load_views` method is deprecated, use `get_views` instead',
|
||||
DeprecationWarning, stacklevel=2,
|
||||
)
|
||||
return self.get_views(views, options=options)
|
||||
|
||||
@api.model
|
||||
def _fields_view_get(self, view_id=None, view_type='form', toolbar=False, submenu=False):
|
||||
warnings.warn(
|
||||
'Method `_fields_view_get` is deprecated, use `_get_view` instead',
|
||||
DeprecationWarning, stacklevel=2,
|
||||
)
|
||||
arch, view = self._get_view(view_id, view_type, toolbar=toolbar, submenu=submenu)
|
||||
result = {
|
||||
'arch': etree.tostring(arch, encoding='unicode'),
|
||||
'model': self._name,
|
||||
'field_parent': False,
|
||||
}
|
||||
if view:
|
||||
result['name'] = view.name
|
||||
result['type'] = view.type
|
||||
result['view_id'] = view.id
|
||||
result['field_parent'] = view.field_parent
|
||||
result['base_model'] = view.model
|
||||
else:
|
||||
result['type'] = view_type
|
||||
result['name'] = 'default'
|
||||
return result
|
||||
|
||||
@api.model
|
||||
def fields_view_get(self, view_id=None, view_type='form', toolbar=False, submenu=False):
|
||||
"""
|
||||
.. deprecated:: saas-15.4
|
||||
|
||||
Use :meth:`~odoo.models.Model.get_view()` instead.
|
||||
"""
|
||||
warnings.warn(
|
||||
'Method `fields_view_get` is deprecated, use `get_view` instead',
|
||||
DeprecationWarning, stacklevel=2,
|
||||
)
|
||||
result = self.get_views([(view_id, view_type)], {'toolbar': toolbar, 'submenu': submenu})['views'][view_type]
|
||||
node = etree.fromstring(result['arch'])
|
||||
view_fields = set(el.get('name') for el in node.xpath('.//field[not(ancestor::field)]'))
|
||||
result['fields'] = self.fields_get(view_fields)
|
||||
result.pop('models', None)
|
||||
if 'id' in result:
|
||||
view = self.env['ir.ui.view'].sudo().browse(result.pop('id'))
|
||||
result['name'] = view.name
|
||||
result['type'] = view.type
|
||||
result['view_id'] = view.id
|
||||
result['field_parent'] = view.field_parent
|
||||
result['base_model'] = view.model
|
||||
else:
|
||||
result['type'] = view_type
|
||||
result['name'] = 'default'
|
||||
result['field_parent'] = False
|
||||
return result
|
||||
|
||||
def get_formview_id(self, access_uid=None):
|
||||
""" Return a view id to open the document ``self`` with. This method is
|
||||
meant to be overridden in addons that want to give specific view ids
|
||||
for example.
|
||||
|
||||
Optional access_uid holds the user that would access the form view
|
||||
id different from the current environment user.
|
||||
"""
|
||||
return False
|
||||
|
||||
def get_formview_action(self, access_uid=None):
|
||||
""" Return an action to open the document ``self``. This method is meant
|
||||
to be overridden in addons that want to give specific view ids for
|
||||
example.
|
||||
|
||||
An optional access_uid holds the user that will access the document
|
||||
that could be different from the current user. """
|
||||
view_id = self.sudo().get_formview_id(access_uid=access_uid)
|
||||
return {
|
||||
'type': 'ir.actions.act_window',
|
||||
'res_model': self._name,
|
||||
'view_type': 'form',
|
||||
'view_mode': 'form',
|
||||
'views': [(view_id, 'form')],
|
||||
'target': 'current',
|
||||
'res_id': self.id,
|
||||
'context': dict(self._context),
|
||||
}
|
||||
|
||||
@api.model
|
||||
def _onchange_spec(self, view_info=None):
|
||||
""" Return the onchange spec from a view description; if not given, the
|
||||
result of ``self.get_view()`` is used.
|
||||
"""
|
||||
result = {}
|
||||
|
||||
# for traversing the XML arch and populating result
|
||||
def process(node, info, prefix):
|
||||
if node.tag == 'field':
|
||||
name = node.attrib['name']
|
||||
names = "%s.%s" % (prefix, name) if prefix else name
|
||||
if not result.get(names):
|
||||
result[names] = node.attrib.get('on_change')
|
||||
# traverse the subviews included in relational fields
|
||||
for child_view in node.xpath("./*[descendant::field]"):
|
||||
process(child_view, None, names)
|
||||
else:
|
||||
for child in node:
|
||||
process(child, info, prefix)
|
||||
|
||||
if view_info is None:
|
||||
view_info = self.get_view()
|
||||
process(etree.fromstring(view_info['arch']), view_info, '')
|
||||
return result
|
||||
|
||||
|
||||
class NameManager:
|
||||
""" An object that manages all the named elements in a view. """
|
||||
|
||||
|
||||
-518
@@ -48,8 +48,6 @@ import dateutil.relativedelta
|
||||
import psycopg2
|
||||
import psycopg2.extensions
|
||||
from psycopg2.extras import Json
|
||||
from lxml import etree
|
||||
from lxml.builder import E
|
||||
|
||||
import odoo
|
||||
from . import SUPERUSER_ID
|
||||
@@ -545,7 +543,6 @@ class BaseModel(metaclass=MetaModel):
|
||||
"""field to use for active records, automatically set to either ``"active"``
|
||||
or ``"x_active"``.
|
||||
"""
|
||||
_date_name = 'date' #: field to use for default calendar view
|
||||
_fold_name = 'fold' #: field to determine folded groups in kanban views
|
||||
|
||||
_translate = True # False disables translations export for this model (Old API)
|
||||
@@ -1457,13 +1454,6 @@ class BaseModel(metaclass=MetaModel):
|
||||
# if self._rec_name is set, it belongs to self._fields
|
||||
return self._rec_name or 'id'
|
||||
|
||||
#
|
||||
# Override this method if you need a window title that depends on the context
|
||||
#
|
||||
@api.model
|
||||
def view_header_get(self, view_id=None, view_type='form'):
|
||||
return False
|
||||
|
||||
@api.model
|
||||
def user_has_groups(self, groups):
|
||||
"""Return true if the user is member of at least one of the groups in
|
||||
@@ -1510,475 +1500,6 @@ class BaseModel(metaclass=MetaModel):
|
||||
|
||||
return not has_groups
|
||||
|
||||
@api.model
|
||||
def _get_default_form_view(self):
|
||||
""" Generates a default single-line form view using all fields
|
||||
of the current model.
|
||||
|
||||
:returns: a form view as an lxml document
|
||||
:rtype: etree._Element
|
||||
"""
|
||||
group = E.group(col="4")
|
||||
for fname, field in self._fields.items():
|
||||
if field.automatic:
|
||||
continue
|
||||
elif field.type in ('one2many', 'many2many', 'text', 'html'):
|
||||
group.append(E.newline())
|
||||
group.append(E.field(name=fname, colspan="4"))
|
||||
group.append(E.newline())
|
||||
else:
|
||||
group.append(E.field(name=fname))
|
||||
group.append(E.separator())
|
||||
return E.form(E.sheet(group, string=self._description))
|
||||
|
||||
@api.model
|
||||
def _get_default_search_view(self):
|
||||
""" Generates a single-field search view, based on _rec_name.
|
||||
|
||||
:returns: a tree view as an lxml document
|
||||
:rtype: etree._Element
|
||||
"""
|
||||
element = E.field(name=self._rec_name_fallback())
|
||||
return E.search(element, string=self._description)
|
||||
|
||||
@api.model
|
||||
def _get_default_tree_view(self):
|
||||
""" Generates a single-field tree view, based on _rec_name.
|
||||
|
||||
:returns: a tree view as an lxml document
|
||||
:rtype: etree._Element
|
||||
"""
|
||||
element = E.field(name=self._rec_name_fallback())
|
||||
return E.tree(element, string=self._description)
|
||||
|
||||
@api.model
|
||||
def _get_default_pivot_view(self):
|
||||
""" Generates an empty pivot view.
|
||||
|
||||
:returns: a pivot view as an lxml document
|
||||
:rtype: etree._Element
|
||||
"""
|
||||
return E.pivot(string=self._description)
|
||||
|
||||
@api.model
|
||||
def _get_default_kanban_view(self):
|
||||
""" Generates a single-field kanban view, based on _rec_name.
|
||||
|
||||
:returns: a kanban view as an lxml document
|
||||
:rtype: etree._Element
|
||||
"""
|
||||
|
||||
field = E.field(name=self._rec_name_fallback())
|
||||
content_div = E.div(field, {'class': "o_kanban_card_content"})
|
||||
card_div = E.div(content_div, {'t-attf-class': "oe_kanban_card oe_kanban_global_click"})
|
||||
kanban_box = E.t(card_div, {'t-name': "kanban-box"})
|
||||
templates = E.templates(kanban_box)
|
||||
return E.kanban(templates, string=self._description)
|
||||
|
||||
@api.model
|
||||
def _get_default_graph_view(self):
|
||||
""" Generates a single-field graph view, based on _rec_name.
|
||||
|
||||
:returns: a graph view as an lxml document
|
||||
:rtype: etree._Element
|
||||
"""
|
||||
element = E.field(name=self._rec_name_fallback())
|
||||
return E.graph(element, string=self._description)
|
||||
|
||||
@api.model
|
||||
def _get_default_calendar_view(self):
|
||||
""" Generates a default calendar view by trying to infer
|
||||
calendar fields from a number of pre-set attribute names
|
||||
|
||||
:returns: a calendar view
|
||||
:rtype: etree._Element
|
||||
"""
|
||||
def set_first_of(seq, in_, to):
|
||||
"""Sets the first value of ``seq`` also found in ``in_`` to
|
||||
the ``to`` attribute of the ``view`` being closed over.
|
||||
|
||||
Returns whether it's found a suitable value (and set it on
|
||||
the attribute) or not
|
||||
"""
|
||||
for item in seq:
|
||||
if item in in_:
|
||||
view.set(to, item)
|
||||
return True
|
||||
return False
|
||||
|
||||
view = E.calendar(string=self._description)
|
||||
view.append(E.field(name=self._rec_name_fallback()))
|
||||
|
||||
if not set_first_of([self._date_name, 'date', 'date_start', 'x_date', 'x_date_start'],
|
||||
self._fields, 'date_start'):
|
||||
raise UserError(_("Insufficient fields for Calendar View!"))
|
||||
|
||||
set_first_of(["user_id", "partner_id", "x_user_id", "x_partner_id"],
|
||||
self._fields, 'color')
|
||||
|
||||
if not set_first_of(["date_stop", "date_end", "x_date_stop", "x_date_end"],
|
||||
self._fields, 'date_stop'):
|
||||
if not set_first_of(["date_delay", "planned_hours", "x_date_delay", "x_planned_hours"],
|
||||
self._fields, 'date_delay'):
|
||||
raise UserError(_(
|
||||
"Insufficient fields to generate a Calendar View for %s, missing a date_stop or a date_delay",
|
||||
self._name
|
||||
))
|
||||
|
||||
return view
|
||||
|
||||
@api.model
|
||||
def get_views(self, views, options=None):
|
||||
""" Returns the fields_views of given views, along with the fields of
|
||||
the current model, and optionally its filters for the given action.
|
||||
|
||||
:param views: list of [view_id, view_type]
|
||||
:param dict options: a dict optional boolean flags, set to enable:
|
||||
|
||||
``toolbar``
|
||||
includes contextual actions when loading fields_views
|
||||
``load_filters``
|
||||
returns the model's filters
|
||||
``action_id``
|
||||
id of the action to get the filters, otherwise loads the global
|
||||
filters or the model
|
||||
|
||||
:return: dictionary with fields_views, fields and optionally filters
|
||||
"""
|
||||
options = options or {}
|
||||
result = {}
|
||||
|
||||
result['views'] = {
|
||||
v_type: self.get_view(
|
||||
v_id, v_type if v_type != 'list' else 'tree',
|
||||
**options
|
||||
)
|
||||
for [v_id, v_type] in views
|
||||
}
|
||||
|
||||
models = {}
|
||||
for view in result['views'].values():
|
||||
for model, model_fields in view.pop('models').items():
|
||||
models.setdefault(model, set()).update(model_fields)
|
||||
|
||||
result['models'] = {}
|
||||
|
||||
for model, model_fields in models.items():
|
||||
result['models'][model] = self.env[model].fields_get(
|
||||
allfields=model_fields, attributes=self._get_view_field_attributes()
|
||||
)
|
||||
|
||||
# Add related action information if asked
|
||||
if options.get('toolbar'):
|
||||
for view in result['views'].values():
|
||||
view['toolbar'] = {}
|
||||
|
||||
bindings = self.env['ir.actions.actions'].get_bindings(self._name)
|
||||
for action_type, key in (('report', 'print'), ('action', 'action')):
|
||||
for action in bindings.get(action_type, []):
|
||||
view_types = (
|
||||
action['binding_view_types'].split(',')
|
||||
if action.get('binding_view_types')
|
||||
else result['views'].keys()
|
||||
)
|
||||
for view_type in view_types:
|
||||
view_type = view_type if view_type != 'tree' else 'list'
|
||||
if view_type in result['views']:
|
||||
result['views'][view_type]['toolbar'].setdefault(key, []).append(action)
|
||||
|
||||
if options.get('load_filters') and 'search' in result['views']:
|
||||
result['views']['search']['filters'] = self.env['ir.filters'].get_filters(
|
||||
self._name, options.get('action_id')
|
||||
)
|
||||
|
||||
return result
|
||||
|
||||
@api.model
|
||||
def _get_view(self, view_id=None, view_type='form', **options):
|
||||
"""_get_view([view_id | view_type='form'])
|
||||
|
||||
Get the model view combined architecture (the view along all its inheriting views).
|
||||
|
||||
:param int view_id: id of the view or None
|
||||
:param str view_type: type of the view to return if view_id is None ('form', 'tree', ...)
|
||||
:param dict options: bool options to return additional features:
|
||||
- bool mobile: true if the web client is currently using the responsive mobile view
|
||||
(to use kanban views instead of list views for x2many fields)
|
||||
:return: architecture of the view as an etree node, and the browse record of the view used
|
||||
:rtype: tuple
|
||||
:raise AttributeError:
|
||||
|
||||
* if no view exists for that model, and no method `_get_default_[view_type]_view` exists for the view type
|
||||
|
||||
"""
|
||||
View = self.env['ir.ui.view'].sudo()
|
||||
|
||||
# try to find a view_id if none provided
|
||||
if not view_id:
|
||||
# <view_type>_view_ref in context can be used to override the default view
|
||||
view_ref_key = view_type + '_view_ref'
|
||||
view_ref = self._context.get(view_ref_key)
|
||||
if view_ref:
|
||||
if '.' in view_ref:
|
||||
module, view_ref = view_ref.split('.', 1)
|
||||
query = "SELECT res_id FROM ir_model_data WHERE model='ir.ui.view' AND module=%s AND name=%s"
|
||||
self._cr.execute(query, (module, view_ref))
|
||||
view_ref_res = self._cr.fetchone()
|
||||
if view_ref_res:
|
||||
view_id = view_ref_res[0]
|
||||
else:
|
||||
_logger.warning('%r requires a fully-qualified external id (got: %r for model %s). '
|
||||
'Please use the complete `module.view_id` form instead.', view_ref_key, view_ref,
|
||||
self._name)
|
||||
|
||||
if not view_id:
|
||||
# otherwise try to find the lowest priority matching ir.ui.view
|
||||
view_id = View.default_view(self._name, view_type)
|
||||
|
||||
if view_id:
|
||||
# read the view with inherited views applied
|
||||
view = View.browse(view_id)
|
||||
arch = view._get_combined_arch()
|
||||
else:
|
||||
# fallback on default views methods if no ir.ui.view could be found
|
||||
view = View.browse()
|
||||
try:
|
||||
arch = getattr(self, '_get_default_%s_view' % view_type)()
|
||||
except AttributeError:
|
||||
raise UserError(_("No default view of type '%s' could be found !", view_type))
|
||||
return arch, view
|
||||
|
||||
@api.model
|
||||
def _get_view_cache_key(self, view_id=None, view_type='form', **options):
|
||||
""" Get the key to use for caching `_get_view_cache`.
|
||||
|
||||
This method is meant to be overriden by models needing additional keys.
|
||||
|
||||
:param int view_id: id of the view or None
|
||||
:param str view_type: type of the view to return if view_id is None ('form', 'tree', ...)
|
||||
:param dict options: bool options to return additional features:
|
||||
- bool mobile: true if the web client is currently using the responsive mobile view
|
||||
(to use kanban views instead of list views for x2many fields)
|
||||
:return: a cache key
|
||||
:rtype: tuple
|
||||
"""
|
||||
return (view_id, view_type, options.get('mobile'), self.env.lang) + tuple(
|
||||
(key, value) for key, value in self.env.context.items() if key.endswith('_view_ref')
|
||||
)
|
||||
|
||||
@api.model
|
||||
@ormcache('self._get_view_cache_key(view_id, view_type, **options)')
|
||||
def _get_view_cache(self, view_id=None, view_type='form', **options):
|
||||
""" Get the view information ready to be cached
|
||||
|
||||
The cached view includes the postprocessed view, including inherited views, for all groups.
|
||||
The blocks restricted to groups must therefore be removed after calling this method
|
||||
for users not part of the given groups.
|
||||
|
||||
:param int view_id: id of the view or None
|
||||
:param str view_type: type of the view to return if view_id is None ('form', 'tree', ...)
|
||||
:param dict options: boolean options to return additional features:
|
||||
- bool mobile: true if the web client is currently using the responsive mobile view
|
||||
(to use kanban views instead of list views for x2many fields)
|
||||
:return: a dictionnary including
|
||||
- string arch: the architecture of the view (including inherited views, postprocessed, for all groups)
|
||||
- int id: the view id
|
||||
- string model: the view model
|
||||
- dict models: the fields of the models used in the view (including sub-views)
|
||||
:rtype: dict
|
||||
"""
|
||||
# Get the view arch and all other attributes describing the composition of the view
|
||||
arch, view = self._get_view(view_id, view_type, **options)
|
||||
|
||||
# Apply post processing, groups and modifiers etc...
|
||||
arch, models = view.postprocess_and_fields(arch, model=self._name, **options)
|
||||
models = self._get_view_fields(view_type or view.type, models)
|
||||
result = {
|
||||
'arch': arch,
|
||||
# TODO: only `web_studio` seems to require this. I guess this is acceptable to keep it.
|
||||
'id': view.id,
|
||||
# TODO: only `web_studio` seems to require this. But this one on the other hand should be eliminated:
|
||||
# you just called `get_views` for that model, so obviously the web client already knows the model.
|
||||
'model': self._name,
|
||||
# Set a frozendict and tuple for the field list to make sure the value in cache cannot be updated.
|
||||
'models': frozendict({model: tuple(fields) for model, fields in models.items()}),
|
||||
}
|
||||
|
||||
return frozendict(result)
|
||||
|
||||
@api.model
|
||||
def get_view(self, view_id=None, view_type='form', **options):
|
||||
""" get_view([view_id | view_type='form'])
|
||||
|
||||
Get the detailed composition of the requested view like model, view architecture
|
||||
|
||||
:param int view_id: id of the view or None
|
||||
:param str view_type: type of the view to return if view_id is None ('form', 'tree', ...)
|
||||
:param dict options: boolean options to return additional features:
|
||||
- bool mobile: true if the web client is currently using the responsive mobile view
|
||||
(to use kanban views instead of list views for x2many fields)
|
||||
:return: composition of the requested view (including inherited views and extensions)
|
||||
:rtype: dict
|
||||
:raise AttributeError:
|
||||
|
||||
* if the inherited view has unknown position to work with other than 'before', 'after', 'inside', 'replace'
|
||||
* if some tag other than 'position' is found in parent view
|
||||
|
||||
:raise Invalid ArchitectureError: if there is view type other than form, tree, calendar, search etc... defined on the structure
|
||||
"""
|
||||
self.check_access_rights('read')
|
||||
|
||||
result = dict(self._get_view_cache(view_id, view_type, **options))
|
||||
|
||||
node = etree.fromstring(result['arch'])
|
||||
node = self.env['ir.ui.view']._postprocess_access_rights(node)
|
||||
node = self.env['ir.ui.view']._postprocess_context_dependent(node)
|
||||
result['arch'] = etree.tostring(node, encoding="unicode").replace('\t', '')
|
||||
|
||||
return result
|
||||
|
||||
@api.model
|
||||
def _get_view_fields(self, view_type, models):
|
||||
""" Returns the field names required by the web client to load the views according to the view type.
|
||||
|
||||
The method is meant to be overridden by modules extending web client features and requiring additional
|
||||
fields.
|
||||
|
||||
:param string view_type: type of the view
|
||||
:param dict models: dict holding the models and fields used in the view architecture.
|
||||
:return: dict holding the models and field required by the web client given the view type.
|
||||
:rtype: list
|
||||
"""
|
||||
if view_type in ('kanban', 'tree', 'form'):
|
||||
for model_fields in models.values():
|
||||
model_fields.update({'id', self.CONCURRENCY_CHECK_FIELD})
|
||||
elif view_type == 'search':
|
||||
models[self._name] = list(self._fields.keys())
|
||||
elif view_type == 'graph':
|
||||
models[self._name].union(fname for fname, field in self._fields.items() if field.type in ('integer', 'float'))
|
||||
elif view_type == 'pivot':
|
||||
models[self._name].union(fname for fname, field in self._fields.items() if field.groupable)
|
||||
return models
|
||||
|
||||
@api.model
|
||||
def _get_view_field_attributes(self):
|
||||
""" Returns the field attributes required by the web client to load the views.
|
||||
|
||||
The method is meant to be overridden by modules extending web client features and requiring additional
|
||||
field attributes.
|
||||
|
||||
:return: string list of field attribute names
|
||||
:rtype: list
|
||||
"""
|
||||
return [
|
||||
'context', 'currency_field', 'definition_record', 'digits', 'domain', 'group_operator', 'groups', 'help',
|
||||
'name', 'readonly', 'related', 'relation', 'relation_field', 'required', 'searchable', 'selection', 'size',
|
||||
'sortable', 'store', 'string', 'translate', 'trim', 'type',
|
||||
]
|
||||
|
||||
@api.model
|
||||
def load_views(self, views, options=None):
|
||||
warnings.warn(
|
||||
'`load_views` method is deprecated, use `get_views` instead',
|
||||
DeprecationWarning, stacklevel=2,
|
||||
)
|
||||
return self.get_views(views, options=options)
|
||||
|
||||
@api.model
|
||||
def _fields_view_get(self, view_id=None, view_type='form', toolbar=False, submenu=False):
|
||||
warnings.warn(
|
||||
'Method `_fields_view_get` is deprecated, use `_get_view` instead',
|
||||
DeprecationWarning, stacklevel=2,
|
||||
)
|
||||
arch, view = self._get_view(view_id, view_type, toolbar=toolbar, submenu=submenu)
|
||||
result = {
|
||||
'arch': etree.tostring(arch, encoding='unicode'),
|
||||
'model': self._name,
|
||||
'field_parent': False,
|
||||
}
|
||||
if view:
|
||||
result['name'] = view.name
|
||||
result['type'] = view.type
|
||||
result['view_id'] = view.id
|
||||
result['field_parent'] = view.field_parent
|
||||
result['base_model'] = view.model
|
||||
else:
|
||||
result['type'] = view_type
|
||||
result['name'] = 'default'
|
||||
return result
|
||||
|
||||
@api.model
|
||||
def fields_view_get(self, view_id=None, view_type='form', toolbar=False, submenu=False):
|
||||
"""
|
||||
.. deprecated:: saas-15.4
|
||||
|
||||
Use :meth:`~odoo.models.Model.get_view()` instead.
|
||||
"""
|
||||
warnings.warn(
|
||||
'Method `fields_view_get` is deprecated, use `get_view` instead',
|
||||
DeprecationWarning, stacklevel=2,
|
||||
)
|
||||
result = self.get_views([(view_id, view_type)], {'toolbar': toolbar, 'submenu': submenu})['views'][view_type]
|
||||
node = etree.fromstring(result['arch'])
|
||||
view_fields = set(el.get('name') for el in node.xpath('.//field[not(ancestor::field)]'))
|
||||
result['fields'] = self.fields_get(view_fields)
|
||||
result.pop('models', None)
|
||||
if 'id' in result:
|
||||
view = self.env['ir.ui.view'].sudo().browse(result.pop('id'))
|
||||
result['name'] = view.name
|
||||
result['type'] = view.type
|
||||
result['view_id'] = view.id
|
||||
result['field_parent'] = view.field_parent
|
||||
result['base_model'] = view.model
|
||||
else:
|
||||
result['type'] = view_type
|
||||
result['name'] = 'default'
|
||||
result['field_parent'] = False
|
||||
return result
|
||||
|
||||
def get_formview_id(self, access_uid=None):
|
||||
""" Return a view id to open the document ``self`` with. This method is
|
||||
meant to be overridden in addons that want to give specific view ids
|
||||
for example.
|
||||
|
||||
Optional access_uid holds the user that would access the form view
|
||||
id different from the current environment user.
|
||||
"""
|
||||
return False
|
||||
|
||||
def get_formview_action(self, access_uid=None):
|
||||
""" Return an action to open the document ``self``. This method is meant
|
||||
to be overridden in addons that want to give specific view ids for
|
||||
example.
|
||||
|
||||
An optional access_uid holds the user that will access the document
|
||||
that could be different from the current user. """
|
||||
view_id = self.sudo().get_formview_id(access_uid=access_uid)
|
||||
return {
|
||||
'type': 'ir.actions.act_window',
|
||||
'res_model': self._name,
|
||||
'view_type': 'form',
|
||||
'view_mode': 'form',
|
||||
'views': [(view_id, 'form')],
|
||||
'target': 'current',
|
||||
'res_id': self.id,
|
||||
'context': dict(self._context),
|
||||
}
|
||||
|
||||
def _get_access_action(self, access_uid=None, force_website=False):
|
||||
""" Return an action to open the document. This method is meant to be
|
||||
overridden in addons that want to give specific access to the document.
|
||||
By default, it opens the formview of the document.
|
||||
|
||||
:param integer access_uid: optional access_uid being the user that
|
||||
accesses the document. May be different from the current user as we
|
||||
may compute an access for someone else.
|
||||
:param integer force_website: force frontend redirection if available
|
||||
on self. Used in overrides, notably with portal / website addons.
|
||||
"""
|
||||
self.ensure_one()
|
||||
return self.get_formview_action(access_uid=access_uid)
|
||||
|
||||
@api.model
|
||||
def search_count(self, domain, limit=None):
|
||||
""" search_count(domain) -> int
|
||||
@@ -3340,19 +2861,6 @@ class BaseModel(metaclass=MetaModel):
|
||||
|
||||
return res
|
||||
|
||||
@api.model
|
||||
def get_empty_list_help(self, help):
|
||||
""" Hook method to customize the help message in empty list/kanban views.
|
||||
|
||||
By default, it returns the help received as parameter.
|
||||
|
||||
:param str help: ir.actions.act_window help content
|
||||
:return: help message displayed when there is no result to display
|
||||
in a list/kanban view (by default, it returns the action help)
|
||||
:rtype: str
|
||||
"""
|
||||
return help
|
||||
|
||||
@api.model
|
||||
def check_field_access_rights(self, operation, fields):
|
||||
"""Check the user access rights on the given fields.
|
||||
@@ -6668,32 +6176,6 @@ class BaseModel(metaclass=MetaModel):
|
||||
dep in other_fields for dep in self._dependent_fields(field.base_field)
|
||||
)
|
||||
|
||||
@api.model
|
||||
def _onchange_spec(self, view_info=None):
|
||||
""" Return the onchange spec from a view description; if not given, the
|
||||
result of ``self.get_view()`` is used.
|
||||
"""
|
||||
result = {}
|
||||
|
||||
# for traversing the XML arch and populating result
|
||||
def process(node, info, prefix):
|
||||
if node.tag == 'field':
|
||||
name = node.attrib['name']
|
||||
names = "%s.%s" % (prefix, name) if prefix else name
|
||||
if not result.get(names):
|
||||
result[names] = node.attrib.get('on_change')
|
||||
# traverse the subviews included in relational fields
|
||||
for child_view in node.xpath("./*[descendant::field]"):
|
||||
process(child_view, None, names)
|
||||
else:
|
||||
for child in node:
|
||||
process(child, info, prefix)
|
||||
|
||||
if view_info is None:
|
||||
view_info = self.get_view()
|
||||
process(etree.fromstring(view_info['arch']), view_info, '')
|
||||
return result
|
||||
|
||||
def _onchange_eval(self, field_name, onchange, result):
|
||||
""" Apply onchange method(s) for field ``field_name`` with spec ``onchange``
|
||||
on record ``self``. Value assignments are applied on ``self``, while
|
||||
|
||||
Reference in New Issue
Block a user