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" /><link rel="stylesheet" type="text/css" href="/style/css/prettify.css" /> 12<script src="/style/scripts/prettify.js" type="text/javascript"> 13</script> 14 15<link href="/images/favicon.ico" rel="shortcut icon" /></head> 16<body id="manual-page"><div id="page-header"> 17<p class="menu"><a href="/mod/">モジュール</a> | <a href="/mod/directives.html">ディレクティブ</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="/glossary.html">用語</a> | <a href="/sitemap.html">サイトマップ</a></p> 18<p class="apache">Apache HTTP サーバ バージョン 2.2</p> 19<img alt="" src="/images/feather.gif" /></div> 20<div class="up"><a href="./"><img title="<-" alt="<-" src="/images/left.gif" /></a></div> 21<div id="path"> 22<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP サーバ</a> > <a href="http://httpd.apache.org/docs/">ドキュメンテーション</a> > <a href="../">バージョン 2.2</a> > <a href="./">Developer Documentation</a></div><div id="page-content"><div id="preamble"><h1>モジュールの Apache 1.3 から Apache 2.0 への移植</h1> 23<div class="toplang"> 24<p><span>翻訳済み言語: </span><a href="/en/developer/modules.html" hreflang="en" rel="alternate" title="English"> en </a> | 25<a href="/ja/developer/modules.html" title="Japanese"> ja </a></p> 26</div> 27<div class="outofdate">この日本語訳はすでに古くなっている 28 可能性があります。 29 最近更新された内容を見るには英語版をご覧下さい。 30 </div> 31 32 <p>この文書は <code>mod_mmap_static</code> モジュールを Apache 2.0 用に移植した時に 33 学んだ経験をもとに書いた、最初の手引き書です。まだまだ完全じゃないし、 34 ひょっとすると間違っている部分もあるかもしれませんが、 35 取っ掛りにはなるでしょう。</p> 36</div> 37<div id="quickview"><ul id="toc"><li><img alt="" src="/images/down.gif" /> <a href="#easy">簡単な変更点</a></li> 38<li><img alt="" src="/images/down.gif" /> <a href="#messy">もっと厄介な変更点…</a></li> 39</ul><ul class="seealso"><li><a href="#comments_section">コメント</a></li></ul></div> 40<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 41<div class="section"> 42<h2><a name="easy" id="easy">簡単な変更点</a></h2> 43 44 <h3><a name="cleanup" id="cleanup">クリーンナップ ルーチン</a></h3> 45 <p>クリーンナップルーチンは <code>apr_status_t</code> 型である必要があります。 46 そして、apr_status_t 型の値を返さなくてはなりません。 47 クリーンナップ中のエラーを通知する必要がなければ、返り値は普通、 48 <code>ARP_SUCCESS</code> です。たとえエラーを通知したとしても、 49 すべてのコードがその通知をチェックしたり、 50 エラーに応じた動作をするわけではないことに気をつけてください。</p> 51 52 53 54 <h3><a name="init" id="init">初期化ルーチン</a></h3> 55 56 <p>初期化ルーチンは処理全体から見てしっくりくるような意味を表すように、 57 名前が変更されました。ですから、<code>mmap_init</code> から <code>mmap_post_config</code> 58 のようにちょっと変更されました。 59 渡される引数は大幅に変更され、次のようになりました。</p> 60 61 <ul> 62 <li><code>apr_pool_t *p</code></li> 63 <li><code>apr_pool_t *plog</code></li> 64 <li><code>apr_pool_t *ptemp</code></li> 65 <li><code>server_rec *s</code></li> 66 </ul> 67 68 69 <h3><a name="datatypes" id="datatypes">データ型</a></h3> 70 <p>データ型のほとんどは <a href="http://apr.apache.org/">APR</a> に移されました。つまり、 71 いくつかの名前が前述のように変更されています。 72 施すべき変更点の簡単な一覧を以下に示します。</p> 73 74 <ul> 75 <li><code>pool</code> becomes <code>apr_pool_t</code></li> 76 <li><code>table</code> becomes <code>apr_table_t</code></li> 77 </ul> 78 79</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 80<div class="section"> 81<h2><a name="messy" id="messy">もっと厄介な変更点…</a></h2> 82 83 <h3><a name="register-hooks" id="register-hooks">フックの登録</a></h3> 84 <p>新しいアーキテクチャでは作成した関数を呼び出すのに 85 一連のフックを使用します。このフックは、新しい関数 86 <code>static void register_hooks(void)</code> を使って登録するよう、 87 モジュールに書き足さなくてはなりません。 88 この関数は、なにをすべきか一旦理解してしまえば、 89 十分にわかりやすいものです。 90 リクエストの処理のあるステージで呼び出さなくてはならない 91 関数は登録する必要があります。ハンドラは登録する必要はありません。 92 関数を登録できるフェーズはたくさんあります。 93 それぞれのフェーズで、関数を呼び出す相対的な順番は、 94 かなりの程度制御できます。</p> 95 96 <p>以下は、<code>mod_mmap_static</code> に追加したコードです:</p> 97 98 <div class="example"><pre> 99static void register_hooks(void) 100{ 101 static const char * const aszPre[]={ "http_core.c",NULL }; 102 ap_hook_post_config(mmap_post_config,NULL,NULL,HOOK_MIDDLE); 103 ap_hook_translate_name(mmap_static_xlat,aszPre,NULL,HOOK_LAST); 104};</pre></div> 105 106 <p>ここでは呼びだすべき二つの関数を登録しています。一つは 107 <code>post_config</code> ステージ用 (ほとんどすべてのモジュール 108 はこれが必要です) で、もう一つは <code>translate_name</code> フェーズ用です。 109 それぞれの関数は名前は違うけれども形式は同じであることに注意してください。 110 それでは、形式はどのようになっているでしょうか?</p> 111 112 <div class="example"><p><code> 113 ap_hook_<var>phase_name</var>(<var>function_name</var>, 114 <var>predecessors</var>, <var>successors</var>, <var>position</var>); 115 </code></p></div> 116 117 <p>三つの位置が定義されています…</p> 118 119 <ul> 120 <li><code>HOOK_FIRST</code></li> 121 <li><code>HOOK_MIDDLE</code></li> 122 <li><code>HOOK_LAST</code></li> 123 </ul> 124 125 <p>位置を定義するには、上記の「位置」を指定し、 126 修飾子である「先行」と「後行」で手を加えます。 127 「先行」「後行」は、呼ばれるべき関数のリストです。 128 「先行」は関数の実行前に呼ばれるもので、 129 「後行」は実行後に呼ばれるものです。</p> 130 131 <p><code>mod_mmap_static</code> の場合、<code>post_config</code> 132 ステージでは必要ありませんが、 133 <code>mmap_static_xlat</code> が core モジュールが名前の変換を実行した後に 134 <strong>呼ばれなければなりません</strong>。 135 そこで aszPre を使って <code>HOOK_LAST</code> の修飾子を定義しています。</p> 136 137 138 <h3><a name="moddef" id="moddef">モジュールの定義</a></h3> 139 <p>モジュールの定義を作成する際に注意しなければならない 140 ステージの数は激減しています。古い定義は次のようになっていました。</p> 141 142 <div class="example"><pre> 143module MODULE_VAR_EXPORT <var>module_name</var>_module = 144{ 145 STANDARD_MODULE_STUFF, 146 /* initializer */ 147 /* dir config creater */ 148 /* dir merger --- default is to override */ 149 /* server config */ 150 /* merge server config */ 151 /* command handlers */ 152 /* handlers */ 153 /* filename translation */ 154 /* check_user_id */ 155 /* check auth */ 156 /* check access */ 157 /* type_checker */ 158 /* fixups */ 159 /* logger */ 160 /* header parser */ 161 /* child_init */ 162 /* child_exit */ 163 /* post read-request */ 164};</pre></div> 165 166 <p>新しい構造体はとってもシンプルです…</p> 167 <div class="example"><pre> 168module MODULE_VAR_EXPORT <var>module_name</var>_module = 169{ 170 STANDARD20_MODULE_STUFF, 171 /* create per-directory config structures */ 172 /* merge per-directory config structures */ 173 /* create per-server config structures */ 174 /* merge per-server config structures */ 175 /* command handlers */ 176 /* handlers */ 177 /* register hooks */ 178};</pre></div> 179 180 <p>このうちのいくつかは古いものから新しいものに直接読み替えられるもので、 181 いくつかはそうではありません。どうすればいいのかを要約してみます。</p> 182 183 <p>直接読み替えられるステージ:</p> 184 185 <dl> 186 <dt><code>/* ディレクトリ設定作成関数 */</code></dt> 187 <dd><code>/* ディレクトリ毎設定構造体作成 */</code></dd> 188 189 <dt><code>/* サーバ設定作成関数 */</code></dt> 190 <dd><code>/* サーバ毎設定構造体作成 */</code></dd> 191 192 <dt><code>/* ディレクトリ設定マージ関数 */</code></dt> 193 <dd><code>/* ディレクトリ毎設定構造体マージ */</code></dd> 194 195 <dt><code>/* サーバ設定マージ関数 */</code></dt> 196 <dd><code>/* サーバ毎設定構造体作成マージ */</code></dd> 197 198 <dt><code>/* コマンド・テーブル */</code></dt> 199 <dd><code>/* コマンド apr_table_t */</code></dd> 200 201 <dt><code>/* ハンドラ */</code></dt> 202 <dd><code>/* ハンドラ */</code></dd> 203 </dl> 204 205 <p>古い関数の残りのものはフックとして登録されるべきです。 206 現時点で次のようなフック・ステージが定義されています…</p> 207 208 <dl> 209 <dt><code>ap_hook_post_config</code></dt> 210 <dd>(以前の <code>_init</code> ルーチンが登録されるべき場所です)</dd> 211 212 <dt><code>ap_hook_http_method</code></dt> 213 <dd>(リクエストから HTTP メソッドを取得します (互換用))</dd> 214 215 <dt><code>ap_hook_open_logs</code></dt> 216 <dd>(特定のログのオープン)</dd> 217 218 <dt><code>ap_hook_auth_checker</code></dt> 219 <dd>(リソースが権限を必要とするかどうかの確認)</dd> 220 221 <dt><code>ap_hook_access_checker</code></dt> 222 <dd>(モジュール固有の制約の確認)</dd> 223 224 <dt><code>ap_hook_check_user_id</code></dt> 225 <dd>(ユーザ ID とパスワードの確認)</dd> 226 227 <dt><code>ap_hook_default_port</code></dt> 228 <dd>(サーバのデフォルト・ポートの取得)</dd> 229 230 <dt><code>ap_hook_pre_connection</code></dt> 231 <dd>(処理の直前に必要なことを実行。ただし accept 直後に呼ばれる)</dd> 232 233 <dt><code>ap_hook_process_connection</code></dt> 234 <dd>(プロトコルの処理)</dd> 235 236 <dt><code>ap_hook_child_init</code></dt> 237 <dd>(子プロセス起動直後)</dd> 238 239 <dt><code>ap_hook_create_request</code></dt> 240 <dd>(??)</dd> 241 242 <dt><code>ap_hook_fixups</code></dt> 243 <dd>(応答内容の生成を変更するラスト・チャンス)</dd> 244 245 <dt><code>ap_hook_handler</code></dt> 246 <dd>(応答内容の生成)</dd> 247 248 <dt><code>ap_hook_header_parser</code></dt> 249 <dd>(モジュールにヘッダの照会をさせる。ほとんどのモジュールでは使われません。post_read_request を使います)</dd> 250 251 <dt><code>ap_hook_insert_filter</code></dt> 252 <dd>(フィルタ・チェインにフィルタを挿入)</dd> 253 254 <dt><code>ap_hook_log_transaction</code></dt> 255 <dd>(リクエストについての情報を記録する)</dd> 256 257 <dt><code>ap_hook_optional_fn_retrieve</code></dt> 258 <dd>(オプションとして登録された関数の取得)</dd> 259 260 <dt><code>ap_hook_post_read_request</code></dt> 261 <dd>(リクエストを読みこんだ後、他のフェーズの前に呼ばれる)</dd> 262 263 <dt><code>ap_hook_quick_handler</code></dt> 264 <dd>リクエストの処理が始まる前に呼ばれる。キャッシュモジュールが 265 使用している</dd> 266 267 <dt><code>ap_hook_translate_name</code></dt> 268 <dd>(URI をファイル名に変換する)</dd> 269 270 <dt><code>ap_hook_type_checker</code></dt> 271 <dd>(文書型の決定と設定。あるいはその片方)</dd> 272 </dl> 273 274</div></div> 275<div class="bottomlang"> 276<p><span>翻訳済み言語: </span><a href="/en/developer/modules.html" hreflang="en" rel="alternate" title="English"> en </a> | 277<a href="/ja/developer/modules.html" title="Japanese"> ja </a></p> 278</div><div class="top"><a href="#page-header"><img src="/images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">コメント</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div> 279<script type="text/javascript"><!--//--><![CDATA[//><!-- 280var comments_shortname = 'httpd'; 281var comments_identifier = 'http://httpd.apache.org/docs/2.2/developer/modules.html'; 282(function(w, d) { 283 if (w.location.hostname.toLowerCase() == "httpd.apache.org") { 284 d.write('<div id="comments_thread"><\/div>'); 285 var s = d.createElement('script'); 286 s.type = 'text/javascript'; 287 s.async = true; 288 s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier; 289 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s); 290 } 291 else { 292 d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>'); 293 } 294})(window, document); 295//--><!]]></script></div><div id="footer"> 296<p class="apache">Copyright 2013 The Apache Software Foundation.<br />この文書は <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a> のライセンスで提供されています。.</p> 297<p class="menu"><a href="/mod/">モジュール</a> | <a href="/mod/directives.html">ディレクティブ</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="/glossary.html">用語</a> | <a href="/sitemap.html">サイトマップ</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!-- 298if (typeof(prettyPrint) !== 'undefined') { 299 prettyPrint(); 300} 301//--><!]]></script> 302</body></html>
