Jetpack_Sync_Queue - Code Metrics - Inspection of "only remove events processed by the server from th..." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — add/sync-action ( b7b7fe...cfb5f0 )

unknown

created 2016-05-16 14:06 UTC

Jetpack_Sync_Queue C

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	363
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes	10
Bugs	0	Features	3

Metric	Value
c	10
b	0
f	3
dl	0
loc	363
rs	6.1904
wmc	59
lcom	1
cbo	2

25 Methods

Rating	Name	Size	Complexity
A	add()	15	2
A	add_all()	20	3
A	peek()	8	2
A	reset()	7	1
A	size()	7	1
A	has_any_items()	8	1
A	unlock()	3	1
A	get_checkout_id()	3	1
A	delete_checkout_id()	3	1
A	get_checkout_transient_name()	3	1
A	get_next_data_row_option_name()	17	2
A	fetch_items()	16	3
A	__construct()	4	1
A	lag()	20	3
B	checkout()	25	5
B	checkout_with_memory_limit()	53	8
A	checkin()	13	2
A	close()	21	3
A	flush_all()	6	1
A	get_all()	3	1
A	force_checkin()	3	1
C	lock()	27	7
A	set_checkout_id()	3	1
A	fetch_items_by_id()	16	3
A	validate_checkout()	17	4

How to fix Complexity

<?php

/**
 * A buffer of items from the queue that can be checked out
 */
class Jetpack_Sync_Queue_Buffer {
	public $id;
	public $items_with_ids;

	public function __construct( $id, $items_with_ids ) {
		$this->id             = $id;
		$this->items_with_ids = $items_with_ids;
	}

	public function get_items() {
		return array_combine( $this->get_item_ids(), Jetpack_Sync_Utils::get_item_values( $this->items_with_ids ) );
	}

	public function get_item_ids() {
		return Jetpack_Sync_Utils::get_item_ids( $this->items_with_ids );
	}
}

/**
 * A persistent queue that can be flushed in increments of N items,
 * and which blocks reads until checked-out buffers are checked in or
 * closed. This uses raw SQL for two reasons: speed, and not triggering
 * tons of added_option callbacks.
 */
class Jetpack_Sync_Queue {

	public $id;
	private $row_iterator;

	function __construct( $id ) {
		$this->id           = str_replace( '-', '_', $id ); // necessary to ensure we don't have ID collisions in the SQL
		$this->row_iterator = 0;
	}

	function add( $item ) {
		global $wpdb;
		$added = false;
		// this basically tries to add the option until enough time has elapsed that
		// it has a unique (microtime-based) option key
		while ( ! $added ) {
			$rows_added = $wpdb->query( $wpdb->prepare(
				"INSERT INTO $wpdb->options (option_name, option_value,autoload) VALUES (%s, %s,%s)",
				$this->get_next_data_row_option_name(),
				serialize( $item ),
				'no'
			) );
			$added      = ( $rows_added !== 0 );
		}
	}

	// Attempts to insert all the items in a single SQL query. May be subject to query size limits!
	function add_all( $items ) {
		global $wpdb;
		$base_option_name = $this->get_next_data_row_option_name();

		$query = "INSERT INTO $wpdb->options (option_name, option_value,autoload) VALUES ";

		$rows = array();

		for ( $i = 0; $i < count( $items ); $i += 1 ) {
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
			$option_name  = esc_sql( $base_option_name . '-' . $i );
			$option_value = esc_sql( serialize( $items[ $i ] ) );
			$rows[]       = "('$option_name', '$option_value', 'no')";
		}

		$rows_added = $wpdb->query( $query . join( ',', $rows ) );

		if ( $rows_added !== count( $items ) ) {
			return new WP_Error( 'row_count_mismatch', "The number of rows inserted didn't match the size of the input array" );
		}
	}

	// Peek at the front-most item on the queue without checking it out
	function peek( $count = 1 ) {
		$items = $this->fetch_items( $count );
		if ( $items ) {
			return Jetpack_Sync_Utils::get_item_values( $items );
		}

		return array();
	}

	// lag is the difference in time between the age of the oldest item and the current time
	function lag() {
		global $wpdb;

		$last_item_name = $wpdb->get_var( $wpdb->prepare(
			"SELECT option_name FROM $wpdb->options WHERE option_name LIKE %s ORDER BY option_name ASC LIMIT 1",
			"jpsq_{$this->id}-%"
		) );

		if ( ! $last_item_name ) {
			return null;
		}

		// break apart the item name to get the timestamp
		$matches = null;
		if ( preg_match( '/^jpsq_' . $this->id . '-(\d+\.\d+)-/', $last_item_name, $matches ) ) {
			return microtime( true ) - floatval( $matches[1] );
		} else {
			return null;
		}
	}

	function reset() {
		global $wpdb;
		$this->delete_checkout_id();
		$wpdb->query( $wpdb->prepare(
			"DELETE FROM $wpdb->options WHERE option_name LIKE %s", "jpsq_{$this->id}-%"
		) );
	}

	function size() {
		global $wpdb;

		return (int) $wpdb->get_var( $wpdb->prepare(
			"SELECT count(*) FROM $wpdb->options WHERE option_name LIKE %s", "jpsq_{$this->id}-%"
		) );
	}

	// we use this peculiar implementation because it's much faster than count(*)
	function has_any_items() {
		global $wpdb;
		$value = $wpdb->get_var( $wpdb->prepare(
			"SELECT exists( SELECT option_name FROM $wpdb->options WHERE option_name LIKE %s )", "jpsq_{$this->id}-%"
		) );

		return ( $value === "1" );
	}

	function checkout( $buffer_size ) {
		if ( $this->get_checkout_id() ) {
			return new WP_Error( 'unclosed_buffer', 'There is an unclosed buffer' );
		}

		$buffer_id = uniqid();

		$result = $this->set_checkout_id( $buffer_id );

		if ( ! $result || is_wp_error( $result ) ) {
			error_log( "badness setting checkout ID (this should not happen)" );

			return $result;
		}

		$items = $this->fetch_items( $buffer_size );

		if ( count( $items ) === 0 ) {
			return false;
		}

		$buffer = new Jetpack_Sync_Queue_Buffer( $buffer_id, array_slice( $items, 0, $buffer_size ) );

		return $buffer;
	}

	// this checks out rows until it either empties the queue or hits a certain memory limit
	// it loads the sizes from the DB first so that it doesn't accidentally
	// load more data into memory than it needs to.
	// The only way it will load more items than $max_size is if a single queue item 
	// exceeds the memory limit, but in that case it will send that item by itself.
	function checkout_with_memory_limit( $max_memory, $max_buffer_size = 500 ) {
		if ( $this->get_checkout_id() ) {
			return new WP_Error( 'unclosed_buffer', 'There is an unclosed buffer' );
		}

		$buffer_id = uniqid();

		$result = $this->set_checkout_id( $buffer_id );

		if ( ! $result || is_wp_error( $result ) ) {
			error_log( "badness setting checkout ID (this should not happen)" );

			return $result;
		}

		// get the map of buffer_id -> memory_size
		global $wpdb;

		$items_with_size = $wpdb->get_results(
			$wpdb->prepare(
				"SELECT option_name AS id, LENGTH(option_value) AS value_size FROM $wpdb->options WHERE option_name LIKE %s ORDER BY option_name ASC LIMIT %d",
				"jpsq_{$this->id}-%",
				$max_buffer_size
			),
			OBJECT
		);

		$total_memory = 0;
		$item_ids     = array();

		foreach ( $items_with_size as $item_with_size ) {
			$total_memory += $item_with_size->value_size;

			// if this is the first item and it exceeds memory, allow loop to continue
			// we will exit on the next iteration instead
			if ( $total_memory > $max_memory && count( $item_ids ) > 0 ) {
				break;
			}
			$item_ids[] = $item_with_size->id;
		}

		$items = $this->fetch_items_by_id( $item_ids );

		if ( count( $items ) === 0 ) {
			$this->delete_checkout_id();

			return false;
		}

		$buffer = new Jetpack_Sync_Queue_Buffer( $buffer_id, $items );

		return $buffer;
	}

	function checkin( $buffer ) {
		$is_valid = $this->validate_checkout( $buffer );

		if ( is_wp_error( $is_valid ) ) {
			error_log( "Invalid checkin: " . $is_valid->get_error_message() );

			return $is_valid;
		}

		$this->delete_checkout_id();

		return true;
	}

	function close( $buffer, $ids_to_remove ) {
		$is_valid = $this->validate_checkout( $buffer );

		if ( is_wp_error( $is_valid ) ) {
			error_log( "Invalid close: " . $is_valid->get_error_message() );

			return $is_valid;
		}

		$this->delete_checkout_id();

		global $wpdb;

		if ( count( $ids_to_remove ) > 0 ) {
			$sql   = "DELETE FROM $wpdb->options WHERE option_name IN (" . implode( ', ', array_fill( 0, count( $ids_to_remove ), '%s' ) ) . ')';
			$query = call_user_func_array( array( $wpdb, 'prepare' ), array_merge( array( $sql ), $ids_to_remove ) );
			$wpdb->query( $query );
		}

		return true;
	}

	function flush_all() {
		$items = Jetpack_Sync_Utils::get_item_values( $this->fetch_items() );
		$this->reset();

		return $items;
	}

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

	// use with caution, this could allow multiple processes to delete
	// and send from the queue at the same time
	function force_checkin() {
		$this->delete_checkout_id();
	}

	// used to lock checkouts from the queue.
	// tries to wait up to $timeout seconds for the queue to be empty
	function lock( $timeout = 30 ) {
		$tries = 0;

		while ( $this->has_any_items() && $tries < $timeout ) {
			sleep( 1 );
			$tries += 1;
		}

		if ( $tries === 30 ) {
			return new WP_Error( 'lock_timeout', 'Timeout waiting for sync queue to empty' );
		}

		if ( $this->get_checkout_id() ) {
			return new WP_Error( 'unclosed_buffer', 'There is an unclosed buffer' );
		}

		// hopefully this means we can acquire a checkout?
		$result = $this->set_checkout_id( 'lock' );

		if ( ! $result || is_wp_error( $result ) ) {
			error_log( "badness setting checkout ID (this should not happen)" );

			return $result;
		}

		return true;
	}

	function unlock() {
		$this->delete_checkout_id();
	}

	private function get_checkout_id() {
		return get_transient( $this->get_checkout_transient_name() );
	}

	private function set_checkout_id( $checkout_id ) {
		return set_transient( $this->get_checkout_transient_name(), $checkout_id, 5 * 60 ); // 5 minute timeout
	}

	private function delete_checkout_id() {
		delete_transient( $this->get_checkout_transient_name() );
	}

	private function get_checkout_transient_name() {
		return "jpsq_{$this->id}_checkout";
	}

	private function get_next_data_row_option_name() {
		// this option is specifically chosen to, as much as possible, preserve time order
		// and minimise the possibility of collisions between multiple processes working 
		// at the same time
		// TODO: confirm we only need to support PHP 5.05+ (otherwise we'll need to emulate microtime as float, and avoid PHP_INT_MAX)

		// @see: http://php.net/manual/en/function.microtime.php
		$timestamp = sprintf( '%.6f', microtime( true ) );

		// row iterator is used to avoid collisions where we're writing data waaay fast in a single process
		if ( $this->row_iterator === PHP_INT_MAX ) {
			$this->row_iterator = 0;
		} else {
			$this->row_iterator += 1;
		}

		return 'jpsq_' . $this->id . '-' . $timestamp . '-' . getmypid() . '-' . $this->row_iterator;
	}

	private function fetch_items( $limit = null ) {
		global $wpdb;

		if ( $limit ) {
			$query_sql = $wpdb->prepare( "SELECT option_name AS id, option_value AS value FROM $wpdb->options WHERE option_name LIKE %s ORDER BY option_name ASC LIMIT %d", "jpsq_{$this->id}-%", $limit );
		} else {
			$query_sql = $wpdb->prepare( "SELECT option_name AS id, option_value AS value FROM $wpdb->options WHERE option_name LIKE %s ORDER BY option_name ASC", "jpsq_{$this->id}-%" );
		}

		$items = $wpdb->get_results( $query_sql, OBJECT );
		foreach ( $items as $item ) {
			$item->value = maybe_unserialize( $item->value );
		}

		return $items;
	}

