~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Martin Pool
  • Date: 2005-04-29 00:43:34 UTC
  • Revision ID: mbp@sourcefrog.net-20050429004334-bbb9dc81ce0d9de3
- update install instructions

Show diffs side-by-side

added added

removed removed

Lines of Context:
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 get_all_cmds():
72
 
    """Return canonical name and class for all registered commands."""
73
 
    for k, v in globals().iteritems():
74
 
        if k.startswith("cmd_"):
75
 
            yield _unsquish_command_name(k), v
76
 
 
77
 
def get_cmd_class(cmd):
78
 
    """Return the canonical name and command class for a command.
79
 
    """
80
 
    cmd = str(cmd)                      # not unicode
81
 
 
82
 
    # first look up this command under the specified name
 
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
    
83
129
    try:
84
 
        return cmd, globals()[_squish_command_name(cmd)]
 
130
        cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
85
131
    except KeyError:
86
 
        pass
87
 
 
88
 
    # look for any command which claims this as an alias
89
 
    for cmdname, cmdclass in get_all_cmds():
90
 
        if cmd in cmdclass.aliases:
91
 
            return cmdname, cmdclass
92
 
 
93
 
    cmdclass = ExternalCommand.find_command(cmd)
94
 
    if cmdclass:
95
 
        return cmd, cmdclass
96
 
 
97
 
    raise BzrCommandError("unknown command %r" % cmd)
98
 
 
99
 
 
100
 
class Command(object):
101
 
    """Base class for commands.
102
 
 
103
 
    The docstring for an actual command should give a single-line
104
 
    summary, then a complete description of the command.  A grammar
105
 
    description will be inserted.
106
 
 
107
 
    takes_args
108
 
        List of argument forms, marked with whether they are optional,
109
 
        repeated, etc.
110
 
 
111
 
    takes_options
112
 
        List of options that may be given for this command.
113
 
 
114
 
    hidden
115
 
        If true, this command isn't advertised.
116
 
    """
117
 
    aliases = []
118
 
    
119
 
    takes_args = []
120
 
    takes_options = []
121
 
 
122
 
    hidden = False
123
 
    
124
 
    def __init__(self, options, arguments):
125
 
        """Construct and run the command.
126
 
 
127
 
        Sets self.status to the return value of run()."""
128
 
        assert isinstance(options, dict)
129
 
        assert isinstance(arguments, dict)
130
 
        cmdargs = options.copy()
131
 
        cmdargs.update(arguments)
132
 
        assert self.__doc__ != Command.__doc__, \
133
 
               ("No help message set for %r" % self)
134
 
        self.status = self.run(**cmdargs)
135
 
 
136
 
    
137
 
    def run(self):
138
 
        """Override this in sub-classes.
139
 
 
140
 
        This is invoked with the options and arguments bound to
141
 
        keyword parameters.
142
 
 
143
 
        Return 0 or None if the command was successful, or a shell
144
 
        error code if not.
145
 
        """
146
 
        return 0
147
 
 
148
 
 
149
 
class ExternalCommand(Command):
150
 
    """Class to wrap external commands.
151
 
 
152
 
    We cheat a little here, when get_cmd_class() calls us we actually give it back
153
 
    an object we construct that has the appropriate path, help, options etc for the
154
 
    specified command.
155
 
 
156
 
    When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
157
 
    method, which we override to call the Command.__init__ method. That then calls
158
 
    our run method which is pretty straight forward.
159
 
 
160
 
    The only wrinkle is that we have to map bzr's dictionary of options and arguments
161
 
    back into command line options and arguments for the script.
162
 
    """
163
 
 
164
 
    def find_command(cls, cmd):
165
 
        import os.path
166
 
        bzrpath = os.environ.get('BZRPATH', '')
167
 
 
168
 
        for dir in bzrpath.split(':'):
169
 
            path = os.path.join(dir, cmd)
170
 
            if os.path.isfile(path):
171
 
                return ExternalCommand(path)
172
 
 
173
 
        return None
174
 
 
175
 
    find_command = classmethod(find_command)
176
 
 
177
 
    def __init__(self, path):
178
 
        self.path = path
179
 
 
180
 
        # TODO: If either of these fail, we should detect that and
181
 
        # assume that path is not really a bzr plugin after all.
182
 
 
183
 
        pipe = os.popen('%s --bzr-usage' % path, 'r')
184
 
        self.takes_options = pipe.readline().split()
185
 
        self.takes_args = pipe.readline().split()
186
 
        pipe.close()
187
 
 
188
 
        pipe = os.popen('%s --bzr-help' % path, 'r')
189
 
        self.__doc__ = pipe.read()
190
 
        pipe.close()
191
 
 
192
 
    def __call__(self, options, arguments):
193
 
        Command.__init__(self, options, arguments)
194
 
        return self
195
 
 
196
 
    def run(self, **kargs):
197
 
        opts = []
198
 
        args = []
199
 
 
200
 
        keys = kargs.keys()
201
 
        keys.sort()
202
 
        for name in keys:
203
 
            value = kargs[name]
204
 
            if OPTIONS.has_key(name):
205
 
                # it's an option
206
 
                opts.append('--%s' % name)
207
 
                if value is not None and value is not True:
208
 
                    opts.append(str(value))
209
 
            else:
210
 
                # it's an arg, or arg list
211
 
                if type(value) is not list:
212
 
                    value = [value]
213
 
                for v in value:
214
 
                    if v is not None:
215
 
                        args.append(str(v))
216
 
 
217
 
        self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
218
 
        return self.status
