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
 
 
23
from bzrlib.trace import mutter, note, log_error, warning
 
 
24
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError, NotBranchError
 
 
25
from bzrlib.branch import Branch
 
 
26
from bzrlib import BZRDIR
 
 
27
from bzrlib.commands import Command
 
 
30
class cmd_status(Command):
 
 
31
    """Display status summary.
 
 
33
    This reports on versioned and unknown files, reporting them
 
 
34
    grouped by state.  Possible states are:
 
 
37
        Versioned in the working copy but not in the previous revision.
 
 
40
        Versioned in the previous revision but removed or deleted
 
 
44
        Path of this file changed from the previous revision;
 
 
45
        the text may also have changed.  This includes files whose
 
 
46
        parent directory was renamed.
 
 
49
        Text has changed since the previous revision.
 
 
52
        Nothing about this file has changed since the previous revision.
 
 
53
        Only shown with --all.
 
 
56
        Not versioned and not matching an ignore pattern.
 
 
58
    To see ignored files use 'bzr ignored'.  For details in the
 
 
59
    changes to file texts, use 'bzr diff'.
 
 
61
    If no arguments are specified, the status of the entire working
 
 
62
    directory is shown.  Otherwise, only the status of the specified
 
 
63
    files or directories is reported.  If a directory is given, status
 
 
64
    is reported for everything inside that directory.
 
 
66
    If a revision argument is given, the status is calculated against
 
 
67
    that revision, or between two revisions if two are provided.
 
 
69
    # XXX: FIXME: bzr status should accept a -r option to show changes
 
 
70
    # relative to a revision, or between revisions
 
 
72
    takes_args = ['file*']
 
 
73
    takes_options = ['all', 'show-ids']
 
 
74
    aliases = ['st', 'stat']
 
 
76
    def run(self, all=False, show_ids=False, file_list=None, revision=None):
 
 
78
            b = Branch.open_containing(file_list[0])
 
 
79
            file_list = [b.relpath(x) for x in file_list]
 
 
80
            # special case: only one path was given and it's the root
 
 
85
            b = Branch.open_containing('.')
 
 
87
        from bzrlib.status import show_status
 
 
88
        show_status(b, show_unchanged=all, show_ids=show_ids,
 
 
89
                    specific_files=file_list, revision=revision)
 
 
92
class cmd_cat_revision(Command):
 
 
93
    """Write out metadata for a revision.
 
 
95
    The revision to print can either be specified by a specific
 
 
96
    revision identifier, or you can use --revision.
 
 
100
    takes_args = ['revision_id?']
 
 
101
    takes_options = ['revision']
 
 
103
    def run(self, revision_id=None, revision=None):
 
 
104
        from bzrlib.revisionspec import RevisionSpec
 
 
106
        if revision_id is not None and revision is not None:
 
 
107
            raise BzrCommandError('You can only supply one of revision_id or --revision')
 
 
108
        if revision_id is None and revision is None:
 
 
109
            raise BzrCommandError('You must supply either --revision or a revision_id')
 
 
110
        b = Branch.open_containing('.')
 
 
111
        if revision_id is not None:
 
 
112
            sys.stdout.write(b.get_revision_xml_file(revision_id).read())
 
 
113
        elif revision is not None:
 
 
116
                    raise BzrCommandError('You cannot specify a NULL revision.')
 
 
117
                revno, rev_id = rev.in_history(b)
 
 
118
                sys.stdout.write(b.get_revision_xml_file(rev_id).read())
 
 
121
class cmd_revno(Command):
 
 
122
    """Show current revision number.
 
 
124
    This is equal to the number of revisions on this branch."""
 
 
126
        print Branch.open_containing('.').revno()
 
 
129
class cmd_revision_info(Command):
 
 
130
    """Show revision number and revision id for a given revision identifier.
 
 
133
    takes_args = ['revision_info*']
 
 
134
    takes_options = ['revision']
 
 
135
    def run(self, revision=None, revision_info_list=[]):
 
 
136
        from bzrlib.revisionspec import RevisionSpec
 
 
139
        if revision is not None:
 
 
140
            revs.extend(revision)
 
 
141
        if revision_info_list is not None:
 
 
142
            for rev in revision_info_list:
 
 
143
                revs.append(RevisionSpec(rev))
 
 
145
            raise BzrCommandError('You must supply a revision identifier')
 
 
147
        b = Branch.open_containing('.')
 
 
150
            revinfo = rev.in_history(b)
 
 
151
            if revinfo.revno is None:
 
 
152
                print '     %s' % revinfo.rev_id
 
 
154
                print '%4d %s' % (revinfo.revno, revinfo.rev_id)
 
 
157
class cmd_add(Command):
 
 
158
    """Add specified files or directories.
 
 
160
    In non-recursive mode, all the named items are added, regardless
 
 
161
    of whether they were previously ignored.  A warning is given if
 
 
162
    any of the named files are already versioned.
 
 
164
    In recursive mode (the default), files are treated the same way
 
 
165
    but the behaviour for directories is different.  Directories that
 
 
166
    are already versioned do not give a warning.  All directories,
 
 
167
    whether already versioned or not, are searched for files or
 
 
168
    subdirectories that are neither versioned or ignored, and these
 
 
169
    are added.  This search proceeds recursively into versioned
 
 
170
    directories.  If no names are given '.' is assumed.
 
 
172
    Therefore simply saying 'bzr add' will version all files that
 
 
173
    are currently unknown.
 
 
175
    Adding a file whose parent directory is not versioned will
 
 
176
    implicitly add the parent, and so on up to the root. This means
 
 
177
    you should never need to explictly add a directory, they'll just
 
 
178
    get added when you add a file in the directory.
 
 
180
    takes_args = ['file*']
 
 
181
    takes_options = ['verbose', 'no-recurse']
 
 
183
    def run(self, file_list, verbose=False, no_recurse=False):
 
 
184
        # verbose currently has no effect
 
 
185
        from bzrlib.add import smart_add, add_reporter_print
 
 
186
        smart_add(file_list, not no_recurse, add_reporter_print)
 
 
190
class cmd_mkdir(Command):
 
 
191
    """Create a new versioned directory.
 
 
193
    This is equivalent to creating the directory and then adding it.
 
 
195
    takes_args = ['dir+']
 
 
197
    def run(self, dir_list):
 
 
203
                b = Branch.open_containing(d)
 
 
208
class cmd_relpath(Command):
 
 
209
    """Show path of a file relative to root"""
 
 
210
    takes_args = ['filename']
 
 
213
    def run(self, filename):
 
 
214
        print Branch.open_containing(filename).relpath(filename)
 
 
218
class cmd_inventory(Command):
 
 
219
    """Show inventory of the current working copy or a revision."""
 
 
220
    takes_options = ['revision', 'show-ids']
 
 
222
    def run(self, revision=None, show_ids=False):
 
 
223
        b = Branch.open_containing('.')
 
 
225
            inv = b.read_working_inventory()
 
 
227
            if len(revision) > 1:
 
 
228
                raise BzrCommandError('bzr inventory --revision takes'
 
 
229
                    ' exactly one revision identifier')
 
 
230
            inv = b.get_revision_inventory(revision[0].in_history(b).rev_id)
 
 
232
        for path, entry in inv.entries():
 
 
234
                print '%-50s %s' % (path, entry.file_id)
 
 
239
class cmd_move(Command):
 
 
240
    """Move files to a different directory.
 
 
245
    The destination must be a versioned directory in the same branch.
 
 
247
    takes_args = ['source$', 'dest']
 
 
248
    def run(self, source_list, dest):
 
 
249
        b = Branch.open_containing('.')
 
 
251
        # TODO: glob expansion on windows?
 
 
252
        b.move([b.relpath(s) for s in source_list], b.relpath(dest))
 
 
255
class cmd_rename(Command):
 
 
256
    """Change the name of an entry.
 
 
259
      bzr rename frob.c frobber.c
 
 
260
      bzr rename src/frob.c lib/frob.c
 
 
262
    It is an error if the destination name exists.
 
 
264
    See also the 'move' command, which moves files into a different
 
 
265
    directory without changing their name.
 
 
267
    TODO: Some way to rename multiple files without invoking bzr for each
 
 
269
    takes_args = ['from_name', 'to_name']
 
 
271
    def run(self, from_name, to_name):
 
 
272
        b = Branch.open_containing('.')
 
 
273
        b.rename_one(b.relpath(from_name), b.relpath(to_name))
 
 
277
class cmd_mv(Command):
 
 
278
    """Move or rename a file.
 
 
281
        bzr mv OLDNAME NEWNAME
 
 
282
        bzr mv SOURCE... DESTINATION
 
 
284
    If the last argument is a versioned directory, all the other names
 
 
285
    are moved into it.  Otherwise, there must be exactly two arguments
 
 
286
    and the file is changed to a new name, which must not already exist.
 
 
288
    Files cannot be moved between branches.
 
 
290
    takes_args = ['names*']
 
 
291
    def run(self, names_list):
 
 
292
        if len(names_list) < 2:
 
 
293
            raise BzrCommandError("missing file argument")
 
 
294
        b = Branch.open_containing(names_list[0])
 
 
296
        rel_names = [b.relpath(x) for x in names_list]
 
 
298
        if os.path.isdir(names_list[-1]):
 
 
299
            # move into existing directory
 
 
300
            for pair in b.move(rel_names[:-1], rel_names[-1]):
 
 
301
                print "%s => %s" % pair
 
 
303
            if len(names_list) != 2:
 
 
304
                raise BzrCommandError('to mv multiple files the destination '
 
 
305
                                      'must be a versioned directory')
 
 
306
            b.rename_one(rel_names[0], rel_names[1])
 
 
307
            print "%s => %s" % (rel_names[0], rel_names[1])
 
 
312
class cmd_pull(Command):
 
 
313
    """Pull any changes from another branch into the current one.
 
 
315
    If the location is omitted, the last-used location will be used.
 
 
316
    Both the revision history and the working directory will be
 
 
319
    This command only works on branches that have not diverged.  Branches are
 
 
320
    considered diverged if both branches have had commits without first
 
 
321
    pulling from the other.
 
 
323
    If branches have diverged, you can use 'bzr merge' to pull the text changes
 
 
324
    from one into the other.
 
 
326
    takes_options = ['remember']
 
 
327
    takes_args = ['location?']
 
 
329
    def run(self, location=None, remember=False):
 
 
330
        from bzrlib.merge import merge
 
 
332
        from shutil import rmtree
 
 
335
        br_to = Branch.open_containing('.')
 
 
336
        stored_loc = br_to.get_parent()
 
 
338
            if stored_loc is None:
 
 
339
                raise BzrCommandError("No pull location known or specified.")
 
 
341
                print "Using saved location: %s" % stored_loc
 
 
342
                location = stored_loc
 
 
343
        cache_root = tempfile.mkdtemp()
 
 
345
            from bzrlib.errors import DivergedBranches
 
 
346
            br_from = Branch.open(location)
 
 
348
            br_from.setup_caching(cache_root)
 
 
349
            location = br_from.base
 
 
350
            old_revno = br_to.revno()
 
 
352
                br_to.update_revisions(br_from)
 
 
353
            except DivergedBranches:
 
 
354
                raise BzrCommandError("These branches have diverged."
 
 
357
            merge(('.', -1), ('.', old_revno), check_clean=False)
 
 
358
            if stored_loc is None or remember:
 
 
359
                br_to.set_parent(location)
 
 
366
class cmd_branch(Command):
 
 
367
    """Create a new copy of a branch.
 
 
369
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
 
 
370
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
 
 
372
    To retrieve the branch as of a particular revision, supply the --revision
 
 
373
    parameter, as in "branch foo/bar -r 5".
 
 
375
    --basis is to speed up branching from remote branches.  When specified, it
 
 
376
    copies all the file-contents, inventory and revision data from the basis
 
 
377
    branch before copying anything from the remote branch.
 
 
379
    takes_args = ['from_location', 'to_location?']
 
 
380
    takes_options = ['revision', 'basis']
 
 
381
    aliases = ['get', 'clone']
 
 
383
    def run(self, from_location, to_location=None, revision=None, basis=None):
 
 
384
        from bzrlib.clone import copy_branch
 
 
387
        from shutil import rmtree
 
 
388
        cache_root = tempfile.mkdtemp()
 
 
392
            elif len(revision) > 1:
 
 
393
                raise BzrCommandError(
 
 
394
                    'bzr branch --revision takes exactly 1 revision value')
 
 
396
                br_from = Branch.open(from_location)
 
 
398
                if e.errno == errno.ENOENT:
 
 
399
                    raise BzrCommandError('Source location "%s" does not'
 
 
400
                                          ' exist.' % to_location)
 
 
403
            br_from.setup_caching(cache_root)
 
 
404
            if basis is not None:
 
 
405
                basis_branch = Branch.open_containing(basis)
 
 
408
            if len(revision) == 1 and revision[0] is not None:
 
 
409
                revision_id = revision[0].in_history(br_from)[1]
 
 
412
            if to_location is None:
 
 
413
                to_location = os.path.basename(from_location.rstrip("/\\"))
 
 
415
                os.mkdir(to_location)
 
 
417
                if e.errno == errno.EEXIST:
 
 
418
                    raise BzrCommandError('Target directory "%s" already'
 
 
419
                                          ' exists.' % to_location)
 
 
420
                if e.errno == errno.ENOENT:
 
 
421
                    raise BzrCommandError('Parent of "%s" does not exist.' %
 
 
426
                copy_branch(br_from, to_location, revision_id, basis_branch)
 
 
427
            except bzrlib.errors.NoSuchRevision:
 
 
429
                msg = "The branch %s has no revision %d." % (from_location, revision[0])
 
 
430
                raise BzrCommandError(msg)
 
 
431
            except bzrlib.errors.UnlistableBranch:
 
 
432
                msg = "The branch %s cannot be used as a --basis"
 
 
437
class cmd_renames(Command):
 
 
438
    """Show list of renamed files.
 
 
440
    TODO: Option to show renames between two historical versions.
 
 
442
    TODO: Only show renames under dir, rather than in the whole branch.
 
 
444
    takes_args = ['dir?']
 
 
446
    def run(self, dir='.'):
 
 
447
        b = Branch.open_containing(dir)
 
 
448
        old_inv = b.basis_tree().inventory
 
 
449
        new_inv = b.read_working_inventory()
 
 
451
        renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
 
 
453
        for old_name, new_name in renames:
 
 
454
            print "%s => %s" % (old_name, new_name)        
 
 
457
class cmd_info(Command):
 
 
458
    """Show statistical information about a branch."""
 
 
459
    takes_args = ['branch?']
 
 
461
    def run(self, branch=None):
 
 
464
        b = Branch.open_containing(branch)
 
 
468
class cmd_remove(Command):
 
 
469
    """Make a file unversioned.
 
 
471
    This makes bzr stop tracking changes to a versioned file.  It does
 
 
472
    not delete the working copy.
 
 
474
    takes_args = ['file+']
 
 
475
    takes_options = ['verbose']
 
 
478
    def run(self, file_list, verbose=False):
 
 
479
        b = Branch.open_containing(file_list[0])
 
 
480
        b.remove([b.relpath(f) for f in file_list], verbose=verbose)
 
 
483
class cmd_file_id(Command):
 
 
484
    """Print file_id of a particular file or directory.
 
 
486
    The file_id is assigned when the file is first added and remains the
 
 
487
    same through all revisions where the file exists, even when it is
 
 
491
    takes_args = ['filename']
 
 
492
    def run(self, filename):
 
 
493
        b = Branch.open_containing(filename)
 
 
494
        i = b.inventory.path2id(b.relpath(filename))
 
 
496
            raise BzrError("%r is not a versioned file" % filename)
 
 
501
class cmd_file_path(Command):
 
 
502
    """Print path of file_ids to a file or directory.
 
 
504
    This prints one line for each directory down to the target,
 
 
505
    starting at the branch root."""
 
 
507
    takes_args = ['filename']
 
 
508
    def run(self, filename):
 
 
509
        b = Branch.open_containing(filename)
 
 
511
        fid = inv.path2id(b.relpath(filename))
 
 
513
            raise BzrError("%r is not a versioned file" % filename)
 
 
514
        for fip in inv.get_idpath(fid):
 
 
518
class cmd_revision_history(Command):
 
 
519
    """Display list of revision ids on this branch."""
 
 
522
        for patchid in Branch.open_containing('.').revision_history():
 
 
526
class cmd_ancestry(Command):
 
 
527
    """List all revisions merged into this branch."""
 
 
531
        for revision_id in b.get_ancestry(b.last_revision()):
 
 
535
class cmd_directories(Command):
 
 
536
    """Display list of versioned directories in this branch."""
 
 
538
        for name, ie in Branch.open_containing('.').read_working_inventory().directories():
 
 
545
class cmd_init(Command):
 
 
546
    """Make a directory into a versioned branch.
 
 
548
    Use this to create an empty branch, or before importing an
 
 
551
    Recipe for importing a tree of files:
 
 
556
        bzr commit -m 'imported project'
 
 
559
        Branch.initialize('.')
 
 
562
class cmd_diff(Command):
 
 
563
    """Show differences in working tree.
 
 
565
    If files are listed, only the changes in those files are listed.
 
 
566
    Otherwise, all changes for the tree are listed.
 
 
568
    TODO: Allow diff across branches.
 
 
570
    TODO: Option to use external diff command; could be GNU diff, wdiff,
 
 
573
    TODO: Python difflib is not exactly the same as unidiff; should
 
 
574
          either fix it up or prefer to use an external diff.
 
 
576
    TODO: If a directory is given, diff everything under that.
 
 
578
    TODO: Selected-file diff is inefficient and doesn't show you
 
 
581
    TODO: This probably handles non-Unix newlines poorly.
 
 
589
    takes_args = ['file*']
 
 
590
    takes_options = ['revision', 'diff-options']
 
 
591
    aliases = ['di', 'dif']
 
 
593
    def run(self, revision=None, file_list=None, diff_options=None):
 
 
594
        from bzrlib.diff import show_diff
 
 
597
            b = Branch.open_containing(file_list[0])
 
 
598
            file_list = [b.relpath(f) for f in file_list]
 
 
599
            if file_list == ['']:
 
 
600
                # just pointing to top-of-tree
 
 
603
            b = Branch.open_containing('.')
 
 
605
        if revision is not None:
 
 
606
            if len(revision) == 1:
 
 
607
                show_diff(b, revision[0], specific_files=file_list,
 
 
608
                          external_diff_options=diff_options)
 
 
609
            elif len(revision) == 2:
 
 
610
                show_diff(b, revision[0], specific_files=file_list,
 
 
611
                          external_diff_options=diff_options,
 
 
612
                          revision2=revision[1])
 
 
614
                raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
 
 
616
            show_diff(b, None, specific_files=file_list,
 
 
617
                      external_diff_options=diff_options)
 
 
622
class cmd_deleted(Command):
 
 
623
    """List files deleted in the working tree.
 
 
625
    TODO: Show files deleted since a previous revision, or between two revisions.
 
 
627
    def run(self, show_ids=False):
 
 
628
        b = Branch.open_containing('.')
 
 
630
        new = b.working_tree()
 
 
632
        ## TODO: Much more efficient way to do this: read in new
 
 
633
        ## directories with readdir, rather than stating each one.  Same
 
 
634
        ## level of effort but possibly much less IO.  (Or possibly not,
 
 
635
        ## if the directories are very large...)
 
 
637
        for path, ie in old.inventory.iter_entries():
 
 
638
            if not new.has_id(ie.file_id):
 
 
640
                    print '%-50s %s' % (path, ie.file_id)
 
 
645
class cmd_modified(Command):
 
 
646
    """List files modified in working tree."""
 
 
649
        from bzrlib.delta import compare_trees
 
 
651
        b = Branch.open_containing('.')
 
 
652
        td = compare_trees(b.basis_tree(), b.working_tree())
 
 
654
        for path, id, kind, text_modified, meta_modified in td.modified:
 
 
659
class cmd_added(Command):
 
 
660
    """List files added in working tree."""
 
 
663
        b = Branch.open_containing('.')
 
 
664
        wt = b.working_tree()
 
 
665
        basis_inv = b.basis_tree().inventory
 
 
668
            if file_id in basis_inv:
 
 
670
            path = inv.id2path(file_id)
 
 
671
            if not os.access(b.abspath(path), os.F_OK):
 
 
677
class cmd_root(Command):
 
 
678
    """Show the tree root directory.
 
 
680
    The root is the nearest enclosing directory with a .bzr control
 
 
682
    takes_args = ['filename?']
 
 
683
    def run(self, filename=None):
 
 
684
        """Print the branch root."""
 
 
685
        b = Branch.open_containing(filename)
 
 
689
class cmd_log(Command):
 
 
690
    """Show log of this branch.
 
 
692
    To request a range of logs, you can use the command -r begin:end
 
 
693
    -r revision requests a specific revision, -r :end or -r begin: are
 
 
696
    --message allows you to give a regular expression, which will be evaluated
 
 
697
    so that only matching entries will be displayed.
 
 
700
    # TODO: Make --revision support uuid: and hash: [future tag:] notation.
 
 
702
    takes_args = ['filename?']
 
 
703
    takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision',
 
 
704
                     'long', 'message', 'short',]
 
 
706
    def run(self, filename=None, timezone='original',
 
 
714
        from bzrlib.log import log_formatter, show_log
 
 
717
        direction = (forward and 'forward') or 'reverse'
 
 
720
            b = Branch.open_containing(filename)
 
 
721
            fp = b.relpath(filename)
 
 
723
                file_id = b.read_working_inventory().path2id(fp)
 
 
725
                file_id = None  # points to branch root
 
 
727
            b = Branch.open_containing('.')
 
 
733
        elif len(revision) == 1:
 
 
734
            rev1 = rev2 = revision[0].in_history(b).revno
 
 
735
        elif len(revision) == 2:
 
 
736
            rev1 = revision[0].in_history(b).revno
 
 
737
            rev2 = revision[1].in_history(b).revno
 
 
739
            raise BzrCommandError('bzr log --revision takes one or two values.')
 
 
746
        mutter('encoding log as %r' % bzrlib.user_encoding)
 
 
748
        # use 'replace' so that we don't abort if trying to write out
 
 
749
        # in e.g. the default C locale.
 
 
750
        outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
 
 
756
        lf = log_formatter(log_format,
 
 
759
                           show_timezone=timezone)
 
 
772
class cmd_touching_revisions(Command):
 
 
773
    """Return revision-ids which affected a particular file.
 
 
775
    A more user-friendly interface is "bzr log FILE"."""
 
 
777
    takes_args = ["filename"]
 
 
778
    def run(self, filename):
 
 
779
        b = Branch.open_containing(filename)
 
 
780
        inv = b.read_working_inventory()
 
 
781
        file_id = inv.path2id(b.relpath(filename))
 
 
782
        for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
 
 
783
            print "%6d %s" % (revno, what)
 
 
786
class cmd_ls(Command):
 
 
787
    """List files in a tree.
 
 
789
    TODO: Take a revision or remote path and list that tree instead.
 
 
792
    def run(self, revision=None, verbose=False):
 
 
793
        b = Branch.open_containing('.')
 
 
795
            tree = b.working_tree()
 
 
797
            tree = b.revision_tree(revision.in_history(b).rev_id)
 
 
798
        for fp, fc, kind, fid, entry in tree.list_files():
 
 
800
                kindch = entry.kind_character()
 
 
801
                print '%-8s %s%s' % (fc, fp, kindch)
 
 
807
class cmd_unknowns(Command):
 
 
808
    """List unknown files."""
 
 
810
        from bzrlib.osutils import quotefn
 
 
811
        for f in Branch.open_containing('.').unknowns():
 
 
816
class cmd_ignore(Command):
 
 
817
    """Ignore a command or pattern.
 
 
819
    To remove patterns from the ignore list, edit the .bzrignore file.
 
 
821
    If the pattern contains a slash, it is compared to the whole path
 
 
822
    from the branch root.  Otherwise, it is comapred to only the last
 
 
823
    component of the path.
 
 
825
    Ignore patterns are case-insensitive on case-insensitive systems.
 
 
827
    Note: wildcards must be quoted from the shell on Unix.
 
 
830
        bzr ignore ./Makefile
 
 
833
    takes_args = ['name_pattern']
 
 
835
    def run(self, name_pattern):
 
 
836
        from bzrlib.atomicfile import AtomicFile
 
 
839
        b = Branch.open_containing('.')
 
 
840
        ifn = b.abspath('.bzrignore')
 
 
842
        if os.path.exists(ifn):
 
 
845
                igns = f.read().decode('utf-8')
 
 
851
        # TODO: If the file already uses crlf-style termination, maybe
 
 
852
        # we should use that for the newly added lines?
 
 
854
        if igns and igns[-1] != '\n':
 
 
856
        igns += name_pattern + '\n'
 
 
859
            f = AtomicFile(ifn, 'wt')
 
 
860
            f.write(igns.encode('utf-8'))
 
 
865
        inv = b.working_tree().inventory
 
 
866
        if inv.path2id('.bzrignore'):
 
 
867
            mutter('.bzrignore is already versioned')
 
 
869
            mutter('need to make new .bzrignore file versioned')
 
 
870
            b.add(['.bzrignore'])
 
 
874
class cmd_ignored(Command):
 
 
875
    """List ignored files and the patterns that matched them.
 
 
877
    See also: bzr ignore"""
 
 
879
        tree = Branch.open_containing('.').working_tree()
 
 
880
        for path, file_class, kind, file_id, entry in tree.list_files():
 
 
881
            if file_class != 'I':
 
 
883
            ## XXX: Slightly inefficient since this was already calculated
 
 
884
            pat = tree.is_ignored(path)
 
 
885
            print '%-50s %s' % (path, pat)
 
 
888
class cmd_lookup_revision(Command):
 
 
889
    """Lookup the revision-id from a revision-number
 
 
892
        bzr lookup-revision 33
 
 
895
    takes_args = ['revno']
 
 
897
    def run(self, revno):
 
 
901
            raise BzrCommandError("not a valid revision-number: %r" % revno)
 
 
903
        print Branch.open_containing('.').get_rev_id(revno)
 
 
906
class cmd_export(Command):
 
 
907
    """Export past revision to destination directory.
 
 
909
    If no revision is specified this exports the last committed revision.
 
 
911
    Format may be an "exporter" name, such as tar, tgz, tbz2.  If none is
 
 
912
    given, try to find the format with the extension. If no extension
 
 
913
    is found exports to a directory (equivalent to --format=dir).
 
 
915
    Root may be the top directory for tar, tgz and tbz2 formats. If none
 
 
916
    is given, the top directory will be the root name of the file."""
 
 
917
    # TODO: list known exporters
 
 
918
    takes_args = ['dest']
 
 
919
    takes_options = ['revision', 'format', 'root']
 
 
920
    def run(self, dest, revision=None, format=None, root=None):
 
 
922
        b = Branch.open_containing('.')
 
 
924
            rev_id = b.last_revision()
 
 
926
            if len(revision) != 1:
 
 
927
                raise BzrError('bzr export --revision takes exactly 1 argument')
 
 
928
            rev_id = revision[0].in_history(b).rev_id
 
 
929
        t = b.revision_tree(rev_id)
 
 
930
        arg_root, ext = os.path.splitext(os.path.basename(dest))
 
 
931
        if ext in ('.gz', '.bz2'):
 
 
932
            new_root, new_ext = os.path.splitext(arg_root)
 
 
933
            if new_ext == '.tar':
 
 
941
            elif ext in (".tar.gz", ".tgz"):
 
 
943
            elif ext in (".tar.bz2", ".tbz2"):
 
 
947
        t.export(dest, format, root)
 
 
950
class cmd_cat(Command):
 
 
951
    """Write a file's text from a previous revision."""
 
 
953
    takes_options = ['revision']
 
 
954
    takes_args = ['filename']
 
 
956
    def run(self, filename, revision=None):
 
 
958
            raise BzrCommandError("bzr cat requires a revision number")
 
 
959
        elif len(revision) != 1:
 
 
960
            raise BzrCommandError("bzr cat --revision takes exactly one number")
 
 
961
        b = Branch.open_containing('.')
 
 
962
        b.print_file(b.relpath(filename), revision[0].in_history(b).revno)
 
 
965
class cmd_local_time_offset(Command):
 
 
966
    """Show the offset in seconds from GMT to local time."""
 
 
969
        print bzrlib.osutils.local_time_offset()
 
 
973
class cmd_commit(Command):
 
 
974
    """Commit changes into a new revision.
 
 
976
    If no arguments are given, the entire tree is committed.
 
 
978
    If selected files are specified, only changes to those files are
 
 
979
    committed.  If a directory is specified then the directory and everything 
 
 
980
    within it is committed.
 
 
982
    A selected-file commit may fail in some cases where the committed
 
 
983
    tree would be invalid, such as trying to commit a file in a
 
 
984
    newly-added directory that is not itself committed.
 
 
986
    TODO: Run hooks on tree to-be-committed, and after commit.
 
 
988
    TODO: Strict commit that fails if there are unknown or deleted files.
 
 
990
    takes_args = ['selected*']
 
 
991
    takes_options = ['message', 'file', 'verbose', 'unchanged']
 
 
992
    aliases = ['ci', 'checkin']
 
 
994
    # TODO: Give better message for -s, --summary, used by tla people
 
 
996
    # XXX: verbose currently does nothing
 
 
998
    def run(self, message=None, file=None, verbose=True, selected_list=None,
 
 
1000
        from bzrlib.errors import PointlessCommit, ConflictsInTree
 
 
1001
        from bzrlib.msgeditor import edit_commit_message
 
 
1002
        from bzrlib.status import show_status
 
 
1003
        from cStringIO import StringIO
 
 
1005
        b = Branch.open_containing('.')
 
 
1007
            selected_list = [b.relpath(s) for s in selected_list]
 
 
1010
        if message is None and not file:
 
 
1011
            catcher = StringIO()
 
 
1012
            show_status(b, specific_files=selected_list,
 
 
1014
            message = edit_commit_message(catcher.getvalue())
 
 
1017
                raise BzrCommandError("please specify a commit message"
 
 
1018
                                      " with either --message or --file")
 
 
1019
        elif message and file:
 
 
1020
            raise BzrCommandError("please specify either --message or --file")
 
 
1024
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
 
 
1027
                raise BzrCommandError("empty commit message specified")
 
 
1031
                     specific_files=selected_list,
 
 
1032
                     allow_pointless=unchanged)
 
 
1033
        except PointlessCommit:
 
 
1034
            # FIXME: This should really happen before the file is read in;
 
 
1035
            # perhaps prepare the commit; get the message; then actually commit
 
 
1036
            raise BzrCommandError("no changes to commit",
 
 
1037
                                  ["use --unchanged to commit anyhow"])
 
 
1038
        except ConflictsInTree:
 
 
1039
            raise BzrCommandError("Conflicts detected in working tree.  "
 
 
1040
                'Use "bzr conflicts" to list, "bzr resolve FILE" to resolve.')
 
 
1043
class cmd_check(Command):
 
 
1044
    """Validate consistency of branch history.
 
 
1046
    This command checks various invariants about the branch storage to
 
 
1047
    detect data corruption or bzr bugs.
 
 
1049
    takes_args = ['dir?']
 
 
1051
    def run(self, dir='.'):
 
 
1052
        from bzrlib.check import check
 
 
1054
        check(Branch.open_containing(dir))
 
 
1057
class cmd_scan_cache(Command):
 
 
1060
        from bzrlib.hashcache import HashCache
 
 
1066
        print '%6d stats' % c.stat_count
 
 
1067
        print '%6d in hashcache' % len(c._cache)
 
 
1068
        print '%6d files removed from cache' % c.removed_count
 
 
1069
        print '%6d hashes updated' % c.update_count
 
 
1070
        print '%6d files changed too recently to cache' % c.danger_count
 
 
1077
class cmd_upgrade(Command):
 
 
1078
    """Upgrade branch storage to current format.
 
 
1080
    The check command or bzr developers may sometimes advise you to run
 
 
1083
    This version of this command upgrades from the full-text storage
 
 
1084
    used by bzr 0.0.8 and earlier to the weave format (v5).
 
 
1086
    takes_args = ['dir?']
 
 
1088
    def run(self, dir='.'):
 
 
1089
        from bzrlib.upgrade import upgrade
 
 
1093
class cmd_whoami(Command):
 
 
1094
    """Show bzr user id."""
 
 
1095
    takes_options = ['email']
 
 
1097
    def run(self, email=False):
 
 
1099
            b = bzrlib.branch.Branch.open_containing('.')
 
 
1100
        except NotBranchError:
 
 
1104
            print bzrlib.osutils.user_email(b)
 
 
1106
            print bzrlib.osutils.username(b)
 
 
1109
class cmd_selftest(Command):
 
 
1110
    """Run internal test suite.
 
 
1112
    This creates temporary test directories in the working directory,
 
 
1113
    but not existing data is affected.  These directories are deleted
 
 
1114
    if the tests pass, or left behind to help in debugging if they
 
 
1117
    If arguments are given, they are regular expressions that say
 
 
1118
    which tests should run."""
 
 
1119
    # TODO: --list should give a list of all available tests
 
 
1121
    takes_args = ['testnames*']
 
 
1122
    takes_options = ['verbose', 'pattern']
 
 
1123
    def run(self, testnames_list=None, verbose=False, pattern=".*"):
 
 
1125
        from bzrlib.selftest import selftest
 
 
1126
        # we don't want progress meters from the tests to go to the
 
 
1127
        # real output; and we don't want log messages cluttering up
 
 
1129
        save_ui = bzrlib.ui.ui_factory
 
 
1130
        bzrlib.trace.info('running tests...')
 
 
1132
            bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
 
 
1133
            result = selftest(verbose=verbose, 
 
 
1135
                              testnames=testnames_list)
 
 
1137
                bzrlib.trace.info('tests passed')
 
 
1139
                bzrlib.trace.info('tests failed')
 
 
1140
            return int(not result)
 
 
1142
            bzrlib.ui.ui_factory = save_ui
 
 
1146
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
 
 
1147
    # is bzrlib itself in a branch?
 
 
1148
    bzrrev = bzrlib.get_bzr_revision()
 
 
1150
        print "  (bzr checkout, revision %d {%s})" % bzrrev
 
 
1151
    print bzrlib.__copyright__
 
 
1152
    print "http://bazaar-ng.org/"
 
 
1154
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
 
 
1155
    print "you may use, modify and redistribute it under the terms of the GNU"
 
 
1156
    print "General Public License version 2 or later."
 
 
1159
class cmd_version(Command):
 
 
1160
    """Show version of bzr."""
 
 
1164
class cmd_rocks(Command):
 
 
1165
    """Statement of optimism."""
 
 
1168
        print "it sure does!"
 
 
1171
class cmd_find_merge_base(Command):
 
 
1172
    """Find and print a base revision for merging two branches.
 
 
1174
    TODO: Options to specify revisions on either side, as if
 
 
1175
          merging only part of the history.
 
 
1177
    takes_args = ['branch', 'other']
 
 
1180
    def run(self, branch, other):
 
 
1181
        from bzrlib.revision import common_ancestor, MultipleRevisionSources
 
 
1183
        branch1 = Branch.open_containing(branch)
 
 
1184
        branch2 = Branch.open_containing(other)
 
 
1186
        history_1 = branch1.revision_history()
 
 
1187
        history_2 = branch2.revision_history()
 
 
1189
        last1 = branch1.last_revision()
 
 
1190
        last2 = branch2.last_revision()
 
 
1192
        source = MultipleRevisionSources(branch1, branch2)
 
 
1194
        base_rev_id = common_ancestor(last1, last2, source)
 
 
1196
        print 'merge base is revision %s' % base_rev_id
 
 
1200
        if base_revno is None:
 
 
1201
            raise bzrlib.errors.UnrelatedBranches()
 
 
1203
        print ' r%-6d in %s' % (base_revno, branch)
 
 
1205
        other_revno = branch2.revision_id_to_revno(base_revid)
 
 
1207
        print ' r%-6d in %s' % (other_revno, other)
 
 
1211
class cmd_merge(Command):
 
 
1212
    """Perform a three-way merge.
 
 
1214
    The branch is the branch you will merge from.  By default, it will
 
 
1215
    merge the latest revision.  If you specify a revision, that
 
 
1216
    revision will be merged.  If you specify two revisions, the first
 
 
1217
    will be used as a BASE, and the second one as OTHER.  Revision
 
 
1218
    numbers are always relative to the specified branch.
 
 
1220
    By default bzr will try to merge in all new work from the other
 
 
1221
    branch, automatically determining an appropriate base.  If this
 
 
1222
    fails, you may need to give an explicit base.
 
 
1226
    To merge the latest revision from bzr.dev
 
 
1227
    bzr merge ../bzr.dev
 
 
1229
    To merge changes up to and including revision 82 from bzr.dev
 
 
1230
    bzr merge -r 82 ../bzr.dev
 
 
1232
    To merge the changes introduced by 82, without previous changes:
 
 
1233
    bzr merge -r 81..82 ../bzr.dev
 
 
1235
    merge refuses to run if there are any uncommitted changes, unless
 
 
1238
    takes_args = ['branch?']
 
 
1239
    takes_options = ['revision', 'force', 'merge-type']
 
 
1241
    def run(self, branch=None, revision=None, force=False, 
 
 
1243
        from bzrlib.merge import merge
 
 
1244
        from bzrlib.merge_core import ApplyMerge3
 
 
1245
        if merge_type is None:
 
 
1246
            merge_type = ApplyMerge3
 
 
1248
            branch = Branch.open_containing('.').get_parent()
 
 
1250
                raise BzrCommandError("No merge location known or specified.")
 
 
1252
                print "Using saved location: %s" % branch 
 
 
1253
        if revision is None or len(revision) < 1:
 
 
1255
            other = [branch, -1]
 
 
1257
            if len(revision) == 1:
 
 
1259
                other = [branch, revision[0].in_history(branch).revno]
 
 
1261
                assert len(revision) == 2
 
 
1262
                if None in revision:
 
 
1263
                    raise BzrCommandError(
 
 
1264
                        "Merge doesn't permit that revision specifier.")
 
 
1265
                b = Branch.open(branch)
 
 
1267
                base = [branch, revision[0].in_history(b).revno]
 
 
1268
                other = [branch, revision[1].in_history(b).revno]
 
 
1271
            merge(other, base, check_clean=(not force), merge_type=merge_type)
 
 
1272
        except bzrlib.errors.AmbiguousBase, e:
 
 
1273
            m = ("sorry, bzr can't determine the right merge base yet\n"
 
 
1274
                 "candidates are:\n  "
 
 
1275
                 + "\n  ".join(e.bases)
 
 
1277
                 "please specify an explicit base with -r,\n"
 
 
1278
                 "and (if you want) report this to the bzr developers\n")
 
 
1282
class cmd_revert(Command):
 
 
1283
    """Reverse all changes since the last commit.
 
 
1285
    Only versioned files are affected.  Specify filenames to revert only 
 
 
1286
    those files.  By default, any files that are changed will be backed up
 
 
1287
    first.  Backup files have a '~' appended to their name.
 
 
1289
    takes_options = ['revision', 'no-backup']
 
 
1290
    takes_args = ['file*']
 
 
1291
    aliases = ['merge-revert']
 
 
1293
    def run(self, revision=None, no_backup=False, file_list=None):
 
 
1294
        from bzrlib.merge import merge
 
 
1295
        from bzrlib.commands import parse_spec
 
 
1297
        if file_list is not None:
 
 
1298
            if len(file_list) == 0:
 
 
1299
                raise BzrCommandError("No files specified")
 
 
1300
        if revision is None:
 
 
1302
        elif len(revision) != 1:
 
 
1303
            raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
 
 
1305
            b = Branch.open_containing('.')
 
 
1306
            revno = revision[0].in_history(b).revno
 
 
1307
        merge(('.', revno), parse_spec('.'),
 
 
1310
              backup_files=not no_backup,
 
 
1311
              file_list=file_list)
 
 
1313
            Branch.open_containing('.').set_pending_merges([])
 
 
1316
class cmd_assert_fail(Command):
 
 
1317
    """Test reporting of assertion failures"""
 
 
1320
        assert False, "always fails"
 
 
1323
class cmd_help(Command):
 
 
1324
    """Show help on a command or other topic.
 
 
1326
    For a list of all available commands, say 'bzr help commands'."""
 
 
1327
    takes_options = ['long']
 
 
1328
    takes_args = ['topic?']
 
 
1331
    def run(self, topic=None, long=False):
 
 
1333
        if topic is None and long:
 
 
1338
class cmd_shell_complete(Command):
 
 
1339
    """Show appropriate completions for context.
 
 
1341
    For a list of all available commands, say 'bzr shell-complete'."""
 
 
1342
    takes_args = ['context?']
 
 
1346
    def run(self, context=None):
 
 
1347
        import shellcomplete
 
 
1348
        shellcomplete.shellcomplete(context)
 
 
1351
class cmd_fetch(Command):
 
 
1352
    """Copy in history from another branch but don't merge it.
 
 
1354
    This is an internal method used for pull and merge."""
 
 
1356
    takes_args = ['from_branch', 'to_branch']
 
 
1357
    def run(self, from_branch, to_branch):
 
 
1358
        from bzrlib.fetch import Fetcher
 
 
1359
        from bzrlib.branch import Branch
 
 
1360
        from_b = Branch(from_branch)
 
 
1361
        to_b = Branch(to_branch)
 
 
1362
        Fetcher(to_b, from_b)
 
 
1366
class cmd_missing(Command):
 
 
1367
    """What is missing in this branch relative to other branch.
 
 
1369
    # TODO: rewrite this in terms of ancestry so that it shows only
 
 
1372
    takes_args = ['remote?']
 
 
1373
    aliases = ['mis', 'miss']
 
 
1374
    # We don't have to add quiet to the list, because 
 
 
1375
    # unknown options are parsed as booleans
 
 
1376
    takes_options = ['verbose', 'quiet']
 
 
1378
    def run(self, remote=None, verbose=False, quiet=False):
 
 
1379
        from bzrlib.errors import BzrCommandError
 
 
1380
        from bzrlib.missing import show_missing
 
 
1382
        if verbose and quiet:
 
 
1383
            raise BzrCommandError('Cannot pass both quiet and verbose')
 
 
1385
        b = Branch.open_containing('.')
 
 
1386
        parent = b.get_parent()
 
 
1389
                raise BzrCommandError("No missing location known or specified.")
 
 
1392
                    print "Using last location: %s" % parent
 
 
1394
        elif parent is None:
 
 
1395
            # We only update parent if it did not exist, missing
 
 
1396
            # should not change the parent
 
 
1397
            b.set_parent(remote)
 
 
1398
        br_remote = Branch.open_containing(remote)
 
 
1399
        return show_missing(b, br_remote, verbose=verbose, quiet=quiet)
 
 
1402
class cmd_plugins(Command):
 
 
1406
        import bzrlib.plugin
 
 
1407
        from inspect import getdoc
 
 
1408
        for plugin in bzrlib.plugin.all_plugins:
 
 
1409
            if hasattr(plugin, '__path__'):
 
 
1410
                print plugin.__path__[0]
 
 
1411
            elif hasattr(plugin, '__file__'):
 
 
1412
                print plugin.__file__
 
 
1418
                print '\t', d.split('\n')[0]