/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Martin Pool
  • Date: 2006-06-05 18:00:36 UTC
  • mto: This revision was merged to the branch mainline in revision 1752.
  • Revision ID: mbp@sourcefrog.net-20060605180036-04f5d0cea94ed999
clean up test kipple

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