sandbox.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 collections.abc import Mapping
from typing import Any, cast

import django.forms as forms
from crispy_forms.layout import Submit
from django import http
from django.contrib import messages
from django.core.exceptions import PermissionDenied
from django.utils.safestring import mark_safe
from django.utils.translation import gettext, gettext_lazy as _

from course.constants import participation_permission as pperm
from course.content import FlowPageDesc
from course.utils import CoursePageContext, course_view, render_course_page


# {{{ for mypy


# }}}

# {{{ sandbox session key prefix

PAGE_SESSION_KEY_PREFIX = "cf_validated_sandbox_page"
ANSWER_DATA_SESSION_KEY_PREFIX = "cf_page_sandbox_answer_data"
PAGE_DATA_SESSION_KEY_PREFIX = "cf_page_sandbox_page_data"

# }}}


# {{{ sandbox form

class SandboxForm(forms.Form):
    # prevents form submission with codemirror's empty textarea
    use_required_attribute = False

    def __init__(self, initial_text: str | None,
            language_mode: str, interaction_mode: str, help_text: str,
            *args: Any, **kwargs: Any) -> None:
        super().__init__(*args, **kwargs)

        from crispy_forms.helper import FormHelper
        self.helper = FormHelper()
        self.helper.form_class = "form-horizontal"

        from course.utils import get_codemirror_widget
        cm_widget, cm_help_text = get_codemirror_widget(
                language_mode=language_mode,
                interaction_mode=interaction_mode,
                autofocus=True)

        self.fields["content"] = forms.CharField(
                required=False,
                initial=initial_text,
                widget=cm_widget,
                help_text=mark_safe(
                    help_text
                    + " "
                    + gettext("Press Alt/Cmd+(Shift+)P to preview.")
                    + " "
                    + cm_help_text),
                label=_("Content"),
                strip=False)

        self.helper.add_input(
                Submit("preview", _("Preview"), accesskey="p"),
                )
        self.helper.add_input(
                Submit("clear", _("Clear"), css_class="btn-secondary"),
                )

# }}}


# {{{ markup sandbox

@course_view
def view_markup_sandbox(pctx):
    if not pctx.has_permission(pperm.use_markup_sandbox):
        raise PermissionDenied()

    request = pctx.request
    preview_text = ""

    def make_form(data=None):
        help_text = (gettext('Enter <a href="http://documen.tician.de/'
                'relate/content.html#relate-markup">'
                "RELATE markup</a>."))
        return SandboxForm(
                None, "markdown", request.user.editor_mode,
                help_text,
                data)

    if request.method == "POST" and "preview" in request.POST:
        form = make_form(request.POST)

        if form.is_valid():
            from course.content import markup_to_html
            try:
                preview_text = markup_to_html(
                        pctx.course, pctx.repo, pctx.course_commit_sha,
                        form.cleaned_data["content"])
            except Exception:
                import sys
                tp, e, _ = sys.exc_info()

                messages.add_message(pctx.request, messages.ERROR,
                        gettext("Markup failed to render")
                        + ": "
                        + f"{tp.__name__}: {e}")

        form = make_form(request.POST)

    else:
        form = make_form()

    return render_course_page(pctx, "course/sandbox-markup.html", {
        "form": form,
        "preview_text": preview_text,
    })

# }}}


# {{{ page sandbox data retriever

def get_sandbox_data_for_page(
        pctx: CoursePageContext, page_desc: Any, key: str) -> Any:
    stored_data_tuple = pctx.request.session.get(key)

    # Session storage uses JSON and may turn tuples into lists.
    if (isinstance(stored_data_tuple, list | tuple)
            and len(stored_data_tuple) == 3):
        stored_data_page_type, stored_data_page_id, \
            stored_data = cast(tuple, stored_data_tuple)

        if (
                stored_data_page_type == page_desc.type
                and stored_data_page_id == page_desc.id):
            return stored_data

    return None

# }}}


# {{{ page sandbox form

