Implement CGI in your httpd
author : Kevin Lynx
Purpose
為我們的http server加入CGI的功能,并不是要讓其成為真正響應CGI query功能的web server。正如klhttpd的開發初衷一樣,
更多的時候我們需要的是一個嵌入式(embeded)的web server。
而加入CGI功能(也許它算不上真正的CGI),則是為了讓我們與client擁有更多的交互能力。我們也許需要為我們的應用程序
加入一個具有網頁外觀的界面,也許這才是我的目的。
Brief
CGI,common gateway interface,在我看來它就是一個公共約定。客戶端瀏覽器提交表單(form)操作結果給服務器,服務器
解析這些操作,完成這些操作,然后創建返回信息(例如一個靜態網頁),返回給瀏覽器。
因為瀏覽器遵循了CGI發送請求的標準,那么我們所要做的就是解析收到的請求,處理我們自己的邏輯,返回信息給客戶端即可。
Detail...
如果你要獲取CGI的更多信息,你可以在網上查閱相關信息。如果你要獲取web server對CGI標準的處理方式,我無法提供給你
這些信息。不過我愿意提供我的臆測:
處理CGI請求通常都是由腳本去完成(當然也可以用任何可執行程序完成)。就我所獲取的資料來看,只要一門語言具備基本的
輸入輸出功能,它就可以被用作CGI腳本。瀏覽器以key-value的形式提交query string,一個典型的以GET方式提交query string的
URL類似于:http://host/cgi-bin/some-script.cgi?name=kevin+lynx&age=22。不必拘泥于我上句話中出現的一些讓你產生問號的
名詞。我可以告訴你,這里舉出的URL(也許更準確的說法是URI)中問號后面的字符串即為一個query string。
我希望你看過我的上一篇草文<實現自己的http server>,你應該知道一個典型的GET請求時怎樣的格式,應該知道什么是initial
line,應該知道HTTP請求有很多method,例如GET、POST、HEAD等。
一個CGI請求通常使用GET或POST作為其request method。對于一個GET類型的CGI請求,一個典型的request類似于:
GET /cgi-bin/some-script.cgi?name=kevin+lynx&age=22 HTTP/1.1
other headers...
...
我上面舉例的那個URL則可能出現在你的瀏覽器的地址欄中,它對我們不重要。
而對于POST類型的CGI請求呢?query string只是被放到了optional body里,如:
POST /cgi-bin/some-script.cgi HTTP/1.1
other heads...
...
name=kevin+lynx&age=22
不管我說到什么,我希望你不要陷入概念的泥潭,我希望你能明確我在brief里提到的what can we do and how to do。
How about the web browser ?
我總是想引領你走在實踐的路上(on the practice way)。作為一個程序員,你有理由自負,但是你沒任何理由小覷任何一個
編程問題。打開你的編譯器,現在就敲下main。
so,我們需要知道如何利用我們的瀏覽器,讓我們更為順手地實踐我們的想法。
你也許會寫:<html><head><title>HTML test</title></head><body>it's a html</body></html>這樣的HTML標記語言。但是
這沒有利用上CGI。check out the url in the reference section and learn how to write FORMs.
這個時候你應該明白:
<html>
<head>
<title>CGI test</title>
</head>
<body>
<FORM ACTION="./cgi-bin/test.cgi">
<INPUT TYPE="text" NAME="name" SIZE=20 VALUE="Your name">
</FORM>
</body>
</html>

加入<FORM>來添加表單,加入<INPUT TYPE="text"加一個edit box控件。那么當你在里面輸入名字按下回車鍵時,瀏覽器將整理
出一個CGI query string發給服務器。
我希望你能在瀏覽器里看到以問號打頭的key-value形式的字符串。
So here we go...
在你自己已有的http server的代碼基礎上,讓瀏覽器來請求一個包含FORM的網頁,例如以上我舉例的html。當瀏覽器將請求發
給服務器的時候,看看服務器這邊收到的request。即使你猜到了什么,我也建議你看看,這樣你將看到一個真正的CGI query是怎么
樣的。
so you know,CGI請求本質上也就是一連串的key-value字符串。真正的http server會將這些字符串傳給CGI腳本。腳本只需要
輸出處理結果信息到標準輸出,服務器就會收集這些輸出然后發給客戶端。
你也許在揣摩,我們的httpd如何地exec一個外部程序或腳本,如何等待腳本執行完(需不需要異步?),然后如何收集標準輸
出上的信息,然后是否需要同步地將這些信息送往客戶端。
這很沒必要。如果我們的http server真的只是被embeded到其他程序的。我們只需要將query的邏輯處理交給上層模塊即可。
What's the next..
現在你知道什么是CGI query string,你也許稍微思考下就知道接下來你該如何去做(if you smart enough)。記住我們的目標,
只是解析CGI query string,然后處理相關邏輯,返回處理結果信息給客戶端。
所以接下來,呃,接下來,everything is up to you:分析那些惱人的字符串,將其從&的間隔中整理出來,得到一個key-value
的表,將這個表給你的上層模塊,上層模塊根據query scritp決定執行什么邏輯,根據這個表獲取需要的參數,處理,將結果格式
化為HTML之類的東西,then response。
就這么簡單。
Example...
同樣,我提供了源碼,從而證明我不是紙上談兵夸夸其談。我希望我公開源碼的習慣能受到你的贊同。
下載帶CGI的http server.
Reference:
http://hoohoo.ncsa.uiuc.edu/cgi/ (獲取服務器需要做的)
http://www.ietf.org/rfc/rfc3875 (rfc cgi)
http://www.cmis.brighton.ac.uk/~mas/mas/courses/html/html2.html (學會寫帶FORM的HTML)