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

jetpack / class.jetpack-options.php

jetpack Last commit date

class.jetpack-options.php

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