diff options
Diffstat (limited to 'plugins/jetpack/modules/google-analytics/classes/wp-google-analytics-legacy.php')
| -rw-r--r-- | plugins/jetpack/modules/google-analytics/classes/wp-google-analytics-legacy.php | 256 |
1 files changed, 256 insertions, 0 deletions
diff --git a/plugins/jetpack/modules/google-analytics/classes/wp-google-analytics-legacy.php b/plugins/jetpack/modules/google-analytics/classes/wp-google-analytics-legacy.php new file mode 100644 index 00000000..ddca0e46 --- /dev/null +++ b/plugins/jetpack/modules/google-analytics/classes/wp-google-analytics-legacy.php @@ -0,0 +1,256 @@ +<?php + +/** +* Jetpack_Google_Analytics_Legacy hooks and enqueues support for ga.js +* https://developers.google.com/analytics/devguides/collection/gajs/ +* +* @author Aaron D. Campbell (original) +* @author allendav +*/ + +/** +* Bail if accessed directly +*/ +if ( ! defined( 'ABSPATH' ) ) { + exit; +} + +class Jetpack_Google_Analytics_Legacy { + public function __construct() { + add_filter( 'jetpack_wga_classic_custom_vars', array( $this, 'jetpack_wga_classic_anonymize_ip' ) ); + add_filter( 'jetpack_wga_classic_custom_vars', array( $this, 'jetpack_wga_classic_track_purchases' ) ); + add_action( 'wp_footer', array( $this, 'insert_code' ) ); + add_action( 'wp_footer', array( $this, 'jetpack_wga_classic_track_add_to_cart' ) ); + } + + /** + * Used to generate a tracking URL + * Called exclusively by insert_code + * + * @param array $track - Must have ['data'] and ['code']. + * @return string - Tracking URL + */ + private function _get_url( $track ) { + $site_url = ( is_ssl() ? 'https://':'http://' ) . sanitize_text_field( wp_unslash( $_SERVER['HTTP_HOST'] ) ); // Input var okay. + foreach ( $track as $k => $value ) { + if ( strpos( strtolower( $value ), strtolower( $site_url ) ) === 0 ) { + $track[ $k ] = substr( $track[ $k ], strlen( $site_url ) ); + } + if ( 'data' === $k ) { + $track[ $k ] = preg_replace( '/^https?:\/\/|^\/+/i', '', $track[ $k ] ); + } + + // This way we don't lose search data. + if ( 'data' === $k && 'search' === $track['code'] ) { + $track[ $k ] = rawurlencode( $track[ $k ] ); + } else { + $track[ $k ] = preg_replace( '/[^a-z0-9\.\/\+\?=-]+/i', '_', $track[ $k ] ); + } + + $track[ $k ] = trim( $track[ $k ], '_' ); + } + $char = ( strpos( $track['data'], '?' ) === false ) ? '?' : '&'; + return str_replace( "'", "\'", "/{$track['code']}/{$track['data']}{$char}referer=" . rawurlencode( isset( $_SERVER['HTTP_REFERER'] ) ? $_SERVER['HTTP_REFERER'] : '' ) ); // Input var okay. + } + + /** + * This injects the Google Analytics code into the footer of the page. + * Called exclusively by wp_footer action + */ + public function insert_code() { + $tracking_id = Jetpack_Google_Analytics_Options::get_tracking_code(); + if ( empty( $tracking_id ) ) { + echo "<!-- Your Google Analytics Plugin is missing the tracking ID -->\r\n"; + return; + } + + // If we're in the admin_area, return without inserting code. + if ( is_admin() ) { + return; + } + + $custom_vars = array( + "_gaq.push(['_setAccount', '{$tracking_id}']);", + ); + + $track = array(); + if ( is_404() ) { + // This is a 404 and we are supposed to track them. + $custom_vars[] = "_gaq.push(['_trackEvent', '404', document.location.href, document.referrer]);"; + } elseif ( + is_search() + && isset( $_REQUEST['s'] ) + ) { + // Set track for searches, if it's a search, and we are supposed to. + $track['data'] = sanitize_text_field( wp_unslash( $_REQUEST['s'] ) ); // Input var okay. + $track['code'] = 'search'; + } + + if ( ! empty( $track ) ) { + $track['url'] = $this->_get_url( $track ); + // adjust the code that we output, account for both types of tracking. + $track['url'] = esc_js( str_replace( '&', '&', $track['url'] ) ); + $custom_vars[] = "_gaq.push(['_trackPageview','{$track['url']}']);"; + } else { + $custom_vars[] = "_gaq.push(['_trackPageview']);"; + } + + /** + * Allow for additional elements to be added to the classic Google Analytics queue (_gaq) array + * + * @since 5.4.0 + * + * @param array $custom_vars Array of classic Google Analytics queue elements + */ + $custom_vars = apply_filters( 'jetpack_wga_classic_custom_vars', $custom_vars ); + + // Ref: https://developers.google.com/analytics/devguides/collection/gajs/gaTrackingEcommerce#Example + printf( + "<!-- Jetpack Google Analytics --> + <script type='text/javascript'> + var _gaq = _gaq || []; + %s + (function() { + var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; + ga.src = ('https:' === document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; + var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); + })(); + </script>\r\n", + implode( "\r\n", $custom_vars ) + ); + } + + /** + * Used to filter in the anonymize IP snippet to the custom vars array for classic analytics + * Ref https://developers.google.com/analytics/devguides/collection/gajs/methods/gaJSApi_gat#_gat._anonymizelp + * @param array custom vars to be filtered + * @return array possibly updated custom vars + */ + public function jetpack_wga_classic_anonymize_ip( $custom_vars ) { + if ( Jetpack_Google_Analytics_Options::anonymize_ip_is_enabled() ) { + array_push( $custom_vars, "_gaq.push(['_gat._anonymizeIp']);" ); + } + + return $custom_vars; + } + + /** + * Used to filter in the order details to the custom vars array for classic analytics + * @param array custom vars to be filtered + * @return array possibly updated custom vars + */ + public function jetpack_wga_classic_track_purchases( $custom_vars ) { + global $wp; + + if ( ! class_exists( 'WooCommerce' ) ) { + return $custom_vars; + } + + if ( ! Jetpack_Google_Analytics_Options::has_tracking_code() ) { + return; + } + + // Ref: https://developers.google.com/analytics/devguides/collection/gajs/gaTrackingEcommerce#Example + if ( ! Jetpack_Google_Analytics_Options::track_purchases_is_enabled() ) { + return $custom_vars; + } + + $minimum_woocommerce_active = class_exists( 'WooCommerce' ) && version_compare( WC_VERSION, '3.0', '>=' ); + if ( $minimum_woocommerce_active && is_order_received_page() ) { + $order_id = isset( $wp->query_vars['order-received'] ) ? $wp->query_vars['order-received'] : 0; + if ( 0 < $order_id && 1 != get_post_meta( $order_id, '_ga_tracked', true ) ) { + $order = new WC_Order( $order_id ); + + // [ '_add_Trans', '123', 'Site Title', '21.00', '1.00', '5.00', 'Snohomish', 'WA', 'USA' ] + array_push( + $custom_vars, + sprintf( + '_gaq.push( %s );', json_encode( + array( + '_addTrans', + (string) $order->get_order_number(), + get_bloginfo( 'name' ), + (string) $order->get_total(), + (string) $order->get_total_tax(), + (string) $order->get_total_shipping(), + (string) $order->get_billing_city(), + (string) $order->get_billing_state(), + (string) $order->get_billing_country() + ) + ) + ) + ); + + // Order items + if ( $order->get_items() ) { + foreach ( $order->get_items() as $item ) { + $product = $order->get_product_from_item( $item ); + $product_sku_or_id = $product->get_sku() ? $product->get_sku() : $product->get_id(); + + array_push( + $custom_vars, + sprintf( + '_gaq.push( %s );', json_encode( + array( + '_addItem', + (string) $order->get_order_number(), + (string) $product_sku_or_id, + $item['name'], + Jetpack_Google_Analytics_Utils::get_product_categories_concatenated( $product ), + (string) $order->get_item_total( $item ), + (string) $item['qty'] + ) + ) + ) + ); + } + } // get_items + + // Mark the order as tracked + update_post_meta( $order_id, '_ga_tracked', 1 ); + array_push( $custom_vars, "_gaq.push(['_trackTrans']);" ); + } // order not yet tracked + } // is order received page + + return $custom_vars; + } + + /** + * Used to add footer javascript to track user clicking on add-to-cart buttons + * on single views (.single_add_to_cart_button) and list views (.add_to_cart_button) + */ + public function jetpack_wga_classic_track_add_to_cart() { + if ( ! class_exists( 'WooCommerce' ) ) { + return; + } + + if ( ! Jetpack_Google_Analytics_Options::has_tracking_code() ) { + return; + } + + if ( ! Jetpack_Google_Analytics_Options::track_add_to_cart_is_enabled() ) { + return; + } + + if ( is_product() ) { // product page + global $product; + $product_sku_or_id = $product->get_sku() ? $product->get_sku() : "#" + $product->get_id(); + wc_enqueue_js( + "jQuery( function( $ ) { + $( '.single_add_to_cart_button' ).click( function() { + _gaq.push(['_trackEvent', 'Products', 'Add to Cart', '#" . esc_js( $product_sku_or_id ) . "']); + } ); + } );" + ); + } else if ( is_woocommerce() ) { // any other page that uses templates (like product lists, archives, etc) + wc_enqueue_js( + "jQuery( function( $ ) { + $( '.add_to_cart_button:not(.product_type_variable, .product_type_grouped)' ).click( function() { + var label = $( this ).data( 'product_sku' ) ? $( this ).data( 'product_sku' ) : '#' + $( this ).data( 'product_id' ); + _gaq.push(['_trackEvent', 'Products', 'Add to Cart', label]); + } ); + } );" + ); + } + } +} |