← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/plugin.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-04-17 00:59:30 UTC
  • mfrom: (1551.15.4 Aaron's mergeable stuff)
  • Revision ID: pqm@pqm.ubuntu.com-20070417005930-rofskshyjsfzrahh
Fix ftp transport with servers that don't support atomic rename

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/plugin.py
1
 
# Copyright (C) 2004, 2005, 2007 Canonical Ltd
 
1
# Copyright (C) 2004, 2005 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
37
37
import imp
38
38
import re
39
39
import types
40
 
import zipfile
 
40
import zipimport
41
41
 
42
42
from bzrlib import (
43
43
    config,
194
194
    """Load all the plugins in a zip."""
195
195
    valid_suffixes = ('.py', '.pyc', '.pyo')    # only python modules/packages
196
196
                                                # is allowed
197
 
 
 
197
    if '.zip' not in zip_name:
 
198
        return
198
199
    try:
199
 
        index = zip_name.rindex('.zip')
200
 
    except ValueError:
 
200
        ziobj = zipimport.zipimporter(zip_name)
 
201
    except zipimport.ZipImportError:
 
202
        # not a valid zip
201
203
        return
202
 
    archive = zip_name[:index+4]
203
 
    prefix = zip_name[index+5:]
204
 
 
205
204
    mutter('Looking for plugins in %r', zip_name)
 
205
    
 
206
    import zipfile
206
207
 
207
208
    # use zipfile to get list of files/dirs inside zip
208
 
    try:
209
 
        z = zipfile.ZipFile(archive)
210
 
        namelist = z.namelist()
211
 
        z.close()
212
 
    except zipfile.error:
213
 
        # not a valid zip
214
 
        return
215
 
 
216
 
    if prefix:
217
 
        prefix = prefix.replace('\\','/')
218
 
        if prefix[-1] != '/':
219
 
            prefix += '/'
 
209
    z = zipfile.ZipFile(ziobj.archive)
 
210
    namelist = z.namelist()
 
211
    z.close()
 
212
    
 
213
    if ziobj.prefix:
 
214
        prefix = ziobj.prefix.replace('\\','/')
220
215
        ix = len(prefix)
221
216
        namelist = [name[ix:]
222
217
                    for name in namelist
223
218
                    if name.startswith(prefix)]
224
 
 
 
219
    
225
220
    mutter('Names in archive: %r', namelist)
226
221
    
227
222
    for name in namelist:
258
253
            continue
259
254
    
260
255
        try:
261
 
            exec "import bzrlib.plugins.%s" % plugin_name in {}
 
256
            plugin = ziobj.load_module(plugin_name)
 
257
            setattr(plugins, plugin_name, plugin)
262
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
263
        except KeyboardInterrupt:
264
264
            raise
265
265
        except Exception, e:
267
267
            warning('Unable to load plugin %r from %r'
268
268
                    % (name, zip_name))
269
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.'):]