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
 
 
19
import sys, os, time, os.path
 
 
23
from bzrlib.trace import mutter, note, log_error
 
 
24
from bzrlib.errors import bailout, BzrError, BzrCheckError, BzrCommandError
 
 
25
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
 
 
26
from bzrlib.tree import RevisionTree, EmptyTree, Tree
 
 
27
from bzrlib.revision import Revision
 
 
28
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
 
 
30
from bzrlib import merge
 
 
33
def _squish_command_name(cmd):
 
 
34
    return 'cmd_' + cmd.replace('-', '_')
 
 
37
def _unsquish_command_name(cmd):
 
 
38
    assert cmd.startswith("cmd_")
 
 
39
    return cmd[4:].replace('_','-')
 
 
42
    """Return canonical name and class for all registered commands."""
 
 
43
    for k, v in globals().iteritems():
 
 
44
        if k.startswith("cmd_"):
 
 
45
            yield _unsquish_command_name(k), v
 
 
47
def get_cmd_class(cmd):
 
 
48
    """Return the canonical name and command class for a command.
 
 
50
    cmd = str(cmd)                      # not unicode
 
 
52
    # first look up this command under the specified name
 
 
54
        return cmd, globals()[_squish_command_name(cmd)]
 
 
58
    # look for any command which claims this as an alias
 
 
59
    for cmdname, cmdclass in get_all_cmds():
 
 
60
        if cmd in cmdclass.aliases:
 
 
61
            return cmdname, cmdclass
 
 
63
    cmdclass = ExternalCommand.find_command(cmd)
 
 
67
    raise BzrCommandError("unknown command %r" % cmd)
 
 
71
    """Base class for commands.
 
 
73
    The docstring for an actual command should give a single-line
 
 
74
    summary, then a complete description of the command.  A grammar
 
 
75
    description will be inserted.
 
 
78
        List of argument forms, marked with whether they are optional,
 
 
82
        List of options that may be given for this command.
 
 
85
        If true, this command isn't advertised.
 
 
94
    def __init__(self, options, arguments):
 
 
95
        """Construct and run the command.
 
 
97
        Sets self.status to the return value of run()."""
 
 
98
        assert isinstance(options, dict)
 
 
99
        assert isinstance(arguments, dict)
 
 
100
        cmdargs = options.copy()
 
 
101
        cmdargs.update(arguments)
 
 
102
        assert self.__doc__ != Command.__doc__, \
 
 
103
               ("No help message set for %r" % self)
 
 
104
        self.status = self.run(**cmdargs)
 
 
108
        """Override this in sub-classes.
 
 
110
        This is invoked with the options and arguments bound to
 
 
113
        Return 0 or None if the command was successful, or a shell
 
 
119
class ExternalCommand(Command):
 
 
120
    """Class to wrap external commands.
 
 
122
    We cheat a little here, when get_cmd_class() calls us we actually give it back
 
 
123
    an object we construct that has the appropriate path, help, options etc for the
 
 
126
    When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
 
 
127
    method, which we override to call the Command.__init__ method. That then calls
 
 
128
    our run method which is pretty straight forward.
 
 
130
    The only wrinkle is that we have to map bzr's dictionary of options and arguments
 
 
131
    back into command line options and arguments for the script.
 
 
134
    def find_command(cls, cmd):
 
 
135
        bzrpath = os.environ.get('BZRPATH', '')
 
 
137
        for dir in bzrpath.split(':'):
 
 
138
            path = os.path.join(dir, cmd)
 
 
139
            if os.path.isfile(path):
 
 
140
                return ExternalCommand(path)
 
 
144
    find_command = classmethod(find_command)
 
 
146
    def __init__(self, path):
 
 
149
        # TODO: If either of these fail, we should detect that and
 
 
150
        # assume that path is not really a bzr plugin after all.
 
 
152
        pipe = os.popen('%s --bzr-usage' % path, 'r')
 
 
153
        self.takes_options = pipe.readline().split()
 
 
154
        self.takes_args = pipe.readline().split()
 
 
157
        pipe = os.popen('%s --bzr-help' % path, 'r')
 
 
158
        self.__doc__ = pipe.read()
 
 
161
    def __call__(self, options, arguments):
 
 
162
        Command.__init__(self, options, arguments)
 
 
165
    def run(self, **kargs):
 
 
173
            if OPTIONS.has_key(name):
 
 
175
                opts.append('--%s' % name)
 
 
176
                if value is not None and value is not True:
 
 
177
                    opts.append(str(value))
 
 
179
                # it's an arg, or arg list
 
 
180
                if type(value) is not list:
 
 
186
        self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
 
 
190
class cmd_status(Command):
 
 
191
    """Display status summary.
 
 
193
    This reports on versioned and unknown files, reporting them
 
 
194
    grouped by state.  Possible states are:
 
 
197
        Versioned in the working copy but not in the previous revision.
 
 
200
        Versioned in the previous revision but removed or deleted
 
 
204
        Path of this file changed from the previous revision;
 
 
205
        the text may also have changed.  This includes files whose
 
 
206
        parent directory was renamed.
 
 
209
        Text has changed since the previous revision.
 
 
212
        Nothing about this file has changed since the previous revision.
 
 
213
        Only shown with --all.
 
 
216
        Not versioned and not matching an ignore pattern.
 
 
218
    To see ignored files use 'bzr ignored'.  For details in the
 
 
219
    changes to file texts, use 'bzr diff'.
 
 
221
    If no arguments are specified, the status of the entire working
 
 
222
    directory is shown.  Otherwise, only the status of the specified
 
 
223
    files or directories is reported.  If a directory is given, status
 
 
224
    is reported for everything inside that directory.
 
 
226
    takes_args = ['file*']
 
 
227
    takes_options = ['all', 'show-ids']
 
 
228
    aliases = ['st', 'stat']
 
 
230
    def run(self, all=False, show_ids=False, file_list=None):
 
 
232
            b = Branch(file_list[0], lock_mode='r')
 
 
233
            file_list = [b.relpath(x) for x in file_list]
 
 
234
            # special case: only one path was given and it's the root
 
 
236
            if file_list == ['']:
 
 
239
            b = Branch('.', lock_mode='r')
 
 
241
        status.show_status(b, show_unchanged=all, show_ids=show_ids,
 
 
242
                           specific_files=file_list)
 
 
245
class cmd_cat_revision(Command):
 
 
246
    """Write out metadata for a revision."""
 
 
249
    takes_args = ['revision_id']
 
 
251
    def run(self, revision_id):
 
 
252
        Branch('.').get_revision(revision_id).write_xml(sys.stdout)
 
 
255
class cmd_revno(Command):
 
 
256
    """Show current revision number.
 
 
258
    This is equal to the number of revisions on this branch."""
 
 
260
        print Branch('.').revno()
 
 
263
class cmd_add(Command):
 
 
264
    """Add specified files or directories.
 
 
266
    In non-recursive mode, all the named items are added, regardless
 
 
267
    of whether they were previously ignored.  A warning is given if
 
 
268
    any of the named files are already versioned.
 
 
270
    In recursive mode (the default), files are treated the same way
 
 
271
    but the behaviour for directories is different.  Directories that
 
 
272
    are already versioned do not give a warning.  All directories,
 
 
273
    whether already versioned or not, are searched for files or
 
 
274
    subdirectories that are neither versioned or ignored, and these
 
 
275
    are added.  This search proceeds recursively into versioned
 
 
278
    Therefore simply saying 'bzr add .' will version all files that
 
 
279
    are currently unknown.
 
 
281
    TODO: Perhaps adding a file whose directly is not versioned should
 
 
282
    recursively add that parent, rather than giving an error?
 
 
284
    takes_args = ['file+']
 
 
285
    takes_options = ['verbose']
 
 
287
    def run(self, file_list, verbose=False):
 
 
288
        bzrlib.add.smart_add(file_list, verbose)
 
 
291
class cmd_relpath(Command):
 
 
292
    """Show path of a file relative to root"""
 
 
293
    takes_args = ['filename']
 
 
295
    def run(self, filename):
 
 
296
        print Branch(filename).relpath(filename)
 
 
300
class cmd_inventory(Command):
 
 
301
    """Show inventory of the current working copy or a revision."""
 
 
302
    takes_options = ['revision']
 
 
304
    def run(self, revision=None):
 
 
307
            inv = b.read_working_inventory()
 
 
309
            inv = b.get_revision_inventory(b.lookup_revision(revision))
 
 
311
        for path, entry in inv.iter_entries():
 
 
312
            print '%-50s %s' % (entry.file_id, path)
 
 
315
class cmd_move(Command):
 
 
316
    """Move files to a different directory.
 
 
321
    The destination must be a versioned directory in the same branch.
 
 
323
    takes_args = ['source$', 'dest']
 
 
324
    def run(self, source_list, dest):
 
 
327
        b.move([b.relpath(s) for s in source_list], b.relpath(dest))
 
 
330
class cmd_rename(Command):
 
 
331
    """Change the name of an entry.
 
 
334
      bzr rename frob.c frobber.c
 
 
335
      bzr rename src/frob.c lib/frob.c
 
 
337
    It is an error if the destination name exists.
 
 
339
    See also the 'move' command, which moves files into a different
 
 
340
    directory without changing their name.
 
 
342
    TODO: Some way to rename multiple files without invoking bzr for each
 
 
344
    takes_args = ['from_name', 'to_name']
 
 
346
    def run(self, from_name, to_name):
 
 
348
        b.rename_one(b.relpath(from_name), b.relpath(to_name))
 
 
352
class cmd_renames(Command):
 
 
353
    """Show list of renamed files.
 
 
355
    TODO: Option to show renames between two historical versions.
 
 
357
    TODO: Only show renames under dir, rather than in the whole branch.
 
 
359
    takes_args = ['dir?']
 
 
361
    def run(self, dir='.'):
 
 
363
        old_inv = b.basis_tree().inventory
 
 
364
        new_inv = b.read_working_inventory()
 
 
366
        renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
 
 
368
        for old_name, new_name in renames:
 
 
369
            print "%s => %s" % (old_name, new_name)        
 
 
372
class cmd_info(Command):
 
 
373
    """Show statistical information about a branch."""
 
 
374
    takes_args = ['branch?']
 
 
376
    def run(self, branch=None):
 
 
379
        from branch import find_branch
 
 
380
        b = find_branch(branch)
 
 
384
class cmd_remove(Command):
 
 
385
    """Make a file unversioned.
 
 
387
    This makes bzr stop tracking changes to a versioned file.  It does
 
 
388
    not delete the working copy.
 
 
390
    takes_args = ['file+']
 
 
391
    takes_options = ['verbose']
 
 
393
    def run(self, file_list, verbose=False):
 
 
394
        b = Branch(file_list[0])
 
 
395
        b.remove([b.relpath(f) for f in file_list], verbose=verbose)
 
 
398
class cmd_file_id(Command):
 
 
399
    """Print file_id of a particular file or directory.
 
 
401
    The file_id is assigned when the file is first added and remains the
 
 
402
    same through all revisions where the file exists, even when it is
 
 
406
    takes_args = ['filename']
 
 
407
    def run(self, filename):
 
 
409
        i = b.inventory.path2id(b.relpath(filename))
 
 
411
            bailout("%r is not a versioned file" % filename)
 
 
416
class cmd_file_path(Command):
 
 
417
    """Print path of file_ids to a file or directory.
 
 
419
    This prints one line for each directory down to the target,
 
 
420
    starting at the branch root."""
 
 
422
    takes_args = ['filename']
 
 
423
    def run(self, filename):
 
 
426
        fid = inv.path2id(b.relpath(filename))
 
 
428
            bailout("%r is not a versioned file" % filename)
 
 
429
        for fip in inv.get_idpath(fid):
 
 
433
class cmd_revision_history(Command):
 
 
434
    """Display list of revision ids on this branch."""
 
 
436
        for patchid in Branch('.').revision_history():
 
 
440
class cmd_directories(Command):
 
 
441
    """Display list of versioned directories in this branch."""
 
 
443
        for name, ie in Branch('.').read_working_inventory().directories():
 
 
450
class cmd_init(Command):
 
 
451
    """Make a directory into a versioned branch.
 
 
453
    Use this to create an empty branch, or before importing an
 
 
456
    Recipe for importing a tree of files:
 
 
461
        bzr commit -m 'imported project'
 
 
464
        Branch('.', init=True)
 
 
467
class cmd_diff(Command):
 
 
468
    """Show differences in working tree.
 
 
470
    If files are listed, only the changes in those files are listed.
 
 
471
    Otherwise, all changes for the tree are listed.
 
 
473
    TODO: Given two revision arguments, show the difference between them.
 
 
475
    TODO: Allow diff across branches.
 
 
477
    TODO: Option to use external diff command; could be GNU diff, wdiff,
 
 
480
    TODO: Python difflib is not exactly the same as unidiff; should
 
 
481
          either fix it up or prefer to use an external diff.
 
 
483
    TODO: If a directory is given, diff everything under that.
 
 
485
    TODO: Selected-file diff is inefficient and doesn't show you
 
 
488
    TODO: This probably handles non-Unix newlines poorly.
 
 
491
    takes_args = ['file*']
 
 
492
    takes_options = ['revision']
 
 
495
    def run(self, revision=None, file_list=None):
 
 
496
        from bzrlib.diff import show_diff
 
 
498
        show_diff(Branch('.'), revision, specific_files=file_list)
 
 
504
class cmd_deleted(Command):
 
 
505
    """List files deleted in the working tree.
 
 
507
    TODO: Show files deleted since a previous revision, or between two revisions.
 
 
509
    def run(self, show_ids=False):
 
 
512
        new = b.working_tree()
 
 
514
        ## TODO: Much more efficient way to do this: read in new
 
 
515
        ## directories with readdir, rather than stating each one.  Same
 
 
516
        ## level of effort but possibly much less IO.  (Or possibly not,
 
 
517
        ## if the directories are very large...)
 
 
519
        for path, ie in old.inventory.iter_entries():
 
 
520
            if not new.has_id(ie.file_id):
 
 
522
                    print '%-50s %s' % (path, ie.file_id)
 
 
527
class cmd_modified(Command):
 
 
528
    """List files modified in working tree."""
 
 
533
        inv = b.read_working_inventory()
 
 
534
        sc = statcache.update_cache(b, inv)
 
 
535
        basis = b.basis_tree()
 
 
536
        basis_inv = basis.inventory
 
 
538
        # We used to do this through iter_entries(), but that's slow
 
 
539
        # when most of the files are unmodified, as is usually the
 
 
540
        # case.  So instead we iterate by inventory entry, and only
 
 
541
        # calculate paths as necessary.
 
 
543
        for file_id in basis_inv:
 
 
544
            cacheentry = sc.get(file_id)
 
 
545
            if not cacheentry:                 # deleted
 
 
547
            ie = basis_inv[file_id]
 
 
548
            if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
 
 
549
                path = inv.id2path(file_id)
 
 
554
class cmd_added(Command):
 
 
555
    """List files added in working tree."""
 
 
559
        wt = b.working_tree()
 
 
560
        basis_inv = b.basis_tree().inventory
 
 
563
            if file_id in basis_inv:
 
 
565
            path = inv.id2path(file_id)
 
 
566
            if not os.access(b.abspath(path), os.F_OK):
 
 
572
class cmd_root(Command):
 
 
573
    """Show the tree root directory.
 
 
575
    The root is the nearest enclosing directory with a .bzr control
 
 
577
    takes_args = ['filename?']
 
 
578
    def run(self, filename=None):
 
 
579
        """Print the branch root."""
 
 
580
        from branch import find_branch
 
 
581
        b = find_branch(filename)
 
 
582
        print getattr(b, 'base', None) or getattr(b, 'baseurl')
 
 
585
class cmd_log(Command):
 
 
586
    """Show log of this branch.
 
 
588
    TODO: Option to limit range.
 
 
590
    TODO: Perhaps show most-recent first with an option for last.
 
 
592
    takes_args = ['filename?']
 
 
593
    takes_options = ['timezone', 'verbose', 'show-ids']
 
 
594
    def run(self, filename=None, timezone='original', verbose=False, show_ids=False):
 
 
595
        from branch import find_branch
 
 
596
        b = find_branch((filename or '.'), lock_mode='r')
 
 
598
            filename = b.relpath(filename)
 
 
599
        bzrlib.show_log(b, filename,
 
 
600
                        show_timezone=timezone,
 
 
606
class cmd_touching_revisions(Command):
 
 
607
    """Return revision-ids which affected a particular file."""
 
 
609
    takes_args = ["filename"]
 
 
610
    def run(self, filename):
 
 
611
        b = Branch(filename, lock_mode='r')
 
 
612
        inv = b.read_working_inventory()
 
 
613
        file_id = inv.path2id(b.relpath(filename))
 
 
614
        for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
 
 
615
            print "%6d %s" % (revno, what)
 
 
618
class cmd_ls(Command):
 
 
619
    """List files in a tree.
 
 
621
    TODO: Take a revision or remote path and list that tree instead.
 
 
624
    def run(self, revision=None, verbose=False):
 
 
627
            tree = b.working_tree()
 
 
629
            tree = b.revision_tree(b.lookup_revision(revision))
 
 
631
        for fp, fc, kind, fid in tree.list_files():
 
 
633
                if kind == 'directory':
 
 
640
                print '%-8s %s%s' % (fc, fp, kindch)
 
 
646
class cmd_unknowns(Command):
 
 
647
    """List unknown files"""
 
 
649
        for f in Branch('.').unknowns():
 
 
654
class cmd_ignore(Command):
 
 
655
    """Ignore a command or pattern
 
 
657
    To remove patterns from the ignore list, edit the .bzrignore file.
 
 
659
    If the pattern contains a slash, it is compared to the whole path
 
 
660
    from the branch root.  Otherwise, it is comapred to only the last
 
 
661
    component of the path.
 
 
663
    Ignore patterns are case-insensitive on case-insensitive systems.
 
 
665
    Note: wildcards must be quoted from the shell on Unix.
 
 
668
        bzr ignore ./Makefile
 
 
671
    takes_args = ['name_pattern']
 
 
673
    def run(self, name_pattern):
 
 
674
        from bzrlib.atomicfile import AtomicFile
 
 
678
        ifn = b.abspath('.bzrignore')
 
 
680
        if os.path.exists(ifn):
 
 
683
                igns = f.read().decode('utf-8')
 
 
689
        if igns and igns[-1] != '\n':
 
 
691
        igns += name_pattern + '\n'
 
 
694
            f = AtomicFile(ifn, 'wt')
 
 
695
            f.write(igns.encode('utf-8'))
 
 
700
        inv = b.working_tree().inventory
 
 
701
        if inv.path2id('.bzrignore'):
 
 
702
            mutter('.bzrignore is already versioned')
 
 
704
            mutter('need to make new .bzrignore file versioned')
 
 
705
            b.add(['.bzrignore'])
 
 
709
class cmd_ignored(Command):
 
 
710
    """List ignored files and the patterns that matched them.
 
 
712
    See also: bzr ignore"""
 
 
714
        tree = Branch('.').working_tree()
 
 
715
        for path, file_class, kind, file_id in tree.list_files():
 
 
716
            if file_class != 'I':
 
 
718
            ## XXX: Slightly inefficient since this was already calculated
 
 
719
            pat = tree.is_ignored(path)
 
 
720
            print '%-50s %s' % (path, pat)
 
 
723
class cmd_lookup_revision(Command):
 
 
724
    """Lookup the revision-id from a revision-number
 
 
727
        bzr lookup-revision 33
 
 
730
    takes_args = ['revno']
 
 
732
    def run(self, revno):
 
 
736
            raise BzrCommandError("not a valid revision-number: %r" % revno)
 
 
738
        print Branch('.').lookup_revision(revno)
 
 
741
class cmd_export(Command):
 
 
742
    """Export past revision to destination directory.
 
 
744
    If no revision is specified this exports the last committed revision."""
 
 
745
    takes_args = ['dest']
 
 
746
    takes_options = ['revision']
 
 
747
    def run(self, dest, revision=None):
 
 
750
            rh = b.revision_history()[-1]
 
 
752
            rh = b.lookup_revision(int(revision))
 
 
753
        t = b.revision_tree(rh)
 
 
757
class cmd_cat(Command):
 
 
758
    """Write a file's text from a previous revision."""
 
 
760
    takes_options = ['revision']
 
 
761
    takes_args = ['filename']
 
 
763
    def run(self, filename, revision=None):
 
 
765
            raise BzrCommandError("bzr cat requires a revision number")
 
 
767
        b.print_file(b.relpath(filename), int(revision))
 
 
770
class cmd_local_time_offset(Command):
 
 
771
    """Show the offset in seconds from GMT to local time."""
 
 
774
        print bzrlib.osutils.local_time_offset()
 
 
778
class cmd_commit(Command):
 
 
779
    """Commit changes into a new revision.
 
 
781
    If selected files are specified, only changes to those files are
 
 
782
    committed.  If a directory is specified then its contents are also
 
 
785
    A selected-file commit may fail in some cases where the committed
 
 
786
    tree would be invalid, such as trying to commit a file in a
 
 
787
    newly-added directory that is not itself committed.
 
 
789
    TODO: Run hooks on tree to-be-committed, and after commit.
 
 
791
    TODO: Strict commit that fails if there are unknown or deleted files.
 
 
793
    takes_args = ['selected*']
 
 
794
    takes_options = ['message', 'file', 'verbose']
 
 
795
    aliases = ['ci', 'checkin']
 
 
797
    def run(self, message=None, file=None, verbose=False, selected_list=None):
 
 
798
        from bzrlib.commit import commit
 
 
800
        ## Warning: shadows builtin file()
 
 
801
        if not message and not file:
 
 
802
            raise BzrCommandError("please specify a commit message",
 
 
803
                                  ["use either --message or --file"])
 
 
804
        elif message and file:
 
 
805
            raise BzrCommandError("please specify either --message or --file")
 
 
809
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
 
 
812
        commit(b, message, verbose=verbose, specific_files=selected_list)
 
 
815
class cmd_check(Command):
 
 
816
    """Validate consistency of branch history.
 
 
818
    This command checks various invariants about the branch storage to
 
 
819
    detect data corruption or bzr bugs.
 
 
821
    takes_args = ['dir?']
 
 
822
    def run(self, dir='.'):
 
 
824
        bzrlib.check.check(Branch(dir, find_root=False))
 
 
828
class cmd_whoami(Command):
 
 
829
    """Show bzr user id."""
 
 
830
    takes_options = ['email']
 
 
832
    def run(self, email=False):
 
 
834
            print bzrlib.osutils.user_email()
 
 
836
            print bzrlib.osutils.username()
 
 
839
class cmd_selftest(Command):
 
 
840
    """Run internal test suite"""
 
 
843
        failures, tests = 0, 0
 
 
845
        import doctest, bzrlib.store, bzrlib.tests
 
 
846
        bzrlib.trace.verbose = False
 
 
848
        for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
 
 
849
            bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
 
 
850
            mf, mt = doctest.testmod(m)
 
 
853
            print '%-40s %3d tests' % (m.__name__, mt),
 
 
855
                print '%3d FAILED!' % mf
 
 
859
        print '%-40s %3d tests' % ('total', tests),
 
 
861
            print '%3d FAILED!' % failures
 
 
867
class cmd_version(Command):
 
 
868
    """Show version of bzr"""
 
 
873
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
 
 
874
    print bzrlib.__copyright__
 
 
875
    print "http://bazaar-ng.org/"
 
 
877
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
 
 
878
    print "you may use, modify and redistribute it under the terms of the GNU"
 
 
879
    print "General Public License version 2 or later."
 
 
882
class cmd_rocks(Command):
 
 
883
    """Statement of optimism."""
 
 
886
        print "it sure does!"
 
 
888
def parse_spec(spec):
 
 
890
        parsed = spec.split('/@')
 
 
891
        assert len(parsed) == 2
 
 
895
            parsed[1] = int(parsed[1])
 
 
898
        parsed = [spec, None]
 
 
901
class cmd_merge(Command):
 
 
902
    """Perform a three-way merge of trees."""
 
 
903
    takes_args = ['other_spec', 'base_spec']
 
 
905
    def run(self, other_spec, base_spec):
 
 
906
        merge.merge(parse_spec(other_spec), parse_spec(base_spec))
 
 
908
class cmd_assert_fail(Command):
 
 
909
    """Test reporting of assertion failures"""
 
 
912
        assert False, "always fails"
 
 
915
class cmd_help(Command):
 
 
916
    """Show help on a command or other topic.
 
 
918
    For a list of all available commands, say 'bzr help commands'."""
 
 
919
    takes_args = ['topic?']
 
 
922
    def run(self, topic=None):
 
 
927
class cmd_update_stat_cache(Command):
 
 
928
    """Update stat-cache mapping inodes to SHA-1 hashes.
 
 
935
        statcache.update_cache(b.base, b.read_working_inventory())
 
 
938
######################################################################
 
 
942
# list of all available options; the rhs can be either None for an
 
 
943
# option that takes no argument, or a constructor function that checks
 
 
967
def parse_args(argv):
 
 
968
    """Parse command line.
 
 
970
    Arguments and options are parsed at this level before being passed
 
 
971
    down to specific command handlers.  This routine knows, from a
 
 
972
    lookup table, something about the available options, what optargs
 
 
973
    they take, and which commands will accept them.
 
 
975
    >>> parse_args('--help'.split())
 
 
977
    >>> parse_args('--version'.split())
 
 
978
    ([], {'version': True})
 
 
979
    >>> parse_args('status --all'.split())
 
 
980
    (['status'], {'all': True})
 
 
981
    >>> parse_args('commit --message=biter'.split())
 
 
982
    (['commit'], {'message': u'biter'})
 
 
987
    # TODO: Maybe handle '--' to end options?
 
 
992
            # option names must not be unicode
 
 
996
                mutter("  got option %r" % a)
 
 
998
                    optname, optarg = a[2:].split('=', 1)
 
 
1001
                if optname not in OPTIONS:
 
 
1002
                    bailout('unknown long option %r' % a)
 
 
1005
                if shortopt not in SHORT_OPTIONS:
 
 
1006
                    bailout('unknown short option %r' % a)
 
 
1007
                optname = SHORT_OPTIONS[shortopt]
 
 
1010
                # XXX: Do we ever want to support this, e.g. for -r?
 
 
1011
                bailout('repeated option %r' % a)
 
 
1013
            optargfn = OPTIONS[optname]
 
 
1017
                        bailout('option %r needs an argument' % a)
 
 
1019
                        optarg = argv.pop(0)
 
 
1020
                opts[optname] = optargfn(optarg)
 
 
1023
                    bailout('option %r takes no argument' % optname)
 
 
1024
                opts[optname] = True
 
 
1033
def _match_argform(cmd, takes_args, args):
 
 
1036
    # step through args and takes_args, allowing appropriate 0-many matches
 
 
1037
    for ap in takes_args:
 
 
1041
                argdict[argname] = args.pop(0)
 
 
1042
        elif ap[-1] == '*': # all remaining arguments
 
 
1044
                argdict[argname + '_list'] = args[:]
 
 
1047
                argdict[argname + '_list'] = None
 
 
1050
                raise BzrCommandError("command %r needs one or more %s"
 
 
1051
                        % (cmd, argname.upper()))
 
 
1053
                argdict[argname + '_list'] = args[:]
 
 
1055
        elif ap[-1] == '$': # all but one
 
 
1057
                raise BzrCommandError("command %r needs one or more %s"
 
 
1058
                        % (cmd, argname.upper()))
 
 
1059
            argdict[argname + '_list'] = args[:-1]
 
 
1065
                raise BzrCommandError("command %r requires argument %s"
 
 
1066
                        % (cmd, argname.upper()))
 
 
1068
                argdict[argname] = args.pop(0)
 
 
1071
        raise BzrCommandError("extra argument to command %s: %s"
 
 
1079
    """Execute a command.
 
 
1081
    This is similar to main(), but without all the trappings for
 
 
1082
    logging and error handling.  
 
 
1084
    argv = [a.decode(bzrlib.user_encoding) for a in argv]
 
 
1087
        args, opts = parse_args(argv[1:])
 
 
1095
        elif 'version' in opts:
 
 
1098
        cmd = str(args.pop(0))
 
 
1105
    canonical_cmd, cmd_class = get_cmd_class(cmd)
 
 
1108
    if 'profile' in opts:
 
 
1114
    # check options are reasonable
 
 
1115
    allowed = cmd_class.takes_options
 
 
1117
        if oname not in allowed:
 
 
1118
            raise BzrCommandError("option '--%s' is not allowed for command %r"
 
 
1121
    # mix arguments and options into one dictionary
 
 
1122
    cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
 
 
1124
    for k, v in opts.items():
 
 
1125
        cmdopts[k.replace('-', '_')] = v
 
 
1128
        import hotshot, tempfile
 
 
1129
        pffileno, pfname = tempfile.mkstemp()
 
 
1131
            prof = hotshot.Profile(pfname)
 
 
1132
            ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
 
 
1135
            import hotshot.stats
 
 
1136
            stats = hotshot.stats.load(pfname)
 
 
1138
            stats.sort_stats('time')
 
 
1139
            ## XXX: Might like to write to stderr or the trace file instead but
 
 
1140
            ## print_stats seems hardcoded to stdout
 
 
1141
            stats.print_stats(20)
 
 
1149
        return cmd_class(cmdopts, cmdargs).status 
 
 
1152
def _report_exception(summary, quiet=False):
 
 
1154
    log_error('bzr: ' + summary)
 
 
1155
    bzrlib.trace.log_exception()
 
 
1158
        tb = sys.exc_info()[2]
 
 
1159
        exinfo = traceback.extract_tb(tb)
 
 
1161
            sys.stderr.write('  at %s:%d in %s()\n' % exinfo[-1][:3])
 
 
1162
        sys.stderr.write('  see ~/.bzr.log for debug information\n')
 
 
1169
    bzrlib.open_tracefile(argv)
 
 
1174
                return run_bzr(argv)
 
 
1176
                # do this here inside the exception wrappers to catch EPIPE
 
 
1179
            quiet = isinstance(e, (BzrCommandError))
 
 
1180
            _report_exception('error: ' + e.args[0], quiet=quiet)
 
 
1183
                    # some explanation or hints
 
 
1186
        except AssertionError, e:
 
 
1187
            msg = 'assertion failed'
 
 
1189
                msg += ': ' + str(e)
 
 
1190
            _report_exception(msg)
 
 
1192
        except KeyboardInterrupt, e:
 
 
1193
            _report_exception('interrupted', quiet=True)
 
 
1195
        except Exception, e:
 
 
1197
            if (isinstance(e, IOError) 
 
 
1198
                and hasattr(e, 'errno')
 
 
1199
                and e.errno == errno.EPIPE):
 
 
1203
                msg = str(e).rstrip('\n')
 
 
1204
            _report_exception(msg, quiet)
 
 
1207
        bzrlib.trace.close_trace()
 
 
1210
if __name__ == '__main__':
 
 
1211
    sys.exit(main(sys.argv))