Internet Explorer 编程简述（八）实现浏览历史菜单

关键字：itravellogstg, ienumtravellogentry, itravellogentry

1、概述

internet explorer的浏览历史菜单在4.0版本开始出现，但直到5.5之前，微软都未公布用于访问浏览历史的com接口，如今已是ie6.0大行其道的年代，用于访问浏览历史的接口也早已公布多时，本文的目的则是试图抛砖引玉，简单介绍用于访问浏览历史的travel log接口，并用一个小小的类cietravellog来实现对travel log的封装。

2、iomhistory接口

在早些时候的msdn中，我们能够查阅到关于浏览历史的接口仅有iomhistory，而该接口实际上对应的是浏览器中可以通过脚本访问的“history”对象。对于“history”对象，msdn中是这样说的：

for security reasons, the history object does not expose the actual urls in the browser history. it does allow navigation through the browser history by exposing the back, forward, and go methods. a particular document in the browser history can be identified as an index relative to the current page. for example, specifying -1 as a parameter for the go method is the equivalent of clicking the back button.

this object is available in script as of microsoft internet explorer 3.0.

即为了安全的原因，iomhistory接口仅提供了有限的几个方法来完成在浏览器中前进、后退等操作，并没有提供访问历史列表url的能力。这也难怪，该接口在ie 3.0时代已经存在，而当时ie并不成熟，可编程能力也不甚强大。一直到ie 4.0通过与windows 98捆绑销售一统天下之后，相关的文档才逐渐丰富，多窗口浏览器等基于internet explorer/webbrowser control的应用软件也才铺天盖地开来。但在ie 5.5接口公布之前，要完全模拟ie的travel log行为，并不是一件容易的事。最容易想到的方法就是在beforenavigate、documentcomplete等事件发生之时记录/修改url并加以保存（我在早些时候也这样做过），但是效果不甚理想，尤其是浏览包含frame的网页时，处理更是麻烦。当然，要完全模拟亦非难事，只不过开发人员都知道微软公布接口是早晚的事，所以也没有人花大力气在模拟ie的travel log行为上。

3、travel log简介

internet explorer 5.5推出以后，travel log接口也就开始出现在msdn中，它是专门为ole嵌入webbrowser control的应用程序设计的，其目的是“提高和加强用户的访问日志体验”（improve and enhance the user's travel log experience）。事实上，稍后我会提到，travel log接口正日益成为应用程序中的重要接口之一。

微软公布的travel log共包含三个接口：itravellogstg, ienumtravellogentry和itravellogentry。

itravellogstg——该接口提供了用于在travel log中添加、删除、枚举日志（浏览历史）的方法，本文需要用到的几个方法列举如下：
方法名     用途

enumentries 为访问日志项创建枚举器（ienumtravellogentry接口指针）

getrelativeentry 返回一个日志项

travelto 访问一个日志项

ienumtravellogentry——该接口提供用于枚举日志项所必需的方法，本文只用到一个方法：
方法名     用途

next   枚举下一个日志项（返回itravellogentry接口指针）

itravellogentry——该接口只有两个方法，分别用于返回日志项的title和url：
方法名     用途

gettitle 返回日志项的title

geturl 返回日志项的url

接口准备好了，我们也就很容易得知它们之间的关系：

要得到相对于当前页面的日志项列表，首先应通过itravellogstg接口创建一个枚举器（ienumtravellogentry接口）。
通过ienumtravellogentry枚举器的next方法枚举出一个个的日志项（itravellogentry接口）。
由itravellogentry接口获取日志项所代表的网页的title和url并加以处理。
访问相对于当前页面的某个日志项时，首先由itravellogstg的getrelativeentry方法根据与当前页的距离得到itravellogentry接口，再将后者传入itravellogstg的travelto方法以达到访问日志项的目的（如前进和后退）。

也许不是太恰当，我对uml也不熟悉，借用一个伪uml序列图表示其关系如下：

4、封装travel log

接下来，我们就用一个简单的类来完成对travel log的封装。如下所示，tlogstg.h包含了travel log的相关接口声明，该头文件可以在platform sdk中找到。

