CChangeNotifyServer Class Reference

Inheritance diagram for CChangeNotifyServer:

Collaboration diagram for CChangeNotifyServer:

Public Member Functions
	CChangeNotifyServer ()
virtual	~CChangeNotifyServer ()
HRESULT	Initialize ()
STDMETHOD()	GetWindow (HWND *lphwnd) override
STDMETHOD()	ContextSensitiveHelp (BOOL fEnterMode) override
LRESULT	OnRegister (UINT uMsg, WPARAM wParam, LPARAM lParam, BOOL &bHandled)
LRESULT	OnUnRegister (UINT uMsg, WPARAM wParam, LPARAM lParam, BOOL &bHandled)
LRESULT	OnDeliverNotification (UINT uMsg, WPARAM wParam, LPARAM lParam, BOOL &bHandled)
LRESULT	OnSuspendResume (UINT uMsg, WPARAM wParam, LPARAM lParam, BOOL &bHandled)
LRESULT	OnRemoveByPID (UINT uMsg, WPARAM wParam, LPARAM lParam, BOOL &bHandled)
LRESULT	OnDestroy (UINT uMsg, WPARAM wParam, LPARAM lParam, BOOL &bHandled)
	MESSAGE_HANDLER (CN_UNREGISTER_PROCESS, OnRemoveByPID)
	MESSAGE_HANDLER (WM_DESTROY, OnDestroy)
Public Member Functions inherited from ATL::CComObjectRootEx< CComMultiThreadModelNoCS >
	~CComObjectRootEx ()
ULONG	InternalAddRef ()
ULONG	InternalRelease ()
void	Lock ()
void	Unlock ()
HRESULT	_AtlInitialConstruct ()
Public Member Functions inherited from ATL::CComObjectRootBase
	CComObjectRootBase ()
	~CComObjectRootBase ()
void	SetVoid (void *)
HRESULT	_AtlFinalConstruct ()
HRESULT	FinalConstruct ()
void	InternalFinalConstructAddRef ()
void	InternalFinalConstructRelease ()
void	FinalRelease ()
HRESULT	GetWindow ([out] HWND *phwnd)
HRESULT	ContextSensitiveHelp ([in] BOOL fEnterMode)
Public Member Functions inherited from IUnknown
HRESULT	QueryInterface ([in] REFIID riid, [out, iid_is(riid)] void **ppvObject)
ULONG	AddRef ()
ULONG	Release ()

Private Member Functions
BOOL	AddItem (CWatchItem *pItem)
BOOL	RemoveItemsByRegID (UINT nRegID)
BOOL	RemoveItemsByProcess (DWORD dwUserPID)
void	DestroyItem (CWatchItem *pItem, HWND *phwndBroker)
void	DestroyAllItems ()
UINT	GetNextRegID ()
BOOL	DeliverNotification (HANDLE hTicket, DWORD dwOwnerPID)
BOOL	ShouldNotify (LPDELITICKET pTicket, LPREGENTRY pRegEntry)

Private Attributes
UINT	m_nNextRegID
CSimpleArray< CWatchItem * >	m_items

Additional Inherited Members
Public Types inherited from IOleWindow
typedef IOleWindow *	LPOLEWINDOW
Public Types inherited from IUnknown
typedef IUnknown *	LPUNKNOWN
Static Public Member Functions inherited from ATL::CComObjectRootBase
static void WINAPI	ObjectMain (bool)
static const struct _ATL_CATMAP_ENTRY *	GetCategoryMap ()
static HRESULT WINAPI	InternalQueryInterface (void *pThis, const _ATL_INTMAP_ENTRY *pEntries, REFIID iid, void **ppvObject)
Public Attributes inherited from ATL::CComObjectRootBase
LONG	m_dwRef

Detailed Description

Definition at line 34 of file CChangeNotifyServer.cpp.

Constructor & Destructor Documentation

CChangeNotifyServer()

