Browse Source
Merge pull request #1028 from hbrunn/10.0-web_menu_navbar_needaction
Merge pull request #1028 from hbrunn/10.0-web_menu_navbar_needaction
[10.0][MIG] web_menu_navbar_needactionpull/1073/head
Pedro M. Baeza
6 years ago
committed by
GitHub
GitHub
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
16 changed files with 734 additions and 193 deletions
-
66web_menu_navbar_needaction/README.rst
-
20web_menu_navbar_needaction/__init__.py
-
28web_menu_navbar_needaction/__manifest__.py
-
14web_menu_navbar_needaction/data/ir_config_parameter.xml
-
7web_menu_navbar_needaction/data/ir_ui_menu.xml
-
20web_menu_navbar_needaction/models/__init__.py
-
156web_menu_navbar_needaction/models/ir_ui_menu.py
-
3web_menu_navbar_needaction/readme/CONFIGURE.rst
-
1web_menu_navbar_needaction/readme/CONTRIBUTORS.rst
-
3web_menu_navbar_needaction/readme/DESCRIPTION.rst
-
404web_menu_navbar_needaction/static/description/index.html
-
4web_menu_navbar_needaction/static/src/css/web_menu_navbar_needaction.css
-
143web_menu_navbar_needaction/static/src/js/web_menu_navbar_needaction.js
-
25web_menu_navbar_needaction/tests/test_web_menu_navbar_needaction.py
-
15web_menu_navbar_needaction/views/ir_ui_menu.xml
-
18web_menu_navbar_needaction/views/templates.xml
@ -1,20 +1,4 @@ |
|||
# -*- coding: utf-8 -*- |
|||
############################################################################## |
|||
# |
|||
# This module copyright (C) 2015 Therp BV <http://therp.nl>. |
|||
# |
|||
# This program is free software: you can redistribute it and/or modify |
|||
# it under the terms of the GNU Affero General Public License as |
|||
# published by the Free Software Foundation, either version 3 of the |
|||
# License, or (at your option) any later version. |
|||
# |
|||
# This program is distributed in the hope that it will be useful, |
|||
# but WITHOUT ANY WARRANTY; without even the implied warranty of |
|||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|||
# GNU Affero General Public License for more details. |
|||
# |
|||
# You should have received a copy of the GNU Affero General Public License |
|||
# along with this program. If not, see <http://www.gnu.org/licenses/>. |
|||
# |
|||
############################################################################## |
|||
# Copyright 2015-2018 Therp BV <https://therp.nl> |
|||
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). |
|||
from . import models |
|||
@ -1,37 +1,21 @@ |
|||
# -*- coding: utf-8 -*- |
|||
############################################################################## |
|||
# |
|||
# This module copyright (C) 2015 Therp BV <http://therp.nl>. |
|||
# |
|||
# This program is free software: you can redistribute it and/or modify |
|||
# it under the terms of the GNU Affero General Public License as |
|||
# published by the Free Software Foundation, either version 3 of the |
|||
# License, or (at your option) any later version. |
|||
# |
|||
# This program is distributed in the hope that it will be useful, |
|||
# but WITHOUT ANY WARRANTY; without even the implied warranty of |
|||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|||
# GNU Affero General Public License for more details. |
|||
# |
|||
# You should have received a copy of the GNU Affero General Public License |
|||
# along with this program. If not, see <http://www.gnu.org/licenses/>. |
|||
# |
|||
############################################################################## |
|||
# Copyright 2015-2018 Therp BV <https://therp.nl> |
|||
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). |
|||
{ |
|||
"name": "Needaction counters in main menu", |
|||
"version": "8.0.1.0.0", |
|||
"version": "10.0.1.0.0", |
|||
"author": "Therp BV,Odoo Community Association (OCA)", |
|||
"license": "AGPL-3", |
|||
"category": "Usability", |
|||
"summary": "Show the sum of submenus' needaction counters in main menu", |
|||
"depends": [ |
|||
'web', |
|||
'mail', |
|||
], |
|||
"data": [ |
|||
"data/ir_ui_menu.xml", |
|||
"views/ir_ui_menu.xml", |
|||
"data/ir_config_parameter.xml", |
|||
'views/templates.xml', |
|||
], |
|||
"auto_install": False, |
|||
'installable': False, |
|||
"application": False, |
|||
} |
|||
@ -1,9 +1,7 @@ |
|||
<?xml version="1.0" encoding="UTF-8"?> |
|||
<openerp> |
|||
<data noupdate="1"> |
|||
<record id="ir_config_parameter_refresh_timeout" model="ir.config_parameter"> |
|||
<field name="key">web_menu_navbar_needaction.refresh_timeout</field> |
|||
<field name="value">600000</field> |
|||
</record> |
|||
</data> |
|||
</openerp> |
|||
<odoo noupdate="1"> |
|||
<record id="ir_config_parameter_refresh_timeout" model="ir.config_parameter"> |
|||
<field name="key">web_menu_navbar_needaction.refresh_timeout</field> |
|||
<field name="value">600000</field> |
|||
</record> |
|||
</odoo> |
|||
@ -0,0 +1,7 @@ |
|||
<?xml version="1.0" encoding="UTF-8"?> |
|||
<odoo noupdate="1"> |
|||
<record id="mail.menu_mail_message" model="ir.ui.menu"> |
|||
<!-- disable needaction for mails in sysadmin menu /--> |
|||
<field name="needaction" eval="False" /> |
|||
</record> |
|||
</odoo> |
|||
@ -1,20 +1,4 @@ |
|||
# -*- coding: utf-8 -*- |
|||
############################################################################## |
|||
# |
|||
# This module copyright (C) 2015 Therp BV <http://therp.nl>. |
|||
# |
|||
# This program is free software: you can redistribute it and/or modify |
|||
# it under the terms of the GNU Affero General Public License as |
|||
# published by the Free Software Foundation, either version 3 of the |
|||
# License, or (at your option) any later version. |
|||
# |
|||
# This program is distributed in the hope that it will be useful, |
|||
# but WITHOUT ANY WARRANTY; without even the implied warranty of |
|||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|||
# GNU Affero General Public License for more details. |
|||
# |
|||
# You should have received a copy of the GNU Affero General Public License |
|||
# along with this program. If not, see <http://www.gnu.org/licenses/>. |
|||
# |
|||
############################################################################## |
|||
# Copyright 2015-2018 Therp BV <https://therp.nl> |
|||
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). |
|||
from . import ir_ui_menu |
|||
@ -1,36 +1,142 @@ |
|||
# -*- coding: utf-8 -*- |
|||
############################################################################## |
|||
# |
|||
# This module copyright (C) 2015 Therp BV (<http://therp.nl>). |
|||
# |
|||
# This program is free software: you can redistribute it and/or modify |
|||
# it under the terms of the GNU Affero General Public License as |
|||
# published by the Free Software Foundation, either version 3 of the |
|||
# License, or (at your option) any later version. |
|||
# |
|||
# This program is distributed in the hope that it will be useful, |
|||
# but WITHOUT ANY WARRANTY; without even the implied warranty of |
|||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|||
# GNU Affero General Public License for more details. |
|||
# |
|||
# You should have received a copy of the GNU Affero General Public License |
|||
# along with this program. If not, see <http://www.gnu.org/licenses/>. |
|||
# |
|||
############################################################################## |
|||
from openerp import models, api |
|||
# Copyright 2015-2018 Therp BV <https://therp.nl> |
|||
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). |
|||
import operator |
|||
from openerp import _, models, api, fields |
|||
from openerp.tools.safe_eval import safe_eval |
|||
from openerp.exceptions import Warning as UserError |
|||
from openerp.osv import expression |
|||
|
|||
|
|||
class IrUiMenu(models.Model): |
|||
_inherit = 'ir.ui.menu' |
|||
|
|||
needaction = fields.Boolean( |
|||
help='Set to False to disable needaction for specific menu items', |
|||
default=True) |
|||
needaction_domain = fields.Text( |
|||
help='If your menu item needs a different domain, set it here. It ' |
|||
'will override the model\'s needaction domain completely.') |
|||
|
|||
@api.multi |
|||
def get_navbar_needaction_data(self): |
|||
"""Return aggregated needaction data for all children of self""" |
|||
result = {} |
|||
for this in self: |
|||
result[this.id] = sum(map( |
|||
lambda x: x['needaction_counter'], |
|||
self.search([('id', 'child_of', this.ids)]) |
|||
._filter_visible_menus().get_needaction_data() |
|||
.itervalues()) |
|||
) |
|||
count_per_model = {} |
|||
action_menu = self.env['ir.ui.menu'].browse([]) |
|||
if not this.needaction: |
|||
continue |
|||
custom_needaction = this._get_navbar_needaction_data_custom() |
|||
if custom_needaction: |
|||
result[this.id] = custom_needaction |
|||
continue |
|||
for menu_id, needaction in self.search( |
|||
[('id', 'child_of', this.ids)])._filter_visible_menus()\ |
|||
.get_needaction_data().iteritems(): |
|||
if needaction.get('needaction_from_children'): |
|||
continue |
|||
if needaction['needaction_enabled']: |
|||
menu = self.env['ir.ui.menu'].browse(menu_id) |
|||
model = menu._get_needaction_model() |
|||
count_per_model[model] = max( |
|||
count_per_model.get(model), |
|||
needaction['needaction_counter'] |
|||
) |
|||
if needaction['needaction_counter'] and not action_menu: |
|||
action_menu = menu |
|||
result[this.id] = { |
|||
'count': sum(count_per_model.itervalues()), |
|||
} |
|||
if action_menu: |
|||
result[this.id].update({ |
|||
'action_id': action_menu.action and |
|||
action_menu.action.id or None, |
|||
'action_domain': action_menu._eval_needaction_domain(), |
|||
}) |
|||
return result |
|||
|
|||
@api.multi |
|||
def _get_navbar_needaction_data_custom(self): |
|||
"""Return nonstandard needaction data for a menu item""" |
|||
self.ensure_one() |
|||
if self == self.env.ref('mail.mail_channel_menu_root_chat'): |
|||
return { |
|||
'count': self.env['mail.message']._needaction_count(), |
|||
'action_id': |
|||
self.env.ref('mail.mail_channel_action_client_chat').id, |
|||
} |
|||
|
|||
@api.multi |
|||
def get_needaction_data(self): |
|||
result = super(IrUiMenu, self).get_needaction_data() |
|||
for this in self.sorted(operator.itemgetter('parent_left'), True): |
|||
data = result[this.id] |
|||
if data['needaction_enabled'] or this.needaction and\ |
|||
this.needaction_domain: |
|||
if not this.needaction: |
|||
data['needaction_enabled'] = False |
|||
data['needaction_counter'] = 0 |
|||
continue |
|||
if this.needaction_domain and\ |
|||
this._get_needaction_model() is not None: |
|||
data['needaction_enabled'] = True |
|||
data['needaction_counter'] = this._get_needaction_model()\ |
|||
.search_count(this._eval_needaction_domain()) |
|||
if not data['needaction_enabled'] and this.needaction and\ |
|||
this.child_id and this.parent_id and this.parent_id.parent_id: |
|||
# if the user didn't turn it off, show counters for submenus |
|||
# but only from the 3rd level (the first that is closed by |
|||
# default) |
|||
for child in this.child_id: |
|||
data['needaction_counter'] += result.get(child.id, {}).get( |
|||
'needaction_counter', 0) |
|||
data['needaction_enabled'] = bool(data['needaction_counter']) |
|||
data['needaction_from_children'] = True |
|||
return result |
|||
|
|||
@api.multi |
|||
def _eval_needaction_domain(self): |
|||
self.ensure_one() |
|||
eval_context = { |
|||
'uid': self.env.user.id, |
|||
'user': self.env.user, |
|||
} |
|||
if self.needaction_domain: |
|||
return safe_eval(self.needaction_domain, locals_dict=eval_context) |
|||
model = self._get_needaction_model() |
|||
if model is None or not hasattr(model, '_needaction_domain_get'): |
|||
return [] |
|||
return expression.AND([ |
|||
safe_eval( |
|||
'domain' in self.action._fields and self.action.domain or '[]', |
|||
locals_dict=eval_context), |
|||
model._needaction_domain_get(), |
|||
]) |
|||
|
|||
@api.multi |
|||
def _get_needaction_model(self): |
|||
if not self.action: |
|||
return None |
|||
model = None |
|||
if 'res_model' in self.action._fields: |
|||
model = self.action.res_model |
|||
elif 'model_id' in self.action._fields: |
|||
model = self.action.model_id.model |
|||
if model in self.env.registry: |
|||
return self.env[model] |
|||
return None |
|||
|
|||
@api.constrains('needaction_domain') |
|||
@api.multi |
|||
def _check_needaction_domain(self): |
|||
for this in self: |
|||
try: |
|||
expression.AND([ |
|||
this._eval_needaction_domain(), |
|||
expression.TRUE_DOMAIN, |
|||
]) |
|||
except Exception as ex: |
|||
raise UserError( |
|||
_('Cannot evaluate %s to a search domain:\n%s') % |
|||
(self.needaction_domain, ex)) |
|||
@ -0,0 +1,3 @@ |
|||
To configure the update frequency, set the configuration parameter `web_menu_navbar_needaction.refresh_timeout` to the amount of milliseconds after which the counters should be updated. Don't do this too often, as this will cause a lot of queries to the database. The default it 600000, which is equivalent to 10 minutes. |
|||
|
|||
To disable updates, set the parameter to 0. |
|||
@ -0,0 +1 @@ |
|||
* Holger Brunn <hbrunn@therp.nl> |
|||
@ -0,0 +1,3 @@ |
|||
This module shows the sum of all submenus' needaction counters in main menus. This way, users get visual feedback where there's still work to do without having to open the respective menu beforehand. |
|||
|
|||
The counters are updated periodically, so users will also be notified if there are new records that require attention. |
|||
@ -0,0 +1,404 @@ |
|||
<?xml version="1.0" encoding="utf-8" ?> |
|||
<!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 0.12: http://docutils.sourceforge.net/" /> |
|||
<title>Needaction counters in main menu</title> |
|||
<style type="text/css"> |
|||
|
|||
/* |
|||
:Author: David Goodger (goodger@python.org) |
|||
:Id: $Id: html4css1.css 7614 2013-02-21 15:55:51Z milde $ |
|||
:Copyright: This stylesheet has been placed in the public domain. |
|||
|
|||
Default cascading style sheet for the HTML output of Docutils. |
|||
|
|||
See http://docutils.sf.net/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 } |
|||
|
|||
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 { |
|||
clear: left ; |
|||
float: left ; |
|||
margin-right: 1em } |
|||
|
|||
img.align-right, .figure.align-right, object.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; |
|||
} |
|||
|
|||
.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 } */ |
|||
|
|||
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="needaction-counters-in-main-menu"> |
|||
<h1 class="title">Needaction counters in main menu</h1> |
|||
|
|||
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
|||
!! This file is generated by oca-gen-addon-readme !! |
|||
!! changes will be overwritten. !! |
|||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! --> |
|||
<p><a class="reference external" 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" 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" href="https://github.com/OCA/web/tree/10.0/web_menu_navbar_needaction"><img alt="OCA/web" src="https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/web-10-0/web-10-0-web_menu_navbar_needaction"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/162/10.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p> |
|||
<p>This module shows the sum of all submenus’ needaction counters in main menus. This way, users get visual feedback where there’s still work to do without having to open the respective menu beforehand.</p> |
|||
<p>The counters are updated periodically, so users will also be notified if there are new records that require attention.</p> |
|||
<p><strong>Table of contents</strong></p> |
|||
<div class="contents local topic" id="contents"> |
|||
<ul class="simple"> |
|||
<li><a class="reference internal" href="#configuration" id="id1">Configuration</a></li> |
|||
<li><a class="reference internal" href="#bug-tracker" id="id2">Bug Tracker</a></li> |
|||
<li><a class="reference internal" href="#credits" id="id3">Credits</a><ul> |
|||
<li><a class="reference internal" href="#authors" id="id4">Authors</a></li> |
|||
<li><a class="reference internal" href="#contributors" id="id5">Contributors</a></li> |
|||
<li><a class="reference internal" href="#maintainers" id="id6">Maintainers</a></li> |
|||
</ul> |
|||
</li> |
|||
</ul> |
|||
</div> |
|||
<div class="section" id="configuration"> |
|||
<h1><a class="toc-backref" href="#id1">Configuration</a></h1> |
|||
<p>To configure the update frequency, set the configuration parameter <cite>web_menu_navbar_needaction.refresh_timeout</cite> to the amount of milliseconds after which the counters should be updated. Don’t do this too often, as this will cause a lot of queries to the database. The default it 600000, which is equivalent to 10 minutes.</p> |
|||
<p>To disable updates, set the parameter to 0.</p> |
|||
</div> |
|||
<div class="section" id="bug-tracker"> |
|||
<h1><a class="toc-backref" href="#id2">Bug Tracker</a></h1> |
|||
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/web/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 smashing it by providing a detailed and welcomed |
|||
<a class="reference external" href="https://github.com/OCA/web/issues/new?body=module:%20web_menu_navbar_needaction%0Aversion:%2010.0%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="#id3">Credits</a></h1> |
|||
<div class="section" id="authors"> |
|||
<h2><a class="toc-backref" href="#id4">Authors</a></h2> |
|||
<ul class="simple"> |
|||
<li>Therp BV</li> |
|||
</ul> |
|||
</div> |
|||
<div class="section" id="contributors"> |
|||
<h2><a class="toc-backref" href="#id5">Contributors</a></h2> |
|||
<ul class="simple"> |
|||
<li>Holger Brunn <<a class="reference external" href="mailto:hbrunn@therp.nl">hbrunn@therp.nl</a>></li> |
|||
</ul> |
|||
</div> |
|||
<div class="section" id="maintainers"> |
|||
<h2><a class="toc-backref" href="#id6">Maintainers</a></h2> |
|||
<p>This module is maintained by the OCA.</p> |
|||
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a> |
|||
<p>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.</p> |
|||
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/web/tree/10.0/web_menu_navbar_needaction">OCA/web</a> project on GitHub.</p> |
|||
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p> |
|||
</div> |
|||
</div> |
|||
</div> |
|||
</body> |
|||
</html> |
|||
@ -1,78 +1,117 @@ |
|||
//-*- coding: utf-8 -*-
|
|||
//############################################################################
|
|||
//
|
|||
// This module copyright (C) 2015 Therp BV <http://therp.nl>.
|
|||
//
|
|||
// This program is free software: you can redistribute it and/or modify
|
|||
// it under the terms of the GNU Affero General Public License as
|
|||
// published by the Free Software Foundation, either version 3 of the
|
|||
// License, or (at your option) any later version.
|
|||
//
|
|||
// This program is distributed in the hope that it will be useful,
|
|||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|||
// GNU Affero General Public License for more details.
|
|||
//
|
|||
// You should have received a copy of the GNU Affero General Public License
|
|||
// along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|||
//
|
|||
//############################################################################
|
|||
// Copyright 2015-2018 Therp BV <https://therp.nl>
|
|||
// License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html).
|
|||
odoo.define('web_menu_navbar_needaction', function(require) { |
|||
var bus = require('web.core').bus, |
|||
chat_manager = require('mail.chat_manager'), |
|||
CompoundContext = require('web.data').CompoundContext, |
|||
pyeval = require('web.pyeval'), |
|||
Menu = require('web.Menu'), |
|||
Model = require('web.Model'), |
|||
qweb = require('web.core').qweb; |
|||
|
|||
openerp.web_menu_navbar_needaction = function(instance) |
|||
{ |
|||
instance.web.Menu.include({ |
|||
init: function() |
|||
{ |
|||
Menu.include({ |
|||
init: function() { |
|||
var self = this, |
|||
result = this._super.apply(this, arguments); |
|||
this.on('menu_bound', this, function() |
|||
{ |
|||
new instance.web.Model('ir.config_parameter') |
|||
this.on('menu_bound', this, function() { |
|||
new Model('ir.config_parameter') |
|||
.call('get_param', |
|||
['web_menu_navbar_needaction.refresh_timeout']) |
|||
.then(self.proxy(self.refresh_navbar_needaction)) |
|||
.then(self.proxy('set_interval_navbar_needaction')); |
|||
}); |
|||
return result; |
|||
}, |
|||
refresh_navbar_needaction: function(timeout) |
|||
{ |
|||
if(timeout) |
|||
{ |
|||
setTimeout(this.proxy(this.refresh_navbar_needaction), timeout, timeout); |
|||
start: function() { |
|||
chat_manager.bus.on( |
|||
'update_needaction', this, this.load_navbar_needaction |
|||
); |
|||
return this._super.apply(this, arguments); |
|||
}, |
|||
set_interval_navbar_needaction: function(timeout) { |
|||
if(parseInt(timeout, 10)) { |
|||
this.navbar_needaction_timer = setInterval( |
|||
this.proxy('load_navbar_needaction'), timeout |
|||
); |
|||
} |
|||
return this.load_navbar_needaction(); |
|||
}, |
|||
load_navbar_needaction: function() |
|||
{ |
|||
clear_interval_navbar_needaction: function(error, ev) { |
|||
clearInterval(this.navbar_needaction_timer); |
|||
ev.preventDefault(); |
|||
}, |
|||
load_navbar_needaction: function() { |
|||
this.navbar_menu_ids = this.$el.parents('body') |
|||
.find('#oe_main_menu_navbar a[data-menu]') |
|||
.filter(function() { return parseInt(jQuery(this).attr('data-menu')); }) |
|||
.map(function() { return parseInt(jQuery(this).attr('data-menu')); }) |
|||
.filter(function() { |
|||
return parseInt(jQuery(this).attr('data-menu'), 10); |
|||
}) |
|||
.map(function() { |
|||
return parseInt(jQuery(this).attr('data-menu'), 10); |
|||
}) |
|||
.get(); |
|||
return new instance.web.Model('ir.ui.menu') |
|||
.call('get_navbar_needaction_data', [this.navbar_menu_ids]) |
|||
.then(this.proxy(this.process_navbar_needaction)); |
|||
return new Model('ir.ui.menu') |
|||
.call('get_navbar_needaction_data', [this.navbar_menu_ids], |
|||
{}, {shadow: true}) |
|||
.then(this.proxy('process_navbar_needaction')) |
|||
.fail(this.proxy('clear_interval_navbar_needaction')); |
|||
}, |
|||
process_navbar_needaction: function(data) |
|||
{ |
|||
process_navbar_needaction: function(data) { |
|||
var self = this; |
|||
_.each(data, function (needaction_count, menu_id) |
|||
{ |
|||
_.each(data, function (needaction_data, menu_id) { |
|||
var $item = self.$el.parents('body').find( |
|||
_.str.sprintf('#oe_main_menu_navbar a[data-menu="%s"]', |
|||
menu_id)); |
|||
if(!$item.length) |
|||
{ |
|||
if(!$item.length || _.isEmpty(needaction_data)) { |
|||
return; |
|||
} |
|||
$item.find('.badge').remove(); |
|||
if(needaction_count) |
|||
{ |
|||
$item.append( |
|||
instance.web.qweb.render("Menu.needaction_counter", |
|||
{widget : {needaction_counter: needaction_count}})); |
|||
if(needaction_data.count) { |
|||
var $counter = jQuery(qweb.render( |
|||
"Menu.needaction_counter", { |
|||
widget: { |
|||
needaction_counter: needaction_data.count, |
|||
} |
|||
} |
|||
)).appendTo($item); |
|||
if(needaction_data.action_id) { |
|||
$counter.click( |
|||
needaction_data, |
|||
self.proxy('navbar_needaction_click') |
|||
); |
|||
} |
|||
} |
|||
}); |
|||
bus.trigger('resize'); |
|||
}, |
|||
navbar_needaction_click: function(ev) { |
|||
var needaction_data = ev.data, |
|||
parent = this.getParent(); |
|||
ev.stopPropagation(); |
|||
ev.preventDefault(); |
|||
return parent.menu_dm.add( |
|||
this.rpc('/web/action/load', { |
|||
action_id: needaction_data.action_id, |
|||
})) |
|||
.then(function(action) { |
|||
return parent.action_mutex.exec(function() { |
|||
action.domain = needaction_data.action_domain; |
|||
action.context = new CompoundContext( |
|||
action.context || {} |
|||
); |
|||
action.context = pyeval.eval( |
|||
'context', action.context |
|||
); |
|||
_.each(_.keys(action.context), function(key) { |
|||
if(key.startsWith('search_default')) { |
|||
delete action.context[key]; |
|||
} |
|||
}); |
|||
return parent.action_manager.do_action( |
|||
action, {disable_custom_filters: true} |
|||
); |
|||
}); |
|||
}); |
|||
}, |
|||
}) |
|||
} |
|||
}); |
|||
}); |
|||
@ -0,0 +1,15 @@ |
|||
<?xml version="1.0" encoding="UTF-8"?> |
|||
<openerp> |
|||
<data> |
|||
<record id="edit_menu_access" model="ir.ui.view"> |
|||
<field name="model">ir.ui.menu</field> |
|||
<field name="inherit_id" ref="base.edit_menu_access" /> |
|||
<field name="arch" type="xml"> |
|||
<field name="sequence" position="after"> |
|||
<field name="needaction" /> |
|||
<field name="needaction_domain" attrs="{'invisible': [('needaction', '=', False)]}" placeholder="Fill in a domain for a custom needaction" /> |
|||
</field> |
|||
</field> |
|||
</record> |
|||
</data> |
|||
</openerp> |
|||
@ -1,11 +1,9 @@ |
|||
<?xml version="1.0" encoding="UTF-8"?> |
|||
<openerp> |
|||
<data> |
|||
<template id="assets_backend" name="web_menu_navbar_needaction assets" inherit_id="web.assets_backend"> |
|||
<xpath expr="." position="inside"> |
|||
<script type="text/javascript" src="/web_menu_navbar_needaction/static/src/js/web_menu_navbar_needaction.js"></script> |
|||
<link rel="stylesheet" href="/web_menu_navbar_needaction/static/src/css/web_menu_navbar_needaction.css"/> |
|||
</xpath> |
|||
</template> |
|||
</data> |
|||
</openerp> |
|||
<odoo> |
|||
<template id="assets_backend" name="web_menu_navbar_needaction assets" inherit_id="web.assets_backend"> |
|||
<xpath expr="." position="inside"> |
|||
<script type="text/javascript" src="/web_menu_navbar_needaction/static/src/js/web_menu_navbar_needaction.js"></script> |
|||
<link rel="stylesheet" href="/web_menu_navbar_needaction/static/src/css/web_menu_navbar_needaction.css"/> |
|||
</xpath> |
|||
</template> |
|||
</odoo> |
|||
Write
Preview
Loading…
Cancel
Save
Reference in new issue