/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

Functional get_record_stream interface tests covering full interface.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2004, 2005, 2006, 2007 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
"""builtin bzr commands"""
 
18
 
 
19
import os
 
20
from StringIO import StringIO
 
21
 
 
22
from bzrlib.lazy_import import lazy_import
 
23
lazy_import(globals(), """
 
24
import codecs
 
25
import sys
 
26
import time
 
27
 
 
28
import bzrlib
 
29
from bzrlib import (
 
30
    bugtracker,
 
31
    bundle,
 
32
    bzrdir,
 
33
    delta,
 
34
    config,
 
35
    errors,
 
36
    globbing,
 
37
    ignores,
 
38
    log,
 
39
    merge as _mod_merge,
 
40
    merge_directive,
 
41
    osutils,
 
42
    reconfigure,
 
43
    revision as _mod_revision,
 
44
    symbol_versioning,
 
45
    transport,
 
46
    tree as _mod_tree,
 
47
    ui,
 
48
    urlutils,
 
49
    )
 
50
from bzrlib.branch import Branch
 
51
from bzrlib.conflicts import ConflictList
 
52
from bzrlib.revisionspec import RevisionSpec
 
53
from bzrlib.smtp_connection import SMTPConnection
 
54
from bzrlib.workingtree import WorkingTree
 
55
""")
 
56
 
 
57
from bzrlib.commands import Command, display_command
 
58
from bzrlib.option import ListOption, Option, RegistryOption, custom_help
 
59
from bzrlib.trace import mutter, note, 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 on the
 
147
    changes to file texts, use 'bzr diff'.
 
148
    
 
149
    Note that --short or -S gives status flags for each item, similar
 
150
    to Subversion's status command. To get output similar to svn -q,
 
151
    use bzr -SV.
 
152
 
 
153
    If no arguments are specified, the status of the entire working
 
154
    directory is shown.  Otherwise, only the status of the specified
 
155
    files or directories is reported.  If a directory is given, status
 
156
    is reported for everything inside that directory.
 
157
 
 
158
    If a revision argument is given, the status is calculated against
 
159
    that revision, or between two revisions if two are provided.
 
160
    """
 
161
    
 
162
    # TODO: --no-recurse, --recurse options
 
163
    
 
164
    takes_args = ['file*']
 
165
    takes_options = ['show-ids', 'revision', 'change',
 
166
                     Option('short', help='Use short status indicators.',
 
167
                            short_name='S'),
 
168
                     Option('versioned', help='Only show versioned files.',
 
169
                            short_name='V'),
 
170
                     Option('no-pending', help='Don\'t show pending merges.',
 
171
                           ),
 
172
                     ]
 
173
    aliases = ['st', 'stat']
 
174
 
 
175
    encoding_type = 'replace'
 
176
    _see_also = ['diff', 'revert', 'status-flags']
 
177
    
 
178
    @display_command
 
179
    def run(self, show_ids=False, file_list=None, revision=None, short=False,
 
180
            versioned=False, no_pending=False):
 
181
        from bzrlib.status import show_tree_status
 
182
 
 
183
        if revision and len(revision) > 2:
 
184
            raise errors.BzrCommandError('bzr status --revision takes exactly'
 
185
                                         ' one or two revision specifiers')
 
186
 
 
187
        tree, file_list = tree_files(file_list)
 
188
            
 
189
        show_tree_status(tree, show_ids=show_ids,
 
190
                         specific_files=file_list, revision=revision,
 
191
                         to_file=self.outf, short=short, versioned=versioned,
 
192
                         show_pending=not no_pending)
 
193
 
 
194
 
 
195
class cmd_cat_revision(Command):
 
196
    """Write out metadata for a revision.
 
197
    
 
198
    The revision to print can either be specified by a specific
 
199
    revision identifier, or you can use --revision.
 
200
    """
 
201
 
 
202
    hidden = True
 
203
    takes_args = ['revision_id?']
 
204
    takes_options = ['revision']
 
205
    # cat-revision is more for frontends so should be exact
 
206
    encoding = 'strict'
 
207
    
 
208
    @display_command
 
209
    def run(self, revision_id=None, revision=None):
 
210
        if revision_id is not None and revision is not None:
 
211
            raise errors.BzrCommandError('You can only supply one of'
 
212
                                         ' revision_id or --revision')
 
213
        if revision_id is None and revision is None:
 
214
            raise errors.BzrCommandError('You must supply either'
 
215
                                         ' --revision or a revision_id')
 
216
        b = WorkingTree.open_containing(u'.')[0].branch
 
217
 
 
218
        # TODO: jam 20060112 should cat-revision always output utf-8?
 
219
        if revision_id is not None:
 
220
            revision_id = osutils.safe_revision_id(revision_id, warn=False)
 
221
            self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
 
222
        elif revision is not None:
 
223
            for rev in revision:
 
224
                if rev is None:
 
225
                    raise errors.BzrCommandError('You cannot specify a NULL'
 
226
                                                 ' revision.')
 
227
                rev_id = rev.as_revision_id(b)
 
228
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
 
229
    
 
230
 
 
231
class cmd_remove_tree(Command):
 
232
    """Remove the working tree from a given branch/checkout.
 
233
 
 
234
    Since a lightweight checkout is little more than a working tree
 
235
    this will refuse to run against one.
 
236
 
 
237
    To re-create the working tree, use "bzr checkout".
 
238
    """
 
239
    _see_also = ['checkout', 'working-trees']
 
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
    _see_also = ['info']
 
270
    takes_args = ['location?']
 
271
 
 
272
    @display_command
 
273
    def run(self, location=u'.'):
 
274
        self.outf.write(str(Branch.open_containing(location)[0].revno()))
 
275
        self.outf.write('\n')
 
276
 
 
277
 
 
278
class cmd_revision_info(Command):
 
279
    """Show revision number and revision id for a given revision identifier.
 
280
    """
 
281
    hidden = True
 
282
    takes_args = ['revision_info*']
 
283
    takes_options = ['revision']
 
284
 
 
285
    @display_command
 
286
    def run(self, revision=None, revision_info_list=[]):
 
287
 
 
288
        revs = []
 
289
        if revision is not None:
 
290
            revs.extend(revision)
 
291
        if revision_info_list is not None:
 
292
            for rev in revision_info_list:
 
293
                revs.append(RevisionSpec.from_string(rev))
 
294
 
 
295
        b = Branch.open_containing(u'.')[0]
 
296
 
 
297
        if len(revs) == 0:
 
298
            revs.append(RevisionSpec.from_string('-1'))
 
299
 
 
300
        for rev in revs:
 
301
            revision_id = rev.as_revision_id(b)
 
302
            try:
 
303
                revno = '%4d' % (b.revision_id_to_revno(revision_id))
 
304
            except errors.NoSuchRevision:
 
305
                dotted_map = b.get_revision_id_to_revno_map()
 
306
                revno = '.'.join(str(i) for i in dotted_map[revision_id])
 
307
            print '%s %s' % (revno, revision_id)
 
308
 
 
309
    
 
310
class cmd_add(Command):
 
311
    """Add specified files or directories.
 
312
 
 
313
    In non-recursive mode, all the named items are added, regardless
 
314
    of whether they were previously ignored.  A warning is given if
 
315
    any of the named files are already versioned.
 
316
 
 
317
    In recursive mode (the default), files are treated the same way
 
318
    but the behaviour for directories is different.  Directories that
 
319
    are already versioned do not give a warning.  All directories,
 
320
    whether already versioned or not, are searched for files or
 
321
    subdirectories that are neither versioned or ignored, and these
 
322
    are added.  This search proceeds recursively into versioned
 
323
    directories.  If no names are given '.' is assumed.
 
324
 
 
325
    Therefore simply saying 'bzr add' will version all files that
 
326
    are currently unknown.
 
327
 
 
328
    Adding a file whose parent directory is not versioned will
 
329
    implicitly add the parent, and so on up to the root. This means
 
330
    you should never need to explicitly add a directory, they'll just
 
331
    get added when you add a file in the directory.
 
332
 
 
333
    --dry-run will show which files would be added, but not actually 
 
334
    add them.
 
335
 
 
336
    --file-ids-from will try to use the file ids from the supplied path.
 
337
    It looks up ids trying to find a matching parent directory with the
 
338
    same filename, and then by pure path. This option is rarely needed
 
339
    but can be useful when adding the same logical file into two
 
340
    branches that will be merged later (without showing the two different
 
341
    adds as a conflict). It is also useful when merging another project
 
342
    into a subdirectory of this one.
 
343
    """
 
344
    takes_args = ['file*']
 
345
    takes_options = [
 
346
        Option('no-recurse',
 
347
               help="Don't recursively add the contents of directories."),
 
348
        Option('dry-run',
 
349
               help="Show what would be done, but don't actually do anything."),
 
350
        'verbose',
 
351
        Option('file-ids-from',
 
352
               type=unicode,
 
353
               help='Lookup file ids from this tree.'),
 
354
        ]
 
355
    encoding_type = 'replace'
 
356
    _see_also = ['remove']
 
357
 
 
358
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
 
359
            file_ids_from=None):
 
360
        import bzrlib.add
 
361
 
 
362
        base_tree = None
 
363
        if file_ids_from is not None:
 
364
            try:
 
365
                base_tree, base_path = WorkingTree.open_containing(
 
366
                                            file_ids_from)
 
367
            except errors.NoWorkingTree:
 
368
                base_branch, base_path = Branch.open_containing(
 
369
                                            file_ids_from)
 
370
                base_tree = base_branch.basis_tree()
 
371
 
 
372
            action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
 
373
                          to_file=self.outf, should_print=(not is_quiet()))
 
374
        else:
 
375
            action = bzrlib.add.AddAction(to_file=self.outf,
 
376
                should_print=(not is_quiet()))
 
377
 
 
378
        if base_tree:
 
379
            base_tree.lock_read()
 
380
        try:
 
381
            file_list = self._maybe_expand_globs(file_list)
 
382
            if file_list:
 
383
                tree = WorkingTree.open_containing(file_list[0])[0]
 
384
            else:
 
385
                tree = WorkingTree.open_containing(u'.')[0]
 
386
            added, ignored = tree.smart_add(file_list, not
 
387
                no_recurse, action=action, save=not dry_run)
 
388
        finally:
 
389
            if base_tree is not None:
 
390
                base_tree.unlock()
 
391
        if len(ignored) > 0:
 
392
            if verbose:
 
393
                for glob in sorted(ignored.keys()):
 
394
                    for path in ignored[glob]:
 
395
                        self.outf.write("ignored %s matching \"%s\"\n" 
 
396
                                        % (path, glob))
 
397
            else:
 
398
                match_len = 0
 
399
                for glob, paths in ignored.items():
 
400
                    match_len += len(paths)
 
401
                self.outf.write("ignored %d file(s).\n" % match_len)
 
402
            self.outf.write("If you wish to add some of these files,"
 
403
                            " please add them by name.\n")
 
404
 
 
405
 
 
406
class cmd_mkdir(Command):
 
407
    """Create a new versioned directory.
 
408
 
 
409
    This is equivalent to creating the directory and then adding it.
 
410
    """
 
411
 
 
412
    takes_args = ['dir+']
 
413
    encoding_type = 'replace'
 
414
 
 
415
    def run(self, dir_list):
 
416
        for d in dir_list:
 
417
            os.mkdir(d)
 
418
            wt, dd = WorkingTree.open_containing(d)
 
419
            wt.add([dd])
 
420
            self.outf.write('added %s\n' % d)
 
421
 
 
422
 
 
423
class cmd_relpath(Command):
 
424
    """Show path of a file relative to root"""
 
425
 
 
426
    takes_args = ['filename']
 
427
    hidden = True
 
428
    
 
429
    @display_command
 
430
    def run(self, filename):
 
431
        # TODO: jam 20050106 Can relpath return a munged path if
 
432
        #       sys.stdout encoding cannot represent it?
 
433
        tree, relpath = WorkingTree.open_containing(filename)
 
434
        self.outf.write(relpath)
 
435
        self.outf.write('\n')
 
436
 
 
437
 
 
438
class cmd_inventory(Command):
 
439
    """Show inventory of the current working copy or a revision.
 
440
 
 
441
    It is possible to limit the output to a particular entry
 
442
    type using the --kind option.  For example: --kind file.
 
443
 
 
444
    It is also possible to restrict the list of files to a specific
 
445
    set. For example: bzr inventory --show-ids this/file
 
446
    """
 
447
 
 
448
    hidden = True
 
449
    _see_also = ['ls']
 
450
    takes_options = [
 
451
        'revision',
 
452
        'show-ids',
 
453
        Option('kind',
 
454
               help='List entries of a particular kind: file, directory, symlink.',
 
455
               type=unicode),
 
456
        ]
 
457
    takes_args = ['file*']
 
458
 
 
459
    @display_command
 
460
    def run(self, revision=None, show_ids=False, kind=None, file_list=None):
 
461
        if kind and kind not in ['file', 'directory', 'symlink']:
 
462
            raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
 
463
 
 
464
        work_tree, file_list = tree_files(file_list)
 
465
        work_tree.lock_read()
 
466
        try:
 
467
            if revision is not None:
 
468
                if len(revision) > 1:
 
469
                    raise errors.BzrCommandError(
 
470
                        'bzr inventory --revision takes exactly one revision'
 
471
                        ' identifier')
 
472
                revision_id = revision[0].as_revision_id(work_tree.branch)
 
473
                tree = work_tree.branch.repository.revision_tree(revision_id)
 
474
 
 
475
                extra_trees = [work_tree]
 
476
                tree.lock_read()
 
477
            else:
 
478
                tree = work_tree
 
479
                extra_trees = []
 
480
 
 
481
            if file_list is not None:
 
482
                file_ids = tree.paths2ids(file_list, trees=extra_trees,
 
483
                                          require_versioned=True)
 
484
                # find_ids_across_trees may include some paths that don't
 
485
                # exist in 'tree'.
 
486
                entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
 
487
                                 for file_id in file_ids if file_id in tree)
 
488
            else:
 
489
                entries = tree.inventory.entries()
 
490
        finally:
 
491
            tree.unlock()
 
492
            if tree is not work_tree:
 
493
                work_tree.unlock()
 
494
 
 
495
        for path, entry in entries:
 
496
            if kind and kind != entry.kind:
 
497
                continue
 
498
            if show_ids:
 
499
                self.outf.write('%-50s %s\n' % (path, entry.file_id))
 
500
            else:
 
501
                self.outf.write(path)
 
502
                self.outf.write('\n')
 
503
 
 
504
 
 
505
class cmd_mv(Command):
 
506
    """Move or rename a file.
 
507
 
 
508
    :Usage:
 
509
        bzr mv OLDNAME NEWNAME
 
510
 
 
511
        bzr mv SOURCE... DESTINATION
 
512
 
 
513
    If the last argument is a versioned directory, all the other names
 
514
    are moved into it.  Otherwise, there must be exactly two arguments
 
515
    and the file is changed to a new name.
 
516
 
 
517
    If OLDNAME does not exist on the filesystem but is versioned and
 
518
    NEWNAME does exist on the filesystem but is not versioned, mv
 
519
    assumes that the file has been manually moved and only updates
 
520
    its internal inventory to reflect that change.
 
521
    The same is valid when moving many SOURCE files to a DESTINATION.
 
522
 
 
523
    Files cannot be moved between branches.
 
524
    """
 
525
 
 
526
    takes_args = ['names*']
 
527
    takes_options = [Option("after", help="Move only the bzr identifier"
 
528
        " of the file, because the file has already been moved."),
 
529
        ]
 
530
    aliases = ['move', 'rename']
 
531
    encoding_type = 'replace'
 
532
 
 
533
    def run(self, names_list, after=False):
 
534
        if names_list is None:
 
535
            names_list = []
 
536
 
 
537
        if len(names_list) < 2:
 
538
            raise errors.BzrCommandError("missing file argument")
 
539
        tree, rel_names = tree_files(names_list)
 
540
        tree.lock_write()
 
541
        try:
 
542
            self._run(tree, names_list, rel_names, after)
 
543
        finally:
 
544
            tree.unlock()
 
545
 
 
546
    def _run(self, tree, names_list, rel_names, after):
 
547
        into_existing = osutils.isdir(names_list[-1])
 
548
        if into_existing and len(names_list) == 2:
 
549
            # special cases:
 
550
            # a. case-insensitive filesystem and change case of dir
 
551
            # b. move directory after the fact (if the source used to be
 
552
            #    a directory, but now doesn't exist in the working tree
 
553
            #    and the target is an existing directory, just rename it)
 
554
            if (not tree.case_sensitive
 
555
                and rel_names[0].lower() == rel_names[1].lower()):
 
556
                into_existing = False
 
557
            else:
 
558
                inv = tree.inventory
 
559
                from_id = tree.path2id(rel_names[0])
 
560
                if (not osutils.lexists(names_list[0]) and
 
561
                    from_id and inv.get_file_kind(from_id) == "directory"):
 
562
                    into_existing = False
 
563
        # move/rename
 
564
        if into_existing:
 
565
            # move into existing directory
 
566
            for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
 
567
                self.outf.write("%s => %s\n" % pair)
 
568
        else:
 
569
            if len(names_list) != 2:
 
570
                raise errors.BzrCommandError('to mv multiple files the'
 
571
                                             ' destination must be a versioned'
 
572
                                             ' directory')
 
573
            tree.rename_one(rel_names[0], rel_names[1], after=after)
 
574
            self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
 
575
 
 
576
 
 
577
class cmd_pull(Command):
 
578
    """Turn this branch into a mirror of another branch.
 
579
 
 
580
    This command only works on branches that have not diverged.  Branches are
 
581
    considered diverged if the destination branch's most recent commit is one
 
582
    that has not been merged (directly or indirectly) into the parent.
 
583
 
 
584
    If branches have diverged, you can use 'bzr merge' to integrate the changes
 
585
    from one into the other.  Once one branch has merged, the other should
 
586
    be able to pull it again.
 
587
 
 
588
    If you want to forget your local changes and just update your branch to
 
589
    match the remote one, use pull --overwrite.
 
590
 
 
591
    If there is no default location set, the first pull will set it.  After
 
592
    that, you can omit the location to use the default.  To change the
 
593
    default, use --remember. The value will only be saved if the remote
 
594
    location can be accessed.
 
595
 
 
596
    Note: The location can be specified either in the form of a branch,
 
597
    or in the form of a path to a file containing a merge directive generated
 
598
    with bzr send.
 
599
    """
 
600
 
 
601
    _see_also = ['push', 'update', 'status-flags']
 
602
    takes_options = ['remember', 'overwrite', 'revision',
 
603
        custom_help('verbose',
 
604
            help='Show logs of pulled revisions.'),
 
605
        Option('directory',
 
606
            help='Branch to pull into, '
 
607
                 'rather than the one containing the working directory.',
 
608
            short_name='d',
 
609
            type=unicode,
 
610
            ),
 
611
        ]
 
612
    takes_args = ['location?']
 
613
    encoding_type = 'replace'
 
614
 
 
615
    def run(self, location=None, remember=False, overwrite=False,
 
616
            revision=None, verbose=False,
 
617
            directory=None):
 
618
        # FIXME: too much stuff is in the command class
 
619
        revision_id = None
 
620
        mergeable = None
 
621
        if directory is None:
 
622
            directory = u'.'
 
623
        try:
 
624
            tree_to = WorkingTree.open_containing(directory)[0]
 
625
            branch_to = tree_to.branch
 
626
        except errors.NoWorkingTree:
 
627
            tree_to = None
 
628
            branch_to = Branch.open_containing(directory)[0]
 
629
 
 
630
        possible_transports = []
 
631
        if location is not None:
 
632
            try:
 
633
                mergeable = bundle.read_mergeable_from_url(location,
 
634
                    possible_transports=possible_transports)
 
635
            except errors.NotABundle:
 
636
                mergeable = None
 
637
 
 
638
        stored_loc = branch_to.get_parent()
 
639
        if location is None:
 
640
            if stored_loc is None:
 
641
                raise errors.BzrCommandError("No pull location known or"
 
642
                                             " specified.")
 
643
            else:
 
644
                display_url = urlutils.unescape_for_display(stored_loc,
 
645
                        self.outf.encoding)
 
646
                if not is_quiet():
 
647
                    self.outf.write("Using saved location: %s\n" % display_url)
 
648
                location = stored_loc
 
649
 
 
650
        if mergeable is not None:
 
651
            if revision is not None:
 
652
                raise errors.BzrCommandError(
 
653
                    'Cannot use -r with merge directives or bundles')
 
654
            mergeable.install_revisions(branch_to.repository)
 
655
            base_revision_id, revision_id, verified = \
 
656
                mergeable.get_merge_request(branch_to.repository)
 
657
            branch_from = branch_to
 
658
        else:
 
659
            branch_from = Branch.open(location,
 
660
                possible_transports=possible_transports)
 
661
 
 
662
            if branch_to.get_parent() is None or remember:
 
663
                branch_to.set_parent(branch_from.base)
 
664
 
 
665
        if revision is not None:
 
666
            if len(revision) == 1:
 
667
                revision_id = revision[0].as_revision_id(branch_from)
 
668
            else:
 
669
                raise errors.BzrCommandError(
 
670
                    'bzr pull --revision takes one value.')
 
671
 
 
672
        if verbose:
 
673
            old_rh = branch_to.revision_history()
 
674
        if tree_to is not None:
 
675
            change_reporter = delta._ChangeReporter(
 
676
                unversioned_filter=tree_to.is_ignored)
 
677
            result = tree_to.pull(branch_from, overwrite, revision_id,
 
678
                                  change_reporter,
 
679
                                  possible_transports=possible_transports)
 
680
        else:
 
681
            result = branch_to.pull(branch_from, overwrite, revision_id)
 
682
 
 
683
        result.report(self.outf)
 
684
        if verbose:
 
685
            new_rh = branch_to.revision_history()
 
686
            log.show_changed_revisions(branch_to, old_rh, new_rh,
 
687
                                       to_file=self.outf)
 
688
 
 
689
 
 
690
class cmd_push(Command):
 
691
    """Update a mirror of this branch.
 
692
    
 
693
    The target branch will not have its working tree populated because this
 
694
    is both expensive, and is not supported on remote file systems.
 
695
    
 
696
    Some smart servers or protocols *may* put the working tree in place in
 
697
    the future.
 
698
 
 
699
    This command only works on branches that have not diverged.  Branches are
 
700
    considered diverged if the destination branch's most recent commit is one
 
701
    that has not been merged (directly or indirectly) by the source branch.
 
702
 
 
703
    If branches have diverged, you can use 'bzr push --overwrite' to replace
 
704
    the other branch completely, discarding its unmerged changes.
 
705
    
 
706
    If you want to ensure you have the different changes in the other branch,
 
707
    do a merge (see bzr help merge) from the other branch, and commit that.
 
708
    After that you will be able to do a push without '--overwrite'.
 
709
 
 
710
    If there is no default push location set, the first push will set it.
 
711
    After that, you can omit the location to use the default.  To change the
 
712
    default, use --remember. The value will only be saved if the remote
 
713
    location can be accessed.
 
714
    """
 
715
 
 
716
    _see_also = ['pull', 'update', 'working-trees']
 
717
    takes_options = ['remember', 'overwrite', 'verbose', 'revision',
 
718
        Option('create-prefix',
 
719
               help='Create the path leading up to the branch '
 
720
                    'if it does not already exist.'),
 
721
        Option('directory',
 
722
            help='Branch to push from, '
 
723
                 'rather than the one containing the working directory.',
 
724
            short_name='d',
 
725
            type=unicode,
 
726
            ),
 
727
        Option('use-existing-dir',
 
728
               help='By default push will fail if the target'
 
729
                    ' directory exists, but does not already'
 
730
                    ' have a control directory.  This flag will'
 
731
                    ' allow push to proceed.'),
 
732
        ]
 
733
    takes_args = ['location?']
 
734
    encoding_type = 'replace'
 
735
 
 
736
    def run(self, location=None, remember=False, overwrite=False,
 
737
            create_prefix=False, verbose=False, revision=None,
 
738
            use_existing_dir=False,
 
739
            directory=None):
 
740
        # FIXME: Way too big!  Put this into a function called from the
 
741
        # command.
 
742
        if directory is None:
 
743
            directory = '.'
 
744
        br_from = Branch.open_containing(directory)[0]
 
745
        stored_loc = br_from.get_push_location()
 
746
        if location is None:
 
747
            if stored_loc is None:
 
748
                raise errors.BzrCommandError("No push location known or specified.")
 
749
            else:
 
750
                display_url = urlutils.unescape_for_display(stored_loc,
 
751
                        self.outf.encoding)
 
752
                self.outf.write("Using saved location: %s\n" % display_url)
 
753
                location = stored_loc
 
754
 
 
755
        to_transport = transport.get_transport(location)
 
756
 
 
757
        br_to = repository_to = dir_to = None
 
758
        try:
 
759
            dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
 
760
        except errors.NotBranchError:
 
761
            pass # Didn't find anything
 
762
        else:
 
763
            # If we can open a branch, use its direct repository, otherwise see
 
764
            # if there is a repository without a branch.
 
765
            try:
 
766
                br_to = dir_to.open_branch()
 
767
            except errors.NotBranchError:
 
768
                # Didn't find a branch, can we find a repository?
 
769
                try:
 
770
                    repository_to = dir_to.find_repository()
 
771
                except errors.NoRepositoryPresent:
 
772
                    pass
 
773
            else:
 
774
                # Found a branch, so we must have found a repository
 
775
                repository_to = br_to.repository
 
776
 
 
777
        if revision is not None:
 
778
            if len(revision) == 1:
 
779
                revision_id = revision[0].in_history(br_from).rev_id
 
780
            else:
 
781
                raise errors.BzrCommandError(
 
782
                    'bzr push --revision takes one value.')
 
783
        else:
 
784
            revision_id = br_from.last_revision()
 
785
 
 
786
        push_result = None
 
787
        if verbose:
 
788
            old_rh = []
 
789
        if dir_to is None:
 
790
            # The destination doesn't exist; create it.
 
791
            # XXX: Refactor the create_prefix/no_create_prefix code into a
 
792
            #      common helper function
 
793
 
 
794
            def make_directory(transport):
 
795
                transport.mkdir('.')
 
796
                return transport
 
797
 
 
798
            def redirected(redirected_transport, e, redirection_notice):
 
799
                return transport.get_transport(e.get_target_url())
 
800
 
 
801
            try:
 
802
                to_transport = transport.do_catching_redirections(
 
803
                    make_directory, to_transport, redirected)
 
804
            except errors.FileExists:
 
805
                if not use_existing_dir:
 
806
                    raise errors.BzrCommandError("Target directory %s"
 
807
                         " already exists, but does not have a valid .bzr"
 
808
                         " directory. Supply --use-existing-dir to push"
 
809
                         " there anyway." % location)
 
810
            except errors.NoSuchFile:
 
811
                if not create_prefix:
 
812
                    raise errors.BzrCommandError("Parent directory of %s"
 
813
                        " does not exist."
 
814
                        "\nYou may supply --create-prefix to create all"
 
815
                        " leading parent directories."
 
816
                        % location)
 
817
                _create_prefix(to_transport)
 
818
            except errors.TooManyRedirections:
 
819
                raise errors.BzrCommandError("Too many redirections trying "
 
820
                                             "to make %s." % location)
 
821
 
 
822
            # Now the target directory exists, but doesn't have a .bzr
 
823
            # directory. So we need to create it, along with any work to create
 
824
            # all of the dependent branches, etc.
 
825
            dir_to = br_from.bzrdir.clone_on_transport(to_transport,
 
826
                                                       revision_id=revision_id)
 
827
            br_to = dir_to.open_branch()
 
828
            # TODO: Some more useful message about what was copied
 
829
            note('Created new branch.')
 
830
            # We successfully created the target, remember it
 
831
            if br_from.get_push_location() is None or remember:
 
832
                br_from.set_push_location(br_to.base)
 
833
        elif repository_to is None:
 
834
            # we have a bzrdir but no branch or repository
 
835
            # XXX: Figure out what to do other than complain.
 
836
            raise errors.BzrCommandError("At %s you have a valid .bzr control"
 
837
                " directory, but not a branch or repository. This is an"
 
838
                " unsupported configuration. Please move the target directory"
 
839
                " out of the way and try again."
 
840
                % location)
 
841
        elif br_to is None:
 
842
            # We have a repository but no branch, copy the revisions, and then
 
843
            # create a branch.
 
844
            repository_to.fetch(br_from.repository, revision_id=revision_id)
 
845
            br_to = br_from.clone(dir_to, revision_id=revision_id)
 
846
            note('Created new branch.')
 
847
            if br_from.get_push_location() is None or remember:
 
848
                br_from.set_push_location(br_to.base)
 
849
        else: # We have a valid to branch
 
850
            # We were able to connect to the remote location, so remember it
 
851
            # we don't need to successfully push because of possible divergence.
 
852
            if br_from.get_push_location() is None or remember:
 
853
                br_from.set_push_location(br_to.base)
 
854
            if verbose:
 
855
                old_rh = br_to.revision_history()
 
856
            try:
 
857
                try:
 
858
                    tree_to = dir_to.open_workingtree()
 
859
                except errors.NotLocalUrl:
 
860
                    warning("This transport does not update the working " 
 
861
                            "tree of: %s. See 'bzr help working-trees' for "
 
862
                            "more information." % br_to.base)
 
863
                    push_result = br_from.push(br_to, overwrite,
 
864
                                               stop_revision=revision_id)
 
865
                except errors.NoWorkingTree:
 
866
                    push_result = br_from.push(br_to, overwrite,
 
867
                                               stop_revision=revision_id)
 
868
                else:
 
869
                    tree_to.lock_write()
 
870
                    try:
 
871
                        push_result = br_from.push(tree_to.branch, overwrite,
 
872
                                                   stop_revision=revision_id)
 
873
                        tree_to.update()
 
874
                    finally:
 
875
                        tree_to.unlock()
 
876
            except errors.DivergedBranches:
 
877
                raise errors.BzrCommandError('These branches have diverged.'
 
878
                                        '  Try using "merge" and then "push".')
 
879
        if push_result is not None:
 
880
            push_result.report(self.outf)
 
881
        elif verbose:
 
882
            new_rh = br_to.revision_history()
 
883
            if old_rh != new_rh:
 
884
                # Something changed
 
885
                from bzrlib.log import show_changed_revisions
 
886
                show_changed_revisions(br_to, old_rh, new_rh,
 
887
                                       to_file=self.outf)
 
888
        else:
 
889
            # we probably did a clone rather than a push, so a message was
 
890
            # emitted above
 
891
            pass
 
892
 
 
893
 
 
894
class cmd_branch(Command):
 
895
    """Create a new copy of a branch.
 
896
 
 
897
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
 
898
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
 
899
    If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
 
900
    is derived from the FROM_LOCATION by stripping a leading scheme or drive
 
901
    identifier, if any. For example, "branch lp:foo-bar" will attempt to
 
902
    create ./foo-bar.
 
903
 
 
904
    To retrieve the branch as of a particular revision, supply the --revision
 
905
    parameter, as in "branch foo/bar -r 5".
 
906
    """
 
907
 
 
908
    _see_also = ['checkout']
 
909
    takes_args = ['from_location', 'to_location?']
 
910
    takes_options = ['revision', Option('hardlink',
 
911
        help='Hard-link working tree files where possible.')]
 
912
    aliases = ['get', 'clone']
 
913
 
 
914
    def run(self, from_location, to_location=None, revision=None,
 
915
            hardlink=False):
 
916
        from bzrlib.tag import _merge_tags_if_possible
 
917
        if revision is None:
 
918
            revision = [None]
 
919
        elif len(revision) > 1:
 
920
            raise errors.BzrCommandError(
 
921
                'bzr branch --revision takes exactly 1 revision value')
 
922
 
 
923
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
 
924
            from_location)
 
925
        br_from.lock_read()
 
926
        try:
 
927
            if len(revision) == 1 and revision[0] is not None:
 
928
                revision_id = revision[0].as_revision_id(br_from)
 
929
            else:
 
930
                # FIXME - wt.last_revision, fallback to branch, fall back to
 
931
                # None or perhaps NULL_REVISION to mean copy nothing
 
932
                # RBC 20060209
 
933
                revision_id = br_from.last_revision()
 
934
            if to_location is None:
 
935
                to_location = urlutils.derive_to_location(from_location)
 
936
                name = None
 
937
            else:
 
938
                name = os.path.basename(to_location) + '\n'
 
939
 
 
940
            to_transport = transport.get_transport(to_location)
 
941
            try:
 
942
                to_transport.mkdir('.')
 
943
            except errors.FileExists:
 
944
                raise errors.BzrCommandError('Target directory "%s" already'
 
945
                                             ' exists.' % to_location)
 
946
            except errors.NoSuchFile:
 
947
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
 
948
                                             % to_location)
 
949
            try:
 
950
                # preserve whatever source format we have.
 
951
                dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
 
952
                                            possible_transports=[to_transport],
 
953
                                            accelerator_tree=accelerator_tree,
 
954
                                            hardlink=hardlink)
 
955
                branch = dir.open_branch()
 
956
            except errors.NoSuchRevision:
 
957
                to_transport.delete_tree('.')
 
958
                msg = "The branch %s has no revision %s." % (from_location, revision[0])
 
959
                raise errors.BzrCommandError(msg)
 
960
            if name:
 
961
                branch.control_files.put_utf8('branch-name', name)
 
962
            _merge_tags_if_possible(br_from, branch)
 
963
            note('Branched %d revision(s).' % branch.revno())
 
964
        finally:
 
965
            br_from.unlock()
 
966
 
 
967
 
 
968
class cmd_checkout(Command):
 
969
    """Create a new checkout of an existing branch.
 
970
 
 
971
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
 
972
    the branch found in '.'. This is useful if you have removed the working tree
 
973
    or if it was never created - i.e. if you pushed the branch to its current
 
974
    location using SFTP.
 
975
    
 
976
    If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
 
977
    be used.  In other words, "checkout ../foo/bar" will attempt to create ./bar.
 
978
    If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
 
979
    is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
 
980
    identifier, if any. For example, "checkout lp:foo-bar" will attempt to
 
981
    create ./foo-bar.
 
982
 
 
983
    To retrieve the branch as of a particular revision, supply the --revision
 
984
    parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
 
985
    out of date [so you cannot commit] but it may be useful (i.e. to examine old
 
986
    code.)
 
987
    """
 
988
 
 
989
    _see_also = ['checkouts', 'branch']
 
990
    takes_args = ['branch_location?', 'to_location?']
 
991
    takes_options = ['revision',
 
992
                     Option('lightweight',
 
993
                            help="Perform a lightweight checkout.  Lightweight "
 
994
                                 "checkouts depend on access to the branch for "
 
995
                                 "every operation.  Normal checkouts can perform "
 
996
                                 "common operations like diff and status without "
 
997
                                 "such access, and also support local commits."
 
998
                            ),
 
999
                     Option('files-from', type=str,
 
1000
                            help="Get file contents from this tree."),
 
1001
                     Option('hardlink',
 
1002
                            help='Hard-link working tree files where possible.'
 
1003
                            ),
 
1004
                     ]
 
1005
    aliases = ['co']
 
1006
 
 
1007
    def run(self, branch_location=None, to_location=None, revision=None,
 
1008
            lightweight=False, files_from=None, hardlink=False):
 
1009
        if revision is None:
 
1010
            revision = [None]
 
1011
        elif len(revision) > 1:
 
1012
            raise errors.BzrCommandError(
 
1013
                'bzr checkout --revision takes exactly 1 revision value')
 
1014
        if branch_location is None:
 
1015
            branch_location = osutils.getcwd()
 
1016
            to_location = branch_location
 
1017
        accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
 
1018
            branch_location)
 
1019
        if files_from is not None:
 
1020
            accelerator_tree = WorkingTree.open(files_from)
 
1021
        if len(revision) == 1 and revision[0] is not None:
 
1022
            revision_id = revision[0].as_revision_id(source)
 
1023
        else:
 
1024
            revision_id = None
 
1025
        if to_location is None:
 
1026
            to_location = urlutils.derive_to_location(branch_location)
 
1027
        # if the source and to_location are the same, 
 
1028
        # and there is no working tree,
 
1029
        # then reconstitute a branch
 
1030
        if (osutils.abspath(to_location) ==
 
1031
            osutils.abspath(branch_location)):
 
1032
            try:
 
1033
                source.bzrdir.open_workingtree()
 
1034
            except errors.NoWorkingTree:
 
1035
                source.bzrdir.create_workingtree(revision_id)
 
1036
                return
 
1037
        source.create_checkout(to_location, revision_id, lightweight,
 
1038
                               accelerator_tree, hardlink)
 
1039
 
 
1040
 
 
1041
class cmd_renames(Command):
 
1042
    """Show list of renamed files.
 
1043
    """
 
1044
    # TODO: Option to show renames between two historical versions.
 
1045
 
 
1046
    # TODO: Only show renames under dir, rather than in the whole branch.
 
1047
    _see_also = ['status']
 
1048
    takes_args = ['dir?']
 
1049
 
 
1050
    @display_command
 
1051
    def run(self, dir=u'.'):
 
1052
        tree = WorkingTree.open_containing(dir)[0]
 
1053
        tree.lock_read()
 
1054
        try:
 
1055
            new_inv = tree.inventory
 
1056
            old_tree = tree.basis_tree()
 
1057
            old_tree.lock_read()
 
1058
            try:
 
1059
                old_inv = old_tree.inventory
 
1060
                renames = list(_mod_tree.find_renames(old_inv, new_inv))
 
1061
                renames.sort()
 
1062
                for old_name, new_name in renames:
 
1063
                    self.outf.write("%s => %s\n" % (old_name, new_name))
 
1064
            finally:
 
1065
                old_tree.unlock()
 
1066
        finally:
 
1067
            tree.unlock()
 
1068
 
 
1069
 
 
1070
class cmd_update(Command):
 
1071
    """Update a tree to have the latest code committed to its branch.
 
1072
    
 
1073
    This will perform a merge into the working tree, and may generate
 
1074
    conflicts. If you have any local changes, you will still 
 
1075
    need to commit them after the update for the update to be complete.
 
1076
    
 
1077
    If you want to discard your local changes, you can just do a 
 
1078
    'bzr revert' instead of 'bzr commit' after the update.
 
1079
    """
 
1080
 
 
1081
    _see_also = ['pull', 'working-trees', 'status-flags']
 
1082
    takes_args = ['dir?']
 
1083
    aliases = ['up']
 
1084
 
 
1085
    def run(self, dir='.'):
 
1086
        tree = WorkingTree.open_containing(dir)[0]
 
1087
        possible_transports = []
 
1088
        master = tree.branch.get_master_branch(
 
1089
            possible_transports=possible_transports)
 
1090
        if master is not None:
 
1091
            tree.lock_write()
 
1092
        else:
 
1093
            tree.lock_tree_write()
 
1094
        try:
 
1095
            existing_pending_merges = tree.get_parent_ids()[1:]
 
1096
            last_rev = _mod_revision.ensure_null(tree.last_revision())
 
1097
            if last_rev == _mod_revision.ensure_null(
 
1098
                tree.branch.last_revision()):
 
1099
                # may be up to date, check master too.
 
1100
                if master is None or last_rev == _mod_revision.ensure_null(
 
1101
                    master.last_revision()):
 
1102
                    revno = tree.branch.revision_id_to_revno(last_rev)
 
1103
                    note("Tree is up to date at revision %d." % (revno,))
 
1104
                    return 0
 
1105
            conflicts = tree.update(
 
1106
                delta._ChangeReporter(unversioned_filter=tree.is_ignored),
 
1107
                possible_transports=possible_transports)
 
1108
            revno = tree.branch.revision_id_to_revno(
 
1109
                _mod_revision.ensure_null(tree.last_revision()))
 
1110
            note('Updated to revision %d.' % (revno,))
 
1111
            if tree.get_parent_ids()[1:] != existing_pending_merges:
 
1112
                note('Your local commits will now show as pending merges with '
 
1113
                     "'bzr status', and can be committed with 'bzr commit'.")
 
1114
            if conflicts != 0:
 
1115
                return 1
 
1116
            else:
 
1117
                return 0
 
1118
        finally:
 
1119
            tree.unlock()
 
1120
 
 
1121
 
 
1122
class cmd_info(Command):
 
1123
    """Show information about a working tree, branch or repository.
 
1124
 
 
1125
    This command will show all known locations and formats associated to the
 
1126
    tree, branch or repository.  Statistical information is included with
 
1127
    each report.
 
1128
 
 
1129
    Branches and working trees will also report any missing revisions.
 
1130
    """
 
1131
    _see_also = ['revno', 'working-trees', 'repositories']
 
1132
    takes_args = ['location?']
 
1133
    takes_options = ['verbose']
 
1134
    encoding_type = 'replace'
 
1135
 
 
1136
    @display_command
 
1137
    def run(self, location=None, verbose=False):
 
1138
        if verbose:
 
1139
            noise_level = 2
 
1140
        else:
 
1141
            noise_level = 0
 
1142
        from bzrlib.info import show_bzrdir_info
 
1143
        show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
 
1144
                         verbose=noise_level, outfile=self.outf)
 
1145
 
 
1146
 
 
1147
class cmd_remove(Command):
 
1148
    """Remove files or directories.
 
1149
 
 
1150
    This makes bzr stop tracking changes to the specified files and
 
1151
    delete them if they can easily be recovered using revert.
 
1152
 
 
1153
    You can specify one or more files, and/or --new.  If you specify --new,
 
1154
    only 'added' files will be removed.  If you specify both, then new files
 
1155
    in the specified directories will be removed.  If the directories are
 
1156
    also new, they will also be removed.
 
1157
    """
 
1158
    takes_args = ['file*']
 
1159
    takes_options = ['verbose',
 
1160
        Option('new', help='Remove newly-added files.'),
 
1161
        RegistryOption.from_kwargs('file-deletion-strategy',
 
1162
            'The file deletion mode to be used.',
 
1163
            title='Deletion Strategy', value_switches=True, enum_switch=False,
 
1164
            safe='Only delete files if they can be'
 
1165
                 ' safely recovered (default).',
 
1166
            keep="Don't delete any files.",
 
1167
            force='Delete all the specified files, even if they can not be '
 
1168
                'recovered and even if they are non-empty directories.')]
 
1169
    aliases = ['rm']
 
1170
    encoding_type = 'replace'
 
1171
 
 
1172
    def run(self, file_list, verbose=False, new=False,
 
1173
        file_deletion_strategy='safe'):
 
1174
        tree, file_list = tree_files(file_list)
 
1175
 
 
1176
        if file_list is not None:
 
1177
            file_list = [f for f in file_list]
 
1178
        elif not new:
 
1179
            raise errors.BzrCommandError('Specify one or more files to'
 
1180
            ' remove, or use --new.')
 
1181
 
 
1182
        if new:
 
1183
            added = tree.changes_from(tree.basis_tree(),
 
1184
                specific_files=file_list).added
 
1185
            file_list = sorted([f[0] for f in added], reverse=True)
 
1186
            if len(file_list) == 0:
 
1187
                raise errors.BzrCommandError('No matching files.')
 
1188
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
 
1189
            keep_files=file_deletion_strategy=='keep',
 
1190
            force=file_deletion_strategy=='force')
 
1191
 
 
1192
 
 
1193
class cmd_file_id(Command):
 
1194
    """Print file_id of a particular file or directory.
 
1195
 
 
1196
    The file_id is assigned when the file is first added and remains the
 
1197
    same through all revisions where the file exists, even when it is
 
1198
    moved or renamed.
 
1199
    """
 
1200
 
 
1201
    hidden = True
 
1202
    _see_also = ['inventory', 'ls']
 
1203
    takes_args = ['filename']
 
1204
 
 
1205
    @display_command
 
1206
    def run(self, filename):
 
1207
        tree, relpath = WorkingTree.open_containing(filename)
 
1208
        i = tree.path2id(relpath)
 
1209
        if i is None:
 
1210
            raise errors.NotVersionedError(filename)
 
1211
        else:
 
1212
            self.outf.write(i + '\n')
 
1213
 
 
1214
 
 
1215
class cmd_file_path(Command):
 
1216
    """Print path of file_ids to a file or directory.
 
1217
 
 
1218
    This prints one line for each directory down to the target,
 
1219
    starting at the branch root.
 
1220
    """
 
1221
 
 
1222
    hidden = True
 
1223
    takes_args = ['filename']
 
1224
 
 
1225
    @display_command
 
1226
    def run(self, filename):
 
1227
        tree, relpath = WorkingTree.open_containing(filename)
 
1228
        fid = tree.path2id(relpath)
 
1229
        if fid is None:
 
1230
            raise errors.NotVersionedError(filename)
 
1231
        segments = osutils.splitpath(relpath)
 
1232
        for pos in range(1, len(segments) + 1):
 
1233
            path = osutils.joinpath(segments[:pos])
 
1234
            self.outf.write("%s\n" % tree.path2id(path))
 
1235
 
 
1236
 
 
1237
class cmd_reconcile(Command):
 
1238
    """Reconcile bzr metadata in a branch.
 
1239
 
 
1240
    This can correct data mismatches that may have been caused by
 
1241
    previous ghost operations or bzr upgrades. You should only
 
1242
    need to run this command if 'bzr check' or a bzr developer 
 
1243
    advises you to run it.
 
1244
 
 
1245
    If a second branch is provided, cross-branch reconciliation is
 
1246
    also attempted, which will check that data like the tree root
 
1247
    id which was not present in very early bzr versions is represented
 
1248
    correctly in both branches.
 
1249
 
 
1250
    At the same time it is run it may recompress data resulting in 
 
