PathResolve.cpp File Reference

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

Include dependency graph for PathResolve.cpp:

Go to the source code of this file.

Classes
struct	tagTEST_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   0x01
#define	EF_TESTDATA   0x02
#define	EF_TYPE_MASK   0x0F
#define	EF_NAME_ONLY   0x10
#define	EF_APP_PATH   0x20
#define	RET_IGNORE   0x00BEF00D
#define	ERR_NO_CHANGE   0xBEEF /* Error Code 48879 */
#define	ERR_DEAD   0xDEAD /* Error Code 57005 */
#define	ERR_IGNORE   0x7F7F7F7F /* Ignore Error Code */
#define	RAISED   9999 /* exception raised */

Typedefs
typedef int(WINAPI *	PATHRESOLVE) (LPWSTR, LPWSTR *, UINT)
typedef BOOL(WINAPI *	ISLFNDRIVEW) (LPCWSTR)
typedef struct tagTEST_ENTRY	TEST_ENTRY
typedef struct tagTEST_ENTRY *	PTEST_ENTRY

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

Variables
static HINSTANCE	s_hShell32 = NULL
static PATHRESOLVE	s_pPathResolve = NULL
static ISLFNDRIVEW	s_pIsLFNDriveW = NULL
static WCHAR	s_TestDir [MAX_PATH]
static WCHAR	s_TestDirWithBackslash [MAX_PATH]
static WCHAR	s_ShortcutLongName [MAX_PATH]
static WCHAR	s_LinkTarget [MAX_PATH]
static WCHAR	s_LinkTargetWithBackslash [MAX_PATH]
static WCHAR	s_LinkTargetDoubleBackslash [MAX_PATH]
static LPWSTR	s_Dirs [2] = { s_TestDir, NULL }
static LPWSTR	s_DirsWithBackslash [2] = { s_TestDirWithBackslash, NULL }
static const TEST_ENTRY	s_LFNEntries []

Macro Definition Documentation

EF_APP_PATH

#define EF_APP_PATH   0x20

Definition at line 82 of file PathResolve.cpp.

EF_FULLPATH

#define EF_FULLPATH   0x01

Definition at line 78 of file PathResolve.cpp.

EF_NAME_ONLY

#define EF_NAME_ONLY   0x10

Definition at line 81 of file PathResolve.cpp.

EF_TESTDATA

#define EF_TESTDATA   0x02

Definition at line 79 of file PathResolve.cpp.

EF_TYPE_MASK

#define EF_TYPE_MASK   0x0F

Definition at line 80 of file PathResolve.cpp.

ERR_DEAD

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

Definition at line 88 of file PathResolve.cpp.

ERR_IGNORE

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

Definition at line 89 of file PathResolve.cpp.

ERR_NO_CHANGE

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

Definition at line 87 of file PathResolve.cpp.

FLAGS0

#define FLAGS0   0

Definition at line 49 of file PathResolve.cpp.

FLAGS1

#define FLAGS1   PRF_VERIFYEXISTS

Definition at line 50 of file PathResolve.cpp.

FLAGS10

#define FLAGS10   (PRF_REQUIREABSOLUTE | PRF_FIRSTDIRDEF | PRF_VERIFYEXISTS)

Definition at line 59 of file PathResolve.cpp.

FLAGS11

#define FLAGS11   (PRF_REQUIREABSOLUTE | PRF_FIRSTDIRDEF | PRF_EXECUTABLE)

Definition at line 60 of file PathResolve.cpp.

FLAGS12

#define FLAGS12   (PRF_REQUIREABSOLUTE | PRF_FIRSTDIRDEF | PRF_TRYPROGRAMEXTENSIONS)

Definition at line 61 of file PathResolve.cpp.

FLAGS13

#define FLAGS13   0xFFFFFFFF

Definition at line 62 of file PathResolve.cpp.

FLAGS2

#define FLAGS2   PRF_EXECUTABLE

Definition at line 51 of file PathResolve.cpp.

FLAGS3

#define FLAGS3   PRF_TRYPROGRAMEXTENSIONS

Definition at line 52 of file PathResolve.cpp.

FLAGS4

#define FLAGS4   (PRF_FIRSTDIRDEF | PRF_VERIFYEXISTS)

Definition at line 53 of file PathResolve.cpp.

FLAGS5

#define FLAGS5   (PRF_FIRSTDIRDEF | PRF_EXECUTABLE)

Definition at line 54 of file PathResolve.cpp.

FLAGS6

#define FLAGS6   (PRF_FIRSTDIRDEF | PRF_TRYPROGRAMEXTENSIONS)

Definition at line 55 of file PathResolve.cpp.

FLAGS7

#define FLAGS7   (PRF_REQUIREABSOLUTE | PRF_VERIFYEXISTS)

Definition at line 56 of file PathResolve.cpp.

FLAGS8

#define FLAGS8   (PRF_REQUIREABSOLUTE | PRF_EXECUTABLE)

Definition at line 57 of file PathResolve.cpp.

FLAGS9

#define FLAGS9   (PRF_REQUIREABSOLUTE | PRF_TRYPROGRAMEXTENSIONS)

Definition at line 58 of file PathResolve.cpp.

PRF_DONTFINDLNK

#define PRF_DONTFINDLNK   0x08

Definition at line 42 of file PathResolve.cpp.

PRF_EXECUTABLE

#define PRF_EXECUTABLE   0x02

Definition at line 39 of file PathResolve.cpp.

PRF_FIRSTDIRDEF

#define PRF_FIRSTDIRDEF   0x04

Definition at line 41 of file PathResolve.cpp.

PRF_REQUIREABSOLUTE

#define PRF_REQUIREABSOLUTE   0x10

Definition at line 45 of file PathResolve.cpp.

PRF_TRYPROGRAMEXTENSIONS

#define PRF_TRYPROGRAMEXTENSIONS   (PRF_EXECUTABLE | PRF_VERIFYEXISTS)

Definition at line 40 of file PathResolve.cpp.

PRF_VERIFYEXISTS

#define PRF_VERIFYEXISTS   0x01

Definition at line 38 of file PathResolve.cpp.

RAISED

#define RAISED   9999 /* exception raised */

Definition at line 90 of file PathResolve.cpp.

RET_IGNORE

#define RET_IGNORE   0x00BEF00D

Definition at line 84 of file PathResolve.cpp.

Typedef Documentation

ISLFNDRIVEW

typedef BOOL(WINAPI * ISLFNDRIVEW) (LPCWSTR)

Definition at line 22 of file PathResolve.cpp.

PATHRESOLVE

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

Definition at line 19 of file PathResolve.cpp.

PTEST_ENTRY

typedef struct tagTEST_ENTRY * PTEST_ENTRY

TEST_ENTRY

typedef struct tagTEST_ENTRY TEST_ENTRY

Function Documentation

CreateRegAppPath()

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

static

Definition at line 609 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("Section %d, Line %d: Could not create test key. Status: %lu\n",
              SectionNumber, LineNumber, Result);
        return FALSE;
    }
    Result = RegSetValueW(RegistryKey, NULL, REG_SZ, Value, 0);
    if (Result != ERROR_SUCCESS)
    {
        trace("Section %d, Line %d: Could not set value of the test key. Status: %lu\n",
              SectionNumber, LineNumber, Result);
        RegCloseKey(RegistryKey);
        return FALSE;
    }
    RegCloseKey(RegistryKey);
    return TRUE;
}

Referenced by DoEntry().

CreateShortcut()

static BOOL CreateShortcut ( LPCWSTR  pszLnkFileName, LPCWSTR  pszTargetPathName  )

static

Definition at line 578 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  SectionNumber, INT  LineNumber, const WCHAR *  Name  )

