[PATCH v10 0/1] MR5373: shell32: Implement FCIDM_SHVIEW_CREATELINK

[Aric Stewart (＠aricstewart)]

Presently the wine file explorer has a create shortcut entry that does nothing. This implements the FCIDM_SHVIEW_CREATELINK command.

This is a patch that was first submitted in 2017 and I unfortunately let the revision request fall unimplemented.

--
  v10: shell32: Implement FCIDM_SHVIEW_CREATELINK

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

[PATCH v10 1/1] shell32: Implement FCIDM_SHVIEW_CREATELINK

[Aric Stewart]

From: Aric Stewart

---
 dlls/shell32/shell32.rc        |   1 +
 dlls/shell32/shlview_cmenu.c   | 106 +++++++++++++++++++++++++
 dlls/shell32/shresdef.h        |   2 +
 dlls/shell32/tests/shlfolder.c | 141 ++++++++++++++++++++++++++++++++-
 4 files changed, 249 insertions(+), 1 deletion(-)

diff --git a/dlls/shell32/shell32.rc b/dlls/shell32/shell32.rc
index f1b0bc50cca..55632a1539d 100644
--- a/dlls/shell32/shell32.rc
+++ b/dlls/shell32/shell32.rc
@@ -250,6 +250,7 @@ the folder?"
         IDS_RECYCLEBIN_OVERWRITEFILE      "A file already exists at the path %1.\n\nDo you want to replace it?"
         IDS_RECYCLEBIN_OVERWRITEFOLDER      "A folder already exists at the path %1.\n\nDo you want to replace it?"
         IDS_RECYCLEBIN_OVERWRITE_CAPTION    "Confirm overwrite"
+        IDS_SHORTCUT    "Shortcut"
 }

STRINGTABLE
diff --git a/dlls/shell32/shlview_cmenu.c b/dlls/shell32/shlview_cmenu.c
index cac33c39af7..a70426fd921 100644
--- a/dlls/shell32/shlview_cmenu.c
+++ b/dlls/shell32/shlview_cmenu.c
@@ -946,6 +946,109 @@ static void DoOpenProperties(ContextMenu *This, HWND hwnd)
        FIXME("No property pages found.\n");
 }

+
+static HRESULT DoCreateLink(ContextMenu *This)
+{
+    IShellLinkW* shelllink;
+    IPersistFile* persistfile;
+    WCHAR filename[MAX_PATH];
+    WCHAR root[MAX_PATH];
+    WCHAR lnkfile[MAX_PATH];
+    ITEMIDLIST *full_pidl;
+    HRESULT hr = S_OK;
+    int counter = 1;
+    WCHAR shortcutW[255];
+    WCHAR *link_filename;
+    int length;
+
+    LoadStringW(shell32_hInstance, IDS_SHORTCUT, shortcutW, ARRAY_SIZE(shortcutW));
+
+    if (FAILED(hr = IShellLink_Constructor(NULL, &IID_IShellLinkW, (LPVOID*)&shelllink)))
+    {
+        return hr;
+    }
+    full_pidl = ILCombine(This->pidl, This->apidl[0]);
+    if (!full_pidl)
+    {
+        IShellLinkW_Release(shelllink);
+        return E_OUTOFMEMORY;
+    }
+
+    hr = IShellLinkW_SetIDList(shelllink, full_pidl);
+    ILFree(full_pidl);
+    if (FAILED(hr))
+    {
+        IShellLinkW_Release(shelllink);
+        return hr;
+    }
+
+    if (!_ILSimpleGetTextW(This->apidl[0], (LPVOID)filename, MAX_PATH))
+    {
+        IShellLinkW_Release(shelllink);
+        return E_FAIL;
+    }
+
+    if (!SHGetPathFromIDListW(This->pidl, root))
+    {
+        /* Special PIDL, use the desktop */
+        if (FAILED(SHGetFolderPathW(NULL, CSIDL_DESKTOP, NULL, 0, root))) {
+            IShellLinkW_Release(shelllink);
+            return E_FAIL;
+        }
+    }
+
+    /* Clear Extension */
+    PathRenameExtensionW(filename, L"");
+
+    IShellLinkW_QueryInterface(shelllink, &IID_IPersistFile, (LPVOID*)&persistfile);
+    length = wcslen(filename) + wcslen(shortcutW) + 41; /* length of the format and counter */
+    link_filename = malloc((length + 1) * sizeof(WCHAR));
+    if (link_filename == NULL) {
+        IShellLinkW_Release(shelllink);
+        return E_OUTOFMEMORY;
+    }
+
+    do {
+        if (counter == 1)
+        {
+            static const WCHAR *fmt = L"%s - %s.lnk";
+            wsprintfW(link_filename, fmt, filename, shortcutW);
+        }
+        else
+        {
+            static const WCHAR *fmt = L"%s - %s (%u).lnk";
+            wsprintfW(link_filename, fmt, filename, shortcutW, counter);
+        }
+
+        length = wcslen(root) + wcslen(link_filename) + 2; /* the path seperator and NULL */
+        if (length > MAX_PATH)
+        {
+            IShellLinkW_Release(shelllink);
+            free(link_filename);
+            return E_INVALIDARG;
+        }
+
+        PathCombineW(lnkfile, root, link_filename);
+        counter++;
+
+        if (PathFileExistsW(lnkfile))
+        {
+            hr = HRESULT_FROM_WIN32(ERROR_FILE_EXISTS);
+        }
+        else
+        {
+            hr = IPersistFile_Save(persistfile, lnkfile, FALSE);
+        }
+    } while (hr == HRESULT_FROM_WIN32(ERROR_FILE_EXISTS));
+
+    free(link_filename);
+
+    IPersistFile_Release(persistfile);
+    IShellLinkW_Release(shelllink);
+
+    return hr;
+}
+
 static HRESULT WINAPI ItemMenu_InvokeCommand(
    IContextMenu3 *iface,
    LPCMINVOKECOMMANDINFO lpcmi)
@@ -1014,6 +1117,9 @@ static HRESULT WINAPI ItemMenu_InvokeCommand(
             TRACE("Verb FCIDM_SHVIEW_PROPERTIES\n");
             DoOpenProperties(This, lpcmi->hwnd);
             break;
+        case FCIDM_SHVIEW_CREATELINK:
+            TRACE("Verb FCIDM_SHVIEW_CREATELINK\n");
+            return DoCreateLink(This);
         default:
             FIXME("Unhandled verb %#x.\n", id);
             return E_INVALIDARG;
diff --git a/dlls/shell32/shresdef.h b/dlls/shell32/shresdef.h
index deabe568022..a2243ad84ee 100644
--- a/dlls/shell32/shresdef.h
+++ b/dlls/shell32/shresdef.h
@@ -139,6 +139,8 @@

#define IDS_NEW_MENU_FOLDER         180

+#define IDS_SHORTCUT                4153
+
 #define IDS_LICENSE                 256
 #define IDS_LICENSE_CAPTION         257

diff --git a/dlls/shell32/tests/shlfolder.c b/dlls/shell32/tests/shlfolder.c
index 5f8b4dc3470..1eeb7f8d248 100644
--- a/dlls/shell32/tests/shlfolder.c
+++ b/dlls/shell32/tests/shlfolder.c
@@ -37,6 +37,8 @@
 #include "ocidl.h"
 #include "oleauto.h"

+#include "../shresdef.h"
+
 #include "wine/test.h"

#include <initguid.h>
@@ -6276,13 +6278,149 @@ static void test_copy_paste(void)
     SetCurrentDirectoryW(cwd);
 }

