<!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>[59257] trunk: Upgrade/Install: Return WP_Error when source files cannot be found.</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/59257">59257</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/59257","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>azaozz</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-10-18 23:35:02 +0000 (Fri, 18 Oct 2024)</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'>Upgrade/Install: Return WP_Error when source files cannot be found.
Fixes a fatal error in `array_keys()` (PHP 8.0+) as `$wp_filesystem->dirlist()` will return `false` when the source directory doesn't exist or becomes unreadable for some reason.
Props: verygoode, lifelightweb, da5f656f, costdev, afragen, azaozz
Fixes <a href="https://core.trac.wordpress.org/ticket/61114">#61114</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesclasswpupgraderphp">trunk/src/wp-admin/includes/class-wp-upgrader.php</a></li>
<li><a href="#trunktestsphpunittestsadminwpUpgraderphp">trunk/tests/phpunit/tests/admin/wpUpgrader.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesclasswpupgraderphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/class-wp-upgrader.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/class-wp-upgrader.php 2024-10-18 21:53:45 UTC (rev 59256)
+++ trunk/src/wp-admin/includes/class-wp-upgrader.php 2024-10-18 23:35:02 UTC (rev 59257)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -204,6 +204,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->strings['mkdir_failed'] = __( 'Could not create directory.' );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->strings['incompatible_archive'] = __( 'The package could not be installed.' );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->strings['files_not_writable'] = __( 'The update cannot be installed because some files could not be copied. This is usually due to inconsistent file permissions.' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->strings['dir_not_readable'] = __( 'A directory could not be read.' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->strings['maintenance_start'] = __( 'Enabling Maintenance mode…' );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->strings['maintenance_end'] = __( 'Disabling Maintenance mode…' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -558,7 +559,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $remote_source = $args['source'];
</span><span class="cx" style="display: block; padding: 0 10px"> $local_destination = $destination;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $source_files = array_keys( $wp_filesystem->dirlist( $remote_source ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $dirlist = $wp_filesystem->dirlist( $remote_source );
+
+ if ( false === $dirlist ) {
+ return new WP_Error( 'source_read_failed', $this->strings['fs_error'], $this->strings['dir_not_readable'] );
+ }
+
+ $source_files = array_keys( $dirlist );
</ins><span class="cx" style="display: block; padding: 0 10px"> $remote_destination = $wp_filesystem->find_folder( $local_destination );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Locate which directory to copy to the new folder. This is based on the actual folder holding the files.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -605,7 +612,13 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Has the source location changed? If so, we need a new source_files list.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $source !== $remote_source ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $source_files = array_keys( $wp_filesystem->dirlist( $source ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $dirlist = $wp_filesystem->dirlist( $source );
+
+ if ( false === $dirlist ) {
+ return new WP_Error( 'new_source_read_failed', $this->strings['fs_error'], $this->strings['dir_not_readable'] );
+ }
+
+ $source_files = array_keys( $dirlist );
</ins><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></span></pre></div>
<a id="trunktestsphpunittestsadminwpUpgraderphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/admin/wpUpgrader.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/admin/wpUpgrader.php 2024-10-18 21:53:45 UTC (rev 59256)
+++ trunk/tests/phpunit/tests/admin/wpUpgrader.php 2024-10-18 23:35:02 UTC (rev 59257)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -949,6 +949,107 @@
</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">+ * Tests that `WP_Upgrader::install_package()` returns a WP_Error object
+ * when the source directory's file list cannot be retrieved.
+ *
+ * @ticket 61114
+ *
+ * @covers WP_Upgrader::install_package
+ */
+ public function test_install_package_should_return_wp_error_when_source_directory_file_list_cannot_be_retrieved() {
+ self::$instance->generic_strings();
+
+ self::$upgrader_skin_mock
+ ->expects( $this->once() )
+ ->method( 'feedback' )
+ ->with( 'installing_package' );
+
+ self::$wp_filesystem_mock
+ ->expects( $this->once() )
+ ->method( 'dirlist' )
+ ->willReturn( false );
+
+ $args = array(
+ 'source' => '/',
+ 'destination' => '/',
+ );
+
+ $actual = self::$instance->install_package( $args );
+
+ $this->assertWPError(
+ $actual,
+ 'WP_Upgrader::install_package() did not return a WP_Error object'
+ );
+
+ $this->assertSame(
+ 'source_read_failed',
+ $actual->get_error_code(),
+ 'Unexpected WP_Error code'
+ );
+ }
+
+ /**
+ * Tests that `WP_Upgrader::install_package()` returns a WP_Error object
+ * when the source directory is filtered and its file list cannot be retrieved.
+ *
+ * @ticket 61114
+ *
+ * @covers WP_Upgrader::install_package
+ *
+ * @runInSeparateProcess
+ * @preserveGlobalState disabled
+ */
+ public function test_install_package_should_return_wp_error_when_a_filtered_source_directory_file_list_cannot_be_retrieved() {
+ define( 'FS_CHMOD_DIR', 0755 );
+
+ self::$instance->generic_strings();
+
+ self::$upgrader_skin_mock
+ ->expects( $this->once() )
+ ->method( 'feedback' )
+ ->with( 'installing_package' );
+
+ $first_source = array(
+ 'subdir' => array(
+ 'name' => 'subdir',
+ 'type' => 'd',
+ 'files' => array( 'subfile.php' ),
+ ),
+ );
+
+ self::$wp_filesystem_mock
+ ->expects( $this->exactly( 2 ) )
+ ->method( 'dirlist' )
+ ->willReturn( $first_source, false );
+
+ $args = array(
+ 'source' => '/',
+ 'destination' => '/',
+ );
+
+ // Filter the source to something else.
+ add_filter(
+ 'upgrader_source_selection',
+ static function () {
+ return '/not_original_source/';
+ }
+ );
+
+ $actual = self::$instance->install_package( $args );
+
+ $this->assertWPError(
+ $actual,
+ 'WP_Upgrader::install_package() did not return a WP_Error object'
+ );
+
+ $this->assertSame(
+ 'new_source_read_failed',
+ $actual->get_error_code(),
+ 'Unexpected WP_Error code'
+ );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Tests that `WP_Upgrader::install_package()` adds a trailing slash to
</span><span class="cx" style="display: block; padding: 0 10px"> * the source directory of a single file.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span></span></pre>
</div>
</div>
</body>
</html>