	private function fetch_items_by_id( $item_ids ) {
		global $wpdb;

		if ( count( $item_ids ) > 0 ) {
			$sql   = "SELECT option_name AS id, option_value AS value FROM $wpdb->options WHERE option_name IN (" . implode( ', ', array_fill( 0, count( $item_ids ), '%s' ) ) . ') ORDER BY option_name ASC';
			$query = call_user_func_array( array( $wpdb, 'prepare' ), array_merge( array( $sql ), $item_ids ) );
			$items = $wpdb->get_results( $query, OBJECT );
			foreach ( $items as $item ) {
				$item->value = maybe_unserialize( $item->value );
			}

			return $items;
		} else {
			return array();
		}
	}

	private function validate_checkout( $buffer ) {
		if ( ! $buffer instanceof Jetpack_Sync_Queue_Buffer ) {
			return new WP_Error( 'not_a_buffer', 'You must checkin an instance of Jetpack_Sync_Queue_Buffer' );
		}

		$checkout_id = $this->get_checkout_id();

		if ( ! $checkout_id ) {
			return new WP_Error( 'buffer_not_checked_out', 'There are no checked out buffers' );
		}

		if ( $checkout_id != $buffer->id ) {
			return new WP_Error( 'buffer_mismatch', 'The buffer you checked in was not checked out' );
		}

		return true;
	}
}

class Jetpack_Sync_Utils {


	static function get_item_values( $items ) {
		return array_map( array( __CLASS__, 'get_item_value' ), $items );
	}

	static function get_item_ids( $items ) {
		return array_map( array( __CLASS__, 'get_item_id' ), $items );
	}

	static private function get_item_value( $item ) {

		return $item->value;
	}

	static private function get_item_id( $item ) {

		return $item->id;
	}
}