CChangeNotifyServer::CChangeNotifyServer

(

)

Definition at line 89 of file CChangeNotifyServer.cpp.

    : m_nNextRegID(INVALID_REG_ID)
{
}

~CChangeNotifyServer()

CChangeNotifyServer::~CChangeNotifyServer ( )

virtual

Definition at line 94 of file CChangeNotifyServer.cpp.

{
}

Member Function Documentation

AddItem()

BOOL CChangeNotifyServer::AddItem ( CWatchItem *  pItem )

private

Definition at line 98 of file CChangeNotifyServer.cpp.

{
    // find the empty room
    for (INT i = 0; i < m_items.GetSize(); ++i)
    {
        if (m_items[i] == NULL)
        {
            // found the room, populate it
            m_items[i] = pItem;
            return TRUE;
        }
    }
 
    // no empty room found
    m_items.Add(pItem);
    return TRUE;
}

ContextSensitiveHelp()

HRESULT WINAPI CChangeNotifyServer::ContextSensitiveHelp ( BOOL  fEnterMode )

override

Implements IOleWindow.

Definition at line 461 of file CChangeNotifyServer.cpp.

{
    return E_NOTIMPL;
}

DeliverNotification()

BOOL CChangeNotifyServer::DeliverNotification ( HANDLE  hTicket, DWORD  dwOwnerPID  )

private

Definition at line 353 of file CChangeNotifyServer.cpp.

{
    TRACE("DeliverNotification(%p, %p, 0x%lx)\n", m_hWnd, hTicket, dwOwnerPID);
 
    // lock the delivery ticket
    LPDELITICKET pTicket = (LPDELITICKET)SHLockSharedEx(hTicket, dwOwnerPID, FALSE);
    if (pTicket == NULL || pTicket->dwMagic != DELITICKET_MAGIC)
    {
        ERR("pTicket is invalid\n");
        SHUnlockShared(pTicket);
        return FALSE;
    }
 
    // for all items
    for (INT i = 0; i < m_items.GetSize(); ++i)
    {
        if (m_items[i] == NULL)
            continue;
 
        LPREGENTRY pRegEntry = m_items[i]->pRegEntry;
        if (pRegEntry == NULL || pRegEntry->dwMagic != REGENTRY_MAGIC)
        {
            ERR("pRegEntry is invalid\n");
            continue;
        }
 
        // should we notify for it?
        BOOL bNotify = ShouldNotify(pTicket, pRegEntry);
        if (bNotify)
        {
            // do notify
            TRACE("Notifying: %p, 0x%x, %p, %lu\n",
                  pRegEntry->hwnd, pRegEntry->uMsg, hTicket, dwOwnerPID);
            SendMessageW(pRegEntry->hwnd, pRegEntry->uMsg, (WPARAM)hTicket, dwOwnerPID);
            TRACE("GetLastError(): %ld\n", ::GetLastError());
        }
    }
 
    // unlock the ticket
    SHUnlockShared(pTicket);
 
    return TRUE;
}

Referenced by OnDeliverNotification().

DestroyAllItems()

void CChangeNotifyServer::DestroyAllItems ( )

private

Definition at line 140 of file CChangeNotifyServer.cpp.

{
    for (INT i = 0; i < m_items.GetSize(); ++i)
    {
        if (m_items[i])
        {
            HWND hwndBroker = NULL;
            DestroyItem(m_items[i], &hwndBroker);
            m_items[i] = NULL;
        }
    }
    m_items.RemoveAll();
}

Referenced by OnDestroy().

DestroyItem()

void CChangeNotifyServer::DestroyItem ( CWatchItem *  pItem, HWND *  phwndBroker  )

private

Definition at line 116 of file CChangeNotifyServer.cpp.

