CGI工房:TOPに戻る


CGI Programing
with Perl




目 次

1.はじめに
2.Perlを使ってCGIを利用するために
2.1 Perlのパス指定
2.2 ヘッダの出力
2.3 もっとも簡単なCGIスクリプト
3.変数の利用
3.1 変数のデータ型
3.2 変数の種類
3.3 変数への値の代入
3.4 引用符
4.引数の渡し方(URLで指定)
4.1 URLで指定してパラメータを渡す
4.2 複数の引数の渡し方
5.ブラウザからの引数の渡し方
5.1 フォームから送信
5.2 METHOD="get"とMETHOD="post"
5.3 フォーム処理のCGI例(METHOD="get"の場合)
5.4 フォーム処理のCGI例(METHOD="post"の場合)
6.一歩進んだフォーム処理
6.1 METHODの判別処理
6.2 フォームの個数に左右されない処理
7.サブルーチンの利用
7.1 サブルーチンの定義
7.2 サブルーチンへの引数の渡し方
8.フォームを利用したCGIの作り方
8.1 処理の流れ
8.2 処理の例

1.はじめに
CGIそのものはWWWサーバー上で実行できるプログラムであれば何でも利用できますが、一般には、スクリプト言語のPerlを利用することがほとんどです。そこで、Perlを使ったCGIスクリプトの作成方法について解説してみたいと思います。

なお、最初にお断りしておきますが、ここでの解説は、CGIに必要なPerlスクリプトの書き方の説明が主体になっています。ホームページにどう設置するかについては、
「First Step CGI」をご覧下さい。
戻る
2.Perlを使ってCGIを利用するために

2.1 Perlのパス指定
まず利用するPerlのフルパスをスクリプトの先頭に記述します。Perlのパスはプロバイダによって異なることがありますので、分からない場合は問い合わせてください。一般的なUNIX系のWWWサーバは(aikisの場合も)、次のようになります。
    #! /usr/local/bin/perl
2.2 ヘッダの出力
PerlでCGIを利用するとき、実行した結果をブラウザにHTML文書として認識させるためのヘッダ出力をする必要があります。実際には作成するスクリプトに、次の1行を追加します。
    print "Content-type: text/html\n\n";
この1行がないと、HTML文書と送信されず、サーバーエラーを起こすことがあります。ちなみに、このような指定にはGIFやJPEG画像などもあり、カウンタなどのプログラムでは画像を送る前に、それぞれのデータ形式にあったヘッダ情報をブラウザに対して送っているのです。
2.3 もっとも簡単なCGIスクリプト
ブラウザに、単に「Hellow World!」と表示するだけのサンプルです。1行目でPerlのパスを、2行目でヘッダ情報を出力したあと、3行目以降でHTML文書のソースを出力しているだけです。

【ファイル名:test1.cgi】 #! /usr/local/bin/perl print "Content-type: text/html\n\n"; # HTML出力のおまじない print "<HTML>\n<HEAD>\n"; # ¥nは改行コード print "<TITLE>CGI-TEST</TITLE>\n"; print "<BODY>\n"; print "Hellow World!\n"; print "</BODY>\n</HTML>\n";
戻る
3.変数の利用
さて、上のtest1.cgiのように、同じ内容を表示するだけなら、わざわざCGIを使う必要などなく、直接HTML文書でその内容を表示すれよいはずです。CGIを使う以上、条件に応じて処理をしたいもので、Perlでも、変数を使って処理をすることができます。
3.1 変数のデータ型
Perlで変数を用いるにあたって、使用できるデータ型は、主に3つあります。
いずれも厳密なデータ型の区別がなく、その点ではC言語などと比べると非常に気楽にプログラミングできますが、その分プログラマが十分に把握しておく必要があります。
3.2 変数の種類
Perlでの変数は、適当な変数名に $, @, % を前につけることで利用できます。
 $   スカラ変数   ふつうの変数 
 @   配列変数   要素を数字で指定 
 %   連想配列変数   要素を文字列で指定 

変数名は、英字または_(アンダースコア)で始まり、英数字または_で構成される単語になります。

