addons/mail/res_users.py

   1 # -*- coding: utf-8 -*-
   2 ##############################################################################
   3 #
   4 #    OpenERP, Open Source Management Solution
   5 #    Copyright (C) 2009-Today OpenERP SA (<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 import logging
  23
  24 from osv import osv, fields
  25 from openerp.modules.registry import RegistryManager
  26 from openerp import SUPERUSER_ID
  27 from tools.translate import _
  28
  29 _logger = logging.getLogger(__name__)
  30
  31 class res_users(osv.Model):
  32     """ Update of res.users class
  33         - add a preference about sending emails about notifications
  34         - make a new user follow itself
  35         - add a welcome message
  36     """
  37     _name = 'res.users'
  38     _inherit = ['res.users']
  39     _inherits = {'mail.alias': 'alias_id'}
  40
  41     _columns = {
  42         'notification_email_pref': fields.selection([
  43             ('all', 'All Feeds'),
  44             ('to_me', 'Only send directly to me'),
  45             ('none', 'Never')
  46             ], 'Receive Feeds by Email', required=True,
  47             help="Choose in which case you want to receive an email when you "\
  48                  "receive new feeds."),
  49         'alias_id': fields.many2one('mail.alias', 'Alias', ondelete="cascade", required=True,
  50             help="Email address internally associated with this user. Incoming "\
  51                  "emails will appear in the user's notifications."),
  52     }
  53
  54     _defaults = {
  55         'notification_email_pref': 'to_me',
  56         'alias_domain': False, # always hide alias during creation
  57     }
  58
  59     def __init__(self, pool, cr):
  60         """ Override of __init__ to add access rights on notification_email_pref
  61             field. Access rights are disabled by default, but allowed on
  62             fields defined in self.SELF_WRITEABLE_FIELDS.
  63         """
  64         init_res = super(res_users, self).__init__(pool, cr)
  65         # duplicate list to avoid modifying the original reference
  66         self.SELF_WRITEABLE_FIELDS = list(self.SELF_WRITEABLE_FIELDS)
  67         self.SELF_WRITEABLE_FIELDS.append('notification_email_pref')
  68         return init_res
  69
  70     def _auto_init(self, cr, context=None):
  71         """Installation hook to create aliases for all users and avoid constraint errors."""
  72
  73         # disable the unique alias_id not null constraint, to avoid spurious warning during
  74         # super.auto_init. We'll reinstall it afterwards.
  75         self._columns['alias_id'].required = False
  76
  77         super(res_users,self)._auto_init(cr, context=context)
  78
  79         registry = RegistryManager.get(cr.dbname)
  80         mail_alias = registry.get('mail.alias')
  81         res_users_model = registry.get('res.users')
  82         users_no_alias = res_users_model.search(cr, SUPERUSER_ID, [('alias_id', '=', False)])
  83         # Use read() not browse(), to avoid prefetching uninitialized inherited fields
  84         for user_data in res_users_model.read(cr, SUPERUSER_ID, users_no_alias, ['login']):
  85             alias_id = mail_alias.create_unique_alias(cr, SUPERUSER_ID, {'alias_name': user_data['login'],
  86                                                                          'alias_force_id': user_data['id']},
  87                                                       model_name=self._name)
  88             res_users_model.write(cr, SUPERUSER_ID, user_data['id'], {'alias_id': alias_id})
  89             _logger.info('Mail alias created for user %s (uid %s)', user_data['login'], user_data['id'])
  90
  91         # Finally attempt to reinstate the missing constraint
  92         try:
  93             cr.execute('ALTER TABLE res_users ALTER COLUMN alias_id SET NOT NULL')
  94         except Exception:
  95             _logger.warning("Table '%s': unable to set a NOT NULL constraint on column '%s' !\n"\
  96                             "If you want to have it, you should update the records and execute manually:\n"\
  97                             "ALTER TABLE %s ALTER COLUMN %s SET NOT NULL",
  98                             self._table, 'alias_id', self._table, 'alias_id')
  99
 100         self._columns['alias_id'].required = True
 101
 102     def create(self, cr, uid, data, context=None):
 103         # create default alias same as the login
 104         mail_alias = self.pool.get('mail.alias')
 105         alias_id = mail_alias.create_unique_alias(cr, uid, {'alias_name': data['login']}, model_name=self._name, context=context)
 106         data['alias_id'] = alias_id
 107         data.pop('alias_name', None) # prevent errors during copy()
 108         # create user that follows its related partner
 109         user_id = super(res_users, self).create(cr, uid, data, context=context)
 110         user = self.browse(cr, uid, user_id, context=context)
 111         self.pool.get('res.partner').message_subscribe(cr, uid, [user.partner_id.id], [user_id], context=context)
 112         # alias
 113         mail_alias.write(cr, SUPERUSER_ID, [alias_id], {"alias_force_thread_id": user_id}, context)
 114         # create a welcome message
 115         self.create_welcome_message(cr, uid, user, context=context)
 116         return user_id
 117
 118     def create_welcome_message(self, cr, uid, user, context=None):
 119         company_name = user.company_id.name if user.company_id else _('the company')
 120         subject = '''%s has joined %s.''' % (user.name, company_name)
 121         body = '''Welcome to OpenERP !'''
 122         # TODO change 1 into user.id but catch errors
 123         return self.pool.get('res.partner').message_append_note(cr, 1, [user.partner_id.id],
 124             subject=subject, body=body, type='comment', content_subtype='html', context=context)
 125
 126     def write(self, cr, uid, ids, vals, context=None):
 127         # User alias is sync'ed with login
 128         if vals.get('login'): vals['alias_name'] = vals['login']
 129         return super(res_users, self).write(cr, uid, ids, vals, context=context)
 130
 131     def unlink(self, cr, uid, ids, context=None):
 132         # Cascade-delete mail aliases as well, as they should not exist without the user.
 133         alias_pool = self.pool.get('mail.alias')
 134         alias_ids = [user.alias_id.id for user in self.browse(cr, uid, ids, context=context) if user.alias_id]
 135         res = super(res_users, self).unlink(cr, uid, ids, context=context)
 136         alias_pool.unlink(cr, uid, alias_ids, context=context)
 137         return res
 138
 139     # --------------------------------------------------
 140     # Wrappers on partner methods for Chatter
 141     # #FIXME: another branch holds a refactoring of mail.thread
 142     # that should help cleaning those wrappers
 143     # --------------------------------------------------
 144
 145     def message_append(self, cr, uid, threads, subject, body_text=None, body_html=None,
 146                         type='email', email_date=None, parent_id=False,
 147                         content_subtype='plain', state=None,
 148                         partner_ids=None, email_from=False, email_to=False,
 149                         email_cc=None, email_bcc=None, reply_to=None,
 150                         headers=None, message_id=False, references=None,
 151                         attachments=None, original=None, context=None):
 152         for user in self.browse(cr, uid, threads, context=context):
 153             user.partner_id.message_append(subject, body_text, body_html, type, email_date, parent_id,
 154                 content_subtype, state, partner_ids, email_from, email_to, email_cc, email_bcc, reply_to,
 155                 headers, message_id, references, attachments, original)
 156
 157     def message_read(self, cr, uid, ids, fetch_ancestors=False, ancestor_ids=None,
 158                         limit=100, offset=0, domain=None, context=None):
 159         for user in self.browse(cr, uid, ids, context=context):
 160             return user.partner_id.message_read(fetch_ancestors, ancestor_ids, limit, offset, domain)
 161
 162     def message_search(self, cr, uid, ids, fetch_ancestors=False, ancestor_ids=None,
 163                         limit=100, offset=0, domain=None, count=False, context=None):
 164         for user in self.browse(cr, uid, ids, context=context):
 165             return user.partner_id.message_search(fetch_ancestors, ancestor_ids, limit, offset, domain, count)
 166
 167     def message_subscribe(self, cr, uid, ids, user_ids = None, context=None):
 168         for user in self.browse(cr, uid, ids, context=context):
 169             return user.partner_id.message_subscribe(user_ids)
 170
 171     def message_unsubscribe(self, cr, uid, ids, user_ids = None, context=None):
 172         for user in self.browse(cr, uid, ids, context=context):
 173             return user.partner_id.message_unsubscribe(user_ids)
 174
 175
 176 class res_users_mail_group(osv.Model):
 177     """ Update of res.groups class
 178         - if adding/removing users from a group, check mail.groups linked to
 179           this user group, and subscribe / unsubscribe them from the discussion
 180           group. This is done by overriding the write method.
 181     """
 182     _name = 'res.users'
 183     _inherit = ['res.users']
 184
 185     def write(self, cr, uid, ids, vals, context=None):
 186         write_res = super(res_users_mail_group, self).write(cr, uid, ids, vals, context=context)
 187         if vals.get('groups_id'):
 188             # form: {'group_ids': [(3, 10), (3, 3), (4, 10), (4, 3)]} or {'group_ids': [(6, 0, [ids]}
 189             user_group_ids = [command[1] for command in vals['groups_id'] if command[0] == 4]
 190             user_group_ids += [id for command in vals['groups_id'] if command[0] == 6 for id in command[2]]
 191             mail_group_obj = self.pool.get('mail.group')
 192             mail_group_ids = mail_group_obj.search(cr, uid, [('group_ids', 'in', user_group_ids)], context=context)
 193             mail_group_obj.message_subscribe(cr, uid, mail_group_ids, ids, context=context)
 194         return write_res
 195
 196 class res_groups_mail_group(osv.Model):
 197     """ Update of res.groups class
 198         - if adding/removing users from a group, check mail.groups linked to
 199           this user group, and subscribe / unsubscribe them from the discussion
 200           group. This is done by overriding the write method.
 201     """
 202     _name = 'res.groups'
 203     _inherit = 'res.groups'
 204
 205     def write(self, cr, uid, ids, vals, context=None):
 206         if vals.get('users'):
 207             # form: {'group_ids': [(3, 10), (3, 3), (4, 10), (4, 3)]} or {'group_ids': [(6, 0, [ids]}
 208             user_ids = [command[1] for command in vals['users'] if command[0] == 4]
 209             user_ids += [id for command in vals['users'] if command[0] == 6 for id in command[2]]
 210             mail_group_obj = self.pool.get('mail.group')
 211             mail_group_ids = mail_group_obj.search(cr, uid, [('group_ids', 'in', ids)], context=context)
 212             mail_group_obj.message_subscribe(cr, uid, mail_group_ids, user_ids, context=context)
 213         return super(res_groups_mail_group, self).write(cr, uid, ids, vals, context=context)
 214
 215 # vim:et: