~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Martin Pool
  • Date: 2006-03-09 03:28:52 UTC
  • mto: This revision was merged to the branch mainline in revision 1602.
  • Revision ID: mbp@sourcefrog.net-20060309032852-1097eb1947d9bceb
doc

Show diffs side-by-side

added added

removed removed

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