PluginProbe
Jetpack – WP Security, Backup, Speed, & Growth / 7.5.1
Jetpack – WP Security, Backup, Speed, & Growth v7.5.1
12.0.3 12.1.3 12.2.3 12.3.2 12.4.2 12.5.2 12.6.4 12.7.3 12.8.3 12.9.5 13.0.2 13.1.5 13.2.4 13.3.3 13.4.5 13.5.2 13.6.2 13.7.2 13.8.3 13.9.2 14.0.1 14.1.1 14.2.2 14.3.1 14.4.2 All 500 releases
jetpack / class.jetpack.php
class.jetpack.php
7,169 lines 233.5 KB
No matching file
Up and down to move Enter to open Esc to close
Raw Download Zip
1 <?php
2
3 use Automattic\Jetpack\Assets\Logo as Jetpack_Logo;
4 use Automattic\Jetpack\Connection\Client;
5 use Automattic\Jetpack\Connection\Manager as Connection_Manager;
6 use Automattic\Jetpack\Connection\REST_Connector as REST_Connector;
7 use Automattic\Jetpack\Connection\XMLRPC_Connector as XMLRPC_Connector;
8 use Automattic\Jetpack\Constants;
9 use Automattic\Jetpack\Sync\Functions;
10 use Automattic\Jetpack\Sync\Sender;
11 use Automattic\Jetpack\Sync\Users;
12 use Automattic\Jetpack\Tracking;
13 use Automattic\Jetpack\Assets;
14
15 /*
16 Options:
17 jetpack_options (array)
18 An array of options.
19 @see Jetpack_Options::get_option_names()
20
21 jetpack_register (string)
22 Temporary verification secrets.
23
24 jetpack_activated (int)
25 1: the plugin was activated normally
26 2: the plugin was activated on this site because of a network-wide activation
27 3: the plugin was auto-installed
28 4: the plugin was manually disconnected (but is still installed)
29
30 jetpack_active_modules (array)
31 Array of active module slugs.
32
33 jetpack_do_activate (bool)
34 Flag for "activating" the plugin on sites where the activation hook never fired (auto-installs)
35 */
36
37 require_once( JETPACK__PLUGIN_DIR . '_inc/lib/class.media.php' );
38
39 class Jetpack {
40 public $xmlrpc_server = null;
41
42 private $xmlrpc_verification = null;
43 private $rest_authentication_status = null;
44
45 public $HTTP_RAW_POST_DATA = null; // copy of $GLOBALS['HTTP_RAW_POST_DATA']
46
47 private $tracking;
48
49 /**
50 * @var array The handles of styles that are concatenated into jetpack.css.
51 *
52 * When making changes to that list, you must also update concat_list in tools/builder/frontend-css.js.
53 */
54 public $concatenated_style_handles = array(
55 'jetpack-carousel',
56 'grunion.css',
57 'the-neverending-homepage',
58 'jetpack_likes',
59 'jetpack_related-posts',
60 'sharedaddy',
61 'jetpack-slideshow',
62 'presentations',
63 'quiz',
64 'jetpack-subscriptions',
65 'jetpack-responsive-videos-style',
66 'jetpack-social-menu',
67 'tiled-gallery',
68 'jetpack_display_posts_widget',
69 'gravatar-profile-widget',
70 'goodreads-widget',
71 'jetpack_social_media_icons_widget',
72 'jetpack-top-posts-widget',
73 'jetpack_image_widget',
74 'jetpack-my-community-widget',
75 'jetpack-authors-widget',
76 'wordads',
77 'eu-cookie-law-style',
78 'flickr-widget-style',
79 'jetpack-search-widget',
80 'jetpack-simple-payments-widget-style',
81 'jetpack-widget-social-icons-styles',
82 );
83
84 /**
85 * Contains all assets that have had their URL rewritten to minified versions.
86 *
87 * @var array
88 */
89 static $min_assets = array();
90
91 public $plugins_to_deactivate = array(
92 'stats' => array( 'stats/stats.php', 'WordPress.com Stats' ),
93 'shortlinks' => array( 'stats/stats.php', 'WordPress.com Stats' ),
94 'sharedaddy' => array( 'sharedaddy/sharedaddy.php', 'Sharedaddy' ),
95 'twitter-widget' => array( 'wickett-twitter-widget/wickett-twitter-widget.php', 'Wickett Twitter Widget' ),
96 'contact-form' => array( 'grunion-contact-form/grunion-contact-form.php', 'Grunion Contact Form' ),
97 'contact-form' => array( 'mullet/mullet-contact-form.php', 'Mullet Contact Form' ),
98 'custom-css' => array( 'safecss/safecss.php', 'WordPress.com Custom CSS' ),
99 'random-redirect' => array( 'random-redirect/random-redirect.php', 'Random Redirect' ),
100 'videopress' => array( 'video/video.php', 'VideoPress' ),
101 'widget-visibility' => array( 'jetpack-widget-visibility/widget-visibility.php', 'Jetpack Widget Visibility' ),
102 'widget-visibility' => array( 'widget-visibility-without-jetpack/widget-visibility-without-jetpack.php', 'Widget Visibility Without Jetpack' ),
103 'sharedaddy' => array( 'jetpack-sharing/sharedaddy.php', 'Jetpack Sharing' ),
104 'gravatar-hovercards' => array( 'jetpack-gravatar-hovercards/gravatar-hovercards.php', 'Jetpack Gravatar Hovercards' ),
105 'latex' => array( 'wp-latex/wp-latex.php', 'WP LaTeX' )
106 );
107
108 static $capability_translations = array(
109 'administrator' => 'manage_options',
110 'editor' => 'edit_others_posts',
111 'author' => 'publish_posts',
112 'contributor' => 'edit_posts',
113 'subscriber' => 'read',
114 );
115
116 /**
117 * Map of modules that have conflicts with plugins and should not be auto-activated
118 * if the plugins are active. Used by filter_default_modules
119 *
120 * Plugin Authors: If you'd like to prevent a single module from auto-activating,
121 * change `module-slug` and add this to your plugin:
122 *
123 * add_filter( 'jetpack_get_default_modules', 'my_jetpack_get_default_modules' );
124 * function my_jetpack_get_default_modules( $modules ) {
125 * return array_diff( $modules, array( 'module-slug' ) );
126 * }
127 *
128 * @var array
129 */
130 private $conflicting_plugins = array(
131 'comments' => array(
132 'Intense Debate' => 'intensedebate/intensedebate.php',
133 'Disqus' => 'disqus-comment-system/disqus.php',
134 'Livefyre' => 'livefyre-comments/livefyre.php',
135 'Comments Evolved for WordPress' => 'gplus-comments/comments-evolved.php',
136 'Google+ Comments' => 'google-plus-comments/google-plus-comments.php',
137 'WP-SpamShield Anti-Spam' => 'wp-spamshield/wp-spamshield.php',
138 ),
139 'comment-likes' => array(
140 'Epoch' => 'epoch/plugincore.php',
141 ),
142 'contact-form' => array(
143 'Contact Form 7' => 'contact-form-7/wp-contact-form-7.php',
144 'Gravity Forms' => 'gravityforms/gravityforms.php',
145 'Contact Form Plugin' => 'contact-form-plugin/contact_form.php',
146 'Easy Contact Forms' => 'easy-contact-forms/easy-contact-forms.php',
147 'Fast Secure Contact Form' => 'si-contact-form/si-contact-form.php',
148 'Ninja Forms' => 'ninja-forms/ninja-forms.php',
149 ),
150 'minileven' => array(
151 'WPtouch' => 'wptouch/wptouch.php',
152 ),
153 'latex' => array(
154 'LaTeX for WordPress' => 'latex/latex.php',
155 'Youngwhans Simple Latex' => 'youngwhans-simple-latex/yw-latex.php',
156 'Easy WP LaTeX' => 'easy-wp-latex-lite/easy-wp-latex-lite.php',
157 'MathJax-LaTeX' => 'mathjax-latex/mathjax-latex.php',
158 'Enable Latex' => 'enable-latex/enable-latex.php',
159 'WP QuickLaTeX' => 'wp-quicklatex/wp-quicklatex.php',
160 ),
161 'protect' => array(
162 'Limit Login Attempts' => 'limit-login-attempts/limit-login-attempts.php',
163 'Captcha' => 'captcha/captcha.php',
164 'Brute Force Login Protection' => 'brute-force-login-protection/brute-force-login-protection.php',
165 'Login Security Solution' => 'login-security-solution/login-security-solution.php',
166 'WPSecureOps Brute Force Protect' => 'wpsecureops-bruteforce-protect/wpsecureops-bruteforce-protect.php',
167 'BulletProof Security' => 'bulletproof-security/bulletproof-security.php',
168 'SiteGuard WP Plugin' => 'siteguard/siteguard.php',
169 'Security-protection' => 'security-protection/security-protection.php',
170 'Login Security' => 'login-security/login-security.php',
171 'Botnet Attack Blocker' => 'botnet-attack-blocker/botnet-attack-blocker.php',
172 'Wordfence Security' => 'wordfence/wordfence.php',
173 'All In One WP Security & Firewall' => 'all-in-one-wp-security-and-firewall/wp-security.php',
174 'iThemes Security' => 'better-wp-security/better-wp-security.php',
175 ),
176 'random-redirect' => array(
177 'Random Redirect 2' => 'random-redirect-2/random-redirect.php',
178 ),
179 'related-posts' => array(
180 'YARPP' => 'yet-another-related-posts-plugin/yarpp.php',
181 'WordPress Related Posts' => 'wordpress-23-related-posts-plugin/wp_related_posts.php',
182 'nrelate Related Content' => 'nrelate-related-content/nrelate-related.php',
183 'Contextual Related Posts' => 'contextual-related-posts/contextual-related-posts.php',
184 'Related Posts for WordPress' => 'microkids-related-posts/microkids-related-posts.php',
185 'outbrain' => 'outbrain/outbrain.php',
186 'Shareaholic' => 'shareaholic/shareaholic.php',
187 'Sexybookmarks' => 'sexybookmarks/shareaholic.php',
188 ),
189 'sharedaddy' => array(
190 'AddThis' => 'addthis/addthis_social_widget.php',
191 'Add To Any' => 'add-to-any/add-to-any.php',
192 'ShareThis' => 'share-this/sharethis.php',
193 'Shareaholic' => 'shareaholic/shareaholic.php',
194 ),
195 'seo-tools' => array(
196 'WordPress SEO by Yoast' => 'wordpress-seo/wp-seo.php',
197 'WordPress SEO Premium by Yoast' => 'wordpress-seo-premium/wp-seo-premium.php',
198 'All in One SEO Pack' => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
199 'All in One SEO Pack Pro' => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
200 'The SEO Framework' => 'autodescription/autodescription.php',
201 ),
202 'verification-tools' => array(
203 'WordPress SEO by Yoast' => 'wordpress-seo/wp-seo.php',
204 'WordPress SEO Premium by Yoast' => 'wordpress-seo-premium/wp-seo-premium.php',
205 'All in One SEO Pack' => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
206 'All in One SEO Pack Pro' => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
207 'The SEO Framework' => 'autodescription/autodescription.php',
208 ),
209 'widget-visibility' => array(
210 'Widget Logic' => 'widget-logic/widget_logic.php',
211 'Dynamic Widgets' => 'dynamic-widgets/dynamic-widgets.php',
212 ),
213 'sitemaps' => array(
214 'Google XML Sitemaps' => 'google-sitemap-generator/sitemap.php',
215 'Better WordPress Google XML Sitemaps' => 'bwp-google-xml-sitemaps/bwp-simple-gxs.php',
216 'Google XML Sitemaps for qTranslate' => 'google-xml-sitemaps-v3-for-qtranslate/sitemap.php',
217 'XML Sitemap & Google News feeds' => 'xml-sitemap-feed/xml-sitemap.php',
218 'Google Sitemap by BestWebSoft' => 'google-sitemap-plugin/google-sitemap-plugin.php',
219 'WordPress SEO by Yoast' => 'wordpress-seo/wp-seo.php',
220 'WordPress SEO Premium by Yoast' => 'wordpress-seo-premium/wp-seo-premium.php',
221 'All in One SEO Pack' => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
222 'All in One SEO Pack Pro' => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
223 'The SEO Framework' => 'autodescription/autodescription.php',
224 'Sitemap' => 'sitemap/sitemap.php',
225 'Simple Wp Sitemap' => 'simple-wp-sitemap/simple-wp-sitemap.php',
226 'Simple Sitemap' => 'simple-sitemap/simple-sitemap.php',
227 'XML Sitemaps' => 'xml-sitemaps/xml-sitemaps.php',
228 'MSM Sitemaps' => 'msm-sitemap/msm-sitemap.php',
229 ),
230 'lazy-images' => array(
231 'Lazy Load' => 'lazy-load/lazy-load.php',
232 'BJ Lazy Load' => 'bj-lazy-load/bj-lazy-load.php',
233 'Lazy Load by WP Rocket' => 'rocket-lazy-load/rocket-lazy-load.php',
234 ),
235 );
236
237 /**
238 * Plugins for which we turn off our Facebook OG Tags implementation.
239 *
240 * Note: All in One SEO Pack, All in one SEO Pack Pro, WordPress SEO by Yoast, and WordPress SEO Premium by Yoast automatically deactivate
241 * Jetpack's Open Graph tags via filter when their Social Meta modules are active.
242 *
243 * Plugin authors: If you'd like to prevent Jetpack's Open Graph tag generation in your plugin, you can do so via this filter:
244 * add_filter( 'jetpack_enable_open_graph', '__return_false' );
245 */
246 private $open_graph_conflicting_plugins = array(
247 '2-click-socialmedia-buttons/2-click-socialmedia-buttons.php',
248 // 2 Click Social Media Buttons
249 'add-link-to-facebook/add-link-to-facebook.php', // Add Link to Facebook
250 'add-meta-tags/add-meta-tags.php', // Add Meta Tags
251 'easy-facebook-share-thumbnails/esft.php', // Easy Facebook Share Thumbnail
252 'heateor-open-graph-meta-tags/heateor-open-graph-meta-tags.php',
253 // Open Graph Meta Tags by Heateor
254 'facebook/facebook.php', // Facebook (official plugin)
255 'facebook-awd/AWD_facebook.php', // Facebook AWD All in one
256 'facebook-featured-image-and-open-graph-meta-tags/fb-featured-image.php',
257 // Facebook Featured Image & OG Meta Tags
258 'facebook-meta-tags/facebook-metatags.php', // Facebook Meta Tags
259 'wonderm00ns-simple-facebook-open-graph-tags/wonderm00n-open-graph.php',
260 // Facebook Open Graph Meta Tags for WordPress
261 'facebook-revised-open-graph-meta-tag/index.php', // Facebook Revised Open Graph Meta Tag
262 'facebook-thumb-fixer/_facebook-thumb-fixer.php', // Facebook Thumb Fixer
263 'facebook-and-digg-thumbnail-generator/facebook-and-digg-thumbnail-generator.php',
264 // Fedmich's Facebook Open Graph Meta
265 'network-publisher/networkpub.php', // Network Publisher
266 'nextgen-facebook/nextgen-facebook.php', // NextGEN Facebook OG
267 'social-networks-auto-poster-facebook-twitter-g/NextScripts_SNAP.php',
268 // NextScripts SNAP
269 'og-tags/og-tags.php', // OG Tags
270 'opengraph/opengraph.php', // Open Graph
271 'open-graph-protocol-framework/open-graph-protocol-framework.php',
272 // Open Graph Protocol Framework
273 'seo-facebook-comments/seofacebook.php', // SEO Facebook Comments
274 'seo-ultimate/seo-ultimate.php', // SEO Ultimate
275 'sexybookmarks/sexy-bookmarks.php', // Shareaholic
276 'shareaholic/sexy-bookmarks.php', // Shareaholic
277 'sharepress/sharepress.php', // SharePress
278 'simple-facebook-connect/sfc.php', // Simple Facebook Connect
279 'social-discussions/social-discussions.php', // Social Discussions
280 'social-sharing-toolkit/social_sharing_toolkit.php', // Social Sharing Toolkit
281 'socialize/socialize.php', // Socialize
282 'squirrly-seo/squirrly.php', // SEO by SQUIRRLY™
283 'only-tweet-like-share-and-google-1/tweet-like-plusone.php',
284 // Tweet, Like, Google +1 and Share
285 'wordbooker/wordbooker.php', // Wordbooker
286 'wpsso/wpsso.php', // WordPress Social Sharing Optimization
287 'wp-caregiver/wp-caregiver.php', // WP Caregiver
288 'wp-facebook-like-send-open-graph-meta/wp-facebook-like-send-open-graph-meta.php',
289 // WP Facebook Like Send & Open Graph Meta
290 'wp-facebook-open-graph-protocol/wp-facebook-ogp.php', // WP Facebook Open Graph protocol
291 'wp-ogp/wp-ogp.php', // WP-OGP
292 'zoltonorg-social-plugin/zosp.php', // Zolton.org Social Plugin
293 'wp-fb-share-like-button/wp_fb_share-like_widget.php', // WP Facebook Like Button
294 'open-graph-metabox/open-graph-metabox.php' // Open Graph Metabox
295 );
296
297 /**
298 * Plugins for which we turn off our Twitter Cards Tags implementation.
299 */
300 private $twitter_cards_conflicting_plugins = array(
301 // 'twitter/twitter.php', // The official one handles this on its own.
302 // // https://github.com/twitter/wordpress/blob/master/src/Twitter/WordPress/Cards/Compatibility.php
303 'eewee-twitter-card/index.php', // Eewee Twitter Card
304 'ig-twitter-cards/ig-twitter-cards.php', // IG:Twitter Cards
305 'jm-twitter-cards/jm-twitter-cards.php', // JM Twitter Cards
306 'kevinjohn-gallagher-pure-web-brilliants-social-graph-twitter-cards-extention/kevinjohn_gallagher___social_graph_twitter_output.php',
307 // Pure Web Brilliant's Social Graph Twitter Cards Extension
308 'twitter-cards/twitter-cards.php', // Twitter Cards
309 'twitter-cards-meta/twitter-cards-meta.php', // Twitter Cards Meta
310 'wp-to-twitter/wp-to-twitter.php', // WP to Twitter
311 'wp-twitter-cards/twitter_cards.php', // WP Twitter Cards
312 );
313
314 /**
315 * Message to display in admin_notice
316 * @var string
317 */
318 public $message = '';
319
320 /**
321 * Error to display in admin_notice
322 * @var string
323 */
324 public $error = '';
325
326 /**
327 * Modules that need more privacy description.
328 * @var string
329 */
330 public $privacy_checks = '';
331
332 /**
333 * Stats to record once the page loads
334 *
335 * @var array
336 */
337 public $stats = array();
338
339 /**
340 * Jetpack_Sync object
341 */
342 public $sync;
343
344 /**
345 * Verified data for JSON authorization request
346 */
347 public $json_api_authorization_request = array();
348
349 /**
350 * @var \Automattic\Jetpack\Connection\Manager
351 */
352 protected $connection_manager;
353
354 /**
355 * @var string Transient key used to prevent multiple simultaneous plugin upgrades
356 */
357 public static $plugin_upgrade_lock_key = 'jetpack_upgrade_lock';
358
359 /**
360 * Holds the singleton instance of this class
361 * @since 2.3.3
362 * @var Jetpack
363 */
364 static $instance = false;
365
366 /**
367 * Singleton
368 * @static
369 */
370 public static function init() {
371 if ( ! self::$instance ) {
372 self::$instance = new Jetpack;
373
374 self::$instance->plugin_upgrade();
375 }
376
377 return self::$instance;
378 }
379
380 /**
381 * Must never be called statically
382 */
383 function plugin_upgrade() {
384 if ( Jetpack::is_active() ) {
385 list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
386 if ( JETPACK__VERSION != $version ) {
387 // Prevent multiple upgrades at once - only a single process should trigger
388 // an upgrade to avoid stampedes
389 if ( false !== get_transient( self::$plugin_upgrade_lock_key ) ) {
390 return;
391 }
392
393 // Set a short lock to prevent multiple instances of the upgrade
394 set_transient( self::$plugin_upgrade_lock_key, 1, 10 );
395
396 // check which active modules actually exist and remove others from active_modules list
397 $unfiltered_modules = Jetpack::get_active_modules();
398 $modules = array_filter( $unfiltered_modules, array( 'Jetpack', 'is_module' ) );
399 if ( array_diff( $unfiltered_modules, $modules ) ) {
400 Jetpack::update_active_modules( $modules );
401 }
402
403 add_action( 'init', array( __CLASS__, 'activate_new_modules' ) );
404
405 // Upgrade to 4.3.0
406 if ( Jetpack_Options::get_option( 'identity_crisis_whitelist' ) ) {
407 Jetpack_Options::delete_option( 'identity_crisis_whitelist' );
408 }
409
410 // Make sure Markdown for posts gets turned back on
411 if ( ! get_option( 'wpcom_publish_posts_with_markdown' ) ) {
412 update_option( 'wpcom_publish_posts_with_markdown', true );
413 }
414
415 if ( did_action( 'wp_loaded' ) ) {
416 self::upgrade_on_load();
417 } else {
418 add_action(
419 'wp_loaded',
420 array( __CLASS__, 'upgrade_on_load' )
421 );
422 }
423 }
424 }
425 }
426
427 /**
428 * Runs upgrade routines that need to have modules loaded.
429 */
430 static function upgrade_on_load() {
431
432 // Not attempting any upgrades if jetpack_modules_loaded did not fire.
433 // This can happen in case Jetpack has been just upgraded and is
434 // being initialized late during the page load. In this case we wait
435 // until the next proper admin page load with Jetpack active.
436 if ( ! did_action( 'jetpack_modules_loaded' ) ) {
437 delete_transient( self::$plugin_upgrade_lock_key );
438
439 return;
440 }
441
442 Jetpack::maybe_set_version_option();
443
444 if ( method_exists( 'Jetpack_Widget_Conditions', 'migrate_post_type_rules' ) ) {
445 Jetpack_Widget_Conditions::migrate_post_type_rules();
446 }
447
448 if (
449 class_exists( 'Jetpack_Sitemap_Manager' )
450 && version_compare( JETPACK__VERSION, '5.3', '>=' )
451 ) {
452 do_action( 'jetpack_sitemaps_purge_data' );
453 }
454
455 delete_transient( self::$plugin_upgrade_lock_key );
456 }
457
458 /**
459 * Saves all the currently active modules to options.
460 * Also fires Action hooks for each newly activated and deactivated module.
461 *
462 * @param $modules Array Array of active modules to be saved in options.
463 *
464 * @return $success bool true for success, false for failure.
465 */
466 static function update_active_modules( $modules ) {
467 $current_modules = Jetpack_Options::get_option( 'active_modules', array() );
468 $active_modules = Jetpack::get_active_modules();
469 $new_active_modules = array_diff( $modules, $current_modules );
470 $new_inactive_modules = array_diff( $active_modules, $modules );
471 $new_current_modules = array_diff( array_merge( $current_modules, $new_active_modules ), $new_inactive_modules );
472 $reindexed_modules = array_values( $new_current_modules );
473 $success = Jetpack_Options::update_option( 'active_modules', array_unique( $reindexed_modules ) );
474
475 foreach ( $new_active_modules as $module ) {
476 /**
477 * Fires when a specific module is activated.
478 *
479 * @since 1.9.0
480 *
481 * @param string $module Module slug.
482 * @param boolean $success whether the module was activated. @since 4.2
483 */
484 do_action( 'jetpack_activate_module', $module, $success );
485 /**
486 * Fires when a module is activated.
487 * The dynamic part of the filter, $module, is the module slug.
488 *
489 * @since 1.9.0
490 *
491 * @param string $module Module slug.
492 */
493 do_action( "jetpack_activate_module_$module", $module );
494 }
495
496 foreach ( $new_inactive_modules as $module ) {
497 /**
498 * Fired after a module has been deactivated.
499 *
500 * @since 4.2.0
501 *
502 * @param string $module Module slug.
503 * @param boolean $success whether the module was deactivated.
504 */
505 do_action( 'jetpack_deactivate_module', $module, $success );
506 /**
507 * Fires when a module is deactivated.
508 * The dynamic part of the filter, $module, is the module slug.
509 *
510 * @since 1.9.0
511 *
512 * @param string $module Module slug.
513 */
514 do_action( "jetpack_deactivate_module_$module", $module );
515 }
516
517 return $success;
518 }
519
520 static function delete_active_modules() {
521 self::update_active_modules( array() );
522 }
523
524 /**
525 * Constructor. Initializes WordPress hooks
526 */
527 private function __construct() {
528 /*
529 * Check for and alert any deprecated hooks
530 */
531 add_action( 'init', array( $this, 'deprecated_hooks' ) );
532
533 /*
534 * Enable enhanced handling of previewing sites in Calypso
535 */
536 if ( Jetpack::is_active() ) {
537 require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-iframe-embed.php';
538 add_action( 'init', array( 'Jetpack_Iframe_Embed', 'init' ), 9, 0 );
539 require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-keyring-service-helper.php';
540 add_action( 'init', array( 'Jetpack_Keyring_Service_Helper', 'init' ), 9, 0 );
541 }
542
543 if ( self::jetpack_tos_agreed() ) {
544 $tracking = new Automattic\Jetpack\Plugin\Tracking();
545 add_action( 'init', array( $tracking, 'init' ) );
546 }
547
548 /*
549 * Load things that should only be in Network Admin.
550 *
551 * For now blow away everything else until a more full
552 * understanding of what is needed at the network level is
553 * available
554 */
555 if ( is_multisite() ) {
556 Jetpack_Network::init();
557 }
558
559 add_filter( 'jetpack_connection_secret_generator', function( $callable ) {
560 return function() {
561 return wp_generate_password( 32, false );
562 };
563 } );
564
565 $this->connection_manager = new Connection_Manager( );
566
567 /**
568 * Prepare Gutenberg Editor functionality
569 */
570 require_once JETPACK__PLUGIN_DIR . 'class.jetpack-gutenberg.php';
571 Jetpack_Gutenberg::init();
572 Jetpack_Gutenberg::load_independent_blocks();
573 add_action( 'enqueue_block_editor_assets', array( 'Jetpack_Gutenberg', 'enqueue_block_editor_assets' ) );
574
575 add_action( 'set_user_role', array( $this, 'maybe_clear_other_linked_admins_transient' ), 10, 3 );
576
577 // Unlink user before deleting the user from .com
578 add_action( 'deleted_user', array( $this, 'unlink_user' ), 10, 1 );
579 add_action( 'remove_user_from_blog', array( $this, 'unlink_user' ), 10, 1 );
580
581 // Alternate XML-RPC, via ?for=jetpack&jetpack=comms
582 if ( isset( $_GET['jetpack'] ) && 'comms' == $_GET['jetpack'] && isset( $_GET['for'] ) && 'jetpack' == $_GET['for'] ) {
583 if ( ! defined( 'XMLRPC_REQUEST' ) ) {
584 define( 'XMLRPC_REQUEST', true );
585 }
586
587 add_action( 'template_redirect', array( $this, 'alternate_xmlrpc' ) );
588
589 add_filter( 'xmlrpc_methods', array( $this, 'remove_non_jetpack_xmlrpc_methods' ), 1000 );
590 }
591
592 if ( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST && isset( $_GET['for'] ) && 'jetpack' == $_GET['for'] ) {
593 @ini_set( 'display_errors', false ); // Display errors can cause the XML to be not well formed.
594
595 require_once JETPACK__PLUGIN_DIR . 'class.jetpack-xmlrpc-server.php';
596 $this->xmlrpc_server = new Jetpack_XMLRPC_Server();
597
598 $this->require_jetpack_authentication();
599
600 if ( Jetpack::is_active() ) {
601 // Hack to preserve $HTTP_RAW_POST_DATA
602 add_filter( 'xmlrpc_methods', array( $this, 'xmlrpc_methods' ) );
603
604 if ( $this->verify_xml_rpc_signature() ) {
605 // The actual API methods.
606 add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'xmlrpc_methods' ) );
607 } else {
608 // The jetpack.authorize method should be available for unauthenticated users on a site with an
609 // active Jetpack connection, so that additional users can link their account.
610 add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'authorize_xmlrpc_methods' ) );
611 }
612 } else {
613 new XMLRPC_Connector( $this->connection_manager );
614
615 // The bootstrap API methods.
616 add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'bootstrap_xmlrpc_methods' ) );
617
618 if ( $this->verify_xml_rpc_signature() ) {
619 // the jetpack Provision method is available for blog-token-signed requests
620 add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'provision_xmlrpc_methods' ) );
621 }
622 }
623
624 // Now that no one can authenticate, and we're whitelisting all XML-RPC methods, force enable_xmlrpc on.
625 add_filter( 'pre_option_enable_xmlrpc', '__return_true' );
626 } elseif (
627 is_admin() &&
628 isset( $_POST['action'] ) && (
629 'jetpack_upload_file' == $_POST['action'] ||
630 'jetpack_update_file' == $_POST['action']
631 )
632 ) {
633 $this->require_jetpack_authentication();
634 $this->add_remote_request_handlers();
635 } else {
636 if ( Jetpack::is_active() ) {
637 add_action( 'login_form_jetpack_json_api_authorization', array( &$this, 'login_form_json_api_authorization' ) );
638 add_filter( 'xmlrpc_methods', array( $this, 'public_xmlrpc_methods' ) );
639 } else {
640 add_action( 'rest_api_init', array( $this, 'initialize_rest_api_registration_connector' ) );
641 }
642 }
643
644 if ( Jetpack::is_active() ) {
645 Jetpack_Heartbeat::init();
646 if ( Jetpack::is_module_active( 'stats' ) && Jetpack::is_module_active( 'search' ) ) {
647 require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-search-performance-logger.php';
648 Jetpack_Search_Performance_Logger::init();
649 }
650 }
651
652 add_filter( 'determine_current_user', array( $this, 'wp_rest_authenticate' ) );
653 add_filter( 'rest_authentication_errors', array( $this, 'wp_rest_authentication_errors' ) );
654
655 add_action( 'jetpack_clean_nonces', array( 'Jetpack', 'clean_nonces' ) );
656 if ( ! wp_next_scheduled( 'jetpack_clean_nonces' ) ) {
657 wp_schedule_event( time(), 'hourly', 'jetpack_clean_nonces' );
658 }
659
660 add_filter( 'xmlrpc_blog_options', array( $this, 'xmlrpc_options' ) );
661
662 add_action( 'admin_init', array( $this, 'admin_init' ) );
663 add_action( 'admin_init', array( $this, 'dismiss_jetpack_notice' ) );
664
665 add_filter( 'admin_body_class', array( $this, 'admin_body_class' ) );
666
667 add_action( 'wp_dashboard_setup', array( $this, 'wp_dashboard_setup' ) );
668 // Filter the dashboard meta box order to swap the new one in in place of the old one.
669 add_filter( 'get_user_option_meta-box-order_dashboard', array( $this, 'get_user_option_meta_box_order_dashboard' ) );
670
671 // returns HTTPS support status
672 add_action( 'wp_ajax_jetpack-recheck-ssl', array( $this, 'ajax_recheck_ssl' ) );
673
674 // JITM AJAX callback function
675 add_action( 'wp_ajax_jitm_ajax', array( $this, 'jetpack_jitm_ajax_callback' ) );
676
677 add_action( 'wp_ajax_jetpack_connection_banner', array( $this, 'jetpack_connection_banner_callback' ) );
678
679 add_action( 'wp_loaded', array( $this, 'register_assets' ) );
680 add_action( 'wp_enqueue_scripts', array( $this, 'devicepx' ) );
681 add_action( 'customize_controls_enqueue_scripts', array( $this, 'devicepx' ) );
682 add_action( 'admin_enqueue_scripts', array( $this, 'devicepx' ) );
683
684 add_action( 'plugins_loaded', array( $this, 'extra_oembed_providers' ), 100 );
685
686 /**
687 * These actions run checks to load additional files.
688 * They check for external files or plugins, so they need to run as late as possible.
689 */
690 add_action( 'wp_head', array( $this, 'check_open_graph' ), 1 );
691 add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ), 999 );
692 add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
693
694 add_filter( 'plugins_url', array( 'Jetpack', 'maybe_min_asset' ), 1, 3 );
695 add_action( 'style_loader_src', array( 'Jetpack', 'set_suffix_on_min' ), 10, 2 );
696 add_filter( 'style_loader_tag', array( 'Jetpack', 'maybe_inline_style' ), 10, 2 );
697
698 add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
699 add_filter( 'profile_update', array( 'Jetpack', 'user_meta_cleanup' ) );
700
701 add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
702 add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
703
704 // A filter to control all just in time messages
705 add_filter( 'jetpack_just_in_time_msgs', array( $this, 'is_active_and_not_development_mode' ), 9 );
706
707 add_filter( 'jetpack_just_in_time_msg_cache', '__return_true', 9);
708
709 // If enabled, point edit post, page, and comment links to Calypso instead of WP-Admin.
710 // We should make sure to only do this for front end links.
711 if ( Jetpack::get_option( 'edit_links_calypso_redirect' ) && ! is_admin() ) {
712 add_filter( 'get_edit_post_link', array( $this, 'point_edit_post_links_to_calypso' ), 1, 2 );
713 add_filter( 'get_edit_comment_link', array( $this, 'point_edit_comment_links_to_calypso' ), 1 );
714
715 //we'll override wp_notify_postauthor and wp_notify_moderator pluggable functions
716 //so they point moderation links on emails to Calypso
717 jetpack_require_lib( 'functions.wp-notify' );
718 }
719
720 // Update the Jetpack plan from API on heartbeats
721 add_action( 'jetpack_heartbeat', array( 'Jetpack_Plan', 'refresh_from_wpcom' ) );
722
723 /**
724 * This is the hack to concatenate all css files into one.
725 * For description and reasoning see the implode_frontend_css method
726 *
727 * Super late priority so we catch all the registered styles
728 */
729 if( !is_admin() ) {
730 add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
731 add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
732 }
733
734
735 /**
736 * These are sync actions that we need to keep track of for jitms
737 */
738 add_filter( 'jetpack_sync_before_send_updated_option', array( $this, 'jetpack_track_last_sync_callback' ), 99 );
739
740 // Actually push the stats on shutdown.
741 if ( ! has_action( 'shutdown', array( $this, 'push_stats' ) ) ) {
742 add_action( 'shutdown', array( $this, 'push_stats' ) );
743 }
744
745 }
746
747 function initialize_rest_api_registration_connector() {
748 new REST_Connector( $this->connection_manager );
749 }
750
751 /**
752 * This is ported over from the manage module, which has been deprecated and baked in here.
753 *
754 * @param $domains
755 */
756 function add_wpcom_to_allowed_redirect_hosts( $domains ) {
757 add_filter( 'allowed_redirect_hosts', array( $this, 'allow_wpcom_domain' ) );
758 }
759
760 /**
761 * Return $domains, with 'wordpress.com' appended.
762 * This is ported over from the manage module, which has been deprecated and baked in here.
763 *
764 * @param $domains
765 * @return array
766 */
767 function allow_wpcom_domain( $domains ) {
768 if ( empty( $domains ) ) {
769 $domains = array();
770 }
771 $domains[] = 'wordpress.com';
772 return array_unique( $domains );
773 }
774
775 function point_edit_post_links_to_calypso( $default_url, $post_id ) {
776 $post = get_post( $post_id );
777
778 if ( empty( $post ) ) {
779 return $default_url;
780 }
781
782 $post_type = $post->post_type;
783
784 // Mapping the allowed CPTs on WordPress.com to corresponding paths in Calypso.
785 // https://en.support.wordpress.com/custom-post-types/
786 $allowed_post_types = array(
787 'post' => 'post',
788 'page' => 'page',
789 'jetpack-portfolio' => 'edit/jetpack-portfolio',
790 'jetpack-testimonial' => 'edit/jetpack-testimonial',
791 );
792
793 if ( ! in_array( $post_type, array_keys( $allowed_post_types ) ) ) {
794 return $default_url;
795 }
796
797 $path_prefix = $allowed_post_types[ $post_type ];
798
799 $site_slug = Jetpack::build_raw_urls( get_home_url() );
800
801 return esc_url( sprintf( 'https://wordpress.com/%s/%s/%d', $path_prefix, $site_slug, $post_id ) );
802 }
803
804 function point_edit_comment_links_to_calypso( $url ) {
805 // Take the `query` key value from the URL, and parse its parts to the $query_args. `amp;c` matches the comment ID.
806 wp_parse_str( wp_parse_url( $url, PHP_URL_QUERY ), $query_args );
807 return esc_url( sprintf( 'https://wordpress.com/comment/%s/%d',
808 Jetpack::build_raw_urls( get_home_url() ),
809 $query_args['amp;c']
810 ) );
811 }
812
813 function jetpack_track_last_sync_callback( $params ) {
814 /**
815 * Filter to turn off jitm caching
816 *
817 * @since 5.4.0
818 *
819 * @param bool false Whether to cache just in time messages
820 */
821 if ( ! apply_filters( 'jetpack_just_in_time_msg_cache', false ) ) {
822 return $params;
823 }
824
825 if ( is_array( $params ) && isset( $params[0] ) ) {
826 $option = $params[0];
827 if ( 'active_plugins' === $option ) {
828 // use the cache if we can, but not terribly important if it gets evicted
829 set_transient( 'jetpack_last_plugin_sync', time(), HOUR_IN_SECONDS );
830 }
831 }
832
833 return $params;
834 }
835
836 function jetpack_connection_banner_callback() {
837 check_ajax_referer( 'jp-connection-banner-nonce', 'nonce' );
838
839 if ( isset( $_REQUEST['dismissBanner'] ) ) {
840 Jetpack_Options::update_option( 'dismissed_connection_banner', 1 );
841 wp_send_json_success();
842 }
843
844 wp_die();
845 }
846
847 /**
848 * Removes all XML-RPC methods that are not `jetpack.*`.
849 * Only used in our alternate XML-RPC endpoint, where we want to
850 * ensure that Core and other plugins' methods are not exposed.
851 *
852 * @param array $methods
853 * @return array filtered $methods
854 */
855 function remove_non_jetpack_xmlrpc_methods( $methods ) {
856 $jetpack_methods = array();
857
858 foreach ( $methods as $method => $callback ) {
859 if ( 0 === strpos( $method, 'jetpack.' ) ) {
860 $jetpack_methods[ $method ] = $callback;
861 }
862 }
863
864 return $jetpack_methods;
865 }
866
867 /**
868 * Since a lot of hosts use a hammer approach to "protecting" WordPress sites,
869 * and just blanket block all requests to /xmlrpc.php, or apply other overly-sensitive
870 * security/firewall policies, we provide our own alternate XML RPC API endpoint
871 * which is accessible via a different URI. Most of the below is copied directly
872 * from /xmlrpc.php so that we're replicating it as closely as possible.
873 */
874 function alternate_xmlrpc() {
875 // phpcs:disable PHPCompatibility.Variables.RemovedPredefinedGlobalVariables.http_raw_post_dataDeprecatedRemoved
876 global $HTTP_RAW_POST_DATA;
877
878 // Some browser-embedded clients send cookies. We don't want them.
879 $_COOKIE = array();
880
881 // A bug in PHP < 5.2.2 makes $HTTP_RAW_POST_DATA not set by default,
882 // but we can do it ourself.
883 if ( ! isset( $HTTP_RAW_POST_DATA ) ) {
884 $HTTP_RAW_POST_DATA = file_get_contents( 'php://input' );
885 }
886
887 // fix for mozBlog and other cases where '<?xml' isn't on the very first line
888 if ( isset( $HTTP_RAW_POST_DATA ) ) {
889 $HTTP_RAW_POST_DATA = trim( $HTTP_RAW_POST_DATA );
890 }
891
892 // phpcs:enable
893
894 include_once( ABSPATH . 'wp-admin/includes/admin.php' );
895 include_once( ABSPATH . WPINC . '/class-IXR.php' );
896 include_once( ABSPATH . WPINC . '/class-wp-xmlrpc-server.php' );
897
898 /**
899 * Filters the class used for handling XML-RPC requests.
900 *
901 * @since 3.1.0
902 *
903 * @param string $class The name of the XML-RPC server class.
904 */
905 $wp_xmlrpc_server_class = apply_filters( 'wp_xmlrpc_server_class', 'wp_xmlrpc_server' );
906 $wp_xmlrpc_server = new $wp_xmlrpc_server_class;
907
908 // Fire off the request
909 nocache_headers();
910 $wp_xmlrpc_server->serve_request();
911
912 exit;
913 }
914
915 /**
916 * The callback for the JITM ajax requests.
917 */
918 function jetpack_jitm_ajax_callback() {
919 // Check for nonce
920 if ( ! isset( $_REQUEST['jitmNonce'] ) || ! wp_verify_nonce( $_REQUEST['jitmNonce'], 'jetpack-jitm-nonce' ) ) {
921 wp_die( 'Module activation failed due to lack of appropriate permissions' );
922 }
923 if ( isset( $_REQUEST['jitmActionToTake'] ) && 'activate' == $_REQUEST['jitmActionToTake'] ) {
924 $module_slug = $_REQUEST['jitmModule'];
925 Jetpack::log( 'activate', $module_slug );
926 Jetpack::activate_module( $module_slug, false, false );
927 Jetpack::state( 'message', 'no_message' );
928
929 //A Jetpack module is being activated through a JITM, track it
930 $this->stat( 'jitm', $module_slug.'-activated-' . JETPACK__VERSION );
931 $this->do_stats( 'server_side' );
932
933 wp_send_json_success();
934 }
935 if ( isset( $_REQUEST['jitmActionToTake'] ) && 'dismiss' == $_REQUEST['jitmActionToTake'] ) {
936 // get the hide_jitm options array
937 $jetpack_hide_jitm = Jetpack_Options::get_option( 'hide_jitm' );
938 $module_slug = $_REQUEST['jitmModule'];
939
940 if( ! $jetpack_hide_jitm ) {
941 $jetpack_hide_jitm = array(
942 $module_slug => 'hide'
943 );
944 } else {
945 $jetpack_hide_jitm[$module_slug] = 'hide';
946 }
947
948 Jetpack_Options::update_option( 'hide_jitm', $jetpack_hide_jitm );
949
950 //jitm is being dismissed forever, track it
951 $this->stat( 'jitm', $module_slug.'-dismissed-' . JETPACK__VERSION );
952 $this->do_stats( 'server_side' );
953
954 wp_send_json_success();
955 }
956 if ( isset( $_REQUEST['jitmActionToTake'] ) && 'launch' == $_REQUEST['jitmActionToTake'] ) {
957 $module_slug = $_REQUEST['jitmModule'];
958
959 // User went to WordPress.com, track this
960 $this->stat( 'jitm', $module_slug.'-wordpress-tools-' . JETPACK__VERSION );
961 $this->do_stats( 'server_side' );
962
963 wp_send_json_success();
964 }
965 if ( isset( $_REQUEST['jitmActionToTake'] ) && 'viewed' == $_REQUEST['jitmActionToTake'] ) {
966 $track = $_REQUEST['jitmModule'];
967
968 // User is viewing JITM, track it.
969 $this->stat( 'jitm', $track . '-viewed-' . JETPACK__VERSION );
970 $this->do_stats( 'server_side' );
971
972 wp_send_json_success();
973 }
974 }
975
976 /**
977 * If there are any stats that need to be pushed, but haven't been, push them now.
978 */
979 function push_stats() {
980 if ( ! empty( $this->stats ) ) {
981 $this->do_stats( 'server_side' );
982 }
983 }
984
985 function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
986 switch( $cap ) {
987 case 'jetpack_connect' :
988 case 'jetpack_reconnect' :
989 if ( Jetpack::is_development_mode() ) {
990 $caps = array( 'do_not_allow' );
991 break;
992 }
993 /**
994 * Pass through. If it's not development mode, these should match disconnect.
995 * Let users disconnect if it's development mode, just in case things glitch.
996 */
997 case 'jetpack_disconnect' :
998 /**
999 * In multisite, can individual site admins manage their own connection?
1000 *
1001 * Ideally, this should be extracted out to a separate filter in the Jetpack_Network class.
1002 */
1003 if ( is_multisite() && ! is_super_admin() && is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
1004 if ( ! Jetpack_Network::init()->get_option( 'sub-site-connection-override' ) ) {
1005 /**
1006 * We need to update the option name -- it's terribly unclear which
1007 * direction the override goes.
1008 *
1009 * @todo: Update the option name to `sub-sites-can-manage-own-connections`
1010 */
1011 $caps = array( 'do_not_allow' );
1012 break;
1013 }
1014 }
1015
1016 $caps = array( 'manage_options' );
1017 break;
1018 case 'jetpack_manage_modules' :
1019 case 'jetpack_activate_modules' :
1020 case 'jetpack_deactivate_modules' :
1021 $caps = array( 'manage_options' );
1022 break;
1023 case 'jetpack_configure_modules' :
1024 $caps = array( 'manage_options' );
1025 break;
1026 case 'jetpack_manage_autoupdates' :
1027 $caps = array(
1028 'manage_options',
1029 'update_plugins',
1030 );
1031 break;
1032 case 'jetpack_network_admin_page':
1033 case 'jetpack_network_settings_page':
1034 $caps = array( 'manage_network_plugins' );
1035 break;
1036 case 'jetpack_network_sites_page':
1037 $caps = array( 'manage_sites' );
1038 break;
1039 case 'jetpack_admin_page' :
1040 if ( Jetpack::is_development_mode() ) {
1041 $caps = array( 'manage_options' );
1042 break;
1043 } else {
1044 $caps = array( 'read' );
1045 }
1046 break;
1047 case 'jetpack_connect_user' :
1048 if ( Jetpack::is_development_mode() ) {
1049 $caps = array( 'do_not_allow' );
1050 break;
1051 }
1052 $caps = array( 'read' );
1053 break;
1054 }
1055 return $caps;
1056 }
1057
1058 function require_jetpack_authentication() {
1059 // Don't let anyone authenticate
1060 $_COOKIE = array();
1061 remove_all_filters( 'authenticate' );
1062 remove_all_actions( 'wp_login_failed' );
1063
1064 if ( Jetpack::is_active() ) {
1065 // Allow Jetpack authentication
1066 add_filter( 'authenticate', array( $this, 'authenticate_jetpack' ), 10, 3 );
1067 }
1068 }
1069
1070 /**
1071 * Load language files
1072 * @action plugins_loaded
1073 */
1074 public static function plugin_textdomain() {
1075 // Note to self, the third argument must not be hardcoded, to account for relocated folders.
1076 load_plugin_textdomain( 'jetpack', false, dirname( plugin_basename( JETPACK__PLUGIN_FILE ) ) . '/languages/' );
1077 }
1078
1079 /**
1080 * Register assets for use in various modules and the Jetpack admin page.
1081 *
1082 * @uses wp_script_is, wp_register_script, plugins_url
1083 * @action wp_loaded
1084 * @return null
1085 */
1086 public function register_assets() {
1087 if ( ! wp_script_is( 'spin', 'registered' ) ) {
1088 wp_register_script(
1089 'spin',
1090 Assets::get_file_url_for_environment( '_inc/build/spin.min.js', '_inc/spin.js' ),
1091 false,
1092 '1.3'
1093 );
1094 }
1095
1096 if ( ! wp_script_is( 'jquery.spin', 'registered' ) ) {
1097 wp_register_script(
1098 'jquery.spin',
1099 Assets::get_file_url_for_environment( '_inc/build/jquery.spin.min.js', '_inc/jquery.spin.js' ),
1100 array( 'jquery', 'spin' ),
1101 '1.3'
1102 );
1103 }
1104
1105 if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
1106 wp_register_script(
1107 'jetpack-gallery-settings',
1108 Assets::get_file_url_for_environment( '_inc/build/gallery-settings.min.js', '_inc/gallery-settings.js' ),
1109 array( 'media-views' ),
1110 '20121225'
1111 );
1112 }
1113
1114 if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
1115 wp_register_script(
1116 'jetpack-twitter-timeline',
1117 Assets::get_file_url_for_environment( '_inc/build/twitter-timeline.min.js', '_inc/twitter-timeline.js' ),
1118 array( 'jquery' ),
1119 '4.0.0',
1120 true
1121 );
1122 }
1123
1124 if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
1125 wp_register_script(
1126 'jetpack-facebook-embed',
1127 Assets::get_file_url_for_environment( '_inc/build/facebook-embed.min.js', '_inc/facebook-embed.js' ),
1128 array( 'jquery' ),
1129 null,
1130 true
1131 );
1132
1133 /** This filter is documented in modules/sharedaddy/sharing-sources.php */
1134 $fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
1135 if ( ! is_numeric( $fb_app_id ) ) {
1136 $fb_app_id = '';
1137 }
1138 wp_localize_script(
1139 'jetpack-facebook-embed',
1140 'jpfbembed',
1141 array(
1142 'appid' => $fb_app_id,
1143 'locale' => $this->get_locale(),
1144 )
1145 );
1146 }
1147
1148 /**
1149 * As jetpack_register_genericons is by default fired off a hook,
1150 * the hook may have already fired by this point.
1151 * So, let's just trigger it manually.
1152 */
1153 require_once( JETPACK__PLUGIN_DIR . '_inc/genericons.php' );
1154 jetpack_register_genericons();
1155
1156 /**
1157 * Register the social logos
1158 */
1159 require_once( JETPACK__PLUGIN_DIR . '_inc/social-logos.php' );
1160 jetpack_register_social_logos();
1161
1162 if ( ! wp_style_is( 'jetpack-icons', 'registered' ) )
1163 wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
1164 }
1165
1166 /**
1167 * Guess locale from language code.
1168 *
1169 * @param string $lang Language code.
1170 * @return string|bool
1171 */
1172 function guess_locale_from_lang( $lang ) {
1173 if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
1174 return 'en_US';
1175 }
1176
1177 if ( ! class_exists( 'GP_Locales' ) ) {
1178 if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
1179 return false;
1180 }
1181
1182 require JETPACK__GLOTPRESS_LOCALES_PATH;
1183 }
1184
1185 if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
1186 // WP.com: get_locale() returns 'it'
1187 $locale = GP_Locales::by_slug( $lang );
1188 } else {
1189 // Jetpack: get_locale() returns 'it_IT';
1190 $locale = GP_Locales::by_field( 'facebook_locale', $lang );
1191 }
1192
1193 if ( ! $locale ) {
1194 return false;
1195 }
1196
1197 if ( empty( $locale->facebook_locale ) ) {
1198 if ( empty( $locale->wp_locale ) ) {
1199 return false;
1200 } else {
1201 // Facebook SDK is smart enough to fall back to en_US if a
1202 // locale isn't supported. Since supported Facebook locales
1203 // can fall out of sync, we'll attempt to use the known
1204 // wp_locale value and rely on said fallback.
1205 return $locale->wp_locale;
1206 }
1207 }
1208
1209 return $locale->facebook_locale;
1210 }
1211
1212 /**
1213 * Get the locale.
1214 *
1215 * @return string|bool
1216 */
1217 function get_locale() {
1218 $locale = $this->guess_locale_from_lang( get_locale() );
1219
1220 if ( ! $locale ) {
1221 $locale = 'en_US';
1222 }
1223
1224 return $locale;
1225 }
1226
1227 /**
1228 * Device Pixels support
1229 * This improves the resolution of gravatars and wordpress.com uploads on hi-res and zoomed browsers.
1230 */
1231 function devicepx() {
1232 if ( Jetpack::is_active() && ! Jetpack_AMP_Support::is_amp_request() ) {
1233 wp_enqueue_script( 'devicepx', 'https://s0.wp.com/wp-content/js/devicepx-jetpack.js', array(), gmdate( 'oW' ), true );
1234 }
1235 }
1236
1237 /**
1238 * Return the network_site_url so that .com knows what network this site is a part of.
1239 * @param bool $option
1240 * @return string
1241 */
1242 public function jetpack_main_network_site_option( $option ) {
1243 return network_site_url();
1244 }
1245 /**
1246 * Network Name.
1247 */
1248 static function network_name( $option = null ) {
1249 global $current_site;
1250 return $current_site->site_name;
1251 }
1252 /**
1253 * Does the network allow new user and site registrations.
1254 * @return string
1255 */
1256 static function network_allow_new_registrations( $option = null ) {
1257 return ( in_array( get_site_option( 'registration' ), array('none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration') : 'none' );
1258 }
1259 /**
1260 * Does the network allow admins to add new users.
1261 * @return boolian
1262 */
1263 static function network_add_new_users( $option = null ) {
1264 return (bool) get_site_option( 'add_new_users' );
1265 }
1266 /**
1267 * File upload psace left per site in MB.
1268 * -1 means NO LIMIT.
1269 * @return number
1270 */
1271 static function network_site_upload_space( $option = null ) {
1272 // value in MB
1273 return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
1274 }
1275
1276 /**
1277 * Network allowed file types.
1278 * @return string
1279 */
1280 static function network_upload_file_types( $option = null ) {
1281 return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
1282 }
1283
1284 /**
1285 * Maximum file upload size set by the network.
1286 * @return number
1287 */
1288 static function network_max_upload_file_size( $option = null ) {
1289 // value in KB
1290 return get_site_option( 'fileupload_maxk', 300 );
1291 }
1292
1293 /**
1294 * Lets us know if a site allows admins to manage the network.
1295 * @return array
1296 */
1297 static function network_enable_administration_menus( $option = null ) {
1298 return get_site_option( 'menu_items' );
1299 }
1300
1301 /**
1302 * If a user has been promoted to or demoted from admin, we need to clear the
1303 * jetpack_other_linked_admins transient.
1304 *
1305 * @since 4.3.2
1306 * @since 4.4.0 $old_roles is null by default and if it's not passed, the transient is cleared.
1307 *
1308 * @param int $user_id The user ID whose role changed.
1309 * @param string $role The new role.
1310 * @param array $old_roles An array of the user's previous roles.
1311 */
1312 function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
1313 if ( 'administrator' == $role
1314 || ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
1315 || is_null( $old_roles )
1316 ) {
1317 delete_transient( 'jetpack_other_linked_admins' );
1318 }
1319 }
1320
1321 /**
1322 * Checks to see if there are any other users available to become primary
1323 * Users must both:
1324 * - Be linked to wpcom
1325 * - Be an admin
1326 *
1327 * @return mixed False if no other users are linked, Int if there are.
1328 */
1329 static function get_other_linked_admins() {
1330 $other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1331
1332 if ( false === $other_linked_users ) {
1333 $admins = get_users( array( 'role' => 'administrator' ) );
1334 if ( count( $admins ) > 1 ) {
1335 $available = array();
1336 foreach ( $admins as $admin ) {
1337 if ( Jetpack::is_user_connected( $admin->ID ) ) {
1338 $available[] = $admin->ID;
1339 }
1340 }
1341
1342 $count_connected_admins = count( $available );
1343 if ( count( $available ) > 1 ) {
1344 $other_linked_users = $count_connected_admins;
1345 } else {
1346 $other_linked_users = 0;
1347 }
1348 } else {
1349 $other_linked_users = 0;
1350 }
1351
1352 set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1353 }
1354
1355 return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1356 }
1357
1358 /**
1359 * Return whether we are dealing with a multi network setup or not.
1360 * The reason we are type casting this is because we want to avoid the situation where
1361 * the result is false since when is_main_network_option return false it cases
1362 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1363 * database which could be set to anything as opposed to what this function returns.
1364 * @param bool $option
1365 *
1366 * @return boolean
1367 */
1368 public function is_main_network_option( $option ) {
1369 // return '1' or ''
1370 return (string) (bool) Jetpack::is_multi_network();
1371 }
1372
1373 /**
1374 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1375 *
1376 * @param string $option
1377 * @return boolean
1378 */
1379 public function is_multisite( $option ) {
1380 return (string) (bool) is_multisite();
1381 }
1382
1383 /**
1384 * Implemented since there is no core is multi network function
1385 * Right now there is no way to tell if we which network is the dominant network on the system
1386 *
1387 * @since 3.3
1388 * @return boolean
1389 */
1390 public static function is_multi_network() {
1391 global $wpdb;
1392
1393 // if we don't have a multi site setup no need to do any more
1394 if ( ! is_multisite() ) {
1395 return false;
1396 }
1397
1398 $num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1399 if ( $num_sites > 1 ) {
1400 return true;
1401 } else {
1402 return false;
1403 }
1404 }
1405
1406 /**
1407 * Trigger an update to the main_network_site when we update the siteurl of a site.
1408 * @return null
1409 */
1410 function update_jetpack_main_network_site_option() {
1411 _deprecated_function( __METHOD__, 'jetpack-4.2' );
1412 }
1413 /**
1414 * Triggered after a user updates the network settings via Network Settings Admin Page
1415 *
1416 */
1417 function update_jetpack_network_settings() {
1418 _deprecated_function( __METHOD__, 'jetpack-4.2' );
1419 // Only sync this info for the main network site.
1420 }
1421
1422 /**
1423 * Get back if the current site is single user site.
1424 *
1425 * @return bool
1426 */
1427 public static function is_single_user_site() {
1428 global $wpdb;
1429
1430 if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1431 $some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1432 set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1433 }
1434 return 1 === (int) $some_users;
1435 }
1436
1437 /**
1438 * Returns true if the site has file write access false otherwise.
1439 * @return string ( '1' | '0' )
1440 **/
1441 public static function file_system_write_access() {
1442 if ( ! function_exists( 'get_filesystem_method' ) ) {
1443 require_once( ABSPATH . 'wp-admin/includes/file.php' );
1444 }
1445
1446 require_once( ABSPATH . 'wp-admin/includes/template.php' );
1447
1448 $filesystem_method = get_filesystem_method();
1449 if ( $filesystem_method === 'direct' ) {
1450 return 1;
1451 }
1452
1453 ob_start();
1454 $filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1455 ob_end_clean();
1456 if ( $filesystem_credentials_are_stored ) {
1457 return 1;
1458 }
1459 return 0;
1460 }
1461
1462 /**
1463 * Finds out if a site is using a version control system.
1464 * @return string ( '1' | '0' )
1465 **/
1466 public static function is_version_controlled() {
1467 _deprecated_function( __METHOD__, 'jetpack-4.2', 'Functions::is_version_controlled' );
1468 return (string) (int) Functions::is_version_controlled();
1469 }
1470
1471 /**
1472 * Determines whether the current theme supports featured images or not.
1473 * @return string ( '1' | '0' )
1474 */
1475 public static function featured_images_enabled() {
1476 _deprecated_function( __METHOD__, 'jetpack-4.2' );
1477 return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1478 }
1479
1480 /**
1481 * Wrapper for core's get_avatar_url(). This one is deprecated.
1482 *
1483 * @deprecated 4.7 use get_avatar_url instead.
1484 * @param int|string|object $id_or_email A user ID, email address, or comment object
1485 * @param int $size Size of the avatar image
1486 * @param string $default URL to a default image to use if no avatar is available
1487 * @param bool $force_display Whether to force it to return an avatar even if show_avatars is disabled
1488 *
1489 * @return array
1490 */
1491 public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1492 _deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1493 return get_avatar_url( $id_or_email, array(
1494 'size' => $size,
1495 'default' => $default,
1496 'force_default' => $force_display,
1497 ) );
1498 }
1499
1500 /**
1501 * jetpack_updates is saved in the following schema:
1502 *
1503 * array (
1504 * 'plugins' => (int) Number of plugin updates available.
1505 * 'themes' => (int) Number of theme updates available.
1506 * 'wordpress' => (int) Number of WordPress core updates available.
1507 * 'translations' => (int) Number of translation updates available.
1508 * 'total' => (int) Total of all available updates.
1509 * 'wp_update_version' => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1510 * )
1511 * @return array
1512 */
1513 public static function get_updates() {
1514 $update_data = wp_get_update_data();
1515
1516 // Stores the individual update counts as well as the total count.
1517 if ( isset( $update_data['counts'] ) ) {
1518 $updates = $update_data['counts'];
1519 }
1520
1521 // If we need to update WordPress core, let's find the latest version number.
1522 if ( ! empty( $updates['wordpress'] ) ) {
1523 $cur = get_preferred_from_update_core();
1524 if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1525 $updates['wp_update_version'] = $cur->current;
1526 }
1527 }
1528 return isset( $updates ) ? $updates : array();
1529 }
1530
1531 public static function get_update_details() {
1532 $update_details = array(
1533 'update_core' => get_site_transient( 'update_core' ),
1534 'update_plugins' => get_site_transient( 'update_plugins' ),
1535 'update_themes' => get_site_transient( 'update_themes' ),
1536 );
1537 return $update_details;
1538 }
1539
1540 public static function refresh_update_data() {
1541 _deprecated_function( __METHOD__, 'jetpack-4.2' );
1542
1543 }
1544
1545 public static function refresh_theme_data() {
1546 _deprecated_function( __METHOD__, 'jetpack-4.2' );
1547 }
1548
1549 /**
1550 * Is Jetpack active?
1551 */
1552 public static function is_active() {
1553 return (bool) Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1554 }
1555
1556 /**
1557 * Make an API call to WordPress.com for plan status
1558 *
1559 * @deprecated 7.2.0 Use Jetpack_Plan::refresh_from_wpcom.
1560 *
1561 * @return bool True if plan is updated, false if no update
1562 */
1563 public static function refresh_active_plan_from_wpcom() {
1564 _deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::refresh_from_wpcom' );
1565 return Jetpack_Plan::refresh_from_wpcom();
1566 }
1567
1568 /**
1569 * Get the plan that this Jetpack site is currently using
1570 *
1571 * @deprecated 7.2.0 Use Jetpack_Plan::get.
1572 * @return array Active Jetpack plan details.
1573 */
1574 public static function get_active_plan() {
1575 _deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::get' );
1576 return Jetpack_Plan::get();
1577 }
1578
1579 /**
1580 * Determine whether the active plan supports a particular feature
1581 *
1582 * @deprecated 7.2.0 Use Jetpack_Plan::supports.
1583 * @return bool True if plan supports feature, false if not.
1584 */
1585 public static function active_plan_supports( $feature ) {
1586 _deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::supports' );
1587 return Jetpack_Plan::supports( $feature );
1588 }
1589
1590 /**
1591 * Is Jetpack in development (offline) mode?
1592 */
1593 public static function is_development_mode() {
1594 $development_mode = false;
1595
1596 if ( defined( 'JETPACK_DEV_DEBUG' ) ) {
1597 $development_mode = JETPACK_DEV_DEBUG;
1598 } elseif ( $site_url = site_url() ) {
1599 $development_mode = false === strpos( $site_url, '.' );
1600 }
1601
1602 /**
1603 * Filters Jetpack's development mode.
1604 *
1605 * @see https://jetpack.com/support/development-mode/
1606 *
1607 * @since 2.2.1
1608 *
1609 * @param bool $development_mode Is Jetpack's development mode active.
1610 */
1611 $development_mode = ( bool ) apply_filters( 'jetpack_development_mode', $development_mode );
1612 return $development_mode;
1613 }
1614
1615 /**
1616 * Whether the site is currently onboarding or not.
1617 * A site is considered as being onboarded if it currently has an onboarding token.
1618 *
1619 * @since 5.8
1620 *
1621 * @access public
1622 * @static
1623 *
1624 * @return bool True if the site is currently onboarding, false otherwise
1625 */
1626 public static function is_onboarding() {
1627 return Jetpack_Options::get_option( 'onboarding' ) !== false;
1628 }
1629
1630 /**
1631 * Determines reason for Jetpack development mode.
1632 */
1633 public static function development_mode_trigger_text() {
1634 if ( ! Jetpack::is_development_mode() ) {
1635 return __( 'Jetpack is not in Development Mode.', 'jetpack' );
1636 }
1637
1638 if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1639 $notice = __( 'The JETPACK_DEV_DEBUG constant is defined in wp-config.php or elsewhere.', 'jetpack' );
1640 } elseif ( site_url() && false === strpos( site_url(), '.' ) ) {
1641 $notice = __( 'The site URL lacking a dot (e.g. http://localhost).', 'jetpack' );
1642 } else {
1643 $notice = __( 'The jetpack_development_mode filter is set to true.', 'jetpack' );
1644 }
1645
1646 return $notice;
1647
1648 }
1649 /**
1650 * Get Jetpack development mode notice text and notice class.
1651 *
1652 * Mirrors the checks made in Jetpack::is_development_mode
1653 *
1654 */
1655 public static function show_development_mode_notice() {
1656 if ( Jetpack::is_development_mode() ) {
1657 $notice = sprintf(
1658 /* translators: %s is a URL */
1659 __( 'In <a href="%s" target="_blank">Development Mode</a>:', 'jetpack' ),
1660 'https://jetpack.com/support/development-mode/'
1661 );
1662
1663 $notice .= ' ' . Jetpack::development_mode_trigger_text();
1664
1665 echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1666 }
1667
1668 // Throw up a notice if using a development version and as for feedback.
1669 if ( Jetpack::is_development_version() ) {
1670 /* translators: %s is a URL */
1671 $notice = sprintf( __( 'You are currently running a development version of Jetpack. <a href="%s" target="_blank">Submit your feedback</a>', 'jetpack' ), 'https://jetpack.com/contact-support/beta-group/' );
1672
1673 echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1674 }
1675 // Throw up a notice if using staging mode
1676 if ( Jetpack::is_staging_site() ) {
1677 /* translators: %s is a URL */
1678 $notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), 'https://jetpack.com/support/staging-sites/' );
1679
1680 echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1681 }
1682 }
1683
1684 /**
1685 * Whether Jetpack's version maps to a public release, or a development version.
1686 */
1687 public static function is_development_version() {
1688 /**
1689 * Allows filtering whether this is a development version of Jetpack.
1690 *
1691 * This filter is especially useful for tests.
1692 *
1693 * @since 4.3.0
1694 *
1695 * @param bool $development_version Is this a develoment version of Jetpack?
1696 */
1697 return (bool) apply_filters(
1698 'jetpack_development_version',
1699 ! preg_match( '/^\d+(\.\d+)+$/', Constants::get_constant( 'JETPACK__VERSION' ) )
1700 );
1701 }
1702
1703 /**
1704 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1705 */
1706 public static function is_user_connected( $user_id = false ) {
1707 return self::connection()->is_user_connected( $user_id );
1708 }
1709
1710 /**
1711 * Get the wpcom user data of the current|specified connected user.
1712 */
1713 public static function get_connected_user_data( $user_id = null ) {
1714 // TODO: remove in favor of Connection_Manager->get_connected_user_data
1715 if ( ! $user_id ) {
1716 $user_id = get_current_user_id();
1717 }
1718
1719 $transient_key = "jetpack_connected_user_data_$user_id";
1720
1721 if ( $cached_user_data = get_transient( $transient_key ) ) {
1722 return $cached_user_data;
1723 }
1724
1725 Jetpack::load_xml_rpc_client();
1726 $xml = new Jetpack_IXR_Client( array(
1727 'user_id' => $user_id,
1728 ) );
1729 $xml->query( 'wpcom.getUser' );
1730 if ( ! $xml->isError() ) {
1731 $user_data = $xml->getResponse();
1732 set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1733 return $user_data;
1734 }
1735
1736 return false;
1737 }
1738
1739 /**
1740 * Get the wpcom email of the current|specified connected user.
1741 */
1742 public static function get_connected_user_email( $user_id = null ) {
1743 if ( ! $user_id ) {
1744 $user_id = get_current_user_id();
1745 }
1746 Jetpack::load_xml_rpc_client();
1747 $xml = new Jetpack_IXR_Client( array(
1748 'user_id' => $user_id,
1749 ) );
1750 $xml->query( 'wpcom.getUserEmail' );
1751 if ( ! $xml->isError() ) {
1752 return $xml->getResponse();
1753 }
1754 return false;
1755 }
1756
1757 /**
1758 * Get the wpcom email of the master user.
1759 */
1760 public static function get_master_user_email() {
1761 $master_user_id = Jetpack_Options::get_option( 'master_user' );
1762 if ( $master_user_id ) {
1763 return self::get_connected_user_email( $master_user_id );
1764 }
1765 return '';
1766 }
1767
1768 function current_user_is_connection_owner() {
1769 $user_token = Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1770 return $user_token && is_object( $user_token ) && isset( $user_token->external_user_id ) && get_current_user_id() === $user_token->external_user_id;
1771 }
1772
1773 /**
1774 * Gets current user IP address.
1775 *
1776 * @param bool $check_all_headers Check all headers? Default is `false`.
1777 *
1778 * @return string Current user IP address.
1779 */
1780 public static function current_user_ip( $check_all_headers = false ) {
1781 if ( $check_all_headers ) {
1782 foreach ( array(
1783 'HTTP_CF_CONNECTING_IP',
1784 'HTTP_CLIENT_IP',
1785 'HTTP_X_FORWARDED_FOR',
1786 'HTTP_X_FORWARDED',
1787 'HTTP_X_CLUSTER_CLIENT_IP',
1788 'HTTP_FORWARDED_FOR',
1789 'HTTP_FORWARDED',
1790 'HTTP_VIA',
1791 ) as $key ) {
1792 if ( ! empty( $_SERVER[ $key ] ) ) {
1793 return $_SERVER[ $key ];
1794 }
1795 }
1796 }
1797
1798 return ! empty( $_SERVER['REMOTE_ADDR'] ) ? $_SERVER['REMOTE_ADDR'] : '';
1799 }
1800
1801 /**
1802 * Add any extra oEmbed providers that we know about and use on wpcom for feature parity.
1803 */
1804 function extra_oembed_providers() {
1805 // Cloudup: https://dev.cloudup.com/#oembed
1806 wp_oembed_add_provider( 'https://cloudup.com/*' , 'https://cloudup.com/oembed' );
1807 wp_oembed_add_provider( 'https://me.sh/*', 'https://me.sh/oembed?format=json' );
1808 wp_oembed_add_provider( '#https?://(www\.)?gfycat\.com/.*#i', 'https://api.gfycat.com/v1/oembed', true );
1809 wp_oembed_add_provider( '#https?://[^.]+\.(wistia\.com|wi\.st)/(medias|embed)/.*#', 'https://fast.wistia.com/oembed', true );
1810 wp_oembed_add_provider( '#https?://sketchfab\.com/.*#i', 'https://sketchfab.com/oembed', true );
1811 wp_oembed_add_provider( '#https?://(www\.)?icloud\.com/keynote/.*#i', 'https://iwmb.icloud.com/iwmb/oembed', true );
1812 }
1813
1814 /**
1815 * Synchronize connected user role changes
1816 */
1817 function user_role_change( $user_id ) {
1818 _deprecated_function( __METHOD__, 'jetpack-4.2', 'Users::user_role_change()' );
1819 Users::user_role_change( $user_id );
1820 }
1821
1822 /**
1823 * Loads the currently active modules.
1824 */
1825 public static function load_modules() {
1826 if (
1827 ! self::is_active()
1828 && ! self::is_development_mode()
1829 && ! self::is_onboarding()
1830 && (
1831 ! is_multisite()
1832 || ! get_site_option( 'jetpack_protect_active' )
1833 )
1834 ) {
1835 return;
1836 }
1837
1838 $version = Jetpack_Options::get_option( 'version' );
1839 if ( ! $version ) {
1840 $version = $old_version = JETPACK__VERSION . ':' . time();
1841 /** This action is documented in class.jetpack.php */
1842 do_action( 'updating_jetpack_version', $version, false );
1843 Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1844 }
1845 list( $version ) = explode( ':', $version );
1846
1847 $modules = array_filter( Jetpack::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1848
1849 $modules_data = array();
1850
1851 // Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1852 if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1853 $updated_modules = array();
1854 foreach ( $modules as $module ) {
1855 $modules_data[ $module ] = Jetpack::get_module( $module );
1856 if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1857 continue;
1858 }
1859
1860 if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1861 continue;
1862 }
1863
1864 $updated_modules[] = $module;
1865 }
1866
1867 $modules = array_diff( $modules, $updated_modules );
1868 }
1869
1870 $is_development_mode = Jetpack::is_development_mode();
1871
1872 foreach ( $modules as $index => $module ) {
1873 // If we're in dev mode, disable modules requiring a connection
1874 if ( $is_development_mode ) {
1875 // Prime the pump if we need to
1876 if ( empty( $modules_data[ $module ] ) ) {
1877 $modules_data[ $module ] = Jetpack::get_module( $module );
1878 }
1879 // If the module requires a connection, but we're in local mode, don't include it.
1880 if ( $modules_data[ $module ]['requires_connection'] ) {
1881 continue;
1882 }
1883 }
1884
1885 if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1886 continue;
1887 }
1888
1889 if ( ! include_once( Jetpack::get_module_path( $module ) ) ) {
1890 unset( $modules[ $index ] );
1891 self::update_active_modules( array_values( $modules ) );
1892 continue;
1893 }
1894
1895 /**
1896 * Fires when a specific module is loaded.
1897 * The dynamic part of the hook, $module, is the module slug.
1898 *
1899 * @since 1.1.0
1900 */
1901 do_action( 'jetpack_module_loaded_' . $module );
1902 }
1903
1904 /**
1905 * Fires when all the modules are loaded.
1906 *
1907 * @since 1.1.0
1908 */
1909 do_action( 'jetpack_modules_loaded' );
1910
1911 // Load module-specific code that is needed even when a module isn't active. Loaded here because code contained therein may need actions such as setup_theme.
1912 require_once( JETPACK__PLUGIN_DIR . 'modules/module-extras.php' );
1913 }
1914
1915 /**
1916 * Check if Jetpack's REST API compat file should be included
1917 * @action plugins_loaded
1918 * @return null
1919 */
1920 public function check_rest_api_compat() {
1921 /**
1922 * Filters the list of REST API compat files to be included.
1923 *
1924 * @since 2.2.5
1925 *
1926 * @param array $args Array of REST API compat files to include.
1927 */
1928 $_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
1929
1930 if ( function_exists( 'bbpress' ) )
1931 $_jetpack_rest_api_compat_includes[] = JETPACK__PLUGIN_DIR . 'class.jetpack-bbpress-json-api-compat.php';
1932
1933 foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include )
1934 require_once $_jetpack_rest_api_compat_include;
1935 }
1936
1937 /**
1938 * Gets all plugins currently active in values, regardless of whether they're
1939 * traditionally activated or network activated.
1940 *
1941 * @todo Store the result in core's object cache maybe?
1942 */
1943 public static function get_active_plugins() {
1944 $active_plugins = (array) get_option( 'active_plugins', array() );
1945
1946 if ( is_multisite() ) {
1947 // Due to legacy code, active_sitewide_plugins stores them in the keys,
1948 // whereas active_plugins stores them in the values.
1949 $network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
1950 if ( $network_plugins ) {
1951 $active_plugins = array_merge( $active_plugins, $network_plugins );
1952 }
1953 }
1954
1955 sort( $active_plugins );
1956
1957 return array_unique( $active_plugins );
1958 }
1959
1960 /**
1961 * Gets and parses additional plugin data to send with the heartbeat data
1962 *
1963 * @since 3.8.1
1964 *
1965 * @return array Array of plugin data
1966 */
1967 public static function get_parsed_plugin_data() {
1968 if ( ! function_exists( 'get_plugins' ) ) {
1969 require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
1970 }
1971 /** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
1972 $all_plugins = apply_filters( 'all_plugins', get_plugins() );
1973 $active_plugins = Jetpack::get_active_plugins();
1974
1975 $plugins = array();
1976 foreach ( $all_plugins as $path => $plugin_data ) {
1977 $plugins[ $path ] = array(
1978 'is_active' => in_array( $path, $active_plugins ),
1979 'file' => $path,
1980 'name' => $plugin_data['Name'],
1981 'version' => $plugin_data['Version'],
1982 'author' => $plugin_data['Author'],
1983 );
1984 }
1985
1986 return $plugins;
1987 }
1988
1989 /**
1990 * Gets and parses theme data to send with the heartbeat data
1991 *
1992 * @since 3.8.1
1993 *
1994 * @return array Array of theme data
1995 */
1996 public static function get_parsed_theme_data() {
1997 $all_themes = wp_get_themes( array( 'allowed' => true ) );
1998 $header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
1999
2000 $themes = array();
2001 foreach ( $all_themes as $slug => $theme_data ) {
2002 $theme_headers = array();
2003 foreach ( $header_keys as $header_key ) {
2004 $theme_headers[ $header_key ] = $theme_data->get( $header_key );
2005 }
2006
2007 $themes[ $slug ] = array(
2008 'is_active_theme' => $slug == wp_get_theme()->get_template(),
2009 'slug' => $slug,
2010 'theme_root' => $theme_data->get_theme_root_uri(),
2011 'parent' => $theme_data->parent(),
2012 'headers' => $theme_headers
2013 );
2014 }
2015
2016 return $themes;
2017 }
2018
2019 /**
2020 * Checks whether a specific plugin is active.
2021 *
2022 * We don't want to store these in a static variable, in case
2023 * there are switch_to_blog() calls involved.
2024 */
2025 public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
2026 return in_array( $plugin, self::get_active_plugins() );
2027 }
2028
2029 /**
2030 * Check if Jetpack's Open Graph tags should be used.
2031 * If certain plugins are active, Jetpack's og tags are suppressed.
2032 *
2033 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2034 * @action plugins_loaded
2035 * @return null
2036 */
2037 public function check_open_graph() {
2038 if ( in_array( 'publicize', Jetpack::get_active_modules() ) || in_array( 'sharedaddy', Jetpack::get_active_modules() ) ) {
2039 add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
2040 }
2041
2042 $active_plugins = self::get_active_plugins();
2043
2044 if ( ! empty( $active_plugins ) ) {
2045 foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
2046 if ( in_array( $plugin, $active_plugins ) ) {
2047 add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
2048 break;
2049 }
2050 }
2051 }
2052
2053 /**
2054 * Allow the addition of Open Graph Meta Tags to all pages.
2055 *
2056 * @since 2.0.3
2057 *
2058 * @param bool false Should Open Graph Meta tags be added. Default to false.
2059 */
2060 if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
2061 require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
2062 }
2063 }
2064
2065 /**
2066 * Check if Jetpack's Twitter tags should be used.
2067 * If certain plugins are active, Jetpack's twitter tags are suppressed.
2068 *
2069 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2070 * @action plugins_loaded
2071 * @return null
2072 */
2073 public function check_twitter_tags() {
2074
2075 $active_plugins = self::get_active_plugins();
2076
2077 if ( ! empty( $active_plugins ) ) {
2078 foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
2079 if ( in_array( $plugin, $active_plugins ) ) {
2080 add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
2081 break;
2082 }
2083 }
2084 }
2085
2086 /**
2087 * Allow Twitter Card Meta tags to be disabled.
2088 *
2089 * @since 2.6.0
2090 *
2091 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
2092 */
2093 if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
2094 require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
2095 }
2096 }
2097
2098 /**
2099 * Allows plugins to submit security reports.
2100 *
2101 * @param string $type Report type (login_form, backup, file_scanning, spam)
2102 * @param string $plugin_file Plugin __FILE__, so that we can pull plugin data
2103 * @param array $args See definitions above
2104 */
2105 public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
2106 _deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
2107 }
2108
2109 /* Jetpack Options API */
2110
2111 public static function get_option_names( $type = 'compact' ) {
2112 return Jetpack_Options::get_option_names( $type );
2113 }
2114
2115 /**
2116 * Returns the requested option. Looks in jetpack_options or jetpack_$name as appropriate.
2117 *
2118 * @param string $name Option name
2119 * @param mixed $default (optional)
2120 */
2121 public static function get_option( $name, $default = false ) {
2122 return Jetpack_Options::get_option( $name, $default );
2123 }
2124
2125 /**
2126 * Updates the single given option. Updates jetpack_options or jetpack_$name as appropriate.
2127 *
2128 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
2129 * @param string $name Option name
2130 * @param mixed $value Option value
2131 */
2132 public static function update_option( $name, $value ) {
2133 _deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
2134 return Jetpack_Options::update_option( $name, $value );
2135 }
2136
2137 /**
2138 * Updates the multiple given options. Updates jetpack_options and/or jetpack_$name as appropriate.
2139 *
2140 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
2141 * @param array $array array( option name => option value, ... )
2142 */
2143 public static function update_options( $array ) {
2144 _deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
2145 return Jetpack_Options::update_options( $array );
2146 }
2147
2148 /**
2149 * Deletes the given option. May be passed multiple option names as an array.
2150 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
2151 *
2152 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
2153 * @param string|array $names
2154 */
2155 public static function delete_option( $names ) {
2156 _deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
2157 return Jetpack_Options::delete_option( $names );
2158 }
2159
2160 /**
2161 * Enters a user token into the user_tokens option
2162 *
2163 * @param int $user_id
2164 * @param string $token
2165 * return bool
2166 */
2167 public static function update_user_token( $user_id, $token, $is_master_user ) {
2168 // not designed for concurrent updates
2169 $user_tokens = Jetpack_Options::get_option( 'user_tokens' );
2170 if ( ! is_array( $user_tokens ) )
2171 $user_tokens = array();
2172 $user_tokens[$user_id] = $token;
2173 if ( $is_master_user ) {
2174 $master_user = $user_id;
2175 $options = compact( 'user_tokens', 'master_user' );
2176 } else {
2177 $options = compact( 'user_tokens' );
2178 }
2179 return Jetpack_Options::update_options( $options );
2180 }
2181
2182 /**
2183 * Returns an array of all PHP files in the specified absolute path.
2184 * Equivalent to glob( "$absolute_path/*.php" ).
2185 *
2186 * @param string $absolute_path The absolute path of the directory to search.
2187 * @return array Array of absolute paths to the PHP files.
2188 */
2189 public static function glob_php( $absolute_path ) {
2190 if ( function_exists( 'glob' ) ) {
2191 return glob( "$absolute_path/*.php" );
2192 }
2193
2194 $absolute_path = untrailingslashit( $absolute_path );
2195 $files = array();
2196 if ( ! $dir = @opendir( $absolute_path ) ) {
2197 return $files;
2198 }
2199
2200 while ( false !== $file = readdir( $dir ) ) {
2201 if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
2202 continue;
2203 }
2204
2205 $file = "$absolute_path/$file";
2206
2207 if ( ! is_file( $file ) ) {
2208 continue;
2209 }
2210
2211 $files[] = $file;
2212 }
2213
2214 closedir( $dir );
2215
2216 return $files;
2217 }
2218
2219 public static function activate_new_modules( $redirect = false ) {
2220 if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
2221 return;
2222 }
2223
2224 $jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
2225 if ( ! $jetpack_old_version ) {
2226 $jetpack_old_version = $version = $old_version = '1.1:' . time();
2227 /** This action is documented in class.jetpack.php */
2228 do_action( 'updating_jetpack_version', $version, false );
2229 Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2230 }
2231
2232 list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
2233
2234 if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
2235 return;
2236 }
2237
2238 $active_modules = Jetpack::get_active_modules();
2239 $reactivate_modules = array();
2240 foreach ( $active_modules as $active_module ) {
2241 $module = Jetpack::get_module( $active_module );
2242 if ( ! isset( $module['changed'] ) ) {
2243 continue;
2244 }
2245
2246 if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
2247 continue;
2248 }
2249
2250 $reactivate_modules[] = $active_module;
2251 Jetpack::deactivate_module( $active_module );
2252 }
2253
2254 $new_version = JETPACK__VERSION . ':' . time();
2255 /** This action is documented in class.jetpack.php */
2256 do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2257 Jetpack_Options::update_options(
2258 array(
2259 'version' => $new_version,
2260 'old_version' => $jetpack_old_version,
2261 )
2262 );
2263
2264 Jetpack::state( 'message', 'modules_activated' );
2265 Jetpack::activate_default_modules( $jetpack_version, JETPACK__VERSION, $reactivate_modules );
2266
2267 if ( $redirect ) {
2268 $page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2269 if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2270 $page = $_GET['page'];
2271 }
2272
2273 wp_safe_redirect( Jetpack::admin_url( 'page=' . $page ) );
2274 exit;
2275 }
2276 }
2277
2278 /**
2279 * List available Jetpack modules. Simply lists .php files in /modules/.
2280 * Make sure to tuck away module "library" files in a sub-directory.
2281 */
2282 public static function get_available_modules( $min_version = false, $max_version = false ) {
2283 static $modules = null;
2284
2285 if ( ! isset( $modules ) ) {
2286 $available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2287 // Use the cache if we're on the front-end and it's available...
2288 if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2289 $modules = $available_modules_option[ JETPACK__VERSION ];
2290 } else {
2291 $files = Jetpack::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2292
2293 $modules = array();
2294
2295 foreach ( $files as $file ) {
2296 if ( ! $headers = Jetpack::get_module( $file ) ) {
2297 continue;
2298 }
2299
2300 $modules[ Jetpack::get_module_slug( $file ) ] = $headers['introduced'];
2301 }
2302
2303 Jetpack_Options::update_option( 'available_modules', array(
2304 JETPACK__VERSION => $modules,
2305 ) );
2306 }
2307 }
2308
2309 /**
2310 * Filters the array of modules available to be activated.
2311 *
2312 * @since 2.4.0
2313 *
2314 * @param array $modules Array of available modules.
2315 * @param string $min_version Minimum version number required to use modules.
2316 * @param string $max_version Maximum version number required to use modules.
2317 */
2318 $mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
2319
2320 if ( ! $min_version && ! $max_version ) {
2321 return array_keys( $mods );
2322 }
2323
2324 $r = array();
2325 foreach ( $mods as $slug => $introduced ) {
2326 if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2327 continue;
2328 }
2329
2330 if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2331 continue;
2332 }
2333
2334 $r[] = $slug;
2335 }
2336
2337 return $r;
2338 }
2339
2340 /**
2341 * Default modules loaded on activation.
2342 */
2343 public static function get_default_modules( $min_version = false, $max_version = false ) {
2344 $return = array();
2345
2346 foreach ( Jetpack::get_available_modules( $min_version, $max_version ) as $module ) {
2347 $module_data = Jetpack::get_module( $module );
2348
2349 switch ( strtolower( $module_data['auto_activate'] ) ) {
2350 case 'yes' :
2351 $return[] = $module;
2352 break;
2353 case 'public' :
2354 if ( Jetpack_Options::get_option( 'public' ) ) {
2355 $return[] = $module;
2356 }
2357 break;
2358 case 'no' :
2359 default :
2360 break;
2361 }
2362 }
2363 /**
2364 * Filters the array of default modules.
2365 *
2366 * @since 2.5.0
2367 *
2368 * @param array $return Array of default modules.
2369 * @param string $min_version Minimum version number required to use modules.
2370 * @param string $max_version Maximum version number required to use modules.
2371 */
2372 return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
2373 }
2374
2375 /**
2376 * Checks activated modules during auto-activation to determine
2377 * if any of those modules are being deprecated. If so, close
2378 * them out, and add any replacement modules.
2379 *
2380 * Runs at priority 99 by default.
2381 *
2382 * This is run late, so that it can still activate a module if
2383 * the new module is a replacement for another that the user
2384 * currently has active, even if something at the normal priority
2385 * would kibosh everything.
2386 *
2387 * @since 2.6
2388 * @uses jetpack_get_default_modules filter
2389 * @param array $modules
2390 * @return array
2391 */
2392 function handle_deprecated_modules( $modules ) {
2393 $deprecated_modules = array(
2394 'debug' => null, // Closed out and moved to the debugger library.
2395 'wpcc' => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2396 'gplus-authorship' => null, // Closed out in 3.2 -- Google dropped support.
2397 );
2398
2399 // Don't activate SSO if they never completed activating WPCC.
2400 if ( Jetpack::is_module_active( 'wpcc' ) ) {
2401 $wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2402 if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2403 $deprecated_modules['wpcc'] = null;
2404 }
2405 }
2406
2407 foreach ( $deprecated_modules as $module => $replacement ) {
2408 if ( Jetpack::is_module_active( $module ) ) {
2409 self::deactivate_module( $module );
2410 if ( $replacement ) {
2411 $modules[] = $replacement;
2412 }
2413 }
2414 }
2415
2416 return array_unique( $modules );
2417 }
2418
2419 /**
2420 * Checks activated plugins during auto-activation to determine
2421 * if any of those plugins are in the list with a corresponding module
2422 * that is not compatible with the plugin. The module will not be allowed
2423 * to auto-activate.
2424 *
2425 * @since 2.6
2426 * @uses jetpack_get_default_modules filter
2427 * @param array $modules
2428 * @return array
2429 */
2430 function filter_default_modules( $modules ) {
2431
2432 $active_plugins = self::get_active_plugins();
2433
2434 if ( ! empty( $active_plugins ) ) {
2435
2436 // For each module we'd like to auto-activate...
2437 foreach ( $modules as $key => $module ) {
2438 // If there are potential conflicts for it...
2439 if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2440 // For each potential conflict...
2441 foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2442 // If that conflicting plugin is active...
2443 if ( in_array( $plugin, $active_plugins ) ) {
2444 // Remove that item from being auto-activated.
2445 unset( $modules[ $key ] );
2446 }
2447 }
2448 }
2449 }
2450 }
2451
2452 return $modules;
2453 }
2454
2455 /**
2456 * Extract a module's slug from its full path.
2457 */
2458 public static function get_module_slug( $file ) {
2459 return str_replace( '.php', '', basename( $file ) );
2460 }
2461
2462 /**
2463 * Generate a module's path from its slug.
2464 */
2465 public static function get_module_path( $slug ) {
2466 /**
2467 * Filters the path of a modules.
2468 *
2469 * @since 7.4.0
2470 *
2471 * @param array $return The absolute path to a module's root php file
2472 * @param string $slug The module slug
2473 */
2474 return apply_filters( 'jetpack_get_module_path', JETPACK__PLUGIN_DIR . "modules/$slug.php", $slug );
2475 }
2476
2477 /**
2478 * Load module data from module file. Headers differ from WordPress
2479 * plugin headers to avoid them being identified as standalone
2480 * plugins on the WordPress plugins page.
2481 */
2482 public static function get_module( $module ) {
2483 $headers = array(
2484 'name' => 'Module Name',
2485 'description' => 'Module Description',
2486 'sort' => 'Sort Order',
2487 'recommendation_order' => 'Recommendation Order',
2488 'introduced' => 'First Introduced',
2489 'changed' => 'Major Changes In',
2490 'deactivate' => 'Deactivate',
2491 'free' => 'Free',
2492 'requires_connection' => 'Requires Connection',
2493 'auto_activate' => 'Auto Activate',
2494 'module_tags' => 'Module Tags',
2495 'feature' => 'Feature',
2496 'additional_search_queries' => 'Additional Search Queries',
2497 'plan_classes' => 'Plans',
2498 );
2499
2500 $file = Jetpack::get_module_path( Jetpack::get_module_slug( $module ) );
2501
2502 $mod = Jetpack::get_file_data( $file, $headers );
2503 if ( empty( $mod['name'] ) ) {
2504 return false;
2505 }
2506
2507 $mod['sort'] = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2508 $mod['recommendation_order'] = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2509 $mod['deactivate'] = empty( $mod['deactivate'] );
2510 $mod['free'] = empty( $mod['free'] );
2511 $mod['requires_connection'] = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2512
2513 if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2514 $mod['auto_activate'] = 'No';
2515 } else {
2516 $mod['auto_activate'] = (string) $mod['auto_activate'];
2517 }
2518
2519 if ( $mod['module_tags'] ) {
2520 $mod['module_tags'] = explode( ',', $mod['module_tags'] );
2521 $mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2522 $mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2523 } else {
2524 $mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2525 }
2526
2527 if ( $mod['plan_classes'] ) {
2528 $mod['plan_classes'] = explode( ',', $mod['plan_classes'] );
2529 $mod['plan_classes'] = array_map( 'strtolower', array_map( 'trim', $mod['plan_classes'] ) );
2530 } else {
2531 $mod['plan_classes'] = array( 'free' );
2532 }
2533
2534 if ( $mod['feature'] ) {
2535 $mod['feature'] = explode( ',', $mod['feature'] );
2536 $mod['feature'] = array_map( 'trim', $mod['feature'] );
2537 } else {
2538 $mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2539 }
2540
2541 /**
2542 * Filters the feature array on a module.
2543 *
2544 * This filter allows you to control where each module is filtered: Recommended,
2545 * and the default "Other" listing.
2546 *
2547 * @since 3.5.0
2548 *
2549 * @param array $mod['feature'] The areas to feature this module:
2550 * 'Recommended' shows on the main Jetpack admin screen.
2551 * 'Other' should be the default if no other value is in the array.
2552 * @param string $module The slug of the module, e.g. sharedaddy.
2553 * @param array $mod All the currently assembled module data.
2554 */
2555 $mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
2556
2557 /**
2558 * Filter the returned data about a module.
2559 *
2560 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2561 * so please be careful.
2562 *
2563 * @since 3.6.0
2564 *
2565 * @param array $mod The details of the requested module.
2566 * @param string $module The slug of the module, e.g. sharedaddy
2567 * @param string $file The path to the module source file.
2568 */
2569 return apply_filters( 'jetpack_get_module', $mod, $module, $file );
2570 }
2571
2572 /**
2573 * Like core's get_file_data implementation, but caches the result.
2574 */
2575 public static function get_file_data( $file, $headers ) {
2576 //Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2577 $file_name = basename( $file );
2578
2579 $cache_key = 'jetpack_file_data_' . JETPACK__VERSION;
2580
2581 $file_data_option = get_transient( $cache_key );
2582
2583 if ( false === $file_data_option ) {
2584 $file_data_option = array();
2585 }
2586
2587 $key = md5( $file_name . serialize( $headers ) );
2588 $refresh_cache = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2589
2590 // If we don't need to refresh the cache, and already have the value, short-circuit!
2591 if ( ! $refresh_cache && isset( $file_data_option[ $key ] ) ) {
2592 return $file_data_option[ $key ];
2593 }
2594
2595 $data = get_file_data( $file, $headers );
2596
2597 $file_data_option[ $key ] = $data;
2598
2599 set_transient( $cache_key, $file_data_option, 29 * DAY_IN_SECONDS );
2600
2601 return $data;
2602 }
2603
2604
2605 /**
2606 * Return translated module tag.
2607 *
2608 * @param string $tag Tag as it appears in each module heading.
2609 *
2610 * @return mixed
2611 */
2612 public static function translate_module_tag( $tag ) {
2613 return jetpack_get_module_i18n_tag( $tag );
2614 }
2615
2616 /**
2617 * Get i18n strings as a JSON-encoded string
2618 *
2619 * @return string The locale as JSON
2620 */
2621 public static function get_i18n_data_json() {
2622
2623 // WordPress 5.0 uses md5 hashes of file paths to associate translation
2624 // JSON files with the file they should be included for. This is an md5
2625 // of '_inc/build/admin.js'.
2626 $path_md5 = '1bac79e646a8bf4081a5011ab72d5807';
2627
2628 $i18n_json =
2629 JETPACK__PLUGIN_DIR
2630 . 'languages/json/jetpack-'
2631 . get_user_locale()
2632 . '-'
2633 . $path_md5
2634 . '.json';
2635
2636 if ( is_file( $i18n_json ) && is_readable( $i18n_json ) ) {
2637 $locale_data = @file_get_contents( $i18n_json );
2638 if ( $locale_data ) {
2639 return $locale_data;
2640 }
2641 }
2642
2643 // Return valid empty Jed locale
2644 return '{ "locale_data": { "messages": { "": {} } } }';
2645 }
2646
2647 /**
2648 * Add locale data setup to wp-i18n
2649 *
2650 * Any Jetpack script that depends on wp-i18n should use this method to set up the locale.
2651 *
2652 * The locale setup depends on an adding inline script. This is error-prone and could easily
2653 * result in multiple additions of the same script when exactly 0 or 1 is desireable.
2654 *
2655 * This method provides a safe way to request the setup multiple times but add the script at
2656 * most once.
2657 *
2658 * @since 6.7.0
2659 *
2660 * @return void
2661 */
2662 public static function setup_wp_i18n_locale_data() {
2663 static $script_added = false;
2664 if ( ! $script_added ) {
2665 $script_added = true;
2666 wp_add_inline_script(
2667 'wp-i18n',
2668 'wp.i18n.setLocaleData( ' . Jetpack::get_i18n_data_json() . ', \'jetpack\' );'
2669 );
2670 }
2671 }
2672
2673 /**
2674 * Return module name translation. Uses matching string created in modules/module-headings.php.
2675 *
2676 * @since 3.9.2
2677 *
2678 * @param array $modules
2679 *
2680 * @return string|void
2681 */
2682 public static function get_translated_modules( $modules ) {
2683 foreach ( $modules as $index => $module ) {
2684 $i18n_module = jetpack_get_module_i18n( $module['module'] );
2685 if ( isset( $module['name'] ) ) {
2686 $modules[ $index ]['name'] = $i18n_module['name'];
2687 }
2688 if ( isset( $module['description'] ) ) {
2689 $modules[ $index ]['description'] = $i18n_module['description'];
2690 $modules[ $index ]['short_description'] = $i18n_module['description'];
2691 }
2692 }
2693 return $modules;
2694 }
2695
2696 /**
2697 * Get a list of activated modules as an array of module slugs.
2698 */
2699 public static function get_active_modules() {
2700 $active = Jetpack_Options::get_option( 'active_modules' );
2701
2702 if ( ! is_array( $active ) ) {
2703 $active = array();
2704 }
2705
2706 if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2707 $active[] = 'vaultpress';
2708 } else {
2709 $active = array_diff( $active, array( 'vaultpress' ) );
2710 }
2711
2712 //If protect is active on the main site of a multisite, it should be active on all sites.
2713 if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2714 $active[] = 'protect';
2715 }
2716
2717 /**
2718 * Allow filtering of the active modules.
2719 *
2720 * Gives theme and plugin developers the power to alter the modules that
2721 * are activated on the fly.
2722 *
2723 * @since 5.8.0
2724 *
2725 * @param array $active Array of active module slugs.
2726 */
2727 $active = apply_filters( 'jetpack_active_modules', $active );
2728
2729 return array_unique( $active );
2730 }
2731
2732 /**
2733 * Check whether or not a Jetpack module is active.
2734 *
2735 * @param string $module The slug of a Jetpack module.
2736 * @return bool
2737 *
2738 * @static
2739 */
2740 public static function is_module_active( $module ) {
2741 return in_array( $module, self::get_active_modules() );
2742 }
2743
2744 public static function is_module( $module ) {
2745 return ! empty( $module ) && ! validate_file( $module, Jetpack::get_available_modules() );
2746 }
2747
2748 /**
2749 * Catches PHP errors. Must be used in conjunction with output buffering.
2750 *
2751 * @param bool $catch True to start catching, False to stop.
2752 *
2753 * @static
2754 */
2755 public static function catch_errors( $catch ) {
2756 static $display_errors, $error_reporting;
2757
2758 if ( $catch ) {
2759 $display_errors = @ini_set( 'display_errors', 1 );
2760 $error_reporting = @error_reporting( E_ALL );
2761 add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2762 } else {
2763 @ini_set( 'display_errors', $display_errors );
2764 @error_reporting( $error_reporting );
2765 remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2766 }
2767 }
2768
2769 /**
2770 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2771 */
2772 public static function catch_errors_on_shutdown() {
2773 Jetpack::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2774 }
2775
2776 /**
2777 * Rewrite any string to make paths easier to read.
2778 *
2779 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2780 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2781 *
2782 * @param $string
2783 * @return mixed
2784 */
2785 public static function alias_directories( $string ) {
2786 // ABSPATH has a trailing slash.
2787 $string = str_replace( ABSPATH, 'ABSPATH/', $string );
2788 // WP_CONTENT_DIR does not have a trailing slash.
2789 $string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2790
2791 return $string;
2792 }
2793
2794 public static function activate_default_modules(
2795 $min_version = false,
2796 $max_version = false,
2797 $other_modules = array(),
2798 $redirect = true,
2799 $send_state_messages = true
2800 ) {
2801 $jetpack = Jetpack::init();
2802
2803 $modules = Jetpack::get_default_modules( $min_version, $max_version );
2804 $modules = array_merge( $other_modules, $modules );
2805
2806 // Look for standalone plugins and disable if active.
2807
2808 $to_deactivate = array();
2809 foreach ( $modules as $module ) {
2810 if ( isset( $jetpack->plugins_to_deactivate[$module] ) ) {
2811 $to_deactivate[$module] = $jetpack->plugins_to_deactivate[$module];
2812 }
2813 }
2814
2815 $deactivated = array();
2816 foreach ( $to_deactivate as $module => $deactivate_me ) {
2817 list( $probable_file, $probable_title ) = $deactivate_me;
2818 if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2819 $deactivated[] = $module;
2820 }
2821 }
2822
2823 if ( $deactivated && $redirect ) {
2824 Jetpack::state( 'deactivated_plugins', join( ',', $deactivated ) );
2825
2826 $url = add_query_arg(
2827 array(
2828 'action' => 'activate_default_modules',
2829 '_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2830 ),
2831 add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), Jetpack::admin_url( 'page=jetpack' ) )
2832 );
2833 wp_safe_redirect( $url );
2834 exit;
2835 }
2836
2837 /**
2838 * Fires before default modules are activated.
2839 *
2840 * @since 1.9.0
2841 *
2842 * @param string $min_version Minimum version number required to use modules.
2843 * @param string $max_version Maximum version number required to use modules.
2844 * @param array $other_modules Array of other modules to activate alongside the default modules.
2845 */
2846 do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2847
2848 // Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2849 if ( $send_state_messages ) {
2850 Jetpack::restate();
2851 Jetpack::catch_errors( true );
2852 }
2853
2854 $active = Jetpack::get_active_modules();
2855
2856 foreach ( $modules as $module ) {
2857 if ( did_action( "jetpack_module_loaded_$module" ) ) {
2858 $active[] = $module;
2859 self::update_active_modules( $active );
2860 continue;
2861 }
2862
2863 if ( $send_state_messages && in_array( $module, $active ) ) {
2864 $module_info = Jetpack::get_module( $module );
2865 if ( ! $module_info['deactivate'] ) {
2866 $state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2867 if ( $active_state = Jetpack::state( $state ) ) {
2868 $active_state = explode( ',', $active_state );
2869 } else {
2870 $active_state = array();
2871 }
2872 $active_state[] = $module;
2873 Jetpack::state( $state, implode( ',', $active_state ) );
2874 }
2875 continue;
2876 }
2877
2878 $file = Jetpack::get_module_path( $module );
2879 if ( ! file_exists( $file ) ) {
2880 continue;
2881 }
2882
2883 // we'll override this later if the plugin can be included without fatal error
2884 if ( $redirect ) {
2885 wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2886 }
2887
2888 if ( $send_state_messages ) {
2889 Jetpack::state( 'error', 'module_activation_failed' );
2890 Jetpack::state( 'module', $module );
2891 }
2892
2893 ob_start();
2894 require_once $file;
2895
2896 $active[] = $module;
2897
2898 if ( $send_state_messages ) {
2899
2900 $state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2901 if ( $active_state = Jetpack::state( $state ) ) {
2902 $active_state = explode( ',', $active_state );
2903 } else {
2904 $active_state = array();
2905 }
2906 $active_state[] = $module;
2907 Jetpack::state( $state, implode( ',', $active_state ) );
2908 }
2909
2910 Jetpack::update_active_modules( $active );
2911
2912 ob_end_clean();
2913 }
2914
2915 if ( $send_state_messages ) {
2916 Jetpack::state( 'error', false );
2917 Jetpack::state( 'module', false );
2918 }
2919
2920 Jetpack::catch_errors( false );
2921 /**
2922 * Fires when default modules are activated.
2923 *
2924 * @since 1.9.0
2925 *
2926 * @param string $min_version Minimum version number required to use modules.
2927 * @param string $max_version Maximum version number required to use modules.
2928 * @param array $other_modules Array of other modules to activate alongside the default modules.
2929 */
2930 do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
2931 }
2932
2933 public static function activate_module( $module, $exit = true, $redirect = true ) {
2934 /**
2935 * Fires before a module is activated.
2936 *
2937 * @since 2.6.0
2938 *
2939 * @param string $module Module slug.
2940 * @param bool $exit Should we exit after the module has been activated. Default to true.
2941 * @param bool $redirect Should the user be redirected after module activation? Default to true.
2942 */
2943 do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
2944
2945 $jetpack = Jetpack::init();
2946
2947 if ( ! strlen( $module ) )
2948 return false;
2949
2950 if ( ! Jetpack::is_module( $module ) )
2951 return false;
2952
2953 // If it's already active, then don't do it again
2954 $active = Jetpack::get_active_modules();
2955 foreach ( $active as $act ) {
2956 if ( $act == $module )
2957 return true;
2958 }
2959
2960 $module_data = Jetpack::get_module( $module );
2961
2962 if ( ! Jetpack::is_active() ) {
2963 if ( ! Jetpack::is_development_mode() && ! Jetpack::is_onboarding() )
2964 return false;
2965
2966 // If we're not connected but in development mode, make sure the module doesn't require a connection
2967 if ( Jetpack::is_development_mode() && $module_data['requires_connection'] )
2968 return false;
2969 }
2970
2971 // Check and see if the old plugin is active
2972 if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2973 // Deactivate the old plugin
2974 if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
2975 // If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
2976 // We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
2977 Jetpack::state( 'deactivated_plugins', $module );
2978 wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
2979 exit;
2980 }
2981 }
2982
2983 // Protect won't work with mis-configured IPs
2984 if ( 'protect' === $module ) {
2985 include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
2986 if ( ! jetpack_protect_get_ip() ) {
2987 Jetpack::state( 'message', 'protect_misconfigured_ip' );
2988 return false;
2989 }
2990 }
2991
2992 if ( ! Jetpack_Plan::supports( $module ) ) {
2993 return false;
2994 }
2995
2996 // Check the file for fatal errors, a la wp-admin/plugins.php::activate
2997 Jetpack::state( 'module', $module );
2998 Jetpack::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
2999
3000 Jetpack::catch_errors( true );
3001 ob_start();
3002 require Jetpack::get_module_path( $module );
3003 /** This action is documented in class.jetpack.php */
3004 do_action( 'jetpack_activate_module', $module );
3005 $active[] = $module;
3006 Jetpack::update_active_modules( $active );
3007
3008 Jetpack::state( 'error', false ); // the override
3009 ob_end_clean();
3010 Jetpack::catch_errors( false );
3011
3012 if ( $redirect ) {
3013 wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3014 }
3015 if ( $exit ) {
3016 exit;
3017 }
3018 return true;
3019 }
3020
3021 function activate_module_actions( $module ) {
3022 _deprecated_function( __METHOD__, 'jetpack-4.2' );
3023 }
3024
3025 public static function deactivate_module( $module ) {
3026 /**
3027 * Fires when a module is deactivated.
3028 *
3029 * @since 1.9.0
3030 *
3031 * @param string $module Module slug.
3032 */
3033 do_action( 'jetpack_pre_deactivate_module', $module );
3034
3035 $jetpack = Jetpack::init();
3036
3037 $active = Jetpack::get_active_modules();
3038 $new = array_filter( array_diff( $active, (array) $module ) );
3039
3040 return self::update_active_modules( $new );
3041 }
3042
3043 public static function enable_module_configurable( $module ) {
3044 $module = Jetpack::get_module_slug( $module );
3045 add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
3046 }
3047
3048 /**
3049 * Composes a module configure URL. It uses Jetpack settings search as default value
3050 * It is possible to redefine resulting URL by using "jetpack_module_configuration_url_$module" filter
3051 *
3052 * @param string $module Module slug
3053 * @return string $url module configuration URL
3054 */
3055 public static function module_configuration_url( $module ) {
3056 $module = Jetpack::get_module_slug( $module );
3057 $default_url = Jetpack::admin_url() . "#/settings?term=$module";
3058 /**
3059 * Allows to modify configure_url of specific module to be able to redirect to some custom location.
3060 *
3061 * @since 6.9.0
3062 *
3063 * @param string $default_url Default url, which redirects to jetpack settings page.
3064 */
3065 $url = apply_filters( 'jetpack_module_configuration_url_' . $module, $default_url );
3066
3067 return $url;
3068 }
3069
3070 /* Installation */
3071 public static function bail_on_activation( $message, $deactivate = true ) {
3072 ?>
3073 <!doctype html>
3074 <html>
3075 <head>
3076 <meta charset="<?php bloginfo( 'charset' ); ?>">
3077 <style>
3078 * {
3079 text-align: center;
3080 margin: 0;
3081 padding: 0;
3082 font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
3083 }
3084 p {
3085 margin-top: 1em;
3086 font-size: 18px;
3087 }
3088 </style>
3089 <body>
3090 <p><?php echo esc_html( $message ); ?></p>
3091 </body>
3092 </html>
3093 <?php
3094 if ( $deactivate ) {
3095 $plugins = get_option( 'active_plugins' );
3096 $jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
3097 $update = false;
3098 foreach ( $plugins as $i => $plugin ) {
3099 if ( $plugin === $jetpack ) {
3100 $plugins[$i] = false;
3101 $update = true;
3102 }
3103 }
3104
3105 if ( $update ) {
3106 update_option( 'active_plugins', array_filter( $plugins ) );
3107 }
3108 }
3109 exit;
3110 }
3111
3112 /**
3113 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
3114 * @static
3115 */
3116 public static function plugin_activation( $network_wide ) {
3117 Jetpack_Options::update_option( 'activated', 1 );
3118
3119 if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
3120 Jetpack::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
3121 }
3122
3123 if ( $network_wide )
3124 Jetpack::state( 'network_nag', true );
3125
3126 // For firing one-off events (notices) immediately after activation
3127 set_transient( 'activated_jetpack', true, .1 * MINUTE_IN_SECONDS );
3128
3129 update_option( 'jetpack_activation_source', self::get_activation_source( wp_get_referer() ) );
3130
3131 Jetpack::plugin_initialize();
3132 }
3133
3134 public static function get_activation_source( $referer_url ) {
3135
3136 if ( defined( 'WP_CLI' ) && WP_CLI ) {
3137 return array( 'wp-cli', null );
3138 }
3139
3140 $referer = parse_url( $referer_url );
3141
3142 $source_type = 'unknown';
3143 $source_query = null;
3144
3145 if ( ! is_array( $referer ) ) {
3146 return array( $source_type, $source_query );
3147 }
3148
3149 $plugins_path = parse_url( admin_url( 'plugins.php' ), PHP_URL_PATH );
3150 $plugins_install_path = parse_url( admin_url( 'plugin-install.php' ), PHP_URL_PATH );// /wp-admin/plugin-install.php
3151
3152 if ( isset( $referer['query'] ) ) {
3153 parse_str( $referer['query'], $query_parts );
3154 } else {
3155 $query_parts = array();
3156 }
3157
3158 if ( $plugins_path === $referer['path'] ) {
3159 $source_type = 'list';
3160 } elseif ( $plugins_install_path === $referer['path'] ) {
3161 $tab = isset( $query_parts['tab'] ) ? $query_parts['tab'] : 'featured';
3162 switch( $tab ) {
3163 case 'popular':
3164 $source_type = 'popular';
3165 break;
3166 case 'recommended':
3167 $source_type = 'recommended';
3168 break;
3169 case 'favorites':
3170 $source_type = 'favorites';
3171 break;
3172 case 'search':
3173 $source_type = 'search-' . ( isset( $query_parts['type'] ) ? $query_parts['type'] : 'term' );
3174 $source_query = isset( $query_parts['s'] ) ? $query_parts['s'] : null;
3175 break;
3176 default:
3177 $source_type = 'featured';
3178 }
3179 }
3180
3181 return array( $source_type, $source_query );
3182 }
3183
3184 /**
3185 * Runs before bumping version numbers up to a new version
3186 * @param string $version Version:timestamp
3187 * @param string $old_version Old Version:timestamp or false if not set yet.
3188 * @return null [description]
3189 */
3190 public static function do_version_bump( $version, $old_version ) {
3191 if ( ! $old_version ) { // For new sites
3192 // There used to be stuff here, but this seems like it might be useful to someone in the future...
3193 }
3194 }
3195
3196 /**
3197 * Sets the internal version number and activation state.
3198 * @static
3199 */
3200 public static function plugin_initialize() {
3201 if ( ! Jetpack_Options::get_option( 'activated' ) ) {
3202 Jetpack_Options::update_option( 'activated', 2 );
3203 }
3204
3205 if ( ! Jetpack_Options::get_option( 'version' ) ) {
3206 $version = $old_version = JETPACK__VERSION . ':' . time();
3207 /** This action is documented in class.jetpack.php */
3208 do_action( 'updating_jetpack_version', $version, false );
3209 Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
3210 }
3211
3212 Jetpack::load_modules();
3213
3214 Jetpack_Options::delete_option( 'do_activate' );
3215 Jetpack_Options::delete_option( 'dismissed_connection_banner' );
3216 }
3217
3218 /**
3219 * Removes all connection options
3220 * @static
3221 */
3222 public static function plugin_deactivation( ) {
3223 require_once( ABSPATH . '/wp-admin/includes/plugin.php' );
3224 if( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
3225 Jetpack_Network::init()->deactivate();
3226 } else {
3227 Jetpack::disconnect( false );
3228 //Jetpack_Heartbeat::init()->deactivate();
3229 }
3230 }
3231
3232 /**
3233 * Disconnects from the Jetpack servers.
3234 * Forgets all connection details and tells the Jetpack servers to do the same.
3235 * @static
3236 */
3237 public static function disconnect( $update_activated_state = true ) {
3238 wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
3239 Jetpack::clean_nonces( true );
3240
3241 // If the site is in an IDC because sync is not allowed,
3242 // let's make sure to not disconnect the production site.
3243 if ( ! self::validate_sync_error_idc_option() ) {
3244 $tracking = new Tracking();
3245 $tracking->record_user_event( 'disconnect_site', array() );
3246 Jetpack::load_xml_rpc_client();
3247 $xml = new Jetpack_IXR_Client();
3248 $xml->query( 'jetpack.deregister' );
3249 }
3250
3251 Jetpack_Options::delete_option(
3252 array(
3253 'blog_token',
3254 'user_token',
3255 'user_tokens',
3256 'master_user',
3257 'time_diff',
3258 'fallback_no_verify_ssl_certs',
3259 )
3260 );
3261
3262 Jetpack_IDC::clear_all_idc_options();
3263 Jetpack_Options::delete_raw_option( 'jetpack_secrets' );
3264
3265 if ( $update_activated_state ) {
3266 Jetpack_Options::update_option( 'activated', 4 );
3267 }
3268
3269 if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
3270 // Check then record unique disconnection if site has never been disconnected previously
3271 if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
3272 $jetpack_unique_connection['disconnected'] = 1;
3273 } else {
3274 if ( 0 == $jetpack_unique_connection['disconnected'] ) {
3275 //track unique disconnect
3276 $jetpack = Jetpack::init();
3277
3278 $jetpack->stat( 'connections', 'unique-disconnect' );
3279 $jetpack->do_stats( 'server_side' );
3280 }
3281 // increment number of times disconnected
3282 $jetpack_unique_connection['disconnected'] += 1;
3283 }
3284
3285 Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
3286 }
3287
3288 // Delete cached connected user data
3289 $transient_key = "jetpack_connected_user_data_" . get_current_user_id();
3290 delete_transient( $transient_key );
3291
3292 // Delete all the sync related data. Since it could be taking up space.
3293 Sender::get_instance()->uninstall();
3294
3295 // Disable the Heartbeat cron
3296 Jetpack_Heartbeat::init()->deactivate();
3297 }
3298
3299 /**
3300 * Unlinks the current user from the linked WordPress.com user
3301 */
3302 public static function unlink_user( $user_id = null ) {
3303 if ( ! $tokens = Jetpack_Options::get_option( 'user_tokens' ) )
3304 return false;
3305
3306 $user_id = empty( $user_id ) ? get_current_user_id() : intval( $user_id );
3307
3308 if ( Jetpack_Options::get_option( 'master_user' ) == $user_id )
3309 return false;
3310
3311 if ( ! isset( $tokens[ $user_id ] ) )
3312 return false;
3313
3314 Jetpack::load_xml_rpc_client();
3315 $xml = new Jetpack_IXR_Client( compact( 'user_id' ) );
3316 $xml->query( 'jetpack.unlink_user', $user_id );
3317
3318 unset( $tokens[ $user_id ] );
3319
3320 Jetpack_Options::update_option( 'user_tokens', $tokens );
3321
3322 /**
3323 * Fires after the current user has been unlinked from WordPress.com.
3324 *
3325 * @since 4.1.0
3326 *
3327 * @param int $user_id The current user's ID.
3328 */
3329 do_action( 'jetpack_unlinked_user', $user_id );
3330
3331 return true;
3332 }
3333
3334 /**
3335 * Attempts Jetpack registration. If it fail, a state flag is set: @see ::admin_page_load()
3336 */
3337 public static function try_registration() {
3338 // The user has agreed to the TOS at some point by now.
3339 Jetpack_Options::update_option( 'tos_agreed', true );
3340
3341 // Let's get some testing in beta versions and such.
3342 if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
3343 // Before attempting to connect, let's make sure that the domains are viable.
3344 $domains_to_check = array_unique( array(
3345 'siteurl' => parse_url( get_site_url(), PHP_URL_HOST ),
3346 'homeurl' => parse_url( get_home_url(), PHP_URL_HOST ),
3347 ) );
3348 foreach ( $domains_to_check as $domain ) {
3349 $result = self::connection()->is_usable_domain( $domain );
3350 if ( is_wp_error( $result ) ) {
3351 return $result;
3352 }
3353 }
3354 }
3355
3356 $result = Jetpack::register();
3357
3358 // If there was an error with registration and the site was not registered, record this so we can show a message.
3359 if ( ! $result || is_wp_error( $result ) ) {
3360 return $result;
3361 } else {
3362 return true;
3363 }
3364 }
3365
3366 /**
3367 * Tracking an internal event log. Try not to put too much chaff in here.
3368 *
3369 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3370 */
3371 public static function log( $code, $data = null ) {
3372 // only grab the latest 200 entries
3373 $log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3374
3375 // Append our event to the log
3376 $log_entry = array(
3377 'time' => time(),
3378 'user_id' => get_current_user_id(),
3379 'blog_id' => Jetpack_Options::get_option( 'id' ),
3380 'code' => $code,
3381 );
3382 // Don't bother storing it unless we've got some.
3383 if ( ! is_null( $data ) ) {
3384 $log_entry['data'] = $data;
3385 }
3386 $log[] = $log_entry;
3387
3388 // Try add_option first, to make sure it's not autoloaded.
3389 // @todo: Add an add_option method to Jetpack_Options
3390 if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3391 Jetpack_Options::update_option( 'log', $log );
3392 }
3393
3394 /**
3395 * Fires when Jetpack logs an internal event.
3396 *
3397 * @since 3.0.0
3398 *
3399 * @param array $log_entry {
3400 * Array of details about the log entry.
3401 *
3402 * @param string time Time of the event.
3403 * @param int user_id ID of the user who trigerred the event.
3404 * @param int blog_id Jetpack Blog ID.
3405 * @param string code Unique name for the event.
3406 * @param string data Data about the event.
3407 * }
3408 */
3409 do_action( 'jetpack_log_entry', $log_entry );
3410 }
3411
3412 /**
3413 * Get the internal event log.
3414 *
3415 * @param $event (string) - only return the specific log events
3416 * @param $num (int) - get specific number of latest results, limited to 200
3417 *
3418 * @return array of log events || WP_Error for invalid params
3419 */
3420 public static function get_log( $event = false, $num = false ) {
3421 if ( $event && ! is_string( $event ) ) {
3422 return new WP_Error( __( 'First param must be string or empty', 'jetpack' ) );
3423 }
3424
3425 if ( $num && ! is_numeric( $num ) ) {
3426 return new WP_Error( __( 'Second param must be numeric or empty', 'jetpack' ) );
3427 }
3428
3429 $entire_log = Jetpack_Options::get_option( 'log', array() );
3430
3431 // If nothing set - act as it did before, otherwise let's start customizing the output
3432 if ( ! $num && ! $event ) {
3433 return $entire_log;
3434 } else {
3435 $entire_log = array_reverse( $entire_log );
3436 }
3437
3438 $custom_log_output = array();
3439
3440 if ( $event ) {
3441 foreach ( $entire_log as $log_event ) {
3442 if ( $event == $log_event[ 'code' ] ) {
3443 $custom_log_output[] = $log_event;
3444 }
3445 }
3446 } else {
3447 $custom_log_output = $entire_log;
3448 }
3449
3450 if ( $num ) {
3451 $custom_log_output = array_slice( $custom_log_output, 0, $num );
3452 }
3453
3454 return $custom_log_output;
3455 }
3456
3457 /**
3458 * Log modification of important settings.
3459 */
3460 public static function log_settings_change( $option, $old_value, $value ) {
3461 switch( $option ) {
3462 case 'jetpack_sync_non_public_post_stati':
3463 self::log( $option, $value );
3464 break;
3465 }
3466 }
3467
3468 /**
3469 * Return stat data for WPCOM sync
3470 */
3471 public static function get_stat_data( $encode = true, $extended = true ) {
3472 $data = Jetpack_Heartbeat::generate_stats_array();
3473
3474 if ( $extended ) {
3475 $additional_data = self::get_additional_stat_data();
3476 $data = array_merge( $data, $additional_data );
3477 }
3478
3479 if ( $encode ) {
3480 return json_encode( $data );
3481 }
3482
3483 return $data;
3484 }
3485
3486 /**
3487 * Get additional stat data to sync to WPCOM
3488 */
3489 public static function get_additional_stat_data( $prefix = '' ) {
3490 $return["{$prefix}themes"] = Jetpack::get_parsed_theme_data();
3491 $return["{$prefix}plugins-extra"] = Jetpack::get_parsed_plugin_data();
3492 $return["{$prefix}users"] = (int) Jetpack::get_site_user_count();
3493 $return["{$prefix}site-count"] = 0;
3494
3495 if ( function_exists( 'get_blog_count' ) ) {
3496 $return["{$prefix}site-count"] = get_blog_count();
3497 }
3498 return $return;
3499 }
3500
3501 private static function get_site_user_count() {
3502 global $wpdb;
3503
3504 if ( function_exists( 'wp_is_large_network' ) ) {
3505 if ( wp_is_large_network( 'users' ) ) {
3506 return -1; // Not a real value but should tell us that we are dealing with a large network.
3507 }
3508 }
3509 if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3510 // It wasn't there, so regenerate the data and save the transient
3511 $user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3512 set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3513 }
3514 return $user_count;
3515 }
3516
3517 /* Admin Pages */
3518
3519 function admin_init() {
3520 // If the plugin is not connected, display a connect message.
3521 if (
3522 // the plugin was auto-activated and needs its candy
3523 Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3524 ||
3525 // the plugin is active, but was never activated. Probably came from a site-wide network activation
3526 ! Jetpack_Options::get_option( 'activated' )
3527 ) {
3528 Jetpack::plugin_initialize();
3529 }
3530
3531 if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
3532 Jetpack_Connection_Banner::init();
3533 } elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3534 // Upgrade: 1.1 -> 1.1.1
3535 // Check and see if host can verify the Jetpack servers' SSL certificate
3536 $args = array();
3537 Client::_wp_remote_request(
3538 Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'test' ) ),
3539 $args,
3540 true
3541 );
3542 }
3543
3544 if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3545 add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3546 }
3547
3548 add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3549 add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3550 add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3551
3552 if ( Jetpack::is_active() || Jetpack::is_development_mode() ) {
3553 // Artificially throw errors in certain whitelisted cases during plugin activation
3554 add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3555 }
3556
3557 // Add custom column in wp-admin/users.php to show whether user is linked.
3558 add_filter( 'manage_users_columns', array( $this, 'jetpack_icon_user_connected' ) );
3559 add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3560 add_action( 'admin_print_styles', array( $this, 'jetpack_user_col_style' ) );
3561 }
3562
3563 function admin_body_class( $admin_body_class = '' ) {
3564 $classes = explode( ' ', trim( $admin_body_class ) );
3565
3566 $classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3567
3568 $admin_body_class = implode( ' ', array_unique( $classes ) );
3569 return " $admin_body_class ";
3570 }
3571
3572 static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3573 return $admin_body_class . ' jetpack-pagestyles ';
3574 }
3575
3576 /**
3577 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3578 * This function artificially throws errors for such cases (whitelisted).
3579 *
3580 * @param string $plugin The activated plugin.
3581 */
3582 function throw_error_on_activate_plugin( $plugin ) {
3583 $active_modules = Jetpack::get_active_modules();
3584
3585 // The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3586 if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3587 $throw = false;
3588
3589 // Try and make sure it really was the stats plugin
3590 if ( ! class_exists( 'ReflectionFunction' ) ) {
3591 if ( 'stats.php' == basename( $plugin ) ) {
3592 $throw = true;
3593 }
3594 } else {
3595 $reflection = new ReflectionFunction( 'stats_get_api_key' );
3596 if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3597 $throw = true;
3598 }
3599 }
3600
3601 if ( $throw ) {
3602 trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3603 }
3604 }
3605 }
3606
3607 function intercept_plugin_error_scrape_init() {
3608 add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3609 }
3610
3611 function intercept_plugin_error_scrape( $action, $result ) {
3612 if ( ! $result ) {
3613 return;
3614 }
3615
3616 foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3617 if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3618 Jetpack::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3619 }
3620 }
3621 }
3622
3623 function add_remote_request_handlers() {
3624 add_action( 'wp_ajax_nopriv_jetpack_upload_file', array( $this, 'remote_request_handlers' ) );
3625 add_action( 'wp_ajax_nopriv_jetpack_update_file', array( $this, 'remote_request_handlers' ) );
3626 }
3627
3628 function remote_request_handlers() {
3629 $action = current_filter();
3630
3631 switch ( current_filter() ) {
3632 case 'wp_ajax_nopriv_jetpack_upload_file' :
3633 $response = $this->upload_handler();
3634 break;
3635
3636 case 'wp_ajax_nopriv_jetpack_update_file' :
3637 $response = $this->upload_handler( true );
3638 break;
3639 default :
3640 $response = new Jetpack_Error( 'unknown_handler', 'Unknown Handler', 400 );
3641 break;
3642 }
3643
3644 if ( ! $response ) {
3645 $response = new Jetpack_Error( 'unknown_error', 'Unknown Error', 400 );
3646 }
3647
3648 if ( is_wp_error( $response ) ) {
3649 $status_code = $response->get_error_data();
3650 $error = $response->get_error_code();
3651 $error_description = $response->get_error_message();
3652
3653 if ( ! is_int( $status_code ) ) {
3654 $status_code = 400;
3655 }
3656
3657 status_header( $status_code );
3658 die( json_encode( (object) compact( 'error', 'error_description' ) ) );
3659 }
3660
3661 status_header( 200 );
3662 if ( true === $response ) {
3663 exit;
3664 }
3665
3666 die( json_encode( (object) $response ) );
3667 }
3668
3669 /**
3670 * Uploads a file gotten from the global $_FILES.
3671 * If `$update_media_item` is true and `post_id` is defined
3672 * the attachment file of the media item (gotten through of the post_id)
3673 * will be updated instead of add a new one.
3674 *
3675 * @param boolean $update_media_item - update media attachment
3676 * @return array - An array describing the uploadind files process
3677 */
3678 function upload_handler( $update_media_item = false ) {
3679 if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3680 return new Jetpack_Error( 405, get_status_header_desc( 405 ), 405 );
3681 }
3682
3683 $user = wp_authenticate( '', '' );
3684 if ( ! $user || is_wp_error( $user ) ) {
3685 return new Jetpack_Error( 403, get_status_header_desc( 403 ), 403 );
3686 }
3687
3688 wp_set_current_user( $user->ID );
3689
3690 if ( ! current_user_can( 'upload_files' ) ) {
3691 return new Jetpack_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
3692 }
3693
3694 if ( empty( $_FILES ) ) {
3695 return new Jetpack_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
3696 }
3697
3698 foreach ( array_keys( $_FILES ) as $files_key ) {
3699 if ( ! isset( $_POST["_jetpack_file_hmac_{$files_key}"] ) ) {
3700 return new Jetpack_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
3701 }
3702 }
3703
3704 $media_keys = array_keys( $_FILES['media'] );
3705
3706 $token = Jetpack_Data::get_access_token( get_current_user_id() );
3707 if ( ! $token || is_wp_error( $token ) ) {
3708 return new Jetpack_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
3709 }
3710
3711 $uploaded_files = array();
3712 $global_post = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3713 unset( $GLOBALS['post'] );
3714 foreach ( $_FILES['media']['name'] as $index => $name ) {
3715 $file = array();
3716 foreach ( $media_keys as $media_key ) {
3717 $file[$media_key] = $_FILES['media'][$media_key][$index];
3718 }
3719
3720 list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][$index] );
3721
3722 $hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3723 if ( $hmac_provided !== $hmac_file ) {
3724 $uploaded_files[$index] = (object) array( 'error' => 'invalid_hmac', 'error_description' => 'The corresponding HMAC for this file does not match' );
3725 continue;
3726 }
3727
3728 $_FILES['.jetpack.upload.'] = $file;
3729 $post_id = isset( $_POST['post_id'][$index] ) ? absint( $_POST['post_id'][$index] ) : 0;
3730 if ( ! current_user_can( 'edit_post', $post_id ) ) {
3731 $post_id = 0;
3732 }
3733
3734 if ( $update_media_item ) {
3735 if ( ! isset( $post_id ) || $post_id === 0 ) {
3736 return new Jetpack_Error( 'invalid_input', 'Media ID must be defined.', 400 );
3737 }
3738
3739 $media_array = $_FILES['media'];
3740
3741 $file_array['name'] = $media_array['name'][0];
3742 $file_array['type'] = $media_array['type'][0];
3743 $file_array['tmp_name'] = $media_array['tmp_name'][0];
3744 $file_array['error'] = $media_array['error'][0];
3745 $file_array['size'] = $media_array['size'][0];
3746
3747 $edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3748
3749 if ( is_wp_error( $edited_media_item ) ) {
3750 return $edited_media_item;
3751 }
3752
3753 $response = (object) array(
3754 'id' => (string) $post_id,
3755 'file' => (string) $edited_media_item->post_title,
3756 'url' => (string) wp_get_attachment_url( $post_id ),
3757 'type' => (string) $edited_media_item->post_mime_type,
3758 'meta' => (array) wp_get_attachment_metadata( $post_id ),
3759 );
3760
3761 return (array) array( $response );
3762 }
3763
3764 $attachment_id = media_handle_upload(
3765 '.jetpack.upload.',
3766 $post_id,
3767 array(),
3768 array(
3769 'action' => 'jetpack_upload_file',
3770 )
3771 );
3772
3773 if ( ! $attachment_id ) {
3774 $uploaded_files[$index] = (object) array( 'error' => 'unknown', 'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site' );
3775 } elseif ( is_wp_error( $attachment_id ) ) {
3776 $uploaded_files[$index] = (object) array( 'error' => 'attachment_' . $attachment_id->get_error_code(), 'error_description' => $attachment_id->get_error_message() );
3777 } else {
3778 $attachment = get_post( $attachment_id );
3779 $uploaded_files[$index] = (object) array(
3780 'id' => (string) $attachment_id,
3781 'file' => $attachment->post_title,
3782 'url' => wp_get_attachment_url( $attachment_id ),
3783 'type' => $attachment->post_mime_type,
3784 'meta' => wp_get_attachment_metadata( $attachment_id ),
3785 );
3786 // Zip files uploads are not supported unless they are done for installation purposed
3787 // lets delete them in case something goes wrong in this whole process
3788 if ( 'application/zip' === $attachment->post_mime_type ) {
3789 // Schedule a cleanup for 2 hours from now in case of failed install.
3790 wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3791 }
3792 }
3793 }
3794 if ( ! is_null( $global_post ) ) {
3795 $GLOBALS['post'] = $global_post;
3796 }
3797
3798 return $uploaded_files;
3799 }
3800
3801 /**
3802 * Add help to the Jetpack page
3803 *
3804 * @since Jetpack (1.2.3)
3805 * @return false if not the Jetpack page
3806 */
3807 function admin_help() {
3808 $current_screen = get_current_screen();
3809
3810 // Overview
3811 $current_screen->add_help_tab(
3812 array(
3813 'id' => 'home',
3814 'title' => __( 'Home', 'jetpack' ),
3815 'content' =>
3816 '<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3817 '<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3818 '<p>' . __( 'On this page, you are able to view the modules available within Jetpack, learn more about them, and activate or deactivate them as needed.', 'jetpack' ) . '</p>',
3819 )
3820 );
3821
3822 // Screen Content
3823 if ( current_user_can( 'manage_options' ) ) {
3824 $current_screen->add_help_tab(
3825 array(
3826 'id' => 'settings',
3827 'title' => __( 'Settings', 'jetpack' ),
3828 'content' =>
3829 '<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3830 '<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3831 '<ol>' .
3832 '<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.', 'jetpack' ) . '</li>' .
3833 '<li>' . __( 'Using the checkboxes next to each module, you can select multiple modules to toggle via the Bulk Actions menu at the top of the list.', 'jetpack' ) . '</li>' .
3834 '</ol>' .
3835 '<p>' . __( 'Using the tools on the right, you can search for specific modules, filter by module categories or which are active, or change the sorting order.', 'jetpack' ) . '</p>'
3836 )
3837 );
3838 }
3839
3840 // Help Sidebar
3841 $current_screen->set_help_sidebar(
3842 '<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3843 '<p><a href="https://jetpack.com/faq/" target="_blank">' . __( 'Jetpack FAQ', 'jetpack' ) . '</a></p>' .
3844 '<p><a href="https://jetpack.com/support/" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3845 '<p><a href="' . Jetpack::admin_url( array( 'page' => 'jetpack-debugger' ) ) .'">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3846 );
3847 }
3848
3849 function admin_menu_css() {
3850 wp_enqueue_style( 'jetpack-icons' );
3851 }
3852
3853 function admin_menu_order() {
3854 return true;
3855 }
3856
3857 function jetpack_menu_order( $menu_order ) {
3858 $jp_menu_order = array();
3859
3860 foreach ( $menu_order as $index => $item ) {
3861 if ( $item != 'jetpack' ) {
3862 $jp_menu_order[] = $item;
3863 }
3864
3865 if ( $index == 0 ) {
3866 $jp_menu_order[] = 'jetpack';
3867 }
3868 }
3869
3870 return $jp_menu_order;
3871 }
3872
3873 function admin_banner_styles() {
3874 $min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
3875
3876 if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
3877 wp_register_style(
3878 'jetpack-dops-style',
3879 plugins_url( '_inc/build/admin.css', JETPACK__PLUGIN_FILE ),
3880 array(),
3881 JETPACK__VERSION
3882 );
3883 }
3884
3885 wp_enqueue_style(
3886 'jetpack',
3887 plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
3888 array( 'jetpack-dops-style' ),
3889 JETPACK__VERSION . '-20121016'
3890 );
3891 wp_style_add_data( 'jetpack', 'rtl', 'replace' );
3892 wp_style_add_data( 'jetpack', 'suffix', $min );
3893 }
3894
3895 function plugin_action_links( $actions ) {
3896
3897 $jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack' ), 'Jetpack' ) );
3898
3899 if( current_user_can( 'jetpack_manage_modules' ) && ( Jetpack::is_active() || Jetpack::is_development_mode() ) ) {
3900 return array_merge(
3901 $jetpack_home,
3902 array( 'settings' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
3903 array( 'support' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack-debugger '), __( 'Support', 'jetpack' ) ) ),
3904 $actions
3905 );
3906 }
3907
3908 return array_merge( $jetpack_home, $actions );
3909 }
3910
3911 /*
3912 * Registration flow:
3913 * 1 - ::admin_page_load() action=register
3914 * 2 - ::try_registration()
3915 * 3 - ::register()
3916 * - Creates jetpack_register option containing two secrets and a timestamp
3917 * - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
3918 * siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
3919 * - That request to jetpack.wordpress.com does not immediately respond. It first makes a request BACK to this site's
3920 * xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
3921 * - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
3922 * - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
3923 * jetpack_id, jetpack_secret, jetpack_public
3924 * - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
3925 * 4 - redirect to https://wordpress.com/start/jetpack-connect
3926 * 5 - user logs in with WP.com account
3927 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
3928 * - Jetpack_Client_Server::authorize()
3929 * - Jetpack_Client_Server::get_token()
3930 * - GET https://jetpack.wordpress.com/jetpack.token/1/ with
3931 * client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
3932 * - which responds with access_token, token_type, scope
3933 * - Jetpack_Client_Server::authorize() stores jetpack_options: user_token => access_token.$user_id
3934 * - Jetpack::activate_default_modules()
3935 * - Deactivates deprecated plugins
3936 * - Activates all default modules
3937 * - Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
3938 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
3939 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
3940 * Done!
3941 */
3942
3943 /**
3944 * Handles the page load events for the Jetpack admin page
3945 */
3946 function admin_page_load() {
3947 $error = false;
3948
3949 // Make sure we have the right body class to hook stylings for subpages off of.
3950 add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ) );
3951
3952 if ( ! empty( $_GET['jetpack_restate'] ) ) {
3953 // Should only be used in intermediate redirects to preserve state across redirects
3954 Jetpack::restate();
3955 }
3956
3957 if ( isset( $_GET['connect_url_redirect'] ) ) {
3958 // @todo: Add validation against a known whitelist
3959 $from = ! empty( $_GET['from'] ) ? $_GET['from'] : 'iframe';
3960 // User clicked in the iframe to link their accounts
3961 if ( ! Jetpack::is_user_connected() ) {
3962 $redirect = ! empty( $_GET['redirect_after_auth'] ) ? $_GET['redirect_after_auth'] : false;
3963
3964 add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
3965 $connect_url = $this->build_connect_url( true, $redirect, $from );
3966 remove_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
3967
3968 if ( isset( $_GET['notes_iframe'] ) )
3969 $connect_url .= '&notes_iframe';
3970 wp_redirect( $connect_url );
3971 exit;
3972 } else {
3973 if ( ! isset( $_GET['calypso_env'] ) ) {
3974 Jetpack::state( 'message', 'already_authorized' );
3975 wp_safe_redirect( Jetpack::admin_url() );
3976 exit;
3977 } else {
3978 $connect_url = $this->build_connect_url( true, false, $from );
3979 $connect_url .= '&already_authorized=true';
3980 wp_redirect( $connect_url );
3981 exit;
3982 }
3983 }
3984 }
3985
3986
3987 if ( isset( $_GET['action'] ) ) {
3988 switch ( $_GET['action'] ) {
3989 case 'authorize':
3990 if ( Jetpack::is_active() && Jetpack::is_user_connected() ) {
3991 Jetpack::state( 'message', 'already_authorized' );
3992 wp_safe_redirect( Jetpack::admin_url() );
3993 exit;
3994 }
3995 Jetpack::log( 'authorize' );
3996 $client_server = new Jetpack_Client_Server;
3997 $client_server->client_authorize();
3998 exit;
3999 case 'register' :
4000 if ( ! current_user_can( 'jetpack_connect' ) ) {
4001 $error = 'cheatin';
4002 break;
4003 }
4004 check_admin_referer( 'jetpack-register' );
4005 Jetpack::log( 'register' );
4006 Jetpack::maybe_set_version_option();
4007 $registered = Jetpack::try_registration();
4008 if ( is_wp_error( $registered ) ) {
4009 $error = $registered->get_error_code();
4010 Jetpack::state( 'error', $error );
4011 Jetpack::state( 'error', $registered->get_error_message() );
4012
4013 /**
4014 * Jetpack registration Error.
4015 *
4016 * @since 7.5.0
4017 *
4018 * @param string|int $error The error code.
4019 * @param \WP_Error $registered The error object.
4020 */
4021 do_action( 'jetpack_connection_register_fail', $error, $registered );
4022 break;
4023 }
4024
4025 $from = isset( $_GET['from'] ) ? $_GET['from'] : false;
4026 $redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
4027
4028 /**
4029 * Jetpack registration Success.
4030 *
4031 * @since 7.5.0
4032 *
4033 * @param string $from 'from' GET parameter;
4034 */
4035 do_action( 'jetpack_connection_register_success', $from );
4036
4037 $url = $this->build_connect_url( true, $redirect, $from );
4038
4039 if ( ! empty( $_GET['onboarding'] ) ) {
4040 $url = add_query_arg( 'onboarding', $_GET['onboarding'], $url );
4041 }
4042
4043 if ( ! empty( $_GET['auth_approved'] ) && 'true' === $_GET['auth_approved'] ) {
4044 $url = add_query_arg( 'auth_approved', 'true', $url );
4045 }
4046
4047 wp_redirect( $url );
4048 exit;
4049 case 'activate' :
4050 if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
4051 $error = 'cheatin';
4052 break;
4053 }
4054
4055 $module = stripslashes( $_GET['module'] );
4056 check_admin_referer( "jetpack_activate-$module" );
4057 Jetpack::log( 'activate', $module );
4058 if ( ! Jetpack::activate_module( $module ) ) {
4059 Jetpack::state( 'error', sprintf( __( 'Could not activate %s', 'jetpack' ), $module ) );
4060 }
4061 // The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
4062 wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4063 exit;
4064 case 'activate_default_modules' :
4065 check_admin_referer( 'activate_default_modules' );
4066 Jetpack::log( 'activate_default_modules' );
4067 Jetpack::restate();
4068 $min_version = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
4069 $max_version = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
4070 $other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
4071 Jetpack::activate_default_modules( $min_version, $max_version, $other_modules );
4072 wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4073 exit;
4074 case 'disconnect' :
4075 if ( ! current_user_can( 'jetpack_disconnect' ) ) {
4076 $error = 'cheatin';
4077 break;
4078 }
4079
4080 check_admin_referer( 'jetpack-disconnect' );
4081 Jetpack::log( 'disconnect' );
4082 Jetpack::disconnect();
4083 wp_safe_redirect( Jetpack::admin_url( 'disconnected=true' ) );
4084 exit;
4085 case 'reconnect' :
4086 if ( ! current_user_can( 'jetpack_reconnect' ) ) {
4087 $error = 'cheatin';
4088 break;
4089 }
4090
4091 check_admin_referer( 'jetpack-reconnect' );
4092 Jetpack::log( 'reconnect' );
4093 $this->disconnect();
4094 wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
4095 exit;
4096 case 'deactivate' :
4097 if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
4098 $error = 'cheatin';
4099 break;
4100 }
4101
4102 $modules = stripslashes( $_GET['module'] );
4103 check_admin_referer( "jetpack_deactivate-$modules" );
4104 foreach ( explode( ',', $modules ) as $module ) {
4105 Jetpack::log( 'deactivate', $module );
4106 Jetpack::deactivate_module( $module );
4107 Jetpack::state( 'message', 'module_deactivated' );
4108 }
4109 Jetpack::state( 'module', $modules );
4110 wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4111 exit;
4112 case 'unlink' :
4113 $redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
4114 check_admin_referer( 'jetpack-unlink' );
4115 Jetpack::log( 'unlink' );
4116 $this->unlink_user();
4117 Jetpack::state( 'message', 'unlinked' );
4118 if ( 'sub-unlink' == $redirect ) {
4119 wp_safe_redirect( admin_url() );
4120 } else {
4121 wp_safe_redirect( Jetpack::admin_url( array( 'page' => $redirect ) ) );
4122 }
4123 exit;
4124 case 'onboard' :
4125 if ( ! current_user_can( 'manage_options' ) ) {
4126 wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4127 } else {
4128 Jetpack::create_onboarding_token();
4129 $url = $this->build_connect_url( true );
4130
4131 if ( false !== ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4132 $url = add_query_arg( 'onboarding', $token, $url );
4133 }
4134
4135 $calypso_env = $this->get_calypso_env();
4136 if ( ! empty( $calypso_env ) ) {
4137 $url = add_query_arg( 'calypso_env', $calypso_env, $url );
4138 }
4139
4140 wp_redirect( $url );
4141 exit;
4142 }
4143 exit;
4144 default:
4145 /**
4146 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4147 *
4148 * @since 2.6.0
4149 *
4150 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4151 */
4152 do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4153 }
4154 }
4155
4156 if ( ! $error = $error ? $error : Jetpack::state( 'error' ) ) {
4157 self::activate_new_modules( true );
4158 }
4159
4160 $message_code = Jetpack::state( 'message' );
4161 if ( Jetpack::state( 'optin-manage' ) ) {
4162 $activated_manage = $message_code;
4163 $message_code = 'jetpack-manage';
4164 }
4165
4166 switch ( $message_code ) {
4167 case 'jetpack-manage':
4168 $this->message = '<strong>' . sprintf( __( 'You are all set! Your site can now be managed from <a href="%s" target="_blank">wordpress.com/sites</a>.', 'jetpack' ), 'https://wordpress.com/sites' ) . '</strong>';
4169 if ( $activated_manage ) {
4170 $this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack' ) . '</strong>';
4171 }
4172 break;
4173
4174 }
4175
4176 $deactivated_plugins = Jetpack::state( 'deactivated_plugins' );
4177
4178 if ( ! empty( $deactivated_plugins ) ) {
4179 $deactivated_plugins = explode( ',', $deactivated_plugins );
4180 $deactivated_titles = array();
4181 foreach ( $deactivated_plugins as $deactivated_plugin ) {
4182 if ( ! isset( $this->plugins_to_deactivate[$deactivated_plugin] ) ) {
4183 continue;
4184 }
4185
4186 $deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[$deactivated_plugin][1] ) . '</strong>';
4187 }
4188
4189 if ( $deactivated_titles ) {
4190 if ( $this->message ) {
4191 $this->message .= "<br /><br />\n";
4192 }
4193
4194 $this->message .= wp_sprintf(
4195 _n(
4196 'Jetpack contains the most recent version of the old %l plugin.',
4197 'Jetpack contains the most recent versions of the old %l plugins.',
4198 count( $deactivated_titles ),
4199 'jetpack'
4200 ),
4201 $deactivated_titles
4202 );
4203
4204 $this->message .= "<br />\n";
4205
4206 $this->message .= _n(
4207 'The old version has been deactivated and can be removed from your site.',
4208 'The old versions have been deactivated and can be removed from your site.',
4209 count( $deactivated_titles ),
4210 'jetpack'
4211 );
4212 }
4213 }
4214
4215 $this->privacy_checks = Jetpack::state( 'privacy_checks' );
4216
4217 if ( $this->message || $this->error || $this->privacy_checks ) {
4218 add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
4219 }
4220
4221 add_filter( 'jetpack_short_module_description', 'wptexturize' );
4222 }
4223
4224 function admin_notices() {
4225
4226 if ( $this->error ) {
4227 ?>
4228 <div id="message" class="jetpack-message jetpack-err">
4229 <div class="squeezer">
4230 <h2><?php echo wp_kses( $this->error, array( 'a' => array( 'href' => array() ), 'small' => true, 'code' => true, 'strong' => true, 'br' => true, 'b' => true ) ); ?></h2>
4231 <?php if ( $desc = Jetpack::state( 'error_description' ) ) : ?>
4232 <p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
4233 <?php endif; ?>
4234 </div>
4235 </div>
4236 <?php
4237 }
4238
4239 if ( $this->message ) {
4240 ?>
4241 <div id="message" class="jetpack-message">
4242 <div class="squeezer">
4243 <h2><?php echo wp_kses( $this->message, array( 'strong' => array(), 'a' => array( 'href' => true ), 'br' => true ) ); ?></h2>
4244 </div>
4245 </div>
4246 <?php
4247 }
4248
4249 if ( $this->privacy_checks ) :
4250 $module_names = $module_slugs = array();
4251
4252 $privacy_checks = explode( ',', $this->privacy_checks );
4253 $privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
4254 foreach ( $privacy_checks as $module_slug ) {
4255 $module = Jetpack::get_module( $module_slug );
4256 if ( ! $module ) {
4257 continue;
4258 }
4259
4260 $module_slugs[] = $module_slug;
4261 $module_names[] = "<strong>{$module['name']}</strong>";
4262 }
4263
4264 $module_slugs = join( ',', $module_slugs );
4265 ?>
4266 <div id="message" class="jetpack-message jetpack-err">
4267 <div class="squeezer">
4268 <h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
4269 <p><?php
4270 echo wp_kses(
4271 wptexturize(
4272 wp_sprintf(
4273 _nx(
4274 "Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
4275 "Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
4276 count( $privacy_checks ),
4277 '%l = list of Jetpack module/feature names',
4278 'jetpack'
4279 ),
4280 $module_names
4281 )
4282 ),
4283 array( 'strong' => true )
4284 );
4285
4286 echo "\n<br />\n";
4287
4288 echo wp_kses(
4289 sprintf(
4290 _nx(
4291 'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
4292 'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
4293 count( $privacy_checks ),
4294 '%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
4295 'jetpack'
4296 ),
4297 wp_nonce_url(
4298 Jetpack::admin_url(
4299 array(
4300 'page' => 'jetpack',
4301 'action' => 'deactivate',
4302 'module' => urlencode( $module_slugs ),
4303 )
4304 ),
4305 "jetpack_deactivate-$module_slugs"
4306 ),
4307 esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4308 ),
4309 array( 'a' => array( 'href' => true, 'title' => true ) )
4310 );
4311 ?></p>
4312 </div>
4313 </div>
4314 <?php endif;
4315 }
4316
4317 /**
4318 * Record a stat for later output. This will only currently output in the admin_footer.
4319 */
4320 function stat( $group, $detail ) {
4321 if ( ! isset( $this->stats[ $group ] ) )
4322 $this->stats[ $group ] = array();
4323 $this->stats[ $group ][] = $detail;
4324 }
4325
4326 /**
4327 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4328 */
4329 function do_stats( $method = '' ) {
4330 if ( is_array( $this->stats ) && count( $this->stats ) ) {
4331 foreach ( $this->stats as $group => $stats ) {
4332 if ( is_array( $stats ) && count( $stats ) ) {
4333 $args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
4334 if ( 'server_side' === $method ) {
4335 self::do_server_side_stat( $args );
4336 } else {
4337 echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
4338 }
4339 }
4340 unset( $this->stats[ $group ] );
4341 }
4342 }
4343 }
4344
4345 /**
4346 * Runs stats code for a one-off, server-side.
4347 *
4348 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4349 *
4350 * @return bool If it worked.
4351 */
4352 static function do_server_side_stat( $args ) {
4353 $response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4354 if ( is_wp_error( $response ) )
4355 return false;
4356
4357 if ( 200 !== wp_remote_retrieve_response_code( $response ) )
4358 return false;
4359
4360 return true;
4361 }
4362
4363 /**
4364 * Builds the stats url.
4365 *
4366 * @param $args array|string The arguments to append to the URL.
4367 *
4368 * @return string The URL to be pinged.
4369 */
4370 static function build_stats_url( $args ) {
4371 $defaults = array(
4372 'v' => 'wpcom2',
4373 'rand' => md5( mt_rand( 0, 999 ) . time() ),
4374 );
4375 $args = wp_parse_args( $args, $defaults );
4376 /**
4377 * Filter the URL used as the Stats tracking pixel.
4378 *
4379 * @since 2.3.2
4380 *
4381 * @param string $url Base URL used as the Stats tracking pixel.
4382 */
4383 $base_url = apply_filters(
4384 'jetpack_stats_base_url',
4385 'https://pixel.wp.com/g.gif'
4386 );
4387 $url = add_query_arg( $args, $base_url );
4388 return $url;
4389 }
4390
4391 static function translate_current_user_to_role() {
4392 foreach ( self::$capability_translations as $role => $cap ) {
4393 if ( current_user_can( $role ) || current_user_can( $cap ) ) {
4394 return $role;
4395 }
4396 }
4397
4398 return false;
4399 }
4400
4401 static function translate_user_to_role( $user ) {
4402 foreach ( self::$capability_translations as $role => $cap ) {
4403 if ( user_can( $user, $role ) || user_can( $user, $cap ) ) {
4404 return $role;
4405 }
4406 }
4407
4408 return false;
4409 }
4410
4411 static function translate_role_to_cap( $role ) {
4412 if ( ! isset( self::$capability_translations[$role] ) ) {
4413 return false;
4414 }
4415
4416 return self::$capability_translations[$role];
4417 }
4418
4419 static function sign_role( $role, $user_id = null ) {
4420 if ( empty( $user_id ) ) {
4421 $user_id = (int) get_current_user_id();
4422 }
4423
4424 if ( ! $user_id ) {
4425 return false;
4426 }
4427
4428 $token = Jetpack_Data::get_access_token();
4429 if ( ! $token || is_wp_error( $token ) ) {
4430 return false;
4431 }
4432
4433 return $role . ':' . hash_hmac( 'md5', "{$role}|{$user_id}", $token->secret );
4434 }
4435
4436
4437 /**
4438 * Builds a URL to the Jetpack connection auth page
4439 *
4440 * @since 3.9.5
4441 *
4442 * @param bool $raw If true, URL will not be escaped.
4443 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4444 * If string, will be a custom redirect.
4445 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4446 * @param bool $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4447 *
4448 * @return string Connect URL
4449 */
4450 function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4451 $site_id = Jetpack_Options::get_option( 'id' );
4452 $blog_token = Jetpack_Data::get_access_token();
4453
4454 if ( $register || ! $blog_token || ! $site_id ) {
4455 $url = Jetpack::nonce_url_no_esc( Jetpack::admin_url( 'action=register' ), 'jetpack-register' );
4456
4457 if ( ! empty( $redirect ) ) {
4458 $url = add_query_arg(
4459 'redirect',
4460 urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4461 $url
4462 );
4463 }
4464
4465 if( is_network_admin() ) {
4466 $url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4467 }
4468 } else {
4469
4470 // Let's check the existing blog token to see if we need to re-register. We only check once per minute
4471 // because otherwise this logic can get us in to a loop.
4472 $last_connect_url_check = intval( Jetpack_Options::get_raw_option( 'jetpack_last_connect_url_check' ) );
4473 if ( ! $last_connect_url_check || ( time() - $last_connect_url_check ) > MINUTE_IN_SECONDS ) {
4474 Jetpack_Options::update_raw_option( 'jetpack_last_connect_url_check', time() );
4475
4476 $response = Client::wpcom_json_api_request_as_blog(
4477 sprintf( '/sites/%d', $site_id ) .'?force=wpcom',
4478 '1.1'
4479 );
4480
4481 if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4482
4483 // Generating a register URL instead to refresh the existing token
4484 return $this->build_connect_url( $raw, $redirect, $from, true );
4485 }
4486 }
4487
4488 if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && include_once JETPACK__GLOTPRESS_LOCALES_PATH ) {
4489 $gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() );
4490 }
4491
4492 $role = self::translate_current_user_to_role();
4493 $signed_role = self::sign_role( $role );
4494
4495 $user = wp_get_current_user();
4496
4497 $jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4498 $redirect = $redirect
4499 ? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4500 : $jetpack_admin_page;
4501
4502 if( isset( $_REQUEST['is_multisite'] ) ) {
4503 $redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4504 }
4505
4506 $secrets = Jetpack::generate_secrets( 'authorize', false, 2 * HOUR_IN_SECONDS );
4507
4508 /**
4509 * Filter the type of authorization.
4510 * 'calypso' completes authorization on wordpress.com/jetpack/connect
4511 * while 'jetpack' ( or any other value ) completes the authorization at jetpack.wordpress.com.
4512 *
4513 * @since 4.3.3
4514 *
4515 * @param string $auth_type Defaults to 'calypso', can also be 'jetpack'.
4516 */
4517 $auth_type = apply_filters( 'jetpack_auth_type', 'calypso' );
4518
4519
4520 $tracks = new Tracking();
4521 $tracks_identity = $tracks->tracks_get_identity( get_current_user_id() );
4522
4523 $args = urlencode_deep(
4524 array(
4525 'response_type' => 'code',
4526 'client_id' => Jetpack_Options::get_option( 'id' ),
4527 'redirect_uri' => add_query_arg(
4528 array(
4529 'action' => 'authorize',
4530 '_wpnonce' => wp_create_nonce( "jetpack-authorize_{$role}_{$redirect}" ),
4531 'redirect' => urlencode( $redirect ),
4532 ),
4533 esc_url( admin_url( 'admin.php?page=jetpack' ) )
4534 ),
4535 'state' => $user->ID,
4536 'scope' => $signed_role,
4537 'user_email' => $user->user_email,
4538 'user_login' => $user->user_login,
4539 'is_active' => Jetpack::is_active(),
4540 'jp_version' => JETPACK__VERSION,
4541 'auth_type' => $auth_type,
4542 'secret' => $secrets['secret_1'],
4543 'locale' => ( isset( $gp_locale ) && isset( $gp_locale->slug ) ) ? $gp_locale->slug : '',
4544 'blogname' => get_option( 'blogname' ),
4545 'site_url' => site_url(),
4546 'home_url' => home_url(),
4547 'site_icon' => get_site_icon_url(),
4548 'site_lang' => get_locale(),
4549 '_ui' => $tracks_identity['_ui'],
4550 '_ut' => $tracks_identity['_ut'],
4551 'site_created' => Jetpack::get_assumed_site_creation_date(),
4552 )
4553 );
4554
4555 self::apply_activation_source_to_args( $args );
4556
4557 $url = add_query_arg( $args, Jetpack::api_url( 'authorize' ) );
4558 }
4559
4560 if ( $from ) {
4561 $url = add_query_arg( 'from', $from, $url );
4562 }
4563
4564 // Ensure that class to get the affiliate code is loaded
4565 if ( ! class_exists( 'Jetpack_Affiliate' ) ) {
4566 require_once JETPACK__PLUGIN_DIR . 'class.jetpack-affiliate.php';
4567 }
4568 // Get affiliate code and add it to the URL
4569 $url = Jetpack_Affiliate::init()->add_code_as_query_arg( $url );
4570
4571 $calypso_env = $this->get_calypso_env();
4572
4573 if ( ! empty( $calypso_env ) ) {
4574 $url = add_query_arg( 'calypso_env', $calypso_env, $url );
4575 }
4576
4577 return $raw ? esc_url_raw( $url ) : esc_url( $url );
4578 }
4579
4580 /**
4581 * Get our assumed site creation date.
4582 * Calculated based on the earlier date of either:
4583 * - Earliest admin user registration date.
4584 * - Earliest date of post of any post type.
4585 *
4586 * @since 7.2.0
4587 *
4588 * @return string Assumed site creation date and time.
4589 */
4590 public static function get_assumed_site_creation_date() {
4591 $earliest_registered_users = get_users( array(
4592 'role' => 'administrator',
4593 'orderby' => 'user_registered',
4594 'order' => 'ASC',
4595 'fields' => array( 'user_registered' ),
4596 'number' => 1,
4597 ) );
4598 $earliest_registration_date = $earliest_registered_users[0]->user_registered;
4599
4600 $earliest_posts = get_posts( array(
4601 'posts_per_page' => 1,
4602 'post_type' => 'any',
4603 'post_status' => 'any',
4604 'orderby' => 'date',
4605 'order' => 'ASC',
4606 ) );
4607
4608 // If there are no posts at all, we'll count only on user registration date.
4609 if ( $earliest_posts ) {
4610 $earliest_post_date = $earliest_posts[0]->post_date;
4611 } else {
4612 $earliest_post_date = PHP_INT_MAX;
4613 }
4614
4615 return min( $earliest_registration_date, $earliest_post_date );
4616 }
4617
4618 public static function apply_activation_source_to_args( &$args ) {
4619 list( $activation_source_name, $activation_source_keyword ) = get_option( 'jetpack_activation_source' );
4620
4621 if ( $activation_source_name ) {
4622 $args['_as'] = urlencode( $activation_source_name );
4623 }
4624
4625 if ( $activation_source_keyword ) {
4626 $args['_ak'] = urlencode( $activation_source_keyword );
4627 }
4628 }
4629
4630 function build_reconnect_url( $raw = false ) {
4631 $url = wp_nonce_url( Jetpack::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4632 return $raw ? $url : esc_url( $url );
4633 }
4634
4635 public static function admin_url( $args = null ) {
4636 $args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
4637 $url = add_query_arg( $args, admin_url( 'admin.php' ) );
4638 return $url;
4639 }
4640
4641 public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4642 $actionurl = str_replace( '&amp;', '&', $actionurl );
4643 return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
4644 }
4645
4646 function dismiss_jetpack_notice() {
4647
4648 if ( ! isset( $_GET['jetpack-notice'] ) ) {
4649 return;
4650 }
4651
4652 switch( $_GET['jetpack-notice'] ) {
4653 case 'dismiss':
4654 if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
4655
4656 require_once ABSPATH . 'wp-admin/includes/plugin.php';
4657 deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
4658 wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
4659 }
4660 break;
4661 case 'jetpack-protect-multisite-opt-out':
4662
4663 if ( check_admin_referer( 'jetpack_protect_multisite_banner_opt_out' ) ) {
4664 // Don't show the banner again
4665
4666 update_site_option( 'jetpack_dismissed_protect_multisite_banner', true );
4667 // redirect back to the page that had the notice
4668 if ( wp_get_referer() ) {
4669 wp_safe_redirect( wp_get_referer() );
4670 } else {
4671 // Take me to Jetpack
4672 wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4673 }
4674 }
4675 break;
4676 }
4677 }
4678
4679 public static function sort_modules( $a, $b ) {
4680 if ( $a['sort'] == $b['sort'] )
4681 return 0;
4682
4683 return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
4684 }
4685
4686 function ajax_recheck_ssl() {
4687 check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
4688 $result = Jetpack::permit_ssl( true );
4689 wp_send_json( array(
4690 'enabled' => $result,
4691 'message' => get_transient( 'jetpack_https_test_message' )
4692 ) );
4693 }
4694
4695 /* Client API */
4696
4697 /**
4698 * Returns the requested Jetpack API URL
4699 *
4700 * @return string
4701 */
4702 public static function api_url( $relative_url ) {
4703 return trailingslashit( JETPACK__API_BASE . $relative_url ) . JETPACK__API_VERSION . '/';
4704 }
4705
4706 /**
4707 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
4708 */
4709 public static function fix_url_for_bad_hosts( $url ) {
4710 if ( 0 !== strpos( $url, 'https://' ) ) {
4711 return $url;
4712 }
4713
4714 switch ( JETPACK_CLIENT__HTTPS ) {
4715 case 'ALWAYS' :
4716 return $url;
4717 case 'NEVER' :
4718 return set_url_scheme( $url, 'http' );
4719 // default : case 'AUTO' :
4720 }
4721
4722 // we now return the unmodified SSL URL by default, as a security precaution
4723 return $url;
4724 }
4725
4726 /**
4727 * Create a random secret for validating onboarding payload
4728 *
4729 * @return string Secret token
4730 */
4731 public static function create_onboarding_token() {
4732 if ( false === ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4733 $token = wp_generate_password( 32, false );
4734 Jetpack_Options::update_option( 'onboarding', $token );
4735 }
4736
4737 return $token;
4738 }
4739
4740 /**
4741 * Remove the onboarding token
4742 *
4743 * @return bool True on success, false on failure
4744 */
4745 public static function invalidate_onboarding_token() {
4746 return Jetpack_Options::delete_option( 'onboarding' );
4747 }
4748
4749 /**
4750 * Validate an onboarding token for a specific action
4751 *
4752 * @return boolean True if token/action pair is accepted, false if not
4753 */
4754 public static function validate_onboarding_token_action( $token, $action ) {
4755 // Compare tokens, bail if tokens do not match
4756 if ( ! hash_equals( $token, Jetpack_Options::get_option( 'onboarding' ) ) ) {
4757 return false;
4758 }
4759
4760 // List of valid actions we can take
4761 $valid_actions = array(
4762 '/jetpack/v4/settings',
4763 );
4764
4765 // Whitelist the action
4766 if ( ! in_array( $action, $valid_actions ) ) {
4767 return false;
4768 }
4769
4770 return true;
4771 }
4772
4773 /**
4774 * Checks to see if the URL is using SSL to connect with Jetpack
4775 *
4776 * @since 2.3.3
4777 * @return boolean
4778 */
4779 public static function permit_ssl( $force_recheck = false ) {
4780 // Do some fancy tests to see if ssl is being supported
4781 if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
4782 $message = '';
4783 if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
4784 $ssl = 0;
4785 } else {
4786 switch ( JETPACK_CLIENT__HTTPS ) {
4787 case 'NEVER':
4788 $ssl = 0;
4789 $message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
4790 break;
4791 case 'ALWAYS':
4792 case 'AUTO':
4793 default:
4794 $ssl = 1;
4795 break;
4796 }
4797
4798 // If it's not 'NEVER', test to see
4799 if ( $ssl ) {
4800 if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
4801 $ssl = 0;
4802 $message = __( 'WordPress reports no SSL support', 'jetpack' );
4803 } else {
4804 $response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
4805 if ( is_wp_error( $response ) ) {
4806 $ssl = 0;
4807 $message = __( 'WordPress reports no SSL support', 'jetpack' );
4808 } elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
4809 $ssl = 0;
4810 $message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
4811 }
4812 }
4813 }
4814 }
4815 set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
4816 set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
4817 }
4818
4819 return (bool) $ssl;
4820 }
4821
4822 /*
4823 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
4824 */
4825 public function alert_auto_ssl_fail() {
4826 if ( ! current_user_can( 'manage_options' ) )
4827 return;
4828
4829 $ajax_nonce = wp_create_nonce( 'recheck-ssl' );
4830 ?>
4831
4832 <div id="jetpack-ssl-warning" class="error jp-identity-crisis">
4833 <div class="jp-banner__content">
4834 <h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
4835 <p><?php _e( 'Your site could not connect to WordPress.com via HTTPS. This could be due to any number of reasons, including faulty SSL certificates, misconfigured or missing SSL libraries, or network issues.', 'jetpack' ); ?></p>
4836 <p>
4837 <?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
4838 <a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
4839 <span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
4840 </p>
4841 <p>
4842 <?php printf( __( 'For more help, try our <a href="%1$s">connection debugger</a> or <a href="%2$s" target="_blank">troubleshooting tips</a>.', 'jetpack' ),
4843 esc_url( Jetpack::admin_url( array( 'page' => 'jetpack-debugger' ) ) ),
4844 esc_url( 'https://jetpack.com/support/getting-started-with-jetpack/troubleshooting-tips/' ) ); ?>
4845 </p>
4846 </div>
4847 </div>
4848 <style>
4849 #jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
4850 </style>
4851 <script type="text/javascript">
4852 jQuery( document ).ready( function( $ ) {
4853 $( '#jetpack-recheck-ssl-button' ).click( function( e ) {
4854 var $this = $( this );
4855 $this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
4856 $( '#jetpack-recheck-ssl-output' ).html( '' );
4857 e.preventDefault();
4858 var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
4859 $.post( ajaxurl, data )
4860 .done( function( response ) {
4861 if ( response.enabled ) {
4862 $( '#jetpack-ssl-warning' ).hide();
4863 } else {
4864 this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
4865 $( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
4866 }
4867 }.bind( $this ) );
4868 } );
4869 } );
4870 </script>
4871
4872 <?php
4873 }
4874
4875 /**
4876 * Returns the Jetpack XML-RPC API
4877 *
4878 * @return string
4879 */
4880 public static function xmlrpc_api_url() {
4881 $base = preg_replace( '#(https?://[^?/]+)(/?.*)?$#', '\\1', JETPACK__API_BASE );
4882 return untrailingslashit( $base ) . '/xmlrpc.php';
4883 }
4884
4885 public static function connection() {
4886 return self::init()->connection_manager;
4887 }
4888
4889 /**
4890 * Creates two secret tokens and the end of life timestamp for them.
4891 *
4892 * Note these tokens are unique per call, NOT static per site for connecting.
4893 *
4894 * @since 2.6
4895 * @return array
4896 */
4897 public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
4898 if ( false === $user_id ) {
4899 $user_id = get_current_user_id();
4900 }
4901
4902 return self::connection()->generate_secrets( $action, $user_id, $exp );
4903 }
4904
4905 public static function get_secrets( $action, $user_id ) {
4906 $secrets = self::connection()->get_secrets( $action, $user_id );
4907
4908 if ( Connection_Manager::SECRETS_MISSING === $secrets ) {
4909 return new WP_Error( 'verify_secrets_missing', 'Verification secrets not found' );
4910 }
4911
4912 if ( Connection_Manager::SECRETS_EXPIRED === $secrets ) {
4913 return new WP_Error( 'verify_secrets_expired', 'Verification took too long' );
4914 }
4915
4916 return $secrets;
4917 }
4918
4919 /**
4920 * @deprecated 7.5 Use Connection_Manager instead.
4921 *
4922 * @param $action
4923 * @param $user_id
4924 */
4925 public static function delete_secrets( $action, $user_id ) {
4926 return self::connection()->delete_secrets( $action, $user_id );
4927 }
4928
4929 /**
4930 * Builds the timeout limit for queries talking with the wpcom servers.
4931 *
4932 * Based on local php max_execution_time in php.ini
4933 *
4934 * @since 2.6
4935 * @return int
4936 * @deprecated
4937 **/
4938 public function get_remote_query_timeout_limit() {
4939 _deprecated_function( __METHOD__, 'jetpack-5.4' );
4940 return Jetpack::get_max_execution_time();
4941 }
4942
4943 /**
4944 * Builds the timeout limit for queries talking with the wpcom servers.
4945 *
4946 * Based on local php max_execution_time in php.ini
4947 *
4948 * @since 5.4
4949 * @return int
4950 **/
4951 public static function get_max_execution_time() {
4952 $timeout = (int) ini_get( 'max_execution_time' );
4953
4954 // Ensure exec time set in php.ini
4955 if ( ! $timeout ) {
4956 $timeout = 30;
4957 }
4958 return $timeout;
4959 }
4960
4961 /**
4962 * Sets a minimum request timeout, and returns the current timeout
4963 *
4964 * @since 5.4
4965 **/
4966 public static function set_min_time_limit( $min_timeout ) {
4967 $timeout = self::get_max_execution_time();
4968 if ( $timeout < $min_timeout ) {
4969 $timeout = $min_timeout;
4970 set_time_limit( $timeout );
4971 }
4972 return $timeout;
4973 }
4974
4975
4976 /**
4977 * Takes the response from the Jetpack register new site endpoint and
4978 * verifies it worked properly.
4979 *
4980 * @since 2.6
4981 * @return string|Jetpack_Error A JSON object on success or Jetpack_Error on failures
4982 **/
4983 public function validate_remote_register_response( $response ) {
4984 if ( is_wp_error( $response ) ) {
4985 return new Jetpack_Error( 'register_http_request_failed', $response->get_error_message() );
4986 }
4987
4988 $code = wp_remote_retrieve_response_code( $response );
4989 $entity = wp_remote_retrieve_body( $response );
4990 if ( $entity )
4991 $registration_response = json_decode( $entity );
4992 else
4993 $registration_response = false;
4994
4995 $code_type = intval( $code / 100 );
4996 if ( 5 == $code_type ) {
4997 return new Jetpack_Error( 'wpcom_5??', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
4998 } elseif ( 408 == $code ) {
4999 return new Jetpack_Error( 'wpcom_408', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5000 } elseif ( ! empty( $registration_response->error ) ) {
5001 if ( 'xml_rpc-32700' == $registration_response->error && ! function_exists( 'xml_parser_create' ) ) {
5002 $error_description = __( "PHP's XML extension is not available. Jetpack requires the XML extension to communicate with WordPress.com. Please contact your hosting provider to enable PHP's XML extension.", 'jetpack' );
5003 } else {
5004 $error_description = isset( $registration_response->error_description ) ? sprintf( __( 'Error Details: %s', 'jetpack' ), (string) $registration_response->error_description ) : '';
5005 }
5006
5007 return new Jetpack_Error( (string) $registration_response->error, $error_description, $code );
5008 } elseif ( 200 != $code ) {
5009 return new Jetpack_Error( 'wpcom_bad_response', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5010 }
5011
5012 // Jetpack ID error block
5013 if ( empty( $registration_response->jetpack_id ) ) {
5014 return new Jetpack_Error( 'jetpack_id', sprintf( __( 'Error Details: Jetpack ID is empty. Do not publicly post this error message! %s', 'jetpack' ), $entity ), $entity );
5015 } elseif ( ! is_scalar( $registration_response->jetpack_id ) ) {
5016 return new Jetpack_Error( 'jetpack_id', sprintf( __( 'Error Details: Jetpack ID is not a scalar. Do not publicly post this error message! %s', 'jetpack' ) , $entity ), $entity );
5017 } elseif ( preg_match( '/[^0-9]/', $registration_response->jetpack_id ) ) {
5018 return new Jetpack_Error( 'jetpack_id', sprintf( __( 'Error Details: Jetpack ID begins with a numeral. Do not publicly post this error message! %s', 'jetpack' ) , $entity ), $entity );
5019 }
5020
5021 return $registration_response;
5022 }
5023 /**
5024 * @return bool|WP_Error
5025 */
5026 public static function register() {
5027 $tracking = new Tracking();
5028 $tracking->record_user_event( 'jpc_register_begin' );
5029 add_action( 'pre_update_jetpack_option_register', array( 'Jetpack_Options', 'delete_option' ) );
5030 $secrets = Jetpack::generate_secrets( 'register' );
5031
5032 if (
5033 empty( $secrets['secret_1'] ) ||
5034 empty( $secrets['secret_2'] ) ||
5035 empty( $secrets['exp'] )
5036 ) {
5037 return new Jetpack_Error( 'missing_secrets' );
5038 }
5039
5040 // better to try (and fail) to set a higher timeout than this system
5041 // supports than to have register fail for more users than it should
5042 $timeout = Jetpack::set_min_time_limit( 60 ) / 2;
5043
5044 $gmt_offset = get_option( 'gmt_offset' );
5045 if ( ! $gmt_offset ) {
5046 $gmt_offset = 0;
5047 }
5048
5049 $stats_options = get_option( 'stats_options' );
5050 $stats_id = isset($stats_options['blog_id']) ? $stats_options['blog_id'] : null;
5051
5052 $tracks = new Tracking();
5053 $tracks_identity = $tracks->tracks_get_identity( get_current_user_id() );
5054
5055 $args = array(
5056 'method' => 'POST',
5057 'body' => array(
5058 'siteurl' => site_url(),
5059 'home' => home_url(),
5060 'gmt_offset' => $gmt_offset,
5061 'timezone_string' => (string) get_option( 'timezone_string' ),
5062 'site_name' => (string) get_option( 'blogname' ),
5063 'secret_1' => $secrets['secret_1'],
5064 'secret_2' => $secrets['secret_2'],
5065 'site_lang' => get_locale(),
5066 'timeout' => $timeout,
5067 'stats_id' => $stats_id,
5068 'state' => get_current_user_id(),
5069 '_ui' => $tracks_identity['_ui'],
5070 '_ut' => $tracks_identity['_ut'],
5071 'site_created' => Jetpack::get_assumed_site_creation_date(),
5072 'jetpack_version' => JETPACK__VERSION,
5073 'ABSPATH' => defined( 'ABSPATH' ) ? ABSPATH : '',
5074 ),
5075 'headers' => array(
5076 'Accept' => 'application/json',
5077 ),
5078 'timeout' => $timeout,
5079 );
5080
5081 self::apply_activation_source_to_args( $args['body'] );
5082
5083 $response = Client::_wp_remote_request( Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'register' ) ), $args, true );
5084
5085 // Make sure the response is valid and does not contain any Jetpack errors
5086 $registration_details = Jetpack::init()->validate_remote_register_response( $response );
5087 if ( is_wp_error( $registration_details ) ) {
5088 return $registration_details;
5089 } elseif ( ! $registration_details ) {
5090 return new Jetpack_Error( 'unknown_error', __( 'Unknown error registering your Jetpack site', 'jetpack' ), wp_remote_retrieve_response_code( $response ) );
5091 }
5092
5093 if ( empty( $registration_details->jetpack_secret ) || ! is_string( $registration_details->jetpack_secret ) ) {
5094 return new Jetpack_Error( 'jetpack_secret', '', wp_remote_retrieve_response_code( $response ) );
5095 }
5096
5097 if ( isset( $registration_details->jetpack_public ) ) {
5098 $jetpack_public = (int) $registration_details->jetpack_public;
5099 } else {
5100 $jetpack_public = false;
5101 }
5102
5103 Jetpack_Options::update_options(
5104 array(
5105 'id' => (int) $registration_details->jetpack_id,
5106 'blog_token' => (string) $registration_details->jetpack_secret,
5107 'public' => $jetpack_public,
5108 )
5109 );
5110
5111 /**
5112 * Fires when a site is registered on WordPress.com.
5113 *
5114 * @since 3.7.0
5115 *
5116 * @param int $json->jetpack_id Jetpack Blog ID.
5117 * @param string $json->jetpack_secret Jetpack Blog Token.
5118 * @param int|bool $jetpack_public Is the site public.
5119 */
5120 do_action( 'jetpack_site_registered', $registration_details->jetpack_id, $registration_details->jetpack_secret, $jetpack_public );
5121
5122 $jetpack = Jetpack::init();
5123
5124 return true;
5125 }
5126
5127 /**
5128 * If the db version is showing something other that what we've got now, bump it to current.
5129 *
5130 * @return bool: True if the option was incorrect and updated, false if nothing happened.
5131 */
5132 public static function maybe_set_version_option() {
5133 list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
5134 if ( JETPACK__VERSION != $version ) {
5135 Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
5136
5137 if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
5138 /** This action is documented in class.jetpack.php */
5139 do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
5140 }
5141
5142 return true;
5143 }
5144 return false;
5145 }
5146
5147 /* Client Server API */
5148
5149 /**
5150 * Loads the Jetpack XML-RPC client
5151 */
5152 public static function load_xml_rpc_client() {
5153 require_once ABSPATH . WPINC . '/class-IXR.php';
5154 require_once JETPACK__PLUGIN_DIR . 'class.jetpack-ixr-client.php';
5155 }
5156
5157 /**
5158 * Resets the saved authentication state in between testing requests.
5159 */
5160 public function reset_saved_auth_state() {
5161 $this->xmlrpc_verification = null;
5162 $this->rest_authentication_status = null;
5163 }
5164
5165 /**
5166 * Verifies the signature of the current request.
5167 *
5168 * @return false|array
5169 */
5170 function verify_xml_rpc_signature() {
5171 if ( is_null( $this->xmlrpc_verification ) ) {
5172 $this->xmlrpc_verification = $this->internal_verify_xml_rpc_signature();
5173
5174 if ( is_wp_error( $this->xmlrpc_verification ) ) {
5175 /**
5176 * Action for logging XMLRPC signature verification errors. This data is sensitive.
5177 *
5178 * Error codes:
5179 * - malformed_token
5180 * - malformed_user_id
5181 * - unknown_token
5182 * - could_not_sign
5183 * - invalid_nonce
5184 * - signature_mismatch
5185 *
5186 * @since 7.5.0
5187 *
5188 * @param WP_Error $signature_verification_error The verification error
5189 */
5190 do_action( 'jetpack_verify_signature_error', $this->xmlrpc_verification );
5191 }
5192 }
5193
5194 return is_wp_error( $this->xmlrpc_verification ) ? false : $this->xmlrpc_verification;
5195 }
5196
5197 /**
5198 * Verifies the signature of the current request.
5199 *
5200 * This function has side effects and should not be used. Instead,
5201 * use the memoized version `->verify_xml_rpc_signature()`.
5202 *
5203 * @internal
5204 */
5205 private function internal_verify_xml_rpc_signature() {
5206 // It's not for us
5207 if ( ! isset( $_GET['token'] ) || empty( $_GET['signature'] ) ) {
5208 return false;
5209 }
5210
5211 $signature_details = array(
5212 'token' => isset( $_GET['token'] ) ? wp_unslash( $_GET['token'] ) : '',
5213 'timestamp' => isset( $_GET['timestamp'] ) ? wp_unslash( $_GET['timestamp'] ) : '',
5214 'nonce' => isset( $_GET['nonce'] ) ? wp_unslash( $_GET['nonce'] ) : '',
5215 'body_hash' => isset( $_GET['body-hash'] ) ? wp_unslash( $_GET['body-hash'] ) : '',
5216 'method' => wp_unslash( $_SERVER['REQUEST_METHOD'] ),
5217 'url' => wp_unslash( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ), // Temp - will get real signature URL later.
5218 'signature' => isset( $_GET['signature'] ) ? wp_unslash( $_GET['signature'] ) : '',
5219 );
5220
5221 @list( $token_key, $version, $user_id ) = explode( ':', wp_unslash( $_GET['token'] ) );
5222 if (
5223 empty( $token_key )
5224 ||
5225 empty( $version ) || strval( JETPACK__API_VERSION ) !== $version
5226 ) {
5227 return new WP_Error( 'malformed_token', 'Malformed token in request', compact( 'signature_details' ) );
5228 }
5229
5230 if ( '0' === $user_id ) {
5231 $token_type = 'blog';
5232 $user_id = 0;
5233 } else {
5234 $token_type = 'user';
5235 if ( empty( $user_id ) || ! ctype_digit( $user_id ) ) {
5236 return new WP_Error( 'malformed_user_id', 'Malformed user_id in request', compact( 'signature_details' ) );
5237 }
5238 $user_id = (int) $user_id;
5239
5240 $user = new WP_User( $user_id );
5241 if ( ! $user || ! $user->exists() ) {
5242 return new WP_Error( 'unknown_user', sprintf( 'User %d does not exist', $user_id ), compact( 'signature_details' ) );
5243 }
5244 }
5245
5246 $token = Jetpack_Data::get_access_token( $user_id, $token_key, false );
5247 if ( is_wp_error( $token ) ) {
5248 $token->add_data( compact( 'signature_details' ) );
5249 return $token;
5250 } elseif ( ! $token ) {
5251 return new WP_Error( 'unknown_token', sprintf( 'Token %s:%s:%d does not exist', $token_key, $version, $user_id ), compact( 'signature_details' ) );
5252 }
5253
5254 $jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5255 if ( isset( $_POST['_jetpack_is_multipart'] ) ) {
5256 $post_data = $_POST;
5257 $file_hashes = array();
5258 foreach ( $post_data as $post_data_key => $post_data_value ) {
5259 if ( 0 !== strpos( $post_data_key, '_jetpack_file_hmac_' ) ) {
5260 continue;
5261 }
5262 $post_data_key = substr( $post_data_key, strlen( '_jetpack_file_hmac_' ) );
5263 $file_hashes[$post_data_key] = $post_data_value;
5264 }
5265
5266 foreach ( $file_hashes as $post_data_key => $post_data_value ) {
5267 unset( $post_data["_jetpack_file_hmac_{$post_data_key}"] );
5268 $post_data[$post_data_key] = $post_data_value;
5269 }
5270
5271 ksort( $post_data );
5272
5273 $body = http_build_query( stripslashes_deep( $post_data ) );
5274 } elseif ( is_null( $this->HTTP_RAW_POST_DATA ) ) {
5275 $body = file_get_contents( 'php://input' );
5276 } else {
5277 $body = null;
5278 }
5279
5280 $signature = $jetpack_signature->sign_current_request(
5281 array( 'body' => is_null( $body ) ? $this->HTTP_RAW_POST_DATA : $body, )
5282 );
5283
5284 $signature_details['url'] = $jetpack_signature->current_request_url;
5285
5286 if ( ! $signature ) {
5287 return new WP_Error( 'could_not_sign', 'Unknown signature error', compact( 'signature_details' ) );
5288 } else if ( is_wp_error( $signature ) ) {
5289 return $signature;
5290 }
5291
5292 $timestamp = (int) $_GET['timestamp'];
5293 $nonce = stripslashes( (string) $_GET['nonce'] );
5294
5295 // Use up the nonce regardless of whether the signature matches.
5296 if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
5297 return new WP_Error( 'invalid_nonce', 'Could not add nonce', compact( 'signature_details' ) );
5298 }
5299
5300 // Be careful about what you do with this debugging data.
5301 // If a malicious requester has access to the expected signature,
5302 // bad things might be possible.
5303 $signature_details['expected'] = $signature;
5304
5305 if ( ! hash_equals( $signature, $_GET['signature'] ) ) {
5306 return new WP_Error( 'signature_mismatch', 'Signature mismatch', compact( 'signature_details' ) );
5307 }
5308
5309 // Let's see if this is onboarding. In such case, use user token type and the provided user id.
5310 if ( isset( $this->HTTP_RAW_POST_DATA ) || ! empty( $_GET['onboarding'] ) ) {
5311 if ( ! empty( $_GET['onboarding'] ) ) {
5312 $jpo = $_GET;
5313 } else {
5314 $jpo = json_decode( $this->HTTP_RAW_POST_DATA, true );
5315 }
5316
5317 $jpo_token = ! empty( $jpo['onboarding']['token'] ) ? $jpo['onboarding']['token'] : null;
5318 $jpo_user = ! empty( $jpo['onboarding']['jpUser'] ) ? $jpo['onboarding']['jpUser'] : null;
5319
5320 if (
5321 isset( $jpo_user ) && isset( $jpo_token ) &&
5322 is_email( $jpo_user ) && ctype_alnum( $jpo_token ) &&
5323 isset( $_GET['rest_route'] ) &&
5324 self::validate_onboarding_token_action( $jpo_token, $_GET['rest_route'] )
5325 ) {
5326 $jpUser = get_user_by( 'email', $jpo_user );
5327 if ( is_a( $jpUser, 'WP_User' ) ) {
5328 wp_set_current_user( $jpUser->ID );
5329 $user_can = is_multisite()
5330 ? current_user_can_for_blog( get_current_blog_id(), 'manage_options' )
5331 : current_user_can( 'manage_options' );
5332 if ( $user_can ) {
5333 $token_type = 'user';
5334 $token->external_user_id = $jpUser->ID;
5335 }
5336 }
5337 }
5338 }
5339
5340 return array(
5341 'type' => $token_type,
5342 'token_key' => $token_key,
5343 'user_id' => $token->external_user_id,
5344 );
5345 }
5346
5347 /**
5348 * Authenticates XML-RPC and other requests from the Jetpack Server
5349 */
5350 function authenticate_jetpack( $user, $username, $password ) {
5351 if ( is_a( $user, 'WP_User' ) ) {
5352 return $user;
5353 }
5354
5355 $token_details = $this->verify_xml_rpc_signature();
5356
5357 if ( ! $token_details ) {
5358 return $user;
5359 }
5360
5361 if ( 'user' !== $token_details['type'] ) {
5362 return $user;
5363 }
5364
5365 if ( ! $token_details['user_id'] ) {
5366 return $user;
5367 }
5368
5369 nocache_headers();
5370
5371 return new WP_User( $token_details['user_id'] );
5372 }
5373
5374 // Authenticates requests from Jetpack server to WP REST API endpoints.
5375 // Uses the existing XMLRPC request signing implementation.
5376 function wp_rest_authenticate( $user ) {
5377 if ( ! empty( $user ) ) {
5378 // Another authentication method is in effect.
5379 return $user;
5380 }
5381
5382 if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
5383 // Nothing to do for this authentication method.
5384 return null;
5385 }
5386
5387 if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
5388 // Nothing to do for this authentication method.
5389 return null;
5390 }
5391
5392 // Ensure that we always have the request body available. At this
5393 // point, the WP REST API code to determine the request body has not
5394 // run yet. That code may try to read from 'php://input' later, but
5395 // this can only be done once per request in PHP versions prior to 5.6.
5396 // So we will go ahead and perform this read now if needed, and save
5397 // the request body where both the Jetpack signature verification code
5398 // and the WP REST API code can see it.
5399 if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
5400 $GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
5401 }
5402 $this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5403
5404 // Only support specific request parameters that have been tested and
5405 // are known to work with signature verification. A different method
5406 // can be passed to the WP REST API via the '?_method=' parameter if
5407 // needed.
5408 if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
5409 $this->rest_authentication_status = new WP_Error(
5410 'rest_invalid_request',
5411 __( 'This request method is not supported.', 'jetpack' ),
5412 array( 'status' => 400 )
5413 );
5414 return null;
5415 }
5416 if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
5417 $this->rest_authentication_status = new WP_Error(
5418 'rest_invalid_request',
5419 __( 'This request method does not support body parameters.', 'jetpack' ),
5420 array( 'status' => 400 )
5421 );
5422 return null;
5423 }
5424
5425 $verified = $this->verify_xml_rpc_signature();
5426
5427 if (
5428 $verified &&
5429 isset( $verified['type'] ) &&
5430 'user' === $verified['type'] &&
5431 ! empty( $verified['user_id'] )
5432 ) {
5433 // Authentication successful.
5434 $this->rest_authentication_status = true;
5435 return $verified['user_id'];
5436 }
5437
5438 // Something else went wrong. Probably a signature error.
5439 $this->rest_authentication_status = new WP_Error(
5440 'rest_invalid_signature',
5441 __( 'The request is not signed correctly.', 'jetpack' ),
5442 array( 'status' => 400 )
5443 );
5444 return null;
5445 }
5446
5447 /**
5448 * Report authentication status to the WP REST API.
5449 *
5450 * @param WP_Error|mixed $result Error from another authentication handler, null if we should handle it, or another value if not
5451 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5452 */
5453 public function wp_rest_authentication_errors( $value ) {
5454 if ( $value !== null ) {
5455 return $value;
5456 }
5457 return $this->rest_authentication_status;
5458 }
5459
5460 function add_nonce( $timestamp, $nonce ) {
5461 global $wpdb;
5462 static $nonces_used_this_request = array();
5463
5464 if ( isset( $nonces_used_this_request["$timestamp:$nonce"] ) ) {
5465 return $nonces_used_this_request["$timestamp:$nonce"];
5466 }
5467
5468 // This should always have gone through Jetpack_Signature::sign_request() first to check $timestamp an $nonce
5469 $timestamp = (int) $timestamp;
5470 $nonce = esc_sql( $nonce );
5471
5472 // Raw query so we can avoid races: add_option will also update
5473 $show_errors = $wpdb->show_errors( false );
5474
5475 $old_nonce = $wpdb->get_row(
5476 $wpdb->prepare( "SELECT * FROM `$wpdb->options` WHERE option_name = %s", "jetpack_nonce_{$timestamp}_{$nonce}" )
5477 );
5478
5479 if ( is_null( $old_nonce ) ) {
5480 $return = $wpdb->query(
5481 $wpdb->prepare(
5482 "INSERT INTO `$wpdb->options` (`option_name`, `option_value`, `autoload`) VALUES (%s, %s, %s)",
5483 "jetpack_nonce_{$timestamp}_{$nonce}",
5484 time(),
5485 'no'
5486 )
5487 );
5488 } else {
5489 $return = false;
5490 }
5491
5492 $wpdb->show_errors( $show_errors );
5493
5494 $nonces_used_this_request["$timestamp:$nonce"] = $return;
5495
5496 return $return;
5497 }
5498
5499 /**
5500 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5501 * Capture it here so we can verify the signature later.
5502 */
5503 function xmlrpc_methods( $methods ) {
5504 $this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5505 return $methods;
5506 }
5507
5508 function public_xmlrpc_methods( $methods ) {
5509 if ( array_key_exists( 'wp.getOptions', $methods ) ) {
5510 $methods['wp.getOptions'] = array( $this, 'jetpack_getOptions' );
5511 }
5512 return $methods;
5513 }
5514
5515 function jetpack_getOptions( $args ) {
5516 global $wp_xmlrpc_server;
5517
5518 $wp_xmlrpc_server->escape( $args );
5519
5520 $username = $args[1];
5521 $password = $args[2];
5522
5523 if ( !$user = $wp_xmlrpc_server->login($username, $password) ) {
5524 return $wp_xmlrpc_server->error;
5525 }
5526
5527 $options = array();
5528 $user_data = $this->get_connected_user_data();
5529 if ( is_array( $user_data ) ) {
5530 $options['jetpack_user_id'] = array(
5531 'desc' => __( 'The WP.com user ID of the connected user', 'jetpack' ),
5532 'readonly' => true,
5533 'value' => $user_data['ID'],
5534 );
5535 $options['jetpack_user_login'] = array(
5536 'desc' => __( 'The WP.com username of the connected user', 'jetpack' ),
5537 'readonly' => true,
5538 'value' => $user_data['login'],
5539 );
5540 $options['jetpack_user_email'] = array(
5541 'desc' => __( 'The WP.com user email of the connected user', 'jetpack' ),
5542 'readonly' => true,
5543 'value' => $user_data['email'],
5544 );
5545 $options['jetpack_user_site_count'] = array(
5546 'desc' => __( 'The number of sites of the connected WP.com user', 'jetpack' ),
5547 'readonly' => true,
5548 'value' => $user_data['site_count'],
5549 );
5550 }
5551 $wp_xmlrpc_server->blog_options = array_merge( $wp_xmlrpc_server->blog_options, $options );
5552 $args = stripslashes_deep( $args );
5553 return $wp_xmlrpc_server->wp_getOptions( $args );
5554 }
5555
5556 function xmlrpc_options( $options ) {
5557 $jetpack_client_id = false;
5558 if ( self::is_active() ) {
5559 $jetpack_client_id = Jetpack_Options::get_option( 'id' );
5560 }
5561 $options['jetpack_version'] = array(
5562 'desc' => __( 'Jetpack Plugin Version', 'jetpack' ),
5563 'readonly' => true,
5564 'value' => JETPACK__VERSION,
5565 );
5566
5567 $options['jetpack_client_id'] = array(
5568 'desc' => __( 'The Client ID/WP.com Blog ID of this site', 'jetpack' ),
5569 'readonly' => true,
5570 'value' => $jetpack_client_id,
5571 );
5572 return $options;
5573 }
5574
5575 public static function clean_nonces( $all = false ) {
5576 global $wpdb;
5577
5578 $sql = "DELETE FROM `$wpdb->options` WHERE `option_name` LIKE %s";
5579 $sql_args = array( $wpdb->esc_like( 'jetpack_nonce_' ) . '%' );
5580
5581 if ( true !== $all ) {
5582 $sql .= ' AND CAST( `option_value` AS UNSIGNED ) < %d';
5583 $sql_args[] = time() - 3600;
5584 }
5585
5586 $sql .= ' ORDER BY `option_id` LIMIT 100';
5587
5588 $sql = $wpdb->prepare( $sql, $sql_args );
5589
5590 for ( $i = 0; $i < 1000; $i++ ) {
5591 if ( ! $wpdb->query( $sql ) ) {
5592 break;
5593 }
5594 }
5595 }
5596
5597 /**
5598 * State is passed via cookies from one request to the next, but never to subsequent requests.
5599 * SET: state( $key, $value );
5600 * GET: $value = state( $key );
5601 *
5602 * @param string $key
5603 * @param string $value
5604 * @param bool $restate private
5605 */
5606 public static function state( $key = null, $value = null, $restate = false ) {
5607 static $state = array();
5608 static $path, $domain;
5609 if ( ! isset( $path ) ) {
5610 require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
5611 $admin_url = Jetpack::admin_url();
5612 $bits = wp_parse_url( $admin_url );
5613
5614 if ( is_array( $bits ) ) {
5615 $path = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5616 $domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5617 } else {
5618 $path = $domain = null;
5619 }
5620 }
5621
5622 // Extract state from cookies and delete cookies
5623 if ( isset( $_COOKIE[ 'jetpackState' ] ) && is_array( $_COOKIE[ 'jetpackState' ] ) ) {
5624 $yum = $_COOKIE[ 'jetpackState' ];
5625 unset( $_COOKIE[ 'jetpackState' ] );
5626 foreach ( $yum as $k => $v ) {
5627 if ( strlen( $v ) )
5628 $state[ $k ] = $v;
5629 setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5630 }
5631 }
5632
5633 if ( $restate ) {
5634 foreach ( $state as $k => $v ) {
5635 setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5636 }
5637 return;
5638 }
5639
5640 // Get a state variable
5641 if ( isset( $key ) && ! isset( $value ) ) {
5642 if ( array_key_exists( $key, $state ) )
5643 return $state[ $key ];
5644 return null;
5645 }
5646
5647 // Set a state variable
5648 if ( isset ( $key ) && isset( $value ) ) {
5649 if( is_array( $value ) && isset( $value[0] ) ) {
5650 $value = $value[0];
5651 }
5652 $state[ $key ] = $value;
5653 setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5654 }
5655 }
5656
5657 public static function restate() {
5658 Jetpack::state( null, null, true );
5659 }
5660
5661 public static function check_privacy( $file ) {
5662 static $is_site_publicly_accessible = null;
5663
5664 if ( is_null( $is_site_publicly_accessible ) ) {
5665 $is_site_publicly_accessible = false;
5666
5667 Jetpack::load_xml_rpc_client();
5668 $rpc = new Jetpack_IXR_Client();
5669
5670 $success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5671 if ( $success ) {
5672 $response = $rpc->getResponse();
5673 if ( $response ) {
5674 $is_site_publicly_accessible = true;
5675 }
5676 }
5677
5678 Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5679 }
5680
5681 if ( $is_site_publicly_accessible ) {
5682 return;
5683 }
5684
5685 $module_slug = self::get_module_slug( $file );
5686
5687 $privacy_checks = Jetpack::state( 'privacy_checks' );
5688 if ( ! $privacy_checks ) {
5689 $privacy_checks = $module_slug;
5690 } else {
5691 $privacy_checks .= ",$module_slug";
5692 }
5693
5694 Jetpack::state( 'privacy_checks', $privacy_checks );
5695 }
5696
5697 /**
5698 * Helper method for multicall XMLRPC.
5699 */
5700 public static function xmlrpc_async_call() {
5701 global $blog_id;
5702 static $clients = array();
5703
5704 $client_blog_id = is_multisite() ? $blog_id : 0;
5705
5706 if ( ! isset( $clients[$client_blog_id] ) ) {
5707 Jetpack::load_xml_rpc_client();
5708 $clients[$client_blog_id] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => JETPACK_MASTER_USER, ) );
5709 if ( function_exists( 'ignore_user_abort' ) ) {
5710 ignore_user_abort( true );
5711 }
5712 add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5713 }
5714
5715 $args = func_get_args();
5716
5717 if ( ! empty( $args[0] ) ) {
5718 call_user_func_array( array( $clients[$client_blog_id], 'addCall' ), $args );
5719 } elseif ( is_multisite() ) {
5720 foreach ( $clients as $client_blog_id => $client ) {
5721 if ( ! $client_blog_id || empty( $client->calls ) ) {
5722 continue;
5723 }
5724
5725 $switch_success = switch_to_blog( $client_blog_id, true );
5726 if ( ! $switch_success ) {
5727 continue;
5728 }
5729
5730 flush();
5731 $client->query();
5732
5733 restore_current_blog();
5734 }
5735 } else {
5736 if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5737 flush();
5738 $clients[0]->query();
5739 }
5740 }
5741 }
5742
5743 public static function staticize_subdomain( $url ) {
5744
5745 // Extract hostname from URL
5746 $host = parse_url( $url, PHP_URL_HOST );
5747
5748 // Explode hostname on '.'
5749 $exploded_host = explode( '.', $host );
5750
5751 // Retrieve the name and TLD
5752 if ( count( $exploded_host ) > 1 ) {
5753 $name = $exploded_host[ count( $exploded_host ) - 2 ];
5754 $tld = $exploded_host[ count( $exploded_host ) - 1 ];
5755 // Rebuild domain excluding subdomains
5756 $domain = $name . '.' . $tld;
5757 } else {
5758 $domain = $host;
5759 }
5760 // Array of Automattic domains
5761 $domain_whitelist = array( 'wordpress.com', 'wp.com' );
5762
5763 // Return $url if not an Automattic domain
5764 if ( ! in_array( $domain, $domain_whitelist ) ) {
5765 return $url;
5766 }
5767
5768 if ( is_ssl() ) {
5769 return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
5770 }
5771
5772 srand( crc32( basename( $url ) ) );
5773 $static_counter = rand( 0, 2 );
5774 srand(); // this resets everything that relies on this, like array_rand() and shuffle()
5775
5776 return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
5777 }
5778
5779 /* JSON API Authorization */
5780
5781 /**
5782 * Handles the login action for Authorizing the JSON API
5783 */
5784 function login_form_json_api_authorization() {
5785 $this->verify_json_api_authorization_request();
5786
5787 add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
5788
5789 add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
5790 add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
5791 add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
5792 }
5793
5794 // Make sure the login form is POSTed to the signed URL so we can reverify the request
5795 function post_login_form_to_signed_url( $url, $path, $scheme ) {
5796 if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
5797 return $url;
5798 }
5799
5800 $parsed_url = parse_url( $url );
5801 $url = strtok( $url, '?' );
5802 $url = "$url?{$_SERVER['QUERY_STRING']}";
5803 if ( ! empty( $parsed_url['query'] ) )
5804 $url .= "&{$parsed_url['query']}";
5805
5806 return $url;
5807 }
5808
5809 // Make sure the POSTed request is handled by the same action
5810 function preserve_action_in_login_form_for_json_api_authorization() {
5811 echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
5812 echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
5813 }
5814
5815 // If someone logs in to approve API access, store the Access Code in usermeta
5816 function store_json_api_authorization_token( $user_login, $user ) {
5817 add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
5818 add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
5819 $token = wp_generate_password( 32, false );
5820 update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
5821 }
5822
5823 // Add public-api.wordpress.com to the safe redirect whitelist - only added when someone allows API access
5824 function allow_wpcom_public_api_domain( $domains ) {
5825 $domains[] = 'public-api.wordpress.com';
5826 return $domains;
5827 }
5828
5829 static function is_redirect_encoded( $redirect_url ) {
5830 return preg_match( '/https?%3A%2F%2F/i', $redirect_url ) > 0;
5831 }
5832
5833 // Add all wordpress.com environments to the safe redirect whitelist
5834 function allow_wpcom_environments( $domains ) {
5835 $domains[] = 'wordpress.com';
5836 $domains[] = 'wpcalypso.wordpress.com';
5837 $domains[] = 'horizon.wordpress.com';
5838 $domains[] = 'calypso.localhost';
5839 return $domains;
5840 }
5841
5842 // Add the Access Code details to the public-api.wordpress.com redirect
5843 function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
5844 return add_query_arg(
5845 urlencode_deep(
5846 array(
5847 'jetpack-code' => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
5848 'jetpack-user-id' => (int) $user->ID,
5849 'jetpack-state' => $this->json_api_authorization_request['state'],
5850 )
5851 ),
5852 $redirect_to
5853 );
5854 }
5855
5856
5857 /**
5858 * Verifies the request by checking the signature
5859 *
5860 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
5861 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
5862 *
5863 * @param null|array $environment
5864 */
5865 function verify_json_api_authorization_request( $environment = null ) {
5866 $environment = is_null( $environment )
5867 ? $_REQUEST
5868 : $environment;
5869
5870 list( $envToken, $envVersion, $envUserId ) = explode( ':', $environment['token'] );
5871 $token = Jetpack_Data::get_access_token( $envUserId, $envToken );
5872 if ( ! $token || empty( $token->secret ) ) {
5873 wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.' , 'jetpack' ) );
5874 }
5875
5876 $die_error = __( 'Someone may be trying to trick you into giving them access to your site. Or it could be you just encountered a bug :). Either way, please close this window.', 'jetpack' );
5877
5878 // Host has encoded the request URL, probably as a result of a bad http => https redirect
5879 if ( Jetpack::is_redirect_encoded( $_GET['redirect_to'] ) ) {
5880 /**
5881 * Jetpack authorisation request Error.
5882 *
5883 * @since 7.5.0
5884 *
5885 */
5886 do_action( 'jetpack_verify_api_authorization_request_error_double_encode' );
5887 $die_error = sprintf(
5888 /* translators: %s is a URL */
5889 __( 'Your site is incorrectly double-encoding redirects from http to https. This is preventing Jetpack from authenticating your connection. Please visit our <a href="%s">support page</a> for details about how to resolve this.', 'jetpack' ),
5890 'https://jetpack.com/support/double-encoding/'
5891 );
5892 }
5893
5894 $jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5895
5896 if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
5897 $signature = $jetpack_signature->sign_request(
5898 $environment['token'],
5899 $environment['timestamp'],
5900 $environment['nonce'],
5901 '',
5902 'GET',
5903 $environment['jetpack_json_api_original_query'],
5904 null,
5905 true
5906 );
5907 } else {
5908 $signature = $jetpack_signature->sign_current_request( array( 'body' => null, 'method' => 'GET' ) );
5909 }
5910
5911 if ( ! $signature ) {
5912 wp_die( $die_error );
5913 } else if ( is_wp_error( $signature ) ) {
5914 wp_die( $die_error );
5915 } else if ( ! hash_equals( $signature, $environment['signature'] ) ) {
5916 if ( is_ssl() ) {
5917 // If we signed an HTTP request on the Jetpack Servers, but got redirected to HTTPS by the local blog, check the HTTP signature as well
5918 $signature = $jetpack_signature->sign_current_request( array( 'scheme' => 'http', 'body' => null, 'method' => 'GET' ) );
5919 if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) {
5920 wp_die( $die_error );
5921 }
5922 } else {
5923 wp_die( $die_error );
5924 }
5925 }
5926
5927 $timestamp = (int) $environment['timestamp'];
5928 $nonce = stripslashes( (string) $environment['nonce'] );
5929
5930 if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
5931 // De-nonce the nonce, at least for 5 minutes.
5932 // We have to reuse this nonce at least once (used the first time when the initial request is made, used a second time when the login form is POSTed)
5933 $old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
5934 if ( $old_nonce_time < time() - 300 ) {
5935 wp_die( __( 'The authorization process expired. Please go back and try again.' , 'jetpack' ) );
5936 }
5937 }
5938
5939 $data = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
5940 $data_filters = array(
5941 'state' => 'opaque',
5942 'client_id' => 'int',
5943 'client_title' => 'string',
5944 'client_image' => 'url',
5945 );
5946
5947 foreach ( $data_filters as $key => $sanitation ) {
5948 if ( ! isset( $data->$key ) ) {
5949 wp_die( $die_error );
5950 }
5951
5952 switch ( $sanitation ) {
5953 case 'int' :
5954 $this->json_api_authorization_request[$key] = (int) $data->$key;
5955 break;
5956 case 'opaque' :
5957 $this->json_api_authorization_request[$key] = (string) $data->$key;
5958 break;
5959 case 'string' :
5960 $this->json_api_authorization_request[$key] = wp_kses( (string) $data->$key, array() );
5961 break;
5962 case 'url' :
5963 $this->json_api_authorization_request[$key] = esc_url_raw( (string) $data->$key );
5964 break;
5965 }
5966 }
5967
5968 if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
5969 wp_die( $die_error );
5970 }
5971 }
5972
5973 function login_message_json_api_authorization( $message ) {
5974 return '<p class="message">' . sprintf(
5975 esc_html__( '%s wants to access your site&#8217;s data. Log in to authorize that access.' , 'jetpack' ),
5976 '<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
5977 ) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
5978 }
5979
5980 /**
5981 * Get $content_width, but with a <s>twist</s> filter.
5982 */
5983 public static function get_content_width() {
5984 $content_width = ( isset( $GLOBALS['content_width'] ) && is_numeric( $GLOBALS['content_width'] ) )
5985 ? $GLOBALS['content_width']
5986 : false;
5987 /**
5988 * Filter the Content Width value.
5989 *
5990 * @since 2.2.3
5991 *
5992 * @param string $content_width Content Width value.
5993 */
5994 return apply_filters( 'jetpack_content_width', $content_width );
5995 }
5996
5997 /**
5998 * Pings the WordPress.com Mirror Site for the specified options.
5999 *
6000 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
6001 *
6002 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
6003 */
6004 public function get_cloud_site_options( $option_names ) {
6005 $option_names = array_filter( (array) $option_names, 'is_string' );
6006
6007 Jetpack::load_xml_rpc_client();
6008 $xml = new Jetpack_IXR_Client( array( 'user_id' => JETPACK_MASTER_USER, ) );
6009 $xml->query( 'jetpack.fetchSiteOptions', $option_names );
6010 if ( $xml->isError() ) {
6011 return array(
6012 'error_code' => $xml->getErrorCode(),
6013 'error_msg' => $xml->getErrorMessage(),
6014 );
6015 }
6016 $cloud_site_options = $xml->getResponse();
6017
6018 return $cloud_site_options;
6019 }
6020
6021 /**
6022 * Checks if the site is currently in an identity crisis.
6023 *
6024 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
6025 */
6026 public static function check_identity_crisis() {
6027 if ( ! Jetpack::is_active() || Jetpack::is_development_mode() || ! self::validate_sync_error_idc_option() ) {
6028 return false;
6029 }
6030
6031 return Jetpack_Options::get_option( 'sync_error_idc' );
6032 }
6033
6034 /**
6035 * Checks whether the home and siteurl specifically are whitelisted
6036 * Written so that we don't have re-check $key and $value params every time
6037 * we want to check if this site is whitelisted, for example in footer.php
6038 *
6039 * @since 3.8.0
6040 * @return bool True = already whitelisted False = not whitelisted
6041 */
6042 public static function is_staging_site() {
6043 $is_staging = false;
6044
6045 $known_staging = array(
6046 'urls' => array(
6047 '#\.staging\.wpengine\.com$#i', // WP Engine
6048 '#\.staging\.kinsta\.com$#i', // Kinsta.com
6049 '#\.stage\.site$#i' // DreamPress
6050 ),
6051 'constants' => array(
6052 'IS_WPE_SNAPSHOT', // WP Engine
6053 'KINSTA_DEV_ENV', // Kinsta.com
6054 'WPSTAGECOACH_STAGING', // WP Stagecoach
6055 'JETPACK_STAGING_MODE', // Generic
6056 )
6057 );
6058 /**
6059 * Filters the flags of known staging sites.
6060 *
6061 * @since 3.9.0
6062 *
6063 * @param array $known_staging {
6064 * An array of arrays that each are used to check if the current site is staging.
6065 * @type array $urls URLs of staging sites in regex to check against site_url.
6066 * @type array $constants PHP constants of known staging/developement environments.
6067 * }
6068 */
6069 $known_staging = apply_filters( 'jetpack_known_staging', $known_staging );
6070
6071 if ( isset( $known_staging['urls'] ) ) {
6072 foreach ( $known_staging['urls'] as $url ){
6073 if ( preg_match( $url, site_url() ) ) {
6074 $is_staging = true;
6075 break;
6076 }
6077 }
6078 }
6079
6080 if ( isset( $known_staging['constants'] ) ) {
6081 foreach ( $known_staging['constants'] as $constant ) {
6082 if ( defined( $constant ) && constant( $constant ) ) {
6083 $is_staging = true;
6084 }
6085 }
6086 }
6087
6088 // Last, let's check if sync is erroring due to an IDC. If so, set the site to staging mode.
6089 if ( ! $is_staging && self::validate_sync_error_idc_option() ) {
6090 $is_staging = true;
6091 }
6092
6093 /**
6094 * Filters is_staging_site check.
6095 *
6096 * @since 3.9.0
6097 *
6098 * @param bool $is_staging If the current site is a staging site.
6099 */
6100 return apply_filters( 'jetpack_is_staging_site', $is_staging );
6101 }
6102
6103 /**
6104 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
6105 *
6106 * @since 4.4.0
6107 * @since 5.4.0 Do not call get_sync_error_idc_option() unless site is in IDC
6108 *
6109 * @return bool
6110 */
6111 public static function validate_sync_error_idc_option() {
6112 $is_valid = false;
6113
6114 $idc_allowed = get_transient( 'jetpack_idc_allowed' );
6115 if ( false === $idc_allowed ) {
6116 $response = wp_remote_get( 'https://jetpack.com/is-idc-allowed/' );
6117 if ( 200 === (int) wp_remote_retrieve_response_code( $response ) ) {
6118 $json = json_decode( wp_remote_retrieve_body( $response ) );
6119 $idc_allowed = isset( $json, $json->result ) && $json->result ? '1' : '0';
6120 $transient_duration = HOUR_IN_SECONDS;
6121 } else {
6122 // If the request failed for some reason, then assume IDC is allowed and set shorter transient.
6123 $idc_allowed = '1';
6124 $transient_duration = 5 * MINUTE_IN_SECONDS;
6125 }
6126
6127 set_transient( 'jetpack_idc_allowed', $idc_allowed, $transient_duration );
6128 }
6129
6130 // Is the site opted in and does the stored sync_error_idc option match what we now generate?
6131 $sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
6132 if ( $idc_allowed && $sync_error && self::sync_idc_optin() ) {
6133 $local_options = self::get_sync_error_idc_option();
6134 if ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
6135 $is_valid = true;
6136 }
6137 }
6138
6139 /**
6140 * Filters whether the sync_error_idc option is valid.
6141 *
6142 * @since 4.4.0
6143 *
6144 * @param bool $is_valid If the sync_error_idc is valid or not.
6145 */
6146 $is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
6147
6148 if ( ! $idc_allowed || ( ! $is_valid && $sync_error ) ) {
6149 // Since the option exists, and did not validate, delete it
6150 Jetpack_Options::delete_option( 'sync_error_idc' );
6151 }
6152
6153 return $is_valid;
6154 }
6155
6156 /**
6157 * Normalizes a url by doing three things:
6158 * - Strips protocol
6159 * - Strips www
6160 * - Adds a trailing slash
6161 *
6162 * @since 4.4.0
6163 * @param string $url
6164 * @return WP_Error|string
6165 */
6166 public static function normalize_url_protocol_agnostic( $url ) {
6167 $parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
6168 if ( ! $parsed_url || empty( $parsed_url['host'] ) || empty( $parsed_url['path'] ) ) {
6169 return new WP_Error( 'cannot_parse_url', sprintf( esc_html__( 'Cannot parse URL %s', 'jetpack' ), $url ) );
6170 }
6171
6172 // Strip www and protocols
6173 $url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
6174 return $url;
6175 }
6176
6177 /**
6178 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
6179 *
6180 * @since 4.4.0
6181 * @since 5.4.0 Add transient since home/siteurl retrieved directly from DB
6182 *
6183 * @param array $response
6184 * @return array Array of the local urls, wpcom urls, and error code
6185 */
6186 public static function get_sync_error_idc_option( $response = array() ) {
6187 // Since the local options will hit the database directly, store the values
6188 // in a transient to allow for autoloading and caching on subsequent views.
6189 $local_options = get_transient( 'jetpack_idc_local' );
6190 if ( false === $local_options ) {
6191 $local_options = array(
6192 'home' => Functions::home_url(),
6193 'siteurl' => Functions::site_url(),
6194 );
6195 set_transient( 'jetpack_idc_local', $local_options, MINUTE_IN_SECONDS );
6196 }
6197
6198 $options = array_merge( $local_options, $response );
6199
6200 $returned_values = array();
6201 foreach( $options as $key => $option ) {
6202 if ( 'error_code' === $key ) {
6203 $returned_values[ $key ] = $option;
6204 continue;
6205 }
6206
6207 if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
6208 continue;
6209 }
6210
6211 $returned_values[ $key ] = $normalized_url;
6212 }
6213
6214 set_transient( 'jetpack_idc_option', $returned_values, MINUTE_IN_SECONDS );
6215
6216 return $returned_values;
6217 }
6218
6219 /**
6220 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
6221 * If set to true, the site will be put into staging mode.
6222 *
6223 * @since 4.3.2
6224 * @return bool
6225 */
6226 public static function sync_idc_optin() {
6227 if ( Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
6228 $default = Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
6229 } else {
6230 $default = ! Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
6231 }
6232
6233 /**
6234 * Allows sites to optin to IDC mitigation which blocks the site from syncing to WordPress.com when the home
6235 * URL or site URL do not match what WordPress.com expects. The default value is either false, or the value of
6236 * JETPACK_SYNC_IDC_OPTIN constant if set.
6237 *
6238 * @since 4.3.2
6239 *
6240 * @param bool $default Whether the site is opted in to IDC mitigation.
6241 */
6242 return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
6243 }
6244
6245 /**
6246 * Maybe Use a .min.css stylesheet, maybe not.
6247 *
6248 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
6249 */
6250 public static function maybe_min_asset( $url, $path, $plugin ) {
6251 // Short out on things trying to find actual paths.
6252 if ( ! $path || empty( $plugin ) ) {
6253 return $url;
6254 }
6255
6256 $path = ltrim( $path, '/' );
6257
6258 // Strip out the abspath.
6259 $base = dirname( plugin_basename( $plugin ) );
6260
6261 // Short out on non-Jetpack assets.
6262 if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
6263 return $url;
6264 }
6265
6266 // File name parsing.
6267 $file = "{$base}/{$path}";
6268 $full_path = JETPACK__PLUGIN_DIR . substr( $file, 8 );
6269 $file_name = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
6270 $file_name_parts_r = array_reverse( explode( '.', $file_name ) );
6271 $extension = array_shift( $file_name_parts_r );
6272
6273 if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
6274 // Already pointing at the minified version.
6275 if ( 'min' === $file_name_parts_r[0] ) {
6276 return $url;
6277 }
6278
6279 $min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
6280 if ( file_exists( $min_full_path ) ) {
6281 $url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
6282 // If it's a CSS file, stash it so we can set the .min suffix for rtl-ing.
6283 if ( 'css' === $extension ) {
6284 $key = str_replace( JETPACK__PLUGIN_DIR, 'jetpack/', $min_full_path );
6285 self::$min_assets[ $key ] = $path;
6286 }
6287 }
6288 }
6289
6290 return $url;
6291 }
6292
6293 /**
6294 * If the asset is minified, let's flag .min as the suffix.
6295 *
6296 * Attached to `style_loader_src` filter.
6297 *
6298 * @param string $tag The tag that would link to the external asset.
6299 * @param string $handle The registered handle of the script in question.
6300 * @param string $href The url of the asset in question.
6301 */
6302 public static function set_suffix_on_min( $src, $handle ) {
6303 if ( false === strpos( $src, '.min.css' ) ) {
6304 return $src;
6305 }
6306
6307 if ( ! empty( self::$min_assets ) ) {
6308 foreach ( self::$min_assets as $file => $path ) {
6309 if ( false !== strpos( $src, $file ) ) {
6310 wp_style_add_data( $handle, 'suffix', '.min' );
6311 return $src;
6312 }
6313 }
6314 }
6315
6316 return $src;
6317 }
6318
6319 /**
6320 * Maybe inlines a stylesheet.
6321 *
6322 * If you'd like to inline a stylesheet instead of printing a link to it,
6323 * wp_style_add_data( 'handle', 'jetpack-inline', true );
6324 *
6325 * Attached to `style_loader_tag` filter.
6326 *
6327 * @param string $tag The tag that would link to the external asset.
6328 * @param string $handle The registered handle of the script in question.
6329 *
6330 * @return string
6331 */
6332 public static function maybe_inline_style( $tag, $handle ) {
6333 global $wp_styles;
6334 $item = $wp_styles->registered[ $handle ];
6335
6336 if ( ! isset( $item->extra['jetpack-inline'] ) || ! $item->extra['jetpack-inline'] ) {
6337 return $tag;
6338 }
6339
6340 if ( preg_match( '# href=\'([^\']+)\' #i', $tag, $matches ) ) {
6341 $href = $matches[1];
6342 // Strip off query string
6343 if ( $pos = strpos( $href, '?' ) ) {
6344 $href = substr( $href, 0, $pos );
6345 }
6346 // Strip off fragment
6347 if ( $pos = strpos( $href, '#' ) ) {
6348 $href = substr( $href, 0, $pos );
6349 }
6350 } else {
6351 return $tag;
6352 }
6353
6354 $plugins_dir = plugin_dir_url( JETPACK__PLUGIN_FILE );
6355 if ( $plugins_dir !== substr( $href, 0, strlen( $plugins_dir ) ) ) {
6356 return $tag;
6357 }
6358
6359 // If this stylesheet has a RTL version, and the RTL version replaces normal...
6360 if ( isset( $item->extra['rtl'] ) && 'replace' === $item->extra['rtl'] && is_rtl() ) {
6361 // And this isn't the pass that actually deals with the RTL version...
6362 if ( false === strpos( $tag, " id='$handle-rtl-css' " ) ) {
6363 // Short out, as the RTL version will deal with it in a moment.
6364 return $tag;
6365 }
6366 }
6367
6368 $file = JETPACK__PLUGIN_DIR . substr( $href, strlen( $plugins_dir ) );
6369 $css = Jetpack::absolutize_css_urls( file_get_contents( $file ), $href );
6370 if ( $css ) {
6371 $tag = "<!-- Inline {$item->handle} -->\r\n";
6372 if ( empty( $item->extra['after'] ) ) {
6373 wp_add_inline_style( $handle, $css );
6374 } else {
6375 array_unshift( $item->extra['after'], $css );
6376 wp_style_add_data( $handle, 'after', $item->extra['after'] );
6377 }
6378 }
6379
6380 return $tag;
6381 }
6382
6383 /**
6384 * Loads a view file from the views
6385 *
6386 * Data passed in with the $data parameter will be available in the
6387 * template file as $data['value']
6388 *
6389 * @param string $template - Template file to load
6390 * @param array $data - Any data to pass along to the template
6391 * @return boolean - If template file was found
6392 **/
6393 public function load_view( $template, $data = array() ) {
6394 $views_dir = JETPACK__PLUGIN_DIR . 'views/';
6395
6396 if( file_exists( $views_dir . $template ) ) {
6397 require_once( $views_dir . $template );
6398 return true;
6399 }
6400
6401 error_log( "Jetpack: Unable to find view file $views_dir$template" );
6402 return false;
6403 }
6404
6405 /**
6406 * Throws warnings for deprecated hooks to be removed from Jetpack
6407 */
6408 public function deprecated_hooks() {
6409 global $wp_filter;
6410
6411 /*
6412 * Format:
6413 * deprecated_filter_name => replacement_name
6414 *
6415 * If there is no replacement, use null for replacement_name
6416 */
6417 $deprecated_list = array(
6418 'jetpack_bail_on_shortcode' => 'jetpack_shortcodes_to_include',
6419 'wpl_sharing_2014_1' => null,
6420 'jetpack-tools-to-include' => 'jetpack_tools_to_include',
6421 'jetpack_identity_crisis_options_to_check' => null,
6422 'update_option_jetpack_single_user_site' => null,
6423 'audio_player_default_colors' => null,
6424 'add_option_jetpack_featured_images_enabled' => null,
6425 'add_option_jetpack_update_details' => null,
6426 'add_option_jetpack_updates' => null,
6427 'add_option_jetpack_network_name' => null,
6428 'add_option_jetpack_network_allow_new_registrations' => null,
6429 'add_option_jetpack_network_add_new_users' => null,
6430 'add_option_jetpack_network_site_upload_space' => null,
6431 'add_option_jetpack_network_upload_file_types' => null,
6432 'add_option_jetpack_network_enable_administration_menus' => null,
6433 'add_option_jetpack_is_multi_site' => null,
6434 'add_option_jetpack_is_main_network' => null,
6435 'add_option_jetpack_main_network_site' => null,
6436 'jetpack_sync_all_registered_options' => null,
6437 'jetpack_has_identity_crisis' => 'jetpack_sync_error_idc_validation',
6438 'jetpack_is_post_mailable' => null,
6439 'jetpack_seo_site_host' => null,
6440 'jetpack_installed_plugin' => 'jetpack_plugin_installed',
6441 'jetpack_holiday_snow_option_name' => null,
6442 'jetpack_holiday_chance_of_snow' => null,
6443 'jetpack_holiday_snow_js_url' => null,
6444 'jetpack_is_holiday_snow_season' => null,
6445 'jetpack_holiday_snow_option_updated' => null,
6446 'jetpack_holiday_snowing' => null,
6447 'jetpack_sso_auth_cookie_expirtation' => 'jetpack_sso_auth_cookie_expiration',
6448 'jetpack_cache_plans' => null,
6449 'jetpack_updated_theme' => 'jetpack_updated_themes',
6450 'jetpack_lazy_images_skip_image_with_atttributes' => 'jetpack_lazy_images_skip_image_with_attributes',
6451 'jetpack_enable_site_verification' => null,
6452 'can_display_jetpack_manage_notice' => null,
6453 // Removed in Jetpack 7.3.0
6454 'atd_load_scripts' => null,
6455 'atd_http_post_timeout' => null,
6456 'atd_http_post_error' => null,
6457 'atd_service_domain' => null,
6458 );
6459
6460 // This is a silly loop depth. Better way?
6461 foreach( $deprecated_list AS $hook => $hook_alt ) {
6462 if ( has_action( $hook ) ) {
6463 foreach( $wp_filter[ $hook ] AS $func => $values ) {
6464 foreach( $values AS $hooked ) {
6465 if ( is_callable( $hooked['function'] ) ) {
6466 $function_name = 'an anonymous function';
6467 } else {
6468 $function_name = $hooked['function'];
6469 }
6470 _deprecated_function( $hook . ' used for ' . $function_name, null, $hook_alt );
6471 }
6472 }
6473 }
6474 }
6475 }
6476
6477 /**
6478 * Converts any url in a stylesheet, to the correct absolute url.
6479 *
6480 * Considerations:
6481 * - Normal, relative URLs `feh.png`
6482 * - Data URLs `data:image/gif;base64,eh129ehiuehjdhsa==`
6483 * - Schema-agnostic URLs `//domain.com/feh.png`
6484 * - Absolute URLs `http://domain.com/feh.png`
6485 * - Domain root relative URLs `/feh.png`
6486 *
6487 * @param $css string: The raw CSS -- should be read in directly from the file.
6488 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6489 *
6490 * @return mixed|string
6491 */
6492 public static function absolutize_css_urls( $css, $css_file_url ) {
6493 $pattern = '#url\((?P<path>[^)]*)\)#i';
6494 $css_dir = dirname( $css_file_url );
6495 $p = parse_url( $css_dir );
6496 $domain = sprintf(
6497 '%1$s//%2$s%3$s%4$s',
6498 isset( $p['scheme'] ) ? "{$p['scheme']}:" : '',
6499 isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
6500 $p['host'],
6501 isset( $p['port'] ) ? ":{$p['port']}" : ''
6502 );
6503
6504 if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
6505 $find = $replace = array();
6506 foreach ( $matches as $match ) {
6507 $url = trim( $match['path'], "'\" \t" );
6508
6509 // If this is a data url, we don't want to mess with it.
6510 if ( 'data:' === substr( $url, 0, 5 ) ) {
6511 continue;
6512 }
6513
6514 // If this is an absolute or protocol-agnostic url,
6515 // we don't want to mess with it.
6516 if ( preg_match( '#^(https?:)?//#i', $url ) ) {
6517 continue;
6518 }
6519
6520 switch ( substr( $url, 0, 1 ) ) {
6521 case '/':
6522 $absolute = $domain . $url;
6523 break;
6524 default:
6525 $absolute = $css_dir . '/' . $url;
6526 }
6527
6528 $find[] = $match[0];
6529 $replace[] = sprintf( 'url("%s")', $absolute );
6530 }
6531 $css = str_replace( $find, $replace, $css );
6532 }
6533
6534 return $css;
6535 }
6536
6537 /**
6538 * This methods removes all of the registered css files on the front end
6539 * from Jetpack in favor of using a single file. In effect "imploding"
6540 * all the files into one file.
6541 *
6542 * Pros:
6543 * - Uses only ONE css asset connection instead of 15
6544 * - Saves a minimum of 56k
6545 * - Reduces server load
6546 * - Reduces time to first painted byte
6547 *
6548 * Cons:
6549 * - Loads css for ALL modules. However all selectors are prefixed so it
6550 * should not cause any issues with themes.
6551 * - Plugins/themes dequeuing styles no longer do anything. See
6552 * jetpack_implode_frontend_css filter for a workaround
6553 *
6554 * For some situations developers may wish to disable css imploding and
6555 * instead operate in legacy mode where each file loads seperately and
6556 * can be edited individually or dequeued. This can be accomplished with
6557 * the following line:
6558 *
6559 * add_filter( 'jetpack_implode_frontend_css', '__return_false' );
6560 *
6561 * @since 3.2
6562 **/
6563 public function implode_frontend_css( $travis_test = false ) {
6564 $do_implode = true;
6565 if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
6566 $do_implode = false;
6567 }
6568
6569 // Do not implode CSS when the page loads via the AMP plugin.
6570 if ( Jetpack_AMP_Support::is_amp_request() ) {
6571 $do_implode = false;
6572 }
6573
6574 /**
6575 * Allow CSS to be concatenated into a single jetpack.css file.
6576 *
6577 * @since 3.2.0
6578 *
6579 * @param bool $do_implode Should CSS be concatenated? Default to true.
6580 */
6581 $do_implode = apply_filters( 'jetpack_implode_frontend_css', $do_implode );
6582
6583 // Do not use the imploded file when default behavior was altered through the filter
6584 if ( ! $do_implode ) {
6585 return;
6586 }
6587
6588 // We do not want to use the imploded file in dev mode, or if not connected
6589 if ( Jetpack::is_development_mode() || ! self::is_active() ) {
6590 if ( ! $travis_test ) {
6591 return;
6592 }
6593 }
6594
6595 // Do not use the imploded file if sharing css was dequeued via the sharing settings screen
6596 if ( get_option( 'sharedaddy_disable_resources' ) ) {
6597 return;
6598 }
6599
6600 /*
6601 * Now we assume Jetpack is connected and able to serve the single
6602 * file.
6603 *
6604 * In the future there will be a check here to serve the file locally
6605 * or potentially from the Jetpack CDN
6606 *
6607 * For now:
6608 * - Enqueue a single imploded css file
6609 * - Zero out the style_loader_tag for the bundled ones
6610 * - Be happy, drink scotch
6611 */
6612
6613 add_filter( 'style_loader_tag', array( $this, 'concat_remove_style_loader_tag' ), 10, 2 );
6614
6615 $version = Jetpack::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . 'css/jetpack.css' ) : JETPACK__VERSION;
6616
6617 wp_enqueue_style( 'jetpack_css', plugins_url( 'css/jetpack.css', __FILE__ ), array(), $version );
6618 wp_style_add_data( 'jetpack_css', 'rtl', 'replace' );
6619 }
6620
6621 function concat_remove_style_loader_tag( $tag, $handle ) {
6622 if ( in_array( $handle, $this->concatenated_style_handles ) ) {
6623 $tag = '';
6624 if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
6625 $tag = "<!-- `" . esc_html( $handle ) . "` is included in the concatenated jetpack.css -->\r\n";
6626 }
6627 }
6628
6629 return $tag;
6630 }
6631
6632 /*
6633 * Check the heartbeat data
6634 *
6635 * Organizes the heartbeat data by severity. For example, if the site
6636 * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6637 *
6638 * Data will be added to "caution" array, if it either:
6639 * - Out of date Jetpack version
6640 * - Out of date WP version
6641 * - Out of date PHP version
6642 *
6643 * $return array $filtered_data
6644 */
6645 public static function jetpack_check_heartbeat_data() {
6646 $raw_data = Jetpack_Heartbeat::generate_stats_array();
6647
6648 $good = array();
6649 $caution = array();
6650 $bad = array();
6651
6652 foreach ( $raw_data as $stat => $value ) {
6653
6654 // Check jetpack version
6655 if ( 'version' == $stat ) {
6656 if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6657 $caution[ $stat ] = $value . " - min supported is " . JETPACK__VERSION;
6658 continue;
6659 }
6660 }
6661
6662 // Check WP version
6663 if ( 'wp-version' == $stat ) {
6664 if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6665 $caution[ $stat ] = $value . " - min supported is " . JETPACK__MINIMUM_WP_VERSION;
6666 continue;
6667 }
6668 }
6669
6670 // Check PHP version
6671 if ( 'php-version' == $stat ) {
6672 if ( version_compare( PHP_VERSION, '5.2.4', '<' ) ) {
6673 $caution[ $stat ] = $value . " - min supported is 5.2.4";
6674 continue;
6675 }
6676 }
6677
6678 // Check ID crisis
6679 if ( 'identitycrisis' == $stat ) {
6680 if ( 'yes' == $value ) {
6681 $bad[ $stat ] = $value;
6682 continue;
6683 }
6684 }
6685
6686 // The rest are good :)
6687 $good[ $stat ] = $value;
6688 }
6689
6690 $filtered_data = array(
6691 'good' => $good,
6692 'caution' => $caution,
6693 'bad' => $bad
6694 );
6695
6696 return $filtered_data;
6697 }
6698
6699
6700 /*
6701 * This method is used to organize all options that can be reset
6702 * without disconnecting Jetpack.
6703 *
6704 * It is used in class.jetpack-cli.php to reset options
6705 *
6706 * @since 5.4.0 Logic moved to Jetpack_Options class. Method left in Jetpack class for backwards compat.
6707 *
6708 * @return array of options to delete.
6709 */
6710 public static function get_jetpack_options_for_reset() {
6711 return Jetpack_Options::get_options_for_reset();
6712 }
6713
6714 /*
6715 * Strip http:// or https:// from a url, replaces forward slash with ::,
6716 * so we can bring them directly to their site in calypso.
6717 *
6718 * @param string | url
6719 * @return string | url without the guff
6720 */
6721 public static function build_raw_urls( $url ) {
6722 $strip_http = '/.*?:\/\//i';
6723 $url = preg_replace( $strip_http, '', $url );
6724 $url = str_replace( '/', '::', $url );
6725 return $url;
6726 }
6727
6728 /**
6729 * Stores and prints out domains to prefetch for page speed optimization.
6730 *
6731 * @param mixed $new_urls
6732 */
6733 public static function dns_prefetch( $new_urls = null ) {
6734 static $prefetch_urls = array();
6735 if ( empty( $new_urls ) && ! empty( $prefetch_urls ) ) {
6736 echo "\r\n";
6737 foreach ( $prefetch_urls as $this_prefetch_url ) {
6738 printf( "<link rel='dns-prefetch' href='%s'/>\r\n", esc_attr( $this_prefetch_url ) );
6739 }
6740 } elseif ( ! empty( $new_urls ) ) {
6741 if ( ! has_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) ) ) {
6742 add_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) );
6743 }
6744 foreach ( (array) $new_urls as $this_new_url ) {
6745 $prefetch_urls[] = strtolower( untrailingslashit( preg_replace( '#^https?://#i', '//', $this_new_url ) ) );
6746 }
6747 $prefetch_urls = array_unique( $prefetch_urls );
6748 }
6749 }
6750
6751 public function wp_dashboard_setup() {
6752 if ( self::is_active() ) {
6753 add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
6754 }
6755
6756 if ( has_action( 'jetpack_dashboard_widget' ) ) {
6757 $jetpack_logo = new Jetpack_Logo();
6758 $widget_title = sprintf(
6759 wp_kses(
6760 /* translators: Placeholder is a Jetpack logo. */
6761 __( 'Stats <span>by %s</span>', 'jetpack' ),
6762 array( 'span' => array() )
6763 ),
6764 $jetpack_logo->get_jp_emblem( true )
6765 );
6766
6767 wp_add_dashboard_widget(
6768 'jetpack_summary_widget',
6769 $widget_title,
6770 array( __CLASS__, 'dashboard_widget' )
6771 );
6772 wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
6773
6774 // If we're inactive and not in development mode, sort our box to the top.
6775 if ( ! self::is_active() && ! self::is_development_mode() ) {
6776 global $wp_meta_boxes;
6777
6778 $dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
6779 $ours = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
6780
6781 $wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
6782 }
6783 }
6784 }
6785
6786 /**
6787 * @param mixed $result Value for the user's option
6788 * @return mixed
6789 */
6790 function get_user_option_meta_box_order_dashboard( $sorted ) {
6791 if ( ! is_array( $sorted ) ) {
6792 return $sorted;
6793 }
6794
6795 foreach ( $sorted as $box_context => $ids ) {
6796 if ( false === strpos( $ids, 'dashboard_stats' ) ) {
6797 // If the old id isn't anywhere in the ids, don't bother exploding and fail out.
6798 continue;
6799 }
6800
6801 $ids_array = explode( ',', $ids );
6802 $key = array_search( 'dashboard_stats', $ids_array );
6803
6804 if ( false !== $key ) {
6805 // If we've found that exact value in the option (and not `google_dashboard_stats` for example)
6806 $ids_array[ $key ] = 'jetpack_summary_widget';
6807 $sorted[ $box_context ] = implode( ',', $ids_array );
6808 // We've found it, stop searching, and just return.
6809 break;
6810 }
6811 }
6812
6813 return $sorted;
6814 }
6815
6816 public static function dashboard_widget() {
6817 /**
6818 * Fires when the dashboard is loaded.
6819 *
6820 * @since 3.4.0
6821 */
6822 do_action( 'jetpack_dashboard_widget' );
6823 }
6824
6825 public static function dashboard_widget_footer() {
6826 ?>
6827 <footer>
6828
6829 <div class="protect">
6830 <?php if ( Jetpack::is_module_active( 'protect' ) ) : ?>
6831 <h3><?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?></h3>
6832 <p><?php echo esc_html_x( 'Blocked malicious login attempts', '{#} Blocked malicious login attempts -- number is on a prior line, text is a caption.', 'jetpack' ); ?></p>
6833 <?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! self::is_development_mode() ) : ?>
6834 <a href="<?php echo esc_url( wp_nonce_url( Jetpack::admin_url( array( 'action' => 'activate', 'module' => 'protect' ) ), 'jetpack_activate-protect' ) ); ?>" class="button button-jetpack" title="<?php esc_attr_e( 'Protect helps to keep you secure from brute-force login attacks.', 'jetpack' ); ?>">
6835 <?php esc_html_e( 'Activate Protect', 'jetpack' ); ?>
6836 </a>
6837 <?php else : ?>
6838 <?php esc_html_e( 'Protect is inactive.', 'jetpack' ); ?>
6839 <?php endif; ?>
6840 </div>
6841
6842 <div class="akismet">
6843 <?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
6844 <h3><?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?></h3>
6845 <p><?php echo esc_html_x( 'Spam comments blocked by Akismet.', '{#} Spam comments blocked by Akismet -- number is on a prior line, text is a caption.', 'jetpack' ); ?></p>
6846 <?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
6847 <a href="<?php echo esc_url( wp_nonce_url( add_query_arg( array( 'action' => 'activate', 'plugin' => 'akismet/akismet.php' ), admin_url( 'plugins.php' ) ), 'activate-plugin_akismet/akismet.php' ) ); ?>" class="button button-jetpack">
6848 <?php esc_html_e( 'Activate Akismet', 'jetpack' ); ?>
6849 </a>
6850 <?php else : ?>
6851 <p><a href="<?php echo esc_url( 'https://akismet.com/?utm_source=jetpack&utm_medium=link&utm_campaign=Jetpack%20Dashboard%20Widget%20Footer%20Link' ); ?>"><?php esc_html_e( 'Akismet can help to keep your blog safe from spam!', 'jetpack' ); ?></a></p>
6852 <?php endif; ?>
6853 </div>
6854
6855 </footer>
6856 <?php
6857 }
6858
6859 /*
6860 * Adds a "blank" column in the user admin table to display indication of user connection.
6861 */
6862 function jetpack_icon_user_connected( $columns ) {
6863 $columns['user_jetpack'] = '';
6864 return $columns;
6865 }
6866
6867 /*
6868 * Show Jetpack icon if the user is linked.
6869 */
6870 function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
6871 if ( 'user_jetpack' == $col && Jetpack::is_user_connected( $user_id ) ) {
6872 $jetpack_logo = new Jetpack_Logo();
6873 $emblem_html = sprintf(
6874 '<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
6875 esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
6876 $jetpack_logo->get_jp_emblem()
6877 );
6878 return $emblem_html;
6879 }
6880
6881 return $val;
6882 }
6883
6884 /*
6885 * Style the Jetpack user column
6886 */
6887 function jetpack_user_col_style() {
6888 global $current_screen;
6889 if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) { ?>
6890 <style>
6891 .fixed .column-user_jetpack {
6892 width: 21px;
6893 }
6894 .jp-emblem-user-admin svg {
6895 width: 20px;
6896 height: 20px;
6897 }
6898 .jp-emblem-user-admin path {
6899 fill: #00BE28;
6900 }
6901 </style>
6902 <?php }
6903 }
6904
6905 /**
6906 * Checks if Akismet is active and working.
6907 *
6908 * We dropped support for Akismet 3.0 with Jetpack 6.1.1 while introducing a check for an Akismet valid key
6909 * that implied usage of methods present since more recent version.
6910 * See https://github.com/Automattic/jetpack/pull/9585
6911 *
6912 * @since 5.1.0
6913 *
6914 * @return bool True = Akismet available. False = Aksimet not available.
6915 */
6916 public static function is_akismet_active() {
6917 static $status = null;
6918
6919 if ( ! is_null( $status ) ) {
6920 return $status;
6921 }
6922
6923 // Check if a modern version of Akismet is active.
6924 if ( ! method_exists( 'Akismet', 'http_post' ) ) {
6925 $status = false;
6926 return $status;
6927 }
6928
6929 // Make sure there is a key known to Akismet at all before verifying key.
6930 $akismet_key = Akismet::get_api_key();
6931 if ( ! $akismet_key ) {
6932 $status = false;
6933 return $status;
6934 }
6935
6936 // Possible values: valid, invalid, failure via Akismet. false if no status is cached.
6937 $akismet_key_state = get_transient( 'jetpack_akismet_key_is_valid' );
6938
6939 // Do not used the cache result in wp-admin or REST API requests if the key isn't valid, in case someone is actively renewing, etc.
6940 $recheck = ( is_admin() || ( defined( 'REST_REQUEST' ) && REST_REQUEST ) ) && 'valid' !== $akismet_key_state;
6941 // We cache the result of the Akismet key verification for ten minutes.
6942 if ( ! $akismet_key_state || $recheck ) {
6943 $akismet_key_state = Akismet::verify_key( $akismet_key );
6944 set_transient( 'jetpack_akismet_key_is_valid', $akismet_key_state, 10 * MINUTE_IN_SECONDS );
6945 }
6946
6947 $status = 'valid' === $akismet_key_state;
6948
6949 return $status;
6950 }
6951
6952 /**
6953 * Checks if one or more function names is in debug_backtrace
6954 *
6955 * @param $names Mixed string name of function or array of string names of functions
6956 *
6957 * @return bool
6958 */
6959 public static function is_function_in_backtrace( $names ) {
6960 $backtrace = debug_backtrace( false ); // phpcs:ignore PHPCompatibility.FunctionUse.NewFunctionParameters.debug_backtrace_optionsFound
6961 if ( ! is_array( $names ) ) {
6962 $names = array( $names );
6963 }
6964 $names_as_keys = array_flip( $names );
6965
6966 //Do check in constant O(1) time for PHP5.5+
6967 if ( function_exists( 'array_column' ) ) {
6968 $backtrace_functions = array_column( $backtrace, 'function' ); // phpcs:ignore PHPCompatibility.FunctionUse.NewFunctions.array_columnFound
6969 $backtrace_functions_as_keys = array_flip( $backtrace_functions );
6970 $intersection = array_intersect_key( $backtrace_functions_as_keys, $names_as_keys );
6971 return ! empty ( $intersection );
6972 }
6973
6974 //Do check in linear O(n) time for < PHP5.5 ( using isset at least prevents O(n^2) )
6975 foreach ( $backtrace as $call ) {
6976 if ( isset( $names_as_keys[ $call['function'] ] ) ) {
6977 return true;
6978 }
6979 }
6980 return false;
6981 }
6982
6983 /**
6984 * Given a minified path, and a non-minified path, will return
6985 * a minified or non-minified file URL based on whether SCRIPT_DEBUG is set and truthy.
6986 *
6987 * Both `$min_base` and `$non_min_base` are expected to be relative to the
6988 * root Jetpack directory.
6989 *
6990 * @since 5.6.0
6991 *
6992 * @param string $min_path
6993 * @param string $non_min_path
6994 * @return string The URL to the file
6995 */
6996 public static function get_file_url_for_environment( $min_path, $non_min_path ) {
6997 return Assets::get_file_url_for_environment( $min_path, $non_min_path );
6998 }
6999
7000 /**
7001 * Checks for whether Jetpack Backup & Scan is enabled.
7002 * Will return true if the state of Backup & Scan is anything except "unavailable".
7003 * @return bool|int|mixed
7004 */
7005 public static function is_rewind_enabled() {
7006 if ( ! Jetpack::is_active() ) {
7007 return false;
7008 }
7009
7010 $rewind_enabled = get_transient( 'jetpack_rewind_enabled' );
7011 if ( false === $rewind_enabled ) {
7012 jetpack_require_lib( 'class.core-rest-api-endpoints' );
7013 $rewind_data = (array) Jetpack_Core_Json_Api_Endpoints::rewind_data();
7014 $rewind_enabled = ( ! is_wp_error( $rewind_data )
7015 && ! empty( $rewind_data['state'] )
7016 && 'active' === $rewind_data['state'] )
7017 ? 1
7018 : 0;
7019
7020 set_transient( 'jetpack_rewind_enabled', $rewind_enabled, 10 * MINUTE_IN_SECONDS );
7021 }
7022 return $rewind_enabled;
7023 }
7024
7025 /**
7026 * Return Calypso environment value; used for developing Jetpack and pairing
7027 * it with different Calypso enrionments, such as localhost.
7028 *
7029 * @since 7.4.0
7030 *
7031 * @return string Calypso environment
7032 */
7033 public static function get_calypso_env() {
7034 if ( isset( $_GET['calypso_env'] ) ) {
7035 return sanitize_key( $_GET['calypso_env'] );
7036 }
7037
7038 if ( getenv( 'CALYPSO_ENV' ) ) {
7039 return sanitize_key( getenv( 'CALYPSO_ENV' ) );
7040 }
7041
7042 if ( defined( 'CALYPSO_ENV' ) && CALYPSO_ENV ) {
7043 return sanitize_key( CALYPSO_ENV );
7044 }
7045
7046 return '';
7047 }
7048
7049 /**
7050 * Checks whether or not TOS has been agreed upon.
7051 * Will return true if a user has clicked to register, or is already connected.
7052 */
7053 public static function jetpack_tos_agreed() {
7054 return Jetpack_Options::get_option( 'tos_agreed' ) || Jetpack::is_active();
7055 }
7056
7057 /**
7058 * Handles activating default modules as well general cleanup for the new connection.
7059 *
7060 * @param boolean $activate_sso Whether to activate the SSO module when activating default modules.
7061 * @param boolean $redirect_on_activation_error Whether to redirect on activation error.
7062 * @param boolean $send_state_messages Whether to send state messages.
7063 * @return void
7064 */
7065 public static function handle_post_authorization_actions(
7066 $activate_sso = false,
7067 $redirect_on_activation_error = false,
7068 $send_state_messages = true
7069 ) {
7070 $other_modules = $activate_sso
7071 ? array( 'sso' )
7072 : array();
7073
7074 if ( $active_modules = Jetpack_Options::get_option( 'active_modules' ) ) {
7075 Jetpack::delete_active_modules();
7076
7077 Jetpack::activate_default_modules( 999, 1, array_merge( $active_modules, $other_modules ), $redirect_on_activation_error, $send_state_messages );
7078 } else {
7079 Jetpack::activate_default_modules( false, false, $other_modules, $redirect_on_activation_error, $send_state_messages );
7080 }
7081
7082 // Since this is a fresh connection, be sure to clear out IDC options
7083 Jetpack_IDC::clear_all_idc_options();
7084 Jetpack_Options::delete_raw_option( 'jetpack_last_connect_url_check' );
7085
7086 // Start nonce cleaner
7087 wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
7088 wp_schedule_event( time(), 'hourly', 'jetpack_clean_nonces' );
7089
7090 if ( $send_state_messages ) {
7091 Jetpack::state( 'message', 'authorized' );
7092 }
7093 }
7094
7095 /**
7096 * Returns a boolean for whether backups UI should be displayed or not.
7097 *
7098 * @return bool Should backups UI be displayed?
7099 */
7100 public static function show_backups_ui() {
7101 /**
7102 * Whether UI for backups should be displayed.
7103 *
7104 * @since 6.5.0
7105 *
7106 * @param bool $show_backups Should UI for backups be displayed? True by default.
7107 */
7108 return Jetpack::is_plugin_active( 'vaultpress/vaultpress.php' ) || apply_filters( 'jetpack_show_backups', true );
7109 }
7110
7111 /*
7112 * Deprecated manage functions
7113 */
7114 function prepare_manage_jetpack_notice() {
7115 _deprecated_function( __METHOD__, 'jetpack-7.3' );
7116 }
7117 function manage_activate_screen() {
7118 _deprecated_function( __METHOD__, 'jetpack-7.3' );
7119 }
7120 function admin_jetpack_manage_notice() {
7121 _deprecated_function( __METHOD__, 'jetpack-7.3' );
7122 }
7123 function opt_out_jetpack_manage_url() {
7124 _deprecated_function( __METHOD__, 'jetpack-7.3' );
7125 }
7126 function opt_in_jetpack_manage_url() {
7127 _deprecated_function( __METHOD__, 'jetpack-7.3' );
7128 }
7129 function opt_in_jetpack_manage_notice() {
7130 _deprecated_function( __METHOD__, 'jetpack-7.3' );
7131 }
7132 function can_display_jetpack_manage_notice() {
7133 _deprecated_function( __METHOD__, 'jetpack-7.3' );
7134 }
7135
7136 /**
7137 * Clean leftoveruser meta.
7138 *
7139 * Delete Jetpack-related user meta when it is no longer needed.
7140 *
7141 * @since 7.3.0
7142 *
7143 * @param int $user_id User ID being updated.
7144 */
7145 public static function user_meta_cleanup( $user_id ) {
7146 $meta_keys = array(
7147 // AtD removed from Jetpack 7.3
7148 'AtD_options',
7149 'AtD_check_when',
7150 'AtD_guess_lang',
7151 'AtD_ignored_phrases',
7152 );
7153
7154 foreach ( $meta_keys as $meta_key ) {
7155 if ( get_user_meta( $user_id, $meta_key ) ) {
7156 delete_user_meta( $user_id, $meta_key );
7157 }
7158 }
7159 }
7160
7161 function is_active_and_not_development_mode( $maybe ) {
7162 if ( ! \Jetpack::is_active() || \Jetpack::is_development_mode() ) {
7163 return false;
7164 }
7165 return true;
7166 }
7167
7168 }
7169