~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Martin Pool
  • Date: 2005-07-11 03:42:53 UTC
  • Revision ID: mbp@sourcefrog.net-20050711034253-412281abeb9f56ad
doc

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2004, 2005 by Canonical Ltd
2
 
 
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.
7
 
 
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.
12
 
 
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
16
 
 
17
 
"""builtin bzr commands"""
18
 
 
19
 
# DO NOT change this to cStringIO - it results in control files 
20
 
# written as UCS4
21
 
# FIXIT! (Only deal with byte streams OR unicode at any one layer.)
22
 
# RBC 20051018
23
 
 
24
 
from StringIO import StringIO
25
 
import sys
26
 
import os
27
 
 
28
 
import bzrlib
29
 
from bzrlib import BZRDIR
30
 
from bzrlib.commands import Command, display_command
31
 
from bzrlib.branch import Branch
32
 
from bzrlib.revision import common_ancestor
33
 
import bzrlib.errors as errors
34
 
from bzrlib.errors import (BzrError, BzrCheckError, BzrCommandError, 
35
 
                           NotBranchError, DivergedBranches, NotConflicted,
36
 
                           NoSuchFile, NoWorkingTree, FileInWrongBranch)
37
 
from bzrlib.option import Option
38
 
from bzrlib.revisionspec import RevisionSpec
39
 
import bzrlib.trace
40
 
from bzrlib.trace import mutter, note, log_error, warning, is_quiet
41
 
from bzrlib.workingtree import WorkingTree
42
 
from bzrlib.log import show_one_log
43
 
 
44
 
 
45
 
def tree_files(file_list, default_branch=u'.'):
46
 
    try:
47
 
        return internal_tree_files(file_list, default_branch)
48
 
    except FileInWrongBranch, e:
49
 
        raise BzrCommandError("%s is not in the same branch as %s" %
50
 
                             (e.path, file_list[0]))
51
 
 
52
 
def internal_tree_files(file_list, default_branch=u'.'):
53
 
    """\
54
 
    Return a branch and list of branch-relative paths.
55
 
    If supplied file_list is empty or None, the branch default will be used,
56
 
    and returned file_list will match the original.
57
 
    """
58
 
    if file_list is None or len(file_list) == 0:
59
 
        return WorkingTree.open_containing(default_branch)[0], file_list
60
 
    tree = WorkingTree.open_containing(file_list[0])[0]
61
 
    new_list = []
62
 
    for filename in file_list:
63
 
        try:
64
 
            new_list.append(tree.relpath(filename))
65
 
        except errors.PathNotChild:
66
 
            raise FileInWrongBranch(tree.branch, filename)
67
 
    return tree, new_list
68
 
 
69
 
 
70
 
# TODO: Make sure no commands unconditionally use the working directory as a
71
 
# branch.  If a filename argument is used, the first of them should be used to
72
 
# specify the branch.  (Perhaps this can be factored out into some kind of
73
 
# Argument class, representing a file in a branch, where the first occurrence
74
 
# opens the branch?)
75
 
 
76
 
class cmd_status(Command):
77
 
    """Display status summary.
78
 
 
79
 
    This reports on versioned and unknown files, reporting them
80
 
    grouped by state.  Possible states are:
81
 
 
82
 
    added
83
 
        Versioned in the working copy but not in the previous revision.
84
 
 
85
 
    removed
86
 
        Versioned in the previous revision but removed or deleted
87
 
        in the working copy.
88
 
 
89
 
    renamed
90
 
        Path of this file changed from the previous revision;
91
 
        the text may also have changed.  This includes files whose
92
 
        parent directory was renamed.
93
 
 
94
 
    modified
95
 
        Text has changed since the previous revision.
96
 
 
97
 
    unchanged
98
 
        Nothing about this file has changed since the previous revision.
99
 
        Only shown with --all.
100
 
 
101
 
    unknown
102
 
        Not versioned and not matching an ignore pattern.
103
 
 
104
 
    To see ignored files use 'bzr ignored'.  For details in the
105
 
    changes to file texts, use 'bzr diff'.
106
 
 
107
 
    If no arguments are specified, the status of the entire working
108
 
    directory is shown.  Otherwise, only the status of the specified
109
 
    files or directories is reported.  If a directory is given, status
110
 
    is reported for everything inside that directory.
111
 
 
112
 
    If a revision argument is given, the status is calculated against
113
 
    that revision, or between two revisions if two are provided.
114
 
    """
115
 
    
116
 
    # TODO: --no-recurse, --recurse options
117
 
    
118
 
    takes_args = ['file*']
119
 
    takes_options = ['all', 'show-ids', 'revision']
120
 
    aliases = ['st', 'stat']
121
 
    
122
 
    @display_command
123
 
    def run(self, all=False, show_ids=False, file_list=None, revision=None):
124
 
        tree, file_list = tree_files(file_list)
125
 
            
126
 
        from bzrlib.status import show_status
127
 
        show_status(tree.branch, show_unchanged=all, show_ids=show_ids,
128
 
                    specific_files=file_list, revision=revision)
129
 
 
130
 
 
131
 
class cmd_cat_revision(Command):
132
 
    """Write out metadata for a revision.
133
 
    
134
 
    The revision to print can either be specified by a specific
135
 
    revision identifier, or you can use --revision.
136
 
    """
137
 
 
138
 
    hidden = True
139
 
    takes_args = ['revision_id?']
140
 
    takes_options = ['revision']
141
 
    
142
 
    @display_command
143
 
    def run(self, revision_id=None, revision=None):
144
 
 
145
 
        if revision_id is not None and revision is not None:
146
 
            raise BzrCommandError('You can only supply one of revision_id or --revision')
147
 
        if revision_id is None and revision is None:
148
 
            raise BzrCommandError('You must supply either --revision or a revision_id')
149
 
        b = WorkingTree.open_containing(u'.')[0].branch
150
 
        if revision_id is not None:
151
 
            sys.stdout.write(b.get_revision_xml(revision_id))
152
 
        elif revision is not None:
153
 
            for rev in revision:
154
 
                if rev is None:
155
 
                    raise BzrCommandError('You cannot specify a NULL revision.')
156
 
                revno, rev_id = rev.in_history(b)
157
 
                sys.stdout.write(b.get_revision_xml(rev_id))
158
 
    
159
 
 
160
 
class cmd_revno(Command):
161
 
    """Show current revision number.
162
 
 
163
 
    This is equal to the number of revisions on this branch."""
164
 
    takes_args = ['location?']
165
 
    @display_command
166
 
    def run(self, location=u'.'):
167
 
        print Branch.open_containing(location)[0].revno()
168
 
 
169
 
 
170
 
class cmd_revision_info(Command):
171
 
    """Show revision number and revision id for a given revision identifier.
172
 
    """
173
 
    hidden = True
174
 
    takes_args = ['revision_info*']
175
 
    takes_options = ['revision']
176
 
    @display_command
177
 
    def run(self, revision=None, revision_info_list=[]):
178
 
 
179
 
        revs = []
180
 
        if revision is not None:
181
 
            revs.extend(revision)
182
 
        if revision_info_list is not None:
183
 
            for rev in revision_info_list:
184
 
                revs.append(RevisionSpec(rev))
185
 
        if len(revs) == 0:
186
 
            raise BzrCommandError('You must supply a revision identifier')
187
 
 
188
 
        b = WorkingTree.open_containing(u'.')[0].branch
189
 
 
190
 
        for rev in revs:
191
 
            revinfo = rev.in_history(b)
192
 
            if revinfo.revno is None:
193
 
                print '     %s' % revinfo.rev_id
194
 
            else:
195
 
                print '%4d %s' % (revinfo.revno, revinfo.rev_id)
196
 
 
197
 
    
198
 
class cmd_add(Command):
199
 
    """Add specified files or directories.
200
 
 
201
 
    In non-recursive mode, all the named items are added, regardless
202
 
    of whether they were previously ignored.  A warning is given if
203
 
    any of the named files are already versioned.
204
 
 
205
 
    In recursive mode (the default), files are treated the same way
206
 
    but the behaviour for directories is different.  Directories that
207
 
    are already versioned do not give a warning.  All directories,
208
 
    whether already versioned or not, are searched for files or
209
 
    subdirectories that are neither versioned or ignored, and these
210
 
    are added.  This search proceeds recursively into versioned
211
 
    directories.  If no names are given '.' is assumed.
212
 
 
213
 
    Therefore simply saying 'bzr add' will version all files that
214
 
    are currently unknown.
215
 
 
216
 
    Adding a file whose parent directory is not versioned will
217
 
    implicitly add the parent, and so on up to the root. This means
218
 
    you should never need to explictly add a directory, they'll just
219
 
    get added when you add a file in the directory.
220
 
 
221
 
    --dry-run will show which files would be added, but not actually 
222
 
    add them.
223
 
    """
224
 
    takes_args = ['file*']
225
 
    takes_options = ['no-recurse', 'dry-run', 'verbose']
226
 
 
227
 
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False):
228
 
        import bzrlib.add
229
 
 
230
 
        if dry_run:
231
 
            if is_quiet():
232
 
                # This is pointless, but I'd rather not raise an error
233
 
                action = bzrlib.add.add_action_null
234
 
            else:
235
 
                action = bzrlib.add.add_action_print
236
 
        elif is_quiet():
237
 
            action = bzrlib.add.add_action_add
238
 
        else:
239
 
            action = bzrlib.add.add_action_add_and_print
240
 
 
241
 
        added, ignored = bzrlib.add.smart_add(file_list, not no_recurse, 
242
 
                                              action)
243
 
        if len(ignored) > 0:
244
 
            for glob in sorted(ignored.keys()):
245
 
                match_len = len(ignored[glob])
246
 
                if verbose:
247
 
                    for path in ignored[glob]:
248
 
                        print "ignored %s matching \"%s\"" % (path, glob)
249
 
                else:
250
 
                    print "ignored %d file(s) matching \"%s\"" % (match_len,
251
 
                                                              glob)
252
 
            print "If you wish to add some of these files, please add them"\
253
 
                " by name."
254
 
 
255
 
 
256
 
class cmd_mkdir(Command):
257
 
    """Create a new versioned directory.
258
 
 
259
 
    This is equivalent to creating the directory and then adding it.
260
 
    """
261
 
    takes_args = ['dir+']
262
 
 
263
 
    def run(self, dir_list):
