/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

Merged in bzr.dev.

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