Intravision/reactos
1
0
Fork 0
mirror of https://github.com/reactos/reactos.git synced 2024-12-28 18:15:11 +00:00
Code Issues Projects Releases Packages Wiki Activity
reactos/dll/win32/shlwapi/utils.cpp

388 lines
11 KiB
C++
Raw Blame History

/*
* PROJECT: ReactOS Shell
* LICENSE: LGPL-2.0-or-later (https://spdx.org/licenses/LGPL-2.0-or-later)
* PURPOSE: Implement shell light-weight utility functions
* COPYRIGHT: Copyright 2023-2024 Katayama Hirofumi MZ <katayama.hirofumi.mz@gmail.com>
*/
#define _ATL_NO_EXCEPTIONS
/*
* HACK! These functions are conflicting with <shobjidl.h> inline functions...
*/
#define IShellFolder_GetDisplayNameOf _disabled_IShellFolder_GetDisplayNameOf_
#define IShellFolder_ParseDisplayName _disabled_IShellFolder_ParseDisplayName_
#define IShellFolder_CompareIDs _disabled_IShellFolder_CompareIDs_
#include "precomp.h"
#include <shellapi.h>
#include <shlwapi.h>
#include <shlobj_undoc.h>
#include <shlguid_undoc.h>
#include <atlstr.h>
/*
* HACK!
*/
#undef IShellFolder_GetDisplayNameOf
#undef IShellFolder_ParseDisplayName
#undef IShellFolder_CompareIDs
#define SHLWAPI_ISHELLFOLDER_HELPERS /* HACK! */
#include <shlwapi_undoc.h>
#include <strsafe.h>
#ifndef FAILED_UNEXPECTEDLY
#define FAILED_UNEXPECTEDLY FAILED /* FIXME: Make shellutils.h usable without ATL */
#endif
WINE_DEFAULT_DEBUG_CHANNEL(shell);
static inline WORD
GetVersionMajorMinor()
{
DWORD version = GetVersion();
return MAKEWORD(HIBYTE(version), LOBYTE(version));
}
static HRESULT
SHInvokeCommandOnContextMenuInternal(
_In_opt_ HWND hWnd,
_In_opt_ IUnknown* pUnk,
_In_ IContextMenu* pCM,
_In_ UINT fCMIC,
_In_ UINT fCMF,
_In_opt_ LPCSTR pszVerb,
_In_opt_ LPCWSTR pwszDir,
_In_ bool ForceQCM)
{
CMINVOKECOMMANDINFOEX info = { sizeof(info), fCMIC, hWnd, pszVerb };
INT iDefItem = 0;
HMENU hMenu = NULL;
HCURSOR hOldCursor;
HRESULT hr = S_OK;
WCHAR wideverb[MAX_PATH];
if (!pCM)
return E_INVALIDARG;
hOldCursor = SetCursor(LoadCursorW(NULL, (LPCWSTR)IDC_WAIT));
info.nShow = SW_NORMAL;
if (pUnk)
IUnknown_SetSite(pCM, pUnk);
if (IS_INTRESOURCE(pszVerb))
{
hMenu = CreatePopupMenu();
if (hMenu)
{
hr = pCM->QueryContextMenu(hMenu, 0, 1, MAXSHORT, fCMF | CMF_DEFAULTONLY);
iDefItem = GetMenuDefaultItem(hMenu, 0, 0);
if (iDefItem != -1)
info.lpVerb = MAKEINTRESOURCEA(iDefItem - 1);
}
info.lpVerbW = MAKEINTRESOURCEW(info.lpVerb);
}
else
{
if (GetVersionMajorMinor() >= _WIN32_WINNT_WIN7)
{
info.fMask |= CMF_OPTIMIZEFORINVOKE;
}
if (pszVerb && SHAnsiToUnicode(pszVerb, wideverb, _countof(wideverb)))
{
info.fMask |= CMIC_MASK_UNICODE;
info.lpVerbW = wideverb;
}
if (ForceQCM)
{
hMenu = CreatePopupMenu();
hr = pCM->QueryContextMenu(hMenu, 0, 1, MAXSHORT, fCMF);
}
}
SetCursor(hOldCursor);
if (!FAILED_UNEXPECTEDLY(hr) && (iDefItem != -1 || info.lpVerb))
{
if (!hWnd)
info.fMask |= CMIC_MASK_FLAG_NO_UI;
CHAR dir[MAX_PATH];
if (pwszDir)
{
info.fMask |= CMIC_MASK_UNICODE;
info.lpDirectoryW = pwszDir;
if (SHUnicodeToAnsi(pwszDir, dir, _countof(dir)))
info.lpDirectory = dir;
}
hr = pCM->InvokeCommand((LPCMINVOKECOMMANDINFO)&info);
if (FAILED_UNEXPECTEDLY(hr)) { /* Diagnostic message */ }
}
if (pUnk)
IUnknown_SetSite(pCM, NULL);
if (hMenu)
DestroyMenu(hMenu);
return hr;
}
/*************************************************************************
* SHInvokeCommandOnContextMenuEx [SHLWAPI.639]
*/
EXTERN_C
HRESULT WINAPI
SHInvokeCommandOnContextMenuEx(
_In_opt_ HWND hWnd,
_In_opt_ IUnknown* pUnk,
_In_ IContextMenu* pCM,
_In_ UINT fCMIC,
_In_ UINT fCMF,
_In_opt_ LPCSTR pszVerb,
_In_opt_ LPCWSTR pwszDir)
{
return SHInvokeCommandOnContextMenuInternal(hWnd, pUnk, pCM, fCMIC, fCMF, pszVerb, pwszDir, true);
}
/*************************************************************************
* SHInvokeCommandOnContextMenu [SHLWAPI.540]
*/
EXTERN_C
HRESULT WINAPI
SHInvokeCommandOnContextMenu(
_In_opt_ HWND hWnd,
_In_opt_ IUnknown* pUnk,
_In_ IContextMenu* pCM,
_In_ UINT fCMIC,
_In_opt_ LPCSTR pszVerb)
{
return SHInvokeCommandOnContextMenuEx(hWnd, pUnk, pCM, fCMIC, CMF_EXTENDEDVERBS, pszVerb, NULL);
}
/*************************************************************************
* SHInvokeCommandWithFlagsAndSite [SHLWAPI.571]
*/
EXTERN_C
HRESULT WINAPI
SHInvokeCommandWithFlagsAndSite(
_In_opt_ HWND hWnd,
_In_opt_ IUnknown* pUnk,
_In_ IShellFolder* pShellFolder,
_In_ LPCITEMIDLIST pidl,
_In_ UINT fCMIC,
_In_opt_ LPCSTR pszVerb)
{
HRESULT hr = E_INVALIDARG;
if (pShellFolder)
{
IContextMenu *pCM;
hr = pShellFolder->GetUIObjectOf(hWnd, 1, &pidl, IID_IContextMenu, NULL, (void**)&pCM);
if (SUCCEEDED(hr))
{
fCMIC |= CMIC_MASK_FLAG_LOG_USAGE;
hr = SHInvokeCommandOnContextMenuEx(hWnd, pUnk, pCM, fCMIC, 0, pszVerb, NULL);
pCM->Release();
}
}
return hr;
}
/*************************************************************************
* IContextMenu_Invoke [SHLWAPI.207]
*
* Used by Win:SHELL32!CISFBand::_TrySimpleInvoke.
*/
EXTERN_C
BOOL WINAPI
IContextMenu_Invoke(
_In_ IContextMenu *pContextMenu,
_In_ HWND hwnd,
_In_ LPCSTR lpVerb,
_In_ UINT uFlags)
{
TRACE("(%p, %p, %s, %u)\n", pContextMenu, hwnd, debugstr_a(lpVerb), uFlags);
HRESULT hr = SHInvokeCommandOnContextMenuInternal(hwnd, NULL, pContextMenu, 0,
uFlags, lpVerb, NULL, false);
return !FAILED_UNEXPECTEDLY(hr);
}
/*************************************************************************
* PathFileExistsDefExtAndAttributesW [SHLWAPI.511]
*
* @param pszPath The path string.
* @param dwWhich The WHICH_... flags.
* @param pdwFileAttributes A pointer to the file attributes. Optional.
* @return TRUE if successful.
*/
BOOL WINAPI
PathFileExistsDefExtAndAttributesW(
_Inout_ LPWSTR pszPath,
_In_ DWORD dwWhich,
_Out_opt_ LPDWORD pdwFileAttributes)
{
TRACE("(%s, 0x%lX, %p)\n", debugstr_w(pszPath), dwWhich, pdwFileAttributes);
if (pdwFileAttributes)
*pdwFileAttributes = INVALID_FILE_ATTRIBUTES;
if (!pszPath)
return FALSE;
if (!dwWhich || (*PathFindExtensionW(pszPath) && (dwWhich & WHICH_OPTIONAL)))
return PathFileExistsAndAttributesW(pszPath, pdwFileAttributes);
if (!PathFileExistsDefExtW(pszPath, dwWhich))
{
if (pdwFileAttributes)
*pdwFileAttributes = INVALID_FILE_ATTRIBUTES;
return FALSE;
}
if (pdwFileAttributes)
*pdwFileAttributes = GetFileAttributesW(pszPath);
return TRUE;
}
static inline BOOL
SHLWAPI_IsBogusHRESULT(HRESULT hr)
{
return (hr == E_FAIL || hr == E_INVALIDARG || hr == E_NOTIMPL);
}
// Used for IShellFolder_GetDisplayNameOf
struct RETRY_DATA
{
SHGDNF uRemove;
SHGDNF uAdd;
DWORD dwRetryFlags;
};
static const RETRY_DATA g_RetryData[] =
{
{ SHGDN_FOREDITING, SHGDN_NORMAL, SFGDNO_RETRYALWAYS },
{ SHGDN_FORADDRESSBAR, SHGDN_NORMAL, SFGDNO_RETRYALWAYS },
{ SHGDN_NORMAL, SHGDN_FORPARSING, SFGDNO_RETRYALWAYS },
{ SHGDN_FORPARSING, SHGDN_NORMAL, SFGDNO_RETRYWITHFORPARSING },
{ SHGDN_INFOLDER, SHGDN_NORMAL, SFGDNO_RETRYALWAYS },
};
/*************************************************************************
* IShellFolder_GetDisplayNameOf [SHLWAPI.316]
*
* @note Don't confuse with <shobjidl.h> inline function of the same name.
* If the original call fails with the given uFlags, this function will
* retry with other flags to attempt retrieving any meaningful description.
*/
EXTERN_C HRESULT WINAPI
IShellFolder_GetDisplayNameOf(
_In_ IShellFolder *psf,
_In_ LPCITEMIDLIST pidl,
_In_ SHGDNF uFlags,
_Out_ LPSTRRET lpName,
_In_ DWORD dwRetryFlags) // dwRetryFlags is an additional parameter
{
HRESULT hr;
TRACE("(%p)->(%p, 0x%lX, %p, 0x%lX)\n", psf, pidl, uFlags, lpName, dwRetryFlags);
hr = psf->GetDisplayNameOf(pidl, uFlags, lpName);
if (!SHLWAPI_IsBogusHRESULT(hr))
return hr;
dwRetryFlags |= SFGDNO_RETRYALWAYS;
if ((uFlags & SHGDN_FORPARSING) == 0)
dwRetryFlags |= SFGDNO_RETRYWITHFORPARSING;
// Retry with other flags to get successful results
for (SIZE_T iEntry = 0; iEntry < _countof(g_RetryData); ++iEntry)
{
const RETRY_DATA *pData = &g_RetryData[iEntry];
if (!(dwRetryFlags & pData->dwRetryFlags))
continue;
SHGDNF uNewFlags = ((uFlags & ~pData->uRemove) | pData->uAdd);
if (uNewFlags == uFlags)
continue;
hr = psf->GetDisplayNameOf(pidl, uNewFlags, lpName);
if (!SHLWAPI_IsBogusHRESULT(hr))
break;
uFlags = uNewFlags; // Update flags every time
}
return hr;
}
/*************************************************************************
* IShellFolder_ParseDisplayName [SHLWAPI.317]
*
* @note Don't confuse with <shobjidl.h> inline function of the same name.
* This function is safer than IShellFolder::ParseDisplayName.
*/
EXTERN_C HRESULT WINAPI
IShellFolder_ParseDisplayName(
_In_ IShellFolder *psf,
_In_opt_ HWND hwndOwner,
_In_opt_ LPBC pbcReserved,
_In_ LPOLESTR lpszDisplayName,
_Out_opt_ ULONG *pchEaten,
_Out_opt_ PIDLIST_RELATIVE *ppidl,
_Out_opt_ ULONG *pdwAttributes)
{
ULONG dummy1, dummy2;
TRACE("(%p)->(%p, %p, %s, %p, %p, %p)\n", psf, hwndOwner, pbcReserved,
debugstr_w(lpszDisplayName), pchEaten, ppidl, pdwAttributes);
if (!pdwAttributes)
{
dummy1 = 0;
pdwAttributes = &dummy1;
}
if (!pchEaten)
{
dummy2 = 0;
pchEaten = &dummy2;
}
if (ppidl)
*ppidl = NULL;
return psf->ParseDisplayName(hwndOwner, pbcReserved, lpszDisplayName, pchEaten,
ppidl, pdwAttributes);
}
/*************************************************************************
* IShellFolder_CompareIDs [SHLWAPI.551]
*
* @note Don't confuse with <shobjidl.h> inline function of the same name.
* This function tries IShellFolder2 if possible.
*/
EXTERN_C HRESULT WINAPI
IShellFolder_CompareIDs(
_In_ IShellFolder *psf,
_In_ LPARAM lParam,
_In_ PCUIDLIST_RELATIVE pidl1,
_In_ PCUIDLIST_RELATIVE pidl2)
{
TRACE("(%p, %p, %p, %p)\n", psf, lParam, pidl1, pidl2);
if (lParam & ~(SIZE_T)SHCIDS_COLUMNMASK)
{
/* Try as IShellFolder2 if possible */
HRESULT hr = psf->QueryInterface(IID_IShellFolder2, (void **)&psf);
if (FAILED(hr))
lParam &= SHCIDS_COLUMNMASK;
else
psf->Release();
}
return psf->CompareIDs(lParam, pidl1, pidl2);
}
Reference in a new issue View git blame Copy permalink