DSAS開発者の部屋

Apache は，リクエストを処理する上で細かくフェーズを設定して，その各フェーズで様々な処理を行います．Apache のモジュールの開発は，そのモジュールが目的の処理をする上で適切なフェーズに Apache の処理が至ったときに，Apache から呼び出してもらうための関数(hook 関数)を作ることと，そのモジュールが動作するための設定を行う関数を作ること，になります．

フェーズには，例えばそのリクエストを受け付けるか拒否するかを決めるフェーズや，リクエストされた URI と実際のディスク上のファイルとの間の対応付けを解決するフェーズ，そしてもちろん実際のレスポンスを生成するフェーズ等があります．hook 関数を挿入するポイントはこれらのフェーズになりますが，もちろんその全てのフェーズのための関数を用意する必要はありません．また個別の設定を施す必要がなければ，設定用の関数も定義する必要ありません．なので，もっとも小規模なモジュールでは，hook 関数を一つと，hook 関数を Apacheに登録するための関数が必要ですからもう一つ，都合二つの関数を定義すれば済みます．Apache の標準モジュールである mod_asis モジュールも，そのような関数が二つだけ定義されたモジュールです．

さて，モジュール開発の始め方ですが，Apache をインストールした時に一緒にインストールされている，apxs コマンドを使います．以下の話は全て Linux 上で実行した場合の話です．このコマンドは Apache のモジュール開発を取り仕切るコマンドで，新しいモジュールを作る時のソースファイルのテンプレートを出力してくれたり，モジュールをコンパイルしてくれたりする，とても便利なものです．
テンプレートを出力するには

 apxs -g -n test

 Makefile  mod_test.c  modules.mk

  #include "httpd.h"

  #include "http_config.h"

  #include "http_protocol.h"

  #include "ap_config.h"



  /* The sample content handler */

  static int test_handler(request_rec *r)

  {

      if (strcmp(r->handler, "test")) {

          return DECLINED;

      }



      r->content_type = "text/html";

      if (!r->header_only)

          ap_rputs("The sample page from mod_test.c\n", r);



      return OK;

  }



  static void test_register_hooks(apr_pool_t *p)

  {

      ap_hook_handler(test_handler, NULL, NULL, APR_HOOK_MIDDLE);

  }



  /* Dispatch list for API hooks */

  module AP_MODULE_DECLARE_DATA test_module = {

      STANDARD20_MODULE_STUFF,

      NULL,                  /* create per-dir    config structures */

      NULL,                  /* merge  per-dir    config structures */

      NULL,                  /* create per-server config structures */

      NULL,                  /* merge  per-server config structures */

      NULL,                  /* table of config file commands       */

      test_register_hooks    /* register hooks          */

  };

これをコンパイルするには，mod_test.c と一緒に生成された Makefile を使って make するか，apxs コマンドを使います．
make する場合は，単に make すればコンパイルできます． install ターゲットを指定すれば，コンパイルが成功したら続けて，できあがった DSO ファイルを modules ディレクトリにコピーしてくれます．
apxs コマンドを使う場合は，

 apxs -c mod_test.c

 apxs -c -i mod_test.c 

 apxs -c -i -a mod_test.c 

 <Location "/hoge/">

   SetHandler test

 </Location>

 The sample page from mod_test.c

さて，このリクエストに先程コンパイルしたモジュールを結びつけているのが，httpd.conf に追加した

 <Location "/hoge/">

   SetHandler test

 </Location>

如何でしょうか．意外と簡単じゃないですか? 今回はさわりだけでしたが，稿を改めて他のフェーズでの処理の話や実際にモジュールを書く上で便利なライブラリの話などを書いてみたいと思います．

参考文献:

• Apache の処理の流れに関してはここのページに書いてあります．
  
• hook 登録関数の一覧はこちらのページの最後の方にあります．が，説明が一文づつしかないのでちょっと物足りないです．