~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/plugin.py

  • Committer: Martin Pool
  • Date: 2005-07-18 13:38:13 UTC
  • Revision ID: mbp@sourcefrog.net-20050718133813-4343f0cde39537de
- refactor member names in Weave code

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2004, 2005 Canonical Ltd
2
 
#
 
1
# Copyright (C) 2004, 2005 by Canonical Ltd
 
2
 
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.
7
 
#
 
7
 
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.
12
 
#
 
12
 
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
16
16
 
17
17
 
18
 
"""bzr python plugin support.
19
 
 
20
 
When load_plugins() is invoked, any python module in any directory in
21
 
$BZR_PLUGIN_PATH will be imported.  The module will be imported as
22
 
'bzrlib.plugins.$BASENAME(PLUGIN)'.  In the plugin's main body, it should
23
 
update any bzrlib registries it wants to extend; for example, to add new
24
 
commands, import bzrlib.commands and add your new command to the plugin_cmds
25
 
variable.
26
 
 
27
 
BZR_PLUGIN_PATH is also honoured for any plugins imported via
28
 
'import bzrlib.plugins.PLUGINNAME', as long as set_plugins_path has been 
29
 
called.
30
 
"""
 
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.
 
24
 
31
25
 
32
26
import os
33
 
import sys
34
 
 
35
 
from bzrlib.lazy_import import lazy_import
36
 
lazy_import(globals(), """
37
 
import imp
38
 
import re
39
 
import types
40
 
import zipimport
41
 
 
42
 
from bzrlib import (
43
 
    config,
44
 
    osutils,
45
 
    plugins,
46
 
    )
47
 
""")
48
 
 
49
 
from bzrlib.trace import mutter, warning, log_exception_quietly
50
 
 
51
 
 
52
 
DEFAULT_PLUGIN_PATH = None
 
27
from bzrlib.osutils import config_dir
 
28
DEFAULT_PLUGIN_PATH = os.path.join(config_dir(), 'plugins')
 
29
 
 
30
all_plugins = []
53
31
_loaded = False
54
32
 
55
 
def get_default_plugin_path():
56
 
    """Get the DEFAULT_PLUGIN_PATH"""
57
 
    global DEFAULT_PLUGIN_PATH
58
 
    if DEFAULT_PLUGIN_PATH is None:
59
 
        DEFAULT_PLUGIN_PATH = osutils.pathjoin(config.config_dir(), 'plugins')
60
 
    return DEFAULT_PLUGIN_PATH
61
 
 
62
 
 
63
 
def all_plugins():
64
 
    """Return a dictionary of the plugins."""
65
 
    result = {}
66
 
    for name, plugin in plugins.__dict__.items():
67
 
        if isinstance(plugin, types.ModuleType):
68
 
            result[name] = plugin
69
 
    return result
70
 
 
71
 
 
72
 
def disable_plugins():
73
 
    """Disable loading plugins.
74
 
 
75
 
    Future calls to load_plugins() will be ignored.
76
 
    """
77
 
    # TODO: jam 20060131 This should probably also disable
78
 
    #       load_from_dirs()
79
 
    global _loaded
80
 
    _loaded = True
81
 
 
82
 
 
83
 
def set_plugins_path():
84
 
    """Set the path for plugins to be loaded from."""
85
 
    path = os.environ.get('BZR_PLUGIN_PATH',
86
 
                          get_default_plugin_path()).split(os.pathsep)
87
 
    # search the plugin path before the bzrlib installed dir
88
 
    path.append(os.path.dirname(plugins.__file__))
89
 
    plugins.__path__ = path
90
 
    return path
91
 
 
92
33
 
93
34
def load_plugins():
94
 
    """Load bzrlib plugins.
 
35
    """
 
36
    Find all python plugins and load them.
 
37
 
 
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.)
 
41
 
 
42
    A list of plugs is stored in bzrlib.plugin.all_plugins for future
 
43
    reference.
95
44
 
96
45
    The environment variable BZR_PLUGIN_PATH is considered a delimited
97
46
    set of paths to look through. Each entry is searched for *.py
