/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: Aaron Bentley
  • Date: 2006-08-02 13:02:47 UTC
  • mfrom: (1907 +trunk)
  • mto: This revision was merged to the branch mainline in revision 1934.
  • Revision ID: abentley@panoramicfeedback.com-20060802130247-bf2502d680abed61
Rough merge of bzr.dev

Show diffs side-by-side

added added

removed removed

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