PathResolve.cpp File Reference

#include "shelltest.h"
#include <assert.h>

Include dependency graph for PathResolve.cpp:

Go to the source code of this file.

Classes
struct	ENTRY

Macros
#define	PRF_VERIFYEXISTS   0x01
#define	PRF_EXECUTABLE   0x02
#define	PRF_TRYPROGRAMEXTENSIONS   (PRF_EXECUTABLE | PRF_VERIFYEXISTS)
#define	PRF_FIRSTDIRDEF   0x04
#define	PRF_DONTFINDLNK   0x08
#define	PRF_REQUIREABSOLUTE   0x10
#define	FLAGS0   0
#define	FLAGS1   PRF_VERIFYEXISTS
#define	FLAGS2   PRF_EXECUTABLE
#define	FLAGS3   PRF_TRYPROGRAMEXTENSIONS
#define	FLAGS4   (PRF_FIRSTDIRDEF | PRF_VERIFYEXISTS)
#define	FLAGS5   (PRF_FIRSTDIRDEF | PRF_EXECUTABLE)
#define	FLAGS6   (PRF_FIRSTDIRDEF | PRF_TRYPROGRAMEXTENSIONS)
#define	FLAGS7   (PRF_REQUIREABSOLUTE | PRF_VERIFYEXISTS)
#define	FLAGS8   (PRF_REQUIREABSOLUTE | PRF_EXECUTABLE)
#define	FLAGS9   (PRF_REQUIREABSOLUTE | PRF_TRYPROGRAMEXTENSIONS)
#define	FLAGS10   (PRF_REQUIREABSOLUTE | PRF_FIRSTDIRDEF | PRF_VERIFYEXISTS)
#define	FLAGS11   (PRF_REQUIREABSOLUTE | PRF_FIRSTDIRDEF | PRF_EXECUTABLE)
#define	FLAGS12   (PRF_REQUIREABSOLUTE | PRF_FIRSTDIRDEF | PRF_TRYPROGRAMEXTENSIONS)
#define	FLAGS13   0xFFFFFFFF
#define	EF_FULLPATH   1
#define	EF_TESTDATA   2
#define	EF_WINDOWS_DIR   4
#define	EF_SYSTEM_DIR   8
#define	EF_TYPE_MASK   0xF
#define	EF_NAME_ONLY   16
#define	EF_APP_PATH   32
#define	BEEF   0xBEEF /* Error Code 48879 */
#define	DEAD   0xDEAD /* Error Code 57005 */
#define	IGNORE_ERR   0x7F7F7F7F /* Ignore Error Code */
#define	RAISED   9999 /* exception raised */

Typedefs
typedef int(WINAPI *	PATHRESOLVE) (LPWSTR, LPWSTR *, UINT)
typedef struct ENTRY	ENTRY

Functions
static BOOL	CreateShortcut (LPCWSTR pszLnkFileName, LPCWSTR pszTargetPathName)
static BOOL	CreateRegAppPath (INT EntryNumber, const WCHAR *Name, const WCHAR *Value)
static BOOL	DeleteRegAppPath (INT EntryNumber, const WCHAR *Name)
static void	DoEntry (INT EntryNumber, const ENTRY *pEntry)
static void	TestMain_PathResolve (void)
	START_TEST (PathResolve)

Variables
static HINSTANCE	s_hShell32 = NULL
static PATHRESOLVE	s_pPathResolve = NULL
static WCHAR	s_TestDataPath [MAX_PATH]
static WCHAR	s_LinkFilePath [MAX_PATH]
static WCHAR	s_LinkTargetPath [MAX_PATH]
static LPWSTR	s_Dirs [2]
static const ENTRY	s_Entries []

Macro Definition Documentation

BEEF

#define BEEF   0xBEEF /* Error Code 48879 */

Definition at line 75 of file PathResolve.cpp.

DEAD

#define DEAD   0xDEAD /* Error Code 57005 */

Definition at line 76 of file PathResolve.cpp.

EF_APP_PATH

#define EF_APP_PATH   32

Definition at line 61 of file PathResolve.cpp.

EF_FULLPATH

#define EF_FULLPATH   1

Definition at line 54 of file PathResolve.cpp.

EF_NAME_ONLY

#define EF_NAME_ONLY   16

Definition at line 60 of file PathResolve.cpp.