219
 
 
220
 
 
221
 
class cmd_status(Command):
 
132
        raise BzrError("unknown command %r" % cmd)
 
133
 
 
134
    return cmd, cmd_handler
 
135
 
 
136
 
 
137
 
 
138
def cmd_status(all=False):
222
139
    """Display status summary.
223
140
 
224
 
    This reports on versioned and unknown files, reporting them
225
 
    grouped by state.  Possible states are:
226
 
 
227
 
    added
228
 
        Versioned in the working copy but not in the previous revision.
229
 
 
230
 
    removed
231
 
        Versioned in the previous revision but removed or deleted
232
 
        in the working copy.
233
 
 
234
 
    renamed
235
 
        Path of this file changed from the previous revision;
236
 
        the text may also have changed.  This includes files whose
237
 
        parent directory was renamed.
238
 
 
239
 
    modified
240
 
        Text has changed since the previous revision.
241
 
 
242
 
    unchanged
243
 
        Nothing about this file has changed since the previous revision.
244
 
        Only shown with --all.
245
 
 
246
 
    unknown
247
 
        Not versioned and not matching an ignore pattern.
248
 
 
249
 
    To see ignored files use 'bzr ignored'.  For details in the
250
 
    changes to file texts, use 'bzr diff'.
251
 
 
252
 
    If no arguments are specified, the status of the entire working
253
 
    directory is shown.  Otherwise, only the status of the specified
254
 
    files or directories is reported.  If a directory is given, status
255
 
    is reported for everything inside that directory.
 
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.
256
144
    """
257
 
    takes_args = ['file*']
258
 
    takes_options = ['all', 'show-ids']
259
 
    aliases = ['st', 'stat']
260
 
    
261
 
    def run(self, all=False, show_ids=False, file_list=None):
262
 
        if file_list:
263
 
            b = Branch(file_list[0])
264
 
            file_list = [b.relpath(x) for x in file_list]
265
 
            # special case: only one path was given and it's the root
266
 
            # of the branch
267
 
            if file_list == ['']:
268
 
                file_list = None
269
 
        else:
270
 
            b = Branch('.')
271
 
        import status
272
 
        status.show_status(b, show_unchanged=all, show_ids=show_ids,
273
 
                           specific_files=file_list)
274
 
 
275
 
 
276
 
class cmd_cat_revision(Command):
277
 
    """Write out metadata for a revision."""
278
 
 
279
 
    hidden = True
280
 
    takes_args = ['revision_id']
281
 
    
282
 
    def run(self, revision_id):
283
 
        Branch('.').get_revision(revision_id).write_xml(sys.stdout)
284
 
 
285
 
 
286
 
class cmd_revno(Command):
287
 
    """Show current revision number.
288
 
 
289
 
    This is equal to the number of revisions on this branch."""
290
 
    def run(self):
291
 
        print Branch('.').revno()
292
 
 
293
 
    
294
 
class cmd_add(Command):
 
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):
295
175
    """Add specified files or directories.
296
176
 
297
177
    In non-recursive mode, all the named items are added, regardless
312
192
    TODO: Perhaps adding a file whose directly is not versioned should
313
193
    recursively add that parent, rather than giving an error?
314
194
    """
315
 
    takes_args = ['file+']
316
 
    takes_options = ['verbose', 'no-recurse']
317
 
    
318
 
    def run(self, file_list, verbose=False, no_recurse=False):
319
 
        bzrlib.add.smart_add(file_list, verbose, not no_recurse)
320
 
 
321
 
 
322
 
class cmd_relpath(Command):
323
 
    """Show path of a file relative to root"""
324
 
    takes_args = ['filename']
325
 
    hidden = True
326
 
    
327
 
    def run(self, filename):
328
 
        print Branch(filename).relpath(filename)
329
 
 
330
 
 
331
 
 
332
 
class cmd_inventory(Command):
333
 
    """Show inventory of the current working copy or a revision."""
334
 
    takes_options = ['revision', 'show-ids']
335
 
    
336
 
    def run(self, revision=None, show_ids=False):
337
 
        b = Branch('.')
338
 
        if revision == None:
339
 
            inv = b.read_working_inventory()
340
 
        else:
341
 
            inv = b.get_revision_inventory(b.lookup_revision(revision))
342
 
 
343
 
        for path, entry in inv.entries():
344
 
            if show_ids:
345
 
                print '%-50s %s' % (path, entry.file_id)
346
 
            else:
347
 
                print path
348
 
 
349
 
 
350
 
class cmd_move(Command):
351
 
    """Move files to a different directory.
352
 
 
353
 
    examples:
354
 
        bzr move *.txt doc
355
 
 
356
 
    The destination must be a versioned directory in the same branch.
357
 
    """
358
 
    takes_args = ['source$', 'dest']
359
 
    def run(self, source_list, dest):
360
 
        b = Branch('.')
361
 
 
362
 
        b.move([b.relpath(s) for s in source_list], b.relpath(dest))
363
 
 
364
 
 
365
 
class cmd_rename(Command):
 
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):
366
230
    """Change the name of an entry.
367
231
 
 
232
    usage: bzr rename FROM_NAME TO_NAME
 
233
 
368
234
    examples:
369
235
      bzr rename frob.c frobber.c
370
236
      bzr rename src/frob.c lib/frob.c
376
242
 
377
243
    TODO: Some way to rename multiple files without invoking bzr for each
378
244
    one?"""
379
 
    takes_args = ['from_name', 'to_name']
 
245
    b = Branch('.')
 
246
    b.rename_one(b.relpath(from_name), b.relpath(to_name))
