<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* REST API Analytics Imports Controller

[2] Fix | Delete

*

[3] Fix | Delete

* Handles requests to get batch import status and trigger manual imports.

[4] Fix | Delete

*/

[5] Fix | Delete

[6] Fix | Delete

declare( strict_types = 1 );

[7] Fix | Delete

[8] Fix | Delete

namespace Automattic\WooCommerce\Admin\API;

[9] Fix | Delete

[10] Fix | Delete

use WP_Error;

[11] Fix | Delete

use Automattic\WooCommerce\Internal\Admin\Schedulers\OrdersScheduler;

[12] Fix | Delete

[13] Fix | Delete

defined( 'ABSPATH' ) || exit;

[14] Fix | Delete

[15] Fix | Delete

/**

[16] Fix | Delete

* REST API Analytics Imports Controller.

[17] Fix | Delete

*

[18] Fix | Delete

* @internal

[19] Fix | Delete

*/

[20] Fix | Delete

class AnalyticsImports extends \WC_REST_Data_Controller {

[21] Fix | Delete

/**

[22] Fix | Delete

* Endpoint namespace.

[23] Fix | Delete

*

[24] Fix | Delete

* @var string

[25] Fix | Delete

*/

[26] Fix | Delete

protected $namespace = 'wc-analytics';

[27] Fix | Delete

[28] Fix | Delete

/**

[29] Fix | Delete

* Route base.

[30] Fix | Delete

*

[31] Fix | Delete

* @var string

[32] Fix | Delete

*/

[33] Fix | Delete

protected $rest_base = 'imports';

[34] Fix | Delete

[35] Fix | Delete

/**

[36] Fix | Delete

* Register routes.

[37] Fix | Delete

*

[38] Fix | Delete

* @return void

[39] Fix | Delete

*/

[40] Fix | Delete

public function register_routes(): void {

[41] Fix | Delete

register_rest_route(

[42] Fix | Delete

$this->namespace,

[43] Fix | Delete

'/' . $this->rest_base . '/status',

[44] Fix | Delete

array(

[45] Fix | Delete

array(

[46] Fix | Delete

'methods' => \WP_REST_Server::READABLE,

[47] Fix | Delete

'callback' => array( $this, 'get_status' ),

[48] Fix | Delete

'permission_callback' => array( $this, 'permissions_check' ),

[49] Fix | Delete

),

[50] Fix | Delete

'schema' => array( $this, 'get_status_schema' ),

[51] Fix | Delete

)

[52] Fix | Delete

);

[53] Fix | Delete

[54] Fix | Delete

register_rest_route(

[55] Fix | Delete

$this->namespace,

[56] Fix | Delete

'/' . $this->rest_base . '/trigger',

[57] Fix | Delete

array(

[58] Fix | Delete

array(

[59] Fix | Delete

'methods' => \WP_REST_Server::CREATABLE,

[60] Fix | Delete

'callback' => array( $this, 'trigger_import' ),

[61] Fix | Delete

'permission_callback' => array( $this, 'permissions_check' ),

[62] Fix | Delete

),

[63] Fix | Delete

'schema' => array( $this, 'get_trigger_schema' ),

[64] Fix | Delete

)

[65] Fix | Delete

);

[66] Fix | Delete

}

[67] Fix | Delete

[68] Fix | Delete

/**

[69] Fix | Delete

* Check if a given request has access to analytics imports.

[70] Fix | Delete

*

[71] Fix | Delete

* @param \WP_REST_Request<array<string, mixed>> $request Full details about the request.

[72] Fix | Delete

* @return WP_Error|boolean

[73] Fix | Delete

*/

[74] Fix | Delete

public function permissions_check( $request ) {

[75] Fix | Delete

if ( ! current_user_can( 'manage_woocommerce' ) ) {

[76] Fix | Delete

return new WP_Error(

[77] Fix | Delete

'woocommerce_rest_cannot_access',

[78] Fix | Delete

__( 'Sorry, you cannot access analytics imports.', 'woocommerce' ),

[79] Fix | Delete

array( 'status' => rest_authorization_required_code() )

[80] Fix | Delete

);

[81] Fix | Delete

}

[82] Fix | Delete

[83] Fix | Delete

return true;

[84] Fix | Delete

}

[85] Fix | Delete

[86] Fix | Delete

/**

[87] Fix | Delete

* Get the current import status.

[88] Fix | Delete

*

[89] Fix | Delete

* @param \WP_REST_Request<array<string, mixed>> $request Full details about the request.

[90] Fix | Delete

* @return \WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.

[91] Fix | Delete

*/

[92] Fix | Delete

public function get_status( $request ) {

[93] Fix | Delete

$is_scheduled_mode = $this->is_scheduled_import_enabled();

[94] Fix | Delete

$mode = $is_scheduled_mode ? 'scheduled' : 'immediate';

[95] Fix | Delete

[96] Fix | Delete

$response = array(

[97] Fix | Delete

'mode' => $mode,

[98] Fix | Delete

'last_processed_date' => null,

[99] Fix | Delete

'next_scheduled' => null,

[100] Fix | Delete

'import_in_progress_or_due' => null,

[101] Fix | Delete

);

[102] Fix | Delete

[103] Fix | Delete

// For scheduled mode, populate additional fields.

[104] Fix | Delete

if ( $is_scheduled_mode ) {

[105] Fix | Delete

$last_processed_gmt = get_option( OrdersScheduler::LAST_PROCESSED_ORDER_DATE_OPTION, null );

[106] Fix | Delete

$response['last_processed_date'] = ( is_string( $last_processed_gmt ) && $last_processed_gmt ) ? get_date_from_gmt( $last_processed_gmt, 'Y-m-d H:i:s' ) : null;

[107] Fix | Delete

$response['next_scheduled'] = $this->get_next_scheduled_time();

[108] Fix | Delete

$response['import_in_progress_or_due'] = $this->is_import_in_progress_or_due();

[109] Fix | Delete

}

[110] Fix | Delete

[111] Fix | Delete

return rest_ensure_response( $response );

[112] Fix | Delete

}

[113] Fix | Delete

[114] Fix | Delete

/**

[115] Fix | Delete

* Trigger a manual import.

[116] Fix | Delete

*

[117] Fix | Delete

* @param \WP_REST_Request<array<string, mixed>> $request Full details about the request.

[118] Fix | Delete

* @return \WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.

[119] Fix | Delete

*/

[120] Fix | Delete

public function trigger_import( $request ) {

[121] Fix | Delete

$is_scheduled_mode = $this->is_scheduled_import_enabled();

[122] Fix | Delete

[123] Fix | Delete

// Return error if in immediate mode.

[124] Fix | Delete

if ( ! $is_scheduled_mode ) {

[125] Fix | Delete

return new WP_Error(

[126] Fix | Delete

'woocommerce_rest_analytics_import_immediate_mode',

[127] Fix | Delete

__( 'Manual import is not available in immediate mode. Imports happen automatically.', 'woocommerce' ),

[128] Fix | Delete

array( 'status' => 400 )

[129] Fix | Delete

);

[130] Fix | Delete

}

[131] Fix | Delete

[132] Fix | Delete

// Check if an import is already in progress or due to run soon.

[133] Fix | Delete

if ( $this->is_import_in_progress_or_due() ) {

[134] Fix | Delete

return new WP_Error(

[135] Fix | Delete

'woocommerce_rest_analytics_import_in_progress',

[136] Fix | Delete

__( 'A batch import is already in progress or scheduled to run soon. Please wait for it to complete before triggering a new import.', 'woocommerce' ),

[137] Fix | Delete

array( 'status' => 400 )

[138] Fix | Delete

);

[139] Fix | Delete

}

[140] Fix | Delete

[141] Fix | Delete

// Trigger the batch import immediately by rescheduling the recurring processor.

[142] Fix | Delete

// This unschedules the current recurring action and reschedules it to run now.

[143] Fix | Delete

$action_hook = OrdersScheduler::get_action( OrdersScheduler::PROCESS_PENDING_ORDERS_BATCH_ACTION );

[144] Fix | Delete

if ( ! is_string( $action_hook ) ) {

[145] Fix | Delete

return new WP_Error(

[146] Fix | Delete

'woocommerce_rest_analytics_import_invalid_action',

[147] Fix | Delete

__( 'Invalid action hook for batch import.', 'woocommerce' ),

[148] Fix | Delete

array( 'status' => 500 )

[149] Fix | Delete

);

[150] Fix | Delete

}

[151] Fix | Delete

WC()->queue()->cancel_all( $action_hook, array(), (string) OrdersScheduler::$group );

[152] Fix | Delete

OrdersScheduler::schedule_recurring_batch_processor();

[153] Fix | Delete

[154] Fix | Delete

return rest_ensure_response(

[155] Fix | Delete

array(

[156] Fix | Delete

'success' => true,

[157] Fix | Delete

'message' => __( 'Batch import triggered successfully.', 'woocommerce' ),

[158] Fix | Delete

)

[159] Fix | Delete

);

[160] Fix | Delete

}

[161] Fix | Delete

[162] Fix | Delete

/**

[163] Fix | Delete

* Check if scheduled import is enabled.

[164] Fix | Delete

*

[165] Fix | Delete

* @return bool

[166] Fix | Delete

*/

[167] Fix | Delete

private function is_scheduled_import_enabled() {

[168] Fix | Delete

return 'yes' === get_option( OrdersScheduler::SCHEDULED_IMPORT_OPTION, OrdersScheduler::SCHEDULED_IMPORT_OPTION_DEFAULT_VALUE );

[169] Fix | Delete

}

[170] Fix | Delete

[171] Fix | Delete

/**

[172] Fix | Delete

* Get the next scheduled time for the batch processor.

[173] Fix | Delete

*

[174] Fix | Delete

* @return string|null Datetime string in site timezone or null if not scheduled.

[175] Fix | Delete

*/

[176] Fix | Delete

private function get_next_scheduled_time() {

[177] Fix | Delete

$action_hook = OrdersScheduler::get_action( OrdersScheduler::PROCESS_PENDING_ORDERS_BATCH_ACTION );

[178] Fix | Delete

if ( ! is_string( $action_hook ) ) {

[179] Fix | Delete

return null;

[180] Fix | Delete

}

[181] Fix | Delete

$next_time = WC()->queue()->get_next( $action_hook, array(), (string) OrdersScheduler::$group );

[182] Fix | Delete

[183] Fix | Delete

if ( ! $next_time ) {

[184] Fix | Delete

return null;

[185] Fix | Delete

}

[186] Fix | Delete

[187] Fix | Delete

// Convert UTC timestamp to site timezone.

[188] Fix | Delete

return get_date_from_gmt( $next_time->format( 'Y-m-d H:i:s' ), 'Y-m-d H:i:s' );

[189] Fix | Delete

}

[190] Fix | Delete

[191] Fix | Delete

/**

[192] Fix | Delete

* Get the schema for the status endpoint, conforming to JSON Schema.

[193] Fix | Delete

*

[194] Fix | Delete

* @return array

[195] Fix | Delete

*/

[196] Fix | Delete

public function get_status_schema() {

[197] Fix | Delete

$schema = array(

[198] Fix | Delete

'$schema' => 'https://json-schema.org/draft-04/schema#',

[199] Fix | Delete

'title' => 'analytics_import_status',

[200] Fix | Delete

'type' => 'object',

[201] Fix | Delete

'properties' => array(

[202] Fix | Delete

'mode' => array(

[203] Fix | Delete

'type' => 'string',

[204] Fix | Delete

'enum' => array( 'scheduled', 'immediate' ),

[205] Fix | Delete

'description' => __( 'Current import mode.', 'woocommerce' ),

[206] Fix | Delete

'context' => array( 'view' ),

[207] Fix | Delete

'readonly' => true,

[208] Fix | Delete

),

[209] Fix | Delete

'last_processed_date' => array(

[210] Fix | Delete

'type' => array( 'string', 'null' ),

[211] Fix | Delete

'description' => __( 'Last processed order date (null in immediate mode).', 'woocommerce' ),

[212] Fix | Delete

'context' => array( 'view' ),

[213] Fix | Delete

'readonly' => true,

[214] Fix | Delete

),

[215] Fix | Delete

'next_scheduled' => array(

[216] Fix | Delete

'type' => array( 'string', 'null' ),

[217] Fix | Delete

'description' => __( 'Next scheduled import time (null in immediate mode).', 'woocommerce' ),

[218] Fix | Delete

'context' => array( 'view' ),

[219] Fix | Delete

'readonly' => true,

[220] Fix | Delete

),

[221] Fix | Delete

'import_in_progress_or_due' => array(

[222] Fix | Delete

'type' => array( 'boolean', 'null' ),

[223] Fix | Delete

'description' => __( 'Whether a batch import is currently running or scheduled to run within the next minute (null in immediate mode).', 'woocommerce' ),

[224] Fix | Delete

'context' => array( 'view' ),

[225] Fix | Delete

'readonly' => true,

[226] Fix | Delete

),

[227] Fix | Delete

),

[228] Fix | Delete

);

[229] Fix | Delete

[230] Fix | Delete

return $this->add_additional_fields_schema( $schema );

[231] Fix | Delete

}

[232] Fix | Delete

[233] Fix | Delete

/**

[234] Fix | Delete

* Get the schema for the trigger endpoint, conforming to JSON Schema.

[235] Fix | Delete

*

[236] Fix | Delete

* @return array

[237] Fix | Delete

*/

[238] Fix | Delete

public function get_trigger_schema() {

[239] Fix | Delete

$schema = array(

[240] Fix | Delete

'$schema' => 'https://json-schema.org/draft-04/schema#',

[241] Fix | Delete

'title' => 'analytics_import_trigger',

[242] Fix | Delete

'type' => 'object',

[243] Fix | Delete

'properties' => array(

[244] Fix | Delete

'success' => array(

[245] Fix | Delete

'type' => 'boolean',

[246] Fix | Delete

'description' => __( 'Whether the trigger was successful.', 'woocommerce' ),

[247] Fix | Delete

'context' => array( 'view' ),

[248] Fix | Delete

'readonly' => true,

[249] Fix | Delete

),

[250] Fix | Delete

'message' => array(

[251] Fix | Delete

'type' => 'string',

[252] Fix | Delete

'description' => __( 'Result message.', 'woocommerce' ),

[253] Fix | Delete

'context' => array( 'view' ),

[254] Fix | Delete

'readonly' => true,

[255] Fix | Delete

),

[256] Fix | Delete

),

[257] Fix | Delete

);

[258] Fix | Delete

[259] Fix | Delete

return $this->add_additional_fields_schema( $schema );

[260] Fix | Delete

}

[261] Fix | Delete

[262] Fix | Delete

/**

[263] Fix | Delete

* Check if a batch import is currently in progress or due to run soon.

[264] Fix | Delete

*

[265] Fix | Delete

* @return bool True if a batch import is in progress or scheduled to run within the next minute, false otherwise.

[266] Fix | Delete

*/

[267] Fix | Delete

private function is_import_in_progress_or_due() {

[268] Fix | Delete

$hook = OrdersScheduler::get_action( OrdersScheduler::PROCESS_PENDING_ORDERS_BATCH_ACTION );

[269] Fix | Delete

if ( ! is_string( $hook ) ) {

[270] Fix | Delete

return false;

[271] Fix | Delete

}

[272] Fix | Delete

[273] Fix | Delete

// Check for actions with 'in-progress' status.

[274] Fix | Delete

$in_progress_actions = WC()->queue()->search(

[275] Fix | Delete

array(

[276] Fix | Delete

'hook' => $hook,

[277] Fix | Delete

'status' => 'in-progress',

[278] Fix | Delete

'per_page' => 1,

[279] Fix | Delete

),

[280] Fix | Delete

'ids'

[281] Fix | Delete

);

[282] Fix | Delete

[283] Fix | Delete

if ( ! empty( $in_progress_actions ) ) {

[284] Fix | Delete

return true;

[285] Fix | Delete

}

[286] Fix | Delete

[287] Fix | Delete

// Check if the next scheduled import is due within 1 minute.

[288] Fix | Delete

$next_scheduled = WC()->queue()->get_next( $hook, array(), (string) OrdersScheduler::$group );

[289] Fix | Delete

if ( $next_scheduled ) {

[290] Fix | Delete

$time_until_next = $next_scheduled->getTimestamp() - time();

[291] Fix | Delete

// Consider it "due" if it's scheduled to run within the next 60 seconds.

[292] Fix | Delete

if ( $time_until_next <= MINUTE_IN_SECONDS ) {

[293] Fix | Delete

return true;

[294] Fix | Delete

}

[295] Fix | Delete

}

[296] Fix | Delete

[297] Fix | Delete

return false;

[298] Fix | Delete

}

[299] Fix | Delete

}

[300] Fix | Delete

[301] Fix | Delete