1
# Copyright (C) 2004, 2005 by Canonical Ltd
 
 
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.
 
 
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.
 
 
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
 
 
17
"""builtin bzr commands"""
 
 
24
from bzrlib import BZRDIR
 
 
25
from bzrlib._merge_core import ApplyMerge3
 
 
26
from bzrlib.commands import Command, display_command
 
 
27
from bzrlib.branch import Branch
 
 
28
from bzrlib.revision import common_ancestor
 
 
29
import bzrlib.errors as errors
 
 
30
from bzrlib.errors import (BzrError, BzrCheckError, BzrCommandError, 
 
 
31
                           NotBranchError, DivergedBranches, NotConflicted,
 
 
32
                           NoSuchFile, NoWorkingTree, FileInWrongBranch)
 
 
33
from bzrlib.log import show_one_log
 
 
34
from bzrlib.option import Option
 
 
35
from bzrlib.revisionspec import RevisionSpec
 
 
37
from bzrlib.trace import mutter, note, log_error, warning, is_quiet
 
 
38
from bzrlib.transport.local import LocalTransport
 
 
39
from bzrlib.workingtree import WorkingTree
 
 
42
def tree_files(file_list, default_branch=u'.'):
 
 
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]))
 
 
49
def internal_tree_files(file_list, default_branch=u'.'):
 
 
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.
 
 
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]
 
 
59
    for filename in file_list:
 
 
61
            new_list.append(tree.relpath(filename))
 
 
62
        except errors.PathNotChild:
 
 
63
            raise FileInWrongBranch(tree.branch, filename)
 
 
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
 
 
73
class cmd_status(Command):
 
 
74
    """Display status summary.
 
 
76
    This reports on versioned and unknown files, reporting them
 
 
77
    grouped by state.  Possible states are:
 
 
80
        Versioned in the working copy but not in the previous revision.
 
 
83
        Versioned in the previous revision but removed or deleted
 
 
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.
 
 
92
        Text has changed since the previous revision.
 
 
95
        Nothing about this file has changed since the previous revision.
 
 
96
        Only shown with --all.
 
 
99
        Not versioned and not matching an ignore pattern.
 
 
101
    To see ignored files use 'bzr ignored'.  For details in the
 
 
102
    changes to file texts, use 'bzr diff'.
 
 
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.
 
 
109
    If a revision argument is given, the status is calculated against
 
 
110
    that revision, or between two revisions if two are provided.
 
 
113
    # TODO: --no-recurse, --recurse options
 
 
115
    takes_args = ['file*']
 
 
116
    takes_options = ['all', 'show-ids', 'revision']
 
 
117
    aliases = ['st', 'stat']
 
 
120
    def run(self, all=False, show_ids=False, file_list=None, revision=None):
 
 
121
        tree, file_list = tree_files(file_list)
 
 
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)
 
 
128
class cmd_cat_revision(Command):
 
 
129
    """Write out metadata for a revision.
 
 
131
    The revision to print can either be specified by a specific
 
 
132
    revision identifier, or you can use --revision.
 
 
136
    takes_args = ['revision_id?']
 
 
137
    takes_options = ['revision']
 
 
140
    def run(self, revision_id=None, revision=None):
 
 
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:
 
 
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))
 
 
157
class cmd_revno(Command):
 
 
158
    """Show current revision number.
 
 
160
    This is equal to the number of revisions on this branch."""
 
 
161
    takes_args = ['location?']
 
 
163
    def run(self, location=u'.'):
 
 
164
        print Branch.open_containing(location)[0].revno()
 
 
167
class cmd_revision_info(Command):
 
 
168
    """Show revision number and revision id for a given revision identifier.
 
 
171
    takes_args = ['revision_info*']
 
 
172
    takes_options = ['revision']
 
 
174
    def run(self, revision=None, revision_info_list=[]):
 
 
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))
 
 
183
            raise BzrCommandError('You must supply a revision identifier')
 
 
185
        b = WorkingTree.open_containing(u'.')[0].branch
 
 
188
            revinfo = rev.in_history(b)
 
 
189
            if revinfo.revno is None:
 
 
190
                print '     %s' % revinfo.rev_id
 
 
192
                print '%4d %s' % (revinfo.revno, revinfo.rev_id)
 
 
195
class cmd_add(Command):
 
 
196
    """Add specified files or directories.
 
 
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.
 
 
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.
 
 
210
    Therefore simply saying 'bzr add' will version all files that
 
 
211
    are currently unknown.
 
 
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.
 
 
218
    --dry-run will show which files would be added, but not actually 
 
 
221
    takes_args = ['file*']
 
 
222
    takes_options = ['no-recurse', 'dry-run', 'verbose']
 
 
224
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False):
 
 
229
                # This is pointless, but I'd rather not raise an error
 
 
230
                action = bzrlib.add.add_action_null
 
 
232
                action = bzrlib.add.add_action_print
 
 
234
            action = bzrlib.add.add_action_add
 
 
236
            action = bzrlib.add.add_action_add_and_print
 
 
238
        added, ignored = bzrlib.add.smart_add(file_list, not no_recurse, 
 
 
241
            for glob in sorted(ignored.keys()):
 
 
242
                match_len = len(ignored[glob])
 
 
244
                    for path in ignored[glob]:
 
 
245
                        print "ignored %s matching \"%s\"" % (path, glob)
 
 
247
                    print "ignored %d file(s) matching \"%s\"" % (match_len,
 
 
249
            print "If you wish to add some of these files, please add them"\
 
 
253
class cmd_mkdir(Command):
 
 
254
    """Create a new versioned directory.
 
 
256
    This is equivalent to creating the directory and then adding it.
 
 
258
    takes_args = ['dir+']
 
 
260
    def run(self, dir_list):
 
 
263
            wt, dd = WorkingTree.open_containing(d)
 
 
268
class cmd_relpath(Command):
 
 
269
    """Show path of a file relative to root"""
 
 
270
    takes_args = ['filename']
 
 
274
    def run(self, filename):
 
 
275
        tree, relpath = WorkingTree.open_containing(filename)
 
 
279
class cmd_inventory(Command):
 
 
280
    """Show inventory of the current working copy or a revision.
 
 
282
    It is possible to limit the output to a particular entry
 
 
283
    type using the --kind option.  For example; --kind file.
 
 
285
    takes_options = ['revision', 'show-ids', 'kind']
 
 
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]
 
 
293
            inv = tree.read_working_inventory()
 
 
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)
 
 
301
        for path, entry in inv.entries():
 
 
302
            if kind and kind != entry.kind:
 
 
305
                print '%-50s %s' % (path, entry.file_id)
 
 
310
class cmd_move(Command):
 
 
311
    """Move files to a different directory.
 
 
316
    The destination must be a versioned directory in the same branch.
 
 
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))
 
 
325
class cmd_rename(Command):
 
 
326
    """Change the name of an entry.
 
 
329
      bzr rename frob.c frobber.c
 
 
330
      bzr rename src/frob.c lib/frob.c
 
 
332
    It is an error if the destination name exists.
 
 
334
    See also the 'move' command, which moves files into a different
 
 
335
    directory without changing their name.
 
 
