/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-03-12 12:00:49 UTC
  • mfrom: (4119.3.3 Hooks.docs)
  • Revision ID: pqm@pqm.ubuntu.com-20090312120049-uxdmf2dfelp5ctva
(robertc) Migrate all hooks into the HookPoint infrastructure.
        (Robert Collins)

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" % ("\n".join(matches),)
 
2444
 
 
2445
 
 
2446
class cmd_ignored(Command):
 
2447
    """List ignored files and the patterns that matched them.
 
2448
 
 
2449
    List all the ignored files and the ignore pattern that caused the file to
 
2450
    be ignored.
 
2451
 
 
2452
    Alternatively, to list just the files::
 
2453
 
 
2454
        bzr ls --ignored
 
2455
    """
 
2456
 
 
2457
    encoding_type = 'replace'
 
2458
    _see_also = ['ignore', 'ls']
 
2459
 
 
2460
    @display_command
 
2461
    def run(self):
 
2462
        tree = WorkingTree.open_containing(u'.')[0]
 
2463
        tree.lock_read()
 
2464
        try:
 
2465
            for path, file_class, kind, file_id, entry in tree.list_files():
 
2466
                if file_class != 'I':
 
2467
                    continue
 
2468
                ## XXX: Slightly inefficient since this was already calculated
 
2469
                pat = tree.is_ignored(path)
 
2470
                self.outf.write('%-50s %s\n' % (path, pat))
 
2471
        finally:
 
2472
            tree.unlock()
 
2473
 
 
2474
 
 
2475
class cmd_lookup_revision(Command):
 
2476
    """Lookup the revision-id from a revision-number
 
2477
 
 
2478
    :Examples:
 
2479
        bzr lookup-revision 33
 
2480
    """
 
2481
    hidden = True
 
2482
    takes_args = ['revno']
 
2483
 
 
2484
    @display_command
 
2485
    def run(self, revno):
 
2486
        try:
 
2487
            revno = int(revno)
 
2488
        except ValueError:
 
2489
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
 
2490
 
 
2491
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
2492
 
 
2493
 
 
2494
class cmd_export(Command):
 
2495
    """Export current or past revision to a destination directory or archive.
 
2496
 
 
2497
    If no revision is specified this exports the last committed revision.
 
2498
 
 
2499
    Format may be an "exporter" name, such as tar, tgz, tbz2.  If none is
 
2500
    given, try to find the format with the extension. If no extension
 
2501
    is found exports to a directory (equivalent to --format=dir).
 
2502
 
 
2503
    If root is supplied, it will be used as the root directory inside
 
2504
    container formats (tar, zip, etc). If it is not supplied it will default
 
2505
    to the exported filename. The root option has no effect for 'dir' format.
 
2506
 
 
2507
    If branch is omitted then the branch containing the current working
 
2508
    directory will be used.
 
2509
 
 
2510
    Note: Export of tree with non-ASCII filenames to zip is not supported.
 
2511
 
 
2512
      =================       =========================
 
2513
      Supported formats       Autodetected by extension
 
2514
      =================       =========================
 
2515
         dir                         (none)
 
2516
         tar                          .tar
 
2517
         tbz2                    .tar.bz2, .tbz2
 
2518
         tgz                      .tar.gz, .tgz
 
2519
         zip                          .zip
 
2520
      =================       =========================
 
2521
    """
 
2522
    takes_args = ['dest', 'branch_or_subdir?']
 
2523
    takes_options = [
 
2524
        Option('format',
 
2525
               help="Type of file to export to.",
 
2526
               type=unicode),
 
2527
        'revision',
 
2528
        Option('root',
 
2529
               type=str,
 
2530
               help="Name of the root directory inside the exported file."),
 
2531
        ]
 
2532
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
 
2533
        root=None):
 
2534
        from bzrlib.export import export
 
2535
 
 
2536
        if branch_or_subdir is None:
 
2537
            tree = WorkingTree.open_containing(u'.')[0]
 
2538
            b = tree.branch
 
2539
            subdir = None
 
2540
        else:
 
2541
            b, subdir = Branch.open_containing(branch_or_subdir)
 
2542
            tree = None
 
2543
 
 
2544
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
 
2545
        try:
 
2546
            export(rev_tree, dest, format, root, subdir)
 
2547
        except errors.NoSuchExportFormat, e:
 
2548
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
 
2549
 
 
2550
 
 
2551
class cmd_cat(Command):
 
2552
    """Write the contents of a file as of a given revision to standard output.
 
2553
 
 
2554
    If no revision is nominated, the last revision is used.
 
2555
 
 
2556
    Note: Take care to redirect standard output when using this command on a
 
2557
    binary file.
 
2558
    """
 
2559
 
 
2560
    _see_also = ['ls']
 
2561
    takes_options = [
 
2562
        Option('name-from-revision', help='The path name in the old tree.'),
 
2563
        'revision',
 
2564
        ]
 
2565
    takes_args = ['filename']
 
2566
    encoding_type = 'exact'
 
2567
 
 
2568
    @display_command
 
2569
    def run(self, filename, revision=None, name_from_revision=False):
 
2570
        if revision is not None and len(revision) != 1:
 
2571
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
 
2572
                                         " one revision specifier")
 
2573
        tree, branch, relpath = \
 
2574
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
2575
        branch.lock_read()
 
2576
        try:
 
2577
            return self._run(tree, branch, relpath, filename, revision,
 
2578
                             name_from_revision)
 
2579
        finally:
 
2580
            branch.unlock()
 
2581
 
 
2582
    def _run(self, tree, b, relpath, filename, revision, name_from_revision):
 
2583
        if tree is None:
 
2584
            tree = b.basis_tree()
 
2585
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
 
2586
 
 
2587
        cur_file_id = tree.path2id(relpath)
 
2588
        old_file_id = rev_tree.path2id(relpath)
 
2589
 
 
2590
        if name_from_revision:
 
2591
            if old_file_id is None:
 
2592
                raise errors.BzrCommandError(
 
2593
                    "%r is not present in revision %s" % (
 
2594
                        filename, rev_tree.get_revision_id()))
 
2595
            else:
 
2596
                content = rev_tree.get_file_text(old_file_id)
 
2597
        elif cur_file_id is not None:
 
2598
            content = rev_tree.get_file_text(cur_file_id)
 
2599
        elif old_file_id is not None:
 
2600
            content = rev_tree.get_file_text(old_file_id)
 
2601
        else:
 
2602
            raise errors.BzrCommandError(
 
2603
                "%r is not present in revision %s" % (
 
2604
                    filename, rev_tree.get_revision_id()))
 
2605
        self.outf.write(content)
 
2606
 
 
2607
 
 
2608
class cmd_local_time_offset(Command):
 
2609
    """Show the offset in seconds from GMT to local time."""
 
2610
    hidden = True
 
2611
    @display_command
 
2612
    def run(self):
 
2613
        print osutils.local_time_offset()
 
2614
 
 
2615
 
 
2616
 
 
2617
class cmd_commit(Command):
 
2618
    """Commit changes into a new revision.
 
2619
 
 
2620
    If no arguments are given, the entire tree is committed.
 
2621
 
 
2622
    If selected files are specified, only changes to those files are
 
2623
    committed.  If a directory is specified then the directory and everything
 
2624
    within it is committed.
 
2625
 
 
2626
    When excludes are given, they take precedence over selected files.
 
2627
    For example, too commit only changes within foo, but not changes within
 
2628
    foo/bar::
 
2629
 
 
2630
      bzr commit foo -x foo/bar
 
2631
 
 
2632
    If author of the change is not the same person as the committer, you can
 
2633
    specify the author's name using the --author option. The name should be
 
2634
    in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
 
2635
    If there is more than one author of the change you can specify the option
 
2636
    multiple times, once for each author.
 
2637
 
 
2638
    A selected-file commit may fail in some cases where the committed
 
2639
    tree would be invalid. Consider::
 
2640
 
 
2641
      bzr init foo
 
2642
      mkdir foo/bar
 
2643
      bzr add foo/bar
 
2644
      bzr commit foo -m "committing foo"
 
2645
      bzr mv foo/bar foo/baz
 
2646
      mkdir foo/bar
 
2647
      bzr add foo/bar
 
2648
      bzr commit foo/bar -m "committing bar but not baz"
 
2649
 
 
2650
    In the example above, the last commit will fail by design. This gives
 
2651
    the user the opportunity to decide whether they want to commit the
 
2652
    rename at the same time, separately first, or not at all. (As a general
 
2653
    rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
 
2654
 
 
2655
    Note: A selected-file commit after a merge is not yet supported.
 
2656
    """
 
2657
    # TODO: Run hooks on tree to-be-committed, and after commit.
 
2658
 
 
2659
    # TODO: Strict commit that fails if there are deleted files.
 
2660
    #       (what does "deleted files" mean ??)
 
2661
 
 
2662
    # TODO: Give better message for -s, --summary, used by tla people
 
2663
 
 
2664
    # XXX: verbose currently does nothing
 
2665
 
 
2666
    _see_also = ['bugs', 'uncommit']
 
2667
    takes_args = ['selected*']
 
2668
    takes_options = [
 
2669
            ListOption('exclude', type=str, short_name='x',
 
2670
                help="Do not consider changes made to a given path."),
 
2671
            Option('message', type=unicode,
 
2672
                   short_name='m',
 
2673
                   help="Description of the new revision."),
 
2674
            'verbose',
 
2675
             Option('unchanged',
 
2676
                    help='Commit even if nothing has changed.'),
 
2677
             Option('file', type=str,
 
2678
                    short_name='F',
 
2679
                    argname='msgfile',
 
2680
                    help='Take commit message from this file.'),
 
2681
             Option('strict',
 
2682
                    help="Refuse to commit if there are unknown "
 
2683
                    "files in the working tree."),
 
2684
             ListOption('fixes', type=str,
 
2685
                    help="Mark a bug as being fixed by this revision "
 
2686
                         "(see \"bzr help bugs\")."),
 
2687
             ListOption('author', type=unicode,
 
2688
                    help="Set the author's name, if it's different "
 
2689
                         "from the committer."),
 
2690
             Option('local',
 
2691
                    help="Perform a local commit in a bound "
 
2692
                         "branch.  Local commits are not pushed to "
 
2693
                         "the master branch until a normal commit "
 
2694
                         "is performed."
 
2695
                    ),
 
2696
              Option('show-diff',
 
2697
                     help='When no message is supplied, show the diff along'
 
2698
                     ' with the status summary in the message editor.'),
 
2699
             ]
 
2700
    aliases = ['ci', 'checkin']
 
2701
 
 
2702
    def _get_bug_fix_properties(self, fixes, branch):
 
2703
        properties = []
 
2704
        # Configure the properties for bug fixing attributes.
 
2705
        for fixed_bug in fixes:
 
2706
            tokens = fixed_bug.split(':')
 
2707
            if len(tokens) != 2:
 
2708
                raise errors.BzrCommandError(
 
2709
                    "Invalid bug %s. Must be in the form of 'tracker:id'. "
 
2710
                    "See \"bzr help bugs\" for more information on this "
 
2711
                    "feature.\nCommit refused." % fixed_bug)
 
2712
            tag, bug_id = tokens
 
2713
            try:
 
2714
                bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
 
2715
            except errors.UnknownBugTrackerAbbreviation:
 
2716
                raise errors.BzrCommandError(
 
2717
                    'Unrecognized bug %s. Commit refused.' % fixed_bug)
 
2718
            except errors.MalformedBugIdentifier, e:
 
2719
                raise errors.BzrCommandError(
 
2720
                    "%s\nCommit refused." % (str(e),))
 
2721
            properties.append('%s fixed' % bug_url)
 
2722
        return '\n'.join(properties)
 
2723
 
 
2724
    def run(self, message=None, file=None, verbose=False, selected_list=None,
 
2725
            unchanged=False, strict=False, local=False, fixes=None,
 
2726
            author=None, show_diff=False, exclude=None):
 
2727
        from bzrlib.errors import (
 
2728
            PointlessCommit,
 
2729
            ConflictsInTree,
 
2730
            StrictCommitFailed
 
2731
        )
 
2732
        from bzrlib.msgeditor import (
 
2733
            edit_commit_message_encoded,
 
2734
            generate_commit_message_template,
 
2735
            make_commit_message_template_encoded
 
2736
        )
 
2737
 
 
2738
        # TODO: Need a blackbox test for invoking the external editor; may be
 
2739
        # slightly problematic to run this cross-platform.
 
2740
 
 
2741
        # TODO: do more checks that the commit will succeed before
 
2742
        # spending the user's valuable time typing a commit message.
 
2743
 
 
2744
        properties = {}
 
2745
 
 
2746
        tree, selected_list = tree_files(selected_list)
 
2747
        if selected_list == ['']:
 
2748
            # workaround - commit of root of tree should be exactly the same
 
2749
            # as just default commit in that tree, and succeed even though
 
2750
            # selected-file merge commit is not done yet
 
2751
            selected_list = []
 
2752
 
 
2753
        if fixes is None:
 
2754
            fixes = []
 
2755
        bug_property = self._get_bug_fix_properties(fixes, tree.branch)
 
2756
        if bug_property:
 
2757
            properties['bugs'] = bug_property
 
2758
 
 
2759
        if local and not tree.branch.get_bound_location():
 
2760
            raise errors.LocalRequiresBoundBranch()
 
2761
 
 
2762
        def get_message(commit_obj):
 
2763
            """Callback to get commit message"""
 
2764
            my_message = message
 
2765
            if my_message is None and not file:
 
2766
                t = make_commit_message_template_encoded(tree,
 
2767
                        selected_list, diff=show_diff,
 
2768
                        output_encoding=osutils.get_user_encoding())
 
2769
                start_message = generate_commit_message_template(commit_obj)
 
2770
                my_message = edit_commit_message_encoded(t,
 
2771
                    start_message=start_message)
 
2772
                if my_message is None:
 
2773
                    raise errors.BzrCommandError("please specify a commit"
 
2774
                        " message with either --message or --file")
 
2775
            elif my_message and file:
 
2776
                raise errors.BzrCommandError(
 
2777
                    "please specify either --message or --file")
 
2778
            if file:
 
2779
                my_message = codecs.open(file, 'rt',
 
2780
                                         osutils.get_user_encoding()).read()
 
2781
            if my_message == "":
 
2782
                raise errors.BzrCommandError("empty commit message specified")
 
2783
            return my_message
 
2784
 
 
2785
        try:
 
2786
            tree.commit(message_callback=get_message,
 
2787
                        specific_files=selected_list,
 
2788
                        allow_pointless=unchanged, strict=strict, local=local,
 
2789
                        reporter=None, verbose=verbose, revprops=properties,
 
2790
                        authors=author,
 
2791
                        exclude=safe_relpath_files(tree, exclude))
 
2792
        except PointlessCommit:
 
2793
            # FIXME: This should really happen before the file is read in;
 
2794
            # perhaps prepare the commit; get the message; then actually commit
 
2795
            raise errors.BzrCommandError("no changes to commit."
 
2796
                              " use --unchanged to commit anyhow")
 
2797
        except ConflictsInTree:
 
2798
            raise errors.BzrCommandError('Conflicts detected in working '
 
2799
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
 
2800
                ' resolve.')
 
2801
        except StrictCommitFailed:
 
2802
            raise errors.BzrCommandError("Commit refused because there are"
 
2803
                              " unknown files in the working tree.")
 
2804
        except errors.BoundBranchOutOfDate, e:
 
2805
            raise errors.BzrCommandError(str(e) + "\n"
 
2806
            'To commit to master branch, run update and then commit.\n'
 
2807
            'You can also pass --local to commit to continue working '
 
2808
            'disconnected.')
 
2809
 
 
2810
 
 
2811
class cmd_check(Command):
 
2812
    """Validate working tree structure, branch consistency and repository history.
 
2813
 
 
2814
    This command checks various invariants about branch and repository storage
 
2815
    to detect data corruption or bzr bugs.
 
2816
 
 
2817
    The working tree and branch checks will only give output if a problem is
 
2818
    detected. The output fields of the repository check are:
 
2819
 
 
2820
        revisions: This is just the number of revisions checked.  It doesn't
 
2821
            indicate a problem.
 
2822
        versionedfiles: This is just the number of versionedfiles checked.  It
 
2823
            doesn't indicate a problem.
 
2824
        unreferenced ancestors: Texts that are ancestors of other texts, but
 
2825
            are not properly referenced by the revision ancestry.  This is a
 
2826
            subtle problem that Bazaar can work around.
 
2827
        unique file texts: This is the total number of unique file contents
 
2828
            seen in the checked revisions.  It does not indicate a problem.
 
2829
        repeated file texts: This is the total number of repeated texts seen
 
2830
            in the checked revisions.  Texts can be repeated when their file
 
2831
            entries are modified, but the file contents are not.  It does not
 
2832
            indicate a problem.
 
2833
 
 
2834
    If no restrictions are specified, all Bazaar data that is found at the given
 
2835
    location will be checked.
 
2836
 
 
2837
    :Examples:
 
2838
 
 
2839
        Check the tree and branch at 'foo'::
 
2840
 
 
2841
            bzr check --tree --branch foo
 
2842
 
 
2843
        Check only the repository at 'bar'::
 
2844
 
 
2845
            bzr check --repo bar
 
2846
 
 
2847
        Check everything at 'baz'::
 
2848
 
 
2849
            bzr check baz
 
2850
    """
 
2851
 
 
2852
    _see_also = ['reconcile']
 
2853
    takes_args = ['path?']
 
2854
    takes_options = ['verbose',
 
2855
                     Option('branch', help="Check the branch related to the"
 
2856
                                           " current directory."),
 
2857
                     Option('repo', help="Check the repository related to the"
 
2858
                                         " current directory."),
 
2859
                     Option('tree', help="Check the working tree related to"
 
2860
                                         " the current directory.")]
 
2861
 
 
2862
    def run(self, path=None, verbose=False, branch=False, repo=False,
 
2863
            tree=False):
 
2864
        from bzrlib.check import check_dwim
 
2865
        if path is None:
 
2866
            path = '.'
 
2867
        if not branch and not repo and not tree:
 
2868
            branch = repo = tree = True
 
2869
        check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
 
2870
 
 
2871
 
 
2872
class cmd_upgrade(Command):
 
2873
    """Upgrade branch storage to current format.
 
2874
 
 
2875
    The check command or bzr developers may sometimes advise you to run
 
2876
    this command. When the default format has changed you may also be warned
 
2877
    during other operations to upgrade.
 
2878
    """
 
2879
 
 
2880
    _see_also = ['check']
 
2881
    takes_args = ['url?']
 
2882
    takes_options = [
 
2883
                    RegistryOption('format',
 
2884
                        help='Upgrade to a specific format.  See "bzr help'
 
2885
                             ' formats" for details.',
 
2886
                        lazy_registry=('bzrlib.bzrdir', 'format_registry'),
 
2887
                        converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
 
2888
                        value_switches=True, title='Branch format'),
 
2889
                    ]
 
2890
 
 
2891
    def run(self, url='.', format=None):
 
2892
        from bzrlib.upgrade import upgrade
 
2893
        if format is None:
 
2894
            format = bzrdir.format_registry.make_bzrdir('default')
 
2895
        upgrade(url, format)
 
2896
 
 
2897
 
 
2898
class cmd_whoami(Command):
 
2899
    """Show or set bzr user id.
 
2900
 
 
2901
    :Examples:
 
2902
        Show the email of the current user::
 
2903
 
 
2904
            bzr whoami --email
 
2905
 
 
2906
        Set the current user::
 
2907
 
 
2908
            bzr whoami "Frank Chu <fchu@example.com>"
 
2909
    """
 
2910
    takes_options = [ Option('email',
 
2911
                             help='Display email address only.'),
 
2912
                      Option('branch',
 
2913
                             help='Set identity for the current branch instead of '
 
2914
                                  'globally.'),
 
2915
                    ]
 
2916
    takes_args = ['name?']
 
2917
    encoding_type = 'replace'
 
2918
 
 
2919
    @display_command
 
2920
    def run(self, email=False, branch=False, name=None):
 
2921
        if name is None:
 
2922
            # use branch if we're inside one; otherwise global config
 
2923
            try:
 
2924
                c = Branch.open_containing('.')[0].get_config()
 
2925
            except errors.NotBranchError:
 
2926
                c = config.GlobalConfig()
 
2927
            if email:
 
2928
                self.outf.write(c.user_email() + '\n')
 
2929
            else:
 
2930
                self.outf.write(c.username() + '\n')
 
2931
            return
 
2932
 
 
2933
        # display a warning if an email address isn't included in the given name.
 
2934
        try:
 
2935
            config.extract_email_address(name)
 
2936
        except errors.NoEmailInUsername, e:
 
2937
            warning('"%s" does not seem to contain an email address.  '
 
2938
                    'This is allowed, but not recommended.', name)
 
2939
 
 
2940
        # use global config unless --branch given
 
2941
        if branch:
 
2942
            c = Branch.open_containing('.')[0].get_config()
 
2943
        else:
 
2944
            c = config.GlobalConfig()
 
2945
        c.set_user_option('email', name)
 
2946
 
 
2947
 
 
2948
class cmd_nick(Command):
 
2949
    """Print or set the branch nickname.
 
2950
 
 
2951
    If unset, the tree root directory name is used as the nickname.
 
2952
    To print the current nickname, execute with no argument.
 
2953
 
 
2954
    Bound branches use the nickname of its master branch unless it is set
 
2955
    locally.
 
2956
    """
 
2957
 
 
2958
    _see_also = ['info']
 
2959
    takes_args = ['nickname?']
 
2960
    def run(self, nickname=None):
 
2961
        branch = Branch.open_containing(u'.')[0]
 
2962
        if nickname is None:
 
2963
            self.printme(branch)
 
2964
        else:
 
2965
            branch.nick = nickname
 
2966
 
 
2967
    @display_command
 
2968
    def printme(self, branch):
 
2969
        print branch.nick
 
2970
 
 
2971
 
 
2972
class cmd_alias(Command):
 
2973
    """Set/unset and display aliases.
 
2974
 
 
2975
    :Examples:
 
2976
        Show the current aliases::
 
2977
 
 
2978
            bzr alias
 
2979
 
 
2980
        Show the alias specified for 'll'::
 
2981
 
 
2982
            bzr alias ll
 
2983
 
 
2984
        Set an alias for 'll'::
 
2985
 
 
2986
            bzr alias ll="log --line -r-10..-1"
 
2987
 
 
2988
        To remove an alias for 'll'::
 
2989
 
 
2990
            bzr alias --remove ll
 
2991
 
 
2992
    """
 
2993
    takes_args = ['name?']
 
2994
    takes_options = [
 
2995
        Option('remove', help='Remove the alias.'),
 
2996
        ]
 
2997
 
 
2998
    def run(self, name=None, remove=False):
 
2999
        if remove:
 
3000
            self.remove_alias(name)
 
3001
        elif name is None:
 
3002
            self.print_aliases()
 
3003
        else:
 
3004
            equal_pos = name.find('=')
 
3005
            if equal_pos == -1:
 
3006
                self.print_alias(name)
 
3007
            else:
 
3008
                self.set_alias(name[:equal_pos], name[equal_pos+1:])
 
3009
 
 
3010
    def remove_alias(self, alias_name):
 
3011
        if alias_name is None:
 
3012
            raise errors.BzrCommandError(
 
3013
                'bzr alias --remove expects an alias to remove.')
 
3014
        # If alias is not found, print something like:
 
3015
        # unalias: foo: not found
 
3016
        c = config.GlobalConfig()
 
3017
        c.unset_alias(alias_name)
 
3018
 
 
3019
    @display_command
 
3020
    def print_aliases(self):
 
3021
        """Print out the defined aliases in a similar format to bash."""
 
3022
        aliases = config.GlobalConfig().get_aliases()
 
3023
        for key, value in sorted(aliases.iteritems()):
 
3024
            self.outf.write('bzr alias %s="%s"\n' % (key, value))
 
3025
 
 
3026
    @display_command
 
3027
    def print_alias(self, alias_name):
 
3028
        from bzrlib.commands import get_alias
 
3029
        alias = get_alias(alias_name)
 
3030
        if alias is None:
 
3031
            self.outf.write("bzr alias: %s: not found\n" % alias_name)
 
3032
        else:
 
3033
            self.outf.write(
 
3034
                'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
 
3035
 
 
3036
    def set_alias(self, alias_name, alias_command):
 
3037
        """Save the alias in the global config."""
 
3038
        c = config.GlobalConfig()
 
3039
        c.set_alias(alias_name, alias_command)
 
3040
 
 
3041
 
 
3042
class cmd_selftest(Command):
 
3043
    """Run internal test suite.
 
3044
 
 
3045
    If arguments are given, they are regular expressions that say which tests
 
3046
    should run.  Tests matching any expression are run, and other tests are
 
3047
    not run.
 
3048
 
 
3049
    Alternatively if --first is given, matching tests are run first and then
 
3050
    all other tests are run.  This is useful if you have been working in a
 
3051
    particular area, but want to make sure nothing else was broken.
 
3052
 
 
3053
    If --exclude is given, tests that match that regular expression are
 
3054
    excluded, regardless of whether they match --first or not.
 
3055
 
 
3056
    To help catch accidential dependencies between tests, the --randomize
 
3057
    option is useful. In most cases, the argument used is the word 'now'.
 
3058
    Note that the seed used for the random number generator is displayed
 
3059
    when this option is used. The seed can be explicitly passed as the
 
3060
    argument to this option if required. This enables reproduction of the
 
3061
    actual ordering used if and when an order sensitive problem is encountered.
 
3062
 
 
3063
    If --list-only is given, the tests that would be run are listed. This is
 
3064
    useful when combined with --first, --exclude and/or --randomize to
 
3065
    understand their impact. The test harness reports "Listed nn tests in ..."
 
3066
    instead of "Ran nn tests in ..." when list mode is enabled.
 
3067
 
 
3068
    If the global option '--no-plugins' is given, plugins are not loaded
 
3069
    before running the selftests.  This has two effects: features provided or
 
3070
    modified by plugins will not be tested, and tests provided by plugins will
 
3071
    not be run.
 
3072
 
 
3073
    Tests that need working space on disk use a common temporary directory,
 
3074
    typically inside $TMPDIR or /tmp.
 
3075
 
 
3076
    :Examples:
 
3077
        Run only tests relating to 'ignore'::
 
3078
 
 
3079
            bzr selftest ignore
 
3080
 
 
3081
        Disable plugins and list tests as they're run::
 
3082
 
 
3083
            bzr --no-plugins selftest -v
 
3084
    """
 
3085
    # NB: this is used from the class without creating an instance, which is
 
3086
    # why it does not have a self parameter.
 
3087
    def get_transport_type(typestring):
 
3088
        """Parse and return a transport specifier."""
 
3089
        if typestring == "sftp":
 
3090
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
3091
            return SFTPAbsoluteServer
 
3092
        if typestring == "memory":
 
3093
            from bzrlib.transport.memory import MemoryServer
 
3094
            return MemoryServer
 
3095
        if typestring == "fakenfs":
 
3096
            from bzrlib.transport.fakenfs import FakeNFSServer
 
3097
            return FakeNFSServer
 
3098
        msg = "No known transport type %s. Supported types are: sftp\n" %\
 
3099
            (typestring)
 
3100
        raise errors.BzrCommandError(msg)
 
3101
 
 
3102
    hidden = True
 
3103
    takes_args = ['testspecs*']
 
3104
    takes_options = ['verbose',
 
3105
                     Option('one',
 
3106
                             help='Stop when one test fails.',
 
3107
                             short_name='1',
 
3108
                             ),
 
3109
                     Option('transport',
 
3110
                            help='Use a different transport by default '
 
3111
                                 'throughout the test suite.',
 
3112
                            type=get_transport_type),
 
3113
                     Option('benchmark',
 
3114
                            help='Run the benchmarks rather than selftests.'),
 
3115
                     Option('lsprof-timed',
 
3116
                            help='Generate lsprof output for benchmarked'
 
3117
                                 ' sections of code.'),
 
3118
                     Option('cache-dir', type=str,
 
3119
                            help='Cache intermediate benchmark output in this '
 
3120
                                 'directory.'),
 
3121
                     Option('first',
 
3122
                            help='Run all tests, but run specified tests first.',
 
3123
                            short_name='f',
 
3124
                            ),
 
3125
                     Option('list-only',
 
3126
                            help='List the tests instead of running them.'),
 
3127
                     Option('randomize', type=str, argname="SEED",
 
3128
                            help='Randomize the order of tests using the given'
 
3129
                                 ' seed or "now" for the current time.'),
 
3130
                     Option('exclude', type=str, argname="PATTERN",
 
3131
                            short_name='x',
 
3132
                            help='Exclude tests that match this regular'
 
3133
                                 ' expression.'),
 
3134
                     Option('strict', help='Fail on missing dependencies or '
 
3135
                            'known failures.'),
 
3136
                     Option('load-list', type=str, argname='TESTLISTFILE',
 
3137
                            help='Load a test id list from a text file.'),
 
3138
                     ListOption('debugflag', type=str, short_name='E',
 
3139
                                help='Turn on a selftest debug flag.'),
 
3140
                     ListOption('starting-with', type=str, argname='TESTID',
 
3141
                                param_name='starting_with', short_name='s',
 
3142
                                help=
 
3143
                                'Load only the tests starting with TESTID.'),
 
3144
                     ]
 
3145
    encoding_type = 'replace'
 
3146
 
 
3147
    def __init__(self):
 
3148
        Command.__init__(self)
 
3149
        self.additional_selftest_args = {}
 
3150
 
 
3151
    def run(self, testspecs_list=None, verbose=False, one=False,
 
3152
            transport=None, benchmark=None,
 
3153
            lsprof_timed=None, cache_dir=None,
 
3154
            first=False, list_only=False,
 
3155
            randomize=None, exclude=None, strict=False,
 
3156
            load_list=None, debugflag=None, starting_with=None):
 
3157
        from bzrlib.tests import selftest
 
3158
        import bzrlib.benchmarks as benchmarks
 
3159
        from bzrlib.benchmarks import tree_creator
 
3160
 
 
3161
        # Make deprecation warnings visible, unless -Werror is set
 
3162
        symbol_versioning.activate_deprecation_warnings(override=False)
 
3163
 
 
3164
        if cache_dir is not None:
 
3165
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
 
3166
        if not list_only:
 
3167
            print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
 
3168
            print '   %s (%s python%s)' % (
 
3169
                    bzrlib.__path__[0],
 
3170
                    bzrlib.version_string,
 
3171
                    bzrlib._format_version_tuple(sys.version_info),
 
3172
                    )
 
3173
        print
 
3174
        if testspecs_list is not None:
 
3175
            pattern = '|'.join(testspecs_list)
 
3176
        else:
 
3177
            pattern = ".*"
 
3178
        if benchmark:
 
3179
            test_suite_factory = benchmarks.test_suite
 
3180
            # Unless user explicitly asks for quiet, be verbose in benchmarks
 
3181
            verbose = not is_quiet()
 
3182
            # TODO: should possibly lock the history file...
 
3183
            benchfile = open(".perf_history", "at", buffering=1)
 
3184
        else:
 
3185
            test_suite_factory = None
 
3186
            benchfile = None
 
3187
        try:
 
3188
            selftest_kwargs = {"verbose": verbose,
 
3189
                              "pattern": pattern,
 
3190
                              "stop_on_failure": one,
 
3191
                              "transport": transport,
 
3192
                              "test_suite_factory": test_suite_factory,
 
3193
                              "lsprof_timed": lsprof_timed,
 
3194
                              "bench_history": benchfile,
 
3195
                              "matching_tests_first": first,
 
3196
                              "list_only": list_only,
 
3197
                              "random_seed": randomize,
 
3198
                              "exclude_pattern": exclude,
 
3199
                              "strict": strict,
 
3200
                              "load_list": load_list,
 
3201
                              "debug_flags": debugflag,
 
3202
                              "starting_with": starting_with
 
3203
                              }
 
3204
            selftest_kwargs.update(self.additional_selftest_args)
 
3205
            result = selftest(**selftest_kwargs)
 
3206
        finally:
 
3207
            if benchfile is not None:
 
3208
                benchfile.close()
 
3209
        if result:
 
3210
            note('tests passed')
 
3211
        else:
 
3212
            note('tests failed')
 
3213
        return int(not result)
 
3214
 
 
3215
 
 
3216
class cmd_version(Command):
 
3217
    """Show version of bzr."""
 
3218
 
 
3219
    encoding_type = 'replace'
 
3220
    takes_options = [
 
3221
        Option("short", help="Print just the version number."),
 
3222
        ]
 
3223
 
 
3224
    @display_command
 
3225
    def run(self, short=False):
 
3226
        from bzrlib.version import show_version
 
3227
        if short:
 
3228
            self.outf.write(bzrlib.version_string + '\n')
 
3229
        else:
 
3230
            show_version(to_file=self.outf)
 
3231
 
 
3232
 
 
3233
class cmd_rocks(Command):
 
3234
    """Statement of optimism."""
 
3235
 
 
3236
    hidden = True
 
3237
 
 
3238
    @display_command
 
3239
    def run(self):
 
3240
        print "It sure does!"
 
3241
 
 
3242
 
 
3243
class cmd_find_merge_base(Command):
 
3244
    """Find and print a base revision for merging two branches."""
 
3245
    # TODO: Options to specify revisions on either side, as if
 
3246
    #       merging only part of the history.
 
3247
    takes_args = ['branch', 'other']
 
3248
    hidden = True
 
3249
 
 
3250
    @display_command
 
3251
    def run(self, branch, other):
 
3252
        from bzrlib.revision import ensure_null
 
3253
 
 
3254
        branch1 = Branch.open_containing(branch)[0]
 
3255
        branch2 = Branch.open_containing(other)[0]
 
3256
        branch1.lock_read()
 
3257
        try:
 
3258
            branch2.lock_read()
 
3259
            try:
 
3260
                last1 = ensure_null(branch1.last_revision())
 
3261
                last2 = ensure_null(branch2.last_revision())
 
3262
 
 
3263
                graph = branch1.repository.get_graph(branch2.repository)
 
3264
                base_rev_id = graph.find_unique_lca(last1, last2)
 
3265
 
 
3266
                print 'merge base is revision %s' % base_rev_id
 
3267
            finally:
 
3268
                branch2.unlock()
 
3269
        finally:
 
3270
            branch1.unlock()
 
3271
 
 
3272
 
 
3273
class cmd_merge(Command):
 
3274
    """Perform a three-way merge.
 
3275
 
 
3276
    The source of the merge can be specified either in the form of a branch,
 
3277
    or in the form of a path to a file containing a merge directive generated
 
3278
    with bzr send. If neither is specified, the default is the upstream branch
 
3279
    or the branch most recently merged using --remember.
 
3280
 
 
3281
    When merging a branch, by default the tip will be merged. To pick a different
 
3282
    revision, pass --revision. If you specify two values, the first will be used as
 
3283
    BASE and the second one as OTHER. Merging individual revisions, or a subset of
 
3284
    available revisions, like this is commonly referred to as "cherrypicking".
 
3285
 
 
3286
    Revision numbers are always relative to the branch being merged.
 
3287
 
 
3288
    By default, bzr will try to merge in all new work from the other
 
3289
    branch, automatically determining an appropriate base.  If this
 
3290
    fails, you may need to give an explicit base.
 
3291
 
 
3292
    Merge will do its best to combine the changes in two branches, but there
 
3293
    are some kinds of problems only a human can fix.  When it encounters those,
 
3294
    it will mark a conflict.  A conflict means that you need to fix something,
 
3295
    before you should commit.
 
3296
 
 
3297
    Use bzr resolve when you have fixed a problem.  See also bzr conflicts.
 
3298
 
 
3299
    If there is no default branch set, the first merge will set it. After
 
3300
    that, you can omit the branch to use the default.  To change the
 
3301
    default, use --remember. The value will only be saved if the remote
 
3302
    location can be accessed.
 
3303
 
 
3304
    The results of the merge are placed into the destination working
 
3305
    directory, where they can be reviewed (with bzr diff), tested, and then
 
3306
    committed to record the result of the merge.
 
3307
 
 
3308
    merge refuses to run if there are any uncommitted changes, unless
 
3309
    --force is given.
 
3310
 
 
3311
    :Examples:
 
3312
        To merge the latest revision from bzr.dev::
 
3313
 
 
3314
            bzr merge ../bzr.dev
 
3315
 
 
3316
        To merge changes up to and including revision 82 from bzr.dev::
 
3317
 
 
3318
            bzr merge -r 82 ../bzr.dev
 
3319
 
 
3320
        To merge the changes introduced by 82, without previous changes::
 
3321
 
 
3322
            bzr merge -r 81..82 ../bzr.dev
 
3323
 
 
3324
        To apply a merge directive contained in in /tmp/merge:
 
3325
 
 
3326
            bzr merge /tmp/merge
 
3327
    """
 
3328
 
 
3329
    encoding_type = 'exact'
 
3330
    _see_also = ['update', 'remerge', 'status-flags', 'send']
 
3331
    takes_args = ['location?']
 
3332
    takes_options = [
 
3333
        'change',
 
3334
        'revision',
 
3335
        Option('force',
 
3336
               help='Merge even if the destination tree has uncommitted changes.'),
 
3337
        'merge-type',
 
3338
        'reprocess',
 
3339
        'remember',
 
3340
        Option('show-base', help="Show base revision text in "
 
3341
               "conflicts."),
 
3342
        Option('uncommitted', help='Apply uncommitted changes'
 
3343
               ' from a working copy, instead of branch changes.'),
 
3344
        Option('pull', help='If the destination is already'
 
3345
                ' completely merged into the source, pull from the'
 
3346
                ' source rather than merging.  When this happens,'
 
3347
                ' you do not need to commit the result.'),
 
3348
        Option('directory',
 
3349
               help='Branch to merge into, '
 
3350
                    'rather than the one containing the working directory.',
 
3351
               short_name='d',
 
3352
               type=unicode,
 
3353
               ),
 
3354
        Option('preview', help='Instead of merging, show a diff of the merge.')
 
3355
    ]
 
3356
 
 
3357
    def run(self, location=None, revision=None, force=False,
 
3358
            merge_type=None, show_base=False, reprocess=None, remember=False,
 
3359
            uncommitted=False, pull=False,
 
3360
            directory=None,
 
3361
            preview=False,
 
3362
            ):
 
3363
        if merge_type is None:
 
3364
            merge_type = _mod_merge.Merge3Merger
 
3365
 
 
3366
        if directory is None: directory = u'.'
 
3367
        possible_transports = []
 
3368
        merger = None
 
3369
        allow_pending = True
 
3370
        verified = 'inapplicable'
 
3371
        tree = WorkingTree.open_containing(directory)[0]
 
3372
 
 
3373
        # die as quickly as possible if there are uncommitted changes
 
3374
        try:
 
3375
            basis_tree = tree.revision_tree(tree.last_revision())
 
3376
        except errors.NoSuchRevision:
 
3377
            basis_tree = tree.basis_tree()
 
3378
        changes = tree.changes_from(basis_tree)
 
3379
        if changes.has_changed():
 
3380
            raise errors.UncommittedChanges(tree)
 
3381
 
 
3382
        view_info = _get_view_info_for_change_reporter(tree)
 
3383
        change_reporter = delta._ChangeReporter(
 
3384
            unversioned_filter=tree.is_ignored, view_info=view_info)
 
3385
        cleanups = []
 
3386
        try:
 
3387
            pb = ui.ui_factory.nested_progress_bar()
 
3388
            cleanups.append(pb.finished)
 
3389
            tree.lock_write()
 
3390
            cleanups.append(tree.unlock)
 
3391
            if location is not None:
 
3392
                try:
 
3393
                    mergeable = bundle.read_mergeable_from_url(location,
 
3394
                        possible_transports=possible_transports)
 
3395
                except errors.NotABundle:
 
3396
                    mergeable = None
 
3397
                else:
 
3398
                    if uncommitted:
 
3399
                        raise errors.BzrCommandError('Cannot use --uncommitted'
 
3400
                            ' with bundles or merge directives.')
 
3401
 
 
3402
                    if revision is not None:
 
3403
                        raise errors.BzrCommandError(
 
3404
                            'Cannot use -r with merge directives or bundles')
 
3405
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
3406
                       mergeable, pb)
 
