~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: 2006-06-29 18:21:57 UTC
  • mfrom: (1711.2.72 jam-integration)
  • Revision ID: pqm@pqm.ubuntu.com-20060629182157-cdc39b5f9e4fac85
(jam) add run_bzr_error, clean up remerge tests

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 by Canonical Ltd
 
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
 
 
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
 
18
 
 
19
 
import sys, os, time, os.path
20
 
from sets import Set
 
18
# TODO: probably should say which arguments are candidates for glob
 
19
# expansion on windows and do that at the command level.
 
20
 
 
21
# TODO: Define arguments by objects, rather than just using names.
 
22
# Those objects can specify the expected type of the argument, which
 
23
# would help with validation and shell completion.  They could also provide
 
24
# help/explanation for that argument in a structured way.
 
25
 
 
26
# TODO: Specific "examples" property on commands for consistent formatting.
 
27
 
 
28
# TODO: "--profile=cum", to change sort order.  Is there any value in leaving
 
29
# the profile output behind so it can be interactively examined?
 
30
 
 
31
import sys
 
32
import os
 
33
from warnings import warn
 
34
import errno
 
35
import codecs
21
36
 
22
37
import bzrlib
23
 
from bzrlib.trace import mutter, note, log_error
24
 
from bzrlib.errors import bailout, BzrError, BzrCheckError, BzrCommandError
25
 
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
26
 
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
27
 
from bzrlib.revision import Revision
28
 
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
29
 
     format_date
 
38
import bzrlib.errors as errors
 
39
from bzrlib.errors import (BzrError,
 
40
                           BzrCommandError,
 
41
                           BzrCheckError,
 
42
                           NotBranchError)
 
43
from bzrlib.option import Option
 
44
import bzrlib.osutils
 
45
from bzrlib.revisionspec import RevisionSpec
 
46
from bzrlib.symbol_versioning import (deprecated_method, zero_eight)
 
47
from bzrlib import trace
 
48
from bzrlib.trace import mutter, note, log_error, warning, be_quiet
 
49
 
 
50
plugin_cmds = {}
 
51
 
 
52
 
 
53
def register_command(cmd, decorate=False):
 
54
    """Utility function to help register a command
 
55
 
 
56
    :param cmd: Command subclass to register
 
57
    :param decorate: If true, allow overriding an existing command
 
58
        of the same name; the old command is returned by this function.
 
59
        Otherwise it is an error to try to override an existing command.
 
60
    """
 
61
    global plugin_cmds
 
62
    k = cmd.__name__
 
63
    if k.startswith("cmd_"):
 
64
        k_unsquished = _unsquish_command_name(k)
 
65
    else:
 
66
        k_unsquished = k
 
67
    if not plugin_cmds.has_key(k_unsquished):
 
68
        plugin_cmds[k_unsquished] = cmd
 
69
        mutter('registered plugin command %s', k_unsquished)
 
70
        if decorate and k_unsquished in builtin_command_names():
 
71
            return _builtin_commands()[k_unsquished]
 
72
    elif decorate:
 
73
        result = plugin_cmds[k_unsquished]
 
74
        plugin_cmds[k_unsquished] = cmd
 
75
        return result
 
76
    else:
 
77
        log_error('Two plugins defined the same command: %r' % k)
 
78
        log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
30
79
 
31
80
 
32
81
def _squish_command_name(cmd):
37
86
    assert cmd.startswith("cmd_")
38
87
    return cmd[4:].replace('_','-')
39
88
 
40
 
def get_all_cmds():
 
89
 
 
90
def _builtin_commands():
 
91
    import bzrlib.builtins
 
92
    r = {}
 
93
    builtins = bzrlib.builtins.__dict__
 
94
    for name in builtins:
 
95
        if name.startswith("cmd_"):
 
96
            real_name = _unsquish_command_name(name)
 
97
            r[real_name] = builtins[name]
 
98
    return r
 
99
            
 
100
 
 
101
def builtin_command_names():
 
102
    """Return list of builtin command names."""
 
103
    return _builtin_commands().keys()
 
104
    
 
105
 
 
106
def plugin_command_names():
 
107
    return plugin_cmds.keys()
 
108
 
 
109
 
 
110
def _get_cmd_dict(plugins_override=True):
 
111
    """Return name->class mapping for all commands."""
 
112
    d = _builtin_commands()
 
113
    if plugins_override:
 
114
        d.update(plugin_cmds)
 
115
    return d
 
116
 
 
117
    
 
118
def get_all_cmds(plugins_override=True):
41
119
    """Return canonical name and class for all registered commands."""
42
 
    for k, v in globals().iteritems():
43
 
        if k.startswith("cmd_"):
44
 
            yield _unsquish_command_name(k), v
45
 
 
46
 
def get_cmd_class(cmd):
 
120
    for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
 
121
        yield k,v
 
122
 
 
123
 
 
124
def get_cmd_object(cmd_name, plugins_override=True):
47
125
    """Return the canonical name and command class for a command.
 
126
 
 
127
    plugins_override
 
128
        If true, plugin commands can override builtins.
48
129
    """
49
 
    cmd = str(cmd)                      # not unicode
 
130
    from bzrlib.externalcommand import ExternalCommand
 
131
 
 
132
    cmd_name = str(cmd_name)            # not unicode
50
133
 
51
134
    # first look up this command under the specified name
 
135
    cmds = _get_cmd_dict(plugins_override=plugins_override)
52
136
    try:
53
 
        return cmd, globals()[_squish_command_name(cmd)]
 
137
        return cmds[cmd_name]()
54
138
    except KeyError:
55
139
        pass
56
140
 
57
141
    # look for any command which claims this as an alias
58
 
    for cmdname, cmdclass in get_all_cmds():
59
 
        if cmd in cmdclass.aliases:
60
 
            return cmdname, cmdclass
61
 
    else:
62
 
        raise BzrCommandError("unknown command %r" % cmd)
63
 
 
64
 
 
65
 
class Command:
 
142
    for real_cmd_name, cmd_class in cmds.iteritems():
 
143
        if cmd_name in cmd_class.aliases:
 
144
            return cmd_class()
 
145
 
 
146
    cmd_obj = ExternalCommand.find_command(cmd_name)
 
147
    if cmd_obj:
 
148
        return cmd_obj
 
149
 
 
150
    raise BzrCommandError('unknown command "%s"' % cmd_name)
 
