<!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>[46836] branches/5.3/tests/phpunit: Upload: fix `wp_unique_filename()` to prevent name collisions with existing or future image sub-size file names, and add unit tests.</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/46836">46836</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/46836","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2019-12-09 12:19:19 +0000 (Mon, 09 Dec 2019)</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'>Upload: fix `wp_unique_filename()` to prevent name collisions with existing or future image sub-size file names, and add unit tests.
Props Viper007Bond, pbiron, azaozz.
Merges <a href="https://core.trac.wordpress.org/changeset/46822">[46822]</a>, <a href="https://core.trac.wordpress.org/changeset/46835">[46835]</a> to the 5.3 branch.
Fixes <a href="https://core.trac.wordpress.org/ticket/42437">#42437</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches53srcwpincludesfunctionsphp">branches/5.3/src/wp-includes/functions.php</a></li>
<li><a href="#branches53testsphpunittestsfunctionsphp">branches/5.3/tests/phpunit/tests/functions.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#branches53testsphpunitdataimagesonebluepixel1100x100png">branches/5.3/tests/phpunit/data/images/one-blue-pixel-1-100x100.png</a></li>
</ul>
<h3>Property Changed</h3>
<ul>
<li><a href="#branches53">branches/5.3/</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<span class="cx" style="display: block; padding: 0 10px">Index: branches/5.3
</span><span class="cx" style="display: block; padding: 0 10px">===================================================================
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">--- branches/5.3 2019-12-09 12:16:43 UTC (rev 46835)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+++ branches/5.3 2019-12-09 12:19:19 UTC (rev 46836)
</ins><a id="branches53"></a>
<div class="propset"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Property changes: branches/5.3</h4>
<pre class="diff"><span>
</span></pre></div>
<a id="svnmergeinfo"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: svn:mergeinfo</h4></div>
<span class="cx" style="display: block; padding: 0 10px"> /branches/3.4:21757
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/4.9:43557,43622
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/5.0:43681-43682,43684-43688,43719-43720,43723,43726-43727,43729-43731,43734-43744,43747,43751-43754,43758,43760-43765,43767-43770,43772,43774-43781,43783,43785,43790-43806,43808-43821,43825,43828,43830-43834,43836-43843,43846-43863,43867-43889,43891-43894,43897-43905,43908-43909,43911-43929,43931-43942,43946-43947,43949-43956,43959-43964,43967-43969,43988,43994,44014,44017,44047,44183,44185,44187-44206,44208-44213,44231-44232,44235,44248,44284,44287-44288
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-/trunk:46583,46605-46606,46613,46616,46656,46658,46665,46668,46676-46677,46700-46703,46705,46707,46709,46711,46713,46715,46719-46720,46722,46724,46738,46745-46748,46753,46756-46758,46761-46762,46765,46770,46772,46779,46782,46786,46788,46793,46795,46797,46809,46815,46817,46824,46832
</del><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/trunk:46583,46605-46606,46613,46616,46656,46658,46665,46668,46676-46677,46700-46703,46705,46707,46709,46711,46713,46715,46719-46720,46722,46724,46738,46745-46748,46753,46756-46758,46761-46762,46765,46770,46772,46779,46782,46786,46788,46793,46795,46797,46809,46815,46817,46822,46824,46832,46835
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="branches53srcwpincludesfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/5.3/src/wp-includes/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.3/src/wp-includes/functions.php 2019-12-09 12:16:43 UTC (rev 46835)
+++ branches/5.3/src/wp-includes/functions.php 2019-12-09 12:19:19 UTC (rev 46836)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2409,6 +2409,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Separate the filename into a name and extension.
</span><span class="cx" style="display: block; padding: 0 10px"> $ext = pathinfo( $filename, PATHINFO_EXTENSION );
</span><span class="cx" style="display: block; padding: 0 10px"> $name = pathinfo( $filename, PATHINFO_BASENAME );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $ext ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $ext = '.' . $ext;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2426,7 +2427,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $filename = call_user_func( $unique_filename_callback, $dir, $name, $ext );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $number = '';
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $fname = pathinfo( $filename, PATHINFO_FILENAME );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Always append a number to file names that can potentially match image sub-size file names.
+ if ( $fname && preg_match( '/-(?:\d+x\d+|scaled|rotated)$/', $fname ) ) {
+ $number = 1;
+
+ // At this point the file name may not be unique. This is tested below and the $number is incremented.
+ $filename = str_replace( "{$fname}{$ext}", "{$fname}-{$number}{$ext}", $filename );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Change '.ext' to lower case.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $ext && strtolower( $ext ) != $ext ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $ext2 = strtolower( $ext );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2433,42 +2443,94 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $filename2 = preg_replace( '|' . preg_quote( $ext ) . '$|', $ext2, $filename );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Check for both lower and upper case extension or image sub-sizes may be overwritten.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- while ( file_exists( $dir . "/$filename" ) || file_exists( $dir . "/$filename2" ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ while ( file_exists( $dir . "/{$filename}" ) || file_exists( $dir . "/{$filename2}" ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $new_number = (int) $number + 1;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $filename = str_replace( array( "-$number$ext", "$number$ext" ), "-$new_number$ext", $filename );
- $filename2 = str_replace( array( "-$number$ext2", "$number$ext2" ), "-$new_number$ext2", $filename2 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $filename = str_replace( array( "-{$number}{$ext}", "{$number}{$ext}" ), "-{$new_number}{$ext}", $filename );
+ $filename2 = str_replace( array( "-{$number}{$ext2}", "{$number}{$ext2}" ), "-{$new_number}{$ext2}", $filename2 );
</ins><span class="cx" style="display: block; padding: 0 10px"> $number = $new_number;
</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">- /**
- * Filters the result when generating a unique file name.
- *
- * @since 4.5.0
- *
- * @param string $filename Unique file name.
- * @param string $ext File extension, eg. ".png".
- * @param string $dir Directory path.
- * @param callable|null $unique_filename_callback Callback function that generates the unique file name.
- */
- return apply_filters( 'wp_unique_filename', $filename2, $ext, $dir, $unique_filename_callback );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $filename = $filename2;
+ } else {
+ while ( file_exists( $dir . "/{$filename}" ) ) {
+ $new_number = (int) $number + 1;
+
+ if ( '' === "{$number}{$ext}" ) {
+ $filename = "{$filename}-{$new_number}";
+ } else {
+ $filename = str_replace( array( "-{$number}{$ext}", "{$number}{$ext}" ), "-{$new_number}{$ext}", $filename );
+ }
+
+ $number = $new_number;
+ }
</ins><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">- while ( file_exists( $dir . "/$filename" ) ) {
- $new_number = (int) $number + 1;
- if ( '' == "$number$ext" ) {
- $filename = "$filename-" . $new_number;
- } else {
- $filename = str_replace( array( "-$number$ext", "$number$ext" ), '-' . $new_number . $ext, $filename );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Prevent collisions with existing file names that contain dimension-like strings
+ // (whether they are subsizes or originals uploaded prior to #42437).
+
+ // The (resized) image files would have name and extension, and will be in the uploads dir.
+ if ( @is_dir( $dir ) && $name && $ext ) {
+ // List of all files and directories contained in $dir (with the "dot" files removed).
+ $files = array_diff( scandir( $dir ), array( '.', '..' ) );
+
+ if ( ! empty( $files ) ) {
+ while ( _wp_check_existing_file_names( $filename, $files ) ) {
+ $new_number = (int) $number + 1;
+ $filename = str_replace( array( "-{$number}{$ext}", "{$number}{$ext}" ), "-{$new_number}{$ext}", $filename );
+ $number = $new_number;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $number = $new_number;
</del><span class="cx" style="display: block; padding: 0 10px"> }
</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">- /** This filter is documented in wp-includes/functions.php */
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters the result when generating a unique file name.
+ *
+ * @since 4.5.0
+ *
+ * @param string $filename Unique file name.
+ * @param string $ext File extension, eg. ".png".
+ * @param string $dir Directory path.
+ * @param callable|null $unique_filename_callback Callback function that generates the unique file name.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'wp_unique_filename', $filename, $ext, $dir, $unique_filename_callback );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Helper function to check if a file name could match an existing image sub-size file name.
+ *
+ * @since 5.3.1
+ * @access private
+ *
+ * @param string $filename The file name to check.
+ * $param array $files An array of existing files in the directory.
+ * $return bool True if the tested file name could match an existing file, false otherwise.
+ */
+function _wp_check_existing_file_names( $filename, $files ) {
+ $fname = pathinfo( $filename, PATHINFO_FILENAME );
+ $ext = pathinfo( $filename, PATHINFO_EXTENSION );
+
+ // Edge case, file names like `.ext`
+ if ( empty( $fname ) ) {
+ return false;
+ }
+
+ if ( $ext ) {
+ $ext = ".$ext";
+ }
+
+ $regex = '/^' . preg_quote( $fname ) . '-(?:\d+x\d+|scaled|rotated)' . preg_quote( $ext ) . '$/';
+
+ foreach ( $files as $file ) {
+ if ( preg_match( $regex, $file ) ) {
+ return true;
+ }
+ }
+
+ return false;
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Create a file in the upload folder with given content.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * If there is an error, then the key 'error' will exist with the error message.
</span></span></pre></div>
<a id="branches53testsphpunitdataimagesonebluepixel1100x100pngfromrev46822trunktestsphpunitdataimagesonebluepixel1100x100png"></a>
<div class="binary"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Copied: branches/5.3/tests/phpunit/data/images/one-blue-pixel-1-100x100.png (from rev 46822, trunk/tests/phpunit/data/images/one-blue-pixel-1-100x100.png)</h4>
<pre class="diff"><span>
<span class="cx">(Binary files differ)
</span></span></pre></div>
<a id="branches53testsphpunittestsfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/5.3/tests/phpunit/tests/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.3/tests/phpunit/tests/functions.php 2019-12-09 12:16:43 UTC (rev 46835)
+++ branches/5.3/tests/phpunit/tests/functions.php 2019-12-09 12:19:19 UTC (rev 46836)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -195,6 +195,19 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 'abcdefg.png', wp_unique_filename( $testdir, 'abcde\\\fg.png' ), 'Tripple slashed not removed' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * @ticket 42437
+ */
+ function test_unique_filename_with_dimension_like_filename() {
+ $testdir = DIR_TESTDATA . '/images/';
+
+ // Test collision with "dimension-like" original filename.
+ $this->assertEquals( 'one-blue-pixel-100x100-1.png', wp_unique_filename( $testdir, 'one-blue-pixel-100x100.png' ) );
+ // Test collision with existing sub-size filename.
+ // Existing files: one-blue-pixel-100x100.png, one-blue-pixel-1-100x100.png.
+ $this->assertEquals( 'one-blue-pixel-2.png', wp_unique_filename( $testdir, 'one-blue-pixel.png' ) );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> function test_is_serialized() {
</span><span class="cx" style="display: block; padding: 0 10px"> $cases = array(
</span><span class="cx" style="display: block; padding: 0 10px"> serialize( null ),
</span></span></pre>
</div>
</div>
</body>
</html>