<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Special cases for overriding modules.

[2] Fix | Delete

*

[3] Fix | Delete

* @package automattic/jetpack

[4] Fix | Delete

*/

[5] Fix | Delete

[6] Fix | Delete

/**

[7] Fix | Delete

* Provides methods for dealing with module overrides.

[8] Fix | Delete

*

[9] Fix | Delete

* @since 5.9.0

[10] Fix | Delete

*/

[11] Fix | Delete

class Jetpack_Modules_Overrides {

[12] Fix | Delete

/**

[13] Fix | Delete

* Used to cache module overrides so that we minimize how many times we apply the

[14] Fix | Delete

* option_jetpack_active_modules filter.

[15] Fix | Delete

*

[16] Fix | Delete

* @var null|array

[17] Fix | Delete

*/

[18] Fix | Delete

private $overrides = null;

[19] Fix | Delete

[20] Fix | Delete

/**

[21] Fix | Delete

* Clears the $overrides member used for caching.

[22] Fix | Delete

*

[23] Fix | Delete

* Since get_overrides() can be passed a falsey value to skip caching, this is probably

[24] Fix | Delete

* most useful for clearing cache between tests.

[25] Fix | Delete

*

[26] Fix | Delete

* @return void

[27] Fix | Delete

*/

[28] Fix | Delete

public function clear_cache() {

[29] Fix | Delete

$this->overrides = null;

[30] Fix | Delete

}

[31] Fix | Delete

[32] Fix | Delete

/**

[33] Fix | Delete

* Returns true if there is a filter on the jetpack_active_modules option.

[34] Fix | Delete

*

[35] Fix | Delete

* @return bool Whether there is a filter on the jetpack_active_modules option.

[36] Fix | Delete

*/

[37] Fix | Delete

public function do_overrides_exist() {

[38] Fix | Delete

return (bool) ( has_filter( 'option_jetpack_active_modules' ) || has_filter( 'jetpack_active_modules' ) );

[39] Fix | Delete

}

[40] Fix | Delete

[41] Fix | Delete

/**

[42] Fix | Delete

* Gets the override for a given module.

[43] Fix | Delete

*

[44] Fix | Delete

* @param string $module_slug The module's slug.

[45] Fix | Delete

* @param boolean $use_cache Whether or not cached overrides should be used.

[46] Fix | Delete

*

[47] Fix | Delete

* @return bool|string False if no override for module. 'active' or 'inactive' if there is an override.

[48] Fix | Delete

*/

[49] Fix | Delete

public function get_module_override( $module_slug, $use_cache = true ) {

[50] Fix | Delete

$overrides = $this->get_overrides( $use_cache );

[51] Fix | Delete

[52] Fix | Delete

if ( ! isset( $overrides[ $module_slug ] ) ) {

[53] Fix | Delete

return false;

[54] Fix | Delete

}

[55] Fix | Delete

[56] Fix | Delete

return $overrides[ $module_slug ];

[57] Fix | Delete

}

[58] Fix | Delete

[59] Fix | Delete

/**

[60] Fix | Delete

* Returns an array of module overrides where the key is the module slug and the value

[61] Fix | Delete

* is true if the module is forced on and false if the module is forced off.

[62] Fix | Delete

*

[63] Fix | Delete

* @param bool $use_cache Whether or not cached overrides should be used.

[64] Fix | Delete

*

[65] Fix | Delete

* @return array The array of module overrides.

[66] Fix | Delete

*/

[67] Fix | Delete

public function get_overrides( $use_cache = true ) {

[68] Fix | Delete

if ( $use_cache && $this->overrides !== null ) {

[69] Fix | Delete

return $this->overrides;

[70] Fix | Delete

}

[71] Fix | Delete

[72] Fix | Delete

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

[73] Fix | Delete

return array();

[74] Fix | Delete

}

[75] Fix | Delete

[76] Fix | Delete

$available_modules = Jetpack::get_available_modules();

[77] Fix | Delete

[78] Fix | Delete

/**

[79] Fix | Delete

* First, let's get all modules that have been forced on.

[80] Fix | Delete

*/

[81] Fix | Delete

[82] Fix | Delete

/** This filter is documented in wp-includes/option.php */

[83] Fix | Delete

$filtered = apply_filters( 'option_jetpack_active_modules', array() );

[84] Fix | Delete

[85] Fix | Delete

/** This filter is documented in class.jetpack.php */

[86] Fix | Delete

$filtered = apply_filters( 'jetpack_active_modules', $filtered );

[87] Fix | Delete

[88] Fix | Delete

$forced_on = array_diff( $filtered, array() );

[89] Fix | Delete

[90] Fix | Delete

/**

[91] Fix | Delete

* Second, let's get all modules forced off.

[92] Fix | Delete

*/

[93] Fix | Delete

[94] Fix | Delete

/** This filter is documented in wp-includes/option.php */

[95] Fix | Delete

$filtered = apply_filters( 'option_jetpack_active_modules', $available_modules );

[96] Fix | Delete

[97] Fix | Delete

/** This filter is documented in class.jetpack.php */

[98] Fix | Delete

$filtered = apply_filters( 'jetpack_active_modules', $filtered );

[99] Fix | Delete

[100] Fix | Delete

$forced_off = array_diff( $available_modules, $filtered );

[101] Fix | Delete

[102] Fix | Delete

/**

[103] Fix | Delete

* Last, build the return value.

[104] Fix | Delete

*/

[105] Fix | Delete

$return_value = array();

[106] Fix | Delete

foreach ( $forced_on as $on ) {

[107] Fix | Delete

$return_value[ $on ] = 'active';

[108] Fix | Delete

}

[109] Fix | Delete

[110] Fix | Delete

foreach ( $forced_off as $off ) {

[111] Fix | Delete

$return_value[ $off ] = 'inactive';

[112] Fix | Delete

}

[113] Fix | Delete

[114] Fix | Delete

$this->overrides = $return_value;

[115] Fix | Delete

[116] Fix | Delete

return $return_value;

[117] Fix | Delete

}

[118] Fix | Delete

[119] Fix | Delete

/**

[120] Fix | Delete

* A reference to an instance of this class.

[121] Fix | Delete

*

[122] Fix | Delete

* @var Jetpack_Modules_Overrides

[123] Fix | Delete

*/

[124] Fix | Delete

private static $instance = null;

[125] Fix | Delete

[126] Fix | Delete

/**

[127] Fix | Delete

* Returns the singleton instance of Jetpack_Modules_Overrides

[128] Fix | Delete

*

[129] Fix | Delete

* @return Jetpack_Modules_Overrides

[130] Fix | Delete

*/

[131] Fix | Delete

public static function instance() {

[132] Fix | Delete

if ( self::$instance === null ) {

[133] Fix | Delete

self::$instance = new Jetpack_Modules_Overrides();

[134] Fix | Delete

}

[135] Fix | Delete

[136] Fix | Delete

return self::$instance;

[137] Fix | Delete

}

[138] Fix | Delete

[139] Fix | Delete

/**

[140] Fix | Delete

* Private construct to enforce singleton.

[141] Fix | Delete

*/

[142] Fix | Delete

private function __construct() {

[143] Fix | Delete

}

[144] Fix | Delete

}

[145] Fix | Delete

[146] Fix | Delete