propbag.cpp File Reference

#include "precomp.h"
#include <shlwapi.h>
#include <shlwapi_undoc.h>
#include <shlobj_undoc.h>
#include <shlguid_undoc.h>
#include <atlstr.h>
#include <atlsimpcoll.h>
#include <atlcomcli.h>
#include <atlconv.h>
#include <strsafe.h>
#include <cstdlib>
#include <new>

Include dependency graph for propbag.cpp:

Go to the source code of this file.

Classes
class	CBasePropertyBag
struct	CPropMapEqual
class	CMemPropertyBag
class	CRegPropertyBag
class	CIniPropertyBag
class	CDesktopUpgradePropertyBag
struct	tagOLD_STREAM_HEADER
class	CViewStatePropertyBag

Macros
#define	_ATL_NO_EXCEPTIONS
#define	MODE_CAN_READ(dwMode)    (((dwMode) & (STGM_READ | STGM_WRITE | STGM_READWRITE)) != STGM_WRITE)
#define	MODE_CAN_WRITE(dwMode)    (((dwMode) & (STGM_READ | STGM_WRITE | STGM_READWRITE)) != STGM_READ)

Typedefs
typedef DWORDLONG	DESKVIEW_FLAGS
typedef struct tagOLD_STREAM_HEADER	OLD_STREAM_HEADER
typedef struct tagOLD_STREAM_HEADER *	POLD_STREAM_HEADER

Functions
	WINE_DEFAULT_DEBUG_CHANNEL (shell)
EXTERN_C HRESULT WINAPI	SHCreatePropertyBagOnMemory (_In_ DWORD dwMode, _In_ REFIID riid, _Out_ void **ppvObj)
EXTERN_C HRESULT WINAPI	SHCreatePropertyBagOnRegKey (_In_ HKEY hKey, _In_z_ LPCWSTR pszSubKey, _In_ DWORD dwMode, _In_ REFIID riid, _Out_ void **ppvObj)
EXTERN_C DWORD WINAPI	SHGetIniStringW (_In_z_ LPCWSTR appName, _In_z_ LPCWSTR keyName, _Out_writes_to_(outLen, return+1) LPWSTR out, _In_ DWORD outLen, _In_z_ LPCWSTR filename)
static BOOL	Is7BitClean (LPCWSTR psz)
EXTERN_C BOOL WINAPI	SHSetIniStringW (_In_z_ LPCWSTR appName, _In_z_ LPCWSTR keyName, _In_opt_z_ LPCWSTR str, _In_z_ LPCWSTR filename)
EXTERN_C DWORD WINAPI	SHGetIniStringUTF7W (_In_opt_z_ LPCWSTR lpAppName, _In_z_ LPCWSTR lpKeyName, _Out_writes_to_(nSize, return+1) _Post_z_ LPWSTR lpReturnedString, _In_ DWORD nSize, _In_z_ LPCWSTR lpFileName)
EXTERN_C BOOL WINAPI	SHSetIniStringUTF7W (_In_z_ LPCWSTR lpAppName, _In_z_ LPCWSTR lpKeyName, _In_opt_z_ LPCWSTR lpString, _In_z_ LPCWSTR lpFileName)
EXTERN_C HRESULT WINAPI	SHCreatePropertyBagOnProfileSection (_In_z_ LPCWSTR lpFileName, _In_opt_z_ LPCWSTR pszSection, _In_ DWORD dwMode, _In_ REFIID riid, _Out_ void **ppvObj)
HRESULT	SHGetDesktopUpgradePropertyBag (REFIID riid, void **ppvObj)
static HRESULT	BindCtx_CreateWithMode (DWORD dwMode, IBindCtx **ppbc)
static BOOL	SHIsRemovableDrive (LPCITEMIDLIST pidl)
EXTERN_C HRESULT WINAPI	SHGetViewStatePropertyBag (_In_opt_ PCIDLIST_ABSOLUTE pidl, _In_opt_ LPCWSTR bag_name, _In_ DWORD flags, _In_ REFIID riid, _Outptr_ void **ppv)
EXTERN_C VOID	FreeViewStatePropertyBagCache (VOID)
EXTERN_C INT WINAPI	SHGetPerScreenResName (_Out_writes_(cchBuffer) LPWSTR pszBuffer, _In_ INT cchBuffer, _In_ DWORD dwReserved)
EXTERN_C HRESULT WINAPI	IUnknown_QueryServicePropertyBag (_In_ IUnknown *punk, _In_ long flags, _In_ REFIID riid, _Outptr_ void **ppvObj)

