Jetpack_Sync_Module_Callables::get_all_callables() - Code Metrics - Inspection of "New build" - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master-stable ( a82972...9baba8 )

unknown

created 2017-11-10 20:56 UTC

Jetpack_Sync_Module_Callables::get_all_callables() A

↳ Parent: Jetpack_Sync_Module_Callables

Complexity

Conditions	1
Paths	1

Size

Total Lines	11
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	8
nc	1
nop	0
dl	0
loc	11
rs	9.4285
c	0
b	0
f	0

<?php

require_once dirname( __FILE__ ) . '/class.jetpack-sync-functions.php';

class Jetpack_Sync_Module_Callables extends Jetpack_Sync_Module {
	const CALLABLES_CHECKSUM_OPTION_NAME = 'jetpack_callables_sync_checksum';
	const CALLABLES_AWAIT_TRANSIENT_NAME = 'jetpack_sync_callables_await';

	private $callable_whitelist;

	public function name() {
		return 'functions';
	}

	public function set_defaults() {
		if ( is_multisite() ) {
			$this->callable_whitelist = array_merge( Jetpack_Sync_Defaults::get_callable_whitelist(), Jetpack_Sync_Defaults::get_multisite_callable_whitelist() );
		} else {
			$this->callable_whitelist = Jetpack_Sync_Defaults::get_callable_whitelist();
		}
	}

	public function init_listeners( $callable ) {
		add_action( 'jetpack_sync_callable', $callable, 10, 2 );
		add_action( 'admin_init', array( $this, 'set_plugin_action_links' ), 9999 ); // Should happen very late

		// For some options, we should always send the change right away!
		$always_send_updates_to_these_options = array(
			'jetpack_active_modules',
			'home',
			'siteurl',
			'jetpack_sync_error_idc'
		);
		foreach( $always_send_updates_to_these_options as $option ) {
			add_action( "update_option_{$option}", array( $this, 'unlock_sync_callable' ) );
		}

		// Provide a hook so that hosts can send changes to certain callables right away.
		// Especially useful when a host uses constants to change home and siteurl.
		add_action( 'jetpack_sync_unlock_sync_callable', array( $this, 'unlock_sync_callable' ) );

		// get_plugins and wp_version
		// gets fired when new code gets installed, updates etc.
		add_action( 'upgrader_process_complete', array( $this, 'unlock_plugin_action_link_and_callables' ) );
		add_action( 'update_option_active_plugins', array( $this, 'unlock_plugin_action_link_and_callables' ) );
	}

	public function init_full_sync_listeners( $callable ) {
		add_action( 'jetpack_full_sync_callables', $callable );
	}

	public function init_before_send() {
		add_action( 'jetpack_sync_before_send_queue_sync', array( $this, 'maybe_sync_callables' ) );

		// full sync
		add_filter( 'jetpack_sync_before_send_jetpack_full_sync_callables', array( $this, 'expand_callables' ) );
	}

	public function reset_data() {
		delete_option( self::CALLABLES_CHECKSUM_OPTION_NAME );
		delete_transient( self::CALLABLES_AWAIT_TRANSIENT_NAME );

		$url_callables = array( 'home_url', 'site_url', 'main_network_site_url' );
		foreach( $url_callables as $callable ) {
			delete_option( Jetpack_Sync_Functions::HTTPS_CHECK_OPTION_PREFIX . $callable );
		}
	}

	function set_callable_whitelist( $callables ) {
		$this->callable_whitelist = $callables;
	}

	function get_callable_whitelist() {
		return $this->callable_whitelist;
	}

	public function get_all_callables() {
		// get_all_callables should run as the master user always.
		$current_user_id = get_current_user_id();
		wp_set_current_user( Jetpack_Options::get_option( 'master_user' ) );
		$callables = array_combine(
			array_keys( $this->get_callable_whitelist() ),
			array_map( array( $this, 'get_callable' ), array_values( $this->get_callable_whitelist() ) )
		);
		wp_set_current_user( $current_user_id );
		return $callables;
	}

	private function get_callable( $callable ) {
		return call_user_func( $callable );
	}

