<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* WooCommerce Analytics.

[2] Fix | Delete

*/

[3] Fix | Delete

[4] Fix | Delete

namespace Automattic\WooCommerce\Internal\Admin;

[5] Fix | Delete

[6] Fix | Delete

use Automattic\WooCommerce\Admin\API\Reports\Cache;

[7] Fix | Delete

use Automattic\WooCommerce\Utilities\OrderUtil;

[8] Fix | Delete

use Automattic\WooCommerce\Admin\Features\Features;

[9] Fix | Delete

use Automattic\WooCommerce\Internal\Features\FeaturesController;

[10] Fix | Delete

use Automattic\WooCommerce\Admin\API\Reports\Orders\Stats\DataStore as OrderStatsDataStore;

[11] Fix | Delete

use Automattic\WooCommerce\Internal\DataStores\Orders\OrdersTableDataStore;

[12] Fix | Delete

[13] Fix | Delete

/**

[14] Fix | Delete

* Contains backend logic for the Analytics feature.

[15] Fix | Delete

*/

[16] Fix | Delete

class Analytics {

[17] Fix | Delete

/**

[18] Fix | Delete

* Option name used to toggle this feature.

[19] Fix | Delete

*/

[20] Fix | Delete

const TOGGLE_OPTION_NAME = 'woocommerce_analytics_enabled';

[21] Fix | Delete

/**

[22] Fix | Delete

* Clear cache tool identifier.

[23] Fix | Delete

*/

[24] Fix | Delete

const CACHE_TOOL_ID = 'clear_woocommerce_analytics_cache';

[25] Fix | Delete

[26] Fix | Delete

/**

[27] Fix | Delete

* Class instance.

[28] Fix | Delete

*

[29] Fix | Delete

* @var Analytics instance

[30] Fix | Delete

*/

[31] Fix | Delete

protected static $instance = null;

[32] Fix | Delete

[33] Fix | Delete

/**

[34] Fix | Delete

* Determines if the feature has been toggled on or off.

[35] Fix | Delete

*

[36] Fix | Delete

* @var boolean

[37] Fix | Delete

*/

[38] Fix | Delete

protected static $is_updated = false;

[39] Fix | Delete

[40] Fix | Delete

/**

[41] Fix | Delete

* Get class instance.

[42] Fix | Delete

*/

[43] Fix | Delete

public static function get_instance() {

[44] Fix | Delete

if ( ! self::$instance ) {

[45] Fix | Delete

self::$instance = new self();

[46] Fix | Delete

}

[47] Fix | Delete

return self::$instance;

[48] Fix | Delete

}

[49] Fix | Delete

[50] Fix | Delete

/**

[51] Fix | Delete

* Hook into WooCommerce.

[52] Fix | Delete

*/

[53] Fix | Delete

public function __construct() {

[54] Fix | Delete

add_action( 'update_option_' . self::TOGGLE_OPTION_NAME, array( $this, 'reload_page_on_toggle' ), 10, 2 );

[55] Fix | Delete

add_action( 'woocommerce_settings_saved', array( $this, 'maybe_reload_page' ) );

[56] Fix | Delete

[57] Fix | Delete

if ( ! Features::is_enabled( 'analytics' ) ) {

[58] Fix | Delete

return;

[59] Fix | Delete

}

[60] Fix | Delete

[61] Fix | Delete

add_filter( 'woocommerce_component_settings_preload_endpoints', array( $this, 'add_preload_endpoints' ) );

[62] Fix | Delete

add_filter( 'woocommerce_admin_get_user_data_fields', array( $this, 'add_user_data_fields' ) );

[63] Fix | Delete

add_action( 'admin_menu', array( $this, 'register_pages' ) );

[64] Fix | Delete

add_filter( 'woocommerce_debug_tools', array( $this, 'register_cache_clear_tool' ) );

[65] Fix | Delete

add_filter( 'woocommerce_debug_tools', array( $this, 'register_regenerate_order_fulfillment_status_tool' ), 12 );

[66] Fix | Delete

}

[67] Fix | Delete

[68] Fix | Delete

/**

[69] Fix | Delete

* Add the feature toggle to the features settings.

[70] Fix | Delete

*

[71] Fix | Delete

* @deprecated 7.0 The WooCommerce Admin features are now handled by the WooCommerce features engine (see the FeaturesController class).

[72] Fix | Delete

*

[73] Fix | Delete

* @param array $features Feature sections.

[74] Fix | Delete

* @return array

[75] Fix | Delete

*/

[76] Fix | Delete

public static function add_feature_toggle( $features ) {

[77] Fix | Delete

return $features;

[78] Fix | Delete

}

[79] Fix | Delete

[80] Fix | Delete

/**

[81] Fix | Delete

* Reloads the page when the option is toggled to make sure all Analytics features are loaded.

[82] Fix | Delete

*

[83] Fix | Delete

* @param string $old_value Old value.

[84] Fix | Delete

* @param string $value New value.

[85] Fix | Delete

*/

[86] Fix | Delete

public static function reload_page_on_toggle( $old_value, $value ) {

[87] Fix | Delete

if ( $old_value === $value ) {

[88] Fix | Delete

return;

[89] Fix | Delete

}

[90] Fix | Delete

[91] Fix | Delete

self::$is_updated = true;

[92] Fix | Delete

}

[93] Fix | Delete

[94] Fix | Delete

/**

[95] Fix | Delete

* Reload the page if the setting has been updated.

[96] Fix | Delete

*/

[97] Fix | Delete

public static function maybe_reload_page() {

[98] Fix | Delete

if ( ! isset( $_SERVER['REQUEST_URI'] ) || ! self::$is_updated ) {

[99] Fix | Delete

return;

[100] Fix | Delete

}

[101] Fix | Delete

[102] Fix | Delete

wp_safe_redirect( wp_unslash( $_SERVER['REQUEST_URI'] ) );

[103] Fix | Delete

exit();

[104] Fix | Delete

}

[105] Fix | Delete

[106] Fix | Delete

/**

[107] Fix | Delete

* Preload data from the countries endpoint.

[108] Fix | Delete

*

[109] Fix | Delete

* @param array $endpoints Array of preloaded endpoints.

[110] Fix | Delete

* @return array

[111] Fix | Delete

*/

[112] Fix | Delete

public function add_preload_endpoints( $endpoints ) {

[113] Fix | Delete

$screen_id = ( function_exists( 'get_current_screen' ) && get_current_screen() ) ? get_current_screen()->id : '';

[114] Fix | Delete

[115] Fix | Delete

// Only preload endpoints on wc-admin pages.

[116] Fix | Delete

if ( 'woocommerce_page_wc-admin' === $screen_id ) {

[117] Fix | Delete

$endpoints['performanceIndicators'] = '/wc-analytics/reports/performance-indicators/allowed';

[118] Fix | Delete

$endpoints['leaderboards'] = '/wc-analytics/leaderboards/allowed';

[119] Fix | Delete

}

[120] Fix | Delete

[121] Fix | Delete

return $endpoints;

[122] Fix | Delete

}

[123] Fix | Delete

[124] Fix | Delete

/**

[125] Fix | Delete

* Adds fields so that we can store user preferences for the columns to display on a report.

[126] Fix | Delete

*

[127] Fix | Delete

* @param array $user_data_fields User data fields.

[128] Fix | Delete

* @return array

[129] Fix | Delete

*/

[130] Fix | Delete

public function add_user_data_fields( $user_data_fields ) {

[131] Fix | Delete

return array_merge(

[132] Fix | Delete

$user_data_fields,

[133] Fix | Delete

array(

[134] Fix | Delete

'categories_report_columns',

[135] Fix | Delete

'coupons_report_columns',

[136] Fix | Delete

'customers_report_columns',

[137] Fix | Delete

'orders_report_columns',

[138] Fix | Delete

'products_report_columns',

[139] Fix | Delete

'revenue_report_columns',

[140] Fix | Delete

'taxes_report_columns',

[141] Fix | Delete

'variations_report_columns',

[142] Fix | Delete

'dashboard_sections',

[143] Fix | Delete

'dashboard_chart_type',

[144] Fix | Delete

'dashboard_chart_interval',

[145] Fix | Delete

'dashboard_leaderboard_rows',

[146] Fix | Delete

'order_attribution_install_banner_dismissed',

[147] Fix | Delete

'scheduled_updates_promotion_notice_dismissed',

[148] Fix | Delete

)

[149] Fix | Delete

);

[150] Fix | Delete

}

[151] Fix | Delete

[152] Fix | Delete

/**

[153] Fix | Delete

* Register the cache clearing tool on the WooCommerce > Status > Tools page.

[154] Fix | Delete

*

[155] Fix | Delete

* @param array $debug_tools Available debug tool registrations.

[156] Fix | Delete

* @return array Filtered debug tool registrations.

[157] Fix | Delete

*/

[158] Fix | Delete

public function register_cache_clear_tool( $debug_tools ) {

[159] Fix | Delete

$settings_url = add_query_arg(

[160] Fix | Delete

array(

[161] Fix | Delete

'page' => 'wc-admin',

[162] Fix | Delete

'path' => '/analytics/settings',

[163] Fix | Delete

),

[164] Fix | Delete

get_admin_url( null, 'admin.php' )

[165] Fix | Delete

);

[166] Fix | Delete

[167] Fix | Delete

$debug_tools[ self::CACHE_TOOL_ID ] = array(

[168] Fix | Delete

'name' => __( 'Clear analytics cache', 'woocommerce' ),

[169] Fix | Delete

'button' => __( 'Clear', 'woocommerce' ),

[170] Fix | Delete

'desc' => sprintf(

[171] Fix | Delete

/* translators: 1: opening link tag, 2: closing tag */

[172] Fix | Delete

__( 'This tool will reset the cached values used in WooCommerce Analytics. If numbers still look off, try %1$sReimporting Historical Data%2$s.', 'woocommerce' ),

[173] Fix | Delete

'<a href="' . esc_url( $settings_url ) . '">',

[174] Fix | Delete

'</a>'

[175] Fix | Delete

),

[176] Fix | Delete

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

[177] Fix | Delete

);

[178] Fix | Delete

[179] Fix | Delete

return $debug_tools;

[180] Fix | Delete

}

[181] Fix | Delete

[182] Fix | Delete

/**

[183] Fix | Delete

* Register the regenerate order fulfillment status tool on the WooCommerce > Status > Tools page.

[184] Fix | Delete

*

[185] Fix | Delete

* @param array $debug_tools Available debug tool registrations.

[186] Fix | Delete

* @return array Filtered debug tool registrations.

[187] Fix | Delete

*/

[188] Fix | Delete

public function register_regenerate_order_fulfillment_status_tool( $debug_tools ) {

[189] Fix | Delete

// Check if the fulfillments feature is enabled.

[190] Fix | Delete

$container = wc_get_container();

[191] Fix | Delete

$features_controller = $container->get( FeaturesController::class );

[192] Fix | Delete

[193] Fix | Delete

if ( ! $features_controller->feature_is_enabled( 'fulfillments' ) ) {

[194] Fix | Delete

return $debug_tools;

[195] Fix | Delete

}

[196] Fix | Delete

[197] Fix | Delete

// If the order fulfillment status has already been regenerated, don't register the tool again.

[198] Fix | Delete

if ( true === (bool) get_option( 'woocommerce_analytics_order_fulfillment_status_regenerated' ) ) {

[199] Fix | Delete

return $debug_tools;

[200] Fix | Delete

}

[201] Fix | Delete

[202] Fix | Delete

$debug_tools['regenerate_order_fulfillment_status'] = array(

[203] Fix | Delete

'name' => __( 'Regenerate order fulfillment status for Analytics', 'woocommerce' ),

[204] Fix | Delete

'button' => __( 'Regenerate', 'woocommerce' ),

[205] Fix | Delete

'desc' => __( 'This tool will regenerate the order fulfillment status for all orders and update the Analytics data using a direct SQL query.', 'woocommerce' ),

[206] Fix | Delete

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

[207] Fix | Delete

);

[208] Fix | Delete

[209] Fix | Delete

return $debug_tools;

[210] Fix | Delete

}

[211] Fix | Delete

[212] Fix | Delete

/**

[213] Fix | Delete

* Regenerate order fulfillment status directly using SQL.

[214] Fix | Delete

*

[215] Fix | Delete

* @return string Success message or error message.

[216] Fix | Delete

*/

[217] Fix | Delete

public function run_regenerate_order_fulfillment_status_tool() {

[218] Fix | Delete

global $wpdb;

[219] Fix | Delete

[220] Fix | Delete

// Check if the column exists, create it if not.

[221] Fix | Delete

if ( ! OrderStatsDataStore::has_fulfillment_status_column() ) {

[222] Fix | Delete

$create_column_result = OrderStatsDataStore::add_fulfillment_status_column();

[223] Fix | Delete

[224] Fix | Delete

if ( true !== $create_column_result ) {

[225] Fix | Delete

return sprintf(

[226] Fix | Delete

/* translators: %s: error message */

[227] Fix | Delete

__( 'Failed to create fulfillment status column: %s', 'woocommerce' ),

[228] Fix | Delete

$create_column_result

[229] Fix | Delete

);

[230] Fix | Delete

}

[231] Fix | Delete

}

[232] Fix | Delete

[233] Fix | Delete

$order_stats_table = $wpdb->prefix . 'wc_order_stats';

[234] Fix | Delete

[235] Fix | Delete

// If HPOS is enabled, use the wc_orders_meta table, else use wp_postmeta.

[236] Fix | Delete

if ( OrderUtil::custom_orders_table_usage_is_enabled() ) {

[237] Fix | Delete

$order_meta_table = OrdersTableDataStore::get_meta_table_name();

[238] Fix | Delete

$order_meta_column = 'order_id';

[239] Fix | Delete

} else {

[240] Fix | Delete

$order_meta_table = $wpdb->postmeta;

[241] Fix | Delete

$order_meta_column = 'post_id';

[242] Fix | Delete

}

[243] Fix | Delete

[244] Fix | Delete

// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching

[245] Fix | Delete

$updated = $wpdb->query(

[246] Fix | Delete

$wpdb->prepare(

[247] Fix | Delete

// phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- Table and column names cannot be prepared.

[248] Fix | Delete

"UPDATE {$order_stats_table} os INNER JOIN {$order_meta_table} om ON os.order_id = om.{$order_meta_column}

[249] Fix | Delete

SET os.fulfillment_status = CASE

[250] Fix | Delete

WHEN om.meta_value = %s THEN NULL

[251] Fix | Delete

ELSE om.meta_value

[252] Fix | Delete

END

[253] Fix | Delete

WHERE om.meta_key = %s",

[254] Fix | Delete

'no_fulfillments',

[255] Fix | Delete

'_fulfillment_status'

[256] Fix | Delete

)

[257] Fix | Delete

);

[258] Fix | Delete

[259] Fix | Delete

if ( false === $updated ) {

[260] Fix | Delete

return __( 'Failed to update order fulfillment status. Please check the database logs for errors.', 'woocommerce' );

[261] Fix | Delete

}

[262] Fix | Delete

[263] Fix | Delete

// Mark as completed.

[264] Fix | Delete

update_option( 'woocommerce_analytics_order_fulfillment_status_regenerated', true, false );

[265] Fix | Delete

[266] Fix | Delete

return sprintf(

[267] Fix | Delete

/* translators: %d: number of orders updated */

[268] Fix | Delete

__( 'Successfully updated fulfillment status for %d orders.', 'woocommerce' ),

[269] Fix | Delete

$updated

[270] Fix | Delete

);

[271] Fix | Delete

}

[272] Fix | Delete

[273] Fix | Delete

/**

[274] Fix | Delete

* Registers report pages.

[275] Fix | Delete

*/

[276] Fix | Delete

public function register_pages() {

[277] Fix | Delete

$report_pages = self::get_report_pages();

[278] Fix | Delete

foreach ( $report_pages as $report_page ) {

[279] Fix | Delete

if ( ! is_null( $report_page ) ) {

[280] Fix | Delete

wc_admin_register_page( $report_page );

[281] Fix | Delete

}

[282] Fix | Delete

}

[283] Fix | Delete

}

[284] Fix | Delete

[285] Fix | Delete

/**

[286] Fix | Delete

* Get report pages.

[287] Fix | Delete

*/

[288] Fix | Delete

public static function get_report_pages() {

[289] Fix | Delete

$overview_page = array(

[290] Fix | Delete

'id' => 'woocommerce-analytics',

[291] Fix | Delete

'title' => __( 'Analytics', 'woocommerce' ),

[292] Fix | Delete

'path' => '/analytics/overview',

[293] Fix | Delete

'icon' => 'dashicons-chart-bar',

[294] Fix | Delete

'position' => 57, // After WooCommerce & Product menu items.

[295] Fix | Delete

);

[296] Fix | Delete

[297] Fix | Delete

$report_pages = array(

[298] Fix | Delete

$overview_page,

[299] Fix | Delete

array(

[300] Fix | Delete

'id' => 'woocommerce-analytics-overview',

[301] Fix | Delete

'title' => __( 'Overview', 'woocommerce' ),

[302] Fix | Delete

'parent' => 'woocommerce-analytics',

[303] Fix | Delete

'path' => '/analytics/overview',

[304] Fix | Delete

),

[305] Fix | Delete

array(

[306] Fix | Delete

'id' => 'woocommerce-analytics-products',

[307] Fix | Delete

'title' => __( 'Products', 'woocommerce' ),

[308] Fix | Delete

'parent' => 'woocommerce-analytics',

[309] Fix | Delete

'path' => '/analytics/products',

[310] Fix | Delete

),

[311] Fix | Delete

array(

[312] Fix | Delete

'id' => 'woocommerce-analytics-revenue',

[313] Fix | Delete

'title' => __( 'Revenue', 'woocommerce' ),

[314] Fix | Delete

'parent' => 'woocommerce-analytics',

[315] Fix | Delete

'path' => '/analytics/revenue',

[316] Fix | Delete

),

[317] Fix | Delete

array(

[318] Fix | Delete

'id' => 'woocommerce-analytics-orders',

[319] Fix | Delete

'title' => __( 'Orders', 'woocommerce' ),

[320] Fix | Delete

'parent' => 'woocommerce-analytics',

[321] Fix | Delete

'path' => '/analytics/orders',

[322] Fix | Delete

),

[323] Fix | Delete

array(

[324] Fix | Delete

'id' => 'woocommerce-analytics-variations',

[325] Fix | Delete

'title' => __( 'Variations', 'woocommerce' ),

[326] Fix | Delete

'parent' => 'woocommerce-analytics',

[327] Fix | Delete

'path' => '/analytics/variations',

[328] Fix | Delete

),

[329] Fix | Delete

array(

[330] Fix | Delete

'id' => 'woocommerce-analytics-categories',

[331] Fix | Delete

'title' => __( 'Categories', 'woocommerce' ),

[332] Fix | Delete

'parent' => 'woocommerce-analytics',

[333] Fix | Delete

'path' => '/analytics/categories',

[334] Fix | Delete

),

[335] Fix | Delete

array(

[336] Fix | Delete

'id' => 'woocommerce-analytics-coupons',

[337] Fix | Delete

'title' => __( 'Coupons', 'woocommerce' ),

[338] Fix | Delete

'parent' => 'woocommerce-analytics',

[339] Fix | Delete

'path' => '/analytics/coupons',

[340] Fix | Delete

),

[341] Fix | Delete

array(

[342] Fix | Delete

'id' => 'woocommerce-analytics-taxes',

[343] Fix | Delete

'title' => __( 'Taxes', 'woocommerce' ),

[344] Fix | Delete

'parent' => 'woocommerce-analytics',

[345] Fix | Delete

'path' => '/analytics/taxes',

[346] Fix | Delete

),

[347] Fix | Delete

array(

[348] Fix | Delete

'id' => 'woocommerce-analytics-downloads',

[349] Fix | Delete

'title' => __( 'Downloads', 'woocommerce' ),

[350] Fix | Delete

'parent' => 'woocommerce-analytics',

[351] Fix | Delete

'path' => '/analytics/downloads',

[352] Fix | Delete

),

[353] Fix | Delete

'yes' === get_option( 'woocommerce_manage_stock' ) ? array(

[354] Fix | Delete

'id' => 'woocommerce-analytics-stock',

[355] Fix | Delete

'title' => __( 'Stock', 'woocommerce' ),

[356] Fix | Delete

'parent' => 'woocommerce-analytics',

[357] Fix | Delete

'path' => '/analytics/stock',

[358] Fix | Delete

) : null,

[359] Fix | Delete

array(

[360] Fix | Delete

'id' => 'woocommerce-analytics-customers',

[361] Fix | Delete

'title' => __( 'Customers', 'woocommerce' ),

[362] Fix | Delete

'parent' => 'woocommerce',

[363] Fix | Delete

'path' => '/customers',

[364] Fix | Delete

),

[365] Fix | Delete

array(

[366] Fix | Delete

'id' => 'woocommerce-analytics-settings',

[367] Fix | Delete

'title' => __( 'Settings', 'woocommerce' ),

[368] Fix | Delete

'parent' => 'woocommerce-analytics',

[369] Fix | Delete

'path' => '/analytics/settings',

[370] Fix | Delete

),

[371] Fix | Delete

);

[372] Fix | Delete

[373] Fix | Delete

/**

[374] Fix | Delete

* The analytics report items used in the menu.

[375] Fix | Delete

*

[376] Fix | Delete

* @since 6.4.0

[377] Fix | Delete

*/

[378] Fix | Delete

return apply_filters( 'woocommerce_analytics_report_menu_items', $report_pages );

[379] Fix | Delete

}

[380] Fix | Delete

[381] Fix | Delete

/**

[382] Fix | Delete

* "Clear" analytics cache by invalidating it.

[383] Fix | Delete

*/

[384] Fix | Delete

public function run_clear_cache_tool() {

[385] Fix | Delete

Cache::invalidate();

[386] Fix | Delete

[387] Fix | Delete

return __( 'Analytics cache cleared.', 'woocommerce' );

[388] Fix | Delete

}

[389] Fix | Delete

}

[390] Fix | Delete

[391] Fix | Delete