<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Features loader for features developed in WooCommerce Admin.

[2] Fix | Delete

*/

[3] Fix | Delete

[4] Fix | Delete

namespace Automattic\WooCommerce\Admin\Features;

[5] Fix | Delete

[6] Fix | Delete

use Automattic\WooCommerce\Admin\PageController;

[7] Fix | Delete

use Automattic\WooCommerce\Internal\Admin\Loader;

[8] Fix | Delete

use Automattic\WooCommerce\Internal\Admin\WCAdminAssets;

[9] Fix | Delete

use Automattic\WooCommerce\Utilities\FeaturesUtil;

[10] Fix | Delete

[11] Fix | Delete

/**

[12] Fix | Delete

* Features Class.

[13] Fix | Delete

*/

[14] Fix | Delete

class Features {

[15] Fix | Delete

/**

[16] Fix | Delete

* Class instance.

[17] Fix | Delete

*

[18] Fix | Delete

* @var Loader instance

[19] Fix | Delete

*/

[20] Fix | Delete

protected static $instance = null;

[21] Fix | Delete

[22] Fix | Delete

/**

[23] Fix | Delete

* Optional features

[24] Fix | Delete

*

[25] Fix | Delete

* @var array

[26] Fix | Delete

*/

[27] Fix | Delete

protected static $optional_features = array(

[28] Fix | Delete

'analytics' => array( 'default' => 'yes' ),

[29] Fix | Delete

'remote-inbox-notifications' => array( 'default' => 'yes' ),

[30] Fix | Delete

);

[31] Fix | Delete

[32] Fix | Delete

/**

[33] Fix | Delete

* Beta features

[34] Fix | Delete

*

[35] Fix | Delete

* @var array

[36] Fix | Delete

*/

[37] Fix | Delete

protected static $beta_features = array(

[38] Fix | Delete

'settings',

[39] Fix | Delete

);

[40] Fix | Delete

[41] Fix | Delete

/**

[42] Fix | Delete

* Get class instance.

[43] Fix | Delete

*/

[44] Fix | Delete

public static function get_instance() {

[45] Fix | Delete

if ( ! self::$instance ) {

[46] Fix | Delete

self::$instance = new self();

[47] Fix | Delete

}

[48] Fix | Delete

return self::$instance;

[49] Fix | Delete

}

[50] Fix | Delete

[51] Fix | Delete

/**

[52] Fix | Delete

* Constructor.

[53] Fix | Delete

*/

[54] Fix | Delete

public function __construct() {

[55] Fix | Delete

[56] Fix | Delete

$this->register_internal_class_aliases();

[57] Fix | Delete

[58] Fix | Delete

if ( ! self::should_load_features() ) {

[59] Fix | Delete

return;

[60] Fix | Delete

}

[61] Fix | Delete

[62] Fix | Delete

// Load feature before WooCommerce update hooks.

[63] Fix | Delete

add_action( 'init', array( __CLASS__, 'load_features' ), 4 );

[64] Fix | Delete

add_action( 'admin_enqueue_scripts', array( __CLASS__, 'maybe_load_beta_features_modal' ) );

[65] Fix | Delete

add_action( 'admin_enqueue_scripts', array( __CLASS__, 'load_scripts' ), 15 );

[66] Fix | Delete

add_filter( 'admin_body_class', array( __CLASS__, 'add_admin_body_classes' ) );

[67] Fix | Delete

add_filter( 'update_option_woocommerce_allow_tracking', array( __CLASS__, 'maybe_disable_features' ), 10, 2 );

[68] Fix | Delete

}

[69] Fix | Delete

[70] Fix | Delete

/**

[71] Fix | Delete

* Gets a build configured array of enabled WooCommerce Admin features/sections, but does not respect optionally disabled features.

[72] Fix | Delete

*

[73] Fix | Delete

* @return array Enabled Woocommerce Admin features/sections.

[74] Fix | Delete

*/

[75] Fix | Delete

public static function get_features() {

[76] Fix | Delete

return apply_filters( 'woocommerce_admin_features', array() );

[77] Fix | Delete

}

[78] Fix | Delete

[79] Fix | Delete

/**

[80] Fix | Delete

* Gets the optional feature options as an associative array that can be toggled on or off.

[81] Fix | Delete

*

[82] Fix | Delete

* @return array

[83] Fix | Delete

*/

[84] Fix | Delete

public static function get_optional_feature_options() {

[85] Fix | Delete

$features = array();

[86] Fix | Delete

[87] Fix | Delete

foreach ( array_keys( self::$optional_features ) as $optional_feature_key ) {

[88] Fix | Delete

$feature_class = self::get_feature_class( $optional_feature_key );

[89] Fix | Delete

[90] Fix | Delete

if ( $feature_class ) {

[91] Fix | Delete

$features[ $optional_feature_key ] = $feature_class::TOGGLE_OPTION_NAME;

[92] Fix | Delete

}

[93] Fix | Delete

}

[94] Fix | Delete

return $features;

[95] Fix | Delete

}

[96] Fix | Delete

[97] Fix | Delete

/**

[98] Fix | Delete

* Returns if a specific wc-admin feature exists in the current environment.

[99] Fix | Delete

*

[100] Fix | Delete

* @param string $feature Feature slug.

[101] Fix | Delete

* @return bool Returns true if the feature exists.

[102] Fix | Delete

*/

[103] Fix | Delete

public static function exists( $feature ) {

[104] Fix | Delete

$features = self::get_features();

[105] Fix | Delete

return in_array( $feature, $features, true );

[106] Fix | Delete

}

[107] Fix | Delete

[108] Fix | Delete

/**

[109] Fix | Delete

* Get the feature class as a string.

[110] Fix | Delete

*

[111] Fix | Delete

* @param string $feature Feature name.

[112] Fix | Delete

* @return string|null

[113] Fix | Delete

*/

[114] Fix | Delete

public static function get_feature_class( $feature ) {

[115] Fix | Delete

$feature = str_replace( '-', '', ucwords( strtolower( $feature ), '-' ) );

[116] Fix | Delete

$feature_class = 'Automattic\\WooCommerce\\Admin\\Features\\' . $feature;

[117] Fix | Delete

[118] Fix | Delete

$should_autoload_class = self::should_load_features();

[119] Fix | Delete

[120] Fix | Delete

if ( class_exists( $feature_class, $should_autoload_class ) ) {

[121] Fix | Delete

return $feature_class;

[122] Fix | Delete

}

[123] Fix | Delete

[124] Fix | Delete

// Handle features contained in subdirectory.

[125] Fix | Delete

if ( class_exists( $feature_class . '\\Init', $should_autoload_class ) ) {

[126] Fix | Delete

return $feature_class . '\\Init';

[127] Fix | Delete

}

[128] Fix | Delete

[129] Fix | Delete

return null;

[130] Fix | Delete

}

[131] Fix | Delete

[132] Fix | Delete

/**

[133] Fix | Delete

* Class loader for enabled WooCommerce Admin features/sections.

[134] Fix | Delete

*/

[135] Fix | Delete

public static function load_features() {

[136] Fix | Delete

if ( ! self::should_load_features() ) {

[137] Fix | Delete

return;

[138] Fix | Delete

}

[139] Fix | Delete

[140] Fix | Delete

$features = self::get_features();

[141] Fix | Delete

foreach ( $features as $feature ) {

[142] Fix | Delete

$feature_class = self::get_feature_class( $feature );

[143] Fix | Delete

[144] Fix | Delete

if ( $feature_class ) {

[145] Fix | Delete

new $feature_class();

[146] Fix | Delete

}

[147] Fix | Delete

}

[148] Fix | Delete

[149] Fix | Delete

if ( FeaturesUtil::feature_is_enabled( 'blueprint' ) ) {

[150] Fix | Delete

new \Automattic\WooCommerce\Admin\Features\Blueprint\Init();

[151] Fix | Delete

}

[152] Fix | Delete

}

[153] Fix | Delete

[154] Fix | Delete

/**

[155] Fix | Delete

* Gets a build configured array of enabled WooCommerce Admin respecting optionally disabled features.

[156] Fix | Delete

*

[157] Fix | Delete

* @return array Enabled Woocommerce Admin features/sections.

[158] Fix | Delete

*/

[159] Fix | Delete

public static function get_available_features() {

[160] Fix | Delete

$features = self::get_features();

[161] Fix | Delete

$optional_feature_keys = array_keys( self::$optional_features );

[162] Fix | Delete

$optional_features_unavailable = array();

[163] Fix | Delete

[164] Fix | Delete

/**

[165] Fix | Delete

* Filter allowing WooCommerce Admin optional features to be disabled.

[166] Fix | Delete

*

[167] Fix | Delete

* @param bool $disabled False.

[168] Fix | Delete

*/

[169] Fix | Delete

if ( apply_filters( 'woocommerce_admin_disabled', false ) ) {

[170] Fix | Delete

return array_values( array_diff( $features, $optional_feature_keys ) );

[171] Fix | Delete

}

[172] Fix | Delete

[173] Fix | Delete

foreach ( $optional_feature_keys as $optional_feature_key ) {

[174] Fix | Delete

$feature_class = self::get_feature_class( $optional_feature_key );

[175] Fix | Delete

[176] Fix | Delete

if ( $feature_class ) {

[177] Fix | Delete

$default = isset( self::$optional_features[ $optional_feature_key ]['default'] ) ?

[178] Fix | Delete

self::$optional_features[ $optional_feature_key ]['default'] :

[179] Fix | Delete

'no';

[180] Fix | Delete

[181] Fix | Delete

// Check if the feature is currently being enabled, if it is continue.

[182] Fix | Delete

/* phpcs:disable WordPress.Security.NonceVerification */

[183] Fix | Delete

$feature_option = $feature_class::TOGGLE_OPTION_NAME;

[184] Fix | Delete

if ( isset( $_POST[ $feature_option ] ) && '1' === $_POST[ $feature_option ] ) {

[185] Fix | Delete

continue;

[186] Fix | Delete

}

[187] Fix | Delete

[188] Fix | Delete

if ( 'yes' !== get_option( $feature_class::TOGGLE_OPTION_NAME, $default ) ) {

[189] Fix | Delete

$optional_features_unavailable[] = $optional_feature_key;

[190] Fix | Delete

}

[191] Fix | Delete

}

[192] Fix | Delete

}

[193] Fix | Delete

[194] Fix | Delete

return array_values( array_diff( $features, $optional_features_unavailable ) );

[195] Fix | Delete

}

[196] Fix | Delete

[197] Fix | Delete

/**

[198] Fix | Delete

* Check if a feature is enabled.

[199] Fix | Delete

*

[200] Fix | Delete

* @param string $feature Feature slug.

[201] Fix | Delete

* @return bool

[202] Fix | Delete

*/

[203] Fix | Delete

public static function is_enabled( $feature ) {

[204] Fix | Delete

$available_features = self::get_available_features();

[205] Fix | Delete

return in_array( $feature, $available_features, true );

[206] Fix | Delete

}

[207] Fix | Delete

[208] Fix | Delete

/**

[209] Fix | Delete

* Enable a toggleable optional feature.

[210] Fix | Delete

*

[211] Fix | Delete

* @param string $feature Feature name.

[212] Fix | Delete

* @return bool

[213] Fix | Delete

*/

[214] Fix | Delete

public static function enable( $feature ) {

[215] Fix | Delete

$features = self::get_optional_feature_options();

[216] Fix | Delete

[217] Fix | Delete

if ( isset( $features[ $feature ] ) ) {

[218] Fix | Delete

update_option( $features[ $feature ], 'yes' );

[219] Fix | Delete

return true;

[220] Fix | Delete

}

[221] Fix | Delete

[222] Fix | Delete

return false;

[223] Fix | Delete

}

[224] Fix | Delete

[225] Fix | Delete

/**

[226] Fix | Delete

* Disable a toggleable optional feature.

[227] Fix | Delete

*

[228] Fix | Delete

* @param string $feature Feature name.

[229] Fix | Delete

* @return bool

[230] Fix | Delete

*/

[231] Fix | Delete

public static function disable( $feature ) {

[232] Fix | Delete

$features = self::get_optional_feature_options();

[233] Fix | Delete

[234] Fix | Delete

if ( isset( $features[ $feature ] ) ) {

[235] Fix | Delete

update_option( $features[ $feature ], 'no' );

[236] Fix | Delete

return true;

[237] Fix | Delete

}

[238] Fix | Delete

[239] Fix | Delete

return false;

[240] Fix | Delete

}

[241] Fix | Delete

[242] Fix | Delete

/**

[243] Fix | Delete

* Disable features when opting out of tracking.

[244] Fix | Delete

*

[245] Fix | Delete

* @param string $old_value Old value.

[246] Fix | Delete

* @param string $value New value.

[247] Fix | Delete

*/

[248] Fix | Delete

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

[249] Fix | Delete

if ( 'yes' === $value ) {

[250] Fix | Delete

return;

[251] Fix | Delete

}

[252] Fix | Delete

[253] Fix | Delete

foreach ( self::$beta_features as $feature ) {

[254] Fix | Delete

self::disable( $feature );

[255] Fix | Delete

}

[256] Fix | Delete

}

