addons/portal/portal.py

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