3407
 
 
3408
            if merger is None and uncommitted:
 
3409
                if revision is not None and len(revision) > 0:
 
3410
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
 
3411
                        ' --revision at the same time.')
 
3412
                location = self._select_branch_location(tree, location)[0]
 
3413
                other_tree, other_path = WorkingTree.open_containing(location)
 
3414
                merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
 
3415
                    pb)
 
3416
                allow_pending = False
 
3417
                if other_path != '':
 
3418
                    merger.interesting_files = [other_path]
 
3419
 
 
3420
            if merger is None:
 
3421
                merger, allow_pending = self._get_merger_from_branch(tree,
 
3422
                    location, revision, remember, possible_transports, pb)
 
3423
 
 
3424
            merger.merge_type = merge_type
 
3425
            merger.reprocess = reprocess
 
3426
            merger.show_base = show_base
 
3427
            self.sanity_check_merger(merger)
 
3428
            if (merger.base_rev_id == merger.other_rev_id and
 
3429
                merger.other_rev_id is not None):
 
3430
                note('Nothing to do.')
 
3431
                return 0
 
3432
            if pull:
 
3433
                if merger.interesting_files is not None:
 
3434
                    raise errors.BzrCommandError('Cannot pull individual files')
 
3435
                if (merger.base_rev_id == tree.last_revision()):
 
3436
                    result = tree.pull(merger.other_branch, False,
 
3437
                                       merger.other_rev_id)
 
3438
                    result.report(self.outf)
 
3439
                    return 0
 
3440
            merger.check_basis(False)
 
3441
            if preview:
 
3442
                return self._do_preview(merger)
 
3443
            else:
 
3444
                return self._do_merge(merger, change_reporter, allow_pending,
 
3445
                                      verified)
 
3446
        finally:
 
3447
            for cleanup in reversed(cleanups):
 
3448
                cleanup()
 
3449
 
 
3450
    def _do_preview(self, merger):
 
3451
        from bzrlib.diff import show_diff_trees
 
3452
        tree_merger = merger.make_merger()
 
3453
        tt = tree_merger.make_preview_transform()
 
3454
        try:
 
3455
            result_tree = tt.get_preview_tree()
 
3456
            show_diff_trees(merger.this_tree, result_tree, self.outf,
 
3457
                            old_label='', new_label='')
 
3458
        finally:
 
3459
            tt.finalize()
 
3460
 
 
3461
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
 
3462
        merger.change_reporter = change_reporter
 
3463
        conflict_count = merger.do_merge()
 
3464
        if allow_pending:
 
3465
            merger.set_pending()
 
3466
        if verified == 'failed':
 
3467
            warning('Preview patch does not match changes')
 
3468
        if conflict_count != 0:
 
3469
            return 1
 
3470
        else:
 
3471
            return 0
 
3472
 
 
3473
    def sanity_check_merger(self, merger):
 
3474
        if (merger.show_base and
 
3475
            not merger.merge_type is _mod_merge.Merge3Merger):
 
3476
            raise errors.BzrCommandError("Show-base is not supported for this"
 
3477
                                         " merge type. %s" % merger.merge_type)
 
3478
        if merger.reprocess is None:
 
3479
            if merger.show_base:
 
3480
                merger.reprocess = False
 
3481
            else:
 
3482
                # Use reprocess if the merger supports it
 
3483
                merger.reprocess = merger.merge_type.supports_reprocess
 
3484
        if merger.reprocess and not merger.merge_type.supports_reprocess:
 
3485
            raise errors.BzrCommandError("Conflict reduction is not supported"
 
3486
                                         " for merge type %s." %
 
3487
                                         merger.merge_type)
 
3488
        if merger.reprocess and merger.show_base:
 
3489
            raise errors.BzrCommandError("Cannot do conflict reduction and"
 
3490
                                         " show base.")
 
3491
 
 
3492
    def _get_merger_from_branch(self, tree, location, revision, remember,
 
3493
                                possible_transports, pb):
 
3494
        """Produce a merger from a location, assuming it refers to a branch."""
 
3495
        from bzrlib.tag import _merge_tags_if_possible
 
3496
        # find the branch locations
 
3497
        other_loc, user_location = self._select_branch_location(tree, location,
 
3498
            revision, -1)
 
3499
        if revision is not None and len(revision) == 2:
 
3500
            base_loc, _unused = self._select_branch_location(tree,
 
3501
                location, revision, 0)
 
3502
        else:
 
3503
            base_loc = other_loc
 
3504
        # Open the branches
 
3505
        other_branch, other_path = Branch.open_containing(other_loc,
 
3506
            possible_transports)
 
3507
        if base_loc == other_loc:
 
3508
            base_branch = other_branch
 
3509
        else:
 
3510
            base_branch, base_path = Branch.open_containing(base_loc,
 
3511
                possible_transports)
 
3512
        # Find the revision ids
 
3513
        if revision is None or len(revision) < 1 or revision[-1] is None:
 
3514
            other_revision_id = _mod_revision.ensure_null(
 
3515
                other_branch.last_revision())
 
3516
        else:
 
3517
            other_revision_id = revision[-1].as_revision_id(other_branch)
 
3518
        if (revision is not None and len(revision) == 2
 
3519
            and revision[0] is not None):
 
3520
            base_revision_id = revision[0].as_revision_id(base_branch)
 
3521
        else:
 
3522
            base_revision_id = None
 
3523
        # Remember where we merge from
 
3524
        if ((remember or tree.branch.get_submit_branch() is None) and
 
3525
             user_location is not None):
 
3526
            tree.branch.set_submit_branch(other_branch.base)
 
3527
        _merge_tags_if_possible(other_branch, tree.branch)
 
3528
        merger = _mod_merge.Merger.from_revision_ids(pb, tree,
 
3529
            other_revision_id, base_revision_id, other_branch, base_branch)
 
3530
        if other_path != '':
 
3531
            allow_pending = False
 
3532
            merger.interesting_files = [other_path]
 
3533
        else:
 
3534
            allow_pending = True
 
3535
        return merger, allow_pending
 
3536
 
 
3537
    def _select_branch_location(self, tree, user_location, revision=None,
 
3538
                                index=None):
 
3539
        """Select a branch location, according to possible inputs.
 
3540
 
 
3541
        If provided, branches from ``revision`` are preferred.  (Both
 
3542
        ``revision`` and ``index`` must be supplied.)
 
3543
 
 
3544
        Otherwise, the ``location`` parameter is used.  If it is None, then the
 
3545
        ``submit`` or ``parent`` location is used, and a note is printed.
 
3546
 
 
3547
        :param tree: The working tree to select a branch for merging into
 
3548
        :param location: The location entered by the user
 
3549
        :param revision: The revision parameter to the command
 
3550
        :param index: The index to use for the revision parameter.  Negative
 
3551
            indices are permitted.
 
3552
        :return: (selected_location, user_location).  The default location
 
3553
            will be the user-entered location.
 
3554
        """
 
3555
        if (revision is not None and index is not None
 
3556
            and revision[index] is not None):
 
3557
            branch = revision[index].get_branch()
 
3558
            if branch is not None:
 
3559
                return branch, branch
 
3560
        if user_location is None:
 
3561
            location = self._get_remembered(tree, 'Merging from')
 
3562
        else:
 
3563
            location = user_location
 
3564
        return location, user_location
 
3565
 
 
3566
    def _get_remembered(self, tree, verb_string):
 
3567
        """Use tree.branch's parent if none was supplied.
 
3568
 
 
3569
        Report if the remembered location was used.
 
3570
        """
 
3571
        stored_location = tree.branch.get_submit_branch()
 
3572
        stored_location_type = "submit"
 
3573
        if stored_location is None:
 
3574
            stored_location = tree.branch.get_parent()
 
3575
            stored_location_type = "parent"
 
3576
        mutter("%s", stored_location)
 
3577
        if stored_location is None:
 
3578
            raise errors.BzrCommandError("No location specified or remembered")
 
3579
        display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
 
3580
        note(u"%s remembered %s location %s", verb_string,
 
3581
                stored_location_type, display_url)
 
3582
        return stored_location
 
3583
 
 
3584
 
 
3585
class cmd_remerge(Command):
 
3586
    """Redo a merge.
 
3587
 
 
3588
    Use this if you want to try a different merge technique while resolving
 
3589
    conflicts.  Some merge techniques are better than others, and remerge
 
3590
    lets you try different ones on different files.
 
3591
 
 
3592
    The options for remerge have the same meaning and defaults as the ones for
 
3593
    merge.  The difference is that remerge can (only) be run when there is a
 
3594
    pending merge, and it lets you specify particular files.
 
3595
 
 
3596
    :Examples:
 
3597
        Re-do the merge of all conflicted files, and show the base text in
 
3598
        conflict regions, in addition to the usual THIS and OTHER texts::
 
3599
 
 
3600
            bzr remerge --show-base
 
3601
 
 
3602
        Re-do the merge of "foobar", using the weave merge algorithm, with
 
3603
        additional processing to reduce the size of conflict regions::
 
3604
 
 
3605
            bzr remerge --merge-type weave --reprocess foobar
 
3606
    """
 
