Fix segmentation fault caused by incorrect referencing of client audio
[wine] / dlls / shell32 / iconcache.c
1 /*
2  *      shell icon cache (SIC)
3  *
4  * Copyright 1998, 1999 Juergen Schmied
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  */
20
21 #include "config.h"
22 #include "wine/port.h"
23
24 #include <stdarg.h>
25 #include <string.h>
26 #include <sys/types.h>
27 #ifdef HAVE_UNISTD_H
28 # include <unistd.h>
29 #endif
30
31 #define COBJMACROS
32
33 #include "windef.h"
34 #include "winbase.h"
35 #include "wingdi.h"
36 #include "winuser.h"
37 #include "winreg.h"
38 #include "wine/debug.h"
39
40 #include "shellapi.h"
41 #include "objbase.h"
42 #include "shlguid.h"
43 #include "pidl.h"
44 #include "shell32_main.h"
45 #include "undocshell.h"
46
47 WINE_DEFAULT_DEBUG_CHANNEL(shell);
48
49 /********************** THE ICON CACHE ********************************/
50
51 #define INVALID_INDEX -1
52
53 typedef struct
54 {
55         LPWSTR sSourceFile;     /* file (not path!) containing the icon */
56         DWORD dwSourceIndex;    /* index within the file, if it is a resoure ID it will be negated */
57         DWORD dwListIndex;      /* index within the iconlist */
58         DWORD dwFlags;          /* GIL_* flags */
59         DWORD dwAccessTime;
60 } SIC_ENTRY, * LPSIC_ENTRY;
61
62 static HDPA             sic_hdpa = 0;
63
64 static CRITICAL_SECTION SHELL32_SicCS;
65 static CRITICAL_SECTION_DEBUG critsect_debug =
66 {
67     0, 0, &SHELL32_SicCS,
68     { &critsect_debug.ProcessLocksList, &critsect_debug.ProcessLocksList },
69       0, 0, { 0, (DWORD)(__FILE__ ": SHELL32_SicCS") }
70 };
71 static CRITICAL_SECTION SHELL32_SicCS = { &critsect_debug, -1, 0, 0, 0, 0 };
72
73 /*****************************************************************************
74  * SIC_CompareEntries
75  *
76  * NOTES
77  *  Callback for DPA_Search
78  */
79 static INT CALLBACK SIC_CompareEntries( LPVOID p1, LPVOID p2, LPARAM lparam)
80 {       TRACE("%p %p %8lx\n", p1, p2, lparam);
81
82         if (((LPSIC_ENTRY)p1)->dwSourceIndex != ((LPSIC_ENTRY)p2)->dwSourceIndex) /* first the faster one*/
83           return 1;
84
85         if (strcmpiW(((LPSIC_ENTRY)p1)->sSourceFile,((LPSIC_ENTRY)p2)->sSourceFile))
86           return 1;
87
88         return 0;
89 }
90 /*****************************************************************************
91  * SIC_IconAppend                       [internal]
92  *
93  * NOTES
94  *  appends an icon pair to the end of the cache
95  */
96 static INT SIC_IconAppend (LPCWSTR sSourceFile, INT dwSourceIndex, HICON hSmallIcon, HICON hBigIcon)
97 {       LPSIC_ENTRY lpsice;
98         INT ret, index, index1;
99         WCHAR path[MAX_PATH];
100         TRACE("%s %i %p %p\n", debugstr_w(sSourceFile), dwSourceIndex, hSmallIcon ,hBigIcon);
101
102         lpsice = (LPSIC_ENTRY) SHAlloc (sizeof (SIC_ENTRY));
103
104        GetFullPathNameW(sSourceFile, MAX_PATH, path, NULL);
105         lpsice->sSourceFile = HeapAlloc( GetProcessHeap(), 0, (strlenW(path)+1)*sizeof(WCHAR) );
106         strcpyW( lpsice->sSourceFile, path );
107
108         lpsice->dwSourceIndex = dwSourceIndex;
109
110         EnterCriticalSection(&SHELL32_SicCS);
111
112         index = DPA_InsertPtr(sic_hdpa, 0x7fff, lpsice);
113         if ( INVALID_INDEX == index )
114         {
115           HeapFree(GetProcessHeap(), 0, lpsice->sSourceFile);
116           SHFree(lpsice);
117           ret = INVALID_INDEX;
118         }
119         else
120         {
121           index = ImageList_AddIcon (ShellSmallIconList, hSmallIcon);
122           index1= ImageList_AddIcon (ShellBigIconList, hBigIcon);
123
124           if (index!=index1)
125           {
126             FIXME("iconlists out of sync 0x%x 0x%x\n", index, index1);
127           }
128           lpsice->dwListIndex = index;
129           ret = lpsice->dwListIndex;
130         }
131
132         LeaveCriticalSection(&SHELL32_SicCS);
133         return ret;
134 }
135 /****************************************************************************
136  * SIC_LoadIcon                         [internal]
137  *
138  * NOTES
139  *  gets small/big icon by number from a file
140  */
141 static INT SIC_LoadIcon (LPCWSTR sSourceFile, INT dwSourceIndex)
142 {       HICON   hiconLarge=0;
143         HICON   hiconSmall=0;
144
145         PrivateExtractIconsW( sSourceFile, dwSourceIndex, 32, 32, &hiconLarge, 0, 1, 0 );
146         PrivateExtractIconsW( sSourceFile, dwSourceIndex, 16, 16, &hiconSmall, 0, 1, 0 );
147
148         if ( !hiconLarge ||  !hiconSmall)
149         {
150           WARN("failure loading icon %i from %s (%p %p)\n", dwSourceIndex, debugstr_w(sSourceFile), hiconLarge, hiconSmall);
151           return -1;
152         }
153         return SIC_IconAppend (sSourceFile, dwSourceIndex, hiconSmall, hiconLarge);
154 }
155 /*****************************************************************************
156  * SIC_GetIconIndex                     [internal]
157  *
158  * Parameters
159  *      sSourceFile     [IN]    filename of file containing the icon
160  *      index           [IN]    index/resID (negated) in this file
161  *
162  * NOTES
163  *  look in the cache for a proper icon. if not available the icon is taken
164  *  from the file and cached
165  */
166 INT SIC_GetIconIndex (LPCWSTR sSourceFile, INT dwSourceIndex )
167 {
168         SIC_ENTRY sice;
169         INT ret, index = INVALID_INDEX;
170         WCHAR path[MAX_PATH];
171
172         TRACE("%s %i\n", debugstr_w(sSourceFile), dwSourceIndex);
173
174         GetFullPathNameW(sSourceFile, MAX_PATH, path, NULL);
175         sice.sSourceFile = path;
176         sice.dwSourceIndex = dwSourceIndex;
177
178         EnterCriticalSection(&SHELL32_SicCS);
179
180         if (NULL != DPA_GetPtr (sic_hdpa, 0))
181         {
182           /* search linear from position 0*/
183           index = DPA_Search (sic_hdpa, &sice, 0, SIC_CompareEntries, 0, 0);
184         }
185
186         if ( INVALID_INDEX == index )
187         {
188           ret = SIC_LoadIcon (sSourceFile, dwSourceIndex);
189         }
190         else
191         {
192           TRACE("-- found\n");
193           ret = ((LPSIC_ENTRY)DPA_GetPtr(sic_hdpa, index))->dwListIndex;
194         }
195
196         LeaveCriticalSection(&SHELL32_SicCS);
197         return ret;
198 }
199 /*****************************************************************************
200  * SIC_Initialize                       [internal]
201  *
202  * NOTES
203  *  hack to load the resources from the shell32.dll under a different dll name
204  *  will be removed when the resource-compiler is ready
205  */
206 BOOL SIC_Initialize(void)
207 {
208         HICON           hSm, hLg;
209         UINT            index;
210         int             cx_small, cy_small;
211         int             cx_large, cy_large;
212
213         cx_small = GetSystemMetrics(SM_CXSMICON);
214         cy_small = GetSystemMetrics(SM_CYSMICON);
215         cx_large = GetSystemMetrics(SM_CXICON);
216         cy_large = GetSystemMetrics(SM_CYICON);
217
218         TRACE("\n");
219
220         if (sic_hdpa)   /* already initialized?*/
221           return TRUE;
222
223         sic_hdpa = DPA_Create(16);
224
225         if (!sic_hdpa)
226         {
227           return(FALSE);
228         }
229
230        ShellSmallIconList = ImageList_Create(16,16,ILC_COLOR32|ILC_MASK,0,0x20);
231        ShellBigIconList = ImageList_Create(32,32,ILC_COLOR32|ILC_MASK,0,0x20);
232
233        ImageList_SetBkColor(ShellSmallIconList, CLR_NONE);
234        ImageList_SetBkColor(ShellBigIconList, CLR_NONE);
235
236         for (index=1; index<39; index++)
237         {
238           hSm = (HICON)LoadImageA(shell32_hInstance, MAKEINTRESOURCEA(index), IMAGE_ICON, cx_small, cy_small, LR_SHARED);
239           hLg = (HICON)LoadImageA(shell32_hInstance, MAKEINTRESOURCEA(index), IMAGE_ICON, cx_large, cy_large, LR_SHARED);
240
241           if(!hSm)
242           {
243             hSm = LoadImageA(shell32_hInstance, MAKEINTRESOURCEA(1), IMAGE_ICON, cx_small, cy_small, LR_SHARED);
244             hLg = LoadImageA(shell32_hInstance, MAKEINTRESOURCEA(1), IMAGE_ICON, cx_large, cy_large, LR_SHARED);
245           }
246          SIC_IconAppend (swShell32Name, index - 1, hSm, hLg);
247          SIC_IconAppend (swShell32Name, -index, hSm, hLg);
248         }
249
250         TRACE("hIconSmall=%p hIconBig=%p\n",ShellSmallIconList, ShellBigIconList);
251
252         return TRUE;
253 }
254 /*************************************************************************
255  * SIC_Destroy
256  *
257  * frees the cache
258  */
259 static INT CALLBACK sic_free( LPVOID ptr, LPVOID lparam )
260 {
261         HeapFree(GetProcessHeap(), 0, ((LPSIC_ENTRY)ptr)->sSourceFile);
262         SHFree(ptr);
263         return TRUE;
264 }
265
266 void SIC_Destroy(void)
267 {
268         TRACE("\n");
269
270         EnterCriticalSection(&SHELL32_SicCS);
271
272         if (sic_hdpa) DPA_DestroyCallback(sic_hdpa, sic_free, NULL );
273
274         sic_hdpa = NULL;
275         ImageList_Destroy(ShellSmallIconList);
276         ShellSmallIconList = 0;
277         ImageList_Destroy(ShellBigIconList);
278         ShellBigIconList = 0;
279
280         LeaveCriticalSection(&SHELL32_SicCS);
281         DeleteCriticalSection(&SHELL32_SicCS);
282 }
283
284 /*************************************************************************
285  * Shell_GetImageList                   [SHELL32.71]
286  *
287  * PARAMETERS
288  *  imglist[1|2] [OUT] pointer which receives imagelist handles
289  *
290  */
291 BOOL WINAPI Shell_GetImageList(HIMAGELIST * lpBigList, HIMAGELIST * lpSmallList)
292 {       TRACE("(%p,%p)\n",lpBigList,lpSmallList);
293         if (lpBigList)
294         { *lpBigList = ShellBigIconList;
295         }
296         if (lpSmallList)
297         { *lpSmallList = ShellSmallIconList;
298         }
299
300         return TRUE;
301 }
302 /*************************************************************************
303  * PidlToSicIndex                       [INTERNAL]
304  *
305  * PARAMETERS
306  *      sh      [IN]    IShellFolder
307  *      pidl    [IN]
308  *      bBigIcon [IN]
309  *      uFlags  [IN]    GIL_*
310  *      pIndex  [OUT]   index within the SIC
311  *
312  */
313 BOOL PidlToSicIndex (
314         IShellFolder * sh,
315         LPCITEMIDLIST pidl,
316         BOOL bBigIcon,
317         UINT uFlags,
318         int * pIndex)
319 {
320         IExtractIconW   *ei;
321         WCHAR           szIconFile[MAX_PATH];   /* file containing the icon */
322         INT             iSourceIndex;           /* index or resID(negated) in this file */
323         BOOL            ret = FALSE;
324         UINT            dwFlags = 0;
325
326         TRACE("sf=%p pidl=%p %s\n", sh, pidl, bBigIcon?"Big":"Small");
327
328         if (SUCCEEDED (IShellFolder_GetUIObjectOf(sh, 0, 1, &pidl, &IID_IExtractIconW, 0, (void **)&ei)))
329         {
330           if (SUCCEEDED(IExtractIconW_GetIconLocation(ei, uFlags, szIconFile, MAX_PATH, &iSourceIndex, &dwFlags)))
331           {
332             *pIndex = SIC_GetIconIndex(szIconFile, iSourceIndex);
333             ret = TRUE;
334           }
335           IExtractIconW_Release(ei);
336         }
337
338         if (INVALID_INDEX == *pIndex)   /* default icon when failed */
339           *pIndex = 0;
340
341         return ret;
342
343 }
344
345 /*************************************************************************
346  * SHMapPIDLToSystemImageListIndex      [SHELL32.77]
347  *
348  * PARAMETERS
349  *      sh      [IN]            pointer to an instance of IShellFolder
350  *      pidl    [IN]
351  *      pIndex  [OUT][OPTIONAL] SIC index for big icon
352  *
353  */
354 int WINAPI SHMapPIDLToSystemImageListIndex(
355         IShellFolder *sh,
356         LPCITEMIDLIST pidl,
357         int *pIndex)
358 {
359         int Index;
360
361         TRACE("(SF=%p,pidl=%p,%p)\n",sh,pidl,pIndex);
362         pdump(pidl);
363
364         if (pIndex)
365           PidlToSicIndex ( sh, pidl, 1, 0, pIndex);
366         PidlToSicIndex ( sh, pidl, 0, 0, &Index);
367         return Index;
368 }
369
370 /*************************************************************************
371  * Shell_GetCachedImageIndex            [SHELL32.72]
372  *
373  */
374 INT WINAPI Shell_GetCachedImageIndexA(LPCSTR szPath, INT nIndex, BOOL bSimulateDoc)
375 {
376         INT ret, len;
377         LPWSTR szTemp;
378
379         WARN("(%s,%08x,%08x) semi-stub.\n",debugstr_a(szPath), nIndex, bSimulateDoc);
380
381         len = MultiByteToWideChar( CP_ACP, 0, szPath, -1, NULL, 0 );
382         szTemp = HeapAlloc( GetProcessHeap(), 0, len * sizeof(WCHAR) );
383         MultiByteToWideChar( CP_ACP, 0, szPath, -1, szTemp, len );
384
385         ret = SIC_GetIconIndex( szTemp, nIndex );
386
387         HeapFree( GetProcessHeap(), 0, szTemp );
388
389         return ret;
390 }
391
392 INT WINAPI Shell_GetCachedImageIndexW(LPCWSTR szPath, INT nIndex, BOOL bSimulateDoc)
393 {
394         WARN("(%s,%08x,%08x) semi-stub.\n",debugstr_w(szPath), nIndex, bSimulateDoc);
395
396         return SIC_GetIconIndex(szPath, nIndex);
397 }
398
399 INT WINAPI Shell_GetCachedImageIndexAW(LPCVOID szPath, INT nIndex, BOOL bSimulateDoc)
400 {       if( SHELL_OsIsUnicode())
401           return Shell_GetCachedImageIndexW(szPath, nIndex, bSimulateDoc);
402         return Shell_GetCachedImageIndexA(szPath, nIndex, bSimulateDoc);
403 }
404
405 /*************************************************************************
406  * ExtractIconExW                       [SHELL32.@]
407  * RETURNS
408  *  0 no icon found
409  *  -1 file is not valid
410  *  or number of icons extracted
411  */
412 UINT WINAPI ExtractIconExW(LPCWSTR lpszFile, INT nIconIndex, HICON * phiconLarge, HICON * phiconSmall, UINT nIcons)
413 {
414         TRACE("%s %i %p %p %i\n", debugstr_w(lpszFile), nIconIndex, phiconLarge, phiconSmall, nIcons);
415
416         return PrivateExtractIconExW(lpszFile, nIconIndex, phiconLarge, phiconSmall, nIcons);
417 }
418
419 /*************************************************************************
420  * ExtractIconExA                       [SHELL32.@]
421  */
422 UINT WINAPI ExtractIconExA(LPCSTR lpszFile, INT nIconIndex, HICON * phiconLarge, HICON * phiconSmall, UINT nIcons)
423 {
424     UINT ret = 0;
425     INT len = MultiByteToWideChar(CP_ACP, 0, lpszFile, -1, NULL, 0);
426     LPWSTR lpwstrFile = HeapAlloc(GetProcessHeap(), 0, len * sizeof(WCHAR));
427
428     TRACE("%s %i %p %p %i\n", lpszFile, nIconIndex, phiconLarge, phiconSmall, nIcons);
429
430     if (lpwstrFile)
431     {
432         MultiByteToWideChar(CP_ACP, 0, lpszFile, -1, lpwstrFile, len);
433         ret = ExtractIconExW(lpwstrFile, nIconIndex, phiconLarge, phiconSmall, nIcons);
434         HeapFree(GetProcessHeap(), 0, lpwstrFile);
435     }
436     return ret;
437 }
438
439 /*************************************************************************
440  *                              ExtractAssociatedIconA (SHELL32.@)
441  *
442  * Return icon for given file (either from file itself or from associated
443  * executable) and patch parameters if needed.
444  */
445 HICON WINAPI ExtractAssociatedIconA(HINSTANCE hInst, LPSTR lpIconPath, LPWORD lpiIcon)
446 {       
447     HICON hIcon = NULL;
448     INT len = MultiByteToWideChar(CP_ACP, 0, lpIconPath, -1, NULL, 0);
449     LPWSTR lpIconPathW = HeapAlloc(GetProcessHeap(), 0, len * sizeof(WCHAR));
450
451     TRACE("%p %s %p\n", hInst, debugstr_a(lpIconPath), lpiIcon);
452
453     if (lpIconPathW)
454     {
455         MultiByteToWideChar(CP_ACP, 0, lpIconPath, -1, lpIconPathW, len);
456         hIcon = ExtractAssociatedIconW(hInst, lpIconPathW, lpiIcon);
457         HeapFree(GetProcessHeap(), 0, lpIconPathW);
458     }
459     return hIcon;
460 }
461
462 HICON WINAPI ExtractAssociatedIconW(HINSTANCE hInst, LPWSTR lpIconPath, LPWORD lpiIcon)
463 {
464     HICON hIcon = NULL;
465     WORD wDummyIcon = 0;
466
467     TRACE("%p %s %p\n", hInst, debugstr_w(lpIconPath), lpiIcon);
468
469     if(lpiIcon == NULL)
470         lpiIcon = &wDummyIcon;
471
472     hIcon = ExtractIconW(hInst, lpIconPath, *lpiIcon);
473
474     if( hIcon < (HICON)2 )
475     { if( hIcon == (HICON)1 ) /* no icons found in given file */
476       { WCHAR tempPath[MAX_PATH];
477         HINSTANCE uRet = FindExecutableW(lpIconPath,NULL,tempPath);
478
479         if( uRet > (HINSTANCE)32 && tempPath[0] )
480         { lstrcpyW(lpIconPath,tempPath);
481           hIcon = ExtractIconW(hInst, lpIconPath, *lpiIcon);
482           if( hIcon > (HICON)2 )
483             return hIcon;
484         }
485       }
486
487       if( hIcon == (HICON)1 )
488         *lpiIcon = 2;   /* MSDOS icon - we found .exe but no icons in it */
489       else
490         *lpiIcon = 6;   /* generic icon - found nothing */
491
492       if (GetModuleFileNameW(hInst, lpIconPath, MAX_PATH))
493         hIcon = LoadIconW(hInst, MAKEINTRESOURCEW(*lpiIcon));
494     }
495     return hIcon;
496 }
497
498 /*************************************************************************
499  *                              ExtractAssociatedIconExW (SHELL32.@)
500  *
501  * Return icon for given file (either from file itself or from associated
502  * executable) and patch parameters if needed.
503  */
504 HICON WINAPI ExtractAssociatedIconExW(HINSTANCE hInst, LPWSTR lpIconPath, LPWORD lpiIconIdx, LPWORD lpiIconId)
505 {
506   FIXME("%p %s %p %p): stub\n", hInst, debugstr_w(lpIconPath), lpiIconIdx, lpiIconId);
507   return 0;
508 }
509
510 /*************************************************************************
511  *                              ExtractAssociatedIconExA (SHELL32.@)
512  *
513  * Return icon for given file (either from file itself or from associated
514  * executable) and patch parameters if needed.
515  */
516 HICON WINAPI ExtractAssociatedIconExA(HINSTANCE hInst, LPSTR lpIconPath, LPWORD lpiIconIdx, LPWORD lpiIconId)
517 {
518   HICON ret;
519   INT len = MultiByteToWideChar( CP_ACP, 0, lpIconPath, -1, NULL, 0 );
520   LPWSTR lpwstrFile = HeapAlloc( GetProcessHeap(), 0, len * sizeof(WCHAR) );
521
522   TRACE("%p %s %p %p)\n", hInst, lpIconPath, lpiIconIdx, lpiIconId);
523
524   MultiByteToWideChar( CP_ACP, 0, lpIconPath, -1, lpwstrFile, len );
525   ret = ExtractAssociatedIconExW(hInst, lpwstrFile, lpiIconIdx, lpiIconId);
526   HeapFree(GetProcessHeap(), 0, lpwstrFile);
527   return ret;
528 }
529
530
531 /****************************************************************************
532  * SHDefExtractIconW            [SHELL32.@]
533  */
534 HRESULT WINAPI SHDefExtractIconW(LPCWSTR pszIconFile, int iIndex, UINT uFlags,
535                                  HICON* phiconLarge, HICON* phiconSmall, UINT nIconSize)
536 {
537         UINT ret;
538         HICON hIcons[2];
539         WARN("%s %d 0x%08x %p %p %d, semi-stub\n", debugstr_w(pszIconFile), iIndex, uFlags, phiconLarge, phiconSmall, nIconSize);
540
541         ret = PrivateExtractIconsW(pszIconFile, iIndex, nIconSize, nIconSize, hIcons, NULL, 2, LR_DEFAULTCOLOR);
542         /* FIXME: deal with uFlags parameter which contains GIL_ flags */
543         if (ret == 0xFFFFFFFF)
544           return E_FAIL;
545         if (ret > 0) {
546           *phiconLarge = hIcons[0];
547           *phiconSmall = hIcons[1];
548           return S_OK;
549         }
550         return S_FALSE;
551 }
552
553 /****************************************************************************
554  * SHDefExtractIconA            [SHELL32.@]
555  */
556 HRESULT WINAPI SHDefExtractIconA(LPCSTR pszIconFile, int iIndex, UINT uFlags,
557                                  HICON* phiconLarge, HICON* phiconSmall, UINT nIconSize)
558 {
559   HRESULT ret;
560   INT len = MultiByteToWideChar(CP_ACP, 0, pszIconFile, -1, NULL, 0);
561   LPWSTR lpwstrFile = HeapAlloc(GetProcessHeap(), 0, len * sizeof(WCHAR));
562
563   TRACE("%s %d 0x%08x %p %p %d\n", pszIconFile, iIndex, uFlags, phiconLarge, phiconSmall, nIconSize);
564
565   MultiByteToWideChar(CP_ACP, 0, pszIconFile, -1, lpwstrFile, len);
566   ret = SHDefExtractIconW(lpwstrFile, iIndex, uFlags, phiconLarge, phiconSmall, nIconSize);
567   HeapFree(GetProcessHeap(), 0, lpwstrFile);
568   return ret;
569 }