Changes between Version 1 and Version 2 of TracPlugins

08/27/15 23:20:06 (4 years ago)



  • TracPlugins

    v1 v2  
    1 = Trac プラグイン =
    2 [[TracGuideToc]]
    4 バージョン 0.9 以降、 Trac はプラグイン機能に対応し、組み込み機能を拡張できるようになりました。プラグインの機能は [ コンポーネント設計] に基づいています。
    6 == 必要条件 ==
    8 Python egg が基になっている Trac のプラグインを使用するためには、 [ setuptools] (バージョン 0.6) をインストールしなければなりません。
    10 プラグインは単一の `.py` ファイルから成り立っていて、各 TracEnvironment かグローバルの `plugin` ディレクトリに配置します。 ''([ milestone:0.10] 以降)''
    12 `setuptools` をインストールするために、ブートストラップモジュールである [] をダウンロードし、以下に示すように実行して下さい:
    13 {{{
     3= Trac plugins
     5Trac is extensible with [trac:PluginList plugins]. Plugin functionality is based on the [trac:TracDev/ComponentArchitecture component architecture], with special cases described in the [trac:TracDev/PluginDevelopment plugin development] page.
     7== Plugin discovery
     9From the user's point of view, a plugin is either a standalone .py file or an .egg package. Trac looks for plugins in Python's `site-packages` directory, the [TracIni#GlobalConfiguration global shared] `plugins` directory and the [TracEnvironment project environment] `plugins` directory. Components defined in globally-installed plugins must be explicitly enabled in the [[TracIni#components-section| [components] ]] section of the `trac.ini` file. Components defined in the `plugins` directory of the project environment are enabled, unless explicitly disabled in the `[components]` section of the `trac.ini` file.
     11== Requirements for Trac eggs #Requirements
     13To use egg-based plugins in Trac, you need to have [ setuptools] (version >= 0.6) installed.
     15To install `setuptools`, download the bootstrap module [] and execute it as follows:
    1418$ python
    17 もし `` スクリプトが setuptools のインストールに失敗したら、 [ PyPI] をダウンロードして手動でインストールしてください。
    19 == Trac プラグインのインストール ==
    21 === 単一のプロジェクト ===
    23 プラグインは [ Python eggs] としてパッケージ化されています。つまり、拡張子が `.egg` となっている ZIP アーカイブのファイルです。プラグインのソースコードディストリビューションをダウンロードした場合は、以下のコマンドを実行して下さい:
    24 {{{
     21If the `` script fails to install the setuptools release, you can download it from [pypi:setuptools PyPI] and install it manually.
     23Plugins can also consist of a single `.py` file dropped directly into either the project's or the shared `plugins` directory.
     25== Installing a Trac plugin
     27=== For a single project
     29Plugins are typically packaged as [ Python eggs]. That means they are .zip archives with the file extension `.egg`.
     31If you have downloaded a source distribution of a plugin, and want to build the `.egg` file:
     33 * Unpack the source. It should provide ``.
     34 * Run:
     35 {{{#!sh
    2536$ python bdist_egg
    27 `.egg` ファイルをビルドできます。
    29 一度、プラグインアーカイブを作成したら、 [wiki:TracEnvironment TracEnvironment] の `plugins` ディレクトリにコピーする必要があります。また、 Web サーバーが egg プラグインを読み取るのに必要なパーミッションをつけてください。
    31 Python egg をビルドするための Python のバージョンと
    32 Trac を動かしている Python のバージョンが一致しなければなりません。
    33 例えば、 Trac を Python のバージョン 2.3 以前で動かしていて、
    34 2.4 にアップグレードしたときに、
    35 Python egg は認識されなくなるでしょう。
    37 === すべてのプロジェクト ===
    39 ==== 単一の .egg ファイル ====
    41 いくつかのプラグイン (例えば [ WebAdmin]) は `.egg` ファイルとしてダウンロードし、 `easy_install` プログラムでインストールすることができます:
    42 {{{
    43 easy_install TracWebAdmin-0.1.1dev_r2765-py2.3.egg
    44 }}}
    46 もし、システムに `easy_install` がなくてプラグインをインストールするには上記の必要条件のセクションを見て下さい。 Windows ユーザは `Scripts` ディレクトリを Python をインストールしたディレクトリ (例えば、 `C:\Python23\Scripts`) を環境変数 `PATH` に加えなければなりません。 (より詳しい情報は、 [ easy_install の Windows Notes] を参照して下さい。)
    48 zipで固められた Python egg をインストールし、 Web サーバに Python egg のキャッシュディレクトリに書き込み権限をつけているのにも関わらず、 Trac がパーミッションエラーを出したら、 解凍した Python egg を単に置き直すことによって回避できます。 `easy_install` に `--always-unzip` オプションを付けるだけです:
    49 {{{
    50 easy_install --always-unzip TracWebAdmin-0.1.1dev_r2765-py2.3.egg
    51 }}}
    52 zip で固められた Python egg ファイルと同じ名前のディレクトリ (拡張子が `.egg` で終わっているもの) ができ、そのなかに解凍した中身が入っているでしょう。
    54 Trac はまた `$prefix/share/trac/plugins` 配下に、グローバルにインストールされたプラグインを検索します ''(0.10 以降)''。
    56 ==== ソースから ====
    58 Subversion からダウンロードしたプラグインのソースや zip で固められたソースファイルはソース中に含まれている `` を使用してインストールできます:
    59 {{{
    60 $ python install
    61 }}}
    63 ==== プラグインを有効にする ====
    64 個別の TracEnvironment にプラグインをインストールする場合と異なり、システム全体にインストールしたプラグインを有効にするためには、 [wiki:TracIni trac.ini] ファイルで明示的に指定しなければいけません。これは設定ファイルの `[components]` セクションに次のような記載を行います:
    65 {{{
     39You should now have an *.egg file. Examine the output of running Python to find where this was created.
     41Once 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, ie kill the process and run again.
     43To uninstall a plugin installed this way, remove the egg from the `plugins` directory and restart the web server.
     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 are running Trac under Python 2.6, but have upgraded your standalone Python to 2.7, the eggs won't be recognized.
     47'''Note''': 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.
     49=== For all projects
     51==== With an .egg file
     53Some plugins, such as [trac:SpamFilter SpamFilter], are downloadable as an `.egg` file that can be installed with `easy_install` or `pip`:
     55$ easy_install TracSpamFilter
     56$ pip install TracSpamFilter
     59If `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:\Python27\Scripts`) to their `PATH` environment variable, or use the full path to `easy_install` (for example, `C:\Python27\Scripts\`). See [ easy_install Windows notes] for more information.
     61`pip` is included in Python 2.7.9. In earlier versions of Python it can be installed through the package manager of your OS (e.g. `apt-get install python-pip`) or using the [].
     63If Trac reports permission errors after installing a zipped egg, and you would rather not bother providing an 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`:
     65$ easy_install --always-unzip TracSpamFilter-0.4.1_r10106-py2.6.egg
     67You should end up with a directory having the same name as the zipped egg, complete with `.egg` extension, and containing its uncompressed contents.
     69Trac also searches for plugins installed in the shared plugins directory, see TracIni#GlobalConfiguration. This is a convenient way to share the installation of plugins across several, but not all, environments.
     71==== From source
     73`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:
     75$ easy_install
     78==== Enabling the plugin
     80Unlike plugins installed per environment, you'll have to explicitly enable globally installed plugins via [wiki:TracIni trac.ini]. This also applies to plugins installed in the shared plugins directory, ie the path specified in the `[inherit] plugins_dir` configuration option.
     82This is done in the `[components]` section of the configuration file `trac.ini`. For example:
    67 webadmin.* = enabled
    68 }}}
    70 オプションの名前はプラグインの Python パッケージ名です。これはプラグインのドキュメンテーションに指定されていなければいけませんが、ソースを見れば簡単に見つけることが出来ます。(最上位のディレクトリにあるファイル `` を探してください。)
    72 Note: プラグインのインストール後、 Apache を再起動する必要があるでしょう。
    74 == プラグインのキャッシュの設定 ==
    76 いくつかのプラグインは Python eggs のランタイム (`pkg_resources`) によって解凍される必要があります。というのもそれらの内容がファイルシステム上に実際に存在する必要があるからです。通常、 Python eggs は現在のユーザのホームディレクトリに解凍されますが、それにより問題が発生するかもしれません。その場合、環境変数 `PYTHON_EGG_CACHE` を設定してデフォルトのロケーションを上書きすることができます。
    78 `PYTHON_EGG_CACHE` を `SetEnv` ディレクティブを使用して Apache に設定するには以下のようにします:
    79 {{{
     85tracspamfilter.* = enabled
     88The 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 ``.
     90After installing the plugin, you must restart your web server.
     92==== Upgrading the environment
     94Some plugins may require an environment upgrade. This will typically be necessary for plugins that implement `IEnvironmentSetupParticipant`. Common reasons for requiring an environment upgrade are to add tables to the database or add configuration parameters to trac.ini. A notification will be displayed when accessing Trac for the first time after installing a plugin and restarting the web server. To upgrade the environment, run the command:
     97$ trac-admin /path/to/env upgrade
     100A database backup will be made before upgrading the environment, unless the `--no-backup` option is specified. For more information, refer to the documentation output by `trac-admin /path/to/env help upgrade`.
     102==== Uninstalling
     104Neither `easy_install` nor `python` have an uninstall feature. However, it is usually trivial to remove a globally installed egg and reference:
     106 1. Do `easy_install -m [plugin name]` to remove references from `$PYTHONLIB/site-packages/easy-install.pth` when the plugin installed by setuptools.
     107 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 ``.
     108 1. Delete the .egg file or folder from where it's installed, usually inside `$PYTHONLIB/site-packages/`.
     109 1. Restart the web server.
     111If you are uncertain about the location of the egg file, you can try to locate it by replacing `myplugin` with whatever namespace the plugin uses (as used when enabling the plugin):
     113>>> import myplugin
     114>>> print myplugin.__file__
     118== Setting up the plugin cache
     120Some plugins will need to be extracted by the Python egg's runtime (`pkg_resources`), so that their contents are actual files on the file system. The directory in which they are extracted defaults to `.python-eggs` in 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.
     122To do this from the Apache configuration, use the `SetEnv` directive:
    80124SetEnv PYTHON_EGG_CACHE /path/to/dir
    83 これは [wiki:TracCgi CGI] と [wiki:TracModPython mod_python] のどちらをフロントエンドにしようと動作します。このディレクティブに [wiki:TracEnvironment Trac Environment] へのパスに設定し、例えば同じ `<Location>` ブロックにおいてください。
    85 例 (CGI用):
    86 {{{
     127This works whether you're 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], ie in the same `<Location>` block.
     129For example for CGI:
    87131 <Location /trac>
    88132   SetEnv TRAC_ENV /path/to/projenv
    93 例 (mod_python用):
    94 {{{
     137Or for mod_python:
    95139 <Location /trac>
    96140   SetHandler mod_python
    102  ''Note: これは `mod_env` モジュールが必要です。''
    104 [wiki:TracFastCgi FastCGI] で、 Web サーバに設定するためには、 `-initial-env` オプションやサーバーが指定している方法で、環境変数を設定する必要があります。
    106 === Subversion の フックスクリプトについて ===
    108 もし、 Trac エンジンを呼び出すような Subversion の フックスクリプト - Trac の配布物の `/contrib` ディレクトリで提供されている post-commit フックスクリプトなど - を設定していたら、プラグインと同様にスクリプトの中で環境変数 `PYTHON_EGG_CACHE` を定義して下さい。
    110 == トラブルシューティング ==
    112 === setuptools は正しくインストールされていますか? ===
    114 これコマンドラインで実行してみてください:
    115 {{{
     146'''Note''': !SetEnv requires the `mod_env` module, which needs to be activated for Apache. In this case the !SetEnv directive can also be used in the `mod_python` Location block.
     148For [wiki:TracFastCgi FastCGI], you'll need to `-initial-env` option, or whatever is provided by your web server for setting environment variables.
     150'''Note''': if you already use -initial-env to set the project directory for either a single project or parent, you will need to add an additional -initial-env directive to the !FastCgiConfig directive:
     153FastCgiConfig -initial-env TRAC_ENV=/var/lib/trac -initial-env PYTHON_EGG_CACHE=/var/lib/trac/plugin-cache
     156=== About hook scripts
     158If 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.
     160== Web-based plugin administration
     162The [trac:WebAdmin] interface offers limited support for plugin configuration through the web to users with `TRAC_ADMIN` permission:
     164* en/disabling installed plugins
     165* installing plugins by uploading them as eggs
     167If you wish to disable the second function for security reasons, add the following to your `trac.ini` file:
     170trac.admin.web_ui.PluginAdminPanel = disabled
     172This disables the whole panel, so the first function will no longer be available either.
     174== Troubleshooting
     176=== Is setuptools properly installed?
     178Try this from the command line:
    116180$ python -c "import pkg_resources"
    119 もし、コマンドラインから '''何も''' かえって来なければ、 setuptools はインストール '''されています'''。そうでなければ、 Trac を動かす前に setuptools をインストールする必要があります。
    121 === Python egg は正しいバージョンですか? ===
    123 Python egg はファイル名の中で Python のバージョンをエンコードします。例えば、 `MyPlugin-1.0-py2.4.egg` は Python 2.4 用の Python egg であり、異なる Python のバージョン (2.3 や 2.5) で動かそうとしても '''動かない''' でしょう。
    125 また、ダウンロードした Python egg ファイル が本当に ZIP アーカイブであるかどうかを確認して下さい。もし Trac サイトからダウンロードしたとしたら、 HTML プレビューページを代わりにダウンロードしているかもしれません。
    127 === プラグインは有効になっていますか? ===
    129 グローバル領域にプラグインをインストールした場合 (TracEnvironment の `plugin` ディレクトリ内 ''ではなく'') 、 [TracIni trac.ini] に明確に有効にする設定をしなければなりません。以下の事項を確認して下さい:
    130  * `[components]` セクションに必要な行数を追加したか。
    131  * パッケージ / モジュール名は正しいか
    132  * もし、(クラスに対して) モジュールを参照しているならば、必要に応じて、 ".*" を追加しているかどうか。
    133  * 正しい値、 "enabled" になっているかどうか。例えば、 "enable" ではなく。
    135 === Python egg ファイルのパーミッションのチェック ===
    137 Trac はもちろん Python egg ファイルを読めなければいけません。分かってるよね。;-)
    139 === ログファイルのチェック ===
    141 Trac で [TracLogging logging] を有効にし、ログレベルを `DEBUG` に設定し、プラグインがロードされるときのログメッセージを見て下さい。
     183If you get '''no output''', setuptools '''is''' installed. Otherwise, you'll need to install it before plugins will work in Trac.
     185=== Did you get the correct version of the Python egg?
     187Python 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).
     189Also, 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.
     191=== Is the plugin enabled?
     193If you install a plugin globally, ie ''not'' inside the `plugins` directory of the Trac project environment, you must explicitly enable it in [TracIni trac.ini]. Make sure that:
     195 * you actually added the necessary line(s) to the `[components]` section.
     196 * the package/module names are correct and do not contain typos.
     197 * the value is "enabled", not "enable" or "Enable".
     198 * the section name is "components", not "component".
     200=== Check the permissions on the .egg file
     202Trac must be able to read the .egg file.
     204=== Check the log files
     206Enable [wiki:TracLogging logging] and set the log level to `DEBUG`, then watch the log file for messages about loading plugins.
     208=== Verify you have the proper permissions
     210Some 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.
     212=== Is the wrong version of the plugin loading?
     214If 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:
     216 * 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.
     217 * A globally installed plugin (typically ` 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.
     218 * 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 unpredicatable 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.
     219 * Having more than one version listed inside Python site-packages is fine, ie installed with ` install`, because 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 the version number nor the 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.
     221=== If all of the above failed
     223Okay, 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!
    144 See also TracGuide, [ プラグイン一覧], [ コンポーネント設計]
     226See also TracGuide, [trac:PluginList plugin list], [trac:TracDev/ComponentArchitecture component architecture].