[257] Fix | Delete

[258] Fix | Delete

/**

[259] Fix | Delete

* Adds the Features section to the advanced tab of WooCommerce Settings

[260] Fix | Delete

*

[261] Fix | Delete

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

[262] Fix | Delete

*

[263] Fix | Delete

* @param array $sections Sections.

[264] Fix | Delete

* @return array

[265] Fix | Delete

*/

[266] Fix | Delete

public static function add_features_section( $sections ) {

[267] Fix | Delete

return $sections;

[268] Fix | Delete

}

[269] Fix | Delete

[270] Fix | Delete

/**

[271] Fix | Delete

* Adds the Features settings.

[272] Fix | Delete

*

[273] Fix | Delete

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

[274] Fix | Delete

*

[275] Fix | Delete

* @param array $settings Settings.

[276] Fix | Delete

* @param string $current_section Current section slug.

[277] Fix | Delete

* @return array

[278] Fix | Delete

*/

[279] Fix | Delete

public static function add_features_settings( $settings, $current_section ) {

[280] Fix | Delete

return $settings;

[281] Fix | Delete

}

[282] Fix | Delete

[283] Fix | Delete

/**

[284] Fix | Delete

* Conditionally loads the beta features tracking modal.

[285] Fix | Delete

*

[286] Fix | Delete

* @param string $hook Page hook.

[287] Fix | Delete

*/

