[IMP] attach the 'Our company' menu items to the portal's root menu
[odoo/odoo.git] / addons / portal / portal.py
index ef048f2..399377e 100644 (file)
@@ -2,7 +2,7 @@
 ##############################################################################
 #
 #    OpenERP, Open Source Management Solution
-#    Copyright (C) 2004-2011 Tiny SPRL (<http://tiny.be>).
+#    Copyright (C) 2004-2011 OpenERP S.A (<http://www.openerp.com>).
 #
 #    This program is free software: you can redistribute it and/or modify
 #    it under the terms of the GNU Affero General Public License as
 
 from osv import osv, fields
 from tools.translate import _
-import random
+
+
 
 class portal(osv.osv):
+    """
+        A portal is a group of users with specific menu, widgets, and typically
+        restricted access rights.
+    """
     _name = 'res.portal'
     _description = 'Portal'
+    _inherits = {'res.groups': 'group_id'}
+    
     _columns = {
-        'name': fields.char(string='Name', size=64, required=True),
-        'group_id': fields.many2one('res.groups', required=True,
-            string='Portal Group',
-            help=_('This group defines the users associated to this portal')),
-        'user_ids': fields.related('group_id', 'users',
-            type='many2many', relation='res.users', store=False,
-            string='Portal Users'),
-        'menu_action_id': fields.many2one('ir.actions.actions', readonly=True,
+        'group_id': fields.many2one('res.groups', required=True, ondelete='cascade',
+            string='Group',
+            help='The group corresponding to this portal'),
+        'url': fields.char('URL', size=64,
+            help="The url where portal users can connect to the server"),
+        'home_action_id': fields.many2one('ir.actions.actions',
+            string='Home Action',
+            help="if set, replaces the standard home action (first screen after loggin) for the portal's users"),
+        'menu_action_id': fields.many2one('ir.actions.act_window', readonly=True,
+            # ISSUE: 'ondelete' constraints do not seem effective on this field...
             string='Menu Action',
-            help=_("What replaces the standard menu for the portal's users")),
-        'parent_menu_id': fields.many2one('ir.ui.menu',
+            help="If set, replaces the standard menu for the portal's users"),
+        'parent_menu_id': fields.many2one('ir.ui.menu', ondelete='restrict',
             string='Parent Menu',
-            help=_('The menu action opens the submenus of this menu item')),
+            help='The menu action opens the submenus of this menu item'),
+        'widget_ids': fields.one2many('res.portal.widget', 'portal_id',
+            string='Widgets',
+            help='Widgets assigned to portal users'),
     }
-    _sql_constraints = [
-        ('unique_name', 'UNIQUE(name)', _('Portals must have different names.'))
-    ]
     
-    def copy(self, cr, uid, id, defaults, context=None):
-        """ override copy(): pick a different name and menu_action_id """
-        # find an unused name of the form "name [N]" for some random N
-        old_name = self.browse(cr, uid, id, context).name
-        new_name = copy_random(old_name)
-        while self.search(cr, uid, [('name', '=', new_name)], limit=1, context=context):
-            new_name = copy_random(old_name)
-        
-        defaults['name'] = new_name
-        defaults['menu_action_id'] = None
-        return super(portal, self).copy(cr, uid, id, defaults, context)
+    def copy(self, cr, uid, id, values, context=None):
+        """ override copy(): menu_action_id must be different """
+        values['menu_action_id'] = None
+        return super(portal, self).copy(cr, uid, id, values, context)
     
     def create(self, cr, uid, values, context=None):
-        """ extend create() to assign the portal group and menu to users """
-        # first create the 'menu_action_id'
-        assert not values.get('menu_action_id')
-        values['menu_action_id'] = self._create_menu_action(cr, uid, values, context)
+        """ extend create() to assign the portal menu to users """
+        if context is None:
+            context = {}
         
-        # set menu action of users
-        user_values = {'menu_id': values['menu_action_id']}
-        # values['user_ids'] should match [(6, 0, IDs)]
-        for id in get_many2many(values['user_ids']):
-            values['user_ids'].append((1, id, user_values))
+        # create portal (admin should not be included)
+        context['noadmin'] = True
+        portal_id = super(portal, self).create(cr, uid, values, context)
         
-        return super(portal, self).create(cr, uid, values, context)
+        # assign menu action and widgets to users
+        if values.get('users') or values.get('menu_action_id'):
+            self._assign_menu(cr, uid, [portal_id], context)
+        if values.get('users') or values.get('widget_ids'):
+            self._assign_widgets(cr, uid, [portal_id], context)
+        
+        return portal_id
     
     def write(self, cr, uid, ids, values, context=None):
