Changeset 57879 for branches/6.5/tests/phpunit/tests/fonts/font-library/wpFontsDir.php

Timestamp:

03/26/2024 09:22:48 AM (13 months ago)

Author:

swissspidy

Message:

Editor: Prevent font folder naive filtering causing infinite loops.

This modifies the font directory API to more closely reflect the upload directory API to help account for naive filtering when uploading fonts.

This moves the protection of infinite loops to the new function _wp_filter_font_directory() to allow developers extending and maintaining the font library to apply the filter without the need for a closure.

These changes also ensure both the upload_dir and font_dir filter are applied consistently when both creating and deleting fonts faces. Prior to this commit the upload_dir filter was only fired when creating fonts faces via the REST API.

Applying the font directory filter to the upload_dir filter is now done by adding the _wp_filter_font_directory function rather than wp_get_font_dir(). Developers who have previously modified the font upload directory using the font_dir filter will NOT need to upload their code.

Extenders wishing to upload files to the font directory can do so via the code:

<?php
add_filter( 'upload_dir', '_wp_filter_font_directory' );
// Your code to upload or sideload a font file.
remove_filter( 'upload_dir', '_wp_filter_font_directory' );

Introduces:

• wp_font_dir(): Attempt to create and retrieve the font upload directory. The equivalent to wp_upload_dir().
• _wp_filter_font_directory(): To run on the upload_dir filter, this sets the default destination of the fonts directory and fires the font_dir filter.

wp_get_font_dir() has been modified to be a lightweight getter for the font directory. It returns the location without attempting to create it. The equivalent to wp_get_upload_dir().

Follow up to [57740].

Reviewed by swissspidy.
Merges [57868] to the 6.5 branch.

Props peterwilsoncc, mukesh27, mikachan, costdev, mmaattiiaass, swissspidy, youknowriad, dd32, grantmkin.
Fixes #60652.

Location:

branches/6.5

Files:

• . (modified) (1 prop)
• tests/phpunit/tests/fonts/font-library/wpFontsDir.php (modified) (1 diff)

branches/6.5/tests/phpunit/tests/fonts/font-library/wpFontsDir.php

@@ -70 +70 @@
         $this->assertSame( static::$dir_defaults, $font_dir, 'The wp_get_font_dir() method should return the default values.' );
     }
+
+    /**
+     * @ticket 60652
+     */
+    public function test_fonts_dir_filters_do_not_trigger_infinite_loop() {
+        /*
+         * Naive filtering of uploads directory to return font directory.
+         *
+         * This emulates the approach a plugin developer may take to
+         * add the filter when extending the font library functionality.
+         */
+        add_filter( 'upload_dir', '_wp_filter_font_directory' );
+
+        add_filter(
+            'upload_dir',
+            function ( $upload_dir ) {
+                static $count = 0;
+                ++$count;
+                // The filter may be applied a couple of times, at five iterations assume an infinite loop.
+                if ( $count >= 5 ) {
+                    $this->fail( 'Filtering the uploads directory triggered an infinite loop.' );
+                }
+                return $upload_dir;
+            },
+            5
+        );
+
+        /*
+         * Filter the font directory to return the uploads directory.
+         *
+         * This emulates moving font files back to the uploads directory due
+         * to file system structure.
+         */
+        add_filter( 'font_dir', 'wp_get_upload_dir' );
+
+        wp_get_upload_dir();
+
+        // This will never be hit if an infinite loop is triggered.
+        $this->assertTrue( true );
+    }
 }