WooPayments
5 days ago
Affirm.php
1 year ago
AfterpayClearpay.php
1 year ago
Airwallex.php
1 year ago
AmazonPay.php
1 year ago
Antom.php
1 year ago
Eway.php
11 months ago
GoCardless.php
1 year ago
Helcim.php
2 weeks ago
HelioPay.php
1 year ago
Klarna.php
1 year ago
Komoju.php
2 weeks ago
KustomCheckout.php
1 week ago
Mastercard.php
2 weeks ago
MercadoPago.php
1 year ago
Mollie.php
2 weeks ago
Monei.php
1 year ago
NexiCheckout.php
11 months ago
PayPal.php
1 year ago
PayUIndia.php
1 year ago
Payfast.php
1 year ago
PaymentGateway.php
5 months ago
Paymob.php
1 year ago
Payoneer.php
1 year ago
Paystack.php
1 year ago
Paytrail.php
1 year ago
PseudoWCPaymentGateway.php
1 year ago
Razorpay.php
1 year ago
Stripe.php
1 year ago
Tilopay.php
1 year ago
Visa.php
11 months ago
Vivacom.php
1 year ago
WCCore.php
9 months ago
WooPayments.php
9 months ago
Komoju.php
177 lines
| 1 | <?php |
| 2 | declare( strict_types=1 ); |
| 3 | |
| 4 | namespace Automattic\WooCommerce\Internal\Admin\Settings\PaymentsProviders; |
| 5 | |
| 6 | use Automattic\WooCommerce\Internal\Admin\Settings\Payments; |
| 7 | use Automattic\WooCommerce\Internal\Logging\SafeGlobalFunctionProxy; |
| 8 | use Throwable; |
| 9 | use WC_Payment_Gateway; |
| 10 | |
| 11 | defined( 'ABSPATH' ) || exit; |
| 12 | |
| 13 | /** |
| 14 | * KOMOJU payment gateway provider class. |
| 15 | * |
| 16 | * This class handles all the custom logic for the KOMOJU payment gateway provider. |
| 17 | */ |
| 18 | class Komoju extends PaymentGateway { |
| 19 | |
| 20 | /** |
| 21 | * Get the settings URL for a payment gateway. |
| 22 | * |
| 23 | * @param WC_Payment_Gateway $payment_gateway The payment gateway object. |
| 24 | * |
| 25 | * @return string The settings URL for the payment gateway. |
| 26 | */ |
| 27 | public function get_settings_url( WC_Payment_Gateway $payment_gateway ): string { |
| 28 | // The legacy combined gateway has no settings section of its own; account connection |
| 29 | // and payment method selection happen on KOMOJU's dedicated settings tab instead. |
| 30 | // Per-method gateways (`komoju_*`) already have a real settings section, so defer to |
| 31 | // the generic gateway settings URL logic for those. |
| 32 | if ( 'komoju' !== $payment_gateway->id ) { |
| 33 | return parent::get_settings_url( $payment_gateway ); |
| 34 | } |
| 35 | |
| 36 | return add_query_arg( |
| 37 | array( |
| 38 | 'from' => Payments::FROM_PAYMENTS_SETTINGS, |
| 39 | ), |
| 40 | admin_url( 'admin.php?page=wc-settings&tab=komoju_settings' ) |
| 41 | ); |
| 42 | } |
| 43 | |
| 44 | /** |
| 45 | * Try to determine if the payment gateway is in test mode. |
| 46 | * |
| 47 | * This is a best-effort attempt, as there is no standard way to determine this. |
| 48 | * Trust the true value, but don't consider a false value as definitive. |
| 49 | * |
| 50 | * @param WC_Payment_Gateway $payment_gateway The payment gateway object. |
| 51 | * |
| 52 | * @return bool True if the payment gateway is in test mode, false otherwise. |
| 53 | */ |
| 54 | public function is_in_test_mode( WC_Payment_Gateway $payment_gateway ): bool { |
| 55 | return $this->is_komoju_in_sandbox_mode( $payment_gateway ) ?? parent::is_in_test_mode( $payment_gateway ); |
| 56 | } |
| 57 | |
| 58 | /** |
| 59 | * Try to determine if the payment gateway is in test mode onboarding (aka sandbox). |
| 60 | * |
| 61 | * This is a best-effort attempt, as there is no standard way to determine this. |
| 62 | * Trust the true value, but don't consider a false value as definitive. |
| 63 | * |
| 64 | * @param WC_Payment_Gateway $payment_gateway The payment gateway object. |
| 65 | * |
| 66 | * @return bool True if the payment gateway is in test mode onboarding, false otherwise. |
| 67 | */ |
| 68 | public function is_in_test_mode_onboarding( WC_Payment_Gateway $payment_gateway ): bool { |
| 69 | // A `sk_test_` key is a sandbox credential, so the account itself is a test account, |
| 70 | // not just a live account processing test payments. KOMOJU exposes no separate |
| 71 | // onboarding environment signal, so the same check answers both questions. |
| 72 | return $this->is_komoju_in_sandbox_mode( $payment_gateway ) ?? parent::is_in_test_mode_onboarding( $payment_gateway ); |
| 73 | } |
| 74 | |
| 75 | /** |
| 76 | * Check if the KOMOJU payment gateway is in sandbox mode. |
| 77 | * |
| 78 | * @param WC_Payment_Gateway $payment_gateway The payment gateway object. |
| 79 | * |
| 80 | * @return ?bool True if the payment gateway is in sandbox mode, false otherwise. |
| 81 | * Null if the environment could not be determined. |
| 82 | */ |
| 83 | private function is_komoju_in_sandbox_mode( WC_Payment_Gateway $payment_gateway ): ?bool { |
| 84 | try { |
| 85 | // Check for a saved key first. The extension's helper below reports a store with no |
| 86 | // key at all as live, but we want that case to stay undetermined so the caller decides. |
| 87 | $secret_key = $this->get_secret_key( $payment_gateway ); |
| 88 | if ( empty( $secret_key ) ) { |
| 89 | return null; |
| 90 | } |
| 91 | |
| 92 | // Prefer the extension's own helper so we keep tracking how KOMOJU determines its |
| 93 | // environment, should that ever stop being a secret key check. |
| 94 | if ( class_exists( 'WC_Gateway_Komoju' ) && is_callable( 'WC_Gateway_Komoju::komoju_is_test_mode' ) ) { |
| 95 | return wc_string_to_bool( \WC_Gateway_Komoju::komoju_is_test_mode() ); |
| 96 | } |
| 97 | |
| 98 | // The helper only exists since extension version 3.2.9, so reproduce it for older |
| 99 | // versions: KOMOJU has no dedicated test-mode setting and infers the environment from |
| 100 | // whether the stored secret key has the `sk_test_` (vs. `sk_live_`) prefix. |
| 101 | return str_starts_with( $secret_key, 'sk_test_' ); |
| 102 | } catch ( Throwable $e ) { |
| 103 | // Do nothing but log so we can investigate. |
| 104 | SafeGlobalFunctionProxy::wc_get_logger()->debug( |
| 105 | 'Failed to determine if gateway is in sandbox mode: ' . $e->getMessage(), |
| 106 | array( |
| 107 | 'gateway' => $payment_gateway->id, |
| 108 | 'source' => 'settings-payments', |
| 109 | 'exception' => $e, |
| 110 | ) |
| 111 | ); |
| 112 | } |
| 113 | |
| 114 | // Let the caller know that we couldn't determine the environment. |
| 115 | return null; |
| 116 | } |
| 117 | |
| 118 | /** |
| 119 | * Check if the payment gateway has a payments processor account connected. |
| 120 | * |
| 121 | * @param WC_Payment_Gateway $payment_gateway The payment gateway object. |
| 122 | * |
| 123 | * @return bool True if the payment gateway account is connected, false otherwise. |
| 124 | * If the payment gateway does not provide the information, it will return true. |
| 125 | */ |
| 126 | public function is_account_connected( WC_Payment_Gateway $payment_gateway ): bool { |
| 127 | try { |
| 128 | // KOMOJU doesn't expose a dedicated "is connected" API. It considers the merchant |
| 129 | // connected once a secret key is saved. |
| 130 | return ! empty( $this->get_secret_key( $payment_gateway ) ); |
| 131 | } catch ( Throwable $e ) { |
| 132 | // Do nothing but log so we can investigate. |
| 133 | SafeGlobalFunctionProxy::wc_get_logger()->debug( |
| 134 | 'Failed to determine if gateway account is connected: ' . $e->getMessage(), |
| 135 | array( |
| 136 | 'gateway' => $payment_gateway->id, |
| 137 | 'source' => 'settings-payments', |
| 138 | 'exception' => $e, |
| 139 | ) |
| 140 | ); |
| 141 | } |
| 142 | |
| 143 | return parent::is_account_connected( $payment_gateway ); |
| 144 | } |
| 145 | |
| 146 | /** |
| 147 | * Get the KOMOJU secret key. |
| 148 | * |
| 149 | * @param WC_Payment_Gateway $payment_gateway The payment gateway object. |
| 150 | * |
| 151 | * @return string The secret key, or an empty string if none is saved. |
| 152 | */ |
| 153 | private function get_secret_key( WC_Payment_Gateway $payment_gateway ): string { |
| 154 | // Prefer the key the gateway resolved for itself, so we keep tracking where KOMOJU |
| 155 | // sources it from. Its `get_option_compat()` reads the current global option and falls |
| 156 | // back to the legacy per-gateway settings array, which is what we reproduce below. |
| 157 | // Guard on non-empty rather than isset(): versions older than 2.5.0 populate the property |
| 158 | // through `WC_Settings_API::get_option()`, which yields an empty string rather than null |
| 159 | // when nothing is stored, and that must still fall through to the reads below. |
| 160 | if ( ! empty( $payment_gateway->secretKey ) && is_string( $payment_gateway->secretKey ) ) { // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase |
| 161 | return $payment_gateway->secretKey; // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase |
| 162 | } |
| 163 | |
| 164 | // The property only exists since extension version 2.5.0, so reproduce its resolution |
| 165 | // for older versions. Note that we cannot use the gateway's own `get_option()` here: |
| 166 | // it reads `woocommerce_{$id}_settings`, which for the per-method `komoju_*` gateways |
| 167 | // is not where the shared key lives. |
| 168 | $secret_key = get_option( 'komoju_woocommerce_secret_key' ); |
| 169 | if ( empty( $secret_key ) ) { |
| 170 | $legacy_settings = get_option( 'woocommerce_komoju_settings' ); |
| 171 | $secret_key = is_array( $legacy_settings ) ? ( $legacy_settings['secretKey'] ?? '' ) : ''; |
| 172 | } |
| 173 | |
| 174 | return is_string( $secret_key ) ? $secret_key : ''; |
| 175 | } |
| 176 | } |
| 177 |