3607
    takes_args = ['file*']
 
3608
    takes_options = [
 
3609
            'merge-type',
 
3610
            'reprocess',
 
3611
            Option('show-base',
 
3612
                   help="Show base revision text in conflicts."),
 
3613
            ]
 
3614
 
 
3615
    def run(self, file_list=None, merge_type=None, show_base=False,
 
3616
            reprocess=False):
 
3617
        if merge_type is None:
 
3618
            merge_type = _mod_merge.Merge3Merger
 
3619
        tree, file_list = tree_files(file_list)
 
3620
        tree.lock_write()
 
3621
        try:
 
3622
            parents = tree.get_parent_ids()
 
3623
            if len(parents) != 2:
 
3624
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
3625
                                             " merges.  Not cherrypicking or"
 
3626
                                             " multi-merges.")
 
3627
            repository = tree.branch.repository
 
3628
            interesting_ids = None
 
3629
            new_conflicts = []
 
3630
            conflicts = tree.conflicts()
 
3631
            if file_list is not None:
 
3632
                interesting_ids = set()
 
3633
                for filename in file_list:
 
3634
                    file_id = tree.path2id(filename)
 
3635
                    if file_id is None:
 
3636
                        raise errors.NotVersionedError(filename)
 
3637
                    interesting_ids.add(file_id)
 
3638
                    if tree.kind(file_id) != "directory":
 
3639
                        continue
 
3640
 
 
3641
                    for name, ie in tree.inventory.iter_entries(file_id):
 
3642
                        interesting_ids.add(ie.file_id)
 
3643
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
3644
            else:
 
3645
                # Remerge only supports resolving contents conflicts
 
3646
                allowed_conflicts = ('text conflict', 'contents conflict')
 
3647
                restore_files = [c.path for c in conflicts
 
3648
                                 if c.typestring in allowed_conflicts]
 
3649
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
3650
            tree.set_conflicts(ConflictList(new_conflicts))
 
3651
            if file_list is not None:
 
3652
                restore_files = file_list
 
3653
            for filename in restore_files:
 
3654
                try:
 
3655
                    restore(tree.abspath(filename))
 
3656
                except errors.NotConflicted:
 
3657
                    pass
 
3658
            # Disable pending merges, because the file texts we are remerging
 
3659
            # have not had those merges performed.  If we use the wrong parents
 
3660
            # list, we imply that the working tree text has seen and rejected
 
3661
            # all the changes from the other tree, when in fact those changes
 
3662
            # have not yet been seen.
 
3663
            pb = ui.ui_factory.nested_progress_bar()
 
3664
            tree.set_parent_ids(parents[:1])
 
3665
            try:
 
3666
                merger = _mod_merge.Merger.from_revision_ids(pb,
 
3667
                                                             tree, parents[1])
 
3668
                merger.interesting_ids = interesting_ids
 
3669
                merger.merge_type = merge_type
 
3670
                merger.show_base = show_base
 
3671
                merger.reprocess = reprocess
 
3672
                conflicts = merger.do_merge()
 
3673
            finally:
 
3674
                tree.set_parent_ids(parents)
 
3675
                pb.finished()
 
3676
        finally:
 
3677
            tree.unlock()
 
3678
        if conflicts > 0:
 
3679
            return 1
 
3680
        else:
 
3681
            return 0
 
3682
 
 
3683
 
 
3684
class cmd_revert(Command):
 
3685
    """Revert files to a previous revision.
 
3686
 
 
3687
    Giving a list of files will revert only those files.  Otherwise, all files
 
3688
    will be reverted.  If the revision is not specified with '--revision', the
 
3689
    last committed revision is used.
 
3690
 
 
3691
    To remove only some changes, without reverting to a prior version, use
 
3692
    merge instead.  For example, "merge . --revision -2..-3" will remove the
 
3693
    changes introduced by -2, without affecting the changes introduced by -1.
 
3694
    Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
 
3695
 
 
3696
    By default, any files that have been manually changed will be backed up
 
3697
    first.  (Files changed only by merge are not backed up.)  Backup files have
 
3698
    '.~#~' appended to their name, where # is a number.
 
3699
 
 
3700
    When you provide files, you can use their current pathname or the pathname
 
3701
    from the target revision.  So you can use revert to "undelete" a file by
 
3702
    name.  If you name a directory, all the contents of that directory will be
 
3703
    reverted.
 
3704
 
 
3705
    Any files that have been newly added since that revision will be deleted,
 
3706
    with a backup kept if appropriate.  Directories containing unknown files
 
3707
    will not be deleted.
 
3708
 
 
3709
    The working tree contains a list of pending merged revisions, which will
 
3710
    be included as parents in the next commit.  Normally, revert clears that
 
3711
    list as well as reverting the files.  If any files are specified, revert
 
3712
    leaves the pending merge list alone and reverts only the files.  Use "bzr
 
3713
    revert ." in the tree root to revert all files but keep the merge record,
 
3714
    and "bzr revert --forget-merges" to clear the pending merge list without
 
3715
    reverting any files.
 
3716
    """
 
3717
 
 
3718
    _see_also = ['cat', 'export']
 
3719
    takes_options = [
 
3720
        'revision',
 
3721
        Option('no-backup', "Do not save backups of reverted files."),
 
3722
        Option('forget-merges',
 
3723
               'Remove pending merge marker, without changing any files.'),
 
3724
        ]
 
3725
    takes_args = ['file*']
 
3726
 
 
3727
    def run(self, revision=None, no_backup=False, file_list=None,
 
3728
            forget_merges=None):
 
3729
        tree, file_list = tree_files(file_list)
 
3730
        tree.lock_write()
 
3731
        try:
 
3732
            if forget_merges:
 
3733
                tree.set_parent_ids(tree.get_parent_ids()[:1])
 
3734
            else:
 
3735
                self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
3736
        finally:
 
3737
            tree.unlock()
 
3738
 
 
3739
    @staticmethod
 
3740
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
 
3741
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
 
3742
        pb = ui.ui_factory.nested_progress_bar()
 
3743
        try:
 
3744
            tree.revert(file_list, rev_tree, not no_backup, pb,
 
3745
                report_changes=True)
 
3746
        finally:
 
3747
            pb.finished()
 
3748
 
 
3749
 
 
3750
class cmd_assert_fail(Command):
 
3751
    """Test reporting of assertion failures"""
 
3752
    # intended just for use in testing
 
3753
 
 
3754
    hidden = True
 
3755
 
 
3756
    def run(self):
 
3757
        raise AssertionError("always fails")
 
3758
 
 
3759
 
 
3760
class cmd_help(Command):
 
3761
    """Show help on a command or other topic.
 
3762
    """
 
3763
 
 
3764
    _see_also = ['topics']
 
3765
    takes_options = [
 
3766
            Option('long', 'Show help on all commands.'),
 
3767
            ]
 
3768
    takes_args = ['topic?']
 
3769
    aliases = ['?', '--help', '-?', '-h']
 
3770
 
 
3771
    @display_command
 
3772
    def run(self, topic=None, long=False):
 
3773
        import bzrlib.help
 
3774
        if topic is None and long:
 
3775
            topic = "commands"
 
3776
        bzrlib.help.help(topic)
 
3777
 
 
3778
 
 
3779
class cmd_shell_complete(Command):
 
3780
    """Show appropriate completions for context.
 
3781
 
 
3782
    For a list of all available commands, say 'bzr shell-complete'.
 
3783
    """
 
3784
    takes_args = ['context?']
 
3785
    aliases = ['s-c']
 
3786
    hidden = True
 
3787
 
 
3788
    @display_command
 
3789
    def run(self, context=None):
 
3790
        import shellcomplete
 
3791
        shellcomplete.shellcomplete(context)
 
3792
 
 
3793
 
 
3794
class cmd_missing(Command):
 
3795
    """Show unmerged/unpulled revisions between two branches.
 
3796
 
 
3797
    OTHER_BRANCH may be local or remote.
 
3798
 
 
3799
    To filter on a range of revirions, you can use the command -r begin..end
 
3800
    -r revision requests a specific revision, -r ..end or -r begin.. are
 
3801
    also valid.
 
3802
 
 
3803
    :Examples:
 
3804
 
 
3805
        Determine the missing revisions between this and the branch at the
 
3806
        remembered pull location::
 
3807
 
 
3808
            bzr missing
 
3809
 
 
3810
        Determine the missing revisions between this and another branch::
 
3811
 
 
3812
            bzr missing http://server/branch
 
3813
 
 
3814
        Determine the missing revisions up to a specific revision on the other
 
3815
        branch::
 
3816
 
 
3817
            bzr missing -r ..-10
 
3818
 
 
3819
        Determine the missing revisions up to a specific revision on this
 
3820
        branch::
 
3821
 
 
3822
            bzr missing --my-revision ..-10
 
3823
    """
 
3824
 
 
3825
    _see_also = ['merge', 'pull']
 
3826
    takes_args = ['other_branch?']
 
3827
    takes_options = [
 
3828
        Option('reverse', 'Reverse the order of revisions.'),
 
3829
        Option('mine-only',
 
3830
               'Display changes in the local branch only.'),
 
3831
        Option('this' , 'Same as --mine-only.'),
 
3832
        Option('theirs-only',
 
3833
               'Display changes in the remote branch only.'),
 
3834
        Option('other', 'Same as --theirs-only.'),
 
3835
        'log-format',
 
3836
        'show-ids',
 
3837
        'verbose',
 
3838
        custom_help('revision',
 
3839
             help='Filter on other branch revisions (inclusive). '
 
3840
                'See "help revisionspec" for details.'),
 
3841
        Option('my-revision',
 
3842
            type=_parse_revision_str,
 
3843
            help='Filter on local branch revisions (inclusive). '
 
3844
                'See "help revisionspec" for details.'),
 
3845
        Option('include-merges', 'Show merged revisions.'),
 
3846
        ]
 
3847
    encoding_type = 'replace'
 
3848
 
 
3849
    @display_command
 
3850
    def run(self, other_branch=None, reverse=False, mine_only=False,
 
3851
            theirs_only=False,
 
3852
            log_format=None, long=False, short=False, line=False,
 
3853
            show_ids=False, verbose=False, this=False, other=False,
 
3854
            include_merges=False, revision=None, my_revision=None):
 
3855
        from bzrlib.missing import find_unmerged, iter_log_revisions
 
3856
        def message(s):
 
3857
            if not is_quiet():
 
3858
                self.outf.write(s)
 
3859
 
 
3860
        if this:
 
3861
            mine_only = this
 
3862
        if other:
 
3863
            theirs_only = other
 
3864
        # TODO: We should probably check that we don't have mine-only and
 
3865
        #       theirs-only set, but it gets complicated because we also have
 
3866
        #       this and other which could be used.
 
3867
        restrict = 'all'
 
3868
        if mine_only:
 
3869
            restrict = 'local'
 
3870
        elif theirs_only:
 
3871
            restrict = 'remote'
 
3872
 
 
3873
        local_branch = Branch.open_containing(u".")[0]
 
3874
        parent = local_branch.get_parent()
 
3875
        if other_branch is None:
 
3876
            other_branch = parent
 
3877
            if other_branch is None:
 
3878
                raise errors.BzrCommandError("No peer location known"
 
3879
                                             " or specified.")
 
3880
            display_url = urlutils.unescape_for_display(parent,
 
3881
                                                        self.outf.encoding)
 
3882
            message("Using saved parent location: "
 
3883
                    + display_url + "\n")
 
3884
 
 
3885
        remote_branch = Branch.open(other_branch)
 
3886
        if remote_branch.base == local_branch.base:
 
3887
            remote_branch = local_branch
 
3888
 
 
3889
        local_revid_range = _revision_range_to_revid_range(
 
3890
            _get_revision_range(my_revision, local_branch,
 
3891
                self.name()))
 
3892
 
 
3893
        remote_revid_range = _revision_range_to_revid_range(
 
3894
            _get_revision_range(revision,
 
3895
                remote_branch, self.name()))
 
3896
 
 
3897
        local_branch.lock_read()
 
3898
        try:
 
3899
            remote_branch.lock_read()
 
3900
            try:
 
3901
                local_extra, remote_extra = find_unmerged(
 
3902
                    local_branch, remote_branch, restrict,
 
3903
                    backward=not reverse,
 
3904
                    include_merges=include_merges,
 
3905
                    local_revid_range=local_revid_range,
 
3906
                    remote_revid_range=remote_revid_range)
 
3907
 
 
3908
                if log_format is None:
 
3909
                    registry = log.log_formatter_registry
 
3910
                    log_format = registry.get_default(local_branch)
 
3911
                lf = log_format(to_file=self.outf,
 
3912
                                show_ids=show_ids,
 
3913
                                show_timezone='original')
 
3914
 
 
3915
                status_code = 0
 
3916
                if local_extra and not theirs_only:
 
3917
                    message("You have %d extra revision(s):\n" %
 
3918
                        len(local_extra))
 
3919
                    for revision in iter_log_revisions(local_extra,
 
3920
                                        local_branch.repository,
 
3921
                                        verbose):
 
3922
                        lf.log_revision(revision)
 
3923
                    printed_local = True
 
3924
                    status_code = 1
 
3925
                else:
 
3926
                    printed_local = False
 
3927
 
 
3928
                if remote_extra and not mine_only:
 
3929
                    if printed_local is True:
 
3930
                        message("\n\n\n")
 
3931
                    message("You are missing %d revision(s):\n" %
 
3932
                        len(remote_extra))
 
3933
                    for revision in iter_log_revisions(remote_extra,
 
3934
                                        remote_branch.repository,
 
3935
                                        verbose):
 
3936
                        lf.log_revision(revision)
 
3937
                    status_code = 1
 
3938
 
 
3939
                if mine_only and not local_extra:
 
3940
                    # We checked local, and found nothing extra
 
3941
                    message('This branch is up to date.\n')
 
3942
                elif theirs_only and not remote_extra:
 
3943
                    # We checked remote, and found nothing extra
 
3944
                    message('Other branch is up to date.\n')
 
3945
                elif not (mine_only or theirs_only or local_extra or
 
3946
                          remote_extra):
 
3947
                    # We checked both branches, and neither one had extra
 
3948
                    # revisions
 
3949
                    message("Branches are up to date.\n")
 
3950
            finally:
 
3951
                remote_branch.unlock()
 
3952
        finally:
 
3953
            local_branch.unlock()
 
3954
        if not status_code and parent is None and other_branch is not None:
 
3955
            local_branch.lock_write()
 
3956
            try:
 
3957
                # handle race conditions - a parent might be set while we run.
 
3958
                if local_branch.get_parent() is None:
 
3959
                    local_branch.set_parent(remote_branch.base)
 
3960
            finally:
 
3961
                local_branch.unlock()
 
3962
        return status_code
 
3963
 
 
3964
 
 
3965
class cmd_pack(Command):
 
3966
    """Compress the data within a repository."""
 
3967
 
 
3968
    _see_also = ['repositories']
 
3969
    takes_args = ['branch_or_repo?']
 
3970
 
 
3971
    def run(self, branch_or_repo='.'):
 
3972
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
 
3973
        try:
 
3974
            branch = dir.open_branch()
 
3975
            repository = branch.repository
 
3976
        except errors.NotBranchError:
 
3977
            repository = dir.open_repository()
 
3978
        repository.pack()
 
3979
 
 
3980
 
 
3981
class cmd_plugins(Command):
 
3982
    """List the installed plugins.
 
3983
 
 
3984
    This command displays the list of installed plugins including
 
3985
    version of plugin and a short description of each.
 
3986
 
 
3987
    --verbose shows the path where each plugin is located.
 
3988
 
 
3989
    A plugin is an external component for Bazaar that extends the
 
3990
    revision control system, by adding or replacing code in Bazaar.
 
3991
    Plugins can do a variety of things, including overriding commands,
 
3992
    adding new commands, providing additional network transports and
 
3993
    customizing log output.
 
3994
 
 
3995
    See the Bazaar web site, http://bazaar-vcs.org, for further
 
3996
    information on plugins including where to find them and how to
 
3997
    install them. Instructions are also provided there on how to
 
3998
    write new plugins using the Python programming language.
 
3999
    """
 
4000
    takes_options = ['verbose']
 
4001
 
 
4002
    @display_command
 
4003
    def run(self, verbose=False):
 
4004
        import bzrlib.plugin
 
4005
        from inspect import getdoc
 
4006
        result = []
 
4007
        for name, plugin in bzrlib.plugin.plugins().items():
 
4008
            version = plugin.__version__
 
4009
            if version == 'unknown':
 
4010
                version = ''
 
4011
            name_ver = '%s %s' % (name, version)
 
4012
            d = getdoc(plugin.module)
 
4013
            if d:
 
4014
                doc = d.split('\n')[0]
 
4015
            else:
 
4016
                doc = '(no description)'
 
4017
            result.append((name_ver, doc, plugin.path()))
 
4018
        for name_ver, doc, path in sorted(result):
 
4019
            print name_ver
 
4020
            print '   ', doc
 
4021
            if verbose:
 
4022
                print '   ', path
 
4023
            print
 
4024
 
 
4025
 
 
4026
class cmd_testament(Command):
 
4027
    """Show testament (signing-form) of a revision."""
 
4028
    takes_options = [
 
4029
            'revision',
 
4030
            Option('long', help='Produce long-format testament.'),
 
4031
            Option('strict',
 
4032
                   help='Produce a strict-format testament.')]
 
4033
    takes_args = ['branch?']
 
4034
    @display_command
 
4035
    def run(self, branch=u'.', revision=None, long=False, strict=False):
 
4036
        from bzrlib.testament import Testament, StrictTestament
 
4037
        if strict is True:
 
4038
            testament_class = StrictTestament
 
4039
        else:
 
4040
            testament_class = Testament
 
4041
        if branch == '.':
 
4042
            b = Branch.open_containing(branch)[0]
 
4043
        else:
 
4044
            b = Branch.open(branch)
 
4045
        b.lock_read()
 
4046
        try:
 
4047
            if revision is None:
 
4048
                rev_id = b.last_revision()
 
4049
            else:
 
4050
                rev_id = revision[0].as_revision_id(b)
 
4051
            t = testament_class.from_revision(b.repository, rev_id)
 
4052
            if long:
 
4053
                sys.stdout.writelines(t.as_text_lines())
 
4054
            else:
 
4055
                sys.stdout.write(t.as_short_text())
 
4056
        finally:
 
4057
            b.unlock()
 
4058
 
 
4059
 
 
4060
class cmd_annotate(Command):
 
4061
    """Show the origin of each line in a file.
 
4062
 
 
4063
    This prints out the given file with an annotation on the left side
 
4064
    indicating which revision, author and date introduced the change.
 
4065
 
 
4066
    If the origin is the same for a run of consecutive lines, it is
 
4067
    shown only at the top, unless the --all option is given.
 
4068
    """
 
4069
    # TODO: annotate directories; showing when each file was last changed
 
4070
    # TODO: if the working copy is modified, show annotations on that
 
4071
    #       with new uncommitted lines marked
 
4072
    aliases = ['ann', 'blame', 'praise']
 
4073
    takes_args = ['filename']
 
4074
    takes_options = [Option('all', help='Show annotations on all lines.'),
 
4075
                     Option('long', help='Show commit date in annotations.'),
 
4076
                     'revision',
 
4077
                     'show-ids',
 
4078
                     ]
 
4079
    encoding_type = 'exact'
 
4080
 
 
4081
    @display_command
 
4082
    def run(self, filename, all=False, long=False, revision=None,
 
4083
            show_ids=False):
 
4084
        from bzrlib.annotate import annotate_file, annotate_file_tree
 
4085
        wt, branch, relpath = \
 
4086
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
4087
        if wt is not None:
 
4088
            wt.lock_read()
 
4089
        else:
 
4090
            branch.lock_read()
 
4091
        try:
 
4092
            tree = _get_one_revision_tree('annotate', revision, branch=branch)
 
4093
            if wt is not None:
 
4094
                file_id = wt.path2id(relpath)
 
4095
            else:
 
4096
                file_id = tree.path2id(relpath)
 
4097
            if file_id is None:
 
4098
                raise errors.NotVersionedError(filename)
 
4099
            file_version = tree.inventory[file_id].revision
 
4100
            if wt is not None and revision is None:
 
4101
                # If there is a tree and we're not annotating historical
 
4102
                # versions, annotate the working tree's content.
 
4103
                annotate_file_tree(wt, file_id, self.outf, long, all,
 
4104
                    show_ids=show_ids)
 
4105
            else:
 
4106
                annotate_file(branch, file_version, file_id, long, all, self.outf,
 
4107
                              show_ids=show_ids)
 
4108
        finally:
 
4109
            if wt is not None:
 
4110
                wt.unlock()
 
4111
            else:
 
4112
                branch.unlock()
 
4113
 
 
4114
 
 
4115
class cmd_re_sign(Command):
 
4116
    """Create a digital signature for an existing revision."""
 
4117
    # TODO be able to replace existing ones.
 
4118
 
 
4119
    hidden = True # is this right ?
 
4120
    takes_args = ['revision_id*']
 
4121
    takes_options = ['revision']
 
4122
 
 
4123
    def run(self, revision_id_list=None, revision=None):
 
4124
        if revision_id_list is not None and revision is not None:
 
4125
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
 
4126
        if revision_id_list is None and revision is None:
 
4127
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
 
4128
        b = WorkingTree.open_containing(u'.')[0].branch
 
4129
        b.lock_write()
 
4130
        try:
 
4131
            return self._run(b, revision_id_list, revision)
 
4132
        finally:
 
4133
            b.unlock()
 
4134
 
 
4135
    def _run(self, b, revision_id_list, revision):
 
4136
        import bzrlib.gpg as gpg
 
4137
        gpg_strategy = gpg.GPGStrategy(b.get_config())
 
4138
        if revision_id_list is not None:
 
4139
            b.repository.start_write_group()
 
4140
            try:
 
4141
                for revision_id in revision_id_list:
 
4142
                    b.repository.sign_revision(revision_id, gpg_strategy)
 
4143
            except:
 
4144
                b.repository.abort_write_group()
 
4145
                raise
 
4146
            else:
 
4147
                b.repository.commit_write_group()
 
4148
        elif revision is not None:
 
4149
            if len(revision) == 1:
 
4150
                revno, rev_id = revision[0].in_history(b)
 
4151
                b.repository.start_write_group()
 
4152
                try:
 
4153
                    b.repository.sign_revision(rev_id, gpg_strategy)
 
4154
                except:
 
4155
                    b.repository.abort_write_group()
 
4156
                    raise
 
4157
                else:
 
4158
                    b.repository.commit_write_group()
 
4159
            elif len(revision) == 2:
 
4160
                # are they both on rh- if so we can walk between them
 
4161
                # might be nice to have a range helper for arbitrary
 
4162
                # revision paths. hmm.
 
4163
                from_revno, from_revid = revision[0].in_history(b)
 
4164
                to_revno, to_revid = revision[1].in_history(b)
 
4165
                if to_revid is None:
 
4166
                    to_revno = b.revno()
 
4167
                if from_revno is None or to_revno is None:
 
4168
                    raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
 
4169
                b.repository.start_write_group()
 
4170
                try:
 
4171
                    for revno in range(from_revno, to_revno + 1):
 
4172
                        b.repository.sign_revision(b.get_rev_id(revno),
 
4173
                                                   gpg_strategy)
 
4174
                except:
 
4175
                    b.repository.abort_write_group()
 
4176
                    raise
 
4177
                else:
 
4178
                    b.repository.commit_write_group()
 
4179
            else:
 
4180
                raise errors.BzrCommandError('Please supply either one revision, or a range.')
 
4181
 
 
4182
 
 
4183
class cmd_bind(Command):
 
4184
    """Convert the current branch into a checkout of the supplied branch.
 
4185
 
 
4186
    Once converted into a checkout, commits must succeed on the master branch
 
4187
    before they will be applied to the local branch.
 
4188
 
 
4189
    Bound branches use the nickname of its master branch unless it is set
 
4190
    locally, in which case binding will update the the local nickname to be
 
4191
    that of the master.
 
4192
    """
 
4193
 
 
4194
    _see_also = ['checkouts', 'unbind']
 
4195
    takes_args = ['location?']
 
4196
    takes_options = []
 
4197
 
 
4198
    def run(self, location=None):
 
4199
        b, relpath = Branch.open_containing(u'.')
 
4200
        if location is None:
 
4201
            try:
 
4202
                location = b.get_old_bound_location()
 
4203
            except errors.UpgradeRequired:
 
4204
                raise errors.BzrCommandError('No location supplied.  '
 
4205
                    'This format does not remember old locations.')
 
4206
            else:
 
4207
                if location is None:
 
4208
                    raise errors.BzrCommandError('No location supplied and no '
 
4209
                        'previous location known')
 
4210
        b_other = Branch.open(location)
 
4211
        try:
 
4212
            b.bind(b_other)
 
4213
        except errors.DivergedBranches:
 
4214
            raise errors.BzrCommandError('These branches have diverged.'
 
4215
                                         ' Try merging, and then bind again.')
 
4216
        if b.get_config().has_explicit_nickname():
 
4217
            b.nick = b_other.nick
 
4218
 
 
4219
 
 
4220
class cmd_unbind(Command):
 
4221
    """Convert the current checkout into a regular branch.
 
4222
 
 
4223
    After unbinding, the local branch is considered independent and subsequent
 
4224
    commits will be local only.
 
4225
    """
 
4226
 
 
4227
    _see_also = ['checkouts', 'bind']
 
4228
    takes_args = []
 
4229
    takes_options = []
 
4230
 
 
4231
    def run(self):
 
4232
        b, relpath = Branch.open_containing(u'.')
 
4233
        if not b.unbind():
 
4234
            raise errors.BzrCommandError('Local branch is not bound')
 
4235
 
 
4236
 
 
4237
class cmd_uncommit(Command):
 
4238
    """Remove the last committed revision.
 
4239
 
 
4240
    --verbose will print out what is being removed.
 
4241
    --dry-run will go through all the motions, but not actually
 
4242
    remove anything.
 
4243
 
 
4244
    If --revision is specified, uncommit revisions to leave the branch at the
 
4245
    specified revision.  For example, "bzr uncommit -r 15" will leave the
 
4246
    branch at revision 15.
 
4247
 
 
4248
    Uncommit leaves the working tree ready for a new commit.  The only change
 
4249
    it may make is to restore any pending merges that were present before
 
4250
    the commit.
 
4251
    """
 
4252
 
 
4253
    # TODO: jam 20060108 Add an option to allow uncommit to remove
 
4254
    # unreferenced information in 'branch-as-repository' branches.
 
4255
    # TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
 
4256
    # information in shared branches as well.
 
4257
    _see_also = ['commit']
 
4258
    takes_options = ['verbose', 'revision',
 
4259
                    Option('dry-run', help='Don\'t actually make changes.'),
 
4260
                    Option('force', help='Say yes to all questions.'),
 
4261
                    Option('local',
 
4262
                           help="Only remove the commits from the local branch"
 
4263
                                " when in a checkout."
 
4264
                           ),
 
4265
                    ]
 
4266
    takes_args = ['location?']
 
4267
    aliases = []
 
4268
    encoding_type = 'replace'
 
4269
 
 
4270
    def run(self, location=None,
 
4271
            dry_run=False, verbose=False,
 
4272
            revision=None, force=False, local=False):
 
4273
        if location is None:
 
4274
            location = u'.'
 
4275
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
4276
        try:
 
4277
            tree = control.open_workingtree()
 
4278
            b = tree.branch
 
4279
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
4280
            tree = None
 
4281
            b = control.open_branch()
 
4282
 
 
4283
        if tree is not None:
 
4284
            tree.lock_write()
 
4285
        else:
 
4286
            b.lock_write()
 
4287
        try:
 
4288
            return self._run(b, tree, dry_run, verbose, revision, force,
 
4289
                             local=local)
 
4290
        finally:
 
4291
            if tree is not None:
 
4292
                tree.unlock()
 
4293
            else:
 
4294
                b.unlock()
 
4295
 
 
4296
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
 
4297
        from bzrlib.log import log_formatter, show_log
 
4298
        from bzrlib.uncommit import uncommit
 
4299
 
 
4300
        last_revno, last_rev_id = b.last_revision_info()
 
4301
 
 
4302
        rev_id = None
 
4303
        if revision is None:
 
4304
            revno = last_revno
 
4305
            rev_id = last_rev_id
 
4306
        else:
 
4307
            # 'bzr uncommit -r 10' actually means uncommit
 
4308
            # so that the final tree is at revno 10.
 
4309
            # but bzrlib.uncommit.uncommit() actually uncommits
 
4310
            # the revisions that are supplied.
 
4311
            # So we need to offset it by one
 
4312
            revno = revision[0].in_history(b).revno + 1
 
4313
            if revno <= last_revno:
 
4314
                rev_id = b.get_rev_id(revno)
 
4315
 
 
4316
        if rev_id is None or _mod_revision.is_null(rev_id):
 
4317
            self.outf.write('No revisions to uncommit.\n')
 
4318
            return 1
 
4319
 
 
4320
        lf = log_formatter('short',
 
4321
                           to_file=self.outf,
 
4322
                           show_timezone='original')
 
4323
 
 
4324
        show_log(b,
 
4325
                 lf,
 
4326
                 verbose=False,
 
4327
                 direction='forward',
 
4328
                 start_revision=revno,
 
4329
                 end_revision=last_revno)
 
4330
 
 
4331
        if dry_run:
 
4332
            print 'Dry-run, pretending to remove the above revisions.'
 
4333
            if not force:
 
4334
                val = raw_input('Press <enter> to continue')
 
4335
        else:
 
4336
            print 'The above revision(s) will be removed.'
 
4337
            if not force:
 
4338
                val = raw_input('Are you sure [y/N]? ')
 
4339
                if val.lower() not in ('y', 'yes'):
 
4340
                    print 'Canceled'
 
4341
                    return 0
 
4342
 
 
4343
        mutter('Uncommitting from {%s} to {%s}',
 
4344
               last_rev_id, rev_id)
 
4345
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
 
4346
                 revno=revno, local=local)
 
4347
        note('You can restore the old tip by running:\n'
 
4348
             '  bzr pull . -r revid:%s', last_rev_id)
 
4349
 
 
4350
 
 
4351
class cmd_break_lock(Command):
 
4352
    """Break a dead lock on a repository, branch or working directory.
 
4353
 
 
4354
    CAUTION: Locks should only be broken when you are sure that the process
 
4355
    holding the lock has been stopped.
 
4356
 
 
4357
    You can get information on what locks are open via the 'bzr info' command.
 
4358
 
 
4359
    :Examples:
 
4360
        bzr break-lock
 
4361
    """
 
4362
    takes_args = ['location?']
 
4363
 
 
4364
    def run(self, location=None, show=False):
 
4365
        if location is None:
 
4366
            location = u'.'
 
4367
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
4368
        try:
 
4369
            control.break_lock()
 
4370
        except NotImplementedError:
 
4371
            pass
 
4372
 
 
4373
 
 
4374
class cmd_wait_until_signalled(Command):
 
4375
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4376
 
 
4377
    This just prints a line to signal when it is ready, then blocks on stdin.
 
4378
    """
 
4379
 
 
4380
    hidden = True
 
4381
 
 
4382
    def run(self):
 
4383
        sys.stdout.write("running\n")
 
4384
        sys.stdout.flush()
 
4385
        sys.stdin.readline()
 
4386
 
 
4387
 
 
4388
class cmd_serve(Command):
 
4389
    """Run the bzr server."""
 
4390
 
 
4391
    aliases = ['server']
 
4392
 
 
4393
    takes_options = [
 
4394
        Option('inet',
 
4395
               help='Serve on stdin/out for use from inetd or sshd.'),
 
4396
        Option('port',
 
4397
               help='Listen for connections on nominated port of the form '
 
4398
                    '[hostname:]portnumber.  Passing 0 as the port number will '
 
4399
                    'result in a dynamically allocated port.  The default port is '
 
4400
                    '4155.',
 
4401
               type=str),
 
4402
        Option('directory',
 
4403
               help='Serve contents of this directory.',
 
4404
               type=unicode),
 
4405
        Option('allow-writes',
 
4406
               help='By default the server is a readonly server.  Supplying '
 
4407
                    '--allow-writes enables write access to the contents of '
 
4408
                    'the served directory and below.'
 
4409
                ),
 
4410
        ]
 
4411
 
 
4412
    def run_smart_server(self, smart_server):
 
4413
        """Run 'smart_server' forever, with no UI output at all."""
 
4414
        # For the duration of this server, no UI output is permitted. note
 
4415
        # that this may cause problems with blackbox tests. This should be
 
4416
        # changed with care though, as we dont want to use bandwidth sending
 
4417
        # progress over stderr to smart server clients!
 
4418
        from bzrlib import lockdir
 
4419
        old_factory = ui.ui_factory
 
4420
        old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
 
4421
        try:
 
4422
            ui.ui_factory = ui.SilentUIFactory()
 
4423
            lockdir._DEFAULT_TIMEOUT_SECONDS = 0
 
4424
            smart_server.serve()
 
4425
        finally:
 
4426
            ui.ui_factory = old_factory
 
4427
            lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
 
4428
 
 
4429
    def get_host_and_port(self, port):
 
4430
        """Return the host and port to run the smart server on.
 
4431
 
 
4432
        If 'port' is None, the default host (`medium.BZR_DEFAULT_INTERFACE`)
 
4433
        and port (`medium.BZR_DEFAULT_PORT`) will be used.
 
4434
 
 
4435
        If 'port' has a colon in it, the string before the colon will be
 
4436
        interpreted as the host.
 
4437
 
 
4438
        :param port: A string of the port to run the server on.
 
4439
        :return: A tuple of (host, port), where 'host' is a host name or IP,
 
4440
            and port is an integer TCP/IP port.
 
4441
        """
 
4442
        from bzrlib.smart import medium
 
4443
        host = medium.BZR_DEFAULT_INTERFACE
 
4444
        if port is None:
 
4445
            port = medium.BZR_DEFAULT_PORT
 
4446
        else:
 
4447
            if ':' in port:
 
4448
                host, port = port.split(':')
 
4449
            port = int(port)
 
4450
        return host, port
 
4451
 
 
4452
    def get_smart_server(self, transport, inet, port):
 
4453
        """Construct a smart server.
 
4454
 
 
4455
        :param transport: The base transport from which branches will be
 
4456
            served.
 
4457
        :param inet: If True, serve over stdin and stdout. Used for running
 
4458
            from inet.
 
4459
        :param port: The port to listen on. By default, it's `
 
4460
            medium.BZR_DEFAULT_PORT`. See `get_host_and_port` for more
 
4461
            information.
 
4462
        :return: A smart server.
 
4463
        """
 
4464
        from bzrlib.smart import medium, server
 
4465
        if inet:
 
4466
            smart_server = medium.SmartServerPipeStreamMedium(
 
4467
                sys.stdin, sys.stdout, transport)
 
4468
        else:
 
4469
            host, port = self.get_host_and_port(port)
 
4470
            smart_server = server.SmartTCPServer(
 
4471
                transport, host=host, port=port)
 
4472
            note('listening on port: %s' % smart_server.port)
 
4473
        return smart_server
 
4474
 
 
4475
    def run(self, port=None, inet=False, directory=None, allow_writes=False):
 
4476
        from bzrlib.transport import get_transport
 
4477
        from bzrlib.transport.chroot import ChrootServer
 
4478
        if directory is None:
 
4479
            directory = os.getcwd()
 
4480
        url = urlutils.local_path_to_url(directory)
 
4481
        if not allow_writes:
 
4482
            url = 'readonly+' + url
 
4483
        chroot_server = ChrootServer(get_transport(url))
 
4484
        chroot_server.setUp()
 
4485
        t = get_transport(chroot_server.get_url())
 
4486
        smart_server = self.get_smart_server(t, inet, port)
 
4487
        self.run_smart_server(smart_server)
 
4488
 
 
4489
 
 
4490
class cmd_join(Command):
 
4491
    """Combine a subtree into its containing tree.
 
4492
 
 
4493
    This command is for experimental use only.  It requires the target tree
 
4494
    to be in dirstate-with-subtree format, which cannot be converted into
 
4495
    earlier formats.
 
4496
 
 
4497
    The TREE argument should be an independent tree, inside another tree, but
 
4498
    not part of it.  (Such trees can be produced by "bzr split", but also by
 
4499
    running "bzr branch" with the target inside a tree.)
 
4500
 
 
4501
    The result is a combined tree, with the subtree no longer an independant
 
4502
    part.  This is marked as a merge of the subtree into the containing tree,
 
4503
    and all history is preserved.
 
4504
 
 
4505
    If --reference is specified, the subtree retains its independence.  It can
 
4506
    be branched by itself, and can be part of multiple projects at the same
 
4507
    time.  But operations performed in the containing tree, such as commit
 
4508
    and merge, will recurse into the subtree.
 
4509
    """
 
4510
 
 
4511
    _see_also = ['split']
 
4512
    takes_args = ['tree']
 
4513
    takes_options = [
 
4514
            Option('reference', help='Join by reference.'),
 
4515
            ]
 
4516
    hidden = True
 
4517
 
 
4518
    def run(self, tree, reference=False):
 
4519
        sub_tree = WorkingTree.open(tree)
 
4520
        parent_dir = osutils.dirname(sub_tree.basedir)
 
4521
        containing_tree = WorkingTree.open_containing(parent_dir)[0]
 
4522
        repo = containing_tree.branch.repository
 
4523
        if not repo.supports_rich_root():
 
4524
            raise errors.BzrCommandError(
 
4525
                "Can't join trees because %s doesn't support rich root data.\n"
 
4526
                "You can use bzr upgrade on the repository."
 
4527
                % (repo,))
 
4528
        if reference:
 
4529
            try:
 
4530
                containing_tree.add_reference(sub_tree)
 
4531
            except errors.BadReferenceTarget, e:
 
4532
                # XXX: Would be better to just raise a nicely printable
 
4533
                # exception from the real origin.  Also below.  mbp 20070306
 
4534
                raise errors.BzrCommandError("Cannot join %s.  %s" %
 
4535
                                             (tree, e.reason))
 
4536
        else:
 
4537
            try:
 
4538
                containing_tree.subsume(sub_tree)
 
4539
            except errors.BadSubsumeSource, e:
 
4540
                raise errors.BzrCommandError("Cannot join %s.  %s" %
 
4541
                                             (tree, e.reason))
 
4542
 
 
4543
 
 
4544
class cmd_split(Command):
 
4545
    """Split a subdirectory of a tree into a separate tree.
 
4546
 
 
4547
    This command will produce a target tree in a format that supports
 
4548
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
 
4549
    converted into earlier formats like 'dirstate-tags'.
 
4550
 
 
4551
    The TREE argument should be a subdirectory of a working tree.  That
 
4552
    subdirectory will be converted into an independent tree, with its own
 
4553
    branch.  Commits in the top-level tree will not apply to the new subtree.
 
4554
    """
 
4555
 
 
4556
    # join is not un-hidden yet
 
4557
    #_see_also = ['join']
 
4558
    takes_args = ['tree']
 
4559
 
 
4560
    def run(self, tree):
 
4561
        containing_tree, subdir = WorkingTree.open_containing(tree)
 
4562
        sub_id = containing_tree.path2id(subdir)
 
4563
        if sub_id is None:
 
4564
            raise errors.NotVersionedError(subdir)
 
4565
        try:
 
4566
            containing_tree.extract(sub_id)
 
4567
        except errors.RootNotRich:
 
4568
            raise errors.UpgradeRequired(containing_tree.branch.base)
 
4569
 
 
4570
 
 
4571
class cmd_merge_directive(Command):
 
4572
    """Generate a merge directive for auto-merge tools.
 
4573
 
 
4574
    A directive requests a merge to be performed, and also provides all the
 
4575
    information necessary to do so.  This means it must either include a
 
4576
    revision bundle, or the location of a branch containing the desired
 
4577
    revision.
 
4578
 
 
4579
    A submit branch (the location to merge into) must be supplied the first
 
4580
    time the command is issued.  After it has been supplied once, it will
 
4581
    be remembered as the default.
 
4582
 
 
4583
    A public branch is optional if a revision bundle is supplied, but required
 
4584
    if --diff or --plain is specified.  It will be remembered as the default
 
4585
    after the first use.
 
4586
    """
 
4587
 
 
4588
    takes_args = ['submit_branch?', 'public_branch?']
 
4589
 
 
4590
    hidden = True
 
4591
 
 
4592
    _see_also = ['send']
 
4593
 
 
4594
    takes_options = [
 
4595
        RegistryOption.from_kwargs('patch-type',
 
4596
            'The type of patch to include in the directive.',
 
4597
            title='Patch type',
 
4598
            value_switches=True,
 
4599
            enum_switch=False,
 
4600
            bundle='Bazaar revision bundle (default).',
 
4601
            diff='Normal unified diff.',
 
4602
            plain='No patch, just directive.'),
 
4603
        Option('sign', help='GPG-sign the directive.'), 'revision',
 
4604
        Option('mail-to', type=str,
 
4605
            help='Instead of printing the directive, email to this address.'),
 
4606
        Option('message', type=str, short_name='m',
 
4607
            help='Message to use when committing this merge.')
 
4608
        ]
 
4609
 
 
4610
    encoding_type = 'exact'
 
4611
 
 
4612
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
 
4613
            sign=False, revision=None, mail_to=None, message=None):
 
4614
        from bzrlib.revision import ensure_null, NULL_REVISION
 
4615
        include_patch, include_bundle = {
 
4616
            'plain': (False, False),
 
4617
            'diff': (True, False),
 
4618
            'bundle': (True, True),
 
4619
            }[patch_type]
 
4620
        branch = Branch.open('.')
 
4621
        stored_submit_branch = branch.get_submit_branch()
 
4622
        if submit_branch is None:
 
4623
            submit_branch = stored_submit_branch
 
4624
        else:
 
4625
            if stored_submit_branch is None:
 
4626
                branch.set_submit_branch(submit_branch)
 
4627
        if submit_branch is None:
 
4628
            submit_branch = branch.get_parent()
 
4629
        if submit_branch is None:
 
4630
            raise errors.BzrCommandError('No submit branch specified or known')
 
4631
 
 
4632
        stored_public_branch = branch.get_public_branch()
 
4633
        if public_branch is None:
 
4634
            public_branch = stored_public_branch
 
4635
        elif stored_public_branch is None:
 
4636
            branch.set_public_branch(public_branch)
 
4637
        if not include_bundle and public_branch is None:
 
4638
            raise errors.BzrCommandError('No public branch specified or'
 
4639
                                         ' known')
 
4640
        base_revision_id = None
 
4641
        if revision is not None:
 
4642
            if len(revision) > 2:
 
4643
                raise errors.BzrCommandError('bzr merge-directive takes '
 
4644
                    'at most two one revision identifiers')
 
4645
            revision_id = revision[-1].as_revision_id(branch)
 
4646
            if len(revision) == 2:
 
4647
                base_revision_id = revision[0].as_revision_id(branch)
 
4648
        else:
 
4649
            revision_id = branch.last_revision()
 
4650
        revision_id = ensure_null(revision_id)
 
4651
        if revision_id == NULL_REVISION:
 
4652
            raise errors.BzrCommandError('No revisions to bundle.')
 
4653
        directive = merge_directive.MergeDirective2.from_objects(
 
4654
            branch.repository, revision_id, time.time(),
 
4655
            osutils.local_time_offset(), submit_branch,
 
4656
            public_branch=public_branch, include_patch=include_patch,
 
4657
            include_bundle=include_bundle, message=message,
 
4658
            base_revision_id=base_revision_id)
 
4659
        if mail_to is None:
 
4660
            if sign:
 
4661
                self.outf.write(directive.to_signed(branch))
 
4662
            else:
 
4663
                self.outf.writelines(directive.to_lines())
 
4664
        else:
 
4665
            message = directive.to_email(mail_to, branch, sign)
 
4666
            s = SMTPConnection(branch.get_config())
 
4667
            s.send_email(message)
 
4668
 
 
4669
 
 
4670
class cmd_send(Command):
 
4671
    """Mail or create a merge-directive for submitting changes.
 
4672
 
 
4673
    A merge directive provides many things needed for requesting merges:
 
4674
 
 
4675
    * A machine-readable description of the merge to perform
 
4676
 
 
4677
    * An optional patch that is a preview of the changes requested
 
4678
 
 
4679
    * An optional bundle of revision data, so that the changes can be applied
 
4680
      directly from the merge directive, without retrieving data from a
 
4681
      branch.
 
4682
 
 
4683
    If --no-bundle is specified, then public_branch is needed (and must be
 
4684
    up-to-date), so that the receiver can perform the merge using the
 
4685
    public_branch.  The public_branch is always included if known, so that
 
4686
    people can check it later.
 
4687
 
 
4688
    The submit branch defaults to the parent, but can be overridden.  Both
 
4689
    submit branch and public branch will be remembered if supplied.
 
4690
 
 
4691
    If a public_branch is known for the submit_branch, that public submit
 
4692
    branch is used in the merge instructions.  This means that a local mirror
 
4693
    can be used as your actual submit branch, once you have set public_branch
 
4694
    for that mirror.
 
4695
 
 
4696
    Mail is sent using your preferred mail program.  This should be transparent
 
4697
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
 
4698
    If the preferred client can't be found (or used), your editor will be used.
 
4699
 
 
4700
    To use a specific mail program, set the mail_client configuration option.
 
4701
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
 
4702
    specific clients are "claws", "evolution", "kmail", "mutt", and
 
4703
    "thunderbird"; generic options are "default", "editor", "emacsclient",
 
4704
    "mapi", and "xdg-email".  Plugins may also add supported clients.
 
4705
 
 
4706
    If mail is being sent, a to address is required.  This can be supplied
 
4707
    either on the commandline, by setting the submit_to configuration
 
4708
    option in the branch itself or the child_submit_to configuration option
 
4709
    in the submit branch.
 
4710
 
 
4711
    Two formats are currently supported: "4" uses revision bundle format 4 and
 
4712
    merge directive format 2.  It is significantly faster and smaller than
 
4713
    older formats.  It is compatible with Bazaar 0.19 and later.  It is the
 
4714
    default.  "0.9" uses revision bundle format 0.9 and merge directive
 
4715
    format 1.  It is compatible with Bazaar 0.12 - 0.18.
 
4716
 
 
4717
    The merge directives created by bzr send may be applied using bzr merge or
 
4718
    bzr pull by specifying a file containing a merge directive as the location.
 
4719
    """
 
4720
 
 
4721
    encoding_type = 'exact'
 
4722
 
 
4723
    _see_also = ['merge', 'pull']
 
4724
 
 
4725
    takes_args = ['submit_branch?', 'public_branch?']
 
4726
 
 
4727
    takes_options = [
 
4728
        Option('no-bundle',
 
4729
               help='Do not include a bundle in the merge directive.'),
 
4730
        Option('no-patch', help='Do not include a preview patch in the merge'
 
4731
               ' directive.'),
 
4732
        Option('remember',
 
4733
               help='Remember submit and public branch.'),
 
4734
        Option('from',
 
4735
               help='Branch to generate the submission from, '
 
4736
               'rather than the one containing the working directory.',
 
4737
               short_name='f',
 
4738
               type=unicode),
 
4739
        Option('output', short_name='o',
 
4740
               help='Write merge directive to this file; '
 
4741
                    'use - for stdout.',
 
4742
               type=unicode),
 
4743
        Option('mail-to', help='Mail the request to this address.',
 
4744
               type=unicode),
 
4745
        'revision',
 
4746
        'message',
 
4747
        Option('body', help='Body for the email.', type=unicode),
 
4748
        RegistryOption.from_kwargs('format',
 
4749
        'Use the specified output format.',
 
4750
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
4751
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
 
4752
        ]
 
4753
 
 
4754
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
 
4755
            no_patch=False, revision=None, remember=False, output=None,
 
4756
            format='4', mail_to=None, message=None, body=None, **kwargs):
 
4757
        return self._run(submit_branch, revision, public_branch, remember,
 
4758
                         format, no_bundle, no_patch, output,
 
4759
                         kwargs.get('from', '.'), mail_to, message, body)
 
4760
 
 
4761
    def _run(self, submit_branch, revision, public_branch, remember, format,
 
4762
             no_bundle, no_patch, output, from_, mail_to, message, body):
 
4763
        from bzrlib.revision import NULL_REVISION
 
4764
        branch = Branch.open_containing(from_)[0]
 
4765
        if output is None:
 
4766
            outfile = cStringIO.StringIO()
 
4767
        elif output == '-':
 
4768
            outfile = self.outf
 
4769
        else:
 
4770
            outfile = open(output, 'wb')
 
4771
        # we may need to write data into branch's repository to calculate
 
4772
        # the data to send.
 
4773
        branch.lock_write()
 
4774
        try:
 
4775
            if output is None:
 
4776
                config = branch.get_config()
 
4777
                if mail_to is None:
 
4778
                    mail_to = config.get_user_option('submit_to')
 
4779
                mail_client = config.get_mail_client()
 
4780
                if (not getattr(mail_client, 'supports_body', False)
 
4781
                    and body is not None):
 
4782
                    raise errors.BzrCommandError(
 
4783
                        'Mail client "%s" does not support specifying body' %
 
4784
                        mail_client.__class__.__name__)
 
4785
            if remember and submit_branch is None:
 
4786
                raise errors.BzrCommandError(
 
4787
                    '--remember requires a branch to be specified.')
 
4788
            stored_submit_branch = branch.get_submit_branch()
 
4789
            remembered_submit_branch = None
 
4790
            if submit_branch is None:
 
4791
                submit_branch = stored_submit_branch
 
4792
                remembered_submit_branch = "submit"
 
4793
            else:
 
4794
                if stored_submit_branch is None or remember:
 
4795
                    branch.set_submit_branch(submit_branch)
 
4796
            if submit_branch is None:
 
4797
                submit_branch = branch.get_parent()
 
4798
                remembered_submit_branch = "parent"
 
4799
            if submit_branch is None:
 
4800
                raise errors.BzrCommandError('No submit branch known or'
 
4801
                                             ' specified')
 
4802
            if remembered_submit_branch is not None:
 
4803
                note('Using saved %s location "%s" to determine what '
 
4804
                        'changes to submit.', remembered_submit_branch,
 
4805
                        submit_branch)
 
4806
 
 
4807
            if mail_to is None:
 
4808
                submit_config = Branch.open(submit_branch).get_config()
 
4809
                mail_to = submit_config.get_user_option("child_submit_to")
 
4810
 
 
4811
            stored_public_branch = branch.get_public_branch()
 
4812
            if public_branch is None:
 
4813
                public_branch = stored_public_branch
 
4814
            elif stored_public_branch is None or remember:
 
4815
                branch.set_public_branch(public_branch)
 
4816
            if no_bundle and public_branch is None:
 
4817
                raise errors.BzrCommandError('No public branch specified or'
 
4818
                                             ' known')
 
4819
            base_revision_id = None
 
4820
            revision_id = None
 
4821
            if revision is not None:
 
4822
                if len(revision) > 2:
 
4823
                    raise errors.BzrCommandError('bzr send takes '
 
4824
                        'at most two one revision identifiers')
 
4825
                revision_id = revision[-1].as_revision_id(branch)
 
4826
                if len(revision) == 2:
 
4827
                    base_revision_id = revision[0].as_revision_id(branch)
 
4828
            if revision_id is None:
 
4829
                revision_id = branch.last_revision()
 
4830
            if revision_id == NULL_REVISION:
 
4831
                raise errors.BzrCommandError('No revisions to submit.')
 
4832
            if format == '4':
 
4833
                directive = merge_directive.MergeDirective2.from_objects(
 
4834
                    branch.repository, revision_id, time.time(),
 
4835
                    osutils.local_time_offset(), submit_branch,
 
4836
                    public_branch=public_branch, include_patch=not no_patch,
 
4837
                    include_bundle=not no_bundle, message=message,
 
4838
                    base_revision_id=base_revision_id)
 
4839
            elif format == '0.9':
 
4840
                if not no_bundle:
 
4841
                    if not no_patch:
 
4842
                        patch_type = 'bundle'
 
4843
                    else:
 
4844
                        raise errors.BzrCommandError('Format 0.9 does not'
 
4845
                            ' permit bundle with no patch')
 
4846
                else:
 
4847
                    if not no_patch:
 
4848
                        patch_type = 'diff'
 
4849
                    else:
 
4850
                        patch_type = None
 
4851
                directive = merge_directive.MergeDirective.from_objects(
 
4852
                    branch.repository, revision_id, time.time(),
 
4853
                    osutils.local_time_offset(), submit_branch,
 
4854
                    public_branch=public_branch, patch_type=patch_type,
 
4855
                    message=message)
 
4856
 
 
4857
            outfile.writelines(directive.to_lines())
 
4858
            if output is None:
 
4859
                subject = '[MERGE] '
 
4860
                if message is not None:
 
4861
                    subject += message
 
4862
                else:
 
4863
                    revision = branch.repository.get_revision(revision_id)
 
4864
                    subject += revision.get_summary()
 
4865
                basename = directive.get_disk_name(branch)
 
4866
                mail_client.compose_merge_request(mail_to, subject,
 
4867
                                                  outfile.getvalue(),
 
4868
                                                  basename, body)
 
4869
        finally:
 
4870
            if output != '-':
 
4871
                outfile.close()
 
4872
            branch.unlock()
 
4873
 
 
4874
 
 
4875
class cmd_bundle_revisions(cmd_send):
 
4876
 
 
4877
    """Create a merge-directive for submitting changes.
 
4878
 
 
4879
    A merge directive provides many things needed for requesting merges:
 
4880
 
 
4881
    * A machine-readable description of the merge to perform
 
4882
 
 
4883
    * An optional patch that is a preview of the changes requested
 
4884
 
 
4885
    * An optional bundle of revision data, so that the changes can be applied
 
4886
      directly from the merge directive, without retrieving data from a
 
4887
      branch.
 
4888
 
 
4889
    If --no-bundle is specified, then public_branch is needed (and must be
 
4890
    up-to-date), so that the receiver can perform the merge using the
 
4891
    public_branch.  The public_branch is always included if known, so that
 
4892
    people can check it later.
 
4893
 
 
4894
    The submit branch defaults to the parent, but can be overridden.  Both
 
4895
    submit branch and public branch will be remembered if supplied.
 
4896
 
 
4897
    If a public_branch is known for the submit_branch, that public submit
 
4898
    branch is used in the merge instructions.  This means that a local mirror
 
4899
    can be used as your actual submit branch, once you have set public_branch
 
4900
    for that mirror.
 
4901
 
 
4902
    Two formats are currently supported: "4" uses revision bundle format 4 and
 
4903
    merge directive format 2.  It is significantly faster and smaller than
 
4904
    older formats.  It is compatible with Bazaar 0.19 and later.  It is the
 
4905
    default.  "0.9" uses revision bundle format 0.9 and merge directive
 
4906
    format 1.  It is compatible with Bazaar 0.12 - 0.18.
 
4907
    """
 
4908
 
 
4909
    takes_options = [
 
4910
        Option('no-bundle',
 
4911
               help='Do not include a bundle in the merge directive.'),
 
4912
        Option('no-patch', help='Do not include a preview patch in the merge'
 
4913
               ' directive.'),
 
4914
        Option('remember',
 
4915
               help='Remember submit and public branch.'),
 
4916
        Option('from',
 
4917
               help='Branch to generate the submission from, '
 
4918
               'rather than the one containing the working directory.',
 
4919
               short_name='f',
 
4920
               type=unicode),
 
4921
        Option('output', short_name='o', help='Write directive to this file.',
 
4922
               type=unicode),
 
4923
        'revision',
 
4924
        RegistryOption.from_kwargs('format',
 
4925
        'Use the specified output format.',
 
4926
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
4927
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
 
4928
        ]
 
4929
    aliases = ['bundle']
 
4930
 
 
4931
    _see_also = ['send', 'merge']
 
4932
 
 
4933
    hidden = True
 
4934
 
 
4935
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
 
4936
            no_patch=False, revision=None, remember=False, output=None,
 
4937
            format='4', **kwargs):
 
4938
        if output is None:
 
4939
            output = '-'
 
4940
        return self._run(submit_branch, revision, public_branch, remember,
 
4941
                         format, no_bundle, no_patch, output,
 
4942
                         kwargs.get('from', '.'), None, None, None)
 
4943
 
 
4944
 
 
4945
class cmd_tag(Command):
 
4946
    """Create, remove or modify a tag naming a revision.
 
4947
 
 
4948
    Tags give human-meaningful names to revisions.  Commands that take a -r
 
4949
    (--revision) option can be given -rtag:X, where X is any previously
 
4950
    created tag.
 
4951
 
 
4952
    Tags are stored in the branch.  Tags are copied from one branch to another
 
4953
    along when you branch, push, pull or merge.
 
4954
 
 
4955
    It is an error to give a tag name that already exists unless you pass
 
4956
    --force, in which case the tag is moved to point to the new revision.
 
4957
 
 
4958
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
 
4959
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
 
4960
    """
 
4961
 
 
4962
    _see_also = ['commit', 'tags']
 
4963
    takes_args = ['tag_name']
 
4964
    takes_options = [
 
4965
        Option('delete',
 
4966
            help='Delete this tag rather than placing it.',
 
4967
            ),
 
4968
        Option('directory',
 
4969
            help='Branch in which to place the tag.',
 
4970
            short_name='d',
 
4971
            type=unicode,
 
4972
            ),
 
4973
        Option('force',
 
4974
            help='Replace existing tags.',
 
4975
            ),
 
4976
        'revision',
 
4977
        ]
 
4978
 
 
4979
    def run(self, tag_name,
 
4980
            delete=None,
 
4981
            directory='.',
 
4982
            force=None,
 
4983
            revision=None,
 
4984
            ):
 
4985
        branch, relpath = Branch.open_containing(directory)
 
4986
        branch.lock_write()
 
4987
        try:
 
4988
            if delete:
 
4989
                branch.tags.delete_tag(tag_name)
 
4990
                self.outf.write('Deleted tag %s.\n' % tag_name)
 
4991
            else:
 
4992
                if revision:
 
4993
                    if len(revision) != 1:
 
4994
                        raise errors.BzrCommandError(
 
4995
                            "Tags can only be placed on a single revision, "
 
4996
                            "not on a range")
 
4997
                    revision_id = revision[0].as_revision_id(branch)
 
4998
                else:
 
4999
                    revision_id = branch.last_revision()
 
5000
                if (not force) and branch.tags.has_tag(tag_name):
 
5001
                    raise errors.TagAlreadyExists(tag_name)
 
5002
                branch.tags.set_tag(tag_name, revision_id)
 
5003
                self.outf.write('Created tag %s.\n' % tag_name)
 
5004
        finally:
 
5005
            branch.unlock()
 
5006
 
 
5007
 
 
5008
class cmd_tags(Command):
 
5009
    """List tags.
 
5010
 
 
5011
    This command shows a table of tag names and the revisions they reference.
 
5012
    """
 
5013
 
 
5014
    _see_also = ['tag']
 
5015
    takes_options = [
 
5016
        Option('directory',
 
5017
            help='Branch whose tags should be displayed.',
 
5018
            short_name='d',
 
5019
            type=unicode,
 
5020
            ),
 
5021
        RegistryOption.from_kwargs('sort',
 
5022
            'Sort tags by different criteria.', title='Sorting',
 
5023
            alpha='Sort tags lexicographically (default).',
 
5024
            time='Sort tags chronologically.',
 
5025
            ),
 
5026
        'show-ids',
 
5027
        'revision',
 
5028
    ]
 
5029
 
 
5030
    @display_command
 
5031
    def run(self,
 
5032
            directory='.',
 
5033
            sort='alpha',
 
5034
            show_ids=False,
 
5035
            revision=None,
 
5036
            ):
 
5037
        branch, relpath = Branch.open_containing(directory)
 
5038
 
 
5039
        tags = branch.tags.get_tag_dict().items()
 
5040
        if not tags:
 
5041
            return
 
5042
 
 
5043
        if revision:
 
5044
            branch.lock_read()
 
5045
            try:
 
5046
                graph = branch.repository.get_graph()
 
5047
                rev1, rev2 = _get_revision_range(revision, branch, self.name())
 
5048
                revid1, revid2 = rev1.rev_id, rev2.rev_id
 
5049
                # only show revisions between revid1 and revid2 (inclusive)
 
5050
                tags = [(tag, revid) for tag, revid in tags if
 
5051
                    graph.is_between(revid, revid1, revid2)]
 
5052
            finally:
 
5053
                branch.unlock()
 
5054
        if sort == 'alpha':
 
5055
            tags.sort()
 
5056
        elif sort == 'time':
 
5057
            timestamps = {}
 
5058
            for tag, revid in tags:
 
5059
                try:
 
5060
                    revobj = branch.repository.get_revision(revid)
 
5061
                except errors.NoSuchRevision:
 
5062
                    timestamp = sys.maxint # place them at the end
 
5063
                else:
 
5064
                    timestamp = revobj.timestamp
 
5065
                timestamps[revid] = timestamp
 
5066
            tags.sort(key=lambda x: timestamps[x[1]])
 
5067
        if not show_ids:
 
5068
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
 
5069
            revno_map = branch.get_revision_id_to_revno_map()
 
5070
            tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
 
5071
                        for tag, revid in tags ]
 
5072
        for tag, revspec in tags:
 
5073
            self.outf.write('%-20s %s\n' % (tag, revspec))
 
5074
 
 
5075
 
 
5076
class cmd_reconfigure(Command):
 
5077
    """Reconfigure the type of a bzr directory.
 
5078
 
 
5079
    A target configuration must be specified.
 
5080
 
 
5081
    For checkouts, the bind-to location will be auto-detected if not specified.
 
5082
    The order of preference is
 
5083
    1. For a lightweight checkout, the current bound location.
 
5084
    2. For branches that used to be checkouts, the previously-bound location.
 
5085
    3. The push location.
 
5086
    4. The parent location.
 
5087
    If none of these is available, --bind-to must be specified.
 
5088
    """
 
5089
 
 
5090
    _see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
 
5091
    takes_args = ['location?']
 
5092
    takes_options = [
 
5093
        RegistryOption.from_kwargs(
 
5094
            'target_type',
 
5095
            title='Target type',
 
5096
            help='The type to reconfigure the directory to.',
 
5097
            value_switches=True, enum_switch=False,
 
5098
            branch='Reconfigure to be an unbound branch with no working tree.',
 
5099
            tree='Reconfigure to be an unbound branch with a working tree.',
 
5100
            checkout='Reconfigure to be a bound branch with a working tree.',
 
5101
            lightweight_checkout='Reconfigure to be a lightweight'
 
5102
                ' checkout (with no local history).',
 
5103
            standalone='Reconfigure to be a standalone branch '
 
5104
                '(i.e. stop using shared repository).',
 
5105
            use_shared='Reconfigure to use a shared repository.',
 
5106
            with_trees='Reconfigure repository to create '
 
5107
                'working trees on branches by default.',
 
5108
            with_no_trees='Reconfigure repository to not create '
 
5109
                'working trees on branches by default.'
 
5110
            ),
 
5111
        Option('bind-to', help='Branch to bind checkout to.', type=str),
 
5112
        Option('force',
 
5113
               help='Perform reconfiguration even if local changes'
 
5114
               ' will be lost.')
 
5115
        ]
 
5116
 
 
5117
    def run(self, location=None, target_type=None, bind_to=None, force=False):
 
5118
        directory = bzrdir.BzrDir.open(location)
 
5119
        if target_type is None:
 
5120
            raise errors.BzrCommandError('No target configuration specified')
 
5121
        elif target_type == 'branch':
 
5122
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
 
5123
        elif target_type == 'tree':
 
5124
            reconfiguration = reconfigure.Reconfigure.to_tree(directory)
 
5125
        elif target_type == 'checkout':
 
5126
            reconfiguration = reconfigure.Reconfigure.to_checkout(
 
5127
                directory, bind_to)
 
5128
        elif target_type == 'lightweight-checkout':
 
5129
            reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
 
5130
                directory, bind_to)
 
5131
        elif target_type == 'use-shared':
 
5132
            reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
 
5133
        elif target_type == 'standalone':
 
5134
            reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
 
5135
        elif target_type == 'with-trees':
 
5136
            reconfiguration = reconfigure.Reconfigure.set_repository_trees(
 
5137
                directory, True)
 
5138
        elif target_type == 'with-no-trees':
 
5139
            reconfiguration = reconfigure.Reconfigure.set_repository_trees(
 
5140
                directory, False)
 
5141
        reconfiguration.apply(force)
 
5142
 
 
5143
 
 
5144
class cmd_switch(Command):
 
5145
    """Set the branch of a checkout and update.
 
5146
 
 
5147
    For lightweight checkouts, this changes the branch being referenced.
 
5148
    For heavyweight checkouts, this checks that there are no local commits
 
5149
    versus the current bound branch, then it makes the local branch a mirror
 
5150
    of the new location and binds to it.
 
5151
 
 
5152
    In both cases, the working tree is updated and uncommitted changes
 
5153
    are merged. The user can commit or revert these as they desire.
 
5154
 
 
5155
    Pending merges need to be committed or reverted before using switch.
 
5156
 
 
5157
    The path to the branch to switch to can be specified relative to the parent
 
5158
    directory of the current branch. For example, if you are currently in a
 
5159
    checkout of /path/to/branch, specifying 'newbranch' will find a branch at
 
5160
    /path/to/newbranch.
 
5161
 
 
5162
    Bound branches use the nickname of its master branch unless it is set
 
5163
    locally, in which case switching will update the the local nickname to be
 
5164
    that of the master.
 
5165
    """
 
5166
 
 
5167
    takes_args = ['to_location']
 
5168
    takes_options = [Option('force',
 
5169
                        help='Switch even if local commits will be lost.')
 
5170
                     ]
 
5171
 
 
5172
    def run(self, to_location, force=False):
 
5173
        from bzrlib import switch
 
5174
        tree_location = '.'
 
5175
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
 
5176
        branch = control_dir.open_branch()
 
5177
        try:
 
5178
            to_branch = Branch.open(to_location)
 
5179
        except errors.NotBranchError:
 
5180
            this_branch = control_dir.open_branch()
 
5181
            # This may be a heavy checkout, where we want the master branch
 
5182
            this_url = this_branch.get_bound_location()
 
5183
            # If not, use a local sibling
 
5184
            if this_url is None:
 
5185
                this_url = this_branch.base
 
5186
            to_branch = Branch.open(
 
5187
                urlutils.join(this_url, '..', to_location))
 
5188
        switch.switch(control_dir, to_branch, force)
 
5189
        if branch.get_config().has_explicit_nickname():
 
5190
            branch = control_dir.open_branch() #get the new branch!
 
5191
            branch.nick = to_branch.nick
 
5192
        note('Switched to branch: %s',
 
5193
            urlutils.unescape_for_display(to_branch.base, 'utf-8'))
 
5194
 
 
5195
 
 
5196
class cmd_view(Command):
 
5197
    """Manage filtered views.
 
5198
 
 
5199
    Views provide a mask over the tree so that users can focus on
 
5200
    a subset of a tree when doing their work. After creating a view,
 
5201
    commands that support a list of files - status, diff, commit, etc -
 
5202
    effectively have that list of files implicitly given each time.
 
5203
    An explicit list of files can still be given but those files
 
5204
    must be within the current view.
 
5205
 
 
5206
    In most cases, a view has a short life-span: it is created to make
 
5207
    a selected change and is deleted once that change is committed.
 
5208
    At other times, you may wish to create one or more named views
 
5209
    and switch between them.
 
5210
 
 
5211
    To disable the current view without deleting it, you can switch to
 
5212
    the pseudo view called ``off``. This can be useful when you need
 
5213
    to see the whole tree for an operation or two (e.g. merge) but
 
5214
    want to switch back to your view after that.
 
5215
 
 
5216
    :Examples:
 
5217
      To define the current view::
 
5218
 
 
5219
        bzr view file1 dir1 ...
 
5220
 
 
5221
      To list the current view::
 
5222
 
 
5223
        bzr view
 
5224
 
 
5225
      To delete the current view::
 
5226
 
 
5227
        bzr view --delete
 
5228
 
 
5229
      To disable the current view without deleting it::
 
5230
 
 
5231
        bzr view --switch off
 
5232
 
 
5233
      To define a named view and switch to it::
 
5234
 
 
5235
        bzr view --name view-name file1 dir1 ...
 
5236
 
 
5237
      To list a named view::
 
5238
 
 
5239
        bzr view --name view-name
 
5240
 
 
5241
      To delete a named view::
 
5242
 
 
5243
        bzr view --name view-name --delete
 
5244
 
 
5245
      To switch to a named view::
 
5246
 
 
5247
        bzr view --switch view-name
 
5248
 
 
5249
      To list all views defined::
 
5250
 
 
5251
        bzr view --all
 
5252
 
 
5253
      To delete all views::
 
5254
 
 
5255
        bzr view --delete --all
 
5256
    """
 
5257
 
 
5258
    _see_also = []
 
5259
    takes_args = ['file*']
 
5260
    takes_options = [
 
5261
        Option('all',
 
5262
            help='Apply list or delete action to all views.',
 
5263
            ),
 
5264
        Option('delete',
 
5265
            help='Delete the view.',
 
5266
            ),
 
5267
        Option('name',
 
5268
            help='Name of the view to define, list or delete.',
 
5269
            type=unicode,
 
5270
            ),
 
5271
        Option('switch',
 
5272
            help='Name of the view to switch to.',
 
5273
            type=unicode,
 
5274
            ),
 
5275
        ]
 
5276
 
 
5277
    def run(self, file_list,
 
5278
            all=False,
 
5279
            delete=False,
 
5280
            name=None,
 
5281
            switch=None,
 
5282
            ):
 
5283
        tree, file_list = tree_files(file_list, apply_view=False)
 
5284
        current_view, view_dict = tree.views.get_view_info()
 
5285
        if name is None:
 
5286
            name = current_view
 
5287
        if delete:
 
5288
            if file_list:
 
5289
                raise errors.BzrCommandError(
 
5290
                    "Both --delete and a file list specified")
 
5291
            elif switch:
 
5292
                raise errors.BzrCommandError(
 
5293
                    "Both --delete and --switch specified")
 
5294
            elif all:
 
5295
                tree.views.set_view_info(None, {})
 
5296
                self.outf.write("Deleted all views.\n")
 
5297
            elif name is None:
 
5298
                raise errors.BzrCommandError("No current view to delete")
 
5299
            else:
 
5300
                tree.views.delete_view(name)
 
5301
                self.outf.write("Deleted '%s' view.\n" % name)
 
5302
        elif switch:
 
5303
            if file_list:
 
5304
                raise errors.BzrCommandError(
 
5305
                    "Both --switch and a file list specified")
 
5306
            elif all:
 
5307
                raise errors.BzrCommandError(
 
5308
                    "Both --switch and --all specified")
 
5309
            elif switch == 'off':
 
5310
                if current_view is None:
 
5311
                    raise errors.BzrCommandError("No current view to disable")
 
5312
                tree.views.set_view_info(None, view_dict)
 
5313
                self.outf.write("Disabled '%s' view.\n" % (current_view))
 
5314
            else:
 
5315
                tree.views.set_view_info(switch, view_dict)
 
5316
                view_str = views.view_display_str(tree.views.lookup_view())
 
5317
                self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
 
5318
        elif all:
 
5319
            if view_dict:
 
5320
                self.outf.write('Views defined:\n')
 
5321
                for view in sorted(view_dict):
 
5322
                    if view == current_view:
 
5323
                        active = "=>"
 
5324
                    else:
 
5325
                        active = "  "
 
5326
                    view_str = views.view_display_str(view_dict[view])
 
5327
                    self.outf.write('%s %-20s %s\n' % (active, view, view_str))
 
5328
            else:
 
5329
                self.outf.write('No views defined.\n')
 
5330
        elif file_list:
 
5331
            if name is None:
 
5332
                # No name given and no current view set
 
5333
                name = 'my'
 
5334
            elif name == 'off':
 
5335
                raise errors.BzrCommandError(
 
5336
                    "Cannot change the 'off' pseudo view")
 
5337
            tree.views.set_view(name, sorted(file_list))
 
5338
            view_str = views.view_display_str(tree.views.lookup_view())
 
5339
            self.outf.write("Using '%s' view: %s\n" % (name, view_str))
 
5340
        else:
 
5341
            # list the files
 
5342
            if name is None:
 
5343
                # No name given and no current view set
 
5344
                self.outf.write('No current view.\n')
 
5345
            else:
 
5346
                view_str = views.view_display_str(tree.views.lookup_view(name))
 
5347
                self.outf.write("'%s' view is: %s\n" % (name, view_str))
 
5348
 
 
5349
 
 
5350
class cmd_hooks(Command):
 
5351
    """Show hooks."""
 
5352
 
 
5353
    hidden = True
 
5354
 
 
5355
    def run(self):
 
5356
        for hook_key in sorted(hooks.known_hooks.keys()):
 
5357
            some_hooks = hooks.known_hooks_key_to_object(hook_key)
 
5358
            self.outf.write("%s:\n" % type(some_hooks).__name__)
 
5359
            for hook_name, hook_point in sorted(some_hooks.items()):
 
5360
                self.outf.write("  %s:\n" % (hook_name,))
 
5361
                found_hooks = list(hook_point)
 
5362
                if found_hooks:
 
5363
                    for hook in found_hooks:
 
5364
                        self.outf.write("    %s\n" %
 
5365
                                        (some_hooks.get_hook_name(hook),))
 
5366
                else:
 
5367
                    self.outf.write("    <no hooks installed>\n")
 
5368
 
 
5369
 
 
5370
class cmd_shelve(Command):
 
5371
    """Temporarily set aside some changes from the current tree.
 
5372
 
 
5373
    Shelve allows you to temporarily put changes you've made "on the shelf",
 
5374
    ie. out of the way, until a later time when you can bring them back from
 
5375
    the shelf with the 'unshelve' command.  The changes are stored alongside
 
5376
    your working tree, and so they aren't propagated along with your branch nor
 
5377
    will they survive its deletion.
 
5378
 
 
5379
    If shelve --list is specified, previously-shelved changes are listed.
 
5380
 
 
5381
    Shelve is intended to help separate several sets of changes that have
 
5382
    been inappropriately mingled.  If you just want to get rid of all changes
 
5383
    and you don't need to restore them later, use revert.  If you want to
 
5384
    shelve all text changes at once, use shelve --all.
 
5385
 
 
5386
    If filenames are specified, only the changes to those files will be
 
5387
    shelved. Other files will be left untouched.
 
5388
 
 
5389
    If a revision is specified, changes since that revision will be shelved.
 
5390
 
 
5391
    You can put multiple items on the shelf, and by default, 'unshelve' will
 
5392
    restore the most recently shelved changes.
 
5393
    """
 
5394
 
 
5395
    takes_args = ['file*']
 
5396
 
 
5397
    takes_options = [
 
5398
        'revision',
 
5399
        Option('all', help='Shelve all changes.'),
 
5400
        'message',
 
5401
        RegistryOption('writer', 'Method to use for writing diffs.',
 
5402
                       bzrlib.option.diff_writer_registry,
 
5403
                       value_switches=True, enum_switch=False),
 
5404
 
 
5405
        Option('list', help='List shelved changes.'),
 
5406
        Option('destroy',
 
5407
               help='Destroy removed changes instead of shelving them.'),
 
5408
    ]
 
5409
    _see_also = ['unshelve']
 
5410
 
 
5411
    def run(self, revision=None, all=False, file_list=None, message=None,
 
5412
            writer=None, list=False, destroy=False):
 
5413
        if list:
 
5414
            return self.run_for_list()
 
5415
        from bzrlib.shelf_ui import Shelver
 
5416
        if writer is None:
 
5417
            writer = bzrlib.option.diff_writer_registry.get()
 
5418
        try:
 
5419
            Shelver.from_args(writer(sys.stdout), revision, all, file_list,
 
5420
                              message, destroy=destroy).run()
 
5421
        except errors.UserAbort:
 
5422
            return 0
 
5423
 
 
5424
    def run_for_list(self):
 
5425
        tree = WorkingTree.open_containing('.')[0]
 
5426
        tree.lock_read()
 
5427
        try:
 
5428
            manager = tree.get_shelf_manager()
 
5429
            shelves = manager.active_shelves()
 
5430
            if len(shelves) == 0:
 
5431
                note('No shelved changes.')
 
5432
                return 0
 
5433
            for shelf_id in reversed(shelves):
 
5434
                message = manager.get_metadata(shelf_id).get('message')
 
5435
                if message is None:
 
5436
                    message = '<no message>'
 
5437
                self.outf.write('%3d: %s\n' % (shelf_id, message))
 
5438
            return 1
 
5439
        finally:
 
5440
            tree.unlock()
 
5441
 
 
5442
 
 
5443
class cmd_unshelve(Command):
 
5444
    """Restore shelved changes.
 
5445
 
 
5446
    By default, the most recently shelved changes are restored. However if you
 
5447
    specify a shelf by id those changes will be restored instead.  This works
 
5448
    best when the changes don't depend on each other.
 
5449
    """
 
5450
 
 
5451
    takes_args = ['shelf_id?']
 
5452
    takes_options = [
 
5453
        RegistryOption.from_kwargs(
 
5454
            'action', help="The action to perform.",
 
5455
            enum_switch=False, value_switches=True,
 
5456
            apply="Apply changes and remove from the shelf.",
 
5457
            dry_run="Show changes, but do not apply or remove them.",
 
5458
            delete_only="Delete changes without applying them."
 
5459
        )
 
5460
    ]
 
5461
    _see_also = ['shelve']
 
5462
 
 
5463
    def run(self, shelf_id=None, action='apply'):
 
5464
        from bzrlib.shelf_ui import Unshelver
 
5465
        Unshelver.from_args(shelf_id, action).run()
 
5466
 
 
5467
 
 
5468
class cmd_clean_tree(Command):
 
5469
    """Remove unwanted files from working tree.
 
5470
 
 
5471
    By default, only unknown files, not ignored files, are deleted.  Versioned
 
5472
    files are never deleted.
 
5473
 
 
5474
    Another class is 'detritus', which includes files emitted by bzr during
 
5475
    normal operations and selftests.  (The value of these files decreases with
 
5476
    time.)
 
5477
 
 
5478
    If no options are specified, unknown files are deleted.  Otherwise, option
 
5479
    flags are respected, and may be combined.
 
5480
 
 
5481
    To check what clean-tree will do, use --dry-run.
 
5482
    """
 
5483
    takes_options = [Option('ignored', help='Delete all ignored files.'),
 
5484
                     Option('detritus', help='Delete conflict files, merge'
 
5485
                            ' backups, and failed selftest dirs.'),
 
5486
                     Option('unknown',
 
5487
                            help='Delete files unknown to bzr (default).'),
 
5488
                     Option('dry-run', help='Show files to delete instead of'
 
5489
                            ' deleting them.'),
 
5490
                     Option('force', help='Do not prompt before deleting.')]
 
5491
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
 
5492
            force=False):
 
5493
        from bzrlib.clean_tree import clean_tree
 
5494
        if not (unknown or ignored or detritus):
 
5495
            unknown = True
 
5496
        if dry_run:
 
5497
            force = True
 
5498
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
 
5499
                   dry_run=dry_run, no_prompt=force)
 
5500
 
 
5501
 
 
5502
def _create_prefix(cur_transport):
 
5503
    needed = [cur_transport]
 
5504
    # Recurse upwards until we can create a directory successfully
 
5505
    while True:
 
5506
        new_transport = cur_transport.clone('..')
 
5507
        if new_transport.base == cur_transport.base:
 
5508
            raise errors.BzrCommandError(
 
5509
                "Failed to create path prefix for %s."
 
5510
                % cur_transport.base)
 
5511
        try:
 
5512
            new_transport.mkdir('.')
 
5513
        except errors.NoSuchFile:
 
5514
            needed.append(new_transport)
 
5515
            cur_transport = new_transport
 
5516
        else:
 
5517
            break
 
5518
    # Now we only need to create child directories
 
5519
    while needed:
 
5520
        cur_transport = needed.pop()
 
5521
        cur_transport.ensure_base()
 
5522
 
 
5523
 
 
5524
# these get imported and then picked up by the scan for cmd_*
 
5525
# TODO: Some more consistent way to split command definitions across files;
 
5526
# we do need to load at least some information about them to know of
 
5527
# aliases.  ideally we would avoid loading the implementation until the
 
5528
# details were needed.
 
5529
from bzrlib.cmd_version_info import cmd_version_info
 
5530
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
5531
from bzrlib.bundle.commands import (
 
5532
    cmd_bundle_info,
 
5533
    )
 
5534
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
5535
from bzrlib.weave_commands import cmd_versionedfile_list, \
 
5536
        cmd_weave_plan_merge, cmd_weave_merge_text