JezK

Edit File: class-ywsbs-subscription-privacy.php

<?php
/**
 * Implements YWSBS_Subscription_Privacy of YITH WooCommerce Subscription
 *
 * @class   YWSBS_Subscription_Privacy
 * @since   1.4.0
 * @author  YITH
 * @package YITH\Subscription
 */

defined( 'YITH_YWSBS_INIT' ) || exit; // Exit if accessed directly.

if ( ! class_exists( 'YWSBS_Subscription_Privacy' ) ) {
	/**
	 * Class YWSBS_Subscription_Privacy
	 */
	class YWSBS_Subscription_Privacy {
		use YITH_WC_Subscription_Singleton_Trait;

/**
		 * Constructor
		 *
		 * Initialize plugin and registers actions and filters to be used
		 *
		 * @since 1.0.0
		 */
		public function __construct() {
			add_filter( 'wp_privacy_personal_data_exporters', array( $this, 'register_exporters' ), 5 );
			add_filter( 'wp_privacy_personal_data_erasers', array( $this, 'register_erasers' ), 4 );
		}

/**
		 * Register the exporter for YITH Subscription.
		 *
		 * @param array $exporters Exporters.
		 * @return array
		 */
		public function register_exporters( $exporters = array() ) {
			$exporters['ywsbs-customer-subscriptions'] = array(
				'exporter_friendly_name' => esc_html__( 'Customer Subscriptions', 'yith-woocommerce-subscription' ),
				'callback'               => array( 'YWSBS_Subscription_Privacy', 'subscription_data_exporter' ),
			);
			return $exporters;
		}

/**
		 * Register the eraser for YITH Subscription.
		 *
		 * @param array $erasers Erasers.
		 *
		 * @return array
		 */
		public function register_erasers( $erasers = array() ) {
			$erasers['ywsbs-customer-subscriptions'] = array(
				'eraser_friendly_name' => esc_html__( 'Customer Subscriptions', 'yith-woocommerce-subscription' ),
				'callback'             => array( 'YWSBS_Subscription_Privacy', 'subscription_data_eraser' ),
			);

return $erasers;
		}

/**
		 * Subscription data exporter.
		 *
		 * @param string $email_address Email address.
		 * @param string $page Page.
		 *
		 * @return array
		 * @throws Exception Return error.
		 */
		public static function subscription_data_exporter( $email_address, $page ) {
			$done           = false;
			$data_to_export = array();

$subscription_query = self::get_query_args( $email_address, $page );
			$subscriptions      = ! empty( $subscription_query ) ? get_posts( $subscription_query ) : false;

if ( $subscriptions ) {
				foreach ( $subscriptions as $subscription ) {
					$data_to_export[] = array(
						'group_id'    => 'ywsbs_subscriptions',
						'group_label' => esc_html__( 'Subscriptions', 'yith-woocommerce-subscription' ),
						'item_id'     => 'subscription-' . $subscription->ID,
						'data'        => self::get_subscription_personal_data( $subscription ),
					);
				}
				$done = 10 > count( $subscriptions );
			} else {
				$done = true;
			}

return array(
				'data' => $data_to_export,
				'done' => $done,
			);
		}

/**
		 * Subscription dara eraser.
		 *
		 * @param string $email_address Email address.
		 * @param string $page Page.
		 *
		 * @return array
		 */
		public static function subscription_data_eraser( $email_address, $page ) {

$erasure_enabled = wc_string_to_bool( get_option( 'ywsbs_erasure_request', 'no' ) );

$response = array(
				'items_removed'  => false,
				'items_retained' => false,
				'messages'       => array(),
			);

$subscription_query = self::get_query_args( $email_address, $page );
			$subscriptions      = ! empty( $subscription_query ) ? get_posts( $subscription_query ) : false;

if ( $subscriptions ) {
				foreach ( $subscriptions as $subscription ) {
					if ( apply_filters( 'ywsbs_privacy_erase_personal_data', $erasure_enabled, $subscription ) ) {
						self::remove_personal_data( $subscription );

/* Translators: %s Subscription number. */
						$response['messages'][]    = sprintf( esc_html_x( 'Removed personal data from subscription %s.', 'placeholder subscription number', 'yith-woocommerce-subscription' ), $subscription->ID );
						$response['items_removed'] = true;
					} else {
						/* Translators: %s Subscription number. */
						$response['messages'][]     = sprintf( esc_html_x( 'Personal data within subscription %s has been retained.', 'placeholder subscription number', 'yith-woocommerce-subscription' ), $subscription->ID );
						$response['items_retained'] = true;
					}
				}
				$response['done'] = 10 > count( $subscriptions );
			} else {
				$response['done'] = true;
			}

return $response;
		}

/**
		 * Return the query args.
		 *
		 * @param string $email_address Email address.
		 * @param string $page Page.
		 *
		 * @return array|string
		 */
		protected static function get_query_args( $email_address, $page ) {
			$subscription_query = '';
			$user               = get_user_by( 'email', $email_address ); // Check if user has an ID in the DB to load stored personal data.
			$page               = (int) $page;

if ( $user instanceof WP_User ) {
				$subscription_query = array(
					'post_type'      => YITH_YWSBS_POST_TYPE,
					'posts_per_page' => 10,
					'paged'          => $page,
					'meta_key'       => 'user_id', // phpcs:ignore
					'meta_value'     => $user->ID, // phpcs:ignore
				);
			} else {
				$order_list  = array();
				$order_query = array(
					'limit'    => -1,
					'customer' => array( $email_address ),
				);

$orders = wc_get_orders( $order_query );

if ( 0 < count( $orders ) ) {
					foreach ( $orders as $order ) {
						$order_list[] = $order->get_id();
					}

$subscription_query = array(
						'post_type'      => YITH_YWSBS_POST_TYPE,
						'posts_per_page' => 10,
						'paged'          => $page,
						'meta_query'     => array( // phpcs:ignore
							array(
								'key'     => 'order_id',
								'value'   => $order_list,
								'compare' => 'IN',
							),
						),
					);
				}
			}

return $subscription_query;
		}

/**
		 * Return subscription personal data.
		 *
		 * @param WP_Post $subscription_post Subscription post.
		 *
		 * @return array
		 * @throws Exception Return Error.
		 */
		protected static function get_subscription_personal_data( $subscription_post ) {
			$personal_data = array();
			$subscription  = ywsbs_get_subscription( $subscription_post->ID );

$props_to_export = apply_filters(
				'ywsbs_privacy_export_personal_data_props',
				array(
					'id'                         => __( 'Subscription Number', 'yith-woocommerce-subscription' ),
					'status'                     => __( 'Subscription Status', 'yith-woocommerce-subscription' ),
					'date_created'               => __( 'Subscription Creation Date', 'yith-woocommerce-subscription' ),
					'subscription_total'         => __( 'Subscription Total', 'yith-woocommerce-subscription' ),
					'item'                       => __( 'Items Purchased', 'yith-woocommerce-subscription' ),
					'_customer_ip_address'       => __( 'IP Address', 'yith-woocommerce-subscription' ),
					'_customer_user_agent'       => __( 'Browser User Agent', 'yith-woocommerce-subscription' ),
					'formatted_billing_address'  => __( 'Billing Address', 'yith-woocommerce-subscription' ),
					'formatted_shipping_address' => __( 'Shipping Address', 'yith-woocommerce-subscription' ),
					'billing_phone'              => __( 'Phone Number', 'yith-woocommerce-subscription' ),
					'billing_email'              => __( 'Email Address', 'yith-woocommerce-subscription' ),
				),
				$subscription,
				$subscription_post
			);

foreach ( $props_to_export as $prop => $name ) {
				$value  = '';
				$fields = '';
				switch ( $prop ) {
					case 'item':
						$value = $subscription->_product_name . ' x ' . $subscription->_quantity;
						break;
					case 'date_created':
						$value = mysql2date( get_option( 'date_format' ), $subscription_post->post_date );
						break;
					case 'status':
						$status = ywsbs_get_status();
						$value  = isset( $status[ $subscription->status ] ) ? $status[ $subscription->status ] : '';
						break;
					case 'subscription_total':
						$value = wc_price( $subscription->_subscription_total, $subscription->_order_currency );
						break;
					case 'formatted_billing_address':
						$fields = $subscription->get_address_fields( 'billing', true );
						break;
					case 'formatted_shipping_address':
						$fields = empty( $fields ) ? $subscription->get_address_fields( 'shipping', true ) : $fields;

$address = WC()->countries->get_formatted_address( $fields );
						$value   = preg_replace( '#<br\s*/?>#i', ', ', $address );
						break;
					default:
						if ( is_callable( array( $subscription, 'get_' . $prop ) ) ) {
							$value = $subscription->{"get_$prop"}();
						} else {
							$value = $subscription->get( $prop );
						}
						break;
				}

$value = apply_filters( 'ywsbs_privacy_export_personal_data_prop', $value, $prop, $subscription );

if ( $value ) {
					$personal_data[] = array(
						'name'  => $name,
						'value' => $value,
					);
				}
			}

return $personal_data;
		}

/**
		 * Remove personal data.
		 *
		 * @param WP_Post $subscription_post Subscription post.
		 */
		protected static function remove_personal_data( $subscription_post ) {
			$anonymized_data = array();

/**
			 * Expose props and data types we'll be anonymizing.
			 *
			 * @since 3.4.0
			 * @param array    $props Keys are the prop names, values are the data type we'll be passing to wp_privacy_anonymize_data().
			 * @param WC_Order $order A customer object.
			 */

$subscription = ywsbs_get_subscription( $subscription_post->ID );

if ( apply_filters( 'ywsbs_cancel_subscription_before_remove_personal_data', true ) && $subscription->can_be_cancelled() ) {
				$subscription->cancel_subscription();
			}

$props_to_remove = apply_filters(
				'ywsbs_privacy_remove_personal_data_props',
				array(
					'_customer_ip_address' => 'ip',
					'_customer_user_agent' => 'text',
					'_billing_first_name'  => 'text',
					'_billing_last_name'   => 'text',
					'_billing_company'     => 'text',
					'_billing_address_1'   => 'text',
					'_billing_address_2'   => 'text',
					'_billing_city'        => 'text',
					'_billing_postcode'    => 'text',
					'_billing_state'       => 'address_state',
					'_billing_country'     => 'address_country',
					'_billing_phone'       => 'phone',
					'_billing_email'       => 'email',
					'_shipping_first_name' => 'text',
					'_shipping_last_name'  => 'text',
					'_shipping_company'    => 'text',
					'_shipping_address_1'  => 'text',
					'_shipping_address_2'  => 'text',
					'_shipping_city'       => 'text',
					'_shipping_postcode'   => 'text',
					'_shipping_state'      => 'address_state',
					'_shipping_country'    => 'address_country',
					'_user_id'             => 'numeric_id',
				),
				$subscription,
				$subscription_post
			);

if ( ! empty( $props_to_remove ) && is_array( $props_to_remove ) ) {
				foreach ( $props_to_remove as $prop => $data_type ) {

$value = $subscription->get( $prop );

// If the value is empty, it does not need to be anonymized.
					if ( empty( $value ) || empty( $data_type ) ) {
						continue;
					}

if ( function_exists( 'wp_privacy_anonymize_data' ) ) {
						$anon_value = wp_privacy_anonymize_data( $data_type, $value );
					} else {
						$anon_value = '';
					}

$anonymized_data[ $prop ] = apply_filters( 'ywsbs_privacy_remove_personal_data_prop_value', $anon_value, $prop, $value, $data_type, $subscription );
				}
			}

$subscription->update_subscription_meta( $anonymized_data );
		}
	}
}

/**
 * Unique access to instance of YWSBS_Subscription_Privacy class
 *
 * @return YWSBS_Subscription_Privacy
 */
function YWSBS_Subscription_Privacy() { // phpcs:ignore
	return YWSBS_Subscription_Privacy::get_instance();
}