← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Martin Pool
  • Date: 2007-03-24 00:06:57 UTC
  • mto: (2323.5.3 0.15)
  • mto: This revision was merged to the branch mainline in revision 2390.
  • Revision ID: mbp@sourcefrog.net-20070324000657-fkotsej7quseardh
prepare rc3

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/builtins.py
 
1
# Copyright (C) 2004, 2005, 2006, 2007 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
import os
 
20
from StringIO import StringIO
 
21
 
 
22
from bzrlib.lazy_import import lazy_import
 
23
lazy_import(globals(), """
 
24
import codecs
 
25
import errno
 
26
import smtplib
 
27
import sys
 
28
import tempfile
 
29
import time
 
30
 
 
31
import bzrlib
 
32
from bzrlib import (
 
33
    branch,
 
34
    bundle,
 
35
    bzrdir,
 
36
    delta,
 
37
    config,
 
38
    errors,
 
39
    globbing,
 
40
    ignores,
 
41
    log,
 
42
    merge as _mod_merge,
 
43
    merge_directive,
 
44
    osutils,
 
45
    registry,
 
46
    repository,
 
47
    symbol_versioning,
 
48
    transport,
 
49
    tree as _mod_tree,
 
50
    ui,
 
51
    urlutils,
 
52
    )
 
53
from bzrlib.branch import Branch
 
54
from bzrlib.bundle.apply_bundle import install_bundle, merge_bundle
 
55
from bzrlib.conflicts import ConflictList
 
56
from bzrlib.revision import common_ancestor
 
57
from bzrlib.revisionspec import RevisionSpec
 
58
from bzrlib.workingtree import WorkingTree
 
59
""")
 
60
 
 
61
from bzrlib.commands import Command, display_command
 
62
from bzrlib.option import Option, RegistryOption
 
63
from bzrlib.progress import DummyProgress, ProgressPhase
 
64
from bzrlib.trace import mutter, note, log_error, warning, is_quiet, info
 
65
 
 
66
 
 
67
def tree_files(file_list, default_branch=u'.'):
 
68
    try:
 
69
        return internal_tree_files(file_list, default_branch)
 
70
    except errors.FileInWrongBranch, e:
 
71
        raise errors.BzrCommandError("%s is not in the same branch as %s" %
 
72
                                     (e.path, file_list[0]))
 
73
 
 
74
 
 
75
# XXX: Bad function name; should possibly also be a class method of
 
76
# WorkingTree rather than a function.
 
77
def internal_tree_files(file_list, default_branch=u'.'):
 
78
    """Convert command-line paths to a WorkingTree and relative paths.
 
79
 
 
80
    This is typically used for command-line processors that take one or
 
81
    more filenames, and infer the workingtree that contains them.
 
82
 
 
83
    The filenames given are not required to exist.
 
84
 
 
85
    :param file_list: Filenames to convert.  
 
86
 
 
87
    :param default_branch: Fallback tree path to use if file_list is empty or
 
88
        None.
 
89
 
 
90
    :return: workingtree, [relative_paths]
 
91
    """
 
92
    if file_list is None or len(file_list) == 0:
 
93
        return WorkingTree.open_containing(default_branch)[0], file_list
 
94
    tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
 
95
    new_list = []
 
96
    for filename in file_list:
 
97
        try:
 
98
            new_list.append(tree.relpath(osutils.dereference_path(filename)))
 
99
        except errors.PathNotChild:
 
100
            raise errors.FileInWrongBranch(tree.branch, filename)
 
101
    return tree, new_list
 
102
 
 
103
 
 
104
@symbol_versioning.deprecated_function(symbol_versioning.zero_fifteen)
 
105
def get_format_type(typestring):
 
106
    """Parse and return a format specifier."""
 
107
    # Have to use BzrDirMetaFormat1 directly, so that
 
108
    # RepositoryFormat.set_default_format works
 
109
    if typestring == "default":
 
110
        return bzrdir.BzrDirMetaFormat1()
 
111
    try:
 
112
        return bzrdir.format_registry.make_bzrdir(typestring)
 
113
    except KeyError:
 
114
        msg = 'Unknown bzr format "%s". See "bzr help formats".' % typestring
 
115
        raise errors.BzrCommandError(msg)
 
116
 
 
117
 
 
118
# TODO: Make sure no commands unconditionally use the working directory as a
 
119
# branch.  If a filename argument is used, the first of them should be used to
 
120
# specify the branch.  (Perhaps this can be factored out into some kind of
 
121
# Argument class, representing a file in a branch, where the first occurrence
 
122
# opens the branch?)
 
123
 
 
124
class cmd_status(Command):
 
125
    """Display status summary.
 
126
 
 
127
    This reports on versioned and unknown files, reporting them
 
128
    grouped by state.  Possible states are:
 
129
 
 
130
    added
 
131
        Versioned in the working copy but not in the previous revision.
 
132
 
 
133
    removed
 
134
        Versioned in the previous revision but removed or deleted
 
135
        in the working copy.
 
136
 
 
137
    renamed
 
138
        Path of this file changed from the previous revision;
 
139
        the text may also have changed.  This includes files whose
 
140
        parent directory was renamed.
 
141
 
 
142
    modified
 
143
        Text has changed since the previous revision.
 
144
 
 
145
    kind changed
 
146
        File kind has been changed (e.g. from file to directory).
 
147
 
 
148
    unknown
 
149
        Not versioned and not matching an ignore pattern.
 
150
 
 
151
    To see ignored files use 'bzr ignored'.  For details in the
 
152
    changes to file texts, use 'bzr diff'.
 
153
    
 
154
    --short gives a status flags for each item, similar to the SVN's status
 
155
    command.
 
156
 
 
157
    Column 1: versioning / renames
 
158
      + File versioned
 
159
      - File unversioned
 
160
      R File renamed
 
161
      ? File unknown
 
162
      C File has conflicts
 
163
      P Entry for a pending merge (not a file)
 
164
 
 
165
    Column 2: Contents
 
166
      N File created
 
167
      D File deleted
 
168
      K File kind changed
 
169
      M File modified
 
170
 
 
171
    Column 3: Execute
 
172
      * The execute bit was changed
 
173
 
 
174
    If no arguments are specified, the status of the entire working
 
175
    directory is shown.  Otherwise, only the status of the specified
 
176
    files or directories is reported.  If a directory is given, status
 
177
    is reported for everything inside that directory.
 
178
 
 
179
    If a revision argument is given, the status is calculated against
 
180
    that revision, or between two revisions if two are provided.
 
181
    """
 
182
    
 
183
    # TODO: --no-recurse, --recurse options
 
184
    
 
185
    takes_args = ['file*']
 
186
    takes_options = ['show-ids', 'revision', 'short',
 
187
                     Option('versioned', help='Only show versioned files')]
 
188
    aliases = ['st', 'stat']
 
189
 
 
190
    encoding_type = 'replace'
 
191
    
 
192
    @display_command
 
193
    def run(self, show_ids=False, file_list=None, revision=None, short=False,
 
194
            versioned=False):
 
195
        from bzrlib.status import show_tree_status
 
196
 
 
197
        tree, file_list = tree_files(file_list)
 
198
            
 
199
        show_tree_status(tree, show_ids=show_ids,
 
200
                         specific_files=file_list, revision=revision,
 
201
                         to_file=self.outf, short=short, versioned=versioned)
 
202
 
 
203
 
 
204
class cmd_cat_revision(Command):
 
205
    """Write out metadata for a revision.
 
206
    
 
207
    The revision to print can either be specified by a specific
 
208
    revision identifier, or you can use --revision.
 
209
    """
 
210
 
 
211
    hidden = True
 
212
    takes_args = ['revision_id?']
 
213
    takes_options = ['revision']
 
214
    # cat-revision is more for frontends so should be exact
 
215
    encoding = 'strict'
 
216
    
 
217
    @display_command
 
218
    def run(self, revision_id=None, revision=None):
 
219
 
 
220
        if revision_id is not None and revision is not None:
 
221
            raise errors.BzrCommandError('You can only supply one of'
 
222
                                         ' revision_id or --revision')
 
223
        if revision_id is None and revision is None:
 
224
            raise errors.BzrCommandError('You must supply either'
 
225
                                         ' --revision or a revision_id')
 
226
        b = WorkingTree.open_containing(u'.')[0].branch
 
227
 
 
228
        # TODO: jam 20060112 should cat-revision always output utf-8?
 
229
        if revision_id is not None:
 
230
            self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
 
231
        elif revision is not None:
 
232
            for rev in revision:
 
233
                if rev is None:
 
234
                    raise errors.BzrCommandError('You cannot specify a NULL'
 
235
                                                 ' revision.')
 
236
                revno, rev_id = rev.in_history(b)
 
237
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
 
238
    
 
239
 
 
240
class cmd_remove_tree(Command):
 
241
    """Remove the working tree from a given branch/checkout.
 
242
 
 
243
    Since a lightweight checkout is little more than a working tree
 
244
    this will refuse to run against one.
 
245
    """
 
246
 
 
247
    takes_args = ['location?']
 
248
 
 
249
    def run(self, location='.'):
 
250
        d = bzrdir.BzrDir.open(location)
 
251
        
 
252
        try:
 
253
            working = d.open_workingtree()
 
254
        except errors.NoWorkingTree:
 
255
            raise errors.BzrCommandError("No working tree to remove")
 
256
        except errors.NotLocalUrl:
 
257
            raise errors.BzrCommandError("You cannot remove the working tree of a "
 
258
                                         "remote path")
 
259
        
 
260
        working_path = working.bzrdir.root_transport.base
 
261
        branch_path = working.branch.bzrdir.root_transport.base
 
262
        if working_path != branch_path:
 
263
            raise errors.BzrCommandError("You cannot remove the working tree from "
 
264
                                         "a lightweight checkout")
 
265
        
 
266
        d.destroy_workingtree()
 
267
        
 
268
 
 
269
class cmd_revno(Command):
 
270
    """Show current revision number.
 
271
 
 
272
    This is equal to the number of revisions on this branch.
 
273
    """
 
274
 
 
275
    takes_args = ['location?']
 
276
 
 
277
    @display_command
 
278
    def run(self, location=u'.'):
 
279
        self.outf.write(str(Branch.open_containing(location)[0].revno()))
 
280
        self.outf.write('\n')
 
281
 
 
282
 
 
283
class cmd_revision_info(Command):
 
284
    """Show revision number and revision id for a given revision identifier.
 
285
    """
 
286
    hidden = True
 
287
    takes_args = ['revision_info*']
 
288
    takes_options = ['revision']
 
289
 
 
290
    @display_command
 
291
    def run(self, revision=None, revision_info_list=[]):
 
292
 
 
293
        revs = []
 
294
        if revision is not None:
 
295
            revs.extend(revision)
 
296
        if revision_info_list is not None:
 
297
            for rev in revision_info_list:
 
298
                revs.append(RevisionSpec.from_string(rev))
 
299
        if len(revs) == 0:
 
300
            raise errors.BzrCommandError('You must supply a revision identifier')
 
301
 
 
302
        b = WorkingTree.open_containing(u'.')[0].branch
 
303
 
 
304
        for rev in revs:
 
305
            revinfo = rev.in_history(b)
 
306
            if revinfo.revno is None:
 
307
                print '     %s' % revinfo.rev_id
 
308
            else:
 
309
                print '%4d %s' % (revinfo.revno, revinfo.rev_id)
 
310
 
 
311
    
 
312
class cmd_add(Command):
 
313
    """Add specified files or directories.
 
314
 
 
315
    In non-recursive mode, all the named items are added, regardless
 
316
    of whether they were previously ignored.  A warning is given if
 
317
    any of the named files are already versioned.
 
318
 
 
319
    In recursive mode (the default), files are treated the same way
 
320
    but the behaviour for directories is different.  Directories that
 
321
    are already versioned do not give a warning.  All directories,
 
322
    whether already versioned or not, are searched for files or
 
323
    subdirectories that are neither versioned or ignored, and these
 
324
    are added.  This search proceeds recursively into versioned
 
325
    directories.  If no names are given '.' is assumed.
 
326
 
 
327
    Therefore simply saying 'bzr add' will version all files that
 
328
    are currently unknown.
 
329
 
 
330
    Adding a file whose parent directory is not versioned will
 
331
    implicitly add the parent, and so on up to the root. This means
 
332
    you should never need to explicitly add a directory, they'll just
 
333
    get added when you add a file in the directory.
 
334
 
 
335
    --dry-run will show which files would be added, but not actually 
 
336
    add them.
 
337
 
 
338
    --file-ids-from will try to use the file ids from the supplied path.
 
339
    It looks up ids trying to find a matching parent directory with the
 
340
    same filename, and then by pure path.
 
341
    """
 
342
    takes_args = ['file*']
 
343
    takes_options = ['no-recurse', 'dry-run', 'verbose',
 
344
                     Option('file-ids-from', type=unicode,
 
345
                            help='Lookup file ids from here')]
 
346
    encoding_type = 'replace'
 
347
 
 
348
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
 
349
            file_ids_from=None):
 
350
        import bzrlib.add
 
351
 
 
352
        base_tree = None
 
353
        if file_ids_from is not None:
 
354
            try:
 
355
                base_tree, base_path = WorkingTree.open_containing(
 
356
                                            file_ids_from)
 
357
            except errors.NoWorkingTree:
 
358
                base_branch, base_path = Branch.open_containing(
 
359
                                            file_ids_from)
 
360
                base_tree = base_branch.basis_tree()
 
361
 
 
362
            action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
 
363
                          to_file=self.outf, should_print=(not is_quiet()))
 
364
        else:
 
365
            action = bzrlib.add.AddAction(to_file=self.outf,
 
366
                should_print=(not is_quiet()))
 
367
 
 
368
        if base_tree:
 
369
            base_tree.lock_read()
 
370
        try:
 
371
            added, ignored = bzrlib.add.smart_add(file_list, not no_recurse,
 
372
                action=action, save=not dry_run)
 
373
        finally:
 
374
            if base_tree is not None:
 
375
                base_tree.unlock()
 
376
        if len(ignored) > 0:
 
377
            if verbose:
 
378
                for glob in sorted(ignored.keys()):
 
379
                    for path in ignored[glob]:
 
380
                        self.outf.write("ignored %s matching \"%s\"\n" 
 
381
                                        % (path, glob))
 
382
            else:
 
383
                match_len = 0
 
384
                for glob, paths in ignored.items():
 
385
                    match_len += len(paths)
 
386
                self.outf.write("ignored %d file(s).\n" % match_len)
 
387
            self.outf.write("If you wish to add some of these files,"
 
388
                            " please add them by name.\n")
 
389
 
 
390
 
 
391
class cmd_mkdir(Command):
 
392
    """Create a new versioned directory.
 
393
 
 
394
    This is equivalent to creating the directory and then adding it.
 
395
    """
 
396
 
 
397
    takes_args = ['dir+']
 
398
    encoding_type = 'replace'
 
399
 
 
400
    def run(self, dir_list):
 
401
        for d in dir_list:
 
402
            os.mkdir(d)
 
403
            wt, dd = WorkingTree.open_containing(d)
 
404
            wt.add([dd])
 
405
            self.outf.write('added %s\n' % d)
 
406
 
 
407
 
 
408
class cmd_relpath(Command):
 
409
    """Show path of a file relative to root"""
 
410
 
 
411
    takes_args = ['filename']
 
412
    hidden = True
 
413
    
 
414
    @display_command
 
415
    def run(self, filename):
 
416
        # TODO: jam 20050106 Can relpath return a munged path if
 
417
        #       sys.stdout encoding cannot represent it?
 
418
        tree, relpath = WorkingTree.open_containing(filename)
 
419
        self.outf.write(relpath)
 
420
        self.outf.write('\n')
 
421
 
 
422
 
 
423
class cmd_inventory(Command):
 
424
    """Show inventory of the current working copy or a revision.
 
425
 
 
426
    It is possible to limit the output to a particular entry
 
427
    type using the --kind option.  For example: --kind file.
 
428
 
 
429
    It is also possible to restrict the list of files to a specific
 
430
    set. For example: bzr inventory --show-ids this/file
 
431
 
 
432
    See also: bzr ls
 
433
    """
 
434
 
 
435
    hidden = True
 
436
 
 
437
    takes_options = ['revision', 'show-ids', 'kind']
 
438
 
 
439
    takes_args = ['file*']
 
440
 
 
441
    @display_command
 
442
    def run(self, revision=None, show_ids=False, kind=None, file_list=None):
 
443
        if kind and kind not in ['file', 'directory', 'symlink']:
 
444
            raise errors.BzrCommandError('invalid kind specified')
 
445
 
 
446
        work_tree, file_list = tree_files(file_list)
 
447
        work_tree.lock_read()
 
448
        try:
 
449
            if revision is not None:
 
450
                if len(revision) > 1:
 
451
                    raise errors.BzrCommandError(
 
452
                        'bzr inventory --revision takes exactly one revision'
 
453
                        ' identifier')
 
454
                revision_id = revision[0].in_history(work_tree.branch).rev_id
 
455
                tree = work_tree.branch.repository.revision_tree(revision_id)
 
456
 
 
457
                extra_trees = [work_tree]
 
458
                tree.lock_read()
 
459
            else:
 
460
                tree = work_tree
 
461
                extra_trees = []
 
462
 
 
463
            if file_list is not None:
 
464
                file_ids = tree.paths2ids(file_list, trees=extra_trees,
 
465
                                          require_versioned=True)
 
466
                # find_ids_across_trees may include some paths that don't
 
467
                # exist in 'tree'.
 
468
                entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
 
469
                                 for file_id in file_ids if file_id in tree)
 
470
            else:
 
471
                entries = tree.inventory.entries()
 
472
        finally:
 
473
            tree.unlock()
 
474
            if tree is not work_tree:
 
475
                work_tree.unlock()
 
476
 
 
477
        for path, entry in entries:
 
478
            if kind and kind != entry.kind:
 
479
                continue
 
480
            if show_ids:
 
481
                self.outf.write('%-50s %s\n' % (path, entry.file_id))
 
482
            else:
 
483
                self.outf.write(path)
 
484
                self.outf.write('\n')
 
485
 
 
486
 
 
487
class cmd_mv(Command):
 
488
    """Move or rename a file.
 
489
 
 
490
    usage:
 
491
        bzr mv OLDNAME NEWNAME
 
492
        bzr mv SOURCE... DESTINATION
 
493
 
 
494
    If the last argument is a versioned directory, all the other names
 
495
    are moved into it.  Otherwise, there must be exactly two arguments
 
496
    and the file is changed to a new name.
 
497
 
 
498
    If OLDNAME does not exist on the filesystem but is versioned and
 
499
    NEWNAME does exist on the filesystem but is not versioned, mv
 
500
    assumes that the file has been manually moved and only updates
 
501
    its internal inventory to reflect that change.
 
502
    The same is valid when moving many SOURCE files to a DESTINATION.
 
503
 
 
504
    Files cannot be moved between branches.
 
505
    """
 
