← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Martin Pool
  • Date: 2005-05-02 04:24:33 UTC
  • Revision ID: mbp@sourcefrog.net-20050502042433-c825a7f7235f6b15
doc: notes on merge

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/commands.py
1
 
# Copyright (C) 2004, 2005 by Canonical Ltd
 
1
# Copyright (C) 2004, 2005 by Martin Pool
 
2
# Copyright (C) 2005 by Canonical Ltd
 
3
 
2
4
 
3
5
# This program is free software; you can redistribute it and/or modify
4
6
# it under the terms of the GNU General Public License as published by
14
16
# along with this program; if not, write to the Free Software
15
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
18
 
17
 
 
18
 
 
19
 
import sys, os
 
19
"""Bazaar-NG -- a free distributed version-control tool
 
20
http://bazaar-ng.org/
 
21
 
 
22
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
 
23
 
 
24
* Metadata format is not stable yet -- you may need to
 
25
  discard history in the future.
 
26
 
 
27
* Many commands unimplemented or partially implemented.
 
28
 
 
29
* Space-inefficient storage.
 
30
 
 
31
* No merge operators yet.
 
32
 
 
33
Interesting commands:
 
34
 
 
35
  bzr help [COMMAND]
 
36
      Show help screen
 
37
  bzr version
 
38
      Show software version/licence/non-warranty.
 
39
  bzr init
 
40
      Start versioning the current directory
 
41
  bzr add FILE...
 
42
      Make files versioned.
 
43
  bzr log
 
44
      Show revision history.
 
45
  bzr rename FROM TO
 
46
      Rename one file.
 
47
  bzr move FROM... DESTDIR
 
48
      Move one or more files to a different directory.
 
49
  bzr diff [FILE...]
 
50
      Show changes from last revision to working copy.
 
51
  bzr commit -m 'MESSAGE'
 
52
      Store current state as new revision.
 
53
  bzr export REVNO DESTINATION
 
54
      Export the branch state at a previous version.
 
55
  bzr status
 
56
      Show summary of pending changes.
 
57
  bzr remove FILE...
 
58
      Make a file not versioned.
 
59
  bzr info
 
60
      Show statistics about this branch.
 
61
  bzr check
 
62
      Verify history is stored safely. 
 
63
  (for more type 'bzr help commands')
 
64
"""
 
65
 
 
66
 
 
67
 
 
68
 
 
69
import sys, os, time, types, shutil, tempfile, fnmatch, difflib, os.path
 
70
from sets import Set
 
71
from pprint import pprint
 
72
from stat import *
 
73
from glob import glob
 
74
from inspect import getdoc
20
75
 
21
76
import bzrlib
 
77
from bzrlib.store import ImmutableStore
22
78
from bzrlib.trace import mutter, note, log_error
23
 
from bzrlib.errors import bailout, BzrError, BzrCheckError, BzrCommandError
24
 
from bzrlib.osutils import quotefn
25
 
from bzrlib import Branch, Inventory, InventoryEntry, BZRDIR, \
 
79
from bzrlib.errors import bailout, BzrError, BzrCheckError
 
80
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
 
81
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
 
82
from bzrlib.revision import Revision
 
83
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
26
84
     format_date
27
85
 
28
 
 
29
 
def _squish_command_name(cmd):
30
 
    return 'cmd_' + cmd.replace('-', '_')
31
 
 
32
 
 
33
 
def _unsquish_command_name(cmd):
34
 
    assert cmd.startswith("cmd_")
35
 
    return cmd[4:].replace('_','-')
36
 
 
37
 
def _parse_revision_str(revstr):
38
 
    """This handles a revision string -> revno. 
39
 
 
40
 
    There are several possibilities:
41
 
 
42
 
        '234'       -> 234
43
 
        '234:345'   -> [234, 345]
44
 
        ':234'      -> [None, 234]
45
 
        '234:'      -> [234, None]
46
 
 
47
 
    In the future we will also support:
48
 
        'uuid:blah-blah-blah'   -> ?
49
 
        'hash:blahblahblah'     -> ?
50
 
        potentially:
51
 
        'tag:mytag'             -> ?
52
 
    """
53
 
    if revstr.find(':') != -1:
54
 
        revs = revstr.split(':')
55
 
        if len(revs) > 2:
56
 
            raise ValueError('More than 2 pieces not supported for --revision: %r' % revstr)
57
 
 
58
 
        if not revs[0]:
59
 
            revs[0] = None
60
 
        else:
61
 
            revs[0] = int(revs[0])
62
 
 
63
 
        if not revs[1]:
64
 
            revs[1] = None
65
 
        else:
66
 
            revs[1] = int(revs[1])
67
 
    else:
68
 
        revs = int(revstr)
69
 
    return revs
70
 
 
71
 
def _find_plugins():
72
 
    """Find all python files which are plugins, and load their commands
73
 
    to add to the list of "all commands"
74
 
 
75
 
    The environment variable BZRPATH is considered a delimited set of
76
 
    paths to look through. Each entry is searched for *.py files.
77
 
    If a directory is found, it is also searched, but they are 
78
 
    not searched recursively. This allows you to revctl the plugins.
79
 
    
80
 
    Inside the plugin should be a series of cmd_* function, which inherit from
81
 
    the bzrlib.commands.Command class.
82
 
    """
83
 
    bzrpath = os.environ.get('BZRPLUGINPATH', '')
84
 
 
85
 
    plugin_cmds = {} 
86
 
    if not bzrpath:
87
 
        return plugin_cmds
88
 
    _platform_extensions = {
89
 
        'win32':'.pyd',
90
 
        'cygwin':'.dll',
91
 
        'darwin':'.dylib',
92
 
        'linux2':'.so'
93
 
        }
94
 
    if _platform_extensions.has_key(sys.platform):
95
 
        platform_extension = _platform_extensions[sys.platform]
96
 
    else:
97
 
        platform_extension = None
98
 
    for d in bzrpath.split(os.pathsep):
99
 
        plugin_names = {} # This should really be a set rather than a dict
100
 
        for f in os.listdir(d):
101
 
            if f.endswith('.py'):
102
 
                f = f[:-3]
103
 
            elif f.endswith('.pyc') or f.endswith('.pyo'):
104
 
                f = f[:-4]
105
 
            elif platform_extension and f.endswith(platform_extension):
106
 
                f = f[:-len(platform_extension)]
107
 
                if f.endswidth('module'):
108
 
                    f = f[:-len('module')]
109
 
            else:
110
 
                continue
111
 
            if not plugin_names.has_key(f):
112
 
                plugin_names[f] = True
113
 
 
114
 
        plugin_names = plugin_names.keys()
115
 
        plugin_names.sort()
116
 
        try:
117
 
            sys.path.insert(0, d)
118
 
            for name in plugin_names:
119
 
                try:
120
 
                    old_module = None
121
 
                    try:
122
 
                        if sys.modules.has_key(name):
123
 
                            old_module = sys.modules[name]
124
 
                            del sys.modules[name]
125
 
                        plugin = __import__(name, locals())
126
 
                        for k in dir(plugin):
127
 
                            if k.startswith('cmd_'):
128
 
                                k_unsquished = _unsquish_command_name(k)
129
 
                                if not plugin_cmds.has_key(k_unsquished):
130
 
                                    plugin_cmds[k_unsquished] = getattr(plugin, k)
131
 
                                else:
132
 
                                    log_error('Two plugins defined the same command: %r' % k)
133
 
                                    log_error('Not loading the one in %r in dir %r' % (name, d))
134
 
                    finally:
135
 
                        if old_module:
136
 
                            sys.modules[name] = old_module
137
 
                except ImportError, e:
138
 
                    log_error('Unable to load plugin: %r from %r\n%s' % (name, d, e))
139
 
        finally:
140
 
            sys.path.pop(0)
141
 
    return plugin_cmds
142
 
 
143
 
def _get_cmd_dict(include_plugins=True):
144
 
    d = {}
145
 
    for k, v in globals().iteritems():
146
 
        if k.startswith("cmd_"):
147
 
            d[_unsquish_command_name(k)] = v
148
 
    if include_plugins:
149
 
        d.update(_find_plugins())
150
 
    return d
151
 
    
152
 
def get_all_cmds(include_plugins=True):
153
 
    """Return canonical name and class for all registered commands."""
154
 
    for k, v in _get_cmd_dict(include_plugins=include_plugins).iteritems():
155
 
        yield k,v
156
 
 
157
 
 
158
 
def get_cmd_class(cmd,include_plugins=True):
159
 
    """Return the canonical name and command class for a command.
160
 
    """
161
 
    cmd = str(cmd)                      # not unicode
162
 
 
163
 
    # first look up this command under the specified name
164
 
    cmds = _get_cmd_dict(include_plugins=include_plugins)
 
86
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
 
87
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
 
88
 
 
89
## standard representation
 
90
NONE_STRING = '(none)'
 
91
EMPTY = 'empty'
 
92
 
 
93
 
 
94
## TODO: Perhaps a different version of inventory commands that
 
95
## returns iterators...
 
96
 
 
97
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
 
98
 
 
99
## TODO: Some kind of locking on branches.  Perhaps there should be a
 
100
## parameter to the branch object saying whether we want a read or
 
101
## write lock; release it from destructor.  Perhaps don't even need a
 
102
## read lock to look at immutable objects?
 
103
 
 
104
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
 
105
## to compare output?
 
106
 
 
107
## TODO: Some kind of global code to generate the right Branch object
 
108
## to work on.  Almost, but not quite all, commands need one, and it
 
109
## can be taken either from their parameters or their working
 
110
## directory.
 
111
 
 
112
 
 
113
 
 
114
cmd_aliases = {
 
115
    '?':         'help',
 
116
    'ci':        'commit',
 
117
    'checkin':   'commit',
 
118
    'di':        'diff',
 
119
    'st':        'status',
 
120
    'stat':      'status',
 
121
    }
 
122
 
 
123
 
 
124
def get_cmd_handler(cmd):
 
125
    cmd = str(cmd)
 
126
    
 
127
    cmd = cmd_aliases.get(cmd, cmd)
 
128
    
165
129
    try:
166
 
        return cmd, cmds[cmd]
 
130
        cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
167
131
    except KeyError:
168
 
        pass
169
 
 
170
 
    # look for any command which claims this as an alias
