Perl - CGI 编程

公共网关接口 (CGI) 是一套标准，定义了信息如何在 Web 服务器和自定义脚本之间交换。
CGI 规范目前由 NCSA 维护，NCSA 对 CGI 的定义如下：
公共网关接口 (CGI) 是外部网关程序与信息服务器（例如 HTTP 服务器）交互的标准。
当前版本为 CGI/1.1，CGI/1.2 正在开发中。

网页浏览

为了理解 CGI 的概念，让我们看看当我们点击网页上提供的超链接来浏览特定网页或 URL 时会发生什么。

您的浏览器使用 HTTP 协议联系 Web 服务器并请求 URL，即网页文件名。
Web 服务器将检查 URL 并查找请求的文件名。如果 Web 服务器找到该文件，则它会将文件发送回浏览器而无需进一步执行，否则会发送错误消息，指示您请求的文件错误。
Web 浏览器接收来自 Web 服务器的响应，并在找不到文件的情况下显示接收到的文件内容或错误消息。

但是，可以这样设置 HTTP 服务器：每当请求某个目录中的文件时，该文件不会被发送回来；相反，它作为程序执行，并且该程序输出的任何结果都会被发送回浏览器以供显示。这可以通过使用 Web 服务器中提供的特殊功能来完成，该功能称为公共网关接口或 CGI，并且服务器执行以产生最终结果的此类程序称为 CGI 脚本。这些 CGI 程序可以是 PERL 脚本、Shell 脚本、C 或 C++ 程序等。

CGI 架构图

Web 服务器支持和配置

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

第一个 CGI 程序

这是一个简单的链接，它链接到名为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链接，则请求将发送到 Web 服务器，Web 服务器将在 /cgi-bin 目录中搜索 hello.cgi，执行它，并将生成的任何结果发送回 Web 浏览器，结果如下：

Hello Word! This is my first CGI program

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

理解 HTTP 头

第一行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 编程中经常使用。

序号	头 & 描述
1	Content-type: 字符串定义返回内容格式的 MIME 字符串。例如 Content-type:text/html
2	Expires: 日期字符串信息变得无效的日期。浏览器应使用此信息来确定何时需要刷新页面。有效的日期字符串应采用 01 Jan 1998 12:00:00 GMT 格式。
3	Location: URL 字符串应返回的 URL，而不是请求的 URL。您可以使用此字段将请求重定向到任何其他位置。
4	Last-modified: 字符串文件的最后修改日期。
5	Content-length: 字符串返回数据的长度（以字节为单位）。浏览器使用此值来报告文件的估计下载时间。
6	Set-Cookie: 字符串设置通过字符串传递的 Cookie

CGI 环境变量

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

序号	变量名称 & 描述
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 服务器正在运行的软件的名称和版本。

这是一个小的 CGI 程序，用于列出 Web 服务器支持的所有 CGI 变量。单击此链接以查看结果获取环境变量

#!/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;

显示“文件下载”对话框？

有时您希望提供一个选项，用户单击链接时会向用户弹出一个“文件下载”对话框，而不是显示实际内容。这非常容易实现，可以通过 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 和 POST 方法

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

使用 GET 方法传递信息

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 方法传递信息。

简单的 URL 示例：GET 方法

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

https://tutorialspoint.com/cgi-bin/hello_get.cgi?first_name=ZARA&last_name=ALI

以下是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;

简单的表单示例：GET 方法

这是一个简单的示例，它使用 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>

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

使用 POST 方法传递信息

将信息传递给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>

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

将复选框数据传递给CGI程序

当需要选择多个选项时，使用复选框。这是一个带有两个复选框的表单的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;

将单选按钮数据传递给CGI程序

当只需要选择一个选项时，使用单选按钮。这是一个带有两个单选按钮的表单的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;

将文本区域数据传递给CGI程序

当必须将多行文本传递给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;

将下拉框数据传递给CGI程序

当有很多选项可用，但只需要选择一两个时，使用下拉框。这是一个带有下拉框的表单的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;

在CGI中使用Cookie

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

在许多情况下，使用Cookie是记住和跟踪偏好、购买、佣金以及其他提高访问者体验或网站统计信息所需信息的最高效方法。

工作原理

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

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

Expires - Cookie将过期的日期。如果为空，则Cookie将在访问者退出浏览器时过期。
Domain - 您网站的域名。
Path - 设置Cookie的目录或网页的路径。如果您想从任何目录或页面检索Cookie，则可以为空。
Secure - 如果此字段包含单词“secure”，则Cookie只能使用安全服务器检索。如果此字段为空，则不存在此类限制。
Name = Value - Cookie以键值对的形式设置和检索。

设置Cookie

将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。设置Cookie属性（如Expires、Domain和Path）是可选的。重要的是要注意，在发送魔术行"Content-type:text/html\r\n\r\n"之前设置Cookie。

检索Cookie

检索所有已设置的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模块和库

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

打印页面

Perl - CGI 编程

什么是 CGI？

网页浏览

CGI 架构图

Web 服务器支持和配置

第一个 CGI 程序

Hello Word! This is my first CGI program

理解 HTTP 头

CGI 环境变量

显示“文件下载”对话框？

GET 和 POST 方法

使用 GET 方法传递信息

简单的 URL 示例：GET 方法

简单的表单示例：GET 方法

使用 POST 方法传递信息

将复选框数据传递给CGI程序

将单选按钮数据传递给CGI程序

将文本区域数据传递给CGI程序

将下拉框数据传递给CGI程序

在CGI中使用Cookie

工作原理

设置Cookie

检索Cookie

CGI模块和库