98
47
    files (and whatever other extensions are used in the platform,
99
48
    such as *.pyd).
 
49
    """
100
50
 
101
 
    load_from_dirs() provides the underlying mechanism and is called with
102
 
    the default directory list to provide the normal behaviour.
103
 
    """
104
 
    global _loaded
 
51
    global all_plugins, _loaded
105
52
    if _loaded:
106
53
        # People can make sure plugins are loaded, they just won't be twice
107
54
        return
 
55
        #raise BzrError("plugins already initialized")
108
56
    _loaded = True
109
57
 
110
 
    # scan for all plugins in the path.
111
 
    load_from_path(set_plugins_path())
112
 
 
113
 
 
114
 
def load_from_path(dirs):
115
 
    """Load bzrlib plugins found in each dir in dirs.
116
 
 
117
 
    Loading a plugin means importing it into the python interpreter.
118
 
    The plugin is expected to make calls to register commands when
119
 
    it's loaded (or perhaps access other hooks in future.)
120
 
 
121
 
    Plugins are loaded into bzrlib.plugins.NAME, and can be found there
122
 
    for future reference.
123
 
 
124
 
    The python module path for bzrlib.plugins will be modified to be 'dirs'.
125
 
    """
126
 
    plugins.__path__ = dirs
127
 
    for d in dirs:
 
58
    import sys, os, imp
 
59
    try:
 
60
        set
 
61
    except NameError:
 
62
        from sets import Set as set         # python2.3
 
63
 
 
64
    from bzrlib.trace import log_error, mutter, log_exception
 
65
    from bzrlib.errors import BzrError
 
66
 
 
67
    bzrpath = os.environ.get('BZR_PLUGIN_PATH', DEFAULT_PLUGIN_PATH)
 
68
 
 
69
    # The problem with imp.get_suffixes() is that it doesn't include
 
70
    # .pyo which is technically valid
 
71
    # It also means that "testmodule.so" will show up as both test and testmodule
 
72
    # though it is only valid as 'test'
 
73
    # but you should be careful, because "testmodule.py" loads as testmodule.
 
74
    suffixes = imp.get_suffixes()
 
75
    suffixes.append(('.pyo', 'rb', imp.PY_COMPILED))
 
76
    package_entries = ['__init__.py', '__init__.pyc', '__init__.pyo']
 
77
    for d in bzrpath.split(os.pathsep):
 
78
        # going through them one by one allows different plugins with the same
 
79
        # filename in different directories in the path
 
80
        mutter('looking for plugins in %s' % d)
128
81
        if not d:
129
82
            continue
130
 
        mutter('looking for plugins in %s', d)
131
 
        if os.path.isdir(d):
132
 
            load_from_dir(d)
133
 
        else:
134
 
            # it might be a zip: try loading from the zip.
135
 
            load_from_zip(d)
 
83
        plugin_names = set()
 
84
        if not os.path.isdir(d):
136
85
            continue
137
 
 
138
 
 
139
 
# backwards compatability: load_from_dirs was the old name
140
 
# This was changed in 0.15
141
 
load_from_dirs = load_from_path
142
 
 
143
 
 
144
 
def load_from_dir(d):
145
 
    """Load the plugins in directory d."""
146
 
    # Get the list of valid python suffixes for __init__.py?
147
 
    # this includes .py, .pyc, and .pyo (depending on if we are running -O)
148
 
    # but it doesn't include compiled modules (.so, .dll, etc)
149
 
    valid_suffixes = [suffix for suffix, mod_type, flags in imp.get_suffixes()
150
 
                              if flags in (imp.PY_SOURCE, imp.PY_COMPILED)]
151
 
    package_entries = ['__init__'+suffix for suffix in valid_suffixes]
152
 
    plugin_names = set()
153
 
    for f in os.listdir(d):
154
 
        path = osutils.pathjoin(d, f)
155
 
        if os.path.isdir(path):
156
 
            for entry in package_entries:
157
 
                # This directory should be a package, and thus added to
158
 
                # the list
