<?php

[0] Fix | Delete

[1] Fix | Delete

namespace Automattic\WooCommerce\Blocks\Patterns;

[2] Fix | Delete

[3] Fix | Delete

use Automattic\WooCommerce\Admin\Features\Features;

[4] Fix | Delete

use WP_Upgrader;

[5] Fix | Delete

[6] Fix | Delete

/**

[7] Fix | Delete

* PTKPatterns class.

[8] Fix | Delete

*

[9] Fix | Delete

* @internal

[10] Fix | Delete

*/

[11] Fix | Delete

class PTKPatternsStore {

[12] Fix | Delete

const OPTION_NAME = 'ptk_patterns';

[13] Fix | Delete

[14] Fix | Delete

/**

[15] Fix | Delete

* Hook and action name used to trigger fetching patterns.

[16] Fix | Delete

*/

[17] Fix | Delete

const FETCH_PATTERNS_ACTION = 'fetch_patterns';

[18] Fix | Delete

[19] Fix | Delete

const CATEGORY_MAPPING = array(

[20] Fix | Delete

'testimonials' => 'reviews',

[21] Fix | Delete

);

[22] Fix | Delete

[23] Fix | Delete

/**

[24] Fix | Delete

* PatternsToolkit instance.

[25] Fix | Delete

*

[26] Fix | Delete

* @var PTKClient $ptk_client

[27] Fix | Delete

*/

[28] Fix | Delete

private PTKClient $ptk_client;

[29] Fix | Delete

[30] Fix | Delete

/**

[31] Fix | Delete

* Constructor for the class.

[32] Fix | Delete

*

[33] Fix | Delete

* @param PTKClient $ptk_client An instance of PatternsToolkit.

[34] Fix | Delete

*/

[35] Fix | Delete

public function __construct( PTKClient $ptk_client ) {

[36] Fix | Delete

$this->ptk_client = $ptk_client;

[37] Fix | Delete

[38] Fix | Delete

if ( Features::is_enabled( 'pattern-toolkit-full-composability' ) ) {

[39] Fix | Delete

// We want to flush the cached patterns when:

[40] Fix | Delete

// - The WooCommerce plugin is deactivated.

[41] Fix | Delete

// - The `woocommerce_allow_tracking` option is disabled.

[42] Fix | Delete

//

[43] Fix | Delete

// We also want to re-fetch the patterns and update the cache when:

[44] Fix | Delete

// - The `woocommerce_allow_tracking` option changes to enabled.

[45] Fix | Delete

// - The WooCommerce plugin is activated (if `woocommerce_allow_tracking` is enabled).

[46] Fix | Delete

// - The WooCommerce plugin is updated.

[47] Fix | Delete

[48] Fix | Delete

add_action( 'woocommerce_activated_plugin', array( $this, 'flush_or_fetch_patterns' ), 10, 2 );

[49] Fix | Delete

add_action( 'update_option_woocommerce_allow_tracking', array( $this, 'flush_or_fetch_patterns' ), 10, 2 );

[50] Fix | Delete

add_action( 'deactivated_plugin', array( $this, 'flush_cached_patterns' ), 10, 2 );

[51] Fix | Delete

add_action( 'upgrader_process_complete', array( $this, 'fetch_patterns_on_plugin_update' ), 10, 2 );

[52] Fix | Delete

add_action( 'action_scheduler_ensure_recurring_actions', array( $this, 'ensure_recurring_fetch_patterns_if_enabled' ) );

[53] Fix | Delete

[54] Fix | Delete

// This is the scheduled action that takes care of flushing and re-fetching the patterns from the PTK API.

[55] Fix | Delete

add_action( self::FETCH_PATTERNS_ACTION, array( $this, 'fetch_patterns' ) );

[56] Fix | Delete

}

[57] Fix | Delete

}

[58] Fix | Delete

[59] Fix | Delete

/**

[60] Fix | Delete

* Resets the cached patterns when the `woocommerce_allow_tracking` option is disabled.

[61] Fix | Delete

* Resets and fetch the patterns from the PTK when it is enabled (if the scheduler

[62] Fix | Delete

* is initialized, it's done asynchronously via a scheduled action).

[63] Fix | Delete

*

[64] Fix | Delete

* @return void

[65] Fix | Delete

*/

[66] Fix | Delete

public function flush_or_fetch_patterns() {

[67] Fix | Delete

if ( $this->allowed_tracking_is_enabled() ) {

[68] Fix | Delete

$this->schedule_fetch_patterns();

[69] Fix | Delete

return;

[70] Fix | Delete

}

[71] Fix | Delete

[72] Fix | Delete

$this->flush_cached_patterns();

[73] Fix | Delete

}

[74] Fix | Delete

[75] Fix | Delete

/**

[76] Fix | Delete

* Schedule an async action to fetch the PTK patterns when the scheduler is initialized.

[77] Fix | Delete

*

[78] Fix | Delete

* @return void

[79] Fix | Delete

*/

[80] Fix | Delete

private function schedule_fetch_patterns() {

[81] Fix | Delete

if ( did_action( 'action_scheduler_init' ) ) {

[82] Fix | Delete

$this->schedule_action_if_not_pending( self::FETCH_PATTERNS_ACTION );

[83] Fix | Delete

} else {

[84] Fix | Delete

add_action(

[85] Fix | Delete

'action_scheduler_init',

[86] Fix | Delete

function () {

[87] Fix | Delete

$this->schedule_action_if_not_pending( self::FETCH_PATTERNS_ACTION );

[88] Fix | Delete

}

[89] Fix | Delete

);

[90] Fix | Delete

}

[91] Fix | Delete

}

[92] Fix | Delete

[93] Fix | Delete

/**

[94] Fix | Delete

* Ensure a recurring fetch patterns action is scheduled.

[95] Fix | Delete

* This is called by the `action_scheduler_ensure_recurring_actions` hook.

[96] Fix | Delete

*

[97] Fix | Delete

* @return void

[98] Fix | Delete

*/

[99] Fix | Delete

public function ensure_recurring_fetch_patterns_if_enabled() {

[100] Fix | Delete

if ( ! $this->allowed_tracking_is_enabled() ) {

[101] Fix | Delete

return;

[102] Fix | Delete

}

[103] Fix | Delete

[104] Fix | Delete

$this->schedule_action_if_not_pending( self::FETCH_PATTERNS_ACTION );

[105] Fix | Delete

}

[106] Fix | Delete

[107] Fix | Delete

/**

[108] Fix | Delete

* Schedule an action if it's not already pending.

[109] Fix | Delete

*

[110] Fix | Delete

* @param string $action The action name to schedule.

[111] Fix | Delete

* @return void

[112] Fix | Delete

*/

[113] Fix | Delete

private function schedule_action_if_not_pending( $action ) {

[114] Fix | Delete

if ( as_has_scheduled_action( $action, array(), 'woocommerce' ) ) {

[115] Fix | Delete

return;

[116] Fix | Delete

}

[117] Fix | Delete

[118] Fix | Delete

as_schedule_recurring_action( time(), DAY_IN_SECONDS, $action, array(), 'woocommerce' );

[119] Fix | Delete

}

[120] Fix | Delete

[121] Fix | Delete

/**

[122] Fix | Delete

* Get the patterns from the Patterns Toolkit cache.

[123] Fix | Delete

*

[124] Fix | Delete

* @return array

[125] Fix | Delete

*/

[126] Fix | Delete

public function get_patterns() {

[127] Fix | Delete

$patterns = get_option( self::OPTION_NAME );

[128] Fix | Delete

[129] Fix | Delete

// If the current data doesn't exist or is invalid, schedule fetching the patterns from the PTK.

[130] Fix | Delete

if ( false === $patterns || ! $this->ptk_client->is_valid_schema( $patterns ) ) {

[131] Fix | Delete

$this->schedule_fetch_patterns();

[132] Fix | Delete

return array();

[133] Fix | Delete

}

[134] Fix | Delete

[135] Fix | Delete

return $patterns;

[136] Fix | Delete

}

[137] Fix | Delete

[138] Fix | Delete

/**

[139] Fix | Delete

* Filter the patterns that have external dependencies.

[140] Fix | Delete

*

[141] Fix | Delete

* @param array $patterns The patterns to filter.

[142] Fix | Delete

* @return array

[143] Fix | Delete

*/

[144] Fix | Delete

private function filter_patterns( array $patterns ) {

[145] Fix | Delete

return array_values(

[146] Fix | Delete

array_filter(

[147] Fix | Delete

$patterns,

[148] Fix | Delete

function ( $pattern ) {

[149] Fix | Delete

if ( ! isset( $pattern['ID'] ) ) {

[150] Fix | Delete

return true;

[151] Fix | Delete

}

[152] Fix | Delete

[153] Fix | Delete

if ( isset( $pattern['post_type'] ) && 'wp_block' !== $pattern['post_type'] ) {

[154] Fix | Delete

return false;

[155] Fix | Delete

}

[156] Fix | Delete

[157] Fix | Delete

if ( $this->has_external_dependencies( $pattern ) ) {

[158] Fix | Delete

return false;

[159] Fix | Delete

}

[160] Fix | Delete

[161] Fix | Delete

return true;

[162] Fix | Delete

}

[163] Fix | Delete

)

[164] Fix | Delete

);

[165] Fix | Delete

}

[166] Fix | Delete

[167] Fix | Delete

/**

[168] Fix | Delete

* Re-fetch the patterns when the WooCommerce plugin is updated.

[169] Fix | Delete

*

[170] Fix | Delete

* @param WP_Upgrader $upgrader_object WP_Upgrader instance.

[171] Fix | Delete

* @param array $options Array of bulk item update data.

[172] Fix | Delete

*

[173] Fix | Delete

* @return void

[174] Fix | Delete

*/

[175] Fix | Delete

public function fetch_patterns_on_plugin_update( $upgrader_object, $options ) {

[176] Fix | Delete

if ( 'update' === $options['action'] && 'plugin' === $options['type'] && isset( $options['plugins'] ) ) {

[177] Fix | Delete

foreach ( $options['plugins'] as $plugin ) {

[178] Fix | Delete

if ( str_contains( $plugin, 'woocommerce.php' ) ) {

[179] Fix | Delete

$this->schedule_fetch_patterns();

[180] Fix | Delete

}

[181] Fix | Delete

}

[182] Fix | Delete

}

[183] Fix | Delete

}

[184] Fix | Delete

[185] Fix | Delete

/**

[186] Fix | Delete

* Reset the cached patterns to fetch them again from the PTK.

[187] Fix | Delete

*

[188] Fix | Delete

* @since 10.4.1 Unscheduling is deferred if Action Scheduler hasn't initialized yet.

[189] Fix | Delete

* @return void

[190] Fix | Delete

*/

[191] Fix | Delete

public function flush_cached_patterns() {

[192] Fix | Delete

delete_option( self::OPTION_NAME );

[193] Fix | Delete

[194] Fix | Delete

if ( ! function_exists( 'as_unschedule_all_actions' ) ) {

[195] Fix | Delete

return;

[196] Fix | Delete

}

[197] Fix | Delete

[198] Fix | Delete

// Unschedule any existing fetch_patterns actions.

[199] Fix | Delete

// Defer unscheduling until Action Scheduler is ready to avoid errors during early initialization.

[200] Fix | Delete

if ( did_action( 'action_scheduler_init' ) ) {

[201] Fix | Delete

as_unschedule_all_actions( self::FETCH_PATTERNS_ACTION, array(), 'woocommerce' );

[202] Fix | Delete

} else {

[203] Fix | Delete

add_action(

[204] Fix | Delete

'action_scheduler_init',

[205] Fix | Delete

function () {

[206] Fix | Delete

as_unschedule_all_actions( self::FETCH_PATTERNS_ACTION, array(), 'woocommerce' );

[207] Fix | Delete

}

[208] Fix | Delete

);

[209] Fix | Delete

}

[210] Fix | Delete

}

[211] Fix | Delete

[212] Fix | Delete

/**

[213] Fix | Delete

* Reset the cached patterns and fetch them again from the PTK API.

[214] Fix | Delete

*

[215] Fix | Delete

* @return void

[216] Fix | Delete

*/

[217] Fix | Delete

public function fetch_patterns() {

[218] Fix | Delete

if ( ! $this->allowed_tracking_is_enabled() ) {

[219] Fix | Delete

return;

[220] Fix | Delete

}

[221] Fix | Delete

[222] Fix | Delete

$patterns = $this->ptk_client->fetch_patterns(

[223] Fix | Delete

array(

[224] Fix | Delete

// This is the site where the patterns are stored. Despite the 'wpcomstaging.com' domain suggesting a staging environment, this URL points to the production environment where stable versions of the patterns are maintained.

[225] Fix | Delete

'site' => 'wooblockpatterns.wpcomstaging.com',

[226] Fix | Delete

'categories' => array(

[227] Fix | Delete

'_woo_intro',

[228] Fix | Delete

'_woo_featured_selling',

[229] Fix | Delete

'_woo_about',

[230] Fix | Delete

'_woo_reviews',

[231] Fix | Delete

'_woo_social_media',

[232] Fix | Delete

'_woo_woocommerce',

[233] Fix | Delete

'_dotcom_imported_intro',

[234] Fix | Delete

'_dotcom_imported_about',

[235] Fix | Delete

'_dotcom_imported_services',

[236] Fix | Delete

'_dotcom_imported_reviews',

[237] Fix | Delete

),

[238] Fix | Delete

)

[239] Fix | Delete

);

[240] Fix | Delete

[241] Fix | Delete

if ( is_wp_error( $patterns ) ) {

[242] Fix | Delete

wc_get_logger()->warning(

[243] Fix | Delete

sprintf(

[244] Fix | Delete

// translators: %s is a generated error message.

[245] Fix | Delete

__( 'Failed to get WooCommerce patterns from the PTK: "%s"', 'woocommerce' ),

[246] Fix | Delete

$patterns->get_error_message()

[247] Fix | Delete

),

[248] Fix | Delete

);

[249] Fix | Delete

return;

[250] Fix | Delete

}

[251] Fix | Delete

[252] Fix | Delete

$patterns = $this->filter_patterns( $patterns );

[253] Fix | Delete

$patterns = $this->map_categories( $patterns );

[254] Fix | Delete

[255] Fix | Delete

update_option( self::OPTION_NAME, $patterns, false );

[256] Fix | Delete

}

[257] Fix | Delete

[258] Fix | Delete

/**

[259] Fix | Delete

* Check if the user allowed tracking.

[260] Fix | Delete

*

[261] Fix | Delete

* @return bool

[262] Fix | Delete

*/

[263] Fix | Delete

private function allowed_tracking_is_enabled(): bool {

[264] Fix | Delete

return 'yes' === get_option( 'woocommerce_allow_tracking' );

[265] Fix | Delete

}

[266] Fix | Delete

[267] Fix | Delete

/**

[268] Fix | Delete

* Change the categories of the patterns to match the ones used in the CYS flow

[269] Fix | Delete

*

[270] Fix | Delete

* @param array $patterns The patterns to map categories for.

[271] Fix | Delete

* @return array The patterns with the categories mapped.

[272] Fix | Delete

*/

[273] Fix | Delete

private function map_categories( array $patterns ) {

[274] Fix | Delete

return array_map(

[275] Fix | Delete

function ( $pattern ) {

[276] Fix | Delete

if ( isset( $pattern['categories'] ) ) {

[277] Fix | Delete

foreach ( $pattern['categories'] as $key => $category ) {

[278] Fix | Delete

if ( isset( $category['slug'] ) && isset( self::CATEGORY_MAPPING[ $key ] ) ) {

[279] Fix | Delete

$new_category = self::CATEGORY_MAPPING[ $key ];

[280] Fix | Delete

unset( $pattern['categories'][ $key ] );

[281] Fix | Delete

$pattern['categories'][ $new_category ]['slug'] = $new_category;

[282] Fix | Delete

$pattern['categories'][ $new_category ]['title'] = ucfirst( $new_category );

[283] Fix | Delete

}

[284] Fix | Delete

}

[285] Fix | Delete

}

[286] Fix | Delete

[287] Fix | Delete

return $pattern;

[288] Fix | Delete

},

[289] Fix | Delete

$patterns

[290] Fix | Delete

);

[291] Fix | Delete

}

[292] Fix | Delete

[293] Fix | Delete

/**

[294] Fix | Delete

* Check if the pattern has external dependencies.

[295] Fix | Delete

*

[296] Fix | Delete

* @param array $pattern The pattern to check.

[297] Fix | Delete

*

[298] Fix | Delete

* @return bool

[299] Fix | Delete

*/

[300] Fix | Delete

private function has_external_dependencies( $pattern ) {

[301] Fix | Delete

if ( ! isset( $pattern['dependencies'] ) || ! is_array( $pattern['dependencies'] ) ) {

[302] Fix | Delete

return false;

[303] Fix | Delete

}

[304] Fix | Delete

[305] Fix | Delete

foreach ( $pattern['dependencies'] as $dependency ) {

[306] Fix | Delete

if ( 'woocommerce' !== $dependency ) {

[307] Fix | Delete

return true;

[308] Fix | Delete

}

[309] Fix | Delete

}

[310] Fix | Delete

[311] Fix | Delete

return false;

[312] Fix | Delete

}

[313] Fix | Delete

}

[314] Fix | Delete

[315] Fix | Delete