GatewayRoute.php
184 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\Framework\PaymentGateways\Routes; |
| 4 | |
| 5 | use Give\Framework\PaymentGateways\DataTransferObjects\GatewayRouteData; |
| 6 | use Give\Framework\PaymentGateways\Exceptions\PaymentGatewayException; |
| 7 | use Give\Framework\PaymentGateways\Log\PaymentGatewayLog; |
| 8 | use Give\Framework\PaymentGateways\PaymentGateway; |
| 9 | use Give\Framework\PaymentGateways\PaymentGatewayRegister; |
| 10 | use Give\Framework\PaymentGateways\Traits\HandleHttpResponses; |
| 11 | |
| 12 | use function Give\Framework\Http\Response\response; |
| 13 | |
| 14 | /** |
| 15 | * @since 2.18.0 |
| 16 | */ |
| 17 | class GatewayRoute |
| 18 | { |
| 19 | use HandleHttpResponses; |
| 20 | |
| 21 | /** |
| 22 | * This is our entry point into the Gateway Routing system. |
| 23 | * |
| 24 | * @since 2.19.0 - validate secureRouteMethods |
| 25 | * @since 2.18.0 |
| 26 | * |
| 27 | * @return void |
| 28 | * |
| 29 | * @throws PaymentGatewayException |
| 30 | */ |
| 31 | public function __invoke() |
| 32 | { |
| 33 | if ($this->isValidListener()) { |
| 34 | /** @var PaymentGatewayRegister $paymentGatewaysRegister */ |
| 35 | $paymentGatewaysRegister = give(PaymentGatewayRegister::class); |
| 36 | |
| 37 | // get all registered gateways |
| 38 | $paymentGateways = $paymentGatewaysRegister->getPaymentGateways(); |
| 39 | |
| 40 | // get all registered gateway ids |
| 41 | $gatewayIds = array_keys($paymentGateways); |
| 42 | |
| 43 | // make sure required params are valid |
| 44 | if (!$this->isValidRequest($gatewayIds)) { |
| 45 | throw new PaymentGatewayException('This route is not valid.'); |
| 46 | } |
| 47 | |
| 48 | // create DTO from GET request |
| 49 | $data = GatewayRouteData::fromRequest(give_clean($_GET)); |
| 50 | |
| 51 | /** |
| 52 | * Get the PaymentGateway instance |
| 53 | * |
| 54 | * @var PaymentGateway $gateway |
| 55 | */ |
| 56 | $gateway = give($paymentGateways[$data->gatewayId]); |
| 57 | |
| 58 | if (!$gateway->supportsMethodRoute($data->gatewayMethod)) { |
| 59 | throw new PaymentGatewayException('The gateway method does not exist.'); |
| 60 | } |
| 61 | |
| 62 | // If method is in secureRouteMethods then, validate signature |
| 63 | if (in_array($data->gatewayMethod, $gateway->secureRouteMethods, true)) { |
| 64 | $this->validateSignature($data->routeSignature, $data); |
| 65 | } |
| 66 | |
| 67 | // Navigate to our payment gateway api to handle calling the gateway's method |
| 68 | $this->handleGatewayRouteMethod($gateway, $data->gatewayMethod, $data->queryParams); |
| 69 | |
| 70 | exit; |
| 71 | } |
| 72 | } |
| 73 | |
| 74 | /** |
| 75 | * Check if the request is valid |
| 76 | * |
| 77 | * @since 2.19.0 remove required check give-donation-id |
| 78 | * |
| 79 | * @since 2.18.0 |
| 80 | * |
| 81 | * @param array $gatewayIds |
| 82 | * |
| 83 | * @return bool |
| 84 | * |
| 85 | * @example ?give-listener=give-gateway&give-gateway-id=test-gateway&give-donation-id=1&give-gateway-method=returnFromOffsiteRedirect |
| 86 | * |
| 87 | */ |
| 88 | private function isValidRequest($gatewayIds) |
| 89 | { |
| 90 | $isset = isset($_GET['give-gateway-id'], $_GET['give-gateway-method']); |
| 91 | $idValid = in_array($_GET['give-gateway-id'], $gatewayIds, true); |
| 92 | |
| 93 | return $isset && $idValid; |
| 94 | } |
| 95 | |
| 96 | /** |
| 97 | * Check if the listener is valid |
| 98 | * |
| 99 | * @since 2.18.0 |
| 100 | * |
| 101 | * @return bool |
| 102 | */ |
| 103 | private function isValidListener() |
| 104 | { |
| 105 | return isset($_GET['give-listener']) && $_GET['give-listener'] === 'give-gateway'; |
| 106 | } |
| 107 | |
| 108 | /** |
| 109 | * Validate signature using nonces |
| 110 | * |
| 111 | * @since 2.19.5 replace nonce with hash |
| 112 | * @since 2.19.4 replace RouteSignature args with unique donationId |
| 113 | * @since 2.19.0 |
| 114 | * |
| 115 | * @param string $routeSignature |
| 116 | * @param GatewayRouteData $data |
| 117 | * |
| 118 | * @return void |
| 119 | */ |
| 120 | private function validateSignature($routeSignature, GatewayRouteData $data) |
| 121 | { |
| 122 | $signature = new RouteSignature( |
| 123 | $data->gatewayId, |
| 124 | $data->gatewayMethod, |
| 125 | $data->routeSignatureId, |
| 126 | $data->routeSignatureExpiration |
| 127 | ); |
| 128 | |
| 129 | if (!$signature->isValid($routeSignature)) { |
| 130 | PaymentGatewayLog::error( |
| 131 | 'Invalid Secure Route', |
| 132 | [ |
| 133 | 'routeSignature' => $routeSignature, |
| 134 | 'signature' => $signature, |
| 135 | 'signatureString' => $signature->toString(), |
| 136 | 'signatureHash' => $signature->toHash(), |
| 137 | 'signatureExpiration' => $signature->expiration, |
| 138 | 'data' => $data |
| 139 | ] |
| 140 | ); |
| 141 | |
| 142 | wp_die('Forbidden', 403); |
| 143 | } |
| 144 | } |
| 145 | |
| 146 | /** |
| 147 | * Handle gateway route method |
| 148 | * |
| 149 | * @since 2.18.0 |
| 150 | * |
| 151 | * @since 2.19.0 - replace $donationId with $queryParams array |
| 152 | * @since 2.19.0 Record gateway id, callback method name and query params in log. |
| 153 | * |
| 154 | * @param PaymentGateway $gateway |
| 155 | * @param string $method |
| 156 | * @param array $queryParams |
| 157 | */ |
| 158 | private function handleGatewayRouteMethod(PaymentGateway $gateway, $method, $queryParams) |
| 159 | { |
| 160 | try { |
| 161 | $this->handleResponse($gateway->callRouteMethod($method, $queryParams)); |
| 162 | } catch (PaymentGatewayException $paymentGatewayException) { |
| 163 | $this->handleResponse(response()->json($paymentGatewayException->getMessage())); |
| 164 | } catch (\Exception $exception) { |
| 165 | PaymentGatewayLog::error( |
| 166 | $exception->getMessage(), |
| 167 | [ |
| 168 | 'Payment Gateway' => $gateway::id(), |
| 169 | 'Payment Gateway Method' => $method, |
| 170 | 'Query Params' => $queryParams |
| 171 | ] |
| 172 | ); |
| 173 | $this->handleResponse( |
| 174 | response()->json( |
| 175 | __( |
| 176 | 'An unexpected error occurred while processing your donation. Please try again or contact us to help resolve.', |
| 177 | 'give' |
| 178 | ) |
| 179 | ) |
| 180 | ); |
| 181 | } |
| 182 | } |
| 183 | } |
| 184 |