575e240961
* feat: add idv events to api - moved what was in signals.py to a handlers.py (which is what their file should have been called) * chore: quality * fix: rename test file + imports * fix: change handler reverse url in other tests * fix: refactor signals and handlers pattern - following OEP-49 pattern for signals directory - user removed as param for update function - event now emitted after save * fix: unpin edx-name-affirmation * chore: add init to signals dir * fix: compile requirements * chore: quality * chore: fix some imports * chore: quality * test: added signal emissions to test_api * chore: lint
84 lines
3.1 KiB
Python
84 lines
3.1 KiB
Python
"""
|
|
Signal handler for setting default course verification dates
|
|
"""
|
|
import logging
|
|
|
|
from django.core.exceptions import ObjectDoesNotExist
|
|
from django.db.models.signals import post_save
|
|
from django.dispatch.dispatcher import receiver
|
|
from xmodule.modulestore.django import SignalHandler, modulestore
|
|
|
|
from common.djangoapps.student.models_api import get_name, get_pending_name_change
|
|
from lms.djangoapps.verify_student.apps import VerifyStudentConfig # pylint: disable=unused-import
|
|
from lms.djangoapps.verify_student.signals.signals import idv_update_signal
|
|
from openedx.core.djangoapps.user_api.accounts.signals import USER_RETIRE_LMS_CRITICAL, USER_RETIRE_LMS_MISC
|
|
|
|
from lms.djangoapps.verify_student.models import (
|
|
SoftwareSecurePhotoVerification,
|
|
VerificationDeadline,
|
|
VerificationAttempt
|
|
)
|
|
|
|
log = logging.getLogger(__name__)
|
|
|
|
|
|
@receiver(SignalHandler.course_published)
|
|
def _listen_for_course_publish(sender, course_key, **kwargs): # pylint: disable=unused-argument
|
|
"""
|
|
Catches the signal that a course has been published in Studio and
|
|
sets the verification deadline date to a default.
|
|
"""
|
|
course = modulestore().get_course(course_key)
|
|
if course:
|
|
try:
|
|
deadline = VerificationDeadline.objects.get(course_key=course_key)
|
|
if not deadline.deadline_is_explicit and deadline.deadline != course.end:
|
|
VerificationDeadline.set_deadline(course_key, course.end)
|
|
except ObjectDoesNotExist:
|
|
VerificationDeadline.set_deadline(course_key, course.end)
|
|
|
|
|
|
@receiver(USER_RETIRE_LMS_CRITICAL)
|
|
def _listen_for_lms_retire(sender, **kwargs): # pylint: disable=unused-argument
|
|
user = kwargs.get('user')
|
|
SoftwareSecurePhotoVerification.retire_user(user.id)
|
|
|
|
|
|
@receiver(post_save, sender=SoftwareSecurePhotoVerification)
|
|
def send_idv_update(sender, instance, **kwargs): # pylint: disable=unused-argument
|
|
"""
|
|
Catches the post save signal from the SoftwareSecurePhotoVerification model, and emits
|
|
another signal with limited information from the model. We are choosing to re-emit a signal
|
|
as opposed to relying only on the post_save signal to avoid the chance that other apps
|
|
import the SoftwareSecurePhotoVerification model.
|
|
"""
|
|
# Prioritize pending name change over current profile name, if the user has one
|
|
pending_name_change = get_pending_name_change(instance.user)
|
|
if pending_name_change:
|
|
full_name = pending_name_change.new_name
|
|
else:
|
|
full_name = get_name(instance.user.id)
|
|
|
|
log.info(
|
|
'IDV sending name_affirmation task (idv_id={idv_id}, user_id={user_id}) to update status={status}'.format(
|
|
user_id=instance.user.id,
|
|
status=instance.status,
|
|
idv_id=instance.id
|
|
)
|
|
)
|
|
|
|
idv_update_signal.send(
|
|
sender='idv_update',
|
|
attempt_id=instance.id,
|
|
user_id=instance.user.id,
|
|
status=instance.status,
|
|
photo_id_name=instance.name,
|
|
full_name=full_name
|
|
)
|
|
|
|
|
|
@receiver(USER_RETIRE_LMS_MISC)
|
|
def _listen_for_lms_retire_verification_attempts(sender, **kwargs): # pylint: disable=unused-argument
|
|
user = kwargs.get('user')
|
|
VerificationAttempt.retire_user(user.id)
|