/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 breezy/builtins.py

  • Committer: Jelmer Vernooij
  • Date: 2020-02-07 02:14:30 UTC
  • mto: This revision was merged to the branch mainline in revision 7492.
  • Revision ID: jelmer@jelmer.uk-20200207021430-m49iq3x4x8xlib6x
Drop python2 support.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/builtins.py
 
1
# Copyright (C) 2005-2012 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
"""builtin brz commands"""
 
18
 
 
19
from __future__ import absolute_import
 
20
 
 
21
import errno
 
22
import os
 
23
import sys
 
24
 
 
25
import breezy.bzr
 
26
import breezy.git
 
27
 
 
28
from . import (
 
29
    errors,
 
30
    )
 
31
 
 
32
from . import lazy_import
 
33
lazy_import.lazy_import(globals(), """
 
34
import time
 
35
 
 
36
import breezy
 
37
from breezy import (
 
38
    branch as _mod_branch,
 
39
    bugtracker,
 
40
    cache_utf8,
 
41
    controldir,
 
42
    directory_service,
 
43
    delta,
 
44
    config as _mod_config,
 
45
    globbing,
 
46
    gpg,
 
47
    hooks,
 
48
    lazy_regex,
 
49
    log,
 
50
    merge as _mod_merge,
 
51
    mergeable as _mod_mergeable,
 
52
    merge_directive,
 
53
    osutils,
 
54
    reconfigure,
 
55
    rename_map,
 
56
    revision as _mod_revision,
 
57
    symbol_versioning,
 
58
    timestamp,
 
59
    transport,
 
60
    tree as _mod_tree,
 
61
    ui,
 
62
    urlutils,
 
63
    views,
 
64
    )
 
65
from breezy.branch import Branch
 
66
from breezy.conflicts import ConflictList
 
67
from breezy.transport import memory
 
68
from breezy.smtp_connection import SMTPConnection
 
69
from breezy.workingtree import WorkingTree
 
70
from breezy.i18n import gettext, ngettext
 
71
""")
 
72
 
 
73
from .commands import (
 
74
    Command,
 
75
    builtin_command_registry,
 
76
    display_command,
 
77
    )
 
78
from .option import (
 
79
    ListOption,
 
80
    Option,
 
81
    RegistryOption,
 
82
    custom_help,
 
83
    _parse_revision_str,
 
84
    )
 
85
from .revisionspec import (
 
86
    RevisionSpec,
 
87
    RevisionInfo,
 
88
    )
 
89
from .trace import mutter, note, warning, is_quiet, get_verbosity_level
 
90
 
 
91
 
 
92
def _get_branch_location(control_dir, possible_transports=None):
 
93
    """Return location of branch for this control dir."""
 
94
    try:
 
95
        target = control_dir.get_branch_reference()
 
96
    except errors.NotBranchError:
 
97
        return control_dir.root_transport.base
 
98
    if target is not None:
 
99
        return target
 
100
    this_branch = control_dir.open_branch(
 
101
        possible_transports=possible_transports)
 
102
    # This may be a heavy checkout, where we want the master branch
 
103
    master_location = this_branch.get_bound_location()
 
104
    if master_location is not None:
 
105
        return master_location
 
106
    # If not, use a local sibling
 
107
    return this_branch.base
 
108
 
 
109
 
 
110
def _is_colocated(control_dir, possible_transports=None):
 
111
    """Check if the branch in control_dir is colocated.
 
112
 
 
113
    :param control_dir: Control directory
 
114
    :return: Tuple with boolean indicating whether the branch is colocated
 
115
        and the full URL to the actual branch
 
116
    """
 
117
    # This path is meant to be relative to the existing branch
 
118
    this_url = _get_branch_location(
 
119
        control_dir, possible_transports=possible_transports)
 
120
    # Perhaps the target control dir supports colocated branches?
 
121
    try:
 
122
        root = controldir.ControlDir.open(
 
123
            this_url, possible_transports=possible_transports)
 
124
    except errors.NotBranchError:
 
125
        return (False, this_url)
 
126
    else:
 
127
        try:
 
128
            control_dir.open_workingtree()
 
129
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
130
            return (False, this_url)
 
131
        else:
 
132
            return (
 
133
                root._format.colocated_branches and
 
134
                control_dir.control_url == root.control_url,
 
135
                this_url)
 
136
 
 
137
 
 
138
def lookup_new_sibling_branch(control_dir, location, possible_transports=None):
 
139
    """Lookup the location for a new sibling branch.
 
140
 
 
141
    :param control_dir: Control directory to find sibling branches from
 
142
    :param location: Name of the new branch
 
143
    :return: Full location to the new branch
 
144
    """
 
145
    location = directory_service.directories.dereference(location)
 
146
    if '/' not in location and '\\' not in location:
 
147
        (colocated, this_url) = _is_colocated(control_dir, possible_transports)
 
148
 
 
149
        if colocated:
 
150
            return urlutils.join_segment_parameters(
 
151
                this_url, {"branch": urlutils.escape(location)})
 
152
        else:
 
153
            return urlutils.join(this_url, '..', urlutils.escape(location))
 
154
    return location
 
155
 
 
156
 
 
157
def open_sibling_branch(control_dir, location, possible_transports=None):
 
158
    """Open a branch, possibly a sibling of another.
 
159
 
 
160
    :param control_dir: Control directory relative to which to lookup the
 
161
        location.
 
162
    :param location: Location to look up
 
163
    :return: branch to open
 
164
    """
 
165
    try:
 
166
        # Perhaps it's a colocated branch?
 
167
        return control_dir.open_branch(
 
168
            location, possible_transports=possible_transports)
 
169
    except (errors.NotBranchError, errors.NoColocatedBranchSupport):
 
170
        this_url = _get_branch_location(control_dir)
 
171
        return Branch.open(
 
172
            urlutils.join(
 
173
                this_url, '..', urlutils.escape(location)))
 
174
 
 
175
 
 
176
def open_nearby_branch(near=None, location=None, possible_transports=None):
 
177
    """Open a nearby branch.
 
178
 
 
179
    :param near: Optional location of container from which to open branch
 
180
    :param location: Location of the branch
 
181
    :return: Branch instance
 
182
    """
 
183
    if near is None:
 
184
        if location is None:
 
185
            location = "."
 
186
        try:
 
187
            return Branch.open(
 
188
                location, possible_transports=possible_transports)
 
189
        except errors.NotBranchError:
 
190
            near = "."
 
191
    cdir = controldir.ControlDir.open(
 
192
        near, possible_transports=possible_transports)
 
193
    return open_sibling_branch(
 
194
        cdir, location, possible_transports=possible_transports)
 
195
 
 
196
 
 
197
def iter_sibling_branches(control_dir, possible_transports=None):
 
198
    """Iterate over the siblings of a branch.
 
199
 
 
200
    :param control_dir: Control directory for which to look up the siblings
 
201
    :return: Iterator over tuples with branch name and branch object
 
202
    """
 
203
    try:
 
204
        reference = control_dir.get_branch_reference()
 
205
    except errors.NotBranchError:
 
206
        reference = None
 
207
    if reference is not None:
 
208
        try:
 
209
            ref_branch = Branch.open(
 
210
                reference, possible_transports=possible_transports)
 
211
        except errors.NotBranchError:
 
212
            ref_branch = None
 
213
    else:
 
214
        ref_branch = None
 
215
    if ref_branch is None or ref_branch.name:
 
216
        if ref_branch is not None:
 
217
            control_dir = ref_branch.controldir
 
218
        for name, branch in control_dir.get_branches().items():
 
219
            yield name, branch
 
220
    else:
 
221
        repo = ref_branch.controldir.find_repository()
 
222
        for branch in repo.find_branches(using=True):
 
223
            name = urlutils.relative_url(
 
224
                repo.user_url, branch.user_url).rstrip("/")
 
225
            yield name, branch
 
226
 
 
227
 
 
228
def tree_files_for_add(file_list):
 
229
    """
 
230
    Return a tree and list of absolute paths from a file list.
 
231
 
 
232
    Similar to tree_files, but add handles files a bit differently, so it a
 
233
    custom implementation.  In particular, MutableTreeTree.smart_add expects
 
234
    absolute paths, which it immediately converts to relative paths.
 
235
    """
 
236
    # FIXME Would be nice to just return the relative paths like
 
237
    # internal_tree_files does, but there are a large number of unit tests
 
238
    # that assume the current interface to mutabletree.smart_add
 
239
    if file_list:
 
240
        tree, relpath = WorkingTree.open_containing(file_list[0])
 
241
        if tree.supports_views():
 
242
            view_files = tree.views.lookup_view()
 
243
            if view_files:
 
244
                for filename in file_list:
 
245
                    if not osutils.is_inside_any(view_files, filename):
 
246
                        raise views.FileOutsideView(filename, view_files)
 
247
        file_list = file_list[:]
 
248
        file_list[0] = tree.abspath(relpath)
 
249
    else:
 
250
        tree = WorkingTree.open_containing(u'.')[0]
 
251
        if tree.supports_views():
 
252
            view_files = tree.views.lookup_view()
 
253
            if view_files:
 
254
                file_list = view_files
 
255
                view_str = views.view_display_str(view_files)
 
256
                note(gettext("Ignoring files outside view. View is %s"),
 
257
                     view_str)
 
258
    return tree, file_list
 
259
 
 
260
 
 
261
def _get_one_revision(command_name, revisions):
 
262
    if revisions is None:
 
263
        return None
 
264
    if len(revisions) != 1:
 
265
        raise errors.BzrCommandError(gettext(
 
266
            'brz %s --revision takes exactly one revision identifier') % (
 
267
                command_name,))
 
268
    return revisions[0]
 
269
 
 
270
 
 
271
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
 
272
    """Get a revision tree. Not suitable for commands that change the tree.
 
273
 
 
274
    Specifically, the basis tree in dirstate trees is coupled to the dirstate
 
275
    and doing a commit/uncommit/pull will at best fail due to changing the
 
276
    basis revision data.
 
277
 
 
278
    If tree is passed in, it should be already locked, for lifetime management
 
279
    of the trees internal cached state.
 
280
    """
 
281
    if branch is None:
 
282
        branch = tree.branch
 
283
    if revisions is None:
 
284
        if tree is not None:
 
285
            rev_tree = tree.basis_tree()
 
286
        else:
 
287
            rev_tree = branch.basis_tree()
 
288
    else:
 
289
        revision = _get_one_revision(command_name, revisions)
 
290
        rev_tree = revision.as_tree(branch)
 
291
    return rev_tree
 
292
 
 
293
 
 
294
def _get_view_info_for_change_reporter(tree):
 
295
    """Get the view information from a tree for change reporting."""
 
296
    view_info = None
 
297
    try:
 
298
        current_view = tree.views.get_view_info()[0]
 
299
        if current_view is not None:
 
300
            view_info = (current_view, tree.views.lookup_view())
 
301
    except views.ViewsNotSupported:
 
302
        pass
 
303
    return view_info
 
304
 
 
305
 
 
306
def _open_directory_or_containing_tree_or_branch(filename, directory):
 
307
    """Open the tree or branch containing the specified file, unless
 
308
    the --directory option is used to specify a different branch."""
 
309
    if directory is not None:
 
310
        return (None, Branch.open(directory), filename)
 
311
    return controldir.ControlDir.open_containing_tree_or_branch(filename)
 
312
 
 
313
 
 
314
# TODO: Make sure no commands unconditionally use the working directory as a
 
315
# branch.  If a filename argument is used, the first of them should be used to
 
316
# specify the branch.  (Perhaps this can be factored out into some kind of
 
317
# Argument class, representing a file in a branch, where the first occurrence
 
318
# opens the branch?)
 
319
 
 
320
class cmd_status(Command):
 
321
    __doc__ = """Display status summary.
 
322
 
 
323
    This reports on versioned and unknown files, reporting them
 
324
    grouped by state.  Possible states are:
 
325
 
 
326
    added
 
327
        Versioned in the working copy but not in the previous revision.
 
328
 
 
329
    removed
 
330
        Versioned in the previous revision but removed or deleted
 
331
        in the working copy.
 
332
 
 
333
    renamed
 
334
        Path of this file changed from the previous revision;
 
335
        the text may also have changed.  This includes files whose
 
336
        parent directory was renamed.
 
337
 
 
338
    modified
 
339
        Text has changed since the previous revision.
 
340
 
 
341
    kind changed
 
342
        File kind has been changed (e.g. from file to directory).
 
343
 
 
344
    unknown
 
345
        Not versioned and not matching an ignore pattern.
 
346
 
 
347
    Additionally for directories, symlinks and files with a changed
 
348
    executable bit, Breezy indicates their type using a trailing
 
349
    character: '/', '@' or '*' respectively. These decorations can be
 
350
    disabled using the '--no-classify' option.
 
351
 
 
352
    To see ignored files use 'brz ignored'.  For details on the
 
353
    changes to file texts, use 'brz diff'.
 
354
 
 
355
    Note that --short or -S gives status flags for each item, similar
 
356
    to Subversion's status command. To get output similar to svn -q,
 
357
    use brz status -SV.
 
358
 
 
359
    If no arguments are specified, the status of the entire working
 
360
    directory is shown.  Otherwise, only the status of the specified
 
361
    files or directories is reported.  If a directory is given, status
 
362
    is reported for everything inside that directory.
 
363
 
 
364
    Before merges are committed, the pending merge tip revisions are
 
365
    shown. To see all pending merge revisions, use the -v option.
 
366
    To skip the display of pending merge information altogether, use
 
367
    the no-pending option or specify a file/directory.
 
368
 
 
369
    To compare the working directory to a specific revision, pass a
 
370
    single revision to the revision argument.
 
371
 
 
372
    To see which files have changed in a specific revision, or between
 
373
    two revisions, pass a revision range to the revision argument.
 
374
    This will produce the same results as calling 'brz diff --summarize'.
 
375
    """
 
376
 
 
377
    # TODO: --no-recurse/-N, --recurse options
 
378
 
 
379
    takes_args = ['file*']
 
380
    takes_options = ['show-ids', 'revision', 'change', 'verbose',
 
381
                     Option('short', help='Use short status indicators.',
 
382
                            short_name='S'),
 
383
                     Option('versioned', help='Only show versioned files.',
 
384
                            short_name='V'),
 
385
                     Option('no-pending', help='Don\'t show pending merges.'),
 
386
                     Option('no-classify',
 
387
                            help='Do not mark object type using indicator.'),
 
388
                     ]
 
389
    aliases = ['st', 'stat']
 
390
 
 
391
    encoding_type = 'replace'
 
392
    _see_also = ['diff', 'revert', 'status-flags']
 
393
 
 
394
    @display_command
 
395
    def run(self, show_ids=False, file_list=None, revision=None, short=False,
 
396
            versioned=False, no_pending=False, verbose=False,
 
397
            no_classify=False):
 
398
        from .status import show_tree_status
 
399
 
 
400
        if revision and len(revision) > 2:
 
401
            raise errors.BzrCommandError(
 
402
                gettext('brz status --revision takes exactly'
 
403
                        ' one or two revision specifiers'))
 
404
 
 
405
        tree, relfile_list = WorkingTree.open_containing_paths(file_list)
 
406
        # Avoid asking for specific files when that is not needed.
 
407
        if relfile_list == ['']:
 
408
            relfile_list = None
 
409
            # Don't disable pending merges for full trees other than '.'.
 
410
            if file_list == ['.']:
 
411
                no_pending = True
 
412
        # A specific path within a tree was given.
 
413
        elif relfile_list is not None:
 
414
            no_pending = True
 
415
        show_tree_status(tree, show_ids=show_ids,
 
416
                         specific_files=relfile_list, revision=revision,
 
417
                         to_file=self.outf, short=short, versioned=versioned,
 
418
                         show_pending=(not no_pending), verbose=verbose,
 
419
                         classify=not no_classify)
 
420
 
 
421
 
 
422
class cmd_cat_revision(Command):
 
423
    __doc__ = """Write out metadata for a revision.
 
424
 
 
425
    The revision to print can either be specified by a specific
 
426
    revision identifier, or you can use --revision.
 
427
    """
 
428
 
 
429
    hidden = True
 
430
    takes_args = ['revision_id?']
 
431
    takes_options = ['directory', 'revision']
 
432
    # cat-revision is more for frontends so should be exact
 
433
    encoding = 'strict'
 
434
 
 
435
    def print_revision(self, revisions, revid):
 
436
        stream = revisions.get_record_stream([(revid,)], 'unordered', True)
 
437
        record = next(stream)
 
438
        if record.storage_kind == 'absent':
 
439
            raise errors.NoSuchRevision(revisions, revid)
 
440
        revtext = record.get_bytes_as('fulltext')
 
441
        self.outf.write(revtext.decode('utf-8'))
 
442
 
 
443
    @display_command
 
444
    def run(self, revision_id=None, revision=None, directory=u'.'):
 
445
        if revision_id is not None and revision is not None:
 
446
            raise errors.BzrCommandError(gettext('You can only supply one of'
 
447
                                                 ' revision_id or --revision'))
 
448
        if revision_id is None and revision is None:
 
449
            raise errors.BzrCommandError(
 
450
                gettext('You must supply either --revision or a revision_id'))
 
451
 
 
452
        b = controldir.ControlDir.open_containing_tree_or_branch(directory)[1]
 
453
 
 
454
        revisions = getattr(b.repository, "revisions", None)
 
455
        if revisions is None:
 
456
            raise errors.BzrCommandError(
 
457
                gettext('Repository %r does not support '
 
458
                        'access to raw revision texts') % b.repository)
 
459
 
 
460
        with b.repository.lock_read():
 
461
            # TODO: jam 20060112 should cat-revision always output utf-8?
 
462
            if revision_id is not None:
 
463
                revision_id = cache_utf8.encode(revision_id)
 
464
                try:
 
465
                    self.print_revision(revisions, revision_id)
 
466
                except errors.NoSuchRevision:
 
467
                    msg = gettext(
 
468
                        "The repository {0} contains no revision {1}.").format(
 
469
                            b.repository.base, revision_id.decode('utf-8'))
 
470
                    raise errors.BzrCommandError(msg)
 
471
            elif revision is not None:
 
472
                for rev in revision:
 
473
                    if rev is None:
 
474
                        raise errors.BzrCommandError(
 
475
                            gettext('You cannot specify a NULL revision.'))
 
476
                    rev_id = rev.as_revision_id(b)
 
477
                    self.print_revision(revisions, rev_id)
 
478
 
 
479
 
 
480
class cmd_remove_tree(Command):
 
481
    __doc__ = """Remove the working tree from a given branch/checkout.
 
482
 
 
483
    Since a lightweight checkout is little more than a working tree
 
484
    this will refuse to run against one.
 
485
 
 
486
    To re-create the working tree, use "brz checkout".
 
487
    """
 
488
    _see_also = ['checkout', 'working-trees']
 
489
    takes_args = ['location*']
 
490
    takes_options = [
 
491
        Option('force',
 
492
               help='Remove the working tree even if it has '
 
493
                    'uncommitted or shelved changes.'),
 
494
        ]
 
495
 
 
496
    def run(self, location_list, force=False):
 
497
        if not location_list:
 
498
            location_list = ['.']
 
499
 
 
500
        for location in location_list:
 
501
            d = controldir.ControlDir.open(location)
 
502
 
 
503
            try:
 
504
                working = d.open_workingtree()
 
505
            except errors.NoWorkingTree:
 
506
                raise errors.BzrCommandError(
 
507
                    gettext("No working tree to remove"))
 
508
            except errors.NotLocalUrl:
 
509
                raise errors.BzrCommandError(
 
510
                    gettext("You cannot remove the working tree"
 
511
                            " of a remote path"))
 
512
            if not force:
 
513
                if (working.has_changes()):
 
514
                    raise errors.UncommittedChanges(working)
 
515
                if working.get_shelf_manager().last_shelf() is not None:
 
516
                    raise errors.ShelvedChanges(working)
 
517
 
 
518
            if working.user_url != working.branch.user_url:
 
519
                raise errors.BzrCommandError(
 
520
                    gettext("You cannot remove the working tree"
 
521
                            " from a lightweight checkout"))
 
522
 
 
523
            d.destroy_workingtree()
 
524
 
 
525
 
 
526
class cmd_repair_workingtree(Command):
 
527
    __doc__ = """Reset the working tree state file.
 
528
 
 
529
    This is not meant to be used normally, but more as a way to recover from
 
530
    filesystem corruption, etc. This rebuilds the working inventory back to a
 
531
    'known good' state. Any new modifications (adding a file, renaming, etc)
 
532
    will be lost, though modified files will still be detected as such.
 
533
 
 
534
    Most users will want something more like "brz revert" or "brz update"
 
535
    unless the state file has become corrupted.
 
536
 
 
537
    By default this attempts to recover the current state by looking at the
 
538
    headers of the state file. If the state file is too corrupted to even do
 
539
    that, you can supply --revision to force the state of the tree.
 
540
    """
 
541
 
 
542
    takes_options = [
 
543
        'revision', 'directory',
 
544
        Option('force',
 
545
               help='Reset the tree even if it doesn\'t appear to be'
 
546
                    ' corrupted.'),
 
547
    ]
 
548
    hidden = True
 
549
 
 
550
    def run(self, revision=None, directory='.', force=False):
 
551
        tree, _ = WorkingTree.open_containing(directory)
 
552
        self.enter_context(tree.lock_tree_write())
 
553
        if not force:
 
554
            try:
 
555
                tree.check_state()
 
556
            except errors.BzrError:
 
557
                pass  # There seems to be a real error here, so we'll reset
 
558
            else:
 
559
                # Refuse
 
560
                raise errors.BzrCommandError(gettext(
 
561
                    'The tree does not appear to be corrupt. You probably'
 
562
                    ' want "brz revert" instead. Use "--force" if you are'
 
563
                    ' sure you want to reset the working tree.'))
 
564
        if revision is None:
 
565
            revision_ids = None
 
566
        else:
 
567
            revision_ids = [r.as_revision_id(tree.branch) for r in revision]
 
568
        try:
 
569
            tree.reset_state(revision_ids)
 
570
        except errors.BzrError:
 
571
            if revision_ids is None:
 
572
                extra = gettext(', the header appears corrupt, try passing '
 
573
                                '-r -1 to set the state to the last commit')
 
574
            else:
 
575
                extra = ''
 
576
            raise errors.BzrCommandError(
 
577
                gettext('failed to reset the tree state{0}').format(extra))
 
578
 
 
579
 
 
580
class cmd_revno(Command):
 
581
    __doc__ = """Show current revision number.
 
582
 
 
583
    This is equal to the number of revisions on this branch.
 
584
    """
 
585
 
 
586
    _see_also = ['info']
 
587
    takes_args = ['location?']
 
588
    takes_options = [
 
589
        Option('tree', help='Show revno of working tree.'),
 
590
        'revision',
 
591
        ]
 
592
 
 
593
    @display_command
 
594
    def run(self, tree=False, location=u'.', revision=None):
 
595
        if revision is not None and tree:
 
596
            raise errors.BzrCommandError(
 
597
                gettext("--tree and --revision can not be used together"))
 
598
 
 
599
        if tree:
 
600
            try:
 
601
                wt = WorkingTree.open_containing(location)[0]
 
602
                self.enter_context(wt.lock_read())
 
603
            except (errors.NoWorkingTree, errors.NotLocalUrl):
 
604
                raise errors.NoWorkingTree(location)
 
605
            b = wt.branch
 
606
            revid = wt.last_revision()
 
607
        else:
 
608
            b = Branch.open_containing(location)[0]
 
609
            self.enter_context(b.lock_read())
 
610
            if revision:
 
611
                if len(revision) != 1:
 
612
                    raise errors.BzrCommandError(gettext(
 
613
                        "Revision numbers only make sense for single "
 
614
                        "revisions, not ranges"))
 
615
                revid = revision[0].as_revision_id(b)
 
616
            else:
 
617
                revid = b.last_revision()
 
618
        try:
 
619
            revno_t = b.revision_id_to_dotted_revno(revid)
 
620
        except (errors.NoSuchRevision, errors.GhostRevisionsHaveNoRevno):
 
621
            revno_t = ('???',)
 
622
        revno = ".".join(str(n) for n in revno_t)
 
623
        self.cleanup_now()
 
624
        self.outf.write(revno + '\n')
 
625
 
 
626
 
 
627
class cmd_revision_info(Command):
 
628
    __doc__ = """Show revision number and revision id for a given revision identifier.
 
629
    """
 
630
    hidden = True
 
631
    takes_args = ['revision_info*']
 
632
    takes_options = [
 
633
        'revision',
 
634
        custom_help('directory', help='Branch to examine, '
 
635
                    'rather than the one containing the working directory.'),
 
636
        Option('tree', help='Show revno of working tree.'),
 
637
        ]
 
638
 
 
639
    @display_command
 
640
    def run(self, revision=None, directory=u'.', tree=False,
 
641
            revision_info_list=[]):
 
642
 
 
643
        try:
 
644
            wt = WorkingTree.open_containing(directory)[0]
 
645
            b = wt.branch
 
646
            self.enter_context(wt.lock_read())
 
647
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
648
            wt = None
 
649
            b = Branch.open_containing(directory)[0]
 
650
            self.enter_context(b.lock_read())
 
651
        revision_ids = []
 
652
        if revision is not None:
 
653
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
 
654
        if revision_info_list is not None:
 
655
            for rev_str in revision_info_list:
 
656
                rev_spec = RevisionSpec.from_string(rev_str)
 
657
                revision_ids.append(rev_spec.as_revision_id(b))
 
658
        # No arguments supplied, default to the last revision
 
659
        if len(revision_ids) == 0:
 
660
            if tree:
 
661
                if wt is None:
 
662
                    raise errors.NoWorkingTree(directory)
 
663
                revision_ids.append(wt.last_revision())
 
664
            else:
 
665
                revision_ids.append(b.last_revision())
 
666
 
 
667
        revinfos = []
 
668
        maxlen = 0
 
669
        for revision_id in revision_ids:
 
670
            try:
 
671
                dotted_revno = b.revision_id_to_dotted_revno(revision_id)
 
672
                revno = '.'.join(str(i) for i in dotted_revno)
 
673
            except errors.NoSuchRevision:
 
674
                revno = '???'
 
675
            maxlen = max(maxlen, len(revno))
 
676
            revinfos.append((revno, revision_id))
 
677
 
 
678
        self.cleanup_now()
 
679
        for revno, revid in revinfos:
 
680
            self.outf.write(
 
681
                '%*s %s\n' % (maxlen, revno, revid.decode('utf-8')))
 
682
 
 
683
 
 
684
class cmd_add(Command):
 
685
    __doc__ = """Add specified files or directories.
 
686
 
 
687
    In non-recursive mode, all the named items are added, regardless
 
688
    of whether they were previously ignored.  A warning is given if
 
689
    any of the named files are already versioned.
 
690
 
 
691
    In recursive mode (the default), files are treated the same way
 
692
    but the behaviour for directories is different.  Directories that
 
693
    are already versioned do not give a warning.  All directories,
 
694
    whether already versioned or not, are searched for files or
 
695
    subdirectories that are neither versioned or ignored, and these
 
696
    are added.  This search proceeds recursively into versioned
 
697
    directories.  If no names are given '.' is assumed.
 
698
 
 
699
    A warning will be printed when nested trees are encountered,
 
700
    unless they are explicitly ignored.
 
701
 
 
702
    Therefore simply saying 'brz add' will version all files that
 
703
    are currently unknown.
 
704
 
 
705
    Adding a file whose parent directory is not versioned will
 
706
    implicitly add the parent, and so on up to the root. This means
 
707
    you should never need to explicitly add a directory, they'll just
 
708
    get added when you add a file in the directory.
 
709
 
 
710
    --dry-run will show which files would be added, but not actually
 
711
    add them.
 
712
 
 
713
    --file-ids-from will try to use the file ids from the supplied path.
 
714
    It looks up ids trying to find a matching parent directory with the
 
715
    same filename, and then by pure path. This option is rarely needed
 
716
    but can be useful when adding the same logical file into two
 
717
    branches that will be merged later (without showing the two different
 
718
    adds as a conflict). It is also useful when merging another project
 
719
    into a subdirectory of this one.
 
720
 
 
721
    Any files matching patterns in the ignore list will not be added
 
722
    unless they are explicitly mentioned.
 
723
 
 
724
    In recursive mode, files larger than the configuration option
 
725
    add.maximum_file_size will be skipped. Named items are never skipped due
 
726
    to file size.
 
727
    """
 
728
    takes_args = ['file*']
 
729
    takes_options = [
 
730
        Option('no-recurse',
 
731
               help="Don't recursively add the contents of directories.",
 
732
               short_name='N'),
 
733
        Option('dry-run',
 
734
               help="Show what would be done, but don't actually do "
 
735
                    "anything."),
 
736
        'verbose',
 
737
        Option('file-ids-from',
 
738
               type=str,
 
739
               help='Lookup file ids from this tree.'),
 
740
        ]
 
741
    encoding_type = 'replace'
 
742
    _see_also = ['remove', 'ignore']
 
743
 
 
744
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
 
745
            file_ids_from=None):
 
746
        import breezy.add
 
747
        tree, file_list = tree_files_for_add(file_list)
 
748
 
 
749
        if file_ids_from is not None and not tree.supports_setting_file_ids():
 
750
            warning(
 
751
                gettext('Ignoring --file-ids-from, since the tree does not '
 
752
                        'support setting file ids.'))
 
753
            file_ids_from = None
 
754
 
 
755
        base_tree = None
 
756
        if file_ids_from is not None:
 
757
            try:
 
758
                base_tree, base_path = WorkingTree.open_containing(
 
759
                    file_ids_from)
 
760
            except errors.NoWorkingTree:
 
761
                base_branch, base_path = Branch.open_containing(
 
762
                    file_ids_from)
 
763
                base_tree = base_branch.basis_tree()
 
764
 
 
765
            action = breezy.add.AddFromBaseAction(
 
766
                base_tree, base_path, to_file=self.outf,
 
767
                should_print=(not is_quiet()))
 
768
        else:
 
769
            action = breezy.add.AddWithSkipLargeAction(
 
770
                to_file=self.outf, should_print=(not is_quiet()))
 
771
 
 
772
        if base_tree:
 
773
            self.enter_context(base_tree.lock_read())
 
774
        added, ignored = tree.smart_add(
 
775
            file_list, not no_recurse, action=action, save=not dry_run)
 
776
        self.cleanup_now()
 
777
        if len(ignored) > 0:
 
778
            if verbose:
 
779
                for glob in sorted(ignored):
 
780
                    for path in ignored[glob]:
 
781
                        self.outf.write(
 
782
                            gettext("ignored {0} matching \"{1}\"\n").format(
 
783
                                path, glob))
 
784
 
 
785
 
 
786
class cmd_mkdir(Command):
 
787
    __doc__ = """Create a new versioned directory.
 
788
 
 
789
    This is equivalent to creating the directory and then adding it.
 
790
    """
 
791
 
 
792
    takes_args = ['dir+']
 
793
    takes_options = [
 
794
        Option(
 
795
            'parents',
 
796
            help='No error if existing, make parent directories as needed.',
 
797
            short_name='p'
 
798
            )
 
799
        ]
 
800
    encoding_type = 'replace'
 
801
 
 
802
    @classmethod
 
803
    def add_file_with_parents(cls, wt, relpath):
 
804
        if wt.is_versioned(relpath):
 
805
            return
 
806
        cls.add_file_with_parents(wt, osutils.dirname(relpath))
 
807
        wt.add([relpath])
 
808
 
 
809
    @classmethod
 
810
    def add_file_single(cls, wt, relpath):
 
811
        wt.add([relpath])
 
812
 
 
813
    def run(self, dir_list, parents=False):
 
814
        if parents:
 
815
            add_file = self.add_file_with_parents
 
816
        else:
 
817
            add_file = self.add_file_single
 
818
        for dir in dir_list:
 
819
            wt, relpath = WorkingTree.open_containing(dir)
 
820
            if parents:
 
821
                try:
 
822
                    os.makedirs(dir)
 
823
                except OSError as e:
 
824
                    if e.errno != errno.EEXIST:
 
825
                        raise
 
826
            else:
 
827
                os.mkdir(dir)
 
828
            add_file(wt, relpath)
 
829
            if not is_quiet():
 
830
                self.outf.write(gettext('added %s\n') % dir)
 
831
 
 
832
 
 
833
class cmd_relpath(Command):
 
834
    __doc__ = """Show path of a file relative to root"""
 
835
 
 
836
    takes_args = ['filename']
 
837
    hidden = True
 
838
 
 
839
    @display_command
 
840
    def run(self, filename):
 
841
        # TODO: jam 20050106 Can relpath return a munged path if
 
842
        #       sys.stdout encoding cannot represent it?
 
843
        tree, relpath = WorkingTree.open_containing(filename)
 
844
        self.outf.write(relpath)
 
845
        self.outf.write('\n')
 
846
 
 
847
 
 
848
class cmd_inventory(Command):
 
849
    __doc__ = """Show inventory of the current working copy or a revision.
 
850
 
 
851
    It is possible to limit the output to a particular entry
 
852
    type using the --kind option.  For example: --kind file.
 
853
 
 
854
    It is also possible to restrict the list of files to a specific
 
855
    set. For example: brz inventory --show-ids this/file
 
856
    """
 
857
 
 
858
    hidden = True
 
859
    _see_also = ['ls']
 
860
    takes_options = [
 
861
        'revision',
 
862
        'show-ids',
 
863
        Option('include-root',
 
864
               help='Include the entry for the root of the tree, if any.'),
 
865
        Option('kind',
 
866
               help='List entries of a particular kind: file, directory, '
 
867
                    'symlink.',
 
868
               type=str),
 
869
        ]
 
870
    takes_args = ['file*']
 
871
 
 
872
    @display_command
 
873
    def run(self, revision=None, show_ids=False, kind=None, include_root=False,
 
874
            file_list=None):
 
875
        if kind and kind not in ['file', 'directory', 'symlink']:
 
876
            raise errors.BzrCommandError(
 
877
                gettext('invalid kind %r specified') % (kind,))
 
878
 
 
879
        revision = _get_one_revision('inventory', revision)
 
880
        work_tree, file_list = WorkingTree.open_containing_paths(file_list)
 
881
        self.enter_context(work_tree.lock_read())
 
882
        if revision is not None:
 
883
            tree = revision.as_tree(work_tree.branch)
 
884
 
 
885
            extra_trees = [work_tree]
 
886
            self.enter_context(tree.lock_read())
 
887
        else:
 
888
            tree = work_tree
 
889
            extra_trees = []
 
890
 
 
891
        self.enter_context(tree.lock_read())
 
892
        if file_list is not None:
 
893
            paths = tree.find_related_paths_across_trees(
 
894
                file_list, extra_trees, require_versioned=True)
 
895
            # find_ids_across_trees may include some paths that don't
 
896
            # exist in 'tree'.
 
897
            entries = tree.iter_entries_by_dir(specific_files=paths)
 
898
        else:
 
899
            entries = tree.iter_entries_by_dir()
 
900
 
 
901
        for path, entry in sorted(entries):
 
902
            if kind and kind != entry.kind:
 
903
                continue
 
904
            if path == "" and not include_root:
 
905
                continue
 
906
            if show_ids:
 
907
                self.outf.write('%-50s %s\n' % (
 
908
                    path, entry.file_id.decode('utf-8')))
 
909
            else:
 
910
                self.outf.write(path)
 
911
                self.outf.write('\n')
 
912
 
 
913
 
 
914
class cmd_cp(Command):
 
915
    __doc__ = """Copy a file.
 
916
 
 
917
    :Usage:
 
918
        brz cp OLDNAME NEWNAME
 
919
 
 
920
        brz cp SOURCE... DESTINATION
 
921
 
 
922
    If the last argument is a versioned directory, all the other names
 
923
    are copied into it.  Otherwise, there must be exactly two arguments
 
924
    and the file is copied to a new name.
 
925
 
 
926
    Files cannot be copied between branches. Only files can be copied
 
927
    at the moment.
 
928
    """
 
929
 
 
930
    takes_args = ['names*']
 
931
    takes_options = []
 
932
    aliases = ['copy']
 
933
    encoding_type = 'replace'
 
934
 
 
935
    def run(self, names_list):
 
936
        if names_list is None:
 
937
            names_list = []
 
938
        if len(names_list) < 2:
 
939
            raise errors.BzrCommandError(gettext("missing file argument"))
 
940
        tree, rel_names = WorkingTree.open_containing_paths(
 
941
            names_list, canonicalize=False)
 
942
        for file_name in rel_names[0:-1]:
 
943
            if file_name == '':
 
944
                raise errors.BzrCommandError(
 
945
                    gettext("can not copy root of branch"))
 
946
        self.enter_context(tree.lock_tree_write())
 
947
        into_existing = osutils.isdir(names_list[-1])
 
948
        if not into_existing:
 
949
            try:
 
950
                (src, dst) = rel_names
 
951
            except IndexError:
 
952
                raise errors.BzrCommandError(
 
953
                    gettext('to copy multiple files the'
 
954
                            ' destination must be a versioned'
 
955
                            ' directory'))
 
956
            pairs = [(src, dst)]
 
957
        else:
 
958
            pairs = [
 
959
                (n, osutils.joinpath([rel_names[-1], osutils.basename(n)]))
 
960
                for n in rel_names[:-1]]
 
961
 
 
962
        for src, dst in pairs:
 
963
            try:
 
964
                src_kind = tree.stored_kind(src)
 
965
            except errors.NoSuchFile:
 
966
                raise errors.BzrCommandError(
 
967
                    gettext('Could not copy %s => %s: %s is not versioned.')
 
968
                    % (src, dst, src))
 
969
            if src_kind is None:
 
970
                raise errors.BzrCommandError(
 
971
                    gettext('Could not copy %s => %s . %s is not versioned\\.'
 
972
                            % (src, dst, src)))
 
973
            if src_kind == 'directory':
 
974
                raise errors.BzrCommandError(
 
975
                    gettext('Could not copy %s => %s . %s is a directory.'
 
976
                            % (src, dst, src)))
 
977
            dst_parent = osutils.split(dst)[0]
 
978
            if dst_parent != '':
 
979
                try:
 
980
                    dst_parent_kind = tree.stored_kind(dst_parent)
 
981
                except errors.NoSuchFile:
 
982
                    raise errors.BzrCommandError(
 
983
                        gettext('Could not copy %s => %s: %s is not versioned.')
 
984
                        % (src, dst, dst_parent))
 
985
                if dst_parent_kind != 'directory':
 
986
                    raise errors.BzrCommandError(
 
987
                        gettext('Could not copy to %s: %s is not a directory.')
 
988
                        % (dst_parent, dst_parent))
 
989
 
 
990
            tree.copy_one(src, dst)
 
991
 
 
992
 
 
993
class cmd_mv(Command):
 
994
    __doc__ = """Move or rename a file.
 
995
 
 
996
    :Usage:
 
997
        brz mv OLDNAME NEWNAME
 
998
 
 
999
        brz mv SOURCE... DESTINATION
 
1000
 
 
1001
    If the last argument is a versioned directory, all the other names
 
1002
    are moved into it.  Otherwise, there must be exactly two arguments
 
1003
    and the file is changed to a new name.
 
1004
 
 
1005
    If OLDNAME does not exist on the filesystem but is versioned and
 
1006
    NEWNAME does exist on the filesystem but is not versioned, mv
 
1007
    assumes that the file has been manually moved and only updates
 
1008
    its internal inventory to reflect that change.
 
1009
    The same is valid when moving many SOURCE files to a DESTINATION.
 
1010
 
 
1011
    Files cannot be moved between branches.
 
1012
    """
 
1013
 
 
1014
    takes_args = ['names*']
 
1015
    takes_options = [Option("after", help="Move only the brz identifier"
 
1016
                            " of the file, because the file has already been moved."),
 
1017
                     Option('auto', help='Automatically guess renames.'),
 
1018
                     Option(
 
1019
                         'dry-run', help='Avoid making changes when guessing renames.'),
 
1020
                     ]
 
1021
    aliases = ['move', 'rename']
 
1022
    encoding_type = 'replace'
 
1023
 
 
1024
    def run(self, names_list, after=False, auto=False, dry_run=False):
 
1025
        if auto:
 
1026
            return self.run_auto(names_list, after, dry_run)
 
1027
        elif dry_run:
 
1028
            raise errors.BzrCommandError(gettext('--dry-run requires --auto.'))
 
1029
        if names_list is None:
 
1030
            names_list = []
 
1031
        if len(names_list) < 2:
 
1032
            raise errors.BzrCommandError(gettext("missing file argument"))
 
1033
        tree, rel_names = WorkingTree.open_containing_paths(
 
1034
            names_list, canonicalize=False)
 
1035
        for file_name in rel_names[0:-1]:
 
1036
            if file_name == '':
 
1037
                raise errors.BzrCommandError(
 
1038
                    gettext("can not move root of branch"))
 
1039
        self.enter_context(tree.lock_tree_write())
 
1040
        self._run(tree, names_list, rel_names, after)
 
1041
 
 
1042
    def run_auto(self, names_list, after, dry_run):
 
1043
        if names_list is not None and len(names_list) > 1:
 
1044
            raise errors.BzrCommandError(
 
1045
                gettext('Only one path may be specified to --auto.'))
 
1046
        if after:
 
1047
            raise errors.BzrCommandError(
 
1048
                gettext('--after cannot be specified with --auto.'))
 
1049
        work_tree, file_list = WorkingTree.open_containing_paths(
 
1050
            names_list, default_directory='.')
 
1051
        self.enter_context(work_tree.lock_tree_write())
 
1052
        rename_map.RenameMap.guess_renames(
 
1053
            work_tree.basis_tree(), work_tree, dry_run)
 
1054
 
 
1055
    def _run(self, tree, names_list, rel_names, after):
 
1056
        into_existing = osutils.isdir(names_list[-1])
 
1057
        if into_existing and len(names_list) == 2:
 
1058
            # special cases:
 
1059
            # a. case-insensitive filesystem and change case of dir
 
1060
            # b. move directory after the fact (if the source used to be
 
1061
            #    a directory, but now doesn't exist in the working tree
 
1062
            #    and the target is an existing directory, just rename it)
 
1063
            if (not tree.case_sensitive
 
1064
                    and rel_names[0].lower() == rel_names[1].lower()):
 
1065
                into_existing = False
 
1066
            else:
 
1067
                # 'fix' the case of a potential 'from'
 
1068
                from_path = tree.get_canonical_path(rel_names[0])
 
1069
                if (not osutils.lexists(names_list[0]) and
 
1070
                    tree.is_versioned(from_path) and
 
1071
                        tree.stored_kind(from_path) == "directory"):
 
1072
                    into_existing = False
 
1073
        # move/rename
 
1074
        if into_existing:
 
1075
            # move into existing directory
 
1076
            # All entries reference existing inventory items, so fix them up
 
1077
            # for cicp file-systems.
 
1078
            rel_names = list(tree.get_canonical_paths(rel_names))
 
1079
            for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
 
1080
                if not is_quiet():
 
1081
                    self.outf.write("%s => %s\n" % (src, dest))
 
1082
        else:
 
1083
            if len(names_list) != 2:
 
1084
                raise errors.BzrCommandError(gettext('to mv multiple files the'
 
1085
                                                     ' destination must be a versioned'
 
1086
                                                     ' directory'))
 
1087
 
 
1088
            # for cicp file-systems: the src references an existing inventory
 
1089
            # item:
 
1090
            src = tree.get_canonical_path(rel_names[0])
 
1091
            # Find the canonical version of the destination:  In all cases, the
 
1092
            # parent of the target must be in the inventory, so we fetch the
 
1093
            # canonical version from there (we do not always *use* the
 
1094
            # canonicalized tail portion - we may be attempting to rename the
 
1095
            # case of the tail)
 
1096
            canon_dest = tree.get_canonical_path(rel_names[1])
 
1097
            dest_parent = osutils.dirname(canon_dest)
 
1098
            spec_tail = osutils.basename(rel_names[1])
 
1099
            # For a CICP file-system, we need to avoid creating 2 inventory
 
1100
            # entries that differ only by case.  So regardless of the case
 
1101
            # we *want* to use (ie, specified by the user or the file-system),
 
1102
            # we must always choose to use the case of any existing inventory
 
1103
            # items.  The only exception to this is when we are attempting a
 
1104
            # case-only rename (ie, canonical versions of src and dest are
 
1105
            # the same)
 
1106
            dest_id = tree.path2id(canon_dest)
 
1107
            if dest_id is None or tree.path2id(src) == dest_id:
 
1108
                # No existing item we care about, so work out what case we
 
1109
                # are actually going to use.
 
1110
                if after:
 
1111
                    # If 'after' is specified, the tail must refer to a file on disk.
 
1112
                    if dest_parent:
 
1113
                        dest_parent_fq = osutils.pathjoin(
 
1114
                            tree.basedir, dest_parent)
 
1115
                    else:
 
1116
                        # pathjoin with an empty tail adds a slash, which breaks
 
1117
                        # relpath :(
 
1118
                        dest_parent_fq = tree.basedir
 
1119
 
 
1120
                    dest_tail = osutils.canonical_relpath(
 
1121
                        dest_parent_fq,
 
1122
                        osutils.pathjoin(dest_parent_fq, spec_tail))
 
1123
                else:
 
1124
                    # not 'after', so case as specified is used
 
1125
                    dest_tail = spec_tail
 
1126
            else:
 
1127
                # Use the existing item so 'mv' fails with AlreadyVersioned.
 
1128
                dest_tail = os.path.basename(canon_dest)
 
1129
            dest = osutils.pathjoin(dest_parent, dest_tail)
 
1130
            mutter("attempting to move %s => %s", src, dest)
 
1131
            tree.rename_one(src, dest, after=after)
 
1132
            if not is_quiet():
 
1133
                self.outf.write("%s => %s\n" % (src, dest))
 
1134
 
 
1135
 
 
1136
class cmd_pull(Command):
 
1137
    __doc__ = """Turn this branch into a mirror of another branch.
 
1138
 
 
1139
    By default, this command only works on branches that have not diverged.
 
1140
    Branches are considered diverged if the destination branch's most recent
 
1141
    commit is one that has not been merged (directly or indirectly) into the
 
1142
    parent.
 
1143
 
 
1144
    If branches have diverged, you can use 'brz merge' to integrate the changes
 
1145
    from one into the other.  Once one branch has merged, the other should
 
1146
    be able to pull it again.
 
1147
 
 
1148
    If you want to replace your local changes and just want your branch to
 
1149
    match the remote one, use pull --overwrite. This will work even if the two
 
1150
    branches have diverged.
 
1151
 
 
1152
    If there is no default location set, the first pull will set it (use
 
1153
    --no-remember to avoid setting it). After that, you can omit the
 
1154
    location to use the default.  To change the default, use --remember. The
 
1155
    value will only be saved if the remote location can be accessed.
 
1156
 
 
1157
    The --verbose option will display the revisions pulled using the log_format
 
1158
    configuration option. You can use a different format by overriding it with
 
1159
    -Olog_format=<other_format>.
 
1160
 
 
1161
    Note: The location can be specified either in the form of a branch,
 
1162
    or in the form of a path to a file containing a merge directive generated
 
1163
    with brz send.
 
1164
    """
 
1165
 
 
1166
    _see_also = ['push', 'update', 'status-flags', 'send']
 
1167
    takes_options = ['remember', 'overwrite', 'revision',
 
1168
                     custom_help('verbose',
 
1169
                                 help='Show logs of pulled revisions.'),
 
1170
                     custom_help('directory',
 
1171
                                 help='Branch to pull into, '
 
1172
                                 'rather than the one containing the working directory.'),
 
1173
                     Option('local',
 
1174
                            help="Perform a local pull in a bound "
 
1175
                            "branch.  Local pulls are not applied to "
 
1176
                            "the master branch."
 
1177
                            ),
 
1178
                     Option('show-base',
 
1179
                            help="Show base revision text in conflicts."),
 
1180
                     Option('overwrite-tags',
 
1181
                            help="Overwrite tags only."),
 
1182
                     ]
 
1183
    takes_args = ['location?']
 
1184
    encoding_type = 'replace'
 
1185
 
 
1186
    def run(self, location=None, remember=None, overwrite=False,
 
1187
            revision=None, verbose=False,
 
1188
            directory=None, local=False,
 
1189
            show_base=False, overwrite_tags=False):
 
1190
 
 
1191
        if overwrite:
 
1192
            overwrite = ["history", "tags"]
 
1193
        elif overwrite_tags:
 
1194
            overwrite = ["tags"]
 
1195
        else:
 
1196
            overwrite = []
 
1197
        # FIXME: too much stuff is in the command class
 
1198
        revision_id = None
 
1199
        mergeable = None
 
1200
        if directory is None:
 
1201
            directory = u'.'
 
1202
        try:
 
1203
            tree_to = WorkingTree.open_containing(directory)[0]
 
1204
            branch_to = tree_to.branch
 
1205
            self.enter_context(tree_to.lock_write())
 
1206
        except errors.NoWorkingTree:
 
1207
            tree_to = None
 
1208
            branch_to = Branch.open_containing(directory)[0]
 
1209
            self.enter_context(branch_to.lock_write())
 
1210
            if show_base:
 
1211
                warning(gettext("No working tree, ignoring --show-base"))
 
1212
 
 
1213
        if local and not branch_to.get_bound_location():
 
1214
            raise errors.LocalRequiresBoundBranch()
 
1215
 
 
1216
        possible_transports = []
 
1217
        if location is not None:
 
1218
            try:
 
1219
                mergeable = _mod_mergeable.read_mergeable_from_url(
 
1220
                    location, possible_transports=possible_transports)
 
1221
            except errors.NotABundle:
 
1222
                mergeable = None
 
1223
 
 
1224
        stored_loc = branch_to.get_parent()
 
1225
        if location is None:
 
1226
            if stored_loc is None:
 
1227
                raise errors.BzrCommandError(gettext("No pull location known or"
 
1228
                                                     " specified."))
 
1229
            else:
 
1230
                display_url = urlutils.unescape_for_display(stored_loc,
 
1231
                                                            self.outf.encoding)
 
1232
                if not is_quiet():
 
1233
                    self.outf.write(
 
1234
                        gettext("Using saved parent location: %s\n") % display_url)
 
1235
                location = stored_loc
 
1236
 
 
1237
        revision = _get_one_revision('pull', revision)
 
1238
        if mergeable is not None:
 
1239
            if revision is not None:
 
1240
                raise errors.BzrCommandError(gettext(
 
1241
                    'Cannot use -r with merge directives or bundles'))
 
1242
            mergeable.install_revisions(branch_to.repository)
 
1243
            base_revision_id, revision_id, verified = \
 
1244
                mergeable.get_merge_request(branch_to.repository)
 
1245
            branch_from = branch_to
 
1246
        else:
 
1247
            branch_from = Branch.open(location,
 
1248
                                      possible_transports=possible_transports)
 
1249
            self.enter_context(branch_from.lock_read())
 
1250
            # Remembers if asked explicitly or no previous location is set
 
1251
            if (remember
 
1252
                    or (remember is None and branch_to.get_parent() is None)):
 
1253
                # FIXME: This shouldn't be done before the pull
 
1254
                # succeeds... -- vila 2012-01-02
 
1255
                branch_to.set_parent(branch_from.base)
 
1256
 
 
1257
        if revision is not None:
 
1258
            revision_id = revision.as_revision_id(branch_from)
 
1259
 
 
1260
        if tree_to is not None:
 
1261
            view_info = _get_view_info_for_change_reporter(tree_to)
 
1262
            change_reporter = delta._ChangeReporter(
 
1263
                unversioned_filter=tree_to.is_ignored,
 
1264
                view_info=view_info)
 
1265
            result = tree_to.pull(
 
1266
                branch_from, overwrite, revision_id, change_reporter,
 
1267
                local=local, show_base=show_base)
 
1268
        else:
 
1269
            result = branch_to.pull(
 
1270
                branch_from, overwrite, revision_id, local=local)
 
1271
 
 
1272
        result.report(self.outf)
 
1273
        if verbose and result.old_revid != result.new_revid:
 
1274
            log.show_branch_change(
 
1275
                branch_to, self.outf, result.old_revno,
 
1276
                result.old_revid)
 
1277
        if getattr(result, 'tag_conflicts', None):
 
1278
            return 1
 
1279
        else:
 
1280
            return 0
 
1281
 
 
1282
 
 
1283
class cmd_push(Command):
 
1284
    __doc__ = """Update a mirror of this branch.
 
1285
 
 
1286
    The target branch will not have its working tree populated because this
 
1287
    is both expensive, and is not supported on remote file systems.
 
1288
 
 
1289
    Some smart servers or protocols *may* put the working tree in place in
 
1290
    the future.
 
1291
 
 
1292
    This command only works on branches that have not diverged.  Branches are
 
1293
    considered diverged if the destination branch's most recent commit is one
 
1294
    that has not been merged (directly or indirectly) by the source branch.
 
1295
 
 
1296
    If branches have diverged, you can use 'brz push --overwrite' to replace
 
1297
    the other branch completely, discarding its unmerged changes.
 
1298
 
 
1299
    If you want to ensure you have the different changes in the other branch,
 
1300
    do a merge (see brz help merge) from the other branch, and commit that.
 
1301
    After that you will be able to do a push without '--overwrite'.
 
1302
 
 
1303
    If there is no default push location set, the first push will set it (use
 
1304
    --no-remember to avoid setting it).  After that, you can omit the
 
1305
    location to use the default.  To change the default, use --remember. The
 
1306
    value will only be saved if the remote location can be accessed.
 
1307
 
 
1308
    The --verbose option will display the revisions pushed using the log_format
 
1309
    configuration option. You can use a different format by overriding it with
 
1310
    -Olog_format=<other_format>.
 
1311
    """
 
1312
 
 
1313
    _see_also = ['pull', 'update', 'working-trees']
 
1314
    takes_options = ['remember', 'overwrite', 'verbose', 'revision',
 
1315
                     Option('create-prefix',
 
1316
                            help='Create the path leading up to the branch '
 
1317
                            'if it does not already exist.'),
 
1318
                     custom_help('directory',
 
1319
                                 help='Branch to push from, '
 
1320
                                 'rather than the one containing the working directory.'),
 
1321
                     Option('use-existing-dir',
 
1322
                            help='By default push will fail if the target'
 
1323
                            ' directory exists, but does not already'
 
1324
                            ' have a control directory.  This flag will'
 
1325
                            ' allow push to proceed.'),
 
1326
                     Option('stacked',
 
1327
                            help='Create a stacked branch that references the public location '
 
1328
                            'of the parent branch.'),
 
1329
                     Option('stacked-on',
 
1330
                            help='Create a stacked branch that refers to another branch '
 
1331
                            'for the commit history. Only the work not present in the '
 
1332
                            'referenced branch is included in the branch created.',
 
1333
                            type=str),
 
1334
                     Option('strict',
 
1335
                            help='Refuse to push if there are uncommitted changes in'
 
1336
                            ' the working tree, --no-strict disables the check.'),
 
1337
                     Option('no-tree',
 
1338
                            help="Don't populate the working tree, even for protocols"
 
1339
                            " that support it."),
 
1340
                     Option('overwrite-tags',
 
1341
                            help="Overwrite tags only."),
 
1342
                     Option('lossy', help="Allow lossy push, i.e. dropping metadata "
 
1343
                            "that can't be represented in the target.")
 
1344
                     ]
 
1345
    takes_args = ['location?']
 
1346
    encoding_type = 'replace'
 
1347
 
 
1348
    def run(self, location=None, remember=None, overwrite=False,
 
1349
            create_prefix=False, verbose=False, revision=None,
 
1350
            use_existing_dir=False, directory=None, stacked_on=None,
 
1351
            stacked=False, strict=None, no_tree=False,
 
1352
            overwrite_tags=False, lossy=False):
 
1353
        from .location import location_to_url
 
1354
        from .push import _show_push_branch
 
1355
 
 
1356
        if overwrite:
 
1357
            overwrite = ["history", "tags"]
 
1358
        elif overwrite_tags:
 
1359
            overwrite = ["tags"]
 
1360
        else:
 
1361
            overwrite = []
 
1362
 
 
1363
        if directory is None:
 
1364
            directory = '.'
 
1365
        # Get the source branch
 
1366
        (tree, br_from,
 
1367
         _unused) = controldir.ControlDir.open_containing_tree_or_branch(directory)
 
1368
        # Get the tip's revision_id
 
1369
        revision = _get_one_revision('push', revision)
 
1370
        if revision is not None:
 
1371
            revision_id = revision.in_history(br_from).rev_id
 
1372
        else:
 
1373
            revision_id = None
 
1374
        if tree is not None and revision_id is None:
 
1375
            tree.check_changed_or_out_of_date(
 
1376
                strict, 'push_strict',
 
1377
                more_error='Use --no-strict to force the push.',
 
1378
                more_warning='Uncommitted changes will not be pushed.')
 
1379
        # Get the stacked_on branch, if any
 
1380
        if stacked_on is not None:
 
1381
            stacked_on = location_to_url(stacked_on, 'read')
 
1382
            stacked_on = urlutils.normalize_url(stacked_on)
 
1383
        elif stacked:
 
1384
            parent_url = br_from.get_parent()
 
1385
            if parent_url:
 
1386
                parent = Branch.open(parent_url)
 
1387
                stacked_on = parent.get_public_branch()
 
1388
                if not stacked_on:
 
1389
                    # I considered excluding non-http url's here, thus forcing
 
1390
                    # 'public' branches only, but that only works for some
 
1391
                    # users, so it's best to just depend on the user spotting an
 
1392
                    # error by the feedback given to them. RBC 20080227.
 
1393
                    stacked_on = parent_url
 
1394
            if not stacked_on:
 
1395
                raise errors.BzrCommandError(gettext(
 
1396
                    "Could not determine branch to refer to."))
 
1397
 
 
1398
        # Get the destination location
 
1399
        if location is None:
 
1400
            stored_loc = br_from.get_push_location()
 
1401
            if stored_loc is None:
 
1402
                parent_loc = br_from.get_parent()
 
1403
                if parent_loc:
 
1404
                    raise errors.BzrCommandError(gettext(
 
1405
                        "No push location known or specified. To push to the "
 
1406
                        "parent branch (at %s), use 'brz push :parent'." %
 
1407
                        urlutils.unescape_for_display(parent_loc,
 
1408
                                                      self.outf.encoding)))
 
1409
                else:
 
1410
                    raise errors.BzrCommandError(gettext(
 
1411
                        "No push location known or specified."))
 
1412
            else:
 
1413
                display_url = urlutils.unescape_for_display(stored_loc,
 
1414
                                                            self.outf.encoding)
 
1415
                note(gettext("Using saved push location: %s") % display_url)
 
1416
                location = stored_loc
 
1417
 
 
1418
        _show_push_branch(br_from, revision_id, location, self.outf,
 
1419
                          verbose=verbose, overwrite=overwrite, remember=remember,
 
1420
                          stacked_on=stacked_on, create_prefix=create_prefix,
 
1421
                          use_existing_dir=use_existing_dir, no_tree=no_tree,
 
1422
                          lossy=lossy)
 
1423
 
 
1424
 
 
1425
class cmd_branch(Command):
 
1426
    __doc__ = """Create a new branch that is a copy of an existing branch.
 
1427
 
 
1428
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
 
1429
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
 
1430
    If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
 
1431
    is derived from the FROM_LOCATION by stripping a leading scheme or drive
 
1432
    identifier, if any. For example, "branch lp:foo-bar" will attempt to
 
1433
    create ./foo-bar.
 
1434
 
 
1435
    To retrieve the branch as of a particular revision, supply the --revision
 
1436
    parameter, as in "branch foo/bar -r 5".
 
1437
    """
 
1438
 
 
1439
    _see_also = ['checkout']
 
1440
    takes_args = ['from_location', 'to_location?']
 
1441
    takes_options = ['revision',
 
1442
                     Option(
 
1443
                         'hardlink', help='Hard-link working tree files where possible.'),
 
1444
                     Option('files-from', type=str,
 
1445
                            help="Get file contents from this tree."),
 
1446
                     Option('no-tree',
 
1447
                            help="Create a branch without a working-tree."),
 
1448
                     Option('switch',
 
1449
                            help="Switch the checkout in the current directory "
 
1450
                            "to the new branch."),
 
1451
                     Option('stacked',
 
1452
                            help='Create a stacked branch referring to the source branch. '
 
1453
                            'The new branch will depend on the availability of the source '
 
1454
                            'branch for all operations.'),
 
1455
                     Option('standalone',
 
1456
                            help='Do not use a shared repository, even if available.'),
 
1457
                     Option('use-existing-dir',
 
1458
                            help='By default branch will fail if the target'
 
1459
                            ' directory exists, but does not already'
 
1460
                            ' have a control directory.  This flag will'
 
1461
                            ' allow branch to proceed.'),
 
1462
                     Option('bind',
 
1463
                            help="Bind new branch to from location."),
 
1464
                     Option('no-recurse-nested',
 
1465
                            help='Do not recursively check out nested trees.'),
 
1466
                     ]
 
1467
 
 
1468
    def run(self, from_location, to_location=None, revision=None,
 
1469
            hardlink=False, stacked=False, standalone=False, no_tree=False,
 
1470
            use_existing_dir=False, switch=False, bind=False,
 
1471
            files_from=None, no_recurse_nested=False):
 
1472
        from breezy import switch as _mod_switch
 
1473
        accelerator_tree, br_from = controldir.ControlDir.open_tree_or_branch(
 
1474
            from_location)
 
1475
        if no_recurse_nested:
 
1476
            recurse = 'none'
 
1477
        else:
 
1478
            recurse = 'down'
 
1479
        if not (hardlink or files_from):
 
1480
            # accelerator_tree is usually slower because you have to read N
 
1481
            # files (no readahead, lots of seeks, etc), but allow the user to
 
1482
            # explicitly request it
 
1483
            accelerator_tree = None
 
1484
        if files_from is not None and files_from != from_location:
 
1485
            accelerator_tree = WorkingTree.open(files_from)
 
1486
        revision = _get_one_revision('branch', revision)
 
1487
        self.enter_context(br_from.lock_read())
 
1488
        if revision is not None:
 
1489
            revision_id = revision.as_revision_id(br_from)
 
1490
        else:
 
1491
            # FIXME - wt.last_revision, fallback to branch, fall back to
 
1492
            # None or perhaps NULL_REVISION to mean copy nothing
 
1493
            # RBC 20060209
 
1494
            revision_id = br_from.last_revision()
 
1495
        if to_location is None:
 
1496
            to_location = urlutils.derive_to_location(from_location)
 
1497
        to_transport = transport.get_transport(to_location, purpose='write')
 
1498
        try:
 
1499
            to_transport.mkdir('.')
 
1500
        except errors.FileExists:
 
1501
            try:
 
1502
                to_dir = controldir.ControlDir.open_from_transport(
 
1503
                    to_transport)
 
1504
            except errors.NotBranchError:
 
1505
                if not use_existing_dir:
 
1506
                    raise errors.BzrCommandError(gettext('Target directory "%s" '
 
1507
                                                         'already exists.') % to_location)
 
1508
                else:
 
1509
                    to_dir = None
 
1510
            else:
 
1511
                try:
 
1512
                    to_dir.open_branch()
 
1513
                except errors.NotBranchError:
 
1514
                    pass
 
1515
                else:
 
1516
                    raise errors.AlreadyBranchError(to_location)
 
1517
        except errors.NoSuchFile:
 
1518
            raise errors.BzrCommandError(gettext('Parent of "%s" does not exist.')
 
1519
                                         % to_location)
 
1520
        else:
 
1521
            to_dir = None
 
1522
        if to_dir is None:
 
1523
            try:
 
1524
                # preserve whatever source format we have.
 
1525
                to_dir = br_from.controldir.sprout(
 
1526
                    to_transport.base, revision_id,
 
1527
                    possible_transports=[to_transport],
 
1528
                    accelerator_tree=accelerator_tree, hardlink=hardlink,
 
1529
                    stacked=stacked, force_new_repo=standalone,
 
1530
                    create_tree_if_local=not no_tree, source_branch=br_from,
 
1531
                    recurse=recurse)
 
1532
                branch = to_dir.open_branch(
 
1533
                    possible_transports=[
 
1534
                        br_from.controldir.root_transport, to_transport])
 
1535
            except errors.NoSuchRevision:
 
1536
                to_transport.delete_tree('.')
 
1537
                msg = gettext("The branch {0} has no revision {1}.").format(
 
1538
                    from_location, revision)
 
1539
                raise errors.BzrCommandError(msg)
 
1540
        else:
 
1541
            try:
 
1542
                to_repo = to_dir.open_repository()
 
1543
            except errors.NoRepositoryPresent:
 
1544
                to_repo = to_dir.create_repository()
 
1545
            to_repo.fetch(br_from.repository, revision_id=revision_id)
 
1546
            branch = br_from.sprout(
 
1547
                to_dir, revision_id=revision_id)
 
1548
        br_from.tags.merge_to(branch.tags)
 
1549
 
 
1550
        # If the source branch is stacked, the new branch may
 
1551
        # be stacked whether we asked for that explicitly or not.
 
1552
        # We therefore need a try/except here and not just 'if stacked:'
 
1553
        try:
 
1554
            note(gettext('Created new stacked branch referring to %s.') %
 
1555
                 branch.get_stacked_on_url())
 
1556
        except (errors.NotStacked, _mod_branch.UnstackableBranchFormat,
 
1557
                errors.UnstackableRepositoryFormat) as e:
 
1558
            revno = branch.revno()
 
1559
            if revno is not None:
 
1560
                note(ngettext('Branched %d revision.',
 
1561
                              'Branched %d revisions.',
 
1562
                              branch.revno()) % revno)
 
1563
            else:
 
1564
                note(gettext('Created new branch.'))
 
1565
        if bind:
 
1566
            # Bind to the parent
 
1567
            parent_branch = Branch.open(from_location)
 
1568
            branch.bind(parent_branch)
 
1569
            note(gettext('New branch bound to %s') % from_location)
 
1570
        if switch:
 
1571
            # Switch to the new branch
 
1572
            wt, _ = WorkingTree.open_containing('.')
 
1573
            _mod_switch.switch(wt.controldir, branch)
 
1574
            note(gettext('Switched to branch: %s'),
 
1575
                 urlutils.unescape_for_display(branch.base, 'utf-8'))
 
1576
 
 
1577
 
 
1578
class cmd_branches(Command):
 
1579
    __doc__ = """List the branches available at the current location.
 
1580
 
 
1581
    This command will print the names of all the branches at the current
 
1582
    location.
 
1583
    """
 
1584
 
 
1585
    takes_args = ['location?']
 
1586
    takes_options = [
 
1587
        Option('recursive', short_name='R',
 
1588
               help='Recursively scan for branches rather than '
 
1589
               'just looking in the specified location.')]
 
1590
 
 
1591
    def run(self, location=".", recursive=False):
 
1592
        if recursive:
 
1593
            t = transport.get_transport(location, purpose='read')
 
1594
            if not t.listable():
 
1595
                raise errors.BzrCommandError(
 
1596
                    "Can't scan this type of location.")
 
1597
            for b in controldir.ControlDir.find_branches(t):
 
1598
                self.outf.write("%s\n" % urlutils.unescape_for_display(
 
1599
                    urlutils.relative_url(t.base, b.base),
 
1600
                    self.outf.encoding).rstrip("/"))
 
1601
        else:
 
1602
            dir = controldir.ControlDir.open_containing(location)[0]
 
1603
            try:
 
1604
                active_branch = dir.open_branch(name="")
 
1605
            except errors.NotBranchError:
 
1606
                active_branch = None
 
1607
            names = {}
 
1608
            for name, branch in iter_sibling_branches(dir):
 
1609
                if name == "":
 
1610
                    continue
 
1611
                active = (active_branch is not None and
 
1612
                          active_branch.user_url == branch.user_url)
 
1613
                names[name] = active
 
1614
            # Only mention the current branch explicitly if it's not
 
1615
            # one of the colocated branches
 
1616
            if not any(names.values()) and active_branch is not None:
 
1617
                self.outf.write("* %s\n" % gettext("(default)"))
 
1618
            for name in sorted(names):
 
1619
                active = names[name]
 
1620
                if active:
 
1621
                    prefix = "*"
 
1622
                else:
 
1623
                    prefix = " "
 
1624
                self.outf.write("%s %s\n" % (prefix, name))
 
1625
 
 
1626
 
 
1627
class cmd_checkout(Command):
 
1628
    __doc__ = """Create a new checkout of an existing branch.
 
1629
 
 
1630
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree
 
1631
    for the branch found in '.'. This is useful if you have removed the working
 
1632
    tree or if it was never created - i.e. if you pushed the branch to its
 
1633
    current location using SFTP.
 
1634
 
 
1635
    If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION
 
1636
    will be used.  In other words, "checkout ../foo/bar" will attempt to create
 
1637
    ./bar.  If the BRANCH_LOCATION has no / or path separator embedded, the
 
1638
    TO_LOCATION is derived from the BRANCH_LOCATION by stripping a leading
 
1639
    scheme or drive identifier, if any. For example, "checkout lp:foo-bar" will
 
1640
    attempt to create ./foo-bar.
 
1641
 
 
1642
    To retrieve the branch as of a particular revision, supply the --revision
 
1643
    parameter, as in "checkout foo/bar -r 5". Note that this will be
 
1644
    immediately out of date [so you cannot commit] but it may be useful (i.e.
 
1645
    to examine old code.)
 
1646
    """
 
1647
 
 
1648
    _see_also = ['checkouts', 'branch', 'working-trees', 'remove-tree']
 
1649
    takes_args = ['branch_location?', 'to_location?']
 
1650
    takes_options = ['revision',
 
1651
                     Option('lightweight',
 
1652
                            help="Perform a lightweight checkout.  Lightweight "
 
1653
                                 "checkouts depend on access to the branch for "
 
1654
                                 "every operation.  Normal checkouts can perform "
 
1655
                                 "common operations like diff and status without "
 
1656
                                 "such access, and also support local commits."
 
1657
                            ),
 
1658
                     Option('files-from', type=str,
 
1659
                            help="Get file contents from this tree."),
 
1660
                     Option('hardlink',
 
1661
                            help='Hard-link working tree files where possible.'
 
1662
                            ),
 
1663
                     ]
 
1664
    aliases = ['co']
 
1665
 
 
1666
    def run(self, branch_location=None, to_location=None, revision=None,
 
1667
            lightweight=False, files_from=None, hardlink=False):
 
1668
        if branch_location is None:
 
1669
            branch_location = osutils.getcwd()
 
1670
            to_location = branch_location
 
1671
        accelerator_tree, source = controldir.ControlDir.open_tree_or_branch(
 
1672
            branch_location)
 
1673
        if not (hardlink or files_from):
 
1674
            # accelerator_tree is usually slower because you have to read N
 
1675
            # files (no readahead, lots of seeks, etc), but allow the user to
 
1676
            # explicitly request it
 
1677
            accelerator_tree = None
 
1678
        revision = _get_one_revision('checkout', revision)
 
1679
        if files_from is not None and files_from != branch_location:
 
1680
            accelerator_tree = WorkingTree.open(files_from)
 
1681
        if revision is not None:
 
1682
            revision_id = revision.as_revision_id(source)
 
1683
        else:
 
1684
            revision_id = None
 
1685
        if to_location is None:
 
1686
            to_location = urlutils.derive_to_location(branch_location)
 
1687
        # if the source and to_location are the same,
 
1688
        # and there is no working tree,
 
1689
        # then reconstitute a branch
 
1690
        if osutils.abspath(to_location) == osutils.abspath(branch_location):
 
1691
            try:
 
1692
                source.controldir.open_workingtree()
 
1693
            except errors.NoWorkingTree:
 
1694
                source.controldir.create_workingtree(revision_id)
 
1695
                return
 
1696
        source.create_checkout(to_location, revision_id, lightweight,
 
1697
                               accelerator_tree, hardlink)
 
1698
 
 
1699
 
 
1700
class cmd_renames(Command):
 
1701
    __doc__ = """Show list of renamed files.
 
1702
    """
 
1703
    # TODO: Option to show renames between two historical versions.
 
1704
 
 
1705
    # TODO: Only show renames under dir, rather than in the whole branch.
 
1706
    _see_also = ['status']
 
1707
    takes_args = ['dir?']
 
1708
 
 
1709
    @display_command
 
1710
    def run(self, dir=u'.'):
 
1711
        tree = WorkingTree.open_containing(dir)[0]
 
1712
        self.enter_context(tree.lock_read())
 
1713
        old_tree = tree.basis_tree()
 
1714
        self.enter_context(old_tree.lock_read())
 
1715
        renames = []
 
1716
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
 
1717
        for change in iterator:
 
1718
            if change.path[0] == change.path[1]:
 
1719
                continue
 
1720
            if None in change.path:
 
1721
                continue
 
1722
            renames.append(change.path)
 
1723
        renames.sort()
 
1724
        for old_name, new_name in renames:
 
1725
            self.outf.write("%s => %s\n" % (old_name, new_name))
 
1726
 
 
1727
 
 
1728
class cmd_update(Command):
 
1729
    __doc__ = """Update a working tree to a new revision.
 
1730
 
 
1731
    This will perform a merge of the destination revision (the tip of the
 
1732
    branch, or the specified revision) into the working tree, and then make
 
1733
    that revision the basis revision for the working tree.
 
1734
 
 
1735
    You can use this to visit an older revision, or to update a working tree
 
1736
    that is out of date from its branch.
 
1737
 
 
1738
    If there are any uncommitted changes in the tree, they will be carried
 
1739
    across and remain as uncommitted changes after the update.  To discard
 
1740
    these changes, use 'brz revert'.  The uncommitted changes may conflict
 
1741
    with the changes brought in by the change in basis revision.
 
1742
 
 
1743
    If the tree's branch is bound to a master branch, brz will also update
 
1744
    the branch from the master.
 
1745
 
 
1746
    You cannot update just a single file or directory, because each Breezy
 
1747
    working tree has just a single basis revision.  If you want to restore a
 
1748
    file that has been removed locally, use 'brz revert' instead of 'brz
 
1749
    update'.  If you want to restore a file to its state in a previous
 
1750
    revision, use 'brz revert' with a '-r' option, or use 'brz cat' to write
 
1751
    out the old content of that file to a new location.
 
1752
 
 
1753
    The 'dir' argument, if given, must be the location of the root of a
 
1754
    working tree to update.  By default, the working tree that contains the
 
1755
    current working directory is used.
 
1756
    """
 
1757
 
 
1758
    _see_also = ['pull', 'working-trees', 'status-flags']
 
1759
    takes_args = ['dir?']
 
1760
    takes_options = ['revision',
 
1761
                     Option('show-base',
 
1762
                            help="Show base revision text in conflicts."),
 
1763
                     ]
 
1764
    aliases = ['up']
 
1765
 
 
1766
    def run(self, dir=None, revision=None, show_base=None):
 
1767
        if revision is not None and len(revision) != 1:
 
1768
            raise errors.BzrCommandError(gettext(
 
1769
                "brz update --revision takes exactly one revision"))
 
1770
        if dir is None:
 
1771
            tree = WorkingTree.open_containing('.')[0]
 
1772
        else:
 
1773
            tree, relpath = WorkingTree.open_containing(dir)
 
1774
            if relpath:
 
1775
                # See bug 557886.
 
1776
                raise errors.BzrCommandError(gettext(
 
1777
                    "brz update can only update a whole tree, "
 
1778
                    "not a file or subdirectory"))
 
1779
        branch = tree.branch
 
1780
        possible_transports = []
 
1781
        master = branch.get_master_branch(
 
1782
            possible_transports=possible_transports)
 
1783
        if master is not None:
 
1784
            branch_location = master.base
 
1785
            self.enter_context(tree.lock_write())
 
1786
        else:
 
1787
            branch_location = tree.branch.base
 
1788
            self.enter_context(tree.lock_tree_write())
 
1789
        # get rid of the final '/' and be ready for display
 
1790
        branch_location = urlutils.unescape_for_display(
 
1791
            branch_location.rstrip('/'),
 
1792
            self.outf.encoding)
 
1793
        existing_pending_merges = tree.get_parent_ids()[1:]
 
1794
        if master is None:
 
1795
            old_tip = None
 
1796
        else:
 
1797
            # may need to fetch data into a heavyweight checkout
 
1798
            # XXX: this may take some time, maybe we should display a
 
1799
            # message
 
1800
            old_tip = branch.update(possible_transports)
 
1801
        if revision is not None:
 
1802
            revision_id = revision[0].as_revision_id(branch)
 
1803
        else:
 
1804
            revision_id = branch.last_revision()
 
1805
        if revision_id == _mod_revision.ensure_null(tree.last_revision()):
 
1806
            revno = branch.revision_id_to_dotted_revno(revision_id)
 