159
 
                if os.path.isfile(osutils.pathjoin(path, entry)):
160
 
                    break
161
 
            else: # This directory is not a package
162
 
                continue
163
 
        else:
164
 
            for suffix_info in imp.get_suffixes():
165
 
                if f.endswith(suffix_info[0]):
166
 
                    f = f[:-len(suffix_info[0])]
167
 
                    if suffix_info[2] == imp.C_EXTENSION and f.endswith('module'):
168
 
                        f = f[:-len('module')]
169
 
                    break
 
86
        for f in os.listdir(d):
 
87
            path = os.path.join(d, f)
 
88
            if os.path.isdir(path):
 
89
                for entry in package_entries:
 
90
                    # This directory should be a package, and thus added to
 
91
                    # the list
 
92
                    if os.path.isfile(os.path.join(path, entry)):
 
93
                        break
 
94
                else: # This directory is not a package
 
95
                    continue
170
96
            else:
171
 
                continue
172
 
        if getattr(plugins, f, None):
173
 
            mutter('Plugin name %s already loaded', f)
174
 
        else:
175
 
            # mutter('add plugin name %s', f)
 
97
                for suffix_info in suffixes:
 
98
                    if f.endswith(suffix_info[0]):
 
99
                        f = f[:-len(suffix_info[0])]
 
100
                        if suffix_info[2] == imp.C_EXTENSION and f.endswith('module'):
 
101
                            f = f[:-len('module')]
 
102
                        break
 
103
                else:
 
104
                    continue
 
105
            mutter('add plugin name %s' % f)
176
106
            plugin_names.add(f)
177
 
    
178
 
    for name in plugin_names:
179
 
        try:
180
 
            exec "import bzrlib.plugins.%s" % name in {}
181
 
        except KeyboardInterrupt:
182
 
            raise
183
 
        except Exception, e:
184
 
            ## import pdb; pdb.set_trace()
185
 
            if re.search('\.|-| ', name):
186
 
                warning('Unable to load plugin %r from %r: '
187
 
                    'It is not a valid python module name.' % (name, d))
188
 
            else:
189
 
                warning('Unable to load plugin %r from %r' % (name, d))
190
 
            log_exception_quietly()
191
 
 
192
 
 
193
 
def load_from_zip(zip_name):
194
 
    """Load all the plugins in a zip."""
195
 
    valid_suffixes = ('.py', '.pyc', '.pyo')    # only python modules/packages
196
 
                                                # is allowed
197
 
    if '.zip' not in zip_name:
198
 
        return
199
 
    try:
200
 
        ziobj = zipimport.zipimporter(zip_name)
201
 
    except zipimport.ZipImportError:
202
 
        # not a valid zip
203
 
        return
204
 
    mutter('Looking for plugins in %r', zip_name)
205
 
    
206
 
    import zipfile
207
 
 
208
 
    # use zipfile to get list of files/dirs inside zip
209
 
    z = zipfile.ZipFile(ziobj.archive)
210
 
    namelist = z.namelist()
211
 
    z.close()
212
 
    
213
 
    if ziobj.prefix:
214
 
        prefix = ziobj.prefix.replace('\\','/')
215
 
        ix = len(prefix)
216
 
        namelist = [name[ix:]
217
 
                    for name in namelist
218
 
                    if name.startswith(prefix)]
219
 
    
220
 
    mutter('Names in archive: %r', namelist)
221
 
    
222
 
    for name in namelist:
223
 
        if not name or name.endswith('/'):
224
 
            continue
225
 
    
226
 
        # '/' is used to separate pathname components inside zip archives
227
 
        ix = name.rfind('/')
228
 
        if ix == -1:
229
 
            head, tail = '', name
230
 
        else:
231
 
            head, tail = name.rsplit('/',1)
232
 
        if '/' in head:
233
 
            # we don't need looking in subdirectories
234
 
            continue
235
 
    
236
 
        base, suffix = osutils.splitext(tail)
237
 
        if suffix not in valid_suffixes:
238
 
            continue
239
 
    
240
 
        if base == '__init__':
241
 
            # package
