CGI Programming

优质

小牛编辑

131浏览

2023-12-01

通用网关接口（CGI）是一组标准，用于定义如何在Web服务器和自定义脚本之间交换信息。 CGI规范目前由NCSA维护。

什么是CGI？

通用网关接口（CGI）是外部网关程序的标准，用于与信息服务器（如HTTP服务器）连接。
目前的版本是CGI/1.1，CGI/1.2正在进行中。

网页浏览 (Web Browsing)

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

您的浏览器会联系HTTP Web服务器并要求提供URL，即文件名。
Web Server解析URL并查找文件名。如果它发现该文件然后将其发送回浏览器，否则会发送一条错误消息，指出您请求了错误的文件。
Web浏览器从Web服务器获取响应，并显示接收的文件或错误消息。

但是，可以设置HTTP服务器，以便每当请求某个目录中的文件时不发回该文件; 相反，它作为一个程序执行，无论该程序输出什么，都会被发回给您的浏览器进行显示。此功能称为公共网关接口或CGI，程序称为CGI脚本。这些CGI程序可以是Python脚本，PERL脚本，Shell脚本，C或C ++程序等。

CGI架构图 (CGI Architecture Diagram)

Web服务器支持和配置

在继续进行CGI编程之前，请确保您的Web服务器支持CGI并配置为处理CGI程序。 HTTP服务器要执行的所有CGI程序都保存在预先配置的目录中。此目录称为CGI目录，按照惯例，它名为/ var/www/cgi-bin。按照惯例，CGI文件的扩展名为。 cgi,但你也可以用python扩展名.py来保存你的文件。

默认情况下，Linux服务器配置为仅运行/ var/www中cgi-bin目录中的脚本。如果要指定任何其他目录来运行CGI脚本，请在httpd.conf文件中注释以下行 -

<Directory "/var/www/cgi-bin">
   AllowOverride None
   Options ExecCGI
   Order allow,deny
   Allow from all
</Directory>
<Directory "/var/www/cgi-bin">
Options All
</Directory>

在这里，我们假设您已经成功运行Web Server，并且您可以运行任何其他CGI程序，如Perl或Shell等。

第一个CGI程序 (First CGI Program)

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

#!/usr/bin/python
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>'

如果单击hello.py，则会生成以下输出 -

你好Word！这是我的第一个CGI计划

这个hello.py脚本是一个简单的Python脚本，它将其输出写入STDOUT文件，即屏幕。有一个重要的额外功能，第一行打印Content-type:text/html\r\n\r\n 。此行将发送回浏览器，并指定要在浏览器屏幕上显示的内容类型。

到目前为止，您必须了解CGI的基本概念，并且可以使用Python编写许多复杂的CGI程序。此脚本还可以与任何其他外部系统交互，以交换RDBMS等信息。

HTTP标头

Content-type:text/html\r\n\r\n是HTTP标头的一部分，它被发送到浏览器以了解内容。所有HTTP标头将采用以下形式 -

HTTP Field Name: Field Content
For Example
Content-type: text/html\r\n\r\n

很少有其他重要的HTTP标头，您将在CGI编程中经常使用它们。

Sr.No.	标题和说明
1	Content-type: MIME字符串，用于定义要返回的文件的格式。示例是Content-type:text/html
2	Expires: Date 信息失效的日期。浏览器使用它来决定何时需要刷新页面。有效日期字符串的格式为01 Jan 1998 12:00:00 GMT。
3	Location: URL 返回的URL而不是请求的URL。您可以使用此字段将请求重定向到任何文件。
4	Last-modified: Date 上次修改资源的日期。
5	Content-length: N 返回数据的长度（以字节为单位）。浏览器使用此值报告文件的估计下载时间。
6	Set-Cookie: String 设置通过string传递的cookie

CGI环境变量 (CGI Environment Variables)

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

Sr.No.	变量名称和描述
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程序，列出了所有CGI变量。单击此链接可查看结果Get Environment

#!/usr/bin/python
import os
print "Content-type: text/html\r\n\r\n";
print "<font size=+1>Environment</font><\br>";
for param in os.environ.keys():
   print "<b>%20s</b>: %s<\br>" % (param, os.environ[param])

GET和POST方法 (GET and POST Methods)

当您需要将某些信息从浏览器传递到Web服务器并最终传递到CGI程序时，您必须遇到很多情况。最常见的是，浏览器使用两种方法将这些信息传递给Web服务器。这些方法是GET方法和POST方法。

使用GET方法传递信息

