/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

small cleanup of test

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/builtins.py
 
1
# Copyright (C) 2004, 2005 by Canonical Ltd
 
2
 
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
 
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
 
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
"""builtin bzr commands"""
 
18
 
 
19
 
 
20
import errno
 
21
import os
 
22
from shutil import rmtree
 
23
import sys
 
24
 
 
25
import bzrlib
 
26
import bzrlib.branch
 
27
from bzrlib.branch import Branch
 
28
import bzrlib.bzrdir as bzrdir
 
29
from bzrlib._merge_core import ApplyMerge3
 
30
from bzrlib.commands import Command, display_command
 
31
from bzrlib.revision import common_ancestor
 
32
import bzrlib.errors as errors
 
33
from bzrlib.errors import (BzrError, BzrCheckError, BzrCommandError, 
 
34
                           NotBranchError, DivergedBranches, NotConflicted,
 
35
                           NoSuchFile, NoWorkingTree, FileInWrongBranch)
 
36
from bzrlib.log import show_one_log
 
37
from bzrlib.option import Option
 
38
from bzrlib.revisionspec import RevisionSpec
 
39
import bzrlib.trace
 
40
from bzrlib.trace import mutter, note, log_error, warning, is_quiet
 
41
from bzrlib.transport.local import LocalTransport
 
42
from bzrlib.workingtree import WorkingTree
 
43
 
 
44
 
 
45
def tree_files(file_list, default_branch=u'.'):
 
46
    try:
 
47
        return internal_tree_files(file_list, default_branch)
 
48
    except FileInWrongBranch, e:
 
49
        raise BzrCommandError("%s is not in the same branch as %s" %
 
50
                             (e.path, file_list[0]))
 
51
 
 
52
def internal_tree_files(file_list, default_branch=u'.'):
 
53
    """\
 
54
    Return a branch and list of branch-relative paths.
 
55
    If supplied file_list is empty or None, the branch default will be used,
 
56
    and returned file_list will match the original.
 
57
    """
 
58
    if file_list is None or len(file_list) == 0:
 
59
        return WorkingTree.open_containing(default_branch)[0], file_list
 
60
    tree = WorkingTree.open_containing(file_list[0])[0]
 
61
    new_list = []
 
62
    for filename in file_list:
 
63
        try:
 
64
            new_list.append(tree.relpath(filename))
 
65
        except errors.PathNotChild:
 
66
            raise FileInWrongBranch(tree.branch, filename)
 
67
    return tree, new_list
 
68
 
 
69
 
 
70
# TODO: Make sure no commands unconditionally use the working directory as a
 
71
# branch.  If a filename argument is used, the first of them should be used to
 
72
# specify the branch.  (Perhaps this can be factored out into some kind of
 
73
# Argument class, representing a file in a branch, where the first occurrence
 
74
# opens the branch?)
 
75
 
 
76
class cmd_status(Command):
 
77
    """Display status summary.
 
78
 
 
79
    This reports on versioned and unknown files, reporting them
 
80
    grouped by state.  Possible states are:
 
81
 
 
82
    added
 
83
        Versioned in the working copy but not in the previous revision.
 
84
 
 
85
    removed
 
86
        Versioned in the previous revision but removed or deleted
 
87
        in the working copy.
 
88
 
 
89
    renamed
 
90
        Path of this file changed from the previous revision;
 
91
        the text may also have changed.  This includes files whose
 
92
        parent directory was renamed.
 
93
 
 
94
    modified
 
95
        Text has changed since the previous revision.
 
96
 
 
97
    unchanged
 
98
        Nothing about this file has changed since the previous revision.
 
99
        Only shown with --all.
 
100
 
 
101
    unknown
 
102
        Not versioned and not matching an ignore pattern.
 
103
 
 
104
    To see ignored files use 'bzr ignored'.  For details in the
 
105
    changes to file texts, use 'bzr diff'.
 
106
 
 
107
    If no arguments are specified, the status of the entire working
 
108
    directory is shown.  Otherwise, only the status of the specified
 
109
    files or directories is reported.  If a directory is given, status
 
110
    is reported for everything inside that directory.
 
111
 
 
112
    If a revision argument is given, the status is calculated against
 
113
    that revision, or between two revisions if two are provided.
 
114
    """
 
115
    
 
116
    # TODO: --no-recurse, --recurse options
 
117
    
 
118
    takes_args = ['file*']
 
119
    takes_options = ['all', 'show-ids', 'revision']
 
120
    aliases = ['st', 'stat']
 
121
    
 
122
    @display_command
 
123
    def run(self, all=False, show_ids=False, file_list=None, revision=None):
 
124
        tree, file_list = tree_files(file_list)
 
125
            
 
126
        from bzrlib.status import show_status
 
127
        show_status(tree.branch, show_unchanged=all, show_ids=show_ids,
 
128
                    specific_files=file_list, revision=revision)
 
129
 
 
130
 
 
131
class cmd_cat_revision(Command):
 
132
    """Write out metadata for a revision.
 
133
    
 
134
    The revision to print can either be specified by a specific
 
135
    revision identifier, or you can use --revision.
 
136
    """
 
137
 
 
138
    hidden = True
 
139
    takes_args = ['revision_id?']
 
140
    takes_options = ['revision']
 
141
    
 
142
    @display_command
 
143
    def run(self, revision_id=None, revision=None):
 
144
 
 
145
        if revision_id is not None and revision is not None:
 
146
            raise BzrCommandError('You can only supply one of revision_id or --revision')
 
147
        if revision_id is None and revision is None:
 
148
            raise BzrCommandError('You must supply either --revision or a revision_id')
 
149
        b = WorkingTree.open_containing(u'.')[0].branch
 
150
        if revision_id is not None:
 
151
            sys.stdout.write(b.repository.get_revision_xml(revision_id))
 
152
        elif revision is not None:
 
153
            for rev in revision:
 
154
                if rev is None:
 
155
                    raise BzrCommandError('You cannot specify a NULL revision.')
 
156
                revno, rev_id = rev.in_history(b)
 
157
                sys.stdout.write(b.repository.get_revision_xml(rev_id))
 
158
    
 
159
 
 
160
class cmd_revno(Command):
 
161
    """Show current revision number.
 
162
 
 
163
    This is equal to the number of revisions on this branch."""
 
164
    takes_args = ['location?']
 
165
    @display_command
 
166
    def run(self, location=u'.'):
 
167
        print Branch.open_containing(location)[0].revno()
 
168
 
 
169
 
 
170
class cmd_revision_info(Command):
 
171
    """Show revision number and revision id for a given revision identifier.
 
172
    """
 
173
    hidden = True
 
174
    takes_args = ['revision_info*']
 
175
    takes_options = ['revision']
 
176
    @display_command
 
177
    def run(self, revision=None, revision_info_list=[]):
 
178
 
 
179
        revs = []
 
180
        if revision is not None:
 
181
            revs.extend(revision)
 
182
        if revision_info_list is not None:
 
183
            for rev in revision_info_list:
 
184
                revs.append(RevisionSpec(rev))
 
185
        if len(revs) == 0:
 
186
            raise BzrCommandError('You must supply a revision identifier')
 
187
 
 
188
        b = WorkingTree.open_containing(u'.')[0].branch
 
189
 
 
190
        for rev in revs:
 
191
            revinfo = rev.in_history(b)
 
192
            if revinfo.revno is None:
 
193
                print '     %s' % revinfo.rev_id
 
194
            else:
 
195
                print '%4d %s' % (revinfo.revno, revinfo.rev_id)
 
196
 
 
197
    
 
198
class cmd_add(Command):
 
199
    """Add specified files or directories.
 
200
 
 
201
    In non-recursive mode, all the named items are added, regardless
 
202
    of whether they were previously ignored.  A warning is given if
 
203
    any of the named files are already versioned.
 
204
 
 
205
    In recursive mode (the default), files are treated the same way
 
206
    but the behaviour for directories is different.  Directories that
 
207
    are already versioned do not give a warning.  All directories,
 
208
    whether already versioned or not, are searched for files or
 
209
    subdirectories that are neither versioned or ignored, and these
 
210
    are added.  This search proceeds recursively into versioned
 
211
    directories.  If no names are given '.' is assumed.
 
212
 
 
213
    Therefore simply saying 'bzr add' will version all files that
 
214
    are currently unknown.
 
215
 
 
216
    Adding a file whose parent directory is not versioned will
 
217
    implicitly add the parent, and so on up to the root. This means
 
218
    you should never need to explictly add a directory, they'll just
 
219
    get added when you add a file in the directory.
 
220
 
 
221
    --dry-run will show which files would be added, but not actually 
 
222
    add them.
 
223
    """
 
224
    takes_args = ['file*']
 
225
    takes_options = ['no-recurse', 'dry-run', 'verbose']
 
226
 
 
227
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False):
 
228
        import bzrlib.add
 
229
 
 
230
        if dry_run:
 
231
            if is_quiet():
 
232
                # This is pointless, but I'd rather not raise an error
 
233
                action = bzrlib.add.add_action_null
 
234
            else:
 
235
                action = bzrlib.add.add_action_print
 
236
        elif is_quiet():
 
237
            action = bzrlib.add.add_action_add
 
238
        else:
 
239
            action = bzrlib.add.add_action_add_and_print
 
240
 
 
241
        added, ignored = bzrlib.add.smart_add(file_list, not no_recurse, 
 
242
                                              action)
 
243
        if len(ignored) > 0:
 
244
            for glob in sorted(ignored.keys()):
 
245
                match_len = len(ignored[glob])
 
246
                if verbose:
 
247
                    for path in ignored[glob]:
 
248
                        print "ignored %s matching \"%s\"" % (path, glob)
 
249
                else:
 
250
                    print "ignored %d file(s) matching \"%s\"" % (match_len,
 
251
                                                              glob)
 
252
            print "If you wish to add some of these files, please add them"\
 
253
                " by name."
 
254
 
 
255
 
 
256
class cmd_mkdir(Command):
 
257
    """Create a new versioned directory.
 
258
 
 
259
    This is equivalent to creating the directory and then adding it.
 
260
    """
 
261
    takes_args = ['dir+']
 
262
 
 
263
    def run(self, dir_list):
 
264
        for d in dir_list:
 
265
            os.mkdir(d)
 
266
            wt, dd = WorkingTree.open_containing(d)
 
267
            wt.add([dd])
 
268
            print 'added', d
 
269
 
 
270
 
 
271
class cmd_relpath(Command):
 
272
    """Show path of a file relative to root"""
 
273
    takes_args = ['filename']
 
274
    hidden = True
 
275
    
 
276
    @display_command
 
277
    def run(self, filename):
 
278
        tree, relpath = WorkingTree.open_containing(filename)
 
279
        print relpath
 
280
 
 
281
 
 
282
class cmd_inventory(Command):
 
283
    """Show inventory of the current working copy or a revision.
 
284
 
 
285
    It is possible to limit the output to a particular entry
 
286
    type using the --kind option.  For example; --kind file.
 
287
    """
 
288
    takes_options = ['revision', 'show-ids', 'kind']
 
289
    
 
290
    @display_command
 
291
    def run(self, revision=None, show_ids=False, kind=None):
 
292
        if kind and kind not in ['file', 'directory', 'symlink']:
 
293
            raise BzrCommandError('invalid kind specified')
 
294
        tree = WorkingTree.open_containing(u'.')[0]
 
295
        if revision is None:
 
