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! 我是來自線上程式語言教學練習的第一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_FILENAMECGI指令碼的完整路徑
SCRIPT_NAMECGI指令碼的的名稱
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'>0s </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=線上程式語言教學練習&url=https://www.twcode01.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>線上程式語言教學練習 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>線上程式語言教學練習(twcode01.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>線上程式語言教學練習 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>線上程式語言教學練習(twcode01.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>線上程式語言教學練習(twcode01.com)</title>
</head>
<body>
<form action="/cgi-bin/checkbox.py" method="POST" target="_blank">
<input type="checkbox" name="twcode01" value="on" /> 線上程式語言教學練習
<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('twcode01'):
   twcode01_flag = "是"
else:
   twcode01_flag = "否"

print ("Content-type:text/html")
print ()
print ("<html>")
print ("<head>")
print ("<meta charset=\"utf-8\">")
print ("<title>線上程式語言教學練習 CGI 測試範例</title>")
print ("</head>")
print ("<body>")
print ("<h2> 線上程式語言教學練習是否選擇了 : %s</h2>" % twcode01_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>線上程式語言教學練習(twcode01.com)</title>
</head>
<body>
<form action="/cgi-bin/radiobutton.py" method="post" target="_blank">
<input type="radio" name="site" value="twcode01" /> 線上程式語言教學練習
<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>線上程式語言教學練習 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>線上程式語言教學練習(twcode01.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>線上程式語言教學練習 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>線上程式語言教學練習(twcode01.com)</title>
</head>
<body>
<form action="/cgi-bin/dropdown.py" method="post" target="_blank">
<select name="dropdown">
<option value="twcode01" selected>線上程式語言教學練習</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>線上程式語言教學練習 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.twcode01.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="線上程式語言教學練習";expires=Wed, 28 Aug 2016 18:30:00 GMT')
print ()
print ("""
<html>
  <head>
    <meta charset="utf-8">
    <title>線上程式語言教學練習(twcode01.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>線上程式語言教學練習(twcode01.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>線上程式語言教學練習(twcode01.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>線上程式語言教學練習(twcode01.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()