1807
            note(gettext("Tree is up to date at revision {0} of branch {1}"
 
1808
                         ).format('.'.join(map(str, revno)), branch_location))
 
1809
            return 0
 
1810
        view_info = _get_view_info_for_change_reporter(tree)
 
1811
        change_reporter = delta._ChangeReporter(
 
1812
            unversioned_filter=tree.is_ignored,
 
1813
            view_info=view_info)
 
1814
        try:
 
1815
            conflicts = tree.update(
 
1816
                change_reporter,
 
1817
                possible_transports=possible_transports,
 
1818
                revision=revision_id,
 
1819
                old_tip=old_tip,
 
1820
                show_base=show_base)
 
1821
        except errors.NoSuchRevision as e:
 
1822
            raise errors.BzrCommandError(gettext(
 
1823
                "branch has no revision %s\n"
 
1824
                "brz update --revision only works"
 
1825
                " for a revision in the branch history")
 
1826
                % (e.revision))
 
1827
        revno = tree.branch.revision_id_to_dotted_revno(
 
1828
            _mod_revision.ensure_null(tree.last_revision()))
 
1829
        note(gettext('Updated to revision {0} of branch {1}').format(
 
1830
             '.'.join(map(str, revno)), branch_location))
 
1831
        parent_ids = tree.get_parent_ids()
 
1832
        if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
 
1833
            note(gettext('Your local commits will now show as pending merges with '
 
1834
                         "'brz status', and can be committed with 'brz commit'."))
 
1835
        if conflicts != 0:
 
1836
            return 1
 
1837
        else:
 
1838
            return 0
 
1839
 
 
1840
 
 
1841
class cmd_info(Command):
 
1842
    __doc__ = """Show information about a working tree, branch or repository.
 
1843
 
 
1844
    This command will show all known locations and formats associated to the
 
1845
    tree, branch or repository.
 
1846
 
 
1847
    In verbose mode, statistical information is included with each report.
 
1848
    To see extended statistic information, use a verbosity level of 2 or
 
1849
    higher by specifying the verbose option multiple times, e.g. -vv.
 
1850
 
 
1851
    Branches and working trees will also report any missing revisions.
 
1852
 
 
1853
    :Examples:
 
1854
 
 
1855
      Display information on the format and related locations:
 
1856
 
 
1857
        brz info
 
1858
 
 
1859
      Display the above together with extended format information and
 
1860
      basic statistics (like the number of files in the working tree and
 
1861
      number of revisions in the branch and repository):
 
1862
 
 
1863
        brz info -v
 
1864
 
 
1865
      Display the above together with number of committers to the branch:
 
1866
 
 
1867
        brz info -vv
 
1868
    """
 
1869
    _see_also = ['revno', 'working-trees', 'repositories']
 
1870
    takes_args = ['location?']
 
1871
    takes_options = ['verbose']
 
1872
    encoding_type = 'replace'
 
1873
 
 
1874
    @display_command
 
1875
    def run(self, location=None, verbose=False):
 
1876
        if verbose:
 
1877
            noise_level = get_verbosity_level()
 
1878
        else:
 
1879
            noise_level = 0
 
1880
        from .info import show_bzrdir_info
 
1881
        show_bzrdir_info(controldir.ControlDir.open_containing(location)[0],
 
1882
                         verbose=noise_level, outfile=self.outf)
 
1883
 
 
1884
 
 
1885
class cmd_remove(Command):
 
1886
    __doc__ = """Remove files or directories.
 
1887
 
 
1888
    This makes Breezy stop tracking changes to the specified files. Breezy will
 
1889
    delete them if they can easily be recovered using revert otherwise they
 
1890
    will be backed up (adding an extension of the form .~#~). If no options or
 
1891
    parameters are given Breezy will scan for files that are being tracked by
 
1892
    Breezy but missing in your tree and stop tracking them for you.
 
1893
    """
 
1894
    takes_args = ['file*']
 
1895
    takes_options = ['verbose',
 
1896
                     Option(
 
1897
                         'new', help='Only remove files that have never been committed.'),
 
1898
                     RegistryOption.from_kwargs('file-deletion-strategy',
 
1899
                                                'The file deletion mode to be used.',
 
1900
                                                title='Deletion Strategy', value_switches=True, enum_switch=False,
 
1901
                                                safe='Backup changed files (default).',
 
1902
                                                keep='Delete from brz but leave the working copy.',
 
1903
                                                no_backup='Don\'t backup changed files.'),
 
1904
                     ]
 
1905
    aliases = ['rm', 'del']
 
1906
    encoding_type = 'replace'
 
1907
 
 
1908
    def run(self, file_list, verbose=False, new=False,
 
1909
            file_deletion_strategy='safe'):
 
1910
 
 
1911
        tree, file_list = WorkingTree.open_containing_paths(file_list)
 
1912
 
 
1913
        if file_list is not None:
 
1914
            file_list = [f for f in file_list]
 
1915
 
 
1916
        self.enter_context(tree.lock_write())
 
1917
        # Heuristics should probably all move into tree.remove_smart or
 
1918
        # some such?
 
1919
        if new:
 
1920
            added = tree.changes_from(tree.basis_tree(),
 
1921
                                      specific_files=file_list).added
 
1922
            file_list = sorted([f.path[1] for f in added], reverse=True)
 
1923
            if len(file_list) == 0:
 
1924
                raise errors.BzrCommandError(gettext('No matching files.'))
 
1925
        elif file_list is None:
 
1926
            # missing files show up in iter_changes(basis) as
 
1927
            # versioned-with-no-kind.
 
1928
            missing = []
 
1929
            for change in tree.iter_changes(tree.basis_tree()):
 
1930
                # Find paths in the working tree that have no kind:
 
1931
                if change.path[1] is not None and change.kind[1] is None:
 
1932
                    missing.append(change.path[1])
 
1933
            file_list = sorted(missing, reverse=True)
 
1934
            file_deletion_strategy = 'keep'
 
1935
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
 
1936
                    keep_files=file_deletion_strategy == 'keep',
 
1937
                    force=(file_deletion_strategy == 'no-backup'))
 
1938
 
 
1939
 
 
1940
class cmd_reconcile(Command):
 
1941
    __doc__ = """Reconcile brz metadata in a branch.
 
1942
 
 
1943
    This can correct data mismatches that may have been caused by
 
1944
    previous ghost operations or brz upgrades. You should only
 
1945
    need to run this command if 'brz check' or a brz developer
 
1946
    advises you to run it.
 
1947
 
 
1948
    If a second branch is provided, cross-branch reconciliation is
 
1949
    also attempted, which will check that data like the tree root
 
1950
    id which was not present in very early brz versions is represented
 
1951
    correctly in both branches.
 
1952
 
 
1953
    At the same time it is run it may recompress data resulting in
 
1954
    a potential saving in disk space or performance gain.
 
1955
 
 
1956
    The branch *MUST* be on a listable system such as local disk or sftp.
 
1957
    """
 
1958
 
 
1959
    _see_also = ['check']
 
1960
    takes_args = ['branch?']
 
1961
    takes_options = [
 
1962
        Option('canonicalize-chks',
 
1963
               help='Make sure CHKs are in canonical form (repairs '
 
1964
                    'bug 522637).',
 
1965
               hidden=True),
 
1966
        ]
 
1967
 
 
1968
    def run(self, branch=".", canonicalize_chks=False):
 
1969
        from .reconcile import reconcile
 
1970
        dir = controldir.ControlDir.open(branch)
 
1971
        reconcile(dir, canonicalize_chks=canonicalize_chks)
 
1972
 
 
1973
 
 
1974
class cmd_revision_history(Command):
 
1975
    __doc__ = """Display the list of revision ids on a branch."""
 
1976
 
 
1977
    _see_also = ['log']
 
1978
    takes_args = ['location?']
 
1979
 
 
1980
    hidden = True
 
1981
 
 
1982
    @display_command
 
1983
    def run(self, location="."):
 
1984
        branch = Branch.open_containing(location)[0]
 
1985
        self.enter_context(branch.lock_read())
 
1986
        graph = branch.repository.get_graph()
 
1987
        history = list(graph.iter_lefthand_ancestry(branch.last_revision(),
 
1988
                                                    [_mod_revision.NULL_REVISION]))
 
1989
        for revid in reversed(history):
 
1990
            self.outf.write(revid)
 
1991
            self.outf.write('\n')
 
1992
 
 
1993
 
 
1994
class cmd_ancestry(Command):
 
1995
    __doc__ = """List all revisions merged into this branch."""
 
1996
 
 
1997
    _see_also = ['log', 'revision-history']
 
1998
    takes_args = ['location?']
 
1999
 
 
2000
    hidden = True
 
2001
 
 
2002
    @display_command
 
2003
    def run(self, location="."):
 
2004
        try:
 
2005
            wt = WorkingTree.open_containing(location)[0]
 
2006
        except errors.NoWorkingTree:
 
2007
            b = Branch.open(location)
 
2008
            last_revision = b.last_revision()
 
2009
        else:
 
2010
            b = wt.branch
 
2011
            last_revision = wt.last_revision()
 
2012
 
 
2013
        self.enter_context(b.repository.lock_read())
 
2014
        graph = b.repository.get_graph()
 
2015
        revisions = [revid for revid, parents in
 
2016
                     graph.iter_ancestry([last_revision])]
 
2017
        for revision_id in reversed(revisions):
 
2018
            if _mod_revision.is_null(revision_id):
 
2019
                continue
 
2020
            self.outf.write(revision_id.decode('utf-8') + '\n')
 
2021
 
 
2022
 
 
2023
class cmd_init(Command):
 
2024
    __doc__ = """Make a directory into a versioned branch.
 
2025
 
 
2026
    Use this to create an empty branch, or before importing an
 
2027
    existing project.
 
2028
 
 
2029
    If there is a repository in a parent directory of the location, then
 
2030
    the history of the branch will be stored in the repository.  Otherwise
 
2031
    init creates a standalone branch which carries its own history
 
2032
    in the .bzr directory.
 
2033
 
 
2034
    If there is already a branch at the location but it has no working tree,
 
2035
    the tree can be populated with 'brz checkout'.
 
2036
 
 
2037
    Recipe for importing a tree of files::
 
2038
 
 
2039
        cd ~/project
 
2040
        brz init
 
2041
        brz add .
 
2042
        brz status
 
2043
        brz commit -m "imported project"
 
2044
    """
 
2045
 
 
2046
    _see_also = ['init-shared-repository', 'branch', 'checkout']
 
2047
    takes_args = ['location?']
 
2048
    takes_options = [
 
2049
        Option('create-prefix',
 
2050
               help='Create the path leading up to the branch '
 
2051
                    'if it does not already exist.'),
 
2052
        RegistryOption('format',
 
2053
                       help='Specify a format for this branch. '
 
2054
                       'See "help formats" for a full list.',
 
2055
                       lazy_registry=('breezy.controldir', 'format_registry'),
 
2056
                       converter=lambda name: controldir.format_registry.make_controldir(
 
2057
                            name),
 
2058
                       value_switches=True,
 
2059
                       title="Branch format",
 
2060
                       ),
 
2061
        Option('append-revisions-only',
 
2062
               help='Never change revnos or the existing log.'
 
2063
               '  Append revisions to it only.'),
 
2064
        Option('no-tree',
 
2065
               'Create a branch without a working tree.')
 
2066
        ]
 
2067
 
 
2068
    def run(self, location=None, format=None, append_revisions_only=False,
 
2069
            create_prefix=False, no_tree=False):
 
2070
        if format is None:
 
2071
            format = controldir.format_registry.make_controldir('default')
 
2072
        if location is None:
 
2073
            location = u'.'
 
2074
 
 
2075
        to_transport = transport.get_transport(location, purpose='write')
 
2076
 
 
2077
        # The path has to exist to initialize a
 
2078
        # branch inside of it.
 
2079
        # Just using os.mkdir, since I don't
 
2080
        # believe that we want to create a bunch of
 
2081
        # locations if the user supplies an extended path
 
2082
        try:
 
2083
            to_transport.ensure_base()
 
2084
        except errors.NoSuchFile:
 
2085
            if not create_prefix:
 
2086
                raise errors.BzrCommandError(gettext("Parent directory of %s"
 
2087
                                                     " does not exist."
 
2088
                                                     "\nYou may supply --create-prefix to create all"
 
2089
                                                     " leading parent directories.")
 
2090
                                             % location)
 
2091
            to_transport.create_prefix()
 
2092
 
 
2093
        try:
 
2094
            a_controldir = controldir.ControlDir.open_from_transport(
 
2095
                to_transport)
 
2096
        except errors.NotBranchError:
 
2097
            # really a NotBzrDir error...
 
2098
            create_branch = controldir.ControlDir.create_branch_convenience
 
2099
            if no_tree:
 
2100
                force_new_tree = False
 
2101
            else:
 
2102
                force_new_tree = None
 
2103
            branch = create_branch(to_transport.base, format=format,
 
2104
                                   possible_transports=[to_transport],
 
2105
                                   force_new_tree=force_new_tree)
 
2106
            a_controldir = branch.controldir
 
2107
        else:
 
2108
            from .transport.local import LocalTransport
 
2109
            if a_controldir.has_branch():
 
2110
                if (isinstance(to_transport, LocalTransport)
 
2111
                        and not a_controldir.has_workingtree()):
 
2112
                    raise errors.BranchExistsWithoutWorkingTree(location)
 
2113
                raise errors.AlreadyBranchError(location)
 
2114
            branch = a_controldir.create_branch()
 
2115
            if not no_tree and not a_controldir.has_workingtree():
 
2116
                a_controldir.create_workingtree()
 
2117
        if append_revisions_only:
 
2118
            try:
 
2119
                branch.set_append_revisions_only(True)
 
2120
            except errors.UpgradeRequired:
 
2121
                raise errors.BzrCommandError(gettext('This branch format cannot be set'
 
2122
                                                     ' to append-revisions-only.  Try --default.'))
 
2123
        if not is_quiet():
 
2124
            from .info import describe_layout, describe_format
 
2125
            try:
 
2126
                tree = a_controldir.open_workingtree(recommend_upgrade=False)
 
2127
            except (errors.NoWorkingTree, errors.NotLocalUrl):
 
2128
                tree = None
 
2129
            repository = branch.repository
 
2130
            layout = describe_layout(repository, branch, tree).lower()
 
2131
            format = describe_format(a_controldir, repository, branch, tree)
 
2132
            self.outf.write(gettext("Created a {0} (format: {1})\n").format(
 
2133
                layout, format))
 
2134
            if repository.is_shared():
 
2135
                # XXX: maybe this can be refactored into transport.path_or_url()
 
2136
                url = repository.controldir.root_transport.external_url()
 
2137
                try:
 
2138
                    url = urlutils.local_path_from_url(url)
 
2139
                except urlutils.InvalidURL:
 
2140
                    pass
 
2141
                self.outf.write(gettext("Using shared repository: %s\n") % url)
 
2142
 
 
2143
 
 
2144
class cmd_init_shared_repository(Command):
 
2145
    __doc__ = """Create a shared repository for branches to share storage space.
 
2146
 
 
2147
    New branches created under the repository directory will store their
 
2148
    revisions in the repository, not in the branch directory.  For branches
 
2149
    with shared history, this reduces the amount of storage needed and
 
2150
    speeds up the creation of new branches.
 
2151
 
 
2152
    If the --no-trees option is given then the branches in the repository
 
2153
    will not have working trees by default.  They will still exist as
 
2154
    directories on disk, but they will not have separate copies of the
 
2155
    files at a certain revision.  This can be useful for repositories that
 
2156
    store branches which are interacted with through checkouts or remote
 
2157
    branches, such as on a server.
 
2158
 
 
2159
    :Examples:
 
2160
        Create a shared repository holding just branches::
 
2161
 
 
2162
            brz init-shared-repo --no-trees repo
 
2163
            brz init repo/trunk
 
2164
 
 
2165
        Make a lightweight checkout elsewhere::
 
2166
 
 
2167
            brz checkout --lightweight repo/trunk trunk-checkout
 
2168
            cd trunk-checkout
 
2169
            (add files here)
 
2170
    """
 
2171
 
 
2172
    _see_also = ['init', 'branch', 'checkout', 'repositories']
 
2173
    takes_args = ["location"]
 
2174
    takes_options = [RegistryOption('format',
 
2175
                                    help='Specify a format for this repository. See'
 
2176
                                    ' "brz help formats" for details.',
 
2177
                                    lazy_registry=(
 
2178
                                        'breezy.controldir', 'format_registry'),
 
2179
                                    converter=lambda name: controldir.format_registry.make_controldir(
 
2180
                                        name),
 
2181
                                    value_switches=True, title='Repository format'),
 
2182
                     Option('no-trees',
 
2183
                            help='Branches in the repository will default to'
 
2184
                            ' not having a working tree.'),
 
2185
                     ]
 
2186
    aliases = ["init-shared-repo", "init-repo"]
 
2187
 
 
2188
    def run(self, location, format=None, no_trees=False):
 
2189
        if format is None:
 
2190
            format = controldir.format_registry.make_controldir('default')
 
2191
 
 
2192
        if location is None:
 
2193
            location = '.'
 
2194
 
 
2195
        to_transport = transport.get_transport(location, purpose='write')
 
2196
 
 
2197
        if format.fixed_components:
 
2198
            repo_format_name = None
 
2199
        else:
 
2200
            repo_format_name = format.repository_format.get_format_string()
 
2201
 
 
2202
        (repo, newdir, require_stacking, repository_policy) = (
 
2203
            format.initialize_on_transport_ex(to_transport,
 
2204
                                              create_prefix=True, make_working_trees=not no_trees,
 
2205
                                              shared_repo=True, force_new_repo=True,
 
2206
                                              use_existing_dir=True,
 
2207
                                              repo_format_name=repo_format_name))
 
2208
        if not is_quiet():
 
2209
            from .info import show_bzrdir_info
 
2210
            show_bzrdir_info(newdir, verbose=0, outfile=self.outf)
 
2211
 
 
2212
 
 
2213
class cmd_diff(Command):
 
2214
    __doc__ = """Show differences in the working tree, between revisions or branches.
 
2215
 
 
2216
    If no arguments are given, all changes for the current tree are listed.
 
2217
    If files are given, only the changes in those files are listed.
 
2218
    Remote and multiple branches can be compared by using the --old and
 
2219
    --new options. If not provided, the default for both is derived from
 
2220
    the first argument, if any, or the current tree if no arguments are
 
2221
    given.
 
2222
 
 
2223
    "brz diff -p1" is equivalent to "brz diff --prefix old/:new/", and
 
2224
    produces patches suitable for "patch -p1".
 
2225
 
 
2226
    Note that when using the -r argument with a range of revisions, the
 
2227
    differences are computed between the two specified revisions.  That
 
2228
    is, the command does not show the changes introduced by the first
 
2229
    revision in the range.  This differs from the interpretation of
 
2230
    revision ranges used by "brz log" which includes the first revision
 
2231
    in the range.
 
2232
 
 
2233
    :Exit values:
 
2234
        1 - changed
 
2235
        2 - unrepresentable changes
 
2236
        3 - error
 
2237
        0 - no change
 
2238
 
 
2239
    :Examples:
 
2240
        Shows the difference in the working tree versus the last commit::
 
2241
 
 
2242
            brz diff
 
2243
 
 
2244
        Difference between the working tree and revision 1::
 
2245
 
 
2246
            brz diff -r1
 
2247
 
 
2248
        Difference between revision 3 and revision 1::
 
2249
 
 
2250
            brz diff -r1..3
 
2251
 
 
2252
        Difference between revision 3 and revision 1 for branch xxx::
 
2253
 
 
2254
            brz diff -r1..3 xxx
 
2255
 
 
2256
        The changes introduced by revision 2 (equivalent to -r1..2)::
 
2257
 
 
2258
            brz diff -c2
 
2259
 
 
2260
        To see the changes introduced by revision X::
 
2261
 
 
2262
            brz diff -cX
 
2263
 
 
2264
        Note that in the case of a merge, the -c option shows the changes
 
2265
        compared to the left hand parent. To see the changes against
 
2266
        another parent, use::
 
2267
 
 
2268
            brz diff -r<chosen_parent>..X
 
2269
 
 
2270
        The changes between the current revision and the previous revision
 
2271
        (equivalent to -c-1 and -r-2..-1)
 
2272
 
 
2273
            brz diff -r-2..
 
2274
 
 
2275
        Show just the differences for file NEWS::
 
2276
 
 
2277
            brz diff NEWS
 
2278
 
 
2279
        Show the differences in working tree xxx for file NEWS::
 
2280
 
 
2281
            brz diff xxx/NEWS
 
2282
 
 
2283
        Show the differences from branch xxx to this working tree:
 
2284
 
 
2285
            brz diff --old xxx
 
2286
 
 
2287
        Show the differences between two branches for file NEWS::
 
2288
 
 
2289
            brz diff --old xxx --new yyy NEWS
 
2290
 
 
2291
        Same as 'brz diff' but prefix paths with old/ and new/::
 
2292
 
 
2293
            brz diff --prefix old/:new/
 
2294
 
 
2295
        Show the differences using a custom diff program with options::
 
2296
 
 
2297
            brz diff --using /usr/bin/diff --diff-options -wu
 
2298
    """
 
2299
    _see_also = ['status']
 
2300
    takes_args = ['file*']
 
2301
    takes_options = [
 
2302
        Option('diff-options', type=str,
 
2303
               help='Pass these options to the external diff program.'),
 
2304
        Option('prefix', type=str,
 
2305
               short_name='p',
 
2306
               help='Set prefixes added to old and new filenames, as '
 
2307
                    'two values separated by a colon. (eg "old/:new/").'),
 
2308
        Option('old',
 
2309
               help='Branch/tree to compare from.',
 
2310
               type=str,
 
2311
               ),
 
2312
        Option('new',
 
2313
               help='Branch/tree to compare to.',
 
2314
               type=str,
 
2315
               ),
 
2316
        'revision',
 
2317
        'change',
 
2318
        Option('using',
 
2319
               help='Use this command to compare files.',
 
2320
               type=str,
 
2321
               ),
 
2322
        RegistryOption('format',
 
2323
                       short_name='F',
 
2324
                       help='Diff format to use.',
 
2325
                       lazy_registry=('breezy.diff', 'format_registry'),
 
2326
                       title='Diff format'),
 
2327
        Option('context',
 
2328
               help='How many lines of context to show.',
 
2329
               type=int,
 
2330
               ),
 
2331
        RegistryOption.from_kwargs(
 
2332
            'color',
 
2333
            help='Color mode to use.',
 
2334
            title='Color Mode', value_switches=False, enum_switch=True,
 
2335
            never='Never colorize output.',
 
2336
            auto='Only colorize output if terminal supports it and STDOUT is a'
 
2337
            ' TTY.',
 
2338
            always='Always colorize output (default).'),
 
2339
        Option(
 
2340
            'check-style',
 
2341
            help=('Warn if trailing whitespace or spurious changes have been'
 
2342
                  '  added.'))
 
2343
        ]
 
2344
 
 
2345
    aliases = ['di', 'dif']
 
2346
    encoding_type = 'exact'
 
2347
 
 
2348
    @display_command
 
2349
    def run(self, revision=None, file_list=None, diff_options=None,
 
2350
            prefix=None, old=None, new=None, using=None, format=None,
 
2351
            context=None, color='never'):
 
2352
        from .diff import (get_trees_and_branches_to_diff_locked,
 
2353
                           show_diff_trees)
 
2354
 
 
2355
        if prefix == u'0':
 
2356
            # diff -p0 format
 
2357
            old_label = ''
 
2358
            new_label = ''
 
2359
        elif prefix == u'1' or prefix is None:
 
2360
            old_label = 'old/'
 
2361
            new_label = 'new/'
 
2362
        elif u':' in prefix:
 
2363
            old_label, new_label = prefix.split(u":")
 
2364
        else:
 
2365
            raise errors.BzrCommandError(gettext(
 
2366
                '--prefix expects two values separated by a colon'
 
2367
                ' (eg "old/:new/")'))
 
2368
 
 
2369
        if revision and len(revision) > 2:
 
2370
            raise errors.BzrCommandError(gettext('brz diff --revision takes exactly'
 
2371
                                                 ' one or two revision specifiers'))
 
2372
 
 
2373
        if using is not None and format is not None:
 
2374
            raise errors.BzrCommandError(gettext(
 
2375
                '{0} and {1} are mutually exclusive').format(
 
2376
                '--using', '--format'))
 
2377
 
 
2378
        (old_tree, new_tree,
 
2379
         old_branch, new_branch,
 
2380
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
 
2381
            file_list, revision, old, new, self._exit_stack, apply_view=True)
 
2382
        # GNU diff on Windows uses ANSI encoding for filenames
 
2383
        path_encoding = osutils.get_diff_header_encoding()
 
2384
        outf = self.outf
 
2385
        if color == 'auto':
 
2386
            from .terminal import has_ansi_colors
 
2387
            if has_ansi_colors():
 
2388
                color = 'always'
 
2389
            else:
 
2390
                color = 'never'
 
2391
        if 'always' == color:
 
2392
            from .colordiff import DiffWriter
 
2393
            outf = DiffWriter(outf)
 
2394
        return show_diff_trees(old_tree, new_tree, outf,
 
2395
                               specific_files=specific_files,
 
2396
                               external_diff_options=diff_options,
 
2397
                               old_label=old_label, new_label=new_label,
 
2398
                               extra_trees=extra_trees,
 
2399
                               path_encoding=path_encoding,
 
2400
                               using=using, context=context,
 
2401
                               format_cls=format)
 
2402
 
 
2403
 
 
2404
class cmd_deleted(Command):
 
2405
    __doc__ = """List files deleted in the working tree.
 
2406
    """
 
2407
    # TODO: Show files deleted since a previous revision, or
 
2408
    # between two revisions.
 
2409
    # TODO: Much more efficient way to do this: read in new
 
2410
    # directories with readdir, rather than stating each one.  Same
 
2411
    # level of effort but possibly much less IO.  (Or possibly not,
 
2412
    # if the directories are very large...)
 
2413
    _see_also = ['status', 'ls']
 
2414
    takes_options = ['directory', 'show-ids']
 
2415
 
 
2416
    @display_command
 
2417
    def run(self, show_ids=False, directory=u'.'):
 
2418
        tree = WorkingTree.open_containing(directory)[0]
 
2419
        self.enter_context(tree.lock_read())
 
2420
        old = tree.basis_tree()
 
2421
        self.enter_context(old.lock_read())
 
2422
        delta = tree.changes_from(old)
 
2423
        for change in delta.removed:
 
2424
            self.outf.write(change.path[0])
 
2425
            if show_ids:
 
2426
                self.outf.write(' ')
 
2427
                self.outf.write(change.file_id)
 
2428
            self.outf.write('\n')
 
2429
 
 
2430
 
 
2431
class cmd_modified(Command):
 
2432
    __doc__ = """List files modified in working tree.
 
2433
    """
 
2434
 
 
2435
    hidden = True
 
2436
    _see_also = ['status', 'ls']
 
2437
    takes_options = ['directory', 'null']
 
2438
 
 
2439
    @display_command
 
2440
    def run(self, null=False, directory=u'.'):
 
2441
        tree = WorkingTree.open_containing(directory)[0]
 
2442
        self.enter_context(tree.lock_read())
 
2443
        td = tree.changes_from(tree.basis_tree())
 
2444
        self.cleanup_now()
 
2445
        for change in td.modified:
 
2446
            if null:
 
2447
                self.outf.write(change.path[1] + '\0')
 
2448
            else:
 
2449
                self.outf.write(osutils.quotefn(change.path[1]) + '\n')
 
2450
 
 
2451
 
 
2452
class cmd_added(Command):
 
2453
    __doc__ = """List files added in working tree.
 
2454
    """
 
2455
 
 
2456
    hidden = True
 
2457
    _see_also = ['status', 'ls']
 
2458
    takes_options = ['directory', 'null']
 
2459
 
 
2460
    @display_command
 
2461
    def run(self, null=False, directory=u'.'):
 
2462
        wt = WorkingTree.open_containing(directory)[0]
 
2463
        self.enter_context(wt.lock_read())
 
2464
        basis = wt.basis_tree()
 
2465
        self.enter_context(basis.lock_read())
 
2466
        for path in wt.all_versioned_paths():
 
2467
            if basis.has_filename(path):
 
2468
                continue
 
2469
            if path == u'':
 
2470
                continue
 
2471
            if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
 
2472
                continue
 
2473
            if null:
 
2474
                self.outf.write(path + '\0')
 
2475
            else:
 
2476
                self.outf.write(osutils.quotefn(path) + '\n')
 
2477
 
 
2478
 
 
2479
class cmd_root(Command):
 
2480
    __doc__ = """Show the tree root directory.
 
2481
 
 
2482
    The root is the nearest enclosing directory with a control
 
2483
    directory."""
 
2484
 
 
2485
    takes_args = ['filename?']
 
2486
 
 
2487
    @display_command
 
2488
    def run(self, filename=None):
 
2489
        """Print the branch root."""
 
2490
        tree = WorkingTree.open_containing(filename)[0]
 
2491
        self.outf.write(tree.basedir + '\n')
 
2492
 
 
2493
 
 
2494
def _parse_limit(limitstring):
 
2495
    try:
 
2496
        return int(limitstring)
 
2497
    except ValueError:
 
2498
        msg = gettext("The limit argument must be an integer.")
 
2499
        raise errors.BzrCommandError(msg)
 
2500
 
 
2501
 
 
2502
def _parse_levels(s):
 
2503
    try:
 
2504
        return int(s)
 
2505
    except ValueError:
 
2506
        msg = gettext("The levels argument must be an integer.")
 
2507
        raise errors.BzrCommandError(msg)
 
2508
 
 
2509
 
 
2510
class cmd_log(Command):
 
2511
    __doc__ = """Show historical log for a branch or subset of a branch.
 
2512
 
 
2513
    log is brz's default tool for exploring the history of a branch.
 
2514
    The branch to use is taken from the first parameter. If no parameters
 
2515
    are given, the branch containing the working directory is logged.
 
2516
    Here are some simple examples::
 
2517
 
 
2518
      brz log                       log the current branch
 
2519
      brz log foo.py                log a file in its branch
 
2520
      brz log http://server/branch  log a branch on a server
 
2521
 
 
2522
    The filtering, ordering and information shown for each revision can
 
2523
    be controlled as explained below. By default, all revisions are
 
2524
    shown sorted (topologically) so that newer revisions appear before
 
2525
    older ones and descendants always appear before ancestors. If displayed,
 
2526
    merged revisions are shown indented under the revision in which they
 
2527
    were merged.
 
2528
 
 
2529
    :Output control:
 
2530
 
 
2531
      The log format controls how information about each revision is
 
2532
      displayed. The standard log formats are called ``long``, ``short``
 
2533
      and ``line``. The default is long. See ``brz help log-formats``
 
2534
      for more details on log formats.
 
2535
 
 
2536
      The following options can be used to control what information is
 
2537
      displayed::
 
2538
 
 
2539
        -l N        display a maximum of N revisions
 
2540
        -n N        display N levels of revisions (0 for all, 1 for collapsed)
 
2541
        -v          display a status summary (delta) for each revision
 
2542
        -p          display a diff (patch) for each revision
 
2543
        --show-ids  display revision-ids (and file-ids), not just revnos
 
2544
 
 
2545
      Note that the default number of levels to display is a function of the
 
2546
      log format. If the -n option is not used, the standard log formats show
 
2547
      just the top level (mainline).
 
2548
 
 
2549
      Status summaries are shown using status flags like A, M, etc. To see
 
2550
      the changes explained using words like ``added`` and ``modified``
 
2551
      instead, use the -vv option.
 
2552
 
 
2553
    :Ordering control:
 
2554
 
 
2555
      To display revisions from oldest to newest, use the --forward option.
 
2556
      In most cases, using this option will have little impact on the total
 
2557
      time taken to produce a log, though --forward does not incrementally
 
2558
      display revisions like --reverse does when it can.
 
2559
 
 
2560
    :Revision filtering:
 
2561
 
 
2562
      The -r option can be used to specify what revision or range of revisions
 
2563
      to filter against. The various forms are shown below::
 
2564
 
 
2565
        -rX      display revision X
 
2566
        -rX..    display revision X and later
 
2567
        -r..Y    display up to and including revision Y
 
2568
        -rX..Y   display from X to Y inclusive
 
2569
 
 
2570
      See ``brz help revisionspec`` for details on how to specify X and Y.
 
2571
      Some common examples are given below::
 
2572
 
 
2573
        -r-1                show just the tip
 
2574
        -r-10..             show the last 10 mainline revisions
 
2575
        -rsubmit:..         show what's new on this branch
 
2576
        -rancestor:path..   show changes since the common ancestor of this
 
2577
                            branch and the one at location path
 
2578
        -rdate:yesterday..  show changes since yesterday
 
2579
 
 
2580
      When logging a range of revisions using -rX..Y, log starts at
 
2581
      revision Y and searches back in history through the primary
 
2582
      ("left-hand") parents until it finds X. When logging just the
 
2583
      top level (using -n1), an error is reported if X is not found
 
2584
      along the way. If multi-level logging is used (-n0), X may be
 
2585
      a nested merge revision and the log will be truncated accordingly.
 
2586
 
 
2587
    :Path filtering:
 
2588
 
 
2589
      If parameters are given and the first one is not a branch, the log
 
2590
      will be filtered to show only those revisions that changed the
 
2591
      nominated files or directories.
 
2592
 
 
2593
      Filenames are interpreted within their historical context. To log a
 
2594
      deleted file, specify a revision range so that the file existed at
 
2595
      the end or start of the range.
 
2596
 
 
2597
      Historical context is also important when interpreting pathnames of
 
2598
      renamed files/directories. Consider the following example:
 
2599
 
 
2600
      * revision 1: add tutorial.txt
 
2601
      * revision 2: modify tutorial.txt
 
2602
      * revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
 
2603
 
 
2604
      In this case:
 
2605
 
 
2606
      * ``brz log guide.txt`` will log the file added in revision 1
 
2607
 
 
2608
      * ``brz log tutorial.txt`` will log the new file added in revision 3
 
2609
 
 
2610
      * ``brz log -r2 -p tutorial.txt`` will show the changes made to
 
2611
        the original file in revision 2.
 
2612
 
 
2613
      * ``brz log -r2 -p guide.txt`` will display an error message as there
 
2614
        was no file called guide.txt in revision 2.
 
2615
 
 
2616
      Renames are always followed by log. By design, there is no need to
 
2617
      explicitly ask for this (and no way to stop logging a file back
 
2618
      until it was last renamed).
 
2619
 
 
2620
    :Other filtering:
 
2621
 
 
2622
      The --match option can be used for finding revisions that match a
 
2623
      regular expression in a commit message, committer, author or bug.
 
2624
      Specifying the option several times will match any of the supplied
 
2625
      expressions. --match-author, --match-bugs, --match-committer and
 
2626
      --match-message can be used to only match a specific field.
 
2627
 
 
2628
    :Tips & tricks:
 
2629
 
 
2630
      GUI tools and IDEs are often better at exploring history than command
 
2631
      line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
 
2632
      bzr-explorer shell, or the Loggerhead web interface.  See the Bazaar
 
2633
      Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/> and
 
2634
      <http://wiki.bazaar.canonical.com/IDEIntegration>.
 
2635
 
 
2636
      You may find it useful to add the aliases below to ``breezy.conf``::
 
2637
 
 
2638
        [ALIASES]
 
2639
        tip = log -r-1
 
2640
        top = log -l10 --line
 
2641
        show = log -v -p
 
2642
 
 
2643
      ``brz tip`` will then show the latest revision while ``brz top``
 
2644
      will show the last 10 mainline revisions. To see the details of a
 
2645
      particular revision X,  ``brz show -rX``.
 
2646
 
 
2647
      If you are interested in looking deeper into a particular merge X,
 
2648
      use ``brz log -n0 -rX``.
 
2649
 
 
2650
      ``brz log -v`` on a branch with lots of history is currently
 
2651
      very slow. A fix for this issue is currently under development.
 
2652
      With or without that fix, it is recommended that a revision range
 
2653
      be given when using the -v option.
 
2654
 
 
2655
      brz has a generic full-text matching plugin, brz-search, that can be
 
2656
      used to find revisions matching user names, commit messages, etc.
 
2657
      Among other features, this plugin can find all revisions containing
 
2658
      a list of words but not others.
 
2659
 
 
2660
      When exploring non-mainline history on large projects with deep
 
2661
      history, the performance of log can be greatly improved by installing
 
2662
      the historycache plugin. This plugin buffers historical information
 
2663
      trading disk space for faster speed.
 
2664
    """
 
2665
    takes_args = ['file*']
 
2666
    _see_also = ['log-formats', 'revisionspec']
 
2667
    takes_options = [
 
2668
        Option('forward',
 
2669
               help='Show from oldest to newest.'),
 
2670
        'timezone',
 
2671
        custom_help('verbose',
 
2672
                    help='Show files changed in each revision.'),
 
2673
        'show-ids',
 
2674
        'revision',
 
2675
        Option('change',
 
2676
               type=breezy.option._parse_revision_str,
 
2677
               short_name='c',
 
2678
               help='Show just the specified revision.'
 
2679
               ' See also "help revisionspec".'),
 
2680
        'log-format',
 
2681
        RegistryOption('authors',
 
2682
                       'What names to list as authors - first, all or committer.',
 
2683
                       title='Authors',
 
2684
                       lazy_registry=(
 
2685
                           'breezy.log', 'author_list_registry'),
 
2686
                       ),
 
2687
        Option('levels',
 
2688
               short_name='n',
 
2689
               help='Number of levels to display - 0 for all, 1 for flat.',
 
2690
               argname='N',
 
2691
               type=_parse_levels),
 
2692
        Option('message',
 
2693
               help='Show revisions whose message matches this '
 
2694
               'regular expression.',
 
2695
               type=str,
 
2696
               hidden=True),
 
2697
        Option('limit',
 
2698
               short_name='l',
 
2699
               help='Limit the output to the first N revisions.',
 
2700
               argname='N',
 
2701
               type=_parse_limit),
 
2702
        Option('show-diff',
 
2703
               short_name='p',
 
2704
               help='Show changes made in each revision as a patch.'),
 
2705
        Option('include-merged',
 
2706
               help='Show merged revisions like --levels 0 does.'),
 
2707
        Option('include-merges', hidden=True,
 
2708
               help='Historical alias for --include-merged.'),
 
2709
        Option('omit-merges',
 
2710
               help='Do not report commits with more than one parent.'),
 
2711
        Option('exclude-common-ancestry',
 
2712
               help='Display only the revisions that are not part'
 
2713
               ' of both ancestries (require -rX..Y).'
 
2714
               ),
 
2715
        Option('signatures',
 
2716
               help='Show digital signature validity.'),
 
2717
        ListOption('match',
 
2718
                   short_name='m',
 
2719
                   help='Show revisions whose properties match this '
 
2720
                   'expression.',
 
2721
                   type=str),
 
2722
        ListOption('match-message',
 
2723
                   help='Show revisions whose message matches this '
 
2724
                   'expression.',
 
2725
                   type=str),
 
2726
        ListOption('match-committer',
 
2727
                   help='Show revisions whose committer matches this '
 
2728
                   'expression.',
 
2729
                   type=str),
 
2730
        ListOption('match-author',
 
2731
                   help='Show revisions whose authors match this '
 
2732
                   'expression.',
 
2733
                   type=str),
 
2734
        ListOption('match-bugs',
 
2735
                   help='Show revisions whose bugs match this '
 
2736
                   'expression.',
 
2737
                   type=str)
 
2738
        ]
 
