静的ファイル構築時のプラグインフック

Serene Bach 3.00beta020 より静的ファイル構築時に呼び出されるプラグイン (以下、ビルド用プラグイン) 向けにエントリーポイントが追加されました。

ビルド用プラグインは、以下のタイミングで呼び出されます。

• sb::Build オブジェクト生成時 (initialize)
• 記事ファイル生成・更新時 (prebuild_entry & postbuild_entry)
• コメント・トラックバック受信後の記事ファイル更新時 (prebuild_receipt & postbuild_receipt)
• 全再構築時 (prebuild_all & postbuild_all)
• トップページ生成・更新時 (prebuild_top & postbuild_top)

sb::Build オブジェクト生成時以外は prebuild_xxx と postbuild_xxx のモードがあり、それぞれ静的ファイル生成前後に呼ばれます。

ビルド用プラグインは、Serene Bach プラグイン API 「register_extra_module」を通して登録します。

sb::Plugin->register_extra_module(
  'type'     => 'build',
  'callback' => \&_callback, # コールバックのリファレンス
);

登録したコールバックには、sb::Build のインスタンス、モード、場合によってターゲットとなっている記事オブジェクトが引き渡されます。

sub _callback
{
  my $builder = shift; # sb::Build インスタンス
  my $mode = shift; # モード / initialize, xxx_entry, xxx_top, xxx_receipt, xxx_all
  my $obj  = shift; # ターゲット記事オブジェクト (xxx_entry or xxx_receipt)
  # 以下、コード
}

ターゲット記事オブジェクトは、記事ファイル生成・更新時ないしコメント・トラックバック受信時のみセットされます。

ビルド用プラグインのサンプル

以下のサンプルプラグインは、静的ファイル生成時にデバッグ出力を行なうシンプルなビルド用プラグインです。

package sb::Plugin::BuildSample;
use sb::Plugin ();
# --------------------------------------
sb::Plugin->register_plugin(
  'lang' => {
    'ja' => 'utf8',
    'en' => 'ascii',
  },
  'text' => {
    'type'    => 'build',
    'name'    => 'sample plugin for build',
    'text'    => 'sample plugin for build',
    'author'  => 'takkyun',
    'detail'  => 'http://serenebach.net/',
    'version' => version(),
  },
  'file' => undef,
  'data' => undef,
);
sb::Plugin->register_extra_module(
  'type'     => 'build',
  'callback' => \&_callback,
);
sub version
{
  return '0.00';
}
# --------------------------------------
sub _callback
{
  my $builder = shift;
  my $mode = shift; # initialize, xxx_entry, xxx_top, xxx_receipt, xxx_all
  my $obj  = shift; # target entry object (xxx_entry or xxx_receipt)
  return if ( $mode eq 'initialize' );
  sb->debug('[build] ' . $mode . ' ... ' . $obj . "\n");
}
1;