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
 
 
22
from bzrlib.trace import mutter, note, log_error
 
 
23
from bzrlib.errors import bailout, BzrError, BzrCheckError, BzrCommandError
 
 
24
from bzrlib.osutils import quotefn
 
 
25
from bzrlib import Branch, Inventory, InventoryEntry, BZRDIR, \
 
 
29
def _squish_command_name(cmd):
 
 
30
    return 'cmd_' + cmd.replace('-', '_')
 
 
33
def _unsquish_command_name(cmd):
 
 
34
    assert cmd.startswith("cmd_")
 
 
35
    return cmd[4:].replace('_','-')
 
 
37
def _parse_revision_str(revstr):
 
 
38
    """This handles a revision string -> revno. 
 
 
40
    There are several possibilities:
 
 
43
        '234:345'   -> [234, 345]
 
 
47
    In the future we will also support:
 
 
48
        'uuid:blah-blah-blah'   -> ?
 
 
49
        'hash:blahblahblah'     -> ?
 
 
53
    if revstr.find(':') != -1:
 
 
54
        revs = revstr.split(':')
 
 
56
            raise ValueError('More than 2 pieces not supported for --revision: %r' % revstr)
 
 
61
            revs[0] = int(revs[0])
 
 
66
            revs[1] = int(revs[1])
 
 
72
    """Return canonical name and class for all registered commands."""
 
 
73
    for k, v in globals().iteritems():
 
 
74
        if k.startswith("cmd_"):
 
 
75
            yield _unsquish_command_name(k), v
 
 
77
def get_cmd_class(cmd):
 
 
78
    """Return the canonical name and command class for a command.
 
 
80
    cmd = str(cmd)                      # not unicode
 
 
82
    # first look up this command under the specified name
 
 
84
        return cmd, globals()[_squish_command_name(cmd)]
 
 
88
    # look for any command which claims this as an alias
 
 
89
    for cmdname, cmdclass in get_all_cmds():
 
 
90
        if cmd in cmdclass.aliases:
 
 
91
            return cmdname, cmdclass
 
 
93
    cmdclass = ExternalCommand.find_command(cmd)
 
 
97
    raise BzrCommandError("unknown command %r" % cmd)
 
 
100
class Command(object):
 
 
101
    """Base class for commands.
 
 
103
    The docstring for an actual command should give a single-line
 
 
104
    summary, then a complete description of the command.  A grammar
 
 
105
    description will be inserted.
 
 
108
        List of argument forms, marked with whether they are optional,
 
 
112
        List of options that may be given for this command.
 
 
115
        If true, this command isn't advertised.
 
 
124
    def __init__(self, options, arguments):
 
 
125
        """Construct and run the command.
 
 
127
        Sets self.status to the return value of run()."""
 
 
128
        assert isinstance(options, dict)
 
 
129
        assert isinstance(arguments, dict)
 
 
130
        cmdargs = options.copy()
 
 
131
        cmdargs.update(arguments)
 
 
132
        assert self.__doc__ != Command.__doc__, \
 
 
133
               ("No help message set for %r" % self)
 
 
134
        self.status = self.run(**cmdargs)
 
 
138
        """Override this in sub-classes.
 
 
140
        This is invoked with the options and arguments bound to
 
 
143
        Return 0 or None if the command was successful, or a shell
 
 
149
class ExternalCommand(Command):
 
 
150
    """Class to wrap external commands.
 
 
152
    We cheat a little here, when get_cmd_class() calls us we actually give it back
 
 
153
    an object we construct that has the appropriate path, help, options etc for the
 
 
156
    When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
 
 
157
    method, which we override to call the Command.__init__ method. That then calls
 
 
158
    our run method which is pretty straight forward.
 
 
160
    The only wrinkle is that we have to map bzr's dictionary of options and arguments
 
 
161
    back into command line options and arguments for the script.
 
 
164
    def find_command(cls, cmd):
 
 
166
        bzrpath = os.environ.get('BZRPATH', '')
 
 
168
        for dir in bzrpath.split(':'):
 
 
169
            path = os.path.join(dir, cmd)
 
 
170
            if os.path.isfile(path):
 
 
171
                return ExternalCommand(path)
 
 
175
    find_command = classmethod(find_command)
 
 
177
    def __init__(self, path):
 
 
180
        # TODO: If either of these fail, we should detect that and
 
 
181
        # assume that path is not really a bzr plugin after all.
 
 
183
        pipe = os.popen('%s --bzr-usage' % path, 'r')
 
 
184
        self.takes_options = pipe.readline().split()
 
 
185
        self.takes_args = pipe.readline().split()
 
 
188
        pipe = os.popen('%s --bzr-help' % path, 'r')
 
 
189
        self.__doc__ = pipe.read()
 
 
192
    def __call__(self, options, arguments):
 
 
193
        Command.__init__(self, options, arguments)
 
 
196
    def run(self, **kargs):
 
 
204
            if OPTIONS.has_key(name):
 
 
206
                opts.append('--%s' % name)
 
 
207
                if value is not None and value is not True:
 
 
208
                    opts.append(str(value))
 
 
210
                # it's an arg, or arg list
 
 
211
                if type(value) is not list:
 
 
217
        self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
 
 
221
class cmd_status(Command):
 
 
222
    """Display status summary.
 
 
224
    This reports on versioned and unknown files, reporting them
 
 
225
    grouped by state.  Possible states are:
 
 
228
        Versioned in the working copy but not in the previous revision.
 
 
231
        Versioned in the previous revision but removed or deleted
 
 
235
        Path of this file changed from the previous revision;
 
 
236
        the text may also have changed.  This includes files whose
 
 
237
        parent directory was renamed.
 
 
240
        Text has changed since the previous revision.
 
 
243
        Nothing about this file has changed since the previous revision.
 
 
244
        Only shown with --all.
 
 
247
        Not versioned and not matching an ignore pattern.
 
 
249
    To see ignored files use 'bzr ignored'.  For details in the
 
 
250
    changes to file texts, use 'bzr diff'.
 
 
252
    If no arguments are specified, the status of the entire working
 
 
253
    directory is shown.  Otherwise, only the status of the specified
 
 
254
    files or directories is reported.  If a directory is given, status
 
 
255
    is reported for everything inside that directory.
 
 
257
    takes_args = ['file*']
 
 
258
    takes_options = ['all', 'show-ids']
 
 
259
    aliases = ['st', 'stat']
 
 
261
    def run(self, all=False, show_ids=False, file_list=None):
 
 
263
            b = Branch(file_list[0])
 
 
264
            file_list = [b.relpath(x) for x in file_list]
 
 
265
            # special case: only one path was given and it's the root
 
 
267
            if file_list == ['']:
 
 
272
        status.show_status(b, show_unchanged=all, show_ids=show_ids,
 
 
273
                           specific_files=file_list)
 
 
276
class cmd_cat_revision(Command):
 
 
277
    """Write out metadata for a revision."""
 
 
280
    takes_args = ['revision_id']
 
 
282
    def run(self, revision_id):
 
 
283
        Branch('.').get_revision(revision_id).write_xml(sys.stdout)
 
 
286
class cmd_revno(Command):
 
 
287
    """Show current revision number.
 
 
289
    This is equal to the number of revisions on this branch."""
 
 
291
        print Branch('.').revno()
 
 
294
class cmd_add(Command):
 
 
295
    """Add specified files or directories.
 
 
297
    In non-recursive mode, all the named items are added, regardless
 
 
298
    of whether they were previously ignored.  A warning is given if
 
 
299
    any of the named files are already versioned.
 
 
301
    In recursive mode (the default), files are treated the same way
 
 
302
    but the behaviour for directories is different.  Directories that
 
 
303
    are already versioned do not give a warning.  All directories,
 
 
304
    whether already versioned or not, are searched for files or
 
 
305
    subdirectories that are neither versioned or ignored, and these
 
 
306
    are added.  This search proceeds recursively into versioned
 
 
309
    Therefore simply saying 'bzr add .' will version all files that
 
 
310
    are currently unknown.
 
 
312
    TODO: Perhaps adding a file whose directly is not versioned should
 
 
313
    recursively add that parent, rather than giving an error?
 
 
315
    takes_args = ['file+']
 
 
316
    takes_options = ['verbose', 'no-recurse']
 
 
318
    def run(self, file_list, verbose=False, no_recurse=False):
 
 
319
        bzrlib.add.smart_add(file_list, verbose, not no_recurse)
 
 
322
class cmd_relpath(Command):
 
 
323
    """Show path of a file relative to root"""
 
 
324
    takes_args = ['filename']
 
 
327
    def run(self, filename):
 
 
328
        print Branch(filename).relpath(filename)
 
 
332
class cmd_inventory(Command):
 
 
333
    """Show inventory of the current working copy or a revision."""
 
 
334
    takes_options = ['revision', 'show-ids']
 
 
336
    def run(self, revision=None, show_ids=False):
 
 
339
            inv = b.read_working_inventory()
 
 
341
            inv = b.get_revision_inventory(b.lookup_revision(revision))
 
 
343
        for path, entry in inv.entries():
 
 
345
                print '%-50s %s' % (path, entry.file_id)
 
 
350
class cmd_move(Command):
 
 
351
    """Move files to a different directory.
 
 
356
    The destination must be a versioned directory in the same branch.
 
 
358
    takes_args = ['source$', 'dest']
 
 
359
    def run(self, source_list, dest):
 
 
362
        b.move([b.relpath(s) for s in source_list], b.relpath(dest))
 
 
365
class cmd_rename(Command):
 
 
366
    """Change the name of an entry.
 
 
369
      bzr rename frob.c frobber.c
 
 
370
      bzr rename src/frob.c lib/frob.c
 
 
372
    It is an error if the destination name exists.
 
 
374
    See also the 'move' command, which moves files into a different
 
 
375
    directory without changing their name.
 
 
377
    TODO: Some way to rename multiple files without invoking bzr for each
 
 
379
    takes_args = ['from_name', 'to_name']
 
 
381
    def run(self, from_name, to_name):
 
 
383
        b.rename_one(b.relpath(from_name), b.relpath(to_name))
 
 
389
class cmd_pull(Command):
 
 
390
    """Pull any changes from another branch into the current one.
 
 
392
    If the location is omitted, the last-used location will be used.
 
 
393
    Both the revision history and the working directory will be
 
 
396
    This command only works on branches that have not diverged.  Branches are
 
 
397
    considered diverged if both branches have had commits without first
 
 
398
    pulling from the other.
 
 
400
    If branches have diverged, you can use 'bzr merge' to pull the text changes
 
 
401
    from one into the other.
 
 
403
    takes_args = ['location?']
 
 
405
    def run(self, location=None):
 
 
406
        from bzrlib.merge import merge
 
 
412
            stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
 
 
414
            if errno == errno.ENOENT:
 
 
417
            location = stored_loc
 
 
419
            raise BzrCommandError("No pull location known or specified.")
 
 
420
        from branch import find_branch, DivergedBranches
 
 
421
        br_from = find_branch(location)
 
 
422
        location = pull_loc(br_from)
 
 
423
        old_revno = br_to.revno()
 
 
425
            br_to.update_revisions(br_from)
 
 
426
        except DivergedBranches:
 
 
427
            raise BzrCommandError("These branches have diverged.  Try merge.")
 
 
429
        merge(('.', -1), ('.', old_revno))
 
 
430
        if location != stored_loc:
 
 
431
            br_to.controlfile("x-pull", "wb").write(location + "\n")
 
 
435
class cmd_branch(Command):
 
 
436
    """Create a new copy of a branch.
 
 
438
    If the TO_LOCATION is omitted, the last component of the
 
 
439
    FROM_LOCATION will be used.  In other words,
 
 
440
    "branch ../foo/bar" will attempt to create ./bar.
 
 
442
    takes_args = ['from_location', 'to_location?']
 
 
444
    def run(self, from_location, to_location=None):
 
 
446
        from bzrlib.merge import merge
 
 
448
        if to_location is None:
 
 
449
            to_location = os.path.basename(from_location)
 
 
450
            # FIXME: If there's a trailing slash, keep removing them
 
 
451
            # until we find the right bit
 
 
454
            os.mkdir(to_location)
 
 
456
            if e.errno == errno.EEXIST:
 
 
457
                raise BzrCommandError('Target directory "%s" already exists.' %
 
 
459
            if e.errno == errno.ENOENT:
 
 
460
                raise BzrCommandError('Parent of "%s" does not exist.' %
 
 
464
        br_to = Branch(to_location, init=True)
 
 
465
        from branch import find_branch, DivergedBranches
 
 
467
            br_from = find_branch(from_location)
 
 
469
            if e.errno == errno.ENOENT:
 
 
470
                raise BzrCommandError('Source location "%s" does not exist.' %
 
 
475
        from_location = pull_loc(br_from)
 
 
476
        br_to.update_revisions(br_from)
 
 
477
        merge((to_location, -1), (to_location, 0), this_dir=to_location,
 
 
479
        br_to.controlfile("x-pull", "wb").write(from_location + "\n")
 
 
482
def pull_loc(branch):
 
 
483
    # TODO: Should perhaps just make attribute be 'base' in
 
 
484
    # RemoteBranch and Branch?
 
 
485
    if hasattr(branch, "baseurl"):
 
 
486
        return branch.baseurl
 
 
492
class cmd_renames(Command):
 
 
493
    """Show list of renamed files.
 
 
495
    TODO: Option to show renames between two historical versions.
 
 
497
    TODO: Only show renames under dir, rather than in the whole branch.
 
 
499
    takes_args = ['dir?']
 
 
501
    def run(self, dir='.'):
 
 
503
        old_inv = b.basis_tree().inventory
 
 
504
        new_inv = b.read_working_inventory()
 
 
506
        renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
 
 
508
        for old_name, new_name in renames:
 
 
509
            print "%s => %s" % (old_name, new_name)        
 
 
512
class cmd_info(Command):
 
 
513
    """Show statistical information about a branch."""
 
 
514
    takes_args = ['branch?']
 
 
516
    def run(self, branch=None):
 
 
519
        from branch import find_branch
 
 
520
        b = find_branch(branch)
 
 
524
class cmd_remove(Command):
 
 
525
    """Make a file unversioned.
 
 
527
    This makes bzr stop tracking changes to a versioned file.  It does
 
 
528
    not delete the working copy.
 
 
530
    takes_args = ['file+']
 
 
531
    takes_options = ['verbose']
 
 
533
    def run(self, file_list, verbose=False):
 
 
534
        b = Branch(file_list[0])
 
 
535
        b.remove([b.relpath(f) for f in file_list], verbose=verbose)
 
 
538
class cmd_file_id(Command):
 
 
539
    """Print file_id of a particular file or directory.
 
 
541
    The file_id is assigned when the file is first added and remains the
 
 
542
    same through all revisions where the file exists, even when it is
 
 
546
    takes_args = ['filename']
 
 
547
    def run(self, filename):
 
 
549
        i = b.inventory.path2id(b.relpath(filename))
 
 
551
            bailout("%r is not a versioned file" % filename)
 
 
556
class cmd_file_path(Command):
 
 
557
    """Print path of file_ids to a file or directory.
 
 
559
    This prints one line for each directory down to the target,
 
 
560
    starting at the branch root."""
 
 
562
    takes_args = ['filename']
 
 
563
    def run(self, filename):
 
 
566
        fid = inv.path2id(b.relpath(filename))
 
 
568
            bailout("%r is not a versioned file" % filename)
 
 
569
        for fip in inv.get_idpath(fid):
 
 
573
class cmd_revision_history(Command):
 
 
574
    """Display list of revision ids on this branch."""
 
 
577
        for patchid in Branch('.').revision_history():
 
 
581
class cmd_directories(Command):
 
 
582
    """Display list of versioned directories in this branch."""
 
 
584
        for name, ie in Branch('.').read_working_inventory().directories():
 
 
591
class cmd_init(Command):
 
 
592
    """Make a directory into a versioned branch.
 
 
594
    Use this to create an empty branch, or before importing an
 
 
597
    Recipe for importing a tree of files:
 
 
602
        bzr commit -m 'imported project'
 
 
605
        Branch('.', init=True)
 
 
608
class cmd_diff(Command):
 
 
609
    """Show differences in working tree.
 
 
611
    If files are listed, only the changes in those files are listed.
 
 
612
    Otherwise, all changes for the tree are listed.
 
 
614
    TODO: Given two revision arguments, show the difference between them.
 
 
616
    TODO: Allow diff across branches.
 
 
618
    TODO: Option to use external diff command; could be GNU diff, wdiff,
 
 
621
    TODO: Python difflib is not exactly the same as unidiff; should
 
 
622
          either fix it up or prefer to use an external diff.
 
 
624
    TODO: If a directory is given, diff everything under that.
 
 
626
    TODO: Selected-file diff is inefficient and doesn't show you
 
 
629
    TODO: This probably handles non-Unix newlines poorly.
 
 
632
    takes_args = ['file*']
 
 
633
    takes_options = ['revision', 'diff-options']
 
 
636
    def run(self, revision=None, file_list=None, diff_options=None):
 
 
637
        from bzrlib.diff import show_diff
 
 
638
        from bzrlib import find_branch
 
 
641
            b = find_branch(file_list[0])
 
 
642
            file_list = [b.relpath(f) for f in file_list]
 
 
643
            if file_list == ['']:
 
 
644
                # just pointing to top-of-tree
 
 
649
        show_diff(b, revision, specific_files=file_list,
 
 
650
                  external_diff_options=diff_options)
 
 
656
class cmd_deleted(Command):
 
 
657
    """List files deleted in the working tree.
 
 
659
    TODO: Show files deleted since a previous revision, or between two revisions.
 
 
661
    def run(self, show_ids=False):
 
 
664
        new = b.working_tree()
 
 
666
        ## TODO: Much more efficient way to do this: read in new
 
 
667
        ## directories with readdir, rather than stating each one.  Same
 
 
668
        ## level of effort but possibly much less IO.  (Or possibly not,
 
 
669
        ## if the directories are very large...)
 
 
671
        for path, ie in old.inventory.iter_entries():
 
 
672
            if not new.has_id(ie.file_id):
 
 
674
                    print '%-50s %s' % (path, ie.file_id)
 
 
679
class cmd_modified(Command):
 
 
680
    """List files modified in working tree."""
 
 
685
        inv = b.read_working_inventory()
 
 
686
        sc = statcache.update_cache(b, inv)
 
 
687
        basis = b.basis_tree()
 
 
688
        basis_inv = basis.inventory
 
 
690
        # We used to do this through iter_entries(), but that's slow
 
 
691
        # when most of the files are unmodified, as is usually the
 
 
692
        # case.  So instead we iterate by inventory entry, and only
 
 
693
        # calculate paths as necessary.
 
 
695
        for file_id in basis_inv:
 
 
696
            cacheentry = sc.get(file_id)
 
 
697
            if not cacheentry:                 # deleted
 
 
699
            ie = basis_inv[file_id]
 
 
700
            if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
 
 
701
                path = inv.id2path(file_id)
 
 
706
class cmd_added(Command):
 
 
707
    """List files added in working tree."""
 
 
711
        wt = b.working_tree()
 
 
712
        basis_inv = b.basis_tree().inventory
 
 
715
            if file_id in basis_inv:
 
 
717
            path = inv.id2path(file_id)
 
 
718
            if not os.access(b.abspath(path), os.F_OK):
 
 
724
class cmd_root(Command):
 
 
725
    """Show the tree root directory.
 
 
727
    The root is the nearest enclosing directory with a .bzr control
 
 
729
    takes_args = ['filename?']
 
 
730
    def run(self, filename=None):
 
 
731
        """Print the branch root."""
 
 
732
        from branch import find_branch
 
 
733
        b = find_branch(filename)
 
 
734
        print getattr(b, 'base', None) or getattr(b, 'baseurl')
 
 
737
class cmd_log(Command):
 
 
738
    """Show log of this branch.
 
 
740
    To request a range of logs, you can use the command -r begin:end
 
 
741
    -r revision requests a specific revision, -r :end or -r begin: are
 
 
744
    TODO: Make --revision support uuid: and hash: [future tag:] notation.
 
 
748
    takes_args = ['filename?']
 
 
749
    takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision']
 
 
751
    def run(self, filename=None, timezone='original',
 
 
756
        from bzrlib import show_log, find_branch
 
 
759
        direction = (forward and 'forward') or 'reverse'
 
 
762
            b = find_branch(filename)
 
 
763
            fp = b.relpath(filename)
 
 
765
                file_id = b.read_working_inventory().path2id(fp)
 
 
767
                file_id = None  # points to branch root
 
 
773
            revision = [None, None]
 
 
774
        elif isinstance(revision, int):
 
 
775
            revision = [revision, revision]
 
 
780
        assert len(revision) == 2
 
 
782
        mutter('encoding log as %r' % bzrlib.user_encoding)
 
 
784
        # use 'replace' so that we don't abort if trying to write out
 
 
785
        # in e.g. the default C locale.
 
 
786
        outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
 
 
789
                 show_timezone=timezone,
 
 
794
                 start_revision=revision[0],
 
 
795
                 end_revision=revision[1])
 
 
799
class cmd_touching_revisions(Command):
 
 
800
    """Return revision-ids which affected a particular file.
 
 
802
    A more user-friendly interface is "bzr log FILE"."""
 
 
804
    takes_args = ["filename"]
 
 
805
    def run(self, filename):
 
 
807
        inv = b.read_working_inventory()
 
 
808
        file_id = inv.path2id(b.relpath(filename))
 
 
809
        for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
 
 
810
            print "%6d %s" % (revno, what)
 
 
813
class cmd_ls(Command):
 
 
814
    """List files in a tree.
 
 
816
    TODO: Take a revision or remote path and list that tree instead.
 
 
819
    def run(self, revision=None, verbose=False):
 
 
822
            tree = b.working_tree()
 
 
824
            tree = b.revision_tree(b.lookup_revision(revision))
 
 
826
        for fp, fc, kind, fid in tree.list_files():
 
 
828
                if kind == 'directory':
 
 
835
                print '%-8s %s%s' % (fc, fp, kindch)
 
 
841
class cmd_unknowns(Command):
 
 
842
    """List unknown files."""
 
 
844
        for f in Branch('.').unknowns():
 
 
849
class cmd_ignore(Command):
 
 
850
    """Ignore a command or pattern.
 
 
852
    To remove patterns from the ignore list, edit the .bzrignore file.
 
 
854
    If the pattern contains a slash, it is compared to the whole path
 
 
855
    from the branch root.  Otherwise, it is comapred to only the last
 
 
856
    component of the path.
 
 
858
    Ignore patterns are case-insensitive on case-insensitive systems.
 
 
860
    Note: wildcards must be quoted from the shell on Unix.
 
 
863
        bzr ignore ./Makefile
 
 
866
    takes_args = ['name_pattern']
 
 
868
    def run(self, name_pattern):
 
 
869
        from bzrlib.atomicfile import AtomicFile
 
 
873
        ifn = b.abspath('.bzrignore')
 
 
875
        if os.path.exists(ifn):
 
 
878
                igns = f.read().decode('utf-8')
 
 
884
        # TODO: If the file already uses crlf-style termination, maybe
 
 
885
        # we should use that for the newly added lines?
 
 
887
        if igns and igns[-1] != '\n':
 
 
889
        igns += name_pattern + '\n'
 
 
892
            f = AtomicFile(ifn, 'wt')
 
 
893
            f.write(igns.encode('utf-8'))
 
 
898
        inv = b.working_tree().inventory
 
 
899
        if inv.path2id('.bzrignore'):
 
 
900
            mutter('.bzrignore is already versioned')
 
 
902
            mutter('need to make new .bzrignore file versioned')
 
 
903
            b.add(['.bzrignore'])
 
 
907
class cmd_ignored(Command):
 
 
908
    """List ignored files and the patterns that matched them.
 
 
910
    See also: bzr ignore"""
 
 
912
        tree = Branch('.').working_tree()
 
 
913
        for path, file_class, kind, file_id in tree.list_files():
 
 
914
            if file_class != 'I':
 
 
916
            ## XXX: Slightly inefficient since this was already calculated
 
 
917
            pat = tree.is_ignored(path)
 
 
918
            print '%-50s %s' % (path, pat)
 
 
921
class cmd_lookup_revision(Command):
 
 
922
    """Lookup the revision-id from a revision-number
 
 
925
        bzr lookup-revision 33
 
 
928
    takes_args = ['revno']
 
 
930
    def run(self, revno):
 
 
934
            raise BzrCommandError("not a valid revision-number: %r" % revno)
 
 
936
        print Branch('.').lookup_revision(revno)
 
 
939
class cmd_export(Command):
 
 
940
    """Export past revision to destination directory.
 
 
942
    If no revision is specified this exports the last committed revision."""
 
 
943
    takes_args = ['dest']
 
 
944
    takes_options = ['revision']
 
 
945
    def run(self, dest, revision=None):
 
 
948
            rh = b.revision_history()[-1]
 
 
950
            rh = b.lookup_revision(int(revision))
 
 
951
        t = b.revision_tree(rh)
 
 
955
class cmd_cat(Command):
 
 
956
    """Write a file's text from a previous revision."""
 
 
958
    takes_options = ['revision']
 
 
959
    takes_args = ['filename']
 
 
961
    def run(self, filename, revision=None):
 
 
963
            raise BzrCommandError("bzr cat requires a revision number")
 
 
965
        b.print_file(b.relpath(filename), int(revision))
 
 
968
class cmd_local_time_offset(Command):
 
 
969
    """Show the offset in seconds from GMT to local time."""
 
 
972
        print bzrlib.osutils.local_time_offset()
 
 
976
class cmd_commit(Command):
 
 
977
    """Commit changes into a new revision.
 
 
979
    If selected files are specified, only changes to those files are
 
 
980
    committed.  If a directory is specified then its contents are also
 
 
983
    A selected-file commit may fail in some cases where the committed
 
 
984
    tree would be invalid, such as trying to commit a file in a
 
 
985
    newly-added directory that is not itself committed.
 
 
987
    TODO: Run hooks on tree to-be-committed, and after commit.
 
 
989
    TODO: Strict commit that fails if there are unknown or deleted files.
 
 
991
    takes_args = ['selected*']
 
 
992
    takes_options = ['message', 'file', 'verbose']
 
 
993
    aliases = ['ci', 'checkin']
 
 
995
    def run(self, message=None, file=None, verbose=True, selected_list=None):
 
 
996
        from bzrlib.commit import commit
 
 
998
        ## Warning: shadows builtin file()
 
 
999
        if not message and not file:
 
 
1000
            raise BzrCommandError("please specify a commit message",
 
 
1001
                                  ["use either --message or --file"])
 
 
1002
        elif message and file:
 
 
1003
            raise BzrCommandError("please specify either --message or --file")
 
 
1007
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
 
 
1010
        commit(b, message, verbose=verbose, specific_files=selected_list)
 
 
1013
class cmd_check(Command):
 
 
1014
    """Validate consistency of branch history.
 
 
1016
    This command checks various invariants about the branch storage to
 
 
1017
    detect data corruption or bzr bugs.
 
 
1019
    takes_args = ['dir?']
 
 
1020
    def run(self, dir='.'):
 
 
1022
        bzrlib.check.check(Branch(dir))
 
 
1026
class cmd_whoami(Command):
 
 
1027
    """Show bzr user id."""
 
 
1028
    takes_options = ['email']
 
 
1030
    def run(self, email=False):
 
 
1032
            print bzrlib.osutils.user_email()
 
 
1034
            print bzrlib.osutils.username()
 
 
1037
class cmd_selftest(Command):
 
 
1038
    """Run internal test suite"""
 
 
1041
        from bzrlib.selftest import selftest
 
 
1049
class cmd_version(Command):
 
 
1050
    """Show version of bzr."""
 
 
1055
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
 
 
1056
    # is bzrlib itself in a branch?
 
 
1057
    bzrrev = bzrlib.get_bzr_revision()
 
 
1059
        print "  (bzr checkout, revision %d {%s})" % bzrrev
 
 
1060
    print bzrlib.__copyright__
 
 
1061
    print "http://bazaar-ng.org/"
 
 
1063
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
 
 
1064
    print "you may use, modify and redistribute it under the terms of the GNU"
 
 
1065
    print "General Public License version 2 or later."
 
 
1068
class cmd_rocks(Command):
 
 
1069
    """Statement of optimism."""
 
 
1072
        print "it sure does!"
 
 
1074
def parse_spec(spec):
 
 
1076
    >>> parse_spec(None)
 
 
1078
    >>> parse_spec("./")
 
 
1080
    >>> parse_spec("../@")
 
 
1082
    >>> parse_spec("../f/@35")
 
 
1088
        parsed = spec.split('/@')
 
 
1089
        assert len(parsed) == 2
 
 
1093
            parsed[1] = int(parsed[1])
 
 
1094
            assert parsed[1] >=0
 
 
1096
        parsed = [spec, None]
 
 
1101
class cmd_merge(Command):
 
 
1102
    """Perform a three-way merge of trees.
 
 
1104
    The SPEC parameters are working tree or revision specifiers.  Working trees
 
 
1105
    are specified using standard paths or urls.  No component of a directory
 
 
1106
    path may begin with '@'.
 
 
1108
    Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
 
 
1110
    Revisions are specified using a dirname/@revno pair, where dirname is the
 
 
1111
    branch directory and revno is the revision within that branch.  If no revno
 
 
1112
    is specified, the latest revision is used.
 
 
1114
    Revision examples: './@127', 'foo/@', '../@1'
 
 
1116
    The OTHER_SPEC parameter is required.  If the BASE_SPEC parameter is
 
 
1117
    not supplied, the common ancestor of OTHER_SPEC the current branch is used
 
 
1120
    merge refuses to run if there are any uncommitted changes, unless
 
 
1123
    takes_args = ['other_spec', 'base_spec?']
 
 
1124
    takes_options = ['force']
 
 
1126
    def run(self, other_spec, base_spec=None, force=False):
 
 
1127
        from bzrlib.merge import merge
 
 
1128
        merge(parse_spec(other_spec), parse_spec(base_spec),
 
 
1129
              check_clean=(not force))
 
 
1132
class cmd_revert(Command):
 
 
1133
    """Reverse all changes since the last commit.
 
 
1135
    Only versioned files are affected.
 
 
1137
    TODO: Store backups of any files that will be reverted, so
 
 
1138
          that the revert can be undone.          
 
 
1140
    takes_options = ['revision']
 
 
1142
    def run(self, revision=-1):
 
 
1143
        from bzrlib.merge import merge
 
 
1144
        merge(('.', revision), parse_spec('.'),
 
 
1149
class cmd_assert_fail(Command):
 
 
1150
    """Test reporting of assertion failures"""
 
 
1153
        assert False, "always fails"
 
 
1156
class cmd_help(Command):
 
 
1157
    """Show help on a command or other topic.
 
 
1159
    For a list of all available commands, say 'bzr help commands'."""
 
 
1160
    takes_args = ['topic?']
 
 
1163
    def run(self, topic=None):
 
 
1168
class cmd_update_stat_cache(Command):
 
 
1169
    """Update stat-cache mapping inodes to SHA-1 hashes.
 
 
1171
    For testing only."""
 
 
1176
        statcache.update_cache(b.base, b.read_working_inventory())
 
 
1180
# list of all available options; the rhs can be either None for an
 
 
1181
# option that takes no argument, or a constructor function that checks
 
 
1185
    'diff-options':           str,
 
 
1193
    'revision':               _parse_revision_str,
 
 
1210
def parse_args(argv):
 
 
1211
    """Parse command line.
 
 
1213
    Arguments and options are parsed at this level before being passed
 
 
1214
    down to specific command handlers.  This routine knows, from a
 
 
1215
    lookup table, something about the available options, what optargs
 
 
1216
    they take, and which commands will accept them.
 
 
1218
    >>> parse_args('--help'.split())
 
 
1219
    ([], {'help': True})
 
 
1220
    >>> parse_args('--version'.split())
 
 
1221
    ([], {'version': True})
 
 
1222
    >>> parse_args('status --all'.split())
 
 
1223
    (['status'], {'all': True})
 
 
1224
    >>> parse_args('commit --message=biter'.split())
 
 
1225
    (['commit'], {'message': u'biter'})
 
 
1230
    # TODO: Maybe handle '--' to end options?
 
 
1235
            # option names must not be unicode
 
 
1239
                mutter("  got option %r" % a)
 
 
1241
                    optname, optarg = a[2:].split('=', 1)
 
 
1244
                if optname not in OPTIONS:
 
 
1245
                    bailout('unknown long option %r' % a)
 
 
1248
                if shortopt not in SHORT_OPTIONS:
 
 
1249
                    bailout('unknown short option %r' % a)
 
 
1250
                optname = SHORT_OPTIONS[shortopt]
 
 
1253
                # XXX: Do we ever want to support this, e.g. for -r?
 
 
1254
                bailout('repeated option %r' % a)
 
 
1256
            optargfn = OPTIONS[optname]
 
 
1260
                        bailout('option %r needs an argument' % a)
 
 
1262
                        optarg = argv.pop(0)
 
 
1263
                opts[optname] = optargfn(optarg)
 
 
1266
                    bailout('option %r takes no argument' % optname)
 
 
1267
                opts[optname] = True
 
 
1276
def _match_argform(cmd, takes_args, args):
 
 
1279
    # step through args and takes_args, allowing appropriate 0-many matches
 
 
1280
    for ap in takes_args:
 
 
1284
                argdict[argname] = args.pop(0)
 
 
1285
        elif ap[-1] == '*': # all remaining arguments
 
 
1287
                argdict[argname + '_list'] = args[:]
 
 
1290
                argdict[argname + '_list'] = None
 
 
1293
                raise BzrCommandError("command %r needs one or more %s"
 
 
1294
                        % (cmd, argname.upper()))
 
 
1296
                argdict[argname + '_list'] = args[:]
 
 
1298
        elif ap[-1] == '$': # all but one
 
 
1300
                raise BzrCommandError("command %r needs one or more %s"
 
 
1301
                        % (cmd, argname.upper()))
 
 
1302
            argdict[argname + '_list'] = args[:-1]
 
 
1308
                raise BzrCommandError("command %r requires argument %s"
 
 
1309
                        % (cmd, argname.upper()))
 
 
1311
                argdict[argname] = args.pop(0)
 
 
1314
        raise BzrCommandError("extra argument to command %s: %s"
 
 
1322
    """Execute a command.
 
 
1324
    This is similar to main(), but without all the trappings for
 
 
1325
    logging and error handling.  
 
 
1327
    argv = [a.decode(bzrlib.user_encoding) for a in argv]
 
 
1330
        args, opts = parse_args(argv[1:])
 
 
1338
        elif 'version' in opts:
 
 
1341
        cmd = str(args.pop(0))
 
 
1348
    canonical_cmd, cmd_class = get_cmd_class(cmd)
 
 
1351
    if 'profile' in opts:
 
 
1357
    # check options are reasonable
 
 
1358
    allowed = cmd_class.takes_options
 
 
1360
        if oname not in allowed:
 
 
1361
            raise BzrCommandError("option '--%s' is not allowed for command %r"
 
 
1364
    # mix arguments and options into one dictionary
 
 
1365
    cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
 
 
1367
    for k, v in opts.items():
 
 
1368
        cmdopts[k.replace('-', '_')] = v
 
 
1371
        import hotshot, tempfile
 
 
1372
        pffileno, pfname = tempfile.mkstemp()
 
 
1374
            prof = hotshot.Profile(pfname)
 
 
1375
            ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
 
 
1378
            import hotshot.stats
 
 
1379
            stats = hotshot.stats.load(pfname)
 
 
1381
            stats.sort_stats('time')
 
 
1382
            ## XXX: Might like to write to stderr or the trace file instead but
 
 
1383
            ## print_stats seems hardcoded to stdout
 
 
1384
            stats.print_stats(20)
 
 
1392
        return cmd_class(cmdopts, cmdargs).status 
 
 
1395
def _report_exception(summary, quiet=False):
 
 
1397
    log_error('bzr: ' + summary)
 
 
1398
    bzrlib.trace.log_exception()
 
 
1401
        tb = sys.exc_info()[2]
 
 
1402
        exinfo = traceback.extract_tb(tb)
 
 
1404
            sys.stderr.write('  at %s:%d in %s()\n' % exinfo[-1][:3])
 
 
1405
        sys.stderr.write('  see ~/.bzr.log for debug information\n')
 
 
1412
    bzrlib.open_tracefile(argv)
 
 
1417
                return run_bzr(argv)
 
 
1419
                # do this here inside the exception wrappers to catch EPIPE
 
 
1422
            quiet = isinstance(e, (BzrCommandError))
 
 
1423
            _report_exception('error: ' + e.args[0], quiet=quiet)
 
 
1426
                    # some explanation or hints
 
 
1429
        except AssertionError, e:
 
 
1430
            msg = 'assertion failed'
 
 
1432
                msg += ': ' + str(e)
 
 
1433
            _report_exception(msg)
 
 
1435
        except KeyboardInterrupt, e:
 
 
1436
            _report_exception('interrupted', quiet=True)
 
 
1438
        except Exception, e:
 
 
1440
            if (isinstance(e, IOError) 
 
 
1441
                and hasattr(e, 'errno')
 
 
1442
                and e.errno == errno.EPIPE):
 
 
1446
                msg = str(e).rstrip('\n')
 
 
1447
            _report_exception(msg, quiet)
 
 
1450
        bzrlib.trace.close_trace()
 
 
1453
if __name__ == '__main__':
 
 
1454
    sys.exit(main(sys.argv))