/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: Matthieu Moy
  • Date: 2006-07-08 20:38:36 UTC
  • mto: This revision was merged to the branch mainline in revision 1857.
  • Revision ID: Matthieu.Moy@imag.fr-20060708203836-41c55eb497690906
Testcases for revno:N:path

Show diffs side-by-side

added added

removed removed

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