/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

Merge bzr.dev

Show diffs side-by-side

added added

removed removed

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