Bootstrap/Load: Add support for custom ports in multisite site addres…

…ses.

This allows a Multisite network to use an address that includes a port name, such as `example.com:1234`, and adds support for this to the local development environment too. You can now run a Multisite installation on the local development environment, for example at `localhost:8889`.

This also fixes some bugs with running a single site installation on a port, and updates the testing infrastructure so that the whole test suite runs both with and without a port number.

Props djzone, scribu, nacin, ipstenu, F J Kaiser, jeremyfelt, johnjamesjacoby, spacedmonkey, PerS, Clorith, Blackbam, enrico.sorcinelli, Jules Colle, obliviousharmony, desrosj, johnbillion

Fixes #21077, #52088

git-svn-id: https://develop.svn.wordpress.org/trunk@58097 602fd350-edb4-49c9-b593-d223f7449a82

.env

@@ -53,13 +53,17 @@ LOCAL_DB_TYPE=mysql
 ##
 LOCAL_DB_VERSION=8.0
 
+# Whether or not to enable multisite.
+LOCAL_MULTISITE=false
+
 # The debug settings to add to `wp-config.php`.
 LOCAL_WP_DEBUG=true
 LOCAL_WP_DEBUG_LOG=true
 LOCAL_WP_DEBUG_DISPLAY=true
 LOCAL_SCRIPT_DEBUG=true
 LOCAL_WP_ENVIRONMENT_TYPE=local
 LOCAL_WP_DEVELOPMENT_MODE=core
+LOCAL_WP_TESTS_DOMAIN=example.org
 
 # The URL to use when running e2e tests.
 WP_BASE_URL=http://localhost:${LOCAL_PORT}

.github/workflows/phpunit-tests-run.yml

@@ -40,6 +40,11 @@ on:
  required: false
  type: 'string'
  default: 'phpunit.xml.dist'
+ tests-domain:
+ description: 'The domain to use for the tests'
+ required: false
+ type: 'string'
+ default: 'example.org'
  report:
  description: 'Whether to report results to WordPress.org Hosting Tests'
  required: false
@@ -50,6 +55,7 @@ env:
  LOCAL_DB_TYPE: ${{ inputs.db-type }}
  LOCAL_DB_VERSION: ${{ inputs.db-version }}
  LOCAL_PHP_MEMCACHED: ${{ inputs.memcached }}
+ LOCAL_WP_TESTS_DOMAIN: ${{ inputs.tests-domain }}
  PHPUNIT_CONFIG: ${{ inputs.phpunit-config }}
  PUPPETEER_SKIP_DOWNLOAD: ${{ true }}
 
@@ -74,7 +80,7 @@ jobs:
  # - Checks out the WordPress Test reporter repository.
  # - Submit the test results to the WordPress.org host test results.
  phpunit-tests:
- name: PHP ${{ inputs.php }} / ${{ 'mariadb' == inputs.db-type && 'MariaDB' || 'MySQL' }} ${{ inputs.db-version }}${{ inputs.multisite && ' multisite' || '' }}${{ inputs.memcached && ' with memcached' || '' }}${{ inputs.report && ' (test reporting enabled)' || '' }}
+ name: PHP ${{ inputs.php }} / ${{ 'mariadb' == inputs.db-type && 'MariaDB' || 'MySQL' }} ${{ inputs.db-version }}${{ inputs.multisite && ' multisite' || '' }}${{ inputs.memcached && ' with memcached' || '' }}${{ inputs.report && ' (test reporting enabled)' || '' }} ${{ 'example.org' != inputs.tests-domain && inputs.tests-domain || '' }}
  runs-on: ${{ inputs.os }}
  timeout-minutes: 20
 

.github/workflows/phpunit-tests.yml

@@ -48,6 +48,7 @@ jobs:
  php: [ '7.2', '7.3', '7.4', '8.0', '8.1', '8.2', '8.3' ]
  db-type: [ 'mysql' ]
  db-version: [ '5.7', '8.0', '8.1', '8.2', '8.3' ]
+ tests-domain: [ 'example.org' ]
  multisite: [ false, true ]
  memcached: [ false ]
 
