/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: 2018-11-10 17:18:27 UTC
  • mto: (7143.11.2 unused-imports)
  • mto: This revision was merged to the branch mainline in revision 7144.
  • Revision ID: jelmer@jelmer.uk-20181110171827-46xer5sa9fzgab1q
Add flake8 configuration to monkey patch for lazy imports.

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