Files
edx-platform/cms/djangoapps/cms_user_tasks/signals.py
Awais Jibran ad7f6019fe Integrate "olxcleaner" with course import (#27164)
* Integrating olxcleaner in course import

* Adding toggle removal date and addressing pylint issues.
2021-03-31 13:26:14 +05:00

54 lines
2.0 KiB
Python

"""
Receivers of signals sent from django-user-tasks
"""
import logging
from urllib.parse import urljoin
from django.dispatch import receiver
from django.urls import reverse
from user_tasks.models import UserTaskArtifact
from user_tasks.signals import user_task_stopped
from .tasks import send_task_complete_email
LOGGER = logging.getLogger(__name__)
@receiver(user_task_stopped, dispatch_uid="cms_user_task_stopped")
def user_task_stopped_handler(sender, **kwargs): # pylint: disable=unused-argument
"""
Handles sending notifications when a django-user-tasks completes.
This is a signal receiver for user_task_stopped. Currently it only sends
a generic "task completed" email, and only when a top-level task
completes. Eventually it might make more sense to create specific per-task
handlers.
Arguments:
sender (obj): Currently the UserTaskStatus object class
**kwargs: See below
Keywork Arguments:
status (obj): UserTaskStatus of the completed task
Returns:
None
"""
status = kwargs['status']
# Only send email when the entire task is complete, should only send when
# a chain / chord / etc completes, not on sub-tasks.
if status.parent is None:
# `name` and `status` are not unique, first is our best guess
artifact = UserTaskArtifact.objects.filter(status=status, name="BASE_URL").first()
detail_url = None
if artifact and artifact.url.startswith(('http://', 'https://')):
detail_url = urljoin(
artifact.url,
reverse('usertaskstatus-detail', args=[status.uuid])
)
user_email = status.user.email
task_name = status.name.lower()
try:
# Need to str state_text here because it is a proxy object and won't serialize correctly
send_task_complete_email.delay(task_name, str(status.state_text), user_email, detail_url)
except Exception: # pylint: disable=broad-except
LOGGER.exception("Unable to queue send_task_complete_email")