+static void test_link(void)
+{
+    CMINVOKECOMMANDINFO invoke_info = {.cbSize = sizeof(invoke_info)};
+    WCHAR cwd[MAX_PATH], temp_path[MAX_PATH];
+    ITEMIDLIST *pidl, *src_pidl;
+    IShellFolder *tmp_folder;
+    IContextMenu *menu;
+    HRESULT hr;
+    WIN32_FIND_DATAW findFileData;
+    WCHAR lnkpath[MAX_PATH];
+    HANDLE handle;
+    WCHAR shortcutW[255];
+    HINSTANCE shell32_hInstance = LoadLibraryW(L"shell32.dll");
+    const WCHAR filename[] = L"test_link.txt";
+    const WCHAR targetname[] = L"test_link";
+    CHAR LongFile[MAX_PATH];
+    WCHAR *filename2;
+    INT length, i;
+    INT targetCmd=0;
+    INT count;
+    HMENU hmenu = CreatePopupMenu();
+
+    /* Setup */
+    GetCurrentDirectoryW(ARRAY_SIZE(cwd), cwd);
+    GetTempPathW(ARRAY_SIZE(temp_path), temp_path);
+    SetCurrentDirectoryW(temp_path);
+
+    CreateTestFile(".\test_link.txt");
+
+    length = MAX_PATH - (lstrlenW(temp_path) + 4);
+    for (i = 0; i < length; i++) LongFile[i] = 'a';
+    LongFile[i] = 0;
+    filename2 = make_wstr(LongFile);
+    CreateTestFile(LongFile);
+
+    LoadStringW(shell32_hInstance, IDS_SHORTCUT, shortcutW, ARRAY_SIZE(shortcutW));
+
+    hr = SHParseDisplayName(temp_path, NULL, &pidl, 0, NULL);
+    ok(hr == S_OK, "Got hr %#lx.\n", hr);
+    hr = SHBindToObject(NULL, pidl, NULL, &IID_IShellFolder, (void **)&tmp_folder);
+    ok(hr == S_OK, "Got hr %#lx.\n", hr);
+    ILFree(pidl);
+
+    hr = IShellFolder_ParseDisplayName(tmp_folder, NULL, NULL, (WCHAR*)filename, NULL, &src_pidl, NULL);
+    ok(hr == S_OK, "Got hr %#lx.\n", hr);
+
+    hr = IShellFolder_GetUIObjectOf(tmp_folder, NULL, 1, (const ITEMIDLIST **)&src_pidl,
+            &IID_IContextMenu, NULL, (void **)&menu);
+    ok(hr == S_OK, "Got hr %#lx.\n", hr);
+
+    /* Find Command */
+    IContextMenu_QueryContextMenu(menu, hmenu, 0, 64, 32767, CMF_NORMAL);
+    count = GetMenuItemCount(hmenu);
+    for (i = 0; i < count; i++)
+    {
+        MENUITEMINFOA mii;
+        INT res;
+        char buf[255], buf2[255];
+        ZeroMemory(&mii, sizeof(MENUITEMINFOA));
+        mii.cbSize = sizeof(MENUITEMINFOA);
+        mii.fMask = MIIM_ID | MIIM_FTYPE | MIIM_STRING;
+        mii.dwTypeData = buf2;
+        mii.cch = sizeof(buf2);
+
+        res = GetMenuItemInfoA(hmenu, i, TRUE, &mii);
+        ok(res, "Failed to get menu item info, error %ld.\n", GetLastError());
+        if (!(mii.fType & MFT_SEPARATOR)) {
+            hr = IContextMenu_GetCommandString(menu, mii.wID - 64, GCS_VERBA, 0, buf, sizeof(buf));
+            ok(hr == S_OK || hr == E_NOTIMPL || hr == E_INVALIDARG,
+                "Got unexpected hr %#lx for ID %d, string %s.\n", hr, mii.wID, debugstr_a(mii.dwTypeData));
+            if (hr == S_OK)
+            {
+                if (!strcmp(buf, "link")) {
+                    targetCmd = mii.wID - 64;
+                    break;
+                }
+            }
+        }
+    }
+    DestroyMenu(hmenu);
+
+    ok (targetCmd != 0, "Failed to find link command\n");
+    if (targetCmd == 0)
+        return;
+
+    invoke_info.lpVerb = MAKEINTRESOURCEA(targetCmd);
+
+    /* Basic Success */
+    hr = IContextMenu_InvokeCommand(menu, &invoke_info);
+    ok(hr == S_OK, "Got hr %#lx.\n", hr);
+
+    /* Second Success */
+    hr = IContextMenu_InvokeCommand(menu, &invoke_info);
+    ok(hr == S_OK, "Got hr %#lx.\n", hr);
+
+    swprintf(lnkpath, ARRAY_SIZE(lnkpath),L"%s%s - %s.lnk", temp_path, targetname, shortcutW);
+    handle = FindFirstFileW(lnkpath, &findFileData);
+    ok(handle != INVALID_HANDLE_VALUE, "Failed to find %s\n", debugstr_w(lnkpath));
+    if (handle != INVALID_HANDLE_VALUE) FindClose(handle);
+
+    swprintf(lnkpath, ARRAY_SIZE(lnkpath),L"%s%s - %s (%u).lnk", temp_path, targetname, shortcutW, 2);
+    handle = FindFirstFileW(lnkpath, &findFileData);
+    ok(handle != INVALID_HANDLE_VALUE, "Failed to find %s\n",debugstr_w(lnkpath));
+    if (handle != INVALID_HANDLE_VALUE) FindClose(handle);
+
+    /* Path too long*/
+    hr = IShellFolder_ParseDisplayName(tmp_folder, NULL, NULL, filename2, NULL, &src_pidl, NULL);
+    ok(hr == S_OK, "Got hr %#lx.\n", hr);
+
+    hr = IShellFolder_GetUIObjectOf(tmp_folder, NULL, 1, (const ITEMIDLIST **)&src_pidl,
+            &IID_IContextMenu, NULL, (void **)&menu);
+    ok(hr == S_OK, "Got hr %#lx.\n", hr);
+
+    invoke_info.lpVerb = MAKEINTRESOURCEA(targetCmd);
+    hr = IContextMenu_InvokeCommand(menu, &invoke_info);
+    ok(hr == E_INVALIDARG, "Got hr %#lx.\n", hr);
+
+    /* Cleanup */
+    swprintf(lnkpath, ARRAY_SIZE(lnkpath), L"%stest_link*.lnk", temp_path);
+    handle = FindFirstFileW(lnkpath, &findFileData);
+    if (handle != INVALID_HANDLE_VALUE) {
+        do {
+            DeleteFileW(findFileData.cFileName);
+        } while (FindNextFileW(handle, &findFileData) != 0);
+        FindClose(handle);
+    }
+    DeleteFileW(filename);
+    DeleteFileW(filename2);
+    free(filename2);
+
+    IContextMenu_Release(menu);
+    ILFree(src_pidl);
+    IShellFolder_Release(tmp_folder);
+    SetCurrentDirectoryW(cwd);
+
+}
+
 START_TEST(shlfolder)
 {
     init_function_pointers();
     /* if OleInitialize doesn't get called, ParseDisplayName returns
        CO_E_NOTINITIALIZED for malformed directory names */
     OleInitialize(NULL);
-
     test_SHBindToFolderIDListParent();
     test_ParseDisplayName();
     test_SHParseDisplayName();
@@ -6324,6 +6462,7 @@ START_TEST(shlfolder)
     test_SHGetSetFolderCustomSettings();
     test_SHOpenFolderAndSelectItems();
     test_copy_paste();
+    test_link();

OleUninitialize();
 }