Perl 简明教程

Perl - CGI Programming

What is CGI ?

  1. 通用网关接口，或 CGI，是一组标准，定义了 Web 服务器和自定义脚本之间如何交换信息。

  2. CGI 规范由 NCSA 维护，NCSA 对 CGI 的定义如下 −

  3. 通用网关接口 (CGI) 是外部网关程序与诸如 HTTP 服务器等信息服务器进行交互的标准。

  4. 当前版本为 CGI/1.1，CGI/1.2 正在进行中。

Web Browsing

要了解 CGI 的概念，让我们看看当我们单击某个网页上可用的超链接来浏览某个特定网页或 URL 时会发生什么。

  1. 您的浏览器使用 HTTP 协议联系 Web 服务器并要求提供该 URL，即网页文件名。

  2. Web 服务器将检查该 URL 并查找请求的文件名。如果 Web 服务器找到了该文件，那么它会在没有任何进一步执行的情况下将该文件发送回浏览器，否则会发送一条错误消息，指明您请求的文件有误。

  3. Web 浏览器从 Web 服务器获取响应，并显示收到的文件内容或在文件未找到的情况下显示错误消息。

然而，有可能以这样的方式设置 HTTP 服务器，以便每当请求某个目录中的文件时，该文件不会被发送回来；而会被作为程序执行，并且无论该程序生成什么结果，都将发送回来让您的浏览器显示。这可以通过使用 Web 服务器中可用的特殊功能来完成，它被称为 Common Gateway Interface 或 CGI，而由服务器执行以产生最终结果的此类程序被称为 CGI 脚本。这些 CGI 程序可以是 PERL 脚本、Shell 脚本、C 或 C++ 程序等。

CGI Architecture Diagram

cgiarch

Web Server Support and Configuration

在继续 CGI 编程之前，请确保您的 Web 服务器支持 CGI 功能，并且已配置为处理 CGI 程序。由 Web 服务器执行的所有 CGI 程序都保存在预先配置的目录中。此目录被称为 CGI 目录，按照惯例它被命名为 /cgi-bin。按照惯例，Perl CGI 文件将扩展名为 .cgi 。

First CGI Program

这里有一个简单的链接，它链接到一个名为 hello.cgi 的 CGI 脚本。该文件保存在 /cgi-bin/ 目录中，并且具有以下内容。在运行您的 CGI 程序之前，请确保您已使用 chmod 755 hello.cgi UNIX 命令更改了该文件模式。

#!/usr/bin/perl

print "Content-type:text/html\r\n\r\n";
print '<html>';
print '<head>';
print '<title>Hello Word - First CGI Program</title>';
print '</head>';
print '<body>';
print '<h2>Hello Word! This is my first CGI program</h2>';
print '</body>';
print '</html>';

1;

现在，如果您单击 hello.cgi 链接，那么请求会发送到在 /cgi-bin 目录中搜索 hello.cgi 的 Web 服务器，执行它，并且无论生成了什么结果，Web 服务器都会将该结果发送回 Web 浏览器，如下所示：

Hello Word! This is my first CGI program

hello.cgi 脚本是一个简单的 Perl 脚本，它正在向 STDOUT 文件（即屏幕）写入其输出。还有一个重要的额外功能可用，即要打印的第一行 Content-type:text/html\r\n\r\n 。这一行发送回浏览器并指定要显示在浏览器屏幕上的内容类型。现在您必定已经了解了 CGI 的基本概念，并且可以使用 Perl 编写许多复杂的 CGI 程序。此脚本还可以与任何其他外部系统进行交互，以交换信息，如数据库、网络服务或任何其他复杂界面。

Understanding HTTP Header

第一行 Content-type:text/html\r\n\r\n 是 HTTP 标头的一部分，发送到浏览器，以便浏览器可以理解来自服务器端的传入内容。所有 HTTP 标头都将采用以下形式 −

HTTP Field Name: Field Content

例如 −

Content-type:text/html\r\n\r\n

有其他一些重要的 HTTP 头信息，您将在 CGI 编程中经常使用。

Sr.No.

Header & Description

1

Content-type: String 一个定义要返回的内容格式的 MIME 字符串。示例是 Content-type:text/html

2

Expires: Date String 信息变为无效的日期。这应由浏览器使用来决定何时需要刷新页面。有效的日期字符串应具有格式 01 Jan 1998 12:00:00 GMT。

3

Location: URL String 应返回的 URL，而不是请求的 URL。你可以使用此字段将请求重定向到任何其他位置。

4

Last-modified: String 文件的最后修改日期。

5

Content-length: String 要返回的数据的长度（以字节为单位）。浏览器使用此值报告文件的估计下载时间。

6

Set-Cookie: String 设置通过字符串传递的 Cookie

CGI Environment Variables

所有 CGI 程序都将能够访问以下环境变量。这些变量在编写任何 CGI 程序时发挥着重要作用。

Sr.No.

Variables Names & Description

1

CONTENT_TYPE 内容的数据类型。在客户端向服务器发送附加内容时使用。例如文件上传等。

2

CONTENT_LENGTH 查询信息的长度。它仅适用于 POST 请求

3

HTTP_COOKIE 以键 & 值对的形式返回设置的 cookie。

4

HTTP_USER_AGENT User-Agent 请求标头字段包含有关发出请求的用户代理的信息。它的 web 浏览器的名称。

5

PATH_INFO CGI 脚本的路径。

6

QUERY_STRING 随 GET 方法请求而发送的 URL 编码信息。

7

REMOTE_ADDR 发出请求的远程主机的 IP 地址。这对于记录或认证目的非常有用。

8

REMOTE_HOST 发出请求的主机的完全限定域名。如果此信息不可用，则可以使用 REMOTE_ADDR 获取 IR 地址。

9

REQUEST_METHOD 用于发出请求的方法。最常见的方法是 GET 和 POST。

10

SCRIPT_FILENAME CGI 脚本的完整路径。

11

SCRIPT_NAME CGI 脚本的名称。

12

SERVER_NAME 服务器的主机名或 IP 地址。

13

SERVER_SOFTWARE 服务器正在运行的软件的名称和版本。

这里是列出 Web 服务器支持的所有 CGI 变量的小型 CGI 程序。单击此链接 Get Environment 查看结果

#!/usr/bin/perl

print "Content-type: text/html\n\n";
print "<font size=+1>Environment</font>\n";
foreach (sort keys %ENV) {
   print "<b>$_</b>: $ENV{$_}<br>\n";
}

1;

Raise a "File Download" Dialog Box?

有时，您希望提供一个选项，用户单击该选项将看到一个“文件下载”对话框，而不是显示实际内容。这非常简单，通过 HTTP 头可以实现。

此 HTTP 头与前面部分中提到的头不同。例如，如果您想让某个 FileName 文件可从给定链接下载，则其语法如下：

#!/usr/bin/perl

# HTTP Header
print "Content-Type:application/octet-stream; name = \"FileName\"\r\n";
print "Content-Disposition: attachment; filename = \"FileName\"\r\n\n";

# Actual File Content will go hear.
open( FILE, "<FileName" );
while(read(FILE, $buffer, 100) ) {
   print("$buffer");
}

GET and POST Methods

您肯定遇到过许多情况，您需要将某些信息从浏览器传递到 Web 服务器，最终传递到处理您请求的 CGI 程序中。浏览器最常使用两种方法将此信息传递到 Web 服务器上。这两种方法是 GET 方法和 POST 方法。让我们逐一了解它们。

Passing Information using GET Method

GET 方法将编码的用户信息追加到页面 URL 本身。该页面和编码信息由 ? 字符分隔，如下所示：

http://www.test.com/cgi-bin/hello.cgi?key1=value1&key2=value2

GET 方法是将信息从浏览器传递到 Web 服务器的默认方法，它会生成一个长字符串，显示在浏览器的 Location: 框中。如果您有密码或其他要传递给服务器的敏感信息，则绝不应使用 GET 方法。GET 方法有大小限制：请求字符串中仅能传递 1024 个字符。

此信息使用 QUERY_STRING 头传递，并可通过 QUERY_STRING 环境变量在你的 CGI 程序中访问，可以在你的 CGI 程序中解析和使用。

您可以简单地将键值对与任何 URL 连接起来传递信息，也可以使用 HTML <FORM> 标记使用 GET 方法传递信息。

Simple URL Example: Get Method

下面是一个简单的 URL，它将两个值传递给 hello_get.cgi 程序，并使用 GET 方法。

下面是 hello_get.cgi 脚本，用于处理 Web 浏览器给出的输入。

#!/usr/bin/perl

local ($buffer, @pairs, $pair, $name, $value, %FORM);
# Read in text
$ENV{'REQUEST_METHOD'} =~ tr/a-z/A-Z/;
if ($ENV{'REQUEST_METHOD'} eq "GET") {
   $buffer = $ENV{'QUERY_STRING'};
}
# Split information into name/value pairs
@pairs = split(/&/, $buffer);
foreach $pair (@pairs) {
   ($name, $value) = split(/=/, $pair);
   $value =~ tr/+/ /;
   $value =~ s/%(..)/pack("C", hex($1))/eg;
   $FORM{$name} = $value;
}
$first_name = $FORM{first_name};
$last_name  = $FORM{last_name};

