1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
|
<?php
/**
* Full sync module.
*
* @package automattic/jetpack-sync
*/
namespace Automattic\Jetpack\Sync\Modules;
use Automattic\Jetpack\Sync\Actions;
use Automattic\Jetpack\Sync\Defaults;
use Automattic\Jetpack\Sync\Lock;
use Automattic\Jetpack\Sync\Modules;
use Automattic\Jetpack\Sync\Settings;
/**
* This class does a full resync of the database by
* sending an outbound action for every single object
* that we care about.
*/
class Full_Sync_Immediately extends Module {
/**
* Prefix of the full sync status option name.
*
* @var string
*/
const STATUS_OPTION = 'jetpack_sync_full_status';
/**
* Sync Lock name.
*
* @var string
*/
const LOCK_NAME = 'full_sync';
/**
* Sync module name.
*
* @access public
*
* @return string
*/
public function name() {
return 'full-sync';
}
/**
* Initialize action listeners for full sync.
*
* @access public
*
* @param callable $callable Action handler callable.
*/
public function init_full_sync_listeners( $callable ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
}
/**
* Start a full sync.
*
* @access public
*
* @param array $full_sync_config Full sync configuration.
*
* @return bool Always returns true at success.
*/
public function start( $full_sync_config = null ) {
// There was a full sync in progress.
if ( $this->is_started() && ! $this->is_finished() ) {
/**
* Fires when a full sync is cancelled.
*
* @since 1.6.3
* @since-jetpack 4.2.0
*/
do_action( 'jetpack_full_sync_cancelled' );
$this->send_action( 'jetpack_full_sync_cancelled' );
}
// Remove all evidence of previous full sync items and status.
$this->reset_data();
if ( ! is_array( $full_sync_config ) ) {
$full_sync_config = Defaults::$default_full_sync_config;
if ( is_multisite() ) {
$full_sync_config['network_options'] = 1;
}
}
if ( isset( $full_sync_config['users'] ) && 'initial' === $full_sync_config['users'] ) {
$full_sync_config['users'] = Modules::get_module( 'users' )->get_initial_sync_user_config();
}
$this->update_status(
array(
'started' => time(),
'config' => $full_sync_config,
'progress' => $this->get_initial_progress( $full_sync_config ),
)
);
$range = $this->get_content_range( $full_sync_config );
/**
* Fires when a full sync begins. This action is serialized
* and sent to the server so that it knows a full sync is coming.
*
* @param array $full_sync_config Sync configuration for all sync modules.
* @param array $range Range of the sync items, containing min and max IDs for some item types.
* @param array $empty The modules with no items to sync during a full sync.
*
* @since 1.6.3
* @since-jetpack 4.2.0
* @since-jetpack 7.3.0 Added $range arg.
* @since-jetpack 7.4.0 Added $empty arg.
*/
do_action( 'jetpack_full_sync_start', $full_sync_config, $range );
$this->send_action( 'jetpack_full_sync_start', array( $full_sync_config, $range ) );
return true;
}
/**
* Whether full sync has started.
*
* @access public
*
* @return boolean
*/
public function is_started() {
return (bool) $this->get_status()['started'];
}
/**
* Retrieve the status of the current full sync.
*
* @access public
*
* @return array Full sync status.
*/
public function get_status() {
$default = array(
'started' => false,
'finished' => false,
'progress' => array(),
'config' => array(),
);
return wp_parse_args( \Jetpack_Options::get_raw_option( self::STATUS_OPTION ), $default );
}
/**
* Returns the progress percentage of a full sync.
*
* @access public
*
* @return int|null
*/
public function get_sync_progress_percentage() {
if ( ! $this->is_started() || $this->is_finished() ) {
return null;
}
$status = $this->get_status();
if ( empty( $status['progress'] ) ) {
return null;
}
$total_items = array_reduce(
array_values( $status['progress'] ),
function ( $sum, $sync_item ) {
return isset( $sync_item['total'] ) ? ( $sum + (int) $sync_item['total'] ) : $sum;
},
0
);
$total_sent = array_reduce(
array_values( $status['progress'] ),
function ( $sum, $sync_item ) {
return isset( $sync_item['sent'] ) ? ( $sum + (int) $sync_item['sent'] ) : $sum;
},
0
);
return floor( ( $total_sent / $total_items ) * 100 );
}
/**
* Whether full sync has finished.
*
* @access public
*
* @return boolean
*/
public function is_finished() {
return (bool) $this->get_status()['finished'];
}
/**
* Clear all the full sync data.
*
* @access public
*/
public function reset_data() {
$this->clear_status();
( new Lock() )->remove( self::LOCK_NAME, true );
}
/**
* Clear all the full sync status options.
*
* @access public
*/
public function clear_status() {
\Jetpack_Options::delete_raw_option( self::STATUS_OPTION );
}
/**
* Updates the status of the current full sync.
*
* @access public
*
* @param array $values New values to set.
*
* @return bool True if success.
*/
public function update_status( $values ) {
return $this->set_status( wp_parse_args( $values, $this->get_status() ) );
}
/**
* Retrieve the status of the current full sync.
*
* @param array $values New values to set.
*
* @access public
*
* @return boolean Full sync status.
*/
public function set_status( $values ) {
return \Jetpack_Options::update_raw_option( self::STATUS_OPTION, $values );
}
/**
* Given an initial Full Sync configuration get the initial status.
*
* @param array $full_sync_config Full sync configuration.
*
* @return array Initial Sent status.
*/
public function get_initial_progress( $full_sync_config ) {
// Set default configuration, calculate totals, and save configuration if totals > 0.
$status = array();
foreach ( $full_sync_config as $name => $config ) {
$module = Modules::get_module( $name );
if ( ! $module ) {
continue;
}
$status[ $name ] = array(
'total' => $module->total( $config ),
'sent' => 0,
'finished' => false,
);
}
return $status;
}
/**
* Get the range for content (posts and comments) to sync.
*
* @access private
*
* @return array Array of range (min ID, max ID, total items) for all content types.
*/
private function get_content_range() {
$range = array();
$config = $this->get_status()['config'];
// Add range only when syncing all objects.
if ( true === isset( $config['posts'] ) && $config['posts'] ) {
$range['posts'] = $this->get_range( 'posts' );
}
if ( true === isset( $config['comments'] ) && $config['comments'] ) {
$range['comments'] = $this->get_range( 'comments' );
}
return $range;
}
/**
* Get the range (min ID, max ID and total items) of items to sync.
*
* @access public
*
* @param string $type Type of sync item to get the range for.
*
* @return array Array of min ID, max ID and total items in the range.
*/
public function get_range( $type ) {
global $wpdb;
if ( ! in_array( $type, array( 'comments', 'posts' ), true ) ) {
return array();
}
switch ( $type ) {
case 'posts':
$table = $wpdb->posts;
$id = 'ID';
$where_sql = Settings::get_blacklisted_post_types_sql();
break;
case 'comments':
$table = $wpdb->comments;
$id = 'comment_ID';
$where_sql = Settings::get_comments_filter_sql();
break;
}
// TODO: Call $wpdb->prepare on the following query.
// phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
$results = $wpdb->get_results( "SELECT MAX({$id}) as max, MIN({$id}) as min, COUNT({$id}) as count FROM {$table} WHERE {$where_sql}" );
if ( isset( $results[0] ) ) {
return $results[0];
}
return array();
}
/**
* Continue sending instead of enqueueing.
*
* @access public
*/
public function continue_enqueuing() {
$this->continue_sending();
}
/**
* Continue sending.
*
* @access public
*/
public function continue_sending() {
// Return early if Full Sync is not running.
if ( ! $this->is_started() || $this->get_status()['finished'] ) {
return;
}
// Return early if we've gotten a retry-after header response.
$retry_time = get_option( Actions::RETRY_AFTER_PREFIX . 'immediate-send' );
if ( $retry_time ) {
// If expired delete but don't send. Send will occurr in new request to avoid race conditions.
if ( microtime( true ) > $retry_time ) {
update_option( Actions::RETRY_AFTER_PREFIX . 'immediate-send', false, false );
}
return false;
}
// Obtain send Lock.
$lock = new Lock();
$lock_expiration = $lock->attempt( self::LOCK_NAME );
// Return if unable to obtain lock.
if ( false === $lock_expiration ) {
return;
}
// Send Full Sync actions.
$success = $this->send();
// Remove lock.
if ( $success ) {
$lock->remove( self::LOCK_NAME, $lock_expiration );
}
}
/**
* Immediately send the next items to full sync.
*
* @access public
*/
public function send() {
$config = $this->get_status()['config'];
$max_duration = Settings::get_setting( 'full_sync_send_duration' );
$send_until = microtime( true ) + $max_duration;
$progress = $this->get_status()['progress'];
foreach ( $this->get_remaining_modules_to_send() as $module ) {
$progress[ $module->name() ] = $module->send_full_sync_actions( $config[ $module->name() ], $progress[ $module->name() ], $send_until );
if ( isset( $progress[ $module->name() ]['error'] ) ) {
unset( $progress[ $module->name() ]['error'] );
$this->update_status( array( 'progress' => $progress ) );
return false;
} elseif ( ! $progress[ $module->name() ]['finished'] ) {
$this->update_status( array( 'progress' => $progress ) );
return true;
}
}
$this->send_full_sync_end();
$this->update_status( array( 'progress' => $progress ) );
return true;
}
/**
* Get Modules that are configured to Full Sync and haven't finished sending
*
* @return array
*/
public function get_remaining_modules_to_send() {
$status = $this->get_status();
return array_filter(
Modules::get_modules(),
/**
* Select configured and not finished modules.
*
* @return bool
* @var $module Module
*/
function ( $module ) use ( $status ) {
// Skip module if not configured for this sync or module is done.
if ( ! isset( $status['config'][ $module->name() ] ) ) {
return false;
}
if ( ! $status['config'][ $module->name() ] ) {
return false;
}
if ( isset( $status['progress'][ $module->name() ]['finished'] ) ) {
if ( true === $status['progress'][ $module->name() ]['finished'] ) {
return false;
}
}
return true;
}
);
}
/**
* Send 'jetpack_full_sync_end' and update 'finished' status.
*
* @access public
*/
public function send_full_sync_end() {
$range = $this->get_content_range();
/**
* Fires when a full sync ends. This action is serialized
* and sent to the server.
*
* @param string $checksum Deprecated since 7.3.0 - @see https://github.com/Automattic/jetpack/pull/11945/
* @param array $range Range of the sync items, containing min and max IDs for some item types.
*
* @since 1.6.3
* @since-jetpack 4.2.0
* @since-jetpack 7.3.0 Added $range arg.
*/
do_action( 'jetpack_full_sync_end', '', $range );
$this->send_action( 'jetpack_full_sync_end', array( '', $range ) );
// Setting autoload to true means that it's faster to check whether we should continue enqueuing.
$this->update_status( array( 'finished' => time() ) );
}
/**
* Empty Function as we don't close buffers on Immediate Full Sync.
*
* @param array $actions an array of actions, ignored for queueless sync.
*/
public function update_sent_progress_action( $actions ) { } // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
}
|