/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

[merge] add --dry-run option (mpe)

Show diffs side-by-side

added added

removed removed

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