Python CGI編程

CGI(Common Gateway Interface) 即通用網(wǎng)關(guān)接口，它是運(yùn)行在服務(wù)器的一段程序，提供 Web 服務(wù)。

1. 網(wǎng)頁瀏覽

為了更好的了解 CGI 是如何工作的，我們可以從在網(wǎng)頁上點(diǎn)擊一個(gè)鏈接或 URL 的流程：

• 1、使用你的瀏覽器訪問 URL 并連接到 HTTP web 服務(wù)器。
• 2、Web 服務(wù)器接收到請求信息后會解析 URL，并查找訪問的文件在服務(wù)器上是否存在，如果存在返回文件的內(nèi)容，否則返回錯(cuò)誤信息。
• 3、瀏覽器從服務(wù)器上接收信息，并顯示接收的文件或者錯(cuò)誤信息。

CGI 程序可以是 Python 腳本，PERL 腳本，SHELL 腳本，C 或者 C++ 程序等。

2. CGI架構(gòu)圖

3. Web 服務(wù)器支持及配置

在你進(jìn)行 CGI 編程前，確保您的 Web 服務(wù)器支持 CGI 及已經(jīng)配置了 CGI 的處理程序。

Apache 支持 CGI 配置：

設(shè)置好CGI目錄：

ScriptAlias /cgi-bin/ /var/www/cgi-bin/

所有的HTTP服務(wù)器執(zhí)行 CGI 程序都保存在一個(gè)預(yù)先配置的目錄。這個(gè)目錄被稱為 CGI 目錄，并按照慣例，它被命名為 /var/www/cgi-bin 目錄。

CGI 文件的擴(kuò)展名為 .cgi，python 也可以使用 .py 擴(kuò)展名。

默認(rèn)情況下，Linux 服務(wù)器配置運(yùn)行的 cgi-bin 目錄中為 /var/www。

如果你想指定其他運(yùn)行 CGI 腳本的目錄，可以修改 httpd.conf 配置文件，如下所示：

<directory "="" var="" www="" cgi-bin"="">
   AllowOverride None
   Options +ExecCGI
   Order allow,deny
   Allow from all</directory>

在 AddHandler 中添加 .py 后綴，這樣我們就可以訪問 .py 結(jié)尾的 python 腳本文件：

AddHandler cgi-script .cgi .pl .py

4. 第一個(gè)CGI程序

我們使用 Python 創(chuàng)建第一個(gè) CGI 程序，文件名為 hello.py，文件位于 /var/www/cgi-bin 目錄中，內(nèi)容如下：

#!/usr/bin/python
# -*- coding: UTF-8 -*-

print "Content-type:text/html"
print                               # 空行，告訴服務(wù)器結(jié)束頭部
print ''
print ''
print '<meta charset="utf-8">'
print '<title>Hello World - 我的第一個(gè) CGI 程序！</title>'
print ''
print ''
print '<h2>Hello World! 我是來自碩編程的第一CGI程序</h2>
'
print ''
print ''

文件保存后修改 hello.py，修改文件權(quán)限為 755：

chmod 755 hello.py 

以上程序在瀏覽器訪問 http://localhost/cgi-bin/hello.py 顯示結(jié)果如下：

Hello World! 我是來自碩編程的第一CGI程序

這個(gè)的hello.py腳本是一個(gè)簡單的Python腳本，腳本第一行的輸出內(nèi)容"Content-type:text/html"發(fā)送到瀏覽器并告知瀏覽器顯示的內(nèi)容類型為"text/html"。

用 print 輸出一個(gè)空行用于告訴服務(wù)器結(jié)束頭部信息。

5. HTTP頭部

hello.py文件內(nèi)容中的" Content-type:text/html"即為HTTP頭部的一部分，它會發(fā)送給瀏覽器告訴瀏覽器文件的內(nèi)容類型。

HTTP頭部的格式如下：

HTTP 字段名: 字段內(nèi)容

例如：

Content-type: text/html

以下表格介紹了CGI程序中HTTP頭部經(jīng)常使用的信息：

6. CGI環(huán)境變量

所有的CGI程序都接收以下的環(huán)境變量，這些變量在CGI程序中發(fā)揮了重要的作用：

