Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
97.97%
145 / 148
75.00%
9 / 12
 CRAP
0.00%
0 / 1
Tracking_Pixel
97.97%
145 / 148
75.00%
9 / 12
 63
0.00%
0 / 1
 build_view_data
100.00%
50 / 50
100.00%
1 / 1
 22
 build_search_filters
95.45%
21 / 22
0.00%
0 / 1
 11
 build_stats_details
100.00%
11 / 11
100.00%
1 / 1
 2
 build_consent_gate
100.00%
5 / 5
100.00%
1 / 1
 1
 add_low_fetchpriority
100.00%
3 / 3
100.00%
1 / 1
 3
 remove_stats_dns_prefetch
94.44%
17 / 18
0.00%
0 / 1
 9.01
 enqueue_stats_script
95.45%
21 / 22
0.00%
0 / 1
 2
 get_amp_pixel_url
100.00%
6 / 6
100.00%
1 / 1
 2
 add_amp_pixel
100.00%
4 / 4
100.00%
1 / 1
 2
 add_to_footer
n/a
0 / 0
n/a
0 / 0
 1
 get_footer_to_add
n/a
0 / 0
n/a
0 / 0
 1
 render_footer
n/a
0 / 0
n/a
0 / 0
 1
 render_amp_footer
100.00%
1 / 1
100.00%
1 / 1
 1
 stats_array_to_string
100.00%
3 / 3
100.00%
1 / 1
 1
 is_amp_request
100.00%
3 / 3
100.00%
1 / 1
 4
