← Back to branch summary

~bzr/ubuntu/lucid/bzr/beta-ppa

« back to all changes in this revision

Viewing changes to bzrlib/plugin.py

  • Committer: Martin Pool
  • Date: 2010-08-18 04:26:39 UTC
  • mfrom: (129.1.8 packaging-karmic)
  • Revision ID: mbp@sourcefrog.net-20100818042639-mjoxtngyjwiu05fo
* PPA rebuild for lucid.
* PPA rebuild for karmic.
* PPA rebuild onto jaunty.
* New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/plugin.py
1
 
# Copyright (C) 2004, 2005, 2007, 2008 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
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
60
60
 
61
61
DEFAULT_PLUGIN_PATH = None
62
62
_loaded = False
63
 
 
64
 
@deprecated_function(deprecated_in((2, 0, 0)))
65
 
def get_default_plugin_path():
66
 
    """Get the DEFAULT_PLUGIN_PATH"""
67
 
    global DEFAULT_PLUGIN_PATH
68
 
    if DEFAULT_PLUGIN_PATH is None:
69
 
        DEFAULT_PLUGIN_PATH = osutils.pathjoin(config.config_dir(), 'plugins')
70
 
    return DEFAULT_PLUGIN_PATH
 
63
_plugins_disabled = False
 
64
 
 
65
 
 
66
def are_plugins_disabled():
 
67
    return _plugins_disabled
71
68
 
72
69
 
73
70
def disable_plugins():
75
72
 
76
73
    Future calls to load_plugins() will be ignored.
77
74
    """
 
75
    global _plugins_disabled
 
76
    _plugins_disabled = True
78
77
    load_plugins([])
79
78
 
80
79
 
82
81
    return path.rstrip("\\/")
83
82
 
84
83
 
 
84
def _get_specific_plugin_paths(paths):
 
85
    """Returns the plugin paths from a string describing the associations.
 
86
 
 
87
    :param paths: A string describing the paths associated with the plugins.
 
88
 
 
89
    :returns: A list of (plugin name, path) tuples.
 
90
 
 
91
    For example, if paths is my_plugin@/test/my-test:her_plugin@/production/her,
 
92
    [('my_plugin', '/test/my-test'), ('her_plugin', '/production/her')] 
 
93
    will be returned.
 
94
 
 
95
    Note that ':' in the example above depends on the os.
 
96
    """
 
97
    if not paths:
 
98
        return []
 
99
    specs = []
 
100
    for spec in paths.split(os.pathsep):
 
101
        try:
 
102
            name, path = spec.split('@')
 
103
        except ValueError:
 
104
            raise errors.BzrCommandError(
 
105
                '"%s" is not a valid <plugin_name>@<plugin_path> description '
 
106
                % spec)
 
107
        specs.append((name, path))
 
108
    return specs
 
109
 
 
110
 
85
111
def set_plugins_path(path=None):
86
112
    """Set the path for plugins to be loaded from.
87
113
 
92
118
    if path is None:
93
119
        path = get_standard_plugins_path()
94
120
    _mod_plugins.__path__ = path
 
121
    PluginImporter.reset()
 
122
    # Set up a blacklist for disabled plugins
 
123
    disabled_plugins = os.environ.get('BZR_DISABLE_PLUGINS', None)
 
124
    if disabled_plugins is not None:
 
125
        for name in disabled_plugins.split(os.pathsep):
 
126
            PluginImporter.blacklist.add('bzrlib.plugins.' + name)
 
127
    # Set up a the specific paths for plugins
 
128
    for plugin_name, plugin_path in _get_specific_plugin_paths(os.environ.get(
 
129
            'BZR_PLUGINS_AT', None)):
 
130
            PluginImporter.specific_paths[
 
131
                'bzrlib.plugins.%s' % plugin_name] = plugin_path
95
132
    return path
96
133
 
97
134
 
180
217
    paths = []
181
218
    for p in env_paths + defaults:
182
219
        if p.startswith('+'):
183
 
            # Resolve reference if they are known
 
220
            # Resolve references if they are known
184
221
            try:
185
222
                p = refs[p[1:]]
186
223
            except KeyError:
187
 
                # Leave them untouched otherwise, user may have paths starting
188
 
                # with '+'...
 
224
                # Leave them untouched so user can still use paths starting
 
225
                # with '+'
189
226
                pass
190
227
        _append_new_path(paths, p)
191
228
 
203
240
    files (and whatever other extensions are used in the platform,
204
241
    such as *.pyd).
205
242
 
206
 
    load_from_dirs() provides the underlying mechanism and is called with
 
243
    load_from_path() provides the underlying mechanism and is called with
207
244
    the default directory list to provide the normal behaviour.
208
245
 
209
246
    :param path: The list of paths to search for plugins.  By default,
232
269
 
233
270
    The python module path for bzrlib.plugins will be modified to be 'dirs'.
234
271
    """
 
272
    # Explicitly load the plugins with a specific path
 
273
    for fullname, path in PluginImporter.specific_paths.iteritems():
 
274
        name = fullname[len('bzrlib.plugins.'):]
 
275
        _load_plugin_module(name, path)
 
276
 
235
277
    # We need to strip the trailing separators here as well as in the
236
278
    # set_plugins_path function because calling code can pass anything in to
237
279
    # this function, and since it sets plugins.__path__, it should set it to
251
293
load_from_dirs = load_from_path
252
294
 
253
295
 
 
296
def _find_plugin_module(dir, name):
 
297
    """Check if there is a valid python module that can be loaded as a plugin.
 
298
 
 
299
    :param dir: The directory where the search is performed.
 
300
    :param path: An existing file path, either a python file or a package
 
301
        directory.
 
302
 
 
303
    :return: (name, path, description) name is the module name, path is the
 
304
        file to load and description is the tuple returned by
 
305
        imp.get_suffixes().
 
306
    """
 
307
    path = osutils.pathjoin(dir, name)
 
308
    if os.path.isdir(path):
 
309
        # Check for a valid __init__.py file, valid suffixes depends on -O and
 
310
        # can be .py, .pyc and .pyo
 
311
        for suffix, mode, kind in imp.get_suffixes():
 
312
            if kind not in (imp.PY_SOURCE, imp.PY_COMPILED):
 
313
                # We don't recognize compiled modules (.so, .dll, etc)
 
314
                continue
 
315
            init_path = osutils.pathjoin(path, '__init__' + suffix)
 
316
            if os.path.isfile(init_path):
 
317
                return name, init_path, (suffix, mode, kind)
 
318
    else:
 
319
        for suffix, mode, kind in imp.get_suffixes():
 
320
            if name.endswith(suffix):
 
321
                # Clean up the module name
 
322
                name = name[:-len(suffix)]
 
323
                if kind == imp.C_EXTENSION and name.endswith('module'):
 
324
                    name = name[:-len('module')]
 
325
                return name, path, (suffix, mode, kind)
 
326
    # There is no python module here
 
327
    return None, None, (None, None, None)
 
328
 
 
329
 
 
330
def _load_plugin_module(name, dir):
 
331
    """Load plugin name from dir.
 
332
 
 
333
    :param name: The plugin name in the bzrlib.plugins namespace.
 
334
    :param dir: The directory the plugin is loaded from for error messages.
 
335
    """
 
336
    if ('bzrlib.plugins.%s' % name) in PluginImporter.blacklist:
 
337
        return
 
338
    try:
 
339
        exec "import bzrlib.plugins.%s" % name in {}
 
340
    except KeyboardInterrupt:
 
341
        raise
 
342
    except errors.IncompatibleAPI, e:
 
343
        trace.warning("Unable to load plugin %r. It requested API version "
 
344
            "%s of module %s but the minimum exported version is %s, and "
 
345
            "the maximum is %s" %
 
346
            (name, e.wanted, e.api, e.minimum, e.current))
 
347
    except Exception, e:
 
348
        trace.warning("%s" % e)
 
349
        if re.search('\.|-| ', name):
 
350
            sanitised_name = re.sub('[-. ]', '_', name)
 
351
            if sanitised_name.startswith('bzr_'):
 
352
                sanitised_name = sanitised_name[len('bzr_'):]
 
353
            trace.warning("Unable to load %r in %r as a plugin because the "
 
354
                    "file path isn't a valid module name; try renaming "
 
355
                    "it to %r." % (name, dir, sanitised_name))
 
356
        else:
 
357
            trace.warning('Unable to load plugin %r from %r' % (name, dir))
 
358
        trace.log_exception_quietly()
 
359
        if 'error' in debug.debug_flags:
 
360
            trace.print_exception(sys.exc_info(), sys.stderr)
 
361
 
 
362
 
254
363
def load_from_dir(d):
255
364
    """Load the plugins in directory d.
256
365
 
257
366
    d must be in the plugins module path already.
 
367
    This function is called once for each directory in the module path.
258
368
    """
259
 
    # Get the list of valid python suffixes for __init__.py?
260
 
    # this includes .py, .pyc, and .pyo (depending on if we are running -O)
261
 
    # but it doesn't include compiled modules (.so, .dll, etc)
262
 
    valid_suffixes = [suffix for suffix, mod_type, flags in imp.get_suffixes()
263
 
                              if flags in (imp.PY_SOURCE, imp.PY_COMPILED)]
264
 
    package_entries = ['__init__'+suffix for suffix in valid_suffixes]
265
369
    plugin_names = set()
266
 
    for f in os.listdir(d):
267
 
        path = osutils.pathjoin(d, f)
268
 
        if os.path.isdir(path):
269
 
            for entry in package_entries:
270
 
                # This directory should be a package, and thus added to
271
 
                # the list
272
 
                if os.path.isfile(osutils.pathjoin(path, entry)):
273
 
                    break
274
 
            else: # This directory is not a package
275
 
                continue
276
 
        else:
277
 
            for suffix_info in imp.get_suffixes():
278
 
                if f.endswith(suffix_info[0]):
279
 
                    f = f[:-len(suffix_info[0])]
280
 
                    if suffix_info[2] == imp.C_EXTENSION and f.endswith('module'):
281
 
                        f = f[:-len('module')]
282
 
                    break
 
370
    for p in os.listdir(d):
 
371
        name, path, desc = _find_plugin_module(d, p)
 
372
        if name is not None:
 
373
            if name == '__init__':
 
374
                # We do nothing with the __init__.py file in directories from
 
375
                # the bzrlib.plugins module path, we may want to, one day
 
376
                # -- vila 20100316.
 
377
                continue # We don't load __init__.py in the plugins dirs
 
378
            elif getattr(_mod_plugins, name, None) is not None:
 
379
                # The module has already been loaded from another directory
 
380
                # during a previous call.
 
381
                # FIXME: There should be a better way to report masked plugins
 
382
                # -- vila 20100316
 
383
                trace.mutter('Plugin name %s already loaded', name)
283
384
            else:
284
 
                continue
285
 
        if f == '__init__':
286
 
            continue # We don't load __init__.py again in the plugin dir
287
 
        elif getattr(_mod_plugins, f, None):
288
 
            trace.mutter('Plugin name %s already loaded', f)
289
 
        else:
290
 
            # trace.mutter('add plugin name %s', f)
291
 
            plugin_names.add(f)
 
385
                plugin_names.add(name)
292
386
 
293
387
    for name in plugin_names:
294
 
        try:
295
 
            exec "import bzrlib.plugins.%s" % name in {}
296
 
        except KeyboardInterrupt:
297
 
            raise
298
 
        except errors.IncompatibleAPI, e:
299
 
            trace.warning("Unable to load plugin %r. It requested API version "
300
 
                "%s of module %s but the minimum exported version is %s, and "
301
 
                "the maximum is %s" %
302
 
                (name, e.wanted, e.api, e.minimum, e.current))
303
 
        except Exception, e:
304
 
            trace.warning("%s" % e)
305
 
            ## import pdb; pdb.set_trace()
306
 
            if re.search('\.|-| ', name):
307
 
                sanitised_name = re.sub('[-. ]', '_', name)
308
 
                if sanitised_name.startswith('bzr_'):
309
 
                    sanitised_name = sanitised_name[len('bzr_'):]
310
 
                trace.warning("Unable to load %r in %r as a plugin because the "
311
 
                        "file path isn't a valid module name; try renaming "
312
 
                        "it to %r." % (name, d, sanitised_name))
313
 
            else:
314
 
                trace.warning('Unable to load plugin %r from %r' % (name, d))
315
 
            trace.log_exception_quietly()
316
 
            if 'error' in debug.debug_flags:
317
 
                trace.print_exception(sys.exc_info(), sys.stderr)
 
388
        _load_plugin_module(name, d)
318
389
 
319
390
 
320
391
def plugins():
477
548
        return version_string
478
549
 
479
550
    __version__ = property(_get__version__)
 
551
 
 
552
 
 
553
class _PluginImporter(object):
 
554
    """An importer tailored to bzr specific needs.
 
555
 
 
556
    This is a singleton that takes care of:
 
557
    - disabled plugins specified in 'blacklist',
 
558
    - plugins that needs to be loaded from specific directories.
 
559
    """
 
560
 
 
561
    def __init__(self):
 
562
        self.reset()
 
563
 
 
564
    def reset(self):
 
565
        self.blacklist = set()
 
566
        self.specific_paths = {}
 
567
 
 
568
    def find_module(self, fullname, parent_path=None):
 
569
        """Search a plugin module.
 
570
 
 
571
        Disabled plugins raise an import error, plugins with specific paths
 
572
        returns a specific loader.
 
573
 
 
574
        :return: None if the plugin doesn't need special handling, self
 
575
            otherwise.
 
576
        """
 
577
        if not fullname.startswith('bzrlib.plugins.'):
 
578
            return None
 
579
        if fullname in self.blacklist:
 
580
            raise ImportError('%s is disabled' % fullname)
 
581
        if fullname in self.specific_paths:
 
582
            return self
 
583
        return None
 
584
 
 
585
    def load_module(self, fullname):
 
586
        """Load a plugin from a specific directory."""
 
587
        # We are called only for specific paths
 
588
        plugin_path = self.specific_paths[fullname]
 
589
        loading_path = None
 
590
        if os.path.isdir(plugin_path):
 
591
            for suffix, mode, kind in imp.get_suffixes():
 
592
                if kind not in (imp.PY_SOURCE, imp.PY_COMPILED):
 
593
                    # We don't recognize compiled modules (.so, .dll, etc)
 
594
                    continue
 
595
                init_path = osutils.pathjoin(plugin_path, '__init__' + suffix)
 
596
                if os.path.isfile(init_path):
 
597
                    # We've got a module here and load_module needs specific
 
598
                    # parameters.
 
599
                    loading_path = plugin_path
 
600
                    suffix = ''
 
601
                    mode = ''
 
602
                    kind = imp.PKG_DIRECTORY
 
603
                    break
 
604
        else:
 
605
            for suffix, mode, kind in imp.get_suffixes():
 
606
                if plugin_path.endswith(suffix):
 
607
                    loading_path = plugin_path
 
608
                    break
 
609
        if loading_path is None:
 
610
            raise ImportError('%s cannot be loaded from %s'
 
611
                              % (fullname, plugin_path))
 
612
        if kind is imp.PKG_DIRECTORY:
 
613
            f = None
 
614
        else:
 
615
            f = open(loading_path, mode)
 
616
        try:
 
617
            mod = imp.load_module(fullname, f, loading_path,
 
618
                                  (suffix, mode, kind))
 
619
            mod.__package__ = fullname
 
620
            return mod
 
621
        finally:
 
622
            if f is not None:
 
623
                f.close()
 
624
 
 
625
 
 
626
# Install a dedicated importer for plugins requiring special handling
 
627
PluginImporter = _PluginImporter()
 
628
sys.meta_path.append(PluginImporter)