模块 ngx_http_perl_module

该模块用于实现 location 和变量处理程序，并将 Perl 调用插入 SSI。ngx_http_perl_module

默认情况下，此模块不是构建的，应使用 configuration 参数启用它。--with-http_perl_module

此模块需要 Perl 版本 5.6.1 或更高版本。 C 编译器应该与用于构建 Perl 的编译器兼容。

该模块是实验性的，需要注意购买者。

为了让 Perl 在 reconfiguration，则应使用 or 参数构建它。 此外，为了使 Perl 在运行时泄漏更少的内存， 它应该使用 parameter 构建。 要在已构建的 Perl（示例中指定了首选值）运行：-Dusemultiplicity=yes-Dusethreads=yes-Dusemymalloc=no

$ perl -V:usemultiplicity -V:usemymalloc
usemultiplicity='define';
usemymalloc='n';

请注意，使用新的 or 参数重新构建 Perl 后， 所有二进制 Perl 模块也必须重新构建 — 他们只会停止使用新的 Perl。-Dusemultiplicity=yes-Dusethreads=yes

主进程和工作进程可能会 每次重新配置后 size 都会增大。 如果主进程增长到不可接受的大小，则可以在不更改可执行文件的情况下应用实时升级过程。

当 Perl 模块正在执行长时间运行的作时，例如 解析域名、连接到其他服务器或查询数据库， 分配给当前 worker 进程的其他请求将不会被处理。 因此，建议仅执行此类作 具有可预测且较短的执行时间，例如 访问本地文件系统。

http {

    perl_modules perl/lib;
    perl_require hello.pm;

    perl_set $msie6 '

        sub {
            my $r = shift;
            my $ua = $r->header_in("User-Agent");

            return "" if $ua =~ /Opera/;
            return "1" if $ua =~ / MSIE [6-9]\.\d+/;
            return "";
        }

    ';

    server {
        location / {
            perl hello::handler;
        }
    }

该模块：perl/lib/hello.pm

package hello;

use nginx;

sub handler {
    my $r = shift;

    $r->send_http_header("text/html");
    return OK if $r->header_only;

    $r->print("hello!\n<br/>");

    if (-f $r->filename or -d _) {
        $r->print($r->uri, " exists!\n");
    }

    return OK;
}

1;
__END__

为给定位置设置 Perl 处理程序。

为 Perl 模块设置一个额外的路径。

定义将在每个 重 构。 可以存在多个Directives。perl_require

为指定的变量安装 Perl 处理程序。

调用 Perl 的 SSI 命令具有以下格式：

<!--# perl sub="module::function" arg="parameter1" arg="parameter2" ...
-->

$r->args

返回请求参数。

$r->filename

返回与请求 URI 对应的文件名。

$r->has_request_body(handler)

如果请求中没有 body，则返回 0。 如果有正文，则为请求设置指定的处理程序 并返回 1。 读取请求体后，nginx 将调用指定的处理程序。 请注意，处理程序函数应通过引用传递。 例：

package hello;

use nginx;

sub handler {
    my $r = shift;

    if ($r->request_method ne "POST") {
        return DECLINED;
    }

    if ($r->has_request_body(\&post)) {
        return OK;
    }

    return HTTP_BAD_REQUEST;
}

sub post {
    my $r = shift;

    $r->send_http_header;

    $r->print("request_body: \"", $r->request_body, "\"<br/>");
    $r->print("request_body_file: \"", $r->request_body_file, "\"<br/>\n");

    return OK;
}

1;

__END__

$r->allow_ranges

允许在发送响应时使用字节范围。

$r->discard_request_body

指示 nginx 丢弃请求体。

$r->header_in(field)

返回指定的 Client Request Header 字段的值。

$r->header_only

确定是应将整个响应发送到还是仅将其标头发送到 客户端。

$r->header_out(field, value)

为指定的 Response Header 字段设置一个值。

$r->internal_redirect(uri)

是否会将internal重定向到指定的 . 实际的重定向发生在 Perl 处理程序执行完成后。uri

从 1.17.2 版本开始，该方法接受转义的 URI 和 支持重定向到命名位置。

$r->log_error(errno, message)

将指定的 SQL 写入 error_log。 如果非零，则为错误代码及其描述 将附加到消息中。messageerrno

$r->print(text, ...)

将数据传递给客户端。

$r->request_body

返回客户端请求正文（如果尚未 写入临时文件。 要确保客户端请求正文位于内存中， 它的大小应受 client_max_body_size 的限制， 并且应使用 client_body_buffer_size 设置足够的缓冲区大小。

$r->request_body_file

返回带有 Client 请求正文的文件的名称。 处理后，应删除该文件。 要始终将请求正文写入文件，应启用 client_body_in_file_only。

$r->request_method

返回客户端请求 HTTP 方法。

$r->remote_addr

返回客户端 IP 地址。

$r->flush

立即将数据发送到客户端。

$r->sendfile(name[, offset[, length]])

将指定的文件内容发送到客户端。 可选参数 指定要传输的数据的初始偏移量和长度。 实际的数据传输发生在 Perl 处理程序之后 已完成。

$r->send_http_header([type])

将响应标头发送到客户端。 可选参数将 “Content-Type” 响应标头字段。 如果值为空字符串，则 “Content-Type” header 字段。type

$r->status(code)

设置响应代码。

$r->sleep(milliseconds, handler)

设置指定的处理程序 并在指定时间内停止请求处理。 与此同时，nginx 继续处理其他请求。 指定时间过后，nginx 将调用已安装的处理程序。 请注意，处理程序函数应通过引用传递。 为了在处理程序之间传递数据，应该使用。 例：$r->variable()

package hello;

use nginx;

sub handler {
    my $r = shift;

    $r->discard_request_body;
    $r->variable("var", "OK");
    $r->sleep(1000, \&next);

    return OK;
}

sub next {
    my $r = shift;

    $r->send_http_header;
    $r->print($r->variable("var"));

    return OK;
}

1;

__END__

$r->unescape(text)

解码以 “%XX” 形式编码的文本。

$r->uri

返回请求 URI。

$r->variable(name[, value])

返回或设置指定变量的值。 变量是每个请求的局部变量。