1251
    a potential saving in disk space or performance gain.
 
1252
 
 
1253
    The branch *MUST* be on a listable system such as local disk or sftp.
 
1254
    """
 
1255
 
 
1256
    _see_also = ['check']
 
1257
    takes_args = ['branch?']
 
1258
 
 
1259
    def run(self, branch="."):
 
1260
        from bzrlib.reconcile import reconcile
 
1261
        dir = bzrdir.BzrDir.open(branch)
 
1262
        reconcile(dir)
 
1263
 
 
1264
 
 
1265
class cmd_revision_history(Command):
 
1266
    """Display the list of revision ids on a branch."""
 
1267
 
 
1268
    _see_also = ['log']
 
1269
    takes_args = ['location?']
 
1270
 
 
1271
    hidden = True
 
1272
 
 
1273
    @display_command
 
1274
    def run(self, location="."):
 
1275
        branch = Branch.open_containing(location)[0]
 
1276
        for revid in branch.revision_history():
 
1277
            self.outf.write(revid)
 
1278
            self.outf.write('\n')
 
1279
 
 
1280
 
 
1281
class cmd_ancestry(Command):
 
1282
    """List all revisions merged into this branch."""
 
1283
 
 
1284
    _see_also = ['log', 'revision-history']
 
1285
    takes_args = ['location?']
 
1286
 
 
1287
    hidden = True
 
1288
 
 
1289
    @display_command
 
1290
    def run(self, location="."):
 
1291
        try:
 
1292
            wt = WorkingTree.open_containing(location)[0]
 
1293
        except errors.NoWorkingTree:
 
1294
            b = Branch.open(location)
 
1295
            last_revision = b.last_revision()
 
1296
        else:
 
1297
            b = wt.branch
 
1298
            last_revision = wt.last_revision()
 
1299
 
 
1300
        revision_ids = b.repository.get_ancestry(last_revision)
 
1301
        assert revision_ids[0] is None
 
1302
        revision_ids.pop(0)
 
1303
        for revision_id in revision_ids:
 
1304
            self.outf.write(revision_id + '\n')
 
1305
 
 
1306
 
 
1307
class cmd_init(Command):
 
1308
    """Make a directory into a versioned branch.
 
1309
 
 
1310
    Use this to create an empty branch, or before importing an
 
1311
    existing project.
 
1312
 
 
1313
    If there is a repository in a parent directory of the location, then 
 
1314
    the history of the branch will be stored in the repository.  Otherwise
 
1315
    init creates a standalone branch which carries its own history
 
1316
    in the .bzr directory.
 
1317
 
 
1318
    If there is already a branch at the location but it has no working tree,
 
1319
    the tree can be populated with 'bzr checkout'.
 
1320
 
 
1321
    Recipe for importing a tree of files::
 
1322
 
 
1323
        cd ~/project
 
1324
        bzr init
 
1325
        bzr add .
 
1326
        bzr status
 
1327
        bzr commit -m "imported project"
 
1328
    """
 
1329
 
 
1330
    _see_also = ['init-repository', 'branch', 'checkout']
 
1331
    takes_args = ['location?']
 
1332
    takes_options = [
 
1333
        Option('create-prefix',
 
1334
               help='Create the path leading up to the branch '
 
1335
                    'if it does not already exist.'),
 
1336
         RegistryOption('format',
 
1337
                help='Specify a format for this branch. '
 
1338
                'See "help formats".',
 
1339
                registry=bzrdir.format_registry,
 
1340
                converter=bzrdir.format_registry.make_bzrdir,
 
1341
                value_switches=True,
 
1342
                title="Branch Format",
 
1343
                ),
 
1344
         Option('append-revisions-only',
 
1345
                help='Never change revnos or the existing log.'
 
1346
                '  Append revisions to it only.')
 
1347
         ]
 
1348
    def run(self, location=None, format=None, append_revisions_only=False,
 
1349
            create_prefix=False):
 
1350
        if format is None:
 
1351
            format = bzrdir.format_registry.make_bzrdir('default')
 
1352
        if location is None:
 
1353
            location = u'.'
 
1354
 
 
1355
        to_transport = transport.get_transport(location)
 
1356
 
 
1357
        # The path has to exist to initialize a
 
1358
        # branch inside of it.
 
1359
        # Just using os.mkdir, since I don't
 
1360
        # believe that we want to create a bunch of
 
1361
        # locations if the user supplies an extended path
 
1362
        try:
 
1363
            to_transport.ensure_base()
 
1364
        except errors.NoSuchFile:
 
1365
            if not create_prefix:
 
1366
                raise errors.BzrCommandError("Parent directory of %s"
 
1367
                    " does not exist."
 
1368
                    "\nYou may supply --create-prefix to create all"
 
1369
                    " leading parent directories."
 
1370
                    % location)
 
1371
            _create_prefix(to_transport)
 
1372
 
 
1373
        try:
 
1374
            existing_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
 
1375
        except errors.NotBranchError:
 
1376
            # really a NotBzrDir error...
 
1377
            create_branch = bzrdir.BzrDir.create_branch_convenience
 
1378
            branch = create_branch(to_transport.base, format=format,
 
1379
                                   possible_transports=[to_transport])
 
1380
        else:
 
1381
            from bzrlib.transport.local import LocalTransport
 
1382
            if existing_bzrdir.has_branch():
 
1383
                if (isinstance(to_transport, LocalTransport)
 
1384
                    and not existing_bzrdir.has_workingtree()):
 
1385
                        raise errors.BranchExistsWithoutWorkingTree(location)
 
1386
                raise errors.AlreadyBranchError(location)
 
1387
            else:
 
1388
                branch = existing_bzrdir.create_branch()
 
1389
                existing_bzrdir.create_workingtree()
 
1390
        if append_revisions_only:
 
1391
            try:
 
1392
                branch.set_append_revisions_only(True)
 
1393
            except errors.UpgradeRequired:
 
1394
                raise errors.BzrCommandError('This branch format cannot be set'
 
1395
                    ' to append-revisions-only.  Try --experimental-branch6')
 
1396
 
 
1397
 
 
1398
class cmd_init_repository(Command):
 
1399
    """Create a shared repository to hold branches.
 
1400
 
 
1401
    New branches created under the repository directory will store their
 
1402
    revisions in the repository, not in the branch directory.
 
1403
 
 
1404
    If the --no-trees option is used then the branches in the repository
 
1405
    will not have working trees by default.
 
1406
 
 
1407
    :Examples:
 
1408
        Create a shared repositories holding just branches::
 
1409
 
 
1410
            bzr init-repo --no-trees repo
 
1411
            bzr init repo/trunk
 
1412
 
 
1413
        Make a lightweight checkout elsewhere::
 
1414
 
 
1415
            bzr checkout --lightweight repo/trunk trunk-checkout
 
1416
            cd trunk-checkout
 
1417
            (add files here)
 
1418
    """
 
1419
 
 
1420
    _see_also = ['init', 'branch', 'checkout', 'repositories']
 
1421
    takes_args = ["location"]
 
1422
    takes_options = [RegistryOption('format',
 
1423
                            help='Specify a format for this repository. See'
 
1424
                                 ' "bzr help formats" for details.',
 
1425
                            registry=bzrdir.format_registry,
 
1426
                            converter=bzrdir.format_registry.make_bzrdir,
 
1427
                            value_switches=True, title='Repository format'),
 
1428
                     Option('no-trees',
 
1429
                             help='Branches in the repository will default to'
 
1430
                                  ' not having a working tree.'),
 
1431
                    ]
 
1432
    aliases = ["init-repo"]
 
1433
 
 
1434
    def run(self, location, format=None, no_trees=False):
 
1435
        if format is None:
 
1436
            format = bzrdir.format_registry.make_bzrdir('default')
 
1437
 
 
1438
        if location is None:
 
1439
            location = '.'
 
1440
 
 
1441
        to_transport = transport.get_transport(location)
 
1442
        to_transport.ensure_base()
 
1443
 
 
1444
        newdir = format.initialize_on_transport(to_transport)
 
1445
        repo = newdir.create_repository(shared=True)
 
1446
        repo.set_make_working_trees(not no_trees)
 
1447
 
 
1448
 
 
1449
class cmd_diff(Command):
 
1450
    """Show differences in the working tree, between revisions or branches.
 
1451
    
 
1452
    If no arguments are given, all changes for the current tree are listed.
 
1453
    If files are given, only the changes in those files are listed.
 
1454
    Remote and multiple branches can be compared by using the --old and
 
1455
    --new options. If not provided, the default for both is derived from
 
1456
    the first argument, if any, or the current tree if no arguments are
 
1457
    given.
 
1458
 
 
1459
    "bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
 
1460
    produces patches suitable for "patch -p1".
 
1461
 
 
1462
    :Exit values:
 
1463
        1 - changed
 
1464
        2 - unrepresentable changes
 
1465
        3 - error
 
1466
        0 - no change
 
1467
 
 
1468
    :Examples:
 
1469
        Shows the difference in the working tree versus the last commit::
 
1470
 
 
1471
            bzr diff
 
1472
 
 
1473
        Difference between the working tree and revision 1::
 
1474
 
 
1475
            bzr diff -r1
 
1476
 
 
1477
        Difference between revision 2 and revision 1::
 
1478
 
 
1479
            bzr diff -r1..2
 
1480
 
 
1481
        Difference between revision 2 and revision 1 for branch xxx::
 
1482
 
 
1483
            bzr diff -r1..2 xxx
 
1484
 
 
1485
        Show just the differences for file NEWS::
 
1486
 
 
1487
            bzr diff NEWS
 
1488
 
 
1489
        Show the differences in working tree xxx for file NEWS::
 
1490
 
 
1491
            bzr diff xxx/NEWS
 
1492
 
 
1493
        Show the differences from branch xxx to this working tree:
 
1494
 
 
1495
            bzr diff --old xxx
 
1496
 
 
1497
        Show the differences between two branches for file NEWS::
 
1498
 
 
1499
            bzr diff --old xxx --new yyy NEWS
 
1500
 
 
1501
        Same as 'bzr diff' but prefix paths with old/ and new/::
 
1502
 
 
1503
            bzr diff --prefix old/:new/
 
1504
    """
 
1505
    _see_also = ['status']
 
1506
    takes_args = ['file*']
 
1507
    takes_options = [
 
1508
        Option('diff-options', type=str,
 
1509
               help='Pass these options to the external diff program.'),
 
1510
        Option('prefix', type=str,
 
1511
               short_name='p',
 
1512
               help='Set prefixes added to old and new filenames, as '
 
1513
                    'two values separated by a colon. (eg "old/:new/").'),
 
1514
        Option('old',
 
1515
            help='Branch/tree to compare from.',
 
1516
            type=unicode,
 
1517
            ),
 
1518
        Option('new',
 
1519
            help='Branch/tree to compare to.',
 
1520
            type=unicode,
 
1521
            ),
 
1522
        'revision',
 
1523
        'change',
 
1524
        Option('using',
 
1525
            help='Use this command to compare files.',
 
1526
            type=unicode,
 
1527
            ),
 
1528
        ]
 
1529
    aliases = ['di', 'dif']
 
1530
    encoding_type = 'exact'
 
1531
 
 
1532
    @display_command
 
1533
    def run(self, revision=None, file_list=None, diff_options=None,
 
1534
            prefix=None, old=None, new=None, using=None):
 
1535
        from bzrlib.diff import _get_trees_to_diff, show_diff_trees
 
1536
 
 
1537
        if (prefix is None) or (prefix == '0'):
 
1538
            # diff -p0 format
 
1539
            old_label = ''
 
1540
            new_label = ''
 
1541
        elif prefix == '1':
 
1542
            old_label = 'old/'
 
1543
            new_label = 'new/'
 
1544
        elif ':' in prefix:
 
1545
            old_label, new_label = prefix.split(":")
 
1546
        else:
 
1547
            raise errors.BzrCommandError(
 
1548
                '--prefix expects two values separated by a colon'
 
1549
                ' (eg "old/:new/")')
 
1550
 
 
1551
        if revision and len(revision) > 2:
 
1552
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
 
1553
                                         ' one or two revision specifiers')
 
1554
 
 
1555
        old_tree, new_tree, specific_files, extra_trees = \
 
1556
                _get_trees_to_diff(file_list, revision, old, new)
 
1557
        return show_diff_trees(old_tree, new_tree, sys.stdout, 
 
1558
                               specific_files=specific_files,
 
1559
                               external_diff_options=diff_options,
 
1560
                               old_label=old_label, new_label=new_label,
 
1561
                               extra_trees=extra_trees, using=using)
 
1562
 
 
1563
 
 
1564
class cmd_deleted(Command):
 
1565
    """List files deleted in the working tree.
 
1566
    """
 
1567
    # TODO: Show files deleted since a previous revision, or
 
1568
    # between two revisions.
 
1569
    # TODO: Much more efficient way to do this: read in new
 
1570
    # directories with readdir, rather than stating each one.  Same
 
1571
    # level of effort but possibly much less IO.  (Or possibly not,
 
1572
    # if the directories are very large...)
 
1573
    _see_also = ['status', 'ls']
 
1574
    takes_options = ['show-ids']
 
1575
 
 
1576
    @display_command
 
1577
    def run(self, show_ids=False):
 
1578
        tree = WorkingTree.open_containing(u'.')[0]
 
1579
        tree.lock_read()
 
1580
        try:
 
1581
            old = tree.basis_tree()
 
1582
            old.lock_read()
 
1583
            try:
 
1584
                for path, ie in old.inventory.iter_entries():
 
1585
                    if not tree.has_id(ie.file_id):
 
1586
                        self.outf.write(path)
 
1587
                        if show_ids:
 
1588
                            self.outf.write(' ')
 
1589
                            self.outf.write(ie.file_id)
 
1590
                        self.outf.write('\n')
 
1591
            finally:
 
1592
                old.unlock()
 
1593
        finally:
 
1594
            tree.unlock()
 
1595
 
 
1596
 
 
1597
class cmd_modified(Command):
 
1598
    """List files modified in working tree.
 
1599
    """
 
1600
 
 
1601
    hidden = True
 
1602
    _see_also = ['status', 'ls']
 
1603
 
 
1604
    @display_command
 
1605
    def run(self):
 
1606
        tree = WorkingTree.open_containing(u'.')[0]
 
1607
        td = tree.changes_from(tree.basis_tree())
 
1608
        for path, id, kind, text_modified, meta_modified in td.modified:
 
1609
            self.outf.write(path + '\n')
 
1610
 
 
1611
 
 
1612
class cmd_added(Command):
 
1613
    """List files added in working tree.
 
1614
    """
 
1615
 
 
1616
    hidden = True
 
1617
    _see_also = ['status', 'ls']
 
1618
 
 
1619
    @display_command
 
1620
    def run(self):
 
1621
        wt = WorkingTree.open_containing(u'.')[0]
 
1622
        wt.lock_read()
 
1623
        try:
 
1624
            basis = wt.basis_tree()
 
1625
            basis.lock_read()
 
1626
            try:
 
1627
                basis_inv = basis.inventory
 
1628
                inv = wt.inventory
 
1629
                for file_id in inv:
 
1630
                    if file_id in basis_inv:
 
1631
                        continue
 
1632
                    if inv.is_root(file_id) and len(basis_inv) == 0:
 
1633
                        continue
 
1634
                    path = inv.id2path(file_id)
 
1635
                    if not os.access(osutils.abspath(path), os.F_OK):
 
1636
                        continue
 
1637
                    self.outf.write(path + '\n')
 
1638
            finally:
 
1639
                basis.unlock()
 
1640
        finally:
 
1641
            wt.unlock()
 
1642
 
 
1643
 
 
1644
class cmd_root(Command):
 
1645
    """Show the tree root directory.
 
1646
 
 
1647
    The root is the nearest enclosing directory with a .bzr control
 
1648
    directory."""
 
1649
 
 
1650
    takes_args = ['filename?']
 
1651
    @display_command
 
1652
    def run(self, filename=None):
 
1653
        """Print the branch root."""
 
1654
        tree = WorkingTree.open_containing(filename)[0]
 
1655
        self.outf.write(tree.basedir + '\n')
 
1656
 
 
1657
 
 
1658
def _parse_limit(limitstring):
 
1659
    try:
 
1660
        return int(limitstring)
 
1661
    except ValueError:
 
1662
        msg = "The limit argument must be an integer."
 
1663
        raise errors.BzrCommandError(msg)
 
1664
 
 
1665
 
 
1666
class cmd_log(Command):
 
1667
    """Show log of a branch, file, or directory.
 
1668
 
 
1669
    By default show the log of the branch containing the working directory.
 
1670
 
 
1671
    To request a range of logs, you can use the command -r begin..end
 
1672
    -r revision requests a specific revision, -r ..end or -r begin.. are
 
1673
    also valid.
 
1674
 
 
1675
    :Examples:
 
1676
        Log the current branch::
 
1677
 
 
1678
            bzr log
 
1679
 
 
1680
        Log a file::
 
1681
 
 
1682
            bzr log foo.c
 
1683
 
 
1684
        Log the last 10 revisions of a branch::
 
1685
 
 
1686
            bzr log -r -10.. http://server/branch
 
1687
    """
 
1688
 
 
1689
    # TODO: Make --revision support uuid: and hash: [future tag:] notation.
 
1690
 
 
1691
    takes_args = ['location?']
 
1692
    takes_options = [
 
1693
            Option('forward',
 
1694
                   help='Show from oldest to newest.'),
 
1695
            Option('timezone',
 
1696
                   type=str,
 
1697
                   help='Display timezone as local, original, or utc.'),
 
1698
            custom_help('verbose',
 
1699
                   help='Show files changed in each revision.'),
 
1700
            'show-ids',
 
1701
            'revision',
 
1702
            'log-format',
 
1703
            Option('message',
 
1704
                   short_name='m',
 
1705
                   help='Show revisions whose message matches this '
 
1706
                        'regular expression.',
 
1707
                   type=str),
 
1708
            Option('limit',
 
1709
                   short_name='l',
 
1710
                   help='Limit the output to the first N revisions.',
 
1711
                   argname='N',
 
1712
                   type=_parse_limit),
 
1713
            ]
 
1714
    encoding_type = 'replace'
 
1715
 
 
1716
    @display_command
 
1717
    def run(self, location=None, timezone='original',
 
1718
            verbose=False,
 
1719
            show_ids=False,
 
1720
            forward=False,
 
1721
            revision=None,
 
1722
            log_format=None,
 
1723
            message=None,
 
1724
            limit=None):
 
1725
        from bzrlib.log import show_log
 
1726
        assert message is None or isinstance(message, basestring), \
 
1727
            "invalid message argument %r" % message
 
1728
        direction = (forward and 'forward') or 'reverse'
 
1729
        
 
1730
        # log everything
 
1731
        file_id = None
 
1732
        if location:
 
1733
            # find the file id to log:
 
1734
 
 
1735
            tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
 
1736
                location)
 
1737
            if fp != '':
 
1738
                if tree is None:
 
1739
                    tree = b.basis_tree()
 
1740
                file_id = tree.path2id(fp)
 
1741
                if file_id is None:
 
1742
                    raise errors.BzrCommandError(
 
1743
                        "Path does not have any revision history: %s" %
 
1744
                        location)
 
1745
        else:
 
1746
            # local dir only
 
1747
            # FIXME ? log the current subdir only RBC 20060203 
 
1748
            if revision is not None \
 
1749
                    and len(revision) > 0 and revision[0].get_branch():
 
1750
                location = revision[0].get_branch()
 
1751
            else:
 
1752
                location = '.'
 
1753
            dir, relpath = bzrdir.BzrDir.open_containing(location)
 
1754
            b = dir.open_branch()
 
1755
 
 
1756
        b.lock_read()
 
1757
        try:
 
1758
            if revision is None:
 
1759
                rev1 = None
 
1760
                rev2 = None
 
1761
            elif len(revision) == 1:
 
1762
                rev1 = rev2 = revision[0].in_history(b)
 
1763
            elif len(revision) == 2:
 
1764
                if revision[1].get_branch() != revision[0].get_branch():
 
1765
                    # b is taken from revision[0].get_branch(), and
 
1766
                    # show_log will use its revision_history. Having
 
1767
                    # different branches will lead to weird behaviors.
 
1768
                    raise errors.BzrCommandError(
 
1769
                        "Log doesn't accept two revisions in different"
 
1770
                        " branches.")
 
1771
                rev1 = revision[0].in_history(b)
 
1772
                rev2 = revision[1].in_history(b)
 
1773
            else:
 
1774
                raise errors.BzrCommandError(
 
1775
                    'bzr log --revision takes one or two values.')
 
1776
 
 
1777
            if log_format is None:
 
1778
                log_format = log.log_formatter_registry.get_default(b)
 
1779
 
 
1780
            lf = log_format(show_ids=show_ids, to_file=self.outf,
 
1781
                            show_timezone=timezone)
 
1782
 
 
1783
            show_log(b,
 
1784
                     lf,
 
1785
                     file_id,
 
1786
                     verbose=verbose,
 
1787
                     direction=direction,
 
1788
                     start_revision=rev1,
 
1789
                     end_revision=rev2,
 
1790
                     search=message,
 
1791
                     limit=limit)
 
1792
        finally:
 
1793
            b.unlock()
 
1794
 
 
1795
 
 
1796
def get_log_format(long=False, short=False, line=False, default='long'):
 
1797
    log_format = default
 
1798
    if long:
 
1799
        log_format = 'long'
 
1800
    if short:
 
1801
        log_format = 'short'
 
1802
    if line:
 
1803
        log_format = 'line'
 
1804
    return log_format
 
1805
 
 
1806
 
 
1807
class cmd_touching_revisions(Command):
 
1808
    """Return revision-ids which affected a particular file.
 
1809
 
 
1810
    A more user-friendly interface is "bzr log FILE".
 
1811
    """
 
1812
 
 
1813
    hidden = True
 
1814
    takes_args = ["filename"]
 
1815
 
 
1816
    @display_command
 
1817
    def run(self, filename):
 
1818
        tree, relpath = WorkingTree.open_containing(filename)
 
1819
        b = tree.branch
 
1820
        file_id = tree.path2id(relpath)
 
1821
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
 
1822
            self.outf.write("%6d %s\n" % (revno, what))
 
1823
 
 
1824
 
 
1825
class cmd_ls(Command):
 
1826
    """List files in a tree.
 