EF_SYSTEM_DIR

#define EF_SYSTEM_DIR   8

Definition at line 57 of file PathResolve.cpp.

EF_TESTDATA

#define EF_TESTDATA   2

Definition at line 55 of file PathResolve.cpp.

EF_TYPE_MASK

#define EF_TYPE_MASK   0xF

Definition at line 58 of file PathResolve.cpp.

EF_WINDOWS_DIR

#define EF_WINDOWS_DIR   4

Definition at line 56 of file PathResolve.cpp.

FLAGS0

#define FLAGS0   0

Definition at line 39 of file PathResolve.cpp.

FLAGS1

#define FLAGS1   PRF_VERIFYEXISTS

Definition at line 40 of file PathResolve.cpp.

FLAGS10

#define FLAGS10   (PRF_REQUIREABSOLUTE | PRF_FIRSTDIRDEF | PRF_VERIFYEXISTS)

Definition at line 49 of file PathResolve.cpp.

FLAGS11

#define FLAGS11   (PRF_REQUIREABSOLUTE | PRF_FIRSTDIRDEF | PRF_EXECUTABLE)

Definition at line 50 of file PathResolve.cpp.

FLAGS12

#define FLAGS12   (PRF_REQUIREABSOLUTE | PRF_FIRSTDIRDEF | PRF_TRYPROGRAMEXTENSIONS)

Definition at line 51 of file PathResolve.cpp.

FLAGS13

#define FLAGS13   0xFFFFFFFF

Definition at line 52 of file PathResolve.cpp.

FLAGS2

#define FLAGS2   PRF_EXECUTABLE

Definition at line 41 of file PathResolve.cpp.

FLAGS3

#define FLAGS3   PRF_TRYPROGRAMEXTENSIONS

Definition at line 42 of file PathResolve.cpp.

FLAGS4

#define FLAGS4   (PRF_FIRSTDIRDEF | PRF_VERIFYEXISTS)

Definition at line 43 of file PathResolve.cpp.

FLAGS5

#define FLAGS5   (PRF_FIRSTDIRDEF | PRF_EXECUTABLE)

Definition at line 44 of file PathResolve.cpp.

FLAGS6

#define FLAGS6   (PRF_FIRSTDIRDEF | PRF_TRYPROGRAMEXTENSIONS)

Definition at line 45 of file PathResolve.cpp.

FLAGS7

#define FLAGS7   (PRF_REQUIREABSOLUTE | PRF_VERIFYEXISTS)

Definition at line 46 of file PathResolve.cpp.

FLAGS8

#define FLAGS8   (PRF_REQUIREABSOLUTE | PRF_EXECUTABLE)

Definition at line 47 of file PathResolve.cpp.

FLAGS9

#define FLAGS9   (PRF_REQUIREABSOLUTE | PRF_TRYPROGRAMEXTENSIONS)

Definition at line 48 of file PathResolve.cpp.

IGNORE_ERR

#define IGNORE_ERR   0x7F7F7F7F /* Ignore Error Code */

Definition at line 77 of file PathResolve.cpp.

PRF_DONTFINDLNK

#define PRF_DONTFINDLNK   0x08

Definition at line 33 of file PathResolve.cpp.

PRF_EXECUTABLE

#define PRF_EXECUTABLE   0x02

Definition at line 30 of file PathResolve.cpp.

PRF_FIRSTDIRDEF

#define PRF_FIRSTDIRDEF   0x04

Definition at line 32 of file PathResolve.cpp.

PRF_REQUIREABSOLUTE

#define PRF_REQUIREABSOLUTE   0x10

Definition at line 36 of file PathResolve.cpp.

PRF_TRYPROGRAMEXTENSIONS

#define PRF_TRYPROGRAMEXTENSIONS   (PRF_EXECUTABLE | PRF_VERIFYEXISTS)

Definition at line 31 of file PathResolve.cpp.

PRF_VERIFYEXISTS

#define PRF_VERIFYEXISTS   0x01

Definition at line 29 of file PathResolve.cpp.

RAISED

#define RAISED   9999 /* exception raised */

Definition at line 78 of file PathResolve.cpp.

Typedef Documentation

ENTRY

typedef struct ENTRY ENTRY

PATHRESOLVE

typedef int(WINAPI * PATHRESOLVE) (LPWSTR, LPWSTR *, UINT)