2739
    encoding_type = 'replace'
 
2740
 
 
2741
    @display_command
 
2742
    def run(self, file_list=None, timezone='original',
 
2743
            verbose=False,
 
2744
            show_ids=False,
 
2745
            forward=False,
 
2746
            revision=None,
 
2747
            change=None,
 
2748
            log_format=None,
 
2749
            levels=None,
 
2750
            message=None,
 
2751
            limit=None,
 
2752
            show_diff=False,
 
2753
            include_merged=None,
 
2754
            authors=None,
 
2755
            exclude_common_ancestry=False,
 
2756
            signatures=False,
 
2757
            match=None,
 
2758
            match_message=None,
 
2759
            match_committer=None,
 
2760
            match_author=None,
 
2761
            match_bugs=None,
 
2762
            omit_merges=False,
 
2763
            ):
 
2764
        from .log import (
 
2765
            Logger,
 
2766
            make_log_request_dict,
 
2767
            _get_info_for_log_files,
 
2768
            )
 
2769
        direction = (forward and 'forward') or 'reverse'
 
2770
        if include_merged is None:
 
2771
            include_merged = False
 
2772
        if (exclude_common_ancestry
 
2773
                and (revision is None or len(revision) != 2)):
 
2774
            raise errors.BzrCommandError(gettext(
 
2775
                '--exclude-common-ancestry requires -r with two revisions'))
 
2776
        if include_merged:
 
2777
            if levels is None:
 
2778
                levels = 0
 
2779
            else:
 
2780
                raise errors.BzrCommandError(gettext(
 
2781
                    '{0} and {1} are mutually exclusive').format(
 
2782
                    '--levels', '--include-merged'))
 
2783
 
 
2784
        if change is not None:
 
2785
            if len(change) > 1:
 
2786
                raise errors.RangeInChangeOption()
 
2787
            if revision is not None:
 
2788
                raise errors.BzrCommandError(gettext(
 
2789
                    '{0} and {1} are mutually exclusive').format(
 
2790
                    '--revision', '--change'))
 
2791
            else:
 
2792
                revision = change
 
2793
 
 
2794
        file_ids = []
 
2795
        filter_by_dir = False
 
2796
        if file_list:
 
2797
            # find the file ids to log and check for directory filtering
 
2798
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
 
2799
                revision, file_list, self._exit_stack)
 
2800
            for relpath, file_id, kind in file_info_list:
 
2801
                if file_id is None:
 
2802
                    raise errors.BzrCommandError(gettext(
 
2803
                        "Path unknown at end or start of revision range: %s") %
 
2804
                        relpath)
 
2805
                # If the relpath is the top of the tree, we log everything
 
2806
                if relpath == '':
 
2807
                    file_ids = []
 
2808
                    break
 
2809
                else:
 
2810
                    file_ids.append(file_id)
 
2811
                filter_by_dir = filter_by_dir or (
 
2812
                    kind in ['directory', 'tree-reference'])
 
2813
        else:
 
2814
            # log everything
 
2815
            # FIXME ? log the current subdir only RBC 20060203
 
2816
            if revision is not None \
 
2817
                    and len(revision) > 0 and revision[0].get_branch():
 
2818
                location = revision[0].get_branch()
 
2819
            else:
 
2820
                location = '.'
 
2821
            dir, relpath = controldir.ControlDir.open_containing(location)
 
2822
            b = dir.open_branch()
 
2823
            self.enter_context(b.lock_read())
 
2824
            rev1, rev2 = _get_revision_range(revision, b, self.name())
 
2825
 
 
2826
        if b.get_config_stack().get('validate_signatures_in_log'):
 
2827
            signatures = True
 
2828
 
 
2829
        if signatures:
 
2830
            if not gpg.GPGStrategy.verify_signatures_available():
 
2831
                raise errors.GpgmeNotInstalled(None)
 
2832
 
 
2833
        # Decide on the type of delta & diff filtering to use
 
2834
        # TODO: add an --all-files option to make this configurable & consistent
 
2835
        if not verbose:
 
2836
            delta_type = None
 
2837
        else:
 
2838
            delta_type = 'full'
 
2839
        if not show_diff:
 
2840
            diff_type = None
 
2841
        elif file_ids:
 
2842
            diff_type = 'partial'
 
2843
        else:
 
2844
            diff_type = 'full'
 
2845
 
 
2846
        # Build the log formatter
 
2847
        if log_format is None:
 
2848
            log_format = log.log_formatter_registry.get_default(b)
 
2849
        # Make a non-encoding output to include the diffs - bug 328007
 
2850
        unencoded_output = ui.ui_factory.make_output_stream(
 
2851
            encoding_type='exact')
 
2852
        lf = log_format(show_ids=show_ids, to_file=self.outf,
 
2853
                        to_exact_file=unencoded_output,
 
2854
                        show_timezone=timezone,
 
2855
                        delta_format=get_verbosity_level(),
 
2856
                        levels=levels,
 
2857
                        show_advice=levels is None,
 
2858
                        author_list_handler=authors)
 
2859
 
 
2860
        # Choose the algorithm for doing the logging. It's annoying
 
2861
        # having multiple code paths like this but necessary until
 
2862
        # the underlying repository format is faster at generating
 
2863
        # deltas or can provide everything we need from the indices.
 
2864
        # The default algorithm - match-using-deltas - works for
 
2865
        # multiple files and directories and is faster for small
 
2866
        # amounts of history (200 revisions say). However, it's too
 
2867
        # slow for logging a single file in a repository with deep
 
2868
        # history, i.e. > 10K revisions. In the spirit of "do no
 
2869
        # evil when adding features", we continue to use the
 
2870
        # original algorithm - per-file-graph - for the "single
 
2871
        # file that isn't a directory without showing a delta" case.
 
2872
        partial_history = revision and b.repository._format.supports_chks
 
2873
        match_using_deltas = (len(file_ids) != 1 or filter_by_dir
 
2874
                              or delta_type or partial_history)
 
2875
 
 
2876
        match_dict = {}
 
2877
        if match:
 
2878
            match_dict[''] = match
 
2879
        if match_message:
 
2880
            match_dict['message'] = match_message
 
2881
        if match_committer:
 
2882
            match_dict['committer'] = match_committer
 
2883
        if match_author:
 
2884
            match_dict['author'] = match_author
 
2885
        if match_bugs:
 
2886
            match_dict['bugs'] = match_bugs
 
2887
 
 
2888
        # Build the LogRequest and execute it
 
2889
        if len(file_ids) == 0:
 
2890
            file_ids = None
 
2891
        rqst = make_log_request_dict(
 
2892
            direction=direction, specific_fileids=file_ids,
 
2893
            start_revision=rev1, end_revision=rev2, limit=limit,
 
2894
            message_search=message, delta_type=delta_type,
 
2895
            diff_type=diff_type, _match_using_deltas=match_using_deltas,
 
2896
            exclude_common_ancestry=exclude_common_ancestry, match=match_dict,
 
2897
            signature=signatures, omit_merges=omit_merges,
 
2898
            )
 
2899
        Logger(b, rqst).show(lf)
 
2900
 
 
2901
 
 
2902
def _get_revision_range(revisionspec_list, branch, command_name):
 
2903
    """Take the input of a revision option and turn it into a revision range.
 
2904
 
 
2905
    It returns RevisionInfo objects which can be used to obtain the rev_id's
 
2906
    of the desired revisions. It does some user input validations.
 
2907
    """
 
2908
    if revisionspec_list is None:
 
2909
        rev1 = None
 
2910
        rev2 = None
 
2911
    elif len(revisionspec_list) == 1:
 
2912
        rev1 = rev2 = revisionspec_list[0].in_history(branch)
 
2913
    elif len(revisionspec_list) == 2:
 
2914
        start_spec = revisionspec_list[0]
 
2915
        end_spec = revisionspec_list[1]
 
2916
        if end_spec.get_branch() != start_spec.get_branch():
 
2917
            # b is taken from revision[0].get_branch(), and
 
2918
            # show_log will use its revision_history. Having
 
2919
            # different branches will lead to weird behaviors.
 
2920
            raise errors.BzrCommandError(gettext(
 
2921
                "brz %s doesn't accept two revisions in different"
 
2922
                " branches.") % command_name)
 
2923
        if start_spec.spec is None:
 
2924
            # Avoid loading all the history.
 
2925
            rev1 = RevisionInfo(branch, None, None)
 
2926
        else:
 
2927
            rev1 = start_spec.in_history(branch)
 
2928
        # Avoid loading all of history when we know a missing
 
2929
        # end of range means the last revision ...
 
2930
        if end_spec.spec is None:
 
2931
            last_revno, last_revision_id = branch.last_revision_info()
 
2932
            rev2 = RevisionInfo(branch, last_revno, last_revision_id)
 
2933
        else:
 
2934
            rev2 = end_spec.in_history(branch)
 
2935
    else:
 
2936
        raise errors.BzrCommandError(gettext(
 
2937
            'brz %s --revision takes one or two values.') % command_name)
 
2938
    return rev1, rev2
 
2939
 
 
2940
 
 
2941
def _revision_range_to_revid_range(revision_range):
 
2942
    rev_id1 = None
 
2943
    rev_id2 = None
 
2944
    if revision_range[0] is not None:
 
2945
        rev_id1 = revision_range[0].rev_id
 
2946
    if revision_range[1] is not None:
 
2947
        rev_id2 = revision_range[1].rev_id
 
2948
    return rev_id1, rev_id2
 
2949
 
 
2950
 
 
2951
def get_log_format(long=False, short=False, line=False, default='long'):
 
2952
    log_format = default
 
2953
    if long:
 
2954
        log_format = 'long'
 
2955
    if short:
 
2956
        log_format = 'short'
 
2957
    if line:
 
2958
        log_format = 'line'
 
2959
    return log_format
 
2960
 
 
2961
 
 
2962
class cmd_touching_revisions(Command):
 
2963
    __doc__ = """Return revision-ids which affected a particular file.
 
2964
 
 
2965
    A more user-friendly interface is "brz log FILE".
 
2966
    """
 
2967
 
 
2968
    hidden = True
 
2969
    takes_args = ["filename"]
 
2970
 
 
2971
    @display_command
 
2972
    def run(self, filename):
 
2973
        tree, relpath = WorkingTree.open_containing(filename)
 
2974
        with tree.lock_read():
 
2975
            touching_revs = log.find_touching_revisions(
 
2976
                tree.branch.repository, tree.branch.last_revision(), tree, relpath)
 
2977
            for revno, revision_id, what in reversed(list(touching_revs)):
 
2978
                self.outf.write("%6d %s\n" % (revno, what))
 
2979
 
 
2980
 
 
2981
class cmd_ls(Command):
 
2982
    __doc__ = """List files in a tree.
 
2983
    """
 
2984
 
 
2985
    _see_also = ['status', 'cat']
 
2986
    takes_args = ['path?']
 
2987
    takes_options = [
 
2988
        'verbose',
 
2989
        'revision',
 
2990
        Option('recursive', short_name='R',
 
2991
               help='Recurse into subdirectories.'),
 
2992
        Option('from-root',
 
2993
               help='Print paths relative to the root of the branch.'),
 
2994
        Option('unknown', short_name='u',
 
2995
               help='Print unknown files.'),
 
2996
        Option('versioned', help='Print versioned files.',
 
2997
               short_name='V'),
 
2998
        Option('ignored', short_name='i',
 
2999
               help='Print ignored files.'),
 
3000
        Option('kind', short_name='k',
 
3001
               help=('List entries of a particular kind: file, '
 
3002
                     'directory, symlink, tree-reference.'),
 
3003
               type=str),
 
3004
        'null',
 
3005
        'show-ids',
 
3006
        'directory',
 
3007
        ]
 
3008
 
 
3009
    @display_command
 
3010
    def run(self, revision=None, verbose=False,
 
3011
            recursive=False, from_root=False,
 
3012
            unknown=False, versioned=False, ignored=False,
 
3013
            null=False, kind=None, show_ids=False, path=None, directory=None):
 
3014
 
 
3015
        if kind and kind not in ('file', 'directory', 'symlink', 'tree-reference'):
 
3016
            raise errors.BzrCommandError(gettext('invalid kind specified'))
 
3017
 
 
3018
        if verbose and null:
 
3019
            raise errors.BzrCommandError(
 
3020
                gettext('Cannot set both --verbose and --null'))
 
3021
        all = not (unknown or versioned or ignored)
 
3022
 
 
3023
        selection = {'I': ignored, '?': unknown, 'V': versioned}
 
3024
 
 
3025
        if path is None:
 
3026
            fs_path = '.'
 
3027
        else:
 
3028
            if from_root:
 
3029
                raise errors.BzrCommandError(gettext('cannot specify both --from-root'
 
3030
                                                     ' and PATH'))
 
3031
            fs_path = path
 
3032
        tree, branch, relpath = \
 
3033
            _open_directory_or_containing_tree_or_branch(fs_path, directory)
 
3034
 
 
3035
        # Calculate the prefix to use
 
3036
        prefix = None
 
3037
        if from_root:
 
3038
            if relpath:
 
3039
                prefix = relpath + '/'
 
3040
        elif fs_path != '.' and not fs_path.endswith('/'):
 
3041
            prefix = fs_path + '/'
 
3042
 
 
3043
        if revision is not None or tree is None:
 
3044
            tree = _get_one_revision_tree('ls', revision, branch=branch)
 
3045
 
 
3046
        apply_view = False
 
3047
        if isinstance(tree, WorkingTree) and tree.supports_views():
 
3048
            view_files = tree.views.lookup_view()
 
3049
            if view_files:
 
3050
                apply_view = True
 
3051
                view_str = views.view_display_str(view_files)
 
3052
                note(gettext("Ignoring files outside view. View is %s") % view_str)
 
3053
 
 
3054
        self.enter_context(tree.lock_read())
 
3055
        for fp, fc, fkind, entry in tree.list_files(
 
3056
                include_root=False, from_dir=relpath, recursive=recursive):
 
3057
            # Apply additional masking
 
3058
            if not all and not selection[fc]:
 
3059
                continue
 
3060
            if kind is not None and fkind != kind:
 
3061
                continue
 
3062
            if apply_view:
 
3063
                try:
 
3064
                    if relpath:
 
3065
                        fullpath = osutils.pathjoin(relpath, fp)
 
3066
                    else:
 
3067
                        fullpath = fp
 
3068
                    views.check_path_in_view(tree, fullpath)
 
3069
                except views.FileOutsideView:
 
3070
                    continue
 
3071
 
 
3072
            # Output the entry
 
3073
            if prefix:
 
3074
                fp = osutils.pathjoin(prefix, fp)
 
3075
            kindch = entry.kind_character()
 
3076
            outstring = fp + kindch
 
3077
            ui.ui_factory.clear_term()
 
3078
            if verbose:
 
3079
                outstring = '%-8s %s' % (fc, outstring)
 
3080
                if show_ids and getattr(entry, 'file_id', None) is not None:
 
3081
                    outstring = "%-50s %s" % (outstring, entry.file_id.decode('utf-8'))
 
3082
                self.outf.write(outstring + '\n')
 
3083
            elif null:
 
3084
                self.outf.write(fp + '\0')
 
3085
                if show_ids:
 
3086
                    if getattr(entry, 'file_id', None) is not None:
 
3087
                        self.outf.write(entry.file_id.decode('utf-8'))
 
3088
                    self.outf.write('\0')
 
3089
                self.outf.flush()
 
3090
            else:
 
3091
                if show_ids:
 
3092
                    if getattr(entry, 'file_id', None) is not None:
 
3093
                        my_id = entry.file_id.decode('utf-8')
 
3094
                    else:
 
3095
                        my_id = ''
 
3096
                    self.outf.write('%-50s %s\n' % (outstring, my_id))
 
3097
                else:
 
3098
                    self.outf.write(outstring + '\n')
 
3099
 
 
3100
 
 
3101
class cmd_unknowns(Command):
 
3102
    __doc__ = """List unknown files.
 
3103
    """
 
3104
 
 
3105
    hidden = True
 
3106
    _see_also = ['ls']
 
3107
    takes_options = ['directory']
 
3108
 
 
3109
    @display_command
 
3110
    def run(self, directory=u'.'):
 
3111
        for f in WorkingTree.open_containing(directory)[0].unknowns():
 
3112
            self.outf.write(osutils.quotefn(f) + '\n')
 
3113
 
 
3114
 
 
3115
class cmd_ignore(Command):
 
3116
    __doc__ = """Ignore specified files or patterns.
 
3117
 
 
3118
    See ``brz help patterns`` for details on the syntax of patterns.
 
3119
 
 
3120
    If a .bzrignore file does not exist, the ignore command
 
3121
    will create one and add the specified files or patterns to the newly
 
3122
    created file. The ignore command will also automatically add the
 
3123
    .bzrignore file to be versioned. Creating a .bzrignore file without
 
3124
    the use of the ignore command will require an explicit add command.
 
3125
 
 
3126
    To remove patterns from the ignore list, edit the .bzrignore file.
 
3127
    After adding, editing or deleting that file either indirectly by
 
3128
    using this command or directly by using an editor, be sure to commit
 
3129
    it.
 
3130
 
 
3131
    Breezy also supports a global ignore file ~/.config/breezy/ignore. On
 
3132
    Windows the global ignore file can be found in the application data
 
3133
    directory as
 
3134
    C:\\Documents and Settings\\<user>\\Application Data\\Breezy\\3.0\\ignore.
 
3135
    Global ignores are not touched by this command. The global ignore file
 
3136
    can be edited directly using an editor.
 
3137
 
 
3138
    Patterns prefixed with '!' are exceptions to ignore patterns and take
 
3139
    precedence over regular ignores.  Such exceptions are used to specify
 
3140
    files that should be versioned which would otherwise be ignored.
 
3141
 
 
3142
    Patterns prefixed with '!!' act as regular ignore patterns, but have
 
3143
    precedence over the '!' exception patterns.
 
3144
 
 
3145
    :Notes:
 
3146
 
 
3147
    * Ignore patterns containing shell wildcards must be quoted from
 
3148
      the shell on Unix.
 
3149
 
 
3150
    * Ignore patterns starting with "#" act as comments in the ignore file.
 
3151
      To ignore patterns that begin with that character, use the "RE:" prefix.
 
3152
 
 
3153
    :Examples:
 
3154
        Ignore the top level Makefile::
 
3155
 
 
3156
            brz ignore ./Makefile
 
3157
 
 
3158
        Ignore .class files in all directories...::
 
3159
 
 
3160
            brz ignore "*.class"
 
3161
 
 
3162
        ...but do not ignore "special.class"::
 
3163
 
 
3164
            brz ignore "!special.class"
 
3165
 
 
3166
        Ignore files whose name begins with the "#" character::
 
3167
 
 
3168
            brz ignore "RE:^#"
 
3169
 
 
3170
        Ignore .o files under the lib directory::
 
3171
 
 
3172
            brz ignore "lib/**/*.o"
 
3173
 
 
3174
        Ignore .o files under the lib directory::
 
3175
 
 
3176
            brz ignore "RE:lib/.*\\.o"
 
3177
 
 
3178
        Ignore everything but the "debian" toplevel directory::
 
3179
 
 
3180
            brz ignore "RE:(?!debian/).*"
 
3181
 
 
3182
        Ignore everything except the "local" toplevel directory,
 
3183
        but always ignore autosave files ending in ~, even under local/::
 
3184
 
 
3185
            brz ignore "*"
 
3186
            brz ignore "!./local"
 
3187
            brz ignore "!!*~"
 
3188
    """
 
3189
 
 
3190
    _see_also = ['status', 'ignored', 'patterns']
 
3191
    takes_args = ['name_pattern*']
 
3192
    takes_options = ['directory',
 
3193
                     Option('default-rules',
 
3194
                            help='Display the default ignore rules that brz uses.')
 
3195
                     ]
 
3196
 
 
3197
    def run(self, name_pattern_list=None, default_rules=None,
 
3198
            directory=u'.'):
 
3199
        from breezy import ignores
 
3200
        if default_rules is not None:
 
3201
            # dump the default rules and exit
 
3202
            for pattern in ignores.USER_DEFAULTS:
 
3203
                self.outf.write("%s\n" % pattern)
 
3204
            return
 
3205
        if not name_pattern_list:
 
3206
            raise errors.BzrCommandError(gettext("ignore requires at least one "
 
3207
                                                 "NAME_PATTERN or --default-rules."))
 
3208
        name_pattern_list = [globbing.normalize_pattern(p)
 
3209
                             for p in name_pattern_list]
 
3210
        bad_patterns = ''
 
3211
        bad_patterns_count = 0
 
3212
        for p in name_pattern_list:
 
3213
            if not globbing.Globster.is_pattern_valid(p):
 
3214
                bad_patterns_count += 1
 
3215
                bad_patterns += ('\n  %s' % p)
 
3216
        if bad_patterns:
 
3217
            msg = (ngettext('Invalid ignore pattern found. %s',
 
3218
                            'Invalid ignore patterns found. %s',
 
3219
                            bad_patterns_count) % bad_patterns)
 
3220
            ui.ui_factory.show_error(msg)
 
3221
            raise lazy_regex.InvalidPattern('')
 
3222
        for name_pattern in name_pattern_list:
 
3223
            if (name_pattern[0] == '/' or
 
3224
                    (len(name_pattern) > 1 and name_pattern[1] == ':')):
 
3225
                raise errors.BzrCommandError(gettext(
 
3226
                    "NAME_PATTERN should not be an absolute path"))
 
3227
        tree, relpath = WorkingTree.open_containing(directory)
 
3228
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
 
3229
        ignored = globbing.Globster(name_pattern_list)
 
3230
        matches = []
 
3231
        self.enter_context(tree.lock_read())
 
3232
        for filename, fc, fkind, entry in tree.list_files():
 
3233
            id = getattr(entry, 'file_id', None)
 
3234
            if id is not None:
 
3235
                if ignored.match(filename):
 
3236
                    matches.append(filename)
 
3237
        if len(matches) > 0:
 
3238
            self.outf.write(gettext("Warning: the following files are version "
 
3239
                                    "controlled and match your ignore pattern:\n%s"
 
3240
                                    "\nThese files will continue to be version controlled"
 
3241
                                    " unless you 'brz remove' them.\n") % ("\n".join(matches),))
 
3242
 
 
3243
 
 
3244
class cmd_ignored(Command):
 
3245
    __doc__ = """List ignored files and the patterns that matched them.
 
3246
 
 
3247
    List all the ignored files and the ignore pattern that caused the file to
 
3248
    be ignored.
 
3249
 
 
3250
    Alternatively, to list just the files::
 
3251
 
 
3252
        brz ls --ignored
 
3253
    """
 
3254
 
 
3255
    encoding_type = 'replace'
 
3256
    _see_also = ['ignore', 'ls']
 
3257
    takes_options = ['directory']
 
3258
 
 
3259
    @display_command
 
3260
    def run(self, directory=u'.'):
 
3261
        tree = WorkingTree.open_containing(directory)[0]
 
3262
        self.enter_context(tree.lock_read())
 
3263
        for path, file_class, kind, entry in tree.list_files():
 
3264
            if file_class != 'I':
 
3265
                continue
 
3266
            # XXX: Slightly inefficient since this was already calculated
 
3267
            pat = tree.is_ignored(path)
 
3268
            self.outf.write('%-50s %s\n' % (path, pat))
 
3269
 
 
3270
 
 
3271
class cmd_lookup_revision(Command):
 
3272
    __doc__ = """Lookup the revision-id from a revision-number
 
3273
 
 
3274
    :Examples:
 
3275
        brz lookup-revision 33
 
3276
    """
 
3277
    hidden = True
 
3278
    takes_args = ['revno']
 
3279
    takes_options = ['directory']
 
3280
 
 
3281
    @display_command
 
3282
    def run(self, revno, directory=u'.'):
 
3283
        try:
 
3284
            revno = int(revno)
 
3285
        except ValueError:
 
3286
            raise errors.BzrCommandError(gettext("not a valid revision-number: %r")
 
3287
                                         % revno)
 
3288
        revid = WorkingTree.open_containing(
 
3289
            directory)[0].branch.get_rev_id(revno)
 
3290
        self.outf.write("%s\n" % revid.decode('utf-8'))
 
3291
 
 
3292
 
 
3293
class cmd_export(Command):
 
3294
    __doc__ = """Export current or past revision to a destination directory or archive.
 
3295
 
 
3296
    If no revision is specified this exports the last committed revision.
 
3297
 
 
3298
    Format may be an "exporter" name, such as tar, tgz, tbz2.  If none is
 
3299
    given, try to find the format with the extension. If no extension
 
3300
    is found exports to a directory (equivalent to --format=dir).
 
3301
 
 
3302
    If root is supplied, it will be used as the root directory inside
 
3303
    container formats (tar, zip, etc). If it is not supplied it will default
 
3304
    to the exported filename. The root option has no effect for 'dir' format.
 
3305
 
 
3306
    If branch is omitted then the branch containing the current working
 
3307
    directory will be used.
 
3308
 
 
3309
    Note: Export of tree with non-ASCII filenames to zip is not supported.
 
3310
 
 
3311
      =================       =========================
 
3312
      Supported formats       Autodetected by extension
 
3313
      =================       =========================
 
3314
         dir                         (none)
 
3315
         tar                          .tar
 
3316
         tbz2                    .tar.bz2, .tbz2
 
3317
         tgz                      .tar.gz, .tgz
 
3318
         zip                          .zip
 
3319
      =================       =========================
 
3320
    """
 
3321
    encoding = 'exact'
 
3322
    encoding_type = 'exact'
 
3323
    takes_args = ['dest', 'branch_or_subdir?']
 
3324
    takes_options = ['directory',
 
3325
                     Option('format',
 
3326
                            help="Type of file to export to.",
 
3327
                            type=str),
 
3328
                     'revision',
 
3329
                     Option('filters', help='Apply content filters to export the '
 
3330
                            'convenient form.'),
 
3331
                     Option('root',
 
3332
                            type=str,
 
3333
                            help="Name of the root directory inside the exported file."),
 
3334
                     Option('per-file-timestamps',
 
3335
                            help='Set modification time of files to that of the last '
 
3336
                            'revision in which it was changed.'),
 
3337
                     Option('uncommitted',
 
3338
                            help='Export the working tree contents rather than that of the '
 
3339
                            'last revision.'),
 
3340
                     ]
 
3341
 
 
3342
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
 
3343
            root=None, filters=False, per_file_timestamps=False, uncommitted=False,
 
3344
            directory=u'.'):
 
3345
        from .export import export, guess_format, get_root_name
 
3346
 
 
3347
        if branch_or_subdir is None:
 
3348
            branch_or_subdir = directory
 
3349
 
 
3350
        (tree, b, subdir) = controldir.ControlDir.open_containing_tree_or_branch(
 
3351
            branch_or_subdir)
 
3352
        if tree is not None:
 
3353
            self.enter_context(tree.lock_read())
 
3354
 
 
3355
        if uncommitted:
 
3356
            if tree is None:
 
3357
                raise errors.BzrCommandError(
 
3358
                    gettext("--uncommitted requires a working tree"))
 
3359
            export_tree = tree
 
3360
        else:
 
3361
            export_tree = _get_one_revision_tree(
 
3362
                'export', revision, branch=b,
 
3363
                tree=tree)
 
3364
 
 
3365
        if format is None:
 
3366
            format = guess_format(dest)
 
3367
 
 
3368
        if root is None:
 
3369
            root = get_root_name(dest)
 
3370
 
 
3371
        if not per_file_timestamps:
 
3372
            force_mtime = time.time()
 
3373
        else:
 
3374
            force_mtime = None
 
3375
 
 
3376
        if filters:
 
3377
            from breezy.filter_tree import ContentFilterTree
 
3378
            export_tree = ContentFilterTree(
 
3379
                export_tree, export_tree._content_filter_stack)
 
3380
 
 
3381
        try:
 
3382
            export(export_tree, dest, format, root, subdir,
 
3383
                   per_file_timestamps=per_file_timestamps)
 
3384
        except errors.NoSuchExportFormat as e:
 
3385
            raise errors.BzrCommandError(
 
3386
                gettext('Unsupported export format: %s') % e.format)
 
3387
 
 
3388
 
 
3389
class cmd_cat(Command):
 
3390
    __doc__ = """Write the contents of a file as of a given revision to standard output.
 
3391
 
 
3392
    If no revision is nominated, the last revision is used.
 
3393
 
 
3394
    Note: Take care to redirect standard output when using this command on a
 
3395
    binary file.
 
3396
    """
 
3397
 
 
3398
    _see_also = ['ls']
 
3399
    takes_options = ['directory',
 
3400
                     Option('name-from-revision',
 
3401
                            help='The path name in the old tree.'),
 
3402
                     Option('filters', help='Apply content filters to display the '
 
3403
                            'convenience form.'),
 
3404
                     'revision',
 
3405
                     ]
 
3406
    takes_args = ['filename']
 
3407
    encoding_type = 'exact'
 
3408
 
 
3409
    @display_command
 
3410
    def run(self, filename, revision=None, name_from_revision=False,
 
3411
            filters=False, directory=None):
 
3412
        if revision is not None and len(revision) != 1:
 
3413
            raise errors.BzrCommandError(gettext("brz cat --revision takes exactly"
 
3414
                                                 " one revision specifier"))
 
3415
        tree, branch, relpath = \
 
3416
            _open_directory_or_containing_tree_or_branch(filename, directory)
 
3417
        self.enter_context(branch.lock_read())
 
3418
        return self._run(tree, branch, relpath, filename, revision,
 
3419
                         name_from_revision, filters)
 
3420
 
 
3421
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
 
3422
             filtered):
 
3423
        import shutil
 
3424
        if tree is None:
 
3425
            tree = b.basis_tree()
 
3426
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
 
3427
        self.enter_context(rev_tree.lock_read())
 
3428
 
 
3429
        if name_from_revision:
 
3430
            # Try in revision if requested
 
3431
            if not rev_tree.is_versioned(relpath):
 
3432
                raise errors.BzrCommandError(gettext(
 
3433
                    "{0!r} is not present in revision {1}").format(
 
3434
                        filename, rev_tree.get_revision_id()))
 
3435
            rev_tree_path = relpath
 
3436
        else:
 
3437
            try:
 
3438
                rev_tree_path = _mod_tree.find_previous_path(
 
3439
                    tree, rev_tree, relpath)
 
3440
            except errors.NoSuchFile:
 
3441
                rev_tree_path = None
 
3442
 
 
3443
            if rev_tree_path is None:
 
3444
                # Path didn't exist in working tree
 
3445
                if not rev_tree.is_versioned(relpath):
 
3446
                    raise errors.BzrCommandError(gettext(
 
3447
                        "{0!r} is not present in revision {1}").format(
 
3448
                            filename, rev_tree.get_revision_id()))
 
3449
                else:
 
3450
                    # Fall back to the same path in the basis tree, if present.
 
3451
                    rev_tree_path = relpath
 
3452
 
 
3453
        if filtered:
 
3454
            from .filter_tree import ContentFilterTree
 
3455
            filter_tree = ContentFilterTree(
 
3456
                rev_tree, rev_tree._content_filter_stack)
 
3457
            fileobj = filter_tree.get_file(rev_tree_path)
 
3458
        else:
 
3459
            fileobj = rev_tree.get_file(rev_tree_path)
 
3460
        shutil.copyfileobj(fileobj, self.outf)
 
3461
        self.cleanup_now()
 
3462
 
 
3463
 
 
3464
class cmd_local_time_offset(Command):
 
3465
    __doc__ = """Show the offset in seconds from GMT to local time."""
 
3466
    hidden = True
 
3467
 
 
3468
    @display_command
 
3469
    def run(self):
 
3470
        self.outf.write("%s\n" % osutils.local_time_offset())
 
3471
 
 
3472
 
 
3473
class cmd_commit(Command):
 
3474
    __doc__ = """Commit changes into a new revision.
 
3475
 
 
3476
    An explanatory message needs to be given for each commit. This is
 
3477
    often done by using the --message option (getting the message from the
 
3478
    command line) or by using the --file option (getting the message from
 
3479
    a file). If neither of these options is given, an editor is opened for
 
3480
    the user to enter the message. To see the changed files in the
 
3481
    boilerplate text loaded into the editor, use the --show-diff option.
 
3482
 
 
3483
    By default, the entire tree is committed and the person doing the
 
3484
    commit is assumed to be the author. These defaults can be overridden
 
3485
    as explained below.
 
3486
 
 
3487
    :Selective commits:
 
3488
 
 
3489
      If selected files are specified, only changes to those files are
 
3490
      committed.  If a directory is specified then the directory and
 
3491
      everything within it is committed.
 
3492
 
 
3493
      When excludes are given, they take precedence over selected files.
 
3494
      For example, to commit only changes within foo, but not changes
 
3495
      within foo/bar::
 
3496
 
 
3497
        brz commit foo -x foo/bar
 
3498
 
 
3499
      A selective commit after a merge is not yet supported.
 
3500
 
 
3501
    :Custom authors:
 
3502
 
 
3503
      If the author of the change is not the same person as the committer,
 
3504
      you can specify the author's name using the --author option. The
 
3505
      name should be in the same format as a committer-id, e.g.
 
3506
      "John Doe <jdoe@example.com>". If there is more than one author of
 
3507
      the change you can specify the option multiple times, once for each
 
3508
      author.
 
3509
 
 
3510
    :Checks:
 
3511
 
 
3512
      A common mistake is to forget to add a new file or directory before
 
3513
      running the commit command. The --strict option checks for unknown
 
3514
      files and aborts the commit if any are found. More advanced pre-commit
 
3515
      checks can be implemented by defining hooks. See ``brz help hooks``
 
3516
      for details.
 
3517
 
 
3518
    :Things to note:
 
3519
 
 
3520
      If you accidentally commit the wrong changes or make a spelling
 
3521
      mistake in the commit message say, you can use the uncommit command
 
3522
      to undo it. See ``brz help uncommit`` for details.
 
3523
 
 
3524
      Hooks can also be configured to run after a commit. This allows you
 
3525
      to trigger updates to external systems like bug trackers. The --fixes
 
3526
      option can be used to record the association between a revision and
 
3527
      one or more bugs. See ``brz help bugs`` for details.
 
3528
    """
 
3529
 
 
3530
    _see_also = ['add', 'bugs', 'hooks', 'uncommit']
 
3531
    takes_args = ['selected*']
 
3532
    takes_options = [
 
3533
        ListOption(
 
3534
            'exclude', type=str, short_name='x',
 
3535
            help="Do not consider changes made to a given path."),
 
3536
        Option('message', type=str,
 
3537
               short_name='m',
 
3538
               help="Description of the new revision."),
 
3539
        'verbose',
 
3540
        Option('unchanged',
 
3541
               help='Commit even if nothing has changed.'),
 
3542
        Option('file', type=str,
 
3543
               short_name='F',
 
3544
               argname='msgfile',
 
3545
               help='Take commit message from this file.'),
 
3546
        Option('strict',
 
3547
               help="Refuse to commit if there are unknown "
 
3548
               "files in the working tree."),
 
3549
        Option('commit-time', type=str,
 
3550
               help="Manually set a commit time using commit date "
 
3551
               "format, e.g. '2009-10-10 08:00:00 +0100'."),
 
3552
        ListOption(
 
3553
            'bugs', type=str,
 
3554
            help="Link to a related bug. (see \"brz help bugs\")."),
 
3555
        ListOption(
 
3556
            'fixes', type=str,
 
3557
            help="Mark a bug as being fixed by this revision "
 
3558
                 "(see \"brz help bugs\")."),
 
3559
        ListOption(
 
3560
            'author', type=str,
 
3561
            help="Set the author's name, if it's different "
 
3562
                 "from the committer."),
 
3563
        Option('local',
 
3564
               help="Perform a local commit in a bound "
 
3565
                    "branch.  Local commits are not pushed to "
 
3566
                    "the master branch until a normal commit "
 
3567
                    "is performed."
 
3568
               ),
 
3569
        Option('show-diff', short_name='p',
 
3570
               help='When no message is supplied, show the diff along'
 
3571
               ' with the status summary in the message editor.'),
 
3572
        Option('lossy',
 
3573
               help='When committing to a foreign version control '
 
3574
               'system do not push data that can not be natively '
 
3575
               'represented.'), ]
 
3576
    aliases = ['ci', 'checkin']
 
3577
 
 
3578
    def _iter_bug_urls(self, bugs, branch, status):
 
3579
        default_bugtracker = None
 
3580
        # Configure the properties for bug fixing attributes.
 
3581
        for bug in bugs:
 
3582
            tokens = bug.split(':')
 
3583
            if len(tokens) == 1:
 
3584
                if default_bugtracker is None:
 
3585
                    branch_config = branch.get_config_stack()
 
3586
                    default_bugtracker = branch_config.get(
 
3587
                        "bugtracker")
 
3588
                if default_bugtracker is None:
 
3589
                    raise errors.BzrCommandError(gettext(
 
3590
                        "No tracker specified for bug %s. Use the form "
 
3591
                        "'tracker:id' or specify a default bug tracker "
 
3592
                        "using the `bugtracker` option.\nSee "
 
3593
                        "\"brz help bugs\" for more information on this "
 
3594
                        "feature. Commit refused.") % bug)
 
3595
                tag = default_bugtracker
 
3596
                bug_id = tokens[0]
 
3597
            elif len(tokens) != 2:
 