以下是一個(gè)簡單的CGI腳本輸出CGI的環(huán)境變量：

#!/usr/bin/python
# -*- coding: UTF-8 -*-
# filename:test.py

import os

print "Content-type: text/html"
print
print "<meta charset="\"utf-8\"">"
print "<b>環(huán)境變量</b> ";
print "<ul>"
for key in os.environ.keys():
    print "<li>%30s  : %s </li>
" % (key,os.environ[key])
print "</ul>
"

將以上點(diǎn)保存為 test.py ,并修改文件權(quán)限為 755，執(zhí)行結(jié)果如下：

7. GET和POST方法

瀏覽器客戶端通過兩種方法向服務(wù)器傳遞信息，這兩種方法就是 GET 方法和 POST 方法。

1) 使用GET方法傳輸數(shù)據(jù)

GET方法發(fā)送編碼后的用戶信息到服務(wù)端，數(shù)據(jù)信息包含在請求頁面的URL上，以"?"號分割, 如下所示：

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

• GET 請求可被緩存
• GET 請求保留在瀏覽器歷史記錄中
• GET 請求可被收藏為書簽
• GET 請求不應(yīng)在處理敏感數(shù)據(jù)時(shí)使用
• GET 請求有長度限制
• GET 請求只應(yīng)當(dāng)用于取回?cái)?shù)據(jù)

2) 簡單的url實(shí)例：GET方法

以下是一個(gè)簡單的URL，使用GET方法向hello_get.py程序發(fā)送兩個(gè)參數(shù)：

/cgi-bin/test.py?name=碩編程&url=http://

以下為hello_get.py文件的代碼：

#!/usr/bin/python
# -*- coding: UTF-8 -*-

# filename：test.py

# CGI處理模塊
import cgi, cgitb 

# 創(chuàng)建 FieldStorage 的實(shí)例化
form = cgi.FieldStorage() 

# 獲取數(shù)據(jù)
site_name = form.getvalue('name')
site_url  = form.getvalue('url')

print "Content-type:text/html"
print
print ""
print ""
print "<meta charset="\"utf-8\"">"
print "<title>碩編程 CGI 測試實(shí)例</title>"
print ""
print ""
print "<h2>%s官網(wǎng)：%s</h2>
" % (site_name, site_url)
print ""
print ""

文件保存后修改 hello_get.py，修改文件權(quán)限為 755：

chmod 755 hello_get.py 

3） 簡單的表單實(shí)例：GET方法

以下是一個(gè)通過HTML的表單使用GET方法向服務(wù)器發(fā)送兩個(gè)數(shù)據(jù)，提交的服務(wù)器腳本同樣是hello_get.py文件，hello_get.html 代碼如下：

 <meta charset="utf-8"> <title>碩編程(yapf.com)</title> <form action="/cgi-bin/hello_get.py" method="get"> 站點(diǎn)名稱: <input type="text" name="name" />  


站點(diǎn) URL: <input type="text" name="url" /> <input type="submit" value="提交" /> </form> 

默認(rèn)情況下 cgi-bin 目錄只能存放腳本文件，我們將 hello_get.html 存儲在 test 目錄下，修改文件權(quán)限為 755：

chmod 755 hello_get.html

Gif 演示如下所示：

4） 使用POST方法傳遞數(shù)據(jù)

使用POST方法向服務(wù)器傳遞數(shù)據(jù)是更安全可靠的，像一些敏感信息如用戶密碼等需要使用POST傳輸數(shù)據(jù)。

以下同樣是hello_get.py ，它也可以處理瀏覽器提交的POST表單數(shù)據(jù):

#!/usr/bin/python
# -*- coding: UTF-8 -*-

# CGI處理模塊
import cgi, cgitb 

# 創(chuàng)建 FieldStorage 的實(shí)例化
form = cgi.FieldStorage() 

# 獲取數(shù)據(jù)
site_name = form.getvalue('name')
site_url  = form.getvalue('url')

print "Content-type:text/html"
print
print ""
print ""
print "<meta charset="\"utf-8\"">"
print "<title>碩編程 CGI 測試實(shí)例</title>"
print ""
print ""
print "<h2>%s官網(wǎng)：%s</h2>
" % (site_name, site_url)
print ""
print ""

