任何一个模块可以通过额外的或者可选的钩子来扩展API,通过在这些钩子处插入额外的逻辑,执行这些逻辑自定的功能,其他模块也可以使用这些功能以便执行这些自定义的逻辑。
钩子调用的代码实现下列的逻辑:
- 在这个钩子处按照顺序运行所有的被注册函数
- 在这个钩子处运行所有的被注册函数直到返回了一个不是DECLINED的值
- 运行所有的函数直到或者除非返回一个错误(非OK或DECLINED)
declare声明
ap_hook_handler(helloworld_handler, NULL, NULL, APR_HOOK_MIDDLE);
ap_hook_type_checker(choices_select, NULL, NULL, APR_HOOK_FIRST);```
**the first argument**:the function we are looking in to Apache.
**the other three arguments**:are concerned with the order of execution when multiple modules have inserted functions on the same hook.
**the second and third argument**:***predecessors*** and ***successors***是对于两个紧密相关的模块需要特定的顺序执行
**APR_HOOK_FIRST**:used for modules may need to run a function before"all other"functions on the same hook have run
**APR_HOOK_MIDDLE**:doesn't matter
**APR_HOOK_LAST**:after
###implement实行
通过在apr_hooks.h、apr_optional_hooks.h和ap_config.h这三个头文件中定义宏的方式来实现钩子。上面三个声明分别和以下三个内容相对应:
- AP_IMPLEMENT_EXTERNAL_HOOK_VOID
- AP_IMPLEMENT_EXTERNAL_HOOK_RUN_FIRST
- AP_IMPLEMENT_EXERTNAL_HOOK_RUN_ALL
当一个模块实现了一个钩子是,它导出一个钩子函数,它们在请求处理流程中按照顺序出现。
###引入hook的原因
对HTTP的请求,我们可以进一步划分为客户身份验证、客户权限认证、请求校验、URL重定向等阶段,每一个阶段调用相应的函数进行处理。
Apache中对请求的处理过程实质上就是依次调用一系列挂钩的过程,不过由于HTTP请求类型的不同,它们所对应的挂钩数目和类型也不尽相同。
挂钩是用来表示在处理HTTP请求中一组类似的操作,与之对应,挂钩函数就是操作函数。
一个挂钩同时是和一组挂钩函数联系在一起的。因此请求处理过程中,调用挂钩的时候实际上就是调用挂钩函数组。调用过程可以用下图示意。Apache对指定挂钩的挂钩函数调用有两种,一种就是将挂钩函数组中的每个函数都调用一次;另一种就是从前往后调用,一旦找到合适的就停止继续调用
##编写自己的挂钩
假如定义一个能够在Apache处理请求时调用的函数accelerator,该函数只允许特定IP连接,其函数原型为:
int accelerator(request_rec *r,int n);```
(1) 挂钩声明
使用AP_DECLEAR_HOOK宏声明一个名为accelerator的挂钩:
AP_DECLARE_HOOK(int,accelerator,(request_rec *r,int n))```
#####(2) 挂钩数组声明
由于accelerator是新声明的挂钩,必须同时声明新的挂钩数组来保存各个模块对挂钩的注册使用:
APR_HOOK_STRUCT(
APR_HOOK_LINK(accelerator)
)```
(3)声明函数调用类型
在真正被ap_run_name调用之前,声明挂钩的调用类型:VOID\FIRST\ALL:
AP_IMPLEMENT_HOOK_RUN_VOID(accelerator,(request_rec *r,int n),(r,n))```
#####(4)注册挂钩函数
至第三步为止,对挂钩的声明已经基本结束,也意味着下一步的工作实际上应该落实到挂钩使用者身上了。比如如果模块som_module中想使用挂钩some_hook,则其必须在挂钩注册函数中注册该挂钩,挂钩注册函数为ap_hook_some_hook,代码示例如下:
static void register_hooks()
{
……
ap_hook_some_hook(some_hook_function,NULL,NULL,HOOK_MIDDLE);
}
AP_DECLARE_DATA module core_module = {
……
register_hooks /* register hooks */
};```
(5) 编写挂钩函数
最后剩下的内容就是编写具体的挂钩调用函数。比如在some_module模块中,我们希望挂钩函数只是打印出“Hello World”语句,而且从(4)中看出挂钩函数名称为some_hook_function,因此挂钩函数声明为如下:
static void some_hook_function(request_rec* r,int n)
{
ap_rputs(“Hello World/n”);
return;
}```
需要注意的是,这边的挂钩函数必须符合AP_IMPLEMENT_HOOK_RUN_XXX中声明的格式。