"""
This module contains all general use signals.
"""


from django.dispatch import Signal

# Signal that fires when a user is graded
COURSE_GRADE_CHANGED = Signal(providing_args=["user", "course_grade", "course_key", "deadline"])

# Signal that fires when a user is awarded a certificate in a course (in the certificates django app)
# TODO: runtime coupling between apps will be reduced if this event is changed to carry a username
# rather than a User object; however, this will require changes to the milestones and badges APIs
COURSE_CERT_CHANGED = Signal(providing_args=["user", "course_key", "mode", "status"])
COURSE_CERT_AWARDED = Signal(providing_args=["user", "course_key", "mode", "status"])
COURSE_CERT_REVOKED = Signal(providing_args=["user", "course_key", "mode", "status"])
COURSE_CERT_DATE_CHANGE = Signal(providing_args=["course_key", "available_date"])


COURSE_ASSESSMENT_GRADE_CHANGED = Signal(
    providing_args=[
        'user',
        'course_id',
        'subsection_id',
        'subsection_grade',
    ]
)

# Signal that indicates that a user has passed a course.
COURSE_GRADE_NOW_PASSED = Signal(
    providing_args=[
        'user',  # user object
        'course_id',  # course.id
    ]
)
#Signal that indicates a user is now failing a course that they had previously passed.
COURSE_GRADE_NOW_FAILED = Signal(
    providing_args=[
        'user',  # user object
        'course_id',  # course.id
        'grade',  # CourseGrade object
    ]
)

# Signal that indicates that a user has become verified for certificate purposes
LEARNER_NOW_VERIFIED = Signal(providing_args=['user'])

USER_ACCOUNT_ACTIVATED = Signal(providing_args=["user"])  # Signal indicating email verification