171
 
    for cmdname, cmdclass in cmds.iteritems():
172
 
        if cmd in cmdclass.aliases:
173
 
            return cmdname, cmdclass
174
 
 
175
 
    cmdclass = ExternalCommand.find_command(cmd)
176
 
    if cmdclass:
177
 
        return cmd, cmdclass
178
 
 
179
 
    raise BzrCommandError("unknown command %r" % cmd)
180
 
 
181
 
 
182
 
class Command(object):
183
 
    """Base class for commands.
184
 
 
185
 
    The docstring for an actual command should give a single-line
186
 
    summary, then a complete description of the command.  A grammar
187
 
    description will be inserted.
188
 
 
189
 
    takes_args
190
 
        List of argument forms, marked with whether they are optional,
191
 
        repeated, etc.
192
 
 
193
 
    takes_options
194
 
        List of options that may be given for this command.
195
 
 
196
 
    hidden
197
 
        If true, this command isn't advertised.
198
 
    """
199
 
    aliases = []
200
 
    
201
 
    takes_args = []
202
 
    takes_options = []
203
 
 
204
 
    hidden = False
205
 
    
206
 
    def __init__(self, options, arguments):
207
 
        """Construct and run the command.
208
 
 
209
 
        Sets self.status to the return value of run()."""
210
 
        assert isinstance(options, dict)
211
 
        assert isinstance(arguments, dict)
212
 
        cmdargs = options.copy()
213
 
        cmdargs.update(arguments)
214
 
        assert self.__doc__ != Command.__doc__, \
215
 
               ("No help message set for %r" % self)
216
 
        self.status = self.run(**cmdargs)
217
 
 
218
 
    
219
 
    def run(self):
220
 
        """Override this in sub-classes.
221
 
 
222
 
        This is invoked with the options and arguments bound to
223
 
        keyword parameters.
224
 
 
225
 
        Return 0 or None if the command was successful, or a shell
226
 
        error code if not.
227
 
        """
228
 
        return 0
229
 
 
230
 
 
231
 
class ExternalCommand(Command):
232
 
    """Class to wrap external commands.
233
 
 
234
 
    We cheat a little here, when get_cmd_class() calls us we actually give it back
235
 
    an object we construct that has the appropriate path, help, options etc for the
236
 
    specified command.
237
 
 
238
 
    When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
239
 
    method, which we override to call the Command.__init__ method. That then calls
240
 
    our run method which is pretty straight forward.
241
 
 
242
 
    The only wrinkle is that we have to map bzr's dictionary of options and arguments
243
 
    back into command line options and arguments for the script.
244
 
    """
245
 
 
246
 
    def find_command(cls, cmd):
247
 
        import os.path
248
 
        bzrpath = os.environ.get('BZRPATH', '')
249
 
 
250
 
        for dir in bzrpath.split(os.pathsep):
251
 
            path = os.path.join(dir, cmd)
252
 
            if os.path.isfile(path):
253
 
                return ExternalCommand(path)
254
 
 
255
 
        return None
256
 
 
257
 
    find_command = classmethod(find_command)
258
 
 
259
 
    def __init__(self, path):
260
 
        self.path = path
261
 
 
262
 
        # TODO: If either of these fail, we should detect that and
263
 
        # assume that path is not really a bzr plugin after all.
264
 
 
265
 
        pipe = os.popen('%s --bzr-usage' % path, 'r')
266
 
        self.takes_options = pipe.readline().split()
267
 
        self.takes_args = pipe.readline().split()
268
 
        pipe.close()
269
 
 
270
 
        pipe = os.popen('%s --bzr-help' % path, 'r')
271
 
        self.__doc__ = pipe.read()
272
 
        pipe.close()
273
 
 
274
 
    def __call__(self, options, arguments):
275
 
        Command.__init__(self, options, arguments)
276
 
        return self
277
 
 
278
 
    def run(self, **kargs):
279
 
        opts = []
280
 
        args = []
281
 
 
282
 
        keys = kargs.keys()
283
 
        keys.sort()
284
 
        for name in keys:
285
 
            value = kargs[name]
286
 
            if OPTIONS.has_key(name):
287
 
                # it's an option
288
 
                opts.append('--%s' % name)
289
 
                if value is not None and value is not True:
290
 
                    opts.append(str(value))
291
 
            else:
292
 
                # it's an arg, or arg list
293
 
                if type(value) is not list:
294
 
                    value = [value]
295
 
                for v in value:
296
 
                    if v is not None:
297
 
                        args.append(str(v))
298
 
 
299
 
        self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
300
 
        return self.status
301
 
 
302
 
 
303
 
class cmd_status(Command):
 
132
        raise BzrError("unknown command %r" % cmd)
 
133
 
 
134
    return cmd, cmd_handler
 
135
 
 
136
 
 
137
 
 
138
def cmd_status(all=False):
304
139
    """Display status summary.
305
140
 
306
 
    This reports on versioned and unknown files, reporting them
307
 
    grouped by state.  Possible states are:
308
 
 
309
 
    added
310
 
        Versioned in the working copy but not in the previous revision.
311
 
 
312
 
    removed
313
 
        Versioned in the previous revision but removed or deleted
314
 
        in the working copy.
315
 
 
316
 
    renamed
317
 
        Path of this file changed from the previous revision;
318
 
        the text may also have changed.  This includes files whose
319
 
        parent directory was renamed.
320
 
 
321
 
    modified
322
 
        Text has changed since the previous revision.
323
 
 
324
 
    unchanged
325
 
        Nothing about this file has changed since the previous revision.
326
 
        Only shown with --all.
327
 
 
328
 
    unknown
329
 
        Not versioned and not matching an ignore pattern.
330
 
 
331
 
    To see ignored files use 'bzr ignored'.  For details in the
332
 
    changes to file texts, use 'bzr diff'.
333
 
 
334
 
    If no arguments are specified, the status of the entire working
335
 
    directory is shown.  Otherwise, only the status of the specified
336
 
    files or directories is reported.  If a directory is given, status
337
 
    is reported for everything inside that directory.
 
141
    For each file there is a single line giving its file state and name.
 
142
    The name is that in the current revision unless it is deleted or
 
143
    missing, in which case the old name is shown.
338
144
    """
339
 
    takes_args = ['file*']
340
 
    takes_options = ['all', 'show-ids']
341
 
    aliases = ['st', 'stat']
342
 
    
343
 
    def run(self, all=False, show_ids=False, file_list=None):
344
 
        if file_list:
345
 
            b = Branch(file_list[0])
346
 
            file_list = [b.relpath(x) for x in file_list]
347
 
            # special case: only one path was given and it's the root
348
 
            # of the branch
349
 
            if file_list == ['']:
350
 
                file_list = None
351
 
        else:
352
 
            b = Branch('.')
353
 
        import status
354
 
        status.show_status(b, show_unchanged=all, show_ids=show_ids,
355
 
                           specific_files=file_list)
356
 
 
357
 
 
358
 
class cmd_cat_revision(Command):
359
 
    """Write out metadata for a revision."""
360
 
 
361
 
    hidden = True
362
 
    takes_args = ['revision_id']
363
 
    
364
 
    def run(self, revision_id):
365
 
        Branch('.').get_revision(revision_id).write_xml(sys.stdout)
366
 
 
367
 
 
368
 
class cmd_revno(Command):
369
 
    """Show current revision number.
370
 
 
371
 
    This is equal to the number of revisions on this branch."""
372
 
    def run(self):
373
 
        print Branch('.').revno()
374
 
 
375
 
    
376
 
class cmd_add(Command):
 
145
    #import bzrlib.status
 
146
    #bzrlib.status.tree_status(Branch('.'))
 
147
    Branch('.').show_status(show_all=all)
 
148
 
 
149
 
 
150
 
 
151
######################################################################
 
152
# examining history
 
153
def cmd_get_revision(revision_id):
 
154
    Branch('.').get_revision(revision_id).write_xml(sys.stdout)
 
155
 
 
156
 
 
157
def cmd_get_file_text(text_id):
 
158
    """Get contents of a file by hash."""
 
159
    sf = Branch('.').text_store[text_id]
 
160
    pumpfile(sf, sys.stdout)
 
161
 
 
162
 
 
163
 
 
164
######################################################################
 
165
# commands
 
166
    
 
167
 
 
168
def cmd_revno():
 
169
    """Show number of revisions on this branch"""
 
170
    print Branch('.').revno()
 
171
    
 
172
 
 
173
    
 
174
def cmd_add(file_list, verbose=False):
377
175
    """Add specified files or directories.
378
176
 
379
177
    In non-recursive mode, all the named items are added, regardless
394
192
    TODO: Perhaps adding a file whose directly is not versioned should
395
193
    recursively add that parent, rather than giving an error?
396
194
    """
397
 
    takes_args = ['file+']
398
 
    takes_options = ['verbose', 'no-recurse']
399
 
    
400
 
    def run(self, file_list, verbose=False, no_recurse=False):
401
 
        bzrlib.add.smart_add(file_list, verbose, not no_recurse)
402
 
 
403
 
 
404
 
class cmd_relpath(Command):
405
 
    """Show path of a file relative to root"""
406
 
    takes_args = ['filename']
407
 
    hidden = True
408
 
    
409
 
    def run(self, filename):
410
 
        print Branch(filename).relpath(filename)
411
 
 
412
 
 
413
 
 
414
 
class cmd_inventory(Command):
415
 
    """Show inventory of the current working copy or a revision."""
416
 
    takes_options = ['revision', 'show-ids']
417
 
    
418
 
    def run(self, revision=None, show_ids=False):
419
 
        b = Branch('.')
420
 
        if revision == None:
421
 
            inv = b.read_working_inventory()
422
 
        else:
423
 
            inv = b.get_revision_inventory(b.lookup_revision(revision))
424
 
 
425
 
        for path, entry in inv.entries():
426
 
            if show_ids:
427
 
                print '%-50s %s' % (path, entry.file_id)
428
 
            else:
429
 
                print path
430
 
 
431
 
 
432
 
class cmd_move(Command):
433
 
    """Move files to a different directory.
434
 
 
435
 
    examples:
436
 
        bzr move *.txt doc
437
 
 
438
 
    The destination must be a versioned directory in the same branch.
439
 
    """
