通用网关接口(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++程序等。
三、Web服务器支持和配置
在继续进行CGI编程之前,请确保你的Web服务器支持CGI,并将其配置为处理CGI程序。HTTP服务器要执行的所有CGI程序都保存在预先配置的目录中。这个目录被称为CGI目录,按照惯例它被命名为/var/www/ CGI –bin,按照惯例,CGI文件的扩展名为,但是你也可以用python扩展名.py来保存你的文件。
默认情况下,Linux服务器被配置为只运行/var/www.中的cgi-bin目录中的脚本如果希望指定任何其他目录来运行CGI脚本,请在httpd.conf文件中注释以下几行:
AllowOverride None
Options ExecCGI
Order allow,deny
Allow from all
Options All
在这里,我们假设你已经成功地启动并运行了Web服务器,并且能够运行任何其他CGI程序,如Perl或Shell等。
四、第一个CGI程序
下面是一个简单的链接,它链接到一个名为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 ''
print '
'print '
Hello Word - CGI编程'print ''
print '
'print '
Hello Word! 这是CGI编程
'print ''
print ''
这个hello.py脚本是一个简单的Python脚本,它将输出写入STDOUT文件。有一个重要且额外的特性可用,它是要打印内容类型的第一行:text/html\r\n\r\n。这一行被发送回浏览器,并指定要在浏览器屏幕上显示的内容类型。
到目前为止,你必须理解CGI的基本概念,你可以用Python编写许多复杂的CGI程序。此脚本还可以与任何其他外部系统交互以交换信息,如RDBMS。
五、HTTP报头
行内容类型: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编程中使用它们。
编号报头和说明
1Content-type:
定义要返回的文件格式的MIME字符串。例子是的content – type: text / html
2Expires: Date
信息无效的日期。浏览器使用它来决定何时需要刷新页面。有效的日期字符串格式为1998年1月01日12:00:00 GMT。
3Location: URL
返回的URL而不是请求的URL。可以使用此字段将请求重定向到任何文件。
4Last-modified: Date
资源最后一次修改的日期。
5Content-length: N
返回数据的长度,以字节为单位。浏览器使用此值报告文件的估计下载时间。
6Set-Cookie: String
设置通过字符串传递的cookie
六、CGI环境变量
所有CGI程序都可以访问以下环境变量,这些变量在编写任何CGI程序时都扮演着重要的角色。
编号变量名和描述
1CONTENT_TYPE
内容的数据类型,当客户机向服务器发送附加内容时使用,例如文件上传。
2CONTENT_LENGTH
查询信息的长度,它只对POST请求可用。
3HTTP_COOKIE
以键值对的形式返回设置的cookie。
4HTTP_USER_AGENT
user-agent请求头字段包含关于发起请求的用户代理的信息,它是web浏览器的名称。
5PATH_INFO
CGI脚本的路径。
6QUERY_STRING
与GET方法请求一起发送的url编码的信息。
7REMOTE_ADDR
发出请求的远程主机的IP地址,这对于日志记录或身份验证非常有用。
8REMOTE_HOST
发出请求的主机的完全限定名。如果此信息不可用,则可以使用REMOTE_ADDR获取IR地址。
9REQUEST_METHOD
用于发出请求的方法,最常见的方法是GET和POST。
10SCRIPT_FILENAME
CGI脚本的完整路径。
11SCRIPT_NAME
CGI脚本的名称。
12SERVER_NAME
服务器的主机名或IP地址
13SERVER_SOFTWARE
服务器正在运行的软件的名称和版本。
这里是一个小的CGI程序,列出了所有的CGI变量,单击此链接以查看结果获取环境:
#!/usr/bin/python
import os
print "Content-type: text/html\r\n\r\n";
print "Environment";
for param in os.environ.keys():
print "%20s: %s" % (param, os.environ[param])
七、GET和POST方法
当你需要将一些信息从浏览器传递到web服务器并最终传递到CGI程序时,你一定遇到过许多情况。最常见的情况是,浏览器使用两个方法将此信息传递给web服务器,这些方法是GET方法和POST方法。
1、使用GET方法传递信息
GET方法发送附加到页面请求的编码用户信息,页面和编码信息之间用?字符如下-
http://www.test.com/cgi-bin/hello.py?key1=value1&key2=value2
GET方法是将信息从浏览器传递到web服务器的默认方法,它生成一个长字符串,显示在浏览器的位置:框中。如果你有密码或其他敏感信息要传递给服务器,请不要使用GET方法。GET方法有大小限制:在一个请求字符串中只能发送1024个字符。GET方法使用QUERY_STRING报头发送信息,并且可以通过QUERY_STRING环境变量在CGI程序中访问。
你可以通过简单地连接键和值对以及任何URL来传递信息,或者你可以使用HTML
标记来使用GET方法传递信息。2、简单的URL示例:Get方法
下面是一个简单的URL,它使用GET方法将两个值传递给hello_get.py程序。
下面是处理web浏览器提供的输入的hello_get.py脚本,我们将使用cgi模块,这使它非常容易访问传递的信息
#!/usr/bin/python
# 导入模块用于CGI处理
import cgi, cgitb
# 创建FieldStorage实例
form = cgi.FieldStorage()
# 获取数据
first_name = form.getvalue('first_name')
last_name = form.getvalue('last_name')
print "Content-type:text/html\r\n\r\n"
print ""
print "
"print "
Hello - CGI程序"print ""
print "
"print "
Hello %s %s
" % (first_name, last_name)print ""
print ""
3、简单的表单示例:GET方法
本例使用HTML表单和submit按钮传递两个值,我们使用相同的CGI脚本hello_get.py来处理这个输入。
First Name:
Last Name:
4、使用POST方法传递信息
传递信息给CGI程序的一种更可靠的方法是POST方法。它以与GET方法完全相同的方式打包信息,而不是将其作为文本字符串发送到?在URL中,它将其作为单独的消息发送,此消息以标准输入的形式进入CGI脚本。
下面是相同的hello_get.py脚本,它处理GET和POST方法。
#!/usr/bin/python
import cgi, cgitb
form = cgi.FieldStorage()
first_name = form.getvalue('first_name')
last_name = form.getvalue('last_name')
print "Content-type:text/html\r\n\r\n"
print ""
print "
"print "
Hello - CGI程序"print ""
print "
"print "
Hello %s %s
" % (first_name, last_name)print ""
print ""
让我们再举一个与上面相同的例子,它使用HTML表单和submit按钮传递两个值。我们使用相同的CGI脚本hello_get.py来处理这个输入。
First Name:
Last Name:
5、将复选框数据传递给CGI程序
当需要选择多个选项时,将使用复选框。
下面是带有两个复选框的表单的HTML代码示例
Maths
Physics
下面是checkbox.cgi脚本,用于处理web浏览器为复选框按钮提供的输入。
#!/usr/bin/python
import cgi, cgitb
form = cgi.FieldStorage()
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 ""
print "
"print "
Checkbox – CGI程序"print ""
print "
"print "
CheckBox Maths is : %s
" % math_flagprint "
CheckBox Physics is : %s
" % physics_flagprint ""
print ""
6、将单选按钮数据传递给CGI程序
当只需要选择一个选项时,使用单选按钮。
下面是带有两个单选按钮的表单的HTML代码示例
Maths
Physics
下面是radiobutton.py脚本,用于处理web浏览器为单选按钮提供的输入
#!/usr/bin/python
import cgi, cgitb
form = cgi.FieldStorage()
if form.getvalue('subject'):
subject = form.getvalue('subject')
else:
subject = "Not set"
print "Content-type:text/html\r\n\r\n"
print ""
print "
"print "
Radio – CGI程序"print ""
print "
"print "
Selected Subject is %s
" % subjectprint ""
print ""
7、将文本区域数据传递给CGI程序
当必须将多行文本传递给CGI程序时,将使用TEXTAREA元素。
下面是带有文本框的表单的HTML代码示例
输入文本...
下面是textarea.cgi脚本处理输入的网页浏览器
#!/usr/bin/python
import cgi, cgitb
form = cgi.FieldStorage()
if form.getvalue('textcontent'):
text_content = form.getvalue('textcontent')
else:
text_content = "无输入"
print "Content-type:text/html\r\n\r\n"
print ""
print "
";print "
Text Area – CGI程序"print ""
print "
"print "
输入内容为 %s
" % text_contentprint ""
8、将下拉框数据传递给CGI程序
下拉框用于当我们有许多可用的选项,但只有一个或两个将被选中。
下面是带有一个下拉框的表单的HTML代码示例
Maths
Physics
下面是处理web浏览器提供的输入的dropdown.py脚本。
#!/usr/bin/python
import cgi, cgitb
form = cgi.FieldStorage()
if form.getvalue('dropdown'):
subject = form.getvalue('dropdown')
else:
subject = "无输入"
print "Content-type:text/html\r\n\r\n"
print ""
print "
"print "
Dropdown Box – CGI程序"print ""
print "
"print "
Selected Subject is %s
" % subjectprint ""
print ""
八、在CGI中使用cookie
HTTP协议是一种无状态协议,对于商业网站,需要维护不同页面之间的会话信息。例如一个用户注册在完成多个页面后结束,如何跨所有web页面维护用户的会话信息呢?
在许多情况下,使用cookie是记忆和跟踪偏好、购买、佣金和其他信息的最有效方法,这些信息是更好的访问者体验或站点统计所必需的。
1、它是如何工作的?
你的服务器以cookie的形式向访问者的浏览器发送一些数据,浏览器可能接受cookie,如果是,它将作为纯文本记录存储在访问者的硬盘上。现在当访问者到达站点的另一个页面时,cookie就可以进行检索了,一旦检索,你的服务器知道/记得存储了什么。
cookie是5个可变长度字段的纯文本数据记录:
Expires—cookie过期的日期。如果这是空白的,当访问者退出浏览器时cookie将过期。
domain域名——网站的域名。
path路径——设置cookie的目录或网页的路径。如果你想从任何目录或页面检索cookie,这可能是空的。
secure安全——如果该字段包含“安全”一词,则只能通过安全服务器检索cookie。如果此字段为空,则不存在此类限制。
Name=Value−cookie以键和值对的形式设置和检索。
2、设置cookie
将cookies发送到浏览器非常容易。这些cookie与HTTP头一起发送到Content-type字段。假设你希望将用户id和密码设置为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-2030 02:10:38 GMT";\r\n"
print "Set-Cookie:Domain = www.srcmini.com;\r\n"
print "Set-Cookie:Path = /perl;\n"
print "Content-type:text/html\r\n\r\n"
...........HTML Content....
从这个例子中,你一定了解了如何设置cookie,我们使用set – cookie HTTP头来设置cookie。
可以选择设置cookie属性,如Expires、Domain和Path。值得注意的是,cookie是在发送“Content-type:text/html\r\n\r\n”之前设置的。
3、获取cookie
获取所有设置的cookie非常容易,cookie存储在CGI环境变量HTTP_COOKIE中,它们将具有以下形式
key1 = value1;key2 = value2;key3 = value3....
下面是一个如何检索cookie的示例。
#!/usr/bin/python
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
九、文件上传的例子
要上载文件,HTML表单必须将enctype属性设置为multipart/form-data,文件类型的输入标签创建了一个“Browse”按钮。
action = "save_file.py" method = "post">
File:
上面的例子已经被故意禁用,以保存人们上传的文件在我们的服务器,但你可以尝试以上代码与你的服务器。
下面是处理文件上传的脚本save_file.py
#!/usr/bin/python
import cgi, os
import cgitb; cgitb.enable()
form = cgi.FieldStorage()
fileitem = form['filename']
if fileitem.filename:
fn = os.path.basename(fileitem.filename)
open('/tmp/' + fn, 'wb').write(fileitem.file.read())
message = '文件 "' + fn + '" 成功上传!'
else:
message = '无文件'
print """\
Content-Type: text/html\n
%s
""" % (message,)
如果你在Unix/Linux上运行上面的脚本,那么你需要像下面这样替换文件分隔符,否则在你的windows机器上open()语句应该可以正常工作。
fn = os.path.basename(fileitem.filename.replace("\", "/" ))
1、如何启动“文件下载”对话框?
有时你需要给用户一个选项,用户可以点击一个链接,它会弹出一个“文件下载”对话框,而不是显示实际的内容。这是非常容易的,可以通过HTTP头实现,此HTTP标头与前一节中提到的标头不同。
例如如果你想要使一个文件名文件可从给定链接下载,那么它的语法如下
#!/usr/bin/python
# HTTP Header
print "Content-Type:application/octet-stream; name = \"FileName\"\r\n";
print "Content-Disposition: attachment; filename = \"FileName\"\r\n\n";
# 实际文件内容.
fo = open("foo.txt", "rb")
str = fo.read();
print str
# 关闭文件
fo.close()