/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: John Arbash Meinel
  • Date: 2006-08-15 15:50:31 UTC
  • mto: This revision was merged to the branch mainline in revision 1927.
  • Revision ID: john@arbash-meinel.com-20060815155031-f1480d692d2cf9d2
There is no strict ordering file addition, other than directories are added before child files

Show diffs side-by-side

added added

removed removed

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