[PATCH v10 0/2] MR566: shell32: Implement SHBindToFolderIDListParent.

[Mohamad Al-Jaf (＠maljaf)]

Called by IE11.

Signed-off-by: Mohamad Al-Jaf

v4: Don't reimplement SHBindToParent.

--
  v10: shell32/tests: Add SHBindToFolderIDListParent tests.
       shell32: Implement SHBindToFolderIDListParent.

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

[PATCH v10 1/2] shell32: Implement SHBindToFolderIDListParent.

[Mohamad Al-Jaf]

From: Mohamad Al-Jaf

Called by IE11.

Signed-off-by: Mohamad Al-Jaf 
---
 dlls/shell32/pidl.c       | 50 +++++++++++++++++++++++++++++++++++++++
 dlls/shell32/shell32.spec |  1 +
 include/shlobj.h          |  2 ++
 3 files changed, 53 insertions(+)

diff --git a/dlls/shell32/pidl.c b/dlls/shell32/pidl.c
index f9c91a79132..aedce020e06 100644
--- a/dlls/shell32/pidl.c
+++ b/dlls/shell32/pidl.c
@@ -1285,6 +1285,56 @@ BOOL WINAPI SHGetPathFromIDListEx(LPCITEMIDLIST pidl, WCHAR *path, DWORD path_si
     return SUCCEEDED(hr);
 }

+/*************************************************************************
+ * SHBindToFolderIDListParent             [SHELL32.@]
+ */
+HRESULT WINAPI SHBindToFolderIDListParent(IShellFolder *psf, LPCITEMIDLIST pidl, REFIID riid, LPVOID *ppv, LPCITEMIDLIST *ppidlLast)
+{
+    IShellFolder *psfDesktop = NULL;
+    HRESULT hr;
+
+    TRACE_(shell)("%p,%p,%s\n", psf, pidl, debugstr_guid(riid));
+    pdump(pidl);
+
+    if (ppidlLast)
+        *ppidlLast = NULL;
+
+    if (!pidl || !ppv)
+        return E_INVALIDARG;
+
+    *ppv = NULL;
+
+    if (!psf)
+    {
+        hr = SHGetDesktopFolder(&psfDesktop);
+        if (FAILED(hr))
+            return hr;
+        psf = psfDesktop;
+    }
+
+    if (_ILIsPidlSimple(pidl))
+    {
+        /* we are on desktop level */
+        hr = IShellFolder_QueryInterface(psf, riid, ppv);
+    }
+    else
+    {
+        LPITEMIDLIST pidlParent = ILClone(pidl);
+        ILRemoveLastID(pidlParent);
+        hr = IShellFolder_BindToObject(psf, pidlParent, NULL, riid, ppv);
+        SHFree (pidlParent);
+    }
+
+    if (psfDesktop)
+        IShellFolder_Release(psfDesktop);
+
+    if (SUCCEEDED(hr) && ppidlLast)
+        *ppidlLast = ILFindLastID(pidl);
+
+    TRACE_(shell)("-- ppv=%p pidl=%p ret=0x%08lx\n", *ppv, (ppidlLast)?*ppidlLast:NULL, hr);
+    return hr;
+}
+
 /*************************************************************************
  *    SHBindToParent        [shell version 5.0]
  */
diff --git a/dlls/shell32/shell32.spec b/dlls/shell32/shell32.spec
index 4a64b80ddd9..aba9166920a 100644
--- a/dlls/shell32/shell32.spec
+++ b/dlls/shell32/shell32.spec
@@ -334,6 +334,7 @@
 @ stdcall SHAssocEnumHandlers(wstr long ptr)
 @ stdcall SHBindToObject(ptr ptr ptr ptr ptr)
 @ stdcall SHBindToParent(ptr ptr ptr ptr)
+@ stdcall SHBindToFolderIDListParent(ptr ptr ptr ptr ptr)
 @ stdcall SHBrowseForFolder(ptr) SHBrowseForFolderA
 @ stdcall SHBrowseForFolderA(ptr)
 @ stdcall SHBrowseForFolderW(ptr)
