Sync: IDC: Add get_raw_url method to Jetpack_Sync_Functions

3rd-party/3rd-party.php

@@ -10,6 +10,7 @@
 require_once( JETPACK__PLUGIN_DIR . '3rd-party/bitly.php' );
 require_once( JETPACK__PLUGIN_DIR . '3rd-party/bbpress.php' );
 require_once( JETPACK__PLUGIN_DIR . '3rd-party/woocommerce.php' );
+require_once( JETPACK__PLUGIN_DIR . '3rd-party/domain-mapping.php' );
 
 // We can't load this conditionally since polldaddy add the call in class constuctor.
 require_once( JETPACK__PLUGIN_DIR . '3rd-party/polldaddy.php' );

3rd-party/domain-mapping.php

@@ -0,0 +1,113 @@
+<?php
+
+/**
+ * Class Jetpack_3rd_Party_Domain_Mapping
+ *
+ * This class contains methods that are used to provide compatibility between Jetpack sync and domain mapping plugins.
+ */
+class Jetpack_3rd_Party_Domain_Mapping {
+
+	/**
+	 * @var Jetpack_3rd_Party_Domain_Mapping
+	 **/
+	private static $instance = null;
+
+	/**
+	 * An array of methods that are used to hook the Jetpack sync filters for home_url and site_url to a mapping plugin.
+	 *
+	 * @var array
+	 */
+	static $test_methods = array(
+		'hook_wordpress_mu_domain_mapping',
+		'hook_wpmu_dev_domain_mapping'
+	);
+
+	static function init() {
+		if ( is_null( self::$instance ) ) {
+			self::$instance = new Jetpack_3rd_Party_Domain_Mapping;
+		}
+
+		return self::$instance;
+	}
+
+	private function __construct() {
+		add_action( 'plugins_loaded', array( $this, 'attempt_to_hook_domain_mapping_plugins' ) );
+	}
+
+	/**
+	 * This function is called on the plugins_loaded action and will loop through the $test_methods
+	 * to try and hook a domain mapping plugin to the Jetpack sync filters for the home_url and site_url callables.
+	 */
+	function attempt_to_hook_domain_mapping_plugins() {
+		if ( ! Jetpack_Constants::is_defined( 'SUNRISE' ) ) {
+			return;
+		}
+
+		$hooked = false;
+		$count = count( self::$test_methods );
+		for ( $i = 0; $i < $count && ! $hooked; $i++ ) {
+			$hooked = call_user_func( array( $this, self::$test_methods[ $i ] ) );
+		}
+	}
+
+	/**
+	 * This method will test for a constant and function that are known to be used with Donncha's WordPress MU
+	 * Domain Mapping plugin. If conditions are met, we hook the domain_mapping_siteurl() function to Jetpack sync
+	 * filters for home_url and site_url callables.
+	 *
+	 * @return bool
+	 */
+	function hook_wordpress_mu_domain_mapping() {
+		if ( ! Jetpack_Constants::is_defined( 'SUNRISE_LOADED' ) || ! $this->function_exists( 'domain_mapping_siteurl' ) ) {
+			return false;
+		}
+
+		add_filter( 'jetpack_sync_home_url', 'domain_mapping_siteurl' );
+		add_filter( 'jetpack_sync_site_url', 'domain_mapping_siteurl' );
+
+		return true;
+	}
+
+	/**
+	 * This method will test for a class and method known to be used in WPMU Dev's domain mapping plugin. If the
+	 * method exists, then we'll hook the swap_to_mapped_url() to our Jetpack sync filters for home_url and site_url.
+	 *
+	 * @return bool
+	 */
+	function hook_wpmu_dev_domain_mapping() {
+		if ( ! $this->class_exists( 'domain_map' ) || ! $this->method_exists( 'domain_map', 'utils' ) ) {
+			return false;
+		}
+
+		$utils = $this->get_domain_mapping_utils_instance();
+		add_filter( 'jetpack_sync_home_url', array( $utils, 'swap_to_mapped_url' ) );
+		add_filter( 'jetpack_sync_site_url', array( $utils, 'swap_to_mapped_url' ) );
+
+		return true;
+	}
+
+	/*
+	 * Utility Methods
+	 *
+	 * These methods are very minimal, and in most cases, simply pass on arguments. Why create them you ask?
+	 * So that we can test.
+	 */
+
+	public function method_exists( $class, $method ) {
+		return method_exists( $class, $method );
+	}
+
+	public function class_exists( $class ) {
+		return class_exists( $class );
+	}
+
+	public function function_exists( $function ) {
+		return function_exists( $function );
+	}
+
+	public function get_domain_mapping_utils_instance() {
+		return domain_map::utils();
+	}
+}
+
+Jetpack_3rd_Party_Domain_Mapping::init();

