~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-05-28 14:25:00 UTC
  • mfrom: (4354.4.9 commit-preview)
  • Revision ID: pqm@pqm.ubuntu.com-20090528142500-n7ki7gucmkxzx611
(abentley) move get_file_with_stat from MutableTree to Tree.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2004, 2005 by Canonical Ltd
2
 
 
 
1
# Copyright (C) 2006, 2008 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
17
 
 
18
 
# TODO: Split the command framework away from the actual commands.
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
19
17
 
20
18
# TODO: probably should say which arguments are candidates for glob
21
19
# expansion on windows and do that at the command level.
22
20
 
 
21
# TODO: Define arguments by objects, rather than just using names.
 
22
# Those objects can specify the expected type of the argument, which
 
23
# would help with validation and shell completion.  They could also provide
 
24
# help/explanation for that argument in a structured way.
 
25
 
 
26
# TODO: Specific "examples" property on commands for consistent formatting.
 
27
 
 
28
# TODO: "--profile=cum", to change sort order.  Is there any value in leaving
 
29
# the profile output behind so it can be interactively examined?
 
30
 
 
31
import os
23
32
import sys
24
 
import os
 
33
 
 
34
from bzrlib.lazy_import import lazy_import
 
35
lazy_import(globals(), """
 
36
import codecs
 
37
import errno
 
38
import threading
 
39
from warnings import warn
25
40
 
26
41
import bzrlib
27
 
from bzrlib.trace import mutter, note, log_error, warning
28
 
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError
29
 
from bzrlib.branch import find_branch
30
 
from bzrlib import BZRDIR
31
 
 
32
 
 
33
 
plugin_cmds = {}
34
 
 
35
 
 
36
 
def register_command(cmd):
37
 
    "Utility function to help register a command"
 
42
from bzrlib import (
 
43
    debug,
 
44
    errors,
 
45
    option,
 
46
    osutils,
 
47
    trace,
 
48
    win32utils,
 
49
    )
 
50
""")
 
51
 
 
52
from bzrlib import registry
 
53
# Compatibility
 
54
from bzrlib.hooks import HookPoint, Hooks
 
55
from bzrlib.option import Option
 
56
 
 
57
 
 
58
class CommandInfo(object):
 
59
    """Information about a command."""
 
60
 
 
61
    def __init__(self, aliases):
 
62
        """The list of aliases for the command."""
 
63
        self.aliases = aliases
 
64
 
 
65
    @classmethod
 
66
    def from_command(klass, command):
 
67
        """Factory to construct a CommandInfo from a command."""
 
68
        return klass(command.aliases)
 
69
 
 
70
 
 
71
class CommandRegistry(registry.Registry):
 
72
 
 
73
    @staticmethod
 
74
    def _get_name(command_name):
 
75
        if command_name.startswith("cmd_"):
 
76
            return _unsquish_command_name(command_name)
 
77
        else:
 
78
            return command_name
 
79
 
 
80
    def register(self, cmd, decorate=False):
 
81
        """Utility function to help register a command
 
82
 
 
83
        :param cmd: Command subclass to register
 
84
        :param decorate: If true, allow overriding an existing command
 
85
            of the same name; the old command is returned by this function.
 
86
            Otherwise it is an error to try to override an existing command.
 
87
        """
 
88
        k = cmd.__name__
 
89
        k_unsquished = self._get_name(k)
 
90
        try:
 
91
            previous = self.get(k_unsquished)
 
92
        except KeyError:
 
93
            previous = _builtin_commands().get(k_unsquished)
 
94
        info = CommandInfo.from_command(cmd)
 
95
        try:
 
96
            registry.Registry.register(self, k_unsquished, cmd,
 
97
                                       override_existing=decorate, info=info)
 
98
        except KeyError:
 
99
            trace.log_error('Two plugins defined the same command: %r' % k)
 
100
            trace.log_error('Not loading the one in %r' %
 
101
                            sys.modules[cmd.__module__])
 
102
            trace.log_error('Previously this command was registered from %r' %
 
103
                            sys.modules[previous.__module__])
 
104
        return previous
 
105
 
 
106
    def register_lazy(self, command_name, aliases, module_name):
 
107
        """Register a command without loading its module.
 
108
 
 
109
        :param command_name: The primary name of the command.
 
110
        :param aliases: A list of aliases for the command.
 
111
        :module_name: The module that the command lives in.
 
112
        """
 
113
        key = self._get_name(command_name)
 
114
        registry.Registry.register_lazy(self, key, module_name, command_name,
 
115
                                        info=CommandInfo(aliases))
 
116
 
 
117
 
 
118
plugin_cmds = CommandRegistry()
 
119
 
 
120
 
 
121
def register_command(cmd, decorate=False):
38
122
    global plugin_cmds
39
 
    k = cmd.__name__
40
 
    if k.startswith("cmd_"):
41
 
        k_unsquished = _unsquish_command_name(k)
42
 
    else:
43
 
        k_unsquished = k
44
 
    if not plugin_cmds.has_key(k_unsquished):
45
 
        plugin_cmds[k_unsquished] = cmd
46
 
    else:
47
 
        log_error('Two plugins defined the same command: %r' % k)
48
 
        log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
 
123
    return plugin_cmds.register(cmd, decorate)
49
124
 
50
125
 
51
126
def _squish_command_name(cmd):
53
128
 
54
129
 
55
130
def _unsquish_command_name(cmd):
56
 
    assert cmd.startswith("cmd_")
57
131
    return cmd[4:].replace('_','-')
58
132
 
59
133
 
60
 
def _parse_revision_str(revstr):
61
 
    """This handles a revision string -> revno.
62
 
 
63
 
    This always returns a list.  The list will have one element for 
64
 
 
65
 
    It supports integers directly, but everything else it
66
 
    defers for passing to Branch.get_revision_info()
67
 
 
68
 
    >>> _parse_revision_str('234')
69
 
    [234]
70
 
    >>> _parse_revision_str('234..567')
71
 
    [234, 567]
72
 
    >>> _parse_revision_str('..')
73
 
    [None, None]
74
 
    >>> _parse_revision_str('..234')
75
 
    [None, 234]
76
 
    >>> _parse_revision_str('234..')
77
 
    [234, None]
78
 
    >>> _parse_revision_str('234..456..789') # Maybe this should be an error
79
 
    [234, 456, 789]
80
 
    >>> _parse_revision_str('234....789') # Error?
81
 
    [234, None, 789]
82
 
    >>> _parse_revision_str('revid:test@other.com-234234')
83
 
    ['revid:test@other.com-234234']
84
 
    >>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
85
 
    ['revid:test@other.com-234234', 'revid:test@other.com-234235']
86
 
    >>> _parse_revision_str('revid:test@other.com-234234..23')
87
 
    ['revid:test@other.com-234234', 23]
88
 
    >>> _parse_revision_str('date:2005-04-12')
89
 
    ['date:2005-04-12']
90
 
    >>> _parse_revision_str('date:2005-04-12 12:24:33')
91
 
    ['date:2005-04-12 12:24:33']
92
 
    >>> _parse_revision_str('date:2005-04-12T12:24:33')
93
 
    ['date:2005-04-12T12:24:33']
94
 
    >>> _parse_revision_str('date:2005-04-12,12:24:33')
95
 
    ['date:2005-04-12,12:24:33']
96
 
    >>> _parse_revision_str('-5..23')
97
 
    [-5, 23]
98
 
    >>> _parse_revision_str('-5')
99
 
    [-5]
100
 
    >>> _parse_revision_str('123a')
101
 
    ['123a']
102
 
    >>> _parse_revision_str('abc')
103
 
    ['abc']
104
 
    """
105
 
    import re
106
 
    old_format_re = re.compile('\d*:\d*')
107
 
    m = old_format_re.match(revstr)
108
 
    if m:
109
 
        warning('Colon separator for revision numbers is deprecated.'
110
 
                ' Use .. instead')
111
 
        revs = []
112
 
        for rev in revstr.split(':'):
113
 
            if rev:
114
 
                revs.append(int(rev))
115
 
            else:
116
 
                revs.append(None)
117
 
        return revs
118
 
    revs = []
119
 
    for x in revstr.split('..'):
120
 
        if not x:
121
 
            revs.append(None)
122
 
        else:
123
 
            try:
124
 
                revs.append(int(x))
125
 
            except ValueError:
126
 
                revs.append(x)
127
 
    return revs
128
 
 
129
 
 
130
 
def get_merge_type(typestring):
131
 
    """Attempt to find the merge class/factory associated with a string."""
132
 
    from merge import merge_types
133
 
    try:
134
 
        return merge_types[typestring][0]
135
 
    except KeyError:
136
 
        templ = '%s%%7s: %%s' % (' '*12)
137
 
        lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
138
 
        type_list = '\n'.join(lines)
139
 
        msg = "No known merge type %s. Supported types are:\n%s" %\
140
 
            (typestring, type_list)
141
 
        raise BzrCommandError(msg)
142
 
    
 
134
def _builtin_commands():
 
135
    import bzrlib.builtins
 
136
    r = {}
 
137
    builtins = bzrlib.builtins.__dict__
 
138
    for name in builtins:
 
139
        if name.startswith("cmd_"):
 
140
            real_name = _unsquish_command_name(name)
 
141
            r[real_name] = builtins[name]
 
142
    return r
 
143
 
 
144
 
 
145
def builtin_command_names():
 
146
    """Return list of builtin command names."""
 
147
    return _builtin_commands().keys()
 
148
 
 
149
 
 
150
def plugin_command_names():
 
151
    return plugin_cmds.keys()
143
152
 
144
153
 
145
154
def _get_cmd_dict(plugins_override=True):
146
 
    d = {}
147
 
    for k, v in globals().iteritems():
148
 
        if k.startswith("cmd_"):
149
 
            d[_unsquish_command_name(k)] = v
150
 
    # If we didn't load plugins, the plugin_cmds dict will be empty
 
155
    """Return name->class mapping for all commands."""
 
156
    d = _builtin_commands()
151
157
    if plugins_override:
152
 
        d.update(plugin_cmds)
153
 
    else:
154
 
        d2 = plugin_cmds.copy()
155
 
        d2.update(d)
156
 
        d = d2
 
158
        d.update(plugin_cmds.iteritems())
157
159
    return d
158
160
 
159
 
    
 
161
 
160
162
def get_all_cmds(plugins_override=True):
161
163
    """Return canonical name and class for all registered commands."""
162
164
    for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
163
165
        yield k,v
164
166
 
165
167
 
166
 
def get_cmd_class(cmd, plugins_override=True):
 
168
def get_cmd_object(cmd_name, plugins_override=True):
167
169
    """Return the canonical name and command class for a command.
 
170
 
 
171
    plugins_override
 
172
        If true, plugin commands can override builtins.
168
173
    """
169
 
    cmd = str(cmd)                      # not unicode
 
174
    try:
 
175
        cmd = _get_cmd_object(cmd_name, plugins_override)
 
176
        # Allow plugins to extend commands
 
177
        for hook in Command.hooks['extend_command']:
 
178
            hook(cmd)
 
179
        return cmd
 
180
    except KeyError:
 
181
        raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
 
182
 
 
183
 
 
184
def _get_cmd_object(cmd_name, plugins_override=True):
 
185
    """Worker for get_cmd_object which raises KeyError rather than BzrCommandError."""
 
186
    from bzrlib.externalcommand import ExternalCommand
 
187
 
 
188
    # We want only 'ascii' command names, but the user may have typed
 
189
    # in a Unicode name. In that case, they should just get a
 
190
    # 'command not found' error later.
 
191
    # In the future, we may actually support Unicode command names.
170
192
 
171
193
    # first look up this command under the specified name
172
 
    cmds = _get_cmd_dict(plugins_override=plugins_override)
 
194
    if plugins_override:
 
195
        try:
 
196
            return plugin_cmds.get(cmd_name)()
 
197
        except KeyError:
 
198
            pass
 
199
    cmds = _get_cmd_dict(plugins_override=False)
173
200
    try:
174
 
        return cmd, cmds[cmd]
 
201
        return cmds[cmd_name]()
175
202
    except KeyError:
176
203
        pass
177
 
 
 
204
    if plugins_override:
 
205
        for key in plugin_cmds.keys():
 
206
            info = plugin_cmds.get_info(key)
 
207
            if cmd_name in info.aliases:
 
208
                return plugin_cmds.get(key)()
178
209
    # look for any command which claims this as an alias
179
 
    for cmdname, cmdclass in cmds.iteritems():
180
 
        if cmd in cmdclass.aliases:
181
 
            return cmdname, cmdclass
182
 
 
183
 
    cmdclass = ExternalCommand.find_command(cmd)
184
 
    if cmdclass:
185
 
        return cmd, cmdclass
186
 
 
187
 
    raise BzrCommandError("unknown command %r" % cmd)
 
210
    for real_cmd_name, cmd_class in cmds.iteritems():
 
211
        if cmd_name in cmd_class.aliases:
 
212
            return cmd_class()
 
213
 
 
214
    cmd_obj = ExternalCommand.find_command(cmd_name)
 
215
    if cmd_obj:
 
216
        return cmd_obj
 
217
 
 
218
    # look for plugins that provide this command but aren't installed
 
219
    for provider in command_providers_registry:
 