{
    assert(pItem);
 
    // destroy broker if any and if first time
    HWND hwndBroker = pItem->hwndBroker;
    pItem->hwndBroker = NULL;
    if (hwndBroker && hwndBroker != *phwndBroker)
    {
        ::DestroyWindow(hwndBroker);
        *phwndBroker = hwndBroker;
    }
 
    // request termination of pDirWatch if any
    CDirectoryWatcher *pDirWatch = pItem->pDirWatch;
    pItem->pDirWatch = NULL;
    if (pDirWatch)
        pDirWatch->RequestTermination();
 
    // free
    SHFree(pItem->pRegEntry);
    delete pItem;
}

Referenced by DestroyAllItems(), RemoveItemsByProcess(), and RemoveItemsByRegID().

GetNextRegID()

UINT CChangeNotifyServer::GetNextRegID ( )

private

Definition at line 343 of file CChangeNotifyServer.cpp.

{
    m_nNextRegID++;
    if (m_nNextRegID == INVALID_REG_ID)
        m_nNextRegID++;
    return m_nNextRegID;
}

Referenced by OnRegister().

GetWindow()

HRESULT WINAPI CChangeNotifyServer::GetWindow ( HWND *  lphwnd )

override

Implements IOleWindow.

Definition at line 453 of file CChangeNotifyServer.cpp.

{
    if (!phwnd)
        return E_INVALIDARG;
    *phwnd = m_hWnd;
    return S_OK;
}

Initialize()

HRESULT CChangeNotifyServer::Initialize

(

)

Definition at line 466 of file CChangeNotifyServer.cpp.

{
    // This is called by CChangeNotifyServer_CreateInstance right after instantiation.
    HWND hwnd = SHCreateDefaultWorkerWindow();
    if (!hwnd)
        return E_FAIL;
    SubclassWindow(hwnd);
    return S_OK;
}

MESSAGE_HANDLER() [1/2]

CChangeNotifyServer::MESSAGE_HANDLER	(	CN_UNREGISTER_PROCESS	,
		OnRemoveByPID
	)

MESSAGE_HANDLER() [2/2]

CChangeNotifyServer::MESSAGE_HANDLER	(	WM_DESTROY	,
		OnDestroy
	)

OnDeliverNotification()

LRESULT CChangeNotifyServer::OnDeliverNotification	(	UINT	uMsg,
		WPARAM	wParam,
		LPARAM	lParam,
		BOOL &	bHandled
	)

Definition at line 299 of file CChangeNotifyServer.cpp.

{
    TRACE("OnDeliverNotification(%p, %u, %p, %p)\n", m_hWnd, uMsg, wParam, lParam);
 
    HANDLE hTicket = (HANDLE)wParam;
    DWORD dwOwnerPID = (DWORD)lParam;
 
    // do delivery
    BOOL ret = DeliverNotification(hTicket, dwOwnerPID);
 
    // free the ticket
    SHFreeShared(hTicket, dwOwnerPID);
    return ret;
}

OnDestroy()

LRESULT CChangeNotifyServer::OnDestroy	(	UINT	uMsg,
		WPARAM	wParam,
		LPARAM	lParam,
		BOOL &	bHandled
	)

Definition at line 335 of file CChangeNotifyServer.cpp.

{
    DestroyAllItems();
    CDirectoryWatcher::RequestAllWatchersTermination();
    return 0;
}

OnRegister()

LRESULT CChangeNotifyServer::OnRegister	(	UINT	uMsg,
		WPARAM	wParam,
		LPARAM	lParam,
		BOOL &	bHandled
	)

Definition at line 213 of file CChangeNotifyServer.cpp.

