/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/plugin.py

  • Committer: Jelmer Vernooij
  • Date: 2017-06-10 16:40:42 UTC
  • mfrom: (6653.6.7 rename-controldir)
  • mto: This revision was merged to the branch mainline in revision 6690.
  • Revision ID: jelmer@jelmer.uk-20170610164042-zrxqgy2htyduvke2
MergeĀ rename-controldirĀ branch.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 Canonical Ltd, 2017 Breezy developers
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
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
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.
 
17
"""Breezy plugin support.
 
18
 
 
19
Which plugins to load can be configured by setting these environment variables:
 
20
 
 
21
- BRZ_PLUGIN_PATH: Paths to look for plugins in.
 
22
- BRZ_DISABLE_PLUGINS: Plugin names to block from being loaded.
 
23
- BRZ_PLUGINS_AT: Name and paths for plugins to load from specific locations.
 
24
 
 
25
The interfaces this module exports include:
 
26
 
 
27
- disable_plugins: Load no plugins and stop future automatic loading.
 
28
- load_plugins: Load all plugins that can be found in configuration.
 
29
- describe_plugins: Generate text for each loaded (or failed) plugin.
 
30
- extend_path: Mechanism by which the plugins package path is set.
 
31
- plugin_name: Gives unprefixed name of a plugin module.
24
32
 
25
33
See the plugin-api developer documentation for information about writing
26
34
plugins.
27
 
 
28
 
BZR_PLUGIN_PATH is also honoured for any plugins imported via
29
 
'import bzrlib.plugins.PLUGINNAME', as long as set_plugins_path has been
30
 
called.
31
35
"""
32
36
 
 
37
from __future__ import absolute_import
 
38
 
33
39
import os
 
40
import re
34
41
import sys
35
42
 
36
 
from bzrlib import osutils
37
 
 
38
 
from bzrlib.lazy_import import lazy_import
39
 
 
 
43
import breezy
 
44
from . import osutils
 
45
 
 
46
from .lazy_import import lazy_import
40
47
lazy_import(globals(), """
41
48
import imp
42
 
import re
43
 
import types
 
49
import importlib
 
50
from importlib import util as importlib_util
44
51
 
45
 
from bzrlib import (
46
 
    _format_version_tuple,
 
52
from breezy import (
47
53
    config,
48
54
    debug,
49
55
    errors,
 
56
    help_topics,
50
57
    trace,
51
58
    )
52
 
from bzrlib import plugins as _mod_plugins
53
59
""")
54
60
 
55
 
from bzrlib.symbol_versioning import (
56
 
    deprecated_function,
57
 
    deprecated_in,
58
 
    )
59
 
 
60
 
 
61
 
DEFAULT_PLUGIN_PATH = None
62
 
_loaded = False
63
 
_plugins_disabled = False
64
 
 
65
 
 
66
 
def are_plugins_disabled():
67
 
    return _plugins_disabled
68
 
 
69
 
 
70
 
def disable_plugins():
 
61
 
 
62
_MODULE_PREFIX = "breezy.plugins."
 
63
 
 
64
if __debug__ or sys.version_info > (3,):
 
65
    COMPILED_EXT = ".pyc"
 
66
else:
 
67
    COMPILED_EXT = ".pyo"
 
68
 
 
69
 
 
70
def disable_plugins(state=None):
71
71
    """Disable loading plugins.
72
72
 
73
73
    Future calls to load_plugins() will be ignored.
 
74
 
 
75
    :param state: The library state object that records loaded plugins.
74
76
    """
75
 
    global _plugins_disabled
76
 
    _plugins_disabled = True
77
 
    load_plugins([])
78
 
 
79
 
 
80
 
def _strip_trailing_sep(path):
81
 
    return path.rstrip("\\/")
82
 
 
83
 
 
84
 
def set_plugins_path(path=None):
85
 
    """Set the path for plugins to be loaded from.
 
77
    if state is None:
 
78
        state = breezy.global_state
 
79
    state.plugins = {}
 
80
 
 
81
 
 
82
def load_plugins(path=None, state=None):
 
83
    """Load breezy plugins.
 
84
 
 
85
    The environment variable BRZ_PLUGIN_PATH is considered a delimited
 
86
    set of paths to look through. Each entry is searched for `*.py`
 
87
    files (and whatever other extensions are used in the platform,
 
88
    such as `*.pyd`).
86
89
 
87
90
    :param path: The list of paths to search for plugins.  By default,
88
 
        path will be determined using get_standard_plugins_path.
89
 
        if path is [], no plugins can be loaded.
 
91
        it is populated from the __path__ of the breezy.plugins package.
 
92
    :param state: The library state object that records loaded plugins.
90
93
    """
 
94
    if state is None:
 
95
        state = breezy.global_state
 
96
    if getattr(state, 'plugins', None) is not None:
 
97
        # People can make sure plugins are loaded, they just won't be twice
 
98
        return
 
99
 
91
100
    if path is None:
92
 
        path = get_standard_plugins_path()
93
 
    _mod_plugins.__path__ = path
94
 
    PluginImporter.reset()
95
 
    # Set up a blacklist for disabled plugins
96
 
    disabled_plugins = os.environ.get('BZR_DISABLE_PLUGINS', None)
97
 
    if disabled_plugins is not None:
98
 
        for name in disabled_plugins.split(os.pathsep):
99
 
            PluginImporter.blacklist.add('bzrlib.plugins.' + name)
100
 
    # Set up a the specific paths for plugins
101
 
    specific_plugins = os.environ.get('BZR_PLUGINS_AT', None)
102
 
    if specific_plugins is not None:
103
 
        for spec in specific_plugins.split(os.pathsep):
104
 
            plugin_name, plugin_path = spec.split('@')
105
 
            PluginImporter.specific_paths[
106
 
                'bzrlib.plugins.%s' % plugin_name] = plugin_path
107
 
    return path
108
 
 
109
 
 
110
 
def _append_new_path(paths, new_path):
111
 
    """Append a new path if it set and not already known."""
112
 
    if new_path is not None and new_path not in paths:
113
 
        paths.append(new_path)
114
 
    return paths
115
 
 
116
 
 
117
 
def get_core_plugin_path():
118
 
    core_path = None
119
 
    bzr_exe = bool(getattr(sys, 'frozen', None))
120
 
    if bzr_exe:    # expand path for bzr.exe
 
101
        # Calls back into extend_path() here
 
102
        from breezy.plugins import __path__ as path
 
103
 
 
104
    state.plugin_warnings = {}
 
105
    _load_plugins(state, path)
 
106
    state.plugins = plugins()
 
107
 
 
108
 
 
109
def plugin_name(module_name):
 
110
    """Gives unprefixed name from module_name or None."""
 
111
    if module_name.startswith(_MODULE_PREFIX):
 
112
        parts = module_name.split(".")
 
113
        if len(parts) > 2:
 
114
            return parts[2]
 
115
    return None
 
116
 
 
117
 
 
118
def extend_path(path, name):
 
119
    """Helper so breezy.plugins can be a sort of namespace package.
 
120
 
 
121
    To be used in similar fashion to pkgutil.extend_path:
 
122
 
 
123
        from breezy.plugins import extend_path
 
124
        __path__ = extend_path(__path__, __name__)
 
125
 
 
126
    Inspects the BRZ_PLUGIN* envvars, sys.path, and the filesystem to find
 
127
    plugins. May mutate sys.modules in order to block plugin loading, and may
 
128
    append a new meta path finder to sys.meta_path for plugins@ loading.
 
129
 
 
130
    Returns a list of paths to import from, as an enhanced object that also
 
131
    contains details of the other configuration used.
 
132
    """
 
133
    blocks = _env_disable_plugins()
 
134
    _block_plugins(blocks)
 
135
 
 
136
    extra_details = _env_plugins_at()
 
137
    _install_importer_if_needed(extra_details)
 
138
 
 
139
    paths = _iter_plugin_paths(_env_plugin_path(), path)
 
140
 
 
141
    return _Path(name, blocks, extra_details, paths)
 
142
 
 
143
 
 
144
class _Path(list):
 
145
    """List type to use as __path__ but containing additional details.
 
146
 
 
147
    Python 3 allows any iterable for __path__ but Python 2 is more fussy.
 
148
    """
 
149
 
 
150
    def __init__(self, package_name, blocked, extra, paths):
 
151
        super(_Path, self).__init__(paths)
 
152
        self.package_name = package_name
 
153
        self.blocked_names = blocked
 
154
        self.extra_details = extra
 
155
 
 
156
    def __repr__(self):
 
157
        return "%s(%r, %r, %r, %s)" % (
 
158
            self.__class__.__name__, self.package_name, self.blocked_names,
 
159
            self.extra_details, list.__repr__(self))
 
160
 
 
161
 
 
162
def _expect_identifier(name, env_key, env_value):
 
163
    """Validate given name from envvar is usable as a Python identifier.
 
164
 
 
165
    Returns the name as a native str, or None if it was invalid.
 
166
 
 
167
    Per PEP 3131 this is no longer strictly correct for Python 3, but as MvL
 
168
    didn't include a neat way to check except eval, this enforces ascii.
 
169
    """
 
170
    if re.match(r"^[A-Za-z_][A-Za-z0-9_]*$", name) is None:
 
171
        trace.warning("Invalid name '%s' in %s='%s'", name, env_key, env_value)
 
172
        return None
 
173
    return str(name)
 
174
 
 
175
 
 
176
def _env_disable_plugins(key='BRZ_DISABLE_PLUGINS'):
 
177
    """Gives list of names for plugins to disable from environ key."""
 
178
    disabled_names = []
 
179
    env = osutils.path_from_environ(key)
 
180
    if env:
 
181
        for name in env.split(os.pathsep):
 
182
            name = _expect_identifier(name, key, env)
 
183
            if name is not None:
 
184
                disabled_names.append(name)
 
185
    return disabled_names
 
186
 
 
187
 
 
188
def _env_plugins_at(key='BRZ_PLUGINS_AT'):
 
189
    """Gives list of names and paths of specific plugins from environ key."""
 
190
    plugin_details = []
 
191
    env = osutils.path_from_environ(key)
 
192
    if env:
 
193
        for pair in env.split(os.pathsep):
 
194
            if '@' in pair:
 
195
                name, path = pair.split('@', 1)
 
196
            else:
 
197
                path = pair
 
198
                name = osutils.basename(path).split('.', 1)[0]
 
199
            name = _expect_identifier(name, key, env)
 
200
            if name is not None:
 
201
                plugin_details.append((name, path))
 
202
    return plugin_details
 
203
 
 
204
 
 
205
def _env_plugin_path(key='BRZ_PLUGIN_PATH'):
 
206
    """Gives list of paths and contexts for plugins from environ key.
 
207
 
 
208
    Each entry is either a specific path to load plugins from and the value
 
209
    'path', or None and one of the three values 'user', 'core', 'site'.
 
210
    """
 
211
    path_details = []
 
212
    env = osutils.path_from_environ(key)
 
213
    defaults = {"user": not env, "core": True, "site": True}
 
214
    if env:
 
215
        # Add paths specified by user in order
 
216
        for p in env.split(os.pathsep):
 
217
            flag, name = p[:1], p[1:]
 
218
            if flag in ("+", "-") and name in defaults:
 
219
                if flag == "+" and defaults[name] is not None:
 
220
                    path_details.append((None, name))
 
221
                defaults[name] = None
 
222
            else:
 
223
                path_details.append((p, 'path'))
 
224
 
 
225
    # Add any remaining default paths
 
226
    for name in ('user', 'core', 'site'):
 
227
        if defaults[name]:
 
228
            path_details.append((None, name))
 
229
 
 
230
    return path_details
 
231
 
 
232
 
 
233
def _iter_plugin_paths(paths_from_env, core_paths):
 
234
    """Generate paths using paths_from_env and core_paths."""
 
235
    # GZ 2017-06-02: This is kinda horrid, should make better.
 
236
    for path, context in paths_from_env:
 
237
        if context == 'path':
 
238
            yield path
 
239
        elif context == 'user':
 
240
            path = get_user_plugin_path()
 
241
            if os.path.isdir(path):
 
242
                yield path
 
243
        elif context == 'core':
 
244
            for path in _get_core_plugin_paths(core_paths):
 
245
                yield path
 
246
        elif context == 'site':
 
247
            for path in _get_site_plugin_paths(sys.path):
 
248
                if os.path.isdir(path):
 
249
                    yield path
 
250
 
 
251
 
 
252
def _install_importer_if_needed(plugin_details):
 
253
    """Install a meta path finder to handle plugin_details if any."""
 
254
    if plugin_details:
 
255
        finder = _PluginsAtFinder(_MODULE_PREFIX, plugin_details)
 
256
        # For Python 3, must insert before default PathFinder to override.
 
257
        sys.meta_path.insert(2, finder)
 
258
 
 
259
 
 
260
def _load_plugins(state, paths):
 
261
    """Do the importing all plugins from paths."""
 
262
    imported_names = set()
 
263
    for name, path in _iter_possible_plugins(paths):
 
264
        if name not in imported_names:
 
265
            msg = _load_plugin_module(name, path)
 
266
            if msg is not None:
 
267
                state.plugin_warnings.setdefault(name, []).append(msg)
 
268
            imported_names.add(name)
 
269
 
 
270
 
 
271
def _block_plugins(names):
 
272
    """Add names to sys.modules to block future imports."""
 
273
    for name in names:
 
274
        package_name = _MODULE_PREFIX + name
 
275
        if sys.modules.get(package_name) is not None:
 
276
            trace.mutter("Blocked plugin %s already loaded.", name)
 
277
        sys.modules[package_name] = None
 
278
 
 
279
 
 
280
def _get_package_init(package_path):
 
281
    """Get path of __init__ file from package_path or None if not a package."""
 
282
    init_path = osutils.pathjoin(package_path, "__init__.py")
 
283
    if os.path.exists(init_path):
 
284
        return init_path
 
285
    init_path = init_path[:-3] + COMPILED_EXT
 
286
    if os.path.exists(init_path):
 
287
        return init_path
 
288
    return None
 
289
 
 
290
 
 
291
def _iter_possible_plugins(plugin_paths):
 
292
    """Generate names and paths of possible plugins from plugin_paths."""
 
293
    # Inspect any from BRZ_PLUGINS_AT first.
 
294
    for name, path in getattr(plugin_paths, "extra_details", ()):
 
295
        yield name, path
 
296
    # Then walk over files and directories in the paths from the package.
 
297
    for path in plugin_paths:
 
298
        if os.path.isfile(path):
 
299
            if path.endswith(".zip"):
 
300
                trace.mutter("Don't yet support loading plugins from zip.")
 
301
        else:
 
302
            for name, path in _walk_modules(path):
 
303
                yield name, path
 
304
 
 
305
 
 
306
def _walk_modules(path):
 
307
    """Generate name and path of modules and packages on path."""
 
308
    for root, dirs, files in os.walk(path):
 
309
        files.sort()
 
310
        for f in files:
 
311
            if f[:2] != "__":
 
312
                if f.endswith((".py", COMPILED_EXT)):
 
313
                    yield f.rsplit(".", 1)[0], root
 
314
        dirs.sort()
 
315
        for d in dirs:
 
316
            if d[:2] != "__":
 
317
                package_dir = osutils.pathjoin(root, d)
 
318
                fullpath = _get_package_init(package_dir)
 
319
                if fullpath is not None:
 
320
                    yield d, package_dir
 
321
        # Don't descend into subdirectories
 
322
        del dirs[:]
 
323
 
 
324
 
 
325
def describe_plugins(show_paths=False, state=None):
 
326
    """Generate text description of plugins.
 
327
 
 
328
    Includes both those that have loaded, and those that failed to load.
 
329
 
 
330
    :param show_paths: If true, include the plugin path.
 
331
    :param state: The library state object to inspect.
 
332
    :returns: Iterator of text lines (including newlines.)
 
333
    """
 
334
    if state is None:
 
335
        state = breezy.global_state
 
336
    all_names = sorted(set(state.plugins).union(state.plugin_warnings))
 
337
    for name in all_names:
 
338
        if name in state.plugins:
 
339
            plugin = state.plugins[name]
 
340
            version = plugin.__version__
 
341
            if version == 'unknown':
 
342
                version = ''
 
343
            yield '%s %s\n' % (name, version)
 
344
            d = plugin.module.__doc__
 
345
            if d:
 
346
                doc = d.split('\n')[0]
 
347
            else:
 
348
                doc = '(no description)'
 
349
            yield ("  %s\n" % doc)
 
350
            if show_paths:
 
351
                yield ("   %s\n" % plugin.path())
 
352
        else:
 
353
            yield "%s (failed to load)\n" % name
 
354
        if name in state.plugin_warnings:
 
355
            for line in state.plugin_warnings[name]:
 
356
                yield "  ** " + line + '\n'
 
357
        yield '\n'
 
358
 
 
359
 
 
360
def _get_core_plugin_paths(existing_paths):
 
361
    """Generate possible locations for plugins based on existing_paths."""
 
362
    if getattr(sys, 'frozen', False):
121
363
        # We need to use relative path to system-wide plugin
122
 
        # directory because bzrlib from standalone bzr.exe
 
364
        # directory because breezy from standalone brz.exe
123
365
        # could be imported by another standalone program
124
366
        # (e.g. bzr-config; or TortoiseBzr/Olive if/when they
125
367
        # will become standalone exe). [bialix 20071123]
126
368
        # __file__ typically is
127
 
        # C:\Program Files\Bazaar\lib\library.zip\bzrlib\plugin.pyc
 
369
        # C:\Program Files\Bazaar\lib\library.zip\breezy\plugin.pyc
128
370
        # then plugins directory is
129
371
        # C:\Program Files\Bazaar\plugins
130
372
        # so relative path is ../../../plugins
131
 
        core_path = osutils.abspath(osutils.pathjoin(
132
 
                osutils.dirname(__file__), '../../../plugins'))
 
373
        yield osutils.abspath(osutils.pathjoin(
 
374
            osutils.dirname(__file__), '../../../plugins'))
133
375
    else:     # don't look inside library.zip
134
 
        # search the plugin path before the bzrlib installed dir
135
 
        core_path = os.path.dirname(_mod_plugins.__file__)
136
 
    return core_path
137
 
 
138
 
 
139
 
def get_site_plugin_path():
140
 
    """Returns the path for the site installed plugins."""
141
 
    if sys.platform == 'win32':
142
 
        # We don't have (yet) a good answer for windows since that is certainly
143
 
        # related to the way we build the installers. -- vila20090821
144
 
        return None
145
 
    site_path = None
146
 
    try:
147
 
        from distutils.sysconfig import get_python_lib
148
 
    except ImportError:
149
 
        # If distutuils is not available, we just don't know where they are
150
 
        pass
151
 
    else:
152
 
        site_path = osutils.pathjoin(get_python_lib(), 'bzrlib', 'plugins')
153
 
    return site_path
 
376
        for path in existing_paths:
 
377
            yield path
 
378
 
 
379
 
 
380
def _get_site_plugin_paths(sys_paths):
 
381
    """Generate possible locations for plugins from given sys_paths."""
 
382
    for path in sys_paths:
 
383
        if os.path.basename(path) in ('dist-packages', 'site-packages'):
 
384
            yield osutils.pathjoin(path, 'breezy', 'plugins')
154
385
 
155
386
 
156
387
def get_user_plugin_path():
157
388
    return osutils.pathjoin(config.config_dir(), 'plugins')
158
389
 
159
390
 
160
 
def get_standard_plugins_path():
161
 
    """Determine a plugin path suitable for general use."""
162
 
    # Ad-Hoc default: core is not overriden by site but user can overrides both
163
 
    # The rationale is that:
164
 
    # - 'site' comes last, because these plugins should always be available and
165
 
    #   are supposed to be in sync with the bzr installed on site.
166
 
    # - 'core' comes before 'site' so that running bzr from sources or a user
167
 
    #   installed version overrides the site version.
168
 
    # - 'user' comes first, because... user is always right.
169
 
    # - the above rules clearly defines which plugin version will be loaded if
170
 
    #   several exist. Yet, it is sometimes desirable to disable some directory
171
 
    #   so that a set of plugins is disabled as once. This can be done via
172
 
    #   -site, -core, -user.
173
 
 
174
 
    env_paths = os.environ.get('BZR_PLUGIN_PATH', '+user').split(os.pathsep)
175
 
    defaults = ['+core', '+site']
176
 
 
177
 
    # The predefined references
178
 
    refs = dict(core=get_core_plugin_path(),
179
 
                site=get_site_plugin_path(),
180
 
                user=get_user_plugin_path())
181
 
 
182
 
    # Unset paths that should be removed
183
 
    for k,v in refs.iteritems():
184
 
        removed = '-%s' % k
185
 
        # defaults can never mention removing paths as that will make it
186
 
        # impossible for the user to revoke these removals.
187
 
        if removed in env_paths:
188
 
            env_paths.remove(removed)
189
 
            refs[k] = None
190
 
 
191
 
    # Expand references
192
 
    paths = []
193
 
    for p in env_paths + defaults:
194
 
        if p.startswith('+'):
195
 
            # Resolve references if they are known
196
 
            try:
197
 
                p = refs[p[1:]]
198
 
            except KeyError:
199
 
                # Leave them untouched so user can still use paths starting
200
 
                # with '+'
201
 
                pass
202
 
        _append_new_path(paths, p)
203
 
 
204
 
    # Get rid of trailing slashes, since Python can't handle them when
205
 
    # it tries to import modules.
206
 
    paths = map(_strip_trailing_sep, paths)
207
 
    return paths
208
 
 
209
 
 
210
 
def load_plugins(path=None):
211
 
    """Load bzrlib plugins.
212
 
 
213
 
    The environment variable BZR_PLUGIN_PATH is considered a delimited
214
 
    set of paths to look through. Each entry is searched for *.py
215
 
    files (and whatever other extensions are used in the platform,
216
 
    such as *.pyd).
217
 
 
218
 
    load_from_path() provides the underlying mechanism and is called with
219
 
    the default directory list to provide the normal behaviour.
220
 
 
221
 
    :param path: The list of paths to search for plugins.  By default,
222
 
        path will be determined using get_standard_plugins_path.
223
 
        if path is [], no plugins can be loaded.
224
 
    """
225
 
    global _loaded
226
 
    if _loaded:
227
 
        # People can make sure plugins are loaded, they just won't be twice
228
 
        return
229
 
    _loaded = True
230
 
 
231
 
    # scan for all plugins in the path.
232
 
    load_from_path(set_plugins_path(path))
233
 
 
234
 
 
235
 
def load_from_path(dirs):
236
 
    """Load bzrlib plugins found in each dir in dirs.
237
 
 
238
 
    Loading a plugin means importing it into the python interpreter.
239
 
    The plugin is expected to make calls to register commands when
240
 
    it's loaded (or perhaps access other hooks in future.)
241
 
 
242
 
    Plugins are loaded into bzrlib.plugins.NAME, and can be found there
243
 
    for future reference.
244
 
 
245
 
    The python module path for bzrlib.plugins will be modified to be 'dirs'.
246
 
    """
247
 
    # Explicitly load the plugins with a specific path
248
 
    for fullname, path in PluginImporter.specific_paths.iteritems():
249
 
        name = fullname[len('bzrlib.plugins.'):]
250
 
        _load_plugin_module(name, path)
251
 
 
252
 
    # We need to strip the trailing separators here as well as in the
253
 
    # set_plugins_path function because calling code can pass anything in to
254
 
    # this function, and since it sets plugins.__path__, it should set it to
255
 
    # something that will be valid for Python to use (in case people try to
256
 
    # run "import bzrlib.plugins.PLUGINNAME" after calling this function).
257
 
    _mod_plugins.__path__ = map(_strip_trailing_sep, dirs)
258
 
    for d in dirs:
259
 
        if not d:
260
 
            continue
261
 
        trace.mutter('looking for plugins in %s', d)
262
 
        if os.path.isdir(d):
263
 
            load_from_dir(d)
264
 
 
265
 
 
266
 
# backwards compatability: load_from_dirs was the old name
267
 
# This was changed in 0.15
268
 
load_from_dirs = load_from_path
269
 
 
270
 
 
271
 
def _find_plugin_module(dir, name):
272
 
    """Check if there is a valid python module that can be loaded as a plugin.
273
 
 
274
 
    :param dir: The directory where the search is performed.
275
 
    :param path: An existing file path, either a python file or a package
276
 
        directory.
277
 
 
278
 
    :return: (name, path, description) name is the module name, path is the
279
 
        file to load and description is the tuple returned by
280
 
        imp.get_suffixes().
281
 
    """
282
 
    path = osutils.pathjoin(dir, name)
283
 
    if os.path.isdir(path):
284
 
        # Check for a valid __init__.py file, valid suffixes depends on -O and
285
 
        # can be .py, .pyc and .pyo
286
 
        for suffix, mode, kind in imp.get_suffixes():
287
 
            if kind not in (imp.PY_SOURCE, imp.PY_COMPILED):
288
 
                # We don't recognize compiled modules (.so, .dll, etc)
289
 
                continue
290
 
            init_path = osutils.pathjoin(path, '__init__' + suffix)
291
 
            if os.path.isfile(init_path):
292
 
                return name, init_path, (suffix, mode, kind)
293
 
    else:
294
 
        for suffix, mode, kind in imp.get_suffixes():
295
 
            if name.endswith(suffix):
296
 
                # Clean up the module name
297
 
                name = name[:-len(suffix)]
298
 
                if kind == imp.C_EXTENSION and name.endswith('module'):
299
 
                    name = name[:-len('module')]
300
 
                return name, path, (suffix, mode, kind)
301
 
    # There is no python module here
302
 
    return None, None, (None, None, None)
 
391
def record_plugin_warning(warning_message):
 
392
    trace.mutter(warning_message)
 
393
    return warning_message
303
394
 
304
395
 
305
396
def _load_plugin_module(name, dir):
306
 
    """Load plugin name from dir.
 
397
    """Load plugin by name.
307
398
 
308
 
    :param name: The plugin name in the bzrlib.plugins namespace.
 
399
    :param name: The plugin name in the breezy.plugins namespace.
309
400
    :param dir: The directory the plugin is loaded from for error messages.
310
401
    """
311
 
    if ('bzrlib.plugins.%s' % name) in PluginImporter.blacklist:
 
402
    if _MODULE_PREFIX + name in sys.modules:
312
403
        return
313
404
    try:
314
 
        exec "import bzrlib.plugins.%s" % name in {}
315
 
    except KeyboardInterrupt:
316
 
        raise
317
 
    except errors.IncompatibleAPI, e:
318
 
        trace.warning("Unable to load plugin %r. It requested API version "
 
405
        __import__(_MODULE_PREFIX + name)
 
406
    except errors.IncompatibleAPI as e:
 
407
        warning_message = (
 
408
            "Unable to load plugin %r. It requested API version "
319
409
            "%s of module %s but the minimum exported version is %s, and "
320
410
            "the maximum is %s" %
321
411
            (name, e.wanted, e.api, e.minimum, e.current))
322
 
    except Exception, e:
323
 
        trace.warning("%s" % e)
 
412
        return record_plugin_warning(warning_message)
 
413
    except Exception as e:
 
414
        trace.log_exception_quietly()
 
415
        if 'error' in debug.debug_flags:
 
416
            trace.print_exception(sys.exc_info(), sys.stderr)
 
417
        # GZ 2017-06-02: Move this name checking up a level, no point trying
 
418
        # to import things with bad names.
324
419
        if re.search('\.|-| ', name):
325
420
            sanitised_name = re.sub('[-. ]', '_', name)
326
 
            if sanitised_name.startswith('bzr_'):
327
 
                sanitised_name = sanitised_name[len('bzr_'):]
 
421
            if sanitised_name.startswith('brz_'):
 
422
                sanitised_name = sanitised_name[len('brz_'):]
328
423
            trace.warning("Unable to load %r in %r as a plugin because the "
329
424
                    "file path isn't a valid module name; try renaming "
330
425
                    "it to %r." % (name, dir, sanitised_name))
331
426
        else:
332
 
            trace.warning('Unable to load plugin %r from %r' % (name, dir))
333
 
        trace.log_exception_quietly()
334
 
        if 'error' in debug.debug_flags:
335
 
            trace.print_exception(sys.exc_info(), sys.stderr)
336
 
 
337
 
 
338
 
def load_from_dir(d):
339
 
    """Load the plugins in directory d.
340
 
 
341
 
    d must be in the plugins module path already.
342
 
    This function is called once for each directory in the module path.
343
 
    """
344
 
    plugin_names = set()
345
 
    for p in os.listdir(d):
346
 
        name, path, desc = _find_plugin_module(d, p)
347
 
        if name is not None:
348
 
            if name == '__init__':
349
 
                # We do nothing with the __init__.py file in directories from
350
 
                # the bzrlib.plugins module path, we may want to, one day
351
 
                # -- vila 20100316.
352
 
                continue # We don't load __init__.py in the plugins dirs
353
 
            elif getattr(_mod_plugins, name, None) is not None:
354
 
                # The module has already been loaded from another directory
355
 
                # during a previous call.
356
 
                # FIXME: There should be a better way to report masked plugins
357
 
                # -- vila 20100316
358
 
                trace.mutter('Plugin name %s already loaded', name)
359
 
            else:
360
 
                plugin_names.add(name)
361
 
 
362
 
    for name in plugin_names:
363
 
        _load_plugin_module(name, d)
 
427
            return record_plugin_warning(
 
428
                'Unable to load plugin %r from %r: %s' % (name, dir, e))
364
429
 
365
430
 
366
431
def plugins():
369
434
    Each item in the dictionary is a PlugIn object.
370
435
    """
371
436
    result = {}
372
 
    for name, plugin in _mod_plugins.__dict__.items():
373
 
        if isinstance(plugin, types.ModuleType):
374
 
            result[name] = PlugIn(name, plugin)
 
437
    for fullname in sys.modules:
 
438
        if fullname.startswith(_MODULE_PREFIX):
 
439
            name = fullname[len(_MODULE_PREFIX):]
 
440
            if not "." in name and sys.modules[fullname] is not None:
 
441
                result[name] = PlugIn(name, sys.modules[fullname])
375
442
    return result
376
443
 
377
444
 
 
445
def format_concise_plugin_list():
 
446
    """Return a string holding a concise list of plugins and their version.
 
447
    """
 
448
    items = []
 
449
    for name, a_plugin in sorted(plugins().items()):
 
450
        items.append("%s[%s]" %
 
451
            (name, a_plugin.__version__))
 
452
    return ', '.join(items)
 
453
 
 
454
 
378
455
class PluginsHelpIndex(object):
379
456
    """A help index that returns help topics for plugins."""
380
457
 
394
471
            return []
395
472
        if topic.startswith(self.prefix):
396
473
            topic = topic[len(self.prefix):]
397
 
        plugin_module_name = 'bzrlib.plugins.%s' % topic
 
474
        plugin_module_name = _MODULE_PREFIX + topic
398
475
        try:
399
476
            module = sys.modules[plugin_module_name]
400
477
        except KeyError:
425
502
            result = self.module.__doc__
426
503
        if result[-1] != '\n':
427
504
            result += '\n'
428
 
        # there is code duplicated here and in bzrlib/help_topic.py's
429
 
        # matching Topic code. This should probably be factored in
430
 
        # to a helper function and a common base class.
431
 
        if additional_see_also is not None:
432
 
            see_also = sorted(set(additional_see_also))
433
 
        else:
434
 
            see_also = None
435
 
        if see_also:
436
 
            result += 'See also: '
437
 
            result += ', '.join(see_also)
438
 
            result += '\n'
 
505
        result += help_topics._format_see_also(additional_see_also)
439
506
        return result
440
507
 
441
508
    def get_help_topic(self):
442
 
        """Return the modules help topic - its __name__ after bzrlib.plugins.."""
443
 
        return self.module.__name__[len('bzrlib.plugins.'):]
 
509
        """Return the module help topic: its basename."""
 
510
        return self.module.__name__[len(_MODULE_PREFIX):]
444
511
 
445
512
 
446
513
class PlugIn(object):
447
 
    """The bzrlib representation of a plugin.
 
514
    """The breezy representation of a plugin.
448
515
 
449
516
    The PlugIn object provides a way to manipulate a given plugin module.
450
517
    """
460
527
            return os.path.abspath(self.module.__path__[0])
461
528
        elif getattr(self.module, '__file__', None) is not None:
462
529
            path = os.path.abspath(self.module.__file__)
463
 
            if path[-4:] in ('.pyc', '.pyo'):
 
530
            if path[-4:] == COMPILED_EXT:
464
531
                pypath = path[:-4] + '.py'
465
532
                if os.path.isfile(pypath):
466
533
                    path = pypath
468
535
        else:
469
536
            return repr(self.module)
470
537
 
471
 
    def __str__(self):
472
 
        return "<%s.%s object at %s, name=%s, module=%s>" % (
473
 
            self.__class__.__module__, self.__class__.__name__, id(self),
 
538
    def __repr__(self):
 
539
        return "<%s.%s name=%s, module=%s>" % (
 
540
            self.__class__.__module__, self.__class__.__name__,
474
541
            self.name, self.module)
475
542
 
476
 
    __repr__ = __str__
477
 
 
478
543
    def test_suite(self):
479
544
        """Return the plugin's test suite."""
480
545
        if getattr(self.module, 'test_suite', None) is not None:
487
552
 
488
553
        :param loader: The custom loader that should be used to load additional
489
554
            tests.
490
 
 
491
555
        """
492
556
        if getattr(self.module, 'load_tests', None) is not None:
493
557
            return loader.loadTestsFromModule(self.module)
499
563
        version_info = getattr(self.module, 'version_info', None)
500
564
        if version_info is not None:
501
565
            try:
502
 
                if isinstance(version_info, types.StringType):
 
566
                if isinstance(version_info, str):
503
567
                    version_info = version_info.split('.')
504
568
                elif len(version_info) == 3:
505
569
                    version_info = tuple(version_info) + ('final', 0)
506
 
            except TypeError, e:
 
570
            except TypeError:
507
571
                # The given version_info isn't even iteratible
508
572
                trace.log_exception_quietly()
509
573
                version_info = (version_info,)
510
574
        return version_info
511
575
 
512
 
    def _get__version__(self):
 
576
    @property
 
577
    def __version__(self):
513
578
        version_info = self.version_info()
514
579
        if version_info is None or len(version_info) == 0:
515
580
            return "unknown"
516
581
        try:
517
 
            version_string = _format_version_tuple(version_info)
518
 
        except (ValueError, TypeError, IndexError), e:
 
582
            version_string = breezy._format_version_tuple(version_info)
 
583
        except (ValueError, TypeError, IndexError):
519
584
            trace.log_exception_quietly()
520
 
            # try to return something usefull for bad plugins, in stead of
521
 
            # stack tracing.
 
585
            # Try to show something for the version anyway
522
586
            version_string = '.'.join(map(str, version_info))
523
587
        return version_string
524
588
 
525
 
    __version__ = property(_get__version__)
526
 
 
527
 
 
528
 
class _PluginImporter(object):
529
 
    """An importer tailored to bzr specific needs.
530
 
 
531
 
    This is a singleton that takes care of:
532
 
    - disabled plugins specified in 'blacklist',
533
 
    - plugins that needs to be loaded from specific directories.
534
 
    """
535
 
 
536
 
    def __init__(self):
537
 
        self.reset()
538
 
 
539
 
    def reset(self):
540
 
        self.blacklist = set()
541
 
        self.specific_paths = {}
542
 
 
543
 
    def find_module(self, fullname, parent_path=None):
544
 
        """Search a plugin module.
545
 
 
546
 
        Disabled plugins raise an import error, plugins with specific paths
547
 
        returns a specific loader.
548
 
 
549
 
        :return: None if the plugin doesn't need special handling, self
550
 
            otherwise.
551
 
        """
552
 
        if not fullname.startswith('bzrlib.plugins.'):
553
 
            return None
554
 
        if fullname in self.blacklist:
555
 
            raise ImportError('%s is disabled' % fullname)
556
 
        if fullname in self.specific_paths:
557
 
            return self
558
 
        return None
 
589
 
 
590
class _PluginsAtFinder(object):
 
591
    """Meta path finder to support BRZ_PLUGINS_AT configuration."""
 
592
 
 
593
    def __init__(self, prefix, names_and_paths):
 
594
        self.prefix = prefix
 
595
        self.names_to_path = dict((prefix + n, p) for n, p in names_and_paths)
 
596
 
 
597
    def __repr__(self):
 
598
        return "<%s %r>" % (self.__class__.__name__, self.prefix)
 
599
 
 
600
    def find_spec(self, fullname, paths, target=None):
 
601
        """New module spec returning find method."""
 
602
        if fullname not in self.names_to_path:
 
603
            return None
 
604
        path = self.names_to_path[fullname]
 
605
        if os.path.isdir(path):
 
606
            path = _get_package_init(path)
 
607
            if path is None:
 
608
                # GZ 2017-06-02: Any reason to block loading of the name from
 
609
                # further down the path like this?
 
610
                raise ImportError("Not loading namespace package %s as %s" % (
 
611
                    path, fullname))
 
612
        return importlib_util.spec_from_file_location(fullname, path)
 
613
 
 
614
    def find_module(self, fullname, path):
 
615
        """Old PEP 302 import hook find_module method."""
 
616
        if fullname not in self.names_to_path:
 
617
            return None
 
618
        return _LegacyLoader(self.names_to_path[fullname])
 
619
 
 
620
 
 
621
class _LegacyLoader(object):
 
622
    """Source loader implementation for Python versions without importlib."""
 
623
 
 
624
    def __init__(self, filepath):
 
625
        self.filepath = filepath
 
626
 
 
627
    def __repr__(self):
 
628
        return "<%s %r>" % (self.__class__.__name__, self.filepath)
559
629
 
560
630
    def load_module(self, fullname):
561
 
        """Load a plugin from a specific directory."""
562
 
        # We are called only for specific paths
563
 
        plugin_path = self.specific_paths[fullname]
 
631
        """Load a plugin from a specific directory (or file)."""
 
632
        plugin_path = self.filepath
564
633
        loading_path = None
565
 
        package = False
566
634
        if os.path.isdir(plugin_path):
567
 
            for suffix, mode, kind in imp.get_suffixes():
568
 
                if kind not in (imp.PY_SOURCE, imp.PY_COMPILED):
569
 
                    # We don't recognize compiled modules (.so, .dll, etc)
570
 
                    continue
571
 
                init_path = osutils.pathjoin(plugin_path, '__init__' + suffix)
572
 
                if os.path.isfile(init_path):
573
 
                    loading_path = init_path
574
 
                    package = True
575
 
                    break
 
635
            init_path = _get_package_init(plugin_path)
 
636
            if init_path is not None:
 
637
                loading_path = plugin_path
 
638
                suffix = ''
 
639
                mode = ''
 
640
                kind = imp.PKG_DIRECTORY
576
641
        else:
577
642
            for suffix, mode, kind in imp.get_suffixes():
578
643
                if plugin_path.endswith(suffix):
581
646
        if loading_path is None:
582
647
            raise ImportError('%s cannot be loaded from %s'
583
648
                              % (fullname, plugin_path))
584
 
        f = open(loading_path, mode)
 
649
        if kind is imp.PKG_DIRECTORY:
 
650
            f = None
 
651
        else:
 
652
            f = open(loading_path, mode)
585
653
        try:
586
654
            mod = imp.load_module(fullname, f, loading_path,
587
655
                                  (suffix, mode, kind))
588
 
            if package:
589
 
                # The plugin can contain modules, so be ready
590
 
                mod.__path__ = [plugin_path]
591
656
            mod.__package__ = fullname
592
657
            return mod
593
658
        finally:
594
 
            f.close()
595
 
 
596
 
 
597
 
# Install a dedicated importer for plugins requiring special handling
598
 
PluginImporter = _PluginImporter()
599
 
sys.meta_path.append(PluginImporter)
 
659
            if f is not None:
 
660
                f.close()