e1678905e8d34e5369f57b58c82a266e8aa4deb3
[moodle.git] / message / amd / src / message_preferences.js
1 // This file is part of Moodle - http://moodle.org/
2 //
3 // Moodle is free software: you can redistribute it and/or modify
4 // it under the terms of the GNU General Public License as published by
5 // the Free Software Foundation, either version 3 of the License, or
6 // (at your option) any later version.
7 //
8 // Moodle is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 // GNU General Public License for more details.
12 //
13 // You should have received a copy of the GNU General Public License
14 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
16 /**
17  * Controls the message preference page.
18  *
19  * @module     core_message/message_preferences
20  * @class      message_preferences
21  * @package    message
22  * @copyright  2016 Ryan Wyllie <ryan@moodle.com>
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
25 define(['jquery', 'core/ajax', 'core/notification',
26         'core_message/message_notification_preference', 'core/custom_interaction_events'],
27         function($, Ajax, Notification, MessageNotificationPreference, CustomEvents) {
29     var SELECTORS = {
30         PREFERENCE: '[data-state]',
31         PREFERENCES_CONTAINER: '[data-region="preferences-container"]',
32         BLOCK_NON_CONTACTS: '[data-region="block-non-contacts-container"] [data-block-non-contacts]',
33         BLOCK_NON_CONTACTS_CONTAINER: '[data-region="block-non-contacts-container"]',
34     };
36     /**
37      * Constructor for the MessagePreferences.
38      *
39      * @param {object} element The root element for the message preferences
40      */
41     var MessagePreferences = function(element) {
42         this.root = $(element);
44         this.registerEventListeners();
45     };
47     /**
48      * Check if the preferences have been disabled on this page.
49      *
50      * @method preferencesDisabled
51      * @return {bool}
52      */
53     MessagePreferences.prototype.preferencesDisabled = function() {
54         return this.root.find(SELECTORS.PREFERENCES_CONTAINER).hasClass('disabled');
55     };
57     /**
58      * Update the block messages from non-contacts user preference in the DOM and
59      * send a request to update on the server.
60      *
61      * @return {Promise}
62      * @method saveBlockNonContactsStatus
63      */
64     MessagePreferences.prototype.saveBlockNonContactsStatus = function() {
65         var checkbox = this.root.find(SELECTORS.BLOCK_NON_CONTACTS);
66         var container = this.root.find(SELECTORS.BLOCK_NON_CONTACTS_CONTAINER);
67         var ischecked = checkbox.prop('checked');
69         if (container.hasClass('loading')) {
70             return $.Deferred().resolve();
71         }
73         container.addClass('loading');
75         var request = {
76             methodname: 'core_user_update_user_preferences',
77             args: {
78                 preferences: [
79                     {
80                         type: checkbox.attr('data-preference-key'),
81                         value: ischecked ? 1 : 0,
82                     }
83                 ]
84             }
85         };
87         return Ajax.call([request])[0]
88             .fail(Notification.exception)
89             .always(function() {
90                 container.removeClass('loading');
91             });
92     };
94     /**
95      * Create all of the event listeners for the message preferences page.
96      *
97      * @method registerEventListeners
98      */
99     MessagePreferences.prototype.registerEventListeners = function() {
100         CustomEvents.define(this.root, [
101             CustomEvents.events.activate
102         ]);
104         this.root.on(CustomEvents.events.activate, SELECTORS.BLOCK_NON_CONTACTS, function() {
105             this.saveBlockNonContactsStatus();
106         }.bind(this));
108         this.root.on('change', function(e) {
109             if (!this.preferencesDisabled()) {
110                 var preferencesContainer = $(e.target).closest(SELECTORS.PREFERENCES_CONTAINER);
111                 var preferenceElement = $(e.target).closest(SELECTORS.PREFERENCE);
112                 var messagePreference = new MessageNotificationPreference(preferencesContainer);
114                 preferenceElement.addClass('loading');
115                 messagePreference.save().always(function() {
116                     preferenceElement.removeClass('loading');
117                 });
118             }
119         }.bind(this));
120     };
122     return MessagePreferences;
123 });