class-wc-stripe-privacy.php
14 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
<?php
if ( ! class_exists( 'WC_Abstract_Privacy' ) ) {
return;
}
class WC_Stripe_Privacy extends WC_Abstract_Privacy {
/**
* Constructor
*/
public function __construct() {
parent::__construct( __( 'Stripe', 'woocommerce-gateway-stripe' ) );
$this->add_exporter( 'woocommerce-gateway-stripe-order-data', __( 'WooCommerce Stripe Order Data', 'woocommerce-gateway-stripe' ), [ $this, 'order_data_exporter' ] );
if ( function_exists( 'wcs_get_subscriptions' ) ) {
$this->add_exporter( 'woocommerce-gateway-stripe-subscriptions-data', __( 'WooCommerce Stripe Subscriptions Data', 'woocommerce-gateway-stripe' ), [ $this, 'subscriptions_data_exporter' ] );
}
$this->add_exporter( 'woocommerce-gateway-stripe-customer-data', __( 'WooCommerce Stripe Customer Data', 'woocommerce-gateway-stripe' ), [ $this, 'customer_data_exporter' ] );
$this->add_eraser( 'woocommerce-gateway-stripe-customer-data', __( 'WooCommerce Stripe Customer Data', 'woocommerce-gateway-stripe' ), [ $this, 'customer_data_eraser' ] );
$this->add_eraser( 'woocommerce-gateway-stripe-order-data', __( 'WooCommerce Stripe Data', 'woocommerce-gateway-stripe' ), [ $this, 'order_data_eraser' ] );
add_filter( 'woocommerce_get_settings_account', [ $this, 'account_settings' ] );
}
/**
* Add retention settings to account tab.
*
* @param array $settings
* @return array $settings Updated
*/
public function account_settings( $settings ) {
$insert_setting = [
[
'title' => __( 'Retain Stripe Data', 'woocommerce-gateway-stripe' ),
'desc_tip' => __( 'Retains any Stripe data such as Stripe customer ID, source ID.', 'woocommerce-gateway-stripe' ),
'id' => 'woocommerce_gateway_stripe_retention',
'type' => 'relative_date_selector',
'placeholder' => __( 'N/A', 'woocommerce-gateway-stripe' ),
'default' => '',
'autoload' => false,
],
];
$index = null;
foreach ( $settings as $key => $value ) {
if ( 'sectionend' === $value['type'] && 'personal_data_retention' === $value['id'] ) {
$index = $key;
break;
}
}
if ( ! is_null( $index ) ) {
array_splice( $settings, $index, 0, $insert_setting );
}
return $settings;
}
/**
* Returns a list of orders that are using one of Stripe's payment methods.
*
* @param string $email_address
* @param int $page
*
* @return array WP_Post
*/
protected function get_stripe_orders( $email_address, $page ) {
$user = get_user_by( 'email', $email_address ); // Check if user has an ID in the DB to load stored personal data.
$order_query = [
'payment_method' => [ 'stripe', 'stripe_alipay', 'stripe_bancontact', 'stripe_eps', 'stripe_giropay', 'stripe_ideal', 'stripe_multibanco', 'stripe_p24', 'stripe_sepa', 'stripe_sofort' ],
'limit' => 10,
'page' => $page,
];
if ( $user instanceof WP_User ) {
$order_query['customer_id'] = (int) $user->ID;
} else {
$order_query['billing_email'] = $email_address;
}
return wc_get_orders( $order_query );
}
/**
* Gets the message of the privacy to display.
*/
public function get_privacy_message() {
$message = sprintf(
/* translators: 1) HTML anchor open tag 2) HTML anchor closing tag */
esc_html__( 'By using this extension, you may be storing personal data or sharing data with an external service. %1$sLearn more about how this works, including what you may want to include in your privacy policy%2$s.', 'woocommerce-gateway-stripe' ),
'<a href="https://woocommerce.com/document/privacy-payments/#section-3" target="_blank">',
'</a>'
);
return wpautop( $message );
}
/**
* Handle exporting data for Orders.
*
* @param string $email_address E-mail address to export.
* @param int $page Pagination of data.
*
* @return array
*/
public function order_data_exporter( $email_address, $page = 1 ) {
$done = false;
$data_to_export = [];
$orders = $this->get_stripe_orders( $email_address, (int) $page );
$done = true;
if ( 0 < count( $orders ) ) {
foreach ( $orders as $order ) {
$data_to_export[] = [
'group_id' => 'woocommerce_orders',
'group_label' => __( 'Orders', 'woocommerce-gateway-stripe' ),
'item_id' => 'order-' . $order->get_id(),
'data' => [
[
'name' => __( 'Stripe payment id', 'woocommerce-gateway-stripe' ),
'value' => get_post_meta( $order->get_id(), '_stripe_source_id', true ),
],
[
'name' => __( 'Stripe customer id', 'woocommerce-gateway-stripe' ),
'value' => get_post_meta( $order->get_id(), '_stripe_customer_id', true ),
],
],
];
}
$done = 10 > count( $orders );
}
return [
'data' => $data_to_export,
'done' => $done,
];
}
/**
* Handle exporting data for Subscriptions.
*
* @param string $email_address E-mail address to export.
* @param int $page Pagination of data.
*
* @return array
*/
public function subscriptions_data_exporter( $email_address, $page = 1 ) {
$done = false;
$page = (int) $page;
$data_to_export = [];
$meta_query = [
'relation' => 'AND',
[
'key' => '_payment_method',
'value' => [ 'stripe', 'stripe_alipay', 'stripe_bancontact', 'stripe_eps', 'stripe_giropay', 'stripe_ideal', 'stripe_multibanco', 'stripe_p24', 'stripe_sepa', 'stripe_sofort' ],
'compare' => 'IN',
],
[
'key' => '_billing_email',
'value' => $email_address,
'compare' => '=',
],
];
$subscription_query = [
'posts_per_page' => 10,
'page' => $page,
'meta_query' => $meta_query,
];
$subscriptions = wcs_get_subscriptions( $subscription_query );
$done = true;
if ( 0 < count( $subscriptions ) ) {
foreach ( $subscriptions as $subscription ) {
$data_to_export[] = [
'group_id' => 'woocommerce_subscriptions',
'group_label' => __( 'Subscriptions', 'woocommerce-gateway-stripe' ),
'item_id' => 'subscription-' . $subscription->get_id(),
'data' => [
[
'name' => __( 'Stripe payment id', 'woocommerce-gateway-stripe' ),
'value' => get_post_meta( $subscription->get_id(), '_stripe_source_id', true ),
],
[
'name' => __( 'Stripe customer id', 'woocommerce-gateway-stripe' ),
'value' => get_post_meta( $subscription->get_id(), '_stripe_customer_id', true ),
],
],
];
}
$done = 10 > count( $subscriptions );
}
return [
'data' => $data_to_export,
'done' => $done,
];
}
/**
* Finds and exports customer data by email address.
*
* @param string $email_address The user email address.
* @param int $page Page.
* @return array An array of personal data in name value pairs
*/
public function customer_data_exporter( $email_address, $page ) {
$user = get_user_by( 'email', $email_address ); // Check if user has an ID in the DB to load stored personal data.
$data_to_export = [];
if ( $user instanceof WP_User ) {
$stripe_user = new WC_Stripe_Customer( $user->ID );
$data_to_export[] = [
'group_id' => 'woocommerce_customer',
'group_label' => __( 'Customer Data', 'woocommerce-gateway-stripe' ),
'item_id' => 'user',
'data' => [
[
'name' => __( 'Stripe payment id', 'woocommerce-gateway-stripe' ),
'value' => get_user_option( '_stripe_source_id', $user->ID ),
],
[
'name' => __( 'Stripe customer id', 'woocommerce-gateway-stripe' ),
'value' => $stripe_user->get_id(),
],
],
];
}
return [
'data' => $data_to_export,
'done' => true,
];
}
/**
* Finds and erases customer data by email address.
*
* @param string $email_address The user email address.
* @param int $page Page.
* @return array An array of personal data in name value pairs
*/
public function customer_data_eraser( $email_address, $page ) {
$page = (int) $page;
$user = get_user_by( 'email', $email_address ); // Check if user has an ID in the DB to load stored personal data.
$stripe_customer_id = '';
$stripe_source_id = '';
if ( $user instanceof WP_User ) {
$stripe_customer_id = get_user_option( '_stripe_customer_id', $user->ID );
$stripe_source_id = get_user_option( '_stripe_source_id', $user->ID );
}
$items_removed = false;
$messages = [];
if ( ! empty( $stripe_customer_id ) || ! empty( $stripe_source_id ) ) {
$items_removed = true;
delete_user_option( $user->ID, '_stripe_customer_id' );
delete_user_option( $user->ID, '_stripe_source_id' );
$messages[] = __( 'Stripe User Data Erased.', 'woocommerce-gateway-stripe' );
}
return [
'items_removed' => $items_removed,
'items_retained' => false,
'messages' => $messages,
'done' => true,
];
}
/**
* Finds and erases order data by email address.
*
* @param string $email_address The user email address.
* @param int $page Page.
* @return array An array of personal data in name value pairs
*/
public function order_data_eraser( $email_address, $page ) {
$orders = $this->get_stripe_orders( $email_address, (int) $page );
$items_removed = false;
$items_retained = false;
$messages = [];
foreach ( (array) $orders as $order ) {
$order = wc_get_order( $order->get_id() );
list( $removed, $retained, $msgs ) = $this->maybe_handle_order( $order );
$items_removed |= $removed;
$items_retained |= $retained;
$messages = array_merge( $messages, $msgs );
list( $removed, $retained, $msgs ) = $this->maybe_handle_subscription( $order );
$items_removed |= $removed;
$items_retained |= $retained;
$messages = array_merge( $messages, $msgs );
}
// Tell core if we have more orders to work on still
$done = count( $orders ) < 10;
return [
'items_removed' => $items_removed,
'items_retained' => $items_retained,
'messages' => $messages,
'done' => $done,
];
}
/**
* Handle eraser of data tied to Subscriptions
*
* @param WC_Order $order
* @return array
*/
protected function maybe_handle_subscription( $order ) {
if ( ! class_exists( 'WC_Subscriptions' ) ) {
return [ false, false, [] ];
}
if ( ! wcs_order_contains_subscription( $order ) ) {
return [ false, false, [] ];
}
$subscription = current( wcs_get_subscriptions_for_order( $order->get_id() ) );
$subscription_id = $subscription->get_id();
$stripe_source_id = get_post_meta( $subscription_id, '_stripe_source_id', true );
if ( empty( $stripe_source_id ) ) {
return [ false, false, [] ];
}
if ( ! $this->is_retention_expired( $order->get_date_created()->getTimestamp() ) ) {
/* translators: %d Order ID */
return [ false, true, [ sprintf( __( 'Order ID %d is less than set retention days. Personal data retained. (Stripe)', 'woocommerce-gateway-stripe' ), $order->get_id() ) ] ];
}
if ( $subscription->has_status( apply_filters( 'wc_stripe_privacy_eraser_subs_statuses', [ 'on-hold', 'active' ] ) ) ) {
/* translators: %d Order ID */
return [ false, true, [ sprintf( __( 'Order ID %d contains an active Subscription. Personal data retained. (Stripe)', 'woocommerce-gateway-stripe' ), $order->get_id() ) ] ];
}
$renewal_orders = WC_Subscriptions_Renewal_Order::get_renewal_orders( $order->get_id() );
foreach ( $renewal_orders as $renewal_order_id ) {
delete_post_meta( $renewal_order_id, '_stripe_source_id' );
delete_post_meta( $renewal_order_id, '_stripe_refund_id' );
delete_post_meta( $renewal_order_id, '_stripe_customer_id' );
}
delete_post_meta( $subscription_id, '_stripe_source_id' );
delete_post_meta( $subscription_id, '_stripe_refund_id' );
delete_post_meta( $subscription_id, '_stripe_customer_id' );
return [ true, false, [ __( 'Stripe Subscription Data Erased.', 'woocommerce-gateway-stripe' ) ] ];
}
/**
* Handle eraser of data tied to Orders
*
* @param WC_Order $order
* @return array
*/
protected function maybe_handle_order( $order ) {
$order_id = $order->get_id();
$stripe_source_id = get_post_meta( $order_id, '_stripe_source_id', true );
$stripe_refund_id = get_post_meta( $order_id, '_stripe_refund_id', true );
$stripe_customer_id = get_post_meta( $order_id, '_stripe_customer_id', true );
if ( ! $this->is_retention_expired( $order->get_date_created()->getTimestamp() ) ) {
/* translators: %d Order ID */
return [ false, true, [ sprintf( __( 'Order ID %d is less than set retention days. Personal data retained. (Stripe)', 'woocommerce-gateway-stripe' ), $order->get_id() ) ] ];
}
if ( empty( $stripe_source_id ) && empty( $stripe_refund_id ) && empty( $stripe_customer_id ) ) {
return [ false, false, [] ];
}
delete_post_meta( $order_id, '_stripe_source_id' );
delete_post_meta( $order_id, '_stripe_refund_id' );
delete_post_meta( $order_id, '_stripe_customer_id' );
return [ true, false, [ __( 'Stripe personal data erased.', 'woocommerce-gateway-stripe' ) ] ];
}
/**
* Checks if create date is passed retention duration.
*/
public function is_retention_expired( $created_date ) {
$retention = wc_parse_relative_date_option( get_option( 'woocommerce_gateway_stripe_retention' ) );
$is_expired = false;
$time_span = time() - strtotime( $created_date );
if ( empty( $retention['number'] ) || empty( $created_date ) ) {
return false;
}
switch ( $retention['unit'] ) {
case 'days':
$retention = $retention['number'] * DAY_IN_SECONDS;
if ( $time_span > $retention ) {
$is_expired = true;
}
break;
case 'weeks':
$retention = $retention['number'] * WEEK_IN_SECONDS;
if ( $time_span > $retention ) {
$is_expired = true;
}
break;
case 'months':
$retention = $retention['number'] * MONTH_IN_SECONDS;
if ( $time_span > $retention ) {
$is_expired = true;
}
break;
case 'years':
$retention = $retention['number'] * YEAR_IN_SECONDS;
if ( $time_span > $retention ) {
$is_expired = true;
}
break;
}
return $is_expired;
}
}
new WC_Stripe_Privacy();