class PageSandboxForm(SandboxForm):
    def __init__(self, initial_text: str | None,
            language_mode: str, interaction_mode: str, help_text: str,
            *args: Any, **kwargs: Any) -> None:
        super().__init__(
                initial_text, language_mode, interaction_mode, help_text,
                *args, **kwargs)

        self.helper.add_input(
                Submit("clear_response", _("Clear Response Data"),
                    css_class="btn-secondary"),
                )

# }}}


# {{{ page sandbox

def make_sandbox_session_key(prefix: str, course_identifier: str) -> str:
    return f"{prefix}:{course_identifier}"


def page_desc_from_yaml_string(pctx: CoursePageContext, source: str) -> FlowPageDesc:
    import yaml
    from pytools.py_codegen import remove_common_indentation

    from course.content import expand_yaml_macros
    from relate.utils import dict_to_struct
    new_page_source = remove_common_indentation(
            source, require_leading_newline=False)
    new_page_source = expand_yaml_macros(
            pctx.repo, pctx.course_commit_sha, new_page_source)

    yaml_data = yaml.safe_load(new_page_source)  # type: ignore
    return cast(FlowPageDesc, dict_to_struct(yaml_data))


@course_view
def view_page_sandbox(pctx: CoursePageContext) -> http.HttpResponse:

    if not pctx.has_permission(pperm.use_page_sandbox):
        raise PermissionDenied()

    from course.validation import ValidationError
    from relate.utils import Struct

    page_session_key = make_sandbox_session_key(
        PAGE_SESSION_KEY_PREFIX, pctx.course.identifier)
    answer_data_session_key = make_sandbox_session_key(
        ANSWER_DATA_SESSION_KEY_PREFIX, pctx.course.identifier)
    page_data_session_key = make_sandbox_session_key(
        PAGE_DATA_SESSION_KEY_PREFIX, pctx.course.identifier)

    request = pctx.request

    page_source = cast(str | None, pctx.request.session.get(page_session_key))

    page_errors = None
    page_warnings = None

    is_clear_post = (request.method == "POST" and "clear" in request.POST)
    is_clear_response_post = (request.method == "POST"
            and "clear_response" in request.POST)
    is_preview_post = (request.method == "POST" and "preview" in request.POST)

    def make_form(data: Mapping[str, Any] | None = None) -> PageSandboxForm:
        assert request.user.is_authenticated
        return PageSandboxForm(
                page_source, "yaml", request.user.editor_mode,
                gettext("Enter YAML markup for a flow page."),
                data)

    if is_preview_post:
        edit_form = make_form(pctx.request.POST)
        new_page_source = None

        if edit_form.is_valid():
            form_content = edit_form.cleaned_data["content"]
            try:
                page_desc = page_desc_from_yaml_string(pctx, form_content)

                if not isinstance(page_desc, Struct):
                    raise ValidationError("Provided page source code is not "
                            "a dictionary. Do you need to remove a leading "
                            "list marker ('-') or some stray indentation?")

                from course.validation import ValidationContext, validate_flow_page
                vctx = ValidationContext(
                        repo=pctx.repo,
                        commit_sha=pctx.course_commit_sha)

                validate_flow_page(vctx, "sandbox", page_desc)

                page_warnings = vctx.warnings

            except Exception:
                import sys
                tp, e, _ = sys.exc_info()

                page_errors = (
                        gettext("Page failed to load/validate")
                        + ": "
                        + f"{tp.__name__}: {e}")  # type: ignore

            else:
                # Yay, it did validate.
                request.session[page_session_key] = page_source = form_content

            del new_page_source
            del form_content

        edit_form = make_form(pctx.request.POST)

    elif is_clear_post:
        page_source = None
        pctx.request.session[page_data_session_key] = None
        pctx.request.session[answer_data_session_key] = None
        del pctx.request.session[page_data_session_key]
        del pctx.request.session[answer_data_session_key]
        edit_form = make_form()

    elif is_clear_response_post:
        page_source = None
        pctx.request.session[page_data_session_key] = None
        pctx.request.session[answer_data_session_key] = None
        del pctx.request.session[page_data_session_key]
        del pctx.request.session[answer_data_session_key]
        edit_form = make_form(pctx.request.POST)

    else:
        edit_form = make_form()

    have_valid_page = page_source is not None
    if have_valid_page:
        assert page_source is not None
        page_desc = page_desc_from_yaml_string(pctx, page_source)

        from course.content import instantiate_flow_page
        try:
            page = instantiate_flow_page("sandbox", pctx.repo, page_desc,
                    pctx.course_commit_sha)
        except Exception:
            import sys
            tp, e, _ = sys.exc_info()

            page_errors = (
                    gettext("Page failed to load/validate")
                    + ": "
                    + f"{tp.__name__}: {e}")  # type: ignore
            have_valid_page = False

    if have_valid_page:
        page_desc = cast(FlowPageDesc, page_desc)

        # Try to recover page_data, answer_data
        page_data = get_sandbox_data_for_page(
                pctx, page_desc, page_data_session_key)

        answer_data = get_sandbox_data_for_page(
                pctx, page_desc, answer_data_session_key)

        from course.models import FlowSession
        from course.page import PageContext
        page_context = PageContext(
                course=pctx.course,
                repo=pctx.repo,
                commit_sha=pctx.course_commit_sha,

                # This helps code pages retrieve the editor pref.
                flow_session=FlowSession(
                    course=pctx.course,
                    participation=pctx.participation),

                in_sandbox=True)

        if page_data is None:
            page_data = page.initialize_page_data(page_context)
            pctx.request.session[page_data_session_key] = (
                    page_desc.type, page_desc.id, page_data)

        title = page.title(page_context, page_data)
        body = page.body(page_context, page_data)

        feedback = None
        page_form_html = None

        if page.expects_answer():
            from course.page.base import PageBehavior
            page_behavior = PageBehavior(
                    show_correctness=True,
                    show_answer=True,
                    may_change_answer=True)

            if request.method == "POST" and not is_preview_post:
                page_form = page.process_form_post(page_context, page_data,
                        request.POST, request.FILES,
                        page_behavior)

                if page_form.is_valid():

                    answer_data = page.answer_data(page_context, page_data,
                            page_form, request.FILES)

                    feedback = page.grade(page_context, page_data, answer_data,
                            grade_data=None)

                    pctx.request.session[answer_data_session_key] = (
                            page_desc.type, page_desc.id, answer_data)

            else:
                try:
                    page_form = page.make_form(page_context, page_data,
                            answer_data, page_behavior)

                except Exception:
                    import sys
                    tp, e, _ = sys.exc_info()

                    page_errors = (
                            gettext("Page failed to load/validate "
                                "(change page ID to clear faults)")
                            + ": "
                            + f"{tp.__name__}: {e}")  # type: ignore

                    page_form = None

            if page_form is not None:
                page_form.helper.add_input(
                        Submit("submit",
                            gettext("Submit answer"),
                            accesskey="g"))
                page_form_html = page.form_to_html(
                        pctx.request, page_context, page_form, answer_data)

        correct_answer = page.correct_answer(
                page_context, page_data, answer_data,
                grade_data=None)

        have_valid_page = have_valid_page and not page_errors

        return render_course_page(pctx, "course/sandbox-page.html", {
            "edit_form": edit_form,
            "page_errors": page_errors,
            "page_warnings": page_warnings,
            "form": edit_form,  # to placate form.media
            "have_valid_page": have_valid_page,
            "title": title,
            "body": body,
            "page_form_html": page_form_html,
            "feedback": feedback,
            "correct_answer": correct_answer,
        })

    else:

        return render_course_page(pctx, "course/sandbox-page.html", {
            "edit_form": edit_form,
            "form": edit_form,  # to placate form.media
            "have_valid_page": have_valid_page,
            "page_errors": page_errors,
            "page_warnings": page_warnings,
        })

# }}}


# vim: foldmethod=marker