~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

Add a NEWS entry and prepare submission.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2008 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
 
import warnings
18
17
 
19
 
from bzrlib.lazy_import import lazy_import
20
 
lazy_import(globals(), """
21
18
from bzrlib import (
22
19
    branch as _mod_branch,
23
 
    cleanup,
24
20
    conflicts as _mod_conflicts,
25
21
    debug,
26
 
    generate_ids,
 
22
    errors,
27
23
    graph as _mod_graph,
28
24
    merge3,
29
25
    osutils,
30
26
    patiencediff,
 
27
    progress,
 
28
    registry,
31
29
    revision as _mod_revision,
32
30
    textfile,
33
31
    trace,
35
33
    tree as _mod_tree,
36
34
    tsort,
37
35
    ui,
38
 
    versionedfile,
39
 
    workingtree,
40
 
    )
41
 
from bzrlib.i18n import gettext
42
 
""")
43
 
from bzrlib import (
44
 
    decorators,
45
 
    errors,
46
 
    hooks,
 
36
    versionedfile
47
37
    )
48
38
from bzrlib.symbol_versioning import (
49
39
    deprecated_in,
54
44
 
55
45
def transform_tree(from_tree, to_tree, interesting_ids=None):
56
46
    from_tree.lock_tree_write()
57
 
    operation = cleanup.OperationWithCleanups(merge_inner)
58
 
    operation.add_cleanup(from_tree.unlock)
59
 
    operation.run_simple(from_tree.branch, to_tree, from_tree,
60
 
        ignore_zero=True, interesting_ids=interesting_ids, this_tree=from_tree)
61
 
 
62
 
 
63
 
class MergeHooks(hooks.Hooks):
64
 
 
65
 
    def __init__(self):
66
 
        hooks.Hooks.__init__(self, "bzrlib.merge", "Merger.hooks")
67
 
        self.add_hook('merge_file_content',
68
 
            "Called with a bzrlib.merge.Merger object to create a per file "
69
 
            "merge object when starting a merge. "
70
 
            "Should return either None or a subclass of "
71
 
            "``bzrlib.merge.AbstractPerFileMerger``. "
72
 
            "Such objects will then be called per file "
73
 
            "that needs to be merged (including when one "
74
 
            "side has deleted the file and the other has changed it). "
75
 
            "See the AbstractPerFileMerger API docs for details on how it is "
76
 
            "used by merge.",
77
 
            (2, 1))
78
 
 
79
 
 
80
 
class AbstractPerFileMerger(object):
81
 
    """PerFileMerger objects are used by plugins extending merge for bzrlib.
82
 
 
83
 
    See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
84
 
    
85
 
    :ivar merger: The Merge3Merger performing the merge.
86
 
    """
87
 
 
88
 
    def __init__(self, merger):
89
 
        """Create a PerFileMerger for use with merger."""
90
 
        self.merger = merger
91
 
 
92
 
    def merge_contents(self, merge_params):
93
 
        """Attempt to merge the contents of a single file.
94
 
        
95
 
        :param merge_params: A bzrlib.merge.MergeHookParams
96
 
        :return: A tuple of (status, chunks), where status is one of
97
 
            'not_applicable', 'success', 'conflicted', or 'delete'.  If status
98
 
            is 'success' or 'conflicted', then chunks should be an iterable of
99
 
            strings for the new file contents.
100
 
        """
101
 
        return ('not applicable', None)
102
 
 
103
 
 
104
 
class PerFileMerger(AbstractPerFileMerger):
105
 
    """Merge individual files when self.file_matches returns True.
106
 
 
107
 
    This class is intended to be subclassed.  The file_matches and
108
 
    merge_matching methods should be overridden with concrete implementations.
109
 
    """
110
 
 
111
 
    def file_matches(self, params):
112
 
        """Return True if merge_matching should be called on this file.
113
 
 
114
 
        Only called with merges of plain files with no clear winner.
115
 
 
116
 
        Subclasses must override this.
117
 
        """
118
 
        raise NotImplementedError(self.file_matches)
119
 
 
120
 
    def get_filename(self, params, tree):
121
 
        """Lookup the filename (i.e. basename, not path), given a Tree (e.g.
122
 
        self.merger.this_tree) and a MergeHookParams.
123
 
        """
124
 
        return osutils.basename(tree.id2path(params.file_id))
125
 
 
126
 
    def get_filepath(self, params, tree):
127
 
        """Calculate the path to the file in a tree.
128
 
 
129
 
        :param params: A MergeHookParams describing the file to merge
130
 
        :param tree: a Tree, e.g. self.merger.this_tree.
131
 
        """
132
 
        return tree.id2path(params.file_id)
133
 
 
134
 
    def merge_contents(self, params):
135
 
        """Merge the contents of a single file."""
136
 
        # Check whether this custom merge logic should be used.
137
 
        if (
138
 
            # OTHER is a straight winner, rely on default merge.
139
 
            params.winner == 'other' or
140
 
            # THIS and OTHER aren't both files.
141
 
            not params.is_file_merge() or
142
 
            # The filename doesn't match *.xml
143
 
            not self.file_matches(params)):
144
 
            return 'not_applicable', None
145
 
        return self.merge_matching(params)
146
 
 
147
 
    def merge_matching(self, params):
148
 
        """Merge the contents of a single file that has matched the criteria
149
 
        in PerFileMerger.merge_contents (is a conflict, is a file,
150
 
        self.file_matches is True).
151
 
 
152
 
        Subclasses must override this.
153
 
        """
154
 
        raise NotImplementedError(self.merge_matching)
155
 
 
156
 
 
157
 
class ConfigurableFileMerger(PerFileMerger):
158
 
    """Merge individual files when configured via a .conf file.
159
 
 
160
 
    This is a base class for concrete custom file merging logic. Concrete
161
 
    classes should implement ``merge_text``.
162
 
 
163
 
    See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
164
 
    
165
 
    :ivar affected_files: The configured file paths to merge.
166
 
 
167
 
    :cvar name_prefix: The prefix to use when looking up configuration
168
 
        details. <name_prefix>_merge_files describes the files targeted by the
169
 
        hook for example.
170
 
        
171
 
    :cvar default_files: The default file paths to merge when no configuration
172
 
        is present.
173
 
    """
174
 
 
175
 
    name_prefix = None
176
 
    default_files = None
177
 
 
178
 
    def __init__(self, merger):
179
 
        super(ConfigurableFileMerger, self).__init__(merger)
180
 
        self.affected_files = None
181
 
        self.default_files = self.__class__.default_files or []
182
 
        self.name_prefix = self.__class__.name_prefix
183
 
        if self.name_prefix is None:
184
 
            raise ValueError("name_prefix must be set.")
185
 
 
186
 
    def file_matches(self, params):
187
 
        """Check whether the file should call the merge hook.
188
 
 
189
 
        <name_prefix>_merge_files configuration variable is a list of files
190
 
        that should use the hook.
191
 
        """
192
 
        affected_files = self.affected_files
193
 
        if affected_files is None:
194
 
            config = self.merger.this_branch.get_config()
195
 
            # Until bzr provides a better policy for caching the config, we
196
 
            # just add the part we're interested in to the params to avoid
197
 
            # reading the config files repeatedly (bazaar.conf, location.conf,
198
 
            # branch.conf).
199
 
            config_key = self.name_prefix + '_merge_files'
200
 
            affected_files = config.get_user_option_as_list(config_key)
201
 
            if affected_files is None:
202
 
                # If nothing was specified in the config, use the default.
203
 
                affected_files = self.default_files
204
 
            self.affected_files = affected_files
205
 
        if affected_files:
206
 
            filepath = self.get_filepath(params, self.merger.this_tree)
207
 
            if filepath in affected_files:
208
 
                return True
209
 
        return False
210
 
 
211
 
    def merge_matching(self, params):
212
 
        return self.merge_text(params)
213
 
 
214
 
    def merge_text(self, params):
215
 
        """Merge the byte contents of a single file.
216
 
 
217
 
        This is called after checking that the merge should be performed in
218
 
        merge_contents, and it should behave as per
219
 
        ``bzrlib.merge.AbstractPerFileMerger.merge_contents``.
220
 
        """
221
 
        raise NotImplementedError(self.merge_text)
222
 
 
223
 
 
224
 
class MergeHookParams(object):
225
 
    """Object holding parameters passed to merge_file_content hooks.
226
 
 
227
 
    There are some fields hooks can access:
228
 
 
229
 
    :ivar file_id: the file ID of the file being merged
230
 
    :ivar trans_id: the transform ID for the merge of this file
231
 
    :ivar this_kind: kind of file_id in 'this' tree
232
 
    :ivar other_kind: kind of file_id in 'other' tree
233
 
    :ivar winner: one of 'this', 'other', 'conflict'
234
 
    """
235
 
 
236
 
    def __init__(self, merger, file_id, trans_id, this_kind, other_kind,
237
 
            winner):
238
 
        self._merger = merger
239
 
        self.file_id = file_id
240
 
        self.trans_id = trans_id
241
 
        self.this_kind = this_kind
242
 
        self.other_kind = other_kind
243
 
        self.winner = winner
244
 
 
245
 
    def is_file_merge(self):
246
 
        """True if this_kind and other_kind are both 'file'."""
247
 
        return self.this_kind == 'file' and self.other_kind == 'file'
248
 
 
249
 
    @decorators.cachedproperty
250
 
    def base_lines(self):
251
 
        """The lines of the 'base' version of the file."""
252
 
        return self._merger.get_lines(self._merger.base_tree, self.file_id)
253
 
 
254
 
    @decorators.cachedproperty
255
 
    def this_lines(self):
256
 
        """The lines of the 'this' version of the file."""
257
 
        return self._merger.get_lines(self._merger.this_tree, self.file_id)
258
 
 
259
 
    @decorators.cachedproperty
260
 
    def other_lines(self):
261
 
        """The lines of the 'other' version of the file."""
262
 
        return self._merger.get_lines(self._merger.other_tree, self.file_id)
 
47
    try:
 
48
        merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
 
49
                    interesting_ids=interesting_ids, this_tree=from_tree)
 
