first commit
This commit is contained in:
Rachit Bhargava
@@ -0,0 +1,197 @@
|
||||
<?php
|
||||
/**
|
||||
* CustomMetaDataStore class file.
|
||||
*/
|
||||
|
||||
namespace Automattic\WooCommerce\Internal\DataStores;
|
||||
|
||||
/**
|
||||
* Implements functions similar to WP's add_metadata(), get_metadata(), and friends using a custom table.
|
||||
*
|
||||
* @see WC_Data_Store_WP For an implementation using WP's metadata functions and tables.
|
||||
*/
|
||||
abstract class CustomMetaDataStore {
|
||||
|
||||
/**
|
||||
* Returns the name of the table used for storage.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
abstract protected function get_table_name();
|
||||
|
||||
/**
|
||||
* Returns the name of the field/column used for identifiying metadata entries.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
protected function get_meta_id_field() {
|
||||
return 'id';
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the name of the field/column used for associating meta with objects.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
protected function get_object_id_field() {
|
||||
return 'object_id';
|
||||
}
|
||||
|
||||
/**
|
||||
* Describes the structure of the metadata table.
|
||||
*
|
||||
* @return array Array elements: table, object_id_field, meta_id_field.
|
||||
*/
|
||||
protected function get_db_info() {
|
||||
return array(
|
||||
'table' => $this->get_table_name(),
|
||||
'meta_id_field' => $this->get_meta_id_field(),
|
||||
'object_id_field' => $this->get_object_id_field(),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns an array of meta for an object.
|
||||
*
|
||||
* @param WC_Data $object WC_Data object.
|
||||
* @return array
|
||||
*/
|
||||
public function read_meta( &$object ) {
|
||||
global $wpdb;
|
||||
|
||||
$db_info = $this->get_db_info();
|
||||
|
||||
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
|
||||
$raw_meta_data = $wpdb->get_results(
|
||||
$wpdb->prepare(
|
||||
"SELECT {$db_info['meta_id_field']} AS meta_id, meta_key, meta_value FROM {$db_info['table']} WHERE {$db_info['object_id_field']} = %d ORDER BY meta_id",
|
||||
$object->get_id()
|
||||
)
|
||||
);
|
||||
// phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
|
||||
|
||||
return $raw_meta_data;
|
||||
}
|
||||
|
||||
/**
|
||||
* Deletes meta based on meta ID.
|
||||
*
|
||||
* @param WC_Data $object WC_Data object.
|
||||
* @param stdClass $meta (containing at least ->id).
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function delete_meta( &$object, $meta ) {
|
||||
global $wpdb;
|
||||
|
||||
if ( ! isset( $meta->id ) ) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$db_info = $this->get_db_info();
|
||||
$meta_id = absint( $meta->id );
|
||||
|
||||
return (bool) $wpdb->delete( $db_info['table'], array( $db_info['meta_id_field'] => $meta_id ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* Add new piece of meta.
|
||||
*
|
||||
* @param WC_Data $object WC_Data object.
|
||||
* @param stdClass $meta (containing ->key and ->value).
|
||||
* @return int meta ID
|
||||
*/
|
||||
public function add_meta( &$object, $meta ) {
|
||||
global $wpdb;
|
||||
|
||||
$db_info = $this->get_db_info();
|
||||
|
||||
$object_id = $object->get_id();
|
||||
$meta_key = wp_unslash( wp_slash( $meta->key ) );
|
||||
$meta_value = maybe_serialize( is_string( $meta->value ) ? wp_unslash( wp_slash( $meta->value ) ) : $meta->value );
|
||||
|
||||
// phpcs:disable WordPress.DB.SlowDBQuery.slow_db_query_meta_value,WordPress.DB.SlowDBQuery.slow_db_query_meta_key
|
||||
$result = $wpdb->insert(
|
||||
$db_info['table'],
|
||||
array(
|
||||
$db_info['object_id_field'] => $object_id,
|
||||
'meta_key' => $meta_key,
|
||||
'meta_value' => $meta_value,
|
||||
)
|
||||
);
|
||||
// phpcs:enable WordPress.DB.SlowDBQuery.slow_db_query_meta_value,WordPress.DB.SlowDBQuery.slow_db_query_meta_key
|
||||
|
||||
return $result ? (int) $wpdb->insert_id : false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Update meta.
|
||||
*
|
||||
* @param WC_Data $object WC_Data object.
|
||||
* @param stdClass $meta (containing ->id, ->key and ->value).
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function update_meta( &$object, $meta ) {
|
||||
global $wpdb;
|
||||
|
||||
if ( ! isset( $meta->id ) || empty( $meta->key ) ) {
|
||||
return false;
|
||||
}
|
||||
|
||||
// phpcs:disable WordPress.DB.SlowDBQuery.slow_db_query_meta_value,WordPress.DB.SlowDBQuery.slow_db_query_meta_key
|
||||
$data = array(
|
||||
'meta_key' => $meta->key,
|
||||
'meta_value' => maybe_serialize( $meta->value ),
|
||||
);
|
||||
// phpcs:enable WordPress.DB.SlowDBQuery.slow_db_query_meta_value,WordPress.DB.SlowDBQuery.slow_db_query_meta_key
|
||||
|
||||
$db_info = $this->get_db_info();
|
||||
|
||||
$result = $wpdb->update(
|
||||
$db_info['table'],
|
||||
$data,
|
||||
array( $db_info['meta_id_field'] => $meta->id ),
|
||||
'%s',
|
||||
'%d'
|
||||
);
|
||||
|
||||
return 1 === $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves metadata by meta ID.
|
||||
*
|
||||
* @param int $meta_id Meta ID.
|
||||
* @return object|bool Metadata object or FALSE if not found.
|
||||
*/
|
||||
public function get_metadata_by_id( $meta_id ) {
|
||||
global $wpdb;
|
||||
|
||||
if ( ! is_numeric( $meta_id ) || floor( $meta_id ) != $meta_id ) { // phpcs:ignore WordPress.PHP.StrictComparisons.LooseComparison
|
||||
return false;
|
||||
}
|
||||
|
||||
$db_info = $this->get_db_info();
|
||||
|
||||
$meta_id = absint( $meta_id );
|
||||
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
|
||||
$meta = $wpdb->get_row(
|
||||
$wpdb->prepare(
|
||||
"SELECT {$db_info['meta_id_field']}, meta_key, meta_value, {$db_info['object_id_field']} FROM {$db_info['table']} WHERE {$db_info['meta_id_field']} = %d",
|
||||
$meta_id
|
||||
)
|
||||
);
|
||||
// phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
|
||||
|
||||
if ( empty( $meta ) ) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if ( isset( $meta->meta_value ) ) {
|
||||
$meta->meta_value = maybe_unserialize( $meta->meta_value );
|
||||
}
|
||||
|
||||
return $meta;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,610 @@
|
||||
<?php
|
||||
/**
|
||||
* CustomOrdersTableController class file.
|
||||
*/
|
||||
|
||||
namespace Automattic\WooCommerce\Internal\DataStores\Orders;
|
||||
|
||||
use Automattic\WooCommerce\Caches\OrderCache;
|
||||
use Automattic\WooCommerce\Caches\OrderCacheController;
|
||||
use Automattic\WooCommerce\Internal\BatchProcessing\BatchProcessingController;
|
||||
use Automattic\WooCommerce\Internal\Features\FeaturesController;
|
||||
use Automattic\WooCommerce\Internal\Traits\AccessiblePrivateMethods;
|
||||
use Automattic\WooCommerce\Utilities\OrderUtil;
|
||||
|
||||
defined( 'ABSPATH' ) || exit;
|
||||
|
||||
/**
|
||||
* This is the main class that controls the custom orders tables feature. Its responsibilities are:
|
||||
*
|
||||
* - Allowing to enable and disable the feature while it's in development (show_feature method)
|
||||
* - Displaying UI components (entries in the tools page and in settings)
|
||||
* - Providing the proper data store for orders via 'woocommerce_order_data_store' hook
|
||||
*
|
||||
* ...and in general, any functionality that doesn't imply database access.
|
||||
*/
|
||||
class CustomOrdersTableController {
|
||||
|
||||
use AccessiblePrivateMethods;
|
||||
|
||||
/**
|
||||
* The name of the option for enabling the usage of the custom orders tables
|
||||
*/
|
||||
public const CUSTOM_ORDERS_TABLE_USAGE_ENABLED_OPTION = 'woocommerce_custom_orders_table_enabled';
|
||||
|
||||
/**
|
||||
* The name of the option that tells that the authoritative table must be flipped once sync finishes.
|
||||
*/
|
||||
private const AUTO_FLIP_AUTHORITATIVE_TABLE_ROLES_OPTION = 'woocommerce_auto_flip_authoritative_table_roles';
|
||||
|
||||
/**
|
||||
* The name of the option that tells whether database transactions are to be used or not for data synchronization.
|
||||
*/
|
||||
public const USE_DB_TRANSACTIONS_OPTION = 'woocommerce_use_db_transactions_for_custom_orders_table_data_sync';
|
||||
|
||||
/**
|
||||
* The name of the option to store the transaction isolation level to use when database transactions are enabled.
|
||||
*/
|
||||
public const DB_TRANSACTIONS_ISOLATION_LEVEL_OPTION = 'woocommerce_db_transactions_isolation_level_for_custom_orders_table_data_sync';
|
||||
|
||||
public const DEFAULT_DB_TRANSACTIONS_ISOLATION_LEVEL = 'REPEATABLE READ';
|
||||
|
||||
/**
|
||||
* The data store object to use.
|
||||
*
|
||||
* @var OrdersTableDataStore
|
||||
*/
|
||||
private $data_store;
|
||||
|
||||
/**
|
||||
* Refunds data store object to use.
|
||||
*
|
||||
* @var OrdersTableRefundDataStore
|
||||
*/
|
||||
private $refund_data_store;
|
||||
|
||||
/**
|
||||
* The data synchronizer object to use.
|
||||
*
|
||||
* @var DataSynchronizer
|
||||
*/
|
||||
private $data_synchronizer;
|
||||
|
||||
/**
|
||||
* The batch processing controller to use.
|
||||
*
|
||||
* @var BatchProcessingController
|
||||
*/
|
||||
private $batch_processing_controller;
|
||||
|
||||
/**
|
||||
* The features controller to use.
|
||||
*
|
||||
* @var FeaturesController
|
||||
*/
|
||||
private $features_controller;
|
||||
|
||||
/**
|
||||
* The orders cache object to use.
|
||||
*
|
||||
* @var OrderCache
|
||||
*/
|
||||
private $order_cache;
|
||||
|
||||
/**
|
||||
* The orders cache controller object to use.
|
||||
*
|
||||
* @var OrderCacheController
|
||||
*/
|
||||
private $order_cache_controller;
|
||||
|
||||
/**
|
||||
* Class constructor.
|
||||
*/
|
||||
public function __construct() {
|
||||
$this->init_hooks();
|
||||
}
|
||||
|
||||
/**
|
||||
* Initialize the hooks used by the class.
|
||||
*/
|
||||
private function init_hooks() {
|
||||
self::add_filter( 'woocommerce_order_data_store', array( $this, 'get_orders_data_store' ), 999, 1 );
|
||||
self::add_filter( 'woocommerce_order-refund_data_store', array( $this, 'get_refunds_data_store' ), 999, 1 );
|
||||
self::add_filter( 'woocommerce_debug_tools', array( $this, 'add_initiate_regeneration_entry_to_tools_array' ), 999, 1 );
|
||||
self::add_filter( 'woocommerce_get_sections_advanced', array( $this, 'get_settings_sections' ), 999, 1 );
|
||||
self::add_filter( 'woocommerce_get_settings_advanced', array( $this, 'get_settings' ), 999, 2 );
|
||||
self::add_filter( 'updated_option', array( $this, 'process_updated_option' ), 999, 3 );
|
||||
self::add_filter( 'pre_update_option', array( $this, 'process_pre_update_option' ), 999, 3 );
|
||||
self::add_filter( DataSynchronizer::PENDING_SYNCHRONIZATION_FINISHED_ACTION, array( $this, 'process_sync_finished' ), 10, 0 );
|
||||
self::add_action( 'woocommerce_update_options_advanced_custom_data_stores', array( $this, 'process_options_updated' ), 10, 0 );
|
||||
self::add_action( 'woocommerce_after_register_post_type', array( $this, 'register_post_type_for_order_placeholders' ), 10, 0 );
|
||||
self::add_action( FeaturesController::FEATURE_ENABLED_CHANGED_ACTION, array( $this, 'handle_feature_enabled_changed' ), 10, 2 );
|
||||
}
|
||||
|
||||
/**
|
||||
* Class initialization, invoked by the DI container.
|
||||
*
|
||||
* @internal
|
||||
* @param OrdersTableDataStore $data_store The data store to use.
|
||||
* @param DataSynchronizer $data_synchronizer The data synchronizer to use.
|
||||
* @param OrdersTableRefundDataStore $refund_data_store The refund data store to use.
|
||||
* @param BatchProcessingController $batch_processing_controller The batch processing controller to use.
|
||||
* @param FeaturesController $features_controller The features controller instance to use.
|
||||
* @param OrderCache $order_cache The order cache engine to use.
|
||||
* @param OrderCacheController $order_cache_controller The order cache controller to use.
|
||||
*/
|
||||
final public function init(
|
||||
OrdersTableDataStore $data_store,
|
||||
DataSynchronizer $data_synchronizer,
|
||||
OrdersTableRefundDataStore $refund_data_store,
|
||||
BatchProcessingController $batch_processing_controller,
|
||||
FeaturesController $features_controller,
|
||||
OrderCache $order_cache,
|
||||
OrderCacheController $order_cache_controller ) {
|
||||
$this->data_store = $data_store;
|
||||
$this->data_synchronizer = $data_synchronizer;
|
||||
$this->batch_processing_controller = $batch_processing_controller;
|
||||
$this->refund_data_store = $refund_data_store;
|
||||
$this->features_controller = $features_controller;
|
||||
$this->order_cache = $order_cache;
|
||||
$this->order_cache_controller = $order_cache_controller;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if the feature is visible (so that dedicated entries will be added to the debug tools page).
|
||||
*
|
||||
* @return bool True if the feature is visible.
|
||||
*/
|
||||
public function is_feature_visible(): bool {
|
||||
return $this->features_controller->feature_is_enabled( 'custom_order_tables' );
|
||||
}
|
||||
|
||||
/**
|
||||
* Makes the feature visible, so that dedicated entries will be added to the debug tools page.
|
||||
*
|
||||
* This method shouldn't be used anymore, see the FeaturesController class.
|
||||
*/
|
||||
public function show_feature() {
|
||||
$class_and_method = ( new \ReflectionClass( $this ) )->getShortName() . '::' . __FUNCTION__;
|
||||
wc_doing_it_wrong(
|
||||
$class_and_method,
|
||||
sprintf(
|
||||
// translators: %1$s the name of the class and method used.
|
||||
__( '%1$s: The visibility of the custom orders table feature is now handled by the WooCommerce features engine. See the FeaturesController class, or go to WooCommerce - Settings - Advanced - Features.', 'woocommerce' ),
|
||||
$class_and_method
|
||||
),
|
||||
'7.0'
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Hides the feature, so that no entries will be added to the debug tools page.
|
||||
*
|
||||
* This method shouldn't be used anymore, see the FeaturesController class.
|
||||
*/
|
||||
public function hide_feature() {
|
||||
$class_and_method = ( new \ReflectionClass( $this ) )->getShortName() . '::' . __FUNCTION__;
|
||||
wc_doing_it_wrong(
|
||||
$class_and_method,
|
||||
sprintf(
|
||||
// translators: %1$s the name of the class and method used.
|
||||
__( '%1$s: The visibility of the custom orders table feature is now handled by the WooCommerce features engine. See the FeaturesController class, or go to WooCommerce - Settings - Advanced - Features.', 'woocommerce' ),
|
||||
$class_and_method
|
||||
),
|
||||
'7.0'
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Is the custom orders table usage enabled via settings?
|
||||
* This can be true only if the feature is enabled and a table regeneration has been completed.
|
||||
*
|
||||
* @return bool True if the custom orders table usage is enabled
|
||||
*/
|
||||
public function custom_orders_table_usage_is_enabled(): bool {
|
||||
return $this->is_feature_visible() && get_option( self::CUSTOM_ORDERS_TABLE_USAGE_ENABLED_OPTION ) === 'yes';
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the instance of the orders data store to use.
|
||||
*
|
||||
* @param \WC_Object_Data_Store_Interface|string $default_data_store The default data store (as received via the woocommerce_order_data_store hook).
|
||||
*
|
||||
* @return \WC_Object_Data_Store_Interface|string The actual data store to use.
|
||||
*/
|
||||
private function get_orders_data_store( $default_data_store ) {
|
||||
return $this->get_data_store_instance( $default_data_store, 'order' );
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the instance of the refunds data store to use.
|
||||
*
|
||||
* @param \WC_Object_Data_Store_Interface|string $default_data_store The default data store (as received via the woocommerce_order-refund_data_store hook).
|
||||
*
|
||||
* @return \WC_Object_Data_Store_Interface|string The actual data store to use.
|
||||
*/
|
||||
private function get_refunds_data_store( $default_data_store ) {
|
||||
return $this->get_data_store_instance( $default_data_store, 'order_refund' );
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the instance of a given data store.
|
||||
*
|
||||
* @param \WC_Object_Data_Store_Interface|string $default_data_store The default data store (as received via the appropriate hooks).
|
||||
* @param string $type The type of the data store to get.
|
||||
*
|
||||
* @return \WC_Object_Data_Store_Interface|string The actual data store to use.
|
||||
*/
|
||||
private function get_data_store_instance( $default_data_store, string $type ) {
|
||||
if ( $this->custom_orders_table_usage_is_enabled() ) {
|
||||
switch ( $type ) {
|
||||
case 'order_refund':
|
||||
return $this->refund_data_store;
|
||||
default:
|
||||
return $this->data_store;
|
||||
}
|
||||
} else {
|
||||
return $default_data_store;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Add an entry to Status - Tools to create or regenerate the custom orders table,
|
||||
* and also an entry to delete the table as appropriate.
|
||||
*
|
||||
* @param array $tools_array The array of tools to add the tool to.
|
||||
* @return array The updated array of tools-
|
||||
*/
|
||||
private function add_initiate_regeneration_entry_to_tools_array( array $tools_array ): array {
|
||||
if ( ! $this->data_synchronizer->check_orders_table_exists() ) {
|
||||
return $tools_array;
|
||||
}
|
||||
|
||||
if ( $this->is_feature_visible() ) {
|
||||
$disabled = true;
|
||||
$message = __( 'This will delete the custom orders tables. The tables can be deleted only if the "High-Performance order storage" feature is disabled (via Settings > Advanced > Features).', 'woocommerce' );
|
||||
} else {
|
||||
$disabled = false;
|
||||
$message = __( 'This will delete the custom orders tables. To create them again enable the "High-Performance order storage" feature (via Settings > Advanced > Features).', 'woocommerce' );
|
||||
}
|
||||
|
||||
$tools_array['delete_custom_orders_table'] = array(
|
||||
'name' => __( 'Delete the custom orders tables', 'woocommerce' ),
|
||||
'desc' => sprintf(
|
||||
'<strong class="red">%1$s</strong> %2$s',
|
||||
__( 'Note:', 'woocommerce' ),
|
||||
$message
|
||||
),
|
||||
'requires_refresh' => true,
|
||||
'callback' => function () {
|
||||
$this->features_controller->change_feature_enable( 'custom_order_tables', false );
|
||||
$this->delete_custom_orders_tables();
|
||||
return __( 'Custom orders tables have been deleted.', 'woocommerce' );
|
||||
},
|
||||
'button' => __( 'Delete', 'woocommerce' ),
|
||||
'disabled' => $disabled,
|
||||
);
|
||||
|
||||
return $tools_array;
|
||||
}
|
||||
|
||||
/**
|
||||
* Create the custom orders tables in response to the user pressing the tool button.
|
||||
*
|
||||
* @param bool $verify_nonce True to perform the nonce verification, false to skip it.
|
||||
*
|
||||
* @throws \Exception Can't create the tables.
|
||||
*/
|
||||
private function create_custom_orders_tables( bool $verify_nonce = true ) {
|
||||
// phpcs:ignore WordPress.Security.ValidatedSanitizedInput
|
||||
if ( $verify_nonce && ( ! isset( $_REQUEST['_wpnonce'] ) || wp_verify_nonce( $_REQUEST['_wpnonce'], 'debug_action' ) === false ) ) {
|
||||
throw new \Exception( 'Invalid nonce' );
|
||||
}
|
||||
|
||||
$this->data_synchronizer->create_database_tables();
|
||||
update_option( self::CUSTOM_ORDERS_TABLE_USAGE_ENABLED_OPTION, 'no' );
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete the custom orders tables and any related options and data in response to the user pressing the tool button.
|
||||
*
|
||||
* @throws \Exception Can't delete the tables.
|
||||
*/
|
||||
private function delete_custom_orders_tables() {
|
||||
if ( $this->custom_orders_table_usage_is_enabled() ) {
|
||||
throw new \Exception( "Can't delete the custom orders tables: they are currently in use (via Settings > Advanced > Custom data stores)." );
|
||||
}
|
||||
|
||||
delete_option( self::CUSTOM_ORDERS_TABLE_USAGE_ENABLED_OPTION );
|
||||
$this->data_synchronizer->delete_database_tables();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the settings sections for the "Advanced" tab, with a "Custom data stores" section added if appropriate.
|
||||
*
|
||||
* @param array $sections The original settings sections array.
|
||||
* @return array The updated settings sections array.
|
||||
*/
|
||||
private function get_settings_sections( array $sections ): array {
|
||||
if ( ! $this->is_feature_visible() ) {
|
||||
return $sections;
|
||||
}
|
||||
|
||||
$sections['custom_data_stores'] = __( 'Custom data stores', 'woocommerce' );
|
||||
|
||||
return $sections;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the settings for the "Custom data stores" section in the "Advanced" tab,
|
||||
* with entries for managing the custom orders tables if appropriate.
|
||||
*
|
||||
* @param array $settings The original settings array.
|
||||
* @param string $section_id The settings section to get the settings for.
|
||||
* @return array The updated settings array.
|
||||
*/
|
||||
private function get_settings( array $settings, string $section_id ): array {
|
||||
if ( ! $this->is_feature_visible() || 'custom_data_stores' !== $section_id ) {
|
||||
return $settings;
|
||||
}
|
||||
|
||||
$settings[] = array(
|
||||
'title' => __( 'Custom orders tables', 'woocommerce' ),
|
||||
'type' => 'title',
|
||||
'id' => 'cot-title',
|
||||
'desc' => sprintf(
|
||||
/* translators: %1$s = <strong> tag, %2$s = </strong> tag. */
|
||||
__( '%1$sWARNING:%2$s This feature is currently under development and may cause database instability. For contributors only.', 'woocommerce' ),
|
||||
'<strong>',
|
||||
'</strong>'
|
||||
),
|
||||
);
|
||||
|
||||
$sync_status = $this->data_synchronizer->get_sync_status();
|
||||
$sync_is_pending = 0 !== $sync_status['current_pending_count'];
|
||||
|
||||
$settings[] = array(
|
||||
'title' => __( 'Data store for orders', 'woocommerce' ),
|
||||
'id' => self::CUSTOM_ORDERS_TABLE_USAGE_ENABLED_OPTION,
|
||||
'default' => 'no',
|
||||
'type' => 'radio',
|
||||
'options' => array(
|
||||
'yes' => __( 'Use the WooCommerce orders tables', 'woocommerce' ),
|
||||
'no' => __( 'Use the WordPress posts table', 'woocommerce' ),
|
||||
),
|
||||
'checkboxgroup' => 'start',
|
||||
'disabled' => $sync_is_pending ? array( 'yes', 'no' ) : array(),
|
||||
);
|
||||
|
||||
if ( $sync_is_pending ) {
|
||||
$initial_pending_count = $sync_status['initial_pending_count'];
|
||||
$current_pending_count = $sync_status['current_pending_count'];
|
||||
if ( $initial_pending_count ) {
|
||||
$text =
|
||||
sprintf(
|
||||
/* translators: %1$s=current number of orders pending sync, %2$s=initial number of orders pending sync */
|
||||
_n( 'There\'s %1$s order (out of a total of %2$s) pending sync!', 'There are %1$s orders (out of a total of %2$s) pending sync!', $current_pending_count, 'woocommerce' ),
|
||||
$current_pending_count,
|
||||
$initial_pending_count
|
||||
);
|
||||
} else {
|
||||
$text =
|
||||
/* translators: %s=initial number of orders pending sync */
|
||||
sprintf( _n( 'There\'s %s order pending sync!', 'There are %s orders pending sync!', $current_pending_count, 'woocommerce' ), $current_pending_count, 'woocommerce' );
|
||||
}
|
||||
|
||||
if ( $this->batch_processing_controller->is_enqueued( get_class( $this->data_synchronizer ) ) ) {
|
||||
$text .= __( "<br/>Synchronization for these orders is currently in progress.<br/>The authoritative table can't be changed until sync completes.", 'woocommerce' );
|
||||
} else {
|
||||
$text .= __( "<br/>The authoritative table can't be changed until these orders are synchronized.", 'woocommerce' );
|
||||
}
|
||||
|
||||
$settings[] = array(
|
||||
'type' => 'info',
|
||||
'id' => 'cot-out-of-sync-warning',
|
||||
'css' => 'color: #C00000',
|
||||
'text' => $text,
|
||||
);
|
||||
}
|
||||
|
||||
$settings[] = array(
|
||||
'desc' => __( 'Keep the posts table and the orders tables synchronized', 'woocommerce' ),
|
||||
'id' => DataSynchronizer::ORDERS_DATA_SYNC_ENABLED_OPTION,
|
||||
'type' => 'checkbox',
|
||||
);
|
||||
|
||||
if ( $sync_is_pending ) {
|
||||
if ( $this->data_synchronizer->data_sync_is_enabled() ) {
|
||||
$message = $this->custom_orders_table_usage_is_enabled() ?
|
||||
__( 'Switch to using the posts table as the authoritative data store for orders when sync finishes', 'woocommerce' ) :
|
||||
__( 'Switch to using the orders table as the authoritative data store for orders when sync finishes', 'woocommerce' );
|
||||
$settings[] = array(
|
||||
'desc' => $message,
|
||||
'id' => self::AUTO_FLIP_AUTHORITATIVE_TABLE_ROLES_OPTION,
|
||||
'type' => 'checkbox',
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
$settings[] = array(
|
||||
'desc' => __( 'Use database transactions for the orders data synchronization', 'woocommerce' ),
|
||||
'id' => self::USE_DB_TRANSACTIONS_OPTION,
|
||||
'type' => 'checkbox',
|
||||
);
|
||||
|
||||
$isolation_level_names = self::get_valid_transaction_isolation_levels();
|
||||
$settings[] = array(
|
||||
'desc' => __( 'Database transaction isolation level to use', 'woocommerce' ),
|
||||
'id' => self::DB_TRANSACTIONS_ISOLATION_LEVEL_OPTION,
|
||||
'type' => 'select',
|
||||
'options' => array_combine( $isolation_level_names, $isolation_level_names ),
|
||||
'default' => self::DEFAULT_DB_TRANSACTIONS_ISOLATION_LEVEL,
|
||||
);
|
||||
|
||||
$settings[] = array( 'type' => 'sectionend' );
|
||||
|
||||
return $settings;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the valid database transaction isolation level names.
|
||||
*
|
||||
* @return string[]
|
||||
*/
|
||||
public static function get_valid_transaction_isolation_levels() {
|
||||
return array(
|
||||
'REPEATABLE READ',
|
||||
'READ COMMITTED',
|
||||
'READ UNCOMMITTED',
|
||||
'SERIALIZABLE',
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Handler for the individual setting updated hook.
|
||||
*
|
||||
* @param string $option Setting name.
|
||||
* @param mixed $old_value Old value of the setting.
|
||||
* @param mixed $value New value of the setting.
|
||||
*/
|
||||
private function process_updated_option( $option, $old_value, $value ) {
|
||||
if ( DataSynchronizer::ORDERS_DATA_SYNC_ENABLED_OPTION === $option && 'no' === $value ) {
|
||||
$this->data_synchronizer->cleanup_synchronization_state();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Handler for the setting pre-update hook.
|
||||
* We use it to verify that authoritative orders table switch doesn't happen while sync is pending.
|
||||
*
|
||||
* @param mixed $value New value of the setting.
|
||||
* @param string $option Setting name.
|
||||
* @param mixed $old_value Old value of the setting.
|
||||
*
|
||||
* @throws \Exception Attempt to change the authoritative orders table while orders sync is pending.
|
||||
*/
|
||||
private function process_pre_update_option( $value, $option, $old_value ) {
|
||||
if ( DataSynchronizer::ORDERS_DATA_SYNC_ENABLED_OPTION === $option && $value !== $old_value ) {
|
||||
$this->order_cache->flush();
|
||||
return $value;
|
||||
}
|
||||
|
||||
if ( self::CUSTOM_ORDERS_TABLE_USAGE_ENABLED_OPTION !== $option || $value === $old_value || false === $old_value ) {
|
||||
return $value;
|
||||
}
|
||||
|
||||
$this->order_cache->flush();
|
||||
|
||||
/**
|
||||
* Re-enable the following code once the COT to posts table sync is implemented (it's currently commented out to ease testing).
|
||||
$sync_is_pending = 0 !== $this->data_synchronizer->get_current_orders_pending_sync_count();
|
||||
if ( $sync_is_pending ) {
|
||||
throw new \Exception( "The authoritative table for orders storage can't be changed while there are orders out of sync" );
|
||||
}
|
||||
*/
|
||||
|
||||
return $value;
|
||||
}
|
||||
|
||||
/**
|
||||
* Handler for the synchronization finished hook.
|
||||
* Here we switch the authoritative table if needed.
|
||||
*/
|
||||
private function process_sync_finished() {
|
||||
if ( ! $this->auto_flip_authoritative_table_enabled() ) {
|
||||
return;
|
||||
}
|
||||
|
||||
update_option( self::AUTO_FLIP_AUTHORITATIVE_TABLE_ROLES_OPTION, 'no' );
|
||||
|
||||
if ( $this->custom_orders_table_usage_is_enabled() ) {
|
||||
update_option( self::CUSTOM_ORDERS_TABLE_USAGE_ENABLED_OPTION, 'no' );
|
||||
} else {
|
||||
update_option( self::CUSTOM_ORDERS_TABLE_USAGE_ENABLED_OPTION, 'yes' );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Is the automatic authoritative table switch setting set?
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
private function auto_flip_authoritative_table_enabled(): bool {
|
||||
return get_option( self::AUTO_FLIP_AUTHORITATIVE_TABLE_ROLES_OPTION ) === 'yes';
|
||||
}
|
||||
|
||||
/**
|
||||
* Handler for the all settings updated hook.
|
||||
*/
|
||||
private function process_options_updated() {
|
||||
$data_sync_is_enabled = $this->data_synchronizer->data_sync_is_enabled();
|
||||
|
||||
// Disabling the sync implies disabling the automatic authoritative table switch too.
|
||||
if ( ! $data_sync_is_enabled && $this->auto_flip_authoritative_table_enabled() ) {
|
||||
update_option( self::AUTO_FLIP_AUTHORITATIVE_TABLE_ROLES_OPTION, 'no' );
|
||||
}
|
||||
|
||||
// Enabling/disabling the sync implies starting/stopping it too, if needed.
|
||||
// We do this check here, and not in process_pre_update_option, so that if for some reason
|
||||
// the setting is enabled but no sync is in process, sync will start by just saving the
|
||||
// settings even without modifying them (and the opposite: sync will be stopped if for
|
||||
// some reason it was ongoing while it was disabled).
|
||||
if ( $data_sync_is_enabled ) {
|
||||
$this->batch_processing_controller->enqueue_processor( DataSynchronizer::class );
|
||||
} else {
|
||||
$this->batch_processing_controller->remove_processor( DataSynchronizer::class );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Handle the 'woocommerce_feature_enabled_changed' action,
|
||||
* if the custom orders table feature is enabled create the database tables if they don't exist.
|
||||
*
|
||||
* @param string $feature_id The id of the feature that is being enabled or disabled.
|
||||
* @param bool $is_enabled True if the feature is being enabled, false if it's being disabled.
|
||||
*/
|
||||
private function handle_feature_enabled_changed( $feature_id, $is_enabled ): void {
|
||||
if ( 'custom_order_tables' !== $feature_id || ! $is_enabled ) {
|
||||
return;
|
||||
}
|
||||
|
||||
if ( ! $this->data_synchronizer->check_orders_table_exists() ) {
|
||||
update_option( DataSynchronizer::ORDERS_DATA_SYNC_ENABLED_OPTION, 'no' );
|
||||
$this->create_custom_orders_tables( false );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Handler for the woocommerce_after_register_post_type post,
|
||||
* registers the post type for placeholder orders.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
private function register_post_type_for_order_placeholders(): void {
|
||||
wc_register_order_type(
|
||||
DataSynchronizer::PLACEHOLDER_ORDER_POST_TYPE,
|
||||
array(
|
||||
'public' => false,
|
||||
'exclude_from_search' => true,
|
||||
'publicly_queryable' => false,
|
||||
'show_ui' => false,
|
||||
'show_in_menu' => false,
|
||||
'show_in_nav_menus' => false,
|
||||
'show_in_admin_bar' => false,
|
||||
'show_in_rest' => false,
|
||||
'rewrite' => false,
|
||||
'query_var' => false,
|
||||
'can_export' => false,
|
||||
'supports' => array(),
|
||||
'capabilities' => array(),
|
||||
'exclude_from_order_count' => true,
|
||||
'exclude_from_order_views' => true,
|
||||
'exclude_from_order_reports' => true,
|
||||
'exclude_from_order_sales_reports' => true,
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
|
||||
}
|
||||
@@ -0,0 +1,534 @@
|
||||
<?php
|
||||
/**
|
||||
* DataSynchronizer class file.
|
||||
*/
|
||||
|
||||
namespace Automattic\WooCommerce\Internal\DataStores\Orders;
|
||||
|
||||
use Automattic\WooCommerce\Caches\OrderCache;
|
||||
use Automattic\WooCommerce\Caches\OrderCacheController;
|
||||
use Automattic\WooCommerce\Database\Migrations\CustomOrderTable\PostsToOrdersMigrationController;
|
||||
use Automattic\WooCommerce\Internal\BatchProcessing\BatchProcessorInterface;
|
||||
use Automattic\WooCommerce\Internal\Features\FeaturesController;
|
||||
use Automattic\WooCommerce\Internal\Traits\AccessiblePrivateMethods;
|
||||
use Automattic\WooCommerce\Internal\Utilities\DatabaseUtil;
|
||||
use Automattic\WooCommerce\Proxies\LegacyProxy;
|
||||
|
||||
defined( 'ABSPATH' ) || exit;
|
||||
|
||||
/**
|
||||
* This class handles the database structure creation and the data synchronization for the custom orders tables. Its responsibilites are:
|
||||
*
|
||||
* - Providing entry points for creating and deleting the required database tables.
|
||||
* - Synchronizing changes between the custom orders tables and the posts table whenever changes in orders happen.
|
||||
*/
|
||||
class DataSynchronizer implements BatchProcessorInterface {
|
||||
|
||||
use AccessiblePrivateMethods;
|
||||
|
||||
public const ORDERS_DATA_SYNC_ENABLED_OPTION = 'woocommerce_custom_orders_table_data_sync_enabled';
|
||||
private const INITIAL_ORDERS_PENDING_SYNC_COUNT_OPTION = 'woocommerce_initial_orders_pending_sync_count';
|
||||
public const PENDING_SYNCHRONIZATION_FINISHED_ACTION = 'woocommerce_orders_sync_finished';
|
||||
public const PLACEHOLDER_ORDER_POST_TYPE = 'shop_order_placehold';
|
||||
|
||||
private const ORDERS_SYNC_BATCH_SIZE = 250;
|
||||
// Allowed values for $type in get_ids_of_orders_pending_sync method.
|
||||
public const ID_TYPE_MISSING_IN_ORDERS_TABLE = 0;
|
||||
public const ID_TYPE_MISSING_IN_POSTS_TABLE = 1;
|
||||
public const ID_TYPE_DIFFERENT_UPDATE_DATE = 2;
|
||||
|
||||
/**
|
||||
* The data store object to use.
|
||||
*
|
||||
* @var OrdersTableDataStore
|
||||
*/
|
||||
private $data_store;
|
||||
|
||||
/**
|
||||
* The database util object to use.
|
||||
*
|
||||
* @var DatabaseUtil
|
||||
*/
|
||||
private $database_util;
|
||||
|
||||
/**
|
||||
* The posts to COT migrator to use.
|
||||
*
|
||||
* @var PostsToOrdersMigrationController
|
||||
*/
|
||||
private $posts_to_cot_migrator;
|
||||
|
||||
/**
|
||||
* Logger object to be used to log events.
|
||||
*
|
||||
* @var \WC_Logger
|
||||
*/
|
||||
private $error_logger;
|
||||
|
||||
/**
|
||||
* The order cache controller.
|
||||
*
|
||||
* @var OrderCacheController
|
||||
*/
|
||||
private $order_cache_controller;
|
||||
|
||||
/**
|
||||
* Class constructor.
|
||||
*/
|
||||
public function __construct() {
|
||||
self::add_action( 'deleted_post', array( $this, 'handle_deleted_post' ), 10, 2 );
|
||||
self::add_action( 'woocommerce_new_order', array( $this, 'handle_updated_order' ), 100 );
|
||||
self::add_action( 'woocommerce_update_order', array( $this, 'handle_updated_order' ), 100 );
|
||||
self::add_filter( 'woocommerce_feature_description_tip', array( $this, 'handle_feature_description_tip' ), 10, 3 );
|
||||
}
|
||||
|
||||
/**
|
||||
* Class initialization, invoked by the DI container.
|
||||
*
|
||||
* @param OrdersTableDataStore $data_store The data store to use.
|
||||
* @param DatabaseUtil $database_util The database util class to use.
|
||||
* @param PostsToOrdersMigrationController $posts_to_cot_migrator The posts to COT migration class to use.
|
||||
* @param LegacyProxy $legacy_proxy The legacy proxy instance to use.
|
||||
* @param OrderCacheController $order_cache_controller The order cache controller instance to use.
|
||||
* @internal
|
||||
*/
|
||||
final public function init(
|
||||
OrdersTableDataStore $data_store,
|
||||
DatabaseUtil $database_util,
|
||||
PostsToOrdersMigrationController $posts_to_cot_migrator,
|
||||
LegacyProxy $legacy_proxy,
|
||||
OrderCacheController $order_cache_controller
|
||||
) {
|
||||
$this->data_store = $data_store;
|
||||
$this->database_util = $database_util;
|
||||
$this->posts_to_cot_migrator = $posts_to_cot_migrator;
|
||||
$this->error_logger = $legacy_proxy->call_function( 'wc_get_logger' );
|
||||
$this->order_cache_controller = $order_cache_controller;
|
||||
}
|
||||
|
||||
/**
|
||||
* Does the custom orders tables exist in the database?
|
||||
*
|
||||
* @return bool True if the custom orders tables exist in the database.
|
||||
*/
|
||||
public function check_orders_table_exists(): bool {
|
||||
$missing_tables = $this->database_util->get_missing_tables( $this->data_store->get_database_schema() );
|
||||
|
||||
return count( $missing_tables ) === 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Create the custom orders database tables.
|
||||
*/
|
||||
public function create_database_tables() {
|
||||
$this->database_util->dbdelta( $this->data_store->get_database_schema() );
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete the custom orders database tables.
|
||||
*/
|
||||
public function delete_database_tables() {
|
||||
$table_names = $this->data_store->get_all_table_names();
|
||||
|
||||
foreach ( $table_names as $table_name ) {
|
||||
$this->database_util->drop_database_table( $table_name );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Is the data sync between old and new tables currently enabled?
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function data_sync_is_enabled(): bool {
|
||||
return 'yes' === get_option( self::ORDERS_DATA_SYNC_ENABLED_OPTION );
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the current sync process status.
|
||||
* The information is meaningful only if pending_data_sync_is_in_progress return true.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function get_sync_status() {
|
||||
return array(
|
||||
'initial_pending_count' => (int) get_option( self::INITIAL_ORDERS_PENDING_SYNC_COUNT_OPTION, 0 ),
|
||||
'current_pending_count' => $this->get_total_pending_count(),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the total number of orders pending synchronization.
|
||||
*
|
||||
* @return int
|
||||
*/
|
||||
public function get_current_orders_pending_sync_count_cached() : int {
|
||||
return $this->get_current_orders_pending_sync_count( true );
|
||||
}
|
||||
|
||||
/**
|
||||
* Calculate how many orders need to be synchronized currently.
|
||||
* A database query is performed to get how many orders match one of the following:
|
||||
*
|
||||
* - Existing in the authoritative table but not in the backup table.
|
||||
* - Existing in both tables, but they have a different update date.
|
||||
*
|
||||
* @param bool $use_cache Whether to use the cached value instead of fetching from database.
|
||||
*/
|
||||
public function get_current_orders_pending_sync_count( $use_cache = false ): int {
|
||||
global $wpdb;
|
||||
|
||||
if ( $use_cache ) {
|
||||
$pending_count = wp_cache_get( 'woocommerce_hpos_pending_sync_count' );
|
||||
if ( false !== $pending_count ) {
|
||||
return (int) $pending_count;
|
||||
}
|
||||
}
|
||||
$orders_table = $this->data_store::get_orders_table_name();
|
||||
$order_post_types = wc_get_order_types( 'cot-migration' );
|
||||
|
||||
if ( empty( $order_post_types ) ) {
|
||||
$this->error_logger->debug(
|
||||
sprintf(
|
||||
/* translators: 1: method name. */
|
||||
esc_html__( '%1$s was called but no order types were registered: it may have been called too early.', 'woocommerce' ),
|
||||
__METHOD__
|
||||
)
|
||||
);
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
$order_post_type_placeholder = implode( ', ', array_fill( 0, count( $order_post_types ), '%s' ) );
|
||||
|
||||
if ( $this->custom_orders_table_is_authoritative() ) {
|
||||
$missing_orders_count_sql = "
|
||||
SELECT COUNT(1) FROM $wpdb->posts posts
|
||||
INNER JOIN $orders_table orders ON posts.id=orders.id
|
||||
WHERE posts.post_type = '" . self::PLACEHOLDER_ORDER_POST_TYPE . "'
|
||||
AND orders.status not in ( 'auto-draft' )
|
||||
";
|
||||
$operator = '>';
|
||||
} else {
|
||||
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared, WordPress.DB.PreparedSQLPlaceholders.UnfinishedPrepare -- $order_post_type_placeholder is prepared.
|
||||
$missing_orders_count_sql = $wpdb->prepare(
|
||||
"
|
||||
SELECT COUNT(1) FROM $wpdb->posts posts
|
||||
LEFT JOIN $orders_table orders ON posts.id=orders.id
|
||||
WHERE
|
||||
posts.post_type in ($order_post_type_placeholder)
|
||||
AND posts.post_status != 'auto-draft'
|
||||
AND orders.id IS NULL",
|
||||
$order_post_types
|
||||
);
|
||||
// phpcs:enable
|
||||
$operator = '<';
|
||||
}
|
||||
|
||||
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared, WordPress.DB.PreparedSQLPlaceholders.UnfinishedPrepare -- $missing_orders_count_sql is prepared.
|
||||
$sql = $wpdb->prepare(
|
||||
"
|
||||
SELECT(
|
||||
($missing_orders_count_sql)
|
||||
+
|
||||
(SELECT COUNT(1) FROM (
|
||||
SELECT orders.id FROM $orders_table orders
|
||||
JOIN $wpdb->posts posts on posts.ID = orders.id
|
||||
WHERE
|
||||
posts.post_type IN ($order_post_type_placeholder)
|
||||
AND orders.date_updated_gmt $operator posts.post_modified_gmt
|
||||
) x)
|
||||
) count",
|
||||
$order_post_types
|
||||
);
|
||||
// phpcs:enable
|
||||
|
||||
// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
|
||||
$pending_count = (int) $wpdb->get_var( $sql );
|
||||
wp_cache_set( 'woocommerce_hpos_pending_sync_count', $pending_count );
|
||||
return $pending_count;
|
||||
}
|
||||
|
||||
/**
|
||||
* Is the custom orders table the authoritative data source for orders currently?
|
||||
*
|
||||
* @return bool Whether the custom orders table the authoritative data source for orders currently.
|
||||
*/
|
||||
public function custom_orders_table_is_authoritative(): bool {
|
||||
return wc_string_to_bool( get_option( CustomOrdersTableController::CUSTOM_ORDERS_TABLE_USAGE_ENABLED_OPTION ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a list of ids of orders than are out of sync.
|
||||
*
|
||||
* Valid values for $type are:
|
||||
*
|
||||
* ID_TYPE_MISSING_IN_ORDERS_TABLE: orders that exist in posts table but not in orders table.
|
||||
* ID_TYPE_MISSING_IN_POSTS_TABLE: orders that exist in orders table but not in posts table (the corresponding post entries are placeholders).
|
||||
* ID_TYPE_DIFFERENT_UPDATE_DATE: orders that exist in both tables but have different last update dates.
|
||||
*
|
||||
* @param int $type One of ID_TYPE_MISSING_IN_ORDERS_TABLE, ID_TYPE_MISSING_IN_POSTS_TABLE, ID_TYPE_DIFFERENT_UPDATE_DATE.
|
||||
* @param int $limit Maximum number of ids to return.
|
||||
* @return array An array of order ids.
|
||||
* @throws \Exception Invalid parameter.
|
||||
*/
|
||||
public function get_ids_of_orders_pending_sync( int $type, int $limit ) {
|
||||
global $wpdb;
|
||||
|
||||
if ( $limit < 1 ) {
|
||||
throw new \Exception( '$limit must be at least 1' );
|
||||
}
|
||||
|
||||
$orders_table = $this->data_store::get_orders_table_name();
|
||||
$order_post_types = wc_get_order_types( 'cot-migration' );
|
||||
$order_post_type_placeholders = implode( ', ', array_fill( 0, count( $order_post_types ), '%s' ) );
|
||||
|
||||
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
|
||||
switch ( $type ) {
|
||||
case self::ID_TYPE_MISSING_IN_ORDERS_TABLE:
|
||||
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared, WordPress.DB.PreparedSQLPlaceholders.UnfinishedPrepare -- $order_post_type_placeholders is prepared.
|
||||
$sql = $wpdb->prepare(
|
||||
"
|
||||
SELECT posts.ID FROM $wpdb->posts posts
|
||||
LEFT JOIN $orders_table orders ON posts.ID = orders.id
|
||||
WHERE
|
||||
posts.post_type IN ($order_post_type_placeholders)
|
||||
AND posts.post_status != 'auto-draft'
|
||||
AND orders.id IS NULL
|
||||
ORDER BY posts.ID ASC",
|
||||
$order_post_types
|
||||
);
|
||||
// phpcs:enable WordPress.DB.PreparedSQLPlaceholders.UnfinishedPrepare
|
||||
break;
|
||||
case self::ID_TYPE_MISSING_IN_POSTS_TABLE:
|
||||
$sql = "
|
||||
SELECT posts.ID FROM $wpdb->posts posts
|
||||
INNER JOIN $orders_table orders ON posts.id=orders.id
|
||||
WHERE posts.post_type = '" . self::PLACEHOLDER_ORDER_POST_TYPE . "'
|
||||
AND orders.status not in ( 'auto-draft' )
|
||||
ORDER BY posts.id ASC
|
||||
";
|
||||
break;
|
||||
case self::ID_TYPE_DIFFERENT_UPDATE_DATE:
|
||||
$operator = $this->custom_orders_table_is_authoritative() ? '>' : '<';
|
||||
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared, WordPress.DB.PreparedSQLPlaceholders.UnfinishedPrepare -- $order_post_type_placeholders is prepared.
|
||||
$sql = $wpdb->prepare(
|
||||
"
|
||||
SELECT orders.id FROM $orders_table orders
|
||||
JOIN $wpdb->posts posts on posts.ID = orders.id
|
||||
WHERE
|
||||
posts.post_type IN ($order_post_type_placeholders)
|
||||
AND orders.date_updated_gmt $operator posts.post_modified_gmt
|
||||
ORDER BY orders.id ASC
|
||||
",
|
||||
$order_post_types
|
||||
);
|
||||
// phpcs:enable
|
||||
break;
|
||||
default:
|
||||
throw new \Exception( 'Invalid $type, must be one of the ID_TYPE_... constants.' );
|
||||
}
|
||||
// phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
|
||||
|
||||
// phpcs:ignore WordPress.DB
|
||||
return array_map( 'intval', $wpdb->get_col( $sql . " LIMIT $limit" ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* Cleanup all the synchronization status information,
|
||||
* because the process has been disabled by the user via settings,
|
||||
* or because there's nothing left to synchronize.
|
||||
*/
|
||||
public function cleanup_synchronization_state() {
|
||||
delete_option( self::INITIAL_ORDERS_PENDING_SYNC_COUNT_OPTION );
|
||||
}
|
||||
|
||||
/**
|
||||
* Process data for current batch.
|
||||
*
|
||||
* @param array $batch Batch details.
|
||||
*/
|
||||
public function process_batch( array $batch ) : void {
|
||||
$this->order_cache_controller->temporarily_disable_orders_cache_usage();
|
||||
|
||||
if ( $this->custom_orders_table_is_authoritative() ) {
|
||||
foreach ( $batch as $id ) {
|
||||
$order = wc_get_order( $id );
|
||||
if ( ! $order ) {
|
||||
$this->error_logger->error( "Order $id not found during batch process, skipping." );
|
||||
continue;
|
||||
}
|
||||
$data_store = $order->get_data_store();
|
||||
$data_store->backfill_post_record( $order );
|
||||
}
|
||||
} else {
|
||||
$this->posts_to_cot_migrator->migrate_orders( $batch );
|
||||
}
|
||||
if ( 0 === $this->get_total_pending_count() ) {
|
||||
$this->cleanup_synchronization_state();
|
||||
$this->order_cache_controller->maybe_restore_orders_cache_usage();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get total number of pending records that require update.
|
||||
*
|
||||
* @return int Number of pending records.
|
||||
*/
|
||||
public function get_total_pending_count(): int {
|
||||
return $this->get_current_orders_pending_sync_count();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the batch with records that needs to be processed for a given size.
|
||||
*
|
||||
* @param int $size Size of the batch.
|
||||
*
|
||||
* @return array Batch of records.
|
||||
*/
|
||||
public function get_next_batch_to_process( int $size ): array {
|
||||
if ( $this->custom_orders_table_is_authoritative() ) {
|
||||
$order_ids = $this->get_ids_of_orders_pending_sync( self::ID_TYPE_MISSING_IN_POSTS_TABLE, $size );
|
||||
} else {
|
||||
$order_ids = $this->get_ids_of_orders_pending_sync( self::ID_TYPE_MISSING_IN_ORDERS_TABLE, $size );
|
||||
}
|
||||
if ( count( $order_ids ) >= $size ) {
|
||||
return $order_ids;
|
||||
}
|
||||
|
||||
$order_ids = $order_ids + $this->get_ids_of_orders_pending_sync( self::ID_TYPE_DIFFERENT_UPDATE_DATE, $size - count( $order_ids ) );
|
||||
return $order_ids;
|
||||
}
|
||||
|
||||
/**
|
||||
* Default batch size to use.
|
||||
*
|
||||
* @return int Default batch size.
|
||||
*/
|
||||
public function get_default_batch_size(): int {
|
||||
$batch_size = self::ORDERS_SYNC_BATCH_SIZE;
|
||||
|
||||
if ( $this->custom_orders_table_is_authoritative() ) {
|
||||
// Back-filling is slower than migration.
|
||||
$batch_size = absint( self::ORDERS_SYNC_BATCH_SIZE / 10 ) + 1;
|
||||
}
|
||||
/**
|
||||
* Filter to customize the count of orders that will be synchronized in each step of the custom orders table to/from posts table synchronization process.
|
||||
*
|
||||
* @since 6.6.0
|
||||
*
|
||||
* @param int Default value for the count.
|
||||
*/
|
||||
return apply_filters( 'woocommerce_orders_cot_and_posts_sync_step_size', $batch_size );
|
||||
}
|
||||
|
||||
/**
|
||||
* A user friendly name for this process.
|
||||
*
|
||||
* @return string Name of the process.
|
||||
*/
|
||||
public function get_name(): string {
|
||||
return 'Order synchronizer';
|
||||
}
|
||||
|
||||
/**
|
||||
* A user friendly description for this process.
|
||||
*
|
||||
* @return string Description.
|
||||
*/
|
||||
public function get_description(): string {
|
||||
return 'Synchronizes orders between posts and custom order tables.';
|
||||
}
|
||||
|
||||
/**
|
||||
* Handle the 'deleted_post' action.
|
||||
*
|
||||
* When posts is authoritative and sync is enabled, deleting a post also deletes COT data.
|
||||
*
|
||||
* @param int $postid The post id.
|
||||
* @param WP_Post $post The deleted post.
|
||||
*/
|
||||
private function handle_deleted_post( $postid, $post ): void {
|
||||
if ( 'shop_order' === $post->post_type && $this->data_sync_is_enabled() ) {
|
||||
$this->data_store->delete_order_data_from_custom_order_tables( $postid );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Handle the 'woocommerce_update_order' action.
|
||||
*
|
||||
* When posts is authoritative and sync is enabled, updating a post triggers a corresponding change in the COT table.
|
||||
*
|
||||
* @param int $order_id The order id.
|
||||
*/
|
||||
private function handle_updated_order( $order_id ): void {
|
||||
if ( ! $this->custom_orders_table_is_authoritative() && $this->data_sync_is_enabled() ) {
|
||||
$this->posts_to_cot_migrator->migrate_orders( array( $order_id ) );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Handle the 'woocommerce_feature_description_tip' filter.
|
||||
*
|
||||
* When the COT feature is enabled and there are orders pending sync (in either direction),
|
||||
* show a "you should ync before disabling" warning under the feature in the features page.
|
||||
* Skip this if the UI prevents changing the feature enable status.
|
||||
*
|
||||
* @param string $desc_tip The original description tip for the feature.
|
||||
* @param string $feature_id The feature id.
|
||||
* @param bool $ui_disabled True if the UI doesn't allow to enable or disable the feature.
|
||||
* @return string The new description tip for the feature.
|
||||
*/
|
||||
private function handle_feature_description_tip( $desc_tip, $feature_id, $ui_disabled ): string {
|
||||
if ( 'custom_order_tables' !== $feature_id || $ui_disabled ) {
|
||||
return $desc_tip;
|
||||
}
|
||||
|
||||
$features_controller = wc_get_container()->get( FeaturesController::class );
|
||||
$feature_is_enabled = $features_controller->feature_is_enabled( 'custom_order_tables' );
|
||||
if ( ! $feature_is_enabled ) {
|
||||
return $desc_tip;
|
||||
}
|
||||
|
||||
$pending_sync_count = $this->get_current_orders_pending_sync_count();
|
||||
if ( ! $pending_sync_count ) {
|
||||
return $desc_tip;
|
||||
}
|
||||
|
||||
if ( $this->custom_orders_table_is_authoritative() ) {
|
||||
$extra_tip = sprintf(
|
||||
_n(
|
||||
"⚠ There's one order pending sync from the orders table to the posts table. The feature shouldn't be disabled until this order is synchronized.",
|
||||
"⚠ There are %1\$d orders pending sync from the orders table to the posts table. The feature shouldn't be disabled until these orders are synchronized.",
|
||||
$pending_sync_count,
|
||||
'woocommerce'
|
||||
),
|
||||
$pending_sync_count
|
||||
);
|
||||
} else {
|
||||
$extra_tip = sprintf(
|
||||
_n(
|
||||
"⚠ There's one order pending sync from the posts table to the orders table. The feature shouldn't be disabled until this order is synchronized.",
|
||||
"⚠ There are %1\$d orders pending sync from the posts table to the orders table. The feature shouldn't be disabled until these orders are synchronized.",
|
||||
$pending_sync_count,
|
||||
'woocommerce'
|
||||
),
|
||||
$pending_sync_count
|
||||
);
|
||||
}
|
||||
|
||||
$cot_settings_url = add_query_arg(
|
||||
array(
|
||||
'page' => 'wc-settings',
|
||||
'tab' => 'advanced',
|
||||
'section' => 'custom_data_stores',
|
||||
),
|
||||
admin_url( 'admin.php' )
|
||||
);
|
||||
|
||||
/* translators: %s = URL of the custom data stores settings page */
|
||||
$manage_cot_settings_link = sprintf( __( "<a href='%s'>Manage orders synchronization</a>", 'woocommerce' ), $cot_settings_url );
|
||||
|
||||
return $desc_tip ? "{$desc_tip}<br/>{$extra_tip} {$manage_cot_settings_link}" : "{$extra_tip} {$manage_cot_settings_link}";
|
||||
}
|
||||
}
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,33 @@
|
||||
<?php
|
||||
/**
|
||||
* OrdersTableDataStoreMeta class file.
|
||||
*/
|
||||
|
||||
namespace Automattic\WooCommerce\Internal\DataStores\Orders;
|
||||
|
||||
use Automattic\WooCommerce\Internal\DataStores\CustomMetaDataStore;
|
||||
|
||||
/**
|
||||
* Mimics a WP metadata (i.e. add_metadata(), get_metadata() and friends) implementation using a custom table.
|
||||
*/
|
||||
class OrdersTableDataStoreMeta extends CustomMetaDataStore {
|
||||
|
||||
/**
|
||||
* Returns the name of the table used for storage.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
protected function get_table_name() {
|
||||
return OrdersTableDataStore::get_meta_table_name();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the name of the field/column used for associating meta with objects.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
protected function get_object_id_field() {
|
||||
return 'order_id';
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,356 @@
|
||||
<?php
|
||||
namespace Automattic\WooCommerce\Internal\DataStores\Orders;
|
||||
|
||||
defined( 'ABSPATH' ) || exit;
|
||||
|
||||
/**
|
||||
* Provides the implementation for `field_query` in {@see OrdersTableQuery} used to build
|
||||
* complex queries against order fields in the database.
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
class OrdersTableFieldQuery {
|
||||
|
||||
/**
|
||||
* List of valid SQL operators to use as field_query 'compare' values.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
private const VALID_COMPARISON_OPERATORS = array(
|
||||
'=',
|
||||
'!=',
|
||||
'LIKE',
|
||||
'NOT LIKE',
|
||||
'IN',
|
||||
'NOT IN',
|
||||
'EXISTS',
|
||||
'NOT EXISTS',
|
||||
'RLIKE',
|
||||
'REGEXP',
|
||||
'NOT REGEXP',
|
||||
'>',
|
||||
'>=',
|
||||
'<',
|
||||
'<=',
|
||||
'BETWEEN',
|
||||
'NOT BETWEEN',
|
||||
);
|
||||
|
||||
/**
|
||||
* The original query object.
|
||||
*
|
||||
* @var OrdersTableQuery
|
||||
*/
|
||||
private $query = null;
|
||||
|
||||
/**
|
||||
* Determines whether the field query should produce no results due to an invalid argument.
|
||||
*
|
||||
* @var boolean
|
||||
*/
|
||||
private $force_no_results = false;
|
||||
|
||||
/**
|
||||
* Holds a sanitized version of the `field_query`.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
private $queries = array();
|
||||
|
||||
/**
|
||||
* JOIN clauses to add to the main SQL query.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
private $join = array();
|
||||
|
||||
/**
|
||||
* WHERE clauses to add to the main SQL query.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
private $where = array();
|
||||
|
||||
/**
|
||||
* Table aliases in use by the field query. Used to keep track of JOINs and optimize when possible.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
private $table_aliases = array();
|
||||
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param OrdersTableQuery $q The main query being performed.
|
||||
*/
|
||||
public function __construct( OrdersTableQuery $q ) {
|
||||
$field_query = $q->get( 'field_query' );
|
||||
|
||||
if ( ! $field_query || ! is_array( $field_query ) ) {
|
||||
return;
|
||||
}
|
||||
|
||||
$this->query = $q;
|
||||
$this->queries = $this->sanitize_query( $field_query );
|
||||
$this->where = ( ! $this->force_no_results ) ? $this->process( $this->queries ) : '1=0';
|
||||
}
|
||||
|
||||
/**
|
||||
* Sanitizes the field_query argument.
|
||||
*
|
||||
* @param array $q A field_query array.
|
||||
* @return array A sanitized field query array.
|
||||
* @throws \Exception When field table info is missing.
|
||||
*/
|
||||
private function sanitize_query( array $q ) {
|
||||
$sanitized = array();
|
||||
|
||||
foreach ( $q as $key => $arg ) {
|
||||
if ( 'relation' === $key ) {
|
||||
$relation = $arg;
|
||||
} elseif ( ! is_array( $arg ) ) {
|
||||
continue;
|
||||
} elseif ( $this->is_atomic( $arg ) ) {
|
||||
if ( isset( $arg['value'] ) && array() === $arg['value'] ) {
|
||||
continue;
|
||||
}
|
||||
|
||||
// Sanitize 'compare'.
|
||||
$arg['compare'] = strtoupper( $arg['compare'] ?? '=' );
|
||||
$arg['compare'] = in_array( $arg['compare'], self::VALID_COMPARISON_OPERATORS, true ) ? $arg['compare'] : '=';
|
||||
|
||||
if ( '=' === $arg['compare'] && isset( $arg['value'] ) && is_array( $arg['value'] ) ) {
|
||||
$arg['compare'] = 'IN';
|
||||
}
|
||||
|
||||
// Sanitize 'cast'.
|
||||
$arg['cast'] = $this->sanitize_cast_type( $arg['type'] ?? '' );
|
||||
|
||||
$field_info = $this->query->get_field_mapping_info( $arg['field'] );
|
||||
if ( ! $field_info ) {
|
||||
$this->force_no_results = true;
|
||||
continue;
|
||||
}
|
||||
|
||||
$arg = array_merge( $arg, $field_info );
|
||||
|
||||
$sanitized[ $key ] = $arg;
|
||||
} else {
|
||||
$sanitized_arg = $this->sanitize_query( $arg );
|
||||
|
||||
if ( $sanitized_arg ) {
|
||||
$sanitized[ $key ] = $sanitized_arg;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if ( $sanitized ) {
|
||||
$sanitized['relation'] = 1 === count( $sanitized ) ? 'OR' : $this->sanitize_relation( $relation ?? 'AND' );
|
||||
}
|
||||
|
||||
return $sanitized;
|
||||
}
|
||||
|
||||
/**
|
||||
* Makes sure we use an AND or OR relation. Defaults to AND.
|
||||
*
|
||||
* @param string $relation An unsanitized relation prop.
|
||||
* @return string
|
||||
*/
|
||||
private function sanitize_relation( string $relation ): string {
|
||||
if ( ! empty( $relation ) && 'OR' === strtoupper( $relation ) ) {
|
||||
return 'OR';
|
||||
}
|
||||
|
||||
return 'AND';
|
||||
}
|
||||
|
||||
/**
|
||||
* Processes field_query entries and generates the necessary table aliases, JOIN statements and WHERE conditions.
|
||||
*
|
||||
* @param array $q A field query.
|
||||
* @return string An SQL WHERE statement.
|
||||
*/
|
||||
private function process( array $q ) {
|
||||
$where = '';
|
||||
|
||||
if ( empty( $q ) ) {
|
||||
return $where;
|
||||
}
|
||||
|
||||
if ( $this->is_atomic( $q ) ) {
|
||||
$q['alias'] = $this->find_or_create_table_alias_for_clause( $q );
|
||||
$where = $this->generate_where_for_clause( $q );
|
||||
} else {
|
||||
$relation = $q['relation'];
|
||||
unset( $q['relation'] );
|
||||
|
||||
foreach ( $q as $query ) {
|
||||
$chunks[] = $this->process( $query );
|
||||
}
|
||||
|
||||
if ( 1 === count( $chunks ) ) {
|
||||
$where = $chunks[0];
|
||||
} else {
|
||||
$where = '(' . implode( " {$relation} ", $chunks ) . ')';
|
||||
}
|
||||
}
|
||||
|
||||
return $where;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks whether a given field_query clause is atomic or not (i.e. not nested).
|
||||
*
|
||||
* @param array $q The field_query clause.
|
||||
* @return boolean TRUE if atomic, FALSE otherwise.
|
||||
*/
|
||||
private function is_atomic( $q ) {
|
||||
return isset( $q['field'] );
|
||||
}
|
||||
|
||||
/**
|
||||
* Finds a common table alias that the field_query clause can use, or creates one.
|
||||
*
|
||||
* @param array $q An atomic field_query clause.
|
||||
* @return string A table alias for use in an SQL JOIN clause.
|
||||
* @throws \Exception When table info for clause is missing.
|
||||
*/
|
||||
private function find_or_create_table_alias_for_clause( $q ) {
|
||||
global $wpdb;
|
||||
|
||||
if ( ! empty( $q['alias'] ) ) {
|
||||
return $q['alias'];
|
||||
}
|
||||
|
||||
if ( empty( $q['table'] ) || empty( $q['column'] ) ) {
|
||||
throw new \Exception( __( 'Missing table info for query arg.', 'woocommerce' ) );
|
||||
}
|
||||
|
||||
$join = '';
|
||||
|
||||
if ( isset( $q['mapping_id'] ) ) {
|
||||
// Re-use JOINs and aliases from OrdersTableQuery for core tables.
|
||||
$alias = $this->query->get_core_mapping_alias( $q['mapping_id'] );
|
||||
$join = $this->query->get_core_mapping_join( $q['mapping_id'] );
|
||||
} else {
|
||||
$alias = $q['table'];
|
||||
$join = '';
|
||||
}
|
||||
|
||||
if ( in_array( $alias, $this->table_aliases, true ) ) {
|
||||
return $alias;
|
||||
}
|
||||
|
||||
$this->table_aliases[] = $alias;
|
||||
|
||||
if ( $join ) {
|
||||
$this->join[ $alias ] = $join;
|
||||
}
|
||||
|
||||
return $alias;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the correct type for a given clause 'type'.
|
||||
*
|
||||
* @param string $type MySQL type.
|
||||
* @return string MySQL type.
|
||||
*/
|
||||
private function sanitize_cast_type( $type ) {
|
||||
$clause_type = strtoupper( $type );
|
||||
|
||||
if ( ! $clause_type || ! preg_match( '/^(?:BINARY|CHAR|DATE|DATETIME|SIGNED|UNSIGNED|TIME|NUMERIC(?:\(\d+(?:,\s?\d+)?\))?|DECIMAL(?:\(\d+(?:,\s?\d+)?\))?)$/', $clause_type ) ) {
|
||||
return 'CHAR';
|
||||
}
|
||||
|
||||
if ( 'NUMERIC' === $clause_type ) {
|
||||
$clause_type = 'SIGNED';
|
||||
}
|
||||
|
||||
return $clause_type;
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates an SQL WHERE clause for a given field_query atomic clause.
|
||||
*
|
||||
* @param array $clause An atomic field_query clause.
|
||||
* @return string An SQL WHERE clause or an empty string if $clause is invalid.
|
||||
*/
|
||||
private function generate_where_for_clause( $clause ): string {
|
||||
global $wpdb;
|
||||
|
||||
$clause_value = $clause['value'] ?? '';
|
||||
|
||||
if ( in_array( $clause['compare'], array( 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN' ), true ) ) {
|
||||
if ( ! is_array( $clause_value ) ) {
|
||||
$clause_value = preg_split( '/[,\s]+/', $clause_value );
|
||||
}
|
||||
} elseif ( is_string( $clause_value ) ) {
|
||||
$clause_value = trim( $clause_value );
|
||||
}
|
||||
|
||||
$clause_compare = $clause['compare'];
|
||||
|
||||
switch ( $clause_compare ) {
|
||||
case 'IN':
|
||||
case 'NOT IN':
|
||||
$where = $wpdb->prepare( '(' . substr( str_repeat( ',%s', count( $clause_value ) ), 1 ) . ')', $clause_value ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
|
||||
break;
|
||||
case 'BETWEEN':
|
||||
case 'NOT BETWEEN':
|
||||
$where = $wpdb->prepare( '%s AND %s', $clause_value[0], $clause_value[1] ?? $clause_value[0] );
|
||||
break;
|
||||
case 'LIKE':
|
||||
case 'NOT LIKE':
|
||||
$where = $wpdb->prepare( '%s', '%' . $wpdb->esc_like( $clause_value ) . '%' );
|
||||
break;
|
||||
case 'EXISTS':
|
||||
// EXISTS with a value is interpreted as '='.
|
||||
if ( $clause_value ) {
|
||||
$clause_compare = '=';
|
||||
$where = $wpdb->prepare( '%s', $clause_value );
|
||||
} else {
|
||||
$clause_compare = 'IS NOT';
|
||||
$where = 'NULL';
|
||||
}
|
||||
|
||||
break;
|
||||
case 'NOT EXISTS':
|
||||
// 'value' is ignored for NOT EXISTS.
|
||||
$clause_compare = 'IS';
|
||||
$where = 'NULL';
|
||||
break;
|
||||
default:
|
||||
$where = $wpdb->prepare( '%s', $clause_value );
|
||||
break;
|
||||
}
|
||||
|
||||
if ( $where ) {
|
||||
if ( 'CHAR' === $clause['cast'] ) {
|
||||
return "`{$clause['alias']}`.`{$clause['column']}` {$clause_compare} {$where}";
|
||||
} else {
|
||||
return "CAST(`{$clause['alias']}`.`{$clause['column']}` AS {$clause['cast']}) {$clause_compare} {$where}";
|
||||
}
|
||||
}
|
||||
|
||||
return '';
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns JOIN and WHERE clauses to be appended to the main SQL query.
|
||||
*
|
||||
* @return array {
|
||||
* @type string $join JOIN clause.
|
||||
* @type string $where WHERE clause.
|
||||
* }
|
||||
*/
|
||||
public function get_sql_clauses() {
|
||||
return array(
|
||||
'join' => $this->join,
|
||||
'where' => $this->where ? array( $this->where ) : array(),
|
||||
);
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,659 @@
|
||||
<?php
|
||||
namespace Automattic\WooCommerce\Internal\DataStores\Orders;
|
||||
|
||||
defined( 'ABSPATH' ) || exit;
|
||||
|
||||
/**
|
||||
* Class used to implement meta queries for the orders table datastore via {@see OrdersTableQuery}.
|
||||
* Heavily inspired by WordPress' own `WP_Meta_Query` for backwards compatibility reasons.
|
||||
*
|
||||
* Parts of the implementation have been adapted from {@link https://core.trac.wordpress.org/browser/tags/6.0.1/src/wp-includes/class-wp-meta-query.php}.
|
||||
*/
|
||||
class OrdersTableMetaQuery {
|
||||
|
||||
/**
|
||||
* List of non-numeric SQL operators used for comparisons in meta queries.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
private const NON_NUMERIC_OPERATORS = array(
|
||||
'=',
|
||||
'!=',
|
||||
'LIKE',
|
||||
'NOT LIKE',
|
||||
'IN',
|
||||
'NOT IN',
|
||||
'EXISTS',
|
||||
'NOT EXISTS',
|
||||
'RLIKE',
|
||||
'REGEXP',
|
||||
'NOT REGEXP',
|
||||
);
|
||||
|
||||
/**
|
||||
* List of numeric SQL operators used for comparisons in meta queries.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
private const NUMERIC_OPERATORS = array(
|
||||
'>',
|
||||
'>=',
|
||||
'<',
|
||||
'<=',
|
||||
'BETWEEN',
|
||||
'NOT BETWEEN',
|
||||
|
||||
);
|
||||
|
||||
/**
|
||||
* Prefix used when generating aliases for the metadata table.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
private const ALIAS_PREFIX = 'meta';
|
||||
|
||||
/**
|
||||
* Name of the main orders table.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
private $meta_table = '';
|
||||
|
||||
/**
|
||||
* Name of the metadata table.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
private $orders_table = '';
|
||||
|
||||
/**
|
||||
* Sanitized `meta_query`.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
private $queries = array();
|
||||
|
||||
/**
|
||||
* Flat list of clauses by name.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
private $flattened_clauses = array();
|
||||
|
||||
/**
|
||||
* JOIN clauses to add to the main SQL query.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
private $join = array();
|
||||
|
||||
/**
|
||||
* WHERE clauses to add to the main SQL query.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
private $where = array();
|
||||
|
||||
/**
|
||||
* Table aliases in use by the meta query. Used to optimize JOINs when possible.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
private $table_aliases = array();
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param OrdersTableQuery $q The main query being performed.
|
||||
*/
|
||||
public function __construct( OrdersTableQuery $q ) {
|
||||
$meta_query = $q->get( 'meta_query' );
|
||||
|
||||
if ( ! $meta_query ) {
|
||||
return;
|
||||
}
|
||||
|
||||
$this->queries = $this->sanitize_meta_query( $meta_query );
|
||||
|
||||
$this->meta_table = $q->get_table_name( 'meta' );
|
||||
$this->orders_table = $q->get_table_name( 'orders' );
|
||||
|
||||
$this->build_query();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns JOIN and WHERE clauses to be appended to the main SQL query.
|
||||
*
|
||||
* @return array {
|
||||
* @type string $join JOIN clause.
|
||||
* @type string $where WHERE clause.
|
||||
* }
|
||||
*/
|
||||
public function get_sql_clauses(): array {
|
||||
return array(
|
||||
'join' => $this->sanitize_join( $this->join ),
|
||||
'where' => $this->flatten_where_clauses( $this->where ),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a list of names (corresponding to meta_query clauses) that can be used as an 'orderby' arg.
|
||||
*
|
||||
* @since 7.4
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function get_orderby_keys(): array {
|
||||
if ( ! $this->flattened_clauses ) {
|
||||
return array();
|
||||
}
|
||||
|
||||
$keys = array();
|
||||
$keys[] = 'meta_value';
|
||||
$keys[] = 'meta_value_num';
|
||||
|
||||
$first_clause = reset( $this->flattened_clauses );
|
||||
if ( $first_clause && ! empty( $first_clause['key'] ) ) {
|
||||
$keys[] = $first_clause['key'];
|
||||
}
|
||||
|
||||
$keys = array_merge(
|
||||
$keys,
|
||||
array_keys( $this->flattened_clauses )
|
||||
);
|
||||
|
||||
return $keys;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns an SQL fragment for the given meta_query key that can be used in an ORDER BY clause.
|
||||
* Call {@see 'get_orderby_keys'} to obtain a list of valid keys.
|
||||
*
|
||||
* @since 7.4
|
||||
*
|
||||
* @param string $key The key name.
|
||||
* @return string
|
||||
*
|
||||
* @throws \Exception When an invalid key is passed.
|
||||
*/
|
||||
public function get_orderby_clause_for_key( string $key ): string {
|
||||
$clause = false;
|
||||
|
||||
if ( isset( $this->flattened_clauses[ $key ] ) ) {
|
||||
$clause = $this->flattened_clauses[ $key ];
|
||||
} else {
|
||||
$first_clause = reset( $this->flattened_clauses );
|
||||
|
||||
if ( $first_clause && ! empty( $first_clause['key'] ) ) {
|
||||
if ( 'meta_value_num' === $key ) {
|
||||
return "{$first_clause['alias']}.meta_value+0";
|
||||
}
|
||||
|
||||
if ( 'meta_value' === $key || $first_clause['key'] === $key ) {
|
||||
$clause = $first_clause;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if ( ! $clause ) {
|
||||
// translators: %s is a meta_query key.
|
||||
throw new \Exception( sprintf( __( 'Invalid meta_query clause key: %s.', 'woocommerce' ), $key ) );
|
||||
}
|
||||
|
||||
return "CAST({$clause['alias']}.meta_value AS {$clause['cast']})";
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks whether a given meta_query clause is atomic or not (i.e. not nested).
|
||||
*
|
||||
* @param array $arg The meta_query clause.
|
||||
* @return boolean TRUE if atomic, FALSE otherwise.
|
||||
*/
|
||||
private function is_atomic( array $arg ): bool {
|
||||
return isset( $arg['key'] ) || isset( $arg['value'] );
|
||||
}
|
||||
|
||||
/**
|
||||
* Sanitizes the meta_query argument.
|
||||
*
|
||||
* @param array $q A meta_query array.
|
||||
* @return array A sanitized meta query array.
|
||||
*/
|
||||
private function sanitize_meta_query( array $q ): array {
|
||||
$sanitized = array();
|
||||
|
||||
foreach ( $q as $key => $arg ) {
|
||||
if ( 'relation' === $key ) {
|
||||
$relation = $arg;
|
||||
} elseif ( ! is_array( $arg ) ) {
|
||||
continue;
|
||||
} elseif ( $this->is_atomic( $arg ) ) {
|
||||
if ( isset( $arg['value'] ) && array() === $arg['value'] ) {
|
||||
unset( $arg['value'] );
|
||||
}
|
||||
|
||||
$arg['compare'] = isset( $arg['compare'] ) ? strtoupper( $arg['compare'] ) : ( isset( $arg['value'] ) && is_array( $arg['value'] ) ? 'IN' : '=' );
|
||||
$arg['compare_key'] = isset( $arg['compare_key'] ) ? strtoupper( $arg['compare_key'] ) : ( isset( $arg['key'] ) && is_array( $arg['key'] ) ? 'IN' : '=' );
|
||||
|
||||
if ( ! in_array( $arg['compare'], self::NON_NUMERIC_OPERATORS, true ) && ! in_array( $arg['compare'], self::NUMERIC_OPERATORS, true ) ) {
|
||||
$arg['compare'] = '=';
|
||||
}
|
||||
|
||||
if ( ! in_array( $arg['compare_key'], self::NON_NUMERIC_OPERATORS, true ) ) {
|
||||
$arg['compare_key'] = '=';
|
||||
}
|
||||
|
||||
$sanitized[ $key ] = $arg;
|
||||
$sanitized[ $key ]['index'] = $key;
|
||||
} else {
|
||||
$sanitized_arg = $this->sanitize_meta_query( $arg );
|
||||
|
||||
if ( $sanitized_arg ) {
|
||||
$sanitized[ $key ] = $sanitized_arg;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if ( $sanitized ) {
|
||||
$sanitized['relation'] = 1 === count( $sanitized ) ? 'OR' : $this->sanitize_relation( $relation ?? 'AND' );
|
||||
}
|
||||
|
||||
return $sanitized;
|
||||
}
|
||||
|
||||
/**
|
||||
* Makes sure we use an AND or OR relation. Defaults to AND.
|
||||
*
|
||||
* @param string $relation An unsanitized relation prop.
|
||||
* @return string
|
||||
*/
|
||||
private function sanitize_relation( string $relation ): string {
|
||||
if ( ! empty( $relation ) && 'OR' === strtoupper( $relation ) ) {
|
||||
return 'OR';
|
||||
}
|
||||
|
||||
return 'AND';
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the correct type for a given meta type.
|
||||
*
|
||||
* @param string $type MySQL type.
|
||||
* @return string MySQL type.
|
||||
*/
|
||||
private function sanitize_cast_type( string $type = '' ): string {
|
||||
$meta_type = strtoupper( $type );
|
||||
|
||||
if ( ! $meta_type || ! preg_match( '/^(?:BINARY|CHAR|DATE|DATETIME|SIGNED|UNSIGNED|TIME|NUMERIC(?:\(\d+(?:,\s?\d+)?\))?|DECIMAL(?:\(\d+(?:,\s?\d+)?\))?)$/', $meta_type ) ) {
|
||||
return 'CHAR';
|
||||
}
|
||||
|
||||
if ( 'NUMERIC' === $meta_type ) {
|
||||
$meta_type = 'SIGNED';
|
||||
}
|
||||
|
||||
return $meta_type;
|
||||
}
|
||||
|
||||
/**
|
||||
* Makes sure a JOIN array does not have duplicates.
|
||||
*
|
||||
* @param array $join A JOIN array.
|
||||
* @return array A sanitized JOIN array.
|
||||
*/
|
||||
private function sanitize_join( array $join ): array {
|
||||
return array_filter( array_unique( array_map( 'trim', $join ) ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* Flattens a nested WHERE array.
|
||||
*
|
||||
* @param array $where A possibly nested WHERE array with AND/OR operators.
|
||||
* @return string An SQL WHERE clause.
|
||||
*/
|
||||
private function flatten_where_clauses( $where ): string {
|
||||
if ( is_string( $where ) ) {
|
||||
return trim( $where );
|
||||
}
|
||||
|
||||
$chunks = array();
|
||||
$operator = $this->sanitize_relation( $where['operator'] ?? '' );
|
||||
|
||||
foreach ( $where as $key => $w ) {
|
||||
if ( 'operator' === $key ) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$flattened = $this->flatten_where_clauses( $w );
|
||||
if ( $flattened ) {
|
||||
$chunks[] = $flattened;
|
||||
}
|
||||
}
|
||||
|
||||
if ( $chunks ) {
|
||||
return '(' . implode( " {$operator} ", $chunks ) . ')';
|
||||
} else {
|
||||
return '';
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Builds all the required internal bits for this meta query.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
private function build_query(): void {
|
||||
if ( ! $this->queries ) {
|
||||
return;
|
||||
}
|
||||
|
||||
$queries = $this->queries;
|
||||
$sql_where = $this->process( $queries );
|
||||
$this->where = $sql_where;
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* Processes meta_query entries and generates the necessary table aliases, JOIN statements and WHERE conditions.
|
||||
*
|
||||
* @param array $arg A meta query.
|
||||
* @param null|array $parent The parent of the element being processed.
|
||||
* @return array A nested array of WHERE conditions.
|
||||
*/
|
||||
private function process( array &$arg, &$parent = null ): array {
|
||||
$where = array();
|
||||
|
||||
if ( $this->is_atomic( $arg ) ) {
|
||||
$arg['alias'] = $this->find_or_create_table_alias_for_clause( $arg, $parent );
|
||||
$arg['cast'] = $this->sanitize_cast_type( $arg['type'] ?? '' );
|
||||
|
||||
$where = array_filter(
|
||||
array(
|
||||
$this->generate_where_for_clause_key( $arg ),
|
||||
$this->generate_where_for_clause_value( $arg ),
|
||||
)
|
||||
);
|
||||
|
||||
// Store clauses by their key for ORDER BY purposes.
|
||||
$flat_clause_key = is_int( $arg['index'] ) ? $arg['alias'] : $arg['index'];
|
||||
|
||||
$unique_flat_key = $flat_clause_key;
|
||||
$i = 1;
|
||||
while ( isset( $this->flattened_clauses[ $unique_flat_key ] ) ) {
|
||||
$unique_flat_key = $flat_clause_key . '-' . $i;
|
||||
$i++;
|
||||
}
|
||||
|
||||
$this->flattened_clauses[ $unique_flat_key ] =& $arg;
|
||||
} else {
|
||||
// Nested.
|
||||
$relation = $arg['relation'];
|
||||
unset( $arg['relation'] );
|
||||
|
||||
foreach ( $arg as $index => &$clause ) {
|
||||
$chunks[] = $this->process( $clause, $arg );
|
||||
}
|
||||
|
||||
// Merge chunks of the form OR(m) with the surrounding clause.
|
||||
if ( 1 === count( $chunks ) ) {
|
||||
$where = $chunks[0];
|
||||
} else {
|
||||
$where = array_merge(
|
||||
array(
|
||||
'operator' => $relation,
|
||||
),
|
||||
$chunks
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
return $where;
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates a JOIN clause to handle an atomic meta_query clause.
|
||||
*
|
||||
* @param array $clause An atomic meta_query clause.
|
||||
* @param string $alias Metadata table alias to use.
|
||||
* @return string An SQL JOIN clause.
|
||||
*/
|
||||
private function generate_join_for_clause( array $clause, string $alias ): string {
|
||||
global $wpdb;
|
||||
|
||||
if ( 'NOT EXISTS' === $clause['compare'] ) {
|
||||
if ( 'LIKE' === $clause['compare_key'] ) {
|
||||
return $wpdb->prepare(
|
||||
"LEFT JOIN {$this->meta_table} AS {$alias} ON ( {$this->orders_table}.id = {$alias}.order_id AND {$alias}.meta_key LIKE %s )", // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
|
||||
'%' . $wpdb->esc_like( $clause['key'] ) . '%'
|
||||
);
|
||||
} else {
|
||||
return $wpdb->prepare(
|
||||
"LEFT JOIN {$this->meta_table} AS {$alias} ON ( {$this->orders_table}.id = {$alias}.order_id AND {$alias}.meta_key = %s )", // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
|
||||
$clause['key']
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
return "INNER JOIN {$this->meta_table} AS {$alias} ON ( {$this->orders_table}.id = {$alias}.order_id )";
|
||||
}
|
||||
|
||||
/**
|
||||
* Finds a common table alias that the meta_query clause can use, or creates one.
|
||||
*
|
||||
* @param array $clause An atomic meta_query clause.
|
||||
* @param array $parent_query The parent query this clause is in.
|
||||
* @return string A table alias for use in an SQL JOIN clause.
|
||||
*/
|
||||
private function find_or_create_table_alias_for_clause( array $clause, array $parent_query ): string {
|
||||
if ( ! empty( $clause['alias'] ) ) {
|
||||
return $clause['alias'];
|
||||
}
|
||||
|
||||
$alias = false;
|
||||
$siblings = array_filter(
|
||||
$parent_query,
|
||||
array( __CLASS__, 'is_atomic' )
|
||||
);
|
||||
|
||||
foreach ( $siblings as $sibling ) {
|
||||
if ( empty( $sibling['alias'] ) ) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if ( $this->is_operator_compatible_with_shared_join( $clause, $sibling, $parent_query['relation'] ?? 'AND' ) ) {
|
||||
$alias = $sibling['alias'];
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if ( ! $alias ) {
|
||||
$alias = self::ALIAS_PREFIX . count( $this->table_aliases );
|
||||
$this->join[] = $this->generate_join_for_clause( $clause, $alias );
|
||||
$this->table_aliases[] = $alias;
|
||||
}
|
||||
|
||||
return $alias;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks whether two meta_query clauses can share a JOIN.
|
||||
*
|
||||
* @param array $clause An atomic meta_query clause.
|
||||
* @param array $sibling An atomic meta_query clause.
|
||||
* @param string $relation The relation involving both clauses.
|
||||
* @return boolean TRUE if the clauses can share a table alias, FALSE otherwise.
|
||||
*/
|
||||
private function is_operator_compatible_with_shared_join( array $clause, array $sibling, string $relation = 'AND' ): bool {
|
||||
if ( ! $this->is_atomic( $clause ) || ! $this->is_atomic( $sibling ) ) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$valid_operators = array();
|
||||
|
||||
if ( 'OR' === $relation ) {
|
||||
$valid_operators = array( '=', 'IN', 'BETWEEN', 'LIKE', 'REGEXP', 'RLIKE', '>', '>=', '<', '<=' );
|
||||
} elseif ( isset( $sibling['key'] ) && isset( $clause['key'] ) && $sibling['key'] === $clause['key'] ) {
|
||||
$valid_operators = array( '!=', 'NOT IN', 'NOT LIKE' );
|
||||
}
|
||||
|
||||
return in_array( strtoupper( $clause['compare'] ), $valid_operators, true ) && in_array( strtoupper( $sibling['compare'] ), $valid_operators, true );
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates an SQL WHERE clause for a given meta_query atomic clause based on its meta key.
|
||||
* Adapted from WordPress' `WP_Meta_Query::get_sql_for_clause()` method.
|
||||
*
|
||||
* @param array $clause An atomic meta_query clause.
|
||||
* @return string An SQL WHERE clause or an empty string if $clause is invalid.
|
||||
*/
|
||||
private function generate_where_for_clause_key( array $clause ): string {
|
||||
global $wpdb;
|
||||
|
||||
if ( ! array_key_exists( 'key', $clause ) ) {
|
||||
return '';
|
||||
}
|
||||
|
||||
if ( 'NOT EXISTS' === $clause['compare'] ) {
|
||||
return "{$clause['alias']}.order_id IS NULL";
|
||||
}
|
||||
|
||||
$alias = $clause['alias'];
|
||||
|
||||
if ( in_array( $clause['compare_key'], array( '!=', 'NOT IN', 'NOT LIKE', 'NOT EXISTS', 'NOT REGEXP' ), true ) ) {
|
||||
$i = count( $this->table_aliases );
|
||||
$subquery_alias = self::ALIAS_PREFIX . $i;
|
||||
$this->table_aliases[] = $subquery_alias;
|
||||
|
||||
$meta_compare_string_start = 'NOT EXISTS (';
|
||||
$meta_compare_string_start .= "SELECT 1 FROM {$this->meta_table} {$subquery_alias} ";
|
||||
$meta_compare_string_start .= "WHERE {$subquery_alias}.order_id = {$alias}.order_id ";
|
||||
$meta_compare_string_end = 'LIMIT 1';
|
||||
$meta_compare_string_end .= ')';
|
||||
}
|
||||
|
||||
switch ( $clause['compare_key'] ) {
|
||||
case '=':
|
||||
case 'EXISTS':
|
||||
$where = $wpdb->prepare( "$alias.meta_key = %s", trim( $clause['key'] ) ); // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
|
||||
break;
|
||||
case 'LIKE':
|
||||
$meta_compare_value = '%' . $wpdb->esc_like( trim( $clause['key'] ) ) . '%';
|
||||
$where = $wpdb->prepare( "$alias.meta_key LIKE %s", $meta_compare_value ); // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
|
||||
break;
|
||||
case 'IN':
|
||||
$meta_compare_string = "$alias.meta_key IN (" . substr( str_repeat( ',%s', count( $clause['key'] ) ), 1 ) . ')';
|
||||
$where = $wpdb->prepare( $meta_compare_string, $clause['key'] ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
|
||||
break;
|
||||
case 'RLIKE':
|
||||
case 'REGEXP':
|
||||
$operator = $clause['compare_key'];
|
||||
if ( isset( $clause['type_key'] ) && 'BINARY' === strtoupper( $clause['type_key'] ) ) {
|
||||
$cast = 'BINARY';
|
||||
} else {
|
||||
$cast = '';
|
||||
}
|
||||
$where = $wpdb->prepare( "$alias.meta_key $operator $cast %s", trim( $clause['key'] ) ); // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
|
||||
break;
|
||||
case '!=':
|
||||
case 'NOT EXISTS':
|
||||
$meta_compare_string = $meta_compare_string_start . "AND $subquery_alias.meta_key = %s " . $meta_compare_string_end;
|
||||
$where = $wpdb->prepare( $meta_compare_string, $clause['key'] ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
|
||||
break;
|
||||
case 'NOT LIKE':
|
||||
$meta_compare_string = $meta_compare_string_start . "AND $subquery_alias.meta_key LIKE %s " . $meta_compare_string_end;
|
||||
|
||||
$meta_compare_value = '%' . $wpdb->esc_like( trim( $clause['key'] ) ) . '%';
|
||||
$where = $wpdb->prepare( $meta_compare_string, $meta_compare_value ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
|
||||
break;
|
||||
case 'NOT IN':
|
||||
$array_subclause = '(' . substr( str_repeat( ',%s', count( $clause['key'] ) ), 1 ) . ') ';
|
||||
$meta_compare_string = $meta_compare_string_start . "AND $subquery_alias.meta_key IN " . $array_subclause . $meta_compare_string_end;
|
||||
$where = $wpdb->prepare( $meta_compare_string, $clause['key'] ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
|
||||
break;
|
||||
case 'NOT REGEXP':
|
||||
$operator = $clause['compare_key'];
|
||||
if ( isset( $clause['type_key'] ) && 'BINARY' === strtoupper( $clause['type_key'] ) ) {
|
||||
$cast = 'BINARY';
|
||||
} else {
|
||||
$cast = '';
|
||||
}
|
||||
|
||||
$meta_compare_string = $meta_compare_string_start . "AND $subquery_alias.meta_key REGEXP $cast %s " . $meta_compare_string_end;
|
||||
$where = $wpdb->prepare( $meta_compare_string, $clause['key'] ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
|
||||
break;
|
||||
default:
|
||||
$where = '';
|
||||
break;
|
||||
}
|
||||
|
||||
return $where;
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates an SQL WHERE clause for a given meta_query atomic clause based on its meta value.
|
||||
* Adapted from WordPress' `WP_Meta_Query::get_sql_for_clause()` method.
|
||||
*
|
||||
* @param array $clause An atomic meta_query clause.
|
||||
* @return string An SQL WHERE clause or an empty string if $clause is invalid.
|
||||
*/
|
||||
private function generate_where_for_clause_value( $clause ): string {
|
||||
global $wpdb;
|
||||
|
||||
if ( ! array_key_exists( 'value', $clause ) ) {
|
||||
return '';
|
||||
}
|
||||
|
||||
$meta_value = $clause['value'];
|
||||
|
||||
if ( in_array( $clause['compare'], array( 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN' ), true ) ) {
|
||||
if ( ! is_array( $meta_value ) ) {
|
||||
$meta_value = preg_split( '/[,\s]+/', $meta_value );
|
||||
}
|
||||
} elseif ( is_string( $meta_value ) ) {
|
||||
$meta_value = trim( $meta_value );
|
||||
}
|
||||
|
||||
$meta_compare = $clause['compare'];
|
||||
|
||||
switch ( $meta_compare ) {
|
||||
case 'IN':
|
||||
case 'NOT IN':
|
||||
$where = $wpdb->prepare( '(' . substr( str_repeat( ',%s', count( $meta_value ) ), 1 ) . ')', $meta_value ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
|
||||
break;
|
||||
|
||||
case 'BETWEEN':
|
||||
case 'NOT BETWEEN':
|
||||
$where = $wpdb->prepare( '%s AND %s', $meta_value[0], $meta_value[1] );
|
||||
break;
|
||||
|
||||
case 'LIKE':
|
||||
case 'NOT LIKE':
|
||||
$where = $wpdb->prepare( '%s', '%' . $wpdb->esc_like( $meta_value ) . '%' );
|
||||
break;
|
||||
|
||||
// EXISTS with a value is interpreted as '='.
|
||||
case 'EXISTS':
|
||||
$meta_compare = '=';
|
||||
$where = $wpdb->prepare( '%s', $meta_value );
|
||||
break;
|
||||
|
||||
// 'value' is ignored for NOT EXISTS.
|
||||
case 'NOT EXISTS':
|
||||
$where = '';
|
||||
break;
|
||||
|
||||
default:
|
||||
$where = $wpdb->prepare( '%s', $meta_value );
|
||||
break;
|
||||
}
|
||||
|
||||
if ( $where ) {
|
||||
if ( 'CHAR' === $clause['cast'] ) {
|
||||
return "{$clause['alias']}.meta_value {$meta_compare} {$where}";
|
||||
} else {
|
||||
return "CAST({$clause['alias']}.meta_value AS {$clause['cast']}) {$meta_compare} {$where}";
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,194 @@
|
||||
<?php
|
||||
/**
|
||||
* Order refund data store. Refunds are based on orders (essentially negative orders) but there is slight difference in how we save them.
|
||||
* For example, order save hooks etc can't be fired when saving refund, so we need to do it a separate datastore.
|
||||
*/
|
||||
|
||||
namespace Automattic\WooCommerce\Internal\DataStores\Orders;
|
||||
|
||||
/**
|
||||
* Class OrdersTableRefundDataStore.
|
||||
*/
|
||||
class OrdersTableRefundDataStore extends OrdersTableDataStore {
|
||||
|
||||
/**
|
||||
* We do not have and use all the getters and setters from OrderTableDataStore, so we only select the props we actually need.
|
||||
*
|
||||
* @var \string[][]
|
||||
*/
|
||||
protected $operational_data_column_mapping = array(
|
||||
'id' => array( 'type' => 'int' ),
|
||||
'order_id' => array( 'type' => 'int' ),
|
||||
'woocommerce_version' => array(
|
||||
'type' => 'string',
|
||||
'name' => 'version',
|
||||
),
|
||||
'prices_include_tax' => array(
|
||||
'type' => 'bool',
|
||||
'name' => 'prices_include_tax',
|
||||
),
|
||||
'coupon_usages_are_counted' => array(
|
||||
'type' => 'bool',
|
||||
'name' => 'recorded_coupon_usage_counts',
|
||||
),
|
||||
'shipping_tax_amount' => array(
|
||||
'type' => 'decimal',
|
||||
'name' => 'shipping_tax',
|
||||
),
|
||||
'shipping_total_amount' => array(
|
||||
'type' => 'decimal',
|
||||
'name' => 'shipping_total',
|
||||
),
|
||||
'discount_tax_amount' => array(
|
||||
'type' => 'decimal',
|
||||
'name' => 'discount_tax',
|
||||
),
|
||||
'discount_total_amount' => array(
|
||||
'type' => 'decimal',
|
||||
'name' => 'discount_total',
|
||||
),
|
||||
);
|
||||
|
||||
/**
|
||||
* Delete a refund order from database.
|
||||
*
|
||||
* @param \WC_Order $refund Refund object to delete.
|
||||
* @param array $args Array of args to pass to the delete method.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function delete( &$refund, $args = array() ) {
|
||||
$refund_id = $refund->get_id();
|
||||
if ( ! $refund_id ) {
|
||||
return;
|
||||
}
|
||||
|
||||
$this->delete_order_data_from_custom_order_tables( $refund_id );
|
||||
$refund->set_id( 0 );
|
||||
|
||||
// If this datastore method is called while the posts table is authoritative, refrain from deleting post data.
|
||||
if ( ! is_a( $refund->get_data_store(), self::class ) ) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Delete the associated post, which in turn deletes order items, etc. through {@see WC_Post_Data}.
|
||||
// Once we stop creating posts for orders, we should do the cleanup here instead.
|
||||
wp_delete_post( $refund_id );
|
||||
}
|
||||
|
||||
/**
|
||||
* Read a refund object from custom tables.
|
||||
*
|
||||
* @param \WC_Abstract_Order $refund Refund object.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function read( &$refund ) {
|
||||
parent::read( $refund );
|
||||
$this->set_refund_props( $refund );
|
||||
}
|
||||
|
||||
/**
|
||||
* Read multiple refund objects from custom tables.
|
||||
*
|
||||
* @param \WC_Order $refunds Refund objects.
|
||||
*/
|
||||
public function read_multiple( &$refunds ) {
|
||||
parent::read_multiple( $refunds );
|
||||
foreach ( $refunds as $refund ) {
|
||||
$this->set_refund_props( $refund );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Helper method to set refund props.
|
||||
*
|
||||
* @param \WC_Order $refund Refund object.
|
||||
*/
|
||||
private function set_refund_props( $refund ) {
|
||||
$refund->set_props(
|
||||
array(
|
||||
'amount' => $refund->get_meta( '_refund_amount', true ),
|
||||
'refunded_by' => $refund->get_meta( '_refunded_by', true ),
|
||||
'refunded_payment' => wc_string_to_bool( $refund->get_meta( '_refunded_payment', true ) ),
|
||||
'reason' => $refund->get_meta( '_refund_reason', true ),
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Method to create a refund in the database.
|
||||
*
|
||||
* @param \WC_Abstract_Order $refund Refund object.
|
||||
*/
|
||||
public function create( &$refund ) {
|
||||
$refund->set_status( 'completed' ); // Refund are always marked completed.
|
||||
$this->persist_save( $refund );
|
||||
}
|
||||
|
||||
/**
|
||||
* Update refund in database.
|
||||
*
|
||||
* @param \WC_Order $refund Refund object.
|
||||
*/
|
||||
public function update( &$refund ) {
|
||||
$this->persist_updates( $refund );
|
||||
}
|
||||
|
||||
/**
|
||||
* Helper method that updates post meta based on an refund object.
|
||||
* Mostly used for backwards compatibility purposes in this datastore.
|
||||
*
|
||||
* @param \WC_Order $refund Refund object.
|
||||
*/
|
||||
public function update_order_meta( &$refund ) {
|
||||
parent::update_order_meta( $refund );
|
||||
|
||||
// Update additional props.
|
||||
$updated_props = array();
|
||||
$meta_key_to_props = array(
|
||||
'_refund_amount' => 'amount',
|
||||
'_refunded_by' => 'refunded_by',
|
||||
'_refunded_payment' => 'refunded_payment',
|
||||
'_refund_reason' => 'reason',
|
||||
);
|
||||
|
||||
$props_to_update = $this->get_props_to_update( $refund, $meta_key_to_props );
|
||||
foreach ( $props_to_update as $meta_key => $prop ) {
|
||||
$value = $refund->{"get_$prop"}( 'edit' );
|
||||
$refund->update_meta_data( $meta_key, $value );
|
||||
$updated_props[] = $prop;
|
||||
}
|
||||
|
||||
/**
|
||||
* Fires after updating meta for a order refund.
|
||||
*
|
||||
* @since 2.7.0
|
||||
*/
|
||||
do_action( 'woocommerce_order_refund_object_updated_props', $refund, $updated_props );
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a title for the new post type.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
protected function get_post_title() {
|
||||
return sprintf(
|
||||
/* translators: %s: Order date */
|
||||
__( 'Refund – %s', 'woocommerce' ),
|
||||
( new \DateTime( 'now' ) )->format( _x( 'M d, Y @ h:i A', 'Order date parsed by DateTime::format', 'woocommerce' ) ) // phpcs:ignore WordPress.WP.I18n.MissingTranslatorsComment, WordPress.WP.I18n.UnorderedPlaceholdersText
|
||||
);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Returns data store object to use backfilling.
|
||||
*
|
||||
* @return \WC_Order_Refund_Data_Store_CPT
|
||||
*/
|
||||
protected function get_post_data_store_for_backfill() {
|
||||
return new \WC_Order_Refund_Data_Store_CPT();
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,157 @@
|
||||
<?php
|
||||
|
||||
namespace Automattic\WooCommerce\Internal\DataStores\Orders;
|
||||
|
||||
use Exception;
|
||||
|
||||
/**
|
||||
* Creates the join and where clauses needed to perform an order search using Custom Order Tables.
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
class OrdersTableSearchQuery {
|
||||
/**
|
||||
* Holds the Orders Table Query object.
|
||||
*
|
||||
* @var OrdersTableQuery
|
||||
*/
|
||||
private $query;
|
||||
|
||||
/**
|
||||
* Holds the search term to be used in the WHERE clauses.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
private $search_term;
|
||||
|
||||
/**
|
||||
* Creates the JOIN and WHERE clauses needed to execute a search of orders.
|
||||
*
|
||||
* @internal
|
||||
*
|
||||
* @param OrdersTableQuery $query The order query object.
|
||||
*/
|
||||
public function __construct( OrdersTableQuery $query ) {
|
||||
$this->query = $query;
|
||||
$this->search_term = "'" . esc_sql( '%' . urldecode( $query->get( 's' ) ) . '%' ) . "'";
|
||||
}
|
||||
|
||||
/**
|
||||
* Supplies an array of clauses to be used in an order query.
|
||||
*
|
||||
* @internal
|
||||
* @throws Exception If unable to generate either the JOIN or WHERE SQL fragments.
|
||||
*
|
||||
* @return array {
|
||||
* @type string $join JOIN clause.
|
||||
* @type string $where WHERE clause.
|
||||
* }
|
||||
*/
|
||||
public function get_sql_clauses(): array {
|
||||
return array(
|
||||
'join' => array( $this->generate_join() ),
|
||||
'where' => array( $this->generate_where() ),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates the necessary JOIN clauses for the order search to be performed.
|
||||
*
|
||||
* @throws Exception May be triggered if a table name cannot be determined.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
private function generate_join(): string {
|
||||
$orders_table = $this->query->get_table_name( 'orders' );
|
||||
$items_table = $this->query->get_table_name( 'items' );
|
||||
|
||||
return "
|
||||
LEFT JOIN $items_table AS search_query_items ON search_query_items.order_id = $orders_table.id
|
||||
";
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates the necessary WHERE clauses for the order search to be performed.
|
||||
*
|
||||
* @throws Exception May be triggered if a table name cannot be determined.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
private function generate_where(): string {
|
||||
$where = '';
|
||||
$possible_order_id = (string) absint( $this->query->get( 's' ) );
|
||||
$order_table = $this->query->get_table_name( 'orders' );
|
||||
|
||||
// Support the passing of an order ID as the search term.
|
||||
if ( (string) $this->query->get( 's' ) === $possible_order_id ) {
|
||||
$where = "`$order_table`.id = $possible_order_id OR ";
|
||||
}
|
||||
|
||||
$meta_sub_query = $this->generate_where_for_meta_table();
|
||||
|
||||
$where .= "
|
||||
search_query_items.order_item_name LIKE $this->search_term
|
||||
OR `$order_table`.id IN ( $meta_sub_query )
|
||||
";
|
||||
|
||||
return " ( $where ) ";
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates where clause for meta table.
|
||||
*
|
||||
* Note we generate the where clause as a subquery to be used by calling function inside the IN clause. This is against the general wisdom for performance, but in this particular case, a subquery is able to use the order_id-meta_key-meta_value index, which is not possible with a join.
|
||||
*
|
||||
* Since it can use the index, which otherwise would not be possible, it is much faster than both LEFT JOIN or SQL_CALC approach that could have been used.
|
||||
*
|
||||
* @return string The where clause for meta table.
|
||||
*/
|
||||
private function generate_where_for_meta_table(): string {
|
||||
$meta_table = $this->query->get_table_name( 'meta' );
|
||||
$meta_fields = $this->get_meta_fields_to_be_searched();
|
||||
return "
|
||||
SELECT search_query_meta.order_id
|
||||
FROM $meta_table as search_query_meta
|
||||
WHERE search_query_meta.meta_key IN ( $meta_fields )
|
||||
AND search_query_meta.meta_value LIKE $this->search_term
|
||||
GROUP BY search_query_meta.order_id
|
||||
";
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the order meta field keys to be searched.
|
||||
*
|
||||
* These will be returned as a single string, where the meta keys have been escaped, quoted and are
|
||||
* comma-separated (ie, "'abc', 'foo'" - ready for inclusion in a SQL IN() clause).
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
private function get_meta_fields_to_be_searched(): string {
|
||||
/**
|
||||
* Controls the order meta keys to be included in search queries.
|
||||
*
|
||||
* This hook is used when Custom Order Tables are in use: the corresponding hook when CPT-orders are in use
|
||||
* is 'woocommerce_shop_order_search_fields'.
|
||||
*
|
||||
* @since 7.0.0
|
||||
*
|
||||
* @param array
|
||||
*/
|
||||
$meta_keys = apply_filters(
|
||||
'woocommerce_order_table_search_query_meta_keys',
|
||||
array(
|
||||
'_billing_address_index',
|
||||
'_shipping_address_index',
|
||||
)
|
||||
);
|
||||
|
||||
$meta_keys = (array) array_map(
|
||||
function ( string $meta_key ): string {
|
||||
return "'" . esc_sql( wc_clean( $meta_key ) ) . "'";
|
||||
},
|
||||
$meta_keys
|
||||
);
|
||||
|
||||
return implode( ',', $meta_keys );
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user