【変数の例】
 $dasy   単なるスカラ変数 
 $days[11]   配列 @daysの 11番目の要素 
 $days{'Feb'}   連想配列の要素の一つ 
 $#days   配列 @daysの最後の添え字 
3.3 変数への値の代入
先ほどの変数には、全て値を代入することができます。代入は、変数を左辺値にして = で値を代入します。ある変数を別な変数に代入することもできますし、引用符で囲んだ文字列などを代入することもできます。
3.4 引用符
Perlの引用符は2種類あり、それぞれ ""(ダブルコーテーション)と、''(シングルコーテーション)の2つになります。この2つのちがいは、文字列の中に含まれる変数に値を代入するか、そのまま文字列とみなすかのちがいです。 "の場合は引用符の中で変数の値を展開しますが ' の場合は変数展開を行いません

変数については、ほかにも色々と規則がありますが、詳しくはPerlのマニュアルなりを参照してください。
戻る
4.引数の渡し方(URLで指定)
さて、変数が使えるだけでもプレーンなHTML文書にはないホームページを作ることができますが、次の段階としては、CGIにパラメータを渡し、そのパラメータを処理して表示していきたいものです。そこで、CGIでパラメータを処理する方法について解説します。
4.1 URLで指定してパラメータを渡す
CGIにパラメータを渡す方法はいくつかありますが、まずはURLで指定する方法を紹介します。

    http://www.hogehoge.com/~hogehoge/hogehoge.cgi?Hellow World!

このように、CGIスクリプトに ? で区切ってパラメータを続けることで、CGIスクリプトにパラメータを渡すことができます。このとき、?以下のパラメータは環境変数 QUERY_STRING に格納されます。それをCGI側で取得すればよいのです。

    $buffer = $ENV{'QUERY_STRING'};

これを処理するCGIスクリプトは以下のようになります。

【ファイル名:test2.cgi】 #! /usr/local/bin/perl $buffer = $ENV{'QUERY_STRING'}; # 引数を$bufferに格納する print "Content-type: text/html\n\n"; # HTML出力のおまじない print "<HTML>\n<HEAD>\n"; # \nは改行コード print "<TITLE>CGI-TEST</TITLE>\n"; print "<BODY>\n"; print "$buffer\n"; print "</BODY>\n</HTML>\n";
4.2 複数の引数の渡し方
CGIスクリプトに複数のパラメータを渡したい時、MS-DOSプログラムのようにスペースで区切って渡す方法は使えません。このような場合、CGIでは複数のパラメータを一つのパラメータにまとめ、1つの引数としてわたす方法を使います。つまり、適当な区切り文字を使ってパラメータを1つにまとめ、それをスクリプト側で分解することで個々のパラメータを取得するわけです。

パラメータ文字列の分解には split()関数を使用します。

次の例は、半角カンマを区切り文字にして、4つのパラメータをわたす方法です。
    http://www.hogehoge.com/~hogehoge/
          test3.cgi?Chuki,Computer,Circle,Language section,

【ファイル名:test3.cgi】 #! /usr/local/bin/perl $buffer = $ENV{'QUERY_STRING'}; # 引数を$bufferに格納する print "Content-type: text/html\n\n"; # HTML出力のおまじない print "<HTML>\n<HEAD>\n"; # \nは改行コード print "<TITLE>CGI-TEST</TITLE>\n"; print "<BODY>\n"; ($arg1,$arg2,$arg3,$arg4) = split( /,/ , $buffer ); # ,(カンマ)で分割 print "$arg1 $arg2, $arg3, $arg4\n"; print "</BODY>\n</HTML>\n";
戻る
5.ブラウザからの引数の渡し方
これまでの説明で、URLの中にパラメータとなる文字列を含めてCGIスクリプトに引数を渡す方法を紹介しましたが、次に、ブラウザのHTML画面からパラメータをCGIに渡す方法を紹介します。
5.1 フォームから送信
HTML画面からパラメータを送る場合、フォームを使って、そこで入力されたパラメータをCGIスクリプトに渡します。

まず、次のようなフォーム入力するHTML文書があるとします。

