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
26 #include "wine/port.h"
44 #include "undocshell.h"
45 #include "shell32_main.h"
48 #include "shellfolder.h"
49 #include "wine/debug.h"
53 WINE_DEFAULT_DEBUG_CHANNEL (shell);
55 /***************************************************************************
56 * debughelper: print out the return address
57 * helps especially to track down unbalanced AddRef/Release
62 #define _CALL_TRACE TRACE("called from: 0x%08x\n", *( ((UINT*)&iface)-1 ));
67 /***************************************************************************
68 * GetNextElement (internal function)
70 * gets a part of a string till the first backslash
73 * pszNext [IN] string to get the element from
74 * pszOut [IN] pointer to buffer whitch receives string
75 * dwOut [IN] length of pszOut
78 * LPSTR pointer to first, not yet parsed char
81 LPCWSTR GetNextElementW (LPCWSTR pszNext, LPWSTR pszOut, DWORD dwOut)
83 LPCWSTR pszTail = pszNext;
86 TRACE ("(%s %p 0x%08lx)\n", debugstr_w (pszNext), pszOut, dwOut);
90 if (!pszNext || !*pszNext)
93 while (*pszTail && (*pszTail != (WCHAR) '\\'))
96 dwCopy = (WCHAR *) pszTail - (WCHAR *) pszNext + 1;
97 lstrcpynW (pszOut, pszNext, (dwOut < dwCopy) ? dwOut : dwCopy);
104 TRACE ("--(%s %s 0x%08lx %p)\n", debugstr_w (pszNext), debugstr_w (pszOut), dwOut, pszTail);
108 HRESULT SHELL32_ParseNextElement (IShellFolder2 * psf, HWND hwndOwner, LPBC pbc,
109 LPITEMIDLIST * pidlInOut, LPOLESTR szNext, DWORD * pEaten, DWORD * pdwAttributes)
111 HRESULT hr = E_OUTOFMEMORY;
112 LPITEMIDLIST pidlOut = NULL,
114 IShellFolder *psfChild;
116 TRACE ("(%p, %p, %p, %s)\n", psf, pbc, pidlInOut ? *pidlInOut : NULL, debugstr_w (szNext));
118 /* get the shellfolder for the child pidl and let it analyse further */
119 hr = IShellFolder_BindToObject (psf, *pidlInOut, pbc, &IID_IShellFolder, (LPVOID *) & psfChild);
121 if (SUCCEEDED (hr)) {
122 hr = IShellFolder_ParseDisplayName (psfChild, hwndOwner, pbc, szNext, pEaten, &pidlOut, pdwAttributes);
123 IShellFolder_Release (psfChild);
125 pidlTemp = ILCombine (*pidlInOut, pidlOut);
132 *pidlInOut = pidlTemp;
134 TRACE ("-- pidl=%p ret=0x%08lx\n", pidlInOut ? *pidlInOut : NULL, hr);
138 /***********************************************************************
139 * SHELL32_CoCreateInitSF
141 * Creates a shell folder and initializes it with a pidl via IPersistFolder.
142 * This function is meant for virtual forders not backed by a file system
145 HRESULT SHELL32_CoCreateInitSF (LPCITEMIDLIST pidlRoot,
146 LPCITEMIDLIST pidlChild, REFCLSID clsid, REFIID iid, LPVOID * ppvOut)
150 TRACE ("%p %p\n", pidlRoot, pidlChild);
152 if (SUCCEEDED ((hr = SHCoCreateInstance (NULL, clsid, NULL, iid, ppvOut)))) {
156 if (SUCCEEDED ((hr = IUnknown_QueryInterface ((IUnknown *) * ppvOut, &IID_IPersistFolder, (LPVOID *) & pPF)))) {
158 LPITEMIDLIST pidlAbsolute;
160 pidlAbsolute = ILCombine (pidlRoot, pidlChild);
161 IPersistFolder_Initialize (pPF, pidlAbsolute);
162 IPersistFolder_Release (pPF);
163 SHFree (pidlAbsolute);
167 TRACE ("-- (%p) ret=0x%08lx\n", *ppvOut, hr);
171 /***********************************************************************
172 * SHELL32_CoCreateInitSFEx
174 * Creates a shell folder and initializes it with a pidl and a root folder
175 * via IPersistFolder3.
176 * This function is meant for virtual forders backed by a file system
180 * pathRoot can be NULL for Folders beeing a drive.
181 * In this case the absolute path is build from pidlChild (eg. C:)
183 HRESULT SHELL32_CoCreateInitSFEx (LPCITEMIDLIST pidlRoot,
184 LPCSTR pathRoot, LPCITEMIDLIST pidlChild, REFCLSID clsid, REFIID riid, LPVOID * ppvOut)
187 IPersistFolder3 *ppf;
189 TRACE ("%p %s %p\n", pidlRoot, pathRoot, pidlChild);
191 if (SUCCEEDED ((hr = SHCoCreateInstance (NULL, &CLSID_ShellFSFolder, NULL, riid, ppvOut)))) {
192 if (SUCCEEDED (IUnknown_QueryInterface ((IUnknown *) * ppvOut, &IID_IPersistFolder3, (LPVOID *) & ppf))) {
193 PERSIST_FOLDER_TARGET_INFO ppfti;
194 LPITEMIDLIST pidlAbsolute;
195 char szDestPath[MAX_PATH];
197 ZeroMemory (&ppfti, sizeof (ppfti));
200 pidlAbsolute = ILCombine (pidlRoot, pidlChild);
204 lstrcpyA (szDestPath, pathRoot);
205 PathAddBackslashA(szDestPath); /* FIXME: why have drives a backslash here ? */
207 szDestPath[0] = '\0';
211 lstrcatA (szDestPath, _ILGetTextPointer (pidlChild));
213 /* fill the PERSIST_FOLDER_TARGET_INFO */
214 ppfti.dwAttributes = -1;
216 MultiByteToWideChar (CP_ACP, 0, szDestPath, -1, ppfti.szTargetParsingName, MAX_PATH);
218 IPersistFolder3_InitializeEx (ppf, NULL, pidlAbsolute, &ppfti);
219 IPersistFolder3_Release (ppf);
220 ILFree (pidlAbsolute);
223 TRACE ("-- (%p) ret=0x%08lx\n", *ppvOut, hr);
227 /***********************************************************************
228 * SHELL32_BindToChild
230 * Common code for IShellFolder_BindToObject.
231 * Creates a shell folder by binding to a root pidl.
233 HRESULT SHELL32_BindToChild (LPCITEMIDLIST pidlRoot,
234 LPCSTR pathRoot, LPCITEMIDLIST pidlComplete, REFIID riid, LPVOID * ppvOut)
239 LPITEMIDLIST pidlChild;
241 if (!pidlRoot || !ppvOut)
246 pidlChild = ILCloneFirst (pidlComplete);
248 if ((clsid = _ILGetGUIDPointer (pidlChild))) {
250 hr = SHELL32_CoCreateInitSF (pidlRoot, pidlChild, clsid, &IID_IShellFolder, (LPVOID *) & pSF);
252 /* file system folder */
253 hr = SHELL32_CoCreateInitSFEx (pidlRoot, pathRoot, pidlChild, &CLSID_ShellFSFolder, &IID_IShellFolder,
258 if (SUCCEEDED (hr)) {
259 if (_ILIsPidlSimple (pidlComplete)) {
261 hr = IShellFolder_QueryInterface (pSF, riid, ppvOut);
264 hr = IShellFolder_BindToObject (pSF, ILGetNext (pidlComplete), NULL, riid, ppvOut);
266 IShellFolder_Release (pSF);
269 TRACE ("-- returning (%p) %08lx\n", *ppvOut, hr);
274 /***********************************************************************
275 * SHELL32_GetDisplayNameOfChild
277 * Retrives the display name of a child object of a shellfolder.
279 * For a pidl eg. [subpidl1][subpidl2][subpidl3]:
280 * - it binds to the child shellfolder [subpidl1]
281 * - asks it for the displayname of [subpidl2][subpidl3]
283 * Is possible the pidl is a simple pidl. In this case it asks the
284 * subfolder for the displayname of a empty pidl. The subfolder
285 * returns the own displayname eg. "::{guid}". This is used for
286 * virtual folders with the registry key WantsFORPARSING set.
288 HRESULT SHELL32_GetDisplayNameOfChild (IShellFolder2 * psf,
289 LPCITEMIDLIST pidl, DWORD dwFlags, LPSTR szOut, DWORD dwOutLen)
291 LPITEMIDLIST pidlFirst;
292 HRESULT hr = E_OUTOFMEMORY;
294 TRACE ("(%p)->(pidl=%p 0x%08lx %p 0x%08lx)\n", psf, pidl, dwFlags, szOut, dwOutLen);
297 pidlFirst = ILCloneFirst (pidl);
299 IShellFolder2 *psfChild;
301 hr = IShellFolder_BindToObject (psf, pidlFirst, NULL, &IID_IShellFolder, (LPVOID *) & psfChild);
302 if (SUCCEEDED (hr)) {
304 LPITEMIDLIST pidlNext = ILGetNext (pidl);
306 hr = IShellFolder_GetDisplayNameOf (psfChild, pidlNext, dwFlags, &strTemp);
307 if (SUCCEEDED (hr)) {
308 hr = StrRetToStrNA (szOut, dwOutLen, &strTemp, pidlNext);
310 IShellFolder_Release (psfChild);
315 TRACE ("-- ret=0x%08lx %s\n", hr, szOut);
320 /***********************************************************************
321 * SHELL32_GetItemAttributes
325 * folder: 0xE0000177 FILESYSTEM | HASSUBFOLDER | FOLDER
326 * file: 0x40000177 FILESYSTEM
327 * drive: 0xf0000144 FILESYSTEM | HASSUBFOLDER | FOLDER | FILESYSANCESTOR
328 * mycomputer: 0xb0000154 HASSUBFOLDER | FOLDER | FILESYSANCESTOR
329 * (seems to be default for shell extensions if no registry entry exists)
332 * folder: 0xF0400177 FILESYSTEM | HASSUBFOLDER | FOLDER | FILESYSANCESTOR | CANMONIKER
333 * file: 0x40400177 FILESYSTEM | CANMONIKER
334 * drive 0xF0400154 FILESYSTEM | HASSUBFOLDER | FOLDER | FILESYSANCESTOR | CANMONIKER | CANRENAME (LABEL)
336 * This functions does not set flags!! It only resets flags when nessesary.
338 HRESULT SHELL32_GetItemAttributes (IShellFolder * psf, LPCITEMIDLIST pidl, LPDWORD pdwAttributes)
342 DWORD dwSupportedAttr=SFGAO_CANCOPY | /*0x00000001 */
343 SFGAO_CANMOVE | /*0x00000002 */
344 SFGAO_CANLINK | /*0x00000004 */
345 SFGAO_CANRENAME | /*0x00000010 */
346 SFGAO_CANDELETE | /*0x00000020 */
347 SFGAO_HASPROPSHEET | /*0x00000040 */
348 SFGAO_DROPTARGET | /*0x00000100 */
349 SFGAO_READONLY | /*0x00040000 */
350 SFGAO_HIDDEN | /*0x00080000 */
351 SFGAO_FILESYSANCESTOR | /*0x10000000 */
352 SFGAO_FOLDER | /*0x20000000 */
353 SFGAO_FILESYSTEM | /*0x40000000 */
354 SFGAO_HASSUBFOLDER; /*0x80000000 */
356 TRACE ("0x%08lx\n", *pdwAttributes);
358 if (*pdwAttributes & ~dwSupportedAttr)
360 WARN ("attributes 0x%08lx not implemented\n", (*pdwAttributes & ~dwSupportedAttr));
361 *pdwAttributes &= dwSupportedAttr;
364 if (_ILIsDrive (pidl)) {
365 *pdwAttributes &= SFGAO_HASSUBFOLDER|SFGAO_FILESYSTEM|SFGAO_FOLDER|SFGAO_FILESYSANCESTOR|SFGAO_DROPTARGET|SFGAO_HASPROPSHEET|SFGAO_CANLINK;
366 } else if ((clsid = _ILGetGUIDPointer (pidl))) {
367 if (HCR_GetFolderAttributes (clsid, &dwAttributes)) {
368 *pdwAttributes &= dwAttributes;
370 *pdwAttributes &= SFGAO_HASSUBFOLDER|SFGAO_FOLDER|SFGAO_FILESYSANCESTOR|SFGAO_DROPTARGET|SFGAO_HASPROPSHEET|SFGAO_CANRENAME|SFGAO_CANLINK;
372 } else if (_ILGetDataPointer (pidl)) {
373 dwAttributes = _ILGetFileAttributes (pidl, NULL, 0);
374 *pdwAttributes &= ~SFGAO_FILESYSANCESTOR;
376 if ((SFGAO_FOLDER & *pdwAttributes) && !(dwAttributes & FILE_ATTRIBUTE_DIRECTORY))
377 *pdwAttributes &= ~(SFGAO_FOLDER | SFGAO_HASSUBFOLDER);
379 if ((SFGAO_HIDDEN & *pdwAttributes) && !(dwAttributes & FILE_ATTRIBUTE_HIDDEN))
380 *pdwAttributes &= ~SFGAO_HIDDEN;
382 if ((SFGAO_READONLY & *pdwAttributes) && !(dwAttributes & FILE_ATTRIBUTE_READONLY))
383 *pdwAttributes &= ~SFGAO_READONLY;
385 *pdwAttributes &= SFGAO_HASSUBFOLDER|SFGAO_FOLDER|SFGAO_FILESYSANCESTOR|SFGAO_DROPTARGET|SFGAO_HASPROPSHEET|SFGAO_CANRENAME|SFGAO_CANLINK;
387 TRACE ("-- 0x%08lx\n", *pdwAttributes);
391 /***********************************************************************
394 HRESULT SHELL32_CompareIDs (IShellFolder * iface, LPARAM lParam, LPCITEMIDLIST pidl1, LPCITEMIDLIST pidl2)
398 char szTemp1[MAX_PATH];
399 char szTemp2[MAX_PATH];
401 LPITEMIDLIST firstpidl,
406 /* test for empty pidls */
407 BOOL isEmpty1 = _ILIsDesktop (pidl1);
408 BOOL isEmpty2 = _ILIsDesktop (pidl2);
410 if (isEmpty1 && isEmpty2)
417 /* test for different types. Sort order is the PT_* constant */
418 type1 = _ILGetDataPointer (pidl1)->type;
419 type2 = _ILGetDataPointer (pidl2)->type;
421 return (type1 - type2);
423 /* test for name of pidl */
424 _ILSimpleGetText (pidl1, szTemp1, MAX_PATH);
425 _ILSimpleGetText (pidl2, szTemp2, MAX_PATH);
426 nReturn = strcasecmp (szTemp1, szTemp2);
430 /* test of complex pidls */
431 firstpidl = ILCloneFirst (pidl1);
432 nextpidl1 = ILGetNext (pidl1);
433 nextpidl2 = ILGetNext (pidl2);
435 /* optimizing: test special cases and bind not deeper */
436 /* the deeper shellfolder would do the same */
437 isEmpty1 = _ILIsDesktop (nextpidl1);
438 isEmpty2 = _ILIsDesktop (nextpidl2);
440 if (isEmpty1 && isEmpty2) {
442 } else if (isEmpty1) {
444 } else if (isEmpty2) {
447 } else if (SUCCEEDED (IShellFolder_BindToObject (iface, firstpidl, NULL, &IID_IShellFolder, (LPVOID *) & psf))) {
448 nReturn = IShellFolder_CompareIDs (psf, lParam, nextpidl1, nextpidl2);
449 IShellFolder_Release (psf);
455 /***********************************************************************
460 HRESULT WINAPI SHCreateLinks( HWND hWnd, LPCSTR lpszDir, LPDATAOBJECT lpDataObject,
461 UINT uFlags, LPITEMIDLIST *lppidlLinks)
463 FIXME("%p %s %p %08x %p\n",hWnd,lpszDir,lpDataObject,uFlags,lppidlLinks);