hail2u.net

不明なflavour回避パッチの問題点

Posted at 2006-10-05T00:19:00+09:00 in Blosxom

かなり前に書いた不明なflavourというエントリで紹介したパッチは概ねうまく機能しているのだけど、検索エンジンなどで意図しないURLが検索結果に出てきてしまうことがあるという問題が。通常は多くのページでリンクを張られている.htmlで終わるURLの方が圧倒的に強く、Web全体からの検索などではあまり問題にならないが、サイト内検索などではかなりゴミとして目立ってしまう。ので、redirectif_noflavourを使い、存在しないflavourの場合は.htmlで終わるURLにリダイレクトさせることにした。

redirectif_noflavourはflavourが見つからなかった場合、設定で指定したflavourのURLに302 Foundでリダイレクトさせるというプラグイン。301 Moved Permanentlyを使いたかったり、設定させなくても$blosxom::default_flavour使えば良さそうと思ったので、

# Blosxom Plugin: redirectif_noflavour
# Author(s): motormean, Kyo Nagashima <kyo@hail2u.net>
# Version: 2006-10-04
# Blosxom Home/Docs/Licensing: http://www.blosxom.com/

package redirectif_noflavour;

use strict;

# --- Configurable variables -----------

# --- Plug-in package variables --------

# --------------------------------------

sub start {
  1;
}

