e2bfcf2a36
This commit updates common/djangoapps. These keys are now objects with a limited interface, and the particular internal representation is managed by the data storage layer (the modulestore). For the LMS, there should be no outward-facing changes to the system. The keys are, for now, a change to internal representation only. For Studio, the new serialized form of the keys is used in urls, to allow for further migration in the future. Co-Author: Andy Armstrong <andya@edx.org> Co-Author: Christina Roberts <christina@edx.org> Co-Author: David Baumgold <db@edx.org> Co-Author: Diana Huang <dkh@edx.org> Co-Author: Don Mitchell <dmitchell@edx.org> Co-Author: Julia Hansbrough <julia@edx.org> Co-Author: Nimisha Asthagiri <nasthagiri@edx.org> Co-Author: Sarina Canelake <sarina@edx.org> [LMS-2370]
54 lines
1.9 KiB
Python
54 lines
1.9 KiB
Python
from django.contrib.auth.models import User
|
|
from django.core.validators import RegexValidator
|
|
from django.db import models
|
|
|
|
from xmodule_django.models import CourseKeyField
|
|
|
|
|
|
class UserPreference(models.Model):
|
|
"""A user's preference, stored as generic text to be processed by client"""
|
|
KEY_REGEX = r"[-_a-zA-Z0-9]+"
|
|
user = models.ForeignKey(User, db_index=True, related_name="preferences")
|
|
key = models.CharField(max_length=255, db_index=True, validators=[RegexValidator(KEY_REGEX)])
|
|
value = models.TextField()
|
|
|
|
class Meta: # pylint: disable=missing-docstring
|
|
unique_together = ("user", "key")
|
|
|
|
@classmethod
|
|
def set_preference(cls, user, preference_key, preference_value):
|
|
"""
|
|
Sets the user preference for a given key
|
|
"""
|
|
user_pref, _ = cls.objects.get_or_create(user=user, key=preference_key)
|
|
user_pref.value = preference_value
|
|
user_pref.save()
|
|
|
|
@classmethod
|
|
def get_preference(cls, user, preference_key, default=None):
|
|
"""
|
|
Gets the user preference value for a given key
|
|
|
|
Returns the given default if there isn't a preference for the given key
|
|
"""
|
|
|
|
try:
|
|
user_pref = cls.objects.get(user=user, key=preference_key)
|
|
return user_pref.value
|
|
except cls.DoesNotExist:
|
|
return default
|
|
|
|
|
|
class UserCourseTag(models.Model):
|
|
"""
|
|
Per-course user tags, to be used by various things that want to store tags about
|
|
the user. Added initially to store assignment to experimental groups.
|
|
"""
|
|
user = models.ForeignKey(User, db_index=True, related_name="+")
|
|
key = models.CharField(max_length=255, db_index=True)
|
|
course_id = CourseKeyField(max_length=255, db_index=True)
|
|
value = models.TextField()
|
|
|
|
class Meta: # pylint: disable=missing-docstring
|
|
unique_together = ("user", "course_id", "key")
|