Definition at line 18 of file PathResolve.cpp.

Function Documentation

CreateRegAppPath()

static BOOL CreateRegAppPath ( INT  EntryNumber, const WCHAR *  Name, const WCHAR *  Value  )

static

Definition at line 596 of file PathResolve.cpp.

{
    HKEY RegistryKey;
    LONG Result;
    WCHAR Buffer[1024];
    DWORD Disposition;

    wcscpy(Buffer, L"Software\\Microsoft\\Windows\\CurrentVersion\\App Paths\\");
    wcscat(Buffer, Name);
    Result = RegCreateKeyExW(HKEY_LOCAL_MACHINE, Buffer, 0, NULL,
        0, KEY_WRITE, NULL, &RegistryKey, &Disposition);
    if (Result != ERROR_SUCCESS)
    {
        trace("#%d: Could not create test key. Status: %lu\n", EntryNumber, Result);
        return FALSE;
    }
    Result = RegSetValueW(RegistryKey, NULL, REG_SZ, Value, 0);
    if (Result != ERROR_SUCCESS)
    {
        trace("#%d: Could not set value of the test key. Status: %lu\n", EntryNumber, Result);
        RegCloseKey(RegistryKey);
        return FALSE;
    }
    RegCloseKey(RegistryKey);
    return TRUE;
}

Referenced by DoEntry().

CreateShortcut()

static BOOL CreateShortcut ( LPCWSTR  pszLnkFileName, LPCWSTR  pszTargetPathName  )

static

Definition at line 565 of file PathResolve.cpp.

{
    IPersistFile *ppf;
    IShellLinkW* psl;
    HRESULT hres;

    hres = CoInitialize(NULL);
    if (SUCCEEDED(hres))
    {
        hres = CoCreateInstance(CLSID_ShellLink, NULL,
            CLSCTX_INPROC_SERVER, IID_IShellLinkW, (LPVOID*)&psl);
        if (SUCCEEDED(hres))
        {
            psl->SetPath(pszTargetPathName);
            hres = psl->QueryInterface(IID_IPersistFile, (LPVOID*)&ppf);
            if (SUCCEEDED(hres))
            {
                hres = ppf->Save(pszLnkFileName, TRUE);
                ppf->Release();
            }
            psl->Release();
        }
        CoUninitialize();
    }
    SetLastError(hres);

    return SUCCEEDED(hres);
}

Referenced by START_TEST().

DeleteRegAppPath()

static BOOL DeleteRegAppPath ( INT  EntryNumber, const WCHAR *  Name  )

static

Definition at line 624 of file PathResolve.cpp.

{
    LONG Result;
    WCHAR Buffer[1024];
    wcscpy(Buffer, L"Software\\Microsoft\\Windows\\CurrentVersion\\App Paths\\");
    wcscat(Buffer, Name);
    Result = RegDeleteKeyW(HKEY_LOCAL_MACHINE, Buffer);
    if (Result != ERROR_SUCCESS)
    {
        trace("#%d: Could not remove the test key. Status: %lu\n", EntryNumber, Result);
        return FALSE;
    }
    return TRUE;
}

Referenced by DoEntry().

DoEntry()

static void DoEntry ( INT  EntryNumber, const ENTRY *  pEntry  )

static

Definition at line 639 of file PathResolve.cpp.

