Python CGI 编程

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

什么是 CGI？

通用网关接口 (CGI) 是外部网关程序与 HTTP 服务器等信息服务器接口的标准。
当前版本是 CGI/1.1，CGI/1.2 正在开发中。

网页浏览

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

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

但是，可以设置 HTTP 服务器，以便无论何时请求某个目录中的文件，该文件都不会被发回；相反，它作为一个程序执行，并且该程序输出的任何内容都会发送回你的浏览器以显示。此功能称为通用网关接口或 CGI，程序称为 CGI 脚本。这些 CGI 程序可以是 Python 脚本、PERL 脚本、Shell 脚本、C 或 C++ 程序等。

CGI 架构图

Web 服务器支持和配置

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

默认情况下，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 服务器，并且你能够运行任何其他 CGI 程序，如 Perl 或 Shell 等。

第一个 CGI 程序

这是一个简单的链接，它链接到一个名为 hello.py .该文件保存在 /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 World - First CGI Program</title>'
print '</head>'
print '<body>'
print '<h2>Hello World! This is my first CGI program</h2>'
print '</body>'
print '</html>'

如果单击 hello.py，则会产生以下输出：

你好世界！这是我的第一个 CGI 程序

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

至此，你一定已经了解了 CGI 的基本概念，并且可以使用 Python 编写许多复杂的 CGI 程序。该脚本还可以与任何其他外部系统交互以交换信息，例如 RDBMS。

HTTP 标头

The line 内容类型：文本/html\r\n\r\n 是发送到浏览器以了解内容的 HTTP 标头的一部分。所有的 HTTP 标头都将采用以下形式：

HTTP Field Name: Field Content

For 例子
Content-type: text/html\r\n\r\n

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

序号.	标题和说明
1	内容类型：定义返回文件格式的 MIME 字符串。示例是 Content-type:text/html
2	过期：日期信息失效的日期。浏览器使用它来决定何时需要刷新页面。有效日期字符串的格式为 01 Jan 1998 12:00:00 GMT。
3	地点：网址返回的 URL，而不是请求的 URL。你可以使用此字段将请求重定向到任何文件。
4	最后修改：日期上次修改资源的日期。
5	内容长度：N 返回的数据的长度(以字节为单位)。浏览器使用此值报告文件的估计下载时间。
6	设置 Cookie：字符串设置通过的cookie string

CGI 环境变量

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

序号.	变量名称和描述
1	内容类型内容的数据类型。当客户端向服务器发送附加内容时使用。例如，文件上传。
2	CONTENT_LENGTH 查询信息的长度。它仅适用于 POST 请求。
3	HTTP_COOKIE 以键值对的形式返回设置的 cookie。
4	HTTP_USER_AGENT User-Agent request-header 字段包含有关发起请求的用户代理的信息。它是 Web 浏览器的名称。
5	PATH_INFO CGI 脚本的路径。
6	请求参数使用 GET 方法请求发送的 URL 编码信息。
7	远程地址发出请求的远程主机的 IP 地址。这对于日志记录或身份验证很有用。
8	远程主机发出请求的主机的完全限定名称。如果此信息不可用，则可以使用 REMOTE_ADDR 获取 IR 地址。
9	REQUEST_METHOD 用于发出请求的方法。最常用的方法是 GET 和 POST。
10	SCRIPT_FILENAME CGI 脚本的完整路径。
11	SCRIPT_NAME CGI 脚本的名称。
12	服务器名称服务器的主机名或 IP 地址
13	服务器软件服务器正在运行的软件的名称和版本。

这是列出所有 CGI 变量的小型 CGI 程序。点击此链接查看结果获取环境

#!/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 方法

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

使用 GET 方法传递信息

GET 方法发送附加到页面请求的编码用户信息。页面和编码信息由 ? 分隔。字符如下：

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

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

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

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

简单的 URL 示例：Get 方法

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

/cgi-bin/hello_get.py?first_name=ZARA&last_name=ALI

Below is 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 阿里

简单的FORM例子：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 脚本。

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

#!/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 脚本：

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

这段代码的结果如下表：

下面是处理 Web 浏览器输入的 dropdown.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('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

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

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

这个怎么运作？

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

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

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

设置 Cookie

将 cookie 发送到浏览器非常容易。这些 cookie 与 HTTP Header 一起发送到 Content-type 字段。假设你要将 UserID 和 Password 设置为 cookie。设置cookies如下：

#!/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 23Web 服务器支持和配置40 GMT";\r\n"
print "Set-Cookie:Domain = www.newbiego.com;\r\n"
print "Set-Cookie:Path = /perl;\n"
print "Content-type:text/html\r\n\r\n"
...........Rest of the HTML Content....

从这个例子中，你一定已经了解了如何设置 cookie。我们用 设置Cookie 用于设置 cookie 的 HTTP 标头。

设置 cookie 属性(如 Expires、Domain 和 Path)是可选的。值得注意的是，cookie是在发送魔术线之前设置的 "内容类型：文本/html\r\n\r\n .

检索 Cookie

检索所有设置的 cookie 非常容易。 Cookies 存储在 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 属性设置为 多部分/表单数据 .具有文件类型的输入标签会创建一个“浏览”按钮。

<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>

这段代码的结果如下表：

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

这是脚本 保存文件.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 "Content-Type:application/octet-stream; name = \"FileName\"\r\n";
print "Content-Disposition: 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()

希望你喜欢本教程。如果是，请将你的反馈发送至：联系我们

< 上一篇（Python 正则表达式）

下一篇（Python MySQL 数据库访问） >

Python教程

Python进阶

Python CGI 编程

什么是 CGI？

网页浏览

CGI 架构图

Web 服务器支持和配置

第一个 CGI 程序

你好世界！这是我的第一个 CGI 程序

HTTP 标头

CGI 环境变量

GET 和 POST 方法

使用 GET 方法传递信息

简单的 URL 示例：Get 方法

你好 ZARA 阿里

简单的FORM例子：GET方法

使用 POST 方法传递信息

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

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

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

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

在 CGI 中使用 Cookie

这个怎么运作？

设置 Cookie

检索 Cookie

文件上传示例

如何弹出“文件下载”对话框？