/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

Add custom description for help's --long option, this fixes bug #31217.
There were no real tests for help, so add a bunch of black box tests
to confirm all the various incantations work.

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