Perl CGI プログラミング


CGIとは

CGIは現在NCSAによって管理されています。NCSAはCGIを次のように定義しています:

CGI(Common Gateway Interface、共通ゲートウェイインターフェース)は、サーバー上で動作するプログラムです。例えばHTTPサーバー上で動作し、クライアントのHTMLページとのインターフェースを提供します。


Webブラウジング

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スクリプトを実行する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>サンプル(example.com)</title>'; print '</head>'; print '<body>'; print '<h2>Hello Word! </h2>'; print '<p>来自サンプル第一个 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メソッド

以下は、GETメソッドを使用してtest.cgiプログラムに2つのパラメータを送信する簡単なURLです:

/cgi-bin/test.cgi?name=サンプル&url=http://www.example.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>サンプル(example.com)</title>'; print "</head>"; print "<body>"; print "<h2>$nameURL:$url</h2>"; print "</body>"; print "</html>"; 1;

ブラウザで確認すると、出力結果は次のようになります:

シンプルなフォームの例:GETメソッド

以下はHTMLフォームを使用してGETメソッドでサーバーに2つのデータを送信する例です。送信先のサーバースクリプトも同じくtest.cgiファイルです。test.htmlのコードは次のとおりです:

test.html ファイルコード

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>サンプル(example.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>サンプル(example.com)</title>'; print "</head>"; print "<body>"; print "<h2>$name网址:$url</h2>"; print "</body>"; print "</html>"; 1;

以下はHTMLフォームを使用してGETメソッドでサーバーに2つのデータを送信する例です。送信先のサーバースクリプトも同じくtest.cgiファイルです。test.htmlのコードは次のとおりです:

test.html コード

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>サンプル(example.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は1つまたは複数のオプションデータを送信するために使用します。test.htmlのコードは次のとおりです:

test.html コード

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>サンプル(example.com)</title> </head> <body> <form action="/cgi-bin/test.cgi" method="POST" target="_blank"> <input type="checkbox" name="サンプル" value="on" />サンプル<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{サンプル} ){ $サンプル_flag ="ON"; }else{ $サンプル_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>サンプル(example.com)</title>'; print "</head>"; print "<body>"; print "<h2> サンプル选中状态 :$サンプル_flag</h2>"; print "<h2> Google 选择状态 :$google_flag</h2>"; print "</body>"; print "</html>"; 1;

ブラウザでの実行結果は次のようになります:


CGIプログラムによるRadioデータの送信

Radioはサーバーに1つのデータのみを送信します。test.htmlのコードは次のとおりです:

test.html コード

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>サンプル(example.com)</title> </head> <body> <form action="/cgi-bin/test.cgi" method="post" target="_blank"> <input type="radio" name="site" value="サンプル" />サンプル<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>サンプル(example.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>サンプル(example.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>サンプル(example.com)</title>'; print "</head>"; print "<body>"; print "<h2>入力されたテキストの内容:</h2>$text_content</h2>"; print "</body>"; print "</html>"; 1;

ブラウザでの実行結果は次のようになります:


CGIプログラムによるドロップダウンデータの送信

HTMLドロップダウンボックスのコードは次のとおりです:

test.html コード

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>サンプル(example.com)</title> </head> <body> <form action="/cgi-bin/test.cgi" method="post" target="_blank"> <select name="dropdown"> <option value="サンプル" selected>サンプル</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>サンプル(example.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.example.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.サンプル.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モジュールが用意されており、よく使用されるものは以下の2つです:

その他の拡張