【ファイル名:test4.html】 <HTML> <BODY> <FORM METHOD="get" ACTION="test4.cgi"> 第1パラメータ <INPUT TYPE="text" NAME="arg1" SIZE=20><BR> 第2パラメータ <INPUT TYPE="text" NAME="arg2" SIZE=20><BR> <INPUT TYPE="submit" VALUE="送信"> </FORM> </BODY> </HTML>
このHTML文書で、ブラウザ上には2つの入力フォームが表示されますが、ここに適当な文字列を入力して[送信]を押すと、以下のようなURLでCGIが呼び出されます。
    http://www.hogehoge.com/~hogehoge/
          test4.cgi?arg1=INPUT1&arg2=INPUT2

それぞれのフォームはフォーム名と内容が = で区切られ、さらにそれが & で区切られた形になっています。このことから、まず & を区切りに各フォームごとに分解し、さらに = で分解してパラメータを取得します。

このほか、フォームからのデータの送信には以下のような特徴がありますので、CGIスクリプト側で対応する必要があります。(この方法は後でとりあげます)
5.2 METHOD="get"とMETHOD="post"
フォームからCGIにデータを送信する際に、送信形式(METHOD)が2種類あり、それぞれに送信の手順が異なります。いずれの場合もフォームの内容自体は、=と&で区切られた形でCGIに渡されますが、その内容がどのように受け渡しされるかが大きく異なります。

上の例は METHOD="get"を使っている例ですが、この時引数はURLで指定した時と同じように、環境変数 QUERY_STRING に格納され、それを参照することでスクリプトに取り込みます。

一方、METHOD="post"を使った場合、引数列は標準入力としてサーバーからCGIスクリプトに渡される事になります。(このためサーバーが METHOD="post"をサポートしている必要があります)

この2つには、格納形式の違いの他に以下のような特徴があります。

これらのことから、CGIでは通常METHOD="post"を使うことが多いのです。
5.3 フォーム処理のCGI例(METHOD="get"の場合)
6.1のHTML文書のフォームで、METHOD="get"で送られてくるパラメータを処理するCGIスクリプトは次のようになります。

【ファイル名:test4.cgi】 #! /usr/local/bin/perl $buffer = $ENV{'QUERY_STRING'}; # 引数を$bufferに格納する ($arg1,$arg2) = split( /&/ , $buffer ); #パラメータごとに分割 ($name1,$value1) = split( /=/ , $arg1 ); #フォーム名と内容に分割 ($name2,$value2) = split( /=/ , $arg2 ); # 〃 $value1 =~ tr/+/ /; # フォーム形式の + を、スペースに変換 $value2 =~ tr/+/ /; # 〃 # フォーム形式の特殊文字・漢字を変換する処理 $value1 =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C", hex($1))/eg; $value2 =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C", hex($1))/eg; print "Content-type: text/html\n\n"; # HTML出力のおまじない print "<HTML>\n<HEAD>\n"; # \nは改行コード print "<TITLE>CGI-TEST</TITLE>\n"; print "<BODY>\n"; print "第1パラメータ = $value1\n"; print "第2パラメータ = $value2\n"; print "</BODY>\n</HTML>\n";
5.4 フォーム処理のCGI例(METHOD="post"の場合)
6.1のHTML文書のフォームで、METHOD="post"で送られてくるパラメータを処理するCGIスクリプトは次のようになります。この場合、標準入力からパラメータを受け取る必要があるので、まず入力されるパラメータ文字列のサイズを、環境変数 CONTENT_LENGTH で取得し、そのサイズ分だけ標準入力から読みとります。

【ファイル名:test4.cgi(postバージョン)】 #! /usr/local/bin/perl $length = $ENV{'CONTENT_LENGTH'}; # パラメータ文字列の長さ read(STDIN, $buffer, $length ); # 長さ分だけ標準入力から読み込む ($arg1,$arg2) = split( /&/ , $buffer ); #パラメータごとに分割 ($name1,$value1) = split( /=/ , $arg1 ); #フォーム名と内容に分割 ($name2,$value2) = split( /=/ , $arg2 ); # 〃 $value1 =~ tr/+/ /; # フォーム形式の + を、スペースに変換 $value2 =~ tr/+/ /; # 〃 # フォーム形式の特殊文字・漢字を変換する処理 $value1 =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C", hex($1))/eg; $value2 =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C", hex($1))/eg; print "Content-type: text/html\n\n"; # HTML出力のおまじない print "<HTML>\n<HEAD>\n"; # ¥nは改行コード print "<TITLE>CGI-TEST</TITLE>\n"; print "<BODY>\n"; print "第1パラメータ = $value1\n"; print "第2パラメータ = $value2\n"; print "</BODY>\n</HTML>\n";
戻る
6.一歩進んだフォーム処理
実際のCGIでは、処理する内容に応じてMETHODが違ったり、渡したいパラメータの数や内容が異なります。このようなパラメータの数が処理する内容によって異なる場合でも、フォームから送られてきた内容を処理できる方法を紹介します。
6.1 METHODの判別処理
METHODがgetかpostかの判定は、環境変数 REQUEST_METHOD で判定できます。
実際の処理は以下のようになります。

if ($ENV{'REQUEST_METHOD'} eq "POST") { read(STDIN, $buffer, $ENV{'CONTENT_LENGTH'}); } else { $buffer = $ENV{'QUERY_STRING'}; }
6.2 フォームの個数に左右されない処理
@pairs = split(/&/,$buffer); # 各パラメータを配列に格納する foreach $pair (@pairs) { ($name, $value) = split(/=/, $pair); # フォーム名と値に分解 $value =~ tr/+/ /; $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C", hex($1))/eg; $FORM{$name} = $value; } この処理で、フォームからのパラメータは、$FORM{'フォーム名'}という連想配列に格納されます。なお、取り込んだパラメータの呼び出しは次のように行います。
  print "$FORM{'arg1'}\n";
  print "$FORM{'arg2'}\n";


実際にCGIスクリプトに組み込む場合は、上記の2種類の処理を1つのサブルーチンにまとめて、スクリプトの先頭部分で、そのサブルーチンを呼び出すようにすればよいでしょう。
戻る
7.サブルーチンの利用
さて、CGIスクリプトも少し長くなってくるとともに、毎回同じような処理も増えてきます。先ほどのフォーム処理などは特にそうでしょう。このような処理はサブルーチン化して呼び出す方がよいと思います。
7.1 サブルーチンの定義
Perlでサブルーチンを定義するのは以下のように行います。(先ほどのフォーム処理です)

sub form { if ($ENV{'REQUEST_METHOD'} eq "POST") { read(STDIN, $buffer, $ENV{'CONTENT_LENGTH'}); } else { $buffer = $ENV{'QUERY_STRING'}; } @pairs = split(/&/,$buffer); # 各パラメータを配列に格納する foreach $pair (@pairs) { ($name, $value) = split(/=/, $pair); # フォーム名と値に分解 $value =~ tr/+/ /; $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C", hex($1))/eg; $FORM{$name} = $value; } }
スクリプト内でこのサブルーチンを呼び出す時は、サブルーチン名に & をつけて呼び出します。
    &form;
これを、CGIプログラムの先頭に記入するだけで$FORMの内容をつかむことが出来ます。
7.2 サブルーチンへの引数の渡し方
サブルーチンに引数を渡したいとき、呼び出し側ではごく一般的な方法で呼び出します。
    &hogehoge( a, b, c, d );
この時引数の各要素は、Perlの予約変数配列の @_ すなわち、$_[0], $_[1}, $_[2],,,に格納されます。したがって、上の例では次のように格納されます。
    $_[0] = a;
    $_[1] = b;
    $_[2] = c;
    $_[3] = d;
戻る
8.フォームを利用したCGIの作り方
ブラウザのフォームを利用してCGI処理を行う場合、どのように処理の流れを考えて行くのか、また、その方法はどうすればよいのか、などについて紹介します。

例として、次のようなHTML文書を出力するCGIとその処理を考えます。(内容は自動登録ができるリンクスクリプトとでもしましょうか)このフォームから送られてくるデータの処理を考えます。

<HTML> <HEAD> <TITLE>自動リンクシステム</TITLE> </HEAD> <BODY> <FORM METHOD="post" ACTION="test5.cgi"> <SELECT NAME="task"> <OPTION VALUE="-">機能の選択  </OPTION> <OPTION VALUE="list">リンクの表示</OPTION> <OPTION VALUE="regist">リンクの登録</OPTION> <OPTION VALUE="delet">リンクの削除</OPTION> <OPTION VALUE="edit">リンクの削除</OPTION> </SELECT> <INPUT TYPE="submit" VALUE="送信"> </FORM> </BODY> </HTML>
8.1 処理の流れ
まず、フォームを利用したCGIの特徴は、(極端な意見ではありますが)『HTML画面を出力した時点でプログラムは一度終了している。』という事ではないかと思います。

つまり、このCGIで必要な最初の処理は、『機能の選択』画面を出力する事ですが、この画面を終了した時点でスクリプトの処理も終わっている事になります。リンクを表示したり、登録・削除・編集といった各機能を処理したくても、スクリプトはすでに終了しているのです。

そこで、このような場合、次にする処理内容が何かをパラメータとしてCGIに送り直して処理をすすめる方法を使うことでこの問題を解決します。上の例では、フォーム名 task が次のスクリプトの動作を蹴ってするパラメータになっています。taskの内容に応じて処理を振り分ければよいのです。

このCGIの場合の流れを見てみます。
  1. CGIスクリプトが実行される
  2. フォームのからのパラメータの取得
  3. $FORM{'task'}の内容がない場合(初めて実行の時など)は『機能選択画面』へ
  4. $FORM{'task'}にパラメータが入力されている場合、その内容に応じて処理
8.2 処理の例
少し長くなりますが、処理の例を紹介します。

【ファイル名:test5.cgi】 #! /usr/local/bin/perl &form; # フォームデータの取得 if ($FORM{'task'} eq "list") { &list; } # リスト表示ルーチンへ elsif ($FORM{'task'} eq "regist") { &regist; } # 登録ルーチンへ elsif ($FORM{'task'} eq "delet") { &delet; } # 削除ルーチンへ elsif ($FORM{'task'} eq "edit") { &edit; } # 編集ルーチンへ else { &main; } # メイン画面へ #--------------------------- # フォームデータの取得 #--------------------------- sub form { if ($ENV{'REQUEST_METHOD'} eq "POST") { read(STDIN, $buffer, $ENV{'CONTENT_LENGTH'}); } else { $buffer = $ENV{'QUERY_STRING'}; } @pairs = split(/&/,$buffer); # 各パラメータを配列に格納する foreach $pair (@pairs) { ($name, $value) = split(/=/, $pair); # フォーム名と値に分解 $value =~ tr/+/ /; $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C", hex($1))/eg; $FORM{$name} = $value; } } #--------------------------- # 通常の「機能の選択画面」 #--------------------------- sub main { print "Content-type: text/html\n\n"; # HTML出力のおまじない print "<HTML>\n<HEAD>\n"; # ¥nは改行コード print "<TITLE>自動リンクシステム</TITLE>\n"; print "<BODY>\n\n"; print "<FORM METHOD="post" ACTION="test5.cgi">\n"; print "<SELECT NAME="task">\n print " <OPTION VALUE="-">機能\の選択  </OPTION>\n"; print " <OPTION VALUE="list">リンクの表示</OPTION>\n"; print " <OPTION VALUE="regist">リンクの登録</OPTION>\n"; print " <OPTION VALUE="delet">リンクの削除</OPTION>\n"; print " <OPTION VALUE="edit">リンクの削除</OPTION>\n"; print "</SELECT>\n"; print "<INPUT TYPE="submit" VALUE="送信">\n"; print "</FORM>\n"; print "</BODY>\n</HTML>\n"; exit; # プログラム終了 } #--------------------------- # リンクの表示 #--------------------------- sub list { # # 処理を記述 # exit; # プログラム終了 } #--------------------------- # リンクの登録 #--------------------------- sub regist { # # 処理を記述 # exit; # プログラム終了 } #--------------------------- # リンクの削除 #--------------------------- sub delet { # # 処理を記述 # exit; # プログラム終了 } #--------------------------- # リンクの編集 #--------------------------- sub edit { # # 処理を記述 # exit; # プログラム終了 }
戻る
CGI工房 (98/06/01)