/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: Jan Balster
  • Date: 2006-08-15 13:13:27 UTC
  • mto: This revision was merged to the branch mainline in revision 1928.
  • Revision ID: jan@merlinux.de-20060815131327-c6db553def157b26
added .perf-history to the ignore file

Show diffs side-by-side

added added

removed removed

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