Variables
CComPtr< CViewStatePropertyBag >	g_pCachedBag
CRITICAL_SECTION	g_csBagCacheLock

Macro Definition Documentation

_ATL_NO_EXCEPTIONS

#define _ATL_NO_EXCEPTIONS

Definition at line 8 of file propbag.cpp.

MODE_CAN_READ

#define MODE_CAN_READ

(

dwMode

)

(((dwMode) & (STGM_READ | STGM_WRITE | STGM_READWRITE)) != STGM_WRITE)

Definition at line 24 of file propbag.cpp.

MODE_CAN_WRITE

#define MODE_CAN_WRITE

(

dwMode

)

(((dwMode) & (STGM_READ | STGM_WRITE | STGM_READWRITE)) != STGM_READ)

Definition at line 26 of file propbag.cpp.

Typedef Documentation

DESKVIEW_FLAGS

typedef DWORDLONG DESKVIEW_FLAGS

Definition at line 1060 of file propbag.cpp.

OLD_STREAM_HEADER

typedef struct tagOLD_STREAM_HEADER OLD_STREAM_HEADER

POLD_STREAM_HEADER

typedef struct tagOLD_STREAM_HEADER * POLD_STREAM_HEADER

Function Documentation

BindCtx_CreateWithMode()

static HRESULT BindCtx_CreateWithMode ( DWORD  dwMode, IBindCtx **  ppbc  )

static

Definition at line 1527 of file propbag.cpp.

{
    HRESULT hr = ::CreateBindCtx(0, ppbc);
    if (FAILED(hr))
        return hr;
 
    IBindCtx *pbc = *ppbc;
 
    BIND_OPTS opts = { sizeof(opts) };
    opts.grfMode = dwMode;
    hr = pbc->SetBindOptions(&opts);
    if (FAILED(hr))
    {
        pbc->Release();
        *ppbc = NULL;
    }
 
    return hr;
}

Referenced by CViewStatePropertyBag::_CreateBag().

FreeViewStatePropertyBagCache()

EXTERN_C VOID FreeViewStatePropertyBagCache

(

VOID

)

Definition at line 1944 of file propbag.cpp.

{
    ::EnterCriticalSection(&g_csBagCacheLock);
    g_pCachedBag.Release();
    ::LeaveCriticalSection(&g_csBagCacheLock);
}

Referenced by DllMain().

Is7BitClean()

static BOOL Is7BitClean ( LPCWSTR  psz )

static

Definition at line 648 of file propbag.cpp.

{
    if (!psz)
        return TRUE;
 
    while (*psz)
    {
        if (*psz > 0x7F)
            return FALSE;
        ++psz;
    }
    return TRUE;
}

Referenced by SHSetIniStringW().

IUnknown_QueryServicePropertyBag()

EXTERN_C HRESULT WINAPI IUnknown_QueryServicePropertyBag	(	_In_ IUnknown *	punk,
		_In_ long	flags,
		_In_ REFIID	riid,
		_Outptr_ void **	ppvObj
	)

Definition at line 1986 of file propbag.cpp.

{
    TRACE("%p 0x%x %p %p\n", punk, flags, &riid, ppvObj);
 
    CComPtr<IShellBrowserService> pService;
    HRESULT hr = IUnknown_QueryService(punk, SID_STopLevelBrowser, IID_IShellBrowserService,
                                       (void **)&pService);
    if (FAILED(hr))
    {
        ERR("0x%X\n", hr);
        return hr;
    }
 
    return pService->GetPropertyBag(flags, riid, ppvObj);
}

Referenced by CDefView::LoadViewState(), and CDefView::SaveViewState().

SHCreatePropertyBagOnMemory()

EXTERN_C HRESULT WINAPI SHCreatePropertyBagOnMemory	(	_In_ DWORD	dwMode,
		_In_ REFIID	riid,
		_Out_ void **	ppvObj
	)

Definition at line 260 of file propbag.cpp.

{
    TRACE("0x%08X, %s, %p\n", dwMode, debugstr_guid(&riid), ppvObj);
 
    *ppvObj = NULL;
 
    CComPtr<CMemPropertyBag> pMemBag(new(std::nothrow) CMemPropertyBag(dwMode));
    if (!pMemBag)
        return E_OUTOFMEMORY;
 
    return pMemBag->QueryInterface(riid, ppvObj);
}

Referenced by SHCreatePropertyBag(), and SHPropertyBag_OnMemory().

SHCreatePropertyBagOnProfileSection()

