dlls/shell32/tests/shellpath.c

   1 /*
   2  * Unit tests for shell32 SHGet{Special}Folder{Path|Location} functions.
   3  *
   4  * Copyright 2004 Juan Lang
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  19  * This is a test program for the SHGet{Special}Folder{Path|Location} functions
  20  * of shell32, that get either a filesystem path or a LPITEMIDLIST (shell
  21  * namespace) path for a given folder (CSIDL value).
  22  *
  23  * FIXME:
  24  * - Need to verify on more systems.
  25  */
  26
  27 #define COBJMACROS
  28
  29 #include <stdarg.h>
  30 #include <stdio.h>
  31 #include "windef.h"
  32 #include "winbase.h"
  33 #include "shlguid.h"
  34 #include "shlobj.h"
  35 #include "shlwapi.h"
  36 #include "wine/test.h"
  37
  38 /* CSIDL_MYDOCUMENTS is now the same as CSIDL_PERSONAL, but what we want
  39  * here is its original value.
  40  */
  41 #define OLD_CSIDL_MYDOCUMENTS  0x000c
  42
  43 #ifndef ARRAY_SIZE
  44 #define ARRAY_SIZE(x) ( sizeof(x) / sizeof((x)[0]) )
  45 #endif
  46
  47 /* from pidl.h, not included here: */
  48 #ifndef PT_GUID
  49 #define PT_GUID       0x1f /* no path */
  50 #endif
  51 #ifndef PT_DRIVE
  52 #define PT_DRIVE      0x23 /* has path */
  53 #endif
  54 #ifndef PT_DRIVE2
  55 #define PT_DRIVE2     0x25 /* has path */
  56 #endif
  57 #ifndef PT_SHELLEXT
  58 #define PT_SHELLEXT   0x2e /* no path */
  59 #endif
  60 #ifndef PT_FOLDER
  61 #define PT_FOLDER     0x31 /* has path */
  62 #endif
  63 #ifndef PT_WORKGRP
  64 #define PT_WORKGRP    0x41 /* no path */
  65 #endif
  66 #ifndef PT_YAGUID
  67 #define PT_YAGUID     0x70 /* no path */
  68 #endif
  69 /* FIXME: this is used for history/favorites folders; what's a better name? */
  70 #ifndef PT_IESPECIAL2
  71 #define PT_IESPECIAL2 0xb1 /* has path */
  72 #endif
  73
  74 static GUID CLSID_CommonDocuments = { 0x0000000c, 0x0000, 0x0000, { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x74, 0x1a } };
  75
  76 struct shellExpectedValues {
  77     int  folder;
  78     BYTE pidlType;
  79 };
  80
  81 static HRESULT (WINAPI *pDllGetVersion)(DLLVERSIONINFO *);
  82 static HRESULT (WINAPI *pSHGetFolderPathA)(HWND, int, HANDLE, DWORD, LPSTR);
  83 static HRESULT (WINAPI *pSHGetFolderLocation)(HWND, int, HANDLE, DWORD,
  84  LPITEMIDLIST *);
  85 static BOOL    (WINAPI *pSHGetSpecialFolderPathA)(HWND, LPSTR, int, BOOL);
  86 static HRESULT (WINAPI *pSHGetSpecialFolderLocation)(HWND, int, LPITEMIDLIST *);
  87 static LPITEMIDLIST (WINAPI *pILFindLastID)(LPCITEMIDLIST);
  88 static int (WINAPI *pSHFileOperationA)(LPSHFILEOPSTRUCTA);
  89 static HRESULT (WINAPI *pSHGetMalloc)(LPMALLOC *);
  90 static DLLVERSIONINFO shellVersion = { 0 };
  91 static LPMALLOC pMalloc;
  92 static const struct shellExpectedValues requiredShellValues[] = {
  93  { CSIDL_BITBUCKET, PT_GUID },
  94  { CSIDL_CONTROLS, PT_SHELLEXT },
  95  { CSIDL_COOKIES, PT_FOLDER },
  96  { CSIDL_DESKTOPDIRECTORY, PT_FOLDER },
  97  { CSIDL_DRIVES, PT_GUID },
  98  { CSIDL_FAVORITES, PT_FOLDER },
  99  { CSIDL_FONTS, PT_FOLDER },
 100 /* FIXME: the following fails in Wine, returns type PT_FOLDER
 101  { CSIDL_HISTORY, PT_IESPECIAL2 },
 102  */
 103  { CSIDL_INTERNET, PT_GUID },
 104  { CSIDL_NETHOOD, PT_FOLDER },
 105  { CSIDL_NETWORK, PT_GUID },
 106  { CSIDL_PRINTERS, PT_YAGUID },
 107  { CSIDL_PRINTHOOD, PT_FOLDER },
 108  { CSIDL_PROGRAMS, PT_FOLDER },
 109  { CSIDL_RECENT, PT_FOLDER },
 110  { CSIDL_SENDTO, PT_FOLDER },
 111  { CSIDL_STARTMENU, PT_FOLDER },
 112  { CSIDL_STARTUP, PT_FOLDER },
 113  { CSIDL_TEMPLATES, PT_FOLDER },
 114 };
 115 static const struct shellExpectedValues optionalShellValues[] = {
 116 /* FIXME: the following only semi-succeed; they return NULL PIDLs on XP.. hmm.
 117  { CSIDL_ALTSTARTUP, PT_FOLDER },
 118  { CSIDL_COMMON_ALTSTARTUP, PT_FOLDER },
 119  { CSIDL_COMMON_OEM_LINKS, PT_FOLDER },
 120  */
 121 /* Windows NT-only: */
 122  { CSIDL_COMMON_DESKTOPDIRECTORY, PT_FOLDER },
 123  { CSIDL_COMMON_DOCUMENTS, PT_SHELLEXT },
 124  { CSIDL_COMMON_FAVORITES, PT_FOLDER },
 125  { CSIDL_COMMON_PROGRAMS, PT_FOLDER },
 126  { CSIDL_COMMON_STARTMENU, PT_FOLDER },
 127  { CSIDL_COMMON_STARTUP, PT_FOLDER },
 128  { CSIDL_COMMON_TEMPLATES, PT_FOLDER },
 129 /* first appearing in shell32 version 4.71: */
 130  { CSIDL_APPDATA, PT_FOLDER },
 131 /* first appearing in shell32 version 4.72: */
 132  { CSIDL_INTERNET_CACHE, PT_IESPECIAL2 },
 133 /* first appearing in shell32 version 5.0: */
 134  { CSIDL_ADMINTOOLS, PT_FOLDER },
 135  { CSIDL_COMMON_APPDATA, PT_FOLDER },
 136  { CSIDL_LOCAL_APPDATA, PT_FOLDER },
 137  { OLD_CSIDL_MYDOCUMENTS, PT_FOLDER },
 138  { CSIDL_MYMUSIC, PT_FOLDER },
 139  { CSIDL_MYPICTURES, PT_FOLDER },
 140  { CSIDL_MYVIDEO, PT_FOLDER },
 141  { CSIDL_PROFILE, PT_FOLDER },
 142  { CSIDL_PROGRAM_FILES, PT_FOLDER },
 143  { CSIDL_PROGRAM_FILESX86, PT_FOLDER },
 144  { CSIDL_PROGRAM_FILES_COMMON, PT_FOLDER },
 145  { CSIDL_PROGRAM_FILES_COMMONX86, PT_FOLDER },
 146  { CSIDL_SYSTEM, PT_FOLDER },
 147  { CSIDL_WINDOWS, PT_FOLDER },
 148 /* first appearing in shell32 6.0: */
 149  { CSIDL_CDBURN_AREA, PT_FOLDER },
 150  { CSIDL_COMMON_MUSIC, PT_FOLDER },
 151  { CSIDL_COMMON_PICTURES, PT_FOLDER },
 152  { CSIDL_COMMON_VIDEO, PT_FOLDER },
 153  { CSIDL_COMPUTERSNEARME, PT_WORKGRP },
 154  { CSIDL_RESOURCES, PT_FOLDER },
 155  { CSIDL_RESOURCES_LOCALIZED, PT_FOLDER },
 156 };
 157
 158 static void loadShell32(void)
 159 {
 160     HMODULE hShell32 = GetModuleHandleA("shell32");
 161
 162 #define GET_PROC(func) \
 163     p ## func = (void*)GetProcAddress(hShell32, #func); \
 164     if(!p ## func) \
 165       trace("GetProcAddress(%s) failed\n", #func);
 166
 167     GET_PROC(DllGetVersion)
 168     GET_PROC(SHGetFolderPathA)
 169     GET_PROC(SHGetFolderLocation)
 170     GET_PROC(SHGetSpecialFolderPathA)
 171     GET_PROC(SHGetSpecialFolderLocation)
 172     GET_PROC(ILFindLastID)
 173     if (!pILFindLastID)
 174         pILFindLastID = (void *)GetProcAddress(hShell32, (LPCSTR)16);
 175     GET_PROC(SHFileOperationA)
 176     GET_PROC(SHGetMalloc)
 177
 178     ok(pSHGetMalloc != NULL, "shell32 is missing SHGetMalloc\n");
 179     if (pSHGetMalloc)
 180     {
 181         HRESULT hr = pSHGetMalloc(&pMalloc);
 182
 183         ok(SUCCEEDED(hr), "SHGetMalloc failed: 0x%08x\n", hr);
 184         ok(pMalloc != NULL, "SHGetMalloc returned a NULL IMalloc\n");
 185     }
 186
 187     if (pDllGetVersion)
 188     {
 189         shellVersion.cbSize = sizeof(shellVersion);
 190         pDllGetVersion(&shellVersion);
 191         if (winetest_interactive)
 192             printf("shell32 version is %d.%d\n",
 193              shellVersion.dwMajorVersion, shellVersion.dwMinorVersion);
 194     }
 195 #undef GET_PROC
 196 }
 197
 198 #ifndef CSIDL_PROFILES
 199 #define CSIDL_PROFILES          0x003e
 200 #endif
 201
 202 /* A couple utility printing functions */
 203 static const char *getFolderName(int folder)
 204 {
 205     static char unknown[32];
 206
 207 #define CSIDL_TO_STR(x) case x: return#x;
 208     switch (folder)
 209     {
 210     CSIDL_TO_STR(CSIDL_DESKTOP);
 211     CSIDL_TO_STR(CSIDL_INTERNET);
 212     CSIDL_TO_STR(CSIDL_PROGRAMS);
 213     CSIDL_TO_STR(CSIDL_CONTROLS);
 214     CSIDL_TO_STR(CSIDL_PRINTERS);
 215     CSIDL_TO_STR(CSIDL_PERSONAL);
 216     CSIDL_TO_STR(CSIDL_FAVORITES);
 217     CSIDL_TO_STR(CSIDL_STARTUP);
 218     CSIDL_TO_STR(CSIDL_RECENT);
 219     CSIDL_TO_STR(CSIDL_SENDTO);
 220     CSIDL_TO_STR(CSIDL_BITBUCKET);
 221     CSIDL_TO_STR(CSIDL_STARTMENU);
 222     CSIDL_TO_STR(OLD_CSIDL_MYDOCUMENTS);
 223     CSIDL_TO_STR(CSIDL_MYMUSIC);
 224     CSIDL_TO_STR(CSIDL_MYVIDEO);
 225     CSIDL_TO_STR(CSIDL_DESKTOPDIRECTORY);
 226     CSIDL_TO_STR(CSIDL_DRIVES);
 227     CSIDL_TO_STR(CSIDL_NETWORK);
 228     CSIDL_TO_STR(CSIDL_NETHOOD);
 229     CSIDL_TO_STR(CSIDL_FONTS);
 230     CSIDL_TO_STR(CSIDL_TEMPLATES);
 231     CSIDL_TO_STR(CSIDL_COMMON_STARTMENU);
 232     CSIDL_TO_STR(CSIDL_COMMON_PROGRAMS);
 233     CSIDL_TO_STR(CSIDL_COMMON_STARTUP);
 234     CSIDL_TO_STR(CSIDL_COMMON_DESKTOPDIRECTORY);
 235     CSIDL_TO_STR(CSIDL_APPDATA);
 236     CSIDL_TO_STR(CSIDL_PRINTHOOD);
 237     CSIDL_TO_STR(CSIDL_LOCAL_APPDATA);
 238     CSIDL_TO_STR(CSIDL_ALTSTARTUP);
 239     CSIDL_TO_STR(CSIDL_COMMON_ALTSTARTUP);
 240     CSIDL_TO_STR(CSIDL_COMMON_FAVORITES);
 241     CSIDL_TO_STR(CSIDL_INTERNET_CACHE);
 242     CSIDL_TO_STR(CSIDL_COOKIES);
 243     CSIDL_TO_STR(CSIDL_HISTORY);
 244     CSIDL_TO_STR(CSIDL_COMMON_APPDATA);
 245     CSIDL_TO_STR(CSIDL_WINDOWS);
 246     CSIDL_TO_STR(CSIDL_SYSTEM);
 247     CSIDL_TO_STR(CSIDL_PROGRAM_FILES);
 248     CSIDL_TO_STR(CSIDL_MYPICTURES);
 249     CSIDL_TO_STR(CSIDL_PROFILE);
 250     CSIDL_TO_STR(CSIDL_SYSTEMX86);
 251     CSIDL_TO_STR(CSIDL_PROGRAM_FILESX86);
 252     CSIDL_TO_STR(CSIDL_PROGRAM_FILES_COMMON);
 253     CSIDL_TO_STR(CSIDL_PROGRAM_FILES_COMMONX86);
 254     CSIDL_TO_STR(CSIDL_COMMON_TEMPLATES);
 255     CSIDL_TO_STR(CSIDL_COMMON_DOCUMENTS);
 256     CSIDL_TO_STR(CSIDL_COMMON_ADMINTOOLS);
 257     CSIDL_TO_STR(CSIDL_ADMINTOOLS);
 258     CSIDL_TO_STR(CSIDL_CONNECTIONS);
 259     CSIDL_TO_STR(CSIDL_PROFILES);
 260     CSIDL_TO_STR(CSIDL_COMMON_MUSIC);
 261     CSIDL_TO_STR(CSIDL_COMMON_PICTURES);
 262     CSIDL_TO_STR(CSIDL_COMMON_VIDEO);
 263     CSIDL_TO_STR(CSIDL_RESOURCES);
 264     CSIDL_TO_STR(CSIDL_RESOURCES_LOCALIZED);
 265     CSIDL_TO_STR(CSIDL_COMMON_OEM_LINKS);
 266     CSIDL_TO_STR(CSIDL_CDBURN_AREA);
 267     CSIDL_TO_STR(CSIDL_COMPUTERSNEARME);
 268 #undef CSIDL_TO_STR
 269     default:
 270         sprintf(unknown, "unknown (0x%04x)", folder);
 271         return unknown;
 272     }
 273 }
 274
 275 static const char *printGUID(const GUID *guid, char * guidSTR)
 276 {
 277     if (!guid) return NULL;
 278
 279     sprintf(guidSTR, "{%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x}",
 280      guid->Data1, guid->Data2, guid->Data3,
 281      guid->Data4[0], guid->Data4[1], guid->Data4[2], guid->Data4[3],
 282      guid->Data4[4], guid->Data4[5], guid->Data4[6], guid->Data4[7]);
 283     return guidSTR;
 284 }
 285
 286 static void testSHGetFolderLocationInvalidArgs(void)
 287 {
 288     LPITEMIDLIST pidl;
 289     HRESULT hr;
 290
 291     if (!pSHGetFolderLocation) return;
 292
 293     /* check a bogus CSIDL: */
 294     pidl = NULL;
 295     hr = pSHGetFolderLocation(NULL, 0xeeee, NULL, 0, &pidl);
 296     ok(hr == E_INVALIDARG,
 297      "SHGetFolderLocation(NULL, 0xeeee, NULL, 0, &pidl) returned 0x%08x, expected E_INVALIDARG\n", hr);
 298     if (SUCCEEDED(hr))
 299         IMalloc_Free(pMalloc, pidl);
 300     /* check a bogus user token: */
 301     pidl = NULL;
 302     hr = pSHGetFolderLocation(NULL, CSIDL_FAVORITES, (HANDLE)2, 0, &pidl);
 303     ok(hr == E_FAIL,
 304      "SHGetFolderLocation(NULL, CSIDL_FAVORITES, 2, 0, &pidl) returned 0x%08x, expected E_FAIL\n", hr);
 305     if (SUCCEEDED(hr))
 306         IMalloc_Free(pMalloc, pidl);
 307     /* check reserved is not zero: */
 308     pidl = NULL;
 309     hr = pSHGetFolderLocation(NULL, CSIDL_DESKTOP, NULL, 1, &pidl);
 310     ok(hr == E_INVALIDARG,
 311      "SHGetFolderLocation(NULL, CSIDL_DESKTOP, NULL, 1, &pidl) returned 0x%08x, expected E_INVALIDARG\n", hr);
 312     if (SUCCEEDED(hr))
 313         IMalloc_Free(pMalloc, pidl);
 314     /* a NULL pidl pointer crashes, so don't test it */
 315 }
 316
 317 static void testSHGetSpecialFolderLocationInvalidArgs(void)
 318 {
 319     LPITEMIDLIST pidl = NULL;
 320     HRESULT hr;
 321
 322     if (!pSHGetSpecialFolderLocation) return;
 323
 324     /* SHGetSpecialFolderLocation(NULL, 0, NULL) crashes */
 325     hr = pSHGetSpecialFolderLocation(NULL, 0xeeee, &pidl);
 326     ok(hr == E_INVALIDARG,
 327      "SHGetSpecialFolderLocation(NULL, 0xeeee, &pidl) returned 0x%08x, "
 328      "expected E_INVALIDARG\n", hr);
 329 }
 330
 331 static void testSHGetFolderPathInvalidArgs(void)
 332 {
 333     char path[MAX_PATH];
 334     HRESULT hr;
 335
 336     if (!pSHGetFolderPathA) return;
 337
 338     /* expect 2's a bogus handle, especially since we didn't open it */
 339     hr = pSHGetFolderPathA(NULL, CSIDL_DESKTOP, (HANDLE)2,
 340      SHGFP_TYPE_DEFAULT, path);
 341     ok(hr == E_FAIL,
 342      "SHGetFolderPathA(NULL, CSIDL_DESKTOP, 2, SHGFP_TYPE_DEFAULT, path) returned 0x%08x, expected E_FAIL\n", hr);
 343     hr = pSHGetFolderPathA(NULL, 0xeeee, NULL, SHGFP_TYPE_DEFAULT, path);
 344     ok(hr == E_INVALIDARG,
 345      "SHGetFolderPathA(NULL, 0xeeee, NULL, SHGFP_TYPE_DEFAULT, path) returned 0x%08x, expected E_INVALIDARG\n", hr);
 346 }
 347
 348 static void testSHGetSpecialFolderPathInvalidArgs(void)
 349 {
 350     char path[MAX_PATH];
 351     BOOL ret;
 352
 353     if (!pSHGetSpecialFolderPathA) return;
 354
 355 #if 0
 356     ret = pSHGetSpecialFolderPathA(NULL, NULL, CSIDL_BITBUCKET, FALSE);
 357     ok(!ret,
 358      "SHGetSpecialFolderPathA(NULL, NULL, CSIDL_BITBUCKET, FALSE) returned TRUE, expected FALSE\n");
 359 #endif
 360     /* odd but true: calling with a NULL path still succeeds if it's a real
 361      * dir (on some windows platform).  on winME it generates exception.
 362      */
 363     ret = pSHGetSpecialFolderPathA(NULL, path, CSIDL_PROGRAMS, FALSE);
 364     ok(ret,
 365      "SHGetSpecialFolderPathA(NULL, path, CSIDL_PROGRAMS, FALSE) returned FALSE, expected TRUE\n");
 366     ret = pSHGetSpecialFolderPathA(NULL, path, 0xeeee, FALSE);
 367     ok(!ret,
 368      "SHGetSpecialFolderPathA(NULL, path, 0xeeee, FALSE) returned TRUE, expected FALSE\n");
 369 }
 370
 371 static void testApiParameters(void)
 372 {
 373     testSHGetFolderLocationInvalidArgs();
 374     testSHGetSpecialFolderLocationInvalidArgs();
 375     testSHGetFolderPathInvalidArgs();
 376     testSHGetSpecialFolderPathInvalidArgs();
 377 }
 378
 379 /* Returns the folder's PIDL type, or 0xff if one can't be found. */
 380 static BYTE testSHGetFolderLocation(BOOL optional, int folder)
 381 {
 382     LPITEMIDLIST pidl;
 383     HRESULT hr;
 384     BYTE ret = 0xff;
 385
 386     /* treat absence of function as success */
 387     if (!pSHGetFolderLocation) return TRUE;
 388
 389     pidl = NULL;
 390     hr = pSHGetFolderLocation(NULL, folder, NULL, 0, &pidl);
 391     ok(SUCCEEDED(hr) || optional,
 392      "SHGetFolderLocation(NULL, %s, NULL, 0, &pidl) failed: 0x%08x\n", getFolderName(folder), hr);
 393     if (SUCCEEDED(hr))
 394     {
 395         ok(pidl != NULL,
 396          "SHGetFolderLocation(NULL, %s, NULL, 0, &pidl) succeeded, but returned pidl is NULL\n", getFolderName(folder));
 397         if (pidl)
 398         {
 399             LPITEMIDLIST pidlLast = pILFindLastID(pidl);
 400
 401             ok(pidlLast != NULL, "%s: ILFindLastID failed\n",
 402              getFolderName(folder));
 403             if (pidlLast)
 404                 ret = pidlLast->mkid.abID[0];
 405             IMalloc_Free(pMalloc, pidl);
 406         }
 407     }
 408     return ret;
 409 }
 410
 411 /* Returns the folder's PIDL type, or 0xff if one can't be found. */
 412 static BYTE testSHGetSpecialFolderLocation(BOOL optional, int folder)
 413 {
 414     LPITEMIDLIST pidl;
 415     HRESULT hr;
 416     BYTE ret = 0xff;
 417
 418     /* treat absence of function as success */
 419     if (!pSHGetSpecialFolderLocation) return TRUE;
 420
 421     pidl = NULL;
 422     hr = pSHGetSpecialFolderLocation(NULL, folder, &pidl);
 423     ok(SUCCEEDED(hr) || optional,
 424      "SHGetSpecialFolderLocation(NULL, %s, &pidl) failed: 0x%08x\n", getFolderName(folder), hr);
 425     if (SUCCEEDED(hr))
 426     {
 427         ok(pidl != NULL,
 428          "SHGetSpecialFolderLocation(NULL, %s, &pidl) succeeded, but returned pidl is NULL\n", getFolderName(folder));
 429         if (pidl)
 430         {
 431             LPITEMIDLIST pidlLast = pILFindLastID(pidl);
 432
 433             ok(pidlLast != NULL,
 434                 "%s: ILFindLastID failed\n", getFolderName(folder));
 435             if (pidlLast)
 436                 ret = pidlLast->mkid.abID[0];
 437             IMalloc_Free(pMalloc, pidl);
 438         }
 439     }
 440     return ret;
 441 }
 442
 443 static void testSHGetFolderPath(BOOL optional, int folder)
 444 {
 445     char path[MAX_PATH];
 446     HRESULT hr;
 447
 448     if (!pSHGetFolderPathA) return;
 449
 450     hr = pSHGetFolderPathA(NULL, folder, NULL, SHGFP_TYPE_CURRENT, path);
 451     ok(SUCCEEDED(hr) || optional,
 452      "SHGetFolderPathA(NULL, %s, NULL, SHGFP_TYPE_CURRENT, path) failed: 0x%08x\n", getFolderName(folder), hr);
 453 }
 454
 455 static void testSHGetSpecialFolderPath(BOOL optional, int folder)
 456 {
 457     char path[MAX_PATH];
 458     BOOL ret;
 459
 460     if (!pSHGetSpecialFolderPathA) return;
 461
 462     ret = pSHGetSpecialFolderPathA(NULL, path, folder, FALSE);
 463     if (ret && winetest_interactive)
 464         printf("%s: %s\n", getFolderName(folder), path);
 465     ok(ret || optional,
 466      "SHGetSpecialFolderPathA(NULL, path, %s, FALSE) failed\n",
 467      getFolderName(folder));
 468 }
 469
 470 static void testShellValues(const struct shellExpectedValues testEntries[],
 471  int numEntries, BOOL optional)
 472 {
 473     int i;
 474
 475     for (i = 0; i < numEntries; i++)
 476     {
 477         BYTE type;
 478
 479         if (pSHGetFolderLocation)
 480         {
 481             type = testSHGetFolderLocation(optional, testEntries[i].folder);
 482             ok(type == testEntries[i].pidlType || optional,
 483              "%s has type %d (0x%02x), expected %d (0x%02x)\n",
 484              getFolderName(testEntries[i].folder), type, type,
 485              testEntries[i].pidlType, testEntries[i].pidlType);
 486         }
 487         type = testSHGetSpecialFolderLocation(optional, testEntries[i].folder);
 488         ok(type == testEntries[i].pidlType || optional,
 489          "%s has type %d (0x%02x), expected %d (0x%02x)\n",
 490          getFolderName(testEntries[i].folder), type, type,
 491          testEntries[i].pidlType, testEntries[i].pidlType);
 492         switch (type)
 493         {
 494             case PT_FOLDER:
 495             case PT_DRIVE:
 496             case PT_DRIVE2:
 497             case PT_IESPECIAL2:
 498                 testSHGetFolderPath(optional, testEntries[i].folder);
 499                 testSHGetSpecialFolderPath(optional, testEntries[i].folder);
 500                 break;
 501         }
 502     }
 503 }
 504
 505 /* Attempts to verify that the folder path corresponding to the folder CSIDL
 506  * value has the same value as the environment variable with name envVar.
 507  * Doesn't mind if SHGetSpecialFolderPath fails for folder or if envVar isn't
 508  * set in this environment; different OS and shell version behave differently.
 509  * However, if both are present, fails if envVar's value is not the same
 510  * (byte-for-byte) as what SHGetSpecialFolderPath returns.
 511  */
 512 static void matchSpecialFolderPathToEnv(int folder, const char *envVar)
 513 {
 514     char path[MAX_PATH];
 515
 516     if (!pSHGetSpecialFolderPathA) return;
 517
 518     if (pSHGetSpecialFolderPathA(NULL, path, folder, FALSE))
 519     {
 520         char *envVal = getenv(envVar);
 521
 522         ok(!envVal || !lstrcmpiA(envVal, path),
 523          "%%%s%% does not match SHGetSpecialFolderPath:\n"
 524          "%%%s%% is %s\nSHGetSpecialFolderPath returns %s\n",
 525          envVar, envVar, envVal, path);
 526     }
 527 }
 528
 529 /* Attempts to match the GUID returned by SHGetFolderLocation for folder with
 530  * GUID.  Assumes the type of the returned PIDL is in fact a GUID, but doesn't
 531  * fail if it isn't--that check should already have been done.
 532  * Fails if the returned PIDL is a GUID whose value does not match guid.
 533  */
 534 static void matchGUID(int folder, const GUID *guid)
 535 {
 536     LPITEMIDLIST pidl;
 537     HRESULT hr;
 538
 539     if (!pSHGetFolderLocation) return;
 540     if (!guid) return;
 541
 542     pidl = NULL;
 543     hr = pSHGetFolderLocation(NULL, folder, NULL, 0, &pidl);
 544     if (SUCCEEDED(hr))
 545     {
 546         LPITEMIDLIST pidlLast = pILFindLastID(pidl);
 547
 548         if (pidlLast && (pidlLast->mkid.abID[0] == PT_SHELLEXT ||
 549          pidlLast->mkid.abID[0] == PT_GUID))
 550         {
 551             GUID *shellGuid = (GUID *)(pidlLast->mkid.abID + 2);
 552             char shellGuidStr[39], guidStr[39];
 553
 554             ok(IsEqualIID(shellGuid, guid),
 555              "%s: got GUID %s, expected %s\n", getFolderName(folder),
 556              printGUID(shellGuid, shellGuidStr), printGUID(guid, guidStr));
 557         }
 558         IMalloc_Free(pMalloc, pidl);
 559     }
 560 }
 561
 562 static void testDesktop(void)
 563 {
 564     testSHGetFolderPath(FALSE, CSIDL_DESKTOP);
 565     testSHGetSpecialFolderPath(FALSE, CSIDL_DESKTOP);
 566     /* Test the desktop; even though SHITEMID should always contain abID of at
 567      * least one type, when cb is 0 its value is undefined.  So don't check
 568      * what the returned type is, just make sure it exists.
 569      */
 570     testSHGetFolderLocation(FALSE, CSIDL_DESKTOP);
 571     testSHGetSpecialFolderLocation(FALSE, CSIDL_DESKTOP);
 572 }
 573
 574 static void testPersonal(void)
 575 {
 576     BYTE type;
 577
 578     /* The pidl may be a real folder, or a virtual directory, or a drive if the
 579      * home directory is set to the root directory of a drive.
 580      */
 581     if (pSHGetFolderLocation)
 582     {
 583         type = testSHGetFolderLocation(FALSE, CSIDL_PERSONAL);
 584         ok(type == PT_FOLDER || type == PT_GUID || type == PT_DRIVE,
 585          "CSIDL_PERSONAL returned invalid type 0x%02x, "
 586          "expected PT_FOLDER or PT_GUID\n", type);
 587         if (type == PT_FOLDER)
 588             testSHGetFolderPath(FALSE, CSIDL_PERSONAL);
 589     }
 590     type = testSHGetSpecialFolderLocation(FALSE, CSIDL_PERSONAL);
 591     ok(type == PT_FOLDER || type == PT_GUID || type == PT_DRIVE,
 592      "CSIDL_PERSONAL returned invalid type 0x%02x, "
 593      "expected PT_FOLDER or PT_GUID\n", type);
 594     if (type == PT_FOLDER)
 595         testSHGetSpecialFolderPath(FALSE, CSIDL_PERSONAL);
 596 }
 597
 598 /* Checks the PIDL type of all the known values. */
 599 static void testPidlTypes(void)
 600 {
 601     testDesktop();
 602     testPersonal();
 603     testShellValues(requiredShellValues, ARRAY_SIZE(requiredShellValues),
 604      FALSE);
 605     testShellValues(optionalShellValues, ARRAY_SIZE(optionalShellValues),
 606      TRUE);
 607 }
 608
 609 /* Verifies various shell virtual folders have the correct well-known GUIDs. */
 610 static void testGUIDs(void)
 611 {
 612     matchGUID(CSIDL_BITBUCKET, &CLSID_RecycleBin);
 613     matchGUID(CSIDL_CONTROLS, &CLSID_ControlPanel);
 614     matchGUID(CSIDL_DRIVES, &CLSID_MyComputer);
 615     matchGUID(CSIDL_INTERNET, &CLSID_Internet);
 616     matchGUID(CSIDL_NETWORK, &CLSID_NetworkPlaces);
 617     matchGUID(CSIDL_PERSONAL, &CLSID_MyDocuments);
 618     matchGUID(CSIDL_COMMON_DOCUMENTS, &CLSID_CommonDocuments);
 619 }
 620
 621 /* Verifies various shell paths match the environment variables to which they
 622  * correspond.
 623  */
 624 static void testEnvVars(void)
 625 {
 626     matchSpecialFolderPathToEnv(CSIDL_PROGRAM_FILES, "ProgramFiles");
 627     matchSpecialFolderPathToEnv(CSIDL_APPDATA, "APPDATA");
 628     matchSpecialFolderPathToEnv(CSIDL_PROFILE, "USERPROFILE");
 629     matchSpecialFolderPathToEnv(CSIDL_WINDOWS, "SystemRoot");
 630     matchSpecialFolderPathToEnv(CSIDL_WINDOWS, "windir");
 631     matchSpecialFolderPathToEnv(CSIDL_PROGRAM_FILES_COMMON,
 632      "CommonProgramFiles");
 633     /* this is only set on Wine, but can't hurt to verify it: */
 634     matchSpecialFolderPathToEnv(CSIDL_SYSTEM, "winsysdir");
 635 }
 636
 637 /* Loosely based on PathRemoveBackslashA from dlls/shlwapi/path.c */
 638 static BOOL myPathIsRootA(LPCSTR lpszPath)
 639 {
 640   if (lpszPath && *lpszPath &&
 641       lpszPath[1] == ':' && lpszPath[2] == '\\' && lpszPath[3] == '\0')
 642       return TRUE; /* X:\ */
 643   return FALSE;
 644 }
 645 static LPSTR myPathRemoveBackslashA( LPSTR lpszPath )
 646 {
 647   LPSTR szTemp = NULL;
 648
 649   if(lpszPath)
 650   {
 651     szTemp = CharPrevA(lpszPath, lpszPath + strlen(lpszPath));
 652     if (!myPathIsRootA(lpszPath) && *szTemp == '\\')
 653       *szTemp = '\0';
 654   }
 655   return szTemp;
 656 }
 657
 658 /* Verifies the shell path for CSIDL_WINDOWS matches the return from
 659  * GetWindowsDirectory.  If SHGetSpecialFolderPath fails, no harm, no foul--not
 660  * every shell32 version supports CSIDL_WINDOWS.
 661  */
 662 static void testWinDir(void)
 663 {
 664     char windowsShellPath[MAX_PATH], windowsDir[MAX_PATH] = { 0 };
 665
 666     if (!pSHGetSpecialFolderPathA) return;
 667
 668     if (pSHGetSpecialFolderPathA(NULL, windowsShellPath, CSIDL_WINDOWS, FALSE))
 669     {
 670         myPathRemoveBackslashA(windowsShellPath);
 671         GetWindowsDirectoryA(windowsDir, sizeof(windowsDir));
 672         myPathRemoveBackslashA(windowsDir);
 673         ok(!lstrcmpiA(windowsDir, windowsShellPath),
 674          "GetWindowsDirectory returns %s SHGetSpecialFolderPath returns %s\n",
 675          windowsDir, windowsShellPath);
 676     }
 677 }
 678
 679 /* Verifies the shell path for CSIDL_SYSTEM and CSIDL_SYSTEMX86 matches the
 680  * return from GetSystemDirectory.  If SHGetSpecialFolderPath fails, no harm,
 681  * no foul--not every shell32 version supports CSIDL_SYSTEM.
 682  */
 683 static void testSystemDir(void)
 684 {
 685     char systemShellPath[MAX_PATH], systemDir[MAX_PATH] = { 0 };
 686
 687     if (!pSHGetSpecialFolderPathA) return;
 688
 689     GetSystemDirectoryA(systemDir, sizeof(systemDir));
 690     myPathRemoveBackslashA(systemDir);
 691     if (pSHGetSpecialFolderPathA(NULL, systemShellPath, CSIDL_SYSTEM, FALSE))
 692     {
 693         myPathRemoveBackslashA(systemShellPath);
 694         ok(!lstrcmpiA(systemDir, systemShellPath),
 695          "GetSystemDirectory returns %s SHGetSpecialFolderPath returns %s\n",
 696          systemDir, systemShellPath);
 697     }
 698     /* check CSIDL_SYSTEMX86; note that this isn't always present, so don't
 699      * worry if it fails
 700      */
 701     if (pSHGetSpecialFolderPathA(NULL, systemShellPath, CSIDL_SYSTEMX86, FALSE))
 702     {
 703         myPathRemoveBackslashA(systemShellPath);
 704         ok(!lstrcmpiA(systemDir, systemShellPath),
 705          "GetSystemDirectory returns %s SHGetSpecialFolderPath returns %s\n",
 706          systemDir, systemShellPath);
 707     }
 708 }
 709
 710 /* Globals used by subprocesses */
 711 static int    myARGC;
 712 static char **myARGV;
 713 static char   base[MAX_PATH];
 714 static char   selfname[MAX_PATH];
 715
 716 static int init(void)
 717 {
 718     myARGC = winetest_get_mainargs(&myARGV);
 719     if (!GetCurrentDirectoryA(sizeof(base), base)) return 0;
 720     strcpy(selfname, myARGV[0]);
 721     return 1;
 722 }
 723
 724 /* Subprocess helper 1: test what happens when CSIDL_FAVORITES is set to a
 725  * nonexistent directory.
 726  */
 727 static void testNonExistentPath1(void)
 728 {
 729     HRESULT hr;
 730     LPITEMIDLIST pidl;
 731     char path[MAX_PATH];
 732
 733     /* test some failure cases first: */
 734     hr = pSHGetFolderPathA(NULL, CSIDL_FAVORITES, NULL,
 735      SHGFP_TYPE_CURRENT, path);
 736     ok(hr == HRESULT_FROM_WIN32(ERROR_FILE_NOT_FOUND),
 737      "SHGetFolderPath returned 0x%08x, expected 0x80070002\n", hr);
 738     pidl = NULL;
 739     hr = pSHGetFolderLocation(NULL, CSIDL_FAVORITES, NULL, 0,
 740      &pidl);
 741     ok(hr == E_FAIL,
 742      "SHGetFolderLocation returned 0x%08x, expected E_FAIL\n", hr);
 743     if (SUCCEEDED(hr) && pidl)
 744         IMalloc_Free(pMalloc, pidl);
 745     ok(!pSHGetSpecialFolderPathA(NULL, path, CSIDL_FAVORITES, FALSE),
 746      "SHGetSpecialFolderPath succeeded, expected failure\n");
 747     pidl = NULL;
 748     hr = pSHGetSpecialFolderLocation(NULL, CSIDL_FAVORITES, &pidl);
 749     ok(hr == E_FAIL, "SHGetFolderLocation returned 0x%08x, expected E_FAIL\n",
 750      hr);
 751     if (SUCCEEDED(hr) && pidl)
 752         IMalloc_Free(pMalloc, pidl);
 753     /* now test success: */
 754     hr = pSHGetFolderPathA(NULL, CSIDL_FAVORITES | CSIDL_FLAG_CREATE, NULL,
 755      SHGFP_TYPE_CURRENT, path);
 756     if (SUCCEEDED(hr))
 757     {
 758         BOOL ret;
 759
 760         if (winetest_interactive)
 761             printf("CSIDL_FAVORITES was changed to %s\n", path);
 762         ret = CreateDirectoryA(path, NULL);
 763         ok(!ret,
 764          "CreateDirectoryA succeeded but should have failed "
 765          "with ERROR_ALREADY_EXISTS\n");
 766         if (!ret)
 767             ok(GetLastError() == ERROR_ALREADY_EXISTS,
 768              "CreateDirectoryA failed with %d, "
 769              "expected ERROR_ALREADY_EXISTS\n",
 770              GetLastError());
 771     }
 772     ok(SUCCEEDED(hr),
 773      "SHGetFolderPath(NULL, CSIDL_FAVORITES | CSIDL_FLAG_CREATE, "
 774      "NULL, SHGFP_TYPE_CURRENT, path) failed: 0x%08x\n", hr);
 775 }
 776
 777 /* Subprocess helper 2: make sure SHGetFolderPath still succeeds when the
 778  * original value of CSIDL_FAVORITES is restored.
 779  */
 780 static void testNonExistentPath2(void)
 781 {
 782     HRESULT hr;
 783     char path[MAX_PATH];
 784
 785     hr = pSHGetFolderPathA(NULL, CSIDL_FAVORITES | CSIDL_FLAG_CREATE, NULL,
 786      SHGFP_TYPE_CURRENT, path);
 787     ok(SUCCEEDED(hr), "SHGetFolderPath failed: 0x%08x\n", hr);
 788 }
 789
 790 static void doChild(const char *arg)
 791 {
 792     if (arg[0] == '1')
 793         testNonExistentPath1();
 794     else if (arg[0] == '2')
 795         testNonExistentPath2();
 796 }
 797
 798 /* Tests the return values from the various shell functions both with and
 799  * without the use of the CSIDL_FLAG_CREATE flag.  This flag only appeared in
 800  * version 5 of the shell, so don't test unless it's at least version 5.
 801  * The test reads a value from the registry, modifies it, calls
 802  * SHGetFolderPath once with the CSIDL_FLAG_CREATE flag, and immediately
 803  * afterward without it.  Then it restores the registry and deletes the folder
 804  * that was created.
 805  * One oddity with respect to restoration: shell32 caches somehow, so it needs
 806  * to be reloaded in order to see the correct (restored) value.
 807  * Some APIs unrelated to the ones under test may fail, but I expect they're
 808  * covered by other unit tests; I just print out something about failure to
 809  * help trace what's going on.
 810  */
 811 static void testNonExistentPath(void)
 812 {
 813     static const char userShellFolders[] =
 814      "Software\\Microsoft\\Windows\\CurrentVersion\\Explorer\\User Shell Folders";
 815     char originalPath[MAX_PATH], modifiedPath[MAX_PATH];
 816     HKEY key;
 817
 818     if (!pSHGetFolderPathA) return;
 819     if (!pSHGetFolderLocation) return;
 820     if (!pSHGetSpecialFolderPathA) return;
 821     if (!pSHGetSpecialFolderLocation) return;
 822     if (!pSHFileOperationA) return;
 823     if (shellVersion.dwMajorVersion < 5) return;
 824
 825     if (!RegOpenKeyExA(HKEY_CURRENT_USER, userShellFolders, 0, KEY_ALL_ACCESS,
 826      &key))
 827     {
 828         DWORD len, type;
 829
 830         len = sizeof(originalPath);
 831         if (!RegQueryValueExA(key, "Favorites", NULL, &type,
 832          (LPBYTE)&originalPath, &len))
 833         {
 834             size_t len = strlen(originalPath);
 835
 836             memcpy(modifiedPath, originalPath, len);
 837             modifiedPath[len++] = '2';
 838             modifiedPath[len++] = '\0';
 839             if (winetest_interactive)
 840                 printf("Changing CSIDL_FAVORITES to %s\n", modifiedPath);
 841             if (!RegSetValueExA(key, "Favorites", 0, type,
 842              (LPBYTE)modifiedPath, len))
 843             {
 844                 char buffer[MAX_PATH+20];
 845                 STARTUPINFOA startup;
 846                 PROCESS_INFORMATION info;
 847                 HRESULT hr;
 848
 849                 sprintf(buffer, "%s tests/shellpath.c 1", selfname);
 850                 memset(&startup, 0, sizeof(startup));
 851                 startup.cb = sizeof(startup);
 852                 startup.dwFlags = STARTF_USESHOWWINDOW;
 853                 startup.dwFlags = SW_SHOWNORMAL;
 854                 CreateProcessA(NULL, buffer, NULL, NULL, FALSE, 0L, NULL, NULL,
 855                  &startup, &info);
 856                 winetest_wait_child_process( info.hProcess );
 857
 858                 /* Query the path to be able to delete it below */
 859                 hr = pSHGetFolderPathA(NULL, CSIDL_FAVORITES, NULL,
 860                  SHGFP_TYPE_CURRENT, modifiedPath);
 861                 ok(SUCCEEDED(hr), "SHGetFolderPathA failed: 0x%08x\n", hr);
 862
 863                 /* restore original values: */
 864                 if (winetest_interactive)
 865                     printf("Restoring CSIDL_FAVORITES to %s\n", originalPath);
 866                 RegSetValueExA(key, "Favorites", 0, type, (LPBYTE) originalPath,
 867                  strlen(originalPath) + 1);
 868                 RegFlushKey(key);
 869
 870                 sprintf(buffer, "%s tests/shellpath.c 2", selfname);
 871                 memset(&startup, 0, sizeof(startup));
 872                 startup.cb = sizeof(startup);
 873                 startup.dwFlags = STARTF_USESHOWWINDOW;
 874                 startup.dwFlags = SW_SHOWNORMAL;
 875                 CreateProcessA(NULL, buffer, NULL, NULL, FALSE, 0L, NULL, NULL,
 876                  &startup, &info);
 877                 ok(WaitForSingleObject(info.hProcess, 30000) == WAIT_OBJECT_0,
 878                  "child process termination\n");
 879
 880                 strcpy(buffer, modifiedPath);
 881                 strcat(buffer, "\\desktop.ini");
 882                 DeleteFileA(buffer);
 883                 RemoveDirectoryA(modifiedPath);
 884             }
 885         }
 886         else if (winetest_interactive)
 887             printf("RegQueryValueExA(key, Favorites, ...) failed\n");
 888         if (key)
 889             RegCloseKey(key);
 890     }
 891     else if (winetest_interactive)
 892         printf("RegOpenKeyExA(HKEY_CURRENT_USER, %s, ...) failed\n",
 893          userShellFolders);
 894 }
 895
 896 START_TEST(shellpath)
 897 {
 898     if (!init()) return;
 899
 900     loadShell32();
 901
 902     if (myARGC >= 3)
 903         doChild(myARGV[2]);
 904     else
 905     {
 906         /* Report missing functions once */
 907         if (!pSHGetFolderLocation)
 908             skip("SHGetFolderLocation is not available\n");
 909
 910         /* first test various combinations of parameters: */
 911         testApiParameters();
 912
 913         /* check known values: */
 914         testPidlTypes();
 915         testGUIDs();
 916         testEnvVars();
 917         testWinDir();
 918         testSystemDir();
 919         testNonExistentPath();
 920     }
 921 }