← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Erik Bågfors
  • Date: 2006-02-03 19:50:59 UTC
  • mto: (1185.50.77 bzr-jam-integration)
  • mto: This revision was merged to the branch mainline in revision 1554.
  • Revision ID: erik@bagfors.nu-20060203195059-1cf8ff5aa68de0ea
Support for plugins to register log formatters and set default formatter
Also, change one command line option for "log"

Show diffs side-by-side

added added

removed removed

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