← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Robert Collins
  • Date: 2006-03-02 03:12:34 UTC
  • mto: (1594.2.4 integration)
  • mto: This revision was merged to the branch mainline in revision 1596.
  • Revision ID: robertc@robertcollins.net-20060302031234-cf6b75961f27c5df
InterVersionedFile implemented.

Show diffs side-by-side

added added

removed removed

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