/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: Ian Clatworthy
  • Date: 2009-03-25 05:33:40 UTC
  • mto: (4205.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 4206.
  • Revision ID: ian.clatworthy@canonical.com-20090325053340-86gbo7fh0dk09d32
get directory logging working again

Show diffs side-by-side

added added

removed removed

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