print "Content-type:text/html\r\n\r\n";
print "<html>";
print "<head>";
print "<title>Hello - Second CGI Program</title>";
print "</head>";
print "<body>";
print "<h2>Hello $first_name $last_name - Second CGI Program</h2>";
print "</body>";
print "</html>";

1;

Simple FORM Example: GET Method

下面是一个简单的示例，它使用 HTML 表单和提交按钮传递两个值。我们将使用相同的 CGI 脚本 hello_get.cgi 来处理此输入。

<FORM action = "/cgi-bin/hello_get.cgi" method = "GET">
First Name: <input type = "text" name = "first_name">  <br>

Last Name: <input type = "text" name = "last_name">
<input type = "submit" value = "Submit">
</FORM>

这是上面表单代码的实际输出。现在，您可以输入名字和姓氏，然后单击提交按钮以查看结果。

Passing Information using POST Method

向 CGI 程序传递信息的更可靠的方法是 POST 方法。这会打包信息的方式与 GET 方法完全相同，但不是在 URL 中在 ? 后面以文本字符串的形式发送，而是作为 HTTP 头的一部分以单独消息的形式发送。Web 服务器会通过标准输入的形式提供此消息给 CGI 脚本。

下面是经过修改的 hello_post.cgi 脚本，用于处理 Web 浏览器给出的输入。此脚本将处理 GET 和 POST 方法。

#!/usr/bin/perl

local ($buffer, @pairs, $pair, $name, $value, %FORM);
# Read in text
$ENV{'REQUEST_METHOD'} =~ tr/a-z/A-Z/;
if ($ENV{'REQUEST_METHOD'} eq "POST") {
   read(STDIN, $buffer, $ENV{'CONTENT_LENGTH'});
} else {
   $buffer = $ENV{'QUERY_STRING'};
}
# Split information into name/value pairs
@pairs = split(/&/, $buffer);
foreach $pair (@pairs) {
   ($name, $value) = split(/=/, $pair);
   $value =~ tr/+/ /;
   $value =~ s/%(..)/pack("C", hex($1))/eg;
   $FORM{$name} = $value;
}
$first_name = $FORM{first_name};
$last_name  = $FORM{last_name};

print "Content-type:text/html\r\n\r\n";
print "<html>";
print "<head>";
print "<title>Hello - Second CGI Program</title>";
print "</head>";
print "<body>";
print "<h2>Hello $first_name $last_name - Second CGI Program</h2>";
print "</body>";
print "</html>";

1;

让我们再次举上面的例子，使用 HTML 表单和提交按钮传递两个值。我们将使用 CGI 脚本 hello_post.cgi 来处理此输入。

<FORM action = "/cgi-bin/hello_post.cgi" method = "POST">
First Name: <input type = "text" name = "first_name">  <br>

Last Name: <input type = "text" name = "last_name">

<input type = "submit" value = "Submit">
</FORM>

这是上面表单代码的实际输出。您可以输入名字和姓氏，然后单击提交按钮以查看结果。

Passing Checkbox Data to CGI Program

当需要选择多个选项时，会使用复选框。以下是带两个复选框的表单的 HTML 代码示例。

<form action = "/cgi-bin/checkbox.cgi" method = "POST" target = "_blank">
<input type = "checkbox" name = "maths" value = "on"> Maths
<input type = "checkbox" name = "physics" value = "on"> Physics
<input type = "submit" value = "Select Subject">
</form>

这段代码的结果是以下表单−

下面是 checkbox.cgi 脚本，用于处理 Web 浏览器给出的单选按钮输入。

#!/usr/bin/perl

local ($buffer, @pairs, $pair, $name, $value, %FORM);
# Read in text
$ENV{'REQUEST_METHOD'} =~ tr/a-z/A-Z/;
if ($ENV{'REQUEST_METHOD'} eq "POST") {
   read(STDIN, $buffer, $ENV{'CONTENT_LENGTH'});
} else {
   $buffer = $ENV{'QUERY_STRING'};
}
# Split information into name/value pairs
@pairs = split(/&/, $buffer);
foreach $pair (@pairs) {
   ($name, $value) = split(/=/, $pair);
   $value =~ tr/+/ /;
   $value =~ s/%(..)/pack("C", hex($1))/eg;
   $FORM{$name} = $value;
}
if( $FORM{maths} ) {
   $maths_flag ="ON";
} else {
   $maths_flag ="OFF";
}
if( $FORM{physics} ) {
   $physics_flag ="ON";
} else {
   $physics_flag ="OFF";
}

