Changeset 59938

Timestamp:

03/05/2025 10:15:09 PM (2 weeks ago)

Author:

flixos90

Message:

Editor: Fix block type and block metadata collection registration issues on Windows due to lack of path normalization.

Props flixos90, gziolo, joemcgill.
Fixes #63027.

Location:

trunk

Files:

• src/wp-includes/blocks.php (modified) (1 diff)
• src/wp-includes/class-wp-block-metadata-registry.php (modified) (9 diffs)
• tests/phpunit/tests/blocks/register.php (modified) (1 diff)
• tests/phpunit/tests/blocks/wpBlockMetadataRegistry.php (modified) (1 diff)

trunk/src/wp-includes/blocks.php

@@ -446 +446 @@
      */
 
+    $file_or_folder = wp_normalize_path( $file_or_folder );
+
     $metadata_file = ( ! str_ends_with( $file_or_folder, 'block.json' ) ) ?
         trailingslashit( $file_or_folder ) . 'block.json' :
         $file_or_folder;
 
-    $is_core_block        = str_starts_with( $file_or_folder, ABSPATH . WPINC );
+    $is_core_block        = str_starts_with( $file_or_folder, wp_normalize_path( ABSPATH . WPINC ) );
     $metadata_file_exists = $is_core_block || file_exists( $metadata_file );
     $registry_metadata    = WP_Block_Metadata_Registry::get_metadata( $file_or_folder );

trunk/src/wp-includes/class-wp-block-metadata-registry.php

@@ -83 +83 @@
      */
     public static function register_collection( $path, $manifest ) {
-        $path = wp_normalize_path( rtrim( $path, '/' ) );
+        $path = rtrim( wp_normalize_path( $path ), '/' );
 
         $collection_roots = self::get_default_collection_roots();
@@ -113 +113 @@
             array_map(
                 static function ( $allowed_root ) {
-                    return rtrim( $allowed_root, '/' );
+                    return rtrim( wp_normalize_path( $allowed_root ), '/' );
                 },
                 $collection_roots
@@ -162 +162 @@
      */
     public static function get_metadata( $file_or_folder ) {
+        $file_or_folder = wp_normalize_path( $file_or_folder );
+
         $path = self::find_collection_path( $file_or_folder );
         if ( ! $path ) {
@@ -195 +197 @@
      */
     public static function get_collection_block_metadata_files( $path ) {
-        $path = wp_normalize_path( rtrim( $path, '/' ) );
+        $path = rtrim( wp_normalize_path( $path ), '/' );
 
         if ( ! isset( self::$collections[ $path ] ) ) {
@@ -214 +216 @@
 
         return array_map(
+            // No normalization necessary since `$path` is already normalized and `$block_name` is just a folder name.
             static function ( $block_name ) use ( $path ) {
                 return "{$path}/{$block_name}/block.json";
@@ -226 +229 @@
      * @since 6.7.0
      *
-     * @param string $file_or_folder The path to the file or folder.
-     * @return string|null The collection path if found, or null if not found.
+     * @param string $file_or_folder The normalized path to the file or folder.
+     * @return string|null The normalized collection path if found, or null if not found.
      */
     private static function find_collection_path( $file_or_folder ) {
@@ -235 +238 @@
 
         // Check the last matched collection first, since block registration usually happens in batches per plugin or theme.
-        $path = wp_normalize_path( rtrim( $file_or_folder, '/' ) );
+        $path = rtrim( $file_or_folder, '/' );
         if ( self::$last_matched_collection && str_starts_with( $path, self::$last_matched_collection ) ) {
             return self::$last_matched_collection;
@@ -280 +283 @@
      * @since 6.7.0
      *
-     * @param string $path The file or folder path to determine the block identifier from.
+     * @param string $path The normalized file or folder path to determine the block identifier from.
      * @return string The block identifier, or an empty string if the path is empty.
      */
@@ -303 +306 @@
      * @since 6.7.2
      *
-     * @param string   $path             Block metadata collection path, without trailing slash.
-     * @param string[] $collection_roots List of collection root paths, without trailing slashes.
+     * @param string   $path             Normalized block metadata collection path, without trailing slash.
+     * @param string[] $collection_roots List of normalized collection root paths, without trailing slashes.
      * @return bool True if the path is allowed, false otherwise.
      */

trunk/tests/phpunit/tests/blocks/register.php

@@ -1502 +1502 @@
         );
     }
+
+    /**
+     * @ticket 63027
+     *
+     * @covers ::register_block_type_from_metadata
+     */
+    public function test_register_block_type_from_metadata_with_windows_path() {
+        $windows_like_path = str_replace( '/', '\\', DIR_TESTDATA ) . '\\blocks\\notice';
+
+        $this->assertNotFalse( register_block_type_from_metadata( $windows_like_path ) );
+    }
 }

trunk/tests/phpunit/tests/blocks/wpBlockMetadataRegistry.php

@@ -221 +221 @@
         );
     }
+
+    /**
+     * Tests that `register_collection()`, `get_metadata()`, and `get_collection_metadata_files()` handle Windows paths.
+     *
+     * @ticket 63027
+     * @covers ::register_collection
+     * @covers ::get_metadata
+     * @covers ::get_collection_metadata_files
+     */
+    public function test_with_windows_paths() {
+        // Set up a mock manifest file.
+        $manifest_data = array(
+            'test-block' => array(
+                'name'  => 'test-block',
+                'title' => 'Test Block',
+            ),
+        );
+        file_put_contents( $this->temp_manifest_file, '<?php return ' . var_export( $manifest_data, true ) . ';' );
+
+        $plugins_path = 'C:\\Site\\wp-content\\plugins';
+        $plugin_path  = $plugins_path . '\\my-plugin\\blocks';
+        $block_path   = $plugin_path . '\\test-block\\block.json';
+
+        // Register the mock plugins directory as an allowed root.
+        add_filter(
+            'wp_allowed_block_metadata_collection_roots',
+            static function ( $paths ) use ( $plugins_path ) {
+                $paths[] = $plugins_path;
+                return $paths;
+            }
+        );
+
+        $this->assertTrue( WP_Block_Metadata_Registry::register_collection( $plugin_path, $this->temp_manifest_file ), 'Could not register block metadata collection.' );
+        $this->assertSame( $manifest_data['test-block'], WP_Block_Metadata_Registry::get_metadata( $block_path ), 'Could not find collection for provided block.json path.' );
+        $this->assertSame( array( wp_normalize_path( $block_path ) ), WP_Block_Metadata_Registry::get_collection_block_metadata_files( $plugin_path ), 'Could not get correct list of block.json paths for collection.' );
+    }
+
+    /**
+     * Tests that `register_collection()` handles Windows paths correctly for verifying allowed roots.
+     *
+     * @ticket 63027
+     * @covers ::register_collection
+     */
+    public function test_with_windows_paths_and_disallowed_location() {
+        $parent_path  = 'C:\\Site\\wp-content';
+        $plugins_path = $parent_path . '\\plugins';
+        $plugin_path  = $plugins_path . '\\my-plugin\\blocks';
+
+        // Register the mock plugins directory as an allowed root.
+        add_filter(
+            'wp_allowed_block_metadata_collection_roots',
+            static function ( $paths ) use ( $plugins_path ) {
+                $paths[] = $plugins_path;
+                return $paths;
+            }
+        );
+
+        $this->setExpectedIncorrectUsage( 'WP_Block_Metadata_Registry::register_collection' );
+
+        $result = WP_Block_Metadata_Registry::register_collection( $plugins_path, $this->temp_manifest_file );
+        $this->assertFalse( $result, 'Arbitrary Windows path should not be registered if it matches a collection root' );
+
+        $result = WP_Block_Metadata_Registry::register_collection( $parent_path, $this->temp_manifest_file );
+        $this->assertFalse( $result, 'Arbitrary Windows path should not be registered if it is a parent directory of a collection root' );
+
+        $result = WP_Block_Metadata_Registry::register_collection( $plugin_path, $this->temp_manifest_file );
+        $this->assertTrue( $result, 'Arbitrary Windows path should be registered successfully if it is within a collection root' );
+    }
 }