<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Loads WooCommerce packages from the /packages directory. These are packages developed outside of core.

[2] Fix | Delete

*/

[3] Fix | Delete

[4] Fix | Delete

declare( strict_types=1 );

[5] Fix | Delete

[6] Fix | Delete

namespace Automattic\WooCommerce;

[7] Fix | Delete

[8] Fix | Delete

use Automattic\Jetpack\Constants;

[9] Fix | Delete

[10] Fix | Delete

defined( 'ABSPATH' ) || exit;

[11] Fix | Delete

[12] Fix | Delete

/**

[13] Fix | Delete

* Packages class.

[14] Fix | Delete

*

[15] Fix | Delete

* @since 3.7.0

[16] Fix | Delete

*/

[17] Fix | Delete

class Packages {

[18] Fix | Delete

[19] Fix | Delete

/**

[20] Fix | Delete

* Static-only class.

[21] Fix | Delete

*/

[22] Fix | Delete

private function __construct() {}

[23] Fix | Delete

[24] Fix | Delete

/**

[25] Fix | Delete

* Array of package names and their main package classes. Once a package has been merged into WooCommerce

[26] Fix | Delete

* directly it should be removed from here and added to the merged packages array.

[27] Fix | Delete

*

[28] Fix | Delete

* @var array Key is the package name/directory, value is the main package class which handles init.

[29] Fix | Delete

*/

[30] Fix | Delete

protected static $packages = array(

[31] Fix | Delete

'email-editor' => '\\Automattic\\WooCommerce\\Internal\\EmailEditor\\Package',

[32] Fix | Delete

);

[33] Fix | Delete

[34] Fix | Delete

/**

[35] Fix | Delete

* Array of package names and their main package classes.

[36] Fix | Delete

*

[37] Fix | Delete

* One a package has been merged into WooCommerce Core it should be moved from the package list and placed in

[38] Fix | Delete

* this list. This will ensure that the feature plugin is disabled as well as provide the class to handle

[39] Fix | Delete

* initialization for the now-merged feature plugin.

[40] Fix | Delete

*

[41] Fix | Delete

* Once a package has been merged into WooCommerce Core it should have its slug added here. This will ensure

[42] Fix | Delete

* that we deactivate the feature plugin automatically to prevent any problems caused by conflicts between

[43] Fix | Delete

* the two versions caused by them both being active.

[44] Fix | Delete

*

[45] Fix | Delete

* The packages included in this array cannot be deactivated and will always load with WooCommerce core.

[46] Fix | Delete

*

[47] Fix | Delete

* @var array Key is the package name/directory, value is the main package class which handles init.

[48] Fix | Delete

*/

[49] Fix | Delete

protected static $base_packages = array(

[50] Fix | Delete

'woocommerce-admin' => '\\Automattic\\WooCommerce\\Admin\\Composer\\Package',

[51] Fix | Delete

'woocommerce-gutenberg-products-block' => '\\Automattic\\WooCommerce\\Blocks\\Package',

[52] Fix | Delete

);

[53] Fix | Delete

[54] Fix | Delete

/**

[55] Fix | Delete

* Similar to $base_packages, but

[56] Fix | Delete

* the packages included in this array can be deactivated via the 'woocommerce_merged_packages' filter.

[57] Fix | Delete

*

[58] Fix | Delete

* @var array Key is the package name/directory, value is the main package class which handles init.

[59] Fix | Delete

*/

[60] Fix | Delete

protected static $merged_packages = array(

[61] Fix | Delete

'woocommerce-brands' => '\\Automattic\\WooCommerce\\Internal\\Brands',

[62] Fix | Delete

);

[63] Fix | Delete

[64] Fix | Delete

[65] Fix | Delete

/**

[66] Fix | Delete

* Init the package loader.

[67] Fix | Delete

*

[68] Fix | Delete

* @since 3.7.0

[69] Fix | Delete

*/

[70] Fix | Delete

public static function init() {

[71] Fix | Delete

add_action( 'plugins_loaded', array( __CLASS__, 'prepare_packages' ), -100 );

[72] Fix | Delete

add_action( 'plugins_loaded', array( __CLASS__, 'on_init' ), 10 );

[73] Fix | Delete

[74] Fix | Delete

// Prevent plugins already merged into WooCommerce core from getting activated as standalone plugins.

[75] Fix | Delete

add_action( 'activate_plugin', array( __CLASS__, 'deactivate_merged_plugins' ) );

[76] Fix | Delete

[77] Fix | Delete

// Display a notice in the Plugins tab next to plugins already merged into WooCommerce core.

[78] Fix | Delete

add_filter( 'all_plugins', array( __CLASS__, 'mark_merged_plugins_as_pending_update' ), 10, 1 );

[79] Fix | Delete

add_action( 'after_plugin_row', array( __CLASS__, 'display_notice_for_merged_plugins' ), 10, 1 );

[80] Fix | Delete

}

[81] Fix | Delete

[82] Fix | Delete

/**

[83] Fix | Delete

* Callback for WordPress init hook.

[84] Fix | Delete

*/

[85] Fix | Delete

public static function on_init() {

[86] Fix | Delete

self::deactivate_merged_packages();

[87] Fix | Delete

self::initialize_packages();

[88] Fix | Delete

}

[89] Fix | Delete

[90] Fix | Delete

/**

[91] Fix | Delete

* Checks a package exists by looking for it's directory.

[92] Fix | Delete

*

[93] Fix | Delete

* @param string $package Package name.

[94] Fix | Delete

* @return boolean

[95] Fix | Delete

*/

[96] Fix | Delete

public static function package_exists( $package ) {

[97] Fix | Delete

return file_exists( dirname( __DIR__ ) . '/packages/' . $package );

[98] Fix | Delete

}

[99] Fix | Delete

[100] Fix | Delete

/**

[101] Fix | Delete

* Checks a package exists by looking for it's directory.

[102] Fix | Delete

*

[103] Fix | Delete

* @param string $class_name Class name.

[104] Fix | Delete

* @return boolean

[105] Fix | Delete

*/

[106] Fix | Delete

public static function should_load_class( $class_name ) {

[107] Fix | Delete

[108] Fix | Delete

foreach ( self::$merged_packages as $merged_package_name => $merged_package_class ) {

[109] Fix | Delete

if ( str_replace( 'woocommerce-', 'wc_', $merged_package_name ) === $class_name ) {

[110] Fix | Delete

return true;

[111] Fix | Delete

}

[112] Fix | Delete

}

[113] Fix | Delete

[114] Fix | Delete

return false;

[115] Fix | Delete

}

[116] Fix | Delete

[117] Fix | Delete

/**

[118] Fix | Delete

* Gets all merged, enabled packages.

[119] Fix | Delete

*

[120] Fix | Delete

* @return array

[121] Fix | Delete

*/

[122] Fix | Delete

protected static function get_enabled_packages() {

[123] Fix | Delete

$enabled_packages = array();

[124] Fix | Delete

[125] Fix | Delete

foreach ( self::$merged_packages as $merged_package_name => $package_class ) {

[126] Fix | Delete

[127] Fix | Delete

$option = 'wc_feature_' . str_replace( '-', '_', $merged_package_name ) . '_enabled';

[128] Fix | Delete

$option_value = get_option( $option, '' );

[129] Fix | Delete

[130] Fix | Delete

// Opt out from the feature.

[131] Fix | Delete

if ( 'no' === $option_value ) {

[132] Fix | Delete

continue;

[133] Fix | Delete

}

[134] Fix | Delete

[135] Fix | Delete

// Force enable feature -- mainly for testing purpose.

[136] Fix | Delete

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

[137] Fix | Delete

$enabled_packages[ $merged_package_name ] = $package_class;

[138] Fix | Delete

continue;

[139] Fix | Delete

}

[140] Fix | Delete

[141] Fix | Delete

// If an option is not set, ensure that a package is enabled for user's remote variant number. Mainly for gradual releases.

[142] Fix | Delete

$experimental_package_enabled = method_exists( $package_class, 'is_enabled' ) ?

[143] Fix | Delete

call_user_func( array( $package_class, 'is_enabled' ) ) :

[144] Fix | Delete

false;

[145] Fix | Delete

[146] Fix | Delete

if ( ! $experimental_package_enabled ) {

[147] Fix | Delete

continue;

[148] Fix | Delete

}

[149] Fix | Delete

[150] Fix | Delete

$enabled_packages[ $merged_package_name ] = $package_class;

[151] Fix | Delete

}

[152] Fix | Delete

[153] Fix | Delete

return array_merge( $enabled_packages, self::$base_packages );

[154] Fix | Delete

}

[155] Fix | Delete

[156] Fix | Delete

/**

[157] Fix | Delete

* Checks if a package is enabled.

[158] Fix | Delete

*

[159] Fix | Delete

* @param string $package Package name.

[160] Fix | Delete

* @return boolean

[161] Fix | Delete

*/

[162] Fix | Delete

public static function is_package_enabled( $package ) {

[163] Fix | Delete

return array_key_exists( $package, self::get_enabled_packages() );

[164] Fix | Delete

}

[165] Fix | Delete

[166] Fix | Delete

/**

[167] Fix | Delete

* Prepare merged packages for initialization.

[168] Fix | Delete

* Especially useful when running actions early in the 'plugins_loaded' timeline.

[169] Fix | Delete

*/

[170] Fix | Delete

public static function prepare_packages() {

[171] Fix | Delete

foreach ( self::get_enabled_packages() as $package_name => $package_class ) {

[172] Fix | Delete

if ( method_exists( $package_class, 'prepare' ) ) {

[173] Fix | Delete

call_user_func( array( $package_class, 'prepare' ) );

[174] Fix | Delete

}

[175] Fix | Delete

}

[176] Fix | Delete

}

[177] Fix | Delete

[178] Fix | Delete

/**

[179] Fix | Delete

* Deactivates merged feature plugins.

[180] Fix | Delete

*

[181] Fix | Delete

* Once a feature plugin is merged into WooCommerce Core it should be deactivated. This method will

[182] Fix | Delete

* ensure that a plugin gets deactivated. Note that for the first request it will still be active,

[183] Fix | Delete

* and as such, there may be some odd behavior. This is unlikely to cause any issues though

[184] Fix | Delete

* because it will be deactivated on the request that updates or activates WooCommerce.

[185] Fix | Delete

*/

