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
|
<?php
/**
* Network Options sync module.
*
* @package automattic/jetpack-sync
*/
namespace Automattic\Jetpack\Sync\Modules;
use Automattic\Jetpack\Sync\Defaults;
/**
* Class to handle sync for network options.
*/
class Network_Options extends Module {
/**
* Whitelist for network options we want to sync.
*
* @access private
*
* @var array
*/
private $network_options_whitelist;
/**
* Sync module name.
*
* @access public
*
* @return string
*/
public function name() {
return 'network_options';
}
/**
* Initialize network options action listeners.
*
* @access public
*
* @param callable $callable Action handler callable.
*/
public function init_listeners( $callable ) {
// Multi site network options.
add_action( 'add_site_option', $callable, 10, 2 );
add_action( 'update_site_option', $callable, 10, 3 );
add_action( 'delete_site_option', $callable, 10, 1 );
$whitelist_network_option_handler = array( $this, 'whitelist_network_options' );
add_filter( 'jetpack_sync_before_enqueue_delete_site_option', $whitelist_network_option_handler );
add_filter( 'jetpack_sync_before_enqueue_add_site_option', $whitelist_network_option_handler );
add_filter( 'jetpack_sync_before_enqueue_update_site_option', $whitelist_network_option_handler );
}
/**
* Initialize network options action listeners for full sync.
*
* @access public
*
* @param callable $callable Action handler callable.
*/
public function init_full_sync_listeners( $callable ) {
add_action( 'jetpack_full_sync_network_options', $callable );
}
/**
* Initialize the module in the sender.
*
* @access public
*/
public function init_before_send() {
// Full sync.
add_filter(
'jetpack_sync_before_send_jetpack_full_sync_network_options',
array(
$this,
'expand_network_options',
)
);
}
/**
* Set module defaults.
* Define the network options whitelist based on the default one.
*
* @access public
*/
public function set_defaults() {
$this->network_options_whitelist = Defaults::$default_network_options_whitelist;
}
/**
* Enqueue the network options actions for full sync.
*
* @access public
*
* @param array $config Full sync configuration for this sync module.
* @param int $max_items_to_enqueue Maximum number of items to enqueue.
* @param boolean $state True if full sync has finished enqueueing this module, false otherwise.
* @return array Number of actions enqueued, and next module state.
*/
public function enqueue_full_sync_actions( $config, $max_items_to_enqueue, $state ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
/**
* Tells the client to sync all options to the server
*
* @since 1.6.3
* @since-jetpack 4.2.0
*
* @param boolean Whether to expand options (should always be true)
*/
do_action( 'jetpack_full_sync_network_options', true );
// The number of actions enqueued, and next module state (true == done).
return array( 1, true );
}
/**
* Send the network options actions for full sync.
*
* @access public
*
* @param array $config Full sync configuration for this sync module.
* @param int $send_until The timestamp until the current request can send.
* @param array $state This module Full Sync status.
*
* @return array This module Full Sync status.
*/
public function send_full_sync_actions( $config, $send_until, $state ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
// we call this instead of do_action when sending immediately.
$this->send_action( 'jetpack_full_sync_network_options', array( true ) );
// The number of actions enqueued, and next module state (true == done).
return array( 'finished' => true );
}
/**
* Retrieve an estimated number of actions that will be enqueued.
*
* @access public
*
* @param array $config Full sync configuration for this sync module.
* @return array Number of items yet to be enqueued.
*/
public function estimate_full_sync_actions( $config ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
return 1;
}
/**
* Retrieve the actions that will be sent for this module during a full sync.
*
* @access public
*
* @return array Full sync actions of this module.
*/
public function get_full_sync_actions() {
return array( 'jetpack_full_sync_network_options' );
}
/**
* Retrieve all network options as per the current network options whitelist.
*
* @access public
*
* @return array All network options.
*/
public function get_all_network_options() {
$options = array();
foreach ( $this->network_options_whitelist as $option ) {
$options[ $option ] = get_site_option( $option );
}
return $options;
}
/**
* Set the network options whitelist.
*
* @access public
*
* @param array $options The new network options whitelist.
*/
public function set_network_options_whitelist( $options ) {
$this->network_options_whitelist = $options;
}
/**
* Get the network options whitelist.
*
* @access public
*
* @return array The network options whitelist.
*/
public function get_network_options_whitelist() {
return $this->network_options_whitelist;
}
/**
* Reject non-whitelisted network options.
*
* @access public
*
* @param array $args The hook parameters.
* @return array|false $args The hook parameters, false if not a whitelisted network option.
*/
public function whitelist_network_options( $args ) {
if ( ! $this->is_whitelisted_network_option( $args[0] ) ) {
return false;
}
return $args;
}
/**
* Whether the option is a whitelisted network option.
*
* @access public
*
* @param string $option Option name.
* @return boolean True if this is a whitelisted network option.
*/
public function is_whitelisted_network_option( $option ) {
return in_array( $option, $this->network_options_whitelist, true );
}
/**
* Expand the network options within a hook before they are serialized and sent to the server.
*
* @access public
*
* @param array $args The hook parameters.
* @return array $args The hook parameters.
*/
public function expand_network_options( $args ) {
if ( $args[0] ) {
return $this->get_all_network_options();
}
return $args;
}
/**
* Return Total number of objects.
*
* @param array $config Full Sync config.
*
* @return int total
*/
public function total( $config ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
return count( $this->network_options_whitelist );
}
}
|