← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/plugin.py

  • Committer: John Arbash Meinel
  • Date: 2007-03-15 22:35:35 UTC
  • mto: This revision was merged to the branch mainline in revision 2363.
  • Revision ID: john@arbash-meinel.com-20070315223535-d3d4964oe1hc8zhg
Add an overzealous test, for Unicode support of _iter_changes.
For both knowns and unknowns.
And include a basic, if suboptimal, fix.
I would rather defer the decoding until we've determined that we are going to return the tuple.
There is still something broken with added files, but I'll get to that.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/plugin.py
 
1
# Copyright (C) 2004, 2005 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
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; 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
"""
 
31
 
 
32
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
 
53
_loaded = False
 
54
 
 
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
 
 
93
def load_plugins():
 
94
    """Load bzrlib plugins.
 
95
 
 
96
    The environment variable BZR_PLUGIN_PATH is considered a delimited
 
97
    set of paths to look through. Each entry is searched for *.py
 
98
    files (and whatever other extensions are used in the platform,
 
99
    such as *.pyd).
 
100
 
 
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
 
105
    if _loaded:
 
106
        # People can make sure plugins are loaded, they just won't be twice
 
107
        return
 
108
    _loaded = True
 
109
 
 
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:
 
128
        if not d:
 
129
            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)
 
136
            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
 
170
            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)
 
176
            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()