EXTERN_C HRESULT WINAPI SHCreatePropertyBagOnProfileSection	(	_In_z_ LPCWSTR	lpFileName,
		_In_opt_z_ LPCWSTR	pszSection,
		_In_ DWORD	dwMode,
		_In_ REFIID	riid,
		_Out_ void **	ppvObj
	)

Definition at line 975 of file propbag.cpp.

{
    HANDLE hFile;
    PWCHAR pchFileTitle;
    WCHAR szBuff[MAX_PATH];
 
    if (dwMode & STGM_CREATE)
    {
        hFile = ::CreateFileW(lpFileName, 0, FILE_SHARE_DELETE, 0, CREATE_NEW,
                              FILE_ATTRIBUTE_HIDDEN | FILE_ATTRIBUTE_SYSTEM, NULL);
        if (hFile != INVALID_HANDLE_VALUE)
        {
            pchFileTitle = PathFindFileNameW(lpFileName);
            if (lstrcmpiW(pchFileTitle, L"desktop.ini") == 0)
            {
                StrCpyNW(szBuff, lpFileName, _countof(szBuff));
                if (PathRemoveFileSpecW(szBuff))
                    PathMakeSystemFolderW(szBuff);
            }
            ::CloseHandle(hFile);
        }
    }
 
    *ppvObj = NULL;
 
    if (!PathFileExistsW(lpFileName))
        return HRESULT_FROM_WIN32(ERROR_FILE_NOT_FOUND);
 
    CComPtr<CIniPropertyBag> pIniPB(new(std::nothrow) CIniPropertyBag(dwMode));
    if (!pIniPB)
        return E_OUTOFMEMORY;
 
    HRESULT hr = pIniPB->Init(lpFileName, pszSection);
    if (FAILED(hr))
    {
        ERR("0x%08X\n", hr);
        return hr;
    }
 
    return pIniPB->QueryInterface(riid, ppvObj);
}

Referenced by SHPropertyBag_OnIniFile().

SHCreatePropertyBagOnRegKey()

EXTERN_C HRESULT WINAPI SHCreatePropertyBagOnRegKey	(	_In_ HKEY	hKey,
		_In_z_ LPCWSTR	pszSubKey,
		_In_ DWORD	dwMode,
		_In_ REFIID	riid,
		_Out_ void **	ppvObj
	)

Definition at line 583 of file propbag.cpp.

{
    TRACE("%p, %s, 0x%08X, %s, %p\n", hKey, debugstr_w(pszSubKey), dwMode,
          debugstr_guid(&riid), ppvObj);
 
    *ppvObj = NULL;
 
    CComPtr<CRegPropertyBag> pRegBag(new(std::nothrow) CRegPropertyBag(dwMode));
    if (!pRegBag)
        return E_OUTOFMEMORY;
 
    HRESULT hr = pRegBag->Init(hKey, pszSubKey);
    if (FAILED(hr))
        return hr;
 
    return pRegBag->QueryInterface(riid, ppvObj);
}

Referenced by CViewStatePropertyBag::_CreateBag(), and CViewStatePropertyBag::_FindNearestInheritBag().

SHGetDesktopUpgradePropertyBag()

HRESULT SHGetDesktopUpgradePropertyBag	(	REFIID	riid,
		void **	ppvObj
	)

Definition at line 1209 of file propbag.cpp.

{
    *ppvObj = NULL;
    CComPtr<CDesktopUpgradePropertyBag> pPropBag(new(std::nothrow) CDesktopUpgradePropertyBag());
    if (!pPropBag)
        return E_OUTOFMEMORY;
    return pPropBag->QueryInterface(riid, ppvObj);
}

Referenced by CViewStatePropertyBag::_EnsureUpgradeBag().

SHGetIniStringUTF7W()

EXTERN_C DWORD WINAPI SHGetIniStringUTF7W	(	_In_opt_z_ LPCWSTR	lpAppName,
		_In_z_ LPCWSTR	lpKeyName,
		_Out_writes_to_(nSize, return+1) _Post_z_ LPWSTR	lpReturnedString,
		_In_ DWORD	nSize,
		_In_z_ LPCWSTR	lpFileName
	)

Definition at line 732 of file propbag.cpp.

{
    if (*lpKeyName == L'@') // UTF-7
        return SHGetIniStringW(lpAppName, lpKeyName + 1, lpReturnedString, nSize, lpFileName);
 
    return GetPrivateProfileStringW(lpAppName, lpKeyName, L"", lpReturnedString, nSize, lpFileName);
}

Referenced by CIniPropertyBag::Read().

