Python CGI程式設計


什麼是CGI

CGI 目前由NCSA維護，NCSA定義CGI如下：

CGI(Common Gateway Interface),通用網關介面,它是一段程式,運行在伺服器上如：HTTP伺服器，提供同客戶端HTML頁面的介面。

網頁瀏覽

為了更好的了解CGI是如何運作的，我們可以從在網頁上點擊一個連結或URL的流程：

  • 1、使用你的瀏覽器存取URL並連接到HTTP web 伺服器。

  • 2、網路伺服器接收到請求資訊後會解析URL，並尋找存取的檔案在伺服器上是否存在，如果存在傳回檔案的內容，否則傳回錯誤訊息。

  • 3、瀏覽器從伺服器上接收訊息，並顯示接收的檔案或錯誤訊息。

CGI程式可以是Python腳本，PERL腳本，SHELL腳本，C或C++程式等。

CGI架構圖

1026.png

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/python
# -*- coding: UTF-8 -*-

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! 我是来自php中文网的第一CGI程序</h2>'
print '</body>'
print '</html>'

檔案儲存後修改hello.py，修改檔案權限為755：

chmod 755 hello.py

以上程式在瀏覽器存取顯示結果如下：

1026.jpg

這個的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/python
# -*- coding: UTF-8 -*-
# filename:test.py

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，執行結果如下：

1027.jpg

#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=php中文网&url=http://www.php.cn

以下為hello_get.py檔案的程式碼：

#!/usr/bin/python
# -*- coding: UTF-8 -*-

# filename：test.py

# 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>php中文网 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

瀏覽器請求輸出結果：

1028.jpg

#簡單的表單實例：GET方法

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

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>php中文网(php.cn)</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 示範如下所示：

hello_get.gif

使用POST方法傳遞資料

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

以下同樣是hello_get.py ，它也可以處理瀏覽器提交的POST表單資料:

#!/usr/bin/python
# -*- coding: UTF-8 -*-

# 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>php中文网 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>php中文网(php.cn)</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>

Gif 示範如下所示：

hello_post.gif

透過CGI程式傳遞checkbox資料

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

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>php中文网(php.cn)</title>
</head>
<body>
<form action="/cgi-bin/checkbox.py" method="POST" target="_blank">
<input type="checkbox" name="php" value="on" /> php中文网
<input type="checkbox" name="google" value="on" /> Google
<input type="submit" value="选择站点" />
</form>
</body>
</html>

以下為checkbox.py 檔案的程式碼：

#!/usr/bin/python
# -*- coding: UTF-8 -*-

# 引入 CGI 处理模块 
import cgi, cgitb 

# 创建 FieldStorage的实例 
form = cgi.FieldStorage() 

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

if form.getvalue('php'):
   php_flag = "是"
else:
   php_flag = "否"

print "Content-type:text/html"
print
print "<html>"
print "<head>"
print "<meta charset=\"utf-8\">"
print "<title>php中文网 CGI 测试实例</title>"
print "</head>"
print "<body>"
print "<h2> php中文网是否选择了 : %s</h2>" % php_flag
print "<h2> Google 是否选择了 : %s</h2>" % google_flag
print "</body>"
print "</html>"

修改checkbox.py 權限：

chmod 755 checkbox.py

瀏覽器存取Gif 示範圖：

checkbox.gif

透過CGI程式傳遞Radio資料

Radio 只傳遞一個數據，HTML程式碼如下：

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>php中文网(php.cn)</title>
</head>
<body>
<form action="/cgi-bin/radiobutton.py" method="post" target="_blank">
<input type="radio" name="site" value="php" /> php中文网
<input type="radio" name="site" value="google" /> Google
<input type="submit" value="提交" />
</form>
</body>
</html>

radiobutton.py 腳本程式碼如下：

#!/usr/bin/python
# -*- coding: UTF-8 -*-

# 引入 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>php中文网 CGI 测试实例</title>"
print "</head>"
print "<body>"
print "<h2> 选中的网站是 %s</h2>" % site
print "</body>"
print "</html>"

修改radiobutton .py 權限：

chmod 755 radiobutton.py

瀏覽器存取Gif 示範圖：

radiobutton.gif

透過CGI程式傳遞Textarea 資料

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

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>php中文网(php.cn)</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/python
# -*- coding: UTF-8 -*-

# 引入 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>php中文网 CGI 测试实例</title>"
print "</head>"
print "<body>"
print "<h2> 输入的内容是：%s</h2>" % text_content
print "</body>"
print "</html>"

修改textarea.py 權限：

chmod 755 textarea.py

瀏覽器存取Gif 示範圖：

textarea.gif

透過CGI程式傳遞下拉資料。

HTML 下拉方塊程式碼如下：

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>php中文网(php.cn)</title>
</head>
<body>
<form action="/cgi-bin/dropdown.py" method="post" target="_blank">
<select name="dropdown">
<option value="php" selected>php中文网</option>
<option value="google">Google</option>
</select>
<input type="submit" value="提交"/>
</form>
</body>
</html>

dropdown.py 腳本程式碼如下所示：

#!/usr/bin/python
# -*- coding: UTF-8 -*-

# 引入 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>php中文网 CGI 测试实例</title>"
print "</head>"
print "<body>"
print "<h2> 选中的选项是：%s</h2>" % dropdown_value
print "</body>"
print "</html>"

修改dropdown.py 權限：

chmod 755 dropdown.py

瀏覽器訪問Gif 演示圖：

dropdown.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.php.cn"

  • secure: 如果給予此標誌，表示cookie只能透過SSL協定的https伺服器來傳遞。

  • cookie的接收是透過設定環境變數HTTP_COOKIE來實現的，CGI程式可以透過檢索該變數來取得cookie資訊。

Cookie設定

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

#!/usr/bin/python
# -*- coding: UTF-8 -*-
# 
print 'Content-Type: text/html'
print 'Set-Cookie: name="php中文网";expires=Wed, 28 Aug 2016 18:30:00 GMT'
print
print """
<html>
	<head>
		<meta charset="utf-8">
		<title>php中文网(php.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資訊

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

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

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

#!/usr/bin/python
# -*- coding: UTF-8 -*-

# 导入模块
import os
import Cookie

print "Content-type: text/html"
print

print """
<html>
<head>
<meta charset="utf-8">
<title>php中文网(php.cn)</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 如下所示：

cookie.gif

檔案上傳實例

HTML設定上傳檔案的表單需要設定enctype 屬性為multipart/form-data# ，程式碼如下所示：

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>php中文网(php.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腳本檔案程式碼如下：

#!/usr/bin/python
# -*- 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('/tmp/' + fn, 'wb').write(fileitem.file.read())

   message = '文件 "' + fn + '" 上传成功'
   
else:
   message = '文件没有上传'
   
print """\
Content-Type: text/html\n
<html>
<head>
<meta charset="utf-8">
<title>php中文网(php.cn)</title>
</head>
<body>
   <p>%s</p>
</body>
</html>
""" % (message,)

將上述程式碼儲存到save_file.py，並修改save_file.py 權限：

chmod 755 save_file.py

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

savefile.gif

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

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

文件下載對話框

我們先在目前目錄下建立foo.txt 文件，用於程式的下載。

檔案下載透過設定HTTP頭資訊來實現，功能代碼如下：

#!/usr/bin/python
# -*- coding: UTF-8 -*-

# HTTP 头部
print "Content-Disposition: attachment; filename=\"foo.txt\"";
print
# 打开文件
fo = open("foo.txt", "rb")

str = fo.read();
print str

# 关闭文件
fo.close()
←
→

PHP中文網

首頁首頁課程課程文章文章問答問答詞典詞典手册手册下載下載搜尋搜尋APP下載 APP下載
變數名稱#描述