50
    finally:
 
51
        from_tree.unlock()
263
52
 
264
53
 
265
54
class Merger(object):
266
 
 
267
 
    hooks = MergeHooks()
268
 
 
269
55
    def __init__(self, this_branch, other_tree=None, base_tree=None,
270
56
                 this_tree=None, pb=None, change_reporter=None,
271
57
                 recurse='down', revision_graph=None):
286
72
        self.interesting_files = None
287
73
        self.show_base = False
288
74
        self.reprocess = False
289
 
        if pb is not None:
290
 
            warnings.warn("pb parameter to Merger() is deprecated and ignored")
 
75
        if pb is None:
 
76
            pb = progress.DummyProgress()
 
77
        self._pb = pb
291
78
        self.pp = None
292
79
        self.recurse = recurse
293
80
        self.change_reporter = change_reporter
429
216
        return self._cached_trees[revision_id]
430
217
 
431
218
    def _get_tree(self, treespec, possible_transports=None):
 
219
        from bzrlib import workingtree
432
220
        location, revno = treespec
433
221
        if revno is None:
434
222
            tree = workingtree.WorkingTree.open_containing(location)[0]
452
240
        if self.other_rev_id is None:
453
241
            other_basis_tree = self.revision_tree(self.other_basis)
454
242
            if other_basis_tree.has_changes(self.other_tree):
455
 
                raise errors.WorkingTreeNotRevision(self.this_tree)
 
243
                raise WorkingTreeNotRevision(self.this_tree)
456
244
            other_rev_id = self.other_basis
457
245
            self.other_tree = other_basis_tree
458
246
 
459
247
    @deprecated_method(deprecated_in((2, 1, 0)))
460
248
    def file_revisions(self, file_id):
461
249
        self.ensure_revision_trees()
 
250
        def get_id(tree, file_id):
 
251
            revision_id = tree.inventory[file_id].revision
 
252
            return revision_id
462
253
        if self.this_rev_id is None:
463
254
            if self.this_basis_tree.get_file_sha1(file_id) != \
464
255
                self.this_tree.get_file_sha1(file_id):
465
256
                raise errors.WorkingTreeNotRevision(self.this_tree)
466
257
 
467
258
        trees = (self.this_basis_tree, self.other_tree)
468
 
        return [tree.get_file_revision(file_id) for tree in trees]
 
259
        return [get_id(tree, file_id) for tree in trees]
469
260
 
470
261
    @deprecated_method(deprecated_in((2, 1, 0)))
471
262
    def check_basis(self, check_clean, require_commits=True):
499
290
    def _add_parent(self):
500
291
        new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
501
292
        new_parent_trees = []
502
 
        operation = cleanup.OperationWithCleanups(
503
 
            self.this_tree.set_parent_trees)
504
293
        for revision_id in new_parents:
505
294
            try:
506
295
                tree = self.revision_tree(revision_id)
508
297
                tree = None
509
298
            else:
510
299
                tree.lock_read()
511
 
                operation.add_cleanup(tree.unlock)
512
300
            new_parent_trees.append((revision_id, tree))
513
 
        operation.run_simple(new_parent_trees, allow_leftmost_as_ghost=True)
 
301
        try:
 
302
            self.this_tree.set_parent_trees(new_parent_trees,
 
303
                                            allow_leftmost_as_ghost=True)
 
304
        finally:
 
305
            for _revision_id, tree in new_parent_trees:
 
306
                if tree is not None:
 
307
                    tree.unlock()
514
308
 
515
309
    def set_other(self, other_revision, possible_transports=None):
