~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

  • Committer: Andrew Bennetts
  • Date: 2010-01-12 03:53:21 UTC
  • mfrom: (4948 +trunk)
  • mto: This revision was merged to the branch mainline in revision 4964.
  • Revision ID: andrew.bennetts@canonical.com-20100112035321-hofpz5p10224ryj3
Merge lp:bzr, resolving conflicts.

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