242
 
            plugin_name = head
243
 
        elif head == '':
244
 
            # module
245
 
            plugin_name = base
246
 
        else:
247
 
            continue
248
 
    
249
 
        if not plugin_name:
250
 
            continue
251
 
        if getattr(plugins, plugin_name, None):
252
 
            mutter('Plugin name %s already loaded', plugin_name)
253
 
            continue
254
 
    
255
 
        try:
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))
262
 
            continue
263
 
        except KeyboardInterrupt:
264
 
            raise
265
 
        except Exception, e:
266
 
            ## import pdb; pdb.set_trace()
267
 
            warning('Unable to load plugin %r from %r'
268
 
                    % (name, zip_name))
269
 
            log_exception_quietly()
270
 
 
271
 
 
272
 
class PluginsHelpIndex(object):
273
 
    """A help index that returns help topics for plugins."""
274
 
 
275
 
    def __init__(self):
276
 
        self.prefix = 'plugins/'
277
 
 
278
 
    def get_topics(self, topic):
279
 
        """Search for topic in the loaded plugins.
280
 
 
281
 
        This will not trigger loading of new plugins.
282
 
 
283
 
        :param topic: A topic to search for.
284
 
        :return: A list which is either empty or contains a single
285
 
            RegisteredTopic entry.
286
 
        """
287
 
        if not topic:
288
 
            return []
289
 
        if topic.startswith(self.prefix):
290
 
            topic = topic[len(self.prefix):]
291
 
        plugin_module_name = 'bzrlib.plugins.%s' % topic
292
 
        try:
293
 
            module = sys.modules[plugin_module_name]
294
 
        except KeyError:
295
 
            return []
296
 
        else:
297
 
            return [ModuleHelpTopic(module)]
298
 
 
299
 
 
300
 
class ModuleHelpTopic(object):
301
 
    """A help topic which returns the docstring for a module."""
302
 
 
303
 
    def __init__(self, module):
304
 
        """Constructor.
305
 
 
306
 
        :param module: The module for which help should be generated.
307
 
        """
308
 
        self.module = module
309
 
 
310
 
    def get_help_text(self, additional_see_also=None):
311
 
        """Return a string with the help for this topic.
312
 
 
313
 
        :param additional_see_also: Additional help topics to be
314
 
            cross-referenced.
315
 
        """
316
 
        if not self.module.__doc__:
317
 
            result = "Plugin '%s' has no docstring.\n" % self.module.__name__
318
 
        else:
319
 
            result = self.module.__doc__
320
 
        if result[-1] != '\n':
321
 
            result += '\n'
322
 
        # there is code duplicated here and in bzrlib/help_topic.py's 
323
 
        # matching Topic code. This should probably be factored in
324
 
        # to a helper function and a common base class.
325
 
        if additional_see_also is not None:
326
 
            see_also = sorted(set(additional_see_also))
327
 
        else:
328
 
            see_also = None
329
 
        if see_also:
330
 
            result += 'See also: '
331
 
            result += ', '.join(see_also)
332
 
            result += '\n'
333
 
        return result
334
 
 
335
 
    def get_help_topic(self):
336
 
        """Return the modules help topic - its __name__ after bzrlib.plugins.."""
337
 
        return self.module.__name__[len('bzrlib.plugins.'):]
 
107
 
 
108
        plugin_names = list(plugin_names)
 
109
        plugin_names.sort()
 
110
        for name in plugin_names:
 
111
            try:
 
112
                plugin_info = imp.find_module(name, [d])
 
113
                mutter('load plugin %r' % (plugin_info,))
 
114
                try:
 
115
                    plugin = imp.load_module('bzrlib.plugin.' + name,
 
116
                                             *plugin_info)
 
117
                    all_plugins.append(plugin)
 
118
                finally:
 
119
                    if plugin_info[0] is not None:
 
120
                        plugin_info[0].close()
 
121
            except Exception, e:
 
122
                log_error('Unable to load plugin %r from %r' % (name, d))
 
123
                log_error(str(e))
 
124
                log_exception()
 
125