人気ページ一覧/リンク元一覧表示機能公開

改名しました^^;
現在このサイトに設置しているような、「人気ページ一覧/リンク元一覧」を任意のサイトに適用できるソフトウェアの version 0.1 を公開します。

Version 0.1 のダウンロード(新しいバージョンがある場合はトラックバックにて辿れます)
注意：ココログ以外に CGI を設置できる web スペースが必要です。

特徴

現状の特徴は、以下です。

1. ページ側への埋めこみが楽。
2. カウントから除外するコードを簡単に追加可能。
3. 同一視するページを指定可能。
   • 例えば、http://shin.txt-nifty.com/ と http://shin.txt-nifty.com/philosophical/ を同一視。
   • URL への "index.html" の有無などについても同一視が可能。
4. リンク元ランキングについては一つのスクリプトでリアルタイム反映。
5. リンク元ランキングを任意の箇所に埋めこみ可能。記事に埋めこめば、トップページの各記事毎に「この記事へのリンク元」を設置可能。
7. サイト内アクセスランキングについては記録/集計を分けている。ランキング表示は軽い。
8. リスティングする最大件数の指定が可能。
9. 集計は密かに web からキック可能^^;。

まぁ、自分の欲しい機能が優先されているので、検索キーワードの表示などは対応していませんが(リンク元にリスティングされた検索エンジンからの URL をクリックすれば見れるし)、逆に、検索以外からの訪問者、つまり「読者」や、他のサイトからのご紹介などのカウントが見えるようになっています。

アーカイブ内容

ダウンロードして展開すると、以下の構造になります。

設置方法

1. 設定の編集

ref.pl を編集します。テキストエディッタで開いて、以下の部分をご自身のサイトに合わせて修正してください。
以下はこのサイト用の修正例です。

2. CGI のアップロード

cgi ディレクトリ配下を丸ごと Web サーバの CGI 実行可能なディレクトリにアップロードしてください。
そして、各ファイルの属性を上記に示したように変更してください。

refer.js は、ココログ上でも別の Web サーバ上でも構いませんので、URL で参照可能な場所にアップロードしてください。
アップロードせずに、ここに設置したものの URL(=http://shin.txt-nifty.com/philosophical/refer.js) をそのまま参照しても構わないかと思います。

3. サイト側の設定

3-1. Web ページへ記録処理の設置

ココログの方は 3-4 へ進んでください。
以下のような行を任意の箇所に追加します。

3-2. 人気ページ一覧の表示処理

とりあえずは、飛ばしても構いません。
「人気ページ一覧」を表示するなら、サイト内のあらゆるページで表示される箇所(サイドバーなど)、あるいは、表示対象としたい各ページ上に以下の記述を追加します。

注意：UTF-8 以外の Web サイトへの設置に関して
上記の script による人気ページ一覧表示では、Web サイトが UTF-8 なページでなければ正常に動作しません。
UTF-8 以外のページに「人気ページ一覧」を表示したい場合は代わりに以下のような iframe の指定を追加してください。

3-3. リンク元一覧の表示処理の追加

飛ばしても構いません。
もし、一ページ中に複数のリンク元一覧を表示したい場合(blog 記事本文に埋めこみたい場合など)は、blog 記事中に以下の記述を追加してください。

3-4. ココログの場合の設置方法

上記の記録処理/一覧表示処理をココログに設置する場合の具体例です。

まず、タイプが「リンク」であるマイリストの作成を行います。
マイリストの設定で、「メモの表示」を「テキスト表示」に設定します。
ダミーの URL を記述して新しいリンクを作成し、「メモ」欄に以下のような記述を追加します。

マイリストをサイドバーに表示するように設定します。

4. 「人気ページ一覧」の更新

「人気ページ一覧」を表示しない人には無関係です。
「人気ページ一覧」はアクセスログを定期的に集計して生成しています。
「人気ページ一覧」の更新は、update_statistics.cgi を起動することで実行できます。
cron を設定するのがよいです。

私は以下のような crontab ファイルを作成して、

また、ブラウザから http://サーバ/cgi-bin/update_statistics.cgi?dummy
のようにダミーパラメタを付加した URL を叩くと手動更新ができます。

以上で設置は完了です。以下はおまけです。

スタイルの調整

リンク元一覧には class="referrer-list" が指定されています。
人気ページ一覧には id="statistics" が指定されています。
内部の A 要素のスタイルの方が優先されてしまいますが、これを元に多少の調整が可能です。
この辺は後のバージョンで改修するかもしれませんけど。

除外するアクセスなどのカスタマイズ

ref.pl の最後の方に、
need_recording_access
need_recording_ref
normalize
といった関数があります。これらを修正すると、人気ページ一覧/リンク元一覧にリスティングする URL を調整できます。
今はかなり説明不足な気もしますが、わかりにくい点がありましたらご質問くださいませ_o_。

注意点/問題点

JavaScript がオフになっているクライアントのアクセスは集計されません。
そのクライアントには表示もされません。
SSI などが利用できない環境に導入できることを優先しているため、SSI 版は今のところ対応予定はありません。

将来

とりあえず、集計から除外すべき物をブラッシュアップします。自分によるアクセスを完全に除外するようにしようかと。
その後は一つのシステムで複数サイトの面倒を見れるようにしようかな…。

謝辞

JavaScript での UTF-8 エンコードには、JavaScriptにおけるURLエンコードの処理のコードを使わせていただきました_o_。

その他

perl なんて嫌いなんですが、配布(特にココログユーザ)を念頭に置くと perl で書くしかなかったので perl です。
perl なコードは怪しい所があるかもしれませんです。変数のスコープもよく知らないで書いてるし^^;。
というわけで perl 慣れしていないコードです。ツッコミありましたらよろしくお願いいたします_o_。
設定を一ヶ所にまとめたかったから、ref.pl にほぼ全ての処理を突っ込むことになってしまった…。require した先の変数も取り込めるんでしょうか？＞識者
はっ!!…設定取得関数化すれば間違いなくうまくいくか…でも無駄に長くなるな…。