151
 
 
152
 
 
153
class Command(object):
66
154
    """Base class for commands.
67
155
 
 
156
    Commands are the heart of the command-line bzr interface.
 
157
 
 
158
    The command object mostly handles the mapping of command-line
 
159
    parameters into one or more bzrlib operations, and of the results
 
160
    into textual output.
 
161
 
 
162
    Commands normally don't have any state.  All their arguments are
 
163
    passed in to the run method.  (Subclasses may take a different
 
164
    policy if the behaviour of the instance needs to depend on e.g. a
 
165
    shell plugin and not just its Python class.)
 
166
 
68
167
    The docstring for an actual command should give a single-line
69
168
    summary, then a complete description of the command.  A grammar
70
169
    description will be inserted.
71
170
 
 
171
    aliases
 
172
        Other accepted names for this command.
 
173
 
72
174
    takes_args
73
175
        List of argument forms, marked with whether they are optional,
74
176
        repeated, etc.
75
177
 
 
178
                Examples:
 
179
 
 
180
                ['to_location', 'from_branch?', 'file*']
 
181
 
 
182
                'to_location' is required
 
183
                'from_branch' is optional
 
184
                'file' can be specified 0 or more times
 
185
 
76
186
    takes_options
77
 
        List of options that may be given for this command.
 
187
        List of options that may be given for this command.  These can
 
188
        be either strings, referring to globally-defined options,
 
189
        or option objects.  Retrieve through options().
78
190
 
79
191
    hidden
80
 
        If true, this command isn't advertised.
 
192
        If true, this command isn't advertised.  This is typically
 
193
        for commands intended for expert users.
 
194
 
 
195
    encoding_type
 
196
        Command objects will get a 'outf' attribute, which has been
 
197
        setup to properly handle encoding of unicode strings.
 
198
        encoding_type determines what will happen when characters cannot
 
199
        be encoded
 
200
            strict - abort if we cannot decode
 
201
            replace - put in a bogus character (typically '?')
 
202
            exact - do not encode sys.stdout
 
203
 
81
204
    """
82
205
    aliases = []
83
 
    
84
206
    takes_args = []
85
207
    takes_options = []
 
208
    encoding_type = 'strict'
86
209
 
87
210
    hidden = False
88
211
    
89
 
    def __init__(self, options, arguments):
90
 
        """Construct and run the command.
91
 
 
92
 
        Sets self.status to the return value of run()."""
93
 
        assert isinstance(options, dict)
94
 
        assert isinstance(arguments, dict)
95
 
        cmdargs = options.copy()
96
 
        cmdargs.update(arguments)
97
 
        assert self.__doc__ != Command.__doc__, \
98
 
               ("No help message set for %r" % self)
99
 
        self.status = self.run(**cmdargs)
100
 
 
 
212
    def __init__(self):
 
213
        """Construct an instance of this command."""
 
214
        if self.__doc__ == Command.__doc__:
 
215
            warn("No help message set for %r" % self)
 
216
 
 
217
    def options(self):
 
218
        """Return dict of valid options for this command.
 
219
 
 
220
        Maps from long option name to option object."""
 
221
        r = dict()
 
222
        r['help'] = Option.OPTIONS['help']
 
223
        for o in self.takes_options:
 
224
            if not isinstance(o, Option):
 
225
                o = Option.OPTIONS[o]
 
226
            r[o.name] = o
 
227
        return r
 
228
 
 
229
    def _setup_outf(self):
 
230
        """Return a file linked to stdout, which has proper encoding."""
 
231
        assert self.encoding_type in ['strict', 'exact', 'replace']
 
232
 
 
233
        # Originally I was using self.stdout, but that looks
 
234
        # *way* too much like sys.stdout
 
235
        if self.encoding_type == 'exact':
 
236
            self.outf = sys.stdout
 
237
            return
 
238
 
 
239
        output_encoding = bzrlib.osutils.get_terminal_encoding()
 
240
 
 
241
        # use 'replace' so that we don't abort if trying to write out
 
242
        # in e.g. the default C locale.
 
243
        self.outf = codecs.getwriter(output_encoding)(sys.stdout, errors=self.encoding_type)
 
244
        # For whatever reason codecs.getwriter() does not advertise its encoding
 
245
        # it just returns the encoding of the wrapped file, which is completely
 
246
        # bogus. So set the attribute, so we can find the correct encoding later.
 
247
        self.outf.encoding = output_encoding
 
248
 
 
249
    @deprecated_method(zero_eight)
 
250
    def run_argv(self, argv):
 
251
        """Parse command line and run.
 
252
        
 
253
        See run_argv_aliases for the 0.8 and beyond api.
 
254
        """
 
255
        return self.run_argv_aliases(argv)
 
256
 
 
257
    def run_argv_aliases(self, argv, alias_argv=None):
 
258
        """Parse the command line and run with extra aliases in alias_argv."""
 
259
        args, opts = parse_args(self, argv, alias_argv)
 
260
        if 'help' in opts:  # e.g. bzr add --help
 
261
            from bzrlib.help import help_on_command
 
262
            help_on_command(self.name())
 
263
            return 0
 
264
        # XXX: This should be handled by the parser
 
265
        allowed_names = self.options().keys()
 
266
        for oname in opts:
 
267
            if oname not in allowed_names:
 
268
                raise BzrOptionError("option '--%s' is not allowed for"
 
269
                                " command %r" % (oname, self.name()))
 
270
        # mix arguments and options into one dictionary
 
271
        cmdargs = _match_argform(self.name(), self.takes_args, args)
 
272
        cmdopts = {}
 
273
        for k, v in opts.items():
 
274
            cmdopts[k.replace('-', '_')] = v
 
275
 
 
276
        all_cmd_args = cmdargs.copy()
 
277
        all_cmd_args.update(cmdopts)
 
278
 
 
279
        self._setup_outf()
 
280
 
 
281
        return self.run(**all_cmd_args)
101
282
    
102
283
    def run(self):
103
 
        """Override this in sub-classes.
 
284
        """Actually run the command.
104
285
 
105
286
        This is invoked with the options and arguments bound to
106
287
        keyword parameters.
107
288
 
108
 
        Return 0 or None if the command was successful, or a shell
109
 
        error code if not.
110
 
        """
111
 
        return 0
112
 
 
113
 
 
114
 
 
115
 
class cmd_status(Command):
116
 
    """Display status summary.
117
 
 
118
 
    For each file there is a single line giving its file state and name.
119
 
    The name is that in the current revision unless it is deleted or
120
 
    missing, in which case the old name is shown.
121
 
    """
122
 
    takes_options = ['all']
123
 
    aliases = ['st', 'stat']
124
 
    
125
 
    def run(self, all=False):
126
 
        #import bzrlib.status
127
 
        #bzrlib.status.tree_status(Branch('.'))
128
 
        Branch('.').show_status(show_all=all)
129
 
 
130
 
 
131
 
class cmd_cat_revision(Command):
132
 
    """Write out metadata for a revision."""
133
 
 
134
 
    hidden = True
135
 
    takes_args = ['revision_id']
136
 
    
137
 
    def run(self, revision_id):
138
 
        Branch('.').get_revision(revision_id).write_xml(sys.stdout)
139
 
 
140
 
 
141
 
class cmd_revno(Command):
142
 
    """Show current revision number.
