Completed
Push — master ( a0c464...2c2ec3 )
by Roy
92:26
created

WC_Stripe::capture_payment()   C

Complexity

Conditions 7
Paths 5

Size

Total Lines 30
Code Lines 19

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 30
rs 6.7272
c 0
b 0
f 0
cc 7
eloc 19
nc 5
nop 1
1
<?php
2
/*
3
 * Plugin Name: WooCommerce Stripe Gateway
4
 * Plugin URI: https://wordpress.org/plugins/woocommerce-gateway-stripe/
5
 * Description: Take credit card payments on your store using Stripe.
6
 * Author: Automattic
7
 * Author URI: https://woocommerce.com/
8
 * Version: 3.0.5
9
 * Text Domain: woocommerce-gateway-stripe
10
 * Domain Path: /languages
11
 *
12
 * Copyright (c) 2016 Automattic
13
 *
14
 * This program is free software: you can redistribute it and/or modify
15
 * it under the terms of the GNU General Public License as published by
16
 * the Free Software Foundation, either version 3 of the License, or
17
 * (at your option) any later version.
18
 *
19
 * This program is distributed in the hope that it will be useful,
20
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22
 * GNU General Public License for more details.
23
 *
24
 * You should have received a copy of the GNU General Public License
25
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
26
*/
27
28
if ( ! defined( 'ABSPATH' ) ) {
29
	exit;
30
}
31
32
/**
33
 * Required minimums and constants
34
 */