[288] Fix | Delete

public static function maybe_load_beta_features_modal( $hook ) {

[289] Fix | Delete

if (

[290] Fix | Delete

'woocommerce_page_wc-settings' !== $hook ||

[291] Fix | Delete

! isset( $_GET['tab'] ) || 'advanced' !== $_GET['tab'] || // phpcs:ignore CSRF ok.

[292] Fix | Delete

! isset( $_GET['section'] ) || 'features' !== $_GET['section'] // phpcs:ignore CSRF ok.

[293] Fix | Delete

) {

[294] Fix | Delete

return;

[295] Fix | Delete

}

[296] Fix | Delete

$tracking_enabled = get_option( 'woocommerce_allow_tracking', 'no' );

[297] Fix | Delete

[298] Fix | Delete

if ( empty( self::$beta_features ) ) {

[299] Fix | Delete

return;

[300] Fix | Delete

}

[301] Fix | Delete

[302] Fix | Delete

if ( 'yes' === $tracking_enabled ) {

[303] Fix | Delete

return;

[304] Fix | Delete

}

[305] Fix | Delete

[306] Fix | Delete

WCAdminAssets::register_style( 'beta-features-tracking-modal', 'style', array( 'wp-components' ) );

[307] Fix | Delete

WCAdminAssets::register_script( 'wp-admin-scripts', 'beta-features-tracking-modal', array( 'wp-i18n', 'wp-element', WC_ADMIN_APP ) );

[308] Fix | Delete

}