264
 
        for d in dir_list:
265
 
            os.mkdir(d)
266
 
            wt, dd = WorkingTree.open_containing(d)
267
 
            wt.add([dd])
268
 
            print 'added', d
269
 
 
270
 
 
271
 
class cmd_relpath(Command):
272
 
    """Show path of a file relative to root"""
273
 
    takes_args = ['filename']
274
 
    hidden = True
275
 
    
276
 
    @display_command
277
 
    def run(self, filename):
278
 
        tree, relpath = WorkingTree.open_containing(filename)
279
 
        print relpath
280
 
 
281
 
 
282
 
class cmd_inventory(Command):
283
 
    """Show inventory of the current working copy or a revision.
284
 
 
285
 
    It is possible to limit the output to a particular entry
286
 
    type using the --kind option.  For example; --kind file.
287
 
    """
288
 
    takes_options = ['revision', 'show-ids', 'kind']
289
 
    
290
 
    @display_command
291
 
    def run(self, revision=None, show_ids=False, kind=None):
292
 
        if kind and kind not in ['file', 'directory', 'symlink']:
293
 
            raise BzrCommandError('invalid kind specified')
294
 
        tree = WorkingTree.open_containing(u'.')[0]
295
 
        if revision is None:
296
 
            inv = tree.read_working_inventory()
297
 
        else:
298
 
            if len(revision) > 1:
299
 
                raise BzrCommandError('bzr inventory --revision takes'
300
 
                    ' exactly one revision identifier')
301
 
            inv = tree.branch.get_revision_inventory(
302
 
                revision[0].in_history(tree.branch).rev_id)
303
 
 
304
 
        for path, entry in inv.entries():
305
 
            if kind and kind != entry.kind:
306
 
                continue
307
 
            if show_ids:
308
 
                print '%-50s %s' % (path, entry.file_id)
309
 
            else:
310
 
                print path
311
 
 
312
 
 
313
 
class cmd_move(Command):
314
 
    """Move files to a different directory.
315
 
 
316
 
    examples:
317
 
        bzr move *.txt doc
318
 
 
319
 
    The destination must be a versioned directory in the same branch.
320
 
    """
321
 
    takes_args = ['source$', 'dest']
322
 
    def run(self, source_list, dest):
323
 
        tree, source_list = tree_files(source_list)
324
 
        # TODO: glob expansion on windows?
325
 
        tree.move(source_list, tree.relpath(dest))
326
 
 
327
 
 
328
 
class cmd_rename(Command):
329
 
    """Change the name of an entry.
330
 
 
331
 
    examples:
332
 
      bzr rename frob.c frobber.c
333
 
      bzr rename src/frob.c lib/frob.c
334
 
 
335
 
    It is an error if the destination name exists.
336
 
 
337
 
    See also the 'move' command, which moves files into a different
338
 
    directory without changing their name.
339
 
    """
340
 
    # TODO: Some way to rename multiple files without invoking 
341
 
    # bzr for each one?"""
342
 
    takes_args = ['from_name', 'to_name']
343
 
    
344
 
    def run(self, from_name, to_name):
345
 
        tree, (from_name, to_name) = tree_files((from_name, to_name))
346
 
        tree.rename_one(from_name, to_name)
347
 
 
348
 
 
349
 
class cmd_mv(Command):
350
 
    """Move or rename a file.
351
 
 
352
 
    usage:
353
 
        bzr mv OLDNAME NEWNAME
354
 
        bzr mv SOURCE... DESTINATION
355
 
 
356
 
    If the last argument is a versioned directory, all the other names
357
 
    are moved into it.  Otherwise, there must be exactly two arguments
358
 
    and the file is changed to a new name, which must not already exist.
359
 
 
360
 
    Files cannot be moved between branches.
361
 
    """
362
 
    takes_args = ['names*']
363
 
    def run(self, names_list):
364
 
        if len(names_list) < 2:
365
 
            raise BzrCommandError("missing file argument")
366
 
        tree, rel_names = tree_files(names_list)
367
 
        
368
 
        if os.path.isdir(names_list[-1]):
369
 
            # move into existing directory
370
 
            for pair in tree.move(rel_names[:-1], rel_names[-1]):
371
 
                print "%s => %s" % pair
372
 
        else:
373
 
            if len(names_list) != 2:
374
 
                raise BzrCommandError('to mv multiple files the destination '
375
 
                                      'must be a versioned directory')
376
 
            tree.rename_one(rel_names[0], rel_names[1])
377
 
            print "%s => %s" % (rel_names[0], rel_names[1])
378
 
            
379
 
    
380
 
class cmd_pull(Command):
381
 
    """Pull any changes from another branch into the current one.
382
 
 
383
 
    If there is no default location set, the first pull will set it.  After
384
 
    that, you can omit the location to use the default.  To change the
385
 
    default, use --remember.
386
 
 
387
 
    This command only works on branches that have not diverged.  Branches are
388
 
    considered diverged if both branches have had commits without first
389
 
    pulling from the other.
390
 
 
391
 
    If branches have diverged, you can use 'bzr merge' to pull the text changes
392
 
    from one into the other.  Once one branch has merged, the other should
393
 
    be able to pull it again.
394
 
 
395
 
    If you want to forget your local changes and just update your branch to
396
 
    match the remote one, use --overwrite.
397
 
    """
398
 
    takes_options = ['remember', 'overwrite', 'verbose']
399
 
    takes_args = ['location?']
400
 
 
401
 
    def run(self, location=None, remember=False, overwrite=False, verbose=False):
402
 
        from bzrlib.merge import merge
403
 
        from shutil import rmtree
404
 
        import errno
405
 
        # FIXME: too much stuff is in the command class        
406
 
        tree_to = WorkingTree.open_containing(u'.')[0]
407
 
        stored_loc = tree_to.branch.get_parent()
408
 
        if location is None:
409
 
            if stored_loc is None:
410
 
                raise BzrCommandError("No pull location known or specified.")
411
 
            else:
412
 
                print "Using saved location: %s" % stored_loc
413
 
                location = stored_loc
414
 
 
415
 
        br_from = Branch.open(location)
416
 
        br_to = tree_to.branch
417
 
 
418
 
        old_rh = br_to.revision_history()
419
 
        count = tree_to.pull(br_from, overwrite)
420
 
 
421
 
        if br_to.get_parent() is None or remember:
422
 
            br_to.set_parent(location)
423
 
        note('%d revision(s) pulled.' % (count,))
424
 
 
425
 
        if verbose:
426
 
            new_rh = tree_to.branch.revision_history()
427
 
            if old_rh != new_rh:
428
 
                # Something changed
429
 
                from bzrlib.log import show_changed_revisions
430
 
                show_changed_revisions(tree_to.branch, old_rh, new_rh)
431
 
 
432
 
 
433
 
class cmd_push(Command):
434
 
    """Push this branch into another branch.
435
 
    
436
 
    The remote branch will not have its working tree populated because this
437
 
    is both expensive, and may not be supported on the remote file system.
438
 
    
439
 
    Some smart servers or protocols *may* put the working tree in place.
440
 
 
441
 
    If there is no default push location set, the first push will set it.
442
 
    After that, you can omit the location to use the default.  To change the
443
 
    default, use --remember.
444
 
 
445
 
    This command only works on branches that have not diverged.  Branches are
446
 
    considered diverged if the branch being pushed to is not an older version
447
 
    of this branch.
448
 
 
449
 
    If branches have diverged, you can use 'bzr push --overwrite' to replace
450
 
    the other branch completely.
451
 
    
452
 
    If you want to ensure you have the different changes in the other branch,
453
 
    do a merge (see bzr help merge) from the other branch, and commit that
454
 
    before doing a 'push --overwrite'.
455
 
    """
456
 
    takes_options = ['remember', 'overwrite', 
457
 
                     Option('create-prefix', 
458
 
                            help='Create the path leading up to the branch '
459
 
                                 'if it does not already exist')]
460
 
    takes_args = ['location?']
461
 
 
462
 
    def run(self, location=None, remember=False, overwrite=False,
463
 
            create_prefix=False, verbose=False):
464
 
        # FIXME: Way too big!  Put this into a function called from the
465
 
        # command.
466
 
        import errno
467
 
        from shutil import rmtree
468
 
        from bzrlib.transport import get_transport
469
 
        
470
 
        tree_from = WorkingTree.open_containing(u'.')[0]
471
 
        br_from = tree_from.branch
472
 
        stored_loc = tree_from.branch.get_push_location()
473
 
        if location is None:
474
 
            if stored_loc is None:
475
 
                raise BzrCommandError("No push location known or specified.")
476
 
            else:
477
 
                print "Using saved location: %s" % stored_loc
478
 
                location = stored_loc
479
 
        try:
480
 
            br_to = Branch.open(location)
481
 
        except NotBranchError:
482
 
            # create a branch.
483
 
            transport = get_transport(location).clone('..')
484
 
            if not create_prefix:
485
 
                try:
486
 
                    transport.mkdir(transport.relpath(location))
487
 
                except NoSuchFile:
488
 
                    raise BzrCommandError("Parent directory of %s "
489
 
                                          "does not exist." % location)
490
 
            else:
491
 
                current = transport.base
492
 
                needed = [(transport, transport.relpath(location))]
493
 
                while needed:
494
 
                    try:
495
 
                        transport, relpath = needed[-1]
496
 
                        transport.mkdir(relpath)
497
 
                        needed.pop()
498
 
                    except NoSuchFile:
499
 
                        new_transport = transport.clone('..')
500
 
                        needed.append((new_transport,
501
 
                                       new_transport.relpath(transport.base)))
502
 
                        if new_transport.base == transport.base:
503
 
                            raise BzrCommandError("Could not creeate "
504
 
                                                  "path prefix.")
505
 
            br_to = Branch.initialize(location)
506
 
        old_rh = br_to.revision_history()
507
 
        try:
508
 
            try:
509
 
                tree_to = br_to.working_tree()
510
 
            except NoWorkingTree:
511
 
                # TODO: This should be updated for branches which don't have a
512
 
                # working tree, as opposed to ones where we just couldn't 
513
 
                # update the tree.
514
 
                warning('Unable to update the working tree of: %s' % (br_to.base,))
515
 
                count = br_to.pull(br_from, overwrite)
516
 
            else:
517
 
                count = tree_to.pull(br_from, overwrite)
518
 
        except DivergedBranches:
519
 
            raise BzrCommandError("These branches have diverged."
520
 
                                  "  Try a merge then push with overwrite.")
521
 
        if br_from.get_push_location() is None or remember:
522
 
            br_from.set_push_location(location)
523
 
        note('%d revision(s) pushed.' % (count,))
524
 
 
525
 
        if verbose:
526
 
            new_rh = br_to.revision_history()
527
 
            if old_rh != new_rh:
528
 
                # Something changed
529
 
                from bzrlib.log import show_changed_revisions
530
 
                show_changed_revisions(br_to, old_rh, new_rh)
531
 
 
532
 
 
533
 
class cmd_branch(Command):
534
 
    """Create a new copy of a branch.
535
 
 
536
 
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
537
 
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
538
 
 
539
 
    To retrieve the branch as of a particular revision, supply the --revision
540
 
    parameter, as in "branch foo/bar -r 5".
541
 
 
542
 
    --basis is to speed up branching from remote branches.  When specified, it
543
 
    copies all the file-contents, inventory and revision data from the basis
544
 
    branch before copying anything from the remote branch.
545
 
    """
546
 
    takes_args = ['from_location', 'to_location?']
547
 
    takes_options = ['revision', 'basis']
548
 
    aliases = ['get', 'clone']
549
 
 
550
 
    def run(self, from_location, to_location=None, revision=None, basis=None):
551
 
        from bzrlib.clone import copy_branch
552
 
        import errno
553
 
        from shutil import rmtree
554
 
        if revision is None:
555
 
            revision = [None]
556
 
        elif len(revision) > 1:
557
 
            raise BzrCommandError(
558
 
                'bzr branch --revision takes exactly 1 revision value')
559
 
        try:
560
 
            br_from = Branch.open(from_location)
561
 
        except OSError, e:
562
 
            if e.errno == errno.ENOENT:
563
 
                raise BzrCommandError('Source location "%s" does not'
564
 
                                      ' exist.' % to_location)
565
 
            else:
566
 
                raise
567
 
        br_from.lock_read()
568
 
        try:
569
 
            if basis is not None:
570
 
                basis_branch = WorkingTree.open_containing(basis)[0].branch
571
 
            else:
572
 
                basis_branch = None
573
 
            if len(revision) == 1 and revision[0] is not None:
574
 
                revision_id = revision[0].in_history(br_from)[1]
575
 
            else:
576
 
                revision_id = None
577
 
            if to_location is None:
578
 
                to_location = os.path.basename(from_location.rstrip("/\\"))
579
 
                name = None
580
 
            else:
581
 
                name = os.path.basename(to_location) + '\n'
582
 
            try:
583
 
                os.mkdir(to_location)
584
 
            except OSError, e:
585
 
                if e.errno == errno.EEXIST:
586
 
                    raise BzrCommandError('Target directory "%s" already'
587
 
                                          ' exists.' % to_location)
588
 
                if e.errno == errno.ENOENT:
589
 
                    raise BzrCommandError('Parent of "%s" does not exist.' %
590
 
                                          to_location)
591
 
                else:
592
 
                    raise
593
 
            try:
594
 
                copy_branch(br_from, to_location, revision_id, basis_branch)
595
 
            except bzrlib.errors.NoSuchRevision:
596
 
                rmtree(to_location)
597
 
                msg = "The branch %s has no revision %s." % (from_location, revision[0])
598
 
                raise BzrCommandError(msg)
599
 
            except bzrlib.errors.UnlistableBranch:
600
 
                rmtree(to_location)
601
 
                msg = "The branch %s cannot be used as a --basis"
602
 
                raise BzrCommandError(msg)
603
 
            branch = Branch.open(to_location)
604
 
            if name:
605
 
                name = StringIO(name)
606
 
                branch.put_controlfile('branch-name', name)
607
 
            note('Branched %d revision(s).' % branch.revno())
608
 
        finally:
609
 
            br_from.unlock()
610
 
 
611
 
 
612
 
class cmd_renames(Command):
613
 
    """Show list of renamed files.
614
 
    """
615
 
    # TODO: Option to show renames between two historical versions.
616
 
 
617
 
    # TODO: Only show renames under dir, rather than in the whole branch.
618
 
    takes_args = ['dir?']
619
 
 
620
 
    @display_command
621
 
    def run(self, dir=u'.'):
622
 
        tree = WorkingTree.open_containing(dir)[0]
623
 
        old_inv = tree.branch.basis_tree().inventory
624
 
        new_inv = tree.read_working_inventory()
625
 
 
626
 
        renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
627
 
        renames.sort()
628
 
        for old_name, new_name in renames:
629
 
            print "%s => %s" % (old_name, new_name)        
630
 
 
631
 
 
632
 
class cmd_info(Command):
633
 
    """Show statistical information about a branch."""
634
 
    takes_args = ['branch?']
635
 
    
636
 
    @display_command
637
 
    def run(self, branch=None):
638
 
        import info
639
 
        b = WorkingTree.open_containing(branch)[0].branch
640
 
        info.show_info(b)
641
 
 
642
 
 
643
 
class cmd_remove(Command):
644
 
    """Make a file unversioned.
645
 
 
646
 
    This makes bzr stop tracking changes to a versioned file.  It does
647
 
    not delete the working copy.
648
 
    """
649
 
    takes_args = ['file+']
650
 
    takes_options = ['verbose']
651
 
    aliases = ['rm']
652
 
    
653
 
    def run(self, file_list, verbose=False):
654
 
        tree, file_list = tree_files(file_list)
655
 
        tree.remove(file_list, verbose=verbose)
656
 
 
657
 
 
658
 
class cmd_file_id(Command):
659
 
    """Print file_id of a particular file or directory.
660
 
 
661
 
    The file_id is assigned when the file is first added and remains the
662
 
    same through all revisions where the file exists, even when it is
663
 
    moved or renamed.
664
 
    """
665
 
    hidden = True
666
 
    takes_args = ['filename']
667
 
    @display_command
668
 
    def run(self, filename):
669
 
        tree, relpath = WorkingTree.open_containing(filename)
670
 
        i = tree.inventory.path2id(relpath)
671
 
        if i == None:
672
 
            raise BzrError("%r is not a versioned file" % filename)
673
 
        else:
674
 
            print i
675
 
 
676
 
 
677
 
class cmd_file_path(Command):
678
 
    """Print path of file_ids to a file or directory.
679
 
 
680
 
    This prints one line for each directory down to the target,
681
 
    starting at the branch root."""
682
 
    hidden = True
683
 
    takes_args = ['filename']
684
 
    @display_command
685
 
    def run(self, filename):
686
 
        tree, relpath = WorkingTree.open_containing(filename)
687
 
        inv = tree.inventory
688
 
        fid = inv.path2id(relpath)
689
 
        if fid == None:
690
 
            raise BzrError("%r is not a versioned file" % filename)
691
 
        for fip in inv.get_idpath(fid):
692
 
            print fip
693
 
 
694
 
 
695
 
class cmd_revision_history(Command):
696
 
    """Display list of revision ids on this branch."""
697
 
    hidden = True
698
 
    @display_command
699
 
    def run(self):
700
 
        branch = WorkingTree.open_containing(u'.')[0].branch
701
 
        for patchid in branch.revision_history():
702
 
            print patchid
703
 
 
704
 
 
705
 
class cmd_ancestry(Command):
706
 
    """List all revisions merged into this branch."""
707
 
    hidden = True
708
 
    @display_command
709
 
    def run(self):
710
 
        tree = WorkingTree.open_containing(u'.')[0]
711
 
        b = tree.branch
712
 
        # FIXME. should be tree.last_revision
713
 
        for revision_id in b.get_ancestry(b.last_revision()):
714
 
            print revision_id
715
 
 
716
 
 
717
 
class cmd_init(Command):
718
 
    """Make a directory into a versioned branch.
719
 
 
720
 
    Use this to create an empty branch, or before importing an
721
 
    existing project.
722
 
 
723
 
    Recipe for importing a tree of files:
724
 
        cd ~/project
725
 
        bzr init
726
 
        bzr add .
727
 
        bzr status
728
 
        bzr commit -m 'imported project'
729
 
    """
730
 
    takes_args = ['location?']
731
 
    def run(self, location=None):
732
 
        from bzrlib.branch import Branch
733
 
        if location is None:
734
 
            location = u'.'
735
 
        else:
736
 
            # The path has to exist to initialize a
737
 
            # branch inside of it.
738
 
            # Just using os.mkdir, since I don't
739
 
            # believe that we want to create a bunch of
740
 
            # locations if the user supplies an extended path
741
 
            if not os.path.exists(location):
742
 
                os.mkdir(location)
743
 
        Branch.initialize(location)
744
 
 
745
 
 
746
 
class cmd_diff(Command):
747
 
    """Show differences in working tree.
748
 
    
749
 
    If files are listed, only the changes in those files are listed.
750
 
    Otherwise, all changes for the tree are listed.
751
 
 
752
 
    examples:
753
 
        bzr diff
754
 
        bzr diff -r1
755
 
        bzr diff -r1..2
756
 
    """
757
 
    # TODO: Allow diff across branches.
758
 
    # TODO: Option to use external diff command; could be GNU diff, wdiff,
759
 
    #       or a graphical diff.
760
 
 
761
 
    # TODO: Python difflib is not exactly the same as unidiff; should
762
 
    #       either fix it up or prefer to use an external diff.
763
 
 
764
 
    # TODO: If a directory is given, diff everything under that.
765
 
 
766
 
    # TODO: Selected-file diff is inefficient and doesn't show you
767
 
    #       deleted files.
768
 
 
769
 
    # TODO: This probably handles non-Unix newlines poorly.
770
 
    
771
 
    takes_args = ['file*']
772
 
    takes_options = ['revision', 'diff-options']
773
 
    aliases = ['di', 'dif']
774
 
 
775
 
    @display_command
776
 
    def run(self, revision=None, file_list=None, diff_options=None):
777
 
        from bzrlib.diff import show_diff
778
 
        try:
779
 
            tree, file_list = internal_tree_files(file_list)
780
 
            b = None
781
 
            b2 = None
782
 
        except FileInWrongBranch:
783
 
            if len(file_list) != 2:
784
 
                raise BzrCommandError("Files are in different branches")
785
 
 
786
 
            b, file1 = Branch.open_containing(file_list[0])
787
 
            b2, file2 = Branch.open_containing(file_list[1])
788
 
            if file1 != "" or file2 != "":
789
 
                # FIXME diff those two files. rbc 20051123
790
 
                raise BzrCommandError("Files are in different branches")
791
 
            file_list = None
792
 
        if revision is not None:
793
 
            if b2 is not None:
794
 
                raise BzrCommandError("Can't specify -r with two branches")
795
 
            if len(revision) == 1:
796
 
                return show_diff(tree.branch, revision[0], specific_files=file_list,
797
 
                                 external_diff_options=diff_options)
798
 
            elif len(revision) == 2:
799
 
                return show_diff(tree.branch, revision[0], specific_files=file_list,
800
 
                                 external_diff_options=diff_options,
801
 
                                 revision2=revision[1])
802
 
            else:
803
 
                raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
804
 
        else:
805
 
            if b is not None:
806
 
                return show_diff(b, None, specific_files=file_list,
807
 
                                 external_diff_options=diff_options, b2=b2)
808
 
            else:
809
 
                return show_diff(tree.branch, None, specific_files=file_list,
810
 
                                 external_diff_options=diff_options)
811
 
 
812
 
 
813
 
class cmd_deleted(Command):
814
 
    """List files deleted in the working tree.
815
 
    """
816
 
    # TODO: Show files deleted since a previous revision, or
817
 
    # between two revisions.
818
 
    # TODO: Much more efficient way to do this: read in new
819
 
    # directories with readdir, rather than stating each one.  Same
820
 
    # level of effort but possibly much less IO.  (Or possibly not,
821
 
    # if the directories are very large...)
822
 
    @display_command
823
 
    def run(self, show_ids=False):
824
 
        tree = WorkingTree.open_containing(u'.')[0]
825
 
        old = tree.branch.basis_tree()
826
 
        for path, ie in old.inventory.iter_entries():
827
 
            if not tree.has_id(ie.file_id):
828
 
                if show_ids:
829
 
                    print '%-50s %s' % (path, ie.file_id)
830
 
                else:
831
 
                    print path
832
 
 
833
 
 
834
 
class cmd_modified(Command):
835
 
    """List files modified in working tree."""
836
 
    hidden = True
837
 
    @display_command
838
 
    def run(self):
839
 
        from bzrlib.delta import compare_trees
840
 
 
841
 
        tree = WorkingTree.open_containing(u'.')[0]
842
 
        td = compare_trees(tree.branch.basis_tree(), tree)
843
 
 
844
 
        for path, id, kind, text_modified, meta_modified in td.modified:
845
 
            print path
846
 
 
847
 
 
848
 
 
849
 
class cmd_added(Command):
850
 
    """List files added in working tree."""
851
 
    hidden = True
852
 
    @display_command
853
 
    def run(self):
854
 
        wt = WorkingTree.open_containing(u'.')[0]
855
 
        basis_inv = wt.branch.basis_tree().inventory
856
 
        inv = wt.inventory
857
 
        for file_id in inv:
858
 
            if file_id in basis_inv:
859
 
                continue
860
 
            path = inv.id2path(file_id)
861
 
            if not os.access(b.abspath(path), os.F_OK):
862
 
                continue
863
 
            print path
864
 
                
865
 
        
866
 
 
867
 
class cmd_root(Command):
868
 
    """Show the tree root directory.
869
 
 
870
 
    The root is the nearest enclosing directory with a .bzr control
871
 
    directory."""
872
 
    takes_args = ['filename?']
873
 
    @display_command
874
 
    def run(self, filename=None):
875
 
        """Print the branch root."""
876
 
        tree = WorkingTree.open_containing(filename)[0]
877
 
        print tree.basedir
878
 
 
879
 
 
880
 
class cmd_log(Command):
881
 
    """Show log of this branch.
882
 
 
883
 
    To request a range of logs, you can use the command -r begin..end
884
 
    -r revision requests a specific revision, -r ..end or -r begin.. are
885
 
    also valid.
886
 
    """
887
 
 
888
 
    # TODO: Make --revision support uuid: and hash: [future tag:] notation.
889
 
 
890
 
    takes_args = ['filename?']
891
 
    takes_options = [Option('forward', 
892
 
                            help='show from oldest to newest'),
893
 
                     'timezone', 'verbose', 
894
 
                     'show-ids', 'revision',
895
 
                     'line', 'long', 
896
 
                     Option('message',
897
 
                            help='show revisions whose message matches this regexp',
898
 
                            type=str),
899
 
                     'short',
900
 
                     ]
901
 
    @display_command
902
 
    def run(self, filename=None, timezone='original',
903
 
            verbose=False,
904
 
            show_ids=False,
905
 
            forward=False,
906
 
            revision=None,
907
 
            message=None,
908
 
            long=False,
909
 
            short=False,
910
 
            line=False):
911
 
        from bzrlib.log import log_formatter, show_log
912
 
        import codecs
913
 
        assert message is None or isinstance(message, basestring), \
914
 
            "invalid message argument %r" % message
915
 
        direction = (forward and 'forward') or 'reverse'
916
 
        
917
 
        if filename:
918
 
            # might be a tree:
919
 
            tree = None
920
 
            try:
921
 
                tree, fp = WorkingTree.open_containing(filename)
922
 
                b = tree.branch
923
 
                if fp != '':
924
 
                    inv = tree.read_working_inventory()
925
 
            except NotBranchError:
926
 
                pass
927
 
            if tree is None:
928
 
                b, fp = Branch.open_containing(filename)
929
 
                if fp != '':
930
 
                    inv = b.get_inventory(b.last_revision())
931
 
            if fp != '':
932
 
                file_id = inv.path2id(fp)
933
 
            else:
934
 
                file_id = None  # points to branch root
935
 
        else:
936
 
            tree, relpath = WorkingTree.open_containing(u'.')
937
 
            b = tree.branch
938
 
            file_id = None
939
 
 
940
 
        if revision is None:
941
 
            rev1 = None
942
 
            rev2 = None
943
 
        elif len(revision) == 1:
944
 
            rev1 = rev2 = revision[0].in_history(b).revno
945
 
        elif len(revision) == 2:
946
 
            rev1 = revision[0].in_history(b).revno
947
 
            rev2 = revision[1].in_history(b).revno
948
 
        else:
949
 
            raise BzrCommandError('bzr log --revision takes one or two values.')
950
 
 
951
 
        # By this point, the revision numbers are converted to the +ve
952
 
        # form if they were supplied in the -ve form, so we can do
953
 
        # this comparison in relative safety
954
 
        if rev1 > rev2:
955
 
            (rev2, rev1) = (rev1, rev2)
956
 
 
957
 
        mutter('encoding log as %r', bzrlib.user_encoding)
958
 
 
959
 
        # use 'replace' so that we don't abort if trying to write out
960
 
        # in e.g. the default C locale.
961
 
        outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
962
 
 
963
 
        log_format = get_log_format(long=long, short=short, line=line)
964
 
        lf = log_formatter(log_format,
965
 
                           show_ids=show_ids,
966
 
                           to_file=outf,
967
 
                           show_timezone=timezone)
968
 
 
969
 
        show_log(b,
970
 
                 lf,
971
 
                 file_id,
972
 
                 verbose=verbose,
973
 
                 direction=direction,
974
 
                 start_revision=rev1,
975
 
                 end_revision=rev2,
976
 
                 search=message)
977
 
 
978
 
def get_log_format(long=False, short=False, line=False, default='long'):
979
 
    log_format = default
980
 
    if long:
981
 
        log_format = 'long'
982
 
    if short:
983
 
        log_format = 'short'
984
 
    if line:
985
 
        log_format = 'line'
986
 
    return log_format
987
 
 
988
 
 
989
 
class cmd_touching_revisions(Command):
990
 
    """Return revision-ids which affected a particular file.
991
 
 
992
 
    A more user-friendly interface is "bzr log FILE"."""
993
 
    hidden = True
994
 
    takes_args = ["filename"]
995
 
    @display_command
996
 
    def run(self, filename):
997
 
        tree, relpath = WorkingTree.open_containing(filename)
998
 
        b = tree.branch
999
 
        inv = tree.read_working_inventory()
1000
 
        file_id = inv.path2id(relpath)
1001
 
        for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
1002
 
            print "%6d %s" % (revno, what)
1003
 
 
1004
 
 
1005
 
class cmd_ls(Command):
1006
 
    """List files in a tree.
1007
 
    """
1008
 
    # TODO: Take a revision or remote path and list that tree instead.
1009
 
    hidden = True
1010
 
    takes_options = ['verbose', 'revision',
1011
 
                     Option('non-recursive',
1012
 
                            help='don\'t recurse into sub-directories'),
1013
 
                     Option('from-root',
1014
 
                            help='Print all paths from the root of the branch.'),
1015
 
                     Option('unknown', help='Print unknown files'),
1016
 
                     Option('versioned', help='Print versioned files'),
1017
 
                     Option('ignored', help='Print ignored files'),
1018
 
 
1019
 
                     Option('null', help='Null separate the files'),
1020
 
                    ]
1021
 
    @display_command
1022
 
    def run(self, revision=None, verbose=False, 
1023
 
            non_recursive=False, from_root=False,
1024
 
            unknown=False, versioned=False, ignored=False,
1025
 
            null=False):
1026
 
 
1027
 
        if verbose and null:
1028
 
            raise BzrCommandError('Cannot set both --verbose and --null')
1029
 
        all = not (unknown or versioned or ignored)
1030
 
 
1031
 
        selection = {'I':ignored, '?':unknown, 'V':versioned}
1032
 
 
1033
 
        tree, relpath = WorkingTree.open_containing(u'.')
1034
 
        if from_root:
1035
 
            relpath = u''
1036
 
        elif relpath:
1037
 
            relpath += '/'
1038
 
        if revision is not None:
1039
 
            tree = tree.branch.revision_tree(
1040
 
                revision[0].in_history(tree.branch).rev_id)
1041
 
        for fp, fc, kind, fid, entry in tree.list_files():
1042
 
            if fp.startswith(relpath):
1043
 
                fp = fp[len(relpath):]
1044
 
                if non_recursive and '/' in fp:
1045
 
                    continue
1046
 
                if not all and not selection[fc]:
1047
 
                    continue
1048
 
                if verbose:
1049
 
                    kindch = entry.kind_character()
1050
 
                    print '%-8s %s%s' % (fc, fp, kindch)
1051
 
                elif null:
1052
 
                    sys.stdout.write(fp)
1053
 
                    sys.stdout.write('\0')
1054
 
                    sys.stdout.flush()
1055
 
                else:
1056
 
                    print fp
1057
 
 
1058
 
 
1059
 
class cmd_unknowns(Command):
1060
 
    """List unknown files."""
1061
 
    @display_command
1062
 
    def run(self):
1063
 
        from bzrlib.osutils import quotefn
1064
 
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
1065
 
            print quotefn(f)
1066
 
 
1067
 
 
1068
 
class cmd_ignore(Command):
1069
 
    """Ignore a command or pattern.
1070
 
 
1071
 
    To remove patterns from the ignore list, edit the .bzrignore file.
1072
 
 
1073
 
    If the pattern contains a slash, it is compared to the whole path
1074
 
    from the branch root.  Otherwise, it is compared to only the last
1075
 
    component of the path.  To match a file only in the root directory,
1076
 
    prepend './'.
1077
 
 
1078
 
    Ignore patterns are case-insensitive on case-insensitive systems.
1079
 
 
1080
 
    Note: wildcards must be quoted from the shell on Unix.
1081
 
 
1082
 
    examples:
1083
 
        bzr ignore ./Makefile
1084
 
        bzr ignore '*.class'
1085
 
    """
1086
 
    # TODO: Complain if the filename is absolute
1087
 
    takes_args = ['name_pattern']
1088
 
    
1089
 
    def run(self, name_pattern):
1090
 
        from bzrlib.atomicfile import AtomicFile
1091
 
        import os.path
1092
 
 
1093
 
        tree, relpath = WorkingTree.open_containing(u'.')
1094
 
        ifn = tree.abspath('.bzrignore')
1095
 
 
1096
 
        if os.path.exists(ifn):
1097
 
            f = open(ifn, 'rt')
1098
 
            try:
1099
 
                igns = f.read().decode('utf-8')
1100
 
            finally:
1101
 
                f.close()
1102
 
        else:
1103
 
            igns = ''
1104
 
 
1105
 
        # TODO: If the file already uses crlf-style termination, maybe
1106
 
        # we should use that for the newly added lines?
1107
 
 
1108
 
        if igns and igns[-1] != '\n':
1109
 
            igns += '\n'
1110
 
        igns += name_pattern + '\n'
1111
 
 
1112
 
        try:
1113
 
            f = AtomicFile(ifn, 'wt')
1114
 
            f.write(igns.encode('utf-8'))
1115
 
            f.commit()
1116
 
        finally:
1117
 
            f.close()
1118
 
 
1119
 
        inv = tree.inventory
1120
 
        if inv.path2id('.bzrignore'):
1121
 
            mutter('.bzrignore is already versioned')
1122
 
        else:
1123
 
            mutter('need to make new .bzrignore file versioned')
1124
 
            tree.add(['.bzrignore'])
1125
 
 
1126
 
 
1127
 
class cmd_ignored(Command):
1128
 
    """List ignored files and the patterns that matched them.
1129
 
 
1130
 
    See also: bzr ignore"""
1131
 
    @display_command
1132
 
    def run(self):
1133
 
        tree = WorkingTree.open_containing(u'.')[0]
1134
 
        for path, file_class, kind, file_id, entry in tree.list_files():
1135
 
            if file_class != 'I':
1136
 
                continue
1137
 
            ## XXX: Slightly inefficient since this was already calculated
1138
 
            pat = tree.is_ignored(path)
1139
 
            print '%-50s %s' % (path, pat)
1140
 
 
1141
 
 
1142
 
class cmd_lookup_revision(Command):
1143
 
    """Lookup the revision-id from a revision-number
1144
 
 
1145
 
    example:
1146
 
        bzr lookup-revision 33
1147
 
    """
1148
 
    hidden = True
1149
 
    takes_args = ['revno']
1150
 
    
1151
 
    @display_command
1152
 
    def run(self, revno):
1153
 
        try:
1154
 
            revno = int(revno)
1155
 
        except ValueError:
1156
 
            raise BzrCommandError("not a valid revision-number: %r" % revno)
1157
 
 
1158
 
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1159
 
 
1160
 
 
1161
 
class cmd_export(Command):
1162
 
    """Export past revision to destination directory.
1163
 
 
1164
 
    If no revision is specified this exports the last committed revision.
1165
 
 
1166
 
    Format may be an "exporter" name, such as tar, tgz, tbz2.  If none is
1167
 
    given, try to find the format with the extension. If no extension
1168
 
    is found exports to a directory (equivalent to --format=dir).
1169
 
 
1170
 
    Root may be the top directory for tar, tgz and tbz2 formats. If none
1171
 
    is given, the top directory will be the root name of the file.
1172
 
 
1173
 
    Note: export of tree with non-ascii filenames to zip is not supported.
1174
 
 
1175
 
    Supported formats       Autodetected by extension
1176
 
    -----------------       -------------------------
1177
 
         dir                            -
1178
 
         tar                          .tar
1179
 
         tbz2                    .tar.bz2, .tbz2
1180
 
         tgz                      .tar.gz, .tgz
1181
 
         zip                          .zip
1182
 
    """
1183
 
    takes_args = ['dest']
1184
 
    takes_options = ['revision', 'format', 'root']
1185
 
    def run(self, dest, revision=None, format=None, root=None):
1186
 
        import os.path
1187
 
        from bzrlib.export import export
1188
 
        tree = WorkingTree.open_containing(u'.')[0]
1189
 
        b = tree.branch
1190
 
        if revision is None:
1191
 
            # should be tree.last_revision  FIXME
1192
 
            rev_id = b.last_revision()
1193
 
        else:
1194
 
            if len(revision) != 1:
1195
 
                raise BzrError('bzr export --revision takes exactly 1 argument')
1196
 
            rev_id = revision[0].in_history(b).rev_id
1197
 
        t = b.revision_tree(rev_id)
1198
 
        try:
1199
 
            export(t, dest, format, root)
1200
 
        except errors.NoSuchExportFormat, e:
1201
 
            raise BzrCommandError('Unsupported export format: %s' % e.format)
1202
 
 
1203
 
 
1204
 
class cmd_cat(Command):
1205
 
    """Write a file's text from a previous revision."""
1206
 
 
1207
 
    takes_options = ['revision']
1208
 
    takes_args = ['filename']
1209
 
 
1210
 
    @display_command
1211
 
    def run(self, filename, revision=None):
1212
 
        if revision is not None and len(revision) != 1:
1213
 
            raise BzrCommandError("bzr cat --revision takes exactly one number")
1214
 
        tree = None
1215
 
        try:
1216
 
            tree, relpath = WorkingTree.open_containing(filename)
1217
 
            b = tree.branch
1218
 
        except NotBranchError:
1219
 
            pass
1220
 
 
1221
 
        if tree is None:
1222
 
            b, relpath = Branch.open_containing(filename)
1223
 
        if revision is None:
1224
 
            revision_id = b.last_revision()
1225
 
        else:
1226
 
            revision_id = revision[0].in_history(b).rev_id
1227
 
        b.print_file(relpath, revision_id)
1228
 
 
1229
 
 
1230
 
class cmd_local_time_offset(Command):
1231
 
    """Show the offset in seconds from GMT to local time."""
1232
 
    hidden = True    
1233
 
    @display_command
1234
 
    def run(self):
1235
 
        print bzrlib.osutils.local_time_offset()
1236
 
 
1237
 
 
1238
 
 
1239
 
class cmd_commit(Command):
1240
 
    """Commit changes into a new revision.
1241
 
    
1242
 
    If no arguments are given, the entire tree is committed.
1243
 
 
1244
 
    If selected files are specified, only changes to those files are
1245
 
    committed.  If a directory is specified then the directory and everything 
1246
 
    within it is committed.
1247
 
 
1248
 
    A selected-file commit may fail in some cases where the committed
1249
 
    tree would be invalid, such as trying to commit a file in a
1250
 
    newly-added directory that is not itself committed.
1251
 
    """
1252
 
    # TODO: Run hooks on tree to-be-committed, and after commit.
1253
 
 
1254
 
    # TODO: Strict commit that fails if there are deleted files.
1255
 
    #       (what does "deleted files" mean ??)
1256
 
 
1257
 
    # TODO: Give better message for -s, --summary, used by tla people
1258
 
 
1259
 
    # XXX: verbose currently does nothing
1260
 
 
1261
 
    takes_args = ['selected*']
1262
 
    takes_options = ['message', 'verbose', 
1263
 
                     Option('unchanged',
1264
 
                            help='commit even if nothing has changed'),
1265
 
                     Option('file', type=str, 
1266
 
                            argname='msgfile',
1267
 
                            help='file containing commit message'),
1268
 
                     Option('strict',
1269
 
                            help="refuse to commit if there are unknown "
1270
 
                            "files in the working tree."),
1271
 
                     ]
1272
 
    aliases = ['ci', 'checkin']
1273
 
 
1274
 
    def run(self, message=None, file=None, verbose=True, selected_list=None,
1275
 
            unchanged=False, strict=False):
1276
 
        from bzrlib.errors import (PointlessCommit, ConflictsInTree,
1277
 
                StrictCommitFailed)
1278
 
        from bzrlib.msgeditor import edit_commit_message, \
1279
 
                make_commit_message_template
1280
 
        from bzrlib.status import show_status
1281
 
        from tempfile import TemporaryFile
1282
 
        import codecs
1283
 
 
1284
 
        # TODO: Need a blackbox test for invoking the external editor; may be
1285
 
        # slightly problematic to run this cross-platform.
1286
 
 
1287
 
        # TODO: do more checks that the commit will succeed before 
1288
 
        # spending the user's valuable time typing a commit message.
1289
 
        #
1290
 
        # TODO: if the commit *does* happen to fail, then save the commit 
1291
 
        # message to a temporary file where it can be recovered
1292
 
        tree, selected_list = tree_files(selected_list)
1293
 
        if message is None and not file:
1294
 
            template = make_commit_message_template(tree, selected_list)
1295
 
            message = edit_commit_message(template)
1296
 
            if message is None:
1297
 
                raise BzrCommandError("please specify a commit message"
1298
 
                                      " with either --message or --file")
1299
 
        elif message and file:
1300
 
            raise BzrCommandError("please specify either --message or --file")
1301
 
        
1302
 
        if file:
1303
 
            import codecs
1304
 
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1305
 
 
1306
 
        if message == "":
1307
 
                raise BzrCommandError("empty commit message specified")
1308
 
            
1309
 
        try:
1310
 
            tree.commit(message, specific_files=selected_list,
1311
 
                        allow_pointless=unchanged, strict=strict)
1312
 
        except PointlessCommit:
1313
 
            # FIXME: This should really happen before the file is read in;
1314
 
            # perhaps prepare the commit; get the message; then actually commit
1315
 
            raise BzrCommandError("no changes to commit",
1316
 
                                  ["use --unchanged to commit anyhow"])
1317
 
        except ConflictsInTree:
1318
 
            raise BzrCommandError("Conflicts detected in working tree.  "
1319
 
                'Use "bzr conflicts" to list, "bzr resolve FILE" to resolve.')
1320
 
        except StrictCommitFailed:
1321
 
            raise BzrCommandError("Commit refused because there are unknown "
1322
 
                                  "files in the working tree.")
1323
 
        note('Committed revision %d.' % (tree.branch.revno(),))
1324
 
 
1325
 
 
1326
 
class cmd_check(Command):
1327
 
    """Validate consistency of branch history.
1328
 
 
1329
 
    This command checks various invariants about the branch storage to
1330
 
    detect data corruption or bzr bugs.
1331
 
    """
1332
 
    takes_args = ['branch?']
1333
 
    takes_options = ['verbose']
1334
 
 
1335
 
    def run(self, branch=None, verbose=False):
1336
 
        from bzrlib.check import check
1337
 
        if branch is None:
1338
 
            tree = WorkingTree.open_containing()[0]
1339
 
            branch = tree.branch
1340
 
        else:
1341
 
            branch = Branch.open(branch)
1342
 
        check(branch, verbose)
1343
 
 
1344
 
 
1345
 
class cmd_scan_cache(Command):
1346
 
    hidden = True
1347
 
    def run(self):
1348
 
        from bzrlib.hashcache import HashCache
1349
 
 
1350
 
        c = HashCache(u'.')
1351
 
        c.read()
1352
 
        c.scan()
1353
 
            
1354
 
        print '%6d stats' % c.stat_count
1355
 
        print '%6d in hashcache' % len(c._cache)
1356
 
        print '%6d files removed from cache' % c.removed_count
1357
 
        print '%6d hashes updated' % c.update_count
1358
 
        print '%6d files changed too recently to cache' % c.danger_count
1359
 
 
1360
 
        if c.needs_write:
1361
 
            c.write()
1362
 
            
1363
 
 
1364
 
 
1365
 
class cmd_upgrade(Command):
1366
 
    """Upgrade branch storage to current format.
1367
 
 
1368
 
    The check command or bzr developers may sometimes advise you to run
1369
 
    this command.
1370
 
 
1371
 
    This version of this command upgrades from the full-text storage
1372
 
    used by bzr 0.0.8 and earlier to the weave format (v5).
1373
 
    """
1374
 
    takes_args = ['dir?']
1375
 
 
1376
 
    def run(self, dir=u'.'):
1377
 
        from bzrlib.upgrade import upgrade
1378
 
        upgrade(dir)
1379
 
 
1380
 
 
1381
 
class cmd_whoami(Command):
1382
 
    """Show bzr user id."""
1383
 
    takes_options = ['email']
1384
 
    
1385
 
    @display_command
1386
 
    def run(self, email=False):
1387
 
        try:
1388
 
            b = WorkingTree.open_containing(u'.')[0].branch
1389
 
            config = bzrlib.config.BranchConfig(b)
1390
 
        except NotBranchError:
1391
 
            config = bzrlib.config.GlobalConfig()
1392
 
        
1393
 
        if email:
1394
 
            print config.user_email()
1395
 
        else:
1396
 
            print config.username()
1397
 
 
1398
 
class cmd_nick(Command):
1399
 
    """\
1400
 
    Print or set the branch nickname.  
1401
 
    If unset, the tree root directory name is used as the nickname
1402
 
    To print the current nickname, execute with no argument.  
1403
 
    """
1404
 
    takes_args = ['nickname?']
1405
 
    def run(self, nickname=None):
1406
 
        branch = Branch.open_containing(u'.')[0]
1407
 
        if nickname is None:
1408
 
            self.printme(branch)
1409
 
        else:
1410
 
            branch.nick = nickname
1411
 
 
1412
 
    @display_command
1413
 
    def printme(self, branch):
1414
 
        print branch.nick 
1415
 
 
1416
 
class cmd_selftest(Command):
1417
 
    """Run internal test suite.
1418
 
    
1419
 
    This creates temporary test directories in the working directory,
1420
 
    but not existing data is affected.  These directories are deleted
1421
 
    if the tests pass, or left behind to help in debugging if they
1422
 
    fail and --keep-output is specified.
1423
 
    
1424
 
    If arguments are given, they are regular expressions that say
1425
 
    which tests should run.
1426
 
    """
1427
 
    # TODO: --list should give a list of all available tests
1428
 
    hidden = True
1429
 
    takes_args = ['testspecs*']
1430
 
    takes_options = ['verbose', 
1431
 
                     Option('one', help='stop when one test fails'),
1432
 
                     Option('keep-output', 
1433
 
                            help='keep output directories when tests fail')
1434
 
                    ]
1435
 
 
1436
 
    def run(self, testspecs_list=None, verbose=False, one=False,
1437
 
            keep_output=False):
1438
 
        import bzrlib.ui
1439
 
        from bzrlib.tests import selftest
1440
 
        # we don't want progress meters from the tests to go to the
1441
 
        # real output; and we don't want log messages cluttering up
1442
 
        # the real logs.
1443
 
        save_ui = bzrlib.ui.ui_factory
1444
 
        bzrlib.trace.info('running tests...')
1445
 
        try:
1446
 
            bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
1447
 
            if testspecs_list is not None:
1448
 
                pattern = '|'.join(testspecs_list)
1449
 
            else:
1450
 
                pattern = ".*"
1451
 
            result = selftest(verbose=verbose, 
1452
 
                              pattern=pattern,
1453
 
                              stop_on_failure=one, 
1454
 
                              keep_output=keep_output)
1455
 
            if result:
1456
 
                bzrlib.trace.info('tests passed')
1457
 
            else:
1458
 
                bzrlib.trace.info('tests failed')
1459
 
            return int(not result)
1460
 
        finally:
1461
 
            bzrlib.ui.ui_factory = save_ui
1462
 
 
1463
 
 
1464
 
def _get_bzr_branch():
1465
 
    """If bzr is run from a branch, return Branch or None"""
1466
 
    import bzrlib.errors
1467
 
    from bzrlib.branch import Branch
1468
 
    from bzrlib.osutils import abspath
1469
 
    from os.path import dirname
1470
 
    
1471
 
    try:
1472
 
        branch = Branch.open(dirname(abspath(dirname(__file__))))
1473
 
        return branch
1474
 
    except bzrlib.errors.BzrError:
1475
 
        return None
1476
 
    
1477
 
 
1478
 
def show_version():
1479
 
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
1480
 
    # is bzrlib itself in a branch?
1481
 
    branch = _get_bzr_branch()
1482
 
    if branch:
1483
 
        rh = branch.revision_history()
1484
 
        revno = len(rh)
1485
 
        print "  bzr checkout, revision %d" % (revno,)
1486
 
        print "  nick: %s" % (branch.nick,)
1487
 
        if rh:
1488
 
            print "  revid: %s" % (rh[-1],)
1489
 
    print bzrlib.__copyright__
1490
 
    print "http://bazaar-ng.org/"
1491
 
    print
1492
 
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
1493
 
    print "you may use, modify and redistribute it under the terms of the GNU"
1494
 
    print "General Public License version 2 or later."
1495
 
 
1496
 
 
1497
 
class cmd_version(Command):
1498
 
    """Show version of bzr."""
1499
 
    @display_command
1500
 
    def run(self):
1501
 
        show_version()
1502
 
 
1503
 
class cmd_rocks(Command):
1504
 
    """Statement of optimism."""
1505
 
    hidden = True
1506
 
    @display_command
1507
 
    def run(self):
1508
 
        print "it sure does!"
1509
 
 
1510
 
 
1511
 
class cmd_find_merge_base(Command):
1512
 
    """Find and print a base revision for merging two branches.
1513
 
    """
1514
 
    # TODO: Options to specify revisions on either side, as if
1515
 
    #       merging only part of the history.
1516
 
    takes_args = ['branch', 'other']
1517
 
    hidden = True
1518
 
    
1519
 
    @display_command
1520
 
    def run(self, branch, other):
1521
 
        from bzrlib.revision import common_ancestor, MultipleRevisionSources
1522
 
        
1523
 
        branch1 = Branch.open_containing(branch)[0]
1524
 
        branch2 = Branch.open_containing(other)[0]
1525
 
 
1526
 
        history_1 = branch1.revision_history()
1527
 
        history_2 = branch2.revision_history()
1528
 
 
1529
 
        last1 = branch1.last_revision()
1530
 
        last2 = branch2.last_revision()
1531
 
 
1532
 
        source = MultipleRevisionSources(branch1, branch2)
1533
 
        
1534
 
        base_rev_id = common_ancestor(last1, last2, source)
1535
 
 
1536
 
        print 'merge base is revision %s' % base_rev_id
1537
 
        
1538
 
        return
1539
 
 
1540
 
        if base_revno is None:
1541
 
            raise bzrlib.errors.UnrelatedBranches()
1542
 
 
1543
 
        print ' r%-6d in %s' % (base_revno, branch)
1544
 
 
1545
 
        other_revno = branch2.revision_id_to_revno(base_revid)
1546
 
        
1547
 
        print ' r%-6d in %s' % (other_revno, other)
1548
 
 
1549
 
 
1550
 
 
1551
 
class cmd_merge(Command):
1552
 
    """Perform a three-way merge.
1553
 
    
1554
 
    The branch is the branch you will merge from.  By default, it will
1555
 
    merge the latest revision.  If you specify a revision, that
1556
 
    revision will be merged.  If you specify two revisions, the first
1557
 
    will be used as a BASE, and the second one as OTHER.  Revision
1558
 
    numbers are always relative to the specified branch.
1559
 
 
1560
 
    By default bzr will try to merge in all new work from the other
1561
 
    branch, automatically determining an appropriate base.  If this
1562
 
    fails, you may need to give an explicit base.
1563
 
    
1564
 
    Examples:
1565
 
 
1566
 
    To merge the latest revision from bzr.dev
1567
 
    bzr merge ../bzr.dev
1568
 
 
1569
 
    To merge changes up to and including revision 82 from bzr.dev
1570
 
    bzr merge -r 82 ../bzr.dev
1571
 
 
1572
 
    To merge the changes introduced by 82, without previous changes:
1573
 
    bzr merge -r 81..82 ../bzr.dev
1574
 
    
1575
 
    merge refuses to run if there are any uncommitted changes, unless
1576
 
    --force is given.
1577
 
    """
1578
 
    takes_args = ['branch?']
1579
 
    takes_options = ['revision', 'force', 'merge-type', 'reprocess',
1580
 
                     Option('show-base', help="Show base revision text in "
1581
 
                            "conflicts")]
1582
 
 
1583
 
    def run(self, branch=None, revision=None, force=False, merge_type=None,
1584
 
            show_base=False, reprocess=False):
1585
 
        from bzrlib.merge import merge
1586
 
        from bzrlib.merge_core import ApplyMerge3
1587
 
        if merge_type is None:
1588
 
            merge_type = ApplyMerge3
1589
 
        if branch is None:
1590
 
            branch = WorkingTree.open_containing(u'.')[0].branch.get_parent()
1591
 
            if branch is None:
1592
 
                raise BzrCommandError("No merge location known or specified.")
1593
 
            else:
1594
 
                print "Using saved location: %s" % branch 
1595
 
        if revision is None or len(revision) < 1:
1596
 
            base = [None, None]
1597
 
            other = [branch, -1]
1598
 
        else:
1599
 
            if len(revision) == 1:
1600
 
                base = [None, None]
1601
 
                other_branch = Branch.open_containing(branch)[0]
1602
 
                revno = revision[0].in_history(other_branch).revno
1603
 
                other = [branch, revno]
1604
 
            else:
1605
 
                assert len(revision) == 2
1606
 
                if None in revision:
1607
 
                    raise BzrCommandError(
1608
 
                        "Merge doesn't permit that revision specifier.")
1609
 
                b = Branch.open_containing(branch)[0]
1610
 
 
1611
 
                base = [branch, revision[0].in_history(b).revno]
1612
 
                other = [branch, revision[1].in_history(b).revno]
1613
 
 
1614
 
        try:
1615
 
            conflict_count = merge(other, base, check_clean=(not force),
1616
 
                                   merge_type=merge_type, reprocess=reprocess,
1617
 
                                   show_base=show_base)
1618
 
            if conflict_count != 0:
1619
 
                return 1
1620
 
            else:
1621
 
                return 0
1622
 
        except bzrlib.errors.AmbiguousBase, e:
1623
 
            m = ("sorry, bzr can't determine the right merge base yet\n"
1624
 
                 "candidates are:\n  "
1625
 
                 + "\n  ".join(e.bases)
1626
 
                 + "\n"
1627
 
                 "please specify an explicit base with -r,\n"
1628
 
                 "and (if you want) report this to the bzr developers\n")
1629
 
            log_error(m)
1630
 
 
1631
 
 
1632
 
class cmd_remerge(Command):
1633
 
    """Redo a merge.
1634
 
    """
1635
 
    takes_args = ['file*']
1636
 
    takes_options = ['merge-type', 'reprocess',
1637
 
                     Option('show-base', help="Show base revision text in "
1638
 
                            "conflicts")]
1639
 
 
1640
 
    def run(self, file_list=None, merge_type=None, show_base=False,
1641
 
            reprocess=False):
1642
 
        from bzrlib.merge import merge_inner, transform_tree
1643
 
        from bzrlib.merge_core import ApplyMerge3
1644
 
        if merge_type is None:
1645
 
            merge_type = ApplyMerge3
1646
 
        tree, file_list = tree_files(file_list)
1647
 
        tree.lock_write()
1648
 
        try:
1649
 
            pending_merges = tree.pending_merges() 
1650
 
            if len(pending_merges) != 1:
1651
 
                raise BzrCommandError("Sorry, remerge only works after normal"
1652
 
                                      + " merges.  Not cherrypicking or"
1653
 
                                      + "multi-merges.")
1654
 
            base_revision = common_ancestor(tree.branch.last_revision(), 
1655
 
                                            pending_merges[0], tree.branch)
1656
 
            base_tree = tree.branch.revision_tree(base_revision)
1657
 
            other_tree = tree.branch.revision_tree(pending_merges[0])
1658
 
            interesting_ids = None
1659
 
            if file_list is not None:
1660
 
                interesting_ids = set()
1661
 
                for filename in file_list:
1662
 
                    file_id = tree.path2id(filename)
1663
 
                    interesting_ids.add(file_id)
1664
 
                    if tree.kind(file_id) != "directory":
1665
 
                        continue
1666
 
                    
1667
 
                    for name, ie in tree.inventory.iter_entries(file_id):
1668
 
                        interesting_ids.add(ie.file_id)
1669
 
            transform_tree(tree, tree.branch.basis_tree(), interesting_ids)
1670
 
            if file_list is None:
1671
 
                restore_files = list(tree.iter_conflicts())
1672
 
            else:
1673
 
                restore_files = file_list
1674
 
            for filename in restore_files:
1675
 
                try:
1676
 
                    restore(tree.abspath(filename))
1677
 
                except NotConflicted:
1678
 
                    pass
1679
 
            conflicts =  merge_inner(tree.branch, other_tree, base_tree, 
1680
 
                                     interesting_ids = interesting_ids, 
1681
 
                                     other_rev_id=pending_merges[0], 
1682
 
                                     merge_type=merge_type, 
1683
 
                                     show_base=show_base,
1684
 
                                     reprocess=reprocess)
1685
 
        finally:
1686
 
            tree.unlock()
1687
 
        if conflicts > 0:
1688
 
            return 1
1689
 
        else:
1690
 
            return 0
1691
 
 
1692
 
class cmd_revert(Command):
1693
 
    """Reverse all changes since the last commit.
1694
 
 
1695
 
    Only versioned files are affected.  Specify filenames to revert only 
1696
 
    those files.  By default, any files that are changed will be backed up
1697
 
    first.  Backup files have a '~' appended to their name.
1698
 
    """
1699
 
    takes_options = ['revision', 'no-backup']
1700
 
    takes_args = ['file*']
1701
 
    aliases = ['merge-revert']
1702
 
 
1703
 
    def run(self, revision=None, no_backup=False, file_list=None):
1704
 
        from bzrlib.merge import merge_inner
1705
 
        from bzrlib.commands import parse_spec
1706
 
        if file_list is not None:
1707
 
            if len(file_list) == 0:
1708
 
                raise BzrCommandError("No files specified")
1709
 
        else:
1710
 
            file_list = []
1711
 
        if revision is None:
1712
 
            revno = -1
1713
 
            tree = WorkingTree.open_containing(u'.')[0]
1714
 
            # FIXME should be tree.last_revision
1715
 
            rev_id = tree.branch.last_revision()
1716
 
        elif len(revision) != 1:
1717
 
            raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
1718
 
        else:
1719
 
            tree, file_list = tree_files(file_list)
1720
 
            rev_id = revision[0].in_history(tree.branch).rev_id
1721
 
        tree.revert(file_list, tree.branch.revision_tree(rev_id),
1722
 
                                not no_backup)
1723
 
 
1724
 
 
1725
 
class cmd_assert_fail(Command):
1726
 
    """Test reporting of assertion failures"""
1727
 
    hidden = True
1728
 
    def run(self):
1729
 
        assert False, "always fails"
1730
 
 
1731
 
 
1732
 
class cmd_help(Command):
1733
 
    """Show help on a command or other topic.
1734
 
 
1735
 
    For a list of all available commands, say 'bzr help commands'."""
1736
 
    takes_options = ['long']
1737
 
    takes_args = ['topic?']
1738
 
    aliases = ['?']
1739
 
    
1740
 
    @display_command
1741
 
    def run(self, topic=None, long=False):
1742
 
        import help
1743
 
        if topic is None and long:
1744
 
            topic = "commands"
1745
 
        help.help(topic)
1746
 
 
1747
 
 
1748
 
class cmd_shell_complete(Command):
1749
 
    """Show appropriate completions for context.
1750
 
 
1751
 
    For a list of all available commands, say 'bzr shell-complete'."""
1752
 
    takes_args = ['context?']
1753
 
    aliases = ['s-c']
1754
 
    hidden = True
1755
 
    
1756
 
    @display_command
1757
 
    def run(self, context=None):
1758
 
        import shellcomplete
1759
 
        shellcomplete.shellcomplete(context)
1760
 
 
1761
 
 
1762
 
class cmd_fetch(Command):
1763
 
    """Copy in history from another branch but don't merge it.
1764
 
 
1765
 
    This is an internal method used for pull and merge."""
1766
 
    hidden = True
1767
 
    takes_args = ['from_branch', 'to_branch']
1768
 
    def run(self, from_branch, to_branch):
1769
 
        from bzrlib.fetch import Fetcher
1770
 
        from bzrlib.branch import Branch
1771
 
        from_b = Branch.open(from_branch)
1772
 
        to_b = Branch.open(to_branch)
1773
 
        from_b.lock_read()
1774
 
        try:
1775
 
            to_b.lock_write()
1776
 
            try:
1777
 
                Fetcher(to_b, from_b)
1778
 
            finally:
1779
 
                to_b.unlock()
1780
 
        finally:
1781
 
            from_b.unlock()
1782
 
 
1783
 
 
1784
 
class cmd_missing(Command):
1785
 
    """Show unmerged/unpulled revisions between two branches.
1786
 
 
1787
 
    OTHER_BRANCH may be local or remote."""
1788
 
    takes_args = ['other_branch?']
1789
 
    takes_options = [Option('reverse', 'Reverse the order of revisions'),
1790
 
                     Option('mine-only', 
1791
 
                            'Display changes in the local branch only'),
1792
 
                     Option('theirs-only', 
1793
 
                            'Display changes in the remote branch only'), 
1794
 
                     'line',
1795
 
                     'long', 
1796
 
                     'short',
1797
 
                     'show-ids',
1798
 
                     'verbose'
1799
 
                     ]
1800
 
 
1801
 
    def run(self, other_branch=None, reverse=False, mine_only=False,
1802
 
            theirs_only=False, long=True, short=False, line=False, 
1803
 
            show_ids=False, verbose=False):
1804
 
        from bzrlib.missing import find_unmerged, iter_log_data
1805
 
        from bzrlib.log import log_formatter
1806
 
        local_branch = bzrlib.branch.Branch.open_containing(u".")[0]
1807
 
        parent = local_branch.get_parent()
1808
 
        if other_branch is None:
1809
 
            other_branch = parent
1810
 
            if other_branch is None:
1811
 
                raise BzrCommandError("No missing location known or specified.")
1812
 
            print "Using last location: " + local_branch.get_parent()
1813
 
        remote_branch = bzrlib.branch.Branch.open(other_branch)
1814
 
        local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
1815
 
        log_format = get_log_format(long=long, short=short, line=line)
1816
 
        lf = log_formatter(log_format, sys.stdout,
1817
 
                           show_ids=show_ids,
1818
 
                           show_timezone='original')
1819
 
        if reverse is False:
1820
 
            local_extra.reverse()
1821
 
            remote_extra.reverse()
1822
 
        if local_extra and not theirs_only:
1823
 
            print "You have %d extra revision(s):" % len(local_extra)
1824
 
            for data in iter_log_data(local_extra, local_branch, verbose):
1825
 
                lf.show(*data)
1826
 
            printed_local = True
1827
 
        else:
1828
 
            printed_local = False
1829
 
        if remote_extra and not mine_only:
1830
 
            if printed_local is True:
1831
 
                print "\n\n"
1832
 
            print "You are missing %d revision(s):" % len(remote_extra)
1833
 
            for data in iter_log_data(remote_extra, remote_branch, verbose):
1834
 
                lf.show(*data)
1835
 
        if not remote_extra and not local_extra:
1836
 
            status_code = 0
1837
 
            print "Branches are up to date."
1838
 
        else:
1839
 
            status_code = 1
1840
 
        if parent is None and other_branch is not None:
1841
 
            local_branch.set_parent(other_branch)
1842
 
        return status_code
1843
 
 
1844
 
 
1845
 
class cmd_plugins(Command):
1846
 
    """List plugins"""
1847
 
    hidden = True
1848
 
    @display_command
1849
 
    def run(self):
1850
 
        import bzrlib.plugin
1851
 
        from inspect import getdoc
1852
 
        for name, plugin in bzrlib.plugin.all_plugins().items():
1853
 
            if hasattr(plugin, '__path__'):
1854
 
                print plugin.__path__[0]
1855
 
            elif hasattr(plugin, '__file__'):
1856
 
                print plugin.__file__
1857
 
            else:
1858
 
                print `plugin`
1859
 
                
1860
 
            d = getdoc(plugin)
1861
 
            if d:
1862
 
                print '\t', d.split('\n')[0]
1863
 
 
1864
 
 
1865
 
class cmd_testament(Command):
1866
 
    """Show testament (signing-form) of a revision."""
1867
 
    takes_options = ['revision', 'long']
1868
 
    takes_args = ['branch?']
1869
 
    @display_command
1870
 
    def run(self, branch=u'.', revision=None, long=False):
1871
 
        from bzrlib.testament import Testament
1872
 
        b = WorkingTree.open_containing(branch)[0].branch
1873
 
        b.lock_read()
1874
 
        try:
1875
 
            if revision is None:
1876
 
                rev_id = b.last_revision()
1877
 
            else:
1878
 
                rev_id = revision[0].in_history(b).rev_id
1879
 
            t = Testament.from_revision(b, rev_id)
1880
 
            if long:
1881
 
                sys.stdout.writelines(t.as_text_lines())
1882
 
            else:
1883
 
                sys.stdout.write(t.as_short_text())
1884
 
        finally:
1885
 
            b.unlock()
1886
 
 
1887
 
 
1888
 
class cmd_annotate(Command):
1889
 
    """Show the origin of each line in a file.
1890
 
 
1891
 
    This prints out the given file with an annotation on the left side
1892
 
    indicating which revision, author and date introduced the change.
1893
 
 
1894
 
    If the origin is the same for a run of consecutive lines, it is 
1895
 
    shown only at the top, unless the --all option is given.
1896
 
    """
1897
 
    # TODO: annotate directories; showing when each file was last changed
1898
 
    # TODO: annotate a previous version of a file
1899
 
    # TODO: if the working copy is modified, show annotations on that 
1900
 
    #       with new uncommitted lines marked
1901
 
    aliases = ['blame', 'praise']
1902
 
    takes_args = ['filename']
1903
 
    takes_options = [Option('all', help='show annotations on all lines'),
1904
 
                     Option('long', help='show date in annotations'),
1905
 
                     ]
1906
 
 
1907
 
    @display_command
1908
 
    def run(self, filename, all=False, long=False):
1909
 
        from bzrlib.annotate import annotate_file
1910
 
        tree, relpath = WorkingTree.open_containing(filename)
1911
 
        branch = tree.branch
1912
 
        branch.lock_read()
1913
 
        try:
1914
 
            file_id = tree.inventory.path2id(relpath)
1915
 
            tree = branch.revision_tree(branch.last_revision())
1916
 
            file_version = tree.inventory[file_id].revision
1917
 
            annotate_file(branch, file_version, file_id, long, all, sys.stdout)
1918
 
        finally:
1919
 
            branch.unlock()
1920
 
 
1921
 
 
1922
 
class cmd_re_sign(Command):
1923
 
    """Create a digital signature for an existing revision."""
1924
 
    # TODO be able to replace existing ones.
1925
 
 
1926
 
    hidden = True # is this right ?
1927
 
    takes_args = ['revision_id?']
1928
 
    takes_options = ['revision']
1929
 
    
1930
 
    def run(self, revision_id=None, revision=None):
1931
 
        import bzrlib.config as config
1932
 
        import bzrlib.gpg as gpg
1933
 
        if revision_id is not None and revision is not None:
1934
 
            raise BzrCommandError('You can only supply one of revision_id or --revision')
1935
 
        if revision_id is None and revision is None:
1936
 
            raise BzrCommandError('You must supply either --revision or a revision_id')
1937
 
        b = WorkingTree.open_containing(u'.')[0].branch
1938
 
        gpg_strategy = gpg.GPGStrategy(config.BranchConfig(b))
1939
 
        if revision_id is not None:
1940
 
            b.sign_revision(revision_id, gpg_strategy)
1941
 
        elif revision is not None:
1942
 
            if len(revision) == 1:
1943
 
                revno, rev_id = revision[0].in_history(b)
1944
 
                b.sign_revision(rev_id, gpg_strategy)
1945
 
            elif len(revision) == 2:
1946
 
                # are they both on rh- if so we can walk between them
1947
 
                # might be nice to have a range helper for arbitrary
1948
 
                # revision paths. hmm.
1949
 
                from_revno, from_revid = revision[0].in_history(b)
1950
 
                to_revno, to_revid = revision[1].in_history(b)
1951
 
                if to_revid is None:
1952
 
                    to_revno = b.revno()
1953
 
                if from_revno is None or to_revno is None:
1954
 
                    raise BzrCommandError('Cannot sign a range of non-revision-history revisions')
1955
 
                for revno in range(from_revno, to_revno + 1):
1956
 
                    b.sign_revision(b.get_rev_id(revno), gpg_strategy)
1957
 
            else:
1958
 
                raise BzrCommandError('Please supply either one revision, or a range.')
1959
 
 
1960
 
 
1961
 
class cmd_uncommit(bzrlib.commands.Command):
1962
 
    """Remove the last committed revision.
1963
 
 
1964
 
    By supplying the --all flag, it will not only remove the entry 
1965
 
    from revision_history, but also remove all of the entries in the
1966
 
    stores.
1967
 
 
1968
 
    --verbose will print out what is being removed.
1969
 
    --dry-run will go through all the motions, but not actually
1970
 
    remove anything.
1971
 
    
1972
 
    In the future, uncommit will create a changeset, which can then
1973
 
    be re-applied.
1974
 
    """
1975
 
    takes_options = ['all', 'verbose', 'revision',
1976
 
                    Option('dry-run', help='Don\'t actually make changes'),
1977
 
                    Option('force', help='Say yes to all questions.')]
1978
 
    takes_args = ['location?']
1979
 
    aliases = []
1980
 
 
1981
 
    def run(self, location=None, all=False,
1982
 
            dry_run=False, verbose=False,
1983
 
            revision=None, force=False):
1984
 
        from bzrlib.branch import Branch
1985
 
        from bzrlib.log import log_formatter
1986
 
        import sys
1987
 
        from bzrlib.uncommit import uncommit
1988
 
 
1989
 
        if location is None:
1990
 
            location = u'.'
1991
 
        b, relpath = Branch.open_containing(location)
1992
 
 
1993
 
        if revision is None:
1994
 
            revno = b.revno()
1995
 
            rev_id = b.last_revision()
1996
 
        else:
1997
 
            revno, rev_id = revision[0].in_history(b)
1998
 
        if rev_id is None:
1999
 
            print 'No revisions to uncommit.'
2000
 
 
2001
 
        for r in range(revno, b.revno()+1):
2002
 
            rev_id = b.get_rev_id(r)
2003
 
            lf = log_formatter('short', to_file=sys.stdout,show_timezone='original')
2004
 
            lf.show(r, b.get_revision(rev_id), None)
2005
 
 
2006
 
        if dry_run:
2007
 
            print 'Dry-run, pretending to remove the above revisions.'
2008
 
            if not force:
2009
 
                val = raw_input('Press <enter> to continue')
2010
 
        else:
2011
 
            print 'The above revision(s) will be removed.'
2012
 
            if not force:
2013
 
                val = raw_input('Are you sure [y/N]? ')
2014
 
                if val.lower() not in ('y', 'yes'):
2015
 
                    print 'Canceled'
2016
 
                    return 0
2017
 
 
2018
 
        uncommit(b, remove_files=all,
2019
 
                dry_run=dry_run, verbose=verbose,
2020
 
                revno=revno)
2021
 
 
2022
 
 
2023
 
# these get imported and then picked up by the scan for cmd_*
2024
 
# TODO: Some more consistent way to split command definitions across files;
2025
 
# we do need to load at least some information about them to know of 
2026
 
# aliases.
2027
 
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore