Completed
Push — master ( 5958ce...840d41 )
by Marcin
02:04 queued 13s
created

WC_Stripe_Customer::delete_source()   A

Complexity

Conditions 3
Paths 3

Size

Total Lines 17

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 3
nc 3
nop 1
dl 0
loc 17
rs 9.7
c 0
b 0
f 0
1
<?php
2
if ( ! defined( 'ABSPATH' ) ) {
3
	exit;
4
}
5
6
/**
7
 * WC_Stripe_Customer class.
8
 *
9
 * Represents a Stripe Customer.
10
 */
11
class WC_Stripe_Customer {
12
13
	/**
14
	 * Stripe customer ID
15
	 * @var string
16
	 */
17
	private $id = '';
18
19
	/**
20
	 * WP User ID
21
	 * @var integer
22
	 */
23
	private $user_id = 0;
24
25
	/**
26
	 * Data from API
27
	 * @var array
28
	 */
29
	private $customer_data = array();
30
31
	/**
32
	 * Constructor
33
	 * @param int $user_id The WP user ID
34
	 */
35
	public function __construct( $user_id = 0 ) {
36
		if ( $user_id ) {
37
			$this->set_user_id( $user_id );
38
			$this->set_id( $this->get_id_from_meta( $user_id ) );
39
		}
40
	}
41
42
	/**
43
	 * Get Stripe customer ID.
44
	 * @return string
45
	 */
46
	public function get_id() {
47
		return $this->id;
48
	}
49
50
	/**
51
	 * Set Stripe customer ID.
52
	 * @param [type] $id [description]
0 ignored issues
show
Documentation introduced by
The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.

Loading history...
53
	 */
54
	public function set_id( $id ) {
55
		// Backwards compat for customer ID stored in array format. (Pre 3.0)
56
		if ( is_array( $id ) && isset( $id['customer_id'] ) ) {
57
			$id = $id['customer_id'];
58
59
			$this->update_id_in_meta( $id );
60
		}
61
62
		$this->id = wc_clean( $id );
63
	}
64
65
	/**
66
	 * User ID in WordPress.
67
	 * @return int
68
	 */
69
	public function get_user_id() {
70
		return absint( $this->user_id );
71
	}
72
73
	/**
74
	 * Set User ID used by WordPress.
75
	 * @param int $user_id
76
	 */
77
	public function set_user_id( $user_id ) {
78
		$this->user_id = absint( $user_id );
79
	}
80
81
	/**
82
	 * Get user object.
83
	 * @return WP_User
84
	 */
85
	protected function get_user() {
86
		return $this->get_user_id() ? get_user_by( 'id', $this->get_user_id() ) : false;
87
	}
88
89
	/**
90
	 * Store data from the Stripe API about this customer
91
	 */
92
	public function set_customer_data( $data ) {
93
		$this->customer_data = $data;
94
	}
95
96
	/**
97
	 * Generates the customer request, used for both creating and updating customers.
98
	 *
99
	 * @param  array $args Additional arguments (optional).
100
	 * @return array
101
	 */
102
	protected function generate_customer_request( $args = array() ) {
103
		$billing_email = isset( $_POST['billing_email'] ) ? filter_var( $_POST['billing_email'], FILTER_SANITIZE_EMAIL ) : '';
104
		$user          = $this->get_user();
105
106
		if ( $user ) {
107
			$billing_first_name = get_user_meta( $user->ID, 'billing_first_name', true );
108
			$billing_last_name  = get_user_meta( $user->ID, 'billing_last_name', true );
109
110
			// If billing first name does not exists try the user first name.
111
			if ( empty( $billing_first_name ) ) {
112
				$billing_first_name = get_user_meta( $user->ID, 'first_name', true );
113
			}
114
115
			// If billing last name does not exists try the user last name.
116
			if ( empty( $billing_last_name ) ) {
117
				$billing_last_name = get_user_meta( $user->ID, 'last_name', true );
118
			}
119
120
			// translators: %1$s First name, %2$s Second name, %3$s Username.
121
			$description = sprintf( __( 'Name: %1$s %2$s, Username: %s', 'woocommerce-gateway-stripe' ), $billing_first_name, $billing_last_name, $user->user_login );
122
123
			$defaults = array(
124
				'email'       => $user->user_email,
125
				'description' => $description,
126
			);
127
		} else {
128
			$billing_first_name = isset( $_POST['billing_first_name'] ) ? filter_var( wp_unslash( $_POST['billing_first_name'] ), FILTER_SANITIZE_STRING ) : ''; // phpcs:ignore WordPress.Security.NonceVerification
129
			$billing_last_name  = isset( $_POST['billing_last_name'] ) ? filter_var( wp_unslash( $_POST['billing_last_name'] ), FILTER_SANITIZE_STRING ) : ''; // phpcs:ignore WordPress.Security.NonceVerification
130
131
			// translators: %1$s First name, %2$s Second name.
132
			$description = sprintf( __( 'Name: %1$s %2$s, Guest', 'woocommerce-gateway-stripe' ), $billing_first_name, $billing_last_name );
133
134
			$defaults = array(
135
				'email'       => $billing_email,
136
				'description' => $description,
137
			);
138
		}
139
140
		$metadata             = array();
141
		$defaults['metadata'] = apply_filters( 'wc_stripe_customer_metadata', $metadata, $user );
142
143
		return wp_parse_args( $args, $defaults );
144
	}
145
146
	/**
147
	 * Create a customer via API.
148
	 * @param array $args
149
	 * @return WP_Error|int
150
	 */
151
	public function create_customer( $args = array() ) {
152
		$args     = $this->generate_customer_request( $args );
153
		$response = WC_Stripe_API::request( apply_filters( 'wc_stripe_create_customer_args', $args ), 'customers' );
154
155 View Code Duplication
		if ( ! empty( $response->error ) ) {
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...
156
			throw new WC_Stripe_Exception( print_r( $response, true ), $response->error->message );
157
		}
158
159
		$this->set_id( $response->id );
160
		$this->clear_cache();
161
		$this->set_customer_data( $response );
162
163
		if ( $this->get_user_id() ) {
164
			$this->update_id_in_meta( $response->id );
165
		}
166
167
		do_action( 'woocommerce_stripe_add_customer', $args, $response );
168
169
		return $response->id;
170
	}
171
172
	/**
173
	 * Updates the Stripe customer through the API.
174
	 *
175
	 * @param array $args     Additional arguments for the request (optional).
176
	 * @param bool  $is_retry Whether the current call is a retry (optional, defaults to false). If true, then an exception will be thrown instead of further retries on error.
177
	 *
178
	 * @return string Customer ID
179
	 *
180
	 * @throws WC_Stripe_Exception
181
	 */
182
	public function update_customer( $args = array(), $is_retry = false ) {
183
		if ( empty( $this->get_id() ) ) {
184
			throw new WC_Stripe_Exception( 'id_required_to_update_user', __( 'Attempting to update a Stripe customer without a customer ID.', 'woocommerce-gateway-stripe' ) );
185
		}
186
187
		$args     = $this->generate_customer_request( $args );
188
		$args     = apply_filters( 'wc_stripe_update_customer_args', $args );
189
		$response = WC_Stripe_API::request( $args, 'customers/' . $this->get_id() );
190
191
		if ( ! empty( $response->error ) ) {
192
			if ( $this->is_no_such_customer_error( $response->error ) && ! $is_retry ) {
193
				// This can happen when switching the main Stripe account or importing users from another site.
194
				// If not already retrying, recreate the customer and then try updating it again.
195
				$this->recreate_customer();
196
				return $this->update_customer( $args, true );
197
			}
198
199
			throw new WC_Stripe_Exception( print_r( $response, true ), $response->error->message );
200
		}
201
202
		$this->clear_cache();
203
		$this->set_customer_data( $response );
204
205
		do_action( 'woocommerce_stripe_update_customer', $args, $response );
206
207
		return $this->get_id();
208
	}
209
210
	/**
211
	 * Checks to see if error is of invalid request
212
	 * error and it is no such customer.
213
	 *
214
	 * @since 4.1.2
215
	 * @param array $error
216
	 */
217
	public function is_no_such_customer_error( $error ) {
218
		return (
219
			$error &&
0 ignored issues
show
Bug Best Practice introduced by
The expression $error of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
220
			'invalid_request_error' === $error->type &&
221
			preg_match( '/No such customer/i', $error->message )
222
		);
223
	}
224
225
	/**
226
	 * Add a source for this stripe customer.
227
	 * @param string $source_id
228
	 * @return WP_Error|int
229
	 */
230
	public function add_source( $source_id ) {
231
		if ( ! $this->get_id() ) {
232
			$this->set_id( $this->create_customer() );
233
		}
234
235
		$response = WC_Stripe_API::request(
236
			array(
237
				'source' => $source_id,
238
			),
239
			'customers/' . $this->get_id() . '/sources'
240
		);
241
242
		$wc_token = false;
243
244
		if ( ! empty( $response->error ) ) {
245
			// It is possible the WC user once was linked to a customer on Stripe
246
			// but no longer exists. Instead of failing, lets try to create a
247
			// new customer.
248
			if ( $this->is_no_such_customer_error( $response->error ) ) {
249
				$this->recreate_customer();
250
				return $this->add_source( $source_id );
251
			} else {
252
				return $response;
0 ignored issues
show
Bug Best Practice introduced by
The return type of return $response; (stdClass|array) is incompatible with the return type documented by WC_Stripe_Customer::add_source of type WP_Error|integer.

If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.

Let’s take a look at an example:

class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}

Our function my_function expects a Post object, and outputs the author of the post. The base class Post returns a simple string and outputting a simple string will work just fine. However, the child class BlogPost which is a sub-type of Post instead decided to return an object, and is therefore violating the SOLID principles. If a BlogPost were passed to my_function, PHP would not complain, but ultimately fail when executing the strtoupper call in its body.

Loading history...
253
			}
254
		} elseif ( empty( $response->id ) ) {
255
			return new WP_Error( 'error', __( 'Unable to add payment source.', 'woocommerce-gateway-stripe' ) );
256
		}
257
258
		// Add token to WooCommerce.
259
		if ( $this->get_user_id() && class_exists( 'WC_Payment_Token_CC' ) ) {
260
			if ( ! empty( $response->type ) ) {
261
				switch ( $response->type ) {
262
					case 'alipay':
263
						break;
264
					case 'sepa_debit':
265
						$wc_token = new WC_Payment_Token_SEPA();
266
						$wc_token->set_token( $response->id );
267
						$wc_token->set_gateway_id( 'stripe_sepa' );
268
						$wc_token->set_last4( $response->sepa_debit->last4 );
269
						break;
270
					default:
271
						if ( 'source' === $response->object && 'card' === $response->type ) {
272
							$wc_token = new WC_Payment_Token_CC();
273
							$wc_token->set_token( $response->id );
274
							$wc_token->set_gateway_id( 'stripe' );
275
							$wc_token->set_card_type( strtolower( $response->card->brand ) );
276
							$wc_token->set_last4( $response->card->last4 );
277
							$wc_token->set_expiry_month( $response->card->exp_month );
278
							$wc_token->set_expiry_year( $response->card->exp_year );
279
						}
280
						break;
281
				}
282
			} else {
283
				// Legacy.
284
				$wc_token = new WC_Payment_Token_CC();
285
				$wc_token->set_token( $response->id );
286
				$wc_token->set_gateway_id( 'stripe' );
287
				$wc_token->set_card_type( strtolower( $response->brand ) );
288
				$wc_token->set_last4( $response->last4 );
289
				$wc_token->set_expiry_month( $response->exp_month );
290
				$wc_token->set_expiry_year( $response->exp_year );
291
			}
292
293
			$wc_token->set_user_id( $this->get_user_id() );
294
			$wc_token->save();
295
		}
296
297
		$this->clear_cache();
298
299
		do_action( 'woocommerce_stripe_add_source', $this->get_id(), $wc_token, $response, $source_id );
300
301
		return $response->id;
302
	}
