[IMP] mail: empty list help: take first created alias by default, because this should...
[odoo/odoo.git] / addons / mail / mail_group.py
index fbbdb85..24aed94 100644 (file)
 #
 ##############################################################################
 
-import datetime as DT
-import io
 import openerp
 import openerp.tools as tools
-from operator import itemgetter
-from osv import osv
-from osv import fields
-from PIL import Image
-import StringIO
-import tools
-from tools.translate import _
-
-class mail_group(osv.osv):
-    """
-    A mail_group is a collection of users sharing messages in a discussion
-    group. Group users are users that follow the mail group, using the
-    subscription/follow mechanism of OpenSocial. A mail group has nothing
-    in common wih res.users.group.
-    Additional information on fields:
-        - ``member_ids``: user member of the groups are calculated with
-          ``message_get_subscribers`` method from mail.thread
-        - ``member_count``: calculated with member_ids
-        - ``is_subscriber``: calculated with member_ids
-        
-    """
-    
+from openerp.osv import osv
+from openerp.osv import fields
+from openerp import SUPERUSER_ID
+
+
+class mail_group(osv.Model):
+    """ A mail_group is a collection of users sharing messages in a discussion
+        group. The group mechanics are based on the followers. """
     _description = 'Discussion group'
     _name = 'mail.group'
+    _mail_flat_thread = False
     _inherit = ['mail.thread']
     _inherits = {'mail.alias': 'alias_id'}
-    def action_group_join(self, cr, uid, ids, context={}):
-        return self.message_subscribe(cr, uid, ids, context=context);
-    
-    def action_group_leave(self, cr, uid, ids, context={}):
-        return self.message_unsubscribe(cr, uid, ids, context=context);
-
-    def onchange_photo(self, cr, uid, ids, value, context=None):
-        if not value:
-            return {'value': {'avatar_big': value, 'avatar': value} }
-        return {'value': {'photo_big': value, 'photo': self._photo_resize(cr, uid, value) } }
-    
-    def _set_photo(self, cr, uid, id, name, value, args, context=None):
-        if value:
-            return self.write(cr, uid, [id], {'photo_big': value}, context=context)
-        else:
-            return self.write(cr, uid, [id], {'photo_big': value}, context=context)
-    
-    def _photo_resize(self, cr, uid, photo, width=128, height=128, context=None):
-        image_stream = io.BytesIO(photo.decode('base64'))
-        img = Image.open(image_stream)
-        img.thumbnail((width, height), Image.ANTIALIAS)
-        img_stream = StringIO.StringIO()
-        img.save(img_stream, "JPEG")
-        return img_stream.getvalue().encode('base64')
-        
-    def _get_photo(self, cr, uid, ids, name, args, context=None):
+
+    def _get_image(self, cr, uid, ids, name, args, context=None):
         result = dict.fromkeys(ids, False)
-        for group in self.browse(cr, uid, ids, context=context):
-            if group.photo_big:
-                result[group.id] = self._photo_resize(cr, uid, group.photo_big, context=context)
+        for obj in self.browse(cr, uid, ids, context=context):
+            result[obj.id] = tools.image_get_resized_images(obj.image)
         return result
