超簡単アクセスカウンタースクリプト

今日アクセス解析ページを見ていたら、2004年1月分の記録が無くなっていることに気づいた。

このページに付けている shinobi アクセス解析は、データを4か月分しか保存してくれない。このため、2004年1月分のカウントが消えてしまった。仕方がないので、アクセスカウンタを付けることにした。ただ、一般ユーザはそのページのヒット数なんて気にしないだろうから、管理者だけが数字を閲覧できるタイプのカウンタで十分だ。

この程度の要件ならすぐ作れそうと思ったので、アクセスカウンタスクリプトを自作してみた。単に数を数えられればそれでいいので、かなり簡素。flock による排他制御は考慮したけど、ファイル I/O エラー時の処理を組み込んでいないなど、かなり思い切った実装。

- ifame によるテキストアクセスカウンタ

iframe で呼び出して使う。アクセスされればされただけ計数する。

#!/usr/bin/perl
open(OUT, '+< /home/hiroaki/cgi-data/count.dat');
flock(OUT, 2);
my $cnt = <OUT>;
++$cnt;
seek(OUT, 0, 0);
print OUT $cnt;
truncate(OUT, tell(OUT));
close(OUT);
print "Content-Type: text/plain\n\n$cnt\n";

- img src で呼び出せる画像カウンタ

iframe よりも img src で呼び出してカウントできる画像カウンタの方がいいかな。カウント時は画像を返し、数字の閲覧時はテキストを返すカウンタにしよう。0から9までの数字部品を呼び出して数字文字列を組み上げるタイプの画像カウンタは手間がかかるので、カウント時はごく小さな単一の画像を返すだけとする。要するに Web バグと呼ばれるものだ。

カウント時の画像は、perl スクリプト中に png をシリアライズして埋め込んでおく。png はサイズを小さくするために、1 ピクセル * 1ピクセルの 白黒画像とし、url エンコードして文字列化する。base64 でもいいけど、デコードルーチンが url エンコードに比べて長いし、Perl モジュールも標準で入ってない環境があるので今回は見送り。

url エンコード。スペースを + に変換する部分は省略。

$ cat count.png |perl -pe 's/([^\w ])/"%".unpack("H2", $1)/eg;'
%89PNG%0d%0a%1a%0a%00%00%00%0dIHDR%00%00%00%01%00%00%00%01%01%00%00%00%007n%f9%24%00%00%00%0aIDAT%18%d3ch%00%00%00%82%00%81%a7%01%ba%10%00%00%00%00IEND%aeB%60%82

スクリプトに組み込み。

#!/usr/bin/perl
open(OUT, '+< /home/hiroaki/cgi-data/count.dat');
flock(OUT, 2);
my $cnt = <OUT>;
++$cnt;
seek(OUT, 0, 0);
print OUT $cnt;
truncate(OUT, tell(OUT));
close(OUT);

my $img = '%89PNG%0d%0a%1a%0a%00%00%00%0dIHDR%00%00%00%01%00%00%00%01%01%00%00%00%007n%f9%24%00%00%00%0aIDAT%18%d3ch%00%00%00%82%00%81%a7%01%ba%10%00%00%00%00IEND%aeB%60%82';
$img =~ s/%([0-9A-Fa-f][0-9A-Fa-f])/pack('H2', $1)/eg;
print "Content-Type: img/png\n\n$img\n";

html に記述して準備完了。

<img src="http://sonic64.hp.infoseek.co.jp/cgi-bin/c.cgi" height="0" width="0" alt="">

- 閲覧機能を組み込む

あ、そうだ。やっぱり数字の閲覧もできた方がいいな。別の cgi にしてもいいけど、この程度だったら path_info か Query String で分岐させるやり方で十分だね。

#!/usr/bin/perl

my $cnt_file = '/home/hiroaki/cgi-data/count.dat';
my %result;

if (defined($ENV{PATH_INFO}) and ($ENV{PATH_INFO} eq '/view')) {
  open(CNT, $cnt_file);
  flock(CNT, 1);
  my $cnt = <CNT>;
  close(CNT);

  $result{body} = $cnt;
  $result{header} = 'text/plain';
} else {
  open(CNT, "+< $cnt_file");
  flock(CNT, 2);
  my $cnt = <CNT>;
  ++$cnt;
  seek(CNT, 0, 0);
  print CNT $cnt;
  truncate(OUT, tell(OUT));
  close(CNT);

  my $img = '%89PNG%0d%0a%1a%0a%00%00%00%0dIHDR%00%00%00%01%00%00%00%01%01%00%00%00%007n%f9%24%00%00%00%0aIDAT%18%d3ch%00%00%00%82%00%81%a7%01%ba%10%00%00%00%00IEND%aeB%60%82';
  $img =~ s/%([0-9A-Fa-f][0-9A-Fa-f])/pack('H2', $1)/eg;
  $result{body} = $img;
  $result{header} = 'image/png';
}

printf("Content-Type: %s\n\n%s", $result{header}, $result{body});

- 数字閲覧時も計数した方が良いかなあ

一般的なカウンタは、ページ管理者がカウンタの数字を閲覧する時にも計数するのが普通のようだ。それに習って、このカウンタも数字閲覧時にもカウントするようにした。また、キャッシュされないようにする HTTP レスポンスヘッダも出力するようにした。

#!/usr/local/bin/perl

my $cnt_file = '../dat/count.dat';
my %result;

open(CNT, "+< $cnt_file");
flock(CNT, 2);
my $cnt = <CNT>;
++$cnt;
seek(CNT, 0, 0);
print CNT $cnt;
truncate(OUT, tell(OUT));
close(CNT);

if (defined($ENV{PATH_INFO}) and ($ENV{PATH_INFO} eq '/view')) {
  $result{body} = $cnt;
  $result{header} = 'text/plain';
} else {
  my $img = '%89PNG%0d%0a%1a%0a%00%00%00%0dIHDR%00%00%00%01%00%00%00%01%01%00%00%00%007n%f9%24%00%00%00%0aIDAT%18%d3ch%00%00%00%82%00%81%a7%01%ba%10%00%00%00%00IEND%aeB%60%82';
  $img =~ s/%([0-9A-Fa-f][0-9A-Fa-f])/pack('H2', $1)/eg;
  $result{body} = $img;
  $result{header} = 'image/png';
}

my $response = <<"__HERE__";
Cache-Control: no-cache
Pragma: no-cache
__HERE__

$response .= sprintf("Content-Type: %s\n\n%s", $result{header}, $result{body});
print $response;

最後に、shinobi がいままでカウントしてくれた Page View を count.dat に記述して完了。
閲覧は http://sonic64.hp.infoseek.co.jp/cgi-bin/c.cgi/view から。infoseek の広告が入っちゃってるけど、まあ気にしないことにする。