Changes between Initial Version and Version 1 of TracPlugins


Ignore:
Timestamp:
2010/10/12 00:14:07 (14 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracPlugins

    v1 v1  
     1= Trac プラグイン = #TracPlugins 
     2[[TracGuideToc]] 
     3 
     4バージョン 0.9 以降、 Trac は [http://trac.edgewall.org/wiki/PluginList プラグイン機能] に対応し、組み込み機能を拡張できるようになりました。プラグインの機能は [http://trac.edgewall.org/wiki/TracDev/ComponentArchitecture コンポーネント設計] に基づいています。 
     5 
     6プラグインはグローバルにもローカルにもインストールすることができます。グローバルにインストールする場合は共有する plugins ディレクトリに配置します ([TracIni#GlobalConfiguration グローバルな設定] を参照してください)。ローカルにインストールする場合は TracEnvironment の `plugins` ディレクトリに配置します。 
     7後者でない場合、プラグインで提供されるコンポーネントは trac.ini の [TracIni#components-section| [components] ]] セクションで、明示的に有効化する必要があります。 
     8 
     9== 必要条件 == #Requirements 
     10 
     11Trac で Python-egg ベースのプラグインを使用するためには、 [http://peak.telecommunity.com/DevCenter/setuptools setuptools] (バージョン 0.6) をインストールしなければなりません。 
     12 
     13`setuptools` をインストールするために、ブートストラップモジュールである [http://peak.telecommunity.com/dist/ez_setup.py ez_setup.py] をダウンロードし、以下に示すように実行して下さい: 
     14{{{ 
     15$ python ez_setup.py 
     16}}} 
     17 
     18もし `ez_setup.py` スクリプトが setuptools のインストールに失敗したら、 [http://www.python.org/pypi/setuptools PyPI] をダウンロードして手動でインストールしてください。 
     19 
     20また、単一の `.py` ファイルで成り立つプラグインは、各 TracEnvironment かグローバルの `plugin` ディレクトリに配置します。 
     21 
     22== Trac プラグインのインストール == #InstallingaTracPlugin 
     23 
     24=== 単一のプロジェクト === #ForaSingleProject 
     25 
     26プラグインは [http://peak.telecommunity.com/DevCenter/PythonEggs Python eggs] としてパッケージ化されています。つまり、拡張子が `.egg` となっている ZIP アーカイブのファイルです。 
     27 
     28plugin のディストリビューションをダウンロードして `.egg` ファイルをビルドしたいのであれば、以下の通りにして下さい: 
     29 * ソースをアンパックして下さい。それにより setup.py が提供されるでしょう。  
     30 * 以下のようにして実行してください: 
     31{{{ 
     32$ python setup.py bdist_egg 
     33}}} 
     34 
     35*.egg ファイルが出力されているでしょう。実行した python の出力を調べて .egg ファイルがどこに作成されたか見つけてください。 
     36 
     37一度、プラグインアーカイブを作成したら、 [wiki:TracEnvironment TracEnvironment] の `plugins` ディレクトリにコピーする必要があります。また、 Web サーバーが egg プラグインを読み取るのに必要なパーミッションをつけてください。必要に応じて Web サーバを再起動してください。 
     38 
     39この方法でインストールしたプラグインをアンインストールする場合、 `plugins` ディレクトリから egg を削除し、 Web サーバを再起動してください。 
     40 
     41Python egg をビルドするための Python のバージョンと  
     42Trac を動かしている Python のバージョンが一致しなければなりません。 
     43例えば、 Trac を Python のバージョン 2.5 以前で動かしていて、 
     442.6 にアップグレードしたときに、  
     45Python egg は認識されなくなるでしょう。 
     46 
     47マルチプロジェクトを設定している場合、 Python インタプリタインスタンスのプールはプロジェクトの必要に応じて動的にアロケートされ、プラグインは Pyhton のモジュールシステムの一定の位置を占有しますので、最初にロードされたバージョンのプラグインが、他のすべてのプロジェクトでも使用されます。言い換えれば、マルチプロジェクトセットアップされたプロジェクト間では、あるプラグインの異なるバージョンを使用することはできません。プラグインは (下記の方法で) すべてのプロジェクト向けにインストールし、個々のプロジェクトで有効/無効を設定する方が安全でしょう。 
     48 
     49=== すべてのプロジェクト === #ForAllProjects 
     50 
     51==== 単一の .egg ファイル ==== #Withan.eggfile 
     52 
     53いくつかのプラグイン (例えば [http://trac.edgewall.org/wiki/SpamFilter SpamFilter]) は `.egg` ファイルとしてダウンロードし、 `easy_install` プログラムでインストールすることができます: 
     54{{{ 
     55easy_install TracSpamFilter 
     56}}} 
     57 
     58もし、システムに `easy_install` がなくてプラグインをインストールするには上記の必要条件のセクションを見て下さい。 Windows ユーザは `Scripts` ディレクトリを Python をインストールしたディレクトリ (例えば、 `C:\Python24\Scripts`) を環境変数 `PATH` に加えなければなりません。 (より詳しい情報は、 [http://peak.telecommunity.com/DevCenter/EasyInstall#windows-notes easy_install の Windows Notes] を参照して下さい。) 
     59 
     60Zip で固められた Python egg をインストールし、 Web サーバに Python egg のキャッシュディレクトリに書き込み権限をつけているのにも関わらず、 Trac がパーミッションエラーを出したら、解凍した Python egg を単に置き直すことによって回避できます。 `easy_install` に `--always-unzip` オプションを付けるだけです: 
     61{{{ 
     62easy_install --always-unzip TracSpamFilter-0.2.1dev_r5943-py2.4.egg 
     63}}} 
     64zip で固められた Python egg ファイルと同じ名前のディレクトリ (拡張子が `.egg` で終わっているもの) ができ、そのなかに解凍した中身が入っているでしょう。 
     65 
     66Trac はまた、 Environment 共通の plugins ディレクトリにインストールされたプラグインを検索します ''(0.10 以降)''。 TracIni#GlobalConfiguration を参照してください。この方法は複数の (しかし全てではない) Environment にまたがってプラグインをインストールする最も簡単な方法になります。 
     67 
     68==== ソースから ==== #Fromsource 
     69 
     70`easy_install` をソースからインストールする方法を以下に示します。Subversion のリポジトリか、 tarball/zip のソースを引数に与えてください。 
     71{{{ 
     72easy_install http://svn.edgewall.com/repos/trac/plugins/0.11/spam-filter 
     73}}} 
     74 
     75==== プラグインを有効にする ==== #Enablingtheplugin 
     76個別の TracEnvironment にプラグインをインストールする場合と異なり、システム全体にインストールしたプラグインを有効にするためには、 [wiki:TracIni trac.ini] ファイルで明示的に指定しなければいけません。設定ファイルの `[inherit] plugins_dir` オプションに指定した Environment 共通の plugins ディレクトリにプラグインをインストールする場合も同じく、明示的に指定する必要があります。 
     77 
     78設定ファイルの `[components]` セクションに次のような記載を行えば完了です: 
     79{{{ 
     80[components] 
     81tracspamfilter.* = enabled 
     82}}} 
     83 
     84オプションの名前はプラグインの Python パッケージ名です。これはプラグインのドキュメンテーションに指定されていなければいけませんが、ソースを見れば簡単に見つけることが出来ます。 (最上位のディレクトリにあるファイル `__init__.py` を探してください。) 
     85 
     86Note: プラグインのインストール後、 Web サーバを再起動する必要があります。 
     87 
     88==== アンインストール ==== #Uninstalling 
     89 
     90`easy_install` や `python setup.py` ではアンインストール機能は提供されていません。しかし、グローバルにインストールされた egg や参照を削除するための簡単な方法があります: 
     91 1. setuptools でインストールした場合、 `easy_install -m [plugin name]` を実行し、 `$PYTHONLIB/site-packages/easy-install.pth` から参照を削除します。 
     92 1. 実行可能ファイルを `/usr/bin`, `/usr/local/bin`, `C:\\Python*\\Scripts` などから削除します。実行可能ファイルが分からない場合、 `setup.py` の `[console-script]` を参照します。 
     93 1. インストールされた場所 (通常 `$PYTHONLIB/site-packages/` 配下) の .egg ファイルやディレクトリを削除します。 
     94 1. Web サーバを再起動する。 
     95 
     96egg の場所が分らない場合、探すためには以下の方法を使います (この方法は、どのようなパッケージでも使えます) - `myplugin` の箇所は、プラグインのネームスペースで置き換えてください。ネームスペースはプラグインの有効化の時に使用した名前と同じになります。 
     97{{{ 
     98>>> import myplugin 
     99>>> print myplugin.__file__ 
     100/opt/local/python24/lib/site-packages/myplugin-0.4.2-py2.4.egg/myplugin/__init__.pyc 
     101}}} 
     102 
     103== プラグインのキャッシュの設定 == #SettingupthePluginCache 
     104 
     105プラグインは Python eggs のランタイム (`pkg_resources`) によって解凍される必要があります。それらの内容がファイルシステム上に実際に存在する必要があるからです。通常は現在のユーザのホームディレクトリの '.python-eggs' に解凍されますが、それにより問題が発生するかもしれません。その場合、環境変数 `PYTHON_EGG_CACHE` を設定してデフォルトのロケーションを上書きすることができます。 
     106 
     107`PYTHON_EGG_CACHE` を `SetEnv` ディレクティブを使用して Apache に設定するには以下のようにします: 
     108{{{ 
     109SetEnv PYTHON_EGG_CACHE /path/to/dir 
     110}}} 
     111 
     112これは [wiki:TracCgi CGI] と [wiki:TracModPython mod_python] のどちらをフロントエンドにしようと動作します。このディレクティブに [wiki:TracEnvironment Trac Environment] へのパスに設定し、例えば同じ `<Location>` ブロックにおいてください。 
     113 
     114例 (CGI用): 
     115{{{ 
     116 <Location /trac> 
     117   SetEnv TRAC_ENV /path/to/projenv 
     118   SetEnv PYTHON_EGG_CACHE /path/to/dir 
     119 </Location> 
     120}}} 
     121 
     122例 (mod_python用): 
     123{{{ 
     124 <Location /trac> 
     125   SetHandler mod_python 
     126   ... 
     127   SetEnv PYTHON_EGG_CACHE /path/to/dir 
     128 </Location> 
     129}}} 
     130 
     131 ''Note: !SetEnv を使用するためには、 Apache で `mod_env` モジュールが有効になっている必要があります。 `mod_python` が設定される Location ブロックでは !SetEnv ディレクティブも使用できます。'' 
     132 
     133[wiki:TracFastCgi FastCGI] で、 Web サーバに設定するためには、 `-initial-env` オプションやサーバーが指定している方法で、環境変数を設定する必要があります。 
     134 
     135 ''Note: プロジェクトディレクトリを設定するために、既に -initial-env を使用している場合は、 [wiki:TracFastCgi TracFastCgi] に例示されるように、必要に応じて -initial-env ディレクティブを !FastCgiConfig ディレクティブに加えてください。'' 
     136 
     137{{{ 
     138FastCgiConfig -initial-env TRAC_ENV=/var/lib/trac -initial-env PYTHON_EGG_CACHE=/var/lib/trac/plugin-cache 
     139}}} 
     140 
     141=== Subversion の フックスクリプトについて === #Abouthookscripts 
     142 
     143もし、 Trac エンジンを呼び出すような Subversion の フックスクリプト - Trac の配布物の `/contrib` ディレクトリで提供されている post-commit フックスクリプトなど - を設定していたら、プラグインと同様にスクリプトの中で環境変数 `PYTHON_EGG_CACHE` を定義して下さい。 
     144 
     145== トラブルシューティング == #Troubleshooting 
     146 
     147=== setuptools は正しくインストールされていますか? === #Issetuptoolsproperlyinstalled 
     148 
     149以下のコマンドを実行してみてください: 
     150{{{ 
     151$ python -c "import pkg_resources" 
     152}}} 
     153 
     154もし、コマンドラインから '''何も''' かえって来なければ、 setuptools はインストール '''されています'''。そうでなければ、 Trac を動かす前に setuptools をインストールする必要があります。 
     155 
     156=== Python egg は正しいバージョンですか? === #DidyougetthecorrectversionofthePythonegg 
     157 
     158Python egg はファイル名の中で Python のバージョンをエンコードします。例えば、 `MyPlugin-1.0-py2.5.egg` は Python 2.5 用の Python egg であり、異なる Python のバージョン (2.4 や 2.6) で動かそうとしても '''動かない''' でしょう。 
     159 
     160また、ダウンロードした Python egg ファイル が本当に ZIP アーカイブであるかどうかを確認して下さい。もし Trac サイトからダウンロードしたとしたら、 HTML プレビューページを代わりにダウンロードしているかもしれません。 
     161 
     162=== プラグインは有効になっていますか? === #Isthepluginenabled 
     163 
     164 
     165グローバル領域にプラグインをインストールした場合 (TracEnvironment の `plugin` ディレクトリ内 ''ではなく'') 、 [TracIni trac.ini] に明確に有効にする設定をしなければなりません。以下の事項を確認して下さい: 
     166 * `[components]` セクションに必要な行数を追加したか。 
     167 * パッケージ / モジュール名は正しいか 
     168 * 正しい値、 "enabled" になっているかどうか。例えば、 "enable" ではなく。 
     169 
     170=== Python egg ファイルのパーミッションのチェック === #Checkthepermissionsontheeggfile 
     171 
     172Trac は Python egg ファイルを読めなければなりません。 
     173 
     174=== ログファイルのチェック === #Checkthelogfiles 
     175 
     176Trac で [wiki:TracLogging logging] を有効にし、ログレベルを `DEBUG` に設定し、プラグインがロードされるときのログメッセージを見て下さい。 
     177 
     178=== 必要な権限を持っていることを確認してください === #Verifyyouhaveproperpermissions 
     179 
     180いくつかのプラグインでは、その機能を使用するために特別な権限を要求します。たとえば [http://trac.edgewall.org/wiki/WebAdmin WebAdmin] では、ナビゲーションバーに表示するためには TRAC_ADMIN 権限が必要になります。 
     181 
     182=== 読み込むプラグインのバージョンを間違えていませんか ? === #Isthewrongversionofthepluginloading 
     183 
     184複数のプロジェクトがある場合に plugins ディレクトリにプラグインを置くなら確実に正しいバージョンのプラグインがロードされていることを確認する必要があります。ここにいくつかの基本的なルールがあります: 
     185 * 実行中の Trac サーバ (すなわち各々の Python プロセス) にはプラグインの 1 バージョンだけがロードできます。 Python の名前空間とモジュールリストは (プラグインが`有効 (enabled)` になっているか `無効 (disabled)` になっているかに関わらず) 全プロジェクトで共有されるでしょう。そしてそれは複製をハンドルすることができません。 
     186 * グローバルにインストールされたプラグイン (通常は `setup.py install`) はグローバルな plugins ディレクトリあるいはプロジェクト毎の plugins ディレクトリ内のどんなバージョンも無視するでしょう。グローバルにインストールされたプラグインは、他のどのプラグインよりも前に動作するでしょう。 
     187 * Trac サーバが (`TRAC_ENV_PARENT_DIR` セットアップのように) 複数のプロジェクトをホスティングした場合、異なったプロジェクトで異なるバージョンのプラグインを使用していると、どのバージョンのプラグインが使用されるかは不明です。異なるバージョンのプラグインのうちいずれか一つがロードされるでしょう。そしてロードされたプラグインは全てのプロジェクトで共有されます。 Trac は基本的に一番最初にリクエストを受けたプロジェクトからプラグインをロードします。 
     188 * Python の site-packages 内に複数のバージョンをリストしておく (すなわち `setup.py install` を使用してインストールする) のは素晴らしいことです。 - setuptools は最も新しいバージョンを確実にインストールします。しかし、複数バージョンのプラグインをグローバルな plugins ディレクトリや、プロジェクト毎の plugins ディレクトリに格納しないでください。 - Trac はプラグインを探すときに バージョン番号、格納された日付などを気にしません。この場合 Trac がどのプラグインを最初に見つけ出すかを確実に指定する方法はありません。 
     189 
     190=== 上記のすべてに失敗した場合 === #Ifalloftheabovefailed 
     191 
     192plugins に対するログが出力されず、 egg が読み込み可能であり、 Python のバージョンが正しく、 ''その上で'' egg がグローバルにインストールされて (そして trac.ini で使用可能に設定されて) いても、なぜかプラグインが動かず、なんのエラーメッセージも表示されない場合は、 [http://trac.edgewall.org/wiki/IrcChannel IrcChannel] で質問してください。 
     193 
     194---- 
     195See also TracGuide, [http://trac.edgewall.org/wiki/PluginList プラグイン一覧], [http://trac.edgewall.org/wiki/TracDev/ComponentArchitecture コンポーネント設計]