print "Content-type:text/html\r\n\r\n";
print "<html>";
print "<head>";
print "<title>Checkbox - Third CGI Program</title>";
print "</head>";
print "<body>";
print "<h2> CheckBox Maths is : $maths_flag</h2>";
print "<h2> CheckBox Physics is : $physics_flag</h2>";
print "</body>";
print "</html>";

1;

Passing Radio Button Data to CGI Program

只有在需要选择一个选项时才使用单选按钮。以下是带两个单选按钮的表单的 HTML 代码示例：

<form action = "/cgi-bin/radiobutton.cgi" method = "POST" target = "_blank">
<input type = "radio" name = "subject" value = "maths"> Maths
<input type = "radio" name = "subject" value = "physics"> Physics
<input type = "submit" value = "Select Subject">
</form>

这段代码的结果是以下表单−

下面是 radiobutton.cgi 脚本，用于处理 Web 浏览器给出的单选按钮输入。

#!/usr/bin/perl

local ($buffer, @pairs, $pair, $name, $value, %FORM);
# Read in text
$ENV{'REQUEST_METHOD'} =~ tr/a-z/A-Z/;
if ($ENV{'REQUEST_METHOD'} eq "POST") {
   read(STDIN, $buffer, $ENV{'CONTENT_LENGTH'});
} else {
   $buffer = $ENV{'QUERY_STRING'};
}
# Split information into name/value pairs
@pairs = split(/&/, $buffer);
foreach $pair (@pairs) {
   ($name, $value) = split(/=/, $pair);
   $value =~ tr/+/ /;
   $value =~ s/%(..)/pack("C", hex($1))/eg;
   $FORM{$name} = $value;
}
$subject = $FORM{subject};

print "Content-type:text/html\r\n\r\n";
print "<html>";
print "<head>";
print "<title>Radio - Fourth CGI Program</title>";
print "</head>";
print "<body>";
print "<h2> Selected Subject is $subject</h2>";
print "</body>";
print "</html>";

1;

Passing Text Area Data to CGI Program

当需要将多行文本传递给 CGI 程序时，使用文本区域元素。以下是带有一个 TEXTAREA 框的表单的示例 HTML 代码 −

<form action = "/cgi-bin/textarea.cgi" method = "POST" target = "_blank">
<textarea name = "textcontent" cols = 40 rows = 4>
Type your text here...
</textarea>
<input type = "submit" value = "Submit">
</form>

这段代码的结果是以下表单−

以下是 textarea.cgi 用于处理 web 浏览器给出的输入的脚本。

#!/usr/bin/perl

local ($buffer, @pairs, $pair, $name, $value, %FORM);
# Read in text
$ENV{'REQUEST_METHOD'} =~ tr/a-z/A-Z/;
if ($ENV{'REQUEST_METHOD'} eq "POST") {
   read(STDIN, $buffer, $ENV{'CONTENT_LENGTH'});
} else {
   $buffer = $ENV{'QUERY_STRING'};
}
# Split information into name/value pairs
@pairs = split(/&/, $buffer);
foreach $pair (@pairs) {
   ($name, $value) = split(/=/, $pair);
   $value =~ tr/+/ /;
   $value =~ s/%(..)/pack("C", hex($1))/eg;
   $FORM{$name} = $value;
}
$text_content = $FORM{textcontent};

print "Content-type:text/html\r\n\r\n";
print "<html>";
print "<head>";
print "<title>Text Area - Fifth CGI Program</title>";
print "</head>";
print "<body>";
print "<h2> Entered Text Content is $text_content</h2>";
print "</body>";
print "</html>";

1;

Passing Drop Down Box Data to CGI Program

当我们有许多可用的选项但只选择一两个选项时，使用下拉框。以下是带有一个下拉框的表单的示例 HTML 代码

<form action = "/cgi-bin/dropdown.cgi" method = "POST" target = "_blank">
<select name = "dropdown">
<option value = "Maths" selected>Maths</option>
<option value = "Physics">Physics</option>
</select>
<input type = "submit" value = "Submit">
</form>

这段代码的结果是以下表单−

以下是 dropdown.cgi 用于处理 web 浏览器给出的输入的脚本。

#!/usr/bin/perl

local ($buffer, @pairs, $pair, $name, $value, %FORM);
# Read in text
$ENV{'REQUEST_METHOD'} =~ tr/a-z/A-Z/;
if ($ENV{'REQUEST_METHOD'} eq "POST") {
   read(STDIN, $buffer, $ENV{'CONTENT_LENGTH'});
} else {
   $buffer = $ENV{'QUERY_STRING'};
}
# Split information into name/value pairs
@pairs = split(/&/, $buffer);
foreach $pair (@pairs) {
   ($name, $value) = split(/=/, $pair);
   $value =~ tr/+/ /;
   $value =~ s/%(..)/pack("C", hex($1))/eg;
   $FORM{$name} = $value;
}
$subject = $FORM{dropdown};

print "Content-type:text/html\r\n\r\n";
print "<html>";
print "<head>";
print "<title>Dropdown Box - Sixth CGI Program</title>";
print "</head>";
print "<body>";
print "<h2> Selected Subject is $subject</h2>";
print "</body>";
print "</html>";

1;

Using Cookies in CGI

HTTP 协议是一个无状态协议。但是，对于商业网站而言，需要在不同页面之间维护会话信息。例如，一个用户注册在跨越许多页面的事务之后结束。但如何在所有网页中维护用户的会话信息？

在许多情况下，使用 cookie 是记忆和跟踪偏好、购买、佣金和其他信息最有效的方法，而这些信息对于提升访问者体验或网站统计至关重要。

How It Works

您的服务器会以 Cookie 的形式向访客的浏览器发送一些数据。浏览器可能会接受 Cookie。如果接受，它将作为纯文本记录存储在访客硬盘上。现在，当访客到达您站点上的另一个页面时，可以检索 Cookie。检索后，您的服务器知道/记住存储的内容。

Cookie 是纯文本数据记录，包含 5 个可变长度字段：

  1. Expires − cookie 的过期日期。如果留空，则 cookie 将在访问者退出浏览器时过期。

  2. Domain − 您网站的域名。

  3. Path − 设置 cookie 的目录或网页的路径。如果您希望从任何目录或页面检索 cookie，则可以留空。

  4. Secure - 如果此字段包含单词“secure”，则只能通过安全服务器来检索 cookie。如果此字段为空，则不存在此类限制。

  5. Name = Value − Cookie 以键值对的形式设置和重新获取。

Setting up Cookies

将 Cookie 发送到浏览器非常容易。这些 Cookie 将与 HTTP 标头一起发送。假设你想要将 UserID 和 Password 设置为 Cookie。因此，将按如下进行 −

#!/usr/bin/perl

print "Set-Cookie:UserID = XYZ;\n";
print "Set-Cookie:Password = XYZ123;\n";
print "Set-Cookie:Expires = Tuesday, 31-Dec-2007 23:12:40 GMT";\n";
print "Set-Cookie:Domain = www.tutorialspoint.com;\n";
print "Set-Cookie:Path = /perl;\n";
print "Content-type:text/html\r\n\r\n";
...........Rest of the HTML Content goes here....

这里我们使用 Set-Cookie HTTP 标头来设置 Cookie。设置 Expires、Domain 和 Path 等 Cookie 属性是可选的。务必要注意，在发送魔术行 "Content-type:text/html\r\n\r\n 之前设置 Cookie。

Retrieving Cookies

非常容易检索所有设置的 Cookie。Cookie 存储在 CGI 环境变量 HTTP_COOKIE 中，它们将具有以下形式。

key1 = value1;key2 = value2;key3 = value3....

以下是有关如何检索 cookie 的示例。

#!/usr/bin/perl
$rcvd_cookies = $ENV{'HTTP_COOKIE'};
@cookies = split /;/, $rcvd_cookies;
foreach $cookie ( @cookies ) {
   ($key, $val) = split(/=/, $cookie); # splits on the first =.
   $key =~ s/^\s+//;
   $val =~ s/^\s+//;
   $key =~ s/\s+$//;
   $val =~ s/\s+$//;
   if( $key eq "UserID" ) {
      $user_id = $val;
   } elsif($key eq "Password") {
      $password = $val;
   }
}
print "User ID  = $user_id\n";
print "Password = $password\n";

在调用读取 cookie 脚本之前设置好 cookie，将产生以下结果，如上所述。

User ID = XYZ
Password = XYZ123

CGI Modules and Libraries

您会在互联网上找到许多内置模块，这些模块为您提供了可在 CGI 程序中直接使用的功能。以下是最重要的。

  1. CGI Module

  2. Berkeley cgi-lib.pl