mod_form.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/>.

/**
 * Display information about all the mod_mooduell modules in the requested course.
 *
 * @package mod_mooduell
 * @copyright 2020 Wunderbyte GmbH <info@wunderbyte.at>
 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

use mod_mooduell\completion\completion_utils;
use mod_mooduell\task\challenge_results_task;
use mod_quiz\question\bank\qbank_helper;

defined('MOODLE_INTERNAL') || die();

global $CFG;

require_once($CFG->dirroot . '/course/moodleform_mod.php');
require_once(__DIR__ . '/lib.php');
require_once($CFG->libdir.'/questionlib.php');

/**
 * Module instance settings form.
 *
 * @package mod_mooduell
 * @copyright 2020 Wunderbyte GmbH <info@wunderbyte.at>
 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class mod_mooduell_mod_form extends moodleform_mod {

    /**
     * Defines forms elements
     */
    public function definition() {
        global $CFG;

        $mform = $this->_form;

        // Adding the "general" fieldset, where all the common settings are shown.
        $mform->addElement('header', 'general', get_string('general', 'form'));

        // Adding the standard "name" field.
        $mform->addElement('text', 'name', get_string('mooduellname', 'mod_mooduell'), [
            'size' => '64',
        ]);

        if (!empty($CFG->formatstringstriptags)) {
            $mform->setType('name', PARAM_TEXT);
        } else {
            $mform->setType('name', PARAM_CLEANHTML);
        }

        $mform->addRule('name', null, 'required', null, 'client');
        $mform->addRule('name', get_string('maximumchars', '', 255), 'maxlength', 255, 'client');
        $mform->addHelpButton('name', 'mooduellname', 'mod_mooduell');

        // Adding the standard "intro" and "introformat" fields.
        $this->standard_intro_elements();

        // Add Question Selection.
        $this->mooduell_questions();

        // Add mooduell elements.
        $this->mooduell_elements();

        // Add standard elements.
        $this->standard_coursemodule_elements();

        // Add standard buttons.
        $this->add_action_buttons();
    }

    /**
     * Defines questions pickers
     *
     * @return void
     */
    private function mooduell_questions() {

        global $COURSE, $DB, $CFG;

        // Get MooDuell id.
        $mooduellid = $this->get_mooduell_id();

        $config = get_config('mooduell');

        $mform = $this->_form;

        $mform->addElement('header', 'questionsettings', get_string('questionselect', 'mod_mooduell'));
        $mform->setExpanded('questionsettings');

        // First, create an array of contexts (containing course context only).
        $arrayofcontexts[] = \context_course::instance($COURSE->id);

        // Now, retrieve a list of categories with a function from questionlib.
        $listofcategories = [];
        if ($CFG->version >= 2022041900) {
            $cats = qbank_managecategories\helper::question_category_options($arrayofcontexts, false, 0, false);
        } else {
            $cats = question_category_options($arrayofcontexts, false, 0, false);

        }
        $cats = array_pop($cats);

        if (!empty($cats)) {
            foreach ($cats as $key => $value) {
                // Repair the keys, so they'll work in our dropdown.
                $keypair = explode(',', $key);
                $newkey = $keypair[0];
                $listofcategories[$newkey] = $value;
            }
        }

        $listofmooduellcats = $DB->get_records('mooduell_categories', ['mooduellid' => $mooduellid]);
        if (count($listofcategories) > 0) {
            // First, there is the explanation.
            $mform->addElement(
                'static',
                'categoriesexplanation',
                get_string('important', 'mod_mooduell'),
                get_string('categoriesexplanation', 'mod_mooduell')
            );

            // Between one to three categories are supported.
            $i = 0;
            $max = 3;
            while ($i < $max) {

                if ($listofmooduellcats && count($listofmooduellcats) > 0) {
                    $selectedcategory = array_shift($listofmooduellcats);
                } else {
                    $selectedcategory = null;
                }

                $this->add_categories_group($i, $selectedcategory, $listofcategories, $mform);
                if ($i < $max - 1) {
                    $j = $i + 1;
                    $mform->addElement('checkbox', 'addanothercategory' . $j, get_string('addanothercategory', 'mod_mooduell'));
                    // We check the checkbox if we have a category element saved.
                    if (count($listofmooduellcats) > 0) {
                        $mform->setDefault('addanothercategory' . $j, true);
                    }
                }
                // Hide categories depending on checkboxes add categories.
                if ($i > 0) {
                    $j = $i - 1;
                    $mform->hideIf('categoriesgroup' . $i, 'addanothercategory' . $i, 'notchecked');
                    $mform->hideIf('addanothercategory' . $i, 'addanothercategory' . $j, 'notchecked');
                }
                ++$i;
            }
        } else {
            // Warning if there are not categories.
            $mform->addElement(
                'static',
                'warning',
                get_string('important', 'mod_mooduell'),
                get_string('nocategories', 'mod_mooduell')
            );
        }
    }

    /**
     * Add Mooduell setting elements.
     * @throws coding_exception
     */
    private function mooduell_elements() {

        global $COURSE, $DB, $CFG;

        // Get MooDuell id.
        $mooduellid = $this->get_mooduell_id();

        $config = get_config('mooduell');

        $mform = $this->_form;

        // Adding the rest of mod_mooduell settings, spreading all them into this fieldset.
        $mform->addElement('header', 'mooduellsettings', get_string('mooduellsettings', 'mod_mooduell'));
        $mform->setExpanded('mooduellsettings');

        $mform->addElement('checkbox', 'usefullnames', get_string('usefullnames', 'mod_mooduell'));
        $mform->setDefault('usefullnames', $config->usefullnames);
        $mform->addHelpButton('usefullnames', 'usefullnames', 'mod_mooduell');

        $mform->addElement('checkbox', 'showcontinuebutton', get_string('showcontinuebutton', 'mod_mooduell'));
        $mform->setDefault('showcontinuebutton', $config->showcontinuebutton);
        $mform->addHelpButton('showcontinuebutton', 'showcontinuebutton', 'mod_mooduell');

        $mform->addElement('checkbox', 'showcorrectanswer', get_string('showcorrectanswer', 'mod_mooduell'));
        $mform->setDefault('showcorrectanswer', $config->showcorrectanswer);
        $mform->addHelpButton('showcorrectanswer', 'showcorrectanswer', 'mod_mooduell');

        $mform->addElement('checkbox', 'showgeneralfeedback', get_string('showgeneralfeedback', 'mod_mooduell'));
        $mform->setDefault('showgeneralfeedback', $config->showgeneralfeedback);
        $mform->addHelpButton('showgeneralfeedback', 'showgeneralfeedback', 'mod_mooduell');

        $mform->addElement('checkbox', 'showanswersfeedback', get_string('showanswersfeedback', 'mod_mooduell'));
        $mform->setDefault('showanswersfeedback', $config->showanswersfeedback);
        $mform->addHelpButton('showanswersfeedback', 'showanswersfeedback', 'mod_mooduell');

        $mform->addElement('select', 'countdown', get_string('countdown', 'mod_mooduell'), $this->return_countdown_options());
        if (isset($config->countdown)) {
            $mform->setDefault('countdown', $config->countdown);
        }
        $mform->addHelpButton('countdown', 'countdown', 'mod_mooduell');

        $mform->addElement(
            'select',
            'waitfornextquestion',
            get_string('waitfornextquestion', 'mod_mooduell'),
            $this->return_move_on_options()
        );
        if (isset($config->waitfornextquestion)) {
            $mform->setDefault('waitfornextquestion', $config->waitfornextquestion);
        }
        $mform->addHelpButton('waitfornextquestion', 'waitfornextquestion', 'mod_mooduell');
        $this->apply_admin_defaults();

    }

    /**
     * create array for countdown select.
     * @return array
     * @throws coding_exception
     */
    private function return_countdown_options() {
        return [
            "0" => get_string('nocountdown', 'mod_mooduell'),
            "10" => get_string('xseconds', 'mod_mooduell', 10),
            "20" => get_string('xseconds', 'mod_mooduell', 20),
            "30" => get_string('xseconds', 'mod_mooduell', 30),
            "60" => get_string('xseconds', 'mod_mooduell', 60),
            "90" => get_string('xseconds', 'mod_mooduell', 90),
            "120" => get_string('xseconds', 'mod_mooduell', 120),
        ];
    }

    /**
     * Because of get_string, this has to be a function.
     *
     * @return array
     * @throws coding_exception
     */
    private function return_move_on_options() {
        return [
            "0" => get_string('clicktomoveon', 'mod_mooduell'),
            "1" => get_string('xseconds', 'mod_mooduell', 1),
            "2" => get_string('xseconds', 'mod_mooduell', 2),
            "5" => get_string('xseconds', 'mod_mooduell', 5),
            "10" => get_string('xseconds', 'mod_mooduell', 10),
            "20" => get_string('xseconds', 'mod_mooduell', 20),
            "30" => get_string('xseconds', 'mod_mooduell', 30),
        ];
    }

    /**
     * Possibility to add another category.
     * @param int $counter
     * @param object|null $selectedcategory
     * @param array $listofcategories
     * @param object $mform
     * @throws coding_exception
     */
    private function add_categories_group(int $counter, $selectedcategory, array $listofcategories, object $mform) {

        $categoryoptions = $listofcategories;
        $catweightoptions = $this->return_list_of_category_weight_options();

        $formgroup = [];
        $formgroup[] = &$mform->createElement('select', 'category',
            get_string('questionscategory', 'mod_mooduell'), $categoryoptions);
        if ($selectedcategory) {
            $formgroup[0]->setSelected($selectedcategory->category);
        }
        $formgroup[] = &$mform->createElement('select', 'weight', get_string('categoryweight', 'mod_mooduell'), $catweightoptions);
        if ($selectedcategory) {
            $formgroup[1]->setSelected($selectedcategory->weight);
        } else {
            $formgroup[1]->setSelected('100');
        }
        $mform->addGroup($formgroup, 'categoriesgroup' . $counter, get_string('questionscategorygroup', 'mod_mooduell'));
    }

    /**
     * Returns children in list.
     * @param object $parent
     * @param array $list
     * @return array
     */
    private function return_children_in_list(object $parent, array $list) {
        $children = [];

        foreach ($list as $child) {

            if ($parent->id == $child->parent) {
                $children[] = $child;
                foreach ($this->return_children_in_list($child, $list) as $grandchild) {
                    if ($grandchild) {
                        $children[] = $grandchild;
                    }
                }
            }
        }
        return $children;
    }

    /**
     * Returns list of category weight options.
     * @return string[]
     */
    private function return_list_of_category_weight_options() {
        return [
            0 => '0',
            17 => '17',
            33 => '33',
            50 => '50',
            66 => '66',
            100 => '100',
        ];
    }

    /**
     * Set defaults and prepare data for form.
     *
     * @param array $defaultvalues
     */
    public function data_preprocessing(&$defaultvalues) {
        parent::data_preprocessing($defaultvalues);

        global $DB;

        // Get MooDuell id.
        $mooduellid = $this->get_mooduell_id();

        // Preprocessing to prefill challenge data.
        $completionmodes = completion_utils::mooduell_get_completion_modes();
        foreach ($completionmodes as $mode => $field) {

            // Prefill target number if it already exists.
            if ($existingtargetnumber = $DB->get_field(
                'mooduell_challenges',
                'targetnumber',
                ['mooduellid' => $mooduellid, 'challengetype' => $mode]
            )) {
                $defaultvalues[$mode . 'enabled'] = 1;
                $defaultvalues[$mode] = $existingtargetnumber;
            } else {
                $defaultvalues[$mode . 'enabled'] = 0;
                $defaultvalues[$mode] = 0;
            }

            // Prefill challenge name if it already exists.
            if ($existingchallengename = $DB->get_field(
                'mooduell_challenges',
                'challengename',
                ['mooduellid' => $mooduellid, 'challengetype' => $mode]
            )) {
                $defaultvalues[$mode . 'name'] = $existingchallengename;
            } else {
                $defaultvalues[$mode . 'name'] = get_string('challengename:' . $mode, 'mooduell');
            }
        }
    }

    /**
     * Allows modules to modify the data returned by form get_data().
     * This method is also called in the bulk activity completion form.
     *
     * Only available on moodleform_mod.
     *
     * @param stdClass $data the form data to be modified.
     */
    public function data_postprocessing($data) {
        parent::data_postprocessing($data);

        // Get course module id.
        $cmid = $this->get_cm_id();

        // Get MooDuell id.
        $mooduellid = $this->get_mooduell_id();

        // Create an adhoc-task to store challenge results after expiration.
        if (isset($data->completion) && $mooduellid != 0 && $data->completion == 2 && $data->completionexpected > 0) {
            // Create task instance.
            $crtask = new challenge_results_task();
            // Add custom data to task.
            $crtask->set_custom_data([
                'cmid' => $cmid,
                'mooduellid' => $mooduellid,
                'completionexpected' => $data->completionexpected,
            ]);
            $crtask->set_next_run_time($data->completionexpected);

            // Second param needs to be true to ignore duplicates.
            \core\task\manager::queue_adhoc_task($crtask, true);
        } else {
            return;
        }
    }

    /**
     * Add any custom completion rules to the form.
     *
     * @return array Contains the names of the added form elements
     */
    public function add_completion_rules() {

        $mform = $this->_form;

        $result = [];
        $completionmodes = completion_utils::mooduell_get_completion_modes();
        foreach ($completionmodes as $mode => $field) {
            $group = [];
            $group[] = $mform->createElement('checkbox', $mode . 'enabled', '', get_string($mode, 'mooduell'));
            $group[] = $mform->createElement('text', $mode, '', ['size' => 2]);
            $group[] = $mform->createElement('text', $mode . 'name', '', ['size' => 30]);
            $mform->setType($mode, PARAM_INT);
            $mform->setType($mode . 'name', PARAM_TEXT);

            $mform->addGroup($group, $mode . 'group', get_string($mode . 'label', 'mooduell'), [' '], false);
            $mform->addHelpButton($mode . 'group', $mode . 'label', 'mooduell');

            $mform->hideIf($mode, $mode . 'enabled', 'notchecked');
            $mform->hideIf($mode . 'name', $mode . 'enabled', 'notchecked');

            $result[] = $mode . 'group';
        }

        return $result;
    }

    /**
     * Determines if completion is enabled for this module.
     *
     * @param array $data
     * @return bool
     */
    public function completion_rule_enabled($data) {
        $completionmodes = completion_utils::mooduell_get_completion_modes();
        foreach ($completionmodes as $mode => $field) {
            if (!empty($data[$mode . 'enabled']) && $data[$mode] !== 0) {
                return true;
            }
        }
        return false;
    }

    /**
     * Get the data of the form
     *
     * @return array Contains the data of the form
     */
    public function get_data() {
        $data = parent::get_data();
        if (!$data) {
            return false;
        }

        // Turn off completion settings if the checkboxes aren't ticked.
        if (!empty($data->completionunlocked)) {
            $autocompletion = !empty($data->completion) && $data->completion == COMPLETION_TRACKING_AUTOMATIC;

            $completionmodes = completion_utils::mooduell_get_completion_modes();
            foreach ($completionmodes as $completionmode => $field) {
                if (empty($data->{$completionmode . 'enabled'}) || !$autocompletion) {
                    $data->{$completionmode} = 0;
                }
            }
        }

        return $data;
    }

    /**
     * Helper function to quickly retrieve MooDuell ID.
     * @return int The ID of the current MooDuell instance, 0 if not found.
     */
    private function get_mooduell_id() {
        $cm = $this->get_coursemodule();

        if ($cm && property_exists($cm, 'instance')) {
            $mooduellid = $cm->instance;
        } else {
            $mooduellid = 0;
        }

        return $mooduellid;
    }

    /**
     * Helper function to quickly retrieve course module id (cmid).
     * @return int The ID of the current current course module, 0 if not found.
     */
    private function get_cm_id() {
        $cm = $this->get_coursemodule();

        if ($cm && property_exists($cm, 'id')) {
            $cmid = $cm->id;
        } else {
            $cmid = 0;
        }

        return $cmid;
    }
}