static

Definition at line 639 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("Section %d, Line %d: Could not remove the test key. Status: %lu\n",
              SectionNumber, LineNumber, Result);
        return FALSE;
    }
    return TRUE;
}

Referenced by DoEntry().

DoEntry()

static void DoEntry ( INT  SectionNumber, INT  LineNumber, const TEST_ENTRY *  pEntry  )

static

Definition at line 655 of file PathResolve.cpp.

{
    WCHAR Path[MAX_PATH], PathExpected[MAX_PATH];
    INT Ret;
    DWORD Error;
 
    ZeroMemory(Path, sizeof(Path));
    ZeroMemory(PathExpected, sizeof(PathExpected));
 
    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_TestDir);
                lstrcatW(Path, L"\\");
                lstrcatW(Path, pEntry->NameBefore);
            }
 
            if (pEntry->NameExpected)
            {
                lstrcpyW(PathExpected, s_TestDir);
                lstrcatW(PathExpected, L"\\");
                lstrcatW(PathExpected, pEntry->NameExpected);
            }
            break;
 
        default:
            assert(0);
            break;
    }
 
    if (pEntry->EF_ & EF_APP_PATH)
    {
        if (!CreateRegAppPath(SectionNumber, LineNumber, pEntry->NameBefore, PathExpected))
        {
            skip("Section %d, Line %d: CreateRegAppPath failure\n", SectionNumber, LineNumber);
            return;
        }
    }
 
    _SEH2_TRY
    {
        SetLastError(ERR_NO_CHANGE);
        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 = ERR_DEAD;
    }
    _SEH2_END;
 
    if (pEntry->EF_ & EF_APP_PATH)
    {
        ok(DeleteRegAppPath(SectionNumber, LineNumber, pEntry->NameBefore),
           "Section %d, Line %d: DeleteRegAppPath failed\n", SectionNumber, LineNumber);
    }
 
    if (pEntry->Ret != RET_IGNORE)
    {
        ok(Ret == pEntry->Ret, "Section %d, Line %d: Ret expected %d, was %d.\n",
           SectionNumber, LineNumber, pEntry->Ret, Ret);
    }
 
    if (pEntry->Error != ERR_IGNORE)
    {
        ok(Error == pEntry->Error, "Section %d, Line %d: last error expected %ld, was %ld.\n",
           SectionNumber, LineNumber, pEntry->Error, Error);
    }
 
    if (pEntry->NameExpected && !(pEntry->EF_ & EF_APP_PATH))
    {
        char expected[MAX_PATH];
        char path[MAX_PATH];
 
        lstrcpynA(expected, wine_dbgstr_w(PathExpected), _countof(expected));
        lstrcpynA(path, wine_dbgstr_w(Path), _countof(path));
 
        ok(lstrcmpW(Path, PathExpected) == 0, "Section %d, Line %d: Path expected %s, was %s.\n",
           SectionNumber, LineNumber, expected, path);
    }
}

Referenced by TestMain_PathResolve().

START_TEST()

START_TEST

(

PathResolve

)

Definition at line 831 of file PathResolve.cpp.

{
    LPWSTR pch;
    WCHAR szRoot[MAX_PATH];
 
    /* Get this program's path */
    GetModuleFileNameW(NULL, s_TestDir, _countof(s_TestDir));
 
    /* Add '\testdir' to the path */
    pch = wcsrchr(s_TestDir, L'\\');
    if (pch == NULL)
    {
        skip("GetModuleFileName and/or wcsrchr are insane.\n");
        return;
    }
    lstrcpyW(pch, L"\\testdir");
 
    /* Create the testdir directory */
    CreateDirectoryW(s_TestDir, NULL);
    if (GetFileAttributesW(s_TestDir) == INVALID_FILE_ATTRIBUTES)
    {
        skip("testdir is not found.\n");
        return;
    }
 
    /* Build s_TestDirWithBackslash path */
    lstrcpyW(s_TestDirWithBackslash, s_TestDir);
    lstrcatW(s_TestDirWithBackslash, L"\\");
 
    /* Build s_LinkTarget path */
    lstrcpyW(s_LinkTarget, s_TestDir);
    lstrcatW(s_LinkTarget, L"\\");
    lstrcatW(s_LinkTarget, L"2PRONG.txt");
 
    /* Create the file */
    fclose(_wfopen(s_LinkTarget, L"wb"));
    ok(GetFileAttributesW(s_LinkTarget) != INVALID_FILE_ATTRIBUTES, "s_LinkTarget not found\n");
 
    /* Build s_LinkTargetWithBackslash path */
    lstrcpyW(s_LinkTargetWithBackslash, s_TestDir);
    lstrcatW(s_LinkTargetWithBackslash, L"\\");
    lstrcatW(s_LinkTargetWithBackslash, L"2PRONG.txt");
    lstrcatW(s_LinkTargetWithBackslash, L"\\");
 
    /* Build s_LinkTargetDoubleBackslash path */
    lstrcpyW(s_LinkTargetDoubleBackslash, s_TestDir);
    lstrcatW(s_LinkTargetDoubleBackslash, L"\\\\");
    lstrcatW(s_LinkTargetDoubleBackslash, L"2PRONG.txt");
 
    /* Build s_ShortcutLongName path */
    lstrcpyW(s_ShortcutLongName, s_TestDir);
    lstrcatW(s_ShortcutLongName, L"\\");
    lstrcatW(s_ShortcutLongName, L"CmdLineUtils.lnk"); /* in Long File Name */
 
    /* Create s_ShortcutLongName shortcut file */
    ok(CreateShortcut(s_ShortcutLongName, s_LinkTarget),
       "CreateShortcut(%s, %s) failed.\n",
       wine_dbgstr_w(s_ShortcutLongName), wine_dbgstr_w(s_LinkTarget));
 
    /* Load shell32.dll */
    s_hShell32 = LoadLibraryA("shell32");
    if (s_hShell32 == NULL)
    {
        skip("Unable to load shell32.\n");
        goto Cleanup;
    }
 
    /* Get PathResolve procedure */
    s_pPathResolve = (PATHRESOLVE)GetProcAddress(s_hShell32, "PathResolve");
    if (s_pPathResolve == NULL)
    {
        skip("Unable to get PathResolve address.\n");
        goto Cleanup;
    }
 
    /* Get IsLFNDriveW procedure */
    s_pIsLFNDriveW = (ISLFNDRIVEW)GetProcAddress(s_hShell32, (LPCSTR)(INT_PTR)42);
    if (s_pIsLFNDriveW == NULL)
    {
        skip("Unable to get IsLFNDriveW address.\n");
        goto Cleanup;
    }
 
    /* Is LFN supported? */
    lstrcpyW(szRoot, s_TestDir);
    PathStripToRootW(szRoot);
    if (!s_pIsLFNDriveW(szRoot))
    {
        skip("LFN is not supported in this drive %s.\n", wine_dbgstr_w(szRoot));
        goto Cleanup;
    }
 
    /* Do tests */
    TestMain_PathResolve();
 
    /* Clean up */
Cleanup:
    DeleteFileW(s_LinkTarget);
    DeleteFileW(s_ShortcutLongName);
    RemoveDirectoryW(s_TestDir);
    FreeLibrary(s_hShell32);
}

TestMain_PathResolve()

static void TestMain_PathResolve ( void  )

static

Definition at line 767 of file PathResolve.cpp.

