← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Martin Pool
  • Date: 2009-06-10 02:22:58 UTC
  • mto: This revision was merged to the branch mainline in revision 4464.
  • Revision ID: mbp@sourcefrog.net-20090610022258-czra1150uv22976i
textwrap break_on_hyphens option is not available in python2.5

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/builtins.py
 
1
# Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
"""builtin bzr commands"""
 
18
 
 
19
import os
 
20
 
 
21
from bzrlib.lazy_import import lazy_import
 
22
lazy_import(globals(), """
 
23
import codecs
 
24
import cStringIO
 
25
import sys
 
26
import time
 
27
 
 
28
import bzrlib
 
29
from bzrlib import (
 
30
    bugtracker,
 
31
    bundle,
 
32
    btree_index,
 
33
    bzrdir,
 
34
    delta,
 
35
    config,
 
36
    errors,
 
37
    globbing,
 
38
    hooks,
 
39
    log,
 
40
    merge as _mod_merge,
 
41
    merge_directive,
 
42
    osutils,
 
43
    reconfigure,
 
44
    revision as _mod_revision,
 
45
    symbol_versioning,
 
46
    transport,
 
47
    tree as _mod_tree,
 
48
    ui,
 
49
    urlutils,
 
50
    views,
 
51
    )
 
52
from bzrlib.branch import Branch
 
53
from bzrlib.conflicts import ConflictList
 
54
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
 
55
from bzrlib.smtp_connection import SMTPConnection
 
56
from bzrlib.workingtree import WorkingTree
 
57
""")
 
58
 
 
59
from bzrlib.commands import Command, display_command
 
60
from bzrlib.option import (
 
61
    ListOption,
 
62
    Option,
 
63
    RegistryOption,
 
64
    custom_help,
 
65
    _parse_revision_str,
 
66
    )
 
67
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
 
68
 
 
69
 
 
70
def tree_files(file_list, default_branch=u'.', canonicalize=True,
 
71
    apply_view=True):
 
72
    try:
 
73
        return internal_tree_files(file_list, default_branch, canonicalize,
 
74
            apply_view)
 
75
    except errors.FileInWrongBranch, e:
 
76
        raise errors.BzrCommandError("%s is not in the same branch as %s" %
 
77
                                     (e.path, file_list[0]))
 
78
 
 
79
 
 
80
def tree_files_for_add(file_list):
 
81
    """Add handles files a bit differently so it a custom implementation."""
 
82
    if file_list:
 
83
        tree = WorkingTree.open_containing(file_list[0])[0]
 
84
        if tree.supports_views():
 
85
            view_files = tree.views.lookup_view()
 
86
            for filename in file_list:
 
87
                if not osutils.is_inside_any(view_files, filename):
 
88
                    raise errors.FileOutsideView(filename, view_files)
 
89
    else:
 
90
        tree = WorkingTree.open_containing(u'.')[0]
 
91
        if tree.supports_views():
 
92
            view_files = tree.views.lookup_view()
 
93
            if view_files:
 
94
                file_list = view_files
 
95
                view_str = views.view_display_str(view_files)
 
96
                note("ignoring files outside view: %s" % view_str)
 
97
    return tree, file_list
 
98
 
 
99
 
 
100
def _get_one_revision(command_name, revisions):
 
101
    if revisions is None:
 
102
        return None
 
103
    if len(revisions) != 1:
 
104
        raise errors.BzrCommandError(
 
105
            'bzr %s --revision takes exactly one revision identifier' % (
 
106
                command_name,))
 
107
    return revisions[0]
 
108
 
 
109
 
 
110
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
 
111
    if branch is None:
 
112
        branch = tree.branch
 
113
    if revisions is None:
 
114
        if tree is not None:
 
115
            rev_tree = tree.basis_tree()
 
116
        else:
 
117
            rev_tree = branch.basis_tree()
 
118
    else:
 
119
        revision = _get_one_revision(command_name, revisions)
 
120
        rev_tree = revision.as_tree(branch)
 
121
    return rev_tree
 
122
 
 
123
 
 
124
# XXX: Bad function name; should possibly also be a class method of
 
125
# WorkingTree rather than a function.
 
126
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
 
127
    apply_view=True):
 
128
    """Convert command-line paths to a WorkingTree and relative paths.
 
129
 
 
130
    This is typically used for command-line processors that take one or
 
131
    more filenames, and infer the workingtree that contains them.
 
132
 
 
133
    The filenames given are not required to exist.
 
134
 
 
135
    :param file_list: Filenames to convert.
 
136
 
 
137
    :param default_branch: Fallback tree path to use if file_list is empty or
 
138
        None.
 
139
 
 
140
    :param apply_view: if True and a view is set, apply it or check that
 
141
        specified files are within it
 
142
 
 
143
    :return: workingtree, [relative_paths]
 
144
    """
 
145
    if file_list is None or len(file_list) == 0:
 
146
        tree = WorkingTree.open_containing(default_branch)[0]
 
147
        if tree.supports_views() and apply_view:
 
148
            view_files = tree.views.lookup_view()
 
149
            if view_files:
 
150
                file_list = view_files
 
151
                view_str = views.view_display_str(view_files)
 
152
                note("ignoring files outside view: %s" % view_str)
 
153
        return tree, file_list
 
154
    tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
 
155
    return tree, safe_relpath_files(tree, file_list, canonicalize,
 
156
        apply_view=apply_view)
 
157
 
 
158
 
 
159
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
 
160
    """Convert file_list into a list of relpaths in tree.
 
161
 
 
162
    :param tree: A tree to operate on.
 
163
    :param file_list: A list of user provided paths or None.
 
164
    :param apply_view: if True and a view is set, apply it or check that
 
165
        specified files are within it
 
166
    :return: A list of relative paths.
 
167
    :raises errors.PathNotChild: When a provided path is in a different tree
 
168
        than tree.
 
169
    """
 
170
    if file_list is None:
 
171
        return None
 
172
    if tree.supports_views() and apply_view:
 
173
        view_files = tree.views.lookup_view()
 
174
    else:
 
175
        view_files = []
 
176
    new_list = []
 
177
    # tree.relpath exists as a "thunk" to osutils, but canonical_relpath
 
178
    # doesn't - fix that up here before we enter the loop.
 
179
    if canonicalize:
 
180
        fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
 
181
    else:
 
182
        fixer = tree.relpath
 
183
    for filename in file_list:
 
184
        try:
 
185
            relpath = fixer(osutils.dereference_path(filename))
 
186
            if  view_files and not osutils.is_inside_any(view_files, relpath):
 
187
                raise errors.FileOutsideView(filename, view_files)
 
188
            new_list.append(relpath)
 
189
        except errors.PathNotChild:
 
190
            raise errors.FileInWrongBranch(tree.branch, filename)
 
191
    return new_list
 
192
 
 
193
 
 
194
def _get_view_info_for_change_reporter(tree):
 
195
    """Get the view information from a tree for change reporting."""
 
196
    view_info = None
 
197
    try:
 
198
        current_view = tree.views.get_view_info()[0]
 
199
        if current_view is not None:
 
200
            view_info = (current_view, tree.views.lookup_view())
 
201
    except errors.ViewsNotSupported:
 
202
        pass
 
203
    return view_info
 
204
 
 
205
 
 
206
# TODO: Make sure no commands unconditionally use the working directory as a
 
207
# branch.  If a filename argument is used, the first of them should be used to
 
208
# specify the branch.  (Perhaps this can be factored out into some kind of
 
209
# Argument class, representing a file in a branch, where the first occurrence
 
210
# opens the branch?)
 
211
 
 
212
class cmd_status(Command):
 
213
    """Display status summary.
 
214
 
 
215
    This reports on versioned and unknown files, reporting them
 
216
    grouped by state.  Possible states are:
 
217
 
 
218
    added
 
219
        Versioned in the working copy but not in the previous revision.
 
220
 
 
221
    removed
 
222
        Versioned in the previous revision but removed or deleted
 
223
        in the working copy.
 
224
 
 
225
    renamed
 
226
        Path of this file changed from the previous revision;
 
227
        the text may also have changed.  This includes files whose
 
228
        parent directory was renamed.
 
229
 
 
230
    modified
 
231
        Text has changed since the previous revision.
 
232
 
 
233
    kind changed
 
234
        File kind has been changed (e.g. from file to directory).
 
235
 
 
236
    unknown
 
237
        Not versioned and not matching an ignore pattern.
 
238
 
 
239
    To see ignored files use 'bzr ignored'.  For details on the
 
240
    changes to file texts, use 'bzr diff'.
 
241
 
 
242
    Note that --short or -S gives status flags for each item, similar
 
243
    to Subversion's status command. To get output similar to svn -q,
 
244
    use bzr status -SV.
 
245
 
 
246
    If no arguments are specified, the status of the entire working
 
247
    directory is shown.  Otherwise, only the status of the specified
 
248
    files or directories is reported.  If a directory is given, status
 
249
    is reported for everything inside that directory.
 
250
 
 
251
    Before merges are committed, the pending merge tip revisions are
 
252
    shown. To see all pending merge revisions, use the -v option.
 
253
    To skip the display of pending merge information altogether, use
 
254
    the no-pending option or specify a file/directory.
 
255
 
 
256
    If a revision argument is given, the status is calculated against
 
257
    that revision, or between two revisions if two are provided.
 
258
    """
 
259
 
 
260
    # TODO: --no-recurse, --recurse options
 
261
 
 
262
    takes_args = ['file*']
 
263
    takes_options = ['show-ids', 'revision', 'change', 'verbose',
 
264
                     Option('short', help='Use short status indicators.',
 
265
                            short_name='S'),
 
266
                     Option('versioned', help='Only show versioned files.',
 
267
                            short_name='V'),
 
268
                     Option('no-pending', help='Don\'t show pending merges.',
 
269
                           ),
 
270
                     ]
 
271
    aliases = ['st', 'stat']
 
272
 
 
273
    encoding_type = 'replace'
 
274
    _see_also = ['diff', 'revert', 'status-flags']
 
275
 
 
276
    @display_command
 
277
    def run(self, show_ids=False, file_list=None, revision=None, short=False,
 
278
            versioned=False, no_pending=False, verbose=False):
 
279
        from bzrlib.status import show_tree_status
 
280
 
 
281
        if revision and len(revision) > 2:
 
282
            raise errors.BzrCommandError('bzr status --revision takes exactly'
 
283
                                         ' one or two revision specifiers')
 
284
 
 
285
        tree, relfile_list = tree_files(file_list)
 
286
        # Avoid asking for specific files when that is not needed.
 
287
        if relfile_list == ['']:
 
288
            relfile_list = None
 
289
            # Don't disable pending merges for full trees other than '.'.
 
290
            if file_list == ['.']:
 
291
                no_pending = True
 
292
        # A specific path within a tree was given.
 
293
        elif relfile_list is not None:
 
294
            no_pending = True
 
295
        show_tree_status(tree, show_ids=show_ids,
 
296
                         specific_files=relfile_list, revision=revision,
 
297
                         to_file=self.outf, short=short, versioned=versioned,
 
298
                         show_pending=(not no_pending), verbose=verbose)
 
299
 
 
300
 
 
301
class cmd_cat_revision(Command):
 
302
    """Write out metadata for a revision.
 
303
 
 
304
    The revision to print can either be specified by a specific
 
305
    revision identifier, or you can use --revision.
 
306
    """
 
307
 
 
308
    hidden = True
 
309
    takes_args = ['revision_id?']
 
310
    takes_options = ['revision']
 
311
    # cat-revision is more for frontends so should be exact
 
312
    encoding = 'strict'
 
313
 
 
314
    @display_command
 
315
    def run(self, revision_id=None, revision=None):
 
316
        if revision_id is not None and revision is not None:
 
317
            raise errors.BzrCommandError('You can only supply one of'
 
318
                                         ' revision_id or --revision')
 
319
        if revision_id is None and revision is None:
 
320
            raise errors.BzrCommandError('You must supply either'
 
321
                                         ' --revision or a revision_id')
 
322
        b = WorkingTree.open_containing(u'.')[0].branch
 
323
 
 
324
        # TODO: jam 20060112 should cat-revision always output utf-8?
 
325
        if revision_id is not None:
 
326
            revision_id = osutils.safe_revision_id(revision_id, warn=False)
 
327
            try:
 
328
                self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
 
329
            except errors.NoSuchRevision:
 
330
                msg = "The repository %s contains no revision %s." % (b.repository.base,
 
331
                    revision_id)
 
332
                raise errors.BzrCommandError(msg)
 
333
        elif revision is not None:
 
334
            for rev in revision:
 
335
                if rev is None:
 
336
                    raise errors.BzrCommandError('You cannot specify a NULL'
 
337
                                                 ' revision.')
 
338
                rev_id = rev.as_revision_id(b)
 
339
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
 
340
 
 
341
 
 
342
class cmd_dump_btree(Command):
 
343
    """Dump the contents of a btree index file to stdout.
 
344
 
 
345
    PATH is a btree index file, it can be any URL. This includes things like
 
346
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
 
347
 
 
348
    By default, the tuples stored in the index file will be displayed. With
 
349
    --raw, we will uncompress the pages, but otherwise display the raw bytes
 
350
    stored in the index.
 
351
    """
 
352
 
 
353
    # TODO: Do we want to dump the internal nodes as well?
 
354
    # TODO: It would be nice to be able to dump the un-parsed information,
 
355
    #       rather than only going through iter_all_entries. However, this is
 
356
    #       good enough for a start
 
357
    hidden = True
 
358
    encoding_type = 'exact'
 
359
    takes_args = ['path']
 
360
    takes_options = [Option('raw', help='Write the uncompressed bytes out,'
 
361
                                        ' rather than the parsed tuples.'),
 
362
                    ]
 
363
 
 
364
    def run(self, path, raw=False):
 
365
        dirname, basename = osutils.split(path)
 
366
        t = transport.get_transport(dirname)
 
367
        if raw:
 
368
            self._dump_raw_bytes(t, basename)
 
369
        else:
 
370
            self._dump_entries(t, basename)
 
371
 
 
372
    def _get_index_and_bytes(self, trans, basename):
 
373
        """Create a BTreeGraphIndex and raw bytes."""
 
374
        bt = btree_index.BTreeGraphIndex(trans, basename, None)
 
375
        bytes = trans.get_bytes(basename)
 
376
        bt._file = cStringIO.StringIO(bytes)
 
377
        bt._size = len(bytes)
 
378
        return bt, bytes
 
379
 
 
380
    def _dump_raw_bytes(self, trans, basename):
 
381
        import zlib
 
382
 
 
383
        # We need to parse at least the root node.
 
384
        # This is because the first page of every row starts with an
 
385
        # uncompressed header.
 
386
        bt, bytes = self._get_index_and_bytes(trans, basename)
 
387
        for page_idx, page_start in enumerate(xrange(0, len(bytes),
 
388
                                                     btree_index._PAGE_SIZE)):
 
389
            page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
 
390
            page_bytes = bytes[page_start:page_end]
 
391
            if page_idx == 0:
 
392
                self.outf.write('Root node:\n')
 
393
                header_end, data = bt._parse_header_from_bytes(page_bytes)
 
394
                self.outf.write(page_bytes[:header_end])
 
395
                page_bytes = data
 
396
            self.outf.write('\nPage %d\n' % (page_idx,))
 
397
            decomp_bytes = zlib.decompress(page_bytes)
 
398
            self.outf.write(decomp_bytes)
 
399
            self.outf.write('\n')
 
400
 
 
401
    def _dump_entries(self, trans, basename):
 
402
        try:
 
403
            st = trans.stat(basename)
 
404
        except errors.TransportNotPossible:
 
405
            # We can't stat, so we'll fake it because we have to do the 'get()'
 
406
            # anyway.
 
407
            bt, _ = self._get_index_and_bytes(trans, basename)
 
408
        else:
 
409
            bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
 
410
        for node in bt.iter_all_entries():
 
411
            # Node is made up of:
 
412
            # (index, key, value, [references])
 
413
            self.outf.write('%s\n' % (node[1:],))
 
414
 
 
415
 
 
416
class cmd_remove_tree(Command):
 
417
    """Remove the working tree from a given branch/checkout.
 
418
 
 
419
    Since a lightweight checkout is little more than a working tree
 
420
    this will refuse to run against one.
 
421
 
 
422
    To re-create the working tree, use "bzr checkout".
 
423
    """
 
424
    _see_also = ['checkout', 'working-trees']
 
425
    takes_args = ['location?']
 
426
    takes_options = [
 
427
        Option('force',
 
428
               help='Remove the working tree even if it has '
 
429
                    'uncommitted changes.'),
 
430
        ]
 
431
 
 
432
    def run(self, location='.', force=False):
 
433
        d = bzrdir.BzrDir.open(location)
 
434
 
 
435
        try:
 
436
            working = d.open_workingtree()
 
437
        except errors.NoWorkingTree:
 
438
            raise errors.BzrCommandError("No working tree to remove")
 
439
        except errors.NotLocalUrl:
 
440
            raise errors.BzrCommandError("You cannot remove the working tree of a "
 
441
                                         "remote path")
 
442
        if not force:
 
443
            changes = working.changes_from(working.basis_tree())
 
444
            if changes.has_changed():
 
445
                raise errors.UncommittedChanges(working)
 
446
 
 
447
        working_path = working.bzrdir.root_transport.base
 
448
        branch_path = working.branch.bzrdir.root_transport.base
 
449
        if working_path != branch_path:
 
450
            raise errors.BzrCommandError("You cannot remove the working tree from "
 
451
                                         "a lightweight checkout")
 
452
 
 
453
        d.destroy_workingtree()
 
454
 
 
455
 
 
456
class cmd_revno(Command):
 
457
    """Show current revision number.
 
458
 
 
459
    This is equal to the number of revisions on this branch.
 
460
    """
 
461
 
 
462
    _see_also = ['info']
 
463
    takes_args = ['location?']
 
464
 
 
465
    @display_command
 
466
    def run(self, location=u'.'):
 
467
        self.outf.write(str(Branch.open_containing(location)[0].revno()))
 
468
        self.outf.write('\n')
 
469
 
 
470
 
 
471
class cmd_revision_info(Command):
 
472
    """Show revision number and revision id for a given revision identifier.
 
473
    """
 
474
    hidden = True
 
475
    takes_args = ['revision_info*']
 
476
    takes_options = [
 
477
        'revision',
 
478
        Option('directory',
 
479
            help='Branch to examine, '
 
480
                 'rather than the one containing the working directory.',
 
481
            short_name='d',
 
482
            type=unicode,
 
483
            ),
 
484
        ]
 
485
 
 
486
    @display_command
 
487
    def run(self, revision=None, directory=u'.', revision_info_list=[]):
 
488
 
 
489
        revs = []
 
490
        if revision is not None:
 
491
            revs.extend(revision)
 
492
        if revision_info_list is not None:
 
493
            for rev in revision_info_list:
 
494
                revs.append(RevisionSpec.from_string(rev))
 
495
 
 
496
        b = Branch.open_containing(directory)[0]
 
497
 
 
498
        if len(revs) == 0:
 
499
            revs.append(RevisionSpec.from_string('-1'))
 
500
 
 
501
        for rev in revs:
 
502
            revision_id = rev.as_revision_id(b)
 
503
            try:
 
504
                revno = '%4d' % (b.revision_id_to_revno(revision_id))
 
505
            except errors.NoSuchRevision:
 
506
                dotted_map = b.get_revision_id_to_revno_map()
 
507
                revno = '.'.join(str(i) for i in dotted_map[revision_id])
 
508
            print '%s %s' % (revno, revision_id)
 
509
 
 
510
 
 
511
class cmd_add(Command):
 
512
    """Add specified files or directories.
 
513
 
 
514
    In non-recursive mode, all the named items are added, regardless
 
515
    of whether they were previously ignored.  A warning is given if
 
516
    any of the named files are already versioned.
 
517
 
 
518
    In recursive mode (the default), files are treated the same way
 
519
    but the behaviour for directories is different.  Directories that
 
520
    are already versioned do not give a warning.  All directories,
 
521
    whether already versioned or not, are searched for files or
 
522
    subdirectories that are neither versioned or ignored, and these
 
523
    are added.  This search proceeds recursively into versioned
 
524
    directories.  If no names are given '.' is assumed.
 
525
 
 
526
    Therefore simply saying 'bzr add' will version all files that
 
527
    are currently unknown.
 
528
 
 
529
    Adding a file whose parent directory is not versioned will
 
530
    implicitly add the parent, and so on up to the root. This means
 
531
    you should never need to explicitly add a directory, they'll just
 
532
    get added when you add a file in the directory.
 
533
 
 
534
    --dry-run will show which files would be added, but not actually
 
535
    add them.
 
536
 
 
537
    --file-ids-from will try to use the file ids from the supplied path.
 
538
    It looks up ids trying to find a matching parent directory with the
 
539
    same filename, and then by pure path. This option is rarely needed
 
540
    but can be useful when adding the same logical file into two
 
541
    branches that will be merged later (without showing the two different
 
542
    adds as a conflict). It is also useful when merging another project
 
543
    into a subdirectory of this one.
 
544
    """
 
545
    takes_args = ['file*']
 
546
    takes_options = [
 
547
        Option('no-recurse',
 
548
               help="Don't recursively add the contents of directories."),
 
549
        Option('dry-run',
 
550
               help="Show what would be done, but don't actually do anything."),
 
551
        'verbose',
 
552
        Option('file-ids-from',
 
553
               type=unicode,
 
554
               help='Lookup file ids from this tree.'),
 
555
        ]
 
556
    encoding_type = 'replace'
 
557
    _see_also = ['remove']
 
558
 
 
559
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
 
560
            file_ids_from=None):
 
561
        import bzrlib.add
 
562
 
 
563
        base_tree = None
 
564
        if file_ids_from is not None:
 
565
            try:
 
566
                base_tree, base_path = WorkingTree.open_containing(
 
567
                                            file_ids_from)
 
568
            except errors.NoWorkingTree:
 
569
                base_branch, base_path = Branch.open_containing(
 
570
                                            file_ids_from)
 
571
                base_tree = base_branch.basis_tree()
 
572
 
 
573
            action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
 
574
                          to_file=self.outf, should_print=(not is_quiet()))
 
575
        else:
 
576
            action = bzrlib.add.AddAction(to_file=self.outf,
 
577
                should_print=(not is_quiet()))
 
578
 
 
579
        if base_tree:
 
580
            base_tree.lock_read()
 
581
        try:
 
582
            file_list = self._maybe_expand_globs(file_list)
 
583
            tree, file_list = tree_files_for_add(file_list)
 
584
            added, ignored = tree.smart_add(file_list, not
 
585
                no_recurse, action=action, save=not dry_run)
 
586
        finally:
 
587
            if base_tree is not None:
 
588
                base_tree.unlock()
 
589
        if len(ignored) > 0:
 
590
            if verbose:
 
591
                for glob in sorted(ignored.keys()):
 
592
                    for path in ignored[glob]:
 
593
                        self.outf.write("ignored %s matching \"%s\"\n"
 
594
                                        % (path, glob))
 
595
            else:
 
596
                match_len = 0
 
597
                for glob, paths in ignored.items():
 
598
                    match_len += len(paths)
 
599
                self.outf.write("ignored %d file(s).\n" % match_len)
 
600
            self.outf.write("If you wish to add some of these files,"
 
601
                            " please add them by name.\n")
 
602
 
 
603
 
 
604
class cmd_mkdir(Command):
 
605
    """Create a new versioned directory.
 
606
 
 
607
    This is equivalent to creating the directory and then adding it.
 
608
    """
 
609
 
 
610
    takes_args = ['dir+']
 
611
    encoding_type = 'replace'
 
612
 
 
613
    def run(self, dir_list):
 
614
        for d in dir_list:
 
615
            os.mkdir(d)
 
616
            wt, dd = WorkingTree.open_containing(d)
 
617
            wt.add([dd])
 
618
            self.outf.write('added %s\n' % d)
 
619
 
 
620
 
 
621
class cmd_relpath(Command):
 
622
    """Show path of a file relative to root"""
 
623
 
 
624
    takes_args = ['filename']
 
625
    hidden = True
 
626
 
 
627
    @display_command
 
628
    def run(self, filename):
 
629
        # TODO: jam 20050106 Can relpath return a munged path if
 
630
        #       sys.stdout encoding cannot represent it?
 
631
        tree, relpath = WorkingTree.open_containing(filename)
 
632
        self.outf.write(relpath)
 
633
        self.outf.write('\n')
 
634
 
 
635
 
 
636
class cmd_inventory(Command):
 
637
    """Show inventory of the current working copy or a revision.
 
638
 
 
639
    It is possible to limit the output to a particular entry
 
640
    type using the --kind option.  For example: --kind file.
 
641
 
 
642
    It is also possible to restrict the list of files to a specific
 
643
    set. For example: bzr inventory --show-ids this/file
 
644
    """
 
645
 
 
646
    hidden = True
 
647
    _see_also = ['ls']
 
648
    takes_options = [
 
649
        'revision',
 
650
        'show-ids',
 
651
        Option('kind',
 
652
               help='List entries of a particular kind: file, directory, symlink.',
 
653
               type=unicode),
 
654
        ]
 
655
    takes_args = ['file*']
 
656
 
 
657
    @display_command
 
658
    def run(self, revision=None, show_ids=False, kind=None, file_list=None):
 
659
        if kind and kind not in ['file', 'directory', 'symlink']:
 
660
            raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
 
661
 
 
662
        revision = _get_one_revision('inventory', revision)
 
663
        work_tree, file_list = tree_files(file_list)
 
664
        work_tree.lock_read()
 
665
        try:
 
666
            if revision is not None:
 
667
                tree = revision.as_tree(work_tree.branch)
 
668
 
 
669
                extra_trees = [work_tree]
 
670
                tree.lock_read()
 
671
            else:
 
672
                tree = work_tree
 
673
                extra_trees = []
 
674
 
 
675
            if file_list is not None:
 
676
                file_ids = tree.paths2ids(file_list, trees=extra_trees,
 
677
                                          require_versioned=True)
 
678
                # find_ids_across_trees may include some paths that don't
 
679
                # exist in 'tree'.
 
680
                entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
 
681
                                 for file_id in file_ids if file_id in tree)
 
682
            else:
 
683
                entries = tree.inventory.entries()
 
684
        finally:
 
685
            tree.unlock()
 
686
            if tree is not work_tree:
 
687
                work_tree.unlock()
 
688
 
 
689
        for path, entry in entries:
 
690
            if kind and kind != entry.kind:
 
691
                continue
 
692
            if show_ids:
 
693
                self.outf.write('%-50s %s\n' % (path, entry.file_id))
 
694
            else:
 
695
                self.outf.write(path)
 
696
                self.outf.write('\n')
 
697
 
 
698
 
 
699
class cmd_mv(Command):
 
700
    """Move or rename a file.
 
701
 
 
702
    :Usage:
 
703
        bzr mv OLDNAME NEWNAME
 
704
 
 
705
        bzr mv SOURCE... DESTINATION
 
706
 
 
707
    If the last argument is a versioned directory, all the other names
 
708
    are moved into it.  Otherwise, there must be exactly two arguments
 
709
    and the file is changed to a new name.
 
710
 
 
711
    If OLDNAME does not exist on the filesystem but is versioned and
 
712
    NEWNAME does exist on the filesystem but is not versioned, mv
 
713
    assumes that the file has been manually moved and only updates
 
714
    its internal inventory to reflect that change.
 
715
    The same is valid when moving many SOURCE files to a DESTINATION.
 
716
 
 
717
    Files cannot be moved between branches.
 
718
    """
 
719
 
 
720
    takes_args = ['names*']
 
721
    takes_options = [Option("after", help="Move only the bzr identifier"
 
722
        " of the file, because the file has already been moved."),
 
723
        ]
 
724
    aliases = ['move', 'rename']
 
725
    encoding_type = 'replace'
 
726
 
 
727
    def run(self, names_list, after=False):
 
728
        if names_list is None:
 
729
            names_list = []
 
730
 
 
731
        if len(names_list) < 2:
 
732
            raise errors.BzrCommandError("missing file argument")
 
733
        tree, rel_names = tree_files(names_list, canonicalize=False)
 
734
        tree.lock_write()
 
735
        try:
 
736
            self._run(tree, names_list, rel_names, after)
 
737
        finally:
 
738
            tree.unlock()
 
739
 
 
740
    def _run(self, tree, names_list, rel_names, after):
 
741
        into_existing = osutils.isdir(names_list[-1])
 
742
        if into_existing and len(names_list) == 2:
 
743
            # special cases:
 
744
            # a. case-insensitive filesystem and change case of dir
 
745
            # b. move directory after the fact (if the source used to be
 
746
            #    a directory, but now doesn't exist in the working tree
 
747
            #    and the target is an existing directory, just rename it)
 
748
            if (not tree.case_sensitive
 
749
                and rel_names[0].lower() == rel_names[1].lower()):
 
