/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 bzrlib/commands.py

  • Committer: John Arbash Meinel
  • Date: 2009-02-24 19:07:29 UTC
  • mto: This revision was merged to the branch mainline in revision 4041.
  • Revision ID: john@arbash-meinel.com-20090224190729-pvb2vrgwajvw65jz
Local modification to exclude certain system DLLs

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2006, 2008 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
# TODO: probably should say which arguments are candidates for glob
 
19
# expansion on windows and do that at the command level.
 
20
 
 
21
# TODO: Define arguments by objects, rather than just using names.
 
22
# Those objects can specify the expected type of the argument, which
 
23
# would help with validation and shell completion.  They could also provide
 
24
# help/explanation for that argument in a structured way.
 
25
 
 
26
# TODO: Specific "examples" property on commands for consistent formatting.
 
27
 
 
28
# TODO: "--profile=cum", to change sort order.  Is there any value in leaving
 
29
# the profile output behind so it can be interactively examined?
 
30
 
 
31
import os
 
32
import sys
 
33
 
 
34
from bzrlib.lazy_import import lazy_import
 
35
lazy_import(globals(), """
 
36
import codecs
 
37
import errno
 
38
from warnings import warn
 
39
 
 
40
import bzrlib
 
41
from bzrlib import (
 
42
    debug,
 
43
    errors,
 
44
    option,
 
45
    osutils,
 
46
    trace,
 
47
    win32utils,
 
48
    )
 
49
""")
 
50
 
 
51
from bzrlib import registry
 
52
# Compatibility
 
53
from bzrlib.option import Option
 
54
 
 
55
 
 
56
class CommandInfo(object):
 
57
    """Information about a command."""
 
58
 
 
59
    def __init__(self, aliases):
 
60
        """The list of aliases for the command."""
 
61
        self.aliases = aliases
 
62
 
 
63
    @classmethod
 
64
    def from_command(klass, command):
 
65
        """Factory to construct a CommandInfo from a command."""
 
66
        return klass(command.aliases)
 
67
 
 
68
 
 
69
class CommandRegistry(registry.Registry):
 
70
 
 
71
    @staticmethod
 
72
    def _get_name(command_name):
 
73
        if command_name.startswith("cmd_"):
 
74
            return _unsquish_command_name(command_name)
 
75
        else:
 
76
            return command_name
 
77
 
 
78
    def register(self, cmd, decorate=False):
 
79
        """Utility function to help register a command
 
80
 
 
81
        :param cmd: Command subclass to register
 
82
        :param decorate: If true, allow overriding an existing command
 
83
            of the same name; the old command is returned by this function.
 
84
            Otherwise it is an error to try to override an existing command.
 
85
        """
 
86
        k = cmd.__name__
 
87
        k_unsquished = self._get_name(k)
 
88
        try:
 
89
            previous = self.get(k_unsquished)
 
90
        except KeyError:
 
91
            previous = _builtin_commands().get(k_unsquished)
 
92
        info = CommandInfo.from_command(cmd)
 
93
        try:
 
94
            registry.Registry.register(self, k_unsquished, cmd,
 
95
                                       override_existing=decorate, info=info)
 
96
        except KeyError:
 
97
            trace.log_error('Two plugins defined the same command: %r' % k)
 
98
            trace.log_error('Not loading the one in %r' %
 
99
                            sys.modules[cmd.__module__])
 
100
            trace.log_error('Previously this command was registered from %r' %
 
101
                            sys.modules[previous.__module__])
 
102
        return previous
 
103
 
 
104
    def register_lazy(self, command_name, aliases, module_name):
 
105
        """Register a command without loading its module.
 
106
 
 
107
        :param command_name: The primary name of the command.
 
108
        :param aliases: A list of aliases for the command.
 
109
        :module_name: The module that the command lives in.
 
110
        """
 
111
        key = self._get_name(command_name)
 
112
        registry.Registry.register_lazy(self, key, module_name, command_name,
 
113
                                        info=CommandInfo(aliases))
 
114
 
 
115
 
 
116
plugin_cmds = CommandRegistry()
 
117
 
 
118
 
 
119
def register_command(cmd, decorate=False):
 
120
    global plugin_cmds
 
121
    return plugin_cmds.register(cmd, decorate)
 
122
 
 
123
 
 
124
def _squish_command_name(cmd):
 
125
    return 'cmd_' + cmd.replace('-', '_')
 
126
 
 
127
 
 
128
def _unsquish_command_name(cmd):
 
129
    return cmd[4:].replace('_','-')
 
130
 
 
131
 
 
132
def _builtin_commands():
 
133
    import bzrlib.builtins
 
134
    r = {}
 
135
    builtins = bzrlib.builtins.__dict__
 
136
    for name in builtins:
 
137
        if name.startswith("cmd_"):
 
138
            real_name = _unsquish_command_name(name)
 