{
    UINT i, cEntries;
    const TEST_ENTRY *pEntries;
    WCHAR Saved[128], *pPathExtSaved;
 
    pEntries = s_LFNEntries;
    cEntries = _countof(s_LFNEntries);
 
    /* save PATHEXT */
    if (GetEnvironmentVariableW(L"PATHEXT", Saved, _countof(Saved)))
        pPathExtSaved = Saved;
    else
        pPathExtSaved = NULL;
 
    /* Section 1 */
    for (i = 0; i < cEntries; ++i)
    {
        DoEntry(1, pEntries[i].LineNumber, &pEntries[i]);
    }
 
    /* Section 2: reset PATHEXT */
    if (SetEnvironmentVariableW(L"PATHEXT", NULL))
    {
        for (i = 0; i < cEntries; ++i)
        {
            DoEntry(2, pEntries[i].LineNumber, &pEntries[i]);
        }
    }
    else
    {
        skip("SetEnvironmentVariableW failed\n");
    }
 
    /* Section 3: set PATHEXT to ".COM;.EXE;.BAT" */
    if (SetEnvironmentVariableW(L"PATHEXT", L".COM;.EXE;.BAT"))
    {
        for (i = 0; i < cEntries; ++i)
        {
            DoEntry(3, pEntries[i].LineNumber, &pEntries[i]);
        }
    }
    else
    {
        skip("SetEnvironmentVariableW failed\n");
    }
 
    /* Section 4: set PATHEXT to ".TXT" */
    if (SetEnvironmentVariableW(L"PATHEXT", L".TXT"))
    {
        for (i = 0; i < cEntries; ++i)
        {
            DoEntry(4, pEntries[i].LineNumber, &pEntries[i]);
        }
    }
    else
    {
        skip("SetEnvironmentVariableW failed\n");
    }
 
    /* restore PATHEXT */
    SetEnvironmentVariableW(L"PATHEXT", pPathExtSaved);
}

Referenced by START_TEST().

Variable Documentation

s_Dirs

LPWSTR s_Dirs[2] = { s_TestDir, NULL }

static

Definition at line 33 of file PathResolve.cpp.

s_DirsWithBackslash

LPWSTR s_DirsWithBackslash[2] = { s_TestDirWithBackslash, NULL }

static

Definition at line 34 of file PathResolve.cpp.

s_hShell32

HINSTANCE s_hShell32 = NULL

static

Definition at line 24 of file PathResolve.cpp.

Referenced by START_TEST().

s_LFNEntries

const TEST_ENTRY s_LFNEntries[]

static

Definition at line 93 of file PathResolve.cpp.

Referenced by TestMain_PathResolve().

s_LinkTarget

WCHAR s_LinkTarget[MAX_PATH]

static

Definition at line 30 of file PathResolve.cpp.

Referenced by START_TEST().

s_LinkTargetDoubleBackslash

WCHAR s_LinkTargetDoubleBackslash[MAX_PATH]

static

Definition at line 32 of file PathResolve.cpp.

Referenced by START_TEST().

s_LinkTargetWithBackslash

WCHAR s_LinkTargetWithBackslash[MAX_PATH]

static

Definition at line 31 of file PathResolve.cpp.

Referenced by START_TEST().

s_pIsLFNDriveW

ISLFNDRIVEW s_pIsLFNDriveW = NULL

static

Definition at line 26 of file PathResolve.cpp.

Referenced by START_TEST().

s_pPathResolve

PATHRESOLVE s_pPathResolve = NULL

static

Definition at line 25 of file PathResolve.cpp.

Referenced by START_TEST().

s_ShortcutLongName

WCHAR s_ShortcutLongName[MAX_PATH]

static

Definition at line 29 of file PathResolve.cpp.

Referenced by START_TEST().

s_TestDir

WCHAR s_TestDir[MAX_PATH]

static

Definition at line 27 of file PathResolve.cpp.

Referenced by DoEntry(), and START_TEST().

s_TestDirWithBackslash

WCHAR s_TestDirWithBackslash[MAX_PATH]

static

Definition at line 28 of file PathResolve.cpp.

Referenced by START_TEST().