35
define( 'WC_STRIPE_VERSION', '3.0.5' );
36
define( 'WC_STRIPE_MIN_PHP_VER', '5.3.0' );
37
define( 'WC_STRIPE_MIN_WC_VER', '2.5.0' );
38
define( 'WC_STRIPE_MAIN_FILE', __FILE__ );
39
define( 'WC_STRIPE_PLUGIN_URL', untrailingslashit( plugins_url( basename( plugin_dir_path( __FILE__ ) ), basename( __FILE__ ) ) ) );
40
41
if ( ! class_exists( 'WC_Stripe' ) ) :
42
43
class WC_Stripe {
44
45
	/**
46
	 * @var Singleton The reference the *Singleton* instance of this class
47
	 */
48
	private static $instance;
49
50
	/**
51
	 * @var Reference to logging class.
52
	 */
53
	private static $log;
54
55
	/**
56
	 * Returns the *Singleton* instance of this class.
57
	 *
58
	 * @return Singleton The *Singleton* instance.
59
	 */
60
	public static function get_instance() {
61
		if ( null === self::$instance ) {
62
			self::$instance = new self();
0 ignored issues
show
Documentation Bug introduced by
It seems like new self() of type object<WC_Stripe> is incompatible with the declared type object<Singleton> of property $instance.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
63
		}
64
		return self::$instance;
0 ignored issues
show
Bug Compatibility introduced by
The expression self::$instance; of type WC_Stripe|Singleton adds the type WC_Stripe to the return on line 64 which is incompatible with the return type documented by WC_Stripe::get_instance of type Singleton.
Loading history...
65
	}
66
67
	/**
68
	 * Private clone method to prevent cloning of the instance of the
69
	 * *Singleton* instance.
70
	 *
71
	 * @return void
72
	 */
73
	private function __clone() {}
74
75
	/**
76
	 * Private unserialize method to prevent unserializing of the *Singleton*
77
	 * instance.
78
	 *
79
	 * @return void
80
	 */
81
	private function __wakeup() {}
82
83
	/**
84
	 * Flag to indicate whether or not we need to load code for / support subscriptions.
85
	 *
86
	 * @var bool
87
	 */
88
	private $subscription_support_enabled = false;
89
90
	/**
91
	 * Flag to indicate whether or not we need to load support for pre-orders.
92
	 *
93
	 * @since 3.0.3
94
	 *
95
	 * @var bool
96
	 */
97
	private $pre_order_enabled = false;
98
99
	/**
100
	 * Notices (array)
101
	 * @var array
102
	 */
103
	public $notices = array();
104
105
	/**
106
	 * Protected constructor to prevent creating a new instance of the
107
	 * *Singleton* via the `new` operator from outside of this class.
108
	 */
109
	protected function __construct() {
110
		add_action( 'admin_init', array( $this, 'check_environment' ) );
111
		add_action( 'admin_notices', array( $this, 'admin_notices' ), 15 );
112
		add_action( 'plugins_loaded', array( $this, 'init' ) );
113
	}
114
115
	/**
116
	 * Init the plugin after plugins_loaded so environment variables are set.
117
	 */
118
	public function init() {
119
		// Don't hook anything else in the plugin if we're in an incompatible environment
120
		if ( self::get_environment_warning() ) {
121
			return;
122
		}
123
124
		include_once( dirname( __FILE__ ) . '/includes/class-wc-stripe-api.php' );
125
		include_once( dirname( __FILE__ ) . '/includes/class-wc-stripe-customer.php' );
126
127
		// Init the gateway itself
128
		$this->init_gateways();
129
130
		add_filter( 'plugin_action_links_' . plugin_basename( __FILE__ ), array( $this, 'plugin_action_links' ) );
131
		add_action( 'woocommerce_order_status_on-hold_to_processing', array( $this, 'capture_payment' ) );
132
		add_action( 'woocommerce_order_status_on-hold_to_completed', array( $this, 'capture_payment' ) );
133
		add_action( 'woocommerce_order_status_on-hold_to_cancelled', array( $this, 'cancel_payment' ) );
134
		add_action( 'woocommerce_order_status_on-hold_to_refunded', array( $this, 'cancel_payment' ) );
135
		add_filter( 'woocommerce_get_customer_payment_tokens', array( $this, 'woocommerce_get_customer_payment_tokens' ), 10, 3 );
136
		add_action( 'woocommerce_payment_token_deleted', array( $this, 'woocommerce_payment_token_deleted' ), 10, 2 );
137
		add_action( 'woocommerce_payment_token_set_default', array( $this, 'woocommerce_payment_token_set_default' ) );
138
	}
139
140
	/**
141
	 * Allow this class and other classes to add slug keyed notices (to avoid duplication)
142
	 */
143
	public function add_admin_notice( $slug, $class, $message ) {
144
		$this->notices[ $slug ] = array(
145
			'class'   => $class,
146
			'message' => $message
147
		);
148
	}
149
150
	/**
151
	 * The backup sanity check, in case the plugin is activated in a weird way,
152
	 * or the environment changes after activation.
153
	 */
154
	public function check_environment() {
155
		$environment_warning = self::get_environment_warning();
156
157
		if ( $environment_warning && is_plugin_active( plugin_basename( __FILE__ ) ) ) {
158
			$this->add_admin_notice( 'bad_environment', 'error', $environment_warning );
159
		}
160
161
		// Check if secret key present. Otherwise prompt, via notice, to go to
162
		// setting.
163
		if ( ! class_exists( 'WC_Stripe_API' ) ) {
164
			include_once( dirname( __FILE__ ) . '/includes/class-wc-stripe-api.php' );
165
		}
166
167
		$secret = WC_Stripe_API::get_secret_key();
168
169
		if ( empty( $secret ) && ! ( isset( $_GET['page'], $_GET['section'] ) && 'wc-settings' === $_GET['page'] && 'stripe' === $_GET['section'] ) ) {
170
			$setting_link = $this->get_setting_link();
171
			$this->add_admin_notice( 'prompt_connect', 'notice notice-warning', sprintf( __( 'Stripe is almost ready. To get started, <a href="%s">set your Stripe account keys</a>.', 'woocommerce-gateway-stripe' ), $setting_link ) );
172
		}
173
	}
174
175
	/**
176
	 * Checks the environment for compatibility problems.  Returns a string with the first incompatibility
177
	 * found or false if the environment has no problems.
178
	 */
179
	static function get_environment_warning() {
0 ignored issues
show
Best Practice introduced by
It is generally recommended to explicitly declare the visibility for methods.

Adding explicit visibility (private, protected, or public) is generally recommend to communicate to other developers how, and from where this method is intended to be used.

Loading history...
180 View Code Duplication
		if ( version_compare( phpversion(), WC_STRIPE_MIN_PHP_VER, '<' ) ) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
181
			$message = __( 'WooCommerce Stripe - The minimum PHP version required for this plugin is %1$s. You are running %2$s.', 'woocommerce-gateway-stripe', 'woocommerce-gateway-stripe' );
182
183
			return sprintf( $message, WC_STRIPE_MIN_PHP_VER, phpversion() );
184
		}
185
		
186
		if ( ! defined( 'WC_VERSION' ) ) {
187
			return __( 'WooCommerce Stripe requires WooCommerce to be activated to work.', 'woocommerce-gateway-stripe' );
188
		} 
189
190 View Code Duplication
		if ( version_compare( WC_VERSION, WC_STRIPE_MIN_WC_VER, '<' ) ) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
191
			$message = __( 'WooCommerce Stripe - The minimum WooCommerce version required for this plugin is %1$s. You are running %2$s.', 'woocommerce-gateway-stripe', 'woocommerce-gateway-stripe' );
192
193
			return sprintf( $message, WC_STRIPE_MIN_WC_VER, WC_VERSION );
194
		}
