- Generate machine-local IPIDs.
[wine.git] / dlls / shell32 / shlfolder.c
blob1f5841906d67ecb126c32b1b7650c5413ae34c20
2 /*
3 * Shell Folder stuff
5 * Copyright 1997 Marcus Meissner
6 * Copyright 1998, 1999, 2002 Juergen Schmied
8 * IShellFolder2 and related interfaces
10 * This library is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU Lesser General Public
12 * License as published by the Free Software Foundation; either
13 * version 2.1 of the License, or (at your option) any later version.
15 * This library is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * Lesser General Public License for more details.
20 * You should have received a copy of the GNU Lesser General Public
21 * License along with this library; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 #include "config.h"
26 #include "wine/port.h"
28 #include <stdlib.h>
29 #include <string.h>
30 #include <stdarg.h>
31 #include <stdio.h>
33 #define COBJMACROS
35 #include "winerror.h"
36 #include "windef.h"
37 #include "winbase.h"
38 #include "winreg.h"
39 #include "wingdi.h"
40 #include "winuser.h"
42 #include "ole2.h"
43 #include "shlguid.h"
45 #include "pidl.h"
46 #include "undocshell.h"
47 #include "shell32_main.h"
48 #include "shlwapi.h"
49 #include "wine/debug.h"
50 #include "shfldr.h"
52 WINE_DEFAULT_DEBUG_CHANNEL (shell);
54 /***************************************************************************
55 * debughelper: print out the return address
56 * helps especially to track down unbalanced AddRef/Release
58 #define MEM_DEBUG 0
60 #if MEM_DEBUG
61 #define _CALL_TRACE TRACE("called from: 0x%08x\n", *( ((UINT*)&iface)-1 ));
62 #else
63 #define _CALL_TRACE
64 #endif
66 static const WCHAR wszDotShellClassInfo[] = {'.','S','h','e','l','l','C','l','a','s','s','I','n','f','o',0};
68 /***************************************************************************
69 * SHELL32_GetCustomFolderAttribute (internal function)
71 * Gets a value from the folder's desktop.ini file, if one exists.
73 * PARAMETERS
74 * pidl [I] Folder containing the desktop.ini file.
75 * pwszHeading [I] Heading in .ini file.
76 * pwszAttribute [I] Attribute in .ini file.
77 * pwszValue [O] Buffer to store value into.
78 * cchValue [I] Size in characters including NULL of buffer pointed to
79 * by pwszValue.
81 * RETURNS
82 * TRUE if returned non-NULL value.
83 * FALSE otherwise.
85 BOOL SHELL32_GetCustomFolderAttribute(
86 LPCITEMIDLIST pidl, LPCWSTR pwszHeading, LPCWSTR pwszAttribute,
87 LPWSTR pwszValue, DWORD cchValue)
89 #if 0 /* Hack around not having system attribute on non-Windows file systems */
90 DWORD dwAttrib = _ILGetFileAttributes(pidl, NULL, 0);
91 #else
92 DWORD dwAttrib = FILE_ATTRIBUTE_SYSTEM;
93 #endif
94 if (dwAttrib & FILE_ATTRIBUTE_SYSTEM)
96 DWORD ret;
97 WCHAR wszDesktopIniPath[MAX_PATH];
98 static const WCHAR wszDesktopIni[] =
99 {'d','e','s','k','t','o','p','.','i','n','i',0};
100 static const WCHAR wszDefault[] =
101 {0};
102 if (!SHGetPathFromIDListW(pidl, wszDesktopIniPath))
103 return FALSE;
104 PathAppendW(wszDesktopIniPath, wszDesktopIni);
105 ret = GetPrivateProfileStringW(pwszHeading, pwszAttribute,
106 wszDefault, pwszValue, cchValue, wszDesktopIniPath);
107 if (!ret) return FALSE;
108 return TRUE;
110 return FALSE;
114 /***************************************************************************
115 * GetNextElement (internal function)
117 * gets a part of a string till the first backslash
119 * PARAMETERS
120 * pszNext [IN] string to get the element from
121 * pszOut [IN] pointer to buffer whitch receives string
122 * dwOut [IN] length of pszOut
124 * RETURNS
125 * LPSTR pointer to first, not yet parsed char
128 LPCWSTR GetNextElementW (LPCWSTR pszNext, LPWSTR pszOut, DWORD dwOut)
130 LPCWSTR pszTail = pszNext;
131 DWORD dwCopy;
133 TRACE ("(%s %p 0x%08lx)\n", debugstr_w (pszNext), pszOut, dwOut);
135 *pszOut = 0x0000;
137 if (!pszNext || !*pszNext)
138 return NULL;
140 while (*pszTail && (*pszTail != (WCHAR) '\\'))
141 pszTail++;
143 dwCopy = (const WCHAR *) pszTail - (const WCHAR *) pszNext + 1;
144 lstrcpynW (pszOut, pszNext, (dwOut < dwCopy) ? dwOut : dwCopy);
146 if (*pszTail)
147 pszTail++;
148 else
149 pszTail = NULL;
151 TRACE ("--(%s %s 0x%08lx %p)\n", debugstr_w (pszNext), debugstr_w (pszOut), dwOut, pszTail);
152 return pszTail;
155 HRESULT SHELL32_ParseNextElement (IShellFolder2 * psf, HWND hwndOwner, LPBC pbc,
156 LPITEMIDLIST * pidlInOut, LPOLESTR szNext, DWORD * pEaten, DWORD * pdwAttributes)
158 HRESULT hr = E_INVALIDARG;
159 LPITEMIDLIST pidlOut = NULL,
160 pidlTemp = NULL;
161 IShellFolder *psfChild;
163 TRACE ("(%p, %p, %p, %s)\n", psf, pbc, pidlInOut ? *pidlInOut : NULL, debugstr_w (szNext));
165 /* get the shellfolder for the child pidl and let it analyse further */
166 hr = IShellFolder_BindToObject (psf, *pidlInOut, pbc, &IID_IShellFolder, (LPVOID *) & psfChild);
168 if (SUCCEEDED(hr)) {
169 hr = IShellFolder_ParseDisplayName (psfChild, hwndOwner, pbc, szNext, pEaten, &pidlOut, pdwAttributes);
170 IShellFolder_Release (psfChild);
172 if (SUCCEEDED(hr)) {
173 pidlTemp = ILCombine (*pidlInOut, pidlOut);
175 if (!pidlTemp)
176 hr = E_OUTOFMEMORY;
179 if (pidlOut)
180 ILFree (pidlOut);
183 ILFree (*pidlInOut);
184 *pidlInOut = pidlTemp;
186 TRACE ("-- pidl=%p ret=0x%08lx\n", pidlInOut ? *pidlInOut : NULL, hr);
187 return hr;
190 /***********************************************************************
191 * SHELL32_CoCreateInitSF
193 * Creates a shell folder and initializes it with a pidl and a root folder
194 * via IPersistFolder3 or IPersistFolder.
196 * NOTES
197 * pathRoot can be NULL for Folders beeing a drive.
198 * In this case the absolute path is build from pidlChild (eg. C:)
200 HRESULT SHELL32_CoCreateInitSF (LPCITEMIDLIST pidlRoot, LPCSTR pathRoot,
201 LPCITEMIDLIST pidlChild, REFCLSID clsid, REFIID riid, LPVOID * ppvOut)
203 HRESULT hr;
205 TRACE ("%p %s %p\n", pidlRoot, pathRoot, pidlChild);
207 if (SUCCEEDED ((hr = SHCoCreateInstance (NULL, clsid, NULL, riid, ppvOut)))) {
208 LPITEMIDLIST pidlAbsolute = ILCombine (pidlRoot, pidlChild);
209 IPersistFolder *pPF;
210 IPersistFolder3 *ppf;
212 if (SUCCEEDED (IUnknown_QueryInterface ((IUnknown *) * ppvOut, &IID_IPersistFolder3, (LPVOID *) & ppf))) {
213 PERSIST_FOLDER_TARGET_INFO ppfti;
214 char szDestPath[MAX_PATH];
216 ZeroMemory (&ppfti, sizeof (ppfti));
218 /* build path */
219 if (pathRoot) {
220 lstrcpyA (szDestPath, pathRoot);
221 PathAddBackslashA(szDestPath); /* FIXME: why have drives a backslash here ? */
222 } else {
223 szDestPath[0] = '\0';
226 if (pidlChild) {
227 LPSTR pszChild = _ILGetTextPointer(pidlChild);
229 if (pszChild)
230 lstrcatA (szDestPath, pszChild);
231 else
232 hr = E_INVALIDARG;
235 /* fill the PERSIST_FOLDER_TARGET_INFO */
236 ppfti.dwAttributes = -1;
237 ppfti.csidl = -1;
238 MultiByteToWideChar (CP_ACP, 0, szDestPath, -1, ppfti.szTargetParsingName, MAX_PATH);
240 IPersistFolder3_InitializeEx (ppf, NULL, pidlAbsolute, &ppfti);
241 IPersistFolder3_Release (ppf);
243 else if (SUCCEEDED ((hr = IUnknown_QueryInterface ((IUnknown *) * ppvOut, &IID_IPersistFolder, (LPVOID *) & pPF)))) {
244 IPersistFolder_Initialize (pPF, pidlAbsolute);
245 IPersistFolder_Release (pPF);
247 ILFree (pidlAbsolute);
249 TRACE ("-- (%p) ret=0x%08lx\n", *ppvOut, hr);
250 return hr;
253 /***********************************************************************
254 * SHELL32_BindToChild
256 * Common code for IShellFolder_BindToObject.
257 * Creates a shell folder by binding to a root pidl.
259 HRESULT SHELL32_BindToChild (LPCITEMIDLIST pidlRoot,
260 LPCSTR pathRoot, LPCITEMIDLIST pidlComplete, REFIID riid, LPVOID * ppvOut)
262 GUID const *clsid;
263 IShellFolder *pSF;
264 HRESULT hr;
265 LPITEMIDLIST pidlChild;
267 if (!pidlRoot || !ppvOut)
268 return E_INVALIDARG;
270 *ppvOut = NULL;
272 pidlChild = ILCloneFirst (pidlComplete);
274 if ((clsid = _ILGetGUIDPointer (pidlChild))) {
275 /* virtual folder */
276 hr = SHELL32_CoCreateInitSF (pidlRoot, pathRoot, pidlChild, clsid, &IID_IShellFolder, (LPVOID *) & pSF);
277 } else {
278 /* file system folder */
279 CLSID clsidFolder = CLSID_ShellFSFolder;
280 static const WCHAR wszCLSID[] = {'C','L','S','I','D',0};
281 WCHAR wszCLSIDValue[CHARS_IN_GUID];
282 LPITEMIDLIST pidlAbsolute = ILCombine (pidlRoot, pidlChild);
283 /* see if folder CLSID should be overridden by desktop.ini file */
284 if (SHELL32_GetCustomFolderAttribute (pidlAbsolute,
285 wszDotShellClassInfo, wszCLSID, wszCLSIDValue, CHARS_IN_GUID))
286 CLSIDFromString (wszCLSIDValue, &clsidFolder);
287 ILFree (pidlAbsolute);
288 hr = SHELL32_CoCreateInitSF (pidlRoot, pathRoot, pidlChild,
289 &clsidFolder, &IID_IShellFolder, (LPVOID *)&pSF);
291 ILFree (pidlChild);
293 if (SUCCEEDED (hr)) {
294 if (_ILIsPidlSimple (pidlComplete)) {
295 /* no sub folders */
296 hr = IShellFolder_QueryInterface (pSF, riid, ppvOut);
297 } else {
298 /* go deeper */
299 hr = IShellFolder_BindToObject (pSF, ILGetNext (pidlComplete), NULL, riid, ppvOut);
301 IShellFolder_Release (pSF);
304 TRACE ("-- returning (%p) %08lx\n", *ppvOut, hr);
306 return hr;
309 /***********************************************************************
310 * SHELL32_GetDisplayNameOfChild
312 * Retrives the display name of a child object of a shellfolder.
314 * For a pidl eg. [subpidl1][subpidl2][subpidl3]:
315 * - it binds to the child shellfolder [subpidl1]
316 * - asks it for the displayname of [subpidl2][subpidl3]
318 * Is possible the pidl is a simple pidl. In this case it asks the
319 * subfolder for the displayname of a empty pidl. The subfolder
320 * returns the own displayname eg. "::{guid}". This is used for
321 * virtual folders with the registry key WantsFORPARSING set.
323 HRESULT SHELL32_GetDisplayNameOfChild (IShellFolder2 * psf,
324 LPCITEMIDLIST pidl, DWORD dwFlags, LPSTR szOut, DWORD dwOutLen)
326 LPITEMIDLIST pidlFirst;
327 HRESULT hr = E_INVALIDARG;
329 TRACE ("(%p)->(pidl=%p 0x%08lx %p 0x%08lx)\n", psf, pidl, dwFlags, szOut, dwOutLen);
330 pdump (pidl);
332 pidlFirst = ILCloneFirst (pidl);
333 if (pidlFirst) {
334 IShellFolder2 *psfChild;
336 hr = IShellFolder_BindToObject (psf, pidlFirst, NULL, &IID_IShellFolder, (LPVOID *) & psfChild);
337 if (SUCCEEDED (hr)) {
338 STRRET strTemp;
339 LPITEMIDLIST pidlNext = ILGetNext (pidl);
341 hr = IShellFolder_GetDisplayNameOf (psfChild, pidlNext, dwFlags, &strTemp);
342 if (SUCCEEDED (hr)) {
343 hr = StrRetToStrNA (szOut, dwOutLen, &strTemp, pidlNext);
345 IShellFolder_Release (psfChild);
347 ILFree (pidlFirst);
348 } else
349 hr = E_OUTOFMEMORY;
351 TRACE ("-- ret=0x%08lx %s\n", hr, szOut);
353 return hr;
356 /***********************************************************************
357 * SHELL32_GetItemAttributes
359 * NOTES
360 * observerd values:
361 * folder: 0xE0000177 FILESYSTEM | HASSUBFOLDER | FOLDER
362 * file: 0x40000177 FILESYSTEM
363 * drive: 0xf0000144 FILESYSTEM | HASSUBFOLDER | FOLDER | FILESYSANCESTOR
364 * mycomputer: 0xb0000154 HASSUBFOLDER | FOLDER | FILESYSANCESTOR
365 * (seems to be default for shell extensions if no registry entry exists)
367 * win2k:
368 * folder: 0xF0400177 FILESYSTEM | HASSUBFOLDER | FOLDER | FILESYSANCESTOR | CANMONIKER
369 * file: 0x40400177 FILESYSTEM | CANMONIKER
370 * drive 0xF0400154 FILESYSTEM | HASSUBFOLDER | FOLDER | FILESYSANCESTOR | CANMONIKER | CANRENAME (LABEL)
372 * This function does not set flags!! It only resets flags when necessary.
374 HRESULT SHELL32_GetItemAttributes (IShellFolder * psf, LPCITEMIDLIST pidl, LPDWORD pdwAttributes)
376 GUID const *clsid;
377 DWORD dwAttributes;
378 DWORD dwSupportedAttr=SFGAO_CANCOPY | /*0x00000001 */
379 SFGAO_CANMOVE | /*0x00000002 */
380 SFGAO_CANLINK | /*0x00000004 */
381 SFGAO_CANRENAME | /*0x00000010 */
382 SFGAO_CANDELETE | /*0x00000020 */
383 SFGAO_HASPROPSHEET | /*0x00000040 */
384 SFGAO_DROPTARGET | /*0x00000100 */
385 SFGAO_LINK | /*0x00010000 */
386 SFGAO_READONLY | /*0x00040000 */
387 SFGAO_HIDDEN | /*0x00080000 */
388 SFGAO_FILESYSANCESTOR | /*0x10000000 */
389 SFGAO_FOLDER | /*0x20000000 */
390 SFGAO_FILESYSTEM | /*0x40000000 */
391 SFGAO_HASSUBFOLDER; /*0x80000000 */
393 TRACE ("0x%08lx\n", *pdwAttributes);
395 if (*pdwAttributes & ~dwSupportedAttr)
397 WARN ("attributes 0x%08lx not implemented\n", (*pdwAttributes & ~dwSupportedAttr));
398 *pdwAttributes &= dwSupportedAttr;
401 if (_ILIsDrive (pidl)) {
402 *pdwAttributes &= SFGAO_HASSUBFOLDER|SFGAO_FILESYSTEM|SFGAO_FOLDER|SFGAO_FILESYSANCESTOR|SFGAO_DROPTARGET|SFGAO_HASPROPSHEET|SFGAO_CANLINK;
403 } else if ((clsid = _ILGetGUIDPointer (pidl))) {
404 if (HCR_GetFolderAttributes (clsid, &dwAttributes)) {
405 *pdwAttributes &= dwAttributes;
406 } else {
407 *pdwAttributes &= SFGAO_HASSUBFOLDER|SFGAO_FOLDER|SFGAO_FILESYSANCESTOR|SFGAO_DROPTARGET|SFGAO_HASPROPSHEET|SFGAO_CANRENAME|SFGAO_CANLINK;
409 } else if (_ILGetDataPointer (pidl)) {
410 dwAttributes = _ILGetFileAttributes (pidl, NULL, 0);
411 *pdwAttributes &= ~SFGAO_FILESYSANCESTOR;
413 if ((SFGAO_FOLDER & *pdwAttributes) && !(dwAttributes & FILE_ATTRIBUTE_DIRECTORY))
414 *pdwAttributes &= ~(SFGAO_FOLDER | SFGAO_HASSUBFOLDER);
416 if ((SFGAO_HIDDEN & *pdwAttributes) && !(dwAttributes & FILE_ATTRIBUTE_HIDDEN))
417 *pdwAttributes &= ~SFGAO_HIDDEN;
419 if ((SFGAO_READONLY & *pdwAttributes) && !(dwAttributes & FILE_ATTRIBUTE_READONLY))
420 *pdwAttributes &= ~SFGAO_READONLY;
422 if (SFGAO_LINK & *pdwAttributes) {
423 char ext[MAX_PATH];
425 if (!_ILGetExtension(pidl, ext, MAX_PATH) || strcasecmp(ext, "lnk"))
426 *pdwAttributes &= ~SFGAO_LINK;
428 } else {
429 *pdwAttributes &= SFGAO_HASSUBFOLDER|SFGAO_FOLDER|SFGAO_FILESYSANCESTOR|SFGAO_DROPTARGET|SFGAO_HASPROPSHEET|SFGAO_CANRENAME|SFGAO_CANLINK;
431 TRACE ("-- 0x%08lx\n", *pdwAttributes);
432 return S_OK;
435 /***********************************************************************
436 * SHELL32_CompareIDs
438 HRESULT SHELL32_CompareIDs (IShellFolder * iface, LPARAM lParam, LPCITEMIDLIST pidl1, LPCITEMIDLIST pidl2)
440 int type1,
441 type2;
442 char szTemp1[MAX_PATH];
443 char szTemp2[MAX_PATH];
444 HRESULT nReturn;
445 LPITEMIDLIST firstpidl,
446 nextpidl1,
447 nextpidl2;
448 IShellFolder *psf;
450 /* test for empty pidls */
451 BOOL isEmpty1 = _ILIsDesktop (pidl1);
452 BOOL isEmpty2 = _ILIsDesktop (pidl2);
454 if (isEmpty1 && isEmpty2)
455 return MAKE_HRESULT( SEVERITY_SUCCESS, 0, 0 );
456 if (isEmpty1)
457 return MAKE_HRESULT( SEVERITY_SUCCESS, 0, (WORD)-1 );
458 if (isEmpty2)
459 return MAKE_HRESULT( SEVERITY_SUCCESS, 0, 1 );
461 /* test for different types. Sort order is the PT_* constant */
462 type1 = _ILGetDataPointer (pidl1)->type;
463 type2 = _ILGetDataPointer (pidl2)->type;
464 if (type1 < type2)
465 return MAKE_HRESULT( SEVERITY_SUCCESS, 0, (WORD)-1 );
466 else if (type1 > type2)
467 return MAKE_HRESULT( SEVERITY_SUCCESS, 0, 1 );
469 /* test for name of pidl */
470 _ILSimpleGetText (pidl1, szTemp1, MAX_PATH);
471 _ILSimpleGetText (pidl2, szTemp2, MAX_PATH);
472 nReturn = strcasecmp (szTemp1, szTemp2);
473 if (nReturn < 0)
474 return MAKE_HRESULT( SEVERITY_SUCCESS, 0, (WORD)-1 );
475 else if (nReturn > 0)
476 return MAKE_HRESULT( SEVERITY_SUCCESS, 0, 1 );
478 /* test of complex pidls */
479 firstpidl = ILCloneFirst (pidl1);
480 nextpidl1 = ILGetNext (pidl1);
481 nextpidl2 = ILGetNext (pidl2);
483 /* optimizing: test special cases and bind not deeper */
484 /* the deeper shellfolder would do the same */
485 isEmpty1 = _ILIsDesktop (nextpidl1);
486 isEmpty2 = _ILIsDesktop (nextpidl2);
488 if (isEmpty1 && isEmpty2) {
489 return MAKE_HRESULT( SEVERITY_SUCCESS, 0, 0 );
490 } else if (isEmpty1) {
491 return MAKE_HRESULT( SEVERITY_SUCCESS, 0, (WORD)-1 );
492 } else if (isEmpty2) {
493 return MAKE_HRESULT( SEVERITY_SUCCESS, 0, 1 );
494 /* optimizing end */
495 } else if (SUCCEEDED (IShellFolder_BindToObject (iface, firstpidl, NULL, &IID_IShellFolder, (LPVOID *) & psf))) {
496 nReturn = IShellFolder_CompareIDs (psf, lParam, nextpidl1, nextpidl2);
497 IShellFolder_Release (psf);
499 ILFree (firstpidl);
500 return nReturn;
503 /***********************************************************************
504 * SHCreateLinks
506 * Undocumented.
508 HRESULT WINAPI SHCreateLinks( HWND hWnd, LPCSTR lpszDir, LPDATAOBJECT lpDataObject,
509 UINT uFlags, LPITEMIDLIST *lppidlLinks)
511 FIXME("%p %s %p %08x %p\n",hWnd,lpszDir,lpDataObject,uFlags,lppidlLinks);
512 return E_NOTIMPL;