Jetpack_Sync_Module_Callables::get_all_callables() - Code Metrics - Inspection of "Merge pull request #4828 from Automattic/fix/only-..." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — fix/aag-section-header-mobile ( 4c98bd )

unknown

created 2016-08-16 20:30 UTC

Jetpack_Sync_Module_Callables::get_all_callables() A

↳ Parent: Jetpack_Sync_Module_Callables

Complexity

Conditions	1
Paths	1

Size

Total Lines	12
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?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::$default_callable_whitelist, Jetpack_Sync_Defaults::$default_multisite_callable_whitelist );

		} else {
			$this->callable_whitelist = Jetpack_Sync_Defaults::$default_callable_whitelist;

		}
	}

	public function init_listeners( $callable ) {
		add_action( 'jetpack_sync_callable', $callable, 10, 2 );

		// always send change to active modules right away
		add_action( 'update_option_jetpack_active_modules', 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_sync_callable' ) );
	}

	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 );
	}

	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->callable_whitelist ),
			array_map( array( $this, 'get_callable' ), array_values( $this->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 ) {
		/**
		 * 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 );

		return 1; // The number of actions enqueued
	}

	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 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) get_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 ( ! $this->still_valid_checksum( $callable_checksums, $name, $checksum ) && ! is_null( $value ) ) {
				/**
				 * 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;
			}
		}
		update_option( self::CALLABLES_CHECKSUM_OPTION_NAME, $callable_checksums );
	}

	public function expand_callables( $args ) {
		if ( $args[0] ) {
			return $this->get_all_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::$default_callable_whitelist, Jetpack_Sync_Defaults::$default_multisite_callable_whitelist );
		0 ignored issues – show Bug introduced 2016-06-29 22:35 UTC by Report Bug Copy Issue Report The property `default_callable_whitelist` 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... Bug introduced 2016-06-29 22:35 UTC by Report Bug Copy Issue Report The property `default_multisite_callable_whitelist` 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...
18		} else {
19		$this->callable_whitelist = Jetpack_Sync_Defaults::$default_callable_whitelist;
		0 ignored issues – show Bug introduced 2016-06-29 22:35 UTC by Report Bug Copy Issue Report The property `default_callable_whitelist` 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...
20		}
21		}
22
23		public function init_listeners( $callable ) {
24		add_action( 'jetpack_sync_callable', $callable, 10, 2 );
25
26		// always send change to active modules right away
27		add_action( 'update_option_jetpack_active_modules', array( $this, 'unlock_sync_callable' ) );
28
29		// get_plugins and wp_version
30		// gets fired when new code gets installed, updates etc.
31		add_action( 'upgrader_process_complete', array( $this, 'unlock_sync_callable' ) );
32		}
33
34		public function init_full_sync_listeners( $callable ) {
35		add_action( 'jetpack_full_sync_callables', $callable );
36		}
37
38		public function init_before_send() {
39		add_action( 'jetpack_sync_before_send_queue_sync', array( $this, 'maybe_sync_callables' ) );
40
41		// full sync
42		add_filter( 'jetpack_sync_before_send_jetpack_full_sync_callables', array( $this, 'expand_callables' ) );
43		}
44
45		public function reset_data() {
46		delete_option( self::CALLABLES_CHECKSUM_OPTION_NAME );
47		delete_transient( self::CALLABLES_AWAIT_TRANSIENT_NAME );
48		}
49
50		function set_callable_whitelist( $callables ) {
51		$this->callable_whitelist = $callables;
52		}
53
54		function get_callable_whitelist() {
55		return $this->callable_whitelist;
56		}
57
58		public function get_all_callables() {
59		// get_all_callables should run as the master user always.
60		$current_user_id = get_current_user_id();
61		wp_set_current_user( Jetpack_Options::get_option( 'master_user' ) );
62		$callables = array_combine(
63		array_keys( $this->callable_whitelist ),
64		array_map( array( $this, 'get_callable' ), array_values( $this->callable_whitelist ) )
65		);
66		wp_set_current_user( $current_user_id );
67
68		return $callables;
69		}
70
71		private function get_callable( $callable ) {
72		return call_user_func( $callable );
73		}
74
75		public function enqueue_full_sync_actions( $config ) {
76		/**
77		* Tells the client to sync all callables to the server
78		*
79		* @since 4.2.0
80		*
81		* @param boolean Whether to expand callables (should always be true)
82		*/
83		do_action( 'jetpack_full_sync_callables', true );
84
85		return 1; // The number of actions enqueued
86		}
87
88		public function estimate_full_sync_actions( $config ) {
89		return 1;
90		}
91
92		public function get_full_sync_actions() {
93		return array( 'jetpack_full_sync_callables' );
94		}
95
96		public function unlock_sync_callable() {
97		delete_transient( self::CALLABLES_AWAIT_TRANSIENT_NAME );
98		}
99
100		public function maybe_sync_callables() {
101		if ( ! is_admin() \|\| Jetpack_Sync_Settings::is_doing_cron() ) {
102		return;
103		}
104
105		if ( get_transient( self::CALLABLES_AWAIT_TRANSIENT_NAME ) ) {
106		return;
107		}
108
109		set_transient( self::CALLABLES_AWAIT_TRANSIENT_NAME, microtime( true ), Jetpack_Sync_Defaults::$default_sync_callables_wait_time );
		0 ignored issues – show Bug introduced 2016-07-28 00:08 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...
110
111		$callables = $this->get_all_callables();
112
113		if ( empty( $callables ) ) {
114		return;
115		}
116
117		$callable_checksums = (array) get_option( self::CALLABLES_CHECKSUM_OPTION_NAME, array() );
118
119		// only send the callables that have changed
120	View Code Duplication	foreach ( $callables as $name => $value ) {
121		$checksum = $this->get_check_sum( $value );
122		// explicitly not using Identical comparison as get_option returns a string
123		if ( ! $this->still_valid_checksum( $callable_checksums, $name, $checksum ) && ! is_null( $value ) ) {
124		/**
125		* Tells the client to sync a callable (aka function) to the server
126		*
127		* @since 4.2.0
128		*
129		* @param string The name of the callable
130		* @param mixed The value of the callable
131		*/
132		do_action( 'jetpack_sync_callable', $name, $value );
133		$callable_checksums[ $name ] = $checksum;
134		} else {
135		$callable_checksums[ $name ] = $checksum;
136		}
137		}
138		update_option( self::CALLABLES_CHECKSUM_OPTION_NAME, $callable_checksums );
139		}
140
141		public function expand_callables( $args ) {
142		if ( $args[0] ) {
143		return $this->get_all_callables();
144		}
145
146		return $args;
147		}
148		}
149

Automattic / jetpack

Push — fix/aag-section-header-mobile ( 4c98bd )

Jetpack_Sync_Module_Callables::get_all_callables() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like