-        """ extend write() to reflect menu and groups changes on users """
+        """ extend write() to reflect changes on users """
         # first apply portal changes
         super(portal, self).write(cr, uid, ids, values, context)
-        portals = self.browse(cr, uid, ids, context)
         
-        # if 'menu_action_id' has changed, set menu_id on users
-        if 'menu_action_id' in values:
-            user_values = {'menu_id': values['menu_action_id']}
-            user_ids = [u.id for p in portals for u in p.user_ids]
-            self.pool.get('res.users').write(cr, uid, user_ids, user_values, context)
+        # assign menu action and widgets to users
+        if values.get('users') or values.get('menu_action_id'):
+            self._assign_menu(cr, uid, ids, context)
+        if values.get('users') or values.get('widget_ids'):
+            self._assign_widgets(cr, uid, ids, context)
         
         # if parent_menu_id has changed, apply the change on menu_action_id
         if 'parent_menu_id' in values:
             act_window_obj = self.pool.get('ir.actions.act_window')
-            action_ids = [p.menu_action_id.id for p in portals]
-            action_values = {'domain': [('parent_id', '=', values['parent_menu_id'])]}
-            act_window_obj.write(cr, uid, action_ids, action_values, context)
+            portals = self.browse(cr, uid, ids, context)
+            action_ids = [p.menu_action_id.id for p in portals if p.menu_action_id]
+            if action_ids:
+                action_values = {'domain': [('parent_id', '=', values['parent_menu_id'])]}
+                act_window_obj.write(cr, uid, action_ids, action_values, context)
         
         return True
-    
-    def _create_menu_action(self, cr, uid, values, context=None):
-        # create a menu action that opens the menu items below parent_menu_id
-        actions_obj = self.pool.get('ir.actions.act_window')
-        action_values = {
-            'name': values['name'] + ' Menu',
-            'type': 'ir.actions.act_window',
-            'usage': 'menu',
-            'res_model': 'ir.ui.menu',
-            'view_type': 'tree',
-            'view_id': self._res_xml_id(cr, uid, 'base', 'view_menu'),
-            'domain': [('parent_id', '=', values.get('parent_menu_id', False))],
-        }
-        return actions_obj.create(cr, uid, action_values, context)
-    
-    def create_parent_menu(self, cr, uid, ids, context=None):
-        """ create a parent menu for this portal """
-        if len(ids) != 1:
-            raise ValueError("portal.create_parent_menu() applies to one portal at a time")
-        portal_name = self.browse(cr, uid, ids[0], context).name
-        
-        # create a menuitem under 'portal.portal_menu_tree'
-        item_values = {
-            'name': portal_name + ' Menu',
-            'parent_id': self._res_xml_id(cr, uid, 'portal', 'portal_menu_tree'),
-        }
-        item_id = self.pool.get('ir.ui.menu').create(cr, uid, item_values, context)
-        
-        # set the parent_menu_id to item_id
-        return self.write(cr, uid, ids, {'parent_menu_id': item_id}, context)
-    
-    def onchange_group(self, cr, uid, ids, group_id, context=None):
-        """ update the users list when the group changes """
-        user_ids = False
-        if group_id:
-            group = self.pool.get('res.groups').browse(cr, uid, group_id, context)
-            user_ids = [u.id for u in group.users]
-        return {
-            'value': {'user_ids': user_ids}
-        }
-    
+
+    def _assign_menu(self, cr, uid, ids, context=None):
+        """ assign portal_menu_settings to users of portals (ids) """
+        user_obj = self.pool.get('res.users')
+        for p in self.browse(cr, uid, ids, context):
+            # user menu action = portal menu action if set in portal
+            if p.menu_action_id:
+                user_ids = [u.id for u in p.users if u.id != 1]
+                user_values = {'menu_id': p.menu_action_id.id}
+                user_obj.write(cr, uid, user_ids, user_values, context)
+
+    def _assign_widgets(self, cr, uid, ids, context=None):
+        """ assign portal widgets to users of portals (ids) """
+        widget_user_obj = self.pool.get('res.widget.user')
+        for p in self.browse(cr, uid, ids, context):
+            for w in p.widget_ids:
+                values = {'sequence': w.sequence, 'widget_id': w.widget_id.id}
+                for u in p.users:
+                    if u.id == 1: continue
+                    values['user_id'] = u.id
+                    widget_user_obj.create(cr, uid, values, context)
+
     def _res_xml_id(self, cr, uid, module, xml_id):
         """ return the resource id associated to the given xml_id """
         data_obj = self.pool.get('ir.model.data')
