http://www.yiibai.com/python/python_cgi_programming.html
公共网关接口或CGI,Web服务器和一个自定义的脚本之间交换信息是是一组定义的标准..
CGI规范在由NCSA和NCSA定义的CGI保持如下:
公共网关接口或CGI,如HTTP服务器信息服务器的标准接口是外部网关方案.
当前版本CGI/1.1和CGI/1.2.
理解CGI的概念,让我们看看会发生什么,当我们点击一个超链接到浏览特定网页或URL.
您的浏览器触点的HTTP Web服务器,即需求的URL ie.文件名.
Web服务器解析URL,如果发现该文件,然后发送回浏览器,否则发送错误消息表明您已经请求一个错误的文件.
Web浏览器从Web服务器的响应,并显示收到的文件或错误消息.
但是,它可能设立的HTTP服务器,因此,只要在某个目录中的文件被请求文件送回,而是作为一个程序执行,任何方案产出发送您的浏览器来显示。这个函数被调用的通用网关接口或CGI程序称为CGI脚本。这些CGI程序可以是一个Python脚本,Perl脚本,shell脚本,C或C+ +程序等.
进行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 allOptions All
在这里,我假设你有Web服务器,并成功运行,你可以运行任何其他CGI程序像Perl或shell等.
下面是一个简单的链接,链接到CGI脚本名为hello.py。此文件被保存在/var/www/cgi-bin目录,它有以下内容。运行CGI程序之前,确保你有CHAGE模式使用 UNIX命令chmod命令 755 hello.py,使文件的可执行文件.
#!/usr/bin/python print "Content-type:text/html\r\n\r\n" print '' print '' print 'Hello Word - First CGI Program' print '' print '' print '
如果你点击hello.py然后,这将产生以下输出:
Hello Word! This is my first CGI program |
这个的hello.py脚本是一个简单的Python脚本,这是写在stdout文件,即它的输出浏览器的屏幕。有一个重要的和额外的功能,这是第一行要打印的内容类型:文本/html\R\N\R\N。此行被发送回浏览器,并指定内容类型的浏览器屏幕上显示。现在,你必须理解CGI的基本概念,可以使用Python写了许多复杂的CGI程序。这个脚本可以与任何其他扩展系统交换,如RDBMS的信息.
该行的内容类型:文本/html\R\N\R\n是理解的内容被发送到浏览器的HTTP头的一部分。所有的HTTP报头,将在下列表格
HTTP Field Name: Field Content For Example Content-type: text/html\r\n\r\n
还有其他一些重要的HTTP头,你会经常使用的CGI编程.
Header | Description |
---|---|
Content-type: | A MIME string defining the format of the file being returned. Example is Content-type:text/html |
Expires: Date | The date the information becomes invalid. This should be used by the browser to decide when a page needs to be refreshed. A valid date string should be in the format 01 Jan 1998 12:00:00 GMT. |
Location: URL | The URL that should be returned instead of the URL requested. You can use this filed to redirect a request to any file. |
Last-modified: Date | The date of last modification of the resource. |
Content-length: N | The length, in bytes, of the data being returned. The browser uses this value to report the estimated download time for a file. |
Set-Cookie: String | Set the cookie passed through the string |
所有的CGI程序,将有机会获得以下环境变量。编写任何CGI程序,这些变量发挥了重要作用.
Variable Name | Description |
CONTENT_TYPE | The data type of the content. Used when the client is sending attached content to the server. For example file upload etc. |
CONTENT_LENGTH | The length of the query information. It's available only for POST requests |
HTTP_COOKIE | Return the set cookies in the form of key & value pair. |
HTTP_USER_AGENT | The User-Agent request-header field contains information about the user agent originating the request. Its name of the web browser. |
PATH_INFO | The path for the CGI script. |
QUERY_STRING | The URL-encoded information that is sent with GET method request. |
REMOTE_ADDR | The IP address of the remote host making the request. This can be useful for logging or for authentication purpose. |
REMOTE_HOST | The fully qualified name of the host making the request. If this information is not available then REMOTE_ADDR can be used to get IR address. |
REQUEST_METHOD | The method used to make the request. The most common methods are GET and POST. |
SCRIPT_FILENAME | The full path to the CGI script. |
SCRIPT_NAME | The name of the CGI script. |
SERVER_NAME | The server's hostname or IP Address |
SERVER_SOFTWARE | The name and version of the software the server is running. |
这里是小的CGI程序列出所有的CGI变量。
#!/usr/bin/python import os print "Content-type: text/html\r\n\r\n"; print "Environment<\br>"; for param in os.environ.keys(): print "%20s: %s<\br>" % (param,os.environ[param])
你所遇到的许多情况下,当您需要从您的浏览器,Web服务器,并最终给你的CGI程序传递一些信息。最常用的浏览器使用两种方法将此信息传递到Web服务器。这些方法是GET方法和POST方法.
GET方法发送编码的用户信息添加到页面请求。分隔页和编码信息?字符作为如下:
http://www.test.com/cgi-bin/hello.py?key1=value1&key2=value2
GET方法是defualt从浏览器向Web服务器的方法来传递信息,它会产生一个很长的字符串出现在浏览器的位置:框。切勿使用GET方法,如果你有密码或其他敏感信息传递给服务器。 GET方法尺寸limtation:只有1024个字符,可以在请求字符串.
此信息通过使用QUERY_STRING的头,将通过QUERY_STRING环境变量在你的CGI程序访问
你可以通过简单的连接键和值对非常久远的任何URL的信息,或您可以使用HTML标签来传递信息,使用GET方法.
这里是一个简单的URL使用GET方法,这将通过两个值hello_get.py方案.
下面是hello_get.py的脚本来处理给定的输入网页浏览器。我们要使用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 "" print "" print "Hello - Second CGI Program" print "" print "" print "
This would generate following result:
Hello ZARA ALI |
下面是一个简单的例子,通过这两个值,使用HTML表单和提交按钮。我们将使用相同的CGI脚本hello_get.py的处理此输入.
First Name:Last Name:
这里是上述形式的实际输出,输入第一个和最后一个名称,然后点击提交按钮来查看结果.
更可靠的信息传递给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 "" print "" print "Hello - Second CGI Program" print "" print "" print "
让我们再次看同以上相同的例子,其中通过两个值,使用HTML表单和提交按钮。我们将使用相同的CGI脚本hello_get.py的处理此输入.
First Name:Last Name:
这里是上述形式的实际输出,输入第一个和最后一个名称,然后点击提交按钮来查看结果.
复选框用于多个选项被选中时,.
这里有两个复选框的形式例如HTML代码
Maths Physics
这段代码的结果是下面的形式
Maths Physics下面是checkbox.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('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 "
单选按钮被选中时,只有一个选项是必需的.
这里是两个单选按钮的形式例如HTML代码:
MathsPhysics
这段代码的结果是下面的形式
Maths Physics 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:="" print="" "content-type:text="" html\r\n\r\n"="" ""="" "radio="" -="" fourth="" cgi="" program"="" "Selected Subject is %s" % subject print "" print ""="">
TEXTAREA元素时使用多行文字要传递给CGI程序.
这里是一个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 "
下拉框是用来当我们有很多可供选择,但只有一个或两个将被选中.
这里是一个下拉框的例子表单的HTML代码
MathsPhysics
这段代码的结果是下面的形式
下面是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 "
HTTP协议是无状态的协议。但是,对于一个商业网站,它需要保持不同的页面之间的会话信息。例如,一个用户注册完成后,许多网页结束。但如何保持用户会话信息的所有网页.
在许多情况下,使用Cookie的记忆和跟踪首选项,购买,佣金,其他更好的游客体验或网站统计所需的信息是最有效的方法.
你的服务器发送一些数据到访问者的浏览器Cookie的形式。浏览器可以接受的cookie。如果是这样,它是作为一个访问者的硬盘驱动器上的纯文本记录存储。现在,当游客到达另一个网站上的网页,cookie是用于检索。一旦检索,您的服务器知道/记得存储.
Cookie是一个纯文本的数据5可变长度字段记录:
Expires : cookie将到期日期。如果是空白,访问者退出浏览器时,cookie将到期.
Domain : 您的网站域名.
Path : 目录或网页设置cookie的路径。这可能是空白的,如果你想从任何目录或页面的cookie检索.
Secure : 目录或网页设置cookie的路径。这可能是空白的,如果你想从任何目录或页面的cookie检索.
Name=Value : Cookies是键和值对的形式设置和retrviewed.
这是很容易发送到浏览器的cookies。这些cookie将被发送HTTP头之前的内容类型提交。假设你要设置用户名和密码的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.yiibai.com;\r\n" print "Set-Cookie:Path=/perl;\n" print "Content-type:text/html\r\n\r\n" ...........Rest of the HTML Content....
从这个例子中,你必须了解如何设置Cookie。我们使用设置CookieHTTP的头设置Cookie.
在这里,它是可选的设置Cookie的属性,如过期,域和路径。值得注意的是,Cookie的之前发送行头 "Content-type:text/html\r\n\r\n.
这是非常方便地检索所有的设置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-数据。与该文件类型的输入标记将创建一个“浏览”按钮.
File:
这段代码的结果是下面的形式:
注: 上面的例子已被禁用,故意人上传的文件保存在我们的服务器上。但你可以尝试上面的代码与您的服务器.
这里是处理文件上传的的脚本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
%s
""" % (message,)Note:如果你是以上脚本运行在Unix / Linux,那么你会采取如下替换文件分隔,否则您的Windows上述open()语句应该正常工作.
fn = os.path.basename(fileitem.filename.replace("\\", "/" ))
有时你想给其中一个用户点击一个链接,它会弹出“文件下载”对话框的用户,而不是显示实际内容的选项。这是很容易的,将通过HTTP头achived。
这个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()