	public function enqueue_full_sync_actions( $config, $max_items_to_enqueue, $state ) {
		/**
		 * Tells the client to sync all callables to the server
		 *
		 * @since 4.2.0
		 *
		 * @param boolean Whether to expand callables (should always be true)
		 */
		do_action( 'jetpack_full_sync_callables', true );

		// The number of actions enqueued, and next module state (true == done)
		return array( 1, true );
	}

	public function estimate_full_sync_actions( $config ) {
		return 1;
	}

	public function get_full_sync_actions() {
		return array( 'jetpack_full_sync_callables' );
	}

	public function unlock_sync_callable() {
		delete_transient( self::CALLABLES_AWAIT_TRANSIENT_NAME );
	}

	public function unlock_plugin_action_link_and_callables() {
		delete_transient( self::CALLABLES_AWAIT_TRANSIENT_NAME );
		delete_transient( 'jetpack_plugin_api_action_links_refresh' );
	}

	public function set_plugin_action_links() {
		if (
			! class_exists( 'DOMDocument' ) ||
			! function_exists ( 'libxml_use_internal_errors' ) ||
			! function_exists ( 'mb_convert_encoding' )
		) {
			return;
		}

		// Is the transient lock in place?
		$plugins_lock = get_transient( 'jetpack_plugin_api_action_links_refresh', false );
		if ( ! empty( $plugins_lock ) ) {
			return;
		}
		$plugins = array_keys( Jetpack_Sync_Functions::get_plugins() );
		foreach ( $plugins as $plugin_file ) {
			/** This filter is documented in src/wp-admin/includes/class-wp-plugins-list-table.php */
			$action_links = apply_filters( 'plugin_action_links', array(), $plugin_file, null, 'all' );
			/** This filter is documented in src/wp-admin/includes/class-wp-plugins-list-table.php */
			$action_links = apply_filters( "plugin_action_links_{$plugin_file}", $action_links, $plugin_file, null, 'all' );
			$formatted_action_links = null;
			if ( ! empty( $action_links ) && count( $action_links ) > 0 ) {
				$dom_doc = new DOMDocument;
				foreach ( $action_links as $action_link ) {
					// The @ is not enough to suppress errors when dealing with libxml,
					// we have to tell it directly how we want to handle errors.
					libxml_use_internal_errors( true );
					$dom_doc->loadHTML( mb_convert_encoding( $action_link, 'HTML-ENTITIES', 'UTF-8' ) );
					libxml_use_internal_errors( false );

					$link_elements = $dom_doc->getElementsByTagName( 'a' );
					if ( $link_elements->length == 0 ) {
						continue;
					}

					$link_element = $link_elements->item( 0 );
					if ( $link_element->hasAttribute( 'href' ) && $link_element->nodeValue ) {

						$link_url = trim( $link_element->getAttribute( 'href' ) );

						// Add the full admin path to the url if the plugin did not provide it
						$link_url_scheme = wp_parse_url( $link_url, PHP_URL_SCHEME );
						if ( empty( $link_url_scheme ) ) {
							$link_url = admin_url( $link_url );
						}

						$formatted_action_links[ $link_element->nodeValue ] = $link_url;
					}
				}
			}
			if ( $formatted_action_links ) {
				$plugins_action_links[ $plugin_file ] = $formatted_action_links;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
			}
		}
		// Cache things for a long time
		set_transient( 'jetpack_plugin_api_action_links_refresh', time(), DAY_IN_SECONDS );
		update_option( 'jetpack_plugin_api_action_links', $plugins_action_links );
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
	}

	public function should_send_callable( $callable_checksums, $name, $checksum ) {
		$idc_override_callables = array(
			'main_network_site',
			'home_url',
			'site_url',
		);
		if ( in_array( $name, $idc_override_callables ) && Jetpack_Options::get_option( 'migrate_for_idc' ) ) {
			return true;
		}

		return ! $this->still_valid_checksum( $callable_checksums, $name, $checksum );
	}

	public function maybe_sync_callables() {
		if ( ! is_admin() || Jetpack_Sync_Settings::is_doing_cron() ) {
			return;
		}

		if ( get_transient( self::CALLABLES_AWAIT_TRANSIENT_NAME ) ) {
			return;
		}

		set_transient( self::CALLABLES_AWAIT_TRANSIENT_NAME, microtime( true ), Jetpack_Sync_Defaults::$default_sync_callables_wait_time );


		$callables = $this->get_all_callables();

		if ( empty( $callables ) ) {
			return;
		}

		$callable_checksums = (array) Jetpack_Options::get_raw_option( self::CALLABLES_CHECKSUM_OPTION_NAME, array() );

		// only send the callables that have changed
		foreach ( $callables as $name => $value ) {
			$checksum = $this->get_check_sum( $value );
			// explicitly not using Identical comparison as get_option returns a string
			if ( ! is_null( $value ) && $this->should_send_callable( $callable_checksums, $name, $checksum ) ) {
				/**
				 * Tells the client to sync a callable (aka function) to the server
				 *
				 * @since 4.2.0
				 *
				 * @param string The name of the callable
				 * @param mixed The value of the callable
				 */
				do_action( 'jetpack_sync_callable', $name, $value );
				$callable_checksums[ $name ] = $checksum;
			} else {
				$callable_checksums[ $name ] = $checksum;
			}
		}
		Jetpack_Options::update_raw_option( self::CALLABLES_CHECKSUM_OPTION_NAME, $callable_checksums );
	}

	public function expand_callables( $args ) {
		if ( $args[0] ) {
			$callables = $this->get_all_callables();
			$callables_checksums = array();
			foreach ( $callables as $name => $value ) {
				$callables_checksums[ $name ] = $this->get_check_sum( $value );
			}
			Jetpack_Options::update_raw_option( self::CALLABLES_CHECKSUM_OPTION_NAME, $callables_checksums );
			return $callables;
		}

		return $args;
	}
}