{
    TRACE("OnRegister(%p, %u, %p, %p)\n", m_hWnd, uMsg, wParam, lParam);
 
    // lock the registration entry
    HANDLE hRegEntry = (HANDLE)wParam;
    DWORD dwOwnerPID = (DWORD)lParam;
    LPREGENTRY pRegEntry = (LPREGENTRY)SHLockSharedEx(hRegEntry, dwOwnerPID, TRUE);
    if (pRegEntry == NULL || pRegEntry->dwMagic != REGENTRY_MAGIC)
    {
        ERR("pRegEntry is invalid\n");
        SHUnlockShared(pRegEntry);
        return FALSE;
    }
 
    // update registration ID if necessary
    if (pRegEntry->nRegID == INVALID_REG_ID)
        pRegEntry->nRegID = GetNextRegID();
 
    TRACE("pRegEntry->nRegID: %u\n", pRegEntry->nRegID);
 
    // get the user PID; that is the process ID of the target window
    DWORD dwUserPID;
    GetWindowThreadProcessId(pRegEntry->hwnd, &dwUserPID);
 
    // get broker if any
    HWND hwndBroker = pRegEntry->hwndBroker;
 
    // clone the registration entry
    LPREGENTRY pNewEntry = (LPREGENTRY)SHAlloc(pRegEntry->cbSize);
    if (pNewEntry == NULL)
    {
        ERR("Out of memory\n");
        pRegEntry->nRegID = INVALID_REG_ID;
        SHUnlockShared(pRegEntry);
        return FALSE;
    }
    CopyMemory(pNewEntry, pRegEntry, pRegEntry->cbSize);
 
    // create a directory watch if necessary
    CDirectoryWatcher *pDirWatch = NULL;
    if (pRegEntry->ibPidl && (pRegEntry->fSources & SHCNRF_InterruptLevel))
    {
        pDirWatch = CreateDirectoryWatcherFromRegEntry(pRegEntry);
        if (pDirWatch && !pDirWatch->RequestAddWatcher())
        {
            ERR("RequestAddWatcher failed: %u\n", pRegEntry->nRegID);
            pRegEntry->nRegID = INVALID_REG_ID;
            SHUnlockShared(pRegEntry);
            delete pDirWatch;
            return FALSE;
        }
    }
 
    // unlock the registry entry
    SHUnlockShared(pRegEntry);
 
    // add an item
    CWatchItem *pItem = new CWatchItem { m_nNextRegID, dwUserPID, pNewEntry, hwndBroker, pDirWatch };
    return AddItem(pItem);
}

OnRemoveByPID()

LRESULT CChangeNotifyServer::OnRemoveByPID	(	UINT	uMsg,
		WPARAM	wParam,
		LPARAM	lParam,
		BOOL &	bHandled
	)

Definition at line 328 of file CChangeNotifyServer.cpp.

{
    DWORD dwUserPID = (DWORD)wParam;
    RemoveItemsByProcess(dwUserPID);
    return 0;
}

OnSuspendResume()

LRESULT CChangeNotifyServer::OnSuspendResume	(	UINT	uMsg,
		WPARAM	wParam,
		LPARAM	lParam,
		BOOL &	bHandled
	)

Definition at line 316 of file CChangeNotifyServer.cpp.

{
    TRACE("OnSuspendResume\n");
 
    // FIXME
    return FALSE;
}

OnUnRegister()

LRESULT CChangeNotifyServer::OnUnRegister	(	UINT	uMsg,
		WPARAM	wParam,
		LPARAM	lParam,
		BOOL &	bHandled
	)

Definition at line 279 of file CChangeNotifyServer.cpp.

{
    TRACE("OnUnRegister(%p, %u, %p, %p)\n", m_hWnd, uMsg, wParam, lParam);
 
    // validate registration ID
    UINT nRegID = (UINT)wParam;
    if (nRegID == INVALID_REG_ID)
    {
        ERR("INVALID_REG_ID\n");
        return FALSE;
    }
 
    // remove it
    return RemoveItemsByRegID(nRegID);
}

RemoveItemsByProcess()

BOOL CChangeNotifyServer::RemoveItemsByProcess ( DWORD  dwUserPID )

private

Definition at line 171 of file CChangeNotifyServer.cpp.

