~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Aaron Bentley
  • Date: 2006-05-30 15:18:12 UTC
  • mto: This revision was merged to the branch mainline in revision 1738.
  • Revision ID: abentley@panoramicfeedback.com-20060530151812-0e3e9b78cc15a804
Rename changesets to revision bundles

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2004, 2005, 2006 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 errno
 
21
import os
 
22
import sys
 
23
 
 
24
import bzrlib
 
25
import bzrlib.branch
 
26
from bzrlib.branch import Branch
 
27
import bzrlib.bzrdir as bzrdir
 
28
from bzrlib.bundle.read_bundle import BadBundle, BundleReader
 
29
from bzrlib.bundle.apply_bundle import merge_bundle
 
30
from bzrlib.commands import Command, display_command
 
31
import bzrlib.errors as errors
 
32
from bzrlib.errors import (BzrError, BzrCheckError, BzrCommandError, 
 
33
                           NotBranchError, DivergedBranches, NotConflicted,
 
34
                           NoSuchFile, NoWorkingTree, FileInWrongBranch,
 
35
                           NotVersionedError)
 
36
from bzrlib.log import show_one_log
 
37
from bzrlib.merge import Merge3Merger
 
38
from bzrlib.option import Option
 
39
from bzrlib.progress import DummyProgress, ProgressPhase
 
40
from bzrlib.revision import common_ancestor
 
41
from bzrlib.revisionspec import RevisionSpec
 
42
import bzrlib.trace
 
43
from bzrlib.trace import mutter, note, log_error, warning, is_quiet
 
44
from bzrlib.transport.local import LocalTransport
 
45
import bzrlib.ui
 
46
from bzrlib.workingtree import WorkingTree
 
47
 
 
48
 
 
49
def tree_files(file_list, default_branch=u'.'):
 
50
    try:
 
51
        return internal_tree_files(file_list, default_branch)
 
52
    except FileInWrongBranch, e:
 
53
        raise BzrCommandError("%s is not in the same branch as %s" %
 
54
                             (e.path, file_list[0]))
 
55
 
 
56
 
 
57
# XXX: Bad function name; should possibly also be a class method of
 
58
# WorkingTree rather than a function.
 
59
def internal_tree_files(file_list, default_branch=u'.'):
 
60
    """Convert command-line paths to a WorkingTree and relative paths.
 
61
 
 
62
    This is typically used for command-line processors that take one or
 
63
    more filenames, and infer the workingtree that contains them.
 
64
 
 
65
    The filenames given are not required to exist.
 
66
 
 
67
    :param file_list: Filenames to convert.  
 
68
 
 
69
    :param default_branch: Fallback tree path to use if file_list is empty or None.
 
70
 
 
71
    :return: workingtree, [relative_paths]
 
72
    """
 
73
    if file_list is None or len(file_list) == 0:
 
74
        return WorkingTree.open_containing(default_branch)[0], file_list
 
75
    tree = WorkingTree.open_containing(file_list[0])[0]
 
76
    new_list = []
 
77
    for filename in file_list:
 
78
        try:
 
79
            new_list.append(tree.relpath(filename))
 
80
        except errors.PathNotChild:
 
81
            raise FileInWrongBranch(tree.branch, filename)
 
82
    return tree, new_list
 
83
 
 
84
 
 
85
def get_format_type(typestring):
 
86
    """Parse and return a format specifier."""
 
87
    if typestring == "weave":
 
88
        return bzrdir.BzrDirFormat6()
 
89
    if typestring == "default":
 
90
        return bzrdir.BzrDirMetaFormat1()
 
91
    if typestring == "metaweave":
 
92
        format = bzrdir.BzrDirMetaFormat1()
 
93
        format.repository_format = bzrlib.repository.RepositoryFormat7()
 
94
        return format
 
95
    if typestring == "knit":
 
96
        format = bzrdir.BzrDirMetaFormat1()
 
97
        format.repository_format = bzrlib.repository.RepositoryFormatKnit1()
 
98
        return format
 
99
    msg = "Unknown bzr format %s. Current formats are: default, knit,\n" \
 
100
          "metaweave and weave" % typestring
 
101
    raise BzrCommandError(msg)
 
102
 
 
103
 
 
104
# TODO: Make sure no commands unconditionally use the working directory as a
 
105
# branch.  If a filename argument is used, the first of them should be used to
 
106
# specify the branch.  (Perhaps this can be factored out into some kind of
 
107
# Argument class, representing a file in a branch, where the first occurrence
 
108
# opens the branch?)
 
109
 
 
110
class cmd_status(Command):
 
111
    """Display status summary.
 
112
 
 
113
    This reports on versioned and unknown files, reporting them
 
114
    grouped by state.  Possible states are:
 
115
 
 
116
    added
 
117
        Versioned in the working copy but not in the previous revision.
 
118
 
 
119
    removed
 
120
        Versioned in the previous revision but removed or deleted
 
121
        in the working copy.
 
122
 
 
123
    renamed
 
124
        Path of this file changed from the previous revision;
 
125
        the text may also have changed.  This includes files whose
 
126
        parent directory was renamed.
 
127
 
 
128
    modified
 
129
        Text has changed since the previous revision.
 
130
 
 
131
    unchanged
 
132
        Nothing about this file has changed since the previous revision.
 
133
        Only shown with --all.
 
134
 
 
135
    unknown
 
136
        Not versioned and not matching an ignore pattern.
 
137
 
 
138
    To see ignored files use 'bzr ignored'.  For details in the
 
139
    changes to file texts, use 'bzr diff'.
 
140
 
 
141
    If no arguments are specified, the status of the entire working
 
142
    directory is shown.  Otherwise, only the status of the specified
 
143
    files or directories is reported.  If a directory is given, status
 
144
    is reported for everything inside that directory.
 
145
 
 
146
    If a revision argument is given, the status is calculated against
 
147
    that revision, or between two revisions if two are provided.
 
148
    """
 
149
    
 
150
    # TODO: --no-recurse, --recurse options
 
151
    
 
152
    takes_args = ['file*']
 
153
    takes_options = ['all', 'show-ids', 'revision']
 
154
    aliases = ['st', 'stat']
 
155
    
 
156
    @display_command
 
157
    def run(self, all=False, show_ids=False, file_list=None, revision=None):
 
158
        tree, file_list = tree_files(file_list)
 
159
            
 
160
        from bzrlib.status import show_tree_status
 
161
        show_tree_status(tree, show_unchanged=all, show_ids=show_ids,
 
162
                         specific_files=file_list, revision=revision)
 
163
 
 
164
 
 
165
class cmd_cat_revision(Command):
 
166
    """Write out metadata for a revision.
 
167
    
 
168
    The revision to print can either be specified by a specific
 
169
    revision identifier, or you can use --revision.
 
170
    """
 
171
 
 
172
    hidden = True
 
173
    takes_args = ['revision_id?']
 
174
    takes_options = ['revision']
 
175
    
 
176
    @display_command
 
177
    def run(self, revision_id=None, revision=None):
 
178
 
 
179
        if revision_id is not None and revision is not None:
 
180
            raise BzrCommandError('You can only supply one of revision_id or --revision')
 
181
        if revision_id is None and revision is None:
 
182
            raise BzrCommandError('You must supply either --revision or a revision_id')
 
183
        b = WorkingTree.open_containing(u'.')[0].branch
 
184
        if revision_id is not None:
 
185
            sys.stdout.write(b.repository.get_revision_xml(revision_id))
 
186
        elif revision is not None:
 
187
            for rev in revision:
 
188
                if rev is None:
 
189
                    raise BzrCommandError('You cannot specify a NULL revision.')
 
190
                revno, rev_id = rev.in_history(b)
 
191
                sys.stdout.write(b.repository.get_revision_xml(rev_id))
 
192
    
 
193
 
 
194
class cmd_revno(Command):
 
195
    """Show current revision number.
 
196
 
 
197
    This is equal to the number of revisions on this branch."""
 
198
    takes_args = ['location?']
 
199
    @display_command
 
200
    def run(self, location=u'.'):
 
201
        print Branch.open_containing(location)[0].revno()
 
202
 
 
203
 
 
204
class cmd_revision_info(Command):
 
205
    """Show revision number and revision id for a given revision identifier.
 
206
    """
 
207
    hidden = True
 
208
    takes_args = ['revision_info*']
 
209
    takes_options = ['revision']
 
210
    @display_command
 
211
    def run(self, revision=None, revision_info_list=[]):
 
212
 
 
213
        revs = []
 
214
        if revision is not None:
 
215
            revs.extend(revision)
 
216
        if revision_info_list is not None:
 
217
            for rev in revision_info_list:
 
218
                revs.append(RevisionSpec(rev))
 
219
        if len(revs) == 0:
 
220
            raise BzrCommandError('You must supply a revision identifier')
 
221
 
 
222
        b = WorkingTree.open_containing(u'.')[0].branch
 
223
 
 
224
        for rev in revs:
 
225
            revinfo = rev.in_history(b)
 
226
            if revinfo.revno is None:
 
227
                print '     %s' % revinfo.rev_id
 
228
            else:
 
229
                print '%4d %s' % (revinfo.revno, revinfo.rev_id)
 
230
 
 
231
    
 
232
class cmd_add(Command):
 
233
    """Add specified files or directories.
 
234
 
 
235
    In non-recursive mode, all the named items are added, regardless
 
236
    of whether they were previously ignored.  A warning is given if
 
237
    any of the named files are already versioned.
 
238
 
 
239
    In recursive mode (the default), files are treated the same way
 
240
    but the behaviour for directories is different.  Directories that
 
241
    are already versioned do not give a warning.  All directories,
 
242
    whether already versioned or not, are searched for files or
 
243
    subdirectories that are neither versioned or ignored, and these
 
244
    are added.  This search proceeds recursively into versioned
 
245
    directories.  If no names are given '.' is assumed.
 
246
 
 
247
    Therefore simply saying 'bzr add' will version all files that
 
248
    are currently unknown.
 
249
 
 
250
    Adding a file whose parent directory is not versioned will
 
251
    implicitly add the parent, and so on up to the root. This means
 
252
    you should never need to explictly add a directory, they'll just
 
253
    get added when you add a file in the directory.
 
254
 
 
255
    --dry-run will show which files would be added, but not actually 
 
256
    add them.
 
257
    """
 
258
    takes_args = ['file*']
 
259
    takes_options = ['no-recurse', 'dry-run', 'verbose']
 
260
 
 
261
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False):
 
262
        import bzrlib.add
 
263
 
 
264
        if dry_run:
 
265
            if is_quiet():
 
266
                # This is pointless, but I'd rather not raise an error
 
267
                action = bzrlib.add.add_action_null
 
268
            else:
 
269
                action = bzrlib.add.add_action_print
 
270
        elif is_quiet():
 
271
            action = bzrlib.add.add_action_add
 
272
        else:
 
273
            action = bzrlib.add.add_action_add_and_print
 
274
 
 
275
        added, ignored = bzrlib.add.smart_add(file_list, not no_recurse, 
 
276
                                              action)
 
277
        if len(ignored) > 0:
 
278
            if verbose:
 
279
                for glob in sorted(ignored.keys()):
 
280
                    for path in ignored[glob]:
 
281
                        print "ignored %s matching \"%s\"" % (path, glob)
 
282
            else:
 
283
                match_len = 0
 
284
                for glob, paths in ignored.items():
 
285
                    match_len += len(paths)
 
286
                print "ignored %d file(s)." % match_len
 
287
            print "If you wish to add some of these files, please add them"\
 
288
                " by name."
 
289
 
 
290
 
 
291
class cmd_mkdir(Command):
 
292
    """Create a new versioned directory.
 
293
 
 
294
    This is equivalent to creating the directory and then adding it.
 
295
    """
 
296
    takes_args = ['dir+']
 
297
 
 
298
    def run(self, dir_list):
 
299
        for d in dir_list:
 
300
            os.mkdir(d)
 
301
            wt, dd = WorkingTree.open_containing(d)
 
302
            wt.add([dd])
 
303
            print 'added', d
 
304
 
 
305
 
 
306
class cmd_relpath(Command):
 
307
    """Show path of a file relative to root"""
 
308
    takes_args = ['filename']
 
309
    hidden = True
 
310
    
 
311
    @display_command
 
312
    def run(self, filename):
 
313
        tree, relpath = WorkingTree.open_containing(filename)
 
314
        print relpath
 
315
 
 
316
 
 
317
class cmd_inventory(Command):
 
318
    """Show inventory of the current working copy or a revision.
 
319
 
 
320
    It is possible to limit the output to a particular entry
 
321
    type using the --kind option.  For example; --kind file.
 
322
    """
 
323
    takes_options = ['revision', 'show-ids', 'kind']
 
324
    
 
325
    @display_command
 
326
    def run(self, revision=None, show_ids=False, kind=None):
 
327
        if kind and kind not in ['file', 'directory', 'symlink']:
 
328
            raise BzrCommandError('invalid kind specified')
 
329
        tree = WorkingTree.open_containing(u'.')[0]
 
330
        if revision is None:
 
331
            inv = tree.read_working_inventory()
 
332
        else:
 
333
            if len(revision) > 1:
 
334
                raise BzrCommandError('bzr inventory --revision takes'
 
335
                    ' exactly one revision identifier')
 
336
            inv = tree.branch.repository.get_revision_inventory(
 
337
                revision[0].in_history(tree.branch).rev_id)
 
338
 
 
339
        for path, entry in inv.entries():
 
340
            if kind and kind != entry.kind:
 
341
                continue
 
342
            if show_ids:
 
343
                print '%-50s %s' % (path, entry.file_id)
 
344
            else:
 
345
                print path
 
346
 
 
347
 
 
348
class cmd_mv(Command):
 
