Added tests for SHGetPathFromIDList.
[wine] / dlls / shell32 / folders.c
1 /*
2  *      Copyright 1997  Marcus Meissner
3  *      Copyright 1998  Juergen Schmied
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18  */
19
20 #include "config.h"
21 #include "wine/port.h"
22
23 #include <stdlib.h>
24 #include <stdarg.h>
25 #include <stdio.h>
26 #include <string.h>
27
28 #define COBJMACROS
29
30 #include "windef.h"
31 #include "winbase.h"
32 #include "winerror.h"
33 #include "objbase.h"
34 #include "undocshell.h"
35 #include "shlguid.h"
36 #include "winreg.h"
37
38 #include "wine/debug.h"
39
40 #include "pidl.h"
41 #include "shell32_main.h"
42 #include "shfldr.h"
43 #include "shresdef.h"
44
45 WINE_DEFAULT_DEBUG_CHANNEL(shell);
46
47 /***********************************************************************
48 *   IExtractIconW implementation
49 */
50 typedef struct
51 {
52         const IExtractIconWVtbl *lpVtbl;
53         DWORD              ref;
54         const IPersistFileVtbl  *lpvtblPersistFile;
55         const IExtractIconAVtbl *lpvtblExtractIconA;
56         LPITEMIDLIST       pidl;
57 } IExtractIconWImpl;
58
59 static const IExtractIconAVtbl eiavt;
60 static const IExtractIconWVtbl eivt;
61 static const IPersistFileVtbl pfvt;
62
63 #define _IPersistFile_Offset ((int)(&(((IExtractIconWImpl*)0)->lpvtblPersistFile)))
64 #define _ICOM_THIS_From_IPersistFile(class, name) class* This = (class*)(((char*)name)-_IPersistFile_Offset);
65
66 #define _IExtractIconA_Offset ((int)(&(((IExtractIconWImpl*)0)->lpvtblExtractIconA)))
67 #define _ICOM_THIS_From_IExtractIconA(class, name) class* This = (class*)(((char*)name)-_IExtractIconA_Offset);
68
69 /**************************************************************************
70 *  IExtractIconW_Constructor
71 */
72 IExtractIconW* IExtractIconW_Constructor(LPCITEMIDLIST pidl)
73 {
74         IExtractIconWImpl* ei;
75         
76         TRACE("%p\n", pidl);
77
78         ei = HeapAlloc(GetProcessHeap(),0,sizeof(IExtractIconWImpl));
79         ei->ref=1;
80         ei->lpVtbl = &eivt;
81         ei->lpvtblPersistFile = &pfvt;
82         ei->lpvtblExtractIconA = &eiavt;
83         ei->pidl=ILClone(pidl);
84
85         pdump(pidl);
86
87         TRACE("(%p)\n", ei);
88         return (IExtractIconW *)ei;
89 }
90 /**************************************************************************
91  *  IExtractIconW_QueryInterface
92  */
93 static HRESULT WINAPI IExtractIconW_fnQueryInterface(IExtractIconW *iface, REFIID riid, LPVOID *ppvObj)
94 {
95         IExtractIconWImpl *This = (IExtractIconWImpl *)iface;
96
97         TRACE("(%p)->(\n\tIID:\t%s,%p)\n", This, debugstr_guid(riid), ppvObj);
98
99         *ppvObj = NULL;
100
101         if (IsEqualIID(riid, &IID_IUnknown))                            /*IUnknown*/
102         {
103           *ppvObj = This;
104         }
105         else if (IsEqualIID(riid, &IID_IPersistFile))   /*IExtractIcon*/
106         {
107           *ppvObj = (IPersistFile*)&(This->lpvtblPersistFile);
108         }
109         else if (IsEqualIID(riid, &IID_IExtractIconA))  /*IExtractIcon*/
110         {
111           *ppvObj = (IExtractIconA*)&(This->lpvtblExtractIconA);
112         }
113         else if (IsEqualIID(riid, &IID_IExtractIconW))  /*IExtractIcon*/
114         {
115           *ppvObj = (IExtractIconW*)This;
116         }
117
118         if(*ppvObj)
119         {
120           IExtractIconW_AddRef((IExtractIconW*) *ppvObj);
121           TRACE("-- Interface: (%p)->(%p)\n",ppvObj,*ppvObj);
122           return S_OK;
123         }
124         TRACE("-- Interface: E_NOINTERFACE\n");
125         return E_NOINTERFACE;
126 }
127
128 /**************************************************************************
129 *  IExtractIconW_AddRef
130 */
131 static ULONG WINAPI IExtractIconW_fnAddRef(IExtractIconW * iface)
132 {
133         IExtractIconWImpl *This = (IExtractIconWImpl *)iface;
134         ULONG refCount = InterlockedIncrement(&This->ref);
135
136         TRACE("(%p)->(count=%lu)\n", This, refCount - 1);
137
138         return refCount;
139 }
140 /**************************************************************************
141 *  IExtractIconW_Release
142 */
143 static ULONG WINAPI IExtractIconW_fnRelease(IExtractIconW * iface)
144 {
145         IExtractIconWImpl *This = (IExtractIconWImpl *)iface;
146         ULONG refCount = InterlockedDecrement(&This->ref);
147
148         TRACE("(%p)->(count=%lu)\n", This, refCount + 1);
149
150         if (!refCount)
151         {
152           TRACE(" destroying IExtractIcon(%p)\n",This);
153           SHFree(This->pidl);
154           HeapFree(GetProcessHeap(),0,This);
155           return 0;
156         }
157         return refCount;
158 }
159
160 static HRESULT getIconLocationForFolder(IExtractIconW *iface, UINT uFlags,
161  LPWSTR szIconFile, UINT cchMax, int *piIndex, UINT *pwFlags)
162 {
163     IExtractIconWImpl *This = (IExtractIconWImpl *)iface;
164     DWORD dwNr;
165     WCHAR wszPath[MAX_PATH];
166     WCHAR wszCLSIDValue[CHARS_IN_GUID];
167     static const WCHAR shellClassInfo[] = { '.','S','h','e','l','l','C','l','a','s','s','I','n','f','o',0 };
168     static const WCHAR iconFile[] = { 'I','c','o','n','F','i','l','e',0 };
169     static const WCHAR clsid[] = { 'C','L','S','I','D',0 };
170     static const WCHAR clsid2[] = { 'C','L','S','I','D','2',0 };
171     static const WCHAR iconIndex[] = { 'I','c','o','n','I','n','d','e','x',0 };
172
173     if (SHELL32_GetCustomFolderAttribute(This->pidl, shellClassInfo, iconFile,
174         wszPath, MAX_PATH))
175     {
176         WCHAR wszIconIndex[10];
177         SHELL32_GetCustomFolderAttribute(This->pidl, shellClassInfo, iconIndex,
178             wszIconIndex, 10);
179         *piIndex = atoiW(wszIconIndex);
180     }
181     else if (SHELL32_GetCustomFolderAttribute(This->pidl, shellClassInfo, clsid,
182         wszCLSIDValue, CHARS_IN_GUID) &&
183         HCR_GetDefaultIconW(wszCLSIDValue, szIconFile, cchMax, &dwNr))
184     {
185        *piIndex = dwNr;
186     }
187     else if (SHELL32_GetCustomFolderAttribute(This->pidl, shellClassInfo, clsid2,
188         wszCLSIDValue, CHARS_IN_GUID) &&
189         HCR_GetDefaultIconW(wszCLSIDValue, szIconFile, cchMax, &dwNr))
190     {
191        *piIndex = dwNr;
192     }
193     else
194     {
195         static const WCHAR folder[] = { 'F','o','l','d','e','r',0 };
196
197         if (!HCR_GetDefaultIconW(folder, szIconFile, cchMax, &dwNr))
198         {
199             lstrcpynW(szIconFile, swShell32Name, cchMax);
200             dwNr = IDI_SHELL_FOLDER;
201         }
202         *piIndex = -((uFlags & GIL_OPENICON) ? dwNr + 1 : dwNr);
203     }
204     return S_OK;
205 }
206
207 WCHAR swShell32Name[MAX_PATH];
208
209 /**************************************************************************
210 *  IExtractIconW_GetIconLocation
211 *
212 * mapping filetype to icon
213 */
214 static HRESULT WINAPI IExtractIconW_fnGetIconLocation(
215         IExtractIconW * iface,
216         UINT uFlags,            /* GIL_ flags */
217         LPWSTR szIconFile,
218         UINT cchMax,
219         int * piIndex,
220         UINT * pwFlags)         /* returned GIL_ flags */
221 {
222         IExtractIconWImpl *This = (IExtractIconWImpl *)iface;
223
224         char    sTemp[MAX_PATH];
225         DWORD   dwNr;
226         GUID const * riid;
227         LPITEMIDLIST    pSimplePidl = ILFindLastID(This->pidl);
228
229         TRACE("(%p) (flags=%u %p %u %p %p)\n", This, uFlags, szIconFile, cchMax, piIndex, pwFlags);
230
231         if (pwFlags)
232           *pwFlags = 0;
233
234         if (_ILIsDesktop(pSimplePidl))
235         {
236           lstrcpynW(szIconFile, swShell32Name, cchMax);
237           *piIndex = -IDI_SHELL_DESKTOP;
238         }
239
240         /* my computer and other shell extensions */
241         else if ((riid = _ILGetGUIDPointer(pSimplePidl)))
242         {
243           static const WCHAR fmt[] = { 'C','L','S','I','D','\\',
244        '{','%','0','8','l','x','-','%','0','4','x','-','%','0','4','x','-',
245        '%','0','2','x','%','0','2','x','-','%','0','2','x', '%','0','2','x',
246        '%','0','2','x','%','0','2','x','%','0','2','x','%','0','2','x','}',0 };
247           WCHAR xriid[50];
248
249           sprintfW(xriid, fmt,
250                   riid->Data1, riid->Data2, riid->Data3,
251                   riid->Data4[0], riid->Data4[1], riid->Data4[2], riid->Data4[3],
252                   riid->Data4[4], riid->Data4[5], riid->Data4[6], riid->Data4[7]);
253
254           if (HCR_GetDefaultIconW(xriid, szIconFile, cchMax, &dwNr))
255           {
256             *piIndex = dwNr;
257           }
258           else
259           {
260             lstrcpynW(szIconFile, swShell32Name, cchMax);
261             if(IsEqualGUID(riid, &CLSID_MyComputer))
262                 *piIndex = -IDI_SHELL_MY_COMPUTER;
263             else if(IsEqualGUID(riid, &CLSID_MyDocuments))
264                 *piIndex = -IDI_SHELL_FOLDER;
265             else if(IsEqualGUID(riid, &CLSID_NetworkPlaces))
266                 *piIndex = -IDI_SHELL_MY_NETWORK_PLACES;
267             else if(IsEqualGUID(riid, &CLSID_UnixFolder) ||
268                     IsEqualGUID(riid, &CLSID_UnixDosFolder))
269                 *piIndex = -IDI_SHELL_DRIVE;
270             else
271                 *piIndex = -IDI_SHELL_FOLDER;
272           }
273         }
274
275         else if (_ILIsDrive (pSimplePidl))
276         {
277           static const WCHAR drive[] = { 'D','r','i','v','e',0 };
278
279           int icon_idx = -1;
280
281           if (_ILGetDrive(pSimplePidl, sTemp, MAX_PATH))
282           {
283                 switch(GetDriveTypeA(sTemp))
284                 {
285                   case DRIVE_REMOVABLE:   icon_idx = IDI_SHELL_FLOPPY;        break;
286                   case DRIVE_CDROM:       icon_idx = IDI_SHELL_CDROM;         break;
287                   case DRIVE_REMOTE:      icon_idx = IDI_SHELL_NETDRIVE;      break;
288                   case DRIVE_RAMDISK:     icon_idx = IDI_SHELL_RAMDISK;       break;
289                 }
290           }
291
292           if (icon_idx != -1)
293           {
294                 lstrcpynW(szIconFile, swShell32Name, cchMax);
295                 *piIndex = -icon_idx;
296           }
297           else
298           {
299                 if (HCR_GetDefaultIconW(drive, szIconFile, cchMax, &dwNr))
300                 {
301                   *piIndex = dwNr;
302                 }
303                 else
304                 {
305                   lstrcpynW(szIconFile, swShell32Name, cchMax);
306                   *piIndex = -IDI_SHELL_DRIVE;
307                 }
308           }
309         }
310         else if (_ILIsFolder (pSimplePidl))
311         {
312             getIconLocationForFolder(iface, uFlags, szIconFile, cchMax, piIndex,
313                                      pwFlags);
314         }
315         else
316         {
317           BOOL found = FALSE;
318
319           if (_ILIsCPanelStruct(pSimplePidl))
320           {
321             if (SUCCEEDED(CPanel_GetIconLocationW(pSimplePidl, szIconFile, cchMax, piIndex)))
322                 found = TRUE;
323           }
324           else if (_ILGetExtension(pSimplePidl, sTemp, MAX_PATH))
325           {
326             if (HCR_MapTypeToValueA(sTemp, sTemp, MAX_PATH, TRUE)
327                 && HCR_GetDefaultIconA(sTemp, sTemp, MAX_PATH, &dwNr))
328             {
329               if (!lstrcmpA("%1", sTemp))               /* icon is in the file */
330               {
331                 SHGetPathFromIDListW(This->pidl, szIconFile);
332                 *piIndex = 0;
333               }
334               else
335               {
336                 MultiByteToWideChar(CP_ACP, 0, sTemp, -1, szIconFile, cchMax);
337                 *piIndex = dwNr;
338               }
339
340               found = TRUE;
341             }
342             else if (!lstrcmpiA(sTemp, "lnkfile"))
343             {
344               /* extract icon from shell shortcut */
345               IShellFolder* dsf;
346               IShellLinkW* psl;
347
348               if (SUCCEEDED(SHGetDesktopFolder(&dsf)))
349               {
350                 HRESULT hr = IShellFolder_GetUIObjectOf(dsf, NULL, 1, (LPCITEMIDLIST*)&This->pidl, &IID_IShellLinkW, NULL, (LPVOID*)&psl);
351
352                 if (SUCCEEDED(hr))
353                 {
354                   hr = IShellLinkW_GetIconLocation(psl, szIconFile, MAX_PATH, piIndex);
355
356                   if (SUCCEEDED(hr) && *szIconFile)
357                     found = TRUE;
358
359                   IShellLinkW_Release(psl);
360                 }
361
362                 IShellFolder_Release(dsf);
363               }
364             }
365           }
366
367           if (!found)                                   /* default icon */
368           {
369             lstrcpynW(szIconFile, swShell32Name, cchMax);
370             *piIndex = 0;
371           }
372         }
373
374         TRACE("-- %s %x\n", debugstr_w(szIconFile), *piIndex);
375         return NOERROR;
376 }
377
378 /**************************************************************************
379 *  IExtractIconW_Extract
380 */
381 static HRESULT WINAPI IExtractIconW_fnExtract(IExtractIconW * iface, LPCWSTR pszFile, UINT nIconIndex, HICON *phiconLarge, HICON *phiconSmall, UINT nIconSize)
382 {
383         IExtractIconWImpl *This = (IExtractIconWImpl *)iface;
384         int index;
385
386         FIXME("(%p) (file=%p index=%d %p %p size=%08x) semi-stub\n", This, debugstr_w(pszFile), (signed)nIconIndex,
387               phiconLarge, phiconSmall, nIconSize);
388
389         index = SIC_GetIconIndex(pszFile, nIconIndex, 0);
390
391         if (phiconLarge)
392           *phiconLarge = ImageList_GetIcon(ShellBigIconList, index, ILD_TRANSPARENT);
393
394         if (phiconSmall)
395           *phiconSmall = ImageList_GetIcon(ShellSmallIconList, index, ILD_TRANSPARENT);
396
397         return S_OK;
398 }
399
400 static const IExtractIconWVtbl eivt =
401 {
402         IExtractIconW_fnQueryInterface,
403         IExtractIconW_fnAddRef,
404         IExtractIconW_fnRelease,
405         IExtractIconW_fnGetIconLocation,
406         IExtractIconW_fnExtract
407 };
408
409 /**************************************************************************
410 *  IExtractIconA_Constructor
411 */
412 IExtractIconA* IExtractIconA_Constructor(LPCITEMIDLIST pidl)
413 {
414         IExtractIconWImpl *This = (IExtractIconWImpl *)IExtractIconW_Constructor(pidl);
415         IExtractIconA *eia = (IExtractIconA *)&This->lpvtblExtractIconA;
416         
417         TRACE("(%p)->(%p)\n", This, eia);
418         return eia;
419 }
420 /**************************************************************************
421  *  IExtractIconA_QueryInterface
422  */
423 static HRESULT WINAPI IExtractIconA_fnQueryInterface(IExtractIconA * iface, REFIID riid, LPVOID *ppvObj)
424 {
425         _ICOM_THIS_From_IExtractIconA(IExtractIconW, iface);
426
427         return IExtractIconW_QueryInterface(This, riid, ppvObj);
428 }
429
430 /**************************************************************************
431 *  IExtractIconA_AddRef
432 */
433 static ULONG WINAPI IExtractIconA_fnAddRef(IExtractIconA * iface)
434 {
435         _ICOM_THIS_From_IExtractIconA(IExtractIconW, iface);
436
437         return IExtractIconW_AddRef(This);
438 }
439 /**************************************************************************
440 *  IExtractIconA_Release
441 */
442 static ULONG WINAPI IExtractIconA_fnRelease(IExtractIconA * iface)
443 {
444         _ICOM_THIS_From_IExtractIconA(IExtractIconW, iface);
445
446         return IExtractIconW_AddRef(This);
447 }
448 /**************************************************************************
449 *  IExtractIconA_GetIconLocation
450 *
451 * mapping filetype to icon
452 */
453 static HRESULT WINAPI IExtractIconA_fnGetIconLocation(
454         IExtractIconA * iface,
455         UINT uFlags,
456         LPSTR szIconFile,
457         UINT cchMax,
458         int * piIndex,
459         UINT * pwFlags)
460 {
461         HRESULT ret;
462         LPWSTR lpwstrFile = HeapAlloc(GetProcessHeap(), 0, cchMax * sizeof(WCHAR));
463         _ICOM_THIS_From_IExtractIconA(IExtractIconW, iface);
464         
465         TRACE("(%p) (flags=%u %p %u %p %p)\n", This, uFlags, szIconFile, cchMax, piIndex, pwFlags);
466
467         ret = IExtractIconW_GetIconLocation(This, uFlags, lpwstrFile, cchMax, piIndex, pwFlags);
468         WideCharToMultiByte(CP_ACP, 0, lpwstrFile, -1, szIconFile, cchMax, NULL, NULL);
469         HeapFree(GetProcessHeap(), 0, lpwstrFile);
470
471         TRACE("-- %s %x\n", szIconFile, *piIndex);
472         return ret;
473 }
474 /**************************************************************************
475 *  IExtractIconA_Extract
476 */
477 static HRESULT WINAPI IExtractIconA_fnExtract(IExtractIconA * iface, LPCSTR pszFile, UINT nIconIndex, HICON *phiconLarge, HICON *phiconSmall, UINT nIconSize)
478 {
479         HRESULT ret;
480         INT len = MultiByteToWideChar(CP_ACP, 0, pszFile, -1, NULL, 0);
481         LPWSTR lpwstrFile = HeapAlloc(GetProcessHeap(), 0, len * sizeof(WCHAR));
482         _ICOM_THIS_From_IExtractIconA(IExtractIconW, iface);
483
484         TRACE("(%p) (file=%p index=%u %p %p size=%u)\n", This, pszFile, nIconIndex, phiconLarge, phiconSmall, nIconSize);
485
486         MultiByteToWideChar(CP_ACP, 0, pszFile, -1, lpwstrFile, len);
487         ret = IExtractIconW_Extract(This, lpwstrFile, nIconIndex, phiconLarge, phiconSmall, nIconSize);
488         HeapFree(GetProcessHeap(), 0, lpwstrFile);
489         return ret;
490 }
491
492 static const IExtractIconAVtbl eiavt =
493 {
494         IExtractIconA_fnQueryInterface,
495         IExtractIconA_fnAddRef,
496         IExtractIconA_fnRelease,
497         IExtractIconA_fnGetIconLocation,
498         IExtractIconA_fnExtract
499 };
500
501 /************************************************************************
502  * IEIPersistFile_QueryInterface (IUnknown)
503  */
504 static HRESULT WINAPI IEIPersistFile_fnQueryInterface(
505         IPersistFile    *iface,
506         REFIID          iid,
507         LPVOID          *ppvObj)
508 {
509         _ICOM_THIS_From_IPersistFile(IExtractIconW, iface);
510
511         return IExtractIconW_QueryInterface(This, iid, ppvObj);
512 }
513
514 /************************************************************************
515  * IEIPersistFile_AddRef (IUnknown)
516  */
517 static ULONG WINAPI IEIPersistFile_fnAddRef(
518         IPersistFile    *iface)
519 {
520         _ICOM_THIS_From_IPersistFile(IExtractIconW, iface);
521
522         return IExtractIconW_AddRef(This);
523 }
524
525 /************************************************************************
526  * IEIPersistFile_Release (IUnknown)
527  */
528 static ULONG WINAPI IEIPersistFile_fnRelease(
529         IPersistFile    *iface)
530 {
531         _ICOM_THIS_From_IPersistFile(IExtractIconW, iface);
532
533         return IExtractIconW_Release(This);
534 }
535
536 /************************************************************************
537  * IEIPersistFile_GetClassID (IPersist)
538  */
539 static HRESULT WINAPI IEIPersistFile_fnGetClassID(
540         IPersistFile    *iface,
541         LPCLSID         lpClassId)
542 {
543         CLSID StdFolderID = { 0x00000000, 0x0000, 0x0000, {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00} };
544
545         if (lpClassId==NULL)
546           return E_POINTER;
547
548         memcpy(lpClassId, &StdFolderID, sizeof(StdFolderID));
549
550         return S_OK;
551 }
552
553 /************************************************************************
554  * IEIPersistFile_Load (IPersistFile)
555  */
556 static HRESULT WINAPI IEIPersistFile_fnLoad(IPersistFile* iface, LPCOLESTR pszFileName, DWORD dwMode)
557 {
558         _ICOM_THIS_From_IPersistFile(IExtractIconW, iface);
559         FIXME("%p\n", This);
560         return E_NOTIMPL;
561
562 }
563
564 static const IPersistFileVtbl pfvt =
565 {
566         IEIPersistFile_fnQueryInterface,
567         IEIPersistFile_fnAddRef,
568         IEIPersistFile_fnRelease,
569         IEIPersistFile_fnGetClassID,
570         (void *) 0xdeadbeef /* IEIPersistFile_fnIsDirty */,
571         IEIPersistFile_fnLoad,
572         (void *) 0xdeadbeef /* IEIPersistFile_fnSave */,
573         (void *) 0xdeadbeef /* IEIPersistFile_fnSaveCompleted */,
574         (void *) 0xdeadbeef /* IEIPersistFile_fnGetCurFile */
575 };