516
310
        """Set the revision and tree to merge from.
581
375
            elif len(lcas) == 1:
582
376
                self.base_rev_id = list(lcas)[0]
583
377
            else: # len(lcas) > 1
584
 
                self._is_criss_cross = True
585
378
                if len(lcas) > 2:
586
379
                    # find_unique_lca can only handle 2 nodes, so we have to
587
380
                    # start back at the beginning. It is a shame to traverse
592
385
                else:
593
386
                    self.base_rev_id = self.revision_graph.find_unique_lca(
594
387
                                            *lcas)
595
 
                sorted_lca_keys = self.revision_graph.find_merge_order(                
596
 
                    revisions[0], lcas)
597
 
                if self.base_rev_id == _mod_revision.NULL_REVISION:
598
 
                    self.base_rev_id = sorted_lca_keys[0]
599
 
                
 
388
                self._is_criss_cross = True
600
389
            if self.base_rev_id == _mod_revision.NULL_REVISION:
601
390
                raise errors.UnrelatedBranches()
602
391
            if self._is_criss_cross:
603
392
                trace.warning('Warning: criss-cross merge encountered.  See bzr'
604
393
                              ' help criss-cross.')
605
394
                trace.mutter('Criss-cross lcas: %r' % lcas)
606
 
                if self.base_rev_id in lcas:
607
 
                    trace.mutter('Unable to find unique lca. '
608
 
                                 'Fallback %r as best option.' % self.base_rev_id)
609
 
                interesting_revision_ids = set(lcas)
610
 
                interesting_revision_ids.add(self.base_rev_id)
 
395
                interesting_revision_ids = [self.base_rev_id]
 
396
                interesting_revision_ids.extend(lcas)
611
397
                interesting_trees = dict((t.get_revision_id(), t)
612
398
                    for t in self.this_branch.repository.revision_trees(
613
399
                        interesting_revision_ids))
614
400
                self._cached_trees.update(interesting_trees)
615
 
                if self.base_rev_id in lcas:
616
 
                    self.base_tree = interesting_trees[self.base_rev_id]
617
 
                else:
618
 
                    self.base_tree = interesting_trees.pop(self.base_rev_id)
 
401
                self.base_tree = interesting_trees.pop(self.base_rev_id)
 
402
                sorted_lca_keys = self.revision_graph.find_merge_order(
 
403
                    revisions[0], lcas)
619
404
                self._lca_trees = [interesting_trees[key]
620
405
                                   for key in sorted_lca_keys]
621
406
            else:
648
433
                  'other_tree': self.other_tree,
649
434
                  'interesting_ids': self.interesting_ids,
650
435
                  'interesting_files': self.interesting_files,
651
 
                  'this_branch': self.this_branch,
 
436
                  'pp': self.pp,
652
437
                  'do_merge': False}
653
438
        if self.merge_type.requires_base:
654
439
            kwargs['base_tree'] = self.base_tree
672
457
        if self._is_criss_cross and getattr(self.merge_type,
673
458
                                            'supports_lca_trees', False):
674
459
            kwargs['lca_trees'] = self._lca_trees
675
 
        return self.merge_type(pb=None,
 
460
        return self.merge_type(pb=self._pb,
676
461
                               change_reporter=self.change_reporter,
677
462
                               **kwargs)
678
463
 
679
 
    def _do_merge_to(self):
680
 
        merge = self.make_merger()
 
464
    def _do_merge_to(self, merge):
681
465
        if self.other_branch is not None:
682
466
            self.other_branch.update_references(self.this_branch)
683
467
        merge.do_merge()
697
481
                    sub_tree.branch.repository.revision_tree(base_revision)
698
482
                sub_merge.base_rev_id = base_revision
699
483
                sub_merge.do_merge()
700
 
        return merge
701
484
 
702
485
    def do_merge(self):
703
 
        operation = cleanup.OperationWithCleanups(self._do_merge_to)
704
486
        self.this_tree.lock_tree_write()
705
 
        operation.add_cleanup(self.this_tree.unlock)
706
 
        if self.base_tree is not None:
707
 
            self.base_tree.lock_read()
708
 
            operation.add_cleanup(self.base_tree.unlock)
709
 
        if self.other_tree is not None:
710
 
            self.other_tree.lock_read()
711
 
            operation.add_cleanup(self.other_tree.unlock)
712
 
        merge = operation.run_simple()
 
487
        try:
 
488
            if self.base_tree is not None:
 
489
                self.base_tree.lock_read()
 
490
            try:
 
491
                if self.other_tree is not None:
 
492
                    self.other_tree.lock_read()
 
493
                try:
 
494
                    merge = self.make_merger()
 
495
                    self._do_merge_to(merge)
 
496
                finally:
 
497
                    if self.other_tree is not None:
 
498
                        self.other_tree.unlock()
 
499
            finally:
 
500
                if self.base_tree is not None:
 
501
                    self.base_tree.unlock()
 
502
        finally:
 
503
            self.this_tree.unlock()
713
504
        if len(merge.cooked_conflicts) == 0:
714
505
            if not self.ignore_zero and not trace.is_quiet():
715
 
                trace.note(gettext("All changes applied successfully."))
 
506
                trace.note("All changes applied successfully.")
716
507
        else:
717
 
            trace.note(gettext("%d conflicts encountered.")
 
508
            trace.note("%d conflicts encountered."
718
509
                       % len(merge.cooked_conflicts))
719
510
 
720
511
        return len(merge.cooked_conflicts)
750
541
 
751
542
    def __init__(self, working_tree, this_tree, base_tree, other_tree,
752
543
                 interesting_ids=None, reprocess=False, show_base=False,
753
 
                 pb=None, pp=None, change_reporter=None,
 
544
                 pb=progress.DummyProgress(), pp=None, change_reporter=None,
754
545
                 interesting_files=None, do_merge=True,
755
 
                 cherrypick=False, lca_trees=None, this_branch=None):
 
546
                 cherrypick=False, lca_trees=None):
756
547
        """Initialize the merger object and perform the merge.
757
548
 
758
549
        :param working_tree: The working tree to apply the merge to
759
550
        :param this_tree: The local tree in the merge operation
760
551
        :param base_tree: The common tree in the merge operation
761
552
        :param other_tree: The other tree to merge changes from
762
 
        :param this_branch: The branch associated with this_tree.  Defaults to
763
 
            this_tree.branch if not supplied.
764
553
        :param interesting_ids: The file_ids of files that should be
765
554
            participate in the merge.  May not be combined with
766
555
            interesting_files.
767
556
        :param: reprocess If True, perform conflict-reduction processing.
768
557
        :param show_base: If True, show the base revision in text conflicts.
769
558
            (incompatible with reprocess)
770
 
        :param pb: ignored
 
559
        :param pb: A Progress bar
771
560
        :param pp: A ProgressPhase object
772
561
        :param change_reporter: An object that should report changes made
773
562
        :param interesting_files: The tree-relative paths of files that should
784
573
        if interesting_files is not None and interesting_ids is not None:
785
574
            raise ValueError(
786
575
                'specify either interesting_ids or interesting_files')
787
 
        if this_branch is None:
788
 
            this_branch = this_tree.branch
789
576
        self.interesting_ids = interesting_ids
790
577
        self.interesting_files = interesting_files
791
578
        self.this_tree = working_tree
792
579
        self.base_tree = base_tree
793
580
        self.other_tree = other_tree
794
 
        self.this_branch = this_branch
795
581
        self._raw_conflicts = []
796
582
        self.cooked_conflicts = []
797
583
        self.reprocess = reprocess
802
588
        # making sure we haven't missed any corner cases.
803
589
        # if lca_trees is None:
804
590
        #     self._lca_trees = [self.base_tree]
 
591
        self.pb = pb
 
592
        self.pp = pp
805
593
        self.change_reporter = change_reporter
806
594
        self.cherrypick = cherrypick
 
595
        if self.pp is None:
 
596
            self.pp = progress.ProgressPhase("Merge phase", 3, self.pb)
807
597
        if do_merge:
808
598
            self.do_merge()
809
 
        if pp is not None:
810
 
            warnings.warn("pp argument to Merge3Merger is deprecated")
811
 
        if pb is not None:
812
 
            warnings.warn("pb argument to Merge3Merger is deprecated")
813
599
 
814
600
    def do_merge(self):
815
 
        operation = cleanup.OperationWithCleanups(self._do_merge)
816
601
        self.this_tree.lock_tree_write()
817
 
        operation.add_cleanup(self.this_tree.unlock)
818
602
        self.base_tree.lock_read()
819
 
        operation.add_cleanup(self.base_tree.unlock)
820
603
        self.other_tree.lock_read()
821
 
        operation.add_cleanup(self.other_tree.unlock)
822
 
        operation.run()
823
 
 
824
 
    def _do_merge(self, operation):
825
 
        self.tt = transform.TreeTransform(self.this_tree, None)
826
 
        operation.add_cleanup(self.tt.finalize)
827
 
        self._compute_transform()
828
 
        results = self.tt.apply(no_conflicts=True)
829
 
        self.write_modified(results)
830
604
        try:
831
 
            self.this_tree.add_conflicts(self.cooked_conflicts)
832
 
        except errors.UnsupportedOperation:
833
 
            pass
 
605
            self.tt = transform.TreeTransform(self.this_tree, self.pb)
 
606
            try:
 
607
                self.pp.next_phase()
 
608
                self._compute_transform()
 
609
                self.pp.next_phase()
 
610
                results = self.tt.apply(no_conflicts=True)
 
611
                self.write_modified(results)
 
612
                try:
 
613
                    self.this_tree.add_conflicts(self.cooked_conflicts)
 
614
                except errors.UnsupportedOperation:
 
615
                    pass
 
616
            finally:
 
617
                self.tt.finalize()
 
618
        finally:
 
619
            self.other_tree.unlock()
 
620
            self.base_tree.unlock()
 
621
            self.this_tree.unlock()
 
622
            self.pb.clear()
834
623
 
835
624
    def make_preview_transform(self):
836
 
        operation = cleanup.OperationWithCleanups(self._make_preview_transform)
837
625
        self.base_tree.lock_read()
838
 
        operation.add_cleanup(self.base_tree.unlock)
839
626
        self.other_tree.lock_read()
840
 
        operation.add_cleanup(self.other_tree.unlock)
841
 
        return operation.run_simple()
842
 
 
843
 
    def _make_preview_transform(self):
844
627
        self.tt = transform.TransformPreview(self.this_tree)
845
 
        self._compute_transform()
 
628
        try:
 
629
            self.pp.next_phase()
 
630
            self._compute_transform()
 
631
            self.pp.next_phase()
 
632
        finally:
 
633
            self.other_tree.unlock()
 
634
            self.base_tree.unlock()
 