750
                into_existing = False
 
751
            else:
 
752
                inv = tree.inventory
 
753
                # 'fix' the case of a potential 'from'
 
754
                from_id = tree.path2id(
 
755
                            tree.get_canonical_inventory_path(rel_names[0]))
 
756
                if (not osutils.lexists(names_list[0]) and
 
757
                    from_id and inv.get_file_kind(from_id) == "directory"):
 
758
                    into_existing = False
 
759
        # move/rename
 
760
        if into_existing:
 
761
            # move into existing directory
 
762
            # All entries reference existing inventory items, so fix them up
 
763
            # for cicp file-systems.
 
764
            rel_names = tree.get_canonical_inventory_paths(rel_names)
 
765
            for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
 
766
                self.outf.write("%s => %s\n" % pair)
 
767
        else:
 
768
            if len(names_list) != 2:
 
769
                raise errors.BzrCommandError('to mv multiple files the'
 
770
                                             ' destination must be a versioned'
 
771
                                             ' directory')
 
772
 
 
773
            # for cicp file-systems: the src references an existing inventory
 
774
            # item:
 
775
            src = tree.get_canonical_inventory_path(rel_names[0])
 
776
            # Find the canonical version of the destination:  In all cases, the
 
777
            # parent of the target must be in the inventory, so we fetch the
 
778
            # canonical version from there (we do not always *use* the
 
779
            # canonicalized tail portion - we may be attempting to rename the
 
780
            # case of the tail)
 
781
            canon_dest = tree.get_canonical_inventory_path(rel_names[1])
 
782
            dest_parent = osutils.dirname(canon_dest)
 
783
            spec_tail = osutils.basename(rel_names[1])
 
784
            # For a CICP file-system, we need to avoid creating 2 inventory
 
785
            # entries that differ only by case.  So regardless of the case
 
786
            # we *want* to use (ie, specified by the user or the file-system),
 
787
            # we must always choose to use the case of any existing inventory
 
788
            # items.  The only exception to this is when we are attempting a
 
789
            # case-only rename (ie, canonical versions of src and dest are
 
790
            # the same)
 
791
            dest_id = tree.path2id(canon_dest)
 
792
            if dest_id is None or tree.path2id(src) == dest_id:
 
793
                # No existing item we care about, so work out what case we
 
794
                # are actually going to use.
 
795
                if after:
 
796
                    # If 'after' is specified, the tail must refer to a file on disk.
 
797
                    if dest_parent:
 
798
                        dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
 
799
                    else:
 
800
                        # pathjoin with an empty tail adds a slash, which breaks
 
801
                        # relpath :(
 
802
                        dest_parent_fq = tree.basedir
 
803
 
 
804
                    dest_tail = osutils.canonical_relpath(
 
805
                                    dest_parent_fq,
 
806
                                    osutils.pathjoin(dest_parent_fq, spec_tail))
 
807
                else:
 
808
                    # not 'after', so case as specified is used
 
809
                    dest_tail = spec_tail
 
810
            else:
 
811
                # Use the existing item so 'mv' fails with AlreadyVersioned.
 
812
                dest_tail = os.path.basename(canon_dest)
 
813
            dest = osutils.pathjoin(dest_parent, dest_tail)
 
814
            mutter("attempting to move %s => %s", src, dest)
 
815
            tree.rename_one(src, dest, after=after)
 
816
            self.outf.write("%s => %s\n" % (src, dest))
 
817
 
 
818
 
 
819
class cmd_pull(Command):
 
820
    """Turn this branch into a mirror of another branch.
 
821
 
 
822
    This command only works on branches that have not diverged.  Branches are
 
823
    considered diverged if the destination branch's most recent commit is one
 
824
    that has not been merged (directly or indirectly) into the parent.
 
825
 
 
826
    If branches have diverged, you can use 'bzr merge' to integrate the changes
 
827
    from one into the other.  Once one branch has merged, the other should
 
828
    be able to pull it again.
 
829
 
 
830
    If you want to forget your local changes and just update your branch to
 
831
    match the remote one, use pull --overwrite.
 
832
 
 
833
    If there is no default location set, the first pull will set it.  After
 
834
    that, you can omit the location to use the default.  To change the
 
835
    default, use --remember. The value will only be saved if the remote
 
836
    location can be accessed.
 
837
 
 
838
    Note: The location can be specified either in the form of a branch,
 
839
    or in the form of a path to a file containing a merge directive generated
 
840
    with bzr send.
 
841
    """
 
842
 
 
843
    _see_also = ['push', 'update', 'status-flags', 'send']
 
844
    takes_options = ['remember', 'overwrite', 'revision',
 
845
        custom_help('verbose',
 
846
            help='Show logs of pulled revisions.'),
 
847
        Option('directory',
 
848
            help='Branch to pull into, '
 
849
                 'rather than the one containing the working directory.',
 
850
            short_name='d',
 
851
            type=unicode,
 
852
            ),
 
853
        ]
 
854
    takes_args = ['location?']
 
855
    encoding_type = 'replace'
 
856
 
 
857
    def run(self, location=None, remember=False, overwrite=False,
 
858
            revision=None, verbose=False,
 
859
            directory=None):
 
860
        # FIXME: too much stuff is in the command class
 
861
        revision_id = None
 
862
        mergeable = None
 
863
        if directory is None:
 
864
            directory = u'.'
 
865
        try:
 
866
            tree_to = WorkingTree.open_containing(directory)[0]
 
867
            branch_to = tree_to.branch
 
868
        except errors.NoWorkingTree:
 
869
            tree_to = None
 
870
            branch_to = Branch.open_containing(directory)[0]
 
871
 
 
872
        possible_transports = []
 
873
        if location is not None:
 
874
            try:
 
875
                mergeable = bundle.read_mergeable_from_url(location,
 
876
                    possible_transports=possible_transports)
 
877
            except errors.NotABundle:
 
878
                mergeable = None
 
879
 
 
880
        stored_loc = branch_to.get_parent()
 
881
        if location is None:
 
882
            if stored_loc is None:
 
883
                raise errors.BzrCommandError("No pull location known or"
 
884
                                             " specified.")
 
885
            else:
 
886
                display_url = urlutils.unescape_for_display(stored_loc,
 
887
                        self.outf.encoding)
 
888
                if not is_quiet():
 
889
                    self.outf.write("Using saved parent location: %s\n" % display_url)
 
890
                location = stored_loc
 
891
 
 
892
        revision = _get_one_revision('pull', revision)
 
893
        if mergeable is not None:
 
894
            if revision is not None:
 
895
                raise errors.BzrCommandError(
 
896
                    'Cannot use -r with merge directives or bundles')
 
897
            mergeable.install_revisions(branch_to.repository)
 
898
            base_revision_id, revision_id, verified = \
 
899
                mergeable.get_merge_request(branch_to.repository)
 
900
            branch_from = branch_to
 
901
        else:
 
902
            branch_from = Branch.open(location,
 
903
                possible_transports=possible_transports)
 
904
 
 
905
            if branch_to.get_parent() is None or remember:
 
906
                branch_to.set_parent(branch_from.base)
 
907
 
 
908
        if revision is not None:
 
909
            revision_id = revision.as_revision_id(branch_from)
 
910
 
 
911
        branch_to.lock_write()
 
912
        try:
 
913
            if tree_to is not None:
 
914
                view_info = _get_view_info_for_change_reporter(tree_to)
 
915
                change_reporter = delta._ChangeReporter(
 
916
                    unversioned_filter=tree_to.is_ignored, view_info=view_info)
 
917
                result = tree_to.pull(branch_from, overwrite, revision_id,
 
918
                                      change_reporter,
 
919
                                      possible_transports=possible_transports)
 
920
            else:
 
921
                result = branch_to.pull(branch_from, overwrite, revision_id)
 
922
 
 
923
            result.report(self.outf)
 
924
            if verbose and result.old_revid != result.new_revid:
 
925
                log.show_branch_change(branch_to, self.outf, result.old_revno,
 
926
                                       result.old_revid)
 
927
        finally:
 
928
            branch_to.unlock()
 
929
 
 
930
 
 
931
class cmd_push(Command):
 
932
    """Update a mirror of this branch.
 
933
 
 
934
    The target branch will not have its working tree populated because this
 
935
    is both expensive, and is not supported on remote file systems.
 
936
 
 
937
    Some smart servers or protocols *may* put the working tree in place in
 
938
    the future.
 
939
 
 
940
    This command only works on branches that have not diverged.  Branches are
 
941
    considered diverged if the destination branch's most recent commit is one
 
942
    that has not been merged (directly or indirectly) by the source branch.
 
943
 
 
944
    If branches have diverged, you can use 'bzr push --overwrite' to replace
 
945
    the other branch completely, discarding its unmerged changes.
 
946
 
 
947
    If you want to ensure you have the different changes in the other branch,
 
948
    do a merge (see bzr help merge) from the other branch, and commit that.
 
949
    After that you will be able to do a push without '--overwrite'.
 
950
 
 
951
    If there is no default push location set, the first push will set it.
 
952
    After that, you can omit the location to use the default.  To change the
 
953
    default, use --remember. The value will only be saved if the remote
 
954
    location can be accessed.
 
955
    """
 
956
 
 
957
    _see_also = ['pull', 'update', 'working-trees']
 
958
    takes_options = ['remember', 'overwrite', 'verbose', 'revision',
 
959
        Option('create-prefix',
 
960
               help='Create the path leading up to the branch '
 
961
                    'if it does not already exist.'),
 
962
        Option('directory',
 
963
            help='Branch to push from, '
 
964
                 'rather than the one containing the working directory.',
 
965
            short_name='d',
 
966
            type=unicode,
 
967
            ),
 
968
        Option('use-existing-dir',
 
969
               help='By default push will fail if the target'
 
970
                    ' directory exists, but does not already'
 
971
                    ' have a control directory.  This flag will'
 
972
                    ' allow push to proceed.'),
 
973
        Option('stacked',
 
974
            help='Create a stacked branch that references the public location '
 
975
                'of the parent branch.'),
 
976
        Option('stacked-on',
 
977
            help='Create a stacked branch that refers to another branch '
 
978
                'for the commit history. Only the work not present in the '
 
979
                'referenced branch is included in the branch created.',
 
980
            type=unicode),
 
981
        ]
 
982
    takes_args = ['location?']
 
983
    encoding_type = 'replace'
 
984
 
 
985
    def run(self, location=None, remember=False, overwrite=False,
 
986
        create_prefix=False, verbose=False, revision=None,
 
987
        use_existing_dir=False, directory=None, stacked_on=None,
 
988
        stacked=False):
 
989
        from bzrlib.push import _show_push_branch
 
990
 
 
991
        # Get the source branch and revision_id
 
992
        if directory is None:
 
993
            directory = '.'
 
994
        br_from = Branch.open_containing(directory)[0]
 
995
        revision = _get_one_revision('push', revision)
 
996
        if revision is not None:
 
997
            revision_id = revision.in_history(br_from).rev_id
 
998
        else:
 
999
            revision_id = br_from.last_revision()
 
1000
 
 
1001
        # Get the stacked_on branch, if any
 
1002
        if stacked_on is not None:
 
1003
            stacked_on = urlutils.normalize_url(stacked_on)
 
1004
        elif stacked:
 
1005
            parent_url = br_from.get_parent()
 
1006
            if parent_url:
 
1007
                parent = Branch.open(parent_url)
 
1008
                stacked_on = parent.get_public_branch()
 
1009
                if not stacked_on:
 
1010
                    # I considered excluding non-http url's here, thus forcing
 
1011
                    # 'public' branches only, but that only works for some
 
1012
                    # users, so it's best to just depend on the user spotting an
 
1013
                    # error by the feedback given to them. RBC 20080227.
 
1014
                    stacked_on = parent_url
 
1015
            if not stacked_on:
 
1016
                raise errors.BzrCommandError(
 
1017
                    "Could not determine branch to refer to.")
 
1018
 
 
1019
        # Get the destination location
 
1020
        if location is None:
 
1021
            stored_loc = br_from.get_push_location()
 
1022
            if stored_loc is None:
 
1023
                raise errors.BzrCommandError(
 
1024
                    "No push location known or specified.")
 
1025
            else:
 
1026
                display_url = urlutils.unescape_for_display(stored_loc,
 
1027
                        self.outf.encoding)
 
1028
                self.outf.write("Using saved push location: %s\n" % display_url)
 
1029
                location = stored_loc
 
1030
 
 
1031
        _show_push_branch(br_from, revision_id, location, self.outf,
 
1032
            verbose=verbose, overwrite=overwrite, remember=remember,
 
1033
            stacked_on=stacked_on, create_prefix=create_prefix,
 
1034
            use_existing_dir=use_existing_dir)
 
1035
 
 
1036
 
 
1037
class cmd_branch(Command):
 
1038
    """Create a new copy of a branch.
 
1039
 
 
1040
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
 
1041
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
 
1042
    If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
 
1043
    is derived from the FROM_LOCATION by stripping a leading scheme or drive
 
1044
    identifier, if any. For example, "branch lp:foo-bar" will attempt to
 
1045
    create ./foo-bar.
 
1046
 
 
1047
    To retrieve the branch as of a particular revision, supply the --revision
 
1048
    parameter, as in "branch foo/bar -r 5".
 
1049
    """
 
1050
 
 
1051
    _see_also = ['checkout']
 
1052
    takes_args = ['from_location', 'to_location?']
 
1053
    takes_options = ['revision', Option('hardlink',
 
1054
        help='Hard-link working tree files where possible.'),
 
1055
        Option('no-tree',
 
1056
            help="Create a branch without a working-tree."),
 
1057
        Option('stacked',
 
1058
            help='Create a stacked branch referring to the source branch. '
 
1059
                'The new branch will depend on the availability of the source '
 
1060
                'branch for all operations.'),
 
1061
        Option('standalone',
 
1062
               help='Do not use a shared repository, even if available.'),
 
1063
        ]
 
1064
    aliases = ['get', 'clone']
 
1065
 
 
1066
    def run(self, from_location, to_location=None, revision=None,
 
1067
            hardlink=False, stacked=False, standalone=False, no_tree=False):
 
1068
        from bzrlib.tag import _merge_tags_if_possible
 
1069
 
 
1070
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
 
1071
            from_location)
 
1072
        revision = _get_one_revision('branch', revision)
 
1073
        br_from.lock_read()
 
1074
        try:
 
1075
            if revision is not None:
 
1076
                revision_id = revision.as_revision_id(br_from)
 
1077
            else:
 
1078
                # FIXME - wt.last_revision, fallback to branch, fall back to
 
1079
                # None or perhaps NULL_REVISION to mean copy nothing
 
1080
                # RBC 20060209
 
1081
                revision_id = br_from.last_revision()
 
1082
            if to_location is None:
 
1083
                to_location = urlutils.derive_to_location(from_location)
 
1084
            to_transport = transport.get_transport(to_location)
 
1085
            try:
 
1086
                to_transport.mkdir('.')
 
1087
            except errors.FileExists:
 
1088
                raise errors.BzrCommandError('Target directory "%s" already'
 
1089
                                             ' exists.' % to_location)
 
1090
            except errors.NoSuchFile:
 
1091
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
 
1092
                                             % to_location)
 
1093
            try:
 
1094
                # preserve whatever source format we have.
 
1095
                dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
 
1096
                                            possible_transports=[to_transport],
 
1097
                                            accelerator_tree=accelerator_tree,
 
1098
                                            hardlink=hardlink, stacked=stacked,
 
1099
                                            force_new_repo=standalone,
 
1100
                                            create_tree_if_local=not no_tree,
 
1101
                                            source_branch=br_from)
 
1102
                branch = dir.open_branch()
 
1103
            except errors.NoSuchRevision:
 
1104
                to_transport.delete_tree('.')
 
1105
                msg = "The branch %s has no revision %s." % (from_location,
 
1106
                    revision)
 
1107
                raise errors.BzrCommandError(msg)
 
1108
            _merge_tags_if_possible(br_from, branch)
 
1109
            # If the source branch is stacked, the new branch may
 
1110
            # be stacked whether we asked for that explicitly or not.
 
1111
            # We therefore need a try/except here and not just 'if stacked:'
 
1112
            try:
 
1113
                note('Created new stacked branch referring to %s.' %
 
1114
                    branch.get_stacked_on_url())
 
1115
            except (errors.NotStacked, errors.UnstackableBranchFormat,
 
1116
                errors.UnstackableRepositoryFormat), e:
 
1117
                note('Branched %d revision(s).' % branch.revno())
 
1118
        finally:
 
1119
            br_from.unlock()
 
1120
 
 
1121
 
 
1122
class cmd_checkout(Command):
 
1123
    """Create a new checkout of an existing branch.
 
1124
 
 
1125
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
 
1126
    the branch found in '.'. This is useful if you have removed the working tree
 
1127
    or if it was never created - i.e. if you pushed the branch to its current
 
1128
    location using SFTP.
 
1129
 
 
1130
    If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
 
1131
    be used.  In other words, "checkout ../foo/bar" will attempt to create ./bar.
 
1132
    If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
 
1133
    is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
 
1134
    identifier, if any. For example, "checkout lp:foo-bar" will attempt to
 
1135
    create ./foo-bar.
 
1136
 
 
1137
    To retrieve the branch as of a particular revision, supply the --revision
 
1138
    parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
 
1139
    out of date [so you cannot commit] but it may be useful (i.e. to examine old
 
1140
    code.)
 
1141
    """
 
1142
 
 
1143
    _see_also = ['checkouts', 'branch']
 
1144
    takes_args = ['branch_location?', 'to_location?']
 
1145
    takes_options = ['revision',
 
1146
                     Option('lightweight',
 
1147
                            help="Perform a lightweight checkout.  Lightweight "
 
1148
                                 "checkouts depend on access to the branch for "
 
1149
                                 "every operation.  Normal checkouts can perform "
 
1150
                                 "common operations like diff and status without "
 
1151
                                 "such access, and also support local commits."
 
1152
                            ),
 
1153
                     Option('files-from', type=str,
 
1154
                            help="Get file contents from this tree."),
 
1155
                     Option('hardlink',
 
1156
                            help='Hard-link working tree files where possible.'
 
1157
                            ),
 
1158
                     ]
 
1159
    aliases = ['co']
 
1160
 
 
1161
    def run(self, branch_location=None, to_location=None, revision=None,
 
1162
            lightweight=False, files_from=None, hardlink=False):
 
1163
        if branch_location is None:
 
1164
            branch_location = osutils.getcwd()
 
1165
            to_location = branch_location
 
1166
        accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
 
1167
            branch_location)
 
1168
        revision = _get_one_revision('checkout', revision)
 
1169
        if files_from is not None:
 
1170
            accelerator_tree = WorkingTree.open(files_from)
 
1171
        if revision is not None:
 
1172
            revision_id = revision.as_revision_id(source)
 
1173
        else:
 
1174
            revision_id = None
 
1175
        if to_location is None:
 
1176
            to_location = urlutils.derive_to_location(branch_location)
 
1177
        # if the source and to_location are the same,
 
1178
        # and there is no working tree,
 
1179
        # then reconstitute a branch
 
1180
        if (osutils.abspath(to_location) ==
 
1181
            osutils.abspath(branch_location)):
 
1182
            try:
 
1183
                source.bzrdir.open_workingtree()
 
1184
            except errors.NoWorkingTree:
 
1185
                source.bzrdir.create_workingtree(revision_id)
 
1186
                return
 
1187
        source.create_checkout(to_location, revision_id, lightweight,
 
1188
                               accelerator_tree, hardlink)
 
1189
 
 
1190
 
 
1191
class cmd_renames(Command):
 
1192
    """Show list of renamed files.
 
1193
    """
 
1194
    # TODO: Option to show renames between two historical versions.
 
1195
 
 
1196
    # TODO: Only show renames under dir, rather than in the whole branch.
 
1197
    _see_also = ['status']
 
1198
    takes_args = ['dir?']
 
1199
 
 
1200
    @display_command
 
1201
    def run(self, dir=u'.'):
 
1202
        tree = WorkingTree.open_containing(dir)[0]
 
1203
        tree.lock_read()
 
1204
        try:
 
1205
            new_inv = tree.inventory
 
1206
            old_tree = tree.basis_tree()
 
1207
            old_tree.lock_read()
 
1208
            try:
 
1209
                old_inv = old_tree.inventory
 
1210
                renames = []
 
1211
                iterator = tree.iter_changes(old_tree, include_unchanged=True)
 
1212
                for f, paths, c, v, p, n, k, e in iterator:
 
1213
                    if paths[0] == paths[1]:
 
1214
                        continue
 
1215
                    if None in (paths):
 
1216
                        continue
 
1217
                    renames.append(paths)
 
1218
                renames.sort()
 
1219
                for old_name, new_name in renames:
 
1220
                    self.outf.write("%s => %s\n" % (old_name, new_name))
 
1221
            finally:
 
1222
                old_tree.unlock()
 
1223
        finally:
 
1224
            tree.unlock()
 
1225
 
 
1226
 
 
1227
class cmd_update(Command):
 
1228
    """Update a tree to have the latest code committed to its branch.
 
1229
 
 
1230
    This will perform a merge into the working tree, and may generate
 
1231
    conflicts. If you have any local changes, you will still
 
1232
    need to commit them after the update for the update to be complete.
 
1233
 
 
1234
    If you want to discard your local changes, you can just do a
 
1235
    'bzr revert' instead of 'bzr commit' after the update.
 
1236
    """
 
1237
 
 
1238
    _see_also = ['pull', 'working-trees', 'status-flags']
 
1239
    takes_args = ['dir?']
 
1240
    aliases = ['up']
 
1241
 
 
1242
    def run(self, dir='.'):
 
1243
        tree = WorkingTree.open_containing(dir)[0]
 
1244
        possible_transports = []
 
1245
        master = tree.branch.get_master_branch(
 
1246
            possible_transports=possible_transports)
 
1247
        if master is not None:
 
1248
            tree.lock_write()
 
1249
        else:
 
1250
            tree.lock_tree_write()
 
1251
        try:
 
1252
            existing_pending_merges = tree.get_parent_ids()[1:]
 
1253
            last_rev = _mod_revision.ensure_null(tree.last_revision())
 
1254
            if last_rev == _mod_revision.ensure_null(
 
1255
                tree.branch.last_revision()):
 
1256
                # may be up to date, check master too.
 
1257
                if master is None or last_rev == _mod_revision.ensure_null(
 
1258
                    master.last_revision()):
 
1259
                    revno = tree.branch.revision_id_to_revno(last_rev)
 
1260
                    note("Tree is up to date at revision %d." % (revno,))
 
1261
                    return 0
 
1262
            view_info = _get_view_info_for_change_reporter(tree)
 
1263
            conflicts = tree.update(
 
1264
                delta._ChangeReporter(unversioned_filter=tree.is_ignored,
 
1265
                view_info=view_info), possible_transports=possible_transports)
 
1266
            revno = tree.branch.revision_id_to_revno(
 
1267
                _mod_revision.ensure_null(tree.last_revision()))
 
1268
            note('Updated to revision %d.' % (revno,))
 
1269
            if tree.get_parent_ids()[1:] != existing_pending_merges:
 
1270
                note('Your local commits will now show as pending merges with '
 
1271
                     "'bzr status', and can be committed with 'bzr commit'.")
 
1272
            if conflicts != 0:
 
1273
                return 1
 
1274
            else:
 
1275
                return 0
 
1276
        finally:
 
1277
            tree.unlock()
 
1278
 
 
1279
 
 
1280
class cmd_info(Command):
 
1281
    """Show information about a working tree, branch or repository.
 
1282
 
 
1283
    This command will show all known locations and formats associated to the
 
1284
    tree, branch or repository.
 
1285
 
 
1286
    In verbose mode, statistical information is included with each report.
 
1287
    To see extended statistic information, use a verbosity level of 2 or
 
1288
    higher by specifying the verbose option multiple times, e.g. -vv.
 
1289
 
 
1290
    Branches and working trees will also report any missing revisions.
 
1291
 
 
1292
    :Examples:
 
1293
 
 
1294
      Display information on the format and related locations:
 
1295
 
 
1296
        bzr info
 
1297
 
 
1298
      Display the above together with extended format information and
 
1299
      basic statistics (like the number of files in the working tree and
 
1300
      number of revisions in the branch and repository):
 
1301
 
 
1302
        bzr -v info
 
1303
 
 
1304
      Display the above together with number of committers to the branch:
 
1305
 
 
1306
        bzr -vv info
 
1307
    """
 
1308
    _see_also = ['revno', 'working-trees', 'repositories']
 
1309
    takes_args = ['location?']
 
1310
    takes_options = ['verbose']
 
1311
    encoding_type = 'replace'
 
1312
 
 
1313
    @display_command
 
1314
    def run(self, location=None, verbose=False):
 
1315
        if verbose:
 
1316
            noise_level = get_verbosity_level()
 
1317
        else:
 
1318
            noise_level = 0
 
1319
        from bzrlib.info import show_bzrdir_info
 
1320
        show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
 
1321
                         verbose=noise_level, outfile=self.outf)
 
1322
 
 
1323
 
 
1324
class cmd_remove(Command):
 
1325
    """Remove files or directories.
 
1326
 
 
1327
    This makes bzr stop tracking changes to the specified files. bzr will delete
 
1328
    them if they can easily be recovered using revert. If no options or
 
1329
    parameters are given bzr will scan for files that are being tracked by bzr
 
1330
    but missing in your tree and stop tracking them for you.
 
1331
    """
 
1332
    takes_args = ['file*']
 
1333
    takes_options = ['verbose',
 
1334
        Option('new', help='Only remove files that have never been committed.'),
 
1335
        RegistryOption.from_kwargs('file-deletion-strategy',
 
1336
            'The file deletion mode to be used.',
 
1337
            title='Deletion Strategy', value_switches=True, enum_switch=False,
 
1338
            safe='Only delete files if they can be'
 
1339
                 ' safely recovered (default).',
 
1340
            keep="Don't delete any files.",
 
1341
            force='Delete all the specified files, even if they can not be '
 
1342
                'recovered and even if they are non-empty directories.')]
 
1343
    aliases = ['rm', 'del']
 
1344
    encoding_type = 'replace'
 
1345
 
 
1346
    def run(self, file_list, verbose=False, new=False,
 
1347
        file_deletion_strategy='safe'):
 
1348
        tree, file_list = tree_files(file_list)
 
1349
 
 
1350
        if file_list is not None:
 
1351
            file_list = [f for f in file_list]
 
1352
 
 
1353
        tree.lock_write()
 
1354
        try:
 
1355
            # Heuristics should probably all move into tree.remove_smart or
 
1356
            # some such?
 
1357
            if new:
 
1358
                added = tree.changes_from(tree.basis_tree(),
 
1359
                    specific_files=file_list).added
 
1360
                file_list = sorted([f[0] for f in added], reverse=True)
 
1361
                if len(file_list) == 0:
 
1362
                    raise errors.BzrCommandError('No matching files.')
 
1363
            elif file_list is None:
 
1364
                # missing files show up in iter_changes(basis) as
 
1365
                # versioned-with-no-kind.
 
1366
                missing = []
 
1367
                for change in tree.iter_changes(tree.basis_tree()):
 
1368
                    # Find paths in the working tree that have no kind:
 
1369
                    if change[1][1] is not None and change[6][1] is None:
 
1370
                        missing.append(change[1][1])
 
1371
                file_list = sorted(missing, reverse=True)
 
1372
                file_deletion_strategy = 'keep'
 
1373
            tree.remove(file_list, verbose=verbose, to_file=self.outf,
 
1374
                keep_files=file_deletion_strategy=='keep',
 
1375
                force=file_deletion_strategy=='force')
 
1376
        finally:
 
1377
            tree.unlock()
 
1378
 
 
1379
 
 
1380
class cmd_file_id(Command):
 
1381
    """Print file_id of a particular file or directory.
 
1382
 
 
1383
    The file_id is assigned when the file is first added and remains the
 
1384
    same through all revisions where the file exists, even when it is
 
1385
    moved or renamed.
 
1386
    """
 
1387
 
 
1388
    hidden = True
 
1389
    _see_also = ['inventory', 'ls']
 
1390
    takes_args = ['filename']
 
1391
 
 
1392
    @display_command
 
1393
    def run(self, filename):
 
1394
        tree, relpath = WorkingTree.open_containing(filename)
 
1395
        i = tree.path2id(relpath)
 
1396
        if i is None:
 
1397
            raise errors.NotVersionedError(filename)
 
1398
        else:
 
1399
            self.outf.write(i + '\n')
 
1400
 
 
1401
 
 
1402
class cmd_file_path(Command):
 
1403
    """Print path of file_ids to a file or directory.
 
1404
 
 
1405
    This prints one line for each directory down to the target,
 
1406
    starting at the branch root.
 
1407
    """
 
1408
 
 
1409
    hidden = True
 
