2 * Unit tests for shell32 SHGet{Special}Folder{Path|Location} functions.
4 * Copyright 2004 Juan Lang
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.
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.
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).
24 * - Need to verify on more systems.
36 #include "wine/test.h"
38 /* CSIDL_MYDOCUMENTS is now the same as CSIDL_PERSONAL, but what we want
39 * here is its original value.
41 #define OLD_CSIDL_MYDOCUMENTS 0x000c
44 #define ARRAY_SIZE(x) ( sizeof(x) / sizeof((x)[0]) )
47 /* from pidl.h, not included here: */
49 #define PT_GUID 0x1f /* no path */
52 #define PT_DRIVE 0x23 /* has path */
55 #define PT_DRIVE2 0x25 /* has path */
58 #define PT_SHELLEXT 0x2e /* no path */
61 #define PT_FOLDER 0x31 /* has path */
64 #define PT_WORKGRP 0x41 /* no path */
67 #define PT_YAGUID 0x70 /* no path */
69 /* FIXME: this is used for history/favorites folders; what's a better name? */
71 #define PT_IESPECIAL2 0xb1 /* has path */
74 static GUID CLSID_CommonDocuments = { 0x0000000c, 0x0000, 0x0000, { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x74, 0x1a } };
76 struct shellExpectedValues {
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,
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 },
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 },
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 },
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 },
158 static void loadShell32(void)
160 HMODULE hShell32 = GetModuleHandleA("shell32");
162 #define GET_PROC(func) \
163 p ## func = (void*)GetProcAddress(hShell32, #func); \
165 trace("GetProcAddress(%s) failed\n", #func);
167 GET_PROC(DllGetVersion)
168 GET_PROC(SHGetFolderPathA)
169 GET_PROC(SHGetFolderLocation)
170 GET_PROC(SHGetSpecialFolderPathA)
171 GET_PROC(SHGetSpecialFolderLocation)
172 GET_PROC(ILFindLastID)
174 pILFindLastID = (void *)GetProcAddress(hShell32, (LPCSTR)16);
175 GET_PROC(SHFileOperationA)
176 GET_PROC(SHGetMalloc)
178 ok(pSHGetMalloc != NULL, "shell32 is missing SHGetMalloc\n");
181 HRESULT hr = pSHGetMalloc(&pMalloc);
183 ok(SUCCEEDED(hr), "SHGetMalloc failed: 0x%08x\n", hr);
184 ok(pMalloc != NULL, "SHGetMalloc returned a NULL IMalloc\n");
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);
198 #ifndef CSIDL_PROFILES
199 #define CSIDL_PROFILES 0x003e
202 /* A couple utility printing functions */
203 static const char *getFolderName(int folder)
205 static char unknown[32];
207 #define CSIDL_TO_STR(x) case x: return#x;
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);
270 sprintf(unknown, "unknown (0x%04x)", folder);
275 static const char *printGUID(const GUID *guid)
277 static char guidSTR[39];
279 if (!guid) return NULL;
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]);
288 static void testSHGetFolderLocationInvalidArgs(void)
293 if (!pSHGetFolderLocation) return;
295 /* check a bogus CSIDL: */
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);
301 IMalloc_Free(pMalloc, pidl);
302 /* check a bogus user token: */
304 hr = pSHGetFolderLocation(NULL, CSIDL_FAVORITES, (HANDLE)2, 0, &pidl);
306 "SHGetFolderLocation(NULL, CSIDL_FAVORITES, 2, 0, &pidl) returned 0x%08x, expected E_FAIL\n", hr);
308 IMalloc_Free(pMalloc, pidl);
309 /* check reserved is not zero: */
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);
315 IMalloc_Free(pMalloc, pidl);
316 /* a NULL pidl pointer crashes, so don't test it */
319 static void testSHGetSpecialFolderLocationInvalidArgs(void)
321 LPITEMIDLIST pidl = NULL;
324 if (!pSHGetSpecialFolderLocation) return;
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);
333 static void testSHGetFolderPathInvalidArgs(void)
338 if (!pSHGetFolderPathA) return;
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);
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);
350 static void testSHGetSpecialFolderPathInvalidArgs(void)
355 if (!pSHGetSpecialFolderPathA) return;
358 ret = pSHGetSpecialFolderPathA(NULL, NULL, CSIDL_BITBUCKET, FALSE);
360 "SHGetSpecialFolderPathA(NULL, NULL, CSIDL_BITBUCKET, FALSE) returned TRUE, expected FALSE\n");
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.
365 ret = pSHGetSpecialFolderPathA(NULL, path, CSIDL_PROGRAMS, FALSE);
367 "SHGetSpecialFolderPathA(NULL, path, CSIDL_PROGRAMS, FALSE) returned FALSE, expected TRUE\n");
368 ret = pSHGetSpecialFolderPathA(NULL, path, 0xeeee, FALSE);
370 "SHGetSpecialFolderPathA(NULL, path, 0xeeee, FALSE) returned TRUE, expected FALSE\n");
373 static void testApiParameters(void)
375 testSHGetFolderLocationInvalidArgs();
376 testSHGetSpecialFolderLocationInvalidArgs();
377 testSHGetFolderPathInvalidArgs();
378 testSHGetSpecialFolderPathInvalidArgs();
381 /* Returns the folder's PIDL type, or 0xff if one can't be found. */
382 static BYTE testSHGetFolderLocation(BOOL optional, int folder)
388 /* treat absence of function as success */
389 if (!pSHGetFolderLocation) return TRUE;
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);
398 "SHGetFolderLocation(NULL, %s, NULL, 0, &pidl) succeeded, but returned pidl is NULL\n", getFolderName(folder));
401 LPITEMIDLIST pidlLast = pILFindLastID(pidl);
403 ok(pidlLast != NULL, "%s: ILFindLastID failed\n",
404 getFolderName(folder));
406 ret = pidlLast->mkid.abID[0];
407 IMalloc_Free(pMalloc, pidl);
413 /* Returns the folder's PIDL type, or 0xff if one can't be found. */
414 static BYTE testSHGetSpecialFolderLocation(BOOL optional, int folder)
420 /* treat absence of function as success */
421 if (!pSHGetSpecialFolderLocation) return TRUE;
424 hr = pSHGetSpecialFolderLocation(NULL, folder, &pidl);
425 ok(SUCCEEDED(hr) || optional,
426 "SHGetSpecialFolderLocation(NULL, %s, &pidl) failed: 0x%08x\n", getFolderName(folder), hr);
430 "SHGetSpecialFolderLocation(NULL, %s, &pidl) succeeded, but returned pidl is NULL\n", getFolderName(folder));
433 LPITEMIDLIST pidlLast = pILFindLastID(pidl);
436 "%s: ILFindLastID failed\n", getFolderName(folder));
438 ret = pidlLast->mkid.abID[0];
439 IMalloc_Free(pMalloc, pidl);
445 static void testSHGetFolderPath(BOOL optional, int folder)
450 if (!pSHGetFolderPathA) return;
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);
457 static void testSHGetSpecialFolderPath(BOOL optional, int folder)
462 if (!pSHGetSpecialFolderPathA) return;
464 ret = pSHGetSpecialFolderPathA(NULL, path, folder, FALSE);
465 if (ret && winetest_interactive)
466 printf("%s: %s\n", getFolderName(folder), path);
468 "SHGetSpecialFolderPathA(NULL, path, %s, FALSE) failed\n",
469 getFolderName(folder));
472 static void testShellValues(const struct shellExpectedValues testEntries[],
473 int numEntries, BOOL optional)
477 for (i = 0; i < numEntries; i++)
481 if (pSHGetFolderLocation)
483 type = testSHGetFolderLocation(optional, testEntries[i].folder);
484 ok(type == testEntries[i].pidlType || optional,
485 "%s has type %d (0x%02x), expected %d (0x%02x)\n",
486 getFolderName(testEntries[i].folder), type, type,
487 testEntries[i].pidlType, testEntries[i].pidlType);
489 type = testSHGetSpecialFolderLocation(optional, testEntries[i].folder);
490 ok(type == testEntries[i].pidlType || optional,
491 "%s has type %d (0x%02x), expected %d (0x%02x)\n",
492 getFolderName(testEntries[i].folder), type, type,
493 testEntries[i].pidlType, testEntries[i].pidlType);
500 testSHGetFolderPath(optional, testEntries[i].folder);
501 testSHGetSpecialFolderPath(optional, testEntries[i].folder);
507 /* Attempts to verify that the folder path corresponding to the folder CSIDL
508 * value has the same value as the environment variable with name envVar.
509 * Doesn't mind if SHGetSpecialFolderPath fails for folder or if envVar isn't
510 * set in this environment; different OS and shell version behave differently.
511 * However, if both are present, fails if envVar's value is not the same
512 * (byte-for-byte) as what SHGetSpecialFolderPath returns.
514 static void matchSpecialFolderPathToEnv(int folder, const char *envVar)
518 if (!pSHGetSpecialFolderPathA) return;
520 if (pSHGetSpecialFolderPathA(NULL, path, folder, FALSE))
522 char *envVal = getenv(envVar);
524 ok(!envVal || !lstrcmpiA(envVal, path),
525 "%%%s%% does not match SHGetSpecialFolderPath:\n"
526 "%%%s%% is %s\nSHGetSpecialFolderPath returns %s\n",
527 envVar, envVar, envVal, path);
531 /* Attempts to match the GUID returned by SHGetFolderLocation for folder with
532 * GUID. Assumes the type of the returned PIDL is in fact a GUID, but doesn't
533 * fail if it isn't--that check should already have been done.
534 * Fails if the returned PIDL is a GUID whose value does not match guid.
536 static void matchGUID(int folder, const GUID *guid)
541 if (!pSHGetFolderLocation) return;
545 hr = pSHGetFolderLocation(NULL, folder, NULL, 0, &pidl);
548 LPITEMIDLIST pidlLast = pILFindLastID(pidl);
550 if (pidlLast && (pidlLast->mkid.abID[0] == PT_SHELLEXT ||
551 pidlLast->mkid.abID[0] == PT_GUID))
553 GUID *shellGuid = (GUID *)(pidlLast->mkid.abID + 2);
555 ok(IsEqualIID(shellGuid, guid),
556 "%s: got GUID %s, expected %s\n", getFolderName(folder),
557 printGUID(shellGuid), printGUID(guid));
559 IMalloc_Free(pMalloc, pidl);
563 static void testDesktop(void)
565 testSHGetFolderPath(FALSE, CSIDL_DESKTOP);
566 testSHGetSpecialFolderPath(FALSE, CSIDL_DESKTOP);
567 /* Test the desktop; even though SHITEMID should always contain abID of at
568 * least one type, when cb is 0 its value is undefined. So don't check
569 * what the returned type is, just make sure it exists.
571 testSHGetFolderLocation(FALSE, CSIDL_DESKTOP);
572 testSHGetSpecialFolderLocation(FALSE, CSIDL_DESKTOP);
575 static void testPersonal(void)
579 /* The pidl may be a real folder, or a virtual directory, or a drive if the
580 * home directory is set to the root directory of a drive.
582 if (pSHGetFolderLocation)
584 type = testSHGetFolderLocation(FALSE, CSIDL_PERSONAL);
585 ok(type == PT_FOLDER || type == PT_GUID || type == PT_DRIVE,
586 "CSIDL_PERSONAL returned invalid type 0x%02x, "
587 "expected PT_FOLDER or PT_GUID\n", type);
588 if (type == PT_FOLDER)
589 testSHGetFolderPath(FALSE, CSIDL_PERSONAL);
591 type = testSHGetSpecialFolderLocation(FALSE, CSIDL_PERSONAL);
592 ok(type == PT_FOLDER || type == PT_GUID || type == PT_DRIVE,
593 "CSIDL_PERSONAL returned invalid type 0x%02x, "
594 "expected PT_FOLDER or PT_GUID\n", type);
595 if (type == PT_FOLDER)
596 testSHGetSpecialFolderPath(FALSE, CSIDL_PERSONAL);
599 /* Checks the PIDL type of all the known values. */
600 static void testPidlTypes(void)
604 testShellValues(requiredShellValues, ARRAY_SIZE(requiredShellValues),
606 testShellValues(optionalShellValues, ARRAY_SIZE(optionalShellValues),
610 /* Verifies various shell virtual folders have the correct well-known GUIDs. */
611 static void testGUIDs(void)
613 matchGUID(CSIDL_BITBUCKET, &CLSID_RecycleBin);
614 matchGUID(CSIDL_CONTROLS, &CLSID_ControlPanel);
615 matchGUID(CSIDL_DRIVES, &CLSID_MyComputer);
616 matchGUID(CSIDL_INTERNET, &CLSID_Internet);
617 matchGUID(CSIDL_NETWORK, &CLSID_NetworkPlaces);
618 matchGUID(CSIDL_PERSONAL, &CLSID_MyDocuments);
619 matchGUID(CSIDL_COMMON_DOCUMENTS, &CLSID_CommonDocuments);
622 /* Verifies various shell paths match the environment variables to which they
625 static void testEnvVars(void)
627 matchSpecialFolderPathToEnv(CSIDL_PROGRAM_FILES, "ProgramFiles");
628 matchSpecialFolderPathToEnv(CSIDL_APPDATA, "APPDATA");
629 matchSpecialFolderPathToEnv(CSIDL_PROFILE, "USERPROFILE");
630 matchSpecialFolderPathToEnv(CSIDL_WINDOWS, "SystemRoot");
631 matchSpecialFolderPathToEnv(CSIDL_WINDOWS, "windir");
632 matchSpecialFolderPathToEnv(CSIDL_PROGRAM_FILES_COMMON,
633 "CommonProgramFiles");
634 /* this is only set on Wine, but can't hurt to verify it: */
635 matchSpecialFolderPathToEnv(CSIDL_SYSTEM, "winsysdir");
638 /* Loosely based on PathRemoveBackslashA from dlls/shlwapi/path.c */
639 static BOOL myPathIsRootA(LPCSTR lpszPath)
641 if (lpszPath && *lpszPath &&
642 lpszPath[1] == ':' && lpszPath[2] == '\\' && lpszPath[3] == '\0')
643 return TRUE; /* X:\ */
646 static LPSTR myPathRemoveBackslashA( LPSTR lpszPath )
652 szTemp = CharPrevA(lpszPath, lpszPath + strlen(lpszPath));
653 if (!myPathIsRootA(lpszPath) && *szTemp == '\\')
659 /* Verifies the shell path for CSIDL_WINDOWS matches the return from
660 * GetWindowsDirectory. If SHGetSpecialFolderPath fails, no harm, no foul--not
661 * every shell32 version supports CSIDL_WINDOWS.
663 static void testWinDir(void)
665 char windowsShellPath[MAX_PATH], windowsDir[MAX_PATH] = { 0 };
667 if (!pSHGetSpecialFolderPathA) return;
669 if (pSHGetSpecialFolderPathA(NULL, windowsShellPath, CSIDL_WINDOWS, FALSE))
671 myPathRemoveBackslashA(windowsShellPath);
672 GetWindowsDirectoryA(windowsDir, sizeof(windowsDir));
673 myPathRemoveBackslashA(windowsDir);
674 ok(!lstrcmpiA(windowsDir, windowsShellPath),
675 "GetWindowsDirectory returns %s SHGetSpecialFolderPath returns %s\n",
676 windowsDir, windowsShellPath);
680 /* Verifies the shell path for CSIDL_SYSTEM and CSIDL_SYSTEMX86 matches the
681 * return from GetSystemDirectory. If SHGetSpecialFolderPath fails, no harm,
682 * no foul--not every shell32 version supports CSIDL_SYSTEM.
684 static void testSystemDir(void)
686 char systemShellPath[MAX_PATH], systemDir[MAX_PATH] = { 0 };
688 if (!pSHGetSpecialFolderPathA) return;
690 GetSystemDirectoryA(systemDir, sizeof(systemDir));
691 myPathRemoveBackslashA(systemDir);
692 if (pSHGetSpecialFolderPathA(NULL, systemShellPath, CSIDL_SYSTEM, FALSE))
694 myPathRemoveBackslashA(systemShellPath);
695 ok(!lstrcmpiA(systemDir, systemShellPath),
696 "GetSystemDirectory returns %s SHGetSpecialFolderPath returns %s\n",
697 systemDir, systemShellPath);
699 /* check CSIDL_SYSTEMX86; note that this isn't always present, so don't
702 if (pSHGetSpecialFolderPathA(NULL, systemShellPath, CSIDL_SYSTEMX86, FALSE))
704 myPathRemoveBackslashA(systemShellPath);
705 ok(!lstrcmpiA(systemDir, systemShellPath),
706 "GetSystemDirectory returns %s SHGetSpecialFolderPath returns %s\n",
707 systemDir, systemShellPath);
711 /* Globals used by subprocesses */
713 static char **myARGV;
714 static char base[MAX_PATH];
715 static char selfname[MAX_PATH];
717 static int init(void)
719 myARGC = winetest_get_mainargs(&myARGV);
720 if (!GetCurrentDirectoryA(sizeof(base), base)) return 0;
721 strcpy(selfname, myARGV[0]);
725 /* Subprocess helper 1: test what happens when CSIDL_FAVORITES is set to a
726 * nonexistent directory.
728 static void testNonExistentPath1(void)
734 /* test some failure cases first: */
735 hr = pSHGetFolderPathA(NULL, CSIDL_FAVORITES, NULL,
736 SHGFP_TYPE_CURRENT, path);
737 ok(hr == HRESULT_FROM_WIN32(ERROR_FILE_NOT_FOUND),
738 "SHGetFolderPath returned 0x%08x, expected 0x80070002\n", hr);
740 hr = pSHGetFolderLocation(NULL, CSIDL_FAVORITES, NULL, 0,
743 "SHGetFolderLocation returned 0x%08x, expected E_FAIL\n", hr);
744 if (SUCCEEDED(hr) && pidl)
745 IMalloc_Free(pMalloc, pidl);
746 ok(!pSHGetSpecialFolderPathA(NULL, path, CSIDL_FAVORITES, FALSE),
747 "SHGetSpecialFolderPath succeeded, expected failure\n");
749 hr = pSHGetSpecialFolderLocation(NULL, CSIDL_FAVORITES, &pidl);
750 ok(hr == E_FAIL, "SHGetFolderLocation returned 0x%08x, expected E_FAIL\n",
752 if (SUCCEEDED(hr) && pidl)
753 IMalloc_Free(pMalloc, pidl);
754 /* now test success: */
755 hr = pSHGetFolderPathA(NULL, CSIDL_FAVORITES | CSIDL_FLAG_CREATE, NULL,
756 SHGFP_TYPE_CURRENT, path);
761 if (winetest_interactive)
762 printf("CSIDL_FAVORITES was changed to %s\n", path);
763 ret = CreateDirectoryA(path, NULL);
765 "CreateDirectoryA succeeded but should have failed "
766 "with ERROR_ALREADY_EXISTS\n");
768 ok(GetLastError() == ERROR_ALREADY_EXISTS,
769 "CreateDirectoryA failed with %d, "
770 "expected ERROR_ALREADY_EXISTS\n",
774 "SHGetFolderPath(NULL, CSIDL_FAVORITES | CSIDL_FLAG_CREATE, "
775 "NULL, SHGFP_TYPE_CURRENT, path) failed: 0x%08x\n", hr);
778 /* Subprocess helper 2: make sure SHGetFolderPath still succeeds when the
779 * original value of CSIDL_FAVORITES is restored.
781 static void testNonExistentPath2(void)
786 hr = pSHGetFolderPathA(NULL, CSIDL_FAVORITES | CSIDL_FLAG_CREATE, NULL,
787 SHGFP_TYPE_CURRENT, path);
788 ok(SUCCEEDED(hr), "SHGetFolderPath failed: 0x%08x\n", hr);
791 static void doChild(const char *arg)
794 testNonExistentPath1();
795 else if (arg[0] == '2')
796 testNonExistentPath2();
799 /* Tests the return values from the various shell functions both with and
800 * without the use of the CSIDL_FLAG_CREATE flag. This flag only appeared in
801 * version 5 of the shell, so don't test unless it's at least version 5.
802 * The test reads a value from the registry, modifies it, calls
803 * SHGetFolderPath once with the CSIDL_FLAG_CREATE flag, and immediately
804 * afterward without it. Then it restores the registry and deletes the folder
806 * One oddity with respect to restoration: shell32 caches somehow, so it needs
807 * to be reloaded in order to see the correct (restored) value.
808 * Some APIs unrelated to the ones under test may fail, but I expect they're
809 * covered by other unit tests; I just print out something about failure to
810 * help trace what's going on.
812 static void testNonExistentPath(void)
814 static const char userShellFolders[] =
815 "Software\\Microsoft\\Windows\\CurrentVersion\\Explorer\\User Shell Folders";
816 char originalPath[MAX_PATH], modifiedPath[MAX_PATH];
819 if (!pSHGetFolderPathA) return;
820 if (!pSHGetFolderLocation) return;
821 if (!pSHGetSpecialFolderPathA) return;
822 if (!pSHGetSpecialFolderLocation) return;
823 if (!pSHFileOperationA) return;
824 if (shellVersion.dwMajorVersion < 5) return;
826 if (!RegOpenKeyExA(HKEY_CURRENT_USER, userShellFolders, 0, KEY_ALL_ACCESS,
831 len = sizeof(originalPath);
832 if (!RegQueryValueExA(key, "Favorites", NULL, &type,
833 (LPBYTE)&originalPath, &len))
835 size_t len = strlen(originalPath);
837 memcpy(modifiedPath, originalPath, len);
838 modifiedPath[len++] = '2';
839 modifiedPath[len++] = '\0';
840 if (winetest_interactive)
841 printf("Changing CSIDL_FAVORITES to %s\n", modifiedPath);
842 if (!RegSetValueExA(key, "Favorites", 0, type,
843 (LPBYTE)modifiedPath, len))
845 char buffer[MAX_PATH+20];
846 STARTUPINFOA startup;
847 PROCESS_INFORMATION info;
850 sprintf(buffer, "%s tests/shellpath.c 1", selfname);
851 memset(&startup, 0, sizeof(startup));
852 startup.cb = sizeof(startup);
853 startup.dwFlags = STARTF_USESHOWWINDOW;
854 startup.dwFlags = SW_SHOWNORMAL;
855 CreateProcessA(NULL, buffer, NULL, NULL, FALSE, 0L, NULL, NULL,
857 winetest_wait_child_process( info.hProcess );
859 /* Query the path to be able to delete it below */
860 hr = pSHGetFolderPathA(NULL, CSIDL_FAVORITES, NULL,
861 SHGFP_TYPE_CURRENT, modifiedPath);
862 ok(SUCCEEDED(hr), "SHGetFolderPathA failed: 0x%08x\n", hr);
864 /* restore original values: */
865 if (winetest_interactive)
866 printf("Restoring CSIDL_FAVORITES to %s\n", originalPath);
867 RegSetValueExA(key, "Favorites", 0, type, (LPBYTE) originalPath,
868 strlen(originalPath) + 1);
871 sprintf(buffer, "%s tests/shellpath.c 2", selfname);
872 memset(&startup, 0, sizeof(startup));
873 startup.cb = sizeof(startup);
874 startup.dwFlags = STARTF_USESHOWWINDOW;
875 startup.dwFlags = SW_SHOWNORMAL;
876 CreateProcessA(NULL, buffer, NULL, NULL, FALSE, 0L, NULL, NULL,
878 ok(WaitForSingleObject(info.hProcess, 30000) == WAIT_OBJECT_0,
879 "child process termination\n");
881 strcpy(buffer, modifiedPath);
882 strcat(buffer, "\\desktop.ini");
884 RemoveDirectoryA(modifiedPath);
887 else if (winetest_interactive)
888 printf("RegQueryValueExA(key, Favorites, ...) failed\n");
892 else if (winetest_interactive)
893 printf("RegOpenKeyExA(HKEY_CURRENT_USER, %s, ...) failed\n",
897 START_TEST(shellpath)
907 /* Report missing functions once */
908 if (!pSHGetFolderLocation)
909 skip("SHGetFolderLocation is not available\n");
911 /* first test various combinations of parameters: */
914 /* check known values: */
920 testNonExistentPath();