forked from Automattic/jetpack
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathclass.jetpack-sync-module-full-sync.php
More file actions
366 lines (292 loc) · 11.2 KB
/
class.jetpack-sync-module-full-sync.php
File metadata and controls
366 lines (292 loc) · 11.2 KB
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
<?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, and its related class Jetpack_Sync_Module, contain 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 page through the object IDs and enqueue them by firing some monitored actions
* - we load the full objects for those IDs in chunks of Jetpack_Sync_Module::ARRAY_CHUNK_SIZE (to reduce the number of MySQL calls)
* - we fire a trigger for the entire array which the Jetpack_Sync_Listener then serializes and queues.
*/
class Jetpack_Sync_Module_Full_Sync extends Jetpack_Sync_Module {
const STATUS_OPTION_PREFIX = 'jetpack_sync_full_';
const FULL_SYNC_TIMEOUT = 3600;
public function name() {
return 'full-sync';
}
function init_full_sync_listeners( $callable ) {
// synthetic actions for full sync
add_action( 'jetpack_full_sync_start', $callable );
add_action( 'jetpack_full_sync_end', $callable );
add_action( 'jetpack_full_sync_cancelled', $callable );
}
function init_before_send() {
// this is triggered after actions have been processed on the server
add_action( 'jetpack_sync_processed_actions', array( $this, 'update_sent_progress_action' ) );
}
function start( $module_configs = null ) {
$was_already_running = $this->is_started() && ! $this->is_finished();
// remove all evidence of previous full sync items and status
$this->reset_data();
if ( $was_already_running ) {
/**
* Fires when a full sync is cancelled.
*
* @since 4.2.0
*/
do_action( 'jetpack_full_sync_cancelled' );
}
$this->update_status_option( 'started', time() );
$this->update_status_option( 'params', $module_configs );
$enqueue_status = array();
$full_sync_config = array();
// default value is full sync
if ( ! is_array( $module_configs ) ) {
$module_configs = array();
foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
$module_configs[ $module->name() ] = true;
}
}
// set default configuration, calculate totals, and save configuration if totals > 0
foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
$module_name = $module->name();
$module_config = isset( $module_configs[ $module_name ] ) ? $module_configs[ $module_name ] : false;
if ( ! $module_config ) {
continue;
}
if ( 'users' === $module_name && 'initial' === $module_config ) {
$module_config = $module->get_initial_sync_user_config();
}
$enqueue_status[ $module_name ] = false;
$total_items = $module->estimate_full_sync_actions( $module_config );
// if there's information to process, configure this module
if ( ! is_null( $total_items ) && $total_items > 0 ) {
$full_sync_config[ $module_name ] = $module_config;
$enqueue_status[ $module_name ] = array(
$total_items, // total
0, // queued
false, // current state
);
}
}
$this->set_config( $full_sync_config );
$this->set_enqueue_status( $enqueue_status );
/**
* Fires when a full sync begins. This action is serialized
* and sent to the server so that it knows a full sync is coming.
*
* @since 4.2.0
*/
do_action( 'jetpack_full_sync_start', $full_sync_config );
$this->continue_enqueuing( $full_sync_config, $enqueue_status );
return true;
}
function continue_enqueuing( $configs = null, $enqueue_status = null ) {
if ( ! $this->is_started() || $this->get_status_option( 'queue_finished' ) ) {
return;
}
// if full sync queue is full, don't enqueue more items
$max_queue_size_full_sync = Jetpack_Sync_Settings::get_setting( 'max_queue_size_full_sync' );
$full_sync_queue = new Jetpack_Sync_Queue( 'full_sync' );
$available_queue_slots = $max_queue_size_full_sync - $full_sync_queue->size();
if ( $available_queue_slots <= 0 ) {
return;
} else {
$remaining_items_to_enqueue = min( Jetpack_Sync_Settings::get_setting( 'max_enqueue_full_sync' ), $available_queue_slots );
}
if ( ! $configs ) {
$configs = $this->get_config();
}
if ( ! $enqueue_status ) {
$enqueue_status = $this->get_enqueue_status();
}
foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
$module_name = $module->name();
// skip module if not configured for this sync or module is done
if ( ! isset( $configs[ $module_name ] )
|| // no module config
! $configs[ $module_name ]
|| // no enqueue status
! $enqueue_status[ $module_name ]
|| // finished enqueuing this module
true === $enqueue_status[ $module_name ][ 2 ] ) {
continue;
}
list( $items_enqueued, $next_enqueue_state ) = $module->enqueue_full_sync_actions( $configs[ $module_name ], $remaining_items_to_enqueue, $enqueue_status[ $module_name ][ 2 ] );
$enqueue_status[ $module_name ][ 2 ] = $next_enqueue_state;
// if items were processed, subtract them from the limit
if ( ! is_null( $items_enqueued ) && $items_enqueued > 0 ) {
$enqueue_status[ $module_name ][ 1 ] += $items_enqueued;
$remaining_items_to_enqueue -= $items_enqueued;
}
// stop processing if we've reached our limit of items to enqueue
if ( 0 >= $remaining_items_to_enqueue ) {
$this->set_enqueue_status( $enqueue_status );
return;
}
}
$this->set_enqueue_status( $enqueue_status );
// setting autoload to true means that it's faster to check whether we should continue enqueuing
$this->update_status_option( 'queue_finished', time(), true );
/**
* Fires when a full sync ends. This action is serialized
* and sent to the server.
*
* @since 4.2.0
*/
do_action( 'jetpack_full_sync_end', '' );
}
function update_sent_progress_action( $actions ) {
// quick way to map to first items with an array of arrays
$actions_with_counts = array_count_values( array_filter( array_map( array( $this, 'get_action_name' ), $actions ) ) );
if ( ! $this->is_started() || $this->is_finished() ) {
return;
}
if ( isset( $actions_with_counts['jetpack_full_sync_start'] ) ) {
$this->update_status_option( 'send_started', time() );
}
foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
$module_actions = $module->get_full_sync_actions();
$status_option_name = "{$module->name()}_sent";
$items_sent = $this->get_status_option( $status_option_name, 0 );
foreach ( $module_actions as $module_action ) {
if ( isset( $actions_with_counts[ $module_action ] ) ) {
$items_sent += $actions_with_counts[ $module_action ];
}
}
if ( $items_sent > 0 ) {
$this->update_status_option( $status_option_name, $items_sent );
}
}
if ( isset( $actions_with_counts['jetpack_full_sync_end'] ) ) {
$this->update_status_option( 'finished', time() );
}
}
public function get_action_name( $queue_item ) {
if ( is_array( $queue_item ) && isset( $queue_item[0] ) ) {
return $queue_item[0];
}
return false;
}
public function is_started() {
return !! $this->get_status_option( 'started' );
}
public function is_finished() {
return !! $this->get_status_option( 'finished' );
}
public function get_status() {
$status = array(
'started' => $this->get_status_option( 'started' ),
'queue_finished' => $this->get_status_option( 'queue_finished' ),
'send_started' => $this->get_status_option( 'send_started' ),
'finished' => $this->get_status_option( 'finished' ),
'sent' => array(),
'queue' => array(),
'config' => $this->get_status_option( 'params' ),
'total' => array(),
);
$enqueue_status = $this->get_enqueue_status();
foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
$name = $module->name();
if ( ! isset( $enqueue_status[ $name ] ) ) {
continue;
}
list( $total, $queued, $state ) = $enqueue_status[ $name ];
if ( $total ) {
$status[ 'total' ][ $name ] = $total;
}
if ( $queued ) {
$status[ 'queue' ][ $name ] = $queued;
}
if ( $sent = $this->get_status_option( "{$name}_sent" ) ) {
$status[ 'sent' ][ $name ] = $sent;
}
}
return $status;
}
public function clear_status() {
$prefix = self::STATUS_OPTION_PREFIX;
Jetpack_Options::delete_raw_option( "{$prefix}_started" );
Jetpack_Options::delete_raw_option( "{$prefix}_params" );
Jetpack_Options::delete_raw_option( "{$prefix}_queue_finished" );
Jetpack_Options::delete_raw_option( "{$prefix}_send_started" );
Jetpack_Options::delete_raw_option( "{$prefix}_finished" );
$this->delete_enqueue_status();
foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
Jetpack_Options::delete_raw_option( "{$prefix}_{$module->name()}_sent" );
}
}
public function reset_data() {
$this->clear_status();
$this->delete_config();
require_once dirname( __FILE__ ) . '/class.jetpack-sync-listener.php';
$listener = Jetpack_Sync_Listener::get_instance();
$listener->get_full_sync_queue()->reset();
}
private function get_status_option( $name, $default = null ) {
$value = Jetpack_Options::get_raw_option( self::STATUS_OPTION_PREFIX . "_$name", $default );
return is_numeric( $value ) ? intval( $value ) : $value;
}
private function update_status_option( $name, $value, $autoload = false ) {
Jetpack_Options::update_raw_option( self::STATUS_OPTION_PREFIX . "_$name", $value, $autoload );
}
private function set_enqueue_status( $new_status ) {
Jetpack_Options::update_raw_option( 'jetpack_sync_full_enqueue_status', $new_status );
}
private function delete_enqueue_status() {
return Jetpack_Options::delete_raw_option( 'jetpack_sync_full_enqueue_status' );
}
private function get_enqueue_status() {
return Jetpack_Options::get_raw_option( 'jetpack_sync_full_enqueue_status' );
}
private function set_config( $config ) {
Jetpack_Options::update_raw_option( 'jetpack_sync_full_config', $config );
}
private function delete_config() {
return Jetpack_Options::delete_raw_option( 'jetpack_sync_full_config' );
}
private function get_config() {
return Jetpack_Options::get_raw_option( 'jetpack_sync_full_config' );
}
private function write_option( $name, $value ) {
// we write our own option updating code to bypass filters/caching/etc on set_option/get_option
global $wpdb;
$serialized_value = maybe_serialize( $value );
// try updating, if no update then insert
// TODO: try to deal with the fact that unchanged values can return updated_num = 0
// below we used "insert ignore" to at least suppress the resulting error
$updated_num = $wpdb->query(
$wpdb->prepare(
"UPDATE $wpdb->options SET option_value = %s WHERE option_name = %s",
$serialized_value,
$name
)
);
if ( ! $updated_num ) {
$updated_num = $wpdb->query(
$wpdb->prepare(
"INSERT IGNORE INTO $wpdb->options ( option_name, option_value, autoload ) VALUES ( %s, %s, 'no' )",
$name,
$serialized_value
)
);
}
return $updated_num;
}
private function read_option( $name, $default = null ) {
global $wpdb;
$value = $wpdb->get_var(
$wpdb->prepare(
"SELECT option_value FROM $wpdb->options WHERE option_name = %s LIMIT 1",
$name
)
);
$value = maybe_unserialize( $value );
if ( $value === null && $default !== null ) {
return $default;
}
return $value;
}
}