1			<?php
2
3			require_once dirname( __FILE__ ) . '/class.jetpack-sync-functions.php';
4
5			class Jetpack_Sync_Module_Callables extends Jetpack_Sync_Module {
6			const CALLABLES_CHECKSUM_OPTION_NAME = 'jetpack_callables_sync_checksum';
7			const CALLABLES_AWAIT_TRANSIENT_NAME = 'jetpack_sync_callables_await';
8
9			private $callable_whitelist;
10
11			public function name() {
12			return 'functions';
13			}
14
15			public function set_defaults() {
16			if ( is_multisite() ) {
17			$this->callable_whitelist = array_merge( Jetpack_Sync_Defaults::get_callable_whitelist(), Jetpack_Sync_Defaults::get_multisite_callable_whitelist() );
18			} else {
19			$this->callable_whitelist = Jetpack_Sync_Defaults::get_callable_whitelist();
20			}
21			}
22
23			public function init_listeners( $callable ) {
24			add_action( 'jetpack_sync_callable', $callable, 10, 2 );
25			add_action( 'admin_init', array( $this, 'set_plugin_action_links' ), 9999 ); // Should happen very late
26
27			// For some options, we should always send the change right away!
28			$always_send_updates_to_these_options = array(
29			'jetpack_active_modules',
30			'home',
31			'siteurl',
32			'jetpack_sync_error_idc'
33			);
34			foreach( $always_send_updates_to_these_options as $option ) {
35			add_action( "update_option_{$option}", array( $this, 'unlock_sync_callable' ) );
36			}
37
38			// Provide a hook so that hosts can send changes to certain callables right away.
39			// Especially useful when a host uses constants to change home and siteurl.
40			add_action( 'jetpack_sync_unlock_sync_callable', array( $this, 'unlock_sync_callable' ) );
41
42			// get_plugins and wp_version
43			// gets fired when new code gets installed, updates etc.
44			add_action( 'upgrader_process_complete', array( $this, 'unlock_plugin_action_link_and_callables' ) );
45			add_action( 'update_option_active_plugins', array( $this, 'unlock_plugin_action_link_and_callables' ) );
46			}
47
48			public function init_full_sync_listeners( $callable ) {
49			add_action( 'jetpack_full_sync_callables', $callable );
50			}
51
52			public function init_before_send() {
53			add_action( 'jetpack_sync_before_send_queue_sync', array( $this, 'maybe_sync_callables' ) );
54
55			// full sync
56			add_filter( 'jetpack_sync_before_send_jetpack_full_sync_callables', array( $this, 'expand_callables' ) );
57			}
58
59			public function reset_data() {
60			delete_option( self::CALLABLES_CHECKSUM_OPTION_NAME );
61			delete_transient( self::CALLABLES_AWAIT_TRANSIENT_NAME );
62
63			$url_callables = array( 'home_url', 'site_url', 'main_network_site_url' );
64			foreach( $url_callables as $callable ) {
65			delete_option( Jetpack_Sync_Functions::HTTPS_CHECK_OPTION_PREFIX . $callable );
66			}
67			}
68
69			function set_callable_whitelist( $callables ) {
70			$this->callable_whitelist = $callables;
71			}
72
73			function get_callable_whitelist() {
74			return $this->callable_whitelist;
75			}
76
77			public function get_all_callables() {
78			// get_all_callables should run as the master user always.
79			$current_user_id = get_current_user_id();
80			wp_set_current_user( Jetpack_Options::get_option( 'master_user' ) );
81			$callables = array_combine(
82			array_keys( $this->get_callable_whitelist() ),
83			array_map( array( $this, 'get_callable' ), array_values( $this->get_callable_whitelist() ) )
84			);
85			wp_set_current_user( $current_user_id );
86			return $callables;
87			}
88
89			private function get_callable( $callable ) {
90			return call_user_func( $callable );
91			}
92
93			public function enqueue_full_sync_actions( $config, $max_items_to_enqueue, $state ) {
94			/**
95			* Tells the client to sync all callables to the server
96			*
97			* @since 4.2.0
98			*
99			* @param boolean Whether to expand callables (should always be true)
100			*/
101			do_action( 'jetpack_full_sync_callables', true );
102
103			// The number of actions enqueued, and next module state (true == done)
104			return array( 1, true );
105			}
106
107			public function estimate_full_sync_actions( $config ) {
108			return 1;
109			}
110
111			public function get_full_sync_actions() {
112			return array( 'jetpack_full_sync_callables' );
113			}
114
115			public function unlock_sync_callable() {
116			delete_transient( self::CALLABLES_AWAIT_TRANSIENT_NAME );
117			}
118
119			public function unlock_plugin_action_link_and_callables() {
120			delete_transient( self::CALLABLES_AWAIT_TRANSIENT_NAME );
121			delete_transient( 'jetpack_plugin_api_action_links_refresh' );
122			}
123
124			public function set_plugin_action_links() {
125			if (
126			! class_exists( 'DOMDocument' ) \|\|
127			! function_exists ( 'libxml_use_internal_errors' ) \|\|
128			! function_exists ( 'mb_convert_encoding' )
129			) {
130			return;
131			}
132
133			// Is the transient lock in place?
134			$plugins_lock = get_transient( 'jetpack_plugin_api_action_links_refresh', false );
135			if ( ! empty( $plugins_lock ) ) {
136			return;
137			}
138			$plugins = array_keys( Jetpack_Sync_Functions::get_plugins() );
139			foreach ( $plugins as $plugin_file ) {
140			/** This filter is documented in src/wp-admin/includes/class-wp-plugins-list-table.php */
141			$action_links = apply_filters( 'plugin_action_links', array(), $plugin_file, null, 'all' );
142			/** This filter is documented in src/wp-admin/includes/class-wp-plugins-list-table.php */
143			$action_links = apply_filters( "plugin_action_links_{$plugin_file}", $action_links, $plugin_file, null, 'all' );
144			$formatted_action_links = null;
145			if ( ! empty( $action_links ) && count( $action_links ) > 0 ) {
146			$dom_doc = new DOMDocument;
147			foreach ( $action_links as $action_link ) {
148			// The @ is not enough to suppress errors when dealing with libxml,
149			// we have to tell it directly how we want to handle errors.
150			libxml_use_internal_errors( true );
151			$dom_doc->loadHTML( mb_convert_encoding( $action_link, 'HTML-ENTITIES', 'UTF-8' ) );
152			libxml_use_internal_errors( false );
153
154			$link_elements = $dom_doc->getElementsByTagName( 'a' );
155			if ( $link_elements->length == 0 ) {
156			continue;
157			}
158
159			$link_element = $link_elements->item( 0 );
160			if ( $link_element->hasAttribute( 'href' ) && $link_element->nodeValue ) {
			0 ignored issues – show Bug introduced 2017-03-13 13:40 UTC by Report Bug Copy Issue Report The method `hasAttribute()` does not exist on `DOMNode`. Did you maybe mean `hasAttributes()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
161			$link_url = trim( $link_element->getAttribute( 'href' ) );
162
163			// Add the full admin path to the url if the plugin did not provide it
164			$link_url_scheme = wp_parse_url( $link_url, PHP_URL_SCHEME );
165			if ( empty( $link_url_scheme ) ) {
166			$link_url = admin_url( $link_url );
167			}
168
169			$formatted_action_links[ $link_element->nodeValue ] = $link_url;
170			}
171			}
172			}
173			if ( $formatted_action_links ) {
174			$plugins_action_links[ $plugin_file ] = $formatted_action_links;
			0 ignored issues – show Coding Style Comprehensibility introduced 2017-09-27 18:20 UTC by Report Bug Copy Issue Report `$plugins_action_links` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$plugins_action_links = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
175			}
176			}
177			// Cache things for a long time
178			set_transient( 'jetpack_plugin_api_action_links_refresh', time(), DAY_IN_SECONDS );
179			update_option( 'jetpack_plugin_api_action_links', $plugins_action_links );
			0 ignored issues – show Bug introduced 2017-10-06 15:25 UTC by Report Bug Copy Issue Report The variable `$plugins_action_links` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
180			}
181
182			public function should_send_callable( $callable_checksums, $name, $checksum ) {
183			$idc_override_callables = array(
184			'main_network_site',
185			'home_url',
186			'site_url',
187			);
188			if ( in_array( $name, $idc_override_callables ) && Jetpack_Options::get_option( 'migrate_for_idc' ) ) {
189			return true;
190			}
191
192			return ! $this->still_valid_checksum( $callable_checksums, $name, $checksum );
193			}
194
195			public function maybe_sync_callables() {
196			if ( ! is_admin() \|\| Jetpack_Sync_Settings::is_doing_cron() ) {
197			return;
198			}
199
200			if ( get_transient( self::CALLABLES_AWAIT_TRANSIENT_NAME ) ) {
201			return;
202			}
203
204			set_transient( self::CALLABLES_AWAIT_TRANSIENT_NAME, microtime( true ), Jetpack_Sync_Defaults::$default_sync_callables_wait_time );
			0 ignored issues – show Bug introduced 2017-03-06 21:43 UTC by Report Bug Copy Issue Report The property `default_sync_callables_wait_time` cannot be accessed from this context as it is declared `private` in class `Jetpack_Sync_Defaults`. This check looks for access to properties that are not accessible from the current context. If you need to make a property accessible to another context you can either raise its visibility level or provide an accessible getter in the defining class. Loading history...
205
206			$callables = $this->get_all_callables();
207
208			if ( empty( $callables ) ) {
209			return;
210			}
211
212			$callable_checksums = (array) Jetpack_Options::get_raw_option( self::CALLABLES_CHECKSUM_OPTION_NAME, array() );
213
214			// only send the callables that have changed
215			foreach ( $callables as $name => $value ) {
216			$checksum = $this->get_check_sum( $value );
217			// explicitly not using Identical comparison as get_option returns a string
218			if ( ! is_null( $value ) && $this->should_send_callable( $callable_checksums, $name, $checksum ) ) {
219			/**
220			* Tells the client to sync a callable (aka function) to the server
221			*
222			* @since 4.2.0
223			*
224			* @param string The name of the callable
225			* @param mixed The value of the callable
226			*/
227			do_action( 'jetpack_sync_callable', $name, $value );
228			$callable_checksums[ $name ] = $checksum;
229			} else {
230			$callable_checksums[ $name ] = $checksum;
231			}
232			}
233			Jetpack_Options::update_raw_option( self::CALLABLES_CHECKSUM_OPTION_NAME, $callable_checksums );
234			}
235
236			public function expand_callables( $args ) {
237			if ( $args[0] ) {
238			$callables = $this->get_all_callables();
239			$callables_checksums = array();
240			foreach ( $callables as $name => $value ) {
241			$callables_checksums[ $name ] = $this->get_check_sum( $value );
242			}
243			Jetpack_Options::update_raw_option( self::CALLABLES_CHECKSUM_OPTION_NAME, $callables_checksums );
244			return $callables;
245			}
246
247			return $args;
248			}
249			}
250

Automattic / jetpack

Push — master-stable ( a82972...9baba8 )

Jetpack_Sync_Module_Callables::get_all_callables() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like