ISAPI简介
一、ISA(Internet Server Application)
ISA(Internet Server Application)也可称为ISAPI DLL,它是可以被HTTP 服务器加载和调用的DLL。使用方法和CGI也类似,由客户端在URL中指定其名称而激活。
例如:下面的请求将调用服务器的虚拟可执行目录Scripts下的function.dll(ISAPI DLL必须放在服务器的虚拟可执行目录下)
http://localhost/Scripts/function.dll?
Internet服务器应用(ISA)也常被称为Internet 服务器扩展。
二、Internet server的API(ISAPI)
ISAPI(Internet Server Application Programming Interface),即Internet服务器应用程序接口,说明白了一套面向Internet服务的API接口,是由微软和Process软件公司联合提出的Web服务器上的API标准。
ISAPI与Web服务器结合紧密,功能强大,能够获得大量的信息,因此利用ISAPI可以开发出灵活高效的Web服务器增强程序。
由于开发ISAPI应用要用到微软的一套API,所以能用来开发ISAPI应用的语言不如CGI那么多。主要有VisualC++4.1以上版本,VisualBasic5.0、BorlandC++5.0也可以。
ISAPI程序和CGI程序完成类似的功能,但是实现方法不同。ISAPI与CGI最大的区别在于:不同于CGI,在ISAPI下建立的应用程序是以动态连接库的形式存在;而CGI的应用程序一般都是可执行程序。
ISAPI程序的执行:
ISAPI 应用的工作流程与CGI有一些不同。ISAPI应用的DLL不仅可以象CGI程序一样被用户请求激活,还可以被系统预先激活来监视用户输入;对于被用户激活的DLL,在处理完一个用户请求后不会马上消失,而是继续驻留在内存中等待处理别的用户输入,直到过了一段时间后一直没有用户输入。
ISAPI性能评价:
一个ISAPI的DLL,可以在被用户请求激活后长驻内存,等待用户的另一个请求,还可以在一个DLL里设置多个用户请求处理函数,此外,ISAPI的DLL应用程序和WWW服务器处于同一个进程中,效率要显著高于CGI。不过ISAPI的平台兼容性较差,目前只能用于微软自己的Windows95和NT操作系统上,服务器平台也仅限于 IIS(InternetInformationServer)和MSpersonalwebserver以及NTworkstation上的 peerwebserver。
三、ISAPI 筛选器
ISAPI筛选器是在启用 ISAPI 的 HTTP 服务器上运行的 DLL,用以筛选与服务器之间来回传送的数据。
该筛选器注册事件的通知,例如登录或 URL 映射。当发生选定事件时,筛选器被调用,并且您可以监视及更改数据(在数据从服务器传输到客户端或相反的过程中)。
可以使用 ISAPI 筛选器提供增强的 HTTP 请求记录(例如,跟踪登录到服务器的用户)、自定义加密、自定义压缩或其他身份验证方法。
四、ISAPI 服务器扩展和筛选器之间的区别
服务器扩展:在 URL 中引用时运行。被显式调用,例如用http://myserver/myprog.dll?。被用户第一次调用时根据请求加载。
筛选器:为服务器处理的每个 URL 调用。如果发生已注册事件,自动为任何发送到服务器的 URL 运行。服务因其注册表项而启动时加载。
五、讨论ISAPI在IIS和VC++ 6.0中的实现
ISA和http服务器之间的接口主要有两个:GetExtentionVersion( )和HttpExtentionProc( )。
任何ISA都必须在其PE文件头的引出表中定义这两个引出函数,以供Web服务器在适当的时候调用。
1、当服务器刚加载ISA时,它会调用ISA提供的GetExtentionVersion( )来获得该ISA所需要的服务器版本,并与自己的版本相比较,以保证版本兼容。函数原型如下:
BOOL WINAPI GetExtentionVersion(HSE_VERSION_INFO *version);
typedef struct _HSE_VERSION_INFO
{
DWORD dwExtensionVersion; //版本号
CHAR lpszExtensionDesc[HSE_MAX_EXT_DLL_NAME_LEN]; //关于ISA的描述字符串
} HSE_VERSION_INFO, *LPHSE_VERSION_INFO;
2、ISA的真正入口是HttpExtentionProc( ),它相当于普通C程序的main( )函数,在这个函数中根据不同的客户请求作不同的处理。
服务器和HttpExtentionProc( )之间是通过扩展控制块(Extention Control Block)来进行通信的,即ECB中存放入口参数和出口参数,包括服务器提供的几个回调函数的入口地址。函数原型如下:
DWORD HttpExtensionProc(EXTENSION_CONTROL_BLOCK *pECB );
ECB的结构定义如下(IN表示入口参数,OUT表示出口参数):
typedef struct _EXTENSION_CONTROL_BLOCK
{
DWORD cbSize; //IN,本结构的大小,只读
DWORD dwVersion //IN,版本号,高16位为主版本号,低16位为次版本号
HCONN ConnID; //IN,连接句柄,由服务器分配,ISA只能读取该值
DWORD dwHttpStatusCode; //OUT,当前完成的事务状态
CHAR lpszLogData[HSE_LOG_BUFFER_LEN]; //OUT,需要写入到日志文件中的内容
LPSTR lpszMethod; //IN,等价于CGI的环境变量REQUEST_METHOD
LPSTR lpszQueryString; //IN,等价于环境变量QUERY_STRING
LPSTR lpszPathInfo; //IN,等价于环境变量PATH_INFO
LPSTR lpszPathTranslated; //IN,等价于环境变量PATH_TRANSLATED
DWORD cbTotalBytes; //IN,等价于环境变量CONTENT_LENGTH
DWORD cbAvailable; //IN,缓冲区中的可用字节数
LPBYTE lpbData; //IN,缓冲区指针,指向客户端发来的数据
LPSTR lpszContentType; //IN,等价于环境变量CONTENT_TYPE
//回调函数,用于返回服务器的连接信息或特定的服务器详细情况
BOOL ( WINAPI * GetServerVariable )
( HCONN hConn,
LPSTR lpszVariableName,
LPVOID lpvBuffer,
LPDWORD lpdwSize );
BOOL ( WINAPI * WriteClient ) //回调函数,从客户端的HTTP请求中读取数据
( HCONN ConnID,
LPVOID Buffer,
LPDWORD lpdwBytes,
DWORD dwReserved );
BOOL ( WINAPI * ReadClient ) //回调函数,向客户端发送数据
( HCONN ConnID,
LPVOID lpvBuffer,
LPDWORD lpdwSize );
BOOL ( WINAPI * ServerSupportFunction ) //回调函数,访问服务器的一般和特定功能
( HCONN hConn,
DWORD dwHSERRequest,
LPVOID lpvBuffer,
LPDWORD lpdwSize,
LPDWORD lpdwDataType );
} EXTENSION_CONTROL_BLOCK, *LPEXTENSION_CONTROL_BLOCK;
在上述ECB中,服务器不但提供了当前HTTP连接的句柄和一些变量,而且提供了4个回调函数给ISA调用,从而使ISA可以获得更详尽的信息。
六、ISAPI Filter
ISAPI Filter位于服务器和客户端之间,能够对服务器和客户端之间的通信进行预处理和后处理,比如对通信进行加密/解密、提供对客户进行身份验证的新方法、提供自定义的日志记录等,在CGI中没有与ISAPI Filter直接相对应的部分。
ISAPI Filter与服务器之间的接口有两个:GetFilterVersion( )和HttpFilterProc( )。任何
ISAPI Filter都必须引出这两个函数以供服务器调用。
1、在注册表的如下键值中存放着所有ISAPI Filter的文件名,IIS服务器启动时从该键值中获得
Filter的文件名并加载它们。
HKEY_LOCAL_MACHINE/SYSTEM/CurrentControlSet/Services/W3SVC/Parameters/FilterDLL
2、然后服务器调用每个Filter提供的GetFilterVersion( )函数,获得版本号以及该Filter希望处理的事件,即ISAPI Filter通过引出GetFilterVersion( )函数来告知服务器自己希望处理什么类型的事件,因为ISAPI Filter是通过事件来激活的,当满足条件的事件到达时,服务器就会调用Filter引出的主函数HttpFilterProc( )对该事件进行处理。GetFilterVersion( )的原型如下:
BOOL WINAPI GetFilterVersion(
DWORD dwServerFilterVersion; //IN,服务器使用的版本规范
DWORD dwFilterVersion; //OUT,过滤器使用的版本规范
CHARlpszFilterDesc[SF_MAX_FILTER_DESC_LEN+1]; //OUT,对该过滤器的描述字符串
DWORD dwFlags //OUT,事件和优先级标志
);
3、HttpFilterProc( )是ISAPI Filter主要的入口函数,它根据当前的事件的不同作出不同的处理。服务器通过如下的参数块和Filter进行交互,这个参数块的作用和ISA中的ECB类似。
typedef struct _HTTP_FILTER_CONTEXT
{
DWORD cbSize; //IN,本参数块的大小
DWORD Revision; //IN
PVOID ServerContext; //IN,由server使用本参数
DWORD ulReserved; //IN,由server使用本参数
BOOL fIsSecurePort; //IN,事件是否发生在安全端口上
PVOID pFilterContext; //IN/OUT,与本次请求相关的上下文
//回调函数,取得关于服务器和本次连接的信息
BOOL (WINAPI * GetServerVariable) (
struct _HTTP_FILTER_CONTEXT * pfc,
LPSTR lpszVariableName,
LPVOID lpvBuffer,
LPDWORD lpdwSize
);
BOOL (WINAPI * AddResponseHeaders) ( //回调函数,给HTTP响应添加一个标头
struct _HTTP_FILTER_CONTEXT * pfc,
LPSTR lpszHeaders,
DWORD dwReserved
);
BOOL (WINAPI * WriteClient) ( //回调函数,将原始数据发送给客户端
struct _HTTP_FILTER_CONTEXT * pfc,
LPVOID Buffer,
LPDWORD lpdwBytes,
DWORD dwReserved
);
VOID * (WINAPI * AllocMem) ( //回调函数,分配内存。
struct _HTTP_FILTER_CONTEXT * pfc,
DWORD cbSize,
DWORD dwReserved
);
BOOL (WINAPI * ServerSupportFunction) ( //回调函数,访问服务器的一般和特定功能
struct _HTTP_FILTER_CONTEXT * pfc,
enum SF_REQ_TYPE sfReq,
PVOID pData,
DWORD ul1,
DWORD ul2
);
} HTTP_FILTER_CONTEXT,*PHTTP_FILTER_CONTEXT;
七、VC++ 6.0中定义了5个相关的类,简化ISAPI的编程工作
CHttpServer
CHttpServerContext
CHttpFilter
CHttpFilterContext
CHtmlStream
这5个类都没有父类。其中:
CHttpServer和CHttpServerContext主要用来编写ISA;
CHttpFilter和CHttpFilterContext则用来编写ISAPI Filter;
而CHtmlStream则用来操作内存中的HTML文件,为其它的4个类提供服务。
CHttpServer在每个ISA中只能有一个实例,一个CHttpServer可以对应多个CHttpServerContext实例,每个CHttpServerContext处理一个客户请求,这样可以处理并发的HTTP请求;
CttpFilter和CHttpFilterContext之间的关系与此类似,在每个ISAPIFilter中只能有一个CHttpFilter实例,但是可以有多个CHttpFilterContext来处理并发的事件。
CHttpServer和CHttpFilter是独立的类,它们可以共存于一个DLL中,也可以分别在不同的DLL中。
一个ISA可以提供多个命令,每个命令对应于CHttpServer(或其子类)的一个成员函数,客户端可以在URL中指定命令名及其参数。在VC++ 6.0中是通过parse map来实现这种对应的。
Parse map类似MFC中的Windows消息分发机制,
通过使用VC提供的DECLARE_PARSE_MAP、BEGIN_PARSE_MAP、ON_PARSE_COMMAND、ON_PARSE_COMMAND_PARAMS、DEFAULT_PARSE_COMMAND、END_PARSE_MAP等宏,可以实现对不同的命令的处理。
每个CHttpServer中只能建立一个parse map,当客户端给ISA发来命令的时候,parse map可以分析HTTP请求中的命令名及其参数,将该命令与相应的成员函数关联起来,即由该成员函数处理该命令。以MSDN中的例子程序pinball为例,该例中有下面这样一个表单:
<form method=get action="pinball.dll?">
<input type="hidden" name="MfcISAPICommand"VALUE="GetImage">
<input type="radio" name="Favorite"value="1" checked> Attack from Mars<br>
<input type="radio" name="Favorite"value="2"> Twilight Zone<br>
<input type="radio" name="Favorite"value="3"> The Addams Family<br>
<input type="radio" name="Favorite"value="4"> Cirqus Voltaire<br>
<input type="radio" name="Favorite"value="0"> I don't see it here<br>
<br>
<input type="submit" value="Show Me!">
</form>
当客户端选中了上面的表单中的“Attack from Mars”这一项并点击了submit按钮后,服务器端最终将得到如下的URL串:
http://www.abc.com/pinball.dll?MfcISAPICommand=GetImage&Favorite=1
在该URL串中,命令名是GetImage,参数Favorite的值是1,因此pinball.dll中的如下成员函数将被调用以处理该请求,其中参数dwChoice对应URL中的参数Favorite:
voidCPinballExtension::GetImage(CHttpServerContext* pCtxt, long dwChoice);
而parse map需要按照下面的形式定义:
//CPinballExtension从CHttpServer派生而来
BEGIN_PARSE_MAP(CPinballExtension,CHttpServer)
//GetImage是CPinballExtension的成员函数,且有一个long型的参数即dwChoice
ON_PARSE_COMMAND(GetImage,CPinballExtension, ITS_I4)
//该参数在URL中的名字为Favorite
ON_PARSE_COMMAND_PARAMS("Favorite")
END_PARSE_MAP(CPinballExtension)
而对于ISAPI Filter,在VC中可以通过重载CHttpFilter(或其子类)的不同的成员函数来实现对不同事件的处理。可重载的函数如下,每一个成员函数均对应一个或多个事件:
OnPreprocHeaders
OnAuthentication
OnUrlMap
OnSendRawData
OnReadRawData
OnLog
OnEndOfNetSession
事件和优先级标志dwFlasg的取值在MSDN中有详细解释,其中包括该Filter被调用的优先级,一般应使用默认的低优先级,否则可能会对系统的性能造成很大影响。
MSDN提供了4个关于ISAPI的编程实例:counter、MFCUCASE、pinball、wwwquote,有兴趣的可看看,本文主要不是介绍编程,所以不再赘述。