woocommerce-gateway-stripe.php
14.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
<?php
/*
* Plugin Name: WooCommerce Stripe Gateway
* Plugin URI: https://wordpress.org/plugins/woocommerce-gateway-stripe/
* Description: Take credit card payments on your store using Stripe.
* Author: Automattic
* Author URI: https://woocommerce.com/
* Version: 3.0.6
* Text Domain: woocommerce-gateway-stripe
* Domain Path: /languages
*
* Copyright (c) 2016 Automattic
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* Required minimums and constants
*/
define( 'WC_STRIPE_VERSION', '3.0.6' );
define( 'WC_STRIPE_MIN_PHP_VER', '5.3.0' );
define( 'WC_STRIPE_MIN_WC_VER', '2.5.0' );
define( 'WC_STRIPE_MAIN_FILE', __FILE__ );
define( 'WC_STRIPE_PLUGIN_URL', untrailingslashit( plugins_url( basename( plugin_dir_path( __FILE__ ) ), basename( __FILE__ ) ) ) );
if ( ! class_exists( 'WC_Stripe' ) ) :
class WC_Stripe {
/**
* @var Singleton The reference the *Singleton* instance of this class
*/
private static $instance;
/**
* @var Reference to logging class.
*/
private static $log;
/**
* Returns the *Singleton* instance of this class.
*
* @return Singleton The *Singleton* instance.
*/
public static function get_instance() {
if ( null === self::$instance ) {
self::$instance = new self();
}
return self::$instance;
}
/**
* Private clone method to prevent cloning of the instance of the
* *Singleton* instance.
*
* @return void
*/
private function __clone() {}
/**
* Private unserialize method to prevent unserializing of the *Singleton*
* instance.
*
* @return void
*/
private function __wakeup() {}
/**
* Flag to indicate whether or not we need to load code for / support subscriptions.
*
* @var bool
*/
private $subscription_support_enabled = false;
/**
* Flag to indicate whether or not we need to load support for pre-orders.
*
* @since 3.0.3
*
* @var bool
*/
private $pre_order_enabled = false;
/**
* Notices (array)
* @var array
*/
public $notices = array();
/**
* Protected constructor to prevent creating a new instance of the
* *Singleton* via the `new` operator from outside of this class.
*/
protected function __construct() {
add_action( 'admin_init', array( $this, 'check_environment' ) );
add_action( 'admin_notices', array( $this, 'admin_notices' ), 15 );
add_action( 'plugins_loaded', array( $this, 'init' ) );
}
/**
* Init the plugin after plugins_loaded so environment variables are set.
*/
public function init() {
// Don't hook anything else in the plugin if we're in an incompatible environment
if ( self::get_environment_warning() ) {
return;
}
include_once( dirname( __FILE__ ) . '/includes/class-wc-stripe-api.php' );
include_once( dirname( __FILE__ ) . '/includes/class-wc-stripe-customer.php' );
// Init the gateway itself
$this->init_gateways();
add_filter( 'plugin_action_links_' . plugin_basename( __FILE__ ), array( $this, 'plugin_action_links' ) );
add_action( 'woocommerce_order_status_on-hold_to_processing', array( $this, 'capture_payment' ) );
add_action( 'woocommerce_order_status_on-hold_to_completed', array( $this, 'capture_payment' ) );
add_action( 'woocommerce_order_status_on-hold_to_cancelled', array( $this, 'cancel_payment' ) );
add_action( 'woocommerce_order_status_on-hold_to_refunded', array( $this, 'cancel_payment' ) );
add_filter( 'woocommerce_get_customer_payment_tokens', array( $this, 'woocommerce_get_customer_payment_tokens' ), 10, 3 );
add_action( 'woocommerce_payment_token_deleted', array( $this, 'woocommerce_payment_token_deleted' ), 10, 2 );
add_action( 'woocommerce_payment_token_set_default', array( $this, 'woocommerce_payment_token_set_default' ) );
}
/**
* Allow this class and other classes to add slug keyed notices (to avoid duplication)
*/
public function add_admin_notice( $slug, $class, $message ) {
$this->notices[ $slug ] = array(
'class' => $class,
'message' => $message
);
}
/**
* The backup sanity check, in case the plugin is activated in a weird way,
* or the environment changes after activation.
*/
public function check_environment() {
$environment_warning = self::get_environment_warning();
if ( $environment_warning && is_plugin_active( plugin_basename( __FILE__ ) ) ) {
$this->add_admin_notice( 'bad_environment', 'error', $environment_warning );
}
// Check if secret key present. Otherwise prompt, via notice, to go to
// setting.
if ( ! class_exists( 'WC_Stripe_API' ) ) {
include_once( dirname( __FILE__ ) . '/includes/class-wc-stripe-api.php' );
}
$secret = WC_Stripe_API::get_secret_key();
if ( empty( $secret ) && ! ( isset( $_GET['page'], $_GET['section'] ) && 'wc-settings' === $_GET['page'] && 'stripe' === $_GET['section'] ) ) {
$setting_link = $this->get_setting_link();
$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 ) );
}
}
/**
* Checks the environment for compatibility problems. Returns a string with the first incompatibility
* found or false if the environment has no problems.
*/
static function get_environment_warning() {
if ( version_compare( phpversion(), WC_STRIPE_MIN_PHP_VER, '<' ) ) {
$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' );
return sprintf( $message, WC_STRIPE_MIN_PHP_VER, phpversion() );
}
if ( ! defined( 'WC_VERSION' ) ) {
return __( 'WooCommerce Stripe requires WooCommerce to be activated to work.', 'woocommerce-gateway-stripe' );
}
if ( version_compare( WC_VERSION, WC_STRIPE_MIN_WC_VER, '<' ) ) {
$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' );
return sprintf( $message, WC_STRIPE_MIN_WC_VER, WC_VERSION );
}
if ( ! function_exists( 'curl_init' ) ) {
return __( 'WooCommerce Stripe - cURL is not installed.', 'woocommerce-gateway-stripe' );
}
return false;
}
/**
* Adds plugin action links
*
* @since 1.0.0
*/
public function plugin_action_links( $links ) {
$setting_link = $this->get_setting_link();
$plugin_links = array(
'<a href="' . $setting_link . '">' . __( 'Settings', 'woocommerce-gateway-stripe' ) . '</a>',
'<a href="https://docs.woothemes.com/document/stripe/">' . __( 'Docs', 'woocommerce-gateway-stripe' ) . '</a>',
'<a href="http://support.woothemes.com/">' . __( 'Support', 'woocommerce-gateway-stripe' ) . '</a>',
);
return array_merge( $plugin_links, $links );
}
/**
* Get setting link.
*
* @since 1.0.0
*
* @return string Setting link
*/
public function get_setting_link() {
$use_id_as_section = version_compare( WC()->version, '2.6', '>=' );
$section_slug = $use_id_as_section ? 'stripe' : strtolower( 'WC_Gateway_Stripe' );
return admin_url( 'admin.php?page=wc-settings&tab=checkout§ion=' . $section_slug );
}
/**
* Display any notices we've collected thus far (e.g. for connection, disconnection)
*/
public function admin_notices() {
foreach ( (array) $this->notices as $notice_key => $notice ) {
echo "<div class='" . esc_attr( $notice['class'] ) . "'><p>";
echo wp_kses( $notice['message'], array( 'a' => array( 'href' => array() ) ) );
echo "</p></div>";
}
}
/**
* Initialize the gateway. Called very early - in the context of the plugins_loaded action
*
* @since 1.0.0
*/
public function init_gateways() {
if ( class_exists( 'WC_Subscriptions_Order' ) && function_exists( 'wcs_create_renewal_order' ) ) {
$this->subscription_support_enabled = true;
}
if ( class_exists( 'WC_Pre_Orders_Order' ) ) {
$this->pre_order_enabled = true;
}
if ( ! class_exists( 'WC_Payment_Gateway' ) ) {
return;
}
if ( class_exists( 'WC_Payment_Gateway_CC' ) ) {
include_once( dirname( __FILE__ ) . '/includes/class-wc-gateway-stripe.php' );
} else {
include_once( dirname( __FILE__ ) . '/includes/legacy/class-wc-gateway-stripe.php' );
include_once( dirname( __FILE__ ) . '/includes/legacy/class-wc-gateway-stripe-saved-cards.php' );
}
load_plugin_textdomain( 'woocommerce-gateway-stripe', false, plugin_basename( dirname( __FILE__ ) ) . '/languages' );
add_filter( 'woocommerce_payment_gateways', array( $this, 'add_gateways' ) );
$load_addons = (
$this->subscription_support_enabled
||
$this->pre_order_enabled
);
if ( $load_addons ) {
require_once( dirname( __FILE__ ) . '/includes/class-wc-gateway-stripe-addons.php' );
}
}
/**
* Add the gateways to WooCommerce
*
* @since 1.0.0
*/
public function add_gateways( $methods ) {
if ( $this->subscription_support_enabled || $this->pre_order_enabled ) {
$methods[] = 'WC_Gateway_Stripe_Addons';
} else {
$methods[] = 'WC_Gateway_Stripe';
}
return $methods;
}
/**
* Capture payment when the order is changed from on-hold to complete or processing
*
* @param int $order_id
*/
public function capture_payment( $order_id ) {
$order = wc_get_order( $order_id );
if ( 'stripe' === $order->payment_method ) {
$charge = get_post_meta( $order_id, '_stripe_charge_id', true );
$captured = get_post_meta( $order_id, '_stripe_charge_captured', true );
if ( $charge && 'no' === $captured ) {
$result = WC_Stripe_API::request( array(
'amount' => $order->get_total() * 100,
'expand[]' => 'balance_transaction'
), 'charges/' . $charge . '/capture' );
if ( is_wp_error( $result ) ) {
$order->add_order_note( __( 'Unable to capture charge!', 'woocommerce-gateway-stripe' ) . ' ' . $result->get_error_message() );
} else {
$order->add_order_note( sprintf( __( 'Stripe charge complete (Charge ID: %s)', 'woocommerce-gateway-stripe' ), $result->id ) );
update_post_meta( $order->id, '_stripe_charge_captured', 'yes' );
// Store other data such as fees
update_post_meta( $order->id, 'Stripe Payment ID', $result->id );
if ( isset( $result->balance_transaction ) && isset( $result->balance_transaction->fee ) ) {
// Fees and Net needs to both come from Stripe to be accurate as the returned
// values are in the local currency of the Stripe account, not from WC.
$fee = ! empty( $result->balance_transaction->fee ) ? number_format( $result->balance_transaction->fee / 100, 2, '.', '' ) : 0;
$net = ! empty( $result->balance_transaction->net ) ? number_format( $result->balance_transaction->net / 100, 2, '.', '' ) : 0;
update_post_meta( $order->id, 'Stripe Fee', $fee );
update_post_meta( $order->id, 'Net Revenue From Stripe', $net );
}
}
}
}
}
/**
* Cancel pre-auth on refund/cancellation
*
* @param int $order_id
*/
public function cancel_payment( $order_id ) {
$order = wc_get_order( $order_id );
if ( 'stripe' === $order->payment_method ) {
$charge = get_post_meta( $order_id, '_stripe_charge_id', true );
if ( $charge ) {
$result = WC_Stripe_API::request( array(
'amount' => $order->get_total() * 100,
), 'charges/' . $charge . '/refund' );
if ( is_wp_error( $result ) ) {
$order->add_order_note( __( 'Unable to refund charge!', 'woocommerce-gateway-stripe' ) . ' ' . $result->get_error_message() );
} else {
$order->add_order_note( sprintf( __( 'Stripe charge refunded (Charge ID: %s)', 'woocommerce-gateway-stripe' ), $result->id ) );
delete_post_meta( $order->id, '_stripe_charge_captured' );
delete_post_meta( $order->id, '_stripe_charge_id' );
}
}
}
}
/**
* Gets saved tokens from API if they don't already exist in WooCommerce.
* @param array $tokens
* @return array
*/
public function woocommerce_get_customer_payment_tokens( $tokens, $customer_id, $gateway_id ) {
if ( is_user_logged_in() && 'stripe' === $gateway_id && class_exists( 'WC_Payment_Token_CC' ) ) {
$stripe_customer = new WC_Stripe_Customer( $customer_id );
$stripe_cards = $stripe_customer->get_cards();
$stored_tokens = array();
foreach ( $tokens as $token ) {
$stored_tokens[] = $token->get_token();
}
foreach ( $stripe_cards as $card ) {
if ( ! in_array( $card->id, $stored_tokens ) ) {
$token = new WC_Payment_Token_CC();
$token->set_token( $card->id );
$token->set_gateway_id( 'stripe' );
$token->set_card_type( strtolower( $card->brand ) );
$token->set_last4( $card->last4 );
$token->set_expiry_month( $card->exp_month );
$token->set_expiry_year( $card->exp_year );
$token->set_user_id( $customer_id );
$token->save();
$tokens[ $token->get_id() ] = $token;
}
}
}
return $tokens;
}
/**
* Delete token from Stripe
*/
public function woocommerce_payment_token_deleted( $token_id, $token ) {
if ( 'stripe' === $token->get_gateway_id() ) {
$stripe_customer = new WC_Stripe_Customer( get_current_user_id() );
$stripe_customer->delete_card( $token->get_token() );
}
}
/**
* Set as default in Stripe
*/
public function woocommerce_payment_token_set_default( $token_id ) {
$token = WC_Payment_Tokens::get( $token_id );
if ( 'stripe' === $token->get_gateway_id() ) {
$stripe_customer = new WC_Stripe_Customer( get_current_user_id() );
$stripe_customer->set_default_card( $token->get_token() );
}
}
/**
* What rolls down stairs
* alone or in pairs,
* and over your neighbor's dog?
* What's great for a snack,
* And fits on your back?
* It's log, log, log
*/
public static function log( $message ) {
if ( empty( self::$log ) ) {
self::$log = new WC_Logger();
}
self::$log->add( 'woocommerce-gateway-stripe', $message );
if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
error_log( $message );
}
}
}
$GLOBALS['wc_stripe'] = WC_Stripe::get_instance();
endif;