/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Robert Collins
  • Date: 2009-03-03 23:05:52 UTC
  • mto: (4083.1.1 robert-rollup)
  • mto: This revision was merged to the branch mainline in revision 4084.
  • Revision ID: robertc@robertcollins.net-20090303230552-isxgvyezephwq1vi
add should not print 'add completed' unnecessarily.

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