constants.py

from __future__ import annotations


__copyright__ = "Copyright (C) 2014 Andreas Kloeckner"

__license__ = """
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
"""


from django.utils.translation import gettext, pgettext_lazy


# Allow 10x extra credit at the very most.
MAX_EXTRA_CREDIT_FACTOR = 10
DEFAULT_EMAIL_APPELLATION_PRIORITY_LIST = [
    "first_name", "email", "username", "full_name"]


COURSE_ID_REGEX = "(?P<course_identifier>[-a-zA-Z0-9]+)"
EVENT_KIND_REGEX = "(?P<event_kind>[_a-z0-9]+)"
FLOW_ID_REGEX = "(?P<flow_id>[-_a-zA-Z0-9]+)"
GRADING_OPP_ID_REGEX = "(?P<grading_opp_id>[-_a-zA-Z0-9]+)"
# FIXME : Support page hierarchy. Add '/' here, fix validation code.
STATICPAGE_PATH_REGEX = r"(?P<page_path>[-\w]+)"


class user_status:  # noqa
    unconfirmed = "unconfirmed"
    active = "active"


USER_STATUS_CHOICES = (
        (user_status.unconfirmed, pgettext_lazy("User status", "Unconfirmed")),
        (user_status.active, pgettext_lazy("User status", "Active")),
        )


# {{{ participation status

class participation_status:  # noqa
    requested = "requested"
    active = "active"
    dropped = "dropped"
    denied = "denied"


PARTICIPATION_STATUS_CHOICES = (
        (participation_status.requested,
            pgettext_lazy("Participation status", "Requested")),
        (participation_status.active,
            pgettext_lazy("Participation status", "Active")),
        (participation_status.dropped,
            pgettext_lazy("Participation status", "Dropped")),
        (participation_status.denied,
            pgettext_lazy("Participation status", "Denied")),
        )

# }}}


# {{{ participation permission

class participation_permission:  # noqa
    edit_course = "edit_course"
    use_admin_interface = "use_admin_interface"
    manage_authentication_tokens = "manage_authentication_tokens"

    impersonate_role = "impersonate_role"
    set_fake_time = "set_fake_time"
    set_pretend_facility = "set_pretend_facility"

    edit_course_permissions = "edit_course_permissions"
    view_hidden_course_page = "view_hidden_course_page"
    view_calendar = "view_calendar"
    send_instant_message = "send_instant_message"
    access_files_for = "access_files_for"
    included_in_grade_statistics = "included_in_grade_statistics"
    skip_during_manual_grading = "skip_during_manual_grading"

    edit_exam = "edit_exam"
    issue_exam_ticket = "issue_exam_ticket"
    batch_issue_exam_ticket = "batch_issue_exam_ticket"

    view_participant_masked_profile = "view_participant_masked_profile"
    view_flow_sessions_from_role = "view_flow_sessions_from_role"
    view_gradebook = "view_gradebook"
    edit_grading_opportunity = "edit_grading_opportunity"
    assign_grade = "assign_grade"
    view_grader_stats = "view_grader_stats"
    batch_import_grade = "batch_import_grade"
    batch_export_grade = "batch_export_grade"
    batch_download_submission = "batch_download_submission"

    impose_flow_session_deadline = "impose_flow_session_deadline"
    batch_impose_flow_session_deadline = "batch_impose_flow_session_deadline"
    end_flow_session = "end_flow_session"
    batch_end_flow_session = "batch_end_flow_session"
    regrade_flow_session = "regrade_flow_session"
    batch_regrade_flow_session = "batch_regrade_flow_session"
    recalculate_flow_session_grade = "recalculate_flow_session_grade"
    batch_recalculate_flow_session_grade = "batch_recalculate_flow_session_grade"

    reopen_flow_session = "reopen_flow_session"
    grant_exception = "grant_exception"
    view_analytics = "view_analytics"

    preview_content = "preview_content"
    update_content = "update_content"
    use_git_endpoint = "use_git_endpoint"
    use_markup_sandbox = "use_markup_sandbox"
    use_page_sandbox = "use_page_sandbox"
    test_flow = "test_flow"

    edit_events = "edit_events"

    query_participation = "query_participation"
    edit_participation = "edit_participation"
    preapprove_participation = "preapprove_participation"

    manage_instant_flow_requests = "manage_instant_flow_requests"


