/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

  • Committer: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

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