<!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>[51910] trunk: FileSystem API: Fix infinite loop on Windows for `clean_dirsize_cache()`.</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/51910">51910</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/51910","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>hellofromTonya</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2021-10-15 22:23:35 +0000 (Fri, 15 Oct 2021)</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'>FileSystem API: Fix infinite loop on Windows for `clean_dirsize_cache()`.
When the PHP native `dirname()` function is used on a Windows disk name - i.e. `C:\`-, it will return the same, i.e, it will return `C:\` again.
The `clean_dirsize_cache()` function didn't have guard clause against this, which meant that on Windows based systems and IIS servers, this function would result in WordPress getting stuck into an infinite loop.
The adjustment to the `while` part of the function fix this by checking if the return value of the `dirname()` function call is the same as the original path passed to `dirname()`, which effectively fixes the infinite loop.
A number of other improvements made:
1. Add input validation for the `$path` parameter to guard against invalid variable types being passed into the function.
2. Guard against an empty `$path` parameter, which would result in an infinite loop on both Windows as well as *nix based systems.
In both these cases, a PHP notice will now be thrown.
3. When a non-empty string, which isn't a path would previously be passed, the `dirname()` function would transform that to a `.` and the `.` key in the transient cache would be cleared out.
This was a bug as there is no relation between a non-path string and the root directory of file system.
This bug has been fixed by checking that something could actually be a path and handling received non-empty, non-path input parameters in a special way, i.e only removing the cache key for the passed string and bowing out from further processing.
Unfortunately, no tests can be added to guard against the infinite loop.
For the other fixes, we have added appropriate unit tests.
Follow-up up <a href="https://core.trac.wordpress.org/changeset/49212">[49212]</a>, <a href="https://core.trac.wordpress.org/changeset/49616">[49616]</a>, <a href="https://core.trac.wordpress.org/changeset/49744">[49744]</a>.
Props jrf, hellofromTonya, raubvogel, sergeybiryukov, codezen8, sjlevy, drosmog, teachlynx, ekojr, bartoszgrzesik, joegasper, janthiel, josephdickson, ocean90, audrasjb.
Fixes <a href="https://core.trac.wordpress.org/ticket/52241">#52241</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesfunctionsphp">trunk/src/wp-includes/functions.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsfunctionscleanDirsizeCachephp">trunk/tests/phpunit/tests/functions/cleanDirsizeCache.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesfunctionsphp"></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/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/functions.php 2021-10-15 05:03:17 UTC (rev 51909)
+++ trunk/src/wp-includes/functions.php 2021-10-15 22:23:35 UTC (rev 51910)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -8221,10 +8221,23 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Removes the current directory and all parent directories from the `dirsize_cache` transient.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.6.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.9.0 Added input validation with a notice for invalid input.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $path Full path of a directory or file.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function clean_dirsize_cache( $path ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! is_string( $path ) || empty( $path ) ) {
+ trigger_error(
+ sprintf(
+ /* translators: 1: Function name, 2: A variable type, like "boolean" or "integer". */
+ __( '%1$s only accepts a non-empty path string, received %2$s.' ),
+ '<code>clean_dirsize_cache()</code>',
+ '<code>' . gettype( $path ) . '</code>'
+ )
+ );
+ return;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $directory_cache = get_transient( 'dirsize_cache' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $directory_cache ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -8231,11 +8244,27 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $path = untrailingslashit( $path );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if (
+ strpos( $path, '/' ) === false &&
+ strpos( $path, '\\' ) === false
+ ) {
+ unset( $directory_cache[ $path ] );
+ set_transient( 'dirsize_cache', $directory_cache );
+ return;
+ }
+
+ $last_path = null;
+ $path = untrailingslashit( $path );
</ins><span class="cx" style="display: block; padding: 0 10px"> unset( $directory_cache[ $path ] );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- while ( DIRECTORY_SEPARATOR !== $path && '.' !== $path && '..' !== $path ) {
- $path = dirname( $path );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ while (
+ $last_path !== $path &&
+ DIRECTORY_SEPARATOR !== $path &&
+ '.' !== $path &&
+ '..' !== $path
+ ) {
+ $last_path = $path;
+ $path = dirname( $path );
</ins><span class="cx" style="display: block; padding: 0 10px"> unset( $directory_cache[ $path ] );
</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="trunktestsphpunittestsfunctionscleanDirsizeCachephp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/tests/functions/cleanDirsizeCache.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/functions/cleanDirsizeCache.php (rev 0)
+++ trunk/tests/phpunit/tests/functions/cleanDirsizeCache.php 2021-10-15 22:23:35 UTC (rev 51910)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,103 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * Tests specific to the directory size caching.
+ *
+ * @covers ::clean_dirsize_cache
+ * @group functions.php
+ */
+class Tests_Functions_CleanDirsizeCache extends WP_UnitTestCase {
+
+ /**
+ * Test the handling of invalid data passed as the $path parameter.
+ *
+ * @ticket 52241
+ *
+ * @dataProvider data_clean_dirsize_cache_with_invalid_inputs
+ *
+ * @param mixed $path Path input to use in the test.
+ * @param string $expected_message Expected notice message.
+ */
+ public function test_clean_dirsize_cache_with_invalid_inputs( $path, $expected_message ) {
+ $this->expectNotice();
+ $this->expectNoticeMessage( $expected_message );
+
+ clean_dirsize_cache( $path );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public function data_clean_dirsize_cache_with_invalid_inputs() {
+ return array(
+ 'null' => arra
y(
+ 'path' => null,
+ 'expected_message' => '<code>clean_dirsize_cache()</code> only accepts a non-empty path string, received <code>NULL</code>.',
+ ),
+ 'bool false' => array(
+ 'path' => false,
+ 'expected_message' => '<code>clean_dirsize_cache()</code> only accepts a non-empty path string, received <code>boolean</code>.',
+ ),
+ 'empty string' => array(
+ 'path' => '',
+ 'expected_message' => '<code>clean_dirsize_cache()</code> only accepts a non-empty path string, received <code>string</code>.',
+ ),
+ 'array' => array(
+ 'path' => array( '.', './second/path/' ),
+ 'expected_message' => '<code>clean_dirsize_cache()</code> only accepts a non-empty path string, received <code>array</code>.',
+ ),
+ );
+ }
+
+ /**
+ * Test the handling of a non-path text str
ing passed as the $path parameter.
+ *
+ * @ticket 52241
+ *
+ * @dataProvider data_clean_dirsize_cache_with_non_path_string
+ *
+ * @param string $path Path input to use in the test.
+ * @param int $expected_count Expected number of paths in the cache after cleaning.
+ */
+ public function test_clean_dirsize_cache_with_non_path_string( $path, $expected_count ) {
+ // Set the dirsize cache to our mock.
+ set_transient( 'dirsize_cache', $this->mock_dirsize_cache_with_non_path_string() );
+
+ clean_dirsize_cache( $path );
+
+ $cache = get_transient( 'dirsize_cache' );
+ $this->assertIsArray( $cache );
+ $this->assertCount( $expected_count, $cache );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public function data_clean_dirsize_cache_with_non_path_string() {
+ return array(
+ 'single dot' => array(
+ 'path' => '.',
+ 'expected_count' => 1,
+ ),
+ 'non-path'
=> array(
+ 'path' => 'string',
+ 'expected_count' => 1,
+ ),
+ 'non-existant string, but non-path' => array(
+ 'path' => 'doesnotexist',
+ 'expected_count' => 2,
+ ),
+ );
+ }
+
+ private function mock_dirsize_cache_with_non_path_string() {
+ return array(
+ '.' => array( 'size' => 50 ),
+ 'string' => array( 'size' => 42 ),
+ );
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/tests/functions/cleanDirsizeCache.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+CR
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span></div>
</body>
</html>