[309] Fix | Delete

[310] Fix | Delete

/**

[311] Fix | Delete

* Loads the required scripts on the correct pages.

[312] Fix | Delete

*/

[313] Fix | Delete

public static function load_scripts() {

[314] Fix | Delete

if ( ! PageController::is_admin_or_embed_page() ) {

[315] Fix | Delete

return;

[316] Fix | Delete

}

[317] Fix | Delete

[318] Fix | Delete

$features = self::get_features();

[319] Fix | Delete

$enabled_features = array();

[320] Fix | Delete

foreach ( $features as $key ) {

[321] Fix | Delete

$enabled_features[ $key ] = self::is_enabled( $key );

[322] Fix | Delete

}

[323] Fix | Delete

wp_add_inline_script( WC_ADMIN_APP, 'window.wcAdminFeatures = ' . wp_json_encode( $enabled_features, JSON_HEX_TAG | JSON_UNESCAPED_SLASHES ), 'before' );

[324] Fix | Delete

}

[325] Fix | Delete

[326] Fix | Delete

[327] Fix | Delete

/**

[328] Fix | Delete

* Adds body classes to the main wp-admin wrapper, allowing us to better target elements in specific scenarios.

[329] Fix | Delete

*

[330] Fix | Delete

* @param string $admin_body_class Body class to add.

[331] Fix | Delete

*/

