Optimize invalidation on insert.
[wine] / dlls / shell32 / shlfolder.c
1
2 /*
3  *      Shell Folder stuff
4  *
5  *      Copyright 1997                  Marcus Meissner
6  *      Copyright 1998, 1999, 2002      Juergen Schmied
7  *
8  *      IShellFolder2 and related interfaces
9  *
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.
14  *
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.
19  *
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
23  */
24
25 #include "config.h"
26 #include "wine/port.h"
27
28 #include <stdlib.h>
29 #include <string.h>
30 #include <stdio.h>
31
32 #include "winerror.h"
33 #include "winbase.h"
34 #include "winreg.h"
35
36 #include "oleidl.h"
37 #include "shlguid.h"
38
39 #include "pidl.h"
40 #include "wine/obj_base.h"
41 #include "wine/obj_dragdrop.h"
42 #include "wine/obj_shellfolder.h"
43 #include "undocshell.h"
44 #include "shell32_main.h"
45 #include "shresdef.h"
46 #include "shlwapi.h"
47 #include "shellfolder.h"
48 #include "wine/debug.h"
49 #include "debughlp.h"
50 #include "shfldr.h"
51
52 WINE_DEFAULT_DEBUG_CHANNEL (shell);
53
54 /***************************************************************************
55  * debughelper: print out the return adress
56  *  helps especially to track down unbalanced AddRef/Release
57  */
58 #define MEM_DEBUG 0
59
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
65
66 /***************************************************************************
67  *  GetNextElement (internal function)
68  *
69  * gets a part of a string till the first backslash
70  *
71  * PARAMETERS
72  *  pszNext [IN] string to get the element from
73  *  pszOut  [IN] pointer to buffer whitch receives string
74  *  dwOut   [IN] length of pszOut
75  *
76  *  RETURNS
77  *    LPSTR pointer to first, not yet parsed char
78  */
79
80 LPCWSTR GetNextElementW (LPCWSTR pszNext, LPWSTR pszOut, DWORD dwOut)
81 {
82     LPCWSTR pszTail = pszNext;
83     DWORD dwCopy;
84
85     TRACE ("(%s %p 0x%08lx)\n", debugstr_w (pszNext), pszOut, dwOut);
86
87     *pszOut = 0x0000;
88
89     if (!pszNext || !*pszNext)
90         return NULL;
91
92     while (*pszTail && (*pszTail != (WCHAR) '\\'))
93         pszTail++;
94
95     dwCopy = (WCHAR *) pszTail - (WCHAR *) pszNext + 1;
96     lstrcpynW (pszOut, pszNext, (dwOut < dwCopy) ? dwOut : dwCopy);
97
98     if (*pszTail)
99         pszTail++;
100     else
101         pszTail = NULL;
102
103     TRACE ("--(%s %s 0x%08lx %p)\n", debugstr_w (pszNext), debugstr_w (pszOut), dwOut, pszTail);
104     return pszTail;
105 }
106
107 HRESULT SHELL32_ParseNextElement (HWND hwndOwner,
108                                   IShellFolder2 * psf,
109                                   LPITEMIDLIST * pidlInOut, LPOLESTR szNext, DWORD * pEaten, DWORD * pdwAttributes)
110 {
111     HRESULT hr = E_OUTOFMEMORY;
112     LPITEMIDLIST pidlOut = NULL,
113       pidlTemp = NULL;
114     IShellFolder *psfChild;
115
116     TRACE ("(%p, %p, %s)\n", psf, pidlInOut ? *pidlInOut : NULL, debugstr_w (szNext));
117
118     /* get the shellfolder for the child pidl and let it analyse further */
119     hr = IShellFolder_BindToObject (psf, *pidlInOut, NULL, &IID_IShellFolder, (LPVOID *) & psfChild);
120
121     if (SUCCEEDED (hr)) {
122         hr = IShellFolder_ParseDisplayName (psfChild, hwndOwner, NULL, szNext, pEaten, &pidlOut, pdwAttributes);
123         IShellFolder_Release (psfChild);
124
125         pidlTemp = ILCombine (*pidlInOut, pidlOut);
126
127         if (pidlOut)
128             ILFree (pidlOut);
129     }
130
131     ILFree (*pidlInOut);
132     *pidlInOut = pidlTemp;
133
134     TRACE ("-- pidl=%p ret=0x%08lx\n", pidlInOut ? *pidlInOut : NULL, hr);
135     return hr;
136 }
137
138 /***********************************************************************
139  *      SHELL32_CoCreateInitSF
140  *
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
143  * folder.
144  */
145 HRESULT SHELL32_CoCreateInitSF (LPITEMIDLIST pidlRoot,
146                                 LPITEMIDLIST pidlChild, REFCLSID clsid, REFIID iid, LPVOID * ppvOut)
147 {
148     HRESULT hr;
149
150     TRACE ("%p %p\n", pidlRoot, pidlChild);
151
152     if (SUCCEEDED ((hr = SHCoCreateInstance (NULL, clsid, NULL, iid, ppvOut)))) {
153
154         IPersistFolder *pPF;
155
156         if (SUCCEEDED ((hr = IUnknown_QueryInterface ((IUnknown *) * ppvOut, &IID_IPersistFolder, (LPVOID *) & pPF)))) {
157
158             LPITEMIDLIST pidlAbsolute;
159
160             pidlAbsolute = ILCombine (pidlRoot, pidlChild);
161             IPersistFolder_Initialize (pPF, pidlAbsolute);
162             IPersistFolder_Release (pPF);
163             SHFree (pidlAbsolute);
164         }
165     }
166
167     TRACE ("-- (%p) ret=0x%08lx\n", *ppvOut, hr);
168     return hr;
169 }
170
171 /***********************************************************************
172  *      SHELL32_CoCreateInitSFEx
173  *
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
177  * folder.
178  *
179  * NOTES
180  *   pathRoot can be NULL for Folders beeing a drive.
181  *   In this case the absolute path is build from pidlChild (eg. C:)
182  */
183 HRESULT SHELL32_CoCreateInitSFEx (LPITEMIDLIST pidlRoot,
184                                   LPCSTR pathRoot, LPITEMIDLIST pidlChild, REFCLSID clsid, REFIID riid, LPVOID * ppvOut)
185 {
186     HRESULT hr;
187     IPersistFolder3 *ppf;
188
189     TRACE ("%p %s %p\n", pidlRoot, pathRoot, pidlChild);
190
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];
196
197             ZeroMemory (&ppfti, sizeof (ppfti));
198
199             /* combine pidls */
200             pidlAbsolute = ILCombine (pidlRoot, pidlChild);
201
202             /* build path */
203             if (pathRoot) {
204                 lstrcpyA (szDestPath, pathRoot);
205                 PathAddBackslashA(szDestPath);          /* FIXME: why have drives a backslash here ? */
206             } else {
207                 szDestPath[0] = '\0';
208             }
209             lstrcatA (szDestPath, _ILGetTextPointer (pidlChild));
210
211             /* fill the PERSIST_FOLDER_TARGET_INFO */
212             ppfti.dwAttributes = -1;
213             ppfti.csidl = -1;
214             MultiByteToWideChar (CP_ACP, 0, szDestPath, -1, ppfti.szTargetParsingName, MAX_PATH);
215
216             IPersistFolder3_InitializeEx (ppf, NULL, pidlAbsolute, &ppfti);
217             IPersistFolder3_Release (ppf);
218             ILFree (pidlAbsolute);
219         }
220     }
221     TRACE ("-- (%p) ret=0x%08lx\n", *ppvOut, hr);
222     return hr;
223 }
224
225 /***********************************************************************
226  *      SHELL32_BindToChild
227  *
228  * Common code for IShellFolder_BindToObject.
229  * Creates a shell folder by binding to a root pidl.
230  */
231 HRESULT SHELL32_BindToChild (LPCITEMIDLIST pidlRoot,
232                              LPCSTR pathRoot, LPCITEMIDLIST pidlComplete, REFIID riid, LPVOID * ppvOut)
233 {
234     GUID const *clsid;
235     IShellFolder *pSF;
236     HRESULT hr;
237     LPITEMIDLIST pidlChild;
238
239     if (!pidlRoot || !ppvOut)
240         return E_INVALIDARG;
241
242     *ppvOut = NULL;
243
244     pidlChild = ILCloneFirst (pidlComplete);
245
246     if ((clsid = _ILGetGUIDPointer (pidlChild))) {
247         /* virtual folder */
248         hr = SHELL32_CoCreateInitSF (pidlRoot, pidlChild, clsid, &IID_IShellFolder, (LPVOID *) & pSF);
249     } else {
250         /* file system folder */
251         hr = SHELL32_CoCreateInitSFEx (pidlRoot, pathRoot, pidlChild, &CLSID_ShellFSFolder, &IID_IShellFolder,
252                                        (LPVOID *) & pSF);
253     }
254     ILFree (pidlChild);
255
256     if (SUCCEEDED (hr)) {
257         if (_ILIsPidlSimple (pidlComplete)) {
258             /* no sub folders */
259             hr = IShellFolder_QueryInterface (pSF, riid, ppvOut);
260         } else {
261             /* go deeper */
262             hr = IShellFolder_BindToObject (pSF, ILGetNext (pidlComplete), NULL, riid, ppvOut);
263         }
264         IShellFolder_Release (pSF);
265     }
266
267     TRACE ("-- returning (%p) %08lx\n", *ppvOut, hr);
268
269     return hr;
270 }
271
272 /***********************************************************************
273  *      SHELL32_GetDisplayNameOfChild
274  *
275  * Retrives the display name of a child object of a shellfolder.
276  *
277  * For a pidl eg. [subpidl1][subpidl2][subpidl3]:
278  * - it binds to the child shellfolder [subpidl1]
279  * - asks it for the displayname of [subpidl2][subpidl3]
280  *
281  * Is possible the pidl is a simple pidl. In this case it asks the
282  * subfolder for the displayname of a empty pidl. The subfolder
283  * returns the own displayname eg. "::{guid}". This is used for
284  * virtual folders with the registry key WantsFORPARSING set.
285  */
286 HRESULT SHELL32_GetDisplayNameOfChild (IShellFolder2 * psf,
287                                        LPCITEMIDLIST pidl, DWORD dwFlags, LPSTR szOut, DWORD dwOutLen)
288 {
289     LPITEMIDLIST pidlFirst;
290     HRESULT hr = E_OUTOFMEMORY;
291
292     TRACE ("(%p)->(pidl=%p 0x%08lx %p 0x%08lx)\n", psf, pidl, dwFlags, szOut, dwOutLen);
293     pdump (pidl);
294
295     pidlFirst = ILCloneFirst (pidl);
296     if (pidlFirst) {
297         IShellFolder2 *psfChild;
298
299         hr = IShellFolder_BindToObject (psf, pidlFirst, NULL, &IID_IShellFolder, (LPVOID *) & psfChild);
300         if (SUCCEEDED (hr)) {
301             STRRET strTemp;
302             LPITEMIDLIST pidlNext = ILGetNext (pidl);
303
304             hr = IShellFolder_GetDisplayNameOf (psfChild, pidlNext, dwFlags, &strTemp);
305             if (SUCCEEDED (hr)) {
306                 hr = StrRetToStrNA (szOut, dwOutLen, &strTemp, pidlNext);
307             }
308             IShellFolder_Release (psfChild);
309         }
310         ILFree (pidlFirst);
311     }
312
313     TRACE ("-- ret=0x%08lx %s\n", hr, szOut);
314
315     return hr;
316 }
317
318 /***********************************************************************
319  *  SHELL32_GetItemAttributes
320  *
321  * NOTES
322  * observerd values:
323  *  folder:     0xE0000177      FILESYSTEM | HASSUBFOLDER | FOLDER
324  *  file:       0x40000177      FILESYSTEM
325  *  drive:      0xf0000144      FILESYSTEM | HASSUBFOLDER | FOLDER | FILESYSANCESTOR
326  *  mycomputer: 0xb0000154      HASSUBFOLDER | FOLDER | FILESYSANCESTOR
327  *  (seems to be default for shell extensions if no registry entry exists)
328  *
329  * This functions does not set flags!! It only resets flags when nessesary.
330  */
331 HRESULT SHELL32_GetItemAttributes (IShellFolder * psf, LPITEMIDLIST pidl, LPDWORD pdwAttributes)
332 {
333     GUID const *clsid;
334     DWORD dwAttributes;
335
336     TRACE ("0x%08lx\n", *pdwAttributes);
337
338     if (*pdwAttributes & (0xcff3fe88))
339         WARN ("attribute 0x%08lx not implemented\n", *pdwAttributes);
340     *pdwAttributes &= ~SFGAO_LINK;      /* FIXME: for native filedialogs */
341
342     if (_ILIsDrive (pidl)) {
343         *pdwAttributes &= 0xf0000144;
344     } else if ((clsid = _ILGetGUIDPointer (pidl))) {
345         if (HCR_GetFolderAttributes (clsid, &dwAttributes)) {
346             *pdwAttributes &= dwAttributes;
347         } else {
348             *pdwAttributes &= 0xb0000154;
349         }
350     } else if (_ILGetDataPointer (pidl)) {
351         dwAttributes = _ILGetFileAttributes (pidl, NULL, 0);
352         *pdwAttributes &= ~SFGAO_FILESYSANCESTOR;
353
354         if ((SFGAO_FOLDER & *pdwAttributes) && !(dwAttributes & FILE_ATTRIBUTE_DIRECTORY))
355             *pdwAttributes &= ~(SFGAO_FOLDER | SFGAO_HASSUBFOLDER);
356
357         if ((SFGAO_HIDDEN & *pdwAttributes) && !(dwAttributes & FILE_ATTRIBUTE_HIDDEN))
358             *pdwAttributes &= ~SFGAO_HIDDEN;
359
360         if ((SFGAO_READONLY & *pdwAttributes) && !(dwAttributes & FILE_ATTRIBUTE_READONLY))
361             *pdwAttributes &= ~SFGAO_READONLY;
362     } else {
363         *pdwAttributes &= 0xb0000154;
364     }
365     TRACE ("-- 0x%08lx\n", *pdwAttributes);
366     return S_OK;
367 }
368
369 /***********************************************************************
370  *  SHELL32_GetItemAttributes
371  */
372 HRESULT SHELL32_CompareIDs (IShellFolder * iface, LPARAM lParam, LPCITEMIDLIST pidl1, LPCITEMIDLIST pidl2)
373 {
374     int type1,
375       type2;
376     char szTemp1[MAX_PATH];
377     char szTemp2[MAX_PATH];
378     int nReturn = 0;
379     LPITEMIDLIST firstpidl,
380       nextpidl1,
381       nextpidl2;
382     IShellFolder *psf;
383
384     /* test for empty pidls */
385     BOOL isEmpty1 = _ILIsDesktop (pidl1);
386     BOOL isEmpty2 = _ILIsDesktop (pidl2);
387
388     if (isEmpty1 && isEmpty2)
389         return 0;
390     if (isEmpty1)
391         return -1;
392     if (isEmpty2)
393         return 1;
394
395     /* test for different types. Sort order is the PT_* constant */
396     type1 = _ILGetDataPointer (pidl1)->type;
397     type2 = _ILGetDataPointer (pidl2)->type;
398     if (type1 != type2)
399         return (type1 - type2);
400
401     /* test for name of pidl */
402     _ILSimpleGetText (pidl1, szTemp1, MAX_PATH);
403     _ILSimpleGetText (pidl2, szTemp2, MAX_PATH);
404     nReturn = strcasecmp (szTemp1, szTemp2);
405     if (nReturn != 0)
406         return nReturn;
407
408     /* test of complex pidls */
409     firstpidl = ILCloneFirst (pidl1);
410     nextpidl1 = ILGetNext (pidl1);
411     nextpidl2 = ILGetNext (pidl2);
412
413     /* optimizing: test special cases and bind not deeper */
414     /* the deeper shellfolder would do the same */
415     isEmpty1 = _ILIsDesktop (nextpidl1);
416     isEmpty2 = _ILIsDesktop (nextpidl2);
417
418     if (isEmpty1 && isEmpty2) {
419         nReturn = 0;
420     } else if (isEmpty1) {
421         nReturn = -1;
422     } else if (isEmpty2) {
423         nReturn = 1;
424     /* optimizing end */
425     } else if (SUCCEEDED (IShellFolder_BindToObject (iface, firstpidl, NULL, &IID_IShellFolder, (LPVOID *) & psf))) {
426         nReturn = IShellFolder_CompareIDs (psf, lParam, nextpidl1, nextpidl2);
427         IShellFolder_Release (psf);
428     }
429     ILFree (firstpidl);
430     return nReturn;
431 }