/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Robert Collins
  • Date: 2009-04-02 05:05:17 UTC
  • mto: This revision was merged to the branch mainline in revision 4234.
  • Revision ID: robertc@robertcollins.net-20090402050517-4m3m3fq2ttfvwoi0
Alter test_config.FakeBranch in accordance with the Branch change to have a _get_config.

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