controller.php

<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**
 *
 * @package   mod_cardbox
 * @copyright 2019 RWTH Aachen (see README.md)
 * @author    Anna Heynkes
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
defined('MOODLE_INTERNAL') || die();
define ('ENABLE_AUTOCORRECT', 0);
define ('DISABLE_AUTOCORRECT', 1);
define ('LONG_DESCRIPTION', 1);
define ('SHORT_DESCRIPTION', 0);


require_once($CFG->dirroot.'/mod/cardbox/locallib.php');

if (!isset($action)) {
    $action = required_param('action', PARAM_ALPHA);
}

/* *********************************************** Add a new flashcard *********************************************** */

if ($action === 'addflashcard') {

    require_once('card_form.php');
    $PAGE->set_url('/mod/cardbox/view.php', array('id' => $cm->id, 'action' => 'addflashcard'));
    $returnurl = new moodle_url('/mod/cardbox/view.php', array('id' => $cmid, 'action' => 'practice'));
    $actionurl = new moodle_url('/mod/cardbox/view.php', array('id' => $cmid, 'action' => 'addflashcard'));

    $stringman = get_string_manager();
    $strings = $stringman->load_component_strings('cardbox', 'en'); // Method gets the strings of the language files.
    $PAGE->requires->strings_for_js(array_keys($strings), 'cardbox'); // Method to use the language-strings in javascript.
    $PAGE->requires->js(new moodle_url("/mod/cardbox/js/addcard.js?ver=00001"));
    $params = array($cmid, 1, null); // true means: the user checks their own results.
    $PAGE->requires->js_init_call('addCard', $params, true);

    // Contextual data to pass on to the card form.
    if (empty($entry)) {
        $entry = new stdClass();
        $entry->id = $cmid;
        $entry->course = $cm->course;
        $entry->action = $action;
    }

    $options = array('subdirs' => 0, 'maxbytes' => 0, 'areamaxbytes' => 10485760, 'maxfiles' => 3,
                          'accepted_types' => array('bmp', 'gif', 'jpeg', 'jpg', 'png', 'svg'), 'return_types' => 1 | 2);
    $component = 'mod_cardbox';
    $filearea = 'content';

    $customdata = array('cardboxid' => $cardbox->id, 'cmid' => $cmid, 'allowautocorrection' => $cardbox->autocorrection);
    $mform = new mod_cardbox_card_form(null, $customdata);
    $mform->set_data($entry);

    if ($mform->is_cancelled()) {

        if (has_capability('mod/cardbox:practice', $context)) { // for students and other participants.
            $action = 'practice';

        } else if (has_capability('mod/cardbox:approvecard', $context)) {
            $action = 'review';

        } else { // for guests.
            redirect($actionurl, '');
        }

        // If submitted: get files from filemanager.
    } else if ($formdata = $mform->get_data()) {

        if (!empty($formdata->submitbutton)) {
            $submitbutton = $formdata->submitbutton;
        } else {
            $submitbutton = null;
        }

        // Create or select a topic for the card.
        switch ($formdata->topic) {
            case -1: // Card belongs to no topic.
                $topicid = null;
                break;
            case 0: // Card belongs to a new topic that is to be created.
                if (!empty($formdata->newtopic)) {
                    $topicid = cardbox_save_new_topic($formdata->newtopic, $cardbox->id);
                } else {
                    $topicid = null;
                }
                break;
            default: // Card belongs to an already existing topic.
                $topicid = $formdata->topic;
        }

        $necessaryanswerslocked = $DB->get_field('cardbox', 'necessaryanswerslocked',
                                        array('id' => $customdata['cardboxid']), IGNORE_MISSING);
        if (!empty($formdata->answers)) {
            $necessaryanswers = $formdata->answers;
        } else if ($necessaryanswerslocked === "1") {
            $necessaryanswers = $DB->get_field('cardbox', 'necessaryanswers',
                                       array('id' => $customdata['cardboxid']), IGNORE_MISSING);
        } else {
            $necessaryanswers = CARDBOX_EVALUATE_ALL;
        }
        if ($formdata->disableautocorrect == DISABLE_AUTOCORRECT) {
            $disableautocorrect = true;
        } else {
            $disableautocorrect = false;
        }
        // Create a new entry in cardbox_cards table.
        $cardid = cardbox_save_new_card($cardbox->id, $submitbutton, $context, $topicid, $necessaryanswers, $disableautocorrect);

        // Save the question text if there is any.
        if (!empty($formdata->question['text'])) {
            cardbox_save_new_cardcontent($cardid, 0, CARDBOX_CONTENTTYPE_TEXT, CARD_MAIN_INFORMATION, $formdata->question['text']);
        }
        // Save the text of the answer/s.

        for ($i = 1; $i <= 10; $i++) {
            $answer = 'answer'. $i;
            if ($formdata->{$answer}['text'] != "") {
                cardbox_save_new_cardcontent($cardid, 1, CARDBOX_CONTENTTYPE_TEXT, CARD_MAIN_INFORMATION,
                                            $formdata->{$answer}['text']);
            }
        }

        // Save the questioncontext text if there is any.
        if (!empty($formdata->questioncontext['text'])) {
            cardbox_save_new_cardcontent($cardid, 0, CARDBOX_CONTENTTYPE_TEXT, CARD_CONTEXT_INFORMATION,
                                         $formdata->questioncontext['text']);
        }

        // Save the questioncontext text if there is any.
        if (!empty($formdata->answercontext['text'])) {
            cardbox_save_new_cardcontent($cardid, 1, CARDBOX_CONTENTTYPE_TEXT, CARD_CONTEXT_INFORMATION,
                                         $formdata->answercontext['text']);
        }

        // Get the draft itemid (Files in the drag-and-drop area are automatically saved as drafts in mdl_files even before the form is submitted).
        $draftitemid = file_get_submitted_draft_itemid('cardimage');

        // Copy all the files from the 'real' area, into the draft area.
        file_prepare_draft_area($draftitemid, $context->id, $component, $filearea, 0, array('subdirs' => true));

        // Save the file.
        if ($draftitemid != null) {
            $fs = get_file_storage();
            $usercontext = context_user::instance($USER->id);
            if ($files = $fs->get_area_files($usercontext->id, 'user', 'draft', $draftitemid, 'sortorder, id', false)) {
                foreach ($files as $file) {
                    // Save a reference to the image data in cardbox_cardcontents.
                    $itemid = cardbox_save_new_cardcontent($cardid, 0, CARDBOX_CONTENTTYPE_IMAGE, CARD_MAIN_INFORMATION,
                                                           $file->get_filename());
                    // Save the actual image data in moodle.
                    file_save_draft_area_files($draftitemid, $context->id, $component, $filearea, $itemid, $options);
                    break;
                }
            }
            // Save the imagedescription if there is any.
            if (!empty($formdata->imagedescription)) {
                cardbox_save_new_cardcontent($cardid, 0, CARDBOX_CONTENTTYPE_IMAGE, CARD_IMAGEDESCRIPTION_INFORMATION,
                                             $formdata->imagedescription);
            }
        }
        // Get the draft itemid (Files in the drag-and-drop area are automatically saved as drafts in mdl_files even before the form is submitted).
        $draftitemidaudio = file_get_submitted_draft_itemid('cardsound');

        // Copy all the audio files from the 'real' area, into the draft area.
        file_prepare_draft_area($draftitemidaudio, $context->id, $component, $filearea, 0, array('subdirs' => true));

        // Save the audio file.
        if ($draftitemidaudio != null) {
            $fs = get_file_storage();
            $usercontext = context_user::instance($USER->id);
            if ($files = $fs->get_area_files($usercontext->id, 'user', 'draft', $draftitemidaudio, 'sortorder, id', false)) {
                foreach ($files as $file) {
                    // Save a reference to the image data in cardbox_cardcontents.
                    $itemidaudio = cardbox_save_new_cardcontent($cardid, 0, CARDBOX_CONTENTTYPE_AUDIO, CARD_MAIN_INFORMATION,
                                                                $file->get_filename());
                    // Save the actual image data in moodle.
                    file_save_draft_area_files($draftitemidaudio, $context->id, $component, $filearea, $itemidaudio, $options);
                    break;
                }
            }
        }
        // Get the draft itemid.
        // (Files in the drag-and-drop area are automatically saved as drafts in mdl_files even before the form is submitted).
        $draftitemid3 = file_get_submitted_draft_itemid('answerimage');

        // Copy all the files from the 'real' area, into the draft area.
        file_prepare_draft_area($draftitemid3, $context->id, $component, $filearea, 0, array('subdirs' => true));

        // Save the file.
        if ($draftitemid3 != null) {
            $fs = get_file_storage();
            $usercontext = context_user::instance($USER->id);
            if ($files = $fs->get_area_files($usercontext->id, 'user', 'draft', $draftitemid3, 'sortorder, id', false)) {
                foreach ($files as $file) {
                    // Save a reference to the image data in cardbox_cardcontents.
                    $itemid3 = cardbox_save_new_cardcontent($cardid, 1, CARDBOX_CONTENTTYPE_IMAGE, CARD_MAIN_INFORMATION,
                                                            $file->get_filename());
                    // Save the actual image data in moodle.
                    file_save_draft_area_files($draftitemid3, $context->id, $component, $filearea, $itemid3, $options);
                    break;
                }
            }
        }

        // Get the draft itemid.
        // (Files in the drag-and-drop area are automatically saved as drafts in mdl_files even before the form is submitted).
        $draftitemid4 = file_get_submitted_draft_itemid('answersound');
        // Copy all the audio files from the 'real' area, into the draft area.
        file_prepare_draft_area($draftitemid2, $context->id, $component, $filearea, 0, array('subdirs' => true));
        // Save the audio file.
        if ($draftitemid2 != null) {
            $fs = get_file_storage();
            $usercontext = context_user::instance($USER->id);
            if ($files = $fs->get_area_files($usercontext->id, 'user', 'draft', $draftitemid4, 'sortorder, id', false)) {
                foreach ($files as $file) {
                    // Save a reference to the image data in cardbox_cardcontents.
                    $itemid4 = cardbox_save_new_cardcontent($cardid, 1, CARDBOX_CONTENTTYPE_AUDIO, CARD_MAIN_INFORMATION,
                                                            $file->get_filename());
                    // Save the actual image data in moodle.
                    file_save_draft_area_files($draftitemid4, $context->id, $component, $filearea, $itemid4, $options);
                    break;
                }
            }
        }

        if (!empty($submitbutton) && $submitbutton == get_string('saveandaccept', 'cardbox') && has_capability('mod/cardbox:approvecard', $context)) {
            $message = get_string('success:addandapprovenewcard', 'cardbox');
        } else {
            $message = get_string('success:addnewcard', 'cardbox');
        }

        redirect($actionurl, $message, null, \core\output\notification::NOTIFY_INFO);
        // TODO: check for errors, validate form.

    } else {

        $PAGE->set_url('/mod/cardbox/view.php', array('id' => $cm->id, 'action' => 'addflashcard'));
        echo $OUTPUT->header(); // Display course name, navigation bar at the very top and "Dashboard->...->..." bar.

        if ($mform->is_submitted() && empty($mform->is_validated())) {
            $info = get_string('error:createcard', 'cardbox');
            echo "<span class='notification alert alert-danger alert-block fade in' role='alert' style='display:block'>" . $info . "</span>";
        }
        echo $OUTPUT->heading(format_string($cardbox->name));
        echo $myrenderer->cardbox_render_tabs($taburl, $action, $context);
        $mform->display();
    }

}

/* ************************************************ Edit a flashcard ************************************************* */

if ($action === 'editcard') {

    require_capability('mod/cardbox:approvecard', $context);

    require_once('card_form.php');

    $cardid = required_param('cardid', PARAM_INT);
    $nextcardid = optional_param('next', 0, PARAM_INT);

    $from = optional_param('from', 'review', PARAM_ALPHA);

    if ($from === 'review') {
        $returnurl = new moodle_url('/mod/cardbox/view.php', array('id' => $cmid, 'action' => 'review'));
    } else {
        $returnurl = new moodle_url('/mod/cardbox/view.php', array('id' => $cmid, 'action' => 'overview'));
    }

    $actionurl = $returnurl;

    $draftitemid = file_get_submitted_draft_itemid('cardimage'); // name of the filemanager element
    $itemid = $DB->get_field('cardbox_cardcontents', 'id', array('card' => $cardid, 'contenttype' => CARDBOX_CONTENTTYPE_IMAGE), IGNORE_MISSING);

    $draftitemid2 = file_get_submitted_draft_itemid('cardsound'); // name of the filemanager element
    $itemid2 = $DB->get_field('cardbox_cardcontents', 'id', array('card' => $cardid, 'contenttype' => CARDBOX_CONTENTTYPE_AUDIO), IGNORE_MISSING);

    $answers = [];
    $topic = cardbox_get_topic($cardid);
    $answers = cardbox_get_answers($cardid);
    $answersnotapproved = cardbox_get_notapproved_answers($cardid);
    $answers = array_merge($answers, $answersnotapproved);
    $answercount = count($answers);
    $necessaryanswers = cardbox_get_necessaryanswers($cardid);
    $disableautocorrect = $DB->get_field('cardbox_cards', 'disableautocorrect', array('id' => $cardid), IGNORE_MISSING);

    $customdata = array('topic' => $topic, 'answercount' => $answercount, 'cardboxid' => $cardbox->id, 'cmid' => $cmid,
    'answers' => $necessaryanswers, 'cardid' => $cardid, 'from' => $from, 'allowautocorrection' => $disableautocorrect);
    $mform = new mod_cardbox_card_form($actionurl, $customdata);

    $options = array('subdirs' => 0, 'maxbytes' => 0, 'areamaxbytes' => 10485760, 'maxfiles' => 3,
                          'accepted_types' => array('bmp', 'gif', 'jpeg', 'jpg', 'png', 'svg'),
                          'return_types' => FILE_INTERNAL | FILE_EXTERNAL);
    $component = 'mod_cardbox';
    $filearea = 'content';
    // Copy the picture file (if there is on) from the 'real' area into the draft area.
    if (!empty($itemid)) {
        file_prepare_draft_area($draftitemid, $context->id, $component, $filearea, $itemid, $options);
    }

    // Copy the audio file (if there is on) from the 'real' area into the draft area.
    if (!empty($itemid2)) {
        file_prepare_draft_area($draftitemid2, $context->id, $component, $filearea, $itemid2, $options);
    }

    // Pass the data of this card to the card_form for editing.
    if (empty($entry)) {
        $entry = new stdClass();
        $entry->id = $cmid;
        $entry->course = $cm->course;
        $entry->cardid = $cardid;
        $entry->question['text'] = cardbox_get_questiontext($cardid);
        $entry->question['format'] = '1';
        $entry->questioncontext['text'] = cardbox_get_questioncontext($cardid);
        $entry->answercontext['text'] = cardbox_get_answercontext($cardid);
        for ($i = 1; $i <= $answercount; $i++) {
            $answer = 'answer' . $i;
            $entry->{$answer}['text'] = $answers[($i - 1)];
            $entry->{$answer}['format'] = '1';
            $entry->from = $from;
        }
        $entry->cardimage = $draftitemid;
        $entry->imagedescription = cardbox_get_imagedescription($cardid);
        $entry->cardsound = $draftitemid2;
        $entry->action = 'editcard';
        $entry->next = $nextcardid;
        $entry->disableautocorrect = $disableautocorrect;
    }
    $mform->set_data($entry);

    if ($mform->is_cancelled()) {

        if ($from === "review") {
            $action = 'review';
        } else {
            $action = 'overview';
        }
    } else if ($formdata = $mform->get_data()) {
        // If submitted: get files from filemanager.
        if (!empty($formdata->submitbutton)) {
            $submitbutton = $formdata->submitbutton;
        } else {
            $submitbutton = null;
        }

        // Create or select a topic for the card.
        switch ($formdata->topic) {
            case -1: // Card belongs to no topic.
                $topicid = null;
                break;
            case 0: // Card belongs to a new topic that is to be created.
                if (!empty($formdata->newtopic)) {
                    $topicid = cardbox_save_new_topic($formdata->newtopic, $cardbox->id);
                } else {
                    $topicid = null;
                }
                break;
            default: // Card belongs to an already existing topic.
                $topicid = $formdata->topic;
        }
        $necessaryanswerslocked = $DB->get_field('cardbox', 'necessaryanswerslocked', array('id' => $customdata['cardboxid']), IGNORE_MISSING);
        if (!empty($formdata->answers)) {
            $necessaryanswers = $formdata->answers;
        } else if ($necessaryanswerslocked === "1") {
            $necessaryanswers = $DB->get_field('cardbox', 'necessaryanswers', array('id' => $customdata['cardboxid']), IGNORE_MISSING);
        } else {
            $necessaryanswers = CARDBOX_EVALUATE_ALL;
        }
        if ($formdata->disableautocorrect == DISABLE_AUTOCORRECT) {
            $disableautocorrect = true;
        } else {
            $disableautocorrect = false;
        }

        if ($formdata->disableautocorrect == DISABLE_AUTOCORRECT) {
            $disableautocorrect = true;
        } else {
            $disableautocorrect = false;
        }

        // Update the entry in cardbox_cards table and delete the original content items.
        $success = cardbox_edit_card($cardid, $topicid, $submitbutton, $context, $necessaryanswers, $disableautocorrect);

        // TODO: Fehlerbehandlung.

        // Save the question text if there is any.
        if (!empty($formdata->question)) {
            cardbox_save_new_cardcontent($cardid, 0, CARDBOX_CONTENTTYPE_TEXT, CARD_MAIN_INFORMATION, $formdata->question['text']);
        }
        // Save the text of the answer/s.
        for ($i = 1; $i <= 10; $i++) {
            $answer = 'answer'. $i;
            if ($formdata->{$answer}['text'] != "") {
                cardbox_save_new_cardcontent($cardid, 1, CARDBOX_CONTENTTYPE_TEXT, CARD_MAIN_INFORMATION,
                                             $formdata->{$answer}['text']);
            }
        }

        // Save the questioncontext text if there is any.
        if (!empty($formdata->questioncontext['text'])) {
            cardbox_save_new_cardcontent($cardid, 0, CARDBOX_CONTENTTYPE_TEXT, CARD_CONTEXT_INFORMATION,
                                         $formdata->questioncontext['text']);
        }
        // Save the answercontext text of the answer/s.
        if (!empty($formdata->answercontext['text'])) {
            cardbox_save_new_cardcontent($cardid, 1, CARDBOX_CONTENTTYPE_TEXT, CARD_CONTEXT_INFORMATION,
                                         $formdata->answercontext['text']);
        }

        // Get the draft itemid (Files in the drag-and-drop area are automatically saved as drafts in mdl_files even before the form is submitted).
        $draftitemid = file_get_submitted_draft_itemid('cardimage');

        // Copy all the files from the 'real' area, into the draft area.
        file_prepare_draft_area($draftitemid, $context->id, $component, $filearea, 0, array('subdirs' => true));
        // Save the file.
        if ($draftitemid != null) {
            $fs = get_file_storage();
            $usercontext = context_user::instance($USER->id);
            if ($files = $fs->get_area_files($usercontext->id, 'user', 'draft', $draftitemid, 'sortorder, id', false)) {
                foreach ($files as $file) {
                    // Save a reference to the image data in cardbox_cardcontents.
                    $itemid = cardbox_save_new_cardcontent($cardid, 0, CARDBOX_CONTENTTYPE_IMAGE, CARD_MAIN_INFORMATION, $file->get_filename());
                    // Save the actual image data in moodle.
                    file_save_draft_area_files($draftitemid, $context->id, $component, $filearea, $itemid, $options);
                    break;
                }
            }
            // Save the imagedescription if there is any.
            if (!empty($formdata->imagedescription)) {
                cardbox_save_new_cardcontent($cardid, 0, CARDBOX_CONTENTTYPE_IMAGE, CARD_IMAGEDESCRIPTION_INFORMATION, $formdata->imagedescription);
            }
        }

        // Get the draft itemid.
        // (Files in the drag-and-drop area are automatically saved as drafts in mdl_files even before the form is submitted).
        $draftitemid2 = file_get_submitted_draft_itemid('cardsound');
        // Copy all the audio files from the 'real' area, into the draft area.
        file_prepare_draft_area($draftitemid2, $context->id, $component, $filearea, 0, array('subdirs' => true));
        // Save the audio file.
        if ($draftitemid2 != null) {
            $fs = get_file_storage();
            $usercontext = context_user::instance($USER->id);
            if ($files = $fs->get_area_files($usercontext->id, 'user', 'draft', $draftitemid2, 'sortorder, id', false)) {
                foreach ($files as $file) {
                    // Save a reference to the image data in cardbox_cardcontents.
                    $itemid2 = cardbox_save_new_cardcontent($cardid, 0, CARDBOX_CONTENTTYPE_AUDIO, CARD_MAIN_INFORMATION,
                                                            $file->get_filename());
                    // Save the actual image data in moodle.
                    file_save_draft_area_files($draftitemid2, $context->id, $component, $filearea, $itemid2, $options);
                    break;
                }
            }
        }

        if ($from === 'overview') { // If the card had already been approved and has possibly been practiced.
            cardbox_send_change_notification($cmid, $cardbox, $cardid);
        }

        if (!empty($nextcardid) && $submitbutton == get_string('saveandaccept', 'cardbox') && has_capability('mod/cardbox:approvecard', $context)) {
            $cardid = $nextcardid;
        }

        $action = $from;

    } else {

        $PAGE->set_url('/mod/cardbox/view.php', array('id' => $cm->id, 'action' => 'editcard', 'from' => $from));
        echo $OUTPUT->header(); // Display course name, navigation bar at the very top and "Dashboard->...->..." bar.

        if ($mform->is_submitted() && empty($mform->is_validated())) {
            $info = get_string('error:createcard', 'cardbox');
            echo "<span class='notification alert alert-danger alert-block fade in' role='alert' style='display:block'>" . $info . "</span>";
        }

        // Javacript information.

        $data = array();
        $data['showquescontext'] = ($entry->questioncontext['text'] != "");
        $data['showanscontext'] = ($entry->answercontext['text'] != "");
        $data['showquesimage'] = ($entry->cardimage != 0);
        $data['showquessound'] = ($entry->cardsound != 0);

        $stringman = get_string_manager();
        $strings = $stringman->load_component_strings('cardbox', 'en'); // Method gets the strings of the language files.
        $PAGE->requires->strings_for_js(array_keys($strings), 'cardbox'); // Method to use the language-strings in javascript.
        $PAGE->requires->js(new moodle_url("/mod/cardbox/js/addcard.js?ver=00001"));
        $params = array($cmid, $answercount, $data); // True means: the user checks their own results.
        $PAGE->requires->js_init_call('addCard', $params, true);

        echo $OUTPUT->heading(get_string('titleforcardedit', 'cardbox'));

        if ($from === "overview") {
            echo $myrenderer->cardbox_render_tabs($taburl, 'overview', $context);
        } else {
            echo $myrenderer->cardbox_render_tabs($taburl, 'review', $context);
        }

        $mform->display();

    }

}

