Merge pull request #30 from savoirfairelinux/8.0-document_page_approval

[MIG] document page approval
This commit is contained in:
Maxime Chambreuil - http://www.savoirfairelinux.com 2015-04-06 21:12:54 -04:00
commit a82b89373c
18 changed files with 423 additions and 377 deletions

View File

@ -1,243 +0,0 @@
# -*- encoding: utf-8 -*-
##############################################################################
#
# OpenERP, Open Source Management Solution
# Copyright (C) 2013 Savoir-faire Linux (<http://www.savoirfairelinux.com>).
#
# 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 datetime import datetime
from openerp.osv import fields, orm
from openerp.tools import DEFAULT_SERVER_DATETIME_FORMAT
class document_page_history_wkfl(orm.Model):
_inherit = 'document.page.history'
def page_approval_draft(self, cr, uid, ids, context=None):
self.write(cr, uid, ids, {'state': 'draft'})
template_id = self.pool.get('ir.model.data').get_object_reference(
cr, uid,
'document_page_approval',
'email_template_new_draft_need_approval')[1]
for page in self.browse(cr, uid, ids, context=context):
if page.is_parent_approval_required:
self.pool.get('email.template').send_mail(
cr, uid, template_id, page.id, force_send=True
)
return True
def page_approval_approved(self, cr, uid, ids, context=None):
self.write(cr, uid, ids, {
'state': 'approved',
'approved_date': datetime.now().strftime(
DEFAULT_SERVER_DATETIME_FORMAT),
'approved_uid': uid
}, context=context)
return True
def can_user_approve_page(self, cr, uid, ids, name, args, context=None):
user = self.pool.get('res.users').browse(cr, uid, uid, context=context)
res = {}
for page in self.browse(cr, uid, ids, context=context):
res[page.id] = self.can_user_approve_this_page(page.page_id, user)
return res
def can_user_approve_this_page(self, page, user):
if page:
res = page.approver_gid in user.groups_id
res = res or self.can_user_approve_this_page(page.parent_id, user)
else:
res = False
return res
def get_approvers_guids(self, cr, uid, ids, name, args, context=None):
res = {}
for page in self.browse(cr, uid, ids, context=context):
res[page.id] = self.get_approvers_guids_for_page(page.page_id)
return res
def get_approvers_guids_for_page(self, page):
if page:
if page.approver_gid:
res = [page.approver_gid.id]
else:
res = []
res.extend(self.get_approvers_guids_for_page(page.parent_id))
else:
res = []
return res
def get_approvers_email(self, cr, uid, ids, name, args, context):
res = {}
for id in ids:
emails = ''
guids = self.get_approvers_guids(
cr, uid, ids, name, args, context=context)
uids = self.pool.get('res.users').search(
cr, uid, [('groups_id', 'in', guids[id])])
users = self.pool.get('res.users').browse(
cr, uid, uids, context=context)
for user in users:
if user.email:
emails += user.email
emails += ','
else:
empl_id = self.pool.get('hr.employee').search(
cr, uid, [('login', '=', user.login)])[0]
empl = self.pool.get('hr.employee').browse(
cr, uid, empl_id, context=context)
if empl.work_email:
emails += empl.work_email
emails += ','
emails = emails[:-1]
res[id] = emails
return res
def get_page_url(self, cr, uid, ids, name, args, context):
res = {}
for id in ids:
base_url = self.pool.get('ir.config_parameter').get_param(
cr, uid, 'web.base.url', default='http://localhost:8069',
context=context)
res[id] = base_url + (
'/#db=%s&id=%s&view_type=form&model=document.page.history' %
(cr.dbname, id))
return res
_columns = {
'state': fields.selection([
('draft', 'Draft'),
('approved', 'Approved')], 'Status', readonly=True),
'approved_date': fields.datetime("Approved Date"),
'approved_uid': fields.many2one('res.users', "Approved By"),
'is_parent_approval_required': fields.related(
'page_id', 'is_parent_approval_required',
string="parent approval", type='boolean', store=False),
'can_user_approve_page': fields.function(
can_user_approve_page, string="can user approve this page",
type='boolean', store=False),
'get_approvers_email': fields.function(
get_approvers_email, string="get all approvers email",
type='text', store=False),
'get_page_url': fields.function(get_page_url, string="URL",
type='text', store=False),
}
class document_page_approval(orm.Model):
_inherit = 'document.page'
def _get_display_content(self, cr, uid, ids, name, args, context=None):
res = {}
for page in self.browse(cr, uid, ids, context=context):
content = ""
if page.type == "category":
content = self._get_page_index(cr, uid, page, link=False)
else:
history = self.pool.get('document.page.history')
if self.is_approval_required(page):
history_ids = history.search(
cr, uid, [
('page_id', '=', page.id),
('state', '=', 'approved')
], limit=1, order='create_date DESC')
for h in history.browse(cr, uid, history_ids,
context=context):
content = h.content
else:
content = page.content
res[page.id] = content
return res
def _get_approved_date(self, cr, uid, ids, name, args, context=None):
res = {}
for page in self.browse(cr, uid, ids, context=context):
if self.is_approval_required(page):
history = self.pool.get('document.page.history')
history_ids = history.search(
cr, uid, [
('page_id', '=', page.id),
('state', '=', 'approved')
], limit=1, order='create_date DESC')
approved_date = False
for h in history.browse(cr, uid, history_ids):
approved_date = h.approved_date
res[page.id] = approved_date
else:
res[page.id] = ""
return res
def _get_approved_uid(self, cr, uid, ids, name, args, context=None):
res = {}
for page in self.browse(cr, uid, ids, context=context):
if self.is_approval_required(page):
history = self.pool.get('document.page.history')
history_ids = history.search(cr, uid, [
('page_id', '=', page.id),
('state', '=', 'approved')], limit=1,
order='create_date DESC')
approved_uid = False
for h in history.browse(cr, uid, history_ids):
approved_uid = h.approved_uid.id
res[page.id] = approved_uid
else:
res[page.id] = ""
return res
def _is_parent_approval_required(self, cr, uid, ids, name, args,
context=None):
res = {}
for page in self.browse(cr, uid, ids, context=context):
res[page.id] = self.is_approval_required(page)
return res
def is_approval_required(self, page):
if page:
res = page.approval_required
res = res or self.is_approval_required(page.parent_id)
else:
res = False
return res
_columns = {
'display_content': fields.function(
_get_display_content, string='Displayed Content', type='text'),
'approved_date': fields.function(
_get_approved_date, string="Approved Date", type='datetime'),
'approved_uid': fields.function(
_get_approved_uid, string="Approved By", type='many2one',
obj='res.users'),
'approval_required': fields.boolean("Require approval"),
'is_parent_approval_required': fields.function(
_is_parent_approval_required, string="parent approval",
type='boolean'),
'approver_gid': fields.many2one("res.groups", "Approver group"),
}

