/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

merge bzr.dev rev 4098

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