/* **************************************************** Delete cards **************************************************** */

if ($action === 'deletecard') {

    require_capability('mod/cardbox:deletecard', $context);

    $cardid = required_param('cardid', PARAM_INT);
    if ($DB->record_exists('cardbox_cards', ['id' => $cardid])) {
        $DB->delete_records('cardbox_cards', ['id' => $cardid]);
        $DB->delete_records('cardbox_cardcontents', ['card' => $cardid]);
        $DB->delete_records('cardbox_progress', ['card' => $cardid]);
    }
    $action = 'overview';

}
/* **************************************************** Delete cards from review **************************************************** */
if ($action === 'rejectcard') {

    require_capability('mod/cardbox:approvecard', $context);

    $cardids = required_param('cardid', PARAM_TEXT);
    foreach ((explode(",", $cardids)) as $cardid) {
        if (strpos($cardid, "-") != false) {
            $pos = strpos($cardid, "-");
            $content = substr($cardid, ($pos + 1));
            $idcard = substr($cardid, 0, $pos);
            $sugg = $DB->get_records_select('cardbox_cardcontents', 'card = :id AND cardside = :cardside AND area = 3' ,
            ['id' => $idcard, 'cardside' => CARDBOX_CARDSIDE_ANSWER], '', 'id, content');
            foreach ($sugg as $sug) {
                if (strip_tags(str_replace(" ", "", $sug->content)) === $content) {
                    $id = $sug->id;
                }
            }
            $DB->delete_records('cardbox_cardcontents', ['card' => $idcard, 'area' => 3, 'id' => $id]);
        } else if ($DB->record_exists('cardbox_cards', ['id' => $cardid])) {
            $DB->delete_records('cardbox_cards', ['id' => $cardid]);
            $DB->delete_records('cardbox_cardcontents', ['card' => $cardid]);
        }
    }
    $action = 'review';

}

