addons/audittrail/audittrail.py

   1 # -*- encoding: utf-8 -*-
   2 ##############################################################################
   3 #
   4 #    OpenERP, Open Source Management Solution
   5 #    Copyright (C) 2004-2009 Tiny SPRL (<http://tiny.be>). All Rights Reserved
   6 #    $Id$
   7 #
   8 #    This program is free software: you can redistribute it and/or modify
   9 #    it under the terms of the GNU General Public License as published by
  10 #    the Free Software Foundation, either version 3 of the License, or
  11 #    (at your option) any later version.
  12 #
  13 #    This program is distributed in the hope that it will be useful,
  14 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 #    GNU General Public License for more details.
  17 #
  18 #    You should have received a copy of the GNU General Public License
  19 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20 #
  21 ##############################################################################
  22
  23
  24 import ir
  25 from osv import fields,osv
  26 import netsvc
  27 import pooler
  28 import time
  29 from tools.translate import _
  30
  31 class audittrail_rule(osv.osv):
  32     _name = 'audittrail.rule'
  33     _columns = {
  34         "name": fields.char("Rule Name", size=32, required=True),
  35         "object_id": fields.many2one('ir.model', 'Object', required=True),
  36         "user_id": fields.many2many('res.users', 'audittail_rules_users', 'user_id', 'rule_id', 'Users'),
  37         "log_read": fields.boolean("Log reads"),
  38         "log_write": fields.boolean("Log writes"),
  39         "log_unlink": fields.boolean("Log deletes"),
  40         "log_create": fields.boolean("Log creates"),
  41         "state": fields.selection((("draft", "Draft"),("subscribed", "Subscribed")), "State", required=True),
  42         "action_id":fields.many2one('ir.actions.act_window',"Action ID"),
  43     }
  44
  45     _defaults = {
  46         'state': lambda *a: 'draft',
  47         'log_create': lambda *a: 1,
  48         'log_unlink': lambda *a: 1,
  49         'log_write': lambda *a: 1,
  50     }
  51
  52     _sql_constraints = [
  53         ('model_uniq', 'unique (object_id)', """There is a rule defined on this object\n You can not define other on the same!""")
  54     ]
  55     __functions = {}
  56
  57     def subscribe(self, cr, uid, ids, *args):
  58         for thisrule in self.browse(cr, uid, ids):
  59             obj = self.pool.get(thisrule.object_id.model)
  60             if not obj:
  61                 raise osv.except_osv(
  62                         _('WARNING:audittrail is not part of the pool'),
  63                         _('Change audittrail depends -- Setting rule as DRAFT'))
  64                 self.write(cr, uid, [thisrule.id], {"state": "draft"})
  65             val={
  66                  "name":'View Log',
  67                  "res_model":'audittrail.log',
  68                  "src_model":thisrule.object_id.model,
  69                  "domain":"[('object_id','=',"+str(thisrule.object_id.id)+"),('res_id', '=', active_id)]"
  70
  71             }
  72             id=self.pool.get('ir.actions.act_window').create(cr, uid, val)
  73             self.write(cr, uid, [thisrule.id], {"state": "subscribed","action_id":id})
  74             keyword = 'client_action_relate'
  75             value = 'ir.actions.act_window,'+str(id)
  76             res=self.pool.get('ir.model.data').ir_set(cr, uid, 'action', keyword,'View_log_'+thisrule.object_id.model, [thisrule.object_id.model], value, replace=True, isobject=True, xml_id=False)
  77         return True
  78
  79
  80
  81     def unsubscribe(self, cr, uid, ids, *args):
  82         for thisrule in self.browse(cr, uid, ids):
  83             if thisrule.id in self.__functions :
  84                 for function in self.__functions[thisrule.id]:
  85                     setattr(function[0], function[1], function[2])
  86             w_id=self.pool.get('ir.actions.act_window').search(cr, uid, [('name','=','View Log'),('res_model','=','audittrail.log'),('src_model','=',thisrule.object_id.model)])
  87             self.pool.get('ir.actions.act_window').unlink(cr, uid,w_id )
  88             val_obj=self.pool.get('ir.values')
  89             value="ir.actions.act_window"+','+str(w_id[0])
  90             val_id=val_obj.search(cr, uid, [('model','=',thisrule.object_id.model),('value','=',value)])
  91             if val_id:
  92                 res = ir.ir_del(cr, uid, val_id[0])
  93             self.write(cr, uid, [thisrule.id], {"state": "draft"})
  94         return True
  95
  96 audittrail_rule()
  97
  98
  99 class audittrail_log(osv.osv):
 100     _name = 'audittrail.log'
 101     _columns = {
 102         "name": fields.char("Name", size=32),
 103         "object_id": fields.many2one('ir.model', 'Object'),
 104         "user_id": fields.many2one('res.users', 'User'),
 105         "method": fields.selection((('read', 'Read'), ('write', 'Write'), ('unlink', 'Delete'), ('create', 'Create')), "Method"),
 106         "timestamp": fields.datetime("Date"),
 107         "res_id":fields.integer('Resource Id'),
 108         "line_ids":fields.one2many('audittrail.log.line','log_id','Log lines')
 109
 110     }
 111     _defaults = {
 112         "timestamp": lambda *a: time.strftime("%Y-%m-%d %H:%M:%S")
 113     }
 114     _order = "timestamp desc"
 115
 116 audittrail_log()
 117
 118 class audittrail_log_line(osv.osv):
 119     _name='audittrail.log.line'
 120     _columns={
 121               'field_id': fields.many2one('ir.model.fields','Fields', required=True),
 122               'log_id':fields.many2one('audittrail.log','Log'),
 123               'log':fields.integer("Log ID"),
 124               'old_value':fields.text("Old Value"),
 125               'new_value':fields.text("New Value"),
 126               'old_value_text':fields.text('Old value Text' ),
 127               'new_value_text':fields.text('New value Text' ),
 128               'field_description':fields.char('Field Description' ,size=64),
 129               }
 130
 131 audittrail_log_line()
 132
 133
 134 objects_proxy = netsvc.SERVICES['object'].__class__
 135
 136 class audittrail_objects_proxy(objects_proxy):
 137
 138     def get_value_text(self, cr, uid, field_name, values, object, context={}):
 139             pool = pooler.get_pool(cr.dbname)
 140             obj=pool.get(object.model)
 141             object_name=obj._name
 142             obj_ids= pool.get('ir.model').search(cr, uid,[('model','=',object_name)])
 143             model_object=pool.get('ir.model').browse(cr,uid,obj_ids)[0]
 144             f_id= pool.get('ir.model.fields').search(cr, uid,[('name','=',field_name),('model_id','=',object.id)])
 145             if f_id:
 146                 field=pool.get('ir.model.fields').read(cr, uid,f_id)[0]
 147                 model=field['relation']
 148
 149                 if field['ttype']=='many2one':
 150                     if values:
 151                         if type(values)==tuple:
 152                             values=values[0]
 153                         val=pool.get(model).read(cr,uid,[values],[pool.get(model)._rec_name])
 154                         if len(val):
 155                             return val[0][pool.get(model)._rec_name]
 156                 elif field['ttype'] == 'many2many':
 157                     value=[]
 158                     if values:
 159                         for id in values:
 160                             val=pool.get(model).read(cr,uid,[id],[pool.get(model)._rec_name])
 161                             if len(val):
 162                                 value.append(val[0][pool.get(model)._rec_name])
 163                     return value
 164
 165                 elif field['ttype'] == 'one2many':
 166
 167                     if values:
 168                         value=[]
 169                         for id in values:
 170                             val=pool.get(model).read(cr,uid,[id],[pool.get(model)._rec_name])
 171
 172                             if len(val):
 173                                 value.append(val[0][pool.get(model)._rec_name])
 174                         return value
 175             return values
 176
 177     def create_log_line(self, cr, uid, id, object, lines=[]):
 178         pool = pooler.get_pool(cr.dbname)
 179         obj=pool.get(object.model)
 180         object_name=obj._name
 181         obj_ids= pool.get('ir.model').search(cr, uid,[('model','=',object_name)])
 182         model_object=pool.get('ir.model').browse(cr,uid,obj_ids)[0]
 183         for line in lines:
 184             f_id= pool.get('ir.model.fields').search(cr, uid,[('name','=',line['name']),('model_id','=',object.id)])
 185             if len(f_id):
 186                 fields=pool.get('ir.model.fields').read(cr, uid,f_id)
 187                 old_value='old_value' in line and  line['old_value'] or ''
 188                 new_value='new_value' in line and  line['new_value'] or ''
 189                 old_value_text='old_value_text' in line and  line['old_value_text'] or ''
 190                 new_value_text='new_value_text' in line and  line['new_value_text'] or ''
 191
 192                 if fields[0]['ttype']== 'many2one':
 193                     if type(old_value)==tuple:
 194                         old_value=old_value[0]
 195                     if type(new_value)==tuple:
 196                         new_value=new_value[0]
 197                 log_line_id = pool.get('audittrail.log.line').create(cr, uid, {"log_id": id, "field_id": f_id[0] ,"old_value":old_value ,"new_value":new_value,"old_value_text":old_value_text ,"new_value_text":new_value_text,"field_description":fields[0]['field_description']})
 198                 cr.commit()
 199         return True
 200
 201     def log_fct(self, db, uid, passwd, object, method, fct_src, *args):
 202             logged_uids = []
 203             pool = pooler.get_pool(db)
 204             cr = pooler.get_db(db).cursor()
 205             obj=pool.get(object)
 206             object_name=obj._name
 207             obj_ids= pool.get('ir.model').search(cr, uid,[('model','=',object_name)])
 208             model_object=pool.get('ir.model').browse(cr,uid,obj_ids)[0]
 209             if method in ('create'):
 210                 res_id = fct_src( db, uid, passwd, object, method, *args)
 211                 cr.commit()
 212                 new_value=pool.get(model_object.model).read(cr,uid,[res_id],args[0].keys())[0]
 213                 if 'id' in new_value:
 214                     del new_value['id']
 215                 if not len(logged_uids) or uid in logged_uids:
 216                     id=pool.get('audittrail.log').create(cr, uid, {"method": method , "object_id": model_object.id, "user_id": uid, "res_id": res_id,"name": "%s %s %s" % (method , model_object.id, time.strftime("%Y-%m-%d %H:%M:%S"))})
 217                     lines=[]
 218                     for field in new_value:
 219                         if new_value[field]:
 220                             line={
 221                                   'name':field,
 222                                   'new_value':new_value[field],
 223                                   'new_value_text': self.get_value_text(cr,uid,field,new_value[field],model_object)
 224                                   }
 225                             lines.append(line)
 226                     self.create_log_line(cr,uid,id,model_object,lines)
 227                 cr.commit()
 228                 cr.close()
 229                 return res_id
 230
 231             if method in ('write'):
 232                 res_ids=args[0]
 233                 for res_id in res_ids:
 234                     old_values=pool.get(model_object.model).read(cr,uid,res_id,args[1].keys())
 235                     old_values_text={}
 236                     for field in args[1].keys():
 237                         old_values_text[field] = self.get_value_text(cr,uid,field,old_values[field],model_object)
 238                     res =fct_src( db, uid, passwd, object, method, *args)
 239                     cr.commit()
 240                     if res:
 241                         new_values=pool.get(model_object.model).read(cr,uid,res_ids,args[1].keys())[0]
 242                         if not len(logged_uids) or uid in logged_uids:
 243                             id=pool.get('audittrail.log').create(cr, uid, {"method": method, "object_id": model_object.id, "user_id": uid, "res_id": res_id,"name": "%s %s %s" % (method , model_object.id, time.strftime("%Y-%m-%d %H:%M:%S"))})
 244                             lines=[]
 245                             for field in args[1].keys():
 246                                 if args[1].keys():
 247                                     line={
 248                                           'name':field,
 249                                           'new_value':field in new_values and new_values[field] or '',
 250                                           'old_value':field in old_values and old_values[field] or '',
 251                                           'new_value_text': self.get_value_text(cr,uid,field,new_values[field],model_object),
 252                                           'old_value_text':old_values_text[field]
 253                                           }
 254                                     lines.append(line)
 255                             cr.commit()
 256                             self.create_log_line(cr,uid,id,model_object,lines)
 257                     cr.close()
 258                     return res
 259
 260             if method in ('read'):
 261                 res_ids=args[0]
 262                 old_values={}
 263                 res =fct_src( db, uid, passwd, object, method, *args)
 264                 if type(res)==list:
 265
 266                     for v in res:
 267                         old_values[v['id']]=v
 268                 else:
 269                     old_values[res['id']]=res
 270                 for res_id in old_values:
 271                     if not len(logged_uids) or uid in logged_uids:
 272                         id=pool.get('audittrail.log').create(cr, uid, {"method": method , "object_id": model_object.id, "user_id": uid, "res_id": res_id,"name": "%s %s %s" % (method , model_object.id, time.strftime("%Y-%m-%d %H:%M:%S"))})
 273                         lines=[]
 274                         for field in old_values[res_id]:
 275                             if old_values[res_id][field]:
 276                                 line={
 277                                           'name':field,
 278                                           'old_value':old_values[res_id][field],
 279                                           'old_value_text': self.get_value_text(cr,uid,field,old_values[res_id][field],model_object)
 280                                           }
 281                                 lines.append(line)
 282                     cr.commit()
 283                     self.create_log_line(cr,uid,id,model_object,lines)
 284                 cr.close()
 285                 return res
 286
 287             if method in ('unlink'):
 288                 res_ids=args[0]
 289                 old_values={}
 290                 for res_id in res_ids:
 291                     old_values[res_id]=pool.get(model_object.model).read(cr,uid,res_id,[])
 292
 293                 for res_id in res_ids:
 294                     if not len(logged_uids) or uid in logged_uids:
 295                         id=pool.get('audittrail.log').create(cr, uid, {"method": method , "object_id": model_object.id, "user_id": uid, "res_id": res_id,"name": "%s %s %s" % (method, model_object,  time.strftime("%Y-%m-%d %H:%M:%S"))})
 296                         lines=[]
 297                         for field in old_values[res_id]:
 298                             if old_values[res_id][field]:
 299                                 line={
 300                                       'name':field,
 301                                       'old_value':old_values[res_id][field],
 302                                       'old_value_text': self.get_value_text(cr,uid,field,old_values[res_id][field],model_object)
 303                                       }
 304                                 lines.append(line)
 305                         cr.commit()
 306                         self.create_log_line(cr,uid,id,model_object,lines)
 307                 res =fct_src( db, uid, passwd, object, method, *args)
 308                 cr.close()
 309                 return res
 310             cr.close()
 311
 312     def execute(self, db, uid, passwd, model, method, *args):
 313         pool = pooler.get_pool(db)
 314         cr = pooler.get_db(db).cursor()
 315         try:
 316             proxy = pool.get(model)
 317             if proxy is None:
 318                 raise Exception('Unknow model: %r' % (model,))
 319
 320             logged_uids = []
 321             model_name = proxy._name
 322
 323             fct_src = super(audittrail_objects_proxy, self).execute
 324
 325             field = method
 326             rule = False
 327             obj_ids= pool.get('ir.model').search(cr, uid,[('model','=',model_name)])
 328             for obj_name in pool.obj_list():
 329                 if obj_name == 'audittrail.rule':
 330                     rule = True
 331             if not rule:
 332                 return fct_src(db, uid, passwd, model, method, *args)
 333             if not len(obj_ids):
 334                 return fct_src(db, uid, passwd, model, method, *args)
 335             rule_ids=pool.get('audittrail.rule').search(cr, uid, [('object_id','=',obj_ids[0]),('state','=','subscribed')])
 336             if not len(rule_ids):
 337                 return fct_src(db, uid, passwd, model, method, *args)
 338
 339             for thisrule in pool.get('audittrail.rule').browse(cr, uid, rule_ids):
 340                 for user in thisrule.user_id:
 341                     logged_uids.append(user.id)
 342                 if not len(logged_uids) or uid in logged_uids:
 343                     if field in ('read','write','create','unlink'):
 344                         if getattr(thisrule, 'log_'+field):
 345                             return self.log_fct(db, uid, passwd, model, method, fct_src, *args)
 346                 return fct_src(db, uid, passwd, model, method, *args)
 347         finally:
 348             cr.close()
 349             pass
 350
 351 audittrail_objects_proxy()
 352
 353 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4:
 354