mirror of
https://github.com/wassname/flask-security.git
synced 2026-07-04 17:20:07 +08:00
Matt Wright
115 lines
3.0 KiB
Python
115 lines
3.0 KiB
Python
# -*- coding: utf-8 -*-
|
|
"""
|
|
flask.ext.security.confirmable
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Flask-Security confirmable module
|
|
|
|
:copyright: (c) 2012 by Matt Wright.
|
|
:license: MIT, see LICENSE for more details.
|
|
"""
|
|
|
|
from datetime import datetime
|
|
|
|
from flask import current_app as app, request, url_for
|
|
from werkzeug.local import LocalProxy
|
|
|
|
from .exceptions import UserNotFoundError, ConfirmationError, TokenExpiredError
|
|
from .utils import generate_token, send_mail
|
|
from .signals import user_confirmed, confirm_instructions_sent
|
|
|
|
|
|
# Convenient references
|
|
_security = LocalProxy(lambda: app.security)
|
|
|
|
_datastore = LocalProxy(lambda: app.security.datastore)
|
|
|
|
|
|
def find_user_by_confirmation_token(token):
|
|
if not token:
|
|
raise ConfirmationError('Confirmation token required')
|
|
return _datastore.find_user(confirmation_token=token)
|
|
|
|
|
|
def send_confirmation_instructions(user):
|
|
url = url_for('flask_security.confirm',
|
|
confirmation_token=user.confirmation_token)
|
|
|
|
confirmation_link = request.url_root[:-1] + url
|
|
|
|
send_mail('Please confirm your email', user.email,
|
|
'confirmation_instructions',
|
|
dict(user=user, confirmation_link=confirmation_link))
|
|
|
|
confirm_instructions_sent.send(user, app=app._get_current_object())
|
|
|
|
return True
|
|
|
|
|
|
def generate_confirmation_token(user):
|
|
while True:
|
|
token = generate_token()
|
|
try:
|
|
find_user_by_confirmation_token(token)
|
|
except UserNotFoundError:
|
|
break
|
|
|
|
now = datetime.utcnow()
|
|
|
|
try:
|
|
user['confirmation_token'] = token
|
|
user['confirmation_sent_at'] = now
|
|
except TypeError:
|
|
user.confirmation_token = token
|
|
user.confirmation_sent_at = now
|
|
|
|
return user
|
|
|
|
|
|
def should_confirm_email(fn):
|
|
def wrapped(*args, **kwargs):
|
|
if _security.confirm_email:
|
|
return fn(*args, **kwargs)
|
|
return False
|
|
return wrapped
|
|
|
|
|
|
@should_confirm_email
|
|
def requires_confirmation(user):
|
|
return user.confirmed_at == None
|
|
|
|
|
|
@should_confirm_email
|
|
def confirmation_token_is_expired(user):
|
|
token_expires = datetime.utcnow() - _security.confirm_email_within
|
|
return user.confirmation_sent_at < token_expires
|
|
|
|
|
|
def confirm_by_token(token):
|
|
try:
|
|
user = find_user_by_confirmation_token(token)
|
|
except UserNotFoundError:
|
|
raise ConfirmationError('Invalid confirmation token')
|
|
|
|
if user.confirmed_at:
|
|
raise ConfirmationError('Account has already been confirmed')
|
|
|
|
if confirmation_token_is_expired(user):
|
|
raise TokenExpiredError(message='Confirmation token is expired',
|
|
user=user)
|
|
|
|
# TODO: Clear confirmation_token after confirmation?
|
|
#user.confirmation_token = None
|
|
#user.confirmation_sent_at = None
|
|
user.confirmed_at = datetime.utcnow()
|
|
|
|
_datastore._save_model(user)
|
|
|
|
user_confirmed.send(user, app=app._get_current_object())
|
|
return user
|
|
|
|
|
|
def reset_confirmation_token(user):
|
|
_datastore._save_model(generate_confirmation_token(user))
|
|
send_confirmation_instructions(user)
|