195
196
		if ( ! function_exists( 'curl_init' ) ) {
197
			return __( 'WooCommerce Stripe - cURL is not installed.', 'woocommerce-gateway-stripe' );
198
		}
199
200
		return false;
201
	}
202
203
	/**
204
	 * Adds plugin action links
205
	 *
206
	 * @since 1.0.0
207
	 */
208
	public function plugin_action_links( $links ) {
209
		$setting_link = $this->get_setting_link();
210
211
		$plugin_links = array(
212
			'<a href="' . $setting_link . '">' . __( 'Settings', 'woocommerce-gateway-stripe' ) . '</a>',
213
			'<a href="https://docs.woothemes.com/document/stripe/">' . __( 'Docs', 'woocommerce-gateway-stripe' ) . '</a>',
214
			'<a href="http://support.woothemes.com/">' . __( 'Support', 'woocommerce-gateway-stripe' ) . '</a>',
215
		);
216
		return array_merge( $plugin_links, $links );
217
	}
218
219
	/**
220
	 * Get setting link.
221
	 *
222
	 * @since 1.0.0
223
	 *
224
	 * @return string Setting link
225
	 */
226
	public function get_setting_link() {
227
		$use_id_as_section = version_compare( WC()->version, '2.6', '>=' );
228
229
		$section_slug = $use_id_as_section ? 'stripe' : strtolower( 'WC_Gateway_Stripe' );
230
231
		return admin_url( 'admin.php?page=wc-settings&tab=checkout&section=' . $section_slug );
232
	}
233
234
	/**
235
	 * Display any notices we've collected thus far (e.g. for connection, disconnection)
236
	 */
237
	public function admin_notices() {
238
		foreach ( (array) $this->notices as $notice_key => $notice ) {
239
			echo "<div class='" . esc_attr( $notice['class'] ) . "'><p>";
240
			echo wp_kses( $notice['message'], array( 'a' => array( 'href' => array() ) ) );
241
			echo "</p></div>";
242
		}
243
	}
244
245
	/**
246
	 * Initialize the gateway. Called very early - in the context of the plugins_loaded action
247
	 *
248
	 * @since 1.0.0
249
	 */