143
 
 
144
 
    This is equal to the number of revisions on this branch."""
145
 
    def run(self):
146
 
        print Branch('.').revno()
147
 
 
148
 
    
149
 
class cmd_add(Command):
150
 
    """Add specified files or directories.
151
 
 
152
 
    In non-recursive mode, all the named items are added, regardless
153
 
    of whether they were previously ignored.  A warning is given if
154
 
    any of the named files are already versioned.
155
 
 
156
 
    In recursive mode (the default), files are treated the same way
157
 
    but the behaviour for directories is different.  Directories that
158
 
    are already versioned do not give a warning.  All directories,
159
 
    whether already versioned or not, are searched for files or
160
 
    subdirectories that are neither versioned or ignored, and these
161
 
    are added.  This search proceeds recursively into versioned
162
 
    directories.
163
 
 
164
 
    Therefore simply saying 'bzr add .' will version all files that
165
 
    are currently unknown.
166
 
 
167
 
    TODO: Perhaps adding a file whose directly is not versioned should
168
 
    recursively add that parent, rather than giving an error?
169
 
    """
170
 
    takes_args = ['file+']
171
 
    takes_options = ['verbose']
172
 
    
173
 
    def run(self, file_list, verbose=False):
174
 
        bzrlib.add.smart_add(file_list, verbose)
175
 
 
176
 
 
177
 
def Relpath(Command):
178
 
    """Show path of a file relative to root"""
179
 
    takes_args = ('filename')
180
 
    
181
 
    def run(self):
182
 
        print Branch(self.args['filename']).relpath(filename)
183
 
 
184
 
 
185
 
 
186
 
class cmd_inventory(Command):
187
 
    """Show inventory of the current working copy or a revision."""
188
 
    takes_options = ['revision']
189
 
    
190
 
    def run(self, revision=None):
191
 
        b = Branch('.')
192
 
        if revision == None:
193
 
            inv = b.read_working_inventory()
194
 
        else:
195
 
            inv = b.get_revision_inventory(b.lookup_revision(revision))
196
 
 
197
 
        for path, entry in inv.iter_entries():
198
 
            print '%-50s %s' % (entry.file_id, path)
199
 
 
200
 
 
201
 
class cmd_move(Command):
202
 
    """Move files to a different directory.
203
 
 
204
 
    examples:
205
 
        bzr move *.txt doc
206
 
 
207
 
    The destination must be a versioned directory in the same branch.
208
 
    """
209
 
    takes_args = ['source$', 'dest']
210
 
    def run(self, source_list, dest):
211
 
        b = Branch('.')
212
 
 
213
 
        b.move([b.relpath(s) for s in source_list], b.relpath(dest))
214
 
 
215
 
 
216
 
class cmd_rename(Command):
217
 
    """Change the name of an entry.
218
 
 
219
 
    examples:
220
 
      bzr rename frob.c frobber.c
221
 
      bzr rename src/frob.c lib/frob.c
222
 
 
223
 
    It is an error if the destination name exists.
224
 
 
225
 
    See also the 'move' command, which moves files into a different
226
 
    directory without changing their name.
227
 
 
228
 
    TODO: Some way to rename multiple files without invoking bzr for each
229
 
    one?"""
230
 
    takes_args = ['from_name', 'to_name']
231
 
    
232
 
    def run(self, from_name, to_name):
233
 
        b = Branch('.')
234
 
        b.rename_one(b.relpath(from_name), b.relpath(to_name))
235
 
 
236
 
 
237
 
 
238
 
class cmd_renames(Command):
239
 
    """Show list of renamed files.
240
 
 
241
 
    TODO: Option to show renames between two historical versions.
242
 
 
243
 
    TODO: Only show renames under dir, rather than in the whole branch.
244
 
    """
245
 
    takes_args = ['dir?']
246
 
 
247
 
    def run(self, dir='.'):
248
 
        b = Branch(dir)
249
 
        old_inv = b.basis_tree().inventory
250
 
        new_inv = b.read_working_inventory()
251
 
 
252
 
        renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
253
 
        renames.sort()
254
 
        for old_name, new_name in renames:
255
 
            print "%s => %s" % (old_name, new_name)        
256
 
 
257
 
 
258
 
class cmd_info(Command):
259
 
    """Show statistical information for this branch"""
260
 
    def run(self):
261
 
        import info
262
 
        info.show_info(Branch('.'))        
263
 
 
264
 
 
265
 
class cmd_remove(Command):
266
 
    """Make a file unversioned.
267
 
 
268
 
    This makes bzr stop tracking changes to a versioned file.  It does
269
 
    not delete the working copy.
270
 
    """
271
 
    takes_args = ['file+']
272
 
    takes_options = ['verbose']
273
 
    
274
 
    def run(self, file_list, verbose=False):
275
 
        b = Branch(file_list[0])
276
 
        b.remove([b.relpath(f) for f in file_list], verbose=verbose)
277
 
 
278
 
 
279
 
class cmd_file_id(Command):
280
 
    """Print file_id of a particular file or directory.
281
 
 
282
 
    The file_id is assigned when the file is first added and remains the
283
 
    same through all revisions where the file exists, even when it is
284
 
    moved or renamed.
285
 
    """
286
 
    hidden = True
287
 
    takes_args = ['filename']
288
 
    def run(self, filename):
289
 
        b = Branch(filename)
290
 
        i = b.inventory.path2id(b.relpath(filename))
291
 
        if i == None:
292
 
            bailout("%r is not a versioned file" % filename)
293
 
        else:
294
 
            print i
295
 
 
296
 
 
297
 
class cmd_file_path(Command):
298
 
    """Print path of file_ids to a file or directory.
299
 
 
300
 
    This prints one line for each directory down to the target,
301
 
    starting at the branch root."""
302
 
    hidden = True
303
 
    takes_args = ['filename']
304
 
    def run(self, filename):
305
 
        b = Branch(filename)
306
 
        inv = b.inventory
307
 
        fid = inv.path2id(b.relpath(filename))
308
 
        if fid == None:
309
 
            bailout("%r is not a versioned file" % filename)
310
 
        for fip in inv.get_idpath(fid):
311
 
            print fip
312
 
 
313
 
 
314
 
class cmd_revision_history(Command):
315
 
    """Display list of revision ids on this branch."""
316
 
    def run(self):
317
 
        for patchid in Branch('.').revision_history():
318
 
            print patchid
319
 
 
320
 
 
321
 
class cmd_directories(Command):
322
 
    """Display list of versioned directories in this branch."""
323
 
    def run(self):
324
 
        for name, ie in Branch('.').read_working_inventory().directories():
325
 
            if name == '':
326
 
                print '.'
327
 
            else:
328
 
                print name
329
 
 
330
 
 
331
 
class cmd_init(Command):
332
 
    """Make a directory into a versioned branch.