[186] Fix | Delete

protected static function deactivate_merged_packages() {

[187] Fix | Delete

// Developers may need to be able to run merged feature plugins alongside merged packages for testing purposes.

[188] Fix | Delete

if ( Constants::is_true( 'WC_ALLOW_MERGED_FEATURE_PLUGINS' ) ) {

[189] Fix | Delete

return;

[190] Fix | Delete

}

[191] Fix | Delete

[192] Fix | Delete

// Scroll through all of the active plugins and disable them if they're merged packages.

[193] Fix | Delete

$active_plugins = get_option( 'active_plugins', array() );

[194] Fix | Delete

// Deactivate the plugin if possible so that there are no conflicts.

[195] Fix | Delete

foreach ( $active_plugins as $active_plugin_path ) {

[196] Fix | Delete

$plugin_file = basename( plugin_basename( $active_plugin_path ), '.php' );

[197] Fix | Delete

[198] Fix | Delete

if ( ! self::is_package_enabled( $plugin_file ) ) {

[199] Fix | Delete

continue;

[200] Fix | Delete

}

[201] Fix | Delete

[202] Fix | Delete

require_once ABSPATH . 'wp-admin/includes/plugin.php';

[203] Fix | Delete

[204] Fix | Delete

// Make sure to display a message informing the user that the plugin has been deactivated.

[205] Fix | Delete

$plugin_data = get_plugin_data( WP_PLUGIN_DIR . '/' . $active_plugin_path );

[206] Fix | Delete

deactivate_plugins( $active_plugin_path );

[207] Fix | Delete

add_action(

[208] Fix | Delete

'admin_notices',

[209] Fix | Delete

function () use ( $plugin_data ) {

[210] Fix | Delete

echo '<div class="error"><p>';

[211] Fix | Delete

printf(

[212] Fix | Delete

/* translators: %s: is referring to the plugin's name. */

[213] Fix | Delete

esc_html__( 'The %1$s plugin has been deactivated as the latest improvements are now included with the %2$s plugin.', 'woocommerce' ),

[214] Fix | Delete

'<code>' . esc_html( $plugin_data['Name'] ) . '</code>',

[215] Fix | Delete

'<code>WooCommerce</code>'

[216] Fix | Delete

);

[217] Fix | Delete

echo '</p></div>';

[218] Fix | Delete

}

[219] Fix | Delete

);

[220] Fix | Delete

}

[221] Fix | Delete

}

[222] Fix | Delete

[223] Fix | Delete

/**

[224] Fix | Delete

* Prevent plugins already merged into WooCommerce core from getting activated as standalone plugins.

[225] Fix | Delete

*

[226] Fix | Delete

* @param string $plugin Plugin name.

[227] Fix | Delete

*/

[228] Fix | Delete

public static function deactivate_merged_plugins( $plugin ) {

[229] Fix | Delete

$plugin_dir = basename( dirname( $plugin ) );

[230] Fix | Delete

[231] Fix | Delete

if ( self::is_package_enabled( $plugin_dir ) ) {

[232] Fix | Delete

$plugins_url = esc_url( admin_url( 'plugins.php' ) );

[233] Fix | Delete

wp_die(

[234] Fix | Delete

esc_html__( 'This plugin cannot be activated because its functionality is now included in WooCommerce core.', 'woocommerce' ),

[235] Fix | Delete

esc_html__( 'Plugin Activation Error', 'woocommerce' ),

[236] Fix | Delete

array(

[237] Fix | Delete

'link_url' => esc_url( $plugins_url ),

[238] Fix | Delete

'link_text' => esc_html__( 'Return to the Plugins page', 'woocommerce' ),

[239] Fix | Delete

),

[240] Fix | Delete

);

[241] Fix | Delete

}

[242] Fix | Delete

}

[243] Fix | Delete

[244] Fix | Delete

/**

[245] Fix | Delete

* Mark merged plugins as pending update.

[246] Fix | Delete

* This is required for correctly displaying maintenance notices.

[247] Fix | Delete

*

[248] Fix | Delete

* @param array $plugins Plugins list.

[249] Fix | Delete

*/

[250] Fix | Delete

public static function mark_merged_plugins_as_pending_update( $plugins ) {

[251] Fix | Delete

foreach ( $plugins as $plugin_name => $plugin_data ) {

[252] Fix | Delete

$plugin_dir = basename( dirname( $plugin_name ) );

[253] Fix | Delete

if ( self::is_package_enabled( $plugin_dir ) ) {

[254] Fix | Delete

// Necessary to properly display notice within row.

[255] Fix | Delete

$plugins[ $plugin_name ]['update'] = 1;

[256] Fix | Delete

}

[257] Fix | Delete

}

[258] Fix | Delete

return $plugins;

[259] Fix | Delete

}

[260] Fix | Delete

[261] Fix | Delete

/**

[262] Fix | Delete

* Displays a maintenance notice next to merged plugins, to inform users

[263] Fix | Delete

* that the plugin functionality is now offered by WooCommerce core.

[264] Fix | Delete

*

[265] Fix | Delete

* Requires 'mark_merged_plugins_as_pending_update' to properly display this notice.

[266] Fix | Delete

*

[267] Fix | Delete

* @param string $plugin_file Plugin file.

[268] Fix | Delete

*/

[269] Fix | Delete

public static function display_notice_for_merged_plugins( $plugin_file ) {

[270] Fix | Delete

global $wp_list_table;

[271] Fix | Delete

[272] Fix | Delete

$plugin_dir = basename( dirname( $plugin_file ) );

[273] Fix | Delete

if ( ! self::is_package_enabled( $plugin_dir ) || is_null( $wp_list_table ) ) {

[274] Fix | Delete

return;

[275] Fix | Delete

}

[276] Fix | Delete

[277] Fix | Delete

$columns_count = $wp_list_table->get_column_count();

[278] Fix | Delete

$notice = __( 'This plugin can no longer be activated because its functionality is now included in <strong>WooCommerce</strong>. It is recommended to <strong>delete</strong> it.', 'woocommerce' );

[279] Fix | Delete

echo '<tr class="plugin-update-tr"><td colspan="' . esc_attr( $columns_count ) . '" class="plugin-update"><div class="update-message notice inline notice-error notice-alt"><p>' . wp_kses_post( $notice ) . '</p></div></td></tr>';

[280] Fix | Delete

}

[281] Fix | Delete

[282] Fix | Delete

/**

[283] Fix | Delete

* Loads packages after plugins_loaded hook.

[284] Fix | Delete

*

[285] Fix | Delete

* Each package should include an init file which loads the package so it can be used by core.

[286] Fix | Delete

*/

[287] Fix | Delete

protected static function initialize_packages() {

[288] Fix | Delete

foreach ( self::get_enabled_packages() as $package_name => $package_class ) {

[289] Fix | Delete

call_user_func( array( $package_class, 'init' ) );

[290] Fix | Delete

}

[291] Fix | Delete

[292] Fix | Delete

foreach ( self::$packages as $package_name => $package_class ) {

[293] Fix | Delete

if ( ! self::package_exists( $package_name ) ) {

[294] Fix | Delete

self::missing_package( $package_name );

[295] Fix | Delete

continue;

[296] Fix | Delete

}

[297] Fix | Delete

call_user_func( array( $package_class, 'init' ) );

[298] Fix | Delete

}

[299] Fix | Delete

[300] Fix | Delete

// Proxies "activated_plugin" hook for embedded packages listen on WC plugin activation

[301] Fix | Delete

// https://github.com/woocommerce/woocommerce/issues/28697.

[302] Fix | Delete

if ( is_admin() ) {

[303] Fix | Delete

$activated_plugin = get_transient( 'woocommerce_activated_plugin' );

[304] Fix | Delete

if ( $activated_plugin ) {

[305] Fix | Delete

delete_transient( 'woocommerce_activated_plugin' );

[306] Fix | Delete

[307] Fix | Delete

/**

[308] Fix | Delete

* WooCommerce is activated hook.

[309] Fix | Delete

*

[310] Fix | Delete

* @since 5.0.0

[311] Fix | Delete

* @param bool $activated_plugin Activated plugin path,

[312] Fix | Delete

* generally woocommerce/woocommerce.php.

[313] Fix | Delete

*/

[314] Fix | Delete

do_action( 'woocommerce_activated_plugin', $activated_plugin );

[315] Fix | Delete

}

[316] Fix | Delete

}

[317] Fix | Delete

}

[318] Fix | Delete

[319] Fix | Delete

/**

[320] Fix | Delete

* If a package is missing, add an admin notice.

[321] Fix | Delete

*

[322] Fix | Delete

* @param string $package Package name.

[323] Fix | Delete

*/

[324] Fix | Delete

protected static function missing_package( $package ) {

[325] Fix | Delete

if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {

[326] Fix | Delete

error_log( // phpcs:ignore

[327] Fix | Delete

sprintf(

[328] Fix | Delete

/* Translators: %s package name. */

[329] Fix | Delete

esc_html__( 'Missing the WooCommerce %s package', 'woocommerce' ),

[330] Fix | Delete

'<code>' . esc_html( $package ) . '</code>'

[331] Fix | Delete

) . ' - ' . esc_html__( 'Your installation of WooCommerce is incomplete. If you installed WooCommerce from GitHub, please refer to this document to set up your development environment: https://github.com/woocommerce/woocommerce/wiki/How-to-set-up-WooCommerce-development-environment', 'woocommerce' )

[332] Fix | Delete

);

[333] Fix | Delete

}

[334] Fix | Delete

add_action(

[335] Fix | Delete

'admin_notices',

[336] Fix | Delete

function () use ( $package ) {

[337] Fix | Delete

?>

[338] Fix | Delete

<div class="notice notice-error">

[339] Fix | Delete

<p>

[340] Fix | Delete

<strong>

[341] Fix | Delete

<?php

[342] Fix | Delete

printf(

[343] Fix | Delete

/* Translators: %s package name. */

[344] Fix | Delete

esc_html__( 'Missing the WooCommerce %s package', 'woocommerce' ),

[345] Fix | Delete

'<code>' . esc_html( $package ) . '</code>'

[346] Fix | Delete

);

[347] Fix | Delete

?>

[348] Fix | Delete

</strong>

[349] Fix | Delete

<br>

[350] Fix | Delete

<?php

[351] Fix | Delete

printf(

[352] Fix | Delete

/* translators: 1: is a link to a support document. 2: closing link */

[353] Fix | Delete

esc_html__( 'Your installation of WooCommerce is incomplete. If you installed WooCommerce from GitHub, %1$splease refer to this document%2$s to set up your development environment.', 'woocommerce' ),

[354] Fix | Delete

'<a href="' . esc_url( 'https://github.com/woocommerce/woocommerce/wiki/How-to-set-up-WooCommerce-development-environment' ) . '" target="_blank" rel="noopener noreferrer">',

[355] Fix | Delete

'</a>'

[356] Fix | Delete

);

[357] Fix | Delete

?>

[358] Fix | Delete

</p>

[359] Fix | Delete

</div>

[360] Fix | Delete

<?php

[361] Fix | Delete

}

[362] Fix | Delete

);

[363] Fix | Delete

}

[364] Fix | Delete

}

[365] Fix | Delete

[366] Fix | Delete