506
 
 
507
    takes_args = ['names*']
 
508
    takes_options = [Option("after", help="move only the bzr identifier"
 
509
        " of the file (file has already been moved). Use this flag if"
 
510
        " bzr is not able to detect this itself.")]
 
511
    aliases = ['move', 'rename']
 
512
    encoding_type = 'replace'
 
513
 
 
514
    def run(self, names_list, after=False):
 
515
        if names_list is None:
 
516
            names_list = []
 
517
 
 
518
        if len(names_list) < 2:
 
519
            raise errors.BzrCommandError("missing file argument")
 
520
        tree, rel_names = tree_files(names_list)
 
521
        
 
522
        if os.path.isdir(names_list[-1]):
 
523
            # move into existing directory
 
524
            for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
 
525
                self.outf.write("%s => %s\n" % pair)
 
526
        else:
 
527
            if len(names_list) != 2:
 
528
                raise errors.BzrCommandError('to mv multiple files the'
 
529
                                             ' destination must be a versioned'
 
530
                                             ' directory')
 
531
            tree.rename_one(rel_names[0], rel_names[1], after=after)
 
532
            self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
 
533
            
 
534
    
 
535
class cmd_pull(Command):
 
536
    """Turn this branch into a mirror of another branch.
 
537
 
 
538
    This command only works on branches that have not diverged.  Branches are
 
539
    considered diverged if the destination branch's most recent commit is one
 
540
    that has not been merged (directly or indirectly) into the parent.
 
541
 
 
542
    If branches have diverged, you can use 'bzr merge' to integrate the changes
 
543
    from one into the other.  Once one branch has merged, the other should
 
544
    be able to pull it again.
 
545
 
 
546
    If you want to forget your local changes and just update your branch to
 
547
    match the remote one, use pull --overwrite.
 
548
 
 
549
    If there is no default location set, the first pull will set it.  After
 
550
    that, you can omit the location to use the default.  To change the
 
551
    default, use --remember. The value will only be saved if the remote
 
552
    location can be accessed.
 
553
    """
 
554
 
 
555
    takes_options = ['remember', 'overwrite', 'revision', 'verbose',
 
556
        Option('directory',
 
557
            help='branch to pull into, '
 
558
                 'rather than the one containing the working directory',
 
559
            short_name='d',
 
560
            type=unicode,
 
561
            ),
 
562
        ]
 
563
    takes_args = ['location?']
 
564
    encoding_type = 'replace'
 
565
 
 
566
    def run(self, location=None, remember=False, overwrite=False,
 
567
            revision=None, verbose=False,
 
568
            directory=None):
 
569
        from bzrlib.tag import _merge_tags_if_possible
 
570
        # FIXME: too much stuff is in the command class
 
571
        if directory is None:
 
572
            directory = u'.'
 
573
        try:
 
574
            tree_to = WorkingTree.open_containing(directory)[0]
 
575
            branch_to = tree_to.branch
 
576
        except errors.NoWorkingTree:
 
577
            tree_to = None
 
578
            branch_to = Branch.open_containing(directory)[0]
 
579
 
 
580
        reader = None
 
581
        if location is not None:
 
582
            try:
 
583
                reader = bundle.read_bundle_from_url(location)
 
584
            except errors.NotABundle:
 
585
                pass # Continue on considering this url a Branch
 
586
 
 
587
        stored_loc = branch_to.get_parent()
 
588
        if location is None:
 
589
            if stored_loc is None:
 
590
                raise errors.BzrCommandError("No pull location known or"
 
591
                                             " specified.")
 
592
            else:
 
593
                display_url = urlutils.unescape_for_display(stored_loc,
 
594
                        self.outf.encoding)
 
595
                self.outf.write("Using saved location: %s\n" % display_url)
 
596
                location = stored_loc
 
597
 
 
598
        if reader is not None:
 
599
            install_bundle(branch_to.repository, reader)
 
600
            branch_from = branch_to
 
601
        else:
 
602
            branch_from = Branch.open(location)
 
603
 
 
604
            if branch_to.get_parent() is None or remember:
 
605
                branch_to.set_parent(branch_from.base)
 
606
 
 
607
        rev_id = None
 
608
        if revision is None:
 
609
            if reader is not None:
 
610
                rev_id = reader.target
 
611
        elif len(revision) == 1:
 
612
            rev_id = revision[0].in_history(branch_from).rev_id
 
613
        else:
 
614
            raise errors.BzrCommandError('bzr pull --revision takes one value.')
 
615
 
 
616
        old_rh = branch_to.revision_history()
 
617
        if tree_to is not None:
 
618
            result = tree_to.pull(branch_from, overwrite, rev_id,
 
619
                delta._ChangeReporter(unversioned_filter=tree_to.is_ignored))
 
620
        else:
 
621
            result = branch_to.pull(branch_from, overwrite, rev_id)
 
622
 
 
623
        result.report(self.outf)
 
624
        if verbose:
 
625
            from bzrlib.log import show_changed_revisions
 
626
            new_rh = branch_to.revision_history()
 
627
            show_changed_revisions(branch_to, old_rh, new_rh, to_file=self.outf)
 
628
 
 
629
 
 
630
class cmd_push(Command):
 
631
    """Update a mirror of this branch.
 
632
    
 
633
    The target branch will not have its working tree populated because this
 
634
    is both expensive, and is not supported on remote file systems.
 
635
    
 
636
    Some smart servers or protocols *may* put the working tree in place in
 
637
    the future.
 
638
 
 
639
    This command only works on branches that have not diverged.  Branches are
 
640
    considered diverged if the destination branch's most recent commit is one
 
641
    that has not been merged (directly or indirectly) by the source branch.
 
642
 
 
643
    If branches have diverged, you can use 'bzr push --overwrite' to replace
 
644
    the other branch completely, discarding its unmerged changes.
 
645
    
 
646
    If you want to ensure you have the different changes in the other branch,
 
647
    do a merge (see bzr help merge) from the other branch, and commit that.
 
648
    After that you will be able to do a push without '--overwrite'.
 
649
 
 
650
    If there is no default push location set, the first push will set it.
 
651
    After that, you can omit the location to use the default.  To change the
 
652
    default, use --remember. The value will only be saved if the remote
 
653
    location can be accessed.
 
654
    """
 
655
 
 
656
    takes_options = ['remember', 'overwrite', 'verbose',
 
657
        Option('create-prefix',
 
658
               help='Create the path leading up to the branch '
 
659
                    'if it does not already exist'),
 
660
        Option('directory',
 
661
            help='branch to push from, '
 
662
                 'rather than the one containing the working directory',
 
663
            short_name='d',
 
664
            type=unicode,
 
665
            ),
 
666
        Option('use-existing-dir',
 
667
               help='By default push will fail if the target'
 
668
                    ' directory exists, but does not already'
 
669
                    ' have a control directory. This flag will'
 
670
                    ' allow push to proceed.'),
 
671
        ]
 
672
    takes_args = ['location?']
 
673
    encoding_type = 'replace'
 
674
 
 
675
    def run(self, location=None, remember=False, overwrite=False,
 
676
            create_prefix=False, verbose=False,
 
677
            use_existing_dir=False,
 
678
            directory=None):
 
679
        # FIXME: Way too big!  Put this into a function called from the
 
680
        # command.
 
681
        if directory is None:
 
682
            directory = '.'
 
683
        br_from = Branch.open_containing(directory)[0]
 
684
        stored_loc = br_from.get_push_location()
 
685
        if location is None:
 
686
            if stored_loc is None:
 
687
                raise errors.BzrCommandError("No push location known or specified.")
 
688
            else:
 
689
                display_url = urlutils.unescape_for_display(stored_loc,
 
690
                        self.outf.encoding)
 
691
                self.outf.write("Using saved location: %s\n" % display_url)
 
692
                location = stored_loc
 
693
 
 
694
        to_transport = transport.get_transport(location)
 
695
        location_url = to_transport.base
 
696
 
 
697
        br_to = repository_to = dir_to = None
 
698
        try:
 
699
            dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
 
700
        except errors.NotBranchError:
 
701
            pass # Didn't find anything
 
702
        else:
 
703
            # If we can open a branch, use its direct repository, otherwise see
 
704
            # if there is a repository without a branch.
 
705
            try:
 
706
                br_to = dir_to.open_branch()
 
707
            except errors.NotBranchError:
 
708
                # Didn't find a branch, can we find a repository?
 
709
                try:
 
710
                    repository_to = dir_to.find_repository()
 
711
                except errors.NoRepositoryPresent:
 
712
                    pass
 
713
            else:
 
714
                # Found a branch, so we must have found a repository
 
715
                repository_to = br_to.repository
 
716
        push_result = None
 
717
        old_rh = []
 
718
        if dir_to is None:
 
719
            # The destination doesn't exist; create it.
 
720
            # XXX: Refactor the create_prefix/no_create_prefix code into a
 
721
            #      common helper function
 
722
            try:
 
723
                to_transport.mkdir('.')
 
724
            except errors.FileExists:
 
725
                if not use_existing_dir:
 
726
                    raise errors.BzrCommandError("Target directory %s"
 
727
                         " already exists, but does not have a valid .bzr"
 
728
                         " directory. Supply --use-existing-dir to push"
 
729
                         " there anyway." % location)
 
730
            except errors.NoSuchFile:
 
731
                if not create_prefix:
 
732
                    raise errors.BzrCommandError("Parent directory of %s"
 
733
                        " does not exist."
 
734
                        "\nYou may supply --create-prefix to create all"
 
735
                        " leading parent directories."
 
736
                        % location)
 
737
 
 
738
                cur_transport = to_transport
 
739
                needed = [cur_transport]
 
740
                # Recurse upwards until we can create a directory successfully
 
741
                while True:
 
742
                    new_transport = cur_transport.clone('..')
 
743
                    if new_transport.base == cur_transport.base:
 
744
                        raise errors.BzrCommandError("Failed to create path"
 
745
                                                     " prefix for %s."
 
746
                                                     % location)
 
747
                    try:
 
748
                        new_transport.mkdir('.')
 
749
                    except errors.NoSuchFile:
 
750
                        needed.append(new_transport)
 
751
                        cur_transport = new_transport
 
752
                    else:
 
753
                        break
 
754
 
 
755
                # Now we only need to create child directories
 
756
                while needed:
 
757
                    cur_transport = needed.pop()
 
758
                    cur_transport.mkdir('.')
 
759
            
 
760
            # Now the target directory exists, but doesn't have a .bzr
 
761
            # directory. So we need to create it, along with any work to create
 
762
            # all of the dependent branches, etc.
 
763
            dir_to = br_from.bzrdir.clone(location_url,
 
764
                revision_id=br_from.last_revision())
 
765
            br_to = dir_to.open_branch()
 
766
            # TODO: Some more useful message about what was copied
 
767
            note('Created new branch.')
 
768
            # We successfully created the target, remember it
 
769
            if br_from.get_push_location() is None or remember:
 
770
                br_from.set_push_location(br_to.base)
 
771
        elif repository_to is None:
 
772
            # we have a bzrdir but no branch or repository
 
773
            # XXX: Figure out what to do other than complain.
 
774
            raise errors.BzrCommandError("At %s you have a valid .bzr control"
 
775
                " directory, but not a branch or repository. This is an"
 
776
                " unsupported configuration. Please move the target directory"
 
777
                " out of the way and try again."
 
778
                % location)
 
779
        elif br_to is None:
 
780
            # We have a repository but no branch, copy the revisions, and then
 
781
            # create a branch.
 
782
            last_revision_id = br_from.last_revision()
 
783
            repository_to.fetch(br_from.repository,
 
784
                                revision_id=last_revision_id)
 
785
            br_to = br_from.clone(dir_to, revision_id=last_revision_id)
 
786
            note('Created new branch.')
 
787
            if br_from.get_push_location() is None or remember:
 
788
                br_from.set_push_location(br_to.base)
 
789
        else: # We have a valid to branch
 
790
            # We were able to connect to the remote location, so remember it
 
791
            # we don't need to successfully push because of possible divergence.
 
792
            if br_from.get_push_location() is None or remember:
 
793
                br_from.set_push_location(br_to.base)
 
794
            old_rh = br_to.revision_history()
 
795
            try:
 
796
                try:
 
797
                    tree_to = dir_to.open_workingtree()
 
798
                except errors.NotLocalUrl:
 
799
                    warning('This transport does not update the working '
 
800
                            'tree of: %s' % (br_to.base,))
 
801
                    push_result = br_from.push(br_to, overwrite)
 
802
                except errors.NoWorkingTree:
 
803
                    push_result = br_from.push(br_to, overwrite)
 
804
                else:
 
805
                    tree_to.lock_write()
 
806
                    try:
 
807
                        push_result = br_from.push(tree_to.branch, overwrite)
 
808
                        tree_to.update()
 
809
                    finally:
 
810
                        tree_to.unlock()
 
811
            except errors.DivergedBranches:
 
812
                raise errors.BzrCommandError('These branches have diverged.'
 
813
                                        '  Try using "merge" and then "push".')
 
814
        if push_result is not None:
 
815
            push_result.report(self.outf)
 
816
        elif verbose:
 
817
            new_rh = br_to.revision_history()
 
818
            if old_rh != new_rh:
 
819
                # Something changed
 
820
                from bzrlib.log import show_changed_revisions
 
821
                show_changed_revisions(br_to, old_rh, new_rh,
 
822
                                       to_file=self.outf)
 
823
        else:
 
824
            # we probably did a clone rather than a push, so a message was
 
825
            # emitted above
 
826
            pass
 
827
 
 
828
 
 
829
class cmd_branch(Command):
 
830
    """Create a new copy of a branch.
 
831
 
 
832
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
 
833
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
 
834
 
 
835
    To retrieve the branch as of a particular revision, supply the --revision
 
836
    parameter, as in "branch foo/bar -r 5".
 
837
 
 
838
    --basis is to speed up branching from remote branches.  When specified, it
 
839
    copies all the file-contents, inventory and revision data from the basis
 
840
    branch before copying anything from the remote branch.
 
841
    """
 
842
    takes_args = ['from_location', 'to_location?']
 
843
    takes_options = ['revision', 'basis']
 
844
    aliases = ['get', 'clone']
 
845
 
 
846
    def run(self, from_location, to_location=None, revision=None, basis=None):
 
847
        from bzrlib.tag import _merge_tags_if_possible
 
848
        if revision is None:
 
849
            revision = [None]
 
850
        elif len(revision) > 1:
 
851
            raise errors.BzrCommandError(
 
852
                'bzr branch --revision takes exactly 1 revision value')
 
853
 
 
854
        br_from = Branch.open(from_location)
 
855
        br_from.lock_read()
 
856
        try:
 
857
            if basis is not None:
 
858
                basis_dir = bzrdir.BzrDir.open_containing(basis)[0]
 
859
            else:
 
860
                basis_dir = None
 
861
            if len(revision) == 1 and revision[0] is not None:
 
862
                revision_id = revision[0].in_history(br_from)[1]
 
863
            else:
 
864
                # FIXME - wt.last_revision, fallback to branch, fall back to
 
865
                # None or perhaps NULL_REVISION to mean copy nothing
 
866
                # RBC 20060209
 
867
                revision_id = br_from.last_revision()
 
868
            if to_location is None:
 
869
                to_location = os.path.basename(from_location.rstrip("/\\"))
 
870
                name = None
 
871
            else:
 
872
                name = os.path.basename(to_location) + '\n'
 
873
 
 
874
            to_transport = transport.get_transport(to_location)
 
875
            try:
 
876
                to_transport.mkdir('.')
 
877
            except errors.FileExists:
 
878
                raise errors.BzrCommandError('Target directory "%s" already'
 
879
                                             ' exists.' % to_location)
 
880
            except errors.NoSuchFile:
 
881
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
 
882
                                             % to_location)
 
883
            try:
 
884
                # preserve whatever source format we have.
 
885
                dir = br_from.bzrdir.sprout(to_transport.base,
 
886
                        revision_id, basis_dir)
 
887
                branch = dir.open_branch()
 
888
            except errors.NoSuchRevision:
 
889
                to_transport.delete_tree('.')
 
890
                msg = "The branch %s has no revision %s." % (from_location, revision[0])
 
891
                raise errors.BzrCommandError(msg)
 
892
            except errors.UnlistableBranch:
 
893
                osutils.rmtree(to_location)
 
894
                msg = "The branch %s cannot be used as a --basis" % (basis,)
 
895
                raise errors.BzrCommandError(msg)
 
896
            if name:
 
897
                branch.control_files.put_utf8('branch-name', name)
 
898
            _merge_tags_if_possible(br_from, branch)
 
899
            note('Branched %d revision(s).' % branch.revno())
 
900
        finally:
 
901
            br_from.unlock()
 
902
 
 
903
 
 
904
class cmd_checkout(Command):
 
905
    """Create a new checkout of an existing branch.
 
906
 
 
907
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
 
908
    the branch found in '.'. This is useful if you have removed the working tree
 
909
    or if it was never created - i.e. if you pushed the branch to its current
 
910
    location using SFTP.
 
911
    
 
912
    If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
 
913
    be used.  In other words, "checkout ../foo/bar" will attempt to create ./bar.
 
914
 
 
915
    To retrieve the branch as of a particular revision, supply the --revision
 
916
    parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
 
917
    out of date [so you cannot commit] but it may be useful (i.e. to examine old
 
918
    code.)
 
919
 
 
920
    --basis is to speed up checking out from remote branches.  When specified, it
 
921
    uses the inventory and file contents from the basis branch in preference to the
 
922
    branch being checked out.
 
923
 
 
924
    See "help checkouts" for more information on checkouts.
 
925
    """
 
926
    takes_args = ['branch_location?', 'to_location?']
 
927
    takes_options = ['revision', # , 'basis']
 
928
                     Option('lightweight',
 
929
                            help="perform a lightweight checkout. Lightweight "
 
930
                                 "checkouts depend on access to the branch for "
 
931
                                 "every operation. Normal checkouts can perform "
 
932
                                 "common operations like diff and status without "
 
933
                                 "such access, and also support local commits."
 
934
                            ),
 
935
                     ]
 
936
    aliases = ['co']
 
937
 
 
938
    def run(self, branch_location=None, to_location=None, revision=None, basis=None,
 
939
            lightweight=False):
 
940
        if revision is None:
 