349
    """Move or rename a file.
 
350
 
 
351
    usage:
 
352
        bzr mv OLDNAME NEWNAME
 
353
        bzr mv SOURCE... DESTINATION
 
354
 
 
355
    If the last argument is a versioned directory, all the other names
 
356
    are moved into it.  Otherwise, there must be exactly two arguments
 
357
    and the file is changed to a new name, which must not already exist.
 
358
 
 
359
    Files cannot be moved between branches.
 
360
    """
 
361
    takes_args = ['names*']
 
362
    aliases = ['move', 'rename']
 
363
 
 
364
    def run(self, names_list):
 
365
        if len(names_list) < 2:
 
366
            raise BzrCommandError("missing file argument")
 
367
        tree, rel_names = tree_files(names_list)
 
368
        
 
369
        if os.path.isdir(names_list[-1]):
 
370
            # move into existing directory
 
371
            for pair in tree.move(rel_names[:-1], rel_names[-1]):
 
372
                print "%s => %s" % pair
 
373
        else:
 
374
            if len(names_list) != 2:
 
375
                raise BzrCommandError('to mv multiple files the destination '
 
376
                                      'must be a versioned directory')
 
377
            tree.rename_one(rel_names[0], rel_names[1])
 
378
            print "%s => %s" % (rel_names[0], rel_names[1])
 
379
            
 
380
    
 
381
class cmd_pull(Command):
 
382
    """Turn this branch into a mirror of another branch.
 
383
 
 
384
    This command only works on branches that have not diverged.  Branches are
 
385
    considered diverged if the destination branch's most recent commit is one
 
386
    that has not been merged (directly or indirectly) into the parent.
 
387
 
 
388
    If branches have diverged, you can use 'bzr merge' to integrate the 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 branches have diverged, you can use 'bzr merge' to pull the text changes
 
393
    from one into the other.  Once one branch has merged, the other should
 
394
    be able to pull it again.
 
395
 
 
396
    If you want to forget your local changes and just update your branch to
 
397
    match the remote one, use pull --overwrite.
 
398
 
 
399
    If there is no default location set, the first pull will set it.  After
 
400
    that, you can omit the location to use the default.  To change the
 
401
    default, use --remember.
 
402
    """
 
403
    takes_options = ['remember', 'overwrite', 'revision', 'verbose']
 
404
    takes_args = ['location?']
 
405
 
 
406
    def run(self, location=None, remember=False, overwrite=False, revision=None, verbose=False):
 
407
        # FIXME: too much stuff is in the command class
 
408
        try:
 
409
            tree_to = WorkingTree.open_containing(u'.')[0]
 
410
            branch_to = tree_to.branch
 
411
        except NoWorkingTree:
 
412
            tree_to = None
 
413
            branch_to = Branch.open_containing(u'.')[0] 
 
414
        stored_loc = branch_to.get_parent()
 
415
        if location is None:
 
416
            if stored_loc is None:
 
417
                raise BzrCommandError("No pull location known or specified.")
 
418
            else:
 
419
                print "Using saved location: %s" % stored_loc
 
420
                location = stored_loc
 
421
 
 
422
        if branch_to.get_parent() is None or remember:
 
423
            branch_to.set_parent(location)
 
424
 
 
425
        branch_from = Branch.open(location)
 
426
 
 
427
        if revision is None:
 
428
            rev_id = None
 
429
        elif len(revision) == 1:
 
430
            rev_id = revision[0].in_history(branch_from).rev_id
 
431
        else:
 
432
            raise BzrCommandError('bzr pull --revision takes one value.')
 
433
 
 
434
        old_rh = branch_to.revision_history()
 
435
        if tree_to is not None:
 
436
            count = tree_to.pull(branch_from, overwrite, rev_id)
 
437
        else:
 
438
            count = branch_to.pull(branch_from, overwrite, rev_id)
 
439
        note('%d revision(s) pulled.' % (count,))
 
440
 
 
441
        if verbose:
 
442
            new_rh = branch_to.revision_history()
 
443
            if old_rh != new_rh:
 
444
                # Something changed
 
445
                from bzrlib.log import show_changed_revisions
 
446
                show_changed_revisions(branch_to, old_rh, new_rh)
 
447
 
 
448
 
 
449
class cmd_push(Command):
 
450
    """Update a mirror of this branch.
 
451
    
 
452
    The target branch will not have its working tree populated because this
 
453
    is both expensive, and is not supported on remote file systems.
 
454
    
 
455
    Some smart servers or protocols *may* put the working tree in place in
 
456
    the future.
 
457
 
 
458
    This command only works on branches that have not diverged.  Branches are
 
459
    considered diverged if the destination branch's most recent commit is one
 
460
    that has not been merged (directly or indirectly) by the source branch.
 
461
 
 
462
    If branches have diverged, you can use 'bzr push --overwrite' to replace
 
463
    the other branch completely, discarding its unmerged changes.
 
464
    
 
465
    If you want to ensure you have the different changes in the other branch,
 
466
    do a merge (see bzr help merge) from the other branch, and commit that.
 
467
    After that you will be able to do a push without '--overwrite'.
 
468
 
 
469
    If there is no default push location set, the first push will set it.
 
470
    After that, you can omit the location to use the default.  To change the
 
471
    default, use --remember.
 
472
    """
 
473
    takes_options = ['remember', 'overwrite', 
 
474
                     Option('create-prefix', 
 
475
                            help='Create the path leading up to the branch '
 
476
                                 'if it does not already exist')]
 
477
    takes_args = ['location?']
 
478
 
 
479
    def run(self, location=None, remember=False, overwrite=False,
 
480
            create_prefix=False, verbose=False):
 
481
        # FIXME: Way too big!  Put this into a function called from the
 
482
        # command.
 
483
        from bzrlib.transport import get_transport
 
484
        
 
485
        br_from = Branch.open_containing('.')[0]
 
486
        stored_loc = br_from.get_push_location()
 
487
        if location is None:
 
488
            if stored_loc is None:
 
489
                raise BzrCommandError("No push location known or specified.")
 
490
            else:
 
491
                print "Using saved location: %s" % stored_loc
 
492
                location = stored_loc
 
493
        if br_from.get_push_location() is None or remember:
 
494
            br_from.set_push_location(location)
 
495
        try:
 
496
            dir_to = bzrlib.bzrdir.BzrDir.open(location)
 
497
            br_to = dir_to.open_branch()
 
498
        except NotBranchError:
 
499
            # create a branch.
 
500
            transport = get_transport(location).clone('..')
 
501
            if not create_prefix:
 
502
                try:
 
503
                    transport.mkdir(transport.relpath(location))
 
504
                except NoSuchFile:
 
505
                    raise BzrCommandError("Parent directory of %s "
 
506
                                          "does not exist." % location)
 
507
            else:
 
508
                current = transport.base
 
509
                needed = [(transport, transport.relpath(location))]
 
510
                while needed:
 
511
                    try:
 
512
                        transport, relpath = needed[-1]
 
513
                        transport.mkdir(relpath)
 
514
                        needed.pop()
 
515
                    except NoSuchFile:
 
516
                        new_transport = transport.clone('..')
 
517
                        needed.append((new_transport,
 
518
                                       new_transport.relpath(transport.base)))
 
519
                        if new_transport.base == transport.base:
 
520
                            raise BzrCommandError("Could not create "
 
521
                                                  "path prefix.")
 
522
            dir_to = br_from.bzrdir.clone(location,
 
523
                revision_id=br_from.last_revision())
 
524
            br_to = dir_to.open_branch()
 
525
            count = len(br_to.revision_history())
 
526
        else:
 
527
            old_rh = br_to.revision_history()
 
528
            try:
 
529
                try:
 
530
                    tree_to = dir_to.open_workingtree()
 
531
                except errors.NotLocalUrl:
 
532
                    warning('This transport does not update the working '
 
533
                            'tree of: %s' % (br_to.base,))
 
534
                    count = br_to.pull(br_from, overwrite)
 
535
                except NoWorkingTree:
 
536
                    count = br_to.pull(br_from, overwrite)
 
537
                else:
 
538
                    count = tree_to.pull(br_from, overwrite)
 
539
            except DivergedBranches:
 
540
                raise BzrCommandError("These branches have diverged."
 
541
                                      "  Try a merge then push with overwrite.")
 
542
        note('%d revision(s) pushed.' % (count,))
 
543
 
 
544
        if verbose:
 
545
            new_rh = br_to.revision_history()
 
546
            if old_rh != new_rh:
 
547
                # Something changed
 
548
                from bzrlib.log import show_changed_revisions
 
549
                show_changed_revisions(br_to, old_rh, new_rh)
 
550
 
 
551
 
 
552
class cmd_branch(Command):
 
553
    """Create a new copy of a branch.
 
554
 
 
555
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
 
556
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
 
557
 
 
558
    To retrieve the branch as of a particular revision, supply the --revision
 
559
    parameter, as in "branch foo/bar -r 5".
 
560
 
 
561
    --basis is to speed up branching from remote branches.  When specified, it
 
562
    copies all the file-contents, inventory and revision data from the basis
 
563
    branch before copying anything from the remote branch.
 
564
    """
 
565
    takes_args = ['from_location', 'to_location?']
 
566
    takes_options = ['revision', 'basis']
 
567
    aliases = ['get', 'clone']
 
568
 
 
569
    def run(self, from_location, to_location=None, revision=None, basis=None):
 
570
        from bzrlib.osutils import rmtree
 
571
        if revision is None:
 
572
            revision = [None]
 
573
        elif len(revision) > 1:
 
574
            raise BzrCommandError(
 
575
                'bzr branch --revision takes exactly 1 revision value')
 
576
        try:
 
577
            br_from = Branch.open(from_location)
 
578
        except OSError, e:
 
579
            if e.errno == errno.ENOENT:
 
580
                raise BzrCommandError('Source location "%s" does not'
 
581
                                      ' exist.' % to_location)
 
582
            else:
 
583
                raise
 
584
        br_from.lock_read()
 
585
        try:
 
586
            if basis is not None:
 
587
                basis_dir = bzrdir.BzrDir.open_containing(basis)[0]
 
588
            else:
 
589
                basis_dir = None
 
590
            if len(revision) == 1 and revision[0] is not None:
 
591
                revision_id = revision[0].in_history(br_from)[1]
 
592
            else:
 
593
                # FIXME - wt.last_revision, fallback to branch, fall back to
 
594
                # None or perhaps NULL_REVISION to mean copy nothing
 
595
                # RBC 20060209
 
596
                revision_id = br_from.last_revision()
 
597
            if to_location is None:
 
598
                to_location = os.path.basename(from_location.rstrip("/\\"))
 
599
                name = None
 
600
            else:
 
601
                name = os.path.basename(to_location) + '\n'
 
602
            try:
 
603
                os.mkdir(to_location)
 
604
            except OSError, e:
 
605
                if e.errno == errno.EEXIST:
 
606
                    raise BzrCommandError('Target directory "%s" already'
 
607
                                          ' exists.' % to_location)
 
608
                if e.errno == errno.ENOENT:
 
609
                    raise BzrCommandError('Parent of "%s" does not exist.' %
 
610
                                          to_location)
 
611
                else:
 
612
                    raise
 
613
            try:
 
614
                # preserve whatever source format we have.
 
615
                dir = br_from.bzrdir.sprout(to_location, revision_id, basis_dir)
 
616
                branch = dir.open_branch()
 
617
            except bzrlib.errors.NoSuchRevision:
 
618
                rmtree(to_location)
 
619
                msg = "The branch %s has no revision %s." % (from_location, revision[0])
 
620
                raise BzrCommandError(msg)
 
621
            except bzrlib.errors.UnlistableBranch:
 
622
                rmtree(to_location)
 
623
                msg = "The branch %s cannot be used as a --basis" % (basis,)
 
624
                raise BzrCommandError(msg)
 
625
            if name:
 
626
                branch.control_files.put_utf8('branch-name', name)
 
627
 
 
628
            note('Branched %d revision(s).' % branch.revno())
 
629
        finally:
 
630
            br_from.unlock()
 
631
 
 
632
 
 
633
class cmd_checkout(Command):
 
634
    """Create a new checkout of an existing branch.
 
635
 
 
636
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
 
637
    the branch found in '.'. This is useful if you have removed the working tree
 
638
    or if it was never created - i.e. if you pushed the branch to its current
 
639
    location using SFTP.
 
640
    
 
641
    If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
 
642
    be used.  In other words, "checkout ../foo/bar" will attempt to create ./bar.
 
643
 
 
644
    To retrieve the branch as of a particular revision, supply the --revision
 
645
    parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
 
646
    out of date [so you cannot commit] but it may be useful (i.e. to examine old
 
647
    code.)
 
648
 
 
649
    --basis is to speed up checking out from remote branches.  When specified, it
 
650
    uses the inventory and file contents from the basis branch in preference to the
 
651
    branch being checked out.
 
652
    """
 
653
    takes_args = ['branch_location?', 'to_location?']
 
654
    takes_options = ['revision', # , 'basis']
 
655
                     Option('lightweight',
 
656
                            help="perform a lightweight checkout. Lightweight "
 
657
                                 "checkouts depend on access to the branch for "
 
658
                                 "every operation. Normal checkouts can perform "
 
659
                                 "common operations like diff and status without "
 
660
                                 "such access, and also support local commits."
 
661
                            ),
 
662
                     ]
 
663
 
 
664
    def run(self, branch_location=None, to_location=None, revision=None, basis=None,
 
665
            lightweight=False):
 
666
        if revision is None:
 
667
            revision = [None]
 
668
        elif len(revision) > 1:
 
669
            raise BzrCommandError(
 
670
                'bzr checkout --revision takes exactly 1 revision value')
 
671
        if branch_location is None:
 
672
            branch_location = bzrlib.osutils.getcwd()
 
673
            to_location = branch_location
 
674
        source = Branch.open(branch_location)
 
675
        if len(revision) == 1 and revision[0] is not None:
 
676
            revision_id = revision[0].in_history(source)[1]
 
677
        else:
 
678
            revision_id = None
 
679
        if to_location is None:
 
680
            to_location = os.path.basename(branch_location.rstrip("/\\"))
 
681
        # if the source and to_location are the same, 
 
682
        # and there is no working tree,
 
683
        # then reconstitute a branch
 
684
        if (bzrlib.osutils.abspath(to_location) == 
 
685
            bzrlib.osutils.abspath(branch_location)):
 
686
            try:
 
687
                source.bzrdir.open_workingtree()
 
688
            except errors.NoWorkingTree:
 
689
                source.bzrdir.create_workingtree()
 
690
                return
 
691
        try:
 
692
            os.mkdir(to_location)
 
693
        except OSError, e:
 
694
            if e.errno == errno.EEXIST:
 
695
                raise BzrCommandError('Target directory "%s" already'
 
696
                                      ' exists.' % to_location)
 
697
            if e.errno == errno.ENOENT:
 
698
                raise BzrCommandError('Parent of "%s" does not exist.' %
 
699
                                      to_location)
 
700
            else:
 
701
                raise
 
702
        old_format = bzrlib.bzrdir.BzrDirFormat.get_default_format()
 
703
        bzrlib.bzrdir.BzrDirFormat.set_default_format(bzrdir.BzrDirMetaFormat1())
 
704
        try:
 
705
            if lightweight:
 
706
                checkout = bzrdir.BzrDirMetaFormat1().initialize(to_location)
 
707
                bzrlib.branch.BranchReferenceFormat().initialize(checkout, source)
 
708
            else:
 
709
                checkout_branch =  bzrlib.bzrdir.BzrDir.create_branch_convenience(
 
710
                    to_location, force_new_tree=False)
 
711
                checkout = checkout_branch.bzrdir
 
712
                checkout_branch.bind(source)
 
713
                if revision_id is not None:
 
714
                    rh = checkout_branch.revision_history()
 
715
                    checkout_branch.set_revision_history(rh[:rh.index(revision_id) + 1])
 
716
            checkout.create_workingtree(revision_id)
 
717
        finally:
 
718
            bzrlib.bzrdir.BzrDirFormat.set_default_format(old_format)
 
719
 
 
720
 
 
721
class cmd_renames(Command):
 
722
    """Show list of renamed files.
 
723
    """
 
724
    # TODO: Option to show renames between two historical versions.
 
725
 
 
726
    # TODO: Only show renames under dir, rather than in the whole branch.
 
727
    takes_args = ['dir?']
 
728
 
 
729
    @display_command
 
730
    def run(self, dir=u'.'):
 
731
        tree = WorkingTree.open_containing(dir)[0]
 
732
        old_inv = tree.basis_tree().inventory
 
733
        new_inv = tree.read_working_inventory()
 
734
 
 
735
        renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
 
736
        renames.sort()
 
737
        for old_name, new_name in renames:
 
738
            print "%s => %s" % (old_name, new_name)        
 
739
 
 
740
 
 
741
class cmd_update(Command):
 
742
    """Update a tree to have the latest code committed to its branch.
 
743
    
 
744
    This will perform a merge into the working tree, and may generate
 
745
    conflicts. If you have any local changes, you will still 
 
746
    need to commit them after the update for the update to be complete.
 
747
    
 
748
    If you want to discard your local changes, you can just do a 
 
749
    'bzr revert' instead of 'bzr commit' after the update.
 
750
    """
 
751
    takes_args = ['dir?']
 
752
 
 
753
    def run(self, dir='.'):
 
754
        tree = WorkingTree.open_containing(dir)[0]
 
755
        tree.lock_write()
 
756
        try:
 
757
            if tree.last_revision() == tree.branch.last_revision():
 
758
                # may be up to date, check master too.
 
759
                master = tree.branch.get_master_branch()
 
760
                if master is None or master.last_revision == tree.last_revision():
 
761
                    note("Tree is up to date.")
 
762
                    return
 
763
            conflicts = tree.update()
 
764
            note('Updated to revision %d.' %
 
765
                 (tree.branch.revision_id_to_revno(tree.last_revision()),))
 
766
            if conflicts != 0:
 
767
                return 1
 
768
            else:
 
769
                return 0
 
770
        finally:
 
771
            tree.unlock()
 
772
 
 
773
 
 
774
class cmd_info(Command):
 
775
    """Show information about a working tree, branch or repository.
 
776
 
 
777
    This command will show all known locations and formats associated to the
 
778
    tree, branch or repository.  Statistical information is included with
 
779
    each report.
 
780
 
 
781
    Branches and working trees will also report any missing revisions.
 
782
    """
 
783
    takes_args = ['location?']
 
784
    takes_options = ['verbose']
 
785
 
 
786
    @display_command
 
787
    def run(self, location=None, verbose=False):
 
788
        from bzrlib.info import show_bzrdir_info
 
789
        show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
 
790
                         verbose=verbose)
 
791
 
 
792
 
 
793
class cmd_remove(Command):
 
794
    """Make a file unversioned.
 
795
 
 
796
    This makes bzr stop tracking changes to a versioned file.  It does
 
797
    not delete the working copy.
 
798
    """
 
799
    takes_args = ['file+']
 
800
    takes_options = ['verbose']
 
801
    aliases = ['rm']
 
802
    
 
803
    def run(self, file_list, verbose=False):
 
804
        tree, file_list = tree_files(file_list)
 
805
        tree.remove(file_list, verbose=verbose)
 
806
 
 
807
 
 
808
class cmd_file_id(Command):
 
809
    """Print file_id of a particular file or directory.
 
810
 
 
811
    The file_id is assigned when the file is first added and remains the
 
812
    same through all revisions where the file exists, even when it is
 
813
    moved or renamed.
 
814
    """
 
815
    hidden = True
 
816
    takes_args = ['filename']
 
817
    @display_command
 
818
    def run(self, filename):
 
819
        tree, relpath = WorkingTree.open_containing(filename)
 
820
        i = tree.inventory.path2id(relpath)
 
821
        if i == None:
 
822
            raise BzrError("%r is not a versioned file" % filename)
 
823
        else:
 
824
            print i
 
825
 
 
826
 
 
827
class cmd_file_path(Command):
 
828
    """Print path of file_ids to a file or directory.
 
829
 
 
830
    This prints one line for each directory down to the target,
 
831
    starting at the branch root."""
 
832
    hidden = True
 
833
    takes_args = ['filename']
 
834
    @display_command
 
835
    def run(self, filename):
 
836
        tree, relpath = WorkingTree.open_containing(filename)
 
837
        inv = tree.inventory
 
838
        fid = inv.path2id(relpath)
 
839
        if fid == None:
 
840
            raise BzrError("%r is not a versioned file" % filename)
 
841
        for fip in inv.get_idpath(fid):
 
842
            print fip
 
843
 
 
844
 
 
845
class cmd_reconcile(Command):
 
846
    """Reconcile bzr metadata in a branch.
 
847
 
 
848
    This can correct data mismatches that may have been caused by
 
849
    previous ghost operations or bzr upgrades. You should only
 
850
    need to run this command if 'bzr check' or a bzr developer 
 
851
    advises you to run it.
 
852
 
 
853
    If a second branch is provided, cross-branch reconciliation is
 
854
    also attempted, which will check that data like the tree root
 
855
    id which was not present in very early bzr versions is represented
 
856
    correctly in both branches.
 
857
 
 
858
    At the same time it is run it may recompress data resulting in 
 
859
    a potential saving in disk space or performance gain.
 
860
 
 
861
    The branch *MUST* be on a listable system such as local disk or sftp.
 
862
    """
 
863
    takes_args = ['branch?']
 
864
 
 
865
    def run(self, branch="."):
 
866
        from bzrlib.reconcile import reconcile
 
867
        dir = bzrlib.bzrdir.BzrDir.open(branch)
 
868
        reconcile(dir)
 
869
 
 
870
 
 
871
class cmd_revision_history(Command):
 
872
    """Display list of revision ids on this branch."""
 
873
    hidden = True
 
874
    @display_command
 
875
    def run(self):
 
876
        branch = WorkingTree.open_containing(u'.')[0].branch
 
877
        for patchid in branch.revision_history():
 
878
            print patchid
 
879
 
 
880
 
 
881
class cmd_ancestry(Command):
 
882
    """List all revisions merged into this branch."""
 
883
    hidden = True
 
884
    @display_command
 
885
    def run(self):
 
886
        tree = WorkingTree.open_containing(u'.')[0]
 
887
        b = tree.branch
 
888
        # FIXME. should be tree.last_revision
 
889
        revision_ids = b.repository.get_ancestry(b.last_revision())
 
890
        assert revision_ids[0] == None
 
891
        revision_ids.pop(0)
 
892
        for revision_id in revision_ids:
 
893
            print revision_id
 
894
 
 
895
 
 
896
class cmd_init(Command):
 
897
    """Make a directory into a versioned branch.
 
898
 
 
899
    Use this to create an empty branch, or before importing an
 
900
    existing project.
 
901
 
 
902
    If there is a repository in a parent directory of the location, then 
 
903
    the history of the branch will be stored in the repository.  Otherwise
 
904
    init creates a standalone branch which carries its own history in 
 
905
    .bzr.
 
906
 
 
907
    If there is already a branch at the location but it has no working tree,
 
908
    the tree can be populated with 'bzr checkout'.
 
909
 
 
910
    Recipe for importing a tree of files:
 
911
        cd ~/project
 
912
        bzr init
 
913
        bzr add .
 
914
        bzr status
 
915
        bzr commit -m 'imported project'
 
916
    """
 
917
    takes_args = ['location?']
 
918
    takes_options = [
 
919
                     Option('format', 
 
920
                            help='Specify a format for this branch. Current'
 
921
                                 ' formats are: default, knit, metaweave and'
 
922
                                 ' weave. Default is knit; metaweave and'
 
923
                                 ' weave are deprecated',
 
924
                            type=get_format_type),
 
925
                     ]
 
926
    def run(self, location=None, format=None):
 
927
        from bzrlib.branch import Branch
 
928
        if format is None:
 
929
            format = get_format_type('default')
 
930
        if location is None:
 
931
            location = u'.'
 
932
        else:
 
933
            # The path has to exist to initialize a
 
934
            # branch inside of it.
 
935
            # Just using os.mkdir, since I don't
 
936
            # believe that we want to create a bunch of
 
937
            # locations if the user supplies an extended path
 
938
            if not os.path.exists(location):
 
939
                os.mkdir(location)
 
940
        try:
 
941
            existing_bzrdir = bzrdir.BzrDir.open(location)
 
942
        except NotBranchError:
 
943
            # really a NotBzrDir error...
 
944
            bzrdir.BzrDir.create_branch_convenience(location, format=format)
 
945
        else:
 
946
            if existing_bzrdir.has_branch():
 
947
                if existing_bzrdir.has_workingtree():
 
948
                    raise errors.AlreadyBranchError(location)
 
949
                else:
 
950
                    raise errors.BranchExistsWithoutWorkingTree(location)
 
951
            else:
 
952
                existing_bzrdir.create_branch()
 
953
                existing_bzrdir.create_workingtree()
 
954
 
 
955
 
 
956
class cmd_init_repository(Command):
 
957
    """Create a shared repository to hold branches.
 
958
 
 
959
    New branches created under the repository directory will store their revisions
 
960
    in the repository, not in the branch directory, if the branch format supports
 
961
    shared storage.
 
962
 
 
963
    example:
 
964
        bzr init-repo repo
 
965
        bzr init repo/trunk
 
966
        bzr checkout --lightweight repo/trunk trunk-checkout
 
967
        cd trunk-checkout
 
968
        (add files here)
 
969
    """
 
970
    takes_args = ["location"] 
 
971
    takes_options = [Option('format', 
 
972
                            help='Specify a format for this repository.'
 
973
                                 ' Current formats are: default, knit,'
 
974
                                 ' metaweave and weave. Default is knit;'
 
975
                                 ' metaweave and weave are deprecated',
 
976
                            type=get_format_type),
 
977
                     Option('trees',
 
978
                             help='Allows branches in repository to have'
 
979
                             ' a working tree')]
 
980
    aliases = ["init-repo"]
 
981
    def run(self, location, format=None, trees=False):
 
982
        from bzrlib.transport import get_transport
 
983
        if format is None:
 
984
            format = get_format_type('default')
 
985
        transport = get_transport(location)
 
986
        if not transport.has('.'):
 
987
            transport.mkdir('')
 
988
        newdir = format.initialize_on_transport(transport)
 
989
        repo = newdir.create_repository(shared=True)
 
990
        repo.set_make_working_trees(trees)
 
991
 
 
992
 
 
993
class cmd_diff(Command):
 
994
    """Show differences in working tree.
 
995
    
 
996
    If files are listed, only the changes in those files are listed.
 
997
    Otherwise, all changes for the tree are listed.
 
998
 
 
999
    "bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
 
1000
    produces patches suitable for "patch -p1".
 
1001
 
 
1002
    examples:
 
1003
        bzr diff
 
1004
        bzr diff -r1
 
1005
        bzr diff -r1..2
 
1006
        bzr diff --diff-prefix old/:new/
 
1007
        bzr diff bzr.mine bzr.dev
 
1008
        bzr diff foo.c
 
1009
    """
 
1010
    # TODO: Option to use external diff command; could be GNU diff, wdiff,
 
1011
    #       or a graphical diff.
 
1012
 
 
1013
    # TODO: Python difflib is not exactly the same as unidiff; should
 
1014
    #       either fix it up or prefer to use an external diff.
 
1015
 
 
1016
    # TODO: Selected-file diff is inefficient and doesn't show you
 
1017
    #       deleted files.
 
1018
 
 
1019
    # TODO: This probably handles non-Unix newlines poorly.
 
1020
    
 
1021
    takes_args = ['file*']
 
1022
    takes_options = ['revision', 'diff-options', 'prefix']
 
1023
    aliases = ['di', 'dif']
 
1024
 
 
1025
    @display_command
 
1026
    def run(self, revision=None, file_list=None, diff_options=None,
 
1027
            prefix=None):
 
1028
        from bzrlib.diff import diff_cmd_helper, show_diff_trees
 
1029
 
 
1030
        if (prefix is None) or (prefix == '0'):
 
1031
            # diff -p0 format
 
1032
            old_label = ''
 
1033
            new_label = ''
 
1034
        elif prefix == '1':
 
1035
            old_label = 'old/'
 
1036
            new_label = 'new/'
 
1037
        else:
 
1038
            if not ':' in prefix:
 
1039
                 raise BzrError("--diff-prefix expects two values separated by a colon")
 
1040
            old_label, new_label = prefix.split(":")
 
1041
        
 
1042
        try:
 
1043
            tree1, file_list = internal_tree_files(file_list)
 
1044
            tree2 = None
 
1045
            b = None
 
1046
            b2 = None
 
1047
        except FileInWrongBranch:
 
1048
            if len(file_list) != 2:
 
1049
                raise BzrCommandError("Files are in different branches")
 
1050
 
 
1051
            tree1, file1 = WorkingTree.open_containing(file_list[0])
 
1052
            tree2, file2 = WorkingTree.open_containing(file_list[1])
 
1053
            if file1 != "" or file2 != "":
 
1054
                # FIXME diff those two files. rbc 20051123
 
1055
                raise BzrCommandError("Files are in different branches")
 
1056
            file_list = None
 
1057
        if revision is not None:
 
1058
            if tree2 is not None:
 
1059
                raise BzrCommandError("Can't specify -r with two branches")
 
1060
            if (len(revision) == 1) or (revision[1].spec is None):
 
1061
                return diff_cmd_helper(tree1, file_list, diff_options,
 
1062
                                       revision[0], 
 
1063
                                       old_label=old_label, new_label=new_label)
 
1064
            elif len(revision) == 2:
 
1065
                return diff_cmd_helper(tree1, file_list, diff_options,
 
1066
                                       revision[0], revision[1],
 
1067
                                       old_label=old_label, new_label=new_label)
 
1068
            else:
 
1069
                raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
 
1070
        else:
 
1071
            if tree2 is not None:
 
1072
                return show_diff_trees(tree1, tree2, sys.stdout, 
 
1073
                                       specific_files=file_list,
 
1074
                                       external_diff_options=diff_options,
 
1075
                                       old_label=old_label, new_label=new_label)
 
1076
            else:
 
1077
                return diff_cmd_helper(tree1, file_list, diff_options,
 
1078
                                       old_label=old_label, new_label=new_label)
 
1079
 
 
1080
 
 
1081
class cmd_deleted(Command):
 
1082
    """List files deleted in the working tree.
 
1083
    """
 
1084
    # TODO: Show files deleted since a previous revision, or
 
1085
    # between two revisions.
 
1086
    # TODO: Much more efficient way to do this: read in new
 
1087
    # directories with readdir, rather than stating each one.  Same
 
1088
    # level of effort but possibly much less IO.  (Or possibly not,
 
1089
    # if the directories are very large...)
 
1090
    @display_command
 
1091
    def run(self, show_ids=False):
 
1092
        tree = WorkingTree.open_containing(u'.')[0]
 
1093
        old = tree.basis_tree()
 
1094
        for path, ie in old.inventory.iter_entries():
 
1095
            if not tree.has_id(ie.file_id):
 
1096
                if show_ids:
 
1097
                    print '%-50s %s' % (path, ie.file_id)
 
1098
                else:
 
1099
                    print path
 
1100
 
 
1101
 
 
1102
class cmd_modified(Command):
 
1103
    """List files modified in working tree."""
 
1104
    hidden = True
 
1105
    @display_command
 
1106
    def run(self):
 
1107
        from bzrlib.delta import compare_trees
 
1108
 
 
1109
        tree = WorkingTree.open_containing(u'.')[0]
 
1110
        td = compare_trees(tree.basis_tree(), tree)
 
1111
 
 
1112
        for path, id, kind, text_modified, meta_modified in td.modified:
 
1113
            print path
 
1114
 
 
1115
 
 
1116
 
 
1117
class cmd_added(Command):
 
1118
    """List files added in working tree."""
 
1119
    hidden = True
 
1120
    @display_command
 
1121
    def run(self):
 
1122
        wt = WorkingTree.open_containing(u'.')[0]
 
1123
        basis_inv = wt.basis_tree().inventory
 
1124
        inv = wt.inventory
 
1125
        for file_id in inv:
 
1126
            if file_id in basis_inv:
 
1127
                continue
 
1128
            path = inv.id2path(file_id)
 
1129
            if not os.access(bzrlib.osutils.abspath(path), os.F_OK):
 
1130
                continue
 
1131
            print path
 
1132
                
 
1133
        
 
1134
 
 
1135
class cmd_root(Command):
 
1136
    """Show the tree root directory.
 
1137
 
 
1138
    The root is the nearest enclosing directory with a .bzr control
 
1139
    directory."""
 
1140
    takes_args = ['filename?']
 
1141
    @display_command
 
1142
    def run(self, filename=None):
 
1143
        """Print the branch root."""
 
1144
        tree = WorkingTree.open_containing(filename)[0]
 
1145
        print tree.basedir
 
1146
 
 
1147
 
 
1148
class cmd_log(Command):
 
1149
    """Show log of a branch, file, or directory.
 
1150
 
 
1151
    By default show the log of the branch containing the working directory.
 
1152
 
 
1153
    To request a range of logs, you can use the command -r begin..end
 
1154
    -r revision requests a specific revision, -r ..end or -r begin.. are
 
1155
    also valid.
 
1156
 
 
1157
    examples:
 
1158
        bzr log
 
1159
        bzr log foo.c
 
1160
        bzr log -r -10.. http://server/branch
 
1161
    """
 
1162
 
 
1163
    # TODO: Make --revision support uuid: and hash: [future tag:] notation.
 
1164
 
 
1165
    takes_args = ['location?']
 
1166
    takes_options = [Option('forward', 
 
1167
                            help='show from oldest to newest'),
 
1168
                     'timezone', 
 
1169
                     Option('verbose', 
 
1170
                             help='show files changed in each revision'),
 
1171
                     'show-ids', 'revision',
 
1172
                     'log-format',
 
1173
                     'line', 'long', 
 
1174
                     Option('message',
 
1175
                            help='show revisions whose message matches this regexp',
 
1176
                            type=str),
 
1177
                     'short',
 
1178
                     ]
 
1179
    @display_command
 
1180
    def run(self, location=None, timezone='original',
 
1181
            verbose=False,
 
1182
            show_ids=False,
 
1183
            forward=False,
 
1184
            revision=None,
 
1185
            log_format=None,
 
1186
            message=None,
 
1187
            long=False,
 
1188
            short=False,
 
1189
            line=False):
 
1190
        from bzrlib.log import log_formatter, show_log
 
1191
        import codecs
 
1192
        assert message is None or isinstance(message, basestring), \
 
1193
            "invalid message argument %r" % message
 
1194
        direction = (forward and 'forward') or 'reverse'
 
1195
        
 
1196
        # log everything
 
1197
        file_id = None
 
1198
        if location:
 
1199
            # find the file id to log:
 
1200
 
 
1201
            dir, fp = bzrdir.BzrDir.open_containing(location)
 
1202
            b = dir.open_branch()
 
1203
            if fp != '':
 
1204
                try:
 
1205
                    # might be a tree:
 
1206
                    inv = dir.open_workingtree().inventory
 
1207
                except (errors.NotBranchError, errors.NotLocalUrl):
 
1208
                    # either no tree, or is remote.
 
1209
                    inv = b.basis_tree().inventory
 
1210
                file_id = inv.path2id(fp)
 
1211
        else:
 
1212
            # local dir only
 
1213
            # FIXME ? log the current subdir only RBC 20060203 
 
1214
            dir, relpath = bzrdir.BzrDir.open_containing('.')
 
1215
            b = dir.open_branch()
 
1216
 
 
1217
        if revision is None:
 
1218
            rev1 = None
 
1219
            rev2 = None
 
1220
        elif len(revision) == 1:
 
1221
            rev1 = rev2 = revision[0].in_history(b).revno
 
1222
        elif len(revision) == 2:
 
1223
            if revision[0].spec is None:
 
1224
                # missing begin-range means first revision
 
1225
                rev1 = 1
 
1226
            else:
 
1227
                rev1 = revision[0].in_history(b).revno
 
1228
 
 
1229
            if revision[1].spec is None:
 
1230
                # missing end-range means last known revision
 
1231
                rev2 = b.revno()
 
1232
            else:
 
1233
                rev2 = revision[1].in_history(b).revno
 
1234
        else:
 
1235
            raise BzrCommandError('bzr log --revision takes one or two values.')
 
1236
 
 
1237
        # By this point, the revision numbers are converted to the +ve
 
1238
        # form if they were supplied in the -ve form, so we can do
 
1239
        # this comparison in relative safety
 
1240
        if rev1 > rev2:
 
1241
            (rev2, rev1) = (rev1, rev2)
 
1242
 
 
1243
        mutter('encoding log as %r', bzrlib.user_encoding)
 
1244
 
 
1245
        # use 'replace' so that we don't abort if trying to write out
 
1246
        # in e.g. the default C locale.
 
1247
        outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
 
1248
 
 
1249
        if (log_format == None):
 
1250
            default = bzrlib.config.BranchConfig(b).log_format()
 
1251
            log_format = get_log_format(long=long, short=short, line=line, default=default)
 
1252
 
 
1253
        lf = log_formatter(log_format,
 
1254
                           show_ids=show_ids,
 
1255
                           to_file=outf,
 
1256
                           show_timezone=timezone)
 
1257
 
 
1258
        show_log(b,
 
1259
                 lf,
 
1260
                 file_id,
 
1261
                 verbose=verbose,
 
1262
                 direction=direction,
 
1263
                 start_revision=rev1,
 
1264
                 end_revision=rev2,
 
1265
                 search=message)
 
1266
 
 
1267
 
 
1268
def get_log_format(long=False, short=False, line=False, default='long'):
 
1269
    log_format = default
 
1270
    if long:
 
1271
        log_format = 'long'
 
1272
    if short:
 
1273
        log_format = 'short'
 
1274
    if line:
 
1275
        log_format = 'line'
 
1276
    return log_format
 
1277
 
 
1278
 
 
1279
class cmd_touching_revisions(Command):
 
1280
    """Return revision-ids which affected a particular file.
 
1281
 
 
1282
    A more user-friendly interface is "bzr log FILE"."""
 
1283
    hidden = True
 
1284
    takes_args = ["filename"]
 
1285
    @display_command
 
1286
    def run(self, filename):
 
1287
        tree, relpath = WorkingTree.open_containing(filename)
 
1288
        b = tree.branch
 
1289
        inv = tree.read_working_inventory()
 
1290
        file_id = inv.path2id(relpath)
 
1291
        for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
 
1292
            print "%6d %s" % (revno, what)
 
1293
 
 
1294
 
 
1295
class cmd_ls(Command):
 
1296
    """List files in a tree.
 
1297
    """
 
1298
    # TODO: Take a revision or remote path and list that tree instead.
 
1299
    hidden = True
 
1300
    takes_options = ['verbose', 'revision',
 
1301
                     Option('non-recursive',
 
1302
                            help='don\'t recurse into sub-directories'),
 
1303
                     Option('from-root',
 
1304
                            help='Print all paths from the root of the branch.'),
 
1305
                     Option('unknown', help='Print unknown files'),
 
1306
                     Option('versioned', help='Print versioned files'),
 
1307
                     Option('ignored', help='Print ignored files'),
 
1308
 
 
1309
                     Option('null', help='Null separate the files'),
 
1310
                    ]
 
1311
    @display_command
 
1312
    def run(self, revision=None, verbose=False, 
 
1313
            non_recursive=False, from_root=False,
 
1314
            unknown=False, versioned=False, ignored=False,
 
1315
            null=False):
 
1316
 
 
1317
        if verbose and null:
 
1318
            raise BzrCommandError('Cannot set both --verbose and --null')
 
1319
        all = not (unknown or versioned or ignored)
 
1320
 
 
1321
        selection = {'I':ignored, '?':unknown, 'V':versioned}
 
1322
 
 
1323
        tree, relpath = WorkingTree.open_containing(u'.')
 
1324
        if from_root:
 
1325
            relpath = u''
 
1326
        elif relpath:
 
1327
            relpath += '/'
 
1328
        if revision is not None:
 
1329
            tree = tree.branch.repository.revision_tree(
 
1330
                revision[0].in_history(tree.branch).rev_id)
 
1331
        for fp, fc, kind, fid, entry in tree.list_files():
 
1332
            if fp.startswith(relpath):
 
1333
                fp = fp[len(relpath):]
 
1334
                if non_recursive and '/' in fp:
 
1335
                    continue
 
1336
                if not all and not selection[fc]:
 
1337
                    continue
 
1338
                if verbose:
 
1339
                    kindch = entry.kind_character()
 
1340
                    print '%-8s %s%s' % (fc, fp, kindch)
 
1341
                elif null:
 
1342
                    sys.stdout.write(fp)
 
1343
                    sys.stdout.write('\0')
 
1344
                    sys.stdout.flush()
 
1345
                else:
 
1346
                    print fp
 
1347
 
 
1348
 
 
1349
class cmd_unknowns(Command):
 
1350
    """List unknown files."""
 
1351
    @display_command
 
1352
    def run(self):
 
1353
        from bzrlib.osutils import quotefn
 
1354
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
 
1355
            print quotefn(f)
 
1356
 
 
1357
 
 
1358
class cmd_ignore(Command):
 
1359
    """Ignore a command or pattern.
 
1360
 
 
1361
    To remove patterns from the ignore list, edit the .bzrignore file.
 
1362
 
 
1363
    If the pattern contains a slash, it is compared to the whole path
 
1364
    from the branch root.  Otherwise, it is compared to only the last
 
1365
    component of the path.  To match a file only in the root directory,
 
1366
    prepend './'.
 
1367
 
 
1368
    Ignore patterns are case-insensitive on case-insensitive systems.
 
1369
 
 
1370
    Note: wildcards must be quoted from the shell on Unix.
 
1371
 
 
1372
    examples:
 
1373
        bzr ignore ./Makefile
 
1374
        bzr ignore '*.class'
 
1375
    """
 
1376
    # TODO: Complain if the filename is absolute
 
1377
    takes_args = ['name_pattern']
 
1378
    
 
1379
    def run(self, name_pattern):
 
1380
        from bzrlib.atomicfile import AtomicFile
 
1381
        import os.path
 
1382
 
 
1383
        tree, relpath = WorkingTree.open_containing(u'.')
 
1384
        ifn = tree.abspath('.bzrignore')
 
1385
 
 
1386
        if os.path.exists(ifn):
 
1387
            f = open(ifn, 'rt')
 
1388
            try:
 
1389
                igns = f.read().decode('utf-8')
 
1390
            finally:
 
1391
                f.close()
 
1392
        else:
 
1393
            igns = ''
 
1394
 
 
1395
        # TODO: If the file already uses crlf-style termination, maybe
 
1396
        # we should use that for the newly added lines?
 
1397
 
 
1398
        if igns and igns[-1] != '\n':
 
1399
            igns += '\n'
 
1400
        igns += name_pattern + '\n'
 
1401
 
 
1402
        f = AtomicFile(ifn, 'wt')
 
1403
        try:
 
1404
            f.write(igns.encode('utf-8'))
 
1405
            f.commit()
 
1406
        finally:
 
1407
            f.close()
 
1408
 
 
1409
        inv = tree.inventory
 
1410
        if inv.path2id('.bzrignore'):
 
1411
            mutter('.bzrignore is already versioned')
 
1412
        else:
 
1413
            mutter('need to make new .bzrignore file versioned')
 
1414
            tree.add(['.bzrignore'])
 
1415
 
 
1416
 
 
1417
class cmd_ignored(Command):
 
1418
    """List ignored files and the patterns that matched them.
 
1419
 
 
1420
    See also: bzr ignore"""
 
1421
    @display_command
 
1422
    def run(self):
 
1423
        tree = WorkingTree.open_containing(u'.')[0]
 
1424
        for path, file_class, kind, file_id, entry in tree.list_files():
 
1425
            if file_class != 'I':
 
1426
                continue
 
1427
            ## XXX: Slightly inefficient since this was already calculated
 
1428
            pat = tree.is_ignored(path)
 
1429
            print '%-50s %s' % (path, pat)
 
1430
 
 
1431
 
 
1432
class cmd_lookup_revision(Command):
 
1433
    """Lookup the revision-id from a revision-number
 
1434
 
 
1435
    example:
 
1436
        bzr lookup-revision 33
 
1437
    """
 
1438
    hidden = True
 
1439
    takes_args = ['revno']
 
1440
    
 
1441
    @display_command
 
1442
    def run(self, revno):
 
1443
        try:
 
1444
            revno = int(revno)
 
1445
        except ValueError:
 
1446
            raise BzrCommandError("not a valid revision-number: %r" % revno)
 
1447
 
 
1448
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
1449
 
 
1450
 
 
1451
class cmd_export(Command):
 
1452
    """Export past revision to destination directory.
 
1453
 
 
1454
    If no revision is specified this exports the last committed revision.
 
1455
 
 
1456
    Format may be an "exporter" name, such as tar, tgz, tbz2.  If none is
 
1457
    given, try to find the format with the extension. If no extension
 
1458
    is found exports to a directory (equivalent to --format=dir).
 
1459
 
 
1460
    Root may be the top directory for tar, tgz and tbz2 formats. If none
 
1461
    is given, the top directory will be the root name of the file.
 
1462
 
 
1463
    Note: export of tree with non-ascii filenames to zip is not supported.
 
1464
 
 
1465
     Supported formats       Autodetected by extension
 
1466
     -----------------       -------------------------
 
1467
         dir                            -
 
1468
         tar                          .tar
 
1469
         tbz2                    .tar.bz2, .tbz2
 
1470
         tgz                      .tar.gz, .tgz
 
1471
         zip                          .zip
 
1472
    """
 
1473
    takes_args = ['dest']
 
1474
    takes_options = ['revision', 'format', 'root']
 
1475
    def run(self, dest, revision=None, format=None, root=None):
 
1476
        import os.path
 
1477
        from bzrlib.export import export
 
1478
        tree = WorkingTree.open_containing(u'.')[0]
 
1479
        b = tree.branch
 
1480
        if revision is None:
 
1481
            # should be tree.last_revision  FIXME
 
1482
            rev_id = b.last_revision()
 
1483
        else:
 
1484
            if len(revision) != 1:
 
1485
                raise BzrError('bzr export --revision takes exactly 1 argument')
 
1486
            rev_id = revision[0].in_history(b).rev_id
 
1487
        t = b.repository.revision_tree(rev_id)
 
1488
        try:
 
1489
            export(t, dest, format, root)
 
1490
        except errors.NoSuchExportFormat, e:
 
1491
            raise BzrCommandError('Unsupported export format: %s' % e.format)
 
1492
 
 
1493
 
 
1494
class cmd_cat(Command):
 
1495
    """Write a file's text from a previous revision."""
 
1496
 
 
1497
    takes_options = ['revision']
 
1498
    takes_args = ['filename']
 
1499
 
 
1500
    @display_command
 
1501
    def run(self, filename, revision=None):
 
1502
        if revision is not None and len(revision) != 1:
 
1503
            raise BzrCommandError("bzr cat --revision takes exactly one number")
 
1504
        tree = None
 
1505
        try:
 
1506
            tree, relpath = WorkingTree.open_containing(filename)
 
1507
            b = tree.branch
 
1508
        except NotBranchError:
 
1509
            pass
 
1510
 
 
1511
        if tree is None:
 
1512
            b, relpath = Branch.open_containing(filename)
 
1513
        if revision is None:
 
1514
            revision_id = b.last_revision()
 
1515
        else:
 
1516
            revision_id = revision[0].in_history(b).rev_id
 
1517
        b.print_file(relpath, revision_id)
 
1518
 
 
1519
 
 
1520
class cmd_local_time_offset(Command):
 
1521
    """Show the offset in seconds from GMT to local time."""
 
1522
    hidden = True    
 
1523
    @display_command
 
1524
    def run(self):
 
1525
        print bzrlib.osutils.local_time_offset()
 
1526
 
 
1527
 
 
1528
 
 
1529
class cmd_commit(Command):
 
1530
    """Commit changes into a new revision.
 
1531
    
 
1532
    If no arguments are given, the entire tree is committed.
 
1533
 
 
1534
    If selected files are specified, only changes to those files are
 
1535
    committed.  If a directory is specified then the directory and everything 
 
1536
    within it is committed.
 
1537
 
 
1538
    A selected-file commit may fail in some cases where the committed
 
1539
    tree would be invalid, such as trying to commit a file in a
 
1540
    newly-added directory that is not itself committed.
 
1541
    """
 
1542
    # TODO: Run hooks on tree to-be-committed, and after commit.
 
1543
 
 
1544
    # TODO: Strict commit that fails if there are deleted files.
 
1545
    #       (what does "deleted files" mean ??)
 
1546
 
 
1547
    # TODO: Give better message for -s, --summary, used by tla people
 
1548
 
 
1549
    # XXX: verbose currently does nothing
 
1550
 
 
1551
    takes_args = ['selected*']
 
1552
    takes_options = ['message', 'verbose', 
 
1553
                     Option('unchanged',
 
1554
                            help='commit even if nothing has changed'),
 
1555
                     Option('file', type=str, 
 
1556
                            argname='msgfile',
 
1557
                            help='file containing commit message'),
 
1558
                     Option('strict',
 
1559
                            help="refuse to commit if there are unknown "
 
1560
                            "files in the working tree."),
 
1561
                     Option('local',
 
1562
                            help="perform a local only commit in a bound "
 
1563
                                 "branch. Such commits are not pushed to "
 
1564
                                 "the master branch until a normal commit "
 
1565
                                 "is performed."
 
1566
                            ),
 
1567
                     ]
 
1568
    aliases = ['ci', 'checkin']
 
1569
 
 
1570
    def run(self, message=None, file=None, verbose=True, selected_list=None,
 
1571
            unchanged=False, strict=False, local=False):
 
1572
        from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
 
1573
        from bzrlib.errors import (PointlessCommit, ConflictsInTree,
 
1574
                StrictCommitFailed)
 
1575
        from bzrlib.msgeditor import edit_commit_message, \
 
1576
                make_commit_message_template
 
1577
        from tempfile import TemporaryFile
 
1578
        import codecs
 
1579
 
 
1580
        # TODO: Need a blackbox test for invoking the external editor; may be
 
1581
        # slightly problematic to run this cross-platform.
 
1582
 
 
1583
        # TODO: do more checks that the commit will succeed before 
 
1584
        # spending the user's valuable time typing a commit message.
 
1585
        #
 
1586
        # TODO: if the commit *does* happen to fail, then save the commit 
 
1587
        # message to a temporary file where it can be recovered
 
1588
        tree, selected_list = tree_files(selected_list)
 
1589
        if selected_list == ['']:
 
1590
            # workaround - commit of root of tree should be exactly the same
 
1591
            # as just default commit in that tree, and succeed even though
 
1592
            # selected-file merge commit is not done yet
 
1593
            selected_list = []
 
1594
 
 
1595
        if local and not tree.branch.get_bound_location():
 
1596
            raise errors.LocalRequiresBoundBranch()
 
1597
        if message is None and not file:
 
1598
            template = make_commit_message_template(tree, selected_list)
 
1599
            message = edit_commit_message(template)
 
1600
            if message is None:
 
1601
                raise BzrCommandError("please specify a commit message"
 
1602
                                      " with either --message or --file")
 
1603
        elif message and file:
 
1604
            raise BzrCommandError("please specify either --message or --file")
 
1605
        
 
1606
        if file:
 
1607
            import codecs
 
1608
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
 
1609
 
 
1610
        if message == "":
 
1611
                raise BzrCommandError("empty commit message specified")
 
1612
        
 
1613
        if verbose:
 
1614
            reporter = ReportCommitToLog()
 
1615
        else:
 
1616
            reporter = NullCommitReporter()
 
1617
        
 
1618
        try:
 
1619
            tree.commit(message, specific_files=selected_list,
 
1620
                        allow_pointless=unchanged, strict=strict, local=local,
 
1621
                        reporter=reporter)
 
1622
        except PointlessCommit:
 
1623
            # FIXME: This should really happen before the file is read in;
 
1624
            # perhaps prepare the commit; get the message; then actually commit
 
1625
            raise BzrCommandError("no changes to commit",
 
1626
                                  ["use --unchanged to commit anyhow"])
 
1627
        except ConflictsInTree:
 
1628
            raise BzrCommandError("Conflicts detected in working tree.  "
 
1629
                'Use "bzr conflicts" to list, "bzr resolve FILE" to resolve.')
 
1630
        except StrictCommitFailed:
 
1631
            raise BzrCommandError("Commit refused because there are unknown "
 
1632
                                  "files in the working tree.")
 
1633
        except errors.BoundBranchOutOfDate, e:
 
1634
            raise BzrCommandError(str(e)
 
1635
                                  + ' Either unbind, update, or'
 
1636
                                    ' pass --local to commit.')
 
1637
 
 
1638
 
 
1639
class cmd_check(Command):
 
1640
    """Validate consistency of branch history.
 
1641
 
 
1642
    This command checks various invariants about the branch storage to
 
1643
    detect data corruption or bzr bugs.
 
1644
    """
 
1645
    takes_args = ['branch?']
 
1646
    takes_options = ['verbose']
 
1647
 
 
1648
    def run(self, branch=None, verbose=False):
 
1649
        from bzrlib.check import check
 
1650
        if branch is None:
 
1651
            tree = WorkingTree.open_containing()[0]
 
1652
            branch = tree.branch
 
1653
        else:
 
1654
            branch = Branch.open(branch)
 
1655
        check(branch, verbose)
 
1656
 
 
1657
 
 
1658
class cmd_scan_cache(Command):
 
1659
    hidden = True
 
1660
    def run(self):
 
1661
        from bzrlib.hashcache import HashCache
 
1662
 
 
1663
        c = HashCache(u'.')
 
1664
        c.read()
 
1665
        c.scan()
 
1666
            
 
1667
        print '%6d stats' % c.stat_count
 
1668
        print '%6d in hashcache' % len(c._cache)
 
1669
        print '%6d files removed from cache' % c.removed_count
 
1670
        print '%6d hashes updated' % c.update_count
 
1671
        print '%6d files changed too recently to cache' % c.danger_count
 
1672
 
 
1673
        if c.needs_write:
 
1674
            c.write()
 
1675
 
 
1676
 
 
1677
class cmd_upgrade(Command):
 
1678
    """Upgrade branch storage to current format.
 
1679
 
 
1680
    The check command or bzr developers may sometimes advise you to run
 
1681
    this command. When the default format has changed you may also be warned
 
1682
    during other operations to upgrade.
 
1683
    """
 
1684
    takes_args = ['url?']
 
1685
    takes_options = [
 
1686
                     Option('format', 
 
1687
                            help='Upgrade to a specific format. Current formats'
 
1688
                                 ' are: default, knit, metaweave and weave.'
 
1689
                                 ' Default is knit; metaweave and weave are'
 
1690
                                 ' deprecated',
 
1691
                            type=get_format_type),
 
1692
                    ]
 
1693
 
 
1694
 
 
1695
    def run(self, url='.', format=None):
 
1696
        from bzrlib.upgrade import upgrade
 
1697
        if format is None:
 
1698
            format = get_format_type('default')
 
1699
        upgrade(url, format)
 
1700
 
 
1701
 
 
1702
class cmd_whoami(Command):
 
1703
    """Show bzr user id."""
 
1704
    takes_options = ['email']
 
1705
    
 
1706
    @display_command
 
1707
    def run(self, email=False):
 
1708
        try:
 
1709
            b = WorkingTree.open_containing(u'.')[0].branch
 
1710
            config = bzrlib.config.BranchConfig(b)
 
1711
        except NotBranchError:
 
1712
            config = bzrlib.config.GlobalConfig()
 
1713
        
 
1714
        if email:
 
1715
            print config.user_email()
 
1716
        else:
 
1717
            print config.username()
 
1718
 
 
1719
 
 
1720
class cmd_nick(Command):
 
1721
    """Print or set the branch nickname.  
 
1722
 
 
1723
    If unset, the tree root directory name is used as the nickname
 
1724
    To print the current nickname, execute with no argument.  
 
1725
    """
 
1726
    takes_args = ['nickname?']
 
1727
    def run(self, nickname=None):
 
1728
        branch = Branch.open_containing(u'.')[0]
 
1729
        if nickname is None:
 
1730
            self.printme(branch)
 
1731
        else:
 
1732
            branch.nick = nickname
 
1733
 
 
1734
    @display_command
 
1735
    def printme(self, branch):
 
1736
        print branch.nick 
 
1737
 
 
1738
 
 
1739
class cmd_selftest(Command):
 
1740
    """Run internal test suite.
 
1741
    
 
1742
    This creates temporary test directories in the working directory,
 
1743
    but not existing data is affected.  These directories are deleted
 
1744
    if the tests pass, or left behind to help in debugging if they
 
1745
    fail and --keep-output is specified.
 
1746
    
 
1747
    If arguments are given, they are regular expressions that say
 
1748
    which tests should run.
 
1749
 
 
1750
    If the global option '--no-plugins' is given, plugins are not loaded
 
1751
    before running the selftests.  This has two effects: features provided or
 
1752
    modified by plugins will not be tested, and tests provided by plugins will
 
1753
    not be run.
 
1754
 
 
1755
    examples:
 
1756
        bzr selftest ignore
 
1757
        bzr --no-plugins selftest -v
 
1758
    """
 
1759
    # TODO: --list should give a list of all available tests
 
1760
 
 
1761
    # NB: this is used from the class without creating an instance, which is
 
1762
    # why it does not have a self parameter.
 
1763
    def get_transport_type(typestring):
 
1764
        """Parse and return a transport specifier."""
 
1765
        if typestring == "sftp":
 
1766
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
1767
            return SFTPAbsoluteServer
 
1768
        if typestring == "memory":
 
1769
            from bzrlib.transport.memory import MemoryServer
 
1770
            return MemoryServer
 
1771
        if typestring == "fakenfs":
 
1772
            from bzrlib.transport.fakenfs import FakeNFSServer
 
1773
            return FakeNFSServer
 
1774
        msg = "No known transport type %s. Supported types are: sftp\n" %\
 
1775
            (typestring)
 
1776
        raise BzrCommandError(msg)
 
1777
 
 
1778
    hidden = True
 
1779
    takes_args = ['testspecs*']
 
1780
    takes_options = ['verbose',
 
1781
                     Option('one', help='stop when one test fails'),
 
1782
                     Option('keep-output', 
 
1783
                            help='keep output directories when tests fail'),
 
1784
                     Option('transport', 
 
1785
                            help='Use a different transport by default '
 
1786
                                 'throughout the test suite.',
 
1787
                            type=get_transport_type),
 
1788
                     Option('benchmark', help='run the bzr bencharks.'),
 
1789
                     Option('lsprof-timed',
 
1790
                            help='generate lsprof output for benchmarked'
 
1791
                                 ' sections of code.'),
 
1792
                     ]
 
1793
 
 
1794
    def run(self, testspecs_list=None, verbose=None, one=False,
 
1795
            keep_output=False, transport=None, benchmark=None,
 
1796
            lsprof_timed=None):
 
1797
        import bzrlib.ui
 
1798
        from bzrlib.tests import selftest
 
1799
        import bzrlib.benchmarks as benchmarks
 
1800
        # we don't want progress meters from the tests to go to the
 
1801
        # real output; and we don't want log messages cluttering up
 
1802
        # the real logs.
 
1803
        save_ui = bzrlib.ui.ui_factory
 
1804
        print '%10s: %s' % ('bzr', bzrlib.osutils.realpath(sys.argv[0]))
 
1805
        print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
 
1806
        print
 
1807
        bzrlib.trace.info('running tests...')
 
1808
        try:
 
1809
            bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
 
1810
            if testspecs_list is not None:
 
1811
                pattern = '|'.join(testspecs_list)
 
1812
            else:
 
1813
                pattern = ".*"
 
1814
            if benchmark:
 
1815
                test_suite_factory = benchmarks.test_suite
 
1816
                if verbose is None:
 
1817
                    verbose = True
 
1818
            else:
 
1819
                test_suite_factory = None
 
1820
                if verbose is None:
 
1821
                    verbose = False
 
1822
            result = selftest(verbose=verbose, 
 
1823
                              pattern=pattern,
 
1824
                              stop_on_failure=one, 
 
1825
                              keep_output=keep_output,
 
1826
                              transport=transport,
 
1827
                              test_suite_factory=test_suite_factory,
 
1828
                              lsprof_timed=lsprof_timed)
 
1829
            if result:
 
1830
                bzrlib.trace.info('tests passed')
 
1831
            else:
 
1832
                bzrlib.trace.info('tests failed')
 
1833
            return int(not result)
 
1834
        finally:
 
1835
            bzrlib.ui.ui_factory = save_ui
 
1836
 
 
1837
 
 
1838
def _get_bzr_branch():
 
1839
    """If bzr is run from a branch, return Branch or None"""
 
1840
    import bzrlib.errors
 
1841
    from bzrlib.branch import Branch
 
1842
    from bzrlib.osutils import abspath
 
1843
    from os.path import dirname
 
1844
    
 
1845
    try:
 
1846
        branch = Branch.open(dirname(abspath(dirname(__file__))))
 
1847
        return branch
 
1848
    except bzrlib.errors.BzrError:
 
1849
        return None
 
1850
    
 
1851
 
 
1852
def show_version():
 
1853
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
 
1854
    # is bzrlib itself in a branch?
 
1855
    branch = _get_bzr_branch()
 
1856
    if branch:
 
1857
        rh = branch.revision_history()
 
1858
        revno = len(rh)
 
1859
        print "  bzr checkout, revision %d" % (revno,)
 
1860
        print "  nick: %s" % (branch.nick,)
 
1861
        if rh:
 
1862
            print "  revid: %s" % (rh[-1],)
 
1863
    print bzrlib.__copyright__
 
1864
    print "http://bazaar-vcs.org/"
 
1865
    print
 
1866
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
 
1867
    print "you may use, modify and redistribute it under the terms of the GNU"
 
1868
    print "General Public License version 2 or later."
 
1869
 
 
1870
 
 
1871
class cmd_version(Command):
 
1872
    """Show version of bzr."""
 
1873
    @display_command
 
1874
    def run(self):
 
1875
        show_version()
 
1876
 
 
1877
class cmd_rocks(Command):
 
1878
    """Statement of optimism."""
 
1879
    hidden = True
 
1880
    @display_command
 
1881
    def run(self):
 
1882
        print "it sure does!"
 
1883
 
 
1884
 
 
1885
class cmd_find_merge_base(Command):
 
1886
    """Find and print a base revision for merging two branches.
 
1887
    """
 
1888
    # TODO: Options to specify revisions on either side, as if
 
1889
    #       merging only part of the history.
 
1890
    takes_args = ['branch', 'other']
 
1891
    hidden = True
 
1892
    
 
1893
    @display_command
 
1894
    def run(self, branch, other):
 
1895
        from bzrlib.revision import common_ancestor, MultipleRevisionSources
 
1896
        
 
1897
        branch1 = Branch.open_containing(branch)[0]
 
1898
        branch2 = Branch.open_containing(other)[0]
 
1899
 
 
1900
        history_1 = branch1.revision_history()
 
1901
        history_2 = branch2.revision_history()
 
1902
 
 
1903
        last1 = branch1.last_revision()
 
1904
        last2 = branch2.last_revision()
 
1905
 
 
1906
        source = MultipleRevisionSources(branch1.repository, 
 
1907
                                         branch2.repository)
 
1908
        
 
1909
        base_rev_id = common_ancestor(last1, last2, source)
 
1910
 
 
1911
        print 'merge base is revision %s' % base_rev_id
 
1912
        
 
1913
        return
 
1914
 
 
1915
        if base_revno is None:
 
1916
            raise bzrlib.errors.UnrelatedBranches()
 
1917
 
 
1918
        print ' r%-6d in %s' % (base_revno, branch)
 
1919
 
 
1920
        other_revno = branch2.revision_id_to_revno(base_revid)
 
1921
        
 
1922
        print ' r%-6d in %s' % (other_revno, other)
 
1923
 
 
1924
 
 
1925
 
 
1926
class cmd_merge(Command):
 
1927
    """Perform a three-way merge.
 
1928
    
 
1929
    The branch is the branch you will merge from.  By default, it will
 
1930
    merge the latest revision.  If you specify a revision, that
 
1931
    revision will be merged.  If you specify two revisions, the first
 
1932
    will be used as a BASE, and the second one as OTHER.  Revision
 
1933
    numbers are always relative to the specified branch.
 
1934
 
 
1935
    By default, bzr will try to merge in all new work from the other
 
1936
    branch, automatically determining an appropriate base.  If this
 
1937
    fails, you may need to give an explicit base.
 
1938
    
 
1939
    Merge will do its best to combine the changes in two branches, but there
 
1940
    are some kinds of problems only a human can fix.  When it encounters those,
 
1941
    it will mark a conflict.  A conflict means that you need to fix something,
 
1942
    before you should commit.
 
1943
 
 
1944
    Use bzr resolve when you have fixed a problem.  See also bzr conflicts.
 
1945
 
 
1946
    If there is no default branch set, the first merge will set it. After
 
1947
    that, you can omit the branch to use the default.  To change the
 
1948
    default, use --remember.
 
1949
 
 
1950
    Examples:
 
1951
 
 
1952
    To merge the latest revision from bzr.dev
 
1953
    bzr merge ../bzr.dev
 
1954
 
 
1955
    To merge changes up to and including revision 82 from bzr.dev
 
1956
    bzr merge -r 82 ../bzr.dev
 
1957
 
 
1958
    To merge the changes introduced by 82, without previous changes:
 
1959
    bzr merge -r 81..82 ../bzr.dev
 
1960
    
 
1961
    merge refuses to run if there are any uncommitted changes, unless
 
1962
    --force is given.
 
1963
 
 
1964
    The following merge types are available:
 
1965
    """
 
1966
    takes_args = ['branch?']
 
1967
    takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
 
1968
                     Option('show-base', help="Show base revision text in "
 
1969
                            "conflicts")]
 
1970
 
 
1971
    def help(self):
 
1972
        from merge import merge_type_help
 
1973
        from inspect import getdoc
 
1974
        return getdoc(self) + '\n' + merge_type_help() 
 
1975
 
 
1976
    def run(self, branch=None, revision=None, force=False, merge_type=None,
 
1977
            show_base=False, reprocess=False, remember=False):
 
1978
        if merge_type is None:
 
1979
            merge_type = Merge3Merger
 
1980
 
 
1981
 
 
1982
        tree = WorkingTree.open_containing(u'.')[0]
 
1983
        try:
 
1984
            if branch is not None:
 
1985
                reader = BundleReader(file(branch, 'rb'))
 
1986
            else:
 
1987
                reader = None
 
1988
        except IOError, e:
 
1989
            if e.errno not in (errno.ENOENT, errno.EISDIR):
 
1990
                raise
 
1991
            reader = None
 
1992
        except BadBundle:
 
1993
            reader = None
 
1994
        if reader is not None:
 
1995
            conflicts = merge_bundle(reader, tree, not force, merge_type,
 
1996
                                        reprocess, show_base)
 
1997
            if conflicts == 0:
 
1998
                return 0
 
1999
            else:
 
2000
                return 1
 
2001
 
 
2002
        stored_loc = tree.branch.get_parent()
 
2003
        if branch is None:
 
2004
            if stored_loc is None:
 
2005
                raise BzrCommandError("No merge branch known or specified.")
 
2006
            else:
 
2007
                print "Using saved branch: %s" % stored_loc
 
2008
                branch = stored_loc
 
2009
 
 
2010
        if tree.branch.get_parent() is None or remember:
 
2011
            tree.branch.set_parent(branch)
 
2012
 
 
2013
        if revision is None or len(revision) < 1:
 
2014
            base = [None, None]
 
2015
            other = [branch, -1]
 
2016
            other_branch, path = Branch.open_containing(branch)
 
2017
        else:
 
2018
            if len(revision) == 1:
 
2019
                base = [None, None]
 
2020
                other_branch, path = Branch.open_containing(branch)
 
2021
                revno = revision[0].in_history(other_branch).revno
 
2022
                other = [branch, revno]
 
2023
            else:
 
2024
                assert len(revision) == 2
 
2025
                if None in revision:
 
2026
                    raise BzrCommandError(
 
2027
                        "Merge doesn't permit that revision specifier.")
 
2028
                b, path = Branch.open_containing(branch)
 
2029
 
 
2030
                base = [branch, revision[0].in_history(b).revno]
 
2031
                other = [branch, revision[1].in_history(b).revno]
 
2032
        if path != "":
 
2033
            interesting_files = [path]
 
2034
        else:
 
2035
            interesting_files = None
 
2036
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
2037
        try:
 
2038
            try:
 
2039
                conflict_count = merge(other, base, check_clean=(not force),
 
2040
                                       merge_type=merge_type, 
 
2041
                                       reprocess=reprocess,
 
2042
                                       show_base=show_base, 
 
2043
                                       pb=pb, file_list=interesting_files)
 
2044
            finally:
 
2045
                pb.finished()
 
2046
            if conflict_count != 0:
 
2047
                return 1
 
2048
            else:
 
2049
                return 0
 
2050
        except bzrlib.errors.AmbiguousBase, e:
 
2051
            m = ("sorry, bzr can't determine the right merge base yet\n"
 
2052
                 "candidates are:\n  "
 
2053
                 + "\n  ".join(e.bases)
 
2054
                 + "\n"
 
2055
                 "please specify an explicit base with -r,\n"
 
2056
                 "and (if you want) report this to the bzr developers\n")
 
2057
            log_error(m)
 
2058
 
 
2059
 
 
2060
class cmd_remerge(Command):
 
2061
    """Redo a merge.
 
2062
 
 
2063
    Use this if you want to try a different merge technique while resolving
 
2064
    conflicts.  Some merge techniques are better than others, and remerge 
 
2065
    lets you try different ones on different files.
 
2066
 
 
2067
    The options for remerge have the same meaning and defaults as the ones for
 
2068
    merge.  The difference is that remerge can (only) be run when there is a
 
2069
    pending merge, and it lets you specify particular files.
 
2070
 
 
2071
    Examples:
 
2072
    $ bzr remerge --show-base
 
2073
        Re-do the merge of all conflicted files, and show the base text in
 
2074
        conflict regions, in addition to the usual THIS and OTHER texts.
 
2075
 
 
2076
    $ bzr remerge --merge-type weave --reprocess foobar
 
2077
        Re-do the merge of "foobar", using the weave merge algorithm, with
 
2078
        additional processing to reduce the size of conflict regions.
 
2079
    
 
2080
    The following merge types are available:"""
 
2081
    takes_args = ['file*']
 
2082
    takes_options = ['merge-type', 'reprocess',
 
2083
                     Option('show-base', help="Show base revision text in "
 
2084
                            "conflicts")]
 
2085
 
 
2086
    def help(self):
 
2087
        from merge import merge_type_help
 
2088
        from inspect import getdoc
 
2089
        return getdoc(self) + '\n' + merge_type_help() 
 
2090
 
 
2091
    def run(self, file_list=None, merge_type=None, show_base=False,
 
2092
            reprocess=False):
 
2093
        from bzrlib.merge import merge_inner, transform_tree
 
2094
        if merge_type is None:
 
2095
            merge_type = Merge3Merger
 
2096
        tree, file_list = tree_files(file_list)
 
2097
        tree.lock_write()
 
2098
        try:
 
2099
            pending_merges = tree.pending_merges() 
 
2100
            if len(pending_merges) != 1:
 
2101
                raise BzrCommandError("Sorry, remerge only works after normal"
 
2102
                                      + " merges.  Not cherrypicking or"
 
2103
                                      + "multi-merges.")
 
2104
            repository = tree.branch.repository
 
2105
            base_revision = common_ancestor(tree.branch.last_revision(), 
 
2106
                                            pending_merges[0], repository)
 
2107
            base_tree = repository.revision_tree(base_revision)
 
2108
            other_tree = repository.revision_tree(pending_merges[0])
 
2109
            interesting_ids = None
 
2110
            if file_list is not None:
 
2111
                interesting_ids = set()
 
2112
                for filename in file_list:
 
2113
                    file_id = tree.path2id(filename)
 
2114
                    if file_id is None:
 
2115
                        raise NotVersionedError(filename)
 
2116
                    interesting_ids.add(file_id)
 
2117
                    if tree.kind(file_id) != "directory":
 
2118
                        continue
 
2119
                    
 
2120
                    for name, ie in tree.inventory.iter_entries(file_id):
 
2121
                        interesting_ids.add(ie.file_id)
 
2122
            transform_tree(tree, tree.basis_tree(), interesting_ids)
 
2123
            if file_list is None:
 
2124
                restore_files = list(tree.iter_conflicts())
 
2125
            else:
 
2126
                restore_files = file_list
 
2127
            for filename in restore_files:
 
2128
                try:
 
2129
                    restore(tree.abspath(filename))
 
2130
                except NotConflicted:
 
2131
                    pass
 
2132
            conflicts =  merge_inner(tree.branch, other_tree, base_tree,
 
2133
                                     this_tree=tree,
 
2134
                                     interesting_ids = interesting_ids, 
 
2135
                                     other_rev_id=pending_merges[0], 
 
2136
                                     merge_type=merge_type, 
 
2137
                                     show_base=show_base,
 
2138
                                     reprocess=reprocess)
 
2139
        finally:
 
2140
            tree.unlock()
 
2141
        if conflicts > 0:
 
2142
            return 1
 
2143
        else:
 
2144
            return 0
 
2145
 
 
2146
class cmd_revert(Command):
 
2147
    """Reverse all changes since the last commit.
 
2148
 
 
2149
    Only versioned files are affected.  Specify filenames to revert only 
 
2150
    those files.  By default, any files that are changed will be backed up
 
2151
    first.  Backup files have a '~' appended to their name.
 
2152
    """
 
2153
    takes_options = ['revision', 'no-backup']
 
2154
    takes_args = ['file*']
 
2155
    aliases = ['merge-revert']
 
2156
 
 
2157
    def run(self, revision=None, no_backup=False, file_list=None):
 
2158
        from bzrlib.commands import parse_spec
 
2159
        if file_list is not None:
 
2160
            if len(file_list) == 0:
 
2161
                raise BzrCommandError("No files specified")
 
2162
        else:
 
2163
            file_list = []
 
2164
        
 
2165
        tree, file_list = tree_files(file_list)
 
2166
        if revision is None:
 
2167
            # FIXME should be tree.last_revision
 
2168
            rev_id = tree.last_revision()
 
2169
        elif len(revision) != 1:
 
2170
            raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
 
2171
        else:
 
2172
            rev_id = revision[0].in_history(tree.branch).rev_id
 
2173
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
2174
        try:
 
2175
            tree.revert(file_list, 
 
2176
                        tree.branch.repository.revision_tree(rev_id),
 
2177
                        not no_backup, pb)
 
2178
        finally:
 
2179
            pb.finished()
 
2180
 
 
2181
 
 
2182
class cmd_assert_fail(Command):
 
2183
    """Test reporting of assertion failures"""
 
2184
    hidden = True
 
2185
    def run(self):
 
2186
        assert False, "always fails"
 
2187
 
 
2188
 
 
2189
class cmd_help(Command):
 
2190
    """Show help on a command or other topic.
 
2191
 
 
2192
    For a list of all available commands, say 'bzr help commands'."""
 
2193
    takes_options = [Option('long', 'show help on all commands')]
 
2194
    takes_args = ['topic?']
 
2195
    aliases = ['?', '--help', '-?', '-h']
 
2196
    
 
2197
    @display_command
 
2198
    def run(self, topic=None, long=False):
 
2199
        import help
 
2200
        if topic is None and long:
 
2201
            topic = "commands"
 
2202
        help.help(topic)
 
2203
 
 
2204
 
 
2205
class cmd_shell_complete(Command):
 
2206
    """Show appropriate completions for context.
 
2207
 
 
2208
    For a list of all available commands, say 'bzr shell-complete'."""
 
2209
    takes_args = ['context?']
 
2210
    aliases = ['s-c']
 
2211
    hidden = True
 
2212
    
 
2213
    @display_command
 
2214
    def run(self, context=None):
 
2215
        import shellcomplete
 
2216
        shellcomplete.shellcomplete(context)
 
2217
 
 
2218
 
 
2219
class cmd_fetch(Command):
 
2220
    """Copy in history from another branch but don't merge it.
 
2221
 
 
2222
    This is an internal method used for pull and merge."""
 
2223
    hidden = True
 
2224
    takes_args = ['from_branch', 'to_branch']
 
2225
    def run(self, from_branch, to_branch):
 
2226
        from bzrlib.fetch import Fetcher
 
2227
        from bzrlib.branch import Branch
 
2228
        from_b = Branch.open(from_branch)
 
2229
        to_b = Branch.open(to_branch)
 
2230
        Fetcher(to_b, from_b)
 
2231
 
 
2232
 
 
2233
class cmd_missing(Command):
 
2234
    """Show unmerged/unpulled revisions between two branches.
 
2235
 
 
2236
    OTHER_BRANCH may be local or remote."""
 
2237
    takes_args = ['other_branch?']
 
2238
    takes_options = [Option('reverse', 'Reverse the order of revisions'),
 
2239
                     Option('mine-only', 
 
2240
                            'Display changes in the local branch only'),
 
2241
                     Option('theirs-only', 
 
2242
                            'Display changes in the remote branch only'), 
 
2243
                     'log-format',
 
2244
                     'line',
 
2245
                     'long', 
 
2246
                     'short',
 
2247
                     'show-ids',
 
2248
                     'verbose'
 
2249
                     ]
 
2250
 
 
2251
    def run(self, other_branch=None, reverse=False, mine_only=False,
 
2252
            theirs_only=False, log_format=None, long=False, short=False, line=False, 
 
2253
            show_ids=False, verbose=False):
 
2254
        from bzrlib.missing import find_unmerged, iter_log_data
 
2255
        from bzrlib.log import log_formatter
 
2256
        local_branch = bzrlib.branch.Branch.open_containing(u".")[0]
 
2257
        parent = local_branch.get_parent()
 
2258
        if other_branch is None:
 
2259
            other_branch = parent
 
2260
            if other_branch is None:
 
2261
                raise BzrCommandError("No missing location known or specified.")
 
2262
            print "Using last location: " + local_branch.get_parent()
 
2263
        remote_branch = bzrlib.branch.Branch.open(other_branch)
 
2264
        if remote_branch.base == local_branch.base:
 
2265
            remote_branch = local_branch
 
2266
        local_branch.lock_read()
 
2267
        try:
 
2268
            remote_branch.lock_read()
 
2269
            try:
 
2270
                local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
 
2271
                if (log_format == None):
 
2272
                    default = bzrlib.config.BranchConfig(local_branch).log_format()
 
2273
                    log_format = get_log_format(long=long, short=short, line=line, default=default)
 
2274
                lf = log_formatter(log_format, sys.stdout,
 
2275
                                   show_ids=show_ids,
 
2276
                                   show_timezone='original')
 
2277
                if reverse is False:
 
2278
                    local_extra.reverse()
 
2279
                    remote_extra.reverse()
 
2280
                if local_extra and not theirs_only:
 
2281
                    print "You have %d extra revision(s):" % len(local_extra)
 
2282
                    for data in iter_log_data(local_extra, local_branch.repository,
 
2283
                                              verbose):
 
2284
                        lf.show(*data)
 
2285
                    printed_local = True
 
2286
                else:
 
2287
                    printed_local = False
 
2288
                if remote_extra and not mine_only:
 
2289
                    if printed_local is True:
 
2290
                        print "\n\n"
 
2291
                    print "You are missing %d revision(s):" % len(remote_extra)
 
2292
                    for data in iter_log_data(remote_extra, remote_branch.repository, 
 
2293
                                              verbose):
 
2294
                        lf.show(*data)
 
2295
                if not remote_extra and not local_extra:
 
2296
                    status_code = 0
 
2297
                    print "Branches are up to date."
 
2298
                else:
 
2299
                    status_code = 1
 
2300
            finally:
 
2301
                remote_branch.unlock()
 
2302
        finally:
 
2303
            local_branch.unlock()
 
2304
        if not status_code and parent is None and other_branch is not None:
 
2305
            local_branch.lock_write()
 
2306
            try:
 
2307
                # handle race conditions - a parent might be set while we run.
 
2308
                if local_branch.get_parent() is None:
 
2309
                    local_branch.set_parent(other_branch)
 
2310
            finally:
 
2311
                local_branch.unlock()
 
2312
        return status_code
 
2313
 
 
2314
 
 
2315
class cmd_plugins(Command):
 
2316
    """List plugins"""
 
2317
    hidden = True
 
2318
    @display_command
 
2319
    def run(self):
 
2320
        import bzrlib.plugin
 
2321
        from inspect import getdoc
 
2322
        for name, plugin in bzrlib.plugin.all_plugins().items():
 
2323
            if hasattr(plugin, '__path__'):
 
2324
                print plugin.__path__[0]
 
2325
            elif hasattr(plugin, '__file__'):
 
2326
                print plugin.__file__
 
2327
            else:
 
2328
                print `plugin`
 
2329
                
 
2330
            d = getdoc(plugin)
 
2331
            if d:
 
2332
                print '\t', d.split('\n')[0]
 
2333
 
 
2334
 
 
2335
class cmd_testament(Command):
 
2336
    """Show testament (signing-form) of a revision."""
 
2337
    takes_options = ['revision', 'long']
 
2338
    takes_args = ['branch?']
 
2339
    @display_command
 
2340
    def run(self, branch=u'.', revision=None, long=False):
 
2341
        from bzrlib.testament import Testament
 
2342
        b = WorkingTree.open_containing(branch)[0].branch
 
2343
        b.lock_read()
 
2344
        try:
 
2345
            if revision is None:
 
2346
                rev_id = b.last_revision()
 
2347
            else:
 
2348
                rev_id = revision[0].in_history(b).rev_id
 
2349
            t = Testament.from_revision(b.repository, rev_id)
 
2350
            if long:
 
2351
                sys.stdout.writelines(t.as_text_lines())
 
2352
            else:
 
2353
                sys.stdout.write(t.as_short_text())
 
2354
        finally:
 
2355
            b.unlock()
 
2356
 
 
2357
 
 
2358
class cmd_annotate(Command):
 
2359
    """Show the origin of each line in a file.
 
2360
 
 
2361
    This prints out the given file with an annotation on the left side
 
2362
    indicating which revision, author and date introduced the change.
 
2363
 
 
2364
    If the origin is the same for a run of consecutive lines, it is 
 
2365
    shown only at the top, unless the --all option is given.
 
2366
    """
 
2367
    # TODO: annotate directories; showing when each file was last changed
 
2368
    # TODO: if the working copy is modified, show annotations on that 
 
2369
    #       with new uncommitted lines marked
 
2370
    aliases = ['blame', 'praise']
 
2371
    takes_args = ['filename']
 
2372
    takes_options = [Option('all', help='show annotations on all lines'),
 
2373
                     Option('long', help='show date in annotations'),
 
2374
                     'revision'
 
2375
                     ]
 
2376
 
 
2377
    @display_command
 
2378
    def run(self, filename, all=False, long=False, revision=None):
 
2379
        from bzrlib.annotate import annotate_file
 
2380
        tree, relpath = WorkingTree.open_containing(filename)
 
2381
        branch = tree.branch
 
2382
        branch.lock_read()
 
2383
        try:
 
2384
            if revision is None:
 
2385
                revision_id = branch.last_revision()
 
2386
            elif len(revision) != 1:
 
2387
                raise BzrCommandError('bzr annotate --revision takes exactly 1 argument')
 
2388
            else:
 
2389
                revision_id = revision[0].in_history(branch).rev_id
 
2390
            file_id = tree.inventory.path2id(relpath)
 
2391
            tree = branch.repository.revision_tree(revision_id)
 
2392
            file_version = tree.inventory[file_id].revision
 
2393
            annotate_file(branch, file_version, file_id, long, all, sys.stdout)
 
2394
        finally:
 
2395
            branch.unlock()
 
2396
 
 
2397
 
 
2398
class cmd_re_sign(Command):
 
2399
    """Create a digital signature for an existing revision."""
 
2400
    # TODO be able to replace existing ones.
 
2401
 
 
2402
    hidden = True # is this right ?
 
2403
    takes_args = ['revision_id*']
 
2404
    takes_options = ['revision']
 
2405
    
 
2406
    def run(self, revision_id_list=None, revision=None):
 
2407
        import bzrlib.config as config
 
2408
        import bzrlib.gpg as gpg
 
2409
        if revision_id_list is not None and revision is not None:
 
2410
            raise BzrCommandError('You can only supply one of revision_id or --revision')
 
2411
        if revision_id_list is None and revision is None:
 
2412
            raise BzrCommandError('You must supply either --revision or a revision_id')
 
2413
        b = WorkingTree.open_containing(u'.')[0].branch
 
2414
        gpg_strategy = gpg.GPGStrategy(config.BranchConfig(b))
 
2415
        if revision_id_list is not None:
 
2416
            for revision_id in revision_id_list:
 
2417
                b.repository.sign_revision(revision_id, gpg_strategy)
 
2418
        elif revision is not None:
 
2419
            if len(revision) == 1:
 
2420
                revno, rev_id = revision[0].in_history(b)
 
2421
                b.repository.sign_revision(rev_id, gpg_strategy)
 
2422
            elif len(revision) == 2:
 
2423
                # are they both on rh- if so we can walk between them
 
2424
                # might be nice to have a range helper for arbitrary
 
2425
                # revision paths. hmm.
 
2426
                from_revno, from_revid = revision[0].in_history(b)
 
2427
                to_revno, to_revid = revision[1].in_history(b)
 
2428
                if to_revid is None:
 
2429
                    to_revno = b.revno()
 
2430
                if from_revno is None or to_revno is None:
 
2431
                    raise BzrCommandError('Cannot sign a range of non-revision-history revisions')
 
2432
                for revno in range(from_revno, to_revno + 1):
 
2433
                    b.repository.sign_revision(b.get_rev_id(revno), 
 
2434
                                               gpg_strategy)
 
2435
            else:
 
2436
                raise BzrCommandError('Please supply either one revision, or a range.')
 
2437
 
 
2438
 
 
2439
class cmd_bind(Command):
 
2440
    """Bind the current branch to a master branch.
 
2441
 
 
2442
    After binding, commits must succeed on the master branch
 
2443
    before they are executed on the local one.
 
2444
    """
 
2445
 
 
2446
    takes_args = ['location']
 
2447
    takes_options = []
 
2448
 
 
2449
    def run(self, location=None):
 
2450
        b, relpath = Branch.open_containing(u'.')
 
2451
        b_other = Branch.open(location)
 
2452
        try:
 
2453
            b.bind(b_other)
 
2454
        except DivergedBranches:
 
2455
            raise BzrCommandError('These branches have diverged.'
 
2456
                                  ' Try merging, and then bind again.')
 
2457
 
 
2458
 
 
2459
class cmd_unbind(Command):
 
2460
    """Unbind the current branch from its master branch.
 
2461
 
 
2462
    After unbinding, the local branch is considered independent.
 
2463
    All subsequent commits will be local.
 
2464
    """
 
2465
 
 
2466
    takes_args = []
 
2467
    takes_options = []
 
2468
 
 
2469
    def run(self):
 
2470
        b, relpath = Branch.open_containing(u'.')
 
2471
        if not b.unbind():
 
2472
            raise BzrCommandError('Local branch is not bound')
 
2473
 
 
2474
 
 
2475
class cmd_uncommit(bzrlib.commands.Command):
 
2476
    """Remove the last committed revision.
 
2477
 
 
2478
    --verbose will print out what is being removed.
 
2479
    --dry-run will go through all the motions, but not actually
 
2480
    remove anything.
 
2481
    
 
2482
    In the future, uncommit will create a revision bundle, which can then
 
2483
    be re-applied.
 
2484
    """
 
2485
 
 
2486
    # TODO: jam 20060108 Add an option to allow uncommit to remove
 
2487
    # unreferenced information in 'branch-as-repostory' branches.
 
2488
    # TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
 
2489
    # information in shared branches as well.
 
2490
    takes_options = ['verbose', 'revision',
 
2491
                    Option('dry-run', help='Don\'t actually make changes'),
 
2492
                    Option('force', help='Say yes to all questions.')]
 
2493
    takes_args = ['location?']
 
2494
    aliases = []
 
2495
 
 
2496
    def run(self, location=None, 
 
2497
            dry_run=False, verbose=False,
 
2498
            revision=None, force=False):
 
2499
        from bzrlib.branch import Branch
 
2500
        from bzrlib.log import log_formatter
 
2501
        import sys
 
2502
        from bzrlib.uncommit import uncommit
 
2503
 
 
2504
        if location is None:
 
2505
            location = u'.'
 
2506
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
2507
        try:
 
2508
            tree = control.open_workingtree()
 
2509
            b = tree.branch
 
2510
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
2511
            tree = None
 
2512
            b = control.open_branch()
 
2513
 
 
2514
        if revision is None:
 
2515
            revno = b.revno()
 
2516
            rev_id = b.last_revision()
 
2517
        else:
 
2518
            revno, rev_id = revision[0].in_history(b)
 
2519
        if rev_id is None:
 
2520
            print 'No revisions to uncommit.'
 
2521
 
 
2522
        for r in range(revno, b.revno()+1):
 
2523
            rev_id = b.get_rev_id(r)
 
2524
            lf = log_formatter('short', to_file=sys.stdout,show_timezone='original')
 
2525
            lf.show(r, b.repository.get_revision(rev_id), None)
 
2526
 
 
2527
        if dry_run:
 
2528
            print 'Dry-run, pretending to remove the above revisions.'
 
2529
            if not force:
 
2530
                val = raw_input('Press <enter> to continue')
 
2531
        else:
 
2532
            print 'The above revision(s) will be removed.'
 
2533
            if not force:
 
2534
                val = raw_input('Are you sure [y/N]? ')
 
2535
                if val.lower() not in ('y', 'yes'):
 
2536
                    print 'Canceled'
 
2537
                    return 0
 
2538
 
 
2539
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
 
2540
                revno=revno)
 
2541
 
 
2542
 
 
2543
class cmd_break_lock(Command):
 
2544
    """Break a dead lock on a repository, branch or working directory.
 
2545
 
 
2546
    CAUTION: Locks should only be broken when you are sure that the process
 
2547
    holding the lock has been stopped.
 
2548
 
 
2549
    You can get information on what locks are open via the 'bzr info' command.
 
2550
    
 
2551
    example:
 
2552
        bzr break-lock
 
2553
    """
 
2554
    takes_args = ['location?']
 
2555
 
 
2556
    def run(self, location=None, show=False):
 
2557
        if location is None:
 
2558
            location = u'.'
 
2559
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
2560
        try:
 
2561
            control.break_lock()
 
2562
        except NotImplementedError:
 
2563
            pass
 
2564
        
 
2565
 
 
2566
 
 
2567
# command-line interpretation helper for merge-related commands
 
2568
def merge(other_revision, base_revision,
 
2569
          check_clean=True, ignore_zero=False,
 
2570
          this_dir=None, backup_files=False, merge_type=Merge3Merger,
 
2571
          file_list=None, show_base=False, reprocess=False,
 
2572
          pb=DummyProgress()):
 
2573
    """Merge changes into a tree.
 
2574
 
 
2575
    base_revision
 
2576
        list(path, revno) Base for three-way merge.  
 
2577
        If [None, None] then a base will be automatically determined.
 
2578
    other_revision
 
2579
        list(path, revno) Other revision for three-way merge.
 
2580
    this_dir
 
2581
        Directory to merge changes into; '.' by default.
 
2582
    check_clean
 
2583
        If true, this_dir must have no uncommitted changes before the
 
2584
        merge begins.
 
2585
    ignore_zero - If true, suppress the "zero conflicts" message when 
 
2586
        there are no conflicts; should be set when doing something we expect
 
2587
        to complete perfectly.
 
2588
    file_list - If supplied, merge only changes to selected files.
 
2589
 
 
2590
    All available ancestors of other_revision and base_revision are
 
2591
    automatically pulled into the branch.
 
2592
 
 
2593
    The revno may be -1 to indicate the last revision on the branch, which is
 
2594
    the typical case.
 
2595
 
 
2596
    This function is intended for use from the command line; programmatic
 
2597
    clients might prefer to call merge.merge_inner(), which has less magic 
 
2598
    behavior.
 
2599
    """
 
2600
    from bzrlib.merge import Merger
 
2601
    if this_dir is None:
 
2602
        this_dir = u'.'
 
2603
    this_tree = WorkingTree.open_containing(this_dir)[0]
 
2604
    if show_base and not merge_type is Merge3Merger:
 
2605
        raise BzrCommandError("Show-base is not supported for this merge"
 
2606
                              " type. %s" % merge_type)
 
2607
    if reprocess and not merge_type.supports_reprocess:
 
2608
        raise BzrCommandError("Conflict reduction is not supported for merge"
 
2609
                              " type %s." % merge_type)
 
2610
    if reprocess and show_base:
 
2611
        raise BzrCommandError("Cannot do conflict reduction and show base.")
 
2612
    try:
 
2613
        merger = Merger(this_tree.branch, this_tree=this_tree, pb=pb)
 
2614
        merger.pp = ProgressPhase("Merge phase", 5, pb)
 
2615
        merger.pp.next_phase()
 
2616
        merger.check_basis(check_clean)
 
2617
        merger.set_other(other_revision)
 
2618
        merger.pp.next_phase()
 
2619
        merger.set_base(base_revision)
 
2620
        if merger.base_rev_id == merger.other_rev_id:
 
2621
            note('Nothing to do.')
 
2622
            return 0
 
2623
        merger.backup_files = backup_files
 
2624
        merger.merge_type = merge_type 
 
2625
        merger.set_interesting_files(file_list)
 
2626
        merger.show_base = show_base 
 
2627
        merger.reprocess = reprocess
 
2628
        conflicts = merger.do_merge()
 
2629
        if file_list is None:
 
2630
            merger.set_pending()
 
2631
    finally:
 
2632
        pb.clear()
 
2633
    return conflicts
 
2634
 
 
2635
 
 
2636
# these get imported and then picked up by the scan for cmd_*
 
2637
# TODO: Some more consistent way to split command definitions across files;
 
2638
# we do need to load at least some information about them to know of 
 
2639
# aliases.  ideally we would avoid loading the implementation until the
 
2640
# details were needed.
 
2641
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
2642
from bzrlib.bundle.commands import cmd_bundle_revisions
 
2643
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
2644
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
 
2645
        cmd_weave_plan_merge, cmd_weave_merge_text