@@ -57,19 +58,37 @@ jobs:
  php: '7.4'
  db-type: 'mysql'
  db-version: '5.7'
+ tests-domain: 'example.org'
  multisite: false
  memcached: true
  - os: ubuntu-latest
  php: '7.4'
  db-type: 'mysql'
  db-version: '5.7'
+ tests-domain: 'example.org'
  multisite: true
  memcached: true
+ # Include jobs with a port on the test domain for both single and multisite.
+ - os: ubuntu-latest
+ php: '7.4'
+ db-type: 'mysql'
+ db-version: '5.7'
+ tests-domain: 'example.org:8889'
+ multisite: false
+ memcached: false
+ - os: ubuntu-latest
+ php: '7.4'
+ db-type: 'mysql'
+ db-version: '5.7'
+ tests-domain: 'example.org:8889'
+ multisite: true
+ memcached: false
  # Report test results to the Host Test Results.
  - os: ubuntu-latest
  php: '7.4'
  db-type: 'mysql'
  db-version: '5.7'
+ tests-domain: 'example.org'
  multisite: false
  memcached: false
  report: true
@@ -81,6 +100,7 @@ jobs:
  multisite: ${{ matrix.multisite }}
  memcached: ${{ matrix.memcached }}
  phpunit-config: ${{ matrix.multisite && 'tests/phpunit/multisite.xml' || 'phpunit.xml.dist' }}
+ tests-domain: ${{ matrix.tests-domain }}
  report: ${{ matrix.report || false }}
 
  #

src/wp-admin/includes/network.php

@@ -148,26 +148,8 @@ function network_step1( $errors = false ) {
  die();
  }
 
- $hostname = get_clean_basedomain();
- $has_ports = strstr( $hostname, ':' );
- if ( ( false !== $has_ports && ! in_array( $has_ports, array( ':80', ':443' ), true ) ) ) {
- wp_admin_notice(
- '<strong>' . __( 'Error:' ) . '</strong> ' . __( 'You cannot install a network of sites with your server address.' ),
- array(
- 'additional_classes' => array( 'error' ),
- )
- );
-
- echo '<p>' . sprintf(
- /* translators: %s: Port number. */
- __( 'You cannot use port numbers such as %s.' ),
- '<code>' . $has_ports . '</code>'
- ) . '</p>';
- echo '<a href="' . esc_url( admin_url() ) . '">' . __( 'Go to Dashboard' ) . '</a>';
- echo '</div>';
- require_once ABSPATH . 'wp-admin/admin-footer.php';
- die();
- }
+ // Strip standard port from hostname.
+ $hostname = preg_replace( '/(?::80|:443)$/', '', get_clean_basedomain() );
 
  echo '<form method="post">';
 

src/wp-admin/network/site-info.php

@@ -66,8 +66,14 @@
  }
 
  $blog_data['scheme'] = $update_parsed_url['scheme'];
+
+ // Make sure to not lose the port if it was provided.
  $blog_data['domain'] = $update_parsed_url['host'];
- $blog_data['path'] = $update_parsed_url['path'];
+ if ( isset( $update_parsed_url['port'] ) ) {
+ $blog_data['domain'] .= ':' . $update_parsed_url['port'];
+ }
+
+ $blog_data['path'] = $update_parsed_url['path'];
  }
 
  $existing_details = get_site( $id );
@@ -88,16 +94,18 @@
 
  $old_home_url = trailingslashit( esc_url( get_option( 'home' ) ) );
  $old_home_parsed = parse_url( $old_home_url );
+ $old_home_host = $old_home_parsed['host'] . ( isset( $old_home_parsed['port'] ) ? ':' . $old_home_parsed['port'] : '' );
 
