PluginProbe
Jetpack – WP Security, Backup, Speed, & Growth / 8.5
Jetpack – WP Security, Backup, Speed, & Growth v8.5
16.2-beta 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 All 501 releases
jetpack / class.jetpack.php

class.jetpack.php in Jetpack – WP Security, Backup, Speed, & Growth 8.5, at class.jetpack.php

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