Bug: Fixes issues for content replacement for the site and media URLs

.changeset/tidy-toys-bake.md

@@ -0,0 +1,14 @@
+---
+'@faustwp/wordpress-plugin': minor
+---
+
+### Fixes
+
+- Fixes various issues with content replacement callback functions and replacing the site_url and media_urls
+- Fixed an issue with content replacement when media replacement was disabled and rewrites enabled, it was overwriting and updating the media URL to the frontend URL rather than leaving it as the original site URL
+
+
+### Added
+
+- Added 6.6 and 6.7 to Github Actions
+- Added 2 new filters for `faustwp_get_wp_site_urls` and `faustwp_get_wp_site_media_urls` to allow users add/remove/edit site and media URLS for the content replacement.

.github/workflows/unit-test-plugin.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-22.04
     strategy:
       matrix:
-        wordpress: [ '6.5', '6.4', '6.3', '6.2', '6.1' ]
+        wordpress: [ '6.7', '6.6', '6.5', '6.4', '6.3', '6.2', '6.1' ]
     steps:
       - name: Checkout
         uses: actions/checkout@v4

.gitignore

@@ -11,6 +11,9 @@ process.yml
 !.env.local.sample
 build/
 faustjs.code-workspace
+plugins/faustwp/.docker/plugins/akismet/
+plugins/faustwp/.docker/plugins/hello.php
+plugins/faustwp/.docker/plugins/index.php
 
 # Ignore the WordPress source where used by various development environments
 wordpress/

plugins/faustwp/docker-compose.yml

@@ -11,7 +11,7 @@ services:
     links:
       - db
     environment:
-      WP_VERSION: ${WP_VERSION:-6.5}
+      WP_VERSION: ${WP_VERSION:-6.7}
       WORDPRESS_DB_HOST: db
       WORDPRESS_DB_NAME: wordpress
       WORDPRESS_DB_USER: root

plugins/faustwp/includes/replacement/callbacks.php

@@ -31,36 +31,42 @@
  *
  * @return string The post content.
  */