1827
    """
 
1828
 
 
1829
    _see_also = ['status', 'cat']
 
1830
    takes_args = ['path?']
 
1831
    # TODO: Take a revision or remote path and list that tree instead.
 
1832
    takes_options = [
 
1833
            'verbose',
 
1834
            'revision',
 
1835
            Option('non-recursive',
 
1836
                   help='Don\'t recurse into subdirectories.'),
 
1837
            Option('from-root',
 
1838
                   help='Print paths relative to the root of the branch.'),
 
1839
            Option('unknown', help='Print unknown files.'),
 
1840
            Option('versioned', help='Print versioned files.'),
 
1841
            Option('ignored', help='Print ignored files.'),
 
1842
            Option('null',
 
1843
                   help='Write an ascii NUL (\\0) separator '
 
1844
                   'between files rather than a newline.'),
 
1845
            Option('kind',
 
1846
                   help='List entries of a particular kind: file, directory, symlink.',
 
1847
                   type=unicode),
 
1848
            'show-ids',
 
1849
            ]
 
1850
    @display_command
 
1851
    def run(self, revision=None, verbose=False,
 
1852
            non_recursive=False, from_root=False,
 
1853
            unknown=False, versioned=False, ignored=False,
 
1854
            null=False, kind=None, show_ids=False, path=None):
 
1855
 
 
1856
        if kind and kind not in ('file', 'directory', 'symlink'):
 
1857
            raise errors.BzrCommandError('invalid kind specified')
 
1858
 
 
1859
        if verbose and null:
 
1860
            raise errors.BzrCommandError('Cannot set both --verbose and --null')
 
1861
        all = not (unknown or versioned or ignored)
 
1862
 
 
1863
        selection = {'I':ignored, '?':unknown, 'V':versioned}
 
1864
 
 
1865
        if path is None:
 
1866
            fs_path = '.'
 
1867
            prefix = ''
 
1868
        else:
 
1869
            if from_root:
 
1870
                raise errors.BzrCommandError('cannot specify both --from-root'
 
1871
                                             ' and PATH')
 
1872
            fs_path = path
 
1873
            prefix = path
 
1874
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
 
1875
            fs_path)
 
1876
        if from_root:
 
1877
            relpath = u''
 
1878
        elif relpath:
 
1879
            relpath += '/'
 
1880
        if revision is not None:
 
1881
            tree = branch.repository.revision_tree(
 
1882
                revision[0].as_revision_id(branch))
 
1883
        elif tree is None:
 
1884
            tree = branch.basis_tree()
 
1885
 
 
1886
        tree.lock_read()
 
1887
        try:
 
1888
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
 
1889
                if fp.startswith(relpath):
 
1890
                    fp = osutils.pathjoin(prefix, fp[len(relpath):])
 
1891
                    if non_recursive and '/' in fp:
 
1892
                        continue
 
1893
                    if not all and not selection[fc]:
 
1894
                        continue
 
1895
                    if kind is not None and fkind != kind:
 
1896
                        continue
 
1897
                    if verbose:
 
1898
                        kindch = entry.kind_character()
 
1899
                        outstring = '%-8s %s%s' % (fc, fp, kindch)
 
1900
                        if show_ids and fid is not None:
 
1901
                            outstring = "%-50s %s" % (outstring, fid)
 
1902
                        self.outf.write(outstring + '\n')
 
1903
                    elif null:
 
1904
                        self.outf.write(fp + '\0')
 
1905
                        if show_ids:
 
1906
                            if fid is not None:
 
1907
                                self.outf.write(fid)
 
1908
                            self.outf.write('\0')
 
1909
                        self.outf.flush()
 
1910
                    else:
 
1911
                        if fid is not None:
 
1912
                            my_id = fid
 
1913
                        else:
 
1914
                            my_id = ''
 
1915
                        if show_ids:
 
1916
                            self.outf.write('%-50s %s\n' % (fp, my_id))
 
1917
                        else:
 
1918
                            self.outf.write(fp + '\n')
 
1919
        finally:
 
1920
            tree.unlock()
 
1921
 
 
1922
 
 
1923
class cmd_unknowns(Command):
 
1924
    """List unknown files.
 
1925
    """
 
1926
 
 
1927
    hidden = True
 
1928
    _see_also = ['ls']
 
1929
 
 
1930
    @display_command
 
1931
    def run(self):
 
1932
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
 
1933
            self.outf.write(osutils.quotefn(f) + '\n')
 
1934
 
 
1935
 
 
1936
class cmd_ignore(Command):
 
1937
    """Ignore specified files or patterns.
 
1938
 
 
1939
    To remove patterns from the ignore list, edit the .bzrignore file.
 
1940
 
 
1941
    Trailing slashes on patterns are ignored. 
 
1942
    If the pattern contains a slash or is a regular expression, it is compared 
 
1943
    to the whole path from the branch root.  Otherwise, it is compared to only
 
1944
    the last component of the path.  To match a file only in the root 
 
1945
    directory, prepend './'.
 
1946
 
 
1947
    Ignore patterns specifying absolute paths are not allowed.
 
1948
 
 
1949
    Ignore patterns may include globbing wildcards such as::
 
1950
 
 
1951
      ? - Matches any single character except '/'
 
1952
      * - Matches 0 or more characters except '/'
 
1953
      /**/ - Matches 0 or more directories in a path
 
1954
      [a-z] - Matches a single character from within a group of characters
 
1955
 
 
1956
    Ignore patterns may also be Python regular expressions.  
 
1957
    Regular expression ignore patterns are identified by a 'RE:' prefix 
 
1958
    followed by the regular expression.  Regular expression ignore patterns
 
1959
    may not include named or numbered groups.
 
1960
 
 
1961
    Note: ignore patterns containing shell wildcards must be quoted from 
 
1962
    the shell on Unix.
 
1963
 
 
1964
    :Examples:
 
1965
        Ignore the top level Makefile::
 
1966
 
 
1967
            bzr ignore ./Makefile
 
1968
 
 
1969
        Ignore class files in all directories::
 
1970
 
 
1971
            bzr ignore "*.class"
 
1972
 
 
1973
        Ignore .o files under the lib directory::
 
1974
 
 
1975
            bzr ignore "lib/**/*.o"
 
1976
 
 
1977
        Ignore .o files under the lib directory::
 
1978
 
 
1979
            bzr ignore "RE:lib/.*\.o"
 
1980
 
 
1981
        Ignore everything but the "debian" toplevel directory::
 
1982
 
 
1983
            bzr ignore "RE:(?!debian/).*"
 
1984
    """
 
1985
 
 
1986
    _see_also = ['status', 'ignored']
 
1987
    takes_args = ['name_pattern*']
 
1988
    takes_options = [
 
1989
        Option('old-default-rules',
 
1990
               help='Write out the ignore rules bzr < 0.9 always used.')
 
1991
        ]
 
1992
    
 
1993
    def run(self, name_pattern_list=None, old_default_rules=None):
 
1994
        from bzrlib.atomicfile import AtomicFile
 
1995
        if old_default_rules is not None:
 
1996
            # dump the rules and exit
 
1997
            for pattern in ignores.OLD_DEFAULTS:
 
1998
                print pattern
 
1999
            return
 
2000
        if not name_pattern_list:
 
2001
            raise errors.BzrCommandError("ignore requires at least one "
 
2002
                                  "NAME_PATTERN or --old-default-rules")
 
2003
        name_pattern_list = [globbing.normalize_pattern(p) 
 
2004
                             for p in name_pattern_list]
 
2005
        for name_pattern in name_pattern_list:
 
2006
            if (name_pattern[0] == '/' or 
 
2007
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
 
2008
                raise errors.BzrCommandError(
 
2009
                    "NAME_PATTERN should not be an absolute path")
 
2010
        tree, relpath = WorkingTree.open_containing(u'.')
 
2011
        ifn = tree.abspath('.bzrignore')
 
2012
        if os.path.exists(ifn):
 
2013
            f = open(ifn, 'rt')
 
2014
            try:
 
2015
                igns = f.read().decode('utf-8')
 
2016
            finally:
 
2017
                f.close()
 
2018
        else:
 
2019
            igns = ''
 
2020
 
 
2021
        # TODO: If the file already uses crlf-style termination, maybe
 
2022
        # we should use that for the newly added lines?
 
2023
 
 
2024
        if igns and igns[-1] != '\n':
 
2025
            igns += '\n'
 
2026
        for name_pattern in name_pattern_list:
 
2027
            igns += name_pattern + '\n'
 
2028
 
 
2029
        f = AtomicFile(ifn, 'wb')
 
2030
        try:
 
2031
            f.write(igns.encode('utf-8'))
 
2032
            f.commit()
 
2033
        finally:
 
2034
            f.close()
 
2035
 
 
2036
        if not tree.path2id('.bzrignore'):
 
2037
            tree.add(['.bzrignore'])
 
2038
 
 
2039
        ignored = globbing.Globster(name_pattern_list)
 
2040
        matches = []
 
2041
        tree.lock_read()
 
2042
        for entry in tree.list_files():
 
2043
            id = entry[3]
 
2044
            if id is not None:
 
2045
                filename = entry[0]
 
2046
                if ignored.match(filename):
 
2047
                    matches.append(filename.encode('utf-8'))
 
2048
        tree.unlock()
 
2049
        if len(matches) > 0:
 
2050
            print "Warning: the following files are version controlled and" \
 
2051
                  " match your ignore pattern:\n%s" % ("\n".join(matches),)
 
2052
 
 
2053
class cmd_ignored(Command):
 
2054
    """List ignored files and the patterns that matched them.
 
2055
    """
 
2056
 
 
2057
    encoding_type = 'replace'
 
2058
    _see_also = ['ignore']
 
2059
 
 
2060
    @display_command
 
2061
    def run(self):
 
2062
        tree = WorkingTree.open_containing(u'.')[0]
 
2063
        tree.lock_read()
 
2064
        try:
 
2065
            for path, file_class, kind, file_id, entry in tree.list_files():
 
2066
                if file_class != 'I':
 
2067
                    continue
 
2068
                ## XXX: Slightly inefficient since this was already calculated
 
2069
                pat = tree.is_ignored(path)
 
2070
                self.outf.write('%-50s %s\n' % (path, pat))
 
2071
        finally:
 
2072
            tree.unlock()
 
2073
 
 
2074
 
 
2075
class cmd_lookup_revision(Command):
 
2076
    """Lookup the revision-id from a revision-number
 
2077
 
 
2078
    :Examples:
 
2079
        bzr lookup-revision 33
 
2080
    """
 
2081
    hidden = True
 
2082
    takes_args = ['revno']
 
2083
    
 
2084
    @display_command
 
2085
    def run(self, revno):
 
2086
        try:
 
2087
            revno = int(revno)
 
2088
        except ValueError:
 
2089
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
 
2090
 
 
2091
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
2092
 
 
2093
 
 
2094
class cmd_export(Command):
 
2095
    """Export current or past revision to a destination directory or archive.
 
2096
 
 
2097
    If no revision is specified this exports the last committed revision.
 
2098
 
 
2099
    Format may be an "exporter" name, such as tar, tgz, tbz2.  If none is
 
2100
    given, try to find the format with the extension. If no extension
 
2101
    is found exports to a directory (equivalent to --format=dir).
 
2102
 
 
2103
    If root is supplied, it will be used as the root directory inside
 
2104
    container formats (tar, zip, etc). If it is not supplied it will default
 
2105
    to the exported filename. The root option has no effect for 'dir' format.
 
2106
 
 
2107
    If branch is omitted then the branch containing the current working
 
2108
    directory will be used.
 
2109
 
 
2110
    Note: Export of tree with non-ASCII filenames to zip is not supported.
 
2111
 
 
2112
      =================       =========================
 
2113
      Supported formats       Autodetected by extension
 
2114
      =================       =========================
 
2115
         dir                         (none)
 
2116
         tar                          .tar
 
2117
         tbz2                    .tar.bz2, .tbz2
 
2118
         tgz                      .tar.gz, .tgz
 
2119
         zip                          .zip
 
2120
      =================       =========================
 
2121
    """
 
2122
    takes_args = ['dest', 'branch?']
 
2123
    takes_options = [
 
2124
        Option('format',
 
2125
               help="Type of file to export to.",
 
2126
               type=unicode),
 
2127
        'revision',
 
2128
        Option('root',
 
2129
               type=str,
 
2130
               help="Name of the root directory inside the exported file."),
 
2131
        ]
 
2132
    def run(self, dest, branch=None, revision=None, format=None, root=None):
 
2133
        from bzrlib.export import export
 
2134
 
 
2135
        if branch is None:
 
2136
            tree = WorkingTree.open_containing(u'.')[0]
 
2137
            b = tree.branch
 
2138
        else:
 
2139
            b = Branch.open(branch)
 
2140
            
 
2141
        if revision is None:
 
2142
            # should be tree.last_revision  FIXME
 
2143
            rev_id = b.last_revision()
 
2144
        else:
 
2145
            if len(revision) != 1:
 
2146
                raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
 
2147
            rev_id = revision[0].as_revision_id(b)
 
2148
        t = b.repository.revision_tree(rev_id)
 
2149
        try:
 
2150
            export(t, dest, format, root)
 
2151
        except errors.NoSuchExportFormat, e:
 
2152
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
 
2153
 
 
2154
 
 
2155
class cmd_cat(Command):
 
2156
    """Write the contents of a file as of a given revision to standard output.
 
2157
 
 
2158
    If no revision is nominated, the last revision is used.
 
2159
 
 
2160
    Note: Take care to redirect standard output when using this command on a
 
2161
    binary file. 
 
2162
    """
 
2163
 
 
2164
    _see_also = ['ls']
 
2165
    takes_options = [
 
2166
        Option('name-from-revision', help='The path name in the old tree.'),
 
2167
        'revision',
 
2168
        ]
 
2169
    takes_args = ['filename']
 
2170
    encoding_type = 'exact'
 
2171
 
 
2172
    @display_command
 
2173
    def run(self, filename, revision=None, name_from_revision=False):
 
2174
        if revision is not None and len(revision) != 1:
 
2175
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
 
2176
                                         " one revision specifier")
 
2177
        tree, branch, relpath = \
 
2178
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
2179
        branch.lock_read()
 
2180
        try:
 
2181
            return self._run(tree, branch, relpath, filename, revision,
 
2182
                             name_from_revision)
 
2183
        finally:
 
2184
            branch.unlock()
 
2185
 
 
2186
    def _run(self, tree, b, relpath, filename, revision, name_from_revision):
 
2187
        if tree is None:
 
2188
            tree = b.basis_tree()
 
2189
        if revision is None:
 
2190
            revision_id = b.last_revision()
 
2191
        else:
 
2192
            revision_id = revision[0].as_revision_id(b)
 
2193
 
 
2194
        cur_file_id = tree.path2id(relpath)
 
2195
        rev_tree = b.repository.revision_tree(revision_id)
 
2196
        old_file_id = rev_tree.path2id(relpath)
 
2197
        
 
2198
        if name_from_revision:
 
2199
            if old_file_id is None:
 
2200
                raise errors.BzrCommandError("%r is not present in revision %s"
 
2201
                                                % (filename, revision_id))
 
2202
            else:
 
2203
                rev_tree.print_file(old_file_id)
 
2204
        elif cur_file_id is not None:
 
2205
            rev_tree.print_file(cur_file_id)
 
2206
        elif old_file_id is not None:
 
2207
            rev_tree.print_file(old_file_id)
 
2208
        else:
 
2209
            raise errors.BzrCommandError("%r is not present in revision %s" %
 
2210
                                         (filename, revision_id))
 
2211
 
 
2212
 
 
2213
class cmd_local_time_offset(Command):
 
2214
    """Show the offset in seconds from GMT to local time."""
 
2215
    hidden = True    
 
2216
    @display_command
 
2217
    def run(self):
 
2218
        print osutils.local_time_offset()
 
2219
 
 
2220
 
 
2221
 
 
2222
class cmd_commit(Command):
 
2223
    """Commit changes into a new revision.
 
2224
    
 
2225
    If no arguments are given, the entire tree is committed.
 
2226
 
 
2227
    If selected files are specified, only changes to those files are
 
2228
    committed.  If a directory is specified then the directory and everything 
 
2229
    within it is committed.
 
2230
 
 
2231
    If author of the change is not the same person as the committer, you can
 
2232
    specify the author's name using the --author option. The name should be
 
2233
    in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
 
2234
 
 
2235
    A selected-file commit may fail in some cases where the committed
 
2236
    tree would be invalid. Consider::
 
2237
 
 
2238
      bzr init foo
 
2239
      mkdir foo/bar
 
2240
      bzr add foo/bar
 
2241
      bzr commit foo -m "committing foo"
 
2242
      bzr mv foo/bar foo/baz
 
2243
      mkdir foo/bar
 
2244
      bzr add foo/bar
 
2245
      bzr commit foo/bar -m "committing bar but not baz"
 
2246
 
 
2247
    In the example above, the last commit will fail by design. This gives
 
2248
    the user the opportunity to decide whether they want to commit the
 
2249
    rename at the same time, separately first, or not at all. (As a general
 
2250
    rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
 
2251
 
 
2252
    Note: A selected-file commit after a merge is not yet supported.
 
2253
    """
 
2254
    # TODO: Run hooks on tree to-be-committed, and after commit.
 
2255
 
 
2256
    # TODO: Strict commit that fails if there are deleted files.
 
2257
    #       (what does "deleted files" mean ??)
 
2258
 
 
2259
    # TODO: Give better message for -s, --summary, used by tla people
 
2260
 
 
2261
    # XXX: verbose currently does nothing
 
2262
 
 
2263
    _see_also = ['bugs', 'uncommit']
 
2264
    takes_args = ['selected*']
 
2265
    takes_options = [
 
2266
            Option('message', type=unicode,
 
2267
                   short_name='m',
 
2268
                   help="Description of the new revision."),
 
2269
            'verbose',
 
2270
             Option('unchanged',
 
2271
                    help='Commit even if nothing has changed.'),
 
2272
             Option('file', type=str,
 
2273
                    short_name='F',
 
2274
                    argname='msgfile',
 
2275
                    help='Take commit message from this file.'),
 
2276
             Option('strict',
 
2277
                    help="Refuse to commit if there are unknown "
 
2278
                    "files in the working tree."),
 
2279
             ListOption('fixes', type=str,
 
2280
                    help="Mark a bug as being fixed by this revision."),
 
2281
             Option('author', type=unicode,
 
2282
                    help="Set the author's name, if it's different "
 
2283
                         "from the committer."),
 
2284
             Option('local',
 
2285
                    help="Perform a local commit in a bound "
 
2286
                         "branch.  Local commits are not pushed to "
 
2287
                         "the master branch until a normal commit "
 
2288
                         "is performed."
 
2289
                    ),
 
2290
              Option('show-diff',
 
2291
                     help='When no message is supplied, show the diff along'
 
2292
                     ' with the status summary in the message editor.'),
 
2293
             ]
 
2294
    aliases = ['ci', 'checkin']
 
2295
 
 
2296
    def _get_bug_fix_properties(self, fixes, branch):
 
2297
        properties = []
 
2298
        # Configure the properties for bug fixing attributes.
 
2299
        for fixed_bug in fixes:
 
2300
            tokens = fixed_bug.split(':')
 
2301
            if len(tokens) != 2:
 
2302
                raise errors.BzrCommandError(
 
2303
                    "Invalid bug %s. Must be in the form of 'tag:id'. "
 
2304
                    "Commit refused." % fixed_bug)
 
2305
            tag, bug_id = tokens
 
2306
            try:
 
2307
                bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
 
2308
            except errors.UnknownBugTrackerAbbreviation:
 
2309
                raise errors.BzrCommandError(
 
2310
                    'Unrecognized bug %s. Commit refused.' % fixed_bug)
 
2311
            except errors.MalformedBugIdentifier:
 
2312
                raise errors.BzrCommandError(
 
2313
                    "Invalid bug identifier for %s. Commit refused."
 
2314
                    % fixed_bug)
 
2315
            properties.append('%s fixed' % bug_url)
 
2316
        return '\n'.join(properties)
 
2317
 
 
2318
    def run(self, message=None, file=None, verbose=False, selected_list=None,
 
2319
            unchanged=False, strict=False, local=False, fixes=None,
 
2320
            author=None, show_diff=False):
 
2321
        from bzrlib.errors import (
 
2322
            PointlessCommit,
 
2323
            ConflictsInTree,
 
2324
            StrictCommitFailed
 
2325
        )
 
2326
        from bzrlib.msgeditor import (
 
2327
            edit_commit_message_encoded,
 
2328
            make_commit_message_template_encoded
 
2329
        )
 
2330
 
 
2331
        # TODO: Need a blackbox test for invoking the external editor; may be
 
2332
        # slightly problematic to run this cross-platform.
 
2333
 
 
2334
        # TODO: do more checks that the commit will succeed before 
 
2335
        # spending the user's valuable time typing a commit message.
 
2336
 
 
2337
        properties = {}
 
2338
 
 
2339
        tree, selected_list = tree_files(selected_list)
 
2340
        if selected_list == ['']:
 
2341
            # workaround - commit of root of tree should be exactly the same
 
2342
            # as just default commit in that tree, and succeed even though
 
2343
            # selected-file merge commit is not done yet
 
2344
            selected_list = []
 
2345
 
 
2346
        if fixes is None:
 
2347
            fixes = []
 
2348
        bug_property = self._get_bug_fix_properties(fixes, tree.branch)
 
2349
        if bug_property:
 
2350
            properties['bugs'] = bug_property
 
2351
 
 
2352
        if local and not tree.branch.get_bound_location():
 
2353
            raise errors.LocalRequiresBoundBranch()
 
2354
 
 
2355
        def get_message(commit_obj):
 
2356
            """Callback to get commit message"""
 
2357
            my_message = message
 
2358
            if my_message is None and not file:
 
2359
                t = make_commit_message_template_encoded(tree,
 
2360
                        selected_list, diff=show_diff,
 
2361
                        output_encoding=bzrlib.user_encoding)
 
2362
                my_message = edit_commit_message_encoded(t)
 
2363
                if my_message is None:
 
2364
                    raise errors.BzrCommandError("please specify a commit"
 
2365
                        " message with either --message or --file")
 
2366
            elif my_message and file:
 
2367
                raise errors.BzrCommandError(
 
2368
                    "please specify either --message or --file")
 
2369
            if file:
 
2370
                my_message = codecs.open(file, 'rt', 
 
2371
                                         bzrlib.user_encoding).read()
 
2372
            if my_message == "":
 
2373
                raise errors.BzrCommandError("empty commit message specified")
 
2374
            return my_message
 
2375
 
 
2376
        try:
 
2377
            tree.commit(message_callback=get_message,
 
2378
                        specific_files=selected_list,
 
2379
                        allow_pointless=unchanged, strict=strict, local=local,
 
2380
                        reporter=None, verbose=verbose, revprops=properties,
 
2381
                        author=author)
 
2382
        except PointlessCommit:
 
2383
            # FIXME: This should really happen before the file is read in;
 
2384
            # perhaps prepare the commit; get the message; then actually commit
 
2385
            raise errors.BzrCommandError("no changes to commit."
 
2386
                              " use --unchanged to commit anyhow")
 
2387
        except ConflictsInTree:
 
2388
            raise errors.BzrCommandError('Conflicts detected in working '
 
2389
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
 
2390
                ' resolve.')
 
2391
        except StrictCommitFailed:
 
2392
            raise errors.BzrCommandError("Commit refused because there are"
 
2393
                              " unknown files in the working tree.")
 
2394
        except errors.BoundBranchOutOfDate, e:
 
2395
            raise errors.BzrCommandError(str(e) + "\n"
 
2396
            'To commit to master branch, run update and then commit.\n'
 
2397
            'You can also pass --local to commit to continue working '
 
2398
            'disconnected.')
 
2399
 
 
2400
 
 
2401
class cmd_check(Command):
 
2402
    """Validate consistency of branch history.
 
2403
 
 
2404
    This command checks various invariants about the branch storage to
 
2405
    detect data corruption or bzr bugs.
 
2406
 
 
2407
    Output fields:
 
2408
 
 
2409
        revisions: This is just the number of revisions checked.  It doesn't
 
2410
            indicate a problem.
 
2411
        versionedfiles: This is just the number of versionedfiles checked.  It
 
2412
            doesn't indicate a problem.
 
2413
        unreferenced ancestors: Texts that are ancestors of other texts, but
 
2414
            are not properly referenced by the revision ancestry.  This is a
 
2415
            subtle problem that Bazaar can work around.
 
2416
        unique file texts: This is the total number of unique file contents
 
2417
            seen in the checked revisions.  It does not indicate a problem.
 
2418
        repeated file texts: This is the total number of repeated texts seen
 
2419
            in the checked revisions.  Texts can be repeated when their file
 
2420
            entries are modified, but the file contents are not.  It does not
 
2421
            indicate a problem.
 
2422
    """
 
2423
 
 
2424
    _see_also = ['reconcile']
 
2425
    takes_args = ['branch?']
 
2426
    takes_options = ['verbose']
 
2427
 
 
2428
    def run(self, branch=None, verbose=False):
 
2429
        from bzrlib.check import check
 
2430
        if branch is None:
 
2431
            branch_obj = Branch.open_containing('.')[0]
 
2432
        else:
 
2433
            branch_obj = Branch.open(branch)
 
2434
        check(branch_obj, verbose)
 
2435
        # bit hacky, check the tree parent is accurate
 
2436
        try:
 
2437
            if branch is None:
 
2438
                tree = WorkingTree.open_containing('.')[0]
 
2439
            else:
 
2440
                tree = WorkingTree.open(branch)
 
2441
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
2442
            pass
 
2443
        else:
 
2444
            # This is a primitive 'check' for tree state. Currently this is not
 
2445
            # integrated into the main check logic as yet.
 
2446
            tree.lock_read()
 
2447
            try:
 
2448
                tree_basis = tree.basis_tree()
 
2449
                tree_basis.lock_read()
 
2450
                try:
 
2451
                    repo_basis = tree.branch.repository.revision_tree(
 
2452
                        tree.last_revision())
 
2453
                    if len(list(repo_basis.iter_changes(tree_basis))):
 
2454
                        raise errors.BzrCheckError(
 
2455
                            "Mismatched basis inventory content.")
 
2456
                    tree._validate()
 
2457
                finally:
 
2458
                    tree_basis.unlock()
 
2459
            finally:
 
2460
                tree.unlock()
 
2461
 
 
2462
 
 
2463
class cmd_upgrade(Command):
 
2464
    """Upgrade branch storage to current format.
 
2465
 
 
2466
    The check command or bzr developers may sometimes advise you to run
 
2467
    this command. When the default format has changed you may also be warned
 
2468
    during other operations to upgrade.
 
2469
    """
 
2470
 
 
2471
    _see_also = ['check']
 
2472
    takes_args = ['url?']
 
2473
    takes_options = [
 
2474
                    RegistryOption('format',
 
2475
                        help='Upgrade to a specific format.  See "bzr help'
 
2476
                             ' formats" for details.',
 
2477
                        registry=bzrdir.format_registry,
 
2478
                        converter=bzrdir.format_registry.make_bzrdir,
 
2479
                        value_switches=True, title='Branch format'),
 
2480
                    ]
 
2481
 
 
2482
    def run(self, url='.', format=None):
 
2483
        from bzrlib.upgrade import upgrade
 
2484
        if format is None:
 
2485
            format = bzrdir.format_registry.make_bzrdir('default')
 
2486
        upgrade(url, format)
 
2487
 
 
2488
 
 
2489
class cmd_whoami(Command):
 
2490
    """Show or set bzr user id.
 
2491
    
 
2492
    :Examples:
 
2493
        Show the email of the current user::
 
2494
 
 
2495
            bzr whoami --email
 
2496
 
 
2497
        Set the current user::
 
2498
 
 
2499
            bzr whoami "Frank Chu <fchu@example.com>"
 
2500
    """
 
2501
    takes_options = [ Option('email',
 
2502
                             help='Display email address only.'),
 
2503
                      Option('branch',
 
2504
                             help='Set identity for the current branch instead of '
 
2505
                                  'globally.'),
 
2506
                    ]
 
2507
    takes_args = ['name?']
 
2508
    encoding_type = 'replace'
 
2509
    
 
2510
    @display_command
 
2511
    def run(self, email=False, branch=False, name=None):
 
2512
        if name is None:
 
2513
            # use branch if we're inside one; otherwise global config
 
2514
            try:
 
2515
                c = Branch.open_containing('.')[0].get_config()
 
2516
            except errors.NotBranchError:
 
2517
                c = config.GlobalConfig()
 
2518
            if email:
 
2519
                self.outf.write(c.user_email() + '\n')
 
2520
            else:
 
2521
                self.outf.write(c.username() + '\n')
 
2522
            return
 
2523
 
 
2524
        # display a warning if an email address isn't included in the given name.
 
2525
        try:
 
2526
            config.extract_email_address(name)
 
2527
        except errors.NoEmailInUsername, e:
 
2528
            warning('"%s" does not seem to contain an email address.  '
 
2529
                    'This is allowed, but not recommended.', name)
 
2530
        
 
2531
        # use global config unless --branch given
 
2532
        if branch:
 
2533
            c = Branch.open_containing('.')[0].get_config()
 
2534
        else:
 
2535
            c = config.GlobalConfig()
 
2536
        c.set_user_option('email', name)
 
2537
 
 
2538
 
 
2539
class cmd_nick(Command):
 
2540
    """Print or set the branch nickname.  
 
2541
 
 
2542
    If unset, the tree root directory name is used as the nickname
 
2543
    To print the current nickname, execute with no argument.  
 
2544
    """
 
2545
 
 
2546
    _see_also = ['info']
 
2547
    takes_args = ['nickname?']
 
2548
    def run(self, nickname=None):
 
2549
        branch = Branch.open_containing(u'.')[0]
 
2550
        if nickname is None:
 
2551
            self.printme(branch)
 
2552
        else:
 
2553
            branch.nick = nickname
 
2554
 
 
2555
    @display_command
 
2556
    def printme(self, branch):
 
2557
        print branch.nick
 
2558
 
 
2559
 
 
2560
class cmd_selftest(Command):
 
2561
    """Run internal test suite.
 
2562
    
 
2563
    If arguments are given, they are regular expressions that say which tests
 
2564
    should run.  Tests matching any expression are run, and other tests are
 
2565
    not run.
 
2566
 
 
2567
    Alternatively if --first is given, matching tests are run first and then
 
2568
    all other tests are run.  This is useful if you have been working in a
 
2569
    particular area, but want to make sure nothing else was broken.
 
2570
 
 
2571
    If --exclude is given, tests that match that regular expression are
 
2572
    excluded, regardless of whether they match --first or not.
 
2573
 
 
2574
    To help catch accidential dependencies between tests, the --randomize
 
2575
    option is useful. In most cases, the argument used is the word 'now'.
 
2576
    Note that the seed used for the random number generator is displayed
 
2577
    when this option is used. The seed can be explicitly passed as the
 
2578
    argument to this option if required. This enables reproduction of the
 
2579
    actual ordering used if and when an order sensitive problem is encountered.
 
2580
 
 
2581
    If --list-only is given, the tests that would be run are listed. This is
 
2582
    useful when combined with --first, --exclude and/or --randomize to
 
2583
    understand their impact. The test harness reports "Listed nn tests in ..."
 
2584
    instead of "Ran nn tests in ..." when list mode is enabled.
 
2585
 
 
2586
    If the global option '--no-plugins' is given, plugins are not loaded
 
2587
    before running the selftests.  This has two effects: features provided or
 
2588
    modified by plugins will not be tested, and tests provided by plugins will
 
2589
    not be run.
 
2590
 
 
2591
    Tests that need working space on disk use a common temporary directory, 
 
2592
    typically inside $TMPDIR or /tmp.
 
2593
 
 
2594
    :Examples:
 
2595
        Run only tests relating to 'ignore'::
 
2596
 
 
2597
            bzr selftest ignore
 
2598
 
 
2599
        Disable plugins and list tests as they're run::
 
2600
 
 
2601
            bzr --no-plugins selftest -v
 
2602
    """
 
2603
    # NB: this is used from the class without creating an instance, which is
 
2604
    # why it does not have a self parameter.
 
2605
    def get_transport_type(typestring):
 
2606
        """Parse and return a transport specifier."""
 
2607
        if typestring == "sftp":
 
2608
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
2609
            return SFTPAbsoluteServer
 
2610
        if typestring == "memory":
 
2611
            from bzrlib.transport.memory import MemoryServer
 
2612
            return MemoryServer
 
2613
        if typestring == "fakenfs":
 
2614
            from bzrlib.transport.fakenfs import FakeNFSServer
 
2615
            return FakeNFSServer
 
2616
        msg = "No known transport type %s. Supported types are: sftp\n" %\
 
2617
            (typestring)
 
2618
        raise errors.BzrCommandError(msg)
 
2619
 
 
2620
    hidden = True
 
2621
    takes_args = ['testspecs*']
 
2622
    takes_options = ['verbose',
 
2623
                     Option('one',
 
2624
                             help='Stop when one test fails.',
 
2625
                             short_name='1',
 
2626
                             ),
 
2627
                     Option('transport',
 
2628
                            help='Use a different transport by default '
 
2629
                                 'throughout the test suite.',
 
2630
                            type=get_transport_type),
 
2631
                     Option('benchmark',
 
2632
                            help='Run the benchmarks rather than selftests.'),
 
2633
                     Option('lsprof-timed',
 
2634
                            help='Generate lsprof output for benchmarked'
 
2635
                                 ' sections of code.'),
 
2636
                     Option('cache-dir', type=str,
 
2637
                            help='Cache intermediate benchmark output in this '
 
2638
                                 'directory.'),
 
2639
                     Option('first',
 
2640
                            help='Run all tests, but run specified tests first.',
 
2641
                            short_name='f',
 
2642
                            ),
 
2643
                     Option('list-only',
 
2644
                            help='List the tests instead of running them.'),
 
2645
                     Option('randomize', type=str, argname="SEED",
 
2646
                            help='Randomize the order of tests using the given'
 
2647
                                 ' seed or "now" for the current time.'),
 
2648
                     Option('exclude', type=str, argname="PATTERN",
 
2649
                            short_name='x',
 
2650
                            help='Exclude tests that match this regular'
 
2651
                                 ' expression.'),
 
2652
                     Option('strict', help='Fail on missing dependencies or '
 
2653
                            'known failures.'),
 
2654
                     Option('load-list', type=str, argname='TESTLISTFILE',
 
2655
                            help='Load a test id list from a text file.'),
 
2656
                     ]
 
2657
    encoding_type = 'replace'
 
2658
 
 
2659
    def run(self, testspecs_list=None, verbose=False, one=False,
 
2660
            transport=None, benchmark=None,
 
2661
            lsprof_timed=None, cache_dir=None,
 
2662
            first=False, list_only=False,
 
2663
            randomize=None, exclude=None, strict=False,
 
2664
            load_list=None):
 
2665
        import bzrlib.ui
 
2666
        from bzrlib.tests import selftest
 
2667
        import bzrlib.benchmarks as benchmarks
 
2668
        from bzrlib.benchmarks import tree_creator
 
2669
 
 
2670
        if cache_dir is not None:
 
2671
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
 
2672
        if not list_only:
 
2673
            print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
 
2674
            print '   %s (%s python%s)' % (
 
2675
                    bzrlib.__path__[0],
 
2676
                    bzrlib.version_string,
 
2677
                    bzrlib._format_version_tuple(sys.version_info),
 
2678
                    )
 
2679
        print
 
2680
        if testspecs_list is not None:
 
2681
            pattern = '|'.join(testspecs_list)
 
2682
        else:
 
2683
            pattern = ".*"
 
2684
        if benchmark:
 
2685
            test_suite_factory = benchmarks.test_suite
 
2686
            # Unless user explicitly asks for quiet, be verbose in benchmarks
 
2687
            verbose = not is_quiet()
 
2688
            # TODO: should possibly lock the history file...
 
2689
            benchfile = open(".perf_history", "at", buffering=1)
 
2690
        else:
 
2691
            test_suite_factory = None
 
2692
            benchfile = None
 
2693
        try:
 
2694
            result = selftest(verbose=verbose,
 
2695
                              pattern=pattern,
 
2696
                              stop_on_failure=one,
 
2697
                              transport=transport,
 
2698
                              test_suite_factory=test_suite_factory,
 
2699
                              lsprof_timed=lsprof_timed,
 
2700
                              bench_history=benchfile,
 
2701
                              matching_tests_first=first,
 
2702
                              list_only=list_only,
 
2703
                              random_seed=randomize,
 
2704
                              exclude_pattern=exclude,
 
2705
                              strict=strict,
 
2706
                              load_list=load_list,
 
2707
                              )
 
2708
        finally:
 
2709
            if benchfile is not None:
 
2710
                benchfile.close()
 
2711
        if result:
 
2712
            note('tests passed')
 
2713
        else:
 
2714
            note('tests failed')
 
2715
        return int(not result)
 
2716
 
 
2717
 
 
2718
class cmd_version(Command):
 
2719
    """Show version of bzr."""
 
2720
 
 
2721
    encoding_type = 'replace'
 
2722
 
 
2723
    @display_command
 
2724
    def run(self):
 
2725
        from bzrlib.version import show_version
 
2726
        show_version(to_file=self.outf)
 
2727
 
 
2728
 
 
2729
class cmd_rocks(Command):
 
2730
    """Statement of optimism."""
 
2731
 
 
2732
    hidden = True
 
2733
 
 
2734
    @display_command
 
2735
    def run(self):
 
2736
        print "It sure does!"
 
2737
 
 
2738
 
 
2739
class cmd_find_merge_base(Command):
 
2740
    """Find and print a base revision for merging two branches."""
 
2741
    # TODO: Options to specify revisions on either side, as if
 
2742
    #       merging only part of the history.
 
2743
    takes_args = ['branch', 'other']
 
2744
    hidden = True
 
2745
    
 
2746
    @display_command
 
2747
    def run(self, branch, other):
 
2748
        from bzrlib.revision import ensure_null
 
2749
        
 
2750
        branch1 = Branch.open_containing(branch)[0]
 
2751
        branch2 = Branch.open_containing(other)[0]
 
2752
        branch1.lock_read()
 
2753
        try:
 
2754
            branch2.lock_read()
 
2755
            try:
 
2756
                last1 = ensure_null(branch1.last_revision())
 
2757
                last2 = ensure_null(branch2.last_revision())
 
2758
 
 
2759
                graph = branch1.repository.get_graph(branch2.repository)
 
2760
                base_rev_id = graph.find_unique_lca(last1, last2)
 
2761
 
 
2762
                print 'merge base is revision %s' % base_rev_id
 
2763
            finally:
 
2764
                branch2.unlock()
 
2765
        finally:
 
2766
            branch1.unlock()
 
2767
 
 
2768
 
 
2769
class cmd_merge(Command):
 
2770
    """Perform a three-way merge.
 
2771
    
 
2772
    The source of the merge can be specified either in the form of a branch,
 
2773
    or in the form of a path to a file containing a merge directive generated
 
2774
    with bzr send. If neither is specified, the default is the upstream branch
 
2775
    or the branch most recently merged using --remember.
 
2776
 
 
2777
    When merging a branch, by default the tip will be merged. To pick a different
 
2778
    revision, pass --revision. If you specify two values, the first will be used as
 
2779
    BASE and the second one as OTHER. Merging individual revisions, or a subset of
 
2780
    available revisions, like this is commonly referred to as "cherrypicking".
 
2781
 
 
2782
    Revision numbers are always relative to the branch being merged.
 
2783
 
 
2784
    By default, bzr will try to merge in all new work from the other
 
2785
    branch, automatically determining an appropriate base.  If this
 
2786
    fails, you may need to give an explicit base.
 
2787
    
 
2788
    Merge will do its best to combine the changes in two branches, but there
 
2789
    are some kinds of problems only a human can fix.  When it encounters those,
 
2790
    it will mark a conflict.  A conflict means that you need to fix something,
 
2791
    before you should commit.
 
2792
 
 
2793
    Use bzr resolve when you have fixed a problem.  See also bzr conflicts.
 
2794
 
 
2795
    If there is no default branch set, the first merge will set it. After
 
2796
    that, you can omit the branch to use the default.  To change the
 
2797
    default, use --remember. The value will only be saved if the remote
 
2798
    location can be accessed.
 
2799
 
 
2800
    The results of the merge are placed into the destination working
 
2801
    directory, where they can be reviewed (with bzr diff), tested, and then
 
2802
    committed to record the result of the merge.
 
2803
    
 
2804
    merge refuses to run if there are any uncommitted changes, unless
 
2805
    --force is given.
 
2806
 
 
2807
    :Examples:
 
2808
        To merge the latest revision from bzr.dev::
 
2809
 
 
2810
            bzr merge ../bzr.dev
 
2811
 
 
2812
        To merge changes up to and including revision 82 from bzr.dev::
 
2813
 
 
2814
            bzr merge -r 82 ../bzr.dev
 
2815
 
 
2816
        To merge the changes introduced by 82, without previous changes::
 
2817
 
 
2818
            bzr merge -r 81..82 ../bzr.dev
 
2819
 
 
2820
        To apply a merge directive contained in in /tmp/merge:
 
2821
 
 
2822
            bzr merge /tmp/merge
 
2823
    """
 
2824
 
 
2825
    encoding_type = 'exact'
 
2826
    _see_also = ['update', 'remerge', 'status-flags']
 
2827
    takes_args = ['location?']
 
2828
    takes_options = [
 
2829
        'change',
 
2830
        'revision',
 
2831
        Option('force',
 
2832
               help='Merge even if the destination tree has uncommitted changes.'),
 
2833
        'merge-type',
 
2834
        'reprocess',
 
2835
        'remember',
 
2836
        Option('show-base', help="Show base revision text in "
 
2837
               "conflicts."),
 
2838
        Option('uncommitted', help='Apply uncommitted changes'
 
2839
               ' from a working copy, instead of branch changes.'),
 
2840
        Option('pull', help='If the destination is already'
 
2841
                ' completely merged into the source, pull from the'
 
2842
                ' source rather than merging.  When this happens,'
 
2843
                ' you do not need to commit the result.'),
 
2844
        Option('directory',
 
2845
               help='Branch to merge into, '
 
2846
                    'rather than the one containing the working directory.',
 
2847
               short_name='d',
 
2848
               type=unicode,
 
2849
               ),
 
2850
        Option('preview', help='Instead of merging, show a diff of the merge.')
 
2851
    ]
 
2852
 
 
2853
    def run(self, location=None, revision=None, force=False,
 
2854
            merge_type=None, show_base=False, reprocess=False, remember=False,
 
2855
            uncommitted=False, pull=False,
 
2856
            directory=None,
 
2857
            preview=False,
 
2858
            ):
 
2859
        if merge_type is None:
 
2860
            merge_type = _mod_merge.Merge3Merger
 
2861
 
 
2862
        if directory is None: directory = u'.'
 
2863
        possible_transports = []
 
2864
        merger = None
 
2865
        allow_pending = True
 
2866
        verified = 'inapplicable'
 
2867
        tree = WorkingTree.open_containing(directory)[0]
 
2868
        change_reporter = delta._ChangeReporter(
 
2869
            unversioned_filter=tree.is_ignored)
 
2870
        cleanups = []
 
2871
        try:
 
2872
            pb = ui.ui_factory.nested_progress_bar()
 
2873
            cleanups.append(pb.finished)
 
2874
            tree.lock_write()
 
2875
            cleanups.append(tree.unlock)
 
2876
            if location is not None:
 
2877
                try:
 
2878
                    mergeable = bundle.read_mergeable_from_url(location,
 
2879
                        possible_transports=possible_transports)
 
2880
                except errors.NotABundle:
 
2881
                    mergeable = None
 
2882
                else:
 
2883
                    if uncommitted:
 
2884
                        raise errors.BzrCommandError('Cannot use --uncommitted'
 
2885
                            ' with bundles or merge directives.')
 
2886
 
 
2887
                    if revision is not None:
 
2888
                        raise errors.BzrCommandError(
 
2889
                            'Cannot use -r with merge directives or bundles')
 
2890
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
2891
                       mergeable, pb)
 
2892
 
 
2893
            if merger is None and uncommitted:
 
2894
                if revision is not None and len(revision) > 0:
 
2895
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
 
2896
                        ' --revision at the same time.')
 
2897
                location = self._select_branch_location(tree, location)[0]
 
2898
                other_tree, other_path = WorkingTree.open_containing(location)
 
2899
                merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
 
2900
                    pb)
 
2901
                allow_pending = False
 
2902
                if other_path != '':
 
2903
                    merger.interesting_files = [other_path]
 
2904
 
 
2905
            if merger is None:
 
2906
                merger, allow_pending = self._get_merger_from_branch(tree,
 
2907
                    location, revision, remember, possible_transports, pb)
 
2908
 
 
2909
            merger.merge_type = merge_type
 
2910
            merger.reprocess = reprocess
 
2911
            merger.show_base = show_base
 
2912
            self.sanity_check_merger(merger)
 
2913
            if (merger.base_rev_id == merger.other_rev_id and
 
2914
                merger.other_rev_id != None):
 
2915
                note('Nothing to do.')
 
2916
                return 0
 
2917
            if pull:
 
2918
                if merger.interesting_files is not None:
 
2919
                    raise errors.BzrCommandError('Cannot pull individual files')
 
2920
                if (merger.base_rev_id == tree.last_revision()):
 
2921
                    result = tree.pull(merger.other_branch, False,
 
2922
                                       merger.other_rev_id)
 
2923
                    result.report(self.outf)
 
2924
                    return 0
 
2925
            merger.check_basis(not force)
 
2926
            if preview:
 
2927
                return self._do_preview(merger)
 
2928
            else:
 
2929
                return self._do_merge(merger, change_reporter, allow_pending,
 
2930
                                      verified)
 
2931
        finally:
 
2932
            for cleanup in reversed(cleanups):
 
2933
                cleanup()
 
2934
 
 
2935
    def _do_preview(self, merger):
 
2936
        from bzrlib.diff import show_diff_trees
 
2937
        tree_merger = merger.make_merger()
 
2938
        tt = tree_merger.make_preview_transform()
 
2939
        try:
 
2940
            result_tree = tt.get_preview_tree()
 
2941
            show_diff_trees(merger.this_tree, result_tree, self.outf,
 
2942
                            old_label='', new_label='')
 
2943
        finally:
 
2944
            tt.finalize()
 
2945
 
 
2946
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
 
2947
        merger.change_reporter = change_reporter
 
2948
        conflict_count = merger.do_merge()
 
2949
        if allow_pending:
 
2950
            merger.set_pending()
 
2951
        if verified == 'failed':
 
2952
            warning('Preview patch does not match changes')
 
2953
        if conflict_count != 0:
 
2954
            return 1
 
2955
        else:
 
2956
            return 0
 
2957
 
 
2958
    def sanity_check_merger(self, merger):
 
2959
        if (merger.show_base and
 
2960
            not merger.merge_type is _mod_merge.Merge3Merger):
 
2961
            raise errors.BzrCommandError("Show-base is not supported for this"
 
2962
                                         " merge type. %s" % merger.merge_type)
 
2963
        if merger.reprocess and not merger.merge_type.supports_reprocess:
 
2964
            raise errors.BzrCommandError("Conflict reduction is not supported"
 
2965
                                         " for merge type %s." %
 
2966
                                         merger.merge_type)
 
2967
        if merger.reprocess and merger.show_base:
 
2968
            raise errors.BzrCommandError("Cannot do conflict reduction and"
 
2969
                                         " show base.")
 
2970
 
 
2971
    def _get_merger_from_branch(self, tree, location, revision, remember,
 
2972
                                possible_transports, pb):
 
2973
        """Produce a merger from a location, assuming it refers to a branch."""
 
2974
        from bzrlib.tag import _merge_tags_if_possible
 
2975
        assert revision is None or len(revision) < 3
 
2976
        # find the branch locations
 
2977
        other_loc, user_location = self._select_branch_location(tree, location,
 
2978
            revision, -1)
 
2979
        if revision is not None and len(revision) == 2:
 
2980
            base_loc, _unused = self._select_branch_location(tree,
 
2981
                location, revision, 0)
 
2982
        else:
 
2983
            base_loc = other_loc
 
2984
        # Open the branches
 
2985
        other_branch, other_path = Branch.open_containing(other_loc,
 
2986
            possible_transports)
 
2987
        if base_loc == other_loc:
 
2988
            base_branch = other_branch
 
2989
        else:
 
2990
            base_branch, base_path = Branch.open_containing(base_loc,
 
2991
                possible_transports)
 
2992
        # Find the revision ids
 
2993
        if revision is None or len(revision) < 1 or revision[-1] is None:
 
2994
            other_revision_id = _mod_revision.ensure_null(
 
2995
                other_branch.last_revision())
 
2996
        else:
 
2997
            other_revision_id = revision[-1].as_revision_id(other_branch)
 
2998
        if (revision is not None and len(revision) == 2
 
2999
            and revision[0] is not None):
 
3000
            base_revision_id = revision[0].as_revision_id(base_branch)
 
3001
        else:
 
3002
            base_revision_id = None
 
3003
        # Remember where we merge from
 
3004
        if ((remember or tree.branch.get_submit_branch() is None) and
 
3005
             user_location is not None):
 
3006
            tree.branch.set_submit_branch(other_branch.base)
 
3007
        _merge_tags_if_possible(other_branch, tree.branch)
 
3008
        merger = _mod_merge.Merger.from_revision_ids(pb, tree,
 
3009
            other_revision_id, base_revision_id, other_branch, base_branch)
 
3010
        if other_path != '':
 
3011
            allow_pending = False
 
3012
            merger.interesting_files = [other_path]
 
3013
        else:
 
3014
            allow_pending = True
 
3015
        return merger, allow_pending
 
3016
 
 
3017
    def _select_branch_location(self, tree, user_location, revision=None,
 
3018
                                index=None):
 
3019
        """Select a branch location, according to possible inputs.
 
3020
 
 
3021
        If provided, branches from ``revision`` are preferred.  (Both
 
3022
        ``revision`` and ``index`` must be supplied.)
 
3023
 
 
3024
        Otherwise, the ``location`` parameter is used.  If it is None, then the
 
3025
        ``submit`` or ``parent`` location is used, and a note is printed.
 
3026
 
 
3027
        :param tree: The working tree to select a branch for merging into
 
3028
        :param location: The location entered by the user
 
3029
        :param revision: The revision parameter to the command
 
3030
        :param index: The index to use for the revision parameter.  Negative
 
3031
            indices are permitted.
 
3032
        :return: (selected_location, user_location).  The default location
 
3033
            will be the user-entered location.
 
3034
        """
 
3035
        if (revision is not None and index is not None
 
3036
            and revision[index] is not None):
 
3037
            branch = revision[index].get_branch()
 
3038
            if branch is not None:
 
3039
                return branch, branch
 
3040
        if user_location is None:
 
3041
            location = self._get_remembered(tree, 'Merging from')
 
3042
        else:
 
3043
            location = user_location
 
3044
        return location, user_location
 
3045
 
 
3046
    def _get_remembered(self, tree, verb_string):
 
3047
        """Use tree.branch's parent if none was supplied.
 
3048
 
 
3049
        Report if the remembered location was used.
 
3050
        """
 
3051
        stored_location = tree.branch.get_submit_branch()
 
3052
        if stored_location is None:
 
3053
            stored_location = tree.branch.get_parent()
 
3054
        mutter("%s", stored_location)
 
3055
        if stored_location is None:
 
3056
            raise errors.BzrCommandError("No location specified or remembered")
 
3057
        display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
 
3058
        note(u"%s remembered location %s", verb_string, display_url)
 
3059
        return stored_location
 
3060
 
 
3061
 
 
3062
class cmd_remerge(Command):
 
3063
    """Redo a merge.
 
3064
 
 
3065
    Use this if you want to try a different merge technique while resolving
 
3066
    conflicts.  Some merge techniques are better than others, and remerge 
 
3067
    lets you try different ones on different files.
 
3068
 
 
3069
    The options for remerge have the same meaning and defaults as the ones for
 
3070
    merge.  The difference is that remerge can (only) be run when there is a
 
3071
    pending merge, and it lets you specify particular files.
 
3072
 
 
3073
    :Examples:
 
3074
        Re-do the merge of all conflicted files, and show the base text in
 
3075
        conflict regions, in addition to the usual THIS and OTHER texts::
 
3076
      
 
3077
            bzr remerge --show-base
 
3078
 
 
3079
        Re-do the merge of "foobar", using the weave merge algorithm, with
 
3080
        additional processing to reduce the size of conflict regions::
 
3081
      
 
3082
            bzr remerge --merge-type weave --reprocess foobar
 
3083
    """
 
3084
    takes_args = ['file*']
 
3085
    takes_options = [
 
3086
            'merge-type',
 
3087
            'reprocess',
 
3088
            Option('show-base',
 
3089
                   help="Show base revision text in conflicts."),
 
3090
            ]
 
3091
 
 
3092
    def run(self, file_list=None, merge_type=None, show_base=False,
 
3093
            reprocess=False):
 
3094
        if merge_type is None:
 
3095
            merge_type = _mod_merge.Merge3Merger
 
3096
        tree, file_list = tree_files(file_list)
 
3097
        tree.lock_write()
 
3098
        try:
 
3099
            parents = tree.get_parent_ids()
 
3100
            if len(parents) != 2:
 
3101
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
3102
                                             " merges.  Not cherrypicking or"
 
3103
                                             " multi-merges.")
 
3104
            repository = tree.branch.repository
 
3105
            interesting_ids = None
 
3106
            new_conflicts = []
 
3107
            conflicts = tree.conflicts()
 
3108
            if file_list is not None:
 
3109
                interesting_ids = set()
 
3110
                for filename in file_list:
 
3111
                    file_id = tree.path2id(filename)
 
3112
                    if file_id is None:
 
3113
                        raise errors.NotVersionedError(filename)
 
3114
                    interesting_ids.add(file_id)
 
3115
                    if tree.kind(file_id) != "directory":
 
3116
                        continue
 
3117
                    
 
3118
                    for name, ie in tree.inventory.iter_entries(file_id):
 
3119
                        interesting_ids.add(ie.file_id)
 
3120
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
3121
            else:
 
3122
                # Remerge only supports resolving contents conflicts
 
3123
                allowed_conflicts = ('text conflict', 'contents conflict')
 
3124
                restore_files = [c.path for c in conflicts
 
3125
                                 if c.typestring in allowed_conflicts]
 
3126
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
3127
            tree.set_conflicts(ConflictList(new_conflicts))
 
3128
            if file_list is not None:
 
3129
                restore_files = file_list
 
3130
            for filename in restore_files:
 
3131
                try:
 
3132
                    restore(tree.abspath(filename))
 
3133
                except errors.NotConflicted:
 
3134
                    pass
 
3135
            # Disable pending merges, because the file texts we are remerging
 
3136
            # have not had those merges performed.  If we use the wrong parents
 
3137
            # list, we imply that the working tree text has seen and rejected
 
3138
            # all the changes from the other tree, when in fact those changes
 
3139
            # have not yet been seen.
 
3140
            pb = ui.ui_factory.nested_progress_bar()
 
3141
            tree.set_parent_ids(parents[:1])
 
3142
            try:
 
3143
                merger = _mod_merge.Merger.from_revision_ids(pb,
 
3144
                                                             tree, parents[1])
 
3145
                merger.interesting_ids = interesting_ids
 
3146
                merger.merge_type = merge_type
 
3147
                merger.show_base = show_base
 
3148
                merger.reprocess = reprocess
 
3149
                conflicts = merger.do_merge()
 
3150
            finally:
 
3151
                tree.set_parent_ids(parents)
 
3152
                pb.finished()
 
3153
        finally:
 
3154
            tree.unlock()
 
3155
        if conflicts > 0:
 
3156
            return 1
 
3157
        else:
 
3158
            return 0
 
3159
 
 
3160
 
 
3161
class cmd_revert(Command):
 
3162
    """Revert files to a previous revision.
 
3163
 
 
3164
    Giving a list of files will revert only those files.  Otherwise, all files
 
3165
    will be reverted.  If the revision is not specified with '--revision', the
 
3166
    last committed revision is used.
 
3167
 
 
3168
    To remove only some changes, without reverting to a prior version, use
 
3169
    merge instead.  For example, "merge . --revision -2..-3" will remove the
 
3170
    changes introduced by -2, without affecting the changes introduced by -1.
 
3171
    Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
 
3172
    
 
3173
    By default, any files that have been manually changed will be backed up
 
3174
    first.  (Files changed only by merge are not backed up.)  Backup files have
 
3175
    '.~#~' appended to their name, where # is a number.
 
3176
 
 
3177
    When you provide files, you can use their current pathname or the pathname
 
3178
    from the target revision.  So you can use revert to "undelete" a file by
 
3179
    name.  If you name a directory, all the contents of that directory will be
 
3180
    reverted.
 
3181
 
 
3182
    Any files that have been newly added since that revision will be deleted,
 
3183
    with a backup kept if appropriate.  Directories containing unknown files
 
3184
    will not be deleted.
 
3185
 
 
3186
    The working tree contains a list of pending merged revisions, which will
 
3187
    be included as parents in the next commit.  Normally, revert clears that
 
3188
    list as well as reverting the files.  If any files are specified, revert
 
3189
    leaves the pending merge list alone and reverts only the files.  Use "bzr
 
3190
    revert ." in the tree root to revert all files but keep the merge record,
 
3191
    and "bzr revert --forget-merges" to clear the pending merge list without
 
3192
    reverting any files.
 
3193
    """
 
3194
 
 
3195
    _see_also = ['cat', 'export']
 
3196
    takes_options = [
 
3197
        'revision',
 
3198
        Option('no-backup', "Do not save backups of reverted files."),
 
3199
        Option('forget-merges',
 
3200
               'Remove pending merge marker, without changing any files.'),
 
3201
        ]
 
3202
    takes_args = ['file*']
 
3203
 
 
3204
    def run(self, revision=None, no_backup=False, file_list=None,
 
3205
            forget_merges=None):
 
3206
        tree, file_list = tree_files(file_list)
 
3207
        if forget_merges:
 
3208
            tree.set_parent_ids(tree.get_parent_ids()[:1])
 
3209
        else:
 
3210
            self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
3211
 
 
3212
    @staticmethod
 
3213
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
 
3214
        if revision is None:
 
3215
            rev_id = tree.last_revision()
 
3216
        elif len(revision) != 1:
 
3217
            raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
 
3218
        else:
 
3219
            rev_id = revision[0].as_revision_id(tree.branch)
 
3220
        pb = ui.ui_factory.nested_progress_bar()
 
3221
        try:
 
3222
            tree.revert(file_list,
 
3223
                        tree.branch.repository.revision_tree(rev_id),
 
3224
                        not no_backup, pb, report_changes=True)
 
3225
        finally:
 
3226
            pb.finished()
 
3227
 
 
3228
 
 
3229
class cmd_assert_fail(Command):
 
3230
    """Test reporting of assertion failures"""
 
3231
    # intended just for use in testing
 
3232
 
 
3233
    hidden = True
 
3234
 
 
3235
    def run(self):
 
3236
        raise AssertionError("always fails")
 
3237
 
 
3238
 
 
3239
class cmd_help(Command):
 
3240
    """Show help on a command or other topic.
 
3241
    """
 
3242
 
 
3243
    _see_also = ['topics']
 
3244
    takes_options = [
 
3245
            Option('long', 'Show help on all commands.'),
 
3246
            ]
 
3247
    takes_args = ['topic?']
 
3248
    aliases = ['?', '--help', '-?', '-h']
 
3249
    
 
3250
    @display_command
 
3251
    def run(self, topic=None, long=False):
 
3252
        import bzrlib.help
 
3253
        if topic is None and long:
 
3254
            topic = "commands"
 
3255
        bzrlib.help.help(topic)
 
3256
 
 
3257
 
 
3258
class cmd_shell_complete(Command):
 
3259
    """Show appropriate completions for context.
 
3260
 
 
3261
    For a list of all available commands, say 'bzr shell-complete'.
 
3262
    """
 
3263
    takes_args = ['context?']
 
3264
    aliases = ['s-c']
 
3265
    hidden = True
 
3266
    
 
3267
    @display_command
 
3268
    def run(self, context=None):
 
3269
        import shellcomplete
 
3270
        shellcomplete.shellcomplete(context)
 
3271
 
 
3272
 
 
3273
class cmd_fetch(Command):
 
3274
    """Copy in history from another branch but don't merge it.
 
3275
 
 
3276
    This is an internal method used for pull and merge.
 
3277
    """
 
3278
    hidden = True
 
3279
    takes_args = ['from_branch', 'to_branch']
 
3280
    def run(self, from_branch, to_branch):
 
3281
        from bzrlib.fetch import Fetcher
 
3282
        from_b = Branch.open(from_branch)
 
3283
        to_b = Branch.open(to_branch)
 
3284
        Fetcher(to_b, from_b)
 
3285
 
 
3286
 
 
3287
class cmd_missing(Command):
 
3288
    """Show unmerged/unpulled revisions between two branches.
 
3289
    
 
3290
    OTHER_BRANCH may be local or remote.
 
3291
    """
 
3292
 
 
3293
    _see_also = ['merge', 'pull']
 
3294
    takes_args = ['other_branch?']
 
3295
    takes_options = [
 
3296
            Option('reverse', 'Reverse the order of revisions.'),
 
3297
            Option('mine-only',
 
3298
                   'Display changes in the local branch only.'),
 
3299
            Option('this' , 'Same as --mine-only.'),
 
3300
            Option('theirs-only',
 
3301
                   'Display changes in the remote branch only.'),
 
3302
            Option('other', 'Same as --theirs-only.'),
 
3303
            'log-format',
 
3304
            'show-ids',
 
3305
            'verbose'
 
3306
            ]
 
3307
    encoding_type = 'replace'
 
3308
 
 
3309
    @display_command
 
3310
    def run(self, other_branch=None, reverse=False, mine_only=False,
 
3311
            theirs_only=False, log_format=None, long=False, short=False, line=False, 
 
3312
            show_ids=False, verbose=False, this=False, other=False):
 
3313
        from bzrlib.missing import find_unmerged, iter_log_revisions
 
3314
 
 
3315
        if this:
 
3316
          mine_only = this
 
3317
        if other:
 
3318
          theirs_only = other
 
3319
 
 
3320
        local_branch = Branch.open_containing(u".")[0]
 
3321
        parent = local_branch.get_parent()
 
3322
        if other_branch is None:
 
3323
            other_branch = parent
 
3324
            if other_branch is None:
 
3325
                raise errors.BzrCommandError("No peer location known"
 
3326
                                             " or specified.")
 
3327
            display_url = urlutils.unescape_for_display(parent,
 
3328
                                                        self.outf.encoding)
 
3329
            self.outf.write("Using last location: " + display_url + "\n")
 
3330
 
 
3331
        remote_branch = Branch.open(other_branch)
 
3332
        if remote_branch.base == local_branch.base:
 
3333
            remote_branch = local_branch
 
3334
        local_branch.lock_read()
 
3335
        try:
 
3336
            remote_branch.lock_read()
 
3337
            try:
 
3338
                local_extra, remote_extra = find_unmerged(local_branch,
 
3339
                                                          remote_branch)
 
3340
                if log_format is None:
 
3341
                    registry = log.log_formatter_registry
 
3342
                    log_format = registry.get_default(local_branch)
 
3343
                lf = log_format(to_file=self.outf,
 
3344
                                show_ids=show_ids,
 
3345
                                show_timezone='original')
 
3346
                if reverse is False:
 
3347
                    local_extra.reverse()
 
3348
                    remote_extra.reverse()
 
3349
                if local_extra and not theirs_only:
 
3350
                    self.outf.write("You have %d extra revision(s):\n" %
 
3351
                                    len(local_extra))
 
3352
                    for revision in iter_log_revisions(local_extra,
 
3353
                                        local_branch.repository,
 
3354
                                        verbose):
 
3355
                        lf.log_revision(revision)
 
3356
                    printed_local = True
 
3357
                else:
 
3358
                    printed_local = False
 
3359
                if remote_extra and not mine_only:
 
3360
                    if printed_local is True:
 
3361
                        self.outf.write("\n\n\n")
 
3362
                    self.outf.write("You are missing %d revision(s):\n" %
 
3363
                                    len(remote_extra))
 
3364
                    for revision in iter_log_revisions(remote_extra,
 
3365
                                        remote_branch.repository,
 
3366
                                        verbose):
 
3367
                        lf.log_revision(revision)
 
3368
                if not remote_extra and not local_extra:
 
3369
                    status_code = 0
 
3370
                    self.outf.write("Branches are up to date.\n")
 
3371
                else:
 
3372
                    status_code = 1
 
3373
            finally:
 
3374
                remote_branch.unlock()
 
3375
        finally:
 
3376
            local_branch.unlock()
 
3377
        if not status_code and parent is None and other_branch is not None:
 
3378
            local_branch.lock_write()
 
3379
            try:
 
3380
                # handle race conditions - a parent might be set while we run.
 
3381
                if local_branch.get_parent() is None:
 
3382
                    local_branch.set_parent(remote_branch.base)
 
3383
            finally:
 
3384
                local_branch.unlock()
 
3385
        return status_code
 
3386
 
 
3387
 
 
3388
class cmd_pack(Command):
 
3389
    """Compress the data within a repository."""
 
3390
 
 
3391
    _see_also = ['repositories']
 
3392
    takes_args = ['branch_or_repo?']
 
3393
 
 
3394
    def run(self, branch_or_repo='.'):
 
3395
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
 
3396
        try:
 
3397
            branch = dir.open_branch()
 
3398
            repository = branch.repository
 
3399
        except errors.NotBranchError:
 
3400
            repository = dir.open_repository()
 
3401
        repository.pack()
 
3402
 
 
3403
 
 
3404
class cmd_plugins(Command):
 
3405
    """List the installed plugins.
 
3406
    
 
3407
    This command displays the list of installed plugins including
 
3408
    version of plugin and a short description of each.
 
3409
 
 
3410
    --verbose shows the path where each plugin is located.
 
3411
 
 
3412
    A plugin is an external component for Bazaar that extends the
 
3413
    revision control system, by adding or replacing code in Bazaar.
 
3414
    Plugins can do a variety of things, including overriding commands,
 
3415
    adding new commands, providing additional network transports and
 
3416
    customizing log output.
 
3417
 
 
3418
    See the Bazaar web site, http://bazaar-vcs.org, for further
 
3419
    information on plugins including where to find them and how to
 
3420
    install them. Instructions are also provided there on how to
 
3421
    write new plugins using the Python programming language.
 
3422
    """
 
3423
    takes_options = ['verbose']
 
3424
 
 
3425
    @display_command
 
3426
    def run(self, verbose=False):
 
3427
        import bzrlib.plugin
 
3428
        from inspect import getdoc
 
3429
        result = []
 
3430
        for name, plugin in bzrlib.plugin.plugins().items():
 
3431
            version = plugin.__version__
 
3432
            if version == 'unknown':
 
3433
                version = ''
 
3434
            name_ver = '%s %s' % (name, version)
 
3435
            d = getdoc(plugin.module)
 
3436
            if d:
 
3437
                doc = d.split('\n')[0]
 
3438
            else:
 
3439
                doc = '(no description)'
 
3440
            result.append((name_ver, doc, plugin.path()))
 
3441
        for name_ver, doc, path in sorted(result):
 
3442
            print name_ver
 
3443
            print '   ', doc
 
3444
            if verbose:
 
3445
                print '   ', path
 
3446
            print
 
3447
 
 
3448
 
 
3449
class cmd_testament(Command):
 
3450
    """Show testament (signing-form) of a revision."""
 
3451
    takes_options = [
 
3452
            'revision',
 
3453
            Option('long', help='Produce long-format testament.'),
 
3454
            Option('strict',
 
3455
                   help='Produce a strict-format testament.')]
 
3456
    takes_args = ['branch?']
 
3457
    @display_command
 
3458
    def run(self, branch=u'.', revision=None, long=False, strict=False):
 
3459
        from bzrlib.testament import Testament, StrictTestament
 
3460
        if strict is True:
 
3461
            testament_class = StrictTestament
 
3462
        else:
 
3463
            testament_class = Testament
 
3464
        b = WorkingTree.open_containing(branch)[0].branch
 
3465
        b.lock_read()
 
3466
        try:
 
3467
            if revision is None:
 
3468
                rev_id = b.last_revision()
 
3469
            else:
 
3470
                rev_id = revision[0].as_revision_id(b)
 
3471
            t = testament_class.from_revision(b.repository, rev_id)
 
3472
            if long:
 
3473
                sys.stdout.writelines(t.as_text_lines())
 
3474
            else:
 
3475
                sys.stdout.write(t.as_short_text())
 
3476
        finally:
 
3477
            b.unlock()
 
3478
 
 
3479
 
 
3480
class cmd_annotate(Command):
 
3481
    """Show the origin of each line in a file.
 
3482
 
 
3483
    This prints out the given file with an annotation on the left side
 
3484
    indicating which revision, author and date introduced the change.
 
3485
 
 
3486
    If the origin is the same for a run of consecutive lines, it is 
 
3487
    shown only at the top, unless the --all option is given.
 
3488
    """
 
3489
    # TODO: annotate directories; showing when each file was last changed
 
3490
    # TODO: if the working copy is modified, show annotations on that 
 
3491
    #       with new uncommitted lines marked
 
3492
    aliases = ['ann', 'blame', 'praise']
 
3493
    takes_args = ['filename']
 
3494
    takes_options = [Option('all', help='Show annotations on all lines.'),
 
3495
                     Option('long', help='Show commit date in annotations.'),
 
3496
                     'revision',
 
3497
                     'show-ids',
 
3498
                     ]
 
3499
    encoding_type = 'exact'
 
3500
 
 
3501
    @display_command
 
3502
    def run(self, filename, all=False, long=False, revision=None,
 
3503
            show_ids=False):
 
3504
        from bzrlib.annotate import annotate_file
 
3505
        wt, branch, relpath = \
 
3506
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
3507
        if wt is not None:
 
3508
            wt.lock_read()
 
3509
        else:
 
3510
            branch.lock_read()
 
3511
        try:
 
3512
            if revision is None:
 
3513
                revision_id = branch.last_revision()
 
3514
            elif len(revision) != 1:
 
3515
                raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
 
3516
            else:
 
3517
                revision_id = revision[0].as_revision_id(branch)
 
3518
            tree = branch.repository.revision_tree(revision_id)
 
3519
            if wt is not None:
 
3520
                file_id = wt.path2id(relpath)
 
3521
            else:
 
3522
                file_id = tree.path2id(relpath)
 
3523
            if file_id is None:
 
3524
                raise errors.NotVersionedError(filename)
 
3525
            file_version = tree.inventory[file_id].revision
 
3526
            annotate_file(branch, file_version, file_id, long, all, self.outf,
 
3527
                          show_ids=show_ids)
 
3528
        finally:
 
3529
            if wt is not None:
 
3530
                wt.unlock()
 
3531
            else:
 
3532
                branch.unlock()
 
3533
 
 
3534
 
 
3535
class cmd_re_sign(Command):
 
3536
    """Create a digital signature for an existing revision."""
 
3537
    # TODO be able to replace existing ones.
 
3538
 
 
3539
    hidden = True # is this right ?
 
3540
    takes_args = ['revision_id*']
 
3541
    takes_options = ['revision']
 
3542
    
 
3543
    def run(self, revision_id_list=None, revision=None):
 
3544
        if revision_id_list is not None and revision is not None:
 
3545
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
 
3546
        if revision_id_list is None and revision is None:
 
3547
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
 
3548
        b = WorkingTree.open_containing(u'.')[0].branch
 
3549
        b.lock_write()
 
3550
        try:
 
3551
            return self._run(b, revision_id_list, revision)
 
3552
        finally:
 
3553
            b.unlock()
 
3554
 
 
3555
    def _run(self, b, revision_id_list, revision):
 
3556
        import bzrlib.gpg as gpg
 
3557
        gpg_strategy = gpg.GPGStrategy(b.get_config())
 
3558
        if revision_id_list is not None:
 
3559
            b.repository.start_write_group()
 
3560
            try:
 
3561
                for revision_id in revision_id_list:
 
3562
                    b.repository.sign_revision(revision_id, gpg_strategy)
 
3563
            except:
 
3564
                b.repository.abort_write_group()
 
3565
                raise
 
3566
            else:
 
3567
                b.repository.commit_write_group()
 
3568
        elif revision is not None:
 
3569
            if len(revision) == 1:
 
3570
                revno, rev_id = revision[0].in_history(b)
 
3571
                b.repository.start_write_group()
 
3572
                try:
 
3573
                    b.repository.sign_revision(rev_id, gpg_strategy)
 
3574
                except:
 
3575
                    b.repository.abort_write_group()
 
3576
                    raise
 
3577
                else:
 
3578
                    b.repository.commit_write_group()
 
3579
            elif len(revision) == 2:
 
3580
                # are they both on rh- if so we can walk between them
 
3581
                # might be nice to have a range helper for arbitrary
 
3582
                # revision paths. hmm.
 
3583
                from_revno, from_revid = revision[0].in_history(b)
 
3584
                to_revno, to_revid = revision[1].in_history(b)
 
3585
                if to_revid is None:
 
3586
                    to_revno = b.revno()
 
3587
                if from_revno is None or to_revno is None:
 
3588
                    raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
 
3589
                b.repository.start_write_group()
 
3590
                try:
 
3591
                    for revno in range(from_revno, to_revno + 1):
 
3592
                        b.repository.sign_revision(b.get_rev_id(revno),
 
3593
                                                   gpg_strategy)
 
3594
                except:
 
3595
                    b.repository.abort_write_group()
 
3596
                    raise
 
3597
                else:
 
3598
                    b.repository.commit_write_group()
 
3599
            else:
 
3600
                raise errors.BzrCommandError('Please supply either one revision, or a range.')
 
3601
 
 
3602
 
 
3603
class cmd_bind(Command):
 
3604
    """Convert the current branch into a checkout of the supplied branch.
 
3605
 
 
3606
    Once converted into a checkout, commits must succeed on the master branch
 
3607
    before they will be applied to the local branch.
 
3608
    """
 
3609
 
 
3610
    _see_also = ['checkouts', 'unbind']
 
3611
    takes_args = ['location?']
 
3612
    takes_options = []
 
3613
 
 
3614
    def run(self, location=None):
 
3615
        b, relpath = Branch.open_containing(u'.')
 
3616
        if location is None:
 
3617
            try:
 
3618
                location = b.get_old_bound_location()
 
3619
            except errors.UpgradeRequired:
 
3620
                raise errors.BzrCommandError('No location supplied.  '
 
3621
                    'This format does not remember old locations.')
 
3622
            else:
 
3623
                if location is None:
 
3624
                    raise errors.BzrCommandError('No location supplied and no '
 
3625
                        'previous location known')
 
3626
        b_other = Branch.open(location)
 
3627
        try:
 
3628
            b.bind(b_other)
 
3629
        except errors.DivergedBranches:
 
3630
            raise errors.BzrCommandError('These branches have diverged.'
 
3631
                                         ' Try merging, and then bind again.')
 
3632
 
 
3633
 
 
3634
class cmd_unbind(Command):
 
3635
    """Convert the current checkout into a regular branch.
 
3636
 
 
3637
    After unbinding, the local branch is considered independent and subsequent
 
3638
    commits will be local only.
 
3639
    """
 
3640
 
 
3641
    _see_also = ['checkouts', 'bind']
 
3642
    takes_args = []
 
3643
    takes_options = []
 
3644
 
 
3645
    def run(self):
 
3646
        b, relpath = Branch.open_containing(u'.')
 
3647
        if not b.unbind():
 
3648
            raise errors.BzrCommandError('Local branch is not bound')
 
3649
 
 
3650
 
 
3651
class cmd_uncommit(Command):
 
3652
    """Remove the last committed revision.
 
3653
 
 
3654
    --verbose will print out what is being removed.
 
3655
    --dry-run will go through all the motions, but not actually
 
3656
    remove anything.
 
3657
 
 
3658
    If --revision is specified, uncommit revisions to leave the branch at the
 
3659
    specified revision.  For example, "bzr uncommit -r 15" will leave the
 
3660
    branch at revision 15.
 
3661
 
 
3662
    In the future, uncommit will create a revision bundle, which can then
 
3663
    be re-applied.
 
3664
    """
 
3665
 
 
3666
    # TODO: jam 20060108 Add an option to allow uncommit to remove
 
3667
    # unreferenced information in 'branch-as-repository' branches.
 
3668
    # TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
 
3669
    # information in shared branches as well.
 
3670
    _see_also = ['commit']
 
3671
    takes_options = ['verbose', 'revision',
 
3672
                    Option('dry-run', help='Don\'t actually make changes.'),
 
3673
                    Option('force', help='Say yes to all questions.'),
 
3674
                    Option('local',
 
3675
                           help="Only remove the commits from the local branch"
 
3676
                                " when in a checkout."
 
3677
                           ),
 
3678
                    ]
 
3679
    takes_args = ['location?']
 
3680
    aliases = []
 
3681
    encoding_type = 'replace'
 
3682
 
 
3683
    def run(self, location=None,
 
3684
            dry_run=False, verbose=False,
 
3685
            revision=None, force=False, local=False):
 
3686
        if location is None:
 
3687
            location = u'.'
 
3688
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
3689
        try:
 
3690
            tree = control.open_workingtree()
 
3691
            b = tree.branch
 
3692
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
3693
            tree = None
 
3694
            b = control.open_branch()
 
3695
 
 
3696
        if tree is not None:
 
3697
            tree.lock_write()
 
3698
        else:
 
3699
            b.lock_write()
 
3700
        try:
 
3701
            return self._run(b, tree, dry_run, verbose, revision, force,
 
3702
                             local=local)
 
3703
        finally:
 
3704
            if tree is not None:
 
3705
                tree.unlock()
 
3706
            else:
 
3707
                b.unlock()
 
3708
 
 
3709
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
 
3710
        from bzrlib.log import log_formatter, show_log
 
3711
        from bzrlib.uncommit import uncommit
 
3712
 
 
3713
        last_revno, last_rev_id = b.last_revision_info()
 
3714
 
 
3715
        rev_id = None
 
3716
        if revision is None:
 
3717
            revno = last_revno
 
3718
            rev_id = last_rev_id
 
3719
        else:
 
3720
            # 'bzr uncommit -r 10' actually means uncommit
 
3721
            # so that the final tree is at revno 10.
 
3722
            # but bzrlib.uncommit.uncommit() actually uncommits
 
3723
            # the revisions that are supplied.
 
3724
            # So we need to offset it by one
 
3725
            revno = revision[0].in_history(b).revno + 1
 
3726
            if revno <= last_revno:
 
3727
                rev_id = b.get_rev_id(revno)
 
3728
 
 
3729
        if rev_id is None or _mod_revision.is_null(rev_id):
 
3730
            self.outf.write('No revisions to uncommit.\n')
 
3731
            return 1
 
3732
 
 
3733
        lf = log_formatter('short',
 
3734
                           to_file=self.outf,
 
3735
                           show_timezone='original')
 
3736
 
 
3737
        show_log(b,
 
3738
                 lf,
 
3739
                 verbose=False,
 
3740
                 direction='forward',
 
3741
                 start_revision=revno,
 
3742
                 end_revision=last_revno)
 
3743
 
 
3744
        if dry_run:
 
3745
            print 'Dry-run, pretending to remove the above revisions.'
 
3746
            if not force:
 
3747
                val = raw_input('Press <enter> to continue')
 
3748
        else:
 
3749
            print 'The above revision(s) will be removed.'
 
3750
            if not force:
 
3751
                val = raw_input('Are you sure [y/N]? ')
 
3752
                if val.lower() not in ('y', 'yes'):
 
3753
                    print 'Canceled'
 
3754
                    return 0
 
3755
 
 
3756
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
 
3757
                 revno=revno, local=local)
 
3758
 
 
3759
 
 
3760
class cmd_break_lock(Command):
 
3761
    """Break a dead lock on a repository, branch or working directory.
 
3762
 
 
3763
    CAUTION: Locks should only be broken when you are sure that the process
 
3764
    holding the lock has been stopped.
 
3765
 
 
3766
    You can get information on what locks are open via the 'bzr info' command.
 
3767
    
 
3768
    :Examples:
 
3769
        bzr break-lock
 
3770
    """
 
3771
    takes_args = ['location?']
 
3772
 
 
3773
    def run(self, location=None, show=False):
 
3774
        if location is None:
 
3775
            location = u'.'
 
3776
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
3777
        try:
 
3778
            control.break_lock()
 
3779
        except NotImplementedError:
 
3780
            pass
 
3781
        
 
3782
 
 
3783
class cmd_wait_until_signalled(Command):
 
3784
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
3785
 
 
3786
    This just prints a line to signal when it is ready, then blocks on stdin.
 
3787
    """
 
3788
 
 
3789
    hidden = True
 
3790
 
 
3791
    def run(self):
 
3792
        sys.stdout.write("running\n")
 
3793
        sys.stdout.flush()
 
3794
        sys.stdin.readline()
 
3795
 
 
3796
 
 
3797
class cmd_serve(Command):
 
3798
    """Run the bzr server."""
 
3799
 
 
3800
    aliases = ['server']
 
3801
 
 
3802
    takes_options = [
 
3803
        Option('inet',
 
3804
               help='Serve on stdin/out for use from inetd or sshd.'),
 
3805
        Option('port',
 
3806
               help='Listen for connections on nominated port of the form '
 
3807
                    '[hostname:]portnumber.  Passing 0 as the port number will '
 
3808
                    'result in a dynamically allocated port.  The default port is '
 
3809
                    '4155.',
 
3810
               type=str),
 
3811
        Option('directory',
 
3812
               help='Serve contents of this directory.',
 
3813
               type=unicode),
 
3814
        Option('allow-writes',
 
3815
               help='By default the server is a readonly server.  Supplying '
 
3816
                    '--allow-writes enables write access to the contents of '
 
3817
                    'the served directory and below.'
 
3818
                ),
 
3819
        ]
 
3820
 
 
3821
    def run(self, port=None, inet=False, directory=None, allow_writes=False):
 
3822
        from bzrlib import lockdir
 
3823
        from bzrlib.smart import medium, server
 
3824
        from bzrlib.transport import get_transport
 
3825
        from bzrlib.transport.chroot import ChrootServer
 
3826
        if directory is None:
 
3827
            directory = os.getcwd()
 
3828
        url = urlutils.local_path_to_url(directory)
 
3829
        if not allow_writes:
 
3830
            url = 'readonly+' + url
 
3831
        chroot_server = ChrootServer(get_transport(url))
 
3832
        chroot_server.setUp()
 
3833
        t = get_transport(chroot_server.get_url())
 
3834
        if inet:
 
3835
            smart_server = medium.SmartServerPipeStreamMedium(
 
3836
                sys.stdin, sys.stdout, t)
 
3837
        else:
 
3838
            host = medium.BZR_DEFAULT_INTERFACE
 
3839
            if port is None:
 
3840
                port = medium.BZR_DEFAULT_PORT
 
3841
            else:
 
3842
                if ':' in port:
 
3843
                    host, port = port.split(':')
 
3844
                port = int(port)
 
3845
            smart_server = server.SmartTCPServer(t, host=host, port=port)
 
3846
            print 'listening on port: ', smart_server.port
 
3847
            sys.stdout.flush()
 
3848
        # for the duration of this server, no UI output is permitted.
 
3849
        # note that this may cause problems with blackbox tests. This should
 
3850
        # be changed with care though, as we dont want to use bandwidth sending
 
3851
        # progress over stderr to smart server clients!
 
3852
        old_factory = ui.ui_factory
 
3853
        old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
 
3854
        try:
 
3855
            ui.ui_factory = ui.SilentUIFactory()
 
3856
            lockdir._DEFAULT_TIMEOUT_SECONDS = 0
 
3857
            smart_server.serve()
 
3858
        finally:
 
3859
            ui.ui_factory = old_factory
 
3860
            lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
 
3861
 
 
3862
 
 
3863
class cmd_join(Command):
 
3864
    """Combine a subtree into its containing tree.
 
3865
    
 
3866
    This command is for experimental use only.  It requires the target tree
 
3867
    to be in dirstate-with-subtree format, which cannot be converted into
 
3868
    earlier formats.
 
3869
 
 
3870
    The TREE argument should be an independent tree, inside another tree, but
 
3871
    not part of it.  (Such trees can be produced by "bzr split", but also by
 
3872
    running "bzr branch" with the target inside a tree.)
 
3873
 
 
3874
    The result is a combined tree, with the subtree no longer an independant
 
3875
    part.  This is marked as a merge of the subtree into the containing tree,
 
3876
    and all history is preserved.
 
3877
 
 
3878
    If --reference is specified, the subtree retains its independence.  It can
 
3879
    be branched by itself, and can be part of multiple projects at the same
 
3880
    time.  But operations performed in the containing tree, such as commit
 
3881
    and merge, will recurse into the subtree.
 
3882
    """
 
3883
 
 
3884
    _see_also = ['split']
 
3885
    takes_args = ['tree']
 
3886
    takes_options = [
 
3887
            Option('reference', help='Join by reference.'),
 
3888
            ]
 
3889
    hidden = True
 
3890
 
 
3891
    def run(self, tree, reference=False):
 
3892
        sub_tree = WorkingTree.open(tree)
 
3893
        parent_dir = osutils.dirname(sub_tree.basedir)
 
3894
        containing_tree = WorkingTree.open_containing(parent_dir)[0]
 
3895
        repo = containing_tree.branch.repository
 
3896
        if not repo.supports_rich_root():
 
3897
            raise errors.BzrCommandError(
 
3898
                "Can't join trees because %s doesn't support rich root data.\n"
 
3899
                "You can use bzr upgrade on the repository."
 
3900
                % (repo,))
 
3901
        if reference:
 
3902
            try:
 
3903
                containing_tree.add_reference(sub_tree)
 
3904
            except errors.BadReferenceTarget, e:
 
3905
                # XXX: Would be better to just raise a nicely printable
 
3906
                # exception from the real origin.  Also below.  mbp 20070306
 
3907
                raise errors.BzrCommandError("Cannot join %s.  %s" %
 
3908
                                             (tree, e.reason))
 
3909
        else:
 
3910
            try:
 
3911
                containing_tree.subsume(sub_tree)
 
3912
            except errors.BadSubsumeSource, e:
 
3913
                raise errors.BzrCommandError("Cannot join %s.  %s" % 
 
3914
                                             (tree, e.reason))
 
3915
 
 
3916
 
 
3917
class cmd_split(Command):
 
3918
    """Split a subdirectory of a tree into a separate tree.
 
3919
 
 
3920
    This command will produce a target tree in a format that supports
 
3921
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
 
3922
    converted into earlier formats like 'dirstate-tags'.
 
3923
 
 
3924
    The TREE argument should be a subdirectory of a working tree.  That
 
3925
    subdirectory will be converted into an independent tree, with its own
 
3926
    branch.  Commits in the top-level tree will not apply to the new subtree.
 
3927
    """
 
3928
 
 
3929
    # join is not un-hidden yet
 
3930
    #_see_also = ['join']
 
3931
    takes_args = ['tree']
 
3932
 
 
3933
    def run(self, tree):
 
3934
        containing_tree, subdir = WorkingTree.open_containing(tree)
 
3935
        sub_id = containing_tree.path2id(subdir)
 
3936
        if sub_id is None:
 
3937
            raise errors.NotVersionedError(subdir)
 
3938
        try:
 
3939
            containing_tree.extract(sub_id)
 
3940
        except errors.RootNotRich:
 
3941
            raise errors.UpgradeRequired(containing_tree.branch.base)
 
3942
 
 
3943
 
 
3944
class cmd_merge_directive(Command):
 
3945
    """Generate a merge directive for auto-merge tools.
 
3946
 
 
3947
    A directive requests a merge to be performed, and also provides all the
 
3948
    information necessary to do so.  This means it must either include a
 
3949
    revision bundle, or the location of a branch containing the desired
 
3950
    revision.
 
3951
 
 
3952
    A submit branch (the location to merge into) must be supplied the first
 
3953
    time the command is issued.  After it has been supplied once, it will
 
3954
    be remembered as the default.
 
3955
 
 
3956
    A public branch is optional if a revision bundle is supplied, but required
 
3957
    if --diff or --plain is specified.  It will be remembered as the default
 
3958
    after the first use.
 
3959
    """
 
3960
 
 
3961
    takes_args = ['submit_branch?', 'public_branch?']
 
3962
 
 
3963
    hidden = True
 
3964
 
 
3965
    _see_also = ['send']
 
3966
 
 
3967
    takes_options = [
 
3968
        RegistryOption.from_kwargs('patch-type',
 
3969
            'The type of patch to include in the directive.',
 
3970
            title='Patch type',
 
3971
            value_switches=True,
 
3972
            enum_switch=False,
 
3973
            bundle='Bazaar revision bundle (default).',
 
3974
            diff='Normal unified diff.',
 
3975
            plain='No patch, just directive.'),
 
3976
        Option('sign', help='GPG-sign the directive.'), 'revision',
 
3977
        Option('mail-to', type=str,
 
3978
            help='Instead of printing the directive, email to this address.'),
 
3979
        Option('message', type=str, short_name='m',
 
3980
            help='Message to use when committing this merge.')
 
3981
        ]
 
3982
 
 
3983
    encoding_type = 'exact'
 
3984
 
 
3985
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
 
3986
            sign=False, revision=None, mail_to=None, message=None):
 
3987
        from bzrlib.revision import ensure_null, NULL_REVISION
 
3988
        include_patch, include_bundle = {
 
3989
            'plain': (False, False),
 
3990
            'diff': (True, False),
 
3991
            'bundle': (True, True),
 
3992
            }[patch_type]
 
3993
        branch = Branch.open('.')
 
3994
        stored_submit_branch = branch.get_submit_branch()
 
3995
        if submit_branch is None:
 
3996
            submit_branch = stored_submit_branch
 
3997
        else:
 
3998
            if stored_submit_branch is None:
 
3999
                branch.set_submit_branch(submit_branch)
 
4000
        if submit_branch is None:
 
4001
            submit_branch = branch.get_parent()
 
4002
        if submit_branch is None:
 
4003
            raise errors.BzrCommandError('No submit branch specified or known')
 
4004
 
 
4005
        stored_public_branch = branch.get_public_branch()
 
4006
        if public_branch is None:
 
4007
            public_branch = stored_public_branch
 
4008
        elif stored_public_branch is None:
 
4009
            branch.set_public_branch(public_branch)
 
4010
        if not include_bundle and public_branch is None:
 
4011
            raise errors.BzrCommandError('No public branch specified or'
 
4012
                                         ' known')
 
4013
        base_revision_id = None
 
4014
        if revision is not None:
 
4015
            if len(revision) > 2:
 
4016
                raise errors.BzrCommandError('bzr merge-directive takes '
 
4017
                    'at most two one revision identifiers')
 
4018
            revision_id = revision[-1].as_revision_id(branch)
 
4019
            if len(revision) == 2:
 
4020
                base_revision_id = revision[0].as_revision_id(branch)
 
4021
        else:
 
4022
            revision_id = branch.last_revision()
 
4023
        revision_id = ensure_null(revision_id)
 
4024
        if revision_id == NULL_REVISION:
 
4025
            raise errors.BzrCommandError('No revisions to bundle.')
 
4026
        directive = merge_directive.MergeDirective2.from_objects(
 
4027
            branch.repository, revision_id, time.time(),
 
4028
            osutils.local_time_offset(), submit_branch,
 
4029
            public_branch=public_branch, include_patch=include_patch,
 
4030
            include_bundle=include_bundle, message=message,
 
4031
            base_revision_id=base_revision_id)
 
4032
        if mail_to is None:
 
4033
            if sign:
 
4034
                self.outf.write(directive.to_signed(branch))
 
4035
            else:
 
4036
                self.outf.writelines(directive.to_lines())
 
4037
        else:
 
4038
            message = directive.to_email(mail_to, branch, sign)
 
4039
            s = SMTPConnection(branch.get_config())
 
4040
            s.send_email(message)
 
4041
 
 
4042
 
 
4043
class cmd_send(Command):
 
4044
    """Mail or create a merge-directive for submiting changes.
 
4045
 
 
4046
    A merge directive provides many things needed for requesting merges:
 
4047
 
 
4048
    * A machine-readable description of the merge to perform
 
4049
 
 
4050
    * An optional patch that is a preview of the changes requested
 
4051
 
 
4052
    * An optional bundle of revision data, so that the changes can be applied
 
4053
      directly from the merge directive, without retrieving data from a
 
4054
      branch.
 
4055
 
 
4056
    If --no-bundle is specified, then public_branch is needed (and must be
 
4057
    up-to-date), so that the receiver can perform the merge using the
 
4058
    public_branch.  The public_branch is always included if known, so that
 
4059
    people can check it later.
 
4060
 
 
4061
    The submit branch defaults to the parent, but can be overridden.  Both
 
4062
    submit branch and public branch will be remembered if supplied.
 
4063
 
 
4064
    If a public_branch is known for the submit_branch, that public submit
 
4065
    branch is used in the merge instructions.  This means that a local mirror
 
4066
    can be used as your actual submit branch, once you have set public_branch
 
4067
    for that mirror.
 
4068
 
 
4069
    Mail is sent using your preferred mail program.  This should be transparent
 
4070
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
 
4071
    If the preferred client can't be found (or used), your editor will be used.
 
4072
    
 
4073
    To use a specific mail program, set the mail_client configuration option.
 
4074
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
 
4075
    specific clients are "evolution", "kmail", "mutt", and "thunderbird";
 
4076
    generic options are "default", "editor", "mapi", and "xdg-email".
 
4077
 
 
4078
    If mail is being sent, a to address is required.  This can be supplied
 
4079
    either on the commandline, by setting the submit_to configuration
 
4080
    option in the branch itself or the child_submit_to configuration option 
 
4081
    in the submit branch.
 
4082
 
 
4083
    Two formats are currently supported: "4" uses revision bundle format 4 and
 
4084
    merge directive format 2.  It is significantly faster and smaller than
 
4085
    older formats.  It is compatible with Bazaar 0.19 and later.  It is the
 
4086
    default.  "0.9" uses revision bundle format 0.9 and merge directive
 
4087
    format 1.  It is compatible with Bazaar 0.12 - 0.18.
 
4088
    
 
4089
    Merge directives are applied using the merge command or the pull command.
 
4090
    """
 
4091
 
 
4092
    encoding_type = 'exact'
 
4093
 
 
4094
    _see_also = ['merge', 'pull']
 
4095
 
 
4096
    takes_args = ['submit_branch?', 'public_branch?']
 
4097
 
 
4098
    takes_options = [
 
4099
        Option('no-bundle',
 
4100
               help='Do not include a bundle in the merge directive.'),
 
4101
        Option('no-patch', help='Do not include a preview patch in the merge'
 
4102
               ' directive.'),
 
4103
        Option('remember',
 
4104
               help='Remember submit and public branch.'),
 
4105
        Option('from',
 
4106
               help='Branch to generate the submission from, '
 
4107
               'rather than the one containing the working directory.',
 
4108
               short_name='f',
 
4109
               type=unicode),
 
4110
        Option('output', short_name='o', help='Write directive to this file.',
 
4111
               type=unicode),
 
4112
        Option('mail-to', help='Mail the request to this address.',
 
4113
               type=unicode),
 
4114
        'revision',
 
4115
        'message',
 
4116
        RegistryOption.from_kwargs('format',
 
4117
        'Use the specified output format.',
 
4118
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
4119
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
 
4120
        ]
 
4121
 
 
4122
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
 
4123
            no_patch=False, revision=None, remember=False, output=None,
 
4124
            format='4', mail_to=None, message=None, **kwargs):
 
4125
        return self._run(submit_branch, revision, public_branch, remember,
 
4126
                         format, no_bundle, no_patch, output,
 
4127
                         kwargs.get('from', '.'), mail_to, message)
 
4128
 
 
4129
    def _run(self, submit_branch, revision, public_branch, remember, format,
 
4130
             no_bundle, no_patch, output, from_, mail_to, message):
 
4131
        from bzrlib.revision import NULL_REVISION
 
4132
        branch = Branch.open_containing(from_)[0]
 
4133
        if output is None:
 
4134
            outfile = StringIO()
 
4135
        elif output == '-':
 
4136
            outfile = self.outf
 
4137
        else:
 
4138
            outfile = open(output, 'wb')
 
4139
        # we may need to write data into branch's repository to calculate
 
4140
        # the data to send.
 
4141
        branch.lock_write()
 
4142
        try:
 
4143
            if output is None:
 
4144
                config = branch.get_config()
 
4145
                if mail_to is None:
 
4146
                    mail_to = config.get_user_option('submit_to')
 
4147
                mail_client = config.get_mail_client()
 
4148
            if remember and submit_branch is None:
 
4149
                raise errors.BzrCommandError(
 
4150
                    '--remember requires a branch to be specified.')
 
4151
            stored_submit_branch = branch.get_submit_branch()
 
4152
            remembered_submit_branch = False
 
4153
            if submit_branch is None:
 
4154
                submit_branch = stored_submit_branch
 
4155
                remembered_submit_branch = True
 
4156
            else:
 
4157
                if stored_submit_branch is None or remember:
 
4158
                    branch.set_submit_branch(submit_branch)
 
4159
            if submit_branch is None:
 
4160
                submit_branch = branch.get_parent()
 
4161
                remembered_submit_branch = True
 
4162
            if submit_branch is None:
 
4163
                raise errors.BzrCommandError('No submit branch known or'
 
4164
                                             ' specified')
 
4165
            if remembered_submit_branch:
 
4166
                note('Using saved location: %s', submit_branch)
 
4167
 
 
4168
            if mail_to is None:
 
4169
                submit_config = Branch.open(submit_branch).get_config()
 
4170
                mail_to = submit_config.get_user_option("child_submit_to")
 
4171
 
 
4172
            stored_public_branch = branch.get_public_branch()
 
4173
            if public_branch is None:
 
4174
                public_branch = stored_public_branch
 
4175
            elif stored_public_branch is None or remember:
 
4176
                branch.set_public_branch(public_branch)
 
4177
            if no_bundle and public_branch is None:
 
4178
                raise errors.BzrCommandError('No public branch specified or'
 
4179
                                             ' known')
 
4180
            base_revision_id = None
 
4181
            revision_id = None
 
4182
            if revision is not None:
 
4183
                if len(revision) > 2:
 
4184
                    raise errors.BzrCommandError('bzr send takes '
 
4185
                        'at most two one revision identifiers')
 
4186
                revision_id = revision[-1].as_revision_id(branch)
 
4187
                if len(revision) == 2:
 
4188
                    base_revision_id = revision[0].as_revision_id(branch)
 
4189
            if revision_id is None:
 
4190
                revision_id = branch.last_revision()
 
4191
            if revision_id == NULL_REVISION:
 
4192
                raise errors.BzrCommandError('No revisions to submit.')
 
4193
            if format == '4':
 
4194
                directive = merge_directive.MergeDirective2.from_objects(
 
4195
                    branch.repository, revision_id, time.time(),
 
4196
                    osutils.local_time_offset(), submit_branch,
 
4197
                    public_branch=public_branch, include_patch=not no_patch,
 
4198
                    include_bundle=not no_bundle, message=message,
 
4199
                    base_revision_id=base_revision_id)
 
4200
            elif format == '0.9':
 
4201
                if not no_bundle:
 
4202
                    if not no_patch:
 
4203
                        patch_type = 'bundle'
 
4204
                    else:
 
4205
                        raise errors.BzrCommandError('Format 0.9 does not'
 
4206
                            ' permit bundle with no patch')
 
4207
                else:
 
4208
                    if not no_patch:
 
4209
                        patch_type = 'diff'
 
4210
                    else:
 
4211
                        patch_type = None
 
4212
                directive = merge_directive.MergeDirective.from_objects(
 
4213
                    branch.repository, revision_id, time.time(),
 
4214
                    osutils.local_time_offset(), submit_branch,
 
4215
                    public_branch=public_branch, patch_type=patch_type,
 
4216
                    message=message)
 
4217
 
 
4218
            outfile.writelines(directive.to_lines())
 
4219
            if output is None:
 
4220
                subject = '[MERGE] '
 
4221
                if message is not None:
 
4222
                    subject += message
 
4223
                else:
 
4224
                    revision = branch.repository.get_revision(revision_id)
 
4225
                    subject += revision.get_summary()
 
4226
                basename = directive.get_disk_name(branch)
 
4227
                mail_client.compose_merge_request(mail_to, subject,
 
4228
                                                  outfile.getvalue(), basename)
 
4229
        finally:
 
4230
            if output != '-':
 
4231
                outfile.close()
 
4232
            branch.unlock()
 
4233
 
 
4234
 
 
4235
class cmd_bundle_revisions(cmd_send):
 
4236
 
 
4237
    """Create a merge-directive for submiting changes.
 
4238
 
 
4239
    A merge directive provides many things needed for requesting merges:
 
4240
 
 
4241
    * A machine-readable description of the merge to perform
 
4242
 
 
4243
    * An optional patch that is a preview of the changes requested
 
4244
 
 
4245
    * An optional bundle of revision data, so that the changes can be applied
 
4246
      directly from the merge directive, without retrieving data from a
 
4247
      branch.
 
4248
 
 
4249
    If --no-bundle is specified, then public_branch is needed (and must be
 
4250
    up-to-date), so that the receiver can perform the merge using the
 
4251
    public_branch.  The public_branch is always included if known, so that
 
4252
    people can check it later.
 
4253
 
 
4254
    The submit branch defaults to the parent, but can be overridden.  Both
 
4255
    submit branch and public branch will be remembered if supplied.
 
4256
 
 
4257
    If a public_branch is known for the submit_branch, that public submit
 
4258
    branch is used in the merge instructions.  This means that a local mirror
 
4259
    can be used as your actual submit branch, once you have set public_branch
 
4260
    for that mirror.
 
4261
 
 
4262
    Two formats are currently supported: "4" uses revision bundle format 4 and
 
4263
    merge directive format 2.  It is significantly faster and smaller than
 
4264
    older formats.  It is compatible with Bazaar 0.19 and later.  It is the
 
4265
    default.  "0.9" uses revision bundle format 0.9 and merge directive
 
4266
    format 1.  It is compatible with Bazaar 0.12 - 0.18.
 
4267
    """
 
4268
 
 
4269
    takes_options = [
 
4270
        Option('no-bundle',
 
4271
               help='Do not include a bundle in the merge directive.'),
 
4272
        Option('no-patch', help='Do not include a preview patch in the merge'
 
4273
               ' directive.'),
 
4274
        Option('remember',
 
4275
               help='Remember submit and public branch.'),
 
4276
        Option('from',
 
4277
               help='Branch to generate the submission from, '
 
4278
               'rather than the one containing the working directory.',
 
4279
               short_name='f',
 
4280
               type=unicode),
 
4281
        Option('output', short_name='o', help='Write directive to this file.',
 
4282
               type=unicode),
 
4283
        'revision',
 
4284
        RegistryOption.from_kwargs('format',
 
4285
        'Use the specified output format.',
 
4286
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
4287
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
 
4288
        ]
 
4289
    aliases = ['bundle']
 
4290
 
 
4291
    _see_also = ['send', 'merge']
 
4292
 
 
4293
    hidden = True
 
4294
 
 
4295
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
 
4296
            no_patch=False, revision=None, remember=False, output=None,
 
4297
            format='4', **kwargs):
 
4298
        if output is None:
 
4299
            output = '-'
 
4300
        return self._run(submit_branch, revision, public_branch, remember,
 
4301
                         format, no_bundle, no_patch, output,
 
4302
                         kwargs.get('from', '.'), None, None)
 
4303
 
 
4304
 
 
4305
class cmd_tag(Command):
 
4306
    """Create, remove or modify a tag naming a revision.
 
4307
    
 
4308
    Tags give human-meaningful names to revisions.  Commands that take a -r
 
4309
    (--revision) option can be given -rtag:X, where X is any previously
 
4310
    created tag.
 
4311
 
 
4312
    Tags are stored in the branch.  Tags are copied from one branch to another
 
4313
    along when you branch, push, pull or merge.
 
4314
 
 
4315
    It is an error to give a tag name that already exists unless you pass 
 
4316
    --force, in which case the tag is moved to point to the new revision.
 
4317
    """
 
4318
 
 
4319
    _see_also = ['commit', 'tags']
 
4320
    takes_args = ['tag_name']
 
4321
    takes_options = [
 
4322
        Option('delete',
 
4323
            help='Delete this tag rather than placing it.',
 
4324
            ),
 
4325
        Option('directory',
 
4326
            help='Branch in which to place the tag.',
 
4327
            short_name='d',
 
4328
            type=unicode,
 
4329
            ),
 
4330
        Option('force',
 
4331
            help='Replace existing tags.',
 
4332
            ),
 
4333
        'revision',
 
4334
        ]
 
4335
 
 
4336
    def run(self, tag_name,
 
4337
            delete=None,
 
4338
            directory='.',
 
4339
            force=None,
 
4340
            revision=None,
 
4341
            ):
 
4342
        branch, relpath = Branch.open_containing(directory)
 
4343
        branch.lock_write()
 
4344
        try:
 
4345
            if delete:
 
4346
                branch.tags.delete_tag(tag_name)
 
4347
                self.outf.write('Deleted tag %s.\n' % tag_name)
 
4348
            else:
 
4349
                if revision:
 
4350
                    if len(revision) != 1:
 
4351
                        raise errors.BzrCommandError(
 
4352
                            "Tags can only be placed on a single revision, "
 
4353
                            "not on a range")
 
4354
                    revision_id = revision[0].as_revision_id(branch)
 
4355
                else:
 
4356
                    revision_id = branch.last_revision()
 
4357
                if (not force) and branch.tags.has_tag(tag_name):
 
4358
                    raise errors.TagAlreadyExists(tag_name)
 
4359
                branch.tags.set_tag(tag_name, revision_id)
 
4360
                self.outf.write('Created tag %s.\n' % tag_name)
 
4361
        finally:
 
4362
            branch.unlock()
 
4363
 
 
4364
 
 
4365
class cmd_tags(Command):
 
4366
    """List tags.
 
4367
 
 
4368
    This command shows a table of tag names and the revisions they reference.
 
4369
    """
 
4370
 
 
4371
    _see_also = ['tag']
 
4372
    takes_options = [
 
4373
        Option('directory',
 
4374
            help='Branch whose tags should be displayed.',
 
4375
            short_name='d',
 
4376
            type=unicode,
 
4377
            ),
 
4378
        RegistryOption.from_kwargs('sort',
 
4379
            'Sort tags by different criteria.', title='Sorting',
 
4380
            alpha='Sort tags lexicographically (default).',
 
4381
            time='Sort tags chronologically.',
 
4382
            ),
 
4383
        'show-ids',
 
4384
    ]
 
4385
 
 
4386
    @display_command
 
4387
    def run(self,
 
4388
            directory='.',
 
4389
            sort='alpha',
 
4390
            show_ids=False,
 
4391
            ):
 
4392
        branch, relpath = Branch.open_containing(directory)
 
4393
        tags = branch.tags.get_tag_dict().items()
 
4394
        if sort == 'alpha':
 
4395
            tags.sort()
 
4396
        elif sort == 'time':
 
4397
            timestamps = {}
 
4398
            for tag, revid in tags:
 
4399
                try:
 
4400
                    revobj = branch.repository.get_revision(revid)
 
4401
                except errors.NoSuchRevision:
 
4402
                    timestamp = sys.maxint # place them at the end
 
4403
                else:
 
4404
                    timestamp = revobj.timestamp
 
4405
                timestamps[revid] = timestamp
 
4406
            tags.sort(key=lambda x: timestamps[x[1]])
 
4407
        if not show_ids:
 
4408
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
 
4409
            revno_map = branch.get_revision_id_to_revno_map()
 
4410
            tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
 
4411
                        for tag, revid in tags ]
 
4412
        for tag, revspec in tags:
 
4413
            self.outf.write('%-20s %s\n' % (tag, revspec))
 
4414
 
 
4415
 
 
4416
class cmd_reconfigure(Command):
 
4417
    """Reconfigure the type of a bzr directory.
 
4418
 
 
4419
    A target configuration must be specified.
 
4420
 
 
4421
    For checkouts, the bind-to location will be auto-detected if not specified.
 
4422
    The order of preference is
 
4423
    1. For a lightweight checkout, the current bound location.
 
4424
    2. For branches that used to be checkouts, the previously-bound location.
 
4425
    3. The push location.
 
4426
    4. The parent location.
 
4427
    If none of these is available, --bind-to must be specified.
 
4428
    """
 
4429
 
 
4430
    takes_args = ['location?']
 
4431
    takes_options = [RegistryOption.from_kwargs('target_type',
 
4432
                     title='Target type',
 
4433
                     help='The type to reconfigure the directory to.',
 
4434
                     value_switches=True, enum_switch=False,
 
4435
                     branch='Reconfigure to a branch.',
 
4436
                     tree='Reconfigure to a tree.',
 
4437
                     checkout='Reconfigure to a checkout.',
 
4438
                     lightweight_checkout='Reconfigure to a lightweight'
 
4439
                     ' checkout.'),
 
4440
                     Option('bind-to', help='Branch to bind checkout to.',
 
4441
                            type=str),
 
4442
                     Option('force',
 
4443
                        help='Perform reconfiguration even if local changes'
 
4444
                        ' will be lost.')
 
4445
                     ]
 
4446
 
 
4447
    def run(self, location=None, target_type=None, bind_to=None, force=False):
 
4448
        directory = bzrdir.BzrDir.open(location)
 
4449
        if target_type is None:
 
4450
            raise errors.BzrCommandError('No target configuration specified')
 
4451
        elif target_type == 'branch':
 
4452
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
 
4453
        elif target_type == 'tree':
 
4454
            reconfiguration = reconfigure.Reconfigure.to_tree(directory)
 
4455
        elif target_type == 'checkout':
 
4456
            reconfiguration = reconfigure.Reconfigure.to_checkout(directory,
 
4457
                                                                  bind_to)
 
4458
        elif target_type == 'lightweight-checkout':
 
4459
            reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
 
4460
                directory, bind_to)
 
4461
        reconfiguration.apply(force)
 
4462
 
 
4463
 
 
4464
class cmd_switch(Command):
 
4465
    """Set the branch of a checkout and update.
 
4466
    
 
4467
    For lightweight checkouts, this changes the branch being referenced.
 
4468
    For heavyweight checkouts, this checks that there are no local commits
 
4469
    versus the current bound branch, then it makes the local branch a mirror
 
4470
    of the new location and binds to it.
 
4471
    
 
4472
    In both cases, the working tree is updated and uncommitted changes
 
4473
    are merged. The user can commit or revert these as they desire.
 
4474
 
 
4475
    Pending merges need to be committed or reverted before using switch.
 
4476
 
 
4477
    The path to the branch to switch to can be specified relative to the parent
 
4478
    directory of the current branch. For example, if you are currently in a
 
4479
    checkout of /path/to/branch, specifying 'newbranch' will find a branch at
 
4480
    /path/to/newbranch.
 
4481
    """
 
4482
 
 
4483
    takes_args = ['to_location']
 
4484
    takes_options = [Option('force',
 
4485
                        help='Switch even if local commits will be lost.')
 
4486
                     ]
 
4487
 
 
4488
    def run(self, to_location, force=False):
 
4489
        from bzrlib import switch
 
4490
        tree_location = '.'
 
4491
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
 
4492
        try:
 
4493
            to_branch = Branch.open(to_location)
 
4494
        except errors.NotBranchError:
 
4495
            to_branch = Branch.open(
 
4496
                control_dir.open_branch().base + '../' + to_location)
 
4497
        switch.switch(control_dir, to_branch, force)
 
4498
        note('Switched to branch: %s',
 
4499
            urlutils.unescape_for_display(to_branch.base, 'utf-8'))
 
4500
 
 
4501
 
 
4502
class cmd_hooks(Command):
 
4503
    """Show a branch's currently registered hooks.
 
4504
    """
 
4505
 
 
4506
    hidden = True
 
4507
    takes_args = ['path?']
 
4508
 
 
4509
    def run(self, path=None):
 
4510
        if path is None:
 
4511
            path = '.'
 
4512
        branch_hooks = Branch.open(path).hooks
 
4513
        for hook_type in branch_hooks:
 
4514
            hooks = branch_hooks[hook_type]
 
4515
            self.outf.write("%s:\n" % (hook_type,))
 
4516
            if hooks:
 
4517
                for hook in hooks:
 
4518
                    self.outf.write("  %s\n" %
 
4519
                                    (branch_hooks.get_hook_name(hook),))
 
4520
            else:
 
4521
                self.outf.write("  <no hooks installed>\n")
 
4522
 
 
4523
 
 
4524
def _create_prefix(cur_transport):
 
4525
    needed = [cur_transport]
 
4526
    # Recurse upwards until we can create a directory successfully
 
4527
    while True:
 
4528
        new_transport = cur_transport.clone('..')
 
4529
        if new_transport.base == cur_transport.base:
 
4530
            raise errors.BzrCommandError(
 
4531
                "Failed to create path prefix for %s."
 
4532
                % cur_transport.base)
 
4533
        try:
 
4534
            new_transport.mkdir('.')
 
4535
        except errors.NoSuchFile:
 
4536
            needed.append(new_transport)
 
4537
            cur_transport = new_transport
 
4538
        else:
 
4539
            break
 
4540
    # Now we only need to create child directories
 
4541
    while needed:
 
4542
        cur_transport = needed.pop()
 
4543
        cur_transport.ensure_base()
 
4544
 
 
4545
 
 
4546
# these get imported and then picked up by the scan for cmd_*
 
4547
# TODO: Some more consistent way to split command definitions across files;
 
4548
# we do need to load at least some information about them to know of 
 
4549
# aliases.  ideally we would avoid loading the implementation until the
 
4550
# details were needed.
 
4551
from bzrlib.cmd_version_info import cmd_version_info
 
4552
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
4553
from bzrlib.bundle.commands import (
 
4554
    cmd_bundle_info,
 
4555
    )
 
4556
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
4557
from bzrlib.weave_commands import cmd_versionedfile_list, cmd_weave_join, \
 
4558
        cmd_weave_plan_merge, cmd_weave_merge_text