openerp/addons/base/ir/ir_ui_view.py

   1 # -*- coding: utf-8 -*-
   2 ##############################################################################
   3 #
   4 #    OpenERP, Open Source Management Solution
   5 #    Copyright (C) 2004-2009 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 osv import fields,osv
  23 from lxml import etree
  24 from tools import graph
  25 from tools.safe_eval import safe_eval as eval
  26 import tools
  27 import os
  28 import logging
  29
  30 _logger = logging.getLogger(__name__)
  31
  32 class view_custom(osv.osv):
  33     _name = 'ir.ui.view.custom'
  34     _order = 'create_date desc'  # search(limit=1) should return the last customization
  35     _columns = {
  36         'ref_id': fields.many2one('ir.ui.view', 'Original View', select=True, required=True, ondelete='cascade'),
  37         'user_id': fields.many2one('res.users', 'User', select=True, required=True, ondelete='cascade'),
  38         'arch': fields.text('View Architecture', required=True),
  39     }
  40
  41     def _auto_init(self, cr, context=None):
  42         super(view_custom, self)._auto_init(cr, context)
  43         cr.execute('SELECT indexname FROM pg_indexes WHERE indexname = \'ir_ui_view_custom_user_id_ref_id\'')
  44         if not cr.fetchone():
  45             cr.execute('CREATE INDEX ir_ui_view_custom_user_id_ref_id ON ir_ui_view_custom (user_id, ref_id)')
  46 view_custom()
  47
  48 class view(osv.osv):
  49     _name = 'ir.ui.view'
  50     _columns = {
  51         'name': fields.char('View Name',size=64,  required=True),
  52         'model': fields.char('Object', size=64, required=True, select=True),
  53         'priority': fields.integer('Sequence', required=True),
  54         'type': fields.selection((
  55             ('tree','Tree'),
  56             ('form','Form'),
  57             ('mdx','mdx'),
  58             ('graph', 'Graph'),
  59             ('calendar', 'Calendar'),
  60             ('diagram','Diagram'),
  61             ('gantt', 'Gantt'),
  62             ('kanban', 'Kanban'),
  63             ('search','Search')), 'View Type', required=True, select=True),
  64         'arch': fields.text('View Architecture', required=True),
  65         'inherit_id': fields.many2one('ir.ui.view', 'Inherited View', ondelete='cascade', select=True),
  66         'field_parent': fields.char('Child Field',size=64),
  67         'xml_id': fields.function(osv.osv.get_xml_id, type='char', size=128, string="External ID",
  68                                   help="ID of the view defined in xml file"),
  69     }
  70     _defaults = {
  71         'arch': '<?xml version="1.0"?>\n<tree string="My view">\n\t<field name="name"/>\n</tree>',
  72         'priority': 16
  73     }
  74     _order = "priority,name"
  75
  76     def _check_xml(self, cr, uid, ids, context=None):
  77         for view in self.browse(cr, uid, ids, context):
  78             eview = etree.fromstring(view.arch.encode('utf8'))
  79             frng = tools.file_open(os.path.join('base','rng','view.rng'))
  80             try:
  81                 relaxng_doc = etree.parse(frng)
  82                 relaxng = etree.RelaxNG(relaxng_doc)
  83                 if not relaxng.validate(eview):
  84                     for error in relaxng.error_log:
  85                         _logger.error(tools.ustr(error))
  86                     return False
  87             finally:
  88                 frng.close()
  89         return True
  90
  91     _constraints = [
  92         (_check_xml, 'Invalid XML for View Architecture!', ['arch'])
  93     ]
  94
  95     def _auto_init(self, cr, context=None):
  96         super(view, self)._auto_init(cr, context)
  97         cr.execute('SELECT indexname FROM pg_indexes WHERE indexname = \'ir_ui_view_model_type_inherit_id\'')
  98         if not cr.fetchone():
  99             cr.execute('CREATE INDEX ir_ui_view_model_type_inherit_id ON ir_ui_view (model, type, inherit_id)')
 100
 101     def get_inheriting_views_arch(self, cr, uid, view_id, model, context=None):
 102         """Retrieves the architecture of views that inherit from the given view.
 103
 104            :param int view_id: id of the view whose inheriting views should be retrieved
 105            :param str model: model identifier of the view's related model (for double-checking)
 106            :rtype: list of tuples
 107            :return: [(view_arch,view_id), ...]
 108         """
 109         cr.execute("""SELECT arch, id FROM ir_ui_view WHERE inherit_id=%s AND model=%s
 110                       ORDER BY priority""",
 111                       (view_id, model))
 112         return cr.fetchall()
 113
 114     def write(self, cr, uid, ids, vals, context=None):
 115         if not isinstance(ids, (list, tuple)):
 116             ids = [ids]
 117         result = super(view, self).write(cr, uid, ids, vals, context)
 118
 119         # drop the corresponding view customizations (used for dashboards for example), otherwise
 120         # not all users would see the updated views
 121         custom_view_ids = self.pool.get('ir.ui.view.custom').search(cr, uid, [('ref_id','in',ids)])
 122         if custom_view_ids:
 123             self.pool.get('ir.ui.view.custom').unlink(cr, uid, custom_view_ids)
 124
 125         return result
 126
 127     def graph_get(self, cr, uid, id, model, node_obj, conn_obj, src_node, des_node, label, scale, context=None):
 128         if not label:
 129             label = '[]'
 130         nodes=[]
 131         nodes_name=[]
 132         transitions=[]
 133         start=[]
 134         tres={}
 135         labels={}
 136         no_ancester=[]
 137         blank_nodes = []
 138
 139         _Model_Obj=self.pool.get(model)
 140         _Node_Obj=self.pool.get(node_obj)
 141         _Arrow_Obj=self.pool.get(conn_obj)
 142
 143         for model_key,model_value in _Model_Obj._columns.items():
 144                 if model_value._type=='one2many':
 145                     if model_value._obj==node_obj:
 146                         _Node_Field=model_key
 147                         _Model_Field=model_value._fields_id
 148                     flag=False
 149                     for node_key,node_value in _Node_Obj._columns.items():
 150                         if node_value._type=='one2many':
 151                              if node_value._obj==conn_obj:
 152                                  if src_node in _Arrow_Obj._columns and flag:
 153                                     _Source_Field=node_key
 154                                  if des_node in _Arrow_Obj._columns and not flag:
 155                                     _Destination_Field=node_key
 156                                     flag = True
 157
 158         datas = _Model_Obj.read(cr, uid, id, [],context)
 159         for a in _Node_Obj.read(cr,uid,datas[_Node_Field],[]):
 160             if a[_Source_Field] or a[_Destination_Field]:
 161                 nodes_name.append((a['id'],a['name']))
 162                 nodes.append(a['id'])
 163             else:
 164                 blank_nodes.append({'id': a['id'],'name':a['name']})
 165
 166             if a.has_key('flow_start') and a['flow_start']:
 167                 start.append(a['id'])
 168             else:
 169                 if not a[_Source_Field]:
 170                     no_ancester.append(a['id'])
 171             for t in _Arrow_Obj.read(cr,uid, a[_Destination_Field],[]):
 172                 transitions.append((a['id'], t[des_node][0]))
 173                 tres[str(t['id'])] = (a['id'],t[des_node][0])
 174                 label_string = ""
 175                 if label:
 176                     for lbl in eval(label):
 177                         if t.has_key(tools.ustr(lbl)) and tools.ustr(t[lbl])=='False':
 178                             label_string = label_string + ' '
 179                         else:
 180                             label_string = label_string + " " + tools.ustr(t[lbl])
 181                 labels[str(t['id'])] = (a['id'],label_string)
 182         g  = graph(nodes, transitions, no_ancester)
 183         g.process(start)
 184         g.scale(*scale)
 185         result = g.result_get()
 186         results = {}
 187         for node in nodes_name:
 188             results[str(node[0])] = result[node[0]]
 189             results[str(node[0])]['name'] = node[1]
 190         return {'nodes': results,
 191                 'transitions': tres,
 192                 'label' : labels,
 193                 'blank_nodes': blank_nodes,
 194                 'node_parent_field': _Model_Field,}
 195 view()
 196
 197 class view_sc(osv.osv):
 198     _name = 'ir.ui.view_sc'
 199     _columns = {
 200         'name': fields.char('Shortcut Name', size=64), # Kept for backwards compatibility only - resource name used instead (translatable)
 201         'res_id': fields.integer('Resource Ref.', help="Reference of the target resource, whose model/table depends on the 'Resource Name' field."),
 202         'sequence': fields.integer('Sequence'),
 203         'user_id': fields.many2one('res.users', 'User Ref.', required=True, ondelete='cascade', select=True),
 204         'resource': fields.char('Resource Name', size=64, required=True, select=True)
 205     }
 206
 207     def _auto_init(self, cr, context=None):
 208         super(view_sc, self)._auto_init(cr, context)
 209         cr.execute('SELECT indexname FROM pg_indexes WHERE indexname = \'ir_ui_view_sc_user_id_resource\'')
 210         if not cr.fetchone():
 211             cr.execute('CREATE INDEX ir_ui_view_sc_user_id_resource ON ir_ui_view_sc (user_id, resource)')
 212
 213     def get_sc(self, cr, uid, user_id, model='ir.ui.menu', context=None):
 214         ids = self.search(cr, uid, [('user_id','=',user_id),('resource','=',model)], context=context)
 215         results = self.read(cr, uid, ids, ['res_id'], context=context)
 216         name_map = dict(self.pool.get(model).name_get(cr, uid, [x['res_id'] for x in results], context=context))
 217         # Make sure to return only shortcuts pointing to exisintg menu items.
 218         filtered_results = filter(lambda result: result['res_id'] in name_map, results)
 219         for result in filtered_results:
 220             result.update(name=name_map[result['res_id']])
 221         return filtered_results
 222
 223     _order = 'sequence,name'
 224     _defaults = {
 225         'resource': lambda *a: 'ir.ui.menu',
 226         'user_id': lambda obj, cr, uid, context: uid,
 227     }
 228     _sql_constraints = [
 229         ('shortcut_unique', 'unique(res_id, resource, user_id)', 'Shortcut for this menu already exists!'),
 230     ]
 231
 232 view_sc()
 233
 234 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4:
 235