什么是cgi
cgi 目前由ncsa维护,ncsa定义cgi如下:
cgi(common gateway interface),通用网关接口,它是一段程序,运行在服务器上如:http服务器,提供同客户端html页面的接口。
网页浏览
为了更好的了解cgi是如何工作的,我们可以从在网页上点击一个链接或url的流程:
1、使用你的浏览器访问url并连接到http web 服务器。
2、web服务器接收到请求信息后会解析url,并查找访问的文件在服务器上是否存在,如果存在返回文件的内容,否则返回错误信息。
3、浏览器从服务器上接收信息,并显示接收的文件或者错误信息。
cgi程序可以是python脚本,perl脚本,shell脚本,c或者c++程序等。
cgi架构图
web服务器支持及配置
在你进行cgi编程前,确保您的web服务器支持cgi及已经配置了cgi的处理程序。
所有的http服务器执行cgi程序都保存在一个预先配置的目录。这个目录被称为cgi目录,并按照惯例,它被命名为/var/www/cgi-bin目录。
cgi文件的扩展名为.cgi,python也可以使用.py扩展名。
默认情况下,linux服务器配置运行的cgi-bin目录中为/var/www。
如果你想指定其他运行cgi脚本的目录,可以修改httpd.conf配置文件,如下所示:
allowoverride none
options execcgi
order allow,deny
allow from all
options all
第一个cgi程序
我们使用python创建第一个cgi程序,文件名为hellp.py,文件位于/var/www/cgi-bin目录中,内容如下,修改文件的权限为755:
#!/usr/bin/python
print “content-type:text/html\r\n\r\n”
print ”
print ”
print ‘hello word – first cgi program’
print ”
print ”
print ‘hello word! this is my first cgi program’
print ”
print ”
以上程序在浏览器访问显示结果如下:
hello word! this is my first cgi program
这个的hello.py脚本是一个简单的python脚本,脚本第一的输出内容”content-type:text/html\r\n\r\n”发送到浏览器并告知浏览器显示的内容类型为”text/html”。
http头部
hello.py文件内容中的” content-type:text/html\r\n\r\n”即为http头部的一部分,它会发送给浏览器告诉浏览器文件的内容类型。
http头部的格式如下:
http 字段名: 字段内容
例如
content-type: text/html\r\n\r\n
以下表格介绍了cgi程序中http头部经常使用的信息:
头
描述
content-type: 请求的与实体对应的mime信息。例如: content-type:text/html
expires: date 响应过期的日期和时间
location: url 用来重定向接收方到非请求url的位置来完成请求或标识新的资源
last-modified: date 请求资源的最后修改时间
content-length: n 请求的内容长度
set-cookie: string 设置http cookie
cgi环境变量
所有的cgi程序都接收以下的环境变量,这些变量在cgi程序中发挥了重要的作用:
变量名
描述
content_type 这个环境变量的值指示所传递来的信息的mime类型。目前,环境变量content_type一般都是:application/x-www-form-urlencoded,他表示数据来自于html表单。
content_length 如果服务器与cgi程序信息的传递方式是post,这个环境变量即使从标准输入stdin中可以读到的有效数据的字节数。这个环境变量在读取所输入的数据时必须使用。
http_cookie 客户机内的 cookie 内容。
http_user_agent 提供包含了版本数或其他专有数据的客户浏览器信息。
path_info 这个环境变量的值表示紧接在cgi程序名之后的其他路径信息。它常常作为cgi程序的参数出现。
query_string 如果服务器与cgi程序信息的传递方式是get,这个环境变量的值即使所传递的信息。这个信息经跟在cgi程序名的后面,两者中间用一个问号’?’分隔。
remote_addr 这个环境变量的值是发送请求的客户机的ip地址,例如上面的192.168.1.67。这个值总是存在的。而且它是web客户机需要提供给web服务器的唯一标识,可以在cgi程序中用它来区分不同的web客户机。
remote_host 这个环境变量的值包含发送cgi请求的客户机的主机名。如果不支持你想查询,则无需定义此环境变量。
request_method 提供脚本被调用的方法。对于使用 http/1.0 协议的脚本,仅 get 和 post 有意义。
script_filename cgi脚本的完整路径
script_name cgi脚本的的名称
server_name 这是你的 web 服务器的主机名、别名或ip地址。
server_software 这个环境变量的值包含了调用cgi程序的http服务器的名称和版本号。例如,上面的值为apache/2.2.14(unix)
以下是一个简单的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方法
浏览器客户端通过两种方法向服务器传递信息,这两种方法就是 get 方法和 post 方法。
使用get方法传输数据
get方法发送编码后的用户信息到服务端,数据信息包含在请求页面的url上,以”?”号分割, 如下所示:
http://www.test.com/cgi-bin/hello.py?key1=value1&key2=value2
有关 get 请求的其他一些注释:
get 请求可被缓存
get 请求保留在浏览器历史记录中
get 请求可被收藏为书签
get 请求不应在处理敏感数据时使用
get 请求有长度限制
get 请求只应当用于取回数据
简单的url实例:get方法
以下是一个简单的url,使用get方法向hello_get.py程序发送两个参数:
/cgi-bin/hello_get.py?first_name=zara&last_name=ali
以下为hello_get.py文件的代码:
#!/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 – second cgi program”
print “”
print “”
print “hello %s %s” % (first_name, last_name)
print “”
print “”
浏览器请求输出结果:
hello zara ali
简单的表单实例:get方法
以下是一个通过html的表单使用get方法向服务器发送两个数据,提交的服务器脚本同样是hello_get.py文件,代码如下:
first name:
last name:
使用post方法传递数据
使用post方法向服务器传递数据是更安全可靠的,像一些敏感信息如用户密码等需要使用post传输数据。
以下同样是hello_get.py ,它也可以处理浏览器提交的post表单数据:
#!/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 – second cgi program”
print “”
print “”
print “hello %s %s” % (first_name, last_name)
print “”
print “”
以下为表单通过post方法向服务器脚本hello_get.py提交数据:
first name:
last name:
通过cgi程序传递checkbox数据
checkbox用于提交一个或者多个选项数据,html代码如下:
maths
physics
以下为 checkbox.cgi 文件的代码:
#!/usr/bin/python
# 引入 cgi 处理模块
import cgi, cgitb
# 创建 fieldstorage的实例
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 – third cgi program”
print “”
print “”
print ” checkbox maths is : %s” % math_flag
print ” checkbox physics is : %s” % physics_flag
print “”
print “”
通过cgi程序传递radio数据
radio只向服务器传递一个数据,html代码如下:
maths
physics
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 “”
print “”
print “radio – fourth cgi program”
print “”
print “”
print ” selected subject is %s” % subject
print “”
print “”
通过cgi程序传递 textarea 数据
textarea向服务器传递多行数据,html代码如下:
type your text here…
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 “”
print “”;
print “text area – fifth cgi program”
print “”
print “”
print ” entered text content is %s” % text_content
print “”
通过cgi程序传递下拉数据
html下拉框代码如下:
maths
physics
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 “”
print “”
print “dropdown box – sixth cgi program”
print “”
print “”
print ” selected subject is %s” % subject
print “”
print “”
cgi中使用cookie
在http协议一个很大的缺点就是不作用户身份的判断,这样给编程人员带来很大的不便,
而cookie功能的出现弥补了这个缺憾。
所有cookie就是在客户访问脚本的同时,通过客户的浏览器,在客户硬盘上写入纪录数据 ,当下次客户访问脚本时取回数据信息,从而达到身份判别的功能,cookie常用在密码判断中 。
cookie的语法
http cookie的发送是通过http头部来实现的,他早于文件的传递,头部set-cookie的语法如下:
set-cookie:name=name;expires=date;path=path;domain=domain;secure
name=name: 需要设置cookie的值(name不能使用”;”和”,”号),有多个name值时用”;”分隔例如:name1=name1;name2=name2;name3=name3。
expires=date: cookie的有效期限,格式: expires=”wdy,dd-mon-yyyy hh:mm:ss”
path=path: 设置cookie支持的路径,如果path是一个路径,则cookie对这个目录下的所有文件及子目录生效,例如: path=”/cgi-bin/”,如果path是一个文件,则cookie指对这个文件生效,例如:path=”/cgi-bin /cookie.cgi”。
domain=domain: 对cookie生效的域名,例如:domain=”www.chinalb.com”
secure: 如果给出此标志,表示cookie只能通过ssl协议的https服务器来传递。
cookie的接收是通过设置环境变量http_cookie来实现的,cgi程序可以通过检索该变量获取cookie信息。
cookie设置
cookie的设置非常简单,cookie会在http头部单独发送。以下实例在cookie中设置了userid 和 password:
#!/usr/bin/python
print “set-cookie:user
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.ziqiangxuetang.com;\r\n”
print “set-cookie:path=/perl;\n”
print “content-type:text/html\r\n\r\n”
………..rest of the html content….
以上实例使用了 set-cookie 头信息来设置cookie信息,可选项中设置了cookie的其他属性,如过期时间expires,域名domain,路径path。这些信息设置在 “content-type:text/html\r\n\r\n”之前。
检索cookie信息
cookie信息检索页非常简单,cookie信息存储在cgi的环境变量http_cookie中,存储格式如下:
key1=value1;key2=value2;key3=value3….
以下是一个简单的cgi检索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
以上脚本输出结果如下:
user id = xyz
password = xyz123
文件上传实例:
html设置上传文件的表单需要设置enctype 属性为multipart/form-data,代码如下所示:
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 = ‘the file “‘ + fn + ‘” was uploaded successfully’
else:
message = ‘no file was uploaded’
print “””\
content-type: text/html\n
%s
“”” % (message,)
如果你使用的系统是unix/linux,你必须替换文件分隔符,在window下只需要使用open()语句即可:
fn = os.path.basename(fileitem.filename.replace(“\\”, “/” ))
文件下载对话框
如果我们需要为用户提供文件下载链接,并在用户点击链接后弹出文件下载对话框,我们通过设置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”;
# actual file content will go hear.
fo = open(“foo.txt”, “rb”)
str = fo.read();
print str
# close opend file
fo.close()