woocommerce /
woocommerce-gateway-stripe
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like WC_Gateway_Stripe often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use WC_Gateway_Stripe, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 11 | class WC_Gateway_Stripe extends WC_Stripe_Payment_Gateway { |
||
| 12 | /** |
||
| 13 | * The delay between retries. |
||
| 14 | * |
||
| 15 | * @var int |
||
| 16 | */ |
||
| 17 | public $retry_interval; |
||
| 18 | |||
| 19 | /** |
||
| 20 | * Should we capture Credit cards |
||
| 21 | * |
||
| 22 | * @var bool |
||
| 23 | */ |
||
| 24 | public $capture; |
||
| 25 | |||
| 26 | /** |
||
| 27 | * Alternate credit card statement name |
||
| 28 | * |
||
| 29 | * @var bool |
||
| 30 | */ |
||
| 31 | public $statement_descriptor; |
||
| 32 | |||
| 33 | /** |
||
| 34 | * Should we store the users credit cards? |
||
| 35 | * |
||
| 36 | * @var bool |
||
| 37 | */ |
||
| 38 | public $saved_cards; |
||
| 39 | |||
| 40 | /** |
||
| 41 | * API access secret key |
||
| 42 | * |
||
| 43 | * @var string |
||
| 44 | */ |
||
| 45 | public $secret_key; |
||
| 46 | |||
| 47 | /** |
||
| 48 | * Api access publishable key |
||
| 49 | * |
||
| 50 | * @var string |
||
| 51 | */ |
||
| 52 | public $publishable_key; |
||
| 53 | |||
| 54 | /** |
||
| 55 | * Do we accept Payment Request? |
||
| 56 | * |
||
| 57 | * @var bool |
||
| 58 | */ |
||
| 59 | public $payment_request; |
||
| 60 | |||
| 61 | /** |
||
| 62 | * Is test mode active? |
||
| 63 | * |
||
| 64 | * @var bool |
||
| 65 | */ |
||
| 66 | public $testmode; |
||
| 67 | |||
| 68 | /** |
||
| 69 | * Inline CC form styling |
||
| 70 | * |
||
| 71 | * @var string |
||
| 72 | */ |
||
| 73 | public $inline_cc_form; |
||
| 74 | |||
| 75 | /** |
||
| 76 | * Pre Orders Object |
||
| 77 | * |
||
| 78 | * @var object |
||
| 79 | */ |
||
| 80 | public $pre_orders; |
||
| 81 | |||
| 82 | /** |
||
| 83 | * Constructor |
||
| 84 | */ |
||
| 85 | public function __construct() { |
||
| 86 | $this->retry_interval = 1; |
||
| 87 | $this->id = 'stripe'; |
||
| 88 | $this->method_title = __( 'Stripe', 'woocommerce-gateway-stripe' ); |
||
| 89 | /* translators: 1) link to Stripe register page 2) link to Stripe api keys page */ |
||
| 90 | $this->method_description = __( 'Stripe works by adding payment fields on the checkout and then sending the details to Stripe for verification.', 'woocommerce-gateway-stripe' ); |
||
| 91 | $this->has_fields = true; |
||
| 92 | $this->supports = array( |
||
| 93 | 'products', |
||
| 94 | 'refunds', |
||
| 95 | 'tokenization', |
||
| 96 | 'add_payment_method', |
||
| 97 | 'subscriptions', |
||
| 98 | 'subscription_cancellation', |
||
| 99 | 'subscription_suspension', |
||
| 100 | 'subscription_reactivation', |
||
| 101 | 'subscription_amount_changes', |
||
| 102 | 'subscription_date_changes', |
||
| 103 | 'subscription_payment_method_change', |
||
| 104 | 'subscription_payment_method_change_customer', |
||
| 105 | 'subscription_payment_method_change_admin', |
||
| 106 | 'multiple_subscriptions', |
||
| 107 | 'pre-orders', |
||
| 108 | ); |
||
| 109 | |||
| 110 | // Load the form fields. |
||
| 111 | $this->init_form_fields(); |
||
| 112 | |||
| 113 | // Load the settings. |
||
| 114 | $this->init_settings(); |
||
| 115 | |||
| 116 | // Get setting values. |
||
| 117 | $this->title = $this->get_option( 'title' ); |
||
| 118 | $this->description = $this->get_option( 'description' ); |
||
| 119 | $this->enabled = $this->get_option( 'enabled' ); |
||
| 120 | $this->testmode = 'yes' === $this->get_option( 'testmode' ); |
||
| 121 | $this->inline_cc_form = 'yes' === $this->get_option( 'inline_cc_form' ); |
||
|
|
|||
| 122 | $this->capture = 'yes' === $this->get_option( 'capture', 'yes' ); |
||
| 123 | $this->statement_descriptor = WC_Stripe_Helper::clean_statement_descriptor( $this->get_option( 'statement_descriptor' ) ); |
||
| 124 | $this->saved_cards = 'yes' === $this->get_option( 'saved_cards' ); |
||
| 125 | $this->secret_key = $this->testmode ? $this->get_option( 'test_secret_key' ) : $this->get_option( 'secret_key' ); |
||
| 126 | $this->publishable_key = $this->testmode ? $this->get_option( 'test_publishable_key' ) : $this->get_option( 'publishable_key' ); |
||
| 127 | $this->payment_request = 'yes' === $this->get_option( 'payment_request', 'yes' ); |
||
| 128 | |||
| 129 | WC_Stripe_API::set_secret_key( $this->secret_key ); |
||
| 130 | |||
| 131 | // Hooks. |
||
| 132 | add_action( 'wp_enqueue_scripts', array( $this, 'payment_scripts' ) ); |
||
| 133 | add_action( 'admin_enqueue_scripts', array( $this, 'admin_scripts' ) ); |
||
| 134 | add_action( 'woocommerce_update_options_payment_gateways_' . $this->id, array( $this, 'process_admin_options' ) ); |
||
| 135 | add_action( 'woocommerce_admin_order_totals_after_total', array( $this, 'display_order_fee' ) ); |
||
| 136 | add_action( 'woocommerce_admin_order_totals_after_total', array( $this, 'display_order_payout' ), 20 ); |
||
| 137 | add_action( 'woocommerce_customer_save_address', array( $this, 'show_update_card_notice' ), 10, 2 ); |
||
| 138 | add_filter( 'woocommerce_available_payment_gateways', array( $this, 'prepare_order_pay_page' ) ); |
||
| 139 | add_action( 'woocommerce_account_view-order_endpoint', array( $this, 'check_intent_status_on_order_page' ), 1 ); |
||
| 140 | add_filter( 'woocommerce_payment_successful_result', array( $this, 'modify_successful_payment_result' ), 99999, 2 ); |
||
| 141 | add_action( 'set_logged_in_cookie', array( $this, 'set_cookie_on_current_request' ) ); |
||
| 142 | add_filter( 'woocommerce_get_checkout_payment_url', array( $this, 'get_checkout_payment_url' ), 10, 2 ); |
||
| 143 | |||
| 144 | // Note: display error is in the parent class. |
||
| 145 | add_action( 'admin_notices', array( $this, 'display_errors' ), 9999 ); |
||
| 146 | |||
| 147 | View Code Duplication | if ( WC_Stripe_Helper::is_pre_orders_exists() ) { |
|
| 148 | $this->pre_orders = new WC_Stripe_Pre_Orders_Compat(); |
||
| 149 | |||
| 150 | add_action( 'wc_pre_orders_process_pre_order_completion_payment_' . $this->id, array( $this->pre_orders, 'process_pre_order_release_payment' ) ); |
||
| 151 | } |
||
| 152 | } |
||
| 153 | |||
| 154 | /** |
||
| 155 | * Checks if gateway should be available to use. |
||
| 156 | * |
||
| 157 | * @since 4.0.2 |
||
| 158 | */ |
||
| 159 | public function is_available() { |
||
| 160 | if ( is_add_payment_method_page() && ! $this->saved_cards ) { |
||
| 161 | return false; |
||
| 162 | } |
||
| 163 | |||
| 164 | return parent::is_available(); |
||
| 165 | } |
||
| 166 | |||
| 167 | /** |
||
| 168 | * Adds a notice for customer when they update their billing address. |
||
| 169 | * |
||
| 170 | * @since 4.1.0 |
||
| 171 | * @param int $user_id The ID of the current user. |
||
| 172 | * @param string $load_address The address to load. |
||
| 173 | */ |
||
| 174 | public function show_update_card_notice( $user_id, $load_address ) { |
||
| 175 | if ( ! $this->saved_cards || ! WC_Stripe_Payment_Tokens::customer_has_saved_methods( $user_id ) || 'billing' !== $load_address ) { |
||
| 176 | return; |
||
| 177 | } |
||
| 178 | |||
| 179 | /* translators: 1) Opening anchor tag 2) closing anchor tag */ |
||
| 180 | wc_add_notice( sprintf( __( 'If your billing address has been changed for saved payment methods, be sure to remove any %1$ssaved payment methods%2$s on file and re-add them.', 'woocommerce-gateway-stripe' ), '<a href="' . esc_url( wc_get_endpoint_url( 'payment-methods' ) ) . '" class="wc-stripe-update-card-notice" style="text-decoration:underline;">', '</a>' ), 'notice' ); |
||
| 181 | } |
||
| 182 | |||
| 183 | /** |
||
| 184 | * Get_icon function. |
||
| 185 | * |
||
| 186 | * @since 1.0.0 |
||
| 187 | * @version 4.0.0 |
||
| 188 | * @return string |
||
| 189 | */ |
||
| 190 | public function get_icon() { |
||
| 191 | $icons = $this->payment_icons(); |
||
| 192 | |||
| 193 | $icons_str = ''; |
||
| 194 | |||
| 195 | $icons_str .= isset( $icons['visa'] ) ? $icons['visa'] : ''; |
||
| 196 | $icons_str .= isset( $icons['amex'] ) ? $icons['amex'] : ''; |
||
| 197 | $icons_str .= isset( $icons['mastercard'] ) ? $icons['mastercard'] : ''; |
||
| 198 | |||
| 199 | if ( 'USD' === get_woocommerce_currency() ) { |
||
| 200 | $icons_str .= isset( $icons['discover'] ) ? $icons['discover'] : ''; |
||
| 201 | $icons_str .= isset( $icons['jcb'] ) ? $icons['jcb'] : ''; |
||
| 202 | $icons_str .= isset( $icons['diners'] ) ? $icons['diners'] : ''; |
||
| 203 | } |
||
| 204 | |||
| 205 | return apply_filters( 'woocommerce_gateway_icon', $icons_str, $this->id ); |
||
| 206 | } |
||
| 207 | |||
| 208 | /** |
||
| 209 | * Initialise Gateway Settings Form Fields |
||
| 210 | */ |
||
| 211 | public function init_form_fields() { |
||
| 212 | $this->form_fields = require( dirname( __FILE__ ) . '/admin/stripe-settings.php' ); |
||
| 213 | } |
||
| 214 | |||
| 215 | /** |
||
| 216 | * Payment form on checkout page |
||
| 217 | */ |
||
| 218 | public function payment_fields() { |
||
| 219 | global $wp; |
||
| 220 | $user = wp_get_current_user(); |
||
| 221 | $display_tokenization = $this->supports( 'tokenization' ) && is_checkout() && $this->saved_cards; |
||
| 222 | $total = WC()->cart->total; |
||
| 223 | $user_email = ''; |
||
| 224 | $description = $this->get_description(); |
||
| 225 | $description = ! empty( $description ) ? $description : ''; |
||
| 226 | $firstname = ''; |
||
| 227 | $lastname = ''; |
||
| 228 | |||
| 229 | // If paying from order, we need to get total from order not cart. |
||
| 230 | if ( isset( $_GET['pay_for_order'] ) && ! empty( $_GET['key'] ) ) { // wpcs: csrf ok. |
||
| 231 | $order = wc_get_order( wc_clean( $wp->query_vars['order-pay'] ) ); // wpcs: csrf ok, sanitization ok. |
||
| 232 | $total = $order->get_total(); |
||
| 233 | $user_email = $order->get_billing_email(); |
||
| 234 | } else { |
||
| 235 | if ( $user->ID ) { |
||
| 236 | $user_email = get_user_meta( $user->ID, 'billing_email', true ); |
||
| 237 | $user_email = $user_email ? $user_email : $user->user_email; |
||
| 238 | } |
||
| 239 | } |
||
| 240 | |||
| 241 | if ( is_add_payment_method_page() ) { |
||
| 242 | $firstname = $user->user_firstname; |
||
| 243 | $lastname = $user->user_lastname; |
||
| 244 | } |
||
| 245 | |||
| 246 | ob_start(); |
||
| 247 | |||
| 248 | echo '<div |
||
| 249 | id="stripe-payment-data" |
||
| 250 | data-email="' . esc_attr( $user_email ) . '" |
||
| 251 | data-full-name="' . esc_attr( $firstname . ' ' . $lastname ) . '" |
||
| 252 | data-currency="' . esc_attr( strtolower( get_woocommerce_currency() ) ) . '" |
||
| 253 | >'; |
||
| 254 | |||
| 255 | if ( $this->testmode ) { |
||
| 256 | /* translators: link to Stripe testing page */ |
||
| 257 | $description .= ' ' . sprintf( __( 'TEST MODE ENABLED. In test mode, you can use the card number 4242424242424242 with any CVC and a valid expiration date or check the <a href="%s" target="_blank">Testing Stripe documentation</a> for more card numbers.', 'woocommerce-gateway-stripe' ), 'https://stripe.com/docs/testing' ); |
||
| 258 | } |
||
| 259 | |||
| 260 | $description = trim( $description ); |
||
| 261 | |||
| 262 | echo apply_filters( 'wc_stripe_description', wpautop( wp_kses_post( $description ) ), $this->id ); // wpcs: xss ok. |
||
| 263 | |||
| 264 | if ( $display_tokenization ) { |
||
| 265 | $this->tokenization_script(); |
||
| 266 | $this->saved_payment_methods(); |
||
| 267 | } |
||
| 268 | |||
| 269 | $this->elements_form(); |
||
| 270 | |||
| 271 | View Code Duplication | if ( apply_filters( 'wc_stripe_display_save_payment_method_checkbox', $display_tokenization ) && ! is_add_payment_method_page() && ! isset( $_GET['change_payment_method'] ) ) { // wpcs: csrf ok. |
|
| 272 | |||
| 273 | $this->save_payment_method_checkbox(); |
||
| 274 | } |
||
| 275 | |||
| 276 | do_action( 'wc_stripe_cards_payment_fields', $this->id ); |
||
| 277 | |||
| 278 | echo '</div>'; |
||
| 279 | |||
| 280 | ob_end_flush(); |
||
| 281 | } |
||
| 282 | |||
| 283 | /** |
||
| 284 | * Renders the Stripe elements form. |
||
| 285 | * |
||
| 286 | * @since 4.0.0 |
||
| 287 | * @version 4.0.0 |
||
| 288 | */ |
||
| 289 | public function elements_form() { |
||
| 290 | ?> |
||
| 291 | <fieldset id="wc-<?php echo esc_attr( $this->id ); ?>-cc-form" class="wc-credit-card-form wc-payment-form" style="background:transparent;"> |
||
| 292 | <?php do_action( 'woocommerce_credit_card_form_start', $this->id ); ?> |
||
| 293 | |||
| 294 | <?php if ( $this->inline_cc_form ) { ?> |
||
| 295 | <label for="card-element"> |
||
| 296 | <?php esc_html_e( 'Credit or debit card', 'woocommerce-gateway-stripe' ); ?> |
||
| 297 | </label> |
||
| 298 | |||
| 299 | <div id="stripe-card-element" class="wc-stripe-elements-field"> |
||
| 300 | <!-- a Stripe Element will be inserted here. --> |
||
| 301 | </div> |
||
| 302 | <?php } else { ?> |
||
| 303 | <div class="form-row form-row-wide"> |
||
| 304 | <label for="stripe-card-element"><?php esc_html_e( 'Card Number', 'woocommerce-gateway-stripe' ); ?> <span class="required">*</span></label> |
||
| 305 | <div class="stripe-card-group"> |
||
| 306 | <div id="stripe-card-element" class="wc-stripe-elements-field"> |
||
| 307 | <!-- a Stripe Element will be inserted here. --> |
||
| 308 | </div> |
||
| 309 | |||
| 310 | <i class="stripe-credit-card-brand stripe-card-brand" alt="Credit Card"></i> |
||
| 311 | </div> |
||
| 312 | </div> |
||
| 313 | |||
| 314 | <div class="form-row form-row-first"> |
||
| 315 | <label for="stripe-exp-element"><?php esc_html_e( 'Expiry Date', 'woocommerce-gateway-stripe' ); ?> <span class="required">*</span></label> |
||
| 316 | |||
| 317 | <div id="stripe-exp-element" class="wc-stripe-elements-field"> |
||
| 318 | <!-- a Stripe Element will be inserted here. --> |
||
| 319 | </div> |
||
| 320 | </div> |
||
| 321 | |||
| 322 | <div class="form-row form-row-last"> |
||
| 323 | <label for="stripe-cvc-element"><?php esc_html_e( 'Card Code (CVC)', 'woocommerce-gateway-stripe' ); ?> <span class="required">*</span></label> |
||
| 324 | <div id="stripe-cvc-element" class="wc-stripe-elements-field"> |
||
| 325 | <!-- a Stripe Element will be inserted here. --> |
||
| 326 | </div> |
||
| 327 | </div> |
||
| 328 | <div class="clear"></div> |
||
| 329 | <?php } ?> |
||
| 330 | |||
| 331 | <!-- Used to display form errors --> |
||
| 332 | <div class="stripe-source-errors" role="alert"></div> |
||
| 333 | <br /> |
||
| 334 | <?php do_action( 'woocommerce_credit_card_form_end', $this->id ); ?> |
||
| 335 | <div class="clear"></div> |
||
| 336 | </fieldset> |
||
| 337 | <?php |
||
| 338 | } |
||
| 339 | |||
| 340 | /** |
||
| 341 | * Load admin scripts. |
||
| 342 | * |
||
| 343 | * @since 3.1.0 |
||
| 344 | * @version 3.1.0 |
||
| 345 | */ |
||
| 346 | public function admin_scripts() { |
||
| 347 | if ( 'woocommerce_page_wc-settings' !== get_current_screen()->id ) { |
||
| 348 | return; |
||
| 349 | } |
||
| 350 | |||
| 351 | $suffix = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ? '' : '.min'; |
||
| 352 | |||
| 353 | wp_enqueue_script( 'woocommerce_stripe_admin', plugins_url( 'assets/js/stripe-admin' . $suffix . '.js', WC_STRIPE_MAIN_FILE ), array(), WC_STRIPE_VERSION, true ); |
||
| 354 | } |
||
| 355 | |||
| 356 | /** |
||
| 357 | * Payment_scripts function. |
||
| 358 | * |
||
| 359 | * Outputs scripts used for stripe payment |
||
| 360 | * |
||
| 361 | * @since 3.1.0 |
||
| 362 | * @version 4.0.0 |
||
| 363 | */ |
||
| 364 | public function payment_scripts() { |
||
| 365 | global $wp; |
||
| 366 | if ( |
||
| 367 | ! is_product() |
||
| 368 | && ! is_cart() |
||
| 369 | && ! is_checkout() |
||
| 370 | && ! isset( $_GET['pay_for_order'] ) // wpcs: csrf ok. |
||
| 371 | && ! is_add_payment_method_page() |
||
| 372 | && ! isset( $_GET['change_payment_method'] ) // wpcs: csrf ok. |
||
| 373 | && ! ( ! empty( get_query_var( 'view-subscription' ) ) && is_callable( 'WCS_Early_Renewal_Manager::is_early_renewal_via_modal_enabled' ) && WCS_Early_Renewal_Manager::is_early_renewal_via_modal_enabled() ) |
||
| 374 | || ( is_order_received_page() ) |
||
| 375 | ) { |
||
| 376 | return; |
||
| 377 | } |
||
| 378 | |||
| 379 | // If Stripe is not enabled bail. |
||
| 380 | if ( 'no' === $this->enabled ) { |
||
| 381 | return; |
||
| 382 | } |
||
| 383 | |||
| 384 | // If keys are not set bail. |
||
| 385 | if ( ! $this->are_keys_set() ) { |
||
| 386 | WC_Stripe_Logger::log( 'Keys are not set correctly.' ); |
||
| 387 | return; |
||
| 388 | } |
||
| 389 | |||
| 390 | // If no SSL bail. |
||
| 391 | if ( ! $this->testmode && ! is_ssl() ) { |
||
| 392 | WC_Stripe_Logger::log( 'Stripe live mode requires SSL.' ); |
||
| 393 | return; |
||
| 394 | } |
||
| 395 | |||
| 396 | $current_theme = wp_get_theme(); |
||
| 397 | |||
| 398 | $suffix = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ? '' : '.min'; |
||
| 399 | |||
| 400 | wp_register_style( 'stripe_styles', plugins_url( 'assets/css/stripe-styles.css', WC_STRIPE_MAIN_FILE ), array(), WC_STRIPE_VERSION ); |
||
| 401 | wp_enqueue_style( 'stripe_styles' ); |
||
| 402 | |||
| 403 | wp_register_script( 'stripe', 'https://js.stripe.com/v3/', '', '3.0', true ); |
||
| 404 | wp_register_script( 'woocommerce_stripe', plugins_url( 'assets/js/stripe' . $suffix . '.js', WC_STRIPE_MAIN_FILE ), array( 'jquery-payment', 'stripe' ), WC_STRIPE_VERSION, true ); |
||
| 405 | |||
| 406 | $stripe_params = array( |
||
| 407 | 'key' => $this->publishable_key, |
||
| 408 | 'i18n_terms' => __( 'Please accept the terms and conditions first', 'woocommerce-gateway-stripe' ), |
||
| 409 | 'i18n_required_fields' => __( 'Please fill in required checkout fields first', 'woocommerce-gateway-stripe' ), |
||
| 410 | ); |
||
| 411 | |||
| 412 | // If we're on the pay page we need to pass stripe.js the address of the order. |
||
| 413 | if ( isset( $_GET['pay_for_order'] ) && 'true' === $_GET['pay_for_order'] ) { // wpcs: csrf ok. |
||
| 414 | $order_id = wc_clean( $wp->query_vars['order-pay'] ); // wpcs: csrf ok, sanitization ok, xss ok. |
||
| 415 | $order = wc_get_order( $order_id ); |
||
| 416 | |||
| 417 | if ( is_a( $order, 'WC_Order' ) ) { |
||
| 418 | $stripe_params['billing_first_name'] = $order->get_billing_first_name(); |
||
| 419 | $stripe_params['billing_last_name'] = $order->get_billing_last_name(); |
||
| 420 | $stripe_params['billing_address_1'] = $order->get_billing_address_1(); |
||
| 421 | $stripe_params['billing_address_2'] = $order->get_billing_address_2(); |
||
| 422 | $stripe_params['billing_state'] = $order->get_billing_state(); |
||
| 423 | $stripe_params['billing_city'] = $order->get_billing_city(); |
||
| 424 | $stripe_params['billing_postcode'] = $order->get_billing_postcode(); |
||
| 425 | $stripe_params['billing_country'] = $order->get_billing_country(); |
||
| 426 | } |
||
| 427 | } |
||
| 428 | |||
| 429 | $sepa_elements_options = apply_filters( |
||
| 430 | 'wc_stripe_sepa_elements_options', |
||
| 431 | array( |
||
| 432 | 'supportedCountries' => array( 'SEPA' ), |
||
| 433 | 'placeholderCountry' => WC()->countries->get_base_country(), |
||
| 434 | 'style' => array( 'base' => array( 'fontSize' => '15px' ) ), |
||
| 435 | ) |
||
| 436 | ); |
||
| 437 | |||
| 438 | $stripe_params['no_prepaid_card_msg'] = __( 'Sorry, we\'re not accepting prepaid cards at this time. Your credit card has not been charged. Please try with alternative payment method.', 'woocommerce-gateway-stripe' ); |
||
| 439 | $stripe_params['no_sepa_owner_msg'] = __( 'Please enter your IBAN account name.', 'woocommerce-gateway-stripe' ); |
||
| 440 | $stripe_params['no_sepa_iban_msg'] = __( 'Please enter your IBAN account number.', 'woocommerce-gateway-stripe' ); |
||
| 441 | $stripe_params['payment_intent_error'] = __( 'We couldn\'t initiate the payment. Please try again.', 'woocommerce-gateway-stripe' ); |
||
| 442 | $stripe_params['sepa_mandate_notification'] = apply_filters( 'wc_stripe_sepa_mandate_notification', 'email' ); |
||
| 443 | $stripe_params['allow_prepaid_card'] = apply_filters( 'wc_stripe_allow_prepaid_card', true ) ? 'yes' : 'no'; |
||
| 444 | $stripe_params['inline_cc_form'] = $this->inline_cc_form ? 'yes' : 'no'; |
||
| 445 | $stripe_params['is_checkout'] = ( is_checkout() && empty( $_GET['pay_for_order'] ) ) ? 'yes' : 'no'; // wpcs: csrf ok. |
||
| 446 | $stripe_params['return_url'] = $this->get_stripe_return_url(); |
||
| 447 | $stripe_params['ajaxurl'] = WC_AJAX::get_endpoint( '%%endpoint%%' ); |
||
| 448 | $stripe_params['stripe_nonce'] = wp_create_nonce( '_wc_stripe_nonce' ); |
||
| 449 | $stripe_params['statement_descriptor'] = $this->statement_descriptor; |
||
| 450 | $stripe_params['elements_options'] = apply_filters( 'wc_stripe_elements_options', array() ); |
||
| 451 | $stripe_params['sepa_elements_options'] = $sepa_elements_options; |
||
| 452 | $stripe_params['invalid_owner_name'] = __( 'Billing First Name and Last Name are required.', 'woocommerce-gateway-stripe' ); |
||
| 453 | $stripe_params['is_change_payment_page'] = isset( $_GET['change_payment_method'] ) ? 'yes' : 'no'; // wpcs: csrf ok. |
||
| 454 | $stripe_params['is_add_payment_page'] = is_wc_endpoint_url( 'add-payment-method' ) ? 'yes' : 'no'; |
||
| 455 | $stripe_params['is_pay_for_order_page'] = is_wc_endpoint_url( 'order-pay' ) ? 'yes' : 'no'; |
||
| 456 | $stripe_params['elements_styling'] = apply_filters( 'wc_stripe_elements_styling', false ); |
||
| 457 | $stripe_params['elements_classes'] = apply_filters( 'wc_stripe_elements_classes', false ); |
||
| 458 | |||
| 459 | // Merge localized messages to be use in JS. |
||
| 460 | $stripe_params = array_merge( $stripe_params, WC_Stripe_Helper::get_localized_messages() ); |
||
| 461 | |||
| 462 | wp_localize_script( 'woocommerce_stripe', 'wc_stripe_params', apply_filters( 'wc_stripe_params', $stripe_params ) ); |
||
| 463 | |||
| 464 | $this->tokenization_script(); |
||
| 465 | wp_enqueue_script( 'woocommerce_stripe' ); |
||
| 466 | } |
||
| 467 | |||
| 468 | /** |
||
| 469 | * Checks if a source object represents a prepaid credit card and |
||
| 470 | * throws an exception if it is one, but that is not allowed. |
||
| 471 | * |
||
| 472 | * @since 4.2.0 |
||
| 473 | * @param object $prepared_source The object with source details. |
||
| 474 | * @throws WC_Stripe_Exception An exception if the card is prepaid, but prepaid cards are not allowed. |
||
| 475 | */ |
||
| 476 | public function maybe_disallow_prepaid_card( $prepared_source ) { |
||
| 477 | // Check if we don't allow prepaid credit cards. |
||
| 478 | if ( apply_filters( 'wc_stripe_allow_prepaid_card', true ) || ! $this->is_prepaid_card( $prepared_source->source_object ) ) { |
||
| 479 | return; |
||
| 480 | } |
||
| 481 | |||
| 482 | $localized_message = __( 'Sorry, we\'re not accepting prepaid cards at this time. Your credit card has not been charged. Please try with alternative payment method.', 'woocommerce-gateway-stripe' ); |
||
| 483 | throw new WC_Stripe_Exception( print_r( $prepared_source->source_object, true ), $localized_message ); |
||
| 484 | } |
||
| 485 | |||
| 486 | /** |
||
| 487 | * Checks whether a source exists. |
||
| 488 | * |
||
| 489 | * @since 4.2.0 |
||
| 490 | * @param object $prepared_source The source that should be verified. |
||
| 491 | * @throws WC_Stripe_Exception An exception if the source ID is missing. |
||
| 492 | */ |
||
| 493 | public function check_source( $prepared_source ) { |
||
| 494 | View Code Duplication | if ( empty( $prepared_source->source ) ) { |
|
| 495 | $localized_message = __( 'Payment processing failed. Please retry.', 'woocommerce-gateway-stripe' ); |
||
| 496 | throw new WC_Stripe_Exception( print_r( $prepared_source, true ), $localized_message ); |
||
| 497 | } |
||
| 498 | } |
||
| 499 | |||
| 500 | /** |
||
| 501 | * Customer param wrong? The user may have been deleted on stripe's end. Remove customer_id. Can be retried without. |
||
| 502 | * |
||
| 503 | * @since 4.2.0 |
||
| 504 | * @param object $error The error that was returned from Stripe's API. |
||
| 505 | * @param WC_Order $order The order those payment is being processed. |
||
| 506 | * @return bool A flag that indicates that the customer does not exist and should be removed. |
||
| 507 | */ |
||
| 508 | public function maybe_remove_non_existent_customer( $error, $order ) { |
||
| 509 | if ( ! $this->is_no_such_customer_error( $error ) ) { |
||
| 510 | return false; |
||
| 511 | } |
||
| 512 | |||
| 513 | delete_user_option( $order->get_customer_id(), '_stripe_customer_id' ); |
||
| 514 | $order->delete_meta_data( '_stripe_customer_id' ); |
||
| 515 | $order->save(); |
||
| 516 | |||
| 517 | return true; |
||
| 518 | } |
||
| 519 | |||
| 520 | /** |
||
| 521 | * Completes an order without a positive value. |
||
| 522 | * |
||
| 523 | * @since 4.2.0 |
||
| 524 | * @param WC_Order $order The order to complete. |
||
| 525 | * @param WC_Order $prepared_source Payment source and customer data. |
||
| 526 | * @param boolean $force_save_source Whether the payment source must be saved, like when dealing with a Subscription setup. |
||
| 527 | * @return array Redirection data for `process_payment`. |
||
| 528 | */ |
||
| 529 | public function complete_free_order( $order, $prepared_source, $force_save_source ) { |
||
| 530 | if ( $force_save_source ) { |
||
| 531 | $intent_secret = $this->setup_intent( $order, $prepared_source ); |
||
| 532 | |||
| 533 | if ( ! empty( $intent_secret ) ) { |
||
| 534 | // `get_return_url()` must be called immediately before returning a value. |
||
| 535 | return array( |
||
| 536 | 'result' => 'success', |
||
| 537 | 'redirect' => $this->get_return_url( $order ), |
||
| 538 | 'setup_intent_secret' => $intent_secret, |
||
| 539 | ); |
||
| 540 | } |
||
| 541 | } |
||
| 542 | |||
| 543 | // Remove cart. |
||
| 544 | WC()->cart->empty_cart(); |
||
| 545 | |||
| 546 | $order->payment_complete(); |
||
| 547 | |||
| 548 | // Return thank you page redirect. |
||
| 549 | return array( |
||
| 550 | 'result' => 'success', |
||
| 551 | 'redirect' => $this->get_return_url( $order ), |
||
| 552 | ); |
||
| 553 | } |
||
| 554 | |||
| 555 | /** |
||
| 556 | * Process the payment |
||
| 557 | * |
||
| 558 | * @since 1.0.0 |
||
| 559 | * @since 4.1.0 Add 4th parameter to track previous error. |
||
| 560 | * @param int $order_id Reference. |
||
| 561 | * @param bool $retry Should we retry on fail. |
||
| 562 | * @param bool $force_save_source Force save the payment source. |
||
| 563 | * @param mix $previous_error Any error message from previous request. |
||
| 564 | * @param bool $use_order_source Whether to use the source, which should already be attached to the order. |
||
| 565 | * |
||
| 566 | * @throws Exception If payment will not be accepted. |
||
| 567 | * @return array|void |
||
| 568 | */ |
||
| 569 | public function process_payment( $order_id, $retry = true, $force_save_source = false, $previous_error = false, $use_order_source = false ) { |
||
| 570 | try { |
||
| 571 | $order = wc_get_order( $order_id ); |
||
| 572 | |||
| 573 | // ToDo: `process_pre_order` saves the source to the order for a later payment. |
||
| 574 | // This might not work well with PaymentIntents. |
||
| 575 | if ( $this->maybe_process_pre_orders( $order_id ) ) { |
||
| 576 | return $this->pre_orders->process_pre_order( $order_id ); |
||
| 577 | } |
||
| 578 | |||
| 579 | // Check whether there is an existing intent. |
||
| 580 | $intent = $this->get_intent_from_order( $order ); |
||
| 581 | if ( isset( $intent->object ) && 'setup_intent' === $intent->object ) { |
||
| 582 | $intent = false; // This function can only deal with *payment* intents |
||
| 583 | } |
||
| 584 | |||
| 585 | $stripe_customer_id = null; |
||
| 586 | if ( $intent && ! empty( $intent->customer ) ) { |
||
| 587 | $stripe_customer_id = $intent->customer; |
||
| 588 | } |
||
| 589 | |||
| 590 | // For some payments the source should already be present in the order. |
||
| 591 | if ( $use_order_source ) { |
||
| 592 | $prepared_source = $this->prepare_order_source( $order ); |
||
| 593 | } else { |
||
| 594 | $prepared_source = $this->prepare_source( get_current_user_id(), $force_save_source, $stripe_customer_id ); |
||
| 595 | } |
||
| 596 | |||
| 597 | $this->maybe_disallow_prepaid_card( $prepared_source ); |
||
| 598 | $this->check_source( $prepared_source ); |
||
| 599 | $this->save_source_to_order( $order, $prepared_source ); |
||
| 600 | |||
| 601 | if ( 0 >= $order->get_total() ) { |
||
| 602 | return $this->complete_free_order( $order, $prepared_source, $force_save_source ); |
||
| 603 | } |
||
| 604 | |||
| 605 | // This will throw exception if not valid. |
||
| 606 | $this->validate_minimum_order_amount( $order ); |
||
| 607 | |||
| 608 | WC_Stripe_Logger::log( "Info: Begin processing payment for order $order_id for the amount of {$order->get_total()}" ); |
||
| 609 | |||
| 610 | if ( $intent ) { |
||
| 611 | $intent = $this->update_existing_intent( $intent, $order, $prepared_source ); |
||
| 612 | } else { |
||
| 613 | $intent = $this->create_intent( $order, $prepared_source ); |
||
| 614 | } |
||
| 615 | |||
| 616 | // Confirm the intent after locking the order to make sure webhooks will not interfere. |
||
| 617 | if ( empty( $intent->error ) ) { |
||
| 618 | $this->lock_order_payment( $order, $intent ); |
||
| 619 | $intent = $this->confirm_intent( $intent, $order, $prepared_source ); |
||
| 620 | } |
||
| 621 | |||
| 622 | if ( ! empty( $intent->error ) ) { |
||
| 623 | $this->maybe_remove_non_existent_customer( $intent->error, $order ); |
||
| 624 | |||
| 625 | // We want to retry. |
||
| 626 | if ( $this->is_retryable_error( $intent->error ) ) { |
||
| 627 | return $this->retry_after_error( $intent, $order, $retry, $force_save_source, $previous_error, $use_order_source ); |
||
| 628 | } |
||
| 629 | |||
| 630 | $this->unlock_order_payment( $order ); |
||
| 631 | $this->throw_localized_message( $intent, $order ); |
||
| 632 | } |
||
| 633 | |||
| 634 | if ( ! empty( $intent ) ) { |
||
| 635 | // Use the last charge within the intent to proceed. |
||
| 636 | $response = end( $intent->charges->data ); |
||
| 637 | |||
| 638 | // If the intent requires a 3DS flow, redirect to it. |
||
| 639 | if ( 'requires_action' === $intent->status ) { |
||
| 640 | $this->unlock_order_payment( $order ); |
||
| 641 | |||
| 642 | /** |
||
| 643 | * This URL contains only a hash, which will be sent to `checkout.js` where it will be set like this: |
||
| 644 | * `window.location = result.redirect` |
||
| 645 | * Once this redirect is sent to JS, the `onHashChange` function will execute `handleCardPayment`. |
||
| 646 | */ |
||
| 647 | |||
| 648 | return array( |
||
| 649 | 'result' => 'success', |
||
| 650 | 'redirect' => $this->get_return_url( $order ), |
||
| 651 | 'payment_intent_secret' => $intent->client_secret, |
||
| 652 | ); |
||
| 653 | } |
||
| 654 | } |
||
| 655 | |||
| 656 | // Process valid response. |
||
| 657 | $this->process_response( $response, $order ); |
||
| 658 | |||
| 659 | // Remove cart. |
||
| 660 | if ( isset( WC()->cart ) ) { |
||
| 661 | WC()->cart->empty_cart(); |
||
| 662 | } |
||
| 663 | |||
| 664 | // Unlock the order. |
||
| 665 | $this->unlock_order_payment( $order ); |
||
| 666 | |||
| 667 | // Return thank you page redirect. |
||
| 668 | return array( |
||
| 669 | 'result' => 'success', |
||
| 670 | 'redirect' => $this->get_return_url( $order ), |
||
| 671 | ); |
||
| 672 | |||
| 673 | } catch ( WC_Stripe_Exception $e ) { |
||
| 674 | wc_add_notice( $e->getLocalizedMessage(), 'error' ); |
||
| 675 | WC_Stripe_Logger::log( 'Error: ' . $e->getMessage() ); |
||
| 676 | |||
| 677 | do_action( 'wc_gateway_stripe_process_payment_error', $e, $order ); |
||
| 678 | |||
| 679 | /* translators: error message */ |
||
| 680 | $order->update_status( 'failed' ); |
||
| 681 | |||
| 682 | return array( |
||
| 683 | 'result' => 'fail', |
||
| 684 | 'redirect' => '', |
||
| 685 | ); |
||
| 686 | } |
||
| 687 | } |
||
| 688 | |||
| 689 | /** |
||
| 690 | * Displays the Stripe fee |
||
| 691 | * |
||
| 692 | * @since 4.1.0 |
||
| 693 | * |
||
| 694 | * @param int $order_id The ID of the order. |
||
| 695 | */ |
||
| 696 | View Code Duplication | public function display_order_fee( $order_id ) { |
|
| 725 | |||
| 726 | /** |
||
| 727 | * Displays the net total of the transaction without the charges of Stripe. |
||
| 728 | * |
||
| 729 | * @since 4.1.0 |
||
| 730 | * |
||
| 731 | * @param int $order_id The ID of the order. |
||
| 732 | */ |
||
| 733 | View Code Duplication | public function display_order_payout( $order_id ) { |
|
| 762 | |||
| 763 | /** |
||
| 764 | * Generates a localized message for an error from a response. |
||
| 765 | * |
||
| 766 | * @since 4.3.2 |
||
| 767 | * |
||
| 768 | * @param stdClass $response The response from the Stripe API. |
||
| 769 | * |
||
| 770 | * @return string The localized error message. |
||
| 771 | */ |
||
| 772 | public function get_localized_error_message_from_response( $response ) { |
||
| 773 | $localized_messages = WC_Stripe_Helper::get_localized_messages(); |
||
| 774 | |||
| 775 | if ( 'card_error' === $response->error->type ) { |
||
| 776 | $localized_message = isset( $localized_messages[ $response->error->code ] ) ? $localized_messages[ $response->error->code ] : $response->error->message; |
||
| 783 | |||
| 784 | /** |
||
| 785 | * Gets a localized message for an error from a response, adds it as a note to the order, and throws it. |
||
| 786 | * |
||
| 787 | * @since 4.2.0 |
||
| 788 | * @param stdClass $response The response from the Stripe API. |
||
| 789 | * @param WC_Order $order The order to add a note to. |
||
| 790 | * @throws WC_Stripe_Exception An exception with the right message. |
||
| 791 | */ |
||
| 792 | public function throw_localized_message( $response, $order ) { |
||
| 799 | |||
| 800 | /** |
||
| 801 | * Retries the payment process once an error occured. |
||
| 802 | * |
||
| 803 | * @since 4.2.0 |
||
| 804 | * @param object $response The response from the Stripe API. |
||
| 805 | * @param WC_Order $order An order that is being paid for. |
||
| 806 | * @param bool $retry A flag that indicates whether another retry should be attempted. |
||
| 807 | * @param bool $force_save_source Force save the payment source. |
||
| 808 | * @param mixed $previous_error Any error message from previous request. |
||
| 809 | * @param bool $use_order_source Whether to use the source, which should already be attached to the order. |
||
| 810 | * @throws WC_Stripe_Exception If the payment is not accepted. |
||
| 811 | * @return array|void |
||
| 812 | */ |
||
| 813 | public function retry_after_error( $response, $order, $retry, $force_save_source, $previous_error, $use_order_source ) { |
||
| 830 | |||
| 831 | /** |
||
| 832 | * Adds the necessary hooks to modify the "Pay for order" page in order to clean |
||
| 833 | * it up and prepare it for the Stripe PaymentIntents modal to confirm a payment. |
||
| 834 | * |
||
| 835 | * @since 4.2 |
||
| 836 | * @param WC_Payment_Gateway[] $gateways A list of all available gateways. |
||
| 837 | * @return WC_Payment_Gateway[] Either the same list or an empty one in the right conditions. |
||
| 838 | */ |
||
| 839 | public function prepare_order_pay_page( $gateways ) { |
||
| 859 | |||
| 860 | /** |
||
| 861 | * Changes the text of the "No available methods" message to one that indicates |
||
| 862 | * the need for a PaymentIntent to be confirmed. |
||
| 863 | * |
||
| 864 | * @since 4.2 |
||
| 865 | * @return string the new message. |
||
| 866 | */ |
||
| 867 | public function change_no_available_methods_message() { |
||
| 870 | |||
| 871 | /** |
||
| 872 | * Prepares the Payment Intent for it to be completed in the "Pay for Order" page. |
||
| 873 | * |
||
| 874 | * @param WC_Order|null $order Order object, or null to get the order from the "order-pay" URL parameter |
||
| 875 | * |
||
| 876 | * @throws WC_Stripe_Exception |
||
| 877 | * @since 4.3 |
||
| 878 | */ |
||
| 879 | public function prepare_intent_for_order_pay_page( $order = null ) { |
||
| 908 | |||
| 909 | /** |
||
| 910 | * Renders hidden inputs on the "Pay for Order" page in order to let Stripe handle PaymentIntents. |
||
| 911 | * |
||
| 912 | * @param WC_Order|null $order Order object, or null to get the order from the "order-pay" URL parameter |
||
| 913 | * |
||
| 914 | * @throws WC_Stripe_Exception |
||
| 915 | * @since 4.2 |
||
| 916 | */ |
||
| 917 | public function render_payment_intent_inputs( $order = null ) { |
||
| 938 | |||
| 939 | /** |
||
| 940 | * Adds an error message wrapper to each saved method. |
||
| 941 | * |
||
| 942 | * @since 4.2.0 |
||
| 943 | * @param WC_Payment_Token $token Payment Token. |
||
| 944 | * @return string Generated payment method HTML |
||
| 945 | */ |
||
| 946 | public function get_saved_payment_method_option_html( $token ) { |
||
| 952 | |||
| 953 | /** |
||
| 954 | * Attempt to manually complete the payment process for orders, which are still pending |
||
| 955 | * before displaying the View Order page. This is useful in case webhooks have not been set up. |
||
| 956 | * |
||
| 957 | * @since 4.2.0 |
||
| 958 | * @param int $order_id The ID that will be used for the thank you page. |
||
| 959 | */ |
||
| 960 | public function check_intent_status_on_order_page( $order_id ) { |
||
| 973 | |||
| 974 | /** |
||
| 975 | * Attached to `woocommerce_payment_successful_result` with a late priority, |
||
| 976 | * this method will combine the "naturally" generated redirect URL from |
||
| 977 | * WooCommerce and a payment/setup intent secret into a hash, which contains both |
||
| 978 | * the secret, and a proper URL, which will confirm whether the intent succeeded. |
||
| 979 | * |
||
| 980 | * @since 4.2.0 |
||
| 981 | * @param array $result The result from `process_payment`. |
||
| 982 | * @param int $order_id The ID of the order which is being paid for. |
||
| 983 | * @return array |
||
| 984 | */ |
||
| 985 | public function modify_successful_payment_result( $result, $order_id ) { |
||
| 1019 | |||
| 1020 | /** |
||
| 1021 | * Proceed with current request using new login session (to ensure consistent nonce). |
||
| 1022 | */ |
||
| 1023 | public function set_cookie_on_current_request( $cookie ) { |
||
| 1026 | |||
| 1027 | /** |
||
| 1028 | * Executed between the "Checkout" and "Thank you" pages, this |
||
| 1029 | * method updates orders based on the status of associated PaymentIntents. |
||
| 1030 | * |
||
| 1031 | * @since 4.2.0 |
||
| 1032 | * @param WC_Order $order The order which is in a transitional state. |
||
| 1033 | */ |
||
| 1034 | public function verify_intent_after_checkout( $order ) { |
||
| 1077 | |||
| 1078 | /** |
||
| 1079 | * Called after an intent verification succeeds, this allows |
||
| 1080 | * specific APNs or children of this class to modify its behavior. |
||
| 1081 | * |
||
| 1082 | * @param WC_Order $order The order whose verification succeeded. |
||
| 1083 | * @param stdClass $intent The Payment Intent object. |
||
| 1084 | */ |
||
| 1085 | protected function handle_intent_verification_success( $order, $intent ) { |
||
| 1088 | |||
| 1089 | /** |
||
| 1090 | * Called after an intent verification fails, this allows |
||
| 1091 | * specific APNs or children of this class to modify its behavior. |
||
| 1092 | * |
||
| 1093 | * @param WC_Order $order The order whose verification failed. |
||
| 1094 | * @param stdClass $intent The Payment Intent object. |
||
| 1095 | */ |
||
| 1096 | protected function handle_intent_verification_failure( $order, $intent ) { |
||
| 1099 | |||
| 1100 | /** |
||
| 1101 | * Checks if the payment intent associated with an order failed and records the event. |
||
| 1102 | * |
||
| 1103 | * @since 4.2.0 |
||
| 1104 | * @param WC_Order $order The order which should be checked. |
||
| 1105 | * @param object $intent The intent, associated with the order. |
||
| 1106 | */ |
||
| 1107 | public function failed_sca_auth( $order, $intent ) { |
||
| 1120 | |||
| 1121 | /** |
||
| 1122 | * Preserves the "wc-stripe-confirmation" URL parameter so the user can complete the SCA authentication after logging in. |
||
| 1123 | * |
||
| 1124 | * @param string $pay_url Current computed checkout URL for the given order. |
||
| 1125 | * @param WC_Order $order Order object. |
||
| 1126 | * |
||
| 1127 | * @return string Checkout URL for the given order. |
||
| 1128 | */ |
||
| 1129 | public function get_checkout_payment_url( $pay_url, $order ) { |
||
| 1136 | |||
| 1137 | /** |
||
| 1138 | * Checks whether new keys are being entered when saving options. |
||
| 1139 | */ |
||
| 1140 | public function process_admin_options() { |
||
| 1170 | |||
| 1171 | View Code Duplication | public function validate_publishable_key_field( $key, $value ) { |
|
| 1178 | |||
| 1179 | View Code Duplication | public function validate_secret_key_field( $key, $value ) { |
|
| 1186 | |||
| 1187 | View Code Duplication | public function validate_test_publishable_key_field( $key, $value ) { |
|
| 1194 | |||
| 1195 | View Code Duplication | public function validate_test_secret_key_field( $key, $value ) { |
|
| 1202 | } |
||
| 1203 |
Loading history...
This check looks for assignments to scalar types that may be of the wrong type.
To ensure the code behaves as expected, it may be a good idea to add an explicit type cast.