/* **************************************************** Practice cards **************************************************** */

if ($action === 'practice') {

    require_once('model/cardbox.class.php');
    require_once('model/card_selection_algorithm.php');
    require_once('model/card_sorting_algorithm.php');

    $PAGE->set_url('/mod/cardbox/view.php', array('id' => $cm->id, 'action' => 'practice'));
    echo $OUTPUT->header();
    echo $OUTPUT->heading(format_string($cardbox->name));
    echo $myrenderer->cardbox_render_tabs($taburl, $action, $context);

    $renderer = $PAGE->get_renderer('mod_cardbox');

    $startnow = optional_param('start', false, PARAM_BOOL);
    $correction = optional_param('mode', 0, PARAM_INT); // Automatic check against solution (default) or self check.
    $topic = optional_param('topic', null, PARAM_INT); // Topic to prioritize.
    $onlyonetopic = optional_param('onlyonetopic', -1, PARAM_INT); // Topic to study.
    $practiceall = optional_param('practiceall', true, PARAM_BOOL);
    $amountcards = optional_param('amountcards', 0, PARAM_INT); // Topic to prioritize.
    $openmodal = true;

    // 1. Create a virtual cardbox for this practice session, i.e. create the model.
    $select = new cardbox_card_selection_algorithm($topic, $practiceall, $onlyonetopic);
    $sort = new cardbox_card_sorting_algorithm();
    $cardboxmodel = new cardbox_cardboxmodel($cardbox->id, $select, $sort, $onlyonetopic);

    $cardcount = $cardboxmodel->cardbox_count_cards();
    $duecardcount = $cardboxmodel->cardbox_count_due_cards();

    // Inform the user that their cardbox is empty.
    if (empty($cardcount)) {

        $info = get_string('info:nocardsavailable', 'cardbox');
        $help = $OUTPUT->help_icon('help:nocardsavailable', 'cardbox');
        echo "<span class='notification alert alert-info alert-block fade in' role='alert' style='display:block'>" . $info . " " . $help . "</span>";
        return;
    } else if ($cardcount == $cardboxmodel->cardbox_count_mastered_cards()) {
        // Inform the user that all of their cards have the status 'mastered' and are no longer repeated.
        $info = get_string('info:nocardsavailableforpractice', 'cardbox');
        $help = $OUTPUT->help_icon('help:nocardsavailableforpractice', 'cardbox');
        echo "<span class='notification alert alert-info alert-block fade in' role='alert' style='display:block'>" . $info . " " . $help . "</span>";
        return;
    } else if (empty($duecardcount) && !$startnow) {
        // Inform the user that none of their cards are due for practice right now.
        $infopart1 = get_string('info:nocardsdueforpractice', 'cardbox');
        $infopart2 = get_string('help:practiceanyway', 'cardbox');
        $help = $OUTPUT->help_icon('help:nocardsdueforpractice', 'cardbox');
        echo "<span id='nocardsduenotification' class='notification alert alert-info alert-block fade in' role='alert' style='display:block'>" .
             $infopart1 . " " . $help . "<br>" . $infopart2 . "</span>";
        $openmodal = false;
    }

    if ($startnow && !( empty($duecardcount) &&  $practiceall == false)) {

        require_once($CFG->dirroot . '/mod/cardbox/classes/output/practice.php');

        $selection = $cardboxmodel->cardbox_get_card_selection($amountcards);
        $autocorrectval = [];
        foreach ($selection as $card) {
            $acvalue = $DB->get_record('cardbox_cards', array('id' => $card));
            array_push($autocorrectval, $card.'_'.$acvalue->disableautocorrect);
        }
        // 2. Create a view controller.
        if ($correction % 2 == 0) {
            $case = 2; // Automatic Check.
        } else {
            $case = 1;
        }
        /*$cardstatus = $DB->get_record('cardbox_cards', array('id' => $selection[0]));
        if ($cardstatus->disableautocorrect) {
            $case = 1;
        }*/
        $practice = new cardbox_practice($case, $context, $selection[0], count($selection), !$correction);
        $data = $practice->export_for_template($renderer);

        // 3. Give javascript access to the language string repository and to the relevant model data and add it to the page.
        $stringman = get_string_manager();
        $strings = $stringman->load_component_strings('cardbox', 'en'); // Method gets the strings of the language files.
        $PAGE->requires->strings_for_js(array_keys($strings), 'cardbox'); // Method to use the language-strings in javascript.
        $PAGE->requires->js(new moodle_url("/mod/cardbox/js/Chart.bundle.js"));
        $PAGE->requires->js(new moodle_url("/mod/cardbox/js/practice.js?ver=00023"));
        $params = array($cmid, $selection, $case, $data, $correction, $autocorrectval); // true means: the user checks their own results.
        $PAGE->requires->js_init_call('startPractice', $params, true);

        // 3. Render the page.
        echo $renderer->cardbox_render_practice($practice);

    } else { // Render a modal dialogue that asks the user to select their practice preferences.

        require_once($CFG->dirroot . '/mod/cardbox/classes/output/start.php');

        $PAGE->requires->js(new moodle_url("/mod/cardbox/js/start.js?ver=00005"));
        $PAGE->requires->js_init_call('startOptions', array($cmid, $openmodal), true);

        $start = new cardbox_start($cardbox->autocorrection, $cardbox->id);

        echo $renderer->cardbox_render_practice_start($start);

    }

}