-    
-    def get_member_ids(self, cr, uid, ids, field_names, args, context=None):
-        if context is None:
-            context = {}
-        result = dict.fromkeys(ids)
-        for id in ids:
-            result[id] = {}
-            result[id]['member_ids'] = self.message_get_subscribers_ids(cr, uid, [id], context=context)
-            result[id]['member_count'] = len(result[id]['member_ids'])
-            result[id]['is_subscriber'] = uid in result[id]['member_ids']
-        return result
-    
-    def search_member_ids(self, cr, uid, obj, name, args, context=None):
-        if context is None:
-            context = {}
-        sub_obj = self.pool.get('mail.subscription')
-        sub_ids = sub_obj.search(cr, uid, ['&', ('res_model', '=', obj._name), ('user_id', '=', args[0][2])], context=context)
-        subs = sub_obj.read(cr, uid, sub_ids, context=context)
-        return [('id', 'in', map(itemgetter('res_id'), subs))]
-    
-    def get_last_month_msg_nbr(self, cr, uid, ids, name, args, context=None):
-        result = {}
-        message_obj = self.pool.get('mail.message')
-        for id in ids:
-            lower_date = (DT.datetime.now() - DT.timedelta(days=30)).strftime(tools.DEFAULT_SERVER_DATE_FORMAT)
-            result[id] = message_obj.search(cr, uid, ['&', '&', ('model', '=', self._name), ('res_id', 'in', ids), ('date', '>=', lower_date)], count=True, context=context)
-        return result
-    
-    def _get_default_photo(self, cr, uid, context=None):
-        avatar_path = openerp.modules.get_module_resource('mail', 'static/src/img', 'groupdefault.png')
-        return self._photo_resize(cr, uid, open(avatar_path, 'rb').read().encode('base64'), context=context)
-    
+
+    def _set_image(self, cr, uid, id, name, value, args, context=None):
+        return self.write(cr, uid, [id], {'image': tools.image_resize_image_big(value)}, context=context)
+
     _columns = {
-        'name': fields.char('Name', size=64, required=True),
+        'name': fields.char('Name', size=64, required=True, translate=True),
         'description': fields.text('Description'),
-        'responsible_id': fields.many2one('res.users', string='Responsible',
-                            ondelete='set null', required=True, select=1,
-                            help="Responsible of the group that has all rights on the record."),
-        'public': fields.boolean('Public', help='This group is visible by non members. Invisible groups can add members through the invite button.'),
-        'photo_big': fields.binary('Full-size photo', help='Field holding the full-sized PIL-supported and base64 encoded version of the group image. The photo field is used as an interface for this field.'),
-        'photo': fields.function(_get_photo, fnct_inv=_set_photo, string='Photo', type="binary",
-            store = {
-                'mail.group': (lambda self, cr, uid, ids, c={}: ids, ['photo_big'], 10),
-            }, help='Field holding the automatically resized (128x128) PIL-supported and base64 encoded version of the group image.'),
-        'member_ids': fields.function(get_member_ids, fnct_search=search_member_ids, type='many2many',
-                        relation='res.users', string='Group members', multi='get_member_ids'),
-        'member_count': fields.function(get_member_ids, type='integer', string='Member count', multi='get_member_ids'),
-        'is_subscriber': fields.function(get_member_ids, type='boolean', string='Joined', multi='get_member_ids'),
-        'last_month_msg_nbr': fields.function(get_last_month_msg_nbr, type='integer', string='Messages count for last month'),
-        'alias_id': fields.many2one('mail.alias', 'Mail Alias', ondelete="cascade", required=True)
+        'menu_id': fields.many2one('ir.ui.menu', string='Related Menu', required=True, ondelete="cascade"),
+        'public': fields.selection([('public', 'Public'), ('private', 'Private'), ('groups', 'Selected Group Only')], 'Privacy', required=True,
+            help='This group is visible by non members. \
+            Invisible groups can add members through the invite button.'),
+        'group_public_id': fields.many2one('res.groups', string='Authorized Group'),
+        'group_ids': fields.many2many('res.groups', rel='mail_group_res_group_rel',
+            id1='mail_group_id', id2='groups_id', string='Auto Subscription',
+            help="Members of those groups will automatically added as followers. "\
+                 "Note that they will be able to manage their subscription manually "\
+                 "if necessary."),
+        # image: all image fields are base64 encoded and PIL-supported
+        'image': fields.binary("Photo",
+            help="This field holds the image used as photo for the group, limited to 1024x1024px."),
+        'image_medium': fields.function(_get_image, fnct_inv=_set_image,
+            string="Medium-sized photo", type="binary", multi="_get_image",
+            store={
+                'mail.group': (lambda self, cr, uid, ids, c={}: ids, ['image'], 10),
+            },
+            help="Medium-sized photo of the group. It is automatically "\
+                 "resized as a 128x128px image, with aspect ratio preserved. "\
+                 "Use this field in form views or some kanban views."),
+        'image_small': fields.function(_get_image, fnct_inv=_set_image,
+            string="Small-sized photo", type="binary", multi="_get_image",
+            store={
+                'mail.group': (lambda self, cr, uid, ids, c={}: ids, ['image'], 10),
+            },
+            help="Small-sized photo of the group. It is automatically "\
+                 "resized as a 64x64px image, with aspect ratio preserved. "\
+                 "Use this field anywhere a small image is required."),
+        'alias_id': fields.many2one('mail.alias', 'Alias', ondelete="cascade", required=True,
+            help="The email address associated with this group. New emails received will automatically "
+                 "create new topics."),
     }
 
