MDL-73909 core_message: Admin notification preferences saved on toggle
This commit is contained in:
raortegar
+1
-69
@@ -43,61 +43,6 @@ $providers = get_message_providers();
|
||||
$preferences = get_message_output_default_preferences();
|
||||
|
||||
if (($form = data_submitted()) && confirm_sesskey()) {
|
||||
$newpreferences = array();
|
||||
// Prepare default message outputs settings.
|
||||
foreach ($providers as $provider) {
|
||||
$componentproviderbase = $provider->component.'_'.$provider->name;
|
||||
$disableprovidersetting = $componentproviderbase.'_disable';
|
||||
if (!isset($form->$disableprovidersetting)) {
|
||||
$newpreferences[$disableprovidersetting] = 1;
|
||||
} else {
|
||||
$newpreferences[$disableprovidersetting] = 0;
|
||||
}
|
||||
|
||||
$componentprovidersetting = $componentproviderbase.'_locked';
|
||||
foreach ($processors as $processor) {
|
||||
$value = 0;
|
||||
if (isset($form->{$componentprovidersetting}[$processor->name])) {
|
||||
$value = $form->{$componentprovidersetting}[$processor->name];
|
||||
if ($value == 'on') {
|
||||
$value = 1;
|
||||
}
|
||||
}
|
||||
|
||||
// Record the site preference.
|
||||
$newpreferences[$processor->name.'_provider_'.$componentprovidersetting] = $value;
|
||||
}
|
||||
|
||||
$componentprovidersetting = $componentproviderbase.'_enabled';
|
||||
$newsettings = [];
|
||||
if (isset($form->$componentprovidersetting)) {
|
||||
// Store defined comma-separated processors as setting value.
|
||||
// Using array_filter eliminates elements set to 0 above.
|
||||
$newsettings = array_keys(array_filter($form->{$componentprovidersetting}));
|
||||
}
|
||||
|
||||
// Let's join existing setting values for disabled processors.
|
||||
$property = 'message_provider_'.$componentprovidersetting;
|
||||
if (property_exists($preferences, $property)) {
|
||||
$existingsetting = $preferences->$property;
|
||||
foreach ($disabledprocessors as $disable) {
|
||||
if (strpos($existingsetting, $disable->name) > -1) {
|
||||
$newsettings[] = $disable->name;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
$value = join(',', $newsettings);
|
||||
if (empty($value)) {
|
||||
$value = null;
|
||||
}
|
||||
|
||||
// Record the site preference.
|
||||
$newpreferences['message_provider_'.$componentprovidersetting] = $value;
|
||||
}
|
||||
|
||||
// Update database.
|
||||
$transaction = $DB->start_delegated_transaction();
|
||||
|
||||
// Save processors enabled/disabled status.
|
||||
foreach ($allprocessors as $processor) {
|
||||
@@ -106,24 +51,11 @@ if (($form = data_submitted()) && confirm_sesskey()) {
|
||||
$class::enable_plugin($processor->name, $enabled);
|
||||
}
|
||||
|
||||
foreach ($newpreferences as $name => $value) {
|
||||
$old = isset($preferences->$name) ? $preferences->$name : '';
|
||||
|
||||
if ($old != $value) {
|
||||
add_to_config_log($name, $old, $value, 'core');
|
||||
}
|
||||
|
||||
set_config($name, $value, 'message');
|
||||
}
|
||||
$transaction->allow_commit();
|
||||
|
||||
core_plugin_manager::reset_caches();
|
||||
|
||||
$url = new moodle_url('message.php');
|
||||
redirect($url);
|
||||
}
|
||||
|
||||
// Page settings
|
||||
// Page settings.
|
||||
$PAGE->set_context(context_system::instance());
|
||||
$renderer = $PAGE->get_renderer('core', 'message');
|
||||
|
||||
|
||||
@@ -245,6 +245,10 @@ $string['showmessagewindownonew'] = 'Show message window with no new messages';
|
||||
$string['showmessagewindowwithcount'] = 'Show message window with {$a} new messages';
|
||||
$string['shownotificationwindownonew'] = 'Show notification window with no new notifications';
|
||||
$string['shownotificationwindowwithcount'] = 'Show notification window with {$a} new notifications';
|
||||
$string['successproviderenabled'] = '\'{$a->provider}\' for \'{$a->processor}\' updated.';
|
||||
$string['successproviderlocked'] = '\'{$a->provider}\' for \'{$a->processor}\' locked.';
|
||||
$string['successproviderunlocked'] = '\'{$a->provider}\' for \'{$a->processor}\' unlocked.';
|
||||
$string['successproviderupdate'] = '\'{$a}\' updated.';
|
||||
$string['togglenotificationmenu'] = 'Toggle notifications menu';
|
||||
$string['togglemessagemenu'] = 'Toggle messaging drawer';
|
||||
$string['totalconversations'] = '{$a} total conversations';
|
||||
|
||||
@@ -1634,6 +1634,12 @@ $functions = array(
|
||||
'type' => 'read',
|
||||
'services' => [MOODLE_OFFICIAL_MOBILE_SERVICE],
|
||||
],
|
||||
'core_message_set_default_notification' => [
|
||||
'classname' => 'core_message\external\message_set_default_notification',
|
||||
'description' => 'Set the default notification preferences toggle',
|
||||
'type' => 'write',
|
||||
'ajax' => true,
|
||||
],
|
||||
'core_my_view_page' => [
|
||||
'classname' => '\core_my\external\view_page',
|
||||
'methodname' => 'execute',
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
define("core_message/default_notification_preferences",["exports"],(function(_exports){Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.default=void 0;
|
||||
define("core_message/default_notification_preferences",["exports","core/ajax","core/notification"],(function(_exports,Ajax,_notification){var obj;function _getRequireWildcardCache(nodeInterop){if("function"!=typeof WeakMap)return null;var cacheBabelInterop=new WeakMap,cacheNodeInterop=new WeakMap;return(_getRequireWildcardCache=function(nodeInterop){return nodeInterop?cacheNodeInterop:cacheBabelInterop})(nodeInterop)}Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.default=void 0,Ajax=function(obj,nodeInterop){if(!nodeInterop&&obj&&obj.__esModule)return obj;if(null===obj||"object"!=typeof obj&&"function"!=typeof obj)return{default:obj};var cache=_getRequireWildcardCache(nodeInterop);if(cache&&cache.has(obj))return cache.get(obj);var newObj={},hasPropertyDescriptor=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var key in obj)if("default"!==key&&Object.prototype.hasOwnProperty.call(obj,key)){var desc=hasPropertyDescriptor?Object.getOwnPropertyDescriptor(obj,key):null;desc&&(desc.get||desc.set)?Object.defineProperty(newObj,key,desc):newObj[key]=obj[key]}newObj.default=obj,cache&&cache.set(obj,newObj);return newObj}
|
||||
/**
|
||||
* Controls the default settings for the list of notification types on the
|
||||
* notifications admin page
|
||||
@@ -8,7 +8,6 @@ define("core_message/default_notification_preferences",["exports"],(function(_ex
|
||||
* @copyright 2021 Moodle
|
||||
* @author Pau Ferrer Ocaña <pau@moodle.com>
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
const selectors_provider=".defaultmessageoutputs .provider_enabled",selectors_lockSetting=".locked_message_setting",selectors_allSettings=".locked_message_setting, .enabled_message_setting";var _default={init:()=>{(()=>{const toggleLockSetting=lockedElement=>{const isEnabled=lockedElement.checked||!1,enabledId=lockedElement.id.replace("_locked[","_enabled[");document.getElementById(enabledId).closest("div.custom-control").classList.toggle("dimmed_text",isEnabled)},toggleEnableProviderSettings=providerEnabledElement=>{const isEnabled=providerEnabledElement.checked||!1;providerEnabledElement.closest("tr").querySelectorAll(selectors_allSettings).forEach((element=>{element.toggleAttribute("disabled",!isEnabled)}))},container=document.querySelector(".preferences-container");container.querySelectorAll(selectors_provider).forEach((providerEnabledElement=>{providerEnabledElement.checked||toggleEnableProviderSettings(providerEnabledElement),providerEnabledElement.addEventListener("change",(e=>{toggleEnableProviderSettings(e.target)}))})),container.querySelectorAll(selectors_lockSetting).forEach((lockedElement=>{lockedElement.checked&&toggleLockSetting(lockedElement),lockedElement.addEventListener("change",(e=>{toggleLockSetting(e.target)}))}))})()}};return _exports.default=_default,_exports.default}));
|
||||
*/(Ajax),_notification=(obj=_notification)&&obj.__esModule?obj:{default:obj};const selectors_provider=".defaultmessageoutputs .provider_enabled",selectors_lockSetting=".locked_message_setting",selectors_enabledSetting=".enabled_message_setting",selectors_allSettings=".locked_message_setting, .enabled_message_setting";var _default={init:()=>{(()=>{const toggleLockSetting=lockedElement=>{const isEnabled=lockedElement.checked||!1,enabledId=lockedElement.id.replace("_locked[","_enabled[");document.getElementById(enabledId).closest("div.custom-control").classList.toggle("dimmed_text",isEnabled)},toggleEnableProviderSettings=providerEnabledElement=>{const isEnabled=providerEnabledElement.checked||!1;providerEnabledElement.closest("tr").querySelectorAll(selectors_allSettings).forEach((element=>{element.toggleAttribute("disabled",!isEnabled)}))},setDefaultNotification=(isEnabled,preference)=>{Ajax.call([{methodname:"core_message_set_default_notification",args:{preference:preference,state:isEnabled?1:0}}])[0].done((data=>{_notification.default.addNotification({message:data.successmessage,type:"success"})})).fail(_notification.default.exception)},container=document.querySelector(".preferences-container");container.querySelectorAll(selectors_provider).forEach((providerEnabledElement=>{providerEnabledElement.checked||toggleEnableProviderSettings(providerEnabledElement),providerEnabledElement.addEventListener("change",(e=>{toggleEnableProviderSettings(e.target),setDefaultNotification(e.target.checked,providerEnabledElement.parentElement.parentElement.dataset.preference)}))})),container.querySelectorAll(selectors_lockSetting).forEach((lockedElement=>{lockedElement.checked&&toggleLockSetting(lockedElement),lockedElement.addEventListener("change",(e=>{toggleLockSetting(e.target),setDefaultNotification(e.target.checked,lockedElement.parentElement.parentElement.dataset.preference)}))})),container.querySelectorAll(selectors_enabledSetting).forEach((enabledElement=>{enabledElement.addEventListener("change",(e=>{setDefaultNotification(e.target.checked,enabledElement.parentElement.parentElement.dataset.preference)}))}))})()}};return _exports.default=_default,_exports.default}));
|
||||
|
||||
//# sourceMappingURL=default_notification_preferences.min.js.map
|
||||
File diff suppressed because one or more lines are too long
@@ -23,6 +23,8 @@
|
||||
* @author Pau Ferrer Ocaña <[email protected]>
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
import * as Ajax from 'core/ajax';
|
||||
import Notification from 'core/notification';
|
||||
|
||||
const selectors = {
|
||||
provider: '.defaultmessageoutputs .provider_enabled',
|
||||
@@ -64,6 +66,30 @@ const registerEventListeners = () => {
|
||||
});
|
||||
};
|
||||
|
||||
/**
|
||||
* AJAX call to update the default notification element status on the server.
|
||||
*
|
||||
* @param {Boolean} isEnabled
|
||||
* @param {string} preference
|
||||
*/
|
||||
const setDefaultNotification = (isEnabled, preference) => {
|
||||
// AJAX call to update the provider's enable status on the server.
|
||||
Ajax.call([{
|
||||
methodname: 'core_message_set_default_notification',
|
||||
args: {
|
||||
preference: preference,
|
||||
state: isEnabled ? 1 : 0
|
||||
}
|
||||
}])[0].done((data) => {
|
||||
// Display success notification.
|
||||
Notification.addNotification({
|
||||
message: data.successmessage,
|
||||
type: 'success'
|
||||
});
|
||||
})
|
||||
.fail(Notification.exception);
|
||||
};
|
||||
|
||||
const container = document.querySelector('.preferences-container');
|
||||
|
||||
container.querySelectorAll(selectors.provider).forEach((providerEnabledElement) => {
|
||||
@@ -74,6 +100,10 @@ const registerEventListeners = () => {
|
||||
|
||||
providerEnabledElement.addEventListener('change', (e) => {
|
||||
toggleEnableProviderSettings(e.target);
|
||||
|
||||
setDefaultNotification(
|
||||
e.target.checked,
|
||||
providerEnabledElement.parentElement.parentElement.dataset.preference);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -85,6 +115,18 @@ const registerEventListeners = () => {
|
||||
|
||||
lockedElement.addEventListener('change', (e) => {
|
||||
toggleLockSetting(e.target);
|
||||
|
||||
setDefaultNotification(
|
||||
e.target.checked,
|
||||
lockedElement.parentElement.parentElement.dataset.preference);
|
||||
});
|
||||
});
|
||||
|
||||
container.querySelectorAll(selectors.enabledSetting).forEach((enabledElement) => {
|
||||
enabledElement.addEventListener('change', (e) => {
|
||||
setDefaultNotification(
|
||||
e.target.checked,
|
||||
enabledElement.parentElement.parentElement.dataset.preference);
|
||||
});
|
||||
});
|
||||
};
|
||||
|
||||
@@ -0,0 +1,192 @@
|
||||
<?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/>.
|
||||
|
||||
namespace core_message\external;
|
||||
|
||||
use context_system;
|
||||
use core_external\external_api;
|
||||
use core_external\external_function_parameters;
|
||||
use core_external\external_value;
|
||||
|
||||
/**
|
||||
* Webservice to enable or disable the default notification.
|
||||
*
|
||||
* @package core_message
|
||||
* @copyright 2024 Raquel Ortega <[email protected]>
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
class message_set_default_notification extends external_api {
|
||||
/**
|
||||
* Returns description of method parameters.
|
||||
*
|
||||
* @return external_function_parameters
|
||||
*/
|
||||
public static function execute_parameters(): external_function_parameters {
|
||||
return new external_function_parameters([
|
||||
'preference' => new external_value(
|
||||
PARAM_TEXT,
|
||||
'The name of the preference',
|
||||
VALUE_REQUIRED,
|
||||
),
|
||||
'state' => new external_value(
|
||||
PARAM_INT,
|
||||
'The target state',
|
||||
VALUE_REQUIRED,
|
||||
),
|
||||
]);
|
||||
}
|
||||
/**
|
||||
* Set the default notification action state.
|
||||
*
|
||||
* @param string $preference The name of the preference.
|
||||
* @param int $state The target state.
|
||||
* @return array
|
||||
*/
|
||||
public static function execute(
|
||||
string $preference,
|
||||
int $state,
|
||||
): array {
|
||||
|
||||
global $DB;
|
||||
// Parameter validation.
|
||||
[
|
||||
'preference' => $preference,
|
||||
'state' => $state,
|
||||
] = self::validate_parameters(self::execute_parameters(), [
|
||||
'preference' => $preference,
|
||||
'state' => $state,
|
||||
]);
|
||||
|
||||
$context = context_system::instance();
|
||||
self::validate_context($context);
|
||||
require_capability('moodle/site:config', $context);
|
||||
|
||||
// Fetch all message processors and filter out disabled ones.
|
||||
$allprocessors = get_message_processors();
|
||||
$processors = array_filter($allprocessors, function($processor) {
|
||||
return $processor->enabled;
|
||||
});
|
||||
$preferences = get_message_output_default_preferences();
|
||||
|
||||
// Get the provider name and provider component from the given preference.
|
||||
$providers = get_message_providers();
|
||||
$providername = '';
|
||||
$providercomponent = '';
|
||||
foreach ($providers as $provider) {
|
||||
if (str_contains($preference, $provider->component . '_' . $provider->name)) {
|
||||
$providername = $provider->name;
|
||||
$providercomponent = $provider->component;
|
||||
break;
|
||||
}
|
||||
}
|
||||
// Initialize variables to store new preferences.
|
||||
$preferencename = '';
|
||||
$value = 0;
|
||||
$successmessage = '';
|
||||
if (!empty($providername) && !empty($providercomponent)) {
|
||||
$componentproviderbase = $providercomponent.'_'.$providername;
|
||||
$providerdisplayname = get_string('messageprovider:'.$providername, $providercomponent);
|
||||
|
||||
// Enabled / disabled toggle for providers.
|
||||
if ($preference === $componentproviderbase . '_disable') {
|
||||
// If $state is true, set the preference to disabled; otherwise, enable it.
|
||||
$preferencename = $preference;
|
||||
$value = $state ? 0 : 1;
|
||||
$successmessage = get_string('successproviderupdate', 'message', $providerdisplayname);
|
||||
|
||||
} else {
|
||||
// Prepare data to use it for the component settings.
|
||||
$currentprocessorname = '';
|
||||
$componentprovidersetting = '';
|
||||
foreach ($processors as $processor) {
|
||||
if (str_contains($preference, '[' . $processor->name . ']')) {
|
||||
$currentprocessorname = $processor->name;
|
||||
$componentprovidersetting = str_replace('[' . $processor->name . ']', '', $preference);
|
||||
$labelparams = [
|
||||
'provider' => $providerdisplayname,
|
||||
'processor' => get_string('pluginname', 'message_' . $processor->name),
|
||||
];
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
// Locked toggle.
|
||||
if ($preference === $componentproviderbase.'_locked' . '[' . $currentprocessorname . ']') {
|
||||
$preferencename = $currentprocessorname.'_provider_'.$componentproviderbase . '_locked';
|
||||
$value = $state ? 1 : 0;
|
||||
if ($value === 1) {
|
||||
$successmessage = get_string('successproviderlocked', 'message', $labelparams);
|
||||
} else {
|
||||
$successmessage = get_string('successproviderunlocked', 'message', $labelparams);
|
||||
}
|
||||
}
|
||||
// Enabled toggle.
|
||||
if ($preference === $componentproviderbase.'_enabled' . '[' . $currentprocessorname . ']') {
|
||||
// Fetch the default message output preferences.
|
||||
$preferencename = 'message_provider_'.$componentprovidersetting;
|
||||
$successmessage = get_string('successproviderenabled', 'message', $labelparams);
|
||||
$newsettings = [];
|
||||
if (!empty($state)) {
|
||||
$newsettings[] = $currentprocessorname;
|
||||
}
|
||||
// Check if the property exists within the preferences to maintain existing values.
|
||||
if (property_exists($preferences, $preferencename)) {
|
||||
$newsettings = array_merge($newsettings, explode(',', $preferences->$preferencename));
|
||||
|
||||
if (in_array($currentprocessorname, $newsettings) && empty($state)) {
|
||||
if (($key = array_search($currentprocessorname, $newsettings)) !== false) {
|
||||
unset($newsettings[$key]);
|
||||
}
|
||||
}
|
||||
}
|
||||
$value = join(',', $newsettings);
|
||||
if (empty($value)) {
|
||||
$value = null;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
// Update preferences.
|
||||
if (!empty($preferencename)) {
|
||||
$transaction = $DB->start_delegated_transaction();
|
||||
$old = isset($preferences->$preferencename) ? $preferences->$preferencename : '';
|
||||
|
||||
if ($old != $value) {
|
||||
add_to_config_log($preferencename, $old, $value, 'message');
|
||||
}
|
||||
|
||||
set_config($preferencename, $value, 'message');
|
||||
$transaction->allow_commit();
|
||||
|
||||
\core_plugin_manager::reset_caches();
|
||||
}
|
||||
|
||||
return [
|
||||
'successmessage' => $successmessage,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Describe the return structure of the external service.
|
||||
*
|
||||
* @return external_function_parameters
|
||||
*/
|
||||
public static function execute_returns(): external_function_parameters {
|
||||
return new external_function_parameters([
|
||||
'successmessage' => new external_value(PARAM_TEXT, 'Success notification message.'),
|
||||
]);
|
||||
}
|
||||
}
|
||||
@@ -53,16 +53,16 @@ class core_message_renderer extends plugin_renderer_base {
|
||||
$output .= $this->heading(get_string('messageoutputs', 'message'));
|
||||
$output .= $this->manage_messageoutputs($allprocessors);
|
||||
|
||||
// Add active message output processors settings.
|
||||
$output .= $this->manage_defaultmessageoutputs($processors, $providers, $preferences);
|
||||
|
||||
$output .= html_writer::start_tag('div', array('class' => 'form-buttons'));
|
||||
$output .= html_writer::start_tag('div', ['class' => 'form-buttons mb-3']);
|
||||
$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');
|
||||
|
||||
// Add active message output processors settings.
|
||||
$output .= $this->manage_defaultmessageoutputs($processors, $providers, $preferences);
|
||||
|
||||
return $output;
|
||||
}
|
||||
|
||||
|
||||
+1
-1
@@ -29,7 +29,7 @@
|
||||
|
||||
defined('MOODLE_INTERNAL') || die();
|
||||
|
||||
$version = 2024120500.00; // YYYYMMDD = weekly release date of this DEV branch.
|
||||
$version = 2024120500.01; // YYYYMMDD = weekly release date of this DEV branch.
|
||||
// RR = release increments - 00 in DEV branches.
|
||||
// .XX = incremental changes.
|
||||
$release = '5.0dev (Build: 20241205)'; // Human-friendly version name
|
||||
|
||||
Reference in New Issue
Block a user