MDL-69166 core_payment: Add paymentarea to the payment subsystem
[moodle.git] / payment / gateway / paypal / classes / external / transaction_complete.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * This class contains a list of webservice functions related to the PayPal payment gateway.
19  *
20  * @package    pg_paypal
21  * @copyright  2020 Shamim Rezaie <shamim@moodle.com>
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 declare(strict_types=1);
27 namespace pg_paypal\external;
29 use core_payment\helper;
30 use external_api;
31 use external_function_parameters;
32 use external_value;
33 use core_payment\helper as payment_helper;
34 use pg_paypal\paypal_helper;
36 defined('MOODLE_INTERNAL') || die();
38 require_once($CFG->libdir . '/externallib.php');
40 class transaction_complete extends external_api {
42     /**
43      * Returns description of method parameters.
44      *
45      * @return external_function_parameters
46      */
47     public static function execute_parameters() {
48         return new external_function_parameters([
49             'component' => new external_value(PARAM_COMPONENT, 'The component name'),
50             'paymentarea' => new external_value(PARAM_AREA, 'Payment area in the component'),
51             'componentid' => new external_value(PARAM_INT, 'The item id in the context of the component area'),
52             'orderid' => new external_value(PARAM_TEXT, 'The order id coming back from PayPal'),
53         ]);
54     }
56     /**
57      * Perform what needs to be done when a transaction is reported to be complete.
58      * This function does not take cost as a parameter as we cannot rely on any provided value.
59      *
60      * @param string $component Name of the component that the componentid belongs to
61      * @param string $paymentarea
62      * @param int $componentid An internal identifier that is used by the component
63      * @param string $orderid PayPal order ID
64      * @return array
65      */
66     public static function execute(string $component, string $paymentarea, int $componentid, string $orderid): array {
67         global $USER, $DB;
69         self::validate_parameters(self::execute_parameters(), [
70             'component' => $component,
71             'paymentarea' => $paymentarea,
72             'componentid' => $componentid,
73             'orderid' => $orderid,
74         ]);
76         $config = (object)helper::get_gateway_configuration($component, $paymentarea, $componentid, 'paypal');
77         $sandbox = $config->environment == 'sandbox';
79         [
80             'amount' => $amount,
81             'currency' => $currency,
82             'accountid' => $accountid,
83         ] = payment_helper::get_cost($component, $paymentarea, $componentid);
85         // Add surcharge if there is any.
86         $surcharge = helper::get_gateway_surcharge('paypal');
87         $amount = helper::get_cost_with_surcharge($amount, $surcharge, $currency);
89         $paypalhelper = new paypal_helper($config->clientid, $config->secret, $sandbox);
90         $orderdetails = $paypalhelper->get_order_details($orderid);
92         $success = false;
93         $message = '';
95         if ($orderdetails) {
96             if ($orderdetails['status'] == paypal_helper::ORDER_STATUS_APPROVED &&
97                     $orderdetails['intent'] == paypal_helper::ORDER_INTENT_CAPTURE) {
98                 $item = $orderdetails['purchase_units'][0];
99                 if ($item['amount']['value'] == $amount && $item['amount']['currency_code'] == $currency) {
100                     $capture = $paypalhelper->capture_order($orderid);
101                     if ($capture && $capture['status'] == paypal_helper::CAPTURE_STATUS_COMPLETED) {
102                         $success = true;
103                         // Everything is correct. Let's give them what they paid for.
104                         try {
105                             $paymentid = payment_helper::save_payment((int) $accountid, $component, $paymentarea, $componentid,
106                                 (int) $USER->id, $amount, $currency, 'paypal');
108                             // Store PayPal extra information.
109                             $record = new \stdClass();
110                             $record->paymentid = $paymentid;
111                             $record->pp_orderid = $orderid;
113                             $DB->insert_record('pg_paypal', $record);
115                             payment_helper::deliver_order($component, $paymentarea, $componentid, $paymentid);
116                         } catch (\Exception $e) {
117                             debugging('Exception while trying to process payment: ' . $e->getMessage(), DEBUG_DEVELOPER);
118                             $success = false;
119                             $message = get_string('internalerror', 'pg_paypal');
120                         }
121                     } else {
122                         $success = false;
123                         $message = get_string('paymentnotcleared', 'pg_paypal');
124                     }
125                 } else {
126                     $success = false;
127                     $message = get_string('amountmismatch', 'pg_paypal');
128                 }
129             } else {
130                 $success = false;
131                 $message = get_string('paymentnotcleared', 'pg_paypal');
132             }
133         } else {
134             // Could not capture authorization!
135             $success = false;
136             $message = get_string('cannotfetchorderdatails', 'pg_paypal');
137         }
139         return [
140             'success' => $success,
141             'message' => $message,
142         ];
143     }
145     /**
146      * Returns description of method result value.
147      *
148      * @return external_function_parameters
149      */
150     public static function execute_returns() {
151         return new external_function_parameters([
152             'success' => new external_value(PARAM_BOOL, 'Whether everything was successful or not.'),
153             'message' => new external_value(PARAM_RAW, 'Message (usually the error message).'),
154         ]);
155     }