<!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>[55938] trunk: Filesystem API: Attempt to create directory in `copy_dir()`.</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/55938">55938</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/55938","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>peterwilsoncc</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-06-19 01:58:25 +0000 (Mon, 19 Jun 2023)</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: Attempt to create directory in `copy_dir()`.

Adds a check to the start of `copy_dir()` that the destination directory exists and attempts to create it if it does not.

An error is returned if the directory can not be created, either due to a permissions error or the parent directory not existing.

Props caraffande, costdev, zunaid321.
Fixes <a href="https://core.trac.wordpress.org/ticket/41855">#41855</a>.</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesfilephp">trunk/src/wp-admin/includes/file.php</a></li>
</ul>

<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsfilesystemcopyDirphp">trunk/tests/phpunit/tests/filesystem/copyDir.php</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesfilephp"></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/file.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/file.php      2023-06-18 16:39:05 UTC (rev 55937)
+++ trunk/src/wp-admin/includes/file.php        2023-06-19 01:58:25 UTC (rev 55938)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1910,6 +1910,14 @@
</span><span class="cx" style="display: block; padding: 0 10px">        $from = trailingslashit( $from );
</span><span class="cx" style="display: block; padding: 0 10px">        $to   = trailingslashit( $to );
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+        if ( ! $wp_filesystem->exists( $to ) && ! $wp_filesystem->mkdir( $to ) ) {
+               return new WP_Error(
+                       'mkdir_destination_failed_copy_dir',
+                       __( 'Could not create the destination directory.' ),
+                       basename( $to )
+               );
+       }
+
</ins><span class="cx" style="display: block; padding: 0 10px">         foreach ( (array) $dirlist as $filename => $fileinfo ) {
</span><span class="cx" style="display: block; padding: 0 10px">                if ( in_array( $filename, $skip_list, true ) ) {
</span><span class="cx" style="display: block; padding: 0 10px">                        continue;
</span></span></pre></div>
<a id="trunktestsphpunittestsfilesystemcopyDirphp"></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/filesystem/copyDir.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/filesystem/copyDir.php                          (rev 0)
+++ trunk/tests/phpunit/tests/filesystem/copyDir.php    2023-06-19 01:58:25 UTC (rev 55938)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,83 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * Tests copy_dir().
+ *
+ * @group file.php
+ *
+ * @covers ::copy_dir
+ */
+class Tests_Filesystem_CopyDir extends WP_UnitTestCase {
+
+       /**
+        * The test directory.
+        *
+        * @var string $test_dir
+        */
+       private static $test_dir;
+
+       /**
+        * Sets up the filesystem and test directory before any tests run.
+        */
+       public static function set_up_before_class() {
+               parent::set_up_before_class();
+
+               require_once ABSPATH . 'wp-admin/includes/file.php';
+               WP_Filesystem();
+
+               self::$test_dir = get_temp_dir() . 'copy_dir/';
+       }
+
+       /**
+        * Sets up the test directory before each test.
+        */
+       public function set_up() {
+               global $wp_filesystem;
+
+               parent::set_up();
+
+               // Create the root directory.
+               $wp_filesystem->mkdir( self::$test_dir );
+       }
+
+       /**
+        * Removes the test directory after each test.
+        */
+       public function tear_down() {
+               global $wp_filesystem;
+
+               // Delete the root directory and its contents.
+               $wp_filesystem->delete( self::$test_dir, true );
+
+               parent::tear_down();
+       }
+
+       /**
+        * Tests that the destination is created if it does not already exist.
+        *
+        * @ticket 41855
+        */
+       public function test_should_create_destination_it_if_does_not_exist() {
+               global $wp_filesystem;
+
+               $from = self::$test_dir . 'folder1/folder2/';
+               $to   = self::$test_dir . 'folder3/folder2/';
+
+               // Create the file structure for the test.
+               $wp_filesystem->mkdir( self::$test_dir . 'folder1' );
+               $wp_filesystem->mkdir( self::$test_dir . 'folder3' );
+               $wp_filesystem->mkdir( $from );
+               $wp_filesystem->touch( $from . 'file1.txt' );
+               $wp_filesystem->mkdir( $from . 'subfolder1' );
+               $wp_filesystem->touch( $from . 'subfolder1/file2.txt' );
+
+               $this->assertTrue( copy_dir( $from, $to ), 'copy_dir() failed.' );
+
+               $this->assertDirectoryExists( $to, 'The destination was not created.' );
+               $this->assertFileExists( $to . 'file1.txt', 'The destination file was not created.' );
+
+               $this->assertDirectoryExists( $to . 'subfolder1/', 'The destination subfolder was not created.' );
+               $this->assertFileExists( $to . 'subfolder1/file2.txt', 'The destination subfolder file was not created.' );
+       }
+
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/tests/filesystem/copyDir.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">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span></div>

</body>
</html>