/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: 2019-02-17 03:45:31 UTC
  • mto: (7290.1.6 work)
  • mto: This revision was merged to the branch mainline in revision 7295.
  • Revision ID: jelmer@jelmer.uk-20190217034531-vw7oc2bo5hdd41jn
Drop documentation about removed pkgimport.conf.

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