payment/amd/src/gateways_modal.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  * Contain the logic for the gateways modal.
  18  *
  19  * @module     core_payment/gateways_modal
  20  * @package    core_payment
  21  * @copyright  2019 Shamim Rezaie <shamim@moodle.com>
  22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23  */
  24
  25 import ModalFactory from 'core/modal_factory';
  26 import Templates from 'core/templates';
  27 import {get_string as getString} from 'core/str';
  28 import {getGatewaysSupportingCurrency} from './repository';
  29 import Selectors from './selectors';
  30 import ModalEvents from 'core/modal_events';
  31 import {add as addToast, addToastRegion} from 'core/toast';
  32 import Notification from 'core/notification';
  33
  34 /**
  35  * Register event listeners for the module.
  36  *
  37  * @param {string} nodeSelector The root to listen to.
  38  */
  39 export const registerEventListeners = (nodeSelector) => {
  40     const rootNode = document.querySelector(nodeSelector);
  41
  42     rootNode.addEventListener('click', (e) => {
  43         e.preventDefault();
  44         show(rootNode, {focusOnClose: e.target});
  45     });
  46 };
  47
  48 /**
  49  * Shows the gateway selector modal.
  50  *
  51  * @param {HTMLElement} rootNode
  52  * @param {Object} options - Additional options
  53  * @param {HTMLElement} options.focusOnClose The element to focus on when the modal is closed.
  54  */
  55 const show = async(rootNode, {
  56     focusOnClose = null,
  57 } = {}) => {
  58     const modal = await ModalFactory.create({
  59         type: ModalFactory.types.SAVE_CANCEL,
  60         title: await getString('selectpaymenttype', 'core_payment'),
  61         body: await Templates.render('core_payment/gateways_modal', {}),
  62     });
  63
  64     addToastRegion(modal.getRoot()[0]);
  65
  66     modal.show();
  67
  68     modal.getRoot().on(ModalEvents.hidden, () => {
  69         // Destroy when hidden.
  70         modal.destroy();
  71         try {
  72             focusOnClose.focus();
  73         } catch (e) {
  74             // eslint-disable-line
  75         }
  76     });
  77
  78     modal.getRoot().on(ModalEvents.save, (e) => {
  79         const root = modal.getRoot()[0];
  80         const gateway = (root.querySelector(Selectors.values.gateway) || {value: ''}).value;
  81
  82         if (gateway) {
  83             processPayment(
  84                 gateway,
  85                 rootNode.dataset.amount,
  86                 rootNode.dataset.currency,
  87                 rootNode.dataset.component,
  88                 rootNode.dataset.componentid,
  89                 rootNode.dataset.description,
  90                 ({success, message = ''}) => {
  91                     modal.hide();
  92                     if (success) {
  93                         Notification.addNotification({
  94                             message: message,
  95                             type: 'success',
  96                         });
  97                         location.reload();
  98                     } else {
  99                         Notification.alert('', message);
 100                     }
 101                 },
 102             );
 103         } else {
 104             // We cannot use await in the following line.
 105             // The reason is that we are preventing the default action of the save event being triggered,
 106             // therefore we cannot define the event handler function asynchronous.
 107             getString('nogatewayselected', 'core_payment').then(message => addToast(message));
 108         }
 109
 110         e.preventDefault();
 111     });
 112
 113     const currency = rootNode.dataset.currency;
 114     const gateways = await getGatewaysSupportingCurrency(currency);
 115     const context = {
 116         gateways
 117     };
 118
 119     const {html, js} = await Templates.renderForPromise('core_payment/gateways', context);
 120     Templates.replaceNodeContents(modal.getRoot().find(Selectors.regions.gatewaysContainer), html, js);
 121 };
 122
 123 /**
 124  * Process payment using the selected gateway.
 125  *
 126  * @param {string} gateway The gateway to be used for payment
 127  * @param {number} amount Amount of payment
 128  * @param {string} currency The currency in the three-character ISO-4217 format
 129  * @param {string} component Name of the component that the componentid belongs to
 130  * @param {number} componentid An internal identifier that is used by the component
 131  * @param {string} description Description of the payment
 132  * @param {processPaymentCallback} callback The callback function to call when processing is finished
 133  * @returns {Promise<void>}
 134  */
 135 const processPayment = async(gateway, amount, currency, component, componentid, description, callback) => {
 136     const paymentMethod = await import(`pg_${gateway}/gateways_modal`);
 137
 138     paymentMethod.process(amount, currency, component, componentid, description, callback);
 139 };
 140
 141 /**
 142  * The callback definition for processPayment.
 143  *
 144  * @callback processPaymentCallback
 145  * @param {bool} success
 146  * @param {string} message
 147  */