diff options
Diffstat (limited to 'plugins/jetpack/jetpack_vendor/automattic/jetpack-connection/src/class-tracking.php')
| -rw-r--r-- | plugins/jetpack/jetpack_vendor/automattic/jetpack-connection/src/class-tracking.php | 321 |
1 files changed, 321 insertions, 0 deletions
diff --git a/plugins/jetpack/jetpack_vendor/automattic/jetpack-connection/src/class-tracking.php b/plugins/jetpack/jetpack_vendor/automattic/jetpack-connection/src/class-tracking.php new file mode 100644 index 00000000..ef1f07eb --- /dev/null +++ b/plugins/jetpack/jetpack_vendor/automattic/jetpack-connection/src/class-tracking.php @@ -0,0 +1,321 @@ +<?php +/** + * Nosara Tracks for Jetpack + * + * @package automattic/jetpack-connection + */ + +namespace Automattic\Jetpack; + +/** + * The Tracking class, used to record events in wpcom + */ +class Tracking { + /** + * The assets version. + * + * @since 1.13.1 + * @deprecated since 1.40.1 + * + * @var string Assets version. + */ + const ASSETS_VERSION = '1.0.0'; + + /** + * Slug of the product that we are tracking. + * + * @var string + */ + private $product_name; + + /** + * Connection manager object. + * + * @var Object + */ + private $connection; + + /** + * Creates the Tracking object. + * + * @param String $product_name the slug of the product that we are tracking. + * @param Automattic\Jetpack\Connection\Manager $connection the connection manager object. + */ + public function __construct( $product_name = 'jetpack', $connection = null ) { + $this->product_name = $product_name; + $this->connection = $connection; + if ( $this->connection === null ) { + // TODO We should always pass a Connection. + $this->connection = new Connection\Manager(); + } + + if ( ! did_action( 'jetpack_set_tracks_ajax_hook' ) ) { + add_action( 'wp_ajax_jetpack_tracks', array( $this, 'ajax_tracks' ) ); + + /** + * Fires when the Tracking::ajax_tracks() callback has been hooked to the + * wp_ajax_jetpack_tracks action. This action is used to ensure that + * the callback is hooked only once. + * + * @since 1.13.11 + */ + do_action( 'jetpack_set_tracks_ajax_hook' ); + } + } + + /** + * Universal method for for all tracking events triggered via the JavaScript client. + * + * @access public + */ + public function ajax_tracks() { + // Check for nonce. + if ( + empty( $_REQUEST['tracksNonce'] ) + || ! wp_verify_nonce( $_REQUEST['tracksNonce'], 'jp-tracks-ajax-nonce' ) // phpcs:ignore WordPress.Security.ValidatedSanitizedInput -- WP core doesn't pre-sanitize nonces either. + ) { + wp_send_json_error( + __( 'You aren’t authorized to do that.', 'jetpack-connection' ), + 403 + ); + } + + if ( ! isset( $_REQUEST['tracksEventName'] ) || ! isset( $_REQUEST['tracksEventType'] ) ) { + wp_send_json_error( + __( 'No valid event name or type.', 'jetpack-connection' ), + 403 + ); + } + + $tracks_data = array(); + if ( 'click' === $_REQUEST['tracksEventType'] && isset( $_REQUEST['tracksEventProp'] ) ) { + if ( is_array( $_REQUEST['tracksEventProp'] ) ) { + $tracks_data = array_map( 'filter_var', wp_unslash( $_REQUEST['tracksEventProp'] ) ); + } else { + $tracks_data = array( 'clicked' => filter_var( wp_unslash( $_REQUEST['tracksEventProp'] ) ) ); + } + } + + $this->record_user_event( filter_var( wp_unslash( $_REQUEST['tracksEventName'] ) ), $tracks_data, null, false ); + + wp_send_json_success(); + } + + /** + * Register script necessary for tracking. + * + * @param boolean $enqueue Also enqueue? defaults to false. + */ + public static function register_tracks_functions_scripts( $enqueue = false ) { + + // Register jp-tracks as it is a dependency. + wp_register_script( + 'jp-tracks', + '//stats.wp.com/w.js', + array(), + gmdate( 'YW' ), + true + ); + + Assets::register_script( + 'jp-tracks-functions', + '../dist/tracks-callables.js', + __FILE__, + array( + 'dependencies' => array( 'jp-tracks' ), + 'enqueue' => $enqueue, + 'in_footer' => true, + 'nonmin_path' => 'js/tracks-callables.js', + ) + ); + } + + /** + * Enqueue script necessary for tracking. + */ + public function enqueue_tracks_scripts() { + Assets::register_script( + 'jptracks', + '../dist/tracks-ajax.js', + __FILE__, + array( + 'dependencies' => array( 'jquery' ), + 'enqueue' => true, + 'in_footer' => true, + 'nonmin_path' => 'js/tracks-ajax.js', + ) + ); + + wp_localize_script( + 'jptracks', + 'jpTracksAJAX', + array( + 'ajaxurl' => admin_url( 'admin-ajax.php' ), + 'jpTracksAJAX_nonce' => wp_create_nonce( 'jp-tracks-ajax-nonce' ), + ) + ); + } + + /** + * Send an event in Tracks. + * + * @param string $event_type Type of the event. + * @param array $data Data to send with the event. + * @param mixed $user Username, user_id, or WP_user object. + * @param bool $use_product_prefix Whether to use the object's product name as a prefix to the event type. If + * set to false, the prefix will be 'jetpack_'. + */ + public function record_user_event( $event_type, $data = array(), $user = null, $use_product_prefix = true ) { + if ( ! $user ) { + $user = wp_get_current_user(); + } + $site_url = get_option( 'siteurl' ); + + $data['_via_ua'] = isset( $_SERVER['HTTP_USER_AGENT'] ) ? filter_var( wp_unslash( $_SERVER['HTTP_USER_AGENT'] ) ) : ''; + $data['_via_ip'] = isset( $_SERVER['REMOTE_ADDR'] ) ? filter_var( wp_unslash( $_SERVER['REMOTE_ADDR'] ) ) : ''; + $data['_lg'] = isset( $_SERVER['HTTP_ACCEPT_LANGUAGE'] ) ? filter_var( wp_unslash( $_SERVER['HTTP_ACCEPT_LANGUAGE'] ) ) : ''; + $data['blog_url'] = $site_url; + $data['blog_id'] = \Jetpack_Options::get_option( 'id' ); + + // Top level events should not be namespaced. + if ( '_aliasUser' !== $event_type ) { + $prefix = $use_product_prefix ? $this->product_name : 'jetpack'; + $event_type = $prefix . '_' . $event_type; + } + + $data['jetpack_version'] = defined( 'JETPACK__VERSION' ) ? JETPACK__VERSION : '0'; + + return $this->tracks_record_event( $user, $event_type, $data ); + } + + /** + * Record an event in Tracks - this is the preferred way to record events from PHP. + * + * @param mixed $user username, user_id, or WP_user object. + * @param string $event_name The name of the event. + * @param array $properties Custom properties to send with the event. + * @param int $event_timestamp_millis The time in millis since 1970-01-01 00:00:00 when the event occurred. + * + * @return bool true for success | \WP_Error if the event pixel could not be fired + */ + public function tracks_record_event( $user, $event_name, $properties = array(), $event_timestamp_millis = false ) { + + // We don't want to track user events during unit tests/CI runs. + if ( $user instanceof \WP_User && 'wptests_capabilities' === $user->cap_key ) { + return false; + } + $terms_of_service = new Terms_Of_Service(); + $status = new Status(); + // Don't track users who have not agreed to our TOS. + if ( ! $this->should_enable_tracking( $terms_of_service, $status ) ) { + return false; + } + + $event_obj = $this->tracks_build_event_obj( $user, $event_name, $properties, $event_timestamp_millis ); + + if ( is_wp_error( $event_obj->error ) ) { + return $event_obj->error; + } + + return $event_obj->record(); + } + + /** + * Determines whether tracking should be enabled. + * + * @param Automattic\Jetpack\Terms_Of_Service $terms_of_service A Terms_Of_Service object. + * @param Automattic\Jetpack\Status $status A Status object. + * + * @return boolean True if tracking should be enabled, else false. + */ + public function should_enable_tracking( $terms_of_service, $status ) { + if ( $status->is_offline_mode() ) { + return false; + } + + return $terms_of_service->has_agreed() || $this->connection->is_user_connected(); + } + + /** + * Procedurally build a Tracks Event Object. + * NOTE: Use this only when the simpler Automattic\Jetpack\Tracking->jetpack_tracks_record_event() function won't work for you. + * + * @param WP_user $user WP_user object. + * @param string $event_name The name of the event. + * @param array $properties Custom properties to send with the event. + * @param int $event_timestamp_millis The time in millis since 1970-01-01 00:00:00 when the event occurred. + * + * @return \Jetpack_Tracks_Event|\WP_Error + */ + private function tracks_build_event_obj( $user, $event_name, $properties = array(), $event_timestamp_millis = false ) { + $identity = $this->tracks_get_identity( $user->ID ); + + $properties['user_lang'] = $user->get( 'WPLANG' ); + + $blog_details = array( + 'blog_lang' => isset( $properties['blog_lang'] ) ? $properties['blog_lang'] : get_bloginfo( 'language' ), + ); + + $timestamp = ( false !== $event_timestamp_millis ) ? $event_timestamp_millis : round( microtime( true ) * 1000 ); + $timestamp_string = is_string( $timestamp ) ? $timestamp : number_format( $timestamp, 0, '', '' ); + + return new \Jetpack_Tracks_Event( + array_merge( + $blog_details, + (array) $properties, + $identity, + array( + '_en' => $event_name, + '_ts' => $timestamp_string, + ) + ) + ); + } + + /** + * Get the identity to send to tracks. + * + * @param int $user_id The user id of the local user. + * + * @return array $identity + */ + public function tracks_get_identity( $user_id ) { + + // Meta is set, and user is still connected. Use WPCOM ID. + $wpcom_id = get_user_meta( $user_id, 'jetpack_tracks_wpcom_id', true ); + if ( $wpcom_id && $this->connection->is_user_connected( $user_id ) ) { + return array( + '_ut' => 'wpcom:user_id', + '_ui' => $wpcom_id, + ); + } + + // User is connected, but no meta is set yet. Use WPCOM ID and set meta. + if ( $this->connection->is_user_connected( $user_id ) ) { + $wpcom_user_data = $this->connection->get_connected_user_data( $user_id ); + update_user_meta( $user_id, 'jetpack_tracks_wpcom_id', $wpcom_user_data['ID'] ); + + return array( + '_ut' => 'wpcom:user_id', + '_ui' => $wpcom_user_data['ID'], + ); + } + + // User isn't linked at all. Fall back to anonymous ID. + $anon_id = get_user_meta( $user_id, 'jetpack_tracks_anon_id', true ); + if ( ! $anon_id ) { + $anon_id = \Jetpack_Tracks_Client::get_anon_id(); + add_user_meta( $user_id, 'jetpack_tracks_anon_id', $anon_id, false ); + } + + if ( ! isset( $_COOKIE['tk_ai'] ) && ! headers_sent() ) { + setcookie( 'tk_ai', $anon_id, 0, COOKIEPATH, COOKIE_DOMAIN, is_ssl(), false ); // phpcs:ignore Jetpack.Functions.SetCookie -- This is a random string and should be fine. + } + + return array( + '_ut' => 'anon', + '_ui' => $anon_id, + ); + + } +} |