message/amd/src/toggle_contact_button.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/>.
  15
  16 /**
  17  * Module to add/remove contact using ajax.
  18  *
  19  * @module     core_message/toggle_contact_button
  20  * @class      toggle_contact_button
  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/templates', 'core/notification', 'core/custom_interaction_events'],
  26         function($, Ajax, Templates, Notification, CustomEvents) {
  27
  28     /**
  29      * Check the state of the element, if the current user is a contact or not.
  30      *
  31      * @method isContact
  32      * @param {object} element jQuery object for the button
  33      * @return {bool}
  34      */
  35     var isContact = function(element) {
  36         return element.attr('data-is-contact') == '1';
  37     };
  38
  39     /**
  40      * Record that the user is a contact.
  41      *
  42      * @method setContact
  43      * @param {object} element jQuery object for the button
  44      */
  45     var setContact = function(element) {
  46         element.attr('data-is-contact', '1');
  47     };
  48
  49     /**
  50      * Record that the user is not a contact.
  51      *
  52      * @method setNotContact
  53      * @param {object} element jQuery object for the button
  54      */
  55     var setNotContact = function(element) {
  56         element.attr('data-is-contact', '0');
  57     };
  58
  59     /**
  60      * Get the id for the user being viewed.
  61      *
  62      * @method getUserId
  63      * @param {object} element jQuery object for the button
  64      * @return {int}
  65      */
  66     var getUserId = function(element) {
  67         return element.attr('data-userid');
  68     };
  69
  70     /**
  71      * Check if this element is currently loading.
  72      *
  73      * @method isLoading
  74      * @param {object} element jQuery object for the button
  75      * @return {bool}
  76      */
  77     var isLoading = function(element) {
  78         return element.hasClass('loading') || element.attr('disabled');
  79     };
  80
  81     /**
  82      * Sends an ajax request to the server and handles the element state
  83      * while the request is being performed.
  84      *
  85      * @method sendRequest
  86      * @param {object} element jQuery object for the button
  87      * @param {object} request Request hash to send
  88      * @return {object} jQuery promise
  89      */
  90     var sendRequest = function(element, request) {
  91         if (isLoading(element)) {
  92             return $.Deferred();
  93         }
  94
  95         element.addClass('loading');
  96         element.attr('disabled', 'disabled');
  97
  98         return Ajax.call([request])[0]
  99             .fail(Notification.exception)
 100             .always(function() {
 101                 element.removeClass('loading');
 102                 element.removeAttr('disabled');
 103             });
 104     };
 105
 106     /**
 107      * Send a request to the server to add the current user as
 108      * a contact. The contents of the button are changed to the
 109      * remove contact button upon success.
 110      *
 111      * @method addContact
 112      * @param {object} element jQuery object for the button
 113      */
 114     var addContact = function(element) {
 115         if (isLoading(element)) {
 116             return;
 117         }
 118
 119         var request = {
 120             methodname: 'core_message_create_contacts',
 121             args: {
 122                 userids: [getUserId(element)],
 123             }
 124         };
 125         sendRequest(element, request).done(function() {
 126             setContact(element);
 127             Templates.render('message/remove_contact_button', {}).done(function(html, js) {
 128                 Templates.replaceNodeContents(element, html, js);
 129             });
 130         });
 131     };
 132
 133     /**
 134      * Send a request to the server to remove the current user as
 135      * a contact. The contents of the button are changed to the
 136      * add contact button upon success.
 137      *
 138      * @method removeContact
 139      * @param {object} element jQuery object for the button
 140      */
 141     var removeContact = function(element) {
 142         if (isLoading(element)) {
 143             return;
 144         }
 145
 146         var request = {
 147             methodname: 'core_message_delete_contacts',
 148             args: {
 149                 userids: [getUserId(element)],
 150             }
 151         };
 152
 153         sendRequest(element, request).done(function() {
 154             setNotContact(element);
 155             Templates.render('message/add_contact_button', {}).done(function(html, js) {
 156                 Templates.replaceNodeContents(element, html, js);
 157             });
 158         });
 159     };
 160
 161     /**
 162      * Enhances the given element with a loading gif and event handles to make
 163      * ajax requests to add or remove a contact where appropriate.
 164      *
 165      * @method enhance
 166      * @param {object} element jQuery object for the button
 167      */
 168     var enhance = function(element) {
 169         element = $(element);
 170
 171         if (!element.children('.loading-icon').length) {
 172             // Add the loading gif if it isn't already there.
 173             Templates.render('core/loading', {}).done(function(html, js) {
 174                 element.append(html, js);
 175             });
 176         }
 177
 178         CustomEvents.define(element, [CustomEvents.events.activate]);
 179
 180         element.on(CustomEvents.events.activate, function(e, data) {
 181             if (isContact(element)) {
 182                 removeContact(element);
 183             } else {
 184                 addContact(element);
 185             }
 186             e.preventDefault();
 187             data.originalEvent.preventDefault();
 188         });
 189     };
 190
 191     return /** @alias module:message/toggle_contact_button */ {
 192         enhance: enhance
 193     };
 194 });