3598
                raise errors.BzrCommandError(gettext(
 
3599
                    "Invalid bug %s. Must be in the form of 'tracker:id'. "
 
3600
                    "See \"brz help bugs\" for more information on this "
 
3601
                    "feature.\nCommit refused.") % bug)
 
3602
            else:
 
3603
                tag, bug_id = tokens
 
3604
            try:
 
3605
                yield bugtracker.get_bug_url(tag, branch, bug_id), status
 
3606
            except bugtracker.UnknownBugTrackerAbbreviation:
 
3607
                raise errors.BzrCommandError(gettext(
 
3608
                    'Unrecognized bug %s. Commit refused.') % bug)
 
3609
            except bugtracker.MalformedBugIdentifier as e:
 
3610
                raise errors.BzrCommandError(gettext(
 
3611
                    u"%s\nCommit refused.") % (e,))
 
3612
 
 
3613
    def run(self, message=None, file=None, verbose=False, selected_list=None,
 
3614
            unchanged=False, strict=False, local=False, fixes=None, bugs=None,
 
3615
            author=None, show_diff=False, exclude=None, commit_time=None,
 
3616
            lossy=False):
 
3617
        import itertools
 
3618
        from .commit import (
 
3619
            PointlessCommit,
 
3620
            )
 
3621
        from .errors import (
 
3622
            ConflictsInTree,
 
3623
            StrictCommitFailed
 
3624
        )
 
3625
        from .msgeditor import (
 
3626
            edit_commit_message_encoded,
 
3627
            generate_commit_message_template,
 
3628
            make_commit_message_template_encoded,
 
3629
            set_commit_message,
 
3630
        )
 
3631
 
 
3632
        commit_stamp = offset = None
 
3633
        if commit_time is not None:
 
3634
            try:
 
3635
                commit_stamp, offset = timestamp.parse_patch_date(commit_time)
 
3636
            except ValueError as e:
 
3637
                raise errors.BzrCommandError(gettext(
 
3638
                    "Could not parse --commit-time: " + str(e)))
 
3639
 
 
3640
        properties = {}
 
3641
 
 
3642
        tree, selected_list = WorkingTree.open_containing_paths(selected_list)
 
3643
        if selected_list == ['']:
 
3644
            # workaround - commit of root of tree should be exactly the same
 
3645
            # as just default commit in that tree, and succeed even though
 
3646
            # selected-file merge commit is not done yet
 
3647
            selected_list = []
 
3648
 
 
3649
        if fixes is None:
 
3650
            fixes = []
 
3651
        if bugs is None:
 
3652
            bugs = []
 
3653
        bug_property = bugtracker.encode_fixes_bug_urls(
 
3654
            itertools.chain(
 
3655
                self._iter_bug_urls(bugs, tree.branch, bugtracker.RELATED),
 
3656
                self._iter_bug_urls(fixes, tree.branch, bugtracker.FIXED)))
 
3657
        if bug_property:
 
3658
            properties[u'bugs'] = bug_property
 
3659
 
 
3660
        if local and not tree.branch.get_bound_location():
 
3661
            raise errors.LocalRequiresBoundBranch()
 
3662
 
 
3663
        if message is not None:
 
3664
            try:
 
3665
                file_exists = osutils.lexists(message)
 
3666
            except UnicodeError:
 
3667
                # The commit message contains unicode characters that can't be
 
3668
                # represented in the filesystem encoding, so that can't be a
 
3669
                # file.
 
3670
                file_exists = False
 
3671
            if file_exists:
 
3672
                warning_msg = (
 
3673
                    'The commit message is a file name: "%(f)s".\n'
 
3674
                    '(use --file "%(f)s" to take commit message from that file)'
 
3675
                    % {'f': message})
 
3676
                ui.ui_factory.show_warning(warning_msg)
 
3677
            if '\r' in message:
 
3678
                message = message.replace('\r\n', '\n')
 
3679
                message = message.replace('\r', '\n')
 
3680
            if file:
 
3681
                raise errors.BzrCommandError(gettext(
 
3682
                    "please specify either --message or --file"))
 
3683
 
 
3684
        def get_message(commit_obj):
 
3685
            """Callback to get commit message"""
 
3686
            if file:
 
3687
                with open(file, 'rb') as f:
 
3688
                    my_message = f.read().decode(osutils.get_user_encoding())
 
3689
            elif message is not None:
 
3690
                my_message = message
 
3691
            else:
 
3692
                # No message supplied: make one up.
 
3693
                # text is the status of the tree
 
3694
                text = make_commit_message_template_encoded(tree,
 
3695
                                                            selected_list, diff=show_diff,
 
3696
                                                            output_encoding=osutils.get_user_encoding())
 
3697
                # start_message is the template generated from hooks
 
3698
                # XXX: Warning - looks like hooks return unicode,
 
3699
                # make_commit_message_template_encoded returns user encoding.
 
3700
                # We probably want to be using edit_commit_message instead to
 
3701
                # avoid this.
 
3702
                my_message = set_commit_message(commit_obj)
 
3703
                if my_message is None:
 
3704
                    start_message = generate_commit_message_template(
 
3705
                        commit_obj)
 
3706
                    if start_message is not None:
 
3707
                        start_message = start_message.encode(
 
3708
                            osutils.get_user_encoding())
 
3709
                    my_message = edit_commit_message_encoded(text,
 
3710
                                                             start_message=start_message)
 
3711
                if my_message is None:
 
3712
                    raise errors.BzrCommandError(gettext("please specify a commit"
 
3713
                                                         " message with either --message or --file"))
 
3714
                if my_message == "":
 
3715
                    raise errors.BzrCommandError(gettext("Empty commit message specified."
 
3716
                                                         " Please specify a commit message with either"
 
3717
                                                         " --message or --file or leave a blank message"
 
3718
                                                         " with --message \"\"."))
 
3719
            return my_message
 
3720
 
 
3721
        # The API permits a commit with a filter of [] to mean 'select nothing'
 
3722
        # but the command line should not do that.
 
3723
        if not selected_list:
 
3724
            selected_list = None
 
3725
        try:
 
3726
            tree.commit(message_callback=get_message,
 
3727
                        specific_files=selected_list,
 
3728
                        allow_pointless=unchanged, strict=strict, local=local,
 
3729
                        reporter=None, verbose=verbose, revprops=properties,
 
3730
                        authors=author, timestamp=commit_stamp,
 
3731
                        timezone=offset,
 
3732
                        exclude=tree.safe_relpath_files(exclude),
 
3733
                        lossy=lossy)
 
3734
        except PointlessCommit:
 
3735
            raise errors.BzrCommandError(gettext("No changes to commit."
 
3736
                                                 " Please 'brz add' the files you want to commit, or use"
 
3737
                                                 " --unchanged to force an empty commit."))
 
3738
        except ConflictsInTree:
 
3739
            raise errors.BzrCommandError(gettext('Conflicts detected in working '
 
3740
                                                 'tree.  Use "brz conflicts" to list, "brz resolve FILE" to'
 
3741
                                                 ' resolve.'))
 
3742
        except StrictCommitFailed:
 
3743
            raise errors.BzrCommandError(gettext("Commit refused because there are"
 
3744
                                                 " unknown files in the working tree."))
 
3745
        except errors.BoundBranchOutOfDate as e:
 
3746
            e.extra_help = (gettext("\n"
 
3747
                                    'To commit to master branch, run update and then commit.\n'
 
3748
                                    'You can also pass --local to commit to continue working '
 
3749
                                    'disconnected.'))
 
3750
            raise
 
3751
 
 
3752
 
 
3753
class cmd_check(Command):
 
3754
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
3755
 
 
3756
    This command checks various invariants about branch and repository storage
 
3757
    to detect data corruption or brz bugs.
 
3758
 
 
3759
    The working tree and branch checks will only give output if a problem is
 
3760
    detected. The output fields of the repository check are:
 
3761
 
 
3762
    revisions
 
3763
        This is just the number of revisions checked.  It doesn't
 
3764
        indicate a problem.
 
3765
 
 
3766
    versionedfiles
 
3767
        This is just the number of versionedfiles checked.  It
 
3768
        doesn't indicate a problem.
 
3769
 
 
3770
    unreferenced ancestors
 
3771
        Texts that are ancestors of other texts, but
 
3772
        are not properly referenced by the revision ancestry.  This is a
 
3773
        subtle problem that Breezy can work around.
 
3774
 
 
3775
    unique file texts
 
3776
        This is the total number of unique file contents
 
3777
        seen in the checked revisions.  It does not indicate a problem.
 
3778
 
 
3779
    repeated file texts
 
3780
        This is the total number of repeated texts seen
 
3781
        in the checked revisions.  Texts can be repeated when their file
 
3782
        entries are modified, but the file contents are not.  It does not
 
3783
        indicate a problem.
 
3784
 
 
3785
    If no restrictions are specified, all data that is found at the given
 
3786
    location will be checked.
 
3787
 
 
3788
    :Examples:
 
3789
 
 
3790
        Check the tree and branch at 'foo'::
 
3791
 
 
3792
            brz check --tree --branch foo
 
3793
 
 
3794
        Check only the repository at 'bar'::
 
3795
 
 
3796
            brz check --repo bar
 
3797
 
 
3798
        Check everything at 'baz'::
 
3799
 
 
3800
            brz check baz
 
3801
    """
 
3802
 
 
3803
    _see_also = ['reconcile']
 
3804
    takes_args = ['path?']
 
3805
    takes_options = ['verbose',
 
3806
                     Option('branch', help="Check the branch related to the"
 
3807
                                           " current directory."),
 
3808
                     Option('repo', help="Check the repository related to the"
 
3809
                                         " current directory."),
 
3810
                     Option('tree', help="Check the working tree related to"
 
3811
                                         " the current directory.")]
 
3812
 
 
3813
    def run(self, path=None, verbose=False, branch=False, repo=False,
 
3814
            tree=False):
 
3815
        from .check import check_dwim
 
3816
        if path is None:
 
3817
            path = '.'
 
3818
        if not branch and not repo and not tree:
 
3819
            branch = repo = tree = True
 
3820
        check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
 
3821
 
 
3822
 
 
3823
class cmd_upgrade(Command):
 
3824
    __doc__ = """Upgrade a repository, branch or working tree to a newer format.
 
3825
 
 
3826
    When the default format has changed after a major new release of
 
3827
    Bazaar/Breezy, you may be informed during certain operations that you
 
3828
    should upgrade. Upgrading to a newer format may improve performance
 
3829
    or make new features available. It may however limit interoperability
 
3830
    with older repositories or with older versions of Bazaar or Breezy.
 
3831
 
 
3832
    If you wish to upgrade to a particular format rather than the
 
3833
    current default, that can be specified using the --format option.
 
3834
    As a consequence, you can use the upgrade command this way to
 
3835
    "downgrade" to an earlier format, though some conversions are
 
3836
    a one way process (e.g. changing from the 1.x default to the
 
3837
    2.x default) so downgrading is not always possible.
 
3838
 
 
3839
    A backup.bzr.~#~ directory is created at the start of the conversion
 
