/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: John Arbash Meinel
  • Date: 2009-03-24 16:35:22 UTC
  • mto: This revision was merged to the branch mainline in revision 4198.
  • Revision ID: john@arbash-meinel.com-20090324163522-p0p9s5ahzsnem1oc
A few notes, some updates from ian.

Show diffs side-by-side

added added

removed removed

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