635
            self.pb.clear()
846
636
        return self.tt
847
637
 
848
638
    def _compute_transform(self):
854
644
            resolver = self._lca_multi_way
855
645
        child_pb = ui.ui_factory.nested_progress_bar()
856
646
        try:
857
 
            factories = Merger.hooks['merge_file_content']
858
 
            hooks = [factory(self) for factory in factories] + [self]
859
 
            self.active_hooks = [hook for hook in hooks if hook is not None]
860
647
            for num, (file_id, changed, parents3, names3,
861
648
                      executable3) in enumerate(entries):
862
 
                child_pb.update(gettext('Preparing file merge'), num, len(entries))
 
649
                child_pb.update('Preparing file merge', num, len(entries))
863
650
                self._merge_names(file_id, parents3, names3, resolver=resolver)
864
651
                if changed:
865
 
                    file_status = self._do_merge_contents(file_id)
 
652
                    file_status = self.merge_contents(file_id)
866
653
                else:
867
654
                    file_status = 'unmodified'
868
655
                self._merge_executable(file_id,
869
656
                    executable3, file_status, resolver=resolver)
870
657
        finally:
871
658
            child_pb.finished()
872
 
        self.tt.fixup_new_roots()
873
 
        self._finish_computing_transform()
874
 
 
875
 
    def _finish_computing_transform(self):
876
 
        """Finalize the transform and report the changes.
877
 
 
878
 
        This is the second half of _compute_transform.
879
 
        """
 
659
        self.fix_root()
 
660
        self.pp.next_phase()
880
661
        child_pb = ui.ui_factory.nested_progress_bar()
881
662
        try:
882
663
            fs_conflicts = transform.resolve_conflicts(self.tt, child_pb,
889
670
                self.tt.iter_changes(), self.change_reporter)
890
671
        self.cook_conflicts(fs_conflicts)
891
672
        for conflict in self.cooked_conflicts:
892
 
            trace.warning(unicode(conflict))
 
673
            trace.warning(conflict)
893
674
 
894
675
    def _entries3(self):
895
676
        """Gather data about files modified between three trees.
902
683
        """
903
684
        result = []
904
685
        iterator = self.other_tree.iter_changes(self.base_tree,
905
 
                specific_files=self.interesting_files,
 
686
                include_unchanged=True, specific_files=self.interesting_files,
906
687
                extra_trees=[self.this_tree])