220
        try:
 
221
            plugin_metadata = provider.plugin_for_command(cmd_name)
 
222
        except errors.NoPluginAvailable:
 
223
            pass
 
224
        else:
 
225
            raise errors.CommandAvailableInPlugin(cmd_name,
 
226
                                                  plugin_metadata, provider)
 
227
    raise KeyError
188
228
 
189
229
 
190
230
class Command(object):
191
231
    """Base class for commands.
192
232
 
 
233
    Commands are the heart of the command-line bzr interface.
 
234
 
 
235
    The command object mostly handles the mapping of command-line
 
236
    parameters into one or more bzrlib operations, and of the results
 
237
    into textual output.
 
238
 
 
239
    Commands normally don't have any state.  All their arguments are
 
240
    passed in to the run method.  (Subclasses may take a different
 
241
    policy if the behaviour of the instance needs to depend on e.g. a
 
242
    shell plugin and not just its Python class.)
 
243
 
193
244
    The docstring for an actual command should give a single-line
194
245
    summary, then a complete description of the command.  A grammar
195
246
    description will be inserted.
196
247
 
 
248
    aliases
 
249
        Other accepted names for this command.
 
250
 
197
251
    takes_args
198
252
        List of argument forms, marked with whether they are optional,
199
253
        repeated, etc.
200
254
 
 
255
                Examples:
 
256
 
 
257
                ['to_location', 'from_branch?', 'file*']
 
258
 
 
259
                'to_location' is required
 
260
                'from_branch' is optional
 
261
                'file' can be specified 0 or more times
 
262
 
201
263
    takes_options
202
 
        List of options that may be given for this command.
 
264
        List of options that may be given for this command.  These can
 
265
        be either strings, referring to globally-defined options,
 
266
        or option objects.  Retrieve through options().
203
267
 
204
268
    hidden
205
 
        If true, this command isn't advertised.
 
269
        If true, this command isn't advertised.  This is typically
 
270
        for commands intended for expert users.
 
271
 
 
272
    encoding_type
 
273
        Command objects will get a 'outf' attribute, which has been
 
274
        setup to properly handle encoding of unicode strings.
 
275
        encoding_type determines what will happen when characters cannot
 
276
        be encoded
 
277
            strict - abort if we cannot decode
 
278
            replace - put in a bogus character (typically '?')
 
279
            exact - do not encode sys.stdout
 
280
 
 
281
            NOTE: by default on Windows, sys.stdout is opened as a text
 
282
            stream, therefore LF line-endings are converted to CRLF.
 
283
            When a command uses encoding_type = 'exact', then
 
284
            sys.stdout is forced to be a binary stream, and line-endings
 
285
            will not mangled.
 
286
 
 
287
    :cvar hooks: An instance of CommandHooks.
206
288
    """
207
289
    aliases = []
208
 
    
209
290
    takes_args = []
210
291
    takes_options = []
 
292
    encoding_type = 'strict'
211
293
 
212
294
    hidden = False
213
 
    
214
 
    def __init__(self, options, arguments):
215
 
        """Construct and run the command.
216
295
 
217
 
        Sets self.status to the return value of run()."""
218
 
        assert isinstance(options, dict)
219
 
        assert isinstance(arguments, dict)
220
 
        cmdargs = options.copy()
221
 
        cmdargs.update(arguments)
 
296
    def __init__(self):
 
297
        """Construct an instance of this command."""
222
298
        if self.__doc__ == Command.__doc__:
223
 
            from warnings import warn
224
299
            warn("No help message set for %r" % self)
225
 
        self.status = self.run(**cmdargs)
226
 
        if self.status is None:
227
 
            self.status = 0
228
 
 
229
 
    
 
300
        # List of standard options directly supported
 
301
        self.supported_std_options = []
 
302
 
 
303
    def _maybe_expand_globs(self, file_list):
 
304
        """Glob expand file_list if the platform does not do that itself.
 
305
 
 
306
        :return: A possibly empty list of unicode paths.
 
307
 
 
308
        Introduced in bzrlib 0.18.
 
309
        """
 
310
        if not file_list:
 
311
            file_list = []
 
312
        if sys.platform == 'win32':
 
313
            file_list = win32utils.glob_expand(file_list)
 
314
        return list(file_list)
 
315
 
 
316
    def _usage(self):
 
317
        """Return single-line grammar for this command.
 
318
 
 
319
        Only describes arguments, not options.
 
320
        """
 
321
        s = 'bzr ' + self.name() + ' '
 
322
        for aname in self.takes_args:
 
323
            aname = aname.upper()
 
324
            if aname[-1] in ['$', '+']:
 
325
                aname = aname[:-1] + '...'
 
326
            elif aname[-1] == '?':
 
327
                aname = '[' + aname[:-1] + ']'
 
328
            elif aname[-1] == '*':
 
329
                aname = '[' + aname[:-1] + '...]'
 
330
            s += aname + ' '
 
331
        s = s[:-1]      # remove last space
 
332
        return s
 
333
 
 
334
    def get_help_text(self, additional_see_also=None, plain=True,
 
335
                      see_also_as_links=False, verbose=True):
 
336
        """Return a text string with help for this command.
 
337
 
 
338
        :param additional_see_also: Additional help topics to be
 
339
            cross-referenced.
 
340
        :param plain: if False, raw help (reStructuredText) is
 
341
            returned instead of plain text.
 
342
        :param see_also_as_links: if True, convert items in 'See also'
 
343
            list to internal links (used by bzr_man rstx generator)
 
344
        :param verbose: if True, display the full help, otherwise
 
345
            leave out the descriptive sections and just display
 
346
            usage help (e.g. Purpose, Usage, Options) with a
 
347
            message explaining how to obtain full help.
 
348
        """
 
349
        doc = self.help()
 
350
        if doc is None:
 
351
            raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
 
352
 
 
353
        # Extract the summary (purpose) and sections out from the text
 
354
        purpose,sections,order = self._get_help_parts(doc)
 
355
 
 
356
        # If a custom usage section was provided, use it
 
357
        if sections.has_key('Usage'):
 
358
            usage = sections.pop('Usage')
 
359
        else:
 
360
            usage = self._usage()
 
361
 
 
362
        # The header is the purpose and usage
 
363
        result = ""
 
364
        result += ':Purpose: %s\n' % purpose
 
365
        if usage.find('\n') >= 0:
 
366
            result += ':Usage:\n%s\n' % usage
 
367
        else:
 
368
            result += ':Usage:   %s\n' % usage
 
369
        result += '\n'
 
370
 
 
371
        # Add the options
 
372
        options = option.get_optparser(self.options()).format_option_help()
 
373
        if options.startswith('Options:'):
 
374
            result += ':' + options
 
375
        elif options.startswith('options:'):
 
376
            # Python 2.4 version of optparse
 
377
            result += ':Options:' + options[len('options:'):]
 
378
        else:
 
379
            result += options
 
380
        result += '\n'
 
381
 
 
382
        if verbose:
 
383
            # Add the description, indenting it 2 spaces
 
384
            # to match the indentation of the options
 
385
            if sections.has_key(None):
 
386
                text = sections.pop(None)
 
387
                text = '\n  '.join(text.splitlines())
 
388
                result += ':%s:\n  %s\n\n' % ('Description',text)
 
389
 
 
390
            # Add the custom sections (e.g. Examples). Note that there's no need
 
391
            # to indent these as they must be indented already in the source.
 
392
            if sections:
 
393
                for label in order:
 
394
                    if sections.has_key(label):
 
395
                        result += ':%s:\n%s\n' % (label,sections[label])
 
396
                result += '\n'
 
397
        else:
 
398
            result += ("See bzr help %s for more details and examples.\n\n"
 
399
                % self.name())
 
400
 
 
401
        # Add the aliases, source (plug-in) and see also links, if any
 
402
        if self.aliases:
 
403
            result += ':Aliases:  '
 
404
            result += ', '.join(self.aliases) + '\n'
 
405
        plugin_name = self.plugin_name()
 
406
        if plugin_name is not None:
 
407
            result += ':From:     plugin "%s"\n' % plugin_name
 
408
        see_also = self.get_see_also(additional_see_also)
 
409
        if see_also:
 
410
            if not plain and see_also_as_links:
 
411
                see_also_links = []
 
412
                for item in see_also:
 
413
                    if item == 'topics':
 
414
                        # topics doesn't have an independent section
 
415
                        # so don't create a real link
 
416
                        see_also_links.append(item)
 
417
                    else:
 
418
                        # Use a reST link for this entry
 
419
                        see_also_links.append("`%s`_" % (item,))
 
420
                see_also = see_also_links
 
421
            result += ':See also: '
 
422
            result += ', '.join(see_also) + '\n'
 
423
 
 
424
        # If this will be rendered as plain text, convert it
 
425
        if plain:
 
426
            import bzrlib.help_topics
 
427
            result = bzrlib.help_topics.help_as_plain_text(result)
 
428
        return result
 
429
 
 
430
    @staticmethod
 
431
    def _get_help_parts(text):
 
432
        """Split help text into a summary and named sections.
 
433
 
 
434
        :return: (summary,sections,order) where summary is the top line and
 
435
            sections is a dictionary of the rest indexed by section name.
 
436
            order is the order the section appear in the text.
 
437
            A section starts with a heading line of the form ":xxx:".
 
438
            Indented text on following lines is the section value.
 
439
            All text found outside a named section is assigned to the
 
440
            default section which is given the key of None.
 
441
        """
 
442
        def save_section(sections, order, label, section):
 
443
            if len(section) > 0:
 
444
                if sections.has_key(label):
 
445
                    sections[label] += '\n' + section
 
446
                else:
 
447
                    order.append(label)
 
448
                    sections[label] = section
 
449
 
 
450
        lines = text.rstrip().splitlines()
 
451
        summary = lines.pop(0)
 
452
        sections = {}
 
453
        order = []
 
454
        label,section = None,''
 
455
        for line in lines:
 
456
            if line.startswith(':') and line.endswith(':') and len(line) > 2:
 
457
                save_section(sections, order, label, section)
 
458
                label,section = line[1:-1],''
 
459
            elif (label is not None) and len(line) > 1 and not line[0].isspace():
 
460
                save_section(sections, order, label, section)
 
461
                label,section = None,line
 
462
            else:
 
463
                if len(section) > 0:
 
464
                    section += '\n' + line
 
465
                else:
 
466
                    section = line
 
467
        save_section(sections, order, label, section)
 
468
        return summary, sections, order
 
469
 
 
470
    def get_help_topic(self):
 
471
        """Return the commands help topic - its name."""
 
472
        return self.name()
 
473
 
 
474
    def get_see_also(self, additional_terms=None):
 
475
        """Return a list of help topics that are related to this command.
 
476
 
 
477
        The list is derived from the content of the _see_also attribute. Any
 
478
        duplicates are removed and the result is in lexical order.
 
479
        :param additional_terms: Additional help topics to cross-reference.
 
480
        :return: A list of help topics.
 
481
        """
 
482
        see_also = set(getattr(self, '_see_also', []))
 
483
        if additional_terms:
 
484
            see_also.update(additional_terms)
 
485
        return sorted(see_also)
 
486
 
 
487
    def options(self):
 
488
        """Return dict of valid options for this command.
 
489
 
 
490
        Maps from long option name to option object."""
 
491
        r = Option.STD_OPTIONS.copy()
 
492
        std_names = r.keys()
 
493
        for o in self.takes_options:
 
494
            if isinstance(o, basestring):
 
495
                o = option.Option.OPTIONS[o]
 
496
            r[o.name] = o
 
497
            if o.name in std_names:
 
498
                self.supported_std_options.append(o.name)
 
499
        return r
 
500
 
 
501
    def _setup_outf(self):
 
502
        """Return a file linked to stdout, which has proper encoding."""
 
503
        # Originally I was using self.stdout, but that looks
 
504
        # *way* too much like sys.stdout
 
505
        if self.encoding_type == 'exact':
 
506
            # force sys.stdout to be binary stream on win32
 
507
            if sys.platform == 'win32':
 
508
                fileno = getattr(sys.stdout, 'fileno', None)
 
509
                if fileno:
 
510
                    import msvcrt
 
511
                    msvcrt.setmode(fileno(), os.O_BINARY)
 
512
            self.outf = sys.stdout
 
513
            return
 
514
 
 
515
        output_encoding = osutils.get_terminal_encoding()
 
516
 
 
517
        self.outf = codecs.getwriter(output_encoding)(sys.stdout,
 
518
                        errors=self.encoding_type)
 
519
        # For whatever reason codecs.getwriter() does not advertise its encoding
 
520
        # it just returns the encoding of the wrapped file, which is completely
 
521
        # bogus. So set the attribute, so we can find the correct encoding later.
 
522
        self.outf.encoding = output_encoding
 
523
 
 
524
    def run_argv_aliases(self, argv, alias_argv=None):
 
525
        """Parse the command line and run with extra aliases in alias_argv."""
 
526
        if argv is None:
 
527
            warn("Passing None for [] is deprecated from bzrlib 0.10",
 
528
                 DeprecationWarning, stacklevel=2)
 
529
            argv = []
 
530
        args, opts = parse_args(self, argv, alias_argv)
 
531
 
 
532
        # Process the standard options
 
533
        if 'help' in opts:  # e.g. bzr add --help
 
534
            sys.stdout.write(self.get_help_text())
 
535
            return 0
 
536
        if 'usage' in opts:  # e.g. bzr add --usage
 
537
            sys.stdout.write(self.get_help_text(verbose=False))
 
538
            return 0
 
539
        trace.set_verbosity_level(option._verbosity_level)
 
540
        if 'verbose' in self.supported_std_options:
 
541
            opts['verbose'] = trace.is_verbose()
 
542
        elif opts.has_key('verbose'):
 
543
            del opts['verbose']
 
544
        if 'quiet' in self.supported_std_options:
 
545
            opts['quiet'] = trace.is_quiet()
 
546
        elif opts.has_key('quiet'):
 
547
            del opts['quiet']
 
548
 
 
549
        # mix arguments and options into one dictionary
 
550
        cmdargs = _match_argform(self.name(), self.takes_args, args)
 
551
        cmdopts = {}
 
552
        for k, v in opts.items():
 
553
            cmdopts[k.replace('-', '_')] = v
 
554
 
 
555
        all_cmd_args = cmdargs.copy()
 
556
        all_cmd_args.update(cmdopts)
 
557
 
 
558
        self._setup_outf()
 
559
 
 
560
        return self.run(**all_cmd_args)
 
561
 
230
562
    def run(self):
231
 
        """Override this in sub-classes.
 
563
        """Actually run the command.
232
564
 
233
565
        This is invoked with the options and arguments bound to
234
566
        keyword parameters.
235
567
 
236
 
        Return 0 or None if the command was successful, or a shell
237
 
        error code if not.
 
568
        Return 0 or None if the command was successful, or a non-zero
 
569
        shell error code if not.  It's OK for this method to allow
 
570
        an exception to raise up.
238
571
        """
239
 
        return 0
240
 
 
241
 
 
242
 
class ExternalCommand(Command):
243
 
    """Class to wrap external commands.
244
 
 
245
 
    We cheat a little here, when get_cmd_class() calls us we actually
246
 
    give it back an object we construct that has the appropriate path,
247
 
    help, options etc for the specified command.
248
 
 
249
 
    When run_bzr() tries to instantiate that 'class' it gets caught by
250
 
    the __call__ method, which we override to call the Command.__init__
251
 
    method. That then calls our run method which is pretty straight
252
 
    forward.
253
 
 
254
 
    The only wrinkle is that we have to map bzr's dictionary of options
255
 
    and arguments back into command line options and arguments for the
256
 
    script.
257
 
    """
258
 
 
259
 
    def find_command(cls, cmd):
260
 
        import os.path
261
 
        bzrpath = os.environ.get('BZRPATH', '')
262
 
 
263
 
        for dir in bzrpath.split(os.pathsep):
264
 
            path = os.path.join(dir, cmd)
265
 
            if os.path.isfile(path):
266
 
                return ExternalCommand(path)
267
 
 
268
 
        return None
269
 
 
270
 
    find_command = classmethod(find_command)
271
 
 
272
 
    def __init__(self, path):
273
 
        self.path = path
274
 
 
275
 
        pipe = os.popen('%s --bzr-usage' % path, 'r')
276
 
        self.takes_options = pipe.readline().split()
277
 
 
278
 
        for opt in self.takes_options:
279
 
            if not opt in OPTIONS:
280
 
                raise BzrError("Unknown option '%s' returned by external command %s"
281
 
                               % (opt, path))
282
 
 
283
 
        # TODO: Is there any way to check takes_args is valid here?
284
 
        self.takes_args = pipe.readline().split()
285
 
 
286
 
        if pipe.close() is not None:
287
 
            raise BzrError("Failed funning '%s --bzr-usage'" % path)
288
 
 
289
 
        pipe = os.popen('%s --bzr-help' % path, 'r')
290
 
        self.__doc__ = pipe.read()
291
 
        if pipe.close() is not None:
292
 
            raise BzrError("Failed funning '%s --bzr-help'" % path)
293
 
 
294
 
    def __call__(self, options, arguments):
295
 
        Command.__init__(self, options, arguments)
296
 
        return self
297
 
 
298
 
    def run(self, **kargs):
299
 
        opts = []
300
 
        args = []
301
 
 
302
 
        keys = kargs.keys()
303
 
        keys.sort()
304
 
        for name in keys:
305
 
            optname = name.replace('_','-')
306
 
            value = kargs[name]
307
 
            if OPTIONS.has_key(optname):
308
 
                # it's an option
309
 
                opts.append('--%s' % optname)
310
 
                if value is not None and value is not True:
311
 
                    opts.append(str(value))
312
 
            else:
313
 
                # it's an arg, or arg list
314
 
                if type(value) is not list:
315
 
                    value = [value]
316
 
                for v in value:
317
 
                    if v is not None:
318
 
                        args.append(str(v))
319
 
 
320
 
        self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
321
 
        return self.status
322
 
 
323
 
 
324
 
class cmd_status(Command):
325
 
    """Display status summary.
326
 
 
327
 
    This reports on versioned and unknown files, reporting them
328
 
    grouped by state.  Possible states are:
329
 
 
330
 
    added
331
 
        Versioned in the working copy but not in the previous revision.
332
 
 
333
 
    removed
334
 
        Versioned in the previous revision but removed or deleted
335
 
        in the working copy.
336
 
 
337
 
    renamed
338
 
        Path of this file changed from the previous revision;
339
 
        the text may also have changed.  This includes files whose
340
 
        parent directory was renamed.
341
 
 
342
 
    modified
343
 
        Text has changed since the previous revision.
344
 
 
345
 
    unchanged
346
 
        Nothing about this file has changed since the previous revision.
347
 
        Only shown with --all.
348
 
 
349
 
    unknown
350
 
        Not versioned and not matching an ignore pattern.
351
 
 
352
 
    To see ignored files use 'bzr ignored'.  For details in the
353
 
    changes to file texts, use 'bzr diff'.
354
 
 
355
 
    If no arguments are specified, the status of the entire working
356
 
    directory is shown.  Otherwise, only the status of the specified
357
 
    files or directories is reported.  If a directory is given, status
358
 
    is reported for everything inside that directory.
359
 
 
360
 
    If a revision is specified, the changes since that revision are shown.
361
 
    """
362
 
    takes_args = ['file*']
363
 
    takes_options = ['all', 'show-ids', 'revision']
364
 
    aliases = ['st', 'stat']
365
 
    
366
 
    def run(self, all=False, show_ids=False, file_list=None):
367
 
        if file_list:
368
 
            b = find_branch(file_list[0])
369
 
            file_list = [b.relpath(x) for x in file_list]
370
 
            # special case: only one path was given and it's the root
371
 
            # of the branch
372
 
            if file_list == ['']:
373
 
                file_list = None
374
 
        else:
375
 
            b = find_branch('.')
376
 
            
377
 
        from bzrlib.status import show_status
378
 
        show_status(b, show_unchanged=all, show_ids=show_ids,
379
 
                    specific_files=file_list)
380
 
 
381
 
 
382
 
class cmd_cat_revision(Command):
383
 
    """Write out metadata for a revision."""
384
 
 
385
 
    hidden = True
386
 
    takes_args = ['revision_id']
387
 
    
388
 
    def run(self, revision_id):
389
 
        from bzrlib.xml import pack_xml
390
 
        pack_xml(find_branch('.').get_revision(revision_id), sys.stdout)
391
 
 
392
 
 
393
 
class cmd_revno(Command):
394
 
    """Show current revision number.
395
 
 
396
 
    This is equal to the number of revisions on this branch."""
397
 
    def run(self):
398
 
        print find_branch('.').revno()
399
 
 
400
 
class cmd_revision_info(Command):
401
 
    """Show revision number and revision id for a given revision identifier.
402
 
    """
403
 
    hidden = True
404
 
    takes_args = ['revision_info*']
405
 
    takes_options = ['revision']
406
 
    def run(self, revision=None, revision_info_list=None):
407
 
        from bzrlib.branch import find_branch
408
 
 
409
 
        revs = []
410
 
        if revision is not None:
411
 
            revs.extend(revision)
412
 
        if revision_info_list is not None:
413
 
            revs.extend(revision_info_list)
414
 
        if len(revs) == 0:
415
 
            raise BzrCommandError('You must supply a revision identifier')
416
 
 
417
 
        b = find_branch('.')
418
 
 
419
 
        for rev in revs:
420
 
            print '%4d %s' % b.get_revision_info(rev)
421
 
 
422
 
    
423
 
class cmd_add(Command):
424
 
    """Add specified files or directories.
425
 
 
426
 
    In non-recursive mode, all the named items are added, regardless
427
 
    of whether they were previously ignored.  A warning is given if
428
 
    any of the named files are already versioned.
429
 
 
430
 
    In recursive mode (the default), files are treated the same way
431
 
    but the behaviour for directories is different.  Directories that
432
 
    are already versioned do not give a warning.  All directories,
433
 
    whether already versioned or not, are searched for files or
434
 
    subdirectories that are neither versioned or ignored, and these
435
 
    are added.  This search proceeds recursively into versioned
436
 
    directories.  If no names are given '.' is assumed.
437
 
 
438
 
    Therefore simply saying 'bzr add' will version all files that
439
 
    are currently unknown.
440
 
 
441
 
    TODO: Perhaps adding a file whose directly is not versioned should
442
 
    recursively add that parent, rather than giving an error?
443
 
    """
444
 
    takes_args = ['file*']
445
 
    takes_options = ['verbose', 'no-recurse']
446
 
    
447
 
    def run(self, file_list, verbose=False, no_recurse=False):
448
 
        from bzrlib.add import smart_add
449
 
        smart_add(file_list, verbose, not no_recurse)
450
 
 
451
 
 
452
 
 
453
 
class cmd_mkdir(Command):
454
 
    """Create a new versioned directory.
455
 
 
456
 
    This is equivalent to creating the directory and then adding it.
457
 
    """
458
 
    takes_args = ['dir+']
459
 
 
460
 
    def run(self, dir_list):
461
 
        b = None
462
 
        
463
 
        for d in dir_list:
464
 
            os.mkdir(d)
465
 
            if not b:
466
 
                b = find_branch(d)
467
 
            b.add([d], verbose=True)
468
 
 
469
 
 
470
 
class cmd_relpath(Command):
471
 
    """Show path of a file relative to root"""
472
 
    takes_args = ['filename']
473
 
    hidden = True
474
 
    
475
 
    def run(self, filename):
476
 
        print find_branch(filename).relpath(filename)
477
 
 
478
 
 
479
 
 
480
 
class cmd_inventory(Command):
481
 
    """Show inventory of the current working copy or a revision."""
482
 
    takes_options = ['revision', 'show-ids']
483
 
    
484
 
    def run(self, revision=None, show_ids=False):
485
 
        b = find_branch('.')
486
 
        if revision == None:
487
 
            inv = b.read_working_inventory()
488
 
        else:
489
 
            if len(revision) > 1:
490
 
                raise BzrCommandError('bzr inventory --revision takes'
491
 
                    ' exactly one revision identifier')
492
 
            inv = b.get_revision_inventory(b.lookup_revision(revision[0]))
493
 
 
494
 
        for path, entry in inv.entries():
495
 
            if show_ids:
496
 
                print '%-50s %s' % (path, entry.file_id)
497
 
            else:
498
 
                print path
499
 
 
500
 
 
501
 
class cmd_move(Command):
502
 
    """Move files to a different directory.
503
 
 
504
 
    examples:
505
 
        bzr move *.txt doc
506
 
 
507
 
    The destination must be a versioned directory in the same branch.
508
 
    """
509
 
    takes_args = ['source$', 'dest']
510
 
    def run(self, source_list, dest):
511
 
        b = find_branch('.')
512
 
 
513
 
        # TODO: glob expansion on windows?
514
 
        b.move([b.relpath(s) for s in source_list], b.relpath(dest))
515
 
 
516
 
 
517
 
class cmd_rename(Command):
518
 
    """Change the name of an entry.
519
 
 
520
 
    examples:
521
 
      bzr rename frob.c frobber.c
522
 
      bzr rename src/frob.c lib/frob.c
523
 
 
524
 
    It is an error if the destination name exists.
525
 
 
526
 
    See also the 'move' command, which moves files into a different
527
 
    directory without changing their name.
528
 
 
529
 
    TODO: Some way to rename multiple files without invoking bzr for each
530
 
    one?"""
531
 
    takes_args = ['from_name', 'to_name']
532
 
    
533
 
    def run(self, from_name, to_name):
534
 
        b = find_branch('.')
535
 
        b.rename_one(b.relpath(from_name), b.relpath(to_name))
536
 
 
537
 
 
538
 
 
539
 
class cmd_mv(Command):
540
 
    """Move or rename a file.
541
 
 
542
 
    usage:
543
 
        bzr mv OLDNAME NEWNAME
544
 
        bzr mv SOURCE... DESTINATION
545
 
 
546
 
    If the last argument is a versioned directory, all the other names
547
 
    are moved into it.  Otherwise, there must be exactly two arguments
548
 
    and the file is changed to a new name, which must not already exist.
549
 
 
550
 
    Files cannot be moved between branches.