941
            revision = [None]
 
942
        elif len(revision) > 1:
 
943
            raise errors.BzrCommandError(
 
944
                'bzr checkout --revision takes exactly 1 revision value')
 
945
        if branch_location is None:
 
946
            branch_location = osutils.getcwd()
 
947
            to_location = branch_location
 
948
        source = Branch.open(branch_location)
 
949
        if len(revision) == 1 and revision[0] is not None:
 
950
            revision_id = revision[0].in_history(source)[1]
 
951
        else:
 
952
            revision_id = None
 
953
        if to_location is None:
 
954
            to_location = os.path.basename(branch_location.rstrip("/\\"))
 
955
        # if the source and to_location are the same, 
 
956
        # and there is no working tree,
 
957
        # then reconstitute a branch
 
958
        if (osutils.abspath(to_location) ==
 
959
            osutils.abspath(branch_location)):
 
960
            try:
 
961
                source.bzrdir.open_workingtree()
 
962
            except errors.NoWorkingTree:
 
963
                source.bzrdir.create_workingtree()
 
964
                return
 
965
        try:
 
966
            os.mkdir(to_location)
 
967
        except OSError, e:
 
968
            if e.errno == errno.EEXIST:
 
969
                raise errors.BzrCommandError('Target directory "%s" already'
 
970
                                             ' exists.' % to_location)
 
971
            if e.errno == errno.ENOENT:
 
972
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
 
973
                                             % to_location)
 
974
            else:
 
975
                raise
 
976
        source.create_checkout(to_location, revision_id, lightweight)
 
977
 
 
978
 
 
979
class cmd_renames(Command):
 
980
    """Show list of renamed files.
 
981
    """
 
982
    # TODO: Option to show renames between two historical versions.
 
983
 
 
984
    # TODO: Only show renames under dir, rather than in the whole branch.
 
985
    takes_args = ['dir?']
 
986
 
 
987
    @display_command
 
988
    def run(self, dir=u'.'):
 
989
        tree = WorkingTree.open_containing(dir)[0]
 
990
        tree.lock_read()
 
991
        try:
 
992
            new_inv = tree.inventory
 
993
            old_tree = tree.basis_tree()
 
994
            old_tree.lock_read()
 
995
            try:
 
996
                old_inv = old_tree.inventory
 
997
                renames = list(_mod_tree.find_renames(old_inv, new_inv))
 
998
                renames.sort()
 
999
                for old_name, new_name in renames:
 
1000
                    self.outf.write("%s => %s\n" % (old_name, new_name))
 
1001
            finally:
 
1002
                old_tree.unlock()
 
1003
        finally:
 
1004
            tree.unlock()
 
1005
 
 
1006
 
 
1007
class cmd_update(Command):
 
1008
    """Update a tree to have the latest code committed to its branch.
 
1009
    
 
1010
    This will perform a merge into the working tree, and may generate
 
1011
    conflicts. If you have any local changes, you will still 
 
1012
    need to commit them after the update for the update to be complete.
 
1013
    
 
1014
    If you want to discard your local changes, you can just do a 
 
1015
    'bzr revert' instead of 'bzr commit' after the update.
 
1016
    """
 
1017
    takes_args = ['dir?']
 
1018
    aliases = ['up']
 
1019
 
 
1020
    def run(self, dir='.'):
 
1021
        tree = WorkingTree.open_containing(dir)[0]
 
1022
        master = tree.branch.get_master_branch()
 
1023
        if master is not None:
 
1024
            tree.lock_write()
 
1025
        else:
 
1026
            tree.lock_tree_write()
 
1027
        try:
 
1028
            existing_pending_merges = tree.get_parent_ids()[1:]
 
1029
            last_rev = tree.last_revision()
 
1030
            if last_rev == tree.branch.last_revision():
 
1031
                # may be up to date, check master too.
 
1032
                master = tree.branch.get_master_branch()
 
1033
                if master is None or last_rev == master.last_revision():
 
1034
                    revno = tree.branch.revision_id_to_revno(last_rev)
 
1035
                    note("Tree is up to date at revision %d." % (revno,))
 
1036
                    return 0
 
1037
            conflicts = tree.update()
 
1038
            revno = tree.branch.revision_id_to_revno(tree.last_revision())
 
1039
            note('Updated to revision %d.' % (revno,))
 
1040
            if tree.get_parent_ids()[1:] != existing_pending_merges:
 
1041
                note('Your local commits will now show as pending merges with '
 
1042
                     "'bzr status', and can be committed with 'bzr commit'.")
 
1043
            if conflicts != 0:
 
1044
                return 1
 
1045
            else:
 
1046
                return 0
 
1047
        finally:
 
1048
            tree.unlock()
 
1049
 
 
1050
 
 
1051
class cmd_info(Command):
 
1052
    """Show information about a working tree, branch or repository.
 
1053
 
 
1054
    This command will show all known locations and formats associated to the
 
1055
    tree, branch or repository.  Statistical information is included with
 
1056
    each report.
 
1057
 
 
1058
    Branches and working trees will also report any missing revisions.
 
1059
    """
 
1060
    takes_args = ['location?']
 
1061
    takes_options = ['verbose']
 
1062
 
 
1063
    @display_command
 
1064
    def run(self, location=None, verbose=False):
 
1065
        from bzrlib.info import show_bzrdir_info
 
1066
        show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
 
1067
                         verbose=verbose)
 
1068
 
 
1069
 
 
1070
class cmd_remove(Command):
 
1071
    """Make a file unversioned.
 
1072
 
 
1073
    This makes bzr stop tracking changes to a versioned file.  It does
 
1074
    not delete the working copy.
 
1075
 
 
1076
    You can specify one or more files, and/or --new.  If you specify --new,
 
1077
    only 'added' files will be removed.  If you specify both, then new files
 
1078
    in the specified directories will be removed.  If the directories are
 
1079
    also new, they will also be removed.
 
1080
    """
 
1081
    takes_args = ['file*']
 
1082
    takes_options = ['verbose', Option('new', help='remove newly-added files')]
 
1083
    aliases = ['rm']
 
1084
    encoding_type = 'replace'
 
1085
    
 
1086
    def run(self, file_list, verbose=False, new=False):
 
1087
        tree, file_list = tree_files(file_list)
 
1088
        if new is False:
 
1089
            if file_list is None:
 
1090
                raise errors.BzrCommandError('Specify one or more files to'
 
1091
                                             ' remove, or use --new.')
 
1092
        else:
 
1093
            added = tree.changes_from(tree.basis_tree(),
 
1094
                specific_files=file_list).added
 
1095
            file_list = sorted([f[0] for f in added], reverse=True)
 
1096
            if len(file_list) == 0:
 
1097
                raise errors.BzrCommandError('No matching files.')
 
1098
        tree.remove(file_list, verbose=verbose, to_file=self.outf)
 
1099
 
 
1100
 
 
1101
class cmd_file_id(Command):
 
1102
    """Print file_id of a particular file or directory.
 
1103
 
 
1104
    The file_id is assigned when the file is first added and remains the
 
1105
    same through all revisions where the file exists, even when it is
 
1106
    moved or renamed.
 
1107
    """
 
1108
 
 
1109
    hidden = True
 
1110
    takes_args = ['filename']
 
1111
 
 
1112
    @display_command
 
1113
    def run(self, filename):
 
1114
        tree, relpath = WorkingTree.open_containing(filename)
 
1115
        i = tree.path2id(relpath)
 
1116
        if i is None:
 
1117
            raise errors.NotVersionedError(filename)
 
1118
        else:
 
1119
            self.outf.write(i + '\n')
 
1120
 
 
1121
 
 
1122
class cmd_file_path(Command):
 
1123
    """Print path of file_ids to a file or directory.
 
1124
 
 
1125
    This prints one line for each directory down to the target,
 
1126
    starting at the branch root.
 
1127
    """
 
1128
 
 
1129
    hidden = True
 
1130
    takes_args = ['filename']
 
1131
 
 
1132
    @display_command
 
1133
    def run(self, filename):
 
1134
        tree, relpath = WorkingTree.open_containing(filename)
 
1135
        fid = tree.path2id(relpath)
 
1136
        if fid is None:
 
1137
            raise errors.NotVersionedError(filename)
 
1138
        segments = osutils.splitpath(relpath)
 
1139
        for pos in range(1, len(segments) + 1):
 
1140
            path = osutils.joinpath(segments[:pos])
 
1141
            self.outf.write("%s\n" % tree.path2id(path))
 
1142
 
 
1143
 
 
1144
class cmd_reconcile(Command):
 
1145
    """Reconcile bzr metadata in a branch.
 
1146
 
 
1147
    This can correct data mismatches that may have been caused by
 
1148
    previous ghost operations or bzr upgrades. You should only
 
1149
    need to run this command if 'bzr check' or a bzr developer 
 
1150
    advises you to run it.
 
1151
 
 
1152
    If a second branch is provided, cross-branch reconciliation is
 
1153
    also attempted, which will check that data like the tree root
 
1154
    id which was not present in very early bzr versions is represented
 
1155
    correctly in both branches.
 
1156
 
 
1157
    At the same time it is run it may recompress data resulting in 
 
1158
    a potential saving in disk space or performance gain.
 
1159
 
 
1160
    The branch *MUST* be on a listable system such as local disk or sftp.
 
1161
    """
 
1162
    takes_args = ['branch?']
 
1163
 
 
1164
    def run(self, branch="."):
 
1165
        from bzrlib.reconcile import reconcile
 
1166
        dir = bzrdir.BzrDir.open(branch)
 
1167
        reconcile(dir)
 
1168
 
 
1169
 
 
1170
class cmd_revision_history(Command):
 
1171
    """Display the list of revision ids on a branch."""
 
1172
    takes_args = ['location?']
 
1173
 
 
1174
    hidden = True
 
1175
 
 
1176
    @display_command
 
1177
    def run(self, location="."):
 
1178
        branch = Branch.open_containing(location)[0]
 
1179
        for revid in branch.revision_history():
 
1180
            self.outf.write(revid)
 
1181
            self.outf.write('\n')
 
1182
 
 
1183
 
 
1184
class cmd_ancestry(Command):
 
1185
    """List all revisions merged into this branch."""
 
1186
    takes_args = ['location?']
 
1187
 
 
1188
    hidden = True
 
1189
 
 
1190
    @display_command
 
1191
    def run(self, location="."):
 
1192
        try:
 
1193
            wt = WorkingTree.open_containing(location)[0]
 
1194
        except errors.NoWorkingTree:
 
1195
            b = Branch.open(location)
 
1196
            last_revision = b.last_revision()
 
1197
        else:
 
1198
            b = wt.branch
 
1199
            last_revision = wt.last_revision()
 
1200
 
 
1201
        revision_ids = b.repository.get_ancestry(last_revision)
 
1202
        assert revision_ids[0] is None
 
1203
        revision_ids.pop(0)
 
1204
        for revision_id in revision_ids:
 
1205
            self.outf.write(revision_id + '\n')
 
1206
 
 
1207
 
 
1208
class cmd_init(Command):
 
1209
    """Make a directory into a versioned branch.
 
1210
 
 
1211
    Use this to create an empty branch, or before importing an
 
1212
    existing project.
 
1213
 
 
1214
    If there is a repository in a parent directory of the location, then 
 
1215
    the history of the branch will be stored in the repository.  Otherwise
 
1216
    init creates a standalone branch which carries its own history in 
 
1217
    .bzr.
 
1218
 
 
1219
    If there is already a branch at the location but it has no working tree,
 
1220
    the tree can be populated with 'bzr checkout'.
 
1221
 
 
1222
    Recipe for importing a tree of files:
 
1223
        cd ~/project
 
1224
        bzr init
 
1225
        bzr add .
 
1226
        bzr status
 
1227
        bzr commit -m 'imported project'
 
1228
    """
 
1229
    takes_args = ['location?']
 
1230
    takes_options = [
 
1231
         RegistryOption('format',
 
1232
                help='Specify a format for this branch. '
 
1233
                'See "help formats".',
 
1234
                registry=bzrdir.format_registry,
 
1235
                converter=bzrdir.format_registry.make_bzrdir,
 
1236
                value_switches=True,
 
1237
                title="Branch Format",
 
1238
                ),
 
1239
         Option('append-revisions-only',
 
1240
                help='Never change revnos or the existing log.'
 
1241
                '  Append revisions to it only.')
 
1242
         ]
 
1243
    def run(self, location=None, format=None, append_revisions_only=False):
 
1244
        if format is None:
 
1245
            format = bzrdir.format_registry.make_bzrdir('default')
 
1246
        if location is None:
 
1247
            location = u'.'
 
1248
 
 
1249
        to_transport = transport.get_transport(location)
 
1250
 
 
1251
        # The path has to exist to initialize a
 
1252
        # branch inside of it.
 
1253
        # Just using os.mkdir, since I don't
 
1254
        # believe that we want to create a bunch of
 
1255
        # locations if the user supplies an extended path
 
1256
        # TODO: create-prefix
 
1257
        try:
 
1258
            to_transport.mkdir('.')
 
1259
        except errors.FileExists:
 
1260
            pass
 
1261
                    
 
1262
        try:
 
1263
            existing_bzrdir = bzrdir.BzrDir.open(location)
 
1264
        except errors.NotBranchError:
 
1265
            # really a NotBzrDir error...
 
1266
            branch = bzrdir.BzrDir.create_branch_convenience(to_transport.base,
 
1267
                                                             format=format)
 
1268
        else:
 
1269
            from bzrlib.transport.local import LocalTransport
 
1270
            if existing_bzrdir.has_branch():
 
1271
                if (isinstance(to_transport, LocalTransport)
 
1272
                    and not existing_bzrdir.has_workingtree()):
 
1273
                        raise errors.BranchExistsWithoutWorkingTree(location)
 
1274
                raise errors.AlreadyBranchError(location)
 
1275
            else:
 
1276
                branch = existing_bzrdir.create_branch()
 
1277
                existing_bzrdir.create_workingtree()
 
1278
        if append_revisions_only:
 
1279
            try:
 
1280
                branch.set_append_revisions_only(True)
 
1281
            except errors.UpgradeRequired:
 
1282
                raise errors.BzrCommandError('This branch format cannot be set'
 
1283
                    ' to append-revisions-only.  Try --experimental-branch6')
 
1284
 
 
1285
 
 
1286
class cmd_init_repository(Command):
 
1287
    """Create a shared repository to hold branches.
 
1288
 
 
1289
    New branches created under the repository directory will store their revisions
 
1290
    in the repository, not in the branch directory.
 
1291
 
 
1292
    example:
 
1293
        bzr init-repo --no-trees repo
 
1294
        bzr init repo/trunk
 
1295
        bzr checkout --lightweight repo/trunk trunk-checkout
 
1296
        cd trunk-checkout
 
1297
        (add files here)
 
1298
    """
 
1299
 
 
1300
    takes_args = ["location"]
 
1301
    takes_options = [RegistryOption('format',
 
1302
                            help='Specify a format for this repository. See'
 
1303
                                 ' "bzr help formats" for details',
 
1304
                            registry=bzrdir.format_registry,
 
1305
                            converter=bzrdir.format_registry.make_bzrdir,
 
1306
                            value_switches=True, title='Repository format'),
 
1307
                     Option('no-trees',
 
1308
                             help='Branches in the repository will default to'
 
1309
                                  ' not having a working tree'),
 
1310
                    ]
 
1311
    aliases = ["init-repo"]
 
1312
 
 
1313
    def run(self, location, format=None, no_trees=False):
 
1314
        if format is None:
 
1315
            format = bzrdir.format_registry.make_bzrdir('default')
 
1316
 
 
1317
        if location is None:
 
1318
            location = '.'
 
1319
 
 
1320
        to_transport = transport.get_transport(location)
 
1321
        try:
 
1322
            to_transport.mkdir('.')
 
1323
        except errors.FileExists:
 
1324
            pass
 
1325
 
 
1326
        newdir = format.initialize_on_transport(to_transport)
 
1327
        repo = newdir.create_repository(shared=True)
 
1328
        repo.set_make_working_trees(not no_trees)
 
1329
 
 
1330
 
 
1331
class cmd_diff(Command):
 
1332
    """Show differences in the working tree or between revisions.
 
1333
    
 
1334
    If files are listed, only the changes in those files are listed.
 
1335
    Otherwise, all changes for the tree are listed.
 
1336
 
 
1337
    "bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
 
1338
    produces patches suitable for "patch -p1".
 
1339
 
 
1340
    examples:
 
1341
        bzr diff
 
1342
            Shows the difference in the working tree versus the last commit
 
1343
        bzr diff -r1
 
1344
            Difference between the working tree and revision 1
 
1345
        bzr diff -r1..2
 
1346
            Difference between revision 2 and revision 1
 
1347
        bzr diff --prefix old/:new/
 
1348
            Same as 'bzr diff' but prefix paths with old/ and new/
 
1349
        bzr diff bzr.mine bzr.dev
 
1350
            Show the differences between the two working trees
 
1351
        bzr diff foo.c
 
1352
            Show just the differences for 'foo.c'
 
1353
    """
 
1354
    # TODO: Option to use external diff command; could be GNU diff, wdiff,
 
1355
    #       or a graphical diff.
 
1356
 
 
1357
    # TODO: Python difflib is not exactly the same as unidiff; should
 
1358
    #       either fix it up or prefer to use an external diff.
 
1359
 
 
1360
    # TODO: Selected-file diff is inefficient and doesn't show you
 
1361
    #       deleted files.
 
1362
 
 
1363
    # TODO: This probably handles non-Unix newlines poorly.
 
1364
 
 
1365
    takes_args = ['file*']
 
1366
    takes_options = ['revision', 'diff-options',
 
1367
        Option('prefix', type=str,
 
1368
               short_name='p',
 
1369
               help='Set prefixes to added to old and new filenames, as '
 
1370
                    'two values separated by a colon. (eg "old/:new/")'),
 
1371
        ]
 
1372
    aliases = ['di', 'dif']
 
1373
    encoding_type = 'exact'
 
1374
 
 
1375
    @display_command
 
1376
    def run(self, revision=None, file_list=None, diff_options=None,
 
1377
            prefix=None):
 
1378
        from bzrlib.diff import diff_cmd_helper, show_diff_trees
 
1379
 
 
1380
        if (prefix is None) or (prefix == '0'):
 
1381
            # diff -p0 format
 
1382
            old_label = ''
 
1383
            new_label = ''
 
1384
        elif prefix == '1':
 
1385
            old_label = 'old/'
 
1386
            new_label = 'new/'
 
1387
        elif ':' in prefix:
 
1388
            old_label, new_label = prefix.split(":")
 
