865 lines
27 KiB
PHP
865 lines
27 KiB
PHP
<?php
|
|
/**
|
|
* Report table sync related functions and actions.
|
|
*
|
|
* @package WooCommerce Admin/Classes
|
|
*/
|
|
|
|
namespace Automattic\WooCommerce\Admin;
|
|
|
|
defined( 'ABSPATH' ) || exit;
|
|
|
|
use \Automattic\WooCommerce\Admin\API\Reports\Coupons\DataStore as CouponsDataStore;
|
|
use \Automattic\WooCommerce\Admin\API\Reports\Customers\DataStore as CustomersDataStore;
|
|
use \Automattic\WooCommerce\Admin\API\Reports\Orders\Stats\DataStore as OrdersStatsDataStore;
|
|
use \Automattic\WooCommerce\Admin\API\Reports\Products\DataStore as ProductsDataStore;
|
|
use \Automattic\WooCommerce\Admin\API\Reports\Taxes\DataStore as TaxesDataStore;
|
|
|
|
/**
|
|
* ReportsSync Class.
|
|
*/
|
|
class ReportsSync {
|
|
/**
|
|
* Action hook for reducing a range of batches down to single actions.
|
|
*/
|
|
const QUEUE_BATCH_ACTION = 'wc-admin_queue_batches';
|
|
|
|
/**
|
|
* Action hook for queuing an action after another is complete.
|
|
*/
|
|
const QUEUE_DEPENDENT_ACTION = 'wc-admin_queue_dependent_action';
|
|
|
|
/**
|
|
* Action hook for importing a batch of customers.
|
|
*/
|
|
const CUSTOMERS_IMPORT_BATCH_ACTION = 'wc-admin_import_customers_batch';
|
|
|
|
/**
|
|
* Action hook for initializing the orders lookup batch creation.
|
|
*/
|
|
const CUSTOMERS_DELETE_BATCH_INIT = 'wc-admin_delete_customers_batch_init';
|
|
|
|
/**
|
|
* Action hook for deleting a batch of customers.
|
|
*/
|
|
const CUSTOMERS_DELETE_BATCH_ACTION = 'wc-admin_delete_customers_batch';
|
|
|
|
/**
|
|
* Action hook for importing a batch of orders.
|
|
*/
|
|
const ORDERS_IMPORT_BATCH_ACTION = 'wc-admin_import_orders_batch';
|
|
|
|
/**
|
|
* Action hook for initializing the orders lookup batch creation.
|
|
*/
|
|
const ORDERS_IMPORT_BATCH_INIT = 'wc-admin_orders_lookup_import_batch_init';
|
|
|
|
/**
|
|
* Action hook for initializing the orders lookup batch deletion.
|
|
*/
|
|
const ORDERS_DELETE_BATCH_INIT = 'wc-admin_orders_lookup_delete_batch_init';
|
|
|
|
/**
|
|
* Action hook for deleting a batch of orders.
|
|
*/
|
|
const ORDERS_DELETE_BATCH_ACTION = 'wc-admin_delete_orders_batch';
|
|
|
|
/**
|
|
* Action hook for importing a single customer.
|
|
*/
|
|
const SINGLE_CUSTOMER_IMPORT_ACTION = 'wc-admin_import_customer';
|
|
|
|
/**
|
|
* Action hook for importing a single order.
|
|
*/
|
|
const SINGLE_ORDER_IMPORT_ACTION = 'wc-admin_import_order';
|
|
|
|
/**
|
|
* Action scheduler group.
|
|
*/
|
|
const QUEUE_GROUP = 'wc-admin-data';
|
|
|
|
/**
|
|
* Queue instance.
|
|
*
|
|
* @var WC_Queue_Interface
|
|
*/
|
|
protected static $queue = null;
|
|
|
|
/**
|
|
* Get queue instance.
|
|
*
|
|
* @return WC_Queue_Interface
|
|
*/
|
|
public static function queue() {
|
|
if ( is_null( self::$queue ) ) {
|
|
self::$queue = WC()->queue();
|
|
}
|
|
|
|
return self::$queue;
|
|
}
|
|
|
|
/**
|
|
* Set queue instance.
|
|
*
|
|
* @param WC_Queue_Interface $queue Queue instance.
|
|
*/
|
|
public static function set_queue( $queue ) {
|
|
self::$queue = $queue;
|
|
}
|
|
|
|
/**
|
|
* Hook in sync methods.
|
|
*/
|
|
public static function init() {
|
|
// Initialize syncing hooks.
|
|
add_action( 'wp_loaded', array( __CLASS__, 'customers_lookup_update_init' ) );
|
|
add_action( 'wp_loaded', array( __CLASS__, 'orders_lookup_update_init' ) );
|
|
|
|
// Initialize scheduled action handlers.
|
|
add_action( self::QUEUE_BATCH_ACTION, array( __CLASS__, 'queue_batches' ), 10, 4 );
|
|
add_action( self::QUEUE_DEPENDENT_ACTION, array( __CLASS__, 'queue_dependent_action' ), 10, 3 );
|
|
add_action( self::CUSTOMERS_IMPORT_BATCH_ACTION, array( __CLASS__, 'customer_lookup_import_batch' ), 10, 3 );
|
|
add_action( self::CUSTOMERS_DELETE_BATCH_INIT, array( __CLASS__, 'customer_lookup_delete_batch_init' ) );
|
|
add_action( self::CUSTOMERS_DELETE_BATCH_ACTION, array( __CLASS__, 'customer_lookup_delete_batch' ) );
|
|
add_action( self::SINGLE_CUSTOMER_IMPORT_ACTION, array( __CLASS__, 'customer_lookup_import_customer' ) );
|
|
add_action( self::ORDERS_IMPORT_BATCH_ACTION, array( __CLASS__, 'orders_lookup_import_batch' ), 10, 4 );
|
|
add_action( self::ORDERS_IMPORT_BATCH_INIT, array( __CLASS__, 'orders_lookup_import_batch_init' ), 10, 3 );
|
|
add_action( self::ORDERS_DELETE_BATCH_ACTION, array( __CLASS__, 'orders_lookup_delete_batch' ), 10, 4 );
|
|
add_action( self::ORDERS_DELETE_BATCH_INIT, array( __CLASS__, 'orders_lookup_delete_batch_init' ), 10, 3 );
|
|
add_action( self::SINGLE_ORDER_IMPORT_ACTION, array( __CLASS__, 'orders_lookup_import_order' ) );
|
|
}
|
|
|
|
/**
|
|
* Regenerate data for reports.
|
|
*
|
|
* @param int|bool $days Number of days to import.
|
|
* @param bool $skip_existing Skip exisiting records.
|
|
* @return string
|
|
*/
|
|
public static function regenerate_report_data( $days, $skip_existing ) {
|
|
if ( self::is_importing() ) {
|
|
return new \WP_Error( 'wc_admin_import_in_progress', __( 'An import is already in progress. Please allow the previous import to complete before beginning a new one.', 'woocommerce-admin' ) );
|
|
}
|
|
|
|
self::reset_import_stats( $days, $skip_existing );
|
|
self::customer_lookup_import_batch_init( $days, $skip_existing );
|
|
self::queue_dependent_action( self::ORDERS_IMPORT_BATCH_INIT, array( $days, $skip_existing ), self::CUSTOMERS_IMPORT_BATCH_ACTION );
|
|
|
|
return __( 'Report table data is being rebuilt. Please allow some time for data to fully populate.', 'woocommerce-admin' );
|
|
}
|
|
|
|
/**
|
|
* Update the import stat totals and counts.
|
|
*
|
|
* @param int|bool $days Number of days to import.
|
|
* @param bool $skip_existing Skip exisiting records.
|
|
*/
|
|
public static function reset_import_stats( $days, $skip_existing ) {
|
|
$totals = self::get_import_totals( $days, $skip_existing );
|
|
update_option( 'wc_admin_import_customers_count', 0 );
|
|
update_option( 'wc_admin_import_orders_count', 0 );
|
|
update_option( 'wc_admin_import_customers_total', $totals['customers'] );
|
|
update_option( 'wc_admin_import_orders_total', $totals['orders'] );
|
|
|
|
// Update imported from date if older than previous.
|
|
$previous_import_date = get_option( 'wc_admin_imported_from_date' );
|
|
$current_import_date = $days ? date( 'Y-m-d 00:00:00', time() - ( DAY_IN_SECONDS * $days ) ) : -1;
|
|
|
|
if ( ! $previous_import_date || -1 === $current_import_date || new \DateTime( $previous_import_date ) > new \DateTime( $current_import_date ) ) {
|
|
update_option( 'wc_admin_imported_from_date', $current_import_date );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get the import totals for customers and orders.
|
|
*
|
|
* @param int|bool $days Number of days to import.
|
|
* @param bool $skip_existing Skip exisiting records.
|
|
* @return array
|
|
*/
|
|
public static function get_import_totals( $days, $skip_existing ) {
|
|
$orders = self::get_orders( 1, 1, $days, $skip_existing );
|
|
$customer_roles = apply_filters( 'woocommerce_admin_import_customer_roles', array( 'customer' ) );
|
|
$customer_query = self::get_user_ids_for_batch(
|
|
$days,
|
|
$skip_existing,
|
|
array(
|
|
'fields' => 'ID',
|
|
'number' => 1,
|
|
'role__in' => $customer_roles,
|
|
)
|
|
);
|
|
|
|
return array(
|
|
'customers' => $customer_query->get_total(),
|
|
'orders' => $orders->total,
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Returns true if an import is in progress.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public static function is_importing() {
|
|
$pending_jobs = self::queue()->search(
|
|
array(
|
|
'status' => 'pending',
|
|
'per_page' => 1,
|
|
'claimed' => false,
|
|
'search' => 'import',
|
|
'group' => self::QUEUE_GROUP,
|
|
)
|
|
);
|
|
|
|
return ! empty( $pending_jobs );
|
|
}
|
|
|
|
/**
|
|
* Clears all queued actions.
|
|
*/
|
|
public static function clear_queued_actions() {
|
|
$store = \ActionScheduler::store();
|
|
|
|
if ( is_a( $store, 'Automattic\WooCommerce\Admin\Overrides\WPPostStore' ) ) {
|
|
// If we're using our data store, call our bespoke deletion method.
|
|
$action_types = array(
|
|
self::QUEUE_BATCH_ACTION,
|
|
self::QUEUE_DEPENDENT_ACTION,
|
|
self::CUSTOMERS_IMPORT_BATCH_ACTION,
|
|
self::CUSTOMERS_DELETE_BATCH_INIT,
|
|
self::CUSTOMERS_DELETE_BATCH_ACTION,
|
|
self::ORDERS_IMPORT_BATCH_ACTION,
|
|
self::ORDERS_IMPORT_BATCH_INIT,
|
|
self::ORDERS_DELETE_BATCH_INIT,
|
|
self::ORDERS_DELETE_BATCH_ACTION,
|
|
self::SINGLE_CUSTOMER_IMPORT_ACTION,
|
|
self::SINGLE_ORDER_IMPORT_ACTION,
|
|
);
|
|
$store->clear_pending_wcadmin_actions( $action_types );
|
|
} elseif ( version_compare( \ActionScheduler_Versions::instance()->latest_version(), '3.0', '>=' ) ) {
|
|
$store->cancel_actions_by_group( self::QUEUE_GROUP );
|
|
} else {
|
|
self::queue()->cancel_all( null, array(), self::QUEUE_GROUP );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Delete all data for reports.
|
|
*
|
|
* @return string
|
|
*/
|
|
public static function delete_report_data() {
|
|
// Cancel all pending import jobs.
|
|
self::clear_queued_actions();
|
|
|
|
// Delete orders in batches.
|
|
self::queue()->schedule_single( time() + 5, self::ORDERS_DELETE_BATCH_INIT, array(), self::QUEUE_GROUP );
|
|
|
|
// Delete customers after order data is deleted.
|
|
self::queue_dependent_action( self::CUSTOMERS_DELETE_BATCH_INIT, array(), self::ORDERS_DELETE_BATCH_INIT );
|
|
|
|
// Delete import options.
|
|
delete_option( 'wc_admin_import_customers_count' );
|
|
delete_option( 'wc_admin_import_orders_count' );
|
|
delete_option( 'wc_admin_import_customers_total' );
|
|
delete_option( 'wc_admin_import_orders_total' );
|
|
delete_option( 'wc_admin_imported_from_date' );
|
|
|
|
return __( 'Report table data is being deleted.', 'woocommerce-admin' );
|
|
}
|
|
|
|
/**
|
|
* Schedule an action to import a single Order.
|
|
*
|
|
* @param int $order_id Order ID.
|
|
* @return void
|
|
*/
|
|
public static function schedule_single_order_import( $order_id ) {
|
|
if ( 'shop_order' !== get_post_type( $order_id ) && 'woocommerce_refund_created' !== current_filter() ) {
|
|
return;
|
|
}
|
|
|
|
if ( apply_filters( 'woocommerce_disable_order_scheduling', false ) ) {
|
|
self::orders_lookup_import_order( $order_id );
|
|
return;
|
|
}
|
|
|
|
// This can get called multiple times for a single order, so we look
|
|
// for existing pending jobs for the same order to avoid duplicating efforts.
|
|
$existing_jobs = self::queue()->search(
|
|
array(
|
|
'status' => 'pending',
|
|
'per_page' => 1,
|
|
'claimed' => false,
|
|
'search' => "[{$order_id}]",
|
|
'group' => self::QUEUE_GROUP,
|
|
)
|
|
);
|
|
|
|
if ( $existing_jobs ) {
|
|
$existing_job = current( $existing_jobs );
|
|
|
|
// Bail out if there's a pending single order action, or a pending dependent action.
|
|
if (
|
|
( self::SINGLE_ORDER_IMPORT_ACTION === $existing_job->get_hook() ) ||
|
|
(
|
|
self::QUEUE_DEPENDENT_ACTION === $existing_job->get_hook() &&
|
|
in_array( self::SINGLE_ORDER_IMPORT_ACTION, $existing_job->get_args(), true )
|
|
)
|
|
) {
|
|
return;
|
|
}
|
|
}
|
|
|
|
// We want to ensure that customer lookup updates are scheduled before order updates.
|
|
self::queue_dependent_action( self::SINGLE_ORDER_IMPORT_ACTION, array( $order_id ), self::CUSTOMERS_IMPORT_BATCH_ACTION );
|
|
}
|
|
|
|
/**
|
|
* Attach customer lookup update hooks.
|
|
*/
|
|
public static function customers_lookup_update_init() {
|
|
add_action( 'woocommerce_new_customer', array( __CLASS__, 'schedule_single_customer_import' ) );
|
|
add_action( 'woocommerce_update_customer', array( __CLASS__, 'schedule_single_customer_import' ) );
|
|
|
|
CustomersDataStore::init();
|
|
}
|
|
|
|
/**
|
|
* Attach order lookup update hooks.
|
|
*/
|
|
public static function orders_lookup_update_init() {
|
|
// Activate WC_Order extension.
|
|
\Automattic\WooCommerce\Admin\Overrides\Order::add_filters();
|
|
\Automattic\WooCommerce\Admin\Overrides\OrderRefund::add_filters();
|
|
|
|
// Order and refund data must be run on these hooks to ensure meta data is set.
|
|
add_action( 'save_post', array( __CLASS__, 'schedule_single_order_import' ) );
|
|
add_action( 'woocommerce_refund_created', array( __CLASS__, 'schedule_single_order_import' ) );
|
|
|
|
OrdersStatsDataStore::init();
|
|
CouponsDataStore::init();
|
|
ProductsDataStore::init();
|
|
TaxesDataStore::init();
|
|
}
|
|
|
|
/**
|
|
* Init order/product lookup tables update (in batches).
|
|
*
|
|
* @param integer|boolean $days Number of days to import.
|
|
* @param boolean $skip_existing Skip exisiting records.
|
|
*/
|
|
public static function orders_lookup_import_batch_init( $days, $skip_existing ) {
|
|
$batch_size = self::get_batch_size( self::ORDERS_IMPORT_BATCH_ACTION );
|
|
$orders = self::get_orders( 1, 1, $days, $skip_existing );
|
|
|
|
if ( 0 === $orders->total ) {
|
|
return;
|
|
}
|
|
|
|
$num_batches = ceil( $orders->total / $batch_size );
|
|
|
|
self::queue_batches( 1, $num_batches, self::ORDERS_IMPORT_BATCH_ACTION, array( $days, $skip_existing ) );
|
|
}
|
|
|
|
/**
|
|
* Get the order/refund IDs and total count that need to be synced.
|
|
*
|
|
* @param int $limit Number of records to retrieve.
|
|
* @param int $page Page number.
|
|
* @param int|bool $days Number of days prior to current date to limit search results.
|
|
* @param bool $skip_existing Skip already imported orders.
|
|
*/
|
|
public static function get_orders( $limit = 10, $page = 1, $days = false, $skip_existing = false ) {
|
|
global $wpdb;
|
|
$where_clause = '';
|
|
$offset = $page > 1 ? ( $page - 1 ) * $limit : 0;
|
|
|
|
if ( is_int( $days ) ) {
|
|
$days_ago = date( 'Y-m-d 00:00:00', time() - ( DAY_IN_SECONDS * $days ) );
|
|
$where_clause .= " AND post_date >= '{$days_ago}'";
|
|
}
|
|
|
|
if ( $skip_existing ) {
|
|
$where_clause .= " AND NOT EXISTS (
|
|
SELECT 1 FROM {$wpdb->prefix}wc_order_stats
|
|
WHERE {$wpdb->prefix}wc_order_stats.order_id = {$wpdb->posts}.ID
|
|
)";
|
|
}
|
|
|
|
$count = $wpdb->get_var(
|
|
"SELECT COUNT(*) FROM {$wpdb->posts}
|
|
WHERE post_type IN ( 'shop_order', 'shop_order_refund' )
|
|
AND post_status NOT IN ( 'wc-auto-draft', 'auto-draft', 'trash' )
|
|
{$where_clause}"
|
|
); // WPCS: unprepared SQL ok.
|
|
|
|
$order_ids = absint( $count ) > 0 ? $wpdb->get_col(
|
|
$wpdb->prepare(
|
|
"SELECT ID FROM {$wpdb->posts}
|
|
WHERE post_type IN ( 'shop_order', 'shop_order_refund' )
|
|
AND post_status NOT IN ( 'auto-draft', 'trash' )
|
|
{$where_clause}
|
|
ORDER BY post_date ASC
|
|
LIMIT %d
|
|
OFFSET %d",
|
|
$limit,
|
|
$offset
|
|
)
|
|
) : array(); // WPCS: unprepared SQL ok.
|
|
|
|
return (object) array(
|
|
'total' => absint( $count ),
|
|
'order_ids' => $order_ids,
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Imports a batch of orders to update (stats and products).
|
|
*
|
|
* @param int $batch_number Batch number to import (essentially a query page number).
|
|
* @param int|bool $days Number of days to import.
|
|
* @param bool $skip_existing Skip exisiting records.
|
|
* @return void
|
|
*/
|
|
public static function orders_lookup_import_batch( $batch_number, $days, $skip_existing ) {
|
|
$batch_size = self::get_batch_size( self::ORDERS_IMPORT_BATCH_ACTION );
|
|
|
|
$properties = array(
|
|
'batch_number' => $batch_number,
|
|
'batch_size' => $batch_size,
|
|
'type' => 'order',
|
|
);
|
|
wc_admin_record_tracks_event( 'import_job_start', $properties );
|
|
|
|
// When we are skipping already imported orders, the table of orders to import gets smaller in
|
|
// every batch, so we want to always import the first page.
|
|
$page = $skip_existing ? 1 : $batch_number;
|
|
$orders = self::get_orders( $batch_size, $page, $days, $skip_existing );
|
|
|
|
foreach ( $orders->order_ids as $order_id ) {
|
|
self::orders_lookup_import_order( $order_id );
|
|
}
|
|
|
|
$imported_count = get_option( 'wc_admin_import_orders_count', 0 );
|
|
update_option( 'wc_admin_import_orders_count', $imported_count + count( $orders->order_ids ) );
|
|
|
|
$properties['imported_count'] = $imported_count;
|
|
|
|
wc_admin_record_tracks_event( 'import_job_complete', $properties );
|
|
}
|
|
|
|
/**
|
|
* Imports a single order or refund to update lookup tables for.
|
|
* If an error is encountered in one of the updates, a retry action is scheduled.
|
|
*
|
|
* @param int $order_id Order or refund ID.
|
|
* @return void
|
|
*/
|
|
public static function orders_lookup_import_order( $order_id ) {
|
|
|
|
$order = wc_get_order( $order_id );
|
|
|
|
// If the order isn't found for some reason, skip the sync.
|
|
if ( ! $order ) {
|
|
return;
|
|
}
|
|
|
|
$type = $order->get_type();
|
|
|
|
// If the order isn't the right type, skip sync.
|
|
if ( 'shop_order' !== $type && 'shop_order_refund' !== $type ) {
|
|
return;
|
|
}
|
|
|
|
// If the order has no id or date created, skip sync.
|
|
if ( ! $order->get_id() || ! $order->get_date_created() ) {
|
|
return;
|
|
}
|
|
|
|
$result = array_sum(
|
|
array(
|
|
OrdersStatsDataStore::sync_order( $order_id ),
|
|
ProductsDataStore::sync_order_products( $order_id ),
|
|
CouponsDataStore::sync_order_coupons( $order_id ),
|
|
TaxesDataStore::sync_order_taxes( $order_id ),
|
|
)
|
|
);
|
|
|
|
// If all updates were either skipped or successful, we're done.
|
|
// The update methods return -1 for skip, or a boolean success indicator.
|
|
if ( 4 === absint( $result ) ) {
|
|
return;
|
|
}
|
|
|
|
// Otherwise assume an error occurred and reschedule.
|
|
self::schedule_single_order_import( $order_id );
|
|
}
|
|
|
|
/**
|
|
* Returns the batch size for regenerating reports.
|
|
* Note: can differ per batch action.
|
|
*
|
|
* @param string $action Single batch action name.
|
|
* @return int Batch size.
|
|
*/
|
|
public static function get_batch_size( $action ) {
|
|
$batch_sizes = array(
|
|
self::QUEUE_BATCH_ACTION => 100,
|
|
self::CUSTOMERS_IMPORT_BATCH_ACTION => 25,
|
|
self::CUSTOMERS_DELETE_BATCH_ACTION => 25,
|
|
self::ORDERS_IMPORT_BATCH_ACTION => 10,
|
|
self::ORDERS_DELETE_BATCH_ACTION => 10,
|
|
);
|
|
$batch_size = isset( $batch_sizes[ $action ] ) ? $batch_sizes[ $action ] : 25;
|
|
|
|
/**
|
|
* Filter the batch size for regenerating a report table.
|
|
*
|
|
* @param int $batch_size Batch size.
|
|
* @param string $action Batch action name.
|
|
*/
|
|
return apply_filters( 'wc_admin_report_regenerate_batch_size', $batch_size, $action );
|
|
}
|
|
|
|
/**
|
|
* Queue a large number of batch jobs, respecting the batch size limit.
|
|
* Reduces a range of batches down to "single batch" jobs.
|
|
*
|
|
* @param int $range_start Starting batch number.
|
|
* @param int $range_end Ending batch number.
|
|
* @param string $single_batch_action Action to schedule for a single batch.
|
|
* @param array $action_args Action arguments.
|
|
* @return void
|
|
*/
|
|
public static function queue_batches( $range_start, $range_end, $single_batch_action, $action_args = array() ) {
|
|
$batch_size = self::get_batch_size( self::QUEUE_BATCH_ACTION );
|
|
$range_size = 1 + ( $range_end - $range_start );
|
|
$action_timestamp = time() + 5;
|
|
|
|
if ( $range_size > $batch_size ) {
|
|
// If the current batch range is larger than a single batch,
|
|
// split the range into $queue_batch_size chunks.
|
|
$chunk_size = (int) ceil( $range_size / $batch_size );
|
|
|
|
for ( $i = 0; $i < $batch_size; $i++ ) {
|
|
$batch_start = (int) ( $range_start + ( $i * $chunk_size ) );
|
|
$batch_end = (int) min( $range_end, $range_start + ( $chunk_size * ( $i + 1 ) ) - 1 );
|
|
|
|
if ( $batch_start > $range_end ) {
|
|
return;
|
|
}
|
|
|
|
self::queue()->schedule_single(
|
|
$action_timestamp,
|
|
self::QUEUE_BATCH_ACTION,
|
|
array( $batch_start, $batch_end, $single_batch_action, $action_args ),
|
|
self::QUEUE_GROUP
|
|
);
|
|
}
|
|
} else {
|
|
// Otherwise, queue the single batches.
|
|
for ( $i = $range_start; $i <= $range_end; $i++ ) {
|
|
$batch_action_args = array_merge( array( $i ), $action_args );
|
|
self::queue()->schedule_single( $action_timestamp, $single_batch_action, $batch_action_args, self::QUEUE_GROUP );
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Queue an action to run after another.
|
|
*
|
|
* @param string $action Action to run after prerequisite.
|
|
* @param array $action_args Action arguments.
|
|
* @param string $prerequisite_action Prerequisite action.
|
|
*/
|
|
public static function queue_dependent_action( $action, $action_args, $prerequisite_action ) {
|
|
$blocking_jobs = self::queue()->search(
|
|
array(
|
|
'status' => 'pending',
|
|
'orderby' => 'date',
|
|
'order' => 'DESC',
|
|
'per_page' => 1,
|
|
'claimed' => false,
|
|
'search' => $prerequisite_action, // search is used instead of hook to find queued batch creation.
|
|
'group' => self::QUEUE_GROUP,
|
|
)
|
|
);
|
|
|
|
$next_job_schedule = null;
|
|
$blocking_job_hook = null;
|
|
|
|
if ( $blocking_jobs ) {
|
|
$blocking_job = current( $blocking_jobs );
|
|
$blocking_job_hook = $blocking_job->get_hook();
|
|
$next_job_schedule = $blocking_job->get_schedule()->next();
|
|
}
|
|
|
|
// Eliminate the false positive scenario where the blocking job is
|
|
// actually another queued dependent action awaiting the same prerequisite.
|
|
// Also, ensure that the next schedule is a DateTime (it can be null).
|
|
if (
|
|
is_a( $next_job_schedule, 'DateTime' ) &&
|
|
( self::QUEUE_DEPENDENT_ACTION !== $blocking_job_hook )
|
|
) {
|
|
self::queue()->schedule_single(
|
|
$next_job_schedule->getTimestamp() + 5,
|
|
self::QUEUE_DEPENDENT_ACTION,
|
|
array( $action, $action_args, $prerequisite_action ),
|
|
self::QUEUE_GROUP
|
|
);
|
|
} else {
|
|
self::queue()->schedule_single( time() + 5, $action, $action_args, self::QUEUE_GROUP );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Exclude users that already exist in our customer lookup table.
|
|
*
|
|
* Meant to be hooked into 'pre_user_query' action.
|
|
*
|
|
* @param WP_User_Query $wp_user_query WP_User_Query to modify.
|
|
*/
|
|
public static function exclude_existing_customers_from_query( $wp_user_query ) {
|
|
global $wpdb;
|
|
|
|
$wp_user_query->query_where .= " AND NOT EXISTS (
|
|
SELECT ID FROM {$wpdb->prefix}wc_customer_lookup
|
|
WHERE {$wpdb->prefix}wc_customer_lookup.user_id = {$wpdb->users}.ID
|
|
)";
|
|
}
|
|
|
|
/**
|
|
* Retrieve user IDs given import criteria.
|
|
*
|
|
* @param int|bool $days Number of days to process.
|
|
* @param bool $skip_existing Skip exisiting records.
|
|
* @param array $query_args Optional. WP_User_Query args.
|
|
* @return WP_User_Query
|
|
*/
|
|
public static function get_user_ids_for_batch( $days, $skip_existing, $query_args = array() ) {
|
|
if ( ! is_array( $query_args ) ) {
|
|
$query_args = array();
|
|
}
|
|
|
|
if ( is_int( $days ) ) {
|
|
$query_args['date_query'] = array(
|
|
'after' => date( 'Y-m-d 00:00:00', time() - ( DAY_IN_SECONDS * $days ) ),
|
|
);
|
|
}
|
|
|
|
if ( $skip_existing ) {
|
|
add_action( 'pre_user_query', array( __CLASS__, 'exclude_existing_customers_from_query' ) );
|
|
}
|
|
|
|
$customer_query = new \WP_User_Query( $query_args );
|
|
|
|
remove_action( 'pre_user_query', array( __CLASS__, 'exclude_existing_customers_from_query' ) );
|
|
|
|
return $customer_query;
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
* Init customer lookup table update (in batches).
|
|
*
|
|
* @param int|bool $days Number of days to process.
|
|
* @param bool $skip_existing Skip existing records.
|
|
*/
|
|
public static function customer_lookup_import_batch_init( $days, $skip_existing ) {
|
|
$batch_size = self::get_batch_size( self::CUSTOMERS_IMPORT_BATCH_ACTION );
|
|
$customer_roles = apply_filters( 'woocommerce_admin_import_customer_roles', array( 'customer' ) );
|
|
$customer_query = self::get_user_ids_for_batch(
|
|
$days,
|
|
$skip_existing,
|
|
array(
|
|
'fields' => 'ID',
|
|
'number' => 1,
|
|
'role__in' => $customer_roles,
|
|
)
|
|
);
|
|
$total_customers = $customer_query->get_total();
|
|
|
|
if ( 0 === $total_customers ) {
|
|
return;
|
|
}
|
|
|
|
$num_batches = ceil( $total_customers / $batch_size );
|
|
|
|
self::queue_batches( 1, $num_batches, self::CUSTOMERS_IMPORT_BATCH_ACTION, array( $days, $skip_existing ) );
|
|
}
|
|
|
|
/**
|
|
* Process a batch of customers to update.
|
|
*
|
|
* @param int $batch_number Batch number to process (essentially a query page number).
|
|
* @param int|bool $days Number of days to process.
|
|
* @param bool $skip_existing Skip exisiting records.
|
|
* @return void
|
|
*/
|
|
public static function customer_lookup_import_batch( $batch_number, $days, $skip_existing ) {
|
|
$batch_size = self::get_batch_size( self::CUSTOMERS_IMPORT_BATCH_ACTION );
|
|
|
|
$properties = array(
|
|
'batch_number' => $batch_number,
|
|
'batch_size' => $batch_size,
|
|
'type' => 'customer',
|
|
);
|
|
wc_admin_record_tracks_event( 'import_job_start', $properties );
|
|
|
|
$customer_roles = apply_filters( 'woocommerce_admin_import_customer_roles', array( 'customer' ) );
|
|
// When we are skipping already imported customers, the table of customers to import gets smaller in
|
|
// every batch, so we want to always import the first page.
|
|
$page = $skip_existing ? 1 : $batch_number;
|
|
$customer_query = self::get_user_ids_for_batch(
|
|
$days,
|
|
$skip_existing,
|
|
array(
|
|
'fields' => 'ID',
|
|
'orderby' => 'ID',
|
|
'order' => 'ASC',
|
|
'number' => $batch_size,
|
|
'paged' => $page,
|
|
'role__in' => $customer_roles,
|
|
)
|
|
);
|
|
|
|
$customer_ids = $customer_query->get_results();
|
|
|
|
foreach ( $customer_ids as $customer_id ) {
|
|
// @todo Schedule single customer update if this fails?
|
|
self::customer_lookup_import_customer( $customer_id );
|
|
}
|
|
|
|
$imported_count = get_option( 'wc_admin_import_customers_count', 0 );
|
|
update_option( 'wc_admin_import_customers_count', $imported_count + count( $customer_ids ) );
|
|
|
|
$properties['imported_count'] = $imported_count;
|
|
|
|
wc_admin_record_tracks_event( 'import_job_complete', $properties );
|
|
}
|
|
|
|
/**
|
|
* Schedule an action to import a single Customer.
|
|
*
|
|
* @param int $user_id User ID.
|
|
* @return void
|
|
*/
|
|
public static function schedule_single_customer_import( $user_id ) {
|
|
// This can get called multiple times for a single customer, so we look
|
|
// for existing pending jobs for the same customer to avoid duplicating efforts.
|
|
$existing_jobs = self::queue()->search(
|
|
array(
|
|
'status' => 'pending',
|
|
'per_page' => 1,
|
|
'claimed' => false,
|
|
'hook' => self::SINGLE_CUSTOMER_IMPORT_ACTION,
|
|
'args' => array( $user_id ),
|
|
'group' => self::QUEUE_GROUP,
|
|
)
|
|
);
|
|
|
|
if ( $existing_jobs ) {
|
|
// Bail out if there's a pending single customer action.
|
|
return;
|
|
}
|
|
|
|
self::queue()->schedule_single( time() + 5, self::SINGLE_CUSTOMER_IMPORT_ACTION, array( $user_id ), self::QUEUE_GROUP );
|
|
}
|
|
|
|
/**
|
|
* Imports a single customer to update lookup tables for.
|
|
*
|
|
* @param int $user_id User ID.
|
|
* @return void
|
|
*/
|
|
public static function customer_lookup_import_customer( $user_id ) {
|
|
CustomersDataStore::update_registered_customer( $user_id );
|
|
}
|
|
|
|
/**
|
|
* Delete customer lookup table rows (in batches).
|
|
*/
|
|
public static function customer_lookup_delete_batch_init() {
|
|
global $wpdb;
|
|
$batch_size = self::get_batch_size( self::CUSTOMERS_DELETE_BATCH_ACTION );
|
|
$count = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->prefix}wc_customer_lookup" );
|
|
|
|
if ( 0 === $count ) {
|
|
return;
|
|
}
|
|
|
|
$num_batches = ceil( $count / $batch_size );
|
|
|
|
self::queue_batches( 1, $num_batches, self::CUSTOMERS_DELETE_BATCH_ACTION );
|
|
}
|
|
|
|
/**
|
|
* Delete a batch of customers.
|
|
*/
|
|
public static function customer_lookup_delete_batch() {
|
|
global $wpdb;
|
|
|
|
wc_admin_record_tracks_event( 'delete_import_data_job_start', array( 'type' => 'customer' ) );
|
|
|
|
$batch_size = self::get_batch_size( self::CUSTOMERS_DELETE_BATCH_ACTION );
|
|
$customer_ids = $wpdb->get_col(
|
|
$wpdb->prepare(
|
|
"SELECT customer_id FROM {$wpdb->prefix}wc_customer_lookup ORDER BY customer_id ASC LIMIT %d",
|
|
$batch_size
|
|
)
|
|
);
|
|
|
|
foreach ( $customer_ids as $customer_id ) {
|
|
CustomersDataStore::delete_customer( $customer_id );
|
|
}
|
|
|
|
wc_admin_record_tracks_event( 'delete_import_data_job_complete', array( 'type' => 'customer' ) );
|
|
}
|
|
|
|
/**
|
|
* Delete orders lookup table rows (in batches).
|
|
*/
|
|
public static function orders_lookup_delete_batch_init() {
|
|
global $wpdb;
|
|
$batch_size = self::get_batch_size( self::ORDERS_DELETE_BATCH_ACTION );
|
|
$count = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->prefix}wc_order_stats" );
|
|
|
|
if ( 0 === $count ) {
|
|
return;
|
|
}
|
|
|
|
$num_batches = ceil( $count / $batch_size );
|
|
|
|
self::queue_batches( 1, $num_batches, self::ORDERS_DELETE_BATCH_ACTION );
|
|
}
|
|
|
|
/**
|
|
* Delete a batch of orders.
|
|
*
|
|
* @return void
|
|
*/
|
|
public static function orders_lookup_delete_batch() {
|
|
global $wpdb;
|
|
|
|
wc_admin_record_tracks_event( 'delete_import_data_job_start', array( 'type' => 'order' ) );
|
|
|
|
$batch_size = self::get_batch_size( self::ORDERS_DELETE_BATCH_ACTION );
|
|
$order_ids = $wpdb->get_col(
|
|
$wpdb->prepare(
|
|
"SELECT order_id FROM {$wpdb->prefix}wc_order_stats ORDER BY order_id ASC LIMIT %d",
|
|
$batch_size
|
|
)
|
|
);
|
|
|
|
foreach ( $order_ids as $order_id ) {
|
|
OrdersStatsDataStore::delete_order( $order_id );
|
|
}
|
|
|
|
wc_admin_record_tracks_event( 'delete_import_data_job_complete', array( 'type' => 'order' ) );
|
|
}
|
|
}
|