addons/auth_signup/res_users.py

   1 # -*- coding: utf-8 -*-
   2 ##############################################################################
   3 #
   4 #    OpenERP, Open Source Management Solution
   5 #    Copyright (C) 2012-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 from datetime import datetime, timedelta
  22 import random
  23 from urllib import urlencode
  24 from urlparse import urljoin
  25
  26 from openerp.addons.base.ir.ir_mail_server import MailDeliveryException
  27 from openerp.osv import osv, fields
  28 from openerp.tools.misc import DEFAULT_SERVER_DATETIME_FORMAT
  29 from ast import literal_eval
  30 from openerp.tools.translate import _
  31
  32 class SignupError(Exception):
  33     pass
  34
  35 def random_token():
  36     # the token has an entropy of about 120 bits (6 bits/char * 20 chars)
  37     chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789'
  38     return ''.join(random.choice(chars) for i in xrange(20))
  39
  40 def now(**kwargs):
  41     dt = datetime.now() + timedelta(**kwargs)
  42     return dt.strftime(DEFAULT_SERVER_DATETIME_FORMAT)
  43
  44
  45 class res_partner(osv.Model):
  46     _inherit = 'res.partner'
  47
  48     def _get_signup_valid(self, cr, uid, ids, name, arg, context=None):
  49         dt = now()
  50         res = {}
  51         for partner in self.browse(cr, uid, ids, context):
  52             res[partner.id] = bool(partner.signup_token) and \
  53                                 (not partner.signup_expiration or dt <= partner.signup_expiration)
  54         return res
  55
  56     def _get_signup_url_for_action(self, cr, uid, ids, action='login', view_type=None, menu_id=None, res_id=None, model=None, context=None):
  57         """ generate a signup url for the given partner ids and action, possibly overriding
  58             the url state components (menu_id, id, view_type) """
  59         if context is None:
  60             context= {}
  61         res = dict.fromkeys(ids, False)
  62         base_url = self.pool.get('ir.config_parameter').get_param(cr, uid, 'web.base.url')
  63         for partner in self.browse(cr, uid, ids, context):
  64             # when required, make sure the partner has a valid signup token
  65             if context.get('signup_valid') and not partner.user_ids:
  66                 self.signup_prepare(cr, uid, [partner.id], context=context)
  67                 partner.refresh()
  68
  69             # the parameters to encode for the query
  70             query = dict(db=cr.dbname)
  71             signup_type = context.get('signup_force_type_in_url', partner.signup_type or '')
  72             if signup_type:
  73                 query['mode'] = signup_type
  74
  75             if partner.signup_token and signup_type:
  76                 query['token'] = partner.signup_token
  77             elif partner.user_ids:
  78                 query['login'] = partner.user_ids[0].login
  79             else:
  80                 continue        # no signup token, no user, thus no signup url!
  81
  82             fragment = dict()
  83             if view_type:
  84                 fragment['view_type'] = view_type
  85             if menu_id:
  86                 fragment['menu_id'] = menu_id
  87             if model:
  88                 fragment['model'] = model
  89             if res_id:
  90                 fragment['id'] = res_id
  91
  92             res[partner.id] = urljoin(base_url, "/web/login?%s#%s" % (urlencode(query), urlencode(fragment)))
  93
  94         return res
  95
  96     def _get_signup_url(self, cr, uid, ids, name, arg, context=None):
  97         """ proxy for function field towards actual implementation """
  98         return self._get_signup_url_for_action(cr, uid, ids, context=context)
  99
 100     _columns = {
 101         'signup_token': fields.char('Signup Token'),
 102         'signup_type': fields.char('Signup Token Type'),
 103         'signup_expiration': fields.datetime('Signup Expiration'),
 104         'signup_valid': fields.function(_get_signup_valid, type='boolean', string='Signup Token is Valid'),
 105         'signup_url': fields.function(_get_signup_url, type='char', string='Signup URL'),
 106     }
 107
 108     def action_signup_prepare(self, cr, uid, ids, context=None):
 109         return self.signup_prepare(cr, uid, ids, context=context)
 110
 111     def signup_cancel(self, cr, uid, ids, context=None):
 112         return self.write(cr, uid, ids, {'signup_token': False, 'signup_type': False, 'signup_expiration': False}, context=context)
 113
 114     def signup_prepare(self, cr, uid, ids, signup_type="signup", expiration=False, context=None):
 115         """ generate a new token for the partners with the given validity, if necessary
 116             :param expiration: the expiration datetime of the token (string, optional)
 117         """
 118         for partner in self.browse(cr, uid, ids, context):
 119             if expiration or not partner.signup_valid:
 120                 token = random_token()
 121                 while self._signup_retrieve_partner(cr, uid, token, context=context):
 122                     token = random_token()
 123                 partner.write({'signup_token': token, 'signup_type': signup_type, 'signup_expiration': expiration})
 124         return True
 125
 126     def _signup_retrieve_partner(self, cr, uid, token,
 127             check_validity=False, raise_exception=False, context=None):
 128         """ find the partner corresponding to a token, and possibly check its validity
 129             :param token: the token to resolve
 130             :param check_validity: if True, also check validity
 131             :param raise_exception: if True, raise exception instead of returning False
 132             :return: partner (browse record) or False (if raise_exception is False)
 133         """
 134         partner_ids = self.search(cr, uid, [('signup_token', '=', token)], context=context)
 135         if not partner_ids:
 136             if raise_exception:
 137                 raise SignupError("Signup token '%s' is not valid" % token)
 138             return False
 139         partner = self.browse(cr, uid, partner_ids[0], context)
 140         if check_validity and not partner.signup_valid:
 141             if raise_exception:
 142                 raise SignupError("Signup token '%s' is no longer valid" % token)
 143             return False
 144         return partner
 145
 146     def signup_retrieve_info(self, cr, uid, token, context=None):
 147         """ retrieve the user info about the token
 148             :return: a dictionary with the user information:
 149                 - 'db': the name of the database
 150                 - 'token': the token, if token is valid
 151                 - 'name': the name of the partner, if token is valid
 152                 - 'login': the user login, if the user already exists
 153                 - 'email': the partner email, if the user does not exist
 154         """
 155         partner = self._signup_retrieve_partner(cr, uid, token, raise_exception=True, context=None)
 156         res = {'db': cr.dbname}
 157         if partner.signup_valid:
 158             res['token'] = token
 159             res['name'] = partner.name
 160         if partner.user_ids:
 161             res['login'] = partner.user_ids[0].login
 162         else:
 163             res['email'] = partner.email or ''
 164         return res
 165
 166 class res_users(osv.Model):
 167     _inherit = 'res.users'
 168
 169     def _get_state(self, cr, uid, ids, name, arg, context=None):
 170         res = {}
 171         for user in self.browse(cr, uid, ids, context):
 172             res[user.id] = ('active' if user.login_date else 'new')
 173         return res
 174
 175     _columns = {
 176         'state': fields.function(_get_state, string='Status', type='selection',
 177                     selection=[('new', 'Never Connected'), ('active', 'Activated')]),
 178     }
 179
 180     def signup(self, cr, uid, values, token=None, context=None):
 181         """ signup a user, to either:
 182             - create a new user (no token), or
 183             - create a user for a partner (with token, but no user for partner), or
 184             - change the password of a user (with token, and existing user).
 185             :param values: a dictionary with field values that are written on user
 186             :param token: signup token (optional)
 187             :return: (dbname, login, password) for the signed up user
 188         """
 189         if token:
 190             # signup with a token: find the corresponding partner id
 191             res_partner = self.pool.get('res.partner')
 192             partner = res_partner._signup_retrieve_partner(
 193                             cr, uid, token, check_validity=True, raise_exception=True, context=None)
 194             # invalidate signup token
 195             partner.write({'signup_token': False, 'signup_type': False, 'signup_expiration': False})
 196
 197             partner_user = partner.user_ids and partner.user_ids[0] or False
 198             if partner_user:
 199                 # user exists, modify it according to values
 200                 values.pop('login', None)
 201                 values.pop('name', None)
 202                 partner_user.write(values)
 203                 return (cr.dbname, partner_user.login, values.get('password'))
 204             else:
 205                 # user does not exist: sign up invited user
 206                 values.update({
 207                     'name': partner.name,
 208                     'partner_id': partner.id,
 209                     'email': values.get('email') or values.get('login'),
 210                 })
 211                 if partner.company_id:
 212                     values['company_id'] = partner.company_id.id
 213                     values['company_ids'] = [(6, 0, [partner.company_id.id])]
 214                 self._signup_create_user(cr, uid, values, context=context)
 215         else:
 216             # no token, sign up an external user
 217             values['email'] = values.get('email') or values.get('login')
 218             self._signup_create_user(cr, uid, values, context=context)
 219
 220         return (cr.dbname, values.get('login'), values.get('password'))
 221
 222     def _signup_create_user(self, cr, uid, values, context=None):
 223         """ create a new user from the template user """
 224         ir_config_parameter = self.pool.get('ir.config_parameter')
 225         template_user_id = literal_eval(ir_config_parameter.get_param(cr, uid, 'auth_signup.template_user_id', 'False'))
 226         assert template_user_id and self.exists(cr, uid, template_user_id, context=context), 'Signup: invalid template user'
 227
 228         # check that uninvited users may sign up
 229         if 'partner_id' not in values:
 230             if not literal_eval(ir_config_parameter.get_param(cr, uid, 'auth_signup.allow_uninvited', 'False')):
 231                 raise SignupError('Signup is not allowed for uninvited users')
 232
 233         assert values.get('login'), "Signup: no login given for new user"
 234         assert values.get('partner_id') or values.get('name'), "Signup: no name or partner given for new user"
 235
 236         # create a copy of the template user (attached to a specific partner_id if given)
 237         values['active'] = True
 238         context = dict(context or {}, no_reset_password=True)
 239         return self.copy(cr, uid, template_user_id, values, context=context)
 240
 241     def reset_password(self, cr, uid, login, context=None):
 242         """ retrieve the user corresponding to login (login or email),
 243             and reset their password
 244         """
 245         user_ids = self.search(cr, uid, [('login', '=', login)], context=context)
 246         if not user_ids:
 247             user_ids = self.search(cr, uid, [('email', '=', login)], context=context)
 248         if len(user_ids) != 1:
 249             raise Exception('Reset password: invalid username or email')
 250         return self.action_reset_password(cr, uid, user_ids, context=context)
 251
 252     def action_reset_password(self, cr, uid, ids, context=None):
 253         """ create signup token for each user, and send their signup url by email """
 254         # prepare reset password signup
 255         res_partner = self.pool.get('res.partner')
 256         partner_ids = [user.partner_id.id for user in self.browse(cr, uid, ids, context)]
 257         res_partner.signup_prepare(cr, uid, partner_ids, signup_type="reset", expiration=now(days=+1), context=context)
 258
 259         if not context:
 260             context = {}
 261
 262         # send email to users with their signup url
 263         template = False
 264         if context.get('create_user'):
 265             try:
 266                 # get_object() raises ValueError if record does not exist
 267                 template = self.pool.get('ir.model.data').get_object(cr, uid, 'auth_signup', 'set_password_email')
 268             except ValueError:
 269                 pass
 270         if not bool(template):
 271             template = self.pool.get('ir.model.data').get_object(cr, uid, 'auth_signup', 'reset_password_email')
 272         assert template._name == 'email.template'
 273
 274         for user in self.browse(cr, uid, ids, context):
 275             if not user.email:
 276                 raise osv.except_osv(_("Cannot send email: user has no email address."), user.name)
 277             self.pool.get('email.template').send_mail(cr, uid, template.id, user.id, force_send=True, raise_exception=True, context=context)
 278
 279     def create(self, cr, uid, values, context=None):
 280         if context is None:
 281             context = {}
 282         # overridden to automatically invite user to sign up
 283         user_id = super(res_users, self).create(cr, uid, values, context=context)
 284         user = self.browse(cr, uid, user_id, context=context)
 285         if user.email and not context.get('no_reset_password'):
 286             context.update({'create_user': True})
 287             try:
 288                 self.action_reset_password(cr, uid, [user.id], context=context)
 289             except MailDeliveryException:
 290                 self.pool.get('res.partner').signup_cancel(cr, uid, [user.partner_id.id], context=context)
 291         return user_id