~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

More conflict handling, test porting

Show diffs side-by-side

added added

removed removed

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