Const correctness fixes.
[wine/multimedia.git] / dlls / shell32 / shlfolder.c
blob7b525a2c10a80e5f225e775a56d2c0deada07b91
2 /*
3 * Shell Folder stuff
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
25 #include "config.h"
26 #include "wine/port.h"
28 #include <stdlib.h>
29 #include <string.h>
30 #include <stdarg.h>
31 #include <stdio.h>
33 #define COBJMACROS
35 #include "winerror.h"
36 #include "windef.h"
37 #include "winbase.h"
38 #include "winreg.h"
39 #include "wingdi.h"
40 #include "winuser.h"
42 #include "ole2.h"
43 #include "shlguid.h"
45 #include "pidl.h"
46 #include "undocshell.h"
47 #include "shell32_main.h"
48 #include "shresdef.h"
49 #include "shlwapi.h"
50 #include "shellfolder.h"
51 #include "wine/debug.h"
52 #include "debughlp.h"
53 #include "shfldr.h"
55 WINE_DEFAULT_DEBUG_CHANNEL (shell);
57 /***************************************************************************
58 * debughelper: print out the return address
59 * helps especially to track down unbalanced AddRef/Release
61 #define MEM_DEBUG 0
63 #if MEM_DEBUG
64 #define _CALL_TRACE TRACE("called from: 0x%08x\n", *( ((UINT*)&iface)-1 ));
65 #else
66 #define _CALL_TRACE
67 #endif
69 static const WCHAR wszDotShellClassInfo[] = {'.','S','h','e','l','l','C','l','a','s','s','I','n','f','o',0};
71 /***************************************************************************
72 * SHELL32_GetCustomFolderAttribute (internal function)
74 * Gets a value from the folder's desktop.ini file, if one exists.
76 * PARAMETERS
77 * pidl [I] Folder containing the desktop.ini file.
78 * pwszHeading [I] Heading in .ini file.
79 * pwszAttribute [I] Attribute in .ini file.
80 * pwszValue [O] Buffer to store value into.
81 * cchValue [I] Size in characters including NULL of buffer pointed to
82 * by pwszValue.
84 * RETURNS
85 * TRUE if returned non-NULL value.
86 * FALSE otherwise.
88 BOOL SHELL32_GetCustomFolderAttribute(
89 LPCITEMIDLIST pidl, LPCWSTR pwszHeading, LPCWSTR pwszAttribute,
90 LPWSTR pwszValue, DWORD cchValue)
92 #if 0 /* Hack around not having system attribute on non-Windows file systems */
93 DWORD dwAttrib = _ILGetFileAttributes(pidl, NULL, 0);
94 #else
95 DWORD dwAttrib = FILE_ATTRIBUTE_SYSTEM;
96 #endif
97 if (dwAttrib & FILE_ATTRIBUTE_SYSTEM)
99 DWORD ret;
100 WCHAR wszDesktopIniPath[MAX_PATH];
101 static const WCHAR wszDesktopIni[] =
102 {'d','e','s','k','t','o','p','.','i','n','i',0};
103 static const WCHAR wszDefault[] =
104 {0};
105 if (!SHGetPathFromIDListW(pidl, wszDesktopIniPath))
106 return FALSE;
107 PathAppendW(wszDesktopIniPath, wszDesktopIni);
108 ret = GetPrivateProfileStringW(pwszHeading, pwszAttribute,
109 wszDefault, pwszValue, cchValue, wszDesktopIniPath);
110 if (!ret) return FALSE;
111 return TRUE;
113 return FALSE;
117 /***************************************************************************
118 * GetNextElement (internal function)
120 * gets a part of a string till the first backslash
122 * PARAMETERS
123 * pszNext [IN] string to get the element from
124 * pszOut [IN] pointer to buffer whitch receives string
125 * dwOut [IN] length of pszOut
127 * RETURNS
128 * LPSTR pointer to first, not yet parsed char
131 LPCWSTR GetNextElementW (LPCWSTR pszNext, LPWSTR pszOut, DWORD dwOut)
133 LPCWSTR pszTail = pszNext;
134 DWORD dwCopy;
136 TRACE ("(%s %p 0x%08lx)\n", debugstr_w (pszNext), pszOut, dwOut);
138 *pszOut = 0x0000;
140 if (!pszNext || !*pszNext)
141 return NULL;
143 while (*pszTail && (*pszTail != (WCHAR) '\\'))
144 pszTail++;
146 dwCopy = (const WCHAR *) pszTail - (const WCHAR *) pszNext + 1;
147 lstrcpynW (pszOut, pszNext, (dwOut < dwCopy) ? dwOut : dwCopy);
149 if (*pszTail)
150 pszTail++;
151 else
152 pszTail = NULL;
154 TRACE ("--(%s %s 0x%08lx %p)\n", debugstr_w (pszNext), debugstr_w (pszOut), dwOut, pszTail);
155 return pszTail;
158 HRESULT SHELL32_ParseNextElement (IShellFolder2 * psf, HWND hwndOwner, LPBC pbc,
159 LPITEMIDLIST * pidlInOut, LPOLESTR szNext, DWORD * pEaten, DWORD * pdwAttributes)
161 HRESULT hr = E_INVALIDARG;
162 LPITEMIDLIST pidlOut = NULL,
163 pidlTemp = NULL;
164 IShellFolder *psfChild;
166 TRACE ("(%p, %p, %p, %s)\n", psf, pbc, pidlInOut ? *pidlInOut : NULL, debugstr_w (szNext));
168 /* get the shellfolder for the child pidl and let it analyse further */
169 hr = IShellFolder_BindToObject (psf, *pidlInOut, pbc, &IID_IShellFolder, (LPVOID *) & psfChild);
171 if (SUCCEEDED(hr)) {
172 hr = IShellFolder_ParseDisplayName (psfChild, hwndOwner, pbc, szNext, pEaten, &pidlOut, pdwAttributes);
173 IShellFolder_Release (psfChild);
175 if (SUCCEEDED(hr)) {
176 pidlTemp = ILCombine (*pidlInOut, pidlOut);
178 if (!pidlTemp)
179 hr = E_OUTOFMEMORY;
182 if (pidlOut)
183 ILFree (pidlOut);
186 ILFree (*pidlInOut);
187 *pidlInOut = pidlTemp;
189 TRACE ("-- pidl=%p ret=0x%08lx\n", pidlInOut ? *pidlInOut : NULL, hr);
190 return hr;
193 /***********************************************************************
194 * SHELL32_CoCreateInitSF
196 * Creates a shell folder and initializes it with a pidl and a root folder
197 * via IPersistFolder3 or IPersistFolder.
199 * NOTES
200 * pathRoot can be NULL for Folders beeing a drive.
201 * In this case the absolute path is build from pidlChild (eg. C:)
203 HRESULT SHELL32_CoCreateInitSF (LPCITEMIDLIST pidlRoot, LPCSTR pathRoot,
204 LPCITEMIDLIST pidlChild, REFCLSID clsid, REFIID riid, LPVOID * ppvOut)
206 HRESULT hr;
208 TRACE ("%p %s %p\n", pidlRoot, pathRoot, pidlChild);
210 if (SUCCEEDED ((hr = SHCoCreateInstance (NULL, clsid, NULL, riid, ppvOut)))) {
211 LPITEMIDLIST pidlAbsolute = ILCombine (pidlRoot, pidlChild);
212 IPersistFolder *pPF;
213 IPersistFolder3 *ppf;
215 if (SUCCEEDED (IUnknown_QueryInterface ((IUnknown *) * ppvOut, &IID_IPersistFolder3, (LPVOID *) & ppf))) {
216 PERSIST_FOLDER_TARGET_INFO ppfti;
217 char szDestPath[MAX_PATH];
219 ZeroMemory (&ppfti, sizeof (ppfti));
221 /* build path */
222 if (pathRoot) {
223 lstrcpyA (szDestPath, pathRoot);
224 PathAddBackslashA(szDestPath); /* FIXME: why have drives a backslash here ? */
225 } else {
226 szDestPath[0] = '\0';
229 if (pidlChild) {
230 LPSTR pszChild = _ILGetTextPointer(pidlChild);
232 if (pszChild)
233 lstrcatA (szDestPath, pszChild);
234 else
235 hr = E_INVALIDARG;
238 /* fill the PERSIST_FOLDER_TARGET_INFO */
239 ppfti.dwAttributes = -1;
240 ppfti.csidl = -1;
241 MultiByteToWideChar (CP_ACP, 0, szDestPath, -1, ppfti.szTargetParsingName, MAX_PATH);
243 IPersistFolder3_InitializeEx (ppf, NULL, pidlAbsolute, &ppfti);
244 IPersistFolder3_Release (ppf);
246 else if (SUCCEEDED ((hr = IUnknown_QueryInterface ((IUnknown *) * ppvOut, &IID_IPersistFolder, (LPVOID *) & pPF)))) {
247 IPersistFolder_Initialize (pPF, pidlAbsolute);
248 IPersistFolder_Release (pPF);
250 ILFree (pidlAbsolute);
252 TRACE ("-- (%p) ret=0x%08lx\n", *ppvOut, hr);
253 return hr;
256 /***********************************************************************
257 * SHELL32_BindToChild
259 * Common code for IShellFolder_BindToObject.
260 * Creates a shell folder by binding to a root pidl.
262 HRESULT SHELL32_BindToChild (LPCITEMIDLIST pidlRoot,
263 LPCSTR pathRoot, LPCITEMIDLIST pidlComplete, REFIID riid, LPVOID * ppvOut)
265 GUID const *clsid;
266 IShellFolder *pSF;
267 HRESULT hr;
268 LPITEMIDLIST pidlChild;
270 if (!pidlRoot || !ppvOut)
271 return E_INVALIDARG;
273 *ppvOut = NULL;
275 pidlChild = ILCloneFirst (pidlComplete);
277 if ((clsid = _ILGetGUIDPointer (pidlChild))) {
278 /* virtual folder */
279 hr = SHELL32_CoCreateInitSF (pidlRoot, pathRoot, pidlChild, clsid, &IID_IShellFolder, (LPVOID *) & pSF);
280 } else {
281 /* file system folder */
282 CLSID clsidFolder = CLSID_ShellFSFolder;
283 static const WCHAR wszCLSID[] = {'C','L','S','I','D',0};
284 WCHAR wszCLSIDValue[CHARS_IN_GUID];
285 LPITEMIDLIST pidlAbsolute = ILCombine (pidlRoot, pidlChild);
286 /* see if folder CLSID should be overridden by desktop.ini file */
287 if (SHELL32_GetCustomFolderAttribute (pidlAbsolute,
288 wszDotShellClassInfo, wszCLSID, wszCLSIDValue, CHARS_IN_GUID))
289 CLSIDFromString (wszCLSIDValue, &clsidFolder);
290 ILFree (pidlAbsolute);
291 hr = SHELL32_CoCreateInitSF (pidlRoot, pathRoot, pidlChild,
292 &clsidFolder, &IID_IShellFolder, (LPVOID *)&pSF);
294 ILFree (pidlChild);
296 if (SUCCEEDED (hr)) {
297 if (_ILIsPidlSimple (pidlComplete)) {
298 /* no sub folders */
299 hr = IShellFolder_QueryInterface (pSF, riid, ppvOut);
300 } else {
301 /* go deeper */
302 hr = IShellFolder_BindToObject (pSF, ILGetNext (pidlComplete), NULL, riid, ppvOut);
304 IShellFolder_Release (pSF);
307 TRACE ("-- returning (%p) %08lx\n", *ppvOut, hr);
309 return hr;
312 /***********************************************************************
313 * SHELL32_GetDisplayNameOfChild
315 * Retrives the display name of a child object of a shellfolder.
317 * For a pidl eg. [subpidl1][subpidl2][subpidl3]:
318 * - it binds to the child shellfolder [subpidl1]
319 * - asks it for the displayname of [subpidl2][subpidl3]
321 * Is possible the pidl is a simple pidl. In this case it asks the
322 * subfolder for the displayname of a empty pidl. The subfolder
323 * returns the own displayname eg. "::{guid}". This is used for
324 * virtual folders with the registry key WantsFORPARSING set.
326 HRESULT SHELL32_GetDisplayNameOfChild (IShellFolder2 * psf,
327 LPCITEMIDLIST pidl, DWORD dwFlags, LPSTR szOut, DWORD dwOutLen)
329 LPITEMIDLIST pidlFirst;
330 HRESULT hr = E_INVALIDARG;
332 TRACE ("(%p)->(pidl=%p 0x%08lx %p 0x%08lx)\n", psf, pidl, dwFlags, szOut, dwOutLen);
333 pdump (pidl);
335 pidlFirst = ILCloneFirst (pidl);
336 if (pidlFirst) {
337 IShellFolder2 *psfChild;
339 hr = IShellFolder_BindToObject (psf, pidlFirst, NULL, &IID_IShellFolder, (LPVOID *) & psfChild);
340 if (SUCCEEDED (hr)) {
341 STRRET strTemp;
342 LPITEMIDLIST pidlNext = ILGetNext (pidl);
344 hr = IShellFolder_GetDisplayNameOf (psfChild, pidlNext, dwFlags, &strTemp);
345 if (SUCCEEDED (hr)) {
346 hr = StrRetToStrNA (szOut, dwOutLen, &strTemp, pidlNext);
348 IShellFolder_Release (psfChild);
350 ILFree (pidlFirst);
351 } else
352 hr = E_OUTOFMEMORY;
354 TRACE ("-- ret=0x%08lx %s\n", hr, szOut);
356 return hr;
359 /***********************************************************************
360 * SHELL32_GetItemAttributes
362 * NOTES
363 * observerd values:
364 * folder: 0xE0000177 FILESYSTEM | HASSUBFOLDER | FOLDER
365 * file: 0x40000177 FILESYSTEM
366 * drive: 0xf0000144 FILESYSTEM | HASSUBFOLDER | FOLDER | FILESYSANCESTOR
367 * mycomputer: 0xb0000154 HASSUBFOLDER | FOLDER | FILESYSANCESTOR
368 * (seems to be default for shell extensions if no registry entry exists)
370 * win2k:
371 * folder: 0xF0400177 FILESYSTEM | HASSUBFOLDER | FOLDER | FILESYSANCESTOR | CANMONIKER
372 * file: 0x40400177 FILESYSTEM | CANMONIKER
373 * drive 0xF0400154 FILESYSTEM | HASSUBFOLDER | FOLDER | FILESYSANCESTOR | CANMONIKER | CANRENAME (LABEL)
375 * This function does not set flags!! It only resets flags when necessary.
377 HRESULT SHELL32_GetItemAttributes (IShellFolder * psf, LPCITEMIDLIST pidl, LPDWORD pdwAttributes)
379 GUID const *clsid;
380 DWORD dwAttributes;
381 DWORD dwSupportedAttr=SFGAO_CANCOPY | /*0x00000001 */
382 SFGAO_CANMOVE | /*0x00000002 */
383 SFGAO_CANLINK | /*0x00000004 */
384 SFGAO_CANRENAME | /*0x00000010 */
385 SFGAO_CANDELETE | /*0x00000020 */
386 SFGAO_HASPROPSHEET | /*0x00000040 */
387 SFGAO_DROPTARGET | /*0x00000100 */
388 SFGAO_LINK | /*0x00010000 */
389 SFGAO_READONLY | /*0x00040000 */
390 SFGAO_HIDDEN | /*0x00080000 */
391 SFGAO_FILESYSANCESTOR | /*0x10000000 */
392 SFGAO_FOLDER | /*0x20000000 */
393 SFGAO_FILESYSTEM | /*0x40000000 */
394 SFGAO_HASSUBFOLDER; /*0x80000000 */
396 TRACE ("0x%08lx\n", *pdwAttributes);
398 if (*pdwAttributes & ~dwSupportedAttr)
400 WARN ("attributes 0x%08lx not implemented\n", (*pdwAttributes & ~dwSupportedAttr));
401 *pdwAttributes &= dwSupportedAttr;
404 if (_ILIsDrive (pidl)) {
405 *pdwAttributes &= SFGAO_HASSUBFOLDER|SFGAO_FILESYSTEM|SFGAO_FOLDER|SFGAO_FILESYSANCESTOR|SFGAO_DROPTARGET|SFGAO_HASPROPSHEET|SFGAO_CANLINK;
406 } else if ((clsid = _ILGetGUIDPointer (pidl))) {
407 if (HCR_GetFolderAttributes (clsid, &dwAttributes)) {
408 *pdwAttributes &= dwAttributes;
409 } else {
410 *pdwAttributes &= SFGAO_HASSUBFOLDER|SFGAO_FOLDER|SFGAO_FILESYSANCESTOR|SFGAO_DROPTARGET|SFGAO_HASPROPSHEET|SFGAO_CANRENAME|SFGAO_CANLINK;
412 } else if (_ILGetDataPointer (pidl)) {
413 dwAttributes = _ILGetFileAttributes (pidl, NULL, 0);
414 *pdwAttributes &= ~SFGAO_FILESYSANCESTOR;
416 if ((SFGAO_FOLDER & *pdwAttributes) && !(dwAttributes & FILE_ATTRIBUTE_DIRECTORY))
417 *pdwAttributes &= ~(SFGAO_FOLDER | SFGAO_HASSUBFOLDER);
419 if ((SFGAO_HIDDEN & *pdwAttributes) && !(dwAttributes & FILE_ATTRIBUTE_HIDDEN))
420 *pdwAttributes &= ~SFGAO_HIDDEN;
422 if ((SFGAO_READONLY & *pdwAttributes) && !(dwAttributes & FILE_ATTRIBUTE_READONLY))
423 *pdwAttributes &= ~SFGAO_READONLY;
425 if (SFGAO_LINK & *pdwAttributes) {
426 char ext[MAX_PATH];
428 if (!_ILGetExtension(pidl, ext, MAX_PATH) || strcasecmp(ext, "lnk"))
429 *pdwAttributes &= ~SFGAO_LINK;
431 } else {
432 *pdwAttributes &= SFGAO_HASSUBFOLDER|SFGAO_FOLDER|SFGAO_FILESYSANCESTOR|SFGAO_DROPTARGET|SFGAO_HASPROPSHEET|SFGAO_CANRENAME|SFGAO_CANLINK;
434 TRACE ("-- 0x%08lx\n", *pdwAttributes);
435 return S_OK;
438 /***********************************************************************
439 * SHELL32_CompareIDs
441 HRESULT SHELL32_CompareIDs (IShellFolder * iface, LPARAM lParam, LPCITEMIDLIST pidl1, LPCITEMIDLIST pidl2)
443 int type1,
444 type2;
445 char szTemp1[MAX_PATH];
446 char szTemp2[MAX_PATH];
447 HRESULT nReturn;
448 LPITEMIDLIST firstpidl,
449 nextpidl1,
450 nextpidl2;
451 IShellFolder *psf;
453 /* test for empty pidls */
454 BOOL isEmpty1 = _ILIsDesktop (pidl1);
455 BOOL isEmpty2 = _ILIsDesktop (pidl2);
457 if (isEmpty1 && isEmpty2)
458 return MAKE_HRESULT( SEVERITY_SUCCESS, 0, 0 );
459 if (isEmpty1)
460 return MAKE_HRESULT( SEVERITY_SUCCESS, 0, (WORD)-1 );
461 if (isEmpty2)
462 return MAKE_HRESULT( SEVERITY_SUCCESS, 0, 1 );
464 /* test for different types. Sort order is the PT_* constant */
465 type1 = _ILGetDataPointer (pidl1)->type;
466 type2 = _ILGetDataPointer (pidl2)->type;
467 if (type1 < type2)
468 return MAKE_HRESULT( SEVERITY_SUCCESS, 0, (WORD)-1 );
469 else if (type1 > type2)
470 return MAKE_HRESULT( SEVERITY_SUCCESS, 0, 1 );
472 /* test for name of pidl */
473 _ILSimpleGetText (pidl1, szTemp1, MAX_PATH);
474 _ILSimpleGetText (pidl2, szTemp2, MAX_PATH);
475 nReturn = strcasecmp (szTemp1, szTemp2);
476 if (nReturn < 0)
477 return MAKE_HRESULT( SEVERITY_SUCCESS, 0, (WORD)-1 );
478 else if (nReturn > 0)
479 return MAKE_HRESULT( SEVERITY_SUCCESS, 0, 1 );
481 /* test of complex pidls */
482 firstpidl = ILCloneFirst (pidl1);
483 nextpidl1 = ILGetNext (pidl1);
484 nextpidl2 = ILGetNext (pidl2);
486 /* optimizing: test special cases and bind not deeper */
487 /* the deeper shellfolder would do the same */
488 isEmpty1 = _ILIsDesktop (nextpidl1);
489 isEmpty2 = _ILIsDesktop (nextpidl2);
491 if (isEmpty1 && isEmpty2) {
492 return MAKE_HRESULT( SEVERITY_SUCCESS, 0, 0 );
493 } else if (isEmpty1) {
494 return MAKE_HRESULT( SEVERITY_SUCCESS, 0, (WORD)-1 );
495 } else if (isEmpty2) {
496 return MAKE_HRESULT( SEVERITY_SUCCESS, 0, 1 );
497 /* optimizing end */
498 } else if (SUCCEEDED (IShellFolder_BindToObject (iface, firstpidl, NULL, &IID_IShellFolder, (LPVOID *) & psf))) {
499 nReturn = IShellFolder_CompareIDs (psf, lParam, nextpidl1, nextpidl2);
500 IShellFolder_Release (psf);
502 ILFree (firstpidl);
503 return nReturn;
506 /***********************************************************************
507 * SHCreateLinks
509 * Undocumented.
511 HRESULT WINAPI SHCreateLinks( HWND hWnd, LPCSTR lpszDir, LPDATAOBJECT lpDataObject,
512 UINT uFlags, LPITEMIDLIST *lppidlLinks)
514 FIXME("%p %s %p %08x %p\n",hWnd,lpszDir,lpDataObject,uFlags,lppidlLinks);
515 return E_NOTIMPL;