8.0 - New module 'base_user_role' to manage user roles efficiently (#608)

* [ADD] New module 'base_user_role'

* [FIX] base_user_role - Review

* [FIX] base_user_role - Review s/is_active/is_enabled/

* [FIX] base_user_role - Review s/is_active/is_enabled/

* [IMP] base_user_role - Translations updated (template + FR)

* [FIX] base_user_role - Lint

base_user_role/models/__init__.py

@@ -0,0 +1,4 @@
+# -*- coding: utf-8 -*-
+
+from . import role
+from . import user

base_user_role/models/role.py

@@ -0,0 +1,83 @@
+# -*- coding: utf-8 -*-
+# Copyright 2014 ABF OSIELL <http://osiell.com>
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+import datetime
+import logging
+
+from openerp import api, fields, models
+
+
+_logger = logging.getLogger(__name__)
+
+
+class ResUsersRole(models.Model):
+    _name = 'res.users.role'
+    _inherits = {'res.groups': 'group_id'}
+    _description = "User role"
+
+    group_id = fields.Many2one(
+        'res.groups', required=True, ondelete='cascade',
+        readonly=True, string=u"Associated group")
+    line_ids = fields.One2many(
+        'res.users.role.line', 'role_id', string=u"Users")
+    user_ids = fields.One2many(
+        'res.users', string=u"Users", compute='_compute_user_ids')
+
+    @api.multi
+    @api.depends('line_ids.user_id')
+    def _compute_user_ids(self):
+        for role in self:
+            role.user_ids = role.line_ids.mapped('user_id')
+
+    @api.model
+    def create(self, vals):
+        new_record = super(ResUsersRole, self).create(vals)
+        new_record.update_users()
+        return new_record
+
+    @api.multi
+    def write(self, vals):
+        res = super(ResUsersRole, self).write(vals)
+        self.update_users()
+        return res
+
+    @api.multi
+    def update_users(self):
+        """Update all the users concerned by the roles identified by `ids`."""
+        users = self.mapped('user_ids')
+        users.set_groups_from_roles()
+        return True
+
+    @api.model
+    def cron_update_users(self):
+        logging.info(u"Update user roles")
+        self.search([]).update_users()
+
+
+class ResUsersRoleLine(models.Model):
+    _name = 'res.users.role.line'
+    _description = 'Users associated to a role'
+
+    role_id = fields.Many2one(
+        'res.users.role', string=u"Role", ondelete='cascade')
+    user_id = fields.Many2one(
+        'res.users', string=u"User")
+    date_from = fields.Date(u"From")
+    date_to = fields.Date(u"To")
+    is_enabled = fields.Boolean(u"Enabled", compute='_compute_is_enabled')
+
+    @api.multi
+    @api.depends('date_from', 'date_to')
+    def _compute_is_enabled(self):
+        today = datetime.date.today()
+        for role_line in self:
+            role_line.is_enabled = True
+            if role_line.date_from:
+                date_from = fields.Date.from_string(role_line.date_from)
+                if date_from > today:
+                    role_line.is_enabled = False
+            if role_line.date_to:
+                date_to = fields.Date.from_string(role_line.date_to)
+                if today > date_to:
+                    role_line.is_enabled = False

base_user_role/models/user.py

@@ -0,0 +1,54 @@
+# -*- coding: utf-8 -*-
+# Copyright 2014 ABF OSIELL <http://osiell.com>
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+from openerp import api, fields, models
+
+
+class ResUsers(models.Model):
+    _inherit = 'res.users'
+
+    role_line_ids = fields.One2many(
+        'res.users.role.line', 'user_id', string=u"Role lines")
+    role_ids = fields.One2many(
+        'res.users.role', string=u"Roles", compute='_compute_role_ids')
+
+    @api.multi
+    @api.depends('role_line_ids.role_id')
+    def _compute_role_ids(self):
+        for user in self:
+            user.role_ids = user.role_line_ids.mapped('role_id')
+
+    @api.model
+    def create(self, vals):
+        new_record = super(ResUsers, self).create(vals)
+        new_record.set_groups_from_roles()
+        return new_record
+
+    @api.multi
+    def write(self, vals):
+        res = super(ResUsers, self).write(vals)
+        self.sudo().set_groups_from_roles()
+        return res
+
+    @api.multi
+    def set_groups_from_roles(self):
+        """Set (replace) the groups following the roles defined on users.
+        If no role is defined on the user, its groups are let untouched.
+        """
+        for user in self:
+            if not user.role_line_ids:
+                continue
+            group_ids = []
+            role_lines = user.role_line_ids.filtered(
+                lambda rec: rec.is_enabled)
+            for role_line in role_lines:
+                role = role_line.role_id
+                group_ids.append(role.group_id.id)
+                group_ids.extend(role.implied_ids.ids)
+            group_ids = list(set(group_ids))    # Remove duplicates IDs
+            vals = {
+                'groups_id': [(6, 0, group_ids)],
+            }
+            super(ResUsers, user).write(vals)
+        return True