440
 
    takes_args = ['source$', 'dest']
441
 
    def run(self, source_list, dest):
442
 
        b = Branch('.')
443
 
 
444
 
        b.move([b.relpath(s) for s in source_list], b.relpath(dest))
445
 
 
446
 
 
447
 
class cmd_rename(Command):
 
195
    bzrlib.add.smart_add(file_list, verbose)
 
196
    
 
197
 
 
198
def cmd_relpath(filename):
 
199
    """Show path of file relative to root"""
 
200
    print Branch(filename).relpath(filename)
 
201
 
 
202
 
 
203
 
 
204
def cmd_inventory(revision=None):
 
205
    """Show inventory of the current working copy."""
 
206
    ## TODO: Also optionally show a previous inventory
 
207
    ## TODO: Format options
 
208
    b = Branch('.')
 
209
    if revision == None:
 
210
        inv = b.read_working_inventory()
 
211
    else:
 
212
        inv = b.get_revision_inventory(b.lookup_revision(revision))
 
213
        
 
214
    for path, entry in inv.iter_entries():
 
215
        print '%-50s %s' % (entry.file_id, path)
 
216
 
 
217
 
 
218
 
 
219
# TODO: Maybe a 'mv' command that has the combined move/rename
 
220
# special behaviour of Unix?
 
221
 
 
222
def cmd_move(source_list, dest):
 
223
    b = Branch('.')
 
224
 
 
225
    b.move([b.relpath(s) for s in source_list], b.relpath(dest))
 
226
 
 
227
 
 
228
 
 
229
def cmd_rename(from_name, to_name):
448
230
    """Change the name of an entry.
449
231
 
 
232
    usage: bzr rename FROM_NAME TO_NAME
 
233
 
450
234
    examples:
451
235
      bzr rename frob.c frobber.c
452
236
      bzr rename src/frob.c lib/frob.c
458
242
 
459
243
    TODO: Some way to rename multiple files without invoking bzr for each
460
244
    one?"""
461
 
    takes_args = ['from_name', 'to_name']
 
245
    b = Branch('.')
 
246
    b.rename_one(b.relpath(from_name), b.relpath(to_name))
462
247
    
463
 
    def run(self, from_name, to_name):
464
 
        b = Branch('.')
465
 
        b.rename_one(b.relpath(from_name), b.relpath(to_name))
466
 
 
467
 
 
468
 
 
469
 
 
470
 
 
471
 
class cmd_pull(Command):
472
 
    """Pull any changes from another branch into the current one.
473
 
 
474
 
    If the location is omitted, the last-used location will be used.
475
 
    Both the revision history and the working directory will be
476
 
    updated.
477
 
 
478
 
    This command only works on branches that have not diverged.  Branches are
479
 
    considered diverged if both branches have had commits without first
480
 
    pulling from the other.
481
 
 
482
 
    If branches have diverged, you can use 'bzr merge' to pull the text changes
483
 
    from one into the other.
484
 
    """
485
 
    takes_args = ['location?']
486
 
 
487
 
    def run(self, location=None):
488
 
        from bzrlib.merge import merge
489
 
        import errno
490
 
        
491
 
        br_to = Branch('.')
492
 
        stored_loc = None
493
 
        try:
494
 
            stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
495
 
        except IOError, e:
496
 
            if errno == errno.ENOENT:
497
 
                raise
498
 
        if location is None:
499
 
            location = stored_loc
500
 
        if location is None:
501
 
            raise BzrCommandError("No pull location known or specified.")
502
 
        from branch import find_branch, DivergedBranches
503
 
        br_from = find_branch(location)
504
 
        location = pull_loc(br_from)
505
 
        old_revno = br_to.revno()
506
 
        try:
507
 
            br_to.update_revisions(br_from)
508
 
        except DivergedBranches:
509
 
            raise BzrCommandError("These branches have diverged.  Try merge.")
510
 
            
511
 
        merge(('.', -1), ('.', old_revno), check_clean=False)
512
 
        if location != stored_loc:
513
 
            br_to.controlfile("x-pull", "wb").write(location + "\n")
514
 
 
515
 
 
516
 
 
517
 
class cmd_branch(Command):
518
 
    """Create a new copy of a branch.
519
 
 
520
 
    If the TO_LOCATION is omitted, the last component of the
521
 
    FROM_LOCATION will be used.  In other words,
522
 
    "branch ../foo/bar" will attempt to create ./bar.
523
 
    """
524
 
    takes_args = ['from_location', 'to_location?']
525
 
 
526
 
    def run(self, from_location, to_location=None):
527
 
        import errno
528
 
        from bzrlib.merge import merge
529
 
        
530
 
        if to_location is None:
531
 
            to_location = os.path.basename(from_location)
532
 
            # FIXME: If there's a trailing slash, keep removing them
533
 
            # until we find the right bit
534
 
 
535
 
        try:
536
 
            os.mkdir(to_location)
537
 
        except OSError, e:
538
 
            if e.errno == errno.EEXIST:
539
 
                raise BzrCommandError('Target directory "%s" already exists.' %
540
 
                                      to_location)
541
 
            if e.errno == errno.ENOENT:
542
 
                raise BzrCommandError('Parent of "%s" does not exist.' %
543
 
                                      to_location)
544
 
            else:
545
 
                raise
546
 
        br_to = Branch(to_location, init=True)
547
 
        from branch import find_branch, DivergedBranches
548
 
        try:
549
 
            br_from = find_branch(from_location)
550
 
        except OSError, e:
551
 
            if e.errno == errno.ENOENT:
552
 
                raise BzrCommandError('Source location "%s" does not exist.' %
553
 
                                      to_location)
554
 
            else:
555
 
                raise
556
 
 
557
 
        from_location = pull_loc(br_from)
558
 
        br_to.update_revisions(br_from)
559
 
        merge((to_location, -1), (to_location, 0), this_dir=to_location,
560
 
              check_clean=False)
561
 
        br_to.controlfile("x-pull", "wb").write(from_location + "\n")
562
 
 
563
 
 
564
 
def pull_loc(branch):
565
 
    # TODO: Should perhaps just make attribute be 'base' in
566
 
    # RemoteBranch and Branch?
567
 
    if hasattr(branch, "baseurl"):
568
 
        return branch.baseurl
569
 
    else:
570
 
        return branch.base
571
 
 
572
 
 
573
 
 
574
 
class cmd_renames(Command):
 
248
 
 
249
 
 
250
 
 
251
def cmd_renames(dir='.'):
575
252
    """Show list of renamed files.
576
253
 
 
254
    usage: bzr renames [BRANCH]
 
255
 
577
256
    TODO: Option to show renames between two historical versions.
578
257
 
579
258
    TODO: Only show renames under dir, rather than in the whole branch.
580
259
    """
581
 
    takes_args = ['dir?']
582
 
 
583
 
    def run(self, dir='.'):
584
 
        b = Branch(dir)
585
 
        old_inv = b.basis_tree().inventory
586
 
        new_inv = b.read_working_inventory()
587
 
 
588
 
        renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
589
 
        renames.sort()
590
 
        for old_name, new_name in renames:
591
 
            print "%s => %s" % (old_name, new_name)        
592
 
 
593
 
 
594
 
class cmd_info(Command):
595
 
    """Show statistical information about a branch."""
596
 
    takes_args = ['branch?']
597
 
    
598
 
    def run(self, branch=None):
599
 
        import info
600
 
 
601
 
        from branch import find_branch
602
 
        b = find_branch(branch)
603
 
        info.show_info(b)
604
 
 
605
 
 
606
 
class cmd_remove(Command):
607
 
    """Make a file unversioned.
608
 
 
609
 
    This makes bzr stop tracking changes to a versioned file.  It does
610
 
    not delete the working copy.
611
 
    """
612
 
    takes_args = ['file+']
613
 
    takes_options = ['verbose']
614
 
    
615
 
    def run(self, file_list, verbose=False):
616
 
        b = Branch(file_list[0])
617
 
        b.remove([b.relpath(f) for f in file_list], verbose=verbose)
618
 
 
619
 
 
620
 
class cmd_file_id(Command):
 
260
    b = Branch(dir)
 
261
    old_inv = b.basis_tree().inventory
 
262
    new_inv = b.read_working_inventory()
 
263
    
 
264
    renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
 
265
    renames.sort()
 
266
    for old_name, new_name in renames:
 
267
        print "%s => %s" % (old_name, new_name)        
 
268
 
 
269
 
 
270
 
 
271
def cmd_info():
 
272
    """info: Show statistical information for this branch
 
273
 
 
274
    usage: bzr info"""
 
275
    import info
 
276
    info.show_info(Branch('.'))        
 
277
    
 
278
 
 
279
 
 
280
def cmd_remove(file_list, verbose=False):
 
281
    b = Branch(file_list[0])
 
282
    b.remove([b.relpath(f) for f in file_list], verbose=verbose)
 
283
 
 
284
 
 
285
 
 
286
def cmd_file_id(filename):
621
287
    """Print file_id of a particular file or directory.
622
288
 
 
289
    usage: bzr file-id FILE
 
290
 
623
291
    The file_id is assigned when the file is first added and remains the
624
292
    same through all revisions where the file exists, even when it is
625
293
    moved or renamed.
626
294
    """
627
 
    hidden = True
628
 
    takes_args = ['filename']
629
 
    def run(self, filename):
630
 
        b = Branch(filename)
631
 
        i = b.inventory.path2id(b.relpath(filename))
632
 
        if i == None:
633
 
            bailout("%r is not a versioned file" % filename)
634
 
        else:
635
 
            print i
636
 
 
637
 
 
638
 
class cmd_file_path(Command):
 
295
    b = Branch(filename)
 
296
    i = b.inventory.path2id(b.relpath(filename))
 
297
    if i == None:
 
298
        bailout("%r is not a versioned file" % filename)
 
299
    else:
 
300
        print i
 
301
 
 
302
 
 
303
def cmd_file_id_path(filename):
639
304
    """Print path of file_ids to a file or directory.
640
305
 
 
306
    usage: bzr file-id-path FILE
 
307
 
641
308
    This prints one line for each directory down to the target,
642
309
    starting at the branch root."""
643
 
    hidden = True
644
 
    takes_args = ['filename']
645
 
    def run(self, filename):
646
 
        b = Branch(filename)
647
 
        inv = b.inventory
648
 
        fid = inv.path2id(b.relpath(filename))
649
 
        if fid == None:
650
 
            bailout("%r is not a versioned file" % filename)
651
 
        for fip in inv.get_idpath(fid):
652
 
            print fip
653
 
 
654
 
 
655
 
class cmd_revision_history(Command):
656
 
    """Display list of revision ids on this branch."""
657
 
    hidden = True
658
 
    def run(self):
659
 
        for patchid in Branch('.').revision_history():
660
 
            print patchid
661
 
 
662
 
 
663
 
class cmd_directories(Command):
664
 
    """Display list of versioned directories in this branch."""
665
 
    def run(self):
666
 
        for name, ie in Branch('.').read_working_inventory().directories():
667
 
            if name == '':
668
 
                print '.'
669
 
            else:
670
 
                print name
671
 
 
672
 
 
673
 
class cmd_init(Command):
674
 
    """Make a directory into a versioned branch.
675
 
 
676
 
    Use this to create an empty branch, or before importing an
677
 
    existing project.
678
 
 
679
 
    Recipe for importing a tree of files:
680
 
        cd ~/project
681
 
        bzr init
682
 
        bzr add -v .
683
 
        bzr status
684
 
        bzr commit -m 'imported project'
685
 
    """
686
 
    def run(self):
687
 
        Branch('.', init=True)
688
 
 
689
 
 
690
 
class cmd_diff(Command):
691
 
    """Show differences in working tree.
692
 
    
 
310
    b = Branch(filename)
 
311
    inv = b.inventory
 
312
    fid = inv.path2id(b.relpath(filename))
 
313
    if fid == None:
 
314
        bailout("%r is not a versioned file" % filename)
 
315
    for fip in inv.get_idpath(fid):
 
316
        print fip
 
317
 
 
318
 
 
319
def cmd_revision_history():
 
320
    for patchid in Branch('.').revision_history():
 
321
        print patchid
 
322
 
 
323
 
 
324
def cmd_directories():
 
325
    for name, ie in Branch('.').read_working_inventory().directories():
 
326
        if name == '':
 
327
            print '.'
 
328
        else:
 
329
            print name
 
330
 
 
331
 
 
332
def cmd_missing():
 
333
    for name, ie in Branch('.').working_tree().missing():
 
334
        print name
 
335
 
 
336
 
 
337
def cmd_init():
 
338
    # TODO: Check we're not already in a working directory?  At the
 
339
    # moment you'll get an ugly error.
 
340
    
 
341
    # TODO: What if we're in a subdirectory of a branch?  Would like
 
342
    # to allow that, but then the parent may need to understand that
 
343
    # the children have disappeared, or should they be versioned in
 
344
    # both?
 
345
 
 
346
    # TODO: Take an argument/option for branch name.
 
347
    Branch('.', init=True)
 
348
 
 
349
 
 
350
def cmd_diff(revision=None, file_list=None):
 
351
    """bzr diff: Show differences in working tree.
 
352
    
 
353
    usage: bzr diff [-r REV] [FILE...]
 
354
 
 
355
    --revision REV
 
356
         Show changes since REV, rather than predecessor.
 
357
 
693
358
    If files are listed, only the changes in those files are listed.
694
359
    Otherwise, all changes for the tree are listed.
695
360
 
709
374
          deleted files.
710
375
 
711
376
    TODO: This probably handles non-Unix newlines poorly.
712
 
    """
 
377
"""
 
378
 
 
379
    ## TODO: Shouldn't be in the cmd function.
 
380
 
 
381
    b = Branch('.')
 
382
 
 
383
    if revision == None:
 
384
        old_tree = b.basis_tree()
 
385
    else:
 
386
        old_tree = b.revision_tree(b.lookup_revision(revision))
 
387
        
 
388
    new_tree = b.working_tree()
 
389
 
 
390
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
 
391
    old_label = ''
 
392
    new_label = ''
 
393
 
 
394
    DEVNULL = '/dev/null'
 
395
    # Windows users, don't panic about this filename -- it is a
 
396
    # special signal to GNU patch that the file should be created or
 
397
    # deleted respectively.
 
398
 
 
399
    # TODO: Generation of pseudo-diffs for added/deleted files could
 
400
    # be usefully made into a much faster special case.
 
401
 
 
402
    # TODO: Better to return them in sorted order I think.
 
403
 
 
404
    if file_list:
 
405
        file_list = [b.relpath(f) for f in file_list]
 
406
 
 
407
    # FIXME: If given a file list, compare only those files rather
 
408
    # than comparing everything and then throwing stuff away.
713
409
    
714
 
    takes_args = ['file*']
715
 
    takes_options = ['revision', 'diff-options']
716
 
    aliases = ['di', 'dif']
717
 
 
718
 
    def run(self, revision=None, file_list=None, diff_options=None):
719
 
        from bzrlib.diff import show_diff
720
 
        from bzrlib import find_branch
721
 
 
722
 
        if file_list:
723
 
            b = find_branch(file_list[0])
724
 
            file_list = [b.relpath(f) for f in file_list]
725
 
            if file_list == ['']:
726
 
                # just pointing to top-of-tree
727
 
                file_list = None
 
410
    for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
 
411
 
 
412
        if file_list and (new_name not in file_list):
 
413
            continue
 
414
        
 
415
        # Don't show this by default; maybe do it if an option is passed
 
416
        # idlabel = '      {%s}' % fid
 
417
        idlabel = ''
 
418
 
 
419
        # FIXME: Something about the diff format makes patch unhappy
 
420
        # with newly-added files.
 
421
 
 
422
        def diffit(oldlines, newlines, **kw):
 
423
            
 
424
            # FIXME: difflib is wrong if there is no trailing newline.
 
425
            # The syntax used by patch seems to be "\ No newline at
 
426
            # end of file" following the last diff line from that
 
427
            # file.  This is not trivial to insert into the
 
428
            # unified_diff output and it might be better to just fix
 
429
            # or replace that function.
 
430
 
 
431
            # In the meantime we at least make sure the patch isn't
 
432
            # mangled.
 
433
            
 
434
 
 
435
            # Special workaround for Python2.3, where difflib fails if
 
436
            # both sequences are empty.
 
437
            if not oldlines and not newlines:
 
438
                return
 
439
 
 
440
            nonl = False
 
441
 
 
442
            if oldlines and (oldlines[-1][-1] != '\n'):
 
443
                oldlines[-1] += '\n'
 
444
                nonl = True
 
445
            if newlines and (newlines[-1][-1] != '\n'):
 
446
                newlines[-1] += '\n'
 
447
                nonl = True
 
448
 
 
449
            ud = difflib.unified_diff(oldlines, newlines, **kw)
 
450
            sys.stdout.writelines(ud)
 
451
            if nonl:
 
452
                print "\\ No newline at end of file"
 
453
            sys.stdout.write('\n')
 
454
        
 
455
        if file_state in ['.', '?', 'I']:
 
456
            continue
 
457
        elif file_state == 'A':
 
458
            print '*** added %s %r' % (kind, new_name)
 
459
            if kind == 'file':
 
460
                diffit([],
 
461
                       new_tree.get_file(fid).readlines(),
 
462
                       fromfile=DEVNULL,
 
463
                       tofile=new_label + new_name + idlabel)
 
464
        elif file_state == 'D':
 
465
            assert isinstance(old_name, types.StringTypes)
 
466
            print '*** deleted %s %r' % (kind, old_name)
 
467
            if kind == 'file':
 
468
                diffit(old_tree.get_file(fid).readlines(), [],
 
469
                       fromfile=old_label + old_name + idlabel,
 
470
                       tofile=DEVNULL)
 
471
        elif file_state in ['M', 'R']:
 
472
            if file_state == 'M':
 
473
                assert kind == 'file'
 
474
                assert old_name == new_name
 
475
                print '*** modified %s %r' % (kind, new_name)
 
476
            elif file_state == 'R':
 
477
                print '*** renamed %s %r => %r' % (kind, old_name, new_name)
 
478
 
 
479
            if kind == 'file':
 
480
                diffit(old_tree.get_file(fid).readlines(),
 
481
                       new_tree.get_file(fid).readlines(),
 
482
                       fromfile=old_label + old_name + idlabel,
 
483
                       tofile=new_label + new_name)
728
484
        else:
729
 
            b = Branch('.')
730
 
    
731
 
        show_diff(b, revision, specific_files=file_list,
732
 
                  external_diff_options=diff_options)
733
 
 
734
 
 
735
 
        
736
 
 
737
 
 
738
 
class cmd_deleted(Command):
 
485
            bailout("can't represent state %s {%s}" % (file_state, fid))
 
486
 
 
487
 
 
488
 
 
489
def cmd_deleted(show_ids=False):
739
490
    """List files deleted in the working tree.
740
491
 
741
492
    TODO: Show files deleted since a previous revision, or between two revisions.
742
493
    """
743
 
    def run(self, show_ids=False):
744
 
        b = Branch('.')
745
 
        old = b.basis_tree()
746
 
        new = b.working_tree()
747
 
 
748
 
        ## TODO: Much more efficient way to do this: read in new
749
 
        ## directories with readdir, rather than stating each one.  Same
750
 
        ## level of effort but possibly much less IO.  (Or possibly not,
751
 
        ## if the directories are very large...)
752
 
 
753
 
        for path, ie in old.inventory.iter_entries():
754
 
            if not new.has_id(ie.file_id):
755
 
                if show_ids:
756
 
                    print '%-50s %s' % (path, ie.file_id)
757
 
                else:
758
 
                    print path
759
 
 
760
 
 
761
 
class cmd_modified(Command):
762
 
    """List files modified in working tree."""
763
 
    hidden = True
764
 
    def run(self):
765
 
        import statcache
766
 
        b = Branch('.')
767
 
        inv = b.read_working_inventory()
768
 
        sc = statcache.update_cache(b, inv)
769
 
        basis = b.basis_tree()
770
 
        basis_inv = basis.inventory
771
 
        
772
 
        # We used to do this through iter_entries(), but that's slow
773
 
        # when most of the files are unmodified, as is usually the
774
 
        # case.  So instead we iterate by inventory entry, and only
775
 
        # calculate paths as necessary.
776
 
 
777
 
        for file_id in basis_inv:
778
 
            cacheentry = sc.get(file_id)
779
 
            if not cacheentry:                 # deleted
780
 
                continue
781
 
            ie = basis_inv[file_id]
782
 
            if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
783
 
                path = inv.id2path(file_id)
 
494
    b = Branch('.')
 
495
    old = b.basis_tree()
 
496
    new = b.working_tree()
 
497
 
 
498
    ## TODO: Much more efficient way to do this: read in new
 
499
    ## directories with readdir, rather than stating each one.  Same
 
500
    ## level of effort but possibly much less IO.  (Or possibly not,
 
501
    ## if the directories are very large...)
 
502
 
 
503
    for path, ie in old.inventory.iter_entries():
 
504
        if not new.has_id(ie.file_id):
 
505
            if show_ids:
 
506
                print '%-50s %s' % (path, ie.file_id)
 
507
            else:
784
508
                print path
785
509
 
786
510
 
787
511
 
788
 
class cmd_added(Command):
789
 
    """List files added in working tree."""
790
 
    hidden = True
791
 
    def run(self):
792
 
        b = Branch('.')
793
 
        wt = b.working_tree()
794
 
        basis_inv = b.basis_tree().inventory
795
 
        inv = wt.inventory
796
 
        for file_id in inv:
797
 
            if file_id in basis_inv:
798
 
                continue
799
 
            path = inv.id2path(file_id)
800
 
            if not os.access(b.abspath(path), os.F_OK):
801
 
                continue
802
 
            print path
 
512
def cmd_parse_inventory():
 
513
    import cElementTree
 
514
    
 
515
    cElementTree.ElementTree().parse(file('.bzr/inventory'))
 
516
 
 
517
 
 
518
 
 
519
def cmd_load_inventory():
 
520
    """Load inventory for timing purposes"""
 
521
    Branch('.').basis_tree().inventory
 
522
 
 
523
 
 
524
def cmd_dump_inventory():
 
525
    Branch('.').read_working_inventory().write_xml(sys.stdout)
 
526
 
 
527
 
 
528
def cmd_dump_new_inventory():
 
529
    import bzrlib.newinventory
 
530
    inv = Branch('.').basis_tree().inventory
 
531
    bzrlib.newinventory.write_inventory(inv, sys.stdout)
 
532
 
 
533
 
 
534
def cmd_load_new_inventory():
 
535
    import bzrlib.newinventory
 
536
    bzrlib.newinventory.read_new_inventory(sys.stdin)
803
537
                
804
 
        
805
 
 
806
 
class cmd_root(Command):
807
 
    """Show the tree root directory.
808
 
 
809
 
    The root is the nearest enclosing directory with a .bzr control
810
 
    directory."""
811
 
    takes_args = ['filename?']
812
 
    def run(self, filename=None):
813
 
        """Print the branch root."""
814
 
        from branch import find_branch
815
 
        b = find_branch(filename)
816
 
        print getattr(b, 'base', None) or getattr(b, 'baseurl')
817
 
 
818
 
 
819
 
class cmd_log(Command):
 
538
    
 
539
def cmd_dump_slacker_inventory():
 
540
    import bzrlib.newinventory
 
541
    inv = Branch('.').basis_tree().inventory
 
542
    bzrlib.newinventory.write_slacker_inventory(inv, sys.stdout)
 
543
 
 
544
 
 
545
 
 
546
def cmd_dump_text_inventory():
 
547
    import bzrlib.textinv
 
548
    inv = Branch('.').basis_tree().inventory
 
549
    bzrlib.textinv.write_text_inventory(inv, sys.stdout)
 
550
 
 
551
 
 
552
def cmd_load_text_inventory():
 
553
    import bzrlib.textinv
 
554
    inv = bzrlib.textinv.read_text_inventory(sys.stdin)
 
555
    print 'loaded %d entries' % len(inv)
 
556
    
 
557
    
 
558
 
 
559
def cmd_root(filename=None):
 
560
    """Print the branch root."""
 
561
    print bzrlib.branch.find_branch_root(filename)
 
562
    
 
563
 
 
564
def cmd_log(timezone='original', verbose=False):
820
565
    """Show log of this branch.
821
566
 
822
 
    To request a range of logs, you can use the command -r begin:end
823
 
    -r revision requests a specific revision, -r :end or -r begin: are
824
 
    also valid.
825
 
 
826
 
    TODO: Make --revision support uuid: and hash: [future tag:] notation.
827
 
  
 
567
    TODO: Options for utc; to show ids; to limit range; etc.
828
568
    """
829
 
 
830
 
    takes_args = ['filename?']
831
 
    takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision']
832
 
    
833
 
    def run(self, filename=None, timezone='original',
834
 
            verbose=False,
835
 
            show_ids=False,
836
 
            forward=False,
837
 
            revision=None):
838
 
        from bzrlib import show_log, find_branch
839
 
        import codecs
840
 
 
841
 
        direction = (forward and 'forward') or 'reverse'
842
 
        
843
 
        if filename:
844
 
            b = find_branch(filename)
845
 
            fp = b.relpath(filename)
846
 
            if fp:
847
 
                file_id = b.read_working_inventory().path2id(fp)
848
 
            else:
849
 
                file_id = None  # points to branch root
850
 
        else:
851
 
            b = find_branch('.')
852
 
            file_id = None
853
 
 
854
 
        if revision == None:
855
 
            revision = [None, None]
856
 
        elif isinstance(revision, int):
857
 
            revision = [revision, revision]
858
 
        else:
859
 
            # pair of revisions?
860
 
            pass
861
 
            
862
 
        assert len(revision) == 2
863
 
 
864
 
        mutter('encoding log as %r' % bzrlib.user_encoding)
865
 
 
866
 
        # use 'replace' so that we don't abort if trying to write out
867
 
        # in e.g. the default C locale.
868
 
        outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
869
 
 
870
 
        show_log(b, file_id,
871
 
                 show_timezone=timezone,
872
 
                 verbose=verbose,
873
 
                 show_ids=show_ids,
874
 
                 to_file=outf,
875
 
                 direction=direction,
876
 
                 start_revision=revision[0],
877
 
                 end_revision=revision[1])
878
 
 
879
 
 
880
 
 
881
 
class cmd_touching_revisions(Command):
882
 
    """Return revision-ids which affected a particular file.
883
 
 
884
 
    A more user-friendly interface is "bzr log FILE"."""
885
 
    hidden = True
886
 
    takes_args = ["filename"]
887
 
    def run(self, filename):
888
 
        b = Branch(filename)
889
 
        inv = b.read_working_inventory()
890
 
        file_id = inv.path2id(b.relpath(filename))
891
 
        for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
892
 
            print "%6d %s" % (revno, what)
893
 
 
894
 
 
895
 
class cmd_ls(Command):
 
569
    Branch('.').write_log(show_timezone=timezone, verbose=verbose)
 
570
 
 
571
 
 
572
def cmd_ls(revision=None, verbose=False):
896
573
    """List files in a tree.
897
574
 
898
575
    TODO: Take a revision or remote path and list that tree instead.
899
576
    """
900
 
    hidden = True
901
 
    def run(self, revision=None, verbose=False):
902
 
        b = Branch('.')
903
 
        if revision == None:
904
 
            tree = b.working_tree()
905
 
        else:
906
 
            tree = b.revision_tree(b.lookup_revision(revision))
907
 
 
908
 
        for fp, fc, kind, fid in tree.list_files():
909
 
            if verbose:
910
 
                if kind == 'directory':
911
 
                    kindch = '/'
912
 
                elif kind == 'file':
913
 
                    kindch = ''
914
 
                else:
915
 
                    kindch = '???'
916
 
 
917
 
                print '%-8s %s%s' % (fc, fp, kindch)
 
577
    b = Branch('.')
 
578
    if revision == None:
 
579
        tree = b.working_tree()
 
580
    else:
 
581
        tree = b.revision_tree(b.lookup_revision(revision))
 
582
        
 
583
    for fp, fc, kind, fid in tree.list_files():
 
584
        if verbose:
 
585
            if kind == 'directory':
 
586
                kindch = '/'
 
587
            elif kind == 'file':
 
588
                kindch = ''
918
589
            else:
919
 
                print fp
920
 
 
921
 
 
922
 
 
923
 
class cmd_unknowns(Command):
924
 
    """List unknown files."""
925
 
    def run(self):
926
 
        for f in Branch('.').unknowns():
927
 
            print quotefn(f)
928
 
 
929
 
 
930
 
 
931
 
class cmd_ignore(Command):
932
 
    """Ignore a command or pattern.
933
 
 
934
 
    To remove patterns from the ignore list, edit the .bzrignore file.
935
 
 
936
 
    If the pattern contains a slash, it is compared to the whole path
937
 
    from the branch root.  Otherwise, it is comapred to only the last
938
 
    component of the path.
939
 
 
940
 
    Ignore patterns are case-insensitive on case-insensitive systems.
941
 
 
942
 
    Note: wildcards must be quoted from the shell on Unix.
943
 
 
944
 
    examples:
945
 
        bzr ignore ./Makefile
946
 
        bzr ignore '*.class'
947
 
    """
948
 
    takes_args = ['name_pattern']
949
 
    
950
 
    def run(self, name_pattern):
951
 
        from bzrlib.atomicfile import AtomicFile
952
 
        import os.path
953
 
 
954
 
        b = Branch('.')
955
 
        ifn = b.abspath('.bzrignore')
956
 
 
957
 
        if os.path.exists(ifn):
958
 
            f = open(ifn, 'rt')
959
 
            try:
960
 
                igns = f.read().decode('utf-8')
961
 
            finally:
962
 
                f.close()
963
 
        else:
964
 
            igns = ''
965
 
 
966
 
        # TODO: If the file already uses crlf-style termination, maybe
967
 
        # we should use that for the newly added lines?
968
 
 
969
 
        if igns and igns[-1] != '\n':
970
 
            igns += '\n'
971
 
        igns += name_pattern + '\n'
972
 
 
973
 
        try:
974
 
            f = AtomicFile(ifn, 'wt')
975
 
            f.write(igns.encode('utf-8'))
976
 
            f.commit()
977
 
        finally:
978
 
            f.close()
979
 
 
980
 
        inv = b.working_tree().inventory
981
 
        if inv.path2id('.bzrignore'):
982
 
            mutter('.bzrignore is already versioned')
983
 
        else:
984
 
            mutter('need to make new .bzrignore file versioned')
985
 
            b.add(['.bzrignore'])
986
 
 
987
 
 
988
 
 
989
 
class cmd_ignored(Command):
 
590
                kindch = '???'
 
591
                
 
592
            print '%-8s %s%s' % (fc, fp, kindch)
 
593
        else:
 
594
            print fp
 
595
    
 
596
    
 
597
 
 
598
def cmd_unknowns():
 
599
    """List unknown files"""
 
600
    for f in Branch('.').unknowns():
 
601
        print quotefn(f)
 
602
 
 
603
 
 
604
 
 
605
def cmd_ignore(name_pattern):
 
606
    """Ignore a command or pattern"""
 
607
 
 
608
    b = Branch('.')
 
609
 
 
610
    # XXX: This will fail if it's a hardlink; should use an AtomicFile class.
 
611
    f = open(b.abspath('.bzrignore'), 'at')
 
612
    f.write(name_pattern + '\n')
 
613
    f.close()
 
614
    
 
615
    inv = b.working_tree().inventory
 
616
    if inv.path2id('.bzrignore'):
 
617
        mutter('.bzrignore is already versioned')
 
618
    else:
 
619
        mutter('need to make new .bzrignore file versioned')
 
620
        b.add(['.bzrignore'])
 
621
 
 
622
 
 
623
 
 
624
def cmd_ignored():
990
625
    """List ignored files and the patterns that matched them.
991
 
 
992
 
    See also: bzr ignore"""
993
 
    def run(self):
994
 
        tree = Branch('.').working_tree()
995
 
        for path, file_class, kind, file_id in tree.list_files():
996
 
            if file_class != 'I':
997
 
                continue
998
 
            ## XXX: Slightly inefficient since this was already calculated
999
 
            pat = tree.is_ignored(path)
1000
 
            print '%-50s %s' % (path, pat)
1001
 
 
1002
 
 
1003
 
class cmd_lookup_revision(Command):
1004
 
    """Lookup the revision-id from a revision-number
1005
 
 
1006
 
    example:
1007
 
        bzr lookup-revision 33
1008
 
    """
1009
 
    hidden = True
1010
 
    takes_args = ['revno']
1011
 
    
1012
 
    def run(self, revno):
1013
 
        try:
1014
 
            revno = int(revno)
1015
 
        except ValueError:
1016
 
            raise BzrCommandError("not a valid revision-number: %r" % revno)
1017
 
 
1018
 
        print Branch('.').lookup_revision(revno)
1019
 
 
1020
 
 
1021
 
class cmd_export(Command):
1022
 
    """Export past revision to destination directory.
1023
 
 
1024
 
    If no revision is specified this exports the last committed revision."""
1025
 
    takes_args = ['dest']
1026
 
    takes_options = ['revision']
1027
 
    def run(self, dest, revision=None):
1028
 
        b = Branch('.')
1029
 
        if revision == None:
1030
 
            rh = b.revision_history()[-1]
1031
 
        else:
1032
 
            rh = b.lookup_revision(int(revision))
1033
 
        t = b.revision_tree(rh)
1034
 
        t.export(dest)
1035
 
 
1036
 
 
1037
 
class cmd_cat(Command):
1038
 
    """Write a file's text from a previous revision."""
1039
 
 
1040
 
    takes_options = ['revision']
1041
 
    takes_args = ['filename']
1042
 
 
1043
 
    def run(self, filename, revision=None):
1044
 
        if revision == None:
1045
 
            raise BzrCommandError("bzr cat requires a revision number")
1046
 
        b = Branch('.')
1047
 
        b.print_file(b.relpath(filename), int(revision))
1048
 
 
1049
 
 
1050
 
class cmd_local_time_offset(Command):
1051
 
    """Show the offset in seconds from GMT to local time."""
1052
 
    hidden = True    
1053
 
    def run(self):
1054
 
        print bzrlib.osutils.local_time_offset()
1055
 
 
1056
 
 
1057
 
 
1058
 
class cmd_commit(Command):
1059
 
    """Commit changes into a new revision.
1060
 
 
1061
 
    If selected files are specified, only changes to those files are
1062
 
    committed.  If a directory is specified then its contents are also
1063
 
    committed.
1064
 
 
1065
 
    A selected-file commit may fail in some cases where the committed
1066
 
    tree would be invalid, such as trying to commit a file in a
1067
 
    newly-added directory that is not itself committed.
 
626
      """
 
627
    tree = Branch('.').working_tree()
 
628
    for path, file_class, kind, file_id in tree.list_files():
 
629
        if file_class != 'I':
 
630
            continue
 
631
        ## XXX: Slightly inefficient since this was already calculated
 
632
        pat = tree.is_ignored(path)
 
633
        print '%-50s %s' % (path, pat)
 
634
 
 
635
 
 
636
def cmd_lookup_revision(revno):
 
637
    try:
 
638
        revno = int(revno)
 
639
    except ValueError:
 
640
        bailout("usage: lookup-revision REVNO",
 
641
                ["REVNO is a non-negative revision number for this branch"])
 
642
 
 
643
    print Branch('.').lookup_revision(revno) or NONE_STRING
 
644
 
 
645
 
 
646
 
 
647
def cmd_export(revno, dest):
 
648
    """Export past revision to destination directory."""
 
649
    b = Branch('.')
 
650
    rh = b.lookup_revision(int(revno))
 
651
    t = b.revision_tree(rh)
 
652
    t.export(dest)
 
653
 
 
654
def cmd_cat(revision, filename):
 
655
    """Print file to stdout."""
 
656
    b = Branch('.')
 
657
    b.print_file(b.relpath(filename), int(revision))
 
658
 
 
659
 
 
660
######################################################################
 
661
# internal/test commands
 
662
 
 
663
 
 
664
def cmd_uuid():
 
665
    """Print a newly-generated UUID."""
 
666
    print bzrlib.osutils.uuid()
 
667
 
 
668
 
 
669
 
 
670
def cmd_local_time_offset():
 
671
    print bzrlib.osutils.local_time_offset()
 
672
 
 
673
 
 
674
 
 
675
def cmd_commit(message=None, verbose=False):
 
676
    """Commit changes to a new revision.
 
677
 
 
678
    --message MESSAGE
 
679
        Description of changes in this revision; free form text.
 
680
        It is recommended that the first line be a single-sentence
 
681
        summary.
 
682
    --verbose
 
683
        Show status of changed files,
 
684
 
 
685
    TODO: Commit only selected files.
1068
686
 
1069
687
    TODO: Run hooks on tree to-be-committed, and after commit.
1070
688
 
1071
689
    TODO: Strict commit that fails if there are unknown or deleted files.
1072
690
    """
1073
 
    takes_args = ['selected*']
1074
 
    takes_options = ['message', 'file', 'verbose']
1075
 
    aliases = ['ci', 'checkin']
1076
 
 
1077
 
    def run(self, message=None, file=None, verbose=True, selected_list=None):
1078
 
        from bzrlib.commit import commit
1079
 
 
1080
 
        ## Warning: shadows builtin file()
1081
 
        if not message and not file:
1082
 
            raise BzrCommandError("please specify a commit message",
1083
 
                                  ["use either --message or --file"])
1084
 
        elif message and file:
1085
 
            raise BzrCommandError("please specify either --message or --file")
1086
 
        
1087
 
        if file:
1088
 
            import codecs
1089
 
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1090
 
 
1091
 
        b = Branch('.')
1092
 
        commit(b, message, verbose=verbose, specific_files=selected_list)
1093
 
 
1094
 
 
1095
 
class cmd_check(Command):
1096
 
    """Validate consistency of branch history.
 
691
 
 
692
    if not message:
 
693
        bailout("please specify a commit message")
 
694
    Branch('.').commit(message, verbose=verbose)
 
695
 
 
696
 
 
697
def cmd_check(dir='.'):
 
698
    """check: Consistency check of branch history.
 
699
 
 
700
    usage: bzr check [-v] [BRANCH]
 
701
 
 
702
    options:
 
703
      --verbose, -v         Show progress of checking.
1097
704
 
1098
705
    This command checks various invariants about the branch storage to
1099
706
    detect data corruption or bzr bugs.
1100
707
    """
1101
 
    takes_args = ['dir?']
1102
 
    def run(self, dir='.'):
1103
 
        import bzrlib.check
1104
 
        bzrlib.check.check(Branch(dir))
1105
 
 
1106
 
 
1107
 
 
1108
 
class cmd_whoami(Command):
1109
 
    """Show bzr user id."""
1110
 
    takes_options = ['email']
 
708
    import bzrlib.check
 
709
    bzrlib.check.check(Branch(dir, find_root=False))
 
710
 
 
711
 
 
712
def cmd_is(pred, *rest):
 
713
    """Test whether PREDICATE is true."""
 
714
    try:
 
715
        cmd_handler = globals()['assert_' + pred.replace('-', '_')]
 
716
    except KeyError:
 
717
        bailout("unknown predicate: %s" % quotefn(pred))
 
718
        
 
719
    try:
 
720
        cmd_handler(*rest)
 
721
    except BzrCheckError:
 
722
        # by default we don't print the message so that this can
 
723
        # be used from shell scripts without producing noise
 
724
        sys.exit(1)
 
725
 
 
726
 
 
727
def cmd_whoami(email=False):
 
728
    """Show bzr user id.
 
729
 
 
730
    usage: bzr whoami
 
731
 
 
732
    options:
 
733
        --email             Show only the email address.
1111
734
    
1112
 
    def run(self, email=False):
1113
 
        if email:
1114
 
            print bzrlib.osutils.user_email()
1115
 
        else:
1116
 
            print bzrlib.osutils.username()
1117
 
 
1118
 
 
1119
 
class cmd_selftest(Command):
 
735
    """
 
736
    if email:
 
737
        print bzrlib.osutils.user_email()
 
738
    else:
 
739
        print bzrlib.osutils.username()
 
740
        
 
741
        
 
742
def cmd_gen_revision_id():
 
743
    print bzrlib.branch._gen_revision_id(time.time())
 
744
 
 
745
 
 
746
def cmd_selftest():
1120
747
    """Run internal test suite"""
1121
 
    hidden = True
1122
 
    def run(self):
1123
 
        from bzrlib.selftest import selftest
1124
 
        if selftest():
1125
 
            return 0
 
748
    ## -v, if present, is seen by doctest; the argument is just here
 
749
    ## so our parser doesn't complain
 
750
 
 
751
    ## TODO: --verbose option
 
752
 
 
753
    failures, tests = 0, 0
 
754
    
 
755
    import doctest, bzrlib.store, bzrlib.tests
 
756
    bzrlib.trace.verbose = False
 
757
 
 
758
    for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
 
759
        bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
 
760
        mf, mt = doctest.testmod(m)
 
761
        failures += mf
 
762
        tests += mt
 
763
        print '%-40s %3d tests' % (m.__name__, mt),
 
764
        if mf:
 
765
            print '%3d FAILED!' % mf
1126
766
        else:
1127
 
            return 1
1128
 
 
1129
 
 
1130
 
 
1131
 
class cmd_version(Command):
1132
 
    """Show version of bzr."""
1133
 
    def run(self):
1134
 
        show_version()
1135
 
 
1136
 
def show_version():
 
767
            print
 
768
 
 
769
    print '%-40s %3d tests' % ('total', tests),
 
770
    if failures:
 
771
        print '%3d FAILED!' % failures
 
772
    else:
 
773
        print
 
774
 
 
775
 
 
776
 
 
777
# deprecated
 
778
cmd_doctest = cmd_selftest
 
779
 
 
780
 
 
781
######################################################################
 
782
# help
 
783
 
 
784
 
 
785
def cmd_help(topic=None):
 
786
    if topic == None:
 
787
        print __doc__
 
788
    elif topic == 'commands':
 
789
        help_commands()
 
790
    else:
 
791
        # otherwise, maybe the name of a command?
 
792
        topic, cmdfn = get_cmd_handler(topic)
 
793
 
 
794
        doc = getdoc(cmdfn)
 
795
        if doc == None:
 
796
            bailout("sorry, no detailed help yet for %r" % topic)
 
797
 
 
798
        print doc
 
799
 
 
800
 
 
801
def help_commands():
 
802
    """List all commands"""
 
803
    accu = []
 
804
    for k in globals().keys():
 
805
        if k.startswith('cmd_'):
 
806
            accu.append(k[4:].replace('_','-'))
 
807
    accu.sort()
 
808
    print "bzr commands: "
 
809
    for x in accu:
 
810
        print "   " + x
 
811
    print "note: some of these commands are internal-use or obsolete"
 
812
    # TODO: Some kind of marker for internal-use commands?
 
813
    # TODO: Show aliases?
 
814
        
 
815
 
 
816
 
 
817
 
 
818
def cmd_version():
1137
819
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
1138
 
    # is bzrlib itself in a branch?
1139
 
    bzrrev = bzrlib.get_bzr_revision()
1140
 
    if bzrrev:
1141
 
        print "  (bzr checkout, revision %d {%s})" % bzrrev
1142
820
    print bzrlib.__copyright__
1143
821
    print "http://bazaar-ng.org/"
1144
822
    print
1145
 
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
1146
 
    print "you may use, modify and redistribute it under the terms of the GNU"
1147
 
    print "General Public License version 2 or later."
1148
 
 
1149
 
 
1150
 
class cmd_rocks(Command):
 
823
    print \
 
824
"""bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and
 
825
you may use, modify and redistribute it under the terms of the GNU 
 
826
General Public License version 2 or later."""
 
827
 
 
828
 
 
829
def cmd_rocks():
1151
830
    """Statement of optimism."""
1152
 
    hidden = True
1153
 
    def run(self):
1154
 
        print "it sure does!"
1155
 
 
1156
 
def parse_spec(spec):
1157
 
    """
1158
 
    >>> parse_spec(None)
1159
 
    [None, None]
1160
 
    >>> parse_spec("./")
1161
 
    ['./', None]
1162
 
    >>> parse_spec("../@")
1163
 
    ['..', -1]
1164
 
    >>> parse_spec("../f/@35")
1165
 
    ['../f', 35]
1166
 
    """
1167
 
    if spec is None:
1168
 
        return [None, None]
1169
 
    if '/@' in spec:
1170
 
        parsed = spec.split('/@')
1171
 
        assert len(parsed) == 2
1172
 
        if parsed[1] == "":
1173
 
            parsed[1] = -1
1174
 
        else:
1175
 
            parsed[1] = int(parsed[1])
1176
 
            assert parsed[1] >=0
1177
 
    else:
1178
 
        parsed = [spec, None]
1179
 
    return parsed
1180
 
 
1181
 
 
1182
 
 
1183
 
class cmd_merge(Command):
1184
 
    """Perform a three-way merge of trees.
1185
 
    
1186
 
    The SPEC parameters are working tree or revision specifiers.  Working trees
1187
 
    are specified using standard paths or urls.  No component of a directory
1188
 
    path may begin with '@'.
1189
 
    
1190
 
    Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1191
 
 
1192
 
    Revisions are specified using a dirname/@revno pair, where dirname is the
1193
 
    branch directory and revno is the revision within that branch.  If no revno
1194
 
    is specified, the latest revision is used.
1195
 
 
1196
 
    Revision examples: './@127', 'foo/@', '../@1'
1197
 
 
1198
 
    The OTHER_SPEC parameter is required.  If the BASE_SPEC parameter is
1199
 
    not supplied, the common ancestor of OTHER_SPEC the current branch is used
1200
 
    as the BASE.
1201
 
 
1202
 
    merge refuses to run if there are any uncommitted changes, unless
1203
 
    --force is given.
1204
 
    """
1205
 
    takes_args = ['other_spec', 'base_spec?']
1206
 
    takes_options = ['force']
1207
 
 
1208
 
    def run(self, other_spec, base_spec=None, force=False):
1209
 
        from bzrlib.merge import merge
1210
 
        merge(parse_spec(other_spec), parse_spec(base_spec),
1211
 
              check_clean=(not force))
1212
 
 
1213
 
 
1214
 
class cmd_revert(Command):
1215
 
    """Reverse all changes since the last commit.
1216
 
 
1217
 
    Only versioned files are affected.
1218
 
 
1219
 
    TODO: Store backups of any files that will be reverted, so
1220
 
          that the revert can be undone.          
1221
 
    """
1222
 
    takes_options = ['revision']
1223
 
 
1224
 
    def run(self, revision=-1):
1225
 
        from bzrlib.merge import merge
1226
 
        merge(('.', revision), parse_spec('.'),
1227
 
              check_clean=False,
1228
 
              ignore_zero=True)
1229
 
 
1230
 
 
1231
 
class cmd_assert_fail(Command):
1232
 
    """Test reporting of assertion failures"""
1233
 
    hidden = True
1234
 
    def run(self):
1235
 
        assert False, "always fails"
1236
 
 
1237
 
 
1238
 
class cmd_help(Command):
1239
 
    """Show help on a command or other topic.
1240
 
 
1241
 
    For a list of all available commands, say 'bzr help commands'."""
1242
 
    takes_args = ['topic?']
1243
 
    aliases = ['?']
1244
 
    
1245
 
    def run(self, topic=None):
1246
 
        import help
1247
 
        help.help(topic)
1248
 
 
1249
 
 
1250
 
class cmd_update_stat_cache(Command):
1251
 
    """Update stat-cache mapping inodes to SHA-1 hashes.
1252
 
 
1253
 
    For testing only."""
1254
 
    hidden = True
1255
 
    def run(self):
1256
 
        import statcache
1257
 
        b = Branch('.')
1258
 
        statcache.update_cache(b.base, b.read_working_inventory())
1259
 
 
 
831
    print "it sure does!"
 
832
 
 
833
 
 
834
 
 
835
######################################################################
 
836
# main routine
1260
837
 
1261
838
 
1262
839
# list of all available options; the rhs can be either None for an
1264
841
# the type.
1265
842
OPTIONS = {
1266
843
    'all':                    None,
1267
 
    'diff-options':           str,
1268
844
    'help':                   None,
1269
 
    'file':                   unicode,
1270
 
    'force':                  None,
1271
 
    'forward':                None,
1272
845
    'message':                unicode,
1273
 
    'no-recurse':             None,
1274
846
    'profile':                None,
1275
 
    'revision':               _parse_revision_str,
 
847
    'revision':               int,
1276
848
    'show-ids':               None,
1277
849
    'timezone':               str,
1278
850
    'verbose':                None,
1281
853
    }
1282
854
 
1283
855
SHORT_OPTIONS = {
1284
 
    'F':                      'file', 
1285
 
    'h':                      'help',
1286
856
    'm':                      'message',
1287
857
    'r':                      'revision',
1288
858
    'v':                      'verbose',
1289
859
}
1290
860
 
 
861
# List of options that apply to particular commands; commands not
 
862
# listed take none.
 
863
cmd_options = {
 
864
    'add':                    ['verbose'],
 
865
    'cat':                    ['revision'],
 
866
    'commit':                 ['message', 'verbose'],
 
867
    'deleted':                ['show-ids'],
 
868
    'diff':                   ['revision'],
 
869
    'inventory':              ['revision'],
 
870
    'log':                    ['timezone', 'verbose'],
 
871
    'ls':                     ['revision', 'verbose'],
 
872
    'remove':                 ['verbose'],
 
873
    'status':                 ['all'],
 
874
    'whoami':                 ['email'],
 
875
    }
 
876
 
 
877
 
 
878
cmd_args = {
 
879
    'add':                    ['file+'],
 
880
    'cat':                    ['filename'],
 
881
    'commit':                 [],
 
882
    'diff':                   ['file*'],
 
883
    'export':                 ['revno', 'dest'],
 
884
    'file-id':                ['filename'],
 
885
    'file-id-path':           ['filename'],
 
886
    'get-file-text':          ['text_id'],
 
887
    'get-inventory':          ['inventory_id'],
 
888
    'get-revision':           ['revision_id'],
 
889
    'get-revision-inventory': ['revision_id'],
 
890
    'help':                   ['topic?'],
 
891
    'ignore':                 ['name_pattern'],
 
892
    'init':                   [],
 
893
    'log':                    [],
 
894
    'lookup-revision':        ['revno'],
 
895
    'move':                   ['source$', 'dest'],
 
896
    'relpath':                ['filename'],
 
897
    'remove':                 ['file+'],
 
898
    'rename':                 ['from_name', 'to_name'],
 
899
    'renames':                ['dir?'],
 
900
    'root':                   ['filename?'],
 
901
    'status':                 [],
 
902
    }
 
903
 
1291
904
 
1292
905
def parse_args(argv):
1293
906
    """Parse command line.
1354
967
 
1355
968
 
1356
969
 
 
970
def _match_args(cmd, args):
 
971
    """Check non-option arguments match required pattern.
1357
972
 
1358
 
def _match_argform(cmd, takes_args, args):
 
973
    >>> _match_args('status', ['asdasdsadasd'])
 
974
    Traceback (most recent call last):
 
975
    ...
 
976
    BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
 
977
    >>> _match_args('add', ['asdasdsadasd'])
 
978
    {'file_list': ['asdasdsadasd']}
 
979
    >>> _match_args('add', 'abc def gj'.split())
 
980
    {'file_list': ['abc', 'def', 'gj']}
 
981
    """
 
982
    # match argument pattern
 
983
    argform = cmd_args.get(cmd, [])
1359
984
    argdict = {}
 
985
    # TODO: Need a way to express 'cp SRC... DEST', where it matches
 
986
    # all but one.
1360
987
 
1361
 
    # step through args and takes_args, allowing appropriate 0-many matches
1362
 
    for ap in takes_args:
 
988
    # step through args and argform, allowing appropriate 0-many matches
 
989
    for ap in argform:
1363
990
        argname = ap[:-1]
1364
991
        if ap[-1] == '?':
1365
992
            if args:
1372
999
                argdict[argname + '_list'] = None
1373
1000
        elif ap[-1] == '+':
1374
1001
            if not args:
1375
 
                raise BzrCommandError("command %r needs one or more %s"
 
1002
                bailout("command %r needs one or more %s"
1376
1003
                        % (cmd, argname.upper()))
1377
1004
            else:
1378
1005
                argdict[argname + '_list'] = args[:]
1379
1006
                args = []
1380
1007
        elif ap[-1] == '$': # all but one
1381
1008
            if len(args) < 2:
1382
 
                raise BzrCommandError("command %r needs one or more %s"
 
1009
                bailout("command %r needs one or more %s"
1383
1010
                        % (cmd, argname.upper()))
1384
1011
            argdict[argname + '_list'] = args[:-1]
1385
1012
            args[:-1] = []                
1387
1014
            # just a plain arg
1388
1015
            argname = ap
1389
1016
            if not args:
1390
 
                raise BzrCommandError("command %r requires argument %s"
 
1017
                bailout("command %r requires argument %s"
1391
1018
                        % (cmd, argname.upper()))
1392
1019
            else:
1393
1020
                argdict[argname] = args.pop(0)
1394
1021
            
1395
1022
    if args:
1396
 
        raise BzrCommandError("extra argument to command %s: %s"
1397
 
                              % (cmd, args[0]))
 
1023
        bailout("extra arguments to command %s: %r"
 
1024
                % (cmd, args))
1398
1025
 
1399
1026
    return argdict
1400
1027
 
1406
1033
    This is similar to main(), but without all the trappings for
1407
1034
    logging and error handling.  
1408
1035
    """
 
1036
 
1409
1037
    argv = [a.decode(bzrlib.user_encoding) for a in argv]
1410
1038
    
1411
 
    include_plugins=True
1412
1039
    try:
1413
1040
        args, opts = parse_args(argv[1:])
1414
1041
        if 'help' in opts:
1415
 
            import help
 
1042
            # TODO: pass down other arguments in case they asked for
 
1043
            # help on a command name?
1416
1044
            if args:
1417
 
                help.help(args[0])
 
1045
                cmd_help(args[0])
1418
1046
            else:
1419
 
                help.help()
 
1047
                cmd_help()
1420
1048
            return 0
1421
1049
        elif 'version' in opts:
1422
 
            show_version()
 
1050
            cmd_version()
1423
1051
            return 0
1424
 
        elif args and args[0] == 'builtin':
1425
 
            include_plugins=False
1426
 
            args = args[1:]
1427
1052
        cmd = str(args.pop(0))
1428
1053
    except IndexError:
1429
 
        import help
1430
 
        help.help()
 
1054
        log_error('usage: bzr COMMAND')
 
1055
        log_error('  try "bzr help"')
1431
1056
        return 1
1432
 
          
1433
1057
 
1434
 
    canonical_cmd, cmd_class = get_cmd_class(cmd,include_plugins=include_plugins)
 
1058
    canonical_cmd, cmd_handler = get_cmd_handler(cmd)
1435
1059
 
1436
1060
    # global option
1437
1061
    if 'profile' in opts:
1441
1065
        profile = False
1442
1066
 
1443
1067
    # check options are reasonable
1444
 
    allowed = cmd_class.takes_options
 
1068
    allowed = cmd_options.get(canonical_cmd, [])
1445
1069
    for oname in opts:
1446
1070
        if oname not in allowed:
1447
 
            raise BzrCommandError("option '--%s' is not allowed for command %r"
1448
 
                                  % (oname, cmd))
 
1071
            bailout("option %r is not allowed for command %r"
 
1072
                    % (oname, cmd))
 
1073
 
 
1074
    # TODO: give an error if there are any mandatory options which are
 
1075
    # not specified?  Or maybe there shouldn't be any "mandatory
 
1076
    # options" (it is an oxymoron)
1449
1077
 
1450
1078
    # mix arguments and options into one dictionary
1451
 
    cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1452
 
    cmdopts = {}
 
1079
    cmdargs = _match_args(canonical_cmd, args)
1453
1080
    for k, v in opts.items():
1454
 
        cmdopts[k.replace('-', '_')] = v
 
1081
        cmdargs[k.replace('-', '_')] = v
1455
1082
 
1456
1083
    if profile:
1457
 
        import hotshot, tempfile
 
1084
        import hotshot
1458
1085
        pffileno, pfname = tempfile.mkstemp()
1459
1086
        try:
1460
1087
            prof = hotshot.Profile(pfname)
1461
 
            ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
 
1088
            ret = prof.runcall(cmd_handler, **cmdargs) or 0
1462
1089
            prof.close()
1463
1090
 
1464
1091
            import hotshot.stats
1469
1096
            ## print_stats seems hardcoded to stdout
1470
1097
            stats.print_stats(20)
1471
1098
            
1472
 
            return ret.status
 
1099
            return ret
1473
1100
 
1474
1101
        finally:
1475
1102
            os.close(pffileno)
1476
1103
            os.remove(pfname)
1477
1104
    else:
1478
 
        return cmd_class(cmdopts, cmdargs).status 
1479
 
 
1480
 
 
1481
 
def _report_exception(summary, quiet=False):
 
1105
        return cmd_handler(**cmdargs) or 0
 
1106
 
 
1107
 
 
1108
 
 
1109
def _report_exception(e, summary):
1482
1110
    import traceback
1483
1111
    log_error('bzr: ' + summary)
1484
 
    bzrlib.trace.log_exception()
1485
 
 
1486
 
    if not quiet:
1487
 
        tb = sys.exc_info()[2]
1488
 
        exinfo = traceback.extract_tb(tb)
1489
 
        if exinfo:
1490
 
            sys.stderr.write('  at %s:%d in %s()\n' % exinfo[-1][:3])
1491
 
        sys.stderr.write('  see ~/.bzr.log for debug information\n')
1492
 
 
 
1112
    bzrlib.trace.log_exception(e)
 
1113
    tb = sys.exc_info()[2]
 
1114
    exinfo = traceback.extract_tb(tb)
 
1115
    if exinfo:
 
1116
        sys.stderr.write('  at %s:%d in %s()\n' % exinfo[-1][:3])
 
1117
    sys.stderr.write('  see ~/.bzr.log for debug information\n')
 
1118
 
 
1119
 
 
1120
def cmd_assert_fail():
 
1121
    assert False, "always fails"
1493
1122
 
1494
1123
 
1495
1124
def main(argv):
1496
 
    import errno
1497
 
    
1498
 
    bzrlib.open_tracefile(argv)
 
1125
    bzrlib.trace.create_tracefile(argv)
1499
1126
 
1500
1127
    try:
1501
1128
        try:
1502
 
            try:
1503
 
                return run_bzr(argv)
1504
 
            finally:
1505
 
                # do this here inside the exception wrappers to catch EPIPE
1506
 
                sys.stdout.flush()
 
1129
            ret = run_bzr(argv)
 
1130
            return ret
1507
1131
        except BzrError, e:
1508
 
            quiet = isinstance(e, (BzrCommandError))
1509
 
            _report_exception('error: ' + e.args[0], quiet=quiet)
 
1132
            _report_exception(e, 'error: ' + e.args[0])
1510
1133
            if len(e.args) > 1:
1511
1134
                for h in e.args[1]:
1512
1135
                    # some explanation or hints
1516
1139
            msg = 'assertion failed'
1517
1140
            if str(e):
1518
1141
                msg += ': ' + str(e)
1519
 
            _report_exception(msg)
1520
 
            return 2
1521
 
        except KeyboardInterrupt, e:
1522
 
            _report_exception('interrupted', quiet=True)
1523
 
            return 2
 
1142
            _report_exception(e, msg)
1524
1143
        except Exception, e:
1525
 
            quiet = False
1526
 
            if (isinstance(e, IOError) 
1527
 
                and hasattr(e, 'errno')
1528
 
                and e.errno == errno.EPIPE):
1529
 
                quiet = True
1530
 
                msg = 'broken pipe'
1531
 
            else:
1532
 
                msg = str(e).rstrip('\n')
1533
 
            _report_exception(msg, quiet)
1534
 
            return 2
 
1144
            _report_exception(e, 'exception: %s' % str(e).rstrip('\n'))
 
1145
            return 1
1535
1146
    finally:
1536
1147
        bzrlib.trace.close_trace()
1537
1148
 
 
1149
    ## TODO: Trap AssertionError
 
1150
 
 
1151
    # TODO: Maybe nicer handling of IOError especially for broken pipe.
 
1152
 
 
1153
 
1538
1154
 
1539
1155
if __name__ == '__main__':
1540
1156
    sys.exit(main(sys.argv))