usermodel.py 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126
  1. from django.contrib.auth.models import (AbstractBaseUser, PermissionsMixin,
  2. UserManager as BaseUserManager)
  3. from django.db import models
  4. from django.utils import timezone
  5. from django.utils.translation import ugettext_lazy as _
  6. from misago.admin import site
  7. from misago.core.utils import slugify
  8. from misago.users.models import Rank
  9. from misago.users.utils import hash_email
  10. from misago.users.validators import (validate_email, validate_password,
  11. validate_username)
  12. class UserManager(BaseUserManager):
  13. def create_user(self, username, email, password=None, **extra_fields):
  14. if not email:
  15. raise ValueError(_("User must have an email address."))
  16. if not password:
  17. raise ValueError(_("User must have a password."))
  18. validate_username(username)
  19. validate_email(email)
  20. validate_password(password)
  21. now = timezone.now()
  22. user = self.model(is_staff=False, is_superuser=False, last_login=now,
  23. joined_on=now, **extra_fields)
  24. user.set_username(username)
  25. user.set_email(email)
  26. user.set_password(password)
  27. if not 'rank' in extra_fields:
  28. user.rank = Rank.objects.default()
  29. user.save(using=self._db)
  30. return user
  31. def create_superuser(self, username, email, password):
  32. user = self.create_user(username, email, password=password)
  33. user.is_staff = True
  34. user.is_superuser = True
  35. user.save(update_fields=['is_staff', 'is_superuser'], using=self._db)
  36. return user
  37. def get_by_username(self, username):
  38. return self.get(username_slug=slugify(username))
  39. def get_by_email(self, email):
  40. return self.get(email_hash=hash_email(email))
  41. def get_by_username_or_email(self, login):
  42. queryset = models.Q(username_slug=slugify(login))
  43. queryset = queryset | models.Q(email_hash=hash_email(login))
  44. return self.get(queryset)
  45. class User(AbstractBaseUser, PermissionsMixin):
  46. """
  47. Note that "username" field is purely for shows.
  48. When searching users by their names, always use lowercased string
  49. and username_slug field instead that is normalized around DB engines
  50. differences in case handling.
  51. """
  52. username = models.CharField(max_length=30)
  53. username_slug = models.CharField(max_length=30, unique=True)
  54. """
  55. Misago stores user email in two fields:
  56. "email" holds normalized email address
  57. "email_hash" is lowercase hash of email address used to identify account
  58. as well as enforcing on database level that no more than one user can be
  59. using one email address
  60. """
  61. email = models.EmailField(max_length=255, db_index=True)
  62. email_hash = models.CharField(max_length=32, unique=True)
  63. joined_on = models.DateTimeField(_('joined on'), default=timezone.now)
  64. rank = models.ForeignKey('users.Rank', on_delete=models.PROTECT)
  65. is_staff = models.BooleanField(
  66. _('staff status'), default=False, db_index=True,
  67. help_text=_('Designates whether the user can log into admin sites.'))
  68. is_active = True
  69. USERNAME_FIELD = 'username_slug'
  70. REQUIRED_FIELDS = ['email']
  71. objects = UserManager()
  72. class Meta:
  73. app_label = 'users'
  74. def get_username(self):
  75. """
  76. Dirty hack: return real username instead of normalized slug
  77. """
  78. return self.username
  79. def get_full_name(self):
  80. return self.username
  81. def get_short_name(self):
  82. return self.username
  83. def set_username(self, new_username):
  84. self.username = new_username
  85. self.username_slug = slugify(new_username)
  86. def set_email(self, new_email):
  87. self.email = UserManager.normalize_email(new_email)
  88. self.email_hash = hash_email(new_email)
  89. """register model in misago admin"""
  90. site.add_node(
  91. parent='misago:admin',
  92. after='misago:admin:index',
  93. namespace='misago:admin:users',
  94. link='misago:admin:users:accounts:index',
  95. name=_("Users"),
  96. icon='fa fa-users')
  97. site.add_node(
  98. parent='misago:admin:users',
  99. namespace='misago:admin:users:accounts',
  100. link='misago:admin:users:accounts:index',
  101. name=_("User Accounts"),
  102. icon='fa fa-users')