/* **************************************************** View progress **************************************************** */

if ($action === 'statistics') {

    require_once('model/cardbox.class.php');
    require_once('model/card_selection_algorithm.php');
    require_once($CFG->dirroot . '/mod/cardbox/classes/output/statistics.php');

    $PAGE->set_url('/mod/cardbox/view.php', array('id' => $cm->id, 'action' => 'statistics'));
    echo $OUTPUT->header();
    echo $OUTPUT->heading(format_string($cardbox->name));
    echo $myrenderer->cardbox_render_tabs($taburl, $action, $context);


    $renderer = $PAGE->get_renderer('mod_cardbox');
    $params = [];
    $params['ismanager'] = $ismanager = has_capability('mod/cardbox:approvecard', $context);
    if ($ismanager) {
        $params['absoluteboxcount'] = get_absolute_cardcounts_per_deck($cardbox->id);
    } else {
        $info = get_string('info:statisticspage', 'cardbox');
        $help = $OUTPUT->help_icon('help:whenarecardsdue', 'cardbox');
        echo "<span id='nocardsduenotification' class='notification alert alert-info alert-block fade in' role='alert' style='display:block'>" .
             $info . " " . $help . "</span>";
        // 1. Create a virtual cardbox for this user, i.e. create the model.
        $select = new cardbox_card_selection_algorithm(null, true);
        $cardboxmodel = new cardbox_cardboxmodel($cardbox->id, $select);
        $params['studentboxcount'] = $cardboxmodel->cardbox_get_status();
        if (cardbox_statistics::is_enrolled_students_threshold_reached($cardbox->id)) {
            $params['averageboxcount'] = get_average_cardcounts_per_deck($cardbox->id);
        }
    }
    // 2. Create a view controller.
    $statistics = new cardbox_statistics($cardbox->id, $ismanager); // XXX auch hier das cardboxmodel nutzen.
    $params['performance'] = $statistics->export_for_template($renderer);
    // 3. Give javascript access to the language string repository and to the relevant model data and add it to the page.
    $stringman = get_string_manager();
    $strings = $stringman->load_component_strings('cardbox', 'en'); // Method gets the strings of the language files.
    $PAGE->requires->strings_for_js(array_keys($strings), 'cardbox'); // Method to use the language-strings in javascript.
    $PAGE->requires->js(new moodle_url("/mod/cardbox/js/Chart.bundle.js"));
    $PAGE->requires->js(new moodle_url("/mod/cardbox/js/statistics.js?ver=00008"));
    $PAGE->requires->js_init_call('displayCharts', [$params], true);

    // 4. Render the page.
    echo $renderer->cardbox_render_statistics($statistics);

}
/* **************************************************** Bulk Import Cards ****************************************************** */