View File

@ -1,51 +0,0 @@
<?xml version="1.0"?>
<openerp>
<data>
<record id="wiki_history_form_inherit" model="ir.ui.view">
<field name="name">document.page.history.form</field>
<field name="model">document.page.history</field>
<field name="inherit_id" ref="document_page.wiki_history_form"/>
<field name="arch" type="xml">
<xpath expr="//form/label[@for='page_id']" position="before">
<header attrs="{'invisible':[('is_parent_approval_required','=',False)]}">
<span attrs="{'invisible':[('can_user_approve_page','=',False)]}">
<button name="page_approval_approve" string="Approve" states="draft"/>
</span>
<field name="state" widget="statusbar" statusbar_visible="draft,approved"/>
<field name="is_parent_approval_required" invisible="1"/>
<field name="can_user_approve_page" invisible="1"/>
</header>
</xpath>
</field>
</record>
<record id="wiki_form_inherit" model="ir.ui.view">
<field name="name">document.page.form</field>
<field name="model">document.page</field>
<field name="inherit_id" ref="document_page.view_wiki_form"/>
<field name="arch" type="xml">
<field name="display_content" position="before">
<field name="approved_date" class="oe_view_only"/>
<field name="approved_uid" class="oe_view_only"/>
</field>
<field name="parent_id" position="after">
<field name="approval_required" attrs="{'invisible':[('type','=','content')]}"/>
<field name="approver_gid" attrs="{'invisible':['|',('type','=','content'),
('approval_required','!=', True)], 'required':[('approval_required','=', True)]}"/>
</field>
</field>
</record>
<record id="view_wiki_history_tree_inherit" model="ir.ui.view">
<field name="name">document.page.history.tree</field>
<field name="model">document.page.history</field>
<field name="inherit_id" ref="document_page.view_wiki_history_tree"/>
<field name="arch" type="xml">
<field name="page_id" position="after">
<field name="state" attrs="{'invisible':[('is_parent_approval_required','=',False)]}"/>
<field name="is_parent_approval_required" invisible="1"/>
</field>
</field>
</record>
</data>
</openerp>