GET方法发送附加到页面请求的编码用户信息。页面和编码信息由？分隔。性格如下 -

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

GET方法是将信息从浏览器传递到Web服务器的默认方法，它会生成一个长字符串，显示在浏览器的Location:框中。如果您要将密码或其他敏感信息传递给服务器，请勿使用GET方法。 GET方法具有大小限制:在请求字符串中只能发送1024个字符。 GET方法使用QUERY_STRING标头发送信息，并可通过QUERY_STRING环境变量在CGI程序中访问。

您可以通过简单地连接键和值对以及任何URL来传递信息，也可以使用HTML

标记使用GET方法传递信息。

简单URL示例:获取方法

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

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

下面是hello_get.py脚本，用于处理Web浏览器提供的输入。我们将使用cgi模块，这使得访问传递的信息变得非常容易 -

#!/usr/bin/python
# Import modules for CGI handling 
import cgi, cgitb 
# Create instance of FieldStorage 
form = cgi.FieldStorage() 
# Get data from fields
first_name = form.getvalue('first_name')
last_name  = form.getvalue('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 %s %s</h2>" % (first_name, last_name)
print "</body>"
print "</html>"

这将产生以下结果 -

你好ZARA ALI

简单形式示例:GET方法

此示例使用HTML FORM和提交按钮传递两个值。我们使用相同的CGI脚本hello_get.py来处理此输入。

<form action = "/cgi-bin/hello_get.py" 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中，它将其作为单独的消息发送。此消息以标准输入的形式进入CGI脚本。

下面是相同的hello_get.py脚本，它处理GET和POST方法。

#!/usr/bin/python
# Import modules for CGI handling 
import cgi, cgitb 
# Create instance of FieldStorage 
form = cgi.FieldStorage() 
# Get data from fields
first_name = form.getvalue('first_name')
last_name  = form.getvalue('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 %s %s</h2>" % (first_name, last_name)
print "</body>"
print "</html>"

让我们再次采用与上面相同的示例，它使用HTML FORM和提交按钮传递两个值。我们使用相同的CGI脚本hello_get.py来处理此输入。

<form action = "/cgi-bin/hello_get.py" 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/python
# Import modules for CGI handling 
import cgi, cgitb 
# Create instance of FieldStorage 
form = cgi.FieldStorage() 
# Get data from fields
if form.getvalue('maths'):
   math_flag = "ON"
else:
   math_flag = "OFF"
if form.getvalue('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 : %s</h2>" % math_flag
print "<h2> CheckBox Physics is : %s</h2>" % physics_flag
print "</body>"
print "</html>"

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

当只需要选择一个选项时，使用单选按钮。

以下是带有两个单选按钮的表单的示例HTML代码 -

<form action = "/cgi-bin/radiobutton.py" 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.py脚本，用于处理网络浏览器为单选按钮提供的输入 -

#!/usr/bin/python
# Import modules for CGI handling 
import cgi, cgitb 
# Create instance of FieldStorage 
form = cgi.FieldStorage() 
# Get data from fields
if form.getvalue('subject'):
   subject = form.getvalue('subject')
else:
   subject = "Not set"
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 %s</h2>" % subject
print "</body>"
print "</html>"

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

当多行文本必须传递给CGI程序时，使用TEXTAREA元素。

以下是带有TEXTAREA框的表单的示例HTML代码 -

<form action = "/cgi-bin/textarea.py" 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/python
# Import modules for CGI handling 
import cgi, cgitb 
# Create instance of FieldStorage 
form = cgi.FieldStorage() 
# Get data from fields
if form.getvalue('textcontent'):
   text_content = form.getvalue('textcontent')
else:
   text_content = "Not entered"
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 %s</h2>" % text_content
print "</body>"

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

当我们有许多可用选项但只选择一个或两个时，使用下拉框。

以下是带有一个下拉框的表单的示例HTML代码 -

<form action = "/cgi-bin/dropdown.py" 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.py脚本，用于处理Web浏览器提供的输入。

#!/usr/bin/python
# Import modules for CGI handling 
import cgi, cgitb 
# Create instance of FieldStorage 
form = cgi.FieldStorage() 
# Get data from fields
if form.getvalue('dropdown'):
   subject = form.getvalue('dropdown')
else:
   subject = "Not entered"
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 %s</h2>" % subject
print "</body>"
print "</html>"

在CGI中使用cookie (Using Cookies in CGI)

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

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

它是如何工作的 (How It Works?)

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

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

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

设置Cookies (Setting up Cookies)

将cookie发送到浏览器非常容易。这些cookie与HTTP标头一起发送到Content-type字段。假设您要将UserID和密码设置为cookie。设置cookie如下 -

#!/usr/bin/python
print "Set-Cookie:UserID = XYZ;\r\n"
print "Set-Cookie:Password = XYZ123;\r\n"
print "Set-Cookie:Expires = Tuesday, 31-Dec-2007 23:12:40 GMT";\r\n"
print "Set-Cookie:Domain = www.xnip.cn;\r\n"
print "Set-Cookie:Path = /perl;\n"
print "Content-type:text/html\r\n\r\n"
...........Rest of the HTML Content....

从这个例子中，您必须了解如何设置cookie。我们使用Set-Cookie HTTP标头来设置cookie。

可以选择设置Expires，Domain和Path等Cookie属性。值得注意的是，在发送魔术行之前设置了cookie "Content-type:text/html\r\n\r\n 。

检索Cookies (Retrieving Cookies)

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

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

以下是如何检索Cookie的示例。

#!/usr/bin/python
# Import modules for CGI handling 
from os import environ
import cgi, cgitb
if environ.has_key('HTTP_COOKIE'):
   for cookie in map(strip, split(environ['HTTP_COOKIE'], ';')):
      (key, value ) = split(cookie, '=');
      if key == "UserID":
         user_id = value
      if key == "Password":
         password = value
print "User ID  = %s" % user_id
print "Password = %s" % password

这会对上面脚本设置的cookie产生以下结果 -

User ID = XYZ
Password = XYZ123

文件上传示例

要上载文件，HTML表单必须将enctype属性设置为multipart/form-data 。具有文件类型的输入标记创建“浏览”按钮。

<html>
<body>
   <form enctype = "multipart/form-data" 
                     action = "save_file.py" method = "post">
   <p>File: <input type = "file" name = "filename" /></p>
   <p><input type = "submit" value = "Upload" /></p>
   </form>
</body>
</html>

此代码的结果如下:

文件:

以上示例已被故意禁用以保存人们在我们的服务器上上传文件，但您可以尝试使用您的服务器上面的代码。

这是用于处理文件上传的脚本save_file.py -

#!/usr/bin/python
import cgi, os
import cgitb; cgitb.enable()
form = cgi.FieldStorage()
# Get filename here.
fileitem = form['filename']
# Test if the file was uploaded
if fileitem.filename:
   # strip leading path from file name to avoid 
   # directory traversal attacks
   fn = os.path.basename(fileitem.filename)
   open('/tmp/' + fn, 'wb').write(fileitem.file.read())
   message = 'The file "' + fn + '" was uploaded successfully'
else:
   message = 'No file was uploaded'
print """\
Content-Type: text/html\n
<html>
<body>
   <p>%s</p>
</body>
</html>
""" % (message,)

如果你在Unix/Linux上运行上面的脚本，那么你需要注意如下替换文件分隔符，否则在windows机器上面open（）语句应该可以正常工作。

fn = os.path.basename(fileitem.filename.replace("\\", "/" ))

如何提高“文件下载”对话框？

有时，您希望提供用户可以单击链接的选项，它会向用户弹出“文件下载”对话框，而不是显示实际内容。这非常简单，可以通过HTTP标头实现。此HTTP标头与上一节中提到的标头不同。

例如，如果您希望从给定链接下载FileName文件，则其语法如下 -

#!/usr/bin/python
# HTTP Header
print "<b>Content-Type:</b>application/octet-stream; name = \"FileName\"\r\n";
print "<b>Content-Disposition:</b> attachment; filename = \"FileName\"\r\n\n";
# Actual File Content will go here.
fo = open("foo.txt", "rb")
str = fo.read();
print str
# Close opend file
fo.close()

CGI Programming

什么是CGI？

网页浏览 (Web Browsing)

CGI架构图 (CGI Architecture Diagram)

Web服务器支持和配置

第一个CGI程序 (First CGI Program)

你好Word！ 这是我的第一个CGI计划

HTTP标头

CGI环境变量 (CGI Environment Variables)

GET和POST方法 (GET and POST Methods)

使用GET方法传递信息

简单URL示例:获取方法

你好ZARA ALI

简单形式示例:GET方法

使用POST方法传递信息

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

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

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

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

在CGI中使用cookie (Using Cookies in CGI)

它是如何工作的 (How It Works?)

设置Cookies (Setting up Cookies)

检索Cookies (Retrieving Cookies)

文件上传示例

如何提高“文件下载”对话框？

你好Word！这是我的第一个CGI计划