<< Back to man.ChinaUnix.net

<-
Apache > HTTP Server > 文档 > 版本2.2 > 模块
   致谢 | 译者声明 | 本篇译者:金步国 | 本篇译稿完成时间:2006年1月24日 | 获取最新版本

Apache模块 mod_cgi

说明在非线程型MPM(prefork)上提供对CGI脚本执行的支持
状态基本(B)
模块名cgi_module
源文件mod_cgi.c

概述

任何具有MIME类型application/x-httpd-cgi或者被cgi-script处理器处理的文件都将被作为CGI脚本对待并由服务器运行,它的输出将被返回给客户端。可以通过两种途径使文件成为CGI脚本,一种是文件具有已由AddType指令定义的扩展名,另一种是文件位于ScriptAlias目录中。

当服务器调用一个CGI脚本时会往运行环境中添加一个叫做DOCUMENT_ROOT的变量。这个变量将包含DocumentRoot指令的值。

要得到对Apache中使用CGI脚本的介绍,参看使用CGI产生动态内容

在UNIX下使用多线程型的MPM时,应该使用模块mod_cgid代替本模块。在用户层面,这两个模块本质上是相同的。

top

CGI环境变量

Apache将按照CGI规范设置环境变量,有以下几个:

PATH_INFO
如果显式设置了AcceptPathInfo指令为 off ,这个变量将不可用。如果没有明确设置AcceptPathInfo ,默认的行为是mod_cgi将会接受路径信息(URI里脚本文件名之后的/more/path/info),即使服务器核心对请求的附加路径信息返回"404 NOT FOUND"错误。省略AcceptPathInfo指令与将它设置为 Onmod_cgi请求具有相同的效果。
REMOTE_HOST
这个变量只有在HostnameLookups指令被设置为"on"(默认是"off")并且对访问主机的DNS反查确实找到了主机名时才被设置。
REMOTE_IDENT
这个变量只有在IdentityCheck被设置为 on 并且访问主机支持识别协议时才被设置。注意这个变量不能信赖,因为它很容易被假冒。而且如果客户端与服务器之间存在代理的话,这个变量通常完全没有用处。
REMOTE_USER
这个变量只有当CGI脚本需要身份验证时才被设置。
top

CGI脚本的调试

调试CGI脚本一直以来都很困难,主要是因为在脚本不能正确运行时不可能研究它的输出(stdout和stderr)。这些指令为发生错误时提供了更详细的错误日志。

CGI日志文件格式

配置好以后,CGI错误日志会记录任何没有正确运行的CGI。每个运行失败的CGI脚本都有几行信息被记录。头两行总是这样的格式:

%% [time] request-line
%% HTTP-status CGI-script-filename

如果错误是CGI脚本无法执行,日志文件会包含以下额外的两行:

%%error
error-message

或者,如果错误是脚本执行结果返回了不正确的头信息(经常是由于脚本内部的bug),会记录以下两行:

%request
All HTTP request headers received
POST or PUT entity (if any)
%response
All headers output by the CGI script
%stdout
CGI standard output
%stderr
CGI standard error

如果脚本没有在stdout和stderr上输出可能会没有%stdout和%stderr部分。

top

ScriptLog 指令

说明CGI脚本错误日志文件的位置
语法ScriptLog file-path
作用域server config, virtual host
状态基本(B)
模块mod_cgi, mod_cgid

ScriptLog指令设置了CGI脚本错误日志文件的位置。如果没有设置ScriptLog ,就不会创建错误日志。如果设置了,所有CGI错误都会被记入作为指令参数的文件中。如果是一个相对路径则以ServerRoot为参照。

示例

ScriptLog logs/cgi_log

此日志会以运行子进程的用户身份打开,比如由主服务器配置部分的User指令指定的用户。这意味着,或者该用户对脚本日志所在目录具有写权限,或者日志文件由此用户手工创建并设置为可写。如果你把脚本日志放在你的主日志目录中,不要为了让运行子进程的用户可以写日志而改变目录的权限。

注意,脚本日志是为了给创建CGI脚本提供一个调试特性,而不是要在运行服务时持续保持活动状态。它没有为速度或是效率作优化,而且与专门设计的那些特性不同,在某种程度上它会存在安全问题。

top

ScriptLogBuffer 指令

说明记入日志文件的PUT或POST请求头的最大数量
语法ScriptLogBuffer bytes
默认值ScriptLogBuffer 1024
作用域server config, virtual host
状态基本(B)
模块mod_cgi, mod_cgid

限制记入日志文件的PUT或者POST内容的大小,防止如果接收到很大内容时日志文件的尺寸增加得太快太大。默认地,最多纪录1024字节,但这个数字可以用此指令改变。

top

ScriptLogLength 指令

说明日志文件的大小限制(字节)
语法ScriptLogLength bytes
默认值ScriptLogLength 10385760
作用域server config, virtual host
状态基本(B)
模块mod_cgi, mod_cgid

ScriptLogLength指令可以用于限制CGI脚本文件的大小。由于日志文件对每个CGI错误纪录(所有请求头、所有脚本输出)许多信息,它有可能会变成一个很大的文件。为了防止无限制的增长引起的问题,这个指令可以用来给CGI日志文件的大小设置一个上限。如果文件大小达到了这个限制,就不会再有信息被写入日志。