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 filesytem 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)
 276 {
 277     static char guidSTR[39];
 278
 279     if (!guid) return NULL;
 280
 281     sprintf(guidSTR, "{%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x}",
 282      guid->Data1, guid->Data2, guid->Data3,
 283      guid->Data4[0], guid->Data4[1], guid->Data4[2], guid->Data4[3],
 284      guid->Data4[4], guid->Data4[5], guid->Data4[6], guid->Data4[7]);
 285     return guidSTR;
 286 }
 287
 288 static void testSHGetFolderLocationInvalidArgs(void)
 289 {
 290     LPITEMIDLIST pidl;
 291     HRESULT hr;
 292
 293     if (!pSHGetFolderLocation) return;
 294
 295     /* check a bogus CSIDL: */
 296     pidl = NULL;
 297     hr = pSHGetFolderLocation(NULL, 0xeeee, NULL, 0, &pidl);
 298     ok(hr == E_INVALIDARG,
 299      "SHGetFolderLocation(NULL, 0xeeee, NULL, 0, &pidl) returned 0x%08x, expected E_INVALIDARG\n", hr);
 300     if (SUCCEEDED(hr))
 301         IMalloc_Free(pMalloc, pidl);
 302     /* check a bogus user token: */
 303     pidl = NULL;
 304     hr = pSHGetFolderLocation(NULL, CSIDL_FAVORITES, (HANDLE)2, 0, &pidl);
 305     ok(hr == E_FAIL,
 306      "SHGetFolderLocation(NULL, CSIDL_FAVORITES, 2, 0, &pidl) returned 0x%08x, expected E_FAIL\n", hr);
 307     if (SUCCEEDED(hr))
 308         IMalloc_Free(pMalloc, pidl);
 309     /* check reserved is not zero: */
 310     pidl = NULL;
 311     hr = pSHGetFolderLocation(NULL, CSIDL_DESKTOP, NULL, 1, &pidl);
 312     ok(hr == E_INVALIDARG,
 313      "SHGetFolderLocation(NULL, CSIDL_DESKTOP, NULL, 1, &pidl) returned 0x%08x, expected E_INVALIDARG\n", hr);
 314     if (SUCCEEDED(hr))
 315         IMalloc_Free(pMalloc, pidl);
 316     /* a NULL pidl pointer crashes, so don't test it */
 317 }
 318
 319 static void testSHGetSpecialFolderLocationInvalidArgs(void)
 320 {
 321     LPITEMIDLIST pidl = NULL;
 322     HRESULT hr;
 323
 324     if (!pSHGetSpecialFolderLocation) return;
 325
 326     /* SHGetSpecialFolderLocation(NULL, 0, NULL) crashes */
 327     hr = pSHGetSpecialFolderLocation(NULL, 0xeeee, &pidl);
 328     ok(hr == E_INVALIDARG,
 329      "SHGetSpecialFolderLocation(NULL, 0xeeee, &pidl) returned 0x%08x, "
 330      "expected E_INVALIDARG\n", hr);
 331 }
 332
 333 static void testSHGetFolderPathInvalidArgs(void)
 334 {
 335     char path[MAX_PATH];
 336     HRESULT hr;
 337
 338     if (!pSHGetFolderPathA) return;
 339
 340     /* expect 2's a bogus handle, especially since we didn't open it */
 341     hr = pSHGetFolderPathA(NULL, CSIDL_DESKTOP, (HANDLE)2,
 342      SHGFP_TYPE_DEFAULT, path);
 343     ok(hr == E_FAIL,
 344      "SHGetFolderPathA(NULL, CSIDL_DESKTOP, 2, SHGFP_TYPE_DEFAULT, path) returned 0x%08x, expected E_FAIL\n", hr);
 345     hr = pSHGetFolderPathA(NULL, 0xeeee, NULL, SHGFP_TYPE_DEFAULT, path);
 346     ok(hr == E_INVALIDARG,
 347      "SHGetFolderPathA(NULL, 0xeeee, NULL, SHGFP_TYPE_DEFAULT, path) returned 0x%08x, expected E_INVALIDARG\n", hr);
 348 }
 349
 350 static void testSHGetSpecialFolderPathInvalidArgs(void)
 351 {
 352     char path[MAX_PATH];
 353     BOOL ret;
 354
 355     if (!pSHGetSpecialFolderPathA) return;
 356
 357 #if 0
 358     ret = pSHGetSpecialFolderPathA(NULL, NULL, CSIDL_BITBUCKET, FALSE);
 359     ok(!ret,
 360      "SHGetSpecialFolderPathA(NULL, NULL, CSIDL_BITBUCKET, FALSE) returned TRUE, expected FALSE\n");
 361 #endif
 362     /* odd but true: calling with a NULL path still succeeds if it's a real
 363      * dir (on some windows platform).  on winME it generates exception.
 364      */
 365     ret = pSHGetSpecialFolderPathA(NULL, path, CSIDL_PROGRAMS, FALSE);
 366     ok(ret,
 367      "SHGetSpecialFolderPathA(NULL, path, CSIDL_PROGRAMS, FALSE) returned FALSE, expected TRUE\n");
 368     ret = pSHGetSpecialFolderPathA(NULL, path, 0xeeee, FALSE);
 369     ok(!ret,
 370      "SHGetSpecialFolderPathA(NULL, path, 0xeeee, FALSE) returned TRUE, expected FALSE\n");
 371 }
 372
 373 static void testApiParameters(void)
 374 {
 375     testSHGetFolderLocationInvalidArgs();
 376     testSHGetSpecialFolderLocationInvalidArgs();
 377     testSHGetFolderPathInvalidArgs();
 378     testSHGetSpecialFolderPathInvalidArgs();
 379 }
 380
 381 /* Returns the folder's PIDL type, or 0xff if one can't be found. */
 382 static BYTE testSHGetFolderLocation(BOOL optional, int folder)
 383 {
 384     LPITEMIDLIST pidl;
 385     HRESULT hr;
 386     BYTE ret = 0xff;
 387
 388     /* treat absence of function as success */
 389     if (!pSHGetFolderLocation) return TRUE;
 390
 391     pidl = NULL;
 392     hr = pSHGetFolderLocation(NULL, folder, NULL, 0, &pidl);
 393     ok(SUCCEEDED(hr) || optional,
 394      "SHGetFolderLocation(NULL, %s, NULL, 0, &pidl) failed: 0x%08x\n", getFolderName(folder), hr);
 395     if (SUCCEEDED(hr))
 396     {
 397         ok(pidl != NULL,
 398          "SHGetFolderLocation(NULL, %s, NULL, 0, &pidl) succeeded, but returned pidl is NULL\n", getFolderName(folder));
 399         if (pidl)
 400         {
 401             LPITEMIDLIST pidlLast = pILFindLastID(pidl);
 402
 403             ok(pidlLast != NULL, "%s: ILFindLastID failed\n",
 404              getFolderName(folder));
 405             if (pidlLast)
 406                 ret = pidlLast->mkid.abID[0];
 407             IMalloc_Free(pMalloc, pidl);
 408         }
 409     }
 410     return ret;
 411 }
 412
 413 /* Returns the folder's PIDL type, or 0xff if one can't be found. */
 414 static BYTE testSHGetSpecialFolderLocation(BOOL optional, int folder)
 415 {
 416     LPITEMIDLIST pidl;
 417     HRESULT hr;
 418     BYTE ret = 0xff;
 419
 420     /* treat absence of function as success */
 421     if (!pSHGetSpecialFolderLocation) return TRUE;
 422
 423     pidl = NULL;
 424     hr = pSHGetSpecialFolderLocation(NULL, folder, &pidl);
 425     ok(SUCCEEDED(hr) || optional,
 426      "SHGetSpecialFolderLocation(NULL, %s, &pidl) failed: 0x%08x\n", getFolderName(folder), hr);
 427     if (SUCCEEDED(hr))
 428     {
 429         ok(pidl != NULL,
 430          "SHGetSpecialFolderLocation(NULL, %s, &pidl) succeeded, but returned pidl is NULL\n", getFolderName(folder));
 431         if (pidl)
 432         {
 433             LPITEMIDLIST pidlLast = pILFindLastID(pidl);
 434
 435             ok(pidlLast != NULL,
 436                 "%s: ILFindLastID failed\n", getFolderName(folder));
 437             if (pidlLast)
 438                 ret = pidlLast->mkid.abID[0];
 439             IMalloc_Free(pMalloc, pidl);
 440         }
 441     }
 442     return ret;
 443 }
 444
 445 static void testSHGetFolderPath(BOOL optional, int folder)
 446 {
 447     char path[MAX_PATH];
 448     HRESULT hr;
 449
 450     if (!pSHGetFolderPathA) return;
 451
 452     hr = pSHGetFolderPathA(NULL, folder, NULL, SHGFP_TYPE_CURRENT, path);
 453     ok(SUCCEEDED(hr) || optional,
 454      "SHGetFolderPathA(NULL, %s, NULL, SHGFP_TYPE_CURRENT, path) failed: 0x%08x\n", getFolderName(folder), hr);
 455 }
 456
 457 static void testSHGetSpecialFolderPath(BOOL optional, int folder)
 458 {
 459     char path[MAX_PATH];
 460     BOOL ret;
 461
 462     if (!pSHGetSpecialFolderPathA) return;
 463
 464     ret = pSHGetSpecialFolderPathA(NULL, path, folder, FALSE);
 465     if (ret && winetest_interactive)
 466         printf("%s: %s\n", getFolderName(folder), path);
 467     ok(ret || optional,
 468      "SHGetSpecialFolderPathA(NULL, path, %s, FALSE) failed\n",
 469      getFolderName(folder));
 470 }
 471
 472 static void testShellValues(const struct shellExpectedValues testEntries[],
 473  int numEntries, BOOL optional)
 474 {
 475     int i;
 476
 477     for (i = 0; i < numEntries; i++)
 478     {
 479         BYTE type;
 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         type = testSHGetSpecialFolderLocation(optional, testEntries[i].folder);
 487         ok(type == testEntries[i].pidlType || optional,
 488          "%s has type %d (0x%02x), expected %d (0x%02x)\n",
 489          getFolderName(testEntries[i].folder), type, type,
 490          testEntries[i].pidlType, testEntries[i].pidlType);
 491         switch (type)
 492         {
 493             case PT_FOLDER:
 494             case PT_DRIVE:
 495             case PT_DRIVE2:
 496             case PT_IESPECIAL2:
 497                 testSHGetFolderPath(optional, testEntries[i].folder);
 498                 testSHGetSpecialFolderPath(optional, testEntries[i].folder);
 499                 break;
 500         }
 501     }
 502 }
 503
 504 /* Attempts to verify that the folder path corresponding to the folder CSIDL
 505  * value has the same value as the environment variable with name envVar.
 506  * Doesn't mind if SHGetSpecialFolderPath fails for folder or if envVar isn't
 507  * set in this environment; different OS and shell version behave differently.
 508  * However, if both are present, fails if envVar's value is not the same
 509  * (byte-for-byte) as what SHGetSpecialFolderPath returns.
 510  */
 511 static void matchSpecialFolderPathToEnv(int folder, const char *envVar)
 512 {
 513     char path[MAX_PATH];
 514
 515     if (!pSHGetSpecialFolderPathA) return;
 516
 517     if (pSHGetSpecialFolderPathA(NULL, path, folder, FALSE))
 518     {
 519         char *envVal = getenv(envVar);
 520
 521         ok(!envVal || !lstrcmpiA(envVal, path),
 522          "%%%s%% does not match SHGetSpecialFolderPath:\n"
 523          "%%%s%% is %s\nSHGetSpecialFolderPath returns %s\n",
 524          envVar, envVar, envVal, path);
 525     }
 526 }
 527
 528 /* Attempts to match the GUID returned by SHGetFolderLocation for folder with
 529  * GUID.  Assumes the type of the returned PIDL is in fact a GUID, but doesn't
 530  * fail if it isn't--that check should already have been done.
 531  * Fails if the returned PIDL is a GUID whose value does not match guid.
 532  */
 533 static void matchGUID(int folder, const GUID *guid)
 534 {
 535     LPITEMIDLIST pidl;
 536     HRESULT hr;
 537
 538     if (!pSHGetFolderLocation) return;
 539     if (!guid) return;
 540
 541     pidl = NULL;
 542     hr = pSHGetFolderLocation(NULL, folder, NULL, 0, &pidl);
 543     if (SUCCEEDED(hr))
 544     {
 545         LPITEMIDLIST pidlLast = pILFindLastID(pidl);
 546
 547         if (pidlLast && (pidlLast->mkid.abID[0] == PT_SHELLEXT ||
 548          pidlLast->mkid.abID[0] == PT_GUID))
 549         {
 550             GUID *shellGuid = (GUID *)(pidlLast->mkid.abID + 2);
 551
 552             ok(IsEqualIID(shellGuid, guid),
 553              "%s: got GUID %s, expected %s\n", getFolderName(folder),
 554              printGUID(shellGuid), printGUID(guid));
 555         }
 556         IMalloc_Free(pMalloc, pidl);
 557     }
 558 }
 559
 560 static void testDesktop(void)
 561 {
 562     testSHGetFolderPath(FALSE, CSIDL_DESKTOP);
 563     testSHGetSpecialFolderPath(FALSE, CSIDL_DESKTOP);
 564     /* Test the desktop; even though SHITEMID should always contain abID of at
 565      * least one type, when cb is 0 its value is undefined.  So don't check
 566      * what the returned type is, just make sure it exists.
 567      */
 568     testSHGetFolderLocation(FALSE, CSIDL_DESKTOP);
 569     testSHGetSpecialFolderLocation(FALSE, CSIDL_DESKTOP);
 570 }
 571
 572 static void testPersonal(void)
 573 {
 574     BYTE type;
 575
 576     /* The pidl may be a real folder, or a virtual directory, or a drive if the
 577      * home directory is set to the root directory of a drive.
 578      */
 579     type = testSHGetFolderLocation(FALSE, CSIDL_PERSONAL);
 580     ok(type == PT_FOLDER || type == PT_GUID || type == PT_DRIVE,
 581      "CSIDL_PERSONAL returned invalid type 0x%02x, "
 582      "expected PT_FOLDER or PT_GUID\n", type);
 583     if (type == PT_FOLDER)
 584         testSHGetFolderPath(FALSE, CSIDL_PERSONAL);
 585     type = testSHGetSpecialFolderLocation(FALSE, CSIDL_PERSONAL);
 586     ok(type == PT_FOLDER || type == PT_GUID || type == PT_DRIVE,
 587      "CSIDL_PERSONAL returned invalid type 0x%02x, "
 588      "expected PT_FOLDER or PT_GUID\n", type);
 589     if (type == PT_FOLDER)
 590         testSHGetSpecialFolderPath(FALSE, CSIDL_PERSONAL);
 591 }
 592
 593 /* Checks the PIDL type of all the known values. */
 594 static void testPidlTypes(void)
 595 {
 596     testDesktop();
 597     testPersonal();
 598     testShellValues(requiredShellValues, ARRAY_SIZE(requiredShellValues),
 599      FALSE);
 600     testShellValues(optionalShellValues, ARRAY_SIZE(optionalShellValues),
 601      TRUE);
 602 }
 603
 604 /* Verifies various shell virtual folders have the correct well-known GUIDs. */
 605 static void testGUIDs(void)
 606 {
 607     matchGUID(CSIDL_BITBUCKET, &CLSID_RecycleBin);
 608     matchGUID(CSIDL_CONTROLS, &CLSID_ControlPanel);
 609     matchGUID(CSIDL_DRIVES, &CLSID_MyComputer);
 610     matchGUID(CSIDL_INTERNET, &CLSID_Internet);
 611     matchGUID(CSIDL_NETWORK, &CLSID_NetworkPlaces);
 612     matchGUID(CSIDL_PERSONAL, &CLSID_MyDocuments);
 613     matchGUID(CSIDL_COMMON_DOCUMENTS, &CLSID_CommonDocuments);
 614 }
 615
 616 /* Verifies various shell paths match the environment variables to which they
 617  * correspond.
 618  */
 619 static void testEnvVars(void)
 620 {
 621     matchSpecialFolderPathToEnv(CSIDL_PROGRAM_FILES, "ProgramFiles");
 622     matchSpecialFolderPathToEnv(CSIDL_APPDATA, "APPDATA");
 623     matchSpecialFolderPathToEnv(CSIDL_PROFILE, "USERPROFILE");
 624     matchSpecialFolderPathToEnv(CSIDL_WINDOWS, "SystemRoot");
 625     matchSpecialFolderPathToEnv(CSIDL_WINDOWS, "windir");
 626     matchSpecialFolderPathToEnv(CSIDL_PROGRAM_FILES_COMMON,
 627      "CommonProgramFiles");
 628     /* this is only set on Wine, but can't hurt to verify it: */
 629     matchSpecialFolderPathToEnv(CSIDL_SYSTEM, "winsysdir");
 630 }
 631
 632 /* Loosely based on PathRemoveBackslashA from dlls/shlwapi/path.c */
 633 static BOOL myPathIsRootA(LPCSTR lpszPath)
 634 {
 635   if (lpszPath && *lpszPath &&
 636       lpszPath[1] == ':' && lpszPath[2] == '\\' && lpszPath[3] == '\0')
 637       return TRUE; /* X:\ */
 638   return FALSE;
 639 }
 640 static LPSTR myPathRemoveBackslashA( LPSTR lpszPath )
 641 {
 642   LPSTR szTemp = NULL;
 643
 644   if(lpszPath)
 645   {
 646     szTemp = CharPrevA(lpszPath, lpszPath + strlen(lpszPath));
 647     if (!myPathIsRootA(lpszPath) && *szTemp == '\\')
 648       *szTemp = '\0';
 649   }
 650   return szTemp;
 651 }
 652
 653 /* Verifies the shell path for CSIDL_WINDOWS matches the return from
 654  * GetWindowsDirectory.  If SHGetSpecialFolderPath fails, no harm, no foul--not
 655  * every shell32 version supports CSIDL_WINDOWS.
 656  */
 657 static void testWinDir(void)
 658 {
 659     char windowsShellPath[MAX_PATH], windowsDir[MAX_PATH] = { 0 };
 660
 661     if (!pSHGetSpecialFolderPathA) return;
 662
 663     if (pSHGetSpecialFolderPathA(NULL, windowsShellPath, CSIDL_WINDOWS, FALSE))
 664     {
 665         myPathRemoveBackslashA(windowsShellPath);
 666         GetWindowsDirectoryA(windowsDir, sizeof(windowsDir));
 667         myPathRemoveBackslashA(windowsDir);
 668         ok(!lstrcmpiA(windowsDir, windowsShellPath),
 669          "GetWindowsDirectory returns %s SHGetSpecialFolderPath returns %s\n",
 670          windowsDir, windowsShellPath);
 671     }
 672 }
 673
 674 /* Verifies the shell path for CSIDL_SYSTEM and CSIDL_SYSTEMX86 matches the
 675  * return from GetSystemDirectory.  If SHGetSpecialFolderPath fails, no harm,
 676  * no foul--not every shell32 version supports CSIDL_SYSTEM.
 677  */
 678 static void testSystemDir(void)
 679 {
 680     char systemShellPath[MAX_PATH], systemDir[MAX_PATH] = { 0 };
 681
 682     if (!pSHGetSpecialFolderPathA) return;
 683
 684     GetSystemDirectoryA(systemDir, sizeof(systemDir));
 685     myPathRemoveBackslashA(systemDir);
 686     if (pSHGetSpecialFolderPathA(NULL, systemShellPath, CSIDL_SYSTEM, FALSE))
 687     {
 688         myPathRemoveBackslashA(systemShellPath);
 689         ok(!lstrcmpiA(systemDir, systemShellPath),
 690          "GetSystemDirectory returns %s SHGetSpecialFolderPath returns %s\n",
 691          systemDir, systemShellPath);
 692     }
 693     /* check CSIDL_SYSTEMX86; note that this isn't always present, so don't
 694      * worry if it fails
 695      */
 696     if (pSHGetSpecialFolderPathA(NULL, systemShellPath, CSIDL_SYSTEMX86, FALSE))
 697     {
 698         myPathRemoveBackslashA(systemShellPath);
 699         ok(!lstrcmpiA(systemDir, systemShellPath),
 700          "GetSystemDirectory returns %s SHGetSpecialFolderPath returns %s\n",
 701          systemDir, systemShellPath);
 702     }
 703 }
 704
 705 /* Globals used by subprocesses */
 706 static int    myARGC;
 707 static char **myARGV;
 708 static char   base[MAX_PATH];
 709 static char   selfname[MAX_PATH];
 710
 711 static int init(void)
 712 {
 713     myARGC = winetest_get_mainargs(&myARGV);
 714     if (!GetCurrentDirectoryA(sizeof(base), base)) return 0;
 715     strcpy(selfname, myARGV[0]);
 716     return 1;
 717 }
 718
 719 /* Subprocess helper 1: test what happens when CSIDL_FAVORITES is set to a
 720  * nonexistent directory.
 721  */
 722 static void testNonExistentPath1(void)
 723 {
 724     HRESULT hr;
 725     LPITEMIDLIST pidl;
 726     char path[MAX_PATH];
 727
 728     /* test some failure cases first: */
 729     hr = pSHGetFolderPathA(NULL, CSIDL_FAVORITES, NULL,
 730      SHGFP_TYPE_CURRENT, path);
 731     ok(hr == HRESULT_FROM_WIN32(ERROR_FILE_NOT_FOUND),
 732      "SHGetFolderPath returned 0x%08x, expected 0x80070002\n", hr);
 733     pidl = NULL;
 734     hr = pSHGetFolderLocation(NULL, CSIDL_FAVORITES, NULL, 0,
 735      &pidl);
 736     ok(hr == E_FAIL,
 737      "SHGetFolderLocation returned 0x%08x, expected E_FAIL\n", hr);
 738     if (SUCCEEDED(hr) && pidl)
 739         IMalloc_Free(pMalloc, pidl);
 740     ok(!pSHGetSpecialFolderPathA(NULL, path, CSIDL_FAVORITES, FALSE),
 741      "SHGetSpecialFolderPath succeeded, expected failure\n");
 742     pidl = NULL;
 743     hr = pSHGetSpecialFolderLocation(NULL, CSIDL_FAVORITES, &pidl);
 744     ok(hr == E_FAIL, "SHGetFolderLocation returned 0x%08x, expected E_FAIL\n",
 745      hr);
 746     if (SUCCEEDED(hr) && pidl)
 747         IMalloc_Free(pMalloc, pidl);
 748     /* now test success: */
 749     hr = pSHGetFolderPathA(NULL, CSIDL_FAVORITES | CSIDL_FLAG_CREATE, NULL,
 750      SHGFP_TYPE_CURRENT, path);
 751     if (SUCCEEDED(hr))
 752     {
 753         BOOL ret;
 754
 755         if (winetest_interactive)
 756             printf("CSIDL_FAVORITES was changed to %s\n", path);
 757         ret = CreateDirectoryA(path, NULL);
 758         ok(!ret,
 759          "CreateDirectoryA succeeded but should have failed "
 760          "with ERROR_ALREADY_EXISTS\n");
 761         if (!ret)
 762             ok(GetLastError() == ERROR_ALREADY_EXISTS,
 763              "CreateDirectoryA failed with %d, "
 764              "expected ERROR_ALREADY_EXISTS\n",
 765              GetLastError());
 766     }
 767     ok(SUCCEEDED(hr),
 768      "SHGetFolderPath(NULL, CSIDL_FAVORITES | CSIDL_FLAG_CREATE, "
 769      "NULL, SHGFP_TYPE_CURRENT, path) failed: 0x%08x\n", hr);
 770 }
 771
 772 /* Subprocess helper 2: make sure SHGetFolderPath still succeeds when the
 773  * original value of CSIDL_FAVORITES is restored.
 774  */
 775 static void testNonExistentPath2(void)
 776 {
 777     HRESULT hr;
 778     char path[MAX_PATH];
 779
 780     hr = pSHGetFolderPathA(NULL, CSIDL_FAVORITES | CSIDL_FLAG_CREATE, NULL,
 781      SHGFP_TYPE_CURRENT, path);
 782     ok(SUCCEEDED(hr), "SHGetFolderPath failed: 0x%08x\n", hr);
 783 }
 784
 785 static void doChild(const char *arg)
 786 {
 787     if (arg[0] == '1')
 788         testNonExistentPath1();
 789     else if (arg[0] == '2')
 790         testNonExistentPath2();
 791 }
 792
 793 /* Tests the return values from the various shell functions both with and
 794  * without the use of the CSIDL_FLAG_CREATE flag.  This flag only appeared in
 795  * version 5 of the shell, so don't test unless it's at least version 5.
 796  * The test reads a value from the registry, modifies it, calls
 797  * SHGetFolderPath once with the CSIDL_FLAG_CREATE flag, and immediately
 798  * afterward without it.  Then it restores the registry and deletes the folder
 799  * that was created.
 800  * One oddity with respect to restoration: shell32 caches somehow, so it needs
 801  * to be reloaded in order to see the correct (restored) value.
 802  * Some APIs unrelated to the ones under test may fail, but I expect they're
 803  * covered by other unit tests; I just print out something about failure to
 804  * help trace what's going on.
 805  */
 806 static void testNonExistentPath(void)
 807 {
 808     static const char userShellFolders[] =
 809      "Software\\Microsoft\\Windows\\CurrentVersion\\Explorer\\User Shell Folders";
 810     char originalPath[MAX_PATH], modifiedPath[MAX_PATH];
 811     HKEY key;
 812
 813     if (!pSHGetFolderPathA) return;
 814     if (!pSHGetFolderLocation) return;
 815     if (!pSHGetSpecialFolderPathA) return;
 816     if (!pSHGetSpecialFolderLocation) return;
 817     if (!pSHFileOperationA) return;
 818     if (shellVersion.dwMajorVersion < 5) return;
 819
 820     if (!RegOpenKeyExA(HKEY_CURRENT_USER, userShellFolders, 0, KEY_ALL_ACCESS,
 821      &key))
 822     {
 823         DWORD len, type;
 824
 825         len = sizeof(originalPath);
 826         if (!RegQueryValueExA(key, "Favorites", NULL, &type,
 827          (LPBYTE)&originalPath, &len))
 828         {
 829             size_t len = strlen(originalPath);
 830
 831             memcpy(modifiedPath, originalPath, len);
 832             modifiedPath[len++] = '2';
 833             modifiedPath[len++] = '\0';
 834             if (winetest_interactive)
 835                 printf("Changing CSIDL_FAVORITES to %s\n", modifiedPath);
 836             if (!RegSetValueExA(key, "Favorites", 0, type,
 837              (LPBYTE)modifiedPath, len))
 838             {
 839                 char buffer[MAX_PATH+20];
 840                 STARTUPINFOA startup;
 841                 PROCESS_INFORMATION info;
 842                 HRESULT hr;
 843
 844                 sprintf(buffer, "%s tests/shellpath.c 1", selfname);
 845                 memset(&startup, 0, sizeof(startup));
 846                 startup.cb = sizeof(startup);
 847                 startup.dwFlags = STARTF_USESHOWWINDOW;
 848                 startup.dwFlags = SW_SHOWNORMAL;
 849                 CreateProcessA(NULL, buffer, NULL, NULL, FALSE, 0L, NULL, NULL,
 850                  &startup, &info);
 851                 winetest_wait_child_process( info.hProcess );
 852
 853                 /* Query the path to be able to delete it below */
 854                 hr = pSHGetFolderPathA(NULL, CSIDL_FAVORITES, NULL,
 855                  SHGFP_TYPE_CURRENT, modifiedPath);
 856                 ok(SUCCEEDED(hr), "SHGetFolderPathA failed: 0x%08x\n", hr);
 857
 858                 /* restore original values: */
 859                 if (winetest_interactive)
 860                     printf("Restoring CSIDL_FAVORITES to %s\n", originalPath);
 861                 RegSetValueExA(key, "Favorites", 0, type, (LPBYTE) originalPath,
 862                  strlen(originalPath) + 1);
 863                 RegFlushKey(key);
 864
 865                 sprintf(buffer, "%s tests/shellpath.c 2", selfname);
 866                 memset(&startup, 0, sizeof(startup));
 867                 startup.cb = sizeof(startup);
 868                 startup.dwFlags = STARTF_USESHOWWINDOW;
 869                 startup.dwFlags = SW_SHOWNORMAL;
 870                 CreateProcessA(NULL, buffer, NULL, NULL, FALSE, 0L, NULL, NULL,
 871                  &startup, &info);
 872                 ok(WaitForSingleObject(info.hProcess, 30000) == WAIT_OBJECT_0,
 873                  "child process termination\n");
 874
 875                 strcpy(buffer, modifiedPath);
 876                 strcat(buffer, "\\desktop.ini");
 877                 DeleteFileA(buffer);
 878                 RemoveDirectoryA(modifiedPath);
 879             }
 880         }
 881         else if (winetest_interactive)
 882             printf("RegQueryValueExA(key, Favorites, ...) failed\n");
 883         if (key)
 884             RegCloseKey(key);
 885     }
 886     else if (winetest_interactive)
 887         printf("RegOpenKeyExA(HKEY_CURRENT_USER, %s, ...) failed\n",
 888          userShellFolders);
 889 }
 890
 891 START_TEST(shellpath)
 892 {
 893     if (!init()) return;
 894
 895     loadShell32();
 896
 897     if (myARGC >= 3)
 898         doChild(myARGV[2]);
 899     else
 900     {
 901         /* first test various combinations of parameters: */
 902         testApiParameters();
 903
 904         /* check known values: */
 905         testPidlTypes();
 906         testGUIDs();
 907         testEnvVars();
 908         testWinDir();
 909         testSystemDir();
 910         testNonExistentPath();
 911     }
 912 }