Make sure the TRACE statements do not spew garbage by using
[wine] / dlls / shell32 / shlfolder.c
1 /*
2  *      Shell Folder stuff
3  *
4  *      Copyright 1997                  Marcus Meissner
5  *      Copyright 1998, 1999, 2002      Juergen Schmied
6  *
7  *      IShellFolder2 and related interfaces
8  *
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.
13  *
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.
18  *
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
22  */
23
24 #include "config.h"
25 #include "wine/port.h"
26
27 #include <stdlib.h>
28 #include <string.h>
29 #include <stdarg.h>
30 #include <stdio.h>
31
32 #define COBJMACROS
33
34 #include "winerror.h"
35 #include "windef.h"
36 #include "winbase.h"
37 #include "winreg.h"
38 #include "wingdi.h"
39 #include "winuser.h"
40
41 #include "ole2.h"
42 #include "shlguid.h"
43
44 #include "pidl.h"
45 #include "undocshell.h"
46 #include "shell32_main.h"
47 #include "shlwapi.h"
48 #include "wine/debug.h"
49 #include "shfldr.h"
50
51 WINE_DEFAULT_DEBUG_CHANNEL (shell);
52
53 static const WCHAR wszDotShellClassInfo[] = {
54     '.','S','h','e','l','l','C','l','a','s','s','I','n','f','o',0};
55
56 /***************************************************************************
57  *  SHELL32_GetCustomFolderAttribute (internal function)
58  *
59  * Gets a value from the folder's desktop.ini file, if one exists.
60  *
61  * PARAMETERS
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
67  *                    by pwszValue.
68  *
69  *  RETURNS
70  *    TRUE if returned non-NULL value.
71  *    FALSE otherwise.
72  */
73 BOOL SHELL32_GetCustomFolderAttribute(
74     LPCITEMIDLIST pidl, LPCWSTR pwszHeading, LPCWSTR pwszAttribute,
75     LPWSTR pwszValue, DWORD cchValue)
76 {
77     static const WCHAR wszDesktopIni[] =
78             {'d','e','s','k','t','o','p','.','i','n','i',0};
79     static const WCHAR wszDefault[] = {0};
80     DWORD dwAttrib = FILE_ATTRIBUTE_SYSTEM;
81
82     /* Hack around not having system attribute on non-Windows file systems */
83     if (0)
84         dwAttrib = _ILGetFileAttributes(pidl, NULL, 0);
85
86     if (dwAttrib & FILE_ATTRIBUTE_SYSTEM)
87     {
88         DWORD ret;
89         WCHAR wszDesktopIniPath[MAX_PATH];
90
91         if (!SHGetPathFromIDListW(pidl, wszDesktopIniPath))
92             return FALSE;
93         PathAppendW(wszDesktopIniPath, wszDesktopIni);
94         ret = GetPrivateProfileStringW(pwszHeading, pwszAttribute,
95             wszDefault, pwszValue, cchValue, wszDesktopIniPath);
96         return ret;
97     }
98     return FALSE;
99 }
100
101
102 /***************************************************************************
103  *  GetNextElement (internal function)
104  *
105  * gets a part of a string till the first backslash
106  *
107  * PARAMETERS
108  *  pszNext [IN] string to get the element from
109  *  pszOut  [IN] pointer to buffer whitch receives string
110  *  dwOut   [IN] length of pszOut
111  *
112  *  RETURNS
113  *    LPSTR pointer to first, not yet parsed char
114  */
115
116 LPCWSTR GetNextElementW (LPCWSTR pszNext, LPWSTR pszOut, DWORD dwOut)
117 {
118     LPCWSTR pszTail = pszNext;
119     DWORD dwCopy;
120
121     TRACE ("(%s %p 0x%08lx)\n", debugstr_w (pszNext), pszOut, dwOut);
122
123     *pszOut = 0x0000;
124
125     if (!pszNext || !*pszNext)
126         return NULL;
127
128     while (*pszTail && (*pszTail != (WCHAR) '\\'))
129         pszTail++;
130
131     dwCopy = (const WCHAR *) pszTail - (const WCHAR *) pszNext + 1;
132     lstrcpynW (pszOut, pszNext, (dwOut < dwCopy) ? dwOut : dwCopy);
133
134     if (*pszTail)
135         pszTail++;
136     else
137         pszTail = NULL;
138
139     TRACE ("--(%s %s 0x%08lx %p)\n", debugstr_w (pszNext), debugstr_w (pszOut), dwOut, pszTail);
140     return pszTail;
141 }
142
143 HRESULT SHELL32_ParseNextElement (IShellFolder2 * psf, HWND hwndOwner, LPBC pbc,
144                                   LPITEMIDLIST * pidlInOut, LPOLESTR szNext, DWORD * pEaten, DWORD * pdwAttributes)
145 {
146     HRESULT hr = E_INVALIDARG;
147     LPITEMIDLIST pidlOut = NULL,
148       pidlTemp = NULL;
149     IShellFolder *psfChild;
150
151     TRACE ("(%p, %p, %p, %s)\n", psf, pbc, pidlInOut ? *pidlInOut : NULL, debugstr_w (szNext));
152
153     /* get the shellfolder for the child pidl and let it analyse further */
154     hr = IShellFolder_BindToObject (psf, *pidlInOut, pbc, &IID_IShellFolder, (LPVOID *) & psfChild);
155
156     if (SUCCEEDED(hr)) {
157         hr = IShellFolder_ParseDisplayName (psfChild, hwndOwner, pbc, szNext, pEaten, &pidlOut, pdwAttributes);
158         IShellFolder_Release (psfChild);
159
160         if (SUCCEEDED(hr)) {
161             pidlTemp = ILCombine (*pidlInOut, pidlOut);
162
163             if (!pidlTemp)
164                 hr = E_OUTOFMEMORY;
165         }
166
167         if (pidlOut)
168             ILFree (pidlOut);
169     }
170
171     ILFree (*pidlInOut);
172     *pidlInOut = pidlTemp;
173
174     TRACE ("-- pidl=%p ret=0x%08lx\n", pidlInOut ? *pidlInOut : NULL, hr);
175     return hr;
176 }
177
178 /***********************************************************************
179  *      SHELL32_CoCreateInitSF
180  *
181  * Creates a shell folder and initializes it with a pidl and a root folder
182  * via IPersistFolder3 or IPersistFolder.
183  *
184  * NOTES
185  *   pathRoot can be NULL for Folders beeing a drive.
186  *   In this case the absolute path is build from pidlChild (eg. C:)
187  */
188 HRESULT SHELL32_CoCreateInitSF (LPCITEMIDLIST pidlRoot, LPCSTR pathRoot,
189     LPCITEMIDLIST pidlChild, REFCLSID clsid, REFIID riid, LPVOID * ppvOut)
190 {
191     HRESULT hr;
192
193     TRACE ("%p %s %p\n", pidlRoot, pathRoot, pidlChild);
194
195     if (SUCCEEDED ((hr = SHCoCreateInstance (NULL, clsid, NULL, riid, ppvOut)))) {
196         LPITEMIDLIST pidlAbsolute = ILCombine (pidlRoot, pidlChild);
197         IPersistFolder *pPF;
198         IPersistFolder3 *ppf;
199
200         if (SUCCEEDED (IUnknown_QueryInterface ((IUnknown *) * ppvOut, &IID_IPersistFolder3, (LPVOID *) & ppf))) {
201             PERSIST_FOLDER_TARGET_INFO ppfti;
202             char szDestPath[MAX_PATH];
203
204             ZeroMemory (&ppfti, sizeof (ppfti));
205
206             /* build path */
207             if (pathRoot) {
208                 lstrcpyA (szDestPath, pathRoot);
209                 PathAddBackslashA(szDestPath);          /* FIXME: why have drives a backslash here ? */
210             } else {
211                 szDestPath[0] = '\0';
212             }
213
214             if (pidlChild) {
215                 LPSTR pszChild = _ILGetTextPointer(pidlChild);
216
217                 if (pszChild)
218                     lstrcatA (szDestPath, pszChild);
219                 else
220                     hr = E_INVALIDARG;
221             }
222
223             /* fill the PERSIST_FOLDER_TARGET_INFO */
224             ppfti.dwAttributes = -1;
225             ppfti.csidl = -1;
226             MultiByteToWideChar (CP_ACP, 0, szDestPath, -1, ppfti.szTargetParsingName, MAX_PATH);
227
228             IPersistFolder3_InitializeEx (ppf, NULL, pidlAbsolute, &ppfti);
229             IPersistFolder3_Release (ppf);
230         }
231         else if (SUCCEEDED ((hr = IUnknown_QueryInterface ((IUnknown *) * ppvOut, &IID_IPersistFolder, (LPVOID *) & pPF)))) {
232             IPersistFolder_Initialize (pPF, pidlAbsolute);
233             IPersistFolder_Release (pPF);
234         }
235         ILFree (pidlAbsolute);
236     }
237     TRACE ("-- (%p) ret=0x%08lx\n", *ppvOut, hr);
238     return hr;
239 }
240
241 /***********************************************************************
242  *      SHELL32_BindToChild
243  *
244  * Common code for IShellFolder_BindToObject.
245  * Creates a shell folder by binding to a root pidl.
246  */
247 HRESULT SHELL32_BindToChild (LPCITEMIDLIST pidlRoot,
248                              LPCSTR pathRoot, LPCITEMIDLIST pidlComplete, REFIID riid, LPVOID * ppvOut)
249 {
250     GUID const *clsid;
251     IShellFolder *pSF;
252     HRESULT hr;
253     LPITEMIDLIST pidlChild;
254
255     if (!pidlRoot || !ppvOut)
256         return E_INVALIDARG;
257
258     *ppvOut = NULL;
259
260     pidlChild = ILCloneFirst (pidlComplete);
261
262     if ((clsid = _ILGetGUIDPointer (pidlChild))) {
263         /* virtual folder */
264         hr = SHELL32_CoCreateInitSF (pidlRoot, pathRoot, pidlChild, clsid, &IID_IShellFolder, (LPVOID *) & pSF);
265     } else {
266         /* file system folder */
267         CLSID clsidFolder = CLSID_ShellFSFolder;
268         static const WCHAR wszCLSID[] = {'C','L','S','I','D',0};
269         WCHAR wszCLSIDValue[CHARS_IN_GUID];
270         LPITEMIDLIST pidlAbsolute = ILCombine (pidlRoot, pidlChild);
271         /* see if folder CLSID should be overridden by desktop.ini file */
272         if (SHELL32_GetCustomFolderAttribute (pidlAbsolute,
273             wszDotShellClassInfo, wszCLSID, wszCLSIDValue, CHARS_IN_GUID))
274             CLSIDFromString (wszCLSIDValue, &clsidFolder);
275         ILFree (pidlAbsolute);
276         hr = SHELL32_CoCreateInitSF (pidlRoot, pathRoot, pidlChild,
277             &clsidFolder, &IID_IShellFolder, (LPVOID *)&pSF);
278     }
279     ILFree (pidlChild);
280
281     if (SUCCEEDED (hr)) {
282         if (_ILIsPidlSimple (pidlComplete)) {
283             /* no sub folders */
284             hr = IShellFolder_QueryInterface (pSF, riid, ppvOut);
285         } else {
286             /* go deeper */
287             hr = IShellFolder_BindToObject (pSF, ILGetNext (pidlComplete), NULL, riid, ppvOut);
288         }
289         IShellFolder_Release (pSF);
290     }
291
292     TRACE ("-- returning (%p) %08lx\n", *ppvOut, hr);
293
294     return hr;
295 }
296
297 /***********************************************************************
298  *      SHELL32_GetDisplayNameOfChild
299  *
300  * Retrives the display name of a child object of a shellfolder.
301  *
302  * For a pidl eg. [subpidl1][subpidl2][subpidl3]:
303  * - it binds to the child shellfolder [subpidl1]
304  * - asks it for the displayname of [subpidl2][subpidl3]
305  *
306  * Is possible the pidl is a simple pidl. In this case it asks the
307  * subfolder for the displayname of an empty pidl. The subfolder
308  * returns the own displayname eg. "::{guid}". This is used for
309  * virtual folders with the registry key WantsFORPARSING set.
310  */
311 HRESULT SHELL32_GetDisplayNameOfChild (IShellFolder2 * psf,
312                                        LPCITEMIDLIST pidl, DWORD dwFlags, LPSTR szOut, DWORD dwOutLen)
313 {
314     LPITEMIDLIST pidlFirst;
315     HRESULT hr = E_INVALIDARG;
316
317     TRACE ("(%p)->(pidl=%p 0x%08lx %p 0x%08lx)\n", psf, pidl, dwFlags, szOut, dwOutLen);
318     pdump (pidl);
319
320     pidlFirst = ILCloneFirst (pidl);
321     if (pidlFirst) {
322         IShellFolder2 *psfChild;
323
324         hr = IShellFolder_BindToObject (psf, pidlFirst, NULL, &IID_IShellFolder, (LPVOID *) & psfChild);
325         if (SUCCEEDED (hr)) {
326             STRRET strTemp;
327             LPITEMIDLIST pidlNext = ILGetNext (pidl);
328
329             hr = IShellFolder_GetDisplayNameOf (psfChild, pidlNext, dwFlags, &strTemp);
330             if (SUCCEEDED (hr)) {
331                 hr = StrRetToStrNA (szOut, dwOutLen, &strTemp, pidlNext);
332             }
333             IShellFolder_Release (psfChild);
334         }
335         ILFree (pidlFirst);
336     } else
337         hr = E_OUTOFMEMORY;
338
339     TRACE ("-- ret=0x%08lx %s\n", hr, szOut);
340
341     return hr;
342 }
343
344 /***********************************************************************
345  *  SHELL32_GetItemAttributes
346  *
347  * NOTES
348  * observerd values:
349  *  folder:     0xE0000177      FILESYSTEM | HASSUBFOLDER | FOLDER
350  *  file:       0x40000177      FILESYSTEM
351  *  drive:      0xf0000144      FILESYSTEM | HASSUBFOLDER | FOLDER | FILESYSANCESTOR
352  *  mycomputer: 0xb0000154      HASSUBFOLDER | FOLDER | FILESYSANCESTOR
353  *  (seems to be default for shell extensions if no registry entry exists)
354  *
355  * win2k:
356  *  folder:    0xF0400177      FILESYSTEM | HASSUBFOLDER | FOLDER | FILESYSANCESTOR | CANMONIKER
357  *  file:      0x40400177      FILESYSTEM | CANMONIKER
358  *  drive      0xF0400154      FILESYSTEM | HASSUBFOLDER | FOLDER | FILESYSANCESTOR | CANMONIKER | CANRENAME (LABEL)
359  *
360  * This function does not set flags!! It only resets flags when necessary.
361  */
362 HRESULT SHELL32_GetItemAttributes (IShellFolder * psf, LPCITEMIDLIST pidl, LPDWORD pdwAttributes)
363 {
364     GUID const *clsid;
365     DWORD dwAttributes;
366     DWORD dwSupportedAttr=SFGAO_CANCOPY |           /*0x00000001 */
367                           SFGAO_CANMOVE |           /*0x00000002 */
368                           SFGAO_CANLINK |           /*0x00000004 */
369                           SFGAO_CANRENAME |         /*0x00000010 */
370                           SFGAO_CANDELETE |         /*0x00000020 */
371                           SFGAO_HASPROPSHEET |      /*0x00000040 */
372                           SFGAO_DROPTARGET |        /*0x00000100 */
373                           SFGAO_LINK |              /*0x00010000 */
374                           SFGAO_READONLY |          /*0x00040000 */
375                           SFGAO_HIDDEN |            /*0x00080000 */
376                           SFGAO_FILESYSANCESTOR |   /*0x10000000 */
377                           SFGAO_FOLDER |            /*0x20000000 */
378                           SFGAO_FILESYSTEM |        /*0x40000000 */
379                           SFGAO_HASSUBFOLDER;       /*0x80000000 */
380     
381     TRACE ("0x%08lx\n", *pdwAttributes);
382
383     if (*pdwAttributes & ~dwSupportedAttr)
384     {
385         WARN ("attributes 0x%08lx not implemented\n", (*pdwAttributes & ~dwSupportedAttr));
386         *pdwAttributes &= dwSupportedAttr;
387     }
388
389     if (_ILIsDrive (pidl)) {
390         *pdwAttributes &= SFGAO_HASSUBFOLDER|SFGAO_FILESYSTEM|SFGAO_FOLDER|SFGAO_FILESYSANCESTOR|SFGAO_DROPTARGET|SFGAO_HASPROPSHEET|SFGAO_CANLINK;
391     } else if ((clsid = _ILGetGUIDPointer (pidl))) {
392         if (HCR_GetFolderAttributes (clsid, &dwAttributes)) {
393             *pdwAttributes &= dwAttributes;
394         } else {
395             *pdwAttributes &= SFGAO_HASSUBFOLDER|SFGAO_FOLDER|SFGAO_FILESYSANCESTOR|SFGAO_DROPTARGET|SFGAO_HASPROPSHEET|SFGAO_CANRENAME|SFGAO_CANLINK;
396         }
397     } else if (_ILGetDataPointer (pidl)) {
398         dwAttributes = _ILGetFileAttributes (pidl, NULL, 0);
399
400         if ((SFGAO_FILESYSANCESTOR & *pdwAttributes) && !(dwAttributes & FILE_ATTRIBUTE_DIRECTORY))
401             *pdwAttributes &= ~SFGAO_FILESYSANCESTOR;
402
403         if ((SFGAO_FOLDER & *pdwAttributes) && !(dwAttributes & FILE_ATTRIBUTE_DIRECTORY))
404             *pdwAttributes &= ~(SFGAO_FOLDER | SFGAO_HASSUBFOLDER);
405
406         if ((SFGAO_HIDDEN & *pdwAttributes) && !(dwAttributes & FILE_ATTRIBUTE_HIDDEN))
407             *pdwAttributes &= ~SFGAO_HIDDEN;
408
409         if ((SFGAO_READONLY & *pdwAttributes) && !(dwAttributes & FILE_ATTRIBUTE_READONLY))
410             *pdwAttributes &= ~SFGAO_READONLY;
411
412         if (SFGAO_LINK & *pdwAttributes) {
413             char ext[MAX_PATH];
414
415             if (!_ILGetExtension(pidl, ext, MAX_PATH) || lstrcmpiA(ext, "lnk"))
416                 *pdwAttributes &= ~SFGAO_LINK;
417         }
418
419         if (SFGAO_HASSUBFOLDER & *pdwAttributes)
420         {
421             IShellFolder *psf2;
422             if (SUCCEEDED(IShellFolder_BindToObject(psf, pidl, 0, (REFIID)&IID_IShellFolder, (LPVOID *)&psf2)))
423             {
424                 IEnumIDList     *pEnumIL = NULL;
425                 if (SUCCEEDED(IShellFolder_EnumObjects(psf2, 0, SHCONTF_FOLDERS, &pEnumIL)))
426                 {
427                     if (IEnumIDList_Skip(pEnumIL, 1) != S_OK)
428                         *pdwAttributes &= ~SFGAO_HASSUBFOLDER;
429                     IEnumIDList_Release(pEnumIL);
430                 }
431                 IShellFolder_Release(psf2);
432             }
433         }
434     } else {
435         *pdwAttributes &= SFGAO_HASSUBFOLDER|SFGAO_FOLDER|SFGAO_FILESYSANCESTOR|SFGAO_DROPTARGET|SFGAO_HASPROPSHEET|SFGAO_CANRENAME|SFGAO_CANLINK;
436     }
437     TRACE ("-- 0x%08lx\n", *pdwAttributes);
438     return S_OK;
439 }
440
441 /***********************************************************************
442  *  SHELL32_CompareIDs
443  */
444 HRESULT SHELL32_CompareIDs (IShellFolder * iface, LPARAM lParam, LPCITEMIDLIST pidl1, LPCITEMIDLIST pidl2)
445 {
446     int type1,
447       type2;
448     char szTemp1[MAX_PATH];
449     char szTemp2[MAX_PATH];
450     HRESULT nReturn;
451     LPITEMIDLIST firstpidl,
452       nextpidl1,
453       nextpidl2;
454     IShellFolder *psf;
455
456     /* test for empty pidls */
457     BOOL isEmpty1 = _ILIsDesktop (pidl1);
458     BOOL isEmpty2 = _ILIsDesktop (pidl2);
459
460     if (isEmpty1 && isEmpty2)
461         return MAKE_HRESULT( SEVERITY_SUCCESS, 0, 0 );
462     if (isEmpty1)
463         return MAKE_HRESULT( SEVERITY_SUCCESS, 0, (WORD)-1 );
464     if (isEmpty2)
465         return MAKE_HRESULT( SEVERITY_SUCCESS, 0, 1 );
466
467     /* test for different types. Sort order is the PT_* constant */
468     type1 = _ILGetDataPointer (pidl1)->type;
469     type2 = _ILGetDataPointer (pidl2)->type;
470     if (type1 < type2)
471         return MAKE_HRESULT( SEVERITY_SUCCESS, 0, (WORD)-1 );
472     else if (type1 > type2)
473         return MAKE_HRESULT( SEVERITY_SUCCESS, 0, 1 );
474
475     /* test for name of pidl */
476     _ILSimpleGetText (pidl1, szTemp1, MAX_PATH);
477     _ILSimpleGetText (pidl2, szTemp2, MAX_PATH);
478     nReturn = lstrcmpiA (szTemp1, szTemp2);
479     if (nReturn < 0)
480         return MAKE_HRESULT( SEVERITY_SUCCESS, 0, (WORD)-1 );
481     else if (nReturn > 0)
482         return MAKE_HRESULT( SEVERITY_SUCCESS, 0, 1 );
483
484     /* test of complex pidls */
485     firstpidl = ILCloneFirst (pidl1);
486     nextpidl1 = ILGetNext (pidl1);
487     nextpidl2 = ILGetNext (pidl2);
488
489     /* optimizing: test special cases and bind not deeper */
490     /* the deeper shellfolder would do the same */
491     isEmpty1 = _ILIsDesktop (nextpidl1);
492     isEmpty2 = _ILIsDesktop (nextpidl2);
493
494     if (isEmpty1 && isEmpty2) {
495         return MAKE_HRESULT( SEVERITY_SUCCESS, 0, 0 );
496     } else if (isEmpty1) {
497         return MAKE_HRESULT( SEVERITY_SUCCESS, 0, (WORD)-1 );
498     } else if (isEmpty2) {
499         return MAKE_HRESULT( SEVERITY_SUCCESS, 0, 1 );
500     /* optimizing end */
501     } else if (SUCCEEDED (IShellFolder_BindToObject (iface, firstpidl, NULL, &IID_IShellFolder, (LPVOID *) & psf))) {
502         nReturn = IShellFolder_CompareIDs (psf, lParam, nextpidl1, nextpidl2);
503         IShellFolder_Release (psf);
504     }
505     ILFree (firstpidl);
506     return nReturn;
507 }
508
509 /***********************************************************************
510  *  SHCreateLinks
511  *
512  *   Undocumented.
513  */
514 HRESULT WINAPI SHCreateLinks( HWND hWnd, LPCSTR lpszDir, LPDATAOBJECT lpDataObject,
515                               UINT uFlags, LPITEMIDLIST *lppidlLinks)
516 {
517     FIXME("%p %s %p %08x %p\n",hWnd,lpszDir,lpDataObject,uFlags,lppidlLinks);
518     return E_NOTIMPL;
519 }