关键字:Google Toolbar, Explorer Bars, ToolBands, IObjectWithSite, IDeskBand
1、概述
Internet Explorer强大而方便的可编程能力和可扩展能力为其抢占浏览器市场可谓是立下了汗马功劳。可编程主要体现两方面:
实现浏览功能的部分被包装成一个控件——WebBrowser Control,开发人员可以在自己的应用程序中嵌入它从而使程序具有访问Internet上网页的能力,同时WebBrowser Control也能够被灵活地自定义以满足不同的需要。可对Microsoft Internet Explorer应用程序本身嵌入的浏览器控件编程,一般通过BHO(
Browser Helper Object)来实现。
可扩展能力则体现在几个方面:
嵌入式面板型扩展,包括Explorer Bars(如收藏夹、搜索、历史等嵌入IE主窗口的大型面板), Tool Bands(如Google Toolbar、MSN Toolbar等嵌入IE的工具条), 和Desk Bands(如快速启动这类嵌入任务栏的面板,实际上是Explorer外壳的扩展)。这几种面板的编写方法相差无几,不同之处主要在于向系统注册方式的不同。
是参数型扩展,包括为浏览器增加上下文菜单项(调用脚本)、为浏览器主菜单增加菜单项、为浏览器“标准按钮”工具条添加按钮等。其他扩展,如文件下载的扩展(Custom Download Manager)、地址栏扩展(搜索扩展)等。
随着IE的发展,各种类型的扩展遍地开花,其中最为引人注目的,当属地址栏扩展和工具条扩展(几乎成了兵家必争之地)。本文讨论的主题,正是工具条的扩展。
2、问题的提出
两个原因促成了Google Toolbar的流行,一是广告窗口的泛滥、二是Google Search。Google“简单”(实则一点都不简单,没有搜索引擎的强力支持,Toolbar的用途就大受限制)地抓住了这两点,迅速占领了市场。
插件的一大好处在于可以不修改主程序,只需换一个样子差不多但功能更强的东西就可以使得整个应用程序功能增强,所以IE不升级大家也觉得Google Toobar越来越好用。于是利用WebBroser Control编写浏览器的开发人员就想,如果能像IE一样支持上述这些扩展,不就能把Google Toolbar拿过来用了吗?其他的事交给Google去做就行了。这就是我们要讨论的问题,“如何在自己的浏览器中嵌入Google Toolbar”。
3、分析
微软并未在MSDN中说明如何将Google Toolbar这类IE的工具条插件嵌入自己的应用程序,但其基于COM的设计方法实际上给予了我们这个能力(创建嵌入式的工具条的方法并不是本文的重点,此处略去,有兴趣的朋友可以参考MSDN)。我们知道,除了IUnknown接口外,Bands和Bars(以下简称Band对象)还需要实现三个接口:IObjectWithSite,IPersistStream和IDeskBand。当用户选择工具条或面板时,其容器(如IE的外壳框架)就会调用Band对象的IObjectWithSite::SetSite方法(该方法仅需要一个IUnknown类型的指针),将自己实现的IUnknown指针传递给Band对象。这就是整个插件开始真正激活的入口,也是我们的着手点。
MSDN中说到,一般来说,Band对象对于SetSite方法的实现需要完成以下几件事:
如果当前Band对象持有另外的Site指针,则首先释放该指针。如果容器向SetSite方法传入的是一个空指针,则表示要删除该Band对象,此时SetSite返回S_OK即可。
如果容器传入的不是空指针,则需要设置新的Site:
对此IUnknown指针所指的新Site调用QueryInterface查询得到其IOleWindow接口。调用得到的IOleWindow接口的GetWindow方法获取父窗口的句柄(此窗口即是Band对象的栖身之处)并保存下来。如果以后不会再用到IOleWindow接口的话就对其调用Release。现在可以创建Band对象的窗口了,当然,要以第2步得到的窗口为父窗口来创建,并且该窗口目前只能以不可见状态存在。如果Band对象实现了IInputObject接口,即需要接收键盘输入,则还需要向容器传来的Site查询(QueryInterface)IInputObjectSite接口,此接口指针也需要保存下来。上述步骤完成后即可返回S_OK,否则应返回OLE-defined的error code告知容器什么地方出了错。
显然,就我们要讨论的问题而言,只需换个角度(编写IE外壳的的角度)来考虑即可。首先,我们需要一个IUnknown接口(即Band对象所需的Site),其次需要一个IInputObjectSite接口,用以和Band对象的IInputObject接口交互,处理输入焦点转移的情况。接下来就可以通过Band对象的IDeskBand接口来显示、隐藏Band对象了(注意IDeskBand接口派生自IDockingWindow接口,后者又派生自IOleWindow接口)。
4、实现
实现分为两个部分,其一是一个简单的类,用以模拟IE外壳,我取名为CIESimulator。其二是一个管理IE扩展的类CIEBandPlugInManager,用以管理Band对象的方方面面。
class CIESimulator : public IInputObjectSite
{
private:
IWebBrowser2 *m_pwb; //保存WebBrowser Control的接口指针
public:
CIESimulator(void){};
~CIESimulator(void){};
void SetIWebBrowser2(IWebBrowser2* pwb);
//IUnknown methods
STDMETHODIMP QueryInterface(REFIID, void **);
STDMETHODIMP_(ULONG) AddRef(void);
STDMETHODIMP_(ULONG) Release(void);
//IInputObjectSite specific methods
STDMETHOD(OnFocusChangeIS)(THIS_ IUnknown* punkObj, BOOL fSetFocus);
};
//IUnknown methods
STDMETHODIMP CIESimulator::QueryInterface( REFIID riid, void **ppv )
{
if ( riid == IID_IInputObjectSite ) //这个接口需要自己处理
{
*ppv = static_cast<IInputObjectSite*>(this);
}
else if ( m_pwb ) //其它的交给WebBrowser Control去处理
{
m_pwb->QueryInterface( riid, ppv );
}
return S_OK;
}
//IInputObjectSite specific methods
STDMETHODIMP CIESimulator::OnFocusChangeIS(IUnknown* punkObj, BOOL fSetFocus)
{
return S_OK; //此处我们简单地返回
}
void CIESimulator::SetIWebBrowser2(IWebBrowser2* pwb)
{
m_pwb = pwb;
}
注意这里我们并没有实现IOleWindow接口来向Band对象传递父窗口对象(窗口的宿主可以更改,所以Band对象创建的窗口的父窗口我们并不关心,Band对象查询IOleWindow接口的动作实际上是向WebBrowser Control查询),而是在稍后的CIEBandPlugInManager类中通过调用IDeskBand的GetWindow方法获得Band对象的窗口句柄,再手动将其嵌入我们指定的窗口中。
首先我们定义一个结构用以保存Band的信息:
enum eBANDTYPE
{
btVertical = 0,
btHorizontal = 1
};
enum eBANDSTATE
{
bsUnInitialized = -1,
bsVisible = 0,
bsInVisible = 1,
bsUnLoaded = 2
};
typedef struct tagIEBANDINFO
{
char
szCLSID[39];
char
szName[MAX_PATH];
IUnknown
*puk;
HWND
hBand;
UINT
uMinHeight;
UINT
uBandID;
eBANDTYPE
eBandType;
eBANDSTATE
eBandState;
} IEBANDINFO, *LPIEBANDINFO;
再用一个函数来获取所有Band的信息(以下代码为示例,具体实现是可从注册表把所有Band的信息一一读出)
void CIEBandPlugInManager::GetAllBandCLSID(void)
{
LPIEBANDINFO pIEBandInfo;
pIEBandInfo = new IEBANDINFO();
strcpy( pIEBandInfo->szCLSID, "{2318C2B1-4965-11d4-9B18-009027A5CD4F}\0"); //Google Toolbar的CLSID
strcpy( pIEBandInfo->szName, GetDisplayName(pIEBandInfo->szCLSID) );
pIEBandInfo->uMinHeight = 22;
pIEBandInfo->uBandID = m_BandCtrlID++;
pIEBandInfo->eBandType = btHorizontal;
pIEBandInfo->eBandState = bsUnInitialized;
m_oaBand.Add( (CObject*)pIEBandInfo );//m_oaBand是一个CObArray
}
//根据CLSID从注册表获取Band的名称
CString CIEBandPlugInManager::GetDisplayName(CString strCLSID)
{
TCHAR
sz[MAX_PATH];
HKEY
hKey;
DWORD
dwSize;
strCLSID = "CLSID\\" + strCLSID;
if(RegOpenKey(HKEY_CLASSES_ROOT, strCLSID, &hKey) != ERROR_SUCCESS)
{
return _T("");
}
RegQueryValueEx(hKey, NULL, NULL, NULL, (LPBYTE)sz, &dwSize);
RegCloseKey(hKey);
return sz;
}
//通过Band的CLSID激活Band
bool CIEBandPlugInManager::ActivateBand( CString strCLSID )
{
LPIEBANDINFO pIEBandInfo = GetBandInfo( strCLSID ); //从m_oaBand中找到符合条件的Band的信息
if ( !pIEBandInfo )
{
return false;
}
WCHAR wsz[MAX_PATH];
::MultiByteToWideChar(CP_ACP, 0, strCLSID, -1, wsz, MAX_PATH);
CLSID
clsid;
HRESULT hr2 = CLSIDFromString( wsz, &clsid);
if ( hr2 != NOERROR )
return false;
HRESULT hr = ::CoCreateInstance(clsid, NULL, LSCTX_INPROC_SERVER, IID_IUnknown, (void**)&pIEBandInfo->puk); //创建Band对象的实例
IUnknown* puk = pIEBandInfo->puk;
if (FAILED(hr))
return false;
DoQueryBandInfo( pIEBandInfo ); //查询Band对象实例的信息
switch( pIEBandInfo->eBandType )
{
case btVertical:
break;
//我们不处理Vertical的面板
case btHorizontal:
{
g_pMainFrame->m_wndReBar.AddBar2( pIEBandInfo->hBand, pIEBandInfo->uBandID, pIEBandInfo->uMinHeight, 0, 0); //将Band嵌入主窗口的ReBar中
REBARBANDINFO rbbi;
rbbi.cbSize = sizeof(rbbi);
rbbi.fMask = RBBIM_CHILDSIZE | RBBIM_IDEALSIZE | RBBIM_SIZE;
rbbi.cxMinChild = 0;
rbbi.cyMinChild = pIEBandInfo->uMinHeight;
rbbi.cx = rbbi.cxIdeal = 250;
UINT nCount = g_pMainFrame->m_wndReBar.GetReBarCtrl().GetBandCount();
g_pMainFrame->m_wndReBar.GetReBarCtrl().SetBandInfo(nCount-1, &rbbi);
break;
}
default:
break;
}
pIEBandInfo->eBandState = bsVisible;
return true;
}
//查询Band对象实例的信息
void CIEBandPlugInManager::DoQueryBandInfo(LPIEBANDINFO pIEBandInfo)
{
IObjectWithSite *pOWS;
//查询IObjectWithSite接口
HRESULT hr = pIEBandInfo->puk->QueryInterface(IID_IObjectWithSite, (void**)&pOWS);
if (SUCCEEDED(hr))
{ //设置Site
pOWS->SetSite( (IUnknown *)&m_IESimulator ); //m_IESimulator是CIESimulator的一个实例对象,对Band对象而言,它就像IE
}
IDeskBand *pdb;
hr = pIEBandInfo->puk->QueryInterface(IID_IDeskBand, (void**)&pdb);
if (SUCCEEDED(hr))
{ //查询得到Band对象窗口的句柄,稍候通过该句柄将Band对象的窗口嵌入我们指定的窗口
pdb->GetWindow(&pIEBandInfo->hBand);
}
ShowBand(pIEBandInfo, TRUE);//显示Band
}
bool CIEBandPlugInManager::ShowBand(LPIEBANDINFO pIEBandInfo, bool bShow)
{
IDockingWindow *pdw;
HRESULT hr = pIEBandInfo->puk->QueryInterface(IID_IDockingWindow, (void**)&pdw);
if (SUCCEEDED(hr))
{
pdw->ShowDW(bShow);
}
else
{
return false;
}
return true;
}
下面是我测试的一个截图,Google的搜索、广告窗口拦截均可正常工作。
5、总结
上述的原理看来很简单,但具体实现的时候仍然需要作较多的测试和考虑,Band对象的管理和缓存、接口的AddRef和Release等。时间有限,代码也很乱,不过只要原理交待清楚,相信会对有兴趣的朋友有所帮助。
6、参考资料
MSDN:《Creating Custom Explorer Bars, Tool Bands, and Desk Bands》