if ($action === 'massimport') {
    $returnurl = new moodle_url('/mod/cardbox/view.php', array('id' => $cmid, 'action' => 'massimport'));

    $step = optional_param('step', 1, PARAM_INT);
    if (!empty($cancelclicked)) {
        echo "<span id='cardbox-review-notification' class='notification'><div class='alert alert-info alert-block fade in' role='alert'>" . $cancelclicked. "</div></span>";
    }
    if ($step == 1) {
        // Data provision.
        $customdata = array('cardboxid' => $cardbox->id, 'cmid' => $cmid, 'context' => $context);
        $mform = new \mod_cardbox\output\massimport_form(null, $customdata);
        if ($formdata = $mform->get_data()) {

            // Store csv content in moodledata/temp for next step.
            $iid = csv_import_reader::get_new_iid('cardbox');
            $csvcontent = $mform->get_file_content('cardimportfile'); // Full content of the file.
            $cir = new csv_import_reader($iid, 'cardbox');
            $readcount = $cir->load_csv_content($csvcontent, $formdata->encoding, $formdata->delimiter_name);
            $csvloaderror = $cir->get_error();
            if (!is_null($csvloaderror)) {
                print_error('csvloaderror', '', $returnurl, $csvloaderror);
            }
            if ($readcount > 1) {
                // Show csv content preview.
                $PAGE->set_url('/mod/cardbox/view.php', array('id' => $cmid, 'action' => 'massimport'));
                echo $OUTPUT->header();
                echo $OUTPUT->heading(format_string($cardbox->name));
                echo $myrenderer->cardbox_render_tabs($taburl, $action, $context);
                echo "<h2>". get_string('importpreview', 'cardbox')."</h2>";
                $csvcolumns = $cir->get_columns();
                $errorflag = 0; // No error.
                $columnexceptions = validate_columns($csvcolumns, LONG_DESCRIPTION);
                if (!empty($columnexceptions[0])) {
                    echo '<div class="alert alert-danger" role="alert">Error(s)<ul>';
                    foreach ($columnexceptions[0] as $error) {
                        echo '<li>'.$error.'</li>';
                    }
                    echo '</ul></div>';
                }
                if (!empty($columnexceptions[1])) {
                    echo '<div class="alert alert-warning" role="alert">Warning(s)<ul>';
                    foreach ($columnexceptions[1] as $warning) {
                        echo '<li>'.$warning.'</li>';
                    }
                    echo '</ul></div>';
                }
                if (!empty($columnexceptions[0])) {
                    $errorflag = 1;
                }
                $importpreviewtable = new \mod_cardbox\output\previewtable($cir, $csvcolumns);
                $test = $importpreviewtable->data;
                $test2 = $test['rows'];
                echo html_writer::tag('div', html_writer::table($importpreviewtable), ['class' => 'flexible-wrap']);
                $customdata = ['id' => $cmid, 'cardboxid' => $cardbox->id, 'context' => $context, 'iid' => $iid,
                'step' => 2, 'count' => $readcount, 'error' => $errorflag];
                $mform2 = new \mod_cardbox\output\massimportpreview_form(null, $customdata);
                $mform2->display();
            } else {
                redirect($returnurl, get_string('emptyimportfile', 'cardbox'), null, \core\output\notification::NOTIFY_INFO);
            }
        } else {
            $PAGE->set_url('/mod/cardbox/view.php', array('id' => $cm->id, 'action' => 'massimport'));
            echo $OUTPUT->header();
            echo $OUTPUT->heading(format_string($cardbox->name));
            echo $myrenderer->cardbox_render_tabs($taburl, $action, $context);
            $mform->display();
        }
    } else if ($step == 2) {
        // Processing.
        $iid = required_param('iid', PARAM_INT);
        $mform2 = new \mod_cardbox\output\massimportpreview_form(null, []);
        if ($formdata2 = $mform2->get_data()) {
            $btn = preg_grep('/btn/', array_keys(get_object_vars($formdata2)));
            $test = array_values($btn);
            $test2 = array_values($btn)[0];
            $btnfunc = substr(array_values($btn)[0], 0, -3);
            if (($btnfunc) == 'import') {
                $cir = new csv_import_reader($iid, 'cardbox');
                $cir->init();
                $PAGE->set_url('/mod/cardbox/view.php', array('id' => $cm->id, 'action' => 'massimport'));
                echo $OUTPUT->header();
                echo $OUTPUT->heading(format_string($cardbox->name));
                echo $myrenderer->cardbox_render_tabs($taburl, $action, $context);
                $errlines = cardbox_import_cards($cir, $cir->get_columns(), $cardbox->id);
                $cir->close();
                $cir->cleanup();
                if (!empty($errlines)) {
                    $errorlines = array();
                    $errorlines['err'] = true;
                    $errorlines['rows'] = $errlines;
                    $errorlines['successfullyimported'] = ($formdata2->count) - (1 + count($errlines));
                    $errorlines['continueurl'] = $returnurl->out(false);
                    $renderer = $PAGE->get_renderer('mod_cardbox');
                    echo $renderer->cardbox_render_errimport($errorlines);
                } else {
                    $errorlines['err'] = false;
                    $errorlines['successfullyimported'] = ($formdata2->count) - (1 + count($errlines));
                    $errorlines['continueurl'] = $returnurl->out(false);
                    $renderer = $PAGE->get_renderer('mod_cardbox');
                    echo $renderer->cardbox_render_errimport($errorlines);
                }
            } else {
                redirect($returnurl, get_string('cancelimport', 'cardbox'), null, \core\output\notification::NOTIFY_INFO);
            }
        }
    }
}

/* **************************************************** Review **************************************************** */

if ($action === 'review') {
    require_once('review_form.php');
    $PAGE->set_url('/mod/cardbox/view.php', array('id' => $cm->id, 'action' => 'review'));
    echo $OUTPUT->header();
    echo $OUTPUT->heading(format_string($cardbox->name));
    echo $myrenderer->cardbox_render_tabs($taburl, $action, $context);
    $actionurl = new moodle_url('/mod/cardbox/view.php', array('id' => $cmid, 'action' => 'review'));

    require_once('model/cardcollection.class.php');

    $page = optional_param('page', 0, PARAM_INT);
    $perpage = 10;
    $offset = $page * $perpage;

    // Load unapproved cards.
    $collection = new cardbox_cardcollection($cardbox->id);
    $unapprovedcardids = $collection->cardbox_get_card_list();
    $reviewablecardids = $unapprovedcardids;

    // Load cards that have suggested answers.
    $cards = $DB->get_records('cardbox_cards', ['cardbox' => $cardbox->id]);
    if (!empty($cards)) {
        list($insql, $inparams) = $DB->get_in_or_equal(array_column($cards, 'id'), SQL_PARAMS_NAMED);
        $anssuggestions = $DB->get_records_select('cardbox_cardcontents', 'area = :area AND cardside = :cardside AND card ' . $insql,
            array_merge(['area' => CARD_ANSERSUGGESTION_INFORMATION, 'cardside' => CARDBOX_CARDSIDE_ANSWER], $inparams));
        foreach ($anssuggestions as $anssuggestion) {
            if (!in_array($anssuggestion->card, $reviewablecardids)) {
                array_push($reviewablecardids, $anssuggestion->card);
            }
        }
    }
    $totalcount = count($reviewablecardids);
    $reviewablecardids = array_slice($reviewablecardids, $offset, $perpage);
    $customdata = array('cardboxid' => $cardbox->id, 'cmid' => $cmid, 'cardlist' => $reviewablecardids, 'context' => $context, 'page' => $page,
        'perpage' => $perpage, 'offset' => $offset, 'totalcount' => $totalcount);
    if (empty($reviewablecardids)) {
        $info = get_string('info:nocardsavailableforreview', 'cardbox');
        echo "<span id='cardbox-review-notification' class='notification'><div class='alert alert-info alert-block fade in' role='alert'>$info</div></span>";
        return;
    } else {
        if (empty($message)) {
            $info = get_string('titleforreview', 'cardbox');
            echo "<span id='cardbox-review-notification' class='notification'><div class='alert alert-info alert-block fade in' role='alert'>" . $info . "</div></span>";
        } else {
            echo "<span id='cardbox-review-notification' class='notification'><div class='alert alert-info alert-block fade in' role='alert'>" . $message. "</div></span>";
        }
    }

    $stringman = get_string_manager();
    $strings = $stringman->load_component_strings('cardbox', 'en');
    $PAGE->requires->strings_for_js(array_keys($strings), 'cardbox');
    $PAGE->requires->js(new moodle_url("/mod/cardbox/js/review.js?ver=00003"));
    $PAGE->requires->js_init_call('startReview', [$cmid], true);
    $mform = new mod_cardbox_review_form(null, $customdata);

    if ($fromform = $mform->get_data()) {
        // Processign form data submitted.
        $filtered = array();
        $btn = preg_grep('/btn/', array_keys(get_object_vars($fromform)));
        $btnfunc = rtrim(array_values($btn)[0], 'btn');
        if (($btnfunc) == 'approve') {
            foreach ($fromform as $key => $value) {
                if (preg_match('/chck/', $key)) {
                    $filtered[] = substr($key, 4, strlen($key));
                    $id = substr($key, 4, strlen($key));
                    if (strpos($id, "-") != false) {
                        $pos = strpos($id, "-");
                        $content = substr($id, ($pos + 1));
                        $id = substr($id, 0, $pos);
                    }
                    $dataobject = new stdClass();
                    $cardapproved = cardbox_card_approved($id);
                    if ($cardapproved) {
                        $sugg = $DB->get_records_select('cardbox_cardcontents', 'card = :id AND cardside = 1 AND area = 3' ,
                                            array('id' => $id), '', 'id, content');
                        foreach ($sugg as $sug) {
                            if (strip_tags(str_replace(" ", "", $sug->content)) === $content) {
                                $dataobject->id = $sug->id;
                                $dataobject->content = $sug->content;
                            }
                        }
                        $dataobject->card = $id;
                        $dataobject->area = '0';
                        $success = $DB->update_record('cardbox_cardcontents', $dataobject, false);
                    } else {
                        $dataobject->id = $id;
                        $dataobject->approved = '1';
                        $dataobject->approvedby = $USER->id;
                        $success = $DB->update_record('cardbox_cards', $dataobject, false);
                    }
                }
            }
            redirect($actionurl, '');
        } else {
            foreach ($fromform as $key => $value) {
                if (preg_match('/chck/', $key)) {
                    $filtered[] = substr($key, 4, strlen($key));
                }
            }
            $rejectparams = array($cmid, $filtered, count($filtered));
            $PAGE->requires->js_init_call('rejectcard', $rejectparams, true);

        }
    } else {

        $mform->display();
    }
    echo $OUTPUT->paging_bar($totalcount, $page, $perpage, $actionurl);
}

