6d380fc5a2
With this change, whenever a IntegritySignature is created or retrieved, the result will be cached into mem cache for future use. This will save round trip to database significantly for honor code check
90 lines
2.7 KiB
Python
90 lines
2.7 KiB
Python
"""
|
|
Agreements API
|
|
"""
|
|
|
|
import logging
|
|
|
|
from django.contrib.auth import get_user_model
|
|
from django.core.cache import cache
|
|
from django.core.exceptions import ObjectDoesNotExist
|
|
from opaque_keys.edx.keys import CourseKey
|
|
|
|
from openedx.core.djangoapps.agreements.cache import get_integrity_signature_cache_key
|
|
from openedx.core.djangoapps.agreements.models import IntegritySignature
|
|
|
|
log = logging.getLogger(__name__)
|
|
User = get_user_model()
|
|
|
|
|
|
def create_integrity_signature(username, course_id):
|
|
"""
|
|
Create an integrity signature. If a signature already exists, do not create a new one.
|
|
|
|
Arguments:
|
|
* username (str)
|
|
* course_id (str)
|
|
|
|
Returns:
|
|
* IntegritySignature object
|
|
"""
|
|
user = User.objects.get(username=username)
|
|
course_key = CourseKey.from_string(course_id)
|
|
signature, created = IntegritySignature.objects.get_or_create(user=user, course_key=course_key)
|
|
if not created:
|
|
log.warning(
|
|
'Integrity signature already exists for user_id={user_id} and '
|
|
'course_id={course_id}'.format(user_id=user.id, course_id=course_id)
|
|
)
|
|
cache_key = get_integrity_signature_cache_key(username, course_id)
|
|
# Write into the cache for future retrieval
|
|
cache.set(cache_key, signature)
|
|
return signature
|
|
|
|
|
|
def get_integrity_signature(username, course_id):
|
|
"""
|
|
Get an integrity signature.
|
|
|
|
Arguments:
|
|
* username (str)
|
|
* course_id (str)
|
|
|
|
Returns:
|
|
* An IntegritySignature object, or None if one does not exist for the
|
|
user + course combination.
|
|
"""
|
|
cache_key = get_integrity_signature_cache_key(username, course_id)
|
|
cached_integrity_signature = cache.get(cache_key)
|
|
if cached_integrity_signature:
|
|
return cached_integrity_signature
|
|
|
|
user = User.objects.get(username=username)
|
|
course_key = CourseKey.from_string(course_id)
|
|
try:
|
|
signature = IntegritySignature.objects.get(user=user, course_key=course_key)
|
|
cache.set(cache_key, signature)
|
|
return signature
|
|
except ObjectDoesNotExist:
|
|
return None
|
|
|
|
|
|
def get_integrity_signatures_for_course(course_id):
|
|
"""
|
|
Get all integrity signatures for a given course.
|
|
|
|
Arguments:
|
|
* course_id (str)
|
|
|
|
Returns:
|
|
* QuerySet of IntegritySignature objects (can be empty).
|
|
"""
|
|
|
|
course_key = CourseKey.from_string(course_id)
|
|
course_integrity_signature = IntegritySignature.objects.filter(
|
|
course_key=course_key
|
|
).select_related('user')
|
|
for signature in course_integrity_signature:
|
|
cache_key = get_integrity_signature_cache_key(signature.user.username, course_id)
|
|
cache.set(cache_key, signature)
|
|
return course_integrity_signature
|