Completed
Push — fix/plugins-callables ( bbafbf...95f8d0 )
by
unknown
09:00
created

Jetpack_Sync_Sender::init()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 7
Code Lines 5

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 2
eloc 5
nc 2
nop 0
dl 0
loc 7
rs 9.4285
c 0
b 0
f 0
1
<?php
2
3
require_once dirname( __FILE__ ) . '/class.jetpack-sync-queue.php';
4
require_once dirname( __FILE__ ) . '/class.jetpack-sync-defaults.php';
5
require_once dirname( __FILE__ ) . '/class.jetpack-sync-json-deflate-array-codec.php';
6
require_once dirname( __FILE__ ) . '/class.jetpack-sync-modules.php';
7
require_once dirname( __FILE__ ) . '/class.jetpack-sync-settings.php';
8
9
/**
10
 * This class grabs pending actions from the queue and sends them
11
 */
12
class Jetpack_Sync_Sender {
13
14
	const NEXT_SYNC_TIME_OPTION_NAME = 'jetpack_next_sync_time';
15
	const WPCOM_ERROR_SYNC_DELAY = 60;
16
	const QUEUE_LOCKED_SYNC_DELAY = 10;
17
18
	private $dequeue_max_bytes;
19
	private $upload_max_bytes;
20
	private $upload_max_rows;
21
	private $max_dequeue_time;
22
	private $sync_wait_time;
23
	private $sync_wait_threshold;
24
	private $enqueue_wait_time;
25
	private $sync_queue;
26
	private $full_sync_queue;
27
	private $codec;
28
	private $old_user;
29
30
	// singleton functions
31
	private static $instance;
32
33
	public static function get_instance() {
34
		if ( null === self::$instance ) {
35
			self::$instance = new self();
36
		}
37
38
		return self::$instance;
39
	}
40
41
	// this is necessary because you can't use "new" when you declare instance properties >:(
42
	protected function __construct() {
43
		$this->set_defaults();
44
		$this->init();
45
	}
46
47
	private function init() {
48
		add_action( 'jetpack_sync_before_send_queue_sync', array( $this, 'maybe_set_user_from_token' ), 1 );
49
		add_action( 'jetpack_sync_before_send_queue_sync', array( $this, 'maybe_clear_user_from_token' ), 20 );
50
		foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
51
			$module->init_before_send();
52
		}
53
	}
54
55
	public function maybe_set_user_from_token() {
56
		$jetpack = Jetpack::init();
57
		if ( defined( 'XMLRPC_REQUEST' ) &&
58
		     XMLRPC_REQUEST &&
59
		     $jetpack->verify_xml_rpc_signature()
60
		) {
61
			$verified_user = $jetpack->verify_xml_rpc_signature();
62
			$old_user = wp_get_current_user();
63
			$this->old_user = isset( $old_user->ID ) ? $old_user->ID : 0;
64
			$this->old_user = wp_set_current_user( $verified_user['user_id'] );
65
		}
66
67
	}
68
69
	public function maybe_clear_user_from_token() {
70
		if ( isset( $this->old_user ) ) {
71
			wp_set_current_user( $this->old_user );
72
		}
73
 	}
74
75
	public function get_next_sync_time( $queue_name ) {
76
		return (double) get_option( self::NEXT_SYNC_TIME_OPTION_NAME . '_' . $queue_name, 0 );
77
	}
78
79
	public function set_next_sync_time( $time, $queue_name ) {
80
		return update_option( self::NEXT_SYNC_TIME_OPTION_NAME . '_' . $queue_name, $time, true );
81
	}
82
83
	public function do_full_sync() {
84
		if ( ! Jetpack_Sync_Modules::get_module( 'full-sync' ) ) {
85
			return;
86
		}
87
		$this->continue_full_sync_enqueue();
88
		return $this->do_sync_and_set_delays( $this->full_sync_queue );
89
	}