/* **************************************************** Overview of all cards **************************************************** */

if ($action === 'overview') {

    $topic = optional_param('topic', -1, PARAM_INT);
    $page = optional_param('page', 0, PARAM_INT);
    $perpage = 10;
    $offset = $page * $perpage;
    $PAGE->requires->js_amd_inline("require(['jquery', 'theme_boost/bootstrap/tooltip'], function($){
        $('[data-toggle=\"tooltip\"]').tooltip();
    });");
    require_once('model/cardcollection.class.php');
    require_once($CFG->dirroot . '/mod/cardbox/classes/output/overview.php');

    $PAGE->set_url('/mod/cardbox/view.php', array('id' => $cm->id, 'action' => 'overview'));
    echo $OUTPUT->header();
    echo $OUTPUT->heading("$cardbox->name");
    echo $myrenderer->cardbox_render_tabs($taburl, $action, $context);

    // 1. Create the model.
    $collection = new cardbox_cardcollection($cardbox->id, $topic, true);
    $list = $collection->cardbox_get_card_list();

    $context = context_module::instance($cmid);

    if (empty($list)) {
        $info = get_string('info:nocardsavailableforoverview', 'cardbox');
        echo "<span class='notification alert alert-info alert-block fade in' role='alert' style='display:block'>" . $info . "</span>";
        return;
    } else {
        $totalcount = count($list);
        $baseurl = new moodle_url('/mod/cardbox/view.php', array('id' => $cmid, 'action' => 'overview'));

        $info = get_string('intro:overview', 'cardbox');
        echo "<span class='notification alert alert-info alert-block fade in' role='alert' style='display:block'>" . $info . "</span>";

        // Load strings and include js.
        $stringman = get_string_manager();
        $strings = $stringman->load_component_strings('cardbox', 'en');
        $PAGE->requires->strings_for_js(array_keys($strings), 'cardbox');

        $PAGE->requires->js(new moodle_url("/mod/cardbox/js/overview.js?ver=00000"));
        $PAGE->requires->js_init_call('startOverview', array($cmid, $topic));
        if ($_GET["ismob"] == '1') {
            $ismob = true;
        } else {
            $ismob = false;
        }
        $ismob = $_GET["ismob"];
        // 2. Create a view controller.
        $overview = new cardbox_overview($list, $offset, $context, $cmid, $cardbox->id, $topic, $ismob);

        // 4. Render the page.
        $renderer = $PAGE->get_renderer('mod_cardbox');
        echo $renderer->cardbox_render_overview($overview);
        echo $OUTPUT->paging_bar($totalcount, $page, $perpage, $baseurl);
    }

}

/* **************************************************** Edit topics **************************************************** */

if ($action === 'savenewtopic') {

    require_capability('mod/cardbox:edittopics', $context);
    $returnurl = new moodle_url('/mod/cardbox/view.php', array('id' => $cmid, 'action' => 'edittopic'));

    $newtopic = required_param('newtopic', PARAM_TEXT);
    cardbox_save_new_topic($newtopic, $cardbox->id);

    redirect($returnurl);

}

/* **************************************************** Edit topics **************************************************** */

if ($action === 'edittopic') {

    require_capability('mod/cardbox:edittopics', $context);

    $page = optional_param('page', 0, PARAM_INT);
    $perpage = 10;
    $offset = $page * $perpage;

    require_once($CFG->dirroot . '/mod/cardbox/classes/output/topics.php');
    $PAGE->set_url('/mod/cardbox/view.php', array('id' => $cm->id, 'action' => 'edittopic'));
    echo $OUTPUT->header();
    echo $OUTPUT->heading(format_string($cardbox->name));
    echo $myrenderer->cardbox_render_tabs($taburl, $action, $context);
    $renderer = $PAGE->get_renderer('mod_cardbox');

    $list = cardbox_get_topics($cardbox->id);

    $topics = new cardbox_topics($list, $offset, /* $context, */ $cmid, $cardbox->id);
    $PAGE->requires->js_call_amd('mod_cardbox/topics', 'init', array($cmid));

    echo $renderer->cardbox_render_topics($topics);
}