551
 
    """
552
 
    takes_args = ['names*']
553
 
    def run(self, names_list):
554
 
        if len(names_list) < 2:
555
 
            raise BzrCommandError("missing file argument")
556
 
        b = find_branch(names_list[0])
557
 
 
558
 
        rel_names = [b.relpath(x) for x in names_list]
559
 
        
560
 
        if os.path.isdir(names_list[-1]):
561
 
            # move into existing directory
562
 
            b.move(rel_names[:-1], rel_names[-1])
563
 
        else:
564
 
            if len(names_list) != 2:
565
 
                raise BzrCommandError('to mv multiple files the destination '
566
 
                                      'must be a versioned directory')
567
 
            b.move(rel_names[0], rel_names[1])
568
 
            
569
 
    
570
 
 
571
 
 
572
 
class cmd_pull(Command):
573
 
    """Pull any changes from another branch into the current one.
574
 
 
575
 
    If the location is omitted, the last-used location will be used.
576
 
    Both the revision history and the working directory will be
577
 
    updated.
578
 
 
579
 
    This command only works on branches that have not diverged.  Branches are
580
 
    considered diverged if both branches have had commits without first
581
 
    pulling from the other.
582
 
 
583
 
    If branches have diverged, you can use 'bzr merge' to pull the text changes
584
 
    from one into the other.
585
 
    """
586
 
    takes_args = ['location?']
587
 
 
588
 
    def run(self, location=None):
589
 
        from bzrlib.merge import merge
590
 
        import tempfile
591
 
        from shutil import rmtree
592
 
        import errno
593
 
        
594
 
        br_to = find_branch('.')
595
 
        stored_loc = None
596
 
        try:
597
 
            stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
598
 
        except IOError, e:
599
 
            if e.errno != errno.ENOENT:
600
 
                raise
601
 
        if location is None:
602
 
            if stored_loc is None:
603
 
                raise BzrCommandError("No pull location known or specified.")
604
 
            else:
605
 
                print "Using last location: %s" % stored_loc
606
 
                location = stored_loc
607
 
        cache_root = tempfile.mkdtemp()
608
 
        from bzrlib.branch import DivergedBranches
609
 
        br_from = find_branch(location)
610
 
        location = pull_loc(br_from)
611
 
        old_revno = br_to.revno()
612
 
        try:
613
 
            from branch import find_cached_branch, DivergedBranches
614
 
            br_from = find_cached_branch(location, cache_root)
615
 
            location = pull_loc(br_from)
616
 
            old_revno = br_to.revno()
617
 
            try:
618
 
                br_to.update_revisions(br_from)
619
 
            except DivergedBranches:
620
 
                raise BzrCommandError("These branches have diverged."
621
 
                    "  Try merge.")
622
 
                
623
 
            merge(('.', -1), ('.', old_revno), check_clean=False)
624
 
            if location != stored_loc:
625
 
                br_to.controlfile("x-pull", "wb").write(location + "\n")
626
 
        finally:
627
 
            rmtree(cache_root)
628
 
 
629
 
 
630
 
 
631
 
class cmd_branch(Command):
632
 
    """Create a new copy of a branch.
633
 
 
634
 
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
635
 
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
636
 
 
637
 
    To retrieve the branch as of a particular revision, supply the --revision
638
 
    parameter, as in "branch foo/bar -r 5".
639
 
    """
640
 
    takes_args = ['from_location', 'to_location?']
641
 
    takes_options = ['revision']
642
 
    aliases = ['get', 'clone']
643
 
 
644
 
    def run(self, from_location, to_location=None, revision=None):
645
 
        import errno
646
 
        from bzrlib.merge import merge
647
 
        from bzrlib.branch import DivergedBranches, NoSuchRevision, \
648
 
             find_cached_branch, Branch
649
 
        from shutil import rmtree
650
 
        from meta_store import CachedStore
651
 
        import tempfile
652
 
        cache_root = tempfile.mkdtemp()
653
 
 
654
 
        if revision is None:
655
 
            revision = [None]
656
 
        elif len(revision) > 1:
657
 
            raise BzrCommandError('bzr branch --revision takes exactly 1 revision value')
658
 
 
659
 
        try:
660
 
            try:
661
 
                br_from = find_cached_branch(from_location, cache_root)
662
 
            except OSError, e:
663
 
                if e.errno == errno.ENOENT:
664
 
                    raise BzrCommandError('Source location "%s" does not'
665
 
                                          ' exist.' % to_location)
666
 
                else:
667
 
                    raise
668
 
 
669
 
            if to_location is None:
670
 
                to_location = os.path.basename(from_location.rstrip("/\\"))
671
 
 
672
 
            try:
673
 
                os.mkdir(to_location)
674
 
            except OSError, e:
675
 
                if e.errno == errno.EEXIST:
676
 
                    raise BzrCommandError('Target directory "%s" already'
677
 
                                          ' exists.' % to_location)
678
 
                if e.errno == errno.ENOENT:
679
 
                    raise BzrCommandError('Parent of "%s" does not exist.' %
680
 
                                          to_location)
681
 
                else:
682
 
                    raise
683
 
            br_to = Branch(to_location, init=True)
684
 
 
685
 
            br_to.set_root_id(br_from.get_root_id())
686
 
 
687
 
            if revision:
688
 
                if revision[0] is None:
689
 
                    revno = br_from.revno()
690
 
                else:
691
 
                    revno, rev_id = br_from.get_revision_info(revision[0])
692
 
                try:
693
 
                    br_to.update_revisions(br_from, stop_revision=revno)
694
 
                except NoSuchRevision:
695
 
                    rmtree(to_location)
696
 
                    msg = "The branch %s has no revision %d." % (from_location,
697
 
                                                                 revno)
698
 
                    raise BzrCommandError(msg)
699
 
            
700
 
            merge((to_location, -1), (to_location, 0), this_dir=to_location,
701
 
                  check_clean=False, ignore_zero=True)
702
 
            from_location = pull_loc(br_from)
703
 
            br_to.controlfile("x-pull", "wb").write(from_location + "\n")
704
 
        finally:
705
 
            rmtree(cache_root)
706
 
 
707
 
 
708
 
def pull_loc(branch):
709
 
    # TODO: Should perhaps just make attribute be 'base' in
710
 
    # RemoteBranch and Branch?
711
 
    if hasattr(branch, "baseurl"):
712
 
        return branch.baseurl
713
 
    else:
714
 
        return branch.base
715
 
 
716
 
 
717
 
 
718
 
class cmd_renames(Command):
719
 
    """Show list of renamed files.
720
 
 
721
 
    TODO: Option to show renames between two historical versions.
722
 
 
723
 
    TODO: Only show renames under dir, rather than in the whole branch.
724
 
    """
725
 
    takes_args = ['dir?']
726
 
 
727
 
    def run(self, dir='.'):
728
 
        b = find_branch(dir)
729
 
        old_inv = b.basis_tree().inventory
730
 
        new_inv = b.read_working_inventory()
731
 
 
732
 
        renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
733
 
        renames.sort()
734
 
        for old_name, new_name in renames:
735
 
            print "%s => %s" % (old_name, new_name)        
736
 
 
737
 
 
738
 
class cmd_info(Command):
739
 
    """Show statistical information about a branch."""
740
 
    takes_args = ['branch?']
741
 
    
742
 
    def run(self, branch=None):
743
 
        import info
744
 
 
745
 
        b = find_branch(branch)
746
 
        info.show_info(b)
747
 
 
748
 
 
749
 
class cmd_remove(Command):
750
 
    """Make a file unversioned.
751
 
 
752
 
    This makes bzr stop tracking changes to a versioned file.  It does
753
 
    not delete the working copy.
754
 
    """
755
 
    takes_args = ['file+']
756
 
    takes_options = ['verbose']
757
 
    
758
 
    def run(self, file_list, verbose=False):
759
 
        b = find_branch(file_list[0])
760
 
        b.remove([b.relpath(f) for f in file_list], verbose=verbose)
761
 
 
762
 
 
763
 
class cmd_file_id(Command):
764
 
    """Print file_id of a particular file or directory.
765
 
 
766
 
    The file_id is assigned when the file is first added and remains the
767
 
    same through all revisions where the file exists, even when it is
768
 
    moved or renamed.
769
 
    """
770
 
    hidden = True
771
 
    takes_args = ['filename']
772
 
    def run(self, filename):
773
 
        b = find_branch(filename)
774
 
        i = b.inventory.path2id(b.relpath(filename))
775
 
        if i == None:
776
 
            raise BzrError("%r is not a versioned file" % filename)
777
 
        else:
778
 
            print i
779
 
 
780
 
 
781
 
class cmd_file_path(Command):
782
 
    """Print path of file_ids to a file or directory.
783
 
 
784
 
    This prints one line for each directory down to the target,
785
 
    starting at the branch root."""
786
 
    hidden = True
787
 
    takes_args = ['filename']
788
 
    def run(self, filename):
789
 
        b = find_branch(filename)
790
 
        inv = b.inventory
791
 
        fid = inv.path2id(b.relpath(filename))
792
 
        if fid == None:
793
 
            raise BzrError("%r is not a versioned file" % filename)
794
 
        for fip in inv.get_idpath(fid):
795
 
            print fip
796
 
 
797
 
 
798
 
class cmd_revision_history(Command):
799
 
    """Display list of revision ids on this branch."""
800
 
    hidden = True
801
 
    def run(self):
802
 
        for patchid in find_branch('.').revision_history():
803
 
            print patchid
804
 
 
805
 
 
806
 
class cmd_directories(Command):
807
 
    """Display list of versioned directories in this branch."""
808
 
    def run(self):
809
 
        for name, ie in find_branch('.').read_working_inventory().directories():
810
 
            if name == '':
811
 
                print '.'
812
 
            else:
813
 
                print name
814
 
 
815
 
 
816
 
class cmd_init(Command):
817
 
    """Make a directory into a versioned branch.
818
 
 
819
 
    Use this to create an empty branch, or before importing an
820
 
    existing project.
821
 
 
822
 
    Recipe for importing a tree of files:
823
 
        cd ~/project
824
 
        bzr init
825
 
        bzr add -v .
826
 
        bzr status
827
 
        bzr commit -m 'imported project'
828
 
    """
829
 
    def run(self):
830
 
        from bzrlib.branch import Branch
831
 
        Branch('.', init=True)
832
 
 
833
 
 
834
 
class cmd_diff(Command):
835
 
    """Show differences in working tree.
836
 
    
837
 
    If files are listed, only the changes in those files are listed.
838
 
    Otherwise, all changes for the tree are listed.
839
 
 
840
 
    TODO: Given two revision arguments, show the difference between them.
841
 
 
842
 
    TODO: Allow diff across branches.
843
 
 
844
 
    TODO: Option to use external diff command; could be GNU diff, wdiff,
845
 
          or a graphical diff.
846
 
 
847
 
    TODO: Python difflib is not exactly the same as unidiff; should
848
 
          either fix it up or prefer to use an external diff.
849
 
 
850
 
    TODO: If a directory is given, diff everything under that.
851
 
 
852
 
    TODO: Selected-file diff is inefficient and doesn't show you
853
 
          deleted files.
854
 
 
855
 
    TODO: This probably handles non-Unix newlines poorly.
856
 
    """
857
 
    
858
 
    takes_args = ['file*']
859
 
    takes_options = ['revision', 'diff-options']
860
 
    aliases = ['di', 'dif']
861
 
 
862
 
    def run(self, revision=None, file_list=None, diff_options=None):
863
 
        from bzrlib.diff import show_diff
864
 
 
865
 
        if file_list:
866
 
            b = find_branch(file_list[0])
867
 
            file_list = [b.relpath(f) for f in file_list]
868
 
            if file_list == ['']:
869
 
                # just pointing to top-of-tree
870
 
                file_list = None
871
 
        else:
872
 
            b = find_branch('.')
873
 
 
874
 
        # TODO: Make show_diff support taking 2 arguments
875
 
        base_rev = None
876
 
        if revision is not None:
877
 
            if len(revision) != 1:
878
 
                raise BzrCommandError('bzr diff --revision takes exactly one revision identifier')
879
 
            base_rev = revision[0]
880
 
    
881
 
        show_diff(b, base_rev, specific_files=file_list,
882
 
                  external_diff_options=diff_options)
883
 
 
884
 
 
885
 
        
886
 
 
887
 
 
888
 
class cmd_deleted(Command):
889
 
    """List files deleted in the working tree.
890
 
 
891
 
    TODO: Show files deleted since a previous revision, or between two revisions.
