woocommerce/includes/class-wc-privacy.php

<?php
/**
 * Privacy/GDPR related functionality which ties into WordPress functionality.
 *
 * @since 3.4.0
 * @package WooCommerce\Classes
 */

defined( 'ABSPATH' ) || exit;

/**
 * WC_Privacy Class.
 */
class WC_Privacy {

	/**
	 * Init - hook into events.
	 */
	public static function init() {
		add_filter( 'wp_privacy_personal_data_exporters', array( __CLASS__, 'register_data_exporter' ), 10 );
		add_action( 'woocommerce_remove_order_personal_data', array( __CLASS__, 'remove_order_personal_data' ) );
	}

	/**
	 * Registers the personal data exporter for comments.
	 *
	 * @param array $exporters An array of personal data exporters.
	 * @return array An array of personal data exporters.
	 */
	public static function register_data_exporter( $exporters ) {
		$exporters[] = array(
			'exporter_friendly_name' => __( 'WooCommerce Data', 'woocommerce' ),
			'callback'               => array( __CLASS__, 'data_exporter' ),
		);
		return $exporters;
	}

	/**
	 * Finds and exports data which could be used to identify a person from WooCommerce data assocated with an email address.
	 *
	 * Orders are exported in blocks of 10 to avoid timeouts.
	 *
	 * @param string $email_address The user email address.
	 * @param int    $page  Page, zero based.
	 * @return array An array of personal data in name value pairs
	 */
	public static function data_exporter( $email_address, $page ) {
		$done           = false;
		$page           = (int) $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 = array();

		// Export customer data first.
		if ( 1 === $page ) {
			if ( $user instanceof WP_User ) {
				$data_to_export[] = array(
					'group_id'    => 'woocommerce_customer',
					'group_label' => __( 'Customer Data', 'woocommerce' ),
					'item_id'     => 'user',
					'data'        => self::get_user_personal_data( $user ),
				);
			}
		} else { // Export orders - 10 at a time.
			$order_query = array(
				'limit' => 10,
				'page'  => $page - 1,
			);

			if ( $user instanceof WP_User ) {
				$order_query['customer_id'] = (int) $user->ID;
			} else {
				$order_query['billing_email'] = $email_address;
			}

			$orders = wc_get_orders( $order_query );

			if ( 0 < count( $orders ) ) {
				foreach ( $orders as $order ) {
					$data_to_export[] = array(
						'group_id'    => 'woocommerce_orders',
						'group_label' => __( 'Orders', 'woocommerce' ),
						'item_id'     => 'order-' . $order->get_id(),
						'data'        => self::get_order_personal_data( $order ),
					);
				}
				$done = 10 > count( $orders );
			} else {
				$done = true;
			}
		}

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

	/**
	 * Anonymize/remove personal data for a given email address.
	 *
	 * @param string $email Email address.
	 */
	public static function remove_personal_data( $email ) {
		/**
		 * Personal Data:
		 *
		 *   - Everything exported above for orders and customers
		 *   - _billing_address_index - just an index for searching which needs clearing?
		 *   - _shipping_address_index - just an index for searching which needs clearing?
		 *
		 * Misc:
		 *
		 *   - Downloadable Product User Email (does not export becasue it matches order/user data).
		 *   - Download logs by user ID and IP address.
		 *   - File based logs containing email? Do search and clear if found.
		 *   - Payment tokens? Check if these need exporting/clearing. Based on User ID.
		 */
	}

	/**
	 * Get personal data (key/value pairs) for a user object.
	 *
	 * @param WP_User $user user object.
	 * @return array
	 */
	protected static function get_user_personal_data( $user ) {
		$personal_data   = array();
		$customer        = new WC_Customer( $user->ID );
		$props_to_export = array(
			'billing_first_name'  => __( 'Billing First Name', 'woocommerce' ),
			'billing_last_name'   => __( 'Billing Last Name', 'woocommerce' ),
			'billing_company'     => __( 'Billing Company', 'woocommerce' ),
			'billing_address_1'   => __( 'Billing Address 1', 'woocommerce' ),
			'billing_address_2'   => __( 'Billing Address 2', 'woocommerce' ),
			'billing_city'        => __( 'Billing City', 'woocommerce' ),
			'billing_postcode'    => __( 'Billing Postal/Zip Code', 'woocommerce' ),
			'billing_state'       => __( 'Billing State', 'woocommerce' ),
			'billing_country'     => __( 'Billing Country', 'woocommerce' ),
			'billing_phone'       => __( 'Phone Number', 'woocommerce' ),
			'billing_email'       => __( 'Email Address', 'woocommerce' ),
			'shipping_first_name' => __( 'Shipping First Name', 'woocommerce' ),
			'shipping_last_name'  => __( 'Shipping Last Name', 'woocommerce' ),
			'shipping_company'    => __( 'Shipping Company', 'woocommerce' ),
			'shipping_address_1'  => __( 'Shipping Address 1', 'woocommerce' ),
			'shipping_address_2'  => __( 'Shipping Address 2', 'woocommerce' ),
			'shipping_city'       => __( 'Shipping City', 'woocommerce' ),
			'shipping_postcode'   => __( 'Shipping Postal/Zip Code', 'woocommerce' ),
			'shipping_state'      => __( 'Shipping State', 'woocommerce' ),
			'shipping_country'    => __( 'Shipping Country', 'woocommerce' ),
		);

		foreach ( $props_to_export as $prop => $description ) {
			$value = $customer->{"get_$prop"}( 'edit' );

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

		/**
		 * Allow extensions to register their own personal data for this customer for the export.
		 *
		 * @since 3.4.0
		 * @param array    $personal_data Array of name value pairs.
		 * @param WC_Order $order A customer object.
		 */
		$personal_data = apply_filters( 'woocommerce_privacy_export_personal_data_customer', $personal_data, $customer );

		return $personal_data;
	}

	/**
	 * Get personal data (key/value pairs) for an order object.
	 *
	 * @param WC_Order $order Order object.
	 * @return array
	 */
	protected static function get_order_personal_data( $order ) {
		$personal_data   = array();
		$props_to_export = array(
			'order_number'               => __( 'Order Number', 'woocommerce' ),
			'date_created'               => __( 'Order Date', 'woocommerce' ),
			'total'                      => __( 'Order Total', 'woocommerce' ),
			'items'                      => __( 'Items Purchased', 'woocommerce' ),
			'customer_ip_address'        => __( 'IP Address', 'woocommerce' ),
			'customer_user_agent'        => __( 'Browser User Agent', 'woocommerce' ),
			'formatted_billing_address'  => __( 'Billing Address', 'woocommerce' ),
			'formatted_shipping_address' => __( 'Shipping Address', 'woocommerce' ),
			'billing_phone'              => __( 'Phone Number', 'woocommerce' ),
			'billing_email'              => __( 'Email Address', 'woocommerce' ),
		);

		foreach ( $props_to_export as $prop => $name ) {
			switch ( $prop ) {
				case 'items':
					$item_names = array();
					foreach ( $order->get_items() as $item ) {
						$item_names[] = $item->get_name() . ' x ' . $item->get_quantity();
					}
					$value = implode( ', ', $item_names );
					break;
				case 'date_created':
					$value = wc_format_datetime( $order->get_date_created(), get_option( 'date_format' ) . ', ' . get_option( 'time_format' ) );
					break;
				case 'formatted_billing_address':
				case 'formatted_shipping_address':
					$value = preg_replace( '#<br\s*/?>#i', ', ', $order->{"get_$prop"}() );
					break;
				default:
					$value = $order->{"get_$prop"}();
					break;
			}

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

		/**
		 * Allow extensions to register their own personal data for this order for the export.
		 *
		 * @since 3.4.0
		 * @param array    $personal_data Array of name value pairs to expose in the export.
		 * @param WC_Order $order An order object.
		 */
		$personal_data = apply_filters( 'woocommerce_privacy_export_personal_data_order', $personal_data, $order );

		return $personal_data;
	}

	/**
	 * Remove personal data specific to WooCommerce from a user object.
	 *
	 * @param WP_User $user user object.
	 */
	protected static function remove_user_personal_data( $user ) {
		$customer        = new WC_Customer( $user->ID );
		$props_to_remove = array(
			'billing_first_name'  => '__return_empty_string',
			'billing_last_name'   => '__return_empty_string',
			'billing_company'     => '__return_empty_string',
			'billing_address_1'   => '__return_empty_string',
			'billing_address_2'   => '__return_empty_string',
			'billing_city'        => '__return_empty_string',
			'billing_postcode'    => '__return_empty_string',
			'billing_state'       => '__return_empty_string',
			'billing_country'     => '__return_empty_string',
			'billing_phone'       => '__return_empty_string',
			'billing_email'       => '__return_empty_string',
			'shipping_first_name' => '__return_empty_string',
			'shipping_last_name'  => '__return_empty_string',
			'shipping_company'    => '__return_empty_string',
			'shipping_address_1'  => '__return_empty_string',
			'shipping_address_2'  => '__return_empty_string',
			'shipping_city'       => '__return_empty_string',
			'shipping_postcode'   => '__return_empty_string',
			'shipping_state'      => '__return_empty_string',
			'shipping_country'    => '__return_empty_string',
		);
		foreach ( $props_to_remove as $prop => $callback ) {
			$customer->{"set_$prop"}( call_user_func( $callback, $customer->{"get_$prop"} ) );
		}

		/**
		 * Allow extensions to remove their own personal data for this customer.
		 *
		 * @since 3.4.0
		 * @param WC_Order $order A customer object.
		 */
		do_action( 'woocommerce_privacy_remove_personal_data_customer', $customer );

		$customer->save();
	}

	/**
	 * Remove personal data specific to WooCommerce from an order object.
	 *
	 * Note; this will hinder order processing for obvious reasons!
	 *
	 * @param WC_Order $order Order object.
	 */
	public static function remove_order_personal_data( $order ) {
		$props_to_remove = array(
			'customer_ip_address' => '__return_empty_string',
			'customer_user_agent' => '__return_empty_string',
			'billing_first_name'  => '__return_empty_string',
			'billing_last_name'   => '__return_empty_string',
			'billing_company'     => '__return_empty_string',
			'billing_address_1'   => '__return_empty_string',
			'billing_address_2'   => '__return_empty_string',
			'billing_city'        => '__return_empty_string',
			'billing_postcode'    => '__return_empty_string',
			'billing_state'       => '__return_empty_string',
			'billing_country'     => '__return_empty_string',
			'billing_phone'       => '__return_empty_string',
			'billing_email'       => array( __CLASS__, 'mask_email' ),
			'shipping_first_name' => '__return_empty_string',
			'shipping_last_name'  => '__return_empty_string',
			'shipping_company'    => '__return_empty_string',
			'shipping_address_1'  => '__return_empty_string',
			'shipping_address_2'  => '__return_empty_string',
			'shipping_city'       => '__return_empty_string',
			'shipping_postcode'   => '__return_empty_string',
			'shipping_state'      => '__return_empty_string',
			'shipping_country'    => '__return_empty_string',
		);
		foreach ( $props_to_remove as $prop => $callback ) {
			$order->{"set_$prop"}( call_user_func( $callback, $order->{"get_$prop"}( 'edit' ) ) );
		}

		/**
		 * Allow extensions to remove their own personal data for this order.
		 *
		 * @since 3.4.0
		 * @param WC_Order $order A customer object.
		 */
		do_action( 'woocommerce_privacy_remove_personal_data_order', $order );

		$order->save();
		$order->add_order_note( __( 'Personal data removed.', 'woocommerce' ) );
	}

	/**
	 * Mask an email address.
	 *
	 * @param string $email Email to mask.
	 * @return string
	 */
	protected static function mask_email( $email ) {
		if ( ! $email ) {
			return '';
		}

		$min_length = 3;
		$max_length = 10;
		$mask       = '***';
		$at_pos     = strrpos( $email, '@' );
		$name       = substr( $email, 0, $at_pos );
		$length     = strlen( $name );
		$domain     = substr( $email, $at_pos );

		if ( ( $length / 2 ) < $max_length ) {
			$max_length = $length / 2;
		}

		$masked_email = $length > $min_length ? substr( $name, 0, $max_length ) : '';

		return "{$masked_email}{$mask}{$domain}";
	}
}

WC_Privacy::init();