PARTICIPATION_PERMISSION_CHOICES = (
        (participation_permission.edit_course,
            pgettext_lazy("Participation permission", "Edit course")),
        (participation_permission.use_admin_interface,
            pgettext_lazy("Participation permission", "Use admin interface")),
        (participation_permission.manage_authentication_tokens,
            pgettext_lazy("Participation permission",
                "Manage authentication tokens")),

        (participation_permission.impersonate_role,
            pgettext_lazy("Participation permission", "Impersonate role")),
        (participation_permission.set_fake_time,
            pgettext_lazy("Participation permission", "Set fake time")),
        (participation_permission.set_pretend_facility,
            pgettext_lazy("Participation permission", "Pretend to be in facility")),
        (participation_permission.edit_course_permissions,
            pgettext_lazy("Participation permission", "Edit course permissions")),
        (participation_permission.view_hidden_course_page,
            pgettext_lazy("Participation permission", "View hidden course page")),
        (participation_permission.view_calendar,
            pgettext_lazy("Participation permission", "View calendar")),
        (participation_permission.send_instant_message,
            pgettext_lazy("Participation permission", "Send instant message")),
        (participation_permission.access_files_for,
            pgettext_lazy("Participation permission", "Access files for")),
        (participation_permission.included_in_grade_statistics,
            pgettext_lazy("Participation permission",
                "Included in grade statistics")),
        (participation_permission.skip_during_manual_grading,
            pgettext_lazy("Participation permission",
                "Skip during manual grading")),

        (participation_permission.edit_exam,
            pgettext_lazy("Participation permission", "Edit exam")),
        (participation_permission.issue_exam_ticket,
            pgettext_lazy("Participation permission", "Issue exam ticket")),
        (participation_permission.batch_issue_exam_ticket,
            pgettext_lazy("Participation permission", "Batch issue exam ticket")),

        (participation_permission.view_participant_masked_profile,
            pgettext_lazy("Participation permission",
                "View participants' masked profile only")),
        (participation_permission.view_flow_sessions_from_role,
            pgettext_lazy("Participation permission",
                "View flow sessions from role")),
        (participation_permission.view_gradebook,
            pgettext_lazy("Participation permission", "View gradebook")),
        (participation_permission.edit_grading_opportunity,
            pgettext_lazy("Participation permission", "Edit grading opportunity")),
        (participation_permission.assign_grade,
            pgettext_lazy("Participation permission", "Assign grade")),
        (participation_permission.view_grader_stats,
            pgettext_lazy("Participation permission", "View grader stats")),
        (participation_permission.batch_import_grade,
            pgettext_lazy("Participation permission", "Batch-import grades")),
        (participation_permission.batch_export_grade,
            pgettext_lazy("Participation permission", "Batch-export grades")),
        (participation_permission.batch_download_submission,
            pgettext_lazy("Participation permission", "Batch-download submissions")),

        (participation_permission.impose_flow_session_deadline,
            pgettext_lazy("Participation permission",
                "Impose flow session deadline")),
        (participation_permission.batch_impose_flow_session_deadline,
            pgettext_lazy("Participation permission",
                "Batch-impose flow session deadline")),
        (participation_permission.end_flow_session,
            pgettext_lazy("Participation permission", "End flow session")),
        (participation_permission.batch_end_flow_session,
            pgettext_lazy("Participation permission", "Batch-end flow sessions")),
        (participation_permission.regrade_flow_session,
            pgettext_lazy("Participation permission", "Regrade flow session")),
        (participation_permission.batch_regrade_flow_session,
            pgettext_lazy("Participation permission",
                "Batch-regrade flow sessions")),
        (participation_permission.recalculate_flow_session_grade,
            pgettext_lazy("Participation permission",
                "Recalculate flow session grade")),
        (participation_permission.batch_recalculate_flow_session_grade,
            pgettext_lazy("Participation permission",
                "Batch-recalculate flow session grades")),

        (participation_permission.reopen_flow_session,
            pgettext_lazy("Participation permission", "Reopen flow session")),
        (participation_permission.grant_exception,
            pgettext_lazy("Participation permission", "Grant exception")),
        (participation_permission.view_analytics,
            pgettext_lazy("Participation permission", "View analytics")),

        (participation_permission.preview_content,
            pgettext_lazy("Participation permission", "Preview content")),
        (participation_permission.update_content,
            pgettext_lazy("Participation permission", "Update content")),
        (participation_permission.use_git_endpoint,
            pgettext_lazy("Participation permission", "Use direct git endpoint")),
        (participation_permission.use_markup_sandbox,
            pgettext_lazy("Participation permission", "Use markup sandbox")),
        (participation_permission.use_page_sandbox,
            pgettext_lazy("Participation permission", "Use page sandbox")),
        (participation_permission.test_flow,
            pgettext_lazy("Participation permission", "Test flow")),

        (participation_permission.edit_events,
            pgettext_lazy("Participation permission", "Edit events")),

        (participation_permission.query_participation,
            pgettext_lazy("Participation permission", "Query participation")),
        (participation_permission.edit_participation,
            pgettext_lazy("Participation permission", "Edit participation")),
        (participation_permission.preapprove_participation,
            pgettext_lazy("Participation permission", "Preapprove participation")),

        (participation_permission.manage_instant_flow_requests,
            pgettext_lazy("Participation permission",
                "Manage instant flow requests")),
        )

