4 * Copyright 1997 Marcus Meissner
5 * Copyright 1998, 1999, 2002 Juergen Schmied
7 * IShellFolder2 and related interfaces
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public
11 * License as published by the Free Software Foundation; either
12 * version 2.1 of the License, or (at your option) any later version.
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this library; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 #include "wine/port.h"
45 #include "undocshell.h"
46 #include "shell32_main.h"
48 #include "wine/debug.h"
51 WINE_DEFAULT_DEBUG_CHANNEL (shell);
53 static const WCHAR wszDotShellClassInfo[] = {
54 '.','S','h','e','l','l','C','l','a','s','s','I','n','f','o',0};
56 /***************************************************************************
57 * SHELL32_GetCustomFolderAttribute (internal function)
59 * Gets a value from the folder's desktop.ini file, if one exists.
62 * pidl [I] Folder containing the desktop.ini file.
63 * pwszHeading [I] Heading in .ini file.
64 * pwszAttribute [I] Attribute in .ini file.
65 * pwszValue [O] Buffer to store value into.
66 * cchValue [I] Size in characters including NULL of buffer pointed to
70 * TRUE if returned non-NULL value.
73 static inline BOOL SHELL32_GetCustomFolderAttributeFromPath(
74 LPWSTR pwszFolderPath, LPCWSTR pwszHeading, LPCWSTR pwszAttribute,
75 LPWSTR pwszValue, DWORD cchValue)
77 static const WCHAR wszDesktopIni[] =
78 {'d','e','s','k','t','o','p','.','i','n','i',0};
79 static const WCHAR wszDefault[] = {0};
81 PathAddBackslashW(pwszFolderPath);
82 PathAppendW(pwszFolderPath, wszDesktopIni);
83 return GetPrivateProfileStringW(pwszHeading, pwszAttribute, wszDefault,
84 pwszValue, cchValue, pwszFolderPath);
87 BOOL SHELL32_GetCustomFolderAttribute(
88 LPCITEMIDLIST pidl, LPCWSTR pwszHeading, LPCWSTR pwszAttribute,
89 LPWSTR pwszValue, DWORD cchValue)
91 DWORD dwAttrib = FILE_ATTRIBUTE_SYSTEM;
92 WCHAR wszFolderPath[MAX_PATH];
94 /* Hack around not having system attribute on non-Windows file systems */
96 dwAttrib = _ILGetFileAttributes(pidl, NULL, 0);
98 if (dwAttrib & FILE_ATTRIBUTE_SYSTEM)
100 if (!SHGetPathFromIDListW(pidl, wszFolderPath))
103 return SHELL32_GetCustomFolderAttributeFromPath(wszFolderPath, pwszHeading,
104 pwszAttribute, pwszValue, cchValue);
109 /***************************************************************************
110 * GetNextElement (internal function)
112 * gets a part of a string till the first backslash
115 * pszNext [IN] string to get the element from
116 * pszOut [IN] pointer to buffer whitch receives string
117 * dwOut [IN] length of pszOut
120 * LPSTR pointer to first, not yet parsed char
123 LPCWSTR GetNextElementW (LPCWSTR pszNext, LPWSTR pszOut, DWORD dwOut)
125 LPCWSTR pszTail = pszNext;
128 TRACE ("(%s %p 0x%08lx)\n", debugstr_w (pszNext), pszOut, dwOut);
132 if (!pszNext || !*pszNext)
135 while (*pszTail && (*pszTail != (WCHAR) '\\'))
138 dwCopy = (const WCHAR *) pszTail - (const WCHAR *) pszNext + 1;
139 lstrcpynW (pszOut, pszNext, (dwOut < dwCopy) ? dwOut : dwCopy);
146 TRACE ("--(%s %s 0x%08lx %p)\n", debugstr_w (pszNext), debugstr_w (pszOut), dwOut, pszTail);
150 HRESULT SHELL32_ParseNextElement (IShellFolder2 * psf, HWND hwndOwner, LPBC pbc,
151 LPITEMIDLIST * pidlInOut, LPOLESTR szNext, DWORD * pEaten, DWORD * pdwAttributes)
153 HRESULT hr = E_INVALIDARG;
154 LPITEMIDLIST pidlOut = NULL,
156 IShellFolder *psfChild;
158 TRACE ("(%p, %p, %p, %s)\n", psf, pbc, pidlInOut ? *pidlInOut : NULL, debugstr_w (szNext));
160 /* get the shellfolder for the child pidl and let it analyse further */
161 hr = IShellFolder_BindToObject (psf, *pidlInOut, pbc, &IID_IShellFolder, (LPVOID *) & psfChild);
164 hr = IShellFolder_ParseDisplayName (psfChild, hwndOwner, pbc, szNext, pEaten, &pidlOut, pdwAttributes);
165 IShellFolder_Release (psfChild);
168 pidlTemp = ILCombine (*pidlInOut, pidlOut);
179 *pidlInOut = pidlTemp;
181 TRACE ("-- pidl=%p ret=0x%08lx\n", pidlInOut ? *pidlInOut : NULL, hr);
185 /***********************************************************************
186 * SHELL32_CoCreateInitSF
188 * Creates a shell folder and initializes it with a pidl and a root folder
189 * via IPersistFolder3 or IPersistFolder.
192 * pathRoot can be NULL for Folders beeing a drive.
193 * In this case the absolute path is build from pidlChild (eg. C:)
195 static HRESULT SHELL32_CoCreateInitSF (LPCITEMIDLIST pidlRoot, LPCWSTR pathRoot,
196 LPCITEMIDLIST pidlChild, REFCLSID clsid, REFIID riid, LPVOID * ppvOut)
200 TRACE ("%p %s %p\n", pidlRoot, debugstr_w(pathRoot), pidlChild);
202 if (SUCCEEDED ((hr = SHCoCreateInstance (NULL, clsid, NULL, riid, ppvOut)))) {
203 LPITEMIDLIST pidlAbsolute = ILCombine (pidlRoot, pidlChild);
205 IPersistFolder3 *ppf;
207 if (_ILIsFolder(pidlChild) &&
208 SUCCEEDED (IUnknown_QueryInterface ((IUnknown *) * ppvOut, &IID_IPersistFolder3, (LPVOID *) & ppf)))
210 PERSIST_FOLDER_TARGET_INFO ppfti;
212 ZeroMemory (&ppfti, sizeof (ppfti));
214 /* fill the PERSIST_FOLDER_TARGET_INFO */
215 ppfti.dwAttributes = -1;
220 lstrcpynW (ppfti.szTargetParsingName, pathRoot, MAX_PATH - 1);
221 PathAddBackslashW(ppfti.szTargetParsingName); /* FIXME: why have drives a backslash here ? */
225 LPCSTR pszChild = _ILGetTextPointer(pidlChild);
226 int len = lstrlenW(ppfti.szTargetParsingName);
229 MultiByteToWideChar (CP_ACP, 0, pszChild, -1, ppfti.szTargetParsingName + len, MAX_PATH - len);
234 IPersistFolder3_InitializeEx (ppf, NULL, pidlAbsolute, &ppfti);
235 IPersistFolder3_Release (ppf);
237 else if (SUCCEEDED ((hr = IUnknown_QueryInterface ((IUnknown *) * ppvOut, &IID_IPersistFolder, (LPVOID *) & pPF)))) {
238 IPersistFolder_Initialize (pPF, pidlAbsolute);
239 IPersistFolder_Release (pPF);
241 ILFree (pidlAbsolute);
243 TRACE ("-- (%p) ret=0x%08lx\n", *ppvOut, hr);
247 /***********************************************************************
248 * SHELL32_BindToChild [Internal]
250 * Common code for IShellFolder_BindToObject.
253 * pidlRoot [I] The parent shell folder's absolute pidl.
254 * pathRoot [I] Absolute dos path of the parent shell folder.
255 * pidlComplete [I] PIDL of the child. Relative to pidlRoot.
256 * riid [I] GUID of the interface, which ppvOut shall be bound to.
257 * ppvOut [O] A reference to the child's interface (riid).
260 * pidlComplete has to contain at least one non empty SHITEMID.
261 * This function makes special assumptions on the shell namespace, which
262 * means you probably can't use it for your IShellFolder implementation.
264 HRESULT SHELL32_BindToChild (LPCITEMIDLIST pidlRoot,
265 LPCWSTR pathRoot, LPCITEMIDLIST pidlComplete, REFIID riid, LPVOID * ppvOut)
270 LPITEMIDLIST pidlChild;
272 if (!pidlRoot || !ppvOut || !pidlComplete || !pidlComplete->mkid.cb)
277 pidlChild = ILCloneFirst (pidlComplete);
279 if ((clsid = _ILGetGUIDPointer (pidlChild))) {
281 hr = SHELL32_CoCreateInitSF (pidlRoot, pathRoot, pidlChild, clsid, &IID_IShellFolder, (LPVOID *) & pSF);
283 /* file system folder */
284 CLSID clsidFolder = CLSID_ShellFSFolder;
285 static const WCHAR wszCLSID[] = {'C','L','S','I','D',0};
286 WCHAR wszCLSIDValue[CHARS_IN_GUID], wszFolderPath[MAX_PATH], *pwszPathTail = wszFolderPath;
288 /* see if folder CLSID should be overridden by desktop.ini file */
290 lstrcpynW(wszFolderPath, pathRoot, MAX_PATH);
291 pwszPathTail = PathAddBackslashW(wszFolderPath);
293 MultiByteToWideChar(CP_ACP, 0, _ILGetTextPointer(pidlChild), -1, pwszPathTail, MAX_PATH - (int)(pwszPathTail - wszFolderPath));
294 if (SHELL32_GetCustomFolderAttributeFromPath (wszFolderPath,
295 wszDotShellClassInfo, wszCLSID, wszCLSIDValue, CHARS_IN_GUID))
296 CLSIDFromString (wszCLSIDValue, &clsidFolder);
298 hr = SHELL32_CoCreateInitSF (pidlRoot, pathRoot, pidlChild,
299 &clsidFolder, &IID_IShellFolder, (LPVOID *)&pSF);
303 if (SUCCEEDED (hr)) {
304 if (_ILIsPidlSimple (pidlComplete)) {
306 hr = IShellFolder_QueryInterface (pSF, riid, ppvOut);
309 hr = IShellFolder_BindToObject (pSF, ILGetNext (pidlComplete), NULL, riid, ppvOut);
311 IShellFolder_Release (pSF);
314 TRACE ("-- returning (%p) %08lx\n", *ppvOut, hr);
319 /***********************************************************************
320 * SHELL32_GetDisplayNameOfChild
322 * Retrives the display name of a child object of a shellfolder.
324 * For a pidl eg. [subpidl1][subpidl2][subpidl3]:
325 * - it binds to the child shellfolder [subpidl1]
326 * - asks it for the displayname of [subpidl2][subpidl3]
328 * Is possible the pidl is a simple pidl. In this case it asks the
329 * subfolder for the displayname of an empty pidl. The subfolder
330 * returns the own displayname eg. "::{guid}". This is used for
331 * virtual folders with the registry key WantsFORPARSING set.
333 HRESULT SHELL32_GetDisplayNameOfChild (IShellFolder2 * psf,
334 LPCITEMIDLIST pidl, DWORD dwFlags, LPWSTR szOut, DWORD dwOutLen)
336 LPITEMIDLIST pidlFirst;
337 HRESULT hr = E_INVALIDARG;
339 TRACE ("(%p)->(pidl=%p 0x%08lx %p 0x%08lx)\n", psf, pidl, dwFlags, szOut, dwOutLen);
342 pidlFirst = ILCloneFirst (pidl);
344 IShellFolder2 *psfChild;
346 hr = IShellFolder_BindToObject (psf, pidlFirst, NULL, &IID_IShellFolder, (LPVOID *) & psfChild);
347 if (SUCCEEDED (hr)) {
349 LPITEMIDLIST pidlNext = ILGetNext (pidl);
351 hr = IShellFolder_GetDisplayNameOf (psfChild, pidlNext, dwFlags, &strTemp);
352 if (SUCCEEDED (hr)) {
353 if(!StrRetToStrNW (szOut, dwOutLen, &strTemp, pidlNext))
356 IShellFolder_Release (psfChild);
362 TRACE ("-- ret=0x%08lx %s\n", hr, debugstr_w(szOut));
367 /***********************************************************************
368 * SHELL32_GetItemAttributes
372 * folder: 0xE0000177 FILESYSTEM | HASSUBFOLDER | FOLDER
373 * file: 0x40000177 FILESYSTEM
374 * drive: 0xf0000144 FILESYSTEM | HASSUBFOLDER | FOLDER | FILESYSANCESTOR
375 * mycomputer: 0xb0000154 HASSUBFOLDER | FOLDER | FILESYSANCESTOR
376 * (seems to be default for shell extensions if no registry entry exists)
379 * folder: 0xF0400177 FILESYSTEM | HASSUBFOLDER | FOLDER | FILESYSANCESTOR | CANMONIKER
380 * file: 0x40400177 FILESYSTEM | CANMONIKER
381 * drive 0xF0400154 FILESYSTEM | HASSUBFOLDER | FOLDER | FILESYSANCESTOR | CANMONIKER | CANRENAME (LABEL)
383 * According to the MSDN documentation this function should not set flags. It claimes only to reset flags when necessary.
384 * However it turns out the native shell32.dll _sets_ flags in several cases - so do we.
386 HRESULT SHELL32_GetItemAttributes (IShellFolder * psf, LPCITEMIDLIST pidl, LPDWORD pdwAttributes)
390 static const DWORD dwSupportedAttr=
391 SFGAO_CANCOPY | /*0x00000001 */
392 SFGAO_CANMOVE | /*0x00000002 */
393 SFGAO_CANLINK | /*0x00000004 */
394 SFGAO_CANRENAME | /*0x00000010 */
395 SFGAO_CANDELETE | /*0x00000020 */
396 SFGAO_HASPROPSHEET | /*0x00000040 */
397 SFGAO_DROPTARGET | /*0x00000100 */
398 SFGAO_LINK | /*0x00010000 */
399 SFGAO_READONLY | /*0x00040000 */
400 SFGAO_HIDDEN | /*0x00080000 */
401 SFGAO_FILESYSANCESTOR | /*0x10000000 */
402 SFGAO_FOLDER | /*0x20000000 */
403 SFGAO_FILESYSTEM | /*0x40000000 */
404 SFGAO_HASSUBFOLDER; /*0x80000000 */
406 TRACE ("0x%08lx\n", *pdwAttributes);
408 if (*pdwAttributes & ~dwSupportedAttr)
410 WARN ("attributes 0x%08lx not implemented\n", (*pdwAttributes & ~dwSupportedAttr));
411 *pdwAttributes &= dwSupportedAttr;
414 has_guid = _ILGetGUIDPointer(pidl) != NULL;
416 dwAttributes = *pdwAttributes;
418 if (_ILIsDrive (pidl)) {
419 *pdwAttributes &= SFGAO_HASSUBFOLDER|SFGAO_FILESYSTEM|SFGAO_FOLDER|SFGAO_FILESYSANCESTOR|
420 SFGAO_DROPTARGET|SFGAO_HASPROPSHEET|SFGAO_CANLINK;
421 } else if (has_guid && HCR_GetFolderAttributes(pidl, &dwAttributes)) {
422 *pdwAttributes = dwAttributes;
423 } else if (_ILGetDataPointer (pidl)) {
424 dwAttributes = _ILGetFileAttributes (pidl, NULL, 0);
426 if (!dwAttributes && has_guid) {
427 WCHAR path[MAX_PATH];
430 /* File attributes are not present in the internal PIDL structure, so get them from the file system. */
432 HRESULT hr = IShellFolder_GetDisplayNameOf(psf, pidl, SHGDN_FORPARSING, &strret);
435 hr = StrRetToBufW(&strret, pidl, path, MAX_PATH);
437 /* call GetFileAttributes() only for file system paths, not for parsing names like "::{...}" */
438 if (SUCCEEDED(hr) && path[0]!=':')
439 dwAttributes = GetFileAttributesW(path);
443 /* Set common attributes */
444 *pdwAttributes |= SFGAO_FILESYSTEM | SFGAO_DROPTARGET | SFGAO_HASPROPSHEET | SFGAO_CANDELETE |
445 SFGAO_CANRENAME | SFGAO_CANLINK | SFGAO_CANMOVE | SFGAO_CANCOPY;
447 if (dwAttributes & FILE_ATTRIBUTE_DIRECTORY)
448 *pdwAttributes |= (SFGAO_FOLDER | SFGAO_HASSUBFOLDER | SFGAO_FILESYSANCESTOR);
450 *pdwAttributes &= ~(SFGAO_FOLDER | SFGAO_HASSUBFOLDER | SFGAO_FILESYSANCESTOR);
452 if (dwAttributes & FILE_ATTRIBUTE_HIDDEN)
453 *pdwAttributes |= SFGAO_HIDDEN;
455 *pdwAttributes &= ~SFGAO_HIDDEN;
457 if (dwAttributes & FILE_ATTRIBUTE_READONLY)
458 *pdwAttributes |= SFGAO_READONLY;
460 *pdwAttributes &= ~SFGAO_READONLY;
462 if (SFGAO_LINK & *pdwAttributes) {
465 if (!_ILGetExtension(pidl, ext, MAX_PATH) || lstrcmpiA(ext, "lnk"))
466 *pdwAttributes &= ~SFGAO_LINK;
469 if (SFGAO_HASSUBFOLDER & *pdwAttributes)
472 if (SUCCEEDED(IShellFolder_BindToObject(psf, pidl, 0, (REFIID)&IID_IShellFolder, (LPVOID *)&psf2)))
474 IEnumIDList *pEnumIL = NULL;
475 if (SUCCEEDED(IShellFolder_EnumObjects(psf2, 0, SHCONTF_FOLDERS, &pEnumIL)))
477 if (IEnumIDList_Skip(pEnumIL, 1) != S_OK)
478 *pdwAttributes &= ~SFGAO_HASSUBFOLDER;
479 IEnumIDList_Release(pEnumIL);
481 IShellFolder_Release(psf2);
485 *pdwAttributes &= SFGAO_HASSUBFOLDER|SFGAO_FOLDER|SFGAO_FILESYSANCESTOR|SFGAO_DROPTARGET|SFGAO_HASPROPSHEET|SFGAO_CANRENAME|SFGAO_CANLINK;
487 TRACE ("-- 0x%08lx\n", *pdwAttributes);
491 /***********************************************************************
494 HRESULT SHELL32_CompareIDs (IShellFolder * iface, LPARAM lParam, LPCITEMIDLIST pidl1, LPCITEMIDLIST pidl2)
498 char szTemp1[MAX_PATH];
499 char szTemp2[MAX_PATH];
501 LPITEMIDLIST firstpidl,
506 /* test for empty pidls */
507 BOOL isEmpty1 = _ILIsDesktop (pidl1);
508 BOOL isEmpty2 = _ILIsDesktop (pidl2);
510 if (isEmpty1 && isEmpty2)
511 return MAKE_HRESULT( SEVERITY_SUCCESS, 0, 0 );
513 return MAKE_HRESULT( SEVERITY_SUCCESS, 0, (WORD)-1 );
515 return MAKE_HRESULT( SEVERITY_SUCCESS, 0, 1 );
517 /* test for different types. Sort order is the PT_* constant */
518 type1 = _ILGetDataPointer (pidl1)->type;
519 type2 = _ILGetDataPointer (pidl2)->type;
521 return MAKE_HRESULT( SEVERITY_SUCCESS, 0, (WORD)-1 );
522 else if (type1 > type2)
523 return MAKE_HRESULT( SEVERITY_SUCCESS, 0, 1 );
525 /* test for name of pidl */
526 _ILSimpleGetText (pidl1, szTemp1, MAX_PATH);
527 _ILSimpleGetText (pidl2, szTemp2, MAX_PATH);
528 nReturn = lstrcmpiA (szTemp1, szTemp2);
530 return MAKE_HRESULT( SEVERITY_SUCCESS, 0, (WORD)-1 );
531 else if (nReturn > 0)
532 return MAKE_HRESULT( SEVERITY_SUCCESS, 0, 1 );
534 /* test of complex pidls */
535 firstpidl = ILCloneFirst (pidl1);
536 nextpidl1 = ILGetNext (pidl1);
537 nextpidl2 = ILGetNext (pidl2);
539 /* optimizing: test special cases and bind not deeper */
540 /* the deeper shellfolder would do the same */
541 isEmpty1 = _ILIsDesktop (nextpidl1);
542 isEmpty2 = _ILIsDesktop (nextpidl2);
544 if (isEmpty1 && isEmpty2) {
545 return MAKE_HRESULT( SEVERITY_SUCCESS, 0, 0 );
546 } else if (isEmpty1) {
547 return MAKE_HRESULT( SEVERITY_SUCCESS, 0, (WORD)-1 );
548 } else if (isEmpty2) {
549 return MAKE_HRESULT( SEVERITY_SUCCESS, 0, 1 );
551 } else if (SUCCEEDED (IShellFolder_BindToObject (iface, firstpidl, NULL, &IID_IShellFolder, (LPVOID *) & psf))) {
552 nReturn = IShellFolder_CompareIDs (psf, lParam, nextpidl1, nextpidl2);
553 IShellFolder_Release (psf);
559 /***********************************************************************
564 HRESULT WINAPI SHCreateLinks( HWND hWnd, LPCSTR lpszDir, LPDATAOBJECT lpDataObject,
565 UINT uFlags, LPITEMIDLIST *lppidlLinks)
567 FIXME("%p %s %p %08x %p\n",hWnd,lpszDir,lpDataObject,uFlags,lppidlLinks);