CShellLink.cpp File Reference

#include "shelltest.h"
#include <debug.h>
#include <stdio.h>
#include <shellapi.h>
#include <versionhelpers.h>
#include <shellutils.h>

Include dependency graph for CShellLink.cpp:

Go to the source code of this file.

Classes
struct	TEST_SHELL_LINK_DEF
struct	TEST_SHELL_ICON

Macros
#define	NDEBUG
#define	Test_SHGNLI(path, dir, rdir, rfile, rext, flags, ret, mustcopy)
#define	SHGNLIFileName   L"ROS_Test_Shell32"

Functions
static VOID	test_checklinkpath (UINT i, TEST_SHELL_LINK_DEF *testDef)
static VOID	TestShellLink (void)
static VOID	TestDescription (void)
static VOID	test_iconlocation (UINT i, TEST_SHELL_ICON *testDef)
static VOID	TestIconLocation (void)
	START_TEST (CShellLink)
	START_TEST (SHGetNewLinkInfo)

Variables
static TEST_SHELL_LINK_DEF	linkTestList_WS03 []
static TEST_SHELL_LINK_DEF	linkTestList_Vista []
static TEST_SHELL_ICON	ShIconTests []

Macro Definition Documentation

NDEBUG

#define NDEBUG

Definition at line 10 of file CShellLink.cpp.

SHGNLIFileName

#define SHGNLIFileName   L"ROS_Test_Shell32"

Test_SHGNLI

#define Test_SHGNLI	(		path,
			dir,
			rdir,
			rfile,
			rext,
			flags,
			ret,
			mustcopy
	)

Value:

    do \
    { \
        WCHAR Result[MAX_PATH], Buf[MAX_PATH]; \
        BOOL MustCopy, Success = SHGetNewLinkInfoW((path), (dir), lstrcpyW(Result, L"?"), &MustCopy, (flags)); \
        ok(Success == (ret), "Return (%#x)\n", UINT(flags)); \
        ok(MustCopy == (mustcopy), "MustCopy (%#x)\n", UINT(flags)); \
        lstrcpyW(Buf, (rdir)); \
        if (*Buf) PathAddBackslashW(Buf); \
        lstrcatW(Buf, (rfile)); \
        lstrcatW(Buf, (rext)); \
        ok((!(ret) && !Success) || !_wcsicmp(Result, Buf), "%ls should be %ls (%#x)\n", Result, Buf, UINT(flags)); \
    } while(0)

Function Documentation

START_TEST() [1/2]

START_TEST

(

CShellLink

)

Definition at line 476 of file CShellLink.cpp.

{
    CCoInit ComInit;
 
    TestShellLink();
    TestDescription();
    TestIconLocation();
}

START_TEST() [2/2]

START_TEST

(

SHGetNewLinkInfo

)

Definition at line 485 of file CShellLink.cpp.

{
    CCoInit ComInit;
    LPCWSTR DotUrlOn7 = IsReactOS() || GetNTVersion() >= _WIN32_WINNT_WIN7 ? L".url" : L".lnk";
    WCHAR FullTarget[MAX_PATH], Dir[MAX_PATH];
 
    SHGetSpecialFolderPathW(NULL, Dir, CSIDL_PROFILE, TRUE);
 
    GetModuleFileNameW(GetModuleHandleW(L"KERNEL32"), FullTarget, _countof(FullTarget));
    LPWSTR TargetFile = PathFindFileNameW(FullTarget);
 
    #define Test_SHGNLI(path, dir, rdir, rfile, rext, flags, ret, mustcopy) do \
    { \
        WCHAR Result[MAX_PATH], Buf[MAX_PATH]; \
        BOOL MustCopy, Success = SHGetNewLinkInfoW((path), (dir), lstrcpyW(Result, L"?"), &MustCopy, (flags)); \
        ok(Success == (ret), "Return (%#x)\n", UINT(flags)); \
        ok(MustCopy == (mustcopy), "MustCopy (%#x)\n", UINT(flags)); \
        lstrcpyW(Buf, (rdir)); \
        if (*Buf) PathAddBackslashW(Buf); \
        lstrcatW(Buf, (rfile)); \
        lstrcatW(Buf, (rext)); \
        ok((!(ret) && !Success) || !_wcsicmp(Result, Buf), "%ls should be %ls (%#x)\n", Result, Buf, UINT(flags)); \
    } while(0)
 
    Test_SHGNLI(FullTarget, Dir, Dir, TargetFile, L".lnk", 0, 1, 0);
 
    CComHeapPtr<ITEMIDLIST> pidl(SHELL_SimpleIDListFromPath(FullTarget));
    Test_SHGNLI((LPWSTR)(LPITEMIDLIST)pidl, Dir, Dir, TargetFile, L".lnk", SHGNLI_PIDL, 1, 0);
 
    Test_SHGNLI(FullTarget, Dir, L"", TargetFile, L".lnk", SHGNLI_NOUNIQUE, 1, 0);
 
    Test_SHGNLI(FullTarget, Dir, Dir, TargetFile, L"", SHGNLI_NOLNK, 1, 0);
    Test_SHGNLI(FullTarget, Dir, L"", TargetFile, L"", SHGNLI_NOLNK | SHGNLI_NOUNIQUE, 1, 0);
    Test_SHGNLI(FullTarget, Dir, Dir, TargetFile, L"", SHGNLI_NOLNK | SHGNLI_USEURLEXT, 1, 0);
 
    Test_SHGNLI(FullTarget, Dir, Dir, TargetFile, DotUrlOn7, SHGNLI_USEURLEXT, 1, 0);
 
    PathRemoveExtensionW(FullTarget);
    Test_SHGNLI(FullTarget, Dir, L"", L"", L"", 0, 0, 0); // Target does not exist
 
    #define SHGNLIFileName L"ROS_Test_Shell32"
    PathAppendW(lstrcpyW(FullTarget, Dir), SHGNLIFileName L".lnk");
    CloseHandle(CreateFileW(FullTarget, 0, 7, NULL, OPEN_ALWAYS, 0, NULL));
    Test_SHGNLI(FullTarget, Dir, Dir, SHGNLIFileName L" (2)", L".lnk", 0, 1, 1);
    Test_SHGNLI(FullTarget, Dir, L"", SHGNLIFileName, L".lnk", SHGNLI_NOUNIQUE, 1, 1);
    Test_SHGNLI(FullTarget, Dir, Dir, SHGNLIFileName L" (2)", L".lnk", SHGNLI_NOLNK, 1, 1); // SFGAO_LINK ignores SHGNLI_NOLNK
    DeleteFileW(FullTarget);
}

test_checklinkpath()

static VOID test_checklinkpath ( UINT  i, TEST_SHELL_LINK_DEF *  testDef  )

static

Definition at line 156 of file CShellLink.cpp.

{
static WCHAR evVar[MAX_PATH];
 
    HRESULT hr, expectedHr;
    WCHAR wPathOut[MAX_PATH];
    BOOL expandPathOut;
    PCWSTR expectedPathOut;
    CComPtr<IShellLinkW> psl;
    UINT i1;
    DWORD flags;
 
    hr = CoCreateInstance(CLSID_ShellLink,
                          NULL,
                          CLSCTX_INPROC_SERVER,
                          IID_PPV_ARG(IShellLinkW, &psl));
    ok(hr == S_OK, "CoCreateInstance, hr = 0x%lx\n", hr);
    if (FAILED(hr))
    {
        skip("Could not instantiate CShellLink\n");
        return;
    }
 
    hr = psl->SetPath(testDef->pathIn);
    ok(hr == testDef->hrSetPath, "IShellLink::SetPath(%d), got hr = 0x%lx, expected 0x%lx\n", i, hr, testDef->hrSetPath);
 
    expectedPathOut = NULL;
    for (i1 = 0; i1 <= 1; i1++)
    {
        if (i1 == 0) /* Usually SLGP_SHORTPATH */
        {
            flags = testDef->flags1;
            expandPathOut = testDef->expandPathOut1;
            expectedPathOut = testDef->pathOut1;
            expectedHr = testDef->hrGetPath1;
        }
        else // if (i1 == 1) /* Usually SLGP_RAWPATH */
        {
            flags = testDef->flags2;
            expandPathOut = testDef->expandPathOut2;
            expectedPathOut = testDef->pathOut2;
            expectedHr = testDef->hrGetPath2;
        }
 
        /* Patch some variables */
        if (expandPathOut)
        {
            ExpandEnvironmentStringsW(expectedPathOut, evVar, _countof(evVar));
            DPRINT("** %S **\n",evVar);
            expectedPathOut = evVar;
        }
 
        hr = psl->GetPath(wPathOut, _countof(wPathOut), NULL, flags);
        ok(hr == expectedHr,
           "IShellLink::GetPath(%d), flags 0x%lx, got hr = 0x%lx, expected 0x%lx\n",
            i, flags, hr, expectedHr);
        ok(_wcsicmp(wPathOut, expectedPathOut) == 0,
           "IShellLink::GetPath(%d), flags 0x%lx, in %S, got %S, expected %S\n",
           i, flags, testDef->pathIn, wPathOut, expectedPathOut);
    }
}

Referenced by TestShellLink().

test_iconlocation()

static VOID test_iconlocation ( UINT  i, TEST_SHELL_ICON *  testDef  )

static

Definition at line 333 of file CShellLink.cpp.

{
    HRESULT hr;
    CComPtr<IShellLinkW> psl;
    CComPtr<IExtractIconW> pei;
    INT iIcon;
    UINT wFlags;
    PCWSTR pszExplorer = L"%SystemRoot%\\explorer.exe";
    WCHAR szPath[MAX_PATH];
    WCHAR szPath2[MAX_PATH];
 
    hr = CoCreateInstance(CLSID_ShellLink,
                          NULL,
                          CLSCTX_INPROC_SERVER,
                          IID_PPV_ARG(IShellLinkW, &psl));
    ok(hr == S_OK, "CoCreateInstance, hr = 0x%lx\n", hr);
    if (FAILED(hr))
    {
        skip("Could not instantiate CShellLink\n");
        return;
    }
 
    /* Set the path to a file */
    ExpandEnvironmentStringsW(testDef->FilePath, szPath, _countof(szPath));
    hr = psl->SetPath(szPath);
    ok(hr == S_OK, "IShellLink::SetPath failed, hr = 0x%lx\n", hr);
 
    /*
     * This test shows that this does not imply that the icon is automatically
     * set and be retrieved naively by a call to IShellLink::GetIconLocation.
     */
    iIcon = 0xdeadbeef;
    wcscpy(szPath, L"garbage");
    hr = psl->GetIconLocation(szPath, _countof(szPath), &iIcon);
    ok(hr == S_OK, "IShellLink::GetIconLocation(%d) failed, hr = 0x%lx\n", i, hr);
    ok(*szPath == L'\0', "IShellLink::GetIconLocation(%d) returned '%S'\n", i, szPath);
    ok(iIcon == 0, "IShellLink::GetIconLocation(%d) returned %d, expected %d\n", i, iIcon, 0);
 
    /* Try to grab the IExtractIconW interface */
    hr = psl->QueryInterface(IID_PPV_ARG(IExtractIconW, &pei));
    ok(hr == S_OK, "IShellLink::QueryInterface(IExtractIconW)(%d) failed, hr = 0x%lx\n", i, hr);
    if (!pei)
    {
        win_skip("No IExtractIconW interface\n");
        return;
    }
 
    iIcon = wFlags = 0xdeadbeef;
    wcscpy(szPath, L"garbage");
    hr = pei->GetIconLocation(GIL_DEFAULTICON, szPath, _countof(szPath), &iIcon, &wFlags);
    ok(hr == testDef->hrDefIcon, "IExtractIcon::GetIconLocation(%d) returned hr = 0x%lx, expected 0x%lx\n", i, hr, testDef->hrDefIcon);
    ok(*szPath == L'\0', "IExtractIcon::GetIconLocation(%d) returned '%S'\n", i, szPath);
    // ok(iIcon == 0, "IExtractIcon::GetIconLocation(%d) returned %d\n", i, iIcon);
 
    iIcon = wFlags = 0xdeadbeef;
    wcscpy(szPath, L"garbage");
    hr = pei->GetIconLocation(GIL_FORSHORTCUT, szPath, _countof(szPath), &iIcon, &wFlags);
    ok(hr == testDef->hrForShrt, "IExtractIcon::GetIconLocation(%d) returned hr = 0x%lx, expected 0x%lx\n", i, hr, testDef->hrForShrt);
    // Here, both szPath and iIcon are untouched...
 
    iIcon = wFlags = 0xdeadbeef;
    wcscpy(szPath, L"garbage");
    hr = pei->GetIconLocation(GIL_FORSHELL, szPath, _countof(szPath), &iIcon, &wFlags);
    ok(hr == testDef->hrForShell, "IExtractIcon::GetIconLocation(%d) returned hr = 0x%lx, expected 0x%lx\n", i, hr, testDef->hrForShell);
    ok(wFlags == testDef->Flags, "IExtractIcon::GetIconLocation(%d) returned wFlags = 0x%x, expected 0x%x\n", i, wFlags, testDef->Flags);
    /*
     * Actually, even if wFlags specifies GIL_NOTFILENAME, a correct file name is returned
     * for executables only (at least...), otherwise we can get an asterix '*'.
     */
    ExpandEnvironmentStringsW(testDef->IconPath, szPath2, _countof(szPath2));
    ok(_wcsicmp(szPath2, szPath) == 0, "IExtractIcon::GetIconLocation(%d) returned '%S', expected '%S'\n", i, szPath, szPath2);
 
    // ok(*szPath == L'\0', "IExtractIcon::GetIconLocation returned '%S'\n", szPath);
    // ok(iIcon == 0, "IExtractIcon::GetIconLocation returned %d\n", iIcon);
    // ok(FALSE, "hr = 0x%lx, szPath = '%S', iIcon = %d, wFlags = %d\n", hr, szPath, iIcon, wFlags);
 
 
    /*
     * Now we test what happens when we explicitly set an icon to the shortcut.
     * Note that actually, SetIconLocation() does not verify whether the file
     * really exists.
     */
    hr = psl->SetIconLocation(pszExplorer, 1);
    ok(hr == S_OK, "IShellLink::SetIconLocation(%d) failed, hr = 0x%lx\n", i, hr);
 
    /*
     * First, we call IShellLink::GetIconLocation. We retrieve
     * exactly what we specified with SetIconLocation.
     */
    iIcon = 0xdeadbeef;
    wcscpy(szPath, L"garbage");
    hr = psl->GetIconLocation(szPath, _countof(szPath), &iIcon);
    ok(hr == S_OK, "IShellLink::GetIconLocation(%d) failed, hr = 0x%lx\n", i, hr);
    ok(wcscmp(szPath, pszExplorer) == 0, "IShellLink::GetIconLocation(%d) returned '%S', expected '%S'\n", i, szPath, pszExplorer);
    ok(iIcon == 1, "IShellLink::GetIconLocation(%d) returned %d, expected %d\n", i, iIcon, 1);
 
    /*
     * Now we test what happens with IExtractIcon::GetIconLocation.
     * We see that it retrieves the icon of the shortcut's underlying file.
     */
    iIcon = wFlags = 0xdeadbeef;
    wcscpy(szPath, L"garbage");
    hr = pei->GetIconLocation(GIL_DEFAULTICON, szPath, _countof(szPath), &iIcon, &wFlags);
    ok(hr == testDef->hrDefIcon, "IExtractIcon::GetIconLocation(%d) returned hr = 0x%lx, expected 0x%lx\n", i, hr, testDef->hrDefIcon);
    ok(*szPath == L'\0', "IExtractIcon::GetIconLocation(%d) returned '%S'\n", i, szPath);
    // ok(iIcon == 0, "IExtractIcon::GetIconLocation(%d) returned %d\n", i, iIcon);
 
    iIcon = wFlags = 0xdeadbeef;
    wcscpy(szPath, L"garbage");
    hr = pei->GetIconLocation(GIL_FORSHORTCUT, szPath, _countof(szPath), &iIcon, &wFlags);
    ok(hr == testDef->hrForShrt, "IExtractIcon::GetIconLocation(%d) returned hr = 0x%lx, expected 0x%lx\n", i, hr, testDef->hrForShrt);
    // Here, both szPath and iIcon are untouched...
 
    iIcon = wFlags = 0xdeadbeef;
    wcscpy(szPath, L"garbage");
    hr = pei->GetIconLocation(GIL_FORSHELL, szPath, _countof(szPath), &iIcon, &wFlags);
    ok(hr == testDef->hrForShell, "IExtractIcon::GetIconLocation(%d) returned hr = 0x%lx, expected 0x%lx\n", i, hr, testDef->hrForShell);
    ok(wFlags == testDef->Flags, "IExtractIcon::GetIconLocation(%d) returned wFlags = 0x%x, expected 0x%x\n", i, wFlags, testDef->Flags);
    /*
     * Actually, even if wFlags specifies GIL_NOTFILENAME, a correct file name is returned
     * for executables only (at least...), otherwise we can get an asterix '*'.
     */
    ExpandEnvironmentStringsW(testDef->IconPath, szPath2, _countof(szPath2));
    ok(_wcsicmp(szPath2, szPath) == 0, "IExtractIcon::GetIconLocation(%d) returned '%S', expected '%S'\n", i, szPath, szPath2);
 
    // ok(*szPath == L'\0', "IExtractIcon::GetIconLocation returned '%S'\n", szPath);
    // ok(iIcon == 0, "IExtractIcon::GetIconLocation returned %d\n", iIcon);
    // ok(FALSE, "hr = 0x%lx, szPath = '%S', iIcon = %d, wFlags = %d\n", hr, szPath, iIcon, wFlags);
}

Referenced by TestIconLocation().

TestDescription()

static VOID TestDescription ( void  )

static

Definition at line 250 of file CShellLink.cpp.

{
    HRESULT hr;
    CComPtr<IShellLinkW> psl;
    WCHAR buffer[64];
    PCWSTR testDescription = L"This is a test description";
 
    /* Test SetDescription */
    hr = CoCreateInstance(CLSID_ShellLink,
                          NULL,
                          CLSCTX_INPROC_SERVER,
                          IID_PPV_ARG(IShellLinkW, &psl));
    ok(hr == S_OK, "CoCreateInstance, hr = 0x%lx\n", hr);
    if (FAILED(hr))
    {
        skip("Could not instantiate CShellLink\n");
        return;
    }
 
    memset(buffer, 0x55, sizeof(buffer));
    hr = psl->GetDescription(buffer, RTL_NUMBER_OF(buffer));
    ok(hr == S_OK, "IShellLink::GetDescription returned hr = 0x%lx\n", hr);
    ok(buffer[0] == 0, "buffer[0] = %x\n", buffer[0]);
    ok(buffer[1] == 0x5555, "buffer[1] = %x\n", buffer[1]);
 
    hr = psl->SetDescription(testDescription);
    ok(hr == S_OK, "IShellLink::SetDescription returned hr = 0x%lx\n", hr);
 
    memset(buffer, 0x55, sizeof(buffer));
    hr = psl->GetDescription(buffer, RTL_NUMBER_OF(buffer));
    ok(hr == S_OK, "IShellLink::GetDescription returned hr = 0x%lx\n", hr);
    ok(buffer[wcslen(testDescription)] == 0, "buffer[n] = %x\n", buffer[wcslen(testDescription)]);
    ok(buffer[wcslen(testDescription) + 1] == 0x5555, "buffer[n+1] = %x\n", buffer[wcslen(testDescription) + 1]);
    ok(!wcscmp(buffer, testDescription), "buffer = '%ls'\n", buffer);
 
    hr = psl->SetDescription(NULL);
    ok(hr == S_OK, "IShellLink::SetDescription returned hr = 0x%lx\n", hr);
 
    memset(buffer, 0x55, sizeof(buffer));
    hr = psl->GetDescription(buffer, RTL_NUMBER_OF(buffer));
    ok(hr == S_OK, "IShellLink::GetDescription returned hr = 0x%lx\n", hr);
    ok(buffer[0] == 0, "buffer[0] = %x\n", buffer[0]);
    ok(buffer[1] == 0x5555, "buffer[1] = %x\n", buffer[1]);
}

Referenced by START_TEST().

TestIconLocation()

static VOID TestIconLocation ( void  )

static

Definition at line 465 of file CShellLink.cpp.

{
    UINT i;
 
    for (i = 0; i < _countof(ShIconTests); ++i)
    {
        test_iconlocation(i, &ShIconTests[i]);
    }
}

Referenced by START_TEST().

TestShellLink()

static VOID TestShellLink ( void  )

static

Definition at line 220 of file CShellLink.cpp.

{
    UINT i, TestListCnt;
    TEST_SHELL_LINK_DEF* Test;
 
    /* Needed for test */
    SetEnvironmentVariableW(L"shell", L"cmd.exe");
 
    if (GetNTVersion() <= _WIN32_WINNT_WS03)
    {
        Test = linkTestList_WS03;
        TestListCnt = _countof(linkTestList_WS03);
    }
    else
    {
        Test = linkTestList_Vista;
        TestListCnt = _countof(linkTestList_Vista);
    }
 
    for (i = 0; i < TestListCnt; ++i)
    {
        DPRINT("IShellLink-Test(%d): %S\n", i, Test[i].pathIn);
        test_checklinkpath(i, &Test[i]);
    }
 
    SetEnvironmentVariableW(L"shell",NULL);
}

Referenced by START_TEST().

Variable Documentation

linkTestList_Vista

TEST_SHELL_LINK_DEF linkTestList_Vista[]

static

Definition at line 95 of file CShellLink.cpp.

Referenced by TestShellLink().

linkTestList_WS03

TEST_SHELL_LINK_DEF linkTestList_WS03[]

static

Definition at line 36 of file CShellLink.cpp.

Referenced by TestShellLink().

ShIconTests

TEST_SHELL_ICON ShIconTests[]

static

Initial value:

=
{
    
    {L"%SystemRoot%\\system32\\cmd.exe", S_FALSE, E_INVALIDARG,
     S_OK, L"%SystemRoot%\\system32\\cmd.exe", GIL_NOTFILENAME | GIL_PERINSTANCE},
 
    
    {L"%SystemRoot%\\system32\\autochk.exe", S_FALSE, E_INVALIDARG,
     S_OK, L"%SystemRoot%\\system32\\autochk.exe", GIL_NOTFILENAME | GIL_PERINSTANCE},
 
    
    {L"%SystemRoot%\\system32\\shell32.dll", S_FALSE, E_INVALIDARG,
     S_OK, L"*", GIL_NOTFILENAME | GIL_PERCLASS},
 
    
    {L"%SystemRoot%\\non-existent-file.sdf", S_FALSE, E_INVALIDARG,
     S_OK, L"*", GIL_NOTFILENAME | GIL_PERCLASS},
    {L"c:\\non-existent-path\\non-existent-file.sdf", S_FALSE, E_INVALIDARG,
     S_OK, L"*", GIL_NOTFILENAME | GIL_PERCLASS},
}

Definition at line 310 of file CShellLink.cpp.

Referenced by TestIconLocation().