907
688
        this_entries = dict((e.file_id, e) for p, e in
908
689
                            self.this_tree.iter_entries_by_dir(
934
715
        it then compares with THIS and BASE.
935
716
 
936
717
        For the multi-valued entries, the format will be (BASE, [lca1, lca2])
937
 
 
938
 
        :return: [(file_id, changed, parents, names, executable)], where:
939
 
 
940
 
            * file_id: Simple file_id of the entry
941
 
            * changed: Boolean, True if the kind or contents changed else False
942
 
            * parents: ((base, [parent_id, in, lcas]), parent_id_other,
943
 
                        parent_id_this)
944
 
            * names:   ((base, [name, in, lcas]), name_in_other, name_in_this)
945
 
            * executable: ((base, [exec, in, lcas]), exec_in_other,
946
 
                        exec_in_this)
 
718
        :return: [(file_id, changed, parents, names, executable)]
 
719
            file_id     Simple file_id of the entry
 
720
            changed     Boolean, True if the kind or contents changed
 
721
                        else False
 
722
            parents     ((base, [parent_id, in, lcas]), parent_id_other,
 
723
                         parent_id_this)
 
724
            names       ((base, [name, in, lcas]), name_in_other, name_in_this)
 
725
            executable  ((base, [exec, in, lcas]), exec_in_other, exec_in_this)
947
726
        """
948
727
        if self.interesting_files is not None:
949
728
            lookup_trees = [self.this_tree, self.base_tree]
991
770
                else:
992
771
                    lca_entries.append(lca_ie)
993
772
 
994
 
            if base_inventory.has_id(file_id):
 
773
            if file_id in base_inventory:
995
774
                base_ie = base_inventory[file_id]
996
775
            else:
997
776
                base_ie = _none_entry
998
777
 
999
 
            if this_inventory.has_id(file_id):
 
778
            if file_id in this_inventory:
1000
779
                this_ie = this_inventory[file_id]
1001
780
            else:
1002
781
                this_ie = _none_entry
1082
861
                        continue
1083
862
                else:
1084
863
                    raise AssertionError('unhandled kind: %s' % other_ie.kind)
 
864
                # XXX: We need to handle kind == 'symlink'
1085
865
 
1086
866
            # If we have gotten this far, that means something has changed
1087
867
            result.append((file_id, content_changed,
1094
874
                          ))
1095
875
        return result
1096
876
 
1097
 
    @deprecated_method(deprecated_in((2, 4, 0)))
 
877
 
1098
878
    def fix_root(self):
1099
 
        if self.tt.final_kind(self.tt.root) is None:
 
879
        try:
 
880
            self.tt.final_kind(self.tt.root)
 
881
        except errors.NoSuchFile:
1100
882
            self.tt.cancel_deletion(self.tt.root)
1101
883
        if self.tt.final_file_id(self.tt.root) is None:
1102
884
            self.tt.version_file(self.tt.tree_file_id(self.tt.root),
1107
889
        other_root = self.tt.trans_id_file_id(other_root_file_id)
1108
890
        if other_root == self.tt.root:
1109
891
            return
1110
 
        if self.this_tree.inventory.has_id(
1111
 
            self.other_tree.inventory.root.file_id):
1112
 
            # the other tree's root is a non-root in the current tree (as
1113
 
            # when a previously unrelated branch is merged into another)
1114
 
            return
1115
 
        if self.tt.final_kind(other_root) is not None:
1116
 
            other_root_is_present = True
1117
 
        else:
1118
 
            # other_root doesn't have a physical representation. We still need
1119
 
            # to move any references to the actual root of the tree.
1120
 
            other_root_is_present = False
1121
 
        # 'other_tree.inventory.root' is not present in this tree. We are
1122
 
        # calling adjust_path for children which *want* to be present with a
1123
 
        # correct place to go.
1124
 
        for _, child in self.other_tree.inventory.root.children.iteritems():
 
892
        try:
 
893
            self.tt.final_kind(other_root)
 
894
        except errors.NoSuchFile:
 
895
            return
 
896
        if self.other_tree.inventory.root.file_id in self.this_tree.inventory:
 
897
            # the other tree's root is a non-root in the current tree
 
898
            return
 
899
        self.reparent_children(self.other_tree.inventory.root, self.tt.root)
 
900
        self.tt.cancel_creation(other_root)
 
901
        self.tt.cancel_versioning(other_root)
 
902
 
 
903
    def reparent_children(self, ie, target):
 
904
        for thing, child in ie.children.iteritems():
1125
905
            trans_id = self.tt.trans_id_file_id(child.file_id)
1126
 
            if not other_root_is_present:
1127
 
                if self.tt.final_kind(trans_id) is not None:
1128
 
                    # The item exist in the final tree and has a defined place
1129
 
                    # to go already.
1130
 
                    continue
1131
 
            # Move the item into the root
1132
 
            try:
1133
 
                final_name = self.tt.final_name(trans_id)
1134
 
            except errors.NoFinalPath:
1135
 
                # This file is not present anymore, ignore it.
1136
 
                continue
1137
 
            self.tt.adjust_path(final_name, self.tt.root, trans_id)
1138
 
        if other_root_is_present:
1139
 
            self.tt.cancel_creation(other_root)
1140
 
            self.tt.cancel_versioning(other_root)
 
906
            self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
1141
907
 
1142
908
    def write_modified(self, results):
1143
909
        modified_hashes = {}
1168
934
    @staticmethod
1169
935
    def contents_sha1(tree, file_id):
1170
936
        """Determine the sha1 of the file contents (used as a key method)."""
1171
 
        if not tree.has_id(file_id):
 
937
        if file_id not in tree:
1172
938
            return None
1173
939
        return tree.get_file_sha1(file_id)
1174
940
 
1175
941
    @staticmethod
1176
942
    def executable(tree, file_id):
1177
943
        """Determine the executability of a file-id (used as a key method)."""
1178
 
        if not tree.has_id(file_id):
 
944
        if file_id not in tree:
1179
945
            return None
1180
946
        if tree.kind(file_id) != "file":
1181
947
            return False
1184
950
    @staticmethod
1185
951
    def kind(tree, file_id):
1186
952
        """Determine the kind of a file-id (used as a key method)."""
1187
 
        if not tree.has_id(file_id):
 
953
        if file_id not in tree:
1188
954
            return None
1189
955
        return tree.kind(file_id)
1190
956
 
1191
957
    @staticmethod
1192
958
    def _three_way(base, other, this):
 
959
        #if base == other, either they all agree, or only THIS has changed.
1193
960
        if base == other:
1194
 
            # if 'base == other', either they all agree, or only 'this' has
1195
 
            # changed.
1196
961
            return 'this'
1197
962
        elif this not in (base, other):
1198
 
            # 'this' is neither 'base' nor 'other', so both sides changed
1199
963
            return 'conflict'
 
964
        # "Ambiguous clean merge" -- both sides have made the same change.
1200
965
        elif this == other:
1201
 
            # "Ambiguous clean merge" -- both sides have made the same change.
1202
966
            return "this"
 
967
        # this == base: only other has changed.
1203
968
        else:
1204
 
            # this == base: only other has changed.
1205
969
            return "other"
1206
970
 
1207
971
    @staticmethod
1251
1015
                # only has an lca value
1252
1016
                return 'other'
1253
1017
 
1254
 
        # At this point, the lcas disagree, and the tip disagree
 
1018
        # At this point, the lcas disagree, and the tips disagree
1255
1019
        return 'conflict'
1256
1020
 
1257
1021
    @staticmethod
1258
 
    @deprecated_method(deprecated_in((2, 2, 0)))
1259
1022
    def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
1260
1023
        """Do a three-way test on a scalar.
1261
1024
        Return "this", "other" or "conflict", depending whether a value wins.
1276
1039
 
1277
1040
    def merge_names(self, file_id):
1278
1041
        def get_entry(tree):
1279
 
            if tree.has_id(file_id):
 
1042
            if file_id in tree.inventory:
1280
1043
                return tree.inventory[file_id]
1281
1044
            else:
1282
1045
                return None
1311
1074
                parent_id_winner = "other"
1312
1075
        if name_winner == "this" and parent_id_winner == "this":
1313
1076
            return
1314
 
        if name_winner == 'conflict' or parent_id_winner == 'conflict':
1315
 
            # Creating helpers (.OTHER or .THIS) here cause problems down the
1316
 
            # road if a ContentConflict needs to be created so we should not do
1317
 
            # that
1318
 
            trans_id = self.tt.trans_id_file_id(file_id)
1319
 
            self._raw_conflicts.append(('path conflict', trans_id, file_id,
1320
 
                                        this_parent, this_name,
1321
 
                                        other_parent, other_name))
1322
 
        if not self.other_tree.has_id(file_id):
 
1077
        if name_winner == "conflict":
 
1078
            trans_id = self.tt.trans_id_file_id(file_id)
 
1079
            self._raw_conflicts.append(('name conflict', trans_id,
 
1080
                                        this_name, other_name))
 
1081
        if parent_id_winner == "conflict":
 
1082
            trans_id = self.tt.trans_id_file_id(file_id)
 
1083
            self._raw_conflicts.append(('parent conflict', trans_id,
 
1084
                                        this_parent, other_parent))
 
1085
        if other_name is None:
1323
1086
            # it doesn't matter whether the result was 'other' or
1324
 
            # 'conflict'-- if it has no file id, we leave it alone.
 
1087
            # 'conflict'-- if there's no 'other', we leave it alone.
1325
1088
            return
 
1089
        # if we get here, name_winner and parent_winner are set to safe values.
 
1090
        trans_id = self.tt.trans_id_file_id(file_id)
1326
1091
        parent_id = parents[self.winner_idx[parent_id_winner]]
1327
 
        name = names[self.winner_idx[name_winner]]
1328
 
        if parent_id is not None or name is not None:
1329
 
            # if we get here, name_winner and parent_winner are set to safe
1330
 
            # values.
1331
 
            if parent_id is None and name is not None:
1332
 
                # if parent_id is None and name is non-None, current file is
1333
 
                # the tree root.
1334
 
                if names[self.winner_idx[parent_id_winner]] != '':
1335
 
                    raise AssertionError(
1336
 
                        'File looks like a root, but named %s' %
1337
 
                        names[self.winner_idx[parent_id_winner]])
1338
 
                parent_trans_id = transform.ROOT_PARENT
1339
 
            else:
1340
 
                parent_trans_id = self.tt.trans_id_file_id(parent_id)
1341
 
            self.tt.adjust_path(name, parent_trans_id,
1342
 
                                self.tt.trans_id_file_id(file_id))
 
1092
        if parent_id is not None:
 
1093
            parent_trans_id = self.tt.trans_id_file_id(parent_id)
 
1094
            self.tt.adjust_path(names[self.winner_idx[name_winner]],
 
1095
                                parent_trans_id, trans_id)
1343
1096
 
1344
 
    def _do_merge_contents(self, file_id):
 
1097
    def merge_contents(self, file_id):
1345
1098
        """Performs a merge on file_id contents."""
1346
1099
        def contents_pair(tree):
1347
 
            if not tree.has_id(file_id):
 
1100
            if file_id not in tree:
1348
1101
                return (None, None)
1349
1102
            kind = tree.kind(file_id)
1350
1103
            if kind == "file":
1355
1108
                contents = None
1356
1109
            return kind, contents
1357
1110
 
 
1111
        def contents_conflict():
 
1112
            trans_id = self.tt.trans_id_file_id(file_id)
 
1113
            name = self.tt.final_name(trans_id)
 
1114
            parent_id = self.tt.final_parent(trans_id)
 
1115
            if file_id in self.this_tree.inventory:
 
1116
                self.tt.unversion_file(trans_id)
 
1117
                if file_id in self.this_tree:
 
1118
                    self.tt.delete_contents(trans_id)
 
1119
            file_group = self._dump_conflicts(name, parent_id, file_id,
 
1120
                                              set_version=True)
 
1121
            self._raw_conflicts.append(('contents conflict', file_group))
 
1122
 
1358
1123
        # See SPOT run.  run, SPOT, run.
1359
1124
        # So we're not QUITE repeating ourselves; we do tricky things with
1360
1125
        # file kind...
1376
1141
        if winner == 'this':
1377
1142
            # No interesting changes introduced by OTHER
1378
1143
            return "unmodified"
1379
 
        # We have a hypothetical conflict, but if we have files, then we
1380
 
        # can try to merge the content
1381
1144
        trans_id = self.tt.trans_id_file_id(file_id)
1382
 
        params = MergeHookParams(self, file_id, trans_id, this_pair[0],
1383
 
            other_pair[0], winner)
1384
 
        hooks = self.active_hooks
1385
 
        hook_status = 'not_applicable'
1386
 
        for hook in hooks:
1387
 
            hook_status, lines = hook.merge_contents(params)
1388
 
            if hook_status != 'not_applicable':
1389
 
                # Don't try any more hooks, this one applies.
1390
 
                break
1391
 
        result = "modified"
1392
 
        if hook_status == 'not_applicable':
1393
 
            # This is a contents conflict, because none of the available
1394
 
            # functions could merge it.
1395
 
            result = None
1396
 
            name = self.tt.final_name(trans_id)
1397
 
            parent_id = self.tt.final_parent(trans_id)
1398
 
            if self.this_tree.has_id(file_id):
1399
 
                self.tt.unversion_file(trans_id)
1400
 
            file_group = self._dump_conflicts(name, parent_id, file_id,
1401
 
                                              set_version=True)
1402
 
            self._raw_conflicts.append(('contents conflict', file_group))
1403
 
        elif hook_status == 'success':
1404
 
            self.tt.create_file(lines, trans_id)
1405
 
        elif hook_status == 'conflicted':
1406
 
            # XXX: perhaps the hook should be able to provide
1407
 
            # the BASE/THIS/OTHER files?
1408
 
            self.tt.create_file(lines, trans_id)
1409
 
            self._raw_conflicts.append(('text conflict', trans_id))
1410
 
            name = self.tt.final_name(trans_id)
1411
 
            parent_id = self.tt.final_parent(trans_id)
1412
 
            self._dump_conflicts(name, parent_id, file_id)
1413
 
        elif hook_status == 'delete':
1414
 
            self.tt.unversion_file(trans_id)
1415
 
            result = "deleted"
1416
 
        elif hook_status == 'done':
1417
 
            # The hook function did whatever it needs to do directly, no
1418
 
            # further action needed here.
1419
 
            pass
1420
 
        else:
1421
 
            raise AssertionError('unknown hook_status: %r' % (hook_status,))
1422
 
        if not self.this_tree.has_id(file_id) and result == "modified":
1423
 
            self.tt.version_file(file_id, trans_id)
1424
 
        # The merge has been performed, so the old contents should not be
1425
 
        # retained.
1426
 
        self.tt.delete_contents(trans_id)
1427
 
        return result
1428
 
 
1429
 
    def _default_other_winner_merge(self, merge_hook_params):
1430
 
        """Replace this contents with other."""
1431
 
        file_id = merge_hook_params.file_id
1432
 
        trans_id = merge_hook_params.trans_id
1433
 
        file_in_this = self.this_tree.has_id(file_id)
1434
 
        if self.other_tree.has_id(file_id):
1435
 
            # OTHER changed the file
1436
 
            wt = self.this_tree
1437
 
            if wt.supports_content_filtering():
1438
 
                # We get the path from the working tree if it exists.
1439
 
                # That fails though when OTHER is adding a file, so
1440
 
                # we fall back to the other tree to find the path if
1441
 
                # it doesn't exist locally.
1442
 
                try:
1443
 
                    filter_tree_path = wt.id2path(file_id)
1444
 
                except errors.NoSuchId:
1445
 
                    filter_tree_path = self.other_tree.id2path(file_id)
1446
 
            else:
1447
 
                # Skip the id2path lookup for older formats
1448
 
                filter_tree_path = None
1449
 
            transform.create_from_tree(self.tt, trans_id,
1450
 
                             self.other_tree, file_id,
1451
 
                             filter_tree_path=filter_tree_path)
1452
 
            return 'done', None
1453
 
        elif file_in_this:
1454
 
            # OTHER deleted the file
1455
 
            return 'delete', None
1456
 
        else:
1457
 
            raise AssertionError(
1458
 
                'winner is OTHER, but file_id %r not in THIS or OTHER tree'
1459
 
                % (file_id,))
1460
 
 
1461
 
    def merge_contents(self, merge_hook_params):
1462
 
        """Fallback merge logic after user installed hooks."""
1463
 
        # This function is used in merge hooks as the fallback instance.
1464
 
        # Perhaps making this function and the functions it calls be a 
1465
 
        # a separate class would be better.
1466
 
        if merge_hook_params.winner == 'other':
 
1145
        if winner == 'other':
1467
1146
            # OTHER is a straight winner, so replace this contents with other
1468
 
            return self._default_other_winner_merge(merge_hook_params)
1469
 
        elif merge_hook_params.is_file_merge():
1470
 
            # THIS and OTHER are both files, so text merge.  Either
1471
 
            # BASE is a file, or both converted to files, so at least we
1472
 
            # have agreement that output should be a file.
1473
 
            try:
1474
 
                self.text_merge(merge_hook_params.file_id,
1475
 
                    merge_hook_params.trans_id)
1476
 
            except errors.BinaryFile:
1477
 
                return 'not_applicable', None
1478
 
            return 'done', None
 
1147
            file_in_this = file_id in self.this_tree
 
1148
            if file_in_this:
 
1149
                # Remove any existing contents
 
1150
                self.tt.delete_contents(trans_id)
 
1151
            if file_id in self.other_tree:
 
1152
                # OTHER changed the file
 
1153
                wt = self.this_tree
 
1154
                if wt.supports_content_filtering():
 
1155
                    # We get the path from the working tree if it exists.
 
1156
                    # That fails though when OTHER is adding a file, so
 
1157
                    # we fall back to the other tree to find the path if
 
1158
                    # it doesn't exist locally.
 
1159
                    try:
 
1160
                        filter_tree_path = wt.id2path(file_id)
 
1161
                    except errors.NoSuchId:
 
1162
                        filter_tree_path = self.other_tree.id2path(file_id)
 
1163
                else:
 
1164
                    # Skip the id2path lookup for older formats
 
1165
                    filter_tree_path = None
 
1166
                transform.create_from_tree(self.tt, trans_id,
 
1167
                                 self.other_tree, file_id,
 
1168
                                 filter_tree_path=filter_tree_path)
 
1169
                if not file_in_this:
 
1170
                    self.tt.version_file(file_id, trans_id)
 
1171
                return "modified"
 
1172
            elif file_in_this:
 
1173
                # OTHER deleted the file
 
1174
                self.tt.unversion_file(trans_id)
 
1175
                return "deleted"
1479
1176
        else:
1480
 
            return 'not_applicable', None
 
1177
            # We have a hypothetical conflict, but if we have files, then we
 
1178
            # can try to merge the content
 
1179
            if this_pair[0] == 'file' and other_pair[0] == 'file':
 
1180
                # THIS and OTHER are both files, so text merge.  Either
 
1181
                # BASE is a file, or both converted to files, so at least we
 
1182
                # have agreement that output should be a file.
 
1183
                try:
 
1184
                    self.text_merge(file_id, trans_id)
 
1185
                except errors.BinaryFile:
 
1186
                    return contents_conflict()
 
1187
                if file_id not in self.this_tree:
 
1188
                    self.tt.version_file(file_id, trans_id)
 
1189
                try:
 
1190
                    self.tt.tree_kind(trans_id)
 
1191
                    self.tt.delete_contents(trans_id)
 
1192
                except errors.NoSuchFile:
 
1193
                    pass
 
1194
                return "modified"
 
1195
            else:
 
1196
                return contents_conflict()
1481
1197
 
1482
1198
    def get_lines(self, tree, file_id):
1483
1199
        """Return the lines in a file, or an empty list."""
1484
 
        if tree.has_id(file_id):
1485
 
            return tree.get_file_lines(file_id)
 
1200
        if file_id in tree:
 
1201
            return tree.get_file(file_id).readlines()
1486
1202
        else:
1487
1203
            return []
1488
1204
 
1490
1206
        """Perform a three-way text merge on a file_id"""
1491
1207
        # it's possible that we got here with base as a different type.
1492
1208
        # if so, we just want two-way text conflicts.
1493
 
        if self.base_tree.has_id(file_id) and \
 
1209
        if file_id in self.base_tree and \
1494
1210
            self.base_tree.kind(file_id) == "file":
1495
1211
            base_lines = self.get_lines(self.base_tree, file_id)
1496
1212
        else:
1559
1275
        versioned = False
1560
1276
        file_group = []
1561
1277
        for suffix, tree, lines in data:
1562
 
            if tree.has_id(file_id):
 
1278
            if file_id in tree:
1563
1279
                trans_id = self._conflict_file(name, parent_id, tree, file_id,
1564
1280
                                               suffix, lines, filter_tree_path)
1565
1281
                file_group.append(trans_id)
1601
1317
        if winner == 'this' and file_status != "modified":
1602
1318
            return
1603
1319
        trans_id = self.tt.trans_id_file_id(file_id)
1604
 
        if self.tt.final_kind(trans_id) != "file":
 
1320
        try:
 
1321
            if self.tt.final_kind(trans_id) != "file":
 
1322
                return
 
1323
        except errors.NoSuchFile:
1605
1324
            return
1606
1325
        if winner == "this":
1607
1326
            executability = this_executable
1608
1327
        else:
1609
 
            if self.other_tree.has_id(file_id):
 
1328
            if file_id in self.other_tree:
1610
1329
                executability = other_executable
1611
 
            elif self.this_tree.has_id(file_id):
 
1330
            elif file_id in self.this_tree:
1612
1331
                executability = this_executable
1613
 
            elif self.base_tree_has_id(file_id):
 
1332
            elif file_id in self.base_tree:
1614
1333
                executability = base_executable
1615
1334
        if executability is not None:
1616
1335
            trans_id = self.tt.trans_id_file_id(file_id)
1618
1337
 
1619
1338
    def cook_conflicts(self, fs_conflicts):
1620
1339
        """Convert all conflicts into a form that doesn't depend on trans_id"""
1621
 
        content_conflict_file_ids = set()
1622
 
        cooked_conflicts = transform.cook_conflicts(fs_conflicts, self.tt)
 
1340
        name_conflicts = {}
 
1341
        self.cooked_conflicts.extend(transform.cook_conflicts(
 
1342
                fs_conflicts, self.tt))
1623
1343
        fp = transform.FinalPaths(self.tt)
1624
1344
        for conflict in self._raw_conflicts:
1625
1345
            conflict_type = conflict[0]
1626
 
            if conflict_type == 'path conflict':
1627
 
                (trans_id, file_id,
1628
 
                this_parent, this_name,
1629
 
                other_parent, other_name) = conflict[1:]
1630
 
                if this_parent is None or this_name is None:
1631
 
                    this_path = '<deleted>'
1632
 
                else:
1633
 
                    parent_path =  fp.get_path(
1634
 
                        self.tt.trans_id_file_id(this_parent))
1635
 
                    this_path = osutils.pathjoin(parent_path, this_name)
1636
 
                if other_parent is None or other_name is None:
1637
 
                    other_path = '<deleted>'
1638
 
                else:
1639
 
                    if other_parent == self.other_tree.get_root_id():
1640
 
                        # The tree transform doesn't know about the other root,
1641
 
                        # so we special case here to avoid a NoFinalPath
1642
 
                        # exception
1643
 
                        parent_path = ''
1644
 
                    else:
1645
 
                        parent_path =  fp.get_path(
1646
 
                            self.tt.trans_id_file_id(other_parent))
1647
 
                    other_path = osutils.pathjoin(parent_path, other_name)
1648
 
                c = _mod_conflicts.Conflict.factory(
1649
 
                    'path conflict', path=this_path,
1650
 
                    conflict_path=other_path,
1651
 
                    file_id=file_id)
1652
 
            elif conflict_type == 'contents conflict':
 
1346
            if conflict_type in ('name conflict', 'parent conflict'):
 
1347
                trans_id = conflict[1]
 
1348
                conflict_args = conflict[2:]
 
1349
                if trans_id not in name_conflicts:
 
1350
                    name_conflicts[trans_id] = {}
 
1351
                transform.unique_add(name_conflicts[trans_id], conflict_type,
 
1352
                                     conflict_args)
 
1353
            if conflict_type == 'contents conflict':
1653
1354
                for trans_id in conflict[1]:
1654
1355
                    file_id = self.tt.final_file_id(trans_id)
1655
1356
                    if file_id is not None:
1661
1362
                        break
1662
1363
                c = _mod_conflicts.Conflict.factory(conflict_type,
1663
1364
                                                    path=path, file_id=file_id)
1664
 
                content_conflict_file_ids.add(file_id)
1665
 
            elif conflict_type == 'text conflict':
 
1365
                self.cooked_conflicts.append(c)
 
1366
            if conflict_type == 'text conflict':
1666
1367
                trans_id = conflict[1]
1667
1368
                path = fp.get_path(trans_id)
1668
1369
                file_id = self.tt.final_file_id(trans_id)
1669
1370
                c = _mod_conflicts.Conflict.factory(conflict_type,
1670
1371
                                                    path=path, file_id=file_id)
 
1372
                self.cooked_conflicts.append(c)
 
1373
 
 
1374
        for trans_id, conflicts in name_conflicts.iteritems():
 
1375
            try:
 
1376
                this_parent, other_parent = conflicts['parent conflict']
 
1377
                if this_parent == other_parent:
 
1378
                    raise AssertionError()
 
1379
            except KeyError:
 
1380
                this_parent = other_parent = \
 
1381
                    self.tt.final_file_id(self.tt.final_parent(trans_id))
 
1382
            try:
 
1383
                this_name, other_name = conflicts['name conflict']
 
1384
                if this_name == other_name:
 
1385
                    raise AssertionError()
 
1386
            except KeyError:
 
1387
                this_name = other_name = self.tt.final_name(trans_id)
 
1388
            other_path = fp.get_path(trans_id)
 
1389
            if this_parent is not None and this_name is not None:
 
1390
                this_parent_path = \
 
1391
                    fp.get_path(self.tt.trans_id_file_id(this_parent))
 
1392
                this_path = osutils.pathjoin(this_parent_path, this_name)
1671
1393
            else:
1672
 
                raise AssertionError('bad conflict type: %r' % (conflict,))
1673
 
            cooked_conflicts.append(c)
1674
 
 
1675
 
        self.cooked_conflicts = []
1676
 
        # We want to get rid of path conflicts when a corresponding contents
1677
 
        # conflict exists. This can occur when one branch deletes a file while
1678
 
        # the other renames *and* modifies it. In this case, the content
1679
 
        # conflict is enough.
1680
 
        for c in cooked_conflicts:
1681
 
            if (c.typestring == 'path conflict'
1682
 
                and c.file_id in content_conflict_file_ids):
1683
 
                continue
 
1394
                this_path = "<deleted>"
 
1395
            file_id = self.tt.final_file_id(trans_id)
 
1396
            c = _mod_conflicts.Conflict.factory('path conflict', path=this_path,
 
1397
                                                conflict_path=other_path,
 
1398
                                                file_id=file_id)
1684
1399
            self.cooked_conflicts.append(c)
1685
1400
        self.cooked_conflicts.sort(key=_mod_conflicts.Conflict.sort_key)
1686
1401
 
1792
1507
            osutils.rmtree(temp_dir)
1793
1508
 
1794
1509
 
1795
 
class PathNotInTree(errors.BzrError):
1796
 
 
1797
 
    _fmt = """Merge-into failed because %(tree)s does not contain %(path)s."""
1798
 
 
1799
 
    def __init__(self, path, tree):
1800
 
        errors.BzrError.__init__(self, path=path, tree=tree)
1801
 
 
1802
 
 
1803
 
class MergeIntoMerger(Merger):
1804
 
    """Merger that understands other_tree will be merged into a subdir.
1805
 
 
1806
 
    This also changes the Merger api so that it uses real Branch, revision_id,
1807
 
    and RevisonTree objects, rather than using revision specs.
1808
 
    """
1809
 
 
1810
 
    def __init__(self, this_tree, other_branch, other_tree, target_subdir,
1811
 
            source_subpath, other_rev_id=None):
1812
 
        """Create a new MergeIntoMerger object.
1813
 
 
1814
 
        source_subpath in other_tree will be effectively copied to
1815
 
        target_subdir in this_tree.
1816
 
 
1817
 
        :param this_tree: The tree that we will be merging into.
1818
 
        :param other_branch: The Branch we will be merging from.
1819
 
        :param other_tree: The RevisionTree object we want to merge.
1820
 
        :param target_subdir: The relative path where we want to merge
1821
 
            other_tree into this_tree
1822
 
        :param source_subpath: The relative path specifying the subtree of
1823
 
            other_tree to merge into this_tree.
1824
 
        """
1825
 
        # It is assumed that we are merging a tree that is not in our current
1826
 
        # ancestry, which means we are using the "EmptyTree" as our basis.
1827
 
        null_ancestor_tree = this_tree.branch.repository.revision_tree(
1828
 
                                _mod_revision.NULL_REVISION)
1829
 
        super(MergeIntoMerger, self).__init__(
1830
 
            this_branch=this_tree.branch,
1831
 
            this_tree=this_tree,
1832
 
            other_tree=other_tree,
1833
 
            base_tree=null_ancestor_tree,
1834
 
            )
1835
 
        self._target_subdir = target_subdir
1836
 
        self._source_subpath = source_subpath
1837
 
        self.other_branch = other_branch
1838
 
        if other_rev_id is None:
1839
 
            other_rev_id = other_tree.get_revision_id()
1840
 
        self.other_rev_id = self.other_basis = other_rev_id
1841
 
        self.base_is_ancestor = True
1842
 
        self.backup_files = True
1843
 
        self.merge_type = Merge3Merger
1844
 
        self.show_base = False
1845
 
        self.reprocess = False
1846
 
        self.interesting_ids = None
1847
 
        self.merge_type = _MergeTypeParameterizer(MergeIntoMergeType,
1848
 
              target_subdir=self._target_subdir,
1849
 
              source_subpath=self._source_subpath)
1850
 
        if self._source_subpath != '':
1851
 
            # If this isn't a partial merge make sure the revisions will be
1852
 
            # present.
1853
 
            self._maybe_fetch(self.other_branch, self.this_branch,
1854
 
                self.other_basis)
1855
 
 
1856
 
    def set_pending(self):
1857
 
        if self._source_subpath != '':
1858
 
            return
1859
 
        Merger.set_pending(self)
1860
 
 
1861
 
 
1862
 
class _MergeTypeParameterizer(object):
1863
 
    """Wrap a merge-type class to provide extra parameters.
1864
 
    
1865
 
    This is hack used by MergeIntoMerger to pass some extra parameters to its
1866
 
    merge_type.  Merger.do_merge() sets up its own set of parameters to pass to
1867
 
    the 'merge_type' member.  It is difficult override do_merge without
1868
 
    re-writing the whole thing, so instead we create a wrapper which will pass
1869
 
    the extra parameters.
1870
 
    """
1871
 
 
1872
 
    def __init__(self, merge_type, **kwargs):
1873
 
        self._extra_kwargs = kwargs
1874
 
        self._merge_type = merge_type
1875
 
 
1876
 
    def __call__(self, *args, **kwargs):
1877
 
        kwargs.update(self._extra_kwargs)
1878
 
        return self._merge_type(*args, **kwargs)
1879
 
 
1880
 
    def __getattr__(self, name):
1881
 
        return getattr(self._merge_type, name)
1882
 
 
1883
 
 
1884
 
class MergeIntoMergeType(Merge3Merger):
1885
 
    """Merger that incorporates a tree (or part of a tree) into another."""
1886
 
 
1887
 
    def __init__(self, *args, **kwargs):
1888
 
        """Initialize the merger object.
1889
 
 
1890
 
        :param args: See Merge3Merger.__init__'s args.
1891
 
        :param kwargs: See Merge3Merger.__init__'s keyword args, except for
1892
 
            source_subpath and target_subdir.
1893
 
        :keyword source_subpath: The relative path specifying the subtree of
1894
 
            other_tree to merge into this_tree.
1895
 
        :keyword target_subdir: The relative path where we want to merge
1896
 
            other_tree into this_tree
1897
 
        """
1898
 
        # All of the interesting work happens during Merge3Merger.__init__(),
1899
 
        # so we have have to hack in to get our extra parameters set.
1900
 
        self._source_subpath = kwargs.pop('source_subpath')
1901
 
        self._target_subdir = kwargs.pop('target_subdir')
1902
 
        super(MergeIntoMergeType, self).__init__(*args, **kwargs)
1903
 
 
1904
 
    def _compute_transform(self):
1905
 
        child_pb = ui.ui_factory.nested_progress_bar()
1906
 
        try:
1907
 
            entries = self._entries_to_incorporate()
1908
 
            entries = list(entries)
1909
 
            for num, (entry, parent_id) in enumerate(entries):
1910
 
                child_pb.update(gettext('Preparing file merge'), num, len(entries))
1911
 
                parent_trans_id = self.tt.trans_id_file_id(parent_id)
1912
 
                trans_id = transform.new_by_entry(self.tt, entry,
1913
 
                    parent_trans_id, self.other_tree)
1914
 
        finally:
1915
 
            child_pb.finished()
1916
 
        self._finish_computing_transform()
1917
 
 
1918
 
    def _entries_to_incorporate(self):
1919
 
        """Yields pairs of (inventory_entry, new_parent)."""
1920
 
        other_inv = self.other_tree.inventory
1921
 
        subdir_id = other_inv.path2id(self._source_subpath)
1922
 
        if subdir_id is None:
1923
 
            # XXX: The error would be clearer if it gave the URL of the source
1924
 
            # branch, but we don't have a reference to that here.
1925
 
            raise PathNotInTree(self._source_subpath, "Source tree")
1926
 
        subdir = other_inv[subdir_id]
1927
 
        parent_in_target = osutils.dirname(self._target_subdir)
1928
 
        target_id = self.this_tree.inventory.path2id(parent_in_target)
1929
 
        if target_id is None:
1930
 
            raise PathNotInTree(self._target_subdir, "Target tree")
1931
 
        name_in_target = osutils.basename(self._target_subdir)
1932
 
        merge_into_root = subdir.copy()
1933
 
        merge_into_root.name = name_in_target
1934
 
        if self.this_tree.inventory.has_id(merge_into_root.file_id):
1935
 
            # Give the root a new file-id.
1936
 
            # This can happen fairly easily if the directory we are
1937
 
            # incorporating is the root, and both trees have 'TREE_ROOT' as
1938
 
            # their root_id.  Users will expect this to Just Work, so we
1939
 
            # change the file-id here.
1940
 
            # Non-root file-ids could potentially conflict too.  That's really
1941
 
            # an edge case, so we don't do anything special for those.  We let
1942
 
            # them cause conflicts.
1943
 
            merge_into_root.file_id = generate_ids.gen_file_id(name_in_target)
1944
 
        yield (merge_into_root, target_id)
1945
 
        if subdir.kind != 'directory':
1946
 
            # No children, so we are done.
1947
 
            return
1948
 
        for ignored_path, entry in other_inv.iter_entries_by_dir(subdir_id):
1949
 
            parent_id = entry.parent_id
1950
 
            if parent_id == subdir.file_id:
1951
 
                # The root's parent ID has changed, so make sure children of
1952
 
                # the root refer to the new ID.
1953
 
                parent_id = merge_into_root.file_id
1954
 
            yield (entry, parent_id)
1955
 
 
1956
 
 
1957
1510
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1958
1511
                backup_files=False,
1959
1512
                merge_type=Merge3Merger,
1963
1516
                other_rev_id=None,
1964
1517
                interesting_files=None,
1965
1518
                this_tree=None,
1966
 
                pb=None,
 
1519
                pb=progress.DummyProgress(),
1967
1520
                change_reporter=None):
1968
1521
    """Primary interface for merging.
1969
1522
 
1970
 
    Typical use is probably::
1971
 
 
1972
 
        merge_inner(branch, branch.get_revision_tree(other_revision),
1973
 
                    branch.get_revision_tree(base_revision))
1974
 
    """
 
1523
        typical use is probably
 
1524
        'merge_inner(branch, branch.get_revision_tree(other_revision),
 
1525
                     branch.get_revision_tree(base_revision))'
 