333
 
 
334
 
    Use this to create an empty branch, or before importing an
335
 
    existing project.
336
 
 
337
 
    Recipe for importing a tree of files:
338
 
        cd ~/project
339
 
        bzr init
340
 
        bzr add -v .
341
 
        bzr status
342
 
        bzr commit -m 'imported project'
343
 
    """
344
 
    def run(self):
345
 
        Branch('.', init=True)
346
 
 
347
 
 
348
 
class cmd_diff(Command):
349
 
    """Show differences in working tree.
350
 
    
351
 
    If files are listed, only the changes in those files are listed.
352
 
    Otherwise, all changes for the tree are listed.
353
 
 
354
 
    TODO: Given two revision arguments, show the difference between them.
355
 
 
356
 
    TODO: Allow diff across branches.
357
 
 
358
 
    TODO: Option to use external diff command; could be GNU diff, wdiff,
359
 
          or a graphical diff.
360
 
 
361
 
    TODO: Python difflib is not exactly the same as unidiff; should
362
 
          either fix it up or prefer to use an external diff.
363
 
 
364
 
    TODO: If a directory is given, diff everything under that.
365
 
 
366
 
    TODO: Selected-file diff is inefficient and doesn't show you
367
 
          deleted files.
368
 
 
369
 
    TODO: This probably handles non-Unix newlines poorly.
370
 
    """
371
 
    
372
 
    takes_args = ['file*']
373
 
    takes_options = ['revision']
374
 
    aliases = ['di']
375
 
 
376
 
    def run(self, revision=None, file_list=None):
377
 
        from bzrlib.diff import show_diff
378
 
    
379
 
        show_diff(Branch('.'), revision, file_list)
380
 
 
381
 
 
382
 
class cmd_deleted(Command):
383
 
    """List files deleted in the working tree.
384
 
 
385
 
    TODO: Show files deleted since a previous revision, or between two revisions.
386
 
    """
387
 
    def run(self, show_ids=False):
388
 
        b = Branch('.')
389
 
        old = b.basis_tree()
390
 
        new = b.working_tree()
391
 
 
392
 
        ## TODO: Much more efficient way to do this: read in new
393
 
        ## directories with readdir, rather than stating each one.  Same
394
 
        ## level of effort but possibly much less IO.  (Or possibly not,
395
 
        ## if the directories are very large...)
396
 
 
397
 
        for path, ie in old.inventory.iter_entries():
398
 
            if not new.has_id(ie.file_id):
399
 
                if show_ids:
400
 
                    print '%-50s %s' % (path, ie.file_id)
401
 
                else:
402
 
                    print path
403
 
 
404
 
class cmd_root(Command):
405
 
    """Show the tree root directory.
406
 
 
407
 
    The root is the nearest enclosing directory with a .bzr control
408
 
    directory."""
409
 
    takes_args = ['filename?']
410
 
    def run(self, filename=None):
411
 
        """Print the branch root."""
412
 
        print bzrlib.branch.find_branch_root(filename)
413
 
 
414
 
 
415
 
 
416
 
class cmd_log(Command):
417
 
    """Show log of this branch.
418
 
 
419
 
    TODO: Options to show ids; to limit range; etc.
420
 
    """
421
 
    takes_options = ['timezone', 'verbose']
422
 
    def run(self, timezone='original', verbose=False):
423
 
        Branch('.', lock_mode='r').write_log(show_timezone=timezone, verbose=verbose)
424
 
 
425
 
 
426
 
class cmd_ls(Command):
427
 
    """List files in a tree.
428
 
 
429
 
    TODO: Take a revision or remote path and list that tree instead.
430
 
    """
431
 
    hidden = True
432
 
    def run(self, revision=None, verbose=False):
433
 
        b = Branch('.')
434
 
        if revision == None:
435
 
            tree = b.working_tree()
436
 
        else:
437
 
            tree = b.revision_tree(b.lookup_revision(revision))
438
 
 
439
 
        for fp, fc, kind, fid in tree.list_files():
440
 
            if verbose:
441
 
                if kind == 'directory':
442
 
                    kindch = '/'
443
 
                elif kind == 'file':
444
 
                    kindch = ''
445
 
                else:
446
 
                    kindch = '???'
447
 
 
448
 
                print '%-8s %s%s' % (fc, fp, kindch)
449
 
            else:
450
 
                print fp
451
 
 
452
 
 
453
 
 
454
 
class cmd_unknowns(Command):
455
 
    """List unknown files"""
456
 
    def run(self):
457
 
        for f in Branch('.').unknowns():
458
 
            print quotefn(f)
459
 
 
460
 
 
461
 
 
462
 
class cmd_ignore(Command):
463
 
    """Ignore a command or pattern"""
464
 
    takes_args = ['name_pattern']
465
 
    
466
 
    def run(self, name_pattern):
467
 
        b = Branch('.')
468
 
 
469
 
        # XXX: This will fail if it's a hardlink; should use an AtomicFile class.
470
 
        f = open(b.abspath('.bzrignore'), 'at')
471
 
        f.write(name_pattern + '\n')
472
 
        f.close()
473
 
 
474
 
        inv = b.working_tree().inventory
475
 
        if inv.path2id('.bzrignore'):
476
 
            mutter('.bzrignore is already versioned')
477
 
        else:
478
 
            mutter('need to make new .bzrignore file versioned')
479
 
            b.add(['.bzrignore'])
480
 
 
481
 
 
482
 
 
483
 
class cmd_ignored(Command):
484
 
    """List ignored files and the patterns that matched them."""
485
 
    def run(self):
486
 
        tree = Branch('.').working_tree()
487
 
        for path, file_class, kind, file_id in tree.list_files():
488
 
            if file_class != 'I':
489
 
                continue
490
 
            ## XXX: Slightly inefficient since this was already calculated
491
 
            pat = tree.is_ignored(path)
492
 
            print '%-50s %s' % (path, pat)
493
 
 
494
 
 
495
 
class cmd_lookup_revision(Command):
496
 
    """Lookup the revision-id from a revision-number
497
 
 
498
 
    example:
499
 
        bzr lookup-revision 33
500
 
        """
501
 
    hidden = True
502
 
    takes_args = ['revno']
503
 
    
504
 
    def run(self, revno):
505
 
        try:
506
 
            revno = int(revno)
507
 
        except ValueError:
508
 
            raise BzrCommandError("not a valid revision-number: %r" % revno)
509
 
 
510
 
        print Branch('.').lookup_revision(revno)
511
 
 
512
 
 
513
 
class cmd_export(Command):
514
 
    """Export past revision to destination directory.
