/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

Merge bzr.dev

Show diffs side-by-side

added added

removed removed

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