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

/**
 * Teams configuration form
 *
 * @package   mod_teams
 * @copyright 2020 Université Clermont Auvergne
 * @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');
require_once($CFG->dirroot.'/mod/url/locallib.php');
require_once($CFG->dirroot.'/mod/teams/lib.php');
require_once($CFG->dirroot.'/mod/teams/vendor/autoload.php');

class mod_teams_mod_form extends moodleform_mod
{
    /**
     * Form construction.
     * @throws Exception
     * @throws coding_exception
     */
    function definition() {
        global $CFG, $USER, $COURSE, $OUTPUT;
        $mform = $this->_form;
        $error = null;

        $resources = [
            (has_capability('mod/teams:addteam', $this->context, $USER)) ? 'team' : '',
            (has_capability('mod/teams:addmeeting', $this->context, $USER)) ? 'meeting' : '',
        ];
        $resources = array_values(array_filter($resources));

        if (!$resources) {
            // The user has not capability to create any of the Teams resources (team or meeting).
            $this->standard_hidden_coursemodule_elements();
            print_error('nopermissions', 'error', '', get_string('resourceerror', 'mod_teams'));
            return;
        }

        $office = get_office();
        try {
            $userId = $office->getUserId($USER->email);
        } catch (Throwable $th) {
            $error = $th->getMessage();
            $userId = null;
        }

        $has_account = (!empty($userId));

        if ($has_account) {
            // Current user had a correct account.
            $edit_ok = true;
            $default_type = ($this->current->id) ? $this->current->type : $resources[0];
            $default_reuse = ($this->current->id) ? $this->current->reuse_meeting : 1;
            $teamexists = true;
            $default_owners = "managers";

            if (!empty($this->current->id)) {
                // Check edit capability.
                if (!has_capability('mod/teams:add' . $this->current->type, $this->context, $USER)) {
                    // The user has not capability to edit this Teams resource.
                    $this->standard_hidden_coursemodule_elements();
                    print_error('nopermissions', 'error', '', get_string('teams:add' . $this->current->type, 'mod_teams'));
                    return;
                }

                // Resource mod edition.
                if ($this->current->type != "meeting") {
                    try {
                        $team = $office->readTeam($this->current->resource_teams_id);
                        $teamexists = true;
                    } catch (Exception $e) {
                        $teamexists = false;
                    }

                    $default_owners = ($this->current->enrol_managers) ? "managers" : (($this->current->other_owners === null) ? "creator" : "others");
                    if ($this->current->population == "groups") {
                        $this->current->groups = json_decode($this->current->selection);
                    } else {
                        if (!teams_is_owner($this->current, $USER)) {
                            $edit_ok = false;
                        }
                        if ($this->current->population == "users") {
                            $this->current->users = json_decode($this->current->selection);
                        }
                    }
                    if ($this->current->other_owners !== null) {
                        $this->current->other_owners = json_decode($this->current->other_owners);
                    }
                } else {
                    try {
                        $office->getMeetingObject($this->current);
                        $teamexists = true;
                    } catch (Exception $e) {
                        $teamexists = false;
                    }
                }
                // Default name, if prefix is used we do not display it here.
                if (strpos($this->current->name, get_string($default_type . '_prefix', 'mod_teams')) == 0) {
                    $this->current->name = str_replace(get_string($default_type . '_prefix', 'mod_teams'), '', $this->current->name);
                }
            }

            if ($edit_ok) {
                if ($teamexists) {
                    $mform->addElement('header', 'general', get_string('general'));

                    $radioarray = [];
                    foreach ($resources as $resource) {
                        $icon = ($resource == "meeting") ? 'i/calendar' : 'i/cohort';
                        $radioarray[] = $mform->createElement('radio', 'type', '',
                            "<div>" . get_string($resource, 'mod_teams') . '<br/>' . html_writer::tag('img', '', array('alt' => get_string($resource, 'mod_teams'), 'src' => $OUTPUT->image_url($icon, 'core'), 'style' => 'height: 96px;margin-right: 50px;')) . "</div>",
                            $resource);
                    }
                    $mform->addGroup($radioarray, 'type', get_string('type', 'mod_teams'), array(' '), false);
                    $mform->addHelpButton('type', 'type', 'mod_teams');
                    $mform->setDefault('type', $default_type);
                    $mform->disabledIf('type', 'resource_teams_id', 'neq', ''); // Disable if we edit the resource

                    $mform->addElement('text', 'name', get_string('name', 'mod_teams'), 'size=80');
                    $mform->addRule('name', null, 'required', null, 'client');
                    $mform->setType('name', PARAM_TEXT);
                    $mform->addHelpButton('name', 'name', 'mod_teams');

                    $mform->addElement('hidden', 'resource_teams_id');
                    $mform->setType('resource_teams_id', PARAM_TEXT);
                    if ($this->current->id) {
                        $mform->setDefault('resource_teams_id', $this->current->resource_teams_id);
                    }

                    $this->standard_intro_elements();
                    $element = $mform->getElement('introeditor');
                    $attributes = $element->getAttributes();
                    $attributes['rows'] = 5;
                    $element->setAttributes($attributes);

                    /* -- Team creation -- */
                    $groupteamitems = array();
                    $groupteamitems[] =& $mform->createElement('html', get_string('desc', 'mod_teams'));
                    $groupteam = $mform->createElement('group', 'group_team', false, $groupteamitems, null, false);
                    $mform->addElement($groupteam);

                    $populationslist = [
                        'course' => get_string('population_all', 'mod_teams'),
                        'students' => get_string('population_students', 'mod_teams'),
                        'groups' => get_string('population_groups', 'mod_teams'),
                        'users' => get_string('population_users', 'mod_teams'),
                    ];

                    $coursecontext = context_course::instance($COURSE->id);
                    $groups = [];
                    $enrolled = [];
                    if (count(groups_get_all_groups($COURSE->id)) > 0) {
                        foreach (groups_get_all_groups($COURSE->id) as $group) {
                            $groups[$group->id] = $group->name;
                        }
                    } else {
                        unset($populationslist['groups']);
                    }
                    foreach (get_enrolled_users($coursecontext, 'mod/teams:view') as $user) {
                        $enrolled[$user->email] = fullname($user);
                    }

                    $mform->addElement('select', 'population', get_string('population', 'mod_teams'), $populationslist);
                    $mform->addHelpButton('population', 'population', 'mod_teams');

                    $mform->addElement('searchableselector', 'groups', get_string('group'), $groups, array('multiple'));
                    $mform->hideIf('groups', 'population', 'eq', 'course');
                    $mform->hideIf('groups', 'population', 'eq', 'students');
                    $mform->hideIf('groups', 'population', 'eq', 'users');

                    $mform->addElement('searchableselector', 'users', get_string('users'), $enrolled, array('multiple'));
                    $mform->hideIf('users', 'population', 'eq', 'course');
                    $mform->hideIf('users', 'population', 'eq', 'students');
                    $mform->hideIf('users', 'population', 'eq', 'groups');

                    $mform->hideIf('group_team', 'type', 'eq', 'meeting');
                    $mform->hideIf('population', 'type', 'eq', 'meeting');
                    $mform->hideIf('groups', 'type', 'eq', 'meeting');
                    $mform->hideIf('users', 'type', 'eq', 'meeting');
                    $mform->hideIf('enrol_managers', 'type', 'eq', 'meeting');

                    $ownerschoice = [
                        'creator' => get_string('owners_creator', 'mod_teams'),
                        'others' => get_string('owners_others', 'mod_teams'),
                        'managers' => get_string('owners_managers', 'mod_teams'),
                    ];

                    $mform->addElement('select', 'owners', get_string('owners', 'mod_teams'), $ownerschoice);
                    $mform->addHelpButton('owners', 'owners', 'mod_teams');
                    $mform->setDefault('owners', $default_owners);
                    $mform->hideIf('owners', 'type', 'eq', 'meeting');
                    $mform->hideIf('owners', 'population', 'eq', 'course');

                    $mform->addElement('searchableselector', 'other_owners', get_string('other_owners', 'mod_teams'), $enrolled, array('multiple'));
                    $mform->addHelpButton('other_owners', 'other_owners', 'mod_teams');
                    $mform->hideIf('other_owners', 'population', 'eq', 'course');
                    $mform->hideIf('other_owners', 'owners', 'neq', 'others');

                    /* -- Meeting creation -- */
                    $reusearray = array();
                    $reusearray[] = $mform->createElement('radio', 'reuse_meeting', '', get_string('reuse_meeting_yes', 'mod_teams'), 1);
                    $reusearray[] = $mform->createElement('radio', 'reuse_meeting', '', get_string('reuse_meeting_no', 'mod_teams'), 0);
                    $mform->addGroup($reusearray, 'reuse_meeting', get_string('reuse_meeting', 'mod_teams'), array(' '), false);
                    $mform->addHelpButton('reuse_meeting', 'reuse_meeting', 'mod_teams');
                    $mform->setDefault('reuse_meeting', $default_reuse);
                    $mform->hideIf('reuse_meeting', 'type', 'eq', 'team');
                    $mform->disabledIf('reuse_meeting', 'team_id', 'neq', ''); // Disable if we edit the resource

                    $enableopengroup = array();
                    $enableopengroup[] =& $mform->createElement('date_time_selector', 'opendate', '');
                    $enableopengroup[] =& $mform->createElement('checkbox', 'useopendate', get_string('enable', 'moodle'));
                    $mform->addGroup($enableopengroup, 'enableopengroup', get_string('opendate', 'mod_teams'), ' ', false);
                    $mform->addHelpButton('enableopengroup', 'opendate', 'mod_teams');
                    $mform->disabledIf('enableopengroup', 'useopendate', 'notchecked');

                    $enableclosegroup = array();
                    $enableclosegroup[] =& $mform->createElement('date_time_selector', 'closedate', '');
                    $enableclosegroup[] =& $mform->createElement('checkbox', 'useclosedate', get_string('enable', 'moodle'));
                    $enableclosegroup[] =& $mform->addGroup($enableclosegroup, 'enableclosegroup', get_string('closedate', 'mod_teams'), ' ', false);
                    $mform->addHelpButton('enableclosegroup', 'closedate', 'mod_teams');
                    $mform->disabledIf('enableclosegroup', 'useclosedate', 'notchecked');

                    $mform->hideIf('enableopengroup', 'type', 'eq', 'team');
                    $mform->hideIf('enableclosegroup', 'type', 'eq', 'team');
                    $mform->hideIf('enableopengroup', 'reuse_meeting', 'eq', 1);
                    $mform->hideIf('enableclosegroup', 'reuse_meeting', 'eq', 1);

                    $dateitems = array();
                    $dateitems[] =& $mform->createElement('html', get_string('dates_help', 'mod_teams'));
                    $dategroup = $mform->createElement('group', 'group_date', false, $dateitems, null, false);
                    $mform->addElement($dategroup);
                    $mform->hideIf('group_date', 'type', 'eq', 'team');

                    $this->standard_coursemodule_elements();
                    $this->add_action_buttons();
                } else {
                    // Resource not found (edit mode).
                    $this->standard_hidden_coursemodule_elements();
                    notice(get_string('teamnotfound', 'mod_teams'), new moodle_url('/course/view.php', array('id' => $this->current->course)));
                    die;
                }
            } else {
                // The current user does not have the rights to edit the resource info.
                $this->standard_hidden_coursemodule_elements();
                $mform->addElement('html', '<div class="alert alert-danger">' . get_string('no_owner', 'teams', $error) . '</div>');
                $mform->addElement('cancel', '', get_string('back', 'teams'));
            }
        } else {
            // The current user does not have an Azure AD account -> impossible to add a teams instance.
            $this->standard_hidden_coursemodule_elements();
            $identifer = ($error) ? 'teamserror' : 'noaccount';
            $mform->addElement('html', '<div class="alert alert-danger">' . get_string($identifer, 'teams', $error) . '</div>');
            $mform->addElement('cancel', '', get_string('back', 'teams'));
        }
    }

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

        if ($data['type'] == "team") { // Teams creation.
            // Checks if at least one group is selected.
            if (isset($data['population']) && $data['population'] == "groups" && count($data['groups']) < 1) {
                $errors['groups'] = get_string('error_groups', 'mod_teams');
            }

            // Checks if at least one user is selected.
            if (isset($data['population']) && $data['population'] == "users" && count($data['users']) < 1) {
                $errors['users'] = get_string('error_users', 'mod_teams');
            }
        } else { // Online meeting creation.
            // Checks dates choice consistency.
            if (isset($data['useopendate']) && isset($data['useclosedate']) && $data['closedate'] < $data['opendate']) {
                $errors['enableclosegroup'] = get_string('error_dates', 'mod_teams');
            }
            // Checks close date is not already past.
            if (isset($data['useclosedate']) && $data['closedate'] < time()) {
                $errors['enableclosegroup'] = get_string('error_dates_past', 'mod_teams');
            }
        }

        return $errors;
    }

    /**
     * Fix default values for date fields.
     * @param array $defaultvalues
     */
    public function data_preprocessing(&$defaultvalues) {
        global $DB;
        if (empty($defaultvalues['opendate'])) {
            $defaultvalues['useopendate'] = 0;
        } else {
            $defaultvalues['useopendate'] = 1;
        }
        if (empty($defaultvalues['closedate'])) {
            $defaultvalues['useclosedate'] = 0;
        } else {
            $defaultvalues['useclosedate'] = 1;
        }
    }

    /**
     * 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);
        if (!empty($data->completionunlocked)) {
            $autocompletion = !empty($data->completion) && $data->completion == COMPLETION_TRACKING_AUTOMATIC;
            if (empty($data->completionentriesenabled) || !$autocompletion) {
                $data->completionentries = 0;
            }
        }

        // "No selection" case
        if (!empty($data->groups)) {
            if (($key = array_search("", $data->groups)) !== false) {
                unset($data->groups[$key]);
            }
            $data->groups = array_values($data->groups);
        }
        if (!empty($data->users)) {
            if (($key = array_search("", $data->users)) !== false) {
                unset($data->users[$key]);
            }
            $data->users = array_values($data->users);
        }
        if (!empty($data->other_owners)) {
            if (($key = array_search("", $data->other_owners)) !== false) {
                unset($data->other_owners[$key]);
            }
            $data->other_owners = array_values($data->other_owners);
        }
    }

}