mirror of
https://github.com/wassname/flask-security.git
synced 2026-06-27 16:10:11 +08:00
Matt Wright
198 lines
6.6 KiB
Python
198 lines
6.6 KiB
Python
# -*- coding: utf-8 -*-
|
|
"""
|
|
flask.ext.security.datastore
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
This module contains an abstracted user datastore.
|
|
|
|
:copyright: (c) 2012 by Matt Wright.
|
|
:license: MIT, see LICENSE for more details.
|
|
"""
|
|
|
|
from datetime import datetime
|
|
from flask.ext import security
|
|
from flask.ext.security import UserCreationError, RoleCreationError, pwd_context
|
|
|
|
class UserDatastore(object):
|
|
"""Abstracted user datastore. Always extend this class and implement the
|
|
:attr:`get_models`, :attr:`_save_model`, :attr:`_do_with_id`,
|
|
:attr:`_do_find_user`, and :attr:`_do_find_role` methods.
|
|
|
|
:param db: An instance of a configured databse manager from a Flask
|
|
extension such as Flask-SQLAlchemy or Flask-MongoEngine"""
|
|
|
|
def __init__(self, db):
|
|
self.db = db
|
|
|
|
def get_models(self):
|
|
"""Returns configured `User` and `Role` models for the datastore
|
|
implementation"""
|
|
raise NotImplementedError(
|
|
"User datastore does not implement get_models method")
|
|
|
|
def _save_model(self, model, **kwargs):
|
|
raise NotImplementedError(
|
|
"User datastore does not implement _save_model method")
|
|
|
|
def _do_with_id(self, id):
|
|
raise NotImplementedError(
|
|
"User datastore does not implement _do_with_id method")
|
|
|
|
def _do_find_user(self):
|
|
raise NotImplementedError(
|
|
"User datastore does not implement _do_find_user method")
|
|
|
|
def _do_find_role(self):
|
|
raise NotImplementedError(
|
|
"User datastore does not implement _do_find_role method")
|
|
|
|
def _do_add_role(self, user, role):
|
|
user, role = self._prepare_role_modify_args(user, role)
|
|
if role not in user.roles:
|
|
user.roles.append(role)
|
|
return user
|
|
|
|
def _do_remove_role(self, user, role):
|
|
user, role = self._prepare_role_modify_args(user, role)
|
|
if role in user.roles:
|
|
user.roles.remove(role)
|
|
return user
|
|
|
|
def _do_toggle_active(self, user, active=None):
|
|
user = self.find_user(user)
|
|
if active is None:
|
|
user.active = not user.active
|
|
elif active != user.active:
|
|
user.active = active
|
|
return user
|
|
|
|
def _do_deactive_user(self, user):
|
|
return self._do_toggle_active(user, False)
|
|
|
|
def _do_active_user(self, user):
|
|
return self._do_toggle_active(user, True)
|
|
|
|
def _prepare_role_modify_args(self, user, role):
|
|
if isinstance(user, security.User):
|
|
user = user.username or user.email
|
|
|
|
if isinstance(role, security.Role):
|
|
role = role.name
|
|
|
|
return self.find_user(user), self.find_role(role)
|
|
|
|
def _prepare_create_role_args(self, kwargs):
|
|
for key in ('name', 'description'):
|
|
kwargs[key] = kwargs.get(key, None)
|
|
|
|
if kwargs['name'] is None:
|
|
raise RoleCreationError("Missing name argument")
|
|
|
|
return kwargs
|
|
|
|
def _prepare_create_user_args(self, kwargs):
|
|
username = kwargs.get('username', None)
|
|
email = kwargs.get('email', None)
|
|
password = kwargs.get('password', None)
|
|
|
|
if username is None and email is None:
|
|
raise UserCreationError('Missing username and/or email arguments')
|
|
|
|
if password is None:
|
|
raise UserCreationError('Missing password argument')
|
|
|
|
roles = kwargs.get('roles', [])
|
|
|
|
for i, role in enumerate(roles):
|
|
rn = role.name if isinstance(role, security.Role) else role
|
|
# see if the role exists
|
|
roles[i] = self.find_role(rn)
|
|
|
|
kwargs['roles'] = roles
|
|
|
|
now = datetime.utcnow()
|
|
kwargs['created_at'], kwargs['modified_at'] = now, now
|
|
|
|
pw = kwargs['password']
|
|
if not pwd_context.identify(pw):
|
|
kwargs['password'] = pwd_context.encrypt(pw)
|
|
|
|
return kwargs
|
|
|
|
def with_id(self, id):
|
|
"""Returns a user with the specified ID.
|
|
|
|
:param id: User ID"""
|
|
user = self._do_with_id(id)
|
|
if user: return user
|
|
raise security.UserIdNotFoundError()
|
|
|
|
def find_user(self, user):
|
|
"""Returns a user based on the specified identifier.
|
|
|
|
:param user: User identifier, usually a username or email address
|
|
"""
|
|
user = self._do_find_user(user)
|
|
if user: return user
|
|
raise security.UserNotFoundError()
|
|
|
|
def find_role(self, role):
|
|
"""Returns a role based on its name.
|
|
|
|
:param role: Role name
|
|
"""
|
|
role = self._do_find_role(role)
|
|
if role: return role
|
|
raise security.RoleNotFoundError()
|
|
|
|
def create_role(self, **kwargs):
|
|
"""Creates and returns a new role.
|
|
|
|
:param name: Role name
|
|
:param description: Role description
|
|
"""
|
|
role = security.Role(**self._prepare_create_role_args(kwargs))
|
|
return self._save_model(role)
|
|
|
|
def create_user(self, **kwargs):
|
|
"""Creates and returns a new user.
|
|
|
|
:param username: Username
|
|
:param email: Email address
|
|
:param password: Unencrypted password
|
|
:param active: The optional active state
|
|
"""
|
|
user = security.User(**self._prepare_create_user_args(kwargs))
|
|
return self._save_model(user)
|
|
|
|
def add_role_to_user(self, user, role):
|
|
"""Adds a role to a user if the user does not have it already. Returns
|
|
the modified user.
|
|
|
|
:param user: A User instance or a user identifier
|
|
:param role: A Role instance or a role name
|
|
"""
|
|
return self._save_model(self._do_add_role(user, role))
|
|
|
|
def remove_role_from_user(self, user, role, commit=True):
|
|
"""Removes a role from a user if the user has the role. Returns the
|
|
modified user.
|
|
|
|
:param user: A User instance or a user identifier
|
|
:param role: A Role instance or a role name
|
|
"""
|
|
return self._save_model(self._do_remove_role(user, role))
|
|
|
|
def deactivate_user(self, user):
|
|
"""Deactivates a user and returns the modified user.
|
|
|
|
:param user: A User instance or a user identifier
|
|
"""
|
|
return self._save_model(self._do_deactive_user(user))
|
|
|
|
def activate_user(self, user, commit=True):
|
|
"""Activates a user and returns the modified user.
|
|
|
|
:param user: A User instance or a user identifier
|
|
"""
|
|
return self._save_model(self._do_active_user(user)) |