3840
    process (where # is a number). By default, this is left there on
 
3841
    completion. If the conversion fails, delete the new .bzr directory
 
3842
    and rename this one back in its place. Use the --clean option to ask
 
3843
    for the backup.bzr directory to be removed on successful conversion.
 
3844
    Alternatively, you can delete it by hand if everything looks good
 
3845
    afterwards.
 
3846
 
 
3847
    If the location given is a shared repository, dependent branches
 
3848
    are also converted provided the repository converts successfully.
 
3849
    If the conversion of a branch fails, remaining branches are still
 
3850
    tried.
 
3851
 
 
3852
    For more information on upgrades, see the Breezy Upgrade Guide,
 
3853
    https://www.breezy-vcs.org/doc/en/upgrade-guide/.
 
3854
    """
 
3855
 
 
3856
    _see_also = ['check', 'reconcile', 'formats']
 
3857
    takes_args = ['url?']
 
3858
    takes_options = [
 
3859
        RegistryOption('format',
 
3860
                       help='Upgrade to a specific format.  See "brz help'
 
3861
                       ' formats" for details.',
 
3862
                       lazy_registry=('breezy.controldir', 'format_registry'),
 
3863
                       converter=lambda name: controldir.format_registry.make_controldir(
 
3864
                           name),
 
3865
                       value_switches=True, title='Branch format'),
 
3866
        Option('clean',
 
3867
               help='Remove the backup.bzr directory if successful.'),
 
3868
        Option('dry-run',
 
3869
               help="Show what would be done, but don't actually do anything."),
 
3870
    ]
 
3871
 
 
3872
    def run(self, url='.', format=None, clean=False, dry_run=False):
 
3873
        from .upgrade import upgrade
 
3874
        exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
 
3875
        if exceptions:
 
3876
            if len(exceptions) == 1:
 
3877
                # Compatibility with historical behavior
 
3878
                raise exceptions[0]
 
3879
            else:
 
3880
                return 3
 
3881
 
 
3882
 
 
3883
class cmd_whoami(Command):
 
3884
    __doc__ = """Show or set brz user id.
 
3885
 
 
3886
    :Examples:
 
3887
        Show the email of the current user::
 
3888
 
 
3889
            brz whoami --email
 
3890
 
 
3891
        Set the current user::
 
3892
 
 
3893
            brz whoami "Frank Chu <fchu@example.com>"
 
3894
    """
 
3895
    takes_options = ['directory',
 
3896
                     Option('email',
 
3897
                            help='Display email address only.'),
 
3898
                     Option('branch',
 
3899
                            help='Set identity for the current branch instead of '
 
3900
                            'globally.'),
 
3901
                     ]
 
3902
    takes_args = ['name?']
 
3903
    encoding_type = 'replace'
 
3904
 
 
3905
    @display_command
 
3906
    def run(self, email=False, branch=False, name=None, directory=None):
 
3907
        if name is None:
 
3908
            if directory is None:
 
3909
                # use branch if we're inside one; otherwise global config
 
3910
                try:
 
3911
                    c = Branch.open_containing(u'.')[0].get_config_stack()
 
3912
                except errors.NotBranchError:
 
3913
                    c = _mod_config.GlobalStack()
 
3914
            else:
 
3915
                c = Branch.open(directory).get_config_stack()
 
3916
            identity = c.get('email')
 
3917
            if email:
 
3918
                self.outf.write(_mod_config.extract_email_address(identity)
 
3919
                                + '\n')
 
3920
            else:
 
3921
                self.outf.write(identity + '\n')
 
3922
            return
 
3923
 
 
3924
        if email:
 
3925
            raise errors.BzrCommandError(gettext("--email can only be used to display existing "
 
3926
                                                 "identity"))
 
3927
 
 
3928
        # display a warning if an email address isn't included in the given name.
 
3929
        try:
 
3930
            _mod_config.extract_email_address(name)
 
3931
        except _mod_config.NoEmailInUsername:
 
3932
            warning('"%s" does not seem to contain an email address.  '
 
3933
                    'This is allowed, but not recommended.', name)
 
3934
 
 
3935
        # use global config unless --branch given
 
3936
        if branch:
 
3937
            if directory is None:
 
3938
                c = Branch.open_containing(u'.')[0].get_config_stack()
 
3939
            else:
 
3940
                b = Branch.open(directory)
 
3941
                self.enter_context(b.lock_write())
 
3942
                c = b.get_config_stack()
 
3943
        else:
 
3944
            c = _mod_config.GlobalStack()
 
3945
        c.set('email', name)
 
3946
 
 
3947
 
 
3948
class cmd_nick(Command):
 
3949
    __doc__ = """Print or set the branch nickname.
 
3950
 
 
3951
    If unset, the colocated branch name is used for colocated branches, and
 
3952
    the branch directory name is used for other branches.  To print the
 
3953
    current nickname, execute with no argument.
 
3954
 
 
3955
    Bound branches use the nickname of its master branch unless it is set
 
3956
    locally.
 
3957
    """
 
3958
 
 
3959
    _see_also = ['info']
 
3960
    takes_args = ['nickname?']
 
3961
    takes_options = ['directory']
 
3962
 
 
3963
    def run(self, nickname=None, directory=u'.'):
 
3964
        branch = Branch.open_containing(directory)[0]
 
3965
        if nickname is None:
 
3966
            self.printme(branch)
 
3967
        else:
 
3968
            branch.nick = nickname
 
3969
 
 
3970
    @display_command
 
3971
    def printme(self, branch):
 
3972
        self.outf.write('%s\n' % branch.nick)
 
3973
 
 
3974
 
 
3975
class cmd_alias(Command):
 
3976
    __doc__ = """Set/unset and display aliases.
 
3977
 
 
3978
    :Examples:
 
3979
        Show the current aliases::
 
3980
 
 
3981
            brz alias
 
3982
 
 
3983
        Show the alias specified for 'll'::
 
3984
 
 
3985
            brz alias ll
 
3986
 
 
3987
        Set an alias for 'll'::
 
3988
 
 
3989
            brz alias ll="log --line -r-10..-1"
 
3990
 
 
3991
        To remove an alias for 'll'::
 
3992
 
 
3993
            brz alias --remove ll
 
3994
 
 
3995
    """
 
3996
    takes_args = ['name?']
 
3997
    takes_options = [
 
3998
        Option('remove', help='Remove the alias.'),
 
3999
        ]
 
4000
 
 
4001
    def run(self, name=None, remove=False):
 
4002
        if remove:
 
4003
            self.remove_alias(name)
 
4004
        elif name is None:
 
4005
            self.print_aliases()
 
4006
        else:
 
4007
            equal_pos = name.find('=')
 
4008
            if equal_pos == -1:
 
4009
                self.print_alias(name)
 
4010
            else:
 
4011
                self.set_alias(name[:equal_pos], name[equal_pos + 1:])
 
4012
 
 
4013
    def remove_alias(self, alias_name):
 
4014
        if alias_name is None:
 
4015
            raise errors.BzrCommandError(gettext(
 
4016
                'brz alias --remove expects an alias to remove.'))
 
4017
        # If alias is not found, print something like:
 
4018
        # unalias: foo: not found
 
4019
        c = _mod_config.GlobalConfig()
 
4020
        c.unset_alias(alias_name)
 
4021
 
 
4022
    @display_command
 
4023
    def print_aliases(self):
 
4024
        """Print out the defined aliases in a similar format to bash."""
 
4025
        aliases = _mod_config.GlobalConfig().get_aliases()
 
4026
        for key, value in sorted(aliases.items()):
 
4027
            self.outf.write('brz alias %s="%s"\n' % (key, value))
 
4028
 
 
4029
    @display_command
 
4030
    def print_alias(self, alias_name):
 
4031
        from .commands import get_alias
 
4032
        alias = get_alias(alias_name)
 
4033
        if alias is None:
 
4034
            self.outf.write("brz alias: %s: not found\n" % alias_name)
 
4035
        else:
 
4036
            self.outf.write(
 
4037
                'brz alias %s="%s"\n' % (alias_name, ' '.join(alias)))
 
4038
 
 
4039
    def set_alias(self, alias_name, alias_command):
 
4040
        """Save the alias in the global config."""
 
4041
        c = _mod_config.GlobalConfig()
 
4042
        c.set_alias(alias_name, alias_command)
 
4043
 
 
4044
 
 
4045
class cmd_selftest(Command):
 
4046
    __doc__ = """Run internal test suite.
 
4047
 
 
4048
    If arguments are given, they are regular expressions that say which tests
 
4049
    should run.  Tests matching any expression are run, and other tests are
 
4050
    not run.
 
4051
 
 
4052
    Alternatively if --first is given, matching tests are run first and then
 
4053
    all other tests are run.  This is useful if you have been working in a
 
4054
    particular area, but want to make sure nothing else was broken.
 
4055
 
 
4056
    If --exclude is given, tests that match that regular expression are
 
4057
    excluded, regardless of whether they match --first or not.
 
4058
 
 
4059
    To help catch accidential dependencies between tests, the --randomize
 
4060
    option is useful. In most cases, the argument used is the word 'now'.
 
4061
    Note that the seed used for the random number generator is displayed
 
4062
    when this option is used. The seed can be explicitly passed as the
 
4063
    argument to this option if required. This enables reproduction of the
 
4064
    actual ordering used if and when an order sensitive problem is encountered.
 
4065
 
 
4066
    If --list-only is given, the tests that would be run are listed. This is
 
4067
    useful when combined with --first, --exclude and/or --randomize to
 
4068
    understand their impact. The test harness reports "Listed nn tests in ..."
 
4069
    instead of "Ran nn tests in ..." when list mode is enabled.
 
4070
 
 
4071
    If the global option '--no-plugins' is given, plugins are not loaded
 
4072
    before running the selftests.  This has two effects: features provided or
 
4073
    modified by plugins will not be tested, and tests provided by plugins will
 
4074
    not be run.
 
4075
 
 
4076
    Tests that need working space on disk use a common temporary directory,
 
4077
    typically inside $TMPDIR or /tmp.
 
4078
 
 
4079
    If you set BRZ_TEST_PDB=1 when running selftest, failing tests will drop
 
4080
    into a pdb postmortem session.
 
4081
 
 
4082
    The --coverage=DIRNAME global option produces a report with covered code
 
4083
    indicated.
 
4084
 
 
4085
    :Examples:
 
4086
        Run only tests relating to 'ignore'::
 
4087
 
 
4088
            brz selftest ignore
 
4089
 
 
4090
        Disable plugins and list tests as they're run::
 
4091
 
 
4092
            brz --no-plugins selftest -v
 
4093
    """
 
4094
    # NB: this is used from the class without creating an instance, which is
 
4095
    # why it does not have a self parameter.
 
4096
 
 
4097
    def get_transport_type(typestring):
 
4098
        """Parse and return a transport specifier."""
 
4099
        if typestring == "sftp":
 
4100
            from .tests import stub_sftp
 
4101
            return stub_sftp.SFTPAbsoluteServer
 
4102
        elif typestring == "memory":
 
4103
            from .tests import test_server
 
4104
            return memory.MemoryServer
 
4105
        elif typestring == "fakenfs":
 
4106
            from .tests import test_server
 
4107
            return test_server.FakeNFSServer
 
4108
        msg = "No known transport type %s. Supported types are: sftp\n" %\
 
4109
            (typestring)
 
4110
        raise errors.BzrCommandError(msg)
 
4111
 
 
4112
    hidden = True
 
4113
    takes_args = ['testspecs*']
 
4114
    takes_options = ['verbose',
 
4115
                     Option('one',
 
4116
                            help='Stop when one test fails.',
 
4117
                            short_name='1',
 
4118
                            ),
 
4119
                     Option('transport',
 
4120
                            help='Use a different transport by default '
 
4121
                                 'throughout the test suite.',
 
4122
                            type=get_transport_type),
 
4123
                     Option('benchmark',
 
4124
                            help='Run the benchmarks rather than selftests.',
 
4125
                            hidden=True),
 
4126
                     Option('lsprof-timed',
 
4127
                            help='Generate lsprof output for benchmarked'
 
4128
                                 ' sections of code.'),
 
4129
                     Option('lsprof-tests',
 
4130
                            help='Generate lsprof output for each test.'),
 
4131
                     Option('first',
 
4132
                            help='Run all tests, but run specified tests first.',
 
4133
                            short_name='f',
 
4134
                            ),
 
4135
                     Option('list-only',
 
4136
                            help='List the tests instead of running them.'),
 
4137
                     RegistryOption('parallel',
 
4138
                                    help="Run the test suite in parallel.",
 
4139
                                    lazy_registry=(
 
4140
                                        'breezy.tests', 'parallel_registry'),
 
4141
                                    value_switches=False,
 
4142
                                    ),
 
4143
                     Option('randomize', type=str, argname="SEED",
 
4144
                            help='Randomize the order of tests using the given'
 
4145
                                 ' seed or "now" for the current time.'),
 
4146
                     ListOption('exclude', type=str, argname="PATTERN",
 
4147
                                short_name='x',
 
4148
                                help='Exclude tests that match this regular'
 
4149
                                ' expression.'),
 
4150
                     Option('subunit1',
 
4151
                            help='Output test progress via subunit v1.'),
 
4152
                     Option('subunit2',
 
4153
                            help='Output test progress via subunit v2.'),
 
4154
                     Option('strict', help='Fail on missing dependencies or '
 
4155
                            'known failures.'),
 
4156
                     Option('load-list', type=str, argname='TESTLISTFILE',
 
4157
                            help='Load a test id list from a text file.'),
 
4158
                     ListOption('debugflag', type=str, short_name='E',
 
4159
                                help='Turn on a selftest debug flag.'),
 
4160
                     ListOption('starting-with', type=str, argname='TESTID',
 
4161
                                param_name='starting_with', short_name='s',
 
4162
                                help='Load only the tests starting with TESTID.'),
 
4163
                     Option('sync',
 
4164
                            help="By default we disable fsync and fdatasync"
 
4165
                                 " while running the test suite.")
 
4166
                     ]
 
4167
    encoding_type = 'replace'
 
4168
 
 
4169
    def __init__(self):
 
4170
        Command.__init__(self)
 
4171
        self.additional_selftest_args = {}
 
4172
 
 
4173
    def run(self, testspecs_list=None, verbose=False, one=False,
 
4174
            transport=None, benchmark=None,
 
4175
            lsprof_timed=None,
 
4176
            first=False, list_only=False,
 
4177
            randomize=None, exclude=None, strict=False,
 
4178
            load_list=None, debugflag=None, starting_with=None, subunit1=False,
 
4179
            subunit2=False, parallel=None, lsprof_tests=False, sync=False):
 
4180
 
 
4181
        # During selftest, disallow proxying, as it can cause severe
 
4182
        # performance penalties and is only needed for thread
 
4183
        # safety. The selftest command is assumed to not use threads
 
4184
        # too heavily. The call should be as early as possible, as
 
4185
        # error reporting for past duplicate imports won't have useful
 
4186
        # backtraces.
 
4187
        if sys.version_info[0] < 3:
 
4188
            # TODO(pad.lv/1696545): Allow proxying on Python 3, since
 
4189
            # disallowing it currently leads to failures in many places.
 
4190
            lazy_import.disallow_proxying()
 
4191
 
 
4192
        try:
 
4193
            from . import tests
 
4194
        except ImportError:
 
4195
            raise errors.BzrCommandError("tests not available. Install the "
 
4196
                                         "breezy tests to run the breezy testsuite.")
 
4197
 
 
4198
        if testspecs_list is not None:
 
4199
            pattern = '|'.join(testspecs_list)
 
4200
        else:
 
4201
            pattern = ".*"
 
4202
        if subunit1:
 
4203
            try:
 
4204
                from .tests import SubUnitBzrRunnerv1
 
4205
            except ImportError:
 
4206
                raise errors.BzrCommandError(gettext(
 
4207
                    "subunit not available. subunit needs to be installed "
 
4208
                    "to use --subunit."))
 
4209
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunnerv1
 
4210
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
 
4211
            # stdout, which would corrupt the subunit stream.
 
4212
            # FIXME: This has been fixed in subunit trunk (>0.0.5) so the
 
4213
            # following code can be deleted when it's sufficiently deployed
 
4214
            # -- vila/mgz 20100514
 
4215
            if (sys.platform == "win32"
 
4216
                    and getattr(sys.stdout, 'fileno', None) is not None):
 
4217
                import msvcrt
 
4218
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
 
4219
        if subunit2:
 
4220
            try:
 
4221
                from .tests import SubUnitBzrRunnerv2
 
4222
            except ImportError:
 
4223
                raise errors.BzrCommandError(gettext(
 
4224
                    "subunit not available. subunit "
 
4225
                    "needs to be installed to use --subunit2."))
 
4226
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunnerv2
 
4227
 
 
4228
        if parallel:
 
4229
            self.additional_selftest_args.setdefault(
 
4230
                'suite_decorators', []).append(parallel)
 
4231
        if benchmark:
 
4232
            raise errors.BzrCommandError(gettext(
 
4233
                "--benchmark is no longer supported from brz 2.2; "
 
4234
                "use bzr-usertest instead"))
 
4235
        test_suite_factory = None
 
4236
        if not exclude:
 
4237
            exclude_pattern = None
 
4238
        else:
 
4239
            exclude_pattern = '(' + '|'.join(exclude) + ')'
 
4240
        if not sync:
 
4241
            self._disable_fsync()
 
4242
        selftest_kwargs = {"verbose": verbose,
 
4243
                           "pattern": pattern,
 
4244
                           "stop_on_failure": one,
 
4245
                           "transport": transport,
 
4246
                           "test_suite_factory": test_suite_factory,
 
4247
                           "lsprof_timed": lsprof_timed,
 
4248
                           "lsprof_tests": lsprof_tests,
 
4249
                           "matching_tests_first": first,
 
4250
                           "list_only": list_only,
 
4251
                           "random_seed": randomize,
 
4252
                           "exclude_pattern": exclude_pattern,
 
4253
                           "strict": strict,
 
4254
                           "load_list": load_list,
 
4255
                           "debug_flags": debugflag,
 
4256
                           "starting_with": starting_with
 
4257
                           }
 
4258
        selftest_kwargs.update(self.additional_selftest_args)
 
4259
 
 
4260
        # Make deprecation warnings visible, unless -Werror is set
 
4261
        cleanup = symbol_versioning.activate_deprecation_warnings(
 
4262
            override=False)
 
4263
        try:
 
4264
            result = tests.selftest(**selftest_kwargs)
 
4265
        finally:
 
4266
            cleanup()
 
4267
        return int(not result)
 
4268
 
 
4269
    def _disable_fsync(self):
 
4270
        """Change the 'os' functionality to not synchronize."""
 
4271
        self._orig_fsync = getattr(os, 'fsync', None)
 
4272
        if self._orig_fsync is not None:
 
4273
            os.fsync = lambda filedes: None
 
4274
        self._orig_fdatasync = getattr(os, 'fdatasync', None)
 
4275
        if self._orig_fdatasync is not None:
 
4276
            os.fdatasync = lambda filedes: None
 
4277
 
 
4278
 
 
4279
class cmd_version(Command):
 
4280
    __doc__ = """Show version of brz."""
 
4281
 
 
4282
    encoding_type = 'replace'
 
4283
    takes_options = [
 
4284
        Option("short", help="Print just the version number."),
 
4285
        ]
 
4286
 
 
4287
    @display_command
 
4288
    def run(self, short=False):
 
4289
        from .version import show_version
 
4290
        if short:
 
4291
            self.outf.write(breezy.version_string + '\n')
 
4292
        else:
 
4293
            show_version(to_file=self.outf)
 
4294
 
 
4295
 
 
4296
class cmd_rocks(Command):
 
4297
    __doc__ = """Statement of optimism."""
 
4298
 
 
4299
    hidden = True
 
4300
 
 
4301
    @display_command
 
4302
    def run(self):
 
4303
        self.outf.write(gettext("It sure does!\n"))
 
4304
 
 
4305
 
 
4306
class cmd_find_merge_base(Command):
 
4307
    __doc__ = """Find and print a base revision for merging two branches."""
 
4308
    # TODO: Options to specify revisions on either side, as if
 
4309
    #       merging only part of the history.
 
4310
    takes_args = ['branch', 'other']
 
4311
    hidden = True
 
4312
 
 
4313
    @display_command
 
4314
    def run(self, branch, other):
 
4315
        from .revision import ensure_null
 
4316
 
 
4317
        branch1 = Branch.open_containing(branch)[0]
 
4318
        branch2 = Branch.open_containing(other)[0]
 
4319
        self.enter_context(branch1.lock_read())
 
4320
        self.enter_context(branch2.lock_read())
 
4321
        last1 = ensure_null(branch1.last_revision())
 
4322
        last2 = ensure_null(branch2.last_revision())
 
4323
 
 
4324
        graph = branch1.repository.get_graph(branch2.repository)
 
4325
        base_rev_id = graph.find_unique_lca(last1, last2)
 
4326
 
 
4327
        self.outf.write(gettext('merge base is revision %s\n') %
 
4328
                        base_rev_id.decode('utf-8'))
 
4329
 
 
4330
 
 
4331
class cmd_merge(Command):
 
4332
    __doc__ = """Perform a three-way merge.
 
4333
 
 
4334
    The source of the merge can be specified either in the form of a branch,
 
4335
    or in the form of a path to a file containing a merge directive generated
 
4336
    with brz send. If neither is specified, the default is the upstream branch
 
4337
    or the branch most recently merged using --remember.  The source of the
 
4338
    merge may also be specified in the form of a path to a file in another
 
4339
    branch:  in this case, only the modifications to that file are merged into
 
4340
    the current working tree.
 
4341
 
 
4342
    When merging from a branch, by default brz will try to merge in all new
 
4343
    work from the other branch, automatically determining an appropriate base
 
4344
    revision.  If this fails, you may need to give an explicit base.
 
4345
 
 
4346
    To pick a different ending revision, pass "--revision OTHER".  brz will
 
4347
    try to merge in all new work up to and including revision OTHER.
 
4348
 
 
4349
    If you specify two values, "--revision BASE..OTHER", only revisions BASE
 
4350
    through OTHER, excluding BASE but including OTHER, will be merged.  If this
 
4351
    causes some revisions to be skipped, i.e. if the destination branch does
 
4352
    not already contain revision BASE, such a merge is commonly referred to as
 
4353
    a "cherrypick". Unlike a normal merge, Breezy does not currently track
 
4354
    cherrypicks. The changes look like a normal commit, and the history of the
 
4355
    changes from the other branch is not stored in the commit.
 
4356
 
 
4357
    Revision numbers are always relative to the source branch.
 
4358
 
 
4359
    Merge will do its best to combine the changes in two branches, but there
 
4360
    are some kinds of problems only a human can fix.  When it encounters those,
 
4361
    it will mark a conflict.  A conflict means that you need to fix something,
 
4362
    before you can commit.
 
4363
 
 
4364
    Use brz resolve when you have fixed a problem.  See also brz conflicts.
 
4365
 
 
4366
    If there is no default branch set, the first merge will set it (use
 
4367
    --no-remember to avoid setting it). After that, you can omit the branch
 
4368
    to use the default.  To change the default, use --remember. The value will
 
4369
    only be saved if the remote location can be accessed.
 
4370
 
 
4371
    The results of the merge are placed into the destination working
 
4372
    directory, where they can be reviewed (with brz diff), tested, and then
 
4373
    committed to record the result of the merge.
 
4374
 
 
4375
    merge refuses to run if there are any uncommitted changes, unless
 
4376
    --force is given.  If --force is given, then the changes from the source
 
4377
    will be merged with the current working tree, including any uncommitted
 
4378
    changes in the tree.  The --force option can also be used to create a
 
4379
    merge revision which has more than two parents.
 
4380
 
 
4381
    If one would like to merge changes from the working tree of the other
 
4382
    branch without merging any committed revisions, the --uncommitted option
 
4383
    can be given.
 
4384
 
 
4385
    To select only some changes to merge, use "merge -i", which will prompt
 
4386
    you to apply each diff hunk and file change, similar to "shelve".
 
4387
 
 
4388
    :Examples:
 
4389
        To merge all new revisions from brz.dev::
 
4390
 
 
4391
            brz merge ../brz.dev
 
4392
 
 
4393
        To merge changes up to and including revision 82 from brz.dev::
 
4394
 
 
4395
            brz merge -r 82 ../brz.dev
 
4396
 
 
4397
        To merge the changes introduced by 82, without previous changes::
 
4398
 
 
4399
            brz merge -r 81..82 ../brz.dev
 
4400
 
 
4401
        To apply a merge directive contained in /tmp/merge::
 
4402
 
 
4403
            brz merge /tmp/merge
 
4404
 
 
4405
        To create a merge revision with three parents from two branches
 
4406
        feature1a and feature1b:
 
4407
 
 
4408
            brz merge ../feature1a
 
4409
            brz merge ../feature1b --force
 
4410
            brz commit -m 'revision with three parents'
 
4411
    """
 
4412
 
 
4413
    encoding_type = 'exact'
 
4414
    _see_also = ['update', 'remerge', 'status-flags', 'send']
 
4415
    takes_args = ['location?']
 
4416
    takes_options = [
 
4417
        'change',
 
4418
        'revision',
 
4419
        Option('force',
 
4420
               help='Merge even if the destination tree has uncommitted changes.'),
 
4421
        'merge-type',
 
4422
        'reprocess',
 
4423
        'remember',
 
4424
        Option('show-base', help="Show base revision text in "
 
4425
               "conflicts."),
 
4426
        Option('uncommitted', help='Apply uncommitted changes'
 
4427
               ' from a working copy, instead of branch changes.'),
 
4428
        Option('pull', help='If the destination is already'
 
4429
               ' completely merged into the source, pull from the'
 
4430
               ' source rather than merging.  When this happens,'
 
4431
               ' you do not need to commit the result.'),
 
4432
        custom_help('directory',
 
4433
                    help='Branch to merge into, '
 
4434
                    'rather than the one containing the working directory.'),
 
4435
        Option('preview', help='Instead of merging, show a diff of the'
 
4436
               ' merge.'),
 
4437
        Option('interactive', help='Select changes interactively.',
 
4438
               short_name='i')
 
4439
    ]
 
4440
 
 
4441
    def run(self, location=None, revision=None, force=False,
 
4442
            merge_type=None, show_base=False, reprocess=None, remember=None,
 
4443
            uncommitted=False, pull=False,
 
4444
            directory=None,
 
4445
            preview=False,
 
4446
            interactive=False,
 
4447
            ):
 
4448
        if merge_type is None:
 
4449
            merge_type = _mod_merge.Merge3Merger
 
4450
 
 
4451
        if directory is None:
 
4452
            directory = u'.'
 
4453
        possible_transports = []
 
4454
        merger = None
 
4455
        allow_pending = True
 
4456
        verified = 'inapplicable'
 
4457
 
 
4458
        tree = WorkingTree.open_containing(directory)[0]
 
4459
        if tree.branch.last_revision() == _mod_revision.NULL_REVISION:
 
4460
            raise errors.BzrCommandError(gettext('Merging into empty branches not currently supported, '
 
4461
                                                 'https://bugs.launchpad.net/bzr/+bug/308562'))
 
4462
 
 
4463
        # die as quickly as possible if there are uncommitted changes
 
4464
        if not force:
 
4465
            if tree.has_changes():
 
4466
                raise errors.UncommittedChanges(tree)
 
4467
 
 
4468
        view_info = _get_view_info_for_change_reporter(tree)
 
4469
        change_reporter = delta._ChangeReporter(
 
4470
            unversioned_filter=tree.is_ignored, view_info=view_info)
 
4471
        pb = ui.ui_factory.nested_progress_bar()
 
4472
        self.enter_context(pb)
 
4473
        self.enter_context(tree.lock_write())
 
4474
        if location is not None:
 
4475
            try:
 
4476
                mergeable = _mod_mergeable.read_mergeable_from_url(
 
4477
                    location, possible_transports=possible_transports)
 
4478
            except errors.NotABundle:
 
4479
                mergeable = None
 
4480
            else:
 
4481
                if uncommitted:
 
4482
                    raise errors.BzrCommandError(gettext('Cannot use --uncommitted'
 
4483
                                                         ' with bundles or merge directives.'))
 
4484
 
 
4485
                if revision is not None:
 
4486
                    raise errors.BzrCommandError(gettext(
 
4487
                        'Cannot use -r with merge directives or bundles'))
 
4488
                merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
4489
                                                                    mergeable)
 
4490
 
 
4491
        if merger is None and uncommitted:
 
4492
            if revision is not None and len(revision) > 0:
 
4493
                raise errors.BzrCommandError(gettext('Cannot use --uncommitted and'
 
4494
                                                     ' --revision at the same time.'))
 
4495
            merger = self.get_merger_from_uncommitted(tree, location, None)
 
4496
            allow_pending = False
 
4497
 
 
4498
        if merger is None:
 
4499
            merger, allow_pending = self._get_merger_from_branch(tree,
 
4500
                                                                 location, revision, remember, possible_transports, None)
 
4501
 
 
4502
        merger.merge_type = merge_type
 
4503
        merger.reprocess = reprocess
 
4504
        merger.show_base = show_base
 
4505
        self.sanity_check_merger(merger)
 
4506
        if (merger.base_rev_id == merger.other_rev_id and
 
4507
                merger.other_rev_id is not None):
 
4508
            # check if location is a nonexistent file (and not a branch) to
 
4509
            # disambiguate the 'Nothing to do'
 
4510
            if merger.interesting_files:
 
4511
                if not merger.other_tree.has_filename(
 
4512
                        merger.interesting_files[0]):
 
4513
                    note(gettext("merger: ") + str(merger))
 
4514
                    raise errors.PathsDoNotExist([location])
 
4515
            note(gettext('Nothing to do.'))
 
4516
            return 0
 
4517
        if pull and not preview:
 
4518
            if merger.interesting_files is not None:
 
4519
                raise errors.BzrCommandError(
 
4520
                    gettext('Cannot pull individual files'))
 
4521
            if (merger.base_rev_id == tree.last_revision()):
 
4522
                result = tree.pull(merger.other_branch, False,
 
4523
                                   merger.other_rev_id)
 
4524
                result.report(self.outf)
 
4525
                return 0
 
4526
        if merger.this_basis is None:
 
4527
            raise errors.BzrCommandError(gettext(
 
4528
                "This branch has no commits."
 
4529
                " (perhaps you would prefer 'brz pull')"))
 
4530
        if preview:
 
4531
            return self._do_preview(merger)
 
4532
        elif interactive:
 
4533
            return self._do_interactive(merger)
 
4534
        else:
 
4535
            return self._do_merge(merger, change_reporter, allow_pending,
 
4536
                                  verified)
 
4537
 
 
4538
    def _get_preview(self, merger):
 
4539
        tree_merger = merger.make_merger()
 
4540
        tt = tree_merger.make_preview_transform()
 
4541
        self.enter_context(tt)
 
4542
        result_tree = tt.get_preview_tree()
 
4543
        return result_tree
 
4544
 
 
4545
    def _do_preview(self, merger):
 
4546
        from .diff import show_diff_trees
 
4547
        result_tree = self._get_preview(merger)
 
4548
        path_encoding = osutils.get_diff_header_encoding()
 
4549
        show_diff_trees(merger.this_tree, result_tree, self.outf,
 
4550
                        old_label='', new_label='',
 
4551
                        path_encoding=path_encoding)
 
4552
 
 
4553
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
 
4554
        merger.change_reporter = change_reporter
 
4555
        conflict_count = merger.do_merge()
 
4556
        if allow_pending:
 
4557
            merger.set_pending()
 
4558
        if verified == 'failed':
 
4559
            warning('Preview patch does not match changes')
 
4560
        if conflict_count != 0:
 
4561
            return 1
 
4562
        else:
 
4563
            return 0
 
4564
 
 
4565
    def _do_interactive(self, merger):
 
4566
        """Perform an interactive merge.
 
4567
 
 
4568
        This works by generating a preview tree of the merge, then using
 
4569
        Shelver to selectively remove the differences between the working tree
 
4570
        and the preview tree.
 
4571
        """
 
4572
        from . import shelf_ui
 
4573
        result_tree = self._get_preview(merger)
 
4574
        writer = breezy.option.diff_writer_registry.get()
 
4575
        shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
 
4576
                                   reporter=shelf_ui.ApplyReporter(),
 
4577
                                   diff_writer=writer(self.outf))
 
4578
        try:
 
4579
            shelver.run()
 
4580
        finally:
 
4581
            shelver.finalize()
 
4582
 
 
4583
    def sanity_check_merger(self, merger):
 
4584
        if (merger.show_base and
 
4585
                merger.merge_type is not _mod_merge.Merge3Merger):
 
4586
            raise errors.BzrCommandError(gettext("Show-base is not supported for this"
 
4587
                                                 " merge type. %s") % merger.merge_type)
 
4588
        if merger.reprocess is None:
 
4589
            if merger.show_base:
 
4590
                merger.reprocess = False
 
4591
            else:
 
4592
                # Use reprocess if the merger supports it
 
4593
                merger.reprocess = merger.merge_type.supports_reprocess
 
4594
        if merger.reprocess and not merger.merge_type.supports_reprocess:
 
4595
            raise errors.BzrCommandError(gettext("Conflict reduction is not supported"
 
4596
                                                 " for merge type %s.") %
 
4597
                                         merger.merge_type)
 
4598
        if merger.reprocess and merger.show_base:
 
4599
            raise errors.BzrCommandError(gettext("Cannot do conflict reduction and"
 
4600
                                                 " show base."))
 
4601
 
 
4602
        if (merger.merge_type.requires_file_merge_plan and
 
4603
            (not getattr(merger.this_tree, 'plan_file_merge', None) or
 
4604
             not getattr(merger.other_tree, 'plan_file_merge', None) or
 
4605
             (merger.base_tree is not None and
 
4606
                 not getattr(merger.base_tree, 'plan_file_merge', None)))):
 
4607
            raise errors.BzrCommandError(
 
4608
                gettext('Plan file merge unsupported: '
 
4609
                        'Merge type incompatible with tree formats.'))
 
4610
 
 
4611
    def _get_merger_from_branch(self, tree, location, revision, remember,
 
4612
                                possible_transports, pb):
 
4613
        """Produce a merger from a location, assuming it refers to a branch."""
 
4614
        # find the branch locations
 
4615
        other_loc, user_location = self._select_branch_location(tree, location,
 
4616
                                                                revision, -1)
 
4617
        if revision is not None and len(revision) == 2:
 
4618
            base_loc, _unused = self._select_branch_location(tree,
 
4619
                                                             location, revision, 0)
 
4620
        else:
 
4621
            base_loc = other_loc
 
4622
        # Open the branches
 
4623
        other_branch, other_path = Branch.open_containing(other_loc,
 
4624
                                                          possible_transports)
 
4625
        if base_loc == other_loc:
 
4626
            base_branch = other_branch
 
4627
        else:
 
4628
            base_branch, base_path = Branch.open_containing(base_loc,
 
4629
                                                            possible_transports)
 
4630
        # Find the revision ids
 
4631
        other_revision_id = None
 
4632
        base_revision_id = None
 
4633
        if revision is not None:
 
4634
            if len(revision) >= 1:
 
4635
                other_revision_id = revision[-1].as_revision_id(other_branch)
 
4636
            if len(revision) == 2:
 
4637
                base_revision_id = revision[0].as_revision_id(base_branch)
 
4638
        if other_revision_id is None:
 
4639
            other_revision_id = _mod_revision.ensure_null(
 
4640
                other_branch.last_revision())
 
4641
        # Remember where we merge from. We need to remember if:
 
4642
        # - user specify a location (and we don't merge from the parent
 
4643
        #   branch)
 
4644
        # - user ask to remember or there is no previous location set to merge
 
4645
        #   from and user didn't ask to *not* remember
 
4646
        if (user_location is not None
 
4647
            and ((remember or
 
4648
                 (remember is None and
 
4649
                  tree.branch.get_submit_branch() is None)))):
 
4650
            tree.branch.set_submit_branch(other_branch.base)
 
4651
        # Merge tags (but don't set them in the master branch yet, the user
 
4652
        # might revert this merge).  Commit will propagate them.
 
4653
        other_branch.tags.merge_to(tree.branch.tags, ignore_master=True)
 
4654
        merger = _mod_merge.Merger.from_revision_ids(tree,
 
4655
                                                     other_revision_id, base_revision_id, other_branch, base_branch)
 
4656
        if other_path != '':
 
4657
            allow_pending = False
 
4658
            merger.interesting_files = [other_path]
 
4659
        else:
 
4660
            allow_pending = True
 
4661
        return merger, allow_pending
 
4662
 
 
4663
    def get_merger_from_uncommitted(self, tree, location, pb):
 
4664
        """Get a merger for uncommitted changes.
 
4665
 
 
4666
        :param tree: The tree the merger should apply to.
 
4667
        :param location: The location containing uncommitted changes.
 
4668
        :param pb: The progress bar to use for showing progress.
 
4669
        """
 
4670
        location = self._select_branch_location(tree, location)[0]
 
4671
        other_tree, other_path = WorkingTree.open_containing(location)
 
4672
        merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
 
4673
        if other_path != '':
 
4674
            merger.interesting_files = [other_path]
 
4675
        return merger
 
4676
 
 
4677
    def _select_branch_location(self, tree, user_location, revision=None,
 
4678
                                index=None):
 
4679
        """Select a branch location, according to possible inputs.
 
4680
 
 
4681
        If provided, branches from ``revision`` are preferred.  (Both
 
4682
        ``revision`` and ``index`` must be supplied.)
 
4683
 
 
4684
        Otherwise, the ``location`` parameter is used.  If it is None, then the
 
4685
        ``submit`` or ``parent`` location is used, and a note is printed.
 
4686
 
 
4687
        :param tree: The working tree to select a branch for merging into
 
4688
        :param location: The location entered by the user
 
4689
        :param revision: The revision parameter to the command
 
4690
        :param index: The index to use for the revision parameter.  Negative
 
4691
            indices are permitted.
 
4692
        :return: (selected_location, user_location).  The default location
 
4693
            will be the user-entered location.
 
4694
        """
 
4695
        if (revision is not None and index is not None
 
4696
                and revision[index] is not None):
 
4697
            branch = revision[index].get_branch()
 
4698
            if branch is not None:
 
4699
                return branch, branch
 
4700
        if user_location is None:
 
4701
            location = self._get_remembered(tree, 'Merging from')
 
4702
        else:
 
4703
            location = user_location
 
4704
        return location, user_location
 
4705
 
 
4706
    def _get_remembered(self, tree, verb_string):
 
4707
        """Use tree.branch's parent if none was supplied.
 
4708
 
 
4709
        Report if the remembered location was used.
 
4710
        """
 
4711
        stored_location = tree.branch.get_submit_branch()
 
4712
        stored_location_type = "submit"
 
4713
        if stored_location is None:
 
4714
            stored_location = tree.branch.get_parent()
 
4715
            stored_location_type = "parent"
 
4716
        mutter("%s", stored_location)
 
4717
        if stored_location is None:
 
4718
            raise errors.BzrCommandError(
 
4719
                gettext("No location specified or remembered"))
 
4720
        display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
 
4721
        note(gettext("{0} remembered {1} location {2}").format(verb_string,
 
4722
                                                               stored_location_type, display_url))
 
4723
        return stored_location
 
4724
 
 
4725
 
 
4726
class cmd_remerge(Command):
 
4727
    __doc__ = """Redo a merge.
 
4728
 
 
4729
    Use this if you want to try a different merge technique while resolving
 
4730
    conflicts.  Some merge techniques are better than others, and remerge
 
4731
    lets you try different ones on different files.
 
4732
 
 
4733
    The options for remerge have the same meaning and defaults as the ones for
 
4734
    merge.  The difference is that remerge can (only) be run when there is a
 
4735
    pending merge, and it lets you specify particular files.
 
4736
 
 
4737
    :Examples:
 
4738
        Re-do the merge of all conflicted files, and show the base text in
 
4739
        conflict regions, in addition to the usual THIS and OTHER texts::
 
4740
 
 
4741
            brz remerge --show-base
 
4742
 
 
4743
        Re-do the merge of "foobar", using the weave merge algorithm, with
 
4744
        additional processing to reduce the size of conflict regions::
 
4745
 
 
4746
            brz remerge --merge-type weave --reprocess foobar
 
4747
    """
 
4748
    takes_args = ['file*']
 
4749
    takes_options = [
 
4750
        'merge-type',
 
4751
        'reprocess',
 
4752
        Option('show-base',
 
4753
               help="Show base revision text in conflicts."),
 
4754
        ]
 
4755
 
 
4756
    def run(self, file_list=None, merge_type=None, show_base=False,
 
4757
            reprocess=False):
 
4758
        from .conflicts import restore
 
4759
        if merge_type is None:
 
4760
            merge_type = _mod_merge.Merge3Merger
 
4761
        tree, file_list = WorkingTree.open_containing_paths(file_list)
 
4762
        self.enter_context(tree.lock_write())
 
4763
        parents = tree.get_parent_ids()
 
4764
        if len(parents) != 2:
 
4765
            raise errors.BzrCommandError(
 
4766
                gettext("Sorry, remerge only works after normal"
 
4767
                        " merges.  Not cherrypicking or multi-merges."))
 
4768
        interesting_files = None
 
4769
        new_conflicts = []
 
4770
        conflicts = tree.conflicts()
 
4771
        if file_list is not None:
 
4772
            interesting_files = set()
 
4773
            for filename in file_list:
 
4774
                if not tree.is_versioned(filename):
 
4775
                    raise errors.NotVersionedError(filename)
 
4776
                interesting_files.add(filename)
 
4777
                if tree.kind(filename) != "directory":
 
4778
                    continue
 
4779
 
 
4780
                for path, ie in tree.iter_entries_by_dir(
 
4781
                        specific_files=[filename]):
 
4782
                    interesting_files.add(path)
 
4783
            new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
4784
        else:
 
4785
            # Remerge only supports resolving contents conflicts
 
4786
            allowed_conflicts = ('text conflict', 'contents conflict')
 
4787
            restore_files = [c.path for c in conflicts
 
4788
                             if c.typestring in allowed_conflicts]
 
4789
        _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_files)
 
4790
        tree.set_conflicts(ConflictList(new_conflicts))
 
4791
        if file_list is not None:
 
4792
            restore_files = file_list
 
4793
        for filename in restore_files:
 
4794
            try:
 
4795
                restore(tree.abspath(filename))
 
4796
            except errors.NotConflicted:
 
4797
                pass
 
4798
        # Disable pending merges, because the file texts we are remerging
 
4799
        # have not had those merges performed.  If we use the wrong parents
 
4800
        # list, we imply that the working tree text has seen and rejected
 
4801
        # all the changes from the other tree, when in fact those changes
 
4802
        # have not yet been seen.
 
4803
        tree.set_parent_ids(parents[:1])
 
4804
        try:
 
4805
            merger = _mod_merge.Merger.from_revision_ids(tree, parents[1])
 
4806
            merger.interesting_files = interesting_files
 
4807
            merger.merge_type = merge_type
 
4808
            merger.show_base = show_base
 
4809
            merger.reprocess = reprocess
 
4810
            conflicts = merger.do_merge()
 
4811
        finally:
 
4812
            tree.set_parent_ids(parents)
 
4813
        if conflicts > 0:
 
4814
            return 1
 
4815
        else:
 
4816
            return 0
 
4817
 
 
4818
 
 
4819
class cmd_revert(Command):
 
4820
    __doc__ = """\
 
4821
    Set files in the working tree back to the contents of a previous revision.
 
4822
 
 
4823
    Giving a list of files will revert only those files.  Otherwise, all files
 
4824
    will be reverted.  If the revision is not specified with '--revision', the
 
4825
    working tree basis revision is used. A revert operation affects only the
 
4826
    working tree, not any revision history like the branch and repository or
 
4827
    the working tree basis revision.
 
4828
 
 
4829
    To remove only some changes, without reverting to a prior version, use
 
4830
    merge instead.  For example, "merge . -r -2..-3" (don't forget the ".")
 
4831
    will remove the changes introduced by the second last commit (-2), without
 
4832
    affecting the changes introduced by the last commit (-1).  To remove
 
4833
    certain changes on a hunk-by-hunk basis, see the shelve command.
 
4834
    To update the branch to a specific revision or the latest revision and
 
4835
    update the working tree accordingly while preserving local changes, see the
 
4836
    update command.
 
4837
 
 
4838
    Uncommitted changes to files that are reverted will be discarded.
 
4839
    However, by default, any files that have been manually changed will be
 
4840
    backed up first.  (Files changed only by merge are not backed up.)  Backup
 
4841
    files have '.~#~' appended to their name, where # is a number.
 
4842
 
 
4843
    When you provide files, you can use their current pathname or the pathname
 
4844
    from the target revision.  So you can use revert to "undelete" a file by
 
4845
    name.  If you name a directory, all the contents of that directory will be
 
4846
    reverted.
 
4847
 
 
4848
    If you have newly added files since the target revision, they will be
 
4849
    removed.  If the files to be removed have been changed, backups will be
 
4850
    created as above.  Directories containing unknown files will not be
 
4851
    deleted.
 
4852
 
 
4853
    The working tree contains a list of revisions that have been merged but
 
4854
    not yet committed. These revisions will be included as additional parents
 
4855
    of the next commit.  Normally, using revert clears that list as well as
 
4856
    reverting the files.  If any files are specified, revert leaves the list
 
4857
    of uncommitted merges alone and reverts only the files.  Use ``brz revert
 
4858
    .`` in the tree root to revert all files but keep the recorded merges,
 
4859
    and ``brz revert --forget-merges`` to clear the pending merge list without
 
4860
    reverting any files.
 
4861
 
 
4862
    Using "brz revert --forget-merges", it is possible to apply all of the
 
4863
    changes from a branch in a single revision.  To do this, perform the merge
 
4864
    as desired.  Then doing revert with the "--forget-merges" option will keep
 
4865
    the content of the tree as it was, but it will clear the list of pending
 
4866
    merges.  The next commit will then contain all of the changes that are
 
4867
    present in the other branch, but without any other parent revisions.
 
4868
    Because this technique forgets where these changes originated, it may
 
4869
    cause additional conflicts on later merges involving the same source and
 
4870
    target branches.
 
4871
    """
 
4872
 
 
4873
    _see_also = ['cat', 'export', 'merge', 'shelve']
 
4874
    takes_options = [
 
4875
        'revision',
 
4876
        Option('no-backup', "Do not save backups of reverted files."),
 
4877
        Option('forget-merges',
 
4878
               'Remove pending merge marker, without changing any files.'),
 
4879
        ]
 
4880
    takes_args = ['file*']
 
4881
 
 
4882
    def run(self, revision=None, no_backup=False, file_list=None,
 
4883
            forget_merges=None):
 
4884
        tree, file_list = WorkingTree.open_containing_paths(file_list)
 
4885
        self.enter_context(tree.lock_tree_write())
 
4886
        if forget_merges:
 
4887
            tree.set_parent_ids(tree.get_parent_ids()[:1])
 
4888
        else:
 
4889
            self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
4890
 
 
4891
    @staticmethod
 
4892
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
 
4893
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
 
4894
        tree.revert(file_list, rev_tree, not no_backup, None,
 
4895
                    report_changes=True)
 
4896
 
 
4897
 
 
4898
class cmd_assert_fail(Command):
 
4899
    __doc__ = """Test reporting of assertion failures"""
 
4900
    # intended just for use in testing
 
4901
 
 
4902
    hidden = True
 
4903
 
 
4904
    def run(self):
 
4905
        raise AssertionError("always fails")
 
4906
 
 
4907
 
 
4908
class cmd_help(Command):
 
4909
    __doc__ = """Show help on a command or other topic.
 
4910
    """
 
4911
 
 
4912
    _see_also = ['topics']
 
4913
    takes_options = [
 
4914
        Option('long', 'Show help on all commands.'),
 
4915
        ]
 
4916
    takes_args = ['topic?']
 
4917
    aliases = ['?', '--help', '-?', '-h']
 
4918
 
 
4919
    @display_command
 
4920
    def run(self, topic=None, long=False):
 
4921
        import breezy.help
 
4922
        if topic is None and long:
 
4923
            topic = "commands"
 
4924
        breezy.help.help(topic)
 
4925
 
 
4926
 
 
4927
class cmd_shell_complete(Command):
 
4928
    __doc__ = """Show appropriate completions for context.
 
4929
 
 
4930
    For a list of all available commands, say 'brz shell-complete'.
 
4931
    """
 
4932
    takes_args = ['context?']
 
4933
    aliases = ['s-c']
 
4934
    hidden = True
 
4935
 
 
4936
    @display_command
 
4937
    def run(self, context=None):
 
4938
        from . import shellcomplete
 
4939
        shellcomplete.shellcomplete(context)
 
4940
 
 
4941
 
 
4942
class cmd_missing(Command):
 
4943
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
4944
 
 
4945
    OTHER_BRANCH may be local or remote.
 
4946
 
 
4947
    To filter on a range of revisions, you can use the command -r begin..end
 
4948
    -r revision requests a specific revision, -r ..end or -r begin.. are
 
4949
    also valid.
 
4950
 
 
4951
    :Exit values:
 
4952
        1 - some missing revisions
 
4953
        0 - no missing revisions
 
4954
 
 
4955
    :Examples:
 
4956
 
 
4957
        Determine the missing revisions between this and the branch at the
 
4958
        remembered pull location::
 
4959
 
 
4960
            brz missing
 
4961
 
 
4962
        Determine the missing revisions between this and another branch::
 
4963
 
 
4964
            brz missing http://server/branch
 
4965
 
 
4966
        Determine the missing revisions up to a specific revision on the other
 
4967
        branch::
 
4968
 
 
4969
            brz missing -r ..-10
 
4970
 
 
4971
        Determine the missing revisions up to a specific revision on this
 
4972
        branch::
 
4973
 
 
4974
            brz missing --my-revision ..-10
 
4975
    """
 
4976
 
 
4977
    _see_also = ['merge', 'pull']
 
4978
    takes_args = ['other_branch?']
 
4979
    takes_options = [
 
4980
        'directory',
 
4981
        Option('reverse', 'Reverse the order of revisions.'),
 
4982
        Option('mine-only',
 
4983
               'Display changes in the local branch only.'),
 
4984
        Option('this', 'Same as --mine-only.'),
 
4985
        Option('theirs-only',
 
4986
               'Display changes in the remote branch only.'),
 
4987
        Option('other', 'Same as --theirs-only.'),
 
4988
        'log-format',
 
4989
        'show-ids',
 
4990
        'verbose',
 
4991
        custom_help('revision',
 
4992
                    help='Filter on other branch revisions (inclusive). '
 
4993
                    'See "help revisionspec" for details.'),
 
4994
        Option('my-revision',
 
4995
               type=_parse_revision_str,
 
4996
               help='Filter on local branch revisions (inclusive). '
 
4997
               'See "help revisionspec" for details.'),
 
4998
        Option('include-merged',
 
4999
               'Show all revisions in addition to the mainline ones.'),
 
5000
        Option('include-merges', hidden=True,
 
5001
               help='Historical alias for --include-merged.'),
 
5002
        ]
 
5003
    encoding_type = 'replace'
 
5004
 
 
5005
    @display_command
 
5006
    def run(self, other_branch=None, reverse=False, mine_only=False,
 
5007
            theirs_only=False,
 
5008
            log_format=None, long=False, short=False, line=False,
 
5009
            show_ids=False, verbose=False, this=False, other=False,
 
5010
            include_merged=None, revision=None, my_revision=None,
 
5011
            directory=u'.'):
 
5012
        from breezy.missing import find_unmerged, iter_log_revisions
 
5013
 
 
5014
        def message(s):
 
5015
            if not is_quiet():
 
5016
                self.outf.write(s)
 
5017
 
 
5018
        if include_merged is None:
 
5019
            include_merged = False
 
5020
        if this:
 
5021
            mine_only = this
 
5022
        if other:
 
5023
            theirs_only = other
 
5024
        # TODO: We should probably check that we don't have mine-only and
 
5025
        #       theirs-only set, but it gets complicated because we also have
 
5026
        #       this and other which could be used.
 
5027
        restrict = 'all'
 
5028
        if mine_only:
 
5029
            restrict = 'local'
 
5030
        elif theirs_only:
 
5031
            restrict = 'remote'
 
5032
 
 
5033
        local_branch = Branch.open_containing(directory)[0]
 
5034
        self.enter_context(local_branch.lock_read())
 
5035
 
 
5036
        parent = local_branch.get_parent()
 
5037
        if other_branch is None:
 
5038
            other_branch = parent
 
5039
            if other_branch is None:
 
5040
                raise errors.BzrCommandError(gettext("No peer location known"
 
5041
                                                     " or specified."))
 
5042
            display_url = urlutils.unescape_for_display(parent,
 
5043
                                                        self.outf.encoding)
 
5044
            message(gettext("Using saved parent location: {0}\n").format(
 
5045
                    display_url))
 
5046
 
 
5047
        remote_branch = Branch.open(other_branch)
 
5048
        if remote_branch.base == local_branch.base:
 
5049
            remote_branch = local_branch
 
5050
        else:
 
5051
            self.enter_context(remote_branch.lock_read())
 
5052
 
 
5053
        local_revid_range = _revision_range_to_revid_range(
 
5054
            _get_revision_range(my_revision, local_branch,
 
5055
                                self.name()))
 
5056
 
 
5057
        remote_revid_range = _revision_range_to_revid_range(
 
5058
            _get_revision_range(revision,
 
5059
                                remote_branch, self.name()))
 
5060
 
 
5061
        local_extra, remote_extra = find_unmerged(
 
5062
            local_branch, remote_branch, restrict,
 
5063
            backward=not reverse,
 
5064
            include_merged=include_merged,
 
5065
            local_revid_range=local_revid_range,
 
5066
            remote_revid_range=remote_revid_range)
 
5067
 
 
5068
        if log_format is None:
 
5069
            registry = log.log_formatter_registry
 
5070
            log_format = registry.get_default(local_branch)
 
5071
        lf = log_format(to_file=self.outf,
 
5072
                        show_ids=show_ids,
 
5073
                        show_timezone='original')
 
5074
 
 
5075
        status_code = 0
 
5076
        if local_extra and not theirs_only:
 
5077
            message(ngettext("You have %d extra revision:\n",
 
5078
                             "You have %d extra revisions:\n",
 
5079
                             len(local_extra)) %
 
5080
                    len(local_extra))
 
5081
            rev_tag_dict = {}
 
5082
            if local_branch.supports_tags():
 
5083
                rev_tag_dict = local_branch.tags.get_reverse_tag_dict()
 
5084
            for revision in iter_log_revisions(local_extra,
 
5085
                                               local_branch.repository,
 
5086
                                               verbose,
 
5087
                                               rev_tag_dict):
 
5088
                lf.log_revision(revision)
 
5089
            printed_local = True
 
5090
            status_code = 1
 
5091
        else:
 
5092
            printed_local = False
 
5093
 
 
5094
        if remote_extra and not mine_only:
 
5095
            if printed_local is True:
 
5096
                message("\n\n\n")
 
5097
            message(ngettext("You are missing %d revision:\n",
 
5098
                             "You are missing %d revisions:\n",
 
5099
                             len(remote_extra)) %
 
5100
                    len(remote_extra))
 
5101
            if remote_branch.supports_tags():
 
5102
                rev_tag_dict = remote_branch.tags.get_reverse_tag_dict()
 
5103
            for revision in iter_log_revisions(remote_extra,
 
5104
                                               remote_branch.repository,
 
5105
                                               verbose,
 
5106
                                               rev_tag_dict):
 
5107
                lf.log_revision(revision)
 
5108
            status_code = 1
 
5109
 
 
5110
        if mine_only and not local_extra:
 
5111
            # We checked local, and found nothing extra
 
5112
            message(gettext('This branch has no new revisions.\n'))
 
5113
        elif theirs_only and not remote_extra:
 
5114
            # We checked remote, and found nothing extra
 
5115
            message(gettext('Other branch has no new revisions.\n'))
 
5116
        elif not (mine_only or theirs_only or local_extra or
 
5117
                  remote_extra):
 
5118
            # We checked both branches, and neither one had extra
 
5119
            # revisions
 
5120
            message(gettext("Branches are up to date.\n"))
 
5121
        self.cleanup_now()
 
5122
        if not status_code and parent is None and other_branch is not None:
 
5123
            self.enter_context(local_branch.lock_write())
 
5124
            # handle race conditions - a parent might be set while we run.
 
5125
            if local_branch.get_parent() is None:
 
5126
                local_branch.set_parent(remote_branch.base)
 
5127
        return status_code
 
5128
 
 
5129
 
 
5130
class cmd_pack(Command):
 
5131
    __doc__ = """Compress the data within a repository.
 
5132
 
 
5133
    This operation compresses the data within a bazaar repository. As
 
5134
    bazaar supports automatic packing of repository, this operation is
 
5135
    normally not required to be done manually.
 
5136
 
 
5137
    During the pack operation, bazaar takes a backup of existing repository
 
5138
    data, i.e. pack files. This backup is eventually removed by bazaar
 
5139
    automatically when it is safe to do so. To save disk space by removing
 
5140
    the backed up pack files, the --clean-obsolete-packs option may be
 
5141
    used.
 
5142
 
 
5143
    Warning: If you use --clean-obsolete-packs and your machine crashes
 
5144
    during or immediately after repacking, you may be left with a state
 
5145
    where the deletion has been written to disk but the new packs have not
 
5146
    been. In this case the repository may be unusable.
 
5147
    """
 
5148
 
 
5149
    _see_also = ['repositories']
 
5150
    takes_args = ['branch_or_repo?']
 
5151
    takes_options = [
 
5152
        Option('clean-obsolete-packs',
 
5153
               'Delete obsolete packs to save disk space.'),
 
5154
        ]
 
5155
 
 
5156
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
5157
        dir = controldir.ControlDir.open_containing(branch_or_repo)[0]
 
5158
        try:
 
5159
            branch = dir.open_branch()
 
5160
            repository = branch.repository
 
5161
        except errors.NotBranchError:
 
5162
            repository = dir.open_repository()
 
5163
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
 
5164
 
 
5165
 
 
5166
class cmd_plugins(Command):
 
5167
    __doc__ = """List the installed plugins.
 
5168
 
 
5169
    This command displays the list of installed plugins including
 
5170
    version of plugin and a short description of each.
 
5171
 
 
5172
    --verbose shows the path where each plugin is located.
 
5173
 
 
5174
    A plugin is an external component for Breezy that extends the
 
5175
    revision control system, by adding or replacing code in Breezy.
 
5176
    Plugins can do a variety of things, including overriding commands,
 
5177
    adding new commands, providing additional network transports and
 
5178
    customizing log output.
 
5179
 
 
5180
    See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
 
5181
    for further information on plugins including where to find them and how to
 
5182
    install them. Instructions are also provided there on how to write new
 
5183
    plugins using the Python programming language.
 
5184
    """
 
5185
    takes_options = ['verbose']
 
5186
 
 
5187
    @display_command
 
5188
    def run(self, verbose=False):
 
5189
        from . import plugin
 
5190
        # Don't give writelines a generator as some codecs don't like that
 
5191
        self.outf.writelines(
 
5192
            list(plugin.describe_plugins(show_paths=verbose)))
 
5193
 
 
5194
 
 
5195
class cmd_testament(Command):
 
5196
    __doc__ = """Show testament (signing-form) of a revision."""
 
5197
    takes_options = [
 
5198
        'revision',
 
5199
        Option('long', help='Produce long-format testament.'),
 
5200
        Option('strict',
 
5201
               help='Produce a strict-format testament.')]
 
5202
    takes_args = ['branch?']
 
5203
    encoding_type = 'exact'
 
5204
 
 
5205
    @display_command
 
5206
    def run(self, branch=u'.', revision=None, long=False, strict=False):
 
5207
        from .bzr.testament import Testament, StrictTestament
 
5208
        if strict is True:
 
5209
            testament_class = StrictTestament
 
5210
        else:
 
5211
            testament_class = Testament
 
5212
        if branch == '.':
 
5213
            b = Branch.open_containing(branch)[0]
 
5214
        else:
 
5215
            b = Branch.open(branch)
 
5216
        self.enter_context(b.lock_read())
 
5217
        if revision is None:
 
5218
            rev_id = b.last_revision()
 
5219
        else:
 
5220
            rev_id = revision[0].as_revision_id(b)
 
5221
        t = testament_class.from_revision(b.repository, rev_id)
 
5222
        if long:
 
5223
            self.outf.writelines(t.as_text_lines())
 
5224
        else:
 
5225
            self.outf.write(t.as_short_text())
 
5226
 
 
5227
 
 
5228
class cmd_annotate(Command):
 
5229
    __doc__ = """Show the origin of each line in a file.
 
5230
 
 
5231
    This prints out the given file with an annotation on the left side
 
5232
    indicating which revision, author and date introduced the change.
 
5233
 
 
5234
    If the origin is the same for a run of consecutive lines, it is
 
5235
    shown only at the top, unless the --all option is given.
 
5236
    """
 
5237
    # TODO: annotate directories; showing when each file was last changed
 
5238
    # TODO: if the working copy is modified, show annotations on that
 
5239
    #       with new uncommitted lines marked
 
5240
    aliases = ['ann', 'blame', 'praise']
 
5241
    takes_args = ['filename']
 
5242
    takes_options = [Option('all', help='Show annotations on all lines.'),
 
5243
                     Option('long', help='Show commit date in annotations.'),
 
5244
                     'revision',
 
5245
                     'show-ids',
 
5246
                     'directory',
 
5247
                     ]
 
5248
    encoding_type = 'exact'
 
5249
 
 
5250
    @display_command
 
5251
    def run(self, filename, all=False, long=False, revision=None,
 
5252
            show_ids=False, directory=None):
 
5253
        from .annotate import (
 
5254
            annotate_file_tree,
 
5255
            )
 
5256
        wt, branch, relpath = \
 
5257
            _open_directory_or_containing_tree_or_branch(filename, directory)
 
5258
        if wt is not None:
 
5259
            self.enter_context(wt.lock_read())
 
5260
        else:
 
5261
            self.enter_context(branch.lock_read())
 
5262
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
 
5263
        self.enter_context(tree.lock_read())
 
5264
        if wt is not None and revision is None:
 
5265
            if not wt.is_versioned(relpath):
 
5266
                raise errors.NotVersionedError(relpath)
 
5267
            # If there is a tree and we're not annotating historical
 
5268
            # versions, annotate the working tree's content.
 
5269
            annotate_file_tree(wt, relpath, self.outf, long, all,
 
5270
                               show_ids=show_ids)
 
5271
        else:
 
5272
            if not tree.is_versioned(relpath):
 
5273
                raise errors.NotVersionedError(relpath)
 
5274
            annotate_file_tree(tree, relpath, self.outf, long, all,
 
5275
                               show_ids=show_ids, branch=branch)
 
5276
 
 
5277
 
 
5278
class cmd_re_sign(Command):
 
5279
    __doc__ = """Create a digital signature for an existing revision."""
 
5280
    # TODO be able to replace existing ones.
 
5281
 
 
5282
    hidden = True  # is this right ?
 
5283
    takes_args = ['revision_id*']
 
5284
    takes_options = ['directory', 'revision']
 
5285
 
 
5286
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
 
5287
        if revision_id_list is not None and revision is not None:
 
5288
            raise errors.BzrCommandError(
 
5289
                gettext('You can only supply one of revision_id or --revision'))
 
5290
        if revision_id_list is None and revision is None:
 
5291
            raise errors.BzrCommandError(
 
5292
                gettext('You must supply either --revision or a revision_id'))
 
5293
        b = WorkingTree.open_containing(directory)[0].branch
 
5294
        self.enter_context(b.lock_write())
 
5295
        return self._run(b, revision_id_list, revision)
 
5296
 
 
5297
    def _run(self, b, revision_id_list, revision):
 
5298
        from .repository import WriteGroup
 
5299
        gpg_strategy = gpg.GPGStrategy(b.get_config_stack())
 
5300
        if revision_id_list is not None:
 
5301
            with WriteGroup(b.repository):
 
5302
                for revision_id in revision_id_list:
 
5303
                    revision_id = cache_utf8.encode(revision_id)
 
5304
                    b.repository.sign_revision(revision_id, gpg_strategy)
 
5305
        elif revision is not None:
 
5306
            if len(revision) == 1:
 
5307
                revno, rev_id = revision[0].in_history(b)
 
5308
                with WriteGroup(b.repository):
 
5309
                    b.repository.sign_revision(rev_id, gpg_strategy)
 
5310
            elif len(revision) == 2:
 
5311
                # are they both on rh- if so we can walk between them
 
5312
                # might be nice to have a range helper for arbitrary
 
5313
                # revision paths. hmm.
 
5314
                from_revno, from_revid = revision[0].in_history(b)
 
5315
                to_revno, to_revid = revision[1].in_history(b)
 
5316
                if to_revid is None:
 
5317
                    to_revno = b.revno()
 
5318
                if from_revno is None or to_revno is None:
 
5319
                    raise errors.BzrCommandError(
 
5320
                        gettext('Cannot sign a range of non-revision-history revisions'))
 
5321
                with WriteGroup(b.repository):
 
5322
                    for revno in range(from_revno, to_revno + 1):
 
5323
                        b.repository.sign_revision(b.get_rev_id(revno),
 
5324
                                                   gpg_strategy)
 
5325
            else:
 
5326
                raise errors.BzrCommandError(
 
5327
                    gettext('Please supply either one revision, or a range.'))
 
5328
 
 
5329
 
 
5330
class cmd_bind(Command):
 
5331
    __doc__ = """Convert the current branch into a checkout of the supplied branch.
 
5332
    If no branch is supplied, rebind to the last bound location.
 
5333
 
 
5334
    Once converted into a checkout, commits must succeed on the master branch
 
5335
    before they will be applied to the local branch.
 
5336
 
 
5337
    Bound branches use the nickname of its master branch unless it is set
 
5338
    locally, in which case binding will update the local nickname to be
 
5339
    that of the master.
 
5340
    """
 
5341
 
 
5342
    _see_also = ['checkouts', 'unbind']
 
5343
    takes_args = ['location?']
 
5344
    takes_options = ['directory']
 
5345
 
 
5346
    def run(self, location=None, directory=u'.'):
 
5347
        b, relpath = Branch.open_containing(directory)
 
5348
        if location is None:
 
5349
            try:
 
5350
                location = b.get_old_bound_location()
 
5351
            except errors.UpgradeRequired:
 
5352
                raise errors.BzrCommandError(
 
5353
                    gettext('No location supplied.  '
 
5354
                            'This format does not remember old locations.'))
 
5355
            else:
 
5356
                if location is None:
 
5357
                    if b.get_bound_location() is not None:
 
5358
                        raise errors.BzrCommandError(
 
5359
                            gettext('Branch is already bound'))
 
5360
                    else:
 
5361
                        raise errors.BzrCommandError(
 
5362
                            gettext('No location supplied'
 
5363
                                    ' and no previous location known'))
 
5364
        b_other = Branch.open(location)
 
5365
        try:
 
5366
            b.bind(b_other)
 
5367
        except errors.DivergedBranches:
 
5368
            raise errors.BzrCommandError(
 
5369
                gettext('These branches have diverged.'
 
5370
                        ' Try merging, and then bind again.'))
 
5371
        if b.get_config().has_explicit_nickname():
 
5372
            b.nick = b_other.nick
 
5373
 
 
5374
 
 
5375
class cmd_unbind(Command):
 
5376
    __doc__ = """Convert the current checkout into a regular branch.
 
5377
 
 
5378
    After unbinding, the local branch is considered independent and subsequent
 
5379
    commits will be local only.
 
5380
    """
 
5381
 
 
5382
    _see_also = ['checkouts', 'bind']
 
5383
    takes_args = []
 
5384
    takes_options = ['directory']
 
5385
 
 
5386
    def run(self, directory=u'.'):
 
5387
        b, relpath = Branch.open_containing(directory)
 
5388
        if not b.unbind():
 
5389
            raise errors.BzrCommandError(gettext('Local branch is not bound'))
 
5390
 
 
5391
 
 
5392
class cmd_uncommit(Command):
 
5393
    __doc__ = """Remove the last committed revision.
 
5394
 
 
5395
    --verbose will print out what is being removed.
 
5396
    --dry-run will go through all the motions, but not actually
 
5397
    remove anything.
 
5398
 
 
5399
    If --revision is specified, uncommit revisions to leave the branch at the
 
5400
    specified revision.  For example, "brz uncommit -r 15" will leave the
 
5401
    branch at revision 15.
 
5402
 
 
5403
    Uncommit leaves the working tree ready for a new commit.  The only change
 
5404
    it may make is to restore any pending merges that were present before
 
5405
    the commit.
 
5406
    """
 
5407
 
 
5408
    # TODO: jam 20060108 Add an option to allow uncommit to remove
 
5409
    # unreferenced information in 'branch-as-repository' branches.
 
5410
    # TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
 
5411
    # information in shared branches as well.
 
5412
    _see_also = ['commit']
 
5413
    takes_options = ['verbose', 'revision',
 
5414
                     Option('dry-run', help='Don\'t actually make changes.'),
 
5415
                     Option('force', help='Say yes to all questions.'),
 
5416
                     Option('keep-tags',
 
5417
                            help='Keep tags that point to removed revisions.'),
 
5418
                     Option('local',
 
5419
                            help="Only remove the commits from the local "
 
5420
                            "branch when in a checkout."
 
5421
                            ),
 
5422
                     ]
 
5423
    takes_args = ['location?']
 
5424
    aliases = []
 
5425
    encoding_type = 'replace'
 
5426
 
 
5427
    def run(self, location=None, dry_run=False, verbose=False,
 
5428
            revision=None, force=False, local=False, keep_tags=False):
 
5429
        if location is None:
 
5430
            location = u'.'
 
5431
        control, relpath = controldir.ControlDir.open_containing(location)
 
5432
        try:
 
5433
            tree = control.open_workingtree()
 
5434
            b = tree.branch
 
5435
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
5436
            tree = None
 
5437
            b = control.open_branch()
 
5438
 
 
5439
        if tree is not None:
 
5440
            self.enter_context(tree.lock_write())
 
5441
        else:
 
5442
            self.enter_context(b.lock_write())
 
5443
        return self._run(b, tree, dry_run, verbose, revision, force,
 
5444
                         local, keep_tags, location)
 
5445
 
 
5446
    def _run(self, b, tree, dry_run, verbose, revision, force, local,
 
5447
             keep_tags, location):
 
5448
        from .log import log_formatter, show_log
 
5449
        from .uncommit import uncommit
 
5450
 
 
5451
        last_revno, last_rev_id = b.last_revision_info()
 
5452
 
 
5453
        rev_id = None
 
5454
        if revision is None:
 
5455
            revno = last_revno
 
5456
            rev_id = last_rev_id
 
5457
        else:
 
5458
            # 'brz uncommit -r 10' actually means uncommit
 
5459
            # so that the final tree is at revno 10.
 
5460
            # but breezy.uncommit.uncommit() actually uncommits
 
5461
            # the revisions that are supplied.
 
5462
            # So we need to offset it by one
 
5463
            revno = revision[0].in_history(b).revno + 1
 
5464
            if revno <= last_revno:
 
5465
                rev_id = b.get_rev_id(revno)
 
5466
 
 
5467
        if rev_id is None or _mod_revision.is_null(rev_id):
 
5468
            self.outf.write(gettext('No revisions to uncommit.\n'))
 
5469
            return 1
 
5470
 
 
5471
        lf = log_formatter('short',
 
5472
                           to_file=self.outf,
 
5473
                           show_timezone='original')
 
5474
 
 
5475
        show_log(b,
 
5476
                 lf,
 
5477
                 verbose=False,
 
5478
                 direction='forward',
 
5479
                 start_revision=revno,
 
5480
                 end_revision=last_revno)
 
5481
 
 
5482
        if dry_run:
 
5483
            self.outf.write(gettext('Dry-run, pretending to remove'
 
5484
                                    ' the above revisions.\n'))
 
5485
        else:
 
5486
            self.outf.write(
 
5487
                gettext('The above revision(s) will be removed.\n'))
 
5488
 
 
5489
        if not force:
 
5490
            if not ui.ui_factory.confirm_action(
 
5491
                    gettext(u'Uncommit these revisions'),
 
5492
                    'breezy.builtins.uncommit',
 
5493
                    {}):
 
5494
                self.outf.write(gettext('Canceled\n'))
 
5495
                return 0
 
5496
 
 
5497
        mutter('Uncommitting from {%s} to {%s}',
 
5498
               last_rev_id, rev_id)
 
5499
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
 
5500
                 revno=revno, local=local, keep_tags=keep_tags)
 
5501
        if location != '.':
 
5502
            self.outf.write(
 
5503
                gettext('You can restore the old tip by running:\n'
 
5504
                        '  brz pull -d %s %s -r revid:%s\n')
 
5505
                % (location, location, last_rev_id.decode('utf-8')))
 
5506
        else:
 
5507
            self.outf.write(
 
5508
                gettext('You can restore the old tip by running:\n'
 
5509
                        '  brz pull . -r revid:%s\n')
 
5510
                % last_rev_id.decode('utf-8'))
 
5511
 
 
5512
 
 
5513
class cmd_break_lock(Command):
 
5514
    __doc__ = """Break a dead lock.
 
5515
 
 
5516
    This command breaks a lock on a repository, branch, working directory or
 
5517
    config file.
 
5518
 
 
5519
    CAUTION: Locks should only be broken when you are sure that the process
 
5520
    holding the lock has been stopped.
 
5521
 
 
5522
    You can get information on what locks are open via the 'brz info
 
5523
    [location]' command.
 
5524
 
 
5525
    :Examples:
 
5526
        brz break-lock
 
5527
        brz break-lock brz+ssh://example.com/brz/foo
 
5528
        brz break-lock --conf ~/.config/breezy
 
5529
    """
 
5530
 
 
5531
    takes_args = ['location?']
 
5532
    takes_options = [
 
5533
        Option('config',
 
5534
               help='LOCATION is the directory where the config lock is.'),
 
5535
        Option('force',
 
5536
               help='Do not ask for confirmation before breaking the lock.'),
 
5537
        ]
 
5538
 
 
5539
    def run(self, location=None, config=False, force=False):
 
5540
        if location is None:
 
5541
            location = u'.'
 
5542
        if force:
 
5543
            ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
 
5544
                                                               None,
 
5545
                                                               {'breezy.lockdir.break': True})
 
