1
# Copyright (C) 2004, 2005 by Canonical Ltd
1
# Copyright (C) 2004, 2005 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
# This module implements plug-in support.
19
# Any python module in $BZR_PLUGIN_PATH will be imported upon initialization
20
# of bzrlib (and then forgotten about). In the plugin's main body, it should
21
# update any bzrlib registries it wants to extend; for example, to add new
22
# commands, import bzrlib.commands and add your new command to the
23
# plugin_cmds variable.
18
"""bzr python plugin support
20
Any python module in $BZR_PLUGIN_PATH will be imported upon initialization of
21
bzrlib. The module will be imported as 'bzrlib.plugins.$BASENAME(PLUGIN)'.
22
In the plugin's main body, it should update any bzrlib registries it wants to
23
extend; for example, to add new commands, import bzrlib.commands and add your
24
new command to the plugin_cmds variable.
27
# TODO: Refactor this to make it more testable. The main problem at the
28
# moment is that loading plugins affects the global process state -- for bzr
29
# in general use it's a reasonable assumption that all plugins are loaded at
30
# startup and then stay loaded, but this is less good for testing.
32
# Several specific issues:
33
# - plugins can't be unloaded and will continue to effect later tests
34
# - load_plugins does nothing if called a second time
35
# - plugin hooks can't be removed
37
# Our options are either to remove these restrictions, or work around them by
38
# loading the plugins into a different space than the one running the tests.
39
# That could be either a separate Python interpreter or perhaps a new
40
# namespace inside this interpreter.
27
from bzrlib.osutils import config_dir
28
DEFAULT_PLUGIN_PATH = os.path.join(config_dir(), 'plugins')
45
from bzrlib.lazy_import import lazy_import
46
lazy_import(globals(), """
57
from bzrlib.trace import mutter, warning, log_exception_quietly
60
DEFAULT_PLUGIN_PATH = None
63
def get_default_plugin_path():
64
"""Get the DEFAULT_PLUGIN_PATH"""
65
global DEFAULT_PLUGIN_PATH
66
if DEFAULT_PLUGIN_PATH is None:
67
DEFAULT_PLUGIN_PATH = osutils.pathjoin(config.config_dir(), 'plugins')
68
return DEFAULT_PLUGIN_PATH
75
"""Return a dictionary of the plugins."""
77
for name, plugin in plugins.__dict__.items():
78
if isinstance(plugin, types.ModuleType):
83
def disable_plugins():
84
"""Disable loading plugins.
86
Future calls to load_plugins() will be ignored.
88
# TODO: jam 20060131 This should probably also disable
34
94
def load_plugins():
36
Find all python plugins and load them.
38
Loading a plugin means importing it into the python interpreter.
39
The plugin is expected to make calls to register commands when
40
it's loaded (or perhaps access other hooks in future.)
42
A list of plugs is stored in bzrlib.plugin.all_plugins for future
95
"""Load bzrlib plugins.
45
97
The environment variable BZR_PLUGIN_PATH is considered a delimited
46
98
set of paths to look through. Each entry is searched for *.py
47
99
files (and whatever other extensions are used in the platform,
102
load_from_dirs() provides the underlying mechanism and is called with
103
the default directory list to provide the normal behaviour.
51
global all_plugins, _loaded
53
107
# People can make sure plugins are loaded, they just won't be twice
55
#raise BzrError("plugins already initialized")
60
from bzrlib.trace import log_error, mutter, log_exception
61
from bzrlib.errors import BzrError
62
from bzrlib import plugins
64
dirs = os.environ.get('BZR_PLUGIN_PATH', DEFAULT_PLUGIN_PATH).split(":")
111
dirs = os.environ.get('BZR_PLUGIN_PATH',
112
get_default_plugin_path()).split(os.pathsep)
65
113
dirs.insert(0, os.path.dirname(plugins.__file__))
67
# The problem with imp.get_suffixes() is that it doesn't include
68
# .pyo which is technically valid
69
# It also means that "testmodule.so" will show up as both test and testmodule
70
# though it is only valid as 'test'
71
# but you should be careful, because "testmodule.py" loads as testmodule.
72
suffixes = imp.get_suffixes()
73
suffixes.append(('.pyo', 'rb', imp.PY_COMPILED))
74
package_entries = ['__init__.py', '__init__.pyc', '__init__.pyo']
119
def load_from_dirs(dirs):
120
"""Load bzrlib plugins found in each dir in dirs.
122
Loading a plugin means importing it into the python interpreter.
123
The plugin is expected to make calls to register commands when
124
it's loaded (or perhaps access other hooks in future.)
126
Plugins are loaded into bzrlib.plugins.NAME, and can be found there
127
for future reference.
129
# Get the list of valid python suffixes for __init__.py?
130
# this includes .py, .pyc, and .pyo (depending on if we are running -O)
131
# but it doesn't include compiled modules (.so, .dll, etc)
132
valid_suffixes = [suffix for suffix, mod_type, flags in imp.get_suffixes()
133
if flags in (imp.PY_SOURCE, imp.PY_COMPILED)]
134
package_entries = ['__init__'+suffix for suffix in valid_suffixes]
76
# going through them one by one allows different plugins with the same
77
# filename in different directories in the path
78
mutter('looking for plugins in %s' % d)
138
mutter('looking for plugins in %s', d)
81
139
plugin_names = set()
82
140
if not os.path.isdir(d):
84
142
for f in os.listdir(d):
85
path = os.path.join(d, f)
143
path = osutils.pathjoin(d, f)
86
144
if os.path.isdir(path):
87
145
for entry in package_entries:
88
146
# This directory should be a package, and thus added to
90
if os.path.isfile(os.path.join(path, entry)):
148
if os.path.isfile(osutils.pathjoin(path, entry)):
92
150
else: # This directory is not a package
95
for suffix_info in suffixes:
153
for suffix_info in imp.get_suffixes():
96
154
if f.endswith(suffix_info[0]):
97
155
f = f[:-len(suffix_info[0])]
98
156
if suffix_info[2] == imp.C_EXTENSION and f.endswith('module'):
103
mutter('add plugin name %s' % f)
161
if getattr(plugins, f, None):
162
mutter('Plugin name %s already loaded', f)
164
# mutter('add plugin name %s', f)
106
167
plugin_names = list(plugin_names)
107
168
plugin_names.sort()
108
169
for name in plugin_names:
110
171
plugin_info = imp.find_module(name, [d])
111
mutter('load plugin %r' % (plugin_info,))
172
# mutter('load plugin %r', plugin_info)
113
plugin = imp.load_module('bzrlib.plugin.' + name,
174
plugin = imp.load_module('bzrlib.plugins.' + name,
115
all_plugins.append(plugin)
176
setattr(plugins, name, plugin)
117
178
if plugin_info[0] is not None:
118
179
plugin_info[0].close()
120
mutter('loaded succesfully')
122
log_error('Unable to load plugin %r from %r' % (name, d))
180
# mutter('loaded succesfully')
181
except KeyboardInterrupt:
184
## import pdb; pdb.set_trace()
185
warning('Unable to load plugin %r from %r' % (name, d))
186
log_exception_quietly()
189
def load_from_zips(zips):
190
"""Load bzr plugins from zip archives with zipimport.
191
It's similar to load_from_dirs but plugins searched inside archives.
196
valid_suffixes = ('.py', '.pyc', '.pyo') # only python modules/packages
198
for zip_name in zips:
199
if '.zip' not in zip_name:
202
ziobj = zipimport.zipimporter(zip_name)
203
except zipimport.ZipImportError:
206
mutter('Looking for plugins in %r', zip_name)
208
# use zipfile to get list of files/dirs inside zip
209
z = zipfile.ZipFile(ziobj.archive)
210
namelist = z.namelist()
214
prefix = ziobj.prefix.replace('\\','/')
216
namelist = [name[ix:]
218
if name.startswith(prefix)]
220
mutter('Names in archive: %r', namelist)
222
for name in namelist:
223
if not name or name.endswith('/'):
226
# '/' is used to separate pathname components inside zip archives
229
head, tail = '', name
231
head, tail = name.rsplit('/',1)
233
# we don't need looking in subdirectories
236
base, suffix = osutils.splitext(tail)
237
if suffix not in valid_suffixes:
240
if base == '__init__':
251
if getattr(plugins, plugin_name, None):
252
mutter('Plugin name %s already loaded', plugin_name)
256
plugin = ziobj.load_module(plugin_name)
257
setattr(plugins, plugin_name, plugin)
258
mutter('Load plugin %s from zip %r', plugin_name, zip_name)
259
except zipimport.ZipImportError, e:
260
mutter('Unable to load plugin %r from %r: %s',
261
plugin_name, zip_name, str(e))
263
except KeyboardInterrupt:
266
## import pdb; pdb.set_trace()
267
warning('Unable to load plugin %r from %r'
269
log_exception_quietly()
added
removed
bzrlib/plugin.py
