<!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>[48523] trunk: Sitemaps: Ensure correct HTTP status when sitemaps are disabled</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/48523">48523</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/48523","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>whyisjake</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-07-21 00:55:20 +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: Ensure correct HTTP status when sitemaps are disabled
If sitemaps are disabled, previously there would be a rewrite rule for the sitemap endpoint. This endpoint would display the homepage since there was a rewrite rule. Now, Sitemaps are loaded, and the proper HTTP headers are returned.
Fixes <a href="https://core.trac.wordpress.org/ticket/50643">#50643</a>.
Props swissspidy, kraftbj, donmhico.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludessitemapsclasswpsitemapsphp">trunk/src/wp-includes/sitemaps/class-wp-sitemaps.php</a></li>
<li><a href="#trunksrcwpincludessitemapsphp">trunk/src/wp-includes/sitemaps.php</a></li>
<li><a href="#trunktestsphpunittestssitemapssitemapsphp">trunk/tests/phpunit/tests/sitemaps/sitemaps.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludessitemapsclasswpsitemapsphp"></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.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.php 2020-07-21 00:41:35 UTC (rev 48522)
+++ trunk/src/wp-includes/sitemaps/class-wp-sitemaps.php 2020-07-21 00:55:20 UTC (rev 48523)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -56,20 +56,55 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Initiates all sitemap functionality.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * If sitemaps are disabled, only the rewrite rules will be registered
+ * by this method, in order to properly send 404s.
+ *
</ins><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="cx" style="display: block; padding: 0 10px"> public function init() {
</span><span class="cx" style="display: block; padding: 0 10px"> // These will all fire on the init hook.
</span><span class="cx" style="display: block; padding: 0 10px"> $this->register_rewrites();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ add_action( 'template_redirect', array( $this, 'render_sitemaps' ) );
+
+ if ( ! $this->sitemaps_enabled() ) {
+ return;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->register_sitemaps();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Add additional action callbacks.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- add_action( 'template_redirect', array( $this, 'render_sitemaps' ) );
</del><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'pre_handle_404', array( $this, 'redirect_sitemapxml' ), 10, 2 );
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'robots_txt', array( $this, 'add_robots' ), 0, 2 );
</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">+ * Determines whether sitemaps are enabled or not.
+ *
+ * @since 5.5.0
+ *
+ * @return bool Whether sitemaps are enabled.
+ */
+ public function sitemaps_enabled() {
+ $is_enabled = (bool) get_option( 'blog_public' );
+
+ /**
+ * Filters whether XML Sitemaps are enabled or not.
+ *
+ * When XML Sitemaps are disabled via this filter, rewrite rules are still
+ * in place to ensure a 404 is returned.
+ *
+ * @see WP_Sitemaps::register_rewrites()
+ *
+ * @since 5.5.0
+ *
+ * @param bool $is_enabled Whether XML Sitemaps are enabled or not. Defaults
+ * to true for public sites.
+ */
+ return (bool) apply_filters( 'wp_sitemaps_enabled', $is_enabled );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Registers and sets up the functionality for all supported sitemaps.
</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">@@ -155,6 +190,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</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">+ if ( ! $this->sitemaps_enabled() ) {
+ $wp_query->set_404();
+ status_header( 404 );
+ return;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Render stylesheet if this is stylesheet route.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $stylesheet_type ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $stylesheet = new WP_Sitemaps_Stylesheet();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -186,6 +227,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Force a 404 and bail early if no URLs are present.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $url_list ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $wp_query->set_404();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ status_header( 404 );
</ins><span class="cx" style="display: block; padding: 0 10px"> return;
</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="trunksrcwpincludessitemapsphp"></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.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/sitemaps.php 2020-07-21 00:41:35 UTC (rev 48522)
+++ trunk/src/wp-includes/sitemaps.php 2020-07-21 00:55:20 UTC (rev 48523)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -17,7 +17,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @global WP_Sitemaps $wp_sitemaps Global Core Sitemaps instance.
</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 WP_Sitemaps|null Sitemaps instance, or null if sitemaps are disabled.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return WP_Sitemaps Sitemaps instance.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_sitemaps_get_server() {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wp_sitemaps;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -24,19 +24,6 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $is_enabled = (bool) get_option( 'blog_public' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /**
- * Filters whether XML Sitemaps are enabled or not.
- *
- * @since 5.5.0
- *
- * @param bool $is_enabled Whether XML Sitemaps are enabled or not. Defaults to true for public sites.
- */
- $is_enabled = (bool) apply_filters( 'wp_sitemaps_enabled', $is_enabled );
-
- if ( ! $is_enabled ) {
- return null;
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> // If there isn't a global instance, set and bootstrap the sitemaps system.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $wp_sitemaps ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $wp_sitemaps = new WP_Sitemaps();
</span></span></pre></div>
<a id="trunktestsphpunittestssitemapssitemapsphp"></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.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/sitemaps/sitemaps.php 2020-07-21 00:41:35 UTC (rev 48522)
+++ trunk/tests/phpunit/tests/sitemaps/sitemaps.php 2020-07-21 00:55:20 UTC (rev 48523)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -444,4 +444,49 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertContains( $sitemap_string, $robots_text, 'Sitemap URL not prefixed with "\n".' );
</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 50643
+ */
+ public function test_sitemaps_enabled() {
+ $before = wp_sitemaps_get_server()->sitemaps_enabled();
+ add_filter( 'wp_sitemaps_enabled', '__return_false' );
+ $after = wp_sitemaps_get_server()->sitemaps_enabled();
+ remove_filter( 'wp_sitemaps_enabled', '__return_false' );
+
+ $this->assertTrue( $before );
+ $this->assertFalse( $after );
+ }
+
+ /**
+ * @ticket 50643
+ * @runInSeparateProcess
+ * @preserveGlobalState disabled
+ */
+ public function test_disable_sitemap_should_return_404() {
+ add_filter( 'wp_sitemaps_enabled', '__return_false' );
+
+ $this->go_to( home_url( '/?sitemap=index' ) );
+
+ wp_sitemaps_get_server()->render_sitemaps();
+
+ remove_filter( 'wp_sitemaps_enabled', '__return_false' );
+
+ $this->assertTrue( is_404() );
+ }
+
+ /**
+ * @ticket 50643
+ * @runInSeparateProcess
+ * @preserveGlobalState disabled
+ */
+ public function test_empty_url_list_should_return_404() {
+ wp_register_sitemap( 'foo', new WP_Sitemaps_Empty_Test_Provider( 'foo' ) );
+
+ $this->go_to( home_url( '/?sitemap=foo' ) );
+
+ wp_sitemaps_get_server()->render_sitemaps();
+
+ $this->assertTrue( is_404() );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>