From 89f9bdb84f39f448f7ab324bb2cbaca4126295fb Mon Sep 17 00:00:00 2001 From: Eric Covener Date: Tue, 8 Nov 2011 02:11:35 +0000 Subject: [PATCH] add info about new early/late arguments and a note about the directives whose context is limited. git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1199063 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/mod/mod_lua.html.en | 31 +++++++++++++++++++++----- docs/manual/mod/mod_lua.xml | 39 +++++++++++++++++++++++++++------ 2 files changed, 58 insertions(+), 12 deletions(-) diff --git a/docs/manual/mod/mod_lua.html.en b/docs/manual/mod/mod_lua.html.en index eaae1a6b00..e8e5bc60c2 100644 --- a/docs/manual/mod/mod_lua.html.en +++ b/docs/manual/mod/mod_lua.html.en @@ -451,25 +451,29 @@ end

LuaHookAccessChecker Directive

- + +
Description:Provide a hook for the access_checker phase of request processing
Syntax:LuaHookAccessChecker /path/to/lua/script.lua hook_function_name
Syntax:LuaHookAccessChecker /path/to/lua/script.lua hook_function_name [early|late]
Context:server config, virtual host, directory, .htaccess
Override:All
Status:Experimental
Module:mod_lua
Compatibility:The optional third argument is supported in 2.3.15 and later

Add your hook to the access_checker phase. An access checker hook function usually returns OK, DECLINED, or HTTP_FORBIDDEN.

+

Ordering

The optional arguments "early" or "late" + control when this script runs relative to other modules.

top

LuaHookAuthChecker Directive

- + +
Description:Provide a hook for the auth_checker phase of request processing
Syntax:LuaHookAuthChecker /path/to/lua/script.lua hook_function_name
Syntax:LuaHookAuthChecker /path/to/lua/script.lua hook_function_name [early|late]
Context:server config, virtual host, directory, .htaccess
Override:All
Status:Experimental
Module:mod_lua
Compatibility:The optional third argument is supported in 2.3.15 and later

Invoke a lua function in the auth_checker phase of processing a request. This can be used to implement arbitrary authentication @@ -507,18 +511,24 @@ function authcheck_hook(r) return apache2.OK end

+

Ordering

The optional arguments "early" or "late" + control when this script runs relative to other modules.

top

LuaHookCheckUserID Directive

- + +
Description:Provide a hook for the check_user_id phase of request processing
Syntax:LuaHookCheckUserID /path/to/lua/script.lua hook_function_name
Syntax:LuaHookCheckUserID /path/to/lua/script.lua hook_function_name [early|late]
Context:server config, virtual host, directory, .htaccess
Override:All
Status:Experimental
Module:mod_lua
Compatibility:The optional third argument is supported in 2.3.15 and later

...

+

Ordering

The optional arguments "early" or "late" + control when this script runs relative to other modules.

+
top

LuaHookFixups Directive

@@ -562,11 +572,12 @@ processing

LuaHookTranslateName Directive

- - + + +
Description:Provide a hook for the translate name phase of request processing
Syntax:LuaHookTranslateName /path/to/lua/script.lua hook_function_name
Context:server config, virtual host, directory, .htaccess
Syntax:LuaHookTranslateName /path/to/lua/script.lua hook_function_name [early|late]
Context:server config, virtual host, directory
Override:All
Status:Experimental
Module:mod_lua
Compatibility:The optional third argument is supported in 2.3.15 and later

Add a hook (at APR_HOOK_MIDDLE) to the translate name phase of request processing. The hook function receives a single @@ -599,6 +610,13 @@ function silly_mapper(r) end

+

Context

This directive is not valid in <Directory>, <Files>, or htaccess + context.

+ +

Ordering

The optional arguments "early" or "late" + control when this script runs relative to other modules.

+ +
top

LuaHookTypeChecker Directive

@@ -688,6 +706,9 @@ end Status:Experimental Module:mod_lua

...

+

Context

This directive is not valid in <Directory>, <Files>, or htaccess + context.

+
top

LuaRoot Directive

diff --git a/docs/manual/mod/mod_lua.xml b/docs/manual/mod/mod_lua.xml index d8cc4c42ae..01ebfe75b3 100644 --- a/docs/manual/mod/mod_lua.xml +++ b/docs/manual/mod/mod_lua.xml @@ -543,9 +543,10 @@ end LuaHookTranslateName Provide a hook for the translate name phase of request processing -LuaHookTranslateName /path/to/lua/script.lua hook_function_name +LuaHookTranslateName /path/to/lua/script.lua hook_function_name [early|late] +The optional third argument is supported in 2.3.15 and later server configvirtual host -directory.htaccess +directory All @@ -580,6 +581,15 @@ function silly_mapper(r) end end + + Context

This directive is not valid in Directory, Files, or htaccess + context.

 + + Ordering

The optional arguments "early" or "late" + control when this script runs relative to other modules.

 + @@ -613,12 +623,16 @@ processing LuaHookCheckUserID Provide a hook for the check_user_id phase of request processing -LuaHookCheckUserID /path/to/lua/script.lua hook_function_name +LuaHookCheckUserID /path/to/lua/script.lua hook_function_name [early|late] +The optional third argument is supported in 2.3.15 and later server configvirtual host directory.htaccess All -

...

 +

...

+ Ordering

The optional arguments "early" or "late" + control when this script runs relative to other modules.

 + @@ -635,7 +649,8 @@ processing LuaHookAuthChecker Provide a hook for the auth_checker phase of request processing -LuaHookAuthChecker /path/to/lua/script.lua hook_function_name +LuaHookAuthChecker /path/to/lua/script.lua hook_function_name [early|late] +The optional third argument is supported in 2.3.15 and later server configvirtual host directory.htaccess @@ -677,13 +692,16 @@ function authcheck_hook(r) return apache2.OK end + Ordering

The optional arguments "early" or "late" + control when this script runs relative to other modules.

 LuaHookAccessChecker Provide a hook for the access_checker phase of request processing -LuaHookAccessChecker /path/to/lua/script.lua hook_function_name +LuaHookAccessChecker /path/to/lua/script.lua hook_function_name [early|late] +The optional third argument is supported in 2.3.15 and later server configvirtual host directory.htaccess @@ -691,6 +709,8 @@ end

Add your hook to the access_checker phase. An access checker hook function usually returns OK, DECLINED, or HTTP_FORBIDDEN.

+ Ordering

The optional arguments "early" or "late" + control when this script runs relative to other modules.

 @@ -713,7 +733,12 @@ hook function usually returns OK, DECLINED, or HTTP_FORBIDDEN.

directory.htaccess All -

...

 +

...

+ Context

This directive is not valid in Directory, Files, or htaccess + context.

 + -- 2.40.0