90
91
	private function continue_full_sync_enqueue() {
92
		if ( defined( 'WP_IMPORTING' ) && WP_IMPORTING ) {
93
			return false;
94
		}
95
96
		if ( $this->get_next_sync_time( 'full-sync-enqueue' ) > microtime( true ) ) {
97
			return false;
98
		}
99
100
		Jetpack_Sync_Modules::get_module( 'full-sync' )->continue_enqueuing();
101
102
		$this->set_next_sync_time( time() + $this->get_enqueue_wait_time(), 'full-sync-enqueue' );
103
	}
104
105
	public function do_sync() {
106
		return $this->do_sync_and_set_delays( $this->sync_queue );
107
	}
108
109
	public function do_sync_and_set_delays( $queue ) {
110
		// don't sync if importing
111
		if ( defined( 'WP_IMPORTING' ) && WP_IMPORTING ) {
112
			return new WP_Error( 'is_importing' );
113
		}
114
115
		// don't sync if we are throttled
116
		if ( $this->get_next_sync_time( $queue->id ) > microtime( true ) ) {
117
			return new WP_Error( 'sync_throttled' );
118
		}
119
120
		$start_time = microtime( true );
121
122
		Jetpack_Sync_Settings::set_is_syncing( true );
123
124
		$sync_result = $this->do_sync_for_queue( $queue );
125
126
		Jetpack_Sync_Settings::set_is_syncing( false );
127
128
		$exceeded_sync_wait_threshold = ( microtime( true ) - $start_time ) > (double) $this->get_sync_wait_threshold();
129
130
		if ( is_wp_error( $sync_result ) ) {
131
			if ( 'unclosed_buffer' === $sync_result->get_error_code() ) {
132
				$this->set_next_sync_time( time() + self::QUEUE_LOCKED_SYNC_DELAY, $queue->id );
133
			}
134
			if ( 'wpcom_error' === $sync_result->get_error_code() ) {
135
				$this->set_next_sync_time( time() + self::WPCOM_ERROR_SYNC_DELAY, $queue->id );
136
			}
137
		} elseif ( $exceeded_sync_wait_threshold ) {
138
			// if we actually sent data and it took a while, wait before sending again
139
			$this->set_next_sync_time( time() + $this->get_sync_wait_time(), $queue->id );
140
		}
141
142
		return $sync_result;
143
	}
144
145
	public function get_items_to_send( $buffer, $encode = true ) {
146
		// track how long we've been processing so we can avoid request timeouts
147
		$start_time = microtime( true );
148
		$upload_size   = 0;
149
		$items_to_send = array();
150
		$items         = $buffer->get_items();
151
		// set up current screen to avoid errors rendering content
152
		require_once( ABSPATH . 'wp-admin/includes/class-wp-screen.php' );
153
		require_once( ABSPATH . 'wp-admin/includes/screen.php' );
154
		set_current_screen( 'sync' );
155
		$skipped_items_ids = array();
156
		// we estimate the total encoded size as we go by encoding each item individually
157
		// this is expensive, but the only way to really know :/
158
		foreach ( $items as $key => $item ) {
159
			// Suspending cache addition help prevent overloading in memory cache of large sites.
160
			wp_suspend_cache_addition( true );
161
			/**
162
			 * Modify the data within an action before it is serialized and sent to the server
163
			 * For example, during full sync this expands Post ID's into full Post objects,
164
			 * so that we don't have to serialize the whole object into the queue.
165
			 *
166
			 * @since 4.2.0
167
			 *
168
			 * @param array The action parameters
169
			 * @param int The ID of the user who triggered the action
170
			 */
171
			$item[1] = apply_filters( 'jetpack_sync_before_send_' . $item[0], $item[1], $item[2] );
172
			wp_suspend_cache_addition( false );
173
			if ( $item[1] === false ) {
174
				$skipped_items_ids[] = $key;
175
				continue;
176
			}
177
			$encoded_item = $encode ? $this->codec->encode( $item ) : $item;
178
			$upload_size += strlen( $encoded_item );
179
			if ( $upload_size > $this->upload_max_bytes && count( $items_to_send ) > 0 ) {
180
				break;
181
			}
182
			$items_to_send[ $key ] = $encoded_item;
183
			if ( microtime(true) - $start_time > $this->max_dequeue_time ) {
184
				break;
185
			}
186
		}
187
188
		return array( $items_to_send, $skipped_items_ids, $items, microtime( true ) - $start_time );
189
	}
190
191
	public function do_sync_for_queue( $queue ) {
192
193
		do_action( 'jetpack_sync_before_send_queue_' . $queue->id );
194
		if ( $queue->size() === 0 ) {
195
			return new WP_Error( 'empty_queue_' . $queue->id );
196
		}
197
		// now that we're sure we are about to sync, try to
198
		// ignore user abort so we can avoid getting into a
199
		// bad state
200
		if ( function_exists( 'ignore_user_abort' ) ) {
201
			ignore_user_abort( true );
202
		}
203
204
		$checkout_start_time = microtime( true );
205
206
		$buffer = $queue->checkout_with_memory_limit( $this->dequeue_max_bytes, $this->upload_max_rows );
207
208
		if ( ! $buffer ) {
209
			// buffer has no items
210
			return new WP_Error( 'empty_buffer' );
211
		}
212
213
		if ( is_wp_error( $buffer ) ) {
214
			return $buffer;
215
		}
216
217
		$checkout_duration = microtime( true ) - $checkout_start_time;
218
219
		list( $items_to_send, $skipped_items_ids, $items, $preprocess_duration ) = $this->get_items_to_send( $buffer, true );
220
221
		/**
222
		 * Fires when data is ready to send to the server.
223
		 * Return false or WP_Error to abort the sync (e.g. if there's an error)
224
		 * The items will be automatically re-sent later
225
		 *
226
		 * @since 4.2.0
227
		 *
228
		 * @param array $data The action buffer
229
		 * @param string $codec The codec name used to encode the data
230
		 * @param double $time The current time
231
		 * @param string $queue The queue used to send ('sync' or 'full_sync')
232
		 */
233
		Jetpack_Sync_Settings::set_is_sending( true );
234
		$processed_item_ids = apply_filters( 'jetpack_sync_send_data', $items_to_send, $this->codec->name(), microtime( true ), $queue->id, $checkout_duration, $preprocess_duration );
235
		Jetpack_Sync_Settings::set_is_sending( false );
236
237
		if ( ! $processed_item_ids || is_wp_error( $processed_item_ids ) ) {
238
			$checked_in_item_ids = $queue->checkin( $buffer );
239
			if ( is_wp_error( $checked_in_item_ids ) ) {
240
				error_log( 'Error checking in buffer: ' . $checked_in_item_ids->get_error_message() );
241
				$queue->force_checkin();
242
			}
243
			if ( is_wp_error( $processed_item_ids ) ) {
244
				return new WP_Error( 'wpcom_error', $processed_item_ids->get_error_code() );
245
			}
246
			// returning a WP_Error('wpcom_error') is a sign to the caller that we should wait a while
247
			// before syncing again
248
			return new WP_Error( 'wpcom_error', 'jetpack_sync_send_data_false' );
249
		} else {
250
			// detect if the last item ID was an error
251
			$had_wp_error = is_wp_error( end( $processed_item_ids ) );
252
			if ( $had_wp_error ) {
253
				$wp_error = array_pop( $processed_item_ids );
254
			}
255
			// also checkin any items that were skipped
256
			if ( count( $skipped_items_ids ) > 0 ) {
257
				$processed_item_ids = array_merge( $processed_item_ids, $skipped_items_ids );
258
			}
259
			$processed_items = array_intersect_key( $items, array_flip( $processed_item_ids ) );
260
			/**
261
			 * Allows us to keep track of all the actions that have been sent.
262
			 * Allows us to calculate the progress of specific actions.
263
			 *
264
			 * @since 4.2.0
265
			 *
266
			 * @param array $processed_actions The actions that we send successfully.
267
			 */
268
			do_action( 'jetpack_sync_processed_actions', $processed_items );
269
			$queue->close( $buffer, $processed_item_ids );
270
			// returning a WP_Error is a sign to the caller that we should wait a while
271
			// before syncing again
272
			if ( $had_wp_error ) {
273
				return new WP_Error( 'wpcom_error', $wp_error->get_error_code() );
0 ignored issues
show
Bug introduced by
The variable $wp_error does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
274
			}
275
		}
276
		return true;
277
	}
