addons/base_module_record/base_module_record.py

   1 # -*- coding: utf-8 -*-
   2 ##############################################################################
   3 #
   4 #    OpenERP, Open Source Management Solution
   5 #    Copyright (C) 2004-2010 Tiny SPRL (<http://tiny.be>).
   6 #
   7 #    This program is free software: you can redistribute it and/or modify
   8 #    it under the terms of the GNU Affero General Public License as
   9 #    published by the Free Software Foundation, either version 3 of the
  10 #    License, or (at your option) any later version.
  11 #
  12 #    This program is distributed in the hope that it will be useful,
  13 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 #    GNU Affero General Public License for more details.
  16 #
  17 #    You should have received a copy of the GNU Affero General Public License
  18 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19 #
  20 ##############################################################################
  21
  22 from xml.dom import minidom
  23 from osv.osv import osv_pool
  24 from osv import fields,osv
  25 import netsvc
  26 import pooler
  27 import string
  28 import tools
  29
  30 #objects_proxy = netsvc.ExportService.getService('object').__class__
  31 class recording_objects_proxy(osv_pool):
  32     def execute(self, *args, **argv):
  33         if len(args) >= 6 and isinstance(args[5], dict):
  34             _old_args = args[5].copy()
  35         else:
  36             _old_args = None
  37         res = super(recording_objects_proxy, self).execute(*args, **argv)
  38         pool = pooler.get_pool(args[0])
  39         mod = pool.get('ir.module.record')
  40         if mod and mod.recording:
  41             if args[3] not in ('default_get','read','fields_view_get','fields_get','search','search_count','name_search','name_get','get','request_get', 'get_sc', 'unlink'):
  42                 if _old_args is not None:
  43                     args[5].update(_old_args)
  44                     if args[5]:
  45                         mod.recording_data.append(('query', args, argv,res))
  46         return res
  47
  48     def exec_workflow(self, *args, **argv):
  49         res = super(recording_objects_proxy, self).exec_workflow(*args, **argv)
  50         pool = pooler.get_pool(args[0])
  51         mod = pool.get('ir.module.record')
  52         if mod and mod.recording:
  53             mod.recording_data.append(('workflow', args, argv))
  54         return res
  55
  56 recording_objects_proxy()
  57
  58 class xElement(minidom.Element):
  59     """dom.Element with compact print
  60     The Element in minidom has a problem: if printed, adds whitespace
  61     around the text nodes. The standard will not ignore that whitespace.
  62     This class simply prints the contained nodes in their compact form, w/o
  63     added spaces.
  64     """
  65     def writexml(self, writer, indent="", addindent="", newl=""):
  66         writer.write(indent)
  67         minidom.Element.writexml(self, writer, indent='', addindent='', newl='')
  68         writer.write(newl)
  69
  70 def doc_createXElement(xdoc, tagName):
  71         e = xElement(tagName)
  72         e.ownerDocument = xdoc
  73         return e
  74
  75 class base_module_record(osv.osv):
  76     _name = "ir.module.record"
  77     _columns = {
  78
  79     }
  80     def __init__(self, *args, **kwargs):
  81         self.recording = 0
  82         self.recording_data = []
  83         self.depends = {}
  84         super(base_module_record, self).__init__(*args, **kwargs)
  85
  86     # To Be Improved
  87     def _create_id(self, cr, uid, model, data):
  88         i = 0
  89         while True:
  90             try:
  91                 name = filter(lambda x: x in string.letters, (data.get('name','') or '').lower())
  92             except:
  93                 name=''
  94             val = model.replace('.','_')+'_'+name+ str(i)
  95             i+=1
  96             if val not in self.ids.values():
  97                 break
  98         return val
  99
 100     def _get_id(self, cr, uid, model, id):
 101         if type(id)==type(()):
 102             id=id[0]
 103         if (model,id) in self.ids:
 104             return self.ids[(model,id)], False
 105         dt = self.pool.get('ir.model.data')
 106         dtids = dt.search(cr, uid, [('model','=',model), ('res_id','=',id)])
 107         if not dtids:
 108             return None, None
 109         obj = dt.browse(cr, uid, dtids[0])
 110         self.depends[obj.module] = True
 111         return obj.module+'.'+obj.name, obj.noupdate
 112
 113     def _create_record(self, cr, uid, doc, model, data, record_id, noupdate=False):
 114         record = doc.createElement('record')
 115         record.setAttribute("id", record_id)
 116         record.setAttribute("model", model)
 117         record_list = [record]
 118         lids  = self.pool.get('ir.model.data').search(cr, uid, [('model','=',model)])
 119         res = self.pool.get('ir.model.data').read(cr, uid, lids[:1], ['module'])
 120         if res:
 121             self.depends[res[0]['module']]=True
 122         fields = self.pool.get(model).fields_get(cr, uid)
 123         for key,val in data.items():
 124             if not (val or (fields[key]['type']=='boolean')):
 125                 continue
 126             if fields[key]['type'] in ('integer','float'):
 127                 field = doc.createElement('field')
 128                 field.setAttribute("name", key)
 129                 field.setAttribute("eval", val and str(val) or 'False' )
 130                 record.appendChild(field)
 131             elif fields[key]['type'] in ('boolean',):
 132                 field = doc.createElement('field')
 133                 field.setAttribute("name", key)
 134                 field.setAttribute("eval", val and '1' or '0' )
 135                 record.appendChild(field)
 136             elif fields[key]['type'] in ('many2one',):
 137                 field = doc.createElement('field')
 138                 field.setAttribute("name", key)
 139                 if type(val) in (type(''),type(u'')):
 140                     id = val
 141                 else:
 142                     id,update = self._get_id(cr, uid, fields[key]['relation'], val)
 143                     noupdate = noupdate or update
 144                 if not id:
 145                     field.setAttribute("model", fields[key]['relation'])
 146                     fld_nm = self.pool.get(fields[key]['relation'])._rec_name
 147                     name = self.pool.get(fields[key]['relation']).read(cr, uid, val,[fld_nm])[fld_nm] or False
 148                     field.setAttribute("search", str([(str(fld_nm) ,'=', name)]))
 149                 else:
 150                     field.setAttribute("ref", id)
 151                 record.appendChild(field)
 152             elif fields[key]['type'] in ('one2many',):
 153                 for valitem in (val or []):
 154                     if valitem[0] in (0,1):
 155                         if key in self.pool.get(model)._columns:
 156                             fname = self.pool.get(model)._columns[key]._fields_id
 157                         else:
 158                             fname = self.pool.get(model)._inherit_fields[key][2]._fields_id
 159                         valitem[2][fname] = record_id
 160                         newid,update = self._get_id(cr, uid, fields[key]['relation'], valitem[1])
 161                         if not newid:
 162                             newid = self._create_id(cr, uid, fields[key]['relation'], valitem[2])
 163                         self.ids[(fields[key]['relation'], valitem[1])] = newid
 164
 165                         childrecord, update = self._create_record(cr, uid, doc, fields[key]['relation'],valitem[2], newid)
 166                         noupdate = noupdate or update
 167                         record_list += childrecord
 168                     else:
 169                         pass
 170             elif fields[key]['type'] in ('many2many',):
 171                 res = []
 172                 for valitem in (val or []):
 173                     if valitem[0]==6:
 174                         for id2 in valitem[2]:
 175                             id,update = self._get_id(cr, uid, fields[key]['relation'], id2)
 176                             self.ids[(fields[key]['relation'],id2)] = id
 177                             noupdate = noupdate or update
 178                             res.append(id)
 179                         field = doc.createElement('field')
 180                         field.setAttribute("name", key)
 181                         field.setAttribute("eval", "[(6,0,["+','.join(map(lambda x: "ref('%s')" % (x,), res))+'])]')
 182                         record.appendChild(field)
 183             else:
 184                 field = doc_createXElement(doc, 'field')
 185                 field.setAttribute("name", key)
 186                 field.appendChild(doc.createTextNode(val))
 187                 record.appendChild(field)
 188
 189         return record_list, noupdate
 190
 191     def _create_yaml_record(self, cr, uid, model, data, record_id):
 192         record={'model': model, 'id': str(record_id)}
 193         lids  = self.pool.get('ir.model.data').search(cr, uid, [('model','=',model)])
 194         res = self.pool.get('ir.model.data').read(cr, uid, lids[:1], ['module'])
 195         attrs={}
 196         if res:
 197             self.depends[res[0]['module']]=True
 198         fields = self.pool.get(model).fields_get(cr, uid)
 199         defaults={}
 200         defaults[model] = self.pool.get(model).default_get(cr, uid, data)
 201         for key,val in data.items():
 202             if ((key in defaults[model]) and (val ==  defaults[model][key])) and not(fields[key].get('required',False)):
 203                 continue
 204             if not (val or (fields[key]['type']=='boolean')):
 205                 continue
 206             elif fields[key]['type'] in ('boolean',):
 207                 if not val:
 208                     continue
 209                 attrs[key] = val
 210             elif fields[key]['type'] in ('integer','float'):
 211                 attrs[key] = val
 212             elif fields[key]['type'] in ('many2one',):
 213                 if type(val) in (type(''),type(u'')):
 214                     id = val
 215                 else:
 216                     id,update = self._get_id(cr, uid, fields[key]['relation'], val)
 217                 attrs[key] = str(id)
 218             elif fields[key]['type'] in ('one2many',):
 219                 items=[[]]
 220                 for valitem in (val or []):
 221                     if valitem[0] in (0,1):
 222                         if key in self.pool.get(model)._columns:
 223                             fname = self.pool.get(model)._columns[key]._fields_id
 224                         else:
 225                             fname = self.pool.get(model)._inherit_fields[key][2]._fields_id
 226                         valitem[2][fname] = record_id
 227                         newid,update = self._get_id(cr, uid, fields[key]['relation'], valitem[1])
 228                         if not newid:
 229                             newid = self._create_id(cr, uid, fields[key]['relation'], valitem[2])
 230                         self.ids[(fields[key]['relation'], valitem[1])] = newid
 231                         childrecord = self._create_yaml_record(cr, uid, fields[key]['relation'],valitem[2], newid)
 232                         items[0].append(childrecord['attrs'])
 233                 attrs[key] = items
 234             elif fields[key]['type'] in ('many2many',):
 235                 if (key in defaults[model]) and (val[0][2] ==  defaults[model][key]):
 236                     continue
 237                 res = []
 238                 for valitem in (val or []):
 239                     if valitem[0]==6:
 240                         for id2 in valitem[2]:
 241                             id,update = self._get_id(cr, uid, fields[key]['relation'], id2)
 242                             self.ids[(fields[key]['relation'],id2)] = id
 243                             res.append(str(id))
 244                         m2m=[res]
 245                 if m2m[0]:
 246                     attrs[key] = m2m
 247             else:
 248                 val=val.replace('"','\'')
 249                 try:
 250                     attrs[key]=str(val)
 251                 except:
 252                     attrs[key]=tools.ustr(val)
 253         record['attrs'] = attrs
 254         return record
 255
 256     def get_copy_data(self, cr, uid, model, id, result):
 257         res = []
 258         obj=self.pool.get(model)
 259         data=obj.read(cr, uid,[id])
 260         if type(data)==type([]):
 261             del data[0]['id']
 262             data=data[0]
 263         else:
 264             del data['id']
 265
 266         mod_fields = obj.fields_get(cr, uid)
 267         for f in filter(lambda a: isinstance(obj._columns[a], fields.function)\
 268                     and (not obj._columns[a].store),obj._columns):
 269             del data[f]
 270
 271         for key,val in data.items():
 272             if result.has_key(key):
 273                 continue
 274             if mod_fields[key]['type'] == 'many2one':
 275                 if type(data[key])==type(True) or type(data[key])==type(1):
 276                     result[key]=data[key]
 277                 elif not data[key]:
 278                     result[key] = False
 279                 else:
 280                     result[key]=data[key][0]
 281
 282             elif mod_fields[key]['type'] in ('one2many',):
 283 #                continue # due to this start stop recording will not record one2many field
 284                 rel = mod_fields[key]['relation']
 285                 if len(data[key]):
 286                     res1=[]
 287                     for rel_id in data[key]:
 288                         res=[0,0]
 289                         res.append(self.get_copy_data(cr, uid,rel,rel_id,{}))
 290                         res1.append(res)
 291                     result[key]=res1
 292                 else:
 293                     result[key]=data[key]
 294
 295             elif mod_fields[key]['type'] == 'many2many':
 296                 result[key]=[(6,0,data[key])]
 297
 298             else:
 299                 result[key]=data[key]
 300         for k,v in obj._inherits.items():
 301             del result[v]
 302         return result
 303
 304     def _create_function(self, cr, uid, doc, model, name, record_id):
 305         record = doc.createElement('function')
 306         record.setAttribute("name", name)
 307         record.setAttribute("model", model)
 308         record_list = [record]
 309
 310         value = doc.createElement('value')
 311         value.setAttribute('eval', '[ref(\'%s\')]' % (record_id, ))
 312         value.setAttribute('model', model)
 313
 314         record.appendChild(value)
 315         return record_list, False
 316
 317     def _generate_object_xml(self, cr, uid, rec, recv, doc, result=None):
 318         record_list = []
 319         noupdate = False
 320         if rec[4]=='write':
 321             for id in rec[5]:
 322                 id,update = self._get_id(cr, uid, rec[3], id)
 323                 noupdate = noupdate or update
 324                 if not id:
 325                     continue
 326                 record,update = self._create_record(cr, uid, doc, rec[3], rec[6], id)
 327                 noupdate = noupdate or update
 328                 record_list += record
 329
 330         elif rec[4] in ('menu_create',):
 331             for id in rec[5]:
 332                 id,update = self._get_id(cr, uid, rec[3], id)
 333                 noupdate = noupdate or update
 334                 if not id:
 335                     continue
 336                 record,update = self._create_function(cr, uid, doc, rec[3], rec[4], id)
 337                 noupdate = noupdate or update
 338                 record_list += record
 339
 340         elif rec[3]=='create':
 341             id = self._create_id(cr, uid, rec[2],rec[4])
 342             record,noupdate = self._create_record(cr, uid, doc, rec[2], rec[4], id)
 343             self.ids[(rec[3], result)] = id
 344             record_list += record
 345
 346         elif rec[3]=='copy':
 347             data=self.get_copy_data(cr,uid,rec[2],rec[4],rec[5])
 348             copy_rec=(rec[0],rec[1],rec[2],rec[3],rec[4],data,rec[5])
 349             rec=copy_rec
 350             rec_data=[(self.recording_data[0][0],rec,self.recording_data[0][2],self.recording_data[0][3])]
 351             self.recording_data=rec_data
 352             id = self._create_id(cr, uid, rec[2],rec[5])
 353             record,noupdate = self._create_record(cr, uid, doc, rec[2], rec[5], id)
 354             self.ids[(rec[2], result)] = id
 355             record_list += record
 356
 357         return record_list,noupdate
 358
 359     def _generate_object_yaml(self, cr, uid, rec, result=None):
 360         if self.mode=="create":
 361             id = self._create_id(cr, uid, rec[2],rec[4])
 362             self.ids[(rec[2], result)] = id
 363             record = self._create_yaml_record(cr, uid, rec[2], rec[4], id)
 364             return record
 365         data=self.get_copy_data(cr,uid,rec[2],rec[4],rec[5])
 366         copy_rec=(rec[0],rec[1],rec[2],rec[3],rec[4],data,rec[5])
 367         rec=copy_rec
 368         rec_data=[(self.recording_data[0][0],rec,self.recording_data[0][2],self.recording_data[0][3])]
 369         self.recording_data=rec_data
 370         id = self._create_id(cr, uid, rec[2],rec[5])
 371         record = self._create_yaml_record(cr, uid, str(rec[2]), rec[5], id)
 372         self.ids[(rec[2], result)] = id
 373         return record
 374
 375     def _generate_assert_xml(self, rec, doc):
 376         pass
 377
 378     def generate_xml(self, cr, uid):
 379         # Create the minidom document
 380         if len(self.recording_data):
 381             self.ids = {}
 382             doc = minidom.Document()
 383             terp = doc.createElement("openerp")
 384             doc.appendChild(terp)
 385             for rec in self.recording_data:
 386                 if rec[0]=='workflow':
 387                     rec_id,noupdate = self._get_id(cr, uid, rec[1][3], rec[1][5])
 388                     if not rec_id:
 389                         continue
 390                     data = doc.createElement("data")
 391                     terp.appendChild(data)
 392                     wkf = doc.createElement('workflow')
 393                     data.appendChild(wkf)
 394                     wkf.setAttribute("model", rec[1][3])
 395                     wkf.setAttribute("action", rec[1][4])
 396                     if noupdate:
 397                         data.setAttribute("noupdate", "1")
 398                     wkf.setAttribute("ref", rec_id)
 399                 if rec[0]=='query':
 400                     res_list,noupdate = self._generate_object_xml(cr, uid, rec[1], rec[2], doc, rec[3])
 401                     data = doc.createElement("data")
 402                     if noupdate:
 403                         data.setAttribute("noupdate", "1")
 404                     if res_list:
 405                         terp.appendChild(data)
 406                     for res in res_list:
 407                         data.appendChild(res)
 408                 elif rec[0]=='assert':
 409                         pass
 410             return doc.toprettyxml(indent="\t").encode('utf-8')
 411
 412     def generate_yaml(self, cr, uid):
 413         self.ids = {}
 414         if len(self.recording_data):
 415             strg='''import yaml
 416
 417 class record(yaml.YAMLObject):
 418     yaml_tag = u'!record'
 419     def __init__(self, model, id=None, attrs={}):
 420         self.model = model
 421         self.id = id
 422         self.attrs=attrs
 423     def __repr__(self):
 424         return '!record {model: %s, id: %s}:' % (str(self.model,), str(self.id,))
 425
 426 class ref(yaml.YAMLObject):
 427     yaml_tag = u'!ref'
 428     def __init__(self, expr="False"):
 429         self.expr = expr
 430     def __repr__(self):
 431         return 'ref(%s)' % (str(self.expr,))
 432
 433 class eval(yaml.YAMLObject):
 434     yaml_tag = u'!eval'
 435     def __init__(self, expr="False"):
 436         self.expr = expr
 437     def __repr__(self):
 438         return 'eval(%s)' % (str(self.expr,))
 439 \n'''
 440
 441             for rec in self.recording_data:
 442                 if rec[1][3] == 'create':
 443                     self.mode="create"
 444                 elif rec[1][3] == 'copy':
 445                     self.mode="copy"
 446                 else:
 447                     continue
 448                 record= self._generate_object_yaml(cr, uid, rec[1],rec[3])
 449                 strg+="object=yaml.load(unicode('''\n !record %s \n''','iso-8859-1'))"%record
 450                 strg+='''
 451 print object
 452 attrs=yaml.dump(object.attrs, default_flow_style=False)
 453 print attrs \n\n'''
 454
 455             import os
 456             py_path = os.path.join(os.getcwd(), 'records.py')
 457             txt_path = os.path.join(os.getcwd(), 'records.txt')
 458             f = open(py_path, 'w')
 459             f.write(strg)
 460             f.close()
 461             os.system('python %s > %s'%(py_path,txt_path))
 462             f = open(txt_path, 'r+')
 463             lines=f.readlines()
 464             f.seek(0)
 465             for line in lines:
 466                 line=line.replace("''","'")
 467                 if line.find('!record') == 0:
 468                     line = "- \n" + "  " + line
 469                 elif line.find('- -') != -1:
 470                     line=line.replace('- -','  -')
 471                     line = "    " + line
 472                 else:
 473                     line = "    " + line
 474                 f.write(line)
 475             f.close()
 476             f = open(txt_path, 'r')
 477             strg = ''.join(f.readlines())
 478             f.close()
 479             os.system('rm %s'%py_path)
 480             os.system('rm %s'%txt_path)
 481             return strg
 482
 483 base_module_record()
 484 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4:
 485