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