303
304
	/**
305
	 * Get a customers saved sources using their Stripe ID.
306
	 *
307
	 * @param  string $customer_id
0 ignored issues
show
Bug introduced by
There is no parameter named $customer_id. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
308
	 * @return array
309
	 */
310
	public function get_sources() {
311
		if ( ! $this->get_id() ) {
312
			return array();
313
		}
314
315
		$sources = get_transient( 'stripe_sources_' . $this->get_id() );
316
317
		$response = WC_Stripe_API::request(
318
			array(
319
				'limit' => 100,
320
			),
321
			'customers/' . $this->get_id() . '/sources',
322
			'GET'
323
		);
324
325
		if ( ! empty( $response->error ) ) {
326
			return array();
327
		}
328
329
		if ( is_array( $response->data ) ) {
330
			$sources = $response->data;
331
		}
332
333
		return empty( $sources ) ? array() : $sources;
334
	}
335
336
	/**
337
	 * Delete a source from stripe.
338
	 * @param string $source_id
339
	 */
340
	public function delete_source( $source_id ) {
341
		if ( ! $this->get_id() ) {
342
			return false;
343
		}
344
345
		$response = WC_Stripe_API::request( array(), 'customers/' . $this->get_id() . '/sources/' . sanitize_text_field( $source_id ), 'DELETE' );
346
347
		$this->clear_cache();
348
349
		if ( empty( $response->error ) ) {
350
			do_action( 'wc_stripe_delete_source', $this->get_id(), $response );
351
352
			return true;
353
		}
354
355
		return false;
356
	}