- if ( $old_home_parsed['host'] === $existing_details->domain && $old_home_parsed['path'] === $existing_details->path ) {
+ if ( $old_home_host === $existing_details->domain && $old_home_parsed['path'] === $existing_details->path ) {
  $new_home_url = untrailingslashit( sanitize_url( $blog_data['scheme'] . '://' . $new_details->domain . $new_details->path ) );
  update_option( 'home', $new_home_url );
  }
 
  $old_site_url = trailingslashit( esc_url( get_option( 'siteurl' ) ) );
  $old_site_parsed = parse_url( $old_site_url );
+ $old_site_host = $old_site_parsed['host'] . ( isset( $old_site_parsed['port'] ) ? ':' . $old_site_parsed['port'] : '' );
 
- if ( $old_site_parsed['host'] === $existing_details->domain && $old_site_parsed['path'] === $existing_details->path ) {
+ if ( $old_site_host === $existing_details->domain && $old_site_parsed['path'] === $existing_details->path ) {
  $new_site_url = untrailingslashit( sanitize_url( $blog_data['scheme'] . '://' . $new_details->domain . $new_details->path ) );
  update_option( 'siteurl', $new_site_url );
  }

src/wp-includes/embed.php

@@ -627,12 +627,13 @@ function get_oembed_response_data_for_url( $url, $args ) {
  wp_parse_url( $url ),
  array(
  'host' => '',
+ 'port' => null,
  'path' => '/',
  )
  );
 
  $qv = array(
- 'domain' => $url_parts['host'],
+ 'domain' => $url_parts['host'] . ( $url_parts['port'] ? ':' . $url_parts['port'] : '' ),
  'path' => '/',
  'update_site_meta_cache' => false,
  );

src/wp-includes/feed.php

@@ -660,8 +660,14 @@ function rss2_site_icon() {
  * @return string Correct link for the atom:self element.
  */
 function get_self_link() {
- $host = parse_url( home_url() );
- return set_url_scheme( 'http://' . $host['host'] . wp_unslash( $_SERVER['REQUEST_URI'] ) );
+ $parsed = parse_url( home_url() );
+
+ $domain = $parsed['host'];
+ if ( isset( $parsed['port'] ) ) {
+ $domain .= ':' . $parsed['port'];
+ }
+
+ return set_url_scheme( 'http://' . $domain . wp_unslash( $_SERVER['REQUEST_URI'] ) );
 }
 
 /**

src/wp-includes/media.php

@@ -1363,8 +1363,17 @@ function wp_calculate_image_srcset( $size_array, $image_src, $image_meta, $attac
  * If currently on HTTPS, prefer HTTPS URLs when we know they're supported by the domain
  * (which is to say, when they share the domain name of the current request).
  */
- if ( is_ssl() && ! str_starts_with( $image_baseurl, 'https' ) && parse_url( $image_baseurl, PHP_URL_HOST ) === $_SERVER['HTTP_HOST'] ) {
- $image_baseurl = set_url_scheme( $image_baseurl, 'https' );
+ if ( is_ssl() && ! str_starts_with( $image_baseurl, 'https' ) ) {
+ // Since the `Host:` header might contain a port we should
+ // compare it against the image URL using the same port.
+ $parsed = parse_url( $image_baseurl );
+ $domain = $parsed['host'];
+ if ( isset( $parsed['port'] ) ) {
+ $domain .= ':' . $parsed['port'];
+ }
+ if ( $_SERVER['HTTP_HOST'] === $domain ) {
+ $image_baseurl = set_url_scheme( $image_baseurl, 'https' );
+ }
  }
 
  /*

src/wp-includes/ms-site.php

@@ -524,11 +524,7 @@ function wp_prepare_site_data( $data, $defaults, $old_site = null ) {
 function wp_normalize_site_data( $data ) {
  // Sanitize domain if passed.
  if ( array_key_exists( 'domain', $data ) ) {
- $data['domain'] = trim( $data['domain'] );
- $data['domain'] = preg_replace( '/\s+/', '', sanitize_user( $data['domain'], true ) );
- if ( is_subdomain_install() ) {
- $data['domain'] = str_replace( '@', '', $data['domain'] );
- }
+ $data['domain'] = preg_replace( '/[^a-z0-9\-.:]+/i', '', $data['domain'] );
  }
 
  // Sanitize path if passed.

tests/phpunit/tests/admin/wpCommentsListTable.php

@@ -204,12 +204,12 @@ public function test_get_views_should_return_views_by_default() {
  $this->table->prepare_items();
 
  $expected = array(
- 'all' => '<a href="http://example.org/wp-admin/edit-comments.php?comment_status=all" class="current" aria-current="page">All <span class="count">(<span class="all-count">0</span>)</span></a>',
- 'mine' => '<a href="http://example.org/wp-admin/edit-comments.php?comment_status=mine&#038;user_id=0">Mine <span class="count">(<span class="mine-count">0</span>)</span></a>',
- 'moderated' => '<a href="http://example.org/wp-admin/edit-comments.php?comment_status=moderated">Pending <span class="count">(<span class="pending-count">0</span>)</span></a>',
- 'approved' => '<a href="http://example.org/wp-admin/edit-comments.php?comment_status=approved">Approved <span class="count">(<span class="approved-count">0</span>)</span></a>',
- 'spam' => '<a href="http://example.org/wp-admin/edit-comments.php?comment_status=spam">Spam <span class="count">(<span class="spam-count">0</span>)</span></a>',
- 'trash' => '<a href="http://example.org/wp-admin/edit-comments.php?comment_status=trash">Trash <span class="count">(<span class="trash-count">0</span>)</span></a>',
+ 'all' => '<a href="http://' . WP_TESTS_DOMAIN . '/wp-admin/edit-comments.php?comment_status=all" class="current" aria-current="page">All <span class="count">(<span class="all-count">0</span>)</span></a>',
+ 'mine' => '<a href="http://' . WP_TESTS_DOMAIN . '/wp-admin/edit-comments.php?comment_status=mine&#038;user_id=0">Mine <span class="count">(<span class="mine-count">0</span>)</span></a>',
+ 'moderated' => '<a href="http://' . WP_TESTS_DOMAIN . '/wp-admin/edit-comments.php?comment_status=moderated">Pending <span class="count">(<span class="pending-count">0</span>)</span></a>',
+ 'approved' => '<a href="http://' . WP_TESTS_DOMAIN . '/wp-admin/edit-comments.php?comment_status=approved">Approved <span class="count">(<span class="approved-count">0</span>)</span></a>',
+ 'spam' => '<a href="http://' . WP_TESTS_DOMAIN . '/wp-admin/edit-comments.php?comment_status=spam">Spam <span class="count">(<span class="spam-count">0</span>)</span></a>',
+ 'trash' => '<a href="http://' . WP_TESTS_DOMAIN . '/wp-admin/edit-comments.php?comment_status=trash">Trash <span class="count">(<span class="trash-count">0</span>)</span></a>',
  );
  $this->assertSame( $expected, $this->table->get_views() );
  }

tests/phpunit/tests/admin/wpPostCommentsListTable.php

@@ -26,12 +26,12 @@ public function test_get_views_should_return_views_by_default() {
  $this->table->prepare_items();
 
  $expected = array(
- 'all' => '<a href="http://example.org/wp-admin/edit-comments.php?comment_status=all" class="current" aria-current="page">All <span class="count">(<span class="all-count">0</span>)</span></a>',
- 'mine' => '<a href="http://example.org/wp-admin/edit-comments.php?comment_status=mine&#038;user_id=0">Mine <span class="count">(<span class="mine-count">0</span>)</span></a>',
- 'moderated' => '<a href="http://example.org/wp-admin/edit-comments.php?comment_status=moderated">Pending <span class="count">(<span class="pending-count">0</span>)</span></a>',
- 'approved' => '<a href="http://example.org/wp-admin/edit-comments.php?comment_status=approved">Approved <span class="count">(<span class="approved-count">0</span>)</span></a>',
- 'spam' => '<a href="http://example.org/wp-admin/edit-comments.php?comment_status=spam">Spam <span class="count">(<span class="spam-count">0</span>)</span></a>',
- 'trash' => '<a href="http://example.org/wp-admin/edit-comments.php?comment_status=trash">Trash <span class="count">(<span class="trash-count">0</span>)</span></a>',
+ 'all' => '<a href="http://' . WP_TESTS_DOMAIN . '/wp-admin/edit-comments.php?comment_status=all" class="current" aria-current="page">All <span class="count">(<span class="all-count">0</span>)</span></a>',
+ 'mine' => '<a href="http://' . WP_TESTS_DOMAIN . '/wp-admin/edit-comments.php?comment_status=mine&#038;user_id=0">Mine <span class="count">(<span class="mine-count">0</span>)</span></a>',
+ 'moderated' => '<a href="http://' . WP_TESTS_DOMAIN . '/wp-admin/edit-comments.php?comment_status=moderated">Pending <span class="count">(<span class="pending-count">0</span>)</span></a>',
+ 'approved' => '<a href="http://' . WP_TESTS_DOMAIN . '/wp-admin/edit-comments.php?comment_status=approved">Approved <span class="count">(<span class="approved-count">0</span>)</span></a>',
+ 'spam' => '<a href="http://' . WP_TESTS_DOMAIN . '/wp-admin/edit-comments.php?comment_status=spam">Spam <span class="count">(<span class="spam-count">0</span>)</span></a>',
+ 'trash' => '<a href="http://' . WP_TESTS_DOMAIN . '/wp-admin/edit-comments.php?comment_status=trash">Trash <span class="count">(<span class="trash-count">0</span>)</span></a>',
  );
  $this->assertSame( $expected, $this->table->get_views() );
  }

tests/phpunit/tests/admin/wpPrivacyRequestsTable.php

@@ -200,7 +200,7 @@ public function data_columns_should_be_sortable() {
  */
  public function test_get_views_should_return_views_by_default() {
  $expected = array(
- 'all' => '<a href="http://example.org/wp-admin/export-personal-data.php" class="current" aria-current="page">All <span class="count">(0)</span></a>',
+ 'all' => '<a href="http://' . WP_TESTS_DOMAIN . '/wp-admin/export-personal-data.php" class="current" aria-current="page">All <span class="count">(0)</span></a>',
  );
 
  $this->assertSame( $expected, $this->get_mocked_class_instance()->get_views() );

tests/phpunit/tests/date/getPermalink.php

@@ -35,10 +35,10 @@ public function test_should_return_correct_date_permalink_with_changed_time_zone
  )
  );
 
- $this->assertSame( 'http://example.org/2018/07/22/21/13/23', get_permalink( $post_id ) );
+ $this->assertSame( 'http://' . WP_TESTS_DOMAIN . '/2018/07/22/21/13/23', get_permalink( $post_id ) );
 
  // phpcs:ignore WordPress.DateTime.RestrictedFunctions.timezone_change_date_default_timezone_set
  date_default_timezone_set( $timezone );
- $this->assertSame( 'http://example.org/2018/07/22/21/13/23', get_permalink( $post_id ) );
+ $this->assertSame( 'http://' . WP_TESTS_DOMAIN . '/2018/07/22/21/13/23', get_permalink( $post_id ) );
  }
 }

tests/phpunit/tests/dependencies/scripts.php

@@ -495,6 +495,8 @@ protected function add_test_inline_script( $handle, $position ) {
  * @return array[]
  */
  public function data_provider_to_test_various_strategy_dependency_chains() {
+ $wp_tests_domain = WP_TESTS_DOMAIN;
+
  return array(
  'async-dependent-with-one-blocking-dependency' => array(
  'set_up' => function () {
@@ -881,8 +883,8 @@ public function data_provider_to_test_various_strategy_dependency_chains() {
  wp_enqueue_script( 'theme-functions', 'https://example.com/theme-functions.js', array( 'jquery' ), null, array( 'strategy' => 'defer' ) );
  },
  'expected_markup' => <<<HTML
-<script type='text/javascript' src='http://example.org/wp-includes/js/jquery/jquery.js' id='jquery-core-js' defer data-wp-strategy='defer'></script>
-<script type='text/javascript' src='http://example.org/wp-includes/js/jquery/jquery-migrate.js' id='jquery-migrate-js' defer data-wp-strategy='defer'></script>
+<script type='text/javascript' src='http://$wp_tests_domain/wp-includes/js/jquery/jquery.js' id='jquery-core-js' defer data-wp-strategy='defer'></script>
+<script type='text/javascript' src='http://$wp_tests_domain/wp-includes/js/jquery/jquery-migrate.js' id='jquery-migrate-js' defer data-wp-strategy='defer'></script>
 <script type='text/javascript' src='https://example.com/theme-functions.js' id='theme-functions-js' defer data-wp-strategy='defer'></script>
 HTML
  ,

tests/phpunit/tests/functions/referer.php

@@ -31,7 +31,9 @@ public function _fake_subfolder_install() {
  }
 
  public function filter_allowed_redirect_hosts( $hosts ) {
- $hosts[] = 'another.' . WP_TESTS_DOMAIN;
+ // Make sure we're only using the hostname and not anything else that might be in the WP_TESTS_DOMAIN.
+ $parsed = parse_url( 'http://' . WP_TESTS_DOMAIN );
+ $hosts[] = 'another.' . $parsed['host'];
 
  return $hosts;
  }

tests/phpunit/tests/functions/wpNonceAys.php

@@ -27,7 +27,7 @@ public function test_wp_nonce_ays() {
  */
  public function test_wp_nonce_ays_log_out() {
  $this->expectException( 'WPDieException' );
- $this->expectExceptionMessageMatches( '#You are attempting to log out of Test Blog</p><p>Do you really want to <a href="http://example\.org/wp-login\.php\?action=logout&amp;_wpnonce=.{10}">log out</a>\?#m' );
+ $this->expectExceptionMessageMatches( '#You are attempting to log out of Test Blog</p><p>Do you really want to <a href="http://' . WP_TESTS_DOMAIN . '/wp-login\.php\?action=logout&amp;_wpnonce=.{10}">log out</a>\?#m' );
  $this->expectExceptionCode( 403 );
 
  wp_nonce_ays( 'log-out' );

tests/phpunit/tests/general/feedLinksExtra.php

@@ -440,7 +440,7 @@ public function test_feed_links_extra_should_respect_comments_open() {
 
  $expected = '<link rel="alternate" type="application/rss+xml"';
  $expected .= ' title="Test Blog &raquo; Post with no comments Comments Feed"';
- $expected .= ' href="http://example.org/?feed=rss2&#038;p=' . self::$post_no_comment_id . '" />' . "\n";
+ $expected .= ' href="http://' . WP_TESTS_DOMAIN . '/?feed=rss2&#038;p=' . self::$post_no_comment_id . '" />' . "\n";
  $this->assertSame( $expected, get_echo( 'feed_links_extra' ) );
  }
 
@@ -455,7 +455,7 @@ public function test_feed_links_extra_should_respect_pings_open() {
 
  $expected = '<link rel="alternate" type="application/rss+xml"';
  $expected .= ' title="Test Blog &raquo; Post with no comments Comments Feed"';
- $expected .= ' href="http://example.org/?feed=rss2&#038;p=' . self::$post_no_comment_id . '" />' . "\n";
+ $expected .= ' href="http://' . WP_TESTS_DOMAIN . '/?feed=rss2&#038;p=' . self::$post_no_comment_id . '" />' . "\n";
  $this->assertSame( $expected, get_echo( 'feed_links_extra' ) );
  }
 
@@ -470,7 +470,7 @@ public function test_feed_links_extra_should_respect_post_comment_count() {
 
  $expected = '<link rel="alternate" type="application/rss+xml"';
  $expected .= ' title="Test Blog &raquo; Post with a comment Comments Feed"';
- $expected .= ' href="http://example.org/?feed=rss2&#038;p=' . self::$post_with_comment_id . '" />' . "\n";
+ $expected .= ' href="http://' . WP_TESTS_DOMAIN . '/?feed=rss2&#038;p=' . self::$post_with_comment_id . '" />' . "\n";
  $this->assertSame( $expected, get_echo( 'feed_links_extra' ) );
  }
 
@@ -507,7 +507,7 @@ static function () {
 
  $expected = '<link rel="alternate" type="testing/foo"';
  $expected .= ' title="Test Blog &raquo; Post with a comment Comments Feed"';
- $expected .= ' href="http://example.org/?feed=foo&#038;p=' . self::$post_with_comment_id . '" />' . "\n";
+ $expected .= ' href="http://' . WP_TESTS_DOMAIN . '/?feed=foo&#038;p=' . self::$post_with_comment_id . '" />' . "\n";
  $this->assertSame( $expected, get_echo( 'feed_links_extra' ) );
  }