[332] Fix | Delete

public static function add_admin_body_classes( $admin_body_class = '' ) {

[333] Fix | Delete

if ( ! PageController::is_admin_or_embed_page() ) {

[334] Fix | Delete

return $admin_body_class;

[335] Fix | Delete

}

[336] Fix | Delete

[337] Fix | Delete

$classes = explode( ' ', trim( $admin_body_class ) );

[338] Fix | Delete

[339] Fix | Delete

$features = self::get_features();

[340] Fix | Delete

foreach ( $features as $feature_key ) {

[341] Fix | Delete

$classes[] = sanitize_html_class( 'woocommerce-feature-enabled-' . $feature_key );

[342] Fix | Delete

}

[343] Fix | Delete

[344] Fix | Delete

$admin_body_class = implode( ' ', array_unique( $classes ) );

[345] Fix | Delete

return " $admin_body_class ";

[346] Fix | Delete

}

[347] Fix | Delete

[348] Fix | Delete

/**

[349] Fix | Delete

* Alias internal features classes to make them backward compatible.

[350] Fix | Delete

* We've moved our feature classes to src-internal as part of merging this

[351] Fix | Delete

* repository with WooCommerce Core to form a monorepo.

[352] Fix | Delete

* See https://wp.me/p90Yrv-2HY for details.

[353] Fix | Delete

*/

[354] Fix | Delete