# }}}


# {{{ flow session related

class flow_session_interaction_kind:  # noqa
    noninteractive = "noninteractive"
    ungraded = "ungraded"
    practice_grade = "practice_grade"
    permanent_grade = "permanent_grade"


class flow_session_expiration_mode:  # noqa
    """
    .. attribute:: end

        End the session upon expiration. Participants may always choose this mode.

    .. attribute:: roll_over

        Upon expiration, reprocess the session start rules and
        treat the session as if it was started the moment of expiration.
        This may be used to 'roll over' into another set of grading rules,
        say ones assigning less credit for homework turned in late.

        Allowed by :attr:`flow_permission.set_roll_over_expiration_mode`.
    """
    # always allowed
    end = "end"

    # allowed by special permission below
    roll_over = "roll_over"


FLOW_SESSION_EXPIRATION_MODE_CHOICES = (
        (flow_session_expiration_mode.end,
            pgettext_lazy("Flow expiration mode", "Submit session for grading")),
        (flow_session_expiration_mode.roll_over,
            pgettext_lazy("Flow expiration mode",
                "Do not submit session for grading")),
        )


def is_expiration_mode_allowed(
        expmode: str, permissions: frozenset[str]
        ) -> bool:
    if expmode == flow_session_expiration_mode.roll_over:
        if (flow_permission.set_roll_over_expiration_mode
                in permissions):
            return True
    elif expmode == flow_session_expiration_mode.end:
        return True
    else:
        raise ValueError(gettext("unknown expiration mode"))

    return False

# }}}


# {{{ flow permission

