~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Martin Pool
  • Date: 2005-06-02 02:41:33 UTC
  • Revision ID: mbp@sourcefrog.net-20050602024133-bb6271c689b3034a
- Improved bash completion script
  contributed by Sven Wilhelm

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