Changeset 52399 for trunk/tests/phpunit/tests/rest-api/wpRestTemplatesController.php

Timestamp:

12/21/2021 04:12:06 AM (2 years ago)

Author:

hellofromTonya

Message:

REST API: Support . in theme directory names in WP_REST_Global_Styles_Controller, WP_REST_Templates_Controller, and WP_REST_Themes_Controller.

Regex changes from [52376] are reverted to restore the original regex patterns. Why? [52376] used an include characters pattern, which was too limiting. It did not account for localized characters, such as é, or other valid directory name characters.

The original theme directory regex pattern, i.e. [^.\/]+(?:\/[^.\/]+)? excluded the period . character. Removing the . character resolves the reported issue by allowing matching for themes/theme-dirname-1.0/ or themes/<subdirname>/theme-dirname-1.0/.

As the pattern used an exclude approach, all characters are valid for matching except for /. However, not all characters are cross-platform valid for directory names. For example, the characters /:<>*?"| are not valid on Windows OS. The pattern now excludes those characters.

The theme's directory (or subdirectory) name pattern matching is now used in WP_REST_Global_Styles_Controller, WP_REST_Templates_Controller, and WP_REST_Themes_Controller.

Follow-up to [51003], [52051], [52275], [52376].

Props costdev, hellofromTonya, spacedmonkey, TimothyBlynJacobs, bijayyadav, kafleg.
Fixes #54596.

File:

• trunk/tests/phpunit/tests/rest-api/wpRestTemplatesController.php (modified) (2 diffs)

trunk/tests/phpunit/tests/rest-api/wpRestTemplatesController.php

@@ -66 +66 @@
         );
         $this->assertArrayHasKey(
-            '/wp/v2/templates/(?P<id>[\/\s%\w\.\(\)\[\]\@_\-]+)',
+            '/wp/v2/templates/(?P<id>([^\/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)[\/\w-]+)',
             $routes,
             'Single template based on the given ID route does not exist'
@@ -206 +206 @@
             array( '/wp/v2/templates/default/my_template' ),
             array( '/wp/v2/templates/default//my_template' ),
+        );
+    }
+
+    /**
+     * @dataProvider data_get_item_with_valid_theme_dirname
+     * @covers WP_REST_Templates_Controller::get_item
+     * @ticket 54596
+     *
+     * @param string $theme_dir Theme directory to test.
+     * @param string $template  Template to test.
+     * @param array  $args      Arguments to create the 'wp_template" post.
+     */
+    public function test_get_item_with_valid_theme_dirname( $theme_dir, $template, array $args ) {
+        wp_set_current_user( self::$admin_id );
+        switch_theme( $theme_dir );
+
+        // Set up template post.
+        $args['post_type'] = 'wp_template';
+        $args['tax_input'] = array(
+            'wp_theme' => array(
+                get_stylesheet(),
+            ),
+        );
+        $post              = self::factory()->post->create_and_get( $args );
+        wp_set_post_terms( $post->ID, get_stylesheet(), 'wp_theme' );
+
+        $request  = new WP_REST_Request( 'GET', "/wp/v2/templates/{$theme_dir}//{$template}" );
+        $response = rest_get_server()->dispatch( $request );
+        $data     = $response->get_data();
+        unset( $data['content'] );
+        unset( $data['_links'] );
+
+        $this->assertSameSetsWithIndex(
+            array(
+                'id'             => "{$theme_dir}//{$template}",
+                'theme'          => $theme_dir,
+                'slug'           => $template,
+                'source'         => 'custom',
+                'origin'         => null,
+                'type'           => 'wp_template',
+                'description'    => $args['post_excerpt'],
+                'title'          => array(
+                    'raw'      => $args['post_title'],
+                    'rendered' => $args['post_title'],
+                ),
+                'status'         => 'publish',
+                'wp_id'          => $post->ID,
+                'has_theme_file' => false,
+                'is_custom'      => true,
+                'author'         => self::$admin_id,
+            ),
+            $data
+        );
+    }
+
+    /**
+     * Data provider.
+     *
+     * @return array
+     */
+    public function data_get_item_with_valid_theme_dirname() {
+        $theme_root_dir = DIR_TESTDATA . '/themedir1/';
+        return array(
+            'template parts: parent theme'                => array(
+                'theme_dir' => 'themedir1/block-theme',
+                'template'  => 'small-header',
+                'args'      => array(
+                    'post_name'    => 'small-header',
+                    'post_title'   => 'Small Header Template',
+                    'post_content' => file_get_contents( $theme_root_dir . '/block-theme/parts/small-header.html' ),
+                    'post_excerpt' => 'Description of small header template.',
+                ),
+            ),
+            'template: parent theme'                      => array(
+                'theme_dir' => 'themedir1/block-theme',
+                'template'  => 'page-home',
+                'args'      => array(
+                    'post_name'    => 'page-home',
+                    'post_title'   => 'Home Page Template',
+                    'post_content' => file_get_contents( $theme_root_dir . 'block-theme/templates/page-home.html' ),
+                    'post_excerpt' => 'Description of page home template.',
+                ),
+            ),
+            'template: child theme'                       => array(
+                'theme_dir' => 'themedir1/block-theme-child',
+                'template'  => 'page-1',
+                'args'      => array(
+                    'post_name'    => 'page-1',
+                    'post_title'   => 'Page 1 Template',
+                    'post_content' => file_get_contents( $theme_root_dir . 'block-theme-child/templates/page-1.html' ),
+                    'post_excerpt' => 'Description of page 1 template.',
+                ),
+            ),
+            'template part: subdir with _-[]. characters' => array(
+                'theme_dir' => 'themedir1/block_theme-[0.4.0]',
+                'template'  => 'large-header',
+                'args'      => array(
+                    'post_name'    => 'large-header',
+                    'post_title'   => 'Large Header Template Part',
+                    'post_content' => file_get_contents( $theme_root_dir . 'block_theme-[0.4.0]/parts/large-header.html' ),
+                    'post_excerpt' => 'Description of large header template.',
+                ),
+            ),
+            'template: subdir with _-[]. characters'      => array(
+                'theme_dir' => 'themedir1/block_theme-[0.4.0]',
+                'template'  => 'page-large-header',
+                'args'      => array(
+                    'post_name'    => 'page-large-header',
+                    'post_title'   => 'Page Large Template',
+                    'post_content' => file_get_contents( $theme_root_dir . 'block_theme-[0.4.0]/templates/page-large-header.html' ),
+                    'post_excerpt' => 'Description of page large template.',
+                ),
+            ),
         );
     }