892
 
    """
893
 
    def run(self, show_ids=False):
894
 
        b = find_branch('.')
895
 
        old = b.basis_tree()
896
 
        new = b.working_tree()
897
 
 
898
 
        ## TODO: Much more efficient way to do this: read in new
899
 
        ## directories with readdir, rather than stating each one.  Same
900
 
        ## level of effort but possibly much less IO.  (Or possibly not,
901
 
        ## if the directories are very large...)
902
 
 
903
 
        for path, ie in old.inventory.iter_entries():
904
 
            if not new.has_id(ie.file_id):
905
 
                if show_ids:
906
 
                    print '%-50s %s' % (path, ie.file_id)
907
 
                else:
908
 
                    print path
909
 
 
910
 
 
911
 
class cmd_modified(Command):
912
 
    """List files modified in working tree."""
913
 
    hidden = True
914
 
    def run(self):
915
 
        from bzrlib.delta import compare_trees
916
 
 
917
 
        b = find_branch('.')
918
 
        td = compare_trees(b.basis_tree(), b.working_tree())
919
 
 
920
 
        for path, id, kind in td.modified:
921
 
            print path
922
 
 
923
 
 
924
 
 
925
 
class cmd_added(Command):
926
 
    """List files added in working tree."""
927
 
    hidden = True
928
 
    def run(self):
929
 
        b = find_branch('.')
930
 
        wt = b.working_tree()
931
 
        basis_inv = b.basis_tree().inventory
932
 
        inv = wt.inventory
933
 
        for file_id in inv:
934
 
            if file_id in basis_inv:
935
 
                continue
936
 
            path = inv.id2path(file_id)
937
 
            if not os.access(b.abspath(path), os.F_OK):
938
 
                continue
939
 
            print path
940
 
                
941
 
        
942
 
 
943
 
class cmd_root(Command):
944
 
    """Show the tree root directory.
945
 
 
946
 
    The root is the nearest enclosing directory with a .bzr control
947
 
    directory."""
948
 
    takes_args = ['filename?']
949
 
    def run(self, filename=None):
950
 
        """Print the branch root."""
951
 
        b = find_branch(filename)
952
 
        print getattr(b, 'base', None) or getattr(b, 'baseurl')
953
 
 
954
 
 
955
 
class cmd_log(Command):
956
 
    """Show log of this branch.
957
 
 
958
 
    To request a range of logs, you can use the command -r begin:end
959
 
    -r revision requests a specific revision, -r :end or -r begin: are
960
 
    also valid.
961
 
 
962
 
    --message allows you to give a regular expression, which will be evaluated
963
 
    so that only matching entries will be displayed.
964
 
 
965
 
    TODO: Make --revision support uuid: and hash: [future tag:] notation.
966
 
  
967
 
    """
968
 
 
969
 
    takes_args = ['filename?']
970
 
    takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision','long', 'message']
971
 
    
972
 
    def run(self, filename=None, timezone='original',
973
 
            verbose=False,
974
 
            show_ids=False,
975
 
            forward=False,
976
 
            revision=None,
977
 
            message=None,
978
 
            long=False):
979
 
        from bzrlib.branch import find_branch
980
 
        from bzrlib.log import log_formatter, show_log
981
 
        import codecs
982
 
 
983
 
        direction = (forward and 'forward') or 'reverse'
984
 
        
985
 
        if filename:
986
 
            b = find_branch(filename)
987
 
            fp = b.relpath(filename)
988
 
            if fp:
989
 
                file_id = b.read_working_inventory().path2id(fp)
990
 
            else:
991
 
                file_id = None  # points to branch root
992
 
        else:
993
 
            b = find_branch('.')
994
 
            file_id = None
995
 
 
996
 
        if revision is None:
997
 
            rev1 = None
998
 
            rev2 = None
999
 
        elif len(revision) == 1:
1000
 
            rev1 = rev2 = b.get_revision_info(revision[0])[0]
1001
 
        elif len(revision) == 2:
1002
 
            rev1 = b.get_revision_info(revision[0])[0]
1003
 
            rev2 = b.get_revision_info(revision[1])[0]
1004
 
        else:
1005
 
            raise BzrCommandError('bzr log --revision takes one or two values.')
1006
 
 
1007
 
        if rev1 == 0:
1008
 
            rev1 = None
1009
 
        if rev2 == 0:
1010
 
            rev2 = None
1011
 
 
1012
 
        mutter('encoding log as %r' % bzrlib.user_encoding)
1013
 
 
1014
 
        # use 'replace' so that we don't abort if trying to write out
1015
 
        # in e.g. the default C locale.
1016
 
        outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
1017
 
 
1018
 
        if long:
1019
 
            log_format = 'long'
1020
 
        else:
1021
 
            log_format = 'short'
1022
 
        lf = log_formatter(log_format,
1023
 
                           show_ids=show_ids,
1024
 
                           to_file=outf,
1025
 
                           show_timezone=timezone)
1026
 
 
1027
 
        show_log(b,
1028
 
                 lf,
1029
 
                 file_id,
1030
 
                 verbose=verbose,
1031
 
                 direction=direction,
1032
 
                 start_revision=rev1,
1033
 
                 end_revision=rev2,
1034
 
                 search=message)
1035
 
 
1036
 
 
1037
 
 
1038
 
class cmd_touching_revisions(Command):
1039
 
    """Return revision-ids which affected a particular file.
1040
 
 
1041
 
    A more user-friendly interface is "bzr log FILE"."""
1042
 
    hidden = True
1043
 
    takes_args = ["filename"]
1044
 
    def run(self, filename):
1045
 
        b = find_branch(filename)
1046
 
        inv = b.read_working_inventory()
1047
 
        file_id = inv.path2id(b.relpath(filename))
1048
 
        for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
1049
 
            print "%6d %s" % (revno, what)
1050
 
 
1051
 
 
1052
 
class cmd_ls(Command):
1053
 
    """List files in a tree.
1054
 
 
1055
 
    TODO: Take a revision or remote path and list that tree instead.
1056
 
    """
1057
 
    hidden = True
1058
 
    def run(self, revision=None, verbose=False):
1059
 
        b = find_branch('.')
1060
 
        if revision == None:
1061
 
            tree = b.working_tree()
1062
 
        else:
1063
 
            tree = b.revision_tree(b.lookup_revision(revision))
1064
 
 
1065
 
        for fp, fc, kind, fid in tree.list_files():
1066
 
            if verbose:
1067
 
                if kind == 'directory':
1068
 
                    kindch = '/'
1069
 
                elif kind == 'file':
1070
 
                    kindch = ''
1071
 
                else:
1072
 
                    kindch = '???'
1073
 
 
1074
 
                print '%-8s %s%s' % (fc, fp, kindch)
1075
 
            else:
1076
 
                print fp
1077
 
 
1078
 
 
1079
 
 
1080
 
class cmd_unknowns(Command):
1081
 
    """List unknown files."""
1082
 
    def run(self):
1083
 
        from bzrlib.osutils import quotefn
1084
 
        for f in find_branch('.').unknowns():
1085
 
            print quotefn(f)
1086
 
 
1087
 
 
1088
 
 
1089
 
class cmd_ignore(Command):
1090
 
    """Ignore a command or pattern.
1091
 
 
1092
 
    To remove patterns from the ignore list, edit the .bzrignore file.
1093
 
 
1094
 
    If the pattern contains a slash, it is compared to the whole path
1095
 
    from the branch root.  Otherwise, it is comapred to only the last
1096
 
    component of the path.
1097
 
 
1098
 
    Ignore patterns are case-insensitive on case-insensitive systems.
1099
 
 
1100
 
    Note: wildcards must be quoted from the shell on Unix.
1101
 
 
1102
 
    examples:
1103
 
        bzr ignore ./Makefile
1104
 
        bzr ignore '*.class'
1105
 
    """
1106
 
    takes_args = ['name_pattern']
1107
 
    
1108
 
    def run(self, name_pattern):
1109
 
        from bzrlib.atomicfile import AtomicFile
1110
 
        import os.path
1111
 
 
1112
 
        b = find_branch('.')
1113
 
        ifn = b.abspath('.bzrignore')
1114
 
 
1115
 
        if os.path.exists(ifn):
1116
 
            f = open(ifn, 'rt')
1117
 
            try:
1118
 
                igns = f.read().decode('utf-8')
1119
 
            finally:
1120
 
                f.close()
1121
 
        else:
1122
 
            igns = ''
1123
 
 
1124
 
        # TODO: If the file already uses crlf-style termination, maybe
1125
 
        # we should use that for the newly added lines?
1126
 
 
1127
 
        if igns and igns[-1] != '\n':
1128
 
            igns += '\n'
1129
 
        igns += name_pattern + '\n'
1130
 
 
1131
 
        try:
1132
 
            f = AtomicFile(ifn, 'wt')
1133
 
            f.write(igns.encode('utf-8'))
1134
 
            f.commit()
1135
 
        finally:
1136
 
            f.close()
1137
 
 
1138
 
        inv = b.working_tree().inventory
1139
 
        if inv.path2id('.bzrignore'):
1140
 
            mutter('.bzrignore is already versioned')
1141
 
        else:
1142
 
            mutter('need to make new .bzrignore file versioned')
1143
 
            b.add(['.bzrignore'])
1144
 
 
1145
 
 
1146
 
 
1147
 
class cmd_ignored(Command):
1148
 
    """List ignored files and the patterns that matched them.
1149
 
 
1150
 
    See also: bzr ignore"""
1151
 
    def run(self):
1152
 
        tree = find_branch('.').working_tree()
1153
 
        for path, file_class, kind, file_id in tree.list_files():
1154
 
            if file_class != 'I':
1155
 
                continue
1156
 
            ## XXX: Slightly inefficient since this was already calculated
1157
 
            pat = tree.is_ignored(path)
1158
 
            print '%-50s %s' % (path, pat)
1159
 
 
1160
 
 
1161
 
class cmd_lookup_revision(Command):
1162
 
    """Lookup the revision-id from a revision-number
1163
 
 
1164
 
    example:
1165
 
        bzr lookup-revision 33
1166
 
    """
1167
 
    hidden = True
1168
 
    takes_args = ['revno']
1169
 
    
1170
 
    def run(self, revno):
1171
 
        try:
1172
 
            revno = int(revno)
1173
 
        except ValueError:
1174
 
            raise BzrCommandError("not a valid revision-number: %r" % revno)
1175
 
 
1176
 
        print find_branch('.').lookup_revision(revno)
1177
 
 
1178
 
 
1179
 
class cmd_export(Command):
1180
 
    """Export past revision to destination directory.
1181
 
 
1182
 
    If no revision is specified this exports the last committed revision.
1183
 
 
1184
 
    Format may be an "exporter" name, such as tar, tgz, tbz2.  If none is
1185
 
    given, try to find the format with the extension. If no extension
1186
 
    is found exports to a directory (equivalent to --format=dir).
1187
 
 
1188
 
    Root may be the top directory for tar, tgz and tbz2 formats. If none
1189
 
    is given, the top directory will be the root name of the file."""
1190
 
    # TODO: list known exporters
1191
 
    takes_args = ['dest']
1192
 
    takes_options = ['revision', 'format', 'root']
1193
 
    def run(self, dest, revision=None, format=None, root=None):
1194
 
        import os.path
1195
 
        b = find_branch('.')
1196
 
        if revision is None:
1197
 
            rev_id = b.last_patch()
1198
 
        else:
1199
 
            if len(revision) != 1:
1200
 
                raise BzrError('bzr export --revision takes exactly 1 argument')
1201
 
            revno, rev_id = b.get_revision_info(revision[0])
1202
 
        t = b.revision_tree(rev_id)
1203
 
        root, ext = os.path.splitext(dest)
1204
 
        if not format:
1205
 
            if ext in (".tar",):
1206
 
                format = "tar"
1207
 
            elif ext in (".gz", ".tgz"):
1208
 
                format = "tgz"
1209
 
            elif ext in (".bz2", ".tbz2"):
1210
 
                format = "tbz2"
1211
 
            else:
1212
 
                format = "dir"
1213
 
        t.export(dest, format, root)
1214
 
 
1215
 
 
1216
 
class cmd_cat(Command):
1217
 
    """Write a file's text from a previous revision."""
1218
 
 
1219
 
    takes_options = ['revision']
1220
 
    takes_args = ['filename']
1221
 
 
1222
 
    def run(self, filename, revision=None):
1223
 
        if revision == None:
1224
 
            raise BzrCommandError("bzr cat requires a revision number")
1225
 
        elif len(revision) != 1:
1226
 
            raise BzrCommandError("bzr cat --revision takes exactly one number")
1227
 
        b = find_branch('.')
1228
 
        b.print_file(b.relpath(filename), revision[0])
1229
 
 
1230
 
 
1231
 
class cmd_local_time_offset(Command):
1232
 
    """Show the offset in seconds from GMT to local time."""
1233
 
    hidden = True    
1234
 
    def run(self):
1235
 
        print bzrlib.osutils.local_time_offset()
1236
 
 
1237
 
 
1238
 
 
1239
 
class cmd_commit(Command):
1240
 
    """Commit changes into a new revision.
1241
 
    
1242
 
    If no arguments are given, the entire tree is committed.
1243
 
 
1244
 
    If selected files are specified, only changes to those files are
1245
 
    committed.  If a directory is specified then the directory and everything 
1246
 
    within it is committed.
1247
 
 
1248
 
    A selected-file commit may fail in some cases where the committed
1249
 
    tree would be invalid, such as trying to commit a file in a
1250
 
    newly-added directory that is not itself committed.
1251
 
 
1252
 
    TODO: Run hooks on tree to-be-committed, and after commit.
1253
 
 
1254
 
    TODO: Strict commit that fails if there are unknown or deleted files.
1255
 
    """
1256
 
    takes_args = ['selected*']
1257
 
    takes_options = ['message', 'file', 'verbose', 'unchanged']
1258
 
    aliases = ['ci', 'checkin']
