Python CGI 編程

2022-07-04 14:52 更新

Python CGI 編程


 注:在pythonCGI編程方面,python2和python3的區(qū)別并不大(區(qū)別在于pythonCGI文件開頭的指定解釋器不同和print語句不同,不過在python27版本中也可以使用類似python3的print語句)。綜合對比后小編覺得本篇文章有可取之處,所以保留本篇文章,python3 CGI編程文章內(nèi)容較新,有更好的參考價值——python3CGI編程。

什么是 CGI

CGI 目前由 NCSA 維護(hù),NCSA 定義 CGI 如下:

CGI(Common Gateway Interface),通用網(wǎng)關(guān)接口,它是一段程序,運行在服務(wù)器上如:HTTP 服務(wù)器,提供同客戶端 HTML 頁面的接口。


網(wǎng)頁瀏覽

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

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

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


CGI 架構(gòu)圖

CGI構(gòu)架圖


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 程序都保存在一個預(yù)先配置的目錄。這個目錄被稱為 CGI 目錄,并按照慣例,它被命名為 /var/www/cgi-bin 目錄。

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

默認(rèn)情況下,Linux 服務(wù)器配置運行的 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 結(jié)尾的 Python 腳本文件:

AddHandler cgi-script .cgi .pl .py

第一個 CGI 程序

我們使用 Python 創(chuàng)建第一個 CGI 程序,文件名為 hellp.py,文件位于 /var/www/cgi-bin 目錄中,內(nèi)容如下,修改文件的權(quán)限為 755:

#coding=utf-8
#!/usr/bin/python

print "Content-type:text/html\r\n\r\n"
print '<html>'
print '<head>'
print '<title>Hello Word - First CGI Program</title>'
print '</head>'
print '<body>'
print '<h2>Hello Word! This is my first CGI program</h2>'
print '</body>'
print '</html>'

以上程序在瀏覽器訪問顯示結(jié)果如下:

Hello Word! This is my first CGI program

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


HTTP 頭部

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

HTTP 頭部的格式如下:

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

例如:

Content-type: text/html

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

描述
Content-type:請求的與實體對應(yīng)的 MIME 信息。例如: Content-type:text/html
Expires: Date響應(yīng)過期的日期和時間
Location: URL用來重定向接收方到非請求 URL 的位置來完成請求或標(biāo)識新的資源
Last-modified: Date請求資源的最后修改時間
Content-length: N請求的內(nèi)容長度
Set-Cookie: String設(shè)置 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如果服務(wù)器與 CGI 程序信息的傳遞方式是 POST,這個環(huán)境變量即使從標(biāo)準(zhǔn)輸入 STDIN 中可以讀到的有效數(shù)據(jù)的字節(jié)數(shù)。這個環(huán)境變量在讀取所輸入的數(shù)據(jù)時必須使用。
HTTP_COOKIE客戶機(jī)內(nèi)的 COOKIE 內(nèi)容。
HTTP_USER_AGENT提供包含了版本數(shù)或其他專有數(shù)據(jù)的客戶瀏覽器信息。
PATH_INFO這個環(huán)境變量的值表示緊接在 CGI 程序名之后的其他路徑信息。它常常作為 CGI 程序的參數(shù)出現(xiàn)。
QUERY_STRING如果服務(wù)器與 CGI 程序信息的傳遞方式是 GET,這個環(huán)境變量的值即使所傳遞的信息。這個信息經(jīng)跟在 CGI 程序名的后面,兩者中間用一個問號'?'分隔。
REMOTE_ADDR這個環(huán)境變量的值是發(fā)送請求的客戶機(jī)的IP地址,例如上面的 192.168.1.67。這個值總是存在的。而且它是 Web 客戶機(jī)需要提供給 Web 服務(wù)器的唯一標(biāo)識,可以在 CGI 程序中用它來區(qū)分不同的 Web 客戶機(jī)。
REMOTE_HOST這個環(huán)境變量的值包含發(fā)送 CGI 請求的客戶機(jī)的主機(jī)名。如果不支持你想查詢,則無需定義此環(huán)境變量。
REQUEST_METHOD提供腳本被調(diào)用的方法。對于使用 HTTP/1.0 協(xié)議的腳本,僅 GET 和 POST 有意義。
SCRIPT_FILENAMECGI 腳本的完整路徑
SCRIPT_NAMECGI 腳本的的名稱
SERVER_NAME這是你的 WEB 服務(wù)器的主機(jī)名、別名或IP地址。
SERVER_SOFTWARE這個環(huán)境變量的值包含了調(diào)用 CGI 程序的 HTTP 服務(wù)器的名稱和版本號。例如,上面的值為 Apache/2.2.14(Unix)

