Changeset 48523

Timestamp:

07/21/2020 12:55:20 AM (4 years ago)

Author:

whyisjake

Message:

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 #50643.
Props swissspidy, kraftbj, donmhico.

Location:

trunk

Files:

• src/wp-includes/sitemaps.php (modified) (2 diffs)
• src/wp-includes/sitemaps/class-wp-sitemaps.php (modified) (4 diffs)
• tests/phpunit/tests/sitemaps/sitemaps.php (modified) (1 diff)

trunk/src/wp-includes/sitemaps.php

@@ -18 +18 @@
  * @global WP_Sitemaps $wp_sitemaps Global Core Sitemaps instance.
  *
- * @return WP_Sitemaps|null Sitemaps instance, or null if sitemaps are disabled.
+ * @return WP_Sitemaps Sitemaps instance.
  */
 function wp_sitemaps_get_server() {
@@ -24 +24 @@
 
     $is_enabled = (bool) get_option( 'blog_public' );
-
-    /**
-     * 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;
-    }
 
     // If there isn't a global instance, set and bootstrap the sitemaps system.

trunk/src/wp-includes/sitemaps/class-wp-sitemaps.php

@@ -57 +57 @@
      * Initiates all sitemap functionality.
      *
+     * If sitemaps are disabled, only the rewrite rules will be registered
+     * by this method, in order to properly send 404s.
+     *
      * @since 5.5.0
      */
@@ -62 +65 @@
         // These will all fire on the init hook.
         $this->register_rewrites();
+
+        add_action( 'template_redirect', array( $this, 'render_sitemaps' ) );
+
+        if ( ! $this->sitemaps_enabled() ) {
+            return;
+        }
+
         $this->register_sitemaps();
 
         // Add additional action callbacks.
-        add_action( 'template_redirect', array( $this, 'render_sitemaps' ) );
         add_filter( 'pre_handle_404', array( $this, 'redirect_sitemapxml' ), 10, 2 );
         add_filter( 'robots_txt', array( $this, 'add_robots' ), 0, 2 );
+    }
+
+    /**
+     * 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 );
     }
 
@@ -156 +191 @@
         }
 
+        if ( ! $this->sitemaps_enabled() ) {
+            $wp_query->set_404();
+            status_header( 404 );
+            return;
+        }
+
         // Render stylesheet if this is stylesheet route.
         if ( $stylesheet_type ) {
@@ -187 +228 @@
         if ( empty( $url_list ) ) {
             $wp_query->set_404();
+            status_header( 404 );
             return;
         }

trunk/tests/phpunit/tests/sitemaps/sitemaps.php

@@ -445 +445 @@
         $this->assertContains( $sitemap_string, $robots_text, 'Sitemap URL not prefixed with "\n".' );
     }
+
+    /**
+     * @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() );
+    }
 }