1259
 
 
1260
 
    # TODO: Give better message for -s, --summary, used by tla people
1261
 
    
1262
 
    def run(self, message=None, file=None, verbose=True, selected_list=None,
1263
 
            unchanged=False):
1264
 
        from bzrlib.errors import PointlessCommit
1265
 
        from bzrlib.osutils import get_text_message
1266
 
 
1267
 
        ## Warning: shadows builtin file()
1268
 
        if not message and not file:
1269
 
            # FIXME: Ugly; change status code to send to a provided function?
1270
 
            
1271
 
            import cStringIO
1272
 
            stdout = sys.stdout
1273
 
            catcher = cStringIO.StringIO()
1274
 
            sys.stdout = catcher
1275
 
            cmd_status({"file_list":selected_list}, {})
1276
 
            info = catcher.getvalue()
1277
 
            sys.stdout = stdout
1278
 
            message = get_text_message(info)
1279
 
            
1280
 
            if message is None:
1281
 
                raise BzrCommandError("please specify a commit message",
1282
 
                                      ["use either --message or --file"])
1283
 
        elif message and file:
1284
 
            raise BzrCommandError("please specify either --message or --file")
1285
 
        
1286
 
        if file:
1287
 
            import codecs
1288
 
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1289
 
 
1290
 
        b = find_branch('.')
1291
 
        if selected_list:
1292
 
            selected_list = [b.relpath(s) for s in selected_list]
1293
 
            
1294
 
        try:
1295
 
            b.commit(message, verbose=verbose,
1296
 
                     specific_files=selected_list,
1297
 
                     allow_pointless=unchanged)
1298
 
        except PointlessCommit:
1299
 
            # FIXME: This should really happen before the file is read in;
1300
 
            # perhaps prepare the commit; get the message; then actually commit
1301
 
            raise BzrCommandError("no changes to commit",
1302
 
                                  ["use --unchanged to commit anyhow"])
1303
 
 
1304
 
 
1305
 
class cmd_check(Command):
1306
 
    """Validate consistency of branch history.
1307
 
 
1308
 
    This command checks various invariants about the branch storage to
1309
 
    detect data corruption or bzr bugs.
1310
 
 
1311
 
    If given the --update flag, it will update some optional fields
1312
 
    to help ensure data consistency.
1313
 
    """
1314
 
    takes_args = ['dir?']
1315
 
 
1316
 
    def run(self, dir='.'):
1317
 
        from bzrlib.check import check
1318
 
        check(find_branch(dir))
1319
 
 
1320
 
 
1321
 
 
1322
 
class cmd_scan_cache(Command):
1323
 
    hidden = True
1324
 
    def run(self):
1325
 
        from bzrlib.hashcache import HashCache
1326
 
        import os
1327
 
 
1328
 
        c = HashCache('.')
1329
 
        c.read()
1330
 
        c.scan()
1331
 
            
1332
 
        print '%6d stats' % c.stat_count
1333
 
        print '%6d in hashcache' % len(c._cache)
1334
 
        print '%6d files removed from cache' % c.removed_count
1335
 
        print '%6d hashes updated' % c.update_count
1336
 
        print '%6d files changed too recently to cache' % c.danger_count
1337
 
 
1338
 
        if c.needs_write:
1339
 
            c.write()
1340
 
            
1341
 
 
1342
 
 
1343
 
class cmd_upgrade(Command):
1344
 
    """Upgrade branch storage to current format.
1345
 
 
1346
 
    This should normally be used only after the check command tells
1347
 
    you to run it.
1348
 
    """
1349
 
    takes_args = ['dir?']
1350
 
 
1351
 
    def run(self, dir='.'):
1352
 
        from bzrlib.upgrade import upgrade
1353
 
        upgrade(find_branch(dir))
1354
 
 
1355
 
 
1356
 
 
1357
 
class cmd_whoami(Command):
1358
 
    """Show bzr user id."""
1359
 
    takes_options = ['email']
1360
 
    
1361
 
    def run(self, email=False):
1362
 
        if email:
1363
 
            print bzrlib.osutils.user_email()
1364
 
        else:
1365
 
            print bzrlib.osutils.username()
1366
 
 
1367
 
 
1368
 
class cmd_selftest(Command):
1369
 
    """Run internal test suite"""
1370
 
    hidden = True
1371
 
    takes_options = ['verbose']
1372
 
    def run(self, verbose=False):
1373
 
        from bzrlib.selftest import selftest
1374
 
        return int(not selftest(verbose=verbose))
1375
 
 
1376
 
 
1377
 
class cmd_version(Command):
1378
 
    """Show version of bzr."""
1379
 
    def run(self):
1380
 
        show_version()
1381
 
 
1382
 
def show_version():
1383
 
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
1384
 
    # is bzrlib itself in a branch?
1385
 
    bzrrev = bzrlib.get_bzr_revision()
1386
 
    if bzrrev:
1387
 
        print "  (bzr checkout, revision %d {%s})" % bzrrev
1388
 
    print bzrlib.__copyright__
1389
 
    print "http://bazaar-ng.org/"
1390
 
    print
1391
 
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
1392
 
    print "you may use, modify and redistribute it under the terms of the GNU"
1393
 
    print "General Public License version 2 or later."
1394
 
 
1395
 
 
1396
 
class cmd_rocks(Command):
1397
 
    """Statement of optimism."""
1398
 
    hidden = True
1399
 
    def run(self):
1400
 
        print "it sure does!"
1401
 
 
1402
 
def parse_spec(spec):
1403
 
    """
1404
 
    >>> parse_spec(None)
1405
 
    [None, None]
1406
 
    >>> parse_spec("./")
1407
 
    ['./', None]
1408
 
    >>> parse_spec("../@")
1409
 
    ['..', -1]
1410
 
    >>> parse_spec("../f/@35")
1411
 
    ['../f', 35]
1412
 
    >>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
1413
 
    ['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
1414
 
    """
1415
 
    if spec is None:
1416
 
        return [None, None]
1417
 
    if '/@' in spec:
1418
 
        parsed = spec.split('/@')
1419
 
        assert len(parsed) == 2
1420
 
        if parsed[1] == "":
1421
 
            parsed[1] = -1
1422
 
        else:
1423
 
            try:
1424
 
                parsed[1] = int(parsed[1])
1425
 
            except ValueError:
1426
 
                pass # We can allow stuff like ./@revid:blahblahblah
1427
 
            else:
1428
 
                assert parsed[1] >=0
1429
 
    else:
1430
 
        parsed = [spec, None]
1431
 
    return parsed
1432
 
 
1433
 
 
1434
 
 
1435
 
class cmd_merge(Command):
1436
 
    """Perform a three-way merge of trees.
1437
 
    
1438
 
    The SPEC parameters are working tree or revision specifiers.  Working trees
1439
 
    are specified using standard paths or urls.  No component of a directory
1440
 
    path may begin with '@'.
1441
 
    
1442
 
    Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1443
 
 
1444
 
    Revisions are specified using a dirname/@revno pair, where dirname is the
1445
 
    branch directory and revno is the revision within that branch.  If no revno
1446
 
    is specified, the latest revision is used.
1447
 
 
1448
 
    Revision examples: './@127', 'foo/@', '../@1'
1449
 
 
1450
 
    The OTHER_SPEC parameter is required.  If the BASE_SPEC parameter is
1451
 
    not supplied, the common ancestor of OTHER_SPEC the current branch is used
1452
 
    as the BASE.
1453
 
 
1454
 
    merge refuses to run if there are any uncommitted changes, unless
1455
 
    --force is given.
1456
 
    """
1457
 
    takes_args = ['other_spec', 'base_spec?']
1458
 
    takes_options = ['force', 'merge-type']
1459
 
 
1460
 
    def run(self, other_spec, base_spec=None, force=False, merge_type=None):
1461
 
        from bzrlib.merge import merge
1462
 
        from bzrlib.merge_core import ApplyMerge3
1463
 
        if merge_type is None:
1464
 
            merge_type = ApplyMerge3
1465
 
        merge(parse_spec(other_spec), parse_spec(base_spec),
1466
 
              check_clean=(not force), merge_type=merge_type)
1467
 
 
1468
 
 
1469
 
class cmd_revert(Command):
1470
 
    """Reverse all changes since the last commit.
1471
 
 
1472
 
    Only versioned files are affected.  Specify filenames to revert only 
1473
 
    those files.  By default, any files that are changed will be backed up
1474
 
    first.  Backup files have a '~' appended to their name.
1475
 
    """
1476
 
    takes_options = ['revision', 'no-backup']
1477
 
    takes_args = ['file*']
1478
 
    aliases = ['merge-revert']
1479
 
 
1480
 
    def run(self, revision=None, no_backup=False, file_list=None):
1481
 
        from bzrlib.merge import merge
1482
 
        if file_list is not None:
1483
 
            if len(file_list) == 0:
1484
 
                raise BzrCommandError("No files specified")
1485
 
        if revision is None:
1486
 
            revision = [-1]
1487
 
        elif len(revision) != 1:
1488
 
            raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
1489
 
        merge(('.', revision[0]), parse_spec('.'),
1490
 
              check_clean=False,
1491
 
              ignore_zero=True,
1492
 
              backup_files=not no_backup,
1493
 
              file_list=file_list)
1494
 
 
1495
 
 
1496
 
class cmd_assert_fail(Command):
1497
 
    """Test reporting of assertion failures"""
1498
 
    hidden = True
1499
 
    def run(self):
1500
 
        assert False, "always fails"
1501
 
 
1502
 
 
1503
 
class cmd_help(Command):
1504
 
    """Show help on a command or other topic.
1505
 
 
1506
 
    For a list of all available commands, say 'bzr help commands'."""
1507
 
    takes_args = ['topic?']
1508
 
    aliases = ['?']
1509
 
    
1510
 
    def run(self, topic=None):
1511
 
        import help
1512
 
        help.help(topic)
1513
 
 
1514
 
 
1515
 
 
1516
 
 
1517
 
class cmd_plugins(Command):
1518
 
    """List plugins"""
1519
 
    hidden = True
1520
 
    def run(self):
1521
 
        import bzrlib.plugin
 
572
        raise NotImplementedError('no implementation of command %r'
 
573
                                  % self.name())
 
574
 
 
575
    def help(self):
 
576
        """Return help message for this class."""
1522
577
        from inspect import getdoc
1523
 
        from pprint import pprint
1524
 
        for plugin in bzrlib.plugin.all_plugins:
1525
 
            print plugin.__path__[0]
1526
 
            d = getdoc(plugin)
1527
 
            if d:
1528
 
                print '\t', d.split('\n')[0]
1529
 
 
1530
 
        #pprint(bzrlib.plugin.all_plugins)
1531
 
 
1532
 
 
1533
 
 
1534
 
# list of all available options; the rhs can be either None for an
1535
 
# option that takes no argument, or a constructor function that checks
1536
 
# the type.
1537
 
OPTIONS = {
1538
 
    'all':                    None,
1539
 
    'diff-options':           str,
1540
 
    'help':                   None,
1541
 
    'file':                   unicode,
1542
 
    'force':                  None,
1543
 
    'format':                 unicode,
1544
 
    'forward':                None,
1545
 
    'message':                unicode,
1546
 
    'no-recurse':             None,
1547
 
    'profile':                None,
1548
 
    'revision':               _parse_revision_str,
1549
 
    'show-ids':               None,
1550
 
    'timezone':               str,
1551
 
    'verbose':                None,
1552
 
    'version':                None,
1553
 
    'email':                  None,
1554
 
    'unchanged':              None,
1555
 
    'update':                 None,
1556
 
    'long':                   None,
1557
 
    'root':                   str,
1558
 
    'no-backup':              None,
1559
 
    'merge-type':             get_merge_type,
1560
 
    }
1561
 
 
1562
 
SHORT_OPTIONS = {
1563
 
    'F':                      'file', 
1564
 
    'h':                      'help',
1565
 
    'm':                      'message',
1566
 
    'r':                      'revision',
1567
 
    'v':                      'verbose',
1568
 
    'l':                      'long',
1569
 
}
1570
 
 
1571
 
 
1572
 
def parse_args(argv):
 
578
        if self.__doc__ is Command.__doc__:
 
579
            return None
 
580
        return getdoc(self)
 
581
 
 
582
    def name(self):
 
583
        return _unsquish_command_name(self.__class__.__name__)
 
584
 
 
585
    def plugin_name(self):
 
586
        """Get the name of the plugin that provides this command.
 
587
 
 
588
        :return: The name of the plugin or None if the command is builtin.
 
589
        """
 
590
        mod_parts = self.__module__.split('.')
 
591
        if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
 
592
            return mod_parts[2]
 
593
        else:
 
594
            return None
 
595
 
 
596
 
 
597
class CommandHooks(Hooks):
 
598
    """Hooks related to Command object creation/enumeration."""
 
599
 
 
600
    def __init__(self):
 
601
        """Create the default hooks.
 
602
 
 
603
        These are all empty initially, because by default nothing should get
 
604
        notified.
 
605
        """
 
606
        Hooks.__init__(self)
 
607
        self.create_hook(HookPoint('extend_command',
 
608
            "Called after creating a command object to allow modifications "
 
609
            "such as adding or removing options, docs etc. Called with the "
 
610
            "new bzrlib.commands.Command object.", (1, 13), None))
 
611
 
 
612
Command.hooks = CommandHooks()
 
613
 
 
614
 
 
615
def parse_args(command, argv, alias_argv=None):
1573
616
    """Parse command line.
1574
 
    
 
617
 
1575
618
    Arguments and options are parsed at this level before being passed
1576
619
    down to specific command handlers.  This routine knows, from a
1577
620
    lookup table, something about the available options, what optargs
1578
621
    they take, and which commands will accept them.
1579
 
 
1580
 
    >>> parse_args('--help'.split())
1581
 
    ([], {'help': True})
1582
 
    >>> parse_args('--version'.split())
1583
 
    ([], {'version': True})
1584
 
    >>> parse_args('status --all'.split())
1585
 
    (['status'], {'all': True})
1586
 
    >>> parse_args('commit --message=biter'.split())
1587
 
    (['commit'], {'message': u'biter'})
1588
 
    >>> parse_args('log -r 500'.split())
1589
 
    (['log'], {'revision': [500]})
1590
 
    >>> parse_args('log -r500..600'.split())
1591
 
    (['log'], {'revision': [500, 600]})
1592
 
    >>> parse_args('log -vr500..600'.split())
1593
 
    (['log'], {'verbose': True, 'revision': [500, 600]})
1594
 
    >>> parse_args('log -rv500..600'.split()) #the r takes an argument
1595
 
    (['log'], {'revision': ['v500', 600]})
1596
622
    """
1597
 
    args = []
1598
 
    opts = {}
1599
 
 
1600
 
    # TODO: Maybe handle '--' to end options?
1601
 
 
1602
 
    while argv:
1603
 
        a = argv.pop(0)
1604
 
        if a[0] == '-':
1605
 
            # option names must not be unicode
1606
 
            a = str(a)
1607
 
            optarg = None
1608
 
            if a[1] == '-':
1609
 
                mutter("  got option %r" % a)
1610
 
                if '=' in a:
1611
 
                    optname, optarg = a[2:].split('=', 1)
1612
 
                else:
1613
 
                    optname = a[2:]
1614
 
                if optname not in OPTIONS:
1615
 
                    raise BzrError('unknown long option %r' % a)
1616
 
            else:
1617
 
                shortopt = a[1:]
1618
 
                if shortopt in SHORT_OPTIONS:
1619
 
                    # Multi-character options must have a space to delimit
1620
 
                    # their value
1621
 
                    optname = SHORT_OPTIONS[shortopt]
1622
 
                else:
1623
 
                    # Single character short options, can be chained,
1624
 
                    # and have their value appended to their name
1625
 
                    shortopt = a[1:2]
1626
 
                    if shortopt not in SHORT_OPTIONS:
1627
 
                        # We didn't find the multi-character name, and we
1628
 
                        # didn't find the single char name
1629
 
                        raise BzrError('unknown short option %r' % a)
1630
 
                    optname = SHORT_OPTIONS[shortopt]
1631
 
 
1632
 
                    if a[2:]:
1633
 
                        # There are extra things on this option
1634
 
                        # see if it is the value, or if it is another
1635
 
                        # short option
1636
 
                        optargfn = OPTIONS[optname]
1637
 
                        if optargfn is None:
1638
 
                            # This option does not take an argument, so the
1639
 
                            # next entry is another short option, pack it back
1640
 
                            # into the list
1641
 
                            argv.insert(0, '-' + a[2:])
1642
 
                        else:
1643
 
                            # This option takes an argument, so pack it
1644
 
                            # into the array
1645
 
                            optarg = a[2:]
1646
 
            
1647
 
            if optname in opts:
1648
 
                # XXX: Do we ever want to support this, e.g. for -r?
1649
 
                raise BzrError('repeated option %r' % a)
1650
 
                
1651
 
            optargfn = OPTIONS[optname]
1652
 
            if optargfn:
1653
 
                if optarg == None:
1654
 
                    if not argv:
1655
 
                        raise BzrError('option %r needs an argument' % a)
1656
 
                    else:
1657
 
                        optarg = argv.pop(0)
1658
 
                opts[optname] = optargfn(optarg)
1659
 
            else:
1660
 
                if optarg != None:
1661
 
                    raise BzrError('option %r takes no argument' % optname)
1662
 
                opts[optname] = True
1663
 
        else:
1664
 
            args.append(a)
1665
 
 
 
623
    # TODO: make it a method of the Command?
 
624
    parser = option.get_optparser(command.options())
 
625
    if alias_argv is not None:
 
626
        args = alias_argv + argv
 
627
    else:
 
628
        args = argv
 
629
 
 
630
    options, args = parser.parse_args(args)
 
631
    opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
 
632
                 v is not option.OptionParser.DEFAULT_VALUE])
1666
633
    return args, opts
1667
634
 
1668
635
 
1669
 
 
1670
 
 
1671
636
def _match_argform(cmd, takes_args, args):
1672
637
    argdict = {}
1673
638
 
1685
650
                argdict[argname + '_list'] = None
1686
651
        elif ap[-1] == '+':
1687
652
            if not args:
1688
 
                raise BzrCommandError("command %r needs one or more %s"
1689
 
                        % (cmd, argname.upper()))
 
653
                raise errors.BzrCommandError("command %r needs one or more %s"
 
654
                                             % (cmd, argname.upper()))
1690
655
            else:
1691
656
                argdict[argname + '_list'] = args[:]
1692
657
                args = []
1693
658
        elif ap[-1] == '$': # all but one
1694
659
            if len(args) < 2:
1695
 
                raise BzrCommandError("command %r needs one or more %s"
1696
 
                        % (cmd, argname.upper()))
 
660
                raise errors.BzrCommandError("command %r needs one or more %s"
 
661
                                             % (cmd, argname.upper()))
1697
662
            argdict[argname + '_list'] = args[:-1]
1698
 
            args[:-1] = []                
 
663
            args[:-1] = []
1699
664
        else:
1700
665
            # just a plain arg
1701
666
            argname = ap
1702
667
            if not args:
1703
 
                raise BzrCommandError("command %r requires argument %s"
1704
 
                        % (cmd, argname.upper()))
 
668
                raise errors.BzrCommandError("command %r requires argument %s"
 
669
                               % (cmd, argname.upper()))
1705
670
            else:
1706
671
                argdict[argname] = args.pop(0)
1707
 
            
 
672
 
1708
673
    if args:
1709
 
        raise BzrCommandError("extra argument to command %s: %s"
1710
 
                              % (cmd, args[0]))
 
674
        raise errors.BzrCommandError("extra argument to command %s: %s"
 
675
                                     % (cmd, args[0]))
1711
676
 
1712
677
    return argdict
1713
678
 
 
679
def apply_coveraged(dirname, the_callable, *args, **kwargs):
 
680
    # Cannot use "import trace", as that would import bzrlib.trace instead of
 
681
    # the standard library's trace.
 
682
    trace = __import__('trace')
 
683
 
 
684
    tracer = trace.Trace(count=1, trace=0)
 
685
    sys.settrace(tracer.globaltrace)
 
686
    threading.settrace(tracer.globaltrace)
 
687
 
 
688
    try:
 
689
        return exception_to_return_code(the_callable, *args, **kwargs)
 
690
    finally:
 
691
        sys.settrace(None)
 
692
        results = tracer.results()
 
693
        results.write_results(show_missing=1, summary=False,
 
694
                              coverdir=dirname)
 
695
 
 
696
 
 
697
def apply_profiled(the_callable, *args, **kwargs):
 
698
    import hotshot
 
699
    import tempfile
 
700
    import hotshot.stats
 
701
    pffileno, pfname = tempfile.mkstemp()
 
702
    try:
 
703
        prof = hotshot.Profile(pfname)
 
704
        try:
 
705
            ret = prof.runcall(exception_to_return_code, the_callable, *args,
 
706
                **kwargs) or 0
 
707
        finally:
 
708
            prof.close()
 
709
        stats = hotshot.stats.load(pfname)
 
710
        stats.strip_dirs()
 
711
        stats.sort_stats('cum')   # 'time'
 
712
        ## XXX: Might like to write to stderr or the trace file instead but
 
713
        ## print_stats seems hardcoded to stdout
 
714
        stats.print_stats(20)
 
715
        return ret
 
716
    finally:
 
717
        os.close(pffileno)
 
718
        os.remove(pfname)
 
719
 
 
720
 
 
721
def exception_to_return_code(the_callable, *args, **kwargs):
 
722
    """UI level helper for profiling and coverage.
 
723
 
 
724
    This transforms exceptions into a return value of 3. As such its only
 
725
    relevant to the UI layer, and should never be called where catching
 
726
    exceptions may be desirable.
 
727
    """
 
728
    try:
 
729
        return the_callable(*args, **kwargs)
 
730
    except (KeyboardInterrupt, Exception), e:
 
731
        # used to handle AssertionError and KeyboardInterrupt
 
732
        # specially here, but hopefully they're handled ok by the logger now
 
733
        exc_info = sys.exc_info()
 
734
        exitcode = trace.report_exception(exc_info, sys.stderr)
 
735
        if os.environ.get('BZR_PDB'):
 
736
            print '**** entering debugger'
 
737
            tb = exc_info[2]
 
738
            import pdb
 
739
            if sys.version_info[:2] < (2, 6):
 
740
                # XXX: we want to do
 
741
                #    pdb.post_mortem(tb)
 
742
                # but because pdb.post_mortem gives bad results for tracebacks
 
743
                # from inside generators, we do it manually.
 
744
                # (http://bugs.python.org/issue4150, fixed in Python 2.6)
 
745
 
 
746
                # Setup pdb on the traceback
 
747
                p = pdb.Pdb()
 
748
                p.reset()
 
749
                p.setup(tb.tb_frame, tb)
 
750
                # Point the debugger at the deepest frame of the stack
 
751
                p.curindex = len(p.stack) - 1
 
752
                p.curframe = p.stack[p.curindex][0]
 
753
                # Start the pdb prompt.
 
754
                p.print_stack_entry(p.stack[p.curindex])
 
755
                p.execRcLines()
 
756
                p.cmdloop()
 
757
            else:
 
758
                pdb.post_mortem(tb)
 
759
        return exitcode
 
760
 
 
761
 
 
762
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
 
763
    from bzrlib.lsprof import profile
 
764
    ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
 
765
    stats.sort()
 
766
    if filename is None:
 
767
        stats.pprint()
 
768
    else:
 
769
        stats.save(filename)
 
770
        trace.note('Profile data written to "%s".', filename)
 
771
    return ret
 
772
 
 
773
 
 
774
def shlex_split_unicode(unsplit):
 
775
    import shlex
 
776
    return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
 
777
 
 
778
 
 
779
def get_alias(cmd, config=None):
 
780
    """Return an expanded alias, or None if no alias exists.
 
781
 
 
782
    cmd
 
783
        Command to be checked for an alias.
 
784
    config
 
785
        Used to specify an alternative config to use,
 
786
        which is especially useful for testing.
 
787
        If it is unspecified, the global config will be used.
 
788
    """
 
789
    if config is None:
 
790
        import bzrlib.config
 
791
        config = bzrlib.config.GlobalConfig()
 
792
    alias = config.get_alias(cmd)
 
793
    if (alias):
 
794
        return shlex_split_unicode(alias)
 
795
    return None
1714
796
 
1715
797
 
1716
798
def run_bzr(argv):
1717
799
    """Execute a command.
1718
800
 
1719
 
    This is similar to main(), but without all the trappings for
1720
 
    logging and error handling.  
1721
 
    
1722
801
    argv
1723
802
       The command-line arguments, without the program name from argv[0]
1724
 
    
 
803
       These should already be decoded. All library/test code calling
 
804
       run_bzr should be passing valid strings (don't need decoding).
 
805
 
1725
806
    Returns a command status or raises an exception.
1726
807
 
1727
808
    Special master options: these must come before the command because
1730
811
    --no-plugins
1731
812
        Do not load plugin modules at all
1732
813
 
 
814
    --no-aliases
 
815
        Do not allow aliases
 
816
 
1733
817
    --builtin
1734
818
        Only use builtin commands.  (Plugins are still allowed to change
1735
819
        other behaviour.)
1736
820
 
1737
821
    --profile
1738
 
        Run under the Python profiler.
 
822
        Run under the Python hotshot profiler.
 
823
 
 
824
    --lsprof
 
825
        Run under the Python lsprof profiler.
 
826
 
 
827
    --coverage
 
828
        Generate line coverage report in the specified directory.
1739
829
    """
1740
 
    
1741
 
    argv = [a.decode(bzrlib.user_encoding) for a in argv]
 
830
    argv = list(argv)
 
831
    trace.mutter("bzr arguments: %r", argv)
1742
832
 
1743
 
    opt_profile = opt_no_plugins = opt_builtin = False
 
833
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin =  \
 
834
                opt_no_aliases = False
 
835
    opt_lsprof_file = opt_coverage_dir = None
1744
836
 
1745
837
    # --no-plugins is handled specially at a very early stage. We need
1746
838
    # to load plugins before doing other command parsing so that they
1747
839
    # can override commands, but this needs to happen first.
1748
840
 
1749
 
    for a in argv[:]:
 
841
    argv_copy = []
 