380
247
    
381
 
    def run(self, from_name, to_name):
382
 
        b = Branch('.')
383
 
        b.rename_one(b.relpath(from_name), b.relpath(to_name))
384
 
 
385
 
 
386
 
 
387
 
class cmd_renames(Command):
 
248
 
 
249
 
 
250
 
 
251
def cmd_renames(dir='.'):
388
252
    """Show list of renamed files.
389
253
 
 
254
    usage: bzr renames [BRANCH]
 
255
 
390
256
    TODO: Option to show renames between two historical versions.
391
257
 
392
258
    TODO: Only show renames under dir, rather than in the whole branch.
393
259
    """
394
 
    takes_args = ['dir?']
395
 
 
396
 
    def run(self, dir='.'):
397
 
        b = Branch(dir)
398
 
        old_inv = b.basis_tree().inventory
399
 
        new_inv = b.read_working_inventory()
400
 
 
401
 
        renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
402
 
        renames.sort()
403
 
        for old_name, new_name in renames:
404
 
            print "%s => %s" % (old_name, new_name)        
405
 
 
406
 
 
407
 
class cmd_info(Command):
408
 
    """Show statistical information about a branch."""
409
 
    takes_args = ['branch?']
410
 
    
411
 
    def run(self, branch=None):
412
 
        import info
413
 
 
414
 
        from branch import find_branch
415
 
        b = find_branch(branch)
416
 
        info.show_info(b)
417
 
 
418
 
 
419
 
class cmd_remove(Command):
420
 
    """Make a file unversioned.
421
 
 
422
 
    This makes bzr stop tracking changes to a versioned file.  It does
423
 
    not delete the working copy.
424
 
    """
425
 
    takes_args = ['file+']
426
 
    takes_options = ['verbose']
427
 
    
428
 
    def run(self, file_list, verbose=False):
429
 
        b = Branch(file_list[0])
430
 
        b.remove([b.relpath(f) for f in file_list], verbose=verbose)
431
 
 
432
 
 
433
 
class cmd_file_id(Command):
 
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):
434
287
    """Print file_id of a particular file or directory.
435
288
 
 
289
    usage: bzr file-id FILE
 
290
 
436
291
    The file_id is assigned when the file is first added and remains the
437
292
    same through all revisions where the file exists, even when it is
438
293
    moved or renamed.
439
294
    """
440
 
    hidden = True
441
 
    takes_args = ['filename']
442
 
    def run(self, filename):
443
 
        b = Branch(filename)
444
 
        i = b.inventory.path2id(b.relpath(filename))
445
 
        if i == None:
446
 
            bailout("%r is not a versioned file" % filename)
447
 
        else:
448
 
            print i
449
 
 
450
 
 
451
 
class cmd_file_path(Command):
 
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):
452
304
    """Print path of file_ids to a file or directory.
453
305
 
 
306
    usage: bzr file-id-path FILE
 
307
 
454
308
    This prints one line for each directory down to the target,
455
309
    starting at the branch root."""
456
 
    hidden = True
457
 
    takes_args = ['filename']
458
 
    def run(self, filename):
459
 
        b = Branch(filename)
460
 
        inv = b.inventory
461
 
        fid = inv.path2id(b.relpath(filename))
462
 
        if fid == None:
463
 
            bailout("%r is not a versioned file" % filename)
464
 
        for fip in inv.get_idpath(fid):
465
 
            print fip
466
 
 
467
 
 
468
 
class cmd_revision_history(Command):
469
 
    """Display list of revision ids on this branch."""
470
 
    hidden = True
471
 
    def run(self):
472
 
        for patchid in Branch('.').revision_history():
473
 
            print patchid
474
 
 
475
 
 
476
 
class cmd_directories(Command):
477
 
    """Display list of versioned directories in this branch."""
478
 
    def run(self):
479
 
        for name, ie in Branch('.').read_working_inventory().directories():
480
 
            if name == '':
481
 
                print '.'
482
 
            else:
483
 
                print name
484
 
 
485
 
 
486
 
class cmd_init(Command):
487
 
    """Make a directory into a versioned branch.
488
 
 
489
 
    Use this to create an empty branch, or before importing an
490
 
    existing project.
491
 
 
492
 
    Recipe for importing a tree of files:
493
 
        cd ~/project
494
 
        bzr init
495
 
        bzr add -v .
496
 
        bzr status
497
 
        bzr commit -m 'imported project'
498
 
    """
499
 
    def run(self):
500
 
        Branch('.', init=True)
501
 
 
502
 
 
503
 
class cmd_diff(Command):
504
 
    """Show differences in working tree.
505
 
    
 
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
 
506
358
    If files are listed, only the changes in those files are listed.
507
359
    Otherwise, all changes for the tree are listed.
508
360
 
522
374
          deleted files.
523
375
 
524
376
    TODO: This probably handles non-Unix newlines poorly.
525
 
    """
 
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.
526
409
    
527
 
    takes_args = ['file*']
528
 
    takes_options = ['revision', 'diff-options']
529
 
    aliases = ['di']
530
 
 
531
 
    def run(self, revision=None, file_list=None, diff_options=None):
532
 
        from bzrlib.diff import show_diff
533
 
        from bzrlib import find_branch
534
 
 
535
 
        if file_list:
536
 
            b = find_branch(file_list[0])
537
 
            file_list = [b.relpath(f) for f in file_list]
538
 
            if file_list == ['']:
539
 
                # just pointing to top-of-tree
540
 
                file_list = None
 
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)
541
484
        else:
542
 
            b = Branch('.')
543
 
    
544
 
        show_diff(b, revision, specific_files=file_list,
545
 
                  external_diff_options=diff_options)
546
 
 
547
 
 
548
 
        
549
 
 
550
 
 
551
 
class cmd_deleted(Command):
 
485
            bailout("can't represent state %s {%s}" % (file_state, fid))
 
486
 
 
487
 
 
488
 
 
489
def cmd_deleted(show_ids=False):
552
490
    """List files deleted in the working tree.
553
491
 
554
492
    TODO: Show files deleted since a previous revision, or between two revisions.
555
493
    """
556
 
    def run(self, show_ids=False):
557
 
        b = Branch('.')
558
 
        old = b.basis_tree()
559
 
        new = b.working_tree()
560
 
 
561
 
        ## TODO: Much more efficient way to do this: read in new
562
 
        ## directories with readdir, rather than stating each one.  Same
563
 
        ## level of effort but possibly much less IO.  (Or possibly not,
564
 
        ## if the directories are very large...)
565
 
 
566
 
        for path, ie in old.inventory.iter_entries():
567
 
            if not new.has_id(ie.file_id):
568
 
                if show_ids:
569
 
                    print '%-50s %s' % (path, ie.file_id)
570
 
                else:
571
 
                    print path
572
 
 
573
 
 
574
 
class cmd_modified(Command):
575
 
    """List files modified in working tree."""
576
 
    hidden = True
577
 
    def run(self):
578
 
        import statcache
579
 
        b = Branch('.')
580
 
        inv = b.read_working_inventory()
581
 
        sc = statcache.update_cache(b, inv)
582
 
        basis = b.basis_tree()
583
 
        basis_inv = basis.inventory
584
 
        
585
 
        # We used to do this through iter_entries(), but that's slow
586
 
        # when most of the files are unmodified, as is usually the
587
 
        # case.  So instead we iterate by inventory entry, and only
588
 
        # calculate paths as necessary.
589
 
 
590
 
        for file_id in basis_inv:
591
 
            cacheentry = sc.get(file_id)
592
 
            if not cacheentry:                 # deleted
593
 
                continue
594
 
            ie = basis_inv[file_id]
595
 
            if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
596
 
                path = inv.id2path(file_id)
 
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:
597
508
                print path
598
509
 
599
510
 
600
511
 
601
 
class cmd_added(Command):
602
 
    """List files added in working tree."""
603
 
    hidden = True
604
 
    def run(self):
605
 
        b = Branch('.')
606
 
        wt = b.working_tree()
607
 
        basis_inv = b.basis_tree().inventory
608
 
        inv = wt.inventory
609
 
        for file_id in inv:
610
 
            if file_id in basis_inv:
611
 
                continue
612
 
            path = inv.id2path(file_id)
613
 
            if not os.access(b.abspath(path), os.F_OK):
614
 
                continue
615
 
            print path
 
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)
616
537
                
617
 
        
618
 
 
619
 
class cmd_root(Command):
620
 
    """Show the tree root directory.
621
 
 
622
 
    The root is the nearest enclosing directory with a .bzr control
623
 
    directory."""
624
 
    takes_args = ['filename?']
625
 
    def run(self, filename=None):
626
 
        """Print the branch root."""
627
 
        from branch import find_branch
628
 
        b = find_branch(filename)
629
 
        print getattr(b, 'base', None) or getattr(b, 'baseurl')
630
 
 
631
 
 
632
 
class cmd_log(Command):
 
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):
633
565
    """Show log of this branch.
634
566
 
635
 
    To request a range of logs, you can use the command -r begin:end
636
 
    -r revision requests a specific revision, -r :end or -r begin: are
637
 
    also valid.
638
 
 
639
 
    TODO: Make --revision support uuid: and hash: [future tag:] notation.
640
 
  
 
567
    TODO: Options for utc; to show ids; to limit range; etc.
641
568
    """
642
 
 
643
 
    takes_args = ['filename?']
644
 
    takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision']
645
 
    
646
 
    def run(self, filename=None, timezone='original',
647
 
            verbose=False,
648
 
            show_ids=False,
649
 
            forward=False,
650
 
            revision=None):
651
 
        from bzrlib import show_log, find_branch
652
 
        import codecs
653
 
 
654
 
        direction = (forward and 'forward') or 'reverse'
655
 
        
656
 
        if filename:
657
 
            b = find_branch(filename)
658
 
            fp = b.relpath(filename)
659
 
            if fp:
660
 
                file_id = b.read_working_inventory().path2id(fp)
661
 
            else:
662
 
                file_id = None  # points to branch root
663
 
        else:
664
 
            b = find_branch('.')
665
 
            file_id = None
666
 
 
667
 
        if revision == None:
668
 
            revision = [None, None]
669
 
        elif isinstance(revision, int):
670
 
            revision = [revision, revision]
671
 
        else:
672
 
            # pair of revisions?
673
 
            pass
674
 
            
675
 
        assert len(revision) == 2
676
 
 
677
 
        mutter('encoding log as %r' % bzrlib.user_encoding)
678
 
        outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout)
679
 
 
680
 
        show_log(b, file_id,
681
 
                 show_timezone=timezone,
682
 
                 verbose=verbose,
683
 
                 show_ids=show_ids,
684
 
                 to_file=outf,
685
 
                 direction=direction,
686
 
                 start_revision=revision[0],
687
 
                 end_revision=revision[1])
688
 
 
689
 
 
690
 
 
691
 
class cmd_touching_revisions(Command):
692
 
    """Return revision-ids which affected a particular file.
693
 
 
694
 
    A more user-friendly interface is "bzr log FILE"."""
695
 
    hidden = True
696
 
    takes_args = ["filename"]
697
 
    def run(self, filename):
698
 
        b = Branch(filename)
699
 
        inv = b.read_working_inventory()
700
 
        file_id = inv.path2id(b.relpath(filename))
701
 
        for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
702
 
            print "%6d %s" % (revno, what)
703
 
 
704
 
 
705
 
class cmd_ls(Command):
 
569
    Branch('.').write_log(show_timezone=timezone, verbose=verbose)
 
570
 
 
571
 
 
572
def cmd_ls(revision=None, verbose=False):
706
573
    """List files in a tree.
707
574
 
708
575
    TODO: Take a revision or remote path and list that tree instead.
709
576
    """
710
 
    hidden = True
711
 
    def run(self, revision=None, verbose=False):
712
 
        b = Branch('.')
713
 
        if revision == None:
714
 
            tree = b.working_tree()
 
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 = ''
 
589
            else:
 
590
                kindch = '???'
 
591
                
 
592
            print '%-8s %s%s' % (fc, fp, kindch)
715
593
        else:
716
 
            tree = b.revision_tree(b.lookup_revision(revision))
717
 
 
718
 
        for fp, fc, kind, fid in tree.list_files():
719
 
            if verbose:
720
 
                if kind == 'directory':
721
 
                    kindch = '/'
722
 
                elif kind == 'file':
723
 
                    kindch = ''
724
 
                else:
725
 
                    kindch = '???'
726
 
 
727
 
                print '%-8s %s%s' % (fc, fp, kindch)
728
 
            else:
729
 
                print fp
730
 
 
731
 
 
732
 
 
733
 
class cmd_unknowns(Command):
 
594
            print fp
 
595
    
 
596
    
 
597
 
 
598
def cmd_unknowns():
734
599
    """List unknown files"""
735
 
    def run(self):
736
 
        for f in Branch('.').unknowns():
737
 
            print quotefn(f)
738
 
 
739
 
 
740
 
 
741
 
class cmd_ignore(Command):
742
 
    """Ignore a command or pattern
743
 
 
744
 
    To remove patterns from the ignore list, edit the .bzrignore file.
745
 
 
746
 
    If the pattern contains a slash, it is compared to the whole path
747
 
    from the branch root.  Otherwise, it is comapred to only the last
748
 
    component of the path.
749
 
 
750
 
    Ignore patterns are case-insensitive on case-insensitive systems.
751
 
 
752
 
    Note: wildcards must be quoted from the shell on Unix.
753
 
 
754
 
    examples:
755
 
        bzr ignore ./Makefile
756
 
        bzr ignore '*.class'
757
 
    """
758
 
    takes_args = ['name_pattern']
 
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()
759
614
    
760
 
    def run(self, name_pattern):
761
 
        from bzrlib.atomicfile import AtomicFile
762
 
        import os.path
763
 
 
764
 
        b = Branch('.')
765
 
        ifn = b.abspath('.bzrignore')
766
 
 
767
 
        if os.path.exists(ifn):
768
 
            f = open(ifn, 'rt')
769
 
            try:
770
 
                igns = f.read().decode('utf-8')
771
 
            finally:
772
 
                f.close()
773
 
        else:
774
 
            igns = ''
775
 
 
776
 
        # TODO: If the file already uses crlf-style termination, maybe
777
 
        # we should use that for the newly added lines?
778
 
 
779
 
        if igns and igns[-1] != '\n':
780
 
            igns += '\n'
781
 
        igns += name_pattern + '\n'
782
 
 
783
 
        try:
784
 
            f = AtomicFile(ifn, 'wt')
785
 
            f.write(igns.encode('utf-8'))
786
 
            f.commit()
787
 
        finally:
788
 
            f.close()
789
 
 
790
 
        inv = b.working_tree().inventory
791
 
        if inv.path2id('.bzrignore'):
792
 
            mutter('.bzrignore is already versioned')
793
 
        else:
794
 
            mutter('need to make new .bzrignore file versioned')
795
 
            b.add(['.bzrignore'])
796
 
 
797
 
 
798
 
 
799
 
class cmd_ignored(Command):
 
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():
800
625
    """List ignored files and the patterns that matched them.
801
 
 
802
 
    See also: bzr ignore"""
803
 
    def run(self):
804
 
        tree = Branch('.').working_tree()
805
 
        for path, file_class, kind, file_id in tree.list_files():
806
 
            if file_class != 'I':
807
 
                continue
808
 
            ## XXX: Slightly inefficient since this was already calculated
809
 
            pat = tree.is_ignored(path)
810
 
            print '%-50s %s' % (path, pat)
811
 
 
812
 
 
813
 
class cmd_lookup_revision(Command):
814
 
    """Lookup the revision-id from a revision-number
815
 
 
816
 
    example:
817
 
        bzr lookup-revision 33
818
 
    """
819
 
    hidden = True
820
 
    takes_args = ['revno']
821
 
    
822
 
    def run(self, revno):
823
 
        try:
824
 
            revno = int(revno)
825
 
        except ValueError:
826
 
            raise BzrCommandError("not a valid revision-number: %r" % revno)
827
 
 
828
 
        print Branch('.').lookup_revision(revno)
829
 
 
830
 
 
831
 
class cmd_export(Command):
832
 
    """Export past revision to destination directory.
833
 
 
834
 
    If no revision is specified this exports the last committed revision."""
835
 
    takes_args = ['dest']
836
 
    takes_options = ['revision']
837
 
    def run(self, dest, revision=None):
838
 
        b = Branch('.')
839
 
        if revision == None:
840
 
            rh = b.revision_history()[-1]
841
 
        else:
842
 
            rh = b.lookup_revision(int(revision))
843
 
        t = b.revision_tree(rh)
844
 
        t.export(dest)
845
 
 
846
 
 
847
 
class cmd_cat(Command):
848
 
    """Write a file's text from a previous revision."""
849
 
 
850
 
    takes_options = ['revision']
851
 
    takes_args = ['filename']
852
 
 
853
 
    def run(self, filename, revision=None):
854
 
        if revision == None:
855
 
            raise BzrCommandError("bzr cat requires a revision number")
856
 
        b = Branch('.')
857
 
        b.print_file(b.relpath(filename), int(revision))
858
 
 
859
 
 
860
 
class cmd_local_time_offset(Command):
861
 
    """Show the offset in seconds from GMT to local time."""
862
 
    hidden = True    
863
 
    def run(self):
864
 
        print bzrlib.osutils.local_time_offset()
865
 
 
866
 
 
867
 
 
868
 
class cmd_commit(Command):
869
 
    """Commit changes into a new revision.
870
 
 
871
 
    If selected files are specified, only changes to those files are
872
 
    committed.  If a directory is specified then its contents are also
873
 
    committed.
874
 
 
875
 
    A selected-file commit may fail in some cases where the committed
876
 
    tree would be invalid, such as trying to commit a file in a
877
 
    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.
878
686
 
879
687
    TODO: Run hooks on tree to-be-committed, and after commit.
880
688
 
881
689
    TODO: Strict commit that fails if there are unknown or deleted files.
882
690
    """
883
 
    takes_args = ['selected*']
884
 
    takes_options = ['message', 'file', 'verbose']
885
 
    aliases = ['ci', 'checkin']
886
 
 
887
 
    def run(self, message=None, file=None, verbose=True, selected_list=None):
888
 
        from bzrlib.commit import commit
889
 
 
890
 
        ## Warning: shadows builtin file()
891
 
        if not message and not file:
892
 
            raise BzrCommandError("please specify a commit message",
893
 
                                  ["use either --message or --file"])
894
 
        elif message and file:
895
 
            raise BzrCommandError("please specify either --message or --file")
896
 
        
897
 
        if file:
898
 
            import codecs
899
 
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
900
 
 
901
 
        b = Branch('.')
902
 
        commit(b, message, verbose=verbose, specific_files=selected_list)
903
 
 
904
 
 
905
 
class cmd_check(Command):
906
 
    """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.
907
704
 
908
705
    This command checks various invariants about the branch storage to
909
706
    detect data corruption or bzr bugs.
910
707
    """
911
 
    takes_args = ['dir?']
912
 
    def run(self, dir='.'):
913
 
        import bzrlib.check
914
 
        bzrlib.check.check(Branch(dir))
915
 
 
916
 
 
917
 
 
918
 
class cmd_whoami(Command):
919
 
    """Show bzr user id."""
920
 
    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.
921
734
    
922
 
    def run(self, email=False):
923
 
        if email:
924
 
            print bzrlib.osutils.user_email()
925
 
        else:
926
 
            print bzrlib.osutils.username()
927
 
 
928
 
 
929
 
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():
930
747
    """Run internal test suite"""
931
 
    hidden = True
932
 
    def run(self):
933
 
        failures, tests = 0, 0
934
 
 
935
 
        import doctest, bzrlib.store
936
 
        bzrlib.trace.verbose = False
937
 
 
938
 
        for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
939
 
            bzrlib.tree, bzrlib.commands, bzrlib.add:
940
 
            mf, mt = doctest.testmod(m)
941
 
            failures += mf
942
 
            tests += mt
943
 
            print '%-40s %3d tests' % (m.__name__, mt),
944
 
            if mf:
945
 
                print '%3d FAILED!' % mf
946
 
            else:
947
 
                print
948
 
 
949
 
        print '%-40s %3d tests' % ('total', tests),
950
 
        if failures:
951
 
            print '%3d FAILED!' % failures
952
 
            return 1
 
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
953
766
        else:
954
767
            print
955
 
            return 0
956
 
 
957
 
 
958
 
 
959
 
class cmd_version(Command):
960
 
    """Show version of bzr"""
961
 
    def run(self):
962
 
        show_version()
963
 
 
964
 
def show_version():
 
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():
965
819
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
966
 
    # is bzrlib itself in a branch?
967
 
    bzrrev = bzrlib.get_bzr_revision()
968
 
    if bzrrev:
969
 
        print "  (bzr checkout, revision %d {%s})" % bzrrev
970
820
    print bzrlib.__copyright__
971
821
    print "http://bazaar-ng.org/"
972
822
    print
973
 
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
974
 
    print "you may use, modify and redistribute it under the terms of the GNU"
975
 
    print "General Public License version 2 or later."
976
 
 
977
 
 
978
 
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():
979
830
    """Statement of optimism."""
980
 
    hidden = True
981
 
    def run(self):
982
 
        print "it sure does!"
983
 
 
984
 
def parse_spec(spec):
985
 
    if '/@' in spec:
986
 
        parsed = spec.split('/@')
987
 
        assert len(parsed) == 2
988
 
        if parsed[1] == "":
989
 
            parsed[1] = -1
990
 
        else:
991
 
            parsed[1] = int(parsed[1])
992
 
            assert parsed[1] >=0
993
 
    else:
994
 
        parsed = [spec, None]
995
 
    return parsed
996
 
 
997
 
class cmd_merge(Command):
998
 
    """Perform a three-way merge of trees."""
999
 
    takes_args = ['other_spec', 'base_spec']
1000
 
 
1001
 
    def run(self, other_spec, base_spec):
1002
 
        from bzrlib.merge import merge
1003
 
        merge(parse_spec(other_spec), parse_spec(base_spec))
1004
 
 
1005
 
class cmd_assert_fail(Command):
1006
 
    """Test reporting of assertion failures"""
1007
 
    hidden = True
1008
 
    def run(self):
1009
 
        assert False, "always fails"
1010
 
 
1011
 
 
1012
 
class cmd_help(Command):
1013
 
    """Show help on a command or other topic.
1014
 
 
1015
 
    For a list of all available commands, say 'bzr help commands'."""
1016
 
    takes_args = ['topic?']
1017
 
    aliases = ['?']
1018
 
    
1019
 
    def run(self, topic=None):
1020
 
        import help
1021
 
        help.help(topic)
1022
 
 
1023
 
 
1024
 
class cmd_update_stat_cache(Command):
1025
 
    """Update stat-cache mapping inodes to SHA-1 hashes.
1026
 
 
1027
 
    For testing only."""
1028
 
    hidden = True
1029
 
    def run(self):
1030
 
        import statcache
1031
 
        b = Branch('.')
1032
 
        statcache.update_cache(b.base, b.read_working_inventory())
1033
 
 
 
831
    print "it sure does!"
 
832
 
 
833
 
 
834
 
 
835
######################################################################
 
836
# main routine
1034
837
 
1035
838
 
1036
839
# list of all available options; the rhs can be either None for an
1038
841
# the type.
1039
842
OPTIONS = {
1040
843
    'all':                    None,
1041
 
    'diff-options':           str,
1042
844
    'help':                   None,
1043
 
    'file':                   unicode,
1044
 
    'forward':                None,
1045
845
    'message':                unicode,
1046
 
    'no-recurse':             None,
1047
846
    'profile':                None,
1048
 
    'revision':               _parse_revision_str,
 
847
    'revision':               int,
1049
848
    'show-ids':               None,
1050
849
    'timezone':               str,
1051
850
    'verbose':                None,
1054
853
    }
1055
854
 
1056
855
SHORT_OPTIONS = {
1057
 
    'F':                      'file', 
1058
 
    'h':                      'help',
1059
856
    'm':                      'message',
1060
857
    'r':                      'revision',
1061
858
    'v':                      'verbose',
1062
859
}
1063
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
 
1064
904
 
1065
905
def parse_args(argv):
1066
906
    """Parse command line.
1127
967
 
1128
968
 
1129
969
 
 
970
def _match_args(cmd, args):
 
971
    """Check non-option arguments match required pattern.
1130
972
 
1131
 
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, [])
1132
984
    argdict = {}
 
985
    # TODO: Need a way to express 'cp SRC... DEST', where it matches
 
986
    # all but one.
1133
987
 
1134
 
    # step through args and takes_args, allowing appropriate 0-many matches
1135
 
    for ap in takes_args:
 
988
    # step through args and argform, allowing appropriate 0-many matches
 
989
    for ap in argform:
1136
990
        argname = ap[:-1]
1137
991
        if ap[-1] == '?':
1138
992
            if args:
1145
999
                argdict[argname + '_list'] = None
1146
1000
        elif ap[-1] == '+':
1147
1001
            if not args:
1148
 
                raise BzrCommandError("command %r needs one or more %s"
 
1002
                bailout("command %r needs one or more %s"
1149
1003
                        % (cmd, argname.upper()))
1150
1004
            else:
1151
1005
                argdict[argname + '_list'] = args[:]
1152
1006
                args = []
1153
1007
        elif ap[-1] == '$': # all but one
1154
1008
            if len(args) < 2:
1155
 
                raise BzrCommandError("command %r needs one or more %s"
 
1009
                bailout("command %r needs one or more %s"
1156
1010
                        % (cmd, argname.upper()))
1157
1011
            argdict[argname + '_list'] = args[:-1]
1158
1012
            args[:-1] = []                
1160
1014
            # just a plain arg
1161
1015
            argname = ap
1162
1016
            if not args:
1163
 
                raise BzrCommandError("command %r requires argument %s"
 
1017
                bailout("command %r requires argument %s"
1164
1018
                        % (cmd, argname.upper()))
1165
1019
            else:
1166
1020
                argdict[argname] = args.pop(0)
1167
1021
            
1168
1022
    if args:
1169
 
        raise BzrCommandError("extra argument to command %s: %s"
1170
 
                              % (cmd, args[0]))
 
1023
        bailout("extra arguments to command %s: %r"
 
1024
                % (cmd, args))
1171
1025
 
1172
1026
    return argdict
1173
1027
 
1179
1033
    This is similar to main(), but without all the trappings for
1180
1034
    logging and error handling.  
1181
1035
    """
 
1036
 
1182
1037
    argv = [a.decode(bzrlib.user_encoding) for a in argv]
1183
1038
    
1184
1039
    try:
1185
1040
        args, opts = parse_args(argv[1:])
1186
1041
        if 'help' in opts:
1187
 
            import help
 
1042
            # TODO: pass down other arguments in case they asked for
 
1043
            # help on a command name?
1188
1044
            if args:
1189
 
                help.help(args[0])
 
1045
                cmd_help(args[0])
1190
1046
            else:
1191
 
                help.help()
 
1047
                cmd_help()
1192
1048
            return 0
1193
1049
        elif 'version' in opts:
1194
 
            show_version()
 
1050
            cmd_version()
1195
1051
            return 0
1196
1052
        cmd = str(args.pop(0))
1197
1053
    except IndexError:
1198
 
        import help
1199
 
        help.help()
 
1054
        log_error('usage: bzr COMMAND')
 
1055
        log_error('  try "bzr help"')
1200
1056
        return 1
1201
 
          
1202
1057
 
1203
 
    canonical_cmd, cmd_class = get_cmd_class(cmd)
 
1058
    canonical_cmd, cmd_handler = get_cmd_handler(cmd)
1204
1059
 
1205
1060
    # global option
1206
1061
    if 'profile' in opts:
1210
1065
        profile = False
1211
1066
 
1212
1067
    # check options are reasonable
1213
 
    allowed = cmd_class.takes_options
 
1068
    allowed = cmd_options.get(canonical_cmd, [])
1214
1069
    for oname in opts:
1215
1070
        if oname not in allowed:
1216
 
            raise BzrCommandError("option '--%s' is not allowed for command %r"
1217
 
                                  % (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)
1218
1077
 
1219
1078
    # mix arguments and options into one dictionary
1220
 
    cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1221
 
    cmdopts = {}
 
1079
    cmdargs = _match_args(canonical_cmd, args)
1222
1080
    for k, v in opts.items():
1223
 
        cmdopts[k.replace('-', '_')] = v
 
1081
        cmdargs[k.replace('-', '_')] = v
1224
1082
 
1225
1083
    if profile:
1226
 
        import hotshot, tempfile
 
1084
        import hotshot
1227
1085
        pffileno, pfname = tempfile.mkstemp()
1228
1086
        try:
1229
1087
            prof = hotshot.Profile(pfname)
1230
 
            ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
 
1088
            ret = prof.runcall(cmd_handler, **cmdargs) or 0
1231
1089
            prof.close()
1232
1090
 
1233
1091
            import hotshot.stats
1238
1096
            ## print_stats seems hardcoded to stdout
1239
1097
            stats.print_stats(20)
1240
1098
            
1241
 
            return ret.status
 
1099
            return ret
1242
1100
 
1243
1101
        finally:
1244
1102
            os.close(pffileno)
1245
1103
            os.remove(pfname)
1246
1104
    else:
1247
 
        return cmd_class(cmdopts, cmdargs).status 
1248
 
 
1249
 
 
1250
 
def _report_exception(summary, quiet=False):
 
1105
        return cmd_handler(**cmdargs) or 0
 
1106
 
 
1107
 
 
1108
 
 
1109
def _report_exception(e, summary):
1251
1110
    import traceback
1252
1111
    log_error('bzr: ' + summary)
1253
 
    bzrlib.trace.log_exception()
1254
 
 
1255
 
    if not quiet:
1256
 
        tb = sys.exc_info()[2]
1257
 
        exinfo = traceback.extract_tb(tb)
1258
 
        if exinfo:
1259
 
            sys.stderr.write('  at %s:%d in %s()\n' % exinfo[-1][:3])
1260
 
        sys.stderr.write('  see ~/.bzr.log for debug information\n')
1261
 
 
 
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"
1262
1122
 
1263
1123
 
1264
1124
def main(argv):
1265
 
    import errno
1266
 
    
1267
 
    bzrlib.open_tracefile(argv)
 
1125
    bzrlib.trace.create_tracefile(argv)
1268
1126
 
1269
1127
    try:
1270
1128
        try:
1271
 
            try:
1272
 
                return run_bzr(argv)
1273
 
            finally:
1274
 
                # do this here inside the exception wrappers to catch EPIPE
1275
 
                sys.stdout.flush()
 
1129
            ret = run_bzr(argv)
 
1130
            return ret
1276
1131
        except BzrError, e:
1277
 
            quiet = isinstance(e, (BzrCommandError))
1278
 
            _report_exception('error: ' + e.args[0], quiet=quiet)
 
1132
            _report_exception(e, 'error: ' + e.args[0])
1279
1133
            if len(e.args) > 1:
1280
1134
                for h in e.args[1]:
1281
1135
                    # some explanation or hints
1285
1139
            msg = 'assertion failed'
1286
1140
            if str(e):
1287
1141
                msg += ': ' + str(e)
1288
 
            _report_exception(msg)
1289
 
            return 2
1290
 
        except KeyboardInterrupt, e:
1291
 
            _report_exception('interrupted', quiet=True)
1292
 
            return 2
 
1142
            _report_exception(e, msg)
1293
1143
        except Exception, e:
1294
 
            quiet = False
1295
 
            if (isinstance(e, IOError) 
1296
 
                and hasattr(e, 'errno')
1297
 
                and e.errno == errno.EPIPE):
1298
 
                quiet = True
1299
 
                msg = 'broken pipe'
1300
 
            else:
1301
 
                msg = str(e).rstrip('\n')
1302
 
            _report_exception(msg, quiet)
1303
 
            return 2
 
1144
            _report_exception(e, 'exception: %s' % str(e).rstrip('\n'))
 
1145
            return 1
1304
1146
    finally:
1305
1147
        bzrlib.trace.close_trace()
1306
1148
 
 
1149
    ## TODO: Trap AssertionError
 
1150
 
 
1151
    # TODO: Maybe nicer handling of IOError especially for broken pipe.
 
1152
 
 
1153
 
1307
1154
 
1308
1155
if __name__ == '__main__':
1309
1156
    sys.exit(main(sys.argv))