357
358
	/**
359
	 * Set default source in Stripe
360
	 * @param string $source_id
361
	 */
362
	public function set_default_source( $source_id ) {
363
		$response = WC_Stripe_API::request(
364
			array(
365
				'default_source' => sanitize_text_field( $source_id ),
366
			),
367
			'customers/' . $this->get_id(),
368
			'POST'
369
		);
370
371
		$this->clear_cache();
372
373
		if ( empty( $response->error ) ) {
374
			do_action( 'wc_stripe_set_default_source', $this->get_id(), $response );
375
376
			return true;
377
		}
378
379
		return false;
380
	}
381
382
	/**
383
	 * Deletes caches for this users cards.
384
	 */
385
	public function clear_cache() {
386
		delete_transient( 'stripe_sources_' . $this->get_id() );
387
		delete_transient( 'stripe_customer_' . $this->get_id() );
388
		$this->customer_data = array();
389
	}
390
391
	/**
392
	 * Retrieves the Stripe Customer ID from the user meta.
393
	 *
394
	 * @param  int $user_id The ID of the WordPress user.
395
	 * @return string|bool  Either the Stripe ID or false.
396
	 */
397
	public function get_id_from_meta( $user_id ) {
398
		return get_user_option( '_stripe_customer_id', $user_id );
399
	}
400
401
	/**
402
	 * Updates the current user with the right Stripe ID in the meta table.
403
	 *
404
	 * @param string $id The Stripe customer ID.
405
	 */
406
	public function update_id_in_meta( $id ) {
407
		update_user_option( $this->get_user_id(), '_stripe_customer_id', $id, false );
408
	}
409
410
	/**
411
	 * Deletes the user ID from the meta table with the right key.
412
	 */
413
	public function delete_id_from_meta() {
414
		delete_user_option( $this->get_user_id(), '_stripe_customer_id', false );
415
	}
416
417
	/**
418
	 * Recreates the customer for this user.
419
	 *
420
	 * @return string ID of the new Customer object.
421
	 */
422
	private function recreate_customer() {
423
		$this->delete_id_from_meta();
424
		return $this->create_customer();
425
	}
426
}
427