0870e1a758
* feat: added apis for discussions tours * fix: resolved linter issues * feat: moved config list to settings and fixed unit tests * refactor: merged migrations in 1 file
42 lines
1.3 KiB
Python
42 lines
1.3 KiB
Python
""" Models for the User Tour Experience. """
|
|
|
|
from django.contrib.auth import get_user_model
|
|
from django.db import models
|
|
from django.utils.translation import gettext_lazy as _
|
|
|
|
User = get_user_model()
|
|
|
|
|
|
class UserTour(models.Model):
|
|
"""
|
|
Model to track which tours a user needs to be shown.
|
|
|
|
Note: This does not track which tours a user has seen, only the ones they should.
|
|
|
|
.. no_pii:
|
|
"""
|
|
class CourseHomeChoices(models.TextChoices):
|
|
EXISTING_USER_TOUR = 'show-existing-user-tour', _('Show existing user tour')
|
|
NEW_USER_TOUR = 'show-new-user-tour', _('Show new user tour')
|
|
NO_TOUR = 'no-tour', _('Do not show user tour')
|
|
|
|
course_home_tour_status = models.CharField(
|
|
max_length=50, choices=CourseHomeChoices.choices, default=CourseHomeChoices.NEW_USER_TOUR
|
|
)
|
|
show_courseware_tour = models.BooleanField(default=True)
|
|
user = models.OneToOneField(User, related_name='tour', on_delete=models.CASCADE)
|
|
|
|
|
|
class UserDiscussionsTours(models.Model):
|
|
"""
|
|
Model to track which discussions tours a user has seen.
|
|
"""
|
|
tour_name = models.CharField(max_length=255)
|
|
show_tour = models.BooleanField(default=True)
|
|
user = models.ForeignKey(User, on_delete=models.CASCADE)
|
|
|
|
class Meta:
|
|
indexes = [
|
|
models.Index(fields=['user', 'tour_name']),
|
|
]
|