250
	public function init_gateways() {
251
		if ( class_exists( 'WC_Subscriptions_Order' ) && function_exists( 'wcs_create_renewal_order' ) ) {
252
			$this->subscription_support_enabled = true;
253
		}
254
255
		if ( class_exists( 'WC_Pre_Orders_Order' ) ) {
256
			$this->pre_order_enabled = true;
257
		}
258
259
		if ( ! class_exists( 'WC_Payment_Gateway' ) ) {
260
			return;
261
		}
262
263
		if ( class_exists( 'WC_Payment_Gateway_CC' ) ) {
264
			include_once( dirname( __FILE__ ) . '/includes/class-wc-gateway-stripe.php' );
265
		} else {
266
			include_once( dirname( __FILE__ ) . '/includes/legacy/class-wc-gateway-stripe.php' );
267
			include_once( dirname( __FILE__ ) . '/includes/legacy/class-wc-gateway-stripe-saved-cards.php' );
268
		}
269
270
		load_plugin_textdomain( 'woocommerce-gateway-stripe', false, plugin_basename( dirname( __FILE__ ) ) . '/languages' );
271
		add_filter( 'woocommerce_payment_gateways', array( $this, 'add_gateways' ) );
272
273
		$load_addons = (
274
			$this->subscription_support_enabled
275
			||
276
			$this->pre_order_enabled
277
		);
278
279
		if ( $load_addons ) {
280
			require_once( dirname( __FILE__ ) . '/includes/class-wc-gateway-stripe-addons.php' );
281
		}
282
	}
283
284
	/**
285
	 * Add the gateways to WooCommerce
286
	 *
287
	 * @since 1.0.0
288
	 */
289
	public function add_gateways( $methods ) {
290
		if ( $this->subscription_support_enabled || $this->pre_order_enabled ) {
291
			$methods[] = 'WC_Gateway_Stripe_Addons';
292
		} else {
293
			$methods[] = 'WC_Gateway_Stripe';
294
		}
295
		return $methods;
296
	}
297
298
	/**
299
	 * Capture payment when the order is changed from on-hold to complete or processing
300
	 *
301
	 * @param  int $order_id
302
	 */
303
	public function capture_payment( $order_id ) {
304
		$order = wc_get_order( $order_id );
305
306
		if ( 'stripe' === $order->payment_method ) {
307
			$charge   = get_post_meta( $order_id, '_stripe_charge_id', true );
308
			$captured = get_post_meta( $order_id, '_stripe_charge_captured', true );
309
310
			if ( $charge && 'no' === $captured ) {
311
				$result = WC_Stripe_API::request( array(
312
					'amount'   => $order->get_total() * 100,
313
					'expand[]' => 'balance_transaction'
314
				), 'charges/' . $charge . '/capture' );
315
316
				if ( is_wp_error( $result ) ) {
317
					$order->add_order_note( __( 'Unable to capture charge!', 'woocommerce-gateway-stripe' ) . ' ' . $result->get_error_message() );
318
				} else {
319
					$order->add_order_note( sprintf( __( 'Stripe charge complete (Charge ID: %s)', 'woocommerce-gateway-stripe' ), $result->id ) );
320
					update_post_meta( $order->id, '_stripe_charge_captured', 'yes' );
321
322
					// Store other data such as fees
323
					update_post_meta( $order->id, 'Stripe Payment ID', $result->id );
324
325
					if ( isset( $result->balance_transaction ) && isset( $result->balance_transaction->fee ) ) {
326
						update_post_meta( $order->id, 'Stripe Fee', number_format( $result->balance_transaction->fee / 100, 2, '.', '' ) );
327
						update_post_meta( $order->id, 'Net Revenue From Stripe', ( $order->order_total - number_format( $result->balance_transaction->fee / 100, 2, '.', '' ) ) );
328
					}
329
				}
330
			}
331
		}
332
	}
333
334
	/**
335
	 * Cancel pre-auth on refund/cancellation
336
	 *
337
	 * @param  int $order_id
338
	 */
339
	public function cancel_payment( $order_id ) {
340
		$order = wc_get_order( $order_id );
341
342
		if ( 'stripe' === $order->payment_method ) {
343
			$charge   = get_post_meta( $order_id, '_stripe_charge_id', true );
344
345
			if ( $charge ) {
346
				$result = WC_Stripe_API::request( array(
347
					'amount' => $order->get_total() * 100,
348
				), 'charges/' . $charge . '/refund' );
349
350
				if ( is_wp_error( $result ) ) {
351
					$order->add_order_note( __( 'Unable to refund charge!', 'woocommerce-gateway-stripe' ) . ' ' . $result->get_error_message() );
352
				} else {
353
					$order->add_order_note( sprintf( __( 'Stripe charge refunded (Charge ID: %s)', 'woocommerce-gateway-stripe' ), $result->id ) );
354
					delete_post_meta( $order->id, '_stripe_charge_captured' );
355
					delete_post_meta( $order->id, '_stripe_charge_id' );
356
				}
357
			}
358
		}
359
	}
360
361
	/**
362
	 * Gets saved tokens from API if they don't already exist in WooCommerce.
363
	 * @param array $tokens
364
	 * @return array
365
	 */
366
	public function woocommerce_get_customer_payment_tokens( $tokens, $customer_id, $gateway_id ) {
367
		if ( is_user_logged_in() && 'stripe' === $gateway_id && class_exists( 'WC_Payment_Token_CC' ) ) {
368
			$stripe_customer = new WC_Stripe_Customer( $customer_id );
369
			$stripe_cards    = $stripe_customer->get_cards();
370
			$stored_tokens   = array();
371
372
			foreach ( $tokens as $token ) {
373
				$stored_tokens[] = $token->get_token();
374
			}
375
376
			foreach ( $stripe_cards as $card ) {
377
				if ( ! in_array( $card->id, $stored_tokens ) ) {
378
					$token = new WC_Payment_Token_CC();
379
					$token->set_token( $card->id );
380
					$token->set_gateway_id( 'stripe' );
381
					$token->set_card_type( strtolower( $card->brand ) );
382
					$token->set_last4( $card->last4 );
383
					$token->set_expiry_month( $card->exp_month  );
384
					$token->set_expiry_year( $card->exp_year );
385
					$token->set_user_id( $customer_id );
386
					$token->save();
387
					$tokens[ $token->get_id() ] = $token;
388
				}
389
			}
390
		}
391
		return $tokens;
392
	}
393
394
	/**
395
	 * Delete token from Stripe
396
	 */
397
	public function woocommerce_payment_token_deleted( $token_id, $token ) {
398
		if ( 'stripe' === $token->get_gateway_id() ) {
399
			$stripe_customer = new WC_Stripe_Customer( get_current_user_id() );
400
			$stripe_customer->delete_card( $token->get_token() );
401
		}
402
	}
403
404
	/**
405
	 * Set as default in Stripe
406
	 */
407
	public function woocommerce_payment_token_set_default( $token_id ) {
408
		$token = WC_Payment_Tokens::get( $token_id );
409
		if ( 'stripe' === $token->get_gateway_id() ) {
410
			$stripe_customer = new WC_Stripe_Customer( get_current_user_id() );
411
			$stripe_customer->set_default_card( $token->get_token() );
412
		}
413
	}
414
415
	/**
416
	 * What rolls down stairs
417
	 * alone or in pairs,
418
	 * and over your neighbor's dog?
419
	 * What's great for a snack,
420
	 * And fits on your back?
421
	 * It's log, log, log
422
	 */
423
	public static function log( $message ) {
424
		if ( empty( self::$log ) ) {
425
			self::$log = new WC_Logger();
0 ignored issues
show
Documentation Bug introduced by
It seems like new \WC_Logger() of type object<WC_Logger> is incompatible with the declared type object<Reference> of property $log.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
426
		}
427
428
		self::$log->add( 'woocommerce-gateway-stripe', $message );
429
430
		if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
431
			error_log( $message );
432
		}
433
	}
434
}
435
436
$GLOBALS['wc_stripe'] = WC_Stripe::get_instance();
437
438
endif;
439