1526
        """
1975
1527
    if this_tree is None:
1976
1528
        raise errors.BzrError("bzrlib.merge.merge_inner requires a this_tree "
1977
 
                              "parameter")
 
1529
                              "parameter as of bzrlib version 0.8.")
1978
1530
    merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1979
1531
                    pb=pb, change_reporter=change_reporter)
1980
1532
    merger.backup_files = backup_files
2434
1986
class _PlanLCAMerge(_PlanMergeBase):
2435
1987
    """
2436
1988
    This merge algorithm differs from _PlanMerge in that:
2437
 
 
2438
1989
    1. comparisons are done against LCAs only
2439
1990
    2. cases where a contested line is new versus one LCA but old versus
2440
1991
       another are marked as conflicts, by emitting the line as conflicted-a
2481
2032
 
2482
2033
        If a line is killed and new, this indicates that the two merge
2483
2034
        revisions contain differing conflict resolutions.
2484
 
 
2485
2035
        :param revision_id: The id of the revision in which the lines are
2486
2036
            unique
2487
2037
        :param unique_line_numbers: The line numbers of unique lines.
2488
 
        :return: a tuple of (new_this, killed_other)
 
2038
        :return a tuple of (new_this, killed_other):
2489
2039
        """
2490
2040
        new = set()
2491
2041
        killed = set()