以下為表單通過POST方法（method="post"）向服務(wù)器腳本 hello_get.py 提交數(shù)據(jù):

 <meta charset="utf-8"> <title>碩編程(yapf.com)</title> <form action="/cgi-bin/hello_get.py" method="post"> 站點(diǎn)名稱: <input type="text" name="name" />  


站點(diǎn) URL: <input type="text" name="url" /> <input type="submit" value="提交" /> </form> 

Gif 演示如下所示：

5） 通過CGI程序傳遞checkbox數(shù)據(jù)

checkbox用于提交一個(gè)或者多個(gè)選項(xiàng)數(shù)據(jù)，HTML代碼如下：

 <meta charset="utf-8"> <title>碩編程(yapf.com)</title> <form action="/cgi-bin/checkbox.py" method="POST" target="_blank"> <input type="checkbox" name="yapf" value="on" /> 碩編程<input type="checkbox" name="google" value="on" /> Google<input type="submit" value="選擇站點(diǎn)" /> </form> 

以下為 checkbox.py 文件的代碼：

#!/usr/bin/python
# -*- coding: UTF-8 -*-

# 引入 CGI 處理模塊 
import cgi, cgitb 

# 創(chuàng)建 FieldStorage的實(shí)例 
form = cgi.FieldStorage() 

# 接收字段數(shù)據(jù)
if form.getvalue('google'):
   google_flag = "是"
else:
   google_flag = "否"

if form.getvalue('yapf'):
   yapf_flag = "是"
else:
   yapf_flag = "否"

print "Content-type:text/html"
print
print ""
print ""
print "<meta charset="\"utf-8\"">"
print "<title>碩編程 CGI 測試實(shí)例</title>"
print ""
print ""
print "<h2> 碩編程是否選擇了 : %s</h2>
" % yapf_flag
print "<h2> Google 是否選擇了 : %s</h2>
" % google_flag
print ""
print ""

修改 checkbox.py 權(quán)限：

chmod 755 checkbox.py

瀏覽器訪問 Gif 演示圖：

6） 通過CGI程序傳遞Radio數(shù)據(jù)

Radio 只向服務(wù)器傳遞一個(gè)數(shù)據(jù)，HTML代碼如下：

 <meta charset="utf-8"> <title>碩編程(yapf.com)</title> <form action="/cgi-bin/radiobutton.py" method="post" target="_blank"> <input type="radio" name="site" value="yapf" /> 碩編程<input type="radio" name="site" value="google" /> Google<input type="submit" value="提交" /> </form> 

radiobutton.py 腳本代碼如下：

#!/usr/bin/python
# -*- coding: UTF-8 -*-

# 引入 CGI 處理模塊 
import cgi, cgitb 

# 創(chuàng)建 FieldStorage的實(shí)例 
form = cgi.FieldStorage() 

# 接收字段數(shù)據(jù)
if form.getvalue('site'):
   site = form.getvalue('site')
else:
   site = "提交數(shù)據(jù)為空"

print "Content-type:text/html"
print
print ""
print ""
print "<meta charset="\"utf-8\"">"
print "<title>碩編程 CGI 測試實(shí)例</title>"
print ""
print ""
print "<h2> 選中的網(wǎng)站是 %s</h2>
" % site
print ""
print ""

修改 radiobutton.py 權(quán)限：

chmod 755 radiobutton.py

瀏覽器訪問 Gif 演示圖：

7） 通過CGI程序傳遞 Textarea 數(shù)據(jù)

Textarea 向服務(wù)器傳遞多行數(shù)據(jù)，HTML代碼如下：

 <meta charset="utf-8"> <title>碩編程(yapf.com)</title> <form action="/cgi-bin/textarea.py" method="post" target="_blank"> <textarea name="textcontent" cols="40" rows="4">在這里輸入內(nèi)容...</textarea> <input type="submit" value="提交" /> </form> 

textarea.py 腳本代碼如下：

#!/usr/bin/python
# -*- coding: UTF-8 -*-

# 引入 CGI 處理模塊 
import cgi, cgitb 

# 創(chuàng)建 FieldStorage的實(shí)例 
form = cgi.FieldStorage() 

# 接收字段數(shù)據(jù)
if form.getvalue('textcontent'):
   text_content = form.getvalue('textcontent')
else:
   text_content = "沒有內(nèi)容"

print "Content-type:text/html"
print
print ""
print "";
print "<meta charset="\"utf-8\"">"
print "<title>碩編程 CGI 測試實(shí)例</title>"
print ""
print ""
print "<h2> 輸入的內(nèi)容是：%s</h2>
" % text_content
print ""
print ""

修改 textarea.py 權(quán)限：

chmod 755 textarea.py

瀏覽器訪問 Gif 演示圖：

8）通過CGI程序傳遞下拉數(shù)據(jù)。

HTML 下拉框代碼如下：

 <meta charset="utf-8"> <title>碩編程(yapf.com)</title> <form action="/cgi-bin/dropdown.py" method="post" target="_blank"> <select name="dropdown"> <option value="yapf" selected="">碩編程</option> <option value="google">Google</option> </select> <input type="submit" value="提交" /> </form> 

dropdown.py 腳本代碼如下所示：

#!/usr/bin/python
# -*- coding: UTF-8 -*-

# 引入 CGI 處理模塊 
import cgi, cgitb 

# 創(chuàng)建 FieldStorage的實(shí)例 
form = cgi.FieldStorage() 

# 接收字段數(shù)據(jù)
if form.getvalue('dropdown'):
   dropdown_value = form.getvalue('dropdown')
else:
   dropdown_value = "沒有內(nèi)容"

print "Content-type:text/html"
print
print ""
print ""
print "<meta charset="\"utf-8\"">"
print "<title>碩編程 CGI 測試實(shí)例</title>"
print ""
print ""
print "<h2> 選中的選項(xiàng)是：%s</h2>
" % dropdown_value
print ""
print ""

修改 dropdown.py 權(quán)限：

chmod 755 dropdown.py

瀏覽器訪問 Gif 演示圖：

8. CGI中使用Cookie

在 http 協(xié)議一個(gè)很大的缺點(diǎn)就是不對用戶身份的進(jìn)行判斷，這樣給編程人員帶來很大的不便， 而 cookie 功能的出現(xiàn)彌補(bǔ)了這個(gè)不足。

cookie 就是在客戶訪問腳本的同時(shí)，通過客戶的瀏覽器，在客戶硬盤上寫入紀(jì)錄數(shù)據(jù) ，當(dāng)下次客戶訪問腳本時(shí)取回?cái)?shù)據(jù)信息，從而達(dá)到身份判別的功能，cookie 常用在身份校驗(yàn)中。

1）cookie的語法

http cookie的發(fā)送是通過http頭部來實(shí)現(xiàn)的，他早于文件的傳遞，頭部set-cookie的語法如下：

Set-cookie:name=name;expires=date;path=path;domain=domain;secure 

• name=name: 需要設(shè)置cookie的值(name不能使用";"和","號),有多個(gè)name值時(shí)用 ";" 分隔，例如：name1=name1;name2=name2;name3=name3。
• expires=date: cookie的有效期限,格式： expires="Wdy,DD-Mon-YYYY HH:MM:SS"
• path=path: 設(shè)置cookie支持的路徑,如果path是一個(gè)路徑，則cookie對這個(gè)目錄下的所有文件及子目錄生效，例如： path="/cgi-bin/"，如果path是一個(gè)文件，則cookie指對這個(gè)文件生效，例如：path="/cgi-bin/cookie.cgi"。
• domain=domain: 對cookie生效的域名，例如：domain=""
• secure: 如果給出此標(biāo)志，表示cookie只能通過SSL協(xié)議的https服務(wù)器來傳遞。
• cookie的接收是通過設(shè)置環(huán)境變量HTTP_COOKIE來實(shí)現(xiàn)的，CGI程序可以通過檢索該變量獲取cookie信息。

9. Cookie設(shè)置

Cookie的設(shè)置非常簡單，cookie會在http頭部單獨(dú)發(fā)送。以下實(shí)例在cookie中設(shè)置了name 和 expires：

#!/usr/bin/python
# -*- coding: UTF-8 -*-
# 
print 'Content-Type: text/html'
print 'Set-Cookie: name="碩編程";expires=Wed, 28 Aug 2016 18:30:00 GMT'
print
print """

    
        <meta charset="utf-8">         <title>碩編程(yapf.com)</title>     
    
        <h1>Cookie set OK!</h1>
    

"""

將以上代碼保存到 cookie_set.py，并修改 cookie_set.py 權(quán)限：

chmod 755 cookie_set.py

以上實(shí)例使用了 Set-Cookie 頭信息來設(shè)置Cookie信息，可選項(xiàng)中設(shè)置了Cookie的其他屬性，如過期時(shí)間Expires，域名Domain，路徑Path。這些信息設(shè)置在 "Content-type:text/html"之前。

10. 檢索Cookie信息

Cookie信息檢索頁非常簡單，Cookie信息存儲在CGI的環(huán)境變量HTTP_COOKIE中，存儲格式如下：

key1=value1;key2=value2;key3=value3....

以下是一個(gè)簡單的CGI檢索cookie信息的程序：

#!/usr/bin/python
# -*- coding: UTF-8 -*-

# 導(dǎo)入模塊
import os
import Cookie

print "Content-type: text/html"
print

print """<meta charset="utf-8"> <title>碩編程(yapf.com)</title> <h1>讀取cookie信息</h1>
"""

if 'HTTP_COOKIE' in os.environ:
    cookie_string=os.environ.get('HTTP_COOKIE')
    c=Cookie.SimpleCookie()
    c.load(cookie_string)

    try:
        data=c['name'].value
        print "cookie data: "+data+"
"
    except KeyError:
        print "cookie 沒有設(shè)置或者已過期
"
print """



"""

將以上代碼保存到 cookie_get.py，并修改 cookie_get.py 權(quán)限：

chmod 755 cookie_get.py

以上 cookie 設(shè)置顏色 Gif 如下所示：

1）文件上傳實(shí)例

HTML設(shè)置上傳文件的表單需要設(shè)置 enctype 屬性為 multipart/form-data，代碼如下所示：

 <meta charset="utf-8"> <title>碩編程(yapf.com)</title>  <form enctype="multipart/form-data" action="/cgi-bin/save_file.py" method="post">    
選中文件: <input type="file" name="filename" />
   
<input type="submit" value="上傳" />
   </form> 

save_file.py腳本文件代碼如下：

#!/usr/bin/python
# -*- coding: UTF-8 -*-

import cgi, os
import cgitb; cgitb.enable()

form = cgi.FieldStorage()

# 獲取文件名
fileitem = form['filename']

# 檢測文件是否上傳
if fileitem.filename:
   # 設(shè)置文件路徑 
   fn = os.path.basename(fileitem.filename)
   open('/tmp/' + fn, 'wb').write(fileitem.file.read())

   message = '文件 "' + fn + '" 上傳成功'
   
else:
   message = '文件沒有上傳'
   
print """\
Content-Type: text/html\n<meta charset="utf-8"> <title>碩編程(yapf.com)</title>    
%s
""" % (message,)

將以上代碼保存到 save_file.py，并修改 save_file.py 權(quán)限：

chmod 755 save_file.py

以上 cookie 設(shè)置顏色 Gif 如下所示：

如果你使用的系統(tǒng)是Unix/Linux，你必須替換文件分隔符，在window下只需要使用open()語句即可：

fn = os.path.basename(fileitem.filename.replace("\\", "/" ))

11. 文件下載對話框

我們先在當(dāng)前目錄下創(chuàng)建 foo.txt 文件，用于程序的下載。

文件下載通過設(shè)置HTTP頭信息來實(shí)現(xiàn)，功能代碼如下：

#!/usr/bin/python
# -*- coding: UTF-8 -*-

# HTTP 頭部
print "Content-Disposition: attachment; filename=\"foo.txt\"";
print
# 打開文件
fo = open("foo.txt", "rb")

str = fo.read();
print str

# 關(guān)閉文件
fo.close()