class flow_permission:  # noqa
    """
    .. attribute:: view

        If present, the participant may view flow pages.

    .. attribute:: submit_answer

        If present, the participant may submit answers to prompts provided on
        a flow page.

    .. attribute:: end_session

        If present, the participant may end their flow session and receive an overall
        grade.

    .. attribute:: change_answer

        Grants permission to change an already-graded answer, which may then be
        graded again. Useful for :class:`course.page.PythonCodeQuestion` to
        allow iterative debugging. Requires :attr:`submit_answer` to also be
        present in order to be meaningful. (If a participant may not *submit*
        answers in the first place, the ability to change answers is moot.)

    .. attribute:: see_correctness

        If present, the participant will be shown to what extent their
        submitted answer is correct. (See :attr:`submit_answer`.)

    .. attribute:: see_answer_before_submission

        If present, shows the correct answer to the participant even before they
        have submitted an answer of their own.

    .. attribute:: see_answer_after_submission

        If present, shows the correct answer to the participant after they have
        submitted an answer of their own (and are no longer able to change it).

    .. attribute:: cannot_see_flow_result

        If present, an overall result/grade for the flow will *not* be shown
        at the end of a flow session.

    .. attribute:: set_roll_over_expiration_mode

        Grants permission to let a student choose to let a flow
        "expire" into the then-current set of access rules
        instead of into being submitted for grading.

        See :ref:`flow-life-cycle`.

    .. attribute:: see_session_time

        Allows the participant to see the duration for which the
        session has been going on.

    .. attribute:: lock_down_as_exam_session

        Once any page of the flow has been viewed, access to all content
        except for this session on this RELATE instance will be denied.

    .. attribute:: send_email_about_flow_page

        If present, the participant can send interaction emails to
        course staff for questions for each page with that permission.

    .. attribute:: hide_point_count

        If present, the point count for the page will not be shown to
        the participant.
    """
    view = "view"
    end_session = "end_session"
    submit_answer = "submit_answer"
    change_answer = "change_answer"
    see_correctness = "see_correctness"
    see_answer_before_submission = "see_answer_before_submission"
    see_answer_after_submission = "see_answer_after_submission"
    cannot_see_flow_result = "cannot_see_flow_result"
    set_roll_over_expiration_mode = "set_roll_over_expiration_mode"
    see_session_time = "see_session_time"
    lock_down_as_exam_session = "lock_down_as_exam_session"
    send_email_about_flow_page = "send_email_about_flow_page"
    hide_point_count = "hide_point_count"


FLOW_PERMISSION_CHOICES = (
        (flow_permission.view,
            pgettext_lazy("Flow permission", "View the flow")),
        (flow_permission.submit_answer,
            pgettext_lazy("Flow permission", "Submit answers")),
        (flow_permission.end_session,
            pgettext_lazy("Flow permission", "End session")),
        (flow_permission.change_answer,
            pgettext_lazy("Flow permission", "Change already-graded answer")),
        (flow_permission.see_correctness,
            pgettext_lazy("Flow permission",
                "See whether an answer is correct")),
        (flow_permission.see_answer_before_submission,
            pgettext_lazy("Flow permission",
                "See the correct answer before answering")),
        (flow_permission.see_answer_after_submission,
            pgettext_lazy("Flow permission",
                "See the correct answer after answering")),
        (flow_permission.cannot_see_flow_result,
            pgettext_lazy("Flow permission",
                "Cannot see flow result")),
        (flow_permission.set_roll_over_expiration_mode,
            pgettext_lazy("Flow permission",
                "Set the session to 'roll over' expiration mode")),
        (flow_permission.see_session_time,
            pgettext_lazy("Flow permission", "See session time")),
        (flow_permission.lock_down_as_exam_session,
            pgettext_lazy("Flow permission", "Lock down as exam session")),
        (flow_permission.send_email_about_flow_page,
         pgettext_lazy("Flow permission",
                       "Send emails about the flow page to course staff")),
        (flow_permission.hide_point_count,
         pgettext_lazy("Flow permission",
                       "Hide point count")),
        )

# }}}


class flow_rule_kind:  # noqa
    start = "start"
    access = "access"
    grading = "grading"


FLOW_RULE_KIND_CHOICES = (
        (flow_rule_kind.start,
            pgettext_lazy("Flow rule kind choices", "Session Start")),
        (flow_rule_kind.access,
            pgettext_lazy("Flow rule kind choices", "Session Access")),
        (flow_rule_kind.grading,
            pgettext_lazy("Flow rule kind choices", "Grading")),
        )


# {{{ grade aggregation strategy

class grade_aggregation_strategy:  # noqa
    """A strategy for aggregating multiple grades into one.

    .. attribute:: max_grade

        Use the maximum of the achieved grades for each attempt.

    .. attribute:: avg_grade

        Use the average of the achieved grades for each attempt.

    .. attribute:: min_grade

        Use the minimum of the achieved grades for each attempt.

    .. attribute:: use_earliest

        Use the first of the achieved grades for each attempt.

    .. attribute:: use_latest

        Use the last of the achieved grades for each attempt.
    """

    max_grade = "max_grade"
    avg_grade = "avg_grade"
    min_grade = "min_grade"

    use_earliest = "use_earliest"
    use_latest = "use_latest"


GRADE_AGGREGATION_STRATEGY_CHOICES = (
        (grade_aggregation_strategy.max_grade,
            pgettext_lazy("Grade aggregation strategy", "Use the max grade")),
        (grade_aggregation_strategy.avg_grade,
            pgettext_lazy("Grade aggregation strategy", "Use the avg grade")),
        (grade_aggregation_strategy.min_grade,
            pgettext_lazy("Grade aggregation strategy", "Use the min grade")),
        (grade_aggregation_strategy.use_earliest,
            pgettext_lazy("Grade aggregation strategy", "Use the earliest grade")),
        (grade_aggregation_strategy.use_latest,
            pgettext_lazy("Grade aggregation strategy", "Use the latest grade")),
        )

# }}}


# {{{ grade state-change type

class grade_state_change_types:  # noqa
    grading_started = "grading_started"
    graded = "graded"
    retrieved = "retrieved"
    unavailable = "unavailable"
    extension = "extension"
    report_sent = "report_sent"
    do_over = "do_over"
    exempt = "exempt"


GRADE_STATE_CHANGE_CHOICES = (
        (grade_state_change_types.grading_started,
            pgettext_lazy("Grade state change", "Grading started")),
        (grade_state_change_types.graded,
            pgettext_lazy("Grade state change", "Graded")),
        (grade_state_change_types.retrieved,
            pgettext_lazy("Grade state change", "Retrieved")),
        (grade_state_change_types.unavailable,
            pgettext_lazy("Grade state change", "Unavailable")),
        (grade_state_change_types.extension,
            pgettext_lazy("Grade state change", "Extension")),
        (grade_state_change_types.report_sent,
            pgettext_lazy("Grade state change", "Report sent")),
        (grade_state_change_types.do_over,
            pgettext_lazy("Grade state change", "Do-over")),
        (grade_state_change_types.exempt,
            pgettext_lazy("Grade state change", "Exempt")),
        )

# }}}


# {{{ exam ticket state

class exam_ticket_states:  # noqa
    valid = "valid"
    used = "used"
    revoked = "revoked"


EXAM_TICKET_STATE_CHOICES = (
        (exam_ticket_states.valid,
            pgettext_lazy("Exam ticket state", "Valid")),
        (exam_ticket_states.used,
            pgettext_lazy("Exam ticket state", "Used")),
        (exam_ticket_states.revoked,
            pgettext_lazy("Exam ticket state", "Revoked")),
        )

# }}}


ATTRIBUTES_FILENAME = ".attributes.yml"
DEFAULT_ACCESS_KINDS = ["public", "in_exam", "student", "ta",
                        "unenrolled", "instructor"]


# {{{ session attributes

SESSION_LOCKED_TO_FLOW_PK = "relate_session_locked_to_exam_flow_session_pk"

# }}}

# vim: foldmethod=marker