2 * IQueryAssociations object and helper functions
4 * Copyright 2002 Jon Griffiths
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.
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.
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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
31 #include "shell32_main.h"
33 #include "wine/unicode.h"
34 #include "wine/debug.h"
36 WINE_DEFAULT_DEBUG_CHANNEL(shell
);
38 /**************************************************************************
39 * IQueryAssociations {SHELL32}
42 * This object provides a layer of abstraction over the system registry in
43 * order to simplify the process of parsing associations between files.
44 * Associations in this context means the registry entries that link (for
45 * example) the extension of a file with its description, list of
46 * applications to open the file with, and actions that can be performed on it
47 * (the shell displays such information in the context menu of explorer
48 * when you right-click on a file).
51 * You can use this object transparently by calling the helper functions
52 * AssocQueryKeyA(), AssocQueryStringA() and AssocQueryStringByKeyA(). These
53 * create an IQueryAssociations object, perform the requested actions
54 * and then dispose of the object. Alternatively, you can create an instance
55 * of the object using AssocCreate() and call the following methods on it:
62 const IQueryAssociationsVtbl
*lpVtbl
;
66 } IQueryAssociationsImpl
;
68 /**************************************************************************
69 * IQueryAssociations_QueryInterface {SHLWAPI}
71 * See IUnknown_QueryInterface.
73 static HRESULT WINAPI
IQueryAssociations_fnQueryInterface(
74 IQueryAssociations
* iface
,
78 IQueryAssociationsImpl
*This
= (IQueryAssociationsImpl
*)iface
;
80 TRACE("(%p,%s,%p)\n",This
, debugstr_guid(riid
), ppvObj
);
84 if (IsEqualIID(riid
, &IID_IUnknown
) ||
85 IsEqualIID(riid
, &IID_IQueryAssociations
))
89 IQueryAssociations_AddRef((IQueryAssociations
*)*ppvObj
);
90 TRACE("Returning IQueryAssociations (%p)\n", *ppvObj
);
93 TRACE("Returning E_NOINTERFACE\n");
97 /**************************************************************************
98 * IQueryAssociations_AddRef {SHLWAPI}
100 * See IUnknown_AddRef.
102 static ULONG WINAPI
IQueryAssociations_fnAddRef(IQueryAssociations
*iface
)
104 IQueryAssociationsImpl
*This
= (IQueryAssociationsImpl
*)iface
;
105 ULONG refCount
= InterlockedIncrement(&This
->ref
);
107 TRACE("(%p)->(ref before=%u)\n",This
, refCount
- 1);
112 /**************************************************************************
113 * IQueryAssociations_Release {SHLWAPI}
115 * See IUnknown_Release.
117 static ULONG WINAPI
IQueryAssociations_fnRelease(IQueryAssociations
*iface
)
119 IQueryAssociationsImpl
*This
= (IQueryAssociationsImpl
*)iface
;
120 ULONG refCount
= InterlockedDecrement(&This
->ref
);
122 TRACE("(%p)->(ref before=%u)\n",This
, refCount
+ 1);
126 TRACE("Destroying IQueryAssociations (%p)\n", This
);
127 RegCloseKey(This
->hkeySource
);
128 RegCloseKey(This
->hkeyProgID
);
129 HeapFree(GetProcessHeap(), 0, This
);
135 /**************************************************************************
136 * IQueryAssociations_Init {SHLWAPI}
138 * Initialise an IQueryAssociations object.
141 * iface [I] IQueryAssociations interface to initialise
142 * cfFlags [I] ASSOCF_ flags from "shlwapi.h"
143 * pszAssoc [I] String for the root key name, or NULL if hkeyProgid is given
144 * hkeyProgid [I] Handle for the root key, or NULL if pszAssoc is given
145 * hWnd [I] Reserved, must be NULL.
148 * Success: S_OK. iface is initialised with the parameters given.
149 * Failure: An HRESULT error code indicating the error.
151 static HRESULT WINAPI
IQueryAssociations_fnInit(
152 IQueryAssociations
*iface
,
158 static const WCHAR szProgID
[] = {'P','r','o','g','I','D',0};
159 IQueryAssociationsImpl
*This
= (IQueryAssociationsImpl
*)iface
;
162 TRACE("(%p)->(%d,%s,%p,%p)\n", iface
,
164 debugstr_w(pszAssoc
),
168 FIXME("hwnd != NULL not supported\n");
170 FIXME("unsupported flags: %x\n", cfFlags
);
171 if (pszAssoc
!= NULL
)
173 ret
= RegOpenKeyExW(HKEY_CLASSES_ROOT
,
178 if (ret
!= ERROR_SUCCESS
)
180 /* if this is not a prog id */
181 if ((*pszAssoc
== '.') || (*pszAssoc
== '{'))
183 RegOpenKeyExW(This
->hkeySource
,
190 This
->hkeyProgID
= This
->hkeySource
;
193 else if (hkeyProgid
!= NULL
)
195 This
->hkeyProgID
= hkeyProgid
;
202 static HRESULT
ASSOC_GetValue(HKEY hkey
, WCHAR
** pszText
)
208 ret
= RegQueryValueExW(hkey
, NULL
, 0, NULL
, NULL
, &len
);
209 if (ret
!= ERROR_SUCCESS
)
210 return HRESULT_FROM_WIN32(ret
);
213 *pszText
= HeapAlloc(GetProcessHeap(), 0, len
);
215 return E_OUTOFMEMORY
;
216 ret
= RegQueryValueExW(hkey
, NULL
, 0, NULL
, (LPBYTE
)*pszText
,
218 if (ret
!= ERROR_SUCCESS
)
220 HeapFree(GetProcessHeap(), 0, *pszText
);
221 return HRESULT_FROM_WIN32(ret
);
226 static HRESULT
ASSOC_GetCommand(IQueryAssociationsImpl
*This
,
227 LPCWSTR pszExtra
, WCHAR
**ppszCommand
)
235 WCHAR
* pszExtraFromReg
= NULL
;
237 static const WCHAR commandW
[] = { 'c','o','m','m','a','n','d',0 };
238 static const WCHAR shellW
[] = { 's','h','e','l','l',0 };
240 hr
= ASSOC_GetValue(This
->hkeySource
, &pszFileType
);
243 ret
= RegOpenKeyExW(HKEY_CLASSES_ROOT
, pszFileType
, 0, KEY_READ
, &hkeyFile
);
244 HeapFree(GetProcessHeap(), 0, pszFileType
);
245 if (ret
!= ERROR_SUCCESS
)
246 return HRESULT_FROM_WIN32(ret
);
248 ret
= RegOpenKeyExW(hkeyFile
, shellW
, 0, KEY_READ
, &hkeyShell
);
249 RegCloseKey(hkeyFile
);
250 if (ret
!= ERROR_SUCCESS
)
251 return HRESULT_FROM_WIN32(ret
);
255 hr
= ASSOC_GetValue(hkeyShell
, &pszExtraFromReg
);
256 /* if no default action */
257 if (hr
== E_FAIL
|| hr
== HRESULT_FROM_WIN32(ERROR_FILE_NOT_FOUND
))
260 ret
= RegQueryInfoKeyW(hkeyShell
, 0, 0, 0, 0, &rlen
, 0, 0, 0, 0, 0, 0);
261 if (ret
!= ERROR_SUCCESS
)
263 RegCloseKey(hkeyShell
);
264 return HRESULT_FROM_WIN32(ret
);
267 pszExtraFromReg
= HeapAlloc(GetProcessHeap(), 0, rlen
* sizeof(WCHAR
));
268 if (!pszExtraFromReg
)
270 RegCloseKey(hkeyShell
);
271 return E_OUTOFMEMORY
;
273 ret
= RegEnumKeyExW(hkeyShell
, 0, pszExtraFromReg
, &rlen
, 0, NULL
, NULL
, NULL
);
274 if (ret
!= ERROR_SUCCESS
)
276 RegCloseKey(hkeyShell
);
277 return HRESULT_FROM_WIN32(ret
);
282 RegCloseKey(hkeyShell
);
287 ret
= RegOpenKeyExW(hkeyShell
, pszExtra
? pszExtra
: pszExtraFromReg
, 0,
288 KEY_READ
, &hkeyVerb
);
289 HeapFree(GetProcessHeap(), 0, pszExtraFromReg
);
290 RegCloseKey(hkeyShell
);
291 if (ret
!= ERROR_SUCCESS
)
292 return HRESULT_FROM_WIN32(ret
);
294 ret
= RegOpenKeyExW(hkeyVerb
, commandW
, 0, KEY_READ
, &hkeyCommand
);
295 RegCloseKey(hkeyVerb
);
296 if (ret
!= ERROR_SUCCESS
)
297 return HRESULT_FROM_WIN32(ret
);
298 hr
= ASSOC_GetValue(hkeyCommand
, ppszCommand
);
299 RegCloseKey(hkeyCommand
);
303 static HRESULT
ASSOC_GetExecutable(IQueryAssociationsImpl
*This
,
304 LPCWSTR pszExtra
, LPWSTR path
,
305 DWORD pathlen
, DWORD
*len
)
314 hr
= ASSOC_GetCommand(This
, pszExtra
, &pszCommand
);
318 /* cleanup pszCommand */
319 if (pszCommand
[0] == '"')
321 pszStart
= pszCommand
+ 1;
322 pszEnd
= strchrW(pszStart
, '"');
326 pszStart
= pszCommand
;
327 pszEnd
= strchrW(pszStart
, ' ');
332 *len
= SearchPathW(NULL
, pszStart
, NULL
, pathlen
, path
, NULL
);
333 HeapFree(GetProcessHeap(), 0, pszCommand
);
335 return HRESULT_FROM_WIN32(ERROR_FILE_NOT_FOUND
);
339 static HRESULT
ASSOC_ReturnData(LPWSTR out
, DWORD
*outlen
, LPCWSTR data
,
346 if (*outlen
< datalen
)
352 lstrcpynW(out
, data
, datalen
);
362 /**************************************************************************
363 * IQueryAssociations_GetString {SHLWAPI}
365 * Get a file association string from the registry.
368 * iface [I] IQueryAssociations interface to query
369 * cfFlags [I] ASSOCF_ flags from "shlwapi.h"
370 * str [I] Type of string to get (ASSOCSTR enum from "shlwapi.h")
371 * pszExtra [I] Extra information about the string location
372 * pszOut [O] Destination for the association string
373 * pcchOut [I/O] Length of pszOut
376 * Success: S_OK. pszOut contains the string, pcchOut contains its length.
377 * Failure: An HRESULT error code indicating the error.
379 static HRESULT WINAPI
IQueryAssociations_fnGetString(
380 IQueryAssociations
*iface
,
387 IQueryAssociationsImpl
*This
= (IQueryAssociationsImpl
*)iface
;
388 const ASSOCF cfUnimplemented
= ~(0);
391 WCHAR path
[MAX_PATH
];
393 TRACE("(%p,0x%8x,0x%8x,%s,%p,%p)\n", This
, cfFlags
, str
,
394 debugstr_w(pszExtra
), pszOut
, pcchOut
);
396 if (cfFlags
& cfUnimplemented
)
397 FIXME("%08x: unimplemented flags!\n", cfFlags
& cfUnimplemented
);
404 case ASSOCSTR_COMMAND
:
407 hr
= ASSOC_GetCommand(This
, pszExtra
, &command
);
410 hr
= ASSOC_ReturnData(pszOut
, pcchOut
, command
, strlenW(command
) + 1);
411 HeapFree(GetProcessHeap(), 0, command
);
416 case ASSOCSTR_EXECUTABLE
:
418 hr
= ASSOC_GetExecutable(This
, pszExtra
, path
, MAX_PATH
, &len
);
422 return ASSOC_ReturnData(pszOut
, pcchOut
, path
, len
);
425 case ASSOCSTR_FRIENDLYDOCNAME
:
431 hr
= ASSOC_GetValue(This
->hkeySource
, &pszFileType
);
435 ret
= RegGetValueW(HKEY_CLASSES_ROOT
, pszFileType
, NULL
, RRF_RT_REG_SZ
, NULL
, NULL
, &size
);
436 if (ret
== ERROR_SUCCESS
)
438 WCHAR
*docName
= HeapAlloc(GetProcessHeap(), 0, size
);
441 ret
= RegGetValueW(HKEY_CLASSES_ROOT
, pszFileType
, NULL
, RRF_RT_REG_SZ
, NULL
, docName
, &size
);
442 if (ret
== ERROR_SUCCESS
)
443 hr
= ASSOC_ReturnData(pszOut
, pcchOut
, docName
, strlenW(docName
) + 1);
445 hr
= HRESULT_FROM_WIN32(ret
);
446 HeapFree(GetProcessHeap(), 0, docName
);
452 hr
= HRESULT_FROM_WIN32(ret
);
453 HeapFree(GetProcessHeap(), 0, pszFileType
);
457 case ASSOCSTR_FRIENDLYAPPNAME
:
459 PVOID verinfoW
= NULL
;
460 DWORD size
, retval
= 0;
463 static const WCHAR translationW
[] = {
464 '\\','V','a','r','F','i','l','e','I','n','f','o',
465 '\\','T','r','a','n','s','l','a','t','i','o','n',0
467 static const WCHAR fileDescFmtW
[] = {
468 '\\','S','t','r','i','n','g','F','i','l','e','I','n','f','o',
469 '\\','%','0','4','x','%','0','4','x',
470 '\\','F','i','l','e','D','e','s','c','r','i','p','t','i','o','n',0
474 hr
= ASSOC_GetExecutable(This
, pszExtra
, path
, MAX_PATH
, &len
);
478 retval
= GetFileVersionInfoSizeW(path
, &size
);
480 goto get_friendly_name_fail
;
481 verinfoW
= HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY
, retval
);
483 return E_OUTOFMEMORY
;
484 if (!GetFileVersionInfoW(path
, 0, retval
, verinfoW
))
485 goto get_friendly_name_fail
;
486 if (VerQueryValueW(verinfoW
, translationW
, (LPVOID
*)&bufW
, &flen
))
489 DWORD
*langCodeDesc
= (DWORD
*)bufW
;
490 for (i
= 0; i
< flen
/ sizeof(DWORD
); i
++)
492 sprintfW(fileDescW
, fileDescFmtW
, LOWORD(langCodeDesc
[i
]),
493 HIWORD(langCodeDesc
[i
]));
494 if (VerQueryValueW(verinfoW
, fileDescW
, (LPVOID
*)&bufW
, &flen
))
496 /* Does strlenW(bufW) == 0 mean we use the filename? */
497 len
= strlenW(bufW
) + 1;
498 TRACE("found FileDescription: %s\n", debugstr_w(bufW
));
499 return ASSOC_ReturnData(pszOut
, pcchOut
, bufW
, len
);
503 get_friendly_name_fail
:
504 PathRemoveExtensionW(path
);
505 PathStripPathW(path
);
506 TRACE("using filename: %s\n", debugstr_w(path
));
507 return ASSOC_ReturnData(pszOut
, pcchOut
, path
, strlenW(path
) + 1);
510 case ASSOCSTR_CONTENTTYPE
:
512 static const WCHAR Content_TypeW
[] = {'C','o','n','t','e','n','t',' ','T','y','p','e',0};
518 ret
= RegGetValueW(This
->hkeySource
, NULL
, Content_TypeW
, RRF_RT_REG_SZ
, NULL
, NULL
, &size
);
519 if (ret
!= ERROR_SUCCESS
)
520 return HRESULT_FROM_WIN32(ret
);
521 contentType
= HeapAlloc(GetProcessHeap(), 0, size
);
522 if (contentType
!= NULL
)
524 ret
= RegGetValueW(This
->hkeySource
, NULL
, Content_TypeW
, RRF_RT_REG_SZ
, NULL
, contentType
, &size
);
525 if (ret
== ERROR_SUCCESS
)
526 hr
= ASSOC_ReturnData(pszOut
, pcchOut
, contentType
, strlenW(contentType
) + 1);
528 hr
= HRESULT_FROM_WIN32(ret
);
529 HeapFree(GetProcessHeap(), 0, contentType
);
536 case ASSOCSTR_DEFAULTICON
:
538 static const WCHAR DefaultIconW
[] = {'D','e','f','a','u','l','t','I','c','o','n',0};
544 hr
= ASSOC_GetValue(This
->hkeySource
, &pszFileType
);
547 ret
= RegOpenKeyExW(HKEY_CLASSES_ROOT
, pszFileType
, 0, KEY_READ
, &hkeyFile
);
548 if (ret
== ERROR_SUCCESS
)
551 ret
= RegGetValueW(hkeyFile
, DefaultIconW
, NULL
, RRF_RT_REG_SZ
, NULL
, NULL
, &size
);
552 if (ret
== ERROR_SUCCESS
)
554 WCHAR
*icon
= HeapAlloc(GetProcessHeap(), 0, size
);
557 ret
= RegGetValueW(hkeyFile
, DefaultIconW
, NULL
, RRF_RT_REG_SZ
, NULL
, icon
, &size
);
558 if (ret
== ERROR_SUCCESS
)
559 hr
= ASSOC_ReturnData(pszOut
, pcchOut
, icon
, strlenW(icon
) + 1);
561 hr
= HRESULT_FROM_WIN32(ret
);
562 HeapFree(GetProcessHeap(), 0, icon
);
568 hr
= HRESULT_FROM_WIN32(ret
);
569 RegCloseKey(hkeyFile
);
572 hr
= HRESULT_FROM_WIN32(ret
);
573 HeapFree(GetProcessHeap(), 0, pszFileType
);
578 FIXME("assocstr %d unimplemented!\n", str
);
583 /**************************************************************************
584 * IQueryAssociations_GetKey {SHLWAPI}
586 * Get a file association key from the registry.
589 * iface [I] IQueryAssociations interface to query
590 * cfFlags [I] ASSOCF_ flags from "shlwapi.h"
591 * assockey [I] Type of key to get (ASSOCKEY enum from "shlwapi.h")
592 * pszExtra [I] Extra information about the key location
593 * phkeyOut [O] Destination for the association key
596 * Success: S_OK. phkeyOut contains a handle to the key.
597 * Failure: An HRESULT error code indicating the error.
599 static HRESULT WINAPI
IQueryAssociations_fnGetKey(
600 IQueryAssociations
*iface
,
606 IQueryAssociationsImpl
*This
= (IQueryAssociationsImpl
*)iface
;
608 FIXME("(%p,0x%8x,0x%8x,%s,%p)-stub!\n", This
, cfFlags
, assockey
,
609 debugstr_w(pszExtra
), phkeyOut
);
613 /**************************************************************************
614 * IQueryAssociations_GetData {SHLWAPI}
616 * Get the data for a file association key from the registry.
619 * iface [I] IQueryAssociations interface to query
620 * cfFlags [I] ASSOCF_ flags from "shlwapi.h"
621 * assocdata [I] Type of data to get (ASSOCDATA enum from "shlwapi.h")
622 * pszExtra [I] Extra information about the data location
623 * pvOut [O] Destination for the association key
624 * pcbOut [I/O] Size of pvOut
627 * Success: S_OK. pszOut contains the data, pcbOut contains its length.
628 * Failure: An HRESULT error code indicating the error.
630 static HRESULT WINAPI
IQueryAssociations_fnGetData(
631 IQueryAssociations
*iface
,
638 IQueryAssociationsImpl
*This
= (IQueryAssociationsImpl
*)iface
;
640 FIXME("(%p,0x%8x,0x%8x,%s,%p,%p)-stub!\n", This
, cfFlags
, assocdata
,
641 debugstr_w(pszExtra
), pvOut
, pcbOut
);
645 /**************************************************************************
646 * IQueryAssociations_GetEnum {SHLWAPI}
648 * Not yet implemented in native Win32.
651 * iface [I] IQueryAssociations interface to query
652 * cfFlags [I] ASSOCF_ flags from "shlwapi.h"
653 * assocenum [I] Type of enum to get (ASSOCENUM enum from "shlwapi.h")
654 * pszExtra [I] Extra information about the enum location
655 * riid [I] REFIID to look for
656 * ppvOut [O] Destination for the interface.
660 * Failure: An HRESULT error code indicating the error.
663 * Presumably this function returns an enumerator object.
665 static HRESULT WINAPI
IQueryAssociations_fnGetEnum(
666 IQueryAssociations
*iface
,
673 IQueryAssociationsImpl
*This
= (IQueryAssociationsImpl
*)iface
;
675 FIXME("(%p,0x%8x,0x%8x,%s,%s,%p)-stub!\n", This
, cfFlags
, assocenum
,
676 debugstr_w(pszExtra
), debugstr_guid(riid
), ppvOut
);
680 static const IQueryAssociationsVtbl IQueryAssociations_vtbl
=
682 IQueryAssociations_fnQueryInterface
,
683 IQueryAssociations_fnAddRef
,
684 IQueryAssociations_fnRelease
,
685 IQueryAssociations_fnInit
,
686 IQueryAssociations_fnGetString
,
687 IQueryAssociations_fnGetKey
,
688 IQueryAssociations_fnGetData
,
689 IQueryAssociations_fnGetEnum
692 /**************************************************************************
693 * IQueryAssociations_Constructor [internal]
695 * Construct a new IQueryAssociations object.
697 HRESULT WINAPI
QueryAssociations_Constructor(IUnknown
*pUnkOuter
, REFIID riid
, LPVOID
*ppOutput
)
699 IQueryAssociationsImpl
* this;
702 if (pUnkOuter
) return CLASS_E_NOAGGREGATION
;
704 if (!(this = SHAlloc(sizeof(*this)))) return E_OUTOFMEMORY
;
705 this->lpVtbl
= &IQueryAssociations_vtbl
;
707 this->hkeySource
= 0;
708 this->hkeyProgID
= 0;
709 if (FAILED(ret
= IUnknown_QueryInterface((IUnknown
*)this, riid
, ppOutput
))) SHFree( this );
710 TRACE("returning %p\n", *ppOutput
);