1410
    takes_args = ['filename']
 
1411
 
 
1412
    @display_command
 
1413
    def run(self, filename):
 
1414
        tree, relpath = WorkingTree.open_containing(filename)
 
1415
        fid = tree.path2id(relpath)
 
1416
        if fid is None:
 
1417
            raise errors.NotVersionedError(filename)
 
1418
        segments = osutils.splitpath(relpath)
 
1419
        for pos in range(1, len(segments) + 1):
 
1420
            path = osutils.joinpath(segments[:pos])
 
1421
            self.outf.write("%s\n" % tree.path2id(path))
 
1422
 
 
1423
 
 
1424
class cmd_reconcile(Command):
 
1425
    """Reconcile bzr metadata in a branch.
 
1426
 
 
1427
    This can correct data mismatches that may have been caused by
 
1428
    previous ghost operations or bzr upgrades. You should only
 
1429
    need to run this command if 'bzr check' or a bzr developer
 
1430
    advises you to run it.
 
1431
 
 
1432
    If a second branch is provided, cross-branch reconciliation is
 
1433
    also attempted, which will check that data like the tree root
 
1434
    id which was not present in very early bzr versions is represented
 
1435
    correctly in both branches.
 
1436
 
 
1437
    At the same time it is run it may recompress data resulting in
 
1438
    a potential saving in disk space or performance gain.
 
1439
 
 
1440
    The branch *MUST* be on a listable system such as local disk or sftp.
 
1441
    """
 
1442
 
 
1443
    _see_also = ['check']
 
1444
    takes_args = ['branch?']
 
1445
 
 
1446
    def run(self, branch="."):
 
1447
        from bzrlib.reconcile import reconcile
 
1448
        dir = bzrdir.BzrDir.open(branch)
 
1449
        reconcile(dir)
 
1450
 
 
1451
 
 
1452
class cmd_revision_history(Command):
 
1453
    """Display the list of revision ids on a branch."""
 
1454
 
 
1455
    _see_also = ['log']
 
1456
    takes_args = ['location?']
 
1457
 
 
1458
    hidden = True
 
1459
 
 
1460
    @display_command
 
1461
    def run(self, location="."):
 
1462
        branch = Branch.open_containing(location)[0]
 
1463
        for revid in branch.revision_history():
 
1464
            self.outf.write(revid)
 
1465
            self.outf.write('\n')
 
1466
 
 
1467
 
 
1468
class cmd_ancestry(Command):
 
1469
    """List all revisions merged into this branch."""
 
1470
 
 
1471
    _see_also = ['log', 'revision-history']
 
1472
    takes_args = ['location?']
 
1473
 
 
1474
    hidden = True
 
1475
 
 
1476
    @display_command
 
1477
    def run(self, location="."):
 
1478
        try:
 
1479
            wt = WorkingTree.open_containing(location)[0]
 
1480
        except errors.NoWorkingTree:
 
1481
            b = Branch.open(location)
 
1482
            last_revision = b.last_revision()
 
1483
        else:
 
1484
            b = wt.branch
 
1485
            last_revision = wt.last_revision()
 
1486
 
 
1487
        revision_ids = b.repository.get_ancestry(last_revision)
 
1488
        revision_ids.pop(0)
 
1489
        for revision_id in revision_ids:
 
1490
            self.outf.write(revision_id + '\n')
 
1491
 
 
1492
 
 
1493
class cmd_init(Command):
 
1494
    """Make a directory into a versioned branch.
 
1495
 
 
1496
    Use this to create an empty branch, or before importing an
 
1497
    existing project.
 
1498
 
 
1499
    If there is a repository in a parent directory of the location, then
 
1500
    the history of the branch will be stored in the repository.  Otherwise
 
1501
    init creates a standalone branch which carries its own history
 
1502
    in the .bzr directory.
 
1503
 
 
1504
    If there is already a branch at the location but it has no working tree,
 
1505
    the tree can be populated with 'bzr checkout'.
 
1506
 
 
1507
    Recipe for importing a tree of files::
 
1508
 
 
1509
        cd ~/project
 
1510
        bzr init
 
1511
        bzr add .
 
1512
        bzr status
 
1513
        bzr commit -m "imported project"
 
1514
    """
 
1515
 
 
1516
    _see_also = ['init-repository', 'branch', 'checkout']
 
1517
    takes_args = ['location?']
 
1518
    takes_options = [
 
1519
        Option('create-prefix',
 
1520
               help='Create the path leading up to the branch '
 
1521
                    'if it does not already exist.'),
 
1522
         RegistryOption('format',
 
1523
                help='Specify a format for this branch. '
 
1524
                'See "help formats".',
 
1525
                lazy_registry=('bzrlib.bzrdir', 'format_registry'),
 
1526
                converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
 
1527
                value_switches=True,
 
1528
                title="Branch Format",
 
1529
                ),
 
1530
         Option('append-revisions-only',
 
1531
                help='Never change revnos or the existing log.'
 
1532
                '  Append revisions to it only.')
 
1533
         ]
 
1534
    def run(self, location=None, format=None, append_revisions_only=False,
 
1535
            create_prefix=False):
 
1536
        if format is None:
 
1537
            format = bzrdir.format_registry.make_bzrdir('default')
 
1538
        if location is None:
 
1539
            location = u'.'
 
1540
 
 
1541
        to_transport = transport.get_transport(location)
 
1542
 
 
1543
        # The path has to exist to initialize a
 
1544
        # branch inside of it.
 
1545
        # Just using os.mkdir, since I don't
 
1546
        # believe that we want to create a bunch of
 
1547
        # locations if the user supplies an extended path
 
1548
        try:
 
1549
            to_transport.ensure_base()
 
1550
        except errors.NoSuchFile:
 
1551
            if not create_prefix:
 
1552
                raise errors.BzrCommandError("Parent directory of %s"
 
1553
                    " does not exist."
 
1554
                    "\nYou may supply --create-prefix to create all"
 
1555
                    " leading parent directories."
 
1556
                    % location)
 
1557
            _create_prefix(to_transport)
 
1558
 
 
1559
        try:
 
1560
            a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
 
1561
        except errors.NotBranchError:
 
1562
            # really a NotBzrDir error...
 
1563
            create_branch = bzrdir.BzrDir.create_branch_convenience
 
1564
            branch = create_branch(to_transport.base, format=format,
 
1565
                                   possible_transports=[to_transport])
 
1566
            a_bzrdir = branch.bzrdir
 
1567
        else:
 
1568
            from bzrlib.transport.local import LocalTransport
 
1569
            if a_bzrdir.has_branch():
 
1570
                if (isinstance(to_transport, LocalTransport)
 
1571
                    and not a_bzrdir.has_workingtree()):
 
1572
                        raise errors.BranchExistsWithoutWorkingTree(location)
 
1573
                raise errors.AlreadyBranchError(location)
 
1574
            branch = a_bzrdir.create_branch()
 
1575
            a_bzrdir.create_workingtree()
 
1576
        if append_revisions_only:
 
1577
            try:
 
1578
                branch.set_append_revisions_only(True)
 
1579
            except errors.UpgradeRequired:
 
1580
                raise errors.BzrCommandError('This branch format cannot be set'
 
1581
                    ' to append-revisions-only.  Try --experimental-branch6')
 
1582
        if not is_quiet():
 
1583
            from bzrlib.info import describe_layout, describe_format
 
1584
            try:
 
1585
                tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
 
1586
            except (errors.NoWorkingTree, errors.NotLocalUrl):
 
1587
                tree = None
 
1588
            repository = branch.repository
 
1589
            layout = describe_layout(repository, branch, tree).lower()
 
1590
            format = describe_format(a_bzrdir, repository, branch, tree)
 
1591
            self.outf.write("Created a %s (format: %s)\n" % (layout, format))
 
1592
            if repository.is_shared():
 
1593
                #XXX: maybe this can be refactored into transport.path_or_url()
 
1594
                url = repository.bzrdir.root_transport.external_url()
 
1595
                try:
 
1596
                    url = urlutils.local_path_from_url(url)
 
1597
                except errors.InvalidURL:
 
1598
                    pass
 
1599
                self.outf.write("Using shared repository: %s\n" % url)
 
1600
 
 
1601
 
 
1602
class cmd_init_repository(Command):
 
1603
    """Create a shared repository to hold branches.
 
1604
 
 
1605
    New branches created under the repository directory will store their
 
1606
    revisions in the repository, not in the branch directory.
 
1607
 
 
1608
    If the --no-trees option is used then the branches in the repository
 
1609
    will not have working trees by default.
 
1610
 
 
1611
    :Examples:
 
1612
        Create a shared repositories holding just branches::
 
1613
 
 
1614
            bzr init-repo --no-trees repo
 
1615
            bzr init repo/trunk
 
1616
 
 
1617
        Make a lightweight checkout elsewhere::
 
1618
 
 
1619
            bzr checkout --lightweight repo/trunk trunk-checkout
 
1620
            cd trunk-checkout
 
1621
            (add files here)
 
1622
    """
 
1623
 
 
1624
    _see_also = ['init', 'branch', 'checkout', 'repositories']
 
1625
    takes_args = ["location"]
 
1626
    takes_options = [RegistryOption('format',
 
1627
                            help='Specify a format for this repository. See'
 
1628
                                 ' "bzr help formats" for details.',
 
1629
                            lazy_registry=('bzrlib.bzrdir', 'format_registry'),
 
1630
                            converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
 
1631
                            value_switches=True, title='Repository format'),
 
1632
                     Option('no-trees',
 
1633
                             help='Branches in the repository will default to'
 
1634
                                  ' not having a working tree.'),
 
1635
                    ]
 
1636
    aliases = ["init-repo"]
 
1637
 
 
1638
    def run(self, location, format=None, no_trees=False):
 
1639
        if format is None:
 
1640
            format = bzrdir.format_registry.make_bzrdir('default')
 
1641
 
 
1642
        if location is None:
 
1643
            location = '.'
 
1644
 
 
1645
        to_transport = transport.get_transport(location)
 
1646
        to_transport.ensure_base()
 
1647
 
 
1648
        newdir = format.initialize_on_transport(to_transport)
 
1649
        repo = newdir.create_repository(shared=True)
 
1650
        repo.set_make_working_trees(not no_trees)
 
1651
        if not is_quiet():
 
1652
            from bzrlib.info import show_bzrdir_info
 
1653
            show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
 
1654
 
 
1655
 
 
1656
class cmd_diff(Command):
 
1657
    """Show differences in the working tree, between revisions or branches.
 
1658
 
 
1659
    If no arguments are given, all changes for the current tree are listed.
 
1660
    If files are given, only the changes in those files are listed.
 
1661
    Remote and multiple branches can be compared by using the --old and
 
1662
    --new options. If not provided, the default for both is derived from
 
1663
    the first argument, if any, or the current tree if no arguments are
 
1664
    given.
 
1665
 
 
1666
    "bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
 
1667
    produces patches suitable for "patch -p1".
 
1668
 
 
1669
    :Exit values:
 
1670
        1 - changed
 
1671
        2 - unrepresentable changes
 
1672
        3 - error
 
1673
        0 - no change
 
1674
 
 
1675
    :Examples:
 
1676
        Shows the difference in the working tree versus the last commit::
 
1677
 
 
1678
            bzr diff
 
1679
 
 
1680
        Difference between the working tree and revision 1::
 
1681
 
 
1682
            bzr diff -r1
 
1683
 
 
1684
        Difference between revision 2 and revision 1::
 
1685
 
 
1686
            bzr diff -r1..2
 
1687
 
 
1688
        Difference between revision 2 and revision 1 for branch xxx::
 
1689
 
 
1690
            bzr diff -r1..2 xxx
 
1691
 
 
1692
        Show just the differences for file NEWS::
 
1693
 
 
1694
            bzr diff NEWS
 
1695
 
 
1696
        Show the differences in working tree xxx for file NEWS::
 
1697
 
 
1698
            bzr diff xxx/NEWS
 
1699
 
 
1700
        Show the differences from branch xxx to this working tree:
 
1701
 
 
1702
            bzr diff --old xxx
 
1703
 
 
1704
        Show the differences between two branches for file NEWS::
 
1705
 
 
1706
            bzr diff --old xxx --new yyy NEWS
 
1707
 
 
1708
        Same as 'bzr diff' but prefix paths with old/ and new/::
 
1709
 
 
1710
            bzr diff --prefix old/:new/
 
1711
    """
 
1712
    _see_also = ['status']
 
1713
    takes_args = ['file*']
 
1714
    takes_options = [
 
1715
        Option('diff-options', type=str,
 
1716
               help='Pass these options to the external diff program.'),
 
1717
        Option('prefix', type=str,
 
1718
               short_name='p',
 
1719
               help='Set prefixes added to old and new filenames, as '
 
1720
                    'two values separated by a colon. (eg "old/:new/").'),
 
1721
        Option('old',
 
1722
            help='Branch/tree to compare from.',
 
1723
            type=unicode,
 
1724
            ),
 
1725
        Option('new',
 
1726
            help='Branch/tree to compare to.',
 
1727
            type=unicode,
 
1728
            ),
 
1729
        'revision',
 
1730
        'change',
 
1731
        Option('using',
 
1732
            help='Use this command to compare files.',
 
1733
            type=unicode,
 
1734
            ),
 
1735
        ]
 
1736
    aliases = ['di', 'dif']
 
1737
    encoding_type = 'exact'
 
1738
 
 
1739
    @display_command
 
1740
    def run(self, revision=None, file_list=None, diff_options=None,
 
1741
            prefix=None, old=None, new=None, using=None):
 
1742
        from bzrlib.diff import _get_trees_to_diff, show_diff_trees
 
1743
 
 
1744
        if (prefix is None) or (prefix == '0'):
 
1745
            # diff -p0 format
 
1746
            old_label = ''
 
1747
            new_label = ''
 
1748
        elif prefix == '1':
 
1749
            old_label = 'old/'
 
1750
            new_label = 'new/'
 
1751
        elif ':' in prefix:
 
1752
            old_label, new_label = prefix.split(":")
 
1753
        else:
 
1754
            raise errors.BzrCommandError(
 
1755
                '--prefix expects two values separated by a colon'
 
1756
                ' (eg "old/:new/")')
 
1757
 
 
1758
        if revision and len(revision) > 2:
 
1759
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
 
1760
                                         ' one or two revision specifiers')
 
1761
 
 
1762
        old_tree, new_tree, specific_files, extra_trees = \
 
1763
                _get_trees_to_diff(file_list, revision, old, new,
 
1764
                apply_view=True)
 
1765
        return show_diff_trees(old_tree, new_tree, sys.stdout,
 
1766
                               specific_files=specific_files,
 
1767
                               external_diff_options=diff_options,
 
1768
                               old_label=old_label, new_label=new_label,
 
1769
                               extra_trees=extra_trees, using=using)
 
1770
 
 
1771
 
 
1772
class cmd_deleted(Command):
 
1773
    """List files deleted in the working tree.
 
1774
    """
 
1775
    # TODO: Show files deleted since a previous revision, or
 
1776
    # between two revisions.
 
1777
    # TODO: Much more efficient way to do this: read in new
 
1778
    # directories with readdir, rather than stating each one.  Same
 
1779
    # level of effort but possibly much less IO.  (Or possibly not,
 
1780
    # if the directories are very large...)
 
1781
    _see_also = ['status', 'ls']
 
1782
    takes_options = ['show-ids']
 
1783
 
 
1784
    @display_command
 
1785
    def run(self, show_ids=False):
 
1786
        tree = WorkingTree.open_containing(u'.')[0]
 
1787
        tree.lock_read()
 
1788
        try:
 
1789
            old = tree.basis_tree()
 
1790
            old.lock_read()
 
1791
            try:
 
1792
                for path, ie in old.inventory.iter_entries():
 
1793
                    if not tree.has_id(ie.file_id):
 
1794
                        self.outf.write(path)
 
1795
                        if show_ids:
 
1796
                            self.outf.write(' ')
 
1797
                            self.outf.write(ie.file_id)
 
1798
                        self.outf.write('\n')
 
1799
            finally:
 
1800
                old.unlock()
 
1801
        finally:
 
1802
            tree.unlock()
 
1803
 
 
1804
 
 
1805
class cmd_modified(Command):
 
1806
    """List files modified in working tree.
 
1807
    """
 
1808
 
 
1809
    hidden = True
 
1810
    _see_also = ['status', 'ls']
 
1811
    takes_options = [
 
1812
            Option('null',
 
1813
                   help='Write an ascii NUL (\\0) separator '
 
1814
                   'between files rather than a newline.')
 
1815
            ]
 
1816
 
 
1817
    @display_command
 
1818
    def run(self, null=False):
 
1819
        tree = WorkingTree.open_containing(u'.')[0]
 
1820
        td = tree.changes_from(tree.basis_tree())
 
1821
        for path, id, kind, text_modified, meta_modified in td.modified:
 
1822
            if null:
 
1823
                self.outf.write(path + '\0')
 
1824
            else:
 
1825
                self.outf.write(osutils.quotefn(path) + '\n')
 
1826
 
 
1827
 
 
1828
class cmd_added(Command):
 
1829
    """List files added in working tree.
 
1830
    """
 
1831
 
 
1832
    hidden = True
 
1833
    _see_also = ['status', 'ls']
 
1834
    takes_options = [
 
1835
            Option('null',
 
1836
                   help='Write an ascii NUL (\\0) separator '
 
1837
                   'between files rather than a newline.')
 
1838
            ]
 
1839
 
 
1840
    @display_command
 
1841
    def run(self, null=False):
 
1842
        wt = WorkingTree.open_containing(u'.')[0]
 
1843
        wt.lock_read()
 
1844
        try:
 
1845
            basis = wt.basis_tree()
 
1846
            basis.lock_read()
 
1847
            try:
 
1848
                basis_inv = basis.inventory
 
1849
                inv = wt.inventory
 
1850
                for file_id in inv:
 
1851
                    if file_id in basis_inv:
 
1852
                        continue
 
1853
                    if inv.is_root(file_id) and len(basis_inv) == 0:
 
1854
                        continue
 
1855
                    path = inv.id2path(file_id)
 
1856
                    if not os.access(osutils.abspath(path), os.F_OK):
 
1857
                        continue
 
1858
                    if null:
 
1859
                        self.outf.write(path + '\0')
 
1860
                    else:
 
1861
                        self.outf.write(osutils.quotefn(path) + '\n')
 
1862
            finally:
 
1863
                basis.unlock()
 
1864
        finally:
 
1865
            wt.unlock()
 
1866
 
 
1867
 
 
1868
class cmd_root(Command):
 
1869
    """Show the tree root directory.
 
1870
 
 
1871
    The root is the nearest enclosing directory with a .bzr control
 
1872
    directory."""
 
1873
 
 
1874
    takes_args = ['filename?']
 
1875
    @display_command
 
1876
    def run(self, filename=None):
 
1877
        """Print the branch root."""
 
1878
        tree = WorkingTree.open_containing(filename)[0]
 
1879
        self.outf.write(tree.basedir + '\n')
 
1880
 
 
1881
 
 
1882
def _parse_limit(limitstring):
 
1883
    try:
 
1884
        return int(limitstring)
 
1885
    except ValueError:
 
1886
        msg = "The limit argument must be an integer."
 
1887
        raise errors.BzrCommandError(msg)
 
1888
 
 
1889
 
 
1890
def _parse_levels(s):
 
1891
    try:
 
1892
        return int(s)
 
1893
    except ValueError:
 
1894
        msg = "The levels argument must be an integer."
 
1895
        raise errors.BzrCommandError(msg)
 
1896
 
 
1897
 
 
1898
class cmd_log(Command):
 
1899
    """Show historical log for a branch or subset of a branch.
 
1900
 
 
1901
    log is bzr's default tool for exploring the history of a branch.
 
1902
    The branch to use is taken from the first parameter. If no parameters
 
1903
    are given, the branch containing the working directory is logged.
 
1904
    Here are some simple examples::
 
1905
 
 
1906
      bzr log                       log the current branch
 
1907
      bzr log foo.py                log a file in its branch
 
1908
      bzr log http://server/branch  log a branch on a server
 
1909
 
 
1910
    The filtering, ordering and information shown for each revision can
 
1911
    be controlled as explained below. By default, all revisions are
 
1912
    shown sorted (topologically) so that newer revisions appear before
 
1913
    older ones and descendants always appear before ancestors. If displayed,
 
1914
    merged revisions are shown indented under the revision in which they
 
1915
    were merged.
 
1916
 
 
1917
    :Output control:
 
1918
 
 
1919
      The log format controls how information about each revision is
 
1920
      displayed. The standard log formats are called ``long``, ``short``
 
1921
      and ``line``. The default is long. See ``bzr help log-formats``
 
1922
      for more details on log formats.
 
1923
 
 
1924
      The following options can be used to control what information is
 
1925
      displayed::
 
1926
 
 
1927
        -l N        display a maximum of N revisions
 
1928
        -n N        display N levels of revisions (0 for all, 1 for collapsed)
 
1929
        -v          display a status summary (delta) for each revision
 
1930
        -p          display a diff (patch) for each revision
 
1931
        --show-ids  display revision-ids (and file-ids), not just revnos
 
1932
 
 
1933
      Note that the default number of levels to display is a function of the
 
1934
      log format. If the -n option is not used, ``short`` and ``line`` show
 
1935
      just the top level (mainline) while ``long`` shows all levels of merged
 
1936
      revisions.
 
1937
 
 
1938
      Status summaries are shown using status flags like A, M, etc. To see
 
1939
      the changes explained using words like ``added`` and ``modified``
 
1940
      instead, use the -vv option.
 
1941
 
 
1942
    :Ordering control:
 
1943
 
 
1944
      To display revisions from oldest to newest, use the --forward option.
 
1945
      In most cases, using this option will have little impact on the total
 
1946
      time taken to produce a log, though --forward does not incrementally
 
1947
      display revisions like --reverse does when it can.
 
1948
 
 
1949
    :Revision filtering:
 
1950
 
 
1951
      The -r option can be used to specify what revision or range of revisions
 
1952
      to filter against. The various forms are shown below::
 
1953
 
 
1954
        -rX      display revision X
 
1955
        -rX..    display revision X and later
 
1956
        -r..Y    display up to and including revision Y
 
1957
        -rX..Y   display from X to Y inclusive
 
1958
 
 
1959
      See ``bzr help revisionspec`` for details on how to specify X and Y.
 
1960
      Some common examples are given below::
 
1961
 
 
1962
        -r-1                show just the tip
 
1963
        -r-10..             show the last 10 mainline revisions
 
1964
        -rsubmit:..         show what's new on this branch
 
1965
        -rancestor:path..   show changes since the common ancestor of this
 
1966
                            branch and the one at location path
 
1967
        -rdate:yesterday..  show changes since yesterday
 
1968
 
 
1969
      When logging a range of revisions using -rX..Y, log starts at
 
1970
      revision Y and searches back in history through the primary
 
1971
      ("left-hand") parents until it finds X. When logging just the
 
1972
      top level (using -n1), an error is reported if X is not found
 
1973
      along the way. If multi-level logging is used (-n0), X may be
 
1974
      a nested merge revision and the log will be truncated accordingly.
 
1975
 
 
1976
    :Path filtering:
 
1977
 
 
1978
      If a parameter is given and it's not a branch, the log will be filtered
 
1979
      to show only those revisions that changed the nominated file or
 
1980
      directory.
 
1981
 
 
1982
      Filenames are interpreted within their historical context. To log a
 
1983
      deleted file, specify a revision range so that the file existed at
 
1984
      the end or start of the range.
 
1985
 
 
1986
      Historical context is also important when interpreting pathnames of
 
1987
      renamed files/directories. Consider the following example:
 
1988
 
 
1989
      * revision 1: add tutorial.txt
 
1990
      * revision 2: modify tutorial.txt
 
1991
      * revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
 
1992
 
 
1993
      In this case:
 
1994
 
 
1995
      * ``bzr log guide.txt`` will log the file added in revision 1
 
1996
 
 
1997
      * ``bzr log tutorial.txt`` will log the new file added in revision 3
 
1998
 
 
1999
      * ``bzr log -r2 -p tutorial.txt`` will show the changes made to
 
2000
        the original file in revision 2.
 
2001
 
 
2002
      * ``bzr log -r2 -p guide.txt`` will display an error message as there
 
2003
        was no file called guide.txt in revision 2.
 
2004
 
 
2005
      Renames are always followed by log. By design, there is no need to
 
2006
      explicitly ask for this (and no way to stop logging a file back
 
2007
      until it was last renamed).
 
2008
 
 
2009
      Note: If the path is a directory, only revisions that directly changed
 
2010
      that directory object are currently shown. This is considered a bug.
 
2011
      (Support for filtering against multiple files and for files within a
 
2012
      directory is under development.)
 
2013
 
 
2014
    :Other filtering:
 
2015
 
 
2016
      The --message option can be used for finding revisions that match a
 
2017
      regular expression in a commit message.
 
2018
 
 
2019
    :Tips & tricks:
 
2020
 
 
2021
      GUI tools and IDEs are often better at exploring history than command
 
2022
      line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
 
2023
      respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
 
2024
      http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
 
2025
 
 
2026
      Web interfaces are often better at exploring history than command line
 
2027
      tools, particularly for branches on servers. You may prefer Loggerhead
 
2028
      or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
 
2029
 
 
2030
      You may find it useful to add the aliases below to ``bazaar.conf``::
 
2031
 
 
2032
        [ALIASES]
 
2033
        tip = log -r-1 -n1
 
2034
        top = log -r-10.. --short --forward
 
2035
        show = log -v -p -n1 --long
 
2036
 
 
2037
      ``bzr tip`` will then show the latest revision while ``bzr top``
 
2038
      will show the last 10 mainline revisions. To see the details of a
 
2039
      particular revision X,  ``bzr show -rX``.
 
2040
 
 
2041
      As many GUI tools and Web interfaces do, you may prefer viewing
 
2042
      history collapsed initially. If you are interested in looking deeper
 
2043
      into a particular merge X, use ``bzr log -n0 -rX``. If you like
 
2044
      working this way, you may wish to either:
 
2045
 
 
2046
      * change your default log format to short (or line)
 
2047
      * add this alias: log = log -n1
 
2048
 
 
2049
      ``bzr log -v`` on a branch with lots of history is currently
 
2050
      very slow. A fix for this issue is currently under development.
 
2051
      With or without that fix, it is recommended that a revision range
 
2052
      be given when using the -v option.
 
2053
 
 
2054
      bzr has a generic full-text matching plugin, bzr-search, that can be
 
2055
      used to find revisions matching user names, commit messages, etc.
 
2056
      Among other features, this plugin can find all revisions containing
 
2057
      a list of words but not others.
 
2058
 
 
2059
      When exploring non-mainline history on large projects with deep
 
2060
      history, the performance of log can be greatly improved by installing
 
2061
      the revnocache plugin. This plugin buffers historical information
 
2062
      trading disk space for faster speed.
 
2063
    """
 
2064
    takes_args = ['location?']
 
2065
    _see_also = ['log-formats', 'revisionspec']
 
2066
    takes_options = [
 
2067
            Option('forward',
 
2068
                   help='Show from oldest to newest.'),
 
2069
            'timezone',
 
2070
            custom_help('verbose',
 
2071
                   help='Show files changed in each revision.'),
 
2072
            'show-ids',
 
2073
            'revision',
 
2074
            Option('change',
 
2075
                   type=bzrlib.option._parse_revision_str,
 
2076
                   short_name='c',
 
2077
                   help='Show just the specified revision.'
 
2078
                   ' See also "help revisionspec".'),
 
2079
            'log-format',
 
2080
            Option('levels',
 
2081
                   short_name='n',
 
2082
                   help='Number of levels to display - 0 for all, 1 for flat.',
 
2083
                   argname='N',
 
2084
                   type=_parse_levels),
 
2085
            Option('message',
 
2086
                   short_name='m',
 
2087
                   help='Show revisions whose message matches this '
 
2088
                        'regular expression.',
 
2089
                   type=str),
 
2090
            Option('limit',
 
2091
                   short_name='l',
 
2092
                   help='Limit the output to the first N revisions.',
 
2093
                   argname='N',
 
2094
                   type=_parse_limit),
 
2095
            Option('show-diff',
 
2096
                   short_name='p',
 
2097
                   help='Show changes made in each revision as a patch.'),
 
2098
            ]
 
2099
    encoding_type = 'replace'
 
2100
 
 
2101
    @display_command
 
2102
    def run(self, location=None, timezone='original',
 
2103
            verbose=False,
 
2104
            show_ids=False,
 
2105
            forward=False,
 
2106
            revision=None,
 
2107
            change=None,
 
2108
            log_format=None,
 
2109
            levels=None,
 
2110
            message=None,
 
2111
            limit=None,
 
2112
            show_diff=False):
 
2113
        from bzrlib.log import show_log, _get_fileid_to_log
 
2114
        direction = (forward and 'forward') or 'reverse'
 
2115
 
 
2116
        if change is not None:
 
2117
            if len(change) > 1:
 
2118
                raise errors.RangeInChangeOption()
 
2119
            if revision is not None:
 
2120
                raise errors.BzrCommandError(
 
2121
                    '--revision and --change are mutually exclusive')
 
2122
            else:
 
2123
                revision = change
 
2124
 
 
2125
        # log everything
 
2126
        file_id = None
 
2127
        if location:
 
2128
            # find the file id to log:
 
2129
 
 
2130
            tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
 
2131
                location)
 
2132
            if fp != '':
 
2133
                file_id = _get_fileid_to_log(revision, tree, b, fp)
 
2134
                if file_id is None:
 
2135
                    raise errors.BzrCommandError(
 
2136
                        "Path unknown at end or start of revision range: %s" %
 
2137
                        location)
 
2138
        else:
 
2139
            # local dir only
 
2140
            # FIXME ? log the current subdir only RBC 20060203
 
2141
            if revision is not None \
 
2142
                    and len(revision) > 0 and revision[0].get_branch():
 
2143
                location = revision[0].get_branch()
 
2144
            else:
 
2145
                location = '.'
 
2146
            dir, relpath = bzrdir.BzrDir.open_containing(location)
 
2147
            b = dir.open_branch()
 
2148
 
 
2149
        b.lock_read()
 
2150
        try:
 
2151
            rev1, rev2 = _get_revision_range(revision, b, self.name())
 
2152
            if log_format is None:
 
2153
                log_format = log.log_formatter_registry.get_default(b)
 
2154
 
 
2155
            lf = log_format(show_ids=show_ids, to_file=self.outf,
 
2156
                            show_timezone=timezone,
 
2157
                            delta_format=get_verbosity_level(),
 
2158
                            levels=levels)
 
2159
 
 
2160
            show_log(b,
 
2161
                     lf,
 
2162
                     file_id,
 
2163
                     verbose=verbose,
 
2164
                     direction=direction,
 
2165
                     start_revision=rev1,
 
2166
                     end_revision=rev2,
 
2167
                     search=message,
 
2168
                     limit=limit,
 
2169
                     show_diff=show_diff)
 
2170
        finally:
 
2171
            b.unlock()
 
2172
 
 
2173
 
 
2174
def _get_revision_range(revisionspec_list, branch, command_name):
 
2175
    """Take the input of a revision option and turn it into a revision range.
 
2176
 
 
2177
    It returns RevisionInfo objects which can be used to obtain the rev_id's
 
2178
    of the desired revisons. It does some user input validations.
 
2179
    """
 
2180
    if revisionspec_list is None:
 
2181
        rev1 = None
 
2182
        rev2 = None
 
2183
    elif len(revisionspec_list) == 1:
 
2184
        rev1 = rev2 = revisionspec_list[0].in_history(branch)
 
2185
    elif len(revisionspec_list) == 2:
 
2186
        start_spec = revisionspec_list[0]
 
2187
        end_spec = revisionspec_list[1]
 
2188
        if end_spec.get_branch() != start_spec.get_branch():
 
2189
            # b is taken from revision[0].get_branch(), and
 
2190
            # show_log will use its revision_history. Having
 
2191
            # different branches will lead to weird behaviors.
 
2192
            raise errors.BzrCommandError(
 
2193
                "bzr %s doesn't accept two revisions in different"
 
2194
                " branches." % command_name)
 
2195
        rev1 = start_spec.in_history(branch)
 
2196
        # Avoid loading all of history when we know a missing
 
2197
        # end of range means the last revision ...
 
2198
        if end_spec.spec is None:
 
2199
            last_revno, last_revision_id = branch.last_revision_info()
 
2200
            rev2 = RevisionInfo(branch, last_revno, last_revision_id)
 
2201
        else:
 
2202
            rev2 = end_spec.in_history(branch)
 
2203
    else:
 
2204
        raise errors.BzrCommandError(
 
2205
            'bzr %s --revision takes one or two values.' % command_name)
 
2206
    return rev1, rev2
 
2207
 
 
2208
 
 
2209
def _revision_range_to_revid_range(revision_range):
 
2210
    rev_id1 = None
 
2211
    rev_id2 = None
 
2212
    if revision_range[0] is not None:
 
2213
        rev_id1 = revision_range[0].rev_id
 
2214
    if revision_range[1] is not None:
 
2215
        rev_id2 = revision_range[1].rev_id
 
2216
    return rev_id1, rev_id2
 
2217
 
 
2218
def get_log_format(long=False, short=False, line=False, default='long'):
 
2219
    log_format = default
 
2220
    if long:
 
2221
        log_format = 'long'
 
2222
    if short:
 
2223
        log_format = 'short'
 
2224
    if line:
 
2225
        log_format = 'line'
 
2226
    return log_format
 
2227
 
 
2228
 
 
2229
class cmd_touching_revisions(Command):
 
2230
    """Return revision-ids which affected a particular file.
 
2231
 
 
2232
    A more user-friendly interface is "bzr log FILE".
 
2233
    """
 
2234
 
 
2235
    hidden = True
 
2236
    takes_args = ["filename"]
 
2237
 
 
2238
    @display_command
 
2239
    def run(self, filename):
 
2240
        tree, relpath = WorkingTree.open_containing(filename)
 
2241
        b = tree.branch
 
2242
        file_id = tree.path2id(relpath)
 
2243
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
 
2244
            self.outf.write("%6d %s\n" % (revno, what))
 
2245
 
 
2246
 
 
2247
class cmd_ls(Command):
 
2248
    """List files in a tree.
 
2249
    """
 
2250
 
 
2251
    _see_also = ['status', 'cat']
 
2252
    takes_args = ['path?']
 
2253
    # TODO: Take a revision or remote path and list that tree instead.
 
2254
    takes_options = [
 
2255
            'verbose',
 
2256
            'revision',
 
2257
            Option('non-recursive',
 
2258
                   help='Don\'t recurse into subdirectories.'),
 
2259
            Option('from-root',
 
2260
                   help='Print paths relative to the root of the branch.'),
 
2261
            Option('unknown', help='Print unknown files.'),
 
2262
            Option('versioned', help='Print versioned files.',
 
2263
                   short_name='V'),
 
2264
            Option('ignored', help='Print ignored files.'),
 
2265
            Option('null',
 
2266
                   help='Write an ascii NUL (\\0) separator '
 
2267
                   'between files rather than a newline.'),
 
2268
            Option('kind',
 
2269
                   help='List entries of a particular kind: file, directory, symlink.',
 
2270
                   type=unicode),
 
2271
            'show-ids',
 
2272
            ]
 
2273
    @display_command
 
2274
    def run(self, revision=None, verbose=False,
 
2275
            non_recursive=False, from_root=False,
 
2276
            unknown=False, versioned=False, ignored=False,
 
2277
            null=False, kind=None, show_ids=False, path=None):
 
2278
 
 
2279
        if kind and kind not in ('file', 'directory', 'symlink'):
 
2280
            raise errors.BzrCommandError('invalid kind specified')
 
2281
 
 
2282
        if verbose and null:
 
2283
            raise errors.BzrCommandError('Cannot set both --verbose and --null')
 
2284
        all = not (unknown or versioned or ignored)
 
2285
 
 
2286
        selection = {'I':ignored, '?':unknown, 'V':versioned}
 
2287
 
 
2288
        if path is None:
 
2289
            fs_path = '.'
 
2290
            prefix = ''
 
2291
        else:
 
2292
            if from_root:
 
2293
                raise errors.BzrCommandError('cannot specify both --from-root'
 
2294
                                             ' and PATH')
 
2295
            fs_path = path
 
2296
            prefix = path
 
2297
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
 
2298
            fs_path)
 
2299
        if from_root:
 
2300
            relpath = u''
 
2301
        elif relpath:
 
2302
            relpath += '/'
 
2303
        if revision is not None or tree is None:
 
2304
            tree = _get_one_revision_tree('ls', revision, branch=branch)
 
2305
 
 
2306
        apply_view = False
 
2307
        if isinstance(tree, WorkingTree) and tree.supports_views():
 
2308
            view_files = tree.views.lookup_view()
 
2309
            if view_files:
 
2310
                apply_view = True
 
2311
                view_str = views.view_display_str(view_files)
 
2312
                note("ignoring files outside view: %s" % view_str)
 
2313
 
 
2314
        tree.lock_read()
 
2315
        try:
 
2316
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
 
2317
                if fp.startswith(relpath):
 
2318
                    fp = osutils.pathjoin(prefix, fp[len(relpath):])
 
2319
                    if non_recursive and '/' in fp:
 
2320
                        continue
 
2321
                    if not all and not selection[fc]:
 
2322
                        continue
 
2323
                    if kind is not None and fkind != kind:
 
2324
                        continue
 
2325
                    if apply_view:
 
2326
                        try:
 
2327
                            views.check_path_in_view(tree, fp)
 
2328
                        except errors.FileOutsideView:
 
2329
                            continue
 
2330
                    kindch = entry.kind_character()
 
2331
                    outstring = fp + kindch
 
2332
                    if verbose:
 
2333
                        outstring = '%-8s %s' % (fc, outstring)
 
2334
                        if show_ids and fid is not None:
 
2335
                            outstring = "%-50s %s" % (outstring, fid)
 
2336
                        self.outf.write(outstring + '\n')
 
2337
                    elif null:
 
2338
                        self.outf.write(fp + '\0')
 
2339
                        if show_ids:
 
2340
                            if fid is not None:
 
2341
                                self.outf.write(fid)
 
2342
                            self.outf.write('\0')
 
2343
                        self.outf.flush()
 
2344
                    else:
 
2345
                        if fid is not None:
 
2346
                            my_id = fid
 
2347
                        else:
 
2348
                            my_id = ''
 
2349
                        if show_ids:
 
2350
                            self.outf.write('%-50s %s\n' % (outstring, my_id))
 
2351
                        else:
 
2352
                            self.outf.write(outstring + '\n')
 
2353
        finally:
 
2354
            tree.unlock()
 
2355
 
 
2356
 
 
2357
class cmd_unknowns(Command):
 
2358
    """List unknown files.
 
2359
    """
 
2360
 
 
2361
    hidden = True
 
2362
    _see_also = ['ls']
 
2363
 
 
2364
    @display_command
 
2365
    def run(self):
 
2366
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
 
2367
            self.outf.write(osutils.quotefn(f) + '\n')
 
2368
 
 
2369
 
 
2370
class cmd_ignore(Command):
 
2371
    """Ignore specified files or patterns.
 
2372
 
 
2373
    See ``bzr help patterns`` for details on the syntax of patterns.
 
2374
 
 
2375
    To remove patterns from the ignore list, edit the .bzrignore file.
 
2376
    After adding, editing or deleting that file either indirectly by
 
2377
    using this command or directly by using an editor, be sure to commit
 
2378
    it.
 
2379
 
 
2380
    Note: ignore patterns containing shell wildcards must be quoted from
 
2381
    the shell on Unix.
 
2382
 
 
2383
    :Examples:
 
2384
        Ignore the top level Makefile::
 
2385
 
 
2386
            bzr ignore ./Makefile
 
2387
 
 
2388
        Ignore class files in all directories::
 
2389
 
 
2390
            bzr ignore "*.class"
 
2391
 
 
2392
        Ignore .o files under the lib directory::
 
2393
 
 
2394
            bzr ignore "lib/**/*.o"
 
2395
 
 
2396
        Ignore .o files under the lib directory::
 
2397
 
 
2398
            bzr ignore "RE:lib/.*\.o"
 
2399
 
 
2400
        Ignore everything but the "debian" toplevel directory::
 
2401
 
 
2402
            bzr ignore "RE:(?!debian/).*"
 
2403
    """
 
2404
 
 
2405
    _see_also = ['status', 'ignored', 'patterns']
 
2406
    takes_args = ['name_pattern*']
 
2407
    takes_options = [
 
2408
        Option('old-default-rules',
 
2409
               help='Write out the ignore rules bzr < 0.9 always used.')
 
2410
        ]
 
2411
 
 
2412
    def run(self, name_pattern_list=None, old_default_rules=None):
 
2413
        from bzrlib import ignores
 
2414
        if old_default_rules is not None:
 
2415
            # dump the rules and exit
 
2416
            for pattern in ignores.OLD_DEFAULTS:
 
2417
                print pattern
 
2418
            return
 
2419
        if not name_pattern_list:
 
2420
            raise errors.BzrCommandError("ignore requires at least one "
 
2421
                                  "NAME_PATTERN or --old-default-rules")
 
2422
        name_pattern_list = [globbing.normalize_pattern(p)
 
2423
                             for p in name_pattern_list]
 
2424
        for name_pattern in name_pattern_list:
 
2425
            if (name_pattern[0] == '/' or
 
2426
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
 
2427
                raise errors.BzrCommandError(
 
2428
                    "NAME_PATTERN should not be an absolute path")
 
2429
        tree, relpath = WorkingTree.open_containing(u'.')
 
2430
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
 
2431
        ignored = globbing.Globster(name_pattern_list)
 
2432
        matches = []
 
2433
        tree.lock_read()
 
2434
        for entry in tree.list_files():
 
2435
            id = entry[3]
 
2436
            if id is not None:
 
2437
                filename = entry[0]
 
2438
                if ignored.match(filename):
 
2439
                    matches.append(filename.encode('utf-8'))
 
2440
        tree.unlock()
 
2441
        if len(matches) > 0:
 
2442
            print "Warning: the following files are version controlled and" \
 
2443
                  " match your ignore pattern:\n%s" \
 
2444
                  "\nThese files will continue to be version controlled" \
 
2445
                  " unless you 'bzr remove' them." % ("\n".join(matches),)
 
2446
 
 
2447
 
 
2448
class cmd_ignored(Command):
 
2449
    """List ignored files and the patterns that matched them.
 
2450
 
 
2451
    List all the ignored files and the ignore pattern that caused the file to
 
2452
    be ignored.
 
2453
 
 
2454
    Alternatively, to list just the files::
 
2455
 
 
2456
        bzr ls --ignored
 
2457
    """
 
2458
 
 
2459
    encoding_type = 'replace'
 
2460
    _see_also = ['ignore', 'ls']
 
2461
 
 
2462
    @display_command
 
2463
    def run(self):
 
2464
        tree = WorkingTree.open_containing(u'.')[0]
 
2465
        tree.lock_read()
 
2466
        try:
 
2467
            for path, file_class, kind, file_id, entry in tree.list_files():
 
2468
                if file_class != 'I':
 
2469
                    continue
 
2470
                ## XXX: Slightly inefficient since this was already calculated
 
2471
                pat = tree.is_ignored(path)
 
2472
                self.outf.write('%-50s %s\n' % (path, pat))
 
2473
        finally:
 
2474
            tree.unlock()
 
2475
 
 
2476
 
 
2477
class cmd_lookup_revision(Command):
 
2478
    """Lookup the revision-id from a revision-number
 
2479
 
 
2480
    :Examples:
 
2481
        bzr lookup-revision 33
 
2482
    """
 
2483
    hidden = True
 
2484
    takes_args = ['revno']
 
2485
 
 
2486
    @display_command
 
2487
    def run(self, revno):
 
2488
        try:
 
2489
            revno = int(revno)
 
2490
        except ValueError:
 
2491
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
 
2492
 
 
2493
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
2494
 
 
2495
 
 
2496
class cmd_export(Command):
 
2497
    """Export current or past revision to a destination directory or archive.
 
2498
 
 
2499
    If no revision is specified this exports the last committed revision.
 
2500
 
 
2501
    Format may be an "exporter" name, such as tar, tgz, tbz2.  If none is
 
2502
    given, try to find the format with the extension. If no extension
 
2503
    is found exports to a directory (equivalent to --format=dir).
 
2504
 
 
2505
    If root is supplied, it will be used as the root directory inside
 
2506
    container formats (tar, zip, etc). If it is not supplied it will default
 
2507
    to the exported filename. The root option has no effect for 'dir' format.
 
2508
 
 
2509
    If branch is omitted then the branch containing the current working
 
2510
    directory will be used.
 
2511
 
 
2512
    Note: Export of tree with non-ASCII filenames to zip is not supported.
 
2513
 
 
2514
      =================       =========================
 
2515
      Supported formats       Autodetected by extension
 
2516
      =================       =========================
 
2517
         dir                         (none)
 
2518
         tar                          .tar
 
2519
         tbz2                    .tar.bz2, .tbz2
 
2520
         tgz                      .tar.gz, .tgz
 
2521
         zip                          .zip
 
2522
      =================       =========================
 
2523
    """
 
2524
    takes_args = ['dest', 'branch_or_subdir?']
 
2525
    takes_options = [
 
2526
        Option('format',
 
2527
               help="Type of file to export to.",
 
2528
               type=unicode),
 
2529
        'revision',
 
2530
        Option('root',
 
2531
               type=str,
 
2532
               help="Name of the root directory inside the exported file."),
 
2533
        ]
 
2534
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
 
2535
        root=None):
 
2536
        from bzrlib.export import export
 
2537
 
 
2538
        if branch_or_subdir is None:
 
2539
            tree = WorkingTree.open_containing(u'.')[0]
 
2540
            b = tree.branch
 
2541
            subdir = None
 
2542
        else:
 
2543
            b, subdir = Branch.open_containing(branch_or_subdir)
 
2544
            tree = None
 
2545
 
 
2546
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
 
2547
        try:
 
2548
            export(rev_tree, dest, format, root, subdir)
 
2549
        except errors.NoSuchExportFormat, e:
 
2550
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
 
2551
 
 
2552
 
 
2553
class cmd_cat(Command):
 
2554
    """Write the contents of a file as of a given revision to standard output.
 
2555
 
 
2556
    If no revision is nominated, the last revision is used.
 
2557
 
 
2558
    Note: Take care to redirect standard output when using this command on a
 
2559
    binary file.
 
2560
    """
 
2561
 
 
2562
    _see_also = ['ls']
 
2563
    takes_options = [
 
2564
        Option('name-from-revision', help='The path name in the old tree.'),
 
2565
        'revision',
 
2566
        ]
 
2567
    takes_args = ['filename']
 
2568
    encoding_type = 'exact'
 
2569
 
 
2570
    @display_command
 
2571
    def run(self, filename, revision=None, name_from_revision=False):
 
2572
        if revision is not None and len(revision) != 1:
 
2573
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
 
2574
                                         " one revision specifier")
 
2575
        tree, branch, relpath = \
 
2576
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
2577
        branch.lock_read()
 
2578
        try:
 
2579
            return self._run(tree, branch, relpath, filename, revision,
 
2580
                             name_from_revision)
 
2581
        finally:
 
2582
            branch.unlock()
 
2583
 
 
2584
    def _run(self, tree, b, relpath, filename, revision, name_from_revision):
 
2585
        if tree is None:
 
2586
            tree = b.basis_tree()
 
2587
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
 
2588
 
 
2589
        old_file_id = rev_tree.path2id(relpath)
 
2590
 
 
2591
        if name_from_revision:
 
2592
            # Try in revision if requested
 
2593
            if old_file_id is None:
 
2594
                raise errors.BzrCommandError(
 
2595
                    "%r is not present in revision %s" % (
 
2596
                        filename, rev_tree.get_revision_id()))
 
2597
            else:
 
2598
                content = rev_tree.get_file_text(old_file_id)
 
2599
        else:
 
2600
            cur_file_id = tree.path2id(relpath)
 
2601
            found = False
 
2602
            if cur_file_id is not None:
 
2603
                # Then try with the actual file id
 
2604
                try:
 
2605
                    content = rev_tree.get_file_text(cur_file_id)
 
2606
                    found = True
 
2607
                except errors.NoSuchId:
 
2608
                    # The actual file id didn't exist at that time
 
2609
                    pass
 
2610
            if not found and old_file_id is not None:
 
2611
                # Finally try with the old file id
 
2612
                content = rev_tree.get_file_text(old_file_id)
 
2613
                found = True
 
2614
            if not found:
 
2615
                # Can't be found anywhere
 
2616
                raise errors.BzrCommandError(
 
2617
                    "%r is not present in revision %s" % (
 
2618
                        filename, rev_tree.get_revision_id()))
 
2619
        self.outf.write(content)
 
2620
 
 
2621
 
 
2622
class cmd_local_time_offset(Command):
 
2623
    """Show the offset in seconds from GMT to local time."""
 
2624
    hidden = True
 
2625
    @display_command
 
2626
    def run(self):
 
2627
        print osutils.local_time_offset()
 
2628
 
 
2629
 
 
2630
 
 
2631
class cmd_commit(Command):
 
2632
    """Commit changes into a new revision.
 
2633
 
 
2634
    If no arguments are given, the entire tree is committed.
 
2635
 
 
2636
    If selected files are specified, only changes to those files are
 
2637
    committed.  If a directory is specified then the directory and everything
 
2638
    within it is committed.
 
2639
 
 
2640
    When excludes are given, they take precedence over selected files.
 
2641
    For example, too commit only changes within foo, but not changes within
 
2642
    foo/bar::
 
2643
 
 
2644
      bzr commit foo -x foo/bar
 
2645
 
 
2646
    If author of the change is not the same person as the committer, you can
 
2647
    specify the author's name using the --author option. The name should be
 
2648
    in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
 
2649
    If there is more than one author of the change you can specify the option
 
2650
    multiple times, once for each author.
 
2651
 
 
2652
    A selected-file commit may fail in some cases where the committed
 
2653
    tree would be invalid. Consider::
 
2654
 
 
2655
      bzr init foo
 
2656
      mkdir foo/bar
 
2657
      bzr add foo/bar
 
2658
      bzr commit foo -m "committing foo"
 
2659
      bzr mv foo/bar foo/baz
 
2660
      mkdir foo/bar
 
2661
      bzr add foo/bar
 
2662
      bzr commit foo/bar -m "committing bar but not baz"
 
2663
 
 
2664
    In the example above, the last commit will fail by design. This gives
 
2665
    the user the opportunity to decide whether they want to commit the
 
2666
    rename at the same time, separately first, or not at all. (As a general
 
2667
    rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
 
2668
 
 
2669
    Note: A selected-file commit after a merge is not yet supported.
 
2670
    """
 
2671
    # TODO: Run hooks on tree to-be-committed, and after commit.
 
2672
 
 
2673
    # TODO: Strict commit that fails if there are deleted files.
 
2674
    #       (what does "deleted files" mean ??)
 
2675
 
 
2676
    # TODO: Give better message for -s, --summary, used by tla people
 
2677
 
 
2678
    # XXX: verbose currently does nothing
 
2679
 
 
2680
    _see_also = ['bugs', 'uncommit']
 
2681
    takes_args = ['selected*']
 
2682
    takes_options = [
 
2683
            ListOption('exclude', type=str, short_name='x',
 
2684
                help="Do not consider changes made to a given path."),
 
2685
            Option('message', type=unicode,
 
2686
                   short_name='m',
 
2687
                   help="Description of the new revision."),
 
2688
            'verbose',
 
2689
             Option('unchanged',
 
2690
                    help='Commit even if nothing has changed.'),
 
2691
             Option('file', type=str,
 
2692
                    short_name='F',
 
2693
                    argname='msgfile',
 
2694
                    help='Take commit message from this file.'),
 
2695
             Option('strict',
 
2696
                    help="Refuse to commit if there are unknown "
 
2697
                    "files in the working tree."),
 
2698
             ListOption('fixes', type=str,
 
2699
                    help="Mark a bug as being fixed by this revision "
 
2700
                         "(see \"bzr help bugs\")."),
 
2701
             ListOption('author', type=unicode,
 
2702
                    help="Set the author's name, if it's different "
 
2703
                         "from the committer."),
 
2704
             Option('local',
 
2705
                    help="Perform a local commit in a bound "
 
2706
                         "branch.  Local commits are not pushed to "
 
2707
                         "the master branch until a normal commit "
 
2708
                         "is performed."
 
2709
                    ),
 
2710
              Option('show-diff',
 
2711
                     help='When no message is supplied, show the diff along'
 
2712
                     ' with the status summary in the message editor.'),
 
2713
             ]
 
2714
    aliases = ['ci', 'checkin']
 
2715
 
 
2716
    def _iter_bug_fix_urls(self, fixes, branch):
 
2717
        # Configure the properties for bug fixing attributes.
 
2718
        for fixed_bug in fixes:
 
2719
            tokens = fixed_bug.split(':')
 
2720
            if len(tokens) != 2:
 
2721
                raise errors.BzrCommandError(
 
2722
                    "Invalid bug %s. Must be in the form of 'tracker:id'. "
 
2723
                    "See \"bzr help bugs\" for more information on this "
 
2724
                    "feature.\nCommit refused." % fixed_bug)
 
2725
            tag, bug_id = tokens
 
2726
            try:
 
2727
                yield bugtracker.get_bug_url(tag, branch, bug_id)
 
2728
            except errors.UnknownBugTrackerAbbreviation:
 
2729
                raise errors.BzrCommandError(
 
2730
                    'Unrecognized bug %s. Commit refused.' % fixed_bug)
 
2731
            except errors.MalformedBugIdentifier, e:
 
2732
                raise errors.BzrCommandError(
 
2733
                    "%s\nCommit refused." % (str(e),))
 
2734
 
 
2735
    def run(self, message=None, file=None, verbose=False, selected_list=None,
 
2736
            unchanged=False, strict=False, local=False, fixes=None,
 
2737
            author=None, show_diff=False, exclude=None):
 
2738
        from bzrlib.errors import (
 
2739
            PointlessCommit,
 
2740
            ConflictsInTree,
 
2741
            StrictCommitFailed
 
2742
        )
 
2743
        from bzrlib.msgeditor import (
 
2744
            edit_commit_message_encoded,
 
2745
            generate_commit_message_template,
 
2746
            make_commit_message_template_encoded
 
2747
        )
 
2748
 
 
2749
        # TODO: Need a blackbox test for invoking the external editor; may be
 
2750
        # slightly problematic to run this cross-platform.
 
2751
 
 
2752
        # TODO: do more checks that the commit will succeed before
 
2753
        # spending the user's valuable time typing a commit message.
 
2754
 
 
2755
        properties = {}
 
2756
 
 
2757
        tree, selected_list = tree_files(selected_list)
 
2758
        if selected_list == ['']:
 
2759
            # workaround - commit of root of tree should be exactly the same
 
2760
            # as just default commit in that tree, and succeed even though
 
2761
            # selected-file merge commit is not done yet
 
2762
            selected_list = []
 
2763
 
 
2764
        if fixes is None:
 
2765
            fixes = []
 
2766
        bug_property = bugtracker.encode_fixes_bug_urls(
 
2767
            self._iter_bug_fix_urls(fixes, tree.branch))
 
2768
        if bug_property:
 
2769
            properties['bugs'] = bug_property
 
2770
 
 
2771
        if local and not tree.branch.get_bound_location():
 
2772
            raise errors.LocalRequiresBoundBranch()
 
2773
 
 
2774
        def get_message(commit_obj):
 
2775
            """Callback to get commit message"""
 
2776
            my_message = message
 
2777
            if my_message is None and not file:
 
2778
                t = make_commit_message_template_encoded(tree,
 
2779
                        selected_list, diff=show_diff,
 
2780
                        output_encoding=osutils.get_user_encoding())
 
2781
                start_message = generate_commit_message_template(commit_obj)
 
2782
                my_message = edit_commit_message_encoded(t,
 
2783
                    start_message=start_message)
 
2784
                if my_message is None:
 
2785
                    raise errors.BzrCommandError("please specify a commit"
 
2786
                        " message with either --message or --file")
 
2787
            elif my_message and file:
 
2788
                raise errors.BzrCommandError(
 
2789
                    "please specify either --message or --file")
 
2790
            if file:
 
2791
                my_message = codecs.open(file, 'rt',
 
2792
                                         osutils.get_user_encoding()).read()
 
2793
            if my_message == "":
 
2794
                raise errors.BzrCommandError("empty commit message specified")
 
2795
            return my_message
 
2796
 
 
2797
        try:
 
2798
            tree.commit(message_callback=get_message,
 
2799
                        specific_files=selected_list,
 
2800
                        allow_pointless=unchanged, strict=strict, local=local,
 
2801
                        reporter=None, verbose=verbose, revprops=properties,
 
2802
                        authors=author,
 
2803
                        exclude=safe_relpath_files(tree, exclude))
 
2804
        except PointlessCommit:
 
2805
            # FIXME: This should really happen before the file is read in;
 
2806
            # perhaps prepare the commit; get the message; then actually commit
 
2807
            raise errors.BzrCommandError("no changes to commit."
 
2808
                              " use --unchanged to commit anyhow")
 
2809
        except ConflictsInTree:
 
2810
            raise errors.BzrCommandError('Conflicts detected in working '
 
2811
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
 
2812
                ' resolve.')
 
2813
        except StrictCommitFailed:
 
2814
            raise errors.BzrCommandError("Commit refused because there are"
 
2815
                              " unknown files in the working tree.")
 
2816
        except errors.BoundBranchOutOfDate, e:
 
2817
            raise errors.BzrCommandError(str(e) + "\n"
 
2818
            'To commit to master branch, run update and then commit.\n'
 
2819
            'You can also pass --local to commit to continue working '
 
2820
            'disconnected.')
 
2821
 
 
2822
 
 
2823
class cmd_check(Command):
 
2824
    """Validate working tree structure, branch consistency and repository history.
 
2825
 
 
2826
    This command checks various invariants about branch and repository storage
 
2827
    to detect data corruption or bzr bugs.
 
2828
 
 
2829
    The working tree and branch checks will only give output if a problem is
 
2830
    detected. The output fields of the repository check are:
 
2831
 
 
2832
        revisions: This is just the number of revisions checked.  It doesn't
 
2833
            indicate a problem.
 
2834
        versionedfiles: This is just the number of versionedfiles checked.  It
 
2835
            doesn't indicate a problem.
 
2836
        unreferenced ancestors: Texts that are ancestors of other texts, but
 
2837
            are not properly referenced by the revision ancestry.  This is a
 
2838
            subtle problem that Bazaar can work around.
 
2839
        unique file texts: This is the total number of unique file contents
 
2840
            seen in the checked revisions.  It does not indicate a problem.
 
2841
        repeated file texts: This is the total number of repeated texts seen
 
2842
            in the checked revisions.  Texts can be repeated when their file
 
2843
            entries are modified, but the file contents are not.  It does not
 
2844
            indicate a problem.
 
2845
 
 
2846
    If no restrictions are specified, all Bazaar data that is found at the given
 
2847
    location will be checked.
 
2848
 
 
2849
    :Examples:
 
2850
 
 
2851
        Check the tree and branch at 'foo'::
 
2852
 
 
2853
            bzr check --tree --branch foo
 
2854
 
 
2855
        Check only the repository at 'bar'::
 
2856
 
 
2857
            bzr check --repo bar
 
2858
 
 
2859
        Check everything at 'baz'::
 
2860
 
 
2861
            bzr check baz
 
2862
    """
 
2863
 
 
2864
    _see_also = ['reconcile']
 
2865
    takes_args = ['path?']
 
2866
    takes_options = ['verbose',
 
2867
                     Option('branch', help="Check the branch related to the"
 
2868
                                           " current directory."),
 
2869
                     Option('repo', help="Check the repository related to the"
 
2870
                                         " current directory."),
 
2871
                     Option('tree', help="Check the working tree related to"
 
2872
                                         " the current directory.")]
 
2873
 
 
2874
    def run(self, path=None, verbose=False, branch=False, repo=False,
 
2875
            tree=False):
 
2876
        from bzrlib.check import check_dwim
 
2877
        if path is None:
 
2878
            path = '.'
 
2879
        if not branch and not repo and not tree:
 
2880
            branch = repo = tree = True
 
2881
        check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
 
2882
 
 
2883
 
 
2884
class cmd_upgrade(Command):
 
2885
    """Upgrade branch storage to current format.
 
2886
 
 
2887
    The check command or bzr developers may sometimes advise you to run
 
2888
    this command. When the default format has changed you may also be warned
 
2889
    during other operations to upgrade.
 
2890
    """
 
2891
 
 
2892
    _see_also = ['check']
 
2893
    takes_args = ['url?']
 
2894
    takes_options = [
 
2895
                    RegistryOption('format',
 
2896
                        help='Upgrade to a specific format.  See "bzr help'
 
2897
                             ' formats" for details.',
 
2898
                        lazy_registry=('bzrlib.bzrdir', 'format_registry'),
 
2899
                        converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
 
2900
                        value_switches=True, title='Branch format'),
 
2901
                    ]
 
2902
 
 
2903
    def run(self, url='.', format=None):
 
2904
        from bzrlib.upgrade import upgrade
 
2905
        if format is None:
 
2906
            format = bzrdir.format_registry.make_bzrdir('default')
 
2907
        upgrade(url, format)
 
2908
 
 
2909
 
 
2910
class cmd_whoami(Command):
 
2911
    """Show or set bzr user id.
 
2912
 
 
2913
    :Examples:
 
2914
        Show the email of the current user::
 
2915
 
 
2916
            bzr whoami --email
 
2917
 
 
2918
        Set the current user::
 
2919
 
 
2920
            bzr whoami "Frank Chu <fchu@example.com>"
 
2921
    """
 
2922
    takes_options = [ Option('email',
 
2923
                             help='Display email address only.'),
 
2924
                      Option('branch',
 
2925
                             help='Set identity for the current branch instead of '
 
2926
                                  'globally.'),
 
2927
                    ]
 
2928
    takes_args = ['name?']
 
2929
    encoding_type = 'replace'
 
2930
 
 
2931
    @display_command
 
2932
    def run(self, email=False, branch=False, name=None):
 
2933
        if name is None:
 
2934
            # use branch if we're inside one; otherwise global config
 
2935
            try:
 
2936
                c = Branch.open_containing('.')[0].get_config()
 
2937
            except errors.NotBranchError:
 
2938
                c = config.GlobalConfig()
 
2939
            if email:
 
2940
                self.outf.write(c.user_email() + '\n')
 
2941
            else:
 
2942
                self.outf.write(c.username() + '\n')
 
2943
            return
 
2944
 
 
2945
        # display a warning if an email address isn't included in the given name.
 
2946
        try:
 
2947
            config.extract_email_address(name)
 
2948
        except errors.NoEmailInUsername, e:
 
2949
            warning('"%s" does not seem to contain an email address.  '
 
2950
                    'This is allowed, but not recommended.', name)
 
2951
 
 
2952
        # use global config unless --branch given
 
2953
        if branch:
 
2954
            c = Branch.open_containing('.')[0].get_config()
 
2955
        else:
 
2956
            c = config.GlobalConfig()
 
2957
        c.set_user_option('email', name)
 
2958
 
 
2959
 
 
2960
class cmd_nick(Command):
 
2961
    """Print or set the branch nickname.
 
2962
 
 
2963
    If unset, the tree root directory name is used as the nickname.
 
2964
    To print the current nickname, execute with no argument.
 
2965
 
 
2966
    Bound branches use the nickname of its master branch unless it is set
 
2967
    locally.
 
2968
    """
 
2969
 
 
2970
    _see_also = ['info']
 
2971
    takes_args = ['nickname?']
 
2972
    def run(self, nickname=None):
 
2973
        branch = Branch.open_containing(u'.')[0]
 
2974
        if nickname is None:
 
2975
            self.printme(branch)
 
2976
        else:
 
2977
            branch.nick = nickname
 
2978
 
 
2979
    @display_command
 
2980
    def printme(self, branch):
 
2981
        print branch.nick
 
2982
 
 
2983
 
 
2984
class cmd_alias(Command):
 
2985
    """Set/unset and display aliases.
 
2986
 
 
2987
    :Examples:
 
2988
        Show the current aliases::
 
2989
 
 
2990
            bzr alias
 
2991
 
 
2992
        Show the alias specified for 'll'::
 
2993
 
 
2994
            bzr alias ll
 
2995
 
 
2996
        Set an alias for 'll'::
 
2997
 
 
2998
            bzr alias ll="log --line -r-10..-1"
 
2999
 
 
3000
        To remove an alias for 'll'::
 
3001
 
 
3002
            bzr alias --remove ll
 
3003
 
 
3004
    """
 
3005
    takes_args = ['name?']
 
3006
    takes_options = [
 
3007
        Option('remove', help='Remove the alias.'),
 
3008
        ]
 
3009
 
 
3010
    def run(self, name=None, remove=False):
 
3011
        if remove:
 
3012
            self.remove_alias(name)
 
3013
        elif name is None:
 
3014
            self.print_aliases()
 
3015
        else:
 
3016
            equal_pos = name.find('=')
 
3017
            if equal_pos == -1:
 
3018
                self.print_alias(name)
 
3019
            else:
 
3020
                self.set_alias(name[:equal_pos], name[equal_pos+1:])
 
3021
 
 
3022
    def remove_alias(self, alias_name):
 
3023
        if alias_name is None:
 
3024
            raise errors.BzrCommandError(
 
3025
                'bzr alias --remove expects an alias to remove.')
 
3026
        # If alias is not found, print something like:
 
3027
        # unalias: foo: not found
 
3028
        c = config.GlobalConfig()
 
3029
        c.unset_alias(alias_name)
 
3030
 
 
3031
    @display_command
 
3032
    def print_aliases(self):
 
3033
        """Print out the defined aliases in a similar format to bash."""
 
3034
        aliases = config.GlobalConfig().get_aliases()
 
3035
        for key, value in sorted(aliases.iteritems()):
 
3036
            self.outf.write('bzr alias %s="%s"\n' % (key, value))
 
3037
 
 
3038
    @display_command
 
3039
    def print_alias(self, alias_name):
 
3040
        from bzrlib.commands import get_alias
 
3041
        alias = get_alias(alias_name)
 
3042
        if alias is None:
 
3043
            self.outf.write("bzr alias: %s: not found\n" % alias_name)
 
3044
        else:
 
3045
            self.outf.write(
 
3046
                'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
 
3047
 
 
3048
    def set_alias(self, alias_name, alias_command):
 
3049
        """Save the alias in the global config."""
 
3050
        c = config.GlobalConfig()
 
3051
        c.set_alias(alias_name, alias_command)
 
3052
 
 
3053
 
 
3054
class cmd_selftest(Command):
 
3055
    """Run internal test suite.
 
3056
 
 
3057
    If arguments are given, they are regular expressions that say which tests
 
3058
    should run.  Tests matching any expression are run, and other tests are
 
3059
    not run.
 
3060
 
 
3061
    Alternatively if --first is given, matching tests are run first and then
 
3062
    all other tests are run.  This is useful if you have been working in a
 
3063
    particular area, but want to make sure nothing else was broken.
 
3064
 
 
3065
    If --exclude is given, tests that match that regular expression are
 
3066
    excluded, regardless of whether they match --first or not.
 
3067
 
 
3068
    To help catch accidential dependencies between tests, the --randomize
 
3069
    option is useful. In most cases, the argument used is the word 'now'.
 
3070
    Note that the seed used for the random number generator is displayed
 
3071
    when this option is used. The seed can be explicitly passed as the
 
3072
    argument to this option if required. This enables reproduction of the
 
3073
    actual ordering used if and when an order sensitive problem is encountered.
 
3074
 
 
3075
    If --list-only is given, the tests that would be run are listed. This is
 
3076
    useful when combined with --first, --exclude and/or --randomize to
 
3077
    understand their impact. The test harness reports "Listed nn tests in ..."
 
3078
    instead of "Ran nn tests in ..." when list mode is enabled.
 
3079
 
 
3080
    If the global option '--no-plugins' is given, plugins are not loaded
 
3081
    before running the selftests.  This has two effects: features provided or
 
3082
    modified by plugins will not be tested, and tests provided by plugins will
 
3083
    not be run.
 
3084
 
 
3085
    Tests that need working space on disk use a common temporary directory,
 
3086
    typically inside $TMPDIR or /tmp.
 
3087
 
 
3088
    :Examples:
 
3089
        Run only tests relating to 'ignore'::
 
3090
 
 
3091
            bzr selftest ignore
 
3092
 
 
3093
        Disable plugins and list tests as they're run::
 
3094
 
 
3095
            bzr --no-plugins selftest -v
 
3096
    """
 
3097
    # NB: this is used from the class without creating an instance, which is
 
3098
    # why it does not have a self parameter.
 
3099
    def get_transport_type(typestring):
 
3100
        """Parse and return a transport specifier."""
 
3101
        if typestring == "sftp":
 
3102
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
3103
            return SFTPAbsoluteServer
 
3104
        if typestring == "memory":
 
3105
            from bzrlib.transport.memory import MemoryServer
 
3106
            return MemoryServer
 
3107
        if typestring == "fakenfs":
 
3108
            from bzrlib.transport.fakenfs import FakeNFSServer
 
3109
            return FakeNFSServer
 
3110
        msg = "No known transport type %s. Supported types are: sftp\n" %\
 
3111
            (typestring)
 
3112
        raise errors.BzrCommandError(msg)
 
3113
 
 
3114
    hidden = True
 
3115
    takes_args = ['testspecs*']
 
3116
    takes_options = ['verbose',
 
3117
                     Option('one',
 
3118
                             help='Stop when one test fails.',
 
3119
                             short_name='1',
 
3120
                             ),
 
3121
                     Option('transport',
 
3122
                            help='Use a different transport by default '
 
3123
                                 'throughout the test suite.',
 
3124
                            type=get_transport_type),
 
3125
                     Option('benchmark',
 
3126
                            help='Run the benchmarks rather than selftests.'),
 
3127
                     Option('lsprof-timed',
 
3128
                            help='Generate lsprof output for benchmarked'
 
3129
                                 ' sections of code.'),
 
3130
                     Option('cache-dir', type=str,
 
3131
                            help='Cache intermediate benchmark output in this '
 
3132
                                 'directory.'),
 
3133
                     Option('first',
 
3134
                            help='Run all tests, but run specified tests first.',
 
3135
                            short_name='f',
 
3136
                            ),
 
3137
                     Option('list-only',
 
3138
                            help='List the tests instead of running them.'),
 
3139
                     Option('randomize', type=str, argname="SEED",
 
3140
                            help='Randomize the order of tests using the given'
 
3141
                                 ' seed or "now" for the current time.'),
 
3142
                     Option('exclude', type=str, argname="PATTERN",
 
3143
                            short_name='x',
 
3144
                            help='Exclude tests that match this regular'
 
3145
                                 ' expression.'),
 
3146
                     Option('strict', help='Fail on missing dependencies or '
 
3147
                            'known failures.'),
 
3148
                     Option('load-list', type=str, argname='TESTLISTFILE',
 
3149
                            help='Load a test id list from a text file.'),
 
3150
                     ListOption('debugflag', type=str, short_name='E',
 
3151
                                help='Turn on a selftest debug flag.'),
 
3152
                     ListOption('starting-with', type=str, argname='TESTID',
 
3153
                                param_name='starting_with', short_name='s',
 
3154
                                help=
 
3155
                                'Load only the tests starting with TESTID.'),
 
3156
                     ]
 
3157
    encoding_type = 'replace'
 
3158
 
 
3159
    def __init__(self):
 
3160
        Command.__init__(self)
 
3161
        self.additional_selftest_args = {}
 
3162
 
 
3163
    def run(self, testspecs_list=None, verbose=False, one=False,
 
3164
            transport=None, benchmark=None,
 
3165
            lsprof_timed=None, cache_dir=None,
 
3166
            first=False, list_only=False,
 
3167
            randomize=None, exclude=None, strict=False,
 
3168
            load_list=None, debugflag=None, starting_with=None):
 
3169
        from bzrlib.tests import selftest
 
3170
        import bzrlib.benchmarks as benchmarks
 
3171
        from bzrlib.benchmarks import tree_creator
 
3172
 
 
3173
        # Make deprecation warnings visible, unless -Werror is set
 
3174
        symbol_versioning.activate_deprecation_warnings(override=False)
 
3175
 
 
3176
        if cache_dir is not None:
 
3177
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
 
3178
        if not list_only:
 
3179
            print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
 
3180
            print '   %s (%s python%s)' % (
 
3181
                    bzrlib.__path__[0],
 
3182
                    bzrlib.version_string,
 
3183
                    bzrlib._format_version_tuple(sys.version_info),
 
3184
                    )
 
3185
        print
 
3186
        if testspecs_list is not None:
 
3187
            pattern = '|'.join(testspecs_list)
 
3188
        else:
 
3189
            pattern = ".*"
 
3190
        if benchmark:
 
3191
            test_suite_factory = benchmarks.test_suite
 
3192
            # Unless user explicitly asks for quiet, be verbose in benchmarks
 
3193
            verbose = not is_quiet()
 
3194
            # TODO: should possibly lock the history file...
 
3195
            benchfile = open(".perf_history", "at", buffering=1)
 
3196
        else:
 
3197
            test_suite_factory = None
 
3198
            benchfile = None
 
3199
        try:
 
3200
            selftest_kwargs = {"verbose": verbose,
 
3201
                              "pattern": pattern,
 
3202
                              "stop_on_failure": one,
 
3203
                              "transport": transport,
 
3204
                              "test_suite_factory": test_suite_factory,
 
3205
                              "lsprof_timed": lsprof_timed,
 
3206
                              "bench_history": benchfile,
 
3207
                              "matching_tests_first": first,
 
3208
                              "list_only": list_only,
 
3209
                              "random_seed": randomize,
 
3210
                              "exclude_pattern": exclude,
 
3211
                              "strict": strict,
 
3212
                              "load_list": load_list,
 
3213
                              "debug_flags": debugflag,
 
3214
                              "starting_with": starting_with
 
3215
                              }
 
3216
            selftest_kwargs.update(self.additional_selftest_args)
 
3217
            result = selftest(**selftest_kwargs)
 
3218
        finally:
 
3219
            if benchfile is not None:
 
3220
                benchfile.close()
 
3221
        if result:
 
3222
            note('tests passed')
 
3223
        else:
 
3224
            note('tests failed')
 
3225
        return int(not result)
 
3226
 
 
3227
 
 
3228
class cmd_version(Command):
 
3229
    """Show version of bzr."""
 
3230
 
 
3231
    encoding_type = 'replace'
 
3232
    takes_options = [
 
3233
        Option("short", help="Print just the version number."),
 
3234
        ]
 
3235
 
 
3236
    @display_command
 
3237
    def run(self, short=False):
 
3238
        from bzrlib.version import show_version
 
3239
        if short:
 
3240
            self.outf.write(bzrlib.version_string + '\n')
 
3241
        else:
 
3242
            show_version(to_file=self.outf)
 
3243
 
 
3244
 
 
3245
class cmd_rocks(Command):
 
3246
    """Statement of optimism."""
 
3247
 
 
3248
    hidden = True
 
3249
 
 
3250
    @display_command
 
3251
    def run(self):
 
3252
        print "It sure does!"
 
3253
 
 
3254
 
 
3255
class cmd_find_merge_base(Command):
 
3256
    """Find and print a base revision for merging two branches."""
 
3257
    # TODO: Options to specify revisions on either side, as if
 
3258
    #       merging only part of the history.
 
3259
    takes_args = ['branch', 'other']
 
3260
    hidden = True
 
3261
 
 
3262
    @display_command
 
3263
    def run(self, branch, other):
 
3264
        from bzrlib.revision import ensure_null
 
3265
 
 
3266
        branch1 = Branch.open_containing(branch)[0]
 
3267
        branch2 = Branch.open_containing(other)[0]
 
3268
        branch1.lock_read()
 
3269
        try:
 
3270
            branch2.lock_read()
 
3271
            try:
 
3272
                last1 = ensure_null(branch1.last_revision())
 
3273
                last2 = ensure_null(branch2.last_revision())
 
3274
 
 
3275
                graph = branch1.repository.get_graph(branch2.repository)
 
3276
                base_rev_id = graph.find_unique_lca(last1, last2)
 
3277
 
 
3278
                print 'merge base is revision %s' % base_rev_id
 
3279
            finally:
 
3280
                branch2.unlock()
 
3281
        finally:
 
3282
            branch1.unlock()
 
3283
 
 
3284
 
 
3285
class cmd_merge(Command):
 
3286
    """Perform a three-way merge.
 
3287
 
 
3288
    The source of the merge can be specified either in the form of a branch,
 
3289
    or in the form of a path to a file containing a merge directive generated
 
3290
    with bzr send. If neither is specified, the default is the upstream branch
 
3291
    or the branch most recently merged using --remember.
 
3292
 
 
3293
    When merging a branch, by default the tip will be merged. To pick a different
 
3294
    revision, pass --revision. If you specify two values, the first will be used as
 
3295
    BASE and the second one as OTHER. Merging individual revisions, or a subset of
 
3296
    available revisions, like this is commonly referred to as "cherrypicking".
 
3297
 
 
3298
    Revision numbers are always relative to the branch being merged.
 
3299
 
 
3300
    By default, bzr will try to merge in all new work from the other
 
3301
    branch, automatically determining an appropriate base.  If this
 
3302
    fails, you may need to give an explicit base.
 
3303
 
 
3304
    Merge will do its best to combine the changes in two branches, but there
 
3305
    are some kinds of problems only a human can fix.  When it encounters those,
 
3306
    it will mark a conflict.  A conflict means that you need to fix something,
 
3307
    before you should commit.
 
3308
 
 
3309
    Use bzr resolve when you have fixed a problem.  See also bzr conflicts.
 
3310
 
 
3311
    If there is no default branch set, the first merge will set it. After
 
3312
    that, you can omit the branch to use the default.  To change the
 
3313
    default, use --remember. The value will only be saved if the remote
 
3314
    location can be accessed.
 
3315
 
 
3316
    The results of the merge are placed into the destination working
 
3317
    directory, where they can be reviewed (with bzr diff), tested, and then
 
3318
    committed to record the result of the merge.
 
3319
 
 
3320
    merge refuses to run if there are any uncommitted changes, unless
 
3321
    --force is given.
 
3322
 
 
3323
    :Examples:
 
3324
        To merge the latest revision from bzr.dev::
 
3325
 
 
3326
            bzr merge ../bzr.dev
 
3327
 
 
3328
        To merge changes up to and including revision 82 from bzr.dev::
 
3329
 
 
3330
            bzr merge -r 82 ../bzr.dev
 
3331
 
 
3332
        To merge the changes introduced by 82, without previous changes::
 
3333
 
 
3334
            bzr merge -r 81..82 ../bzr.dev
 
3335
 
 
3336
        To apply a merge directive contained in in /tmp/merge:
 
3337
 
 
3338
            bzr merge /tmp/merge
 
3339
    """
 
3340
 
 
3341
    encoding_type = 'exact'
 
3342
    _see_also = ['update', 'remerge', 'status-flags', 'send']
 
3343
    takes_args = ['location?']
 
3344
    takes_options = [
 
3345
        'change',
 
3346
        'revision',
 
3347
        Option('force',
 
3348
               help='Merge even if the destination tree has uncommitted changes.'),
 
3349
        'merge-type',
 
3350
        'reprocess',
 
3351
        'remember',
 
3352
        Option('show-base', help="Show base revision text in "
 
3353
               "conflicts."),
 
3354
        Option('uncommitted', help='Apply uncommitted changes'
 
3355
               ' from a working copy, instead of branch changes.'),
 
3356
        Option('pull', help='If the destination is already'
 
3357
                ' completely merged into the source, pull from the'
 
3358
                ' source rather than merging.  When this happens,'
 
3359
                ' you do not need to commit the result.'),
 
3360
        Option('directory',
 
3361
               help='Branch to merge into, '
 
3362
                    'rather than the one containing the working directory.',
 
3363
               short_name='d',
 
3364
               type=unicode,
 
3365
               ),
 
3366
        Option('preview', help='Instead of merging, show a diff of the merge.')
 
3367
    ]
 
3368
 
 
3369
    def run(self, location=None, revision=None, force=False,
 
3370
            merge_type=None, show_base=False, reprocess=None, remember=False,
 
3371
            uncommitted=False, pull=False,
 
3372
            directory=None,
 
3373
            preview=False,
 
3374
            ):
 
3375
        if merge_type is None:
 
3376
            merge_type = _mod_merge.Merge3Merger
 
3377
 
 
3378
        if directory is None: directory = u'.'
 
3379
        possible_transports = []
 
3380
        merger = None
 
3381
        allow_pending = True
 
3382
        verified = 'inapplicable'
 
3383
        tree = WorkingTree.open_containing(directory)[0]
 
3384
 
 
3385
        # die as quickly as possible if there are uncommitted changes
 
3386
        try:
 
3387
            basis_tree = tree.revision_tree(tree.last_revision())
 
3388
        except errors.NoSuchRevision:
 
3389
            basis_tree = tree.basis_tree()
 
3390
        if not force:
 
3391
            changes = tree.changes_from(basis_tree)
 
3392
            if changes.has_changed():
 
3393
                raise errors.UncommittedChanges(tree)
 
3394
 
 
3395
        view_info = _get_view_info_for_change_reporter(tree)
 
3396
        change_reporter = delta._ChangeReporter(
 
3397
            unversioned_filter=tree.is_ignored, view_info=view_info)
 
3398
        cleanups = []
 
3399
        try:
 
3400
            pb = ui.ui_factory.nested_progress_bar()
 
3401
            cleanups.append(pb.finished)
 
3402
            tree.lock_write()
 
3403
            cleanups.append(tree.unlock)
 
3404
            if location is not None:
 
3405
                try:
 
3406
                    mergeable = bundle.read_mergeable_from_url(location,
 
3407
                        possible_transports=possible_transports)
 
3408
                except errors.NotABundle:
 
3409
                    mergeable = None
 
3410
                else:
 
3411
                    if uncommitted:
 
3412
                        raise errors.BzrCommandError('Cannot use --uncommitted'
 
3413
                            ' with bundles or merge directives.')
 
3414
 
 
3415
                    if revision is not None:
 
3416
                        raise errors.BzrCommandError(
 
3417
                            'Cannot use -r with merge directives or bundles')
 
3418
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
3419
                       mergeable, pb)
 
3420
 
 
3421
            if merger is None and uncommitted:
 
3422
                if revision is not None and len(revision) > 0:
 
3423
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
 
3424
                        ' --revision at the same time.')
 
3425
                location = self._select_branch_location(tree, location)[0]
 
3426
                other_tree, other_path = WorkingTree.open_containing(location)
 
3427
                merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
 
3428
                    pb)
 
3429
                allow_pending = False
 
3430
                if other_path != '':
 
3431
                    merger.interesting_files = [other_path]
 
3432
 
 
3433
            if merger is None:
 
3434
                merger, allow_pending = self._get_merger_from_branch(tree,
 
3435
                    location, revision, remember, possible_transports, pb)
 
3436
 
 
3437
            merger.merge_type = merge_type
 
3438
            merger.reprocess = reprocess
 
3439
            merger.show_base = show_base
 
3440
            self.sanity_check_merger(merger)
 
3441
            if (merger.base_rev_id == merger.other_rev_id and
 
3442
                merger.other_rev_id is not None):
 
3443
                note('Nothing to do.')
 
3444
                return 0
 
3445
            if pull:
 
3446
                if merger.interesting_files is not None:
 
3447
                    raise errors.BzrCommandError('Cannot pull individual files')
 
3448
                if (merger.base_rev_id == tree.last_revision()):
 
3449
                    result = tree.pull(merger.other_branch, False,
 
3450
                                       merger.other_rev_id)
 
3451
                    result.report(self.outf)
 
3452
                    return 0
 
3453
            merger.check_basis(False)
 
3454
            if preview:
 
3455
                return self._do_preview(merger)
 
3456
            else:
 
3457
                return self._do_merge(merger, change_reporter, allow_pending,
 
3458
                                      verified)
 
3459
        finally:
 
3460
            for cleanup in reversed(cleanups):
 
3461
                cleanup()
 
3462
 
 
3463
    def _do_preview(self, merger):
 
3464
        from bzrlib.diff import show_diff_trees
 
3465
        tree_merger = merger.make_merger()
 
3466
        tt = tree_merger.make_preview_transform()
 
3467
        try:
 
3468
            result_tree = tt.get_preview_tree()
 
3469
            show_diff_trees(merger.this_tree, result_tree, self.outf,
 
3470
                            old_label='', new_label='')
 
3471
        finally:
 
3472
            tt.finalize()
 
3473
 
 
3474
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
 
3475
        merger.change_reporter = change_reporter
 
3476
        conflict_count = merger.do_merge()
 
3477
        if allow_pending:
 
3478
            merger.set_pending()
 
3479
        if verified == 'failed':
 
3480
            warning('Preview patch does not match changes')
 
3481
        if conflict_count != 0:
 
3482
            return 1
 
3483
        else:
 
3484
            return 0
 
3485
 
 
3486
    def sanity_check_merger(self, merger):
 
3487
        if (merger.show_base and
 
3488
            not merger.merge_type is _mod_merge.Merge3Merger):
 
3489
            raise errors.BzrCommandError("Show-base is not supported for this"
 
3490
                                         " merge type. %s" % merger.merge_type)
 
3491
        if merger.reprocess is None:
 
3492
            if merger.show_base:
 
3493
                merger.reprocess = False
 
3494
            else:
 
3495
                # Use reprocess if the merger supports it
 
3496
                merger.reprocess = merger.merge_type.supports_reprocess
 
3497
        if merger.reprocess and not merger.merge_type.supports_reprocess:
 
3498
            raise errors.BzrCommandError("Conflict reduction is not supported"
 
3499
                                         " for merge type %s." %
 
3500
                                         merger.merge_type)
 
3501
        if merger.reprocess and merger.show_base:
 
3502
            raise errors.BzrCommandError("Cannot do conflict reduction and"
 
3503
                                         " show base.")
 
3504
 
 
3505
    def _get_merger_from_branch(self, tree, location, revision, remember,
 
3506
                                possible_transports, pb):
 
3507
        """Produce a merger from a location, assuming it refers to a branch."""
 
3508
        from bzrlib.tag import _merge_tags_if_possible
 
3509
        # find the branch locations
 
3510
        other_loc, user_location = self._select_branch_location(tree, location,
 
3511
            revision, -1)
 
3512
        if revision is not None and len(revision) == 2:
 
3513
            base_loc, _unused = self._select_branch_location(tree,
 
3514
                location, revision, 0)
 
3515
        else:
 
3516
            base_loc = other_loc
 
3517
        # Open the branches
 
3518
        other_branch, other_path = Branch.open_containing(other_loc,
 
3519
            possible_transports)
 
3520
        if base_loc == other_loc:
 
3521
            base_branch = other_branch
 
3522
        else:
 
3523
            base_branch, base_path = Branch.open_containing(base_loc,
 
3524
                possible_transports)
 
3525
        # Find the revision ids
 
3526
        if revision is None or len(revision) < 1 or revision[-1] is None:
 
3527
            other_revision_id = _mod_revision.ensure_null(
 
3528
                other_branch.last_revision())
 
3529
        else:
 
3530
            other_revision_id = revision[-1].as_revision_id(other_branch)
 
3531
        if (revision is not None and len(revision) == 2
 
3532
            and revision[0] is not None):
 
3533
            base_revision_id = revision[0].as_revision_id(base_branch)
 
3534
        else:
 
3535
            base_revision_id = None
 
3536
        # Remember where we merge from
 
3537
        if ((remember or tree.branch.get_submit_branch() is None) and
 
3538
             user_location is not None):
 
3539
            tree.branch.set_submit_branch(other_branch.base)
 
3540
        _merge_tags_if_possible(other_branch, tree.branch)
 
3541
        merger = _mod_merge.Merger.from_revision_ids(pb, tree,
 
3542
            other_revision_id, base_revision_id, other_branch, base_branch)
 
3543
        if other_path != '':
 
3544
            allow_pending = False
 
3545
            merger.interesting_files = [other_path]
 
3546
        else:
 
3547
            allow_pending = True
 
3548
        return merger, allow_pending
 
3549
 
 
3550
    def _select_branch_location(self, tree, user_location, revision=None,
 
3551
                                index=None):
 
3552
        """Select a branch location, according to possible inputs.
 
3553
 
 
3554
        If provided, branches from ``revision`` are preferred.  (Both
 
3555
        ``revision`` and ``index`` must be supplied.)
 
3556
 
 
3557
        Otherwise, the ``location`` parameter is used.  If it is None, then the
 
3558
        ``submit`` or ``parent`` location is used, and a note is printed.
 
3559
 
 
3560
        :param tree: The working tree to select a branch for merging into
 
3561
        :param location: The location entered by the user
 
3562
        :param revision: The revision parameter to the command
 
3563
        :param index: The index to use for the revision parameter.  Negative
 
3564
            indices are permitted.
 
3565
        :return: (selected_location, user_location).  The default location
 
3566
            will be the user-entered location.
 
3567
        """
 
3568
        if (revision is not None and index is not None
 
3569
            and revision[index] is not None):
 
3570
            branch = revision[index].get_branch()
 
3571
            if branch is not None:
 
3572
                return branch, branch
 
3573
        if user_location is None:
 
3574
            location = self._get_remembered(tree, 'Merging from')
 
3575
        else:
 
3576
            location = user_location
 
3577
        return location, user_location
 
3578
 
 
3579
    def _get_remembered(self, tree, verb_string):
 
3580
        """Use tree.branch's parent if none was supplied.
 
3581
 
 
3582
        Report if the remembered location was used.
 
3583
        """
 
3584
        stored_location = tree.branch.get_submit_branch()
 
3585
        stored_location_type = "submit"
 
3586
        if stored_location is None:
 
3587
            stored_location = tree.branch.get_parent()
 
3588
            stored_location_type = "parent"
 
3589
        mutter("%s", stored_location)
 
3590
        if stored_location is None:
 
3591
            raise errors.BzrCommandError("No location specified or remembered")
 
3592
        display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
 
3593
        note(u"%s remembered %s location %s", verb_string,
 
3594
                stored_location_type, display_url)
 
3595
        return stored_location
 
3596
 
 
3597
 
 
3598
class cmd_remerge(Command):
 
3599
    """Redo a merge.
 
3600
 
 
3601
    Use this if you want to try a different merge technique while resolving
 
3602
    conflicts.  Some merge techniques are better than others, and remerge
 
3603
    lets you try different ones on different files.
 
3604
 
 
3605
    The options for remerge have the same meaning and defaults as the ones for
 
3606
    merge.  The difference is that remerge can (only) be run when there is a
 
3607
    pending merge, and it lets you specify particular files.
 
3608
 
 
3609
    :Examples:
 
3610
        Re-do the merge of all conflicted files, and show the base text in
 
3611
        conflict regions, in addition to the usual THIS and OTHER texts::
 
3612
 
 
3613
            bzr remerge --show-base
 
3614
 
 
3615
        Re-do the merge of "foobar", using the weave merge algorithm, with
 
3616
        additional processing to reduce the size of conflict regions::
 
3617
 
 
3618
            bzr remerge --merge-type weave --reprocess foobar
 
3619
    """
 
3620
    takes_args = ['file*']
 
3621
    takes_options = [
 
3622
            'merge-type',
 
3623
            'reprocess',
 
3624
            Option('show-base',
 
3625
                   help="Show base revision text in conflicts."),
 
3626
            ]
 
3627
 
 
3628
    def run(self, file_list=None, merge_type=None, show_base=False,
 
3629
            reprocess=False):
 
3630
        if merge_type is None:
 
3631
            merge_type = _mod_merge.Merge3Merger
 
3632
        tree, file_list = tree_files(file_list)
 
3633
        tree.lock_write()
 
3634
        try:
 
3635
            parents = tree.get_parent_ids()
 
3636
            if len(parents) != 2:
 
3637
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
3638
                                             " merges.  Not cherrypicking or"
 
3639
                                             " multi-merges.")
 
3640
            repository = tree.branch.repository
 
3641
            interesting_ids = None
 
3642
            new_conflicts = []
 
3643
            conflicts = tree.conflicts()
 
3644
            if file_list is not None:
 
3645
                interesting_ids = set()
 
3646
                for filename in file_list:
 
3647
                    file_id = tree.path2id(filename)
 
3648
                    if file_id is None:
 
3649
                        raise errors.NotVersionedError(filename)
 
3650
                    interesting_ids.add(file_id)
 
3651
                    if tree.kind(file_id) != "directory":
 
3652
                        continue
 
3653
 
 
3654
                    for name, ie in tree.inventory.iter_entries(file_id):
 
3655
                        interesting_ids.add(ie.file_id)
 
3656
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
3657
            else:
 
3658
                # Remerge only supports resolving contents conflicts
 
3659
                allowed_conflicts = ('text conflict', 'contents conflict')
 
3660
                restore_files = [c.path for c in conflicts
 
3661
                                 if c.typestring in allowed_conflicts]
 
3662
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
3663
            tree.set_conflicts(ConflictList(new_conflicts))
 
3664
            if file_list is not None:
 
3665
                restore_files = file_list
 
3666
            for filename in restore_files:
 
3667
                try:
 
3668
                    restore(tree.abspath(filename))
 
3669
                except errors.NotConflicted:
 
3670
                    pass
 
3671
            # Disable pending merges, because the file texts we are remerging
 
3672
            # have not had those merges performed.  If we use the wrong parents
 
3673
            # list, we imply that the working tree text has seen and rejected
 
3674
            # all the changes from the other tree, when in fact those changes
 
3675
            # have not yet been seen.
 
3676
            pb = ui.ui_factory.nested_progress_bar()
 
3677
            tree.set_parent_ids(parents[:1])
 
3678
            try:
 
3679
                merger = _mod_merge.Merger.from_revision_ids(pb,
 
3680
                                                             tree, parents[1])
 
3681
                merger.interesting_ids = interesting_ids
 
3682
                merger.merge_type = merge_type
 
3683
                merger.show_base = show_base
 
3684
                merger.reprocess = reprocess
 
3685
                conflicts = merger.do_merge()
 
3686
            finally:
 
3687
                tree.set_parent_ids(parents)
 
3688
                pb.finished()
 
3689
        finally:
 
3690
            tree.unlock()
 
3691
        if conflicts > 0:
 
3692
            return 1
 
3693
        else:
 
3694
            return 0
 
3695
 
 
3696
 
 
3697
class cmd_revert(Command):
 
3698
    """Revert files to a previous revision.
 
3699
 
 
3700
    Giving a list of files will revert only those files.  Otherwise, all files
 
3701
    will be reverted.  If the revision is not specified with '--revision', the
 
3702
    last committed revision is used.
 
3703
 
 
3704
    To remove only some changes, without reverting to a prior version, use
 
3705
    merge instead.  For example, "merge . --revision -2..-3" will remove the
 
3706
    changes introduced by -2, without affecting the changes introduced by -1.
 
3707
    Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
 
3708
 
 
3709
    By default, any files that have been manually changed will be backed up
 
3710
    first.  (Files changed only by merge are not backed up.)  Backup files have
 
3711
    '.~#~' appended to their name, where # is a number.
 
3712
 
 
3713
    When you provide files, you can use their current pathname or the pathname
 
3714
    from the target revision.  So you can use revert to "undelete" a file by
 
3715
    name.  If you name a directory, all the contents of that directory will be
 
3716
    reverted.
 
3717
 
 
3718
    Any files that have been newly added since that revision will be deleted,
 
3719
    with a backup kept if appropriate.  Directories containing unknown files
 
3720
    will not be deleted.
 
3721
 
 
3722
    The working tree contains a list of pending merged revisions, which will
 
3723
    be included as parents in the next commit.  Normally, revert clears that
 
3724
    list as well as reverting the files.  If any files are specified, revert
 
3725
    leaves the pending merge list alone and reverts only the files.  Use "bzr
 
3726
    revert ." in the tree root to revert all files but keep the merge record,
 
3727
    and "bzr revert --forget-merges" to clear the pending merge list without
 
3728
    reverting any files.
 
3729
    """
 
3730
 
 
3731
    _see_also = ['cat', 'export']
 
3732
    takes_options = [
 
3733
        'revision',
 
3734
        Option('no-backup', "Do not save backups of reverted files."),
 
3735
        Option('forget-merges',
 
3736
               'Remove pending merge marker, without changing any files.'),
 
3737
        ]
 
3738
    takes_args = ['file*']
 
3739
 
 
3740
    def run(self, revision=None, no_backup=False, file_list=None,
 
3741
            forget_merges=None):
 
3742
        tree, file_list = tree_files(file_list)
 
3743
        tree.lock_write()
 
3744
        try:
 
3745
            if forget_merges:
 
3746
                tree.set_parent_ids(tree.get_parent_ids()[:1])
 
3747
            else:
 
3748
                self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
3749
        finally:
 
3750
            tree.unlock()
 
3751
 
 
3752
    @staticmethod
 
3753
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
 
3754
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
 
3755
        pb = ui.ui_factory.nested_progress_bar()
 
3756
        try:
 
3757
            tree.revert(file_list, rev_tree, not no_backup, pb,
 
3758
                report_changes=True)
 
3759
        finally:
 
3760
            pb.finished()
 
3761
 
 
3762
 
 
3763
class cmd_assert_fail(Command):
 
3764
    """Test reporting of assertion failures"""
 
3765
    # intended just for use in testing
 
3766
 
 
3767
    hidden = True
 
3768
 
 
3769
    def run(self):
 
3770
        raise AssertionError("always fails")
 
3771
 
 
3772
 
 
3773
class cmd_help(Command):
 
3774
    """Show help on a command or other topic.
 
3775
    """
 
3776
 
 
3777
    _see_also = ['topics']
 
3778
    takes_options = [
 
3779
            Option('long', 'Show help on all commands.'),
 
3780
            ]
 
3781
    takes_args = ['topic?']
 
3782
    aliases = ['?', '--help', '-?', '-h']
 
3783
 
 
3784
    @display_command
 
3785
    def run(self, topic=None, long=False):
 
3786
        import bzrlib.help
 
3787
        if topic is None and long:
 
3788
            topic = "commands"
 
3789
        bzrlib.help.help(topic)
 
3790
 
 
3791
 
 
3792
class cmd_shell_complete(Command):
 
3793
    """Show appropriate completions for context.
 
3794
 
 
3795
    For a list of all available commands, say 'bzr shell-complete'.
 
3796
    """
 
3797
    takes_args = ['context?']
 
3798
    aliases = ['s-c']
 
3799
    hidden = True
 
3800
 
 
3801
    @display_command
 
3802
    def run(self, context=None):
 
3803
        import shellcomplete
 
3804
        shellcomplete.shellcomplete(context)
 
3805
 
 
3806
 
 
3807
class cmd_missing(Command):
 
3808
    """Show unmerged/unpulled revisions between two branches.
 
3809
 
 
3810
    OTHER_BRANCH may be local or remote.
 
3811
 
 
3812
    To filter on a range of revisions, you can use the command -r begin..end
 
3813
    -r revision requests a specific revision, -r ..end or -r begin.. are
 
3814
    also valid.
 
3815
 
 
3816
    :Examples:
 
3817
 
 
3818
        Determine the missing revisions between this and the branch at the
 
3819
        remembered pull location::
 
3820
 
 
3821
            bzr missing
 
3822
 
 
3823
        Determine the missing revisions between this and another branch::
 
3824
 
 
3825
            bzr missing http://server/branch
 
3826
 
 
3827
        Determine the missing revisions up to a specific revision on the other
 
3828
        branch::
 
3829
 
 
3830
            bzr missing -r ..-10
 
3831
 
 
3832
        Determine the missing revisions up to a specific revision on this
 
3833
        branch::
 
3834
 
 
3835
            bzr missing --my-revision ..-10
 
3836
    """
 
3837
 
 
3838
    _see_also = ['merge', 'pull']
 
3839
    takes_args = ['other_branch?']
 
3840
    takes_options = [
 
3841
        Option('reverse', 'Reverse the order of revisions.'),
 
3842
        Option('mine-only',
 
3843
               'Display changes in the local branch only.'),
 
3844
        Option('this' , 'Same as --mine-only.'),
 
3845
        Option('theirs-only',
 
3846
               'Display changes in the remote branch only.'),
 
3847
        Option('other', 'Same as --theirs-only.'),
 
3848
        'log-format',
 
3849
        'show-ids',
 
3850
        'verbose',
 
3851
        custom_help('revision',
 
3852
             help='Filter on other branch revisions (inclusive). '
 
3853
                'See "help revisionspec" for details.'),
 
3854
        Option('my-revision',
 
3855
            type=_parse_revision_str,
 
3856
            help='Filter on local branch revisions (inclusive). '
 
3857
                'See "help revisionspec" for details.'),
 
3858
        Option('include-merges', 'Show merged revisions.'),
 
3859
        ]
 
3860
    encoding_type = 'replace'
 
3861
 
 
3862
    @display_command
 
3863
    def run(self, other_branch=None, reverse=False, mine_only=False,
 
3864
            theirs_only=False,
 
3865
            log_format=None, long=False, short=False, line=False,
 
3866
            show_ids=False, verbose=False, this=False, other=False,
 
3867
            include_merges=False, revision=None, my_revision=None):
 
3868
        from bzrlib.missing import find_unmerged, iter_log_revisions
 
3869
        def message(s):
 
3870
            if not is_quiet():
 
3871
                self.outf.write(s)
 
3872
 
 
3873
        if this:
 
3874
            mine_only = this
 
3875
        if other:
 
3876
            theirs_only = other
 
3877
        # TODO: We should probably check that we don't have mine-only and
 
3878
        #       theirs-only set, but it gets complicated because we also have
 
3879
        #       this and other which could be used.
 
3880
        restrict = 'all'
 
3881
        if mine_only:
 
3882
            restrict = 'local'
 
3883
        elif theirs_only:
 
3884
            restrict = 'remote'
 
3885
 
 
3886
        local_branch = Branch.open_containing(u".")[0]
 
3887
        parent = local_branch.get_parent()
 
3888
        if other_branch is None:
 
3889
            other_branch = parent
 
3890
            if other_branch is None:
 
3891
                raise errors.BzrCommandError("No peer location known"
 
3892
                                             " or specified.")
 
3893
            display_url = urlutils.unescape_for_display(parent,
 
3894
                                                        self.outf.encoding)
 
3895
            message("Using saved parent location: "
 
3896
                    + display_url + "\n")
 
3897
 
 
3898
        remote_branch = Branch.open(other_branch)
 
3899
        if remote_branch.base == local_branch.base:
 
3900
            remote_branch = local_branch
 
3901
 
 
3902
        local_revid_range = _revision_range_to_revid_range(
 
3903
            _get_revision_range(my_revision, local_branch,
 
3904
                self.name()))
 
3905
 
 
3906
        remote_revid_range = _revision_range_to_revid_range(
 
3907
            _get_revision_range(revision,
 
3908
                remote_branch, self.name()))
 
3909
 
 
3910
        local_branch.lock_read()
 
3911
        try:
 
3912
            remote_branch.lock_read()
 
3913
            try:
 
3914
                local_extra, remote_extra = find_unmerged(
 
3915
                    local_branch, remote_branch, restrict,
 
3916
                    backward=not reverse,
 
3917
                    include_merges=include_merges,
 
3918
                    local_revid_range=local_revid_range,
 
3919
                    remote_revid_range=remote_revid_range)
 
3920
 
 
3921
                if log_format is None:
 
3922
                    registry = log.log_formatter_registry
 
3923
                    log_format = registry.get_default(local_branch)
 
3924
                lf = log_format(to_file=self.outf,
 
3925
                                show_ids=show_ids,
 
3926
                                show_timezone='original')
 
3927
 
 
3928
                status_code = 0
 
3929
                if local_extra and not theirs_only:
 
3930
                    message("You have %d extra revision(s):\n" %
 
3931
                        len(local_extra))
 
3932
                    for revision in iter_log_revisions(local_extra,
 
3933
                                        local_branch.repository,
 
3934
                                        verbose):
 
3935
                        lf.log_revision(revision)
 
3936
                    printed_local = True
 
3937
                    status_code = 1
 
3938
                else:
 
3939
                    printed_local = False
 
3940
 
 
3941
                if remote_extra and not mine_only:
 
3942
                    if printed_local is True:
 
3943
                        message("\n\n\n")
 
3944
                    message("You are missing %d revision(s):\n" %
 
3945
                        len(remote_extra))
 
3946
                    for revision in iter_log_revisions(remote_extra,
 
3947
                                        remote_branch.repository,
 
3948
                                        verbose):
 
3949
                        lf.log_revision(revision)
 
3950
                    status_code = 1
 
3951
 
 
3952
                if mine_only and not local_extra:
 
3953
                    # We checked local, and found nothing extra
 
3954
                    message('This branch is up to date.\n')
 
3955
                elif theirs_only and not remote_extra:
 
3956
                    # We checked remote, and found nothing extra
 
3957
                    message('Other branch is up to date.\n')
 
3958
                elif not (mine_only or theirs_only or local_extra or
 
3959
                          remote_extra):
 
3960
                    # We checked both branches, and neither one had extra
 
3961
                    # revisions
 
3962
                    message("Branches are up to date.\n")
 
3963
            finally:
 
3964
                remote_branch.unlock()
 
3965
        finally:
 
3966
            local_branch.unlock()
 
3967
        if not status_code and parent is None and other_branch is not None:
 
3968
            local_branch.lock_write()
 
3969
            try:
 
3970
                # handle race conditions - a parent might be set while we run.
 
3971
                if local_branch.get_parent() is None:
 
3972
                    local_branch.set_parent(remote_branch.base)
 
3973
            finally:
 
3974
                local_branch.unlock()
 
3975
        return status_code
 
3976
 
 
3977
 
 
3978
class cmd_pack(Command):
 
3979
    """Compress the data within a repository."""
 
3980
 
 
3981
    _see_also = ['repositories']
 
3982
    takes_args = ['branch_or_repo?']
 
3983
 
 
3984
    def run(self, branch_or_repo='.'):
 
3985
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
 
3986
        try:
 
3987
            branch = dir.open_branch()
 
3988
            repository = branch.repository
 
3989
        except errors.NotBranchError:
 
3990
            repository = dir.open_repository()
 
3991
        repository.pack()
 
3992
 
 
3993
 
 
3994
class cmd_plugins(Command):
 
3995
    """List the installed plugins.
 
3996
 
 
3997
    This command displays the list of installed plugins including
 
3998
    version of plugin and a short description of each.
 
3999
 
 
4000
    --verbose shows the path where each plugin is located.
 
4001
 
 
4002
    A plugin is an external component for Bazaar that extends the
 
4003
    revision control system, by adding or replacing code in Bazaar.
 
4004
    Plugins can do a variety of things, including overriding commands,
 
4005
    adding new commands, providing additional network transports and
 
4006
    customizing log output.
 
4007
 
 
4008
    See the Bazaar web site, http://bazaar-vcs.org, for further
 
4009
    information on plugins including where to find them and how to
 
4010
    install them. Instructions are also provided there on how to
 
4011
    write new plugins using the Python programming language.
 
4012
    """
 
4013
    takes_options = ['verbose']
 
4014
 
 
4015
    @display_command
 
4016
    def run(self, verbose=False):
 
4017
        import bzrlib.plugin
 
4018
        from inspect import getdoc
 
4019
        result = []
 
4020
        for name, plugin in bzrlib.plugin.plugins().items():
 
4021
            version = plugin.__version__
 
4022
            if version == 'unknown':
 
4023
                version = ''
 
4024
            name_ver = '%s %s' % (name, version)
 
4025
            d = getdoc(plugin.module)
 
4026
            if d:
 
4027
                doc = d.split('\n')[0]
 
4028
            else:
 
4029
                doc = '(no description)'
 
4030
            result.append((name_ver, doc, plugin.path()))
 
4031
        for name_ver, doc, path in sorted(result):
 
4032
            print name_ver
 
4033
            print '   ', doc
 
4034
            if verbose:
 
4035
                print '   ', path
 
4036
            print
 
4037
 
 
4038
 
 
4039
class cmd_testament(Command):
 
4040
    """Show testament (signing-form) of a revision."""
 
4041
    takes_options = [
 
4042
            'revision',
 
4043
            Option('long', help='Produce long-format testament.'),
 
4044
            Option('strict',
 
4045
                   help='Produce a strict-format testament.')]
 
4046
    takes_args = ['branch?']
 
4047
    @display_command
 
4048
    def run(self, branch=u'.', revision=None, long=False, strict=False):
 
4049
        from bzrlib.testament import Testament, StrictTestament
 
4050
        if strict is True:
 
4051
            testament_class = StrictTestament
 
4052
        else:
 
4053
            testament_class = Testament
 
4054
        if branch == '.':
 
4055
            b = Branch.open_containing(branch)[0]
 
4056
        else:
 
4057
            b = Branch.open(branch)
 
4058
        b.lock_read()
 
4059
        try:
 
4060
            if revision is None:
 
4061
                rev_id = b.last_revision()
 
4062
            else:
 
4063
                rev_id = revision[0].as_revision_id(b)
 
4064
            t = testament_class.from_revision(b.repository, rev_id)
 
4065
            if long:
 
4066
                sys.stdout.writelines(t.as_text_lines())
 
4067
            else:
 
4068
                sys.stdout.write(t.as_short_text())
 
4069
        finally:
 
4070
            b.unlock()
 
4071
 
 
4072
 
 
4073
class cmd_annotate(Command):
 
4074
    """Show the origin of each line in a file.
 
4075
 
 
4076
    This prints out the given file with an annotation on the left side
 
4077
    indicating which revision, author and date introduced the change.
 
4078
 
 
4079
    If the origin is the same for a run of consecutive lines, it is
 
4080
    shown only at the top, unless the --all option is given.
 
4081
    """
 
4082
    # TODO: annotate directories; showing when each file was last changed
 
4083
    # TODO: if the working copy is modified, show annotations on that
 
4084
    #       with new uncommitted lines marked
 
4085
    aliases = ['ann', 'blame', 'praise']
 
4086
    takes_args = ['filename']
 
4087
    takes_options = [Option('all', help='Show annotations on all lines.'),
 
4088
                     Option('long', help='Show commit date in annotations.'),
 
4089
                     'revision',
 
4090
                     'show-ids',
 
4091
                     ]
 
4092
    encoding_type = 'exact'
 
4093
 
 
4094
    @display_command
 
4095
    def run(self, filename, all=False, long=False, revision=None,
 
4096
            show_ids=False):
 
4097
        from bzrlib.annotate import annotate_file, annotate_file_tree
 
4098
        wt, branch, relpath = \
 
4099
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
4100
        if wt is not None:
 
4101
            wt.lock_read()
 
4102
        else:
 
4103
            branch.lock_read()
 
4104
        try:
 
4105
            tree = _get_one_revision_tree('annotate', revision, branch=branch)
 
4106
            if wt is not None:
 
4107
                file_id = wt.path2id(relpath)
 
4108
            else:
 
4109
                file_id = tree.path2id(relpath)
 
4110
            if file_id is None:
 
4111
                raise errors.NotVersionedError(filename)
 
4112
            file_version = tree.inventory[file_id].revision
 
4113
            if wt is not None and revision is None:
 
4114
                # If there is a tree and we're not annotating historical
 
4115
                # versions, annotate the working tree's content.
 
4116
                annotate_file_tree(wt, file_id, self.outf, long, all,
 
4117
                    show_ids=show_ids)
 
4118
            else:
 
4119
                annotate_file(branch, file_version, file_id, long, all, self.outf,
 
4120
                              show_ids=show_ids)
 
4121
        finally:
 
4122
            if wt is not None:
 
4123
                wt.unlock()
 
4124
            else:
 
4125
                branch.unlock()
 
4126
 
 
4127
 
 
4128
class cmd_re_sign(Command):
 
4129
    """Create a digital signature for an existing revision."""
 
4130
    # TODO be able to replace existing ones.
 
4131
 
 
4132
    hidden = True # is this right ?
 
4133
    takes_args = ['revision_id*']
 
4134
    takes_options = ['revision']
 
4135
 
 
4136
    def run(self, revision_id_list=None, revision=None):
 
4137
        if revision_id_list is not None and revision is not None:
 
4138
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
 
4139
        if revision_id_list is None and revision is None:
 
4140
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
 
4141
        b = WorkingTree.open_containing(u'.')[0].branch
 
4142
        b.lock_write()
 
4143
        try:
 
4144
            return self._run(b, revision_id_list, revision)
 
4145
        finally:
 
4146
            b.unlock()
 
4147
 
 
4148
    def _run(self, b, revision_id_list, revision):
 
4149
        import bzrlib.gpg as gpg
 
4150
        gpg_strategy = gpg.GPGStrategy(b.get_config())
 
4151
        if revision_id_list is not None:
 
4152
            b.repository.start_write_group()
 
4153
            try:
 
4154
                for revision_id in revision_id_list:
 
4155
                    b.repository.sign_revision(revision_id, gpg_strategy)
 
4156
            except:
 
4157
                b.repository.abort_write_group()
 
4158
                raise
 
4159
            else:
 
4160
                b.repository.commit_write_group()
 
4161
        elif revision is not None:
 
4162
            if len(revision) == 1:
 
4163
                revno, rev_id = revision[0].in_history(b)
 
4164
                b.repository.start_write_group()
 
4165
                try:
 
4166
                    b.repository.sign_revision(rev_id, gpg_strategy)
 
4167
                except:
 
4168
                    b.repository.abort_write_group()
 
4169
                    raise
 
4170
                else:
 
4171
                    b.repository.commit_write_group()
 
4172
            elif len(revision) == 2:
 
4173
                # are they both on rh- if so we can walk between them
 
4174
                # might be nice to have a range helper for arbitrary
 
4175
                # revision paths. hmm.
 
4176
                from_revno, from_revid = revision[0].in_history(b)
 
4177
                to_revno, to_revid = revision[1].in_history(b)
 
4178
                if to_revid is None:
 
4179
                    to_revno = b.revno()
 
4180
                if from_revno is None or to_revno is None:
 
4181
                    raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
 
4182
                b.repository.start_write_group()
 
4183
                try:
 
4184
                    for revno in range(from_revno, to_revno + 1):
 
4185
                        b.repository.sign_revision(b.get_rev_id(revno),
 
4186
                                                   gpg_strategy)
 
4187
                except:
 
4188
                    b.repository.abort_write_group()
 
4189
                    raise
 
4190
                else:
 
4191
                    b.repository.commit_write_group()
 
4192
            else:
 
4193
                raise errors.BzrCommandError('Please supply either one revision, or a range.')
 
4194
 
 
4195
 
 
4196
class cmd_bind(Command):
 
4197
    """Convert the current branch into a checkout of the supplied branch.
 
4198
 
 
4199
    Once converted into a checkout, commits must succeed on the master branch
 
4200
    before they will be applied to the local branch.
 
4201
 
 
4202
    Bound branches use the nickname of its master branch unless it is set
 
4203
    locally, in which case binding will update the the local nickname to be
 
4204
    that of the master.
 
4205
    """
 
4206
 
 
4207
    _see_also = ['checkouts', 'unbind']
 
4208
    takes_args = ['location?']
 
4209
    takes_options = []
 
4210
 
 
4211
    def run(self, location=None):
 
4212
        b, relpath = Branch.open_containing(u'.')
 
4213
        if location is None:
 
4214
            try:
 
4215
                location = b.get_old_bound_location()
 
4216
            except errors.UpgradeRequired:
 
4217
                raise errors.BzrCommandError('No location supplied.  '
 
4218
                    'This format does not remember old locations.')
 
4219
            else:
 
4220
                if location is None:
 
4221
                    raise errors.BzrCommandError('No location supplied and no '
 
4222
                        'previous location known')
 
4223
        b_other = Branch.open(location)
 
4224
        try:
 
4225
            b.bind(b_other)
 
4226
        except errors.DivergedBranches:
 
4227
            raise errors.BzrCommandError('These branches have diverged.'
 
4228
                                         ' Try merging, and then bind again.')
 
4229
        if b.get_config().has_explicit_nickname():
 
4230
            b.nick = b_other.nick
 
4231
 
 
4232
 
 
4233
class cmd_unbind(Command):
 
4234
    """Convert the current checkout into a regular branch.
 
4235
 
 
4236
    After unbinding, the local branch is considered independent and subsequent
 
4237
    commits will be local only.
 
4238
    """
 
4239
 
 
4240
    _see_also = ['checkouts', 'bind']
 
4241
    takes_args = []
 
4242
    takes_options = []
 
4243
 
 
4244
    def run(self):
 
4245
        b, relpath = Branch.open_containing(u'.')
 
4246
        if not b.unbind():
 
4247
            raise errors.BzrCommandError('Local branch is not bound')
 
4248
 
 
4249
 
 
4250
class cmd_uncommit(Command):
 
4251
    """Remove the last committed revision.
 
4252
 
 
4253
    --verbose will print out what is being removed.
 
4254
    --dry-run will go through all the motions, but not actually
 
4255
    remove anything.
 
4256
 
 
4257
    If --revision is specified, uncommit revisions to leave the branch at the
 
4258
    specified revision.  For example, "bzr uncommit -r 15" will leave the
 
4259
    branch at revision 15.
 
4260
 
 
4261
    Uncommit leaves the working tree ready for a new commit.  The only change
 
4262
    it may make is to restore any pending merges that were present before
 
4263
    the commit.
 
4264
    """
 
4265
 
 
4266
    # TODO: jam 20060108 Add an option to allow uncommit to remove
 
4267
    # unreferenced information in 'branch-as-repository' branches.
 
4268
    # TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
 
4269
    # information in shared branches as well.
 
4270
    _see_also = ['commit']
 
4271
    takes_options = ['verbose', 'revision',
 
4272
                    Option('dry-run', help='Don\'t actually make changes.'),
 
4273
                    Option('force', help='Say yes to all questions.'),
 
4274
                    Option('local',
 
4275
                           help="Only remove the commits from the local branch"
 
4276
                                " when in a checkout."
 
4277
                           ),
 
4278
                    ]
 
4279
    takes_args = ['location?']
 
4280
    aliases = []
 
4281
    encoding_type = 'replace'
 
4282
 
 
4283
    def run(self, location=None,
 
4284
            dry_run=False, verbose=False,
 
4285
            revision=None, force=False, local=False):
 
4286
        if location is None:
 
4287
            location = u'.'
 
4288
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
4289
        try:
 
4290
            tree = control.open_workingtree()
 
4291
            b = tree.branch
 
4292
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
4293
            tree = None
 
4294
            b = control.open_branch()
 
4295
 
 
4296
        if tree is not None:
 
4297
            tree.lock_write()
 
4298
        else:
 
4299
            b.lock_write()
 
4300
        try:
 
4301
            return self._run(b, tree, dry_run, verbose, revision, force,
 
4302
                             local=local)
 
4303
        finally:
 
4304
            if tree is not None:
 
4305
                tree.unlock()
 
4306
            else:
 
4307
                b.unlock()
 
4308
 
 
4309
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
 
4310
        from bzrlib.log import log_formatter, show_log
 
4311
        from bzrlib.uncommit import uncommit
 
4312
 
 
4313
        last_revno, last_rev_id = b.last_revision_info()
 
4314
 
 
4315
        rev_id = None
 
4316
        if revision is None:
 
4317
            revno = last_revno
 
4318
            rev_id = last_rev_id
 
4319
        else:
 
4320
            # 'bzr uncommit -r 10' actually means uncommit
 
4321
            # so that the final tree is at revno 10.
 
4322
            # but bzrlib.uncommit.uncommit() actually uncommits
 
4323
            # the revisions that are supplied.
 
4324
            # So we need to offset it by one
 
4325
            revno = revision[0].in_history(b).revno + 1
 
4326
            if revno <= last_revno:
 
4327
                rev_id = b.get_rev_id(revno)
 
4328
 
 
4329
        if rev_id is None or _mod_revision.is_null(rev_id):
 
4330
            self.outf.write('No revisions to uncommit.\n')
 
4331
            return 1
 
4332
 
 
4333
        lf = log_formatter('short',
 
4334
                           to_file=self.outf,
 
4335
                           show_timezone='original')
 
4336
 
 
4337
        show_log(b,
 
4338
                 lf,
 
4339
                 verbose=False,
 
4340
                 direction='forward',
 
4341
                 start_revision=revno,
 
4342
                 end_revision=last_revno)
 
4343
 
 
4344
        if dry_run:
 
4345
            print 'Dry-run, pretending to remove the above revisions.'
 
4346
            if not force:
 
4347
                val = raw_input('Press <enter> to continue')
 
4348
        else:
 
4349
            print 'The above revision(s) will be removed.'
 
4350
            if not force:
 
4351
                val = raw_input('Are you sure [y/N]? ')
 
4352
                if val.lower() not in ('y', 'yes'):
 
4353
                    print 'Canceled'
 
4354
                    return 0
 
4355
 
 
4356
        mutter('Uncommitting from {%s} to {%s}',
 
4357
               last_rev_id, rev_id)
 
4358
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
 
4359
                 revno=revno, local=local)
 
4360
        note('You can restore the old tip by running:\n'
 
4361
             '  bzr pull . -r revid:%s', last_rev_id)
 
4362
 
 
4363
 
 
4364
class cmd_break_lock(Command):
 
4365
    """Break a dead lock on a repository, branch or working directory.
 
4366
 
 
4367
    CAUTION: Locks should only be broken when you are sure that the process
 
4368
    holding the lock has been stopped.
 
4369
 
 
4370
    You can get information on what locks are open via the 'bzr info' command.
 
4371
 
 
4372
    :Examples:
 
4373
        bzr break-lock
 
4374
    """
 
4375
    takes_args = ['location?']
 
4376
 
 
4377
    def run(self, location=None, show=False):
 
4378
        if location is None:
 
4379
            location = u'.'
 
4380
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
4381
        try:
 
4382
            control.break_lock()
 
4383
        except NotImplementedError:
 
4384
            pass
 
4385
 
 
4386
 
 
4387
class cmd_wait_until_signalled(Command):
 
4388
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4389
 
 
4390
    This just prints a line to signal when it is ready, then blocks on stdin.
 
4391
    """
 
4392
 
 
4393
    hidden = True
 
4394
 
 
4395
    def run(self):
 
4396
        sys.stdout.write("running\n")
 
4397
        sys.stdout.flush()
 
4398
        sys.stdin.readline()
 
4399
 
 
4400
 
 
4401
class cmd_serve(Command):
 
4402
    """Run the bzr server."""
 
4403
 
 
4404
    aliases = ['server']
 
4405
 
 
4406
    takes_options = [
 
4407
        Option('inet',
 
4408
               help='Serve on stdin/out for use from inetd or sshd.'),
 
4409
        Option('port',
 
4410
               help='Listen for connections on nominated port of the form '
 
4411
                    '[hostname:]portnumber.  Passing 0 as the port number will '
 
4412
                    'result in a dynamically allocated port.  The default port is '
 
4413
                    '4155.',
 
4414
               type=str),
 
4415
        Option('directory',
 
4416
               help='Serve contents of this directory.',
 
4417
               type=unicode),
 
4418
        Option('allow-writes',
 
4419
               help='By default the server is a readonly server.  Supplying '
 
4420
                    '--allow-writes enables write access to the contents of '
 
4421
                    'the served directory and below.'
 
4422
                ),
 
4423
        ]
 
4424
 
 
4425
    def run_smart_server(self, smart_server):
 
4426
        """Run 'smart_server' forever, with no UI output at all."""
 
4427
        # For the duration of this server, no UI output is permitted. note
 
4428
        # that this may cause problems with blackbox tests. This should be
 
4429
        # changed with care though, as we dont want to use bandwidth sending
 
4430
        # progress over stderr to smart server clients!
 
4431
        from bzrlib import lockdir
 
4432
        old_factory = ui.ui_factory
 
4433
        old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
 
4434
        try:
 
4435
            ui.ui_factory = ui.SilentUIFactory()
 
4436
            lockdir._DEFAULT_TIMEOUT_SECONDS = 0
 
4437
            smart_server.serve()
 
4438
        finally:
 
4439
            ui.ui_factory = old_factory
 
4440
            lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
 
4441
 
 
4442
    def get_host_and_port(self, port):
 
4443
        """Return the host and port to run the smart server on.
 
4444
 
 
4445
        If 'port' is None, the default host (`medium.BZR_DEFAULT_INTERFACE`)
 
4446
        and port (`medium.BZR_DEFAULT_PORT`) will be used.
 
4447
 
 
4448
        If 'port' has a colon in it, the string before the colon will be
 
4449
        interpreted as the host.
 
4450
 
 
4451
        :param port: A string of the port to run the server on.
 
4452
        :return: A tuple of (host, port), where 'host' is a host name or IP,
 
4453
            and port is an integer TCP/IP port.
 
4454
        """
 
4455
        from bzrlib.smart import medium
 
4456
        host = medium.BZR_DEFAULT_INTERFACE
 
4457
        if port is None:
 
4458
            port = medium.BZR_DEFAULT_PORT
 
4459
        else:
 
4460
            if ':' in port:
 
4461
                host, port = port.split(':')
 
4462
            port = int(port)
 
4463
        return host, port
 
4464
 
 
4465
    def get_smart_server(self, transport, inet, port):
 
4466
        """Construct a smart server.
 
4467
 
 
4468
        :param transport: The base transport from which branches will be
 
4469
            served.
 
4470
        :param inet: If True, serve over stdin and stdout. Used for running
 
4471
            from inet.
 
4472
        :param port: The port to listen on. By default, it's `
 
4473
            medium.BZR_DEFAULT_PORT`. See `get_host_and_port` for more
 
4474
            information.
 
4475
        :return: A smart server.
 
4476
        """
 
4477
        from bzrlib.smart import medium, server
 
4478
        if inet:
 
4479
            smart_server = medium.SmartServerPipeStreamMedium(
 
4480
                sys.stdin, sys.stdout, transport)
 
4481
        else:
 
4482
            host, port = self.get_host_and_port(port)
 
4483
            smart_server = server.SmartTCPServer(
 
4484
                transport, host=host, port=port)
 
4485
            note('listening on port: %s' % smart_server.port)
 
4486
        return smart_server
 
4487
 
 
4488
    def run(self, port=None, inet=False, directory=None, allow_writes=False):
 
4489
        from bzrlib.transport import get_transport
 
4490
        from bzrlib.transport.chroot import ChrootServer
 
4491
        if directory is None:
 
4492
            directory = os.getcwd()
 
4493
        url = urlutils.local_path_to_url(directory)
 
4494
        if not allow_writes:
 
4495
            url = 'readonly+' + url
 
4496
        chroot_server = ChrootServer(get_transport(url))
 
4497
        chroot_server.setUp()
 
4498
        t = get_transport(chroot_server.get_url())
 
4499
        smart_server = self.get_smart_server(t, inet, port)
 
4500
        self.run_smart_server(smart_server)
 
4501
 
 
4502
 
 
4503
class cmd_join(Command):
 
4504
    """Combine a subtree into its containing tree.
 
4505
 
 
4506
    This command is for experimental use only.  It requires the target tree
 
4507
    to be in dirstate-with-subtree format, which cannot be converted into
 
4508
    earlier formats.
 
4509
 
 
4510
    The TREE argument should be an independent tree, inside another tree, but
 
4511
    not part of it.  (Such trees can be produced by "bzr split", but also by
 
4512
    running "bzr branch" with the target inside a tree.)
 
4513
 
 
4514
    The result is a combined tree, with the subtree no longer an independant
 
4515
    part.  This is marked as a merge of the subtree into the containing tree,
 
4516
    and all history is preserved.
 
4517
 
 
4518
    If --reference is specified, the subtree retains its independence.  It can
 
4519
    be branched by itself, and can be part of multiple projects at the same
 
4520
    time.  But operations performed in the containing tree, such as commit
 
4521
    and merge, will recurse into the subtree.
 
4522
    """
 
4523
 
 
4524
    _see_also = ['split']
 
4525
    takes_args = ['tree']
 
4526
    takes_options = [
 
4527
            Option('reference', help='Join by reference.'),
 
4528
            ]
 
4529
    hidden = True
 
4530
 
 
4531
    def run(self, tree, reference=False):
 
4532
        sub_tree = WorkingTree.open(tree)
 
4533
        parent_dir = osutils.dirname(sub_tree.basedir)
 
4534
        containing_tree = WorkingTree.open_containing(parent_dir)[0]
 
4535
        repo = containing_tree.branch.repository
 
4536
        if not repo.supports_rich_root():
 
4537
            raise errors.BzrCommandError(
 
4538
                "Can't join trees because %s doesn't support rich root data.\n"
 
4539
                "You can use bzr upgrade on the repository."
 
4540
                % (repo,))
 
4541
        if reference:
 
4542
            try:
 
4543
                containing_tree.add_reference(sub_tree)
 
4544
            except errors.BadReferenceTarget, e:
 
4545
                # XXX: Would be better to just raise a nicely printable
 
4546
                # exception from the real origin.  Also below.  mbp 20070306
 
4547
                raise errors.BzrCommandError("Cannot join %s.  %s" %
 
4548
                                             (tree, e.reason))
 
4549
        else:
 
4550
            try:
 
4551
                containing_tree.subsume(sub_tree)
 
4552
            except errors.BadSubsumeSource, e:
 
4553
                raise errors.BzrCommandError("Cannot join %s.  %s" %
 
4554
                                             (tree, e.reason))
 
4555
 
 
4556
 
 
4557
class cmd_split(Command):
 
4558
    """Split a subdirectory of a tree into a separate tree.
 
4559
 
 
4560
    This command will produce a target tree in a format that supports
 
4561
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
 
4562
    converted into earlier formats like 'dirstate-tags'.
 
4563
 
 
4564
    The TREE argument should be a subdirectory of a working tree.  That
 
4565
    subdirectory will be converted into an independent tree, with its own
 
4566
    branch.  Commits in the top-level tree will not apply to the new subtree.
 
4567
    """
 
4568
 
 
4569
    # join is not un-hidden yet
 
4570
    #_see_also = ['join']
 
4571
    takes_args = ['tree']
 
4572
 
 
4573
    def run(self, tree):
 
4574
        containing_tree, subdir = WorkingTree.open_containing(tree)
 
4575
        sub_id = containing_tree.path2id(subdir)
 
4576
        if sub_id is None:
 
4577
            raise errors.NotVersionedError(subdir)
 
4578
        try:
 
4579
            containing_tree.extract(sub_id)
 
4580
        except errors.RootNotRich:
 
4581
            raise errors.UpgradeRequired(containing_tree.branch.base)
 
4582
 
 
4583
 
 
4584
class cmd_merge_directive(Command):
 
4585
    """Generate a merge directive for auto-merge tools.
 
4586
 
 
4587
    A directive requests a merge to be performed, and also provides all the
 
4588
    information necessary to do so.  This means it must either include a
 
4589
    revision bundle, or the location of a branch containing the desired
 
4590
    revision.
 
4591
 
 
4592
    A submit branch (the location to merge into) must be supplied the first
 
4593
    time the command is issued.  After it has been supplied once, it will
 
4594
    be remembered as the default.
 
4595
 
 
4596
    A public branch is optional if a revision bundle is supplied, but required
 
4597
    if --diff or --plain is specified.  It will be remembered as the default
 
4598
    after the first use.
 
4599
    """
 
4600
 
 
4601
    takes_args = ['submit_branch?', 'public_branch?']
 
4602
 
 
4603
    hidden = True
 
4604
 
 
4605
    _see_also = ['send']
 
4606
 
 
4607
    takes_options = [
 
4608
        RegistryOption.from_kwargs('patch-type',
 
4609
            'The type of patch to include in the directive.',
 
4610
            title='Patch type',
 
4611
            value_switches=True,
 
4612
            enum_switch=False,
 
4613
            bundle='Bazaar revision bundle (default).',
 
4614
            diff='Normal unified diff.',
 
4615
            plain='No patch, just directive.'),
 
4616
        Option('sign', help='GPG-sign the directive.'), 'revision',
 
4617
        Option('mail-to', type=str,
 
4618
            help='Instead of printing the directive, email to this address.'),
 
4619
        Option('message', type=str, short_name='m',
 
4620
            help='Message to use when committing this merge.')
 
4621
        ]
 
4622
 
 
4623
    encoding_type = 'exact'
 
4624
 
 
4625
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
 
4626
            sign=False, revision=None, mail_to=None, message=None):
 
4627
        from bzrlib.revision import ensure_null, NULL_REVISION
 
4628
        include_patch, include_bundle = {
 
4629
            'plain': (False, False),
 
4630
            'diff': (True, False),
 
4631
            'bundle': (True, True),
 
4632
            }[patch_type]
 
4633
        branch = Branch.open('.')
 
4634
        stored_submit_branch = branch.get_submit_branch()
 
4635
        if submit_branch is None:
 
4636
            submit_branch = stored_submit_branch
 
4637
        else:
 
4638
            if stored_submit_branch is None:
 
4639
                branch.set_submit_branch(submit_branch)
 
4640
        if submit_branch is None:
 
4641
            submit_branch = branch.get_parent()
 
4642
        if submit_branch is None:
 
4643
            raise errors.BzrCommandError('No submit branch specified or known')
 
4644
 
 
4645
        stored_public_branch = branch.get_public_branch()
 
4646
        if public_branch is None:
 
4647
            public_branch = stored_public_branch
 
4648
        elif stored_public_branch is None:
 
4649
            branch.set_public_branch(public_branch)
 
4650
        if not include_bundle and public_branch is None:
 
4651
            raise errors.BzrCommandError('No public branch specified or'
 
4652
                                         ' known')
 
4653
        base_revision_id = None
 
4654
        if revision is not None:
 
4655
            if len(revision) > 2:
 
4656
                raise errors.BzrCommandError('bzr merge-directive takes '
 
4657
                    'at most two one revision identifiers')
 
4658
            revision_id = revision[-1].as_revision_id(branch)
 
4659
            if len(revision) == 2:
 
4660
                base_revision_id = revision[0].as_revision_id(branch)
 
4661
        else:
 
4662
            revision_id = branch.last_revision()
 
4663
        revision_id = ensure_null(revision_id)
 
4664
        if revision_id == NULL_REVISION:
 
4665
            raise errors.BzrCommandError('No revisions to bundle.')
 
4666
        directive = merge_directive.MergeDirective2.from_objects(
 
4667
            branch.repository, revision_id, time.time(),
 
4668
            osutils.local_time_offset(), submit_branch,
 
4669
            public_branch=public_branch, include_patch=include_patch,
 
4670
            include_bundle=include_bundle, message=message,
 
4671
            base_revision_id=base_revision_id)
 
4672
        if mail_to is None:
 
4673
            if sign:
 
4674
                self.outf.write(directive.to_signed(branch))
 
4675
            else:
 
4676
                self.outf.writelines(directive.to_lines())
 
4677
        else:
 
4678
            message = directive.to_email(mail_to, branch, sign)
 
4679
            s = SMTPConnection(branch.get_config())
 
4680
            s.send_email(message)
 
4681
 
 
4682
 
 
4683
class cmd_send(Command):
 
4684
    """Mail or create a merge-directive for submitting changes.
 
4685
 
 
4686
    A merge directive provides many things needed for requesting merges:
 
4687
 
 
4688
    * A machine-readable description of the merge to perform
 
4689
 
 
4690
    * An optional patch that is a preview of the changes requested
 
4691
 
 
4692
    * An optional bundle of revision data, so that the changes can be applied
 
4693
      directly from the merge directive, without retrieving data from a
 
4694
      branch.
 
4695
 
 
4696
    If --no-bundle is specified, then public_branch is needed (and must be
 
4697
    up-to-date), so that the receiver can perform the merge using the
 
4698
    public_branch.  The public_branch is always included if known, so that
 
4699
    people can check it later.
 
4700
 
 
4701
    The submit branch defaults to the parent, but can be overridden.  Both
 
4702
    submit branch and public branch will be remembered if supplied.
 
4703
 
 
4704
    If a public_branch is known for the submit_branch, that public submit
 
4705
    branch is used in the merge instructions.  This means that a local mirror
 
4706
    can be used as your actual submit branch, once you have set public_branch
 
4707
    for that mirror.
 
4708
 
 
4709
    Mail is sent using your preferred mail program.  This should be transparent
 
4710
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
 
4711
    If the preferred client can't be found (or used), your editor will be used.
 
4712
 
 
4713
    To use a specific mail program, set the mail_client configuration option.
 
4714
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
 
4715
    specific clients are "claws", "evolution", "kmail", "mutt", and
 
4716
    "thunderbird"; generic options are "default", "editor", "emacsclient",
 
4717
    "mapi", and "xdg-email".  Plugins may also add supported clients.
 
4718
 
 
4719
    If mail is being sent, a to address is required.  This can be supplied
 
4720
    either on the commandline, by setting the submit_to configuration
 
4721
    option in the branch itself or the child_submit_to configuration option
 
4722
    in the submit branch.
 
4723
 
 
4724
    Two formats are currently supported: "4" uses revision bundle format 4 and
 
4725
    merge directive format 2.  It is significantly faster and smaller than
 
4726
    older formats.  It is compatible with Bazaar 0.19 and later.  It is the
 
4727
    default.  "0.9" uses revision bundle format 0.9 and merge directive
 
4728
    format 1.  It is compatible with Bazaar 0.12 - 0.18.
 
4729
 
 
4730
    The merge directives created by bzr send may be applied using bzr merge or
 
4731
    bzr pull by specifying a file containing a merge directive as the location.
 
4732
    """
 
4733
 
 
4734
    encoding_type = 'exact'
 
4735
 
 
4736
    _see_also = ['merge', 'pull']
 
4737
 
 
4738
    takes_args = ['submit_branch?', 'public_branch?']
 
4739
 
 
4740
    takes_options = [
 
4741
        Option('no-bundle',
 
4742
               help='Do not include a bundle in the merge directive.'),
 
4743
        Option('no-patch', help='Do not include a preview patch in the merge'
 
4744
               ' directive.'),
 
4745
        Option('remember',
 
4746
               help='Remember submit and public branch.'),
 
4747
        Option('from',
 
4748
               help='Branch to generate the submission from, '
 
4749
               'rather than the one containing the working directory.',
 
4750
               short_name='f',
 
4751
               type=unicode),
 
4752
        Option('output', short_name='o',
 
4753
               help='Write merge directive to this file; '
 
4754
                    'use - for stdout.',
 
4755
               type=unicode),
 
4756
        Option('mail-to', help='Mail the request to this address.',
 
4757
               type=unicode),
 
4758
        'revision',
 
4759
        'message',
 
4760
        Option('body', help='Body for the email.', type=unicode),
 
4761
        RegistryOption.from_kwargs('format',
 
4762
        'Use the specified output format.',
 
4763
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
4764
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
 
4765
        ]
 
4766
 
 
4767
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
 
4768
            no_patch=False, revision=None, remember=False, output=None,
 
4769
            format='4', mail_to=None, message=None, body=None, **kwargs):
 
4770
        return self._run(submit_branch, revision, public_branch, remember,
 
4771
                         format, no_bundle, no_patch, output,
 
4772
                         kwargs.get('from', '.'), mail_to, message, body)
 
4773
 
 
4774
    def _run(self, submit_branch, revision, public_branch, remember, format,
 
4775
             no_bundle, no_patch, output, from_, mail_to, message, body):
 
4776
        from bzrlib.revision import NULL_REVISION
 
4777
        branch = Branch.open_containing(from_)[0]
 
4778
        if output is None:
 
4779
            outfile = cStringIO.StringIO()
 
4780
        elif output == '-':
 
4781
            outfile = self.outf
 
4782
        else:
 
4783
            outfile = open(output, 'wb')
 
4784
        # we may need to write data into branch's repository to calculate
 
4785
        # the data to send.
 
4786
        branch.lock_write()
 
4787
        try:
 
4788
            if output is None:
 
4789
                config = branch.get_config()
 
4790
                if mail_to is None:
 
4791
                    mail_to = config.get_user_option('submit_to')
 
4792
                mail_client = config.get_mail_client()
 
4793
                if (not getattr(mail_client, 'supports_body', False)
 
4794
                    and body is not None):
 
4795
                    raise errors.BzrCommandError(
 
4796
                        'Mail client "%s" does not support specifying body' %
 
4797
                        mail_client.__class__.__name__)
 
4798
            if remember and submit_branch is None:
 
4799
                raise errors.BzrCommandError(
 
4800
                    '--remember requires a branch to be specified.')
 
4801
            stored_submit_branch = branch.get_submit_branch()
 
4802
            remembered_submit_branch = None
 
4803
            if submit_branch is None:
 
4804
                submit_branch = stored_submit_branch
 
4805
                remembered_submit_branch = "submit"
 
4806
            else:
 
4807
                if stored_submit_branch is None or remember:
 
4808
                    branch.set_submit_branch(submit_branch)
 
4809
            if submit_branch is None:
 
4810
                submit_branch = branch.get_parent()
 
4811
                remembered_submit_branch = "parent"
 
4812
            if submit_branch is None:
 
4813
                raise errors.BzrCommandError('No submit branch known or'
 
4814
                                             ' specified')
 
4815
            if remembered_submit_branch is not None:
 
4816
                note('Using saved %s location "%s" to determine what '
 
4817
                        'changes to submit.', remembered_submit_branch,
 
4818
                        submit_branch)
 
4819
 
 
4820
            if mail_to is None:
 
4821
                submit_config = Branch.open(submit_branch).get_config()
 
4822
                mail_to = submit_config.get_user_option("child_submit_to")
 
4823
 
 
4824
            stored_public_branch = branch.get_public_branch()
 
4825
            if public_branch is None:
 
4826
                public_branch = stored_public_branch
 
4827
            elif stored_public_branch is None or remember:
 
4828
                branch.set_public_branch(public_branch)
 
4829
            if no_bundle and public_branch is None:
 
4830
                raise errors.BzrCommandError('No public branch specified or'
 
4831
                                             ' known')
 
4832
            base_revision_id = None
 
4833
            revision_id = None
 
4834
            if revision is not None:
 
4835
                if len(revision) > 2:
 
4836
                    raise errors.BzrCommandError('bzr send takes '
 
4837
                        'at most two one revision identifiers')
 
4838
                revision_id = revision[-1].as_revision_id(branch)
 
4839
                if len(revision) == 2:
 
4840
                    base_revision_id = revision[0].as_revision_id(branch)
 
4841
            if revision_id is None:
 
4842
                revision_id = branch.last_revision()
 
4843
            if revision_id == NULL_REVISION:
 
4844
                raise errors.BzrCommandError('No revisions to submit.')
 
4845
            if format == '4':
 
4846
                directive = merge_directive.MergeDirective2.from_objects(
 
4847
                    branch.repository, revision_id, time.time(),
 
4848
                    osutils.local_time_offset(), submit_branch,
 
4849
                    public_branch=public_branch, include_patch=not no_patch,
 
4850
                    include_bundle=not no_bundle, message=message,
 
4851
                    base_revision_id=base_revision_id)
 
4852
            elif format == '0.9':
 
4853
                if not no_bundle:
 
4854
                    if not no_patch:
 
4855
                        patch_type = 'bundle'
 
4856
                    else:
 
4857
                        raise errors.BzrCommandError('Format 0.9 does not'
 
4858
                            ' permit bundle with no patch')
 
4859
                else:
 
4860
                    if not no_patch:
 
4861
                        patch_type = 'diff'
 
4862
                    else:
 
4863
                        patch_type = None
 
4864
                directive = merge_directive.MergeDirective.from_objects(
 
4865
                    branch.repository, revision_id, time.time(),
 
4866
                    osutils.local_time_offset(), submit_branch,
 
4867
                    public_branch=public_branch, patch_type=patch_type,
 
4868
                    message=message)
 
4869
 
 
4870
            outfile.writelines(directive.to_lines())
 
4871
            if output is None:
 
4872
                subject = '[MERGE] '
 
4873
                if message is not None:
 
4874
                    subject += message
 
4875
                else:
 
4876
                    revision = branch.repository.get_revision(revision_id)
 
4877
                    subject += revision.get_summary()
 
4878
                basename = directive.get_disk_name(branch)
 
4879
                mail_client.compose_merge_request(mail_to, subject,
 
4880
                                                  outfile.getvalue(),
 
4881
                                                  basename, body)
 
4882
        finally:
 
4883
            if output != '-':
 
4884
                outfile.close()
 
4885
            branch.unlock()
 
4886
 
 
4887
 
 
4888
class cmd_bundle_revisions(cmd_send):
 
4889
 
 
4890
    """Create a merge-directive for submitting changes.
 
4891
 
 
4892
    A merge directive provides many things needed for requesting merges:
 
4893
 
 
4894
    * A machine-readable description of the merge to perform
 
4895
 
 
4896
    * An optional patch that is a preview of the changes requested
 
4897
 
 
4898
    * An optional bundle of revision data, so that the changes can be applied
 
4899
      directly from the merge directive, without retrieving data from a
 
4900
      branch.
 
4901
 
 
4902
    If --no-bundle is specified, then public_branch is needed (and must be
 
4903
    up-to-date), so that the receiver can perform the merge using the
 
4904
    public_branch.  The public_branch is always included if known, so that
 
4905
    people can check it later.
 
4906
 
 
4907
    The submit branch defaults to the parent, but can be overridden.  Both
 
4908
    submit branch and public branch will be remembered if supplied.
 
4909
 
 
4910
    If a public_branch is known for the submit_branch, that public submit
 
4911
    branch is used in the merge instructions.  This means that a local mirror
 
4912
    can be used as your actual submit branch, once you have set public_branch
 
4913
    for that mirror.
 
4914
 
 
4915
    Two formats are currently supported: "4" uses revision bundle format 4 and
 
4916
    merge directive format 2.  It is significantly faster and smaller than
 
4917
    older formats.  It is compatible with Bazaar 0.19 and later.  It is the
 
4918
    default.  "0.9" uses revision bundle format 0.9 and merge directive
 
4919
    format 1.  It is compatible with Bazaar 0.12 - 0.18.
 
4920
    """
 
4921
 
 
4922
    takes_options = [
 
4923
        Option('no-bundle',
 
4924
               help='Do not include a bundle in the merge directive.'),
 
4925
        Option('no-patch', help='Do not include a preview patch in the merge'
 
4926
               ' directive.'),
 
4927
        Option('remember',
 
4928
               help='Remember submit and public branch.'),
 
4929
        Option('from',
 
4930
               help='Branch to generate the submission from, '
 
4931
               'rather than the one containing the working directory.',
 
4932
               short_name='f',
 
4933
               type=unicode),
 
4934
        Option('output', short_name='o', help='Write directive to this file.',
 
4935
               type=unicode),
 
4936
        'revision',
 
4937
        RegistryOption.from_kwargs('format',
 
4938
        'Use the specified output format.',
 
4939
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
4940
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
 
4941
        ]
 
4942
    aliases = ['bundle']
 
4943
 
 
4944
    _see_also = ['send', 'merge']
 
4945
 
 
4946
    hidden = True
 
4947
 
 
4948
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
 
4949
            no_patch=False, revision=None, remember=False, output=None,
 
4950
            format='4', **kwargs):
 
4951
        if output is None:
 
4952
            output = '-'
 
4953
        return self._run(submit_branch, revision, public_branch, remember,
 
4954
                         format, no_bundle, no_patch, output,
 
4955
                         kwargs.get('from', '.'), None, None, None)
 
4956
 
 
4957
 
 
4958
class cmd_tag(Command):
 
4959
    """Create, remove or modify a tag naming a revision.
 
4960
 
 
4961
    Tags give human-meaningful names to revisions.  Commands that take a -r
 
4962
    (--revision) option can be given -rtag:X, where X is any previously
 
4963
    created tag.
 
4964
 
 
4965
    Tags are stored in the branch.  Tags are copied from one branch to another
 
4966
    along when you branch, push, pull or merge.
 
4967
 
 
4968
    It is an error to give a tag name that already exists unless you pass
 
4969
    --force, in which case the tag is moved to point to the new revision.
 
4970
 
 
4971
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
 
4972
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
 
4973
    """
 
4974
 
 
4975
    _see_also = ['commit', 'tags']
 
4976
    takes_args = ['tag_name']
 
4977
    takes_options = [
 
4978
        Option('delete',
 
4979
            help='Delete this tag rather than placing it.',
 
4980
            ),
 
4981
        Option('directory',
 
4982
            help='Branch in which to place the tag.',
 
4983
            short_name='d',
 
4984
            type=unicode,
 
4985
            ),
 
4986
        Option('force',
 
4987
            help='Replace existing tags.',
 
4988
            ),
 
4989
        'revision',
 
4990
        ]
 
4991
 
 
4992
    def run(self, tag_name,
 
4993
            delete=None,
 
4994
            directory='.',
 
4995
            force=None,
 
4996
            revision=None,
 
4997
            ):
 
4998
        branch, relpath = Branch.open_containing(directory)
 
4999
        branch.lock_write()
 
5000
        try:
 
5001
            if delete:
 
5002
                branch.tags.delete_tag(tag_name)
 
5003
                self.outf.write('Deleted tag %s.\n' % tag_name)
 
5004
            else:
 
5005
                if revision:
 
5006
                    if len(revision) != 1:
 
5007
                        raise errors.BzrCommandError(
 
5008
                            "Tags can only be placed on a single revision, "
 
5009
                            "not on a range")
 
5010
                    revision_id = revision[0].as_revision_id(branch)
 
5011
                else:
 
5012
                    revision_id = branch.last_revision()
 
5013
                if (not force) and branch.tags.has_tag(tag_name):
 
5014
                    raise errors.TagAlreadyExists(tag_name)
 
5015
                branch.tags.set_tag(tag_name, revision_id)
 
5016
                self.outf.write('Created tag %s.\n' % tag_name)
 
5017
        finally:
 
5018
            branch.unlock()
 
5019
 
 
5020
 
 
5021
class cmd_tags(Command):
 
5022
    """List tags.
 
5023
 
 
5024
    This command shows a table of tag names and the revisions they reference.
 
5025
    """
 
5026
 
 
5027
    _see_also = ['tag']
 
5028
    takes_options = [
 
5029
        Option('directory',
 
5030
            help='Branch whose tags should be displayed.',
 
5031
            short_name='d',
 
5032
            type=unicode,
 
5033
            ),
 
5034
        RegistryOption.from_kwargs('sort',
 
5035
            'Sort tags by different criteria.', title='Sorting',
 
5036
            alpha='Sort tags lexicographically (default).',
 
5037
            time='Sort tags chronologically.',
 
5038
            ),
 
5039
        'show-ids',
 
5040
        'revision',
 
5041
    ]
 
5042
 
 
5043
    @display_command
 
5044
    def run(self,
 
5045
            directory='.',
 
5046
            sort='alpha',
 
5047
            show_ids=False,
 
5048
            revision=None,
 
5049
            ):
 
5050
        branch, relpath = Branch.open_containing(directory)
 
5051
 
 
5052
        tags = branch.tags.get_tag_dict().items()
 
5053
        if not tags:
 
5054
            return
 
5055
 
 
5056
        if revision:
 
5057
            branch.lock_read()
 
5058
            try:
 
5059
                graph = branch.repository.get_graph()
 
5060
                rev1, rev2 = _get_revision_range(revision, branch, self.name())
 
5061
                revid1, revid2 = rev1.rev_id, rev2.rev_id
 
5062
                # only show revisions between revid1 and revid2 (inclusive)
 
5063
                tags = [(tag, revid) for tag, revid in tags if
 
5064
                    graph.is_between(revid, revid1, revid2)]
 
5065
            finally:
 
5066
                branch.unlock()
 
5067
        if sort == 'alpha':
 
5068
            tags.sort()
 
5069
        elif sort == 'time':
 
5070
            timestamps = {}
 
5071
            for tag, revid in tags:
 
5072
                try:
 
5073
                    revobj = branch.repository.get_revision(revid)
 
5074
                except errors.NoSuchRevision:
 
5075
                    timestamp = sys.maxint # place them at the end
 
5076
                else:
 
5077
                    timestamp = revobj.timestamp
 
5078
                timestamps[revid] = timestamp
 
5079
            tags.sort(key=lambda x: timestamps[x[1]])
 
5080
        if not show_ids:
 
5081
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
 
5082
            revno_map = branch.get_revision_id_to_revno_map()
 
5083
            tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
 
5084
                        for tag, revid in tags ]
 
5085
        for tag, revspec in tags:
 
5086
            self.outf.write('%-20s %s\n' % (tag, revspec))
 
5087
 
 
5088
 
 
5089
class cmd_reconfigure(Command):
 
5090
    """Reconfigure the type of a bzr directory.
 
5091
 
 
5092
    A target configuration must be specified.
 
5093
 
 
5094
    For checkouts, the bind-to location will be auto-detected if not specified.
 
5095
    The order of preference is
 
5096
    1. For a lightweight checkout, the current bound location.
 
5097
    2. For branches that used to be checkouts, the previously-bound location.
 
5098
    3. The push location.
 
5099
    4. The parent location.
 
5100
    If none of these is available, --bind-to must be specified.
 
5101
    """
 
5102
 
 
5103
    _see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
 
5104
    takes_args = ['location?']
 
5105
    takes_options = [
 
5106
        RegistryOption.from_kwargs(
 
5107
            'target_type',
 
5108
            title='Target type',
 
5109
            help='The type to reconfigure the directory to.',
 
5110
            value_switches=True, enum_switch=False,
 
5111
            branch='Reconfigure to be an unbound branch with no working tree.',
 
5112
            tree='Reconfigure to be an unbound branch with a working tree.',
 
5113
            checkout='Reconfigure to be a bound branch with a working tree.',
 
5114
            lightweight_checkout='Reconfigure to be a lightweight'
 
5115
                ' checkout (with no local history).',
 
5116
            standalone='Reconfigure to be a standalone branch '
 
5117
                '(i.e. stop using shared repository).',
 
5118
            use_shared='Reconfigure to use a shared repository.',
 
5119
            with_trees='Reconfigure repository to create '
 
5120
                'working trees on branches by default.',
 
5121
            with_no_trees='Reconfigure repository to not create '
 
5122
                'working trees on branches by default.'
 
5123
            ),
 
5124
        Option('bind-to', help='Branch to bind checkout to.', type=str),
 
5125
        Option('force',
 
5126
               help='Perform reconfiguration even if local changes'
 
5127
               ' will be lost.')
 
5128
        ]
 
5129
 
 
5130
    def run(self, location=None, target_type=None, bind_to=None, force=False):
 
5131
        directory = bzrdir.BzrDir.open(location)
 
5132
        if target_type is None:
 
5133
            raise errors.BzrCommandError('No target configuration specified')
 
5134
        elif target_type == 'branch':
 
5135
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
 
5136
        elif target_type == 'tree':
 
5137
            reconfiguration = reconfigure.Reconfigure.to_tree(directory)
 
5138
        elif target_type == 'checkout':
 
5139
            reconfiguration = reconfigure.Reconfigure.to_checkout(
 
5140
                directory, bind_to)
 
5141
        elif target_type == 'lightweight-checkout':
 
5142
            reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
 
5143
                directory, bind_to)
 
5144
        elif target_type == 'use-shared':
 
5145
            reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
 
5146
        elif target_type == 'standalone':
 
5147
            reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
 
5148
        elif target_type == 'with-trees':
 
5149
            reconfiguration = reconfigure.Reconfigure.set_repository_trees(
 
5150
                directory, True)
 
5151
        elif target_type == 'with-no-trees':
 
5152
            reconfiguration = reconfigure.Reconfigure.set_repository_trees(
 
5153
                directory, False)
 
5154
        reconfiguration.apply(force)
 
5155
 
 
5156
 
 
5157
class cmd_switch(Command):
 
5158
    """Set the branch of a checkout and update.
 
5159
 
 
5160
    For lightweight checkouts, this changes the branch being referenced.
 
5161
    For heavyweight checkouts, this checks that there are no local commits
 
5162
    versus the current bound branch, then it makes the local branch a mirror
 
5163
    of the new location and binds to it.
 
5164
 
 
5165
    In both cases, the working tree is updated and uncommitted changes
 
5166
    are merged. The user can commit or revert these as they desire.
 
5167
 
 
5168
    Pending merges need to be committed or reverted before using switch.
 
5169
 
 
5170
    The path to the branch to switch to can be specified relative to the parent
 
5171
    directory of the current branch. For example, if you are currently in a
 
5172
    checkout of /path/to/branch, specifying 'newbranch' will find a branch at
 
5173
    /path/to/newbranch.
 
5174
 
 
5175
    Bound branches use the nickname of its master branch unless it is set
 
5176
    locally, in which case switching will update the the local nickname to be
 
5177
    that of the master.
 
5178
    """
 
5179
 
 
5180
    takes_args = ['to_location']
 
5181
    takes_options = [Option('force',
 
5182
                        help='Switch even if local commits will be lost.')
 
5183
                     ]
 
5184
 
 
5185
    def run(self, to_location, force=False):
 
5186
        from bzrlib import switch
 
5187
        tree_location = '.'
 
5188
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
 
5189
        branch = control_dir.open_branch()
 
5190
        try:
 
5191
            to_branch = Branch.open(to_location)
 
5192
        except errors.NotBranchError:
 
5193
            this_branch = control_dir.open_branch()
 
5194
            # This may be a heavy checkout, where we want the master branch
 
5195
            this_url = this_branch.get_bound_location()
 
5196
            # If not, use a local sibling
 
5197
            if this_url is None:
 
5198
                this_url = this_branch.base
 
5199
            to_branch = Branch.open(
 
5200
                urlutils.join(this_url, '..', to_location))
 
5201
        switch.switch(control_dir, to_branch, force)
 
5202
        if branch.get_config().has_explicit_nickname():
 
5203
            branch = control_dir.open_branch() #get the new branch!
 
5204
            branch.nick = to_branch.nick
 
5205
        note('Switched to branch: %s',
 
5206
            urlutils.unescape_for_display(to_branch.base, 'utf-8'))
 
5207
 
 
5208
 
 
5209
class cmd_view(Command):
 
5210
    """Manage filtered views.
 
5211
 
 
5212
    Views provide a mask over the tree so that users can focus on
 
5213
    a subset of a tree when doing their work. After creating a view,
 
5214
    commands that support a list of files - status, diff, commit, etc -
 
5215
    effectively have that list of files implicitly given each time.
 
5216
    An explicit list of files can still be given but those files
 
5217
    must be within the current view.
 
5218
 
 
5219
    In most cases, a view has a short life-span: it is created to make
 
5220
    a selected change and is deleted once that change is committed.
 
5221
    At other times, you may wish to create one or more named views
 
5222
    and switch between them.
 
5223
 
 
5224
    To disable the current view without deleting it, you can switch to
 
5225
    the pseudo view called ``off``. This can be useful when you need
 
5226
    to see the whole tree for an operation or two (e.g. merge) but
 
5227
    want to switch back to your view after that.
 
5228
 
 
5229
    :Examples:
 
5230
      To define the current view::
 
5231
 
 
5232
        bzr view file1 dir1 ...
 
5233
 
 
5234
      To list the current view::
 
5235
 
 
5236
        bzr view
 
5237
 
 
5238
      To delete the current view::
 
5239
 
 
5240
        bzr view --delete
 
5241
 
 
5242
      To disable the current view without deleting it::
 
5243
 
 
5244
        bzr view --switch off
 
5245
 
 
5246
      To define a named view and switch to it::
 
5247
 
 
5248
        bzr view --name view-name file1 dir1 ...
 
5249
 
 
5250
      To list a named view::
 
5251
 
 
5252
        bzr view --name view-name
 
5253
 
 
5254
      To delete a named view::
 
5255
 
 
5256
        bzr view --name view-name --delete
 
5257
 
 
5258
      To switch to a named view::
 
5259
 
 
5260
        bzr view --switch view-name
 
5261
 
 
5262
      To list all views defined::
 
5263
 
 
5264
        bzr view --all
 
5265
 
 
5266
      To delete all views::
 
5267
 
 
5268
        bzr view --delete --all
 
5269
    """
 
5270
 
 
5271
    _see_also = []
 
5272
    takes_args = ['file*']
 
5273
    takes_options = [
 
5274
        Option('all',
 
5275
            help='Apply list or delete action to all views.',
 
5276
            ),
 
5277
        Option('delete',
 
5278
            help='Delete the view.',
 
5279
            ),
 
5280
        Option('name',
 
5281
            help='Name of the view to define, list or delete.',
 
5282
            type=unicode,
 
5283
            ),
 
5284
        Option('switch',
 
5285
            help='Name of the view to switch to.',
 
5286
            type=unicode,
 
5287
            ),
 
5288
        ]
 
5289
 
 
5290
    def run(self, file_list,
 
5291
            all=False,
 
5292
            delete=False,
 
5293
            name=None,
 
5294
            switch=None,
 
5295
            ):
 
5296
        tree, file_list = tree_files(file_list, apply_view=False)
 
5297
        current_view, view_dict = tree.views.get_view_info()
 
5298
        if name is None:
 
5299
            name = current_view
 
5300
        if delete:
 
5301
            if file_list:
 
5302
                raise errors.BzrCommandError(
 
5303
                    "Both --delete and a file list specified")
 
5304
            elif switch:
 
5305
                raise errors.BzrCommandError(
 
5306
                    "Both --delete and --switch specified")
 
5307
            elif all:
 
5308
                tree.views.set_view_info(None, {})
 
5309
                self.outf.write("Deleted all views.\n")
 
5310
            elif name is None:
 
5311
                raise errors.BzrCommandError("No current view to delete")
 
5312
            else:
 
5313
                tree.views.delete_view(name)
 
5314
                self.outf.write("Deleted '%s' view.\n" % name)
 
5315
        elif switch:
 
5316
            if file_list:
 
5317
                raise errors.BzrCommandError(
 
5318
                    "Both --switch and a file list specified")
 
5319
            elif all:
 
5320
                raise errors.BzrCommandError(
 
5321
                    "Both --switch and --all specified")
 
5322
            elif switch == 'off':
 
5323
                if current_view is None:
 
5324
                    raise errors.BzrCommandError("No current view to disable")
 
5325
                tree.views.set_view_info(None, view_dict)
 
5326
                self.outf.write("Disabled '%s' view.\n" % (current_view))
 
5327
            else:
 
5328
                tree.views.set_view_info(switch, view_dict)
 
5329
                view_str = views.view_display_str(tree.views.lookup_view())
 
5330
                self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
 
5331
        elif all:
 
5332
            if view_dict:
 
5333
                self.outf.write('Views defined:\n')
 
5334
                for view in sorted(view_dict):
 
5335
                    if view == current_view:
 
5336
                        active = "=>"
 
5337
                    else:
 
5338
                        active = "  "
 
5339
                    view_str = views.view_display_str(view_dict[view])
 
5340
                    self.outf.write('%s %-20s %s\n' % (active, view, view_str))
 
5341
            else:
 
5342
                self.outf.write('No views defined.\n')
 
5343
        elif file_list:
 
5344
            if name is None:
 
5345
                # No name given and no current view set
 
5346
                name = 'my'
 
5347
            elif name == 'off':
 
5348
                raise errors.BzrCommandError(
 
5349
                    "Cannot change the 'off' pseudo view")
 
5350
            tree.views.set_view(name, sorted(file_list))
 
5351
            view_str = views.view_display_str(tree.views.lookup_view())
 
5352
            self.outf.write("Using '%s' view: %s\n" % (name, view_str))
 
5353
        else:
 
5354
            # list the files
 
5355
            if name is None:
 
5356
                # No name given and no current view set
 
5357
                self.outf.write('No current view.\n')
 
5358
            else:
 
5359
                view_str = views.view_display_str(tree.views.lookup_view(name))
 
5360
                self.outf.write("'%s' view is: %s\n" % (name, view_str))
 
5361
 
 
5362
 
 
5363
class cmd_hooks(Command):
 
5364
    """Show hooks."""
 
5365
 
 
5366
    hidden = True
 
5367
 
 
5368
    def run(self):
 
5369
        for hook_key in sorted(hooks.known_hooks.keys()):
 
5370
            some_hooks = hooks.known_hooks_key_to_object(hook_key)
 
5371
            self.outf.write("%s:\n" % type(some_hooks).__name__)
 
5372
            for hook_name, hook_point in sorted(some_hooks.items()):
 
5373
                self.outf.write("  %s:\n" % (hook_name,))
 
5374
                found_hooks = list(hook_point)
 
5375
                if found_hooks:
 
5376
                    for hook in found_hooks:
 
5377
                        self.outf.write("    %s\n" %
 
5378
                                        (some_hooks.get_hook_name(hook),))
 
5379
                else:
 
5380
                    self.outf.write("    <no hooks installed>\n")
 
5381
 
 
5382
 
 
5383
class cmd_shelve(Command):
 
5384
    """Temporarily set aside some changes from the current tree.
 
5385
 
 
5386
    Shelve allows you to temporarily put changes you've made "on the shelf",
 
5387
    ie. out of the way, until a later time when you can bring them back from
 
5388
    the shelf with the 'unshelve' command.  The changes are stored alongside
 
5389
    your working tree, and so they aren't propagated along with your branch nor
 
5390
    will they survive its deletion.
 
5391
 
 
5392
    If shelve --list is specified, previously-shelved changes are listed.
 
5393
 
 
5394
    Shelve is intended to help separate several sets of changes that have
 
5395
    been inappropriately mingled.  If you just want to get rid of all changes
 
5396
    and you don't need to restore them later, use revert.  If you want to
 
5397
    shelve all text changes at once, use shelve --all.
 
5398
 
 
5399
    If filenames are specified, only the changes to those files will be
 
5400
    shelved. Other files will be left untouched.
 
5401
 
 
5402
    If a revision is specified, changes since that revision will be shelved.
 
5403
 
 
5404
    You can put multiple items on the shelf, and by default, 'unshelve' will
 
5405
    restore the most recently shelved changes.
 
5406
    """
 
5407
 
 
5408
    takes_args = ['file*']
 
5409
 
 
5410
    takes_options = [
 
5411
        'revision',
 
5412
        Option('all', help='Shelve all changes.'),
 
5413
        'message',
 
5414
        RegistryOption('writer', 'Method to use for writing diffs.',
 
5415
                       bzrlib.option.diff_writer_registry,
 
5416
                       value_switches=True, enum_switch=False),
 
5417
 
 
5418
        Option('list', help='List shelved changes.'),
 
5419
        Option('destroy',
 
5420
               help='Destroy removed changes instead of shelving them.'),
 
5421
    ]
 
5422
    _see_also = ['unshelve']
 
5423
 
 
5424
    def run(self, revision=None, all=False, file_list=None, message=None,
 
5425
            writer=None, list=False, destroy=False):
 
5426
        if list:
 
5427
            return self.run_for_list()
 
5428
        from bzrlib.shelf_ui import Shelver
 
5429
        if writer is None:
 
5430
            writer = bzrlib.option.diff_writer_registry.get()
 
5431
        try:
 
5432
            Shelver.from_args(writer(sys.stdout), revision, all, file_list,
 
5433
                              message, destroy=destroy).run()
 
5434
        except errors.UserAbort:
 
5435
            return 0
 
5436
 
 
5437
    def run_for_list(self):
 
5438
        tree = WorkingTree.open_containing('.')[0]
 
5439
        tree.lock_read()
 
5440
        try:
 
5441
            manager = tree.get_shelf_manager()
 
5442
            shelves = manager.active_shelves()
 
5443
            if len(shelves) == 0:
 
5444
                note('No shelved changes.')
 
5445
                return 0
 
5446
            for shelf_id in reversed(shelves):
 
5447
                message = manager.get_metadata(shelf_id).get('message')
 
5448
                if message is None:
 
5449
                    message = '<no message>'
 
5450
                self.outf.write('%3d: %s\n' % (shelf_id, message))
 
5451
            return 1
 
5452
        finally:
 
5453
            tree.unlock()
 
5454
 
 
5455
 
 
5456
class cmd_unshelve(Command):
 
5457
    """Restore shelved changes.
 
5458
 
 
5459
    By default, the most recently shelved changes are restored. However if you
 
5460
    specify a shelf by id those changes will be restored instead.  This works
 
5461
    best when the changes don't depend on each other.
 
5462
    """
 
5463
 
 
5464
    takes_args = ['shelf_id?']
 
5465
    takes_options = [
 
5466
        RegistryOption.from_kwargs(
 
5467
            'action', help="The action to perform.",
 
5468
            enum_switch=False, value_switches=True,
 
5469
            apply="Apply changes and remove from the shelf.",
 
5470
            dry_run="Show changes, but do not apply or remove them.",
 
5471
            delete_only="Delete changes without applying them."
 
5472
        )
 
5473
    ]
 
5474
    _see_also = ['shelve']
 
5475
 
 
5476
    def run(self, shelf_id=None, action='apply'):
 
5477
        from bzrlib.shelf_ui import Unshelver
 
5478
        Unshelver.from_args(shelf_id, action).run()
 
5479
 
 
5480
 
 
5481
class cmd_clean_tree(Command):
 
5482
    """Remove unwanted files from working tree.
 
5483
 
 
5484
    By default, only unknown files, not ignored files, are deleted.  Versioned
 
5485
    files are never deleted.
 
5486
 
 
5487
    Another class is 'detritus', which includes files emitted by bzr during
 
5488
    normal operations and selftests.  (The value of these files decreases with
 
5489
    time.)
 
5490
 
 
5491
    If no options are specified, unknown files are deleted.  Otherwise, option
 
5492
    flags are respected, and may be combined.
 
5493
 
 
5494
    To check what clean-tree will do, use --dry-run.
 
5495
    """
 
5496
    takes_options = [Option('ignored', help='Delete all ignored files.'),
 
5497
                     Option('detritus', help='Delete conflict files, merge'
 
5498
                            ' backups, and failed selftest dirs.'),
 
5499
                     Option('unknown',
 
5500
                            help='Delete files unknown to bzr (default).'),
 
5501
                     Option('dry-run', help='Show files to delete instead of'
 
5502
                            ' deleting them.'),
 
5503
                     Option('force', help='Do not prompt before deleting.')]
 
5504
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
 
5505
            force=False):
 
5506
        from bzrlib.clean_tree import clean_tree
 
5507
        if not (unknown or ignored or detritus):
 
5508
            unknown = True
 
5509
        if dry_run:
 
5510
            force = True
 
5511
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
 
5512
                   dry_run=dry_run, no_prompt=force)
 
5513
 
 
5514
 
 
5515
def _create_prefix(cur_transport):
 
5516
    needed = [cur_transport]
 
5517
    # Recurse upwards until we can create a directory successfully
 
5518
    while True:
 
5519
        new_transport = cur_transport.clone('..')
 
5520
        if new_transport.base == cur_transport.base:
 
5521
            raise errors.BzrCommandError(
 
5522
                "Failed to create path prefix for %s."
 
5523
                % cur_transport.base)
 
5524
        try:
 
5525
            new_transport.mkdir('.')
 
5526
        except errors.NoSuchFile:
 
5527
            needed.append(new_transport)
 
5528
            cur_transport = new_transport
 
5529
        else:
 
5530
            break
 
5531
    # Now we only need to create child directories
 
5532
    while needed:
 
5533
        cur_transport = needed.pop()
 
5534
        cur_transport.ensure_base()
 
5535
 
 
5536
 
 
5537
# these get imported and then picked up by the scan for cmd_*
 
5538
# TODO: Some more consistent way to split command definitions across files;
 
5539
# we do need to load at least some information about them to know of
 
5540
# aliases.  ideally we would avoid loading the implementation until the
 
5541
# details were needed.
 
5542
from bzrlib.cmd_version_info import cmd_version_info
 
5543
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
5544
from bzrlib.bundle.commands import (
 
5545
    cmd_bundle_info,
 
5546
    )
 
5547
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
5548
from bzrlib.weave_commands import cmd_versionedfile_list, \
 
5549
        cmd_weave_plan_merge, cmd_weave_merge_text