以下是一個簡單的 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><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>"

GET 和 POST 方法

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

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

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

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

有關(guān) GET 請求的其他一些注釋:

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

簡單的 url 實例:GET方法

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

/cgi-bin/hello_get.py?first_name=ZARA&last_name=ALI

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

#coding=utf-8
#!/usr/bin/python

# CGI處理模塊
import cgi, cgitb 

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

# 獲取數(shù)據(jù)
first_name = form.getvalue('first_name')
last_name  = form.getvalue('last_name')

print "Content-type:text/html\r\n\r\n"
print "<html>"
print "<head>"
print "<title>Hello - Second CGI Program</title>"
print "</head>"
print "<body>"
print "<h2>Hello %s %s</h2>" % (first_name, last_name)
print "</body>"
print "</html>"

瀏覽器請求輸出結(jié)果:

Hello ZARA ALI

簡單的表單實例:GET 方法

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

<form action="/cgi-bin/hello_get.py" method="get">
First Name: <input type="text" name="first_name">  <br />

Last Name: <input type="text" name="last_name" />
<input type="submit" value="Submit" />
</form>

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

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

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

#coding=utf-8
#!/usr/bin/python

# 引入 CGI 模塊 
import cgi, cgitb 

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

# 獲取表單數(shù)據(jù)
first_name = form.getvalue('first_name')
last_name  = form.getvalue('last_name')

print "Content-type:text/html\r\n\r\n"
print "<html>"
print "<head>"
print "<title>Hello - Second CGI Program</title>"
print "</head>"
print "<body>"
print "<h2>Hello %s %s</h2>" % (first_name, last_name)
print "</body>"
print "</html>"

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

<form action="/cgi-bin/hello_get.py" method="post">
First Name: <input type="text" name="first_name"><br />
Last Name: <input type="text" name="last_name" />

<input type="submit" value="Submit" />
</form>

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

checkbox 用于提交一個或者多個選項數(shù)據(jù),HTML 代碼如下:

<form action="/cgi-bin/checkbox.cgi" method="POST" target="_blank">
<input type="checkbox" name="maths" value="on" /> Maths
<input type="checkbox" name="physics" value="on" /> Physics
<input type="submit" value="Select Subject" />
</form>

以下為 checkbox.cgi 文件的代碼:

#coding=utf-8
#!/usr/bin/python

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

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

# 接收字段數(shù)據(jù)
if form.getvalue('maths'):
   math_flag = "ON"
else:
   math_flag = "OFF"

if form.getvalue('physics'):
   physics_flag = "ON"
else:
   physics_flag = "OFF"

print "Content-type:text/html\r\n\r\n"
print "<html>"
print "<head>"
print "<title>Checkbox - Third CGI Program</title>"
print "</head>"
print "<body>"
print "<h2> CheckBox Maths is : %s</h2>" % math_flag
print "<h2> CheckBox Physics is : %s</h2>" % physics_flag
print "</body>"
print "</html>"

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

Radio 只向服務(wù)器傳遞一個數(shù)據(jù),HTML 代碼如下:

<form action="/cgi-bin/radiobutton.py" method="post" target="_blank">
<input type="radio" name="subject" value="maths" /> Maths
<input type="radio" name="subject" value="physics" /> Physics
<input type="submit" value="Select Subject" />
</form>

radiobutton.py 腳本代碼如下:

#coding=utf-8
#!/usr/bin/python

# Import modules for CGI handling 
import cgi, cgitb 

# Create instance of FieldStorage 
form = cgi.FieldStorage() 

# Get data from fields
if form.getvalue('subject'):
   subject = form.getvalue('subject')
else:
   subject = "Not set"

print "Content-type:text/html\r\n\r\n"
print "<html>"
print "<head>"
print "<title>Radio - Fourth CGI Program</title>"
print "</head>"
print "<body>"
print "<h2> Selected Subject is %s</h2>" % subject
print "</body>"
print "</html>"

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

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

<form action="/cgi-bin/textarea.py" method="post" target="_blank">
<textarea name="textcontent" cols="40" rows="4">
Type your text here...
</textarea>
<input type="submit" value="Submit" />
</form>

textarea.cgi腳本代碼如下:

#coding=utf-8
#!/usr/bin/python

# Import modules for CGI handling 
import cgi, cgitb 

# Create instance of FieldStorage 
form = cgi.FieldStorage() 

# Get data from fields
if form.getvalue('textcontent'):
   text_content = form.getvalue('textcontent')
else:
   text_content = "Not entered"

print "Content-type:text/html\r\n\r\n"
print "<html>"
print "<head>";
print "<title>Text Area - Fifth CGI Program</title>"
print "</head>"
print "<body>"
print "<h2> Entered Text Content is %s</h2>" % text_content
print "</body>"

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

HTML下拉框代碼如下:

<form action="/cgi-bin/dropdown.py" method="post" target="_blank">
<select name="dropdown">
<option value="Maths" selected>Maths</option>
<option value="Physics">Physics</option>
</select>
<input type="submit" value="Submit"/>
</form>

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

#coding=utf-8
#!/usr/bin/python

# Import modules for CGI handling 
import cgi, cgitb 

# Create instance of FieldStorage 
form = cgi.FieldStorage() 

# Get data from fields
if form.getvalue('dropdown'):
   subject = form.getvalue('dropdown')
else:
   subject = "Not entered"

print "Content-type:text/html\r\n\r\n"
print "<html>"
print "<head>"
print "<title>Dropdown Box - Sixth CGI Program</title>"
print "</head>"
print "<body>"
print "<h2> Selected Subject is %s</h2>" % subject
print "</body>"
print "</html>"

CGI 中使用 Cookie

在 http 協(xié)議一個很大的缺點就是不作用戶身份的判斷,這樣給編程人員帶來很大的不便,

而 cookie 功能的出現(xiàn)彌補了這個缺憾。

所有 cookie 就是在客戶訪問腳本的同時,通過客戶的瀏覽器,在客戶硬盤上寫入紀(jì)錄數(shù)據(jù) ,當(dāng)下次客戶訪問腳本時取回數(shù)據(jù)信息,從而達(dá)到身份判別的功能,cookie 常用在密碼判斷中 。

cookie 的語法

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

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

Cookie 設(shè)置

Cookie 的設(shè)置非常簡單,cookie 會在 http 頭部單獨發(fā)送。以下實例在 cookie 中設(shè)置了 UserID 和 Password:

<pre>
#coding=utf-8
#!/usr/bin/python

print "Set-Cookie:UserID=XYZ;\r\n"
print "Set-Cookie:Password=XYZ123;\r\n"
print "Set-Cookie:Expires=Tuesday, 31-Dec-2007 23:12:40 GMT";\r\n"
print "Set-Cookie:Domain=m.hgci.cn;\r\n"
print "Set-Cookie:Path=/perl;\n"
print "Content-type:text/html\r\n\r\n"
...........Rest of the HTML Content....

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


檢索 Cookie 信息

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

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

以下是一個簡單的 CGI 檢索 cookie 信息的程序:

#coding=utf-8
#!/usr/bin/python

# Import modules for CGI handling 
from os import environ
import cgi, cgitb

if environ.has_key('HTTP_COOKIE'):
   for cookie in map(strip, split(environ['HTTP_COOKIE'], ';')):
      (key, value ) = split(cookie, '=');
      if key == "UserID":
         user_id = value

      if key == "Password":
         password = value

print "User ID  = %s" % user_id
print "Password = %s" % password

以上腳本輸出結(jié)果如下:

User ID = XYZ
Password = XYZ123

文件上傳實例:

HTML 設(shè)置上傳文件的表單需要設(shè)置 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="/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 腳本文件代碼如下:

#coding=utf-8
#!/usr/bin/python

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 = 'The file "' + fn + '" was uploaded successfully'
   
else:
   message = 'No file was uploaded'
   
print """\
Content-Type: text/html\n
<html>
<body>
   <p>%s</p>
</body>
</html>
""" % (message,)

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

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

文件下載對話框

如果我們需要為用戶提供文件下載鏈接,并在用戶點擊鏈接后彈出文件下載對話框,我們通過設(shè)置 HTTP 頭信息來實現(xiàn)這些功能,功能代碼如下:

#coding=utf-8
#!/usr/bin/python

# HTTP Header
print "Content-Type:application/octet-stream; name=\"FileName\"\r\n";
print "Content-Disposition: attachment; filename=\"FileName\"\r\n\n";

# Actual File Content will go hear.
fo = open("foo.txt", "rb")

str = fo.read();
print str

# Close opend file
fo.close()


以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號