← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Martin Pool
  • Date: 2009-03-03 01:45:32 UTC
  • mto: (4070.4.5 gnu-changelog)
  • mto: This revision was merged to the branch mainline in revision 4081.
  • Revision ID: mbp@sourcefrog.net-20090303014532-d223fxy97cb1og8f
Recommend setting timestamp in BranchBuilder

Show diffs side-by-side

added added

removed removed

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