[PATCH 0/1] MR5020: implement CopyFile2

[Kartavya Vashishtha (＠kvashis)]

copy implementation of CopyFileExW into CopyFile2,
then implement CopyFileExW in terms of CopyFile2

should fix https://bugs.winehq.org/show_bug.cgi?id=55897, as Python does not use any new functionality nor the callback parameter from CopyFile2.

- followed [the Wiki](https://wiki.winehq.org/Developer_Hints#Implementing_new_API_calls) for adding a new API call
- run `file.c` tests and they seem to pass

I have not written extensive documentation since the original function didn't seem to have any; I can do that if recommended.

I originally intended to implement the callback functionality in this MR as well, but realized that would be better as a follow-up.

-- 
https://gitlab.winehq.org/wine/wine/-/merge_requests/5020

[PATCH 1/1] implement CopyFile2

[Kartavya Vashishtha]

From: Kartavya Vashishtha <sendtokartavya(a)gmail.com>

implement CopyFileExW in terms of CopyFile2
---
 dlls/kernelbase/file.c          | 47 +++++++++++++++++++++++----------
 dlls/kernelbase/kernelbase.spec |  2 +-
 2 files changed, 34 insertions(+), 15 deletions(-)

diff --git a/dlls/kernelbase/file.c b/dlls/kernelbase/file.c
index e1ba92a6448..48e2af85005 100644
--- a/dlls/kernelbase/file.c
+++ b/dlls/kernelbase/file.c
@@ -487,13 +487,14 @@ BOOL WINAPI DECLSPEC_HOTPATCH AreFileApisANSI(void)
     return !oem_file_apis;
 }
 
-
 /***********************************************************************
- *	CopyFileExW   (kernelbase.@)
+ *	CopyFile2   (kernelbase.@)
+ * 
+ * FIXME: Silently ignores:
+ * the callback function
+ * cancel_ptr
  */
-BOOL WINAPI CopyFileExW( const WCHAR *source, const WCHAR *dest, LPPROGRESS_ROUTINE progress,
-                         void *param, BOOL *cancel_ptr, DWORD flags )
-{
+HRESULT WINAPI CopyFile2 ( const PCWSTR source , const PCWSTR dest, COPYFILE2_EXTENDED_PARAMETERS* params) {
     static const int buffer_size = 65536;
     HANDLE h1, h2;
     FILE_BASIC_INFORMATION info;
@@ -502,15 +503,15 @@ BOOL WINAPI CopyFileExW( const WCHAR *source, const WCHAR *dest, LPPROGRESS_ROUT
     BOOL ret = FALSE;
     char *buffer;
 
+    DWORD flags = params? params->dwCopyFlags : 0;
+
     if (!source || !dest)
     {
-        SetLastError( ERROR_INVALID_PARAMETER );
-        return FALSE;
+        return HRESULT_FROM_WIN32( ERROR_INVALID_PARAMETER );
     }
     if (!(buffer = HeapAlloc( GetProcessHeap(), 0, buffer_size )))
     {
-        SetLastError( ERROR_NOT_ENOUGH_MEMORY );
-        return FALSE;
+        return HRESULT_FROM_WIN32( ERROR_NOT_ENOUGH_MEMORY );
     }
 
     TRACE("%s -> %s, %lx\n", debugstr_w(source), debugstr_w(dest), flags);
@@ -527,7 +528,7 @@ BOOL WINAPI CopyFileExW( const WCHAR *source, const WCHAR *dest, LPPROGRESS_ROUT
     {
         WARN("Unable to open source %s\n", debugstr_w(source));
         HeapFree( GetProcessHeap(), 0, buffer );
-        return FALSE;
+        return HRESULT_FROM_WIN32( ERROR_INVALID_PARAMETER );
     }
 
     if (!set_ntstatus( NtQueryInformationFile( h1, &io, &info, sizeof(info), FileBasicInformation )))
@@ -535,7 +536,7 @@ BOOL WINAPI CopyFileExW( const WCHAR *source, const WCHAR *dest, LPPROGRESS_ROUT
         WARN("GetFileInformationByHandle returned error for %s\n", debugstr_w(source));
         HeapFree( GetProcessHeap(), 0, buffer );
         CloseHandle( h1 );
-        return FALSE;
+        return HRESULT_FROM_WIN32( GetLastError() );
     }
 
     if (!(flags & COPY_FILE_FAIL_IF_EXISTS))
@@ -551,8 +552,7 @@ BOOL WINAPI CopyFileExW( const WCHAR *source, const WCHAR *dest, LPPROGRESS_ROUT
         {
             HeapFree( GetProcessHeap(), 0, buffer );
             CloseHandle( h1 );
-            SetLastError( ERROR_SHARING_VIOLATION );
-            return FALSE;
+            return HRESULT_FROM_WIN32( ERROR_SHARING_VIOLATION );
         }
     }
 
@@ -563,7 +563,7 @@ BOOL WINAPI CopyFileExW( const WCHAR *source, const WCHAR *dest, LPPROGRESS_ROUT
         WARN("Unable to open dest %s\n", debugstr_w(dest));
         HeapFree( GetProcessHeap(), 0, buffer );
         CloseHandle( h1 );
-        return FALSE;
+        return HRESULT_FROM_WIN32( GetLastError() );
     }
 
     while (ReadFile( h1, buffer, buffer_size, &count, NULL ) && count)
@@ -590,6 +590,25 @@ done:
 }
 
 
+/***********************************************************************
+ *	CopyFileExW   (kernelbase.@)
+ */
+BOOL WINAPI CopyFileExW( const WCHAR *source, const WCHAR *dest, LPPROGRESS_ROUTINE progress,
+                         void *param, BOOL *cancel_ptr, DWORD flags )
+{
+    BOOL ret;
+    COPYFILE2_EXTENDED_PARAMETERS params;
+
+    params.dwSize = sizeof(params);
+    params.dwCopyFlags = flags;
+
+    ret = CopyFile2( source, dest, ¶ms );
+    if (ret) SetLastError( 0 );
+
+    return ret;
+}
+
+
 /**************************************************************************
  *	CopyFileW   (kernelbase.@)
  */
diff --git a/dlls/kernelbase/kernelbase.spec b/dlls/kernelbase/kernelbase.spec
index ffb153a46ee..bde4bc66bde 100644
--- a/dlls/kernelbase/kernelbase.spec
+++ b/dlls/kernelbase/kernelbase.spec
@@ -168,7 +168,7 @@
 @ stdcall ConvertThreadToFiberEx(ptr long)
 @ stdcall ConvertToAutoInheritPrivateObjectSecurity(ptr ptr ptr ptr long ptr)
 @ stdcall CopyContext(ptr long ptr)
-# @ stub CopyFile2
+@ stdcall CopyFile2(wstr wstr ptr)
 @ stdcall CopyFileExW(wstr wstr ptr ptr ptr long)
 @ stdcall CopyFileW(wstr wstr long)
 @ stdcall -arch=x86_64 CopyMemoryNonTemporal(ptr ptr long) ntdll.RtlCopyMemoryNonTemporal
-- 
GitLab

https://gitlab.winehq.org/wine/wine/-/merge_requests/5020

[PATCH 1/1] implement CopyFile2

[Marvin]

Hi,

It looks like your patch introduced the new failures shown below.
Please investigate and fix them before resubmitting your patch.
If they are not new, fixing them anyway would help a lot. Otherwise
please ask for the known failures list to be updated.

The tests also ran into some preexisting test failures. If you know how
to fix them that would be helpful. See the TestBot job for the details:

The full results can be found at:
https://testbot.winehq.org/JobDetails.pl?Key=142762

Your paranoid android.


=== debian11b (64 bit WoW report) ===

cmd.exe:
batch.c:321: Test failed: unexpected char 0x49 position 0 in line 1543 (got 'Incorrect errorlevel', wanted 'Passed: Did not find dir2')
batch.c:310: Test failed: unexpected end of line 1544 (got 'Passed: Did not find dir2', wanted 'Passed: Did not find dir2\file1')
batch.c:321: Test failed: unexpected char 0x44 position 8 in line 1545 (got 'Passed: Did not find dir2\file1', wanted 'Passed: Found expected dir1\file1')
batch.c:321: Test failed: unexpected char 0x31 position 32 in line 1546 (got 'Passed: Found expected dir1\file1', wanted 'Passed: Found expected dir1\file2')
batch.c:321: Test failed: unexpected char 0x32 position 32 in line 1547 (got 'Passed: Found expected dir1\file2', wanted 'Passed: Found expected dir1\file3')
batch.c:321: Test failed: unexpected char 0x33 position 32 in line 1548 (got 'Passed: Found expected dir1\file3', wanted 'Passed: Found expected dir1\file1')
batch.c:321: Test failed: unexpected char 0x31 position 32 in line 1549 (got 'Passed: Found expected dir1\file1', wanted 'Passed: Found expected dir1\file2')
batch.c:321: Test failed: unexpected char 0x32 position 32 in line 1550 (got 'Passed: Found expected dir1\file2', wanted 'Passed: Found expected dir1\file3')
batch.c:321: Test failed: unexpected char 0x64 position 23 in line 1551 (got 'Passed: Found expected dir1\file3', wanted 'Passed: Found expected file1')
batch.c:321: Test failed: unexpected char 0x31 position 27 in line 1552 (got 'Passed: Found expected file1', wanted 'Passed: Found expected file2')
batch.c:321: Test failed: unexpected char 0x32 position 27 in line 1553 (got 'Passed: Found expected file2', wanted 'Passed: Found expected file3')
batch.c:321: Test failed: unexpected char 0x46 position 8 in line 1554 (got 'Passed: Found expected file3', wanted 'Passed: Did not find dir2')
batch.c:321: Test failed: unexpected char 0x49 position 0 in line 1555 (got 'Incorrect errorlevel', wanted 'Passed: Did not find dir2\file1')
batch.c:310: Test failed: unexpected end of line 1556 (got 'Passed: Did not find dir2', wanted 'Passed: Did not find dir2\file2')
batch.c:321: Test failed: unexpected char 0x31 position 30 in line 1557 (got 'Passed: Did not find dir2\file1', wanted 'Passed: Did not find dir2\file3')
batch.c:321: Test failed: unexpected char 0x44 position 8 in line 1558 (got 'Passed: Did not find dir2\file2', wanted 'Passed: Found expected testfile')
batch.c:321: Test failed: unexpected char 0x44 position 8 in line 1559 (got 'Passed: Did not find dir2\file3', wanted 'Passed: Found expected testfile')
batch.c:321: Test failed: unexpected char 0x74 position 23 in line 1563 (got 'Passed: Found expected testfile', wanted 'Passed: Found expected dir1\fred')
batch.c:321: Test failed: unexpected char 0x74 position 23 in line 1564 (got 'Passed: Found expected testfile', wanted 'Passed: Found expected dir1\fred')
batch.c:321: Test failed: unexpected char 0x64 position 23 in line 1565 (got 'Passed: Found expected dir1\fred', wanted 'Passed: Found expected fred')
batch.c:321: Test failed: unexpected char 0x64 position 23 in line 1566 (got 'Passed: Found expected dir1\fred', wanted 'Passed: Found expected fred')
batch.c:321: Test failed: unexpected char 0x46 position 8 in line 1567 (got 'Passed: Found expected fred', wanted 'Passed: file size check on file1 [5]@or_broken(a)Skipping file size check on NT4')
batch.c:321: Test failed: unexpected char 0x46 position 8 in line 1568 (got 'Passed: Found expected fred', wanted 'Passed: file size check on file2 [8]@or_broken(a)Skipping file size check on NT4')
batch.c:321: Test failed: unexpected char 0x31 position 31 in line 1569 (got 'Passed: file size check on file1 [5]', wanted 'Passed: file size check on file3 [11]@or_broken(a)Skipping file size check on NT4')
batch.c:321: Test failed: unexpected char 0x32 position 31 in line 1570 (got 'Passed: file size check on file2 [8]', wanted 'Passed: file size check on file1_default [5]@or_broken(a)Skipping file size check on NT4')
batch.c:321: Test failed: unexpected char 0x33 position 31 in line 1571 (got 'Passed: file size check on file3 [11]', wanted 'Passed: file size check on file1_default2 [5]@or_broken(a)Skipping file size check on NT4')
batch.c:321: Test failed: unexpected char 0x64 position 33 in line 1572 (got 'Passed: file size check on file1_default [5]', wanted 'Passed: file size check on file1_plus_eof [6]@or_broken(a)Skipping file size check on NT4')
batch.c:321: Test failed: unexpected char 0x31 position 31 in line 1573 (got 'Passed: file size check on file1_default2 [5]', wanted 'Passed: file size check on file2_plus_eof [9]@or_broken(a)Skipping file size check on NT4')
batch.c:321: Test failed: unexpected char 0x31 position 31 in line 1574 (got 'Passed: file size check on file1_plus_eof [6]', wanted 'Passed: file size check on file3_plus_eof [12]@or_broken(a)Skipping file size check on NT4')
batch.c:321: Test failed: unexpected char 0x32 position 31 in line 1575 (got 'Passed: file size check on file2_plus_eof [9]', wanted 'Passed: file size check on file12_plus_eof [14]@or_broken(a)Skipping file size check on NT4')
batch.c:321: Test failed: unexpected char 0x33 position 31 in line 1576 (got 'Passed: file size check on file3_plus_eof [12]', wanted 'Passed: file size check on file12_no_eof [13]@or_broken(a)Skipping file size check on NT4')
batch.c:321: Test failed: unexpected char 0x70 position 34 in line 1577 (got 'Passed: file size check on file12_plus_eof [14]', wanted 'Passed: file size check on file12_eof2 [14]@or_broken(a)Skipping file size check on NT4')
batch.c:321: Test failed: unexpected char 0x32 position 32 in line 1578 (got 'Passed: file size check on file12_no_eof [13]', wanted 'Passed: file size check on file1 [24]@or_broken(a)Skipping file size check on NT4')
batch.c:321: Test failed: unexpected char 0x31 position 31 in line 1579 (got 'Passed: file size check on file12_eof2 [14]', wanted 'Passed: file size check on file2 [16]@or_broken(a)Skipping file size check on NT4')
batch.c:321: Test failed: unexpected char 0x31 position 31 in line 1580 (got 'Passed: file size check on file1 [24]', wanted 'Passed: file size check on file3 [13]@or_broken(a)Skipping file size check on NT4')
batch.c:321: Test failed: unexpected char 0x32 position 31 in line 1581 (got 'Passed: file size check on file2 [16]', wanted 'Passed: file size check on file1_binary_srccopy [6]@or_broken(a)Skipping file size check on NT4')
batch.c:321: Test failed: unexpected char 0x33 position 31 in line 1582 (got 'Passed: file size check on file3 [13]', wanted 'Passed: file size check on file1_ascii_srccopy [5]@or_broken(a)Skipping file size check on NT4')
batch.c:321: Test failed: unexpected char 0x5f position 32 in line 1583 (got 'Passed: file size check on file1_binary_srccopy [6]', wanted 'Passed: file size check on file123_default_copy [25]@or_broken(a)Skipping file size check on NT4')
batch.c:321: Test failed: unexpected char 0x5f position 32 in line 1584 (got 'Passed: file size check on file1_ascii_srccopy [5]', wanted 'Passed: file size check on file123_ascii_copy [25]@or_broken(a)Skipping file size check on NT4')
batch.c:321: Test failed: unexpected char 0x64 position 35 in line 1585 (got 'Passed: file size check on file123_default_copy [25]', wanted 'Passed: file size check on file123_binary_copy [27]@or_broken(a)Skipping file size check on NT4')
batch.c:321: Test failed: unexpected char 0x61 position 35 in line 1586 (got 'Passed: file size check on file123_ascii_copy [25]', wanted 'Passed: file size check on file123_mixed_copy1 [26]@or_broken(a)Skipping file size check on NT4')
batch.c:321: Test failed: unexpected char 0x62 position 35 in line 1587 (got 'Passed: file size check on file123_binary_copy [27]', wanted 'Passed: file size check on file123_mixed_copy2 [27]@or_broken(a)Skipping file size check on NT4')
batch.c:321: Test failed: unexpected char 0x31 position 45 in line 1588 (got 'Passed: file size check on file123_mixed_copy1 [26]', wanted 'Passed: file size check on file123_mixed_copy3 [26]@or_broken(a)Skipping file size check on NT4')
batch.c:321: Test failed: unexpected char 0x32 position 45 in line 1589 (got 'Passed: file size check on file123_mixed_copy2 [27]', wanted 'Passed: file size check on file123_mixed_copy4 [25]@or_broken(a)Skipping file size check on NT4')
batch.c:321: Test failed: unexpected char 0x33 position 45 in line 1590 (got 'Passed: file size check on file123_mixed_copy3 [26]', wanted 'Passed: file size check on file123_mixed_copy5 [28]@or_broken(a)Skipping file size check on NT4')
batch.c:321: Test failed: unexpected char 0x34 position 45 in line 1591 (got 'Passed: file size check on file123_mixed_copy4 [25]', wanted 'Passed: file size check on file123_mixed_copy6 [19]@or_broken(a)Skipping file size check on NT4')
batch.c:321: Test failed: unexpected char 0x35 position 45 in line 1592 (got 'Passed: file size check on file123_mixed_copy5 [28]', wanted 'Passed: file size check on file123_mixed_copy7 [6]@or_broken(a)Skipping file size check on NT4')
batch.c:321: Test failed: unexpected char 0x36 position 45 in line 1593 (got 'Passed: file size check on file123_mixed_copy6 [19]', wanted 'Passed: file size check on file123_mixed_copy8 [7]@or_broken(a)Skipping file size check on NT4')
batch.c:321: Test failed: unexpected char 0x66 position 8 in line 1594 (got 'Passed: file size check on file123_mixed_copy7 [6]', wanted 'Passed: errorlevel invalid check 1')
batch.c:321: Test failed: unexpected char 0x66 position 8 in line 1595 (got 'Passed: file size check on file123_mixed_copy8 [7]', wanted 'Passed: Did not find dir1\file1')
batch.c:321: Test failed: unexpected char 0x31 position 33 in line 1596 (got 'Passed: errorlevel invalid check 1', wanted 'Passed: errorlevel invalid check 2')
batch.c:321: Test failed: unexpected char 0x44 position 8 in line 1597 (got 'Passed: Did not find dir1\file1', wanted 'Passed: errorlevel invalid check 3')
batch.c:321: Test failed: unexpected char 0x46 position 0 in line 1598 (got 'Failed: errorlevel invalid check 2', wanted '------------ Testing setlocal/endlocal ------------')
batch.c:321: Test failed: unexpected char 0x46 position 0 in line 1599 (got 'Failed: errorlevel invalid check 3', wanted '------------ Testing setlocal/endlocal ------------')

kernel32:
file.c:700: Test failed: copying a file to itself didn't fail (ret=-2147024864, err=0)
file.c:724: Test failed: CopyFileA: unexpected error 0
file.c:732: Test failed: CopyFileA: ret = -2147024809, unexpected error 0
file.c:735: Test failed: CopyFileA: ret = -2147024893, unexpected error 0
file.c:742: Test failed: copying from a read-locked file succeeded when it shouldn't have
file.c:746: Test failed: copying from a file that doesn't exist failed in an unexpected way (ret=-2147024809, err=0)
file.c:770: Test failed: copying to a write-locked file didn't fail (ret=-2147024864, err=0)
file.c:789: Test failed: copying to a delete-locked shared file didn't fail (ret=-2147024864, err=0)
file.c:815: Test failed: CopyFileA: ret = -2147024864, unexpected error 0
file.c:831: Test failed: CopyFileA with mapped dest file: expected ERROR_SHARING_VIOLATION, got 0
file.c:845: Test failed: CopyFileA: expected failure
file.c:846: Test failed: CopyFileA with mapped dest file: expected ERROR_USER_MAPPED_FILE, got 0
file.c:882: Test failed: CopyFileW: unexpected error 0
file.c:1184: Test failed: CopyFileExA unexpectedly succeeded
file.c:1185: Test failed: expected ERROR_PATH_NOT_FOUND, got 0
file.c:1187: Test failed: CopyFileExA unexpectedly succeeded
file.c:1188: Test failed: expected ERROR_PATH_NOT_FOUND, got 0

mscms:
profile.c:648: Test failed: InstallColorProfileA() succeeded (0)
profile.c:702: Test failed: InstallColorProfileW() failed (0)

msi:
db.c:74: Test failed: expected failure
install.c:3462: Test failed: Expected file to be overwritten
install.c:4158: Test failed: Expected ERROR_INSTALL_FAILURE, got 0
install.c:4168: Test failed: Expected ERROR_INSTALL_FAILURE, got 0
install.c:5375: Test failed: Expected ERROR_SUCCESS_REBOOT_REQUIRED got 0
install.c:5312: Test failed: Expected a 'msitest' entry
install.c:5330: Test failed: Expected file to match

msvcp120:
msvcp120.c:1445: Test failed: test_tr2_sys__Copy_file(): test 3 expect: 80, got 0
msvcp120.c:1445: Test failed: test_tr2_sys__Copy_file(): test 5 expect: 5, got 0
msvcp120.c:1449: Test failed: test_tr2_sys__Copy_file(): test 5 failed, mismatched file sizes
msvcp120.c:1445: Test failed: test_tr2_sys__Copy_file(): test 6 expect: 5, got 0
msvcp120.c:1445: Test failed: test_tr2_sys__Copy_file(): test 9 expect: 2, got 0
msvcp120.c:1445: Test failed: test_tr2_sys__Copy_file(): test 10 expect: 3, got 0
msvcp120.c:1449: Test failed: test_tr2_sys__Copy_file(): test 10 failed, mismatched file sizes
msvcp120.c:1445: Test failed: test_tr2_sys__Copy_file(): test 11 expect: 5, got 0
msvcp120.c:1449: Test failed: test_tr2_sys__Copy_file(): test 11 failed, mismatched file sizes

msvcp140:
msvcp140.c:1609: Test failed: Got unexpected ret 0.
msvcp140.c:1614: Test failed: Got unexpected ret 0.
msvcp140.c:1631: Test failed: Got unexpected ret 0.

setupapi:
install.c:1166: Test failed: Destination file should exist.
install.c:1167: Test failed: Destination file should exist.
install.c:1168: Test failed: Destination file should exist.
install.c:1169: Test failed: Destination file should exist.
install.c:1756: Test failed: Destination file should exist.
install.c:1757: Test failed: Destination file should exist.
install.c:1769: Test failed: Destination file should exist.
install.c:1770: Test failed: Destination file should exist.
install.c:1885: Test failed: Got 1 callbacks.
install.c:1887: Test failed: Destination file should exist.
install.c:1888: Test failed: Destination file should exist.
install.c:1902: Test failed: Got 0 copy errors.
install.c:1919: Test failed: Got 0 copy errors.
install.c:1921: Test failed: Destination file should exist.
install.c:1922: Test failed: Destination file should exist.
install.c:1938: Test failed: Got 0 copy errors.
install.c:1940: Test failed: Destination file should exist.
install.c:1941: Test failed: Destination file should exist.
install.c:1956: Test failed: Destination file should exist.
install.c:1957: Test failed: Destination file should exist.
install.c:1483: Test succeeded inside todo block: Expected success.
install.c:1484: Test succeeded inside todo block: Got unexpected error 0.
install.c:1491: Test failed: Expected failure.
install.c:1492: Test failed: Got unexpected error 0.

shell32:
shlfileop.c:1031: Test failed: CopyFileA should have fail with ERROR_ACCESS_DENIED