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

jetpack / class.jetpack-options.php

jetpack Last commit date

class.jetpack-options.php

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