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

/**
 * This file contains the forms to create and edit an instance of this module
 *
 * @package   mod_surveypro
 * @copyright 2013 onwards kordan <stringapiccola@gmail.com>
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

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

require_once($CFG->dirroot.'/course/moodleform_mod.php');

/**
 * Surveypro settings form.
 *
 * @package   mod_surveypro
 * @copyright 2013 onwards kordan <stringapiccola@gmail.com>
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class mod_surveypro_mod_form extends \moodleform_mod {

    /**
     * Definition.
     *
     * @return void
     */
    public function definition() {
        global $CFG, $COURSE;

        $mform = $this->_form;

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

        // Adding the standard "name" field.
        $fieldname = 'name';
        $mform->addElement('text', $fieldname, get_string('name'), ['size' => '64']);
        if (!empty($CFG->formatstringstriptags)) {
            $mform->setType($fieldname, PARAM_TEXT);
        } else {
            $mform->setType($fieldname, PARAM_CLEANHTML);
        }
        $mform->addRule($fieldname, get_string('required'), 'required', null, 'client');
        $mform->addRule($fieldname, get_string('maximumchars', '', 255), 'maxlength', 255, 'client');
        $mform->addHelpButton($fieldname, 'surveyproname', 'surveypro');

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

        // Open date.
        $fieldname = 'timeopen';
        $mform->addElement('date_time_selector', $fieldname, get_string($fieldname, 'mod_surveypro'), ['optional' => true]);
        $mform->addHelpButton($fieldname, $fieldname, 'surveypro');

        // Close date.
        $fieldname = 'timeclose';
        $mform->addElement('date_time_selector', $fieldname, get_string($fieldname, 'mod_surveypro'), ['optional' => true]);
        $mform->addHelpButton($fieldname, $fieldname, 'surveypro');

        // Modulesettinghdr fieldset (header).
        $fieldname = 'modulesettinghdr';
        $mform->addElement('header', $fieldname, get_string($fieldname, 'mod_surveypro'));

        // Newpageforchild.
        $fieldname = 'newpageforchild';
        $mform->addElement('checkbox', $fieldname, get_string($fieldname, 'mod_surveypro'));
        $mform->addHelpButton($fieldname, $fieldname, 'surveypro');

        // Never started reminder.
        $fieldname = 'neverstartedemail';
        $mform->addElement('checkbox', $fieldname, get_string($fieldname, 'mod_surveypro'));
        $mform->addHelpButton($fieldname, $fieldname, 'surveypro');

        // Allow/deny pauseresume with or without reminder email.
        $options = [SURVEYPRO_ONESHOTNOEMAIL => get_string('oneshotnoemail', 'mod_surveypro')];
        $options[SURVEYPRO_ONESHOTEMAIL] = get_string('oneshotemail', 'mod_surveypro');
        $options[SURVEYPRO_PAUSERESUMENOEMAIL] = get_string('pauseresumenoemail', 'mod_surveypro');
        $options[SURVEYPRO_PAUSERESUMEEMAIL] = get_string('pauseresumeemail', 'mod_surveypro');
        $fieldname = 'pauseresume';
        $mform->addElement('select', $fieldname, get_string($fieldname, 'mod_surveypro'), $options);
        $mform->addHelpButton($fieldname, $fieldname, 'surveypro');

        // Keep in progress.
        $fieldname = 'keepinprogress';
        $mform->addElement('checkbox', $fieldname, get_string($fieldname, 'mod_surveypro'));
        $mform->addHelpButton($fieldname, $fieldname, 'surveypro');

        // History.
        $fieldname = 'history';
        $mform->addElement('checkbox', $fieldname, get_string($fieldname, 'mod_surveypro'));
        $mform->addHelpButton($fieldname, $fieldname, 'surveypro');

        // Allow/deny anonymous.
        $fieldname = 'anonymous';
        $mform->addElement('checkbox', $fieldname, get_string($fieldname, 'mod_surveypro'));
        $mform->addHelpButton($fieldname, $fieldname, 'surveypro');

        // Recaptcha.
        if (surveypro_site_recaptcha_enabled()) {
            $fieldname = 'captcha';
            $mform->addElement('checkbox', $fieldname, get_string($fieldname, 'mod_surveypro'));
            $mform->addHelpButton($fieldname, $fieldname, 'surveypro');
        }

        // Startyear.
        $yearsrange = range(1902, 2038);
        $boundaryyear = array_combine($yearsrange, $yearsrange);

        $fieldname = 'startyear';
        $mform->addElement('select', $fieldname, get_string($fieldname, 'mod_surveypro'), $boundaryyear);
        $mform->setDefault($fieldname, 1970);
        $mform->addHelpButton($fieldname, $fieldname, 'surveypro');

        // Stopyear.
        $fieldname = 'stopyear';
        $mform->addElement('select', $fieldname, get_string($fieldname, 'mod_surveypro'), $boundaryyear);
        $currentyear = userdate(time(), "%Y");
        $mform->setDefault($fieldname, $currentyear);
        $mform->addHelpButton($fieldname, $fieldname, 'surveypro');

        // Userstyle.
        $fieldname = 'userstyle';
        $attributes = surveypro_get_user_style_options();
        $mform->addElement('filemanager', $fieldname.'_filemanager', get_string($fieldname, 'mod_surveypro'), null, $attributes);
        $mform->addHelpButton($fieldname.'_filemanager', $fieldname, 'surveypro');

        // Maxentries.
        $fieldname = 'maxentries';
        $maxentries = 50;
        $entriesrange = range(1, $maxentries);
        $countoptions = array_combine($entriesrange, $entriesrange);
        array_unshift($countoptions, get_string('unlimited', 'mod_surveypro'));

        $mform->addElement('select', $fieldname, get_string($fieldname, 'mod_surveypro'), $countoptions);
        $mform->addHelpButton($fieldname, $fieldname, 'surveypro');

        // Helper variables.
        $attributes = ['wrap' => 'virtual', 'rows' => 10, 'cols' => 60];

        // Define thanks page.
        $fieldname = 'thankspageeditor';
        $editoroptions = surveypro_get_editor_options();
        $mform->addElement('editor', $fieldname, get_string($fieldname, 'mod_surveypro'), $attributes, $editoroptions);
        $mform->addHelpButton($fieldname, $fieldname, 'surveypro');
        $mform->setType($fieldname, PARAM_RAW); // No XSS prevention here, users must be trusted.

        // Mailroles.
        $fieldname = 'mailroles';
        $options = [];
        $context = \context_course::instance($COURSE->id);
        // I look for roles belonging to governance.
        // At the moment the capability 'mod/surveypro:accessreports' seems to be a good indicator of that group.
        $roleoptions = get_role_names_with_caps_in_context($context, ['mod/surveypro:accessreports']);
        foreach ($roleoptions as $roleid => $rolename) {
            $users = get_role_users($roleid, $context, true);
            $options[$roleid] = $rolename.' ('.count($users).')';
        }
        $select = $mform->addElement('select', $fieldname, get_string($fieldname, 'mod_surveypro'), $options);
        $select->setMultiple(true);
        $mform->addHelpButton($fieldname, $fieldname, 'surveypro');

        // Mailextraaddresses.
        $fieldname = 'mailextraaddresses';
        $mform->addElement('textarea', $fieldname, get_string($fieldname, 'mod_surveypro'), $attributes);
        $mform->addHelpButton($fieldname, $fieldname, 'surveypro');

        // Custom mail message for notifications. No embedded pictures to handle.
        $fieldname = 'mailcontenteditor';
        $mform->addElement('editor', $fieldname, get_string($fieldname, 'mod_surveypro'), $attributes);
        $mailcontentdefault = ['text' => get_string('mailcontentdefault', 'surveypro'), 'format' => FORMAT_HTML];
        $mform->setDefault($fieldname, $mailcontentdefault);
        $mform->addHelpButton($fieldname, $fieldname, 'surveypro');
        $mform->setType($fieldname, PARAM_RAW); // No XSS prevention here, users must be trusted.

        // Riskyeditdeadline.
        $fieldname = 'riskyeditdeadline';
        $mform->addElement('date_time_selector', $fieldname, get_string($fieldname, 'mod_surveypro'));
        $mform->addHelpButton($fieldname, $fieldname, 'surveypro');

        // Add standard elements, common to all modules.
        $this->standard_coursemodule_elements();

        // Add standard buttons, common to all modules.
        $this->add_action_buttons();
    }

    /**
     * Retrieve the data parsed from the address.
     *
     * @return \stdClass the parsed data.
     */
    public function get_data() {
        $data = parent::get_data();
        if (!$data) {
            return false;
        }

        // Thankspage.
        $data->thankspageformat = $data->thankspageeditor['format'];
        $data->thankspage = $data->thankspageeditor['text'];

        // Mailroles.
        if (isset($data->mailroles)) {
            $data->mailroles = implode(',', $data->mailroles);
        } else {
            $data->mailroles = '';
        }

        // Mailcontent.
        $data->mailcontentformat = $data->mailcontenteditor['format'];
        $data->mailcontent = $data->mailcontenteditor['text'];

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

        return $data;
    }

    /**
     * Any data processing needed before the form is displayed
     * (needed to set up draft areas for editor and filemanager elements)
     *
     * @param object $defaults the data being passed to the form.
     */
    public function data_preprocessing(&$defaults) {
        parent::data_preprocessing($defaults);

        // Manage userstyle filemanager.
        $filename = 'userstyle';
        $filemanageroptions = surveypro_get_user_style_options();
        $draftitemid = file_get_submitted_draft_itemid($filename.'_filemanager');

        if ($this->current->instance) {
            file_prepare_draft_area($draftitemid, $this->context->id, 'mod_surveypro',
                SURVEYPRO_STYLEFILEAREA, 0, $filemanageroptions);
            $defaults[$filename.'_filemanager'] = $draftitemid;

            // Manage thankspage editor.
            $filename = 'thankspageeditor';
            $editoroptions = surveypro_get_editor_options();
            // Editing an existing surveypro - let us prepare the added editor elements (intro done automatically).
            $draftitemid = file_get_submitted_draft_itemid('thankspage');
            $defaults[$filename]['text'] = file_prepare_draft_area($draftitemid, $this->context->id,
                                           'mod_surveypro', SURVEYPRO_THANKSPAGEFILEAREA, 0, $editoroptions, $defaults['thankspage']);
            $defaults[$filename]['format'] = $defaults['thankspageformat'];
            $defaults[$filename]['itemid'] = $draftitemid;

            // Mailroles.
            if ($defaults['mailroles']) {
                $filename = 'mailroles';
                $presetroles = explode(',', $defaults['mailroles']);
                foreach ($presetroles as $roleid) {
                    $values[] = $roleid;
                }
                $defaults[$filename] = $values;

                // Manage mailcontent editor. No embedded pictures to handle.
                $filename = 'mailcontenteditor';
                $defaults[$filename]['text'] = $defaults['mailcontent'];
                $defaults[$filename]['format'] = $defaults['mailcontentformat'];
            }
        } else {
            file_prepare_draft_area($draftitemid, $this->context->id, 'mod_surveypro',
                                    SURVEYPRO_STYLEFILEAREA, 0, $filemanageroptions);
            $defaults[$filename.'_filemanager'] = $draftitemid;

            // Manage thankspage editor.
            $filename = 'thankspageeditor';
            $draftitemid = file_get_submitted_draft_itemid('thankspage');
            file_prepare_draft_area($draftitemid, null, 'mod_surveypro', SURVEYPRO_THANKSPAGEFILEAREA, 0);
            $defaults[$filename]['text'] = '';
            $defaults[$filename]['format'] = editors_get_preferred_format();
            $defaults[$filename]['itemid'] = $draftitemid;

            // Mailroles.
            // Nothing to do.

            // Manage mailcontent editor. No embedded pictures to handle.
            // Nothing to do.
        }

        $fieldname = 'completionsubmit';
        $defaults[$fieldname.'_check'] = !empty($defaults[$fieldname]) ? 1 : 0;
        if (empty($defaults[$fieldname])) {
            $defaults[$fieldname] = 1;
        }
    }

    /**
     * Validate form data.
     *
     * @param array $data
     * @param array $files
     * @return array
     */
    public function validation($data, $files) {
        $errors = parent::validation($data, $files);

        $mailextraaddresses = $data['mailextraaddresses'];
        $mailextraaddresses = trim($mailextraaddresses);
        $mailextraaddresses = preg_replace('~\n\n+~', "\n", $mailextraaddresses);

        $extraemail = explode("\n", $mailextraaddresses);
        $extraemail = array_map('trim', $extraemail);

        $arrayunique = array_unique($extraemail);
        if (count($arrayunique) != count($extraemail)) {
            $errors['mailextraaddresses'] = get_string('duplicateemail', 'surveypro');
        }

        return $errors;
    }

    /**
     * Add_completion_rules.
     *
     * @return void
     */
    public function add_completion_rules() {
        $mform =& $this->_form;

        // Completionsubmit_check is not saved to db because it is completely redundant.
        // If completionsubmit is not empty it is checked otherwise it is not checked.
        // See data_preprocessing method just few lines above.
        $fieldname = 'completionsubmit';
        $elementgroup = [];
        $checklabel = get_string($fieldname.'_check', 'mod_surveypro');
        $elementgroup[] = $mform->createElement('checkbox', $fieldname.'_check', '', $checklabel);
        $elementgroup[] = $mform->createElement('text', $fieldname, '', ['size' => 3]);
        $mform->setType($fieldname, PARAM_INT);
        $mform->addGroup($elementgroup, $fieldname.'_group', get_string($fieldname.'_group', 'mod_surveypro'), ' ', false);
        $mform->addHelpButton($fieldname.'_group', $fieldname.'_group', 'surveypro');
        $mform->disabledIf($fieldname, $fieldname.'_check', 'notchecked');

        return [$fieldname.'_group'];
    }

    /**
     * Completion_rule_enabled.
     *
     * @param array $data
     * @return bool
     */
    public function completion_rule_enabled($data) {
        return (!empty($data['completionsubmit_check']) && ($data['completionsubmit'] != 0));
    }
}