5546
        if config:
 
5547
            conf = _mod_config.LockableConfig(file_name=location)
 
5548
            conf.break_lock()
 
5549
        else:
 
5550
            control, relpath = controldir.ControlDir.open_containing(location)
 
5551
            try:
 
5552
                control.break_lock()
 
5553
            except NotImplementedError:
 
5554
                pass
 
5555
 
 
5556
 
 
5557
class cmd_wait_until_signalled(Command):
 
5558
    __doc__ = """Test helper for test_start_and_stop_brz_subprocess_send_signal.
 
5559
 
 
5560
    This just prints a line to signal when it is ready, then blocks on stdin.
 
5561
    """
 
5562
 
 
5563
    hidden = True
 
5564
 
 
5565
    def run(self):
 
5566
        self.outf.write("running\n")
 
5567
        self.outf.flush()
 
5568
        sys.stdin.readline()
 
5569
 
 
5570
 
 
5571
class cmd_serve(Command):
 
5572
    __doc__ = """Run the brz server."""
 
5573
 
 
5574
    aliases = ['server']
 
5575
 
 
5576
    takes_options = [
 
5577
        Option('inet',
 
5578
               help='Serve on stdin/out for use from inetd or sshd.'),
 
5579
        RegistryOption('protocol',
 
5580
                       help="Protocol to serve.",
 
5581
                       lazy_registry=('breezy.transport',
 
5582
                                      'transport_server_registry'),
 
5583
                       value_switches=True),
 
5584
        Option('listen',
 
5585
               help='Listen for connections on nominated address.',
 
5586
               type=str),
 
5587
        Option('port',
 
5588
               help='Listen for connections on nominated port.  Passing 0 as '
 
5589
                    'the port number will result in a dynamically allocated '
 
5590
                    'port.  The default port depends on the protocol.',
 
5591
               type=int),
 
5592
        custom_help('directory',
 
5593
                    help='Serve contents of this directory.'),
 
5594
        Option('allow-writes',
 
5595
               help='By default the server is a readonly server.  Supplying '
 
5596
                    '--allow-writes enables write access to the contents of '
 
5597
                    'the served directory and below.  Note that ``brz serve`` '
 
5598
                    'does not perform authentication, so unless some form of '
 
5599
                    'external authentication is arranged supplying this '
 
5600
                    'option leads to global uncontrolled write access to your '
 
5601
                    'file system.'
 
5602
               ),
 
5603
        Option('client-timeout', type=float,
 
5604
               help='Override the default idle client timeout (5min).'),
 
5605
        ]
 
5606
 
 
5607
    def run(self, listen=None, port=None, inet=False, directory=None,
 
5608
            allow_writes=False, protocol=None, client_timeout=None):
 
5609
        from . import location, transport
 
5610
        if directory is None:
 
5611
            directory = osutils.getcwd()
 
5612
        if protocol is None:
 
5613
            protocol = transport.transport_server_registry.get()
 
5614
        url = location.location_to_url(directory)
 
5615
        if not allow_writes:
 
5616
            url = 'readonly+' + url
 
5617
        t = transport.get_transport_from_url(url)
 
5618
        protocol(t, listen, port, inet, client_timeout)
 
5619
 
 
5620
 
 
5621
class cmd_join(Command):
 
5622
    __doc__ = """Combine a tree into its containing tree.
 
5623
 
 
5624
    This command requires the target tree to be in a rich-root format.
 
5625
 
 
5626
    The TREE argument should be an independent tree, inside another tree, but
 
5627
    not part of it.  (Such trees can be produced by "brz split", but also by
 
5628
    running "brz branch" with the target inside a tree.)
 
5629
 
 
5630
    The result is a combined tree, with the subtree no longer an independent
 
5631
    part.  This is marked as a merge of the subtree into the containing tree,
 
5632
    and all history is preserved.
 
5633
    """
 
5634
 
 
5635
    _see_also = ['split']
 
5636
    takes_args = ['tree']
 
5637
    takes_options = [
 
5638
        Option('reference', help='Join by reference.', hidden=True),
 
5639
        ]
 
5640
 
 
5641
    def run(self, tree, reference=False):
 
5642
        from breezy.mutabletree import BadReferenceTarget
 
5643
        sub_tree = WorkingTree.open(tree)
 
5644
        parent_dir = osutils.dirname(sub_tree.basedir)
 
5645
        containing_tree = WorkingTree.open_containing(parent_dir)[0]
 
5646
        repo = containing_tree.branch.repository
 
5647
        if not repo.supports_rich_root():
 
5648
            raise errors.BzrCommandError(gettext(
 
5649
                "Can't join trees because %s doesn't support rich root data.\n"
 
5650
                "You can use brz upgrade on the repository.")
 
5651
                % (repo,))
 
5652
        if reference:
 
5653
            try:
 
5654
                containing_tree.add_reference(sub_tree)
 
5655
            except BadReferenceTarget as e:
 
5656
                # XXX: Would be better to just raise a nicely printable
 
5657
                # exception from the real origin.  Also below.  mbp 20070306
 
5658
                raise errors.BzrCommandError(
 
5659
                    gettext("Cannot join {0}.  {1}").format(tree, e.reason))
 
5660
        else:
 
5661
            try:
 
5662
                containing_tree.subsume(sub_tree)
 
5663
            except errors.BadSubsumeSource as e:
 
5664
                raise errors.BzrCommandError(
 
5665
                    gettext("Cannot join {0}.  {1}").format(tree, e.reason))
 
5666
 
 
5667
 
 
5668
class cmd_split(Command):
 
5669
    __doc__ = """Split a subdirectory of a tree into a separate tree.
 
5670
 
 
5671
    This command will produce a target tree in a format that supports
 
5672
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
 
5673
    converted into earlier formats like 'dirstate-tags'.
 
5674
 
 
5675
    The TREE argument should be a subdirectory of a working tree.  That
 
5676
    subdirectory will be converted into an independent tree, with its own
 
5677
    branch.  Commits in the top-level tree will not apply to the new subtree.
 
5678
    """
 
5679
 
 
5680
    _see_also = ['join']
 
5681
    takes_args = ['tree']
 
5682
 
 
5683
    def run(self, tree):
 
5684
        containing_tree, subdir = WorkingTree.open_containing(tree)
 
5685
        if not containing_tree.is_versioned(subdir):
 
5686
            raise errors.NotVersionedError(subdir)
 
5687
        try:
 
5688
            containing_tree.extract(subdir)
 
5689
        except errors.RootNotRich:
 
5690
            raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
 
5691
 
 
5692
 
 
5693
class cmd_merge_directive(Command):
 
5694
    __doc__ = """Generate a merge directive for auto-merge tools.
 
5695
 
 
5696
    A directive requests a merge to be performed, and also provides all the
 
5697
    information necessary to do so.  This means it must either include a
 
5698
    revision bundle, or the location of a branch containing the desired
 
5699
    revision.
 
5700
 
 
5701
    A submit branch (the location to merge into) must be supplied the first
 
5702
    time the command is issued.  After it has been supplied once, it will
 
5703
    be remembered as the default.
 
5704
 
 
5705
    A public branch is optional if a revision bundle is supplied, but required
 
5706
    if --diff or --plain is specified.  It will be remembered as the default
 
5707
    after the first use.
 
5708
    """
 
5709
 
 
5710
    takes_args = ['submit_branch?', 'public_branch?']
 
5711
 
 
5712
    hidden = True
 
5713
 
 
5714
    _see_also = ['send']
 
5715
 
 
5716
    takes_options = [
 
5717
        'directory',
 
5718
        RegistryOption.from_kwargs(
 
5719
            'patch-type',
 
5720
            'The type of patch to include in the directive.',
 
5721
            title='Patch type',
 
5722
            value_switches=True,
 
5723
            enum_switch=False,
 
5724
            bundle='Bazaar revision bundle (default).',
 
5725
            diff='Normal unified diff.',
 
5726
            plain='No patch, just directive.'),
 
5727
        Option('sign', help='GPG-sign the directive.'), 'revision',
 
5728
        Option('mail-to', type=str,
 
5729
               help='Instead of printing the directive, email to this '
 
5730
               'address.'),
 
5731
        Option('message', type=str, short_name='m',
 
5732
               help='Message to use when committing this merge.')
 
5733
        ]
 
5734
 
 
5735
    encoding_type = 'exact'
 
5736
 
 
5737
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
 
5738
            sign=False, revision=None, mail_to=None, message=None,
 
5739
            directory=u'.'):
 
5740
        from .revision import ensure_null, NULL_REVISION
 
5741
        include_patch, include_bundle = {
 
5742
            'plain': (False, False),
 
5743
            'diff': (True, False),
 
5744
            'bundle': (True, True),
 
5745
            }[patch_type]
 
5746
        branch = Branch.open(directory)
 
5747
        stored_submit_branch = branch.get_submit_branch()
 
5748
        if submit_branch is None:
 
5749
            submit_branch = stored_submit_branch
 
5750
        else:
 
5751
            if stored_submit_branch is None:
 
5752
                branch.set_submit_branch(submit_branch)
 
5753
        if submit_branch is None:
 
5754
            submit_branch = branch.get_parent()
 
5755
        if submit_branch is None:
 
5756
            raise errors.BzrCommandError(
 
5757
                gettext('No submit branch specified or known'))
 
5758
 
 
5759
        stored_public_branch = branch.get_public_branch()
 
5760
        if public_branch is None:
 
5761
            public_branch = stored_public_branch
 
5762
        elif stored_public_branch is None:
 
5763
            # FIXME: Should be done only if we succeed ? -- vila 2012-01-03
 
5764
            branch.set_public_branch(public_branch)
 
5765
        if not include_bundle and public_branch is None:
 
5766
            raise errors.BzrCommandError(
 
5767
                gettext('No public branch specified or known'))
 
5768
        base_revision_id = None
 
5769
        if revision is not None:
 
5770
            if len(revision) > 2:
 
5771
                raise errors.BzrCommandError(
 
5772
                    gettext('brz merge-directive takes '
 
5773
                            'at most two one revision identifiers'))
 
5774
            revision_id = revision[-1].as_revision_id(branch)
 
5775
            if len(revision) == 2:
 
5776
                base_revision_id = revision[0].as_revision_id(branch)
 
5777
        else:
 
5778
            revision_id = branch.last_revision()
 
5779
        revision_id = ensure_null(revision_id)
 
5780
        if revision_id == NULL_REVISION:
 
5781
            raise errors.BzrCommandError(gettext('No revisions to bundle.'))
 
5782
        directive = merge_directive.MergeDirective2.from_objects(
 
5783
            branch.repository, revision_id, time.time(),
 
5784
            osutils.local_time_offset(), submit_branch,
 
5785
            public_branch=public_branch, include_patch=include_patch,
 
5786
            include_bundle=include_bundle, message=message,
 
5787
            base_revision_id=base_revision_id)
 
5788
        if mail_to is None:
 
5789
            if sign:
 
5790
                self.outf.write(directive.to_signed(branch))
 
5791
            else:
 
5792
                self.outf.writelines(directive.to_lines())
 
5793
        else:
 
5794
            message = directive.to_email(mail_to, branch, sign)
 
5795
            s = SMTPConnection(branch.get_config_stack())
 
5796
            s.send_email(message)
 
5797
 
 
5798
 
 
5799
class cmd_send(Command):
 
5800
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
5801
 
 
5802
    A merge directive provides many things needed for requesting merges:
 
5803
 
 
5804
    * A machine-readable description of the merge to perform
 
5805
 
 
5806
    * An optional patch that is a preview of the changes requested
 
5807
 
 
5808
    * An optional bundle of revision data, so that the changes can be applied
 
5809
      directly from the merge directive, without retrieving data from a
 
5810
      branch.
 
5811
 
 
5812
    `brz send` creates a compact data set that, when applied using brz
 
5813
    merge, has the same effect as merging from the source branch.
 
5814
 
 
5815
    By default the merge directive is self-contained and can be applied to any
 
5816
    branch containing submit_branch in its ancestory without needing access to
 
5817
    the source branch.
 
5818
 
 
5819
    If --no-bundle is specified, then Breezy doesn't send the contents of the
 
5820
    revisions, but only a structured request to merge from the
 
5821
    public_location.  In that case the public_branch is needed and it must be
 
5822
    up-to-date and accessible to the recipient.  The public_branch is always
 
5823
    included if known, so that people can check it later.
 
5824
 
 
5825
    The submit branch defaults to the parent of the source branch, but can be
 
5826
    overridden.  Both submit branch and public branch will be remembered in
 
5827
    branch.conf the first time they are used for a particular branch.  The
 
5828
    source branch defaults to that containing the working directory, but can
 
5829
    be changed using --from.
 
5830
 
 
5831
    Both the submit branch and the public branch follow the usual behavior with
 
5832
    respect to --remember: If there is no default location set, the first send
 
5833
    will set it (use --no-remember to avoid setting it). After that, you can
 
5834
    omit the location to use the default.  To change the default, use
 
5835
    --remember. The value will only be saved if the location can be accessed.
 
5836
 
 
5837
    In order to calculate those changes, brz must analyse the submit branch.
 
5838
    Therefore it is most efficient for the submit branch to be a local mirror.
 
5839
    If a public location is known for the submit_branch, that location is used
 
5840
    in the merge directive.
 
5841
 
 
5842
    The default behaviour is to send the merge directive by mail, unless -o is
 
5843
    given, in which case it is sent to a file.
 
5844
 
 
5845
    Mail is sent using your preferred mail program.  This should be transparent
 
5846
    on Windows (it uses MAPI).  On Unix, it requires the xdg-email utility.
 
5847
    If the preferred client can't be found (or used), your editor will be used.
 
5848
 
 
5849
    To use a specific mail program, set the mail_client configuration option.
 
5850
    Supported values for specific clients are "claws", "evolution", "kmail",
 