sub skip {
  my $path = $blosxom::path_info;

  do {
    return 0 if -e "$blosxom::datadir/$path/story.$blosxom::flavour";
  } while ($path =~ s/(\/*[^\/]*)$// and $1);

  $path = $blosxom::path_info;
  $path =~ s/\..+?$/.$blosxom::default_flavour/;
  $blosxom::header->{-status} = '301 Moved Permanently';
  $blosxom::header->{-Location} = "$blosxom::url/$path";
  $blosxom::output = '';

  return 1;
}

1;

と、少しだけ改造した。自前でflavourを漁らなくても何とかなりそうな気はする。けどコード考えるのがめんどくさい。303 See Otherのが良いかな？微妙だ。移動させたわけじゃないから303 See Otherのほうが妥当かもしれない。

こういうケースは404 Not Foundでももちろん良いと思う。というか本来は404 Not Foundであるべきなのだけど、301 Moved Permanently(などのリダイレクトするHTTPステータスコード)を使った方が訪問者を逃さないので、サイト・オーナー的にはプラスだと思う。訪問者にも(多くの場合は)プラスになるはず。

redirectif_noflavourは使いたくないけどerror flavourなページを検索エンジンに拾わせたくないなどという場合は、blosxom.cgiの最後のに書いてあるerror flavourの定義に、

<meta name="robots" content="noindex, nofollow" />

といったロボット対策のmeta要素を追加するとかが良さそう。

はてなブックマークでつけられたコメントをblosxomにインクルード

Posted at 2006-09-20T04:02:00+09:00 in Blosxom

はてなブックマークエントリー情報取得APIを利用して、blosxomのエントリ個別ページにはてなブックマークでそのエントリに付けられたコメントを引っ張ってこようとかいうネタ。blosxomでの話ということになっているけど、実装自体はほぼPure JavaScriptなので、どんなページにも応用できるはず。

プラグインは特に必要は無い。プラグインにする必要も無いとも言える。必要なのはflavourへのコードの追加とJavaScriptファイル。

head.html

<script type="text/javascript" src="/scripts/prototype.js"></script>
<script type="text/javascript" src="/scripts/hatena/bookmark.js"></script>

prototype.jsが必要。インクルードするだけ。

stoy.html

<?$path_info like="\.html$">
  <div class="story" id="comments">
    <h3>Comments</h3>
    <p>JavaScriptに対応または有効な環境の場合、ここに<a href="http://b.hatena.ne.jp/">はてなブックマーク</a>でのこのエントリに対するコメントが表示されます。</p>
  </div>
</?>

interplate_fancyが必要。$path_infoを利用して、エントリ個別ページかどうかを判別し、そうだった場合にコメントを流し込むためのノードを作っておくという感じ。

コメント表示スクリプト

bookmark.jsのみ。ソースが全てを物語る。はてなブックマークエントリー情報取得APIに対して一回リクエストすれば良いだけなので、単純な実装にした。HTMLの出力もinnerHTMLでガンガンぶっこんでいく形(今のところは)。

細かいことはあとで書く。かもしれない。とか書いておく時は大抵書かない。

interpolate_fancyプラグインの使い方

Posted at 2006-08-27T13:14:00+09:00 in Blosxom

手軽にblosxomのflavourシステムを強化することが出来るようになるinterpolate_fancyプラグインについて今さら書いてみようかとか。本当に今さらすぎて笑えない。今さらとはいえ、blosxomのflavourシステムを強化するプラグインとしてはこれくらいしか選択肢はないので書いておいても損ではないはず。

少し前にもちょっとだけ使い方を書いたけど、文字数稼ぎ興味を持てずに飛ばしてしまった人のために簡単に使い方を説明してみる。基本は、

<$foo /> = $foo
<?$foo>$fooがdefinedなら表示される</?>
<!?$foo>$fooがundefinedなら表示される</?>

の3つで、これらに加えて、

<?$foo eq="1">$fooが1なら表示される。</?>
<?$foo ne="1">$fooが1でないなら表示される。</?>
<?$foo lt="1">$fooが1より小さいなら表示される。</?>
<?$foo gt="1">$fooが1より大きいなら表示される。</?>
<?$foo like="^[a-z]$">$fooが正規表現^[a-z]$にマッチするなら表示される。</?>
<?$foo unlike="^[a-z]$">$fooが正規表現^[a-z]$にマッチしないなら表示される。</?>

などといった条件比較も可能。更に、他にインストールしているプラグインのサブルーチンを呼べたりとかもする。

以下に具体的な利用例を挙げてみる。

permalinkではタイトルにリンクを張らない

このblogのように、$path/$fn.htmlという形のpermalinkを採用している場合は、$path_infoが.htmlで終わっているかどうかを調べることによってpermalinkかどうかを判断できる。つまり、

<h3>
  <?$path_info unlike="\.html$">
    <a href="/blog$path/$fn.$default_flavour" title="&quot;$title&quot; への恒久的なリンク">
  </?>
  $title
  <?$path_info unlike="\.html$">
    </a>
  </?>
</h3>

というような書き方(見やすいように改行を入れている)をしてやれば、permalinkではタイトルにリンクが張られなくなる。else系の条件分岐が無いのでくだくだしい書き方。

文字列を保護する

blosxomのinterpolate()の仕様上、$yr-$mo_num-$daT$ti:00とか書いた場合、意図した通りに表示されない。しかし、適当な変数名を利用して、

$yr-$mo_num-$da<?$yr>T</?>$ti<?$yr>:</?>00+09:00

と、書くことができる。こうすると「T」や「:」が保護されるので、きちんと意図した通りに表示される。バッド・ノウハウ。

簡単な条件分岐を利用して都合よく体裁を整える

このサイトのトップ・ページに表示している最近のエントリ一覧を実現しているjs flavourで利用してたりします。story.jsの中身は、

<?$push_if_first::is_first eq="1">
  document.write('<h4><a href="$url$path/$fn.$default_flavour" title="&quot;$title&quot; への恒久的なリンク">$title</a></h4>');
  document.write('<p class="date">Posted at $yr-$mo_num-$da<?$yr>T</?>$ti<?$yr>:</?>00+09:00 in <a href="/blog$path/" title="&quot;$categories::name&quot; 関連のエントリを閲覧する">$categories::name</a></p>');
  document.write('<p>$rss::excerpt</p>');
  document.write('<p class="seemore"><a href="$url$path/$fn.$default_flavour" title="&quot;$title&quot; の全文を読む">&#187; Read full entry</a></p>');
  document.write('<ul>');
</?>

<?$push_if_first::is_first ne="1">
  document.write('<li><a href="$url$path/$fn.$default_flavour" title="$title Posted at $yr/$mo_num/$da ($dw) $ti in $categories::name">$title</a></li>');
</?>

と、push_if_firstプラグインと組み合わせることによって、最初のエントリの場合は概要まで表示しエントリ全文へのリンクを追加、それ以外の場合はタイトルをリストで並べるという形を実現している。

特定のエントリではwritebackを禁止する

特定のエントリということを判断させるためにmetaプラグインが必要になるが、作業的には面倒ではない。まず、writebackのフォームを表示しているstory.htmlなどで、

<?!$meta::nowriteback>
  <form ...>
  ...
  </form>
</?>

といったように、writebackのフォームをくくる。その上で、その特定のエントリに、

meta-nowriteback: 1

と書いておけば良い。metaプラグインはエントリに対してメタ・データを付与できるプラグインなので、こういったケースでもわかるようにinterpolate_fancyプラグインとは相性が良い。

禁止するというかフォームを表示させないだけ。指定の日数すぎたらwritebackを禁止するとかいう場合は、プラグインを書かないとならない(と思う)。例えば、現在の時間とエントリの時間の差を秒数で取得し、変数に格納するだけのプラグインをつくり、ltでその指定の日数を秒に変換した数字(30日なら2592000)と比較とか。

基本的には他のプラグインとうまく組み合わせてやると力を発揮するプラグインだと思う。また、逆に他のプラグイン側も条件分岐をinterpolate_fancy側に任せたりすることも可能なので、プラグインが多少書きやすくなる。これがデフォルトのinterpolate()だったらなぁ・・・とかは思っていても口に出してはいけない。

SourceForge.netで開発されているblosxomはv2.0.2に

Posted at 2006-08-21T07:31:00+09:00 in Blosxom

SourceForge.netで開発・公開されているblosxomは現在2.0.2になっています。一応、こちらも公式なもの。一応っていうのもヒドイ言い様だ。Raelさんから開発を引き継いだということになっているので、文句無く公式なもの・・・一応(アレ？)。まったく追いかけていなかったので、どんな感じか確認するついでに、all about blosxomの方へBlosxomAtSourceForgeというページを作っておいた。SourceForge.netで公開されているblosxomを使っている人は、気づいたことなんかがあったら書いてくれるとうれしい。

そこそこ手を入れられていますが、多くは静的生成における問題点の解消のようで、動的生成で利用している人にはあまり関係ないかなという感じ。ビルトイン・フレーバーを改行を利用して見やすく書くことができるようになってたりとかするのはちょっと良いかなと思うけど、多くの場合はそんなところを見もしないわけで。

元々blosxomにはこれといったバグはなく、大幅に手を入れるきっかけがないんだろうなと思う。UIとか多くの人が不満を持ちやすく、そして手を入れやすい部分が元々存在しないことなんかも手を入れるきっかけがないことの理由のひとつかも。挙動的にはほぼパーフェクトと感じているユーザーがほとんど、そしてちょっとした不満ならばプラグインでほぼどうにでもなると思うので、そういった点でも手をいれにくそう。

パフォーマンスの面で改善の余地がもちろんあるのだろうけど、そこに手を入れるとなるとフラット・ファイルがデータベースなことが問題視されてしまうと思う。フラット・ファイルじゃなくなったら、互換性が保たれたり変換ツールが登場しようと、それはもうblosxomではないと多くの人が感じるだろうから、ここにはどうしても手は付けられない。

むしろ思い切って静的生成を削除したものを公開しても面白そうかなとか思った。あくまでもブランチとしてだけど。そしてそれをベースに変数の拡張(デバッグに使える変数とか欲しい)などを中心にガリガリいじってみようみたいな。静的生成は動かすOSの問題とかが表面化しがちなので開発しづらいし。開発MLに投げてみようかな。投げるだけならタダ。

blosxom starter kitをSourceForge.netで配布されているものをベースに作り直すという予定は今のところない。多分そのまんま差し替えるだけで良いと思うのだけど。

英語化しようとしたのも今となっては「それいつの夢？」みたいな。

paging plugin更新 #8

Posted at 2005-09-30T20:54:00+09:00 in Blosxom

pagingにより生成された各ページは、当然ですが、コロコロ中身が変わります。つまり中身の保証がないので、検索エンジンにインデックスして貰いたくないページであるとも言えます(多くの人には)。というわけで2ページ目以降、つまりpage=2とかパラメータが付く場合はmeta要素でロボット除外を指示するようにとかいう機能を追加してみました。

head.htmlなどに$paging::meta_robotsと記述することによってロボット除外meta要素が出力されます。なので、$paging::meta_robotsをflavourに記述しなければこれまでどおりの動作です。

なお、ロボットの巡回による負荷への対策にはなりません(多分)。巡回による負荷対策はrobots.txtでやった方が良さげというか、robots.txtじゃないとムリそう。ページングのナビゲーションのa要素のrel属性にnofollowを追加するとかだといけるかも？

ついでにXHTMLで出力するかどうかも設定可能にしておいたり。

バグ報告や機能改善要望、機能追加要望は、BBSやMLなどでお気軽にどうぞ。