private function register_internal_class_aliases() {

[355] Fix | Delete

$aliases = array(

[356] Fix | Delete

// new class => original class (this will be aliased).

[357] Fix | Delete

'Automattic\WooCommerce\Internal\Admin\WCPayPromotion\Init' => 'Automattic\WooCommerce\Admin\Features\WcPayPromotion\Init',

[358] Fix | Delete

'Automattic\WooCommerce\Internal\Admin\RemoteFreeExtensions\Init' => 'Automattic\WooCommerce\Admin\Features\RemoteFreeExtensions\Init',

[359] Fix | Delete

'Automattic\WooCommerce\Internal\Admin\ActivityPanels' => 'Automattic\WooCommerce\Admin\Features\ActivityPanels',

[360] Fix | Delete

'Automattic\WooCommerce\Internal\Admin\Analytics' => 'Automattic\WooCommerce\Admin\Features\Analytics',

[361] Fix | Delete

'Automattic\WooCommerce\Internal\Admin\Coupons' => 'Automattic\WooCommerce\Admin\Features\Coupons',

[362] Fix | Delete

'Automattic\WooCommerce\Internal\Admin\CouponsMovedTrait' => 'Automattic\WooCommerce\Admin\Features\CouponsMovedTrait',

[363] Fix | Delete

'Automattic\WooCommerce\Internal\Admin\CustomerEffortScoreTracks' => 'Automattic\WooCommerce\Admin\Features\CustomerEffortScoreTracks',

[364] Fix | Delete

'Automattic\WooCommerce\Internal\Admin\Homescreen' => 'Automattic\WooCommerce\Admin\Features\Homescreen',

[365] Fix | Delete

'Automattic\WooCommerce\Internal\Admin\Marketing' => 'Automattic\WooCommerce\Admin\Features\Marketing',

[366] Fix | Delete

'Automattic\WooCommerce\Internal\Admin\MobileAppBanner' => 'Automattic\WooCommerce\Admin\Features\MobileAppBanner',

[367] Fix | Delete

'Automattic\WooCommerce\Internal\Admin\RemoteInboxNotifications' => 'Automattic\WooCommerce\Admin\Features\RemoteInboxNotifications',

[368] Fix | Delete

'Automattic\WooCommerce\Internal\Admin\ShippingLabelBanner' => 'Automattic\WooCommerce\Admin\Features\ShippingLabelBanner',

[369] Fix | Delete

'Automattic\WooCommerce\Internal\Admin\ShippingLabelBannerDisplayRules' => 'Automattic\WooCommerce\Admin\Features\ShippingLabelBannerDisplayRules',

[370] Fix | Delete

'Automattic\WooCommerce\Internal\Admin\WcPayWelcomePage' => 'Automattic\WooCommerce\Admin\Features\WcPayWelcomePage',

[371] Fix | Delete

);

[372] Fix | Delete

foreach ( $aliases as $new_class => $orig_class ) {

[373] Fix | Delete

class_alias( $new_class, $orig_class );

[374] Fix | Delete

}

[375] Fix | Delete

}

[376] Fix | Delete

[377] Fix | Delete

/**

[378] Fix | Delete

* Check if we're in an admin context where features should be loaded.

[379] Fix | Delete

*

[380] Fix | Delete

* @return boolean

[381] Fix | Delete

*/

[382] Fix | Delete

private static function should_load_features() {

[383] Fix | Delete

$should_load = (

[384] Fix | Delete

is_admin() ||

[385] Fix | Delete

wp_doing_ajax() ||

[386] Fix | Delete

wp_doing_cron() ||

[387] Fix | Delete

( defined( 'WP_CLI' ) && WP_CLI ) ||

[388] Fix | Delete

( WC()->is_rest_api_request() && ! WC()->is_store_api_request() ) ||

[389] Fix | Delete

// Allow features to be loaded in frontend for admin users. This is needed for the use case such as the coming soon footer banner.

[390] Fix | Delete

current_user_can( 'manage_woocommerce' )

[391] Fix | Delete

);

[392] Fix | Delete

[393] Fix | Delete

/**

[394] Fix | Delete

* Filter to determine if admin features should be loaded.

[395] Fix | Delete

*

[396] Fix | Delete

* @since 9.6.0

[397] Fix | Delete

* @param boolean $should_load Whether admin features should be loaded. It defaults to true when the current request is in an admin context.

[398] Fix | Delete

*/

[399] Fix | Delete

return apply_filters( 'woocommerce_admin_should_load_features', $should_load );

[400] Fix | Delete

}

[401] Fix | Delete

}

[402] Fix | Delete

[403] Fix | Delete