SHGetIniStringW()

EXTERN_C DWORD WINAPI SHGetIniStringW	(	_In_z_ LPCWSTR	appName,
		_In_z_ LPCWSTR	keyName,
		_Out_writes_to_(outLen, return+1) LPWSTR	out,
		_In_ DWORD	outLen,
		_In_z_ LPCWSTR	filename
	)

Definition at line 612 of file propbag.cpp.

{
    TRACE("(%s,%s,%p,%08x,%s)\n", debugstr_w(appName), debugstr_w(keyName),
          out, outLen, debugstr_w(filename));
 
    if (outLen == 0)
        return 0;
 
    // Try ".W"-appended section name. See also SHSetIniStringW
    CStringW szSection(appName);
    szSection += L".W";
    CStringW pszWideBuff;
    const INT cchWideMax = 4 * MAX_PATH; // UTF-7 needs 4 times length buffer.
    GetPrivateProfileStringW(szSection, keyName, NULL,
                             pszWideBuff.GetBuffer(cchWideMax), cchWideMax, filename);
    pszWideBuff.ReleaseBuffer();
 
    if (pszWideBuff.IsEmpty()) // It's empty or not found
    {
        // Try the normal section name
        return GetPrivateProfileStringW(appName, keyName, NULL, out, outLen, filename);
    }
 
    // Okay, now ".W" version is valid. Its value is a UTF-7 string in UTF-16
    CW2A wide2utf7(pszWideBuff);
    MultiByteToWideChar(CP_UTF7, 0, wide2utf7, -1, out, outLen);
    out[outLen - 1] = UNICODE_NULL;
 
    return lstrlenW(out);
}

Referenced by SHGetIniStringUTF7W().

SHGetPerScreenResName()

EXTERN_C INT WINAPI SHGetPerScreenResName	(	_Out_writes_(cchBuffer) LPWSTR	pszBuffer,
		_In_ INT	cchBuffer,
		_In_ DWORD	dwReserved
	)

Definition at line 1957 of file propbag.cpp.

{
    if (dwReserved)
        return 0;
 
    HDC hDC = ::GetDC(NULL);
    INT cxWidth = ::GetDeviceCaps(hDC, HORZRES);
    INT cyHeight = ::GetDeviceCaps(hDC, VERTRES);
    INT cMonitors = ::GetSystemMetrics(SM_CMONITORS);
    ::ReleaseDC(NULL, hDC);
 
    StringCchPrintfW(pszBuffer, cchBuffer, L"%dx%d(%d)", cxWidth, cyHeight, cMonitors);
    return lstrlenW(pszBuffer);
}

Referenced by CDefView::SaveViewState(), and SHPropertyBag_PerScreenRes().

SHGetViewStatePropertyBag()

EXTERN_C HRESULT WINAPI SHGetViewStatePropertyBag	(	_In_opt_ PCIDLIST_ABSOLUTE	pidl,
		_In_opt_ LPCWSTR	bag_name,
		_In_ DWORD	flags,
		_In_ REFIID	riid,
		_Outptr_ void **	ppv
	)

Definition at line 1896 of file propbag.cpp.

{
    HRESULT hr;
 
    TRACE("%p %s 0x%X %p %p\n", pidl, debugstr_w(bag_name), flags, &riid, ppv);
 
    *ppv = NULL;
 
    ::EnterCriticalSection(&g_csBagCacheLock);
 
    if (g_pCachedBag && g_pCachedBag->IsSameBag(pidl, bag_name, flags))
    {
        hr = g_pCachedBag->QueryInterface(riid, ppv);
        ::LeaveCriticalSection(&g_csBagCacheLock);
        return hr;
    }
 
    if (SHIsRemovableDrive(pidl))
    {
        TRACE("pidl %p is removable\n", pidl);
        ::LeaveCriticalSection(&g_csBagCacheLock);
        return E_FAIL;
    }
 
    CComPtr<CViewStatePropertyBag> pBag(new(std::nothrow) CViewStatePropertyBag());
    if (!pBag)
    {
        ::LeaveCriticalSection(&g_csBagCacheLock);
        return E_OUTOFMEMORY;
    }
 
    hr = pBag->Init(pidl, bag_name, flags);
    if (FAILED(hr))
    {
        ERR("0x%08X\n", hr);
        ::LeaveCriticalSection(&g_csBagCacheLock);
        return hr;
    }
    g_pCachedBag = pBag;
    ::LeaveCriticalSection(&g_csBagCacheLock);
    return pBag->QueryInterface(riid, ppv);
}

