/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to breezy/merge.py

  • Committer: Jelmer Vernooij
  • Date: 2018-03-30 14:47:14 UTC
  • mto: This revision was merged to the branch mainline in revision 6930.
  • Revision ID: jelmer@jelmer.uk-20180330144714-sncrnhqh8y4nmpbr
Add basic tests.

Show diffs side-by-side

added added

removed removed

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