Python3 CGI編程

上一頁： Python3正則表達式

下一頁： Python3 MySQL數據庫連接

什麼是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_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=本教程&url=http://www.w3big.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>本教程(w3big.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>本教程(w3big.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>本教程(w3big.com)</title>
</head>
<body>
<form action="/cgi-bin/checkbox.py" method="POST" target="_blank">
<input type="checkbox" name="w3big" 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('w3big'):
   w3big_flag = "是"
else:
   w3big_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>" % w3big_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>本教程(w3big.com)</title>
</head>
<body>
<form action="/cgi-bin/radiobutton.py" method="post" target="_blank">
<input type="radio" name="site" value="w3big" /> 本教程
<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>本教程(w3big.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>本教程(w3big.com)</title>
</head>
<body>
<form action="/cgi-bin/dropdown.py" method="post" target="_blank">
<select name="dropdown">
<option value="w3big" 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.w3big.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>本教程(w3big.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 Cookie

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

print ("""
<html>
<head>
<meta charset="utf-8">
<title>本教程(w3big.com)</title>
</head>
<body>
<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+"<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>本教程(w3big.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>本教程(w3big.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正則表達式

下一頁： Python3 MySQL數據庫連接

Python 3 教程

Python3 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信息

文件上傳實例

文件下載對話框