379 lines
14 KiB
Python
379 lines
14 KiB
Python
import warnings
|
|
import re
|
|
import urlparse
|
|
|
|
from django.core.exceptions import ImproperlyConfigured
|
|
from django.utils import timezone
|
|
from django.utils.http import urlquote
|
|
from django.conf import settings
|
|
from django.core import validators
|
|
from django.db import models
|
|
from django.core.mail import send_mail
|
|
from django.utils.translation import ugettext_lazy as _
|
|
from django.contrib.auth.models import (AbstractBaseUser, PermissionsMixin,
|
|
BaseUserManager, SiteProfileNotAvailable)
|
|
from django.contrib.auth import load_backend
|
|
|
|
from model_utils.managers import QueryManager
|
|
|
|
from . import attribute_kinds
|
|
|
|
|
|
try:
|
|
from django.contrib.contenttypes.fields import GenericForeignKey
|
|
except ImportError:
|
|
from django.contrib.contenttypes.generic import GenericForeignKey
|
|
from django.contrib.contenttypes.models import ContentType
|
|
|
|
|
|
from . import managers, plugins
|
|
|
|
plugins.init()
|
|
|
|
class UserManager(BaseUserManager):
|
|
def create_user(self, username, email=None, password=None, **extra_fields):
|
|
"""
|
|
Creates and saves a User with the given username, email and password.
|
|
"""
|
|
now = timezone.now()
|
|
if not username:
|
|
raise ValueError('The given username must be set')
|
|
email = UserManager.normalize_email(email)
|
|
user = self.model(username=username, email=email,
|
|
is_staff=False, is_active=True, is_superuser=False,
|
|
last_login=now, date_joined=now, **extra_fields)
|
|
|
|
user.set_password(password)
|
|
user.save(using=self._db)
|
|
return user
|
|
|
|
def create_superuser(self, username, email, password, **extra_fields):
|
|
u = self.create_user(username, email, password, **extra_fields)
|
|
u.is_staff = True
|
|
u.is_active = True
|
|
u.is_superuser = True
|
|
u.save(using=self._db)
|
|
return u
|
|
|
|
|
|
class AbstractUser(AbstractBaseUser, PermissionsMixin):
|
|
"""
|
|
An abstract base class implementing a fully featured User model with
|
|
admin-compliant permissions.
|
|
|
|
Username, password and email are required. Other fields are optional.
|
|
"""
|
|
username = models.CharField(_('username'), max_length=256, unique=True,
|
|
help_text=_('Required. 30 characters or fewer. Letters, numbers and '
|
|
'@/./+/-/_ characters'),
|
|
validators=[
|
|
validators.RegexValidator(re.compile('^[\w.@+-]+$'), _('Enter a valid username.'), 'invalid')
|
|
])
|
|
is_staff = models.BooleanField(_('staff status'), default=False,
|
|
help_text=_('Designates whether the user can log into this admin '
|
|
'site.'))
|
|
is_active = models.BooleanField(_('active'), default=True,
|
|
help_text=_('Designates whether this user should be treated as '
|
|
'active. Unselect this instead of deleting accounts.'))
|
|
date_joined = models.DateTimeField(_('date joined'), default=timezone.now)
|
|
backend = models.CharField(max_length=64, blank=True)
|
|
backend_id = models.CharField(max_length=256, blank=True)
|
|
|
|
objects = UserManager()
|
|
|
|
USERNAME_FIELD = 'username'
|
|
REQUIRED_FIELDS = ['email']
|
|
|
|
class Meta:
|
|
verbose_name = _('user')
|
|
verbose_name_plural = _('users')
|
|
abstract = True
|
|
|
|
def get_absolute_url(self):
|
|
return "/users/%s/" % urlquote(self.username)
|
|
|
|
def get_full_name(self):
|
|
"""
|
|
Returns the first_name plus the last_name, with a space in between.
|
|
"""
|
|
full_name = '%s %s' % (self.first_name, self.last_name)
|
|
return full_name.strip()
|
|
|
|
def get_short_name(self):
|
|
"Returns the short name for the user."
|
|
return self.username
|
|
|
|
def email_user(self, subject, message, from_email=None):
|
|
"""
|
|
Sends an email to this User.
|
|
"""
|
|
send_mail(subject, message, from_email, [self.email])
|
|
|
|
def get_profile(self):
|
|
"""
|
|
Returns site-specific profile for this user. Raises
|
|
SiteProfileNotAvailable if this site does not allow profiles.
|
|
"""
|
|
warnings.warn("The use of AUTH_PROFILE_MODULE to define user profiles has been deprecated.",
|
|
DeprecationWarning, stacklevel=2)
|
|
if not hasattr(self, '_profile_cache'):
|
|
from django.conf import settings
|
|
if not getattr(settings, 'AUTH_PROFILE_MODULE', False):
|
|
raise SiteProfileNotAvailable(
|
|
'You need to set AUTH_PROFILE_MODULE in your project '
|
|
'settings')
|
|
try:
|
|
app_label, model_name = settings.AUTH_PROFILE_MODULE.split('.')
|
|
except ValueError:
|
|
raise SiteProfileNotAvailable(
|
|
'app_label and model_name should be separated by a dot in '
|
|
'the AUTH_PROFILE_MODULE setting')
|
|
try:
|
|
model = models.get_model(app_label, model_name)
|
|
if model is None:
|
|
raise SiteProfileNotAvailable(
|
|
'Unable to load the profile model, check '
|
|
'AUTH_PROFILE_MODULE in your project settings')
|
|
self._profile_cache = model._default_manager.using(
|
|
self._state.db).get(user__id__exact=self.id)
|
|
self._profile_cache.user = self
|
|
except (ImportError, ImproperlyConfigured):
|
|
raise SiteProfileNotAvailable
|
|
return self._profile_cache
|
|
|
|
def get_backend(self):
|
|
return load_backend(self.backend)
|
|
|
|
def has_usable_password(self):
|
|
if self.backend:
|
|
backend = self.get_backend()
|
|
if hasattr(backend, 'has_usable_password'):
|
|
return backend.has_usable_password(self)
|
|
return super(AbstractUser, self).has_usable_password()
|
|
|
|
def set_password(self, raw_password):
|
|
if self.backend:
|
|
backend = self.get_backend()
|
|
if hasattr(backend, 'set_password'):
|
|
return backend.set_password(self, raw_password)
|
|
return super(AbstractUser, self).set_password(raw_password)
|
|
|
|
def check_password(self, raw_password):
|
|
if self.backend:
|
|
backend = self.get_backend()
|
|
if hasattr(backend, 'check_password'):
|
|
return backend.check_password(self, raw_password)
|
|
return super(AbstractUser, self).check_password(raw_password)
|
|
|
|
def save(self, *args, **kwargs):
|
|
no_backend = kwargs.pop('no_backend', False)
|
|
if self.backend and not no_backend:
|
|
backend = self.get_backend()
|
|
if hasattr(backend, 'save'):
|
|
if backend.save(self, *args, **kwargs):
|
|
return
|
|
super(AbstractUser, self).save(*args, **kwargs)
|
|
|
|
def get_roles(self):
|
|
return [group.name for group in self.groups.all()]
|
|
roles = property(get_roles)
|
|
|
|
|
|
class DeletedUser(models.Model):
|
|
'''Record users to delete'''
|
|
|
|
objects = managers.DeletedUserManager()
|
|
|
|
user = models.ForeignKey(settings.AUTH_USER_MODEL,
|
|
verbose_name=_('user'))
|
|
creation = models.DateTimeField(auto_now_add=True,
|
|
verbose_name=_('creation date'))
|
|
|
|
class Meta:
|
|
verbose_name = _('user to delete')
|
|
verbose_name_plural = _('users to delete')
|
|
|
|
class UserExternalId(models.Model):
|
|
user = models.ForeignKey(settings.AUTH_USER_MODEL,
|
|
verbose_name=_('user'))
|
|
source = models.URLField(max_length=256,
|
|
verbose_name=_('source'))
|
|
external_id = models.CharField(max_length=256,
|
|
verbose_name=_('external id'))
|
|
created = models.DateTimeField(auto_now_add=True,
|
|
verbose_name=_('creation date'))
|
|
updated = models.DateTimeField(auto_now=True,
|
|
verbose_name=_('last update date'))
|
|
|
|
def __unicode__(self):
|
|
return u'{0} is {1} on {2}'.format(
|
|
self.user, self.external_id, self.source)
|
|
|
|
def __repr__(self):
|
|
return '<UserExternalId user: {0!r} source: {1!r} ' \
|
|
'external_id: {2!r} created: {3} updated: {4}' \
|
|
.format(self.user_id, self.source, self.external_id,
|
|
self.created, self.update)
|
|
|
|
class Meta:
|
|
verbose_name = _('user external id')
|
|
verbose_name_plural = _('user external ids')
|
|
|
|
class AuthenticationEvent(models.Model):
|
|
'''Record authentication events whatever the source'''
|
|
when = models.DateTimeField(auto_now=True,
|
|
verbose_name=_('when'))
|
|
who = models.CharField(max_length=80,
|
|
verbose_name=_('who'))
|
|
how = models.CharField(max_length=10,
|
|
verbose_name=_('how'))
|
|
nonce = models.CharField(max_length=255,
|
|
verbose_name=_('nonce'))
|
|
|
|
objects = managers.AuthenticationEventManager()
|
|
|
|
class Meta:
|
|
verbose_name = _('authentication log')
|
|
verbose_name_plural = _('authentication logs')
|
|
|
|
def __unicode__(self):
|
|
return _('Authentication of %(who)s by %(how)s at %(when)s') % \
|
|
self.__dict__
|
|
|
|
class LogoutUrlAbstract(models.Model):
|
|
logout_url = models.URLField(verbose_name=_('url'), help_text=_('you can use a {} '
|
|
'to pass the URL of the success icon, ex.: '
|
|
'http://example.com/logout?next={}'), max_length=255, blank=True, null=True)
|
|
logout_use_iframe = models.BooleanField(
|
|
verbose_name=_('use an iframe instead of an img tag for logout'))
|
|
logout_use_iframe_timeout = models.PositiveIntegerField(
|
|
verbose_name=_('iframe logout timeout (ms)'),
|
|
help_text=_('if iframe logout is used, it\'s the time between the '
|
|
'onload event for this iframe and the moment we consider its '
|
|
'loading to be really finished'),
|
|
default=300)
|
|
|
|
def get_logout_url(self, request):
|
|
ok_icon_url = request.build_absolute_uri(urlparse.urljoin(settings.STATIC_URL,
|
|
'authentic2/images/ok.png'))
|
|
return self.logout_url.format(urlquote(ok_icon_url))
|
|
|
|
class Meta:
|
|
abstract = True
|
|
|
|
|
|
class LogoutUrl(LogoutUrlAbstract):
|
|
content_type = models.ForeignKey(ContentType,
|
|
verbose_name=_('content type'))
|
|
object_id = models.PositiveIntegerField(
|
|
verbose_name=_('object identifier'))
|
|
provider = GenericForeignKey('content_type', 'object_id')
|
|
|
|
class Meta:
|
|
verbose_name = _('logout URL')
|
|
verbose_name_plural = _('logout URL')
|
|
|
|
class FederatedId(models.Model):
|
|
provider = models.CharField(max_length=255,
|
|
verbose_name=_('provider'))
|
|
about = models.CharField(max_length=255,
|
|
verbose_name=_('about'))
|
|
service = models.CharField(max_length=255,
|
|
verbose_name=_('service'))
|
|
id_format = models.CharField(max_length=128,
|
|
verbose_name=_('format identifier'))
|
|
id_value = models.TextField(
|
|
verbose_name=_('identifier'))
|
|
|
|
objects = managers.FederatedIdManager()
|
|
|
|
class Meta:
|
|
verbose_name = _('federation identifier')
|
|
verbose_name_plural = _('federation identifiers')
|
|
|
|
class Attribute(models.Model):
|
|
label = models.CharField(verbose_name=_('label'), max_length=63,
|
|
unique=True)
|
|
description = models.TextField(verbose_name=_('description'), blank=True)
|
|
name = models.SlugField(verbose_name=_('name'), max_length=256,
|
|
unique=True)
|
|
required = models.BooleanField(
|
|
verbose_name=_('required'),
|
|
blank=True)
|
|
asked_on_registration = models.BooleanField(
|
|
verbose_name=_('asked on registration'),
|
|
blank=True)
|
|
user_editable = models.BooleanField(
|
|
verbose_name=_('user editable'),
|
|
blank=True)
|
|
user_visible = models.BooleanField(
|
|
verbose_name=_('user visible'),
|
|
blank=True)
|
|
multiple = models.BooleanField(
|
|
verbose_name=_('multiple'),
|
|
blank=True)
|
|
kind = models.CharField(max_length=16,
|
|
verbose_name=_('kind'),
|
|
choices=attribute_kinds.get_choices())
|
|
|
|
objects = managers.GetByNameManager()
|
|
registration_attributes = QueryManager(asked_on_registration=True)
|
|
user_attributes = QueryManager(user_editable=True)
|
|
|
|
def get_form_field(self, **kwargs):
|
|
kwargs['label'] = self.label
|
|
kwargs['required'] = self.required
|
|
if self.description:
|
|
kwargs['help_text'] = self.description
|
|
return attribute_kinds.get_form_field(self.kind, **kwargs)
|
|
|
|
def get_kind(self):
|
|
return attribute_kinds.get_kind(self.kind)
|
|
|
|
def contribute_to_form(self, form, **kwargs):
|
|
form.fields[self.name] = self.get_form_field(**kwargs)
|
|
|
|
def set_value(self, owner, value):
|
|
serialize = self.get_kind()['serialize']
|
|
content = serialize(value)
|
|
av, created = AttributeValue.objects.get_or_create(
|
|
content_type=ContentType.objects.get_for_model(owner),
|
|
object_id=owner.pk,
|
|
attribute=self,
|
|
defaults={'content': content})
|
|
if not created:
|
|
av.content = content
|
|
av.save()
|
|
|
|
def natural_key(self):
|
|
return (self.name,)
|
|
|
|
def __unicode__(self):
|
|
return self.label
|
|
|
|
class Meta:
|
|
verbose_name = _('attribute definition')
|
|
verbose_name_plural = _('attribute definitions')
|
|
|
|
class AttributeValue(models.Model):
|
|
content_type = models.ForeignKey('contenttypes.ContentType',
|
|
verbose_name=_('content type'))
|
|
object_id = models.PositiveIntegerField(
|
|
verbose_name=_('object identifier'))
|
|
owner = GenericForeignKey('content_type', 'object_id')
|
|
|
|
attribute = models.ForeignKey('Attribute',
|
|
verbose_name=_('attribute'))
|
|
|
|
content = models.TextField(verbose_name=_('content'))
|
|
|
|
objects = managers.AttributeValueManager()
|
|
|
|
def to_python(self):
|
|
deserialize = self.attribute.get_kind()['deserialize']
|
|
return deserialize(self.content)
|
|
|
|
class Meta:
|
|
verbose_name = _('attribute value')
|
|
verbose_name_plural = _('attribute values')
|