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
 
 
18
# TODO: Split the command framework away from the actual commands.
 
 
20
# TODO: probably should say which arguments are candidates for glob
 
 
21
# expansion on windows and do that at the command level.
 
 
23
# TODO: Help messages for options.
 
 
25
# TODO: Define arguments by objects, rather than just using names.
 
 
26
# Those objects can specify the expected type of the argument, which
 
 
27
# would help with validation and shell completion.
 
 
34
from bzrlib.trace import mutter, note, log_error, warning
 
 
35
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError
 
 
36
from bzrlib.branch import find_branch
 
 
37
from bzrlib import BZRDIR
 
 
43
def register_command(cmd):
 
 
44
    "Utility function to help register a command"
 
 
47
    if k.startswith("cmd_"):
 
 
48
        k_unsquished = _unsquish_command_name(k)
 
 
51
    if not plugin_cmds.has_key(k_unsquished):
 
 
52
        plugin_cmds[k_unsquished] = cmd
 
 
54
        log_error('Two plugins defined the same command: %r' % k)
 
 
55
        log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
 
 
58
def _squish_command_name(cmd):
 
 
59
    return 'cmd_' + cmd.replace('-', '_')
 
 
62
def _unsquish_command_name(cmd):
 
 
63
    assert cmd.startswith("cmd_")
 
 
64
    return cmd[4:].replace('_','-')
 
 
67
def _parse_revision_str(revstr):
 
 
68
    """This handles a revision string -> revno.
 
 
70
    This always returns a list.  The list will have one element for 
 
 
72
    It supports integers directly, but everything else it
 
 
73
    defers for passing to Branch.get_revision_info()
 
 
75
    >>> _parse_revision_str('234')
 
 
77
    >>> _parse_revision_str('234..567')
 
 
79
    >>> _parse_revision_str('..')
 
 
81
    >>> _parse_revision_str('..234')
 
 
83
    >>> _parse_revision_str('234..')
 
 
85
    >>> _parse_revision_str('234..456..789') # Maybe this should be an error
 
 
87
    >>> _parse_revision_str('234....789') # Error?
 
 
89
    >>> _parse_revision_str('revid:test@other.com-234234')
 
 
90
    ['revid:test@other.com-234234']
 
 
91
    >>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
 
 
92
    ['revid:test@other.com-234234', 'revid:test@other.com-234235']
 
 
93
    >>> _parse_revision_str('revid:test@other.com-234234..23')
 
 
94
    ['revid:test@other.com-234234', 23]
 
 
95
    >>> _parse_revision_str('date:2005-04-12')
 
 
97
    >>> _parse_revision_str('date:2005-04-12 12:24:33')
 
 
98
    ['date:2005-04-12 12:24:33']
 
 
99
    >>> _parse_revision_str('date:2005-04-12T12:24:33')
 
 
100
    ['date:2005-04-12T12:24:33']
 
 
101
    >>> _parse_revision_str('date:2005-04-12,12:24:33')
 
 
102
    ['date:2005-04-12,12:24:33']
 
 
103
    >>> _parse_revision_str('-5..23')
 
 
105
    >>> _parse_revision_str('-5')
 
 
107
    >>> _parse_revision_str('123a')
 
 
109
    >>> _parse_revision_str('abc')
 
 
113
    old_format_re = re.compile('\d*:\d*')
 
 
114
    m = old_format_re.match(revstr)
 
 
116
        warning('Colon separator for revision numbers is deprecated.'
 
 
119
        for rev in revstr.split(':'):
 
 
121
                revs.append(int(rev))
 
 
126
    for x in revstr.split('..'):
 
 
137
def get_merge_type(typestring):
 
 
138
    """Attempt to find the merge class/factory associated with a string."""
 
 
139
    from merge import merge_types
 
 
141
        return merge_types[typestring][0]
 
 
143
        templ = '%s%%7s: %%s' % (' '*12)
 
 
144
        lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
 
 
145
        type_list = '\n'.join(lines)
 
 
146
        msg = "No known merge type %s. Supported types are:\n%s" %\
 
 
147
            (typestring, type_list)
 
 
148
        raise BzrCommandError(msg)
 
 
151
def get_merge_type(typestring):
 
 
152
    """Attempt to find the merge class/factory associated with a string."""
 
 
153
    from merge import merge_types
 
 
155
        return merge_types[typestring][0]
 
 
157
        templ = '%s%%7s: %%s' % (' '*12)
 
 
158
        lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
 
 
159
        type_list = '\n'.join(lines)
 
 
160
        msg = "No known merge type %s. Supported types are:\n%s" %\
 
 
161
            (typestring, type_list)
 
 
162
        raise BzrCommandError(msg)
 
 
166
def _get_cmd_dict(plugins_override=True):
 
 
168
    for k, v in globals().iteritems():
 
 
169
        if k.startswith("cmd_"):
 
 
170
            d[_unsquish_command_name(k)] = v
 
 
171
    # If we didn't load plugins, the plugin_cmds dict will be empty
 
 
173
        d.update(plugin_cmds)
 
 
175
        d2 = plugin_cmds.copy()
 
 
181
def get_all_cmds(plugins_override=True):
 
 
182
    """Return canonical name and class for all registered commands."""
 
 
183
    for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
 
 
187
def get_cmd_class(cmd, plugins_override=True):
 
 
188
    """Return the canonical name and command class for a command.
 
 
190
    cmd = str(cmd)                      # not unicode
 
 
192
    # first look up this command under the specified name
 
 
193
    cmds = _get_cmd_dict(plugins_override=plugins_override)
 
 
195
        return cmd, cmds[cmd]
 
 
199
    # look for any command which claims this as an alias
 
 
200
    for cmdname, cmdclass in cmds.iteritems():
 
 
201
        if cmd in cmdclass.aliases:
 
 
202
            return cmdname, cmdclass
 
 
204
    cmdclass = ExternalCommand.find_command(cmd)
 
 
208
    raise BzrCommandError("unknown command %r" % cmd)
 
 
211
class Command(object):
 
 
212
    """Base class for commands.
 
 
214
    The docstring for an actual command should give a single-line
 
 
215
    summary, then a complete description of the command.  A grammar
 
 
216
    description will be inserted.
 
 
219
        List of argument forms, marked with whether they are optional,
 
 
223
        List of options that may be given for this command.
 
 
226
        If true, this command isn't advertised.
 
 
235
    def __init__(self, options, arguments):
 
 
236
        """Construct and run the command.
 
 
238
        Sets self.status to the return value of run()."""
 
 
239
        assert isinstance(options, dict)
 
 
240
        assert isinstance(arguments, dict)
 
 
241
        cmdargs = options.copy()
 
 
242
        cmdargs.update(arguments)
 
 
243
        if self.__doc__ == Command.__doc__:
 
 
244
            from warnings import warn
 
 
245
            warn("No help message set for %r" % self)
 
 
246
        self.status = self.run(**cmdargs)
 
 
247
        if self.status is None:
 
 
252
        """Override this in sub-classes.
 
 
254
        This is invoked with the options and arguments bound to
 
 
257
        Return 0 or None if the command was successful, or a shell
 
 
