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

jetpack / class.jetpack-options.php

jetpack Last commit date

class.jetpack-options.php

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