Commit 0794ea9495d91fc3bfc114e088bdd73343d37e3f
1 parent
52c37d174f
Exists in
master
Improved search fields for autocomplete
Showing 3 changed files with 12 additions and 2 deletions Inline Diff
flashcards/models.py
View file @
0794ea9
| from django.contrib.auth.models import AbstractUser, UserManager | 1 | 1 | from django.contrib.auth.models import AbstractUser, UserManager | |
| from django.db.models import * | 2 | 2 | from django.db.models import * | |
| from django.utils.timezone import now | 3 | 3 | from django.utils.timezone import now | |
| from simple_email_confirmation import SimpleEmailConfirmationUserMixin | 4 | 4 | from simple_email_confirmation import SimpleEmailConfirmationUserMixin | |
| from fields import MaskField | 5 | 5 | from fields import MaskField | |
| 6 | 6 | |||
| # Hack to fix AbstractUser before subclassing it | 7 | 7 | # Hack to fix AbstractUser before subclassing it | |
| AbstractUser._meta.get_field('email')._unique = True | 8 | 8 | AbstractUser._meta.get_field('email')._unique = True | |
| AbstractUser._meta.get_field('username')._unique = False | 9 | 9 | AbstractUser._meta.get_field('username')._unique = False | |
| 10 | 10 | |||
| 11 | 11 | |||
| class EmailOnlyUserManager(UserManager): | 12 | 12 | class EmailOnlyUserManager(UserManager): | |
| """ | 13 | 13 | """ | |
| A tiny extension of Django's UserManager which correctly creates users | 14 | 14 | A tiny extension of Django's UserManager which correctly creates users | |
| without usernames (using emails instead). | 15 | 15 | without usernames (using emails instead). | |
| """ | 16 | 16 | """ | |
| 17 | 17 | |||
| def _create_user(self, email, password, is_staff, is_superuser, **extra_fields): | 18 | 18 | def _create_user(self, email, password, is_staff, is_superuser, **extra_fields): | |
| """ | 19 | 19 | """ | |
| Creates and saves a User with the given email and password. | 20 | 20 | Creates and saves a User with the given email and password. | |
| """ | 21 | 21 | """ | |
| email = self.normalize_email(email) | 22 | 22 | email = self.normalize_email(email) | |
| user = self.model(email=email, | 23 | 23 | user = self.model(email=email, | |
| is_staff=is_staff, is_active=True, | 24 | 24 | is_staff=is_staff, is_active=True, | |
| is_superuser=is_superuser, | 25 | 25 | is_superuser=is_superuser, | |
| date_joined=now(), **extra_fields) | 26 | 26 | date_joined=now(), **extra_fields) | |
| user.set_password(password) | 27 | 27 | user.set_password(password) | |
| user.save(using=self._db) | 28 | 28 | user.save(using=self._db) | |
| return user | 29 | 29 | return user | |
| 30 | 30 | |||
| def create_user(self, email, password=None, **extra_fields): | 31 | 31 | def create_user(self, email, password=None, **extra_fields): | |
| return self._create_user(email, password, False, False, **extra_fields) | 32 | 32 | return self._create_user(email, password, False, False, **extra_fields) | |
| 33 | 33 | |||
| def create_superuser(self, email, password, **extra_fields): | 34 | 34 | def create_superuser(self, email, password, **extra_fields): | |
| return self._create_user(email, password, True, True, **extra_fields) | 35 | 35 | return self._create_user(email, password, True, True, **extra_fields) | |
| 36 | 36 | |||
| 37 | 37 | |||
| class User(AbstractUser, SimpleEmailConfirmationUserMixin): | 38 | 38 | class User(AbstractUser, SimpleEmailConfirmationUserMixin): | |
| """ | 39 | 39 | """ | |
| An extension of Django's default user model. | 40 | 40 | An extension of Django's default user model. | |
| We use email as the username field, and include enrolled sections here | 41 | 41 | We use email as the username field, and include enrolled sections here | |
| """ | 42 | 42 | """ | |
| objects = EmailOnlyUserManager() | 43 | 43 | objects = EmailOnlyUserManager() | |
| USERNAME_FIELD = 'email' | 44 | 44 | USERNAME_FIELD = 'email' | |
| REQUIRED_FIELDS = [] | 45 | 45 | REQUIRED_FIELDS = [] | |
| sections = ManyToManyField('Section', help_text="The sections which the user is enrolled in") | 46 | 46 | sections = ManyToManyField('Section', help_text="The sections which the user is enrolled in") | |
| 47 | 47 | |||
| 48 | 48 | |||
| class UserFlashcard(Model): | 49 | 49 | class UserFlashcard(Model): | |
| """ | 50 | 50 | """ | |
| Represents the relationship between a user and a flashcard by: | 51 | 51 | Represents the relationship between a user and a flashcard by: | |
| 1. A user has a flashcard in their deck | 52 | 52 | 1. A user has a flashcard in their deck | |
| 2. A user used to have a flashcard in their deck | 53 | 53 | 2. A user used to have a flashcard in their deck | |
| 3. A user has a flashcard hidden from them | 54 | 54 | 3. A user has a flashcard hidden from them | |
| """ | 55 | 55 | """ | |
| user = ForeignKey('User') | 56 | 56 | user = ForeignKey('User') | |
| mask = MaskField(max_length=255, null=True, blank=True, help_text="The user-specific mask on the card") | 57 | 57 | mask = MaskField(max_length=255, null=True, blank=True, help_text="The user-specific mask on the card") | |
| pulled = DateTimeField(blank=True, null=True, help_text="When the user pulled the card") | 58 | 58 | pulled = DateTimeField(blank=True, null=True, help_text="When the user pulled the card") | |
| flashcard = ForeignKey('Flashcard') | 59 | 59 | flashcard = ForeignKey('Flashcard') | |
| unpulled = DateTimeField(blank=True, null=True, help_text="When the user unpulled this card") | 60 | 60 | unpulled = DateTimeField(blank=True, null=True, help_text="When the user unpulled this card") | |
| 61 | 61 | |||
| class Meta: | 62 | 62 | class Meta: | |
| # There can be at most one UserFlashcard for each User and Flashcard | 63 | 63 | # There can be at most one UserFlashcard for each User and Flashcard | |
| unique_together = (('user', 'flashcard'),) | 64 | 64 | unique_together = (('user', 'flashcard'),) | |
| index_together = ["user", "flashcard"] | 65 | 65 | index_together = ["user", "flashcard"] | |
| # By default, order by most recently pulled | 66 | 66 | # By default, order by most recently pulled | |
| ordering = ['-pulled'] | 67 | 67 | ordering = ['-pulled'] | |
| 68 | 68 | |||
| def is_hidden(self): | 69 | 69 | def is_hidden(self): | |
| """ | 70 | 70 | """ | |
| A card is hidden only if a user has not ever added it to their deck. | 71 | 71 | A card is hidden only if a user has not ever added it to their deck. | |
| :return: Whether the flashcard is hidden from the user | 72 | 72 | :return: Whether the flashcard is hidden from the user | |
| """ | 73 | 73 | """ | |
| return not self.pulled | 74 | 74 | return not self.pulled | |
| 75 | 75 | |||
| def is_in_deck(self): | 76 | 76 | def is_in_deck(self): | |
| """ | 77 | 77 | """ | |
| :return:Whether the flashcard is in the user's deck | 78 | 78 | :return:Whether the flashcard is in the user's deck | |
| """ | 79 | 79 | """ | |
| return self.pulled and not self.unpulled | 80 | 80 | return self.pulled and not self.unpulled | |
| 81 | 81 | |||
| 82 | 82 | |||
| class Flashcard(Model): | 83 | 83 | class Flashcard(Model): | |
| text = CharField(max_length=255, help_text='The text on the card') | 84 | 84 | text = CharField(max_length=255, help_text='The text on the card') | |
| section = ForeignKey('Section', help_text='The section with which the card is associated') | 85 | 85 | section = ForeignKey('Section', help_text='The section with which the card is associated') | |
| pushed = DateTimeField(auto_now_add=True, help_text="When the card was first pushed") | 86 | 86 | pushed = DateTimeField(auto_now_add=True, help_text="When the card was first pushed") | |
| material_date = DateTimeField(default=now, help_text="The date with which the card is associated") | 87 | 87 | material_date = DateTimeField(default=now, help_text="The date with which the card is associated") | |
| previous = ForeignKey('Flashcard', null=True, blank=True, | 88 | 88 | previous = ForeignKey('Flashcard', null=True, blank=True, | |
| help_text="The previous version of this card, if one exists") | 89 | 89 | help_text="The previous version of this card, if one exists") | |
| author = ForeignKey(User) | 90 | 90 | author = ForeignKey(User) | |
| is_hidden = BooleanField(default=False) | 91 | 91 | is_hidden = BooleanField(default=False) | |
| hide_reason = CharField(blank=True, max_length=255, help_text="Reason for hiding this card") | 92 | 92 | hide_reason = CharField(blank=True, max_length=255, help_text="Reason for hiding this card") | |
| mask = MaskField(max_length=255, null=True, blank=True, help_text="The mask on the card") | 93 | 93 | mask = MaskField(max_length=255, null=True, blank=True, help_text="The mask on the card") | |
| 94 | 94 | |||
| class Meta: | 95 | 95 | class Meta: | |
| # By default, order by most recently pushed | 96 | 96 | # By default, order by most recently pushed | |
| ordering = ['-pushed'] | 97 | 97 | ordering = ['-pushed'] | |
| 98 | 98 | |||
| def is_hidden_from(self, user): | 99 | 99 | def is_hidden_from(self, user): | |
| """ | 100 | 100 | """ | |
| A card can be hidden globally, but if a user has the card in their deck, | 101 | 101 | A card can be hidden globally, but if a user has the card in their deck, | |
| this visibility overrides a global hide. | 102 | 102 | this visibility overrides a global hide. | |
| :param user: | 103 | 103 | :param user: | |
| :return: Whether the card is hidden from the user. | 104 | 104 | :return: Whether the card is hidden from the user. | |
| """ | 105 | 105 | """ | |
| result = user.userflashcard_set.filter(flashcard=self) | 106 | 106 | result = user.userflashcard_set.filter(flashcard=self) | |
| if not result.exists(): return self.is_hidden | 107 | 107 | if not result.exists(): return self.is_hidden | |
| return result[0].is_hidden() | 108 | 108 | return result[0].is_hidden() | |
| 109 | 109 | |||
| @classmethod | 110 | 110 | @classmethod | |
| def cards_visible_to(cls, user): | 111 | 111 | def cards_visible_to(cls, user): | |
| """ | 112 | 112 | """ | |
| :param user: | 113 | 113 | :param user: | |
| :return: A queryset with all cards that should be visible to a user. | 114 | 114 | :return: A queryset with all cards that should be visible to a user. | |
| """ | 115 | 115 | """ | |
| return cls.objects.filter(is_hidden=False).exclude(userflashcard__user=user, userflashcard__pulled=None) | 116 | 116 | return cls.objects.filter(is_hidden=False).exclude(userflashcard__user=user, userflashcard__pulled=None) | |
| 117 | 117 | |||
| 118 | 118 | |||
| class UserFlashcardQuiz(Model): | 119 | 119 | class UserFlashcardQuiz(Model): | |
| """ | 120 | 120 | """ | |
| An event of a user being quizzed on a flashcard. | 121 | 121 | An event of a user being quizzed on a flashcard. | |
| """ | 122 | 122 | """ | |
| user_flashcard = ForeignKey(UserFlashcard) | 123 | 123 | user_flashcard = ForeignKey(UserFlashcard) | |
| when = DateTimeField(auto_now=True) | 124 | 124 | when = DateTimeField(auto_now=True) | |
| blanked_word = CharField(max_length=8, blank=True, help_text="The character range which was blanked") | 125 | 125 | blanked_word = CharField(max_length=8, blank=True, help_text="The character range which was blanked") | |
| response = CharField(max_length=255, blank=True, null=True, help_text="The user's response") | 126 | 126 | response = CharField(max_length=255, blank=True, null=True, help_text="The user's response") | |
| correct = NullBooleanField(help_text="The user's self-evaluation of their response") | 127 | 127 | correct = NullBooleanField(help_text="The user's self-evaluation of their response") | |
| 128 | 128 | |||
| def status(self): | 129 | 129 | def status(self): | |
| """ | 130 | 130 | """ | |
| There are three stages of a quiz object: | 131 | 131 | There are three stages of a quiz object: | |
| 1. the user has been shown the card | 132 | 132 | 1. the user has been shown the card | |
| 2. the user has answered the card | 133 | 133 | 2. the user has answered the card | |
| 3. the user has self-evaluated their response's correctness | 134 | 134 | 3. the user has self-evaluated their response's correctness | |
| 135 | 135 | |||
| :return: string (evaluated, answered, viewed) | 136 | 136 | :return: string (evaluated, answered, viewed) | |
| """ | 137 | 137 | """ | |
| if self.correct is not None: return "evaluated" | 138 | 138 | if self.correct is not None: return "evaluated" | |
| if self.response: return "answered" | 139 | 139 | if self.response: return "answered" | |
| return "viewed" | 140 | 140 | return "viewed" | |
| 141 | 141 | |||
| 142 | 142 | |||
| class Section(Model): | 143 | 143 | class Section(Model): | |
| """ | 144 | 144 | """ | |
| A UCSD course taught by an instructor during a quarter. | 145 | 145 | A UCSD course taught by an instructor during a quarter. | |
| We use the term "section" to avoid collision with the builtin keyword "class" | 146 | 146 | We use the term "section" to avoid collision with the builtin keyword "class" | |
| We index gratuitously to support autofill and because this is primarily read-only | 147 | 147 | We index gratuitously to support autofill and because this is primarily read-only | |
| """ | 148 | 148 | """ | |
| department = CharField(db_index=True, max_length=50) | 149 | 149 | department = CharField(db_index=True, max_length=50) | |
| department_abbreviation = CharField(db_index=True, max_length=10) | 150 | 150 | department_abbreviation = CharField(db_index=True, max_length=10) | |
| course_num = CharField(db_index=True, max_length=6) | 151 | 151 | course_num = CharField(db_index=True, max_length=6) | |
| course_title = CharField(db_index=True, max_length=50) | 152 | 152 | course_title = CharField(db_index=True, max_length=50) | |
| instructor = CharField(db_index=True, max_length=100) | 153 | 153 | instructor = CharField(db_index=True, max_length=100) | |
| quarter = CharField(db_index=True, max_length=4) | 154 | 154 | quarter = CharField(db_index=True, max_length=4) | |
| 155 | 155 | |||
| @classmethod | 156 | 156 | @classmethod | |
| def search(cls, terms): | 157 | 157 | def search(cls, terms): | |
| """ | 158 | 158 | """ | |
| Search all fields of all sections for a particular set of terms | 159 | 159 | Search all fields of all sections for a particular set of terms | |
| A matching section must match at least one field on each term | 160 | 160 | A matching section must match at least one field on each term | |
| :param terms:iterable | 161 | 161 | :param terms:iterable | |
| :return: Matching QuerySet ordered by department and course number | 162 | 162 | :return: Matching QuerySet ordered by department and course number | |
| """ | 163 | 163 | """ | |
| final_q = Q() | 164 | 164 | final_q = Q() | |
| for term in terms: | 165 | 165 | for term in terms: | |
| q = Q(department__icontains=term) | 166 | 166 | q = Q(department__icontains=term) | |
| q |= Q(department_abbreviation__icontains=term) | 167 | 167 | q |= Q(department_abbreviation__icontains=term) | |
| q |= Q(course_title__icontains=term) | 168 | 168 | q |= Q(course_title__icontains=term) | |
| q |= Q(course_num__icontains=term) | 169 | 169 | q |= Q(course_num__icontains=term) | |
| q |= Q(instructor__icontains=term) | 170 | 170 | q |= Q(instructor__icontains=term) | |
| final_q &= q | 171 | 171 | final_q &= q | |
| qs = cls.objects.filter(final_q) | 172 | 172 | qs = cls.objects.filter(final_q) | |
| # Have the database cast the course number to an integer so it will sort properly | 173 | 173 | # Have the database cast the course number to an integer so it will sort properly | |
| # ECE 35 should rank before ECE 135 even though '135' < '35' lexicographically | 174 | 174 | # ECE 35 should rank before ECE 135 even though '135' < '35' lexicographically | |
| qs = qs.extra(select={'course_num_int': "CAST(rtrim(course_num, 'ABCDEFGHIJKLMNOPQRSTUVWXYZ') AS INTEGER)"}) | 175 | 175 | qs = qs.extra(select={'course_num_int': "CAST(rtrim(course_num, 'ABCDEFGHIJKLMNOPQRSTUVWXYZ') AS INTEGER)"}) | |
| qs = qs.order_by('department_abbreviation', 'course_num_int') | 176 | 176 | qs = qs.order_by('department_abbreviation', 'course_num_int') | |
| return qs | 177 | 177 | return qs | |
| 178 | 178 | |||
| def is_whitelisted(self): | 179 | 179 | def is_whitelisted(self): | |
| """ | 180 | 180 | """ | |
| :return: whether a whitelist exists for this section | 181 | 181 | :return: whether a whitelist exists for this section | |
| """ | 182 | 182 | """ | |
| return self.whitelist.exists() | 183 | 183 | return self.whitelist.exists() | |
| 184 | 184 | |||
| def is_user_on_whitelist(self, user): | 185 | 185 | def is_user_on_whitelist(self, user): | |
| """ | 186 | 186 | """ | |
| :return: whether the user is on the waitlist for this section | 187 | 187 | :return: whether the user is on the waitlist for this section | |
| """ | 188 | 188 | """ | |
| return self.whitelist.filter(email=user.email).exists() | 189 | 189 | return self.whitelist.filter(email=user.email).exists() | |
| 190 | 190 | |||
| class Meta: | 191 | 191 | class Meta: | |
| ordering = ['-course_title'] | 192 | 192 | ordering = ['-course_title'] | |
| 193 | 193 | |||
| 194 | @property | |||
| 195 | def long_name(self): | |||
| 196 | return '%s (%s)' % (self.course_title, self.instructor) | |||
| 197 | ||||
| 198 | @property | |||
| 199 | def short_name(self): | |||
| 200 | return '%s %s' % (self.department_abbreviation, self.course_num) | |||
| 201 |
flashcards/serializers.py
View file @
0794ea9
| from django.utils.datetime_safe import datetime | 1 | 1 | from django.utils.datetime_safe import datetime | |
| from django.utils.timezone import now | 2 | 2 | from django.utils.timezone import now | |
| import pytz | 3 | 3 | import pytz | |
| from flashcards.models import Section, LecturePeriod, User, Flashcard | 4 | 4 | from flashcards.models import Section, LecturePeriod, User, Flashcard | |
| from flashcards.validators import FlashcardMask, OverlapIntervalException | 5 | 5 | from flashcards.validators import FlashcardMask, OverlapIntervalException | |
| from rest_framework import serializers | 6 | 6 | from rest_framework import serializers | |
| from rest_framework.fields import EmailField, BooleanField, CharField, IntegerField, DateTimeField | 7 | 7 | from rest_framework.fields import EmailField, BooleanField, CharField, IntegerField, DateTimeField | |
| from rest_framework.relations import HyperlinkedRelatedField | 8 | 8 | from rest_framework.relations import HyperlinkedRelatedField | |
| from rest_framework.serializers import ModelSerializer, Serializer | 9 | 9 | from rest_framework.serializers import ModelSerializer, Serializer | |
| from rest_framework.validators import UniqueValidator | 10 | 10 | from rest_framework.validators import UniqueValidator | |
| from json import dumps, loads | 11 | 11 | from json import dumps, loads | |
| 12 | 12 | |||
| 13 | 13 | |||
| class EmailSerializer(Serializer): | 14 | 14 | class EmailSerializer(Serializer): | |
| email = EmailField(required=True) | 15 | 15 | email = EmailField(required=True) | |
| 16 | 16 | |||
| 17 | 17 | |||
| class EmailPasswordSerializer(EmailSerializer): | 18 | 18 | class EmailPasswordSerializer(EmailSerializer): | |
| password = CharField(required=True) | 19 | 19 | password = CharField(required=True) | |
| 20 | 20 | |||
| 21 | 21 | |||
| class RegistrationSerializer(EmailPasswordSerializer): | 22 | 22 | class RegistrationSerializer(EmailPasswordSerializer): | |
| email = EmailField(required=True, validators=[UniqueValidator(queryset=User.objects.all())]) | 23 | 23 | email = EmailField(required=True, validators=[UniqueValidator(queryset=User.objects.all())]) | |
| 24 | 24 | |||
| 25 | 25 | |||
| class PasswordResetRequestSerializer(EmailSerializer): | 26 | 26 | class PasswordResetRequestSerializer(EmailSerializer): | |
| def validate_email(self, value): | 27 | 27 | def validate_email(self, value): | |
| try: | 28 | 28 | try: | |
| User.objects.get(email=value) | 29 | 29 | User.objects.get(email=value) | |
| return value | 30 | 30 | return value | |
| except User.DoesNotExist: | 31 | 31 | except User.DoesNotExist: | |
| raise serializers.ValidationError('No user exists with that email') | 32 | 32 | raise serializers.ValidationError('No user exists with that email') | |
| 33 | 33 | |||
| 34 | 34 | |||
| class PasswordResetSerializer(Serializer): | 35 | 35 | class PasswordResetSerializer(Serializer): | |
| new_password = CharField(required=True, allow_blank=False) | 36 | 36 | new_password = CharField(required=True, allow_blank=False) | |
| uid = IntegerField(required=True) | 37 | 37 | uid = IntegerField(required=True) | |
| token = CharField(required=True) | 38 | 38 | token = CharField(required=True) | |
| 39 | 39 | |||
| def validate_uid(self, value): | 40 | 40 | def validate_uid(self, value): | |
| try: | 41 | 41 | try: | |
| User.objects.get(id=value) | 42 | 42 | User.objects.get(id=value) | |
| return value | 43 | 43 | return value | |
| except User.DoesNotExist: | 44 | 44 | except User.DoesNotExist: | |
| raise serializers.ValidationError('Could not verify reset token') | 45 | 45 | raise serializers.ValidationError('Could not verify reset token') | |
| 46 | 46 | |||
| 47 | 47 | |||
| class UserUpdateSerializer(Serializer): | 48 | 48 | class UserUpdateSerializer(Serializer): | |
| old_password = CharField(required=False) | 49 | 49 | old_password = CharField(required=False) | |
| new_password = CharField(required=False, allow_blank=False) | 50 | 50 | new_password = CharField(required=False, allow_blank=False) | |
| confirmation_key = CharField(required=False) | 51 | 51 | confirmation_key = CharField(required=False) | |
| # reset_token = CharField(required=False) | 52 | 52 | # reset_token = CharField(required=False) | |
| 53 | 53 | |||
| def validate(self, data): | 54 | 54 | def validate(self, data): | |
| if 'new_password' in data and 'old_password' not in data: | 55 | 55 | if 'new_password' in data and 'old_password' not in data: | |
| raise serializers.ValidationError('old_password is required to set a new_password') | 56 | 56 | raise serializers.ValidationError('old_password is required to set a new_password') | |
| return data | 57 | 57 | return data | |
| 58 | 58 | |||
| 59 | 59 | |||
| class Password(Serializer): | 60 | 60 | class Password(Serializer): | |
| email = EmailField(required=True) | 61 | 61 | email = EmailField(required=True) | |
| password = CharField(required=True) | 62 | 62 | password = CharField(required=True) | |
| 63 | 63 | |||
| 64 | 64 | |||
| class LecturePeriodSerializer(ModelSerializer): | 65 | 65 | class LecturePeriodSerializer(ModelSerializer): | |
| class Meta: | 66 | 66 | class Meta: | |
| model = LecturePeriod | 67 | 67 | model = LecturePeriod | |
| exclude = 'id', 'section' | 68 | 68 | exclude = 'id', 'section' | |
| 69 | 69 | |||
| 70 | 70 | |||
| class SectionSerializer(ModelSerializer): | 71 | 71 | class SectionSerializer(ModelSerializer): | |
| lectures = LecturePeriodSerializer(source='lectureperiod_set', many=True, read_only=True) | 72 | 72 | lectures = LecturePeriodSerializer(source='lectureperiod_set', many=True, read_only=True) | |
| 73 | short_name = CharField() | |||
| 74 | long_name = CharField() | |||
| 73 | 75 | |||
| class Meta: | 74 | 76 | class Meta: | |
| model = Section | 75 | 77 | model = Section | |
| 76 | 78 | |||
| 77 | 79 | |||
| class UserSerializer(ModelSerializer): | 78 | 80 | class UserSerializer(ModelSerializer): | |
| email = EmailField(required=False) | 79 | 81 | email = EmailField(required=False) | |
| sections = HyperlinkedRelatedField(queryset=Section.objects.all(), many=True, view_name='section-detail') | 80 | 82 | sections = HyperlinkedRelatedField(queryset=Section.objects.all(), many=True, view_name='section-detail') | |
| is_confirmed = BooleanField() | 81 | 83 | is_confirmed = BooleanField() | |
| 82 | 84 | |||
| class Meta: | 83 | 85 | class Meta: | |
| model = User | 84 | 86 | model = User | |
| fields = ("sections", "email", "is_confirmed", "last_login", "date_joined") | 85 | 87 | fields = ("sections", "email", "is_confirmed", "last_login", "date_joined") | |
| 86 | 88 | |||
| 87 | 89 | |||
| class MaskFieldSerializer(serializers.Field): | 88 | 90 | class MaskFieldSerializer(serializers.Field): | |
| default_error_messages = { | 89 | 91 | default_error_messages = { | |
| 'max_length': 'Ensure this field has no more than {max_length} characters.', | 90 | 92 | 'max_length': 'Ensure this field has no more than {max_length} characters.', | |
| 'interval': 'Ensure this field has valid intervals.', | 91 | 93 | 'interval': 'Ensure this field has valid intervals.', | |
| 'overlap': 'Ensure this field does not have overlapping intervals.' | 92 | 94 | 'overlap': 'Ensure this field does not have overlapping intervals.' | |
| } | 93 | 95 | } | |
| 94 | 96 | |||
| def to_representation(self, value): | 95 | 97 | def to_representation(self, value): | |
| return dumps(list(self._make_mask(value))) | 96 | 98 | return dumps(list(self._make_mask(value))) | |
| 97 | 99 | |||
| def to_internal_value(self, value): | 98 | 100 | def to_internal_value(self, value): | |
| return self._make_mask(loads(value)) | 99 | 101 | return self._make_mask(loads(value)) | |
| 100 | 102 | |||
| def _make_mask(self, data): | 101 | 103 | def _make_mask(self, data): | |
| try: | 102 | 104 | try: | |
| mask = FlashcardMask(data) | 103 | 105 | mask = FlashcardMask(data) | |
| except ValueError: | 104 | 106 | except ValueError: | |
| raise serializers.ValidationError("Invalid JSON for MaskField") | 105 | 107 | raise serializers.ValidationError("Invalid JSON for MaskField") | |
| except TypeError: | 106 | 108 | except TypeError: | |
| raise serializers.ValidationError("Invalid data for MaskField.") | 107 | 109 | raise serializers.ValidationError("Invalid data for MaskField.") | |
| except OverlapIntervalException: | 108 | 110 | except OverlapIntervalException: | |
| raise serializers.ValidationError("Invalid intervals for MaskField data.") | 109 | 111 | raise serializers.ValidationError("Invalid intervals for MaskField data.") | |
| if len(mask) > 32: | 110 | 112 | if len(mask) > 32: | |
| raise serializers.ValidationError("Too many intervals in the mask.") | 111 | 113 | raise serializers.ValidationError("Too many intervals in the mask.") | |
| return mask | 112 | 114 | return mask | |
| 113 | 115 | |||
| 114 | 116 | |||
| class FlashcardSerializer(ModelSerializer): | 115 | 117 | class FlashcardSerializer(ModelSerializer): | |
| is_hidden = BooleanField(read_only=True) | 116 | 118 | is_hidden = BooleanField(read_only=True) | |
| hide_reason = CharField(read_only=True) | 117 | 119 | hide_reason = CharField(read_only=True) | |
| material_date = DateTimeField(default=now) | 118 | 120 | material_date = DateTimeField(default=now) |
flashcards/views.py
View file @
0794ea9
| from django.contrib import auth | 1 | 1 | from django.contrib import auth | |
| from django.db.models import Q | 2 | 2 | from django.db.models import Q | |
| from flashcards.api import StandardResultsSetPagination | 3 | 3 | from flashcards.api import StandardResultsSetPagination | |
| from flashcards.models import Section, User, Flashcard, FlashcardReport, UserFlashcard | 4 | 4 | from flashcards.models import Section, User, Flashcard, FlashcardReport, UserFlashcard | |
| from flashcards.serializers import SectionSerializer, UserUpdateSerializer, RegistrationSerializer, UserSerializer, \ | 5 | 5 | from flashcards.serializers import SectionSerializer, UserUpdateSerializer, RegistrationSerializer, UserSerializer, \ | |
| PasswordResetSerializer, PasswordResetRequestSerializer, EmailPasswordSerializer, FlashcardSerializer | 6 | 6 | PasswordResetSerializer, PasswordResetRequestSerializer, EmailPasswordSerializer, FlashcardSerializer | |
| from rest_framework.decorators import detail_route, permission_classes, api_view, list_route | 7 | 7 | from rest_framework.decorators import detail_route, permission_classes, api_view, list_route | |
| from rest_framework.generics import ListAPIView, GenericAPIView | 8 | 8 | from rest_framework.generics import ListAPIView, GenericAPIView | |
| from rest_framework.mixins import CreateModelMixin, RetrieveModelMixin | 9 | 9 | from rest_framework.mixins import CreateModelMixin, RetrieveModelMixin | |
| from rest_framework.permissions import IsAuthenticated | 10 | 10 | from rest_framework.permissions import IsAuthenticated | |
| from rest_framework.viewsets import ReadOnlyModelViewSet, GenericViewSet | 11 | 11 | from rest_framework.viewsets import ReadOnlyModelViewSet, GenericViewSet | |
| from django.core.mail import send_mail | 12 | 12 | from django.core.mail import send_mail | |
| from django.contrib.auth import authenticate | 13 | 13 | from django.contrib.auth import authenticate | |
| from django.contrib.auth.tokens import default_token_generator | 14 | 14 | from django.contrib.auth.tokens import default_token_generator | |
| from rest_framework.status import HTTP_204_NO_CONTENT, HTTP_201_CREATED | 15 | 15 | from rest_framework.status import HTTP_204_NO_CONTENT, HTTP_201_CREATED | |
| from rest_framework.response import Response | 16 | 16 | from rest_framework.response import Response | |
| from rest_framework.exceptions import AuthenticationFailed, NotAuthenticated, ValidationError, PermissionDenied | 17 | 17 | from rest_framework.exceptions import AuthenticationFailed, NotAuthenticated, ValidationError, PermissionDenied | |
| from simple_email_confirmation import EmailAddress | 18 | 18 | from simple_email_confirmation import EmailAddress | |
| 19 | 19 | |||
| 20 | 20 | |||
| class SectionViewSet(ReadOnlyModelViewSet): | 21 | 21 | class SectionViewSet(ReadOnlyModelViewSet): | |
| queryset = Section.objects.all() | 22 | 22 | queryset = Section.objects.all() | |
| serializer_class = SectionSerializer | 23 | 23 | serializer_class = SectionSerializer | |
| pagination_class = StandardResultsSetPagination | 24 | 24 | pagination_class = StandardResultsSetPagination | |
| permission_classes = [IsAuthenticated] | 25 | 25 | permission_classes = [IsAuthenticated] | |
| 26 | 26 | |||
| @detail_route(methods=['get'], permission_classes=[IsAuthenticated]) | 27 | 27 | @detail_route(methods=['get'], permission_classes=[IsAuthenticated]) | |
| def flashcards(self, request, pk): | 28 | 28 | def flashcards(self, request, pk): | |
| """ | 29 | 29 | """ | |
| Gets flashcards for a section, excluding hidden cards. | 30 | 30 | Gets flashcards for a section, excluding hidden cards. | |
| Returned in strictly chronological order (material date). | 31 | 31 | Returned in strictly chronological order (material date). | |
| """ | 32 | 32 | """ | |
| flashcards = Flashcard.cards_visible_to(request.user).filter( \ | 33 | 33 | flashcards = Flashcard.cards_visible_to(request.user).filter( \ | |
| section=self.get_object(), is_hidden=False).all() | 34 | 34 | section=self.get_object(), is_hidden=False).all() | |
| 35 | 35 | |||
| return Response(FlashcardSerializer(flashcards, many=True).data) | 36 | 36 | return Response(FlashcardSerializer(flashcards, many=True).data) | |
| 37 | 37 | |||
| @detail_route(methods=['post'], permission_classes=[IsAuthenticated]) | 38 | 38 | @detail_route(methods=['post'], permission_classes=[IsAuthenticated]) | |
| def enroll(self, request, pk): | 39 | 39 | def enroll(self, request, pk): | |
| """ | 40 | 40 | """ | |
| Add the current user to a specified section | 41 | 41 | Add the current user to a specified section | |
| If the class has a whitelist, but the user is not on the whitelist, the request will fail. | 42 | 42 | If the class has a whitelist, but the user is not on the whitelist, the request will fail. | |
| --- | 43 | 43 | --- | |
| omit_serializer: true | 44 | 44 | omit_serializer: true | |
| parameters: | 45 | 45 | parameters: | |
| - fake: None | 46 | 46 | - fake: None | |
| parameters_strategy: | 47 | 47 | parameters_strategy: | |
| form: replace | 48 | 48 | form: replace | |
| """ | 49 | 49 | """ | |
| section = self.get_object() | 50 | 50 | section = self.get_object() | |
| if request.user.sections.filter(pk=section.pk).exists(): | 51 | 51 | if request.user.sections.filter(pk=section.pk).exists(): | |
| raise ValidationError("You are already in this section.") | 52 | 52 | raise ValidationError("You are already in this section.") | |
| if section.is_whitelisted() and not section.is_user_on_whitelist(request.user): | 53 | 53 | if section.is_whitelisted() and not section.is_user_on_whitelist(request.user): | |
| raise PermissionDenied("You must be on the whitelist to add this section.") | 54 | 54 | raise PermissionDenied("You must be on the whitelist to add this section.") | |
| request.user.sections.add(section) | 55 | 55 | request.user.sections.add(section) | |
| return Response(status=HTTP_204_NO_CONTENT) | 56 | 56 | return Response(status=HTTP_204_NO_CONTENT) | |
| 57 | 57 | |||
| @detail_route(methods=['post'], permission_classes=[IsAuthenticated]) | 58 | 58 | @detail_route(methods=['post'], permission_classes=[IsAuthenticated]) | |
| def drop(self, request, pk): | 59 | 59 | def drop(self, request, pk): | |
| """ | 60 | 60 | """ | |
| Remove the current user from a specified section | 61 | 61 | Remove the current user from a specified section | |
| If the user is not in the class, the request will fail. | 62 | 62 | If the user is not in the class, the request will fail. | |
| --- | 63 | 63 | --- | |
| omit_serializer: true | 64 | 64 | omit_serializer: true | |
| parameters: | 65 | 65 | parameters: | |
| - fake: None | 66 | 66 | - fake: None | |
| parameters_strategy: | 67 | 67 | parameters_strategy: | |
| form: replace | 68 | 68 | form: replace | |
| """ | 69 | 69 | """ | |
| section = self.get_object() | 70 | 70 | section = self.get_object() | |
| if not section.user_set.filter(pk=request.user.pk).exists(): | 71 | 71 | if not section.user_set.filter(pk=request.user.pk).exists(): | |
| raise ValidationError("You are not in the section.") | 72 | 72 | raise ValidationError("You are not in the section.") | |
| section.user_set.remove(request.user) | 73 | 73 | section.user_set.remove(request.user) | |
| return Response(status=HTTP_204_NO_CONTENT) | 74 | 74 | return Response(status=HTTP_204_NO_CONTENT) | |
| 75 | 75 | |||
| @list_route(methods=['get'], permission_classes=[IsAuthenticated]) | 76 | 76 | @list_route(methods=['get'], permission_classes=[IsAuthenticated]) | |
| def search(self, request): | 77 | 77 | def search(self, request): | |
| query = request.GET.get('q',None) | 78 | 78 | query = request.GET.get('q',None) | |
| if not query: return Response('[]') | 79 | 79 | if not query: return Response('[]') | |
| qs = Section.search(query.split(' '))[:5] | 80 | 80 | qs = Section.search(query.split(' '))[:20] | |
| serializer = SectionSerializer(qs, many=True) | 81 | 81 | serializer = SectionSerializer(qs, many=True) | |
| return Response(serializer.data) | 82 | 82 | return Response(serializer.data) | |
| 83 | 83 | |||
| 84 | 84 | |||
| class UserSectionListView(ListAPIView): | 85 | 85 | class UserSectionListView(ListAPIView): | |
| serializer_class = SectionSerializer | 86 | 86 | serializer_class = SectionSerializer | |
| permission_classes = [IsAuthenticated] | 87 | 87 | permission_classes = [IsAuthenticated] | |
| 88 | 88 | |||
| def get_queryset(self): | 89 | 89 | def get_queryset(self): | |
| return self.request.user.sections.all() | 90 | 90 | return self.request.user.sections.all() | |
| 91 | 91 | |||
| def paginate_queryset(self, queryset): return None | 92 | 92 | def paginate_queryset(self, queryset): return None | |
| 93 | 93 | |||
| 94 | 94 | |||
| class UserDetail(GenericAPIView): | 95 | 95 | class UserDetail(GenericAPIView): | |
| serializer_class = UserSerializer | 96 | 96 | serializer_class = UserSerializer | |
| permission_classes = [IsAuthenticated] | 97 | 97 | permission_classes = [IsAuthenticated] | |
| 98 | 98 | |||
| def get_queryset(self): | 99 | 99 | def get_queryset(self): | |
| return User.objects.all() | 100 | 100 | return User.objects.all() | |
| 101 | 101 | |||
| def patch(self, request, format=None): | 102 | 102 | def patch(self, request, format=None): | |
| """ | 103 | 103 | """ | |
| Updates the user's password, or verifies their email address | 104 | 104 | Updates the user's password, or verifies their email address | |
| --- | 105 | 105 | --- | |
| request_serializer: UserUpdateSerializer | 106 | 106 | request_serializer: UserUpdateSerializer | |
| response_serializer: UserSerializer | 107 | 107 | response_serializer: UserSerializer | |
| """ | 108 | 108 | """ | |
| data = UserUpdateSerializer(data=request.data, context={'user': request.user}) | 109 | 109 | data = UserUpdateSerializer(data=request.data, context={'user': request.user}) | |
| data.is_valid(raise_exception=True) | 110 | 110 | data.is_valid(raise_exception=True) | |
| data = data.validated_data | 111 | 111 | data = data.validated_data | |
| 112 | 112 | |||
| if 'new_password' in data: | 113 | 113 | if 'new_password' in data: | |
| if not request.user.check_password(data['old_password']): | 114 | 114 | if not request.user.check_password(data['old_password']): | |
| raise ValidationError('old_password is incorrect') | 115 | 115 | raise ValidationError('old_password is incorrect') | |
| request.user.set_password(data['new_password']) | 116 | 116 | request.user.set_password(data['new_password']) | |
| request.user.save() | 117 | 117 | request.user.save() | |
| 118 | 118 | |||
| if 'confirmation_key' in data: | 119 | 119 | if 'confirmation_key' in data: | |
| try: | 120 | 120 | try: | |
| request.user.confirm_email(data['confirmation_key']) | 121 | 121 | request.user.confirm_email(data['confirmation_key']) | |
| except EmailAddress.DoesNotExist: | 122 | 122 | except EmailAddress.DoesNotExist: | |
| raise ValidationError('confirmation_key is invalid') | 123 | 123 | raise ValidationError('confirmation_key is invalid') | |
| 124 | 124 | |||
| return Response(UserSerializer(request.user).data) | 125 | 125 | return Response(UserSerializer(request.user).data) | |
| 126 | 126 | |||
| def get(self, request, format=None): | 127 | 127 | def get(self, request, format=None): | |
| """ | 128 | 128 | """ | |
| Return data about the user | 129 | 129 | Return data about the user | |
| --- | 130 | 130 | --- | |
| response_serializer: UserSerializer | 131 | 131 | response_serializer: UserSerializer | |
| """ | 132 | 132 | """ | |
| serializer = UserSerializer(request.user, context={'request': request}) | 133 | 133 | serializer = UserSerializer(request.user, context={'request': request}) | |
| return Response(serializer.data) | 134 | 134 | return Response(serializer.data) | |
| 135 | 135 | |||
| def delete(self, request): | 136 | 136 | def delete(self, request): | |
| """ | 137 | 137 | """ | |
| Irrevocably delete the user and their data | 138 | 138 | Irrevocably delete the user and their data | |
| 139 | 139 | |||
| Yes, really | 140 | 140 | Yes, really | |
| """ | 141 | 141 | """ | |
| request.user.delete() | 142 | 142 | request.user.delete() | |
| return Response(status=HTTP_204_NO_CONTENT) | 143 | 143 | return Response(status=HTTP_204_NO_CONTENT) | |
| 144 | 144 | |||
| 145 | 145 | |||
| @api_view(['POST']) | 146 | 146 | @api_view(['POST']) | |
| def register(request, format=None): | 147 | 147 | def register(request, format=None): | |
| """ | 148 | 148 | """ | |
| Register a new user | 149 | 149 | Register a new user | |
| --- | 150 | 150 | --- | |
| request_serializer: EmailPasswordSerializer | 151 | 151 | request_serializer: EmailPasswordSerializer | |
| response_serializer: UserSerializer | 152 | 152 | response_serializer: UserSerializer | |
| """ | 153 | 153 | """ | |
| data = RegistrationSerializer(data=request.data) | 154 | 154 | data = RegistrationSerializer(data=request.data) | |
| data.is_valid(raise_exception=True) | 155 | 155 | data.is_valid(raise_exception=True) | |
| 156 | 156 | |||
| User.objects.create_user(**data.validated_data) | 157 | 157 | User.objects.create_user(**data.validated_data) | |
| user = authenticate(**data.validated_data) | 158 | 158 | user = authenticate(**data.validated_data) | |
| auth.login(request, user) | 159 | 159 | auth.login(request, user) | |
| 160 | 160 | |||
| body = ''' | 161 | 161 | body = ''' | |
| Visit the following link to confirm your email address: | 162 | 162 | Visit the following link to confirm your email address: | |
| https://flashy.cards/app/verify_email/%s | 163 | 163 | https://flashy.cards/app/verify_email/%s | |
| 164 | 164 | |||
| If you did not register for Flashy, no action is required. | 165 | 165 | If you did not register for Flashy, no action is required. | |
| ''' | 166 | 166 | ''' | |
| 167 | 167 | |||
| assert send_mail("Flashy email verification", | 168 | 168 | assert send_mail("Flashy email verification", | |
| body % user.confirmation_key, | 169 | 169 | body % user.confirmation_key, | |
| "noreply@flashy.cards", | 170 | 170 | "noreply@flashy.cards", | |
| [user.email]) | 171 | 171 | [user.email]) | |
| 172 | 172 | |||
| return Response(UserSerializer(request.user).data, status=HTTP_201_CREATED) | 173 | 173 | return Response(UserSerializer(request.user).data, status=HTTP_201_CREATED) | |
| 174 | 174 | |||
| 175 | 175 | |||
| @api_view(['POST']) | 176 | 176 | @api_view(['POST']) | |
| def login(request): | 177 | 177 | def login(request): | |
| """ | 178 | 178 | """ | |
| Authenticates user and returns user data if valid. | 179 | 179 | Authenticates user and returns user data if valid. | |
| --- | 180 | 180 | --- | |
| request_serializer: EmailPasswordSerializer | 181 | 181 | request_serializer: EmailPasswordSerializer | |
| response_serializer: UserSerializer | 182 | 182 | response_serializer: UserSerializer | |
| """ | 183 | 183 | """ | |
| 184 | 184 | |||
| data = EmailPasswordSerializer(data=request.data) | 185 | 185 | data = EmailPasswordSerializer(data=request.data) | |
| data.is_valid(raise_exception=True) | 186 | 186 | data.is_valid(raise_exception=True) | |
| user = authenticate(**data.validated_data) | 187 | 187 | user = authenticate(**data.validated_data) | |
| 188 | 188 | |||
| if user is None: | 189 | 189 | if user is None: | |
| raise AuthenticationFailed('Invalid email or password') | 190 | 190 | raise AuthenticationFailed('Invalid email or password') | |
| if not user.is_active: | 191 | 191 | if not user.is_active: | |
| raise NotAuthenticated('Account is disabled') | 192 | 192 | raise NotAuthenticated('Account is disabled') | |
| auth.login(request, user) | 193 | 193 | auth.login(request, user) | |
| return Response(UserSerializer(request.user).data) | 194 | 194 | return Response(UserSerializer(request.user).data) | |
| 195 | 195 | |||
| 196 | 196 | |||
| @api_view(['POST']) | 197 | 197 | @api_view(['POST']) | |
| @permission_classes((IsAuthenticated, )) | 198 | 198 | @permission_classes((IsAuthenticated, )) | |
| def logout(request, format=None): | 199 | 199 | def logout(request, format=None): | |
| """ | 200 | 200 | """ | |
| Logs the authenticated user out. | 201 | 201 | Logs the authenticated user out. | |
| """ | 202 | 202 | """ | |
| auth.logout(request) | 203 | 203 | auth.logout(request) | |
| return Response(status=HTTP_204_NO_CONTENT) | 204 | 204 | return Response(status=HTTP_204_NO_CONTENT) | |
| 205 | 205 | |||
| 206 | 206 | |||
| @api_view(['POST']) | 207 | 207 | @api_view(['POST']) | |
| def request_password_reset(request, format=None): | 208 | 208 | def request_password_reset(request, format=None): | |
| """ | 209 | 209 | """ | |
| Send a password reset token/link to the provided email. | 210 | 210 | Send a password reset token/link to the provided email. | |
| --- | 211 | 211 | --- | |
| request_serializer: PasswordResetRequestSerializer | 212 | 212 | request_serializer: PasswordResetRequestSerializer | |
| """ | 213 | 213 | """ | |
| data = PasswordResetRequestSerializer(data=request.data) | 214 | 214 | data = PasswordResetRequestSerializer(data=request.data) | |
| data.is_valid(raise_exception=True) | 215 | 215 | data.is_valid(raise_exception=True) | |
| user = User.objects.get(email=data['email'].value) | 216 | 216 | user = User.objects.get(email=data['email'].value) | |
| token = default_token_generator.make_token(user) | 217 | 217 | token = default_token_generator.make_token(user) | |
| 218 | 218 | |||
| body = ''' | 219 | 219 | body = ''' | |
| Visit the following link to reset your password: | 220 | 220 | Visit the following link to reset your password: | |
| https://flashy.cards/app/reset_password/%d/%s | 221 | 221 | https://flashy.cards/app/reset_password/%d/%s | |
| 222 | 222 | |||
| If you did not request a password reset, no action is required. | 223 | 223 | If you did not request a password reset, no action is required. | |
| ''' | 224 | 224 | ''' | |
| 225 | 225 | |||
| send_mail("Flashy password reset", | 226 | 226 | send_mail("Flashy password reset", | |
| body % (user.pk, token), | 227 | 227 | body % (user.pk, token), | |
| "noreply@flashy.cards", | 228 | 228 | "noreply@flashy.cards", | |
| [user.email]) | 229 | 229 | [user.email]) | |
| 230 | 230 | |||
| return Response(status=HTTP_204_NO_CONTENT) | 231 | 231 | return Response(status=HTTP_204_NO_CONTENT) | |
| 232 | 232 | |||
| 233 | 233 | |||
| @api_view(['POST']) | 234 | 234 | @api_view(['POST']) | |
| def reset_password(request, format=None): | 235 | 235 | def reset_password(request, format=None): | |
| """ | 236 | 236 | """ | |
| Updates user's password to new password if token is valid. | 237 | 237 | Updates user's password to new password if token is valid. | |
| --- | 238 | 238 | --- | |
| request_serializer: PasswordResetSerializer | 239 | 239 | request_serializer: PasswordResetSerializer | |
| """ | 240 | 240 | """ | |
| data = PasswordResetSerializer(data=request.data) | 241 | 241 | data = PasswordResetSerializer(data=request.data) | |
| data.is_valid(raise_exception=True) | 242 | 242 | data.is_valid(raise_exception=True) | |
| 243 | 243 | |||
| user = User.objects.get(id=data['uid'].value) | 244 | 244 | user = User.objects.get(id=data['uid'].value) | |
| # Check token validity. | 245 | 245 | # Check token validity. | |
| 246 | 246 | |||
| if default_token_generator.check_token(user, data['token'].value): | 247 | 247 | if default_token_generator.check_token(user, data['token'].value): | |
| user.set_password(data['new_password'].value) | 248 | 248 | user.set_password(data['new_password'].value) | |
| user.save() | 249 | 249 | user.save() |