139
            r[real_name] = builtins[name]
 
140
    return r
 
141
            
 
142
 
 
143
def builtin_command_names():
 
144
    """Return list of builtin command names."""
 
145
    return _builtin_commands().keys()
 
146
    
 
147
 
 
148
def plugin_command_names():
 
149
    return plugin_cmds.keys()
 
150
 
 
151
 
 
152
def _get_cmd_dict(plugins_override=True):
 
153
    """Return name->class mapping for all commands."""
 
154
    d = _builtin_commands()
 
155
    if plugins_override:
 
156
        d.update(plugin_cmds.iteritems())
 
157
    return d
 
158
 
 
159
    
 
160
def get_all_cmds(plugins_override=True):
 
161
    """Return canonical name and class for all registered commands."""
 
162
    for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
 
163
        yield k,v
 
164
 
 
165
 
 
166
def get_cmd_object(cmd_name, plugins_override=True):
 
167
    """Return the canonical name and command class for a command.
 
168
 
 
169
    plugins_override
 
170
        If true, plugin commands can override builtins.
 
171
    """
 
172
    try:
 
173
        return _get_cmd_object(cmd_name, plugins_override)
 
174
    except KeyError:
 
175
        raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
 
176
 
 
177
 
 
178
def _get_cmd_object(cmd_name, plugins_override=True):
 
179
    """Worker for get_cmd_object which raises KeyError rather than BzrCommandError."""
 
180
    from bzrlib.externalcommand import ExternalCommand
 
181
 
 
182
    # We want only 'ascii' command names, but the user may have typed
 
183
    # in a Unicode name. In that case, they should just get a
 
184
    # 'command not found' error later.
 
185
    # In the future, we may actually support Unicode command names.
 
186
 
 
187
    # first look up this command under the specified name
 
188
    if plugins_override:
 
189
        try:
 
190
            return plugin_cmds.get(cmd_name)()
 
191
        except KeyError:
 
192
            pass
 
193
    cmds = _get_cmd_dict(plugins_override=False)
 
194
    try:
 
195
        return cmds[cmd_name]()
 
196
    except KeyError:
 
197
        pass
 
198
    if plugins_override:
 
199
        for key in plugin_cmds.keys():
 
200
            info = plugin_cmds.get_info(key)
 
201
            if cmd_name in info.aliases:
 
202
                return plugin_cmds.get(key)()
 
203
    # look for any command which claims this as an alias
 
204
    for real_cmd_name, cmd_class in cmds.iteritems():
 
205
        if cmd_name in cmd_class.aliases:
 
206
            return cmd_class()
 
207
 
 
208
    cmd_obj = ExternalCommand.find_command(cmd_name)
 
209
    if cmd_obj:
 
210
        return cmd_obj
 
211
 
 
212
    # look for plugins that provide this command but aren't installed
 
213
    for provider in command_providers_registry:
 
214
        try:
 
215
            plugin_metadata = provider.plugin_for_command(cmd_name)
 
216
        except errors.NoPluginAvailable:
 
217
            pass
 
218
        else:
 
219
            raise errors.CommandAvailableInPlugin(cmd_name, 
 
220
                                                  plugin_metadata, provider)
 
221
 
 
222
    raise KeyError
 
223
 
 
224
 
 
225
class Command(object):
 
226
    """Base class for commands.
 
227
 
 
228
    Commands are the heart of the command-line bzr interface.
 
229
 
 
230
    The command object mostly handles the mapping of command-line
 
231
    parameters into one or more bzrlib operations, and of the results
 
232
    into textual output.
 
233
 
 
234
    Commands normally don't have any state.  All their arguments are
 
235
    passed in to the run method.  (Subclasses may take a different
 
236
    policy if the behaviour of the instance needs to depend on e.g. a
 
237
    shell plugin and not just its Python class.)
 
238
 
 
239
    The docstring for an actual command should give a single-line
 
240
    summary, then a complete description of the command.  A grammar
 
241
    description will be inserted.
 
242
 
 
243
    aliases
 
244
        Other accepted names for this command.
 
245
 
 
246
    takes_args
 
247
        List of argument forms, marked with whether they are optional,
 
248
        repeated, etc.
 
249
 
 
250
                Examples:
 
251
 
 
252
                ['to_location', 'from_branch?', 'file*']
 
253
 
 
254
                'to_location' is required
 
255
                'from_branch' is optional
 
256
                'file' can be specified 0 or more times
 
257
 
 
258
    takes_options
 
259
        List of options that may be given for this command.  These can
 
260
        be either strings, referring to globally-defined options,
 
261
        or option objects.  Retrieve through options().
 
262
 
 
263
    hidden
 
264
        If true, this command isn't advertised.  This is typically
 
265
        for commands intended for expert users.
 
266
 
 
267
    encoding_type
 
268
        Command objects will get a 'outf' attribute, which has been
 
269
        setup to properly handle encoding of unicode strings.
 
270
        encoding_type determines what will happen when characters cannot
 
271
        be encoded
 
272
            strict - abort if we cannot decode
 
273
            replace - put in a bogus character (typically '?')
 
274
            exact - do not encode sys.stdout
 
275
 
 
276
            NOTE: by default on Windows, sys.stdout is opened as a text
 
277
            stream, therefore LF line-endings are converted to CRLF.
 
278
            When a command uses encoding_type = 'exact', then
 
279
            sys.stdout is forced to be a binary stream, and line-endings
 
280
            will not mangled.
 
281
 
 
282
    """
 