class.jetpack-xmlrpc-server.php

@@ -340,9 +340,10 @@ function sync_object( $args ) {
 	 * @return array
 	 */
 	function validate_urls_for_idc_mitigation() {
+		require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-functions.php';
 		return array(
-			'home'    => get_home_url(),
-			'siteurl' => get_site_url(),
+			'home'    => Jetpack_Sync_Functions::home_url(),
+			'siteurl' => Jetpack_Sync_Functions::site_url(),
 		);
 	}
 

class.jetpack.php

@@ -5797,9 +5797,10 @@ public static function normalize_url_protocol_agnostic( $url ) {
 	 * @return array Array of the local urls, wpcom urls, and error code
 	 */
 	public static function get_sync_error_idc_option( $response = array() ) {
+		require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-functions.php';
 		$local_options = array(
-			'home' => get_home_url(),
-			'siteurl' => get_site_url(),
+			'home'    => Jetpack_Sync_Functions::home_url(),
+			'siteurl' => Jetpack_Sync_Functions::site_url(),
 		);
 
 		$options = array_merge( $local_options, $response );

phpunit.xml.dist

@@ -80,6 +80,9 @@
 		<testsuite name="jitm">
 			<file>tests/php/test_class.jetpack-jitm.php</file>
 		</testsuite>
+		<testsuite name="3rd-party">
+			<directory prefix="test_" suffix=".php">tests/php/3rd-party</directory>
+		</testsuite>
 	</testsuites>
 	<groups>
 		<exclude>

sync/class.jetpack-sync-actions.php

@@ -113,15 +113,16 @@ static function set_is_importing_true() {
 	}
 
 	static function send_data( $data, $codec_name, $sent_timestamp, $queue_id, $checkout_duration, $preprocess_duration ) {
+		require_once dirname( __FILE__ ) . '/class.jetpack-sync-functions.php';
 		Jetpack::load_xml_rpc_client();
 
 		$query_args = array(
 			'sync'      => '1',             // add an extra parameter to the URL so we can tell it's a sync action
 			'codec'     => $codec_name,     // send the name of the codec used to encode the data
 			'timestamp' => $sent_timestamp, // send current server time so we can compensate for clock differences
 			'queue'     => $queue_id,       // sync or full_sync
-			'home'      => get_home_url(),  // Send home url option to check for Identity Crisis server-side
-			'siteurl'   => get_site_url(),  // Send siteurl option to check for Identity Crisis server-side
+			'home'      => Jetpack_Sync_Functions::home_url(),  // Send home url option to check for Identity Crisis server-side
+			'siteurl'   => Jetpack_Sync_Functions::site_url(),  // Send siteurl option to check for Identity Crisis server-side
 			'cd'        => sprintf( '%.4f', $checkout_duration),   // Time spent retrieving queue items from the DB
 			'pd'        => sprintf( '%.4f', $preprocess_duration), // Time spent converting queue items into data to send
 		);

sync/class.jetpack-sync-functions.php

@@ -144,18 +144,53 @@ public static function file_system_write_access() {
 		return false;
 	}
 
+	/**
+	 * Helper function that is used when getting home or siteurl values. Decides
+	 * whether to get the raw or filtered value.
+	 *
+	 * @return string
+	 */
+	public static function get_raw_or_filtered_url( $url_type ) {
+		if (
+			! Jetpack_Constants::is_defined( 'JETPACK_SYNC_USE_RAW_URL' ) ||
+			Jetpack_Constants::get_constant( 'JETPACK_SYNC_USE_RAW_URL' )
+		) {
+			$url = self::get_raw_url( $url_type );
+		} else {
+			$url_function = ( 'home' == $url_type )
+				? 'home_url'
+				: 'site_url';
+			$url = self::normalize_www_in_url( $url_type, $url_function );
+			$url = self::get_protocol_normalized_url( $url_function, $url );
+		}
+
+		return $url;
+	}
+
 	public static function home_url() {
-		return self::get_protocol_normalized_url(
-			'home_url',
-			self::normalize_www_in_url( 'home', 'home_url' )
-		);
+		$url = self::get_raw_or_filtered_url( 'home' );
+
+		/**
+		 * Allows overriding of the home_url value that is synced back to WordPress.com.
+		 *
+		 * @since 5.2
+		 *
+		 * @param string $home_url
+		 */
+		return esc_url_raw( apply_filters( 'jetpack_sync_home_url', $url ) );
 	}
 
 	public static function site_url() {
-		return self::get_protocol_normalized_url(
-			'site_url',
-			self::normalize_www_in_url( 'siteurl', 'site_url' )
-		);
+		$url = self::get_raw_or_filtered_url( 'siteurl' );
+
+		/**
+		 * Allows overriding of the site_url value that is synced back to WordPress.com.
+		 *
+		 * @since 5.2
+		 *
+		 * @param string $site_url
+		 */
+		return esc_url_raw( apply_filters( 'jetpack_sync_site_url', $url ) );
 	}
 
 	public static function main_network_site_url() {
@@ -184,6 +219,23 @@ public static function get_protocol_normalized_url( $callable, $new_value ) {
 		return set_url_scheme( $new_value, $forced_scheme );
 	}
 
+	public static function get_raw_url( $option_name ) {
+		$value = null;
+		$constant = ( 'home' == $option_name )
+			? 'WP_HOME'
+			: 'WP_SITEURL';
+
+		if ( Jetpack_Constants::is_defined( $constant ) ) {
+			$value = Jetpack_Constants::get_constant( $constant );
+		} else {
+			// Let's get the option from the database so that we can bypass filters. This will help
+			// ensure that we get more uniform values.
+			$value = Jetpack_Options::get_raw_option( $option_name );
+		}
+
+		return $value;
+	}
+
 	public static function normalize_www_in_url( $option, $url_function ) {
 		$url        = wp_parse_url( call_user_func( $url_function ) );
 		$option_url = wp_parse_url( get_option( $option ) );

sync/class.jetpack-sync-module-callables.php

@@ -145,7 +145,7 @@ public function maybe_sync_callables() {
 			return;
 		}
 
-		$callable_checksums = (array) get_option( self::CALLABLES_CHECKSUM_OPTION_NAME, array() );
+		$callable_checksums = (array) Jetpack_Options::get_raw_option( self::CALLABLES_CHECKSUM_OPTION_NAME, array() );
 
 		// only send the callables that have changed
 		foreach ( $callables as $name => $value ) {
@@ -166,7 +166,7 @@ public function maybe_sync_callables() {
 				$callable_checksums[ $name ] = $checksum;
 			}
 		}
-		update_option( self::CALLABLES_CHECKSUM_OPTION_NAME, $callable_checksums );
+		Jetpack_Options::update_raw_option( self::CALLABLES_CHECKSUM_OPTION_NAME, $callable_checksums );
 	}
 
 	public function expand_callables( $args ) {