+    def _get_default_employee_group(self, cr, uid, context=None):
+        ref = self.pool.get('ir.model.data').get_object_reference(cr, uid, 'base', 'group_user')
+        return ref and ref[1] or False
+
+    def _get_default_image(self, cr, uid, context=None):
+        image_path = openerp.modules.get_module_resource('mail', 'static/src/img', 'groupdefault.png')
+        return tools.image_resize_image_big(open(image_path, 'rb').read().encode('base64'))
+
     _defaults = {
-        'public': True,
-        'responsible_id': (lambda s, cr, uid, ctx: uid),
-        'photo': _get_default_photo,
+        'public': 'groups',
+        'group_public_id': _get_default_employee_group,
+        'image': _get_default_image,
+        'alias_domain': False,  # always hide alias during creation
     }
-    
-    def fields_view_get(self, cr, uid, view_id=None, view_type='form', context=None, toolbar=False, submenu=False):
-        res = super(mail_group,self).fields_view_get(cr, uid, view_id, view_type, context, toolbar=toolbar, submenu=submenu)
-        if view_type == 'form':
-            domain = self.pool.get("ir.config_parameter").get_param(cr, uid, "mail.catchall.domain", context=context)
-            if not domain:
-                doc = etree.XML(res['arch'])
-                alias_node = doc.xpath("//field[@name='alias_id']")[0]
-                parent = alias_node.getparent()
-                parent.remove(alias_node)
-                res['arch'] = etree.tostring(doc)
-        return res
-    
+
+    def _generate_header_description(self, cr, uid, group, context=None):
+        header = ''
+        if group.description:
+            header = '%s' % group.description
+        if group.alias_id and group.alias_id.alias_name and group.alias_id.alias_domain:
+            if header:
+                header = '%s<br/>' % header
+            return '%sGroup email gateway: %s@%s' % (header, group.alias_id.alias_name, group.alias_id.alias_domain)
+        return header
+
+    def _subscribe_users(self, cr, uid, ids, context=None):
+        for mail_group in self.browse(cr, uid, ids, context=context):
+            partner_ids = []
+            for group in mail_group.group_ids:
+                partner_ids += [user.partner_id.id for user in group.users]
+            self.message_subscribe(cr, uid, ids, partner_ids, context=context)
+
     def create(self, cr, uid, vals, context=None):
