addons/portal/portal.py

   1 # -*- coding: utf-8 -*-
   2 ##############################################################################
   3 #
   4 #    OpenERP, Open Source Management Solution
   5 #    Copyright (C) 2004-2011 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 osv, fields
  23 from tools.translate import _
  24
  25 class portal(osv.osv):
  26     """
  27         A portal is a group of users with specific menu, widgets, and typically
  28         restricted access rights.
  29     """
  30     _name = 'res.portal'
  31     _description = 'Portal'
  32     _inherits = {'res.groups': 'group_id'}
  33
  34     _columns = {
  35         'group_id': fields.many2one('res.groups', required=True, ondelete='cascade',
  36             string='Group',
  37             help=_('The group extended by this portal')),
  38         'menu_action_id': fields.many2one('ir.actions.actions', readonly=True,
  39             string='Menu Action',
  40             help=_("If set, replaces the standard menu for the portal's users")),
  41         'parent_menu_id': fields.many2one('ir.ui.menu',
  42             string='Parent Menu',
  43             help=_('The menu action opens the submenus of this menu item')),
  44         'widget_ids': fields.one2many('res.portal.widget', 'portal_id',
  45             string='Widgets',
  46             help=_('Widgets assigned to portal users')),
  47     }
  48
  49     def copy(self, cr, uid, id, values, context=None):
  50         """ override copy(): menu_action_id must be different """
  51         values['menu_action_id'] = None
  52         return super(portal, self).copy(cr, uid, id, values, context)
  53
  54     def create(self, cr, uid, values, context=None):
  55         """ extend create() to assign the portal menu to users """
  56         if context is None:
  57             context = {}
  58
  59         # create portal (admin should not be included)
  60         context['noadmin'] = True
  61         portal_id = super(portal, self).create(cr, uid, values, context)
  62
  63         # assign menu action and widgets to users
  64         if values.get('users') or values.get('menu_action_id'):
  65             self._assign_menu_to_users(cr, uid, [portal_id], context)
  66         if values.get('users') or values.get('widget_ids'):
  67             self._assign_widgets_to_users(cr, uid, [portal_id], context)
  68
  69         return portal_id
  70
  71     def write(self, cr, uid, ids, values, context=None):
  72         """ extend write() to reflect menu and groups changes on users """
  73         # first apply portal changes
  74         super(portal, self).write(cr, uid, ids, values, context)
  75
  76         # assign menu action and widgets to users
  77         if values.get('users') or values.get('menu_action_id'):
  78             self._assign_menu_to_users(cr, uid, ids, context)
  79         if values.get('users') or values.get('widget_ids'):
  80             self._assign_widgets_to_users(cr, uid, ids, context)
  81
  82         # if parent_menu_id has changed, apply the change on menu_action_id
  83         if 'parent_menu_id' in values:
  84             act_window_obj = self.pool.get('ir.actions.act_window')
  85             portals = self.browse(cr, uid, ids, context)
  86             action_ids = [p.menu_action_id.id for p in portals if p.menu_action_id]
  87             if action_ids:
  88                 action_values = {'domain': [('parent_id', '=', values['parent_menu_id'])]}
  89                 act_window_obj.write(cr, uid, action_ids, action_values, context)
  90
  91         return True
  92
  93     def do_create_menu(self, cr, uid, ids, context=None):
  94         """ create a parent menu for the given portals """
  95         menu_obj = self.pool.get('ir.ui.menu')
  96         menu_root = self._res_xml_id(cr, uid, 'portal', 'portal_menu')
  97
  98         for p in self.browse(cr, uid, ids, context):
  99             # create a menuitem under 'portal.portal_menu'
 100             menu_values = {
 101                 'name': p.name + ' Menu',
 102                 'parent_id': menu_root,
 103                 'groups_id': [(6, 0, [p.group_id.id])],
 104             }
 105             menu_id = menu_obj.create(cr, uid, menu_values, context)
 106             # set the parent_menu_id to item_id
 107             self.write(cr, uid, [p.id], {'parent_menu_id': menu_id}, context)
 108
 109         return True
 110
 111     def _assign_menu_to_users(self, cr, uid, ids, context=None):
 112         """ assign portal menu action to users for the given portal ids """
 113         user_obj = self.pool.get('res.users')
 114         for p in self.browse(cr, uid, ids, context):
 115             if p.menu_action_id:
 116                 user_values = {'menu_id': p.menu_action_id.id}
 117                 user_obj.write(cr, uid, [u.id for u in p.users], user_values, context)
 118
 119     def _assign_widgets_to_users(self, cr, uid, ids, context=None):
 120         """ assign portal widgets to users for the given portal ids """
 121         widget_user_obj = self.pool.get('res.widget.user')
 122         for p in self.browse(cr, uid, ids, context):
 123             for w in p.widget_ids:
 124                 values = {'sequence': w.sequence, 'widget_id': w.widget_id.id}
 125                 for u in p.user_ids:
 126                     if u.id == 1: continue
 127                     values['user_id'] = u.id
 128                     widget_user_obj.create(cr, uid, values, context)
 129
 130     def _res_xml_id(self, cr, uid, module, xml_id):
 131         """ return the resource id associated to the given xml_id """
 132         data_obj = self.pool.get('ir.model.data')
 133         data_id = data_obj._get_id(cr, uid, module, xml_id)
 134         return data_obj.browse(cr, uid, data_id).res_id
 135
 136 portal()
 137
 138
 139
 140 class portal_override_menu(osv.osv):
 141     """
 142         extend res.portal with a boolean field 'Override Users Menu', that
 143         triggers the creation or removal of menu_action_id
 144     """
 145     _name = 'res.portal'
 146     _inherit = 'res.portal'
 147
 148     def _get_override_menu(self, cr, uid, ids, field_name, arg, context=None):
 149         assert field_name == 'override_menu'
 150         result = {}
 151         for p in self.browse(cr, uid, ids, context):
 152             result[p.id] = bool(p.menu_action_id)
 153         return result
 154
 155     def _set_override_menu(self, cr, uid, id, field_name, field_value, arg, context=None):
 156         assert field_name == 'override_menu'
 157         if field_value:
 158             self.create_menu_action(cr, uid, id, context)
 159         else:
 160             self.write(cr, uid, [id], {'menu_action_id': False}, context)
 161
 162     def create_menu_action(self, cr, uid, id, context=None):
 163         """ create, if necessary, a menu action that opens the menu items below
 164             parent_menu_id """
 165         p = self.browse(cr, uid, id, context)
 166         if not p.menu_action_id:
 167             actions_obj = self.pool.get('ir.actions.act_window')
 168             parent_id = p.parent_menu_id.id if p.parent_menu_id else False
 169             action_values = {
 170                 'name': p.name + ' Menu',
 171                 'type': 'ir.actions.act_window',
 172                 'usage': 'menu',
 173                 'res_model': 'ir.ui.menu',
 174                 'view_type': 'tree',
 175                 'view_id': self._res_xml_id(cr, uid, 'base', 'view_menu'),
 176                 'domain': [('parent_id', '=', parent_id)],
 177             }
 178             action_id = actions_obj.create(cr, uid, action_values, context)
 179             self.write(cr, uid, [id], {'menu_action_id': action_id}, context)
 180
 181     _columns = {
 182         'override_menu': fields.function(
 183             _get_override_menu, fnct_inv=_set_override_menu,
 184             type='boolean', method=True, string='Override Users Menu Action'),
 185     }
 186
 187 portal_override_menu()
 188
 189
 190
 191 class portal_widget(osv.osv):
 192     """
 193         Similar to res.widget.user (res_widget.py), but with a portal instead.
 194         New users in a portal are assigned the portal's widgets.
 195     """
 196     _name='res.portal.widget'
 197     _description = 'Portal Widgets'
 198     _order = 'sequence'
 199     _columns = {
 200         'sequence': fields.integer('Sequence'),
 201         'portal_id': fields.many2one('res.portal', select=1,
 202             string='Portal'),
 203         'widget_id': fields.many2one('res.widget', required=True, ondelete='cascade',
 204             string='Widget'),
 205     }
 206
 207     def create(self, cr, uid, values, context=None):
 208         domain = [('portal_id', '=', values.get('portal_id')),
 209                   ('widget_id', '=', values.get('widget_id'))]
 210         existing = self.search(cr, uid, domain, context=context)
 211         if existing:
 212             res = existing[0]
 213         else:
 214             res = super(portal_widget, self).create(cr, uid, values, context=context)
 215         return res
 216
 217 portal_widget()
 218
 219
 220