View File

@ -1,77 +0,0 @@
<?xml version="1.0"?>
<openerp>
<data>
<record model="workflow" id="wkf_document_page_history_aproval">
<field name="name">document.page.history.aproval.wkf</field>
<field name="osv">document.page.history</field>
<field name="on_create">True</field>
</record>
<record model="workflow.activity" id="act_draft">
<field name="wkf_id" ref="wkf_document_page_history_aproval" />
<field name="flow_start">True</field>
<field name="name">draft</field>
<field name="kind">function</field>
<field name="action">page_approval_draft()</field>
</record>
<record model="workflow.activity" id="act_approved">
<field name="wkf_id" ref="wkf_document_page_history_aproval" />
<field name="name">approved</field>
<field name="kind">function</field>
<field name="action">page_approval_approved()</field>
<field name="flow_stop">True</field>
</record>
<record model="workflow.transition" id="tda">
<field name="act_from" ref="act_draft" />
<field name="act_to" ref="act_approved" />
<field name="signal">page_approval_approve</field>
</record>
<record model="workflow.transition" id="tad">
<field name="act_from" ref="act_approved" />
<field name="act_to" ref="act_draft" />
<field name="signal">edit</field>
</record>
</data>
<!-- Allow user to make upgrade-proof customizations to email template -->
<data noupdate="1">
<record id="email_template_new_draft_need_approval" model="email.template">
<field name="name">Automated new draft need approval Notification Mail</field>
<field name="email_from">${object.create_uid.company_id.email or 'noreply@localhost.com'}</field>
<field name="subject">New version of "${object.page_id.name}" to approve</field>
<field name="email_to">${object.get_approvers_email}</field>
<field name="model_id" ref="model_document_page_history"/>
<field name="auto_delete" eval="True"/>
<field name="lang">${object.create_uid.partner_id.lang}</field>
<field name="body_html"><![CDATA[
<p>Hello,</p>
<p>The page "${object.page_id.name}" has been modified and need your approval.</p>
<p>You can review the new version here : <a href="${object.get_page_url}">${object.get_page_url}</a></p>
<p>Have a great day.<br/>
--<br/>
OpenERP</p>]]>
</field>
<field name="body_text"><![CDATA[
Hello,
The page "${object.page_id.name}" has been modified and need your approval.
You can review the new version here: ${object.get_page_url}
Have a great day.
--
OpenERP]]></field>
</record>
</data>
</openerp>

View File

