first commit

wp-content/plugins/jetpack.bck/vendor/automattic/jetpack-tracking/legacy/class-jetpack-tracks-client.php

@@ -0,0 +1,228 @@
+<?php
+/**
+ * Legacy Jetpack Tracks Client
+ *
+ * @package Jetpack
+ */
+
+/**
+ * Jetpack_Tracks_Client
+ *
+ * @autounit nosara tracks-client
+ *
+ * Send Tracks events on behalf of a user
+ *
+ * Example Usage:
+```php
+	require( dirname(__FILE__).'path/to/tracks/class-jetpack-tracks-client.php' );
+
+	$result = Jetpack_Tracks_Client::record_event( array(
+		'_en'        => $event_name,       // required
+		'_ui'        => $user_id,          // required unless _ul is provided
+		'_ul'        => $user_login,       // required unless _ui is provided
+
+		// Optional, but recommended
+		'_ts'        => $ts_in_ms,         // Default: now
+		'_via_ip'    => $client_ip,        // we use it for geo, etc.
+
+		// Possibly useful to set some context for the event
+		'_via_ua'    => $client_user_agent,
+		'_via_url'   => $client_url,
+		'_via_ref'   => $client_referrer,
+
+		// For user-targeted tests
+		'abtest_name'        => $abtest_name,
+		'abtest_variation'   => $abtest_variation,
+
+		// Your application-specific properties
+		'custom_property'    => $some_value,
+	) );
+
+	if ( is_wp_error( $result ) ) {
+		// Handle the error in your app
+	}
+```
+ */
+class Jetpack_Tracks_Client {
+	const PIXEL           = 'https://pixel.wp.com/t.gif';
+	const BROWSER_TYPE    = 'php-agent';
+	const USER_AGENT_SLUG = 'tracks-client';
+	const VERSION         = '0.3';
+
+	/**
+	 * Stores the Terms of Service Object Reference.
+	 *
+	 * @var null
+	 */
+	private static $terms_of_service = null;
+
+	/**
+	 * Record an event.
+	 *
+	 * @param  mixed $event Event object to send to Tracks. An array will be cast to object. Required.
+	 *                      Properties are included directly in the pixel query string after light validation.
+	 * @return mixed         True on success, WP_Error on failure
+	 */
+	public static function record_event( $event ) {
+		if ( ! self::$terms_of_service ) {
+			self::$terms_of_service = new \Automattic\Jetpack\Terms_Of_Service();
+		}
+
+		// Don't track users who have opted out or not agreed to our TOS, or are not running an active Jetpack.
+		if ( ! self::$terms_of_service->has_agreed() || ! empty( $_COOKIE['tk_opt-out'] ) ) {
+			return false;
+		}
+
+		if ( ! $event instanceof Jetpack_Tracks_Event ) {
+			$event = new Jetpack_Tracks_Event( $event );
+		}
+		if ( is_wp_error( $event ) ) {
+			return $event;
+		}
+
+		$pixel = $event->build_pixel_url( $event );
+
+		if ( ! $pixel ) {
+			return new WP_Error( 'invalid_pixel', 'cannot generate tracks pixel for given input', 400 );
+		}
+
+		return self::record_pixel( $pixel );
+	}
+
+	/**
+	 * Synchronously request the pixel.
+	 *
+	 * @param string $pixel The wp.com tracking pixel.
+	 * @return array|bool|WP_Error True if successful. wp_remote_get response or WP_Error if not.
+	 */
+	public static function record_pixel( $pixel ) {
+		// Add the Request Timestamp and URL terminator just before the HTTP request.
+		$pixel .= '&_rt=' . self::build_timestamp() . '&_=_';
+
+		$response = wp_remote_get(
+			$pixel,
+			array(
+				'blocking'    => true, // The default, but being explicit here :).
+				'timeout'     => 1,
+				'redirection' => 2,
+				'httpversion' => '1.1',
+				'user-agent'  => self::get_user_agent(),
+			)
+		);
+
+		if ( is_wp_error( $response ) ) {
+			return $response;
+		}
+
+		$code = isset( $response['response']['code'] ) ? $response['response']['code'] : 0;
+
+		if ( 200 !== $code ) {
+			return new WP_Error( 'request_failed', 'Tracks pixel request failed', $code );
+		}
+
+		return true;
+	}
+
+	/**
+	 * Get the user agent.
+	 *
+	 * @return string The user agent.
+	 */
+	public static function get_user_agent() {
+		return self::USER_AGENT_SLUG . '-v' . self::VERSION;
+	}
+
+	/**
+	 * Build an event and return its tracking URL
+	 *
+	 * @deprecated          Call the `build_pixel_url` method on a Jetpack_Tracks_Event object instead.
+	 * @param  array $event Event keys and values.
+	 * @return string       URL of a tracking pixel.
+	 */
+	public static function build_pixel_url( $event ) {
+		$_event = new Jetpack_Tracks_Event( $event );
+		return $_event->build_pixel_url();
+	}
+
+	/**
+	 * Validate input for a tracks event.
+	 *
+	 * @deprecated          Instantiate a Jetpack_Tracks_Event object instead
+	 * @param  array $event Event keys and values.
+	 * @return mixed        Validated keys and values or WP_Error on failure
+	 */
+	private static function validate_and_sanitize( $event ) {
+		$_event = new Jetpack_Tracks_Event( $event );
+		if ( is_wp_error( $_event ) ) {
+			return $_event;
+		}
+		return get_object_vars( $_event );
+	}
+
+	/**
+	 * Builds a timestamp.
+	 *
+	 * Milliseconds since 1970-01-01.
+	 *
+	 * @return string
+	 */
+	public static function build_timestamp() {
+		$ts = round( microtime( true ) * 1000 );
+		return number_format( $ts, 0, '', '' );
+	}
+
+	/**
+	 * Grabs the user's anon id from cookies, or generates and sets a new one
+	 *
+	 * @return string An anon id for the user
+	 */
+	public static function get_anon_id() {
+		static $anon_id = null;
+
+		if ( ! isset( $anon_id ) ) {
+
+			// Did the browser send us a cookie?
+			if ( isset( $_COOKIE['tk_ai'] ) && preg_match( '#^[A-Za-z0-9+/=]{24}$#', $_COOKIE['tk_ai'] ) ) {
+				$anon_id = $_COOKIE['tk_ai'];
+			} else {
+
+				$binary = '';
+
+				// Generate a new anonId and try to save it in the browser's cookies.
+				// Note that base64-encoding an 18 character string generates a 24-character anon id.
+				for ( $i = 0; $i < 18; ++$i ) {
+					$binary .= chr( wp_rand( 0, 255 ) );
+				}
+
+				$anon_id = 'jetpack:' . base64_encode( $binary ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_encode
+
+				if ( ! headers_sent()
+					&& ! ( defined( 'REST_REQUEST' ) && REST_REQUEST )
+					&& ! ( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST )
+				) {
+					setcookie( 'tk_ai', $anon_id );
+				}
+			}
+		}
+
+		return $anon_id;
+	}
+
+	/**
+	 * Gets the WordPress.com user's Tracks identity, if connected.
+	 *
+	 * @return array|bool
+	 */
+	public static function get_connected_user_tracks_identity() {
+		$user_data = Jetpack::get_connected_user_data();
+		if ( ! $user_data ) {
+			return false;
+		}
+
+		return array(
+			'blogid'   => Jetpack_Options::get_option( 'id', 0 ),
+			'userid'   => $user_data['ID'],
+			'username' => $user_data['login'],
+		);
+	}
+}

wp-content/plugins/jetpack.bck/vendor/automattic/jetpack-tracking/legacy/class-jetpack-tracks-event.php

@@ -0,0 +1,189 @@
+<?php
+/**
+ * Class Jetpack_Tracks_Event. Legacy.
+ *
+ * @package automattic/jetpack-sync
+ */
+
+/*
+ * @autounit nosara tracks-client
+ *
+ * Example Usage:
+```php
+	require_once( dirname(__FILE__) . 'path/to/tracks/class-jetpack-tracks-event.php' );
+
+	$event = new Jetpack_Tracks_Event( array(
+		'_en'        => $event_name,       // required
+		'_ui'        => $user_id,          // required unless _ul is provided
+		'_ul'        => $user_login,       // required unless _ui is provided
+
+		// Optional, but recommended
+		'_via_ip'    => $client_ip,        // for geo, etc.
+
+		// Possibly useful to set some context for the event
+		'_via_ua'    => $client_user_agent,
+		'_via_url'   => $client_url,
+		'_via_ref'   => $client_referrer,
+
+		// For user-targeted tests
+		'abtest_name'        => $abtest_name,
+		'abtest_variation'   => $abtest_variation,
+
+		// Your application-specific properties
+		'custom_property'    => $some_value,
+	) );
+
+	if ( is_wp_error( $event->error ) ) {
+		// Handle the error in your app
+	}
+
+	$bump_and_redirect_pixel = $event->build_signed_pixel_url();
+```
+ */
+
+/**
+ * Class Jetpack_Tracks_Event
+ */
+class Jetpack_Tracks_Event {
+	const EVENT_NAME_REGEX = '/^(([a-z0-9]+)_){2}([a-z0-9_]+)$/';
+	const PROP_NAME_REGEX  = '/^[a-z_][a-z0-9_]*$/';
+
+	/**
+	 * Tracks Event Error.
+	 *
+	 * @var mixed Error.
+	 */
+	public $error;
+
+	/**
+	 * Jetpack_Tracks_Event constructor.
+	 *
+	 * @param object $event Tracks event.
+	 */
+	public function __construct( $event ) {
+		$_event = self::validate_and_sanitize( $event );
+		if ( is_wp_error( $_event ) ) {
+			$this->error = $_event;
+			return;
+		}
+
+		foreach ( $_event as $key => $value ) {
+			$this->{$key} = $value;
+		}
+	}
+
+	/**
+	 * Record a track event.
+	 */
+	public function record() {
+		return Jetpack_Tracks_Client::record_event( $this );
+	}
+
+	/**
+	 * Annotate the event with all relevant info.
+	 *
+	 * @param  mixed $event Object or (flat) array.
+	 * @return mixed        The transformed event array or WP_Error on failure.
+	 */
+	public static function validate_and_sanitize( $event ) {
+		$event = (object) $event;
+
+		// Required.
+		if ( ! $event->_en ) {
+			return new WP_Error( 'invalid_event', 'A valid event must be specified via `_en`', 400 );
+		}
+
+		// delete non-routable addresses otherwise geoip will discard the record entirely.
+		if ( property_exists( $event, '_via_ip' ) && preg_match( '/^192\.168|^10\./', $event->_via_ip ) ) {
+			unset( $event->_via_ip );
+		}
+
+		$validated = array(
+			'browser_type' => Jetpack_Tracks_Client::BROWSER_TYPE,
+			'_aua'         => Jetpack_Tracks_Client::get_user_agent(),
+		);
+
+		$_event = (object) array_merge( (array) $event, $validated );
+
+		// If you want to blacklist property names, do it here.
+
+		// Make sure we have an event timestamp.
+		if ( ! isset( $_event->_ts ) ) {
+			$_event->_ts = Jetpack_Tracks_Client::build_timestamp();
+		}
+
+		return $_event;
+	}
+
+	/**
+	 * Build a pixel URL that will send a Tracks event when fired.
+	 * On error, returns an empty string ('').
+	 *
+	 * @return string A pixel URL or empty string ('') if there were invalid args.
+	 */
+	public function build_pixel_url() {
+		if ( $this->error ) {
+			return '';
+		}
+
+		$args = get_object_vars( $this );
+
+		// Request Timestamp and URL Terminator must be added just before the HTTP request or not at all.
+		unset( $args['_rt'] );
+		unset( $args['_'] );
+
+		$validated = self::validate_and_sanitize( $args );
+
+		if ( is_wp_error( $validated ) ) {
+			return '';
+		}
+
+		return Jetpack_Tracks_Client::PIXEL . '?' . http_build_query( $validated );
+	}
+
+	/**
+	 * Validate the event name.
+	 *
+	 * @param string $name Event name.
+	 * @return false|int
+	 */
+	public static function event_name_is_valid( $name ) {
+		return preg_match( self::EVENT_NAME_REGEX, $name );
+	}
+
+	/**
+	 * Validates prop name
+	 *
+	 * @param string $name Property name.
+	 *
+	 * @return false|int Truthy value.
+	 */
+	public static function prop_name_is_valid( $name ) {
+		return preg_match( self::PROP_NAME_REGEX, $name );
+	}
+
+	/**
+	 * Scrutinize event name.
+	 *
+	 * @param object $event Tracks event.
+	 */
+	public static function scrutinize_event_names( $event ) {
+		if ( ! self::event_name_is_valid( $event->_en ) ) {
+			return;
+		}
+
+		$whitelisted_key_names = array(
+			'anonId',
+			'Browser_Type',
+		);
+
+		foreach ( array_keys( (array) $event ) as $key ) {
+			if ( in_array( $key, $whitelisted_key_names, true ) ) {
+				continue;
+			}
+			if ( ! self::prop_name_is_valid( $key ) ) {
+				return;
+			}
+		}
+	}
+}