278
279
	function get_sync_queue() {
280
		return $this->sync_queue;
281
	}
282
283
	function get_full_sync_queue() {
284
		return $this->full_sync_queue;
285
	}
286
287
	function get_codec() {
288
		return $this->codec;
289
	}
290
291
	function send_checksum() {
292
		require_once 'class.jetpack-sync-wp-replicastore.php';
293
		$store = new Jetpack_Sync_WP_Replicastore();
294
		do_action( 'jetpack_sync_checksum', $store->checksum_all() );
295
	}
296
297
	function reset_sync_queue() {
298
		$this->sync_queue->reset();
299
	}
300
301
	function reset_full_sync_queue() {
302
		$this->full_sync_queue->reset();
303
	}
304
305
	function set_dequeue_max_bytes( $size ) {
306
		$this->dequeue_max_bytes = $size;
307
	}
308
309
	// in bytes
310
	function set_upload_max_bytes( $max_bytes ) {
311
		$this->upload_max_bytes = $max_bytes;
312
	}
313
314
	// in rows
315
	function set_upload_max_rows( $max_rows ) {
316
		$this->upload_max_rows = $max_rows;
317
	}
318
319
	// in seconds
320
	function set_sync_wait_time( $seconds ) {
321
		$this->sync_wait_time = $seconds;
322
	}
323
324
	function get_sync_wait_time() {
325
		return $this->sync_wait_time;
326
	}
327
328
	function set_enqueue_wait_time( $seconds ) {
329
		$this->enqueue_wait_time = $seconds;
330
	}
331
332
	function get_enqueue_wait_time() {
333
		return $this->enqueue_wait_time;
334
	}
335
336
	// in seconds
337
	function set_sync_wait_threshold( $seconds ) {
338
		$this->sync_wait_threshold = $seconds;
339
	}
340
341
	function get_sync_wait_threshold() {
342
		return $this->sync_wait_threshold;
343
	}
344
345
	// in seconds
346
	function set_max_dequeue_time( $seconds ) {
347
		$this->max_dequeue_time = $seconds;
348
	}
349
350
	function set_defaults() {
351
		$this->sync_queue      = new Jetpack_Sync_Queue( 'sync' );
352
		$this->full_sync_queue = new Jetpack_Sync_Queue( 'full_sync' );
353
		$this->codec           = new Jetpack_Sync_JSON_Deflate_Array_Codec();
354
355
		// saved settings
356
		Jetpack_Sync_Settings::set_importing( null );
357
		$settings = Jetpack_Sync_Settings::get_settings();
358
		$this->set_dequeue_max_bytes( $settings['dequeue_max_bytes'] );
359
		$this->set_upload_max_bytes( $settings['upload_max_bytes'] );
360
		$this->set_upload_max_rows( $settings['upload_max_rows'] );
361
		$this->set_sync_wait_time( $settings['sync_wait_time'] );
362
		$this->set_enqueue_wait_time( $settings['enqueue_wait_time'] );
363
		$this->set_sync_wait_threshold( $settings['sync_wait_threshold'] );
364
		$this->set_max_dequeue_time( Jetpack_Sync_Defaults::get_max_sync_execution_time() );
365
	}
366
367
	function reset_data() {
368
		$this->reset_sync_queue();
369
		$this->reset_full_sync_queue();
370
371
		foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
372
			$module->reset_data();
373
		}
374
375
		foreach ( array( 'sync', 'full_sync', 'full-sync-enqueue' ) as $queue_name ) {
376
			delete_option( self::NEXT_SYNC_TIME_OPTION_NAME . '_' . $queue_name );
377
		}
378
379
		Jetpack_Sync_Settings::reset_data();
380
	}
381
382
	function uninstall() {
383
		// Lets delete all the other fun stuff like transient and option and the sync queue
384
		$this->reset_data();
385
386
		// delete the full sync status
387
		delete_option( 'jetpack_full_sync_status' );
388
389
		// clear the sync cron.
390
		wp_clear_scheduled_hook( 'jetpack_sync_cron' );
391
		wp_clear_scheduled_hook( 'jetpack_sync_full_cron' );
392
	}
393
}
394