296
            inv = tree.read_working_inventory()
 
297
        else:
 
298
            if len(revision) > 1:
 
299
                raise BzrCommandError('bzr inventory --revision takes'
 
300
                    ' exactly one revision identifier')
 
301
            inv = tree.branch.repository.get_revision_inventory(
 
302
                revision[0].in_history(tree.branch).rev_id)
 
303
 
 
304
        for path, entry in inv.entries():
 
305
            if kind and kind != entry.kind:
 
306
                continue
 
307
            if show_ids:
 
308
                print '%-50s %s' % (path, entry.file_id)
 
309
            else:
 
310
                print path
 
311
 
 
312
 
 
313
class cmd_move(Command):
 
314
    """Move files to a different directory.
 
315
 
 
316
    examples:
 
317
        bzr move *.txt doc
 
318
 
 
319
    The destination must be a versioned directory in the same branch.
 
320
    """
 
321
    takes_args = ['source$', 'dest']
 
322
    def run(self, source_list, dest):
 
323
        tree, source_list = tree_files(source_list)
 
324
        # TODO: glob expansion on windows?
 
325
        tree.move(source_list, tree.relpath(dest))
 
326
 
 
327
 
 
328
class cmd_rename(Command):
 
329
    """Change the name of an entry.
 
330
 
 
331
    examples:
 
332
      bzr rename frob.c frobber.c
 
333
      bzr rename src/frob.c lib/frob.c
 
334
 
 
335
    It is an error if the destination name exists.
 
336
 
 
337
    See also the 'move' command, which moves files into a different
 
338
    directory without changing their name.
 
339
    """
 
340
    # TODO: Some way to rename multiple files without invoking 
 
341
    # bzr for each one?"""
 
342
    takes_args = ['from_name', 'to_name']
 
343
    
 
344
    def run(self, from_name, to_name):
 
345
        tree, (from_name, to_name) = tree_files((from_name, to_name))
 
346
        tree.rename_one(from_name, to_name)
 
347
 
 
348
 
 
349
class cmd_mv(Command):
 
350
    """Move or rename a file.
 
351
 
 
352
    usage:
 
353
        bzr mv OLDNAME NEWNAME
 
354
        bzr mv SOURCE... DESTINATION
 
355
 
 
356
    If the last argument is a versioned directory, all the other names
 
357
    are moved into it.  Otherwise, there must be exactly two arguments
 
358
    and the file is changed to a new name, which must not already exist.
 
359
 
 
360
    Files cannot be moved between branches.
 
361
    """
 
362
    takes_args = ['names*']
 
363
    def run(self, names_list):
 
364
        if len(names_list) < 2:
 
365
            raise BzrCommandError("missing file argument")
 
366
        tree, rel_names = tree_files(names_list)
 
367
        
 
368
        if os.path.isdir(names_list[-1]):
 
369
            # move into existing directory
 
370
            for pair in tree.move(rel_names[:-1], rel_names[-1]):
 
371
                print "%s => %s" % pair
 
372
        else:
 
373
            if len(names_list) != 2:
 
374
                raise BzrCommandError('to mv multiple files the destination '
 
375
                                      'must be a versioned directory')
 
376
            tree.rename_one(rel_names[0], rel_names[1])
 
377
            print "%s => %s" % (rel_names[0], rel_names[1])
 
378
            
 
379
    
 
380
class cmd_pull(Command):
 
381
    """Pull any changes from another branch into the current one.
 
382
 
 
383
    If there is no default location set, the first pull will set it.  After
 
384
    that, you can omit the location to use the default.  To change the
 
385
    default, use --remember.
 
386
 
 
387
    This command only works on branches that have not diverged.  Branches are
 
388
    considered diverged if both branches have had commits without first
 
389
    pulling from the other.
 
390
 
 
391
    If branches have diverged, you can use 'bzr merge' to pull the text changes
 
392
    from one into the other.  Once one branch has merged, the other should
 
393
    be able to pull it again.
 
394
 
 
395
    If you want to forget your local changes and just update your branch to
 
396
    match the remote one, use --overwrite.
 
397
    """
 
398
    takes_options = ['remember', 'overwrite', 'revision', 'verbose']
 
399
    takes_args = ['location?']
 
400
 
 
401
    def run(self, location=None, remember=False, overwrite=False, revision=None, verbose=False):
 
402
        # FIXME: too much stuff is in the command class        
 
403
        tree_to = WorkingTree.open_containing(u'.')[0]
 
404
        stored_loc = tree_to.branch.get_parent()
 
405
        if location is None:
 
406
            if stored_loc is None:
 
407
                raise BzrCommandError("No pull location known or specified.")
 
408
            else:
 
409
                print "Using saved location: %s" % stored_loc
 
410
                location = stored_loc
 
411
 
 
412
        br_from = Branch.open(location)
 
413
        br_to = tree_to.branch
 
414
 
 
415
        if revision is None:
 
416
            rev_id = None
 
417
        elif len(revision) == 1:
 
418
            rev_id = revision[0].in_history(br_from).rev_id
 
419
        else:
 
420
            raise BzrCommandError('bzr pull --revision takes one value.')
 
421
 
 
422
        old_rh = br_to.revision_history()
 
423
        count = tree_to.pull(br_from, overwrite, rev_id)
 
424
 
 
425
        if br_to.get_parent() is None or remember:
 
426
            br_to.set_parent(location)
 
427
        note('%d revision(s) pulled.' % (count,))
 
428
 
 
429
        if verbose:
 
430
            new_rh = tree_to.branch.revision_history()
 
431
            if old_rh != new_rh:
 
432
                # Something changed
 
433
                from bzrlib.log import show_changed_revisions
 
434
                show_changed_revisions(tree_to.branch, old_rh, new_rh)
 
435
 
 
436
 
 
437
class cmd_push(Command):
 
438
    """Push this branch into another branch.
 
439
    
 
440
    The remote branch will not have its working tree populated because this
 
441
    is both expensive, and may not be supported on the remote file system.
 
442
    
 
443
    Some smart servers or protocols *may* put the working tree in place.
 
444
 
 
445
    If there is no default push location set, the first push will set it.
 
446
    After that, you can omit the location to use the default.  To change the
 
447
    default, use --remember.
 
448
 
 
449
    This command only works on branches that have not diverged.  Branches are
 
450
    considered diverged if the branch being pushed to is not an older version
 
451
    of this branch.
 
452
 
 
453
    If branches have diverged, you can use 'bzr push --overwrite' to replace
 
454
    the other branch completely.
 
455
    
 
456
    If you want to ensure you have the different changes in the other branch,
 
457
    do a merge (see bzr help merge) from the other branch, and commit that
 
458
    before doing a 'push --overwrite'.
 
459
    """
 
460
    takes_options = ['remember', 'overwrite', 
 
461
                     Option('create-prefix', 
 
462
                            help='Create the path leading up to the branch '
 
463
                                 'if it does not already exist')]
 
464
    takes_args = ['location?']
 
465
 
 
466
    def run(self, location=None, remember=False, overwrite=False,
 
467
            create_prefix=False, verbose=False):
 
468
        # FIXME: Way too big!  Put this into a function called from the
 
469
        # command.
 
470
        from bzrlib.transport import get_transport
 
471
        
 
472
        tree_from = WorkingTree.open_containing(u'.')[0]
 
473
        br_from = tree_from.branch
 
474
        stored_loc = tree_from.branch.get_push_location()
 
475
        if location is None:
 
476
            if stored_loc is None:
 
477
                raise BzrCommandError("No push location known or specified.")
 
478
            else:
 
479
                print "Using saved location: %s" % stored_loc
 
480
                location = stored_loc
 
481
        try:
 
482
            br_to = Branch.open(location)
 
483
        except NotBranchError:
 
484
            # create a branch.
 
485
            transport = get_transport(location).clone('..')
 
486
            if not create_prefix:
 
487
                try:
 
488
                    transport.mkdir(transport.relpath(location))
 
489
                except NoSuchFile:
 
490
                    raise BzrCommandError("Parent directory of %s "
 
491
                                          "does not exist." % location)
 
492
            else:
 
493
                current = transport.base
 
494
                needed = [(transport, transport.relpath(location))]
 
495
                while needed:
 
496
                    try:
 
497
                        transport, relpath = needed[-1]
 
498
                        transport.mkdir(relpath)
 
499
                        needed.pop()
 
500
                    except NoSuchFile:
 
501
                        new_transport = transport.clone('..')
 
502
                        needed.append((new_transport,
 
503
                                       new_transport.relpath(transport.base)))
 
504
                        if new_transport.base == transport.base:
 
505
                            raise BzrCommandError("Could not creeate "
 
506
                                                  "path prefix.")
 
507
            if isinstance(transport, LocalTransport):
 
508
                br_to = WorkingTree.create_standalone(location).branch
 
509
            else:
 
510
                br_to = Branch.create(location)
 
511
        old_rh = br_to.revision_history()
 
512
        try:
 
513
            try:
 
514
                tree_to = br_to.working_tree()
 
515
            except NoWorkingTree:
 
516
                # TODO: This should be updated for branches which don't have a
 
517
                # working tree, as opposed to ones where we just couldn't 
 
518
                # update the tree.
 
519
                warning('Unable to update the working tree of: %s' % (br_to.base,))
 
520
                count = br_to.pull(br_from, overwrite)
 
521
            else:
 
522
                count = tree_to.pull(br_from, overwrite)
 
523
        except DivergedBranches:
 
524
            raise BzrCommandError("These branches have diverged."
 
525
                                  "  Try a merge then push with overwrite.")
 
526
        if br_from.get_push_location() is None or remember:
 
527
            br_from.set_push_location(location)
 
528
        note('%d revision(s) pushed.' % (count,))
 
529
 
 
530
        if verbose:
 
531
            new_rh = br_to.revision_history()
 
532
            if old_rh != new_rh:
 
533
                # Something changed
 
534
                from bzrlib.log import show_changed_revisions
 
535
                show_changed_revisions(br_to, old_rh, new_rh)
 
536
 
 
537
 
 
538
class cmd_branch(Command):
 
539
    """Create a new copy of a branch.
 
540
 
 
541
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
 
542
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
 
543
 
 
544
    To retrieve the branch as of a particular revision, supply the --revision
 
545
    parameter, as in "branch foo/bar -r 5".
 
546
 
 
547
    --basis is to speed up branching from remote branches.  When specified, it
 
548
    copies all the file-contents, inventory and revision data from the basis
 
549
    branch before copying anything from the remote branch.
 
550
    """
 
551
    takes_args = ['from_location', 'to_location?']
 
552
    takes_options = ['revision', 'basis']
 
553
    aliases = ['get', 'clone']
 
554
 
 
555
    def run(self, from_location, to_location=None, revision=None, basis=None):
 
556
        if revision is None:
 
557
            revision = [None]
 
558
        elif len(revision) > 1:
 
559
            raise BzrCommandError(
 
560
                'bzr branch --revision takes exactly 1 revision value')
 
561
        try:
 
562
            br_from = Branch.open(from_location)
 
563
        except OSError, e:
 
564
            if e.errno == errno.ENOENT:
 
565
                raise BzrCommandError('Source location "%s" does not'
 
566
                                      ' exist.' % to_location)
 
567
            else:
 
568
                raise
 
569
        br_from.lock_read()
 
570
        try:
 
571
            if basis is not None:
 
572
                basis_dir = bzrdir.BzrDir.open_containing(basis)[0]
 
573
            else:
 
574
                basis_dir = None
 
575
            if len(revision) == 1 and revision[0] is not None:
 
576
                revision_id = revision[0].in_history(br_from)[1]
 
577
            else:
 
578
                # FIXME - wt.last_revision, fallback to branch, fall back to
 
579
                # None or perhaps NULL_REVISION to mean copy nothing
 
580
                # RBC 20060209
 
581
                revision_id = br_from.last_revision()
 
582
            if to_location is None:
 
583
                to_location = os.path.basename(from_location.rstrip("/\\"))
 
584
                name = None
 
585
            else:
 
586
                name = os.path.basename(to_location) + '\n'
 
587
            try:
 
588
                os.mkdir(to_location)
 
589
            except OSError, e:
 
590
                if e.errno == errno.EEXIST:
 
591
                    raise BzrCommandError('Target directory "%s" already'
 
592
                                          ' exists.' % to_location)
 
593
                if e.errno == errno.ENOENT:
 
594
                    raise BzrCommandError('Parent of "%s" does not exist.' %
 
595
                                          to_location)
 
596
                else:
 
597
                    raise
 
598
            try:
 
599
                dir = br_from.bzrdir.sprout(to_location, revision_id, basis_dir)
 
600
                branch = dir.open_branch()
 
601
            except bzrlib.errors.NoSuchRevision:
 
602
                rmtree(to_location)
 
603
                msg = "The branch %s has no revision %s." % (from_location, revision[0])
 
604
                raise BzrCommandError(msg)
 
605
            except bzrlib.errors.UnlistableBranch:
 
606
                rmtree(to_location)
 
607
                msg = "The branch %s cannot be used as a --basis"
 
608
                raise BzrCommandError(msg)
 
609
            if name:
 
610
                branch.control_files.put_utf8('branch-name', name)
 
611
 
 
612
            note('Branched %d revision(s).' % branch.revno())
 
613
        finally:
 
614
            br_from.unlock()
 
615
 
 
616
 
 
617
class cmd_checkout(Command):
 
618
    """Create a new checkout of an existing branch.
 
619
 
 
620
    If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
 
621
    be used.  In other words, "checkout ../foo/bar" will attempt to create ./bar.
 
622
 
 
623
    To retrieve the branch as of a particular revision, supply the --revision
 
624
    parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
 
625
    out of date [so you cannot commit] but it may be useful (i.e. to examine old
 
626
    code.)
 
627
 
 
628
    --basis is to speed up checking out from remote branches.  When specified, it
 
629
    uses the inventory and file contents from the basis branch in preference to the
 
630
    branch being checked out. [Not implemented yet.]
 
631
    """
 
632
    takes_args = ['branch_location', 'to_location?']
 
633
    takes_options = ['revision'] # , 'basis']
 
634
 
 
635
    def run(self, branch_location, to_location=None, revision=None, basis=None):
 
636
        if revision is None:
 
637
            revision = [None]
 
638
        elif len(revision) > 1:
 
639
            raise BzrCommandError(
 
640
                'bzr checkout --revision takes exactly 1 revision value')
 
641
        source = Branch.open(branch_location)
 
642
        if len(revision) == 1 and revision[0] is not None:
 
643
            revision_id = revision[0].in_history(source)[1]
 
644
        else:
 
645
            revision_id = None
 
646
        if to_location is None:
 
647
            to_location = os.path.basename(branch_location.rstrip("/\\"))
 
648
        try:
 
649
            os.mkdir(to_location)
 
650
        except OSError, e:
 
651
            if e.errno == errno.EEXIST:
 
652
                raise BzrCommandError('Target directory "%s" already'
 
653
                                      ' exists.' % to_location)
 
654
            if e.errno == errno.ENOENT:
 
655
                raise BzrCommandError('Parent of "%s" does not exist.' %
 
656
                                      to_location)
 
657
            else:
 
658
                raise
 
659
        checkout = bzrdir.BzrDirMetaFormat1().initialize(to_location)
 
660
        bzrlib.branch.BranchReferenceFormat().initialize(checkout, source)
 
661
        checkout.create_workingtree(revision_id)
 
662
 
 
663
 
 
664
class cmd_renames(Command):
 
665
    """Show list of renamed files.
 
666
    """
 
667
    # TODO: Option to show renames between two historical versions.
 
668
 
 
669
    # TODO: Only show renames under dir, rather than in the whole branch.
 
670
    takes_args = ['dir?']
 
671
 
 
672
    @display_command
 
673
    def run(self, dir=u'.'):
 
674
        tree = WorkingTree.open_containing(dir)[0]
 
675
        old_inv = tree.basis_tree().inventory
 
676
        new_inv = tree.read_working_inventory()
 
677
 
 
678
        renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
 
679
        renames.sort()
 
680
        for old_name, new_name in renames:
 
681
            print "%s => %s" % (old_name, new_name)        
 
682
 
 
683
 
 
684
class cmd_update(Command):
 
685
    """Update a tree to have the latest code committed to its branch.
 
686
    
 
687
    This will perform a merge into the working tree, and may generate
 
688
    conflicts. If you have any uncommitted changes, you will still 
 
689
    need to commit them after the update.
 
690
    """
 
691
    takes_args = ['dir?']
 
692
 
 
693
    def run(self, dir='.'):
 
694
        tree = WorkingTree.open_containing(dir)[0]
 
695
        tree.lock_write()
 
696
        try:
 
697
            if tree.last_revision() == tree.branch.last_revision():
 
698
                note("Tree is up to date.")
 
699
                return
 
700
            conflicts = tree.update()
 
701
            note('Updated to revision %d.' %
 
702
                 (tree.branch.revision_id_to_revno(tree.last_revision()),))
 
703
            if conflicts != 0:
 
704
                return 1
 
705
            else:
 
706
                return 0
 
707
        finally:
 
708
            tree.unlock()
 
709
 
 
710
 
 
711
class cmd_info(Command):
 
712
    """Show statistical information about a branch."""
 
713
    takes_args = ['branch?']
 
714
    
 
715
    @display_command
 
716
    def run(self, branch=None):
 
717
        import info
 
718
        b = WorkingTree.open_containing(branch)[0].branch
 
719
        info.show_info(b)
 
720
 
 
721
 
 
722
class cmd_remove(Command):
 
723
    """Make a file unversioned.
 
724
 
 
725
    This makes bzr stop tracking changes to a versioned file.  It does
 
726
    not delete the working copy.
 
727
    """
 
728
    takes_args = ['file+']
 
729
    takes_options = ['verbose']
 
730
    aliases = ['rm']
 
731
    
 
732
    def run(self, file_list, verbose=False):
 
733
        tree, file_list = tree_files(file_list)
 
734
        tree.remove(file_list, verbose=verbose)
 
735
 
 
736
 
 
737
class cmd_file_id(Command):
 
738
    """Print file_id of a particular file or directory.
 
739
 
 
740
    The file_id is assigned when the file is first added and remains the
 
741
    same through all revisions where the file exists, even when it is
 
742
    moved or renamed.
 
743
    """
 
744
    hidden = True
 
745
    takes_args = ['filename']
 
746
    @display_command
 
747
    def run(self, filename):
 
748
        tree, relpath = WorkingTree.open_containing(filename)
 
749
        i = tree.inventory.path2id(relpath)
 
750
        if i == None:
 
751
            raise BzrError("%r is not a versioned file" % filename)
 
752
        else:
 
753
            print i
 
754
 
 
755
 
 
756
class cmd_file_path(Command):
 
757
    """Print path of file_ids to a file or directory.
 
758
 
 
759
    This prints one line for each directory down to the target,
 
760
    starting at the branch root."""
 
761
    hidden = True
 
762
    takes_args = ['filename']
 
763
    @display_command
 
764
    def run(self, filename):
 
765
        tree, relpath = WorkingTree.open_containing(filename)
 
766
        inv = tree.inventory
 
767
        fid = inv.path2id(relpath)
 
768
        if fid == None:
 
769
            raise BzrError("%r is not a versioned file" % filename)
 
770
        for fip in inv.get_idpath(fid):
 
771
            print fip
 
772
 
 
773
 
 
774
class cmd_revision_history(Command):
 
775
    """Display list of revision ids on this branch."""
 
776
    hidden = True
 
777
    @display_command
 
778
    def run(self):
 
779
        branch = WorkingTree.open_containing(u'.')[0].branch
 
780
        for patchid in branch.revision_history():
 
781
            print patchid
 
782
 
 
783
 
 
784
class cmd_ancestry(Command):
 
785
    """List all revisions merged into this branch."""
 
786
    hidden = True
 
787
    @display_command
 
788
    def run(self):
 
789
        tree = WorkingTree.open_containing(u'.')[0]
 
790
        b = tree.branch
 
791
        # FIXME. should be tree.last_revision
 
792
        for revision_id in b.repository.get_ancestry(b.last_revision()):
 
793
            print revision_id
 
794
 
 
795
 
 
796
class cmd_init(Command):
 
797
    """Make a directory into a versioned branch.
 
798
 
 
799
    Use this to create an empty branch, or before importing an
 
800
    existing project.
 
801
 
 
802
    Recipe for importing a tree of files:
 
803
        cd ~/project
 
804
        bzr init
 
805
        bzr add .
 
806
        bzr status
 
807
        bzr commit -m 'imported project'
 
808
    """
 
809
    takes_args = ['location?']
 
810
    def run(self, location=None):
 
811
        from bzrlib.branch import Branch
 
812
        if location is None:
 
813
            location = u'.'
 
814
        else:
 
815
            # The path has to exist to initialize a
 
816
            # branch inside of it.
 
817
            # Just using os.mkdir, since I don't
 
818
            # believe that we want to create a bunch of
 
819
            # locations if the user supplies an extended path
 
820
            if not os.path.exists(location):
 
821
                os.mkdir(location)
 
822
        WorkingTree.create_standalone(location)
 
823
 
 
824
 
 
825
class cmd_diff(Command):
 
826
    """Show differences in working tree.
 
827
    
 
828
    If files are listed, only the changes in those files are listed.
 
829
    Otherwise, all changes for the tree are listed.
 
830
 
 
831
    examples:
 
832
        bzr diff
 
833
        bzr diff -r1
 
834
        bzr diff -r1..2
 
835
    """
 
836
    # TODO: Allow diff across branches.
 
837
    # TODO: Option to use external diff command; could be GNU diff, wdiff,
 
838
    #       or a graphical diff.
 
839
 
 
840
    # TODO: Python difflib is not exactly the same as unidiff; should
 
841
    #       either fix it up or prefer to use an external diff.
 
842
 
 
843
    # TODO: If a directory is given, diff everything under that.
 
844
 
 
845
    # TODO: Selected-file diff is inefficient and doesn't show you
 
846
    #       deleted files.
 
847
 
 
848
    # TODO: This probably handles non-Unix newlines poorly.
 
849
    
 
850
    takes_args = ['file*']
 
851
    takes_options = ['revision', 'diff-options']
 
852
    aliases = ['di', 'dif']
 
853
 
 
854
    @display_command
 
855
    def run(self, revision=None, file_list=None, diff_options=None):
 
856
        from bzrlib.diff import show_diff
 
857
        try:
 
858
            tree, file_list = internal_tree_files(file_list)
 
859
            b = None
 
860
            b2 = None
 
861
        except FileInWrongBranch:
 
862
            if len(file_list) != 2:
 