-function content_replacement( $content ) {
-	$use_wp_domain_for_permalinks = ! domain_replacement_enabled();
-	$use_wp_domain_for_media      = use_wp_domain_for_media();
+function content_replacement( string $content ): string {
 
-	if ( $use_wp_domain_for_permalinks && $use_wp_domain_for_media ) {
+	if ( ! $content ) {
+		return '';
+	}
+
+	$replace_content_urls = domain_replacement_enabled();
+	$replace_media_urls   = ! use_wp_domain_for_media();
+
+	if ( ! $replace_content_urls && ! $replace_media_urls ) {
 		return $content;
 	}
 
-	$replacement = faustwp_get_setting( 'frontend_uri' );
-	if ( ! $replacement ) {
-		$replacement = '/';
+	$wp_site_urls = faustwp_get_wp_site_urls();
+	if ( empty( $wp_site_urls ) ) {
+		return $content;
 	}
 
-	$site_url  = site_url();
-	$media_dir = str_replace( $site_url, '', wp_upload_dir()['baseurl'] );
-	$media_url = $site_url . $media_dir;
+	$wp_media_urls       = faustwp_get_wp_media_urls();
+	$relative_upload_url = faustwp_get_relative_upload_url( $wp_site_urls );
+	$frontend_uri        = faustwp_get_setting( 'frontend_uri' );
+	if ( ! $frontend_uri ) {
+		$frontend_uri = '/';
+	}
 
-	if ( $use_wp_domain_for_permalinks && ! $use_wp_domain_for_media ) {
-		$content = str_replace( $media_url, $replacement . $media_dir, $content );
-		return $content;
+	if ( $replace_content_urls && $replace_media_urls ) {
+		return str_replace( $wp_site_urls, $frontend_uri, $content );
 	}
 
-	if ( ! $use_wp_domain_for_permalinks && ! $use_wp_domain_for_media ) {
-		$content = str_replace( $site_url, $replacement, $content );
-		return $content;
+	if ( $replace_media_urls ) {
+		return faustwp_replace_media_url( $content, $wp_media_urls, $frontend_uri . $relative_upload_url );
 	}
 
-	if ( ! $use_wp_domain_for_permalinks && $use_wp_domain_for_media ) {
-		$content = preg_replace( "#{$site_url}(?!{$media_dir})#", "{$replacement}", $content );
-		return $content;
+	foreach ( $wp_site_urls as $site_url ) {
+		$pattern_exclude_media_urls = '#' . preg_quote( $site_url, '#' ) . "(?!{$relative_upload_url}(\/|$))#";
+		$content                    = preg_replace( $pattern_exclude_media_urls, $frontend_uri, $content );
 	}
 
 	return $content;
@@ -86,6 +92,7 @@ function image_source_replacement( $content ) {
 		"#src=\"{$frontend_uri}/#",
 		'#src="/#',
 	);
+
 	return preg_replace( $patterns, "src=\"{$site_url}/", $content );
 }
 
@@ -95,40 +102,43 @@ function image_source_replacement( $content ) {
  *
  * @param array $sources One or more arrays of source data to include in the 'srcset'.
  *
- * @return string One or more arrays of source data.
+ * @return array One or more arrays of source data.
  */
 function image_source_srcset_replacement( $sources ) {
-	$use_wp_domain_for_media = use_wp_domain_for_media();
-	$frontend_uri            = faustwp_get_setting( 'frontend_uri' );
-	$site_url                = site_url();
-
-	/**
-	 * For urls with no domain or the frontend domain, replace with the WP site_url.
-	 * This was the default replacement pattern until Faust 1.2, at which point this
-	 * was adjusted to correct replacement bugs.
-	 */
-	$patterns = array(
-		"#^{$site_url}/#",
+
+	if ( ! is_array( $sources ) || empty( $sources ) ) {
+		return $sources;
+	}
+
+	$replace_media_urls = ! use_wp_domain_for_media();
+	$wp_site_urls       = faustwp_get_wp_site_urls();
+	if ( empty( $wp_site_urls ) ) {
+		return $sources;
+	}
+
+	$wp_media_urls       = faustwp_get_wp_media_urls();
+	$relative_upload_url = faustwp_get_relative_upload_url( $wp_site_urls );
+	$frontend_uri        = faustwp_get_setting( 'frontend_uri' );
+
+	$wp_media_site_url = $frontend_uri . $relative_upload_url;
+	$patterns          = array(
+		"#^{$frontend_uri}/#",
 		'#^/#',
 	);
 
-	$replacement = $frontend_uri;
+	foreach ( $sources as $width => $source ) {
+		if ( ! $replace_media_urls ) {
+			$sources[ $width ]['url'] = faustwp_replace_urls( $patterns, $wp_site_urls, $source['url'] );
 
-	/**
-	 * If using WP domain for media and a frontend URL is encountered, rewrite it to WP URL.
-	 */
-	if ( $use_wp_domain_for_media ) {
-		$patterns    = array(
-			"#^{$frontend_uri}/#",
-			'#^/#',
-		);
-		$replacement = $site_url;
-	}
+			continue;
+		}
 
-	if ( is_array( $sources ) ) {
-		foreach ( $sources as $width => $source ) {
-			$sources[ $width ]['url'] = preg_replace( $patterns, "$replacement/", $source['url'] );
+		if ( strpos( $source['url'], $relative_upload_url ) === 0 ) {
+			$sources[ $width ]['url'] = $frontend_uri . $source['url'];
+			continue;
 		}
+
+		$sources[ $width ]['url'] = faustwp_replace_media_url( $source['url'], $wp_media_urls, $wp_media_site_url );
 	}
 
 	return $sources;
@@ -240,7 +250,15 @@ function post_preview_link( $link, $post ) {
  */
 function post_link( $link ) {
 	global $pagenow;
-	$target_pages = array( 'admin-ajax.php', 'index.php', 'edit.php', 'post.php', 'post-new.php', 'upload.php', 'media-new.php' );
+	$target_pages = array(
+		'admin-ajax.php',
+		'index.php',
+		'edit.php',
+		'post.php',
+		'post-new.php',
+		'upload.php',
+		'media-new.php',
+	);
 
 	// phpcs:ignore WordPress.Security.NonceVerification.Missing -- Nonce verified in `is_ajax_generate_permalink_request()` and `is_wp_link_ajax_request()`.
 	if ( empty( $_POST ) && 'post-new.php' === $pagenow ) {
@@ -251,7 +269,7 @@ function post_link( $link ) {
 	if ( in_array( $pagenow, $target_pages, true )
 		&& is_ajax_generate_permalink_request()
 	) {
-			return $link;
+		return $link;
 	}
 
 	if (

plugins/faustwp/includes/replacement/functions.php

@@ -131,3 +131,106 @@ function is_wp_link_ajax_request(): bool {
 		&& ! empty( $_POST['action'] )
 		&& 'wp-link-ajax' === $_POST['action'] );
 }
+
+/**
+ * Get all site URLs for each possible HTTP protocol
+ */
+function faustwp_get_wp_site_urls() {
+
+	$site_url = site_url();
+	$host_url = wp_parse_url( $site_url, PHP_URL_HOST );
+
+	if ( ! is_string( $host_url ) ) {
+		return apply_filters( 'faustwp_get_wp_site_urls', array( $site_url ) );
+	}
+
+	$is_https = substr( $site_url, 0, 6 ) === 'https:';
+
+	return apply_filters(
+		'faustwp_get_wp_site_urls',
+		array(
+			$is_https ? "https://$host_url" : "http://$host_url",
+			$is_https ? "http://$host_url" : "https://$host_url",
+			"//$host_url",
+		)
+	);
+}
+
+/**
+ * Get all media urls based off the available site urls
+ *
+ * @return array
+ */
+function faustwp_get_wp_media_urls() {
+	$site_urls  = faustwp_get_wp_site_urls();
+	$upload_url = faustwp_get_relative_upload_url( $site_urls );
+
+	if ( ! is_string( $upload_url ) ) {
+		return apply_filters( 'faustwp_get_wp_site_media_urls', array() );
+	}
+
+	$media_urls = array();
+	foreach ( $site_urls as $site_url ) {
+		$media_urls[] = $site_url . $upload_url;
+	}
+
+	return apply_filters( 'faustwp_get_wp_site_media_urls', $media_urls );
+}
+
+
+/**
+ * Gets the relative wp-content upload URL.
+ *
+ * @param array<string> $site_urls An array of site URLs.
+ *
+ * @return string The relative upload URL.
+ */
+function faustwp_get_relative_upload_url( $site_urls ) {
+	$upload_dir = wp_upload_dir()['baseurl'];
+
+	foreach ( $site_urls as $site_url ) {
+		if ( false !== strpos( $upload_dir, $site_url ) ) {
+			return (string) str_replace( $site_url, '', $upload_dir );
+		}
+	}
+
+	return '';
+}
+
+/***
+ * Replaces the media URL for various media urls
+ *
+ * @param string $content The content to be updated with the new media URL.
+ * @param array  $wp_media_urls An array of media URLS.
+ * @param string $replace_url The media URL to be updated to.
+ *
+ * @return string The replaced string
+ */
+function faustwp_replace_media_url( string $content, array $wp_media_urls, string $replace_url ) {
+	return str_replace( $wp_media_urls, $replace_url, $content );
+}
+
+
+/**
+ * Replaces urls for multiple patterns
+ *
+ * @param array $patterns The array of patterns.
+ * @param mixed $wp_site_urls The array of site URLs.
+ * @param mixed $content The content to be updated.
+ *
+ * @return mixed The replaced content
+ */
+function faustwp_replace_urls( array $patterns, mixed $wp_site_urls, mixed $content ) {
+	$i = 0;
+
+	return preg_replace_callback(
+		$patterns,
+		function () use ( &$wp_site_urls, &$i ) {
+			$replacement = $wp_site_urls[ $i ] . '/';
+			$i++;
+
+			return $replacement;
+		},
+		$content
+	);
+}