← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: John Arbash Meinel
  • Date: 2007-04-12 21:18:29 UTC
  • mto: This revision was merged to the branch mainline in revision 2415.
  • Revision ID: john@arbash-meinel.com-20070412211829-dduwktk8in0e6zpl
Clean up test ordering

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