863
                raise BzrCommandError("Files are in different branches")
 
864
 
 
865
            b, file1 = Branch.open_containing(file_list[0])
 
866
            b2, file2 = Branch.open_containing(file_list[1])
 
867
            if file1 != "" or file2 != "":
 
868
                # FIXME diff those two files. rbc 20051123
 
869
                raise BzrCommandError("Files are in different branches")
 
870
            file_list = None
 
871
        if revision is not None:
 
872
            if b2 is not None:
 
873
                raise BzrCommandError("Can't specify -r with two branches")
 
874
            if (len(revision) == 1) or (revision[1].spec is None):
 
875
                return show_diff(tree.branch, revision[0], specific_files=file_list,
 
876
                                 external_diff_options=diff_options)
 
877
            elif len(revision) == 2:
 
878
                return show_diff(tree.branch, revision[0], specific_files=file_list,
 
879
                                 external_diff_options=diff_options,
 
880
                                 revision2=revision[1])
 
881
            else:
 
882
                raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
 
883
        else:
 
884
            if b is not None:
 
885
                return show_diff(b, None, specific_files=file_list,
 
886
                                 external_diff_options=diff_options, b2=b2)
 
887
            else:
 
888
                return show_diff(tree.branch, None, specific_files=file_list,
 
889
                                 external_diff_options=diff_options)
 
890
 
 
891
 
 
892
class cmd_deleted(Command):
 
893
    """List files deleted in the working tree.
 
894
    """
 
895
    # TODO: Show files deleted since a previous revision, or
 
896
    # between two revisions.
 
897
    # TODO: Much more efficient way to do this: read in new
 
898
    # directories with readdir, rather than stating each one.  Same
 
899
    # level of effort but possibly much less IO.  (Or possibly not,
 
900
    # if the directories are very large...)
 
901
    @display_command
 
902
    def run(self, show_ids=False):
 
903
        tree = WorkingTree.open_containing(u'.')[0]
 
904
        old = tree.basis_tree()
 
905
        for path, ie in old.inventory.iter_entries():
 
906
            if not tree.has_id(ie.file_id):
 
907
                if show_ids:
 
908
                    print '%-50s %s' % (path, ie.file_id)
 
909
                else:
 
910
                    print path
 
911
 
 
912
 
 
913
class cmd_modified(Command):
 
914
    """List files modified in working tree."""
 
915
    hidden = True
 
916
    @display_command
 
917
    def run(self):
 
918
        from bzrlib.delta import compare_trees
 
919
 
 
920
        tree = WorkingTree.open_containing(u'.')[0]
 
921
        td = compare_trees(tree.basis_tree(), tree)
 
922
 
 
923
        for path, id, kind, text_modified, meta_modified in td.modified:
 
924
            print path
 
925
 
 
926
 
 
927
 
 
928
class cmd_added(Command):
 
929
    """List files added in working tree."""
 
930
    hidden = True
 
931
    @display_command
 
932
    def run(self):
 
933
        wt = WorkingTree.open_containing(u'.')[0]
 
934
        basis_inv = wt.basis_tree().inventory
 
935
        inv = wt.inventory
 
936
        for file_id in inv:
 
937
            if file_id in basis_inv:
 
938
                continue
 
939
            path = inv.id2path(file_id)
 
940
            if not os.access(bzrlib.osutils.abspath(path), os.F_OK):
 
941
                continue
 
942
            print path
 
943
                
 
944
        
 
945
 
 
946
class cmd_root(Command):
 
947
    """Show the tree root directory.
 
948
 
 
949
    The root is the nearest enclosing directory with a .bzr control
 
950
    directory."""
 
951
    takes_args = ['filename?']
 
952
    @display_command
 
953
    def run(self, filename=None):
 
954
        """Print the branch root."""
 
955
        tree = WorkingTree.open_containing(filename)[0]
 
956
        print tree.basedir
 
957
 
 
958
 
 
959
class cmd_log(Command):
 
960
    """Show log of this branch.
 
961
 
 
962
    To request a range of logs, you can use the command -r begin..end
 
963
    -r revision requests a specific revision, -r ..end or -r begin.. are
 
964
    also valid.
 
965
    """
 
966
 
 
967
    # TODO: Make --revision support uuid: and hash: [future tag:] notation.
 
968
 
 
969
    takes_args = ['filename?']
 
970
    takes_options = [Option('forward', 
 
971
                            help='show from oldest to newest'),
 
972
                     'timezone', 'verbose', 
 
973
                     'show-ids', 'revision',
 
974
                     'log-format',
 
975
                     'line', 'long', 
 
976
                     Option('message',
 
977
                            help='show revisions whose message matches this regexp',
 
978
                            type=str),
 
979
                     'short',
 
980
                     ]
 
981
    @display_command
 
982
    def run(self, filename=None, timezone='original',
 
983
            verbose=False,
 
984
            show_ids=False,
 
985
            forward=False,
 
986
            revision=None,
 
987
            log_format=None,
 
988
            message=None,
 
989
            long=False,
 
990
            short=False,
 
991
            line=False):
 
992
        from bzrlib.log import log_formatter, show_log
 
993
        import codecs
 
994
        assert message is None or isinstance(message, basestring), \
 
995
            "invalid message argument %r" % message
 
996
        direction = (forward and 'forward') or 'reverse'
 
997
        
 
998
        # log everything
 
999
        file_id = None
 
1000
        if filename:
 
1001
            # find the file id to log:
 
1002
 
 
1003
            dir, fp = bzrdir.BzrDir.open_containing(filename)
 
1004
            b = dir.open_branch()
 
1005
            if fp != '':
 
1006
                try:
 
1007
                    # might be a tree:
 
1008
                    inv = dir.open_workingtree().inventory
 
1009
                except (errors.NotBranchError, errors.NotLocalUrl):
 
1010
                    # either no tree, or is remote.
 
1011
                    inv = b.basis_tree().inventory
 
1012
                file_id = inv.path2id(fp)
 
1013
        else:
 
1014
            # local dir only
 
1015
            # FIXME ? log the current subdir only RBC 20060203 
 
1016
            dir, relpath = bzrdir.BzrDir.open_containing('.')
 
1017
            b = dir.open_branch()
 
1018
 
 
1019
        if revision is None:
 
1020
            rev1 = None
 
1021
            rev2 = None
 
1022
        elif len(revision) == 1:
 
1023
            rev1 = rev2 = revision[0].in_history(b).revno
 
1024
        elif len(revision) == 2:
 
1025
            rev1 = revision[0].in_history(b).revno
 
1026
            if revision[1].spec is None:
 
1027
                # missing end-range means last known revision
 
1028
                rev2 = b.revno()
 
1029
            else:
 
1030
                rev2 = revision[1].in_history(b).revno
 
1031
        else:
 
1032
            raise BzrCommandError('bzr log --revision takes one or two values.')
 
1033
 
 
1034
        # By this point, the revision numbers are converted to the +ve
 
1035
        # form if they were supplied in the -ve form, so we can do
 
1036
        # this comparison in relative safety
 
1037
        if rev1 > rev2:
 
1038
            (rev2, rev1) = (rev1, rev2)
 
1039
 
 
1040
        mutter('encoding log as %r', bzrlib.user_encoding)
 
1041
 
 
1042
        # use 'replace' so that we don't abort if trying to write out
 
1043
        # in e.g. the default C locale.
 
1044
        outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
 
1045
 
 
1046
        if (log_format == None):
 
1047
            default = bzrlib.config.BranchConfig(b).log_format()
 
1048
            log_format = get_log_format(long=long, short=short, line=line, default=default)
 
1049
 
 
1050
        lf = log_formatter(log_format,
 
1051
                           show_ids=show_ids,
 
1052
                           to_file=outf,
 
1053
                           show_timezone=timezone)
 
1054
 
 
1055
        show_log(b,
 
1056
                 lf,
 
1057
                 file_id,
 
1058
                 verbose=verbose,
 
1059
                 direction=direction,
 
1060
                 start_revision=rev1,
 
1061
                 end_revision=rev2,
 
1062
                 search=message)
 
1063
 
 
1064
 
 
1065
def get_log_format(long=False, short=False, line=False, default='long'):
 
1066
    log_format = default
 
1067
    if long:
 
1068
        log_format = 'long'
 
1069
    if short:
 
1070
        log_format = 'short'
 
1071
    if line:
 
1072
        log_format = 'line'
 
1073
    return log_format
 
1074
 
 
1075
 
 
1076
class cmd_touching_revisions(Command):
 
1077
    """Return revision-ids which affected a particular file.
 
1078
 
 
1079
    A more user-friendly interface is "bzr log FILE"."""
 
1080
    hidden = True
 
1081
    takes_args = ["filename"]
 
1082
    @display_command
 
1083
    def run(self, filename):
 
1084
        tree, relpath = WorkingTree.open_containing(filename)
 
1085
        b = tree.branch
 
1086
        inv = tree.read_working_inventory()
 
1087
        file_id = inv.path2id(relpath)
 
1088
        for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
 
1089
            print "%6d %s" % (revno, what)
 
1090
 
 
1091
 
 
1092
class cmd_ls(Command):
 
1093
    """List files in a tree.
 
1094
    """
 
1095
    # TODO: Take a revision or remote path and list that tree instead.
 
1096
    hidden = True
 
1097
    takes_options = ['verbose', 'revision',
 
1098
                     Option('non-recursive',
 
1099
                            help='don\'t recurse into sub-directories'),
 
1100
                     Option('from-root',
 
1101
                            help='Print all paths from the root of the branch.'),
 
1102
                     Option('unknown', help='Print unknown files'),
 
1103
                     Option('versioned', help='Print versioned files'),
 
1104
                     Option('ignored', help='Print ignored files'),
 
1105
 
 
1106
                     Option('null', help='Null separate the files'),
 
1107
                    ]
 
1108
    @display_command
 
1109
    def run(self, revision=None, verbose=False, 
 
1110
            non_recursive=False, from_root=False,
 
1111
            unknown=False, versioned=False, ignored=False,
 
1112
            null=False):
 
1113
 
 
1114
        if verbose and null:
 
1115
            raise BzrCommandError('Cannot set both --verbose and --null')
 
1116
        all = not (unknown or versioned or ignored)
 
1117
 
 
1118
        selection = {'I':ignored, '?':unknown, 'V':versioned}
 
1119
 
 
1120
        tree, relpath = WorkingTree.open_containing(u'.')
 
1121
        if from_root:
 
1122
            relpath = u''
 
1123
        elif relpath:
 
1124
            relpath += '/'
 
1125
        if revision is not None:
 
1126
            tree = tree.branch.repository.revision_tree(
 
1127
                revision[0].in_history(tree.branch).rev_id)
 
1128
        for fp, fc, kind, fid, entry in tree.list_files():
 
1129
            if fp.startswith(relpath):
 
1130
                fp = fp[len(relpath):]
 
1131
                if non_recursive and '/' in fp:
 
1132
                    continue
 
1133
                if not all and not selection[fc]:
 
1134
                    continue
 
1135
                if verbose:
 
1136
                    kindch = entry.kind_character()
 
1137
                    print '%-8s %s%s' % (fc, fp, kindch)
 
1138
                elif null:
 
1139
                    sys.stdout.write(fp)
 
1140
                    sys.stdout.write('\0')
 
1141
                    sys.stdout.flush()
 
1142
                else:
 
1143
                    print fp
 
