validation.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.
"""

import datetime
import re
import sys
from typing import TYPE_CHECKING, Any

from django.core.exceptions import ObjectDoesNotExist
from django.utils.html import escape
from django.utils.translation import gettext, gettext_lazy as _

from course.constants import (
    ATTRIBUTES_FILENAME,
    DEFAULT_ACCESS_KINDS,
    FLOW_SESSION_EXPIRATION_MODE_CHOICES,
    participation_permission as pperm,
)
from course.content import get_repo_blob
from relate.utils import Struct, string_concat


# {{{ mypy

if TYPE_CHECKING:
    from course.models import Course
    from relate.utils import Repo_ish

# }}}


__doc__ = """
.. autoclass:: ValidationContext

.. autofunction:: validate_struct

Stub Docs
=========

.. class:: Course
.. class:: Repo_ish
"""


# {{{ validation tools

class ValidationError(RuntimeError):
    pass


ID_RE = re.compile(r"^[\w]+$")


def validate_identifier(
        vctx: ValidationContext, location: str, s: str, warning_only: bool = False
        ) -> None:
    if not ID_RE.match(s):

        if warning_only:
            msg = (string_concat(
                        _("invalid identifier"),
                        " '%(string)s'")
                    % {"location": location, "string": s})

            vctx.add_warning(location, msg)
        else:
            msg = (string_concat(
                        "%(location)s: ",
                        _("invalid identifier"),
                        " '%(string)s'")
                    % {"location": location, "string": s})

            raise ValidationError(msg)


def validate_role(vctx: ValidationContext, location: str, role: str) -> None:

    if vctx.course is not None:
        from course.models import ParticipationRole
        roles = ParticipationRole.objects.filter(course=vctx.course).values_list(
                "identifier", flat=True)

        if role not in roles:
            raise ValidationError(
                    string_concat("%(location)s: ",
                        _("invalid role '%(role)s'"))
                    % {"location": location, "role": role})


def validate_facility(
        vctx: ValidationContext, location: str, facility: str) -> None:
    from course.utils import get_facilities_config
    facilities = get_facilities_config()
    if facilities is None:
        return

    if facility not in facilities:
        vctx.add_warning(location, _(
            "Name of facility not recognized: '%(fac_name)s'. "
            "Known facility names: '%(known_fac_names)s'")
            % {
                "fac_name": facility,
                "known_fac_names": ", ".join(facilities),
                })


def validate_participationtag(
        vctx: ValidationContext, location: str, participationtag: str) -> None:
    if vctx.course is not None:
        from pytools import memoize_in

        @memoize_in(vctx, "available_participation_tags")
        def get_ptag_list(vctx: ValidationContext) -> list[str]:
            from course.models import ParticipationTag
            return list(
                ParticipationTag.objects.filter(course=vctx.course)
                .values_list("name", flat=True))

        ptag_list = get_ptag_list(vctx)
        if participationtag not in ptag_list:
            vctx.add_warning(
                location,
                _(
                    "Name of participation tag not recognized: '%(ptag_name)s'. "
                    "Known participation tag names: '%(known_ptag_names)s'")
                % {
                    "ptag_name": participationtag,
                    "known_ptag_names": ", ".join(ptag_list),
                })


def validate_struct(
        vctx: ValidationContext,
        location: str,
        obj: Any,
        required_attrs: list[tuple[str, Any]],
        allowed_attrs: list[tuple[str, Any]],
        ) -> None:

    """
    :arg required_attrs: an attribute validation list (see below)
    :arg allowed_attrs: an attribute validation list (see below)

    An attribute validation list is a list of elements, where each element is
    either a string (the name of the attribute), in which case the type of each
    attribute is not checked, or a tuple *(name, type)*, where type is valid
    as a second argument to :func:`isinstance`.
    """

    if not isinstance(obj, Struct):
        raise ValidationError(
                "%s: not a key-value map" % location)

    present_attrs = {name for name in dir(obj) if not name.startswith("_")}

    for required, attr_list in [
            (True, required_attrs),
            (False, allowed_attrs),
            ]:
        for attr_rec in attr_list:
            if isinstance(attr_rec, tuple):
                attr, allowed_types = attr_rec
            else:
                attr = attr_rec
                allowed_types = None

            if attr not in present_attrs:
                if required:
                    raise ValidationError(
                            string_concat("%(location)s: ",
                                _("attribute '%(attr)s' missing"))
                            % {"location": location, "attr": attr})
            else:
                present_attrs.remove(attr)
                val = getattr(obj, attr)

                is_markup = False
                if allowed_types == "markup":
                    allowed_types = str
                    is_markup = True

                if not isinstance(val, allowed_types):
                    raise ValidationError(
                            string_concat("%(location)s: ",
                                _("attribute '%(attr)s' has "
                                    "wrong type: got '%(name)s', "
                                    "expected '%(allowed)s'"))
                            % {
                                "location": location,
                                "attr": attr,
                                "name": type(val).__name__,
                                "allowed": escape(str(allowed_types))})

                if is_markup:
                    validate_markup(vctx, f"{location}: attribute {attr}", val)

    if present_attrs:
        raise ValidationError(
                string_concat("%(location)s: ",
                    _("extraneous attribute(s) '%(attr)s'"))
                % {"location": location, "attr": ",".join(present_attrs)})


datespec_types = (datetime.date, str, datetime.datetime)

# }}}


class ValidationWarning:
    def __init__(self, location: str | None, text: str) -> None:
        self.location = location
        self.text = text


class ValidationContext:
    """
    .. attribute:: repo
    .. attribute:: commit_sha
    .. attribute:: course

        A :class:`course.models.Course` instance, or *None*, if no database
        is currently available.
    """

    course: Course | None = None

    def __init__(
            self, repo: Repo_ish, commit_sha: bytes, course: Course | None = None
            ) -> None:
        self.repo = repo
        self.commit_sha = commit_sha
        self.course = course

        self.warnings: list[ValidationWarning] = []

    def encounter_datespec(self, location: str, datespec: str) -> None:

        from course.content import parse_date_spec
        parse_date_spec(self.course, datespec, vctx=self, location=location)

    def add_warning(self, location: str | None, text: str) -> None:
        self.warnings.append(ValidationWarning(location, text))


# {{{ markup validation

def validate_markup(
        vctx: ValidationContext, location: str, markup_str: str) -> None:
    def reverse_func(*args, **kwargs):
        pass

    from course.content import markup_to_html
    try:
        markup_to_html(
                course=None,
                repo=vctx.repo,
                commit_sha=vctx.commit_sha,
                text=markup_str,
                reverse_func=reverse_func,
                validate_only=True)
    except Exception:
        from traceback import print_exc
        print_exc()

        tp, e, _ = sys.exc_info()

        assert tp is not None

        raise ValidationError(
                "{location}: {err_type}: {err_str}".format(
                    location=location,
                    err_type=tp.__name__,
                    err_str=str(e)))

# }}}


# {{{ course page validation

def validate_chunk_rule(vctx, location, chunk_rule):
    validate_struct(
            vctx,
            location,
            chunk_rule,
            required_attrs=[
                ("weight", int),
                ],
            allowed_attrs=[
                ("if_after", datespec_types),
                ("if_before", datespec_types),
                ("if_in_facility", str),
                ("if_has_role", list),
                ("if_has_participation_tags_any", list),
                ("if_has_participation_tags_all", list),

                ("start", datespec_types),
                ("end", datespec_types),
                ("roles", list),

                ("shown", bool),
            ])

    if hasattr(chunk_rule, "if_after"):
        vctx.encounter_datespec(location, chunk_rule.if_after)

    if hasattr(chunk_rule, "if_before"):
        vctx.encounter_datespec(location, chunk_rule.if_before)

    if hasattr(chunk_rule, "if_has_role"):
        for role in chunk_rule.if_has_role:
            validate_role(vctx, location, role)

    if hasattr(chunk_rule, "if_has_participation_tags_any"):
        for ptag in chunk_rule.if_has_participation_tags_any:
            validate_participationtag(vctx, location, ptag)

    if hasattr(chunk_rule, "if_has_participation_tags_all"):
        for ptag in chunk_rule.if_has_participation_tags_all:
            validate_participationtag(vctx, location, ptag)

    if hasattr(chunk_rule, "if_in_facility"):
        validate_facility(vctx, location, chunk_rule.if_in_facility)

    # {{{ deprecated

    if hasattr(chunk_rule, "start"):
        vctx.add_warning(location, _("Uses deprecated 'start' attribute--"
                "use 'if_after' instead"))

        vctx.encounter_datespec(location, chunk_rule.start)

    if hasattr(chunk_rule, "end"):
        vctx.add_warning(location, _("Uses deprecated 'end' attribute--"
                "use 'if_before' instead"))

        vctx.encounter_datespec(location, chunk_rule.end)

    if hasattr(chunk_rule, "roles"):
        vctx.add_warning(location, _("Uses deprecated 'roles' attribute--"
                "use 'if_has_role' instead"))

        for role in chunk_rule.roles:
            validate_role(vctx, location, role)

    # }}}


def validate_page_chunk(vctx, location, chunk):
    validate_struct(
            vctx,
            location,
            chunk,
            required_attrs=[
                ("id", str),
                ("content", "markup"),
                ],
            allowed_attrs=[
                ("title", str),
                ("rules", list),
                ]
            )

    title = getattr(chunk, "title", None)
    if title is None:
        from course.content import extract_title_from_markup
        title = extract_title_from_markup(chunk.content)

    if title is None:
        raise ValidationError(
                string_concat("%(location)s: ",
                    _("no title present"))
                % {"location": location})

    if hasattr(chunk, "rules"):
        for i, rule in enumerate(chunk.rules):
            validate_chunk_rule(vctx,
                    "%s, rule %d" % (location, i+1),
                    rule)

    validate_markup(vctx, location, chunk.content)


def validate_staticpage_desc(vctx, location, page_desc):
    validate_struct(
            vctx,
            location,
            page_desc,
            required_attrs=[
                ],
            allowed_attrs=[
                ("chunks", list),
                ("content", str),
                ]
            )

    # {{{ check for presence of 'chunks' or 'content'

    if (
            (not hasattr(page_desc, "chunks") and not hasattr(page_desc, "content"))
            or (hasattr(page_desc, "chunks") and hasattr(page_desc, "content"))):
        raise ValidationError(
                string_concat("%(location)s: ",
                    _("must have either 'chunks' or 'content'"))
                % {"location": location})

    # }}}

    if hasattr(page_desc, "content"):
        from course.content import normalize_page_desc
        page_desc = normalize_page_desc(page_desc)

        assert not hasattr(page_desc, "content")
        assert hasattr(page_desc, "chunks")

    for i, chunk in enumerate(page_desc.chunks):
        validate_page_chunk(vctx,
                "%s, chunk %d ('%s')"
                % (location, i+1, getattr(chunk, "id", None)),
                chunk)

    # {{{ check chunk id uniqueness

    chunk_ids = set()

    for chunk in page_desc.chunks:
        if chunk.id in chunk_ids:
            raise ValidationError(
                    string_concat(
                        "%(location)s: ",
                        _("chunk id '%(chunkid)s' not unique"))
                    % {"location": location, "chunkid": chunk.id})

        chunk_ids.add(chunk.id)

    # }}}

# }}}


# {{{ flow validation

def validate_flow_page(
        vctx: ValidationContext, location: str, page_desc: Any) -> None:
    if not hasattr(page_desc, "id"):
        raise ValidationError(
                string_concat(
                    "%s: ",
                    gettext("flow page has no ID"))
                % location)

    validate_identifier(vctx, location, page_desc.id)

    from course.content import get_flow_page_class
    try:
        class_ = get_flow_page_class(vctx.repo, page_desc.type, vctx.commit_sha)
        class_(vctx, location, page_desc)
    except ValidationError:
        raise
    except Exception:
        tp, e, __ = sys.exc_info()

        from traceback import format_exc
        raise ValidationError(
                string_concat(
                    "%(location)s: ",
                    _("could not instantiate flow page"),
                    ": %(err_type)s: "
                    "%(err_str)s<br><pre>%(format_exc)s</pre>")
                % {
                    "location": location,
                    "err_type": tp.__name__,  # type: ignore
                    "err_str": str(e),
                    "format_exc": format_exc()})


def validate_flow_group(vctx, location, grp):
    validate_struct(
            vctx,
            location,
            grp,
            required_attrs=[
                ("id", str),
                ("pages", list),
                ],
            allowed_attrs=[
                ("shuffle", bool),
                ("max_page_count", int),
                ]
            )

    if len(grp.pages) == 0:
        raise ValidationError(
                string_concat(
                    "%(location)s, ",
                    _("group '%(group_id)s': group is empty"))
                % {"location": location, "group_id": grp.id})

    for i, page_desc in enumerate(grp.pages):
        validate_flow_page(
                vctx,
                "%s, page %d ('%s')"
                % (location, i+1, getattr(page_desc, "id", None)),
                page_desc)

    if hasattr(grp, "max_page_count"):
        if grp.max_page_count <= 0:
            raise ValidationError(
                string_concat(
                    "%(location)s, ",
                    _("group '%(group_id)s': "
                        "max_page_count is not positive"))
                % {"location": location, "group_id": grp.id})
        elif not hasattr(grp, "shuffle") and grp.max_page_count < len(grp.pages):
            vctx.add_warning(
                _("%(location)s, group '%(group_id)s': ") % {
                    "location": location, "group_id": grp.id},
                _("shuffle attribute will be required for groups with"
                  "max_page_count in a future version. set "
                  "'shuffle: False' to match current behavior."))

    # {{{ check page id uniqueness

    page_ids = set()

    for page_desc in grp.pages:
        if page_desc.id in page_ids:
            raise ValidationError(
                    string_concat(
                        "%(location)s: ",
                        _("page id '%(page_desc_id)s' not unique"))
                    % {"location": location, "page_desc_id": page_desc.id})

        page_ids.add(page_desc.id)

    # }}}

    validate_identifier(vctx, location, grp.id)


# {{{ flow rules

def validate_session_start_rule(
        vctx: ValidationContext, location: str, nrule: Any, tags: list[str]
        ) -> None:
    validate_struct(
            vctx, location, nrule,
            required_attrs=[],
            allowed_attrs=[
                ("if_after", datespec_types),
                ("if_before", datespec_types),
                ("if_has_role", list),
                ("if_has_participation_tags_any", list),
                ("if_has_participation_tags_all", list),
                ("if_in_facility", str),
                ("if_has_in_progress_session", bool),
                ("if_has_session_tagged", (str, type(None))),
                ("if_has_fewer_sessions_than", int),
                ("if_has_fewer_tagged_sessions_than", int),
                ("if_signed_in_with_matching_exam_ticket", bool),
                ("tag_session", (str, type(None))),
                ("may_start_new_session", bool),
                ("may_list_existing_sessions", bool),
                ("lock_down_as_exam_session", bool),
                ("default_expiration_mode", str),
                ]
            )

    if hasattr(nrule, "if_after"):
        vctx.encounter_datespec(location, nrule.if_after)
    if hasattr(nrule, "if_before"):
        vctx.encounter_datespec(location, nrule.if_before)
    if hasattr(nrule, "if_has_role"):
        for j, role in enumerate(nrule.if_has_role):
            validate_role(
                    vctx,
                    "%s, role %d" % (location, j+1),
                    role)

    if hasattr(nrule, "if_has_participation_tags_any"):
        for ptag in nrule.if_has_participation_tags_any:
            validate_participationtag(vctx, location, ptag)

    if hasattr(nrule, "if_has_participation_tags_all"):
        for ptag in nrule.if_has_participation_tags_all:
            validate_participationtag(vctx, location, ptag)

    if hasattr(nrule, "if_in_facility"):
        validate_facility(vctx, location, nrule.if_in_facility)

    if hasattr(nrule, "if_has_session_tagged"):
        if nrule.if_has_session_tagged is not None:
            validate_identifier(vctx, "%s: if_has_session_tagged" % location,
                    nrule.if_has_session_tagged)

    if not hasattr(nrule, "may_start_new_session"):
        vctx.add_warning(
                location+", rules",
                _("attribute 'may_start_new_session' is not present"))
    if not hasattr(nrule, "may_list_existing_sessions"):
        vctx.add_warning(
                location+", rules",
                _("attribute 'may_list_existing_sessions' is not present"))
    if hasattr(nrule, "lock_down_as_exam_session"):
        vctx.add_warning(
                location+", rules",
                _("Attribute 'lock_down_as_exam_session' is deprecated "
                "and non-functional. Use the access permission flag "
                "'lock_down_as_exam_session' instead."))

    if hasattr(nrule, "tag_session"):
        if nrule.tag_session is not None:
            validate_identifier(vctx, "%s: tag_session" % location,
                    nrule.tag_session,
                    warning_only=True)

        if not (nrule.tag_session is None or nrule.tag_session in tags):
            raise ValidationError(
                    string_concat(
                        "%(location)s: ",
                        _("invalid tag '%(tag)s'"))
                    % {"location": location, "tag": nrule.tag_session})

    if hasattr(nrule, "default_expiration_mode"):
        from course.constants import FLOW_SESSION_EXPIRATION_MODE_CHOICES
        if nrule.default_expiration_mode not in dict(
                FLOW_SESSION_EXPIRATION_MODE_CHOICES):
            raise ValidationError(
                    string_concat("%(location)s: ",
                        _("invalid default expiration mode '%(expiremode)s'"))
                    % {
                        "location": location,
                        "expiremode": nrule.default_expiration_mode})


def validate_session_access_rule(
        vctx: ValidationContext, location: str, arule: Any, tags: list[str]
        ) -> None:
    validate_struct(
            vctx, location, arule,
            required_attrs=[
                ("permissions", list),
                ],
            allowed_attrs=[
                ("if_after", datespec_types),
                ("if_before", datespec_types),
                ("if_started_before", datespec_types),
                ("if_has_role", list),
                ("if_has_participation_tags_any", list),
                ("if_has_participation_tags_all", list),
                ("if_in_facility", str),
                ("if_has_tag", (str, type(None))),
                ("if_in_progress", bool),
                ("if_completed_before", datespec_types),
                ("if_expiration_mode", str),
                ("if_session_duration_shorter_than_minutes", (int, float)),
                ("if_signed_in_with_matching_exam_ticket", bool),
                ("message", str),
                ]
            )

    if hasattr(arule, "if_after"):
        vctx.encounter_datespec(location, arule.if_after)
    if hasattr(arule, "if_before"):
        vctx.encounter_datespec(location, arule.if_before)
    if hasattr(arule, "if_completed_before"):
        vctx.encounter_datespec(location, arule.if_completed_before)

    if hasattr(arule, "if_has_role"):
        for j, role in enumerate(arule.if_has_role):
            validate_role(
                    vctx,
                    "%s, role %d" % (location, j+1),
                    role)

    if hasattr(arule, "if_has_participation_tags_any"):
        for ptag in arule.if_has_participation_tags_any:
            validate_participationtag(vctx, location, ptag)

    if hasattr(arule, "if_has_participation_tags_all"):
        for ptag in arule.if_has_participation_tags_all:
            validate_participationtag(vctx, location, ptag)

    if hasattr(arule, "if_in_facility"):
        validate_facility(vctx, location, arule.if_in_facility)

    if hasattr(arule, "if_has_tag"):
        if arule.if_has_tag is not None:
            validate_identifier(vctx, "%s: if_has_tag" % location,
                    arule.if_has_tag,
                    warning_only=True)

        if not (arule.if_has_tag is None or arule.if_has_tag in tags):
            raise ValidationError(
                    string_concat(
                        "%(location)s: ",
                        _("invalid tag '%(tag)s'"))
                    % {"location": location, "tag": arule.if_has_tag})

    if hasattr(arule, "if_expiration_mode"):
        if arule.if_expiration_mode not in dict(
                FLOW_SESSION_EXPIRATION_MODE_CHOICES):
            raise ValidationError(
                    string_concat("%(location)s: ",
                        _("invalid expiration mode '%(expiremode)s'"))
                    % {
                        "location": location,
                        "expiremode": arule.if_expiration_mode})

    for j, perm in enumerate(arule.permissions):
        validate_flow_permission(
                vctx,
                "%s, permission %d" % (location, j+1),
                perm)

    if hasattr(arule, "if_in_progress") and not arule.if_in_progress:
        from course.constants import flow_permission
        if (
                flow_permission.submit_answer in arule.permissions
                or flow_permission.end_session in arule.permissions):
            vctx.add_warning(location,
                    _("Rule specifies 'submit_answer' or 'end_session' "
                        "permissions for non-in-progress flow. These "
                        "permissions will be ignored."))


def validate_session_grading_rule(
        vctx: ValidationContext,
        location: str,
        grule: Any,
        tags: list[str],
        grade_identifier: str | None,
        ) -> bool:

    """
    :returns: whether the rule only applies conditionally
    """

    validate_struct(
            vctx, location, grule,
            required_attrs=[
                ],
            allowed_attrs=[
                ("if_has_role", list),
                ("if_has_participation_tags_any", list),
                ("if_has_participation_tags_all", list),
                ("if_has_tag", (str, type(None))),
                ("if_started_before", datespec_types),
                ("if_completed_before", datespec_types),

                ("credit_percent", (int, float)),
                ("use_last_activity_as_completion_time", bool),
                ("due", datespec_types),
                ("generates_grade", bool),
                ("description", str),

                ("max_points", (int, float)),
                ("max_points_enforced_cap", (int, float)),
                ("bonus_points", (int, float)),

                # legacy
                ("grade_identifier", (type(None), str)),
                ("grade_aggregation_strategy", str),
                ]
            )

    if hasattr(grule, "grade_identifier"):
        raise ValidationError(
                string_concat("%(location)s: ",
                    _("'grade_identifier' attribute found. "
                        "This attribute is no longer allowed here "
                        "and should be moved upward into the 'rules' "
                        "block."))
                % {"location": location})

    if hasattr(grule, "grade_aggregation_strategy"):
        raise ValidationError(
                string_concat("%(location)s: ",
                    _("'grade_aggregation_strategy' attribute found. "
                        "This attribute is no longer allowed here "
                        "and should be moved upward into the 'rules' "
                        "block."))
                % {"location": location})

    has_conditionals = False

    if hasattr(grule, "if_started_before"):
        vctx.encounter_datespec(location, grule.if_started_before)
        has_conditionals = True

    if hasattr(grule, "if_completed_before"):
        vctx.encounter_datespec(location, grule.if_completed_before)
        has_conditionals = True

    if hasattr(grule, "if_has_role"):
        for j, role in enumerate(grule.if_has_role):
            validate_role(
                    vctx,
                    "%s, role %d" % (location, j+1),
                    role)
        has_conditionals = True

    if hasattr(grule, "if_has_participation_tags_any"):
        for ptag in grule.if_has_participation_tags_any:
            validate_participationtag(vctx, location, ptag)
        has_conditionals = True

    if hasattr(grule, "if_has_participation_tags_all"):
        for ptag in grule.if_has_participation_tags_all:
            validate_participationtag(vctx, location, ptag)
        has_conditionals = True

    if hasattr(grule, "if_has_tag"):
        if grule.if_has_tag is not None:
            validate_identifier(vctx, "%s: if_has_tag" % location,
                    grule.if_has_tag,
                    warning_only=True)

        if not (grule.if_has_tag is None or grule.if_has_tag in tags):
            raise ValidationError(
                    string_concat(
                        "%(location)s: ",
                        _("invalid tag '%(tag)s'"))
                    % {"location": location, "tag": grule.if_has_tag})
        has_conditionals = True

    if hasattr(grule, "due"):
        vctx.encounter_datespec(location, grule.due)

    if (getattr(grule, "generates_grade", True)
            and grade_identifier is None):
        raise ValidationError(
                string_concat("%(location)s: ",
                    _("'generates_grade' is true, but no 'grade_identifier'"
                        "is given."))
                % {"location": location})

    return has_conditionals


def validate_flow_rules(vctx, location, rules):
    validate_struct(
            vctx,
            location + ", rules",
            rules,
            required_attrs=[
                ("access", list),
                ],
            allowed_attrs=[
                # may not start with an underscore
                ("start", list),
                ("grading", list),
                ("tags", list),

                ("grade_identifier", (type(None), str)),
                ("grade_aggregation_strategy", str),
                ]
            )

    if not hasattr(rules, "grade_identifier"):
        error_msg = _("'rules' block does not have a grade_identifier "
                     "attribute.")

        # for backward compatibility
        if hasattr(rules, "grading"):
            if hasattr(rules.grading, "grade_identifier"):
                error_msg = string_concat(
                    error_msg,
                    _(" This attribute needs to be moved out of "
                      "the lower-level 'grading' rules block and into "
                      "the 'rules' block itself."))
        raise ValidationError(
                string_concat("%(location)s: ", error_msg)
                % {"location": location})

    tags = getattr(rules, "tags", [])

    for i, tag in enumerate(tags):
        validate_identifier(vctx, "%s: tag %d" % (location, i+1), tag)

    # {{{ validate new-session rules

    if hasattr(rules, "start"):
        for i, nrule in enumerate(rules.start):
            validate_session_start_rule(
                    vctx, "%s, rules/start %d" % (location,  i+1),
                    nrule, tags)

    # }}}

    # {{{ validate access rules

    for i, arule in enumerate(rules.access):
        validate_session_access_rule(
                vctx,
                location="%s, rules/access #%d"
                % (location,  i+1), arule=arule, tags=tags)

    # }}}

    # {{{ grade_id

    if rules.grade_identifier:
        validate_identifier(vctx, "%s: grade_identifier" % location,
                rules.grade_identifier)
        if not hasattr(rules, "grade_aggregation_strategy"):
            raise ValidationError(
                    string_concat("%(location)s: ",
                        _("flows that have a grade "
                            "identifier ('%(identifier)s') "
                            "must have grading rules with a "
                            "grade_aggregation_strategy"))
                    % {
                        "location": location,
                        "identifier": rules.grade_identifier})

    from course.constants import GRADE_AGGREGATION_STRATEGY_CHOICES
    if (
            hasattr(rules, "grade_aggregation_strategy")
            and rules.grade_aggregation_strategy
            not in dict(GRADE_AGGREGATION_STRATEGY_CHOICES)):
        raise ValidationError(
                string_concat("%s: ",
                    _("invalid grade aggregation strategy"),
                    ": %s" % rules.grade_aggregation_strategy)
                % location)

    # }}}

    # {{{ validate grading rules

    if not hasattr(rules, "grading"):
        if rules.grade_identifier is not None:
            raise ValidationError(
                    string_concat("%(location)s: ",
                        _("'grading' block is required if grade_identifier "
                            "is not null/None."))
                    % {"location": location})

    else:
        has_conditionals = None

        if len(rules.grading) == 0:
            raise ValidationError(
                    string_concat(
                        "%s, ",
                        _("rules/grading: "
                            "may not be an empty list"))
                    % location)

        for i, grule in enumerate(rules.grading):
            has_conditionals = validate_session_grading_rule(
                    vctx,
                    location="%s, rules/grading #%d"
                    % (location,  i+1), grule=grule, tags=tags,
                    grade_identifier=rules.grade_identifier)

        if has_conditionals:
            raise ValidationError(
                    string_concat(
                        "%s, ",
                        _("rules/grading: "
                            "last grading rule must be unconditional"))
                    % location)

    # }}}


def validate_flow_permission(
        vctx: ValidationContext, location: str, permission: str) -> None:
    from course.constants import FLOW_PERMISSION_CHOICES
    if permission == "modify":
        vctx.add_warning(location, _("Uses deprecated 'modify' permission--"
                "replace by 'submit_answer' and 'end_session'"))
        return

    if permission == "see_answer":
        vctx.add_warning(location,
                _("Uses deprecated 'see_answer' permission--"