-        model_pool = self.pool.get('ir.model.data')
-        alias_pool = self.pool.get('mail.alias')
-        model, res_id = model_pool.get_object_reference( cr, uid, "mail", "model_mail_group")
-        vals.update({'alias_name': "mailing-group",
-                     'alias_model_id': res_id})
-        name = alias_pool.create_unique_alias(cr, uid, vals, context=context)
-        res = super( mail_group, self).create(cr, uid, vals, context)
-        record = self.read(cr, uid, res, context)
-        alias_pool.write(cr, uid, [record['alias_id']], {"alias_force_thread_id":record['id']}, context)
+        mail_alias = self.pool.get('mail.alias')
+        if not vals.get('alias_id'):
+            vals.pop('alias_name', None)  # prevent errors during copy()
+            alias_id = mail_alias.create_unique_alias(cr, uid,
+                          # Using '+' allows using subaddressing for those who don't
+                          # have a catchall domain setup.
+                          {'alias_name': "group+" + vals['name']},
+                          model_name=self._name, context=context)
+            vals['alias_id'] = alias_id
+
+        # get parent menu
+        menu_parent = self.pool.get('ir.model.data').get_object_reference(cr, uid, 'mail', 'mail_group_root')
+        menu_parent = menu_parent and menu_parent[1] or False
+
+        # Create menu id
+        mobj = self.pool.get('ir.ui.menu')
+        menu_id = mobj.create(cr, SUPERUSER_ID, {'name': vals['name'], 'parent_id': menu_parent}, context=context)
+        vals['menu_id'] = menu_id
+
+        # Create group and alias
+        mail_group_id = super(mail_group, self).create(cr, uid, vals, context=context)
+        mail_alias.write(cr, uid, [vals['alias_id']], {"alias_force_thread_id": mail_group_id}, context)
+        group = self.browse(cr, uid, mail_group_id, context=context)
+
+        # Create client action for this group and link the menu to it
+        ref = self.pool.get('ir.model.data').get_object_reference(cr, uid, 'mail', 'action_mail_group_feeds')
+        if ref:
+            search_ref = self.pool.get('ir.model.data').get_object_reference(cr, uid, 'mail', 'view_message_search')
+            params = {
+                'search_view_id': search_ref and search_ref[1] or False,
+                'domain': [('model', '=', 'mail.group'), ('res_id', '=', mail_group_id)],
+                'context': {'default_model': 'mail.group', 'default_res_id': mail_group_id, 'search_default_message_unread': True},
+                'res_model': 'mail.message',
+                'thread_level': 1,
+                'header_description': self._generate_header_description(cr, uid, group, context=context)
+            }
+            cobj = self.pool.get('ir.actions.client')
+            newref = cobj.copy(cr, SUPERUSER_ID, ref[1], default={'params': str(params), 'name': vals['name']}, context=context)
+            mobj.write(cr, SUPERUSER_ID, menu_id, {'action': 'ir.actions.client,' + str(newref), 'mail_group_id': mail_group_id}, context=context)
+
+        if vals.get('group_ids'):
+            self._subscribe_users(cr, uid, [mail_group_id], context=context)
+        return mail_group_id
+
+    def unlink(self, cr, uid, ids, context=None):
+        groups = self.browse(cr, uid, ids, context=context)
+        # Cascade-delete mail aliases as well, as they should not exist without the mail group.
+        mail_alias = self.pool.get('mail.alias')
+        alias_ids = [group.alias_id.id for group in groups if group.alias_id]
+        # Delete mail_group
+        res = super(mail_group, self).unlink(cr, uid, ids, context=context)
+        # Delete alias
+        mail_alias.unlink(cr, SUPERUSER_ID, alias_ids, context=context)
+        # Cascade-delete menu entries as well
+        self.pool.get('ir.ui.menu').unlink(cr, SUPERUSER_ID, [group.menu_id.id for group in groups if group.menu_id], context=context)
         return res
+
+    def write(self, cr, uid, ids, vals, context=None):
+        result = super(mail_group, self).write(cr, uid, ids, vals, context=context)
+        if vals.get('group_ids'):
+            self._subscribe_users(cr, uid, ids, context=context)
+        # if description, name or alias is changed: update client action
+        if vals.get('description') or vals.get('name') or vals.get('alias_id') or vals.get('alias_name'):
+            cobj = self.pool.get('ir.actions.client')
+            for action in [group.menu_id.action for group in self.browse(cr, uid, ids, context=context)]:
+                new_params = action.params
+                new_params['header_description'] = self._generate_header_description(cr, uid, group, context=context)
+                cobj.write(cr, SUPERUSER_ID, [action.id], {'params': str(new_params)}, context=context)
+        # if name is changed: update menu
+        if vals.get('name'):
+            mobj = self.pool.get('ir.ui.menu')
+            mobj.write(cr, SUPERUSER_ID,
+                [group.menu_id.id for group in self.browse(cr, uid, ids, context=context)],
+                {'name': vals.get('name')}, context=context)
+
+        return result
+
+    def action_follow(self, cr, uid, ids, context=None):
+        """ Wrapper because message_subscribe_users take a user_ids=None
+            that receive the context without the wrapper. """
+        return self.message_subscribe_users(cr, uid, ids, context=context)
+
+    def action_unfollow(self, cr, uid, ids, context=None):
+        """ Wrapper because message_unsubscribe_users take a user_ids=None
+            that receive the context without the wrapper. """
+        return self.message_unsubscribe_users(cr, uid, ids, context=context)