@ -32,7 +32,7 @@ Web pages
'website': 'http://www.openerp.com/',
'license': 'AGPL-3',
'depends': [
'knowledge'
'knowledge',
],
'data': [
'wizard/document_page_create_menu_view.xml',

View File

@ -18,9 +18,12 @@
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
##############################################################################
import logging
import difflib
from openerp import models, fields, api, _
_logger = logging.getLogger(__name__)
class document_page(models.Model):
_name = "document.page"
@ -177,3 +180,14 @@ class document_page_history(models.Model):
"Revision-{}".format(v2),
context=True
)
def __getattr__(self, attr):
"""Return a dummy callabale"""
if attr in ['_sql', 'init', '_ids']:
raise AttributeError
_logger.warning(
"Trying to access attribute %s on document_page_history",
attr
)
return (lambda *a, **b: None)

View File

@ -18,5 +18,4 @@
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
##############################################################################
import document_page_approval
from . import document_page_approval

View File

@ -43,16 +43,18 @@ Scenario
* Users reading the page see the last approved version.
""",
'depends': [
'knowledge',
'document_page',
'email_template',
],
],
'data': [
'data/email_template.xml',
'document_page_wkfl.xml',
'document_page_view.xml',
'security/document_page_security.xml',
'security/ir.model.access.csv',
],
'installable': False,
],
'installable': True,
'auto_install': False,
'images': [
'images/category.png',

View File

@ -0,0 +1,31 @@
<?xml version="1.0"?>
<openerp>
<!-- Allow user to make upgrade-proof customizations to email template -->
<data noupdate="1">
<record id="email_template_new_draft_need_approval"
model="email.template">
<field name="name">Automated new draft need approval Notification Mail</field>
<field name="email_from">${object.create_uid.company_id.email or 'noreply@localhost.com'}</field>
<field name="subject">New version of "${object.page_id.name}" to approve</field>
<field name="email_to">${object.get_approvers_email}</field>
<field name="model_id" ref="model_document_page_history"/>
<field name="auto_delete" eval="True"/>
<field name="lang">${object.create_uid.partner_id.lang}</field>
<field name="body_html"><![CDATA[
<p>Hello,</p>
<p>The page "${object.page_id.name}" has been modified and need your approval.</p>
<p>You can review the new version here : <a href="${object.get_page_url}">${object.get_page_url}</a></p>
<p>Have a great day.<br/>
--<br/>
OpenERP</p>]]>
</field>
</record>
</data>
</openerp>

View File

@ -0,0 +1,258 @@
# -*- encoding: utf-8 -*-
##############################################################################
#
# OpenERP, Open Source Management Solution
# Copyright (C) 2013 Savoir-faire Linux (<http://www.savoirfairelinux.com>).
#
# 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 datetime import datetime
from openerp.tools import DEFAULT_SERVER_DATETIME_FORMAT
from openerp import models, fields
class document_page_history_wkfl(models.Model):
_inherit = 'document.page.history'
def page_approval_draft(self, cr, uid, ids, context=None):
self.write(cr, uid, ids, {'state': 'draft'})
template_id = self.pool.get('ir.model.data').get_object_reference(
cr, uid,
'document_page_approval',
'email_template_new_draft_need_approval')[1]
for page in self.browse(cr, uid, ids, context=context):
if page.is_parent_approval_required:
self.pool.get('email.template').send_mail(
cr,
uid,
template_id,
page.id,
force_send=True
)
return True
def page_approval_approved(self, cr, uid, ids, context=None):
self.write(cr, uid, ids, {
'state': 'approved',
'approved_date': datetime.now().strftime(
DEFAULT_SERVER_DATETIME_FORMAT),
'approved_uid': uid
}, context=context)
return True
def _can_user_approve_page(self):
user = self.env.user
for page in self:
page.can_user_approve_page = page.can_user_approve_this_page(
page.page_id,
user
)
def can_user_approve_this_page(self, page, user):
if page:
res = page.approver_gid in user.groups_id
res = res or self.can_user_approve_this_page(page.parent_id, user)
else:
res = False
return res
def get_approvers_guids(self):
res = {}
for page in self:
res[page.id] = self.get_approvers_guids_for_page(page.page_id)
return res
def get_approvers_guids_for_page(self, page):
if page:
if page.approver_gid:
res = [page.approver_gid.id]
else:
res = []
res.extend(self.get_approvers_guids_for_page(page.parent_id))
else:
res = []
return res
def _get_approvers_email(self):
for page in self:
emails = ''
guids = self.get_approvers_guids()
uids = [i.id for i in self.env['res.users'].search([
('groups_id', 'in', guids[page.id])
])]
users = self.env['res.users'].browse(uids)
for user in users:
if user.email:
emails += user.email
emails += ','
else:
empl = self.env['hr.employee'].search([
('login', '=', user.login)
])
if empl.work_email:
emails += empl.work_email
emails += ','
page.get_approvers_email = emails[:-1]
def _get_page_url(self):
for page in self:
base_url = self.env['ir.config_parameter'].get_param(
'web.base.url',
default='http://localhost:8069'
)
page.get_page_url = (
'{}/#db={}&id={}&view_type=form&'
'model=document.page.history').format(
base_url,
self.env.cr.dbname,
page.id
)
state = fields.Selection(
[('draft', 'Draft'), ('approved', 'Approved')],
'Status',
readonly=True
)
approved_date = fields.Datetime("Approved Date")
approved_uid = fields.Many2one(
'res.users',
"Approved By"
)
is_parent_approval_required = fields.Boolean(
related='page_id.is_parent_approval_required',
string="parent approval",
store=False
)
can_user_approve_page = fields.Boolean(
compute=_can_user_approve_page,
string="can user approve this page",
store=False
)
get_approvers_email = fields.Text(
compute=_get_approvers_email,
string="get all approvers email",
store=False
)
get_page_url = fields.Text(
compute=_get_page_url,
string="URL",
store=False
)
class document_page_approval(models.Model):
_inherit = 'document.page'
def _get_display_content(self):
for page in self:
content = ""
if page.type == "category":
content = self._get_page_index(page, link=False)
else:
history = self.env['document.page.history']
if self.is_approval_required(page):
history_ids = history.search(
[
('page_id', '=', page.id),
('state', '=', 'approved')
],
limit=1,
order='create_date DESC'
)
content = history_ids.content
else:
content = page.content
page.display_content = content
def _get_approved_date(self):
for page in self:
approved_date = False
if self.is_approval_required(page):
history = self.env['document.page.history']
history_ids = history.search(
[
('page_id', '=', page.id),
('state', '=', 'approved')
],
limit=1,
order='create_date DESC'
)
approved_date = history_ids.approved_date
page.approved_date = approved_date
def _get_approved_uid(self):
for page in self:
approved_uid = False
if self.is_approval_required(page):
history = self.env['document.page.history']
history_ids = history.search(
[
('page_id', '=', page.id),
('state', '=', 'approved')
],
limit=1,
order='create_date DESC'
)
approved_uid = history_ids.approved_uid.id
page.approved_uid = approved_uid
def _is_parent_approval_required(self):
for page in self:
page.is_parent_approval_required = self.is_approval_required(page)
def is_approval_required(self, page):
if page:
res = page.approval_required
res = res or self.is_approval_required(page.parent_id)
else:
res = False
return res
display_content = fields.Text(
compute=_get_display_content,
string='Displayed Content'
)
approved_date = fields.Datetime(
compute=_get_approved_date,
string="Approved Date"
)
approved_uid = fields.Many2one(
'res.users',
compute=_get_approved_uid,
string="Approved By",
)
approval_required = fields.Boolean("Require approval")
is_parent_approval_required = fields.Boolean(
compute=_is_parent_approval_required,
string="parent approval"
)
approver_gid = fields.Many2one(
"res.groups",
"Approver group"
)

View File

@ -0,0 +1,70 @@
<?xml version="1.0"?>
<openerp>
<data>
<record id="wiki_history_form_inherit" model="ir.ui.view">
<field name="name">document.page.history.form</field>
<field name="model">document.page.history</field>
<field name="inherit_id"
ref="document_page.wiki_history_form"/>
<field name="arch" type="xml">
<xpath expr="//form/label[@for='page_id']"
position="before">
<header attrs="{'invisible':[('is_parent_approval_required','=',False)]}">
<span attrs="{'invisible':[('can_user_approve_page','=',False)]}">
<button name="page_approval_approve"
string="Approve"
states="draft" />
</span>
<field name="state"
widget="statusbar"
statusbar_visible="draft,approved"/>
<field name="is_parent_approval_required"
invisible="1" />
<field name="can_user_approve_page"
invisible="1" />
</header>
</xpath>
</field>
</record>
<record id="wiki_form_inherit" model="ir.ui.view">
<field name="name">document.page.form</field>
<field name="model">document.page</field>
<field name="inherit_id"
ref="document_page.view_wiki_form" />
<field name="arch" type="xml">
<field name="display_content"
position="before">
<group class="oe_read_only"
attrs="{'invisible':[('type','!=','content')]}">
<field name="approved_date" />
<field name="approved_uid" />
</group>
</field>
<field name="parent_id" position="after">
<field name="approval_required"
attrs="{'invisible':[('type','=','content')]}"/>
<field name="approver_gid"
attrs="{'invisible':['|',('type','=','content'),
('approval_required','!=', True)], 'required':[('approval_required','=', True)]}"/>
</field>
</field>
</record>
<record id="view_wiki_history_tree_inherit" model="ir.ui.view">
<field name="name">document.page.history.tree</field>
<field name="model">document.page.history</field>
<field name="inherit_id"
ref="document_page.view_wiki_history_tree" />
<field name="arch" type="xml">
<field name="page_id" position="after">
<field name="state"
attrs="{'invisible':[('is_parent_approval_required','=',False)]}"/>
<field name="is_parent_approval_required"
invisible="1" />
</field>
</field>
</record>
</data>
</openerp>

View File

@ -0,0 +1,43 @@
<?xml version="1.0"?>
<openerp>
<data>
<record model="workflow" id="wkf_document_page_history_aproval">
<field name="name">document.page.history.aproval.wkf</field>
<field name="osv">document.page.history</field>
<field name="on_create">True</field>
</record>
<record model="workflow.activity" id="act_approved">
<field name="wkf_id"
ref="wkf_document_page_history_aproval" />
<field name="name">approved</field>
<field name="kind">function</field>
<field name="action">page_approval_approved()</field>
<field name="flow_stop">True</field>
</record>
<record model="workflow.activity" id="act_draft">
<field name="wkf_id"
ref="wkf_document_page_history_aproval" />
<field name="flow_start">True</field>
<field name="name">draft</field>
<field name="kind">function</field>
<field name="action">page_approval_draft()</field>
</record>
<record model="workflow.transition" id="tda">
<field name="act_from" ref="act_draft" />
<field name="act_to" ref="act_approved" />
<field name="signal">page_approval_approve</field>
</record>
<record model="workflow.transition" id="tad">
<field name="act_from" ref="act_approved" />
<field name="act_to" ref="act_draft" />
<field name="signal">edit</field>
</record>
</data>
</openerp>

View File

Before

Width:  |  Height:  |  Size: 58 KiB

After

Width:  |  Height:  |  Size: 58 KiB

View File

Before

Width:  |  Height:  |  Size: 59 KiB

After

Width:  |  Height:  |  Size: 59 KiB

View File

Before

Width:  |  Height:  |  Size: 57 KiB

After

Width:  |  Height:  |  Size: 57 KiB