You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
289 lines
14 KiB
289 lines
14 KiB
2 years ago
|
<?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/>.
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Contains renderer objects for messaging
|
||
|
|
*
|
||
|
|
* @package core_message
|
||
|
|
* @copyright 2011 Lancaster University Network Services Limited
|
||
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||
|
|
*/
|
||
|
|
|
||
|
|
defined('MOODLE_INTERNAL') || die();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* message Renderer
|
||
|
|
*
|
||
|
|
* Class for rendering various message objects
|
||
|
|
*
|
||
|
|
* @package core_message
|
||
|
|
* @subpackage message
|
||
|
|
* @copyright 2011 Lancaster University Network Services Limited
|
||
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||
|
|
*/
|
||
|
|
class core_message_renderer extends plugin_renderer_base {
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Display the interface to manage both message outputs and default message outputs
|
||
|
|
*
|
||
|
|
* @param array $allprocessors array of objects containing all message processors
|
||
|
|
* @param array $processors array of objects containing active message processors
|
||
|
|
* @param array $providers array of objects containing message providers
|
||
|
|
* @param array $preferences array of objects containing current preferences
|
||
|
|
* @return string The text to render
|
||
|
|
*/
|
||
|
|
public function manage_messageoutput_settings($allprocessors, $processors, $providers, $preferences) {
|
||
|
|
$output = html_writer::start_tag('form', array('id' => 'defaultmessageoutputs', 'method' => 'post'));
|
||
|
|
$output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'sesskey', 'value' => sesskey()));
|
||
|
|
|
||
|
|
// Add message output processors enabled/disabled and settings.
|
||
|
|
$output .= $this->heading(get_string('messageoutputs', 'message'));
|
||
|
|
$output .= $this->manage_messageoutputs($allprocessors);
|
||
|
|
|
||
|
|
// Add active message output processors settings.
|
||
|
|
$output .= $this->heading(get_string('managemessageoutputs', 'message'));
|
||
|
|
$output .= $this->manage_defaultmessageoutputs($processors, $providers, $preferences);
|
||
|
|
|
||
|
|
$output .= html_writer::start_tag('div', array('class' => 'form-buttons'));
|
||
|
|
$output .= html_writer::empty_tag('input',
|
||
|
|
array('type' => 'submit', 'value' => get_string('savechanges', 'admin'), 'class' => 'form-submit btn btn-primary')
|
||
|
|
);
|
||
|
|
$output .= html_writer::end_tag('div');
|
||
|
|
$output .= html_writer::end_tag('form');
|
||
|
|
|
||
|
|
return $output;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Display the interface to manage message outputs
|
||
|
|
*
|
||
|
|
* @param array $processors array of objects containing message processors
|
||
|
|
* @return string The text to render
|
||
|
|
*/
|
||
|
|
public function manage_messageoutputs($processors) {
|
||
|
|
// Display the current workflows
|
||
|
|
$table = new html_table();
|
||
|
|
$table->attributes['class'] = 'admintable generaltable';
|
||
|
|
$table->data = array();
|
||
|
|
$table->head = array(
|
||
|
|
get_string('name'),
|
||
|
|
get_string('enable'),
|
||
|
|
get_string('settings'),
|
||
|
|
);
|
||
|
|
$table->colclasses = array(
|
||
|
|
'displayname', 'availability', 'settings',
|
||
|
|
);
|
||
|
|
|
||
|
|
foreach ($processors as $processor) {
|
||
|
|
$row = new html_table_row();
|
||
|
|
$row->attributes['class'] = 'messageoutputs';
|
||
|
|
|
||
|
|
$name = new html_table_cell(get_string('pluginname', 'message_'.$processor->name));
|
||
|
|
$enable = new html_table_cell();
|
||
|
|
if (!$processor->available) {
|
||
|
|
$enable->text = html_writer::nonempty_tag('span', get_string('outputnotavailable', 'message'),
|
||
|
|
array('class' => 'error')
|
||
|
|
);
|
||
|
|
} else {
|
||
|
|
$enable->text = html_writer::checkbox($processor->name, $processor->id, $processor->enabled, '',
|
||
|
|
array('id' => $processor->name)
|
||
|
|
);
|
||
|
|
}
|
||
|
|
// Settings
|
||
|
|
$settings = new html_table_cell();
|
||
|
|
if ($processor->available && $processor->hassettings) {
|
||
|
|
$settingsurl = new moodle_url('/admin/settings.php', array('section' => 'messagesetting'.$processor->name));
|
||
|
|
$settings->text = html_writer::link($settingsurl, get_string('settings', 'message'));
|
||
|
|
}
|
||
|
|
|
||
|
|
$row->cells = array($name, $enable, $settings);
|
||
|
|
$table->data[] = $row;
|
||
|
|
}
|
||
|
|
return html_writer::table($table);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Display the interface to manage default message outputs
|
||
|
|
*
|
||
|
|
* @param array $processors array of objects containing message processors
|
||
|
|
* @param array $providers array of objects containing message providers
|
||
|
|
* @param array $preferences array of objects containing current preferences
|
||
|
|
* @return string The text to render
|
||
|
|
*/
|
||
|
|
public function manage_defaultmessageoutputs($processors, $providers, $preferences) {
|
||
|
|
// Prepare list of options for dropdown menu
|
||
|
|
$options = array();
|
||
|
|
foreach (array('disallowed', 'permitted', 'forced') as $setting) {
|
||
|
|
$options[$setting] = get_string($setting, 'message');
|
||
|
|
}
|
||
|
|
|
||
|
|
// Display users outputs table
|
||
|
|
$table = new html_table();
|
||
|
|
$table->attributes['class'] = 'generaltable';
|
||
|
|
$table->data = array();
|
||
|
|
$table->head = array('');
|
||
|
|
|
||
|
|
// Populate the header row
|
||
|
|
foreach ($processors as $processor) {
|
||
|
|
$table->head[] = get_string('pluginname', 'message_'.$processor->name);
|
||
|
|
}
|
||
|
|
// Add enable/disable to head
|
||
|
|
$table->head[] = get_string('enabled', 'core_message');
|
||
|
|
|
||
|
|
// Generate the matrix of settings for each provider and processor
|
||
|
|
foreach ($providers as $provider) {
|
||
|
|
$row = new html_table_row();
|
||
|
|
$row->attributes['class'] = 'defaultmessageoutputs';
|
||
|
|
$row->cells = array();
|
||
|
|
|
||
|
|
// Provider Name
|
||
|
|
$providername = get_string('messageprovider:'.$provider->name, $provider->component);
|
||
|
|
$row->cells[] = new html_table_cell($providername);
|
||
|
|
$providersettingprefix = $provider->component.'_'.$provider->name.'_';
|
||
|
|
$disableprovidersetting = $providersettingprefix.'disable';
|
||
|
|
$providerdisabled = !empty($preferences->$disableprovidersetting);
|
||
|
|
// Settings for each processor
|
||
|
|
foreach ($processors as $processor) {
|
||
|
|
$cellcontent = '';
|
||
|
|
foreach (array('permitted', 'loggedin', 'loggedoff') as $setting) {
|
||
|
|
// pepare element and preference names
|
||
|
|
$elementname = $providersettingprefix.$setting.'['.$processor->name.']';
|
||
|
|
$preferencebase = $providersettingprefix.$setting;
|
||
|
|
// prepare language bits
|
||
|
|
$processorname = get_string('pluginname', 'message_'.$processor->name);
|
||
|
|
$statename = get_string($setting, 'message');
|
||
|
|
$labelparams = array(
|
||
|
|
'provider' => $providername,
|
||
|
|
'processor' => $processorname,
|
||
|
|
'state' => $statename
|
||
|
|
);
|
||
|
|
if ($setting == 'permitted') {
|
||
|
|
$label = get_string('sendingvia', 'message', $labelparams);
|
||
|
|
// determine the current setting or use default
|
||
|
|
$select = MESSAGE_DEFAULT_PERMITTED;
|
||
|
|
$preference = $processor->name.'_provider_'.$preferencebase;
|
||
|
|
if ($providerdisabled) {
|
||
|
|
$select = MESSAGE_DISALLOWED;
|
||
|
|
} else if (array_key_exists($preference, $preferences)) {
|
||
|
|
$select = $preferences->{$preference};
|
||
|
|
}
|
||
|
|
// dropdown menu
|
||
|
|
$cellcontent = html_writer::label($label, $elementname, true, array('class' => 'accesshide'));
|
||
|
|
$cellcontent .= html_writer::select($options, $elementname, $select, false, array('id' => $elementname));
|
||
|
|
$cellcontent .= html_writer::tag('div', get_string('defaults', 'message'));
|
||
|
|
} else {
|
||
|
|
$label = get_string('sendingviawhen', 'message', $labelparams);
|
||
|
|
// determine the current setting based on the 'permitted' setting above
|
||
|
|
$checked = false;
|
||
|
|
if ($select == 'forced') {
|
||
|
|
$checked = true;
|
||
|
|
} else if ($select == 'permitted') {
|
||
|
|
$preference = 'message_provider_'.$preferencebase;
|
||
|
|
if (array_key_exists($preference, $preferences)) {
|
||
|
|
$checked = (int)in_array($processor->name, explode(',', $preferences->{$preference}));
|
||
|
|
}
|
||
|
|
}
|
||
|
|
// generate content
|
||
|
|
$cellcontent .= html_writer::start_tag('div');
|
||
|
|
$cellcontent .= html_writer::label($label, $elementname, true, array('class' => 'accesshide'));
|
||
|
|
$cellcontent .= html_writer::checkbox($elementname, 1, $checked, '', array('id' => $elementname));
|
||
|
|
$cellcontent .= $statename;
|
||
|
|
$cellcontent .= html_writer::end_tag('div');
|
||
|
|
}
|
||
|
|
}
|
||
|
|
$row->cells[] = new html_table_cell($cellcontent);
|
||
|
|
}
|
||
|
|
$disableprovider = html_writer::checkbox($disableprovidersetting, 1, !$providerdisabled, '',
|
||
|
|
array('id' => $disableprovidersetting, 'class' => 'messagedisable'));
|
||
|
|
$disableprovider = html_writer::tag('div', $disableprovider);
|
||
|
|
$row->cells[] = new html_table_cell($disableprovider);
|
||
|
|
$table->data[] = $row;
|
||
|
|
}
|
||
|
|
|
||
|
|
$output = html_writer::table($table);
|
||
|
|
return $output;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Display the interface for notification preferences
|
||
|
|
*
|
||
|
|
* @param object $user instance of a user
|
||
|
|
* @return string The text to render
|
||
|
|
*/
|
||
|
|
public function render_user_notification_preferences($user) {
|
||
|
|
$processors = get_message_processors();
|
||
|
|
$providers = message_get_providers_for_user($user->id);
|
||
|
|
|
||
|
|
$preferences = \core_message\api::get_all_message_preferences($processors, $providers, $user);
|
||
|
|
$notificationlistoutput = new \core_message\output\preferences\notification_list($processors, $providers,
|
||
|
|
$preferences, $user);
|
||
|
|
return $this->render_from_template('message/notification_preferences',
|
||
|
|
$notificationlistoutput->export_for_template($this));
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Display the interface for message preferences
|
||
|
|
*
|
||
|
|
* @param object $user instance of a user
|
||
|
|
* @return string The text to render
|
||
|
|
*/
|
||
|
|
public function render_user_message_preferences($user) {
|
||
|
|
global $CFG;
|
||
|
|
|
||
|
|
// Filter out enabled, available system_configured and user_configured processors only.
|
||
|
|
$readyprocessors = array_filter(get_message_processors(), function($processor) {
|
||
|
|
return $processor->enabled &&
|
||
|
|
$processor->configured &&
|
||
|
|
$processor->object->is_user_configured() &&
|
||
|
|
// Filter out processors that don't have and message preferences to configure.
|
||
|
|
$processor->object->has_message_preferences();
|
||
|
|
});
|
||
|
|
|
||
|
|
$providers = array_filter(message_get_providers_for_user($user->id), function($provider) {
|
||
|
|
return $provider->component === 'moodle';
|
||
|
|
});
|
||
|
|
$preferences = \core_message\api::get_all_message_preferences($readyprocessors, $providers, $user);
|
||
|
|
$notificationlistoutput = new \core_message\output\preferences\message_notification_list($readyprocessors,
|
||
|
|
$providers, $preferences, $user);
|
||
|
|
$context = $notificationlistoutput->export_for_template($this);
|
||
|
|
|
||
|
|
// Get the privacy settings options for being messaged.
|
||
|
|
$privacysetting = \core_message\api::get_user_privacy_messaging_preference($user->id);
|
||
|
|
$choices = array();
|
||
|
|
$choices[] = [
|
||
|
|
'value' => \core_message\api::MESSAGE_PRIVACY_ONLYCONTACTS,
|
||
|
|
'text' => get_string('contactableprivacy_onlycontacts', 'message'),
|
||
|
|
'checked' => ($privacysetting == \core_message\api::MESSAGE_PRIVACY_ONLYCONTACTS)
|
||
|
|
];
|
||
|
|
$choices[] = [
|
||
|
|
'value' => \core_message\api::MESSAGE_PRIVACY_COURSEMEMBER,
|
||
|
|
'text' => get_string('contactableprivacy_coursemember', 'message'),
|
||
|
|
'checked' => ($privacysetting == \core_message\api::MESSAGE_PRIVACY_COURSEMEMBER)
|
||
|
|
];
|
||
|
|
if (!empty($CFG->messagingallusers)) {
|
||
|
|
// Add the MESSAGE_PRIVACY_SITE option when site-wide messaging between users is enabled.
|
||
|
|
$choices[] = [
|
||
|
|
'value' => \core_message\api::MESSAGE_PRIVACY_SITE,
|
||
|
|
'text' => get_string('contactableprivacy_site', 'message'),
|
||
|
|
'checked' => ($privacysetting == \core_message\api::MESSAGE_PRIVACY_SITE)
|
||
|
|
];
|
||
|
|
}
|
||
|
|
$context['privacychoices'] = $choices;
|
||
|
|
|
||
|
|
return $this->render_from_template('message/message_preferences', $context);
|
||
|
|
}
|
||
|
|
}
|