• cppgen.pl

Getopt::Compact モジュールを使用しています。ご利用の際にはそちらも合わせてインストールしてあげてください。

ツールの特徴としては以下のとおりです。

• 名前空間とクラス名を指定すると、それらから類推される名前でファイル名や include guard シンボル名を設定し、ひな形を生成する。これらの指定は必須。
  • 名前空間は 1階層にしか対応してません…。
• doxygen フォーマット (javadoc 風) でコメントを付加。
  • -s オプションでクラスの概要 (@brief) を指定可能。省略した場合はクラス名を使用。
• クラスの public 継承、仮想クラス、インタフェースクラスに対応。
• Pimpl に対応 (構造体及びメンバ変数名は固定です…)。
• Boost.noncopyable に対応。
• コピーコンストラクタ、ムーブコンストラクタを自力実装するようにプレースホルダを設ける機能に対応。

使い方ですが、例えば以下のようにすると、

$ perl cppgen.pl -c Observer -d hoge -s 'オブザーバーインタフェース' -in
$ perl cppgen.pl -c Subject -d hoge -s 'サブジェクト抽象クラス' -vpn
$ perl cppgen.pl -c ConsoleView -d hoge -s 'コンソールビュー抽象クラス' -e Subject -p
$ perl cppgen.pl -c StaticText -d hoge -s 'コンソールに静的にテキストを表示するビュークラス' -e ConsoleView -p
$ perl cppgen.pl -c DateTime -d hoge -s '日時を扱うクラス' -pCM
$ perl cppgen.pl -c WatchController -d hoge -s '時計コントローラ' -e Observer -p
$ perl cppgen.pl -c ConsoleManager -d hoge -s 'コンソール操作管理クラス' -pn
$ ls
console-manager.cpp  console-view.h  date-time.h      static-text.h  watch-controller.cpp
console-manager.h    cppgen.pl       observer.h       subject.cpp    watch-controller.h
console-view.cpp     date-time.cpp   static-text.cpp  subject.h

以下のような構成でファイルが生成されます。

• Observer クラス … noncopyable なインタフェースクラス (observer.h のみ)
• Subject クラス … Pimpl を持つ noncopyable な抽象クラス (subject.h, subject.cpp)
• ConsoleView クラス … Subject を継承し、 Pimpl を持つ抽象クラス (console-view.h, console-view.cpp)
  • 他のクラスを継承するクラスは強制的に抽象クラスになります (デストラクタが virtual になる)。当たり前ですが…。
• StaticText クラス … ConsoleView クラスを継承し、 Pimpl を持つ抽象クラス (static-text.h, static-text.cpp)
• DateTime クラス … Pimpl を持ち、コピーコンストラクタ、ムーブコンストラクタのプレースホルダを持つクラス (date-time.h, date-time.cpp)
• WatchController クラス … Observer クラスを継承し、 Pimpl を持つ抽象クラス (watch-controller.h, watch-controller.cpp)
• ConsoleManager クラス … Pimpl を持つ noncopyable なクラス (console-manager.h, console-manager.cpp)