Referenced by CDesktopBrowser::GetPropertyBag(), and CShellBrowser::GetPropertyBag().

SHIsRemovableDrive()

static BOOL SHIsRemovableDrive ( LPCITEMIDLIST  pidl )

static

Definition at line 1852 of file propbag.cpp.

{
    STRRET strret;
    CComPtr<IShellFolder> psf;
    WCHAR szBuff[MAX_PATH];
    LPCITEMIDLIST ppidlLast;
    INT iDrive, nType;
    HRESULT hr;
 
    hr = SHBindToParent(pidl, IID_IShellFolder, (void **)&psf, &ppidlLast);
    if (FAILED(hr))
        return FALSE;
 
    hr = psf->GetDisplayNameOf(ppidlLast, SHGDN_FORPARSING, &strret);
    if (FAILED(hr))
        return FALSE;
 
    hr = StrRetToBufW(&strret, ppidlLast, szBuff, _countof(szBuff));
    if (FAILED(hr))
        return FALSE;
 
    iDrive = PathGetDriveNumberW(szBuff);
    if (iDrive < 0)
        return FALSE;
 
    nType = RealDriveType(iDrive, FALSE);
    return (nType == DRIVE_REMOVABLE || nType == DRIVE_CDROM);
}

Referenced by SHGetViewStatePropertyBag().

SHSetIniStringUTF7W()

EXTERN_C BOOL WINAPI SHSetIniStringUTF7W	(	_In_z_ LPCWSTR	lpAppName,
		_In_z_ LPCWSTR	lpKeyName,
		_In_opt_z_ LPCWSTR	lpString,
		_In_z_ LPCWSTR	lpFileName
	)

Definition at line 758 of file propbag.cpp.

{
    if (*lpKeyName == L'@') // UTF-7
        return SHSetIniStringW(lpAppName, lpKeyName + 1, lpString, lpFileName);
 
    return WritePrivateProfileStringW(lpAppName, lpKeyName, lpString, lpFileName);
}

Referenced by CIniPropertyBag::Write().

SHSetIniStringW()

EXTERN_C BOOL WINAPI SHSetIniStringW	(	_In_z_ LPCWSTR	appName,
		_In_z_ LPCWSTR	keyName,
		_In_opt_z_ LPCWSTR	str,
		_In_z_ LPCWSTR	filename
	)

Definition at line 668 of file propbag.cpp.

{
    TRACE("(%s, %p, %s, %s)\n", debugstr_w(appName), keyName, debugstr_w(str),
          debugstr_w(filename));
 
    // Write a normal profile string. If str was NULL, then key will be deleted
    if (!WritePrivateProfileStringW(appName, keyName, str, filename))
        return FALSE;
 
    if (Is7BitClean(str))
    {
        // Delete ".A" version
        CStringW szSection(appName);
        szSection += L".A";
        WritePrivateProfileStringW(szSection, keyName, NULL, filename);
 
        // Delete ".W" version
        szSection = appName;
        szSection += L".W";
        WritePrivateProfileStringW(szSection, keyName, NULL, filename);
 
        return TRUE;
    }
 
    // Now str is not 7-bit clean. It needs UTF-7 encoding in UTF-16.
    // We write ".A" and ".W"-appended sections
    CW2A wide2utf7(str, CP_UTF7);
    CA2W utf72wide(wide2utf7, CP_ACP);
 
    BOOL ret = TRUE;
 
    // Write ".A" version
    CStringW szSection(appName);
    szSection += L".A";
    if (!WritePrivateProfileStringW(szSection, keyName, str, filename))
        ret = FALSE;
 
    // Write ".W" version
    szSection = appName;
    szSection += L".W";
    if (!WritePrivateProfileStringW(szSection, keyName, utf72wide, filename))
        ret = FALSE;
 
    return ret;
}

Referenced by SHSetIniStringUTF7W().

WINE_DEFAULT_DEBUG_CHANNEL()

WINE_DEFAULT_DEBUG_CHANNEL

(

shell

)

Variable Documentation

g_csBagCacheLock

CRITICAL_SECTION g_csBagCacheLock

Definition at line 1325 of file propbag.cpp.

Referenced by DllMain(), FreeViewStatePropertyBagCache(), and SHGetViewStatePropertyBag().

g_pCachedBag

CComPtr<CViewStatePropertyBag> g_pCachedBag

Definition at line 1322 of file propbag.cpp.

Referenced by FreeViewStatePropertyBagCache(), and SHGetViewStatePropertyBag().