1<?php
2/**
3 * Stats Tracking_Pixel
4 *
5 * @package automattic/jetpack-stats
6 */
7
8namespace Automattic\Jetpack\Stats;
9
10use Jetpack_Options;
11use WP_Post;
12
13/**
14 * Stats Tracking_Pixel class.
15 *
16 * Responsible for embedding the Stats tracking pixel.
17 *
18 * @since 0.1.0
19 */
20class Tracking_Pixel {
21
22    /**
23     * Array name.
24     *
25     * @var string $array_name The 'stats' array name
26     */
27    const STATS_ARRAY_TO_STRING_FILTER = 'stats_array';
28
29    const TRACKED_UTM_PARAMETERS = array(
30        'utm_id',
31        'utm_source',
32        'utm_medium',
33        'utm_campaign',
34        'utm_term',
35        'utm_content',
36        'utm_source_platform',
37        'utm_creative_format',
38        'utm_marketing_tactic',
39    );
40
41    /**
42     * Stats Build View Data.
43     *
44     * @access public
45     * @return array
46     */
47    public static function build_view_data() {
48        global $wp_the_query;
49
50        $blog        = Jetpack_Options::get_option( 'id' );
51        $tz          = get_option( 'gmt_offset' );
52        $v           = 'ext';
53        $blog_url    = wp_parse_url( site_url() );
54        $srv         = $blog_url['host'];
55        $is_not_post = false;
56        if ( $wp_the_query->is_single || $wp_the_query->is_page || $wp_the_query->is_posts_page ) {
57            // Store and reset the queried_object and queried_object_id
58            // Otherwise, redirect_canonical() will redirect to home_url( '/' ) for show_on_front = page sites where home_url() is not all lowercase.
59            // Repro:
60            // 1. Set home_url = https://ExamPle.com/
61            // 2. Set show_on_front = page
62            // 3. Set page_on_front = something
63            // 4. Visit https://example.com/ !
64            $queried_object    = $wp_the_query->queried_object ?? null;
65            $queried_object_id = $wp_the_query->queried_object_id ?? null;
66            try {
67                $post_obj = $wp_the_query->get_queried_object();
68                $post     = $post_obj instanceof WP_Post ? $post_obj->ID : '0';
69            } finally {
70                $wp_the_query->queried_object    = $queried_object;
71                $wp_the_query->queried_object_id = $queried_object_id;
72            }
73        } else {
74            $post        = '0';
75            $is_not_post = true;
76        }
77        $view_data = compact( 'v', 'blog', 'post', 'tz', 'srv' );
78        // Batcache removes some of the UTM params from $_GET, we need to extract them from uri directly instead.
79        // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- We're sanitizing individual params in the loop.
80        $url_query = wp_parse_url( wp_unslash( $_SERVER['REQUEST_URI'] ?? '' ), PHP_URL_QUERY );
81        parse_str( (string) $url_query, $url_params );
82        foreach ( self::TRACKED_UTM_PARAMETERS as $utm_parameter ) {
83            if ( isset( $url_params[ $utm_parameter ] ) && is_scalar( $url_params[ $utm_parameter ] ) ) {
84                $view_data[ $utm_parameter ] = substr( sanitize_textarea_field( wp_unslash( $url_params[ $utm_parameter ] ) ), 0, 255 );
85            }
86        }
87
88        if ( $is_not_post ) {
89            if ( $wp_the_query->is_home() ) {
90                $view_data['arch_home'] = '1';
91            } elseif ( $wp_the_query->is_search() ) {
92                $search_term               = $wp_the_query->query['s'] ?? $wp_the_query->query_vars['s'] ?? '';
93                $view_data['arch_search']  = sanitize_text_field( $search_term );
94                $view_data['arch_filters'] = sanitize_text_field( self::build_search_filters( $wp_the_query ) );
95                $view_data['arch_results'] = $wp_the_query->posts ? $wp_the_query->post_count : 0;
96            } elseif ( $wp_the_query->is_archive() ) {
97                if ( $wp_the_query->is_date ) {
98                    $query                  = $wp_the_query->query;
99                    $date_parts             = array_filter( array( $query['year'] ?? null, $query['monthnum'] ?? null, $query['day'] ?? null ) );
100                    $date                   = implode( '/', $date_parts );
101                    $view_data['arch_date'] = $date;
102                }
103                if ( $wp_the_query->is_category ) {
104                    $view_data['arch_cat'] = $wp_the_query->query['category_name'] ?? $wp_the_query->query_vars['category_name'] ?? '';
105                }
106                if ( $wp_the_query->is_tag ) {
107                    $view_data['arch_tag'] = $wp_the_query->query['tag'] ?? $wp_the_query->query_vars['tag'] ?? '';
108                }
109                if ( $wp_the_query->is_author ) {
110                    $view_data['arch_author'] = $wp_the_query->query['author_name'] ?? '';
111                }
112                if ( $wp_the_query->is_tax ) {
113                    $query = $wp_the_query->query;
114                    if ( is_array( $query ) && count( $query ) === 1 ) {
115                        $view_data[ 'arch_tax_' . array_keys( $query )[0] ] = array_values( $query )[0];
116                    }
117                }
118                $view_data['arch_results'] = $wp_the_query->posts ? $wp_the_query->post_count : 0;
119            } elseif ( $wp_the_query->is_404() ) {
120                $view_data['arch_err'] = sanitize_text_field( wp_unslash( $_SERVER['REQUEST_URI'] ?? '' ) );
121            } else {
122                $view_data['arch_other'] = sanitize_text_field( wp_unslash( $_SERVER['REQUEST_URI'] ?? '' ) );
123            }
124        }
125        return $view_data;
126    }
127
128    /**
129     * Collect the tracking data for a search page.
130     *
131     * @access private
132     * @param  \WP_Query $query The WP_Query object to parse all the filters from.
133     * @return string The search filters in a URL query string format.
134     */
135    private static function build_search_filters( $query ) {
136        $data = array(
137            'posts_per_page' => $query->get( 'posts_per_page' ),
138            'paged'          => ( $query->get( 'paged' ) ) ? absint( $query->get( 'paged' ) ) : 1,
139            'orderby'        => $query->get( 'orderby' ),
140            'order'          => $query->get( 'order' ),
141        );
142
143        if ( $query->get( 'author_name' ) ) {
144            $data['author_name'] = $query->get( 'author_name' );
145        }
146        $filters = http_build_query( $data );
147
148        $the_tax_query = $query->tax_query;
149        $terms         = array();
150        if ( ! empty( $the_tax_query->queried_terms ) && is_array( $the_tax_query->queried_terms ) ) {
151            foreach ( $the_tax_query->queries as $tax_query ) {
152                if ( ! is_array( $tax_query ) || ! isset( $tax_query['taxonomy'] ) ) {
153                    continue;
154                }
155                $taxonomy = $tax_query['taxonomy'];
156                if ( ! isset( $terms[ $taxonomy ] ) || ! is_array( $terms[ $taxonomy ] ) ) {
157                    $terms[ $taxonomy ] = array();
158                }
159                $terms[ $taxonomy ] = array_merge( $terms[ $taxonomy ], $tax_query['terms'] );
160            }
161        }
162        if ( ! empty( $terms ) ) {
163            $filters .= '&terms=' . wp_json_encode( $terms, JSON_UNESCAPED_SLASHES | JSON_HEX_TAG | JSON_HEX_AMP );
164        }
165        return $filters;
166    }
167
168    /**
169     * Build the Stats tracking details.
170     *
171     * @since 0.6.0
172     *
173     * @access private
174     * @param array $data Array of options about the site and page for the inline (non-AMP) tracker.
175     * @return string
176     */
177    private static function build_stats_details( $data ) {
178        $data_stats_array = self::stats_array_to_string( $data );
179
180        $pushes = sprintf(
181            '_stq.push([ "view", %1$s ]);
182_stq.push([ "clickTrackerInit", "%2$s", "%3$s" ]);',
183            $data_stats_array,
184            $data['blog'],
185            $data['post']
186        );
187
188        // Without the WP Consent API plugin there is no consent to honor, so the output stays byte-for-byte historical.
189        if ( ! function_exists( 'wp_has_consent' ) ) {
190            return "_stq = window._stq || [];\n" . $pushes;
191        }
192
193        return self::build_consent_gate( $pushes );
194    }
195
196    /**
197     * Wrap the tracking pushes in a WP Consent API gate, checked in the browser because cached HTML is shared across visitors.
198     *
199     * `_jpStatsFire.done` is set before the pushes so a push that throws is never replayed: the
200     * sender assigns the beacon `src` first, so that view was already counted.
201     *
202     * @access private
203     * @param string $pushes The `_stq.push(...)` statements to gate.
204     * @return string
205     */
206    private static function build_consent_gate( $pushes ) {
207        // A stored deny wins: without a consent type, which some banners set only on the first visit, wp_has_consent() ignores it.
208        // Under waitfor_consent_hook the banner sets the type later, and until then wp_has_consent() reads a fallback that can allow.
209        return sprintf(
210            '_stq = window._stq || [];
211function _jpStatsFire() {
212    if ( _jpStatsFire.done ) { return; }
213    _jpStatsFire.done = true;
214    %1$s
215}
216function _jpStatsDenied() {
217    return typeof window.consent_api_get_cookie === "function" && !! window.consent_api &&
218        window.consent_api_get_cookie( window.consent_api.cookie_prefix + "_statistics" ) === "deny";
219}
220function _jpStatsCheck() {
221    if ( typeof window.wp_has_consent !== "function" ) { return; }
222    if ( window.waitfor_consent_hook && typeof window.wp_consent_type === "undefined" ) { return; }
223    var consented;
224    try {
225        consented = ! _jpStatsDenied() && window.wp_has_consent( "statistics" );
226    } catch ( e ) {
227        window.console && console.warn( "Jetpack Stats: wp_has_consent() threw, so Stats waits for a consent change.", e );
228        return;
229    }
230    if ( consented ) { _jpStatsFire(); }
231}
232document.addEventListener( "wp_listen_for_consent_change", function ( event ) {
233    if ( event && event.detail && event.detail.statistics === "allow" ) { _jpStatsFire(); }
234} );
235document.addEventListener( "wp_consent_type_defined", _jpStatsCheck );
236window.addEventListener( "wp_consent_type_defined", _jpStatsCheck );
237window.addEventListener( "load", function () {
238    if ( typeof window.wp_has_consent !== "function" ) {
239        window.console && console.warn( "Jetpack Stats: the WP Consent API script has not loaded, so Stats waits for a consent change." );
240    }
241    _jpStatsCheck();
242}, { once: true } );
243if ( document.readyState === "loading" ) {
244    document.addEventListener( "DOMContentLoaded", _jpStatsCheck, { once: true } );
245} else {
246    _jpStatsCheck();
247}',
248            $pushes
249        );
250    }
251
252    /**
253     * Add fetchpriority="low" to the Stats script attributes.
254     *
255     * Reduces network contention with resources in the critical rendering path (e.g., the LCP
256     * element image). This benefits Safari and Firefox, which don't automatically assign low
257     * priority to async/defer scripts (unlike Chrome).
258     *
259     * @since 0.19.5
260     *
261     * @param array $attributes Script tag attributes.
262     * @return array Modified attributes.
263     */
264    public static function add_low_fetchpriority( $attributes ) {
265        // WordPress derives the tag id from the enqueue handle as "{handle}-js", so the
266        // 'jetpack-stats' script (registered in enqueue_stats_script()) prints as
267        // 'jetpack-stats-js'. Keep this in sync if the handle is ever renamed.
268        if ( isset( $attributes['id'] ) && 'jetpack-stats-js' === $attributes['id'] ) {
269            $attributes['fetchpriority'] = 'low';
270        }
271        return $attributes;
272    }
273
274    /**
275     * Remove the dns-prefetch resource hint for stats.wp.com.
276     *
277     * WordPress automatically adds dns-prefetch hints for enqueued script hosts via
278     * wp_dependencies_unique_hosts(). Since we're deprioritizing the stats script,
279     * the dns-prefetch is counterproductive — it front-loads DNS resolution for a
280     * resource we're intentionally delaying.
281     *
282     * @since 0.19.5
283     *
284     * @param array  $urls          Array of resource hint URLs.
285     * @param string $relation_type The relation type (dns-prefetch, preconnect, etc.).
286     * @return array Filtered URLs.
287     */
288    public static function remove_stats_dns_prefetch( $urls, $relation_type ) {
289        if ( 'dns-prefetch' !== $relation_type ) {
290            return $urls;
291        }
292
293        return array_filter(
294            $urls,
295            static function ( $url ) {
296                // Resource hints can be arrays that carry the URL under an 'href' key.
297                if ( is_array( $url ) ) {
298                    $candidate = ( isset( $url['href'] ) && is_string( $url['href'] ) ) ? $url['href'] : '';
299                } elseif ( is_string( $url ) ) {
300                    $candidate = $url;
301                } else {
302                    return true; // Unknown entry shape; leave it untouched.
303                }
304
305                // dns-prefetch entries arrive in several shapes: WordPress core emits bare
306                // hosts ('stats.wp.com') via wp_dependencies_unique_hosts(), while other
307                // filters may add scheme-relative ('//stats.wp.com') or full URLs. Normalize
308                // each to a host so we drop stats.wp.com exactly without removing look-alike
309                // hosts such as 'mystats.wp.com' or 'stats.wp.com.evil.tld'.
310                if ( str_starts_with( $candidate, '//' ) ) {
311                    $host = wp_parse_url( 'https:' . $candidate, PHP_URL_HOST );
312                } elseif ( str_contains( $candidate, '://' ) ) {
313                    $host = wp_parse_url( $candidate, PHP_URL_HOST );
314                } else {
315                    $host = $candidate; // Bare host form, e.g. 'stats.wp.com'.
316                }
317
318                return ! is_string( $host ) || 'stats.wp.com' !== strtolower( $host );
319            }
320        );
321    }
322
323    /**
324     * Enqueue the Stats pixel.
325     * Do not use this function directly, it is hooked into `wp_enqueue_scripts`.
326     *
327     * @access public
328     * @return void
329     */
330    public static function enqueue_stats_script() {
331        if ( self::is_amp_request() ) {
332            return;
333        }
334
335        wp_enqueue_script(
336            'jetpack-stats',
337            'https://stats.wp.com/e-' . gmdate( 'YW' ) . '.js',
338            array(),
339            null, // phpcs:ignore WordPress.WP.EnqueuedResourceParameters.MissingVersion -- The version is set in the URL.
340            array(
341                'in_footer' => true,
342                'strategy'  => 'defer',
343            )
344        );
345        add_filter( 'wp_script_attributes', array( static::class, 'add_low_fetchpriority' ) );
346        add_filter( 'wp_resource_hints', array( static::class, 'remove_stats_dns_prefetch' ), 100, 2 );
347
348        $data = self::build_view_data();
349
350        /**
351         * Filter the parameters added to the JavaScript stats tracking code.
352         *
353         * @module stats
354         *
355         * @since-jetpack 10.9
356         *
357         * @param array $data Array of options about the site and page you're on.
358         */
359        $data = (array) apply_filters( 'jetpack_stats_footer_js_data', $data );
360
361        $triggers = self::build_stats_details( $data );
362        wp_add_inline_script(
363            'jetpack-stats',
364            $triggers,
365            'before'
366        );
367    }
368
369    /**
370     * Gets the tracking pixel URL for AMP output.
371     *
372     * @access private
373     * @param array $data Array of data for the AMP pixel tracker.
374     * @return string Returns the URL for the Stats tracker in an AMP scenario.
375     */
376    private static function get_amp_pixel_url( $data ) {
377        /**
378         * Filter the parameters added to the AMP pixel tracking code.
379         *
380         * @module stats
381         *
382         * @since-jetpack 10.9
383         *
384         * @param array $data Array of options about the site and page you're on.
385         */
386        $data = (array) apply_filters( 'jetpack_stats_footer_amp_data', $data );
387
388        $data['host'] = isset( $_SERVER['HTTP_HOST'] ) ? sanitize_text_field( wp_unslash( $_SERVER['HTTP_HOST'] ) ) : ''; // input var ok.
389        $data['rand'] = 'RANDOM'; // AMP placeholder.
390        $data['ref']  = 'DOCUMENT_REFERRER'; // AMP placeholder.
391        $data         = array_map( 'rawurlencode', $data );
392        return add_query_arg( $data, 'https://pixel.wp.com/g.gif' );
393    }
394
395    /**
396     * Build an AMP pixel.
397     * Do not use this function directly, it is hooked into `wp_footer`.
398     *
399     * @access public
400     * @return void
401     */
402    public static function add_amp_pixel() {
403        $data = self::build_view_data();
404        if ( ! self::is_amp_request() ) {
405            return;
406        }
407
408        printf( '<amp-pixel src="%s"></amp-pixel>', esc_url( self::get_amp_pixel_url( $data ) ) );
409    }
410
411    /**
412     * Stats Footer.
413     *
414     * @deprecated 0.6.0
415     *
416     * @access public
417     * @return void
418     */
419    public static function add_to_footer() {
420        _deprecated_function( __METHOD__, '0.6.0' );
421    }
422
423    /**
424     * Gets the footer to add for the Stats tracker.
425     *
426     * @deprecated 0.6.0
427     *
428     * @access public
429     * @param array $data Array of data for the JS stats tracker.
430     * @return void
431     */
432    public static function get_footer_to_add( $data ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
433        _deprecated_function( __METHOD__, '0.6.0' );
434    }
435
436    /**
437     * Render the stats footer. Kept for backward compatibility on legacy AMF views.
438     *
439     * @deprecated 0.6.0
440     *
441     * @access public
442     * @param array $data Array of data for the JS stats tracker.
443     */
444    public static function render_footer( $data ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
445        _deprecated_function( __METHOD__, '0.6.0' );
446    }
447
448    /**
449     * Render the stats footer for AMP output. Kept for backward compatibility.
450     *
451     * @access public
452     * @param array $data Array of data for the AMP pixel tracker.
453     */
454    public static function render_amp_footer( $data ) {
455        printf( '<amp-pixel src="%s"></amp-pixel>', esc_url( self::get_amp_pixel_url( $data ) ) );
456    }
457
458    /**
459     * Creates the "array" string used as part of the JS tracker.
460     *
461     * @access private
462     * @param array $kvs Array of options about the site and page you're on.
463     * @return string
464     */
465    private static function stats_array_to_string( $kvs ) {
466        /**
467         * Filters the options added to the JavaScript Stats tracking code.
468         *
469         * @since-jetpack 1.1.0
470         *
471         * @param array $kvs Array of options about the site and page you're on.
472         */
473        $kvs = (array) apply_filters( self::STATS_ARRAY_TO_STRING_FILTER, $kvs );
474        $kvs = array_map( 'strval', $kvs );
475
476        // Encode into JSON object for direct use in JS.
477        return wp_json_encode( $kvs, JSON_UNESCAPED_SLASHES | JSON_HEX_TAG | JSON_HEX_AMP );
478    }
479
480    /**
481     * Does the page return AMP content.
482     *
483     * @return bool $is_amp_request Are we on AMP view.
484     */
485    private static function is_amp_request() {
486        $is_amp_request = ( function_exists( 'amp_is_request' ) && amp_is_request() );
487        $is_amp_request = $is_amp_request || ( function_exists( 'ampforwp_is_amp_endpoint' ) && ampforwp_is_amp_endpoint() );
488
489        /**
490         * Returns true if the current request should return valid AMP content.
491         *
492         * @since 6.2.0
493         *
494         * @param boolean $is_amp_request Is this request supposed to return valid AMP content?
495         */
496        return apply_filters( 'jetpack_is_amp_request', $is_amp_request );
497    }
498}