Inactive account handling

Author: mikejolley

Diff for: includes/admin/settings/class-wc-settings-accounts.php

@@ -89,6 +89,25 @@ public function get_settings() {
 					'checkboxgroup' => 'end',
 					'autoload'      => false,
 				),
+				array(
+					'title'         => __( 'Account erasure requests', 'woocommerce' ),
+					'desc'          => __( 'Remove personal data from orders', 'woocommerce' ),
+					'desc_tip'      => __( 'When handling an account erasure request, should personal data within orders be retained or removed?', 'woocommerce' ),
+					'id'            => 'woocommerce_erasure_request_removes_order_data',
+					'type'          => 'checkbox',
+					'default'       => 'no',
+					'checkboxgroup' => 'start',
+					'autoload'      => false,
+				),
+				array(
+					'desc'          => __( 'Remove access to downloads', 'woocommerce' ),
+					'desc_tip'      => __( 'When handling an account erasure request, should access to downloadable files be revoked and download logs cleared?', 'woocommerce' ),
+					'id'            => 'woocommerce_erasure_request_removes_download_data',
+					'type'          => 'checkbox',
+					'default'       => 'no',
+					'checkboxgroup' => 'end',
+					'autoload'      => false,
+				),
 				array(
 					'type' => 'sectionend',
 					'id'   => 'account_registration_options',
@@ -133,33 +152,26 @@ public function get_settings() {
 					'id'   => 'privacy_policy_options',
 				),
 				array(
-					'title' => __( 'Personal data handling', 'woocommerce' ),
-					'desc'  => __( 'These tools let you clean up personal data when it\'s no longer needed for processing, or a user requests account erasure.', 'woocommerce' ),
+					'title' => __( 'Personal data retention', 'woocommerce' ),
+					'desc'  => __( 'Choose how long to retain personal data when it\'s no longer needed for processing. Leave the following options blank to retain this data indefinetely.', 'woocommerce' ),
 					'type'  => 'title',
-					'id'    => 'personal_data_handling',
-				),
-				array(
-					'title'         => __( 'Erasure request handling', 'woocommerce' ),
-					'desc'          => __( 'Remove personal data from orders', 'woocommerce' ),
-					'desc_tip'      => __( 'When processing a request for erasure, should the order data be retained or removed?', 'woocommerce' ),
-					'id'            => 'woocommerce_erasure_request_removes_order_data',
-					'type'          => 'checkbox',
-					'default'       => 'no',
-					'checkboxgroup' => 'start',
-					'autoload'      => false,
+					'id'    => 'personal_data_retention',
 				),
 				array(
-					'desc'          => __( 'Remove access to downloads', 'woocommerce' ),
-					'desc_tip'      => __( 'When processing a request for erasure, should access to downloadable files be revoked and download logs cleared?', 'woocommerce' ),
-					'id'            => 'woocommerce_erasure_request_removes_download_data',
-					'type'          => 'checkbox',
-					'default'       => 'no',
-					'checkboxgroup' => 'end',
-					'autoload'      => false,
+					'title'       => __( 'Retain inactive accounts ', 'woocommerce' ),
+					'desc_tip'    => __( 'Inactive accounts are those which have not logged in, or placed an order, for the specified duration. They will be deleted. Any orders will be converted into guest orders.', 'woocommerce' ),
+					'id'          => 'woocommerce_delete_inactive_accounts',
+					'type'        => 'relative_date_selector',
+					'placeholder' => __( 'N/A', 'woocommerce' ),
+					'default'     => array(
+						'number' => '',
+						'unit'   => 'months',
+					),
+					'autoload'    => false,
 				),
 				array(
 					'title'       => __( 'Retain pending orders ', 'woocommerce' ),
-					'desc_tip'    => __( 'Retain orders with this status for a specified duration before trashing them. Leave blank to retain these orders forever.', 'woocommerce' ),
+					'desc_tip'    => __( 'Pending orders are unpaid and may have been abadonned by the customer. They will be trashed after the specified duration.', 'woocommerce' ),
 					'id'          => 'woocommerce_trash_pending_orders',
 					'type'        => 'relative_date_selector',
 					'placeholder' => __( 'N/A', 'woocommerce' ),
@@ -168,7 +180,7 @@ public function get_settings() {
 				),
 				array(
 					'title'       => __( 'Retain failed orders', 'woocommerce' ),
-					'desc_tip'    => __( 'Retain orders with this status for a specified duration before trashing them. Leave blank to retain these orders forever.', 'woocommerce' ),
+					'desc_tip'    => __( 'Failed orders are unpaid and may have been abadonned by the customer. They will be trashed after the specified duration.', 'woocommerce' ),
 					'id'          => 'woocommerce_trash_failed_orders',
 					'type'        => 'relative_date_selector',
 					'placeholder' => __( 'N/A', 'woocommerce' ),
@@ -177,7 +189,7 @@ public function get_settings() {
 				),
 				array(
 					'title'       => __( 'Retain cancelled orders', 'woocommerce' ),
-					'desc_tip'    => __( 'Retain orders with this status for a specified duration before trashing them. Leave blank to retain these orders forever.', 'woocommerce' ),
+					'desc_tip'    => __( 'Cancelled orders are unpaid and may have been cancelled by the store owner or customer. They will be trashed after the specified duration.', 'woocommerce' ),
 					'id'          => 'woocommerce_trash_cancelled_orders',
 					'type'        => 'relative_date_selector',
 					'placeholder' => __( 'N/A', 'woocommerce' ),
@@ -186,19 +198,19 @@ public function get_settings() {
 				),
 				array(
 					'title'       => __( 'Retain completed orders', 'woocommerce' ),
-					'desc_tip'    => __( 'Retain completed orders for a specified duration before anonymizing the personal data within them. Leave blank to retain these orders forever.', 'woocommerce' ),
+					'desc_tip'    => __( 'Retain completed orders for a specified duration before anonymizing the personal data within them.', 'woocommerce' ),
 					'id'          => 'woocommerce_anonymize_completed_orders',
 					'type'        => 'relative_date_selector',
 					'placeholder' => __( 'N/A', 'woocommerce' ),
 					'default'     => array(
 						'number' => '',
-						'unit'   => 'years',
+						'unit'   => 'months',
 					),
 					'autoload'    => false,
 				),
 				array(
 					'type' => 'sectionend',
-					'id'   => 'personal_data_handling',
+					'id'   => 'personal_data_retention',
 				),
 			)
 		);

Diff for: includes/class-wc-install.php

@@ -351,7 +351,7 @@ private static function create_cron_jobs() {
 		wp_clear_scheduled_hook( 'woocommerce_scheduled_sales' );
 		wp_clear_scheduled_hook( 'woocommerce_cancel_unpaid_orders' );
 		wp_clear_scheduled_hook( 'woocommerce_cleanup_sessions' );
-		wp_clear_scheduled_hook( 'woocommerce_cleanup_orders' );
+		wp_clear_scheduled_hook( 'woocommerce_cleanup_personal_data' );
 		wp_clear_scheduled_hook( 'woocommerce_geoip_updater' );
 		wp_clear_scheduled_hook( 'woocommerce_tracker_send_event' );
 
@@ -365,7 +365,7 @@ private static function create_cron_jobs() {
 			wp_schedule_single_event( time() + ( absint( $held_duration ) * 60 ), 'woocommerce_cancel_unpaid_orders' );
 		}
 
-		wp_schedule_event( time(), 'daily', 'woocommerce_cleanup_orders' );
+		wp_schedule_event( time(), 'daily', 'woocommerce_cleanup_personal_data' );
 		wp_schedule_event( time(), 'twicedaily', 'woocommerce_cleanup_sessions' );
 		wp_schedule_event( strtotime( 'first tuesday of next month' ), 'monthly', 'woocommerce_geoip_updater' );
 		wp_schedule_event( time(), apply_filters( 'woocommerce_tracker_event_recurrence', 'daily' ), 'woocommerce_tracker_send_event' );
@@ -838,10 +838,16 @@ public static function create_roles() {
 			$wp_roles = new WP_Roles(); // @codingStandardsIgnoreLine
 		}
 
+		// Dummy gettext calls to get strings in the catalog.
+		/* translators: user role */
+		_x( 'Customer', 'User role', 'woocommerce' );
+		/* translators: user role */
+		_x( 'Shop manager', 'User role', 'woocommerce' );
+
 		// Customer role.
 		add_role(
 			'customer',
-			__( 'Customer', 'woocommerce' ),
+			'Customer',
 			array(
 				'read' => true,
 			)
@@ -850,7 +856,7 @@ public static function create_roles() {
 		// Shop manager role.
 		add_role(
 			'shop_manager',
-			__( 'Shop manager', 'woocommerce' ),
+			'Shop manager',
 			array(
 				'level_9'                => true,
 				'level_8'                => true,

Diff for: includes/class-wc-privacy-background-process.php

@@ -55,6 +55,9 @@ protected function task( $item ) {
 			case 'anonymize_completed_orders':
 				$process_count = WC_Privacy::anonymize_completed_orders( $process_limit );
 				break;
+			case 'delete_inactive_accounts':
+				$process_count = WC_Privacy::delete_inactive_accounts( $process_limit );
+				break;
 		}
 
 		if ( $process_limit === $process_count ) {

Diff for: includes/class-wc-privacy.php

@@ -45,7 +45,7 @@ public function __construct() {
 		$this->add_eraser( __( 'Customer Downloads', 'woocommerce' ), array( 'WC_Privacy_Erasers', 'download_data_eraser' ) );
 
 		// Cleanup orders daily - this is a callback on a daily cron event.
-		add_action( 'woocommerce_cleanup_orders', array( $this, 'order_cleanup_process' ) );
+		add_action( 'woocommerce_cleanup_personal_data', array( $this, 'queue_cleanup_personal_data' ) );
 
 		// Handles custom anonomization types not included in core.
 		add_filter( 'wp_privacy_anonymize_data', array( $this, 'anonymize_custom_data_types' ), 10, 3 );
@@ -87,11 +87,12 @@ public function get_privacy_message() {
 	/**
 	 * Spawn events for order cleanup.
 	 */
-	public function order_cleanup_process() {
+	public function queue_cleanup_personal_data() {
 		self::$background_process->push_to_queue( array( 'task' => 'trash_pending_orders' ) );
 		self::$background_process->push_to_queue( array( 'task' => 'trash_failed_orders' ) );
 		self::$background_process->push_to_queue( array( 'task' => 'trash_cancelled_orders' ) );
 		self::$background_process->push_to_queue( array( 'task' => 'anonymize_completed_orders' ) );
+		self::$background_process->push_to_queue( array( 'task' => 'delete_inactive_accounts' ) );
 		self::$background_process->save()->dispatch();
 	}
 
@@ -119,48 +120,6 @@ public function anonymize_custom_data_types( $anonymous, $type, $data ) {
 		return $anonymous;
 	}
 
-	/**
-	 * For a given query trash all matches.
-	 *
-	 * @since 3.4.0
-	 * @param array $query Query array to pass to wc_get_orders().
-	 * @return int Count of orders that were trashed.
-	 */
-	protected static function trash_orders_query( $query ) {
-		$orders = wc_get_orders( $query );
-		$count  = 0;
-
-		if ( $orders ) {
-			foreach ( $orders as $order ) {
-				$order->delete( false );
-				$count ++;
-			}
-		}
-
-		return $count;
-	}
-
-	/**
-	 * For a given query, anonymize all matches.
-	 *
-	 * @since 3.4.0
-	 * @param array $query Query array to pass to wc_get_orders().
-	 * @return int Count of orders that were anonymized.
-	 */
-	protected static function anonymize_orders_query( $query ) {
-		$orders = wc_get_orders( $query );
-		$count  = 0;
-
-		if ( $orders ) {
-			foreach ( $orders as $order ) {
-				WC_Privacy_Erasers::remove_order_personal_data( $order );
-				$count ++;
-			}
-		}
-
-		return $count;
-	}
-
 	/**
 	 * Find and trash old orders.
 	 *
@@ -224,15 +183,35 @@ public static function trash_cancelled_orders( $limit = 20 ) {
 		) );
 	}
 
+	/**
+	 * For a given query trash all matches.
+	 *
+	 * @since 3.4.0
+	 * @param array $query Query array to pass to wc_get_orders().
+	 * @return int Count of orders that were trashed.
+	 */
+	protected static function trash_orders_query( $query ) {
+		$orders = wc_get_orders( $query );
+		$count  = 0;
+
+		if ( $orders ) {
+			foreach ( $orders as $order ) {
+				$order->delete( false );
+				$count ++;
+			}
+		}
+
+		return $count;
+	}
+
 	/**
 	 * Anonymize old completed orders.
 	 *
 	 * @since 3.4.0
 	 * @param  int $limit Limit orders to process per batch.
-	 * @param  int $page Page to process.
 	 * @return int Number of orders processed.
 	 */
-	public static function anonymize_completed_orders( $limit = 20, $page = 1 ) {
+	public static function anonymize_completed_orders( $limit = 20 ) {
 		$option = wc_parse_relative_date_option( get_option( 'woocommerce_anonymize_completed_orders' ) );
 
 		if ( empty( $option['number'] ) ) {
@@ -246,6 +225,90 @@ public static function anonymize_completed_orders( $limit = 20, $page = 1 ) {
 			'anonymized'   => false,
 		) );
 	}
+
+	/**
+	 * For a given query, anonymize all matches.
+	 *
+	 * @since 3.4.0
+	 * @param array $query Query array to pass to wc_get_orders().
+	 * @return int Count of orders that were anonymized.
+	 */
+	protected static function anonymize_orders_query( $query ) {
+		$orders = wc_get_orders( $query );
+		$count  = 0;
+
+		if ( $orders ) {
+			foreach ( $orders as $order ) {
+				WC_Privacy_Erasers::remove_order_personal_data( $order );
+				$count ++;
+			}
+		}
+
+		return $count;
+	}
+
+	/**
+	 * Delete inactive accounts.
+	 *
+	 * @since 3.4.0
+	 * @param  int $limit Limit users to process per batch.
+	 * @return int Number of users processed.
+	 */
+	public static function delete_inactive_accounts( $limit = 20 ) {
+		$option = wc_parse_relative_date_option( get_option( 'woocommerce_delete_inactive_accounts' ) );
+
+		if ( empty( $option['number'] ) ) {
+			return 0;
+		}
+
+		return self::delete_inactive_accounts_query( strtotime( '-' . $option['number'] . ' ' . $option['unit'] ), $limit );
+	}
+
+	/**
+	 * Delete inactive accounts.
+	 *
+	 * @since 3.4.0
+	 * @param int $timestamp Timestamp to delete customers before.
+	 * @param int $limit     Limit number of users to delete per run.
+	 * @return int Count of customers that were deleted.
+	 */
+	protected static function delete_inactive_accounts_query( $timestamp, $limit = 20 ) {
+		$count      = 0;
+		$user_query = new WP_User_Query( array(
+			'fields'     => 'ID',
+			'number'     => $limit,
+			'role__in'   => apply_filters( 'woocommerce_delete_inactive_account_roles', array(
+				'Customer',
+				'Subscriber',
+			) ),
+			'meta_query' => array(
+				'relation' => 'AND',
+				array(
+					'key'     => 'wc_last_active',
+					'value'   => (string) $timestamp,
+					'compare' => '<',
+					'type'    => 'NUMERIC',
+				),
+				array(
+					'key'     => 'wc_last_active',
+					'value'   => '0',
+					'compare' => '>',
+					'type'    => 'NUMERIC',
+				),
+			),
+		) );
+
+		$user_ids = $user_query->get_results();
+
+		if ( $user_ids ) {
+			foreach ( $user_ids as $user_id ) {
+				wp_delete_user( $user_id );
+				$count ++;
+			}
+		}
+
+		return $count;
+	}
 }
 
 new WC_Privacy();

Diff for: includes/data-stores/class-wc-order-data-store-cpt.php

@@ -259,11 +259,16 @@ protected function update_post_meta( &$order ) {
 		}
 
 		// If customer changed, update any downloadable permissions.
-		if ( in_array( 'customer_user', $updated_props, true ) || in_array( 'billing_email', $updated_props, true ) ) {
+		if ( in_array( 'customer_id', $updated_props, true ) || in_array( 'billing_email', $updated_props, true ) ) {
 			$data_store = WC_Data_Store::load( 'customer-download' );
 			$data_store->update_user_by_order_id( $id, $order->get_customer_id(), $order->get_billing_email() );
 		}
 
+		// Mark user account as active.
+		if ( in_array( 'customer_id', $updated_props, true ) ) {
+			wc_update_user_last_active( $order->get_customer_id() );
+		}
+
 		do_action( 'woocommerce_order_object_updated_props', $order, $updated_props );
 	}