MDL-69166 core_payment: Use a custom modal type for gateway selector
[moodle.git] / 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/>.
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  */
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 PaymentEvents from 'core_payment/events';
32 import {add as addToast, addToastRegion} from 'core/toast';
33 import Notification from 'core/notification';
34 import ModalGateways from './modal_gateways';
36 /**
37  * Register event listeners for the module.
38  *
39  * @param {string} nodeSelector The root to listen to.
40  */
41 export const registerEventListenersBySelector = (nodeSelector) => {
42     document.querySelectorAll(nodeSelector).forEach((element) => {
43         registerEventListeners(element);
44     });
45 };
47 /**
48  * Register event listeners for the module.
49  *
50  * @param {HTMLElement} rootNode The root to listen to.
51  */
52 export const registerEventListeners = (rootNode) => {
53     rootNode.addEventListener('click', (e) => {
54         e.preventDefault();
55         show(rootNode, {focusOnClose: e.target});
56     });
57 };
59 /**
60  * Shows the gateway selector modal.
61  *
62  * @param {HTMLElement} rootNode
63  * @param {Object} options - Additional options
64  * @param {HTMLElement} options.focusOnClose The element to focus on when the modal is closed.
65  */
66 const show = async(rootNode, {
67     focusOnClose = null,
68 } = {}) => {
69     const modal = await ModalFactory.create({
70         type: ModalGateways.TYPE,
71         title: await getString('selectpaymenttype', 'core_payment'),
72         body: await Templates.render('core_payment/gateways_modal', {}),
73     });
75     addToastRegion(modal.getRoot()[0]);
77     modal.show();
79     modal.getRoot().on(ModalEvents.hidden, () => {
80         // Destroy when hidden.
81         modal.destroy();
82         try {
83             focusOnClose.focus();
84         } catch (e) {
85             // eslint-disable-line
86         }
87     });
89     modal.getRoot().on(PaymentEvents.proceed, (e) => {
90         const root = modal.getRoot()[0];
91         const gateway = (root.querySelector(Selectors.values.gateway) || {value: ''}).value;
93         if (gateway) {
94             processPayment(
95                 gateway,
96                 rootNode.dataset.amount,
97                 rootNode.dataset.currency,
98                 rootNode.dataset.component,
99                 rootNode.dataset.componentid,
100                 rootNode.dataset.description,
101                 ({success, message = ''}) => {
102                     modal.hide();
103                     if (success) {
104                         Notification.addNotification({
105                             message: message,
106                             type: 'success',
107                         });
108                         location.reload();
109                     } else {
110                         Notification.alert('', message);
111                     }
112                 },
113             );
114         } else {
115             // We cannot use await in the following line.
116             // The reason is that we are preventing the default action of the save event being triggered,
117             // therefore we cannot define the event handler function asynchronous.
118             getString('nogatewayselected', 'core_payment').then(message => addToast(message));
119         }
121         e.preventDefault();
122     });
124     const currency = rootNode.dataset.currency;
125     const gateways = await getGatewaysSupportingCurrency(currency);
126     const context = {
127         gateways
128     };
130     const {html, js} = await Templates.renderForPromise('core_payment/gateways', context);
131     Templates.replaceNodeContents(modal.getRoot().find(Selectors.regions.gatewaysContainer), html, js);
132 };
134 /**
135  * Process payment using the selected gateway.
136  *
137  * @param {string} gateway The gateway to be used for payment
138  * @param {number} amount Amount of payment
139  * @param {string} currency The currency in the three-character ISO-4217 format
140  * @param {string} component Name of the component that the componentid belongs to
141  * @param {number} componentid An internal identifier that is used by the component
142  * @param {string} description Description of the payment
143  * @param {processPaymentCallback} callback The callback function to call when processing is finished
144  * @returns {Promise<void>}
145  */
146 const processPayment = async(gateway, amount, currency, component, componentid, description, callback) => {
147     const paymentMethod = await import(`pg_${gateway}/gateways_modal`);
149     paymentMethod.process(amount, currency, component, componentid, description, callback);
150 };
152 /**
153  * The callback definition for processPayment.
154  *
155  * @callback processPaymentCallback
156  * @param {bool} success
157  * @param {string} message
158  */