class.jetpack-options.php — Jetpack – WP Security, Backup, Speed, & Growth 6.0.4

jetpack / class.jetpack-options.php

jetpack Last commit date

class.jetpack-options.php

588 lines

1	<?php
2
3	class Jetpack_Options {
4
5	/**
6	* An array that maps a grouped option type to an option name.
7	* @var array
8	*/
9	private static $grouped_options = array(
10	'compact' => 'jetpack_options',
11	'private' => 'jetpack_private_options'
12	);
13
14	/**
15	* Returns an array of option names for a given type.
16	*
17	* @param string $type The type of option to return. Defaults to 'compact'.
18	*
19	* @return array
20	*/
21	public static function get_option_names( $type = 'compact' ) {
22	switch ( $type ) {
23	case 'non-compact' :
24	case 'non_compact' :
25	return array(
26	'activated',
27	'active_modules',
28	'available_modules',
29	'do_activate',
30	'edit_links_calypso_redirect', // (bool) Whether post/page edit links on front end should point to Calypso.
31	'log',
32	'slideshow_background_color',
33	'widget_twitter',
34	'wpcc_options',
35	'relatedposts',
36	'file_data',
37	'autoupdate_plugins', // (array) An array of plugin ids ( eg. jetpack/jetpack ) that should be autoupdated
38	'autoupdate_plugins_translations', // (array) An array of plugin ids ( eg. jetpack/jetpack ) that should be autoupdated translation files.
39	'autoupdate_themes', // (array) An array of theme ids ( eg. twentyfourteen ) that should be autoupdated
40	'autoupdate_themes_translations', // (array) An array of theme ids ( eg. twentyfourteen ) that should autoupdated translation files.
41	'autoupdate_core', // (bool) Whether or not to autoupdate core
42	'autoupdate_translations', // (bool) Whether or not to autoupdate all translations
43	'json_api_full_management', // (bool) Allow full management (eg. Activate, Upgrade plugins) of the site via the JSON API.
44	'sync_non_public_post_stati', // (bool) Allow synchronisation of posts and pages with non-public status.
45	'site_icon_url', // (string) url to the full site icon
46	'site_icon_id', // (int) Attachment id of the site icon file
47	'dismissed_manage_banner', // (bool) Dismiss Jetpack manage banner allows the user to dismiss the banner permanently
48	'restapi_stats_cache', // (array) Stats Cache data.
49	'unique_connection', // (array) A flag to determine a unique connection to wordpress.com two values "connected" and "disconnected" with values for how many times each has occured
50	'protect_whitelist', // (array) IP Address for the Protect module to ignore
51	'sync_error_idc', // (bool\|array) false or array containing the site's home and siteurl at time of IDC error
52	'safe_mode_confirmed', // (bool) True if someone confirms that this site was correctly put into safe mode automatically after an identity crisis is discovered.
53	'migrate_for_idc', // (bool) True if someone confirms that this site should migrate stats and subscribers from its previous URL
54	'dismissed_connection_banner', // (bool) True if the connection banner has been dismissed
55	'onboarding', // (string) Auth token to be used in the onboarding connection flow
56	'tos_agreed', // (bool) Whether or not the TOS for connection has been agreed upon.
57	);
58
59	case 'private' :
60	return array(
61	'blog_token', // (string) The Client Secret/Blog Token of this site.
62	'user_token', // (string) The User Token of this site. (deprecated)
63	'user_tokens' // (array) User Tokens for each user of this site who has connected to jetpack.wordpress.com.
64	);
65
66	case 'network' :
67	return array(
68	'onboarding', // (string) Auth token to be used in the onboarding connection flow
69	'file_data' // (array) List of absolute paths to all Jetpack modules
70	);
71	}
72
73	return array(
74	'id', // (int) The Client ID/WP.com Blog ID of this site.
75	'publicize_connections', // (array) An array of Publicize connections from WordPress.com
76	'master_user', // (int) The local User ID of the user who connected this site to jetpack.wordpress.com.
77	'version', // (string) Used during upgrade procedure to auto-activate new modules. version:time
78	'old_version', // (string) Used to determine which modules are the most recently added. previous_version:time
79	'fallback_no_verify_ssl_certs', // (int) Flag for determining if this host must skip SSL Certificate verification due to misconfigured SSL.
80	'time_diff', // (int) Offset between Jetpack server's clocks and this server's clocks. Jetpack Server Time = time() + (int) Jetpack_Options::get_option( 'time_diff' )
81	'public', // (int\|bool) If we think this site is public or not (1, 0), false if we haven't yet tried to figure it out.
82	'videopress', // (array) VideoPress options array.
83	'is_network_site', // (int\|bool) If we think this site is a network or a single blog (1, 0), false if we haven't yet tried to figue it out.
84	'social_links', // (array) The specified links for each social networking site.
85	'identity_crisis_whitelist', // (array) An array of options, each having an array of the values whitelisted for it.
86	'gplus_authors', // (array) The Google+ authorship information for connected users.
87	'last_heartbeat', // (int) The timestamp of the last heartbeat that fired.
88	'jumpstart', // (string) A flag for whether or not to show the Jump Start. Accepts: new_connection, jumpstart_activated, jetpack_action_taken, jumpstart_dismissed.
89	'hide_jitm', // (array) A list of just in time messages that we should not show because they have been dismissed by the user
90	'custom_css_4.7_migration', // (bool) Whether Custom CSS has scanned for and migrated any legacy CSS CPT entries to the new Core format.
91	'image_widget_migration', // (bool) Whether any legacy Image Widgets have been converted to the new Core widget
92	'gallery_widget_migration', // (bool) Whether any legacy Gallery Widgets have been converted to the new Core widget
93	);
94	}
95
96	/**
97	* Is the option name valid?
98	*
99	* @param string $name The name of the option
100	* @param string\|null $group The name of the group that the option is in. Default to null, which will search non_compact.
101	*
102	* @return bool Is the option name valid?
103	*/
104	public static function is_valid( $name, $group = null ) {
105	if ( is_array( $name ) ) {
106	$compact_names = array();
107	foreach ( array_keys( self::$grouped_options ) as $_group ) {
108	$compact_names = array_merge( $compact_names, self::get_option_names( $_group ) );
109	}
110
111	$result = array_diff( $name, self::get_option_names( 'non_compact' ), $compact_names );
112
113	return empty( $result );
114	}
115
116	if ( is_null( $group ) \|\| 'non_compact' === $group ) {
117	if ( in_array( $name, self::get_option_names( $group ) ) ) {
118	return true;
119	}
120	}
121
122	foreach ( array_keys( self::$grouped_options ) as $_group ) {
123	if ( is_null( $group ) \|\| $group === $_group ) {
124	if ( in_array( $name, self::get_option_names( $_group ) ) ) {
125	return true;
126	}
127	}
128	}
129
130	return false;
131	}
132
133	/**
134	* Checks if an option must be saved for the whole network in WP Multisite
135	*
136	* @param string $option_name Option name. It must come _without_ `jetpack_%` prefix. The method will prefix the option name.
137	*
138	* @return bool
139	*/
140	public static function is_network_option( $option_name ) {
141	if ( ! is_multisite() ) {
142	return false;
143	}
144	return in_array( $option_name, self::get_option_names( 'network' ) );
145	}
146
147	/**
148	* Returns the requested option. Looks in jetpack_options or jetpack_$name as appropriate.
149	*
150	* @param string $name Option name. It must come _without_ `jetpack_%` prefix. The method will prefix the option name.
151	* @param mixed $default (optional)
152	*
153	* @return mixed
154	*/
155	public static function get_option( $name, $default = false ) {
156	if ( self::is_valid( $name, 'non_compact' ) ) {
157	if ( self::is_network_option( $name ) ) {
158	return get_site_option( "jetpack_$name", $default );
159	}
160
161	return get_option( "jetpack_$name", $default );
162	}
163
164	foreach ( array_keys( self::$grouped_options ) as $group ) {
165	if ( self::is_valid( $name, $group ) ) {
166	return self::get_grouped_option( $group, $name, $default );
167	}
168	}
169
170	trigger_error( sprintf( 'Invalid Jetpack option name: %s', $name ), E_USER_WARNING );
171
172	return $default;
173	}
174
175	/**
176	* Returns the requested option, and ensures it's autoloaded in the future.
177	* This does _not_ adjust the prefix in any way (does not prefix jetpack_%)
178	*
179	* @param string $name Option name
180	* @param mixed $default (optional)
181	*
182	* @return mixed
183	*/
184	public static function get_option_and_ensure_autoload( $name, $default ) {
185	// In this function the name is not adjusted by prefixing jetpack_
186	// so if it has already prefixed, we'll replace it and then
187	// check if the option name is a network option or not
188	$jetpack_name = preg_replace( '/^jetpack_/', '', $name, 1 );
189	$is_network_option = self::is_network_option( $jetpack_name );
190	$value = $is_network_option ? get_site_option( $name ) : get_option( $name );
191
192	if ( false === $value && false !== $default ) {
193	if ( $is_network_option ) {
194	update_site_option( $name, $default );
195	} else {
196	update_option( $name, $default );
197	}
198	$value = $default;
199	}
200
201	return $value;
202	}
203
204	private static function update_grouped_option( $group, $name, $value ) {
205	$options = get_option( self::$grouped_options[ $group ] );
206	if ( ! is_array( $options ) ) {
207	$options = array();
208	}
209	$options[ $name ] = $value;
210
211	return update_option( self::$grouped_options[ $group ], $options );
212	}
213
214	/**
215	* Updates the single given option. Updates jetpack_options or jetpack_$name as appropriate.
216	*
217	* @param string $name Option name. It must come _without_ `jetpack_%` prefix. The method will prefix the option name.
218	* @param mixed $value Option value
219	* @param string $autoload If not compact option, allows specifying whether to autoload or not.
220	*
221	* @return bool Was the option successfully updated?
222	*/
223	public static function update_option( $name, $value, $autoload = null ) {
224	/**
225	* Fires before Jetpack updates a specific option.
226	*
227	* @since 3.0.0
228	*
229	* @param str $name The name of the option being updated.
230	* @param mixed $value The new value of the option.
231	*/
232	do_action( 'pre_update_jetpack_option_' . $name, $name, $value );
233	if ( self::is_valid( $name, 'non_compact' ) ) {
234	if ( self::is_network_option( $name ) ) {
235	return update_site_option( "jetpack_$name", $value );
236	}
237
238	return update_option( "jetpack_$name", $value, $autoload );
239
240	}
241
242	foreach ( array_keys( self::$grouped_options ) as $group ) {
243	if ( self::is_valid( $name, $group ) ) {
244	return self::update_grouped_option( $group, $name, $value );
245	}
246	}
247
248	trigger_error( sprintf( 'Invalid Jetpack option name: %s', $name ), E_USER_WARNING );
249
250	return false;
251	}
252
253	/**
254	* Updates the multiple given options. Updates jetpack_options and/or jetpack_$name as appropriate.
255	*
256	* @param array $array array( option name => option value, ... )
257	*/
258	public static function update_options( $array ) {
259	$names = array_keys( $array );
260
261	foreach ( array_diff( $names, self::get_option_names(), self::get_option_names( 'non_compact' ), self::get_option_names( 'private' ) ) as $unknown_name ) {
262	trigger_error( sprintf( 'Invalid Jetpack option name: %s', $unknown_name ), E_USER_WARNING );
263	unset( $array[ $unknown_name ] );
264	}
265
266	foreach ( $names as $name ) {
267	self::update_option( $name, $array[ $name ] );
268	}
269	}
270
271	/**
272	* Deletes the given option. May be passed multiple option names as an array.
273	* Updates jetpack_options and/or deletes jetpack_$name as appropriate.
274	*
275	* @param string\|array $names Option names. They must come _without_ `jetpack_%` prefix. The method will prefix the option names.
276	*
277	* @return bool Was the option successfully deleted?
278	*/
279	public static function delete_option( $names ) {
280	$result = true;
281	$names = (array) $names;
282
283	if ( ! self::is_valid( $names ) ) {
284	trigger_error( sprintf( 'Invalid Jetpack option names: %s', print_r( $names, 1 ) ), E_USER_WARNING );
285	return false;
286	}
287
288	foreach ( array_intersect( $names, self::get_option_names( 'non_compact' ) ) as $name ) {
289	if ( self::is_network_option( $name ) ) {
290	$result = delete_site_option( "jetpack_$name" );
291	} else {
292	$result = delete_option( "jetpack_$name" );
293	}
294
295	}
296
297	foreach ( array_keys( self::$grouped_options ) as $group ) {
298	if ( ! self::delete_grouped_option( $group, $names ) ) {
299	$result = false;
300	}
301	}
302
303	return $result;
304	}
305
306	private static function get_grouped_option( $group, $name, $default ) {
307	$options = get_option( self::$grouped_options[ $group ] );
308	if ( is_array( $options ) && isset( $options[ $name ] ) ) {
309	return $options[ $name ];
310	}
311
312	return $default;
313	}
314
315	private static function delete_grouped_option( $group, $names ) {
316	$options = get_option( self::$grouped_options[ $group ], array() );
317
318	$to_delete = array_intersect( $names, self::get_option_names( $group ), array_keys( $options ) );
319	if ( $to_delete ) {
320	foreach ( $to_delete as $name ) {
321	unset( $options[ $name ] );
322	}
323
324	return update_option( self::$grouped_options[ $group ], $options );
325	}
326
327	return true;
328	}
329
330	// Raw option methods allow Jetpack to get / update / delete options via direct DB queries, including options
331	// that are not created by the Jetpack plugin. This is helpful only in rare cases when we need to bypass
332	// cache and filters.
333
334	/**
335	* Deletes an option via $wpdb query.
336	*
337	* @param string $name Option name.
338	*
339	* @return bool Is the option deleted?
340	*/
341	static function delete_raw_option( $name ) {
342	if ( self::bypass_raw_option( $name ) ) {
343	return delete_option( $name );
344	}
345	global $wpdb;
346	$result = $wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->options WHERE option_name = %s", $name ) );
347	return $result;
348	}
349
350	/**
351	* Updates an option via $wpdb query.
352	*
353	* @param string $name Option name.
354	* @param mixed $value Option value.
355	* @param bool $autoload Specifying whether to autoload or not.
356	*
357	* @return bool Is the option updated?
358	*/
359	static function update_raw_option( $name, $value, $autoload = false ) {
360	if ( self::bypass_raw_option( $name ) ) {
361	return update_option( $name, $value, $autoload );
362	}
363	global $wpdb;
364	$autoload_value = $autoload ? 'yes' : 'no';
365
366	$serialized_value = maybe_serialize( $value );
367	// try updating, if no update then insert
368	// TODO: try to deal with the fact that unchanged values can return updated_num = 0
369	// below we used "insert ignore" to at least suppress the resulting error
370	$updated_num = $wpdb->query(
371	$wpdb->prepare(
372	"UPDATE $wpdb->options SET option_value = %s WHERE option_name = %s",
373	$serialized_value,
374	$name
375	)
376	);
377
378	if ( ! $updated_num ) {
379	$updated_num = $wpdb->query(
380	$wpdb->prepare(
381	"INSERT IGNORE INTO $wpdb->options ( option_name, option_value, autoload ) VALUES ( %s, %s, '$autoload_value' )",
382	$name,
383	$serialized_value
384	)
385	);
386	}
387	return $updated_num;
388	}
389
390	/**
391	* Gets an option via $wpdb query.
392	*
393	* @since 5.4.0
394	*
395	* @param string $name Option name.
396	* @param mixed $default Default option value if option is not found.
397	*
398	* @return mixed Option value, or null if option is not found and default is not specified.
399	*/
400	static function get_raw_option( $name, $default = null ) {
401	if ( self::bypass_raw_option( $name ) ) {
402	return get_option( $name, $default );
403	}
404
405	global $wpdb;
406	$value = $wpdb->get_var(
407	$wpdb->prepare(
408	"SELECT option_value FROM $wpdb->options WHERE option_name = %s LIMIT 1",
409	$name
410	)
411	);
412	$value = maybe_unserialize( $value );
413
414	if ( $value === null && $default !== null ) {
415	return $default;
416	}
417
418	return $value;
419	}
420
421	/**
422	* This function checks for a constant that, if present, will disable direct DB queries Jetpack uses to manage certain options and force Jetpack to always use Options API instead.
423	* Options can be selectively managed via a blacklist by filtering option names via the jetpack_disabled_raw_option filter.
424	*
425	* @param $name Option name
426	*
427	* @return bool
428	*/
429	static function bypass_raw_option( $name ) {
430
431	if ( Jetpack_Constants::get_constant( 'JETPACK_DISABLE_RAW_OPTIONS' ) ) {
432	return true;
433	}
434	/**
435	* Allows to disable particular raw options.
436	* @since 5.5.0
437	*
438	* @param array $disabled_raw_options An array of option names that you can selectively blacklist from being managed via direct database queries.
439	*/
440	$disabled_raw_options = apply_filters( 'jetpack_disabled_raw_options', array() );
441	return isset( $disabled_raw_options[ $name ] );
442	}
443
444	/**
445	* Gets all known options that are used by Jetpack and managed by Jetpack_Options.
446	*
447	* @since 5.4.0
448	*
449	* @param boolean $strip_unsafe_options If true, and by default, will strip out options necessary for the connection to WordPress.com.
450	* @return array An array of all options managed via the Jetpack_Options class.
451	*/
452	static function get_all_jetpack_options( $strip_unsafe_options = true ) {
453	$jetpack_options = self::get_option_names();
454	$jetpack_options_non_compat = self::get_option_names( 'non_compact' );
455	$jetpack_options_private = self::get_option_names( 'private' );
456
457	$all_jp_options = array_merge( $jetpack_options, $jetpack_options_non_compat, $jetpack_options_private );
458
459	if ( $strip_unsafe_options ) {
460	// Flag some Jetpack options as unsafe
461	$unsafe_options = array(
462	'id', // (int) The Client ID/WP.com Blog ID of this site.
463	'master_user', // (int) The local User ID of the user who connected this site to jetpack.wordpress.com.
464	'version', // (string) Used during upgrade procedure to auto-activate new modules. version:time
465	'jumpstart', // (string) A flag for whether or not to show the Jump Start. Accepts: new_connection, jumpstart_activated, jetpack_action_taken, jumpstart_dismissed.
466
467	// non_compact
468	'activated',
469
470	// private
471	'register',
472	'blog_token', // (string) The Client Secret/Blog Token of this site.
473	'user_token', // (string) The User Token of this site. (deprecated)
474	'user_tokens'
475	);
476
477	// Remove the unsafe Jetpack options
478	foreach ( $unsafe_options as $unsafe_option ) {
479	if ( false !== ( $key = array_search( $unsafe_option, $all_jp_options ) ) ) {
480	unset( $all_jp_options[ $key ] );
481	}
482	}
483	}
484
485	return $all_jp_options;
486	}
487
488	/**
489	* Get all options that are not managed by the Jetpack_Options class that are used by Jetpack.
490	*
491	* @since 5.4.0
492	*
493	* @return array
494	*/
495	static function get_all_wp_options() {
496	// A manual build of the wp options
497	return array(
498	'sharing-options',
499	'disabled_likes',
500	'disabled_reblogs',
501	'jetpack_comments_likes_enabled',
502	'wp_mobile_excerpt',
503	'wp_mobile_featured_images',
504	'wp_mobile_app_promos',
505	'stats_options',
506	'stats_dashboard_widget',
507	'safecss_preview_rev',
508	'safecss_rev',
509	'safecss_revision_migrated',
510	'nova_menu_order',
511	'jetpack_portfolio',
512	'jetpack_portfolio_posts_per_page',
513	'jetpack_testimonial',
514	'jetpack_testimonial_posts_per_page',
515	'wp_mobile_custom_css',
516	'sharedaddy_disable_resources',
517	'sharing-options',
518	'sharing-services',
519	'site_icon_temp_data',
520	'featured-content',
521	'site_logo',
522	'jetpack_dismissed_notices',
523	'jetpack-twitter-cards-site-tag',
524	'jetpack-sitemap-state',
525	'jetpack_sitemap_post_types',
526	'jetpack_sitemap_location',
527	'jetpack_protect_key',
528	'jetpack_protect_blocked_attempts',
529	'jetpack_protect_activating',
530	'jetpack_connection_banner_ab',
531	'jetpack_active_plan',
532	'jetpack_activation_source',
533	'jetpack_sso_match_by_email',
534	'jetpack_sso_require_two_step',
535	'jetpack_sso_remove_login_form',
536	'jetpack_last_connect_url_check',
537	'jpo_business_address',
538	'jpo_site_type',
539	'jpo_homepage_format',
540	'jpo_contact_page',
541	);
542	}
543
544	/**
545	* Gets all options that can be safely reset by CLI.
546	*
547	* @since 5.4.0
548	*
549	* @return array array Associative array containing jp_options which are managed by the Jetpack_Options class and wp_options which are not.
550	*/
551	static function get_options_for_reset() {
552	$all_jp_options = self::get_all_jetpack_options();
553
554	$wp_options = self::get_all_wp_options();
555
556	$options = array(
557	'jp_options' => $all_jp_options,
558	'wp_options' => $wp_options
559	);
560
561	return $options;
562	}
563
564	/**
565	* Delete all known options
566	*
567	* @since 5.4.0
568	*
569	* @return void
570	*/
571	static function delete_all_known_options() {
572	// Delete all compact options
573	foreach ( (array) self::$grouped_options as $option_name ) {
574	delete_option( $option_name );
575	}
576
577	// Delete all non-compact Jetpack options
578	foreach ( (array) self::get_option_names( 'non-compact' ) as $option_name ) {
579	Jetpack_Options::delete_option( $option_name );
580	}
581
582	// Delete all options that can be reset via CLI, that aren't Jetpack options
583	foreach ( (array) self::get_all_wp_options() as $option_name ) {
584	delete_option( $option_name );
585	}
586	}
587	}
588