#include "tlogstg.h"
class cietravellog
{
private:
itravellogstg *m_ptravellogstg;
ienumtravellogentry *m_penumlogentry;
itravellogentry *m_ptravallogentry;
iwebbrowser2* m_pwebbrowser;
public:
cietravellog(void);
~cietravellog(void);
void setwebbrowser(iwebbrowser2* pwebbrowser);
void buildhistorymenu(cmenu * pmenu, unsigned char ncount, bool bforward);
void travelto(int nposition);
};
cietravellog::cietravellog(void)
: m_ptravellogstg(null), m_penumlogentry(null), m_ptravallogentry(null), m_pwebbrowser(null)
{
}
cietravellog::~cietravellog(void)
{
if ( m_ptravellogstg != null )
{
m_ptravellogstg->release();
}
if ( m_penumlogentry != null )
{
m_penumlogentry->release();
}
if ( m_ptravallogentry != null )
{
m_ptravallogentry->release();
}
if ( m_pwebbrowser != null )
{
m_pwebbrowser->release();
}
}
//将浏览器的iwebbrowser2接口指针赋予cietravellog的实例
void cietravellog::setwebbrowser(iwebbrowser2* pwebbrowser)
{
if ( (m_pwebbrowser == pwebbrowser) || (m_pwebbrowser == null) )
{
return;
}
if ( m_pwebbrowser != null )
{
m_pwebbrowser->release();
}
m_pwebbrowser = pwebbrowser;
iserviceprovider *psp;
hresult hr = m_pwebbrowser->queryinterface(iid_iserviceprovider, (lpvoid*)&psp);
m_pwebbrowser->release();
if (succeeded(hr))
{
hr = psp->queryservice(sid_stravellogcursor, iid_itravellogstg, (lpvoid*)&m_ptravellogstg);
psp->release();
}
}
//创建浏览历史菜单，bforward指明是前进还是后退菜单
void cietravellog::buildhistorymenu(cmenu * pmenu, unsigned char ncount, bool bforward)
{
if ( m_ptravellogstg == null )
{
return;
}
tlenumf eflag = bforward ? tlef_relative_fore : tlef_relative_back;
if ( failed(m_ptravellogstg->enumentries( eflag, &m_penumlogentry ) ) )
{
return;
}
ulong ufetched;
int i=0;
if ( m_penumlogentry !=null )
{
while ( succeeded( m_penumlogentry->next( 1, &m_ptravallogentry, &ufetched ) ) &&
m_ptravallogentry && i<10 )//我们最多只需要10条历史菜单，可根据实际情况修改
{
lpolestr psztitle;
m_ptravallogentry->gettitle( &psztitle );
cstring strtitle = psztitle;
if ( bforward )
{
//id_iehistory_middle是预定义的某个菜单项id，从该id开始前后可以创建10个菜单项，参见下一节
pmenu->insertmenu( 0, mf_string, id_iehistory_middle + ++i, strtitle );
}
else
{
pmenu->insertmenu( 0, mf_string, id_iehistory_middle - ++i, strtitle );
}
cotaskmemfree( psztitle );
m_ptravallogentry->release();
}
}
}
//根据与当前页面的相对距离来访问历史网页
void cietravellog::travelto(int nposition)
{
if ( m_ptravellogstg == null )
{
return;
}
if succeeded(m_ptravellogstg->getrelativeentry( nposition, &m_ptravallogentry ))
{
m_ptravellogstg->travelto( m_ptravallogentry );
}
}

5、使用cietravellog

假设是在我们自己编写的多窗口浏览器中使用travel log。为简单起见，我们声明一个cietravellog的全局对象g_ietravellog，以便在任何地方调用。然后在适当的地方，如cmainframe的tbn_dropdown消息（工具条菜单下拉消息）处理函数ondropdown中，添加下面的代码，用以创建浏览历史菜单：

//getactivewebbrowserptr返回活动的浏览器iwebbrowser2接口指针

ietravellog.setwebbrowser( getactivewebbrowserptr );

//bforward为true则创建“前进”菜单，否则创建“后退”菜单

ietravellog.buildhistorymenu( &menu, 10, bforward);

以下定义为菜单项id的范围，前后共可以容纳10个菜单项，可根据实际情况修改。

#define id_iehistory_first  60200

#define id_iehistory_middle 60210

#define id_iehistory_last   60220

添加命令处理函数ontravelhistoryurl用以响应从id_iehistory_first到id_iehistory_last的菜单命令。

on_command_range(id_iehistory_first, id_iehistory_last, ontravelhistoryurl)
void cmainframe::ontravelhistoryurl(uint nid /* command id */)
{
//nid - id_iehistory_middle即为要访问的浏览历史到当前页面的距离
g_ietravellog.travelto( nid - id_iehistory_middle );
}

6、再谈travel log

前面我提到“travel log接口正日益成为应用程序中的重要接口之一”，此处加以说明。从微软平台的开发模式及导向来看，基于internet explorer/webbrowser control的应用势必会成为主流。在下一代的操作系统longhorn中，应用程序界面的描述将完全由xml的一个特化——xaml来完成，而xaml的解析将由浏览器完成。微软说未来应用程序的部署将会十分容易，本地应用和基于浏览器的应用之间的差异将会被逐渐淡化，而实现这一目标的一个重要表现就是，在将来的操作系统平台上，应用程序实际上时刻都将运行在internet explorer中，internet explorer在某种程度上来说变成了一个容器。

于是，扎根于internet explorer的travel log自然而然地就被整合到了我们的应用程序中。君不见，我们每天在资源管理器和浏览器上完成的工作，不就是在travel log中来来回回地跑吗？如果所有的应用程序都嵌入到internet explorer中运行，那么我们在应用程序中所作的操作便自然得到了记录，“前进”和“后退”也就很easy了。

很多软件都已经或多或少地开始采用基于internet explorer的模式，如microsoft money、microsoft encarta、visual studio.net的安装程序等等，都是很好的范例。所以，就目前来说，将我们的应用程序按这种模式编写（可参考《利用浏览器实现程序界面与实现的分离》），不是可以早一点获得“访问日志的体验”吗？何乐而不为。