OCA
/
server-tools
5
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
Browse Source

auditlog - Ability to choose the log type on the rule: Full log (complete but slow) and Fast log (data input only, faster)

pull/1556/head
sebalix 8 years ago
parent
9e371d114b
commit
172659c2ba
4 changed files with 141 additions and 37 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 5
      auditlog/models/log.py
  2. 110
      auditlog/models/rule.py
  3. 60
      auditlog/tests/test_auditlog.py
  4. 3
      auditlog/views/auditlog_view.xml

5
auditlog/models/log.py
View File

@ -40,6 +40,11 @@ class AuditlogLog(models.Model):
'auditlog.http.session', string=u"Session")
http_request_id = fields.Many2one(
'auditlog.http.request', string=u"HTTP Request")
type = fields.Selection(
[('full', u"Full log"),
('fast', u"Fast log"),
],
string=u"Type")
class AuditlogLogLine(models.Model):

110
auditlog/models/rule.py
View File

@ -88,6 +88,16 @@ class AuditlogRule(models.Model):
u"Log Creates", default=True,
help=(u"Select this if you want to keep track of creation on any "
u"record of the model of this rule"))
log_type = fields.Selection(
[('full', u"Full log"),
('fast', u"Fast log"),
],
string=u"Type", required=True, default='full',
help=(u"Full log: make a diff between the data before and after "
u"the operation (log more info like computed fields which were "
u"updated, but it is slower)\n"
u"Fast log: only log the changes made through the create and "
u"write operations (less information, but it is faster)"))
# log_action = fields.Boolean(
# "Log Action",
# help=("Select this if you want to keep track of actions on the "
@ -137,28 +147,28 @@ class AuditlogRule(models.Model):
check_attr = 'auditlog_ruled_create'
if getattr(rule, 'log_create') \
and not hasattr(model_model, check_attr):
model_model._patch_method('create', self._make_create())
model_model._patch_method('create', rule._make_create())
setattr(model_model, check_attr, True)
updated = True
# -> read
check_attr = 'auditlog_ruled_read'
if getattr(rule, 'log_read') \
and not hasattr(model_model, check_attr):
model_model._patch_method('read', self._make_read())
model_model._patch_method('read', rule._make_read())
setattr(model_model, check_attr, True)
updated = True
# -> write
check_attr = 'auditlog_ruled_write'
if getattr(rule, 'log_write') \
and not hasattr(model_model, check_attr):
model_model._patch_method('write', self._make_write())
model_model._patch_method('write', rule._make_write())
setattr(model_model, check_attr, True)
updated = True
# -> unlink
check_attr = 'auditlog_ruled_unlink'
if getattr(rule, 'log_unlink') \
and not hasattr(model_model, check_attr):
model_model._patch_method('unlink', self._make_unlink())
model_model._patch_method('unlink', rule._make_unlink())
setattr(model_model, check_attr, True)
updated = True
return updated
@ -205,25 +215,46 @@ class AuditlogRule(models.Model):
self.unsubscribe()
return super(AuditlogRule, self).unlink()
@api.multi
def _make_create(self):
"""Instanciate a create method that log its calls."""
self.ensure_one()
log_type = self.log_type
@api.model
@api.returns('self', lambda value: value.id)
def create(self, vals, **kwargs):
def create_full(self, vals, **kwargs):
self = self.with_context(auditlog_disabled=True)
rule_model = self.env['auditlog.rule']
new_record = create.origin(self, vals, **kwargs)
new_record = create_full.origin(self, vals, **kwargs)
new_values = dict(
(d['id'], d) for d in new_record.sudo()
.with_context(prefetch_fields=False).read(list(self._fields)))
rule_model.sudo().create_logs(
self.env.uid, self._name, new_record.ids,
'create', None, new_values)
'create', None, new_values, {'type': log_type})
return new_record
@api.model
@api.returns('self', lambda value: value.id)
def create_fast(self, vals, **kwargs):
self = self.with_context(auditlog_disabled=True)
rule_model = self.env['auditlog.rule']
vals2 = dict(vals)
new_record = create_fast.origin(self, vals, **kwargs)
new_values = {new_record.id: vals2}
rule_model.sudo().create_logs(
self.env.uid, self._name, new_record.ids,
'create', None, new_values, {'type': log_type})
return new_record
return create
return create_full if self.log_type == 'full' else create_fast
@api.multi
def _make_read(self):
"""Instanciate a read method that log its calls."""
self.ensure_one()
log_type = self.log_type
def read(self, *args, **kwargs):
result = read.origin(self, *args, **kwargs)
@ -248,7 +279,7 @@ class AuditlogRule(models.Model):
rule_model = env['auditlog.rule']
rule_model.sudo().create_logs(
env.uid, self._name, ids,
'read', read_values)
'read', read_values, None, {'type': log_type})
# New API
else:
# If the call came from auditlog itself, skip logging:
@ -261,42 +292,79 @@ class AuditlogRule(models.Model):
rule_model = self.env['auditlog.rule']
rule_model.sudo().create_logs(
self.env.uid, self._name, self.ids,
'read', read_values)
'read', read_values, None, {'type': log_type})
return result
return read
@api.multi
def _make_write(self):
"""Instanciate a write method that log its calls."""
self.ensure_one()
log_type = self.log_type
@api.multi
def write(self, vals, **kwargs):
def write_full(self, vals, **kwargs):
self = self.with_context(auditlog_disabled=True)
rule_model = self.env['auditlog.rule']
old_values = dict(
(d['id'], d) for d in self.sudo()
.with_context(prefetch_fields=False).read(list(self._fields)))
result = write.origin(self, vals, **kwargs)
result = write_full.origin(self, vals, **kwargs)
new_values = dict(
(d['id'], d) for d in self.sudo()
.with_context(prefetch_fields=False).read(list(self._fields)))
rule_model.sudo().create_logs(
self.env.uid, self._name, self.ids,
'write', old_values, new_values)
'write', old_values, new_values, {'type': log_type})
return result
@api.multi
def write_fast(self, vals, **kwargs):
self = self.with_context(auditlog_disabled=True)
rule_model = self.env['auditlog.rule']
# Log the user input only, no matter if the `vals` is updated
# afterwards as it could not represent the real state
# of the data in the database
vals2 = dict(vals)
old_vals2 = dict.fromkeys(vals2.keys(), False)
old_values = dict((id_, old_vals2) for id_ in self.ids)
new_values = dict((id_, vals2) for id_ in self.ids)
result = write_fast.origin(self, vals, **kwargs)
rule_model.sudo().create_logs(
self.env.uid, self._name, self.ids,
'write', old_values, new_values, {'type': log_type})
return result
return write
return write_full if self.log_type == 'full' else write_fast
@api.multi
def _make_unlink(self):
"""Instanciate an unlink method that log its calls."""
self.ensure_one()
log_type = self.log_type
@api.multi
def unlink(self, **kwargs):
def unlink_full(self, **kwargs):
self = self.with_context(auditlog_disabled=True)
rule_model = self.env['auditlog.rule']
old_values = dict(
(d['id'], d) for d in self.sudo()
.with_context(prefetch_fields=False).read(list(self._fields)))
rule_model.sudo().create_logs(
self.env.uid, self._name, self.ids, 'unlink', old_values)
return unlink.origin(self, **kwargs)
return unlink
self.env.uid, self._name, self.ids, 'unlink', old_values, None,
{'type': log_type})
return unlink_full.origin(self, **kwargs)
@api.multi
def unlink_fast(self, **kwargs):
self = self.with_context(auditlog_disabled=True)
rule_model = self.env['auditlog.rule']
rule_model.sudo().create_logs(
self.env.uid, self._name, self.ids, 'unlink', None, None,
{'type': log_type})
return unlink_fast.origin(self, **kwargs)
return unlink_full if self.log_type == 'full' else unlink_fast
def create_logs(self, uid, res_model, res_ids, method,
old_values=None, new_values=None,
@ -419,7 +487,8 @@ class AuditlogRule(models.Model):
'new_value_text': new_values[log.res_id][field['name']],
}
# for *2many fields, log the name_get
if field['relation'] and '2many' in field['ttype']:
if log.type == 'full' and field['relation'] \
and '2many' in field['ttype']:
# Filter IDs to prevent a 'name_get()' call on deleted resources
existing_ids = self.env[field['relation']]._search(
[('id', 'in', vals['old_value'])])
@ -464,7 +533,8 @@ class AuditlogRule(models.Model):
'new_value': new_values[log.res_id][field['name']],
'new_value_text': new_values[log.res_id][field['name']],
}
if field['relation'] and '2many' in field['ttype']:
if log.type == 'full' and field['relation'] \
and '2many' in field['ttype']:
new_value_text = self.env[field['relation']].browse(
vals['new_value']).name_get()
vals['new_value_text'] = new_value_text