842
    i = 0
 
843
    while i < len(argv):
 
844
        a = argv[i]
1750
845
        if a == '--profile':
1751
846
            opt_profile = True
 
847
        elif a == '--lsprof':
 
848
            opt_lsprof = True
 
849
        elif a == '--lsprof-file':
 
850
            opt_lsprof = True
 
851
            opt_lsprof_file = argv[i + 1]
 
852
            i += 1
1752
853
        elif a == '--no-plugins':
1753
854
            opt_no_plugins = True
 
855
        elif a == '--no-aliases':
 
856
            opt_no_aliases = True
1754
857
        elif a == '--builtin':
1755
858
            opt_builtin = True
 
859
        elif a == '--coverage':
 
860
            opt_coverage_dir = argv[i + 1]
 
861
            i += 1
 
862
        elif a.startswith('-D'):
 
863
            debug.debug_flags.add(a[2:])
1756
864
        else:
1757
 
            break
1758
 
        argv.remove(a)
 
865
            argv_copy.append(a)
 
866
        i += 1
 
867
 
 
868
    debug.set_debug_flags_from_config()
 
869
 
 
870
    argv = argv_copy
 
871
    if (not argv):
 
872
        from bzrlib.builtins import cmd_help
 
873
        cmd_help().run_argv_aliases([])
 
874
        return 0
 
875
 
 
876
    if argv[0] == '--version':
 
877
        from bzrlib.builtins import cmd_version
 
878
        cmd_version().run_argv_aliases([])
 
879
        return 0
1759
880
 
1760
881
    if not opt_no_plugins:
1761
882
        from bzrlib.plugin import load_plugins
1762
883
        load_plugins()
1763
 
 
1764
 
    args, opts = parse_args(argv)
1765
 
 
1766
 
    if 'help' in opts:
1767
 
        from bzrlib.help import help
1768
 
        if args:
1769
 
            help(args[0])
1770
 
        else:
1771
 
            help()
1772
 
        return 0            
1773
 
        
1774
 
    if 'version' in opts:
1775
 
        show_version()
1776
 
        return 0
1777
 
    
1778
 
    if not args:
1779
 
        print >>sys.stderr, "please try 'bzr help' for help"
1780
 
        return 1
1781
 
    
1782
 
    cmd = str(args.pop(0))
1783
 
 
1784
 
    canonical_cmd, cmd_class = \
1785
 
                   get_cmd_class(cmd, plugins_override=not opt_builtin)
1786
 
 
1787
 
    # check options are reasonable
1788
 
    allowed = cmd_class.takes_options
1789
 
    for oname in opts:
1790
 
        if oname not in allowed:
1791
 
            raise BzrCommandError("option '--%s' is not allowed for command %r"
1792
 
                                  % (oname, cmd))
1793
 
 
1794
 
    # mix arguments and options into one dictionary
1795
 
    cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1796
 
    cmdopts = {}
1797
 
    for k, v in opts.items():
1798
 
        cmdopts[k.replace('-', '_')] = v
1799
 
 
1800
 
    if opt_profile:
1801
 
        import hotshot, tempfile
1802
 
        pffileno, pfname = tempfile.mkstemp()
1803
 
        try:
1804
 
            prof = hotshot.Profile(pfname)
1805
 
            ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1806
 
            prof.close()
1807
 
 
1808
 
            import hotshot.stats
1809
 
            stats = hotshot.stats.load(pfname)
1810
 
            #stats.strip_dirs()
1811
 
            stats.sort_stats('time')
1812
 
            ## XXX: Might like to write to stderr or the trace file instead but
1813
 
            ## print_stats seems hardcoded to stdout
1814
 
            stats.print_stats(20)
1815
 
            
1816
 
            return ret.status
1817
 
 
1818
 
        finally:
1819
 
            os.close(pffileno)
1820
 
            os.remove(pfname)
1821
884
    else:
1822
 
        return cmd_class(cmdopts, cmdargs).status 
1823
 
 
1824
 
 
1825
 
def _report_exception(summary, quiet=False):
1826
 
    import traceback
1827
 
    
1828
 
    log_error('bzr: ' + summary)
1829
 
    bzrlib.trace.log_exception()
1830
 
 
1831
 
    if os.environ.get('BZR_DEBUG'):
1832
 
        traceback.print_exc()
1833
 
 
1834
 
    if not quiet:
1835
 
        sys.stderr.write('\n')
1836
 
        tb = sys.exc_info()[2]
1837
 
        exinfo = traceback.extract_tb(tb)
1838
 
        if exinfo:
1839
 
            sys.stderr.write('  at %s:%d in %s()\n' % exinfo[-1][:3])
1840
 
        sys.stderr.write('  see ~/.bzr.log for debug information\n')
1841
 
 
1842
 
 
1843
 
 
1844
 
def main(argv):
1845
 
    
1846
 
    bzrlib.trace.open_tracefile(argv)
 
885
        from bzrlib.plugin import disable_plugins
 
886
        disable_plugins()
 
887
 
 
888
    alias_argv = None
 
889
 
 
890
    if not opt_no_aliases:
 
891
        alias_argv = get_alias(argv[0])
 
892
        if alias_argv:
 
893
            user_encoding = osutils.get_user_encoding()
 
894
            alias_argv = [a.decode(user_encoding) for a in alias_argv]
 
895
            argv[0] = alias_argv.pop(0)
 
896
 
 
897
    cmd = argv.pop(0)
 
898
    # We want only 'ascii' command names, but the user may have typed
 
899
    # in a Unicode name. In that case, they should just get a
 
900
    # 'command not found' error later.
 
901
 
 
902
    cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
 
903
    run = cmd_obj.run_argv_aliases
 
904
    run_argv = [argv, alias_argv]
1847
905
 
1848
906
    try:
1849
 
        try:
1850
 
            try:
1851
 
                return run_bzr(argv[1:])
1852
 
            finally:
1853
 
                # do this here inside the exception wrappers to catch EPIPE
1854
 
                sys.stdout.flush()
1855
 
        except BzrError, e:
1856
 
            quiet = isinstance(e, (BzrCommandError))
1857
 
            _report_exception('error: ' + str(e), quiet=quiet)
1858
 
            if len(e.args) > 1:
1859
 
                for h in e.args[1]:
1860
 
                    # some explanation or hints
1861
 
                    log_error('  ' + h)
1862
 
            return 1
1863
 
        except AssertionError, e:
1864
 
            msg = 'assertion failed'
1865
 
            if str(e):
1866
 
                msg += ': ' + str(e)
1867
 
            _report_exception(msg)
1868
 
            return 2
1869
 
        except KeyboardInterrupt, e:
1870
 
            _report_exception('interrupted', quiet=True)
1871
 
            return 2
1872
 
        except Exception, e:
1873
 
            import errno
1874
 
            quiet = False
1875
 
            if (isinstance(e, IOError) 
1876
 
                and hasattr(e, 'errno')
1877
 
                and e.errno == errno.EPIPE):
1878
 
                quiet = True
1879
 
                msg = 'broken pipe'
1880
 
            else:
1881
 
                msg = str(e).rstrip('\n')
1882
 
            _report_exception(msg, quiet)
1883
 
            return 2
 
907
        # We can be called recursively (tests for example), but we don't want
 
908
        # the verbosity level to propagate.
 
909
        saved_verbosity_level = option._verbosity_level
 
910
        option._verbosity_level = 0
 
911
        if opt_lsprof:
 
912
            if opt_coverage_dir:
 
913
                trace.warning(
 
914
                    '--coverage ignored, because --lsprof is in use.')
 
915
            ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
 
916
        elif opt_profile:
 
917
            if opt_coverage_dir:
 
918
                trace.warning(
 
919
                    '--coverage ignored, because --profile is in use.')
 
920
            ret = apply_profiled(run, *run_argv)
 
921
        elif opt_coverage_dir:
 
922
            ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
 
923
        else:
 
924
            ret = run(*run_argv)
 
925
        if 'memory' in debug.debug_flags:
 
926
            trace.debug_memory('Process status after command:', short=False)
 
927
        return ret or 0
1884
928
    finally:
1885
 
        bzrlib.trace.close_trace()
 
929
        # reset, in case we may do other commands later within the same
 
930
        # process. Commands that want to execute sub-commands must propagate
 
931
        # --verbose in their own way.
 
932
        option._verbosity_level = saved_verbosity_level
 
933
 
 
934
 
 
935
def display_command(func):
 
936
    """Decorator that suppresses pipe/interrupt errors."""
 
937
    def ignore_pipe(*args, **kwargs):
 
938
        try:
 
939
            result = func(*args, **kwargs)
 
940
            sys.stdout.flush()
 
941
            return result
 
942
        except IOError, e:
 
943
            if getattr(e, 'errno', None) is None:
 
944
                raise
 
945
            if e.errno != errno.EPIPE:
 
946
                # Win32 raises IOError with errno=0 on a broken pipe
 
947
                if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
 
948
                    raise
 
949
            pass
 
950
        except KeyboardInterrupt:
 
951
            pass
 
952
    return ignore_pipe
 
953
 
 
954
 
 
955
def main(argv=None):
 
956
    """Main entry point of command-line interface.
 
957
 
 
958
    :param argv: list of unicode command-line arguments similar to sys.argv.
 
959
        argv[0] is script name usually, it will be ignored.
 
960
        Don't pass here sys.argv because this list contains plain strings
 
961
        and not unicode; pass None instead.
 
962
 
 
963
    :return: exit code of bzr command.
 
964
    """
 
965
    import bzrlib.ui
 
966
    bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
 
967
        sys.stdin, sys.stdout, sys.stderr)
 
968
 
 
969
    # Is this a final release version? If so, we should suppress warnings
 
970
    if bzrlib.version_info[3] == 'final':
 
971
        from bzrlib import symbol_versioning
 
972
        symbol_versioning.suppress_deprecation_warnings(override=False)
 
973
    if argv is None:
 
974
        argv = osutils.get_unicode_argv()
 
975
    else:
 
976
        new_argv = []
 
977
        try:
 
978
            # ensure all arguments are unicode strings
 
979
            for a in argv[1:]:
 
980
                if isinstance(a, unicode):
 
981
                    new_argv.append(a)
 
982
                else:
 
983
                    new_argv.append(a.decode('ascii'))
 
984
        except UnicodeDecodeError:
 
985
            raise errors.BzrError("argv should be list of unicode strings.")
 
986
        argv = new_argv
 
987
    ret = run_bzr_catch_errors(argv)
 
988
    trace.mutter("return code %d", ret)
 
989
    return ret
 
990
 
 
991
 
 
992
def run_bzr_catch_errors(argv):
 
993
    """Run a bzr command with parameters as described by argv.
 
994
 
 
995
    This function assumed that that UI layer is setup, that symbol deprecations
 
996
    are already applied, and that unicode decoding has already been performed on argv.
 
997
    """
 
998
    return exception_to_return_code(run_bzr, argv)
 
999
 
 
1000
 
 
1001
def run_bzr_catch_user_errors(argv):
 
1002
    """Run bzr and report user errors, but let internal errors propagate.
 
1003
 
 
1004
    This is used for the test suite, and might be useful for other programs
 
1005
    that want to wrap the commandline interface.
 
1006
    """
 
1007
    try:
 
1008
        return run_bzr(argv)
 
1009
    except Exception, e:
 
1010
        if (isinstance(e, (OSError, IOError))
 
1011
            or not getattr(e, 'internal_error', True)):
 
1012
            trace.report_exception(sys.exc_info(), sys.stderr)
 
1013
            return 3
 
1014
        else:
 
1015
            raise
 
1016
 
 
1017
 
 
1018
class HelpCommandIndex(object):
 
1019
    """A index for bzr help that returns commands."""
 
1020
 
 
1021
    def __init__(self):
 
1022
        self.prefix = 'commands/'
 
1023
 
 
1024
    def get_topics(self, topic):
 
1025
        """Search for topic amongst commands.
 
1026
 
 
1027
        :param topic: A topic to search for.
 
1028
        :return: A list which is either empty or contains a single
 
1029
            Command entry.
 
1030
        """
 
1031
        if topic and topic.startswith(self.prefix):
 
1032
            topic = topic[len(self.prefix):]
 
1033
        try:
 
1034
            cmd = _get_cmd_object(topic)
 
1035
        except KeyError:
 
1036
            return []
 
1037
        else:
 
1038
            return [cmd]
 
1039
 
 
1040
 
 
1041
class Provider(object):
 
1042
    '''Generic class to be overriden by plugins'''
 
1043
 
 
1044
    def plugin_for_command(self, cmd_name):
 
1045
        '''Takes a command and returns the information for that plugin
 
1046
 
 
1047
        :return: A dictionary with all the available information
 
1048
        for the requested plugin
 
1049
        '''
 
1050
        raise NotImplementedError
 
1051
 
 
1052
 
 
1053
class ProvidersRegistry(registry.Registry):
 
1054
    '''This registry exists to allow other providers to exist'''
 
1055
 
 
1056
    def __iter__(self):
 
1057
        for key, provider in self.iteritems():
 
1058
            yield provider
 
1059
 
 
1060
command_providers_registry = ProvidersRegistry()
1886
1061
 
1887
1062
 
1888
1063
if __name__ == '__main__':