Merge commit '1a978cb460194e7f3db4c8d8bf6405411b2f9bcd' into epm
[wine/dcerpc.git] / dlls / shell32 / shellpath.c
blobfb0c309cd9539b05fd5ad769f36a3e6218e46be7
1 /*
2 * Path Functions
4 * Copyright 1998, 1999, 2000 Juergen Schmied
5 * Copyright 2004 Juan Lang
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
21 * NOTES:
23 * Many of these functions are in SHLWAPI.DLL also
27 #include "config.h"
28 #include "wine/port.h"
30 #include <stdio.h>
31 #include <stdarg.h>
32 #include <string.h>
33 #include <ctype.h>
34 #include "wine/debug.h"
35 #include "windef.h"
36 #include "winbase.h"
37 #include "winnls.h"
38 #include "winreg.h"
39 #include "wingdi.h"
40 #include "winuser.h"
42 #include "shlobj.h"
43 #include "shresdef.h"
44 #include "shell32_main.h"
45 #include "undocshell.h"
46 #include "pidl.h"
47 #include "wine/unicode.h"
48 #include "shlwapi.h"
49 #include "xdg.h"
50 #include "sddl.h"
52 WINE_DEFAULT_DEBUG_CHANNEL(shell);
55 ########## Combining and Constructing paths ##########
58 /*************************************************************************
59 * PathAppend [SHELL32.36]
61 BOOL WINAPI PathAppendAW(
62 LPVOID lpszPath1,
63 LPCVOID lpszPath2)
65 if (SHELL_OsIsUnicode())
66 return PathAppendW(lpszPath1, lpszPath2);
67 return PathAppendA(lpszPath1, lpszPath2);
70 /*************************************************************************
71 * PathCombine [SHELL32.37]
73 LPVOID WINAPI PathCombineAW(
74 LPVOID szDest,
75 LPCVOID lpszDir,
76 LPCVOID lpszFile)
78 if (SHELL_OsIsUnicode())
79 return PathCombineW( szDest, lpszDir, lpszFile );
80 return PathCombineA( szDest, lpszDir, lpszFile );
83 /*************************************************************************
84 * PathAddBackslash [SHELL32.32]
86 LPVOID WINAPI PathAddBackslashAW(LPVOID lpszPath)
88 if(SHELL_OsIsUnicode())
89 return PathAddBackslashW(lpszPath);
90 return PathAddBackslashA(lpszPath);
93 /*************************************************************************
94 * PathBuildRoot [SHELL32.30]
96 LPVOID WINAPI PathBuildRootAW(LPVOID lpszPath, int drive)
98 if(SHELL_OsIsUnicode())
99 return PathBuildRootW(lpszPath, drive);
100 return PathBuildRootA(lpszPath, drive);
104 Extracting Component Parts
107 /*************************************************************************
108 * PathFindFileName [SHELL32.34]
110 LPVOID WINAPI PathFindFileNameAW(LPCVOID lpszPath)
112 if(SHELL_OsIsUnicode())
113 return PathFindFileNameW(lpszPath);
114 return PathFindFileNameA(lpszPath);
117 /*************************************************************************
118 * PathFindExtension [SHELL32.31]
120 LPVOID WINAPI PathFindExtensionAW(LPCVOID lpszPath)
122 if (SHELL_OsIsUnicode())
123 return PathFindExtensionW(lpszPath);
124 return PathFindExtensionA(lpszPath);
128 /*************************************************************************
129 * PathGetExtensionA [internal]
131 * NOTES
132 * exported by ordinal
133 * return value points to the first char after the dot
135 static LPSTR PathGetExtensionA(LPCSTR lpszPath)
137 TRACE("(%s)\n",lpszPath);
139 lpszPath = PathFindExtensionA(lpszPath);
140 return (LPSTR)(*lpszPath?(lpszPath+1):lpszPath);
143 /*************************************************************************
144 * PathGetExtensionW [internal]
146 static LPWSTR PathGetExtensionW(LPCWSTR lpszPath)
148 TRACE("(%s)\n",debugstr_w(lpszPath));
150 lpszPath = PathFindExtensionW(lpszPath);
151 return (LPWSTR)(*lpszPath?(lpszPath+1):lpszPath);
154 /*************************************************************************
155 * PathGetExtension [SHELL32.158]
157 LPVOID WINAPI PathGetExtensionAW(LPCVOID lpszPath,DWORD void1, DWORD void2)
159 if (SHELL_OsIsUnicode())
160 return PathGetExtensionW(lpszPath);
161 return PathGetExtensionA(lpszPath);
164 /*************************************************************************
165 * PathGetArgs [SHELL32.52]
167 LPVOID WINAPI PathGetArgsAW(LPVOID lpszPath)
169 if (SHELL_OsIsUnicode())
170 return PathGetArgsW(lpszPath);
171 return PathGetArgsA(lpszPath);
174 /*************************************************************************
175 * PathGetDriveNumber [SHELL32.57]
177 int WINAPI PathGetDriveNumberAW(LPVOID lpszPath)
179 if (SHELL_OsIsUnicode())
180 return PathGetDriveNumberW(lpszPath);
181 return PathGetDriveNumberA(lpszPath);
184 /*************************************************************************
185 * PathRemoveFileSpec [SHELL32.35]
187 BOOL WINAPI PathRemoveFileSpecAW(LPVOID lpszPath)
189 if (SHELL_OsIsUnicode())
190 return PathRemoveFileSpecW(lpszPath);
191 return PathRemoveFileSpecA(lpszPath);
194 /*************************************************************************
195 * PathStripPath [SHELL32.38]
197 void WINAPI PathStripPathAW(LPVOID lpszPath)
199 if (SHELL_OsIsUnicode())
200 PathStripPathW(lpszPath);
201 else
202 PathStripPathA(lpszPath);
205 /*************************************************************************
206 * PathStripToRoot [SHELL32.50]
208 BOOL WINAPI PathStripToRootAW(LPVOID lpszPath)
210 if (SHELL_OsIsUnicode())
211 return PathStripToRootW(lpszPath);
212 return PathStripToRootA(lpszPath);
215 /*************************************************************************
216 * PathRemoveArgs [SHELL32.251]
218 void WINAPI PathRemoveArgsAW(LPVOID lpszPath)
220 if (SHELL_OsIsUnicode())
221 PathRemoveArgsW(lpszPath);
222 else
223 PathRemoveArgsA(lpszPath);
226 /*************************************************************************
227 * PathRemoveExtension [SHELL32.250]
229 void WINAPI PathRemoveExtensionAW(LPVOID lpszPath)
231 if (SHELL_OsIsUnicode())
232 PathRemoveExtensionW(lpszPath);
233 else
234 PathRemoveExtensionA(lpszPath);
239 Path Manipulations
242 /*************************************************************************
243 * PathGetShortPathA [internal]
245 static void PathGetShortPathA(LPSTR pszPath)
247 CHAR path[MAX_PATH];
249 TRACE("%s\n", pszPath);
251 if (GetShortPathNameA(pszPath, path, MAX_PATH))
253 lstrcpyA(pszPath, path);
257 /*************************************************************************
258 * PathGetShortPathW [internal]
260 static void PathGetShortPathW(LPWSTR pszPath)
262 WCHAR path[MAX_PATH];
264 TRACE("%s\n", debugstr_w(pszPath));
266 if (GetShortPathNameW(pszPath, path, MAX_PATH))
268 lstrcpyW(pszPath, path);
272 /*************************************************************************
273 * PathGetShortPath [SHELL32.92]
275 VOID WINAPI PathGetShortPathAW(LPVOID pszPath)
277 if(SHELL_OsIsUnicode())
278 PathGetShortPathW(pszPath);
279 PathGetShortPathA(pszPath);
282 /*************************************************************************
283 * PathRemoveBlanks [SHELL32.33]
285 void WINAPI PathRemoveBlanksAW(LPVOID str)
287 if(SHELL_OsIsUnicode())
288 PathRemoveBlanksW(str);
289 else
290 PathRemoveBlanksA(str);
293 /*************************************************************************
294 * PathQuoteSpaces [SHELL32.55]
296 VOID WINAPI PathQuoteSpacesAW (LPVOID lpszPath)
298 if(SHELL_OsIsUnicode())
299 PathQuoteSpacesW(lpszPath);
300 else
301 PathQuoteSpacesA(lpszPath);
304 /*************************************************************************
305 * PathUnquoteSpaces [SHELL32.56]
307 VOID WINAPI PathUnquoteSpacesAW(LPVOID str)
309 if(SHELL_OsIsUnicode())
310 PathUnquoteSpacesW(str);
311 else
312 PathUnquoteSpacesA(str);
315 /*************************************************************************
316 * PathParseIconLocation [SHELL32.249]
318 int WINAPI PathParseIconLocationAW (LPVOID lpszPath)
320 if(SHELL_OsIsUnicode())
321 return PathParseIconLocationW(lpszPath);
322 return PathParseIconLocationA(lpszPath);
326 ########## Path Testing ##########
328 /*************************************************************************
329 * PathIsUNC [SHELL32.39]
331 BOOL WINAPI PathIsUNCAW (LPCVOID lpszPath)
333 if (SHELL_OsIsUnicode())
334 return PathIsUNCW( lpszPath );
335 return PathIsUNCA( lpszPath );
338 /*************************************************************************
339 * PathIsRelative [SHELL32.40]
341 BOOL WINAPI PathIsRelativeAW (LPCVOID lpszPath)
343 if (SHELL_OsIsUnicode())
344 return PathIsRelativeW( lpszPath );
345 return PathIsRelativeA( lpszPath );
348 /*************************************************************************
349 * PathIsRoot [SHELL32.29]
351 BOOL WINAPI PathIsRootAW(LPCVOID lpszPath)
353 if (SHELL_OsIsUnicode())
354 return PathIsRootW(lpszPath);
355 return PathIsRootA(lpszPath);
358 /*************************************************************************
359 * PathIsExeA [internal]
361 static BOOL PathIsExeA (LPCSTR lpszPath)
363 LPCSTR lpszExtension = PathGetExtensionA(lpszPath);
364 int i;
365 static const char * const lpszExtensions[] =
366 {"exe", "com", "pif", "cmd", "bat", "scf", "scr", NULL };
368 TRACE("path=%s\n",lpszPath);
370 for(i=0; lpszExtensions[i]; i++)
371 if (!lstrcmpiA(lpszExtension,lpszExtensions[i])) return TRUE;
373 return FALSE;
376 /*************************************************************************
377 * PathIsExeW [internal]
379 static BOOL PathIsExeW (LPCWSTR lpszPath)
381 LPCWSTR lpszExtension = PathGetExtensionW(lpszPath);
382 int i;
383 static const WCHAR lpszExtensions[][4] =
384 {{'e','x','e','\0'}, {'c','o','m','\0'}, {'p','i','f','\0'},
385 {'c','m','d','\0'}, {'b','a','t','\0'}, {'s','c','f','\0'},
386 {'s','c','r','\0'}, {'\0'} };
388 TRACE("path=%s\n",debugstr_w(lpszPath));
390 for(i=0; lpszExtensions[i][0]; i++)
391 if (!strcmpiW(lpszExtension,lpszExtensions[i])) return TRUE;
393 return FALSE;
396 /*************************************************************************
397 * PathIsExe [SHELL32.43]
399 BOOL WINAPI PathIsExeAW (LPCVOID path)
401 if (SHELL_OsIsUnicode())
402 return PathIsExeW (path);
403 return PathIsExeA(path);
406 /*************************************************************************
407 * PathIsDirectory [SHELL32.159]
409 BOOL WINAPI PathIsDirectoryAW (LPCVOID lpszPath)
411 if (SHELL_OsIsUnicode())
412 return PathIsDirectoryW (lpszPath);
413 return PathIsDirectoryA (lpszPath);
416 /*************************************************************************
417 * PathFileExists [SHELL32.45]
419 BOOL WINAPI PathFileExistsAW (LPCVOID lpszPath)
421 if (SHELL_OsIsUnicode())
422 return PathFileExistsW (lpszPath);
423 return PathFileExistsA (lpszPath);
426 /*************************************************************************
427 * PathMatchSpec [SHELL32.46]
429 BOOL WINAPI PathMatchSpecAW(LPVOID name, LPVOID mask)
431 if (SHELL_OsIsUnicode())
432 return PathMatchSpecW( name, mask );
433 return PathMatchSpecA( name, mask );
436 /*************************************************************************
437 * PathIsSameRoot [SHELL32.650]
439 BOOL WINAPI PathIsSameRootAW(LPCVOID lpszPath1, LPCVOID lpszPath2)
441 if (SHELL_OsIsUnicode())
442 return PathIsSameRootW(lpszPath1, lpszPath2);
443 return PathIsSameRootA(lpszPath1, lpszPath2);
446 /*************************************************************************
447 * IsLFNDriveA [SHELL32.41]
449 BOOL WINAPI IsLFNDriveA(LPCSTR lpszPath)
451 DWORD fnlen;
453 if (!GetVolumeInformationA(lpszPath, NULL, 0, NULL, &fnlen, NULL, NULL, 0))
454 return FALSE;
455 return fnlen > 12;
458 /*************************************************************************
459 * IsLFNDriveW [SHELL32.42]
461 BOOL WINAPI IsLFNDriveW(LPCWSTR lpszPath)
463 DWORD fnlen;
465 if (!GetVolumeInformationW(lpszPath, NULL, 0, NULL, &fnlen, NULL, NULL, 0))
466 return FALSE;
467 return fnlen > 12;
470 /*************************************************************************
471 * IsLFNDrive [SHELL32.119]
473 BOOL WINAPI IsLFNDriveAW(LPCVOID lpszPath)
475 if (SHELL_OsIsUnicode())
476 return IsLFNDriveW(lpszPath);
477 return IsLFNDriveA(lpszPath);
481 ########## Creating Something Unique ##########
483 /*************************************************************************
484 * PathMakeUniqueNameA [internal]
486 BOOL WINAPI PathMakeUniqueNameA(
487 LPSTR lpszBuffer,
488 DWORD dwBuffSize,
489 LPCSTR lpszShortName,
490 LPCSTR lpszLongName,
491 LPCSTR lpszPathName)
493 FIXME("%p %u %s %s %s stub\n",
494 lpszBuffer, dwBuffSize, debugstr_a(lpszShortName),
495 debugstr_a(lpszLongName), debugstr_a(lpszPathName));
496 return TRUE;
499 /*************************************************************************
500 * PathMakeUniqueNameW [internal]
502 BOOL WINAPI PathMakeUniqueNameW(
503 LPWSTR lpszBuffer,
504 DWORD dwBuffSize,
505 LPCWSTR lpszShortName,
506 LPCWSTR lpszLongName,
507 LPCWSTR lpszPathName)
509 FIXME("%p %u %s %s %s stub\n",
510 lpszBuffer, dwBuffSize, debugstr_w(lpszShortName),
511 debugstr_w(lpszLongName), debugstr_w(lpszPathName));
512 return TRUE;
515 /*************************************************************************
516 * PathMakeUniqueName [SHELL32.47]
518 BOOL WINAPI PathMakeUniqueNameAW(
519 LPVOID lpszBuffer,
520 DWORD dwBuffSize,
521 LPCVOID lpszShortName,
522 LPCVOID lpszLongName,
523 LPCVOID lpszPathName)
525 if (SHELL_OsIsUnicode())
526 return PathMakeUniqueNameW(lpszBuffer,dwBuffSize, lpszShortName,lpszLongName,lpszPathName);
527 return PathMakeUniqueNameA(lpszBuffer,dwBuffSize, lpszShortName,lpszLongName,lpszPathName);
530 /*************************************************************************
531 * PathYetAnotherMakeUniqueName [SHELL32.75]
533 * NOTES
534 * exported by ordinal
536 BOOL WINAPI PathYetAnotherMakeUniqueName(
537 LPWSTR lpszBuffer,
538 LPCWSTR lpszPathName,
539 LPCWSTR lpszShortName,
540 LPCWSTR lpszLongName)
542 FIXME("(%p, %s, %s ,%s):stub.\n",
543 lpszBuffer, debugstr_w(lpszPathName), debugstr_w(lpszShortName), debugstr_w(lpszLongName));
544 return TRUE;
549 ########## cleaning and resolving paths ##########
552 /*************************************************************************
553 * PathFindOnPath [SHELL32.145]
555 BOOL WINAPI PathFindOnPathAW(LPVOID sFile, LPCVOID *sOtherDirs)
557 if (SHELL_OsIsUnicode())
558 return PathFindOnPathW(sFile, (LPCWSTR *)sOtherDirs);
559 return PathFindOnPathA(sFile, (LPCSTR *)sOtherDirs);
562 /*************************************************************************
563 * PathCleanupSpec [SHELL32.171]
565 * lpszFile is changed in place.
567 int WINAPI PathCleanupSpec( LPCWSTR lpszPathW, LPWSTR lpszFileW )
569 int i = 0;
570 DWORD rc = 0;
571 int length = 0;
573 if (SHELL_OsIsUnicode())
575 LPWSTR p = lpszFileW;
577 TRACE("Cleanup %s\n",debugstr_w(lpszFileW));
579 if (lpszPathW)
580 length = strlenW(lpszPathW);
582 while (*p)
584 int gct = PathGetCharTypeW(*p);
585 if (gct == GCT_INVALID || gct == GCT_WILD || gct == GCT_SEPARATOR)
587 lpszFileW[i]='-';
588 rc |= PCS_REPLACEDCHAR;
590 else
591 lpszFileW[i]=*p;
592 i++;
593 p++;
594 if (length + i == MAX_PATH)
596 rc |= PCS_FATAL | PCS_PATHTOOLONG;
597 break;
600 lpszFileW[i]=0;
602 else
604 LPSTR lpszFileA = (LPSTR)lpszFileW;
605 LPCSTR lpszPathA = (LPCSTR)lpszPathW;
606 LPSTR p = lpszFileA;
608 TRACE("Cleanup %s\n",debugstr_a(lpszFileA));
610 if (lpszPathA)
611 length = strlen(lpszPathA);
613 while (*p)
615 int gct = PathGetCharTypeA(*p);
616 if (gct == GCT_INVALID || gct == GCT_WILD || gct == GCT_SEPARATOR)
618 lpszFileA[i]='-';
619 rc |= PCS_REPLACEDCHAR;
621 else
622 lpszFileA[i]=*p;
623 i++;
624 p++;
625 if (length + i == MAX_PATH)
627 rc |= PCS_FATAL | PCS_PATHTOOLONG;
628 break;
631 lpszFileA[i]=0;
633 return rc;
636 /*************************************************************************
637 * PathQualifyA [SHELL32]
639 BOOL WINAPI PathQualifyA(LPCSTR pszPath)
641 FIXME("%s\n",pszPath);
642 return 0;
645 /*************************************************************************
646 * PathQualifyW [SHELL32]
648 BOOL WINAPI PathQualifyW(LPCWSTR pszPath)
650 FIXME("%s\n",debugstr_w(pszPath));
651 return 0;
654 /*************************************************************************
655 * PathQualify [SHELL32.49]
657 BOOL WINAPI PathQualifyAW(LPCVOID pszPath)
659 if (SHELL_OsIsUnicode())
660 return PathQualifyW(pszPath);
661 return PathQualifyA(pszPath);
664 /*************************************************************************
665 * PathResolveA [SHELL32.51]
667 BOOL WINAPI PathResolveA(
668 LPSTR lpszPath,
669 LPCSTR *alpszPaths,
670 DWORD dwFlags)
672 FIXME("(%s,%p,0x%08x),stub!\n",
673 lpszPath, *alpszPaths, dwFlags);
674 return 0;
677 /*************************************************************************
678 * PathResolveW [SHELL32]
680 BOOL WINAPI PathResolveW(
681 LPWSTR lpszPath,
682 LPCWSTR *alpszPaths,
683 DWORD dwFlags)
685 FIXME("(%s,%p,0x%08x),stub!\n",
686 debugstr_w(lpszPath), debugstr_w(*alpszPaths), dwFlags);
687 return 0;
690 /*************************************************************************
691 * PathResolve [SHELL32.51]
693 BOOL WINAPI PathResolveAW(
694 LPVOID lpszPath,
695 LPCVOID *alpszPaths,
696 DWORD dwFlags)
698 if (SHELL_OsIsUnicode())
699 return PathResolveW(lpszPath, (LPCWSTR*)alpszPaths, dwFlags);
700 return PathResolveA(lpszPath, (LPCSTR*)alpszPaths, dwFlags);
703 /*************************************************************************
704 * PathProcessCommandA [SHELL32.653]
706 LONG WINAPI PathProcessCommandA (
707 LPCSTR lpszPath,
708 LPSTR lpszBuff,
709 DWORD dwBuffSize,
710 DWORD dwFlags)
712 FIXME("%s %p 0x%04x 0x%04x stub\n",
713 lpszPath, lpszBuff, dwBuffSize, dwFlags);
714 if(!lpszPath) return -1;
715 if(lpszBuff) strcpy(lpszBuff, lpszPath);
716 return strlen(lpszPath);
719 /*************************************************************************
720 * PathProcessCommandW
722 LONG WINAPI PathProcessCommandW (
723 LPCWSTR lpszPath,
724 LPWSTR lpszBuff,
725 DWORD dwBuffSize,
726 DWORD dwFlags)
728 FIXME("(%s, %p, 0x%04x, 0x%04x) stub\n",
729 debugstr_w(lpszPath), lpszBuff, dwBuffSize, dwFlags);
730 if(!lpszPath) return -1;
731 if(lpszBuff) strcpyW(lpszBuff, lpszPath);
732 return strlenW(lpszPath);
735 /*************************************************************************
736 * PathProcessCommand (SHELL32.653)
738 LONG WINAPI PathProcessCommandAW (
739 LPCVOID lpszPath,
740 LPVOID lpszBuff,
741 DWORD dwBuffSize,
742 DWORD dwFlags)
744 if (SHELL_OsIsUnicode())
745 return PathProcessCommandW(lpszPath, lpszBuff, dwBuffSize, dwFlags);
746 return PathProcessCommandA(lpszPath, lpszBuff, dwBuffSize, dwFlags);
750 ########## special ##########
753 /*************************************************************************
754 * PathSetDlgItemPath (SHELL32.48)
756 VOID WINAPI PathSetDlgItemPathAW(HWND hDlg, int id, LPCVOID pszPath)
758 if (SHELL_OsIsUnicode())
759 PathSetDlgItemPathW(hDlg, id, pszPath);
760 else
761 PathSetDlgItemPathA(hDlg, id, pszPath);
764 static const WCHAR szCurrentVersion[] = {'S','o','f','t','w','a','r','e','\\','M','i','c','r','o','s','o','f','t','\\','W','i','n','d','o','w','s','\\','C','u','r','r','e','n','t','V','e','r','s','i','o','n','\0'};
765 static const WCHAR Administrative_ToolsW[] = {'A','d','m','i','n','i','s','t','r','a','t','i','v','e',' ','T','o','o','l','s','\0'};
766 static const WCHAR AppDataW[] = {'A','p','p','D','a','t','a','\0'};
767 static const WCHAR CacheW[] = {'C','a','c','h','e','\0'};
768 static const WCHAR CD_BurningW[] = {'C','D',' ','B','u','r','n','i','n','g','\0'};
769 static const WCHAR Common_Administrative_ToolsW[] = {'C','o','m','m','o','n',' ','A','d','m','i','n','i','s','t','r','a','t','i','v','e',' ','T','o','o','l','s','\0'};
770 static const WCHAR Common_AppDataW[] = {'C','o','m','m','o','n',' ','A','p','p','D','a','t','a','\0'};
771 static const WCHAR Common_DesktopW[] = {'C','o','m','m','o','n',' ','D','e','s','k','t','o','p','\0'};
772 static const WCHAR Common_DocumentsW[] = {'C','o','m','m','o','n',' ','D','o','c','u','m','e','n','t','s','\0'};
773 static const WCHAR CommonFilesDirW[] = {'C','o','m','m','o','n','F','i','l','e','s','D','i','r','\0'};
774 static const WCHAR CommonMusicW[] = {'C','o','m','m','o','n','M','u','s','i','c','\0'};
775 static const WCHAR CommonPicturesW[] = {'C','o','m','m','o','n','P','i','c','t','u','r','e','s','\0'};
776 static const WCHAR Common_ProgramsW[] = {'C','o','m','m','o','n',' ','P','r','o','g','r','a','m','s','\0'};
777 static const WCHAR Common_StartUpW[] = {'C','o','m','m','o','n',' ','S','t','a','r','t','U','p','\0'};
778 static const WCHAR Common_Start_MenuW[] = {'C','o','m','m','o','n',' ','S','t','a','r','t',' ','M','e','n','u','\0'};
779 static const WCHAR Common_TemplatesW[] = {'C','o','m','m','o','n',' ','T','e','m','p','l','a','t','e','s','\0'};
780 static const WCHAR CommonVideoW[] = {'C','o','m','m','o','n','V','i','d','e','o','\0'};
781 static const WCHAR CookiesW[] = {'C','o','o','k','i','e','s','\0'};
782 static const WCHAR DesktopW[] = {'D','e','s','k','t','o','p','\0'};
783 static const WCHAR FavoritesW[] = {'F','a','v','o','r','i','t','e','s','\0'};
784 static const WCHAR FontsW[] = {'F','o','n','t','s','\0'};
785 static const WCHAR HistoryW[] = {'H','i','s','t','o','r','y','\0'};
786 static const WCHAR Local_AppDataW[] = {'L','o','c','a','l',' ','A','p','p','D','a','t','a','\0'};
787 static const WCHAR My_MusicW[] = {'M','y',' ','M','u','s','i','c','\0'};
788 static const WCHAR My_PicturesW[] = {'M','y',' ','P','i','c','t','u','r','e','s','\0'};
789 static const WCHAR My_VideoW[] = {'M','y',' ','V','i','d','e','o','s','\0'};
790 static const WCHAR NetHoodW[] = {'N','e','t','H','o','o','d','\0'};
791 static const WCHAR PersonalW[] = {'P','e','r','s','o','n','a','l','\0'};
792 static const WCHAR PrintHoodW[] = {'P','r','i','n','t','H','o','o','d','\0'};
793 static const WCHAR ProgramFilesDirW[] = {'P','r','o','g','r','a','m','F','i','l','e','s','D','i','r','\0'};
794 static const WCHAR ProgramsW[] = {'P','r','o','g','r','a','m','s','\0'};
795 static const WCHAR RecentW[] = {'R','e','c','e','n','t','\0'};
796 static const WCHAR ResourcesW[] = {'R','e','s','o','u','r','c','e','s','\0'};
797 static const WCHAR SendToW[] = {'S','e','n','d','T','o','\0'};
798 static const WCHAR StartUpW[] = {'S','t','a','r','t','U','p','\0'};
799 static const WCHAR Start_MenuW[] = {'S','t','a','r','t',' ','M','e','n','u','\0'};
800 static const WCHAR TemplatesW[] = {'T','e','m','p','l','a','t','e','s','\0'};
801 static const WCHAR DefaultW[] = {'.','D','e','f','a','u','l','t','\0'};
802 static const WCHAR AllUsersProfileW[] = {'%','A','L','L','U','S','E','R','S','P','R','O','F','I','L','E','%','\0'};
803 static const WCHAR UserProfileW[] = {'%','U','S','E','R','P','R','O','F','I','L','E','%','\0'};
804 static const WCHAR SystemDriveW[] = {'%','S','y','s','t','e','m','D','r','i','v','e','%','\0'};
805 static const WCHAR ProfileListW[] = {'S','o','f','t','w','a','r','e','\\','M','i','c','r','o','s','o','f','t','\\','W','i','n','d','o','w','s',' ','N','T','\\','C','u','r','r','e','n','t','V','e','r','s','i','o','n','\\','P','r','o','f','i','l','e','L','i','s','t',0};
806 static const WCHAR ProfilesDirectoryW[] = {'P','r','o','f','i','l','e','s','D','i','r','e','c','t','o','r','y',0};
807 static const WCHAR AllUsersProfileValueW[] = {'A','l','l','U','s','e','r','s','P','r','o','f','i','l','e','\0'};
808 static const WCHAR szSHFolders[] = {'S','o','f','t','w','a','r','e','\\','M','i','c','r','o','s','o','f','t','\\','W','i','n','d','o','w','s','\\','C','u','r','r','e','n','t','V','e','r','s','i','o','n','\\','E','x','p','l','o','r','e','r','\\','S','h','e','l','l',' ','F','o','l','d','e','r','s','\0'};
809 static const WCHAR szSHUserFolders[] = {'S','o','f','t','w','a','r','e','\\','M','i','c','r','o','s','o','f','t','\\','W','i','n','d','o','w','s','\\','C','u','r','r','e','n','t','V','e','r','s','i','o','n','\\','E','x','p','l','o','r','e','r','\\','U','s','e','r',' ','S','h','e','l','l',' ','F','o','l','d','e','r','s','\0'};
810 /* This defaults to L"Documents and Settings" on Windows 2000/XP, but we're
811 * acting more Windows 9x-like for now.
813 static const WCHAR szDefaultProfileDirW[] = {'p','r','o','f','i','l','e','s','\0'};
814 static const WCHAR AllUsersW[] = {'A','l','l',' ','U','s','e','r','s','\0'};
816 typedef enum _CSIDL_Type {
817 CSIDL_Type_User,
818 CSIDL_Type_AllUsers,
819 CSIDL_Type_CurrVer,
820 CSIDL_Type_Disallowed,
821 CSIDL_Type_NonExistent,
822 CSIDL_Type_WindowsPath,
823 CSIDL_Type_SystemPath,
824 } CSIDL_Type;
826 typedef struct
828 CSIDL_Type type;
829 LPCWSTR szValueName;
830 LPCWSTR szDefaultPath; /* fallback string or resource ID */
831 } CSIDL_DATA;
833 static const CSIDL_DATA CSIDL_Data[] =
835 { /* 0x00 - CSIDL_DESKTOP */
836 CSIDL_Type_User,
837 DesktopW,
838 MAKEINTRESOURCEW(IDS_DESKTOPDIRECTORY)
840 { /* 0x01 - CSIDL_INTERNET */
841 CSIDL_Type_Disallowed,
842 NULL,
843 NULL
845 { /* 0x02 - CSIDL_PROGRAMS */
846 CSIDL_Type_User,
847 ProgramsW,
848 MAKEINTRESOURCEW(IDS_PROGRAMS)
850 { /* 0x03 - CSIDL_CONTROLS (.CPL files) */
851 CSIDL_Type_SystemPath,
852 NULL,
853 NULL
855 { /* 0x04 - CSIDL_PRINTERS */
856 CSIDL_Type_SystemPath,
857 NULL,
858 NULL
860 { /* 0x05 - CSIDL_PERSONAL */
861 CSIDL_Type_User,
862 PersonalW,
863 MAKEINTRESOURCEW(IDS_PERSONAL)
865 { /* 0x06 - CSIDL_FAVORITES */
866 CSIDL_Type_User,
867 FavoritesW,
868 MAKEINTRESOURCEW(IDS_FAVORITES)
870 { /* 0x07 - CSIDL_STARTUP */
871 CSIDL_Type_User,
872 StartUpW,
873 MAKEINTRESOURCEW(IDS_STARTUP)
875 { /* 0x08 - CSIDL_RECENT */
876 CSIDL_Type_User,
877 RecentW,
878 MAKEINTRESOURCEW(IDS_RECENT)
880 { /* 0x09 - CSIDL_SENDTO */
881 CSIDL_Type_User,
882 SendToW,
883 MAKEINTRESOURCEW(IDS_SENDTO)
885 { /* 0x0a - CSIDL_BITBUCKET - Recycle Bin */
886 CSIDL_Type_Disallowed,
887 NULL,
888 NULL,
890 { /* 0x0b - CSIDL_STARTMENU */
891 CSIDL_Type_User,
892 Start_MenuW,
893 MAKEINTRESOURCEW(IDS_STARTMENU)
895 { /* 0x0c - CSIDL_MYDOCUMENTS */
896 CSIDL_Type_Disallowed, /* matches WinXP--can't get its path */
897 NULL,
898 NULL
900 { /* 0x0d - CSIDL_MYMUSIC */
901 CSIDL_Type_User,
902 My_MusicW,
903 MAKEINTRESOURCEW(IDS_MYMUSIC)
905 { /* 0x0e - CSIDL_MYVIDEO */
906 CSIDL_Type_User,
907 My_VideoW,
908 MAKEINTRESOURCEW(IDS_MYVIDEO)
910 { /* 0x0f - unassigned */
911 CSIDL_Type_Disallowed,
912 NULL,
913 NULL,
915 { /* 0x10 - CSIDL_DESKTOPDIRECTORY */
916 CSIDL_Type_User,
917 DesktopW,
918 MAKEINTRESOURCEW(IDS_DESKTOPDIRECTORY)
920 { /* 0x11 - CSIDL_DRIVES */
921 CSIDL_Type_Disallowed,
922 NULL,
923 NULL,
925 { /* 0x12 - CSIDL_NETWORK */
926 CSIDL_Type_Disallowed,
927 NULL,
928 NULL,
930 { /* 0x13 - CSIDL_NETHOOD */
931 CSIDL_Type_User,
932 NetHoodW,
933 MAKEINTRESOURCEW(IDS_NETHOOD)
935 { /* 0x14 - CSIDL_FONTS */
936 CSIDL_Type_WindowsPath,
937 FontsW,
938 FontsW
940 { /* 0x15 - CSIDL_TEMPLATES */
941 CSIDL_Type_User,
942 TemplatesW,
943 MAKEINTRESOURCEW(IDS_TEMPLATES)
945 { /* 0x16 - CSIDL_COMMON_STARTMENU */
946 CSIDL_Type_AllUsers,
947 Common_Start_MenuW,
948 MAKEINTRESOURCEW(IDS_STARTMENU)
950 { /* 0x17 - CSIDL_COMMON_PROGRAMS */
951 CSIDL_Type_AllUsers,
952 Common_ProgramsW,
953 MAKEINTRESOURCEW(IDS_PROGRAMS)
955 { /* 0x18 - CSIDL_COMMON_STARTUP */
956 CSIDL_Type_AllUsers,
957 Common_StartUpW,
958 MAKEINTRESOURCEW(IDS_STARTUP)
960 { /* 0x19 - CSIDL_COMMON_DESKTOPDIRECTORY */
961 CSIDL_Type_AllUsers,
962 Common_DesktopW,
963 MAKEINTRESOURCEW(IDS_DESKTOP)
965 { /* 0x1a - CSIDL_APPDATA */
966 CSIDL_Type_User,
967 AppDataW,
968 MAKEINTRESOURCEW(IDS_APPDATA)
970 { /* 0x1b - CSIDL_PRINTHOOD */
971 CSIDL_Type_User,
972 PrintHoodW,
973 MAKEINTRESOURCEW(IDS_PRINTHOOD)
975 { /* 0x1c - CSIDL_LOCAL_APPDATA */
976 CSIDL_Type_User,
977 Local_AppDataW,
978 MAKEINTRESOURCEW(IDS_LOCAL_APPDATA)
980 { /* 0x1d - CSIDL_ALTSTARTUP */
981 CSIDL_Type_NonExistent,
982 NULL,
983 NULL
985 { /* 0x1e - CSIDL_COMMON_ALTSTARTUP */
986 CSIDL_Type_NonExistent,
987 NULL,
988 NULL
990 { /* 0x1f - CSIDL_COMMON_FAVORITES */
991 CSIDL_Type_AllUsers,
992 FavoritesW,
993 MAKEINTRESOURCEW(IDS_FAVORITES)
995 { /* 0x20 - CSIDL_INTERNET_CACHE */
996 CSIDL_Type_User,
997 CacheW,
998 MAKEINTRESOURCEW(IDS_INTERNET_CACHE)
1000 { /* 0x21 - CSIDL_COOKIES */
1001 CSIDL_Type_User,
1002 CookiesW,
1003 MAKEINTRESOURCEW(IDS_COOKIES)
1005 { /* 0x22 - CSIDL_HISTORY */
1006 CSIDL_Type_User,
1007 HistoryW,
1008 MAKEINTRESOURCEW(IDS_HISTORY)
1010 { /* 0x23 - CSIDL_COMMON_APPDATA */
1011 CSIDL_Type_AllUsers,
1012 Common_AppDataW,
1013 MAKEINTRESOURCEW(IDS_APPDATA)
1015 { /* 0x24 - CSIDL_WINDOWS */
1016 CSIDL_Type_WindowsPath,
1017 NULL,
1018 NULL
1020 { /* 0x25 - CSIDL_SYSTEM */
1021 CSIDL_Type_SystemPath,
1022 NULL,
1023 NULL
1025 { /* 0x26 - CSIDL_PROGRAM_FILES */
1026 CSIDL_Type_CurrVer,
1027 ProgramFilesDirW,
1028 MAKEINTRESOURCEW(IDS_PROGRAM_FILES)
1030 { /* 0x27 - CSIDL_MYPICTURES */
1031 CSIDL_Type_User,
1032 My_PicturesW,
1033 MAKEINTRESOURCEW(IDS_MYPICTURES)
1035 { /* 0x28 - CSIDL_PROFILE */
1036 CSIDL_Type_User,
1037 NULL,
1038 NULL
1040 { /* 0x29 - CSIDL_SYSTEMX86 */
1041 CSIDL_Type_NonExistent,
1042 NULL,
1043 NULL
1045 { /* 0x2a - CSIDL_PROGRAM_FILESX86 */
1046 CSIDL_Type_NonExistent,
1047 NULL,
1048 NULL
1050 { /* 0x2b - CSIDL_PROGRAM_FILES_COMMON */
1051 CSIDL_Type_CurrVer,
1052 CommonFilesDirW,
1053 MAKEINTRESOURCEW(IDS_PROGRAM_FILES_COMMON)
1055 { /* 0x2c - CSIDL_PROGRAM_FILES_COMMONX86 */
1056 CSIDL_Type_NonExistent,
1057 NULL,
1058 NULL
1060 { /* 0x2d - CSIDL_COMMON_TEMPLATES */
1061 CSIDL_Type_AllUsers,
1062 Common_TemplatesW,
1063 MAKEINTRESOURCEW(IDS_TEMPLATES)
1065 { /* 0x2e - CSIDL_COMMON_DOCUMENTS */
1066 CSIDL_Type_AllUsers,
1067 Common_DocumentsW,
1068 MAKEINTRESOURCEW(IDS_COMMON_DOCUMENTS)
1070 { /* 0x2f - CSIDL_COMMON_ADMINTOOLS */
1071 CSIDL_Type_AllUsers,
1072 Common_Administrative_ToolsW,
1073 MAKEINTRESOURCEW(IDS_ADMINTOOLS)
1075 { /* 0x30 - CSIDL_ADMINTOOLS */
1076 CSIDL_Type_User,
1077 Administrative_ToolsW,
1078 MAKEINTRESOURCEW(IDS_ADMINTOOLS)
1080 { /* 0x31 - CSIDL_CONNECTIONS */
1081 CSIDL_Type_Disallowed,
1082 NULL,
1083 NULL
1085 { /* 0x32 - unassigned */
1086 CSIDL_Type_Disallowed,
1087 NULL,
1088 NULL
1090 { /* 0x33 - unassigned */
1091 CSIDL_Type_Disallowed,
1092 NULL,
1093 NULL
1095 { /* 0x34 - unassigned */
1096 CSIDL_Type_Disallowed,
1097 NULL,
1098 NULL
1100 { /* 0x35 - CSIDL_COMMON_MUSIC */
1101 CSIDL_Type_AllUsers,
1102 CommonMusicW,
1103 MAKEINTRESOURCEW(IDS_COMMON_MUSIC)
1105 { /* 0x36 - CSIDL_COMMON_PICTURES */
1106 CSIDL_Type_AllUsers,
1107 CommonPicturesW,
1108 MAKEINTRESOURCEW(IDS_COMMON_PICTURES)
1110 { /* 0x37 - CSIDL_COMMON_VIDEO */
1111 CSIDL_Type_AllUsers,
1112 CommonVideoW,
1113 MAKEINTRESOURCEW(IDS_COMMON_VIDEO)
1115 { /* 0x38 - CSIDL_RESOURCES */
1116 CSIDL_Type_WindowsPath,
1117 NULL,
1118 ResourcesW
1120 { /* 0x39 - CSIDL_RESOURCES_LOCALIZED */
1121 CSIDL_Type_NonExistent,
1122 NULL,
1123 NULL
1125 { /* 0x3a - CSIDL_COMMON_OEM_LINKS */
1126 CSIDL_Type_NonExistent,
1127 NULL,
1128 NULL
1130 { /* 0x3b - CSIDL_CDBURN_AREA */
1131 CSIDL_Type_User,
1132 CD_BurningW,
1133 MAKEINTRESOURCEW(IDS_CDBURN_AREA)
1135 { /* 0x3c unassigned */
1136 CSIDL_Type_Disallowed,
1137 NULL,
1138 NULL
1140 { /* 0x3d - CSIDL_COMPUTERSNEARME */
1141 CSIDL_Type_Disallowed, /* FIXME */
1142 NULL,
1143 NULL
1145 { /* 0x3e - CSIDL_PROFILES */
1146 CSIDL_Type_Disallowed, /* oddly, this matches WinXP */
1147 NULL,
1148 NULL
1152 static HRESULT _SHExpandEnvironmentStrings(LPCWSTR szSrc, LPWSTR szDest);
1154 /* Gets the value named value from the registry key
1155 * rootKey\Software\Microsoft\Windows\CurrentVersion\Explorer\User Shell Folders
1156 * (or from rootKey\userPrefix\... if userPrefix is not NULL) into path, which
1157 * is assumed to be MAX_PATH WCHARs in length.
1158 * If it exists, expands the value and writes the expanded value to
1159 * rootKey\Software\Microsoft\Windows\CurrentVersion\Explorer\Shell Folders
1160 * Returns successful error code if the value was retrieved from the registry,
1161 * and a failure otherwise.
1163 static HRESULT _SHGetUserShellFolderPath(HKEY rootKey, LPCWSTR userPrefix,
1164 LPCWSTR value, LPWSTR path)
1166 HRESULT hr;
1167 WCHAR shellFolderPath[MAX_PATH], userShellFolderPath[MAX_PATH];
1168 LPCWSTR pShellFolderPath, pUserShellFolderPath;
1169 DWORD dwType, dwPathLen = MAX_PATH;
1170 HKEY userShellFolderKey, shellFolderKey;
1172 TRACE("%p,%s,%s,%p\n",rootKey, debugstr_w(userPrefix), debugstr_w(value),
1173 path);
1175 if (userPrefix)
1177 strcpyW(shellFolderPath, userPrefix);
1178 PathAddBackslashW(shellFolderPath);
1179 strcatW(shellFolderPath, szSHFolders);
1180 pShellFolderPath = shellFolderPath;
1181 strcpyW(userShellFolderPath, userPrefix);
1182 PathAddBackslashW(userShellFolderPath);
1183 strcatW(userShellFolderPath, szSHUserFolders);
1184 pUserShellFolderPath = userShellFolderPath;
1186 else
1188 pUserShellFolderPath = szSHUserFolders;
1189 pShellFolderPath = szSHFolders;
1192 if (RegCreateKeyW(rootKey, pShellFolderPath, &shellFolderKey))
1194 TRACE("Failed to create %s\n", debugstr_w(pShellFolderPath));
1195 return E_FAIL;
1197 if (RegCreateKeyW(rootKey, pUserShellFolderPath, &userShellFolderKey))
1199 TRACE("Failed to create %s\n",
1200 debugstr_w(pUserShellFolderPath));
1201 RegCloseKey(shellFolderKey);
1202 return E_FAIL;
1205 if (!RegQueryValueExW(userShellFolderKey, value, NULL, &dwType,
1206 (LPBYTE)path, &dwPathLen) && (dwType == REG_EXPAND_SZ || dwType == REG_SZ))
1208 LONG ret;
1210 path[dwPathLen / sizeof(WCHAR)] = '\0';
1211 if (dwType == REG_EXPAND_SZ && path[0] == '%')
1213 WCHAR szTemp[MAX_PATH];
1215 _SHExpandEnvironmentStrings(path, szTemp);
1216 lstrcpynW(path, szTemp, MAX_PATH);
1218 ret = RegSetValueExW(shellFolderKey, value, 0, REG_SZ, (LPBYTE)path,
1219 (strlenW(path) + 1) * sizeof(WCHAR));
1220 if (ret != ERROR_SUCCESS)
1221 hr = HRESULT_FROM_WIN32(ret);
1222 else
1223 hr = S_OK;
1225 else
1226 hr = E_FAIL;
1227 RegCloseKey(shellFolderKey);
1228 RegCloseKey(userShellFolderKey);
1229 TRACE("returning 0x%08x\n", hr);
1230 return hr;
1233 /* Gets a 'semi-expanded' default value of the CSIDL with index folder into
1234 * pszPath, based on the entries in CSIDL_Data. By semi-expanded, I mean:
1235 * - The entry's szDefaultPath may be either a string value or an integer
1236 * resource identifier. In the latter case, the string value of the resource
1237 * is written.
1238 * - Depending on the entry's type, the path may begin with an (unexpanded)
1239 * environment variable name. The caller is responsible for expanding
1240 * environment strings if so desired.
1241 * The types that are prepended with environment variables are:
1242 * CSIDL_Type_User: %USERPROFILE%
1243 * CSIDL_Type_AllUsers: %ALLUSERSPROFILE%
1244 * CSIDL_Type_CurrVer: %SystemDrive%
1245 * (Others might make sense too, but as yet are unneeded.)
1247 static HRESULT _SHGetDefaultValue(BYTE folder, LPWSTR pszPath)
1249 HRESULT hr;
1250 WCHAR resourcePath[MAX_PATH];
1251 LPCWSTR pDefaultPath = NULL;
1253 TRACE("0x%02x,%p\n", folder, pszPath);
1255 if (folder >= sizeof(CSIDL_Data) / sizeof(CSIDL_Data[0]))
1256 return E_INVALIDARG;
1257 if (!pszPath)
1258 return E_INVALIDARG;
1260 if (CSIDL_Data[folder].szDefaultPath &&
1261 IS_INTRESOURCE(CSIDL_Data[folder].szDefaultPath))
1263 if (LoadStringW(shell32_hInstance,
1264 LOWORD(CSIDL_Data[folder].szDefaultPath), resourcePath, MAX_PATH))
1266 hr = S_OK;
1267 pDefaultPath = resourcePath;
1269 else
1271 FIXME("(%d,%s), LoadString failed, missing translation?\n", folder,
1272 debugstr_w(pszPath));
1273 hr = E_FAIL;
1276 else
1278 hr = S_OK;
1279 pDefaultPath = CSIDL_Data[folder].szDefaultPath;
1281 if (SUCCEEDED(hr))
1283 switch (CSIDL_Data[folder].type)
1285 case CSIDL_Type_User:
1286 strcpyW(pszPath, UserProfileW);
1287 break;
1288 case CSIDL_Type_AllUsers:
1289 strcpyW(pszPath, AllUsersProfileW);
1290 break;
1291 case CSIDL_Type_CurrVer:
1292 strcpyW(pszPath, SystemDriveW);
1293 break;
1294 default:
1295 ; /* no corresponding env. var, do nothing */
1297 if (pDefaultPath)
1299 PathAddBackslashW(pszPath);
1300 strcatW(pszPath, pDefaultPath);
1303 TRACE("returning 0x%08x\n", hr);
1304 return hr;
1307 /* Gets the (unexpanded) value of the folder with index folder into pszPath.
1308 * The folder's type is assumed to be CSIDL_Type_CurrVer. Its default value
1309 * can be overridden in the HKLM\\szCurrentVersion key.
1310 * If dwFlags has SHGFP_TYPE_DEFAULT set or if the value isn't overridden in
1311 * the registry, uses _SHGetDefaultValue to get the value.
1313 static HRESULT _SHGetCurrentVersionPath(DWORD dwFlags, BYTE folder,
1314 LPWSTR pszPath)
1316 HRESULT hr;
1318 TRACE("0x%08x,0x%02x,%p\n", dwFlags, folder, pszPath);
1320 if (folder >= sizeof(CSIDL_Data) / sizeof(CSIDL_Data[0]))
1321 return E_INVALIDARG;
1322 if (CSIDL_Data[folder].type != CSIDL_Type_CurrVer)
1323 return E_INVALIDARG;
1324 if (!pszPath)
1325 return E_INVALIDARG;
1327 if (dwFlags & SHGFP_TYPE_DEFAULT)
1328 hr = _SHGetDefaultValue(folder, pszPath);
1329 else
1331 HKEY hKey;
1333 if (RegCreateKeyW(HKEY_LOCAL_MACHINE, szCurrentVersion, &hKey))
1334 hr = E_FAIL;
1335 else
1337 DWORD dwType, dwPathLen = MAX_PATH * sizeof(WCHAR);
1339 if (RegQueryValueExW(hKey, CSIDL_Data[folder].szValueName, NULL,
1340 &dwType, (LPBYTE)pszPath, &dwPathLen) ||
1341 (dwType != REG_SZ && dwType != REG_EXPAND_SZ))
1343 hr = _SHGetDefaultValue(folder, pszPath);
1344 dwType = REG_EXPAND_SZ;
1345 RegSetValueExW(hKey, CSIDL_Data[folder].szValueName, 0, dwType,
1346 (LPBYTE)pszPath, (strlenW(pszPath)+1)*sizeof(WCHAR));
1348 else
1350 pszPath[dwPathLen / sizeof(WCHAR)] = '\0';
1351 hr = S_OK;
1353 RegCloseKey(hKey);
1356 TRACE("returning 0x%08x (output path is %s)\n", hr, debugstr_w(pszPath));
1357 return hr;
1360 static LPWSTR _GetUserSidStringFromToken(HANDLE Token)
1362 char InfoBuffer[64];
1363 PTOKEN_USER UserInfo;
1364 DWORD InfoSize;
1365 LPWSTR SidStr;
1367 UserInfo = (PTOKEN_USER) InfoBuffer;
1368 if (! GetTokenInformation(Token, TokenUser, InfoBuffer, sizeof(InfoBuffer),
1369 &InfoSize))
1371 if (GetLastError() != ERROR_INSUFFICIENT_BUFFER)
1372 return NULL;
1373 UserInfo = HeapAlloc(GetProcessHeap(), 0, InfoSize);
1374 if (UserInfo == NULL)
1375 return NULL;
1376 if (! GetTokenInformation(Token, TokenUser, UserInfo, InfoSize,
1377 &InfoSize))
1379 HeapFree(GetProcessHeap(), 0, UserInfo);
1380 return NULL;
1384 if (! ConvertSidToStringSidW(UserInfo->User.Sid, &SidStr))
1385 SidStr = NULL;
1387 if (UserInfo != (PTOKEN_USER) InfoBuffer)
1388 HeapFree(GetProcessHeap(), 0, UserInfo);
1390 return SidStr;
1393 /* Gets the user's path (unexpanded) for the CSIDL with index folder:
1394 * If SHGFP_TYPE_DEFAULT is set, calls _SHGetDefaultValue for it. Otherwise
1395 * calls _SHGetUserShellFolderPath for it. Where it looks depends on hToken:
1396 * - if hToken is -1, looks in HKEY_USERS\.Default
1397 * - otherwise looks first in HKEY_CURRENT_USER, followed by HKEY_LOCAL_MACHINE
1398 * if HKEY_CURRENT_USER doesn't contain any entries. If both fail, finally
1399 * calls _SHGetDefaultValue for it.
1401 static HRESULT _SHGetUserProfilePath(HANDLE hToken, DWORD dwFlags, BYTE folder,
1402 LPWSTR pszPath)
1404 HRESULT hr;
1406 TRACE("%p,0x%08x,0x%02x,%p\n", hToken, dwFlags, folder, pszPath);
1408 if (folder >= sizeof(CSIDL_Data) / sizeof(CSIDL_Data[0]))
1409 return E_INVALIDARG;
1410 if (CSIDL_Data[folder].type != CSIDL_Type_User)
1411 return E_INVALIDARG;
1412 if (!pszPath)
1413 return E_INVALIDARG;
1415 if (dwFlags & SHGFP_TYPE_DEFAULT)
1417 if (hToken != NULL && hToken != (HANDLE)-1)
1419 FIXME("unsupported for user other than current or default\n");
1420 return E_FAIL;
1422 hr = _SHGetDefaultValue(folder, pszPath);
1424 else
1426 LPCWSTR userPrefix = NULL;
1427 HKEY hRootKey;
1429 if (hToken == (HANDLE)-1)
1431 hRootKey = HKEY_USERS;
1432 userPrefix = DefaultW;
1434 else if (hToken == NULL)
1435 hRootKey = HKEY_CURRENT_USER;
1436 else
1438 hRootKey = HKEY_USERS;
1439 userPrefix = _GetUserSidStringFromToken(hToken);
1440 if (userPrefix == NULL)
1442 hr = E_FAIL;
1443 goto error;
1446 hr = _SHGetUserShellFolderPath(hRootKey, userPrefix,
1447 CSIDL_Data[folder].szValueName, pszPath);
1448 if (FAILED(hr) && hRootKey != HKEY_LOCAL_MACHINE)
1449 hr = _SHGetUserShellFolderPath(HKEY_LOCAL_MACHINE, NULL,
1450 CSIDL_Data[folder].szValueName, pszPath);
1451 if (FAILED(hr))
1452 hr = _SHGetDefaultValue(folder, pszPath);
1453 if (userPrefix != NULL && userPrefix != DefaultW)
1454 LocalFree((HLOCAL) userPrefix);
1456 error:
1457 TRACE("returning 0x%08x (output path is %s)\n", hr, debugstr_w(pszPath));
1458 return hr;
1461 /* Gets the (unexpanded) path for the CSIDL with index folder. If dwFlags has
1462 * SHGFP_TYPE_DEFAULT set, calls _SHGetDefaultValue. Otherwise calls
1463 * _SHGetUserShellFolderPath for it, looking only in HKEY_LOCAL_MACHINE.
1464 * If this fails, falls back to _SHGetDefaultValue.
1466 static HRESULT _SHGetAllUsersProfilePath(DWORD dwFlags, BYTE folder,
1467 LPWSTR pszPath)
1469 HRESULT hr;
1471 TRACE("0x%08x,0x%02x,%p\n", dwFlags, folder, pszPath);
1473 if (folder >= sizeof(CSIDL_Data) / sizeof(CSIDL_Data[0]))
1474 return E_INVALIDARG;
1475 if (CSIDL_Data[folder].type != CSIDL_Type_AllUsers)
1476 return E_INVALIDARG;
1477 if (!pszPath)
1478 return E_INVALIDARG;
1480 if (dwFlags & SHGFP_TYPE_DEFAULT)
1481 hr = _SHGetDefaultValue(folder, pszPath);
1482 else
1484 hr = _SHGetUserShellFolderPath(HKEY_LOCAL_MACHINE, NULL,
1485 CSIDL_Data[folder].szValueName, pszPath);
1486 if (FAILED(hr))
1487 hr = _SHGetDefaultValue(folder, pszPath);
1489 TRACE("returning 0x%08x (output path is %s)\n", hr, debugstr_w(pszPath));
1490 return hr;
1493 static HRESULT _SHOpenProfilesKey(PHKEY pKey)
1495 LONG lRet;
1496 DWORD disp;
1498 lRet = RegCreateKeyExW(HKEY_LOCAL_MACHINE, ProfileListW, 0, NULL, 0,
1499 KEY_ALL_ACCESS, NULL, pKey, &disp);
1500 return HRESULT_FROM_WIN32(lRet);
1503 /* Reads the value named szValueName from the key profilesKey (assumed to be
1504 * opened by _SHOpenProfilesKey) into szValue, which is assumed to be MAX_PATH
1505 * WCHARs in length. If it doesn't exist, returns szDefault (and saves
1506 * szDefault to the registry).
1508 static HRESULT _SHGetProfilesValue(HKEY profilesKey, LPCWSTR szValueName,
1509 LPWSTR szValue, LPCWSTR szDefault)
1511 HRESULT hr;
1512 DWORD type, dwPathLen = MAX_PATH * sizeof(WCHAR);
1513 LONG lRet;
1515 TRACE("%p,%s,%p,%s\n", profilesKey, debugstr_w(szValueName), szValue,
1516 debugstr_w(szDefault));
1517 lRet = RegQueryValueExW(profilesKey, szValueName, NULL, &type,
1518 (LPBYTE)szValue, &dwPathLen);
1519 if (!lRet && (type == REG_SZ || type == REG_EXPAND_SZ) && dwPathLen
1520 && *szValue)
1522 dwPathLen /= sizeof(WCHAR);
1523 szValue[dwPathLen] = '\0';
1524 hr = S_OK;
1526 else
1528 /* Missing or invalid value, set a default */
1529 lstrcpynW(szValue, szDefault, MAX_PATH);
1530 TRACE("Setting missing value %s to %s\n", debugstr_w(szValueName),
1531 debugstr_w(szValue));
1532 lRet = RegSetValueExW(profilesKey, szValueName, 0, REG_EXPAND_SZ,
1533 (LPBYTE)szValue,
1534 (strlenW(szValue) + 1) * sizeof(WCHAR));
1535 if (lRet)
1536 hr = HRESULT_FROM_WIN32(lRet);
1537 else
1538 hr = S_OK;
1540 TRACE("returning 0x%08x (output value is %s)\n", hr, debugstr_w(szValue));
1541 return hr;
1544 /* Attempts to expand environment variables from szSrc into szDest, which is
1545 * assumed to be MAX_PATH characters in length. Before referring to the
1546 * environment, handles a few variables directly, because the environment
1547 * variables may not be set when this is called (as during Wine's installation
1548 * when default values are being written to the registry).
1549 * The directly handled environment variables, and their source, are:
1550 * - ALLUSERSPROFILE, USERPROFILE: reads from the registry
1551 * - SystemDrive: uses GetSystemDirectoryW and uses the drive portion of its
1552 * path
1553 * If one of the directly handled environment variables is expanded, only
1554 * expands a single variable, and only in the beginning of szSrc.
1556 static HRESULT _SHExpandEnvironmentStrings(LPCWSTR szSrc, LPWSTR szDest)
1558 HRESULT hr;
1559 WCHAR szTemp[MAX_PATH], szProfilesPrefix[MAX_PATH] = { 0 };
1560 HKEY key = NULL;
1562 TRACE("%s, %p\n", debugstr_w(szSrc), szDest);
1564 if (!szSrc || !szDest) return E_INVALIDARG;
1566 /* short-circuit if there's nothing to expand */
1567 if (szSrc[0] != '%')
1569 strcpyW(szDest, szSrc);
1570 hr = S_OK;
1571 goto end;
1573 /* Get the profile prefix, we'll probably be needing it */
1574 hr = _SHOpenProfilesKey(&key);
1575 if (SUCCEEDED(hr))
1577 WCHAR szDefaultProfilesPrefix[MAX_PATH];
1579 GetWindowsDirectoryW(szDefaultProfilesPrefix, MAX_PATH);
1580 PathAddBackslashW(szDefaultProfilesPrefix);
1581 PathAppendW(szDefaultProfilesPrefix, szDefaultProfileDirW);
1582 hr = _SHGetProfilesValue(key, ProfilesDirectoryW, szProfilesPrefix,
1583 szDefaultProfilesPrefix);
1586 *szDest = 0;
1587 strcpyW(szTemp, szSrc);
1588 while (SUCCEEDED(hr) && szTemp[0] == '%')
1590 if (!strncmpiW(szTemp, AllUsersProfileW, strlenW(AllUsersProfileW)))
1592 WCHAR szAllUsers[MAX_PATH];
1594 strcpyW(szDest, szProfilesPrefix);
1595 hr = _SHGetProfilesValue(key, AllUsersProfileValueW,
1596 szAllUsers, AllUsersW);
1597 PathAppendW(szDest, szAllUsers);
1598 PathAppendW(szDest, szTemp + strlenW(AllUsersProfileW));
1600 else if (!strncmpiW(szTemp, UserProfileW, strlenW(UserProfileW)))
1602 WCHAR userName[MAX_PATH];
1603 DWORD userLen = MAX_PATH;
1605 strcpyW(szDest, szProfilesPrefix);
1606 GetUserNameW(userName, &userLen);
1607 PathAppendW(szDest, userName);
1608 PathAppendW(szDest, szTemp + strlenW(UserProfileW));
1610 else if (!strncmpiW(szTemp, SystemDriveW, strlenW(SystemDriveW)))
1612 GetSystemDirectoryW(szDest, MAX_PATH);
1613 if (szDest[1] != ':')
1615 FIXME("non-drive system paths unsupported\n");
1616 hr = E_FAIL;
1618 else
1620 strcpyW(szDest + 3, szTemp + strlenW(SystemDriveW) + 1);
1621 hr = S_OK;
1624 else
1626 DWORD ret = ExpandEnvironmentStringsW(szSrc, szDest, MAX_PATH);
1628 if (ret > MAX_PATH)
1629 hr = HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER);
1630 else if (ret == 0)
1631 hr = HRESULT_FROM_WIN32(GetLastError());
1632 else
1633 hr = S_OK;
1635 if (SUCCEEDED(hr) && szDest[0] == '%')
1636 strcpyW(szTemp, szDest);
1637 else
1639 /* terminate loop */
1640 szTemp[0] = '\0';
1643 end:
1644 if (key)
1645 RegCloseKey(key);
1646 TRACE("returning 0x%08x (input was %s, output is %s)\n", hr,
1647 debugstr_w(szSrc), debugstr_w(szDest));
1648 return hr;
1651 /*************************************************************************
1652 * SHGetFolderPathW [SHELL32.@]
1654 * Convert nFolder to path.
1656 * RETURNS
1657 * Success: S_OK
1658 * Failure: standard HRESULT error codes.
1660 * NOTES
1661 * Most values can be overridden in either
1662 * HKCU\Software\Microsoft\Windows\CurrentVersion\Explorer\User Shell Folders
1663 * or in the same location in HKLM.
1664 * The "Shell Folders" registry key was used in NT4 and earlier systems.
1665 * Beginning with Windows 2000, the "User Shell Folders" key is used, so
1666 * changes made to it are made to the former key too. This synchronization is
1667 * done on-demand: not until someone requests the value of one of these paths
1668 * (by calling one of the SHGet functions) is the value synchronized.
1669 * Furthermore, the HKCU paths take precedence over the HKLM paths.
1671 HRESULT WINAPI SHGetFolderPathW(
1672 HWND hwndOwner, /* [I] owner window */
1673 int nFolder, /* [I] CSIDL identifying the folder */
1674 HANDLE hToken, /* [I] access token */
1675 DWORD dwFlags, /* [I] which path to return */
1676 LPWSTR pszPath) /* [O] converted path */
1678 HRESULT hr = SHGetFolderPathAndSubDirW(hwndOwner, nFolder, hToken, dwFlags, NULL, pszPath);
1679 if(HRESULT_FROM_WIN32(ERROR_PATH_NOT_FOUND) == hr)
1680 hr = HRESULT_FROM_WIN32(ERROR_FILE_NOT_FOUND);
1681 return hr;
1684 HRESULT WINAPI SHGetFolderPathAndSubDirA(
1685 HWND hwndOwner, /* [I] owner window */
1686 int nFolder, /* [I] CSIDL identifying the folder */
1687 HANDLE hToken, /* [I] access token */
1688 DWORD dwFlags, /* [I] which path to return */
1689 LPCSTR pszSubPath, /* [I] sub directory of the specified folder */
1690 LPSTR pszPath) /* [O] converted path */
1692 int length;
1693 HRESULT hr = S_OK;
1694 LPWSTR pszSubPathW = NULL;
1695 LPWSTR pszPathW = NULL;
1696 TRACE("%08x,%08x,%s\n",nFolder, dwFlags, debugstr_w(pszSubPathW));
1698 if(pszPath) {
1699 pszPathW = HeapAlloc(GetProcessHeap(), 0, MAX_PATH * sizeof(WCHAR));
1700 if(!pszPathW) {
1701 hr = HRESULT_FROM_WIN32(ERROR_NOT_ENOUGH_MEMORY);
1702 goto cleanup;
1705 TRACE("%08x,%08x,%s\n",nFolder, dwFlags, debugstr_w(pszSubPathW));
1707 /* SHGetFolderPathAndSubDirW does not distinguish if pszSubPath isn't
1708 * set (null), or an empty string.therefore call it without the parameter set
1709 * if pszSubPath is an empty string
1711 if (pszSubPath && pszSubPath[0]) {
1712 length = MultiByteToWideChar(CP_ACP, 0, pszSubPath, -1, NULL, 0);
1713 pszSubPathW = HeapAlloc(GetProcessHeap(), 0, length * sizeof(WCHAR));
1714 if(!pszSubPathW) {
1715 hr = HRESULT_FROM_WIN32(ERROR_NOT_ENOUGH_MEMORY);
1716 goto cleanup;
1718 MultiByteToWideChar(CP_ACP, 0, pszSubPath, -1, pszSubPathW, length);
1721 hr = SHGetFolderPathAndSubDirW(hwndOwner, nFolder, hToken, dwFlags, pszSubPathW, pszPathW);
1723 if (SUCCEEDED(hr) && pszPath)
1724 WideCharToMultiByte(CP_ACP, 0, pszPathW, -1, pszPath, MAX_PATH, NULL, NULL);
1726 cleanup:
1727 HeapFree(GetProcessHeap(), 0, pszPathW);
1728 HeapFree(GetProcessHeap(), 0, pszSubPathW);
1729 return hr;
1732 HRESULT WINAPI SHGetFolderPathAndSubDirW(
1733 HWND hwndOwner, /* [I] owner window */
1734 int nFolder, /* [I] CSIDL identifying the folder */
1735 HANDLE hToken, /* [I] access token */
1736 DWORD dwFlags, /* [I] which path to return */
1737 LPCWSTR pszSubPath,/* [I] sub directory of the specified folder */
1738 LPWSTR pszPath) /* [O] converted path */
1740 HRESULT hr;
1741 WCHAR szBuildPath[MAX_PATH], szTemp[MAX_PATH];
1742 DWORD folder = nFolder & CSIDL_FOLDER_MASK;
1743 CSIDL_Type type;
1744 int ret;
1746 TRACE("%p,%p,nFolder=0x%04x,%s\n", hwndOwner,pszPath,nFolder,debugstr_w(pszSubPath));
1748 /* Windows always NULL-terminates the resulting path regardless of success
1749 * or failure, so do so first
1751 if (pszPath)
1752 *pszPath = '\0';
1754 if (folder >= sizeof(CSIDL_Data) / sizeof(CSIDL_Data[0]))
1755 return E_INVALIDARG;
1756 if ((SHGFP_TYPE_CURRENT != dwFlags) && (SHGFP_TYPE_DEFAULT != dwFlags))
1757 return E_INVALIDARG;
1758 szTemp[0] = 0;
1759 type = CSIDL_Data[folder].type;
1760 switch (type)
1762 case CSIDL_Type_Disallowed:
1763 hr = E_INVALIDARG;
1764 break;
1765 case CSIDL_Type_NonExistent:
1766 hr = S_FALSE;
1767 break;
1768 case CSIDL_Type_WindowsPath:
1769 GetWindowsDirectoryW(szTemp, MAX_PATH);
1770 if (CSIDL_Data[folder].szDefaultPath &&
1771 !IS_INTRESOURCE(CSIDL_Data[folder].szDefaultPath) &&
1772 *CSIDL_Data[folder].szDefaultPath)
1774 PathAddBackslashW(szTemp);
1775 strcatW(szTemp, CSIDL_Data[folder].szDefaultPath);
1777 hr = S_OK;
1778 break;
1779 case CSIDL_Type_SystemPath:
1780 GetSystemDirectoryW(szTemp, MAX_PATH);
1781 if (CSIDL_Data[folder].szDefaultPath &&
1782 !IS_INTRESOURCE(CSIDL_Data[folder].szDefaultPath) &&
1783 *CSIDL_Data[folder].szDefaultPath)
1785 PathAddBackslashW(szTemp);
1786 strcatW(szTemp, CSIDL_Data[folder].szDefaultPath);
1788 hr = S_OK;
1789 break;
1790 case CSIDL_Type_CurrVer:
1791 hr = _SHGetCurrentVersionPath(dwFlags, folder, szTemp);
1792 break;
1793 case CSIDL_Type_User:
1794 hr = _SHGetUserProfilePath(hToken, dwFlags, folder, szTemp);
1795 break;
1796 case CSIDL_Type_AllUsers:
1797 hr = _SHGetAllUsersProfilePath(dwFlags, folder, szTemp);
1798 break;
1799 default:
1800 FIXME("bogus type %d, please fix\n", type);
1801 hr = E_INVALIDARG;
1802 break;
1805 /* Expand environment strings if necessary */
1806 if (*szTemp == '%')
1807 hr = _SHExpandEnvironmentStrings(szTemp, szBuildPath);
1808 else
1809 strcpyW(szBuildPath, szTemp);
1811 if (FAILED(hr)) goto end;
1813 if(pszSubPath) {
1814 /* make sure the new path does not exceed th bufferlength
1815 * rememebr to backslash and the termination */
1816 if(MAX_PATH < (lstrlenW(szBuildPath) + lstrlenW(pszSubPath) + 2)) {
1817 hr = HRESULT_FROM_WIN32(ERROR_FILENAME_EXCED_RANGE);
1818 goto end;
1820 PathAppendW(szBuildPath, pszSubPath);
1821 PathRemoveBackslashW(szBuildPath);
1823 /* Copy the path if it's available before we might return */
1824 if (SUCCEEDED(hr) && pszPath)
1825 strcpyW(pszPath, szBuildPath);
1827 /* if we don't care about existing directories we are ready */
1828 if(nFolder & CSIDL_FLAG_DONT_VERIFY) goto end;
1830 if (PathFileExistsW(szBuildPath)) goto end;
1832 /* not existing but we are not allowed to create it. The return value
1833 * is verified against shell32 version 6.0.
1835 if (!(nFolder & CSIDL_FLAG_CREATE))
1837 hr = HRESULT_FROM_WIN32(ERROR_PATH_NOT_FOUND);
1838 goto end;
1841 /* create directory/directories */
1842 ret = SHCreateDirectoryExW(hwndOwner, szBuildPath, NULL);
1843 if (ret && ret != ERROR_ALREADY_EXISTS)
1845 ERR("Failed to create directory %s.\n", debugstr_w(szBuildPath));
1846 hr = E_FAIL;
1847 goto end;
1850 TRACE("Created missing system directory %s\n", debugstr_w(szBuildPath));
1851 end:
1852 TRACE("returning 0x%08x (final path is %s)\n", hr, debugstr_w(szBuildPath));
1853 return hr;
1856 /*************************************************************************
1857 * SHGetFolderPathA [SHELL32.@]
1859 * See SHGetFolderPathW.
1861 HRESULT WINAPI SHGetFolderPathA(
1862 HWND hwndOwner,
1863 int nFolder,
1864 HANDLE hToken,
1865 DWORD dwFlags,
1866 LPSTR pszPath)
1868 WCHAR szTemp[MAX_PATH];
1869 HRESULT hr;
1871 TRACE("%p,%p,nFolder=0x%04x\n",hwndOwner,pszPath,nFolder);
1873 if (pszPath)
1874 *pszPath = '\0';
1875 hr = SHGetFolderPathW(hwndOwner, nFolder, hToken, dwFlags, szTemp);
1876 if (SUCCEEDED(hr) && pszPath)
1877 WideCharToMultiByte(CP_ACP, 0, szTemp, -1, pszPath, MAX_PATH, NULL,
1878 NULL);
1880 return hr;
1883 /* For each folder in folders, if its value has not been set in the registry,
1884 * calls _SHGetUserProfilePath or _SHGetAllUsersProfilePath (depending on the
1885 * folder's type) to get the unexpanded value first.
1886 * Writes the unexpanded value to User Shell Folders, and queries it with
1887 * SHGetFolderPathW to force the creation of the directory if it doesn't
1888 * already exist. SHGetFolderPathW also returns the expanded value, which
1889 * this then writes to Shell Folders.
1891 static HRESULT _SHRegisterFolders(HKEY hRootKey, HANDLE hToken,
1892 LPCWSTR szUserShellFolderPath, LPCWSTR szShellFolderPath, const UINT folders[],
1893 UINT foldersLen)
1895 UINT i;
1896 WCHAR path[MAX_PATH];
1897 HRESULT hr = S_OK;
1898 HKEY hUserKey = NULL, hKey = NULL;
1899 DWORD dwType, dwPathLen;
1900 LONG ret;
1902 TRACE("%p,%p,%s,%p,%u\n", hRootKey, hToken,
1903 debugstr_w(szUserShellFolderPath), folders, foldersLen);
1905 ret = RegCreateKeyW(hRootKey, szUserShellFolderPath, &hUserKey);
1906 if (ret)
1907 hr = HRESULT_FROM_WIN32(ret);
1908 else
1910 ret = RegCreateKeyW(hRootKey, szShellFolderPath, &hKey);
1911 if (ret)
1912 hr = HRESULT_FROM_WIN32(ret);
1914 for (i = 0; SUCCEEDED(hr) && i < foldersLen; i++)
1916 dwPathLen = MAX_PATH * sizeof(WCHAR);
1917 if (RegQueryValueExW(hUserKey, CSIDL_Data[folders[i]].szValueName, NULL,
1918 &dwType, (LPBYTE)path, &dwPathLen) || (dwType != REG_SZ &&
1919 dwType != REG_EXPAND_SZ))
1921 *path = '\0';
1922 if (CSIDL_Data[folders[i]].type == CSIDL_Type_User)
1923 _SHGetUserProfilePath(hToken, SHGFP_TYPE_DEFAULT, folders[i],
1924 path);
1925 else if (CSIDL_Data[folders[i]].type == CSIDL_Type_AllUsers)
1926 _SHGetAllUsersProfilePath(SHGFP_TYPE_DEFAULT, folders[i], path);
1927 else if (CSIDL_Data[folders[i]].type == CSIDL_Type_WindowsPath)
1929 GetWindowsDirectoryW(path, MAX_PATH);
1930 if (CSIDL_Data[folders[i]].szDefaultPath &&
1931 !IS_INTRESOURCE(CSIDL_Data[folders[i]].szDefaultPath))
1933 PathAddBackslashW(path);
1934 strcatW(path, CSIDL_Data[folders[i]].szDefaultPath);
1937 else
1938 hr = E_FAIL;
1939 if (*path)
1941 ret = RegSetValueExW(hUserKey,
1942 CSIDL_Data[folders[i]].szValueName, 0, REG_EXPAND_SZ,
1943 (LPBYTE)path, (strlenW(path) + 1) * sizeof(WCHAR));
1944 if (ret)
1945 hr = HRESULT_FROM_WIN32(ret);
1946 else
1948 hr = SHGetFolderPathW(NULL, folders[i] | CSIDL_FLAG_CREATE,
1949 hToken, SHGFP_TYPE_DEFAULT, path);
1950 ret = RegSetValueExW(hKey,
1951 CSIDL_Data[folders[i]].szValueName, 0, REG_SZ,
1952 (LPBYTE)path, (strlenW(path) + 1) * sizeof(WCHAR));
1953 if (ret)
1954 hr = HRESULT_FROM_WIN32(ret);
1959 if (hUserKey)
1960 RegCloseKey(hUserKey);
1961 if (hKey)
1962 RegCloseKey(hKey);
1964 TRACE("returning 0x%08x\n", hr);
1965 return hr;
1968 static HRESULT _SHRegisterUserShellFolders(BOOL bDefault)
1970 static const UINT folders[] = {
1971 CSIDL_PROGRAMS,
1972 CSIDL_PERSONAL,
1973 CSIDL_FAVORITES,
1974 CSIDL_APPDATA,
1975 CSIDL_STARTUP,
1976 CSIDL_RECENT,
1977 CSIDL_SENDTO,
1978 CSIDL_STARTMENU,
1979 CSIDL_MYMUSIC,
1980 CSIDL_MYVIDEO,
1981 CSIDL_DESKTOPDIRECTORY,
1982 CSIDL_NETHOOD,
1983 CSIDL_TEMPLATES,
1984 CSIDL_PRINTHOOD,
1985 CSIDL_LOCAL_APPDATA,
1986 CSIDL_INTERNET_CACHE,
1987 CSIDL_COOKIES,
1988 CSIDL_HISTORY,
1989 CSIDL_MYPICTURES,
1990 CSIDL_FONTS
1992 WCHAR userShellFolderPath[MAX_PATH], shellFolderPath[MAX_PATH];
1993 LPCWSTR pUserShellFolderPath, pShellFolderPath;
1994 HRESULT hr = S_OK;
1995 HKEY hRootKey;
1996 HANDLE hToken;
1998 TRACE("%s\n", bDefault ? "TRUE" : "FALSE");
1999 if (bDefault)
2001 hToken = (HANDLE)-1;
2002 hRootKey = HKEY_USERS;
2003 strcpyW(userShellFolderPath, DefaultW);
2004 PathAddBackslashW(userShellFolderPath);
2005 strcatW(userShellFolderPath, szSHUserFolders);
2006 pUserShellFolderPath = userShellFolderPath;
2007 strcpyW(shellFolderPath, DefaultW);
2008 PathAddBackslashW(shellFolderPath);
2009 strcatW(shellFolderPath, szSHFolders);
2010 pShellFolderPath = shellFolderPath;
2012 else
2014 hToken = NULL;
2015 hRootKey = HKEY_CURRENT_USER;
2016 pUserShellFolderPath = szSHUserFolders;
2017 pShellFolderPath = szSHFolders;
2020 hr = _SHRegisterFolders(hRootKey, hToken, pUserShellFolderPath,
2021 pShellFolderPath, folders, sizeof(folders) / sizeof(folders[0]));
2022 TRACE("returning 0x%08x\n", hr);
2023 return hr;
2026 static HRESULT _SHRegisterCommonShellFolders(void)
2028 static const UINT folders[] = {
2029 CSIDL_COMMON_STARTMENU,
2030 CSIDL_COMMON_PROGRAMS,
2031 CSIDL_COMMON_STARTUP,
2032 CSIDL_COMMON_DESKTOPDIRECTORY,
2033 CSIDL_COMMON_FAVORITES,
2034 CSIDL_COMMON_APPDATA,
2035 CSIDL_COMMON_TEMPLATES,
2036 CSIDL_COMMON_DOCUMENTS,
2038 HRESULT hr;
2040 TRACE("\n");
2041 hr = _SHRegisterFolders(HKEY_LOCAL_MACHINE, NULL, szSHUserFolders,
2042 szSHFolders, folders, sizeof(folders) / sizeof(folders[0]));
2043 TRACE("returning 0x%08x\n", hr);
2044 return hr;
2047 /******************************************************************************
2048 * _SHAppendToUnixPath [Internal]
2050 * Helper function for _SHCreateSymbolicLinks. Appends pwszSubPath (or the
2051 * corresponding resource, if IS_INTRESOURCE) to the unix base path 'szBasePath'
2052 * and replaces backslashes with slashes.
2054 * PARAMS
2055 * szBasePath [IO] The unix base path, which will be appended to (CP_UNXICP).
2056 * pwszSubPath [I] Sub-path or resource id (use MAKEINTRESOURCEW).
2058 * RETURNS
2059 * Success: TRUE,
2060 * Failure: FALSE
2062 static inline BOOL _SHAppendToUnixPath(char *szBasePath, LPCWSTR pwszSubPath) {
2063 WCHAR wszSubPath[MAX_PATH];
2064 int cLen = strlen(szBasePath);
2065 char *pBackslash;
2067 if (IS_INTRESOURCE(pwszSubPath)) {
2068 if (!LoadStringW(shell32_hInstance, LOWORD(pwszSubPath), wszSubPath, MAX_PATH)) {
2069 /* Fall back to hard coded defaults. */
2070 switch (LOWORD(pwszSubPath)) {
2071 case IDS_PERSONAL:
2072 lstrcpyW(wszSubPath, PersonalW);
2073 break;
2074 case IDS_MYMUSIC:
2075 lstrcpyW(wszSubPath, My_MusicW);
2076 break;
2077 case IDS_MYPICTURES:
2078 lstrcpyW(wszSubPath, My_PicturesW);
2079 break;
2080 case IDS_MYVIDEO:
2081 lstrcpyW(wszSubPath, My_VideoW);
2082 break;
2083 default:
2084 ERR("LoadString(%d) failed!\n", LOWORD(pwszSubPath));
2085 return FALSE;
2088 } else {
2089 lstrcpyW(wszSubPath, pwszSubPath);
2092 if (szBasePath[cLen-1] != '/') szBasePath[cLen++] = '/';
2094 if (!WideCharToMultiByte(CP_UNIXCP, 0, wszSubPath, -1, szBasePath + cLen,
2095 FILENAME_MAX - cLen, NULL, NULL))
2097 return FALSE;
2100 pBackslash = szBasePath + cLen;
2101 while ((pBackslash = strchr(pBackslash, '\\'))) *pBackslash = '/';
2103 return TRUE;
2106 /******************************************************************************
2107 * _SHCreateSymbolicLinks [Internal]
2109 * Sets up symbol links for various shell folders to point into the users home
2110 * directory. We do an educated guess about what the user would probably want:
2111 * - If there is a 'My Documents' directory in $HOME, the user probably wants
2112 * wine's 'My Documents' to point there. Furthermore, we imply that the user
2113 * is a Windows lover and has no problem with wine creating 'My Pictures',
2114 * 'My Music' and 'My Video' subfolders under '$HOME/My Documents', if those
2115 * do not already exits. We put appropriate symbolic links in place for those,
2116 * too.
2117 * - If there is no 'My Documents' directory in $HOME, we let 'My Documents'
2118 * point directly to $HOME. We assume the user to be a unix hacker who does not
2119 * want wine to create anything anywhere besides the .wine directory. So, if
2120 * there already is a 'My Music' directory in $HOME, we symlink the 'My Music'
2121 * shell folder to it. But if not, then we check XDG_MUSIC_DIR - "well known"
2122 * directory, and try to link to that. If that fails, then we symlink to
2123 * $HOME directly. The same holds fo 'My Pictures' and 'My Video'.
2124 * - The Desktop shell folder is symlinked to XDG_DESKTOP_DIR. If that does not
2125 * exist, then we try '$HOME/Desktop'. If that does not exist, then we leave
2126 * it alone.
2127 * ('My Music',... above in fact means LoadString(IDS_MYMUSIC))
2129 static void _SHCreateSymbolicLinks(void)
2131 UINT aidsMyStuff[] = { IDS_MYPICTURES, IDS_MYVIDEO, IDS_MYMUSIC }, i;
2132 int acsidlMyStuff[] = { CSIDL_MYPICTURES, CSIDL_MYVIDEO, CSIDL_MYMUSIC };
2133 static const char * xdg_dirs[] = { "PICTURES", "VIDEOS", "MUSIC", "DESKTOP" };
2134 WCHAR wszTempPath[MAX_PATH];
2135 char szPersonalTarget[FILENAME_MAX], *pszPersonal;
2136 char szMyStuffTarget[FILENAME_MAX], *pszMyStuff;
2137 char szDesktopTarget[FILENAME_MAX], *pszDesktop;
2138 struct stat statFolder;
2139 const char *pszHome;
2140 HRESULT hr;
2141 const unsigned int num = sizeof(xdg_dirs) / sizeof(xdg_dirs[0]);
2142 char ** xdg_results = NULL;
2143 char * xdg_desktop_dir;
2145 /* Create all necessary profile sub-dirs up to 'My Documents' and get the unix path. */
2146 hr = SHGetFolderPathW(NULL, CSIDL_PERSONAL|CSIDL_FLAG_CREATE, NULL,
2147 SHGFP_TYPE_DEFAULT, wszTempPath);
2148 if (FAILED(hr)) return;
2149 pszPersonal = wine_get_unix_file_name(wszTempPath);
2150 if (!pszPersonal) return;
2152 XDG_UserDirLookup(xdg_dirs, num, &xdg_results);
2154 pszHome = getenv("HOME");
2155 if (pszHome && !stat(pszHome, &statFolder) && S_ISDIR(statFolder.st_mode)) {
2156 strcpy(szPersonalTarget, pszHome);
2157 if (_SHAppendToUnixPath(szPersonalTarget, MAKEINTRESOURCEW(IDS_PERSONAL)) &&
2158 !stat(szPersonalTarget, &statFolder) && S_ISDIR(statFolder.st_mode))
2160 /* '$HOME/My Documents' exists. Create 'My Pictures', 'My Videos' and
2161 * 'My Music' subfolders or fail silently if they already exist. */
2162 for (i = 0; i < sizeof(aidsMyStuff)/sizeof(aidsMyStuff[0]); i++) {
2163 strcpy(szMyStuffTarget, szPersonalTarget);
2164 if (_SHAppendToUnixPath(szMyStuffTarget, MAKEINTRESOURCEW(aidsMyStuff[i])))
2165 mkdir(szMyStuffTarget, 0777);
2168 else
2170 /* '$HOME/My Documents' doesn't exists, but '$HOME' does. */
2171 strcpy(szPersonalTarget, pszHome);
2174 /* Replace 'My Documents' directory with a symlink of fail silently if not empty. */
2175 rmdir(pszPersonal);
2176 symlink(szPersonalTarget, pszPersonal);
2178 else
2180 /* '$HOME' doesn't exist. Create 'My Pictures', 'My Videos' and 'My Music' subdirs
2181 * in '%USERPROFILE%\\My Documents' or fail silently if they already exist. */
2182 strcpy(szPersonalTarget, pszPersonal);
2183 for (i = 0; i < sizeof(aidsMyStuff)/sizeof(aidsMyStuff[0]); i++) {
2184 strcpy(szMyStuffTarget, szPersonalTarget);
2185 if (_SHAppendToUnixPath(szMyStuffTarget, MAKEINTRESOURCEW(aidsMyStuff[i])))
2186 mkdir(szMyStuffTarget, 0777);
2190 /* Create symbolic links for 'My Pictures', 'My Video' and 'My Music'. */
2191 for (i=0; i < sizeof(aidsMyStuff)/sizeof(aidsMyStuff[0]); i++) {
2192 /* Create the current 'My Whatever' folder and get it's unix path. */
2193 hr = SHGetFolderPathW(NULL, acsidlMyStuff[i]|CSIDL_FLAG_CREATE, NULL,
2194 SHGFP_TYPE_DEFAULT, wszTempPath);
2195 if (FAILED(hr)) continue;
2196 pszMyStuff = wine_get_unix_file_name(wszTempPath);
2197 if (!pszMyStuff) continue;
2199 strcpy(szMyStuffTarget, szPersonalTarget);
2200 if (_SHAppendToUnixPath(szMyStuffTarget, MAKEINTRESOURCEW(aidsMyStuff[i])) &&
2201 !stat(szMyStuffTarget, &statFolder) && S_ISDIR(statFolder.st_mode))
2203 /* If there's a 'My Whatever' directory where 'My Documents' links to, link to it. */
2204 rmdir(pszMyStuff);
2205 symlink(szMyStuffTarget, pszMyStuff);
2207 else
2209 rmdir(pszMyStuff);
2210 if (xdg_results && xdg_results[i])
2212 /* the folder specified by XDG_XXX_DIR exists, link to it. */
2213 symlink(xdg_results[i], pszMyStuff);
2215 else
2217 /* Else link to where 'My Documents' itself links to. */
2218 symlink(szPersonalTarget, pszMyStuff);
2221 HeapFree(GetProcessHeap(), 0, pszMyStuff);
2224 /* Last but not least, the Desktop folder */
2225 if (pszHome)
2226 strcpy(szDesktopTarget, pszHome);
2227 else
2228 strcpy(szDesktopTarget, pszPersonal);
2229 HeapFree(GetProcessHeap(), 0, pszPersonal);
2231 xdg_desktop_dir = xdg_results ? xdg_results[num - 1] : NULL;
2232 if (xdg_desktop_dir ||
2233 (_SHAppendToUnixPath(szDesktopTarget, DesktopW) &&
2234 !stat(szDesktopTarget, &statFolder) && S_ISDIR(statFolder.st_mode)))
2236 hr = SHGetFolderPathW(NULL, CSIDL_DESKTOPDIRECTORY|CSIDL_FLAG_CREATE, NULL,
2237 SHGFP_TYPE_DEFAULT, wszTempPath);
2238 if (SUCCEEDED(hr) && (pszDesktop = wine_get_unix_file_name(wszTempPath)))
2240 rmdir(pszDesktop);
2241 if (xdg_desktop_dir)
2242 symlink(xdg_desktop_dir, pszDesktop);
2243 else
2244 symlink(szDesktopTarget, pszDesktop);
2245 HeapFree(GetProcessHeap(), 0, pszDesktop);
2249 /* Free resources allocated by XDG_UserDirLookup() */
2250 if (xdg_results)
2252 for (i = 0; i < num; i++)
2253 HeapFree(GetProcessHeap(), 0, xdg_results[i]);
2254 HeapFree(GetProcessHeap(), 0, xdg_results);
2258 /* Register the default values in the registry, as some apps seem to depend
2259 * on their presence. The set registered was taken from Windows XP.
2261 HRESULT SHELL_RegisterShellFolders(void)
2263 HRESULT hr;
2265 /* Set up '$HOME' targeted symlinks for 'My Documents', 'My Pictures',
2266 * 'My Video', 'My Music' and 'Desktop' in advance, so that the
2267 * _SHRegister*ShellFolders() functions will find everything nice and clean
2268 * and thus will not attempt to create them in the profile directory. */
2269 _SHCreateSymbolicLinks();
2271 hr = _SHRegisterUserShellFolders(TRUE);
2272 if (SUCCEEDED(hr))
2273 hr = _SHRegisterUserShellFolders(FALSE);
2274 if (SUCCEEDED(hr))
2275 hr = _SHRegisterCommonShellFolders();
2276 return hr;
2279 /*************************************************************************
2280 * SHGetSpecialFolderPathA [SHELL32.@]
2282 BOOL WINAPI SHGetSpecialFolderPathA (
2283 HWND hwndOwner,
2284 LPSTR szPath,
2285 int nFolder,
2286 BOOL bCreate)
2288 return (SHGetFolderPathA(
2289 hwndOwner,
2290 nFolder + (bCreate ? CSIDL_FLAG_CREATE : 0),
2291 NULL,
2293 szPath)) == S_OK ? TRUE : FALSE;
2296 /*************************************************************************
2297 * SHGetSpecialFolderPathW
2299 BOOL WINAPI SHGetSpecialFolderPathW (
2300 HWND hwndOwner,
2301 LPWSTR szPath,
2302 int nFolder,
2303 BOOL bCreate)
2305 return (SHGetFolderPathW(
2306 hwndOwner,
2307 nFolder + (bCreate ? CSIDL_FLAG_CREATE : 0),
2308 NULL,
2310 szPath)) == S_OK ? TRUE : FALSE;
2313 /*************************************************************************
2314 * SHGetSpecialFolderPath (SHELL32.175)
2316 BOOL WINAPI SHGetSpecialFolderPathAW (
2317 HWND hwndOwner,
2318 LPVOID szPath,
2319 int nFolder,
2320 BOOL bCreate)
2323 if (SHELL_OsIsUnicode())
2324 return SHGetSpecialFolderPathW (hwndOwner, szPath, nFolder, bCreate);
2325 return SHGetSpecialFolderPathA (hwndOwner, szPath, nFolder, bCreate);
2328 /*************************************************************************
2329 * SHGetFolderLocation [SHELL32.@]
2331 * Gets the folder locations from the registry and creates a pidl.
2333 * PARAMS
2334 * hwndOwner [I]
2335 * nFolder [I] CSIDL_xxxxx
2336 * hToken [I] token representing user, or NULL for current user, or -1 for
2337 * default user
2338 * dwReserved [I] must be zero
2339 * ppidl [O] PIDL of a special folder
2341 * RETURNS
2342 * Success: S_OK
2343 * Failure: Standard OLE-defined error result, S_FALSE or E_INVALIDARG
2345 * NOTES
2346 * Creates missing reg keys and directories.
2347 * Mostly forwards to SHGetFolderPathW, but a few values of nFolder return
2348 * virtual folders that are handled here.
2350 HRESULT WINAPI SHGetFolderLocation(
2351 HWND hwndOwner,
2352 int nFolder,
2353 HANDLE hToken,
2354 DWORD dwReserved,
2355 LPITEMIDLIST *ppidl)
2357 HRESULT hr = E_INVALIDARG;
2359 TRACE("%p 0x%08x %p 0x%08x %p\n",
2360 hwndOwner, nFolder, hToken, dwReserved, ppidl);
2362 if (!ppidl)
2363 return E_INVALIDARG;
2364 if (dwReserved)
2365 return E_INVALIDARG;
2367 /* The virtual folders' locations are not user-dependent */
2368 *ppidl = NULL;
2369 switch (nFolder)
2371 case CSIDL_DESKTOP:
2372 *ppidl = _ILCreateDesktop();
2373 break;
2375 case CSIDL_PERSONAL:
2376 *ppidl = _ILCreateMyDocuments();
2377 break;
2379 case CSIDL_INTERNET:
2380 *ppidl = _ILCreateIExplore();
2381 break;
2383 case CSIDL_CONTROLS:
2384 *ppidl = _ILCreateControlPanel();
2385 break;
2387 case CSIDL_PRINTERS:
2388 *ppidl = _ILCreatePrinters();
2389 break;
2391 case CSIDL_BITBUCKET:
2392 *ppidl = _ILCreateBitBucket();
2393 break;
2395 case CSIDL_DRIVES:
2396 *ppidl = _ILCreateMyComputer();
2397 break;
2399 case CSIDL_NETWORK:
2400 *ppidl = _ILCreateNetwork();
2401 break;
2403 default:
2405 WCHAR szPath[MAX_PATH];
2407 hr = SHGetFolderPathW(hwndOwner, nFolder, hToken,
2408 SHGFP_TYPE_CURRENT, szPath);
2409 if (SUCCEEDED(hr))
2411 DWORD attributes=0;
2413 TRACE("Value=%s\n", debugstr_w(szPath));
2414 hr = SHILCreateFromPathW(szPath, ppidl, &attributes);
2416 else if (hr == HRESULT_FROM_WIN32(ERROR_FILE_NOT_FOUND))
2418 /* unlike SHGetFolderPath, SHGetFolderLocation in shell32
2419 * version 6.0 returns E_FAIL for nonexistent paths
2421 hr = E_FAIL;
2425 if(*ppidl)
2426 hr = NOERROR;
2428 TRACE("-- (new pidl %p)\n",*ppidl);
2429 return hr;
2432 /*************************************************************************
2433 * SHGetSpecialFolderLocation [SHELL32.@]
2435 * NOTES
2436 * In NT5, SHGetSpecialFolderLocation needs the <winntdir>/Recent
2437 * directory.
2439 HRESULT WINAPI SHGetSpecialFolderLocation(
2440 HWND hwndOwner,
2441 INT nFolder,
2442 LPITEMIDLIST * ppidl)
2444 HRESULT hr = E_INVALIDARG;
2446 TRACE("(%p,0x%x,%p)\n", hwndOwner,nFolder,ppidl);
2448 if (!ppidl)
2449 return E_INVALIDARG;
2451 hr = SHGetFolderLocation(hwndOwner, nFolder, NULL, 0, ppidl);
2452 return hr;