/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-03-24 17:01:50 UTC
  • mfrom: (4178.3.7 lru_cache_linked_lst)
  • Revision ID: pqm@pqm.ubuntu.com-20090324170150-9wtdpv5w7192zdwy
(jam) Improvements to LRUCache structure, use a double-linked-list

Show diffs side-by-side

added added

removed removed

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