283
    aliases = []
 
284
    takes_args = []
 
285
    takes_options = []
 
286
    encoding_type = 'strict'
 
287
 
 
288
    hidden = False
 
289
    
 
290
    def __init__(self):
 
291
        """Construct an instance of this command."""
 
292
        if self.__doc__ == Command.__doc__:
 
293
            warn("No help message set for %r" % self)
 
294
        # List of standard options directly supported
 
295
        self.supported_std_options = []
 
296
 
 
297
    def _maybe_expand_globs(self, file_list):
 
298
        """Glob expand file_list if the platform does not do that itself.
 
299
        
 
300
        :return: A possibly empty list of unicode paths.
 
301
 
 
302
        Introduced in bzrlib 0.18.
 
303
        """
 
304
        if not file_list:
 
305
            file_list = []
 
306
        if sys.platform == 'win32':
 
307
            file_list = win32utils.glob_expand(file_list)
 
308
        return list(file_list)
 
309
 
 
310
    def _usage(self):
 
311
        """Return single-line grammar for this command.
 
312
 
 
313
        Only describes arguments, not options.
 
314
        """
 
315
        s = 'bzr ' + self.name() + ' '
 
316
        for aname in self.takes_args:
 
317
            aname = aname.upper()
 
318
            if aname[-1] in ['$', '+']:
 
319
                aname = aname[:-1] + '...'
 
320
            elif aname[-1] == '?':
 
321
                aname = '[' + aname[:-1] + ']'
 
322
            elif aname[-1] == '*':
 
323
                aname = '[' + aname[:-1] + '...]'
 
324
            s += aname + ' '
 
325
        s = s[:-1]      # remove last space
 
326
        return s
 
327
 
 
328
    def get_help_text(self, additional_see_also=None, plain=True,
 
329
                      see_also_as_links=False):
 
330
        """Return a text string with help for this command.
 
331
        
 
332
        :param additional_see_also: Additional help topics to be
 
333
            cross-referenced.
 
334
        :param plain: if False, raw help (reStructuredText) is
 
335
            returned instead of plain text.
 
336
        :param see_also_as_links: if True, convert items in 'See also'
 
337
            list to internal links (used by bzr_man rstx generator)
 
338
        """
 
339
        doc = self.help()
 
340
        if doc is None:
 
341
            raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
 
342
 
 
343
        # Extract the summary (purpose) and sections out from the text
 
344
        purpose,sections,order = self._get_help_parts(doc)
 
345
 
 
346
        # If a custom usage section was provided, use it
 
347
        if sections.has_key('Usage'):
 
348
            usage = sections.pop('Usage')
 
349
        else:
 
350
            usage = self._usage()
 
351
 
 
352
        # The header is the purpose and usage
 
353
        result = ""
 
354
        result += ':Purpose: %s\n' % purpose
 
355
        if usage.find('\n') >= 0:
 
356
            result += ':Usage:\n%s\n' % usage
 
357
        else:
 
358
            result += ':Usage:   %s\n' % usage
 
359
        result += '\n'
 
360
 
 
361
        # Add the options
 
362
        options = option.get_optparser(self.options()).format_option_help()
 
363
        if options.startswith('Options:'):
 
364
            result += ':' + options
 
365
        elif options.startswith('options:'):
 
366
            # Python 2.4 version of optparse
 
367
            result += ':Options:' + options[len('options:'):]
 
368
        else:
 
369
            result += options
 
370
        result += '\n'
 
371
 
 
372
        # Add the description, indenting it 2 spaces
 
373
        # to match the indentation of the options
 
374
        if sections.has_key(None):
 
375
            text = sections.pop(None)
 
376
            text = '\n  '.join(text.splitlines())
 
377
            result += ':%s:\n  %s\n\n' % ('Description',text)
 
378
 
 
379
        # Add the custom sections (e.g. Examples). Note that there's no need
 
380
        # to indent these as they must be indented already in the source.
 
381
        if sections:
 
382
            for label in order:
 
383
                if sections.has_key(label):
 
384
                    result += ':%s:\n%s\n\n' % (label,sections[label])
 
385
 
 
386
        # Add the aliases, source (plug-in) and see also links, if any
 
387
        if self.aliases:
 
388
            result += ':Aliases:  '
 
389
            result += ', '.join(self.aliases) + '\n'
 
390
        plugin_name = self.plugin_name()
 
391
        if plugin_name is not None:
 
392
            result += ':From:     plugin "%s"\n' % plugin_name
 
393
        see_also = self.get_see_also(additional_see_also)
 
394
        if see_also:
 
395
            if not plain and see_also_as_links:
 
396
                see_also_links = []
 
397
                for item in see_also:
 
398
                    if item == 'topics':
 
399
                        # topics doesn't have an independent section
 
400
                        # so don't create a real link
 
401
                        see_also_links.append(item)
 
402
                    else:
 
403
                        # Use a reST link for this entry
 
404
                        see_also_links.append("`%s`_" % (item,))
 
405
                see_also = see_also_links
 
406
            result += ':See also: '
 
407
            result += ', '.join(see_also) + '\n'
 
408
 
 
409
        # If this will be rendered as plain text, convert it
 
410
        if plain:
 
411
            import bzrlib.help_topics
 
412
            result = bzrlib.help_topics.help_as_plain_text(result)
 
413
        return result
 
414
 
 
415
    @staticmethod
 
416
    def _get_help_parts(text):
 
417
        """Split help text into a summary and named sections.
 
418
 
 
419
        :return: (summary,sections,order) where summary is the top line and
 
420
            sections is a dictionary of the rest indexed by section name.
 
421
            order is the order the section appear in the text.
 
422
            A section starts with a heading line of the form ":xxx:".
 
423
            Indented text on following lines is the section value.
 
424
            All text found outside a named section is assigned to the
 
425
            default section which is given the key of None.
 
426
        """
 
427
        def save_section(sections, order, label, section):
 
428
            if len(section) > 0:
 
429
                if sections.has_key(label):
 
430
                    sections[label] += '\n' + section
 
431
                else:
 
432
                    order.append(label)
 
433
                    sections[label] = section
 
434
 
 
435
        lines = text.rstrip().splitlines()
 
436
        summary = lines.pop(0)
 
437
        sections = {}
 
438
        order = []
 
439
        label,section = None,''
 
440
        for line in lines:
 
441
            if line.startswith(':') and line.endswith(':') and len(line) > 2:
 
442
                save_section(sections, order, label, section)
 
443
                label,section = line[1:-1],''
 
444
            elif (label is not None) and len(line) > 1 and not line[0].isspace():
 
445
                save_section(sections, order, label, section)
 
446
                label,section = None,line
 
447
            else:
 
448
                if len(section) > 0:
 
449
                    section += '\n' + line
 
450
                else:
 
451
                    section = line
 
452
        save_section(sections, order, label, section)
 
453
        return summary, sections, order
 
454
 
 
455
    def get_help_topic(self):
 
456
        """Return the commands help topic - its name."""
 
457
        return self.name()
 
458
 
 
459
    def get_see_also(self, additional_terms=None):
 
460
        """Return a list of help topics that are related to this command.
 
461
        
 
462
        The list is derived from the content of the _see_also attribute. Any
 
463
        duplicates are removed and the result is in lexical order.
 
464
        :param additional_terms: Additional help topics to cross-reference.
 
465
        :return: A list of help topics.
 
466
        """
 
467
        see_also = set(getattr(self, '_see_also', []))
 
468
        if additional_terms:
 
469
            see_also.update(additional_terms)
 
470
        return sorted(see_also)
 
471
 
 
472
    def options(self):
 
473
        """Return dict of valid options for this command.
 
474
 
 
475
        Maps from long option name to option object."""
 
476
        r = Option.STD_OPTIONS.copy()
 
477
        std_names = r.keys()
 
478
        for o in self.takes_options:
 
479
            if isinstance(o, basestring):
 
480
                o = option.Option.OPTIONS[o]
 
481
            r[o.name] = o
 
482
            if o.name in std_names:
 
483
                self.supported_std_options.append(o.name)
 
484
        return r
 
485
 
 
486
    def _setup_outf(self):
 
487
        """Return a file linked to stdout, which has proper encoding."""
 
488
        # Originally I was using self.stdout, but that looks
 
489
        # *way* too much like sys.stdout
 
490
        if self.encoding_type == 'exact':
 
491
            # force sys.stdout to be binary stream on win32
 
492
            if sys.platform == 'win32':
 
493
                fileno = getattr(sys.stdout, 'fileno', None)
 
494
                if fileno:
 
495
                    import msvcrt
 
496
                    msvcrt.setmode(fileno(), os.O_BINARY)
 
497
            self.outf = sys.stdout
 
498
            return
 
499
 
 
500
        output_encoding = osutils.get_terminal_encoding()
 
501
 
 
502
        self.outf = codecs.getwriter(output_encoding)(sys.stdout,
 
503
                        errors=self.encoding_type)
 
504
        # For whatever reason codecs.getwriter() does not advertise its encoding
 
505
        # it just returns the encoding of the wrapped file, which is completely
 
506
        # bogus. So set the attribute, so we can find the correct encoding later.
 
507
        self.outf.encoding = output_encoding
 
508
 
 
509
    def run_argv_aliases(self, argv, alias_argv=None):
 
510
        """Parse the command line and run with extra aliases in alias_argv."""
 
511
        if argv is None:
 
512
            warn("Passing None for [] is deprecated from bzrlib 0.10",
 
513
                 DeprecationWarning, stacklevel=2)
 
514
            argv = []
 
515
        args, opts = parse_args(self, argv, alias_argv)
 
516
 
 
517
        # Process the standard options
 
518
        if 'help' in opts:  # e.g. bzr add --help
 
519
            sys.stdout.write(self.get_help_text())
 
520
            return 0
 
521
        trace.set_verbosity_level(option._verbosity_level)
 
522
        if 'verbose' in self.supported_std_options:
 
523
            opts['verbose'] = trace.is_verbose()
 
524
        elif opts.has_key('verbose'):
 
525
            del opts['verbose']
 
526
        if 'quiet' in self.supported_std_options:
 
527
            opts['quiet'] = trace.is_quiet()
 
528
        elif opts.has_key('quiet'):
 
529
            del opts['quiet']
 
530
 
 
531
        # mix arguments and options into one dictionary
 
532
        cmdargs = _match_argform(self.name(), self.takes_args, args)
 
533
        cmdopts = {}
 
534
        for k, v in opts.items():
 
535
            cmdopts[k.replace('-', '_')] = v
 
536
 
 
537
        all_cmd_args = cmdargs.copy()
 
538
        all_cmd_args.update(cmdopts)
 
539
 
 
540
        self._setup_outf()
 
541
 
 
542
        return self.run(**all_cmd_args)
 
543
 
 
544
    def run(self):
 
545
        """Actually run the command.
 
546
 
 
547
        This is invoked with the options and arguments bound to
 
548
        keyword parameters.
 
549
 
 
550
        Return 0 or None if the command was successful, or a non-zero
 
551
        shell error code if not.  It's OK for this method to allow
 
552
        an exception to raise up.
 
553
        """
 
554
        raise NotImplementedError('no implementation of command %r'
 
555
                                  % self.name())
 
556
 
 
557
    def help(self):
 
558
        """Return help message for this class."""
 
559
        from inspect import getdoc
 
560
        if self.__doc__ is Command.__doc__:
 
561
            return None
 
562
        return getdoc(self)
 
563
 
 
564
    def name(self):
 
565
        return _unsquish_command_name(self.__class__.__name__)
 
566
 
 
567
    def plugin_name(self):
 
568
        """Get the name of the plugin that provides this command.
 
569
 
 
570
        :return: The name of the plugin or None if the command is builtin.
 
571
        """
 
572
        mod_parts = self.__module__.split('.')
 
573
        if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
 
574
            return mod_parts[2]
 
575
        else:
 
576
            return None
 
577
 
 
578
 
 
579
def parse_args(command, argv, alias_argv=None):
 
580
    """Parse command line.
 
581
    
 
582
    Arguments and options are parsed at this level before being passed
 
583
    down to specific command handlers.  This routine knows, from a
 
584
    lookup table, something about the available options, what optargs
 
585
    they take, and which commands will accept them.
 
586
    """
 
587
    # TODO: make it a method of the Command?
 
588
    parser = option.get_optparser(command.options())
 
589
    if alias_argv is not None:
 
590
        args = alias_argv + argv
 
591
    else:
 
592
        args = argv
 
593
 
 
594
    options, args = parser.parse_args(args)
 
595
    opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
 
596
                 v is not option.OptionParser.DEFAULT_VALUE])
 
597
    return args, opts
 
598
 
 
599
 
 
600
def _match_argform(cmd, takes_args, args):
 
601
    argdict = {}
 
602
 
 
603
    # step through args and takes_args, allowing appropriate 0-many matches
 
604
    for ap in takes_args:
 
605
        argname = ap[:-1]
 
606
        if ap[-1] == '?':
 
607
            if args:
 
608
                argdict[argname] = args.pop(0)
 
609
        elif ap[-1] == '*': # all remaining arguments
 
610
            if args:
 
611
                argdict[argname + '_list'] = args[:]
 
612
                args = []
 
613
            else:
 
614
                argdict[argname + '_list'] = None
 
615
        elif ap[-1] == '+':
 
616
            if not args:
 
617
                raise errors.BzrCommandError("command %r needs one or more %s"
 
618
                                             % (cmd, argname.upper()))
 
619
            else:
 
620
                argdict[argname + '_list'] = args[:]
 
621
                args = []
 
622
        elif ap[-1] == '$': # all but one
 
623
            if len(args) < 2:
 
624
                raise errors.BzrCommandError("command %r needs one or more %s"
 
625
                                             % (cmd, argname.upper()))
 
626
            argdict[argname + '_list'] = args[:-1]
 
627
            args[:-1] = []
 
628
        else:
 
629
            # just a plain arg
 
630
            argname = ap
 
631
            if not args:
 
632
                raise errors.BzrCommandError("command %r requires argument %s"
 
633
                               % (cmd, argname.upper()))
 
634
            else:
 
635
                argdict[argname] = args.pop(0)
 
636
            
 
637
    if args:
 
638
        raise errors.BzrCommandError("extra argument to command %s: %s"
 
639
                                     % (cmd, args[0]))
 
640
 
 
641
    return argdict
 
642
 
 
643
def apply_coveraged(dirname, the_callable, *args, **kwargs):
 
644
    # Cannot use "import trace", as that would import bzrlib.trace instead of
 
645
    # the standard library's trace.
 
646
    trace = __import__('trace')
 
647
 
 
648
    tracer = trace.Trace(count=1, trace=0)
 
649
    sys.settrace(tracer.globaltrace)
 
650
 
 
651
    ret = the_callable(*args, **kwargs)
 
652
 
 
653
    sys.settrace(None)
 
654
    results = tracer.results()
 
655
    results.write_results(show_missing=1, summary=False,
 
656
                          coverdir=dirname)
 
657
 
 
658
 
 
659
def apply_profiled(the_callable, *args, **kwargs):
 
660
    import hotshot
 
661
    import tempfile
 
662
    import hotshot.stats
 
663
    pffileno, pfname = tempfile.mkstemp()
 
664
    try:
 
665
        prof = hotshot.Profile(pfname)
 
666
        try:
 
667
            ret = prof.runcall(the_callable, *args, **kwargs) or 0
 
668
        finally:
 
669
            prof.close()
 
670
        stats = hotshot.stats.load(pfname)
 
671
        stats.strip_dirs()
 
672
        stats.sort_stats('cum')   # 'time'
 
673
        ## XXX: Might like to write to stderr or the trace file instead but
 
674
        ## print_stats seems hardcoded to stdout
 
675
        stats.print_stats(20)
 
676
        return ret
 
677
    finally:
 
678
        os.close(pffileno)
 
679
        os.remove(pfname)
 
680
 
 
681
 
 
682
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
 
683
    from bzrlib.lsprof import profile
 
684
    ret, stats = profile(the_callable, *args, **kwargs)
 
685
    stats.sort()
 
686
    if filename is None:
 
687
        stats.pprint()
 
688
    else:
 
689
        stats.save(filename)
 
690
        trace.note('Profile data written to "%s".', filename)
 
691
    return ret
 
692
 
 
693
 
 
694
def shlex_split_unicode(unsplit):
 
695
    import shlex
 
696
    return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
 
697
 
 
698
 
 
699
def get_alias(cmd, config=None):
 
700
    """Return an expanded alias, or None if no alias exists.
 
701
 
 
702
    cmd
 
703
        Command to be checked for an alias.
 
704
    config
 
705
        Used to specify an alternative config to use,
 
706
        which is especially useful for testing.
 
707
        If it is unspecified, the global config will be used.
 
708
    """
 
709
    if config is None:
 
710
        import bzrlib.config
 
711
        config = bzrlib.config.GlobalConfig()
 
712
    alias = config.get_alias(cmd)
 
713
    if (alias):
 
714
        return shlex_split_unicode(alias)
 
715
    return None
 
716
 
 
717
 
 
718
def run_bzr(argv):
 
719
    """Execute a command.
 
720
 
 
721
    argv
 
722
       The command-line arguments, without the program name from argv[0]
 
723
       These should already be decoded. All library/test code calling
 
724
       run_bzr should be passing valid strings (don't need decoding).
 
725
    
 
726
    Returns a command status or raises an exception.
 
727
 
 
728
    Special master options: these must come before the command because
 
729
    they control how the command is interpreted.
 
730
 
 
731
    --no-plugins
 
732
        Do not load plugin modules at all
 
733
 
 
734
    --no-aliases
 
735
        Do not allow aliases
 
736
 
 
737
    --builtin
 
738
        Only use builtin commands.  (Plugins are still allowed to change
 
739
        other behaviour.)
 
740
 
 
741
    --profile
 
742
        Run under the Python hotshot profiler.
 
743
 
 
744
    --lsprof
 
745
        Run under the Python lsprof profiler.
 
746
 
 
747
    --coverage
 
748
        Generate line coverage report in the specified directory.
 
749
    """
 
750
    argv = list(argv)
 
751
    trace.mutter("bzr arguments: %r", argv)
 
752
 
 
753
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin =  \
 
754
                opt_no_aliases = False
 
755
    opt_lsprof_file = opt_coverage_dir = None
 
756
 
 
757
    # --no-plugins is handled specially at a very early stage. We need
 
758
    # to load plugins before doing other command parsing so that they
 
759
    # can override commands, but this needs to happen first.
 
760
 
 
761
    argv_copy = []
 
762
    i = 0
 
763
    while i < len(argv):
 
764
        a = argv[i]
 
765
        if a == '--profile':
 
766
            opt_profile = True
 
767
        elif a == '--lsprof':
 
768
            opt_lsprof = True
 
769
        elif a == '--lsprof-file':
 
770
            opt_lsprof = True
 
771
            opt_lsprof_file = argv[i + 1]
 
772
            i += 1
 
773
        elif a == '--no-plugins':
 
774
            opt_no_plugins = True
 
775
        elif a == '--no-aliases':
 
776
            opt_no_aliases = True
 
777
        elif a == '--builtin':
 
778
            opt_builtin = True
 
779
        elif a == '--coverage':
 
780
            opt_coverage_dir = argv[i + 1]
 
781
            i += 1
 
782
        elif a.startswith('-D'):
 
783
            debug.debug_flags.add(a[2:])
 
784
        else:
 
785
            argv_copy.append(a)
 
786
        i += 1
 
787
 
 
788
    argv = argv_copy
 
789
    if (not argv):
 
790
        from bzrlib.builtins import cmd_help
 
791
        cmd_help().run_argv_aliases([])
 
792
        return 0
 
793
 
 
794
    if argv[0] == '--version':
 
795
        from bzrlib.builtins import cmd_version
 
796
        cmd_version().run_argv_aliases([])
 
797
        return 0
 
798
 
 
799
    if not opt_no_plugins:
 
800
        from bzrlib.plugin import load_plugins
 
801
        load_plugins()
 
802
    else:
 
803
        from bzrlib.plugin import disable_plugins
 
804
        disable_plugins()
 
805
 
 
806
    alias_argv = None
 
807
 
 
808
    if not opt_no_aliases:
 
809
        alias_argv = get_alias(argv[0])
 
810
        if alias_argv:
 
811
            user_encoding = osutils.get_user_encoding()
 
812
            alias_argv = [a.decode(user_encoding) for a in alias_argv]
 
813
            argv[0] = alias_argv.pop(0)
 
814
 
 
815
    cmd = argv.pop(0)
 
816
    # We want only 'ascii' command names, but the user may have typed
 
817
    # in a Unicode name. In that case, they should just get a
 
818
    # 'command not found' error later.
 
819
 
 
820
    cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
 
821
    run = cmd_obj.run_argv_aliases
 
822
    run_argv = [argv, alias_argv]
 
823
 
 
824
    try:
 
825
        # We can be called recursively (tests for example), but we don't want
 
826
        # the verbosity level to propagate.
 
827
        saved_verbosity_level = option._verbosity_level
 
828
        option._verbosity_level = 0
 
829
        if opt_lsprof:
 
830
            if opt_coverage_dir:
 
831
                trace.warning(
 
832
                    '--coverage ignored, because --lsprof is in use.')
 
833
            ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
 
834
        elif opt_profile:
 
835
            if opt_coverage_dir:
 
836
                trace.warning(
 
837
                    '--coverage ignored, because --profile is in use.')
 
838
            ret = apply_profiled(run, *run_argv)
 
839
        elif opt_coverage_dir:
 
840
            ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
 
841
        else:
 
842
            ret = run(*run_argv)
 
843
        if 'memory' in debug.debug_flags:
 
844
            trace.debug_memory('Process status after command:', short=False)
 
845
        return ret or 0
 
846
    finally:
 
847
        # reset, in case we may do other commands later within the same
 
848
        # process. Commands that want to execute sub-commands must propagate
 
849
        # --verbose in their own way.
 
850
        option._verbosity_level = saved_verbosity_level
 
851
 
 
852
def display_command(func):
 
853
    """Decorator that suppresses pipe/interrupt errors."""
 
854
    def ignore_pipe(*args, **kwargs):
 
855
        try:
 
856
            result = func(*args, **kwargs)
 
857
            sys.stdout.flush()
 
858
            return result
 
859
        except IOError, e:
 
860
            if getattr(e, 'errno', None) is None:
 
861
                raise
 
862
            if e.errno != errno.EPIPE:
 
863
                # Win32 raises IOError with errno=0 on a broken pipe
 
864
                if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
 
865
                    raise
 
866
            pass
 
867
        except KeyboardInterrupt:
 
868
            pass
 
869
    return ignore_pipe
 
870
 
 
871
 
 
872
def main(argv):
 
873
    import bzrlib.ui
 
874
    bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
 
875
        sys.stdin, sys.stdout, sys.stderr)
 
876
 
 
877
    # Is this a final release version? If so, we should suppress warnings
 
878
    if bzrlib.version_info[3] == 'final':
 
879
        from bzrlib import symbol_versioning
 
880
        symbol_versioning.suppress_deprecation_warnings(override=False)
 
881
    try:
 
882
        user_encoding = osutils.get_user_encoding()
 
883
        argv = [a.decode(user_encoding) for a in argv[1:]]
 
884
    except UnicodeDecodeError:
 
885
        raise errors.BzrError(("Parameter '%r' is unsupported by the current "
 
886
                                                            "encoding." % a))
 
887
    ret = run_bzr_catch_errors(argv)
 
888
    trace.mutter("return code %d", ret)
 
889
    return ret
 
890
 
 
891
 
 
892
def run_bzr_catch_errors(argv):
 
893
    # Note: The except clause logic below should be kept in sync with the
 
894
    # profile() routine in lsprof.py.
 
895
    try:
 
896
        return run_bzr(argv)
 
897
    except (KeyboardInterrupt, Exception), e:
 
898
        # used to handle AssertionError and KeyboardInterrupt
 
899
        # specially here, but hopefully they're handled ok by the logger now
 
900
        exc_info = sys.exc_info()
 
901
        exitcode = trace.report_exception(exc_info, sys.stderr)
 
902
        if os.environ.get('BZR_PDB'):
 
903
            print '**** entering debugger'
 
904
            tb = exc_info[2]
 
905
            import pdb
 
906
            if sys.version_info[:2] < (2, 6):
 
907
                # XXX: we want to do
 
908
                #    pdb.post_mortem(tb)
 
909
                # but because pdb.post_mortem gives bad results for tracebacks
 
910
                # from inside generators, we do it manually.
 
911
                # (http://bugs.python.org/issue4150, fixed in Python 2.6)
 
912
                
 
913
                # Setup pdb on the traceback
 
914
                p = pdb.Pdb()
 
915
                p.reset()
 
916
                p.setup(tb.tb_frame, tb)
 
917
                # Point the debugger at the deepest frame of the stack
 
918
                p.curindex = len(p.stack) - 1
 
919
                p.curframe = p.stack[p.curindex]
 
920
                # Start the pdb prompt.
 
921
                p.print_stack_entry(p.stack[p.curindex])
 
922
                p.execRcLines()
 
923
                p.cmdloop()
 
924
            else:
 
925
                pdb.post_mortem(tb)
 
926
        return exitcode
 
927
 
 
928
 
 
929
def run_bzr_catch_user_errors(argv):
 
930
    """Run bzr and report user errors, but let internal errors propagate.
 
931
 
 
932
    This is used for the test suite, and might be useful for other programs
 
933
    that want to wrap the commandline interface.
 
934
    """
 
935
    try:
 
936
        return run_bzr(argv)
 
937
    except Exception, e:
 
938
        if (isinstance(e, (OSError, IOError))
 
939
            or not getattr(e, 'internal_error', True)):
 
940
            trace.report_exception(sys.exc_info(), sys.stderr)
 
941
            return 3
 
942
        else:
 
943
            raise
 
944
 
 
945
 
 
946
class HelpCommandIndex(object):
 
947
    """A index for bzr help that returns commands."""
 
948
 
 
949
    def __init__(self):
 
950
        self.prefix = 'commands/'
 
951
 
 
952
    def get_topics(self, topic):
 
953
        """Search for topic amongst commands.
 
954
 
 
955
        :param topic: A topic to search for.
 
956
        :return: A list which is either empty or contains a single
 
957
            Command entry.
 
958
        """
 
959
        if topic and topic.startswith(self.prefix):
 
960
            topic = topic[len(self.prefix):]
 
961
        try:
 
962
            cmd = _get_cmd_object(topic)
 
963
        except KeyError:
 
964
            return []
 
965
        else:
 
966
            return [cmd]
 
967
 
 
968
 
 
969
class Provider(object):
 
970
    '''Generic class to be overriden by plugins'''
 
971
 
 
972
    def plugin_for_command(self, cmd_name):
 
973
        '''Takes a command and returns the information for that plugin
 
974
        
 
975
        :return: A dictionary with all the available information 
 
976
        for the requested plugin
 
977
        '''
 
978
        raise NotImplementedError
 
979
 
 
980
 
 
981
class ProvidersRegistry(registry.Registry):
 
982
    '''This registry exists to allow other providers to exist'''
 
983
 
 
984
    def __iter__(self):
 
985
        for key, provider in self.iteritems():
 
986
            yield provider
 
987
 
 
988
command_providers_registry = ProvidersRegistry()
 
989
 
 
990
 
 
991
if __name__ == '__main__':
 
992
    sys.exit(main(sys.argv))