~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Martin Pool
  • Date: 2005-05-10 08:15:58 UTC
  • Revision ID: mbp@sourcefrog.net-20050510081558-9a38e2c46ba4ebc4
- Patch from Fredrik Lundh to check Python version and 
  try to find a better one if it's too old.

  Patched to try to prevent infinite loops in wierd configurations,
  and to log to stderr.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
2
 
#
 
1
# Copyright (C) 2004, 2005 by Canonical Ltd
 
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
#
 
7
 
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
#
 
12
 
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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
 
import threading
39
 
from warnings import warn
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
 
 
18
 
 
19
import sys, os, time, os.path
 
20
from sets import Set
40
21
 
41
22
import bzrlib
42
 
from bzrlib import (
43
 
    cleanup,
44
 
    cmdline,
45
 
    debug,
46
 
    errors,
47
 
    option,
48
 
    osutils,
49
 
    trace,
50
 
    ui,
51
 
    win32utils,
52
 
    )
53
 
""")
54
 
 
55
 
from bzrlib.hooks import HookPoint, Hooks
56
 
# Compatibility - Option used to be in commands.
57
 
from bzrlib.option import Option
58
 
from bzrlib.plugin import disable_plugins, load_plugins
59
 
from bzrlib import registry
60
 
from bzrlib.symbol_versioning import (
61
 
    deprecated_function,
62
 
    deprecated_in,
63
 
    deprecated_method,
64
 
    )
65
 
 
66
 
 
67
 
class CommandInfo(object):
68
 
    """Information about a command."""
69
 
 
70
 
    def __init__(self, aliases):
71
 
        """The list of aliases for the command."""
72
 
        self.aliases = aliases
73
 
 
74
 
    @classmethod
75
 
    def from_command(klass, command):
76
 
        """Factory to construct a CommandInfo from a command."""
77
 
        return klass(command.aliases)
78
 
 
79
 
 
80
 
class CommandRegistry(registry.Registry):
81
 
 
82
 
    @staticmethod
83
 
    def _get_name(command_name):
84
 
        if command_name.startswith("cmd_"):
85
 
            return _unsquish_command_name(command_name)
86
 
        else:
87
 
            return command_name
88
 
 
89
 
    def register(self, cmd, decorate=False):
90
 
        """Utility function to help register a command
91
 
 
92
 
        :param cmd: Command subclass to register
93
 
        :param decorate: If true, allow overriding an existing command
94
 
            of the same name; the old command is returned by this function.
95
 
            Otherwise it is an error to try to override an existing command.
96
 
        """
97
 
        k = cmd.__name__
98
 
        k_unsquished = self._get_name(k)
99
 
        try:
100
 
            previous = self.get(k_unsquished)
101
 
        except KeyError:
102
 
            previous = _builtin_commands().get(k_unsquished)
103
 
        info = CommandInfo.from_command(cmd)
104
 
        try:
105
 
            registry.Registry.register(self, k_unsquished, cmd,
106
 
                                       override_existing=decorate, info=info)
107
 
        except KeyError:
108
 
            trace.warning('Two plugins defined the same command: %r' % k)
109
 
            trace.warning('Not loading the one in %r' %
110
 
                sys.modules[cmd.__module__])
111
 
            trace.warning('Previously this command was registered from %r' %
112
 
                sys.modules[previous.__module__])
113
 
        return previous
114
 
 
115
 
    def register_lazy(self, command_name, aliases, module_name):
116
 
        """Register a command without loading its module.
117
 
 
118
 
        :param command_name: The primary name of the command.
119
 
        :param aliases: A list of aliases for the command.
120
 
        :module_name: The module that the command lives in.
121
 
        """
122
 
        key = self._get_name(command_name)
123
 
        registry.Registry.register_lazy(self, key, module_name, command_name,
124
 
                                        info=CommandInfo(aliases))
125
 
 
126
 
 
127
 
plugin_cmds = CommandRegistry()
128
 
 
129
 
 
130
 
def register_command(cmd, decorate=False):
131
 
    global plugin_cmds
132
 
    return plugin_cmds.register(cmd, decorate)
 
23
from bzrlib.trace import mutter, note, log_error
 
24
from bzrlib.errors import bailout, BzrError, BzrCheckError, BzrCommandError
 
25
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
 
26
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
 
27
from bzrlib.revision import Revision
 
28
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
 
29
     format_date
133
30
 
134
31
 
135
32
def _squish_command_name(cmd):
137
34
 
138
35
 
139
36
def _unsquish_command_name(cmd):
 
37
    assert cmd.startswith("cmd_")
140
38
    return cmd[4:].replace('_','-')
141
39
 
142
 
 
143
 
def _builtin_commands():
144
 
    import bzrlib.builtins
145
 
    return _scan_module_for_commands(bzrlib.builtins)
146
 
 
147
 
 
148
 
def _scan_module_for_commands(module):
149
 
    r = {}
150
 
    for name, obj in module.__dict__.iteritems():
151
 
        if name.startswith("cmd_"):
152
 
            real_name = _unsquish_command_name(name)
153
 
            r[real_name] = obj
154
 
    return r
155
 
 
156
 
 
157
 
def _list_bzr_commands(names):
158
 
    """Find commands from bzr's core and plugins."""
159
 
    # to eliminate duplicates
160
 
    names.update(builtin_command_names())
161
 
    names.update(plugin_command_names())
162
 
    return names
163
 
 
164
 
 
165
 
def all_command_names():
166
 
    """Return a set of all command names."""
167
 
    names = set()
168
 
    for hook in Command.hooks['list_commands']:
169
 
        names = hook(names)
170
 
        if names is None:
171
 
            raise AssertionError(
172
 
                'hook %s returned None' % Command.hooks.get_hook_name(hook))
173
 
    return names
174
 
 
175
 
 
176
 
def builtin_command_names():
177
 
    """Return list of builtin command names.
178
 
    
179
 
    Use of all_command_names() is encouraged rather than builtin_command_names
180
 
    and/or plugin_command_names.
181
 
    """
182
 
    return _builtin_commands().keys()
183
 
 
184
 
 
185
 
def plugin_command_names():
186
 
    """Returns command names from commands registered by plugins."""
187
 
    return plugin_cmds.keys()
188
 
 
189
 
 
190
 
def get_cmd_object(cmd_name, plugins_override=True):
191
 
    """Return the command object for a command.
192
 
 
193
 
    plugins_override
194
 
        If true, plugin commands can override builtins.
195
 
    """
196
 
    try:
197
 
        return _get_cmd_object(cmd_name, plugins_override)
198
 
    except KeyError:
199
 
        raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
200
 
 
201
 
 
202
 
def _get_cmd_object(cmd_name, plugins_override=True):
203
 
    """Get a command object.
204
 
 
205
 
    :param cmd_name: The name of the command.
206
 
    :param plugins_override: Allow plugins to override builtins.
207
 
    :return: A Command object instance
208
 
    :raises KeyError: If no command is found.
209
 
    """
210
 
    # We want only 'ascii' command names, but the user may have typed
211
 
    # in a Unicode name. In that case, they should just get a
212
 
    # 'command not found' error later.
213
 
    # In the future, we may actually support Unicode command names.
214
 
    cmd = None
215
 
    # Get a command
216
 
    for hook in Command.hooks['get_command']:
217
 
        cmd = hook(cmd, cmd_name)
218
 
        if cmd is not None and not plugins_override and not cmd.plugin_name():
219
 
            # We've found a non-plugin command, don't permit it to be
220
 
            # overridden.
221
 
            break
222
 
    if cmd is None:
223
 
        for hook in Command.hooks['get_missing_command']:
224
 
            cmd = hook(cmd_name)
225
 
            if cmd is not None:
226
 
                break
227
 
    if cmd is None:
228
 
        # No command found.
229
 
        raise KeyError
230
 
    # Allow plugins to extend commands
231
 
    for hook in Command.hooks['extend_command']:
232
 
        hook(cmd)
233
 
    return cmd
234
 
 
235
 
 
236
 
def _try_plugin_provider(cmd_name):
237
 
    """Probe for a plugin provider having cmd_name."""
238
 
    try:
239
 
        plugin_metadata, provider = probe_for_provider(cmd_name)
240
 
        raise errors.CommandAvailableInPlugin(cmd_name,
241
 
            plugin_metadata, provider)
242
 
    except errors.NoPluginAvailable:
243
 
        pass
244
 
 
245
 
 
246
 
def probe_for_provider(cmd_name):
247
 
    """Look for a provider for cmd_name.
248
 
 
249
 
    :param cmd_name: The command name.
250
 
    :return: plugin_metadata, provider for getting cmd_name.
251
 
    :raises NoPluginAvailable: When no provider can supply the plugin.
252
 
    """
253
 
    # look for providers that provide this command but aren't installed
254
 
    for provider in command_providers_registry:
255
 
        try:
256
 
            return provider.plugin_for_command(cmd_name), provider
257
 
        except errors.NoPluginAvailable:
258
 
            pass
259
 
    raise errors.NoPluginAvailable(cmd_name)
260
 
 
261
 
 
262
 
def _get_bzr_command(cmd_or_None, cmd_name):
263
 
    """Get a command from bzr's core."""
264
 
    cmds = _builtin_commands()
265
 
    try:
266
 
        return cmds[cmd_name]()
267
 
    except KeyError:
268
 
        pass
 
40
def get_all_cmds():
 
41
    """Return canonical name and class for all registered commands."""
 
42
    for k, v in globals().iteritems():
 
43
        if k.startswith("cmd_"):
 
44
            yield _unsquish_command_name(k), v
 
45
 
 
46
def get_cmd_class(cmd):
 
47
    """Return the canonical name and command class for a command.
 
48
    """
 
49
    cmd = str(cmd)                      # not unicode
 
50
 
 
51
    # first look up this command under the specified name
 
52
    try:
 
53
        return cmd, globals()[_squish_command_name(cmd)]
 
54
    except KeyError:
 
55
        pass
 
56
 
269
57
    # look for any command which claims this as an alias
270
 
    for real_cmd_name, cmd_class in cmds.iteritems():
271
 
        if cmd_name in cmd_class.aliases:
272
 
            return cmd_class()
273
 
    return cmd_or_None
274
 
 
275
 
 
276
 
def _get_external_command(cmd_or_None, cmd_name):
277
 
    """Lookup a command that is a shell script."""
278
 
    # Only do external command lookups when no command is found so far.
279
 
    if cmd_or_None is not None:
280
 
        return cmd_or_None
281
 
    from bzrlib.externalcommand import ExternalCommand
282
 
    cmd_obj = ExternalCommand.find_command(cmd_name)
283
 
    if cmd_obj:
284
 
        return cmd_obj
285
 
 
286
 
 
287
 
def _get_plugin_command(cmd_or_None, cmd_name):
288
 
    """Get a command from bzr's plugins."""
289
 
    try:
290
 
        return plugin_cmds.get(cmd_name)()
291
 
    except KeyError:
292
 
        pass
293
 
    for key in plugin_cmds.keys():
294
 
        info = plugin_cmds.get_info(key)
295
 
        if cmd_name in info.aliases:
296
 
            return plugin_cmds.get(key)()
297
 
    return cmd_or_None
298
 
 
299
 
 
300
 
class Command(object):
 
58
    for cmdname, cmdclass in get_all_cmds():
 
59
        if cmd in cmdclass.aliases:
 
60
            return cmdname, cmdclass
 
61
 
 
62
    cmdclass = ExternalCommand.find_command(cmd)
 
63
    if cmdclass:
 
64
        return cmd, cmdclass
 
65
 
 
66
    raise BzrCommandError("unknown command %r" % cmd)
 
67
 
 
68
 
 
69
class Command:
301
70
    """Base class for commands.
302
71
 
303
 
    Commands are the heart of the command-line bzr interface.
304
 
 
305
 
    The command object mostly handles the mapping of command-line
306
 
    parameters into one or more bzrlib operations, and of the results
307
 
    into textual output.
308
 
 
309
 
    Commands normally don't have any state.  All their arguments are
310
 
    passed in to the run method.  (Subclasses may take a different
311
 
    policy if the behaviour of the instance needs to depend on e.g. a
312
 
    shell plugin and not just its Python class.)
313
 
 
314
72
    The docstring for an actual command should give a single-line
315
73
    summary, then a complete description of the command.  A grammar
316
74
    description will be inserted.
317
75
 
318
 
    aliases
319
 
        Other accepted names for this command.
320
 
 
321
76
    takes_args
322
77
        List of argument forms, marked with whether they are optional,
323
78
        repeated, etc.
324
79
 
325
 
                Examples:
326
 
 
327
 
                ['to_location', 'from_branch?', 'file*']
328
 
 
329
 
                'to_location' is required
330
 
                'from_branch' is optional
331
 
                'file' can be specified 0 or more times
332
 
 
333
80
    takes_options
334
 
        List of options that may be given for this command.  These can
335
 
        be either strings, referring to globally-defined options,
336
 
        or option objects.  Retrieve through options().
 
81
        List of options that may be given for this command.
337
82
 
338
83
    hidden
339
 
        If true, this command isn't advertised.  This is typically
340
 
        for commands intended for expert users.
341
 
 
342
 
    encoding_type
343
 
        Command objects will get a 'outf' attribute, which has been
344
 
        setup to properly handle encoding of unicode strings.
345
 
        encoding_type determines what will happen when characters cannot
346
 
        be encoded
347
 
            strict - abort if we cannot decode
348
 
            replace - put in a bogus character (typically '?')
349
 
            exact - do not encode sys.stdout
350
 
 
351
 
            NOTE: by default on Windows, sys.stdout is opened as a text
352
 
            stream, therefore LF line-endings are converted to CRLF.
353
 
            When a command uses encoding_type = 'exact', then
354
 
            sys.stdout is forced to be a binary stream, and line-endings
355
 
            will not mangled.
356
 
 
357
 
    :cvar hooks: An instance of CommandHooks.
 
84
        If true, this command isn't advertised.
358
85
    """
359
86
    aliases = []
 
87
    
360
88
    takes_args = []
361
89
    takes_options = []
362
 
    encoding_type = 'strict'
363
90
 
364
91
    hidden = False
365
 
 
366
 
    def __init__(self):
367
 
        """Construct an instance of this command."""
368
 
        if self.__doc__ == Command.__doc__:
369
 
            warn("No help message set for %r" % self)
370
 
        # List of standard options directly supported
371
 
        self.supported_std_options = []
372
 
        self._operation = cleanup.OperationWithCleanups(self.run)
373
 
    
374
 
    def add_cleanup(self, cleanup_func, *args, **kwargs):
375
 
        """Register a function to call after self.run returns or raises.
376
 
 
377
 
        Functions will be called in LIFO order.
378
 
        """
379
 
        self._operation.add_cleanup(cleanup_func, *args, **kwargs)
380
 
 
381
 
    def cleanup_now(self):
382
 
        """Execute and empty pending cleanup functions immediately.
383
 
 
384
 
        After cleanup_now all registered cleanups are forgotten.  add_cleanup
385
 
        may be called again after cleanup_now; these cleanups will be called
386
 
        after self.run returns or raises (or when cleanup_now is next called).
387
 
 
388
 
        This is useful for releasing expensive or contentious resources (such
389
 
        as write locks) before doing further work that does not require those
390
 
        resources (such as writing results to self.outf).
391
 
        """
392
 
        self._operation.cleanup_now()
393
 
        
394
 
    @deprecated_method(deprecated_in((2, 1, 0)))
395
 
    def _maybe_expand_globs(self, file_list):
396
 
        """Glob expand file_list if the platform does not do that itself.
397
 
 
398
 
        Not used anymore, now that the bzr command-line parser globs on
399
 
        Windows.
400
 
 
401
 
        :return: A possibly empty list of unicode paths.
402
 
 
403
 
        Introduced in bzrlib 0.18.
404
 
        """
405
 
        return file_list
406
 
 
407
 
    def _usage(self):
408
 
        """Return single-line grammar for this command.
409
 
 
410
 
        Only describes arguments, not options.
411
 
        """
412
 
        s = 'bzr ' + self.name() + ' '
413
 
        for aname in self.takes_args:
414
 
            aname = aname.upper()
415
 
            if aname[-1] in ['$', '+']:
416
 
                aname = aname[:-1] + '...'
417
 
            elif aname[-1] == '?':
418
 
                aname = '[' + aname[:-1] + ']'
419
 
            elif aname[-1] == '*':
420
 
                aname = '[' + aname[:-1] + '...]'
421
 
            s += aname + ' '
422
 
        s = s[:-1]      # remove last space
423
 
        return s
424
 
 
425
 
    def get_help_text(self, additional_see_also=None, plain=True,
426
 
                      see_also_as_links=False, verbose=True):
427
 
        """Return a text string with help for this command.
428
 
 
429
 
        :param additional_see_also: Additional help topics to be
430
 
            cross-referenced.
431
 
        :param plain: if False, raw help (reStructuredText) is
432
 
            returned instead of plain text.
433
 
        :param see_also_as_links: if True, convert items in 'See also'
434
 
            list to internal links (used by bzr_man rstx generator)
435
 
        :param verbose: if True, display the full help, otherwise
436
 
            leave out the descriptive sections and just display
437
 
            usage help (e.g. Purpose, Usage, Options) with a
438
 
            message explaining how to obtain full help.
439
 
        """
440
 
        doc = self.help()
441
 
        if doc is None:
442
 
            raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
443
 
 
444
 
        # Extract the summary (purpose) and sections out from the text
445
 
        purpose,sections,order = self._get_help_parts(doc)
446
 
 
447
 
        # If a custom usage section was provided, use it
448
 
        if sections.has_key('Usage'):
449
 
            usage = sections.pop('Usage')
450
 
        else:
451
 
            usage = self._usage()
452
 
 
453
 
        # The header is the purpose and usage
454
 
        result = ""
455
 
        result += ':Purpose: %s\n' % purpose
456
 
        if usage.find('\n') >= 0:
457
 
            result += ':Usage:\n%s\n' % usage
458
 
        else:
459
 
            result += ':Usage:   %s\n' % usage
460
 
        result += '\n'
461
 
 
462
 
        # Add the options
463
 
        #
464
 
        # XXX: optparse implicitly rewraps the help, and not always perfectly,
465
 
        # so we get <https://bugs.launchpad.net/bzr/+bug/249908>.  -- mbp
466
 
        # 20090319
467
 
        options = option.get_optparser(self.options()).format_option_help()
468
 
        # XXX: According to the spec, ReST option lists actually don't support 
469
 
        # options like --1.9 so that causes syntax errors (in Sphinx at least).
470
 
        # As that pattern always appears in the commands that break, we trap
471
 
        # on that and then format that block of 'format' options as a literal
472
 
        # block.
473
 
        if not plain and options.find('  --1.9  ') != -1:
474
 
            options = options.replace(' format:\n', ' format::\n\n', 1)
475
 
        if options.startswith('Options:'):
476
 
            result += ':' + options
477
 
        elif options.startswith('options:'):
478
 
            # Python 2.4 version of optparse
479
 
            result += ':Options:' + options[len('options:'):]
480
 
        else:
481
 
            result += options
482
 
        result += '\n'
483
 
 
484
 
        if verbose:
485
 
            # Add the description, indenting it 2 spaces
486
 
            # to match the indentation of the options
487
 
            if sections.has_key(None):
488
 
                text = sections.pop(None)
489
 
                text = '\n  '.join(text.splitlines())
490
 
                result += ':%s:\n  %s\n\n' % ('Description',text)
491
 
 
492
 
            # Add the custom sections (e.g. Examples). Note that there's no need
493
 
            # to indent these as they must be indented already in the source.
494
 
            if sections:
495
 
                for label in order:
496
 
                    if sections.has_key(label):
497
 
                        result += ':%s:\n%s\n' % (label,sections[label])
498
 
                result += '\n'
499
 
        else:
500
 
            result += ("See bzr help %s for more details and examples.\n\n"
501
 
                % self.name())
502
 
 
503
 
        # Add the aliases, source (plug-in) and see also links, if any
504
 
        if self.aliases:
505
 
            result += ':Aliases:  '
506
 
            result += ', '.join(self.aliases) + '\n'
507
 
        plugin_name = self.plugin_name()
508
 
        if plugin_name is not None:
509
 
            result += ':From:     plugin "%s"\n' % plugin_name
510
 
        see_also = self.get_see_also(additional_see_also)
511
 
        if see_also:
512
 
            if not plain and see_also_as_links:
513
 
                see_also_links = []
514
 
                for item in see_also:
515
 
                    if item == 'topics':
516
 
                        # topics doesn't have an independent section
517
 
                        # so don't create a real link
518
 
                        see_also_links.append(item)
519
 
                    else:
520
 
                        # Use a Sphinx link for this entry
521
 
                        link_text = ":doc:`%s <%s-help>`" % (item, item)
522
 
                        see_also_links.append(link_text)
523
 
                see_also = see_also_links
524
 
            result += ':See also: '
525
 
            result += ', '.join(see_also) + '\n'
526
 
 
527
 
        # If this will be rendered as plain text, convert it
528
 
        if plain:
529
 
            import bzrlib.help_topics
530
 
            result = bzrlib.help_topics.help_as_plain_text(result)
531
 
        return result
532
 
 
533
 
    @staticmethod
534
 
    def _get_help_parts(text):
535
 
        """Split help text into a summary and named sections.
536
 
 
537
 
        :return: (summary,sections,order) where summary is the top line and
538
 
            sections is a dictionary of the rest indexed by section name.
539
 
            order is the order the section appear in the text.
540
 
            A section starts with a heading line of the form ":xxx:".
541
 
            Indented text on following lines is the section value.
542
 
            All text found outside a named section is assigned to the
543
 
            default section which is given the key of None.
544
 
        """
545
 
        def save_section(sections, order, label, section):
546
 
            if len(section) > 0:
547
 
                if sections.has_key(label):
548
 
                    sections[label] += '\n' + section
549
 
                else:
550
 
                    order.append(label)
551
 
                    sections[label] = section
552
 
 
553
 
        lines = text.rstrip().splitlines()
554
 
        summary = lines.pop(0)
555
 
        sections = {}
556
 
        order = []
557
 
        label,section = None,''
558
 
        for line in lines:
559
 
            if line.startswith(':') and line.endswith(':') and len(line) > 2:
560
 
                save_section(sections, order, label, section)
561
 
                label,section = line[1:-1],''
562
 
            elif (label is not None) and len(line) > 1 and not line[0].isspace():
563
 
                save_section(sections, order, label, section)
564
 
                label,section = None,line
565
 
            else:
566
 
                if len(section) > 0:
567
 
                    section += '\n' + line
568
 
                else:
569
 
                    section = line
570
 
        save_section(sections, order, label, section)
571
 
        return summary, sections, order
572
 
 
573
 
    def get_help_topic(self):
574
 
        """Return the commands help topic - its name."""
575
 
        return self.name()
576
 
 
577
 
    def get_see_also(self, additional_terms=None):
578
 
        """Return a list of help topics that are related to this command.
579
 
 
580
 
        The list is derived from the content of the _see_also attribute. Any
581
 
        duplicates are removed and the result is in lexical order.
582
 
        :param additional_terms: Additional help topics to cross-reference.
583
 
        :return: A list of help topics.
584
 
        """
585
 
        see_also = set(getattr(self, '_see_also', []))
586
 
        if additional_terms:
587
 
            see_also.update(additional_terms)
588
 
        return sorted(see_also)
589
 
 
590
 
    def options(self):
591
 
        """Return dict of valid options for this command.
592
 
 
593
 
        Maps from long option name to option object."""
594
 
        r = Option.STD_OPTIONS.copy()
595
 
        std_names = r.keys()
596
 
        for o in self.takes_options:
597
 
            if isinstance(o, basestring):
598
 
                o = option.Option.OPTIONS[o]
599
 
            r[o.name] = o
600
 
            if o.name in std_names:
601
 
                self.supported_std_options.append(o.name)
602
 
        return r
603
 
 
604
 
    def _setup_outf(self):
605
 
        """Return a file linked to stdout, which has proper encoding."""
606
 
        self.outf = ui.ui_factory.make_output_stream(
607
 
            encoding_type=self.encoding_type)
608
 
 
609
 
    def run_argv_aliases(self, argv, alias_argv=None):
610
 
        """Parse the command line and run with extra aliases in alias_argv."""
611
 
        args, opts = parse_args(self, argv, alias_argv)
612
 
 
613
 
        # Process the standard options
614
 
        if 'help' in opts:  # e.g. bzr add --help
615
 
            sys.stdout.write(self.get_help_text())
616
 
            return 0
617
 
        if 'usage' in opts:  # e.g. bzr add --usage
618
 
            sys.stdout.write(self.get_help_text(verbose=False))
619
 
            return 0
620
 
        trace.set_verbosity_level(option._verbosity_level)
621
 
        if 'verbose' in self.supported_std_options:
622
 
            opts['verbose'] = trace.is_verbose()
623
 
        elif opts.has_key('verbose'):
624
 
            del opts['verbose']
625
 
        if 'quiet' in self.supported_std_options:
626
 
            opts['quiet'] = trace.is_quiet()
627
 
        elif opts.has_key('quiet'):
628
 
            del opts['quiet']
629
 
 
630
 
        # mix arguments and options into one dictionary
631
 
        cmdargs = _match_argform(self.name(), self.takes_args, args)
632
 
        cmdopts = {}
633
 
        for k, v in opts.items():
634
 
            cmdopts[k.replace('-', '_')] = v
635
 
 
636
 
        all_cmd_args = cmdargs.copy()
637
 
        all_cmd_args.update(cmdopts)
638
 
 
639
 
        self._setup_outf()
640
 
 
641
 
        return self.run_direct(**all_cmd_args)
642
 
 
643
 
    def run_direct(self, *args, **kwargs):
644
 
        """Call run directly with objects (without parsing an argv list)."""
645
 
        return self._operation.run_simple(*args, **kwargs)
646
 
 
 
92
    
 
93
    def __init__(self, options, arguments):
 
94
        """Construct and run the command.
 
95
 
 
96
        Sets self.status to the return value of run()."""
 
97
        assert isinstance(options, dict)
 
98
        assert isinstance(arguments, dict)
 
99
        cmdargs = options.copy()
 
100
        cmdargs.update(arguments)
 
101
        assert self.__doc__ != Command.__doc__, \
 
102
               ("No help message set for %r" % self)
 
103
        self.status = self.run(**cmdargs)
 
104
 
 
105
    
647
106
    def run(self):
648
 
        """Actually run the command.
 
107
        """Override this in sub-classes.
649
108
 
650
109
        This is invoked with the options and arguments bound to
651
110
        keyword parameters.
652
111
 
653
 
        Return 0 or None if the command was successful, or a non-zero
654
 
        shell error code if not.  It's OK for this method to allow
655
 
        an exception to raise up.
656
 
        """
657
 
        raise NotImplementedError('no implementation of command %r'
658
 
                                  % self.name())
659
 
 
660
 
    def help(self):
661
 
        """Return help message for this class."""
662
 
        from inspect import getdoc
663
 
        if self.__doc__ is Command.__doc__:
664
 
            return None
665
 
        return getdoc(self)
666
 
 
667
 
    def name(self):
668
 
        return _unsquish_command_name(self.__class__.__name__)
669
 
 
670
 
    def plugin_name(self):
671
 
        """Get the name of the plugin that provides this command.
672
 
 
673
 
        :return: The name of the plugin or None if the command is builtin.
674
 
        """
675
 
        mod_parts = self.__module__.split('.')
676
 
        if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
677
 
            return mod_parts[2]
678
 
        else:
679
 
            return None
680
 
 
681
 
 
682
 
class CommandHooks(Hooks):
683
 
    """Hooks related to Command object creation/enumeration."""
684
 
 
685
 
    def __init__(self):
686
 
        """Create the default hooks.
687
 
 
688
 
        These are all empty initially, because by default nothing should get
689
 
        notified.
690
 
        """
691
 
        Hooks.__init__(self)
692
 
        self.create_hook(HookPoint('extend_command',
693
 
            "Called after creating a command object to allow modifications "
694
 
            "such as adding or removing options, docs etc. Called with the "
695
 
            "new bzrlib.commands.Command object.", (1, 13), None))
696
 
        self.create_hook(HookPoint('get_command',
697
 
            "Called when creating a single command. Called with "
698
 
            "(cmd_or_None, command_name). get_command should either return "
699
 
            "the cmd_or_None parameter, or a replacement Command object that "
700
 
            "should be used for the command. Note that the Command.hooks "
701
 
            "hooks are core infrastructure. Many users will prefer to use "
702
 
            "bzrlib.commands.register_command or plugin_cmds.register_lazy.",
703
 
            (1, 17), None))
704
 
        self.create_hook(HookPoint('get_missing_command',
705
 
            "Called when creating a single command if no command could be "
706
 
            "found. Called with (command_name). get_missing_command should "
707
 
            "either return None, or a Command object to be used for the "
708
 
            "command.", (1, 17), None))
709
 
        self.create_hook(HookPoint('list_commands',
710
 
            "Called when enumerating commands. Called with a set of "
711
 
            "cmd_name strings for all the commands found so far. This set "
712
 
            " is safe to mutate - e.g. to remove a command. "
713
 
            "list_commands should return the updated set of command names.",
714
 
            (1, 17), None))
715
 
 
716
 
Command.hooks = CommandHooks()
717
 
 
718
 
 
719
 
def parse_args(command, argv, alias_argv=None):
 
112
        Return 0 or None if the command was successful, or a shell
 
113
        error code if not.
 
114
        """
 
115
        return 0
 
116
 
 
117
 
 
118
class ExternalCommand(Command):
 
119
    """Class to wrap external commands.
 
120
 
 
121
    We cheat a little here, when get_cmd_class() calls us we actually give it back
 
122
    an object we construct that has the appropriate path, help, options etc for the
 
123
    specified command.
 
124
 
 
125
    When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
 
126
    method, which we override to call the Command.__init__ method. That then calls
 
127
    our run method which is pretty straight forward.
 
128
 
 
129
    The only wrinkle is that we have to map bzr's dictionary of options and arguments
 
130
    back into command line options and arguments for the script.
 
131
    """
 
132
 
 
133
    def find_command(cls, cmd):
 
134
        bzrpath = os.environ.get('BZRPATH', '')
 
135
 
 
136
        for dir in bzrpath.split(':'):
 
137
            path = os.path.join(dir, cmd)
 
138
            if os.path.isfile(path):
 
139
                return ExternalCommand(path)
 
140
 
 
141
        return None
 
142
 
 
143
    find_command = classmethod(find_command)
 
144
 
 
145
    def __init__(self, path):
 
146
        self.path = path
 
147
 
 
148
        # TODO: If either of these fail, we should detect that and
 
149
        # assume that path is not really a bzr plugin after all.
 
150
 
 
151
        pipe = os.popen('%s --bzr-usage' % path, 'r')
 
152
        self.takes_options = pipe.readline().split()
 
153
        self.takes_args = pipe.readline().split()
 
154
        pipe.close()
 
155
 
 
156
        pipe = os.popen('%s --bzr-help' % path, 'r')
 
157
        self.__doc__ = pipe.read()
 
158
        pipe.close()
 
159
 
 
160
    def __call__(self, options, arguments):
 
161
        Command.__init__(self, options, arguments)
 
162
        return self
 
163
 
 
164
    def run(self, **kargs):
 
165
        opts = []
 
166
        args = []
 
167
 
 
168
        keys = kargs.keys()
 
169
        keys.sort()
 
170
        for name in keys:
 
171
            value = kargs[name]
 
172
            if OPTIONS.has_key(name):
 
173
                # it's an option
 
174
                opts.append('--%s' % name)
 
175
                if value is not None and value is not True:
 
176
                    opts.append(str(value))
 
177
            else:
 
178
                # it's an arg, or arg list
 
179
                if type(value) is not list:
 
180
                    value = [value]
 
181
                for v in value:
 
182
                    if v is not None:
 
183
                        args.append(str(v))
 
184
 
 
185
        self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
 
186
        return self.status
 
187
 
 
188
 
 
189
class cmd_status(Command):
 
190
    """Display status summary.
 
191
 
 
192
    For each file there is a single line giving its file state and name.
 
193
    The name is that in the current revision unless it is deleted or
 
194
    missing, in which case the old name is shown.
 
195
    """
 
196
    takes_args = ['file*']
 
197
    takes_options = ['all']
 
198
    aliases = ['st', 'stat']
 
199
    
 
200
    def run(self, all=False, file_list=None):
 
201
        b = Branch('.', lock_mode='r')
 
202
        b.show_status(show_all=all, file_list=file_list)
 
203
 
 
204
 
 
205
class cmd_cat_revision(Command):
 
206
    """Write out metadata for a revision."""
 
207
 
 
208
    hidden = True
 
209
    takes_args = ['revision_id']
 
210
    
 
211
    def run(self, revision_id):
 
212
        Branch('.').get_revision(revision_id).write_xml(sys.stdout)
 
213
 
 
214
 
 
215
class cmd_revno(Command):
 
216
    """Show current revision number.
 
217
 
 
218
    This is equal to the number of revisions on this branch."""
 
219
    def run(self):
 
220
        print Branch('.').revno()
 
221
 
 
222
    
 
223
class cmd_add(Command):
 
224
    """Add specified files or directories.
 
225
 
 
226
    In non-recursive mode, all the named items are added, regardless
 
227
    of whether they were previously ignored.  A warning is given if
 
228
    any of the named files are already versioned.
 
229
 
 
230
    In recursive mode (the default), files are treated the same way
 
231
    but the behaviour for directories is different.  Directories that
 
232
    are already versioned do not give a warning.  All directories,
 
233
    whether already versioned or not, are searched for files or
 
234
    subdirectories that are neither versioned or ignored, and these
 
235
    are added.  This search proceeds recursively into versioned
 
236
    directories.
 
237
 
 
238
    Therefore simply saying 'bzr add .' will version all files that
 
239
    are currently unknown.
 
240
 
 
241
    TODO: Perhaps adding a file whose directly is not versioned should
 
242
    recursively add that parent, rather than giving an error?
 
243
    """
 
244
    takes_args = ['file+']
 
245
    takes_options = ['verbose']
 
246
    
 
247
    def run(self, file_list, verbose=False):
 
248
        bzrlib.add.smart_add(file_list, verbose)
 
249
 
 
250
 
 
251
class cmd_relpath(Command):
 
252
    """Show path of a file relative to root"""
 
253
    takes_args = ['filename']
 
254
    
 
255
    def run(self, filename):
 
256
        print Branch(filename).relpath(filename)
 
257
 
 
258
 
 
259
 
 
260
class cmd_inventory(Command):
 
261
    """Show inventory of the current working copy or a revision."""
 
262
    takes_options = ['revision']
 
263
    
 
264
    def run(self, revision=None):
 
265
        b = Branch('.')
 
266
        if revision == None:
 
267
            inv = b.read_working_inventory()
 
268
        else:
 
269
            inv = b.get_revision_inventory(b.lookup_revision(revision))
 
270
 
 
271
        for path, entry in inv.iter_entries():
 
272
            print '%-50s %s' % (entry.file_id, path)
 
273
 
 
274
 
 
275
class cmd_move(Command):
 
276
    """Move files to a different directory.
 
277
 
 
278
    examples:
 
279
        bzr move *.txt doc
 
280
 
 
281
    The destination must be a versioned directory in the same branch.
 
282
    """
 
283
    takes_args = ['source$', 'dest']
 
284
    def run(self, source_list, dest):
 
285
        b = Branch('.')
 
286
 
 
287
        b.move([b.relpath(s) for s in source_list], b.relpath(dest))
 
288
 
 
289
 
 
290
class cmd_rename(Command):
 
291
    """Change the name of an entry.
 
292
 
 
293
    examples:
 
294
      bzr rename frob.c frobber.c
 
295
      bzr rename src/frob.c lib/frob.c
 
296
 
 
297
    It is an error if the destination name exists.
 
298
 
 
299
    See also the 'move' command, which moves files into a different
 
300
    directory without changing their name.
 
301
 
 
302
    TODO: Some way to rename multiple files without invoking bzr for each
 
303
    one?"""
 
304
    takes_args = ['from_name', 'to_name']
 
305
    
 
306
    def run(self, from_name, to_name):
 
307
        b = Branch('.')
 
308
        b.rename_one(b.relpath(from_name), b.relpath(to_name))
 
309
 
 
310
 
 
311
 
 
312
class cmd_renames(Command):
 
313
    """Show list of renamed files.
 
314
 
 
315
    TODO: Option to show renames between two historical versions.
 
316
 
 
317
    TODO: Only show renames under dir, rather than in the whole branch.
 
318
    """
 
319
    takes_args = ['dir?']
 
320
 
 
321
    def run(self, dir='.'):
 
322
        b = Branch(dir)
 
323
        old_inv = b.basis_tree().inventory
 
324
        new_inv = b.read_working_inventory()
 
325
 
 
326
        renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
 
327
        renames.sort()
 
328
        for old_name, new_name in renames:
 
329
            print "%s => %s" % (old_name, new_name)        
 
330
 
 
331
 
 
332
class cmd_info(Command):
 
333
    """Show statistical information for this branch"""
 
334
    def run(self):
 
335
        import info
 
336
        info.show_info(Branch('.'))        
 
337
 
 
338
 
 
339
class cmd_remove(Command):
 
340
    """Make a file unversioned.
 
341
 
 
342
    This makes bzr stop tracking changes to a versioned file.  It does
 
343
    not delete the working copy.
 
344
    """
 
345
    takes_args = ['file+']
 
346
    takes_options = ['verbose']
 
347
    
 
348
    def run(self, file_list, verbose=False):
 
349
        b = Branch(file_list[0])
 
350
        b.remove([b.relpath(f) for f in file_list], verbose=verbose)
 
351
 
 
352
 
 
353
class cmd_file_id(Command):
 
354
    """Print file_id of a particular file or directory.
 
355
 
 
356
    The file_id is assigned when the file is first added and remains the
 
357
    same through all revisions where the file exists, even when it is
 
358
    moved or renamed.
 
359
    """
 
360
    hidden = True
 
361
    takes_args = ['filename']
 
362
    def run(self, filename):
 
363
        b = Branch(filename)
 
364
        i = b.inventory.path2id(b.relpath(filename))
 
365
        if i == None:
 
366
            bailout("%r is not a versioned file" % filename)
 
367
        else:
 
368
            print i
 
369
 
 
370
 
 
371
class cmd_file_path(Command):
 
372
    """Print path of file_ids to a file or directory.
 
373
 
 
374
    This prints one line for each directory down to the target,
 
375
    starting at the branch root."""
 
376
    hidden = True
 
377
    takes_args = ['filename']
 
378
    def run(self, filename):
 
379
        b = Branch(filename)
 
380
        inv = b.inventory
 
381
        fid = inv.path2id(b.relpath(filename))
 
382
        if fid == None:
 
383
            bailout("%r is not a versioned file" % filename)
 
384
        for fip in inv.get_idpath(fid):
 
385
            print fip
 
386
 
 
387
 
 
388
class cmd_revision_history(Command):
 
389
    """Display list of revision ids on this branch."""
 
390
    def run(self):
 
391
        for patchid in Branch('.').revision_history():
 
392
            print patchid
 
393
 
 
394
 
 
395
class cmd_directories(Command):
 
396
    """Display list of versioned directories in this branch."""
 
397
    def run(self):
 
398
        for name, ie in Branch('.').read_working_inventory().directories():
 
399
            if name == '':
 
400
                print '.'
 
401
            else:
 
402
                print name
 
403
 
 
404
 
 
405
class cmd_init(Command):
 
406
    """Make a directory into a versioned branch.
 
407
 
 
408
    Use this to create an empty branch, or before importing an
 
409
    existing project.
 
410
 
 
411
    Recipe for importing a tree of files:
 
412
        cd ~/project
 
413
        bzr init
 
414
        bzr add -v .
 
415
        bzr status
 
416
        bzr commit -m 'imported project'
 
417
    """
 
418
    def run(self):
 
419
        Branch('.', init=True)
 
420
 
 
421
 
 
422
class cmd_diff(Command):
 
423
    """Show differences in working tree.
 
424
    
 
425
    If files are listed, only the changes in those files are listed.
 
426
    Otherwise, all changes for the tree are listed.
 
427
 
 
428
    TODO: Given two revision arguments, show the difference between them.
 
429
 
 
430
    TODO: Allow diff across branches.
 
431
 
 
432
    TODO: Option to use external diff command; could be GNU diff, wdiff,
 
433
          or a graphical diff.
 
434
 
 
435
    TODO: Python difflib is not exactly the same as unidiff; should
 
436
          either fix it up or prefer to use an external diff.
 
437
 
 
438
    TODO: If a directory is given, diff everything under that.
 
439
 
 
440
    TODO: Selected-file diff is inefficient and doesn't show you
 
441
          deleted files.
 
442
 
 
443
    TODO: This probably handles non-Unix newlines poorly.
 
444
    """
 
