mod_form.php

<?php
// This file is part of the Accredible Certificate module for 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_accredible
 * @subpackage accredible
 * @copyright  Accredible <dev@accredible.com>
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

defined('MOODLE_INTERNAL') || die('Direct access to this script is forbidden.');

require_once($CFG->dirroot.'/course/moodleform_mod.php');
require_once($CFG->dirroot.'/mod/accredible/lib.php');
require_once($CFG->dirroot.'/mod/accredible/locallib.php');

use mod_accredible\Html2Text\Html2Text;
use mod_accredible\local\credentials;
use mod_accredible\local\groups;
use mod_accredible\local\users;
use mod_accredible\local\formhelper;


/**
 * Accredible settings form.
 *
 * @package    mod_accredible
 * @subpackage accredible
 * @copyright  Accredible <dev@accredible.com>
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class mod_accredible_mod_form extends moodleform_mod {

    /**
     * Called to define this moodle form
     *
     * @return void
     */
    public function definition() {
        global $DB, $COURSE, $CFG, $PAGE, $OUTPUT;

        $credentialsclient = new credentials();
        $groupsclient = new groups();
        $usersclient = new users();
        $formhelper = new formhelper();

        $updatingcert = false;
        $alreadyexists = false;

        if (!extension_loaded('mbstring')) {
            throw new moodle_exception('You or administrator must install mbstring extensions of php.');
        }

        if (!extension_loaded('dom')) {
            throw new moodle_exception('You or administrator must install dom extensions of php.');
        }

        $description = Html2Text::convert($COURSE->summary);
        if (empty($description)) {
            $description = "Recipient has compeleted the achievement.";
        }

        if ($CFG->is_eu) {
            $dashboardurl = 'https://eu.dashboard.accredible.com/';
        } else {
            $dashboardurl = 'https://dashboard.accredible.com/';
        }

        // Make sure the API key is set.
        if (!isset($CFG->accredible_api_key)) {
            throw new moodle_exception('Please set your API Key first in the plugin settings.');
        }
        // Update form init.
        if (optional_param('update', '', PARAM_INT)) {
            $updatingcert = true;
            $cmid = optional_param('update', '', PARAM_INT);
            $cm = get_coursemodule_from_id('accredible', $cmid, 0, false, MUST_EXIST);
            $id = $cm->course;
            $course = $DB->get_record('course', ['id' => $id], '*', MUST_EXIST);
            $accrediblecertificate = $DB->get_record('accredible', ['id' => $cm->instance], '*', MUST_EXIST);
        } else if (optional_param('course', '', PARAM_INT)) { // New form init.
            $id = optional_param('course', '', PARAM_INT);
            $course = $DB->get_record('course', ['id' => $id], '*', MUST_EXIST);
            // See if other accredible certificates already exist for this course.
            $alreadyexists = $DB->record_exists('accredible', ['course' => $id]);
        }

        // Load user data.
        $context = context_course::instance($course->id);
        $users = get_enrolled_users($context, "mod/accredible:view", null, 'u.*');

        if ($updatingcert) {
            // Grab existing certificates and cross-reference emails.
            if ($accrediblecertificate->achievementid) {
                $userswithcredential = $usersclient->get_users_with_credentials($users, $accrediblecertificate->achievementid);
            } else {
                $userswithcredential = $usersclient->get_users_with_credentials($users, $accrediblecertificate->groupid);
            }
        }

        // Load final quiz choices.
        $quizchoices = ['' => 'Select a Quiz'];
        if ($quizes = $DB->get_records_select('quiz', 'course = :course_id', ['course_id' => $id], '', 'id, name')) {
            foreach ($quizes as $quiz) {
                $quizchoices[$quiz->id] = $quiz->name;
            }
        }

        $inputstyle = ['style' => 'width: 399px'];

        // Load template contexts.
        $attributekeyschoices = $formhelper->get_attributekeys_choices();

        $accredibleoptions = $formhelper->map_select_options($attributekeyschoices);
        $coursefieldoptions = $formhelper->load_course_field_options();
        $coursecustomfieldoptions = $formhelper->load_course_custom_field_options();
        $userprofilefieldoptions = $formhelper->load_user_profile_field_options();

        // Form start.
        $PAGE->requires->js_call_amd('mod_accredible/userlist_updater', 'init');
        $PAGE->requires->js_call_amd('mod_accredible/attribute_keys_displayer', 'init');
        $PAGE->requires->js_call_amd('mod_accredible/mappings', 'init');

        $mform =& $this->_form;
        $mform->addElement('hidden', 'course', $id);
        if ($updatingcert) {
            $mform->addElement('hidden', 'instance-id', $cm->instance);
        } else {
            $mform->addElement('hidden', 'instance-id', 0);
        }
        $mform->setType('instance-id', PARAM_INT);
        $mform->addElement('header', 'general', get_string('general', 'form'));

        $mform->addElement('text', 'name', get_string('activityname', 'accredible'), $inputstyle);
        $mform->addRule('name', null, 'required', null, 'client');
        $mform->setType('name', PARAM_TEXT);
        $mform->setDefault('name', $course->fullname);

        if ($alreadyexists) {
            $mform->addElement('static', 'additionalactivitiesone', '', get_string('additionalactivitiesone', 'accredible'));
        }

        // Load available groups.
        $templates = ['' => 'Select a Group'] + $groupsclient->get_groups();
        $mform->addElement('select', 'groupid', get_string('accrediblegroup', 'accredible'), $templates, $inputstyle);
        $mform->addRule('groupid', null, 'required', null, 'client');
        if ($updatingcert && $accrediblecertificate->groupid) {
            $mform->setDefault('groupid', $accrediblecertificate->groupid);
        }

        $mform->addElement('static', 'overview', '',
            get_string('activitygroupdescription', 'accredible', $dashboardurl));

        if ($alreadyexists) {
            $mform->addElement('static', 'additionalactivitiestwo', '', get_string('additionalactivitiestwo', 'accredible'));
        }

        if (isset($attributekeyschoices)) {
            // Hidden element to check if we should disable the "gradeattributekeyname" select.
            $mform->addElement('hidden', 'attributekysnumber', 1);
        } else {
            $mform->addElement('hidden', 'attributekysnumber', 0);
        }
        $mform->setType('attributekysnumber', PARAM_INT);

        $mform->addElement('checkbox', 'includegradeattribute', get_string('includegradeattributedescription', 'accredible'),
            get_string('includegradeattributecheckbox', 'accredible'));

        $mform->setType('includegradeattribute', PARAM_INT);
        if (isset( $accrediblecertificate->includegradeattribute ) && $accrediblecertificate->includegradeattribute == 1) {
            $mform->setDefault('includegradeattribute', 1);
            $includegradewrapperhtml = '<div id="include-grade-select-container">';
        } else {
            $includegradewrapperhtml = '<div id="include-grade-select-container" class="hidden">';
        }

        $mform->addElement('html', $includegradewrapperhtml);
        $mform->addElement('select', 'gradeattributegradeitemid', get_string('gradeattributegradeitemselect', 'accredible'),
            $formhelper->load_grade_item_options($id), $inputstyle);
        $mform->addElement('select', 'gradeattributekeyname', get_string('gradeattributekeynameselect', 'accredible'),
            $attributekeyschoices, $inputstyle);
        $mform->disabledIf('gradeattributekeyname', 'attributekysnumber', 'eq', 0);
        $mform->addElement('static', 'emptygradeattributekeyname', '', get_string('emptygradeattributekeyname', 'accredible',
            $dashboardurl));
        $mform->addElement('html', '</div>');

        if ($updatingcert && $accrediblecertificate->achievementid) {
            // Grab the list of templates available.
            $templates = $groupsclient->get_templates();
            $mform->addElement('static', 'usestemplatesdescription', '', get_string('usestemplatesdescription', 'accredible'));
            $mform->addElement('select', 'achievementid', get_string('groupselect', 'accredible'), $templates);
            $mform->addRule('achievementid', null, 'required', null, 'client');
            $mform->setDefault('achievementid', $course->shortname);

            if ($alreadyexists) {
                $mform->addElement('static', 'additionalactivitiesthree', '',
                    get_string('additionalactivitiesthree', 'accredible'));
            }
            $mform->addElement('text', 'certificatename',
                get_string('certificatename', 'accredible'), ['style' => 'width: 399px']);
            $mform->addRule('certificatename', null, 'required', null, 'client');
            $mform->setType('certificatename', PARAM_TEXT);
            $mform->setDefault('certificatename', $course->fullname);

            $mform->addElement('textarea', 'description',
                get_string('description', 'accredible'),
                ['cols' => '64', 'rows' => '10', 'wrap' => 'virtual', 'maxlength' => '1000']);
            $mform->addRule('description', null, 'required', null, 'client');
            $mform->setType('description', PARAM_RAW);
            $mform->setDefault('description', $description);
            if ($updatingcert) {
                $mform->addElement('static', 'dashboardlink',
                    get_string('dashboardlink', 'accredible'), get_string('dashboardlinktext', 'accredible'));
            }
        }

        // Users who pass the requirements but not have credential.
        if (isset($userswithcredential) && count($userswithcredential) > 0) {
            $mform->addElement('header', 'chooseunissuedusers', get_string('unissuedheader', 'accredible'));
            $mform->addElement('html', '<div class="manual-issue-warning hidden">');
            $mform->addElement('static', 'nouserswarning', '', get_string('nouserswarning', 'accredible'));
            $mform->addElement('html', '</div>');
            $mform->addElement('static', 'unissueddescription', '', get_string('unissueddescription', 'accredible'));
            $this->add_checkbox_controller(2, 'Select All/None');
            $mform->addElement('html', '<div id="unissued-users-container">');

            $unissuedusers = $usersclient->get_unissued_users($userswithcredential, $cm->instance);

            foreach ($unissuedusers as $user) {
                // No existing certificate, add this user to the unissued users list.
                $mform->addElement('advcheckbox', 'unissuedusers['.$user['id'].']',
                    $user['name'] . '    ' . $user['email'], null, ['group' => 2]);
            }
            $mform->addElement('html', '</div>');
        }

        // Manually issue certificates header.
        $mform->addElement('header', 'chooseusers', get_string('manualheader', 'accredible'));
        // Hidden message to be displayed with Javascript when no users are available.
        $mform->addElement('html', '<div class="manual-issue-warning hidden">');
        $mform->addElement('static', 'nouserswarning', '', get_string('nouserswarning', 'accredible'));
        $mform->addElement('html', '</div>');
        $this->add_checkbox_controller(1, 'Select All/None');
        $mform->addElement('html', '<div id="manual-issue-users-container">');

        if ($updatingcert) {
            foreach ($userswithcredential as $user) {
                // Show the certificate if they have a certificate.
                if ($user['credential_id']) {
                    $mform->addElement('static', 'certlink'.$user['id'],
                        $user['name'] . '    ' . $user['email'],
                        'Certificate '. $user['credential_id'].' - <a href='.$user['credential_url'].' target="_blank">link</a>');
                    $mform->addElement('html', '<div class="hidden">');
                    $mform->addElement('advcheckbox', 'users['.$user['id'].']',
                        $user['name'] . '    ' . $user['email'], null, ['group' => 1]);
                    $mform->addElement('html', '</div>');
                } else { // Show a checkbox if they don't.
                    $mform->addElement('advcheckbox', 'users['.$user['id'].']',
                        $user['name'] . '    ' . $user['email'], null, ['group' => 1]);
                }
            }
        } else { // For new modules, just list all the users.
            foreach ($users as $user) {
                $mform->addElement('advcheckbox', 'users['.$user->id.']',
                    $user->firstname . ' ' . $user->lastname . '    ' . $user->email, null, ['group' => 1]);
            }
        }
        $mform->addElement('html', '</div>');

        $mform->addElement('header', 'gradeissue', get_string('gradeissueheader', 'accredible'));
        $mform->addElement('select', 'finalquiz', get_string('chooseexam', 'accredible'), $quizchoices);
        $mform->addElement('text', 'passinggrade', get_string('passinggrade', 'accredible'));
        $mform->setType('passinggrade', PARAM_INT);
        $mform->setDefault('passinggrade', 70);

        $mform->addElement('header', 'completionissue', get_string('completionissueheader', 'accredible'));
        $mform->addElement('checkbox', 'completionactivities', get_string('completionissuecheckbox', 'accredible'));
        if ($updatingcert && isset($accrediblecertificate->completionactivities)) {
            $mform->setDefault('completionactivities', 1);
        }

        $attributemappingdefaultvalues =
            $formhelper->attributemapping_default_values(
                $updatingcert ? $accrediblecertificate->attributemapping : null
            );

        // Attribute mapping: course fields.
        $mform->addElement('header', 'attributemappingcoursefields', get_string('attributemappingcoursefields', 'accredible'));

        $coursefieldmappings = $attributemappingdefaultvalues['coursefieldmapping'];
        $coursefieldmappingcontent = [
            'mappings' => $coursefieldmappings,
            'section' => 'coursefieldmapping',
            'hasmappings' => isset($coursefieldmappings),
            'accredibleoptions' => $accredibleoptions,
            'moodleoptions' => $coursefieldoptions,
        ];

        $mform->addElement('html', $OUTPUT->render_from_template('mod_accredible/mappings', $coursefieldmappingcontent));

        // Attribute mapping: course custom fields.
        $mform->addElement(
            'header',
            'attributemappingcoursecustomfields',
            get_string('attributemappingcoursecustomfields', 'accredible')
        );

        $coursecustomfieldmappings = $attributemappingdefaultvalues['coursecustomfieldmapping'];
        $coursecustomfieldmappingcontent = [
            'mappings' => $coursecustomfieldmappings,
            'section' => 'coursecustomfieldmapping',
            'hasid' => true,
            'hasmappings' => isset($coursecustomfieldmappings),
            'accredibleoptions' => $accredibleoptions,
            'moodleoptions' => $coursecustomfieldoptions,
            'nocoursecustomoptions' => count($coursecustomfieldoptions) == 1,
        ];

        $mform->addElement('html', $OUTPUT->render_from_template('mod_accredible/mappings', $coursecustomfieldmappingcontent));

        // Attribute mapping: user profile fields.
        $mform->addElement('header',
            'attributemappinguserprofilefields',
            get_string('attributemappinguserprofilefields', 'accredible')
        );

        $userprofilefieldmappings = $attributemappingdefaultvalues['userprofilefieldmapping'];
        $userprofilefieldmappingcontent = [
            'mappings' => $userprofilefieldmappings,
            'section' => 'userprofilefieldmapping',
            'hasid' => true,
            'hasmappings' => isset($userprofilefieldmappings),
            'accredibleoptions' => $accredibleoptions,
            'moodleoptions' => $userprofilefieldoptions,
            'noprofileoptions' => count($userprofilefieldoptions) == 1,
        ];

        $mform->addElement('html', $OUTPUT->render_from_template('mod_accredible/mappings', $userprofilefieldmappingcontent));

        $this->standard_coursemodule_elements();
        $this->add_action_buttons();
    }

    /**
     * Called right before form submission.
     * We use it to include missing form data from mustache templates.
     *
     * @param stdClass $data passed by reference
     * @return void
     */
    public function data_postprocessing($data) {
        parent::data_postprocessing($data);
        $submitteddata = $this->_form->getSubmitValues();

        $formhelper = new formhelper();
        $data->coursefieldmapping = isset($submitteddata['coursefieldmapping']) ?
            $formhelper->reindexarray($submitteddata['coursefieldmapping']) : [];
        $data->coursecustomfieldmapping = isset($submitteddata['coursecustomfieldmapping']) ?
            $formhelper->reindexarray($submitteddata['coursecustomfieldmapping']) : [];
        $data->userprofilefieldmapping = isset($submitteddata['userprofilefieldmapping']) ?
            $formhelper->reindexarray($submitteddata['userprofilefieldmapping']) : [];
    }

    /**
     * Sets the default value for a mapping field in the form.
     *
     * @param MoodleQuickForm $mform The form instance to modify.
     * @param array $defaultvalues The default values for the form fields.
     * @param string $mappingname The name of the mapping field.
     * @param string $fieldname The specific field within the mapping to set.
     * @param int $num The index of the field in case of multiple fields with the same name.
     */
    private function set_mapping_field_default($mform, $defaultvalues, $mappingname, $fieldname, $num = 0) {
        $value = '';
        if (isset($defaultvalues[$mappingname][$num][$fieldname])) {
            $value = $defaultvalues[$mappingname][$num][$fieldname];
        }
        $mform->setDefault(
            $mappingname . '[' . $num . '][' . $fieldname . ']',
            $value
        );
    }
}