/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-05-05 23:32:39 UTC
  • mto: (7490.7.21 work)
  • mto: This revision was merged to the branch mainline in revision 7501.
  • Revision ID: jelmer@jelmer.uk-20200505233239-kdmnmscn8eisltk6
Add a breezy.__main__ module.

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