{
    WCHAR Path[MAX_PATH], PathExpected[MAX_PATH];
    INT Ret;
    DWORD Error;

    if (pEntry->NameBefore == NULL)
    {
        assert(pEntry->NameExpected == NULL);
    }

    switch (pEntry->EF_ & EF_TYPE_MASK)
    {
    case EF_FULLPATH:
        if (pEntry->NameBefore)
        {
            lstrcpyW(Path, pEntry->NameBefore);
        }
        if (pEntry->NameExpected)
        {
            lstrcpyW(PathExpected, pEntry->NameExpected);
        }
        break;

    case EF_TESTDATA:
        if (pEntry->EF_ & EF_NAME_ONLY)
        {
            lstrcpyW(Path, pEntry->NameBefore);
        }
        else
        {
            lstrcpyW(Path, s_TestDataPath);
            lstrcatW(Path, L"\\");
            lstrcatW(Path, pEntry->NameBefore);
        }

        if (pEntry->NameExpected)
        {
            lstrcpyW(PathExpected, s_TestDataPath);
            lstrcatW(PathExpected, L"\\");
            lstrcatW(PathExpected, pEntry->NameExpected);
        }
        break;

    case EF_WINDOWS_DIR:
        if (pEntry->EF_ & EF_NAME_ONLY)
        {
            lstrcpyW(Path, pEntry->NameBefore);
        }
        else
        {
            GetWindowsDirectoryW(Path, _countof(Path));
            lstrcatW(Path, L"\\");
            lstrcatW(Path, pEntry->NameBefore);
        }

        if (pEntry->NameExpected)
        {
            GetWindowsDirectoryW(PathExpected, _countof(PathExpected));
            lstrcatW(PathExpected, L"\\");
            lstrcatW(PathExpected, pEntry->NameExpected);
        }
        break;

    case EF_SYSTEM_DIR:
        if (pEntry->EF_ & EF_NAME_ONLY)
        {
            lstrcpyW(Path, pEntry->NameBefore);
        }
        else
        {
            GetSystemDirectoryW(Path, _countof(Path));
            lstrcatW(Path, L"\\");
            lstrcatW(Path, pEntry->NameBefore);
        }

        if (pEntry->NameExpected)
        {
            GetSystemDirectoryW(PathExpected, _countof(PathExpected));
            lstrcatW(PathExpected, L"\\");
            lstrcatW(PathExpected, pEntry->NameExpected);
        }
        break;
    }

    if (pEntry->EF_ & EF_APP_PATH)
    {
        if (!CreateRegAppPath(EntryNumber, pEntry->NameBefore, PathExpected))
        {
            skip("#%d: CreateRegAppPath failure\n", EntryNumber);
            return;
        }
    }

    _SEH2_TRY
    {
        SetLastError(BEEF);
        if (pEntry->NameBefore)
        {
            Ret = (*s_pPathResolve)(Path, pEntry->Dirs, pEntry->Flags);
        }
        else
        {
            Ret = (*s_pPathResolve)(NULL, pEntry->Dirs, pEntry->Flags);
        }
        Error = GetLastError();
    }
    _SEH2_EXCEPT(EXCEPTION_EXECUTE_HANDLER)
    {
        Ret = RAISED;
        Error = DEAD;
    }
    _SEH2_END;

    if (pEntry->EF_ & EF_APP_PATH)
    {
        ok(DeleteRegAppPath(EntryNumber, pEntry->NameBefore),
           "#%d: DeleteRegAppPath failed\n", EntryNumber);
    }

    ok(Ret == pEntry->Ret, "#%d: Ret expected %d, was %d.\n",
       EntryNumber, pEntry->Ret, Ret);
    if (pEntry->Error != IGNORE_ERR)
    {
        ok(Error == pEntry->Error, "#%d: last error expected %ld, was %ld.\n",
           EntryNumber, pEntry->Error, Error);
    }

    if (pEntry->NameExpected && !(pEntry->EF_ & EF_APP_PATH))
    {
        ok(lstrcmpW(Path, PathExpected) == 0, "#%d: Path expected %s, was %s.\n",
           EntryNumber, wine_dbgstr_w(PathExpected), wine_dbgstr_w(Path));
    }
}

Referenced by TestMain_PathResolve().

START_TEST()

START_TEST

(

PathResolve

)

Definition at line 838 of file PathResolve.cpp.

