Jetpack_Sync_Client::set_constants_whitelist() - Code Metrics - Inspection of "Make constants whitelist function naming more cons..." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — add/sync-rest-2 ( a538dc...58beac )

unknown

created 2016-04-17 19:34 UTC

Jetpack_Sync_Client::set_constants_whitelist() A

↳ Parent: Jetpack_Sync_Client

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	3
rs	10
cc	1
eloc	2
nc	1
nop	1

<?php
require_once dirname( __FILE__ ) . '/class.jetpack-sync-deflate-codec.php';
require_once dirname( __FILE__ ) . '/class.jetpack-sync-queue.php';

class Jetpack_Sync_Client {
	static $default_options_whitelist = array( 'stylesheet', '/^theme_mods_.*$/' );
class A {
    var $property;
}
	static $default_constants_whitelist = array();
class A {
    var $property;
}

	private $sync_queue;
	private $codec;
	private $options_whitelist;
	private $constants_whitelist;
	private $meta_types = array( 'post' );

	// singleton functions
	private static $instance;

	public static function getInstance() {
		if (null === static::$instance) {
class YourClass
{
    private static $someVariable;

    public static function getSomeVariable()
    {
        return static::$someVariable;
    }
}
			static::$instance = new static();
class YourClass
{
    private static $someVariable;

    public static function getSomeVariable()
    {
        return static::$someVariable;
    }
}
		}
		
		return static::$instance;
class YourClass
{
    private static $someVariable;

    public static function getSomeVariable()
    {
        return static::$someVariable;
    }
}
	}

	// this is necessary because you can't use "new" when you declare instance properties >:(
	protected function __construct() {
		$this->sync_queue = new Jetpack_Sync_Queue( 'sync', 100 );
		$this->codec = new Jetpack_Sync_Deflate_Codec();
		$this->options_whitelist = self::$default_options_whitelist;
		$this->init();
	}

	private function init() {
		$handler = array( $this, 'action_handler' );

		// posts
		add_action( 'wp_insert_post', $handler, 10, 3 );
		add_action( 'deleted_post', $handler, 10 );

		// comments
		add_action( 'wp_insert_comment', $handler, 10, 2 );
		add_action( 'deleted_comment', $handler, 10 );
		add_action( 'trashed_comment', $handler, 10 );
		add_action( 'spammed_comment', $handler, 10 );

		// even though it's messy, we implement these hooks because 
		// the edit_comment hook doesn't include the data
		// so this saves us a DB read for every comment event
		foreach ( array( '', 'trackback', 'pingback' ) as $comment_type ) {
			foreach ( array( 'unapproved', 'approved' ) as $comment_status ) {
				add_action( "comment_{$comment_status}_{$comment_type}", $handler, 10, 2 );
			}
		}

		// options
		add_action( 'added_option', $handler, 10, 2 );
		add_action( 'updated_option', $handler, 10, 3 );
		add_action( 'deleted_option', $handler, 10, 1 );

		// themes
		add_action( 'jetpack_sync_current_theme_support', $handler, 10 ); // custom hook, see meta-hooks below
		add_action( 'jetpack_sync_current_constants', $handler, 10 );

		// post-meta, and in the future - other meta?
		foreach ( $this->meta_types as $meta_type ) {
			// we need to make sure we don't commit before we receive these,
			// because they're invoked after meta changes are saved to the DB
			add_action( "added_{$meta_type}_meta", $handler, 99, 4 );
			add_action( "updated_{$meta_type}_meta", $handler, 99, 4 );
			add_action( "deleted_{$meta_type}_meta", $handler, 99, 4 );
		}

		/**
		 * Other hooks - fire synthetic hooks for all the properties we need to sync, 
		 * e.g. when a theme changes
		 */

		// themes
		add_action( 'switch_theme', array( $this, 'switch_theme_handler' ) );
	}

	function set_options_whitelist( $options ) {
		$this->options_whitelist = $options;
	}

	function set_constants_whitelist( $constants ) {
		$this->constants_whitelist = $constants;
	}

	function is_whitelisted_option( $option ) {
		foreach ( $this->options_whitelist as $whitelisted_option ) {
			if ( $whitelisted_option[0] === '/' && preg_match( $whitelisted_option, $option ) ) {
				return true;
			} elseif ( $whitelisted_option === $option ) {
				return true;
			}
		}
		return false;
	}

	function set_codec( iJetpack_Sync_Codec $codec ) {
		$this->codec = $codec;
	}

	function set_sync_queue( $queue ) {
		$this->sync_queue = $queue;
	}

	function action_handler() {
		$current_filter = current_filter();
		$args           = func_get_args();

		if ( $current_filter === 'wp_insert_post' && $args[1]->post_type === 'revision' ) {
			return;
		}

		if ( in_array( $current_filter, array( 'deleted_option', 'added_option', 'updated_option' ) ) 
			&& 
			! $this->is_whitelisted_option( $args[0] ) ) {
			return;
		}
		Jetpack_Sync::schedule_sync();
		$this->sync_queue->add( array(
			$current_filter,
			$args
		) );
	}

	function switch_theme_handler() {
		global $_wp_theme_features;
		
		do_action( 'jetpack_sync_current_theme_support', $_wp_theme_features );
	}

	function do_sync() {
		$this->maybe_sync_constants();

		// TODO: only send buffer once, then do the rest in a cron job

		$iters = 0;
		while ( ( $buffer = $this->sync_queue->checkout() ) && $iters < 100 ) {

			if ( !$buffer ) {
				// buffer has no items
				return;
			}

			if ( is_wp_error( $buffer) ) {
				error_log("Error fetching buffer: ".$buffer->get_error_message());

				return;
			}

			$data = $this->codec->encode( $buffer->get_items() );

			/**
			 * Fires when data is ready to send to the server.
			 * Return false or WP_Error to abort the sync (e.g. if there's an error)
			 * The items will be automatically re-sent later
			 *
			 * @since 4.1
			 *
			 * @param array $data The action buffer
			 */
			$result = apply_filters( 'jetpack_sync_client_send_data', $data );

			if ( !$result || is_wp_error( $result ) ) {
				$this->sync_queue->checkin( $buffer );
			} else {
				$this->sync_queue->close( $buffer );
			}
			$iters += 1;
		}
	}
	
	private function maybe_sync_constants() {
		$constants = $this->get_all_constants();
		$constants_check_sum = $this->get_check_sum( $constants );
		$check_sum_option = 'jetpack_constants_sync_checksum';
		if ( $constants_check_sum !== get_option( $check_sum_option ) ) {
			do_action( 'jetpack_sync_current_constants', $constants );
			update_option( $check_sum_option, $constants_check_sum );
		}
	}

	private function get_all_constants() {
		return 	array_combine( 
					$this->constants_whitelist, 
					array_map( array( $this, 'get_constant' ), $this->constants_whitelist ) 
				);
	}

	private function get_constant( $constant ) {
		if ( defined( $constant ) ) {
			return constant( $constant );
		}

		return null;
	}

	private function get_check_sum( $values ) {
		return crc32( serialize( $values ) );
	}

	function get_actions() {
		// TODO: we should only send a bit at a time, flush_all sends everything

		return $this->sync_queue->flush_all();
	}

	function get_all_actions() {
		return $this->sync_queue->get_all();
	}

	function reset_state() {
		$this->codec = new Jetpack_Sync_Deflate_Codec();
		$this->constants_whitelist = self::$default_constants_whitelist;
		$this->options_whitelist = self::$default_options_whitelist;
		$this->sync_queue->reset();
	}
}


1			<?php
2			require_once dirname( __FILE__ ) . '/class.jetpack-sync-deflate-codec.php';
3			require_once dirname( __FILE__ ) . '/class.jetpack-sync-queue.php';
4
5			class Jetpack_Sync_Client {
6			static $default_options_whitelist = array( 'stylesheet', '/^theme_mods_.*$/' );
			0 ignored issues – show Coding Style introduced 2016-04-17 19:29 UTC by Report Bug Copy Issue Report The visibility should be declared for property `$default_options_whitelist`. The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using class A { var $property; } the property is implicitly global. To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2. Loading history...
7			static $default_constants_whitelist = array();
			0 ignored issues – show Coding Style introduced 2016-04-17 19:47 UTC by Report Bug Copy Issue Report The visibility should be declared for property `$default_constants_whitelist`. The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using class A { var $property; } the property is implicitly global. To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2. Loading history...
8
9			private $sync_queue;
10			private $codec;
11			private $options_whitelist;
12			private $constants_whitelist;
13			private $meta_types = array( 'post' );
14
15			// singleton functions
16			private static $instance;
17
18			public static function getInstance() {
19			if (null === static::$instance) {
			0 ignored issues – show Bug introduced 2016-04-17 19:11 UTC by Report Bug Copy Issue Report Since `$instance` is declared private, accessing it with `static` will lead to errors in possible sub-classes; consider using `self`, or increasing the visibility of `$instance` to at least protected. Let’s assume you have a class which uses late-static binding: class YourClass { private static $someVariable; public static function getSomeVariable() { return static::$someVariable; } } The code above will run fine in your PHP runtime. However, if you now create a sub-class and call the `getSomeVariable()` on that sub-class, you will receive a runtime error: class YourSubClass extends YourClass { } YourSubClass::getSomeVariable(); // Will cause an access error. In the case above, it makes sense to update `SomeClass` to use `self` instead: class SomeClass { private static $someVariable; public static function getSomeVariable() { return self::$someVariable; // self works fine with private. } } Loading history...
20			static::$instance = new static();
			0 ignored issues – show Bug introduced 2016-04-17 19:11 UTC by Report Bug Copy Issue Report Since `$instance` is declared private, accessing it with `static` will lead to errors in possible sub-classes; consider using `self`, or increasing the visibility of `$instance` to at least protected. Let’s assume you have a class which uses late-static binding: class YourClass { private static $someVariable; public static function getSomeVariable() { return static::$someVariable; } } The code above will run fine in your PHP runtime. However, if you now create a sub-class and call the `getSomeVariable()` on that sub-class, you will receive a runtime error: class YourSubClass extends YourClass { } YourSubClass::getSomeVariable(); // Will cause an access error. In the case above, it makes sense to update `SomeClass` to use `self` instead: class SomeClass { private static $someVariable; public static function getSomeVariable() { return self::$someVariable; // self works fine with private. } } Loading history...
21			}
22
23			return static::$instance;
			0 ignored issues – show Bug introduced 2016-04-17 19:11 UTC by Report Bug Copy Issue Report Since `$instance` is declared private, accessing it with `static` will lead to errors in possible sub-classes; consider using `self`, or increasing the visibility of `$instance` to at least protected. Let’s assume you have a class which uses late-static binding: class YourClass { private static $someVariable; public static function getSomeVariable() { return static::$someVariable; } } The code above will run fine in your PHP runtime. However, if you now create a sub-class and call the `getSomeVariable()` on that sub-class, you will receive a runtime error: class YourSubClass extends YourClass { } YourSubClass::getSomeVariable(); // Will cause an access error. In the case above, it makes sense to update `SomeClass` to use `self` instead: class SomeClass { private static $someVariable; public static function getSomeVariable() { return self::$someVariable; // self works fine with private. } } Loading history...
24			}
25
26			// this is necessary because you can't use "new" when you declare instance properties >:(
27			protected function __construct() {
28			$this->sync_queue = new Jetpack_Sync_Queue( 'sync', 100 );
29			$this->codec = new Jetpack_Sync_Deflate_Codec();
30			$this->options_whitelist = self::$default_options_whitelist;
31			$this->init();
32			}
33
34			private function init() {
35			$handler = array( $this, 'action_handler' );
36
37			// posts
38			add_action( 'wp_insert_post', $handler, 10, 3 );
39			add_action( 'deleted_post', $handler, 10 );
40
41			// comments
42			add_action( 'wp_insert_comment', $handler, 10, 2 );
43			add_action( 'deleted_comment', $handler, 10 );
44			add_action( 'trashed_comment', $handler, 10 );
45			add_action( 'spammed_comment', $handler, 10 );
46
47			// even though it's messy, we implement these hooks because
48			// the edit_comment hook doesn't include the data
49			// so this saves us a DB read for every comment event
50			foreach ( array( '', 'trackback', 'pingback' ) as $comment_type ) {
51			foreach ( array( 'unapproved', 'approved' ) as $comment_status ) {
52			add_action( "comment_{$comment_status}_{$comment_type}", $handler, 10, 2 );
53			}
54			}
55
56			// options
57			add_action( 'added_option', $handler, 10, 2 );
58			add_action( 'updated_option', $handler, 10, 3 );
59			add_action( 'deleted_option', $handler, 10, 1 );
60
61			// themes
62			add_action( 'jetpack_sync_current_theme_support', $handler, 10 ); // custom hook, see meta-hooks below
63			add_action( 'jetpack_sync_current_constants', $handler, 10 );
64
65			// post-meta, and in the future - other meta?
66			foreach ( $this->meta_types as $meta_type ) {
67			// we need to make sure we don't commit before we receive these,
68			// because they're invoked after meta changes are saved to the DB
69			add_action( "added_{$meta_type}_meta", $handler, 99, 4 );
70			add_action( "updated_{$meta_type}_meta", $handler, 99, 4 );
71			add_action( "deleted_{$meta_type}_meta", $handler, 99, 4 );
72			}
73
74			/**
75			* Other hooks - fire synthetic hooks for all the properties we need to sync,
76			* e.g. when a theme changes
77			*/
78
79			// themes
80			add_action( 'switch_theme', array( $this, 'switch_theme_handler' ) );
81			}
82
83			function set_options_whitelist( $options ) {
84			$this->options_whitelist = $options;
85			}
86
87			function set_constants_whitelist( $constants ) {
88			$this->constants_whitelist = $constants;
89			}
90
91			function is_whitelisted_option( $option ) {
92			foreach ( $this->options_whitelist as $whitelisted_option ) {
93			if ( $whitelisted_option[0] === '/' && preg_match( $whitelisted_option, $option ) ) {
94			return true;
95			} elseif ( $whitelisted_option === $option ) {
96			return true;
97			}
98			}
99			return false;
100			}
101
102			function set_codec( iJetpack_Sync_Codec $codec ) {
103			$this->codec = $codec;
104			}
105
106			function set_sync_queue( $queue ) {
107			$this->sync_queue = $queue;
108			}
109
110			function action_handler() {
111			$current_filter = current_filter();
112			$args = func_get_args();
113
114			if ( $current_filter === 'wp_insert_post' && $args[1]->post_type === 'revision' ) {
115			return;
116			}
117
118			if ( in_array( $current_filter, array( 'deleted_option', 'added_option', 'updated_option' ) )
119			&&
120			! $this->is_whitelisted_option( $args[0] ) ) {
121			return;
122			}
123			Jetpack_Sync::schedule_sync();
124			$this->sync_queue->add( array(
125			$current_filter,
126			$args
127			) );
128			}
129
130			function switch_theme_handler() {
131			global $_wp_theme_features;
132
133			do_action( 'jetpack_sync_current_theme_support', $_wp_theme_features );
134			}
135
136			function do_sync() {
137			$this->maybe_sync_constants();
138
139			// TODO: only send buffer once, then do the rest in a cron job
			0 ignored issues – show Coding Style Best Practice introduced 2016-04-17 04:00 UTC by Report Bug Copy Issue Report Comments for TODO tasks are often forgotten in the code; it might be better to use a dedicated issue tracker. Loading history...
140			$iters = 0;
141			while ( ( $buffer = $this->sync_queue->checkout() ) && $iters < 100 ) {
142
143			if ( !$buffer ) {
144			// buffer has no items
145			return;
146			}
147
148			if ( is_wp_error( $buffer) ) {
149			error_log("Error fetching buffer: ".$buffer->get_error_message());
			0 ignored issues – show Bug introduced 2016-04-14 22:16 UTC by Report Bug Copy Issue Report The method `get_error_message()` does not seem to exist on `object<Jetpack_Sync_Queue_Buffer>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
150			return;
151			}
152
153			$data = $this->codec->encode( $buffer->get_items() );
154
155			/**
156			* Fires when data is ready to send to the server.
157			* Return false or WP_Error to abort the sync (e.g. if there's an error)
158			* The items will be automatically re-sent later
159			*
160			* @since 4.1
161			*
162			* @param array $data The action buffer
163			*/
164			$result = apply_filters( 'jetpack_sync_client_send_data', $data );
165
166			if ( !$result \|\| is_wp_error( $result ) ) {
167			$this->sync_queue->checkin( $buffer );
168			} else {
169			$this->sync_queue->close( $buffer );
170			}
171			$iters += 1;
172			}
173			}
174
175			private function maybe_sync_constants() {
176			$constants = $this->get_all_constants();
177			$constants_check_sum = $this->get_check_sum( $constants );
178			$check_sum_option = 'jetpack_constants_sync_checksum';
179			if ( $constants_check_sum !== get_option( $check_sum_option ) ) {
180			do_action( 'jetpack_sync_current_constants', $constants );
181			update_option( $check_sum_option, $constants_check_sum );
182			}
183			}
184
185			private function get_all_constants() {
186			return array_combine(
187			$this->constants_whitelist,
188			array_map( array( $this, 'get_constant' ), $this->constants_whitelist )
189			);
190			}
191
192			private function get_constant( $constant ) {
193			if ( defined( $constant ) ) {
194			return constant( $constant );
195			}
196
197			return null;
198			}
199
200			private function get_check_sum( $values ) {
201			return crc32( serialize( $values ) );
202			}
203
204			function get_actions() {
205			// TODO: we should only send a bit at a time, flush_all sends everything
			0 ignored issues – show Coding Style Best Practice introduced 2016-04-14 22:16 UTC by Report Bug Copy Issue Report Comments for TODO tasks are often forgotten in the code; it might be better to use a dedicated issue tracker. Loading history...
206			return $this->sync_queue->flush_all();
207			}
208
209			function get_all_actions() {
210			return $this->sync_queue->get_all();
211			}
212
213			function reset_state() {
214			$this->codec = new Jetpack_Sync_Deflate_Codec();
215			$this->constants_whitelist = self::$default_constants_whitelist;
216			$this->options_whitelist = self::$default_options_whitelist;
217			$this->sync_queue->reset();
218			}
219			}
220

Automattic / jetpack

Push — add/sync-rest-2 ( a538dc...58beac )

Jetpack_Sync_Client::set_constants_whitelist() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like