mirror of
https://github.com/moodle/moodle.git
synced 2025-01-18 22:08:20 +01:00
767 lines
36 KiB
PHP
767 lines
36 KiB
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/>.
|
|
|
|
/**
|
|
* Config all BigBlueButtonBN instances in this course.
|
|
*
|
|
* @package mod_bigbluebuttonbn
|
|
* @copyright 2010 onwards, Blindside Networks Inc
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
* @author Jesus Federico (jesus [at] blindsidenetworks [dt] com)
|
|
* @author Fred Dixon (ffdixon [at] blindsidenetworks [dt] com)
|
|
*/
|
|
|
|
use mod_bigbluebuttonbn\extension;
|
|
use mod_bigbluebuttonbn\instance;
|
|
use mod_bigbluebuttonbn\local\helpers\roles;
|
|
use mod_bigbluebuttonbn\local\proxy\bigbluebutton_proxy;
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
global $CFG;
|
|
require_once($CFG->dirroot . '/course/moodleform_mod.php');
|
|
|
|
/**
|
|
* Moodle class for mod_form.
|
|
*
|
|
* @copyright 2010 onwards, Blindside Networks Inc
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class mod_bigbluebuttonbn_mod_form extends moodleform_mod {
|
|
|
|
/**
|
|
* @var array $formextensions extensions to this form
|
|
*/
|
|
protected $formextensions = [];
|
|
/**
|
|
* Define (add) particular settings this activity can have.
|
|
*
|
|
* @return void
|
|
* @throws moodle_exception
|
|
*/
|
|
public function definition(): void {
|
|
global $CFG, $DB, $PAGE;
|
|
$mform = &$this->_form;
|
|
|
|
// Validates if the BigBlueButton server is running.
|
|
$serverversion = bigbluebutton_proxy::get_server_version();
|
|
if (is_null($serverversion)) {
|
|
throw new moodle_exception('general_error_unable_connect',
|
|
'bigbluebuttonbn',
|
|
$CFG->wwwroot . '/admin/settings.php?section=modsettingbigbluebuttonbn',
|
|
\mod_bigbluebuttonbn\local\config::get('server_url')
|
|
);
|
|
}
|
|
// UI configuration options.
|
|
$cfg = \mod_bigbluebuttonbn\local\config::get_options();
|
|
|
|
// Get only those that are allowed.
|
|
$course = $this->_course;
|
|
$context = context_course::instance($course->id);
|
|
$bigbluebuttonbn = empty($this->get_current()->id) ? null : $this->get_current();
|
|
|
|
$this->formextensions = extension::mod_form_addons_instances($mform, $bigbluebuttonbn, $this->get_suffix());
|
|
|
|
$instancetyperofiles = $this->get_instance_type_profiles();
|
|
$this->bigbluebuttonbn_mform_add_block_profiles($mform, $instancetyperofiles);
|
|
// Data for participant selection.
|
|
$participantlist = roles::get_participant_list($bigbluebuttonbn, $context);
|
|
// Add block 'General'.
|
|
$this->bigbluebuttonbn_mform_add_block_general($mform, $cfg);
|
|
// Add block 'Room'.
|
|
$this->bigbluebuttonbn_mform_add_block_room($mform, $cfg);
|
|
// Add block 'Lock'.
|
|
$this->bigbluebuttonbn_mform_add_block_locksettings($mform, $cfg);
|
|
// Add block 'Preuploads'.
|
|
$this->bigbluebuttonbn_mform_add_block_preuploads($mform, $cfg);
|
|
// Add block 'Participant List'.
|
|
$this->bigbluebuttonbn_mform_add_block_user_role_mapping($mform, $participantlist);
|
|
// Add block 'Guest Access'.
|
|
$this->bigbluebuttonbn_mform_add_block_guest_access($mform, $cfg, $this->current);
|
|
// Add block 'Schedule'.
|
|
$this->bigbluebuttonbn_mform_add_block_schedule($mform, $this->current);
|
|
// Now add subplugins form elements.
|
|
$this->add_subplugins_elements();
|
|
|
|
// Add standard elements, common to all modules.
|
|
$this->standard_coursemodule_elements();
|
|
// Add standard buttons, common to all modules.
|
|
$this->add_action_buttons();
|
|
|
|
$jsvars = [
|
|
'instanceTypeDefault' => array_keys($instancetyperofiles)[0],
|
|
];
|
|
|
|
// Now add the instance type profiles to the form as a html hidden field.
|
|
$mform->addElement('html', html_writer::div('', 'd-none', [
|
|
'data-profile-types' => json_encode($instancetyperofiles),
|
|
'data-participant-data' => json_encode(roles::get_participant_data($context, $bigbluebuttonbn)),
|
|
]));
|
|
|
|
$PAGE->requires->js_call_amd('mod_bigbluebuttonbn/modform', 'init', [$jsvars]);
|
|
}
|
|
|
|
/**
|
|
* Get instance type profile.
|
|
*
|
|
* @return array|array[]
|
|
* @throws moodle_exception
|
|
*/
|
|
protected function get_instance_type_profiles() {
|
|
// Add profile data here instead of passing it by parameters.
|
|
$context = context_course::instance($this->_course->id);
|
|
$instancetyperofiles = bigbluebutton_proxy::get_instance_type_profiles_create_allowed(
|
|
has_capability('mod/bigbluebuttonbn:addinstancewithmeeting', $context),
|
|
has_capability('mod/bigbluebuttonbn:addinstancewithrecording', $context)
|
|
);
|
|
// If none is allowed, fail and return.
|
|
if (empty($instancetyperofiles)) {
|
|
global $CFG;
|
|
// Also check module context for those that are allowed.
|
|
$contextm = context_module::instance($this->_cm->id);
|
|
$instancetyperofiles = bigbluebutton_proxy::get_instance_type_profiles_create_allowed(
|
|
has_capability('mod/bigbluebuttonbn:addinstancewithmeeting', $contextm),
|
|
has_capability('mod/bigbluebuttonbn:addinstancewithrecording', $contextm)
|
|
);
|
|
// If still none is allowed, fail and return.
|
|
if (empty($instancetyperofiles)) {
|
|
throw new moodle_exception('general_error_not_allowed_to_create_instances', 'bigbluebuttonbn',
|
|
$CFG->wwwroot . '/admin/settings.php?section=modsettingbigbluebuttonbn');
|
|
}
|
|
}
|
|
return $instancetyperofiles;
|
|
}
|
|
|
|
/**
|
|
* Prepare the attachment for being stored.
|
|
*
|
|
* @param array|null $defaultvalues
|
|
* @return void
|
|
*/
|
|
public function data_preprocessing(&$defaultvalues) {
|
|
parent::data_preprocessing($defaultvalues);
|
|
|
|
$suffix = $this->get_suffix();
|
|
$completionattendanceenabledel = 'completionattendanceenabled' . $suffix;
|
|
$completionattendanceel = 'completionattendance' . $suffix;
|
|
|
|
// Completion: tick by default if completion attendance settings is set to 1 or more.
|
|
$defaultvalues[$completionattendanceenabledel] = 0;
|
|
if (!empty($defaultvalues[$completionattendanceel])) {
|
|
$defaultvalues[$completionattendanceenabledel] = 1;
|
|
}
|
|
// Check if we are Editing an existing instance.
|
|
if ($this->current->instance) {
|
|
// Pre-uploaded presentation: copy existing files into draft area.
|
|
try {
|
|
$draftitemid = file_get_submitted_draft_itemid('presentation');
|
|
file_prepare_draft_area($draftitemid, $this->context->id, 'mod_bigbluebuttonbn', 'presentation', 0,
|
|
['subdirs' => 0, 'maxbytes' => 0, 'maxfiles' => 1, 'mainfile' => true]
|
|
);
|
|
$defaultvalues['presentation'] = $draftitemid;
|
|
} catch (Exception $e) {
|
|
debugging('Presentation could not be loaded: ' . $e->getMessage(), DEBUG_DEVELOPER);
|
|
return;
|
|
}
|
|
// Completion: tick if completion attendance settings is set to 1 or more.
|
|
$defaultvalues[$completionattendanceenabledel] = 0;
|
|
if (!empty($this->current->{$completionattendanceel})) {
|
|
$defaultvalues[$completionattendanceenabledel] = 1;
|
|
}
|
|
}
|
|
foreach ($this->formextensions as $formextension) {
|
|
$formextension->data_preprocessing($defaultvalues);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Validates the data processed by the form.
|
|
*
|
|
* @param mixed $data
|
|
* @param array $files
|
|
* @return array
|
|
*/
|
|
public function validation($data, $files) {
|
|
$errors = parent::validation($data, $files);
|
|
if (isset($data['openingtime']) && isset($data['closingtime'])) {
|
|
if ($data['openingtime'] != 0 && $data['closingtime'] != 0 &&
|
|
$data['closingtime'] < $data['openingtime']) {
|
|
$errors['closingtime'] = get_string('bbbduetimeoverstartingtime', 'bigbluebuttonbn');
|
|
}
|
|
}
|
|
if (isset($data['voicebridge'])) {
|
|
if (!bigbluebutton_proxy::is_voicebridge_number_unique($data['instance'], $data['voicebridge'])) {
|
|
$errors['voicebridge'] = get_string('mod_form_field_voicebridge_notunique_error', 'bigbluebuttonbn');
|
|
}
|
|
}
|
|
$additionalsubpluginerrors = [];
|
|
foreach ($this->formextensions as $formextension) {
|
|
$additionalsubpluginerrors = array_merge($additionalsubpluginerrors, $formextension->validation($data, $files));
|
|
}
|
|
return array_merge($errors, $additionalsubpluginerrors);
|
|
}
|
|
|
|
/**
|
|
* Add elements for setting the custom completion rules.
|
|
*
|
|
* @return array List of added element names, or names of wrapping group elements.
|
|
* @category completion
|
|
*/
|
|
public function add_completion_rules(): array {
|
|
$mform = $this->_form;
|
|
if (!(boolean) \mod_bigbluebuttonbn\local\config::get('meetingevents_enabled')) {
|
|
return [];
|
|
}
|
|
|
|
$suffix = $this->get_suffix();
|
|
|
|
// Elements for completion by Attendance.
|
|
$attendance['rulelabel'] = get_string('completionattendance', 'bigbluebuttonbn');
|
|
$completionattendanceenabledel = 'completionattendanceenabled' . $suffix;
|
|
$completionattendanceel = 'completionattendance' . $suffix;
|
|
$completionattendanceunitel = 'completionattendanceunit' . $suffix;
|
|
$attendance['group'] = [
|
|
$mform->createElement('advcheckbox', $completionattendanceenabledel, '', $attendance['rulelabel'] . ' '),
|
|
$mform->createElement('text', $completionattendanceel, 'minutes', ['size' => 3]),
|
|
];
|
|
$mform->setType($completionattendanceel, PARAM_INT);
|
|
$completionattendancegroupel = 'completionattendancegroup' . $suffix;
|
|
$mform->addGroup($attendance['group'], $completionattendancegroupel, '', ' ', false);
|
|
$completionel = 'completion' . $suffix;
|
|
$mform->hideIf($completionattendancegroupel, $completionel, 'neq', COMPLETION_AGGREGATION_ANY);
|
|
$mform->hideIf($completionattendanceel, $completionattendanceenabledel, 'notchecked');
|
|
|
|
// Elements for completion by Engagement.
|
|
$engagement['chatlabel'] = get_string('completionengagementchats', 'bigbluebuttonbn');
|
|
$engagement['talklabel'] = get_string('completionengagementtalks', 'bigbluebuttonbn');
|
|
$engagement['raisehand'] = get_string('completionengagementraisehand', 'bigbluebuttonbn');
|
|
$engagement['pollvotes'] = get_string('completionengagementpollvotes', 'bigbluebuttonbn');
|
|
$engagement['emojis'] = get_string('completionengagementemojis', 'bigbluebuttonbn');
|
|
|
|
$completionengagementchatsel = 'completionengagementchats' . $suffix;
|
|
$completionengagementtalksel = 'completionengagementtalks' . $suffix;
|
|
$completionengagementraisehandel = 'completionengagementraisehand' . $suffix;
|
|
$completionengagementpollvotesel = 'completionengagementpollvotes' . $suffix;
|
|
$completionengagementemojisel = 'completionengagementemojis' . $suffix;
|
|
$engagement['group'] = [
|
|
$mform->createElement('advcheckbox', $completionengagementchatsel, '', $engagement['chatlabel'] . ' '),
|
|
$mform->createElement('advcheckbox', $completionengagementtalksel, '', $engagement['talklabel'] . ' '),
|
|
$mform->createElement('advcheckbox', $completionengagementraisehandel, '', $engagement['raisehand'] . ' '),
|
|
$mform->createElement('advcheckbox', $completionengagementpollvotesel, '', $engagement['pollvotes'] . ' '),
|
|
$mform->createElement('advcheckbox', $completionengagementemojisel, '', $engagement['emojis'] . ' '),
|
|
];
|
|
$completionengagementgroupel = 'completionengagementgroup' . $suffix;
|
|
$mform->addGroup($engagement['group'], $completionengagementgroupel, '', ' ', false);
|
|
$mform->addGroupRule($completionattendancegroupel, [
|
|
$completionattendanceel => [
|
|
[null, 'numeric', null, 'client']
|
|
]
|
|
]);
|
|
$mform->hideIf($completionengagementgroupel, $completionel, 'neq', COMPLETION_AGGREGATION_ANY);
|
|
|
|
$completionrules = [$completionattendancegroupel, $completionengagementgroupel];
|
|
foreach ($this->formextensions as $formextension) {
|
|
$completionrules = array_merge($completionrules, $formextension->add_completion_rules());
|
|
}
|
|
return $completionrules;
|
|
}
|
|
|
|
/**
|
|
* Called during validation to see whether some module-specific completion rules are selected.
|
|
*
|
|
* @param array $data Input data not yet validated.
|
|
* @return bool True if one or more rules is enabled, false if none are.
|
|
*/
|
|
public function completion_rule_enabled($data) {
|
|
$suffix = $this->get_suffix();
|
|
$rules = [
|
|
'completionattendanceenabled',
|
|
'completionattendance',
|
|
'completionengagementchats',
|
|
'completionengagementtalks',
|
|
'completionengagementraisehand',
|
|
'completionengagementpollvotes',
|
|
'completionengagementemojis'
|
|
];
|
|
$enabled = array_reduce($rules, function($carry, $rule) use ($data, $suffix) {
|
|
return $carry || !empty($data[$rule . $suffix]);
|
|
}, false);
|
|
|
|
foreach ($this->formextensions as $formextension) {
|
|
$enabled = $enabled || $formextension->completion_rule_enabled($data);
|
|
}
|
|
return $enabled;
|
|
}
|
|
|
|
/**
|
|
* Allows module 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);
|
|
// Turn off completion settings if the checkboxes aren't ticked.
|
|
if (!empty($data->completionunlocked)) {
|
|
$suffix = $this->get_suffix();
|
|
$completion = $data->{'completion' . $suffix};
|
|
$autocompletion = !empty($completion) && $completion == COMPLETION_TRACKING_AUTOMATIC;
|
|
if (empty($data->{'completionattendanceenabled' . $suffix}) || !$autocompletion) {
|
|
$data->{'completionattendance' . $suffix} = 0;
|
|
}
|
|
}
|
|
foreach ($this->formextensions as $formextension) {
|
|
$formextension->data_postprocessing($data);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Function for showing the block for selecting profiles.
|
|
*
|
|
* @param MoodleQuickForm $mform
|
|
* @param array $profiles
|
|
* @return void
|
|
*/
|
|
private function bigbluebuttonbn_mform_add_block_profiles(MoodleQuickForm &$mform, array $profiles): void {
|
|
if ((boolean) \mod_bigbluebuttonbn\local\config::recordings_enabled()) {
|
|
$mform->addElement('select', 'type', get_string('mod_form_field_instanceprofiles', 'bigbluebuttonbn'),
|
|
bigbluebutton_proxy::get_instance_profiles_array($profiles));
|
|
$mform->addHelpButton('type', 'mod_form_field_instanceprofiles', 'bigbluebuttonbn');
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Function for showing the block for general settings.
|
|
*
|
|
* @param MoodleQuickForm $mform
|
|
* @param array $cfg
|
|
* @return void
|
|
*/
|
|
private function bigbluebuttonbn_mform_add_block_general(MoodleQuickForm &$mform, array $cfg): void {
|
|
global $CFG;
|
|
$mform->addElement('header', 'general', get_string('mod_form_block_general', 'bigbluebuttonbn'));
|
|
$mform->addElement('text', 'name', get_string('mod_form_field_name', 'bigbluebuttonbn'),
|
|
'maxlength="64" size="32"');
|
|
$mform->setType('name', empty($CFG->formatstringstriptags) ? PARAM_CLEANHTML : PARAM_TEXT);
|
|
$mform->addRule('name', null, 'required', null, 'client');
|
|
$this->standard_intro_elements(get_string('mod_form_field_intro', 'bigbluebuttonbn'));
|
|
$mform->setAdvanced('introeditor');
|
|
$mform->setAdvanced('showdescription');
|
|
}
|
|
|
|
/**
|
|
* Function for showing details of the room settings for the room.
|
|
*
|
|
* @param MoodleQuickForm $mform
|
|
* @param array $cfg
|
|
* @return void
|
|
*/
|
|
private function bigbluebuttonbn_mform_add_block_room_room(MoodleQuickForm &$mform, array $cfg): void {
|
|
$field = ['type' => 'hidden', 'name' => 'welcome', 'data_type' => PARAM_INT,
|
|
'description_key' => null];
|
|
if ($cfg['welcome_editable']) {
|
|
$field['type'] = 'textarea';
|
|
$field['data_type'] = PARAM_CLEANHTML;
|
|
$field['description_key'] = 'mod_form_field_welcome';
|
|
$this->bigbluebuttonbn_mform_add_element($mform, $field['type'], $field['name'], $field['data_type'],
|
|
$field['description_key'], $cfg['welcome_default'], ['wrap' => 'virtual', 'rows' => 5, 'cols' => '60']);
|
|
}
|
|
$field = ['type' => 'hidden', 'name' => 'voicebridge', 'data_type' => PARAM_INT,
|
|
'description_key' => null];
|
|
if ($cfg['voicebridge_editable']) {
|
|
$field['type'] = 'text';
|
|
$field['data_type'] = PARAM_TEXT;
|
|
$field['description_key'] = 'mod_form_field_voicebridge';
|
|
$this->bigbluebuttonbn_mform_add_element($mform, $field['type'], $field['name'], $field['data_type'],
|
|
$field['description_key'], 0, ['maxlength' => 4, 'size' => 6],
|
|
['message' => get_string('mod_form_field_voicebridge_format_error', 'bigbluebuttonbn'),
|
|
'type' => 'numeric', 'rule' => '####', 'validator' => 'server']
|
|
);
|
|
} else {
|
|
$this->bigbluebuttonbn_mform_add_element($mform, $field['type'], $field['name'], $field['data_type'],
|
|
$field['description_key'], 0, ['maxlength' => 4, 'size' => 6]);
|
|
}
|
|
$field = ['type' => 'hidden', 'name' => 'wait', 'data_type' => PARAM_INT, 'description_key' => null];
|
|
if ($cfg['waitformoderator_editable']) {
|
|
$field['type'] = 'checkbox';
|
|
$field['description_key'] = 'mod_form_field_wait';
|
|
}
|
|
$this->bigbluebuttonbn_mform_add_element($mform, $field['type'], $field['name'], $field['data_type'],
|
|
$field['description_key'], $cfg['waitformoderator_default']);
|
|
$field = ['type' => 'hidden', 'name' => 'userlimit', 'data_type' => PARAM_INT, 'description_key' => null];
|
|
if ($cfg['userlimit_editable']) {
|
|
$field['type'] = 'text';
|
|
$field['data_type'] = PARAM_TEXT;
|
|
$field['description_key'] = 'mod_form_field_userlimit';
|
|
}
|
|
$this->bigbluebuttonbn_mform_add_element($mform, $field['type'], $field['name'], $field['data_type'],
|
|
$field['description_key'], $cfg['userlimit_default']);
|
|
$field = ['type' => 'hidden', 'name' => 'record', 'data_type' => PARAM_INT, 'description_key' => null];
|
|
if ($cfg['recording_editable']) {
|
|
$field['type'] = 'checkbox';
|
|
$field['description_key'] = 'mod_form_field_record';
|
|
}
|
|
$this->bigbluebuttonbn_mform_add_element($mform, $field['type'], $field['name'], $field['data_type'],
|
|
$field['description_key'], $cfg['recording_default']);
|
|
|
|
// Record all from start and hide button.
|
|
$field = ['type' => 'hidden', 'name' => 'recordallfromstart', 'data_type' => PARAM_INT, 'description_key' => null];
|
|
if ($cfg['recording_all_from_start_editable']) {
|
|
$field['type'] = 'checkbox';
|
|
$field['description_key'] = 'mod_form_field_recordallfromstart';
|
|
}
|
|
$this->bigbluebuttonbn_mform_add_element($mform, $field['type'], $field['name'], $field['data_type'],
|
|
$field['description_key'], $cfg['recording_all_from_start_default']);
|
|
|
|
$field = ['type' => 'hidden', 'name' => 'recordhidebutton', 'data_type' => PARAM_INT, 'description_key' => null];
|
|
if ($cfg['recording_hide_button_editable']) {
|
|
$field['type'] = 'checkbox';
|
|
$field['description_key'] = 'mod_form_field_recordhidebutton';
|
|
}
|
|
$this->bigbluebuttonbn_mform_add_element($mform, $field['type'], $field['name'], $field['data_type'],
|
|
$field['description_key'], $cfg['recording_hide_button_default']);
|
|
|
|
$mform->disabledIf('recordallfromstart', 'record');
|
|
$mform->disabledIf('recordhidebutton', 'record');
|
|
$mform->hideIf('recordhidebutton', 'recordallfromstart', 'checked');
|
|
// End Record all from start and hide button.
|
|
|
|
$field = ['type' => 'hidden', 'name' => 'muteonstart', 'data_type' => PARAM_INT, 'description_key' => null];
|
|
if ($cfg['muteonstart_editable']) {
|
|
$field['type'] = 'checkbox';
|
|
$field['description_key'] = 'mod_form_field_muteonstart';
|
|
}
|
|
$this->bigbluebuttonbn_mform_add_element($mform, $field['type'], $field['name'], $field['data_type'],
|
|
$field['description_key'], $cfg['muteonstart_default']);
|
|
|
|
}
|
|
|
|
/**
|
|
* Function for showing details of the lock settings for the room.
|
|
*
|
|
* @param MoodleQuickForm $mform
|
|
* @param array $cfg
|
|
* @return void
|
|
*/
|
|
private function bigbluebuttonbn_mform_add_block_locksettings(MoodleQuickForm &$mform, array $cfg): void {
|
|
$mform->addElement('header', 'lock', get_string('mod_form_locksettings', 'bigbluebuttonbn'));
|
|
|
|
$locksettings = false;
|
|
|
|
$field = ['type' => 'hidden', 'name' => 'disablecam', 'data_type' => PARAM_INT, 'description_key' => null];
|
|
if ($cfg['disablecam_editable']) {
|
|
$field['type'] = 'checkbox';
|
|
$field['description_key'] = 'mod_form_field_disablecam';
|
|
$locksettings = true;
|
|
}
|
|
$this->bigbluebuttonbn_mform_add_element($mform, $field['type'], $field['name'], $field['data_type'],
|
|
$field['description_key'], $cfg['disablecam_default']);
|
|
|
|
$field = ['type' => 'hidden', 'name' => 'disablemic', 'data_type' => PARAM_INT, 'description_key' => null];
|
|
if ($cfg['disablemic_editable']) {
|
|
$field['type'] = 'checkbox';
|
|
$field['description_key'] = 'mod_form_field_disablemic';
|
|
$locksettings = true;
|
|
}
|
|
$this->bigbluebuttonbn_mform_add_element($mform, $field['type'], $field['name'], $field['data_type'],
|
|
$field['description_key'], $cfg['disablemic_default']);
|
|
|
|
$field = ['type' => 'hidden', 'name' => 'disableprivatechat', 'data_type' => PARAM_INT, 'description_key' => null];
|
|
if ($cfg['disableprivatechat_editable']) {
|
|
$field['type'] = 'checkbox';
|
|
$field['description_key'] = 'mod_form_field_disableprivatechat';
|
|
$locksettings = true;
|
|
}
|
|
$this->bigbluebuttonbn_mform_add_element($mform, $field['type'], $field['name'], $field['data_type'],
|
|
$field['description_key'], $cfg['disableprivatechat_default']);
|
|
|
|
$field = ['type' => 'hidden', 'name' => 'disablepublicchat', 'data_type' => PARAM_INT, 'description_key' => null];
|
|
if ($cfg['disablepublicchat_editable']) {
|
|
$field['type'] = 'checkbox';
|
|
$field['description_key'] = 'mod_form_field_disablepublicchat';
|
|
$locksettings = true;
|
|
}
|
|
$this->bigbluebuttonbn_mform_add_element($mform, $field['type'], $field['name'], $field['data_type'],
|
|
$field['description_key'], $cfg['disablepublicchat_default']);
|
|
|
|
$field = ['type' => 'hidden', 'name' => 'disablenote', 'data_type' => PARAM_INT, 'description_key' => null];
|
|
if ($cfg['disablenote_editable']) {
|
|
$field['type'] = 'checkbox';
|
|
$field['description_key'] = 'mod_form_field_disablenote';
|
|
$locksettings = true;
|
|
}
|
|
$this->bigbluebuttonbn_mform_add_element($mform, $field['type'], $field['name'], $field['data_type'],
|
|
$field['description_key'], $cfg['disablenote_default']);
|
|
|
|
$field = ['type' => 'hidden', 'name' => 'hideuserlist', 'data_type' => PARAM_INT, 'description_key' => null];
|
|
if ($cfg['hideuserlist_editable']) {
|
|
$field['type'] = 'checkbox';
|
|
$field['description_key'] = 'mod_form_field_hideuserlist';
|
|
$locksettings = true;
|
|
}
|
|
$this->bigbluebuttonbn_mform_add_element($mform, $field['type'], $field['name'], $field['data_type'],
|
|
$field['description_key'], $cfg['hideuserlist_default']);
|
|
|
|
// Output message if no settings.
|
|
if (!$locksettings) {
|
|
$field = ['type' => 'static', 'name' => 'no_locksettings',
|
|
'defaultvalue' => get_string('mod_form_field_nosettings', 'bigbluebuttonbn')];
|
|
$this->bigbluebuttonbn_mform_add_element($mform, $field['type'], $field['name'], null, null,
|
|
$field['defaultvalue']);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Function for showing details of the recording settings for the room.
|
|
*
|
|
* @param MoodleQuickForm $mform
|
|
* @param array $cfg
|
|
* @return void
|
|
*/
|
|
private function bigbluebuttonbn_mform_add_block_room_recordings(MoodleQuickForm &$mform, array $cfg): void {
|
|
$recordingsettings = false;
|
|
$field = ['type' => 'hidden', 'name' => 'recordings_deleted', 'data_type' => PARAM_INT,
|
|
'description_key' => null];
|
|
if ($cfg['recordings_deleted_editable']) {
|
|
$field['type'] = 'checkbox';
|
|
$field['description_key'] = 'mod_form_field_recordings_deleted';
|
|
$recordingsettings = true;
|
|
}
|
|
$this->bigbluebuttonbn_mform_add_element($mform, $field['type'], $field['name'], $field['data_type'],
|
|
$field['description_key'], $cfg['recordings_deleted_default']);
|
|
$field = ['type' => 'hidden', 'name' => 'recordings_imported', 'data_type' => PARAM_INT,
|
|
'description_key' => null];
|
|
if ($cfg['importrecordings_enabled'] && $cfg['recordings_imported_editable']) {
|
|
$field['type'] = 'checkbox';
|
|
$field['description_key'] = 'mod_form_field_recordings_imported';
|
|
$recordingsettings = true;
|
|
}
|
|
$this->bigbluebuttonbn_mform_add_element($mform, $field['type'], $field['name'], $field['data_type'],
|
|
$field['description_key'], $cfg['recordings_imported_default']);
|
|
$field = ['type' => 'hidden', 'name' => 'recordings_preview', 'data_type' => PARAM_INT,
|
|
'description_key' => null];
|
|
if ($cfg['recordings_preview_editable']) {
|
|
$field['type'] = 'checkbox';
|
|
$field['description_key'] = 'mod_form_field_recordings_preview';
|
|
$recordingsettings = true;
|
|
}
|
|
$this->bigbluebuttonbn_mform_add_element($mform, $field['type'], $field['name'], $field['data_type'],
|
|
$field['description_key'], $cfg['recordings_preview_default']);
|
|
|
|
if (!$recordingsettings) {
|
|
$field = ['type' => 'static', 'name' => 'no_recordings',
|
|
'defaultvalue' => get_string('mod_form_field_nosettings', 'bigbluebuttonbn')];
|
|
$this->bigbluebuttonbn_mform_add_element($mform, $field['type'], $field['name'], null, null,
|
|
$field['defaultvalue']);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Function for showing the block for room settings.
|
|
*
|
|
* @param MoodleQuickForm $mform
|
|
* @param array $cfg
|
|
* @return void
|
|
*/
|
|
private function bigbluebuttonbn_mform_add_block_room(MoodleQuickForm &$mform, array $cfg) {
|
|
if ($cfg['voicebridge_editable'] || $cfg['waitformoderator_editable'] ||
|
|
$cfg['userlimit_editable'] || $cfg['recording_editable'] || $cfg['muteonstart_editable']) {
|
|
$mform->addElement('header', 'room', get_string('mod_form_block_room', 'bigbluebuttonbn'));
|
|
$this->bigbluebuttonbn_mform_add_block_room_room($mform, $cfg);
|
|
}
|
|
if ($cfg['recordings_deleted_editable'] ||
|
|
$cfg['recordings_imported_editable'] || $cfg['recordings_preview_editable']) {
|
|
$mform->addElement('header', 'recordings', get_string('mod_form_block_recordings', 'bigbluebuttonbn'));
|
|
$this->bigbluebuttonbn_mform_add_block_room_recordings($mform, $cfg);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Function for showing the block for preuploaded presentation.
|
|
*
|
|
* @param MoodleQuickForm $mform
|
|
* @param array $cfg
|
|
* @return void
|
|
*/
|
|
private function bigbluebuttonbn_mform_add_block_preuploads(MoodleQuickForm &$mform, array $cfg): void {
|
|
if ($cfg['preuploadpresentation_editable']) {
|
|
$mform->addElement('header', 'preuploadpresentation',
|
|
get_string('mod_form_block_presentation', 'bigbluebuttonbn'));
|
|
$mform->setExpanded('preuploadpresentation');
|
|
$filemanageroptions = [];
|
|
$filemanageroptions['accepted_types'] = '*';
|
|
$filemanageroptions['maxbytes'] = 0;
|
|
$filemanageroptions['subdirs'] = 0;
|
|
$filemanageroptions['maxfiles'] = 1;
|
|
$filemanageroptions['mainfile'] = true;
|
|
$mform->addElement('filemanager', 'presentation', get_string('selectfiles'),
|
|
null, $filemanageroptions);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Function for showing the block for setting participant roles.
|
|
*
|
|
* @param MoodleQuickForm $mform
|
|
* @param array $participantlist
|
|
* @return void
|
|
*/
|
|
private function bigbluebuttonbn_mform_add_block_user_role_mapping(MoodleQuickForm &$mform, array $participantlist): void {
|
|
global $OUTPUT;
|
|
$participantselection = roles::get_participant_selection_data();
|
|
$mform->addElement('header', 'permissions', get_string('mod_form_block_participants', 'bigbluebuttonbn'));
|
|
$mform->setExpanded('permissions');
|
|
$mform->addElement('hidden', 'participants', json_encode($participantlist));
|
|
$mform->setType('participants', PARAM_TEXT);
|
|
$selectiontype = new single_select(new moodle_url(qualified_me()),
|
|
'bigbluebuttonbn_participant_selection_type',
|
|
$participantselection['type_options'],
|
|
$participantselection['type_selected']);
|
|
$selectionparticipants = new single_select(new moodle_url(qualified_me()),
|
|
'bigbluebuttonbn_participant_selection',
|
|
$participantselection['options'],
|
|
$participantselection['selected']);
|
|
$action = new single_button(new moodle_url(qualified_me()),
|
|
get_string('mod_form_field_participant_list_action_add', 'bigbluebuttonbn'),
|
|
'post',
|
|
single_button::BUTTON_SECONDARY,
|
|
['name' => 'bigbluebuttonbn_participant_selection_add']
|
|
);
|
|
$pformcontext = [
|
|
'selectionType' => $selectiontype->export_for_template($OUTPUT),
|
|
'selectionParticipant' => $selectionparticipants->export_for_template($OUTPUT),
|
|
'action' => $action->export_for_template($OUTPUT),
|
|
];
|
|
$html = $OUTPUT->render_from_template('mod_bigbluebuttonbn/participant_form', $pformcontext);
|
|
$mform->addElement('static', 'static_participant_list',
|
|
get_string('mod_form_field_participant_list', 'bigbluebuttonbn'), $html);
|
|
}
|
|
|
|
/**
|
|
* Function to add guest acces settings to the instance
|
|
*
|
|
* @param MoodleQuickForm $mform
|
|
* @param array $cfg
|
|
* @param stdClass $current
|
|
* @return void
|
|
* @throws coding_exception
|
|
*/
|
|
private function bigbluebuttonbn_mform_add_block_guest_access(MoodleQuickForm $mform, array $cfg, stdClass $current) {
|
|
if (!empty($cfg['guestaccess_enabled'])) {
|
|
$mform->addElement('header', 'guestaccess', get_string('mod_form_block_guestaccess', 'bigbluebuttonbn'));
|
|
$mform->setExpanded('guestaccess');
|
|
$mform->addElement('advcheckbox', 'guestallowed',
|
|
get_string('mod_form_field_guestallowed', 'bigbluebuttonbn'));
|
|
$mform->addElement('advcheckbox', 'mustapproveuser',
|
|
get_string('mod_form_field_mustapproveuser', 'bigbluebuttonbn'));
|
|
$mform->hideIf('mustapproveuser', 'guestallowed');
|
|
if (!empty($this->_cm)) {
|
|
$instance = instance::get_from_cmid($this->_cm->id);
|
|
\mod_bigbluebuttonbn\form\guest_add::add_meeting_links_elements($mform);
|
|
$mform->setDefault('guestjoinurl', $instance->get_guest_access_url());
|
|
$mform->setDefault('guestpassword', $instance->get_guest_access_password());
|
|
$mform->hideIf('guestjoinurl', 'guestallowed');
|
|
$mform->hideIf('guestpassword', 'guestallowed');
|
|
}
|
|
} else {
|
|
$mform->addElement('hidden', 'guestallowed', 0);
|
|
$mform->addElement('hidden', 'mustapproveuser', 0);
|
|
}
|
|
$mform->setType('guestallowed', PARAM_BOOL);
|
|
$mform->setType('mustapproveuser', PARAM_BOOL);
|
|
$mform->setDefault('guestallowed', 0);
|
|
$mform->setDefault('mustapproveuser', 1);
|
|
}
|
|
|
|
/**
|
|
* Function for showing the block for integration with the calendar.
|
|
*
|
|
* @param MoodleQuickForm $mform
|
|
* @param stdClass $activity
|
|
* @return void
|
|
*/
|
|
private function bigbluebuttonbn_mform_add_block_schedule(MoodleQuickForm &$mform, stdClass &$activity) {
|
|
$mform->addElement('header', 'schedule', get_string('mod_form_block_schedule', 'bigbluebuttonbn'));
|
|
if (!empty($activity->openingtime) || !empty($activity->closingtime)) {
|
|
$mform->setExpanded('schedule');
|
|
}
|
|
$mform->addElement('date_time_selector', 'openingtime',
|
|
get_string('mod_form_field_openingtime', 'bigbluebuttonbn'), ['optional' => true]);
|
|
$mform->setDefault('openingtime', 0);
|
|
$mform->addElement('date_time_selector', 'closingtime',
|
|
get_string('mod_form_field_closingtime', 'bigbluebuttonbn'), ['optional' => true]);
|
|
$mform->setDefault('closingtime', 0);
|
|
}
|
|
|
|
/**
|
|
* Function for showing an element.
|
|
*
|
|
* @param MoodleQuickForm $mform
|
|
* @param string $type
|
|
* @param string $name
|
|
* @param string|null $datatype
|
|
* @param string|null $descriptionkey
|
|
* @param mixed|null $defaultvalue
|
|
* @param array|null $options
|
|
* @param array|null $rule
|
|
* @return void
|
|
*/
|
|
private function bigbluebuttonbn_mform_add_element(MoodleQuickForm &$mform, string $type, string $name, ?string $datatype,
|
|
?string $descriptionkey = "", $defaultvalue = null, ?array $options = null, ?array $rule = null): void {
|
|
$datatype = $datatype ?? 'hidden';
|
|
if ($type === 'hidden' || $type === 'static') {
|
|
$mform->addElement($type, $name, $defaultvalue);
|
|
$mform->setType($name, $datatype);
|
|
return;
|
|
}
|
|
if ($descriptionkey) {
|
|
$mform->addElement($type, $name, get_string($descriptionkey, 'bigbluebuttonbn'), $options);
|
|
if (get_string_manager()->string_exists($descriptionkey . '_help', 'bigbluebuttonbn')) {
|
|
$mform->addHelpButton($name, $descriptionkey, 'bigbluebuttonbn');
|
|
}
|
|
}
|
|
if (!empty($rule)) {
|
|
$mform->addRule($name, $rule['message'], $rule['type'], $rule['rule'], $rule['validator']);
|
|
}
|
|
$mform->setDefault($name, $defaultvalue);
|
|
$mform->setType($name, $datatype);
|
|
}
|
|
|
|
/**
|
|
* Definition after data
|
|
*
|
|
* Here just to tweak form group in completion that should not be frozen. This avoid
|
|
* unwanted warnings.
|
|
*/
|
|
public function definition_after_data() {
|
|
parent::definition_after_data();
|
|
foreach ($this->formextensions as $formextension) {
|
|
$formextension->definition_after_data();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Add subplugins form elements
|
|
* @return void
|
|
*/
|
|
private function add_subplugins_elements() {
|
|
foreach ($this->formextensions as $formextension) {
|
|
$formextension->add_fields();
|
|
}
|
|
}
|
|
}
|