5851
    "mail.app" (MacOS X's Mail.app), "mutt", and "thunderbird"; generic options
 
5852
    are "default", "editor", "emacsclient", "mapi", and "xdg-email".  Plugins
 
5853
    may also add supported clients.
 
5854
 
 
5855
    If mail is being sent, a to address is required.  This can be supplied
 
5856
    either on the commandline, by setting the submit_to configuration
 
5857
    option in the branch itself or the child_submit_to configuration option
 
5858
    in the submit branch.
 
5859
 
 
5860
    The merge directives created by brz send may be applied using brz merge or
 
5861
    brz pull by specifying a file containing a merge directive as the location.
 
5862
 
 
5863
    brz send makes extensive use of public locations to map local locations into
 
5864
    URLs that can be used by other people.  See `brz help configuration` to
 
5865
    set them, and use `brz info` to display them.
 
5866
    """
 
5867
 
 
5868
    encoding_type = 'exact'
 
5869
 
 
5870
    _see_also = ['merge', 'pull']
 
5871
 
 
5872
    takes_args = ['submit_branch?', 'public_branch?']
 
5873
 
 
5874
    takes_options = [
 
5875
        Option('no-bundle',
 
5876
               help='Do not include a bundle in the merge directive.'),
 
5877
        Option('no-patch', help='Do not include a preview patch in the merge'
 
5878
               ' directive.'),
 
5879
        Option('remember',
 
5880
               help='Remember submit and public branch.'),
 
5881
        Option('from',
 
5882
               help='Branch to generate the submission from, '
 
5883
               'rather than the one containing the working directory.',
 
5884
               short_name='f',
 
5885
               type=str),
 
5886
        Option('output', short_name='o',
 
5887
               help='Write merge directive to this file or directory; '
 
5888
                    'use - for stdout.',
 
5889
               type=str),
 
5890
        Option('strict',
 
5891
               help='Refuse to send if there are uncommitted changes in'
 
5892
               ' the working tree, --no-strict disables the check.'),
 
5893
        Option('mail-to', help='Mail the request to this address.',
 
5894
               type=str),
 
5895
        'revision',
 
5896
        'message',
 
5897
        Option('body', help='Body for the email.', type=str),
 
5898
        RegistryOption('format',
 
5899
                       help='Use the specified output format.',
 
5900
                       lazy_registry=('breezy.send', 'format_registry')),
 
5901
        ]
 
5902
 
 
5903
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
 
5904
            no_patch=False, revision=None, remember=None, output=None,
 
5905
            format=None, mail_to=None, message=None, body=None,
 
5906
            strict=None, **kwargs):
 
5907
        from .send import send
 
5908
        return send(submit_branch, revision, public_branch, remember,
 
5909
                    format, no_bundle, no_patch, output,
 
5910
                    kwargs.get('from', '.'), mail_to, message, body,
 
5911
                    self.outf,
 
5912
                    strict=strict)
 
5913
 
 
5914
 
 
5915
class cmd_bundle_revisions(cmd_send):
 
5916
    __doc__ = """Create a merge-directive for submitting changes.
 
5917
 
 
5918
    A merge directive provides many things needed for requesting merges:
 
5919
 
 
5920
    * A machine-readable description of the merge to perform
 
5921
 
 
5922
    * An optional patch that is a preview of the changes requested
 
5923
 
 
5924
    * An optional bundle of revision data, so that the changes can be applied
 
5925
      directly from the merge directive, without retrieving data from a
 
5926
      branch.
 
5927
 
 
5928
    If --no-bundle is specified, then public_branch is needed (and must be
 
5929
    up-to-date), so that the receiver can perform the merge using the
 
5930
    public_branch.  The public_branch is always included if known, so that
 
5931
    people can check it later.
 
5932
 
 
5933
    The submit branch defaults to the parent, but can be overridden.  Both
 
5934
    submit branch and public branch will be remembered if supplied.
 
5935
 
 
5936
    If a public_branch is known for the submit_branch, that public submit
 
5937
    branch is used in the merge instructions.  This means that a local mirror
 
5938
    can be used as your actual submit branch, once you have set public_branch
 
5939
    for that mirror.
 
5940
    """
 
5941
 
 
5942
    takes_options = [
 
5943
        Option('no-bundle',
 
5944
               help='Do not include a bundle in the merge directive.'),
 
5945
        Option('no-patch', help='Do not include a preview patch in the merge'
 
5946
               ' directive.'),
 
5947
        Option('remember',
 
5948
               help='Remember submit and public branch.'),
 
5949
        Option('from',
 
5950
               help='Branch to generate the submission from, '
 
5951
               'rather than the one containing the working directory.',
 
5952
               short_name='f',
 
5953
               type=str),
 
5954
        Option('output', short_name='o', help='Write directive to this file.',
 
5955
               type=str),
 
5956
        Option('strict',
 
5957
               help='Refuse to bundle revisions if there are uncommitted'
 
5958
               ' changes in the working tree, --no-strict disables the check.'),
 
5959
        'revision',
 
5960
        RegistryOption('format',
 
5961
                       help='Use the specified output format.',
 
5962
                       lazy_registry=('breezy.send', 'format_registry')),
 
5963
        ]
 
5964
    aliases = ['bundle']
 
5965
 
 
5966
    _see_also = ['send', 'merge']
 
5967
 
 
5968
    hidden = True
 
5969
 
 
5970
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
 
5971
            no_patch=False, revision=None, remember=False, output=None,
 
5972
            format=None, strict=None, **kwargs):
 
5973
        if output is None:
 
5974
            output = '-'
 
5975
        from .send import send
 
5976
        return send(submit_branch, revision, public_branch, remember,
 
5977
                    format, no_bundle, no_patch, output,
 
5978
                    kwargs.get('from', '.'), None, None, None,
 
5979
                    self.outf, strict=strict)
 
5980
 
 
5981
 
 
5982
class cmd_tag(Command):
 
5983
    __doc__ = """Create, remove or modify a tag naming a revision.
 
5984
 
 
5985
    Tags give human-meaningful names to revisions.  Commands that take a -r
 
5986
    (--revision) option can be given -rtag:X, where X is any previously
 
5987
    created tag.
 
5988
 
 
5989
    Tags are stored in the branch.  Tags are copied from one branch to another
 
5990
    along when you branch, push, pull or merge.
 
5991
 
 
5992
    It is an error to give a tag name that already exists unless you pass
 
5993
    --force, in which case the tag is moved to point to the new revision.
 
5994
 
 
5995
    To rename a tag (change the name but keep it on the same revsion), run ``brz
 
5996
    tag new-name -r tag:old-name`` and then ``brz tag --delete oldname``.
 
5997
 
 
5998
    If no tag name is specified it will be determined through the
 
5999
    'automatic_tag_name' hook. This can e.g. be used to automatically tag
 
6000
    upstream releases by reading configure.ac. See ``brz help hooks`` for
 
6001
    details.
 
6002
    """
 
6003
 
 
6004
    _see_also = ['commit', 'tags']
 
6005
    takes_args = ['tag_name?']
 
6006
    takes_options = [
 
6007
        Option('delete',
 
6008
               help='Delete this tag rather than placing it.',
 
6009
               ),
 
6010
        custom_help('directory',
 
6011
                    help='Branch in which to place the tag.'),
 
6012
        Option('force',
 
6013
               help='Replace existing tags.',
 
6014
               ),
 
6015
        'revision',
 
6016
        ]
 
6017
 
 
6018
    def run(self, tag_name=None,
 
6019
            delete=None,
 
6020
            directory='.',
 
6021
            force=None,
 
6022
            revision=None,
 
6023
            ):
 
6024
        branch, relpath = Branch.open_containing(directory)
 
6025
        self.enter_context(branch.lock_write())
 
6026
        if delete:
 
6027
            if tag_name is None:
 
6028
                raise errors.BzrCommandError(
 
6029
                    gettext("No tag specified to delete."))
 
6030
            branch.tags.delete_tag(tag_name)
 
6031
            note(gettext('Deleted tag %s.') % tag_name)
 
6032
        else:
 
6033
            if revision:
 
6034
                if len(revision) != 1:
 
6035
                    raise errors.BzrCommandError(gettext(
 
6036
                        "Tags can only be placed on a single revision, "
 
6037
                        "not on a range"))
 
6038
                revision_id = revision[0].as_revision_id(branch)
 
6039
            else:
 
6040
                revision_id = branch.last_revision()
 
6041
            if tag_name is None:
 
6042
                tag_name = branch.automatic_tag_name(revision_id)
 
6043
                if tag_name is None:
 
6044
                    raise errors.BzrCommandError(gettext(
 
6045
                        "Please specify a tag name."))
 
6046
            try:
 
6047
                existing_target = branch.tags.lookup_tag(tag_name)
 
6048
            except errors.NoSuchTag:
 
6049
                existing_target = None
 
6050
            if not force and existing_target not in (None, revision_id):
 
6051
                raise errors.TagAlreadyExists(tag_name)
 
6052
            if existing_target == revision_id:
 
6053
                note(gettext('Tag %s already exists for that revision.') % tag_name)
 
6054
            else:
 
6055
                branch.tags.set_tag(tag_name, revision_id)
 
6056
                if existing_target is None:
 
6057
                    note(gettext('Created tag %s.') % tag_name)
 
6058
                else:
 
6059
                    note(gettext('Updated tag %s.') % tag_name)
 
6060
 
 
6061
 
 
6062
class cmd_tags(Command):
 
6063
    __doc__ = """List tags.
 
6064
 
 
6065
    This command shows a table of tag names and the revisions they reference.
 
6066
    """
 
6067
 
 
6068
    _see_also = ['tag']
 
6069
    takes_options = [
 
6070
        custom_help('directory',
 
6071
                    help='Branch whose tags should be displayed.'),
 
6072
        RegistryOption('sort',
 
6073
                       'Sort tags by different criteria.', title='Sorting',
 
6074
                       lazy_registry=('breezy.tag', 'tag_sort_methods')
 
6075
                       ),
 
6076
        'show-ids',
 
6077
        'revision',
 
6078
    ]
 
6079
 
 
6080
    @display_command
 
6081
    def run(self, directory='.', sort=None, show_ids=False, revision=None):
 
6082
        from .tag import tag_sort_methods
 
6083
        branch, relpath = Branch.open_containing(directory)
 
6084
 
 
6085
        tags = list(branch.tags.get_tag_dict().items())
 
6086
        if not tags:
 
6087
            return
 
6088
 
 
6089
        self.enter_context(branch.lock_read())
 
6090
        if revision:
 
6091
            # Restrict to the specified range
 
6092
            tags = self._tags_for_range(branch, revision)
 
6093
        if sort is None:
 
6094
            sort = tag_sort_methods.get()
 
6095
        sort(branch, tags)
 
6096
        if not show_ids:
 
6097
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
 
6098
            for index, (tag, revid) in enumerate(tags):
 
6099
                try:
 
6100
                    revno = branch.revision_id_to_dotted_revno(revid)
 
6101
                    if isinstance(revno, tuple):
 
6102
                        revno = '.'.join(map(str, revno))
 
6103
                except (errors.NoSuchRevision,
 
6104
                        errors.GhostRevisionsHaveNoRevno,
 
6105
                        errors.UnsupportedOperation):
 
6106
                    # Bad tag data/merges can lead to tagged revisions
 
6107
                    # which are not in this branch. Fail gracefully ...
 
6108
                    revno = '?'
 
6109
                tags[index] = (tag, revno)
 
6110
        else:
 
6111
            tags = [(tag, revid.decode('utf-8')) for (tag, revid) in tags]
 
6112
        self.cleanup_now()
 
6113
        for tag, revspec in tags:
 
6114
            self.outf.write('%-20s %s\n' % (tag, revspec))
 
6115
 
 
6116
    def _tags_for_range(self, branch, revision):
 
6117
        rev1, rev2 = _get_revision_range(revision, branch, self.name())
 
6118
        revid1, revid2 = rev1.rev_id, rev2.rev_id
 
6119
        # _get_revision_range will always set revid2 if it's not specified.
 
6120
        # If revid1 is None, it means we want to start from the branch
 
6121
        # origin which is always a valid ancestor. If revid1 == revid2, the
 
6122
        # ancestry check is useless.
 
6123
        if revid1 and revid1 != revid2:
 
6124
            # FIXME: We really want to use the same graph than
 
6125
            # branch.iter_merge_sorted_revisions below, but this is not
 
6126
            # easily available -- vila 2011-09-23
 
6127
            if branch.repository.get_graph().is_ancestor(revid2, revid1):
 
6128
                # We don't want to output anything in this case...
 
6129
                return []
 
6130
        # only show revisions between revid1 and revid2 (inclusive)
 
6131
        tagged_revids = branch.tags.get_reverse_tag_dict()
 
6132
        found = []
 
6133
        for r in branch.iter_merge_sorted_revisions(
 
6134
                start_revision_id=revid2, stop_revision_id=revid1,
 
6135
                stop_rule='include'):
 
6136
            revid_tags = tagged_revids.get(r[0], None)
 
6137
            if revid_tags:
 
6138
                found.extend([(tag, r[0]) for tag in revid_tags])
 
6139
        return found
 
6140
 
 
6141
 
 
6142
class cmd_reconfigure(Command):
 
6143
    __doc__ = """Reconfigure the type of a brz directory.
 
6144
 
 
6145
    A target configuration must be specified.
 
6146
 
 
6147
    For checkouts, the bind-to location will be auto-detected if not specified.
 
6148
    The order of preference is
 
6149
    1. For a lightweight checkout, the current bound location.
 
6150
    2. For branches that used to be checkouts, the previously-bound location.
 
6151
    3. The push location.
 
6152
    4. The parent location.
 
6153
    If none of these is available, --bind-to must be specified.
 
6154
    """
 
6155
 
 
6156
    _see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
 
6157
    takes_args = ['location?']
 
6158
    takes_options = [
 
6159
        RegistryOption.from_kwargs(
 
6160
            'tree_type',
 
6161
            title='Tree type',
 
6162
            help='The relation between branch and tree.',
 
6163
            value_switches=True, enum_switch=False,
 
6164
            branch='Reconfigure to be an unbound branch with no working tree.',
 
6165
            tree='Reconfigure to be an unbound branch with a working tree.',
 
6166
            checkout='Reconfigure to be a bound branch with a working tree.',
 
6167
            lightweight_checkout='Reconfigure to be a lightweight'
 
6168
            ' checkout (with no local history).',
 
6169
            ),
 
6170
        RegistryOption.from_kwargs(
 
6171
            'repository_type',
 
6172
            title='Repository type',
 
6173
            help='Location fo the repository.',
 
6174
            value_switches=True, enum_switch=False,
 
6175
            standalone='Reconfigure to be a standalone branch '
 
6176
            '(i.e. stop using shared repository).',
 
6177
            use_shared='Reconfigure to use a shared repository.',
 
6178
            ),
 
6179
        RegistryOption.from_kwargs(
 
6180
            'repository_trees',
 
6181
            title='Trees in Repository',
 
6182
            help='Whether new branches in the repository have trees.',
 
6183
            value_switches=True, enum_switch=False,
 
6184
            with_trees='Reconfigure repository to create '
 
6185
            'working trees on branches by default.',
 
6186
            with_no_trees='Reconfigure repository to not create '
 
6187
            'working trees on branches by default.'
 
6188
            ),
 
6189
        Option('bind-to', help='Branch to bind checkout to.', type=str),
 
6190
        Option('force',
 
6191
               help='Perform reconfiguration even if local changes'
 
6192
               ' will be lost.'),
 
6193
        Option('stacked-on',
 
6194
               help='Reconfigure a branch to be stacked on another branch.',
 
6195
               type=str,
 
6196
               ),
 
6197
        Option('unstacked',
 
6198
               help='Reconfigure a branch to be unstacked.  This '
 
6199
               'may require copying substantial data into it.',
 
6200
               ),
 
6201
        ]
 
6202
 
 
6203
    def run(self, location=None, bind_to=None, force=False,
 
6204
            tree_type=None, repository_type=None, repository_trees=None,
 
6205
            stacked_on=None, unstacked=None):
 
6206
        directory = controldir.ControlDir.open(location)
 
6207
        if stacked_on and unstacked:
 
6208
            raise errors.BzrCommandError(
 
6209
                gettext("Can't use both --stacked-on and --unstacked"))
 
6210
        elif stacked_on is not None:
 
6211
            reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
 
6212
        elif unstacked:
 
6213
            reconfigure.ReconfigureUnstacked().apply(directory)
 
6214
        # At the moment you can use --stacked-on and a different
 
6215
        # reconfiguration shape at the same time; there seems no good reason
 
6216
        # to ban it.
 
6217
        if (tree_type is None and
 
6218
            repository_type is None and
 
6219
                repository_trees is None):
 
6220
            if stacked_on or unstacked:
 
6221
                return
 
6222
            else:
 
6223
                raise errors.BzrCommandError(gettext('No target configuration '
 
6224
                                                     'specified'))
 
6225
        reconfiguration = None
 
6226
        if tree_type == 'branch':
 
6227
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
 
6228
        elif tree_type == 'tree':
 
6229
            reconfiguration = reconfigure.Reconfigure.to_tree(directory)
 
6230
        elif tree_type == 'checkout':
 
6231
            reconfiguration = reconfigure.Reconfigure.to_checkout(
 
6232
                directory, bind_to)
 
6233
        elif tree_type == 'lightweight-checkout':
 
6234
            reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
 
6235
                directory, bind_to)
 
6236
        if reconfiguration:
 
6237
            reconfiguration.apply(force)
 
6238
            reconfiguration = None
 
6239
        if repository_type == 'use-shared':
 
6240
            reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
 
6241
        elif repository_type == 'standalone':
 
6242
            reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
 
6243
        if reconfiguration:
 
6244
            reconfiguration.apply(force)
 
6245
            reconfiguration = None
 
6246
        if repository_trees == 'with-trees':
 
6247
            reconfiguration = reconfigure.Reconfigure.set_repository_trees(
 
6248
                directory, True)
 
6249
        elif repository_trees == 'with-no-trees':
 
6250
            reconfiguration = reconfigure.Reconfigure.set_repository_trees(
 
6251
                directory, False)
 
6252
        if reconfiguration:
 
6253
            reconfiguration.apply(force)
 
6254
            reconfiguration = None
 
6255
 
 
6256
 
 
6257
class cmd_switch(Command):
 
6258
    __doc__ = """Set the branch of a checkout and update.
 
6259
 
 
6260
    For lightweight checkouts, this changes the branch being referenced.
 
6261
    For heavyweight checkouts, this checks that there are no local commits
 
6262
    versus the current bound branch, then it makes the local branch a mirror
 
6263
    of the new location and binds to it.
 
6264
 
 
6265
    In both cases, the working tree is updated and uncommitted changes
 
6266
    are merged. The user can commit or revert these as they desire.
 
6267
 
 
6268
    Pending merges need to be committed or reverted before using switch.
 
6269
 
 
6270
    The path to the branch to switch to can be specified relative to the parent
 
6271
    directory of the current branch. For example, if you are currently in a
 
6272
    checkout of /path/to/branch, specifying 'newbranch' will find a branch at
 
6273
    /path/to/newbranch.
 
6274
 
 
6275
    Bound branches use the nickname of its master branch unless it is set
 
6276
    locally, in which case switching will update the local nickname to be
 
6277
    that of the master.
 
6278
    """
 
6279
 
 
6280
    takes_args = ['to_location?']
 
6281
    takes_options = ['directory',
 
6282
                     Option('force',
 
6283
                            help='Switch even if local commits will be lost.'),
 
6284
                     'revision',
 
6285
                     Option('create-branch', short_name='b',
 
6286
                            help='Create the target branch from this one before'
 
6287
                            ' switching to it.'),
 
6288
                     Option('store',
 
6289
                            help='Store and restore uncommitted changes in the'
 
6290
                            ' branch.'),
 
6291
                     ]
 
6292
 
 
6293
    def run(self, to_location=None, force=False, create_branch=False,
 
6294
            revision=None, directory=u'.', store=False):
 
6295
        from . import switch
 
6296
        tree_location = directory
 
6297
        revision = _get_one_revision('switch', revision)
 
6298
        control_dir = controldir.ControlDir.open_containing(tree_location)[0]
 
6299
        possible_transports = [control_dir.root_transport]
 
6300
        if to_location is None:
 
6301
            if revision is None:
 
6302
                raise errors.BzrCommandError(gettext('You must supply either a'
 
6303
                                                     ' revision or a location'))
 
6304
            to_location = tree_location
 
6305
        try:
 
6306
            branch = control_dir.open_branch(
 
6307
                possible_transports=possible_transports)
 
6308
            had_explicit_nick = branch.get_config().has_explicit_nickname()
 
6309
        except errors.NotBranchError:
 
6310
            branch = None
 
6311
            had_explicit_nick = False
 
6312
        else:
 
6313
            possible_transports.append(branch.user_transport)
 
6314
        if create_branch:
 
6315
            if branch is None:
 
6316
                raise errors.BzrCommandError(
 
6317
                    gettext('cannot create branch without source branch'))
 
6318
            to_location = lookup_new_sibling_branch(
 
6319
                control_dir, to_location,
 
6320
                possible_transports=possible_transports)
 
6321
            if revision is not None:
 
6322
                revision = revision.as_revision_id(branch)
 
6323
            to_branch = branch.controldir.sprout(
 
6324
                to_location,
 
6325
                possible_transports=possible_transports,
 
6326
                revision_id=revision,
 
6327
                source_branch=branch).open_branch()
 
6328
        else:
 
6329
            try:
 
6330
                to_branch = Branch.open(
 
6331
                    to_location, possible_transports=possible_transports)
 
6332
            except errors.NotBranchError:
 
6333
                to_branch = open_sibling_branch(
 
6334
                    control_dir, to_location,
 
6335
                    possible_transports=possible_transports)
 
6336
            if revision is not None:
 
6337
                revision = revision.as_revision_id(to_branch)
 
6338
        possible_transports.append(to_branch.user_transport)
 
6339
        try:
 
6340
            switch.switch(control_dir, to_branch, force, revision_id=revision,
 
6341
                          store_uncommitted=store,
 
6342
                          possible_transports=possible_transports)
 
6343
        except controldir.BranchReferenceLoop:
 
6344
            raise errors.BzrCommandError(
 
6345
                gettext('switching would create a branch reference loop. '
 
6346
                        'Use the "bzr up" command to switch to a '
 
6347
                        'different revision.'))
 
6348
        if had_explicit_nick:
 
6349
            branch = control_dir.open_branch()  # get the new branch!
 
6350
            branch.nick = to_branch.nick
 
6351
        if to_branch.name:
 
6352
            if to_branch.controldir.control_url != control_dir.control_url:
 
6353
                note(gettext('Switched to branch %s at %s'),
 
6354
                     to_branch.name, urlutils.unescape_for_display(to_branch.base, 'utf-8'))
 
6355
            else:
 
6356
                note(gettext('Switched to branch %s'), to_branch.name)
 
6357
        else:
 
6358
            note(gettext('Switched to branch at %s'),
 
6359
                 urlutils.unescape_for_display(to_branch.base, 'utf-8'))
 
6360
 
 
6361
 
 
6362
class cmd_view(Command):
 
6363
    __doc__ = """Manage filtered views.
 
6364
 
 
6365
    Views provide a mask over the tree so that users can focus on
 
6366
    a subset of a tree when doing their work. After creating a view,
 
6367
    commands that support a list of files - status, diff, commit, etc -
 
6368
    effectively have that list of files implicitly given each time.
 
6369
    An explicit list of files can still be given but those files
 
6370
    must be within the current view.
 
6371
 
 
6372
    In most cases, a view has a short life-span: it is created to make
 
6373
    a selected change and is deleted once that change is committed.
 
6374
    At other times, you may wish to create one or more named views
 
6375
    and switch between them.
 
6376
 
 
6377
    To disable the current view without deleting it, you can switch to
 
6378
    the pseudo view called ``off``. This can be useful when you need
 
6379
    to see the whole tree for an operation or two (e.g. merge) but
 
6380
    want to switch back to your view after that.
 
6381
 
 
6382
    :Examples:
 
6383
      To define the current view::
 
6384
 
 
6385
        brz view file1 dir1 ...
 
6386
 
 
6387
      To list the current view::
 
6388
 
 
6389
        brz view
 
6390
 
 
6391
      To delete the current view::
 
6392
 
 
6393
        brz view --delete
 
6394
 
 
6395
      To disable the current view without deleting it::
 
6396
 
 
6397
        brz view --switch off
 
6398
 
 
6399
      To define a named view and switch to it::
 
6400
 
 
6401
        brz view --name view-name file1 dir1 ...
 
6402
 
 
6403
      To list a named view::
 
6404
 
 
6405
        brz view --name view-name
 
6406
 
 
6407
      To delete a named view::
 
6408
 
 
6409
        brz view --name view-name --delete
 
6410
 
 
6411
      To switch to a named view::
 
6412
 
 
6413
        brz view --switch view-name
 
6414
 
 
6415
      To list all views defined::
 
6416
 
 
6417
        brz view --all
 
6418
 
 
6419
      To delete all views::
 
6420
 
 
6421
        brz view --delete --all
 
6422
    """
 
6423
 
 
6424
    _see_also = []
 
6425
    takes_args = ['file*']
 
6426
    takes_options = [
 
6427
        Option('all',
 
6428
               help='Apply list or delete action to all views.',
 
6429
               ),
 
6430
        Option('delete',
 
6431
               help='Delete the view.',
 
6432
               ),
 
6433
        Option('name',
 
6434
               help='Name of the view to define, list or delete.',
 
6435
               type=str,
 
6436
               ),
 
6437
        Option('switch',
 
6438
               help='Name of the view to switch to.',
 
6439
               type=str,
 
6440
               ),
 
6441
        ]
 
6442
 
 
6443
    def run(self, file_list,
 
6444
            all=False,
 
6445
            delete=False,
 
6446
            name=None,
 
6447
            switch=None,
 
6448
            ):
 
6449
        tree, file_list = WorkingTree.open_containing_paths(file_list,
 
6450
                                                            apply_view=False)
 
6451
        current_view, view_dict = tree.views.get_view_info()
 
6452
        if name is None:
 
6453
            name = current_view
 
6454
        if delete:
 
6455
            if file_list:
 
6456
                raise errors.BzrCommandError(gettext(
 
6457
                    "Both --delete and a file list specified"))
 
6458
            elif switch:
 
6459
                raise errors.BzrCommandError(gettext(
 
6460
                    "Both --delete and --switch specified"))
 
6461
            elif all:
 
6462
                tree.views.set_view_info(None, {})
 
6463
                self.outf.write(gettext("Deleted all views.\n"))
 
6464
            elif name is None:
 
6465
                raise errors.BzrCommandError(
 
6466
                    gettext("No current view to delete"))
 
6467
            else:
 
6468
                tree.views.delete_view(name)
 
6469
                self.outf.write(gettext("Deleted '%s' view.\n") % name)
 
6470
        elif switch:
 
6471
            if file_list:
 
6472
                raise errors.BzrCommandError(gettext(
 
6473
                    "Both --switch and a file list specified"))
 
6474
            elif all:
 
6475
                raise errors.BzrCommandError(gettext(
 
6476
                    "Both --switch and --all specified"))
 
6477
            elif switch == 'off':
 
6478
                if current_view is None:
 
6479
                    raise errors.BzrCommandError(
 
6480
                        gettext("No current view to disable"))
 
6481
                tree.views.set_view_info(None, view_dict)
 
6482
                self.outf.write(gettext("Disabled '%s' view.\n") %
 
6483
                                (current_view))
 
6484
            else:
 
6485
                tree.views.set_view_info(switch, view_dict)
 
6486
                view_str = views.view_display_str(tree.views.lookup_view())
 
6487
                self.outf.write(
 
6488
                    gettext("Using '{0}' view: {1}\n").format(switch, view_str))
 
6489
        elif all:
 
6490
            if view_dict:
 
6491
                self.outf.write(gettext('Views defined:\n'))
 
6492
                for view in sorted(view_dict):
 
6493
                    if view == current_view:
 
6494
                        active = "=>"
 
6495
                    else:
 
6496
                        active = "  "
 
6497
                    view_str = views.view_display_str(view_dict[view])
 
6498
                    self.outf.write('%s %-20s %s\n' % (active, view, view_str))
 
6499
            else:
 
6500
                self.outf.write(gettext('No views defined.\n'))
 
6501
        elif file_list:
 
6502
            if name is None:
 
6503
                # No name given and no current view set
 
6504
                name = 'my'
 
6505
            elif name == 'off':
 
6506
                raise errors.BzrCommandError(gettext(
 
6507
                    "Cannot change the 'off' pseudo view"))
 
6508
            tree.views.set_view(name, sorted(file_list))
 
6509
            view_str = views.view_display_str(tree.views.lookup_view())
 
6510
            self.outf.write(
 
6511
                gettext("Using '{0}' view: {1}\n").format(name, view_str))
 
6512
        else:
 
6513
            # list the files
 
6514
            if name is None:
 
6515
                # No name given and no current view set
 
6516
                self.outf.write(gettext('No current view.\n'))
 
6517
            else:
 
6518
                view_str = views.view_display_str(tree.views.lookup_view(name))
 
6519
                self.outf.write(
 
6520
                    gettext("'{0}' view is: {1}\n").format(name, view_str))
 
6521
 
 
6522
 
 
6523
class cmd_hooks(Command):
 
6524
    __doc__ = """Show hooks."""
 
6525
 
 
6526
    hidden = True
 
6527
 
 
6528
    def run(self):
 
6529
        for hook_key in sorted(hooks.known_hooks.keys()):
 
6530
            some_hooks = hooks.known_hooks_key_to_object(hook_key)
 
6531
            self.outf.write("%s:\n" % type(some_hooks).__name__)
 
6532
            for hook_name, hook_point in sorted(some_hooks.items()):
 
6533
                self.outf.write("  %s:\n" % (hook_name,))
 
6534
                found_hooks = list(hook_point)
 
6535
                if found_hooks:
 
6536
                    for hook in found_hooks:
 
6537
                        self.outf.write("    %s\n" %
 
6538
                                        (some_hooks.get_hook_name(hook),))
 
6539
                else:
 
6540
                    self.outf.write(gettext("    <no hooks installed>\n"))
 
6541
 
 
6542
 
 
6543
class cmd_remove_branch(Command):
 
6544
    __doc__ = """Remove a branch.
 
6545
 
 
6546
    This will remove the branch from the specified location but
 
6547
    will keep any working tree or repository in place.
 
6548
 
 
6549
    :Examples:
 
6550
 
 
6551
      Remove the branch at repo/trunk::
 
6552
 
 
6553
        brz remove-branch repo/trunk
 
6554
 
 
6555
    """
 
6556
 
 
6557
    takes_args = ["location?"]
 
6558
 
 
6559
    takes_options = ['directory',
 
6560
                     Option('force', help='Remove branch even if it is the active branch.')]
 
6561
 
 
6562
    aliases = ["rmbranch"]
 
6563
 
 
6564
    def run(self, directory=None, location=None, force=False):
 
6565
        br = open_nearby_branch(near=directory, location=location)
 
6566
        if not force and br.controldir.has_workingtree():
 
6567
            try:
 
6568
                active_branch = br.controldir.open_branch(name="")
 
6569
            except errors.NotBranchError:
 
6570
                active_branch = None
 
6571
            if (active_branch is not None and
 
6572
                    br.control_url == active_branch.control_url):
 
6573
                raise errors.BzrCommandError(
 
6574
                    gettext("Branch is active. Use --force to remove it."))
 
6575
        br.controldir.destroy_branch(br.name)
 
6576
 
 
6577
 
 
6578
class cmd_shelve(Command):
 
6579
    __doc__ = """Temporarily set aside some changes from the current tree.
 
6580
 
 
6581
    Shelve allows you to temporarily put changes you've made "on the shelf",
 
6582
    ie. out of the way, until a later time when you can bring them back from
 
6583
    the shelf with the 'unshelve' command.  The changes are stored alongside
 
6584
    your working tree, and so they aren't propagated along with your branch nor
 
6585
    will they survive its deletion.
 
6586
 
 
6587
    If shelve --list is specified, previously-shelved changes are listed.
 
6588
 
 
6589
    Shelve is intended to help separate several sets of changes that have
 
6590
    been inappropriately mingled.  If you just want to get rid of all changes
 
6591
    and you don't need to restore them later, use revert.  If you want to
 
6592
    shelve all text changes at once, use shelve --all.
 
6593
 
 
6594
    If filenames are specified, only the changes to those files will be
 
6595
    shelved. Other files will be left untouched.
 
6596
 
 
6597
    If a revision is specified, changes since that revision will be shelved.
 
6598
 
 
6599
    You can put multiple items on the shelf, and by default, 'unshelve' will
 
6600
    restore the most recently shelved changes.
 
6601
 
 
6602
    For complicated changes, it is possible to edit the changes in a separate
 
6603
    editor program to decide what the file remaining in the working copy
 
6604
    should look like.  To do this, add the configuration option
 
6605
 
 
6606
        change_editor = PROGRAM {new_path} {old_path}
 
6607
 
 
6608
    where {new_path} is replaced with the path of the new version of the
 
6609
    file and {old_path} is replaced with the path of the old version of
 
6610
    the file.  The PROGRAM should save the new file with the desired
 
6611
    contents of the file in the working tree.
 
6612
 
 
6613
    """
 
6614
 
 
6615
    takes_args = ['file*']
 
6616
 
 
6617
    takes_options = [
 
6618
        'directory',
 
6619
        'revision',
 
6620
        Option('all', help='Shelve all changes.'),
 
6621
        'message',
 
6622
        RegistryOption('writer', 'Method to use for writing diffs.',
 
6623
                       breezy.option.diff_writer_registry,
 
6624
                       value_switches=True, enum_switch=False),
 
6625
 
 
6626
        Option('list', help='List shelved changes.'),
 
6627
        Option('destroy',
 
6628
               help='Destroy removed changes instead of shelving them.'),
 
6629
    ]
 
6630
    _see_also = ['unshelve', 'configuration']
 
6631
 
 
6632
    def run(self, revision=None, all=False, file_list=None, message=None,
 
6633
            writer=None, list=False, destroy=False, directory=None):
 
6634
        if list:
 
6635
            return self.run_for_list(directory=directory)
 
6636
        from .shelf_ui import Shelver
 
6637
        if writer is None:
 
6638
            writer = breezy.option.diff_writer_registry.get()
 
6639
        try:
 
6640
            shelver = Shelver.from_args(writer(self.outf), revision, all,
 
6641
                                        file_list, message, destroy=destroy, directory=directory)
 
6642
            try:
 
6643
                shelver.run()
 
6644
            finally:
 
6645
                shelver.finalize()
 
6646
        except errors.UserAbort:
 
6647
            return 0
 
6648
 
 
6649
    def run_for_list(self, directory=None):
 
6650
        if directory is None:
 
6651
            directory = u'.'
 
6652
        tree = WorkingTree.open_containing(directory)[0]
 
6653
        self.enter_context(tree.lock_read())
 
6654
        manager = tree.get_shelf_manager()
 
6655
        shelves = manager.active_shelves()
 
6656
        if len(shelves) == 0:
 
6657
            note(gettext('No shelved changes.'))
 
6658
            return 0
 
6659
        for shelf_id in reversed(shelves):
 
6660
            message = manager.get_metadata(shelf_id).get(b'message')
 
6661
            if message is None:
 
6662
                message = '<no message>'
 
6663
            self.outf.write('%3d: %s\n' % (shelf_id, message))
 
6664
        return 1
 
6665
 
 
6666
 
 
6667
class cmd_unshelve(Command):
 
6668
    __doc__ = """Restore shelved changes.
 
6669
 
 
6670
    By default, the most recently shelved changes are restored. However if you
 
6671
    specify a shelf by id those changes will be restored instead.  This works
 
6672
    best when the changes don't depend on each other.
 
6673
    """
 
6674
 
 
6675
    takes_args = ['shelf_id?']
 
6676
    takes_options = [
 
6677
        'directory',
 
6678
        RegistryOption.from_kwargs(
 
6679
            'action', help="The action to perform.",
 
6680
            enum_switch=False, value_switches=True,
 
6681
            apply="Apply changes and remove from the shelf.",
 
6682
            dry_run="Show changes, but do not apply or remove them.",
 
6683
            preview="Instead of unshelving the changes, show the diff that "
 
6684
                    "would result from unshelving.",
 
6685
            delete_only="Delete changes without applying them.",
 
6686
            keep="Apply changes but don't delete them.",
 
6687
        )
 
6688
    ]
 
6689
    _see_also = ['shelve']
 
6690
 
 
6691
    def run(self, shelf_id=None, action='apply', directory=u'.'):
 
6692
        from .shelf_ui import Unshelver
 
6693
        unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
 
6694
        try:
 
6695
            unshelver.run()
 
6696
        finally:
 
6697
            unshelver.tree.unlock()
 
6698
 
 
6699
 
 
6700
class cmd_clean_tree(Command):
 
6701
    __doc__ = """Remove unwanted files from working tree.
 
6702
 
 
6703
    By default, only unknown files, not ignored files, are deleted.  Versioned
 
6704
    files are never deleted.
 
6705
 
 
6706
    Another class is 'detritus', which includes files emitted by brz during
 
6707
    normal operations and selftests.  (The value of these files decreases with
 
6708
    time.)
 
6709
 
 
6710
    If no options are specified, unknown files are deleted.  Otherwise, option
 
6711
    flags are respected, and may be combined.
 
6712
 
 
6713
    To check what clean-tree will do, use --dry-run.
 
6714
    """
 
6715
    takes_options = ['directory',
 
6716
                     Option('ignored', help='Delete all ignored files.'),
 
6717
                     Option('detritus', help='Delete conflict files, merge and revert'
 
6718
                            ' backups, and failed selftest dirs.'),
 
6719
                     Option('unknown',
 
6720
                            help='Delete files unknown to brz (default).'),
 
6721
                     Option('dry-run', help='Show files to delete instead of'
 
6722
                            ' deleting them.'),
 
6723
                     Option('force', help='Do not prompt before deleting.')]
 
6724
 
 
6725
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
 
6726
            force=False, directory=u'.'):
 
6727
        from .clean_tree import clean_tree
 
6728
        if not (unknown or ignored or detritus):
 
6729
            unknown = True
 
6730
        if dry_run:
 
6731
            force = True
 
6732
        clean_tree(directory, unknown=unknown, ignored=ignored,
 
6733
                   detritus=detritus, dry_run=dry_run, no_prompt=force)
 
6734
 
 
6735
 
 
6736
class cmd_reference(Command):
 
6737
    __doc__ = """list, view and set branch locations for nested trees.
 
6738
 
 
6739
    If no arguments are provided, lists the branch locations for nested trees.
 
6740
    If one argument is provided, display the branch location for that tree.
 
6741
    If two arguments are provided, set the branch location for that tree.
 
6742
    """
 
6743
 
 
6744
    hidden = True
 
6745
 
 
6746
    takes_args = ['path?', 'location?']
 
6747
    takes_options = [
 
6748
        'directory',
 
6749
        Option('force-unversioned',
 
6750
               help='Set reference even if path is not versioned.'),
 
6751
        ]
 
6752
 
 
6753
    def run(self, path=None, directory='.', location=None, force_unversioned=False):
 
6754
        tree, branch, relpath = (
 
6755
            controldir.ControlDir.open_containing_tree_or_branch(directory))
 
6756
        if tree is None:
 
6757
            tree = branch.basis_tree()
 
6758
        if path is None:
 
6759
            with tree.lock_read():
 
6760
                info = [
 
6761
                    (path, tree.get_reference_info(path, branch))
 
6762
                    for path in tree.iter_references()]
 
6763
                self._display_reference_info(tree, branch, info)
 
6764
        else:
 
6765
            if not tree.is_versioned(path) and not force_unversioned:
 
6766
                raise errors.NotVersionedError(path)
 
6767
            if location is None:
 
6768
                info = [(path, tree.get_reference_info(path, branch))]
 
6769
                self._display_reference_info(tree, branch, info)
 
6770
            else:
 
6771
                tree.set_reference_info(path, location)
 
6772
 
 
6773
    def _display_reference_info(self, tree, branch, info):
 
6774
        ref_list = []
 
6775
        for path, location in info:
 
6776
            ref_list.append((path, location))
 
6777
        for path, location in sorted(ref_list):
 
6778
            self.outf.write('%s %s\n' % (path, location))
 
6779
 
 
6780
 
 
6781
class cmd_export_pot(Command):
 
6782
    __doc__ = """Export command helps and error messages in po format."""
 
6783
 
 
6784
    hidden = True
 
6785
    takes_options = [Option('plugin',
 
6786
                            help='Export help text from named command '
 
6787
                                 '(defaults to all built in commands).',
 
6788
                            type=str),
 
6789
                     Option('include-duplicates',
 
6790
                            help='Output multiple copies of the same msgid '
 
6791
                                 'string if it appears more than once.'),
 
6792
                     ]
 
6793
 
 
6794
    def run(self, plugin=None, include_duplicates=False):
 
6795
        from .export_pot import export_pot
 
6796
        export_pot(self.outf, plugin, include_duplicates)
 
6797
 
 
6798
 
 
6799
class cmd_import(Command):
 
6800
    __doc__ = """Import sources from a directory, tarball or zip file
 
6801
 
 
6802
    This command will import a directory, tarball or zip file into a bzr
 
6803
    tree, replacing any versioned files already present.  If a directory is
 
6804
    specified, it is used as the target.  If the directory does not exist, or
 
6805
    is not versioned, it is created.
 
6806
 
 
6807
    Tarballs may be gzip or bzip2 compressed.  This is autodetected.
 
6808
 
 
6809
    If the tarball or zip has a single root directory, that directory is
 
6810
    stripped when extracting the tarball.  This is not done for directories.
 
6811
    """
 
6812
 
 
6813
    takes_args = ['source', 'tree?']
 
6814
 
 
6815
    def run(self, source, tree=None):
 
6816
        from .upstream_import import do_import
 
6817
        do_import(source, tree)
 
6818
 
 
6819
 
 
6820
class cmd_link_tree(Command):
 
6821
    __doc__ = """Hardlink matching files to another tree.
 
6822
 
 
6823
    Only files with identical content and execute bit will be linked.
 
6824
    """
 
6825
 
 
6826
    takes_args = ['location']
 
6827
 
 
6828
    def run(self, location):
 
6829
        from .transform import link_tree
 
6830
        target_tree = WorkingTree.open_containing(".")[0]
 
6831
        source_tree = WorkingTree.open(location)
 
6832
        with target_tree.lock_write(), source_tree.lock_read():
 
6833
            link_tree(target_tree, source_tree)
 
6834
 
 
6835
 
 
6836
class cmd_fetch_ghosts(Command):
 
6837
    __doc__ = """Attempt to retrieve ghosts from another branch.
 
6838
 
 
6839
    If the other branch is not supplied, the last-pulled branch is used.
 
6840
    """
 
6841
 
 
6842
    hidden = True
 
6843
    aliases = ['fetch-missing']
 
6844
    takes_args = ['branch?']
 
6845
    takes_options = [Option('no-fix', help="Skip additional synchonization.")]
 
6846
 
 
6847
    def run(self, branch=None, no_fix=False):
 
6848
        from .fetch_ghosts import GhostFetcher
 
6849
        installed, failed = GhostFetcher.from_cmdline(branch).run()
 
6850
        if len(installed) > 0:
 
6851
            self.outf.write("Installed:\n")
 
6852
            for rev in installed:
 
6853
                self.outf.write(rev.decode('utf-8') + "\n")
 
6854
        if len(failed) > 0:
 
6855
            self.outf.write("Still missing:\n")
 
6856
            for rev in failed:
 
6857
                self.outf.write(rev.decode('utf-8') + "\n")
 
6858
        if not no_fix and len(installed) > 0:
 
6859
            cmd_reconcile().run(".")
 
6860
 
 
6861
 
 
6862
class cmd_grep(Command):
 
6863
    """Print lines matching PATTERN for specified files and revisions.
 
6864
 
 
6865
    This command searches the specified files and revisions for a given
 
6866
    pattern.  The pattern is specified as a Python regular expressions[1].
 
6867
 
 
6868
    If the file name is not specified, the revisions starting with the
 
6869
    current directory are searched recursively. If the revision number is
 
6870
    not specified, the working copy is searched. To search the last committed
 
6871
    revision, use the '-r -1' or '-r last:1' option.
 
6872
 
 
6873
    Unversioned files are not searched unless explicitly specified on the
 
6874
    command line. Unversioned directores are not searched.
 
6875
 
 
6876
    When searching a pattern, the output is shown in the 'filepath:string'
 
6877
    format. If a revision is explicitly searched, the output is shown as
 
6878
    'filepath~N:string', where N is the revision number.
 
6879
 
 
6880
    --include and --exclude options can be used to search only (or exclude
 
6881
    from search) files with base name matches the specified Unix style GLOB
 
6882
    pattern.  The GLOB pattern an use *, ?, and [...] as wildcards, and \\
 
6883
    to quote wildcard or backslash character literally. Note that the glob
 
6884
    pattern is not a regular expression.
 
6885
 
 
6886
    [1] http://docs.python.org/library/re.html#regular-expression-syntax
 
6887
    """
 
6888
 
 
6889
    encoding_type = 'replace'
 
6890
    takes_args = ['pattern', 'path*']
 
6891
    takes_options = [
 
6892
        'verbose',
 
6893
        'revision',
 
6894
        Option('color', type=str, argname='when',
 
6895
               help='Show match in color. WHEN is never, always or auto.'),
 
6896
        Option('diff', short_name='p',
 
6897
               help='Grep for pattern in changeset for each revision.'),
 
6898
        ListOption('exclude', type=str, argname='glob', short_name='X',
 
6899
                   help="Skip files whose base name matches GLOB."),
 
6900
        ListOption('include', type=str, argname='glob', short_name='I',
 
6901
                   help="Search only files whose base name matches GLOB."),
 
6902
        Option('files-with-matches', short_name='l',
 
6903
               help='Print only the name of each input file in '
 
6904
               'which PATTERN is found.'),
 
6905
        Option('files-without-match', short_name='L',
 
6906
               help='Print only the name of each input file in '
 
6907
               'which PATTERN is not found.'),
 
6908
        Option('fixed-string', short_name='F',
 
6909
               help='Interpret PATTERN is a single fixed string (not regex).'),
 
6910
        Option('from-root',
 
6911
               help='Search for pattern starting from the root of the branch. '
 
6912
               '(implies --recursive)'),
 
6913
        Option('ignore-case', short_name='i',
 
6914
               help='Ignore case distinctions while matching.'),
 
6915
        Option('levels',
 
6916
               help='Number of levels to display - 0 for all, 1 for collapsed '
 
6917
               '(1 is default).',
 
6918
               argname='N',
 
6919
               type=_parse_levels),
 
6920
        Option('line-number', short_name='n',
 
6921
               help='Show 1-based line number.'),
 
6922
        Option('no-recursive',
 
6923
               help="Don't recurse into subdirectories. (default is --recursive)"),
 
6924
        Option('null', short_name='Z',
 
6925
               help='Write an ASCII NUL (\\0) separator '
 
6926
               'between output lines rather than a newline.'),
 
6927
        ]
 
6928
 
 
6929
    @display_command
 
6930
    def run(self, verbose=False, ignore_case=False, no_recursive=False,
 
6931
            from_root=False, null=False, levels=None, line_number=False,
 
6932
            path_list=None, revision=None, pattern=None, include=None,
 
6933
            exclude=None, fixed_string=False, files_with_matches=False,
 
6934
            files_without_match=False, color=None, diff=False):
 
6935
        from breezy import _termcolor
 
6936
        from . import grep
 
6937
        import re
 
6938
        if path_list is None:
 
6939
            path_list = ['.']
 
6940
        else:
 
6941
            if from_root:
 
6942
                raise errors.BzrCommandError(
 
6943
                    'cannot specify both --from-root and PATH.')
 
6944
 
 
6945
        if files_with_matches and files_without_match:
 
6946
            raise errors.BzrCommandError(
 
6947
                'cannot specify both '
 
6948
                '-l/--files-with-matches and -L/--files-without-matches.')
 
6949
 
 
6950
        global_config = _mod_config.GlobalConfig()
 
6951
 
 
6952
        if color is None:
 
6953
            color = global_config.get_user_option('grep_color')
 
6954
 
 
6955
        if color is None:
 
6956
            color = 'never'
 
6957
 
 
6958
        if color not in ['always', 'never', 'auto']:
 
6959
            raise errors.BzrCommandError('Valid values for --color are '
 
6960
                                         '"always", "never" or "auto".')
 
6961
 
 
6962
        if levels is None:
 
6963
            levels = 1
 
6964
 
 
6965
        print_revno = False
 
6966
        if revision is not None or levels == 0:
 
6967
            # print revision numbers as we may be showing multiple revisions
 
6968
            print_revno = True
 
6969
 
 
6970
        eol_marker = '\n'
 
6971
        if null:
 
6972
            eol_marker = '\0'
 
6973
 
 
6974
        if not ignore_case and grep.is_fixed_string(pattern):
 
6975
            # if the pattern isalnum, implicitly use to -F for faster grep
 
6976
            fixed_string = True
 
6977
        elif ignore_case and fixed_string:
 
6978
            # GZ 2010-06-02: Fall back to regexp rather than lowercasing
 
6979
            #                pattern and text which will cause pain later
 
6980
            fixed_string = False
 
6981
            pattern = re.escape(pattern)
 
6982
 
 
6983
        patternc = None
 
6984
        re_flags = re.MULTILINE
 
6985
        if ignore_case:
 
6986
            re_flags |= re.IGNORECASE
 
6987
 
 
6988
        if not fixed_string:
 
6989
            patternc = grep.compile_pattern(
 
6990
                pattern.encode(grep._user_encoding), re_flags)
 
6991
 
 
6992
        if color == 'always':
 
6993
            show_color = True
 
6994
        elif color == 'never':
 
6995
            show_color = False
 
6996
        elif color == 'auto':
 
6997
            show_color = _termcolor.allow_color()
 
6998
 
 
6999
        opts = grep.GrepOptions()
 
7000
 
 
7001
        opts.verbose = verbose
 
7002
        opts.ignore_case = ignore_case
 
7003
        opts.no_recursive = no_recursive
 
7004
        opts.from_root = from_root
 
7005
        opts.null = null
 
7006
        opts.levels = levels
 
7007
        opts.line_number = line_number
 
7008
        opts.path_list = path_list
 
7009
        opts.revision = revision
 
7010
        opts.pattern = pattern
 
7011
        opts.include = include
 
7012
        opts.exclude = exclude
 
7013
        opts.fixed_string = fixed_string
 
7014
        opts.files_with_matches = files_with_matches
 
7015
        opts.files_without_match = files_without_match
 
7016
        opts.color = color
 
7017
        opts.diff = False
 
7018
 
 
7019
        opts.eol_marker = eol_marker
 
7020
        opts.print_revno = print_revno
 
7021
        opts.patternc = patternc
 
7022
        opts.recursive = not no_recursive
 
7023
        opts.fixed_string = fixed_string
 
7024
        opts.outf = self.outf
 
7025
        opts.show_color = show_color
 
7026
 
 
7027
        if diff:
 
7028
            # options not used:
 
7029
            # files_with_matches, files_without_match
 
7030
            # levels(?), line_number, from_root
 
7031
            # include, exclude
 
7032
            # These are silently ignored.
 
7033
            grep.grep_diff(opts)
 
7034
        elif revision is None:
 
7035
            grep.workingtree_grep(opts)
 
7036
        else:
 
7037
            grep.versioned_grep(opts)
 
7038
 
 
7039
 
 
7040
class cmd_patch(Command):
 
7041
    """Apply a named patch to the current tree.
 
7042
 
 
7043
    """
 
7044
 
 
7045
    takes_args = ['filename?']
 
7046
    takes_options = [Option('strip', type=int, short_name='p',
 
7047
                            help=("Strip the smallest prefix containing num "
 
7048
                                  "leading slashes from filenames.")),
 
7049
                     Option('silent', help='Suppress chatter.')]
 
7050
 
 
7051
    def run(self, filename=None, strip=None, silent=False):
 
7052
        from .patch import patch_tree
 
7053
        wt = WorkingTree.open_containing('.')[0]
 
7054
        if strip is None:
 
7055
            strip = 1
 
7056
        my_file = None
 
7057
        if filename is None:
 
7058
            my_file = getattr(sys.stdin, 'buffer', sys.stdin)
 
7059
        else:
 
7060
            my_file = open(filename, 'rb')
 
7061
        patches = [my_file.read()]
 
7062
        return patch_tree(wt, patches, strip, quiet=is_quiet(), out=self.outf)
 
7063
 
 
7064
 
 
7065
class cmd_resolve_location(Command):
 
7066
    __doc__ = """Expand a location to a full URL.
 
7067
 
 
7068
    :Examples:
 
7069
        Look up a Launchpad URL.
 
7070
 
 
7071
            brz resolve-location lp:brz
 
7072
    """
 
7073
    takes_args = ['location']
 
7074
    hidden = True
 
7075
 
 
7076
    def run(self, location):
 
7077
        from .location import location_to_url
 
7078
        url = location_to_url(location)
 
7079
        display_url = urlutils.unescape_for_display(url, self.outf.encoding)
 
7080
        self.outf.write('%s\n' % display_url)
 
7081
 
 
7082
 
 
7083
def _register_lazy_builtins():
 
7084
    # register lazy builtins from other modules; called at startup and should
 
7085
    # be only called once.
 
7086
    for (name, aliases, module_name) in [
 
7087
            ('cmd_bisect', [], 'breezy.bisect'),
 
7088
            ('cmd_bundle_info', [], 'breezy.bzr.bundle.commands'),
 
7089
            ('cmd_config', [], 'breezy.config'),
 
7090
            ('cmd_dump_btree', [], 'breezy.bzr.debug_commands'),
 
7091
            ('cmd_file_id', [], 'breezy.bzr.debug_commands'),
 
7092
            ('cmd_file_path', [], 'breezy.bzr.debug_commands'),
 
7093
            ('cmd_version_info', [], 'breezy.cmd_version_info'),
 
7094
            ('cmd_resolve', ['resolved'], 'breezy.conflicts'),
 
7095
            ('cmd_conflicts', [], 'breezy.conflicts'),
 
7096
            ('cmd_ping', [], 'breezy.bzr.smart.ping'),
 
7097
            ('cmd_sign_my_commits', [], 'breezy.commit_signature_commands'),
 
7098
            ('cmd_verify_signatures', [], 'breezy.commit_signature_commands'),
 
7099
            ('cmd_test_script', [], 'breezy.cmd_test_script'),
 
7100
            ]:
 
7101
        builtin_command_registry.register_lazy(name, aliases, module_name)