Changes between Version 3 and Version 4 of TracPlugins


Ignore:
Timestamp:
Jan 28, 2010, 4:25:36 AM (8 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracPlugins

    v3 v4  
    1 = Trac プラグイン =
     1= Trac Plugins =
    22[[TracGuideToc]]
    33
    4 バージョン 0.9 以降、 Trac はプラグイン機能に対応し、組み込み機能を拡張できるようになりました。プラグインの機能は [http://trac.edgewall.org/wiki/TracDev/ComponentArchitecture コンポーネント設計] に基づいています。
     4Since version 0.9, Trac supports [PluginList plugins] that extend the built-in functionality. The plugin functionality is based on the [trac:TracDev/ComponentArchitecture component architecture].
    55
    6 == 必要条件 ==
     6== Requirements ==
    77
    8 Python egg が基になっている Trac のプラグインを使用するためには、 [http://peak.telecommunity.com/DevCenter/setuptools setuptools] (バージョン 0.6) をインストールしなければなりません。
     8To use egg based plugins in Trac, you need to have [http://peak.telecommunity.com/DevCenter/setuptools setuptools] (version 0.6) installed.
    99
    10 プラグインは単一の `.py` ファイルから成り立っていて、各 TracEnvironment かグローバルの `plugin` ディレクトリに配置します。 ''([http://trac.edgewall.org/milestone/0.10 milestone:0.10] 以降)''
    11 
    12 `setuptools` をインストールするために、ブートストラップモジュールである [http://peak.telecommunity.com/dist/ez_setup.py ez_setup.py] をダウンロードし、以下に示すように実行して下さい:
     10To install `setuptools`, download the bootstrap module [http://peak.telecommunity.com/dist/ez_setup.py ez_setup.py] and execute it as follows:
    1311{{{
    1412$ python ez_setup.py
    1513}}}
    1614
    17 もし `ez_setup.py` スクリプトが setuptools のインストールに失敗したら、 [http://www.python.org/pypi/setuptools PyPI] をダウンロードして手動でインストールしてください。
     15If 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.
    1816
    19 == Trac プラグインのインストール ==
     17Plugins can also consist of a single `.py` file dropped into either the environment or global `plugins` directory ''(since [milestone:0.10])''. See TracIni#GlobalConfiguration .
    2018
    21 === 単一のプロジェクト ===
     19== Installing a Trac Plugin ==
    2220
    23 プラグインは [http://peak.telecommunity.com/DevCenter/PythonEggs Python eggs] としてパッケージ化されています。つまり、拡張子が `.egg` となっている ZIP アーカイブのファイルです。プラグインのソースコードディストリビューションをダウンロードした場合は、以下のコマンドを実行して下さい:
     21=== For a Single Project ===
     22
     23Plugins are packaged as [http://peak.telecommunity.com/DevCenter/PythonEggs Python eggs]. That means they are ZIP archives with the file extension `.egg`.
     24
     25If you have downloaded a source distribution of a plugin, and want to build the `.egg` file, follow this instruction:
     26 * Unpack the source. It should provide a setup.py.
     27 * Run:
    2428{{{
    2529$ python setup.py bdist_egg
    2630}}}
    27 `.egg` ファイルをビルドできます。
    2831
    29 一度、プラグインアーカイブを作成したら、 [wiki:TracEnvironment TracEnvironment] の `plugins` ディレクトリにコピーする必要があります。また、 Web サーバーが egg プラグインを読み取るのに必要なパーミッションをつけてください。
     32Then you will have a *.egg file. Examine the output of running python to find where this was created.
    3033
    31 Python egg をビルドするための Python のバージョンと
    32 Trac を動かしている Python のバージョンが一致しなければなりません。
    33 例えば、 Trac を Python のバージョン 2.3 以前で動かしていて、
    34 2.4 にアップグレードしたときに、
    35 Python egg は認識されなくなるでしょう。
     34Once you have the plugin archive, you need to 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.
    3635
    37 === すべてのプロジェクト ===
     36To uninstall a plugin installed this way, remove the egg from `plugins` directory and restart web server.
    3837
    39 ==== 単一の .egg ファイル ====
     38Note that the Python version that the egg is built with must
     39match the Python version with which Trac is run.  If for
     40instance you are running Trac under Python 2.3, but have
     41upgraded your standalone Python to 2.4, the eggs won't be
     42recognized.
    4043
    41 いくつかのプラグイン (例えば [http://trac.edgewall.org/wiki/WebAdmin WebAdmin]) は `.egg` ファイルとしてダウンロードし、 `easy_install` プログラムでインストールすることができます:
     44Note also that in a multi-project setup, a pool of Python interpreter instances will be dynamically allocated to projects based on need, and 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 the 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.
     45
     46=== For All Projects ===
     47
     48==== With an .egg file ====
     49
     50Some plugins (such as [trac:SpamFilter SpamFilter]) are downloadable as a `.egg` file which can be installed with the `easy_install` program:
    4251{{{
    43 easy_install TracWebAdmin-0.1.1dev_r2765-py2.3.egg
     52easy_install TracSpamFilter
    4453}}}
    4554
    46 もし、システムに `easy_install` がなくてプラグインをインストールするには上記の必要条件のセクションを見て下さい。 Windows ユーザは `Scripts` ディレクトリを Python をインストールしたディレクトリ (例えば、 `C:\Python23\Scripts`) を環境変数 `PATH` に加えなければなりません。 (より詳しい情報は、 [http://peak.telecommunity.com/DevCenter/EasyInstall#windows-notes easy_install の Windows Notes] を参照して下さい。)
     55If `easy_install` is not on your system see the Requirements section above to install it.  Windows users will need to add the `Scripts` directory of their Python installation (for example, `C:\Python23\Scripts`) to their `PATH` environment variable (see [http://peak.telecommunity.com/DevCenter/EasyInstall#windows-notes easy_install Windows notes] for more information).
    4756
    48 zipで固められた Python egg をインストールし、 Web サーバに Python egg のキャッシュディレクトリに書き込み権限をつけているのにも関わらず、 Trac がパーミッションエラーを出したら、 解凍した Python egg を単に置き直すことによって回避できます。 `easy_install` に `--always-unzip` オプションを付けるだけです:
     57If Trac reports permission errors after installing a zipped egg and you would rather not bother providing a egg cache directory writable by the web server, you can get around it by simply unzipping the egg. Just pass `--always-unzip` to `easy_install`:
    4958{{{
    50 easy_install --always-unzip TracWebAdmin-0.1.1dev_r2765-py2.3.egg
     59easy_install --always-unzip TracSpamFilter-0.2.1dev_r5943-py2.4.egg
    5160}}}
    52 zip で固められた Python egg ファイルと同じ名前のディレクトリ (拡張子が `.egg` で終わっているもの) ができ、そのなかに解凍した中身が入っているでしょう。
     61You should end up with a directory having the same name as the zipped egg (complete with `.egg` extension) and containing its uncompressed contents.
    5362
    54 Trac はまた `$prefix/share/trac/plugins` 配下に、グローバルにインストールされたプラグインを検索します ''(0.10 以降)''。
     63Trac also searches for globally installed plugins ''(since 0.10)'', see TracIni#GlobalConfiguration.
    5564
    56 ==== ソースから ====
     65==== From source ====
    5766
    58 Subversion からダウンロードしたプラグインのソースや zip で固められたソースファイルはソース中に含まれている `setup.py` を使用してインストールできます:
     67`easy_install` makes installing from source a snap. Just give it the URL to either a Subversion repository or a tarball/zip of the source:
    5968{{{
    60 $ python setup.py install
     69easy_install http://svn.edgewall.com/repos/trac/sandbox/spam-filter
    6170}}}
    6271
    63 ==== プラグインを有効にする ====
    64 個別の TracEnvironment にプラグインをインストールする場合と異なり、システム全体にインストールしたプラグインを有効にするためには、 [wiki:TracIni trac.ini] ファイルで明示的に指定しなければいけません。これは設定ファイルの `[components]` セクションに次のような記載を行います:
     72==== Enabling the plugin ====
     73Unlike plugins installed per-environment, you'll have to explicitly enable globally installed plugins via [wiki:TracIni trac.ini]. This is done in the `[components]` section of the configuration file, for example:
    6574{{{
    6675[components]
    67 webadmin.* = enabled
     76tracspamfilter.* = enabled
    6877}}}
    6978
    70 オプションの名前はプラグインの Python パッケージ名です。これはプラグインのドキュメンテーションに指定されていなければいけませんが、ソースを見れば簡単に見つけることが出来ます。(最上位のディレクトリにあるファイル `__init__.py` を探してください。)
     79The 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`.)
    7180
    72 Note: プラグインのインストール後、 Apache を再起動する必要があるでしょう。
     81Note: After installing the plugin, you need to restart your web server.
    7382
    74 == プラグインのキャッシュの設定 ==
     83==== Uninstalling ====
    7584
    76 いくつかのプラグインは Python eggs のランタイム (`pkg_resources`) によって解凍される必要があります。というのもそれらの内容がファイルシステム上に実際に存在する必要があるからです。通常、 Python eggs は現在のユーザのホームディレクトリに解凍されますが、それにより問題が発生するかもしれません。その場合、環境変数 `PYTHON_EGG_CACHE` を設定してデフォルトのロケーションを上書きすることができます。
     85`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:
     86 1. Do `easy_install -m [plugin name]` to remove references from `$PYTHONLIB/site-packages/easy-install.pth` when the plugin installed by setuptools.
     87 1. Delete executables from `/usr/bin`, `/usr/local/bin` or `C:\\Python*\Scripts`. For search what executables are there, you may refer to `[console-script]` section of `setup.py`.
     88 1. Delete the .egg file or folder from where it is installed, usually inside `$PYTHONLIB/site-packages/`.
     89 1. Restart web server.
    7790
    78 `PYTHON_EGG_CACHE` を `SetEnv` ディレクティブを使用して Apache に設定するには以下のようにします:
     91If you are uncertain about the location of the egg, here is a small tip to help locate an egg (or any package) - replace `myplugin` with whatever namespace the plugin uses (as used when enabling the plugin):
     92{{{
     93>>> import myplugin
     94>>> print myplugin.__file__
     95/opt/local/python24/lib/site-packages/myplugin-0.4.2-py2.4.egg/myplugin/__init__.pyc
     96}}}
     97
     98== Setting up the Plugin Cache ==
     99
     100Some plugins will need to be extracted by the Python eggs runtime (`pkg_resources`), so that their contents are actual files on the file system. The directory in which they are extracted defaults to the home directory of the current user, which may or may not be a problem. You can however override the default location using the `PYTHON_EGG_CACHE` environment variable.
     101
     102To do this from the Apache configuration, use the `SetEnv` directive as follows:
    79103{{{
    80104SetEnv PYTHON_EGG_CACHE /path/to/dir
    81105}}}
    82106
    83 これは [wiki:TracCgi CGI] と [wiki:TracModPython mod_python] のどちらをフロントエンドにしようと動作します。このディレクティブに [wiki:TracEnvironment Trac Environment] へのパスに設定し、例えば同じ `<Location>` ブロックにおいてください。
     107This works whether you are using the [wiki:TracCgi CGI] or the [wiki:TracModPython mod_python] front-end. Put this directive next to where you set the path to the [wiki:TracEnvironment Trac environment], i.e. in the same `<Location>` block.
    84108
    85 例 (CGI用):
     109For example (for CGI):
    86110{{{
    87111 <Location /trac>
     
    91115}}}
    92116
    93 例 (mod_python用):
     117or (for mod_python):
    94118{{{
    95119 <Location /trac>
     
    100124}}}
    101125
    102  ''Note: これは `mod_env` モジュールが必要です。''
     126 ''Note: this requires the `mod_env` module''
    103127
    104 [wiki:TracFastCgi FastCGI] で、 Web サーバに設定するためには、 `-initial-env` オプションやサーバーが指定している方法で、環境変数を設定する必要があります。
     128For [wiki:TracFastCgi FastCGI], you'll need to `-initial-env` option, or whatever is provided by your web server for setting environment variables.
    105129
    106 === Subversion の フックスクリプトについて ===
     130 ''Note: that if you already use -initial-env to set the project directory for either a single project or parent you will need to add atleast one environment variable inside trac.fcgi as expressed in the example on [wiki:TracFastCgi TracFastCgi].
    107131
    108 もし、 Trac エンジンを呼び出すような Subversion の フックスクリプト - Trac の配布物の `/contrib` ディレクトリで提供されている post-commit フックスクリプトなど - を設定していたら、プラグインと同様にスクリプトの中で環境変数 `PYTHON_EGG_CACHE` を定義して下さい。
     132=== About hook scripts ===
    109133
    110 == トラブルシューティング ==
     134If you have set up some subversion hook scripts that call the Trac engine - such as the post-commit hook script provided in the `/contrib` directory - make sure you define the `PYTHON_EGG_CACHE` environment variable within these scripts as well.
    111135
    112 === setuptools は正しくインストールされていますか? ===
     136== Troubleshooting ==
    113137
    114 これコマンドラインで実行してみてください:
     138=== Is setuptools properly installed? ===
     139
     140Try this from the command line:
    115141{{{
    116142$ python -c "import pkg_resources"
    117143}}}
    118144
    119 もし、コマンドラインから '''何も''' かえって来なければ、 setuptools はインストール '''されています'''。そうでなければ、 Trac を動かす前に setuptools をインストールする必要があります。
     145If you get '''no output''', setuptools '''is''' installed. Otherwise, you'll need to install it before plugins will work in Trac.
    120146
    121 === Python egg は正しいバージョンですか? ===
     147=== Did you get the correct version of the Python egg? ===
    122148
    123 Python egg はファイル名の中で Python のバージョンをエンコードします。例えば、 `MyPlugin-1.0-py2.4.egg` は Python 2.4 用の Python egg であり、異なる Python のバージョン (2.3 や 2.5) で動かそうとしても '''動かない''' でしょう。
     149Python eggs have the Python version encoded in their filename. For example, `MyPlugin-1.0-py2.4.egg` is an egg for Python 2.4, and will '''not''' be loaded if you're running a different Python version (such as 2.3 or 2.5).
    124150
    125 また、ダウンロードした Python egg ファイル が本当に ZIP アーカイブであるかどうかを確認して下さい。もし Trac サイトからダウンロードしたとしたら、 HTML プレビューページを代わりにダウンロードしているかもしれません。
     151Also, 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.
    126152
    127 === プラグインは有効になっていますか? ===
     153=== Is the plugin enabled? ===
    128154
    129 グローバル領域にプラグインをインストールした場合 (TracEnvironment の `plugin` ディレクトリ内 ''ではなく'') 、 [TracIni trac.ini] に明確に有効にする設定をしなければなりません。以下の事項を確認して下さい:
    130  * `[components]` セクションに必要な行数を追加したか。
    131  * パッケージ / モジュール名は正しいか
    132  * もし、(クラスに対して) モジュールを参照しているならば、必要に応じて、 ".*" を追加しているかどうか。
    133  * 正しい値、 "enabled" になっているかどうか。例えば、 "enable" ではなく。
     155If you install a plugin globally (i.e. ''not'' inside the `plugins` directory of the Trac project environment) you will have to explicitly enable it in [TracIni trac.ini]. Make sure that:
     156 * you actually added the necessary line(s) to the `[components]` section
     157 * the package/module names are correct
     158 * the value is “enabled", not e.g. “enable”
    134159
    135 === Python egg ファイルのパーミッションのチェック ===
     160=== Check the permissions on the egg file ===
    136161
    137 Trac はもちろん Python egg ファイルを読めなければいけません。分かってるよね。;-)
     162Trac must be able to read the file.
    138163
    139 === ログファイルのチェック ===
     164=== Check the log files ===
    140165
    141 Trac で [TracLogging logging] を有効にし、ログレベルを `DEBUG` に設定し、プラグインがロードされるときのログメッセージを見て下さい。
     166Enable [wiki:TracLogging logging] and set the log level to `DEBUG`, then watch the log file for messages about loading plugins.
     167
     168=== Verify you have proper permissions ===
     169
     170Some plugins require you have special permissions in order to use them. WebAdmin, for example, requires the user to have TRAC_ADMIN permissions for it to show up on the navigation bar.
     171
     172=== Is the wrong version of the plugin loading? ===
     173
     174If 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:
     175 * Only one version of the plugin can be loaded for each running Trac server (ie. 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.
     176 * A globally installed plugin (typically `setup.py install`) will override any version in global or project plugins directories. A plugin from the global plugins directory will be located before any project plugins directory.
     177 * If your Trac server hosts more than one project (as with `TRAC_ENV_PARENT_DIR` setups), then 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 found - basically from the project that receives the first request.
     178 * Having more than one version listed inside Python site-packages is fine (ie. 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.
     179
     180=== If all of the above failed ===
     181
     182OK, 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 the trac.ini) and it still doesn't work or give any error messages or any other indication as to why? Hop on the IrcChannel and ask away.
    142183
    143184----
    144 See also TracGuide, [http://trac.edgewall.org/wiki/PluginList プラグイン一覧], [http://trac.edgewall.org/wiki/TracDev/ComponentArchitecture コンポーネント設計]
     185See also TracGuide, [trac:PluginList plugin list], [trac:TracDev/ComponentArchitecture component architecture]