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

jetpack / class.jetpack-options.php

jetpack Last commit date

class.jetpack-options.php

288 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	'log',
31	'publicize',
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	);
55
56	case 'private' :
57	return array(
58	'register',
59	'authorize',
60	'activate_manage',
61	'blog_token', // (string) The Client Secret/Blog Token of this site.
62	'user_token', // (string) The User Token of this site. (deprecated)
63	'user_tokens' // (array) User Tokens for each user of this site who has connected to jetpack.wordpress.com.
64	);
65	}
66
67	return array(
68	'id', // (int) The Client ID/WP.com Blog ID of this site.
69	'publicize_connections', // (array) An array of Publicize connections from WordPress.com
70	'master_user', // (int) The local User ID of the user who connected this site to jetpack.wordpress.com.
71	'version', // (string) Used during upgrade procedure to auto-activate new modules. version:time
72	'old_version', // (string) Used to determine which modules are the most recently added. previous_version:time
73	'fallback_no_verify_ssl_certs', // (int) Flag for determining if this host must skip SSL Certificate verification due to misconfigured SSL.
74	'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' )
75	'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.
76	'videopress', // (array) VideoPress options array.
77	'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.
78	'social_links', // (array) The specified links for each social networking site.
79	'identity_crisis_whitelist', // (array) An array of options, each having an array of the values whitelisted for it.
80	'gplus_authors', // (array) The Google+ authorship information for connected users.
81	'last_heartbeat', // (int) The timestamp of the last heartbeat that fired.
82	'jumpstart', // (string) A flag for whether or not to show the Jump Start. Accepts: new_connection, jumpstart_activated, jetpack_action_taken, jumpstart_dismissed.
83	'hide_jitm', // (array) A list of just in time messages that we should not show because they have been dismissed by the user
84	'custom_css_4.7_migration', // (bool) Whether Custom CSS has scanned for and migrated any legacy CSS CPT entries to the new Core format.
85	);
86	}
87
88	/**
89	* Is the option name valid?
90	*
91	* @param string $name The name of the option
92	* @param string\|null $group The name of the group that the option is in. Default to null, which will search non_compact.
93	*
94	* @return bool Is the option name valid?
95	*/
96	public static function is_valid( $name, $group = null ) {
97	if ( is_array( $name ) ) {
98	$compact_names = array();
99	foreach ( array_keys( self::$grouped_options ) as $_group ) {
100	$compact_names = array_merge( $compact_names, self::get_option_names( $_group ) );
101	}
102
103	$result = array_diff( $name, self::get_option_names( 'non_compact' ), $compact_names );
104
105	return empty( $result );
106	}
107
108	if ( is_null( $group ) \|\| 'non_compact' === $group ) {
109	if ( in_array( $name, self::get_option_names( $group ) ) ) {
110	return true;
111	}
112	}
113
114	foreach ( array_keys( self::$grouped_options ) as $_group ) {
115	if ( is_null( $group ) \|\| $group === $_group ) {
116	if ( in_array( $name, self::get_option_names( $_group ) ) ) {
117	return true;
118	}
119	}
120	}
121
122	return false;
123	}
124
125	/**
126	* Returns the requested option. Looks in jetpack_options or jetpack_$name as appropriate.
127	*
128	* @param string $name Option name
129	* @param mixed $default (optional)
130	*
131	* @return mixed
132	*/
133	public static function get_option( $name, $default = false ) {
134	if ( self::is_valid( $name, 'non_compact' ) ) {
135	return get_option( "jetpack_$name", $default );
136	}
137
138	foreach ( array_keys( self::$grouped_options ) as $group ) {
139	if ( self::is_valid( $name, $group ) ) {
140	return self::get_grouped_option( $group, $name, $default );
141	}
142	}
143
144	trigger_error( sprintf( 'Invalid Jetpack option name: %s', $name ), E_USER_WARNING );
145
146	return $default;
147	}
148
149	/**
150	* Returns the requested option, and ensures it's autoloaded in the future.
151	* This does _not_ adjust the prefix in any way (does not prefix jetpack_%)
152	*
153	* @param string $name Option name
154	* @param mixed $default (optional)
155	*
156	* @return mixed\|void
157	*/
158	public static function get_option_and_ensure_autoload( $name, $default ) {
159	$value = get_option( $name );
160
161	if ( $value === false && $default !== false ) {
162	update_option( $name, $default );
163	$value = $default;
164	}
165
166	return $value;
167	}
168
169	private static function update_grouped_option( $group, $name, $value ) {
170	$options = get_option( self::$grouped_options[ $group ] );
171	if ( ! is_array( $options ) ) {
172	$options = array();
173	}
174	$options[ $name ] = $value;
175
176	return update_option( self::$grouped_options[ $group ], $options );
177	}
178
179	/**
180	* Updates the single given option. Updates jetpack_options or jetpack_$name as appropriate.
181	*
182	* @param string $name Option name
183	* @param mixed $value Option value
184	* @param string $autoload If not compact option, allows specifying whether to autoload or not.
185	*
186	* @return bool Was the option successfully updated?
187	*/
188	public static function update_option( $name, $value, $autoload = null ) {
189	/**
190	* Fires before Jetpack updates a specific option.
191	*
192	* @since 3.0.0
193	*
194	* @param str $name The name of the option being updated.
195	* @param mixed $value The new value of the option.
196	*/
197	do_action( 'pre_update_jetpack_option_' . $name, $name, $value );
198	if ( self::is_valid( $name, 'non_compact' ) ) {
199	return update_option( "jetpack_$name", $value, $autoload );
200	}
201
202	foreach ( array_keys( self::$grouped_options ) as $group ) {
203	if ( self::is_valid( $name, $group ) ) {
204	return self::update_grouped_option( $group, $name, $value );
205	}
206	}
207
208	trigger_error( sprintf( 'Invalid Jetpack option name: %s', $name ), E_USER_WARNING );
209
210	return false;
211	}
212
213	/**
214	* Updates the multiple given options. Updates jetpack_options and/or jetpack_$name as appropriate.
215	*
216	* @param array $array array( option name => option value, ... )
217	*/
218	public static function update_options( $array ) {
219	$names = array_keys( $array );
220
221	foreach ( array_diff( $names, self::get_option_names(), self::get_option_names( 'non_compact' ), self::get_option_names( 'private' ) ) as $unknown_name ) {
222	trigger_error( sprintf( 'Invalid Jetpack option name: %s', $unknown_name ), E_USER_WARNING );
223	unset( $array[ $unknown_name ] );
224	}
225
226	foreach ( $names as $name ) {
227	self::update_option( $name, $array[ $name ] );
228	}
229	}
230
231	/**
232	* Deletes the given option. May be passed multiple option names as an array.
233	* Updates jetpack_options and/or deletes jetpack_$name as appropriate.
234	*
235	* @param string\|array $names
236	*
237	* @return bool Was the option successfully deleted?
238	*/
239	public static function delete_option( $names ) {
240	$result = true;
241	$names = (array) $names;
242
243	if ( ! self::is_valid( $names ) ) {
244	trigger_error( sprintf( 'Invalid Jetpack option names: %s', print_r( $names, 1 ) ), E_USER_WARNING );
245	return false;
246	}
247
248	foreach ( array_intersect( $names, self::get_option_names( 'non_compact' ) ) as $name ) {
249	if ( ! delete_option( "jetpack_$name" ) ) {
250	$result = false;
251	}
252	}
253
254	foreach ( array_keys( self::$grouped_options ) as $group ) {
255	if ( ! self::delete_grouped_option( $group, $names ) ) {
256	$result = false;
257	}
258	}
259
260	return $result;
261	}
262
263	private static function get_grouped_option( $group, $name, $default ) {
264	$options = get_option( self::$grouped_options[ $group ] );
265	if ( is_array( $options ) && isset( $options[ $name ] ) ) {
266	return $options[ $name ];
267	}
268
269	return $default;
270	}
271
272	private static function delete_grouped_option( $group, $names ) {
273	$options = get_option( self::$grouped_options[ $group ], array() );
274
275	$to_delete = array_intersect( $names, self::get_option_names( $group ), array_keys( $options ) );
276	if ( $to_delete ) {
277	foreach ( $to_delete as $name ) {
278	unset( $options[ $name ] );
279	}
280
281	return update_option( self::$grouped_options[ $group ], $options );
282	}
283
284	return true;
285	}
286
287	}
288