<!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>[48532] trunk: Sitemaps: Correctly enforce maximum number of sitemaps in index.</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 { white-space: pre-line; 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/48532">48532</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/48532","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>swissspidy</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-07-21 13:55:45 +0000 (Tue, 21 Jul 2020)</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'>Sitemaps: Correctly enforce maximum number of sitemaps in index.
Before this change, the limit of 50k entries was enforced for the number of providers, not the amount of sitemaps all providers add to the index in total.
Props pbiron, swissspidy.
Fixes <a href="https://core.trac.wordpress.org/ticket/50666">#50666</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludessitemapsclasswpsitemapsindexphp">trunk/src/wp-includes/sitemaps/class-wp-sitemaps-index.php</a></li>
<li><a href="#trunksrcwpincludessitemapsclasswpsitemapsregistryphp">trunk/src/wp-includes/sitemaps/class-wp-sitemaps-registry.php</a></li>
<li><a href="#trunktestsphpunitincludesbootstrapphp">trunk/tests/phpunit/includes/bootstrap.php</a></li>
<li><a href="#trunktestsphpunittestssitemapssitemapsindexphp">trunk/tests/phpunit/tests/sitemaps/sitemaps-index.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunitincludesclasswpsitemapslargetestproviderphp">trunk/tests/phpunit/includes/class-wp-sitemaps-large-test-provider.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludessitemapsclasswpsitemapsindexphp"></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/sitemaps/class-wp-sitemaps-index.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/sitemaps/class-wp-sitemaps-index.php 2020-07-21 13:13:54 UTC (rev 48531)
+++ trunk/src/wp-includes/sitemaps/class-wp-sitemaps-index.php 2020-07-21 13:55:45 UTC (rev 48532)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -25,6 +25,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> protected $registry;
</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">+ * Maximum number of sitemaps to include in an index.
+ *
+ * @sincee 5.5.0
+ *
+ * @var int Maximum number of sitemaps.
+ */
+ private $max_sitemaps = 50000;
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * WP_Sitemaps_Index constructor.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.5.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -47,7 +56,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $providers = $this->registry->get_sitemaps();
</span><span class="cx" style="display: block; padding: 0 10px"> /* @var WP_Sitemaps_Provider $provider */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- foreach ( $providers as $provider ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ foreach ( $providers as $name => $provider ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $sitemap_entries = $provider->get_sitemap_entries();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Prevent issues with array_push and empty arrays on PHP < 7.3.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -57,9 +66,12 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Using array_push is more efficient than array_merge in a loop.
</span><span class="cx" style="display: block; padding: 0 10px"> array_push( $sitemaps, ...$sitemap_entries );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( count( $sitemaps ) >= $this->max_sitemaps ) {
+ break;
+ }
</ins><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">- return $sitemaps;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return array_slice( $sitemaps, 0, $this->max_sitemaps, true );
</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></pre></div>
<a id="trunksrcwpincludessitemapsclasswpsitemapsregistryphp"></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/sitemaps/class-wp-sitemaps-registry.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/sitemaps/class-wp-sitemaps-registry.php 2020-07-21 13:13:54 UTC (rev 48531)
+++ trunk/src/wp-includes/sitemaps/class-wp-sitemaps-registry.php 2020-07-21 13:55:45 UTC (rev 48532)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -25,15 +25,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> private $sitemaps = array();
</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">- * Maximum number of sitemaps to include in an index.
- *
- * @sincee 5.5.0
- *
- * @var int Maximum number of sitemaps.
- */
- private $max_sitemaps = 50000;
-
- /**
</del><span class="cx" style="display: block; padding: 0 10px"> * Adds a sitemap with route to the registry.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.5.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -69,7 +60,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"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Lists all registered sitemaps.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Returns all registered sitemap providers.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -76,12 +67,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return WP_Sitemaps_Provider[] Array of sitemap providers.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function get_sitemaps() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $total_sitemaps = count( $this->sitemaps );
-
- if ( $total_sitemaps > $this->max_sitemaps ) {
- return array_slice( $this->sitemaps, 0, $this->max_sitemaps, true );
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> return $this->sitemaps;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunitincludesbootstrapphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/includes/bootstrap.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/includes/bootstrap.php 2020-07-21 13:13:54 UTC (rev 48531)
+++ trunk/tests/phpunit/includes/bootstrap.php 2020-07-21 13:55:45 UTC (rev 48532)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -162,6 +162,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> require __DIR__ . '/class-wp-fake-block-type.php';
</span><span class="cx" style="display: block; padding: 0 10px"> require __DIR__ . '/class-wp-sitemaps-test-provider.php';
</span><span class="cx" style="display: block; padding: 0 10px"> require __DIR__ . '/class-wp-sitemaps-empty-test-provider.php';
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+require __DIR__ . '/class-wp-sitemaps-large-test-provider.php';
</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"> * A class to handle additional command line arguments passed to the script.
</span></span></pre></div>
<a id="trunktestsphpunitincludesclasswpsitemapslargetestproviderphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/includes/class-wp-sitemaps-large-test-provider.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/includes/class-wp-sitemaps-large-test-provider.php (rev 0)
+++ trunk/tests/phpunit/includes/class-wp-sitemaps-large-test-provider.php 2020-07-21 13:55:45 UTC (rev 48532)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,59 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * Class WP_Sitemaps_Large_Test_Provider.
+ *
+ * Provides test data for additional registered providers.
+ */
+class WP_Sitemaps_Large_Test_Provider extends WP_Sitemaps_Provider {
+ /**
+ * Number of entries in the sitemap the provider produces.
+ *
+ * @var integer
+ */
+ public $num_entries = 1;
+
+ /**
+ * WP_Sitemaps_Large_Test_Provider constructor.
+ *
+ * @param int $num_entries Optional. Number of entries in in the sitemap.
+ */
+ public function __construct( $num_entries = 50001 ) {
+ $this->name = 'tests';
+ $this->object_type = 'test';
+
+ $this->num_entries = $num_entries;
+ }
+
+ /**
+ * Gets a URL list for a sitemap.
+ *
+ * @param int $page_num Page of results.
+ * @param string $object_subtype Optional. Object subtype name. Default empty.
+ * @return array List of URLs for a sitemap.
+ */
+ public function get_url_list( $page_num, $object_subtype = '' ) {
+ return array_fill( 0, $this->num_entries, array( 'loc' => home_url( '/' ) ) );
+ }
+
+ /**
+ * Lists sitemap pages exposed by this provider.
+ *
+ * The returned data is used to populate the sitemap entries of the index.
+ *
+ * @return array[] Array of sitemap entries.
+ */
+ public function get_sitemap_entries() {
+ return array_fill( 0, $this->num_entries, array( 'loc' => home_url( '/' ) ) );
+ }
+
+ /**
+ * Query for determining the number of pages.
+ *
+ * @param string $object_subtype Optional. Object subtype. Default empty.
+ * @return int Total number of pages.
+ */
+ public function get_max_num_pages( $object_subtype = '' ) {
+ return $this->num_entries;
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/includes/class-wp-sitemaps-large-test-provider.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="trunktestsphpunittestssitemapssitemapsindexphp"></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/sitemaps/sitemaps-index.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/sitemaps/sitemaps-index.php 2020-07-21 13:13:54 UTC (rev 48531)
+++ trunk/tests/phpunit/tests/sitemaps/sitemaps-index.php 2020-07-21 13:55:45 UTC (rev 48532)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -20,6 +20,29 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertCount( 24, $sitemap_index->get_sitemap_list() );
</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">+ /**
+ * Test that a sitemap index won't contain more than 50000 sitemaps.
+ *
+ * @ticket 50666
+ */
+ public function test_get_sitemap_list_limit() {
+ $registry = new WP_Sitemaps_Registry();
+
+ // add 3 providers, which combined produce more than the maximum 50000 sitemaps in the index.
+ $registry->add_sitemap( 'provider_1', new WP_Sitemaps_Large_Test_Provider( 25000 ) );
+ $registry->add_sitemap( 'provider_2', new WP_Sitemaps_Large_Test_Provider( 25000 ) );
+ $registry->add_sitemap( 'provider_3', new WP_Sitemaps_Large_Test_Provider( 25000 ) );
+
+ $count = 0;
+ foreach ( $registry->get_sitemaps() as $provider ) {
+ $count += count( $provider->get_url_list( 1 ) );
+ }
+ $this->assertGreaterThan( 50000, $count );
+
+ $sitemap_index = new WP_Sitemaps_Index( $registry );
+ $this->assertCount( 50000, $sitemap_index->get_sitemap_list() );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_get_sitemap_list_no_entries() {
</span><span class="cx" style="display: block; padding: 0 10px"> $registry = new WP_Sitemaps_Registry();
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>