diff --git a/include/shlobj.h b/include/shlobj.h
index c7452cf5f0a..4cb7375bb59 100644
--- a/include/shlobj.h
+++ b/include/shlobj.h
@@ -1748,6 +1748,8 @@ WINSHELLAPI HRESULT WINAPI SHGetFolderPathW(HWND hwnd, int nFolder, HANDLE hToke
  */
 WINSHELLAPI HRESULT WINAPI SHGetDesktopFolder(IShellFolder * *);

+HRESULT WINAPI SHBindToFolderIDListParent(IShellFolder *psf, LPCITEMIDLIST pidl, REFIID riid, LPVOID *ppv, LPCITEMIDLIST *ppidlLast);
+
 /****************************************************************************
  * SHBindToParent API
  */

[PATCH v10 2/2] shell32/tests: Add SHBindToFolderIDListParent tests.

[Dmitry Timoshkov]

From: Dmitry Timoshkov

---
 dlls/shell32/tests/shlfolder.c | 53 ++++++++++++++++++++++++++++++++++
 1 file changed, 53 insertions(+)

diff --git a/dlls/shell32/tests/shlfolder.c b/dlls/shell32/tests/shlfolder.c
index dc0b6cb2ee2..e799f469685 100644
--- a/dlls/shell32/tests/shlfolder.c
+++ b/dlls/shell32/tests/shlfolder.c
@@ -60,6 +60,7 @@ static BOOL (WINAPI *pIsWow64Process)(HANDLE, PBOOL);
 static HRESULT (WINAPI *pSHCreateDefaultContextMenu)(const DEFCONTEXTMENU*,REFIID,void**);
 static BOOL (WINAPI *pSHGetPathFromIDListEx)(PCIDLIST_ABSOLUTE,WCHAR*,DWORD,GPFIDL_FLAGS);
 static HRESULT (WINAPI *pSHGetSetFolderCustomSettings)(LPSHFOLDERCUSTOMSETTINGS,PCWSTR,DWORD);
+static HRESULT (WINAPI *pSHBindToFolderIDListParent)(IShellFolder*,LPCITEMIDLIST,REFIID,void **,LPCITEMIDLIST*);

static WCHAR *make_wstr(const char *str)
 {
@@ -120,6 +121,7 @@ static void init_function_pointers(void)
     hmod = GetModuleHandleA("shell32.dll");

#define MAKEFUNC(f) (p##f = (void*)GetProcAddress(hmod, #f))
+    MAKEFUNC(SHBindToFolderIDListParent);
     MAKEFUNC(SHCreateItemFromIDList);
     MAKEFUNC(SHCreateItemFromParsingName);
     MAKEFUNC(SHCreateItemFromRelativeName);
@@ -5550,6 +5552,56 @@ static void test_SHOpenFolderAndSelectItems(void)
     ILFree(folder);
 }

+static void test_SHBindToFolderIDListParent(void)
+{
+    IShellFolder *psf_desktop;
+    LPITEMIDLIST pidl;
+    HRESULT hr;
+    WCHAR path[MAX_PATH];
+    SHITEMID empty_item = { 0, { 0 } };
+    LPITEMIDLIST pidl_empty = (LPITEMIDLIST)&empty_item;
+    LPCITEMIDLIST pidl_last;
+    IShellFolder *psf;
+
+    if (!pSHBindToFolderIDListParent)
+    {
+        win_skip("SHBindToFolderIDListParent not available\n");
+        return;
+    }
+
+    GetTempPathW(ARRAY_SIZE(path), path);
+    SHGetDesktopFolder(&psf_desktop);
+
+    hr = IShellFolder_ParseDisplayName(psf_desktop, NULL, NULL, path, NULL, &pidl, 0);
+    ok(hr == S_OK, "got %#lx\n", hr);
+
+    pidl_last = NULL;
+    hr = pSHBindToFolderIDListParent(psf_desktop, pidl, &IID_IShellFolder, (void **)&psf, &pidl_last);
+    ok(hr == S_OK, "got %#lx\n", hr);
+    ok(pidl_last != NULL, "got %p\n", pidl_last);
+    IShellFolder_Release(psf);
+
+    hr = pSHBindToFolderIDListParent(NULL, pidl_empty, &IID_IShellFolder, (void **)&psf, &pidl_last);
+    ok(hr == S_OK, "got %#lx\n", hr);
+    ok(pidl_last == pidl_empty, "got %p\n", pidl_last);
+    IShellFolder_Release(psf);
+
+    hr = pSHBindToFolderIDListParent(NULL, pidl, &IID_IShellFolder, (void **)&psf, NULL);
+    ok(hr == S_OK, "got %#lx\n", hr);
+    IShellFolder_Release(psf);
+
+    if (0) /* crashes under Windows */
+        hr = pSHBindToFolderIDListParent(NULL, pidl, &IID_IShellFolder, NULL, NULL);
+
+    ILFree(pidl);
+    IShellFolder_Release(psf_desktop);
+
+    pidl_last = (LPITEMIDLIST)0xdeadbeef;
+    hr = pSHBindToFolderIDListParent(NULL, NULL, &IID_IShellFolder, (void **)&psf, &pidl_last);
+    ok(hr == E_INVALIDARG, "got %#lx\n", hr);
+    ok(pidl_last == NULL, "got %p\n", pidl_last);
+}
+
 START_TEST(shlfolder)
 {
     init_function_pointers();
@@ -5557,6 +5609,7 @@ START_TEST(shlfolder)
        CO_E_NOTINITIALIZED for malformed directory names */
     OleInitialize(NULL);

+    test_SHBindToFolderIDListParent();
     test_ParseDisplayName();
     test_SHParseDisplayName();
     test_BindToObject();

[Huw Davies (＠huw)]

I've not really been following this, but why doesn't `SHBindToParent()` call `SHBindToFolderIDListParent()`?

What you want to do is to implement `SHBindToFolderIDListParent()` using the code in `SHBindToParent()` as a start, adding the code to deal with the passed in `IShellFolder`.  Then **in the same commit** change `SHBindToParent()` to call `SHBindToFolderIDListParent()`.  With careful choice of the positioning of the second function with respect to first one, the diff should be quite small.