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

jetpack / class.jetpack-options.php

jetpack Last commit date

class.jetpack-options.php

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