Jetpack_Sync_Full::get_status() - Code Metrics - Inspection of "Full sync progress" - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — add/sync-rest-2 ( 1dfaae...26bda8 )

unknown

created 2016-04-21 22:02 UTC

Jetpack_Sync_Full::get_status() A

↳ Parent: Jetpack_Sync_Full

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	0

<?php

/**
 * This class does a full resync of the database by 
 * enqueuing an outbound action for every single object
 * that we care about.
 * 
 * This class contains a few non-obvious optimisations that should be explained:
 * - we fire an action called jetpack_full_sync_start so that WPCOM can erase the contents of the cached database
 * - for each object type, we obtain a full list of object IDs to sync via a single API call (hoping that since they're ints, they can all fit in RAM)
 * - we load the full objects for those IDs in chunks of Jetpack_Sync_Full::$array_chunk_size (to reduce the number of MySQL calls)
 * - we fire a trigger for the entire array which the Jetpack_Sync_Client then serializes and queues.
 */

class Jetpack_Sync_Full {
	static $array_chunk_size = 5;
class A {
    var $property;
}
	static $status_transient_name = "jetpack_full_sync_progress";
class A {
    var $property;
}
	static $transient_timeout = 3600; // an hour
class A {
    var $property;
}
	static $modules = array( 'wp_version', 'constants', 'functions', 'options', 'posts', 'comments', 'themes', 'updates' ); 
class A {
    var $property;
}

	// singleton functions
	private static $instance;

	public static function getInstance() {
		if ( null === self::$instance ) {
			self::$instance = new self();
		}

		return self::$instance;
	}

	protected function __construct() {
		$this->init();
	}

	function init() {
		add_filter( "jetack_sync_before_send_jetpack_full_sync_posts", array( $this, 'expand_post_ids' ) );
		add_filter( "jetack_sync_before_send_jetpack_full_sync_comments", array( $this, 'expand_comment_ids' ) );
	}

	function start() {
		$this->client = Jetpack_Sync_Client::getInstance();
class MyClass { }

$x = new MyClass();
$x->foo = true;
		do_action( 'jetpack_full_sync_start' );

		$this->set_status_queuing_started();

		$this->enqueue_wp_version();
		$this->enqueue_all_constants();
		$this->enqueue_all_functions();
		$this->enqueue_all_options();
		$this->enqueue_all_theme_info();
		$this->enqueue_all_posts();
		$this->enqueue_all_comments();
		$this->enqueue_all_updates();

		$this->set_status_queuing_finished();

		do_action( 'jetpack_full_sync_end' );
	}

	private function enqueue_wp_version() {
		$this->set_status("wp_version", 0);
		global $wp_version;
		do_action( 'jetpack_sync_wp_version', $wp_version );
		$this->set_status("wp_version", 100);
	}

	private function enqueue_all_constants() {
		$this->set_status("constants", 0);
		$this->client->force_sync_constants();
		$this->set_status("constants", 100);
	}

	private function enqueue_all_functions() {
		$this->set_status("functions", 0);
		$this->client->force_sync_callables();
		$this->set_status("functions", 100);
	}

	private function enqueue_all_options() {
		$this->set_status("options", 0);
		global $wpdb;

		// Unfortunately, since our options whitelist includes regexes,
		// we need to load all option names and match them against the whitelist.
		// This could be pretty awful if we have huge queues, but it's the only way to 
		// be sure we're syncing everything that's whitelisted.

		// As per posts and comments, we do this in ID batches and hope the IDs *AND* names don't exceed RAM

		// In theory, MySQL has regex support. In practice, I wouldn't want to rely on it being compatible
		// with PHP's regexes.

		// Alternatively, rather than option regexes, we could use wildcards in the option and then just
		// use "LIKE" queries here, replacing * with %?

		$option_names = $wpdb->get_col( "SELECT option_name FROM $wpdb->options" );

		// filter by client option whitelist
		$option_names = array_filter( $option_names, array( $this->client, 'is_whitelisted_option' ) );

		$counter = 0;
		$total = count( $option_names );

		foreach ( $option_names as $option_name ) {
			$this->set_status( "options", ( $counter / $total ) * 100 );
			do_action( 'jetpack_full_sync_option', $option_name, get_option( $option_name ) );
			$counter += 1;
		}

		$this->set_status("options", 100);
	}

	private function enqueue_all_posts() {
		$this->set_status("posts", 0);
		global $wpdb;

		// I hope this is never bigger than RAM...
		$post_ids = $wpdb->get_col( "SELECT id FROM $wpdb->posts");

		// Request posts in groups of N for efficiency
		$chunked_post_ids = array_chunk( $post_ids, self::$array_chunk_size );

		$counter = 0;
		$total = count( $chunked_post_ids );

		// Send each chunk as an array of objects
		foreach ( $chunked_post_ids as $chunk ) {
			$this->set_status( "posts", ( $counter / $total ) * 100 );
			do_action( 'jetpack_full_sync_posts', $chunk );
			$counter += 1;
		}

		$this->set_status("posts", 100);
	}

	public function expand_post_ids( $args ) {
		$post_ids = $args[0];
		global $wpdb;

		$posts = get_posts( array(
	 		'include'          => $post_ids,
	 		'post_type'        => 'any',
	 		'post_status'      => 'any',
	 		'suppress_filters' => true ) );

		$postmetas = $wpdb->get_results( 
			"SELECT * FROM $wpdb->postmeta WHERE post_id IN ( " . implode( ',', wp_parse_id_list( $post_ids ) ) . " )", OBJECT 
		);

		return array(
			'posts' => $posts,
			'postmetas' => $postmetas
		);
	}

	private function enqueue_all_comments() {
		$this->set_status("comments", 0);

		global $wpdb;

		$comment_ids = $wpdb->get_col( "SELECT comment_id FROM $wpdb->comments");
		$chunked_comment_ids = array_chunk( $comment_ids, self::$array_chunk_size );

		$counter = 0;
		$total = count( $chunked_comment_ids );

		foreach ( $chunked_comment_ids as $chunk ) {
			$this->set_status( "comments", ( $counter / $total ) * 100 );
			do_action( 'jetpack_full_sync_comments', $chunk);
			$counter += 1;
		}

		$this->set_status("comments", 100);
	}

	public function expand_comment_ids( $args ) {
		$comment_ids = $args[0];
		return get_comments( array(
	 		'include_unapproved' => true,
	 		'comment__in' => $comment_ids,
 		) );
	}

	// TODO:

	private function enqueue_all_theme_info() {
		$this->set_status("themes", 0);
		$this->client->send_theme_info();
		$this->set_status("themes", 100);
	}

	private function enqueue_all_updates() {
		$this->set_status("updates", 0);
		// check for updates
		wp_update_plugins();
		wp_update_themes();
		_maybe_update_core();
		$this->set_status("updates", 100);
	}
	
	private function set_status( $name, $percent, $count = 1, $total =1 ) {

		set_transient( self::$status_transient_name.'_'.$name, 
			array( 
				'progress' => $percent, 
				// 'count' => $count, 
				// 'total' => $total 
			),
			self::$transient_timeout
		);
	}

	private function set_status_queuing_started() {
		set_transient( self::$status_transient_name, array( 'phase' => 'queuing started' ), self::$transient_timeout );
	}

	private function set_status_queuing_finished() {
		set_transient( self::$status_transient_name, array( 'phase' => 'queuing finished' ), self::$transient_timeout );
	}

	// these are called by the Sync Client when it sees that the full sync start/end actions have actually been transmitted
	public function set_status_sending_started() {
		set_transient( self::$status_transient_name, array( 'phase' => 'sending started' ), self::$transient_timeout );
	}

	public function set_status_sending_finished() {
		set_transient( self::$status_transient_name, array( 'phase' => 'sending finished' ), self::$transient_timeout );
	}

	public function get_status() {
		return get_transient( self::$status_transient_name );
	}

	public function get_module_status( $module ) {
		return get_transient( self::$status_transient_name.'_'.$module );
	}

	public function get_complete_status() {
		return array_merge( 
			$this->get_status(),
			array_combine( 
				Jetpack_Sync_Full::$modules, 
				array_map( array( $this, 'get_module_status' ), Jetpack_Sync_Full::$modules )
			)
		);
	}
}

1		<?php
2
3		/**
4		* This class does a full resync of the database by
5		* enqueuing an outbound action for every single object
6		* that we care about.
7		*
8		* This class contains a few non-obvious optimisations that should be explained:
9		* - we fire an action called jetpack_full_sync_start so that WPCOM can erase the contents of the cached database
10		* - for each object type, we obtain a full list of object IDs to sync via a single API call (hoping that since they're ints, they can all fit in RAM)
11		* - we load the full objects for those IDs in chunks of Jetpack_Sync_Full::$array_chunk_size (to reduce the number of MySQL calls)
12		* - we fire a trigger for the entire array which the Jetpack_Sync_Client then serializes and queues.
13		*/
14
15		class Jetpack_Sync_Full {
16		static $array_chunk_size = 5;
		0 ignored issues – show Coding Style introduced 2016-04-20 01:08 UTC by Report Bug Copy Issue Report The visibility should be declared for property `$array_chunk_size`. 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...
17		static $status_transient_name = "jetpack_full_sync_progress";
		0 ignored issues – show Coding Style introduced 2016-04-21 22:18 UTC by Report Bug Copy Issue Report The visibility should be declared for property `$status_transient_name`. 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...
18		static $transient_timeout = 3600; // an hour
		0 ignored issues – show Coding Style introduced 2016-04-21 22:18 UTC by Report Bug Copy Issue Report The visibility should be declared for property `$transient_timeout`. 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...
19		static $modules = array( 'wp_version', 'constants', 'functions', 'options', 'posts', 'comments', 'themes', 'updates' );
		0 ignored issues – show Coding Style introduced 2016-04-21 23:12 UTC by Report Bug Copy Issue Report The visibility should be declared for property `$modules`. 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...
20
21		// singleton functions
22		private static $instance;
23
24		public static function getInstance() {
25		if ( null === self::$instance ) {
26		self::$instance = new self();
27		}
28
29		return self::$instance;
30		}
31
32		protected function __construct() {
33		$this->init();
34		}
35
36		function init() {
37		add_filter( "jetack_sync_before_send_jetpack_full_sync_posts", array( $this, 'expand_post_ids' ) );
38		add_filter( "jetack_sync_before_send_jetpack_full_sync_comments", array( $this, 'expand_comment_ids' ) );
39		}
40
41		function start() {
42		$this->client = Jetpack_Sync_Client::getInstance();
		0 ignored issues – show Bug introduced 2016-04-20 17:56 UTC by Report Bug Copy Issue Report The property `client` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
43		do_action( 'jetpack_full_sync_start' );
44
45		$this->set_status_queuing_started();
46
47		$this->enqueue_wp_version();
48		$this->enqueue_all_constants();
49		$this->enqueue_all_functions();
50		$this->enqueue_all_options();
51		$this->enqueue_all_theme_info();
52		$this->enqueue_all_posts();
53		$this->enqueue_all_comments();
54		$this->enqueue_all_updates();
55
56		$this->set_status_queuing_finished();
57
58		do_action( 'jetpack_full_sync_end' );
59		}
60
61		private function enqueue_wp_version() {
62		$this->set_status("wp_version", 0);
63		global $wp_version;
64		do_action( 'jetpack_sync_wp_version', $wp_version );
65		$this->set_status("wp_version", 100);
66		}
67
68		private function enqueue_all_constants() {
69		$this->set_status("constants", 0);
70		$this->client->force_sync_constants();
71		$this->set_status("constants", 100);
72		}
73
74		private function enqueue_all_functions() {
75		$this->set_status("functions", 0);
76		$this->client->force_sync_callables();
77		$this->set_status("functions", 100);
78		}
79
80		private function enqueue_all_options() {
81		$this->set_status("options", 0);
82		global $wpdb;
83
84		// Unfortunately, since our options whitelist includes regexes,
85		// we need to load all option names and match them against the whitelist.
86		// This could be pretty awful if we have huge queues, but it's the only way to
87		// be sure we're syncing everything that's whitelisted.
88
89		// As per posts and comments, we do this in ID batches and hope the IDs AND names don't exceed RAM
90
91		// In theory, MySQL has regex support. In practice, I wouldn't want to rely on it being compatible
92		// with PHP's regexes.
93
94		// Alternatively, rather than option regexes, we could use wildcards in the option and then just
95		// use "LIKE" queries here, replacing * with %?
96
97		$option_names = $wpdb->get_col( "SELECT option_name FROM $wpdb->options" );
98
99		// filter by client option whitelist
100		$option_names = array_filter( $option_names, array( $this->client, 'is_whitelisted_option' ) );
101
102		$counter = 0;
103		$total = count( $option_names );
104
105		foreach ( $option_names as $option_name ) {
106		$this->set_status( "options", ( $counter / $total ) * 100 );
107		do_action( 'jetpack_full_sync_option', $option_name, get_option( $option_name ) );
108		$counter += 1;
109		}
110
111		$this->set_status("options", 100);
112		}
113
114	View Code Duplication	private function enqueue_all_posts() {
115		$this->set_status("posts", 0);
116		global $wpdb;
117
118		// I hope this is never bigger than RAM...
119		$post_ids = $wpdb->get_col( "SELECT id FROM $wpdb->posts");
120
121		// Request posts in groups of N for efficiency
122		$chunked_post_ids = array_chunk( $post_ids, self::$array_chunk_size );
123
124		$counter = 0;
125		$total = count( $chunked_post_ids );
126
127		// Send each chunk as an array of objects
128		foreach ( $chunked_post_ids as $chunk ) {
129		$this->set_status( "posts", ( $counter / $total ) * 100 );
130		do_action( 'jetpack_full_sync_posts', $chunk );
131		$counter += 1;
132		}
133
134		$this->set_status("posts", 100);
135		}
136
137		public function expand_post_ids( $args ) {
138		$post_ids = $args[0];
139		global $wpdb;
140
141		$posts = get_posts( array(
142		'include' => $post_ids,
143		'post_type' => 'any',
144		'post_status' => 'any',
145		'suppress_filters' => true ) );
146
147		$postmetas = $wpdb->get_results(
148		"SELECT * FROM $wpdb->postmeta WHERE post_id IN ( " . implode( ',', wp_parse_id_list( $post_ids ) ) . " )", OBJECT
149		);
150
151		return array(
152		'posts' => $posts,
153		'postmetas' => $postmetas
154		);
155		}
156
157	View Code Duplication	private function enqueue_all_comments() {
158		$this->set_status("comments", 0);
159
160		global $wpdb;
161
162		$comment_ids = $wpdb->get_col( "SELECT comment_id FROM $wpdb->comments");
163		$chunked_comment_ids = array_chunk( $comment_ids, self::$array_chunk_size );
164
165		$counter = 0;
166		$total = count( $chunked_comment_ids );
167
168		foreach ( $chunked_comment_ids as $chunk ) {
169		$this->set_status( "comments", ( $counter / $total ) * 100 );
170		do_action( 'jetpack_full_sync_comments', $chunk);
171		$counter += 1;
172		}
173
174		$this->set_status("comments", 100);
175		}
176
177		public function expand_comment_ids( $args ) {
178		$comment_ids = $args[0];
179		return get_comments( array(
180		'include_unapproved' => true,
181		'comment__in' => $comment_ids,
182		) );
183		}
184
185		// TODO:
		0 ignored issues – show Coding Style introduced 2016-04-20 20:11 UTC by Report Bug Copy Issue Report Comment refers to a TODO task This check looks `TODO` comments that have been left in the code. ``TODO``s show that something is left unfinished and should be attended to. Loading history...
186		private function enqueue_all_theme_info() {
187		$this->set_status("themes", 0);
188		$this->client->send_theme_info();
189		$this->set_status("themes", 100);
190		}
191
192		private function enqueue_all_updates() {
193		$this->set_status("updates", 0);
194		// check for updates
195		wp_update_plugins();
196		wp_update_themes();
197		_maybe_update_core();
198		$this->set_status("updates", 100);
199		}
200
201		private function set_status( $name, $percent, $count = 1, $total =1 ) {
		0 ignored issues – show Unused Code introduced 2016-04-21 23:12 UTC by Report Bug Copy Issue Report The parameter `$count` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2016-04-21 23:12 UTC by Report Bug Copy Issue Report The parameter `$total` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
202		set_transient( self::$status_transient_name.'_'.$name,
203		array(
204		'progress' => $percent,
205		// 'count' => $count,
206		// 'total' => $total
207		),
208		self::$transient_timeout
209		);
210		}
211
212		private function set_status_queuing_started() {
213		set_transient( self::$status_transient_name, array( 'phase' => 'queuing started' ), self::$transient_timeout );
214		}
215
216		private function set_status_queuing_finished() {
217		set_transient( self::$status_transient_name, array( 'phase' => 'queuing finished' ), self::$transient_timeout );
218		}
219
220		// these are called by the Sync Client when it sees that the full sync start/end actions have actually been transmitted
221		public function set_status_sending_started() {
222		set_transient( self::$status_transient_name, array( 'phase' => 'sending started' ), self::$transient_timeout );
223		}
224
225		public function set_status_sending_finished() {
226		set_transient( self::$status_transient_name, array( 'phase' => 'sending finished' ), self::$transient_timeout );
227		}
228
229		public function get_status() {
230		return get_transient( self::$status_transient_name );
231		}
232
233		public function get_module_status( $module ) {
234		return get_transient( self::$status_transient_name.'_'.$module );
235		}
236
237		public function get_complete_status() {
238		return array_merge(
239		$this->get_status(),
240		array_combine(
241		Jetpack_Sync_Full::$modules,
242		array_map( array( $this, 'get_module_status' ), Jetpack_Sync_Full::$modules )
243		)
244		);
245		}
246		}

Automattic / jetpack

Push — add/sync-rest-2 ( 1dfaae...26bda8 )

Jetpack_Sync_Full::get_status() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like