{
    LPWSTR pch;

    GetModuleFileNameW(NULL, s_TestDataPath, _countof(s_TestDataPath));
    pch = wcsrchr(s_TestDataPath, L'\\');
    if (pch == NULL)
        pch = wcsrchr(s_TestDataPath, L'/');
    if (pch == NULL)
    {
        skip("GetModuleFileName and/or wcsrchr are insane.\n");
        return;
    }
    lstrcpyW(pch, L"\\testdata");
    if (GetFileAttributesW(s_TestDataPath) == INVALID_FILE_ATTRIBUTES)
    {
        skip("testdata is not found.\n");
        return;
    }

    s_Dirs[0] = s_TestDataPath;
    s_Dirs[1] = NULL;

    lstrcpyW(s_LinkFilePath, s_TestDataPath);
    lstrcatW(s_LinkFilePath, L"\\");
    lstrcatW(s_LinkFilePath, L"CmdLineUtils.lnk");

    lstrcpyW(s_LinkTargetPath, s_TestDataPath);
    lstrcatW(s_LinkTargetPath, L"\\");
    lstrcatW(s_LinkTargetPath, L"2PRONG.txt");

    ok(CreateShortcut(s_LinkFilePath, s_LinkTargetPath),
       "CreateShortcut(%s, %s) failed.\n",
       wine_dbgstr_w(s_LinkFilePath), wine_dbgstr_w(s_LinkTargetPath));

    s_hShell32 = LoadLibraryA("shell32");
    if (s_hShell32 == NULL)
    {
        skip("Unable to load shell32.\n");
        return;
    }

    s_pPathResolve = (PATHRESOLVE)GetProcAddress(s_hShell32, "PathResolve");
    if (s_pPathResolve == NULL)
    {
        skip("Unable to get PathResolve address.\n");
        return;
    }

    TestMain_PathResolve();

    ok(DeleteFileW(s_LinkFilePath), "DeleteFileW(%s) failed\n",
       wine_dbgstr_w(s_LinkFilePath));

    FreeLibrary(s_hShell32);
    s_hShell32 = NULL;
    s_pPathResolve = NULL;
}

TestMain_PathResolve()

static void TestMain_PathResolve ( void  )

static

Definition at line 774 of file PathResolve.cpp.

{
    UINT i;
    WCHAR Saved[128], *pPathExtSaved;

    /* save PATHEXT */
    if (GetEnvironmentVariableW(L"PATHEXT", Saved, _countof(Saved)))
    {
        pPathExtSaved = Saved;
    }
    else
    {
        pPathExtSaved = NULL;
    }

    /* normal */
    for (i = 0; i < _countof(s_Entries); ++i)
    {
        DoEntry(s_Entries[i].EntryNumber, &s_Entries[i]);
    }

    /* +#1000: reset PATHEXT */
    if (SetEnvironmentVariableW(L"PATHEXT", NULL))
    {
        for (i = 0; i < _countof(s_Entries); ++i)
        {
            DoEntry(s_Entries[i].EntryNumber + 1000, &s_Entries[i]);
        }
    }
    else
    {
        skip("SetEnvironmentVariableW failed\n");
    }

    /* +#2000: set PATHEXT to ".COM;.EXE;.BAT" */
    if (SetEnvironmentVariableW(L"PATHEXT", L".COM;.EXE;.BAT"))
    {
        for (i = 0; i < _countof(s_Entries); ++i)
        {
            DoEntry(s_Entries[i].EntryNumber + 2000, &s_Entries[i]);
        }
    }
    else
    {
        skip("SetEnvironmentVariableW failed\n");
    }

    /* +#3000: set PATHEXT to ".TXT" */
    if (SetEnvironmentVariableW(L"PATHEXT", L".TXT"))
    {
        for (i = 0; i < _countof(s_Entries); ++i)
        {
            DoEntry(s_Entries[i].EntryNumber + 3000, &s_Entries[i]);
        }
    }
    else
    {
        skip("SetEnvironmentVariableW failed\n");
    }

    /* restore PATHEXT */
    SetEnvironmentVariableW(L"PATHEXT", pPathExtSaved);
}

Referenced by START_TEST().

Variable Documentation

s_Dirs

LPWSTR s_Dirs[2]

static

Definition at line 25 of file PathResolve.cpp.

Referenced by START_TEST().

s_Entries

const ENTRY s_Entries[]

static

Definition at line 80 of file PathResolve.cpp.

Referenced by TestMain_PathResolve().

s_hShell32

HINSTANCE s_hShell32 = NULL

static

Definition at line 20 of file PathResolve.cpp.

Referenced by START_TEST().

s_LinkFilePath

WCHAR s_LinkFilePath[MAX_PATH]

static

Definition at line 23 of file PathResolve.cpp.

Referenced by START_TEST().

s_LinkTargetPath

WCHAR s_LinkTargetPath[MAX_PATH]

static

Definition at line 24 of file PathResolve.cpp.

Referenced by START_TEST().

s_pPathResolve

PATHRESOLVE s_pPathResolve = NULL

static

Definition at line 21 of file PathResolve.cpp.

Referenced by START_TEST().

s_TestDataPath

WCHAR s_TestDataPath[MAX_PATH]

static

Definition at line 22 of file PathResolve.cpp.

Referenced by DoEntry(), and START_TEST().