<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[40102] trunk: Multisite: Use `WP_Network_Query` in `WP_Network::get_by_path()`.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/40102">40102</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/40102","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>flixos90</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-02-22 10:41:20 +0000 (Wed, 22 Feb 2017)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Multisite: Use `WP_Network_Query` in `WP_Network::get_by_path()`.
An additional unit test has been introduced to verify the method works properly when using an external object cache.
Props spacedmonkey, jeremyfelt.
Fixes <a href="https://core.trac.wordpress.org/ticket/37217">#37217</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpnetworkphp">trunk/src/wp-includes/class-wp-network.php</a></li>
<li><a href="#trunktestsphpunittestsmultisitebootstrapphp">trunk/tests/phpunit/tests/multisite/bootstrap.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpnetworkphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-network.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-network.php 2017-02-21 18:17:32 UTC (rev 40101)
+++ trunk/src/wp-includes/class-wp-network.php 2017-02-22 10:41:20 UTC (rev 40102)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -267,8 +267,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return WP_Network|bool Network object if successful. False when no network is found.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public static function get_by_path( $domain = '', $path = '', $segments = null ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- global $wpdb;
-
</del><span class="cx" style="display: block; padding: 0 10px"> $domains = array( $domain );
</span><span class="cx" style="display: block; padding: 0 10px"> $pieces = explode( '.', $domain );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -295,7 +293,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( wp_using_ext_object_cache() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $using_paths = wp_cache_get( 'networks_have_paths', 'site-options' );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( false === $using_paths ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $using_paths = (int) $wpdb->get_var( "SELECT id FROM {$wpdb->site} WHERE path <> '/' LIMIT 1" );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $using_paths = get_networks( array(
+ 'number' => 1,
+ 'count' => true,
+ 'path__not_in' => '/',
+ ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> wp_cache_add( 'networks_have_paths', $using_paths, 'site-options' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -353,35 +355,31 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $pre;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // @todo Consider additional optimization routes, perhaps as an opt-in for plugins.
- // We already have paths covered. What about how far domains should be drilled down (including www)?
-
- $search_domains = "'" . implode( "', '", $wpdb->_escape( $domains ) ) . "'";
-
</del><span class="cx" style="display: block; padding: 0 10px"> if ( ! $using_paths ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $network = $wpdb->get_row( "
- SELECT * FROM {$wpdb->site}
- WHERE domain IN ({$search_domains})
- ORDER BY CHAR_LENGTH(domain)
- DESC LIMIT 1
- " );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $networks = get_networks( array(
+ 'number' => 1,
+ 'orderby' => array(
+ 'domain_length' => 'DESC',
+ ),
+ 'domain__in' => $domains,
+ ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! empty( $network ) && ! is_wp_error( $network ) ) {
- return new WP_Network( $network );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! empty( $networks ) ) {
+ return array_shift( $networks );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
- } else {
- $search_paths = "'" . implode( "', '", $wpdb->_escape( $paths ) ) . "'";
- $networks = $wpdb->get_results( "
- SELECT * FROM {$wpdb->site}
- WHERE domain IN ({$search_domains})
- AND path IN ({$search_paths})
- ORDER BY CHAR_LENGTH(domain) DESC, CHAR_LENGTH(path) DESC
- " );
</del><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $networks = get_networks( array(
+ 'orderby' => array(
+ 'domain_length' => 'DESC',
+ 'path_length' => 'DESC',
+ ),
+ 'domain__in' => $domains,
+ 'path__in' => $paths,
+ ) );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /*
</span><span class="cx" style="display: block; padding: 0 10px"> * Domains are sorted by length of domain, then by length of path.
</span><span class="cx" style="display: block; padding: 0 10px"> * The domain must match for the path to be considered. Otherwise,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -402,7 +400,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( true === $found ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return new WP_Network( $network );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return $network;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span></span></pre></div>
<a id="trunktestsphpunittestsmultisitebootstrapphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/multisite/bootstrap.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/multisite/bootstrap.php 2017-02-21 18:17:32 UTC (rev 40101)
+++ trunk/tests/phpunit/tests/multisite/bootstrap.php 2017-02-22 10:41:20 UTC (rev 40102)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -17,6 +17,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'wordpress.org/' => array( 'domain' => 'wordpress.org', 'path' => '/' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'make.wordpress.org/' => array( 'domain' => 'make.wordpress.org', 'path' => '/' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'wordpress.org/one/' => array( 'domain' => 'wordpress.org', 'path' => '/one/' ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'wordpress.org/one/b/' => array( 'domain' => 'wordpress.org', 'path' => '/one/b/' ),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'wordpress.net/' => array( 'domain' => 'wordpress.net', 'path' => '/' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'www.wordpress.net/' => array( 'domain' => 'www.wordpress.net', 'path' => '/' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'www.wordpress.net/two/' => array( 'domain' => 'www.wordpress.net', 'path' => '/two/' ),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -80,15 +81,74 @@
</span><span class="cx" style="display: block; padding: 0 10px"> array( 'wordpress.net/', 'wordpress.net', '/notapath/', 'A missing path on a top level domain should find the correct network.' ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( 'www.wordpress.net/', 'www.wordpress.net', '/notapath/', 'A missing path should find the correct network.' ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( 'wordpress.org/one/', 'www.wordpress.org', '/one/', 'Should find the path despite the www.' ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ array( 'wordpress.org/one/', 'wordpress.org', '/one/page/', 'A request with two path segments should find the correct network.' ),
+ array( 'wordpress.org/one/b/', 'wordpress.org', '/one/b/', 'A request with two valid path segments should find the correct network.' ),
</ins><span class="cx" style="display: block; padding: 0 10px"> array( 'wordpress.org/', 'site1.wordpress.org', '/one/', 'Should not find path because domains do not match.' ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( 'wordpress.net/three/', 'wordpress.net', '/three/', 'A network can have a path.' ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( 'www.wordpress.net/two/', 'www.wordpress.net', '/two/', 'A www network with a path can coexist with a non-www network.' ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( 'wordpress.net/', 'site1.wordpress.net', '/notapath/', 'An invalid subdomain should find the top level network domain.' ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( 'wordpress.net/', 'site1.wordpress.net', '/three/', 'An invalid subdomain and path should find the top level network domain.' ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ array( 'wordpress.net/', 'x.y.wordpress.net', '/', 'An invalid two level subdomain should find the top level network domain.' ),
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @ticket 37217
+ * @dataProvider data_get_network_by_path_not_using_paths
+ *
+ * @param string $expected_key The array key associated with expected data for the test.
+ * @param string $domain The requested domain.
+ * @param string $path The requested path.
+ * @param string $message The message to pass for failed tests.
+ */
+ public function test_get_network_by_path_not_using_paths( $expected_key, $domain, $path, $message ) {
+ if ( ! wp_using_ext_object_cache() ) {
+ $this->markTestSkipped( 'Only testable with an external object cache.' );
+ }
+
+ // Temporarily store original object cache and using paths values.
+ $using_paths_orig = wp_cache_get( 'networks_have_paths', 'site-options' );
+
+ wp_cache_set( 'networks_have_paths', 0, 'site-options' );
+
+ $network = get_network_by_path( $domain, $path );
+
+ // Restore original object cache and using paths values.
+ wp_cache_set( 'networks_have_paths', $using_paths_orig, 'site-options' );
+
+ $this->assertEquals( self::$network_ids[ $expected_key ], $network->id, $message );
+ }
+
+ public function data_get_network_by_path_not_using_paths() {
+ return array(
+ array( 'wordpress.org/', 'wordpress.org', '/', 'A standard domain and path request should work.' ),
+ array( 'wordpress.net/', 'wordpress.net', '/notapath/', 'A network matching a top level domain should be found regardless of path.' ),
+ array( 'www.wordpress.net/', 'www.wordpress.net', '/notapath/', 'A network matching a domain should be found regardless of path.' ),
+ array( 'wordpress.org/', 'www.wordpress.org', '/one/', 'Should find the network despite the www and regardless of path.' ),
+ array( 'wordpress.org/', 'site1.wordpress.org', '/one/', 'Should find the network with the corresponding top level domain regardless of path.' ),
+ array( 'www.wordpress.net/', 'www.wordpress.net', '/two/', 'A www network can coexist with a non-www network.' ),
+ array( 'make.wordpress.org/', 'make.wordpress.org', '/notapath/', 'A subdomain network should be found regardless of path.' ),
+ array( 'wordpress.net/', 'x.y.wordpress.net', '/', 'An invalid two level subdomain should find the top level network domain.' ),
+ );
+ }
+
+ /**
+ * Even if a matching network is available, it should not match if the the filtered
+ * value for network path segments is fewer than the number of paths passed.
+ */
+ public function test_get_network_by_path_with_forced_single_path_segment_returns_single_path_network() {
+ add_filter( 'network_by_path_segments_count', array( $this, 'filter_network_path_segments' ) );
+ $network = get_network_by_path( 'wordpress.org', '/one/b/' );
+ remove_filter( 'network_by_path_segments_count', array( $this, 'filter_network_path_segments' ) );
+
+ $this->assertEquals( self::$network_ids[ 'wordpress.org/one/' ], $network->id );
+ }
+
+ public function filter_network_path_segments() {
+ return 1;
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 27003
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 27927
</span><span class="cx" style="display: block; padding: 0 10px"> * @dataProvider data_get_site_by_path
</span></span></pre>
</div>
</div>
</body>
</html>