| 4 | | From version 0.9 onwards, Trac is extensible with [trac:PluginList plugins]. Plugin functionality is based on the [trac:TracDev/ComponentArchitecture component architecture], with peculiarities described in the [TracDev/PluginDevelopment plugin development] page. |
| 5 | | |
| 6 | | == Plugin discovery == |
| 7 | | |
| 8 | | From the user's point of view, a plugin is either a standalone .py file or an .egg package. Trac looks for plugins in the global shared plugins directory (see [TracIni#GlobalConfiguration Global Configuration]) and in the `plugins` directory of the local TracEnvironment. Components defined in globally-installed plugins should be explicitly enabled in the [[TracIni#components-section| [components] ]] section of the trac.ini file. |
| 9 | | |
| 10 | | == Requirements for Trac eggs == |
| 11 | | |
| 12 | | To use egg-based plugins in Trac, you need to have [http://peak.telecommunity.com/DevCenter/setuptools setuptools] (version 0.6) installed. |
| 13 | | |
| 14 | | To install `setuptools`, download the bootstrap module [http://peak.telecommunity.com/dist/ez_setup.py ez_setup.py] and execute it as follows: |
| | 4 | バージョン 0.9 以降の Trac は[trac:PluginList プラグイン機能] による機能拡張が可能です。プラグイン機能は、 [trac:TracDev/ComponentArchitecture コンポーネント設計] に基づき、 [trac:TracDev/PluginDevelopment プラグインの開発] ページに記載されているような特性を持っています。 |
| | 5 | |
| | 6 | == プラグインを見つける == #Plugindiscovery |
| | 7 | |
| | 8 | ユーザの視点からいうと、プラグインはスタンドアロンの .py ファイルか .egg パッケージのどちらかです。 Trac は グローバルで共有するプラグインのディレクトリ ([TracIni#GlobalConfiguration グローバルな設定] 参照) とローカルの TracEnvironment の `plugins` ディレクトリに対して、プラグインを探します。グローバルにインストールされているプラグインを定義するコンポーネントは trac.ini ファイルの [[TracIni#components-section| [components] ]] セクションで明確に有効にするべきです。 |
| | 9 | |
| | 10 | == Trac eggs ファイルにおける必要条件 == #RequirementsforTraceggs |
| | 11 | |
| | 12 | Trac で Python-egg ベースのプラグインを使用するためには、 [http://peak.telecommunity.com/DevCenter/setuptools setuptools] (バージョン 0.6) をインストールしなければなりません。 |
| | 13 | |
| | 14 | `setuptools` をインストールするために、ブートストラップモジュールである [http://peak.telecommunity.com/dist/ez_setup.py ez_setup.py] をダウンロードし、以下に示すように実行して下さい: |
| 20 | | If the `ez_setup.py` script fails to install the setuptools release, you can download it from [http://www.python.org/pypi/setuptools PyPI] and install it manually. |
| 21 | | |
| 22 | | Plugins can also consist of a single `.py` file dropped directly into either the project's or the shared `plugins` directory. |
| 23 | | |
| 24 | | == Installing a Trac plugin == |
| 25 | | |
| 26 | | === For a single project === |
| 27 | | |
| 28 | | Plugins are typically packaged as [http://peak.telecommunity.com/DevCenter/PythonEggs Python eggs]. That means they are .zip archives with the file extension `.egg`. |
| 29 | | |
| 30 | | If you have downloaded a source distribution of a plugin, and want to build the `.egg` file: |
| 31 | | |
| 32 | | * Unpack the source. It should provide `setup.py`. |
| 33 | | * Run: |
| | 20 | もし `ez_setup.py` スクリプトが setuptools のインストールに失敗したら、 [http://www.python.org/pypi/setuptools PyPI] をダウンロードして手動でインストールしてください。 |
| | 21 | |
| | 22 | また、単一の `.py` ファイルで成り立つプラグインは、各プロジェクトの `plugins` ディレクトリか共有の `plugins` ディレクトリに配置します。 |
| | 23 | |
| | 24 | == Trac プラグインのインストール == #InstallingaTracplugin |
| | 25 | |
| | 26 | === 単一のプロジェクト === #Forasingleproject |
| | 27 | |
| | 28 | プラグインは一般的に [http://peak.telecommunity.com/DevCenter/PythonEggs Python eggs] としてパッケージ化されています。つまり、拡張子が `.egg` となっている .zip アーカイブのファイルです。 |
| | 29 | |
| | 30 | プラグインのディストリビューションをダウンロードして `.egg` ファイルをビルドしたい場合: |
| | 31 | |
| | 32 | * ソースをアンパックして下さい。それにより `setup.py` が提供されるでしょう |
| | 33 | * 以下のようにして実行してください: |
| 39 | | You should have a *.egg file. Examine the output of running python to find where this was created. |
| 40 | | |
| 41 | | Once you have the plugin archive, copy it into the `plugins` directory of the [wiki:TracEnvironment project environment]. Also, make sure that the web server has sufficient permissions to read the plugin egg. Then restart the web server. If you are running as a [wiki:TracStandalone "tracd" standalone server], restart tracd (kill and run again). |
| 42 | | |
| 43 | | To uninstall a plugin installed this way, remove the egg from the `plugins` directory and restart the web server. |
| 44 | | |
| 45 | | Note: the Python version that the egg is built with ''must'' match the Python version with which Trac is run. For example, if you're running Trac under Python 2.5, but have upgraded your standalone Python to 2.6, the eggs won't be recognized. |
| 46 | | |
| 47 | | Note also: in a multi-project setup, a pool of Python interpreter instances will be dynamically allocated to projects based on need; since plugins occupy a place in Python's module system, the first version of any given plugin to be loaded will be used for all projects. In other words, you cannot use different versions of a single plugin in two projects of a multi-project setup. It may be safer to install plugins for all projects (see below), and then enable them selectively on a project-by-project basis. |
| 48 | | |
| 49 | | === For all projects === |
| 50 | | |
| 51 | | ==== With an .egg file ==== |
| 52 | | |
| 53 | | Some plugins (such as [trac:SpamFilter SpamFilter]) are downloadable as an `.egg` file that can be installed with the `easy_install` program: |
| | 39 | *.egg ファイルが出力されるはずです。実行した python の出力を調べて .egg ファイルがどこに作成されたか見つけてください。 |
| | 40 | |
| | 41 | 一度、プラグインアーカイブを作成したら、 [wiki:TracEnvironment TracEnvironment] の `plugins` ディレクトリにコピーする必要があります。また、 Web サーバーが egg プラグインを読み取るのに必要なパーミッションを持っているか確認してください。そして Web サーバを再起動してください。 [wiki:TracStandalone "tracd" というスタンドアロンサーバー] を使用している方は、tracd を再起動してください。 |
| | 42 | |
| | 43 | この方法でインストールしたプラグインをアンインストールする場合、 `plugins` ディレクトリから egg を削除し、 Web サーバを再起動してください。 |
| | 44 | |
| | 45 | Note: Python egg をビルドするための Python のバージョンと Trac を動かしている Python のバージョンが一致しなければなりません。例えば、 Trac を Python のバージョン 2.5 以前で動かしていて、 2.6 にアップグレードしたときに、Python egg は認識されなくなるでしょう。 |
| | 46 | |
| | 47 | Note: マルチプロジェクトを設定している場合、 Python インタプリタインスタンスのプールはプロジェクトの必要に応じて動的にアロケートされ、プラグインは Pyhton のモジュールシステムの一定の位置を占有しますので、最初にロードされたバージョンのプラグインが、他のすべてのプロジェクトでも使用されます。言い換えれば、マルチプロジェクトセットアップされたプロジェクト間では、あるプラグインの異なるバージョンを使用することはできません。プラグインは (下記の方法で) すべてのプロジェクト向けにインストールし、個々のプロジェクトで有効/無効を設定する方が安全でしょう。 |
| | 48 | |
| | 49 | === すべてのプロジェクト === #Forallprojects |
| | 50 | |
| | 51 | ==== 単一の .egg ファイル ==== #Withan.eggfile |
| | 52 | |
| | 53 | いくつかのプラグイン (例えば [trac:SpamFilter SpamFilter]) は `.egg` ファイルとしてダウンロードし、 `easy_install` プログラムでインストールすることができます: |
| 85 | | The name of the option is the Python package of the plugin. This should be specified in the documentation of the plugin, but can also be easily discovered by looking at the source (look for a top-level directory that contains a file named `__init__.py`). |
| 86 | | |
| 87 | | Note: After installing the plugin, you must restart your web server. |
| 88 | | |
| 89 | | ==== Uninstalling ==== |
| 90 | | |
| 91 | | `easy_install` or `python setup.py` does not have an uninstall feature. Hower, it is usually quite trivial to remove a globally-installed egg and reference: |
| 92 | | |
| 93 | | 1. Do `easy_install -m [plugin name]` to remove references from `$PYTHONLIB/site-packages/easy-install.pth` when the plugin installed by setuptools. |
| 94 | | 1. Delete executables from `/usr/bin`, `/usr/local/bin`, or `C:\\Python*\Scripts`. To find what executables are involved, refer to the `[console-script]` section of `setup.py`. |
| 95 | | 1. Delete the .egg file or folder from where it's installed (usually inside `$PYTHONLIB/site-packages/`). |
| 96 | | 1. Restart the web server. |
| 97 | | |
| 98 | | If you are uncertain about the location of the egg, here's a small tip to help locate an egg (or any package). Just replace `myplugin` with whatever namespace the plugin uses (as used when enabling the plugin): |
| | 85 | オプションの名前はプラグインの Python パッケージ名です。これはプラグインのドキュメンテーションに指定されていなければいけませんが、ソースを見れば簡単に見つけることが出来ます。 (最上位のディレクトリにあるファイル `__init__.py` を探してください。) |
| | 86 | |
| | 87 | Note: プラグインのインストール後、 Web サーバを再起動する必要があります。 |
| | 88 | |
| | 89 | ==== アンインストール ==== #Uninstalling |
| | 90 | |
| | 91 | `easy_install` や `python setup.py` ではアンインストール機能は提供されていません。しかし、グローバルにインストールされた egg や参照を削除するための簡単な方法があります: |
| | 92 | |
| | 93 | 1. setuptools でインストールした場合、 `easy_install -m [plugin name]` を実行し、 `$PYTHONLIB/site-packages/easy-install.pth` から参照を削除します |
| | 94 | 1. `/usr/bin`, `/usr/local/bin`, `C:\\Python*\\Scripts` などから実行可能ファイルを削除します。実行可能ファイルが分からない場合、 `setup.py` の `[console-script]` を参照してください |
| | 95 | 1. インストールされた場所 (通常 `$PYTHONLIB/site-packages/` 配下) の .egg ファイルやディレクトリを削除します |
| | 96 | 1. Web サーバを再起動します |
| | 97 | |
| | 98 | egg の場所が分らない場合、探すためには以下の方法を使います (この方法は、どのようなパッケージでも使えます)。`myplugin` の箇所は、プラグインのネームスペースで置き換えてください。ネームスペースはプラグインの有効化の時に使用した名前と同じになります: |
| 156 | | If you get '''no output''', setuptools '''is''' installed. Otherwise, you'll need to install it before plugins will work in Trac. |
| 157 | | |
| 158 | | === Did you get the correct version of the Python egg? === |
| 159 | | |
| 160 | | Python eggs have the Python version encoded in their filename. For example, `MyPlugin-1.0-py2.5.egg` is an egg for Python 2.5, and will '''not''' be loaded if you're running a different Python version (such as 2.4 or 2.6). |
| 161 | | |
| 162 | | Also, verify that the egg file you downloaded is indeed a .zip archive. If you downloaded it from a Trac site, chances are you downloaded the HTML preview page instead. |
| 163 | | |
| 164 | | === Is the plugin enabled? === |
| 165 | | |
| 166 | | If you install a plugin globally (i.e., ''not'' inside the `plugins` directory of the Trac project environment), you must explicitly enable it in [TracIni trac.ini]. Make sure that: |
| 167 | | |
| 168 | | * ...you actually added the necessary line(s) to the `[components]` section. |
| 169 | | * ...the package/module names are correct. |
| 170 | | * ...the value is "enabled", not "enable" or "Enable". |
| 171 | | |
| 172 | | === Check the permissions on the .egg file === |
| 173 | | |
| 174 | | Trac must be able to read the .egg file. |
| 175 | | |
| 176 | | === Check the log files === |
| 177 | | |
| 178 | | Enable [wiki:TracLogging logging] and set the log level to `DEBUG`, then watch the log file for messages about loading plugins. |
| 179 | | |
| 180 | | === Verify you have proper permissions === |
| 181 | | |
| 182 | | Some plugins require you have special permissions in order to use them. [trac:WebAdmin WebAdmin], for example, requires the user to have TRAC_ADMIN permissions for it to show up on the navigation bar. |
| 183 | | |
| 184 | | === Is the wrong version of the plugin loading? === |
| 185 | | |
| 186 | | If you put your plugins inside plugins directories, and certainly if you have more than one project, you need to make sure that the correct version of the plugin is loading. Here are some basic rules: |
| 187 | | |
| 188 | | * Only one version of the plugin can be loaded for each running Trac server (i.e., each Python process). The Python namespaces and module list will be shared, and it cannot handle duplicates. Whether a plugin is `enabled` or `disabled` makes no difference. |
| 189 | | * A globally-installed plugin (typically `setup.py install`) will override any version in the global or project plugins directories. A plugin from the global plugins directory will be located ''before'' any project plugins directory. |
| 190 | | * If your Trac server hosts more than one project (as with `TRAC_ENV_PARENT_DIR` setups), having two versions of a plugin in two different projects will give uncertain results. Only one of them will load, and the one loaded will be shared by both projects. Trac will load the first plugin found, usually from the project that receives the first request. |
| 191 | | * Having more than one version listed inside Python site-packages is fine (i.e., installed with `setup.py install`) -- setuptools will make sure you get the version installed most recently. However, don't store more than one version inside a global or project plugins directory -- neither version number nor installed date will matter at all. There is no way to determine which one will be located first when Trac searches the directory for plugins. |
| 192 | | |
| 193 | | === If all of the above failed === |
| 194 | | |
| 195 | | Okay, so the logs don't mention plugins, the egg is readable, the Python version is correct, ''and'' the egg has been installed globally (and is enabled in trac.ini)... and it ''still'' doesn't work or give any error messages or any other indication as to why. Hop on the [trac:IrcChannel IrcChannel] and ask away! |
| 196 | | |
| 197 | | == Web-based plugin administration == |
| 198 | | |
| 199 | | The WebAdmin plugin (part of the core since 0.11) offers limited support for plugin configuration through the web to users with `TRAC_ADMIN` permission: |
| 200 | | |
| 201 | | * en/disabling installed plugins |
| 202 | | * installing plugins by uploading them as eggs |
| 203 | | |
| 204 | | You probably want to disable the second function for security reasons: in `trac.ini`, in the `[components]` section, add the line |
| | 156 | もし、コマンドラインから '''何も''' かえって来なければ、 setuptools はインストール '''されています'''。そうでなければ、 Trac を動かす前に setuptools をインストールする必要があります。 |
| | 157 | |
| | 158 | === Python egg は正しいバージョンですか？ === #DidyougetthecorrectversionofthePythonegg |
| | 159 | |
| | 160 | Python egg はファイル名の中で Python のバージョンをエンコードします。例えば、 `MyPlugin-1.0-py2.5.egg` は Python 2.5 用の Python egg であり、異なる Python のバージョン (2.4 や 2.6) で動かそうとしても '''動かない''' でしょう。 |
| | 161 | |
| | 162 | また、ダウンロードした Python egg ファイル が本当に .zip アーカイブであるかどうかを確認して下さい。もし Trac サイトからダウンロードしたとしたら、 HTML プレビューページを代わりにダウンロードしているかもしれません。 |
| | 163 | |
| | 164 | === プラグインは有効になっていますか？ === #Isthepluginenabled |
| | 165 | |
| | 166 | グローバル領域にプラグインをインストールした場合 (Environment の `plugins` ディレクトリ内 ''ではなく'') 、 [TracIni trac.ini] に明確に有効にする設定をしなければなりません。以下の事項を確認して下さい: |
| | 167 | |
| | 168 | * ...`[components]` セクションに必要な行数を追加したか |
| | 169 | * ...パッケージ / モジュール名は正しいか |
| | 170 | * ..."enable" や "Enable" ではなく、正しい値 "enabled" になっているかどうか |
| | 171 | |
| | 172 | === Python egg ファイルのパーミッションのチェック === #Checkthepermissionsonthe.eggfile |
| | 173 | |
| | 174 | Trac は Python egg ファイルを読み込み可能でなければなりません。 |
| | 175 | |
| | 176 | === ログファイルのチェック === #Checkthelogfiles |
| | 177 | |
| | 178 | Trac で [wiki:TracLogging logging] を有効にし、ログレベルを `DEBUG` に設定し、プラグインがロードされるときのログメッセージを見て下さい。 |
| | 179 | |
| | 180 | === 必要な権限を持っていることを確認してください === #Verifyyouhaveproperpermissions |
| | 181 | |
| | 182 | いくつかのプラグインでは、その機能を使用するために特別な権限を要求します。たとえば [trac:WebAdmin WebAdmin] では、ナビゲーションバーに表示するためには TRAC_ADMIN 権限が必要になります。 |
| | 183 | |
| | 184 | === 読み込むプラグインのバージョンを間違えていませんか ? === #Isthewrongversionofthepluginloading |
| | 185 | |
| | 186 | 複数のプロジェクトがある場合に plugins ディレクトリにプラグインを置くなら、確実に正しいバージョンのプラグインがロードされていることを確認する必要があります。ここにいくつかの基本的なルールがあります: |
| | 187 | |
| | 188 | * 実行中の Trac サーバ (すなわち各々の Python プロセス) にはプラグインの 1 バージョンだけがロードできます。 Python の名前空間とモジュールリストは (プラグインが`有効 (enabled)` になっているか `無効 (disabled)` になっているかに関わらず) 全プロジェクトで共有されるでしょう。そしてそれは複製をハンドルすることができません |
| | 189 | * グローバルにインストールされたプラグイン (通常は `setup.py install`) は共有 plugins ディレクトリあるいはプロジェクト毎の plugins ディレクトリ内のどんなバージョンも無視するでしょう。グローバルにインストールされたプラグインは、他のどのプラグインよりも''先に''動作するでしょう |
| | 190 | * Trac サーバが (`TRAC_ENV_PARENT_DIR` セットアップのように) 複数のプロジェクトをホスティングした場合、異なったプロジェクトで異なるバージョンのプラグインを使用していると、どのバージョンのプラグインが使用されるかは不明です。異なるバージョンのプラグインのうちいずれか一つがロードされるでしょう。そしてロードされたプラグインは全てのプロジェクトで共有されます。 Trac は通常一番最初にリクエストを受けたプロジェクトからプラグインをロードします |
| | 191 | * Python の site-packages 内に複数のバージョンをリストしておく (すなわち `setup.py install` を使用してインストールする) のは素晴らしいことです。 - setuptools は最も新しいバージョンを確実にインストールします。しかし、複数バージョンのプラグインを共有 plugins ディレクトリや、プロジェクト毎の plugins ディレクトリに格納しないでください。 - Trac はプラグインを探すときに バージョン番号、格納された日付などを気にしません。この場合 Trac がどのプラグインを最初に見つけ出すかを確実に指定する方法はありません |
| | 192 | |
| | 193 | === 上記のすべてに失敗した場合 === #Ifalloftheabovefailed |
| | 194 | |
| | 195 | plugins に対するログが出力されず、 egg が読み込み可能であり、 Python のバージョンが正しく、 ''その上で'' egg がグローバルにインストールされて (そして trac.ini で使用可能に設定されて) ''いても''、なぜかプラグインが動かず、なんのエラーメッセージも表示されない場合は、 [trac:IrcChannel IrcChannel] で質問してください。 |
| | 196 | |
| | 197 | == web ベースのプラグイン管理 == #Web-basedpluginadministration |
| | 198 | |
| | 199 | !WebAdmin プラグイン (0.11 から標準付属) を導入することで、 `TRAC_ADMIN` 権限を持ったユーザは web 上でプラグインの設定が行えるようになります: |
| | 200 | |
| | 201 | * インストールされたプラグインの有効/無効を設定する |
| | 202 | * Python egg をアップロードすることでプラグインをインストールする |
| | 203 | |
| | 204 | セキュリティ上の理由から 2 番目の機能を無効にしたいときには、`trac.ini` の `[components]` セクションに以下の一行を追記してください。 |
![(please configure the [header_logo] section in trac.ini)](/python/trac/mypz/chrome/common/trac_logo_mini.png){kind=logo}