/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

  • Committer: Robert Collins
  • Date: 2005-12-15 03:21:11 UTC
  • mfrom: (1185.56.2 fixes)
  • Revision ID: robertc@robertcollins.net-20051215032111-e68d5e6ffbd4b574
* Raise NoSuchFile when someone tries to add a non-existant file.
  (Michael Ellerman)

* Simplify handling of DivergedBranches in cmd_pull().
  (Michael Ellerman)

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