/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Robert Collins
  • Date: 2006-02-12 09:40:15 UTC
  • mto: (1534.1.22 integration)
  • mto: This revision was merged to the branch mainline in revision 1554.
  • Revision ID: robertc@robertcollins.net-20060212094015-0fba37745716a3d9
Implement -r limit for checkout command.

Show diffs side-by-side

added added

removed removed

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