1			<?php
2
3			/**
4			* A buffer of items from the queue that can be checked out
5			*/
6			class Jetpack_Sync_Queue_Buffer {
7			public $id;
8			public $items_with_ids;
9
10			public function __construct( $id, $items_with_ids ) {
11			$this->id = $id;
12			$this->items_with_ids = $items_with_ids;
13			}
14
15			public function get_items() {
16			return array_combine( $this->get_item_ids(), Jetpack_Sync_Utils::get_item_values( $this->items_with_ids ) );
17			}
18
19			public function get_item_ids() {
20			return Jetpack_Sync_Utils::get_item_ids( $this->items_with_ids );
21			}
22			}
23
24			/**
25			* A persistent queue that can be flushed in increments of N items,
26			* and which blocks reads until checked-out buffers are checked in or
27			* closed. This uses raw SQL for two reasons: speed, and not triggering
28			* tons of added_option callbacks.
29			*/
30			class Jetpack_Sync_Queue {
			0 ignored issues – show Coding Style Compatibility introduced 2016-04-14 21:57 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...
31			public $id;
32			private $row_iterator;
33
34			function __construct( $id ) {
35			$this->id = str_replace( '-', '_', $id ); // necessary to ensure we don't have ID collisions in the SQL
36			$this->row_iterator = 0;
37			}
38
39			function add( $item ) {
40			global $wpdb;
41			$added = false;
42			// this basically tries to add the option until enough time has elapsed that
43			// it has a unique (microtime-based) option key
44			while ( ! $added ) {
45			$rows_added = $wpdb->query( $wpdb->prepare(
46			"INSERT INTO $wpdb->options (option_name, option_value,autoload) VALUES (%s, %s,%s)",
47			$this->get_next_data_row_option_name(),
48			serialize( $item ),
49			'no'
50			) );
51			$added = ( $rows_added !== 0 );
52			}
53			}
54
55			// Attempts to insert all the items in a single SQL query. May be subject to query size limits!
56			function add_all( $items ) {
57			global $wpdb;
58			$base_option_name = $this->get_next_data_row_option_name();
59
60			$query = "INSERT INTO $wpdb->options (option_name, option_value,autoload) VALUES ";
61
62			$rows = array();
63
64			for ( $i = 0; $i < count( $items ); $i += 1 ) {
			0 ignored issues – show Performance Best Practice introduced 2016-04-17 19:11 UTC by Report Bug Copy Issue Report It seems like you are calling the size function `count()` as part of the test condition. You might want to compute the size beforehand, and not on each iteration. If the size of the collection does not change during the iteration, it is generally a good practice to compute it beforehand, and not on each iteration: for ($i=0; $i<count($array); $i++) { // calls count() on each iteration } // Better for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once } Loading history...
65			$option_name = esc_sql( $base_option_name . '-' . $i );
66			$option_value = esc_sql( serialize( $items[ $i ] ) );
67			$rows[] = "('$option_name', '$option_value', 'no')";
68			}
69
70			$rows_added = $wpdb->query( $query . join( ',', $rows ) );
71
72			if ( $rows_added !== count( $items ) ) {
73			return new WP_Error( 'row_count_mismatch', "The number of rows inserted didn't match the size of the input array" );
74			}
75			}
76
77			// Peek at the front-most item on the queue without checking it out
78			function peek( $count = 1 ) {
79			$items = $this->fetch_items( $count );
80			if ( $items ) {
81			return Jetpack_Sync_Utils::get_item_values( $items );
82			}
83
84			return array();
85			}
86
87			// lag is the difference in time between the age of the oldest item and the current time
88			function lag() {
89			global $wpdb;
90
91			$last_item_name = $wpdb->get_var( $wpdb->prepare(
92			"SELECT option_name FROM $wpdb->options WHERE option_name LIKE %s ORDER BY option_name ASC LIMIT 1",
93			"jpsq_{$this->id}-%"
94			) );
95
96			if ( ! $last_item_name ) {
97			return null;
98			}
99
100			// break apart the item name to get the timestamp
101			$matches = null;
102			if ( preg_match( '/^jpsq_' . $this->id . '-(\d+\.\d+)-/', $last_item_name, $matches ) ) {
103			return microtime( true ) - floatval( $matches[1] );
104			} else {
105			return null;
106			}
107			}
108
109			function reset() {
110			global $wpdb;
111			$this->delete_checkout_id();
112			$wpdb->query( $wpdb->prepare(
113			"DELETE FROM $wpdb->options WHERE option_name LIKE %s", "jpsq_{$this->id}-%"
114			) );
115			}
116
117			function size() {
118			global $wpdb;
119
120			return (int) $wpdb->get_var( $wpdb->prepare(
121			"SELECT count(*) FROM $wpdb->options WHERE option_name LIKE %s", "jpsq_{$this->id}-%"
122			) );
123			}
124
125			// we use this peculiar implementation because it's much faster than count(*)
126			function has_any_items() {
127			global $wpdb;
128			$value = $wpdb->get_var( $wpdb->prepare(
129			"SELECT exists( SELECT option_name FROM $wpdb->options WHERE option_name LIKE %s )", "jpsq_{$this->id}-%"
130			) );
131
132			return ( $value === "1" );
133			}
134
135			function checkout( $buffer_size ) {
136			if ( $this->get_checkout_id() ) {
137			return new WP_Error( 'unclosed_buffer', 'There is an unclosed buffer' );
138			}
139
140			$buffer_id = uniqid();
141
142			$result = $this->set_checkout_id( $buffer_id );
143
144			if ( ! $result \|\| is_wp_error( $result ) ) {
145			error_log( "badness setting checkout ID (this should not happen)" );
146
147			return $result;
148			}
149
150			$items = $this->fetch_items( $buffer_size );
151
152			if ( count( $items ) === 0 ) {
153			return false;
154			}
155
156			$buffer = new Jetpack_Sync_Queue_Buffer( $buffer_id, array_slice( $items, 0, $buffer_size ) );
157
158			return $buffer;
159			}
160
161			// this checks out rows until it either empties the queue or hits a certain memory limit
162			// it loads the sizes from the DB first so that it doesn't accidentally
163			// load more data into memory than it needs to.
164			// The only way it will load more items than $max_size is if a single queue item
165			// exceeds the memory limit, but in that case it will send that item by itself.
166			function checkout_with_memory_limit( $max_memory, $max_buffer_size = 500 ) {
167			if ( $this->get_checkout_id() ) {
168			return new WP_Error( 'unclosed_buffer', 'There is an unclosed buffer' );
169			}
170
171			$buffer_id = uniqid();
172
173			$result = $this->set_checkout_id( $buffer_id );
174
175			if ( ! $result \|\| is_wp_error( $result ) ) {
176			error_log( "badness setting checkout ID (this should not happen)" );
177
178			return $result;
179			}
180
181			// get the map of buffer_id -> memory_size
182			global $wpdb;
183
184			$items_with_size = $wpdb->get_results(
185			$wpdb->prepare(
186			"SELECT option_name AS id, LENGTH(option_value) AS value_size FROM $wpdb->options WHERE option_name LIKE %s ORDER BY option_name ASC LIMIT %d",
187			"jpsq_{$this->id}-%",
188			$max_buffer_size
189			),
190			OBJECT
191			);
192
193			$total_memory = 0;
194			$item_ids = array();
195
196			foreach ( $items_with_size as $item_with_size ) {
197			$total_memory += $item_with_size->value_size;
198
199			// if this is the first item and it exceeds memory, allow loop to continue
200			// we will exit on the next iteration instead
201			if ( $total_memory > $max_memory && count( $item_ids ) > 0 ) {
202			break;
203			}
204			$item_ids[] = $item_with_size->id;
205			}
206
207			$items = $this->fetch_items_by_id( $item_ids );
208
209			if ( count( $items ) === 0 ) {
210			$this->delete_checkout_id();
211
212			return false;
213			}
214
215			$buffer = new Jetpack_Sync_Queue_Buffer( $buffer_id, $items );
216
217			return $buffer;
218			}
219
220			function checkin( $buffer ) {
221			$is_valid = $this->validate_checkout( $buffer );
222
223			if ( is_wp_error( $is_valid ) ) {
224			error_log( "Invalid checkin: " . $is_valid->get_error_message() );
225
226			return $is_valid;
227			}
228
229			$this->delete_checkout_id();
230
231			return true;
232			}
233
234			function close( $buffer, $ids_to_remove ) {
235			$is_valid = $this->validate_checkout( $buffer );
236
237			if ( is_wp_error( $is_valid ) ) {
238			error_log( "Invalid close: " . $is_valid->get_error_message() );
239
240			return $is_valid;
241			}
242
243			$this->delete_checkout_id();
244
245			global $wpdb;
246
247			if ( count( $ids_to_remove ) > 0 ) {
248			$sql = "DELETE FROM $wpdb->options WHERE option_name IN (" . implode( ', ', array_fill( 0, count( $ids_to_remove ), '%s' ) ) . ')';
249			$query = call_user_func_array( array( $wpdb, 'prepare' ), array_merge( array( $sql ), $ids_to_remove ) );
250			$wpdb->query( $query );
251			}
252
253			return true;
254			}
255
256			function flush_all() {
257			$items = Jetpack_Sync_Utils::get_item_values( $this->fetch_items() );
258			$this->reset();
259
260			return $items;
261			}
262
263			function get_all() {
264			return $this->fetch_items();
265			}
266
267			// use with caution, this could allow multiple processes to delete
268			// and send from the queue at the same time
269			function force_checkin() {
270			$this->delete_checkout_id();
271			}
272
273			// used to lock checkouts from the queue.
274			// tries to wait up to $timeout seconds for the queue to be empty
275			function lock( $timeout = 30 ) {
276			$tries = 0;
277
278			while ( $this->has_any_items() && $tries < $timeout ) {
279			sleep( 1 );
280			$tries += 1;
281			}
282
283			if ( $tries === 30 ) {
284			return new WP_Error( 'lock_timeout', 'Timeout waiting for sync queue to empty' );
285			}
286
287			if ( $this->get_checkout_id() ) {
288			return new WP_Error( 'unclosed_buffer', 'There is an unclosed buffer' );
289			}
290
291			// hopefully this means we can acquire a checkout?
292			$result = $this->set_checkout_id( 'lock' );
293
294			if ( ! $result \|\| is_wp_error( $result ) ) {
295			error_log( "badness setting checkout ID (this should not happen)" );
296
297			return $result;
298			}
299
300			return true;
301			}
302
303			function unlock() {
304			$this->delete_checkout_id();
305			}
306
307			private function get_checkout_id() {
308			return get_transient( $this->get_checkout_transient_name() );
309			}
310
311			private function set_checkout_id( $checkout_id ) {
312			return set_transient( $this->get_checkout_transient_name(), $checkout_id, 5 * 60 ); // 5 minute timeout
313			}
314
315			private function delete_checkout_id() {
316			delete_transient( $this->get_checkout_transient_name() );
317			}
318
319			private function get_checkout_transient_name() {
320			return "jpsq_{$this->id}_checkout";
321			}
322
323			private function get_next_data_row_option_name() {
324			// this option is specifically chosen to, as much as possible, preserve time order
325			// and minimise the possibility of collisions between multiple processes working
326			// at the same time
327			// TODO: confirm we only need to support PHP 5.05+ (otherwise we'll need to emulate microtime as float, and avoid PHP_INT_MAX)
			0 ignored issues – show Coding Style Best Practice introduced 2016-04-19 19:44 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...
328			// @see: http://php.net/manual/en/function.microtime.php
329			$timestamp = sprintf( '%.6f', microtime( true ) );
330
331			// row iterator is used to avoid collisions where we're writing data waaay fast in a single process
332			if ( $this->row_iterator === PHP_INT_MAX ) {
333			$this->row_iterator = 0;
334			} else {
335			$this->row_iterator += 1;
336			}
337
338			return 'jpsq_' . $this->id . '-' . $timestamp . '-' . getmypid() . '-' . $this->row_iterator;
339			}
340
341			private function fetch_items( $limit = null ) {
342			global $wpdb;
343
344			if ( $limit ) {
345			$query_sql = $wpdb->prepare( "SELECT option_name AS id, option_value AS value FROM $wpdb->options WHERE option_name LIKE %s ORDER BY option_name ASC LIMIT %d", "jpsq_{$this->id}-%", $limit );
346			} else {
347			$query_sql = $wpdb->prepare( "SELECT option_name AS id, option_value AS value FROM $wpdb->options WHERE option_name LIKE %s ORDER BY option_name ASC", "jpsq_{$this->id}-%" );
348			}
349
350			$items = $wpdb->get_results( $query_sql, OBJECT );
351			foreach ( $items as $item ) {
352			$item->value = maybe_unserialize( $item->value );
353			}
354
355			return $items;
356			}
357
358			private function fetch_items_by_id( $item_ids ) {
359			global $wpdb;
360
361			if ( count( $item_ids ) > 0 ) {
362			$sql = "SELECT option_name AS id, option_value AS value FROM $wpdb->options WHERE option_name IN (" . implode( ', ', array_fill( 0, count( $item_ids ), '%s' ) ) . ') ORDER BY option_name ASC';
363			$query = call_user_func_array( array( $wpdb, 'prepare' ), array_merge( array( $sql ), $item_ids ) );
364			$items = $wpdb->get_results( $query, OBJECT );
365			foreach ( $items as $item ) {
366			$item->value = maybe_unserialize( $item->value );
367			}
368
369			return $items;
370			} else {
371			return array();
372			}
373			}
374
375			private function validate_checkout( $buffer ) {
376			if ( ! $buffer instanceof Jetpack_Sync_Queue_Buffer ) {
377			return new WP_Error( 'not_a_buffer', 'You must checkin an instance of Jetpack_Sync_Queue_Buffer' );
378			}
379
380			$checkout_id = $this->get_checkout_id();
381
382			if ( ! $checkout_id ) {
383			return new WP_Error( 'buffer_not_checked_out', 'There are no checked out buffers' );
384			}
385
386			if ( $checkout_id != $buffer->id ) {
387			return new WP_Error( 'buffer_mismatch', 'The buffer you checked in was not checked out' );
388			}
389
390			return true;
391			}
392			}
393
394			class Jetpack_Sync_Utils {
			0 ignored issues – show Coding Style Compatibility introduced 2016-04-19 21:52 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...
395
396			static function get_item_values( $items ) {
397			return array_map( array( __CLASS__, 'get_item_value' ), $items );
398			}
399
400			static function get_item_ids( $items ) {
401			return array_map( array( __CLASS__, 'get_item_id' ), $items );
402			}
403
404			static private function get_item_value( $item ) {
			0 ignored issues – show Coding Style introduced 2016-04-19 21:52 UTC by Report Bug Copy Issue Report As per PSR2, the `static` declaration should come after the visibility declaration. Loading history...
405			return $item->value;
406			}
407
408			static private function get_item_id( $item ) {
			0 ignored issues – show Coding Style introduced 2016-04-19 21:52 UTC by Report Bug Copy Issue Report As per PSR2, the `static` declaration should come after the visibility declaration. Loading history...
409			return $item->id;
410			}
411			}
412

Automattic / jetpack

Push — add/sync-action ( b7b7fe...cfb5f0 )

Jetpack_Sync_Queue C

Complexity

Size/Duplication

Coupling/Cohesion

Importance

25 Methods

How to fix Complexity

Complex Class

Duplication Side-by-Side

Filter issues like