1389
        else:
 
1390
            raise errors.BzrCommandError(
 
1391
                '--prefix expects two values separated by a colon'
 
1392
                ' (eg "old/:new/")')
 
1393
 
 
1394
        if revision and len(revision) > 2:
 
1395
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
 
1396
                                         ' one or two revision specifiers')
 
1397
 
 
1398
        try:
 
1399
            tree1, file_list = internal_tree_files(file_list)
 
1400
            tree2 = None
 
1401
            b = None
 
1402
            b2 = None
 
1403
        except errors.FileInWrongBranch:
 
1404
            if len(file_list) != 2:
 
1405
                raise errors.BzrCommandError("Files are in different branches")
 
1406
 
 
1407
            tree1, file1 = WorkingTree.open_containing(file_list[0])
 
1408
            tree2, file2 = WorkingTree.open_containing(file_list[1])
 
1409
            if file1 != "" or file2 != "":
 
1410
                # FIXME diff those two files. rbc 20051123
 
1411
                raise errors.BzrCommandError("Files are in different branches")
 
1412
            file_list = None
 
1413
        except errors.NotBranchError:
 
1414
            if (revision is not None and len(revision) == 2
 
1415
                and not revision[0].needs_branch()
 
1416
                and not revision[1].needs_branch()):
 
1417
                # If both revision specs include a branch, we can
 
1418
                # diff them without needing a local working tree
 
1419
                tree1, tree2 = None, None
 
1420
            else:
 
1421
                raise
 
1422
 
 
1423
        if tree2 is not None:
 
1424
            if revision is not None:
 
1425
                # FIXME: but there should be a clean way to diff between
 
1426
                # non-default versions of two trees, it's not hard to do
 
1427
                # internally...
 
1428
                raise errors.BzrCommandError(
 
1429
                        "Sorry, diffing arbitrary revisions across branches "
 
1430
                        "is not implemented yet")
 
1431
            return show_diff_trees(tree1, tree2, sys.stdout, 
 
1432
                                   specific_files=file_list,
 
1433
                                   external_diff_options=diff_options,
 
1434
                                   old_label=old_label, new_label=new_label)
 
1435
 
 
1436
        return diff_cmd_helper(tree1, file_list, diff_options,
 
1437
                               revision_specs=revision,
 
1438
                               old_label=old_label, new_label=new_label)
 
1439
 
 
1440
 
 
1441
class cmd_deleted(Command):
 
1442
    """List files deleted in the working tree.
 
1443
    """
 
1444
    # TODO: Show files deleted since a previous revision, or
 
1445
    # between two revisions.
 
1446
    # TODO: Much more efficient way to do this: read in new
 
1447
    # directories with readdir, rather than stating each one.  Same
 
1448
    # level of effort but possibly much less IO.  (Or possibly not,
 
1449
    # if the directories are very large...)
 
1450
    takes_options = ['show-ids']
 
1451
 
 
1452
    @display_command
 
1453
    def run(self, show_ids=False):
 
1454
        tree = WorkingTree.open_containing(u'.')[0]
 
1455
        tree.lock_read()
 
1456
        try:
 
1457
            old = tree.basis_tree()
 
1458
            old.lock_read()
 
1459
            try:
 
1460
                for path, ie in old.inventory.iter_entries():
 
1461
                    if not tree.has_id(ie.file_id):
 
1462
                        self.outf.write(path)
 
1463
                        if show_ids:
 
1464
                            self.outf.write(' ')
 
1465
                            self.outf.write(ie.file_id)
 
1466
                        self.outf.write('\n')
 
1467
            finally:
 
1468
                old.unlock()
 
1469
        finally:
 
1470
            tree.unlock()
 
1471
 
 
1472
 
 
1473
class cmd_modified(Command):
 
1474
    """List files modified in working tree.
 
1475
 
 
1476
    See also: "bzr status".
 
1477
    """
 
1478
 
 
1479
    hidden = True
 
1480
 
 
1481
    @display_command
 
1482
    def run(self):
 
1483
        tree = WorkingTree.open_containing(u'.')[0]
 
1484
        td = tree.changes_from(tree.basis_tree())
 
1485
        for path, id, kind, text_modified, meta_modified in td.modified:
 
1486
            self.outf.write(path + '\n')
 
1487
 
 
1488
 
 
1489
class cmd_added(Command):
 
1490
    """List files added in working tree.
 
1491
 
 
1492
    See also: "bzr status".
 
1493
    """
 
1494
 
 
1495
    hidden = True
 
1496
 
 
1497
    @display_command
 
1498
    def run(self):
 
1499
        wt = WorkingTree.open_containing(u'.')[0]
 
1500
        wt.lock_read()
 
1501
        try:
 
1502
            basis = wt.basis_tree()
 
1503
            basis.lock_read()
 
1504
            try:
 
1505
                basis_inv = basis.inventory
 
1506
                inv = wt.inventory
 
1507
                for file_id in inv:
 
1508
                    if file_id in basis_inv:
 
1509
                        continue
 
1510
                    if inv.is_root(file_id) and len(basis_inv) == 0:
 
1511
                        continue
 
1512
                    path = inv.id2path(file_id)
 
1513
                    if not os.access(osutils.abspath(path), os.F_OK):
 
1514
                        continue
 
1515
                    self.outf.write(path + '\n')
 
1516
            finally:
 
1517
                basis.unlock()
 
1518
        finally:
 
1519
            wt.unlock()
 
1520
 
 
1521
 
 
1522
class cmd_root(Command):
 
1523
    """Show the tree root directory.
 
1524
 
 
1525
    The root is the nearest enclosing directory with a .bzr control
 
1526
    directory."""
 
1527
    takes_args = ['filename?']
 
1528
    @display_command
 
1529
    def run(self, filename=None):
 
1530
        """Print the branch root."""
 
1531
        tree = WorkingTree.open_containing(filename)[0]
 
1532
        self.outf.write(tree.basedir + '\n')
 
1533
 
 
1534
 
 
1535
class cmd_log(Command):
 
1536
    """Show log of a branch, file, or directory.
 
1537
 
 
1538
    By default show the log of the branch containing the working directory.
 
1539
 
 
1540
    To request a range of logs, you can use the command -r begin..end
 
1541
    -r revision requests a specific revision, -r ..end or -r begin.. are
 
1542
    also valid.
 
1543
 
 
1544
    examples:
 
1545
        bzr log
 
1546
        bzr log foo.c
 
1547
        bzr log -r -10.. http://server/branch
 
1548
    """
 
1549
 
 
1550
    # TODO: Make --revision support uuid: and hash: [future tag:] notation.
 
1551
 
 
1552
    takes_args = ['location?']
 
1553
    takes_options = [Option('forward', 
 
1554
                            help='show from oldest to newest'),
 
1555
                     'timezone', 
 
1556
                     Option('verbose', 
 
1557
                             short_name='v',
 
1558
                             help='show files changed in each revision'),
 
1559
                     'show-ids', 'revision',
 
1560
                     'log-format',
 
1561
                     Option('message',
 
1562
                            short_name='m',
 
1563
                            help='show revisions whose message matches this regexp',
 
1564
                            type=str),
 
1565
                     ]
 
1566
    encoding_type = 'replace'
 
1567
 
 
1568
    @display_command
 
1569
    def run(self, location=None, timezone='original',
 
1570
            verbose=False,
 
1571
            show_ids=False,
 
1572
            forward=False,
 
1573
            revision=None,
 
1574
            log_format=None,
 
1575
            message=None):
 
1576
        from bzrlib.log import show_log
 
1577
        assert message is None or isinstance(message, basestring), \
 
1578
            "invalid message argument %r" % message
 
1579
        direction = (forward and 'forward') or 'reverse'
 
1580
        
 
1581
        # log everything
 
1582
        file_id = None
 
1583
        if location:
 
1584
            # find the file id to log:
 
1585
 
 
1586
            tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
 
1587
                location)
 
1588
            if fp != '':
 
1589
                if tree is None:
 
1590
                    tree = b.basis_tree()
 
1591
                file_id = tree.path2id(fp)
 
1592
                if file_id is None:
 
1593
                    raise errors.BzrCommandError(
 
1594
                        "Path does not have any revision history: %s" %
 
1595
                        location)
 
1596
        else:
 
1597
            # local dir only
 
1598
            # FIXME ? log the current subdir only RBC 20060203 
 
1599
            if revision is not None \
 
1600
                    and len(revision) > 0 and revision[0].get_branch():
 
1601
                location = revision[0].get_branch()
 
1602
            else:
 
1603
                location = '.'
 
1604
            dir, relpath = bzrdir.BzrDir.open_containing(location)
 
1605
            b = dir.open_branch()
 
1606
 
 
1607
        b.lock_read()
 
1608
        try:
 
1609
            if revision is None:
 
1610
                rev1 = None
 
1611
                rev2 = None
 
1612
            elif len(revision) == 1:
 
1613
                rev1 = rev2 = revision[0].in_history(b).revno
 
1614
            elif len(revision) == 2:
 
1615
                if revision[1].get_branch() != revision[0].get_branch():
 
1616
                    # b is taken from revision[0].get_branch(), and
 
1617
                    # show_log will use its revision_history. Having
 
1618
                    # different branches will lead to weird behaviors.
 
1619
                    raise errors.BzrCommandError(
 
1620
                        "Log doesn't accept two revisions in different"
 
1621
                        " branches.")
 
1622
                if revision[0].spec is None:
 
1623
                    # missing begin-range means first revision
 
1624
                    rev1 = 1
 
1625
                else:
 
1626
                    rev1 = revision[0].in_history(b).revno
 
1627
 
 
1628
                if revision[1].spec is None:
 
1629
                    # missing end-range means last known revision
 
1630
                    rev2 = b.revno()
 
1631
                else:
 
1632
                    rev2 = revision[1].in_history(b).revno
 
1633
            else:
 
1634
                raise errors.BzrCommandError(
 
1635
                    'bzr log --revision takes one or two values.')
 
1636
 
 
1637
            # By this point, the revision numbers are converted to the +ve
 
1638
            # form if they were supplied in the -ve form, so we can do
 
1639
            # this comparison in relative safety
 
1640
            if rev1 > rev2:
 
1641
                (rev2, rev1) = (rev1, rev2)
 
1642
 
 
1643
            if log_format is None:
 
1644
                log_format = log.log_formatter_registry.get_default(b)
 
1645
 
 
1646
            lf = log_format(show_ids=show_ids, to_file=self.outf,
 
1647
                            show_timezone=timezone)
 
1648
 
 
1649
            show_log(b,
 
1650
                     lf,
 
1651
                     file_id,
 
1652
                     verbose=verbose,
 
1653
                     direction=direction,
 
1654
                     start_revision=rev1,
 
1655
                     end_revision=rev2,
 
1656
                     search=message)
 
1657
        finally:
 
1658
            b.unlock()
 
1659
 
 
1660
 
 
1661
def get_log_format(long=False, short=False, line=False, default='long'):
 
1662
    log_format = default
 
1663
    if long:
 
1664
        log_format = 'long'
 
1665
    if short:
 
1666
        log_format = 'short'
 
1667
    if line:
 
1668
        log_format = 'line'
 
1669
    return log_format
 
1670
 
 
1671
 
 
1672
class cmd_touching_revisions(Command):
 
1673
    """Return revision-ids which affected a particular file.
 
1674
 
 
1675
    A more user-friendly interface is "bzr log FILE".
 
1676
    """
 
1677
 
 
1678
    hidden = True
 
1679
    takes_args = ["filename"]
 
1680
 
 
1681
    @display_command
 
1682
    def run(self, filename):
 
1683
        tree, relpath = WorkingTree.open_containing(filename)
 
1684
        b = tree.branch
 
1685
        file_id = tree.path2id(relpath)
 
1686
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
 
1687
            self.outf.write("%6d %s\n" % (revno, what))
 
1688
 
 
1689
 
 
1690
class cmd_ls(Command):
 
1691
    """List files in a tree.
 
1692
    """
 
1693
 
 
1694
    takes_args = ['path?']
 
1695
    # TODO: Take a revision or remote path and list that tree instead.
 
1696
    takes_options = ['verbose', 'revision',
 
1697
                     Option('non-recursive',
 
1698
                            help='don\'t recurse into sub-directories'),
 
1699
                     Option('from-root',
 
1700
                            help='Print all paths from the root of the branch.'),
 
1701
                     Option('unknown', help='Print unknown files'),
 
1702
                     Option('versioned', help='Print versioned files'),
 
1703
                     Option('ignored', help='Print ignored files'),
 
1704
 
 
1705
                     Option('null', help='Null separate the files'),
 
1706
                     'kind', 'show-ids'
 
1707
                    ]
 
1708
    @display_command
 
1709
    def run(self, revision=None, verbose=False, 
 
1710
            non_recursive=False, from_root=False,
 
1711
            unknown=False, versioned=False, ignored=False,
 
1712
            null=False, kind=None, show_ids=False, path=None):
 
1713
 
 
1714
        if kind and kind not in ('file', 'directory', 'symlink'):
 
1715
            raise errors.BzrCommandError('invalid kind specified')
 
1716
 
 
1717
        if verbose and null:
 
1718
            raise errors.BzrCommandError('Cannot set both --verbose and --null')
 
1719
        all = not (unknown or versioned or ignored)
 
1720
 
 
1721
        selection = {'I':ignored, '?':unknown, 'V':versioned}
 
1722
 
 
1723
        if path is None:
 
1724
            fs_path = '.'
 
1725
            prefix = ''
 
1726
        else:
 
1727
            if from_root:
 
1728
                raise errors.BzrCommandError('cannot specify both --from-root'
 
1729
                                             ' and PATH')
 
1730
            fs_path = path
 
1731
            prefix = path
 
1732
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
 
1733
            fs_path)
 
1734
        if from_root:
 
1735
            relpath = u''
 
1736
        elif relpath:
 
1737
            relpath += '/'
 
1738
        if revision is not None:
 
1739
            tree = branch.repository.revision_tree(
 
1740
                revision[0].in_history(branch).rev_id)
 
1741
        elif tree is None:
 
1742
            tree = branch.basis_tree()
 
1743
 
 
1744
        tree.lock_read()
 
1745
        try:
 
1746
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
 
1747
                if fp.startswith(relpath):
 
1748
                    fp = osutils.pathjoin(prefix, fp[len(relpath):])
 
1749
                    if non_recursive and '/' in fp:
 
1750
                        continue
 
1751
                    if not all and not selection[fc]:
 
1752
                        continue
 
1753
                    if kind is not None and fkind != kind:
 
1754
                        continue
 
1755
                    if verbose:
 
1756
                        kindch = entry.kind_character()
 
1757
                        outstring = '%-8s %s%s' % (fc, fp, kindch)
 
1758
                        if show_ids and fid is not None:
 
1759
                            outstring = "%-50s %s" % (outstring, fid)
 
1760
                        self.outf.write(outstring + '\n')
 
1761
                    elif null:
 
1762
                        self.outf.write(fp + '\0')
 
1763
                        if show_ids:
 
1764
                            if fid is not None:
 
1765
                                self.outf.write(fid)
 
1766
                            self.outf.write('\0')
 
1767
                        self.outf.flush()
 
1768
                    else:
 
1769
                        if fid is not None:
 
1770
                            my_id = fid
 
1771
                        else:
 
1772
                            my_id = ''
 
1773
                        if show_ids:
 
1774
                            self.outf.write('%-50s %s\n' % (fp, my_id))
 
1775
                        else:
 
1776
                            self.outf.write(fp + '\n')
 
1777
        finally:
 
1778
            tree.unlock()
 
1779
 
 
1780
 
 
1781
class cmd_unknowns(Command):
 
1782
    """List unknown files.
 
1783
 
 
1784
    See also: "bzr ls --unknown".
 
1785
    """
 
1786
 
 
1787
    hidden = True
 
1788
 
 
1789
    @display_command
 
1790
    def run(self):
 
1791
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
 
1792
            self.outf.write(osutils.quotefn(f) + '\n')
 
1793
 
 
1794
 
 
1795
class cmd_ignore(Command):
 
1796
    """Ignore specified files or patterns.
 
1797
 
 
1798
    To remove patterns from the ignore list, edit the .bzrignore file.
 
1799
 
 
1800
    Trailing slashes on patterns are ignored. 
 
1801
    If the pattern contains a slash or is a regular expression, it is compared 
 
1802
    to the whole path from the branch root.  Otherwise, it is compared to only
 
1803
    the last component of the path.  To match a file only in the root 
 
1804
    directory, prepend './'.
 
1805
 
 
1806
    Ignore patterns specifying absolute paths are not allowed.
 
1807
 
 
1808
    Ignore patterns may include globbing wildcards such as:
 
1809
      ? - Matches any single character except '/'
 
1810
      * - Matches 0 or more characters except '/'
 
1811
      /**/ - Matches 0 or more directories in a path
 
1812
      [a-z] - Matches a single character from within a group of characters
 
1813
 
 
1814
    Ignore patterns may also be Python regular expressions.  
 
1815
    Regular expression ignore patterns are identified by a 'RE:' prefix 
 
1816
    followed by the regular expression.  Regular expression ignore patterns
 
1817
    may not include named or numbered groups.
 
1818
 
 
1819
    Note: ignore patterns containing shell wildcards must be quoted from 
 
1820
    the shell on Unix.
 
1821
 
 
1822
    examples:
 
1823
        bzr ignore ./Makefile
 
1824
        bzr ignore '*.class'
 
1825
        bzr ignore 'lib/**/*.o'
 
1826
        bzr ignore 'RE:lib/.*\.o'
 
1827
    """
 
1828
    takes_args = ['name_pattern*']
 
1829
    takes_options = [
 
1830
                     Option('old-default-rules',
 
1831
                            help='Out the ignore rules bzr < 0.9 always used.')
 
1832
                     ]
 
1833
    
 
1834
    def run(self, name_pattern_list=None, old_default_rules=None):
 
1835
        from bzrlib.atomicfile import AtomicFile
 
1836
        if old_default_rules is not None:
 
1837
            # dump the rules and exit
 
1838
            for pattern in ignores.OLD_DEFAULTS:
 
1839
                print pattern
 
1840
            return
 
1841
        if not name_pattern_list:
 
1842
            raise errors.BzrCommandError("ignore requires at least one "
 
1843
                                  "NAME_PATTERN or --old-default-rules")
 
1844
        name_pattern_list = [globbing.normalize_pattern(p) 
 
1845
                             for p in name_pattern_list]
 
1846
        for name_pattern in name_pattern_list:
 