445
    
 
446
    takes_args = ['file*']
 
447
    takes_options = ['revision']
 
448
    aliases = ['di']
 
449
 
 
450
    def run(self, revision=None, file_list=None):
 
451
        from bzrlib.diff import show_diff
 
452
    
 
453
        show_diff(Branch('.'), revision, file_list)
 
454
 
 
455
 
 
456
        
 
457
 
 
458
 
 
459
class cmd_deleted(Command):
 
460
    """List files deleted in the working tree.
 
461
 
 
462
    TODO: Show files deleted since a previous revision, or between two revisions.
 
463
    """
 
464
    def run(self, show_ids=False):
 
465
        b = Branch('.')
 
466
        old = b.basis_tree()
 
467
        new = b.working_tree()
 
468
 
 
469
        ## TODO: Much more efficient way to do this: read in new
 
470
        ## directories with readdir, rather than stating each one.  Same
 
471
        ## level of effort but possibly much less IO.  (Or possibly not,
 
472
        ## if the directories are very large...)
 
473
 
 
474
        for path, ie in old.inventory.iter_entries():
 
475
            if not new.has_id(ie.file_id):
 
476
                if show_ids:
 
477
                    print '%-50s %s' % (path, ie.file_id)
 
478
                else:
 
479
                    print path
 
480
 
 
481
 
 
482
class cmd_modified(Command):
 
483
    """List files modified in working tree."""
 
484
    hidden = True
 
485
    def run(self):
 
486
        import statcache
 
487
        b = Branch('.')
 
488
        inv = b.read_working_inventory()
 
489
        sc = statcache.update_cache(b, inv)
 
490
        basis = b.basis_tree()
 
491
        basis_inv = basis.inventory
 
492
        
 
493
        # We used to do this through iter_entries(), but that's slow
 
494
        # when most of the files are unmodified, as is usually the
 
495
        # case.  So instead we iterate by inventory entry, and only
 
496
        # calculate paths as necessary.
 
497
 
 
498
        for file_id in basis_inv:
 
499
            cacheentry = sc.get(file_id)
 
500
            if not cacheentry:                 # deleted
 
501
                continue
 
502
            ie = basis_inv[file_id]
 
503
            if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
 
504
                path = inv.id2path(file_id)
 
505
                print path
 
506
 
 
507
 
 
508
 
 
509
class cmd_added(Command):
 
510
    """List files added in working tree."""
 
511
    hidden = True
 
512
    def run(self):
 
513
        b = Branch('.')
 
514
        wt = b.working_tree()
 
515
        basis_inv = b.basis_tree().inventory
 
516
        inv = wt.inventory
 
517
        for file_id in inv:
 
518
            if file_id in basis_inv:
 
519
                continue
 
520
            path = inv.id2path(file_id)
 
521
            if not os.access(b.abspath(path), os.F_OK):
 
522
                continue
 
523
            print path
 
524
                
 
525
        
 
526
 
 
527
class cmd_root(Command):
 
528
    """Show the tree root directory.
 
529
 
 
530
    The root is the nearest enclosing directory with a .bzr control
 
531
    directory."""
 
532
    takes_args = ['filename?']
 
533
    def run(self, filename=None):
 
534
        """Print the branch root."""
 
535
        from branch import find_branch
 
536
        b = find_branch(filename)
 
537
        print getattr(b, 'base', None) or getattr(b, 'baseurl')
 
538
 
 
539
 
 
540
class cmd_log(Command):
 
541
    """Show log of this branch.
 
542
 
 
543
    TODO: Option to limit range.
 
544
 
 
545
    TODO: Perhaps show most-recent first with an option for last.
 
546
    """
 
547
    takes_args = ['filename?']
 
548
    takes_options = ['timezone', 'verbose', 'show-ids']
 
549
    def run(self, filename=None, timezone='original', verbose=False, show_ids=False):
 
550
        from branch import find_branch
 
551
        b = find_branch((filename or '.'), lock_mode='r')
 
552
        if filename:
 
553
            filename = b.relpath(filename)
 
554
        bzrlib.show_log(b, filename,
 
555
                        show_timezone=timezone,
 
556
                        verbose=verbose,
 
557
                        show_ids=show_ids)
 
558
 
 
559
 
 
560
 
 
561
class cmd_touching_revisions(Command):
 
562
    """Return revision-ids which affected a particular file."""
 
563
    hidden = True
 
564
    takes_args = ["filename"]
 
565
    def run(self, filename):
 
566
        b = Branch(filename, lock_mode='r')
 
567
        inv = b.read_working_inventory()
 
568
        file_id = inv.path2id(b.relpath(filename))
 
569
        for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
 
570
            print "%6d %s" % (revno, what)
 
571
 
 
572
 
 
573
class cmd_ls(Command):
 
574
    """List files in a tree.
 
575
 
 
576
    TODO: Take a revision or remote path and list that tree instead.
 
577
    """
 
578
    hidden = True
 
579
    def run(self, revision=None, verbose=False):
 
580
        b = Branch('.')
 
581
        if revision == None:
 
582
            tree = b.working_tree()
 
583
        else:
 
584
            tree = b.revision_tree(b.lookup_revision(revision))
 
585
 
 
586
        for fp, fc, kind, fid in tree.list_files():
 
587
            if verbose:
 
588
                if kind == 'directory':
 
589
                    kindch = '/'
 
590
                elif kind == 'file':
 
591
                    kindch = ''
 
592
                else:
 
593
                    kindch = '???'
 
594
 
 
595
                print '%-8s %s%s' % (fc, fp, kindch)
 
596
            else:
 
597
                print fp
 
598
 
 
599
 
 
600
 
 
601
class cmd_unknowns(Command):
 
602
    """List unknown files"""
 
603
    def run(self):
 
604
        for f in Branch('.').unknowns():
 
605
            print quotefn(f)
 
606
 
 
607
 
 
608
 
 
609
class cmd_ignore(Command):
 
610
    """Ignore a command or pattern
 
611
 
 
612
    To remove patterns from the ignore list, edit the .bzrignore file.
 
613
 
 
614
    If the pattern contains a slash, it is compared to the whole path
 
615
    from the branch root.  Otherwise, it is comapred to only the last
 
616
    component of the path.
 
617
 
 
618
    Ignore patterns are case-insensitive on case-insensitive systems.
 
619
 
 
620
    Note: wildcards must be quoted from the shell on Unix.
 
621
 
 
622
    examples:
 
623
        bzr ignore ./Makefile
 
624
        bzr ignore '*.class'
 
625
    """
 
626
    takes_args = ['name_pattern']
 
627
    
 
628
    def run(self, name_pattern):
 
629
        from bzrlib.atomicfile import AtomicFile
 
630
        import codecs
 
631
 
 
632
        b = Branch('.')
 
633
        ifn = b.abspath('.bzrignore')
 
634
 
 
635
        # FIXME: probably doesn't handle non-ascii patterns
 
636
 
 
637
        if os.path.exists(ifn):
 
638
            f = b.controlfile(ifn, 'rt')
 
639
            igns = f.read()
 
640
            f.close()
 
641
        else:
 
642
            igns = ''
 
643
 
 
644
        if igns and igns[-1] != '\n':
 
645
            igns += '\n'
 
646
        igns += name_pattern + '\n'
 
647
 
 
648
        f = AtomicFile(ifn, 'wt')
 
649
        f.write(igns)
 
650
        f.commit()
 
651
 
 
652
        inv = b.working_tree().inventory
 
653
        if inv.path2id('.bzrignore'):
 
654
            mutter('.bzrignore is already versioned')
 
655
        else:
 
656
            mutter('need to make new .bzrignore file versioned')
 
657
            b.add(['.bzrignore'])
 
658
 
 
659
 
 
660
 
 
661
class cmd_ignored(Command):
 
662
    """List ignored files and the patterns that matched them.
 
663
 
 
664
    See also: bzr ignore"""
 
665
    def run(self):
 
666
        tree = Branch('.').working_tree()
 
667
        for path, file_class, kind, file_id in tree.list_files():
 
668
            if file_class != 'I':
 
669
                continue
 
670
            ## XXX: Slightly inefficient since this was already calculated
 
671
            pat = tree.is_ignored(path)
 
672
            print '%-50s %s' % (path, pat)
 
673
 
 
674
 
 
675
class cmd_lookup_revision(Command):
 
676
    """Lookup the revision-id from a revision-number
 
677
 
 
678
    example:
 
679
        bzr lookup-revision 33
 
680
    """
 
681
    hidden = True
 
682
    takes_args = ['revno']
 
683
    
 
684
    def run(self, revno):
 
685
        try:
 
686
            revno = int(revno)
 
687
        except ValueError:
 
688
            raise BzrCommandError("not a valid revision-number: %r" % revno)
 
689
 
 
690
        print Branch('.').lookup_revision(revno)
 
691
 
 
692
 
 
693
class cmd_export(Command):
 
694
    """Export past revision to destination directory.
 
695
 
 
696
    If no revision is specified this exports the last committed revision."""
 
697
    takes_args = ['dest']
 
698
    takes_options = ['revision']
 
699
    def run(self, dest, revision=None):
 
700
        b = Branch('.')
 
701
        if revision == None:
 
702
            rh = b.revision_history()[-1]
 
703
        else:
 
704
            rh = b.lookup_revision(int(revision))
 
705
        t = b.revision_tree(rh)
 
706
        t.export(dest)
 
707
 
 
708
 
 
709
class cmd_cat(Command):
 
710
    """Write a file's text from a previous revision."""
 
711
 
 
712
    takes_options = ['revision']
 
713
    takes_args = ['filename']
 
714
 
 
715
    def run(self, filename, revision=None):
 
716
        if revision == None:
 
717
            raise BzrCommandError("bzr cat requires a revision number")
 
718
        b = Branch('.')
 
719
        b.print_file(b.relpath(filename), int(revision))
 
720
 
 
721
 
 
722
class cmd_local_time_offset(Command):
 
723
    """Show the offset in seconds from GMT to local time."""
 
724
    hidden = True    
 
725
    def run(self):
 
726
        print bzrlib.osutils.local_time_offset()
 
727
 
 
728
 
 
729
 
 
730
class cmd_commit(Command):
 
731
    """Commit changes into a new revision.
 
732
 
 
733
    TODO: Commit only selected files.
 
734
 
 
735
    TODO: Run hooks on tree to-be-committed, and after commit.
 
736
 
 
737
    TODO: Strict commit that fails if there are unknown or deleted files.
 
738
    """
 
739
    takes_options = ['message', 'file', 'verbose']
 
740
    aliases = ['ci', 'checkin']
 
741
 
 
742
    def run(self, message=None, file=None, verbose=False):
 
743
        ## Warning: shadows builtin file()
 
744
        if not message and not file:
 
745
            raise BzrCommandError("please specify a commit message",
 
746
                                  ["use either --message or --file"])
 
747
        elif message and file:
 
748
            raise BzrCommandError("please specify either --message or --file")
 
749
        
 
750
        if file:
 
751
            import codecs
 
752
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
 
753
 
 
754
        Branch('.').commit(message, verbose=verbose)
 
755
 
 
756
 
 
757
class cmd_check(Command):
 
758
    """Validate consistency of branch history.
 
759
 
 
760
    This command checks various invariants about the branch storage to
 
761
    detect data corruption or bzr bugs.
 
762
    """
 
763
    takes_args = ['dir?']
 
764
    def run(self, dir='.'):
 
765
        import bzrlib.check
 
766
        bzrlib.check.check(Branch(dir, find_root=False))
 
767
 
 
768
 
 
769
 
 
770
class cmd_whoami(Command):
 
771
    """Show bzr user id."""
 
772
    takes_options = ['email']
 
773
    
 
774
    def run(self, email=False):
 
775
        if email:
 
776
            print bzrlib.osutils.user_email()
 
777
        else:
 
778
            print bzrlib.osutils.username()
 
779
 
 
780
 
 
781
class cmd_selftest(Command):
 
782
    """Run internal test suite"""
 
783
    hidden = True
 
784
    def run(self):
 
785
        failures, tests = 0, 0
 
786
 
 
787
        import doctest, bzrlib.store, bzrlib.tests
 
788
        bzrlib.trace.verbose = False
 
789
 
 
790
        for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
 
791
            bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
 
792
            mf, mt = doctest.testmod(m)
 
793
            failures += mf
 
794
            tests += mt
 
795
            print '%-40s %3d tests' % (m.__name__, mt),
 
796
            if mf:
 
797
                print '%3d FAILED!' % mf
 
798
            else:
 
799
                print
 
800
 
 
801
        print '%-40s %3d tests' % ('total', tests),
 
802
        if failures:
 
803
            print '%3d FAILED!' % failures
 
804
        else:
 
805
            print
 
806
 
 
807
 
 
808
 
 
809
class cmd_version(Command):
 
810
    """Show version of bzr"""
 
811
    def run(self):
 
812
        show_version()
 
813
 
 
814
def show_version():
 
815
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
 
816
    print bzrlib.__copyright__
 
817
    print "http://bazaar-ng.org/"
 
818
    print
 
819
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
 
820
    print "you may use, modify and redistribute it under the terms of the GNU"
 
821
    print "General Public License version 2 or later."
 
822
 
 
823
 
 
824
class cmd_rocks(Command):
 
825
    """Statement of optimism."""
 
826
    hidden = True
 
827
    def run(self):
 
828
        print "it sure does!"
 
829
 
 
830
 
 
831
class cmd_assert_fail(Command):
 
832
    """Test reporting of assertion failures"""
 
833
    hidden = True
 
834
    def run(self):
 
835
        assert False, "always fails"
 
836
 
 
837
 
 
838
class cmd_help(Command):
 
839
    """Show help on a command or other topic.
 
840
 
 
841
    For a list of all available commands, say 'bzr help commands'."""
 
842
    takes_args = ['topic?']
 
843
    aliases = ['?']
 
844
    
 
845
    def run(self, topic=None):
 
846
        import help
 
847
        help.help(topic)
 
848
 
 
849
 
 
850
class cmd_update_stat_cache(Command):
 
851
    """Update stat-cache mapping inodes to SHA-1 hashes.
 
852
 
 
853
    For testing only."""
 
854
    hidden = True
 
855
    def run(self):
 
856
        import statcache
 
857
        b = Branch('.')
 
858
        statcache.update_cache(b)
 
859
 
 
860
 
 
861
######################################################################
 
862
# main routine
 
863
 
 
864
 
 
865
# list of all available options; the rhs can be either None for an
 
866
# option that takes no argument, or a constructor function that checks
 
867
# the type.
 
868
OPTIONS = {
 
869
    'all':                    None,
 
870
    'help':                   None,
 
871
    'file':                   unicode,
 
872
    'message':                unicode,
 
873
    'profile':                None,
 
874
    'revision':               int,
 
875
    'show-ids':               None,
 
876
    'timezone':               str,
 
877
    'verbose':                None,
 
878
    'version':                None,
 
879
    'email':                  None,
 
880
    }
 
881
 
 
882
SHORT_OPTIONS = {
 
883
    'm':                      'message',
 
884
    'F':                      'file', 
 
885
    'r':                      'revision',
 
886
    'v':                      'verbose',
 
887
}
 
888
 
 
889
 
 
890
def parse_args(argv):
720
891
    """Parse command line.
721
 
 
 
892
    
722
893
    Arguments and options are parsed at this level before being passed
723
894
    down to specific command handlers.  This routine knows, from a
724
895
    lookup table, something about the available options, what optargs
725
896
    they take, and which commands will accept them.
 
897
 
 
898
    >>> parse_args('--help'.split())
 
899
    ([], {'help': True})
 
900
    >>> parse_args('--version'.split())
 
901
    ([], {'version': True})
 
902
    >>> parse_args('status --all'.split())
 
903
    (['status'], {'all': True})
 
904
    >>> parse_args('commit --message=biter'.split())
 
905
    (['commit'], {'message': u'biter'})
726
906
    """
727
 
    # TODO: make it a method of the Command?
728
 
    parser = option.get_optparser(command.options())
729
 
    if alias_argv is not None:
730
 
        args = alias_argv + argv
731
 
    else:
732
 
        args = argv
733
 
 
734
 
    options, args = parser.parse_args(args)
735
 
    opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
736
 
                 v is not option.OptionParser.DEFAULT_VALUE])
 
907
    args = []
 
908
    opts = {}
 
909
 
 
910
    # TODO: Maybe handle '--' to end options?
 
911
 
 
912
    while argv:
 
913
        a = argv.pop(0)
 
914
        if a[0] == '-':
 
915
            # option names must not be unicode
 
916
            a = str(a)
 
917
            optarg = None
 
918
            if a[1] == '-':
 
919
                mutter("  got option %r" % a)
 
920
                if '=' in a:
 
921
                    optname, optarg = a[2:].split('=', 1)
 
922
                else:
 
923
                    optname = a[2:]
 
924
                if optname not in OPTIONS:
 
925
                    bailout('unknown long option %r' % a)
 
926
            else:
 
927
                shortopt = a[1:]
 
928
                if shortopt not in SHORT_OPTIONS:
 
929
                    bailout('unknown short option %r' % a)
 
930
                optname = SHORT_OPTIONS[shortopt]
 
931
            
 
932
            if optname in opts:
 
933
                # XXX: Do we ever want to support this, e.g. for -r?
 
934
                bailout('repeated option %r' % a)
 
935
                
 
936
            optargfn = OPTIONS[optname]
 
937
            if optargfn:
 
938
                if optarg == None:
 
939
                    if not argv:
 
940
                        bailout('option %r needs an argument' % a)
 
941
                    else:
 
942
                        optarg = argv.pop(0)
 
943
                opts[optname] = optargfn(optarg)
 
944
            else:
 
945
                if optarg != None:
 
946
                    bailout('option %r takes no argument' % optname)
 
947
                opts[optname] = True
 
948
        else:
 
949
            args.append(a)
 
950
 
737
951
    return args, opts
738
952
 
739
953
 
 
954
 
 
955
 
740
956
def _match_argform(cmd, takes_args, args):
741
957
    argdict = {}
742
958
 
754
970
                argdict[argname + '_list'] = None
755
971
        elif ap[-1] == '+':
756
972
            if not args:
757
 
                raise errors.BzrCommandError("command %r needs one or more %s"
758
 
                                             % (cmd, argname.upper()))
 
973
                raise BzrCommandError("command %r needs one or more %s"
 
974
                        % (cmd, argname.upper()))
759
975
            else:
760
976
                argdict[argname + '_list'] = args[:]
761
977
                args = []
762
978
        elif ap[-1] == '$': # all but one
763
979
            if len(args) < 2:
764
 
                raise errors.BzrCommandError("command %r needs one or more %s"
765
 
                                             % (cmd, argname.upper()))
 
980
                raise BzrCommandError("command %r needs one or more %s"
 
981
                        % (cmd, argname.upper()))
766
982
            argdict[argname + '_list'] = args[:-1]
767
 
            args[:-1] = []
 
983
            args[:-1] = []                
768
984
        else:
769
985
            # just a plain arg
770
986
            argname = ap
771
987
            if not args:
772
 
                raise errors.BzrCommandError("command %r requires argument %s"
773
 
                               % (cmd, argname.upper()))
 
988
                raise BzrCommandError("command %r requires argument %s"
 
989
                        % (cmd, argname.upper()))
774
990
            else:
775
991
                argdict[argname] = args.pop(0)
776
 
 
 
992
            
777
993
    if args:
778
 
        raise errors.BzrCommandError("extra argument to command %s: %s"
779
 
                                     % (cmd, args[0]))
 
994
        raise BzrCommandError("extra argument to command %s: %s"
 
995
                              % (cmd, args[0]))
780
996
 
781
997
    return argdict
782
998
 
783
 
def apply_coveraged(dirname, the_callable, *args, **kwargs):
784
 
    # Cannot use "import trace", as that would import bzrlib.trace instead of
785
 
    # the standard library's trace.
786
 
    trace = __import__('trace')
787
 
 
788
 
    tracer = trace.Trace(count=1, trace=0)
789
 
    sys.settrace(tracer.globaltrace)
790
 
    threading.settrace(tracer.globaltrace)
791
 
 
792
 
    try:
793
 
        return exception_to_return_code(the_callable, *args, **kwargs)
794
 
    finally:
795
 
        sys.settrace(None)
796
 
        results = tracer.results()
797
 
        results.write_results(show_missing=1, summary=False,
798
 
                              coverdir=dirname)
799
 
 
800
 
 
801
 
def apply_profiled(the_callable, *args, **kwargs):
802
 
    import hotshot
803
 
    import tempfile
804
 
    import hotshot.stats
805
 
    pffileno, pfname = tempfile.mkstemp()
806
 
    try:
807
 
        prof = hotshot.Profile(pfname)
 
999
 
 
1000
 
 
1001
def run_bzr(argv):
 
1002
    """Execute a command.
 
1003
 
 
1004
    This is similar to main(), but without all the trappings for
 
1005
    logging and error handling.  
 
1006
    """
 
1007
    argv = [a.decode(bzrlib.user_encoding) for a in argv]
 
1008
    
 
1009
    try:
 
1010
        args, opts = parse_args(argv[1:])
 
1011
        if 'help' in opts:
 
1012
            import help
 
1013
            if args:
 
1014
                help.help(args[0])
 
1015
            else:
 
1016
                help.help()
 
1017
            return 0
 
1018
        elif 'version' in opts:
 
1019
            show_version()
 
1020
            return 0
 
1021
        cmd = str(args.pop(0))
 
1022
    except IndexError:
 
1023
        log_error('usage: bzr COMMAND')
 
1024
        log_error('  try "bzr help"')
 
1025
        return 1
 
1026
 
 
1027
    canonical_cmd, cmd_class = get_cmd_class(cmd)
 
1028
 
 
1029
    # global option
 
1030
    if 'profile' in opts:
 
1031
        profile = True
 
1032
        del opts['profile']
 
1033
    else:
 
1034
        profile = False
 
1035
 
 
1036
    # check options are reasonable
 
1037
    allowed = cmd_class.takes_options
 
1038
    for oname in opts:
 
1039
        if oname not in allowed:
 
1040
            raise BzrCommandError("option '--%s' is not allowed for command %r"
 
1041
                                  % (oname, cmd))
 
1042
 
 
1043
    # mix arguments and options into one dictionary
 
1044
    cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
 
1045
    cmdopts = {}
 
1046
    for k, v in opts.items():
 
1047
        cmdopts[k.replace('-', '_')] = v
 
1048
 
 
1049
    if profile:
 
1050
        import hotshot, tempfile
 
1051
        pffileno, pfname = tempfile.mkstemp()
808
1052
        try:
809
 
            ret = prof.runcall(exception_to_return_code, the_callable, *args,
810
 
                **kwargs) or 0
 
1053
            prof = hotshot.Profile(pfname)
 
1054
            ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
 
1055
            prof.close()
 
1056
 
 
1057
            import hotshot.stats
 
1058
            stats = hotshot.stats.load(pfname)
 
1059
            #stats.strip_dirs()
 
1060
            stats.sort_stats('time')
 
1061
            ## XXX: Might like to write to stderr or the trace file instead but
 
1062
            ## print_stats seems hardcoded to stdout
 
1063
            stats.print_stats(20)
 
1064
            
 
1065
            return ret.status
 
1066
 
811
1067
        finally:
812
 
            prof.close()
813
 
        stats = hotshot.stats.load(pfname)
814
 
        stats.strip_dirs()
815
 
        stats.sort_stats('cum')   # 'time'
816
 
        ## XXX: Might like to write to stderr or the trace file instead but
817
 
        ## print_stats seems hardcoded to stdout
818
 
        stats.print_stats(20)
819
 
        return ret
820
 
    finally:
821
 
        os.close(pffileno)
822
 
        os.remove(pfname)
823
 
 
824
 
 
825
 
def exception_to_return_code(the_callable, *args, **kwargs):
826
 
    """UI level helper for profiling and coverage.
827
 
 
828
 
    This transforms exceptions into a return value of 3. As such its only
829
 
    relevant to the UI layer, and should never be called where catching
830
 
    exceptions may be desirable.
831
 
    """
 
1068
            os.close(pffileno)
 
1069
            os.remove(pfname)
 
1070
    else:
 
1071
        cmdobj = cmd_class(cmdopts, cmdargs).status 
 
1072
 
 
1073
 
 
1074
def _report_exception(summary, quiet=False):
 
1075
    import traceback
 
1076
    log_error('bzr: ' + summary)
 
1077
    bzrlib.trace.log_exception()
 
1078
 
 
1079
    if not quiet:
 
1080
        tb = sys.exc_info()[2]
 
1081
        exinfo = traceback.extract_tb(tb)
 
1082
        if exinfo:
 
1083
            sys.stderr.write('  at %s:%d in %s()\n' % exinfo[-1][:3])
 
1084
        sys.stderr.write('  see ~/.bzr.log for debug information\n')
 
1085
 
 
1086
 
 
1087
 
 
1088
def main(argv):
 
1089
    import errno
 
1090
    
 
1091
    bzrlib.open_tracefile(argv)
 
1092
 
832
1093
    try:
833
 
        return the_callable(*args, **kwargs)
834
 
    except (KeyboardInterrupt, Exception), e:
835
 
        # used to handle AssertionError and KeyboardInterrupt
836
 
        # specially here, but hopefully they're handled ok by the logger now
837
 
        exc_info = sys.exc_info()
838
 
        exitcode = trace.report_exception(exc_info, sys.stderr)
839
 
        if os.environ.get('BZR_PDB'):
840
 
            print '**** entering debugger'
841
 
            tb = exc_info[2]
842
 
            import pdb
843
 
            if sys.version_info[:2] < (2, 6):
844
 
                # XXX: we want to do
845
 
                #    pdb.post_mortem(tb)
846
 
                # but because pdb.post_mortem gives bad results for tracebacks
847
 
                # from inside generators, we do it manually.
848
 
                # (http://bugs.python.org/issue4150, fixed in Python 2.6)
849
 
 
850
 
                # Setup pdb on the traceback
851
 
                p = pdb.Pdb()
852
 
                p.reset()
853
 
                p.setup(tb.tb_frame, tb)
854
 
                # Point the debugger at the deepest frame of the stack
855
 
                p.curindex = len(p.stack) - 1
856
 
                p.curframe = p.stack[p.curindex][0]
857
 
                # Start the pdb prompt.
858
 
                p.print_stack_entry(p.stack[p.curindex])
859
 
                p.execRcLines()
860
 
                p.cmdloop()
 
1094
        try:
 
1095
            try:
 
1096
                return run_bzr(argv)
 
1097
            finally:
 
1098
                # do this here inside the exception wrappers to catch EPIPE
 
1099
                sys.stdout.flush()
 
1100
        except BzrError, e:
 
1101
            quiet = isinstance(e, (BzrCommandError))
 
1102
            _report_exception('error: ' + e.args[0], quiet=quiet)
 
1103
            if len(e.args) > 1:
 
1104
                for h in e.args[1]:
 
1105
                    # some explanation or hints
 
1106
                    log_error('  ' + h)
 
1107
            return 1
 
1108
        except AssertionError, e:
 
1109
            msg = 'assertion failed'
 
1110
            if str(e):
 
1111
                msg += ': ' + str(e)
 
1112
            _report_exception(msg)
 
1113
            return 2
 
1114
        except KeyboardInterrupt, e:
 
1115
            _report_exception('interrupted', quiet=True)
 
1116
            return 2
 
1117
        except Exception, e:
 
1118
            quiet = False
 
1119
            if (isinstance(e, IOError) 
 
1120
                and hasattr(e, 'errno')
 
1121
                and e.errno == errno.EPIPE):
 
1122
                quiet = True
 
1123
                msg = 'broken pipe'
861
1124
            else:
862
 
                pdb.post_mortem(tb)
863
 
        return exitcode
864
 
 
865
 
 
866
 
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
867
 
    from bzrlib.lsprof import profile
868
 
    ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
869
 
    stats.sort()
870
 
    if filename is None:
871
 
        stats.pprint()
872
 
    else:
873
 
        stats.save(filename)
874
 
        trace.note('Profile data written to "%s".', filename)
875
 
    return ret
876
 
 
877
 
 
878
 
def get_alias(cmd, config=None):
879
 
    """Return an expanded alias, or None if no alias exists.
880
 
 
881
 
    cmd
882
 
        Command to be checked for an alias.
883
 
    config
884
 
        Used to specify an alternative config to use,
885
 
        which is especially useful for testing.
886
 
        If it is unspecified, the global config will be used.
887
 
    """
888
 
    if config is None:
889
 
        import bzrlib.config
890
 
        config = bzrlib.config.GlobalConfig()
891
 
    alias = config.get_alias(cmd)
892
 
    if (alias):
893
 
        return cmdline.split(alias)
894
 
    return None
895
 
 
896
 
 
897
 
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
898
 
    """Execute a command.
899
 
 
900
 
    :param argv: The command-line arguments, without the program name from
901
 
        argv[0] These should already be decoded. All library/test code calling
902
 
        run_bzr should be passing valid strings (don't need decoding).
903
 
    :param load_plugins: What function to call when triggering plugin loading.
904
 
        This function should take no arguments and cause all plugins to be
905
 
        loaded.
906
 
    :param disable_plugins: What function to call when disabling plugin
907
 
        loading. This function should take no arguments and cause all plugin
908
 
        loading to be prohibited (so that code paths in your application that
909
 
        know about some plugins possibly being present will fail to import
910
 
        those plugins even if they are installed.)
911
 
    :return: Returns a command exit code or raises an exception.
912
 
 
913
 
    Special master options: these must come before the command because
914
 
    they control how the command is interpreted.
915
 
 
916
 
    --no-plugins
917
 
        Do not load plugin modules at all
918
 
 
919
 
    --no-aliases
920
 
        Do not allow aliases
921
 
 
922
 
    --builtin
923
 
        Only use builtin commands.  (Plugins are still allowed to change
924
 
        other behaviour.)
925
 
 
926
 
    --profile
927
 
        Run under the Python hotshot profiler.
928
 
 
929
 
    --lsprof
930
 
        Run under the Python lsprof profiler.
931
 
 
932
 
    --coverage
933
 
        Generate line coverage report in the specified directory.
934
 
 
935
 
    --concurrency
936
 
        Specify the number of processes that can be run concurrently (selftest).
937
 
    """
938
 
    trace.mutter("bazaar version: " + bzrlib.__version__)
939
 
    argv = list(argv)
940
 
    trace.mutter("bzr arguments: %r", argv)
