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

jetpack / class.jetpack-options.php

jetpack Last commit date

class.jetpack-options.php

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