{
    BOOL bFound = FALSE;
    HWND hwndBroker = NULL;
    assert(dwUserPID != 0);
    for (INT i = 0; i < m_items.GetSize(); ++i)
    {
        if (m_items[i] && m_items[i]->dwUserPID == dwUserPID)
        {
            bFound = TRUE;
            DestroyItem(m_items[i], &hwndBroker);
            m_items[i] = NULL;
        }
    }
    return bFound;
}

Referenced by OnRemoveByPID().

RemoveItemsByRegID()

BOOL CChangeNotifyServer::RemoveItemsByRegID ( UINT  nRegID )

private

Definition at line 154 of file CChangeNotifyServer.cpp.

{
    BOOL bFound = FALSE;
    HWND hwndBroker = NULL;
    assert(nRegID != INVALID_REG_ID);
    for (INT i = 0; i < m_items.GetSize(); ++i)
    {
        if (m_items[i] && m_items[i]->nRegID == nRegID)
        {
            bFound = TRUE;
            DestroyItem(m_items[i], &hwndBroker);
            m_items[i] = NULL;
        }
    }
    return bFound;
}

Referenced by OnUnRegister().

ShouldNotify()

BOOL CChangeNotifyServer::ShouldNotify ( LPDELITICKET  pTicket, LPREGENTRY  pRegEntry  )

private

Definition at line 397 of file CChangeNotifyServer.cpp.

{
#define RETURN(x) do { \
    TRACE("ShouldNotify return %d\n", (x)); \
    return (x); \
} while (0)
 
    if (pTicket->wEventId & SHCNE_INTERRUPT)
    {
        if (!(pRegEntry->fSources & SHCNRF_InterruptLevel))
            RETURN(FALSE);
        if (!pRegEntry->ibPidl)
            RETURN(FALSE);
    }
    else
    {
        if (!(pRegEntry->fSources & SHCNRF_ShellLevel))
            RETURN(FALSE);
    }
 
    if (!(pTicket->wEventId & pRegEntry->fEvents))
        RETURN(FALSE);
 
    LPITEMIDLIST pidl = NULL, pidl1 = NULL, pidl2 = NULL;
    if (pRegEntry->ibPidl)
        pidl = (LPITEMIDLIST)((LPBYTE)pRegEntry + pRegEntry->ibPidl);
    if (pTicket->ibOffset1)
        pidl1 = (LPITEMIDLIST)((LPBYTE)pTicket + pTicket->ibOffset1);
    if (pTicket->ibOffset2)
        pidl2 = (LPITEMIDLIST)((LPBYTE)pTicket + pTicket->ibOffset2);
 
    if (pidl == NULL || (pTicket->wEventId & SHCNE_GLOBALEVENTS))
        RETURN(TRUE);
 
    if (pRegEntry->fRecursive)
    {
        if (ILIsParent(pidl, pidl1, FALSE) ||
            (pidl2 && ILIsParent(pidl, pidl2, FALSE)))
        {
            RETURN(TRUE);
        }
    }
    else
    {
        if (ILIsEqual(pidl, pidl1) ||
            ILIsParent(pidl, pidl1, TRUE) ||
            (pidl2 && ILIsParent(pidl, pidl2, TRUE)))
        {
            RETURN(TRUE);
        }
    }
 
    RETURN(FALSE);
#undef RETURN
}

Referenced by DeliverNotification().

Member Data Documentation

m_items

CSimpleArray<CWatchItem*> CChangeNotifyServer::m_items

private

Definition at line 76 of file CChangeNotifyServer.cpp.

Referenced by AddItem(), DeliverNotification(), DestroyAllItems(), RemoveItemsByProcess(), and RemoveItemsByRegID().

m_nNextRegID

UINT CChangeNotifyServer::m_nNextRegID

private

Definition at line 75 of file CChangeNotifyServer.cpp.

Referenced by GetNextRegID(), and OnRegister().

---

The documentation for this class was generated from the following file:

• dll/win32/shell32/shelldesktop/CChangeNotifyServer.cpp