337
    # TODO: Some way to rename multiple files without invoking 
 
 
338
    # bzr for each one?"""
 
 
339
    takes_args = ['from_name', 'to_name']
 
 
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)
 
 
346
class cmd_mv(Command):
 
 
347
    """Move or rename a file.
 
 
350
        bzr mv OLDNAME NEWNAME
 
 
351
        bzr mv SOURCE... DESTINATION
 
 
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.
 
 
357
    Files cannot be moved between branches.
 
 
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)
 
 
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
 
 
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])
 
 
377
class cmd_pull(Command):
 
 
378
    """Pull any changes from another branch into the current one.
 
 
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.
 
 
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.
 
 
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.
 
 
392
    If you want to forget your local changes and just update your branch to
 
 
393
    match the remote one, use --overwrite.
 
 
395
    takes_options = ['remember', 'overwrite', 'verbose']
 
 
396
    takes_args = ['location?']
 
 
398
    def run(self, location=None, remember=False, overwrite=False, verbose=False):
 
 
399
        from shutil import rmtree
 
 
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()
 
 
405
            if stored_loc is None:
 
 
406
                raise BzrCommandError("No pull location known or specified.")
 
 
408
                print "Using saved location: %s" % stored_loc
 
 
409
                location = stored_loc
 
 
411
        br_from = Branch.open(location)
 
 
412
        br_to = tree_to.branch
 
 
414
        old_rh = br_to.revision_history()
 
 
415
        count = tree_to.pull(br_from, overwrite)
 
 
417
        if br_to.get_parent() is None or remember:
 
 
418
            br_to.set_parent(location)
 
 
419
        note('%d revision(s) pulled.' % (count,))
 
 
422
            new_rh = tree_to.branch.revision_history()
 
 
425
                from bzrlib.log import show_changed_revisions
 
 
426
                show_changed_revisions(tree_to.branch, old_rh, new_rh)
 
 
429
class cmd_push(Command):
 
 
430
    """Push this branch into another branch.
 
 
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.
 
 
435
    Some smart servers or protocols *may* put the working tree in place.
 
 
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.
 
 
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
 
 
445
    If branches have diverged, you can use 'bzr push --overwrite' to replace
 
 
446
    the other branch completely.
 
 
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'.
 
 
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?']
 
 
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
 
 
463
        from shutil import rmtree
 
 
464
        from bzrlib.transport import get_transport
 
 
466
        tree_from = WorkingTree.open_containing(u'.')[0]
 
 
467
        br_from = tree_from.branch
 
 
468
        stored_loc = tree_from.branch.get_push_location()
 
 
470
            if stored_loc is None:
 
 
471
                raise BzrCommandError("No push location known or specified.")
 
 
473
                print "Using saved location: %s" % stored_loc
 
 
474
                location = stored_loc
 
 
476
            br_to = Branch.open(location)
 
 
477
        except NotBranchError:
 
 
479
            transport = get_transport(location).clone('..')
 
 
480
            if not create_prefix:
 
 
482
                    transport.mkdir(transport.relpath(location))
 
 
484
                    raise BzrCommandError("Parent directory of %s "
 
 
485
                                          "does not exist." % location)
 
 
487
                current = transport.base
 
 
488
                needed = [(transport, transport.relpath(location))]
 
 
491
                        transport, relpath = needed[-1]
 
 
492
                        transport.mkdir(relpath)
 
 
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 "
 
 
501
            if isinstance(transport, LocalTransport):
 
 
502
                br_to = WorkingTree.create_standalone(location).branch
 
 
504
                br_to = Branch.create(location)
 
 
505
        old_rh = br_to.revision_history()
 
 
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 
 
 
513
                warning('Unable to update the working tree of: %s' % (br_to.base,))
 
 
514
                count = br_to.pull(br_from, overwrite)
 
 
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,))
 
 
525
            new_rh = br_to.revision_history()
 
 
528
                from bzrlib.log import show_changed_revisions
 
 
529
                show_changed_revisions(br_to, old_rh, new_rh)
 
 
532
class cmd_branch(Command):
 
 
533
    """Create a new copy of a branch.
 
 
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.
 
 
538
    To retrieve the branch as of a particular revision, supply the --revision
 
 
539
    parameter, as in "branch foo/bar -r 5".
 
 
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.
 
 
545
    takes_args = ['from_location', 'to_location?']
 
 
546
    takes_options = ['revision', 'basis']
 
 
547
    aliases = ['get', 'clone']
 
 
549
    def run(self, from_location, to_location=None, revision=None, basis=None):
 
 
551
        from shutil import rmtree
 
 
554
        elif len(revision) > 1:
 
 
555
            raise BzrCommandError(
 
 
556
                'bzr branch --revision takes exactly 1 revision value')
 
 
558
            br_from = Branch.open(from_location)
 
 
560
            if e.errno == errno.ENOENT:
 
 
561
                raise BzrCommandError('Source location "%s" does not'
 
 
562
                                      ' exist.' % to_location)
 
 
567
            if basis is not None:
 
 
568
                basis_branch = WorkingTree.open_containing(basis)[0].branch
 
 
571
            if len(revision) == 1 and revision[0] is not None:
 
 
572
                revision_id = revision[0].in_history(br_from)[1]
 
 
575
            if to_location is None:
 
 
576
                to_location = os.path.basename(from_location.rstrip("/\\"))
 
 
579
                name = os.path.basename(to_location) + '\n'
 
 
581
                os.mkdir(to_location)
 
 
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.' %
 
 
592
                br_from.clone(to_location, revision_id, basis_branch)
 
 
593
            except bzrlib.errors.NoSuchRevision:
 
 
595
                msg = "The branch %s has no revision %s." % (from_location, revision[0])
 
 
596
                raise BzrCommandError(msg)
 
 
597
            except bzrlib.errors.UnlistableBranch:
 
 
599
                msg = "The branch %s cannot be used as a --basis"
 
 
600
                raise BzrCommandError(msg)
 
 
601
            branch = Branch.open(to_location)
 
 
603
                branch.control_files.put_utf8('branch-name', name)
 
 
605
            note('Branched %d revision(s).' % branch.revno())
 
 
610
class cmd_renames(Command):
 
 
611
    """Show list of renamed files.
 
 
613
    # TODO: Option to show renames between two historical versions.
 
 
615
    # TODO: Only show renames under dir, rather than in the whole branch.
 
 
616
    takes_args = ['dir?']
 
 
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()
 
 
624
        renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
 
 
626
        for old_name, new_name in renames:
 
 
627
            print "%s => %s" % (old_name, new_name)        
 
 
630
class cmd_info(Command):
 
 
631
    """Show statistical information about a branch."""
 
 
632
    takes_args = ['branch?']
 
 
635
    def run(self, branch=None):
 
 
637
        b = WorkingTree.open_containing(branch)[0].branch
 
 
641
class cmd_remove(Command):
 
 
642
    """Make a file unversioned.
 
 
644
    This makes bzr stop tracking changes to a versioned file.  It does
 
 
645
    not delete the working copy.
 
 
647
    takes_args = ['file+']
 
 
648
    takes_options = ['verbose']
 
 
651
    def run(self, file_list, verbose=False):
 
 
652
        tree, file_list = tree_files(file_list)
 
 
653
        tree.remove(file_list, verbose=verbose)
 
 
656
class cmd_file_id(Command):
 
 
657
    """Print file_id of a particular file or directory.
 
 
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
 
 
664
    takes_args = ['filename']
 
 
666
    def run(self, filename):
 
 
667
        tree, relpath = WorkingTree.open_containing(filename)
 
 
668
        i = tree.inventory.path2id(relpath)
 
 
670
            raise BzrError("%r is not a versioned file" % filename)
 
 
675
class cmd_file_path(Command):
 
 
676
    """Print path of file_ids to a file or directory.
 
 
678
    This prints one line for each directory down to the target,
 
 
679
    starting at the branch root."""
 
 
681
    takes_args = ['filename']
 
 
683
    def run(self, filename):
 
 
684
        tree, relpath = WorkingTree.open_containing(filename)
 
 
686
        fid = inv.path2id(relpath)
 
 
688
            raise BzrError("%r is not a versioned file" % filename)
 
 
689
        for fip in inv.get_idpath(fid):
 
 
693
class cmd_revision_history(Command):
 
 
694
    """Display list of revision ids on this branch."""
 
 
698
        branch = WorkingTree.open_containing(u'.')[0].branch
 
 
699
        for patchid in branch.revision_history():
 
 
703
class cmd_ancestry(Command):
 
 
704
    """List all revisions merged into this branch."""
 
 
708
        tree = WorkingTree.open_containing(u'.')[0]
 
 
710
        # FIXME. should be tree.last_revision
 
 
711
        for revision_id in b.get_ancestry(b.last_revision()):
 
 
715
class cmd_init(Command):
 
 
716
    """Make a directory into a versioned branch.
 
 
718
    Use this to create an empty branch, or before importing an
 
 
721
    Recipe for importing a tree of files:
 
 
726
        bzr commit -m 'imported project'
 
 
728
    takes_args = ['location?']
 
 
729
    def run(self, location=None):
 
 
730
        from bzrlib.branch import Branch
 
 
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):
 
 
741
        WorkingTree.create_standalone(location)
 
 
744
class cmd_diff(Command):
 
 
745
    """Show differences in working tree.
 
 
747
    If files are listed, only the changes in those files are listed.
 
 
748
    Otherwise, all changes for the tree are listed.
 
 
755
    # TODO: Allow diff across branches.
 
 
756
    # TODO: Option to use external diff command; could be GNU diff, wdiff,
 
 
757
    #       or a graphical diff.
 
 
759
    # TODO: Python difflib is not exactly the same as unidiff; should
 
 
760
    #       either fix it up or prefer to use an external diff.
 
 
762
    # TODO: If a directory is given, diff everything under that.
 
 
764
    # TODO: Selected-file diff is inefficient and doesn't show you
 
 
767
    # TODO: This probably handles non-Unix newlines poorly.
 
 
769
    takes_args = ['file*']
 
 
770
    takes_options = ['revision', 'diff-options']
 
 
771
    aliases = ['di', 'dif']
 
 
774
    def run(self, revision=None, file_list=None, diff_options=None):
 
 
775
        from bzrlib.diff import show_diff
 
 
777
            tree, file_list = internal_tree_files(file_list)
 
 
780
        except FileInWrongBranch:
 
 
781
            if len(file_list) != 2:
 
 
782
                raise BzrCommandError("Files are in different branches")
 
 
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")
 
 
790
        if revision 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])
 
 
801
                raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
 
 
804
                return show_diff(b, None, specific_files=file_list,
 
 
805
                                 external_diff_options=diff_options, b2=b2)
 
 
807
                return show_diff(tree.branch, None, specific_files=file_list,
 
 
808
                                 external_diff_options=diff_options)
 
 
811
class cmd_deleted(Command):
 
 
812
    """List files deleted in the working tree.
 
 
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...)
 
 
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):
 
 
827
                    print '%-50s %s' % (path, ie.file_id)
 
 
832
class cmd_modified(Command):
 
 
833
    """List files modified in working tree."""
 
 
837
        from bzrlib.delta import compare_trees
 
 
839
        tree = WorkingTree.open_containing(u'.')[0]
 
 
840
        td = compare_trees(tree.branch.basis_tree(), tree)
 
 
842
        for path, id, kind, text_modified, meta_modified in td.modified:
 
 
847
class cmd_added(Command):
 
 
848
    """List files added in working tree."""
 
 
852
        wt = WorkingTree.open_containing(u'.')[0]
 
 
853
        basis_inv = wt.branch.basis_tree().inventory
 
 
856
            if file_id in basis_inv:
 
 
858
            path = inv.id2path(file_id)
 
 
859
            if not os.access(bzrlib.osutils.abspath(path), os.F_OK):
 
 
865
class cmd_root(Command):
 
 
866
    """Show the tree root directory.
 
 
868
    The root is the nearest enclosing directory with a .bzr control
 
 
870
    takes_args = ['filename?']
 
 
872
    def run(self, filename=None):
 
 
873
        """Print the branch root."""
 
 
874
        tree = WorkingTree.open_containing(filename)[0]
 
 
878
class cmd_log(Command):
 
 
879
    """Show log of this branch.
 
 
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
 
 
886
    # TODO: Make --revision support uuid: and hash: [future tag:] notation.
 
 
888
    takes_args = ['filename?']
 
 
889
    takes_options = [Option('forward', 
 
 
890
                            help='show from oldest to newest'),
 
 
891
                     'timezone', 'verbose', 
 
 
892
                     'show-ids', 'revision',
 
 
895
                            help='show revisions whose message matches this regexp',
 
 
900
    def run(self, filename=None, timezone='original',
 
 
909
        from bzrlib.log import log_formatter, show_log
 
 
911
        assert message is None or isinstance(message, basestring), \
 
 
912
            "invalid message argument %r" % message
 
 
913
        direction = (forward and 'forward') or 'reverse'
 
 
919
                tree, fp = WorkingTree.open_containing(filename)
 
 
922
                    inv = tree.read_working_inventory()
 
 
923
            except NotBranchError:
 
 
926
                b, fp = Branch.open_containing(filename)
 
 
928
                    inv = b.repository.get_inventory(b.last_revision())
 
 
930
                file_id = inv.path2id(fp)
 
 
932
                file_id = None  # points to branch root
 
 
934
            tree, relpath = WorkingTree.open_containing(u'.')
 
 
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
 
 
947
            raise BzrCommandError('bzr log --revision takes one or two values.')
 
 
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
 
 
953
            (rev2, rev1) = (rev1, rev2)
 
 
955
        mutter('encoding log as %r', bzrlib.user_encoding)
 
 
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')
 
 
961
        log_format = get_log_format(long=long, short=short, line=line)
 
 
962
        lf = log_formatter(log_format,
 
 
965
                           show_timezone=timezone)
 
 
976
def get_log_format(long=False, short=False, line=False, default='long'):
 
 
987
class cmd_touching_revisions(Command):
 
 
988
    """Return revision-ids which affected a particular file.
 
 
990
    A more user-friendly interface is "bzr log FILE"."""
 
 
992
    takes_args = ["filename"]
 
 
994
    def run(self, filename):
 
 
995
        tree, relpath = WorkingTree.open_containing(filename)
 
 
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)
 
 
1003
class cmd_ls(Command):
 
 
1004
    """List files in a tree.
 
 
1006
    # TODO: Take a revision or remote path and list that tree instead.
 
 
1008
    takes_options = ['verbose', 'revision',
 
 
1009
                     Option('non-recursive',
 
 
1010
                            help='don\'t recurse into sub-directories'),
 
 
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'),
 
 
1017
                     Option('null', help='Null separate the files'),
 
 
1020
    def run(self, revision=None, verbose=False, 
 
 
1021
            non_recursive=False, from_root=False,
 
 
1022
            unknown=False, versioned=False, ignored=False,
 
 
1025
        if verbose and null:
 
 
1026
            raise BzrCommandError('Cannot set both --verbose and --null')
 
 
1027
        all = not (unknown or versioned or ignored)
 
 
1029
        selection = {'I':ignored, '?':unknown, 'V':versioned}
 
 
1031
        tree, relpath = WorkingTree.open_containing(u'.')
 
 
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:
 
 
1044
                if not all and not selection[fc]:
 
 
1047
                    kindch = entry.kind_character()
 
 
1048
                    print '%-8s %s%s' % (fc, fp, kindch)
 
 
1050
                    sys.stdout.write(fp)
 
 
1051
                    sys.stdout.write('\0')
 
 
1057
class cmd_unknowns(Command):
 
 
1058
    """List unknown files."""
 
 
1061
        from bzrlib.osutils import quotefn
 
 
1062
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
 
 
1066
class cmd_ignore(Command):
 
 
1067
    """Ignore a command or pattern.
 
 
1069
    To remove patterns from the ignore list, edit the .bzrignore file.
 
 
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,
 
 
1076
    Ignore patterns are case-insensitive on case-insensitive systems.
 
 
1078
    Note: wildcards must be quoted from the shell on Unix.
 
 
1081
        bzr ignore ./Makefile
 
 
1082
        bzr ignore '*.class'
 
 
1084
    # TODO: Complain if the filename is absolute
 
 
1085
    takes_args = ['name_pattern']
 
 
1087
    def run(self, name_pattern):
 
 
1088
        from bzrlib.atomicfile import AtomicFile
 
 
1091
        tree, relpath = WorkingTree.open_containing(u'.')
 
 
1092
        ifn = tree.abspath('.bzrignore')
 
 
1094
        if os.path.exists(ifn):
 
 
1097
                igns = f.read().decode('utf-8')
 
 
1103
        # TODO: If the file already uses crlf-style termination, maybe
 
 
1104
        # we should use that for the newly added lines?
 
 
1106
        if igns and igns[-1] != '\n':
 
 
1108
        igns += name_pattern + '\n'
 
 
1111
            f = AtomicFile(ifn, 'wt')
 
 
1112
            f.write(igns.encode('utf-8'))
 
 
1117
        inv = tree.inventory
 
 
1118
        if inv.path2id('.bzrignore'):
 
 
1119
            mutter('.bzrignore is already versioned')
 
 
1121
            mutter('need to make new .bzrignore file versioned')
 
 
1122
            tree.add(['.bzrignore'])
 
 
1125
class cmd_ignored(Command):
 
 
1126
    """List ignored files and the patterns that matched them.
 
 
1128
    See also: bzr ignore"""
 
 
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':
 
 
1135
            ## XXX: Slightly inefficient since this was already calculated
 
 
1136
            pat = tree.is_ignored(path)
 
 
1137
            print '%-50s %s' % (path, pat)
 
 
1140
class cmd_lookup_revision(Command):
 
 
1141
    """Lookup the revision-id from a revision-number
 
 
1144
        bzr lookup-revision 33
 
 
1147
    takes_args = ['revno']
 
 
1150
    def run(self, revno):
 
 
1154
            raise BzrCommandError("not a valid revision-number: %r" % revno)
 
 
1156
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
 
1159
class cmd_export(Command):
 
 
1160
    """Export past revision to destination directory.
 
 
1162
    If no revision is specified this exports the last committed revision.
 
 
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).
 
 
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.
 
 
1171
    Note: export of tree with non-ascii filenames to zip is not supported.
 
 
1173
    Supported formats       Autodetected by extension
 
 
1174
    -----------------       -------------------------
 
 
1177
         tbz2                    .tar.bz2, .tbz2
 
 
1181
    takes_args = ['dest']
 
 
1182
    takes_options = ['revision', 'format', 'root']
 
 
1183
    def run(self, dest, revision=None, format=None, root=None):
 
 
1185
        from bzrlib.export import export
 
 
1186
        tree = WorkingTree.open_containing(u'.')[0]
 
 
1188
        if revision is None:
 
 
1189
            # should be tree.last_revision  FIXME
 
 
1190
            rev_id = b.last_revision()
 
 
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)
 
 
1197
            export(t, dest, format, root)
 
 
1198
        except errors.NoSuchExportFormat, e:
 
 
1199
            raise BzrCommandError('Unsupported export format: %s' % e.format)
 
 
1202
class cmd_cat(Command):
 
 
1203
    """Write a file's text from a previous revision."""
 
 
1205
    takes_options = ['revision']
 
 
1206
    takes_args = ['filename']
 
 
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")
 
 
1214
            tree, relpath = WorkingTree.open_containing(filename)
 
 
1216
        except NotBranchError:
 
 
1220
            b, relpath = Branch.open_containing(filename)
 
 
1221
        if revision is None:
 
 
1222
            revision_id = b.last_revision()
 
 
1224
            revision_id = revision[0].in_history(b).rev_id
 
 
1225
        b.print_file(relpath, revision_id)
 
 
1228
class cmd_local_time_offset(Command):
 
 
1229
    """Show the offset in seconds from GMT to local time."""
 
 
1233
        print bzrlib.osutils.local_time_offset()
 
 
1237
class cmd_commit(Command):
 
 
1238
    """Commit changes into a new revision.
 
 
1240
    If no arguments are given, the entire tree is committed.
 
 
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.
 
 
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.
 
 
1250
    # TODO: Run hooks on tree to-be-committed, and after commit.
 
 
1252
    # TODO: Strict commit that fails if there are deleted files.
 
 
1253
    #       (what does "deleted files" mean ??)
 
 
1255
    # TODO: Give better message for -s, --summary, used by tla people
 
 
1257
    # XXX: verbose currently does nothing
 
 
1259
    takes_args = ['selected*']
 
 
1260
    takes_options = ['message', 'verbose', 
 
 
1262
                            help='commit even if nothing has changed'),
 
 
1263
                     Option('file', type=str, 
 
 
1265
                            help='file containing commit message'),
 
 
1267
                            help="refuse to commit if there are unknown "
 
 
1268
                            "files in the working tree."),
 
 
1270
    aliases = ['ci', 'checkin']
 
 
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,
 
 
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
 
 
1282
        # TODO: Need a blackbox test for invoking the external editor; may be
 
 
1283
        # slightly problematic to run this cross-platform.
 
 
1285
        # TODO: do more checks that the commit will succeed before 
 
 
1286
        # spending the user's valuable time typing a commit message.
 
 
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)
 
 
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")
 
 
1302
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
 
 
1305
                raise BzrCommandError("empty commit message specified")
 
 
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(),))
 
 
1324
class cmd_check(Command):
 
 
1325
    """Validate consistency of branch history.
 
 
1327
    This command checks various invariants about the branch storage to
 
 
1328
    detect data corruption or bzr bugs.
 
 
1330
    takes_args = ['branch?']
 
 
1331
    takes_options = ['verbose']
 
 
1333
    def run(self, branch=None, verbose=False):
 
 
1334
        from bzrlib.check import check
 
 
1336
            tree = WorkingTree.open_containing()[0]
 
 
1337
            branch = tree.branch
 
 
1339
            branch = Branch.open(branch)
 
 
1340
        check(branch, verbose)
 
 
1343
class cmd_scan_cache(Command):
 
 
1346
        from bzrlib.hashcache import HashCache
 
 
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
 
 
1363
class cmd_upgrade(Command):
 
 
1364
    """Upgrade branch storage to current format.
 
 
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.
 
 
1370
    takes_args = ['url?']
 
 
1372
    def run(self, url='.'):
 
 
1373
        from bzrlib.upgrade import upgrade
 
 
1377
class cmd_whoami(Command):
 
 
1378
    """Show bzr user id."""
 
 
1379
    takes_options = ['email']
 
 
1382
    def run(self, email=False):
 
 
1384
            b = WorkingTree.open_containing(u'.')[0].branch
 
 
1385
            config = bzrlib.config.BranchConfig(b)
 
 
1386
        except NotBranchError:
 
 
1387
            config = bzrlib.config.GlobalConfig()
 
 
1390
            print config.user_email()
 
 
1392
            print config.username()
 
 
1395
class cmd_nick(Command):
 
 
1397
    Print or set the branch nickname.  
 
 
1398
    If unset, the tree root directory name is used as the nickname
 
 
1399
    To print the current nickname, execute with no argument.  
 
 
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)
 
 
1407
            branch.nick = nickname
 
 
1410
    def printme(self, branch):
 
 
1414
class cmd_selftest(Command):
 
 
1415
    """Run internal test suite.
 
 
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.
 
 
1422
    If arguments are given, they are regular expressions that say
 
 
1423
    which tests should run.
 
 
1425
    # TODO: --list should give a list of all available tests
 
 
1427
    # NB: this is used from the class without creating an instance, which is
 
 
1428
    # why it does not have a self parameter.
 
 
1429
    def get_transport_type(typestring):
 
 
1430
        """Parse and return a transport specifier."""
 
 
1431
        if typestring == "sftp":
 
 
1432
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
 
1433
            return SFTPAbsoluteServer
 
 
1434
        if typestring == "memory":
 
 
1435
            from bzrlib.transport.memory import MemoryServer
 
 
1437
        msg = "No known transport type %s. Supported types are: sftp\n" %\
 
 
1439
        raise BzrCommandError(msg)
 
 
1442
    takes_args = ['testspecs*']
 
 
1443
    takes_options = ['verbose', 
 
 
1444
                     Option('one', help='stop when one test fails'),
 
 
1445
                     Option('keep-output', 
 
 
1446
                            help='keep output directories when tests fail'),
 
 
1448
                            help='Use a different transport by default '
 
 
1449
                                 'throughout the test suite.',
 
 
1450
                            type=get_transport_type),
 
 
1453
    def run(self, testspecs_list=None, verbose=False, one=False,
 
 
1454
            keep_output=False, transport=None):
 
 
1456
        from bzrlib.tests import selftest
 
 
1457
        # we don't want progress meters from the tests to go to the
 
 
1458
        # real output; and we don't want log messages cluttering up
 
 
1460
        save_ui = bzrlib.ui.ui_factory
 
 
1461
        bzrlib.trace.info('running tests...')
 
 
1463
            bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
 
 
1464
            if testspecs_list is not None:
 
 
1465
                pattern = '|'.join(testspecs_list)
 
 
1468
            result = selftest(verbose=verbose, 
 
 
1470
                              stop_on_failure=one, 
 
 
1471
                              keep_output=keep_output,
 
 
1472
                              transport=transport)
 
 
1474
                bzrlib.trace.info('tests passed')
 
 
1476
                bzrlib.trace.info('tests failed')
 
 
1477
            return int(not result)
 
 
1479
            bzrlib.ui.ui_factory = save_ui
 
 
1482
def _get_bzr_branch():
 
 
1483
    """If bzr is run from a branch, return Branch or None"""
 
 
1484
    import bzrlib.errors
 
 
1485
    from bzrlib.branch import Branch
 
 
1486
    from bzrlib.osutils import abspath
 
 
1487
    from os.path import dirname
 
 
1490
        branch = Branch.open(dirname(abspath(dirname(__file__))))
 
 
1492
    except bzrlib.errors.BzrError:
 
 
1497
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
 
 
1498
    # is bzrlib itself in a branch?
 
 
1499
    branch = _get_bzr_branch()
 
 
1501
        rh = branch.revision_history()
 
 
1503
        print "  bzr checkout, revision %d" % (revno,)
 
 
1504
        print "  nick: %s" % (branch.nick,)
 
 
1506
            print "  revid: %s" % (rh[-1],)
 
 
1507
    print bzrlib.__copyright__
 
 
1508
    print "http://bazaar-ng.org/"
 
 
1510
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
 
 
1511
    print "you may use, modify and redistribute it under the terms of the GNU"
 
 
1512
    print "General Public License version 2 or later."
 
 
1515
class cmd_version(Command):
 
 
1516
    """Show version of bzr."""
 
 
1521
class cmd_rocks(Command):
 
 
1522
    """Statement of optimism."""
 
 
1526
        print "it sure does!"
 
 
1529
class cmd_find_merge_base(Command):
 
 
1530
    """Find and print a base revision for merging two branches.
 
 
1532
    # TODO: Options to specify revisions on either side, as if
 
 
1533
    #       merging only part of the history.
 
 
1534
    takes_args = ['branch', 'other']
 
 
1538
    def run(self, branch, other):
 
 
1539
        from bzrlib.revision import common_ancestor, MultipleRevisionSources
 
 
1541
        branch1 = Branch.open_containing(branch)[0]
 
 
1542
        branch2 = Branch.open_containing(other)[0]
 
 
1544
        history_1 = branch1.revision_history()
 
 
1545
        history_2 = branch2.revision_history()
 
 
1547
        last1 = branch1.last_revision()
 
 
1548
        last2 = branch2.last_revision()
 
 
1550
        source = MultipleRevisionSources(branch1, branch2)
 
 
1552
        base_rev_id = common_ancestor(last1, last2, source)
 
 
1554
        print 'merge base is revision %s' % base_rev_id
 
 
1558
        if base_revno is None:
 
 
1559
            raise bzrlib.errors.UnrelatedBranches()
 
 
1561
        print ' r%-6d in %s' % (base_revno, branch)
 
 
1563
        other_revno = branch2.revision_id_to_revno(base_revid)
 
 
1565
        print ' r%-6d in %s' % (other_revno, other)
 
 
1569
class cmd_merge(Command):
 
 
1570
    """Perform a three-way merge.
 
 
1572
    The branch is the branch you will merge from.  By default, it will
 
 
1573
    merge the latest revision.  If you specify a revision, that
 
 
1574
    revision will be merged.  If you specify two revisions, the first
 
 
1575
    will be used as a BASE, and the second one as OTHER.  Revision
 
 
1576
    numbers are always relative to the specified branch.
 
 
1578
    By default bzr will try to merge in all new work from the other
 
 
1579
    branch, automatically determining an appropriate base.  If this
 
 
1580
    fails, you may need to give an explicit base.
 
 
1584
    To merge the latest revision from bzr.dev
 
 
1585
    bzr merge ../bzr.dev
 
 
1587
    To merge changes up to and including revision 82 from bzr.dev
 
 
1588
    bzr merge -r 82 ../bzr.dev
 
 
1590
    To merge the changes introduced by 82, without previous changes:
 
 
1591
    bzr merge -r 81..82 ../bzr.dev
 
 
1593
    merge refuses to run if there are any uncommitted changes, unless
 
 
1596
    takes_args = ['branch?']
 
 
1597
    takes_options = ['revision', 'force', 'merge-type', 'reprocess',
 
 
1598
                     Option('show-base', help="Show base revision text in "
 
 
1601
    def run(self, branch=None, revision=None, force=False, merge_type=None,
 
 
1602
            show_base=False, reprocess=False):
 
 
1603
        from bzrlib._merge_core import ApplyMerge3
 
 
1604
        if merge_type is None:
 
 
1605
            merge_type = ApplyMerge3
 
 
1607
            branch = WorkingTree.open_containing(u'.')[0].branch.get_parent()
 
 
1609
                raise BzrCommandError("No merge location known or specified.")
 
 
1611
                print "Using saved location: %s" % branch 
 
 
1612
        if revision is None or len(revision) < 1:
 
 
1614
            other = [branch, -1]
 
 
1616
            if len(revision) == 1:
 
 
1618
                other_branch = Branch.open_containing(branch)[0]
 
 
1619
                revno = revision[0].in_history(other_branch).revno
 
 
1620
                other = [branch, revno]
 
 
1622
                assert len(revision) == 2
 
 
1623
                if None in revision:
 
 
1624
                    raise BzrCommandError(
 
 
1625
                        "Merge doesn't permit that revision specifier.")
 
 
1626
                b = Branch.open_containing(branch)[0]
 
 
1628
                base = [branch, revision[0].in_history(b).revno]
 
 
1629
                other = [branch, revision[1].in_history(b).revno]
 
 
1632
            conflict_count = merge(other, base, check_clean=(not force),
 
 
1633
                                   merge_type=merge_type, reprocess=reprocess,
 
 
1634
                                   show_base=show_base)
 
 
1635
            if conflict_count != 0:
 
 
1639
        except bzrlib.errors.AmbiguousBase, e:
 
 
1640
            m = ("sorry, bzr can't determine the right merge base yet\n"
 
 
1641
                 "candidates are:\n  "
 
 
1642
                 + "\n  ".join(e.bases)
 
 
1644
                 "please specify an explicit base with -r,\n"
 
 
1645
                 "and (if you want) report this to the bzr developers\n")
 
 
1649
class cmd_remerge(Command):
 
 
1652
    takes_args = ['file*']
 
 
1653
    takes_options = ['merge-type', 'reprocess',
 
 
1654
                     Option('show-base', help="Show base revision text in "
 
 
1657
    def run(self, file_list=None, merge_type=None, show_base=False,
 
 
1659
        from bzrlib.merge import merge_inner, transform_tree
 
 
1660
        from bzrlib._merge_core import ApplyMerge3
 
 
1661
        if merge_type is None:
 
 
1662
            merge_type = ApplyMerge3
 
 
1663
        tree, file_list = tree_files(file_list)
 
 
1666
            pending_merges = tree.pending_merges() 
 
 
1667
            if len(pending_merges) != 1:
 
 
1668
                raise BzrCommandError("Sorry, remerge only works after normal"
 
 
1669
                                      + " merges.  Not cherrypicking or"
 
 
1671
            repository = tree.branch.repository
 
 
1672
            base_revision = common_ancestor(tree.branch.last_revision(), 
 
 
1673
                                            pending_merges[0], repository)
 
 
1674
            base_tree = repository.revision_tree(base_revision)
 
 
1675
            other_tree = repository.revision_tree(pending_merges[0])
 
 
1676
            interesting_ids = None
 
 
1677
            if file_list is not None:
 
 
1678
                interesting_ids = set()
 
 
1679
                for filename in file_list:
 
 
1680
                    file_id = tree.path2id(filename)
 
 
1681
                    interesting_ids.add(file_id)
 
 
1682
                    if tree.kind(file_id) != "directory":
 
 
1685
                    for name, ie in tree.inventory.iter_entries(file_id):
 
 
1686
                        interesting_ids.add(ie.file_id)
 
 
1687
            transform_tree(tree, tree.branch.basis_tree(), interesting_ids)
 
 
1688
            if file_list is None:
 
 
1689
                restore_files = list(tree.iter_conflicts())
 
 
1691
                restore_files = file_list
 
 
1692
            for filename in restore_files:
 
 
1694
                    restore(tree.abspath(filename))
 
 
1695
                except NotConflicted:
 
 
1697
            conflicts =  merge_inner(tree.branch, other_tree, base_tree, 
 
 
1698
                                     interesting_ids = interesting_ids, 
 
 
1699
                                     other_rev_id=pending_merges[0], 
 
 
1700
                                     merge_type=merge_type, 
 
 
1701
                                     show_base=show_base,
 
 
1702
                                     reprocess=reprocess)
 
 
1710
class cmd_revert(Command):
 
 
1711
    """Reverse all changes since the last commit.
 
 
1713
    Only versioned files are affected.  Specify filenames to revert only 
 
 
1714
    those files.  By default, any files that are changed will be backed up
 
 
1715
    first.  Backup files have a '~' appended to their name.
 
 
1717
    takes_options = ['revision', 'no-backup']
 
 
1718
    takes_args = ['file*']
 
 
1719
    aliases = ['merge-revert']
 
 
1721
    def run(self, revision=None, no_backup=False, file_list=None):
 
 
1722
        from bzrlib.commands import parse_spec
 
 
1723
        if file_list is not None:
 
 
1724
            if len(file_list) == 0:
 
 
1725
                raise BzrCommandError("No files specified")
 
 
1729
        tree, file_list = tree_files(file_list)
 
 
1730
        if revision is None:
 
 
1731
            # FIXME should be tree.last_revision
 
 
1732
            rev_id = tree.branch.last_revision()
 
 
1733
        elif len(revision) != 1:
 
 
1734
            raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
 
 
1736
            rev_id = revision[0].in_history(tree.branch).rev_id
 
 
1737
        tree.revert(file_list, tree.branch.repository.revision_tree(rev_id),
 
 
1741
class cmd_assert_fail(Command):
 
 
1742
    """Test reporting of assertion failures"""
 
 
1745
        assert False, "always fails"
 
 
1748
class cmd_help(Command):
 
 
1749
    """Show help on a command or other topic.
 
 
1751
    For a list of all available commands, say 'bzr help commands'."""
 
 
1752
    takes_options = ['long']
 
 
1753
    takes_args = ['topic?']
 
 
1757
    def run(self, topic=None, long=False):
 
 
1759
        if topic is None and long:
 
 
1764
class cmd_shell_complete(Command):
 
 
1765
    """Show appropriate completions for context.
 
 
1767
    For a list of all available commands, say 'bzr shell-complete'."""
 
 
1768
    takes_args = ['context?']
 
 
1773
    def run(self, context=None):
 
 
1774
        import shellcomplete
 
 
1775
        shellcomplete.shellcomplete(context)
 
 
1778
class cmd_fetch(Command):
 
 
1779
    """Copy in history from another branch but don't merge it.
 
 
1781
    This is an internal method used for pull and merge."""
 
 
1783
    takes_args = ['from_branch', 'to_branch']
 
 
1784
    def run(self, from_branch, to_branch):
 
 
1785
        from bzrlib.fetch import Fetcher
 
 
1786
        from bzrlib.branch import Branch
 
 
1787
        from_b = Branch.open(from_branch)
 
 
1788
        to_b = Branch.open(to_branch)
 
 
1789
        Fetcher(to_b, from_b)
 
 
1792
class cmd_missing(Command):
 
 
1793
    """Show unmerged/unpulled revisions between two branches.
 
 
1795
    OTHER_BRANCH may be local or remote."""
 
 
1796
    takes_args = ['other_branch?']
 
 
1797
    takes_options = [Option('reverse', 'Reverse the order of revisions'),
 
 
1799
                            'Display changes in the local branch only'),
 
 
1800
                     Option('theirs-only', 
 
 
1801
                            'Display changes in the remote branch only'), 
 
 
1809
    def run(self, other_branch=None, reverse=False, mine_only=False,
 
 
1810
            theirs_only=False, long=True, short=False, line=False, 
 
 
1811
            show_ids=False, verbose=False):
 
 
1812
        from bzrlib.missing import find_unmerged, iter_log_data
 
 
1813
        from bzrlib.log import log_formatter
 
 
1814
        local_branch = bzrlib.branch.Branch.open_containing(u".")[0]
 
 
1815
        parent = local_branch.get_parent()
 
 
1816
        if other_branch is None:
 
 
1817
            other_branch = parent
 
 
1818
            if other_branch is None:
 
 
1819
                raise BzrCommandError("No missing location known or specified.")
 
 
1820
            print "Using last location: " + local_branch.get_parent()
 
 
1821
        remote_branch = bzrlib.branch.Branch.open(other_branch)
 
 
1822
        local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
 
 
1823
        log_format = get_log_format(long=long, short=short, line=line)
 
 
1824
        lf = log_formatter(log_format, sys.stdout,
 
 
1826
                           show_timezone='original')
 
 
1827
        if reverse is False:
 
 
1828
            local_extra.reverse()
 
 
1829
            remote_extra.reverse()
 
 
1830
        if local_extra and not theirs_only:
 
 
1831
            print "You have %d extra revision(s):" % len(local_extra)
 
 
1832
            for data in iter_log_data(local_extra, local_branch.repository,
 
 
1835
            printed_local = True
 
 
1837
            printed_local = False
 
 
1838
        if remote_extra and not mine_only:
 
 
1839
            if printed_local is True:
 
 
1841
            print "You are missing %d revision(s):" % len(remote_extra)
 
 
1842
            for data in iter_log_data(remote_extra, remote_branch.repository, 
 
 
1845
        if not remote_extra and not local_extra:
 
 
1847
            print "Branches are up to date."
 
 
1850
        if parent is None and other_branch is not None:
 
 
1851
            local_branch.set_parent(other_branch)
 
 
1855
class cmd_plugins(Command):
 
 
1860
        import bzrlib.plugin
 
 
1861
        from inspect import getdoc
 
 
1862
        for name, plugin in bzrlib.plugin.all_plugins().items():
 
 
1863
            if hasattr(plugin, '__path__'):
 
 
1864
                print plugin.__path__[0]
 
 
1865
            elif hasattr(plugin, '__file__'):
 
 
1866
                print plugin.__file__
 
 
1872
                print '\t', d.split('\n')[0]
 
 
1875
class cmd_testament(Command):
 
 
1876
    """Show testament (signing-form) of a revision."""
 
 
1877
    takes_options = ['revision', 'long']
 
 
1878
    takes_args = ['branch?']
 
 
1880
    def run(self, branch=u'.', revision=None, long=False):
 
 
1881
        from bzrlib.testament import Testament
 
 
1882
        b = WorkingTree.open_containing(branch)[0].branch
 
 
1885
            if revision is None:
 
 
1886
                rev_id = b.last_revision()
 
 
1888
                rev_id = revision[0].in_history(b).rev_id
 
 
1889
            t = Testament.from_revision(b.repository, rev_id)
 
 
1891
                sys.stdout.writelines(t.as_text_lines())
 
 
1893
                sys.stdout.write(t.as_short_text())
 
 
1898
class cmd_annotate(Command):
 
 
1899
    """Show the origin of each line in a file.
 
 
1901
    This prints out the given file with an annotation on the left side
 
 
1902
    indicating which revision, author and date introduced the change.
 
 
1904
    If the origin is the same for a run of consecutive lines, it is 
 
 
1905
    shown only at the top, unless the --all option is given.
 
 
1907
    # TODO: annotate directories; showing when each file was last changed
 
 
1908
    # TODO: annotate a previous version of a file
 
 
1909
    # TODO: if the working copy is modified, show annotations on that 
 
 
1910
    #       with new uncommitted lines marked
 
 
1911
    aliases = ['blame', 'praise']
 
 
1912
    takes_args = ['filename']
 
 
1913
    takes_options = [Option('all', help='show annotations on all lines'),
 
 
1914
                     Option('long', help='show date in annotations'),
 
 
1918
    def run(self, filename, all=False, long=False):
 
 
1919
        from bzrlib.annotate import annotate_file
 
 
1920
        tree, relpath = WorkingTree.open_containing(filename)
 
 
1921
        branch = tree.branch
 
 
1924
            file_id = tree.inventory.path2id(relpath)
 
 
1925
            tree = branch.repository.revision_tree(branch.last_revision())
 
 
1926
            file_version = tree.inventory[file_id].revision
 
 
1927
            annotate_file(branch, file_version, file_id, long, all, sys.stdout)
 
 
1932
class cmd_re_sign(Command):
 
 
1933
    """Create a digital signature for an existing revision."""
 
 
1934
    # TODO be able to replace existing ones.
 
 
1936
    hidden = True # is this right ?
 
 
1937
    takes_args = ['revision_id?']
 
 
1938
    takes_options = ['revision']
 
 
1940
    def run(self, revision_id=None, revision=None):
 
 
1941
        import bzrlib.config as config
 
 
1942
        import bzrlib.gpg as gpg
 
 
1943
        if revision_id is not None and revision is not None:
 
 
1944
            raise BzrCommandError('You can only supply one of revision_id or --revision')
 
 
1945
        if revision_id is None and revision is None:
 
 
1946
            raise BzrCommandError('You must supply either --revision or a revision_id')
 
 
1947
        b = WorkingTree.open_containing(u'.')[0].branch
 
 
1948
        gpg_strategy = gpg.GPGStrategy(config.BranchConfig(b))
 
 
1949
        if revision_id is not None:
 
 
1950
            b.repository.sign_revision(revision_id, gpg_strategy)
 
 
1951
        elif revision is not None:
 
 
1952
            if len(revision) == 1:
 
 
1953
                revno, rev_id = revision[0].in_history(b)
 
 
1954
                b.repository.sign_revision(rev_id, gpg_strategy)
 
 
1955
            elif len(revision) == 2:
 
 
1956
                # are they both on rh- if so we can walk between them
 
 
1957
                # might be nice to have a range helper for arbitrary
 
 
1958
                # revision paths. hmm.
 
 
1959
                from_revno, from_revid = revision[0].in_history(b)
 
 
1960
                to_revno, to_revid = revision[1].in_history(b)
 
 
1961
                if to_revid is None:
 
 
1962
                    to_revno = b.revno()
 
 
1963
                if from_revno is None or to_revno is None:
 
 
1964
                    raise BzrCommandError('Cannot sign a range of non-revision-history revisions')
 
 
1965
                for revno in range(from_revno, to_revno + 1):
 
 
1966
                    b.repository.sign_revision(b.get_rev_id(revno), 
 
 
1969
                raise BzrCommandError('Please supply either one revision, or a range.')
 
 
1972
class cmd_uncommit(bzrlib.commands.Command):
 
 
1973
    """Remove the last committed revision.
 
 
1975
    By supplying the --all flag, it will not only remove the entry 
 
 
1976
    from revision_history, but also remove all of the entries in the
 
 
1979
    --verbose will print out what is being removed.
 
 
1980
    --dry-run will go through all the motions, but not actually
 
 
1983
    In the future, uncommit will create a changeset, which can then
 
 
1986
    TODO: jam 20060108 Add an option to allow uncommit to remove unreferenced
 
 
1987
              information in 'branch-as-repostory' branches.
 
 
1988
    TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
 
 
1989
              information in shared branches as well.
 
 
1991
    takes_options = ['verbose', 'revision',
 
 
1992
                    Option('dry-run', help='Don\'t actually make changes'),
 
 
1993
                    Option('force', help='Say yes to all questions.')]
 
 
1994
    takes_args = ['location?']
 
 
1997
    def run(self, location=None, 
 
 
1998
            dry_run=False, verbose=False,
 
 
1999
            revision=None, force=False):
 
 
2000
        from bzrlib.branch import Branch
 
 
2001
        from bzrlib.log import log_formatter
 
 
2003
        from bzrlib.uncommit import uncommit
 
 
2005
        if location is None:
 
 
2007
        b, relpath = Branch.open_containing(location)
 
 
2009
        if revision is None:
 
 
2011
            rev_id = b.last_revision()
 
 
2013
            revno, rev_id = revision[0].in_history(b)
 
 
2015
            print 'No revisions to uncommit.'
 
 
2017
        for r in range(revno, b.revno()+1):
 
 
2018
            rev_id = b.get_rev_id(r)
 
 
2019
            lf = log_formatter('short', to_file=sys.stdout,show_timezone='original')
 
 
2020
            lf.show(r, b.repository.get_revision(rev_id), None)
 
 
2023
            print 'Dry-run, pretending to remove the above revisions.'
 
 
2025
                val = raw_input('Press <enter> to continue')
 
 
2027
            print 'The above revision(s) will be removed.'
 
 
2029
                val = raw_input('Are you sure [y/N]? ')
 
 
2030
                if val.lower() not in ('y', 'yes'):
 
 
2034
        uncommit(b, dry_run=dry_run, verbose=verbose,
 
 
2038
def merge(other_revision, base_revision,
 
 
2039
          check_clean=True, ignore_zero=False,
 
 
2040
          this_dir=None, backup_files=False, merge_type=ApplyMerge3,
 
 
2041
          file_list=None, show_base=False, reprocess=False):
 
 
2042
    """Merge changes into a tree.
 
 
2045
        list(path, revno) Base for three-way merge.  
 
 
2046
        If [None, None] then a base will be automatically determined.
 
 
2048
        list(path, revno) Other revision for three-way merge.
 
 
2050
        Directory to merge changes into; '.' by default.
 
 
2052
        If true, this_dir must have no uncommitted changes before the
 
 
2054
    ignore_zero - If true, suppress the "zero conflicts" message when 
 
 
2055
        there are no conflicts; should be set when doing something we expect
 
 
2056
        to complete perfectly.
 
 
2057
    file_list - If supplied, merge only changes to selected files.
 
 
2059
    All available ancestors of other_revision and base_revision are
 
 
2060
    automatically pulled into the branch.
 
 
2062
    The revno may be -1 to indicate the last revision on the branch, which is
 
 
2065
    This function is intended for use from the command line; programmatic
 
 
2066
    clients might prefer to call merge.merge_inner(), which has less magic 
 
 
2069
    from bzrlib.merge import Merger, _MergeConflictHandler
 
 
2070
    if this_dir is None:
 
 
2072
    this_tree = WorkingTree.open_containing(this_dir)[0]
 
 
2073
    if show_base and not merge_type is ApplyMerge3:
 
 
2074
        raise BzrCommandError("Show-base is not supported for this merge"
 
 
2075
                              " type. %s" % merge_type)
 
 
2076
    if reprocess and not merge_type is ApplyMerge3:
 
 
2077
        raise BzrCommandError("Reprocess is not supported for this merge"
 
 
2078
                              " type. %s" % merge_type)
 
 
2079
    if reprocess and show_base:
 
 
2080
        raise BzrCommandError("Cannot reprocess and show base.")
 
 
2081
    merger = Merger(this_tree.branch, this_tree=this_tree)
 
 
2082
    merger.check_basis(check_clean)
 
 
2083
    merger.set_other(other_revision)
 
 
2084
    merger.set_base(base_revision)
 
 
2085
    if merger.base_rev_id == merger.other_rev_id:
 
 
2086
        note('Nothing to do.')
 
 
2088
    merger.backup_files = backup_files
 
 
2089
    merger.merge_type = merge_type 
 
 
2090
    merger.set_interesting_files(file_list)
 
 
2091
    merger.show_base = show_base 
 
 
2092
    merger.reprocess = reprocess
 
 
2093
    merger.conflict_handler = _MergeConflictHandler(merger.this_tree, 
 
 
2096
                                                    ignore_zero=ignore_zero)
 
 
2097
    conflicts = merger.do_merge()
 
 
2098
    merger.set_pending()
 
 
2102
# these get imported and then picked up by the scan for cmd_*
 
 
2103
# TODO: Some more consistent way to split command definitions across files;
 
 
2104
# we do need to load at least some information about them to know of 
 
 
2106
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore