免費AI編程助手
Python3 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 架構圖
Web 服務器支持及配置
在你進行 CGI 編程前，確保您的 Web 服務器支持 CGI 及已經配置了 CGI 的處理程序。
Apache 支持 CGI 配置（這里使用PHPstudy集成的Apache）：
打開Apache的配置文件?httpd-conf?，在文件中找到如下內容：
首先找到ScriptAlias（圖片內容為已經修改過的值，默認值應該有所不同而且是被注釋掉的）
修改為項目地址? ScriptAlias /cgi-bin/ "F:/phpstudy/phpstudy_pro/WWW/webpy"? （之前的項目都放在?F:/phpstudy/phpstudy_pro/WWW/?下,這個文件夾是PHPstudy的apache默認項目文件夾，將路徑改為這樣可以方便localhost訪問）。
然后找到Directory，將其修改為
<Directory "F:/phpstudy/phpstudy_pro/WWW/webpy">
AllowOverride None
Options +ExecCGI
Order allow,deny
Allow from all
</Directory>
注意：這里的路徑和上面設置的路徑是一樣的。
接著找到AddHandler
添加?.py?。使apache識別.py文件為cgi程序（圖中已添加）。
接下來我們就可以在webpy文件夾下寫pythonCGI程序了。
第一個CGI程序
我們使用 Python 創(chuàng)建第一個 CGI 程序，文件名為 hello.py，文件位于 /var/www/cgi-bin目錄中，內容如下：
#!/usr/bin/python3
# 請注意第一行代碼，在linux中需要在py文件中正確指定python解釋器的路徑才能運行
# 在Windows中使用Python CGI文件也需要正確指定python解釋器的路徑才能運行
#coding=utf-8
print("Content-type:text/html") # 指定返回的類型，沒有這行代碼會報錯
print() # 空行，告訴服務器結束頭部
# 以下是要返回的HTML正文
print ('<html>')
print ('<head>')
print ('<title>Hello Word - 我的第一個 CGI 程序！</title>')
print ('</head>')
print ('<body>')
print ('<h2>Hello Word! 我的第一CGI程序</h2>')
print ('</body>')
print ('</html>')
文件保存后修改 hello.py，修改文件權限為 755（linux和macos需要在webpy文件夾下使用下面的命令來修改文件讀寫權限，在Windows環(huán)境下需要修改文件的讀寫權限）：
chmod 755 hello.py 以上程序在瀏覽器訪問顯示結果如下：
這個的 hello.py 腳本是一個簡單的 Python 腳本，腳本第一行的輸出內容"Content-type:text/html"發(fā)送到瀏覽器并告知瀏覽器顯示的內容類型為"text/html"。
用 print 輸出一個空行用于告訴服務器結束頭部信息。
注：如果此處出現(xiàn)亂碼，可以在打印html的時候打印??,在下文部分代碼中有所體現(xiàn)（注意，這里不使用UTF-8的原因是小編在這里使用utf-8出現(xiàn)亂碼，這是因為小編的系統(tǒng)是Windows系統(tǒng)，系統(tǒng)默認字符集是GBK，所以會出現(xiàn)亂碼）。
另外：請注意第一行代碼，在linux中需要在py文件中正確指定python解釋器的路徑才能運行 。在Windows中使用Python CGI文件也需要正確指定python解釋器的路徑才能運行
HTTP頭部
hello.py 文件內容中的" Content-type:text/html"即為 HTTP 頭部的一部分，它會發(fā)送給瀏覽器告訴瀏覽器文件的內容類型。
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 環(huán)境變量
所有的 CGI 程序都接收以下的環(huán)境變量，這些變量在 CGI 程序中發(fā)揮了重要的作用：
| 變量名 | 描述 |
|---|---|
| CONTENT_TYPE | 這個環(huán)境變量的值指示所傳遞來的信息的 MIME 類型。目前，環(huán)境變量 CONTENT_TYPE 一般都是：application/x-www-form-urlencoded,他表示數(shù)據(jù)來自于 HTML 表單。 |
| CONTENT_LENGTH | 如果服務器與 CGI 程序信息的傳遞方式是 POST，這個環(huán)境變量即使從標準輸入 STDIN 中可以讀到的有效數(shù)據(jù)的字節(jié)數(shù)。這個環(huán)境變量在讀取所輸入的數(shù)據(jù)時必須使用。 |
| HTTP_COOKIE | 客戶機內的 COOKIE 內容。 |
| HTTP_USER_AGENT | 提供包含了版本數(shù)或其他專有數(shù)據(jù)的客戶瀏覽器信息。 |
| PATH_INFO | 這個環(huán)境變量的值表示緊接在 CGI 程序名之后的其他路徑信息。它常常作為 CGI 程序的參數(shù)出現(xiàn)。 |
| QUERY_STRING | 如果服務器與 CGI 程序信息的傳遞方式是 GET，這個環(huán)境變量的值即使所傳遞的信息。這個信息經跟在 CGI 程序名的后面，兩者中間用一個問號'?'分隔。 |
| REMOTE_ADDR | 這個環(huán)境變量的值是發(fā)送請求的客戶機的IP地址，例如上面的192.168.1.67。這個值總是存在的。而且它是 Web 客戶機需要提供給Web服務器的唯一標識，可以在 CGI 程序中用它來區(qū)分不同的 Web 客戶機。 |
| REMOTE_HOST | 這個環(huán)境變量的值包含發(fā)送 CGI 請求的客戶機的主機名。如果不支持你想查詢，則無需定義此環(huán)境變量。 |
| REQUEST_METHOD | 提供腳本被調用的方法。對于使用 HTTP/1.0 協(xié)議的腳本，僅 GET 和 POST 有意義。 |
| SCRIPT_FILENAME | CGI 腳本的完整路徑 |
| SCRIPT_NAME | CGI 腳本的的名稱 |
| SERVER_NAME | 這是你的 WEB 服務器的主機名、別名或IP地址。 |
| SERVER_SOFTWARE | 這個環(huán)境變量的值包含了調用 CGI 程序的 HTTP 服務器的名稱和版本號。例如，上面的值為 Apache/2.2.14(Unix) |
以下是一個簡單的 CGI 腳本輸出 CGI 的環(huán)境變量：
#!/usr/bin/python3
#coding=utf-8
import os
print ("Content-type: text/html")
print ()
print ("<b>環(huán)境變量</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，執(zhí)行結果如下：
GET 和 POST 方法
瀏覽器客戶端通過兩種方法向服務器傳遞信息，這兩種方法就是 GET 方法和 POST 方法。
使用 GET 方法傳輸數(shù)據(jù)
GET 方法發(fā)送編碼后的用戶信息到服務端，數(shù)據(jù)信息包含在請求頁面的 URL 上，以"?"號分割, 如下所示：
?http://localhost/webpy/test.py?key1=value1&key2=value2
?
有關 GET 請求的其他一些注釋：
- GET 請求可被緩存
- GET 請求保留在瀏覽器歷史記錄中
- GET 請求可被收藏為書簽
- GET 請求不應在處理敏感數(shù)據(jù)時使用
- GET 請求有長度限制
- GET 請求只應當用于取回數(shù)據(jù)
簡單的 url 實例：GET 方法
以下是一個簡單的 URL，使用 GET 方法向 test_get.py 程序發(fā)送兩個參數(shù)：
?http://localhost/webpy/test_get.py?name=W3Cschool教程&url=http://o2fo.com
?
以下為 test_get.py 文件的代碼：
#!/usr/bin/python3
#coding=utf-8
# CGI處理模塊
import cgi, cgitb
# 創(chuàng)建 FieldStorage 的實例化
form = cgi.FieldStorage()
# 獲取數(shù)據(jù)
site_name = form.getvalue('name')
site_url = form.getvalue('url')
print ("Content-type:text/html")
print ()
print ("<html>")
print ("<head>")
print ("<title>W3Cschool教程 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 方法向服務器發(fā)送兩個數(shù)據(jù)，提交的服務器腳本同樣是 test_get.py 文件，hello_get.html 代碼如下：
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>W3Cschool教程(w3cschool.cn)</title>
</head>
<body>
<form action="/webpy/test_get.py" method="get">
站點名稱: <input type="text" name="name"> <br />
站點 URL: <input type="text" name="url" />
<input type="submit" value="提交" />
</form>
</body>
</html>
默認情況下 webpy 目錄只能存放腳本文件，我們將 hello_get.html 存儲在 WWW 目錄下，修改文件權限為 755：
chmod 755 hello_get.html
Gif 演示如下所示：
使用 POST 方法傳遞數(shù)據(jù)
使用 POST 方法向服務器傳遞數(shù)據(jù)是更安全可靠的，像一些敏感信息如用戶密碼等需要使用 POST 傳輸數(shù)據(jù)。
以下同樣是 test_get.py ，它也可以處理瀏覽器提交的 POST 表單數(shù)據(jù):
#!/usr/bin/python3
#coding=utf-8
# CGI處理模塊
import cgi, cgitb
# 創(chuàng)建 FieldStorage 的實例化
form = cgi.FieldStorage()
# 獲取數(shù)據(jù)
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>W3Cschool教程 CGI 測試實例</title>")
print ("</head>")
print ("<body>")
print ("<h2>%s官網：%s</h2>" % (site_name, site_url))
print ("</body>")
print ("</html>")
以下為表單通過 POST 方法（method="post"）向服務器腳本 test_get.py 提交數(shù)據(jù):
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>W3Cschool教程(w3cschool.cn)</title>
</head>
<body>
<form action="/webpy/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 數(shù)據(jù)
checkbox 用于提交一個或者多個選項數(shù)據(jù)，HTML 代碼如下：
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>W3Cschool教程(w3cschool.cn)</title>
</head>
<body>
<form action="/webpy/checkbox.py" method="POST" target="_blank">
<input type="checkbox" name="youj" value="on" /> W3Cschool教程
<input type="checkbox" name="google" value="on" /> Google
<input type="submit" value="選擇站點" />
</form>
</body>
</html>
以下為 checkbox.py 文件的代碼：
#!/usr/bin/python3
#coding=utf-8
# 引入 CGI 處理模塊
import cgi, cgitb
# 創(chuàng)建 FieldStorage的實例
form = cgi.FieldStorage()
# 接收字段數(shù)據(jù)
if form.getvalue('google'):
google_flag = "是"
else:
google_flag = "否"
if form.getvalue('youj'):
youj_flag = "是"
else:
youj_flag = "否"
print ("Content-type:text/html")
print ()
print ("<html>")
print ("<head>")
print ("<title>W3Cschool教程 CGI 測試實例</title>")
print ("</head>")
print ("<body>")
print ("<h2> W3Cschool教程是否選擇了 : %s</h2>" % youj_flag)
print ("<h2> Google 是否選擇了 : %s</h2>" % google_flag)
print ("</body>")
print ("</html>")
修改 checkbox.py 權限：
chmod 755 checkbox.py
瀏覽器訪問 Gif 演示圖：
通過 CGI 程序傳遞 Radio 數(shù)據(jù)
Radio 只向服務器傳遞一個數(shù)據(jù)，HTML 代碼如下：
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>W3Cschool教程(w3cschool.cn)</title>
</head>
<body>
<form action="/webpy/radiobutton.py" method="post" target="_blank">
<input type="radio" name="site" value="W3Cschool教程" /> W3Cschool教程<input type="radio" name="site" value="google" /> Google
<input type="submit" value="提交" />
</form>
</body>
</html>
radiobutton.py 腳本代碼如下：
#!/usr/bin/python3
#coding=utf-8
# 引入 CGI 處理模塊
import cgi, cgitb
# 創(chuàng)建 FieldStorage的實例
form = cgi.FieldStorage()
# 接收字段數(shù)據(jù)
if form.getvalue('site'):
site = form.getvalue('site')
else:
site = "提交數(shù)據(jù)為空"
print ("Content-type:text/html")
print ()
print ("<html>")
print ("<head>")
print ("<title>W3Cschool教程 CGI 測試實例</title>")
print ("</head>")
print ("<body>")
print ("<h2> 選中的網站是 %s</h2>" % site)
print ("</body>")
print ("</html>")
修改 radiobutton.py 權限：
chmod 755 radiobutton.py
瀏覽器訪問 Gif 演示圖：
通過 CGI 程序傳遞 Textarea 數(shù)據(jù)
Textarea 向服務器傳遞多行數(shù)據(jù)，HTML 代碼如下：
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>W3Cschool教程(w3cschool.cn)</title>
</head>
<body>
<form action="/webpy/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
#coding=utf-8
# 引入 CGI 處理模塊
import cgi, cgitb
# 創(chuàng)建 FieldStorage的實例
form = cgi.FieldStorage()
# 接收字段數(shù)據(jù)
if form.getvalue('textcontent'):
text_content = form.getvalue('textcontent')
else:
text_content = "沒有內容"
print ("Content-type:text/html")
print ()
print ("<html>")
print ("<head>")
print ("<title>W3Cschool教程 CGI 測試實例</title>")
print ("</head>")
print ("<body>")
print ("<h2> 輸入的內容是：%s</h2>" % text_content)
print ("</body>")
print ("</html>")
修改 textarea.py 權限：
chmod 755 textarea.py
瀏覽器訪問 Gif 演示圖：
通過 CGI 程序傳遞下拉數(shù)據(jù)。
HTML 下拉框代碼如下：
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>W3Cschool教程(w3cschool.cn)</title>
</head>
<body>
<form action="/webpy/dropdown.py" method="post" target="_blank">
<select name="dropdown">
<option value="W3Cschool教程" selected>W3Cschool教程</option>
<option value="google">Google</option>
</select>
<input type="submit" value="提交"/>
</form>
</body>
</html>
dropdown.py 腳本代碼如下所示：
#!/usr/bin/python3
#coding=utf-8
# 引入 CGI 處理模塊
import cgi, cgitb
# 創(chuàng)建 FieldStorage的實例
form = cgi.FieldStorage()
# 接收字段數(shù)據(jù)
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>W3Cschool教程 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 協(xié)議一個很大的缺點就是不對用戶身份的進行判斷，這樣給編程人員帶來很大的不便，而 cookie 功能的出現(xiàn)彌補了這個不足。
cookie 就是在客戶訪問腳本的同時，通過客戶的瀏覽器，在客戶硬盤上寫入紀錄數(shù)據(jù) ，當下次客戶訪問腳本時取回數(shù)據(jù)信息，從而達到身份判別的功能，cookie 常用在身份校驗中。
cookie 的語法
http cookie 的發(fā)送是通過 http 頭部來實現(xiàn)的，他早于文件的傳遞，頭部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="/webpy/"，如果path是一個文件，則cookie指對這個文件生效，例如：path="/webpy/cookie.py"。
- domain=domain: 對 cookie 生效的域名，例如：domain="o2fo.com"
- secure: 如果給出此標志，表示cookie只能通過SSL協(xié)議的https服務器來傳遞。
- cookie的接收是通過設置環(huán)境變量 HTTP_COOKIE 來實現(xiàn)的，CGI 程序可以通過檢索該變量獲取 cookie 信息。
Cookie 設置
Cookie 的設置非常簡單，cookie 會在 http 頭部單獨發(fā)送。以下實例在 cookie 中設置了name 和 expires：
#!/usr/bin/python3
#coding=utf-8
print ('Content-Type: text/html')
print ('Set-Cookie: name="W3Cschool";expires=Thu 02 Dec 2021 18:30:00 GMT')//注意，這個cookie在這個時間前有效，之后使用cookie會過期
print ()
print ("""
<html>
<head>
<meta charset="gbk">
<title>W3Cschool教程(w3cschool.cn)</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不能存放中文，本文采用英文例子，如果要使用中文可以使用后端編碼（可以采用utf-8等編碼，python和JavaScript都有提供響應的編解碼的功能）,傳到前端后再將其解碼即可。
檢索Cookie信息
Cookie 信息檢索頁非常簡單，Cookie 信息存儲在 CGI 的環(huán)境變量 HTTP_COOKIE 中，存儲格式如下：
key1=value1;key2=value2;key3=value3....
以下是一個簡單的 CGI 檢索 cookie 信息的程序：
#!/usr/bin/python3
#coding=utf-8
# 導入模塊
import os
import http.cookies
print ("Content-type: text/html")
print ()
print ("""
<html>
<head>
<meta charset="gbk">
<title>W3Cschool教程(w3cschool.cn)</title>
</head>
<body>
<h1>讀取cookie信息</h1>
""")
if 'HTTP_COOKIE' in os.environ:
cookie_string=os.environ.get('HTTP_COOKIE')
c=http.cookies.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>W3Cschool教程(w3cschool.cn)</title>
</head>
<body>
<form enctype="multipart/form-data"
action="/webpy/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
#coding=utf-8
import cgi, os
import cgitb
cgitb.enable()
form = cgi.FieldStorage()
# 獲取文件名
fileitem = form['filename']
# 檢測文件是否上傳
if fileitem.filename:
# 設置文件路徑
fn = os.path.basename(fileitem.filename)
open(os.getcwd()+'/tmp/' + fn, 'wb').write(fileitem.file.read())
message = '文件 "' + fn + '" 上傳成功'
else:
message = '文件沒有上傳'
print ("Content-type: text/html")
print ()
print ("""
<html>
<head>
<meta charset="gbk">
<title>W3Cschool教程(w3cschool.cn)</title>
</head>
<body>
<p>%s</p>
</body>
</html>
""" % (message,))
將以上代碼保存到 save_file.py，并修改 save_file.py 權限：
chmod 755 save_file.py
以上文件上傳代碼 Gif 如下所示：
如果你使用的系統(tǒng)是 Unix/Linux，你必須替換文件分隔符，在 window 下只需要使用open() 語句即可：
fn = os.path.basename(fileitem.filename.replace("\\", "/" ))
另外，請注意在webpy下創(chuàng)建一個tmp文件夾，不然上傳的時候會報錯
文件下載對話框
我們先在當前目錄下創(chuàng)建 foo.txt 文件，用于程序的下載。
文件下載通過設置 HTTP 頭信息來實現(xiàn)，功能代碼如下：
#!/usr/bin/python3
# HTTP 頭部
print ("Content-Disposition: attachment; filename=\"foo.txt\"")
print ()
# 打開文件
fo = open("foo.txt", "rb")
str = fo.read();
print (str)
# 關閉文件
fo.close()
更多建議：