@@ -140,39 +127,89 @@ class portal(osv.osv):
 
 portal()
 
-class users(osv.osv):
-    _name = 'res.users'
-    _inherit = 'res.users'
+
+
+class portal_override_menu(osv.osv):
+    """
+        extend res.portal with a boolean field 'Override Users Menu', that
+        triggers the creation or removal of menu_action_id
+    """
+    _name = 'res.portal'
+    _inherit = 'res.portal'
     
-    def default_get(self, cr, uid, fields, context=None):
-        """ override default value of menu_id for portal users """
-        defs = super(users, self).default_get(cr, uid, fields, context)
-        
-        # the value of 'menu_id' is passed in context by the portal form view
-        if ('menu_id' in context) and ('menu_id' in fields):
-            defs['menu_id'] = context['menu_id']
-        
-        return defs
+    def _get_override_menu(self, cr, uid, ids, field_name, arg, context=None):
+        assert field_name == 'override_menu'
+        result = {}
+        for p in self.browse(cr, uid, ids, context):
+            result[p.id] = bool(p.menu_action_id)
+        return result
+    
+    def _set_override_menu(self, cr, uid, id, field_name, field_value, arg, context=None):
+        assert field_name == 'override_menu'
+        if field_value:
+            self.create_menu_action(cr, uid, id, context)
+        else:
+            self.write(cr, uid, [id], {'menu_action_id': False}, context)
+    
+    def create_menu_action(self, cr, uid, id, context=None):
+        """ create, if necessary, a menu action that opens the menu items below
+            parent_menu_id """
+        p = self.browse(cr, uid, id, context)
+        if not p.menu_action_id:
+            actions_obj = self.pool.get('ir.actions.act_window')
+            parent_id = p.parent_menu_id.id if p.parent_menu_id else False
+            action_values = {
+                'name': _('%s Menu') % p.name,
+                'type': 'ir.actions.act_window',
+                'usage': 'menu',
+                'res_model': 'ir.ui.menu',
+                'view_type': 'tree',
+                'view_id': self._res_xml_id(cr, uid, 'base', 'view_menu'),
+                'domain': [('parent_id', '=', parent_id)],
+            }
+            action_id = actions_obj.create(cr, uid, action_values, context)
+            self.write(cr, uid, [id], {'menu_action_id': action_id}, context)
+    
+    _columns = {
+        'override_menu': fields.function(
+            _get_override_menu, fnct_inv=_set_override_menu,
+            type='boolean', string='Override Menu Action of Users',
+            help='Enable this option to override the Menu Action of portal users'),
+    }
 
-users()
+portal_override_menu()
 
 
 
-# utils
-def get_browse_id(obj):
-    """ return the id of a browse() object, or None """
-    return (obj and obj.id or None)
+class portal_widget(osv.osv):
+    """
+        Similar to res.widget.user (res_widget.py), but with a portal instead.
+        New users in a portal are assigned the portal's widgets.
+    """
+    _name='res.portal.widget'
+    _description = 'Portal Widgets'
+    _order = 'sequence'
+    _columns = {
+        'sequence': fields.integer('Sequence'),
+        'portal_id': fields.many2one('res.portal', select=1, ondelete='cascade',
+            string='Portal'),
+        'widget_id': fields.many2one('res.widget', required=True, ondelete='cascade',
+            string='Widget'),
+    }
+
+    def create(self, cr, uid, values, context=None):
+        domain = [('portal_id', '=', values.get('portal_id')),
+                  ('widget_id', '=', values.get('widget_id'))]
+        existing = self.search(cr, uid, domain, context=context)
+        if existing:
+            res = existing[0]
+        else:
+            res = super(portal_widget, self).create(cr, uid, values, context=context)
+        return res
+
+portal_widget()
 
-def get_browse_ids(objs):
-    """ return the ids of a list of browse() objects """
-    return map(get_browse_id, objs)
 
-def get_many2many(arg):
-    """ get the list of ids from a many2many 'values' field """
-    assert len(arg) == 1 and arg[0][0] == 6             # arg = [(6, _, IDs)]
-    return arg[0][2]
 
-def copy_random(name):
-    """ return "name [N]" for some random integer N """
-    return "%s [%s]" % (name, random.choice(xrange(1000000)))
 
+# vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: