/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: Vincent Ladeuil
  • Date: 2009-07-02 09:09:35 UTC
  • mto: (4536.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4537.
  • Revision ID: v.ladeuil+lp@free.fr-20090702090935-ya2kx3t8mz1tsf2k
ui.get_boolean can also use bool_from_string.

* bzrlib/ui/__init__.py:
(CLIUIFactory.get_boolean): Simplified by using bool_from_string.

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