1144
 
 
1145
 
 
1146
class cmd_unknowns(Command):
 
1147
    """List unknown files."""
 
1148
    @display_command
 
1149
    def run(self):
 
1150
        from bzrlib.osutils import quotefn
 
1151
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
 
1152
            print quotefn(f)
 
1153
 
 
1154
 
 
1155
class cmd_ignore(Command):
 
1156
    """Ignore a command or pattern.
 
1157
 
 
1158
    To remove patterns from the ignore list, edit the .bzrignore file.
 
1159
 
 
1160
    If the pattern contains a slash, it is compared to the whole path
 
1161
    from the branch root.  Otherwise, it is compared to only the last
 
1162
    component of the path.  To match a file only in the root directory,
 
1163
    prepend './'.
 
1164
 
 
1165
    Ignore patterns are case-insensitive on case-insensitive systems.
 
1166
 
 
1167
    Note: wildcards must be quoted from the shell on Unix.
 
1168
 
 
1169
    examples:
 
1170
        bzr ignore ./Makefile
 
1171
        bzr ignore '*.class'
 
1172
    """
 
1173
    # TODO: Complain if the filename is absolute
 
1174
    takes_args = ['name_pattern']
 
1175
    
 
1176
    def run(self, name_pattern):
 
1177
        from bzrlib.atomicfile import AtomicFile
 
1178
        import os.path
 
1179
 
 
1180
        tree, relpath = WorkingTree.open_containing(u'.')
 
1181
        ifn = tree.abspath('.bzrignore')
 
1182
 
 
1183
        if os.path.exists(ifn):
 
1184
            f = open(ifn, 'rt')
 
1185
            try:
 
1186
                igns = f.read().decode('utf-8')
 
1187
            finally:
 
1188
                f.close()
 
1189
        else:
 
1190
            igns = ''
 
1191
 
 
1192
        # TODO: If the file already uses crlf-style termination, maybe
 
1193
        # we should use that for the newly added lines?
 
1194
 
 
1195
        if igns and igns[-1] != '\n':
 
1196
            igns += '\n'
 
1197
        igns += name_pattern + '\n'
 
1198
 
 
1199
        try:
 
1200
            f = AtomicFile(ifn, 'wt')
 
1201
            f.write(igns.encode('utf-8'))
 
1202
            f.commit()
 
1203
        finally:
 
1204
            f.close()
 
1205
 
 
1206
        inv = tree.inventory
 
1207
        if inv.path2id('.bzrignore'):
 
1208
            mutter('.bzrignore is already versioned')
 
1209
        else:
 
1210
            mutter('need to make new .bzrignore file versioned')
 
1211
            tree.add(['.bzrignore'])
 
1212
 
 
1213
 
 
1214
class cmd_ignored(Command):
 
1215
    """List ignored files and the patterns that matched them.
 
1216
 
 
1217
    See also: bzr ignore"""
 
1218
    @display_command
 
1219
    def run(self):
 
1220
        tree = WorkingTree.open_containing(u'.')[0]
 
1221
        for path, file_class, kind, file_id, entry in tree.list_files():
 
1222
            if file_class != 'I':
 
1223
                continue
 
1224
            ## XXX: Slightly inefficient since this was already calculated
 
1225
            pat = tree.is_ignored(path)
 
1226
            print '%-50s %s' % (path, pat)
 
1227
 
 
1228
 
 
1229
class cmd_lookup_revision(Command):
 
1230
    """Lookup the revision-id from a revision-number
 
1231
 
 
1232
    example:
 
1233
        bzr lookup-revision 33
 
1234
    """
 
1235
    hidden = True
 
1236
    takes_args = ['revno']
 
1237
    
 
1238
    @display_command
 
1239
    def run(self, revno):
 
1240
        try:
 
1241
            revno = int(revno)
 
1242
        except ValueError:
 
1243
            raise BzrCommandError("not a valid revision-number: %r" % revno)
 
1244
 
 
1245
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
1246
 
 
1247
 
 
1248
class cmd_export(Command):
 
1249
    """Export past revision to destination directory.
 
1250
 
 
1251
    If no revision is specified this exports the last committed revision.
 
1252
 
 
1253
    Format may be an "exporter" name, such as tar, tgz, tbz2.  If none is
 
1254
    given, try to find the format with the extension. If no extension
 
1255
    is found exports to a directory (equivalent to --format=dir).
 
1256
 
 
1257
    Root may be the top directory for tar, tgz and tbz2 formats. If none
 
1258
    is given, the top directory will be the root name of the file.
 
1259
 
 
1260
    Note: export of tree with non-ascii filenames to zip is not supported.
 
1261
 
 
1262
     Supported formats       Autodetected by extension
 
1263
     -----------------       -------------------------
 
1264
         dir                            -
 
1265
         tar                          .tar
 
1266
         tbz2                    .tar.bz2, .tbz2
 
1267
         tgz                      .tar.gz, .tgz
 
1268
         zip                          .zip
 
1269
    """
 
1270
    takes_args = ['dest']
 
1271
    takes_options = ['revision', 'format', 'root']
 
1272
    def run(self, dest, revision=None, format=None, root=None):
 
1273
        import os.path
 
1274
        from bzrlib.export import export
 
1275
        tree = WorkingTree.open_containing(u'.')[0]
 
1276
        b = tree.branch
 
1277
        if revision is None:
 
1278
            # should be tree.last_revision  FIXME
 
1279
            rev_id = b.last_revision()
 
1280
        else:
 
1281
            if len(revision) != 1:
 
1282
                raise BzrError('bzr export --revision takes exactly 1 argument')
 
1283
            rev_id = revision[0].in_history(b).rev_id
 
1284
        t = b.repository.revision_tree(rev_id)
 
1285
        try:
 
1286
            export(t, dest, format, root)
 
1287
        except errors.NoSuchExportFormat, e:
 
1288
            raise BzrCommandError('Unsupported export format: %s' % e.format)
 
1289
 
 
1290
 
 
1291
class cmd_cat(Command):
 
1292
    """Write a file's text from a previous revision."""
 
1293
 
 
1294
    takes_options = ['revision']
 
1295
    takes_args = ['filename']
 
1296
 
 
1297
    @display_command
 
1298
    def run(self, filename, revision=None):
 
1299
        if revision is not None and len(revision) != 1:
 
1300
            raise BzrCommandError("bzr cat --revision takes exactly one number")
 
1301
        tree = None
 
1302
        try:
 
1303
            tree, relpath = WorkingTree.open_containing(filename)
 
1304
            b = tree.branch
 
1305
        except NotBranchError:
 
1306
            pass
 
1307
 
 
1308
        if tree is None:
 
1309
            b, relpath = Branch.open_containing(filename)
 
1310
        if revision is None:
 
1311
            revision_id = b.last_revision()
 
1312
        else:
 
1313
            revision_id = revision[0].in_history(b).rev_id
 
1314
        b.print_file(relpath, revision_id)
 
1315
 
 
1316
 
 
1317
class cmd_local_time_offset(Command):
 
1318
    """Show the offset in seconds from GMT to local time."""
 
1319
    hidden = True    
 
1320
    @display_command
 
1321
    def run(self):
 
1322
        print bzrlib.osutils.local_time_offset()
 
1323
 
 
1324
 
 
1325
 
 
1326
class cmd_commit(Command):
 
1327
    """Commit changes into a new revision.
 
1328
    
 
1329
    If no arguments are given, the entire tree is committed.
 
1330
 
 
1331
    If selected files are specified, only changes to those files are
 
1332
    committed.  If a directory is specified then the directory and everything 
 
1333
    within it is committed.
 
1334
 
 
1335
    A selected-file commit may fail in some cases where the committed
 
1336
    tree would be invalid, such as trying to commit a file in a
 
1337
    newly-added directory that is not itself committed.
 
1338
    """
 
1339
    # TODO: Run hooks on tree to-be-committed, and after commit.
 
1340
 
 
1341
    # TODO: Strict commit that fails if there are deleted files.
 
1342
    #       (what does "deleted files" mean ??)
 
1343
 
 
1344
    # TODO: Give better message for -s, --summary, used by tla people
 
1345
 
 
1346
    # XXX: verbose currently does nothing
 
1347
 
 
1348
    takes_args = ['selected*']
 
1349
    takes_options = ['message', 'verbose', 
 
1350
                     Option('unchanged',
 
1351
                            help='commit even if nothing has changed'),
 
1352
                     Option('file', type=str, 
 
1353
                            argname='msgfile',
 
1354
                            help='file containing commit message'),
 
1355
                     Option('strict',
 
1356
                            help="refuse to commit if there are unknown "
 
1357
                            "files in the working tree."),
 
1358
                     ]
 
1359
    aliases = ['ci', 'checkin']
 
1360
 
 
1361
    def run(self, message=None, file=None, verbose=True, selected_list=None,
 
1362
            unchanged=False, strict=False):
 
1363
        from bzrlib.errors import (PointlessCommit, ConflictsInTree,
 
1364
                StrictCommitFailed)
 
1365
        from bzrlib.msgeditor import edit_commit_message, \
 
1366
                make_commit_message_template
 
1367
        from bzrlib.status import show_status
 
1368
        from tempfile import TemporaryFile
 
1369
        import codecs
 
1370
 
 
1371
        # TODO: Need a blackbox test for invoking the external editor; may be
 
1372
        # slightly problematic to run this cross-platform.
 
1373
 
 
1374
        # TODO: do more checks that the commit will succeed before 
 
1375
        # spending the user's valuable time typing a commit message.
 
1376
        #
 
1377
        # TODO: if the commit *does* happen to fail, then save the commit 
 
1378
        # message to a temporary file where it can be recovered
 
1379
        tree, selected_list = tree_files(selected_list)
 
1380
        if message is None and not file:
 
1381
            template = make_commit_message_template(tree, selected_list)
 
1382
            message = edit_commit_message(template)
 
1383
            if message is None:
 
1384
                raise BzrCommandError("please specify a commit message"
 
1385
                                      " with either --message or --file")
 
1386
        elif message and file:
 
1387
            raise BzrCommandError("please specify either --message or --file")
 
1388
        
 
1389
        if file:
 
1390
            import codecs
 
1391
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
 
1392
 
 
1393
        if message == "":
 
1394
                raise BzrCommandError("empty commit message specified")
 
1395
            
 
1396
        try:
 
1397
            tree.commit(message, specific_files=selected_list,
 
1398
                        allow_pointless=unchanged, strict=strict)
 
1399
        except PointlessCommit:
 
1400
            # FIXME: This should really happen before the file is read in;
 
1401
            # perhaps prepare the commit; get the message; then actually commit
 
1402
            raise BzrCommandError("no changes to commit",
 
1403
                                  ["use --unchanged to commit anyhow"])
 
1404
        except ConflictsInTree:
 
1405
            raise BzrCommandError("Conflicts detected in working tree.  "
 
1406
                'Use "bzr conflicts" to list, "bzr resolve FILE" to resolve.')
 
1407
        except StrictCommitFailed:
 
1408
            raise BzrCommandError("Commit refused because there are unknown "
 
1409
                                  "files in the working tree.")
 
1410
        note('Committed revision %d.' % (tree.branch.revno(),))
 
1411
 
 
1412
 
 
1413
class cmd_check(Command):
 
1414
    """Validate consistency of branch history.
 
1415
 
 
1416
    This command checks various invariants about the branch storage to
 
1417
    detect data corruption or bzr bugs.
 
1418
    """
 
1419
    takes_args = ['branch?']
 
1420
    takes_options = ['verbose']
 
1421
 
 
1422
    def run(self, branch=None, verbose=False):
 
1423
        from bzrlib.check import check
 
1424
        if branch is None:
 
1425
            tree = WorkingTree.open_containing()[0]
 
1426
            branch = tree.branch
 
1427
        else:
 
1428
            branch = Branch.open(branch)
 
1429
        check(branch, verbose)
 
1430
 
 
1431
 
 
1432
class cmd_scan_cache(Command):
 
1433
    hidden = True
 
1434
    def run(self):
 
1435
        from bzrlib.hashcache import HashCache
 
1436
 
 
1437
        c = HashCache(u'.')
 
1438
        c.read()
 
1439
        c.scan()
 
1440
            
 
1441
        print '%6d stats' % c.stat_count
 
1442
        print '%6d in hashcache' % len(c._cache)
 
1443
        print '%6d files removed from cache' % c.removed_count
 
1444
        print '%6d hashes updated' % c.update_count
 
1445
        print '%6d files changed too recently to cache' % c.danger_count
 
1446
 
 
1447
        if c.needs_write:
 
1448
            c.write()
 
1449
            
 
1450
 
 
1451
 
 
1452
class cmd_upgrade(Command):
 
1453
    """Upgrade branch storage to current format.
 
1454
 
 
1455
    The check command or bzr developers may sometimes advise you to run
 
1456
    this command. When the default format has changed you may also be warned
 
1457
    during other operations to upgrade.
 
1458
    """
 
1459
    takes_args = ['url?']
 
1460
 
 
1461
    def run(self, url='.'):
 
1462
        from bzrlib.upgrade import upgrade
 
1463
        upgrade(url)
 
1464
 
 
1465
 
 
1466
class cmd_whoami(Command):
 
1467
    """Show bzr user id."""
 
1468
    takes_options = ['email']
 
1469
    
 
1470
    @display_command
 
1471
    def run(self, email=False):
 
1472
        try:
 
1473
            b = WorkingTree.open_containing(u'.')[0].branch
 
1474
            config = bzrlib.config.BranchConfig(b)
 
1475
        except NotBranchError:
 
1476
            config = bzrlib.config.GlobalConfig()
 
1477
        
 
1478
        if email:
 
1479
            print config.user_email()
 
1480
        else:
 
1481
            print config.username()
 
1482
 
 
1483
 
 
1484
class cmd_nick(Command):
 
1485
    """Print or set the branch nickname.  
 
1486
 
 
1487
    If unset, the tree root directory name is used as the nickname
 
1488
    To print the current nickname, execute with no argument.  
 
1489
    """
 
1490
    takes_args = ['nickname?']
 
1491
    def run(self, nickname=None):
 
1492
        branch = Branch.open_containing(u'.')[0]
 
1493
        if nickname is None:
 
1494
            self.printme(branch)
 
1495
        else:
 
1496
            branch.nick = nickname
 
1497
 
 
1498
    @display_command
 
1499
    def printme(self, branch):
 
1500
        print branch.nick 
 
1501
 
 
1502
 
 
1503
class cmd_selftest(Command):
 
1504
    """Run internal test suite.
 
1505
    
 
1506
    This creates temporary test directories in the working directory,
 
1507
    but not existing data is affected.  These directories are deleted
 
1508
    if the tests pass, or left behind to help in debugging if they
 
1509
    fail and --keep-output is specified.
 
1510
    
 
1511
    If arguments are given, they are regular expressions that say
 
1512
    which tests should run.
 
1513
 
 
1514
    If the global option '--no-plugins' is given, plugins are not loaded
 
1515
    before running the selftests.  This has two effects: features provided or
 
1516
    modified by plugins will not be tested, and tests provided by plugins will
 
1517
    not be run.
 
1518
 
 
1519
    examples:
 
1520
        bzr selftest ignore
 
1521
        bzr --no-plugins selftest -v
 
1522
    """
 
1523
    # TODO: --list should give a list of all available tests
 
1524
 
 
1525
    # NB: this is used from the class without creating an instance, which is
 
1526
    # why it does not have a self parameter.
 
1527
    def get_transport_type(typestring):
 
1528
        """Parse and return a transport specifier."""
 
1529
        if typestring == "sftp":
 
1530
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
1531
            return SFTPAbsoluteServer
 
1532
        if typestring == "memory":
 
1533
            from bzrlib.transport.memory import MemoryServer
 
1534
            return MemoryServer
 
1535
        msg = "No known transport type %s. Supported types are: sftp\n" %\
 
1536
            (typestring)
 
1537
        raise BzrCommandError(msg)
 
1538
 
 
1539
    hidden = True
 
1540
    takes_args = ['testspecs*']
 
1541
    takes_options = ['verbose',
 
1542
                     Option('one', help='stop when one test fails'),
 
1543
                     Option('keep-output', 
 
1544
                            help='keep output directories when tests fail'),
 
1545
                     Option('transport', 
 
1546
                            help='Use a different transport by default '
 
1547
                                 'throughout the test suite.',
 
1548
                            type=get_transport_type),
 
1549
                    ]
 
1550
 
 
1551
    def run(self, testspecs_list=None, verbose=False, one=False,
 
1552
            keep_output=False, transport=None):
 
1553
        import bzrlib.ui
 
1554
        from bzrlib.tests import selftest
 
1555
        # we don't want progress meters from the tests to go to the
 
1556
        # real output; and we don't want log messages cluttering up
 
1557
        # the real logs.
 
1558
        save_ui = bzrlib.ui.ui_factory
 
1559
        bzrlib.trace.info('running tests...')
 
1560
        try:
 
1561
            bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
 
1562
            if testspecs_list is not None:
 
1563
                pattern = '|'.join(testspecs_list)
 
1564
            else:
 
1565
                pattern = ".*"
 
1566
            result = selftest(verbose=verbose, 
 
1567
                              pattern=pattern,
 
1568
                              stop_on_failure=one, 
 
1569
                              keep_output=keep_output,
 
1570
                              transport=transport)
 
1571
            if result:
 
1572
                bzrlib.trace.info('tests passed')
 
1573
            else:
 
1574
                bzrlib.trace.info('tests failed')
 
1575
            return int(not result)
 
1576
        finally:
 
1577
            bzrlib.ui.ui_factory = save_ui
 
1578
 
 
1579
 
 
1580
def _get_bzr_branch():
 
1581
    """If bzr is run from a branch, return Branch or None"""
 
1582
    import bzrlib.errors
 
1583
    from bzrlib.branch import Branch
 
1584
    from bzrlib.osutils import abspath
 
1585
    from os.path import dirname
 
1586
    
 
1587
    try:
 
1588
        branch = Branch.open(dirname(abspath(dirname(__file__))))
 
1589
        return branch
 
1590
    except bzrlib.errors.BzrError:
 
1591
        return None
 
1592
    
 
1593
 
 
1594
def show_version():
 
1595
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
 
1596
    # is bzrlib itself in a branch?
 
1597
    branch = _get_bzr_branch()
 
1598
    if branch:
 
1599
        rh = branch.revision_history()
 
1600
        revno = len(rh)
 
1601
        print "  bzr checkout, revision %d" % (revno,)
 
1602
        print "  nick: %s" % (branch.nick,)
 
1603
        if rh:
 
1604
            print "  revid: %s" % (rh[-1],)
 
1605
    print bzrlib.__copyright__
 
1606
    print "http://bazaar-ng.org/"
 
1607
    print
 
1608
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
 
1609
    print "you may use, modify and redistribute it under the terms of the GNU"
 
1610
    print "General Public License version 2 or later."
 
1611
 
 
1612
 
 
1613
class cmd_version(Command):
 
1614
    """Show version of bzr."""
 
1615
    @display_command
 
1616
    def run(self):
 
1617
        show_version()
 
1618
 
 
1619
class cmd_rocks(Command):
 
1620
    """Statement of optimism."""
 
1621
    hidden = True
 
1622
    @display_command
 
1623
    def run(self):
 
1624
        print "it sure does!"
 
1625
 
 
1626
 
 
1627
class cmd_find_merge_base(Command):
 
1628
    """Find and print a base revision for merging two branches.
 
1629
    """
 
1630
    # TODO: Options to specify revisions on either side, as if
 
1631
    #       merging only part of the history.
 
1632
    takes_args = ['branch', 'other']
 
1633
    hidden = True
 
1634
    
 
1635
    @display_command
 
1636
    def run(self, branch, other):
 
1637
        from bzrlib.revision import common_ancestor, MultipleRevisionSources
 
1638
        
 
1639
        branch1 = Branch.open_containing(branch)[0]
 
1640
        branch2 = Branch.open_containing(other)[0]
 
1641
 
 
1642
        history_1 = branch1.revision_history()
 
1643
        history_2 = branch2.revision_history()
 
1644
 
 
1645
        last1 = branch1.last_revision()
 
1646
        last2 = branch2.last_revision()
 
1647
 
 
1648
        source = MultipleRevisionSources(branch1.repository, 
 
1649
                                         branch2.repository)
 
1650
        
 
1651
        base_rev_id = common_ancestor(last1, last2, source)
 
1652
 
 
1653
        print 'merge base is revision %s' % base_rev_id
 
1654
        
 
1655
        return
 
1656
 
 
1657
        if base_revno is None:
 
1658
            raise bzrlib.errors.UnrelatedBranches()
 
1659
 
 
1660
        print ' r%-6d in %s' % (base_revno, branch)
 
1661
 
 
1662
        other_revno = branch2.revision_id_to_revno(base_revid)
 
1663
        
 
1664
        print ' r%-6d in %s' % (other_revno, other)
 
1665
 
 
1666
 
 
1667
 
 
1668
class cmd_merge(Command):
 
1669
    """Perform a three-way merge.
 
1670
    
 
1671
    The branch is the branch you will merge from.  By default, it will
 
1672
    merge the latest revision.  If you specify a revision, that
 
1673
    revision will be merged.  If you specify two revisions, the first
 
1674
    will be used as a BASE, and the second one as OTHER.  Revision
 
1675
    numbers are always relative to the specified branch.
 
1676
 
 
1677
    By default bzr will try to merge in all new work from the other
 
1678
    branch, automatically determining an appropriate base.  If this
 
1679
    fails, you may need to give an explicit base.
 
1680
    
 
1681
    Examples:
 
1682
 
 
1683
    To merge the latest revision from bzr.dev
 
1684
    bzr merge ../bzr.dev
 
1685
 
 
1686
    To merge changes up to and including revision 82 from bzr.dev
 
1687
    bzr merge -r 82 ../bzr.dev
 
1688
 
 
1689
    To merge the changes introduced by 82, without previous changes:
 
1690
    bzr merge -r 81..82 ../bzr.dev
 
1691
    
 
1692
    merge refuses to run if there are any uncommitted changes, unless
 
1693
    --force is given.
 
1694
    """
 
1695
    takes_args = ['branch?']
 
1696
    takes_options = ['revision', 'force', 'merge-type', 'reprocess',
 
1697
                     Option('show-base', help="Show base revision text in "
 
1698
                            "conflicts")]
 
1699
 
 
1700
    def run(self, branch=None, revision=None, force=False, merge_type=None,
 
1701
            show_base=False, reprocess=False):
 
1702
        from bzrlib._merge_core import ApplyMerge3
 
1703
        if merge_type is None:
 
1704
            merge_type = ApplyMerge3
 
1705
        if branch is None:
 
1706
            branch = WorkingTree.open_containing(u'.')[0].branch.get_parent()
 
1707
            if branch is None:
 
1708
                raise BzrCommandError("No merge location known or specified.")
 
1709
            else:
 
1710
                print "Using saved location: %s" % branch 
 
1711
        if revision is None or len(revision) < 1:
 
1712
            base = [None, None]
 
1713
            other = [branch, -1]
 
1714
        else:
 
1715
            if len(revision) == 1:
 
1716
                base = [None, None]
 
1717
                other_branch = Branch.open_containing(branch)[0]
 
1718
                revno = revision[0].in_history(other_branch).revno
 
1719
                other = [branch, revno]
 
1720
            else:
 
1721
                assert len(revision) == 2
 
1722
                if None in revision:
 
1723
                    raise BzrCommandError(
 
1724
                        "Merge doesn't permit that revision specifier.")
 
1725
                b = Branch.open_containing(branch)[0]
 
1726
 
 
1727
                base = [branch, revision[0].in_history(b).revno]
 
1728
                other = [branch, revision[1].in_history(b).revno]
 
1729
 
 
1730
        try:
 
1731
            conflict_count = merge(other, base, check_clean=(not force),
 
1732
                                   merge_type=merge_type, reprocess=reprocess,
 
1733
                                   show_base=show_base)
 
1734
            if conflict_count != 0:
 
1735
                return 1
 
1736
            else:
 
1737
                return 0
 
1738
        except bzrlib.errors.AmbiguousBase, e:
 
1739
            m = ("sorry, bzr can't determine the right merge base yet\n"
 
1740
                 "candidates are:\n  "
 
1741
                 + "\n  ".join(e.bases)
 
1742
                 + "\n"
 
1743
                 "please specify an explicit base with -r,\n"
 
1744
                 "and (if you want) report this to the bzr developers\n")
 
1745
            log_error(m)
 
1746
 
 
1747
 
 
1748
class cmd_remerge(Command):
 
1749
    """Redo a merge.
 
1750
    """
 
1751
    takes_args = ['file*']
 
1752
    takes_options = ['merge-type', 'reprocess',
 
1753
                     Option('show-base', help="Show base revision text in "
 
1754
                            "conflicts")]
 
1755
 
 
1756
    def run(self, file_list=None, merge_type=None, show_base=False,
 
1757
            reprocess=False):
 
1758
        from bzrlib.merge import merge_inner, transform_tree
 
1759
        from bzrlib._merge_core import ApplyMerge3
 
1760
        if merge_type is None:
 
1761
            merge_type = ApplyMerge3
 
1762
        tree, file_list = tree_files(file_list)
 
1763
        tree.lock_write()
 
1764
        try:
 
1765
            pending_merges = tree.pending_merges() 
 
1766
            if len(pending_merges) != 1:
 
1767
                raise BzrCommandError("Sorry, remerge only works after normal"
 
1768
                                      + " merges.  Not cherrypicking or"
 
1769
                                      + "multi-merges.")
 
1770
            repository = tree.branch.repository
 
1771
            base_revision = common_ancestor(tree.branch.last_revision(), 
 
1772
                                            pending_merges[0], repository)
 
1773
            base_tree = repository.revision_tree(base_revision)
 
1774
            other_tree = repository.revision_tree(pending_merges[0])
 
1775
            interesting_ids = None
 
1776
            if file_list is not None:
 
1777
                interesting_ids = set()
 
1778
                for filename in file_list:
 
1779
                    file_id = tree.path2id(filename)
 
1780
                    interesting_ids.add(file_id)
 
1781
                    if tree.kind(file_id) != "directory":
 
1782
                        continue
 
1783
                    
 
1784
                    for name, ie in tree.inventory.iter_entries(file_id):
 
1785
                        interesting_ids.add(ie.file_id)
 
1786
            transform_tree(tree, tree.basis_tree(), interesting_ids)
 
1787
            if file_list is None:
 
1788
                restore_files = list(tree.iter_conflicts())
 
1789
            else:
 
1790
                restore_files = file_list
 
1791
            for filename in restore_files:
 
1792
                try:
 
1793
                    restore(tree.abspath(filename))
 
1794
                except NotConflicted:
 
1795
                    pass
 
1796
            conflicts =  merge_inner(tree.branch, other_tree, base_tree, 
 
1797
                                     interesting_ids = interesting_ids, 
 
1798
                                     other_rev_id=pending_merges[0], 
 
1799
                                     merge_type=merge_type, 
 
1800
                                     show_base=show_base,
 
1801
                                     reprocess=reprocess)
 
1802
        finally:
 
1803
            tree.unlock()
 
1804
        if conflicts > 0:
 
1805
            return 1
 
1806
        else:
 
1807
            return 0
 
1808
 
 
1809
class cmd_revert(Command):
 
1810
    """Reverse all changes since the last commit.
 
1811
 
 
1812
    Only versioned files are affected.  Specify filenames to revert only 
 
1813
    those files.  By default, any files that are changed will be backed up
 
1814
    first.  Backup files have a '~' appended to their name.
 
1815
    """
 
1816
    takes_options = ['revision', 'no-backup']
 
1817
    takes_args = ['file*']
 
1818
    aliases = ['merge-revert']
 
1819
 
 
1820
    def run(self, revision=None, no_backup=False, file_list=None):
 
1821
        from bzrlib.commands import parse_spec
 
1822
        if file_list is not None:
 
1823
            if len(file_list) == 0:
 
1824
                raise BzrCommandError("No files specified")
 
1825
        else:
 
1826
            file_list = []
 
1827
        
 
1828
        tree, file_list = tree_files(file_list)
 
1829
        if revision is None:
 
1830
            # FIXME should be tree.last_revision
 
1831
            rev_id = tree.branch.last_revision()
 
1832
        elif len(revision) != 1:
 
1833
            raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
 
1834
        else:
 
1835
            rev_id = revision[0].in_history(tree.branch).rev_id
 
1836
        tree.revert(file_list, tree.branch.repository.revision_tree(rev_id),
 
1837
                    not no_backup)
 
1838
 
 
1839
 
 
1840
class cmd_assert_fail(Command):
 
1841
    """Test reporting of assertion failures"""
 
1842
    hidden = True
 
1843
    def run(self):
 
1844
        assert False, "always fails"
 
1845
 
 
1846
 
 
1847
class cmd_help(Command):
 
1848
    """Show help on a command or other topic.
 
1849
 
 
1850
    For a list of all available commands, say 'bzr help commands'."""
 
1851
    takes_options = ['long']
 
1852
    takes_args = ['topic?']
 
1853
    aliases = ['?']
 
1854
    
 
1855
    @display_command
 
1856
    def run(self, topic=None, long=False):
 
1857
        import help
 
1858
        if topic is None and long:
 
1859
            topic = "commands"
 
1860
        help.help(topic)
 
1861
 
 
1862
 
 
1863
class cmd_shell_complete(Command):
 
1864
    """Show appropriate completions for context.
 
1865
 
 
1866
    For a list of all available commands, say 'bzr shell-complete'."""
 
1867
    takes_args = ['context?']
 
1868
    aliases = ['s-c']
 
1869
    hidden = True
 
1870
    
 
1871
    @display_command
 
1872
    def run(self, context=None):
 
1873
        import shellcomplete
 
1874
        shellcomplete.shellcomplete(context)
 
1875
 
 
1876
 
 
1877
class cmd_fetch(Command):
 
1878
    """Copy in history from another branch but don't merge it.
 
1879
 
 
1880
    This is an internal method used for pull and merge."""
 
1881
    hidden = True
 
1882
    takes_args = ['from_branch', 'to_branch']
 
1883
    def run(self, from_branch, to_branch):
 
1884
        from bzrlib.fetch import Fetcher
 
1885
        from bzrlib.branch import Branch
 
1886
        from_b = Branch.open(from_branch)
 
1887
        to_b = Branch.open(to_branch)
 
1888
        Fetcher(to_b, from_b)
 
1889
 
 
1890
 
 
1891
class cmd_missing(Command):
 
1892
    """Show unmerged/unpulled revisions between two branches.
 
1893
 
 
1894
    OTHER_BRANCH may be local or remote."""
 
1895
    takes_args = ['other_branch?']
 
1896
    takes_options = [Option('reverse', 'Reverse the order of revisions'),
 
1897
                     Option('mine-only', 
 
1898
                            'Display changes in the local branch only'),
 
1899
                     Option('theirs-only', 
 
1900
                            'Display changes in the remote branch only'), 
 
1901
                     'log-format',
 
1902
                     'line',
 
1903
                     'long', 
 
1904
                     'short',
 
1905
                     'show-ids',
 
1906
                     'verbose'
 
1907
                     ]
 
1908
 
 
1909
    def run(self, other_branch=None, reverse=False, mine_only=False,
 
1910
            theirs_only=False, log_format=None, long=False, short=False, line=False, 
 
1911
            show_ids=False, verbose=False):
 
1912
        from bzrlib.missing import find_unmerged, iter_log_data
 
1913
        from bzrlib.log import log_formatter
 
1914
        local_branch = bzrlib.branch.Branch.open_containing(u".")[0]
 
1915
        parent = local_branch.get_parent()
 
1916
        if other_branch is None:
 
1917
            other_branch = parent
 
1918
            if other_branch is None:
 
1919
                raise BzrCommandError("No missing location known or specified.")
 
1920
            print "Using last location: " + local_branch.get_parent()
 
1921
        remote_branch = bzrlib.branch.Branch.open(other_branch)
 
1922
        local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
 
1923
        if (log_format == None):
 
1924
            default = bzrlib.config.BranchConfig(local_branch).log_format()
 
1925
            log_format = get_log_format(long=long, short=short, line=line, default=default)
 
1926
        lf = log_formatter(log_format, sys.stdout,
 
1927
                           show_ids=show_ids,
 
1928
                           show_timezone='original')
 
1929
        if reverse is False:
 
1930
            local_extra.reverse()
 
1931
            remote_extra.reverse()
 
1932
        if local_extra and not theirs_only:
 
1933
            print "You have %d extra revision(s):" % len(local_extra)
 
1934
            for data in iter_log_data(local_extra, local_branch.repository,
 
1935
                                      verbose):
 
1936
                lf.show(*data)
 
1937
            printed_local = True
 
1938
        else:
 
1939
            printed_local = False
 
1940
        if remote_extra and not mine_only:
 
1941
            if printed_local is True:
 
1942
                print "\n\n"
 
1943
            print "You are missing %d revision(s):" % len(remote_extra)
 
1944
            for data in iter_log_data(remote_extra, remote_branch.repository, 
 
1945
                                      verbose):
 
1946
                lf.show(*data)
 
1947
        if not remote_extra and not local_extra:
 
1948
            status_code = 0
 
1949
            print "Branches are up to date."
 
1950
        else:
 
1951
            status_code = 1
 
1952
        if parent is None and other_branch is not None:
 
1953
            local_branch.set_parent(other_branch)
 
1954
        return status_code
 
1955
 
 
1956
 
 
1957
class cmd_plugins(Command):
 
1958
    """List plugins"""
 
1959
    hidden = True
 
1960
    @display_command
 
1961
    def run(self):
 
1962
        import bzrlib.plugin
 
1963
        from inspect import getdoc
 
1964
        for name, plugin in bzrlib.plugin.all_plugins().items():
 
1965
            if hasattr(plugin, '__path__'):
 
1966
                print plugin.__path__[0]
 
1967
            elif hasattr(plugin, '__file__'):
 
1968
                print plugin.__file__
 
1969
            else:
 
1970
                print `plugin`
 
1971
                
 
1972
            d = getdoc(plugin)
 
1973
            if d:
 
1974
                print '\t', d.split('\n')[0]
 
1975
 
 
1976
 
 
1977
class cmd_testament(Command):
 
1978
    """Show testament (signing-form) of a revision."""
 
1979
    takes_options = ['revision', 'long']
 
1980
    takes_args = ['branch?']
 
1981
    @display_command
 
1982
    def run(self, branch=u'.', revision=None, long=False):
 
1983
        from bzrlib.testament import Testament
 
1984
        b = WorkingTree.open_containing(branch)[0].branch
 
1985
        b.lock_read()
 
1986
        try:
 
1987
            if revision is None:
 
1988
                rev_id = b.last_revision()
 
1989
            else:
 
1990
                rev_id = revision[0].in_history(b).rev_id
 
1991
            t = Testament.from_revision(b.repository, rev_id)
 
1992
            if long:
 
1993
                sys.stdout.writelines(t.as_text_lines())
 
1994
            else:
 
1995
                sys.stdout.write(t.as_short_text())
 
1996
        finally:
 
1997
            b.unlock()
 
1998
 
 
1999
 
 
2000
class cmd_annotate(Command):
 
2001
    """Show the origin of each line in a file.
 
2002
 
 
2003
    This prints out the given file with an annotation on the left side
 
2004
    indicating which revision, author and date introduced the change.
 
2005
 
 
2006
    If the origin is the same for a run of consecutive lines, it is 
 
2007
    shown only at the top, unless the --all option is given.
 
2008
    """
 
2009
    # TODO: annotate directories; showing when each file was last changed
 
2010
    # TODO: annotate a previous version of a file
 
2011
    # TODO: if the working copy is modified, show annotations on that 
 
2012
    #       with new uncommitted lines marked
 
2013
    aliases = ['blame', 'praise']
 
2014
    takes_args = ['filename']
 
2015
    takes_options = [Option('all', help='show annotations on all lines'),
 
2016
                     Option('long', help='show date in annotations'),
 
2017
                     ]
 
2018
 
 
2019
    @display_command
 
2020
    def run(self, filename, all=False, long=False):
 
2021
        from bzrlib.annotate import annotate_file
 
2022
        tree, relpath = WorkingTree.open_containing(filename)
 
2023
        branch = tree.branch
 
2024
        branch.lock_read()
 
2025
        try:
 
2026
            file_id = tree.inventory.path2id(relpath)
 
2027
            tree = branch.repository.revision_tree(branch.last_revision())
 
2028
            file_version = tree.inventory[file_id].revision
 
2029
            annotate_file(branch, file_version, file_id, long, all, sys.stdout)
 
2030
        finally:
 
2031
            branch.unlock()
 
2032
 
 
2033
 
 
2034
class cmd_re_sign(Command):
 
2035
    """Create a digital signature for an existing revision."""
 
2036
    # TODO be able to replace existing ones.
 
2037
 
 
2038
    hidden = True # is this right ?
 
2039
    takes_args = ['revision_id*']
 
2040
    takes_options = ['revision']
 
2041
    
 
2042
    def run(self, revision_id_list=None, revision=None):
 
2043
        import bzrlib.config as config
 
2044
        import bzrlib.gpg as gpg
 
2045
        if revision_id_list is not None and revision is not None:
 
2046
            raise BzrCommandError('You can only supply one of revision_id or --revision')
 
2047
        if revision_id_list is None and revision is None:
 
2048
            raise BzrCommandError('You must supply either --revision or a revision_id')
 
2049
        b = WorkingTree.open_containing(u'.')[0].branch
 
2050
        gpg_strategy = gpg.GPGStrategy(config.BranchConfig(b))
 
2051
        if revision_id_list is not None:
 
2052
            for revision_id in revision_id_list:
 
2053
                b.repository.sign_revision(revision_id, gpg_strategy)
 
2054
        elif revision is not None:
 
2055
            if len(revision) == 1:
 
2056
                revno, rev_id = revision[0].in_history(b)
 
2057
                b.repository.sign_revision(rev_id, gpg_strategy)
 
2058
            elif len(revision) == 2:
 
2059
                # are they both on rh- if so we can walk between them
 
2060
                # might be nice to have a range helper for arbitrary
 
2061
                # revision paths. hmm.
 
2062
                from_revno, from_revid = revision[0].in_history(b)
 
2063
                to_revno, to_revid = revision[1].in_history(b)
 
2064
                if to_revid is None:
 
2065
                    to_revno = b.revno()
 
2066
                if from_revno is None or to_revno is None:
 
2067
                    raise BzrCommandError('Cannot sign a range of non-revision-history revisions')
 
2068
                for revno in range(from_revno, to_revno + 1):
 
2069
                    b.repository.sign_revision(b.get_rev_id(revno), 
 
2070
                                               gpg_strategy)
 
2071
            else:
 
2072
                raise BzrCommandError('Please supply either one revision, or a range.')
 
2073
 
 
2074
 
 
2075
class cmd_uncommit(bzrlib.commands.Command):
 
2076
    """Remove the last committed revision.
 
2077
 
 
2078
    By supplying the --all flag, it will not only remove the entry 
 
2079
    from revision_history, but also remove all of the entries in the
 
2080
    stores.
 
2081
 
 
2082
    --verbose will print out what is being removed.
 
2083
    --dry-run will go through all the motions, but not actually
 
2084
    remove anything.
 
2085
    
 
2086
    In the future, uncommit will create a changeset, which can then
 
2087
    be re-applied.
 
2088
 
 
2089
    TODO: jam 20060108 Add an option to allow uncommit to remove unreferenced
 
2090
              information in 'branch-as-repostory' branches.
 
2091
    TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
 
2092
              information in shared branches as well.
 
2093
    """
 
2094
    takes_options = ['verbose', 'revision',
 
2095
                    Option('dry-run', help='Don\'t actually make changes'),
 
2096
                    Option('force', help='Say yes to all questions.')]
 
2097
    takes_args = ['location?']
 
2098
    aliases = []
 
2099
 
 
2100
    def run(self, location=None, 
 
2101
            dry_run=False, verbose=False,
 
2102
            revision=None, force=False):
 
2103
        from bzrlib.branch import Branch
 
2104
        from bzrlib.log import log_formatter
 
2105
        import sys
 
2106
        from bzrlib.uncommit import uncommit
 
2107
 
 
2108
        if location is None:
 
2109
            location = u'.'
 
2110
        b, relpath = Branch.open_containing(location)
 
2111
 
 
2112
        if revision is None:
 
2113
            revno = b.revno()
 
2114
            rev_id = b.last_revision()
 
2115
        else:
 
2116
            revno, rev_id = revision[0].in_history(b)
 
2117
        if rev_id is None:
 
2118
            print 'No revisions to uncommit.'
 
2119
 
 
2120
        for r in range(revno, b.revno()+1):
 
2121
            rev_id = b.get_rev_id(r)
 
2122
            lf = log_formatter('short', to_file=sys.stdout,show_timezone='original')
 
2123
            lf.show(r, b.repository.get_revision(rev_id), None)
 
2124
 
 
2125
        if dry_run:
 
2126
            print 'Dry-run, pretending to remove the above revisions.'
 
2127
            if not force:
 
2128
                val = raw_input('Press <enter> to continue')
 
2129
        else:
 
2130
            print 'The above revision(s) will be removed.'
 
2131
            if not force:
 
2132
                val = raw_input('Are you sure [y/N]? ')
 
2133
                if val.lower() not in ('y', 'yes'):
 
2134
                    print 'Canceled'
 
2135
                    return 0
 
2136
 
 
2137
        uncommit(b, dry_run=dry_run, verbose=verbose,
 
2138
                revno=revno)
 
2139
 
 
2140
 
 
2141
def merge(other_revision, base_revision,
 
2142
          check_clean=True, ignore_zero=False,
 
2143
          this_dir=None, backup_files=False, merge_type=ApplyMerge3,
 
2144
          file_list=None, show_base=False, reprocess=False):
 
2145
    """Merge changes into a tree.
 
2146
 
 
2147
    base_revision
 
2148
        list(path, revno) Base for three-way merge.  
 
2149
        If [None, None] then a base will be automatically determined.
 
2150
    other_revision
 
2151
        list(path, revno) Other revision for three-way merge.
 
2152
    this_dir
 
2153
        Directory to merge changes into; '.' by default.
 
2154
    check_clean
 
2155
        If true, this_dir must have no uncommitted changes before the
 
2156
        merge begins.
 
2157
    ignore_zero - If true, suppress the "zero conflicts" message when 
 
2158
        there are no conflicts; should be set when doing something we expect
 
2159
        to complete perfectly.
 
2160
    file_list - If supplied, merge only changes to selected files.
 
2161
 
 
2162
    All available ancestors of other_revision and base_revision are
 
2163
    automatically pulled into the branch.
 
2164
 
 
2165
    The revno may be -1 to indicate the last revision on the branch, which is
 
2166
    the typical case.
 
2167
 
 
2168
    This function is intended for use from the command line; programmatic
 
2169
    clients might prefer to call merge.merge_inner(), which has less magic 
 
2170
    behavior.
 
2171
    """
 
2172
    from bzrlib.merge import Merger, _MergeConflictHandler
 
2173
    if this_dir is None:
 
2174
        this_dir = u'.'
 
2175
    this_tree = WorkingTree.open_containing(this_dir)[0]
 
2176
    if show_base and not merge_type is ApplyMerge3:
 
2177
        raise BzrCommandError("Show-base is not supported for this merge"
 
2178
                              " type. %s" % merge_type)
 
2179
    if reprocess and not merge_type is ApplyMerge3:
 
2180
        raise BzrCommandError("Reprocess is not supported for this merge"
 
2181
                              " type. %s" % merge_type)
 
2182
    if reprocess and show_base:
 
2183
        raise BzrCommandError("Cannot reprocess and show base.")
 
2184
    merger = Merger(this_tree.branch, this_tree=this_tree)
 
2185
    merger.check_basis(check_clean)
 
2186
    merger.set_other(other_revision)
 
2187
    merger.set_base(base_revision)
 
2188
    if merger.base_rev_id == merger.other_rev_id:
 
2189
        note('Nothing to do.')
 
2190
        return 0
 
2191
    merger.backup_files = backup_files
 
2192
    merger.merge_type = merge_type 
 
2193
    merger.set_interesting_files(file_list)
 
2194
    merger.show_base = show_base 
 
2195
    merger.reprocess = reprocess
 
2196
    merger.conflict_handler = _MergeConflictHandler(merger.this_tree, 
 
2197
                                                    merger.base_tree, 
 
2198
                                                    merger.other_tree,
 
2199
                                                    ignore_zero=ignore_zero)
 
2200
    conflicts = merger.do_merge()
 
2201
    merger.set_pending()
 
2202
    return conflicts
 
2203
 
 
2204
 
 
2205
# these get imported and then picked up by the scan for cmd_*
 
2206
# TODO: Some more consistent way to split command definitions across files;
 
2207
# we do need to load at least some information about them to know of 
 
2208
# aliases.
 
2209
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore