Jetpack_JSON_API_Sync_Now_Endpoint::result() - Code Metrics - Inspection of "Merge pull request #5039 from Automattic/add/sync-..." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — branch-4.2 ( b191b2...26e77e )

unknown

created 2016-09-01 18:21 UTC

Jetpack_JSON_API_Sync_Now_Endpoint::result() A

↳ Parent: Jetpack_JSON_API_Sync_Now_Endpoint

Complexity

Conditions	3
Paths	3

Size

Total Lines	22
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
cc	3
eloc	12
c	1
b	0
f	1
nc	3
nop	0
dl	0
loc	22
rs	9.2

<?php

// POST /sites/%s/sync
class Jetpack_JSON_API_Sync_Endpoint extends Jetpack_JSON_API_Endpoint {
	protected $needed_capabilities = 'manage_options';

	protected function validate_call( $_blog_id, $capability, $check_manage_active = true ) {
		parent::validate_call( $_blog_id, $capability, false );
	}

	protected function result() {
		$args = $this->input();

		$modules = null;

		// convert list of modules in comma-delimited format into an array
		// of "$modulename => true"
		if ( isset( $args['modules'] ) && ! empty( $args['modules'] ) ) {
			$modules = array_map( '__return_true', array_flip( array_map( 'trim', explode( ',', $args['modules'] ) ) ) );
		}

		foreach ( array( 'posts', 'comments', 'users' ) as $module_name ) {
			if ( 'users' === $module_name && isset( $args[ $module_name ] ) && 'initial' === $args[ $module_name ] ) {
				$modules[ 'users' ] = 'initial';
			} elseif ( isset( $args[ $module_name ] ) ) {
				$ids = explode( ',', $args[ $module_name ] );
				if ( count( $ids ) > 0 ) {
					$modules[ $module_name ] = $ids;
				}
			}
		}

		if ( empty( $modules ) ) {
			$modules = null;
		}

		return array( 'scheduled' => Jetpack_Sync_Actions::schedule_full_sync( $modules ) );
	}
}

// GET /sites/%s/sync/status
class Jetpack_JSON_API_Sync_Status_Endpoint extends Jetpack_JSON_API_Sync_Endpoint {

	protected function result() {
		require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-modules.php';
		require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-sender.php';

		$sync_module = Jetpack_Sync_Modules::get_module( 'full-sync' );
		$sender      = Jetpack_Sync_Sender::get_instance();
		$queue       = $sender->get_sync_queue();
		$full_queue  = $sender->get_full_sync_queue();

		return array_merge(
			$sync_module->get_status(),
			array(
				'is_scheduled'    => Jetpack_Sync_Actions::is_scheduled_full_sync(),
				'queue_size'      => $queue->size(),
				'queue_lag'       => $queue->lag(),
				'full_queue_size' => $full_queue->size(),
				'full_queue_lag'  => $full_queue->lag()
			)
		);
	}
}

// GET /sites/%s/data-check
class Jetpack_JSON_API_Sync_Check_Endpoint extends Jetpack_JSON_API_Sync_Endpoint {

	protected function result() {
		require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-sender.php';

		$sender     = Jetpack_Sync_Sender::get_instance();
		$sync_queue = $sender->get_sync_queue();

		// lock sending from the queue while we compare checksums with the server
		$result = $sync_queue->lock( 30 ); // tries to acquire the lock for up to 30 seconds

		if ( ! $result ) {
			$sync_queue->unlock();

			return new WP_Error( 'unknown_error', 'Unknown error trying to lock the sync queue' );
		}

		if ( is_wp_error( $result ) ) {
			$sync_queue->unlock();

			return $result;
		}

		require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-wp-replicastore.php';

		$store = new Jetpack_Sync_WP_Replicastore();

		$result = $store->checksum_all();

		$sync_queue->unlock();

		return $result;

	}
}

// GET /sites/%s/data-histogram
class Jetpack_JSON_API_Sync_Histogram_Endpoint extends Jetpack_JSON_API_Sync_Endpoint {

	protected function result() {
		require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-sender.php';

		$sender     = Jetpack_Sync_Sender::get_instance();
		$sync_queue = $sender->get_sync_queue();

		// lock sending from the queue while we compare checksums with the server
		$result = $sync_queue->lock( 30 ); // tries to acquire the lock for up to 30 seconds

		if ( ! $result ) {
			$sync_queue->unlock();

			return new WP_Error( 'unknown_error', 'Unknown error trying to lock the sync queue' );
		}

		if ( is_wp_error( $result ) ) {
			$sync_queue->unlock();

			return $result;
		}

		$args = $this->query_args();

		if ( isset( $args['columns'] ) ) {
			$columns = array_map( 'trim', explode( ',', $args['columns'] ) );
		} else {
			$columns = null; // go with defaults
		}

		require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-wp-replicastore.php';

		$store = new Jetpack_Sync_WP_Replicastore();

		$result = $store->checksum_histogram( $args['object_type'], $args['buckets'], $args['start_id'], $args['end_id'], $columns );

		$sync_queue->unlock();

		return $result;

	}
}

// POST /sites/%s/sync/settings
class Jetpack_JSON_API_Sync_Modify_Settings_Endpoint extends Jetpack_JSON_API_Sync_Endpoint {

	protected function result() {
		$args = $this->input();

		require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-settings.php';

		$sync_settings = Jetpack_Sync_Settings::get_settings();

		foreach ( $args as $key => $value ) {
			if ( $value !== false ) {
				if ( is_numeric( $value ) ) {
					$value = (int) $value;
				}
				
				// special case for sending empty arrays - a string with value 'empty'
				if ( $value === 'empty' ) {
					$value = array();
				}

				$sync_settings[ $key ] = $value;
			}
		}

		Jetpack_Sync_Settings::update_settings( $sync_settings );

		// re-fetch so we see what's really being stored
		return Jetpack_Sync_Settings::get_settings();
	}
}

// GET /sites/%s/sync/settings
class Jetpack_JSON_API_Sync_Get_Settings_Endpoint extends Jetpack_JSON_API_Sync_Endpoint {

	protected function result() {
		require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-settings.php';

		return Jetpack_Sync_Settings::get_settings();
	}
}

// GET /sites/%s/sync-object
class Jetpack_JSON_API_Sync_Object extends Jetpack_JSON_API_Sync_Endpoint {

	protected function result() {
		$args = $this->query_args();

		$module_name = $args['module_name'];

		require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-modules.php';

		if ( ! $sync_module = Jetpack_Sync_Modules::get_module( $module_name ) ) {
			return new WP_Error( 'invalid_module', 'You specified an invalid sync module' );
		}

		$object_type = $args['object_type'];
		$object_id   = $args['object_id'];

		require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-sender.php';
		$codec = Jetpack_Sync_Sender::get_instance()->get_codec();

		return array(
			'object' => $codec->encode( $sync_module->get_object_by_id( $object_type, $object_id ) )
		);
	}
}

class Jetpack_JSON_API_Sync_Now_Endpoint extends Jetpack_JSON_API_Sync_Endpoint {

	protected function result() {
		$args = $this->input();

		if ( ! isset( $args['queue'] ) ) {
			return new WP_Error( 'invalid_queue', 'Queue name is required', 400 );
		}

		if ( ! in_array( $args['queue'], array( 'sync', 'full_sync' ) ) ) {
			return new WP_Error( 'invalid_queue', 'Queue name should be sync or full_sync', 400 );
		}

		$queue_name = $args['queue'];

		require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-sender.php';

		$sender = Jetpack_Sync_Sender::get_instance();
		$response = $sender->do_sync_for_queue( new Jetpack_Sync_Queue( $queue_name ) );

		return array(
			'response' => $response
		);
	}
}


1			<?php
2
3			// POST /sites/%s/sync
4			class Jetpack_JSON_API_Sync_Endpoint extends Jetpack_JSON_API_Endpoint {
5			protected $needed_capabilities = 'manage_options';
6
7			protected function validate_call( $_blog_id, $capability, $check_manage_active = true ) {
8			parent::validate_call( $_blog_id, $capability, false );
9			}
10
11			protected function result() {
12			$args = $this->input();
13
14			$modules = null;
15
16			// convert list of modules in comma-delimited format into an array
17			// of "$modulename => true"
18			if ( isset( $args['modules'] ) && ! empty( $args['modules'] ) ) {
19			$modules = array_map( '__return_true', array_flip( array_map( 'trim', explode( ',', $args['modules'] ) ) ) );
20			}
21
22			foreach ( array( 'posts', 'comments', 'users' ) as $module_name ) {
23			if ( 'users' === $module_name && isset( $args[ $module_name ] ) && 'initial' === $args[ $module_name ] ) {
24			$modules[ 'users' ] = 'initial';
25			} elseif ( isset( $args[ $module_name ] ) ) {
26			$ids = explode( ',', $args[ $module_name ] );
27			if ( count( $ids ) > 0 ) {
28			$modules[ $module_name ] = $ids;
29			}
30			}
31			}
32
33			if ( empty( $modules ) ) {
34			$modules = null;
35			}
36
37			return array( 'scheduled' => Jetpack_Sync_Actions::schedule_full_sync( $modules ) );
38			}
39			}
40
41			// GET /sites/%s/sync/status
42			class Jetpack_JSON_API_Sync_Status_Endpoint extends Jetpack_JSON_API_Sync_Endpoint {
			0 ignored issues – show Coding Style Compatibility introduced 2016-06-15 20:23 UTC by Report Bug Copy Issue Report PSR1 recommends that each class should be in its own file to aid autoloaders. Having each class in a dedicated file usually plays nice with PSR autoloaders and is therefore a well established practice. If you use other autoloaders, you might not want to follow this rule. Loading history...
43			protected function result() {
44			require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-modules.php';
45			require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-sender.php';
46
47			$sync_module = Jetpack_Sync_Modules::get_module( 'full-sync' );
48			$sender = Jetpack_Sync_Sender::get_instance();
49			$queue = $sender->get_sync_queue();
50			$full_queue = $sender->get_full_sync_queue();
51
52			return array_merge(
53			$sync_module->get_status(),
54			array(
55			'is_scheduled' => Jetpack_Sync_Actions::is_scheduled_full_sync(),
56			'queue_size' => $queue->size(),
57			'queue_lag' => $queue->lag(),
58			'full_queue_size' => $full_queue->size(),
59			'full_queue_lag' => $full_queue->lag()
60			)
61			);
62			}
63			}
64
65			// GET /sites/%s/data-check
66			class Jetpack_JSON_API_Sync_Check_Endpoint extends Jetpack_JSON_API_Sync_Endpoint {
			0 ignored issues – show Coding Style Compatibility introduced 2016-05-04 18:05 UTC by Report Bug Copy Issue Report PSR1 recommends that each class should be in its own file to aid autoloaders. Having each class in a dedicated file usually plays nice with PSR autoloaders and is therefore a well established practice. If you use other autoloaders, you might not want to follow this rule. Loading history...
67			protected function result() {
68			require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-sender.php';
69
70			$sender = Jetpack_Sync_Sender::get_instance();
71			$sync_queue = $sender->get_sync_queue();
72
73			// lock sending from the queue while we compare checksums with the server
74			$result = $sync_queue->lock( 30 ); // tries to acquire the lock for up to 30 seconds
75
76			if ( ! $result ) {
77			$sync_queue->unlock();
78
79			return new WP_Error( 'unknown_error', 'Unknown error trying to lock the sync queue' );
80			}
81
82			if ( is_wp_error( $result ) ) {
83			$sync_queue->unlock();
84
85			return $result;
86			}
87
88			require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-wp-replicastore.php';
89
90			$store = new Jetpack_Sync_WP_Replicastore();
91
92			$result = $store->checksum_all();
93
94			$sync_queue->unlock();
95
96			return $result;
97
98			}
99			}
100
101			// GET /sites/%s/data-histogram
102			class Jetpack_JSON_API_Sync_Histogram_Endpoint extends Jetpack_JSON_API_Sync_Endpoint {
			0 ignored issues – show Coding Style Compatibility introduced 2016-07-12 23:29 UTC by Report Bug Copy Issue Report PSR1 recommends that each class should be in its own file to aid autoloaders. Having each class in a dedicated file usually plays nice with PSR autoloaders and is therefore a well established practice. If you use other autoloaders, you might not want to follow this rule. Loading history...
103			protected function result() {
104			require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-sender.php';
105
106			$sender = Jetpack_Sync_Sender::get_instance();
107			$sync_queue = $sender->get_sync_queue();
108
109			// lock sending from the queue while we compare checksums with the server
110			$result = $sync_queue->lock( 30 ); // tries to acquire the lock for up to 30 seconds
111
112			if ( ! $result ) {
113			$sync_queue->unlock();
114
115			return new WP_Error( 'unknown_error', 'Unknown error trying to lock the sync queue' );
116			}
117
118			if ( is_wp_error( $result ) ) {
119			$sync_queue->unlock();
120
121			return $result;
122			}
123
124			$args = $this->query_args();
125
126			if ( isset( $args['columns'] ) ) {
127			$columns = array_map( 'trim', explode( ',', $args['columns'] ) );
128			} else {
129			$columns = null; // go with defaults
130			}
131
132			require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-wp-replicastore.php';
133
134			$store = new Jetpack_Sync_WP_Replicastore();
135
136			$result = $store->checksum_histogram( $args['object_type'], $args['buckets'], $args['start_id'], $args['end_id'], $columns );
137
138			$sync_queue->unlock();
139
140			return $result;
141
142			}
143			}
144
145			// POST /sites/%s/sync/settings
146			class Jetpack_JSON_API_Sync_Modify_Settings_Endpoint extends Jetpack_JSON_API_Sync_Endpoint {
			0 ignored issues – show Coding Style Compatibility introduced 2016-06-01 04:54 UTC by Report Bug Copy Issue Report PSR1 recommends that each class should be in its own file to aid autoloaders. Having each class in a dedicated file usually plays nice with PSR autoloaders and is therefore a well established practice. If you use other autoloaders, you might not want to follow this rule. Loading history...
147			protected function result() {
148			$args = $this->input();
149
150			require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-settings.php';
151
152			$sync_settings = Jetpack_Sync_Settings::get_settings();
153
154			foreach ( $args as $key => $value ) {
155			if ( $value !== false ) {
156			if ( is_numeric( $value ) ) {
157			$value = (int) $value;
158			}
159
160			// special case for sending empty arrays - a string with value 'empty'
161			if ( $value === 'empty' ) {
162			$value = array();
163			}
164
165			$sync_settings[ $key ] = $value;
166			}
167			}
168
169			Jetpack_Sync_Settings::update_settings( $sync_settings );
170
171			// re-fetch so we see what's really being stored
172			return Jetpack_Sync_Settings::get_settings();
173			}
174			}
175
176			// GET /sites/%s/sync/settings
177			class Jetpack_JSON_API_Sync_Get_Settings_Endpoint extends Jetpack_JSON_API_Sync_Endpoint {
			0 ignored issues – show Coding Style Compatibility introduced 2016-06-01 04:54 UTC by Report Bug Copy Issue Report PSR1 recommends that each class should be in its own file to aid autoloaders. Having each class in a dedicated file usually plays nice with PSR autoloaders and is therefore a well established practice. If you use other autoloaders, you might not want to follow this rule. Loading history...
178			protected function result() {
179			require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-settings.php';
180
181			return Jetpack_Sync_Settings::get_settings();
182			}
183			}
184
185			// GET /sites/%s/sync-object
186			class Jetpack_JSON_API_Sync_Object extends Jetpack_JSON_API_Sync_Endpoint {
			0 ignored issues – show Coding Style Compatibility introduced 2016-08-28 19:16 UTC by Report Bug Copy Issue Report PSR1 recommends that each class should be in its own file to aid autoloaders. Having each class in a dedicated file usually plays nice with PSR autoloaders and is therefore a well established practice. If you use other autoloaders, you might not want to follow this rule. Loading history...
187			protected function result() {
188			$args = $this->query_args();
189
190			$module_name = $args['module_name'];
191
192			require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-modules.php';
193
194			if ( ! $sync_module = Jetpack_Sync_Modules::get_module( $module_name ) ) {
195			return new WP_Error( 'invalid_module', 'You specified an invalid sync module' );
196			}
197
198			$object_type = $args['object_type'];
199			$object_id = $args['object_id'];
200
201			require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-sender.php';
202			$codec = Jetpack_Sync_Sender::get_instance()->get_codec();
203
204			return array(
205			'object' => $codec->encode( $sync_module->get_object_by_id( $object_type, $object_id ) )
206			);
207			}
208			}
209
210			class Jetpack_JSON_API_Sync_Now_Endpoint extends Jetpack_JSON_API_Sync_Endpoint {
			0 ignored issues – show Coding Style Compatibility introduced 2016-08-31 02:04 UTC by Report Bug Copy Issue Report PSR1 recommends that each class should be in its own file to aid autoloaders. Having each class in a dedicated file usually plays nice with PSR autoloaders and is therefore a well established practice. If you use other autoloaders, you might not want to follow this rule. Loading history...
211			protected function result() {
212			$args = $this->input();
213
214			if ( ! isset( $args['queue'] ) ) {
215			return new WP_Error( 'invalid_queue', 'Queue name is required', 400 );
216			}
217
218			if ( ! in_array( $args['queue'], array( 'sync', 'full_sync' ) ) ) {
219			return new WP_Error( 'invalid_queue', 'Queue name should be sync or full_sync', 400 );
220			}
221
222			$queue_name = $args['queue'];
223
224			require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-sender.php';
225
226			$sender = Jetpack_Sync_Sender::get_instance();
227			$response = $sender->do_sync_for_queue( new Jetpack_Sync_Queue( $queue_name ) );
228
229			return array(
230			'response' => $response
231			);
232			}
233			}
234

Automattic / jetpack

Push — branch-4.2 ( b191b2...26e77e )

Jetpack_JSON_API_Sync_Now_Endpoint::result() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like