← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Robert Collins
  • Date: 2007-03-07 01:14:11 UTC
  • mfrom: (2321 +trunk)
  • mto: (2321.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 2322.
  • Revision ID: robertc@robertcollins.net-20070307011411-0cmmc8atx67v3nv7
Merge bzr.dev.

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