/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/merge.py

  • Committer: Jelmer Vernooij
  • Date: 2018-03-01 23:44:14 UTC
  • mto: This revision was merged to the branch mainline in revision 6871.
  • Revision ID: jelmer@jelmer.uk-20180301234414-5btxmc1z8pz131ob
Fix context manager for RecordingUIFactory.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/merge.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
from __future__ import absolute_import
 
18
 
17
19
import warnings
18
20
 
19
 
from bzrlib import (
 
21
from .lazy_import import lazy_import
 
22
lazy_import(globals(), """
 
23
from breezy import (
20
24
    branch as _mod_branch,
 
25
    cleanup,
21
26
    conflicts as _mod_conflicts,
22
27
    debug,
23
 
    decorators,
24
 
    errors,
 
28
    generate_ids,
25
29
    graph as _mod_graph,
26
 
    hooks,
27
30
    merge3,
28
31
    osutils,
29
32
    patiencediff,
34
37
    tree as _mod_tree,
35
38
    tsort,
36
39
    ui,
37
 
    versionedfile
38
 
    )
39
 
from bzrlib.cleanup import OperationWithCleanups
40
 
from bzrlib.symbol_versioning import (
41
 
    deprecated_in,
42
 
    deprecated_method,
 
40
    workingtree,
 
41
    )
 
42
from breezy.bzr import (
 
43
    versionedfile,
 
44
    )
 
45
from breezy.i18n import gettext
 
46
""")
 
47
from . import (
 
48
    decorators,
 
49
    errors,
 
50
    hooks,
 
51
    registry,
 
52
    )
 
53
from .sixish import (
 
54
    viewitems,
43
55
    )
44
56
# TODO: Report back as changes are merged in
45
57
 
46
58
 
47
59
def transform_tree(from_tree, to_tree, interesting_ids=None):
48
60
    from_tree.lock_tree_write()
49
 
    operation = OperationWithCleanups(merge_inner)
 
61
    operation = cleanup.OperationWithCleanups(merge_inner)
50
62
    operation.add_cleanup(from_tree.unlock)
51
63
    operation.run_simple(from_tree.branch, to_tree, from_tree,
52
64
        ignore_zero=True, interesting_ids=interesting_ids, this_tree=from_tree)
55
67
class MergeHooks(hooks.Hooks):
56
68
 
57
69
    def __init__(self):
58
 
        hooks.Hooks.__init__(self)
59
 
        self.create_hook(hooks.HookPoint('merge_file_content',
60
 
            "Called with a bzrlib.merge.Merger object to create a per file "
 
70
        hooks.Hooks.__init__(self, "breezy.merge", "Merger.hooks")
 
71
        self.add_hook('merge_file_content',
 
72
            "Called with a breezy.merge.Merger object to create a per file "
61
73
            "merge object when starting a merge. "
62
74
            "Should return either None or a subclass of "
63
 
            "``bzrlib.merge.AbstractPerFileMerger``. "
 
75
            "``breezy.merge.AbstractPerFileMerger``. "
64
76
            "Such objects will then be called per file "
65
77
            "that needs to be merged (including when one "
66
78
            "side has deleted the file and the other has changed it). "
67
79
            "See the AbstractPerFileMerger API docs for details on how it is "
68
80
            "used by merge.",
69
 
            (2, 1), None))
 
81
            (2, 1))
 
82
        self.add_hook('pre_merge',
 
83
            'Called before a merge. '
 
84
            'Receives a Merger object as the single argument.',
 
85
            (2, 5))
 
86
        self.add_hook('post_merge',
 
87
            'Called after a merge. '
 
88
            'Receives a Merger object as the single argument. '
 
89
            'The return value is ignored.',
 
90
            (2, 5))
70
91
 
71
92
 
72
93
class AbstractPerFileMerger(object):
73
 
    """PerFileMerger objects are used by plugins extending merge for bzrlib.
74
 
 
75
 
    See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
76
 
    
 
94
    """PerFileMerger objects are used by plugins extending merge for breezy.
 
95
 
 
96
    See ``breezy.plugins.news_merge.news_merge`` for an example concrete class.
 
97
 
77
98
    :ivar merger: The Merge3Merger performing the merge.
78
99
    """
79
100
 
83
104
 
84
105
    def merge_contents(self, merge_params):
85
106
        """Attempt to merge the contents of a single file.
86
 
        
87
 
        :param merge_params: A bzrlib.merge.MergeHookParams
88
 
        :return : A tuple of (status, chunks), where status is one of
 
107
 
 
108
        :param merge_params: A breezy.merge.MergeFileHookParams
 
109
        :return: A tuple of (status, chunks), where status is one of
89
110
            'not_applicable', 'success', 'conflicted', or 'delete'.  If status
90
111
            is 'success' or 'conflicted', then chunks should be an iterable of
91
112
            strings for the new file contents.
111
132
 
112
133
    def get_filename(self, params, tree):
113
134
        """Lookup the filename (i.e. basename, not path), given a Tree (e.g.
114
 
        self.merger.this_tree) and a MergeHookParams.
 
135
        self.merger.this_tree) and a MergeFileHookParams.
115
136
        """
116
137
        return osutils.basename(tree.id2path(params.file_id))
117
138
 
118
139
    def get_filepath(self, params, tree):
119
140
        """Calculate the path to the file in a tree.
120
141
 
121
 
        :param params: A MergeHookParams describing the file to merge
 
142
        :param params: A MergeFileHookParams describing the file to merge
122
143
        :param tree: a Tree, e.g. self.merger.this_tree.
123
144
        """
124
145
        return tree.id2path(params.file_id)
131
152
            params.winner == 'other' or
132
153
            # THIS and OTHER aren't both files.
133
154
            not params.is_file_merge() or
134
 
            # The filename doesn't match *.xml
 
155
            # The filename doesn't match
135
156
            not self.file_matches(params)):
136
157
            return 'not_applicable', None
137
158
        return self.merge_matching(params)
152
173
    This is a base class for concrete custom file merging logic. Concrete
153
174
    classes should implement ``merge_text``.
154
175
 
155
 
    See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
156
 
    
 
176
    See ``breezy.plugins.news_merge.news_merge`` for an example concrete class.
 
177
 
157
178
    :ivar affected_files: The configured file paths to merge.
158
179
 
159
180
    :cvar name_prefix: The prefix to use when looking up configuration
160
181
        details. <name_prefix>_merge_files describes the files targeted by the
161
182
        hook for example.
162
 
        
 
183
 
163
184
    :cvar default_files: The default file paths to merge when no configuration
164
185
        is present.
165
186
    """
186
207
            config = self.merger.this_branch.get_config()
187
208
            # Until bzr provides a better policy for caching the config, we
188
209
            # just add the part we're interested in to the params to avoid
189
 
            # reading the config files repeatedly (bazaar.conf, location.conf,
 
210
            # reading the config files repeatedly (breezy.conf, location.conf,
190
211
            # branch.conf).
191
212
            config_key = self.name_prefix + '_merge_files'
192
213
            affected_files = config.get_user_option_as_list(config_key)
208
229
 
209
230
        This is called after checking that the merge should be performed in
210
231
        merge_contents, and it should behave as per
211
 
        ``bzrlib.merge.AbstractPerFileMerger.merge_contents``.
 
232
        ``breezy.merge.AbstractPerFileMerger.merge_contents``.
212
233
        """
213
234
        raise NotImplementedError(self.merge_text)
214
235
 
215
236
 
216
 
class MergeHookParams(object):
 
237
class MergeFileHookParams(object):
217
238
    """Object holding parameters passed to merge_file_content hooks.
218
239
 
219
240
    There are some fields hooks can access:
259
280
    hooks = MergeHooks()
260
281
 
261
282
    def __init__(self, this_branch, other_tree=None, base_tree=None,
262
 
                 this_tree=None, pb=None, change_reporter=None,
 
283
                 this_tree=None, change_reporter=None,
263
284
                 recurse='down', revision_graph=None):
264
285
        object.__init__(self)
265
286
        self.this_branch = this_branch
278
299
        self.interesting_files = None
279
300
        self.show_base = False
280
301
        self.reprocess = False
281
 
        if pb is not None:
282
 
            warnings.warn("pb parameter to Merger() is deprecated and ignored")
283
302
        self.pp = None
284
303
        self.recurse = recurse
285
304
        self.change_reporter = change_reporter
333
352
                                      _set_base_is_other_ancestor)
334
353
 
335
354
    @staticmethod
336
 
    def from_uncommitted(tree, other_tree, pb=None, base_tree=None):
 
355
    def from_uncommitted(tree, other_tree, base_tree=None):
337
356
        """Return a Merger for uncommitted changes in other_tree.
338
357
 
339
358
        :param tree: The tree to merge into
340
359
        :param other_tree: The tree to get uncommitted changes from
341
 
        :param pb: A progress indicator
342
360
        :param base_tree: The basis to use for the merge.  If unspecified,
343
361
            other_tree.basis_tree() will be used.
344
362
        """
345
363
        if base_tree is None:
346
364
            base_tree = other_tree.basis_tree()
347
 
        merger = Merger(tree.branch, other_tree, base_tree, tree, pb)
 
365
        merger = Merger(tree.branch, other_tree, base_tree, tree)
348
366
        merger.base_rev_id = merger.base_tree.get_revision_id()
349
367
        merger.other_rev_id = None
350
368
        merger.other_basis = merger.base_rev_id
351
369
        return merger
352
370
 
353
371
    @classmethod
354
 
    def from_mergeable(klass, tree, mergeable, pb):
 
372
    def from_mergeable(klass, tree, mergeable):
355
373
        """Return a Merger for a bundle or merge directive.
356
374
 
357
375
        :param tree: The tree to merge changes into
358
376
        :param mergeable: A merge directive or bundle
359
 
        :param pb: A progress indicator
360
377
        """
361
378
        mergeable.install_revisions(tree.branch.repository)
362
379
        base_revision_id, other_revision_id, verified =\
369
386
                base_revision_id = None
370
387
            else:
371
388
                trace.warning('Performing cherrypick')
372
 
        merger = klass.from_revision_ids(pb, tree, other_revision_id,
 
389
        merger = klass.from_revision_ids(tree, other_revision_id,
373
390
                                         base_revision_id, revision_graph=
374
391
                                         revision_graph)
375
392
        return merger, verified
376
393
 
377
394
    @staticmethod
378
 
    def from_revision_ids(pb, tree, other, base=None, other_branch=None,
 
395
    def from_revision_ids(tree, other, base=None, other_branch=None,
379
396
                          base_branch=None, revision_graph=None,
380
397
                          tree_branch=None):
381
398
        """Return a Merger for revision-ids.
382
399
 
383
 
        :param pb: A progress indicator
384
400
        :param tree: The tree to merge changes into
385
401
        :param other: The revision-id to use as OTHER
386
402
        :param base: The revision-id to use as BASE.  If not specified, will
396
412
        """
397
413
        if tree_branch is None:
398
414
            tree_branch = tree.branch
399
 
        merger = Merger(tree_branch, this_tree=tree, pb=pb,
 
415
        merger = Merger(tree_branch, this_tree=tree,
400
416
                        revision_graph=revision_graph)
401
417
        if other_branch is None:
402
418
            other_branch = tree.branch
421
437
        return self._cached_trees[revision_id]
422
438
 
423
439
    def _get_tree(self, treespec, possible_transports=None):
424
 
        from bzrlib import workingtree
425
440
        location, revno = treespec
426
441
        if revno is None:
427
442
            tree = workingtree.WorkingTree.open_containing(location)[0]
435
450
        revision_id = _mod_revision.ensure_null(revision_id)
436
451
        return branch, self.revision_tree(revision_id, branch)
437
452
 
438
 
    @deprecated_method(deprecated_in((2, 1, 0)))
439
 
    def ensure_revision_trees(self):
440
 
        if self.this_revision_tree is None:
441
 
            self.this_basis_tree = self.revision_tree(self.this_basis)
442
 
            if self.this_basis == self.this_rev_id:
443
 
                self.this_revision_tree = self.this_basis_tree
444
 
 
445
 
        if self.other_rev_id is None:
446
 
            other_basis_tree = self.revision_tree(self.other_basis)
447
 
            if other_basis_tree.has_changes(self.other_tree):
448
 
                raise errors.WorkingTreeNotRevision(self.this_tree)
449
 
            other_rev_id = self.other_basis
450
 
            self.other_tree = other_basis_tree
451
 
 
452
 
    @deprecated_method(deprecated_in((2, 1, 0)))
453
 
    def file_revisions(self, file_id):
454
 
        self.ensure_revision_trees()
455
 
        def get_id(tree, file_id):
456
 
            revision_id = tree.inventory[file_id].revision
457
 
            return revision_id
458
 
        if self.this_rev_id is None:
459
 
            if self.this_basis_tree.get_file_sha1(file_id) != \
460
 
                self.this_tree.get_file_sha1(file_id):
461
 
                raise errors.WorkingTreeNotRevision(self.this_tree)
462
 
 
463
 
        trees = (self.this_basis_tree, self.other_tree)
464
 
        return [get_id(tree, file_id) for tree in trees]
465
 
 
466
 
    @deprecated_method(deprecated_in((2, 1, 0)))
467
 
    def check_basis(self, check_clean, require_commits=True):
468
 
        if self.this_basis is None and require_commits is True:
469
 
            raise errors.BzrCommandError(
470
 
                "This branch has no commits."
471
 
                " (perhaps you would prefer 'bzr pull')")
472
 
        if check_clean:
473
 
            self.compare_basis()
474
 
            if self.this_basis != self.this_rev_id:
475
 
                raise errors.UncommittedChanges(self.this_tree)
476
 
 
477
 
    @deprecated_method(deprecated_in((2, 1, 0)))
478
 
    def compare_basis(self):
479
 
        try:
480
 
            basis_tree = self.revision_tree(self.this_tree.last_revision())
481
 
        except errors.NoSuchRevision:
482
 
            basis_tree = self.this_tree.basis_tree()
483
 
        if not self.this_tree.has_changes(basis_tree):
484
 
            self.this_rev_id = self.this_basis
485
 
 
486
453
    def set_interesting_files(self, file_list):
487
454
        self.interesting_files = file_list
488
455
 
495
462
    def _add_parent(self):
496
463
        new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
497
464
        new_parent_trees = []
498
 
        operation = OperationWithCleanups(self.this_tree.set_parent_trees)
 
465
        operation = cleanup.OperationWithCleanups(
 
466
            self.this_tree.set_parent_trees)
499
467
        for revision_id in new_parents:
500
468
            try:
501
469
                tree = self.revision_tree(revision_id)
532
500
                raise errors.NoCommits(self.other_branch)
533
501
        if self.other_rev_id is not None:
534
502
            self._cached_trees[self.other_rev_id] = self.other_tree
535
 
        self._maybe_fetch(self.other_branch,self.this_branch, self.other_basis)
 
503
        self._maybe_fetch(self.other_branch, self.this_branch, self.other_basis)
536
504
 
537
505
    def set_other_revision(self, revision_id, other_branch):
538
506
        """Set 'other' based on a branch and revision id
576
544
            elif len(lcas) == 1:
577
545
                self.base_rev_id = list(lcas)[0]
578
546
            else: # len(lcas) > 1
 
547
                self._is_criss_cross = True
579
548
                if len(lcas) > 2:
580
549
                    # find_unique_lca can only handle 2 nodes, so we have to
581
550
                    # start back at the beginning. It is a shame to traverse
586
555
                else:
587
556
                    self.base_rev_id = self.revision_graph.find_unique_lca(
588
557
                                            *lcas)
589
 
                self._is_criss_cross = True
 
558
                sorted_lca_keys = self.revision_graph.find_merge_order(
 
559
                    revisions[0], lcas)
 
560
                if self.base_rev_id == _mod_revision.NULL_REVISION:
 
561
                    self.base_rev_id = sorted_lca_keys[0]
 
562
 
590
563
            if self.base_rev_id == _mod_revision.NULL_REVISION:
591
564
                raise errors.UnrelatedBranches()
592
565
            if self._is_criss_cross:
593
566
                trace.warning('Warning: criss-cross merge encountered.  See bzr'
594
567
                              ' help criss-cross.')
595
568
                trace.mutter('Criss-cross lcas: %r' % lcas)
596
 
                interesting_revision_ids = [self.base_rev_id]
597
 
                interesting_revision_ids.extend(lcas)
 
569
                if self.base_rev_id in lcas:
 
570
                    trace.mutter('Unable to find unique lca. '
 
571
                                 'Fallback %r as best option.'
 
572
                                 % self.base_rev_id)
 
573
                interesting_revision_ids = set(lcas)
 
574
                interesting_revision_ids.add(self.base_rev_id)
598
575
                interesting_trees = dict((t.get_revision_id(), t)
599
576
                    for t in self.this_branch.repository.revision_trees(
600
577
                        interesting_revision_ids))
601
578
                self._cached_trees.update(interesting_trees)
602
 
                self.base_tree = interesting_trees.pop(self.base_rev_id)
603
 
                sorted_lca_keys = self.revision_graph.find_merge_order(
604
 
                    revisions[0], lcas)
 
579
                if self.base_rev_id in lcas:
 
580
                    self.base_tree = interesting_trees[self.base_rev_id]
 
581
                else:
 
582
                    self.base_tree = interesting_trees.pop(self.base_rev_id)
605
583
                self._lca_trees = [interesting_trees[key]
606
584
                                   for key in sorted_lca_keys]
607
585
            else:
630
608
            self._maybe_fetch(base_branch, self.this_branch, self.base_rev_id)
631
609
 
632
610
    def make_merger(self):
633
 
        kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
 
611
        kwargs = {'working_tree': self.this_tree, 'this_tree': self.this_tree,
634
612
                  'other_tree': self.other_tree,
635
613
                  'interesting_ids': self.interesting_ids,
636
614
                  'interesting_files': self.interesting_files,
637
615
                  'this_branch': self.this_branch,
 
616
                  'other_branch': self.other_branch,
638
617
                  'do_merge': False}
639
618
        if self.merge_type.requires_base:
640
619
            kwargs['base_tree'] = self.base_tree
658
637
        if self._is_criss_cross and getattr(self.merge_type,
659
638
                                            'supports_lca_trees', False):
660
639
            kwargs['lca_trees'] = self._lca_trees
661
 
        return self.merge_type(pb=None,
662
 
                               change_reporter=self.change_reporter,
 
640
        return self.merge_type(change_reporter=self.change_reporter,
663
641
                               **kwargs)
664
642
 
665
643
    def _do_merge_to(self):
666
644
        merge = self.make_merger()
667
645
        if self.other_branch is not None:
668
646
            self.other_branch.update_references(self.this_branch)
 
647
        for hook in Merger.hooks['pre_merge']:
 
648
            hook(merge)
669
649
        merge.do_merge()
 
650
        for hook in Merger.hooks['post_merge']:
 
651
            hook(merge)
670
652
        if self.recurse == 'down':
671
653
            for relpath, file_id in self.this_tree.iter_references():
672
 
                sub_tree = self.this_tree.get_nested_tree(file_id, relpath)
 
654
                sub_tree = self.this_tree.get_nested_tree(relpath, file_id)
673
655
                other_revision = self.other_tree.get_reference_revision(
674
 
                    file_id, relpath)
 
656
                    relpath, file_id)
675
657
                if  other_revision == sub_tree.last_revision():
676
658
                    continue
677
659
                sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
678
660
                sub_merge.merge_type = self.merge_type
679
 
                other_branch = self.other_branch.reference_parent(file_id, relpath)
 
661
                other_branch = self.other_branch.reference_parent(file_id,
 
662
                                                                  relpath)
680
663
                sub_merge.set_other_revision(other_revision, other_branch)
681
 
                base_revision = self.base_tree.get_reference_revision(file_id)
 
664
                base_tree_path = self.base_tree.id2path(file_id)
 
665
                base_revision = self.base_tree.get_reference_revision(
 
666
                    base_tree_path, file_id)
682
667
                sub_merge.base_tree = \
683
668
                    sub_tree.branch.repository.revision_tree(base_revision)
684
669
                sub_merge.base_rev_id = base_revision
686
671
        return merge
687
672
 
688
673
    def do_merge(self):
689
 
        operation = OperationWithCleanups(self._do_merge_to)
 
674
        operation = cleanup.OperationWithCleanups(self._do_merge_to)
690
675
        self.this_tree.lock_tree_write()
691
676
        operation.add_cleanup(self.this_tree.unlock)
692
677
        if self.base_tree is not None:
698
683
        merge = operation.run_simple()
699
684
        if len(merge.cooked_conflicts) == 0:
700
685
            if not self.ignore_zero and not trace.is_quiet():
701
 
                trace.note("All changes applied successfully.")
 
686
                trace.note(gettext("All changes applied successfully."))
702
687
        else:
703
 
            trace.note("%d conflicts encountered."
 
688
            trace.note(gettext("%d conflicts encountered.")
704
689
                       % len(merge.cooked_conflicts))
705
690
 
706
691
        return len(merge.cooked_conflicts)
733
718
    supports_reverse_cherrypick = True
734
719
    winner_idx = {"this": 2, "other": 1, "conflict": 1}
735
720
    supports_lca_trees = True
 
721
    requires_file_merge_plan = False
736
722
 
737
723
    def __init__(self, working_tree, this_tree, base_tree, other_tree,
738
724
                 interesting_ids=None, reprocess=False, show_base=False,
739
 
                 pb=None, pp=None, change_reporter=None,
740
 
                 interesting_files=None, do_merge=True,
741
 
                 cherrypick=False, lca_trees=None, this_branch=None):
 
725
                 change_reporter=None, interesting_files=None, do_merge=True,
 
726
                 cherrypick=False, lca_trees=None, this_branch=None,
 
727
                 other_branch=None):
742
728
        """Initialize the merger object and perform the merge.
743
729
 
744
730
        :param working_tree: The working tree to apply the merge to
747
733
        :param other_tree: The other tree to merge changes from
748
734
        :param this_branch: The branch associated with this_tree.  Defaults to
749
735
            this_tree.branch if not supplied.
 
736
        :param other_branch: The branch associated with other_tree, if any.
750
737
        :param interesting_ids: The file_ids of files that should be
751
738
            participate in the merge.  May not be combined with
752
739
            interesting_files.
753
740
        :param: reprocess If True, perform conflict-reduction processing.
754
741
        :param show_base: If True, show the base revision in text conflicts.
755
742
            (incompatible with reprocess)
756
 
        :param pb: ignored
757
 
        :param pp: A ProgressPhase object
758
743
        :param change_reporter: An object that should report changes made
759
744
        :param interesting_files: The tree-relative paths of files that should
760
745
            participate in the merge.  If these paths refer to directories,
774
759
            this_branch = this_tree.branch
775
760
        self.interesting_ids = interesting_ids
776
761
        self.interesting_files = interesting_files
777
 
        self.this_tree = working_tree
 
762
        self.working_tree = working_tree
 
763
        self.this_tree = this_tree
778
764
        self.base_tree = base_tree
779
765
        self.other_tree = other_tree
780
766
        self.this_branch = this_branch
 
767
        self.other_branch = other_branch
781
768
        self._raw_conflicts = []
782
769
        self.cooked_conflicts = []
783
770
        self.reprocess = reprocess
792
779
        self.cherrypick = cherrypick
793
780
        if do_merge:
794
781
            self.do_merge()
795
 
        if pp is not None:
796
 
            warnings.warn("pp argument to Merge3Merger is deprecated")
797
 
        if pb is not None:
798
 
            warnings.warn("pb argument to Merge3Merger is deprecated")
799
782
 
800
783
    def do_merge(self):
801
 
        operation = OperationWithCleanups(self._do_merge)
802
 
        self.this_tree.lock_tree_write()
 
784
        operation = cleanup.OperationWithCleanups(self._do_merge)
 
785
        self.working_tree.lock_tree_write()
 
786
        operation.add_cleanup(self.working_tree.unlock)
 
787
        self.this_tree.lock_read()
803
788
        operation.add_cleanup(self.this_tree.unlock)
804
789
        self.base_tree.lock_read()
805
790
        operation.add_cleanup(self.base_tree.unlock)
808
793
        operation.run()
809
794
 
810
795
    def _do_merge(self, operation):
811
 
        self.tt = transform.TreeTransform(self.this_tree, None)
 
796
        self.tt = transform.TreeTransform(self.working_tree, None)
812
797
        operation.add_cleanup(self.tt.finalize)
813
798
        self._compute_transform()
814
799
        results = self.tt.apply(no_conflicts=True)
815
800
        self.write_modified(results)
816
801
        try:
817
 
            self.this_tree.add_conflicts(self.cooked_conflicts)
 
802
            self.working_tree.add_conflicts(self.cooked_conflicts)
818
803
        except errors.UnsupportedOperation:
819
804
            pass
820
805
 
821
806
    def make_preview_transform(self):
822
 
        operation = OperationWithCleanups(self._make_preview_transform)
 
807
        operation = cleanup.OperationWithCleanups(self._make_preview_transform)
823
808
        self.base_tree.lock_read()
824
809
        operation.add_cleanup(self.base_tree.unlock)
825
810
        self.other_tree.lock_read()
827
812
        return operation.run_simple()
828
813
 
829
814
    def _make_preview_transform(self):
830
 
        self.tt = transform.TransformPreview(self.this_tree)
 
815
        self.tt = transform.TransformPreview(self.working_tree)
831
816
        self._compute_transform()
832
817
        return self.tt
833
818
 
838
823
        else:
839
824
            entries = self._entries_lca()
840
825
            resolver = self._lca_multi_way
841
 
        child_pb = ui.ui_factory.nested_progress_bar()
842
 
        try:
843
 
            factories = Merger.hooks['merge_file_content']
844
 
            hooks = [factory(self) for factory in factories] + [self]
845
 
            self.active_hooks = [hook for hook in hooks if hook is not None]
 
826
        # Prepare merge hooks
 
827
        factories = Merger.hooks['merge_file_content']
 
828
        # One hook for each registered one plus our default merger
 
829
        hooks = [factory(self) for factory in factories] + [self]
 
830
        self.active_hooks = [hook for hook in hooks if hook is not None]
 
831
        with ui.ui_factory.nested_progress_bar() as child_pb:
846
832
            for num, (file_id, changed, parents3, names3,
847
833
                      executable3) in enumerate(entries):
848
 
                child_pb.update('Preparing file merge', num, len(entries))
 
834
                # Try merging each entry
 
835
                child_pb.update(gettext('Preparing file merge'),
 
836
                                num, len(entries))
849
837
                self._merge_names(file_id, parents3, names3, resolver=resolver)
850
838
                if changed:
851
839
                    file_status = self._do_merge_contents(file_id)
853
841
                    file_status = 'unmodified'
854
842
                self._merge_executable(file_id,
855
843
                    executable3, file_status, resolver=resolver)
856
 
        finally:
857
 
            child_pb.finished()
858
 
        self.fix_root()
859
 
        child_pb = ui.ui_factory.nested_progress_bar()
860
 
        try:
 
844
        self.tt.fixup_new_roots()
 
845
        self._finish_computing_transform()
 
846
 
 
847
    def _finish_computing_transform(self):
 
848
        """Finalize the transform and report the changes.
 
849
 
 
850
        This is the second half of _compute_transform.
 
851
        """
 
852
        with ui.ui_factory.nested_progress_bar() as child_pb:
861
853
            fs_conflicts = transform.resolve_conflicts(self.tt, child_pb,
862
854
                lambda t, c: transform.conflict_pass(t, c, self.other_tree))
863
 
        finally:
864
 
            child_pb.finished()
865
855
        if self.change_reporter is not None:
866
 
            from bzrlib import delta
 
856
            from breezy import delta
867
857
            delta.report_changes(
868
858
                self.tt.iter_changes(), self.change_reporter)
869
859
        self.cook_conflicts(fs_conflicts)
870
860
        for conflict in self.cooked_conflicts:
871
 
            trace.warning(conflict)
 
861
            trace.warning(unicode(conflict))
872
862
 
873
863
    def _entries3(self):
874
864
        """Gather data about files modified between three trees.
881
871
        """
882
872
        result = []
883
873
        iterator = self.other_tree.iter_changes(self.base_tree,
884
 
                include_unchanged=True, specific_files=self.interesting_files,
 
874
                specific_files=self.interesting_files,
885
875
                extra_trees=[self.this_tree])
886
876
        this_entries = dict((e.file_id, e) for p, e in
887
877
                            self.this_tree.iter_entries_by_dir(
913
903
        it then compares with THIS and BASE.
914
904
 
915
905
        For the multi-valued entries, the format will be (BASE, [lca1, lca2])
916
 
        :return: [(file_id, changed, parents, names, executable)]
917
 
            file_id     Simple file_id of the entry
918
 
            changed     Boolean, True if the kind or contents changed
919
 
                        else False
920
 
            parents     ((base, [parent_id, in, lcas]), parent_id_other,
921
 
                         parent_id_this)
922
 
            names       ((base, [name, in, lcas]), name_in_other, name_in_this)
923
 
            executable  ((base, [exec, in, lcas]), exec_in_other, exec_in_this)
 
906
 
 
907
        :return: [(file_id, changed, parents, names, executable)], where:
 
908
 
 
909
            * file_id: Simple file_id of the entry
 
910
            * changed: Boolean, True if the kind or contents changed else False
 
911
            * parents: ((base, [parent_id, in, lcas]), parent_id_other,
 
912
                        parent_id_this)
 
913
            * names:   ((base, [name, in, lcas]), name_in_other, name_in_this)
 
914
            * executable: ((base, [exec, in, lcas]), exec_in_other,
 
915
                        exec_in_this)
924
916
        """
925
917
        if self.interesting_files is not None:
926
918
            lookup_trees = [self.this_tree, self.base_tree]
933
925
        result = []
934
926
        walker = _mod_tree.MultiWalker(self.other_tree, self._lca_trees)
935
927
 
936
 
        base_inventory = self.base_tree.inventory
937
 
        this_inventory = self.this_tree.inventory
 
928
        base_inventory = self.base_tree.root_inventory
 
929
        this_inventory = self.this_tree.root_inventory
938
930
        for path, file_id, other_ie, lca_values in walker.iter_all():
939
931
            # Is this modified at all from any of the other trees?
940
932
            if other_ie is None:
968
960
                else:
969
961
                    lca_entries.append(lca_ie)
970
962
 
971
 
            if file_id in base_inventory:
 
963
            if base_inventory.has_id(file_id):
972
964
                base_ie = base_inventory[file_id]
973
965
            else:
974
966
                base_ie = _none_entry
975
967
 
976
 
            if file_id in this_inventory:
 
968
            if this_inventory.has_id(file_id):
977
969
                this_ie = this_inventory[file_id]
978
970
            else:
979
971
                this_ie = _none_entry
1010
1002
                    def get_sha1(ie, tree):
1011
1003
                        if ie.kind != 'file':
1012
1004
                            return None
1013
 
                        return tree.get_file_sha1(file_id)
 
1005
                        return tree.get_file_sha1(tree.id2path(file_id), file_id)
1014
1006
                    base_sha1 = get_sha1(base_ie, self.base_tree)
1015
1007
                    lca_sha1s = [get_sha1(ie, tree) for ie, tree
1016
1008
                                 in zip(lca_entries, self._lca_trees)]
1033
1025
                    def get_target(ie, tree):
1034
1026
                        if ie.kind != 'symlink':
1035
1027
                            return None
1036
 
                        return tree.get_symlink_target(file_id)
 
1028
                        path = tree.id2path(file_id)
 
1029
                        return tree.get_symlink_target(path, file_id)
1037
1030
                    base_target = get_target(base_ie, self.base_tree)
1038
1031
                    lca_targets = [get_target(ie, tree) for ie, tree
1039
1032
                                   in zip(lca_entries, self._lca_trees)]
1071
1064
                          ))
1072
1065
        return result
1073
1066
 
1074
 
 
1075
 
    def fix_root(self):
1076
 
        try:
1077
 
            self.tt.final_kind(self.tt.root)
1078
 
        except errors.NoSuchFile:
1079
 
            self.tt.cancel_deletion(self.tt.root)
1080
 
        if self.tt.final_file_id(self.tt.root) is None:
1081
 
            self.tt.version_file(self.tt.tree_file_id(self.tt.root),
1082
 
                                 self.tt.root)
1083
 
        other_root_file_id = self.other_tree.get_root_id()
1084
 
        if other_root_file_id is None:
1085
 
            return
1086
 
        other_root = self.tt.trans_id_file_id(other_root_file_id)
1087
 
        if other_root == self.tt.root:
1088
 
            return
1089
 
        if self.other_tree.inventory.root.file_id in self.this_tree.inventory:
1090
 
            # the other tree's root is a non-root in the current tree (as when
1091
 
            # a previously unrelated branch is merged into another)
1092
 
            return
1093
 
        try:
1094
 
            self.tt.final_kind(other_root)
1095
 
            other_root_is_present = True
1096
 
        except errors.NoSuchFile:
1097
 
            # other_root doesn't have a physical representation. We still need
1098
 
            # to move any references to the actual root of the tree.
1099
 
            other_root_is_present = False
1100
 
        # 'other_tree.inventory.root' is not present in this tree. We are
1101
 
        # calling adjust_path for children which *want* to be present with a
1102
 
        # correct place to go.
1103
 
        for thing, child in self.other_tree.inventory.root.children.iteritems():
1104
 
            trans_id = self.tt.trans_id_file_id(child.file_id)
1105
 
            if not other_root_is_present:
1106
 
                # FIXME: Make final_kind returns None instead of raising
1107
 
                # NoSuchFile to avoid the ugly construct below -- vila 20100402
1108
 
                try:
1109
 
                    self.tt.final_kind(trans_id)
1110
 
                    # The item exist in the final tree and has a defined place
1111
 
                    # to go already.
1112
 
                    continue
1113
 
                except errors.NoSuchFile, e:
1114
 
                    pass
1115
 
            # Move the item into the root
1116
 
            self.tt.adjust_path(self.tt.final_name(trans_id),
1117
 
                                self.tt.root, trans_id)
1118
 
        if other_root_is_present:
1119
 
            self.tt.cancel_creation(other_root)
1120
 
            self.tt.cancel_versioning(other_root)
1121
 
 
1122
1067
    def write_modified(self, results):
1123
1068
        modified_hashes = {}
1124
1069
        for path in results.modified_paths:
1125
 
            file_id = self.this_tree.path2id(self.this_tree.relpath(path))
 
1070
            wt_relpath = self.working_tree.relpath(path)
 
1071
            file_id = self.working_tree.path2id(wt_relpath)
1126
1072
            if file_id is None:
1127
1073
                continue
1128
 
            hash = self.this_tree.get_file_sha1(file_id)
 
1074
            hash = self.working_tree.get_file_sha1(wt_relpath, file_id)
1129
1075
            if hash is None:
1130
1076
                continue
1131
1077
            modified_hashes[file_id] = hash
1132
 
        self.this_tree.set_merge_modified(modified_hashes)
 
1078
        self.working_tree.set_merge_modified(modified_hashes)
1133
1079
 
1134
1080
    @staticmethod
1135
1081
    def parent(entry, file_id):
1148
1094
    @staticmethod
1149
1095
    def contents_sha1(tree, file_id):
1150
1096
        """Determine the sha1 of the file contents (used as a key method)."""
1151
 
        if file_id not in tree:
 
1097
        try:
 
1098
            path = tree.id2path(file_id)
 
1099
        except errors.NoSuchId:
1152
1100
            return None
1153
 
        return tree.get_file_sha1(file_id)
 
1101
        return tree.get_file_sha1(path, file_id)
1154
1102
 
1155
1103
    @staticmethod
1156
1104
    def executable(tree, file_id):
1157
1105
        """Determine the executability of a file-id (used as a key method)."""
1158
 
        if not tree.has_id(file_id):
 
1106
        try:
 
1107
            path = tree.id2path(file_id)
 
1108
        except errors.NoSuchId:
1159
1109
            return None
1160
 
        if tree.kind(file_id) != "file":
 
1110
        if tree.kind(path, file_id) != "file":
1161
1111
            return False
1162
 
        return tree.is_executable(file_id)
 
1112
        return tree.is_executable(path, file_id)
1163
1113
 
1164
1114
    @staticmethod
1165
 
    def kind(tree, file_id):
 
1115
    def kind(tree, path, file_id):
1166
1116
        """Determine the kind of a file-id (used as a key method)."""
1167
 
        if not tree.has_id(file_id):
 
1117
        try:
 
1118
            path = tree.id2path(file_id)
 
1119
        except errors.NoSuchId:
1168
1120
            return None
1169
 
        return tree.kind(file_id)
 
1121
        return tree.kind(path, file_id)
1170
1122
 
1171
1123
    @staticmethod
1172
1124
    def _three_way(base, other, this):
1234
1186
        # At this point, the lcas disagree, and the tip disagree
1235
1187
        return 'conflict'
1236
1188
 
1237
 
    @staticmethod
1238
 
    @deprecated_method(deprecated_in((2, 2, 0)))
1239
 
    def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
1240
 
        """Do a three-way test on a scalar.
1241
 
        Return "this", "other" or "conflict", depending whether a value wins.
1242
 
        """
1243
 
        key_base = key(base_tree, file_id)
1244
 
        key_other = key(other_tree, file_id)
1245
 
        #if base == other, either they all agree, or only THIS has changed.
1246
 
        if key_base == key_other:
1247
 
            return "this"
1248
 
        key_this = key(this_tree, file_id)
1249
 
        # "Ambiguous clean merge"
1250
 
        if key_this == key_other:
1251
 
            return "this"
1252
 
        elif key_this == key_base:
1253
 
            return "other"
1254
 
        else:
1255
 
            return "conflict"
1256
 
 
1257
1189
    def merge_names(self, file_id):
1258
1190
        def get_entry(tree):
1259
 
            if tree.has_id(file_id):
1260
 
                return tree.inventory[file_id]
1261
 
            else:
 
1191
            try:
 
1192
                return tree.root_inventory[file_id]
 
1193
            except errors.NoSuchId:
1262
1194
                return None
1263
1195
        this_entry = get_entry(self.this_tree)
1264
1196
        other_entry = get_entry(self.other_tree)
1299
1231
            self._raw_conflicts.append(('path conflict', trans_id, file_id,
1300
1232
                                        this_parent, this_name,
1301
1233
                                        other_parent, other_name))
1302
 
        if other_name is None:
 
1234
        if not self.other_tree.has_id(file_id):
1303
1235
            # it doesn't matter whether the result was 'other' or
1304
 
            # 'conflict'-- if there's no 'other', we leave it alone.
 
1236
            # 'conflict'-- if it has no file id, we leave it alone.
1305
1237
            return
1306
1238
        parent_id = parents[self.winner_idx[parent_id_winner]]
1307
 
        if parent_id is not None:
 
1239
        name = names[self.winner_idx[name_winner]]
 
1240
        if parent_id is not None or name is not None:
1308
1241
            # if we get here, name_winner and parent_winner are set to safe
1309
1242
            # values.
1310
 
            self.tt.adjust_path(names[self.winner_idx[name_winner]],
1311
 
                                self.tt.trans_id_file_id(parent_id),
 
1243
            if parent_id is None and name is not None:
 
1244
                # if parent_id is None and name is non-None, current file is
 
1245
                # the tree root.
 
1246
                if names[self.winner_idx[parent_id_winner]] != '':
 
1247
                    raise AssertionError(
 
1248
                        'File looks like a root, but named %s' %
 
1249
                        names[self.winner_idx[parent_id_winner]])
 
1250
                parent_trans_id = transform.ROOT_PARENT
 
1251
            else:
 
1252
                parent_trans_id = self.tt.trans_id_file_id(parent_id)
 
1253
            self.tt.adjust_path(name, parent_trans_id,
1312
1254
                                self.tt.trans_id_file_id(file_id))
1313
1255
 
1314
1256
    def _do_merge_contents(self, file_id):
1315
1257
        """Performs a merge on file_id contents."""
1316
1258
        def contents_pair(tree):
1317
 
            if file_id not in tree:
1318
 
                return (None, None)
1319
 
            kind = tree.kind(file_id)
 
1259
            try:
 
1260
                path = tree.id2path(file_id)
 
1261
            except errors.NoSuchId:
 
1262
                return (None, None)
 
1263
            try:
 
1264
                kind = tree.kind(path, file_id)
 
1265
            except errors.NoSuchFile:
 
1266
                return (None, None)
1320
1267
            if kind == "file":
1321
 
                contents = tree.get_file_sha1(file_id)
 
1268
                contents = tree.get_file_sha1(path, file_id)
1322
1269
            elif kind == "symlink":
1323
 
                contents = tree.get_symlink_target(file_id)
 
1270
                contents = tree.get_symlink_target(path, file_id)
1324
1271
            else:
1325
1272
                contents = None
1326
1273
            return kind, contents
1349
1296
        # We have a hypothetical conflict, but if we have files, then we
1350
1297
        # can try to merge the content
1351
1298
        trans_id = self.tt.trans_id_file_id(file_id)
1352
 
        params = MergeHookParams(self, file_id, trans_id, this_pair[0],
 
1299
        params = MergeFileHookParams(self, file_id, trans_id, this_pair[0],
1353
1300
            other_pair[0], winner)
1354
1301
        hooks = self.active_hooks
1355
1302
        hook_status = 'not_applicable'
1358
1305
            if hook_status != 'not_applicable':
1359
1306
                # Don't try any more hooks, this one applies.
1360
1307
                break
 
1308
        # If the merge ends up replacing the content of the file, we get rid of
 
1309
        # it at the end of this method (this variable is used to track the
 
1310
        # exceptions to this rule).
 
1311
        keep_this = False
1361
1312
        result = "modified"
1362
1313
        if hook_status == 'not_applicable':
1363
 
            # This is a contents conflict, because none of the available
1364
 
            # functions could merge it.
 
1314
            # No merge hook was able to resolve the situation. Two cases exist:
 
1315
            # a content conflict or a duplicate one.
1365
1316
            result = None
1366
1317
            name = self.tt.final_name(trans_id)
1367
1318
            parent_id = self.tt.final_parent(trans_id)
1368
 
            if self.this_tree.has_id(file_id):
1369
 
                self.tt.unversion_file(trans_id)
1370
 
            file_group = self._dump_conflicts(name, parent_id, file_id,
1371
 
                                              set_version=True)
1372
 
            self._raw_conflicts.append(('contents conflict', file_group))
 
1319
            duplicate = False
 
1320
            inhibit_content_conflict = False
 
1321
            if params.this_kind is None: # file_id is not in THIS
 
1322
                # Is the name used for a different file_id ?
 
1323
                dupe_path = self.other_tree.id2path(file_id)
 
1324
                this_id = self.this_tree.path2id(dupe_path)
 
1325
                if this_id is not None:
 
1326
                    # Two entries for the same path
 
1327
                    keep_this = True
 
1328
                    # versioning the merged file will trigger a duplicate
 
1329
                    # conflict
 
1330
                    self.tt.version_file(file_id, trans_id)
 
1331
                    transform.create_from_tree(
 
1332
                        self.tt, trans_id, self.other_tree,
 
1333
                        self.other_tree.id2path(file_id), file_id=file_id,
 
1334
                        filter_tree_path=self._get_filter_tree_path(file_id))
 
1335
                    inhibit_content_conflict = True
 
1336
            elif params.other_kind is None: # file_id is not in OTHER
 
1337
                # Is the name used for a different file_id ?
 
1338
                dupe_path = self.this_tree.id2path(file_id)
 
1339
                other_id = self.other_tree.path2id(dupe_path)
 
1340
                if other_id is not None:
 
1341
                    # Two entries for the same path again, but here, the other
 
1342
                    # entry will also be merged.  We simply inhibit the
 
1343
                    # 'content' conflict creation because we know OTHER will
 
1344
                    # create (or has already created depending on ordering) an
 
1345
                    # entry at the same path. This will trigger a 'duplicate'
 
1346
                    # conflict later.
 
1347
                    keep_this = True
 
1348
                    inhibit_content_conflict = True
 
1349
            if not inhibit_content_conflict:
 
1350
                if params.this_kind is not None:
 
1351
                    self.tt.unversion_file(trans_id)
 
1352
                # This is a contents conflict, because none of the available
 
1353
                # functions could merge it.
 
1354
                file_group = self._dump_conflicts(name, parent_id, file_id,
 
1355
                                                  set_version=True)
 
1356
                self._raw_conflicts.append(('contents conflict', file_group))
1373
1357
        elif hook_status == 'success':
1374
1358
            self.tt.create_file(lines, trans_id)
1375
1359
        elif hook_status == 'conflicted':
1391
1375
            raise AssertionError('unknown hook_status: %r' % (hook_status,))
1392
1376
        if not self.this_tree.has_id(file_id) and result == "modified":
1393
1377
            self.tt.version_file(file_id, trans_id)
1394
 
        # The merge has been performed, so the old contents should not be
1395
 
        # retained.
1396
 
        try:
 
1378
        if not keep_this:
 
1379
            # The merge has been performed and produced a new content, so the
 
1380
            # old contents should not be retained.
1397
1381
            self.tt.delete_contents(trans_id)
1398
 
        except errors.NoSuchFile:
1399
 
            pass
1400
1382
        return result
1401
1383
 
1402
1384
    def _default_other_winner_merge(self, merge_hook_params):
1403
1385
        """Replace this contents with other."""
1404
1386
        file_id = merge_hook_params.file_id
1405
1387
        trans_id = merge_hook_params.trans_id
1406
 
        file_in_this = self.this_tree.has_id(file_id)
1407
1388
        if self.other_tree.has_id(file_id):
1408
1389
            # OTHER changed the file
1409
 
            wt = self.this_tree
1410
 
            if wt.supports_content_filtering():
1411
 
                # We get the path from the working tree if it exists.
1412
 
                # That fails though when OTHER is adding a file, so
1413
 
                # we fall back to the other tree to find the path if
1414
 
                # it doesn't exist locally.
1415
 
                try:
1416
 
                    filter_tree_path = wt.id2path(file_id)
1417
 
                except errors.NoSuchId:
1418
 
                    filter_tree_path = self.other_tree.id2path(file_id)
1419
 
            else:
1420
 
                # Skip the id2path lookup for older formats
1421
 
                filter_tree_path = None
1422
 
            transform.create_from_tree(self.tt, trans_id,
1423
 
                             self.other_tree, file_id,
1424
 
                             filter_tree_path=filter_tree_path)
 
1390
            transform.create_from_tree(
 
1391
                self.tt, trans_id, self.other_tree,
 
1392
                self.other_tree.id2path(file_id), file_id=file_id,
 
1393
                filter_tree_path=self._get_filter_tree_path(file_id))
1425
1394
            return 'done', None
1426
 
        elif file_in_this:
 
1395
        elif self.this_tree.has_id(file_id):
1427
1396
            # OTHER deleted the file
1428
1397
            return 'delete', None
1429
1398
        else:
1434
1403
    def merge_contents(self, merge_hook_params):
1435
1404
        """Fallback merge logic after user installed hooks."""
1436
1405
        # This function is used in merge hooks as the fallback instance.
1437
 
        # Perhaps making this function and the functions it calls be a 
 
1406
        # Perhaps making this function and the functions it calls be a
1438
1407
        # a separate class would be better.
1439
1408
        if merge_hook_params.winner == 'other':
1440
1409
            # OTHER is a straight winner, so replace this contents with other
1454
1423
 
1455
1424
    def get_lines(self, tree, file_id):
1456
1425
        """Return the lines in a file, or an empty list."""
1457
 
        if tree.has_id(file_id):
1458
 
            return tree.get_file(file_id).readlines()
1459
 
        else:
 
1426
        try:
 
1427
            path = tree.id2path(file_id)
 
1428
        except errors.NoSuchId:
1460
1429
            return []
 
1430
        else:
 
1431
            return tree.get_file_lines(path, file_id)
1461
1432
 
1462
1433
    def text_merge(self, file_id, trans_id):
1463
1434
        """Perform a three-way text merge on a file_id"""
1464
1435
        # it's possible that we got here with base as a different type.
1465
1436
        # if so, we just want two-way text conflicts.
1466
 
        if self.base_tree.has_id(file_id) and \
1467
 
            self.base_tree.kind(file_id) == "file":
1468
 
            base_lines = self.get_lines(self.base_tree, file_id)
1469
 
        else:
 
1437
        try:
 
1438
            base_path = self.base_tree.id2path(file_id)
 
1439
        except errors.NoSuchId:
1470
1440
            base_lines = []
 
1441
        else:
 
1442
            if self.base_tree.kind(base_path, file_id) == "file":
 
1443
                base_lines = self.get_lines(self.base_tree, file_id)
 
1444
            else:
 
1445
                base_lines = []
1471
1446
        other_lines = self.get_lines(self.other_tree, file_id)
1472
1447
        this_lines = self.get_lines(self.this_tree, file_id)
1473
1448
        m3 = merge3.Merge3(base_lines, this_lines, other_lines,
1503
1478
                                              other_lines)
1504
1479
            file_group.append(trans_id)
1505
1480
 
 
1481
    def _get_filter_tree_path(self, file_id):
 
1482
        if self.this_tree.supports_content_filtering():
 
1483
            # We get the path from the working tree if it exists.
 
1484
            # That fails though when OTHER is adding a file, so
 
1485
            # we fall back to the other tree to find the path if
 
1486
            # it doesn't exist locally.
 
1487
            try:
 
1488
                return self.this_tree.id2path(file_id)
 
1489
            except errors.NoSuchId:
 
1490
                return self.other_tree.id2path(file_id)
 
1491
        # Skip the id2path lookup for older formats
 
1492
        return None
 
1493
 
1506
1494
    def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
1507
1495
                        base_lines=None, other_lines=None, set_version=False,
1508
1496
                        no_base=False):
1532
1520
        versioned = False
1533
1521
        file_group = []
1534
1522
        for suffix, tree, lines in data:
1535
 
            if tree.has_id(file_id):
1536
 
                trans_id = self._conflict_file(name, parent_id, tree, file_id,
1537
 
                                               suffix, lines, filter_tree_path)
 
1523
            try:
 
1524
                path = tree.id2path(file_id)
 
1525
            except errors.NoSuchId:
 
1526
                pass
 
1527
            else:
 
1528
                trans_id = self._conflict_file(
 
1529
                        name, parent_id, path, tree, file_id, suffix, lines,
 
1530
                        filter_tree_path)
1538
1531
                file_group.append(trans_id)
1539
1532
                if set_version and not versioned:
1540
1533
                    self.tt.version_file(file_id, trans_id)
1541
1534
                    versioned = True
1542
1535
        return file_group
1543
1536
 
1544
 
    def _conflict_file(self, name, parent_id, tree, file_id, suffix,
 
1537
    def _conflict_file(self, name, parent_id, path, tree, file_id, suffix,
1545
1538
                       lines=None, filter_tree_path=None):
1546
1539
        """Emit a single conflict file."""
1547
1540
        name = name + '.' + suffix
1548
1541
        trans_id = self.tt.create_path(name, parent_id)
1549
 
        transform.create_from_tree(self.tt, trans_id, tree, file_id, lines,
1550
 
            filter_tree_path)
 
1542
        transform.create_from_tree(
 
1543
                self.tt, trans_id, tree, path,
 
1544
                file_id=file_id, bytes=lines,
 
1545
                filter_tree_path=filter_tree_path)
1551
1546
        return trans_id
1552
1547
 
1553
1548
    def merge_executable(self, file_id, file_status):
1574
1569
        if winner == 'this' and file_status != "modified":
1575
1570
            return
1576
1571
        trans_id = self.tt.trans_id_file_id(file_id)
1577
 
        try:
1578
 
            if self.tt.final_kind(trans_id) != "file":
1579
 
                return
1580
 
        except errors.NoSuchFile:
 
1572
        if self.tt.final_kind(trans_id) != "file":
1581
1573
            return
1582
1574
        if winner == "this":
1583
1575
            executability = this_executable
1594
1586
 
1595
1587
    def cook_conflicts(self, fs_conflicts):
1596
1588
        """Convert all conflicts into a form that doesn't depend on trans_id"""
1597
 
        self.cooked_conflicts.extend(transform.cook_conflicts(
1598
 
                fs_conflicts, self.tt))
 
1589
        content_conflict_file_ids = set()
 
1590
        cooked_conflicts = transform.cook_conflicts(fs_conflicts, self.tt)
1599
1591
        fp = transform.FinalPaths(self.tt)
1600
1592
        for conflict in self._raw_conflicts:
1601
1593
            conflict_type = conflict[0]
1612
1604
                if other_parent is None or other_name is None:
1613
1605
                    other_path = '<deleted>'
1614
1606
                else:
1615
 
                    parent_path =  fp.get_path(
1616
 
                        self.tt.trans_id_file_id(other_parent))
 
1607
                    if other_parent == self.other_tree.get_root_id():
 
1608
                        # The tree transform doesn't know about the other root,
 
1609
                        # so we special case here to avoid a NoFinalPath
 
1610
                        # exception
 
1611
                        parent_path = ''
 
1612
                    else:
 
1613
                        parent_path =  fp.get_path(
 
1614
                            self.tt.trans_id_file_id(other_parent))
1617
1615
                    other_path = osutils.pathjoin(parent_path, other_name)
1618
1616
                c = _mod_conflicts.Conflict.factory(
1619
1617
                    'path conflict', path=this_path,
1623
1621
                for trans_id in conflict[1]:
1624
1622
                    file_id = self.tt.final_file_id(trans_id)
1625
1623
                    if file_id is not None:
 
1624
                        # Ok we found the relevant file-id
1626
1625
                        break
1627
1626
                path = fp.get_path(trans_id)
1628
1627
                for suffix in ('.BASE', '.THIS', '.OTHER'):
1629
1628
                    if path.endswith(suffix):
 
1629
                        # Here is the raw path
1630
1630
                        path = path[:-len(suffix)]
1631
1631
                        break
1632
1632
                c = _mod_conflicts.Conflict.factory(conflict_type,
1633
1633
                                                    path=path, file_id=file_id)
 
1634
                content_conflict_file_ids.add(file_id)
1634
1635
            elif conflict_type == 'text conflict':
1635
1636
                trans_id = conflict[1]
1636
1637
                path = fp.get_path(trans_id)
1639
1640
                                                    path=path, file_id=file_id)
1640
1641
            else:
1641
1642
                raise AssertionError('bad conflict type: %r' % (conflict,))
 
1643
            cooked_conflicts.append(c)
 
1644
 
 
1645
        self.cooked_conflicts = []
 
1646
        # We want to get rid of path conflicts when a corresponding contents
 
1647
        # conflict exists. This can occur when one branch deletes a file while
 
1648
        # the other renames *and* modifies it. In this case, the content
 
1649
        # conflict is enough.
 
1650
        for c in cooked_conflicts:
 
1651
            if (c.typestring == 'path conflict'
 
1652
                and c.file_id in content_conflict_file_ids):
 
1653
                continue
1642
1654
            self.cooked_conflicts.append(c)
1643
1655
        self.cooked_conflicts.sort(key=_mod_conflicts.Conflict.sort_key)
1644
1656
 
1649
1661
    supports_show_base = False
1650
1662
    supports_reverse_cherrypick = False
1651
1663
    history_based = True
 
1664
    requires_file_merge_plan = True
1652
1665
 
1653
1666
    def _generate_merge_plan(self, file_id, base):
1654
1667
        return self.this_tree.plan_file_merge(file_id, self.other_tree,
1703
1716
 
1704
1717
class LCAMerger(WeaveMerger):
1705
1718
 
 
1719
    requires_file_merge_plan = True
 
1720
 
1706
1721
    def _generate_merge_plan(self, file_id, base):
1707
1722
        return self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
1708
1723
                                                  base=base)
1710
1725
class Diff3Merger(Merge3Merger):
1711
1726
    """Three-way merger using external diff3 for text merging"""
1712
1727
 
 
1728
    requires_file_merge_plan = False
 
1729
 
1713
1730
    def dump_file(self, temp_dir, name, tree, file_id):
1714
1731
        out_path = osutils.pathjoin(temp_dir, name)
1715
 
        out_file = open(out_path, "wb")
1716
 
        try:
1717
 
            in_file = tree.get_file(file_id)
 
1732
        with open(out_path, "wb") as out_file:
 
1733
            in_file = tree.get_file(tree.id2path(file_id), file_id)
1718
1734
            for line in in_file:
1719
1735
                out_file.write(line)
1720
 
        finally:
1721
 
            out_file.close()
1722
1736
        return out_path
1723
1737
 
1724
1738
    def text_merge(self, file_id, trans_id):
1726
1740
        If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
1727
1741
        will be dumped, and a will be conflict noted.
1728
1742
        """
1729
 
        import bzrlib.patch
 
1743
        import breezy.patch
1730
1744
        temp_dir = osutils.mkdtemp(prefix="bzr-")
1731
1745
        try:
1732
1746
            new_file = osutils.pathjoin(temp_dir, "new")
1733
1747
            this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
1734
1748
            base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
1735
1749
            other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
1736
 
            status = bzrlib.patch.diff3(new_file, this, base, other)
 
1750
            status = breezy.patch.diff3(new_file, this, base, other)
1737
1751
            if status not in (0, 1):
1738
1752
                raise errors.BzrError("Unhandled diff3 exit code")
1739
 
            f = open(new_file, 'rb')
1740
 
            try:
 
1753
            with open(new_file, 'rb') as f:
1741
1754
                self.tt.create_file(f, trans_id)
1742
 
            finally:
1743
 
                f.close()
1744
1755
            if status == 1:
1745
1756
                name = self.tt.final_name(trans_id)
1746
1757
                parent_id = self.tt.final_parent(trans_id)
1750
1761
            osutils.rmtree(temp_dir)
1751
1762
 
1752
1763
 
 
1764
class PathNotInTree(errors.BzrError):
 
1765
 
 
1766
    _fmt = """Merge-into failed because %(tree)s does not contain %(path)s."""
 
1767
 
 
1768
    def __init__(self, path, tree):
 
1769
        errors.BzrError.__init__(self, path=path, tree=tree)
 
1770
 
 
1771
 
 
1772
class MergeIntoMerger(Merger):
 
1773
    """Merger that understands other_tree will be merged into a subdir.
 
1774
 
 
1775
    This also changes the Merger api so that it uses real Branch, revision_id,
 
1776
    and RevisonTree objects, rather than using revision specs.
 
1777
    """
 
1778
 
 
1779
    def __init__(self, this_tree, other_branch, other_tree, target_subdir,
 
1780
            source_subpath, other_rev_id=None):
 
1781
        """Create a new MergeIntoMerger object.
 
1782
 
 
1783
        source_subpath in other_tree will be effectively copied to
 
1784
        target_subdir in this_tree.
 
1785
 
 
1786
        :param this_tree: The tree that we will be merging into.
 
1787
        :param other_branch: The Branch we will be merging from.
 
1788
        :param other_tree: The RevisionTree object we want to merge.
 
1789
        :param target_subdir: The relative path where we want to merge
 
1790
            other_tree into this_tree
 
1791
        :param source_subpath: The relative path specifying the subtree of
 
1792
            other_tree to merge into this_tree.
 
1793
        """
 
1794
        # It is assumed that we are merging a tree that is not in our current
 
1795
        # ancestry, which means we are using the "EmptyTree" as our basis.
 
1796
        null_ancestor_tree = this_tree.branch.repository.revision_tree(
 
1797
                                _mod_revision.NULL_REVISION)
 
1798
        super(MergeIntoMerger, self).__init__(
 
1799
            this_branch=this_tree.branch,
 
1800
            this_tree=this_tree,
 
1801
            other_tree=other_tree,
 
1802
            base_tree=null_ancestor_tree,
 
1803
            )
 
1804
        self._target_subdir = target_subdir
 
1805
        self._source_subpath = source_subpath
 
1806
        self.other_branch = other_branch
 
1807
        if other_rev_id is None:
 
1808
            other_rev_id = other_tree.get_revision_id()
 
1809
        self.other_rev_id = self.other_basis = other_rev_id
 
1810
        self.base_is_ancestor = True
 
1811
        self.backup_files = True
 
1812
        self.merge_type = Merge3Merger
 
1813
        self.show_base = False
 
1814
        self.reprocess = False
 
1815
        self.interesting_ids = None
 
1816
        self.merge_type = _MergeTypeParameterizer(MergeIntoMergeType,
 
1817
              target_subdir=self._target_subdir,
 
1818
              source_subpath=self._source_subpath)
 
1819
        if self._source_subpath != '':
 
1820
            # If this isn't a partial merge make sure the revisions will be
 
1821
            # present.
 
1822
            self._maybe_fetch(self.other_branch, self.this_branch,
 
1823
                self.other_basis)
 
1824
 
 
1825
    def set_pending(self):
 
1826
        if self._source_subpath != '':
 
1827
            return
 
1828
        Merger.set_pending(self)
 
1829
 
 
1830
 
 
1831
class _MergeTypeParameterizer(object):
 
1832
    """Wrap a merge-type class to provide extra parameters.
 
1833
 
 
1834
    This is hack used by MergeIntoMerger to pass some extra parameters to its
 
1835
    merge_type.  Merger.do_merge() sets up its own set of parameters to pass to
 
1836
    the 'merge_type' member.  It is difficult override do_merge without
 
1837
    re-writing the whole thing, so instead we create a wrapper which will pass
 
1838
    the extra parameters.
 
1839
    """
 
1840
 
 
1841
    def __init__(self, merge_type, **kwargs):
 
1842
        self._extra_kwargs = kwargs
 
1843
        self._merge_type = merge_type
 
1844
 
 
1845
    def __call__(self, *args, **kwargs):
 
1846
        kwargs.update(self._extra_kwargs)
 
1847
        return self._merge_type(*args, **kwargs)
 
1848
 
 
1849
    def __getattr__(self, name):
 
1850
        return getattr(self._merge_type, name)
 
1851
 
 
1852
 
 
1853
class MergeIntoMergeType(Merge3Merger):
 
1854
    """Merger that incorporates a tree (or part of a tree) into another."""
 
1855
 
 
1856
    def __init__(self, *args, **kwargs):
 
1857
        """Initialize the merger object.
 
1858
 
 
1859
        :param args: See Merge3Merger.__init__'s args.
 
1860
        :param kwargs: See Merge3Merger.__init__'s keyword args, except for
 
1861
            source_subpath and target_subdir.
 
1862
        :keyword source_subpath: The relative path specifying the subtree of
 
1863
            other_tree to merge into this_tree.
 
1864
        :keyword target_subdir: The relative path where we want to merge
 
1865
            other_tree into this_tree
 
1866
        """
 
1867
        # All of the interesting work happens during Merge3Merger.__init__(),
 
1868
        # so we have have to hack in to get our extra parameters set.
 
1869
        self._source_subpath = kwargs.pop('source_subpath')
 
1870
        self._target_subdir = kwargs.pop('target_subdir')
 
1871
        super(MergeIntoMergeType, self).__init__(*args, **kwargs)
 
1872
 
 
1873
    def _compute_transform(self):
 
1874
        with ui.ui_factory.nested_progress_bar() as child_pb:
 
1875
            entries = self._entries_to_incorporate()
 
1876
            entries = list(entries)
 
1877
            for num, (entry, parent_id, path) in enumerate(entries):
 
1878
                child_pb.update(gettext('Preparing file merge'), num, len(entries))
 
1879
                parent_trans_id = self.tt.trans_id_file_id(parent_id)
 
1880
                trans_id = transform.new_by_entry(path, self.tt, entry,
 
1881
                    parent_trans_id, self.other_tree)
 
1882
        self._finish_computing_transform()
 
1883
 
 
1884
    def _entries_to_incorporate(self):
 
1885
        """Yields pairs of (inventory_entry, new_parent)."""
 
1886
        other_inv = self.other_tree.root_inventory
 
1887
        subdir_id = other_inv.path2id(self._source_subpath)
 
1888
        if subdir_id is None:
 
1889
            # XXX: The error would be clearer if it gave the URL of the source
 
1890
            # branch, but we don't have a reference to that here.
 
1891
            raise PathNotInTree(self._source_subpath, "Source tree")
 
1892
        subdir = other_inv[subdir_id]
 
1893
        parent_in_target = osutils.dirname(self._target_subdir)
 
1894
        target_id = self.this_tree.path2id(parent_in_target)
 
1895
        if target_id is None:
 
1896
            raise PathNotInTree(self._target_subdir, "Target tree")
 
1897
        name_in_target = osutils.basename(self._target_subdir)
 
1898
        merge_into_root = subdir.copy()
 
1899
        merge_into_root.name = name_in_target
 
1900
        if self.this_tree.has_id(merge_into_root.file_id):
 
1901
            # Give the root a new file-id.
 
1902
            # This can happen fairly easily if the directory we are
 
1903
            # incorporating is the root, and both trees have 'TREE_ROOT' as
 
1904
            # their root_id.  Users will expect this to Just Work, so we
 
1905
            # change the file-id here.
 
1906
            # Non-root file-ids could potentially conflict too.  That's really
 
1907
            # an edge case, so we don't do anything special for those.  We let
 
1908
            # them cause conflicts.
 
1909
            merge_into_root.file_id = generate_ids.gen_file_id(name_in_target)
 
1910
        yield (merge_into_root, target_id, '')
 
1911
        if subdir.kind != 'directory':
 
1912
            # No children, so we are done.
 
1913
            return
 
1914
        for path, entry in other_inv.iter_entries_by_dir(subdir_id):
 
1915
            parent_id = entry.parent_id
 
1916
            if parent_id == subdir.file_id:
 
1917
                # The root's parent ID has changed, so make sure children of
 
1918
                # the root refer to the new ID.
 
1919
                parent_id = merge_into_root.file_id
 
1920
            yield (entry, parent_id, path)
 
1921
 
 
1922
 
1753
1923
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1754
1924
                backup_files=False,
1755
1925
                merge_type=Merge3Merger,
1759
1929
                other_rev_id=None,
1760
1930
                interesting_files=None,
1761
1931
                this_tree=None,
1762
 
                pb=None,
1763
1932
                change_reporter=None):
1764
1933
    """Primary interface for merging.
1765
1934
 
1766
 
        typical use is probably
1767
 
        'merge_inner(branch, branch.get_revision_tree(other_revision),
1768
 
                     branch.get_revision_tree(base_revision))'
1769
 
        """
 
1935
    Typical use is probably::
 
1936
 
 
1937
        merge_inner(branch, branch.get_revision_tree(other_revision),
 
1938
                    branch.get_revision_tree(base_revision))
 
1939
    """
1770
1940
    if this_tree is None:
1771
 
        raise errors.BzrError("bzrlib.merge.merge_inner requires a this_tree "
1772
 
                              "parameter as of bzrlib version 0.8.")
 
1941
        raise errors.BzrError("breezy.merge.merge_inner requires a this_tree "
 
1942
                              "parameter")
1773
1943
    merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1774
 
                    pb=pb, change_reporter=change_reporter)
 
1944
                    change_reporter=change_reporter)
1775
1945
    merger.backup_files = backup_files
1776
1946
    merger.merge_type = merge_type
1777
1947
    merger.interesting_ids = interesting_ids
1792
1962
    merger.set_base_revision(get_revision_id(), this_branch)
1793
1963
    return merger.do_merge()
1794
1964
 
 
1965
 
 
1966
merge_type_registry = registry.Registry()
 
1967
merge_type_registry.register('diff3', Diff3Merger,
 
1968
                             "Merge using external diff3.")
 
1969
merge_type_registry.register('lca', LCAMerger,
 
1970
                             "LCA-newness merge.")
 
1971
merge_type_registry.register('merge3', Merge3Merger,
 
1972
                             "Native diff3-style merge.")
 
1973
merge_type_registry.register('weave', WeaveMerger,
 
1974
                             "Weave-based merge.")
 
1975
 
 
1976
 
1795
1977
def get_merge_type_registry():
1796
 
    """Merge type registry is in bzrlib.option to avoid circular imports.
 
1978
    """Merge type registry was previously in breezy.option
1797
1979
 
1798
 
    This method provides a sanctioned way to retrieve it.
 
1980
    This method provides a backwards compatible way to retrieve it.
1799
1981
    """
1800
 
    from bzrlib import option
1801
 
    return option._merge_type_registry
 
1982
    return merge_type_registry
1802
1983
 
1803
1984
 
1804
1985
def _plan_annotate_merge(annotated_a, annotated_b, ancestors_a, ancestors_b):
2025
2206
        while True:
2026
2207
            next_lcas = self.graph.find_lca(*cur_ancestors)
2027
2208
            # Map a plain NULL_REVISION to a simple no-ancestors
2028
 
            if next_lcas == set([_mod_revision.NULL_REVISION]):
 
2209
            if next_lcas == {_mod_revision.NULL_REVISION}:
2029
2210
                next_lcas = ()
2030
2211
            # Order the lca's based on when they were merged into the tip
2031
2212
            # While the actual merge portion of weave merge uses a set() of
2119
2300
        filtered_parent_map = {}
2120
2301
        child_map = {}
2121
2302
        tails = []
2122
 
        for key, parent_keys in parent_map.iteritems():
 
2303
        for key, parent_keys in viewitems(parent_map):
2123
2304
            culled_parent_keys = [p for p in parent_keys if p in parent_map]
2124
2305
            if not culled_parent_keys:
2125
2306
                tails.append(key)
2175
2356
        return all_texts
2176
2357
 
2177
2358
    def _build_weave(self):
2178
 
        from bzrlib import weave
 
2359
        from .bzr import weave
2179
2360
        self._weave = weave.Weave(weave_name='in_memory_weave',
2180
2361
                                  allow_reserved=True)
2181
2362
        parent_map = self._find_recursive_lcas()
2229
2410
class _PlanLCAMerge(_PlanMergeBase):
2230
2411
    """
2231
2412
    This merge algorithm differs from _PlanMerge in that:
 
2413
 
2232
2414
    1. comparisons are done against LCAs only
2233
2415
    2. cases where a contested line is new versus one LCA but old versus
2234
2416
       another are marked as conflicts, by emitting the line as conflicted-a
2275
2457
 
2276
2458
        If a line is killed and new, this indicates that the two merge
2277
2459
        revisions contain differing conflict resolutions.
 
2460
 
2278
2461
        :param revision_id: The id of the revision in which the lines are
2279
2462
            unique
2280
2463
        :param unique_line_numbers: The line numbers of unique lines.
2281
 
        :return a tuple of (new_this, killed_other):
 
2464
        :return: a tuple of (new_this, killed_other)
2282
2465
        """
2283
2466
        new = set()
2284
2467
        killed = set()