60
auditlog/tests/test_auditlog.py
View File

@ -21,23 +21,7 @@
from openerp.tests.common import TransactionCase
class TestAuditlog(TransactionCase):
def setUp(self):
super(TestAuditlog, self).setUp()
self.groups_model_id = self.env.ref('base.model_res_groups').id
self.groups_rule = self.env['auditlog.rule'].create({
'name': 'testrule for groups',
'model_id': self.groups_model_id,
'log_read': True,
'log_create': True,
'log_write': True,
'log_unlink': True,
'state': 'subscribed',
})
def tearDown(self):
self.groups_rule.unlink()
super(TestAuditlog, self).tearDown()
class TestAuditlog(object):
def test_LogCreation(self):
"""First test, caching some data."""
@ -105,3 +89,45 @@ class TestAuditlog(TransactionCase):
('method', '=', 'write'),
('res_id', '=', testgroup4.id),
]).ensure_one())
class TestAuditlogFull(TransactionCase, TestAuditlog):
def setUp(self):
super(TestAuditlogFull, self).setUp()
self.groups_model_id = self.env.ref('base.model_res_groups').id
self.groups_rule = self.env['auditlog.rule'].create({
'name': 'testrule for groups',
'model_id': self.groups_model_id,
'log_read': True,
'log_create': True,
'log_write': True,
'log_unlink': True,
'state': 'subscribed',
'log_type': 'full',
})
def tearDown(self):
self.groups_rule.unlink()
super(TestAuditlogFull, self).tearDown()
class TestAuditlogFast(TransactionCase, TestAuditlog):
def setUp(self):
super(TestAuditlogFast, self).setUp()
self.groups_model_id = self.env.ref('base.model_res_groups').id
self.groups_rule = self.env['auditlog.rule'].create({
'name': 'testrule for groups',
'model_id': self.groups_model_id,
'log_read': True,
'log_create': True,
'log_write': True,
'log_unlink': True,
'state': 'subscribed',
'log_type': 'fast',
})
def tearDown(self):
self.groups_rule.unlink()
super(TestAuditlogFast, self).tearDown()

3
auditlog/views/auditlog_view.xml
View File

@ -26,6 +26,7 @@
<group colspan="1">
<field name="name" required="1"/>
<field name="model_id"/>
<field name="log_type"/>
<field name="action_id" readonly="1" groups="base.group_no_one"/>
</group>
<group colspan="1">
@ -54,6 +55,7 @@
<tree colors="blue:state == 'draft';black:state == 'subscribed'" string="Rules">
<field name="name"/>
<field name="model_id"/>
<field name="log_type"/>
<field name="log_read"/>
<field name="log_write"/>
<field name="log_unlink"/>
@ -110,6 +112,7 @@
<field name="create_date" readonly="1"/>
<field name="user_id" readonly="1"/>
<field name="method" readonly="1"/>
<field name="type" readonly="1"/>
</group>
<group colspan="1">
<field name="model_id" readonly="1"/>

Write Preview
Loading…
Cancel
Save