← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-07-11 00:28:34 UTC
  • mfrom: (1793.3.13 bundle-fixes)
  • Revision ID: pqm@pqm.ubuntu.com-20060711002834-437bd17f804929ad
(jam) Updates to bundles, handle binary files, non integer timezone offsets, and sftp pull

Show diffs side-by-side

added added

removed removed

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