941
 
 
942
 
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin =  \
943
 
                opt_no_aliases = False
944
 
    opt_lsprof_file = opt_coverage_dir = None
945
 
 
946
 
    # --no-plugins is handled specially at a very early stage. We need
947
 
    # to load plugins before doing other command parsing so that they
948
 
    # can override commands, but this needs to happen first.
949
 
 
950
 
    argv_copy = []
951
 
    i = 0
952
 
    while i < len(argv):
953
 
        a = argv[i]
954
 
        if a == '--profile':
955
 
            opt_profile = True
956
 
        elif a == '--lsprof':
957
 
            opt_lsprof = True
958
 
        elif a == '--lsprof-file':
959
 
            opt_lsprof = True
960
 
            opt_lsprof_file = argv[i + 1]
961
 
            i += 1
962
 
        elif a == '--no-plugins':
963
 
            opt_no_plugins = True
964
 
        elif a == '--no-aliases':
965
 
            opt_no_aliases = True
966
 
        elif a == '--builtin':
967
 
            opt_builtin = True
968
 
        elif a == '--concurrency':
969
 
            os.environ['BZR_CONCURRENCY'] = argv[i + 1]
970
 
            i += 1
971
 
        elif a == '--coverage':
972
 
            opt_coverage_dir = argv[i + 1]
973
 
            i += 1
974
 
        elif a.startswith('-D'):
975
 
            debug.debug_flags.add(a[2:])
976
 
        else:
977
 
            argv_copy.append(a)
978
 
        i += 1
979
 
 
980
 
    debug.set_debug_flags_from_config()
981
 
 
982
 
    if not opt_no_plugins:
983
 
        load_plugins()
984
 
    else:
985
 
        disable_plugins()
986
 
 
987
 
    argv = argv_copy
988
 
    if (not argv):
989
 
        get_cmd_object('help').run_argv_aliases([])
990
 
        return 0
991
 
 
992
 
    if argv[0] == '--version':
993
 
        get_cmd_object('version').run_argv_aliases([])
994
 
        return 0
995
 
 
996
 
    alias_argv = None
997
 
 
998
 
    if not opt_no_aliases:
999
 
        alias_argv = get_alias(argv[0])
1000
 
        if alias_argv:
1001
 
            user_encoding = osutils.get_user_encoding()
1002
 
            alias_argv = [a.decode(user_encoding) for a in alias_argv]
1003
 
            argv[0] = alias_argv.pop(0)
1004
 
 
1005
 
    cmd = argv.pop(0)
1006
 
    # We want only 'ascii' command names, but the user may have typed
1007
 
    # in a Unicode name. In that case, they should just get a
1008
 
    # 'command not found' error later.
1009
 
 
1010
 
    cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1011
 
    run = cmd_obj.run_argv_aliases
1012
 
    run_argv = [argv, alias_argv]
1013
 
 
1014
 
    try:
1015
 
        # We can be called recursively (tests for example), but we don't want
1016
 
        # the verbosity level to propagate.
1017
 
        saved_verbosity_level = option._verbosity_level
1018
 
        option._verbosity_level = 0
1019
 
        if opt_lsprof:
1020
 
            if opt_coverage_dir:
1021
 
                trace.warning(
1022
 
                    '--coverage ignored, because --lsprof is in use.')
1023
 
            ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1024
 
        elif opt_profile:
1025
 
            if opt_coverage_dir:
1026
 
                trace.warning(
1027
 
                    '--coverage ignored, because --profile is in use.')
1028
 
            ret = apply_profiled(run, *run_argv)
1029
 
        elif opt_coverage_dir:
1030
 
            ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1031
 
        else:
1032
 
            ret = run(*run_argv)
1033
 
        return ret or 0
 
1125
                msg = str(e).rstrip('\n')
 
1126
            _report_exception(msg, quiet)
 
1127
            return 2
1034
1128
    finally:
1035
 
        # reset, in case we may do other commands later within the same
1036
 
        # process. Commands that want to execute sub-commands must propagate
1037
 
        # --verbose in their own way.
1038
 
        if 'memory' in debug.debug_flags:
1039
 
            trace.debug_memory('Process status after command:', short=False)
1040
 
        option._verbosity_level = saved_verbosity_level
1041
 
 
1042
 
 
1043
 
def display_command(func):
1044
 
    """Decorator that suppresses pipe/interrupt errors."""
1045
 
    def ignore_pipe(*args, **kwargs):
1046
 
        try:
1047
 
            result = func(*args, **kwargs)
1048
 
            sys.stdout.flush()
1049
 
            return result
1050
 
        except IOError, e:
1051
 
            if getattr(e, 'errno', None) is None:
1052
 
                raise
1053
 
            if e.errno != errno.EPIPE:
1054
 
                # Win32 raises IOError with errno=0 on a broken pipe
1055
 
                if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1056
 
                    raise
1057
 
            pass
1058
 
        except KeyboardInterrupt:
1059
 
            pass
1060
 
    return ignore_pipe
1061
 
 
1062
 
 
1063
 
def install_bzr_command_hooks():
1064
 
    """Install the hooks to supply bzr's own commands."""
1065
 
    if _list_bzr_commands in Command.hooks["list_commands"]:
1066
 
        return
1067
 
    Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1068
 
        "bzr commands")
1069
 
    Command.hooks.install_named_hook("get_command", _get_bzr_command,
1070
 
        "bzr commands")
1071
 
    Command.hooks.install_named_hook("get_command", _get_plugin_command,
1072
 
        "bzr plugin commands")
1073
 
    Command.hooks.install_named_hook("get_command", _get_external_command,
1074
 
        "bzr external command lookup")
1075
 
    Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1076
 
        "bzr plugin-provider-db check")
1077
 
 
1078
 
 
1079
 
 
1080
 
def _specified_or_unicode_argv(argv):
1081
 
    # For internal or testing use, argv can be passed.  Otherwise, get it from
1082
 
    # the process arguments in a unicode-safe way.
1083
 
    if argv is None:
1084
 
        return osutils.get_unicode_argv()
1085
 
    else:
1086
 
        new_argv = []
1087
 
        try:
1088
 
            # ensure all arguments are unicode strings
1089
 
            for a in argv[1:]:
1090
 
                if isinstance(a, unicode):
1091
 
                    new_argv.append(a)
1092
 
                else:
1093
 
                    new_argv.append(a.decode('ascii'))
1094
 
        except UnicodeDecodeError:
1095
 
            raise errors.BzrError("argv should be list of unicode strings.")
1096
 
        return new_argv
1097
 
 
1098
 
 
1099
 
def main(argv=None):
1100
 
    """Main entry point of command-line interface.
1101
 
 
1102
 
    Typically `bzrlib.initialize` should be called first.
1103
 
 
1104
 
    :param argv: list of unicode command-line arguments similar to sys.argv.
1105
 
        argv[0] is script name usually, it will be ignored.
1106
 
        Don't pass here sys.argv because this list contains plain strings
1107
 
        and not unicode; pass None instead.
1108
 
 
1109
 
    :return: exit code of bzr command.
1110
 
    """
1111
 
    argv = _specified_or_unicode_argv(argv)
1112
 
    ret = run_bzr_catch_errors(argv)
1113
 
    bzrlib.ui.ui_factory.log_transport_activity(
1114
 
        display=('bytes' in debug.debug_flags))
1115
 
    trace.mutter("return code %d", ret)
1116
 
    return ret
1117
 
 
1118
 
 
1119
 
def run_bzr_catch_errors(argv):
1120
 
    """Run a bzr command with parameters as described by argv.
1121
 
 
1122
 
    This function assumed that that UI layer is setup, that symbol deprecations
1123
 
    are already applied, and that unicode decoding has already been performed on argv.
1124
 
    """
1125
 
    # done here so that they're covered for every test run
1126
 
    install_bzr_command_hooks()
1127
 
    return exception_to_return_code(run_bzr, argv)
1128
 
 
1129
 
 
1130
 
def run_bzr_catch_user_errors(argv):
1131
 
    """Run bzr and report user errors, but let internal errors propagate.
1132
 
 
1133
 
    This is used for the test suite, and might be useful for other programs
1134
 
    that want to wrap the commandline interface.
1135
 
    """
1136
 
    # done here so that they're covered for every test run
1137
 
    install_bzr_command_hooks()
1138
 
    try:
1139
 
        return run_bzr(argv)
1140
 
    except Exception, e:
1141
 
        if (isinstance(e, (OSError, IOError))
1142
 
            or not getattr(e, 'internal_error', True)):
1143
 
            trace.report_exception(sys.exc_info(), sys.stderr)
1144
 
            return 3
1145
 
        else:
1146
 
            raise
1147
 
 
1148
 
 
1149
 
class HelpCommandIndex(object):
1150
 
    """A index for bzr help that returns commands."""
1151
 
 
1152
 
    def __init__(self):
1153
 
        self.prefix = 'commands/'
1154
 
 
1155
 
    def get_topics(self, topic):
1156
 
        """Search for topic amongst commands.
1157
 
 
1158
 
        :param topic: A topic to search for.
1159
 
        :return: A list which is either empty or contains a single
1160
 
            Command entry.
1161
 
        """
1162
 
        if topic and topic.startswith(self.prefix):
1163
 
            topic = topic[len(self.prefix):]
1164
 
        try:
1165
 
            cmd = _get_cmd_object(topic)
1166
 
        except KeyError:
1167
 
            return []
1168
 
        else:
1169
 
            return [cmd]
1170
 
 
1171
 
 
1172
 
class Provider(object):
1173
 
    '''Generic class to be overriden by plugins'''
1174
 
 
1175
 
    def plugin_for_command(self, cmd_name):
1176
 
        '''Takes a command and returns the information for that plugin
1177
 
 
1178
 
        :return: A dictionary with all the available information
1179
 
        for the requested plugin
1180
 
        '''
1181
 
        raise NotImplementedError
1182
 
 
1183
 
 
1184
 
class ProvidersRegistry(registry.Registry):
1185
 
    '''This registry exists to allow other providers to exist'''
1186
 
 
1187
 
    def __iter__(self):
1188
 
        for key, provider in self.iteritems():
1189
 
            yield provider
1190
 
 
1191
 
command_providers_registry = ProvidersRegistry()
 
1129
        bzrlib.trace.close_trace()
 
1130
 
 
1131
 
 
1132
if __name__ == '__main__':
 
1133
    sys.exit(main(sys.argv))