1847
            if (name_pattern[0] == '/' or 
 
1848
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
 
1849
                raise errors.BzrCommandError(
 
1850
                    "NAME_PATTERN should not be an absolute path")
 
1851
        tree, relpath = WorkingTree.open_containing(u'.')
 
1852
        ifn = tree.abspath('.bzrignore')
 
1853
        if os.path.exists(ifn):
 
1854
            f = open(ifn, 'rt')
 
1855
            try:
 
1856
                igns = f.read().decode('utf-8')
 
1857
            finally:
 
1858
                f.close()
 
1859
        else:
 
1860
            igns = ''
 
1861
 
 
1862
        # TODO: If the file already uses crlf-style termination, maybe
 
1863
        # we should use that for the newly added lines?
 
1864
 
 
1865
        if igns and igns[-1] != '\n':
 
1866
            igns += '\n'
 
1867
        for name_pattern in name_pattern_list:
 
1868
            igns += name_pattern + '\n'
 
1869
 
 
1870
        f = AtomicFile(ifn, 'wb')
 
1871
        try:
 
1872
            f.write(igns.encode('utf-8'))
 
1873
            f.commit()
 
1874
        finally:
 
1875
            f.close()
 
1876
 
 
1877
        if not tree.path2id('.bzrignore'):
 
1878
            tree.add(['.bzrignore'])
 
1879
 
 
1880
 
 
1881
class cmd_ignored(Command):
 
1882
    """List ignored files and the patterns that matched them.
 
1883
 
 
1884
    See also: bzr ignore"""
 
1885
    @display_command
 
1886
    def run(self):
 
1887
        tree = WorkingTree.open_containing(u'.')[0]
 
1888
        tree.lock_read()
 
1889
        try:
 
1890
            for path, file_class, kind, file_id, entry in tree.list_files():
 
1891
                if file_class != 'I':
 
1892
                    continue
 
1893
                ## XXX: Slightly inefficient since this was already calculated
 
1894
                pat = tree.is_ignored(path)
 
1895
                print '%-50s %s' % (path, pat)
 
1896
        finally:
 
1897
            tree.unlock()
 
1898
 
 
1899
 
 
1900
class cmd_lookup_revision(Command):
 
1901
    """Lookup the revision-id from a revision-number
 
1902
 
 
1903
    example:
 
1904
        bzr lookup-revision 33
 
1905
    """
 
1906
    hidden = True
 
1907
    takes_args = ['revno']
 
1908
    
 
1909
    @display_command
 
1910
    def run(self, revno):
 
1911
        try:
 
1912
            revno = int(revno)
 
1913
        except ValueError:
 
1914
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
 
1915
 
 
1916
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
1917
 
 
1918
 
 
1919
class cmd_export(Command):
 
1920
    """Export past revision to destination directory.
 
1921
 
 
1922
    If no revision is specified this exports the last committed revision.
 
1923
 
 
1924
    Format may be an "exporter" name, such as tar, tgz, tbz2.  If none is
 
1925
    given, try to find the format with the extension. If no extension
 
1926
    is found exports to a directory (equivalent to --format=dir).
 
1927
 
 
1928
    Root may be the top directory for tar, tgz and tbz2 formats. If none
 
1929
    is given, the top directory will be the root name of the file.
 
1930
 
 
1931
    If branch is omitted then the branch containing the CWD will be used.
 
1932
 
 
1933
    Note: export of tree with non-ascii filenames to zip is not supported.
 
1934
 
 
1935
     Supported formats       Autodetected by extension
 
1936
     -----------------       -------------------------
 
1937
         dir                            -
 
1938
         tar                          .tar
 
1939
         tbz2                    .tar.bz2, .tbz2
 
1940
         tgz                      .tar.gz, .tgz
 
1941
         zip                          .zip
 
1942
    """
 
1943
    takes_args = ['dest', 'branch?']
 
1944
    takes_options = ['revision', 'format', 'root']
 
1945
    def run(self, dest, branch=None, revision=None, format=None, root=None):
 
1946
        from bzrlib.export import export
 
1947
 
 
1948
        if branch is None:
 
1949
            tree = WorkingTree.open_containing(u'.')[0]
 
1950
            b = tree.branch
 
1951
        else:
 
1952
            b = Branch.open(branch)
 
1953
            
 
1954
        if revision is None:
 
1955
            # should be tree.last_revision  FIXME
 
1956
            rev_id = b.last_revision()
 
1957
        else:
 
1958
            if len(revision) != 1:
 
1959
                raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
 
1960
            rev_id = revision[0].in_history(b).rev_id
 
1961
        t = b.repository.revision_tree(rev_id)
 
1962
        try:
 
1963
            export(t, dest, format, root)
 
1964
        except errors.NoSuchExportFormat, e:
 
1965
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
 
1966
 
 
1967
 
 
1968
class cmd_cat(Command):
 
1969
    """Write a file's text from a previous revision."""
 
1970
 
 
1971
    takes_options = ['revision', 'name-from-revision']
 
1972
    takes_args = ['filename']
 
1973
    encoding_type = 'exact'
 
1974
 
 
1975
    @display_command
 
1976
    def run(self, filename, revision=None, name_from_revision=False):
 
1977
        if revision is not None and len(revision) != 1:
 
1978
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
 
1979
                                        " one number")
 
1980
 
 
1981
        tree = None
 
1982
        try:
 
1983
            tree, b, relpath = \
 
1984
                    bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
1985
        except errors.NotBranchError:
 
1986
            pass
 
1987
 
 
1988
        if revision is not None and revision[0].get_branch() is not None:
 
1989
            b = Branch.open(revision[0].get_branch())
 
1990
        if tree is None:
 
1991
            tree = b.basis_tree()
 
1992
        if revision is None:
 
1993
            revision_id = b.last_revision()
 
1994
        else:
 
1995
            revision_id = revision[0].in_history(b).rev_id
 
1996
 
 
1997
        cur_file_id = tree.path2id(relpath)
 
1998
        rev_tree = b.repository.revision_tree(revision_id)
 
1999
        old_file_id = rev_tree.path2id(relpath)
 
2000
        
 
2001
        if name_from_revision:
 
2002
            if old_file_id is None:
 
2003
                raise errors.BzrCommandError("%r is not present in revision %s"
 
2004
                                                % (filename, revision_id))
 
2005
            else:
 
2006
                rev_tree.print_file(old_file_id)
 
2007
        elif cur_file_id is not None:
 
2008
            rev_tree.print_file(cur_file_id)
 
2009
        elif old_file_id is not None:
 
2010
            rev_tree.print_file(old_file_id)
 
2011
        else:
 
2012
            raise errors.BzrCommandError("%r is not present in revision %s" %
 
2013
                                         (filename, revision_id))
 
2014
 
 
2015
 
 
2016
class cmd_local_time_offset(Command):
 
2017
    """Show the offset in seconds from GMT to local time."""
 
2018
    hidden = True    
 
2019
    @display_command
 
2020
    def run(self):
 
2021
        print osutils.local_time_offset()
 
2022
 
 
2023
 
 
2024
 
 
2025
class cmd_commit(Command):
 
2026
    """Commit changes into a new revision.
 
2027
    
 
2028
    If no arguments are given, the entire tree is committed.
 
2029
 
 
2030
    If selected files are specified, only changes to those files are
 
2031
    committed.  If a directory is specified then the directory and everything 
 
2032
    within it is committed.
 
2033
 
 
2034
    A selected-file commit may fail in some cases where the committed
 
2035
    tree would be invalid, such as trying to commit a file in a
 
2036
    newly-added directory that is not itself committed.
 
2037
    """
 
2038
    # TODO: Run hooks on tree to-be-committed, and after commit.
 
2039
 
 
2040
    # TODO: Strict commit that fails if there are deleted files.
 
2041
    #       (what does "deleted files" mean ??)
 
2042
 
 
2043
    # TODO: Give better message for -s, --summary, used by tla people
 
2044
 
 
2045
    # XXX: verbose currently does nothing
 
2046
 
 
2047
    takes_args = ['selected*']
 
2048
    takes_options = ['message', 'verbose', 
 
2049
                     Option('unchanged',
 
2050
                            help='commit even if nothing has changed'),
 
2051
                     Option('file', type=str, 
 
2052
                            short_name='F',
 
2053
                            argname='msgfile',
 
2054
                            help='file containing commit message'),
 
2055
                     Option('strict',
 
2056
                            help="refuse to commit if there are unknown "
 
2057
                            "files in the working tree."),
 
2058
                     Option('local',
 
2059
                            help="perform a local only commit in a bound "
 
2060
                                 "branch. Such commits are not pushed to "
 
2061
                                 "the master branch until a normal commit "
 
2062
                                 "is performed."
 
2063
                            ),
 
2064
                     ]
 
2065
    aliases = ['ci', 'checkin']
 
2066
 
 
2067
    def run(self, message=None, file=None, verbose=True, selected_list=None,
 
2068
            unchanged=False, strict=False, local=False):
 
2069
        from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
 
2070
        from bzrlib.errors import (PointlessCommit, ConflictsInTree,
 
2071
                StrictCommitFailed)
 
2072
        from bzrlib.msgeditor import edit_commit_message, \
 
2073
                make_commit_message_template
 
2074
 
 
2075
        # TODO: Need a blackbox test for invoking the external editor; may be
 
2076
        # slightly problematic to run this cross-platform.
 
2077
 
 
2078
        # TODO: do more checks that the commit will succeed before 
 
2079
        # spending the user's valuable time typing a commit message.
 
2080
        tree, selected_list = tree_files(selected_list)
 
2081
        if selected_list == ['']:
 
2082
            # workaround - commit of root of tree should be exactly the same
 
2083
            # as just default commit in that tree, and succeed even though
 
2084
            # selected-file merge commit is not done yet
 
2085
            selected_list = []
 
2086
 
 
2087
        if local and not tree.branch.get_bound_location():
 
2088
            raise errors.LocalRequiresBoundBranch()
 
2089
 
 
2090
        def get_message(commit_obj):
 
2091
            """Callback to get commit message"""
 
2092
            my_message = message
 
2093
            if my_message is None and not file:
 
2094
                template = make_commit_message_template(tree, selected_list)
 
2095
                my_message = edit_commit_message(template)
 
2096
                if my_message is None:
 
2097
                    raise errors.BzrCommandError("please specify a commit"
 
2098
                        " message with either --message or --file")
 
2099
            elif my_message and file:
 
2100
                raise errors.BzrCommandError(
 
2101
                    "please specify either --message or --file")
 
2102
            if file:
 
2103
                my_message = codecs.open(file, 'rt', 
 
2104
                                         bzrlib.user_encoding).read()
 
2105
            if my_message == "":
 
2106
                raise errors.BzrCommandError("empty commit message specified")
 
2107
            return my_message
 
2108
        
 
2109
        if verbose:
 
2110
            reporter = ReportCommitToLog()
 
2111
        else:
 
2112
            reporter = NullCommitReporter()
 
2113
 
 
2114
        try:
 
2115
            tree.commit(message_callback=get_message,
 
2116
                        specific_files=selected_list,
 
2117
                        allow_pointless=unchanged, strict=strict, local=local,
 
2118
                        reporter=reporter)
 
2119
        except PointlessCommit:
 
2120
            # FIXME: This should really happen before the file is read in;
 
2121
            # perhaps prepare the commit; get the message; then actually commit
 
2122
            raise errors.BzrCommandError("no changes to commit."
 
2123
                              " use --unchanged to commit anyhow")
 
2124
        except ConflictsInTree:
 
2125
            raise errors.BzrCommandError('Conflicts detected in working '
 
2126
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
 
2127
                ' resolve.')
 
2128
        except StrictCommitFailed:
 
2129
            raise errors.BzrCommandError("Commit refused because there are"
 
2130
                              " unknown files in the working tree.")
 
2131
        except errors.BoundBranchOutOfDate, e:
 
2132
            raise errors.BzrCommandError(str(e) + "\n"
 
2133
            'To commit to master branch, run update and then commit.\n'
 
2134
            'You can also pass --local to commit to continue working '
 
2135
            'disconnected.')
 
2136
 
 
2137
 
 
2138
class cmd_check(Command):
 
2139
    """Validate consistency of branch history.
 
2140
 
 
2141
    This command checks various invariants about the branch storage to
 
2142
    detect data corruption or bzr bugs.
 
2143
    """
 
2144
    takes_args = ['branch?']
 
2145
    takes_options = ['verbose']
 
2146
 
 
2147
    def run(self, branch=None, verbose=False):
 
2148
        from bzrlib.check import check
 
2149
        if branch is None:
 
2150
            tree = WorkingTree.open_containing()[0]
 
2151
            branch = tree.branch
 
2152
        else:
 
2153
            branch = Branch.open(branch)
 
2154
        check(branch, verbose)
 
2155
 
 
2156
 
 
2157
class cmd_upgrade(Command):
 
2158
    """Upgrade branch storage to current format.
 
2159
 
 
2160
    The check command or bzr developers may sometimes advise you to run
 
2161
    this command. When the default format has changed you may also be warned
 
2162
    during other operations to upgrade.
 
2163
    """
 
2164
    takes_args = ['url?']
 
2165
    takes_options = [
 
2166
                    RegistryOption('format',
 
2167
                        help='Upgrade to a specific format.  See "bzr help'
 
2168
                             ' formats" for details',
 
2169
                        registry=bzrdir.format_registry,
 
2170
                        converter=bzrdir.format_registry.make_bzrdir,
 
2171
                        value_switches=True, title='Branch format'),
 
2172
                    ]
 
2173
 
 
2174
    def run(self, url='.', format=None):
 
2175
        from bzrlib.upgrade import upgrade
 
2176
        if format is None:
 
2177
            format = bzrdir.format_registry.make_bzrdir('default')
 
2178
        upgrade(url, format)
 
2179
 
 
2180
 
 
2181
class cmd_whoami(Command):
 
2182
    """Show or set bzr user id.
 
2183
    
 
2184
    examples:
 
2185
        bzr whoami --email
 
2186
        bzr whoami 'Frank Chu <fchu@example.com>'
 
2187
    """
 
2188
    takes_options = [ Option('email',
 
2189
                             help='display email address only'),
 
2190
                      Option('branch',
 
2191
                             help='set identity for the current branch instead of '
 
2192
                                  'globally'),
 
2193
                    ]
 
2194
    takes_args = ['name?']
 
2195
    encoding_type = 'replace'
 
2196
    
 
2197
    @display_command
 
2198
    def run(self, email=False, branch=False, name=None):
 
2199
        if name is None:
 
2200
            # use branch if we're inside one; otherwise global config
 
2201
            try:
 
2202
                c = Branch.open_containing('.')[0].get_config()
 
2203
            except errors.NotBranchError:
 
2204
                c = config.GlobalConfig()
 
2205
            if email:
 
2206
                self.outf.write(c.user_email() + '\n')
 
2207
            else:
 
2208
                self.outf.write(c.username() + '\n')
 
2209
            return
 
2210
 
 
2211
        # display a warning if an email address isn't included in the given name.
 
2212
        try:
 
2213
            config.extract_email_address(name)
 
2214
        except errors.NoEmailInUsername, e:
 
2215
            warning('"%s" does not seem to contain an email address.  '
 
2216
                    'This is allowed, but not recommended.', name)
 
2217
        
 
2218
        # use global config unless --branch given
 
2219
        if branch:
 
2220
            c = Branch.open_containing('.')[0].get_config()
 
2221
        else:
 
2222
            c = config.GlobalConfig()
 
2223
        c.set_user_option('email', name)
 
2224
 
 
2225
 
 
2226
class cmd_nick(Command):
 
2227
    """Print or set the branch nickname.  
 
2228
 
 
2229
    If unset, the tree root directory name is used as the nickname
 
2230
    To print the current nickname, execute with no argument.  
 
2231
    """
 
2232
    takes_args = ['nickname?']
 
2233
    def run(self, nickname=None):
 
2234
        branch = Branch.open_containing(u'.')[0]
 
2235
        if nickname is None:
 
2236
            self.printme(branch)
 
2237
        else:
 
2238
            branch.nick = nickname
 
2239
 
 
2240
    @display_command
 
2241
    def printme(self, branch):
 
2242
        print branch.nick 
 
2243
 
 
2244
 
 
2245
class cmd_selftest(Command):
 
2246
    """Run internal test suite.
 
2247
    
 
2248
    This creates temporary test directories in the working directory, but not
 
2249
    existing data is affected.  These directories are deleted if the tests
 
2250
    pass, or left behind to help in debugging if they fail and --keep-output
 
2251
    is specified.
 
2252
    
 
2253
    If arguments are given, they are regular expressions that say which tests
 
2254
    should run.  Tests matching any expression are run, and other tests are
 
2255
    not run.
 
2256
 
 
2257
    Alternatively if --first is given, matching tests are run first and then
 
2258
    all other tests are run.  This is useful if you have been working in a
 
2259
    particular area, but want to make sure nothing else was broken.
 
2260
 
 
2261
    If the global option '--no-plugins' is given, plugins are not loaded
 
2262
    before running the selftests.  This has two effects: features provided or
 
2263
    modified by plugins will not be tested, and tests provided by plugins will
 
2264
    not be run.
 
2265
 
 
2266
    examples::
 
2267
        bzr selftest ignore
 
2268
            run only tests relating to 'ignore'
 
2269
        bzr --no-plugins selftest -v
 
2270
            disable plugins and list tests as they're run
 
2271
 
 
2272
    For each test, that needs actual disk access, bzr create their own
 
2273
    subdirectory in the temporary testing directory (testXXXX.tmp).
 
2274
    By default the name of such subdirectory is based on the name of the test.
 
2275
    If option '--numbered-dirs' is given, bzr will use sequent numbers
 
2276
    of running tests to create such subdirectories. This is default behavior
 
2277
    on Windows because of path length limitation.
 
2278
    """
 
2279
    # TODO: --list should give a list of all available tests
 
2280
 
 
2281
    # NB: this is used from the class without creating an instance, which is
 
2282
    # why it does not have a self parameter.
 
2283
    def get_transport_type(typestring):
 
2284
        """Parse and return a transport specifier."""
 
2285
        if typestring == "sftp":
 
2286
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
2287
            return SFTPAbsoluteServer
 
2288
        if typestring == "memory":
 
2289
            from bzrlib.transport.memory import MemoryServer
 
2290
            return MemoryServer
 
2291
        if typestring == "fakenfs":
 
2292
            from bzrlib.transport.fakenfs import FakeNFSServer
 
2293
            return FakeNFSServer
 
2294
        msg = "No known transport type %s. Supported types are: sftp\n" %\
 
2295
            (typestring)
 
2296
        raise errors.BzrCommandError(msg)
 
2297
 
 
2298
    hidden = True
 
2299
    takes_args = ['testspecs*']
 
2300
    takes_options = ['verbose',
 
2301
                     Option('one', help='stop when one test fails'),
 
2302
                     Option('keep-output',
 
2303
                            help='keep output directories when tests fail'),
 
2304
                     Option('transport',
 
2305
                            help='Use a different transport by default '
 
2306
                                 'throughout the test suite.',
 
2307
                            type=get_transport_type),
 
2308
                     Option('benchmark', help='run the bzr benchmarks.'),
 
2309
                     Option('lsprof-timed',
 
2310
                            help='generate lsprof output for benchmarked'
 
2311
                                 ' sections of code.'),
 
2312
                     Option('cache-dir', type=str,
 
2313
                            help='a directory to cache intermediate'
 
2314
                                 ' benchmark steps'),
 
2315
                     Option('clean-output',
 
2316
                            help='clean temporary tests directories'
 
2317
                                 ' without running tests'),
 
2318
                     Option('first',
 
2319
                            help='run all tests, but run specified tests first'
 
2320
                            ),
 
2321
                     Option('numbered-dirs',
 
2322
                            help='use numbered dirs for TestCaseInTempDir'),
 
2323
                     ]
 
2324
    encoding_type = 'replace'
 
2325
 
 
2326
    def run(self, testspecs_list=None, verbose=None, one=False,
 
2327
            keep_output=False, transport=None, benchmark=None,
 
2328
            lsprof_timed=None, cache_dir=None, clean_output=False,
 
2329
            first=False, numbered_dirs=None):
 
2330
        import bzrlib.ui
 
2331
        from bzrlib.tests import selftest
 
2332
        import bzrlib.benchmarks as benchmarks
 
2333
        from bzrlib.benchmarks import tree_creator
 
2334
 
 
2335
        if clean_output:
 
2336
            from bzrlib.tests import clean_selftest_output
 
2337
            clean_selftest_output()
 
2338
            return 0
 
2339
 
 
2340
        if numbered_dirs is None and sys.platform == 'win32':
 
2341
            numbered_dirs = True
 
2342
 
 
2343
        if cache_dir is not None:
 
2344
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
 
2345
        print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
 
2346
        print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
 
2347
        print
 
2348
        if testspecs_list is not None:
 
2349
            pattern = '|'.join(testspecs_list)
 
2350
        else:
 
2351
            pattern = ".*"
 
2352
        if benchmark:
 
2353
            test_suite_factory = benchmarks.test_suite
 
2354
            if verbose is None:
 
2355
                verbose = True
 
2356
            # TODO: should possibly lock the history file...
 
2357
            benchfile = open(".perf_history", "at", buffering=1)
 
2358
        else:
 
2359
            test_suite_factory = None
 
2360
            if verbose is None:
 
2361
                verbose = False
 
2362
            benchfile = None
 
2363
        try:
 
2364
            result = selftest(verbose=verbose, 
 
2365
                              pattern=pattern,
 
2366
                              stop_on_failure=one, 
 
2367
                              keep_output=keep_output,
 
2368
                              transport=transport,
 
2369
                              test_suite_factory=test_suite_factory,
 
2370
                              lsprof_timed=lsprof_timed,
 
2371
                              bench_history=benchfile,
 
2372
                              matching_tests_first=first,
 
2373
                              numbered_dirs=numbered_dirs,
 
2374
                              )
 
2375
        finally:
 
2376
            if benchfile is not None:
 
2377
                benchfile.close()
 
2378
        if result:
 
2379
            info('tests passed')
 
2380
        else:
 
2381
            info('tests failed')
 
2382
        return int(not result)
 
2383
 
 
2384
 
 
2385
class cmd_version(Command):
 
2386
    """Show version of bzr."""
 
2387
 
 
2388
    @display_command
 
2389
    def run(self):
 
2390
        from bzrlib.version import show_version
 
2391
        show_version()
 
2392
 
 
2393
 
 
2394
class cmd_rocks(Command):
 
2395
    """Statement of optimism."""
 
2396
 
 
2397
    hidden = True
 
2398
 
 
2399
    @display_command
 
2400
    def run(self):
 
2401
        print "It sure does!"
 
2402
 
 
2403
 
 
2404
class cmd_find_merge_base(Command):
 
2405
    """Find and print a base revision for merging two branches."""
 
2406
    # TODO: Options to specify revisions on either side, as if
 
2407
    #       merging only part of the history.
 
2408
    takes_args = ['branch', 'other']
 
2409
    hidden = True
 
2410
    
 
2411
    @display_command
 
2412
    def run(self, branch, other):
 
2413
        from bzrlib.revision import MultipleRevisionSources
 
2414
        
 
2415
        branch1 = Branch.open_containing(branch)[0]
 
2416
        branch2 = Branch.open_containing(other)[0]
 
2417
 
 
2418
        last1 = branch1.last_revision()
 
2419
        last2 = branch2.last_revision()
 
2420
 
 
2421
        source = MultipleRevisionSources(branch1.repository, 
 
2422
                                         branch2.repository)
 
2423
        
 
2424
        base_rev_id = common_ancestor(last1, last2, source)
 
2425
 
 
2426
        print 'merge base is revision %s' % base_rev_id
 
2427
 
 
2428
 
 
2429
class cmd_merge(Command):
 
2430
    """Perform a three-way merge.
 
2431
    
 
2432
    The branch is the branch you will merge from.  By default, it will merge
 
2433
    the latest revision.  If you specify a revision, that revision will be
 
2434
    merged.  If you specify two revisions, the first will be used as a BASE,
 
2435
    and the second one as OTHER.  Revision numbers are always relative to the
 
2436
    specified branch.
 
2437
 
 
2438
    By default, bzr will try to merge in all new work from the other
 
2439
    branch, automatically determining an appropriate base.  If this
 
2440
    fails, you may need to give an explicit base.
 
2441
    
 
2442
    Merge will do its best to combine the changes in two branches, but there
 
2443
    are some kinds of problems only a human can fix.  When it encounters those,
 
2444
    it will mark a conflict.  A conflict means that you need to fix something,
 
2445
    before you should commit.
 
2446
 
 
2447
    Use bzr resolve when you have fixed a problem.  See also bzr conflicts.
 
2448
 
 
2449
    If there is no default branch set, the first merge will set it. After
 
2450
    that, you can omit the branch to use the default.  To change the
 
2451
    default, use --remember. The value will only be saved if the remote
 
2452
    location can be accessed.
 
2453
 
 
2454
    The results of the merge are placed into the destination working
 
2455
    directory, where they can be reviewed (with bzr diff), tested, and then
 
2456
    committed to record the result of the merge.
 
2457
 
 
2458
    Examples:
 
2459
 
 
2460
    To merge the latest revision from bzr.dev
 
2461
    bzr merge ../bzr.dev
 
2462
 
 
2463
    To merge changes up to and including revision 82 from bzr.dev
 
2464
    bzr merge -r 82 ../bzr.dev
 
2465
 
 
2466
    To merge the changes introduced by 82, without previous changes:
 
2467
    bzr merge -r 81..82 ../bzr.dev
 
2468
    
 
2469
    merge refuses to run if there are any uncommitted changes, unless
 
2470
    --force is given.
 
2471
 
 
2472
    The following merge types are available:
 
2473
    """
 
2474
    takes_args = ['branch?']
 
2475
    takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
 
2476
        Option('show-base', help="Show base revision text in "
 
2477
               "conflicts"),
 
2478
        Option('uncommitted', help='Apply uncommitted changes'
 
2479
               ' from a working copy, instead of branch changes'),
 
2480
        Option('pull', help='If the destination is already'
 
2481
                ' completely merged into the source, pull from the'
 
2482
                ' source rather than merging. When this happens,'
 
2483
                ' you do not need to commit the result.'),
 
2484
        Option('directory',
 
2485
            help='Branch to merge into, '
 
2486
                 'rather than the one containing the working directory',
 
2487
            short_name='d',
 
2488
            type=unicode,
 
2489
            ),
 
2490
    ]
 
2491
 
 
2492
    def run(self, branch=None, revision=None, force=False, merge_type=None,
 
2493
            show_base=False, reprocess=False, remember=False,
 
2494
            uncommitted=False, pull=False,
 
2495
            directory=None,
 
2496
            ):
 
2497
        from bzrlib.tag import _merge_tags_if_possible
 
2498
        if merge_type is None:
 
2499
            merge_type = _mod_merge.Merge3Merger
 
2500
 
 
2501
        if directory is None: directory = u'.'
 
2502
        # XXX: jam 20070225 WorkingTree should be locked before you extract its
 
2503
        #      inventory. Because merge is a mutating operation, it really
 
2504
        #      should be a lock_write() for the whole cmd_merge operation.
 
2505
        #      However, cmd_merge open's its own tree in _merge_helper, which
 
2506
        #      means if we lock here, the later lock_write() will always block.
 
2507
        #      Either the merge helper code should be updated to take a tree,
 
2508
        #      (What about tree.merge_from_branch?)
 
2509
        tree = WorkingTree.open_containing(directory)[0]
 
2510
        change_reporter = delta._ChangeReporter(
 
2511
            unversioned_filter=tree.is_ignored)
 
2512
 
 
2513
        if branch is not None:
 
2514
            try:
 
2515
                reader = bundle.read_bundle_from_url(branch)
 
2516
            except errors.NotABundle:
 
2517
                pass # Continue on considering this url a Branch
 
2518
            else:
 
2519
                conflicts = merge_bundle(reader, tree, not force, merge_type,
 
2520
                                         reprocess, show_base, change_reporter)
 
2521
                if conflicts == 0:
 
2522
                    return 0
 
2523
                else:
 
2524
                    return 1
 
2525
 
 
2526
        if revision is None \
 
2527
                or len(revision) < 1 or revision[0].needs_branch():
 
2528
            branch = self._get_remembered_parent(tree, branch, 'Merging from')
 
2529
 
 
2530
        if revision is None or len(revision) < 1:
 
2531
            if uncommitted:
 
2532
                base = [branch, -1]
 
2533
                other = [branch, None]
 
2534
            else:
 
2535
                base = [None, None]
 
2536
                other = [branch, -1]
 
2537
            other_branch, path = Branch.open_containing(branch)
 
2538
        else:
 
2539
            if uncommitted:
 
2540
                raise errors.BzrCommandError('Cannot use --uncommitted and'
 
2541
                                             ' --revision at the same time.')
 
2542
            branch = revision[0].get_branch() or branch
 
2543
            if len(revision) == 1:
 
2544
                base = [None, None]
 
2545
                other_branch, path = Branch.open_containing(branch)
 
2546
                revno = revision[0].in_history(other_branch).revno
 
2547
                other = [branch, revno]
 
2548
            else:
 
2549
                assert len(revision) == 2
 
2550
                if None in revision:
 
2551
                    raise errors.BzrCommandError(
 
2552
                        "Merge doesn't permit empty revision specifier.")
 
2553
                base_branch, path = Branch.open_containing(branch)
 
2554
                branch1 = revision[1].get_branch() or branch
 
2555
                other_branch, path1 = Branch.open_containing(branch1)
 
2556
                if revision[0].get_branch() is not None:
 
2557
                    # then path was obtained from it, and is None.
 
2558
                    path = path1
 
2559
 
 
2560
                base = [branch, revision[0].in_history(base_branch).revno]
 
2561
                other = [branch1, revision[1].in_history(other_branch).revno]
 
2562
 
 
2563
        if tree.branch.get_parent() is None or remember:
 
2564
            tree.branch.set_parent(other_branch.base)
 
2565
 
 
2566
        # pull tags now... it's a bit inconsistent to do it ahead of copying
 
2567
        # the history but that's done inside the merge code
 
2568
        _merge_tags_if_possible(other_branch, tree.branch)
 
2569
 
 
2570
        if path != "":
 
2571
            interesting_files = [path]
 
2572
        else:
 
2573
            interesting_files = None
 
2574
        pb = ui.ui_factory.nested_progress_bar()
 
2575
        try:
 
2576
            try:
 
2577
                conflict_count = _merge_helper(
 
2578
                    other, base, check_clean=(not force),
 
2579
                    merge_type=merge_type,
 
2580
                    reprocess=reprocess,
 
2581
                    show_base=show_base,
 
2582
                    pull=pull,
 
2583
                    this_dir=directory,
 
2584
                    pb=pb, file_list=interesting_files,
 
2585
                    change_reporter=change_reporter)
 
2586
            finally:
 
2587
                pb.finished()
 
2588
            if conflict_count != 0:
 
2589
                return 1
 
2590
            else:
 
2591
                return 0
 
2592
        except errors.AmbiguousBase, e:
 
2593
            m = ("sorry, bzr can't determine the right merge base yet\n"
 
2594
                 "candidates are:\n  "
 
2595
                 + "\n  ".join(e.bases)
 
2596
                 + "\n"
 
2597
                 "please specify an explicit base with -r,\n"
 
2598
                 "and (if you want) report this to the bzr developers\n")
 
2599
            log_error(m)
 
2600
 
 
2601
    # TODO: move up to common parent; this isn't merge-specific anymore. 
 
2602
    def _get_remembered_parent(self, tree, supplied_location, verb_string):
 
2603
        """Use tree.branch's parent if none was supplied.
 
2604
 
 
2605
        Report if the remembered location was used.
 
2606
        """
 
2607
        if supplied_location is not None:
 
2608
            return supplied_location
 
2609
        stored_location = tree.branch.get_parent()
 
2610
        mutter("%s", stored_location)
 
2611
        if stored_location is None:
 
2612
            raise errors.BzrCommandError("No location specified or remembered")
 
2613
        display_url = urlutils.unescape_for_display(stored_location, self.outf.encoding)
 
2614
        self.outf.write("%s remembered location %s\n" % (verb_string, display_url))
 
2615
        return stored_location
 
2616
 
 
2617
 
 
2618
class cmd_remerge(Command):
 
2619
    """Redo a merge.
 
2620
 
 
2621
    Use this if you want to try a different merge technique while resolving
 
2622
    conflicts.  Some merge techniques are better than others, and remerge 
 
2623
    lets you try different ones on different files.
 
2624
 
 
2625
    The options for remerge have the same meaning and defaults as the ones for
 
2626
    merge.  The difference is that remerge can (only) be run when there is a
 
2627
    pending merge, and it lets you specify particular files.
 
2628
 
 
2629
    Examples:
 
2630
    $ bzr remerge --show-base
 
2631
        Re-do the merge of all conflicted files, and show the base text in
 
2632
        conflict regions, in addition to the usual THIS and OTHER texts.
 
2633
 
 
2634
    $ bzr remerge --merge-type weave --reprocess foobar
 
2635
        Re-do the merge of "foobar", using the weave merge algorithm, with
 
2636
        additional processing to reduce the size of conflict regions.
 
2637
    
 
2638
    The following merge types are available:"""
 
2639
    takes_args = ['file*']
 
2640
    takes_options = ['merge-type', 'reprocess',
 
2641
                     Option('show-base', help="Show base revision text in "
 
2642
                            "conflicts")]
 
2643
 
 
2644
    def run(self, file_list=None, merge_type=None, show_base=False,
 
2645
            reprocess=False):
 
2646
        if merge_type is None:
 
2647
            merge_type = _mod_merge.Merge3Merger
 
2648
        tree, file_list = tree_files(file_list)
 
2649
        tree.lock_write()
 
2650
        try:
 
2651
            parents = tree.get_parent_ids()
 
2652
            if len(parents) != 2:
 
2653
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
2654
                                             " merges.  Not cherrypicking or"
 
2655
                                             " multi-merges.")
 
2656
            repository = tree.branch.repository
 
2657
            base_revision = common_ancestor(parents[0],
 
2658
                                            parents[1], repository)
 
2659
            base_tree = repository.revision_tree(base_revision)
 
2660
            other_tree = repository.revision_tree(parents[1])
 
2661
            interesting_ids = None
 
2662
            new_conflicts = []
 
2663
            conflicts = tree.conflicts()
 
2664
            if file_list is not None:
 
2665
                interesting_ids = set()
 
2666
                for filename in file_list:
 
2667
                    file_id = tree.path2id(filename)
 
2668
                    if file_id is None:
 
2669
                        raise errors.NotVersionedError(filename)
 
2670
                    interesting_ids.add(file_id)
 
2671
                    if tree.kind(file_id) != "directory":
 
2672
                        continue
 
2673
                    
 
2674
                    for name, ie in tree.inventory.iter_entries(file_id):
 
2675
                        interesting_ids.add(ie.file_id)
 
2676
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
2677
            else:
 
2678
                # Remerge only supports resolving contents conflicts
 
2679
                allowed_conflicts = ('text conflict', 'contents conflict')
 
2680
                restore_files = [c.path for c in conflicts
 
2681
                                 if c.typestring in allowed_conflicts]
 
2682
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
2683
            tree.set_conflicts(ConflictList(new_conflicts))
 
2684
            if file_list is not None:
 
2685
                restore_files = file_list
 
2686
            for filename in restore_files:
 
2687
                try:
 
2688
                    restore(tree.abspath(filename))
 
2689
                except errors.NotConflicted:
 
2690
                    pass
 
2691
            conflicts = _mod_merge.merge_inner(
 
2692
                                      tree.branch, other_tree, base_tree,
 
2693
                                      this_tree=tree,
 
2694
                                      interesting_ids=interesting_ids,
 
2695
                                      other_rev_id=parents[1],
 
2696
                                      merge_type=merge_type,
 
2697
                                      show_base=show_base,
 
2698
                                      reprocess=reprocess)
 
2699
        finally:
 
2700
            tree.unlock()
 
2701
        if conflicts > 0:
 
2702
            return 1
 
2703
        else:
 
2704
            return 0
 
2705
 
 
2706
 
 
2707
class cmd_revert(Command):
 
2708
    """Revert files to a previous revision.
 
2709
 
 
2710
    Giving a list of files will revert only those files.  Otherwise, all files
 
2711
    will be reverted.  If the revision is not specified with '--revision', the
 
2712
    last committed revision is used.
 
2713
 
 
2714
    To remove only some changes, without reverting to a prior version, use
 
2715
    merge instead.  For example, "merge . --r-2..-3" will remove the changes
 
2716
    introduced by -2, without affecting the changes introduced by -1.  Or
 
2717
    to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
 
2718
    
 
2719
    By default, any files that have been manually changed will be backed up
 
2720
    first.  (Files changed only by merge are not backed up.)  Backup files have
 
2721
    '.~#~' appended to their name, where # is a number.
 
2722
 
 
2723
    When you provide files, you can use their current pathname or the pathname
 
2724
    from the target revision.  So you can use revert to "undelete" a file by
 
2725
    name.  If you name a directory, all the contents of that directory will be
 
2726
    reverted.
 
2727
    """
 
2728
    takes_options = ['revision', 'no-backup']
 
2729
    takes_args = ['file*']
 
2730
 
 
2731
    def run(self, revision=None, no_backup=False, file_list=None):
 
2732
        if file_list is not None:
 
2733
            if len(file_list) == 0:
 
2734
                raise errors.BzrCommandError("No files specified")
 
2735
        else:
 
2736
            file_list = []
 
2737
        
 
2738
        tree, file_list = tree_files(file_list)
 
2739
        if revision is None:
 
2740
            # FIXME should be tree.last_revision
 
2741
            rev_id = tree.last_revision()
 
2742
        elif len(revision) != 1:
 
2743
            raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
 
2744
        else:
 
2745
            rev_id = revision[0].in_history(tree.branch).rev_id
 
2746
        pb = ui.ui_factory.nested_progress_bar()
 
2747
        try:
 
2748
            tree.revert(file_list, 
 
2749
                        tree.branch.repository.revision_tree(rev_id),
 
2750
                        not no_backup, pb, report_changes=True)
 
2751
        finally:
 
2752
            pb.finished()
 
2753
 
 
2754
 
 
2755
class cmd_assert_fail(Command):
 
2756
    """Test reporting of assertion failures"""
 
2757
    # intended just for use in testing
 
2758
 
 
2759
    hidden = True
 
2760
 
 
2761
    def run(self):
 
2762
        raise AssertionError("always fails")
 
2763
 
 
2764
 
 
2765
class cmd_help(Command):
 
2766
    """Show help on a command or other topic.
 
2767
 
 
2768
    For a list of all available commands, say 'bzr help commands'.
 
2769
    """
 
2770
    takes_options = [Option('long', 'show help on all commands')]
 
2771
    takes_args = ['topic?']
 
2772
    aliases = ['?', '--help', '-?', '-h']
 
2773
    
 
2774
    @display_command
 
2775
    def run(self, topic=None, long=False):
 
2776
        import bzrlib.help
 
2777
        if topic is None and long:
 
2778
            topic = "commands"
 
2779
        bzrlib.help.help(topic)
 
2780
 
 
2781
 
 
2782
class cmd_shell_complete(Command):
 
2783
    """Show appropriate completions for context.
 
2784
 
 
2785
    For a list of all available commands, say 'bzr shell-complete'.
 
2786
    """
 
2787
    takes_args = ['context?']
 
2788
    aliases = ['s-c']
 
2789
    hidden = True
 
2790
    
 
2791
    @display_command
 
2792
    def run(self, context=None):
 
2793
        import shellcomplete
 
2794
        shellcomplete.shellcomplete(context)
 
2795
 
 
2796
 
 
2797
class cmd_fetch(Command):
 
2798
    """Copy in history from another branch but don't merge it.
 
2799
 
 
2800
    This is an internal method used for pull and merge.
 
2801
    """
 
2802
    hidden = True
 
2803
    takes_args = ['from_branch', 'to_branch']
 
2804
    def run(self, from_branch, to_branch):
 
2805
        from bzrlib.fetch import Fetcher
 
2806
        from_b = Branch.open(from_branch)
 
2807
        to_b = Branch.open(to_branch)
 
2808
        Fetcher(to_b, from_b)
 
2809
 
 
2810
 
 
2811
class cmd_missing(Command):
 
2812
    """Show unmerged/unpulled revisions between two branches.
 
2813
 
 
2814
    OTHER_BRANCH may be local or remote.
 
2815
    """
 
2816
    takes_args = ['other_branch?']
 
2817
    takes_options = [Option('reverse', 'Reverse the order of revisions'),
 
2818
                     Option('mine-only', 
 
2819
                            'Display changes in the local branch only'),
 
2820
                     Option('theirs-only', 
 
2821
                            'Display changes in the remote branch only'), 
 
2822
                     'log-format',
 
2823
                     'show-ids',
 
2824
                     'verbose'
 
2825
                     ]
 
2826
    encoding_type = 'replace'
 
2827
 
 
2828
    @display_command
 
2829
    def run(self, other_branch=None, reverse=False, mine_only=False,
 
2830
            theirs_only=False, log_format=None, long=False, short=False, line=False, 
 
2831
            show_ids=False, verbose=False):
 
2832
        from bzrlib.missing import find_unmerged, iter_log_data
 
2833
        from bzrlib.log import log_formatter
 
2834
        local_branch = Branch.open_containing(u".")[0]
 
2835
        parent = local_branch.get_parent()
 
2836
        if other_branch is None:
 
2837
            other_branch = parent
 
2838
            if other_branch is None:
 
2839
                raise errors.BzrCommandError("No peer location known or specified.")
 
2840
            display_url = urlutils.unescape_for_display(parent,
 
2841
                                                        self.outf.encoding)
 
2842
            print "Using last location: " + display_url
 
2843
 
 
2844
        remote_branch = Branch.open(other_branch)
 
2845
        if remote_branch.base == local_branch.base:
 
2846
            remote_branch = local_branch
 
2847
        local_branch.lock_read()
 
2848
        try:
 
2849
            remote_branch.lock_read()
 
2850
            try:
 
2851
                local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
 
2852
                if (log_format is None):
 
2853
                    log_format = log.log_formatter_registry.get_default(
 
2854
                        local_branch)
 
2855
                lf = log_format(to_file=self.outf,
 
2856
                                show_ids=show_ids,
 
2857
                                show_timezone='original')
 
2858
                if reverse is False:
 
2859
                    local_extra.reverse()
 
2860
                    remote_extra.reverse()
 
2861
                if local_extra and not theirs_only:
 
2862
                    print "You have %d extra revision(s):" % len(local_extra)
 
2863
                    for data in iter_log_data(local_extra, local_branch.repository,
 
2864
                                              verbose):
 
2865
                        lf.show(*data)
 
2866
                    printed_local = True
 
2867
                else:
 
2868
                    printed_local = False
 
2869
                if remote_extra and not mine_only:
 
2870
                    if printed_local is True:
 
2871
                        print "\n\n"
 
2872
                    print "You are missing %d revision(s):" % len(remote_extra)
 
2873
                    for data in iter_log_data(remote_extra, remote_branch.repository, 
 
2874
                                              verbose):
 
2875
                        lf.show(*data)
 
2876
                if not remote_extra and not local_extra:
 
2877
                    status_code = 0
 
2878
                    print "Branches are up to date."
 
2879
                else:
 
2880
                    status_code = 1
 
2881
            finally:
 
2882
                remote_branch.unlock()
 
2883
        finally:
 
2884
            local_branch.unlock()
 
2885
        if not status_code and parent is None and other_branch is not None:
 
2886
            local_branch.lock_write()
 
2887
            try:
 
2888
                # handle race conditions - a parent might be set while we run.
 
2889
                if local_branch.get_parent() is None:
 
2890
                    local_branch.set_parent(remote_branch.base)
 
2891
            finally:
 
2892
                local_branch.unlock()
 
2893
        return status_code
 
2894
 
 
2895
 
 
2896
class cmd_plugins(Command):
 
2897
    """List plugins"""
 
2898
    hidden = True
 
2899
    @display_command
 
2900
    def run(self):
 
2901
        import bzrlib.plugin
 
2902
        from inspect import getdoc
 
2903
        for name, plugin in bzrlib.plugin.all_plugins().items():
 
2904
            if getattr(plugin, '__path__', None) is not None:
 
2905
                print plugin.__path__[0]
 
2906
            elif getattr(plugin, '__file__', None) is not None:
 
2907
                print plugin.__file__
 
2908
            else:
 
2909
                print repr(plugin)
 
2910
                
 
2911
            d = getdoc(plugin)
 
2912
            if d:
 
2913
                print '\t', d.split('\n')[0]
 
2914
 
 
2915
 
 
2916
class cmd_testament(Command):
 
2917
    """Show testament (signing-form) of a revision."""
 
2918
    takes_options = ['revision', 
 
2919
                     Option('long', help='Produce long-format testament'), 
 
2920
                     Option('strict', help='Produce a strict-format'
 
2921
                            ' testament')]
 
2922
    takes_args = ['branch?']
 
2923
    @display_command
 
2924
    def run(self, branch=u'.', revision=None, long=False, strict=False):
 
2925
        from bzrlib.testament import Testament, StrictTestament
 
2926
        if strict is True:
 
2927
            testament_class = StrictTestament
 
2928
        else:
 
2929
            testament_class = Testament
 
2930
        b = WorkingTree.open_containing(branch)[0].branch
 
2931
        b.lock_read()
 
2932
        try:
 
2933
            if revision is None:
 
2934
                rev_id = b.last_revision()
 
2935
            else:
 
2936
                rev_id = revision[0].in_history(b).rev_id
 
2937
            t = testament_class.from_revision(b.repository, rev_id)
 
2938
            if long:
 
2939
                sys.stdout.writelines(t.as_text_lines())
 
2940
            else:
 
2941
                sys.stdout.write(t.as_short_text())
 
2942
        finally:
 
2943
            b.unlock()
 
2944
 
 
2945
 
 
2946
class cmd_annotate(Command):
 
2947
    """Show the origin of each line in a file.
 
2948
 
 
2949
    This prints out the given file with an annotation on the left side
 
2950
    indicating which revision, author and date introduced the change.
 
2951
 
 
2952
    If the origin is the same for a run of consecutive lines, it is 
 
2953
    shown only at the top, unless the --all option is given.
 
2954
    """
 
2955
    # TODO: annotate directories; showing when each file was last changed
 
2956
    # TODO: if the working copy is modified, show annotations on that 
 
2957
    #       with new uncommitted lines marked
 
2958
    aliases = ['ann', 'blame', 'praise']
 
2959
    takes_args = ['filename']
 
2960
    takes_options = [Option('all', help='show annotations on all lines'),
 
2961
                     Option('long', help='show date in annotations'),
 
2962
                     'revision',
 
2963
                     'show-ids',
 
2964
                     ]
 
2965
 
 
2966
    @display_command
 
2967
    def run(self, filename, all=False, long=False, revision=None,
 
2968
            show_ids=False):
 
2969
        from bzrlib.annotate import annotate_file
 
2970
        tree, relpath = WorkingTree.open_containing(filename)
 
2971
        branch = tree.branch
 
2972
        branch.lock_read()
 
2973
        try:
 
2974
            if revision is None:
 
2975
                revision_id = branch.last_revision()
 
2976
            elif len(revision) != 1:
 
2977
                raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
 
2978
            else:
 
2979
                revision_id = revision[0].in_history(branch).rev_id
 
2980
            file_id = tree.path2id(relpath)
 
2981
            tree = branch.repository.revision_tree(revision_id)
 
2982
            file_version = tree.inventory[file_id].revision
 
2983
            annotate_file(branch, file_version, file_id, long, all, sys.stdout,
 
2984
                          show_ids=show_ids)
 
2985
        finally:
 
2986
            branch.unlock()
 
2987
 
 
2988
 
 
2989
class cmd_re_sign(Command):
 
2990
    """Create a digital signature for an existing revision."""
 
2991
    # TODO be able to replace existing ones.
 
2992
 
 
2993
    hidden = True # is this right ?
 
2994
    takes_args = ['revision_id*']
 
2995
    takes_options = ['revision']
 
2996
    
 
2997
    def run(self, revision_id_list=None, revision=None):
 
2998
        import bzrlib.gpg as gpg
 
2999
        if revision_id_list is not None and revision is not None:
 
3000
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
 
3001
        if revision_id_list is None and revision is None:
 
3002
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
 
3003
        b = WorkingTree.open_containing(u'.')[0].branch
 
3004
        gpg_strategy = gpg.GPGStrategy(b.get_config())
 
3005
        if revision_id_list is not None:
 
3006
            for revision_id in revision_id_list:
 
3007
                b.repository.sign_revision(revision_id, gpg_strategy)
 
3008
        elif revision is not None:
 
3009
            if len(revision) == 1:
 
3010
                revno, rev_id = revision[0].in_history(b)
 
3011
                b.repository.sign_revision(rev_id, gpg_strategy)
 
3012
            elif len(revision) == 2:
 
3013
                # are they both on rh- if so we can walk between them
 
3014
                # might be nice to have a range helper for arbitrary
 
3015
                # revision paths. hmm.
 
3016
                from_revno, from_revid = revision[0].in_history(b)
 
3017
                to_revno, to_revid = revision[1].in_history(b)
 
3018
                if to_revid is None:
 
3019
                    to_revno = b.revno()
 
3020
                if from_revno is None or to_revno is None:
 
3021
                    raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
 
3022
                for revno in range(from_revno, to_revno + 1):
 
3023
                    b.repository.sign_revision(b.get_rev_id(revno), 
 
3024
                                               gpg_strategy)
 
3025
            else:
 
3026
                raise errors.BzrCommandError('Please supply either one revision, or a range.')
 
3027
 
 
3028
 
 
3029
class cmd_bind(Command):
 
3030
    """Convert the current branch into a checkout of the supplied branch.
 
3031
 
 
3032
    Once converted into a checkout, commits must succeed on the master branch
 
3033
    before they will be applied to the local branch.
 
3034
 
 
3035
    See "help checkouts" for more information on checkouts.
 
3036
    """
 
3037
 
 
3038
    takes_args = ['location?']
 
3039
    takes_options = []
 
3040
 
 
3041
    def run(self, location=None):
 
3042
        b, relpath = Branch.open_containing(u'.')
 
3043
        if location is None:
 
3044
            try:
 
3045
                location = b.get_old_bound_location()
 
3046
            except errors.UpgradeRequired:
 
3047
                raise errors.BzrCommandError('No location supplied.  '
 
3048
                    'This format does not remember old locations.')
 
3049
            else:
 
3050
                if location is None:
 
3051
                    raise errors.BzrCommandError('No location supplied and no '
 
3052
                        'previous location known')
 
3053
        b_other = Branch.open(location)
 
3054
        try:
 
3055
            b.bind(b_other)
 
3056
        except errors.DivergedBranches:
 
3057
            raise errors.BzrCommandError('These branches have diverged.'
 
3058
                                         ' Try merging, and then bind again.')
 
3059
 
 
3060
 
 
3061
class cmd_unbind(Command):
 
3062
    """Convert the current checkout into a regular branch.
 
3063
 
 
3064
    After unbinding, the local branch is considered independent and subsequent
 
3065
    commits will be local only.
 
3066
 
 
3067
    See "help checkouts" for more information on checkouts.
 
3068
    """
 
3069
 
 
3070
    takes_args = []
 
3071
    takes_options = []
 
3072
 
 
3073
    def run(self):
 
3074
        b, relpath = Branch.open_containing(u'.')
 
3075
        if not b.unbind():
 
3076
            raise errors.BzrCommandError('Local branch is not bound')
 
3077
 
 
3078
 
 
3079
class cmd_uncommit(Command):
 
3080
    """Remove the last committed revision.
 
3081
 
 
3082
    --verbose will print out what is being removed.
 
3083
    --dry-run will go through all the motions, but not actually
 
3084
    remove anything.
 
3085
    
 
3086
    In the future, uncommit will create a revision bundle, which can then
 
3087
    be re-applied.
 
3088
    """
 
3089
 
 
3090
    # TODO: jam 20060108 Add an option to allow uncommit to remove
 
3091
    # unreferenced information in 'branch-as-repository' branches.
 
3092
    # TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
 
3093
    # information in shared branches as well.
 
3094
    takes_options = ['verbose', 'revision',
 
3095
                    Option('dry-run', help='Don\'t actually make changes'),
 
3096
                    Option('force', help='Say yes to all questions.')]
 
3097
    takes_args = ['location?']
 
3098
    aliases = []
 
3099
 
 
3100
    def run(self, location=None,
 
3101
            dry_run=False, verbose=False,
 
3102
            revision=None, force=False):
 
3103
        from bzrlib.log import log_formatter, show_log
 
3104
        import sys
 
3105
        from bzrlib.uncommit import uncommit
 
3106
 
 
3107
        if location is None:
 
3108
            location = u'.'
 
3109
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
3110
        try:
 
3111
            tree = control.open_workingtree()
 
3112
            b = tree.branch
 
3113
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
3114
            tree = None
 
3115
            b = control.open_branch()
 
3116
 
 
3117
        rev_id = None
 
3118
        if revision is None:
 
3119
            revno = b.revno()
 
3120
        else:
 
3121
            # 'bzr uncommit -r 10' actually means uncommit
 
3122
            # so that the final tree is at revno 10.
 
3123
            # but bzrlib.uncommit.uncommit() actually uncommits
 
3124
            # the revisions that are supplied.
 
3125
            # So we need to offset it by one
 
3126
            revno = revision[0].in_history(b).revno+1
 
3127
 
 
3128
        if revno <= b.revno():
 
3129
            rev_id = b.get_rev_id(revno)
 
3130
        if rev_id is None:
 
3131
            self.outf.write('No revisions to uncommit.\n')
 
3132
            return 1
 
3133
 
 
3134
        lf = log_formatter('short',
 
3135
                           to_file=self.outf,
 
3136
                           show_timezone='original')
 
3137
 
 
3138
        show_log(b,
 
3139
                 lf,
 
3140
                 verbose=False,
 
3141
                 direction='forward',
 
3142
                 start_revision=revno,
 
3143
                 end_revision=b.revno())
 
3144
 
 
3145
        if dry_run:
 
3146
            print 'Dry-run, pretending to remove the above revisions.'
 
3147
            if not force:
 
3148
                val = raw_input('Press <enter> to continue')
 
3149
        else:
 
3150
            print 'The above revision(s) will be removed.'
 
3151
            if not force:
 
3152
                val = raw_input('Are you sure [y/N]? ')
 
3153
                if val.lower() not in ('y', 'yes'):
 
3154
                    print 'Canceled'
 
3155
                    return 0
 
3156
 
 
3157
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
 
3158
                revno=revno)
 
3159
 
 
3160
 
 
3161
class cmd_break_lock(Command):
 
3162
    """Break a dead lock on a repository, branch or working directory.
 
3163
 
 
3164
    CAUTION: Locks should only be broken when you are sure that the process
 
3165
    holding the lock has been stopped.
 
3166
 
 
3167
    You can get information on what locks are open via the 'bzr info' command.
 
3168
    
 
3169
    example:
 
3170
        bzr break-lock
 
3171
    """
 
3172
    takes_args = ['location?']
 
3173
 
 
3174
    def run(self, location=None, show=False):
 
3175
        if location is None:
 
3176
            location = u'.'
 
3177
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
3178
        try:
 
3179
            control.break_lock()
 
3180
        except NotImplementedError:
 
3181
            pass
 
3182
        
 
3183
 
 
3184
class cmd_wait_until_signalled(Command):
 
3185
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
3186
 
 
3187
    This just prints a line to signal when it is ready, then blocks on stdin.
 
3188
    """
 
3189
 
 
3190
    hidden = True
 
3191
 
 
3192
    def run(self):
 
3193
        sys.stdout.write("running\n")
 
3194
        sys.stdout.flush()
 
3195
        sys.stdin.readline()
 
3196
 
 
3197
 
 
3198
class cmd_serve(Command):
 
3199
    """Run the bzr server."""
 
3200
 
 
3201
    aliases = ['server']
 
3202
 
 
3203
    takes_options = [
 
3204
        Option('inet',
 
3205
               help='serve on stdin/out for use from inetd or sshd'),
 
3206
        Option('port',
 
3207
               help='listen for connections on nominated port of the form '
 
3208
                    '[hostname:]portnumber. Passing 0 as the port number will '
 
3209
                    'result in a dynamically allocated port. Default port is '
 
3210
                    '4155.',
 
3211
               type=str),
 
3212
        Option('directory',
 
3213
               help='serve contents of directory',
 
3214
               type=unicode),
 
3215
        Option('allow-writes',
 
3216
               help='By default the server is a readonly server. Supplying '
 
3217
                    '--allow-writes enables write access to the contents of '
 
3218
                    'the served directory and below. '
 
3219
                ),
 
3220
        ]
 
3221
 
 
3222
    def run(self, port=None, inet=False, directory=None, allow_writes=False):
 
3223
        from bzrlib.transport import smart
 
3224
        from bzrlib.transport import get_transport
 
3225
        if directory is None:
 
3226
            directory = os.getcwd()
 
3227
        url = urlutils.local_path_to_url(directory)
 
3228
        if not allow_writes:
 
3229
            url = 'readonly+' + url
 
3230
        t = get_transport(url)
 
3231
        if inet:
 
3232
            server = smart.SmartServerPipeStreamMedium(sys.stdin, sys.stdout, t)
 
3233
        else:
 
3234
            if port is None:
 
3235
                port = smart.BZR_DEFAULT_PORT
 
3236
                host = '127.0.0.1'
 
3237
            else:
 
3238
                if ':' in port:
 
3239
                    host, port = port.split(':')
 
3240
                else:
 
3241
                    host = '127.0.0.1'
 
3242
                port = int(port)
 
3243
            server = smart.SmartTCPServer(t, host=host, port=port)
 
3244
            print 'listening on port: ', server.port
 
3245
            sys.stdout.flush()
 
3246
        server.serve()
 
3247
 
 
3248
class cmd_join(Command):
 
3249
    """Combine a subtree into its containing tree.
 
3250
    
 
3251
    This command is for experimental use only.  It requires the target tree
 
3252
    to be in dirstate-with-subtree format, which cannot be converted into
 
3253
    earlier formats.
 
3254
 
 
3255
    The TREE argument should be an independent tree, inside another tree, but
 
3256
    not part of it.  (Such trees can be produced by "bzr split", but also by
 
3257
    running "bzr branch" with the target inside a tree.)
 
3258
 
 
3259
    The result is a combined tree, with the subtree no longer an independant
 
3260
    part.  This is marked as a merge of the subtree into the containing tree,
 
3261
    and all history is preserved.
 
3262
 
 
3263
    If --reference is specified, the subtree retains its independence.  It can
 
3264
    be branched by itself, and can be part of multiple projects at the same
 
3265
    time.  But operations performed in the containing tree, such as commit
 
3266
    and merge, will recurse into the subtree.
 
3267
    """
 
3268
 
 
3269
    takes_args = ['tree']
 
3270
    takes_options = [Option('reference', 'join by reference')]
 
3271
    hidden = True
 
3272
 
 
3273
    def run(self, tree, reference=False):
 
3274
        sub_tree = WorkingTree.open(tree)
 
3275
        parent_dir = osutils.dirname(sub_tree.basedir)
 
3276
        containing_tree = WorkingTree.open_containing(parent_dir)[0]
 
3277
        repo = containing_tree.branch.repository
 
3278
        if not repo.supports_rich_root():
 
3279
            raise errors.BzrCommandError(
 
3280
                "Can't join trees because %s doesn't support rich root data.\n"
 
3281
                "You can use bzr upgrade on the repository."
 
3282
                % (repo,))
 
3283
        if reference:
 
3284
            try:
 
3285
                containing_tree.add_reference(sub_tree)
 
3286
            except errors.BadReferenceTarget, e:
 
3287
                # XXX: Would be better to just raise a nicely printable
 
3288
                # exception from the real origin.  Also below.  mbp 20070306
 
3289
                raise errors.BzrCommandError("Cannot join %s.  %s" %
 
3290
                                             (tree, e.reason))
 
3291
        else:
 
3292
            try:
 
3293
                containing_tree.subsume(sub_tree)
 
3294
            except errors.BadSubsumeSource, e:
 
3295
                raise errors.BzrCommandError("Cannot join %s.  %s" % 
 
3296
                                             (tree, e.reason))
 
3297
 
 
3298
 
 
3299
class cmd_split(Command):
 
3300
    """Split a tree into two trees.
 
3301
 
 
3302
    This command is for experimental use only.  It requires the target tree
 
3303
    to be in dirstate-with-subtree format, which cannot be converted into
 
3304
    earlier formats.
 
3305
 
 
3306
    The TREE argument should be a subdirectory of a working tree.  That
 
3307
    subdirectory will be converted into an independent tree, with its own
 
3308
    branch.  Commits in the top-level tree will not apply to the new subtree.
 
3309
    If you want that behavior, do "bzr join --reference TREE".
 
3310
 
 
3311
    To undo this operation, do "bzr join TREE".
 
3312
    """
 
3313
 
 
3314
    takes_args = ['tree']
 
3315
 
 
3316
    hidden = True
 
3317
 
 
3318
    def run(self, tree):
 
3319
        containing_tree, subdir = WorkingTree.open_containing(tree)
 
3320
        sub_id = containing_tree.path2id(subdir)
 
3321
        if sub_id is None:
 
3322
            raise errors.NotVersionedError(subdir)
 
3323
        try:
 
3324
            containing_tree.extract(sub_id)
 
3325
        except errors.RootNotRich:
 
3326
            raise errors.UpgradeRequired(containing_tree.branch.base)
 
3327
 
 
3328
 
 
3329
 
 
3330
class cmd_merge_directive(Command):
 
3331
    """Generate a merge directive for auto-merge tools.
 
3332
 
 
3333
    A directive requests a merge to be performed, and also provides all the
 
3334
    information necessary to do so.  This means it must either include a
 
3335
    revision bundle, or the location of a branch containing the desired
 
3336
    revision.
 
3337
 
 
3338
    A submit branch (the location to merge into) must be supplied the first
 
3339
    time the command is issued.  After it has been supplied once, it will
 
3340
    be remembered as the default.
 
3341
 
 
3342
    A public branch is optional if a revision bundle is supplied, but required
 
3343
    if --diff or --plain is specified.  It will be remembered as the default
 
3344
    after the first use.
 
3345
    """
 
3346
 
 
3347
    takes_args = ['submit_branch?', 'public_branch?']
 
3348
 
 
3349
    takes_options = [
 
3350
        RegistryOption.from_kwargs('patch-type',
 
3351
            'The type of patch to include in the directive',
 
3352
            title='Patch type', value_switches=True, enum_switch=False,
 
3353
            bundle='Bazaar revision bundle (default)',
 
3354
            diff='Normal unified diff',
 
3355
            plain='No patch, just directive'),
 
3356
        Option('sign', help='GPG-sign the directive'), 'revision',
 
3357
        Option('mail-to', type=str,
 
3358
            help='Instead of printing the directive, email to this address'),
 
3359
        Option('message', type=str, short_name='m',
 
3360
            help='Message to use when committing this merge')
 
3361
        ]
 
3362
 
 
3363
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
 
3364
            sign=False, revision=None, mail_to=None, message=None):
 
3365
        if patch_type == 'plain':
 
3366
            patch_type = None
 
3367
        branch = Branch.open('.')
 
3368
        stored_submit_branch = branch.get_submit_branch()
 
3369
        if submit_branch is None:
 
3370
            submit_branch = stored_submit_branch
 
3371
        else:
 
3372
            if stored_submit_branch is None:
 
3373
                branch.set_submit_branch(submit_branch)
 
3374
        if submit_branch is None:
 
3375
            submit_branch = branch.get_parent()
 
3376
        if submit_branch is None:
 
3377
            raise errors.BzrCommandError('No submit branch specified or known')
 
3378
 
 
3379
        stored_public_branch = branch.get_public_branch()
 
3380
        if public_branch is None:
 
3381
            public_branch = stored_public_branch
 
3382
        elif stored_public_branch is None:
 
3383
            branch.set_public_branch(public_branch)
 
3384
        if patch_type != "bundle" and public_branch is None:
 
3385
            raise errors.BzrCommandError('No public branch specified or'
 
3386
                                         ' known')
 
3387
        if revision is not None:
 
3388
            if len(revision) != 1:
 
3389
                raise errors.BzrCommandError('bzr merge-directive takes '
 
3390
                    'exactly one revision identifier')
 
3391
            else:
 
3392
                revision_id = revision[0].in_history(branch).rev_id
 
3393
        else:
 
3394
            revision_id = branch.last_revision()
 
3395
        directive = merge_directive.MergeDirective.from_objects(
 
3396
            branch.repository, revision_id, time.time(),
 
3397
            osutils.local_time_offset(), submit_branch,
 
3398
            public_branch=public_branch, patch_type=patch_type,
 
3399
            message=message)
 
3400
        if mail_to is None:
 
3401
            if sign:
 
3402
                self.outf.write(directive.to_signed(branch))
 
3403
            else:
 
3404
                self.outf.writelines(directive.to_lines())
 
3405
        else:
 
3406
            message = directive.to_email(mail_to, branch, sign)
 
3407
            s = smtplib.SMTP()
 
3408
            server = branch.get_config().get_user_option('smtp_server')
 
3409
            if not server:
 
3410
                server = 'localhost'
 
3411
            s.connect(server)
 
3412
            s.sendmail(message['From'], message['To'], message.as_string())
 
3413
 
 
3414
 
 
3415
class cmd_tag(Command):
 
3416
    """Create a tag naming a revision.
 
3417
    
 
3418
    Tags give human-meaningful names to revisions.  Commands that take a -r
 
3419
    (--revision) option can be given -rtag:X, where X is any previously
 
3420
    created tag.
 
3421
 
 
3422
    Tags are stored in the branch.  Tags are copied from one branch to another
 
3423
    along when you branch, push, pull or merge.
 
3424
 
 
3425
    It is an error to give a tag name that already exists unless you pass 
 
3426
    --force, in which case the tag is moved to point to the new revision.
 
3427
    """
 
3428
 
 
3429
    takes_args = ['tag_name']
 
3430
    takes_options = [
 
3431
        Option('delete',
 
3432
            help='Delete this tag rather than placing it.',
 
3433
            ),
 
3434
        Option('directory',
 
3435
            help='Branch in which to place the tag.',
 
3436
            short_name='d',
 
3437
            type=unicode,
 
3438
            ),
 
3439
        Option('force',
 
3440
            help='Replace existing tags',
 
3441
            ),
 
3442
        'revision',
 
3443
        ]
 
3444
 
 
3445
    def run(self, tag_name,
 
3446
            delete=None,
 
3447
            directory='.',
 
3448
            force=None,
 
3449
            revision=None,
 
3450
            ):
 
3451
        branch, relpath = Branch.open_containing(directory)
 
3452
        branch.lock_write()
 
3453
        try:
 
3454
            if delete:
 
3455
                branch.tags.delete_tag(tag_name)
 
3456
                self.outf.write('Deleted tag %s.\n' % tag_name)
 
3457
            else:
 
3458
                if revision:
 
3459
                    if len(revision) != 1:
 
3460
                        raise errors.BzrCommandError(
 
3461
                            "Tags can only be placed on a single revision, "
 
3462
                            "not on a range")
 
3463
                    revision_id = revision[0].in_history(branch).rev_id
 
3464
                else:
 
3465
                    revision_id = branch.last_revision()
 
3466
                if (not force) and branch.tags.has_tag(tag_name):
 
3467
                    raise errors.TagAlreadyExists(tag_name)
 
3468
                branch.tags.set_tag(tag_name, revision_id)
 
3469
                self.outf.write('Created tag %s.\n' % tag_name)
 
3470
        finally:
 
3471
            branch.unlock()
 
3472
 
 
3473
 
 
3474
class cmd_tags(Command):
 
3475
    """List tags.
 
3476
 
 
3477
    This tag shows a table of tag names and the revisions they reference.
 
3478
    """
 
3479
 
 
3480
    takes_options = [
 
3481
        Option('directory',
 
3482
            help='Branch whose tags should be displayed',
 
3483
            short_name='d',
 
3484
            type=unicode,
 
3485
            ),
 
3486
    ]
 
3487
 
 
3488
    @display_command
 
3489
    def run(self,
 
3490
            directory='.',
 
3491
            ):
 
3492
        branch, relpath = Branch.open_containing(directory)
 
3493
        for tag_name, target in sorted(branch.tags.get_tag_dict().items()):
 
3494
            self.outf.write('%-20s %s\n' % (tag_name, target))
 
3495
 
 
3496
 
 
3497
# command-line interpretation helper for merge-related commands
 
3498
def _merge_helper(other_revision, base_revision,
 
3499
                  check_clean=True, ignore_zero=False,
 
3500
                  this_dir=None, backup_files=False,
 
3501
                  merge_type=None,
 
3502
                  file_list=None, show_base=False, reprocess=False,
 
3503
                  pull=False,
 
3504
                  pb=DummyProgress(),
 
3505
                  change_reporter=None):
 
3506
    """Merge changes into a tree.
 
3507
 
 
3508
    base_revision
 
3509
        list(path, revno) Base for three-way merge.  
 
3510
        If [None, None] then a base will be automatically determined.
 
3511
    other_revision
 
3512
        list(path, revno) Other revision for three-way merge.
 
3513
    this_dir
 
3514
        Directory to merge changes into; '.' by default.
 
3515
    check_clean
 
3516
        If true, this_dir must have no uncommitted changes before the
 
3517
        merge begins.
 
3518
    ignore_zero - If true, suppress the "zero conflicts" message when 
 
3519
        there are no conflicts; should be set when doing something we expect
 
3520
        to complete perfectly.
 
3521
    file_list - If supplied, merge only changes to selected files.
 
3522
 
 
3523
    All available ancestors of other_revision and base_revision are
 
3524
    automatically pulled into the branch.
 
3525
 
 
3526
    The revno may be -1 to indicate the last revision on the branch, which is
 
3527
    the typical case.
 
3528
 
 
3529
    This function is intended for use from the command line; programmatic
 
3530
    clients might prefer to call merge.merge_inner(), which has less magic 
 
3531
    behavior.
 
3532
    """
 
3533
    # Loading it late, so that we don't always have to import bzrlib.merge
 
3534
    if merge_type is None:
 
3535
        merge_type = _mod_merge.Merge3Merger
 
3536
    if this_dir is None:
 
3537
        this_dir = u'.'
 
3538
    this_tree = WorkingTree.open_containing(this_dir)[0]
 
3539
    if show_base and not merge_type is _mod_merge.Merge3Merger:
 
3540
        raise errors.BzrCommandError("Show-base is not supported for this merge"
 
3541
                                     " type. %s" % merge_type)
 
3542
    if reprocess and not merge_type.supports_reprocess:
 
3543
        raise errors.BzrCommandError("Conflict reduction is not supported for merge"
 
3544
                                     " type %s." % merge_type)
 
3545
    if reprocess and show_base:
 
3546
        raise errors.BzrCommandError("Cannot do conflict reduction and show base.")
 
3547
    # TODO: jam 20070226 We should really lock these trees earlier. However, we
 
3548
    #       only want to take out a lock_tree_write() if we don't have to pull
 
3549
    #       any ancestry. But merge might fetch ancestry in the middle, in
 
3550
    #       which case we would need a lock_write().
 
3551
    #       Because we cannot upgrade locks, for now we live with the fact that
 
3552
    #       the tree will be locked multiple times during a merge. (Maybe
 
3553
    #       read-only some of the time, but it means things will get read
 
3554
    #       multiple times.)
 
3555
    try:
 
3556
        merger = _mod_merge.Merger(this_tree.branch, this_tree=this_tree,
 
3557
                                   pb=pb, change_reporter=change_reporter)
 
3558
        merger.pp = ProgressPhase("Merge phase", 5, pb)
 
3559
        merger.pp.next_phase()
 
3560
        merger.check_basis(check_clean)
 
3561
        merger.set_other(other_revision)
 
3562
        merger.pp.next_phase()
 
3563
        merger.set_base(base_revision)
 
3564
        if merger.base_rev_id == merger.other_rev_id:
 
3565
            note('Nothing to do.')
 
3566
            return 0
 
3567
        if file_list is None:
 
3568
            if pull and merger.base_rev_id == merger.this_rev_id:
 
3569
                # FIXME: deduplicate with pull
 
3570
                result = merger.this_tree.pull(merger.this_branch,
 
3571
                        False, merger.other_rev_id)
 
3572
                if result.old_revid == result.new_revid:
 
3573
                    note('No revisions to pull.')
 
3574
                else:
 
3575
                    note('Now on revision %d.' % result.new_revno)
 
3576
                return 0
 
3577
        merger.backup_files = backup_files
 
3578
        merger.merge_type = merge_type 
 
3579
        merger.set_interesting_files(file_list)
 
3580
        merger.show_base = show_base 
 
3581
        merger.reprocess = reprocess
 
3582
        conflicts = merger.do_merge()
 
3583
        if file_list is None:
 
3584
            merger.set_pending()
 
3585
    finally:
 
3586
        pb.clear()
 
3587
    return conflicts
 
3588
 
 
3589
 
 
3590
# Compatibility
 
3591
merge = _merge_helper
 
3592
 
 
3593
 
 
3594
# these get imported and then picked up by the scan for cmd_*
 
3595
# TODO: Some more consistent way to split command definitions across files;
 
3596
# we do need to load at least some information about them to know of 
 
3597
# aliases.  ideally we would avoid loading the implementation until the
 
3598
# details were needed.
 
3599
from bzrlib.cmd_version_info import cmd_version_info
 
3600
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
3601
from bzrlib.bundle.commands import cmd_bundle_revisions
 
3602
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
3603
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
 
3604
        cmd_weave_plan_merge, cmd_weave_merge_text