rubbos/app/httpd-2.0.64/docs/manual/developer/modules.html.ja.utf8

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="ja" xml:lang="ja"><head><!--
   4         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   5               This file is generated from xml source: DO NOT EDIT
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7       -->
   8 <title>モジュールの Apache 1.3 から Apache 2.0 への移植 - Apache HTTP サーバ</title>
   9 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  10 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  11 <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
  12 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  13 <body id="manual-page"><div id="page-header">
  14 <p class="menu"><a href="../mod/">モジュール</a> | <a href="../mod/directives.html">ディレクティブ</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">用語</a> | <a href="../sitemap.html">サイトマップ</a></p>
  15 <p class="apache">Apache HTTP サーバ バージョン 2.0</p>
  16 <img alt="" src="../images/feather.gif" /></div>
  17 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  18 <div id="path">
  19 <a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP サーバ</a> &gt; <a href="http://httpd.apache.org/docs/">ドキュメンテーション</a> &gt; <a href="../">バージョン 2.0</a> &gt; <a href="./">Developer Documentation</a></div><div id="page-content"><div id="preamble"><h1>モジュールの Apache 1.3 から Apache 2.0 への移植</h1>
  20 <div class="toplang">
  21 <p><span>Available Languages: </span><a href="../en/developer/modules.html" hreflang="en" rel="alternate" title="English">&nbsp;en&nbsp;</a> |
  22 <a href="../ja/developer/modules.html" title="Japanese">&nbsp;ja&nbsp;</a></p>
  23 </div>
  24
  25     <p>この文書は <code>mod_mmap_static</code> モジュールを Apache 2.0 用に移植した時に
  26     学んだ経験をもとに書いた、最初の手引き書です。まだまだ完全じゃないし、
  27     ひょっとすると間違っている部分もあるかもしれませんが、
  28     取っ掛りにはなるでしょう。</p>
  29 </div>
  30 <div id="quickview"><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#easy">簡単な変更点</a></li>
  31 <li><img alt="" src="../images/down.gif" /> <a href="#messy">もっと厄介な変更点…</a></li>
  32 </ul></div>
  33 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  34 <div class="section">
  35 <h2><a name="easy" id="easy">簡単な変更点</a></h2>
  36
  37     <h3><a name="cleanup" id="cleanup">クリーンナップ ルーチン</a></h3>
  38       <p>クリーンナップルーチンは <code>apr_status_t</code> 型である必要があります。
  39       そして、apr_status_t 型の値を返さなくてはなりません。
  40       クリーンナップ中のエラーを通知する必要がなければ、返り値は普通、
  41       <code>ARP_SUCCESS</code> です。たとえエラーを通知したとしても、
  42       すべてのコードがその通知をチェックしたり、
  43       エラーに応じた動作をするわけではないことに気をつけてください。</p>
  44
  45
  46
  47     <h3><a name="init" id="init">初期化ルーチン</a></h3>
  48
  49     <p>初期化ルーチンは処理全体から見てしっくりくるような意味を表すように、
  50     名前が変更されました。ですから、<code>mmap_init</code> から <code>mmap_post_config</code>
  51     のようにちょっと変更されました。
  52     渡される引数は大幅に変更され、次のようになりました。</p>
  53
  54       <ul>
  55         <li><code>apr_pool_t *p</code></li>
  56         <li><code>apr_pool_t *plog</code></li>
  57         <li><code>apr_pool_t *ptemp</code></li>
  58         <li><code>server_rec *s</code></li>
  59       </ul>
  60
  61
  62     <h3><a name="datatypes" id="datatypes">データ型</a></h3>
  63       <p>データ型のほとんどは <a href="http://apr.apache.org/">APR</a> に移されました。つまり、
  64       いくつかの名前が前述のように変更されています。
  65       施すべき変更点の簡単な一覧を以下に示します。</p>
  66
  67       <ul>
  68         <li><code>pool</code> becomes <code>apr_pool_t</code></li>
  69         <li><code>table</code> becomes <code>apr_table_t</code></li>
  70       </ul>
  71
  72 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  73 <div class="section">
  74 <h2><a name="messy" id="messy">もっと厄介な変更点…</a></h2>
  75
  76     <h3><a name="register-hooks" id="register-hooks">フックの登録</a></h3>
  77       <p>新しいアーキテクチャでは作成した関数を呼び出すのに
  78       一連のフックを使用します。このフックは、新しい関数
  79       <code>static void register_hooks(void)</code> を使って登録するよう、
  80       モジュールに書き足さなくてはなりません。
  81       この関数は、なにをすべきか一旦理解してしまえば、
  82       十分にわかりやすいものです。
  83       リクエストの処理のあるステージで呼び出さなくてはならない
  84       関数は登録する必要があります。ハンドラは登録する必要はありません。
  85       関数を登録できるフェーズはたくさんあります。
  86       それぞれのフェーズで、関数を呼び出す相対的な順番は、
  87       かなりの程度制御できます。</p>
  88
  89     <p>以下は、<code>mod_mmap_static</code> に追加したコードです:</p>
  90
  91       <div class="example"><pre>
  92 static void register_hooks(void)
  93 {
  94     static const char * const aszPre[]={ "http_core.c",NULL };
  95     ap_hook_post_config(mmap_post_config,NULL,NULL,HOOK_MIDDLE);
  96     ap_hook_translate_name(mmap_static_xlat,aszPre,NULL,HOOK_LAST);
  97 };</pre></div>
  98
  99     <p>ここでは呼びだすべき二つの関数を登録しています。一つは
 100     <code>post_config</code> ステージ用 (ほとんどすべてのモジュール
 101     はこれが必要です) で、もう一つは <code>translate_name</code> フェーズ用です。
 102     それぞれの関数は名前は違うけれども形式は同じであることに注意してください。
 103     それでは、形式はどのようになっているでしょうか?</p>
 104
 105       <div class="example"><p><code>
 106         ap_hook_<var>phase_name</var>(<var>function_name</var>,
 107         <var>predecessors</var>, <var>successors</var>, <var>position</var>);
 108       </code></p></div>
 109
 110     <p>三つの位置が定義されています…</p>
 111
 112       <ul>
 113         <li><code>HOOK_FIRST</code></li>
 114         <li><code>HOOK_MIDDLE</code></li>
 115         <li><code>HOOK_LAST</code></li>
 116       </ul>
 117
 118     <p>位置を定義するには、上記の「位置」を指定し、
 119     修飾子である「先行」と「後行」で手を加えます。
 120    「先行」「後行」は、呼ばれるべき関数のリストです。
 121    「先行」は関数の実行前に呼ばれるもので、
 122    「後行」は実行後に呼ばれるものです。</p>
 123
 124     <p><code>mod_mmap_static</code> の場合、<code>post_config</code>
 125     ステージでは必要ありませんが、
 126     <code>mmap_static_xlat</code> が core モジュールが名前の変換を実行した後に
 127     <strong>呼ばれなければなりません</strong>。
 128     そこで aszPre を使って <code>HOOK_LAST</code> の修飾子を定義しています。</p>
 129
 130
 131     <h3><a name="moddef" id="moddef">モジュールの定義</a></h3>
 132       <p>モジュールの定義を作成する際に注意しなければならない
 133       ステージの数は激減しています。古い定義は次のようになっていました。</p>
 134
 135       <div class="example"><pre>
 136 module MODULE_VAR_EXPORT <var>module_name</var>_module =
 137 {
 138     STANDARD_MODULE_STUFF,
 139     /* initializer */
 140     /* dir config creater */
 141     /* dir merger --- default is to override */
 142     /* server config */
 143     /* merge server config */
 144     /* command handlers */
 145     /* handlers */
 146     /* filename translation */
 147     /* check_user_id */
 148     /* check auth */
 149     /* check access */
 150     /* type_checker */
 151     /* fixups */
 152     /* logger */
 153     /* header parser */
 154     /* child_init */
 155     /* child_exit */
 156     /* post read-request */
 157 };</pre></div>
 158
 159     <p>新しい構造体はとってもシンプルです…</p>
 160       <div class="example"><pre>
 161 module MODULE_VAR_EXPORT <var>module_name</var>_module =
 162 {
 163     STANDARD20_MODULE_STUFF,
 164     /* create per-directory config structures */
 165     /* merge per-directory config structures  */
 166     /* create per-server config structures    */
 167     /* merge per-server config structures     */
 168     /* command handlers */
 169     /* handlers */
 170     /* register hooks */
 171 };</pre></div>
 172
 173     <p>このうちのいくつかは古いものから新しいものに直接読み替えられるもので、
 174     いくつかはそうではありません。どうすればいいのかを要約してみます。</p>
 175
 176     <p>直接読み替えられるステージ:</p>
 177
 178     <dl>
 179       <dt><code>/* ディレクトリ設定作成関数 */</code></dt>
 180       <dd><code>/* ディレクトリ毎設定構造体作成 */</code></dd>
 181
 182       <dt><code>/* サーバ設定作成関数 */</code></dt>
 183       <dd><code>/* サーバ毎設定構造体作成 */</code></dd>
 184
 185       <dt><code>/* ディレクトリ設定マージ関数 */</code></dt>
 186       <dd><code>/* ディレクトリ毎設定構造体マージ */</code></dd>
 187
 188       <dt><code>/* サーバ設定マージ関数 */</code></dt>
 189       <dd><code>/* サーバ毎設定構造体作成マージ */</code></dd>
 190
 191       <dt><code>/* コマンド・テーブル */</code></dt>
 192       <dd><code>/* コマンド apr_table_t */</code></dd>
 193
 194       <dt><code>/* ハンドラ */</code></dt>
 195       <dd><code>/* ハンドラ */</code></dd>
 196     </dl>
 197
 198     <p>古い関数の残りのものはフックとして登録されるべきです。
 199     現時点で次のようなフック・ステージが定義されています…</p>
 200
 201     <dl>
 202       <dt><code>ap_hook_post_config</code></dt>
 203       <dd>(以前の <code>_init</code> ルーチンが登録されるべき場所です)</dd>
 204
 205       <dt><code>ap_hook_http_method</code></dt>
 206       <dd>(リクエストから HTTP メソッドを取得します (互換用))</dd>
 207
 208       <dt><code>ap_hook_open_logs</code></dt>
 209       <dd>(特定のログのオープン)</dd>
 210
 211       <dt><code>ap_hook_auth_checker</code></dt>
 212       <dd>(リソースが権限を必要とするかどうかの確認)</dd>
 213
 214       <dt><code>ap_hook_access_checker</code></dt>
 215       <dd>(モジュール固有の制約の確認)</dd>
 216
 217       <dt><code>ap_hook_check_user_id</code></dt>
 218       <dd>(ユーザ ID とパスワードの確認)</dd>
 219
 220       <dt><code>ap_hook_default_port</code></dt>
 221       <dd>(サーバのデフォルト・ポートの取得)</dd>
 222
 223       <dt><code>ap_hook_pre_connection</code></dt>
 224       <dd>(処理の直前に必要なことを実行。ただし accept 直後に呼ばれる)</dd>
 225
 226       <dt><code>ap_hook_process_connection</code></dt>
 227       <dd>(プロトコルの処理)</dd>
 228
 229       <dt><code>ap_hook_child_init</code></dt>
 230       <dd>(子プロセル起動直後)</dd>
 231
 232       <dt><code>ap_hook_create_request</code></dt>
 233       <dd>(??)</dd>
 234
 235       <dt><code>ap_hook_fixups</code></dt>
 236       <dd>(応答内容の生成を変更するラスト・チャンス)</dd>
 237
 238       <dt><code>ap_hook_handler</code></dt>
 239       <dd>(応答内容の生成)</dd>
 240
 241       <dt><code>ap_hook_header_parser</code></dt>
 242       <dd>(モジュールにヘッダの照会をさせる。ほとんどのモジュールでは使われません。post_read_request を使います)</dd>
 243
 244       <dt><code>ap_hook_insert_filter</code></dt>
 245       <dd>(フィルタ・チェインにフィルタを挿入)</dd>
 246
 247       <dt><code>ap_hook_log_transaction</code></dt>
 248       <dd>(リクエストについての情報を記録する)</dd>
 249
 250       <dt><code>ap_hook_optional_fn_retrieve</code></dt>
 251       <dd>(オプションとして登録された関数の取得)</dd>
 252
 253       <dt><code>ap_hook_post_read_request</code></dt>
 254       <dd>(リクエストを読みこんだ後、他のフェーズの前に呼ばれる)</dd>
 255
 256       <dt><code>ap_hook_quick_handler</code></dt>
 257       <dd>リクエストの処理が始まる前に呼ばれる。キャッシュモジュールが
 258       使用している</dd>
 259
 260       <dt><code>ap_hook_translate_name</code></dt>
 261       <dd>(URI をファイル名に変換する)</dd>
 262
 263       <dt><code>ap_hook_type_checker</code></dt>
 264       <dd>(文書型の決定と設定。あるいはその片方)</dd>
 265     </dl>
 266
 267 </div></div>
 268 <div class="bottomlang">
 269 <p><span>Available Languages: </span><a href="../en/developer/modules.html" hreflang="en" rel="alternate" title="English">&nbsp;en&nbsp;</a> |
 270 <a href="../ja/developer/modules.html" title="Japanese">&nbsp;ja&nbsp;</a></p>
 271 </div><div id="footer">
 272 <p class="apache">Copyright 2009 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
 273 <p class="menu"><a href="../mod/">モジュール</a> | <a href="../mod/directives.html">ディレクティブ</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">用語</a> | <a href="../sitemap.html">サイトマップ</a></p></div>
 274 </body></html>