Python CGI程式设计

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

什么是CGI？

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

网页浏览

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

你的浏览器联系HTTP Web服务器并要求提供URL(即文件名)。
Web Server解析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 Server，并且能够运行任何其他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文件(即屏幕)上。有一个重要的额外功能可用，即要打印的第一行 内容类型：text / html \ r \ n \ r \ n 。该行发送回浏览器，并指定要在浏览器屏幕上显示的内容类型。

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

HTTP头

The line 内容类型：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编程中经常使用这些标头。

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

CGI环境变量

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

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

这是一个小的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：框中。如果你有密码或其他敏感信息要传递到服务器，请不要使用GET方法。 GET方法具有大小限制：在请求字符串中只能发送1024个字符。 GET方法使用QUERY_STRING标头发送信息，并且可以通过QUERY_STRING环境变量在CGI程序中进行访问。

你可以通过简单地将键和值对与任何URL串联来传递信息，也可以使用HTML

标记使用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 ALI

简单的FORM示例：GET方法

本示例使用HTML FORM和Submit按钮传递两个值。我们使用相同的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方法完全相同的方式打包信息，但不是在？之后将其作为文本字符串发送。在网址中将其作为单独的消息发送。该消息以标准输入的形式进入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和Submit按钮传递两个值。我们使用相同的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脚本，用于处理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('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

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

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

这个怎么运作？

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

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

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

设置Cookie

将cookie发送到浏览器非常容易。这些cookie与HTTP标头一起发送到Content-type字段。假设你要将UserID和Password设置为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 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。我们用 Set-Cookie 设置cookie的HTTP标头。

可以选择设置cookie属性，例如Expires，Domain和Path。值得注意的是，在发送魔术行之前已设置cookie “内容类型：text / 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>

该代码的结果为以下形式：

上面的示例已被有意地禁用，以防止人们在我们的服务器上上传文件，但是你可以在服务器上尝试上述代码。

这是脚本 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 "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数据库访问） >

Python2 教程

Python2 进阶

Python CGI程式设计

什么是CGI？

网页浏览

CGI架构图

Web服务器支持和配置

第一个CGI程序

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

HTTP头

CGI环境变量

GET和POST方法

使用GET方法传递信息

简单网址示例：获取方法

你好ZARA ALI

简单的FORM示例：GET方法

使用POST方法传递信息

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

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

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

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

在CGI中使用Cookie

这个怎么运作？

设置Cookie

检索Cookie

文件上传示例

如何引发“文件下载”对话框？