263
class ExternalCommand(Command):
 
 
264
    """Class to wrap external commands.
 
 
266
    We cheat a little here, when get_cmd_class() calls us we actually
 
 
267
    give it back an object we construct that has the appropriate path,
 
 
268
    help, options etc for the specified command.
 
 
270
    When run_bzr() tries to instantiate that 'class' it gets caught by
 
 
271
    the __call__ method, which we override to call the Command.__init__
 
 
272
    method. That then calls our run method which is pretty straight
 
 
275
    The only wrinkle is that we have to map bzr's dictionary of options
 
 
276
    and arguments back into command line options and arguments for the
 
 
280
    def find_command(cls, cmd):
 
 
282
        bzrpath = os.environ.get('BZRPATH', '')
 
 
284
        for dir in bzrpath.split(os.pathsep):
 
 
285
            path = os.path.join(dir, cmd)
 
 
286
            if os.path.isfile(path):
 
 
287
                return ExternalCommand(path)
 
 
291
    find_command = classmethod(find_command)
 
 
293
    def __init__(self, path):
 
 
296
        pipe = os.popen('%s --bzr-usage' % path, 'r')
 
 
297
        self.takes_options = pipe.readline().split()
 
 
299
        for opt in self.takes_options:
 
 
300
            if not opt in OPTIONS:
 
 
301
                raise BzrError("Unknown option '%s' returned by external command %s"
 
 
304
        # TODO: Is there any way to check takes_args is valid here?
 
 
305
        self.takes_args = pipe.readline().split()
 
 
307
        if pipe.close() is not None:
 
 
308
            raise BzrError("Failed funning '%s --bzr-usage'" % path)
 
 
310
        pipe = os.popen('%s --bzr-help' % path, 'r')
 
 
311
        self.__doc__ = pipe.read()
 
 
312
        if pipe.close() is not None:
 
 
313
            raise BzrError("Failed funning '%s --bzr-help'" % path)
 
 
315
    def __call__(self, options, arguments):
 
 
316
        Command.__init__(self, options, arguments)
 
 
319
    def run(self, **kargs):
 
 
326
            optname = name.replace('_','-')
 
 
328
            if OPTIONS.has_key(optname):
 
 
330
                opts.append('--%s' % optname)
 
 
331
                if value is not None and value is not True:
 
 
332
                    opts.append(str(value))
 
 
334
                # it's an arg, or arg list
 
 
335
                if type(value) is not list:
 
 
341
        self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
 
 
345
class cmd_status(Command):
 
 
346
    """Display status summary.
 
 
348
    This reports on versioned and unknown files, reporting them
 
 
349
    grouped by state.  Possible states are:
 
 
352
        Versioned in the working copy but not in the previous revision.
 
 
355
        Versioned in the previous revision but removed or deleted
 
 
359
        Path of this file changed from the previous revision;
 
 
360
        the text may also have changed.  This includes files whose
 
 
361
        parent directory was renamed.
 
 
364
        Text has changed since the previous revision.
 
 
367
        Nothing about this file has changed since the previous revision.
 
 
368
        Only shown with --all.
 
 
371
        Not versioned and not matching an ignore pattern.
 
 
373
    To see ignored files use 'bzr ignored'.  For details in the
 
 
374
    changes to file texts, use 'bzr diff'.
 
 
376
    If no arguments are specified, the status of the entire working
 
 
377
    directory is shown.  Otherwise, only the status of the specified
 
 
378
    files or directories is reported.  If a directory is given, status
 
 
379
    is reported for everything inside that directory.
 
 
381
    If a revision is specified, the changes since that revision are shown.
 
 
383
    takes_args = ['file*']
 
 
384
    takes_options = ['all', 'show-ids', 'revision']
 
 
385
    aliases = ['st', 'stat']
 
 
387
    def run(self, all=False, show_ids=False, file_list=None):
 
 
389
            b = find_branch(file_list[0])
 
 
390
            file_list = [b.relpath(x) for x in file_list]
 
 
391
            # special case: only one path was given and it's the root
 
 
393
            if file_list == ['']:
 
 
398
        from bzrlib.status import show_status
 
 
399
        show_status(b, show_unchanged=all, show_ids=show_ids,
 
 
400
                    specific_files=file_list)
 
 
403
class cmd_cat_revision(Command):
 
 
404
    """Write out metadata for a revision."""
 
 
407
    takes_args = ['revision_id']
 
 
409
    def run(self, revision_id):
 
 
410
        from bzrlib.xml import pack_xml
 
 
411
        pack_xml(find_branch('.').get_revision(revision_id), sys.stdout)
 
 
414
class cmd_revno(Command):
 
 
415
    """Show current revision number.
 
 
417
    This is equal to the number of revisions on this branch."""
 
 
419
        print find_branch('.').revno()
 
 
421
class cmd_revision_info(Command):
 
 
422
    """Show revision number and revision id for a given revision identifier.
 
 
425
    takes_args = ['revision_info*']
 
 
426
    takes_options = ['revision']
 
 
427
    def run(self, revision=None, revision_info_list=None):
 
 
428
        from bzrlib.branch import find_branch
 
 
431
        if revision is not None:
 
 
432
            revs.extend(revision)
 
 
433
        if revision_info_list is not None:
 
 
434
            revs.extend(revision_info_list)
 
 
436
            raise BzrCommandError('You must supply a revision identifier')
 
 
441
            print '%4d %s' % b.get_revision_info(rev)
 
 
444
class cmd_add(Command):
 
 
445
    """Add specified files or directories.
 
 
447
    In non-recursive mode, all the named items are added, regardless
 
 
448
    of whether they were previously ignored.  A warning is given if
 
 
449
    any of the named files are already versioned.
 
 
451
    In recursive mode (the default), files are treated the same way
 
 
452
    but the behaviour for directories is different.  Directories that
 
 
453
    are already versioned do not give a warning.  All directories,
 
 
454
    whether already versioned or not, are searched for files or
 
 
455
    subdirectories that are neither versioned or ignored, and these
 
 
456
    are added.  This search proceeds recursively into versioned
 
 
457
    directories.  If no names are given '.' is assumed.
 
 
459
    Therefore simply saying 'bzr add' will version all files that
 
 
460
    are currently unknown.
 
 
462
    TODO: Perhaps adding a file whose directly is not versioned should
 
 
463
    recursively add that parent, rather than giving an error?
 
 
465
    takes_args = ['file*']
 
 
466
    takes_options = ['verbose', 'no-recurse']
 
 
468
    def run(self, file_list, verbose=False, no_recurse=False):
 
 
469
        from bzrlib.add import smart_add
 
 
470
        smart_add(file_list, verbose, not no_recurse)
 
 
474
class cmd_mkdir(Command):
 
 
475
    """Create a new versioned directory.
 
 
477
    This is equivalent to creating the directory and then adding it.
 
 
479
    takes_args = ['dir+']
 
 
481
    def run(self, dir_list):
 
 
488
            b.add([d], verbose=True)
 
 
491
class cmd_relpath(Command):
 
 
492
    """Show path of a file relative to root"""
 
 
493
    takes_args = ['filename']
 
 
496
    def run(self, filename):
 
 
497
        print find_branch(filename).relpath(filename)
 
 
501
class cmd_inventory(Command):
 
 
502
    """Show inventory of the current working copy or a revision."""
 
 
503
    takes_options = ['revision', 'show-ids']
 
 
505
    def run(self, revision=None, show_ids=False):
 
 
508
            inv = b.read_working_inventory()
 
 
510
            if len(revision) > 1:
 
 
511
                raise BzrCommandError('bzr inventory --revision takes'
 
 
512
                    ' exactly one revision identifier')
 
 
513
            inv = b.get_revision_inventory(b.lookup_revision(revision[0]))
 
 
515
        for path, entry in inv.entries():
 
 
517
                print '%-50s %s' % (path, entry.file_id)
 
 
522
class cmd_move(Command):
 
 
523
    """Move files to a different directory.
 
 
528
    The destination must be a versioned directory in the same branch.
 
 
530
    takes_args = ['source$', 'dest']
 
 
531
    def run(self, source_list, dest):
 
 
534
        # TODO: glob expansion on windows?
 
 
535
        b.move([b.relpath(s) for s in source_list], b.relpath(dest))
 
 
538
class cmd_rename(Command):
 
 
539
    """Change the name of an entry.
 
 
542
      bzr rename frob.c frobber.c
 
 
543
      bzr rename src/frob.c lib/frob.c
 
 
545
    It is an error if the destination name exists.
 
 
547
    See also the 'move' command, which moves files into a different
 
 
548
    directory without changing their name.
 
 
550
    TODO: Some way to rename multiple files without invoking bzr for each
 
 
552
    takes_args = ['from_name', 'to_name']
 
 
554
    def run(self, from_name, to_name):
 
 
556
        b.rename_one(b.relpath(from_name), b.relpath(to_name))
 
 
560
class cmd_mv(Command):
 
 
561
    """Move or rename a file.
 
 
564
        bzr mv OLDNAME NEWNAME
 
 
565
        bzr mv SOURCE... DESTINATION
 
 
567
    If the last argument is a versioned directory, all the other names
 
 
568
    are moved into it.  Otherwise, there must be exactly two arguments
 
 
569
    and the file is changed to a new name, which must not already exist.
 
 
571
    Files cannot be moved between branches.
 
 
573
    takes_args = ['names*']
 
 
574
    def run(self, names_list):
 
 
575
        if len(names_list) < 2:
 
 
576
            raise BzrCommandError("missing file argument")
 
 
577
        b = find_branch(names_list[0])
 
 
579
        rel_names = [b.relpath(x) for x in names_list]
 
 
581
        if os.path.isdir(names_list[-1]):
 
 
582
            # move into existing directory
 
 
583
            b.move(rel_names[:-1], rel_names[-1])
 
 
585
            if len(names_list) != 2:
 
 
586
                raise BzrCommandError('to mv multiple files the destination '
 
 
587
                                      'must be a versioned directory')
 
 
588
            b.move(rel_names[0], rel_names[1])
 
 
593
class cmd_pull(Command):
 
 
594
    """Pull any changes from another branch into the current one.
 
 
596
    If the location is omitted, the last-used location will be used.
 
 
597
    Both the revision history and the working directory will be
 
 
600
    This command only works on branches that have not diverged.  Branches are
 
 
601
    considered diverged if both branches have had commits without first
 
 
602
    pulling from the other.
 
 
604
    If branches have diverged, you can use 'bzr merge' to pull the text changes
 
 
605
    from one into the other.
 
 
607
    takes_args = ['location?']
 
 
609
    def run(self, location=None):
 
 
610
        from bzrlib.merge import merge
 
 
612
        from shutil import rmtree
 
 
615
        br_to = find_branch('.')
 
 
618
            stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
 
 
620
            if e.errno != errno.ENOENT:
 
 
623
            if stored_loc is None:
 
 
624
                raise BzrCommandError("No pull location known or specified.")
 
 
626
                print "Using last location: %s" % stored_loc
 
 
627
                location = stored_loc
 
 
628
        cache_root = tempfile.mkdtemp()
 
 
629
        from bzrlib.branch import DivergedBranches
 
 
630
        br_from = find_branch(location)
 
 
631
        location = pull_loc(br_from)
 
 
632
        old_revno = br_to.revno()
 
 
634
            from branch import find_cached_branch, DivergedBranches
 
 
635
            br_from = find_cached_branch(location, cache_root)
 
 
636
            location = pull_loc(br_from)
 
 
637
            old_revno = br_to.revno()
 
 
639
                br_to.update_revisions(br_from)
 
 
640
            except DivergedBranches:
 
 
641
                raise BzrCommandError("These branches have diverged."
 
 
644
            merge(('.', -1), ('.', old_revno), check_clean=False)
 
 
645
            if location != stored_loc:
 
 
646
                br_to.controlfile("x-pull", "wb").write(location + "\n")
 
 
652
class cmd_branch(Command):
 
 
653
    """Create a new copy of a branch.
 
 
655
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
 
 
656
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
 
 
658
    To retrieve the branch as of a particular revision, supply the --revision
 
 
659
    parameter, as in "branch foo/bar -r 5".
 
 
661
    takes_args = ['from_location', 'to_location?']
 
 
662
    takes_options = ['revision']
 
 
663
    aliases = ['get', 'clone']
 
 
665
    def run(self, from_location, to_location=None, revision=None):
 
 
667
        from bzrlib.merge import merge
 
 
668
        from bzrlib.branch import DivergedBranches, \
 
 
669
             find_cached_branch, Branch
 
 
670
        from shutil import rmtree
 
 
671
        from meta_store import CachedStore
 
 
673
        cache_root = tempfile.mkdtemp()
 
 
677
        elif len(revision) > 1:
 
 
678
            raise BzrCommandError('bzr branch --revision takes exactly 1 revision value')
 
 
682
                br_from = find_cached_branch(from_location, cache_root)
 
 
684
                if e.errno == errno.ENOENT:
 
 
685
                    raise BzrCommandError('Source location "%s" does not'
 
 
686
                                          ' exist.' % to_location)
 
 
690
            if to_location is None:
 
 
691
                to_location = os.path.basename(from_location.rstrip("/\\"))
 
 
694
                os.mkdir(to_location)
 
 
696
                if e.errno == errno.EEXIST:
 
 
697
                    raise BzrCommandError('Target directory "%s" already'
 
 
698
                                          ' exists.' % to_location)
 
 
699
                if e.errno == errno.ENOENT:
 
 
700
                    raise BzrCommandError('Parent of "%s" does not exist.' %
 
 
704
            br_to = Branch(to_location, init=True)
 
 
706
            br_to.set_root_id(br_from.get_root_id())
 
 
709
                if revision[0] is None:
 
 
710
                    revno = br_from.revno()
 
 
712
                    revno, rev_id = br_from.get_revision_info(revision[0])
 
 
714
                    br_to.update_revisions(br_from, stop_revision=revno)
 
 
715
                except bzrlib.errors.NoSuchRevision:
 
 
717
                    msg = "The branch %s has no revision %d." % (from_location,
 
 
719
                    raise BzrCommandError(msg)
 
 
721
            merge((to_location, -1), (to_location, 0), this_dir=to_location,
 
 
722
                  check_clean=False, ignore_zero=True)
 
 
723
            from_location = pull_loc(br_from)
 
 
724
            br_to.controlfile("x-pull", "wb").write(from_location + "\n")
 
 
729
def pull_loc(branch):
 
 
730
    # TODO: Should perhaps just make attribute be 'base' in
 
 
731
    # RemoteBranch and Branch?
 
 
732
    if hasattr(branch, "baseurl"):
 
 
733
        return branch.baseurl
 
 
739
class cmd_renames(Command):
 
 
740
    """Show list of renamed files.
 
 
742
    TODO: Option to show renames between two historical versions.
 
 
744
    TODO: Only show renames under dir, rather than in the whole branch.
 
 
746
    takes_args = ['dir?']
 
 
748
    def run(self, dir='.'):
 
 
750
        old_inv = b.basis_tree().inventory
 
 
751
        new_inv = b.read_working_inventory()
 
 
753
        renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
 
 
755
        for old_name, new_name in renames:
 
 
756
            print "%s => %s" % (old_name, new_name)        
 
 
759
class cmd_info(Command):
 
 
760
    """Show statistical information about a branch."""
 
 
761
    takes_args = ['branch?']
 
 
763
    def run(self, branch=None):
 
 
766
        b = find_branch(branch)
 
 
770
class cmd_remove(Command):
 
 
771
    """Make a file unversioned.
 
 
773
    This makes bzr stop tracking changes to a versioned file.  It does
 
 
774
    not delete the working copy.
 
 
776
    takes_args = ['file+']
 
 
777
    takes_options = ['verbose']
 
 
779
    def run(self, file_list, verbose=False):
 
 
780
        b = find_branch(file_list[0])
 
 
781
        b.remove([b.relpath(f) for f in file_list], verbose=verbose)
 
 
784
class cmd_file_id(Command):
 
 
785
    """Print file_id of a particular file or directory.
 
 
787
    The file_id is assigned when the file is first added and remains the
 
 
788
    same through all revisions where the file exists, even when it is
 
 
792
    takes_args = ['filename']
 
 
793
    def run(self, filename):
 
 
794
        b = find_branch(filename)
 
 
795
        i = b.inventory.path2id(b.relpath(filename))
 
 
797
            raise BzrError("%r is not a versioned file" % filename)
 
 
802
class cmd_file_path(Command):
 
 
803
    """Print path of file_ids to a file or directory.
 
 
805
    This prints one line for each directory down to the target,
 
 
806
    starting at the branch root."""
 
 
808
    takes_args = ['filename']
 
 
809
    def run(self, filename):
 
 
810
        b = find_branch(filename)
 
 
812
        fid = inv.path2id(b.relpath(filename))
 
 
814
            raise BzrError("%r is not a versioned file" % filename)
 
 
815
        for fip in inv.get_idpath(fid):
 
 
819
class cmd_revision_history(Command):
 
 
820
    """Display list of revision ids on this branch."""
 
 
823
        for patchid in find_branch('.').revision_history():
 
 
827
class cmd_directories(Command):
 
 
828
    """Display list of versioned directories in this branch."""
 
 
830
        for name, ie in find_branch('.').read_working_inventory().directories():
 
 
837
class cmd_init(Command):
 
 
838
    """Make a directory into a versioned branch.
 
 
840
    Use this to create an empty branch, or before importing an
 
 
843
    Recipe for importing a tree of files:
 
 
848
        bzr commit -m 'imported project'
 
 
851
        from bzrlib.branch import Branch
 
 
852
        Branch('.', init=True)
 
 
855
class cmd_diff(Command):
 
 
856
    """Show differences in working tree.
 
 
858
    If files are listed, only the changes in those files are listed.
 
 
859
    Otherwise, all changes for the tree are listed.
 
 
861
    TODO: Allow diff across branches.
 
 
863
    TODO: Option to use external diff command; could be GNU diff, wdiff,
 
 
866
    TODO: Python difflib is not exactly the same as unidiff; should
 
 
867
          either fix it up or prefer to use an external diff.
 
 
869
    TODO: If a directory is given, diff everything under that.
 
 
871
    TODO: Selected-file diff is inefficient and doesn't show you
 
 
874
    TODO: This probably handles non-Unix newlines poorly.
 
 
882
    takes_args = ['file*']
 
 
883
    takes_options = ['revision', 'diff-options']
 
 
884
    aliases = ['di', 'dif']
 
 
886
    def run(self, revision=None, file_list=None, diff_options=None):
 
 
887
        from bzrlib.diff import show_diff
 
 
890
            b = find_branch(file_list[0])
 
 
891
            file_list = [b.relpath(f) for f in file_list]
 
 
892
            if file_list == ['']:
 
 
893
                # just pointing to top-of-tree
 
 
898
        if revision is not None:
 
 
899
            if len(revision) == 1:
 
 
900
                show_diff(b, revision[0], specific_files=file_list,
 
 
901
                          external_diff_options=diff_options)
 
 
902
            elif len(revision) == 2:
 
 
903
                show_diff(b, revision[0], specific_files=file_list,
 
 
904
                          external_diff_options=diff_options,
 
 
905
                          revision2=revision[1])
 
 
907
                raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
 
 
909
            show_diff(b, None, specific_files=file_list,
 
 
910
                      external_diff_options=diff_options)
 
 
915
class cmd_deleted(Command):
 
 
916
    """List files deleted in the working tree.
 
 
918
    TODO: Show files deleted since a previous revision, or between two revisions.
 
 
920
    def run(self, show_ids=False):
 
 
923
        new = b.working_tree()
 
 
925
        ## TODO: Much more efficient way to do this: read in new
 
 
926
        ## directories with readdir, rather than stating each one.  Same
 
 
927
        ## level of effort but possibly much less IO.  (Or possibly not,
 
 
928
        ## if the directories are very large...)
 
 
930
        for path, ie in old.inventory.iter_entries():
 
 
931
            if not new.has_id(ie.file_id):
 
 
933
                    print '%-50s %s' % (path, ie.file_id)
 
 
938
class cmd_modified(Command):
 
 
939
    """List files modified in working tree."""
 
 
942
        from bzrlib.delta import compare_trees
 
 
945
        td = compare_trees(b.basis_tree(), b.working_tree())
 
 
947
        for path, id, kind in td.modified:
 
 
952
class cmd_added(Command):
 
 
953
    """List files added in working tree."""
 
 
957
        wt = b.working_tree()
 
 
958
        basis_inv = b.basis_tree().inventory
 
 
961
            if file_id in basis_inv:
 
 
963
            path = inv.id2path(file_id)
 
 
964
            if not os.access(b.abspath(path), os.F_OK):
 
 
970
class cmd_root(Command):
 
 
971
    """Show the tree root directory.
 
 
973
    The root is the nearest enclosing directory with a .bzr control
 
 
975
    takes_args = ['filename?']
 
 
976
    def run(self, filename=None):
 
 
977
        """Print the branch root."""
 
 
978
        b = find_branch(filename)
 
 
979
        print getattr(b, 'base', None) or getattr(b, 'baseurl')
 
 
982
class cmd_log(Command):
 
 
983
    """Show log of this branch.
 
 
985
    To request a range of logs, you can use the command -r begin:end
 
 
986
    -r revision requests a specific revision, -r :end or -r begin: are
 
 
989
    --message allows you to give a regular expression, which will be evaluated
 
 
990
    so that only matching entries will be displayed.
 
 
992
    TODO: Make --revision support uuid: and hash: [future tag:] notation.
 
 
996
    takes_args = ['filename?']
 
 
997
    takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision',
 
 
998
                     'long', 'message', 'short',]
 
 
1000
    def run(self, filename=None, timezone='original',
 
 
1008
        from bzrlib.branch import find_branch
 
 
1009
        from bzrlib.log import log_formatter, show_log
 
 
1012
        direction = (forward and 'forward') or 'reverse'
 
 
1015
            b = find_branch(filename)
 
 
1016
            fp = b.relpath(filename)
 
 
1018
                file_id = b.read_working_inventory().path2id(fp)
 
 
1020
                file_id = None  # points to branch root
 
 
1022
            b = find_branch('.')
 
 
1025
        if revision is None:
 
 
1028
        elif len(revision) == 1:
 
 
1029
            rev1 = rev2 = b.get_revision_info(revision[0])[0]
 
 
1030
        elif len(revision) == 2:
 
 
1031
            rev1 = b.get_revision_info(revision[0])[0]
 
 
1032
            rev2 = b.get_revision_info(revision[1])[0]
 
 
1034
            raise BzrCommandError('bzr log --revision takes one or two values.')
 
 
1041
        mutter('encoding log as %r' % bzrlib.user_encoding)
 
 
1043
        # use 'replace' so that we don't abort if trying to write out
 
 
1044
        # in e.g. the default C locale.
 
 
1045
        outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
 
 
1050
            log_format = 'short'
 
 
1051
        lf = log_formatter(log_format,
 
 
1054
                           show_timezone=timezone)
 
 
1060
                 direction=direction,
 
 
1061
                 start_revision=rev1,
 
 
1067
class cmd_touching_revisions(Command):
 
 
1068
    """Return revision-ids which affected a particular file.
 
 
1070
    A more user-friendly interface is "bzr log FILE"."""
 
 
1072
    takes_args = ["filename"]
 
 
1073
    def run(self, filename):
 
 
1074
        b = find_branch(filename)
 
 
1075
        inv = b.read_working_inventory()
 
 
1076
        file_id = inv.path2id(b.relpath(filename))
 
 
1077
        for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
 
 
1078
            print "%6d %s" % (revno, what)
 
 
1081
class cmd_ls(Command):
 
 
1082
    """List files in a tree.
 
 
1084
    TODO: Take a revision or remote path and list that tree instead.
 
 
1087
    def run(self, revision=None, verbose=False):
 
 
1088
        b = find_branch('.')
 
 
1089
        if revision == None:
 
 
1090
            tree = b.working_tree()
 
 
1092
            tree = b.revision_tree(b.lookup_revision(revision))
 
 
1094
        for fp, fc, kind, fid in tree.list_files():
 
 
1096
                if kind == 'directory':
 
 
1098
                elif kind == 'file':
 
 
1103
                print '%-8s %s%s' % (fc, fp, kindch)
 
 
1109
class cmd_unknowns(Command):
 
 
1110
    """List unknown files."""
 
 
1112
        from bzrlib.osutils import quotefn
 
 
1113
        for f in find_branch('.').unknowns():
 
 
1118
class cmd_ignore(Command):
 
 
1119
    """Ignore a command or pattern.
 
 
1121
    To remove patterns from the ignore list, edit the .bzrignore file.
 
 
1123
    If the pattern contains a slash, it is compared to the whole path
 
 
1124
    from the branch root.  Otherwise, it is comapred to only the last
 
 
1125
    component of the path.
 
 
1127
    Ignore patterns are case-insensitive on case-insensitive systems.
 
 
1129
    Note: wildcards must be quoted from the shell on Unix.
 
 
1132
        bzr ignore ./Makefile
 
 
1133
        bzr ignore '*.class'
 
 
1135
    takes_args = ['name_pattern']
 
 
1137
    def run(self, name_pattern):
 
 
1138
        from bzrlib.atomicfile import AtomicFile
 
 
1141
        b = find_branch('.')
 
 
1142
        ifn = b.abspath('.bzrignore')
 
 
1144
        if os.path.exists(ifn):
 
 
1147
                igns = f.read().decode('utf-8')
 
 
1153
        # TODO: If the file already uses crlf-style termination, maybe
 
 
1154
        # we should use that for the newly added lines?
 
 
1156
        if igns and igns[-1] != '\n':
 
 
1158
        igns += name_pattern + '\n'
 
 
1161
            f = AtomicFile(ifn, 'wt')
 
 
1162
            f.write(igns.encode('utf-8'))
 
 
1167
        inv = b.working_tree().inventory
 
 
1168
        if inv.path2id('.bzrignore'):
 
 
1169
            mutter('.bzrignore is already versioned')
 
 
1171
            mutter('need to make new .bzrignore file versioned')
 
 
1172
            b.add(['.bzrignore'])
 
 
1176
class cmd_ignored(Command):
 
 
1177
    """List ignored files and the patterns that matched them.
 
 
1179
    See also: bzr ignore"""
 
 
1181
        tree = find_branch('.').working_tree()
 
 
1182
        for path, file_class, kind, file_id in tree.list_files():
 
 
1183
            if file_class != 'I':
 
 
1185
            ## XXX: Slightly inefficient since this was already calculated
 
 
1186
            pat = tree.is_ignored(path)
 
 
1187
            print '%-50s %s' % (path, pat)
 
 
1190
class cmd_lookup_revision(Command):
 
 
1191
    """Lookup the revision-id from a revision-number
 
 
1194
        bzr lookup-revision 33
 
 
1197
    takes_args = ['revno']
 
 
1199
    def run(self, revno):
 
 
1203
            raise BzrCommandError("not a valid revision-number: %r" % revno)
 
 
1205
        print find_branch('.').lookup_revision(revno)
 
 
1208
class cmd_export(Command):
 
 
1209
    """Export past revision to destination directory.
 
 
1211
    If no revision is specified this exports the last committed revision.
 
 
1213
    Format may be an "exporter" name, such as tar, tgz, tbz2.  If none is
 
 
1214
    given, try to find the format with the extension. If no extension
 
 
1215
    is found exports to a directory (equivalent to --format=dir).
 
 
1217
    Root may be the top directory for tar, tgz and tbz2 formats. If none
 
 
1218
    is given, the top directory will be the root name of the file."""
 
 
1219
    # TODO: list known exporters
 
 
1220
    takes_args = ['dest']
 
 
1221
    takes_options = ['revision', 'format', 'root']
 
 
1222
    def run(self, dest, revision=None, format=None, root=None):
 
 
1224
        b = find_branch('.')
 
 
1225
        if revision is None:
 
 
1226
            rev_id = b.last_patch()
 
 
1228
            if len(revision) != 1:
 
 
1229
                raise BzrError('bzr export --revision takes exactly 1 argument')
 
 
1230
            revno, rev_id = b.get_revision_info(revision[0])
 
 
1231
        t = b.revision_tree(rev_id)
 
 
1232
        root, ext = os.path.splitext(dest)
 
 
1234
            if ext in (".tar",):
 
 
1236
            elif ext in (".gz", ".tgz"):
 
 
1238
            elif ext in (".bz2", ".tbz2"):
 
 
1242
        t.export(dest, format, root)
 
 
1245
class cmd_cat(Command):
 
 
1246
    """Write a file's text from a previous revision."""
 
 
1248
    takes_options = ['revision']
 
 
1249
    takes_args = ['filename']
 
 
1251
    def run(self, filename, revision=None):
 
 
1252
        if revision == None:
 
 
1253
            raise BzrCommandError("bzr cat requires a revision number")
 
 
1254
        elif len(revision) != 1:
 
 
1255
            raise BzrCommandError("bzr cat --revision takes exactly one number")
 
 
1256
        b = find_branch('.')
 
 
1257
        b.print_file(b.relpath(filename), revision[0])
 
 
1260
class cmd_local_time_offset(Command):
 
 
1261
    """Show the offset in seconds from GMT to local time."""
 
 
1264
        print bzrlib.osutils.local_time_offset()
 
 
1268
class cmd_commit(Command):
 
 
1269
    """Commit changes into a new revision.
 
 
1271
    If no arguments are given, the entire tree is committed.
 
 
1273
    If selected files are specified, only changes to those files are
 
 
1274
    committed.  If a directory is specified then the directory and everything 
 
 
1275
    within it is committed.
 
 
1277
    A selected-file commit may fail in some cases where the committed
 
 
1278
    tree would be invalid, such as trying to commit a file in a
 
 
1279
    newly-added directory that is not itself committed.
 
 
1281
    TODO: Run hooks on tree to-be-committed, and after commit.
 
 
1283
    TODO: Strict commit that fails if there are unknown or deleted files.
 
 
1285
    takes_args = ['selected*']
 
 
1286
    takes_options = ['message', 'file', 'verbose', 'unchanged']
 
 
1287
    aliases = ['ci', 'checkin']
 
 
1289
    # TODO: Give better message for -s, --summary, used by tla people
 
 
1291
    def run(self, message=None, file=None, verbose=True, selected_list=None,
 
 
1293
        from bzrlib.errors import PointlessCommit
 
 
1294
        from bzrlib.osutils import get_text_message
 
 
1296
        ## Warning: shadows builtin file()
 
 
1297
        if not message and not file:
 
 
1298
            # FIXME: Ugly; change status code to send to a provided function?
 
 
1302
            catcher = cStringIO.StringIO()
 
 
1303
            sys.stdout = catcher
 
 
1304
            cmd_status({"file_list":selected_list}, {})
 
 
1305
            info = catcher.getvalue()
 
 
1307
            message = get_text_message(info)
 
 
1310
                raise BzrCommandError("please specify a commit message",
 
 
1311
                                      ["use either --message or --file"])
 
 
1312
        elif message and file:
 
 
1313
            raise BzrCommandError("please specify either --message or --file")
 
 
1317
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
 
 
1319
        b = find_branch('.')
 
 
1321
            selected_list = [b.relpath(s) for s in selected_list]
 
 
1324
            b.commit(message, verbose=verbose,
 
 
1325
                     specific_files=selected_list,
 
 
1326
                     allow_pointless=unchanged)
 
 
1327
        except PointlessCommit:
 
 
1328
            # FIXME: This should really happen before the file is read in;
 
 
1329
            # perhaps prepare the commit; get the message; then actually commit
 
 
1330
            raise BzrCommandError("no changes to commit",
 
 
1331
                                  ["use --unchanged to commit anyhow"])
 
 
1334
class cmd_check(Command):
 
 
1335
    """Validate consistency of branch history.
 
 
1337
    This command checks various invariants about the branch storage to
 
 
1338
    detect data corruption or bzr bugs.
 
 
1340
    If given the --update flag, it will update some optional fields
 
 
1341
    to help ensure data consistency.
 
 
1343
    takes_args = ['dir?']
 
 
1345
    def run(self, dir='.'):
 
 
1346
        from bzrlib.check import check
 
 
1348
        check(find_branch(dir))
 
 
1351
class cmd_scan_cache(Command):
 
 
1354
        from bzrlib.hashcache import HashCache
 
 
1361
        print '%6d stats' % c.stat_count
 
 
1362
        print '%6d in hashcache' % len(c._cache)
 
 
1363
        print '%6d files removed from cache' % c.removed_count
 
 
1364
        print '%6d hashes updated' % c.update_count
 
 
1365
        print '%6d files changed too recently to cache' % c.danger_count
 
 
1372
class cmd_upgrade(Command):
 
 
1373
    """Upgrade branch storage to current format.
 
 
1375
    This should normally be used only after the check command tells
 
 
1378
    takes_args = ['dir?']
 
 
1380
    def run(self, dir='.'):
 
 
1381
        from bzrlib.upgrade import upgrade
 
 
1382
        upgrade(find_branch(dir))
 
 
1386
class cmd_whoami(Command):
 
 
1387
    """Show bzr user id."""
 
 
1388
    takes_options = ['email']
 
 
1390
    def run(self, email=False):
 
 
1392
            b = bzrlib.branch.find_branch('.')
 
 
1397
            print bzrlib.osutils.user_email(b)
 
 
1399
            print bzrlib.osutils.username(b)
 
 
1402
class cmd_selftest(Command):
 
 
1403
    """Run internal test suite"""
 
 
1405
    takes_options = ['verbose']
 
 
1406
    def run(self, verbose=False):
 
 
1408
        from bzrlib.selftest import selftest
 
 
1410
        # we don't want progress meters from the tests to go to the
 
 
1413
        save_ui = bzrlib.ui.ui_factory
 
 
1415
            bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
 
 
1416
            return int(not selftest(verbose=verbose))
 
 
1418
            bzrlib.ui.ui_factory = save_ui
 
 
1421
class cmd_version(Command):
 
 
1422
    """Show version of bzr."""
 
 
1427
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
 
 
1428
    # is bzrlib itself in a branch?
 
 
1429
    bzrrev = bzrlib.get_bzr_revision()
 
 
1431
        print "  (bzr checkout, revision %d {%s})" % bzrrev
 
 
1432
    print bzrlib.__copyright__
 
 
1433
    print "http://bazaar-ng.org/"
 
 
1435
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
 
 
1436
    print "you may use, modify and redistribute it under the terms of the GNU"
 
 
1437
    print "General Public License version 2 or later."
 
 
1440
class cmd_rocks(Command):
 
 
1441
    """Statement of optimism."""
 
 
1444
        print "it sure does!"
 
 
1446
def parse_spec(spec):
 
 
1448
    >>> parse_spec(None)
 
 
1450
    >>> parse_spec("./")
 
 
1452
    >>> parse_spec("../@")
 
 
1454
    >>> parse_spec("../f/@35")
 
 
1456
    >>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
 
 
1457
    ['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
 
 
1462
        parsed = spec.split('/@')
 
 
1463
        assert len(parsed) == 2
 
 
1468
                parsed[1] = int(parsed[1])
 
 
1470
                pass # We can allow stuff like ./@revid:blahblahblah
 
 
1472
                assert parsed[1] >=0
 
 
1474
        parsed = [spec, None]
 
 
1479
class cmd_find_merge_base(Command):
 
 
1480
    """Find and print a base revision for merging two branches.
 
 
1482
    TODO: Options to specify revisions on either side, as if
 
 
1483
          merging only part of the history.
 
 
1485
    takes_args = ['branch', 'other']
 
 
1488
    def run(self, branch, other):
 
 
1489
        branch1 = find_branch(branch)
 
 
1490
        branch2 = find_branch(other)
 
 
1492
        base_revno, base_revid = branch1.common_ancestor(branch2)
 
 
1494
        if base_revno is None:
 
 
1495
            raise bzrlib.errors.UnrelatedBranches()
 
 
1497
        print 'merge base is revision %s' % base_revid
 
 
1498
        print ' r%-6d in %s' % (base_revno, branch)
 
 
1500
        other_revno = branch2.revision_id_to_revno(base_revid)
 
 
1502
        print ' r%-6d in %s' % (other_revno, other)
 
 
1506
class cmd_merge(Command):
 
 
1507
    """Perform a three-way merge.
 
 
1509
    The branch is the branch you will merge from.  By default, it will merge
 
 
1510
    the latest revision.  If you specify a revision, that revision will be
 
 
1511
    merged.  If you specify two revisions, the first will be used as a BASE, 
 
 
1512
    and the second one as OTHER.  Revision numbers are always relative to the
 
 
1517
    To merge the latest revision from bzr.dev
 
 
1518
    bzr merge ../bzr.dev
 
 
1520
    To merge changes up to and including revision 82 from bzr.dev
 
 
1521
    bzr merge -r 82 ../bzr.dev
 
 
1523
    To merge the changes introduced by 82, without previous changes:
 
 
1524
    bzr merge -r 81..82 ../bzr.dev
 
 
1526
    merge refuses to run if there are any uncommitted changes, unless
 
 
1529
    takes_args = ['branch?']
 
 
1530
    takes_options = ['revision', 'force', 'merge-type']
 
 
1532
    def run(self, branch='.', revision=None, force=False, 
 
 
1534
        from bzrlib.merge import merge
 
 
1535
        from bzrlib.merge_core import ApplyMerge3
 
 
1536
        if merge_type is None:
 
 
1537
            merge_type = ApplyMerge3
 
 
1539
        if revision is None or len(revision) < 1:
 
 
1541
            other = (branch, -1)
 
 
1543
            if len(revision) == 1:
 
 
1544
                other = (branch, revision[0])
 
 
1547
                assert len(revision) == 2
 
 
1548
                if None in revision:
 
 
1549
                    raise BzrCommandError(
 
 
1550
                        "Merge doesn't permit that revision specifier.")
 
 
1551
                base = (branch, revision[0])
 
 
1552
                other = (branch, revision[1])
 
 
1554
        merge(other, base, check_clean=(not force), merge_type=merge_type)
 
 
1557
class cmd_revert(Command):
 
 
1558
    """Reverse all changes since the last commit.
 
 
1560
    Only versioned files are affected.  Specify filenames to revert only 
 
 
1561
    those files.  By default, any files that are changed will be backed up
 
 
1562
    first.  Backup files have a '~' appended to their name.
 
 
1564
    takes_options = ['revision', 'no-backup']
 
 
1565
    takes_args = ['file*']
 
 
1566
    aliases = ['merge-revert']
 
 
1568
    def run(self, revision=None, no_backup=False, file_list=None):
 
 
1569
        from bzrlib.merge import merge
 
 
1570
        if file_list is not None:
 
 
1571
            if len(file_list) == 0:
 
 
1572
                raise BzrCommandError("No files specified")
 
 
1573
        if revision is None:
 
 
1575
        elif len(revision) != 1:
 
 
1576
            raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
 
 
1577
        merge(('.', revision[0]), parse_spec('.'),
 
 
1580
              backup_files=not no_backup,
 
 
1581
              file_list=file_list)
 
 
1584
class cmd_assert_fail(Command):
 
 
1585
    """Test reporting of assertion failures"""
 
 
1588
        assert False, "always fails"
 
 
1591
class cmd_help(Command):
 
 
1592
    """Show help on a command or other topic.
 
 
1594
    For a list of all available commands, say 'bzr help commands'."""
 
 
1595
    takes_options = ['long']
 
 
1596
    takes_args = ['topic?']
 
 
1599
    def run(self, topic=None, long=False):
 
 
1601
        if topic is None and long:
 
 
1606
class cmd_shell_complete(Command):
 
 
1607
    """Show appropriate completions for context.
 
 
1609
    For a list of all available commands, say 'bzr shell-complete'."""
 
 
1610
    takes_args = ['context?']
 
 
1614
    def run(self, context=None):
 
 
1615
        import shellcomplete
 
 
1616
        shellcomplete.shellcomplete(context)
 
 
1619
class cmd_missing(Command):
 
 
1620
    """What is missing in this branch relative to other branch.
 
 
1622
    takes_args = ['remote?']
 
 
1623
    aliases = ['mis', 'miss']
 
 
1624
    # We don't have to add quiet to the list, because 
 
 
1625
    # unknown options are parsed as booleans
 
 
1626
    takes_options = ['verbose', 'quiet']
 
 
1628
    def run(self, remote=None, verbose=False, quiet=False):
 
 
1629
        from bzrlib.branch import find_branch, DivergedBranches
 
 
1630
        from bzrlib.errors import BzrCommandError
 
 
1631
        from bzrlib.missing import get_parent, show_missing
 
 
1633
        if verbose and quiet:
 
 
1634
            raise BzrCommandError('Cannot pass both quiet and verbose')
 
 
1636
        b = find_branch('.')
 
 
1637
        parent = get_parent(b)
 
 
1640
                raise BzrCommandError("No missing location known or specified.")
 
 
1643
                    print "Using last location: %s" % parent
 
 
1645
        elif parent is None:
 
 
1646
            # We only update x-pull if it did not exist, missing should not change the parent
 
 
1647
            b.controlfile('x-pull', 'wb').write(remote + '\n')
 
 
1648
        br_remote = find_branch(remote)
 
 
1650
        return show_missing(b, br_remote, verbose=verbose, quiet=quiet)
 
 
1654
class cmd_plugins(Command):
 
 
1658
        import bzrlib.plugin
 
 
1659
        from inspect import getdoc
 
 
1660
        from pprint import pprint
 
 
1661
        for plugin in bzrlib.plugin.all_plugins:
 
 
1662
            print plugin.__path__[0]
 
 
1665
                print '\t', d.split('\n')[0]
 
 
1667
        #pprint(bzrlib.plugin.all_plugins)
 
 
1671
# list of all available options; the rhs can be either None for an
 
 
1672
# option that takes no argument, or a constructor function that checks
 
 
1676
    'diff-options':           str,
 
 
1685
    'revision':               _parse_revision_str,
 
 
1697
    'merge-type':             get_merge_type,
 
 
1710
def parse_args(argv):
 
 
1711
    """Parse command line.
 
 
1713
    Arguments and options are parsed at this level before being passed
 
 
1714
    down to specific command handlers.  This routine knows, from a
 
 
1715
    lookup table, something about the available options, what optargs
 
 
1716
    they take, and which commands will accept them.
 
 
1718
    >>> parse_args('--help'.split())
 
 
1719
    ([], {'help': True})
 
 
1720
    >>> parse_args('--version'.split())
 
 
1721
    ([], {'version': True})
 
 
1722
    >>> parse_args('status --all'.split())
 
 
1723
    (['status'], {'all': True})
 
 
1724
    >>> parse_args('commit --message=biter'.split())
 
 
1725
    (['commit'], {'message': u'biter'})
 
 
1726
    >>> parse_args('log -r 500'.split())
 
 
1727
    (['log'], {'revision': [500]})
 
 
1728
    >>> parse_args('log -r500..600'.split())
 
 
1729
    (['log'], {'revision': [500, 600]})
 
 
1730
    >>> parse_args('log -vr500..600'.split())
 
 
1731
    (['log'], {'verbose': True, 'revision': [500, 600]})
 
 
1732
    >>> parse_args('log -rv500..600'.split()) #the r takes an argument
 
 
1733
    (['log'], {'revision': ['v500', 600]})
 
 
1738
    # TODO: Maybe handle '--' to end options?
 
 
1743
            # option names must not be unicode
 
 
1747
                mutter("  got option %r" % a)
 
 
1749
                    optname, optarg = a[2:].split('=', 1)
 
 
1752
                if optname not in OPTIONS:
 
 
1753
                    raise BzrError('unknown long option %r' % a)
 
 
1756
                if shortopt in SHORT_OPTIONS:
 
 
1757
                    # Multi-character options must have a space to delimit
 
 
1759
                    optname = SHORT_OPTIONS[shortopt]
 
 
1761
                    # Single character short options, can be chained,
 
 
1762
                    # and have their value appended to their name
 
 
1764
                    if shortopt not in SHORT_OPTIONS:
 
 
1765
                        # We didn't find the multi-character name, and we
 
 
1766
                        # didn't find the single char name
 
 
1767
                        raise BzrError('unknown short option %r' % a)
 
 
1768
                    optname = SHORT_OPTIONS[shortopt]
 
 
1771
                        # There are extra things on this option
 
 
1772
                        # see if it is the value, or if it is another
 
 
1774
                        optargfn = OPTIONS[optname]
 
 
1775
                        if optargfn is None:
 
 
1776
                            # This option does not take an argument, so the
 
 
1777
                            # next entry is another short option, pack it back
 
 
1779
                            argv.insert(0, '-' + a[2:])
 
 
1781
                            # This option takes an argument, so pack it
 
 
1786
                # XXX: Do we ever want to support this, e.g. for -r?
 
 
1787
                raise BzrError('repeated option %r' % a)
 
 
1789
            optargfn = OPTIONS[optname]
 
 
1793
                        raise BzrError('option %r needs an argument' % a)
 
 
1795
                        optarg = argv.pop(0)
 
 
1796
                opts[optname] = optargfn(optarg)
 
 
1799
                    raise BzrError('option %r takes no argument' % optname)
 
 
1800
                opts[optname] = True
 
 
1809
def _match_argform(cmd, takes_args, args):
 
 
1812
    # step through args and takes_args, allowing appropriate 0-many matches
 
 
1813
    for ap in takes_args:
 
 
1817
                argdict[argname] = args.pop(0)
 
 
1818
        elif ap[-1] == '*': # all remaining arguments
 
 
1820
                argdict[argname + '_list'] = args[:]
 
 
1823
                argdict[argname + '_list'] = None
 
 
1826
                raise BzrCommandError("command %r needs one or more %s"
 
 
1827
                        % (cmd, argname.upper()))
 
 
1829
                argdict[argname + '_list'] = args[:]
 
 
1831
        elif ap[-1] == '$': # all but one
 
 
1833
                raise BzrCommandError("command %r needs one or more %s"
 
 
1834
                        % (cmd, argname.upper()))
 
 
1835
            argdict[argname + '_list'] = args[:-1]
 
 
1841
                raise BzrCommandError("command %r requires argument %s"
 
 
1842
                        % (cmd, argname.upper()))
 
 
1844
                argdict[argname] = args.pop(0)
 
 
1847
        raise BzrCommandError("extra argument to command %s: %s"
 
 
1855
    """Execute a command.
 
 
1857
    This is similar to main(), but without all the trappings for
 
 
1858
    logging and error handling.  
 
 
1861
       The command-line arguments, without the program name from argv[0]
 
 
1863
    Returns a command status or raises an exception.
 
 
1865
    Special master options: these must come before the command because
 
 
1866
    they control how the command is interpreted.
 
 
1869
        Do not load plugin modules at all
 
 
1872
        Only use builtin commands.  (Plugins are still allowed to change
 
 
1876
        Run under the Python profiler.
 
 
1879
    argv = [a.decode(bzrlib.user_encoding) for a in argv]
 
 
1881
    opt_profile = opt_no_plugins = opt_builtin = False
 
 
1883
    # --no-plugins is handled specially at a very early stage. We need
 
 
1884
    # to load plugins before doing other command parsing so that they
 
 
1885
    # can override commands, but this needs to happen first.
 
 
1888
        if a == '--profile':
 
 
1890
        elif a == '--no-plugins':
 
 
1891
            opt_no_plugins = True
 
 
1892
        elif a == '--builtin':
 
 
1898
    if not opt_no_plugins:
 
 
1899
        from bzrlib.plugin import load_plugins
 
 
1902
    args, opts = parse_args(argv)
 
 
1905
        from bzrlib.help import help
 
 
1912
    if 'version' in opts:
 
 
1917
        from bzrlib.help import help
 
 
1921
    cmd = str(args.pop(0))
 
 
1923
    canonical_cmd, cmd_class = \
 
 
1924
                   get_cmd_class(cmd, plugins_override=not opt_builtin)
 
 
1926
    # check options are reasonable
 
 
1927
    allowed = cmd_class.takes_options
 
 
1929
        if oname not in allowed:
 
 
1930
            raise BzrCommandError("option '--%s' is not allowed for command %r"
 
 
1933
    # mix arguments and options into one dictionary
 
 
1934
    cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
 
 
1936
    for k, v in opts.items():
 
 
1937
        cmdopts[k.replace('-', '_')] = v
 
 
1940
        import hotshot, tempfile
 
 
1941
        pffileno, pfname = tempfile.mkstemp()
 
 
1943
            prof = hotshot.Profile(pfname)
 
 
1944
            ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
 
 
1947
            import hotshot.stats
 
 
1948
            stats = hotshot.stats.load(pfname)
 
 
1950
            stats.sort_stats('time')
 
 
1951
            ## XXX: Might like to write to stderr or the trace file instead but
 
 
1952
            ## print_stats seems hardcoded to stdout
 
 
1953
            stats.print_stats(20)
 
 
1961
        return cmd_class(cmdopts, cmdargs).status 
 
 
1967
    bzrlib.trace.open_tracefile(argv)
 
 
1969
    bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
 
 
1973
            return run_bzr(argv[1:])
 
 
1975
            # do this here inside the exception wrappers to catch EPIPE
 
 
1977
    except BzrCommandError, e:
 
 
1978
        # command line syntax error, etc
 
 
1982
        bzrlib.trace.log_exception()
 
 
1984
    except AssertionError, e:
 
 
1985
        bzrlib.trace.log_exception('assertion failed: ' + str(e))
 
 
1987
    except KeyboardInterrupt, e:
 
 
1988
        bzrlib.trace.note('interrupted')
 
 
1990
    except Exception, e:
 
 
1992
        if (isinstance(e, IOError) 
 
 
1993
            and hasattr(e, 'errno')
 
 
1994
            and e.errno == errno.EPIPE):
 
 
1995
            bzrlib.trace.note('broken pipe')
 
 
1998
            bzrlib.trace.log_exception()
 
 
2002
if __name__ == '__main__':
 
 
2003
    sys.exit(main(sys.argv))