PluginProbe
Jetpack – WP Security, Backup, Speed, & Growth / 14.2
Jetpack – WP Security, Backup, Speed, & Growth v14.2
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 / modules / stats.php

stats.php in Jetpack – WP Security, Backup, Speed, & Growth 14.2, at modules/stats.php

1,573 lines 46.6 KB
No matching file
Up and down to move Enter to open Esc to close
Raw Download Zip
1 <?php
2 /**
3 * Module Name: Jetpack Stats
4 * Module Description: Collect valuable traffic stats and insights.
5 * Sort Order: 1
6 * Recommendation Order: 2
7 * First Introduced: 1.1
8 * Requires Connection: Yes
9 * Auto Activate: Yes
10 * Module Tags: Jetpack Stats, Site Stats, Recommended
11 * Feature: Engagement
12 * Additional Search Queries: statistics, tracking, analytics, views, traffic, stats
13 *
14 * @package automattic/jetpack
15 */
16
17 use Automattic\Jetpack\Admin_UI\Admin_Menu;
18 use Automattic\Jetpack\Connection\Client;
19 use Automattic\Jetpack\Connection\Manager as Connection_Manager;
20 use Automattic\Jetpack\Connection\XMLRPC_Async_Call;
21 use Automattic\Jetpack\Redirect;
22 use Automattic\Jetpack\Stats\Main as Stats;
23 use Automattic\Jetpack\Stats\Options as Stats_Options;
24 use Automattic\Jetpack\Stats\Tracking_Pixel as Stats_Tracking_Pixel;
25 use Automattic\Jetpack\Stats\WPCOM_Stats;
26 use Automattic\Jetpack\Stats\XMLRPC_Provider as Stats_XMLRPC;
27 use Automattic\Jetpack\Stats_Admin\Dashboard as Stats_Dashboard;
28 use Automattic\Jetpack\Stats_Admin\Main as Stats_Main;
29 use Automattic\Jetpack\Status\Host;
30 use Automattic\Jetpack\Tracking;
31
32 if ( defined( 'STATS_DASHBOARD_SERVER' ) ) {
33 return;
34 }
35
36 define( 'STATS_DASHBOARD_SERVER', 'dashboard.wordpress.com' );
37
38 /**
39 * Stats content markers.
40 * Used to test for content vs script when parsing server-generated HTML.
41 */
42 const STATS_BODY_MARKER = '<div id="statchart"';
43 const STATS_CONTENT_MARKER = '<div class="gotonewdash">';
44
45 add_action( 'jetpack_modules_loaded', 'stats_load' );
46
47 /**
48 * Load Stats.
49 *
50 * @access public
51 * @return void
52 */
53 function stats_load() {
54 Jetpack::enable_module_configurable( __FILE__ );
55
56 // Only run the callback for those who can see the stats.
57 if ( is_user_logged_in() && current_user_can( 'view_stats' ) ) {
58 add_action( 'admin_head', 'stats_admin_bar_head', 100 );
59 add_action( 'wp_head', 'stats_admin_bar_head', 100 );
60 }
61
62 add_action( 'jetpack_admin_menu', 'stats_admin_menu' );
63
64 add_filter( 'pre_option_db_version', 'stats_ignore_db_version' );
65
66 // Add an icon to see stats in WordPress.com for a particular post.
67 add_action( 'admin_print_styles-edit.php', 'jetpack_stats_load_admin_css' );
68 add_filter( 'manage_posts_columns', 'jetpack_stats_post_table' );
69 add_filter( 'manage_pages_columns', 'jetpack_stats_post_table' );
70 add_action( 'manage_posts_custom_column', 'jetpack_stats_post_table_cell', 10, 2 );
71 add_action( 'manage_pages_custom_column', 'jetpack_stats_post_table_cell', 10, 2 );
72 // Filter for adding the Jetpack plugin version to tracking stats.
73 add_filter( 'stats_array', 'filter_stats_array_add_jp_version' );
74
75 require_once __DIR__ . '/stats/class-jetpack-stats-upgrade-nudges.php';
76 add_action( 'updating_jetpack_version', array( 'Jetpack_Stats_Upgrade_Nudges', 'unset_nudges_setting' ) );
77 }
78
79 /**
80 * Checks if filter is set and dnt is enabled.
81 *
82 * @deprecated 11.5
83 * @return bool
84 */
85 function jetpack_is_dnt_enabled() {
86 _deprecated_function( __METHOD__, 'jetpack-11.5', 'Automattic\Jetpack\Stats\Main::jetpack_is_dnt_enabled' );
87 return Stats::jetpack_is_dnt_enabled();
88 }
89
90 /**
91 * Prevent sparkline img requests being redirected to upgrade.php.
92 * See wp-admin/admin.php where it checks $wp_db_version.
93 *
94 * @access public
95 * @param mixed $version Version.
96 * @return string $version.
97 */
98 function stats_ignore_db_version( $version ) {
99 if (
100 is_admin() &&
101 isset( $_GET['page'] ) && 'stats' === $_GET['page'] && // phpcs:ignore WordPress.Security.NonceVerification.Recommended
102 isset( $_GET['chart'] ) && strpos( $_GET['chart'], 'admin-bar-hours' ) === 0 // phpcs:ignore WordPress.Security.NonceVerification.Recommended, WordPress.Security.ValidatedSanitizedInput
103 ) {
104 global $wp_db_version;
105 return $wp_db_version;
106 }
107 return $version;
108 }
109
110 /**
111 * Maps view_stats cap to read cap as needed.
112 *
113 * @deprecated 11.5
114 *
115 * @access public
116 * @param mixed $caps Caps.
117 * @param mixed $cap Cap.
118 * @param mixed $user_id User ID.
119 * @return array Possibly mapped capabilities for meta capability.
120 */
121 function stats_map_meta_caps( $caps, $cap, $user_id ) {
122 _deprecated_function( __METHOD__, 'jetpack-11.5', 'Automattic\Jetpack\Stats\Main::map_meta_caps' );
123 return Stats::map_meta_caps( $caps, $cap, $user_id );
124 }
125
126 /**
127 * Stats Template Redirect.
128 *
129 * @deprecated 11.5
130 * @access public
131 * @return void
132 */
133 function stats_template_redirect() {
134 _deprecated_function( __METHOD__, 'jetpack-11.5', 'Automattic\Jetpack\Stats\Main::template_redirect' );
135 Stats::template_redirect();
136 }
137
138 /**
139 * Stats Build View Data.
140 *
141 * @deprecated 11.5
142 * @access public
143 * @return array
144 */
145 function stats_build_view_data() {
146 _deprecated_function( __METHOD__, 'jetpack-11.5', 'Automattic\Jetpack\Stats\Tracking_Pixel::build_view_data' );
147 return Stats_Tracking_Pixel::build_view_data();
148 }
149
150 /**
151 * Stats Get Options.
152 *
153 * @deprecated 11.5
154 *
155 * @access public
156 * @return array
157 */
158 function stats_get_options() {
159 _deprecated_function( __METHOD__, 'jetpack-11.5', 'Automattic\Jetpack\Stats\Options::get_options' );
160 return Stats_Options::get_options();
161 }
162
163 /**
164 * Get Stats Options.
165 *
166 * @deprecated 11.5
167 *
168 * @access public
169 * @param mixed $option Option.
170 * @return mixed|null
171 */
172 function stats_get_option( $option ) {
173 _deprecated_function( __METHOD__, 'jetpack-11.5', 'Automattic\Jetpack\Stats\Options::get_option' );
174 return Stats_Options::get_option( $option );
175 }
176
177 /**
178 * Stats Set Options.
179 *
180 * @deprecated 11.5
181 *
182 * @access public
183 * @param mixed $option Option.
184 * @param mixed $value Value.
185 * @return bool
186 */
187 function stats_set_option( $option, $value ) {
188 _deprecated_function( __METHOD__, 'jetpack-11.5', 'Automattic\Jetpack\Stats\Options::set_option' );
189 return Stats_Options::set_option( $option, $value );
190 }
191
192 /**
193 * Stats Set Options.
194 *
195 * @deprecated 11.5
196 *
197 * @access public
198 * @param mixed $options Options.
199 * @return bool
200 */
201 function stats_set_options( $options ) {
202 _deprecated_function( __METHOD__, 'jetpack-11.5', 'Automattic\Jetpack\Stats\Options::set_options' );
203 return Stats_Options::set_options( $options );
204 }
205
206 /**
207 * Stats Upgrade Options.
208 *
209 * @deprecated 11.5
210 *
211 * @access public
212 * @param mixed $options Options.
213 * @return array|bool
214 */
215 function stats_upgrade_options( $options ) {
216 _deprecated_function( __METHOD__, 'jetpack-11.5', 'Automattic\Jetpack\Stats\Options::upgrade_options' );
217 return Stats_Options::upgrade_options( $options );
218 }
219
220 /**
221 * Admin Pages.
222 *
223 * @access public
224 * @return void
225 */
226 function stats_admin_menu() {
227 global $pagenow;
228
229 // If we're at an old Stats URL, redirect to the new one.
230 // Don't even bother with caps, menu_page_url(), etc. Just do it.
231 if ( 'index.php' === $pagenow && isset( $_GET['page'] ) && 'stats' === $_GET['page'] ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
232 $redirect_url = str_replace( array( '/wp-admin/index.php?', '/wp-admin/?' ), '/wp-admin/admin.php?', isset( $_SERVER['REQUEST_URI'] ) ? filter_var( wp_unslash( $_SERVER['REQUEST_URI'] ) ) : null );
233 $relative_pos = strpos( $redirect_url, '/wp-admin/' );
234 if ( false !== $relative_pos ) {
235 wp_safe_redirect( admin_url( substr( $redirect_url, $relative_pos + 10 ) ) );
236 exit;
237 }
238 }
239
240 // phpcs:ignore WordPress.Security.NonceVerification.Recommended
241 if ( ! ( new Host() )->is_woa_site() && isset( $_GET['enable_new_stats'] ) && '1' === $_GET['enable_new_stats'] ) {
242 // Passing true enables Odyssey Stats.
243 // We're ignorning the return value for now.
244 Stats_Main::update_new_stats_status( true );
245 }
246
247 // phpcs:ignore WordPress.Security.NonceVerification.Recommended
248 if ( ! Stats_Options::get_option( 'enable_odyssey_stats' ) || isset( $_GET['noheader'] ) ) {
249 // Show old Jetpack Stats interface for:
250 // - When the "enable_odyssey_stats" option is disabled.
251 // - When being shown in the adminbar outside of wp-admin.
252 $hook = Admin_Menu::add_menu( __( 'Stats', 'jetpack' ), __( 'Stats', 'jetpack' ), 'view_stats', 'stats', 'jetpack_admin_ui_stats_report_page_wrapper' );
253 add_action( "load-$hook", 'stats_reports_load' );
254 } else {
255 // Enable the new Odyssey Stats experience.
256 $stats_dashboard = new Stats_Dashboard();
257 $hook = Admin_Menu::add_menu( __( 'Stats', 'jetpack' ), __( 'Stats', 'jetpack' ), 'view_stats', 'stats', array( $stats_dashboard, 'render' ), 1 );
258 add_action( "load-$hook", array( $stats_dashboard, 'admin_init' ) );
259 }
260 }
261
262 /**
263 * Stats Admin Path.
264 *
265 * @access public
266 * @return string
267 */
268 function stats_admin_path() {
269 return Jetpack::module_configuration_url( __FILE__ );
270 }
271
272 /**
273 * Stats Reports Load.
274 *
275 * @access public
276 * @return void
277 */
278 function stats_reports_load() {
279 require_once __DIR__ . '/stats/class-jetpack-stats-upgrade-nudges.php';
280 Jetpack_Stats_Upgrade_Nudges::init();
281
282 wp_enqueue_script( 'jquery' );
283 wp_enqueue_script( 'postbox' );
284 wp_enqueue_script( 'underscore' );
285
286 Jetpack_Admin_Page::load_wrapper_styles();
287 add_action( 'admin_print_styles', 'stats_reports_css' );
288
289 if ( ! empty( $_GET['nojs'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
290 $parsed = wp_parse_url( admin_url() );
291 // Remember user doesn't want JS.
292 setcookie( 'stnojs', '1', time() + 172800, $parsed['path'], COOKIE_DOMAIN, is_ssl(), true ); // 2 days.
293 }
294
295 if ( ! empty( $_COOKIE['stnojs'] ) ) {
296 // Detect if JS is on. If so, remove cookie so next page load is via JS.
297 add_action( 'admin_print_footer_scripts', 'stats_js_remove_stnojs_cookie' );
298 } elseif ( ! isset( $_GET['noheader'] ) && empty( $_GET['nojs'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
299 // Normal page load. Load page content via JS.
300 add_action( 'admin_print_footer_scripts', 'stats_script_dismiss_nudge_handler' );
301 }
302 }
303
304 /**
305 * JavaScript to dismiss the Odyssey nudge.
306 *
307 * @access public
308 * @return void
309 */
310 function stats_script_dismiss_nudge_handler() {
311 ?>
312 <script type="text/javascript">
313 function stats_odyssey_dismiss_nudge() {
314 // Hide the nudge UI, effectively dismissing it.
315 var element = document.getElementById( "stats-odyssey-nudge-main" );
316 element.classList.toggle( "is-hidden" );
317 // Send an AJAX request.
318 // Note we can provide a 'postponed_for' parameter to set the delay.
319 // Without a parameter it defaults to 30 days which is what we want here.
320 let nonce = <?php echo wp_json_encode( wp_create_nonce( 'wp_rest' ) ); ?>;
321 let url = <?php echo wp_json_encode( rest_url( '/jetpack/v4/stats-app/stats/notices' ) ); ?>;
322 let data = {
323 id: 'opt_in_new_stats',
324 status: 'postponed',
325 };
326 jQuery.ajax({
327 type: "POST",
328 url: url,
329 data: data,
330 headers: { "x-wp-nonce": nonce },
331 });
332 }
333 </script>
334 <?php
335 }
336
337 /**
338 * Stats Reports CSS.
339 *
340 * @access public
341 * @return void
342 */
343 function stats_reports_css() {
344 ?>
345 <style type="text/css">
346 #jp-stats-wrap, #jp-stats-report-bottom {
347 max-width: 1040px;
348 margin: 0 auto;
349 overflow: hidden;
350 }
351 </style>
352 <?php
353 }
354
355 /**
356 * Detect if JS is on. If so, remove cookie so next page load is via JS.
357 *
358 * @access public
359 * @return void
360 */
361 function stats_js_remove_stnojs_cookie() {
362 $parsed = wp_parse_url( admin_url() );
363 ?>
364 <script type="text/javascript">
365 /* <![CDATA[ */
366 document.cookie = 'stnojs=0; expires=Wed, 9 Mar 2011 16:55:50 UTC; path=<?php echo esc_js( $parsed['path'] ); ?>';
367 /* ]]> */
368 </script>
369 <?php
370 }
371
372 /**
373 * Jetpack Admin Page Wrapper.
374 */
375 function jetpack_admin_ui_stats_report_page_wrapper() {
376 if ( ! isset( $_GET['noheader'] ) && empty( $_GET['nojs'] ) && empty( $_COOKIE['stnojs'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
377 Jetpack_Admin_Page::wrap_ui( 'stats_reports_page', array( 'is-wide' => true ) );
378 } else {
379 stats_reports_page();
380 }
381 }
382
383 /**
384 * Stats Report Page.
385 *
386 * @access public
387 * @param bool $main_chart_only (default: false) Main Chart Only.
388 */
389 function stats_reports_page( $main_chart_only = false ) {
390 if ( isset( $_GET['dashboard'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
391 stats_dashboard_widget_content();
392 exit; // @phan-suppress-current-line PhanPluginUnreachableCode -- Safer to include it even though stats_dashboard_widget_content() never returns.
393 }
394
395 $blog_id = Stats_Options::get_option( 'blog_id' );
396 $learn_url = Redirect::get_url( 'jetpack-stats-learn-more' );
397 $redirect_url = admin_url( 'admin.php?page=stats&enable_new_stats=1' );
398 $stats_bg_url = plugins_url( 'images/odyssey-upgrade/background.png', JETPACK__PLUGIN_FILE );
399 $stats_bg_gradient_url = plugins_url( 'images/odyssey-upgrade/gradient.png', JETPACK__PLUGIN_FILE );
400
401 if ( ! $main_chart_only && ! isset( $_GET['noheader'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
402 ?>
403
404 <style>
405 .stats-odyssey-notice {
406 display: flex;
407 font-size: var( --font-body );
408
409 border: 1px solid var( --jp-gray-5 );
410 border-left-color: var( --jp-black );
411 border-left-width: 6px;
412 border-radius: 4px;
413
414 margin-top: 24px;
415 background: white;
416 position: relative;
417 }
418 .stats-odyssey-notice--content__highlighted {
419 border-left-color: var( --jp-red );
420 }
421 .stats-odyssey-notice--content {
422 padding: 24px 0 24px 30px;
423 font-size: 2em;
424 width: 100%;
425 }
426 .stats-odyssey-notice--content-header {
427 font-size: 24px;
428 line-height: 32px;
429 margin: 0;
430 margin-bottom: 8px;
431 }
432 .stats-odyssey-notice--content-text {
433 font-size: 16px;
434 margin: 0;
435 }
436 .stats-odyssey-notice--image-container {
437 background-image: url("<?php echo esc_url( $stats_bg_url ); ?>"), url("<?php echo esc_url( $stats_bg_gradient_url ); ?>");
438 background-size: cover;
439 padding-right: 28px;
440 width: 100%;
441 }
442 .stats-odyssey-notice--close-button {
443 position: absolute;
444 top: 1rem;
445 right: 1rem;
446 background-color: transparent;
447 border: none;
448 cursor: pointer;
449 }
450 .stats-odyssey-notice--action-bar {
451 display: flex;
452 align-items: center;
453 margin-top: 24px;
454 }
455 .stats-odyssey-notice--primary-button {
456 margin-right: 18px;
457 padding-left: 20px;
458 padding-right: 20px;
459 font-size: 16px;
460 border-color: black;
461 background-color: black;
462 }
463 .stats-odyssey-notice--primary-button:hover {
464 border-color: #3c434a;
465 background-color: #3c434a;
466 }
467 .is-primary-link {
468 color: white;
469 text-decoration: none;
470 }
471 .is-primary-link:active {
472 color: white;
473 }
474 .is-primary-link:focus {
475 color: white;
476 box-shadow: none;
477 outline: none;
478 }
479 .is-primary-link:hover {
480 color: white;
481 }
482 .is-secondary-link {
483 color: black;
484 font-size: var( --font-body );
485 }
486 .is-secondary-link:hover {
487 color: black;
488 }
489 .is-hidden {
490 display: none;
491 }
492 </style>
493 <div id="jp-stats-wrap">
494 <div class="wrap">
495 <h1><?php esc_html_e( 'Jetpack Stats', 'jetpack' ); ?>
496 <?php
497 if ( current_user_can( 'jetpack_manage_modules' ) ) :
498 $i18n_headers = jetpack_get_module_i18n( 'stats' );
499 ?>
500 <a
501 style="font-size:13px;"
502 href="<?php echo esc_url( admin_url( 'admin.php?page=jetpack#/settings?term=' . rawurlencode( $i18n_headers['name'] ) ) ); ?>"
503 >
504 <?php esc_html_e( 'Configure', 'jetpack' ); ?>
505 </a>
506 <?php
507 endif;
508
509 ?>
510 </h2>
511 </div>
512 <div class="wrap">
513 <div class="stats-odyssey-notice stats-odyssey-notice--content__highlighted">
514 <div class="stats-odyssey-notice--content">
515 <h2 class="stats-odyssey-notice--content-header"><?php esc_html_e( 'Deprecated Jetpack Stats Experience', 'jetpack' ); ?></h2>
516 <p class="stats-odyssey-notice--content-text"><?php esc_html_e( 'The old Jetpack Stats has been deprecated. Please click the button to enable the new experience.', 'jetpack' ); ?></p>
517 <div class="stats-odyssey-notice--action-bar">
518 <button class="dops-button stats-odyssey-notice--primary-button">
519 <a class="is-primary-link" href="<?php echo esc_url( $redirect_url ); ?>"><?php esc_html_e( 'Switch to new Stats', 'jetpack' ); ?></a>
520 </button>
521 <a class="is-secondary-link" href="<?php echo esc_url( $learn_url ); ?>" rel="noopener noreferrer" target="_blank"><?php esc_html_e( 'Learn about Stats', 'jetpack' ); ?> <svg xmlns="http://www.w3.org/2000/svg" style="vertical-align: middle;" viewBox="0 0 24 24" width="16" height="16" aria-hidden="true" focusable="false"><path d="M18.2 17c0 .7-.6 1.2-1.2 1.2H7c-.7 0-1.2-.6-1.2-1.2V7c0-.7.6-1.2 1.2-1.2h3.2V4.2H7C5.5 4.2 4.2 5.5 4.2 7v10c0 1.5 1.2 2.8 2.8 2.8h10c1.5 0 2.8-1.2 2.8-2.8v-3.6h-1.5V17zM14.9 3v1.5h3.7l-6.4 6.4 1.1 1.1 6.4-6.4v3.7h1.5V3h-6.3z"></path></svg></a>
522 </div>
523 </div>
524 <div class="stats-odyssey-notice--image-container"></div>
525 </div>
526 </div>
527 <p></p>
528 </div>
529 <?php
530 return;
531 }
532
533 $day = isset( $_GET['day'] ) && preg_match( '/^\d{4}-\d{2}-\d{2}$/', $_GET['day'] ) ? $_GET['day'] : false; // phpcs:ignore WordPress.Security.NonceVerification.Recommended, WordPress.Security.ValidatedSanitizedInput
534 $q = array(
535 'noheader' => 'true',
536 'proxy' => '',
537 'page' => 'stats',
538 'day' => $day,
539 'blog' => $blog_id,
540 'charset' => get_option( 'blog_charset' ),
541 'color' => get_user_option( 'admin_color' ),
542 'ssl' => is_ssl(),
543 'j' => sprintf( '%s:%s', JETPACK__API_VERSION, JETPACK__VERSION ),
544 );
545 if ( get_locale() !== 'en_US' ) {
546 $q['jp_lang'] = get_locale();
547 }
548 // Only show the main chart, without extra header data, or metaboxes.
549 $q['main_chart_only'] = $main_chart_only;
550 $args = array(
551 'view' => array( 'referrers', 'postviews', 'searchterms', 'clicks', 'post', 'table' ),
552 'numdays' => 'int',
553 'day' => 'date',
554 'unit' => array( '1', '7', '31', 'human' ),
555 'humanize' => array( 'true' ),
556 'num' => 'int',
557 'summarize' => null,
558 'post' => 'int',
559 'width' => 'int',
560 'height' => 'int',
561 'data' => 'data',
562 'blog_subscribers' => 'int',
563 'comment_subscribers' => null,
564 'type' => array( 'wpcom', 'email', 'pending' ),
565 'pagenum' => 'int',
566 'masterbar' => null,
567 );
568 foreach ( $args as $var => $vals ) {
569 if ( ! isset( $_REQUEST[ $var ] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
570 continue;
571 }
572 $val = wp_unslash( $_REQUEST[ $var ] ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended, WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
573 if ( is_array( $vals ) ) {
574 if ( in_array( $val, $vals, true ) ) {
575 $q[ $var ] = $val;
576 }
577 } elseif ( 'int' === $vals ) {
578 $q[ $var ] = (int) $val;
579 } elseif ( 'date' === $vals ) {
580 if ( preg_match( '/^\d{4}-\d{2}-\d{2}$/', $val ) ) {
581 $q[ $var ] = $val;
582 }
583 } elseif ( null === $vals ) {
584 $q[ $var ] = '';
585 } elseif ( 'data' === $vals ) {
586 if ( str_starts_with( $val, 'index.php' ) ) {
587 $q[ $var ] = $val;
588 }
589 }
590 }
591
592 $url = 'https://' . STATS_DASHBOARD_SERVER . '/wp-admin/index.php';
593 if ( isset( $_GET['chart'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
594 if ( preg_match( '/^[a-z0-9-]+$/', $_GET['chart'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended, WordPress.Security.ValidatedSanitizedInput
595 $chart = sanitize_title( $_GET['chart'] ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended, WordPress.Security.ValidatedSanitizedInput
596 $url = 'https://' . STATS_DASHBOARD_SERVER . "/wp-includes/charts/{$chart}.php";
597 }
598 }
599
600 $url = add_query_arg( $q, $url );
601 $method = 'GET';
602 $timeout = 90;
603 $user_id = 0; // Means use the blog token.
604
605 $get = Client::remote_request( compact( 'url', 'method', 'timeout', 'user_id' ) );
606 $get_code = wp_remote_retrieve_response_code( $get );
607 if ( is_wp_error( $get ) || ( 2 !== (int) ( $get_code / 100 ) && 304 !== $get_code ) || empty( $get['body'] ) ) {
608 stats_print_wp_remote_error( $get, $url );
609 } elseif ( ! empty( $get['headers']['content-type'] ) ) {
610 $type = $get['headers']['content-type'];
611 if ( str_starts_with( $type, 'image' ) ) {
612 $img = $get['body'];
613 header( 'Content-Type: ' . $type );
614 header( 'Content-Length: ' . strlen( $img ) );
615 echo $img; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
616 die();
617 }
618 }
619
620 if ( isset( $_GET['page'] ) && 'stats' === $_GET['page'] && ! isset( $_GET['chart'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
621 $tracking = new Tracking();
622 $tracking->record_user_event( 'wpa_page_view', array( 'path' => 'old_stats' ) );
623 }
624
625 if ( isset( $_GET['noheader'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
626 die;
627 }
628 }
629
630 /**
631 * Stats Convert Image URLs.
632 *
633 * @access public
634 * @param mixed $html HTML.
635 * @return string
636 */
637 function stats_convert_image_urls( $html ) {
638 $url = set_url_scheme( 'https://' . STATS_DASHBOARD_SERVER );
639 $html = preg_replace( '|(["\'])(/i/stats.+)\\1|', '$1' . $url . '$2$1', $html );
640 return $html;
641 }
642
643 /**
644 * Callback for preg_replace_callback used in stats_convert_chart_urls()
645 *
646 * @since 5.6.0
647 *
648 * @param array $matches The matches resulting from the preg_replace_callback call.
649 * @return string The admin url for the chart.
650 */
651 function jetpack_stats_convert_chart_urls_callback( $matches ) {
652 // If there is a query string, change the beginning '?' to a '&' so it fits into the middle of this query string.
653 return 'admin.php?page=stats&noheader&chart=' . $matches[1] . str_replace( '?', '&', $matches[2] );
654 }
655
656 /**
657 * Stats Convert Chart URLs.
658 *
659 * @access public
660 * @param mixed $html HTML.
661 * @return string
662 */
663 function stats_convert_chart_urls( $html ) {
664 $html = preg_replace_callback(
665 '|https?://[-.a-z0-9]+/wp-includes/charts/([-.a-z0-9]+).php(\??)|',
666 'jetpack_stats_convert_chart_urls_callback',
667 $html
668 );
669 return $html;
670 }
671
672 /**
673 * Stats Convert Post Title HTML
674 *
675 * @access public
676 * @param mixed $html HTML.
677 * @return string
678 */
679 function stats_convert_post_titles( $html ) {
680 global $stats_posts;
681 $pattern = "<span class='post-(\d+)-link'>.*?</span>";
682 if ( ! preg_match_all( "!$pattern!", $html, $matches ) ) {
683 return $html;
684 }
685 $posts = get_posts(
686 array(
687 'include' => implode( ',', $matches[1] ),
688 'post_type' => 'any',
689 'post_status' => 'any',
690 'numberposts' => -1,
691 'suppress_filters' => false,
692 )
693 );
694 foreach ( $posts as $post ) {
695 $stats_posts[ $post->ID ] = $post;
696 }
697 $html = preg_replace_callback( "!$pattern!", 'stats_convert_post_title', $html );
698 return $html;
699 }
700
701 /**
702 * Stats Convert Post Title Matches.
703 *
704 * @access public
705 * @param mixed $matches Matches.
706 * @return string
707 */
708 function stats_convert_post_title( $matches ) {
709 global $stats_posts;
710 $post_id = $matches[1];
711 if ( isset( $stats_posts[ $post_id ] ) ) {
712 return '<a href="' . get_permalink( $post_id ) . '" target="_blank">' . get_the_title( $post_id ) . '</a>';
713 }
714 return $matches[0];
715 }
716
717 /**
718 * CSS to hide the tracking pixel smiley.
719 * It is now hidden for everyone (used to be visible if you had set the hide_smile option).
720 *
721 * @access public
722 * @return void
723 */
724 function stats_hide_smile_css() {
725 ?>
726 <style>img#wpstats{display:none}</style>
727 <?php
728 }
729
730 /**
731 * Stats Admin Bar Head.
732 *
733 * @access public
734 * @return void
735 */
736 function stats_admin_bar_head() {
737 // Let's not show the stats admin bar to users who are not logged in.
738 if ( ! is_user_logged_in() ) {
739 return;
740 }
741
742 if ( ! Stats_Options::get_option( 'admin_bar' ) ) {
743 return;
744 }
745
746 if ( ! current_user_can( 'view_stats' ) ) {
747 return;
748 }
749
750 if ( ! is_admin_bar_showing() ) {
751 return;
752 }
753
754 add_action( 'admin_bar_menu', 'stats_admin_bar_menu', 100 );
755 ?>
756
757 <style data-ampdevmode type='text/css'>
758 #wpadminbar .quicklinks li#wp-admin-bar-stats {
759 height: 32px;
760 }
761 #wpadminbar .quicklinks li#wp-admin-bar-stats a {
762 height: 32px;
763 padding: 0;
764 }
765 #wpadminbar .quicklinks li#wp-admin-bar-stats a div {
766 height: 32px;
767 width: 95px;
768 overflow: hidden;
769 margin: 0 10px;
770 }
771 #wpadminbar .quicklinks li#wp-admin-bar-stats a:hover div {
772 width: auto;
773 margin: 0 8px 0 10px;
774 }
775 #wpadminbar .quicklinks li#wp-admin-bar-stats a img {
776 height: 24px;
777 margin: 4px 0;
778 max-width: none;
779 border: none;
780 }
781 </style>
782 <?php
783 }
784
785 /**
786 * Gets the image source of the given stats chart.
787 *
788 * @param string $chart Name of the chart.
789 * @param array $args Extra list of argument to use in the image source.
790 * @return string An image source.
791 */
792 function stats_get_image_chart_src( $chart, $args = array() ) {
793 $url = add_query_arg( 'page', 'stats', admin_url( 'admin.php' ) );
794
795 return add_query_arg(
796 array_merge(
797 array(
798 'noheader' => '',
799 'proxy' => '',
800 'chart' => $chart,
801 ),
802 $args
803 ),
804 $url
805 );
806 }
807
808 /**
809 * Stats AdminBar.
810 *
811 * @access public
812 * @param mixed $wp_admin_bar WPAdminBar.
813 * @return void
814 */
815 function stats_admin_bar_menu( &$wp_admin_bar ) {
816 $img_src = esc_attr( stats_get_image_chart_src( 'admin-bar-hours-scale' ) );
817 $img_src_2x = esc_attr( stats_get_image_chart_src( 'admin-bar-hours-scale-2x' ) );
818 $alt = esc_attr( __( 'Stats', 'jetpack' ) );
819 $title = esc_attr( __( 'Views over 48 hours. Click for more Jetpack Stats.', 'jetpack' ) );
820
821 $menu = array(
822 'id' => 'stats',
823 'href' => add_query_arg( 'page', 'stats', admin_url( 'admin.php' ) ), // no menu_page_url() blog-side.
824 'title' => "<div><img src='$img_src' srcset='$img_src 1x, $img_src_2x 2x' width='112' height='24' alt='$alt' title='$title'></div>",
825 );
826
827 $wp_admin_bar->add_menu( $menu );
828 }
829
830 /**
831 *
832 * Deprecated. The stats module should not update blog details. This is handled by Sync.
833 *
834 * Stats Update Blog.
835 *
836 * @access public
837 * @return void
838 *
839 * @deprecated since 10.3.
840 */
841 function stats_update_blog() {
842 _deprecated_function( __METHOD__, 'jetpack-10.3' );
843 XMLRPC_Async_Call::add_call( 'jetpack.updateBlog', 0, stats_get_blog() );
844 }
845
846 /**
847 * Stats Get Blog.
848 *
849 * @deprecated 11.5
850 *
851 * @access public
852 * @return string
853 */
854 function stats_get_blog() {
855 _deprecated_function( __METHOD__, 'jetpack-11.5' );
856 return Stats_XMLRPC::init()->get_blog();
857 }
858
859 /**
860 * Stats Dashboard Widget Options.
861 *
862 * TODO: This should be moved into class-jetpack-stats-dashboard-widget.php.
863 *
864 * @access public
865 * @return array
866 */
867 function stats_dashboard_widget_options() {
868 $defaults = array(
869 'chart' => 1,
870 'top' => 1,
871 'search' => 7,
872 );
873 $options = get_option( 'stats_dashboard_widget' );
874 if ( ( ! $options ) || ! is_array( $options ) ) {
875 $options = array();
876 }
877
878 // Ignore obsolete option values.
879 $intervals = array( 1, 7, 31, 90, 365 );
880 foreach ( array( 'top', 'search' ) as $key ) {
881 if ( isset( $options[ $key ] ) && ! in_array( (int) $options[ $key ], $intervals, true ) ) {
882 unset( $options[ $key ] );
883 }
884 }
885
886 return array_merge( $defaults, $options );
887 }
888
889 /**
890 * Stats Dashboard Widget Control.
891 *
892 * TODO: This should be moved into class-jetpack-stats-dashboard-widget.php.
893 *
894 * @access public
895 * @return void
896 */
897 function stats_dashboard_widget_control() {
898 stats_dashboard_widget_controls_handle_submission();
899 $periods = array(
900 '1' => __( 'day', 'jetpack' ),
901 '7' => __( 'week', 'jetpack' ),
902 '31' => __( 'month', 'jetpack' ),
903 );
904 $intervals = array(
905 '1' => __( 'the past day', 'jetpack' ),
906 '7' => __( 'the past week', 'jetpack' ),
907 '31' => __( 'the past month', 'jetpack' ),
908 '90' => __( 'the past quarter', 'jetpack' ),
909 '365' => __( 'the past year', 'jetpack' ),
910 );
911 stats_dashboard_widget_controls_html( $intervals, $periods, stats_dashboard_widget_options() );
912 }
913
914 /**
915 * Handle widget controls form submission.
916 *
917 * TODO: This should be moved into class-jetpack-stats-dashboard-widget.php.
918 *
919 * @access public
920 * @return void
921 */
922 function stats_dashboard_widget_controls_handle_submission() {
923 $options = stats_dashboard_widget_options();
924 $defaults = array(
925 'top' => 1,
926 'search' => 7,
927 );
928
929 // Check if the correct form was submitted.
930 if ( isset( $_POST['stats_id'] ) && 'dashboard_stats' === $_POST['stats_id'] ) {
931 // Perform nonce verification.
932 if (
933 isset( $_POST['dashboard-widget-nonce'] ) &&
934 wp_verify_nonce( filter_var( wp_unslash( $_POST['dashboard-widget-nonce'] ) ), 'edit-dashboard-widget_dashboard_stats' )
935 ) {
936 // Update options.
937 $options['chart'] = isset( $_POST['chart'] ) ? (int) $_POST['chart'] : 1;
938 foreach ( array( 'top', 'search' ) as $key ) {
939 $options[ $key ] = isset( $_POST[ $key ] ) ? (int) $_POST[ $key ] : $defaults[ $key ];
940 }
941 update_option( 'stats_dashboard_widget', $options );
942 }
943 }
944 }
945
946 /**
947 * Output HTML for widget controls.
948 *
949 * @param array $intervals Array of intervals.
950 * @param array $periods Array of periods.
951 * @param array $options Array of options.
952 *
953 * TODO: This should be moved into class-jetpack-stats-dashboard-widget.php.
954 *
955 * @access public
956 * @return void
957 */
958 function stats_dashboard_widget_controls_html( $intervals, $periods, $options ) {
959 ?>
960 <p>
961 <label for="chart"><?php esc_html_e( 'Chart stats by', 'jetpack' ); ?></label>
962 <select id="chart" name="chart">
963 <?php
964 foreach ( $periods as $val => $label ) {
965 ?>
966 <option value="<?php echo esc_attr( $val ); ?>"<?php selected( $val, $options['chart'] ); ?>><?php echo esc_html( $label ); ?></option>
967 <?php
968 }
969 ?>
970 </select>.
971 </p>
972
973 <p>
974 <label for="top"><?php esc_html_e( 'Show top posts over', 'jetpack' ); ?></label>
975 <select id="top" name="top">
976 <?php
977 foreach ( $intervals as $val => $label ) {
978 ?>
979 <option value="<?php echo esc_attr( $val ); ?>"<?php selected( $val, $options['top'] ); ?>><?php echo esc_html( $label ); ?></option>
980 <?php
981 }
982 ?>
983 </select>.
984 </p>
985
986 <p>
987 <label for="search"><?php esc_html_e( 'Show top search terms over', 'jetpack' ); ?></label>
988 <select id="search" name="search">
989 <?php
990 foreach ( $intervals as $val => $label ) {
991 ?>
992 <option value="<?php echo esc_attr( $val ); ?>"<?php selected( $val, $options['search'] ); ?>><?php echo esc_html( $label ); ?></option>
993 <?php
994 }
995 ?>
996 </select>.
997 </p>
998 <?php
999 }
1000
1001 /**
1002 * Jetpack Stats Dashboard Widget.
1003 *
1004 * TODO: This should be moved into class-jetpack-stats-dashboard-widget.php.
1005 *
1006 * @access public
1007 * @return void
1008 */
1009 function stats_jetpack_dashboard_widget() {
1010 ?>
1011 <form id="stats_dashboard_widget_control" action="<?php echo esc_url( admin_url() ); ?>" method="post">
1012 <?php stats_dashboard_widget_control(); ?>
1013 <?php wp_nonce_field( 'edit-dashboard-widget_dashboard_stats', 'dashboard-widget-nonce' ); ?>
1014 <input type="hidden" name="stats_id" value="dashboard_stats" />
1015 <?php submit_button( __( 'Submit', 'jetpack' ) ); ?>
1016 </form>
1017 <button type="button" class="handlediv js-toggle-stats_dashboard_widget_control" aria-expanded="true">
1018 <span class="screen-reader-text"><?php esc_html_e( 'Configure', 'jetpack' ); ?></span>
1019 <span class="toggle-indicator" aria-hidden="true"></span>
1020 </button>
1021 <div id="dashboard_stats" class="is-loading">
1022 <div class="inside">
1023 <div style="height: 250px;"></div>
1024 </div>
1025 </div>
1026 <?php
1027 }
1028
1029 /**
1030 * Stats Dashboard Widget Content.
1031 *
1032 * TODO: This should be moved into class-jetpack-stats-dashboard-widget.php.
1033 *
1034 * @access public
1035 * @return never
1036 */
1037 function stats_dashboard_widget_content() {
1038 $width = isset( $_GET['width'] ) ? intval( $_GET['width'] ) / 2 : null; // phpcs:ignore WordPress.Security.NonceVerification.Recommended
1039 $height = isset( $_GET['height'] ) ? intval( $_GET['height'] ) - 36 : null; // phpcs:ignore WordPress.Security.NonceVerification.Recommended
1040 if ( ! $width || $width < 250 ) {
1041 $width = 370;
1042 }
1043 if ( ! $height || $height < 230 ) {
1044 $height = 180;
1045 }
1046
1047 $_width = $width - 5;
1048 $_height = $height - 5;
1049
1050 $options = stats_dashboard_widget_options();
1051 $blog_id = Jetpack_Options::get_option( 'id' );
1052
1053 $q = array(
1054 'noheader' => 'true',
1055 'proxy' => '',
1056 'blog' => $blog_id,
1057 'page' => 'stats',
1058 'chart' => '',
1059 'unit' => $options['chart'],
1060 'color' => get_user_option( 'admin_color' ),
1061 'width' => $_width,
1062 'height' => $_height,
1063 'ssl' => is_ssl(),
1064 'j' => sprintf( '%s:%s', JETPACK__API_VERSION, JETPACK__VERSION ),
1065 );
1066
1067 $url = 'https://' . STATS_DASHBOARD_SERVER . '/wp-admin/index.php';
1068
1069 $url = add_query_arg( $q, $url );
1070 $method = 'GET';
1071 $timeout = 90;
1072 $user_id = 0; // Means use the blog token.
1073
1074 $get = Client::remote_request( compact( 'url', 'method', 'timeout', 'user_id' ) );
1075 $get_code = wp_remote_retrieve_response_code( $get );
1076 if ( is_wp_error( $get ) || ( 2 !== (int) ( $get_code / 100 ) && 304 !== $get_code ) || empty( $get['body'] ) ) {
1077 stats_print_wp_remote_error( $get, $url );
1078 } else {
1079 $body = stats_convert_post_titles( $get['body'] );
1080 $body = stats_convert_chart_urls( $body );
1081 $body = stats_convert_image_urls( $body );
1082 echo $body; // phpcs:ignore WordPress.Security.EscapeOutput
1083 }
1084
1085 $post_ids = array();
1086
1087 $csv_end_date = current_time( 'Y-m-d' );
1088 $csv_args = array(
1089 'top' => "&limit=6&end=$csv_end_date",
1090 'search' => "&limit=5&end=$csv_end_date",
1091 );
1092
1093 $top_posts = stats_get_csv( 'postviews', "days=$options[top]$csv_args[top]" );
1094 foreach ( $top_posts as $i => $post ) {
1095 if ( 0 === $post['post_id'] ) {
1096 unset( $top_posts[ $i ] );
1097 continue;
1098 }
1099 $post_ids[] = $post['post_id'];
1100 }
1101
1102 // Cache.
1103 get_posts( array( 'include' => implode( ',', array_unique( $post_ids ) ) ) );
1104
1105 $searches = array();
1106 $search_terms = stats_get_csv( 'searchterms', "days=$options[search]$csv_args[search]" );
1107 foreach ( $search_terms as $search_term ) {
1108 if ( 'encrypted_search_terms' === $search_term['searchterm'] ) {
1109 continue;
1110 }
1111 $searches[] = esc_html( $search_term['searchterm'] );
1112 }
1113
1114 ?>
1115 <div id="stats-info">
1116 <div id="stats-info-container">
1117 <div class="stats-info-header">
1118 <h2><?php esc_html_e( 'Highlights', 'jetpack' ); ?></h2>
1119 <div class="stats-info-header-right">
1120 <a href="<?php echo esc_url( admin_url( 'admin.php?page=stats' ) ); ?>" class="button button-primary">
1121 <?php esc_html_e( 'View detailed stats', 'jetpack' ); ?>
1122 </a>
1123 </div>
1124 </div>
1125 <div class="stats-info-content">
1126 <div id="top-posts" class="stats-section">
1127 <div class="stats-section-inner">
1128 <h3 class="heading"><?php esc_html_e( 'Top Posts', 'jetpack' ); ?></h3>
1129 <?php
1130 if ( empty( $top_posts ) ) {
1131 ?>
1132 <p class="nothing"><?php esc_html_e( 'Sorry, nothing to report.', 'jetpack' ); ?></p>
1133 <?php
1134 } else {
1135 foreach ( $top_posts as $post ) {
1136 if ( ! get_post( $post['post_id'] ) ) {
1137 continue;
1138 }
1139 ?>
1140 <p>
1141 <?php
1142 printf(
1143 esc_html(
1144 /* Translators: Stats dashboard widget Post list with view count: "Post Title 1 View (or Views if plural)". */
1145 _n( '%1$s %2$s View', '%1$s %2$s Views', $post['views'], 'jetpack' )
1146 ),
1147 '<a href="' . esc_url( get_permalink( $post['post_id'] ) ) . '">' . esc_html( get_the_title( $post['post_id'] ) ) . '</a>',
1148 esc_html( number_format_i18n( $post['views'] ) )
1149 );
1150 ?>
1151 </p>
1152 <?php
1153 }
1154 }
1155 ?>
1156 </div>
1157 </div>
1158 <div id="top-search" class="stats-section">
1159 <div class="stats-section-inner">
1160 <h3 class="heading"><?php esc_html_e( 'Top Searches', 'jetpack' ); ?></h3>
1161 <?php
1162 if ( empty( $searches ) ) {
1163 ?>
1164 <p class="nothing"><?php esc_html_e( 'Sorry, nothing to report.', 'jetpack' ); ?></p>
1165 <?php
1166 } else {
1167 foreach ( $searches as $search_term_item ) {
1168 printf(
1169 '<p>%s</p>',
1170 esc_html( $search_term_item )
1171 );
1172 }
1173 }
1174 ?>
1175 </div>
1176 </div>
1177 </div>
1178 </div>
1179 </div>
1180 <?php
1181 exit;
1182 }
1183
1184 /**
1185 * Stats Print WP Remote Error.
1186 *
1187 * @access public
1188 * @param mixed $get Get.
1189 * @param mixed $url URL.
1190 * @return void
1191 */
1192 function stats_print_wp_remote_error( $get, $url ) {
1193 $state_name = 'stats_remote_error_' . substr( md5( $url ), 0, 8 );
1194 $previous_error = Jetpack::state( $state_name );
1195 $error = md5( wp_json_encode( compact( 'get', 'url' ) ) );
1196 Jetpack::state( $state_name, $error );
1197 if ( $error !== $previous_error ) {
1198 ?>
1199 <div class="wrap">
1200 <p><?php esc_html_e( 'We were unable to get your stats just now. Please reload this page to try again.', 'jetpack' ); ?></p>
1201 </div>
1202 <?php
1203 return;
1204 }
1205 ?>
1206 <div class="wrap">
1207 <p>
1208 <?php
1209 printf(
1210 /* translators: placeholder is an a href for a support site. */
1211 esc_html__( 'We were unable to get your stats just now. Please reload this page to try again. If this error persists, please contact %1$s. In your report, please include the information below.', 'jetpack' ),
1212 sprintf(
1213 '<a href="https://support.wordpress.com/contact/?jetpack=needs-service">%s</a>',
1214 esc_html__( 'Jetpack Support', 'jetpack' )
1215 )
1216 );
1217 ?>
1218 </p>
1219 <pre class="stats-widget-error">
1220 User Agent: "<?php echo isset( $_SERVER['HTTP_USER_AGENT'] ) ? esc_html( wp_unslash( $_SERVER['HTTP_USER_AGENT'] ) ) : ''; // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized ?>"
1221 Page URL: "http<?php echo ( is_ssl() ? 's' : '' ) . '://' . esc_html( ( isset( $_SERVER['HTTP_HOST'] ) ? wp_unslash( $_SERVER['HTTP_HOST'] ) : '' ) . ( isset( $_SERVER['REQUEST_URI'] ) ? wp_unslash( $_SERVER['REQUEST_URI'] ) : '' ) ); // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized ?>"
1222 API URL: "<?php echo esc_url( $url ); ?>"
1223 <?php
1224 if ( is_wp_error( $get ) ) {
1225 foreach ( $get->get_error_codes() as $code ) {
1226 foreach ( $get->get_error_messages( $code ) as $message ) {
1227 print esc_html( $code ) . ': "' . esc_html( $message ) . '"';
1228 }
1229 }
1230 } else {
1231 $get_code = wp_remote_retrieve_response_code( $get );
1232 $content_length = strlen( wp_remote_retrieve_body( $get ) );
1233 ?>
1234 Response code: "<?php print esc_html( $get_code ); ?>"
1235 Content length: "<?php print esc_html( $content_length ); ?>"
1236 <?php
1237 }
1238 ?>
1239 </pre>
1240 </div>
1241 <?php
1242 }
1243
1244 /**
1245 * Get stats from WordPress.com
1246 *
1247 * @param string $table The stats which you want to retrieve: postviews, or searchterms.
1248 * @param array $args {
1249 * An associative array of arguments.
1250 *
1251 * @type bool $end The last day of the desired time frame. Format is 'Y-m-d' (e.g. 2007-05-01)
1252 * and default timezone is UTC date. Default value is Now.
1253 * @type string $days The length of the desired time frame. Default is 30. Maximum 90 days.
1254 * @type int $limit The maximum number of records to return. Default is 10. Maximum 100.
1255 * @type int $post_id The ID of the post to retrieve stats data for
1256 * @type string $summarize If present, summarizes all matching records. Default Null.
1257 * @type int $blog_id The WordPress.com blog ID to retrieve stats data for. Default is the current blog.
1258 *
1259 * }
1260 *
1261 * @return array {
1262 * An array of post view data, each post as an array
1263 *
1264 * array {
1265 * The post view data for a single post
1266 *
1267 * @type string $post_id The ID of the post
1268 * @type string $post_title The title of the post
1269 * @type string $post_permalink The permalink for the post
1270 * @type string $views The number of views for the post within the $num_days specified
1271 * }
1272 * }
1273 */
1274 function stats_get_csv( $table, $args = null ) {
1275 $defaults = array(
1276 'end' => false,
1277 'days' => false,
1278 'limit' => 3,
1279 'post_id' => false,
1280 'summarize' => '',
1281 'blog_id' => Jetpack_Options::get_option( 'id' ),
1282 );
1283
1284 $args = wp_parse_args( $args, $defaults );
1285 $args['table'] = $table;
1286
1287 $stats_csv_url = add_query_arg( $args, 'https://stats.wordpress.com/csv.php' );
1288
1289 $key = md5( $stats_csv_url );
1290
1291 // Get cache.
1292 $stats_cache = get_option( 'stats_cache' );
1293 if ( ! $stats_cache || ! is_array( $stats_cache ) ) {
1294 $stats_cache = array();
1295 }
1296
1297 // Return or expire this key.
1298 if ( isset( $stats_cache[ $key ] ) ) {
1299 $time = key( $stats_cache[ $key ] );
1300 if ( time() - $time < 300 ) {
1301 return $stats_cache[ $key ][ $time ];
1302 }
1303 unset( $stats_cache[ $key ] );
1304 }
1305
1306 $stats_rows = array();
1307 do {
1308 $stats = stats_get_remote_csv( $stats_csv_url );
1309 if ( ! $stats ) {
1310 break;
1311 }
1312
1313 $labels = array_shift( $stats );
1314
1315 if ( 0 === stripos( $labels[0], 'error' ) ) {
1316 break;
1317 }
1318
1319 $stats_rows = array();
1320 for ( $s = 0; isset( $stats[ $s ] ); $s++ ) {
1321 $row = array();
1322 foreach ( $labels as $col => $label ) {
1323 $row[ $label ] = $stats[ $s ][ $col ];
1324 }
1325 $stats_rows[] = $row;
1326 }
1327 } while ( 0 );
1328
1329 // Expire old keys.
1330 foreach ( $stats_cache as $k => $cache ) {
1331 if ( ! is_array( $cache ) || 300 < time() - key( $cache ) ) {
1332 unset( $stats_cache[ $k ] );
1333 }
1334 }
1335
1336 // Set cache.
1337 $stats_cache[ $key ] = array( time() => $stats_rows );
1338 update_option( 'stats_cache', $stats_cache );
1339
1340 return $stats_rows;
1341 }
1342
1343 /**
1344 * Stats get remote CSV.
1345 *
1346 * @access public
1347 * @param mixed $url URL.
1348 * @return array
1349 */
1350 function stats_get_remote_csv( $url ) {
1351 $method = 'GET';
1352 $timeout = 90;
1353 $user_id = 0; // Blog token.
1354
1355 $get = Client::remote_request( compact( 'url', 'method', 'timeout', 'user_id' ) );
1356 $get_code = wp_remote_retrieve_response_code( $get );
1357 if ( is_wp_error( $get ) || ( 2 !== (int) ( $get_code / 100 ) && 304 !== $get_code ) || empty( $get['body'] ) ) {
1358 return array(); // @todo: return an error?
1359 } else {
1360 return stats_str_getcsv( $get['body'] );
1361 }
1362 }
1363
1364 /**
1365 * Recursively run str_getcsv on the stats csv.
1366 *
1367 * @since 9.7.0 Remove custom handling since str_getcsv is available on all servers running this now.
1368 *
1369 * @param mixed $csv CSV.
1370 * @return array
1371 */
1372 function stats_str_getcsv( $csv ) {
1373 // @todo Correctly handle embedded newlines. Note, despite claims online, `str_getcsv( $csv, "\n" )` does not actually work.
1374 $lines = explode( "\n", rtrim( $csv, "\n" ) );
1375 return array_map(
1376 function ( $line ) {
1377 // @todo When we drop support for PHP <7.4, consider passing empty-string for `$escape` here for better spec compatibility.
1378 return str_getcsv( $line, ',', '"', '\\' );
1379 },
1380 $lines
1381 );
1382 }
1383
1384 /**
1385 * Abstract out building the rest api stats path.
1386 *
1387 * @param string $resource Resource.
1388 * @return string
1389 */
1390 function jetpack_stats_api_path( $resource = '' ) {
1391 $resource = ltrim( $resource, '/' );
1392 return sprintf( '/sites/%d/stats/%s', Stats_Options::get_option( 'blog_id' ), $resource );
1393 }
1394
1395 /**
1396 * Fetches stats data from the REST API. Caches locally for 5 minutes.
1397 *
1398 * @link: https://developer.wordpress.com/docs/api/1.1/get/sites/%24site/stats/
1399 * @access public
1400 * @deprecated 11.5 Use WPCOM_Stats available methodsinstead.
1401 * @param array $args (default: array()) The args that are passed to the endpoint.
1402 * @param string $resource (default: '') Optional sub-endpoint following /stats/.
1403 * @return array|WP_Error
1404 */
1405 function stats_get_from_restapi( $args = array(), $resource = '' ) {
1406 _deprecated_function( __METHOD__, 'jetpack-11.5', 'Please checkout the methods available in Automattic\Jetpack\Stats\WPCOM_Stats' );
1407 $endpoint = jetpack_stats_api_path( $resource );
1408 $api_version = '1.1';
1409 $args = wp_parse_args( $args, array() );
1410 $cache_key = md5( implode( '|', array( $endpoint, $api_version, wp_json_encode( $args ) ) ) );
1411
1412 $transient_name = "jetpack_restapi_stats_cache_{$cache_key}";
1413
1414 $stats_cache = get_transient( $transient_name );
1415
1416 // Return or expire this key.
1417 if ( $stats_cache ) {
1418 $time = key( $stats_cache );
1419 $data = $stats_cache[ $time ]; // WP_Error or string (JSON encoded object).
1420
1421 if ( is_wp_error( $data ) ) {
1422 return $data;
1423 }
1424
1425 return (object) array_merge( array( 'cached_at' => $time ), (array) json_decode( $data ) );
1426 }
1427
1428 // Do the dirty work.
1429 $response = Client::wpcom_json_api_request_as_blog( $endpoint, $api_version, $args );
1430 if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
1431 // WP_Error.
1432 $data = is_wp_error( $response ) ? $response : new WP_Error( 'stats_error' );
1433 // WP_Error.
1434 $return = $data;
1435 } else {
1436 // string (JSON encoded object).
1437 $data = wp_remote_retrieve_body( $response );
1438 // object (rare: null on JSON failure).
1439 $return = json_decode( $data );
1440 }
1441
1442 // To reduce size in storage: store with time as key, store JSON encoded data (unless error).
1443 set_transient( $transient_name, array( time() => $data ), 5 * MINUTE_IN_SECONDS );
1444
1445 return $return;
1446 }
1447
1448 /**
1449 * Load CSS needed for Stats column width in WP-Admin area.
1450 *
1451 * @since 4.7.0
1452 */
1453 function jetpack_stats_load_admin_css() {
1454 ?>
1455 <style type="text/css">
1456 .fixed .column-stats {
1457 width: 5em;
1458 }
1459 </style>
1460 <?php
1461 }
1462
1463 /**
1464 * Set header for column that allows to view an entry's stats.
1465 *
1466 * @param array $columns An array of column names.
1467 *
1468 * @since 4.7.0
1469 *
1470 * @return mixed
1471 */
1472 function jetpack_stats_post_table( $columns ) {
1473 /*
1474 * Stats can be accessed in wp-admin or in Calypso,
1475 * depending on what version of the stats screen is enabled on your site.
1476 *
1477 * In both cases, the user must be allowed to access stats.
1478 *
1479 * If the Odyssey Stats experience isn't enabled, the user will need to go to Calypso,
1480 * so they need to be connected to WordPress.com to be able to access that page.
1481 */
1482 if (
1483 ! current_user_can( 'view_stats' )
1484 || (
1485 ! Stats_Options::get_option( 'enable_odyssey_stats' )
1486 && ! ( new Connection_Manager( 'jetpack' ) )->is_user_connected()
1487 )
1488 ) {
1489 return $columns;
1490 }
1491
1492 // Array-Fu to add before comments.
1493 $pos = array_search( 'comments', array_keys( $columns ), true );
1494
1495 // Fallback to the last position if the post type does not support comments.
1496 if ( ! is_int( $pos ) ) {
1497 $pos = count( $columns );
1498 }
1499
1500 // Final fallback, if the array was malformed by another plugin for example.
1501 if ( ! is_int( $pos ) ) {
1502 return $columns;
1503 }
1504
1505 $chunks = array_chunk( $columns, $pos, true );
1506 $chunks[0]['stats'] = esc_html__( 'Stats', 'jetpack' );
1507
1508 return call_user_func_array( 'array_merge', $chunks );
1509 }
1510
1511 /**
1512 * Set content for cell with link to an entry's stats in Odyssey Stats.
1513 *
1514 * @param string $column The name of the column to display.
1515 * @param int $post_id The current post ID.
1516 *
1517 * @since 4.7.0
1518 *
1519 * @return mixed
1520 */
1521 function jetpack_stats_post_table_cell( $column, $post_id ) {
1522 if ( 'stats' === $column ) {
1523 if ( 'publish' !== get_post_status( $post_id ) ) {
1524 printf(
1525 '<span aria-hidden="true">—</span><span class="screen-reader-text">%s</span>',
1526 esc_html__( 'No stats', 'jetpack' )
1527 );
1528 } else {
1529 // Link to the wp-admin stats page.
1530 $stats_post_url = admin_url( sprintf( 'admin.php?page=stats#!/stats/post/%d/%d', $post_id, Jetpack_Options::get_option( 'id', 0 ) ) );
1531 // Unless the user is on a Default style WOA site, in which case link to Calypso.
1532 if ( ( new Host() )->is_woa_site() && Stats_Options::get_option( 'enable_odyssey_stats' ) && 'wp-admin' !== get_option( 'wpcom_admin_interface' ) ) {
1533 $stats_post_url = Redirect::get_url(
1534 'calypso-stats-post',
1535 array(
1536 'path' => $post_id,
1537 )
1538 );
1539 }
1540
1541 printf(
1542 '<a href="%s" title="%s" class="dashicons dashicons-chart-bar" target="_blank"></a>',
1543 esc_url( $stats_post_url ),
1544 esc_html__( 'View stats for this post', 'jetpack' )
1545 );
1546 }
1547 }
1548 }
1549
1550 /**
1551 * Add the Jetpack plugin version to the stats tracking data.
1552 *
1553 * @param array $kvs The stats array in key values.
1554 * @return array
1555 */
1556 function filter_stats_array_add_jp_version( $kvs ) {
1557 $kvs['j'] = sprintf( '%s:%s', JETPACK__API_VERSION, JETPACK__VERSION );
1558
1559 return $kvs;
1560 }
1561
1562 /**
1563 * Convert stats array to object after sanity checking the array is valid.
1564 *
1565 * @param array $stats_array The stats array.
1566 * @return WP_Error|Object|null
1567 */
1568 function convert_stats_array_to_object( $stats_array ) {
1569 _deprecated_function( __FUNCTION__, 'jetpack-13.2', 'Automattic\Jetpack\Stats\WPCOM_Stats->convert_stats_array_to_object' );
1570
1571 return ( new WPCOM_Stats() )->convert_stats_array_to_object( $stats_array );
1572 }
1573