515
 
 
516
 
    If no revision is specified this exports the last committed revision."""
517
 
    takes_args = ['dest']
518
 
    takes_options = ['revision']
519
 
    def run(self, dest, revno=None):
520
 
        b = Branch('.')
521
 
        if revno == None:
522
 
            rh = b.revision_history[-1]
523
 
        else:
524
 
            rh = b.lookup_revision(int(revno))
525
 
        t = b.revision_tree(rh)
526
 
        t.export(dest)
527
 
 
528
 
 
529
 
class cmd_cat(Command):
530
 
    """Write a file's text from a previous revision."""
531
 
 
532
 
    takes_options = ['revision']
533
 
    takes_args = ['filename']
534
 
 
535
 
    def run(self, filename, revision=None):
536
 
        if revision == None:
537
 
            raise BzrCommandError("bzr cat requires a revision number")
538
 
        b = Branch('.')
539
 
        b.print_file(b.relpath(filename), int(revision))
540
 
 
541
 
 
542
 
class cmd_local_time_offset(Command):
543
 
    """Show the offset in seconds from GMT to local time."""
544
 
    hidden = True    
545
 
    def run(self):
546
 
        print bzrlib.osutils.local_time_offset()
547
 
 
548
 
 
549
 
 
550
 
class cmd_commit(Command):
551
 
    """Commit changes into a new revision.
552
 
 
553
 
    TODO: Commit only selected files.
554
 
 
555
 
    TODO: Run hooks on tree to-be-committed, and after commit.
556
 
 
557
 
    TODO: Strict commit that fails if there are unknown or deleted files.
558
 
    """
559
 
    takes_options = ['message', 'verbose']
560
 
    aliases = ['ci', 'checkin']
561
 
 
562
 
    def run(self, message=None, verbose=False):
563
 
        if not message:
564
 
            raise BzrCommandError("please specify a commit message")
565
 
        Branch('.').commit(message, verbose=verbose)
566
 
 
567
 
 
568
 
class cmd_check(Command):
569
 
    """Validate consistency of branch history.
570
 
 
571
 
    This command checks various invariants about the branch storage to
572
 
    detect data corruption or bzr bugs.
573
 
    """
574
 
    takes_args = ['dir?']
575
 
    def run(self, dir='.'):
576
 
        import bzrlib.check
577
 
        bzrlib.check.check(Branch(dir, find_root=False))
578
 
 
579
 
 
580
 
 
581
 
class cmd_whoami(Command):
582
 
    """Show bzr user id."""
583
 
    takes_options = ['email']
584
 
    
585
 
    def run(self, email=False):
586
 
        if email:
587
 
            print bzrlib.osutils.user_email()
588
 
        else:
589
 
            print bzrlib.osutils.username()
590
 
 
591
 
 
592
 
class cmd_selftest(Command):
593
 
    """Run internal test suite"""
594
 
    hidden = True
595
 
    def run(self):
596
 
        failures, tests = 0, 0
597
 
 
598
 
        import doctest, bzrlib.store, bzrlib.tests
599
 
        bzrlib.trace.verbose = False
600
 
 
601
 
        for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
602
 
            bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
603
 
            mf, mt = doctest.testmod(m)
604
 
            failures += mf
605
 
            tests += mt
606
 
            print '%-40s %3d tests' % (m.__name__, mt),
607
 
            if mf:
608
 
                print '%3d FAILED!' % mf
609
 
            else:
610
 
                print
611
 
 
612
 
        print '%-40s %3d tests' % ('total', tests),
613
 
        if failures:
614
 
            print '%3d FAILED!' % failures
615
 
        else:
616
 
            print
617
 
 
618
 
 
619
 
 
620
 
class cmd_version(Command):
621
 
    """Show version of bzr"""
622
 
    def run(self):
623
 
        show_version()
624
 
 
625
 
def show_version():
626
 
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
627
 
    print bzrlib.__copyright__
628
 
    print "http://bazaar-ng.org/"
629
 
    print
630
 
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
631
 
    print "you may use, modify and redistribute it under the terms of the GNU"
632
 
    print "General Public License version 2 or later."
633
 
 
634
 
 
635
 
class cmd_rocks(Command):
636
 
    """Statement of optimism."""
637
 
    hidden = True
638
 
    def run(self):
639
 
        print "it sure does!"
640
 
 
641
 
 
642
 
class cmd_assert_fail(Command):
643
 
    """Test reporting of assertion failures"""
644
 
    hidden = True
645
 
    def run(self):
646
 
        assert False, "always fails"
647
 
 
648
 
 
649
 
class cmd_help(Command):
650
 
    """Show help on a command or other topic.
651
 
 
652
 
    For a list of all available commands, say 'bzr help commands'."""
653
 
    takes_args = ['topic?']
654
 
    aliases = ['?']
655
 
    
656
 
    def run(self, topic=None):
657
 
        import help
658
 
        help.help(topic)
659
 
 
660
 
 
661
 
######################################################################
662
 
# main routine
663
 
 
664
 
 
665
 
# list of all available options; the rhs can be either None for an
666
 
# option that takes no argument, or a constructor function that checks
667
 
# the type.
668
 
OPTIONS = {
669
 
    'all':                    None,
670
 
    'help':                   None,
671
 
    'message':                unicode,
672
 
    'profile':                None,
673
 
    'revision':               int,
674
 
    'show-ids':               None,
675
 
    'timezone':               str,
676
 
    'verbose':                None,
677
 
    'version':                None,
678
 
    'email':                  None,
679
 
    }
680
 
 
681
 
SHORT_OPTIONS = {
682
 
    'm':                      'message',
683
 
    'r':                      'revision',
684
 
    'v':                      'verbose',
685
 
}
686
 
 
687
 
 
688
 
def parse_args(argv):
 
289
        Return 0 or None if the command was successful, or a non-zero
 
290
        shell error code if not.  It's OK for this method to allow
 
291
        an exception to raise up.
 
292
        """
 
293
        raise NotImplementedError('no implementation of command %r' 
 
294
                                  % self.name())
 
295
 
 
296
    def help(self):
 
297
        """Return help message for this class."""
 
298
        from inspect import getdoc
 
299
        if self.__doc__ is Command.__doc__:
 
300
            return None
 
301
        return getdoc(self)
 
302
 
 
303
    def name(self):
 
304
        return _unsquish_command_name(self.__class__.__name__)
 
305
 
 
306
    def plugin_name(self):
 
307
        """Get the name of the plugin that provides this command.
 
308
 
 
309
        :return: The name of the plugin or None if the command is builtin.
 
310
        """
 
311
        mod_parts = self.__module__.split('.')
 
312
        if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
 
313
            return mod_parts[2]
 
314
        else:
 
315
            return None
 
316
 
 
317
 
 
318
def parse_spec(spec):
 
319
    """
 
320
    >>> parse_spec(None)
 
321
    [None, None]
 
322
    >>> parse_spec("./")
 
323
    ['./', None]
 
324
    >>> parse_spec("../@")
 
325
    ['..', -1]
 
326
    >>> parse_spec("../f/@35")
 
327
    ['../f', 35]
 
328
    >>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
 
329
    ['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
 
330
    """
 
331
    if spec is None:
 
332
        return [None, None]
 
333
    if '/@' in spec:
 
334
        parsed = spec.split('/@')
 
335
        assert len(parsed) == 2
 
336
        if parsed[1] == "":
 
337
            parsed[1] = -1
 
338
        else:
 
339
            try:
 
340
                parsed[1] = int(parsed[1])
 
341
            except ValueError:
 
342
                pass # We can allow stuff like ./@revid:blahblahblah
 
343
            else:
 
344
                assert parsed[1] >=0
 
345
    else:
 
346
        parsed = [spec, None]
 
347
    return parsed
 
348
 
 
349
def parse_args(command, argv, alias_argv=None):
689
350
    """Parse command line.
690
351
    
691
352
    Arguments and options are parsed at this level before being passed
692
353
    down to specific command handlers.  This routine knows, from a
693
354
    lookup table, something about the available options, what optargs
694
355
    they take, and which commands will accept them.
695
 
 
696
 
    >>> parse_args('--help'.split())
697
 
    ([], {'help': True})
698
 
    >>> parse_args('--version'.split())
699
 
    ([], {'version': True})
700
 
    >>> parse_args('status --all'.split())
701
 
    (['status'], {'all': True})
702
 
    >>> parse_args('commit --message=biter'.split())
703
 
    (['commit'], {'message': u'biter'})
704
356
    """
 
357
    # TODO: chop up this beast; make it a method of the Command
705
358
    args = []
706
359
    opts = {}
707
 
 
708
 
    # TODO: Maybe handle '--' to end options?
709
 
 
710
 
    while argv:
711
 
        a = argv.pop(0)
712
 
        if a[0] == '-':
713
 
            # option names must not be unicode
714
 
            a = str(a)
715
 
            optarg = None
716
 
            if a[1] == '-':
717
 
                mutter("  got option %r" % a)
718
 
                if '=' in a:
719
 
                    optname, optarg = a[2:].split('=', 1)
720
 
                else:
721
 
                    optname = a[2:]
722
 
                if optname not in OPTIONS:
723
 
                    bailout('unknown long option %r' % a)
724
 
            else:
725
 
                shortopt = a[1:]
726
 
                if shortopt not in SHORT_OPTIONS:
727
 
                    bailout('unknown short option %r' % a)
728
 
                optname = SHORT_OPTIONS[shortopt]
729
 
            
730
 
            if optname in opts:
731
 
                # XXX: Do we ever want to support this, e.g. for -r?
732
 
                bailout('repeated option %r' % a)
733
 
                
734
 
            optargfn = OPTIONS[optname]
735
 
            if optargfn:
736
 
                if optarg == None:
737
 
                    if not argv:
738
 
                        bailout('option %r needs an argument' % a)
739
 
                    else:
740
 
                        optarg = argv.pop(0)
741
 
                opts[optname] = optargfn(optarg)
742
 
            else:
743
 
                if optarg != None:
744
 
                    bailout('option %r takes no argument' % optname)
745
 
                opts[optname] = True
746
 
        else:
747
 
            args.append(a)
748
 
 
 
360
    alias_opts = {}
 
361
 
 
362
    cmd_options = command.options()
 
363
    argsover = False
 
364
    proc_aliasarg = True # Are we processing alias_argv now?
 
365
    for proc_argv in alias_argv, argv:
 
366
        while proc_argv:
 
367
            a = proc_argv.pop(0)
 
368
            if argsover:
 
369
                args.append(a)
 
370
                continue
 
371
            elif a == '--':
 
372
                # We've received a standalone -- No more flags
 
373
                argsover = True
 
374
                continue
 
375
            if a[0] == '-':
 
376
                # option names must not be unicode
 
377
                a = str(a)
 
378
                optarg = None
 
379
                if a[1] == '-':
 
380
                    mutter("  got option %r", a)
 
381
                    if '=' in a:
 
382
                        optname, optarg = a[2:].split('=', 1)
 
383
                    else:
 
384
                        optname = a[2:]
 
385
                    if optname not in cmd_options:
 
386
                        raise BzrCommandError('unknown option "%s"' % a)
 
387
                else:
 
388
                    shortopt = a[1:]
 
389
                    if shortopt in Option.SHORT_OPTIONS:
 
390
                        # Multi-character options must have a space to delimit
 
391
                        # their value
 
392
                        # ^^^ what does this mean? mbp 20051014
 
393
                        optname = Option.SHORT_OPTIONS[shortopt].name
 
394
                    else:
 
395
                        # Single character short options, can be chained,
 
396
                        # and have their value appended to their name
 
397
                        shortopt = a[1:2]
 
398
                        if shortopt not in Option.SHORT_OPTIONS:
 
399
                            # We didn't find the multi-character name, and we
 
400
                            # didn't find the single char name
 
401
                            raise BzrCommandError('unknown option "%s"' % a)
 
402
                        optname = Option.SHORT_OPTIONS[shortopt].name
 
403
 
 
404
                        if a[2:]:
 
405
                            # There are extra things on this option
 
406
                            # see if it is the value, or if it is another
 
407
                            # short option
 
408
                            optargfn = Option.OPTIONS[optname].type
 
409
                            if optargfn is None:
 
410
                                # This option does not take an argument, so the
 
411
                                # next entry is another short option, pack it
 
412
                                # back into the list
 
413
                                proc_argv.insert(0, '-' + a[2:])
 
414
                            else:
 
415
                                # This option takes an argument, so pack it
 
416
                                # into the array
 
417
                                optarg = a[2:]
 
418
                    if optname not in cmd_options:
 
419
                        raise BzrCommandError('unknown option "%s"' % shortopt)
 
420
                if optname in opts:
 
421
                    # XXX: Do we ever want to support this, e.g. for -r?
 
422
                    if proc_aliasarg:
 
423
                        raise BzrCommandError('repeated option %r' % a)
 
424
                    elif optname in alias_opts:
 
425
                        # Replace what's in the alias with what's in the real
 
426
                        # argument
 
427
                        del alias_opts[optname]
 
428
                        del opts[optname]
 
429
                        proc_argv.insert(0, a)
 
430
                        continue
 
431
                    else:
 
432
                        raise BzrCommandError('repeated option %r' % a)
 
433
                    
 
434
                option_obj = cmd_options[optname]
 
435
                optargfn = option_obj.type
 
436
                if optargfn:
 
437
                    if optarg == None:
 
438
                        if not proc_argv:
 
439
                            raise BzrCommandError('option %r needs an argument' % a)
 
440
                        else:
 
441
                            optarg = proc_argv.pop(0)
 
442
                    opts[optname] = optargfn(optarg)
 
443
                    if proc_aliasarg:
 
444
                        alias_opts[optname] = optargfn(optarg)
 
445
                else:
 
446
                    if optarg != None:
 
447
                        raise BzrCommandError('option %r takes no argument' % optname)
 
448
                    opts[optname] = True
 
449
                    if proc_aliasarg:
 
450
                        alias_opts[optname] = True
 
451
            else:
 
452
                args.append(a)
 
453
        proc_aliasarg = False # Done with alias argv
749
454
    return args, opts
750
455
 
751
456
 
752
 
 
753
 
 
754
457
def _match_argform(cmd, takes_args, args):
755
458
    argdict = {}
756
459
 
778
481
                raise BzrCommandError("command %r needs one or more %s"
779
482
                        % (cmd, argname.upper()))
780
483
            argdict[argname + '_list'] = args[:-1]
781
 
            args[:-1] = []                
 
484
            args[:-1] = []
782
485
        else:
783
486
            # just a plain arg
784
487
            argname = ap
796
499
 
797
500
 
798
501
 
 
502
def apply_profiled(the_callable, *args, **kwargs):
 
503
    import hotshot
 
504
    import tempfile
 
505
    import hotshot.stats
 
506
    pffileno, pfname = tempfile.mkstemp()
 
507
    try:
 
508
        prof = hotshot.Profile(pfname)
 
509
        try:
 
510
            ret = prof.runcall(the_callable, *args, **kwargs) or 0
 
511
        finally:
 
512
            prof.close()
 
513
        stats = hotshot.stats.load(pfname)
 
514
        stats.strip_dirs()
 
515
        stats.sort_stats('cum')   # 'time'
 
516
        ## XXX: Might like to write to stderr or the trace file instead but
 
517
        ## print_stats seems hardcoded to stdout
 
518
        stats.print_stats(20)
 
519
        return ret
 
520
    finally:
 
521
        os.close(pffileno)
 
522
        os.remove(pfname)
 
523
 
 
524
 
 
525
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
 
526
    from bzrlib.lsprof import profile
 
527
    import cPickle
 
528
    ret, stats = profile(the_callable, *args, **kwargs)
 
529
    stats.sort()
 
530
    if filename is None:
 
531
        stats.pprint()
 
532
    else:
 
533
        stats.freeze()
 
534
        cPickle.dump(stats, open(filename, 'w'), 2)
 
535
        print 'Profile data written to %r.' % filename
 
536
    return ret
 
537
 
 
538
 
 
539
def get_alias(cmd):
 
540
    """Return an expanded alias, or None if no alias exists"""
 
541
    import bzrlib.config
 
542
    alias = bzrlib.config.GlobalConfig().get_alias(cmd)
 
543
    if (alias):
 
544
        return alias.split(' ')
 
545
    return None
 
546
 
 
547
 
799
548
def run_bzr(argv):
800
549
    """Execute a command.
801
550
 
802
551
    This is similar to main(), but without all the trappings for
803
552
    logging and error handling.  
 
553
    
 
554
    argv
 
555
       The command-line arguments, without the program name from argv[0]
 
556
       These should already be decoded. All library/test code calling
 
557
       run_bzr should be passing valid strings (don't need decoding).
 
558
    
 
559
    Returns a command status or raises an exception.
 
560
 
 
561
    Special master options: these must come before the command because
 
562
    they control how the command is interpreted.
 
563
 
 
564
    --no-plugins
 
565
        Do not load plugin modules at all
 
566
 
 
567
    --no-aliases
 
568
        Do not allow aliases
 
569
 
 
570
    --builtin
 
571
        Only use builtin commands.  (Plugins are still allowed to change
 
572
        other behaviour.)
 
573
 
 
574
    --profile
 
575
        Run under the Python hotshot profiler.
 
576
 
 
577
    --lsprof
 
578
        Run under the Python lsprof profiler.
804
579
    """
805
 
    argv = [a.decode(bzrlib.user_encoding) for a in argv]
806
 
    
 
580
    argv = list(argv)
 
581
 
 
582
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin =  \
 
583
                opt_no_aliases = False
 
584
    opt_lsprof_file = None
 
585
 
 
586
    # --no-plugins is handled specially at a very early stage. We need
 
587
    # to load plugins before doing other command parsing so that they
 
588
    # can override commands, but this needs to happen first.
 
589
 
 
590
    argv_copy = []
 
591
    i = 0
 
592
    while i < len(argv):
 
593
        a = argv[i]
 
594
        if a == '--profile':
 
595
            opt_profile = True
 
596
        elif a == '--lsprof':
 
597
            opt_lsprof = True
 
598
        elif a == '--lsprof-file':
 
599
            opt_lsprof_file = argv[i + 1]
 
600
            i += 1
 
601
        elif a == '--no-plugins':
 
602
            opt_no_plugins = True
 
603
        elif a == '--no-aliases':
 
604
            opt_no_aliases = True
 
605
        elif a == '--builtin':
 
606
            opt_builtin = True
 
607
        elif a in ('--quiet', '-q'):
 
608
            be_quiet()
 
609
        else:
 
610
            argv_copy.append(a)
 
611
        i += 1
 
612
 
 
613
    argv = argv_copy
 
614
    if (not argv):
 
615
        from bzrlib.builtins import cmd_help
 
616
        cmd_help().run_argv_aliases([])
 
617
        return 0
 
618
 
 
619
    if argv[0] == '--version':
 
620
        from bzrlib.builtins import show_version
 
621
        show_version()
 
622
        return 0
 
623
        
 
624
    if not opt_no_plugins:
 
625
        from bzrlib.plugin import load_plugins
 
626
        load_plugins()
 
627
    else:
 
628
        from bzrlib.plugin import disable_plugins
 
629
        disable_plugins()
 
630
 
 
631
    alias_argv = None
 
632
 
 
633
    if not opt_no_aliases:
 
634
        alias_argv = get_alias(argv[0])
 
635
        if alias_argv:
 
636
            alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
 
637
            argv[0] = alias_argv.pop(0)
 
638
 
 
639
    cmd = str(argv.pop(0))
 
640
 
 
641
    cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
 
642
    if not getattr(cmd_obj.run_argv, 'is_deprecated', False):
 
643
        run = cmd_obj.run_argv
 
644
        run_argv = [argv]
 
645
    else:
 
646
        run = cmd_obj.run_argv_aliases
 
647
        run_argv = [argv, alias_argv]
 
648
 
807
649
    try:
808
 
        args, opts = parse_args(argv[1:])
809
 
        if 'help' in opts:
810
 
            import help
811
 
            if args:
812
 
                help.help(args[0])
813
 
            else:
814
 
                help.help()
815
 
            return 0
816
 
        elif 'version' in opts:
817
 
            show_version()
818
 
            return 0
819
 
        cmd = str(args.pop(0))
820
 
    except IndexError:
821
 
        log_error('usage: bzr COMMAND')
822
 
        log_error('  try "bzr help"')
823
 
        return 1
824
 
 
825
 
    canonical_cmd, cmd_class = get_cmd_class(cmd)
826
 
 
827
 
    # global option
828
 
    if 'profile' in opts:
829
 
        profile = True
830
 
        del opts['profile']
831
 
    else:
832
 
        profile = False
833
 
 
834
 
    # check options are reasonable
835
 
    allowed = cmd_class.takes_options
836
 
    for oname in opts:
837
 
        if oname not in allowed:
838
 
            raise BzrCommandError("option %r is not allowed for command %r"
839
 
                                  % (oname, cmd))
840
 
 
841
 
    # mix arguments and options into one dictionary
842
 
    cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
843
 
    cmdopts = {}
844
 
    for k, v in opts.items():
845
 
        cmdopts[k.replace('-', '_')] = v
846
 
 
847
 
    if profile:
848
 
        import hotshot, tempfile
849
 
        pffileno, pfname = tempfile.mkstemp()
 
650
        if opt_lsprof:
 
651
            ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
 
652
        elif opt_profile:
 
653
            ret = apply_profiled(run, *run_argv)
 
654
        else:
 
655
            ret = run(*run_argv)
 
656
        return ret or 0
 
657
    finally:
 
658
        # reset, in case we may do other commands later within the same process
 
659
        be_quiet(False)
 
660
 
 
661
def display_command(func):
 
662
    """Decorator that suppresses pipe/interrupt errors."""
 
663
    def ignore_pipe(*args, **kwargs):
850
664
        try:
851
 
            prof = hotshot.Profile(pfname)
852
 
            ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
853
 
            prof.close()
854
 
 
855
 
            import hotshot.stats
856
 
            stats = hotshot.stats.load(pfname)
857
 
            #stats.strip_dirs()
858
 
            stats.sort_stats('time')
859
 
            ## XXX: Might like to write to stderr or the trace file instead but
860
 
            ## print_stats seems hardcoded to stdout
861
 
            stats.print_stats(20)
862
 
            
863
 
            return ret.status
864
 
 
865
 
        finally:
866
 
            os.close(pffileno)
867
 
            os.remove(pfname)
868
 
    else:
869
 
        cmdobj = cmd_class(cmdopts, cmdargs).status 
870
 
 
871
 
 
872
 
def _report_exception(summary, quiet=False):
873
 
    import traceback
874
 
    log_error('bzr: ' + summary)
875
 
    bzrlib.trace.log_exception()
876
 
 
877
 
    if not quiet:
878
 
        tb = sys.exc_info()[2]
879
 
        exinfo = traceback.extract_tb(tb)
880
 
        if exinfo:
881
 
            sys.stderr.write('  at %s:%d in %s()\n' % exinfo[-1][:3])
882
 
        sys.stderr.write('  see ~/.bzr.log for debug information\n')
883
 
 
 
665
            result = func(*args, **kwargs)
 
666
            sys.stdout.flush()
 
667
            return result
 
668
        except IOError, e:
 
669
            if not hasattr(e, 'errno'):
 
670
                raise
 
671
            if e.errno != errno.EPIPE:
 
672
                # Win32 raises IOError with errno=0 on a broken pipe
 
673
                if sys.platform != 'win32' or e.errno != 0:
 
674
                    raise
 
675
            pass
 
676
        except KeyboardInterrupt:
 
677
            pass
 
678
    return ignore_pipe
884
679
 
885
680
 
886
681
def main(argv):
887
 
    import errno
888
 
    
889
 
    bzrlib.open_tracefile(argv)
890
 
 
 
682
    import bzrlib.ui
 
683
    from bzrlib.ui.text import TextUIFactory
 
684
    bzrlib.ui.ui_factory = TextUIFactory()
 
685
    argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
 
686
    ret = run_bzr_catch_errors(argv)
 
687
    mutter("return code %d", ret)
 
688
    return ret
 
689
 
 
690
 
 
691
def run_bzr_catch_errors(argv):
891
692
    try:
892
 
        try:
893
 
            try:
894
 
                return run_bzr(argv)
895
 
            finally:
896
 
                # do this here inside the exception wrappers to catch EPIPE
897
 
                sys.stdout.flush()
898
 
        except BzrError, e:
899
 
            quiet = isinstance(e, (BzrCommandError))
900
 
            _report_exception('error: ' + e.args[0], quiet=quiet)
901
 
            if len(e.args) > 1:
902
 
                for h in e.args[1]:
903
 
                    # some explanation or hints
904
 
                    log_error('  ' + h)
905
 
            return 1
906
 
        except AssertionError, e:
907
 
            msg = 'assertion failed'
908
 
            if str(e):
909
 
                msg += ': ' + str(e)
910
 
            _report_exception(msg)
911
 
            return 2
912
 
        except KeyboardInterrupt, e:
913
 
            _report_exception('interrupted', quiet=True)
914
 
            return 2
915
 
        except Exception, e:
916
 
            quiet = False
917
 
            if isinstance(e, IOError) and e.errno == errno.EPIPE:
918
 
                quiet = True
919
 
                msg = 'broken pipe'
920
 
            else:
921
 
                msg = str(e).rstrip('\n')
922
 
            _report_exception(msg, quiet)
923
 
            return 2
924
 
    finally:
925
 
        bzrlib.trace.close_trace()
926
 
 
 
693
        return run_bzr(argv)
 
694
        # do this here inside the exception wrappers to catch EPIPE
 
695
        sys.stdout.flush()
 
696
    except Exception, e:
 
697
        # used to handle AssertionError and KeyboardInterrupt
 
698
        # specially here, but hopefully they're handled ok by the logger now
 
699
        bzrlib.trace.report_exception(sys.exc_info(), sys.stderr)
 
700
        if os.environ.get('BZR_PDB'):
 
701
            print '**** entering debugger'
 
702
            import pdb
 
703
            pdb.post_mortem(sys.exc_traceback)
 
704
        return 3
927
705
 
928
706
if __name__ == '__main__':
929
707
    sys.exit(main(sys.argv))