詳しくは -h オプションでヘルプを見るか、ソースを参照してください (^_^; 。

$ perl gencpp.pl -c DomNodeFromId -d hoge -t 'class NodeType' -ns 'ID を指定して DOM ノードを検索するラッパーオブジェクトクラス'

とかやると、以下の内容のヘッダファイル dom-node-from-id.h のみが生成されます。

/**
    @file   dom-node-from-id.h
    @brief  ID を指定して DOM ノードを検索するラッパーオブジェクトクラス定義  
*/
#ifndef HOGE_DOM_NODE_FROM_ID_H
#define HOGE_DOM_NODE_FROM_ID_H


namespace hoge {

/**
    @brief  ID を指定して DOM ノードを検索するラッパーオブジェクトクラス  
*/
template <class NodeType>
class DomNodeFromId {
    /// コピーコンストラクタ (使用禁止)
    DomNodeFromId(DomNodeFromId const&) = delete;
    /// コピー代入演算子 (使用禁止)
    DomNodeFromId & operator=(DomNodeFromId const&) = delete;
    /// ムーブコンストラクタ (使用禁止)
    DomNodeFromId(DomNodeFromId &&) = delete;
    /// ムーブ代入演算子 (使用禁止)
    DomNodeFromId & operator=(DomNodeFromId &&) = delete;

public:
    /**
        @brief  デフォルトコンストラクタ  
    */
    DomNodeFromId()
    {
        //TODO: デフォルト生成を行う処理の詳細をここに記述
    }
    /**
        @brief  デストラクタ  
    */
    ~DomNodeFromId() = default;
};

}   //namespace hoge

#endif  //HOGE_DOM_NODE_FROM_ID_H

見ての通り、 -n オプションと併用すると Boost.noncopyable を使用する代わりに、コピーやらムーブやらのあれこれを = delete しまくるコードが挿入されます。それから、デフォルトコンストラクタのプレースホルダはクラス定義内に確保され、デストラクタは = default で定義されます。

この他、 -CM オプションあたりが併用可能となっていますが、抽象クラスになるようなオプション (-vie) や、 Pimpl モード (-p) との併用はできません。

my @cap = $uri{$mkey} =~ /$ex_item->{match}{$mkey}{pattern}/    or next EX_MATCH_LOOP;
@vars{@{$ex_item->{match}{$mkey}{vars}}} = @cap
    if exists $ex_item->{match}{$mkey}{vars} && ref $ex_item->{match}{$mkey}{vars} eq 'ARRAY';

なんてコードを書いていて (何をやろうとしているのかは想像にお任せします… 別にプロプライエタリなコードじゃないし、いちいち擬似コード的に書き直すのも面倒なのでそのまま持って来ちゃいましたｗ)、ふと、ここでやっている正規表現のパターンにキャプチャが含まれていなかった場合、マッチするのに or の後に処理が流れてしまうことはないのかと疑問に思いました。

結論としては、上記のコードに問題はないようです (まだテストしてないけど)。以下のように、スモールケースで試してみると、リストコンテキストではパターンにキャプチャがない場合でも空リストを返すのではなく、 (1)、すなわち値 1 のみを持つリストを返してくれることが分かります。

$ perl -e '$x = "foo bar baz"; @s = $x =~ /bar/ or print "no match?\n"; print join(", ", @s), "\n"'
1
$ 

もちろん、キャプチャがある場合には、キャプチャリングされた値がリストとして返されます。

$ perl -e '$x = "foo bar baz"; @s = $x =~ /(b)(ar)/ or print "no match?\n"; print join(", ", @s), "\n"'
b, ar
$ 

Perl での開発で、自分で作っているモジュールのファイルと同じ場所にあるファイルを設定ファイルとして読み込みたい場合があります。その設定ファイルも Perl モジュールとして書いてしまうのはやり方としては悪くないのですが、単なる定数値の羅列としてではなく、 YAML などで書きたくなるような若干複雑な構造のファイルもあるので、その場合、ファイルの場所を特定する方法が必要になります。

読み込まれたモジュールファイルの場所は、 %INC 特殊変数に記録されています。キーに、モジュールのファイル名を指定すれば、そのファイルの場所を取得できます。

%perl -Mstrict -e 'print qq/$INC{"strict.pm"}\n/'
/usr/local/lib/perl5/5.8.9/strict.pm
%

モジュールファイルがカレントディレクトリにある場合、その値はキーと同じファイル名のみになるようです。

%INC はそのモジュールファイルの読み込みを開始する時点で既にセットされるようなので、自身のモジュールファイル内であれば、たとえ BEGIN 節であっても参照できます。

package Hoge;

BEGIN {
    print "$INC{'Hoge.pm'}\n";
}

1;

設定ファイルの場所を特定して読み込むのは、以下の要領で書けば実現できるでしょう。

package Hoge;
use strict;
use YAML;

BEGIN {
    my $conf_path = ($INC{'Hoge.pm'} =~ (m!^((?:.+/)?)Hoge.pm$!)[0] . '/conf.yml';
    my $yaml = LoadFile($conf_path);

    # ...処理...
}

# ...

1;

直接お金になる仕事ではないのですが、ここしばらく、某所の BBS を開発するため、 Perl をいじっております。正直、 .NET や JavaScript 、ケータイアプリの開発なんてことばかりやっておりますと、たまにいじる Perl が楽しくて楽しくて、ついついこっちばかりやってしまう、という日々がしばらく続いております。いかんですな。

で、こちらの開発がとりあえずキリの良いところまで進んだので、一旦お蔵入りにしようと思うのですが (といっても年単位で寝かせるわけではないですが)、その前にこれに関連する技術的なメモをしたためておこうかと思うのであります。

作っているのは、さくらの共有レンタルサーバーサービス上で動作する CGI なのですが、レンタルサーバの性質上、 CPAN から最新のモジュールを引っ張ってくることが出来るので、割とモダンチックなスタイルで開発できるのが強みだったりします。

ただ、レンタルサーバ上で動作確認する場合、 500 エラーになってもエラーログをすぐには参照できないので (さくらにメールで問い合わせすることは可能らしいですが…)、弊社サーバー上にも設置し、動作確認するようにしました。

弊社サーバーはさくらの VPS を利用しており、 CentOS5 で動いています。基本的にはソフトウェアの導入は yum から行っているのですが、その場合、 DBD::mysql を始めとした多くの CPAN モジュールが、かなり古いバージョンで導入されることになります。特に、 DBD::mysql は 3.0007 と極めて古く、Unicode を扱うのに必要不可欠な接続時オプション mysql_enable_utf8 が使えないといった弊害がありました。他にも、 DateTime がタイムゾーンを理解できないなど、いろいろと弊害があったため、 CPAN から最新版をインストールしようかと試みたのですが、そのままではほとんどのモジュールについてコンパイルが通らないなど、cpan コマンドからではインストールが出来ませんでした。

CPAN 自体を最新版に

まず、cpan コマンドとして動作する Bundle::CPAN モジュール自体が古いので、それを最新にしてしまいましょう。

$ sudo cpan -i Bundle::CPAN

さらに、導入済みのモジュールを最新版に一括して更新してしまいましょう。こちらは cpan コマンドからではうまくいかなかったので、 perl から。

$ sudo perl -MCPAN -e 'CPAN::Shell->install(CPAN::Shell->r)'

DBD::mysql のインストールには MySQL 自体のソースが必要

ここまでやっても、DBD::mysql のインストールはやっぱり失敗していて、古いバージョンのままです。

$ perl -MDBD::mysql -e 'print "$DBD::mysql::VERSION\n"'
3.0007
$

結論から言うと、DBD::mysql を make する際に、MySQL 自体のヘッダファイルを参照しており、単に yum から MySQL だけを入れた状態ではこのヘッダファイルが導入されていないために、コンパイルに失敗してしまいます。そこで、 MySQL の開発用リソースを導入するパッケージ mysql-devel を事前に入れておく必要があります。

$ sudo yum install mysql-devel
$ sudo cpan -i DBD::mysql

これで、最新の DBD::mysql のインストールが成功するはずです。

で、せっかくなので、試しに簡単なサンプルを作って動作確認をしてみました。

#include <iostream>
#include <fstream>
#include <string>

#include <boost/regex.hpp>

using namespace std;
using namespace boost;

void escapeHtml(const string &src, string &modified);

int main(int argc, char* argv[])
{
	for (int i = 1; i < argc; i++)
	{
		ifstream fin(argv[i]);
		if (fin.bad() || fin.fail())
		{
			cerr << argv[0] << ": Can't open " << argv[i] << "." << endl;
			continue;
		}
		while (!fin.eof())
		{
			string line;
			getline(fin, line);
			string modified;
			escapeHtml(line, modified);
			cout << modified << endl;
		}
	}
	
	return 0;
}

void escapeHtml(const string &src, string &modified)
{
	modified.clear();
	sregex_iterator last_it;
	for (sregex_iterator it(src.begin(), src.end(), regex("[<>&\"]")); it != sregex_iterator(); it++)
	{
		modified += it->prefix().str();
		string sub = (*it)[0].str();
		switch (sub[0])
		{
			case '<':	modified += "&lt;";		break;
			case '>':	modified += "&gt;";		break;
			case '&':	modified += "&amp;";	break;
			case '"':	modified += "&quot;";	break;
			default:	assert(0);	break;
		}
		last_it = it;
	}
	modified += last_it == sregex_iterator() ? src : last_it->suffix().str();
}

Boost.Regex の regex_iterator を用いたテストです。よーするに、コマンドに指定したファイルの HTML エスケープ処理を施してコンソールに書き出すプログラムです。

上記のプログラムを test.cpp などのファイル名で保存し、そのまま Visual Studio 2008 コマンドプロンプト上で

cl test.cpp

とやってみましたが、これだけではコンパイルできませんでした。どうやら、 Visual Studio のオプションダイアログでヘッダーファイルやライブラリの参照先ディレクトリを設定しても、その設定が参照されるのは Visual Studio の IDE からビルドを実行した場合のみのようです。あるいは、環境変数 INCLUDE や LIB を設定してあげればこれでコンパイルできるのかも知れません。その辺はまた追々調べてみますが、最終的には .configure に --boost-prefix といったようなオプションを設ける、といった形の対応になるのではないかとも思います。

ちなみに、これと同等の (しかもより確実に動作する) プログラムを Perl で記述すると、以下の通りになります (この書き方はしかし Unix 風環境限定ですが)。

#!/usr/bin/perl -p
s/[<>&"]/'&'.{qw(< lt > gt & amp " quot)}->{$&}.';'/eg;

うあー、やっぱりスクリプト言語は便利だなー (汗。

egtra 様、ご指摘感謝です。仰る通り、 string::getline() を使った方がスマートなので、その通りに修正させて頂きました。

自社開発で作ろうとしていた物が実は mod_perl に対応した Web アプリなのですが、そういえば mod_perl ってまともに弄ったこと無かったなぁとか思ったので、風邪も引いて頭も回らないことだし少し脱線するかとばかりに遊んでみました。

世間一般においてはちっともはやらない mod_perl 。かろうじて拾う話題もせいぜい Apache::Registry を用いた既存 CGI の高速化とかその程度の話で、本格的に Perl で Apache モジュールを作ろうみたいな話になると本を買うか英語で情報を探すしかなかったりするのが現状のようです (あるいはおいらの探し方が悪いのかも知れませんが…)。参考にしたのは mod_perl の公式サイトにあるドキュメントでした。

• mod_perl: mod_perl 2.0 Documentation

これ全体をぼえ～っと眺めてみても何から手をつければいいのかよくわからないのですが、この辺を見てみるとサンプルを見つけることができたので、これを参考に作ってみることにします。

動かす場所 (URI) を決める

とりあえず弊社の環境では test という名のサブドメインを設け、 http://test.harapeko.jp/aho にアクセスするとプログラムが実行できるということにしてみました。もちろん、サブドメインを設けるには、named (BIND) の設定追加と、 Apache 側の設定が必要です。

サブドメインとか面倒な人は、この辺は読み飛ばしちゃってください。BIND の設定については、ここでは省きます。

Apache 側の設定ですが、あとでここに mod_perl に関する設定も書き加えるので、 mod_perl.c モジュールが見える場所に記述するようにしてください (mod_perl.c を LoadModule している特別な設定ファイルがあるのであれば、その中に記述します)。

<IfModule mod_perl.c>

<VirtualHost *:80>
  ServerName test.harapeko.jp
  DocumentRoot /var/www/vhosts/test/htdocs
  ErrorLog logs/test-error_log
  CustomLog logs/test-access_log common
</VirtualHost>

</IfModule>

mod_perl モジュールとしてあほプログラムを書く

mod_perl モジュールとしてロードできるのは、@INC のパスが通ったディレクトリに置いてあるモジュールファイルだけです。つまり、通常は Cpan などから正規にインストールしたモジュールだけです。

ただ、 mod_perl の実行中は Apache の設定で ServerRoot に設定されているディレクトリにも @INC のパスが通るようなので、テスト目的でちょっとしたプログラムを書きたいだけならば、この配下にファイルを置いていけばいいでしょう。弊社の環境では /etc/httpd が ServerRoot に設定されているので、例えばモジュールのパッケージ名を MpTest::AhoAho にするのであれば、モジュールファイルは /etc/httpd/MpTest/AhoAho.pm とします。

以下、そのサンプルコードです。

package MpTest::AhoAho;

use strict;
use utf8;

use Encode;
use Apache2::RequestRec ();
use Apache2::RequestIO ();
use Apache2::Const -compile => qw( :common :http );

my $urlEncode;

sub handler {
	my $r = shift;
	$r->content_type( 'text/html; charset=UTF-8' );
	if ( $r->method eq 'GET' )
	{
		$r->print( encode( 'UTF-8', <<ENDLINE ) );
<html><head><title>あほあほ!!</title></head>
<body>
<h1>あほあほ!!</h1>
<form method="POST" action="${ \ $r->uri }">
<p>どう思いますか? &gt;<input type="text" name="hoge" size="50">
<input type="submit" value="送信"></p>
</body>
</html>
ENDLINE
	}
	elsif ( $r->method eq 'POST' )
	{
		my $length = $r->headers_in->{ 'Content-Length' };
		if ( $length > 1024 ){
			$r->status( Apache2::Const::HTTP_BAD_REQUEST );
			$r->print( encode( 'UTF-8', <<ENDLINE ) );
<html><head><title>話が長すぎじゃばっかも～～～ん!!!</title>
<body>
<h1>話が長すぎじゃばっかも～～～ん!!!</h1>
<p>1KB 以内に納めて来い!!</p>
<hr>
<p><a href="${ \ $r->uri }">もう一回?</a></p>
</body>
</html>
ENDLINE
			return Apache2::Const::OK;
		}
		my $buf;
		$r->read( $buf, $length ) == $length	or die '???';
		my $request = $urlEncode->( $buf );
		my $comment = "$request->{ hoge } としか言えない貴様はやっぱりあほだ!!!";
		$r->print( encode( 'UTF-8', <<ENDLINE ) );
<html><head><title>あほあほあほ!!!</title></head>
<body>
<h1>$comment</h1>

<p>
ENDLINE
		for ( 1 .. 1000 )
		{
			$r->print( encode( 'UTF-8', "$comment " ) );
		}
		$r->print( encode( 'UTF-8', <<ENDLINE ) );
</p>

<hr>
<p><a href="${ \ $r->uri }">もう一回?</a></p>

</body>
</html>
ENDLINE
	}
	return Apache2::Const::OK;
}

$urlEncode = sub {
	my $url = shift;
	my %map;
	for my $pair ( split /&/, $url )
	{
		my ( $name, $val ) = split /=/, $pair;
		$name =~ tr/+/ /;
		$name =~ s/%([\da-f][\da-f])/pack 'H2', $1/ieg;
		$name = decode( 'UTF-8', $name );
		$val =~ tr/+/ /;
		$val =~ s/%([\da-f][\da-f])/pack 'H2', $1/ieg;
		$val = decode( 'UTF-8', $val );
		$map{ $name } = $val;
	}
	return \%map;
};

1;
__END__

URI アクセスに応じてモジュールが動くように設定する

プログラムができたら、それを URI に関連づけます。先の手順でサブドメインの追加を行っていれば、その <VertualHost> ディレクティブの中に、以下のように設定を追加します。

<VirtualHost *:80>
  ServerName test.harapeko.jp
  DocumentRoot /var/www/vhosts/test/htdocs
  ErrorLog logs/test-error_log
  CustomLog logs/test-access_log common

  # 追加 --ここから
  PerlModule APR::Table  # 要らないかも。後述
  PerlModule MpTest::AhoAho
  <Location /aho>
    SetHandler modperl
    PerlResponseHandler MpTest::AhoAho
  </Location>
  # 追加 --ここまで
</VirtualHost>

これで設定完了です。 apache2ctl configtest (または /etc/init.d/httpd configtest 等) で設定ファイルの文法を確認したら、 apache2ctl restart (または /etc/init.d/httpd restart 等) で再起動しましょう。

実際に動いている物サンプル

実際に動いているサンプルです。もうなんて言うか激しくごめんなさい。 orz

解説

それでは解説です。まず、 Apache 側の設定ファイル中でキモになる記述は以下の部分です。

  PerlModule MpTest::AhoAho
  <Location /aho>
    SetHandler modperl
    PerlResponseHandler MpTest::AhoAho
  </Location>

PerlModule はモジュールをロードする宣言で、この行は実は無くても動きます。が、書いておくと Apache の起動時にロードしてコンパイルまで済ませておいてくれるので、多分早くなるんだと思います (多分ってなんだよ＞ヲレ)。

PerlResponseHandler は、Apache がクライアントにレスポンスを返す際に呼び出すハンドラモジュールを指定する宣言です。つまり、大雑把に言うと、ここで指定したモジュールの handler メソッドが、 URI アクセス時に呼び出されます。上記のサンプルではこの宣言は <Location /aho> ディレクティブ内に記述されているので、「/aho の URI にアクセスしてきた場合は、応答時に MpTest::AhoAho->handler を実行する」という意味になります。

SetHandler は PerlResponseHandler などのハンドラを指定する宣言を書く場所では必ず書いておく必要のある宣言です。引数は modperl と perl-script の 2種類があって、後者はレガシーなスクリプトとの互換性を重視するためか、プログラム中でそのまま使える print 関数や %ENV などにアクセスできるようになります。今回は敢えてそれができない modperl の方を選んでみました。

次にプログラムですが、内容的には GET アクセス時は質問ページを、 POST アクセス時は罵倒ページを表示するというただそれだけの物です。但し POST したデータが長すぎる (1KB を超える) 場合には自前でエラーを表示するようにしています (ちゃんと 400 Bad Request を返しているので、IE で試すと IE 謹製のエラー画面が表示されるはずです)。

use Apache2::* シリーズはいずれもほぼ必須と考えていいと思います。Apache2::RequestRec と Apache2::RequestIO は、ハンドラ内で最初に受け取るリクエストオブジェクトの各メソッドにアクセスできるようにするためのモジュールで、前者はステータス値や HTTP ヘッダー、環境変数などへのアクセス用、後者はコンテンツの入出力用です。例えば $r->method や $r->uri、 $r->headers_in などを参照したり、$r->content_type で出力用の Content-type: ヘッダーを設定したりするには Apache2::RequestRec が、 $r->print でコンテンツを出力したり、 $r->read で POST を入力したりするには Apache2::RequestIO がそれぞれ必要になります。

Apache2::Const モジュールは各種定数の定義です。引数リストで使用する定数を宣言できますが、その最初に '-compile' と入れておくと、定数名をグローバル名前空間に展開しません (その場合は、 Apache2::Const::HOGE_FUGA としてアクセスします)。

Apache はこのモジュールの handler 関数を呼び出し、最初の引数にリクエストオブジェクトを渡します。そして、自前の処理を実行しつつ、リクエストオブジェクトの各メソッドを適切に呼んであげてから、 Apache2::Const::OK を返してあげればいい、という流れです。あとは、API のリファレンスとにらめっこしつつ読みこなしていただければ、やっていることは大体解ると思います。

$r->headers_in メソッド呼び出しでエラーが発生する場合

ところで、 Apache 側の設定で、以下の行について説明していませんでしたが、

  PerlModule APR::Table  # 要らないかも。後述

この宣言は、 $r->headers_in メソッドにアクセスした際、以下のようなエラーが発生してしまうのを回避するためのものです。自宅で宅内サーバーにしているマシン@debian では発生しなかったのですが、会社サーバー@centos では発生するので、念のため付記しておきます。

[Mon Dec 29 18:47:51 2008] [error] [client 218.219.204.253] Can't locate object
method "FETCH" via package "APR::Table" at /etc/httpd/MpTest/AhoAho.pm line 32.\
n, referer: http://test.harapeko.jp/aho

この解決法については、以下のサイトを参考にしました。

• Re: [mp2] APR::Table FETCH method not found (reported when using $r->headers_in->{Cookie}