13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
from itertools import chain
19
from bzrlib.lazy_import import lazy_import
20
lazy_import(globals(), """
21
23
from bzrlib import (
22
branch as _mod_branch,
24
conflicts as _mod_conflicts,
27
26
graph as _mod_graph,
31
30
revision as _mod_revision,
47
from bzrlib.symbol_versioning import (
33
from bzrlib.branch import Branch
34
from bzrlib.conflicts import ConflictList, Conflict
35
from bzrlib.errors import (BzrCommandError,
45
WorkingTreeNotRevision,
48
from bzrlib.graph import Graph
49
from bzrlib.merge3 import Merge3
50
from bzrlib.osutils import rename, pathjoin
51
from progress import DummyProgress, ProgressPhase
52
from bzrlib.revision import (NULL_REVISION, ensure_null)
53
from bzrlib.textfile import check_text_lines
54
from bzrlib.trace import mutter, warning, note, is_quiet
55
from bzrlib.transform import (TransformPreview, TreeTransform,
56
resolve_conflicts, cook_conflicts,
57
conflict_pass, FinalPaths, create_by_entry,
58
unique_add, ROOT_PARENT)
59
from bzrlib.versionedfile import PlanWeaveMerge
51
62
# TODO: Report back as changes are merged in
54
65
def transform_tree(from_tree, to_tree, interesting_ids=None):
55
from_tree.lock_tree_write()
56
operation = cleanup.OperationWithCleanups(merge_inner)
57
operation.add_cleanup(from_tree.unlock)
58
operation.run_simple(from_tree.branch, to_tree, from_tree,
59
ignore_zero=True, interesting_ids=interesting_ids, this_tree=from_tree)
62
class MergeHooks(hooks.Hooks):
65
hooks.Hooks.__init__(self, "bzrlib.merge", "Merger.hooks")
66
self.add_hook('merge_file_content',
67
"Called with a bzrlib.merge.Merger object to create a per file "
68
"merge object when starting a merge. "
69
"Should return either None or a subclass of "
70
"``bzrlib.merge.AbstractPerFileMerger``. "
71
"Such objects will then be called per file "
72
"that needs to be merged (including when one "
73
"side has deleted the file and the other has changed it). "
74
"See the AbstractPerFileMerger API docs for details on how it is "
79
class AbstractPerFileMerger(object):
80
"""PerFileMerger objects are used by plugins extending merge for bzrlib.
82
See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
84
:ivar merger: The Merge3Merger performing the merge.
87
def __init__(self, merger):
88
"""Create a PerFileMerger for use with merger."""
91
def merge_contents(self, merge_params):
92
"""Attempt to merge the contents of a single file.
94
:param merge_params: A bzrlib.merge.MergeHookParams
95
:return: A tuple of (status, chunks), where status is one of
96
'not_applicable', 'success', 'conflicted', or 'delete'. If status
97
is 'success' or 'conflicted', then chunks should be an iterable of
98
strings for the new file contents.
100
return ('not applicable', None)
103
class PerFileMerger(AbstractPerFileMerger):
104
"""Merge individual files when self.file_matches returns True.
106
This class is intended to be subclassed. The file_matches and
107
merge_matching methods should be overridden with concrete implementations.
110
def file_matches(self, params):
111
"""Return True if merge_matching should be called on this file.
113
Only called with merges of plain files with no clear winner.
115
Subclasses must override this.
117
raise NotImplementedError(self.file_matches)
119
def get_filename(self, params, tree):
120
"""Lookup the filename (i.e. basename, not path), given a Tree (e.g.
121
self.merger.this_tree) and a MergeHookParams.
123
return osutils.basename(tree.id2path(params.file_id))
125
def get_filepath(self, params, tree):
126
"""Calculate the path to the file in a tree.
128
:param params: A MergeHookParams describing the file to merge
129
:param tree: a Tree, e.g. self.merger.this_tree.
131
return tree.id2path(params.file_id)
133
def merge_contents(self, params):
134
"""Merge the contents of a single file."""
135
# Check whether this custom merge logic should be used.
137
# OTHER is a straight winner, rely on default merge.
138
params.winner == 'other' or
139
# THIS and OTHER aren't both files.
140
not params.is_file_merge() or
141
# The filename doesn't match *.xml
142
not self.file_matches(params)):
143
return 'not_applicable', None
144
return self.merge_matching(params)
146
def merge_matching(self, params):
147
"""Merge the contents of a single file that has matched the criteria
148
in PerFileMerger.merge_contents (is a conflict, is a file,
149
self.file_matches is True).
151
Subclasses must override this.
153
raise NotImplementedError(self.merge_matching)
156
class ConfigurableFileMerger(PerFileMerger):
157
"""Merge individual files when configured via a .conf file.
159
This is a base class for concrete custom file merging logic. Concrete
160
classes should implement ``merge_text``.
162
See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
164
:ivar affected_files: The configured file paths to merge.
166
:cvar name_prefix: The prefix to use when looking up configuration
167
details. <name_prefix>_merge_files describes the files targeted by the
170
:cvar default_files: The default file paths to merge when no configuration
177
def __init__(self, merger):
178
super(ConfigurableFileMerger, self).__init__(merger)
179
self.affected_files = None
180
self.default_files = self.__class__.default_files or []
181
self.name_prefix = self.__class__.name_prefix
182
if self.name_prefix is None:
183
raise ValueError("name_prefix must be set.")
185
def file_matches(self, params):
186
"""Check whether the file should call the merge hook.
188
<name_prefix>_merge_files configuration variable is a list of files
189
that should use the hook.
191
affected_files = self.affected_files
192
if affected_files is None:
193
config = self.merger.this_branch.get_config()
194
# Until bzr provides a better policy for caching the config, we
195
# just add the part we're interested in to the params to avoid
196
# reading the config files repeatedly (bazaar.conf, location.conf,
198
config_key = self.name_prefix + '_merge_files'
199
affected_files = config.get_user_option_as_list(config_key)
200
if affected_files is None:
201
# If nothing was specified in the config, use the default.
202
affected_files = self.default_files
203
self.affected_files = affected_files
205
filepath = self.get_filepath(params, self.merger.this_tree)
206
if filepath in affected_files:
210
def merge_matching(self, params):
211
return self.merge_text(params)
213
def merge_text(self, params):
214
"""Merge the byte contents of a single file.
216
This is called after checking that the merge should be performed in
217
merge_contents, and it should behave as per
218
``bzrlib.merge.AbstractPerFileMerger.merge_contents``.
220
raise NotImplementedError(self.merge_text)
223
class MergeHookParams(object):
224
"""Object holding parameters passed to merge_file_content hooks.
226
There are some fields hooks can access:
228
:ivar file_id: the file ID of the file being merged
229
:ivar trans_id: the transform ID for the merge of this file
230
:ivar this_kind: kind of file_id in 'this' tree
231
:ivar other_kind: kind of file_id in 'other' tree
232
:ivar winner: one of 'this', 'other', 'conflict'
235
def __init__(self, merger, file_id, trans_id, this_kind, other_kind,
237
self._merger = merger
238
self.file_id = file_id
239
self.trans_id = trans_id
240
self.this_kind = this_kind
241
self.other_kind = other_kind
244
def is_file_merge(self):
245
"""True if this_kind and other_kind are both 'file'."""
246
return self.this_kind == 'file' and self.other_kind == 'file'
248
@decorators.cachedproperty
249
def base_lines(self):
250
"""The lines of the 'base' version of the file."""
251
return self._merger.get_lines(self._merger.base_tree, self.file_id)
253
@decorators.cachedproperty
254
def this_lines(self):
255
"""The lines of the 'this' version of the file."""
256
return self._merger.get_lines(self._merger.this_tree, self.file_id)
258
@decorators.cachedproperty
259
def other_lines(self):
260
"""The lines of the 'other' version of the file."""
261
return self._merger.get_lines(self._merger.other_tree, self.file_id)
66
merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
67
interesting_ids=interesting_ids, this_tree=from_tree)
264
70
class Merger(object):
268
71
def __init__(self, this_branch, other_tree=None, base_tree=None,
269
this_tree=None, pb=None, change_reporter=None,
72
this_tree=None, pb=DummyProgress(), change_reporter=None,
270
73
recurse='down', revision_graph=None):
271
74
object.__init__(self)
272
75
self.this_branch = this_branch
451
231
if self.other_rev_id is None:
452
232
other_basis_tree = self.revision_tree(self.other_basis)
453
if other_basis_tree.has_changes(self.other_tree):
454
raise errors.WorkingTreeNotRevision(self.this_tree)
233
changes = other_basis_tree.changes_from(self.other_tree)
234
if changes.has_changed():
235
raise WorkingTreeNotRevision(self.this_tree)
455
236
other_rev_id = self.other_basis
456
237
self.other_tree = other_basis_tree
458
@deprecated_method(deprecated_in((2, 1, 0)))
459
239
def file_revisions(self, file_id):
460
240
self.ensure_revision_trees()
241
def get_id(tree, file_id):
242
revision_id = tree.inventory[file_id].revision
461
244
if self.this_rev_id is None:
462
245
if self.this_basis_tree.get_file_sha1(file_id) != \
463
246
self.this_tree.get_file_sha1(file_id):
464
raise errors.WorkingTreeNotRevision(self.this_tree)
247
raise WorkingTreeNotRevision(self.this_tree)
466
249
trees = (self.this_basis_tree, self.other_tree)
467
return [tree.get_file_revision(file_id) for tree in trees]
250
return [get_id(tree, file_id) for tree in trees]
469
@deprecated_method(deprecated_in((2, 1, 0)))
470
252
def check_basis(self, check_clean, require_commits=True):
471
253
if self.this_basis is None and require_commits is True:
472
raise errors.BzrCommandError(
473
"This branch has no commits."
474
" (perhaps you would prefer 'bzr pull')")
254
raise BzrCommandError("This branch has no commits."
255
" (perhaps you would prefer 'bzr pull')")
476
257
self.compare_basis()
477
258
if self.this_basis != self.this_rev_id:
478
259
raise errors.UncommittedChanges(self.this_tree)
480
@deprecated_method(deprecated_in((2, 1, 0)))
481
261
def compare_basis(self):
483
263
basis_tree = self.revision_tree(self.this_tree.last_revision())
484
264
except errors.NoSuchRevision:
485
265
basis_tree = self.this_tree.basis_tree()
486
if not self.this_tree.has_changes(basis_tree):
266
changes = self.this_tree.changes_from(basis_tree)
267
if not changes.has_changed():
487
268
self.this_rev_id = self.this_basis
489
270
def set_interesting_files(self, file_list):
490
271
self.interesting_files = file_list
492
273
def set_pending(self):
493
if (not self.base_is_ancestor or not self.base_is_other_ancestor
494
or self.other_rev_id is None):
274
if not self.base_is_ancestor or not self.base_is_other_ancestor or self.other_rev_id is None:
496
276
self._add_parent()
498
278
def _add_parent(self):
499
279
new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
500
280
new_parent_trees = []
501
operation = cleanup.OperationWithCleanups(
502
self.this_tree.set_parent_trees)
503
281
for revision_id in new_parents:
505
283
tree = self.revision_tree(revision_id)
566
349
target.fetch(source, revision_id)
568
351
def find_base(self):
569
revisions = [_mod_revision.ensure_null(self.this_basis),
570
_mod_revision.ensure_null(self.other_basis)]
571
if _mod_revision.NULL_REVISION in revisions:
572
self.base_rev_id = _mod_revision.NULL_REVISION
573
self.base_tree = self.revision_tree(self.base_rev_id)
574
self._is_criss_cross = False
352
revisions = [ensure_null(self.this_basis),
353
ensure_null(self.other_basis)]
354
if NULL_REVISION in revisions:
355
self.base_rev_id = NULL_REVISION
576
lcas = self.revision_graph.find_lca(revisions[0], revisions[1])
577
self._is_criss_cross = False
579
self.base_rev_id = _mod_revision.NULL_REVISION
581
self.base_rev_id = list(lcas)[0]
582
else: # len(lcas) > 1
583
self._is_criss_cross = True
585
# find_unique_lca can only handle 2 nodes, so we have to
586
# start back at the beginning. It is a shame to traverse
587
# the graph again, but better than re-implementing
589
self.base_rev_id = self.revision_graph.find_unique_lca(
590
revisions[0], revisions[1])
592
self.base_rev_id = self.revision_graph.find_unique_lca(
594
sorted_lca_keys = self.revision_graph.find_merge_order(
596
if self.base_rev_id == _mod_revision.NULL_REVISION:
597
self.base_rev_id = sorted_lca_keys[0]
599
if self.base_rev_id == _mod_revision.NULL_REVISION:
600
raise errors.UnrelatedBranches()
601
if self._is_criss_cross:
602
trace.warning('Warning: criss-cross merge encountered. See bzr'
603
' help criss-cross.')
604
trace.mutter('Criss-cross lcas: %r' % lcas)
605
if self.base_rev_id in lcas:
606
trace.mutter('Unable to find unique lca. '
607
'Fallback %r as best option.' % self.base_rev_id)
608
interesting_revision_ids = set(lcas)
609
interesting_revision_ids.add(self.base_rev_id)
610
interesting_trees = dict((t.get_revision_id(), t)
611
for t in self.this_branch.repository.revision_trees(
612
interesting_revision_ids))
613
self._cached_trees.update(interesting_trees)
614
if self.base_rev_id in lcas:
615
self.base_tree = interesting_trees[self.base_rev_id]
617
self.base_tree = interesting_trees.pop(self.base_rev_id)
618
self._lca_trees = [interesting_trees[key]
619
for key in sorted_lca_keys]
621
self.base_tree = self.revision_tree(self.base_rev_id)
357
self.base_rev_id, steps = self.revision_graph.find_unique_lca(
358
revisions[0], revisions[1], count_steps=True)
359
if self.base_rev_id == NULL_REVISION:
360
raise UnrelatedBranches()
362
warning('Warning: criss-cross merge encountered. See bzr'
363
' help criss-cross.')
364
self.base_tree = self.revision_tree(self.base_rev_id)
622
365
self.base_is_ancestor = True
623
366
self.base_is_other_ancestor = True
624
trace.mutter('Base revid: %r' % self.base_rev_id)
626
368
def set_base(self, base_revision):
627
369
"""Set the base revision to use for the merge.
629
371
:param base_revision: A 2-list containing a path and revision number.
631
trace.mutter("doing merge() with no base_revision specified")
373
mutter("doing merge() with no base_revision specified")
632
374
if base_revision == [None, None]:
647
389
'other_tree': self.other_tree,
648
390
'interesting_ids': self.interesting_ids,
649
391
'interesting_files': self.interesting_files,
650
'this_branch': self.this_branch,
651
393
'do_merge': False}
652
394
if self.merge_type.requires_base:
653
395
kwargs['base_tree'] = self.base_tree
654
396
if self.merge_type.supports_reprocess:
655
397
kwargs['reprocess'] = self.reprocess
656
398
elif self.reprocess:
657
raise errors.BzrError(
658
"Conflict reduction is not supported for merge"
659
" type %s." % self.merge_type)
399
raise BzrError("Conflict reduction is not supported for merge"
400
" type %s." % self.merge_type)
660
401
if self.merge_type.supports_show_base:
661
402
kwargs['show_base'] = self.show_base
662
403
elif self.show_base:
663
raise errors.BzrError("Showing base is not supported for this"
664
" merge type. %s" % self.merge_type)
404
raise BzrError("Showing base is not supported for this"
405
" merge type. %s" % self.merge_type)
665
406
if (not getattr(self.merge_type, 'supports_reverse_cherrypick', True)
666
407
and not self.base_is_other_ancestor):
667
408
raise errors.CannotReverseCherrypick()
668
409
if self.merge_type.supports_cherrypick:
669
410
kwargs['cherrypick'] = (not self.base_is_ancestor or
670
411
not self.base_is_other_ancestor)
671
if self._is_criss_cross and getattr(self.merge_type,
672
'supports_lca_trees', False):
673
kwargs['lca_trees'] = self._lca_trees
674
return self.merge_type(pb=None,
412
return self.merge_type(pb=self._pb,
675
413
change_reporter=self.change_reporter,
678
def _do_merge_to(self):
679
merge = self.make_merger()
680
if self.other_branch is not None:
681
self.other_branch.update_references(self.this_branch)
683
if self.recurse == 'down':
684
for relpath, file_id in self.this_tree.iter_references():
685
sub_tree = self.this_tree.get_nested_tree(file_id, relpath)
686
other_revision = self.other_tree.get_reference_revision(
688
if other_revision == sub_tree.last_revision():
690
sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
691
sub_merge.merge_type = self.merge_type
692
other_branch = self.other_branch.reference_parent(file_id, relpath)
693
sub_merge.set_other_revision(other_revision, other_branch)
694
base_revision = self.base_tree.get_reference_revision(file_id)
695
sub_merge.base_tree = \
696
sub_tree.branch.repository.revision_tree(base_revision)
697
sub_merge.base_rev_id = base_revision
701
416
def do_merge(self):
702
operation = cleanup.OperationWithCleanups(self._do_merge_to)
703
417
self.this_tree.lock_tree_write()
704
operation.add_cleanup(self.this_tree.unlock)
705
418
if self.base_tree is not None:
706
419
self.base_tree.lock_read()
707
operation.add_cleanup(self.base_tree.unlock)
708
420
if self.other_tree is not None:
709
421
self.other_tree.lock_read()
710
operation.add_cleanup(self.other_tree.unlock)
711
merge = operation.run_simple()
423
merge = self.make_merger()
425
if self.recurse == 'down':
426
for relpath, file_id in self.this_tree.iter_references():
427
sub_tree = self.this_tree.get_nested_tree(file_id, relpath)
428
other_revision = self.other_tree.get_reference_revision(
430
if other_revision == sub_tree.last_revision():
432
sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
433
sub_merge.merge_type = self.merge_type
434
other_branch = self.other_branch.reference_parent(file_id, relpath)
435
sub_merge.set_other_revision(other_revision, other_branch)
436
base_revision = self.base_tree.get_reference_revision(file_id)
437
sub_merge.base_tree = \
438
sub_tree.branch.repository.revision_tree(base_revision)
439
sub_merge.base_rev_id = base_revision
443
if self.other_tree is not None:
444
self.other_tree.unlock()
445
if self.base_tree is not None:
446
self.base_tree.unlock()
447
self.this_tree.unlock()
712
448
if len(merge.cooked_conflicts) == 0:
713
if not self.ignore_zero and not trace.is_quiet():
714
trace.note("All changes applied successfully.")
449
if not self.ignore_zero and not is_quiet():
450
note("All changes applied successfully.")
716
trace.note("%d conflicts encountered."
717
% len(merge.cooked_conflicts))
452
note("%d conflicts encountered." % len(merge.cooked_conflicts))
719
454
return len(merge.cooked_conflicts)
722
class _InventoryNoneEntry(object):
723
"""This represents an inventory entry which *isn't there*.
725
It simplifies the merging logic if we always have an InventoryEntry, even
726
if it isn't actually present
733
symlink_target = None
736
_none_entry = _InventoryNoneEntry()
739
457
class Merge3Merger(object):
740
458
"""Three-way merger that uses the merge3 text merger"""
741
459
requires_base = True
745
463
supports_cherrypick = True
746
464
supports_reverse_cherrypick = True
747
465
winner_idx = {"this": 2, "other": 1, "conflict": 1}
748
supports_lca_trees = True
750
def __init__(self, working_tree, this_tree, base_tree, other_tree,
467
def __init__(self, working_tree, this_tree, base_tree, other_tree,
751
468
interesting_ids=None, reprocess=False, show_base=False,
752
pb=None, pp=None, change_reporter=None,
469
pb=DummyProgress(), pp=None, change_reporter=None,
753
470
interesting_files=None, do_merge=True,
754
cherrypick=False, lca_trees=None, this_branch=None):
755
472
"""Initialize the merger object and perform the merge.
757
474
:param working_tree: The working tree to apply the merge to
758
475
:param this_tree: The local tree in the merge operation
759
476
:param base_tree: The common tree in the merge operation
760
:param other_tree: The other tree to merge changes from
761
:param this_branch: The branch associated with this_tree. Defaults to
762
this_tree.branch if not supplied.
477
:param other_tree: The other other tree to merge changes from
763
478
:param interesting_ids: The file_ids of files that should be
764
479
participate in the merge. May not be combined with
765
480
interesting_files.
766
481
:param: reprocess If True, perform conflict-reduction processing.
767
482
:param show_base: If True, show the base revision in text conflicts.
768
483
(incompatible with reprocess)
484
:param pb: A Progress bar
770
485
:param pp: A ProgressPhase object
771
486
:param change_reporter: An object that should report changes made
772
487
:param interesting_files: The tree-relative paths of files that should
775
490
be combined with interesting_ids. If neither interesting_files nor
776
491
interesting_ids is specified, all files may participate in the
778
:param lca_trees: Can be set to a dictionary of {revision_id:rev_tree}
779
if the ancestry was found to include a criss-cross merge.
780
Otherwise should be None.
782
494
object.__init__(self)
783
495
if interesting_files is not None and interesting_ids is not None:
784
496
raise ValueError(
785
497
'specify either interesting_ids or interesting_files')
786
if this_branch is None:
787
this_branch = this_tree.branch
788
498
self.interesting_ids = interesting_ids
789
499
self.interesting_files = interesting_files
790
500
self.this_tree = working_tree
791
501
self.base_tree = base_tree
792
502
self.other_tree = other_tree
793
self.this_branch = this_branch
794
503
self._raw_conflicts = []
795
504
self.cooked_conflicts = []
796
505
self.reprocess = reprocess
797
506
self.show_base = show_base
798
self._lca_trees = lca_trees
799
# Uncommenting this will change the default algorithm to always use
800
# _entries_lca. This can be useful for running the test suite and
801
# making sure we haven't missed any corner cases.
802
# if lca_trees is None:
803
# self._lca_trees = [self.base_tree]
804
509
self.change_reporter = change_reporter
805
510
self.cherrypick = cherrypick
512
self.pp = ProgressPhase("Merge phase", 3, self.pb)
809
warnings.warn("pp argument to Merge3Merger is deprecated")
811
warnings.warn("pb argument to Merge3Merger is deprecated")
813
516
def do_merge(self):
814
operation = cleanup.OperationWithCleanups(self._do_merge)
815
517
self.this_tree.lock_tree_write()
816
operation.add_cleanup(self.this_tree.unlock)
817
518
self.base_tree.lock_read()
818
operation.add_cleanup(self.base_tree.unlock)
819
519
self.other_tree.lock_read()
820
operation.add_cleanup(self.other_tree.unlock)
823
def _do_merge(self, operation):
824
self.tt = transform.TreeTransform(self.this_tree, None)
825
operation.add_cleanup(self.tt.finalize)
826
self._compute_transform()
827
results = self.tt.apply(no_conflicts=True)
828
self.write_modified(results)
520
self.tt = TreeTransform(self.this_tree, self.pb)
830
self.this_tree.add_conflicts(self.cooked_conflicts)
831
except errors.UnsupportedOperation:
523
self._compute_transform()
525
results = self.tt.apply(no_conflicts=True)
526
self.write_modified(results)
528
self.this_tree.add_conflicts(self.cooked_conflicts)
529
except UnsupportedOperation:
533
self.other_tree.unlock()
534
self.base_tree.unlock()
535
self.this_tree.unlock()
834
538
def make_preview_transform(self):
835
operation = cleanup.OperationWithCleanups(self._make_preview_transform)
836
539
self.base_tree.lock_read()
837
operation.add_cleanup(self.base_tree.unlock)
838
540
self.other_tree.lock_read()
839
operation.add_cleanup(self.other_tree.unlock)
840
return operation.run_simple()
842
def _make_preview_transform(self):
843
self.tt = transform.TransformPreview(self.this_tree)
844
self._compute_transform()
541
self.tt = TransformPreview(self.this_tree)
544
self._compute_transform()
547
self.other_tree.unlock()
548
self.base_tree.unlock()
847
552
def _compute_transform(self):
848
if self._lca_trees is None:
849
entries = self._entries3()
850
resolver = self._three_way
852
entries = self._entries_lca()
853
resolver = self._lca_multi_way
553
entries = self._entries3()
854
554
child_pb = ui.ui_factory.nested_progress_bar()
856
factories = Merger.hooks['merge_file_content']
857
hooks = [factory(self) for factory in factories] + [self]
858
self.active_hooks = [hook for hook in hooks if hook is not None]
859
556
for num, (file_id, changed, parents3, names3,
860
557
executable3) in enumerate(entries):
861
558
child_pb.update('Preparing file merge', num, len(entries))
862
self._merge_names(file_id, parents3, names3, resolver=resolver)
559
self._merge_names(file_id, parents3, names3)
864
file_status = self._do_merge_contents(file_id)
561
file_status = self.merge_contents(file_id)
866
563
file_status = 'unmodified'
867
564
self._merge_executable(file_id,
868
executable3, file_status, resolver=resolver)
565
executable3, file_status)
870
567
child_pb.finished()
871
self.tt.fixup_new_roots()
872
self._finish_computing_transform()
874
def _finish_computing_transform(self):
875
"""Finalize the transform and report the changes.
877
This is the second half of _compute_transform.
879
570
child_pb = ui.ui_factory.nested_progress_bar()
881
fs_conflicts = transform.resolve_conflicts(self.tt, child_pb,
882
lambda t, c: transform.conflict_pass(t, c, self.other_tree))
572
fs_conflicts = resolve_conflicts(self.tt, child_pb,
573
lambda t, c: conflict_pass(t, c, self.other_tree))
884
575
child_pb.finished()
885
576
if self.change_reporter is not None:
926
614
result.append((file_id, changed, parents3, names3, executable3))
929
def _entries_lca(self):
930
"""Gather data about files modified between multiple trees.
932
This compares OTHER versus all LCA trees, and for interesting entries,
933
it then compares with THIS and BASE.
935
For the multi-valued entries, the format will be (BASE, [lca1, lca2])
937
:return: [(file_id, changed, parents, names, executable)], where:
939
* file_id: Simple file_id of the entry
940
* changed: Boolean, True if the kind or contents changed else False
941
* parents: ((base, [parent_id, in, lcas]), parent_id_other,
943
* names: ((base, [name, in, lcas]), name_in_other, name_in_this)
944
* executable: ((base, [exec, in, lcas]), exec_in_other,
947
if self.interesting_files is not None:
948
lookup_trees = [self.this_tree, self.base_tree]
949
lookup_trees.extend(self._lca_trees)
950
# I think we should include the lca trees as well
951
interesting_ids = self.other_tree.paths2ids(self.interesting_files,
954
interesting_ids = self.interesting_ids
956
walker = _mod_tree.MultiWalker(self.other_tree, self._lca_trees)
958
base_inventory = self.base_tree.inventory
959
this_inventory = self.this_tree.inventory
960
for path, file_id, other_ie, lca_values in walker.iter_all():
961
# Is this modified at all from any of the other trees?
963
other_ie = _none_entry
964
if interesting_ids is not None and file_id not in interesting_ids:
967
# If other_revision is found in any of the lcas, that means this
968
# node is uninteresting. This is because when merging, if there are
969
# multiple heads(), we have to create a new node. So if we didn't,
970
# we know that the ancestry is linear, and that OTHER did not
972
# See doc/developers/lca_merge_resolution.txt for details
973
other_revision = other_ie.revision
974
if other_revision is not None:
975
# We can't use this shortcut when other_revision is None,
976
# because it may be None because things are WorkingTrees, and
977
# not because it is *actually* None.
978
is_unmodified = False
979
for lca_path, ie in lca_values:
980
if ie is not None and ie.revision == other_revision:
987
for lca_path, lca_ie in lca_values:
989
lca_entries.append(_none_entry)
991
lca_entries.append(lca_ie)
993
if base_inventory.has_id(file_id):
994
base_ie = base_inventory[file_id]
996
base_ie = _none_entry
998
if this_inventory.has_id(file_id):
999
this_ie = this_inventory[file_id]
1001
this_ie = _none_entry
1007
for lca_ie in lca_entries:
1008
lca_kinds.append(lca_ie.kind)
1009
lca_parent_ids.append(lca_ie.parent_id)
1010
lca_names.append(lca_ie.name)
1011
lca_executable.append(lca_ie.executable)
1013
kind_winner = self._lca_multi_way(
1014
(base_ie.kind, lca_kinds),
1015
other_ie.kind, this_ie.kind)
1016
parent_id_winner = self._lca_multi_way(
1017
(base_ie.parent_id, lca_parent_ids),
1018
other_ie.parent_id, this_ie.parent_id)
1019
name_winner = self._lca_multi_way(
1020
(base_ie.name, lca_names),
1021
other_ie.name, this_ie.name)
1023
content_changed = True
1024
if kind_winner == 'this':
1025
# No kind change in OTHER, see if there are *any* changes
1026
if other_ie.kind == 'directory':
1027
if parent_id_winner == 'this' and name_winner == 'this':
1028
# No change for this directory in OTHER, skip
1030
content_changed = False
1031
elif other_ie.kind is None or other_ie.kind == 'file':
1032
def get_sha1(ie, tree):
1033
if ie.kind != 'file':
1035
return tree.get_file_sha1(file_id)
1036
base_sha1 = get_sha1(base_ie, self.base_tree)
1037
lca_sha1s = [get_sha1(ie, tree) for ie, tree
1038
in zip(lca_entries, self._lca_trees)]
1039
this_sha1 = get_sha1(this_ie, self.this_tree)
1040
other_sha1 = get_sha1(other_ie, self.other_tree)
1041
sha1_winner = self._lca_multi_way(
1042
(base_sha1, lca_sha1s), other_sha1, this_sha1,
1043
allow_overriding_lca=False)
1044
exec_winner = self._lca_multi_way(
1045
(base_ie.executable, lca_executable),
1046
other_ie.executable, this_ie.executable)
1047
if (parent_id_winner == 'this' and name_winner == 'this'
1048
and sha1_winner == 'this' and exec_winner == 'this'):
1049
# No kind, parent, name, exec, or content change for
1050
# OTHER, so this node is not considered interesting
1052
if sha1_winner == 'this':
1053
content_changed = False
1054
elif other_ie.kind == 'symlink':
1055
def get_target(ie, tree):
1056
if ie.kind != 'symlink':
1058
return tree.get_symlink_target(file_id)
1059
base_target = get_target(base_ie, self.base_tree)
1060
lca_targets = [get_target(ie, tree) for ie, tree
1061
in zip(lca_entries, self._lca_trees)]
1062
this_target = get_target(this_ie, self.this_tree)
1063
other_target = get_target(other_ie, self.other_tree)
1064
target_winner = self._lca_multi_way(
1065
(base_target, lca_targets),
1066
other_target, this_target)
1067
if (parent_id_winner == 'this' and name_winner == 'this'
1068
and target_winner == 'this'):
1069
# No kind, parent, name, or symlink target change
1072
if target_winner == 'this':
1073
content_changed = False
1074
elif other_ie.kind == 'tree-reference':
1075
# The 'changed' information seems to be handled at a higher
1076
# level. At least, _entries3 returns False for content
1077
# changed, even when at a new revision_id.
1078
content_changed = False
1079
if (parent_id_winner == 'this' and name_winner == 'this'):
1080
# Nothing interesting
1083
raise AssertionError('unhandled kind: %s' % other_ie.kind)
1085
# If we have gotten this far, that means something has changed
1086
result.append((file_id, content_changed,
1087
((base_ie.parent_id, lca_parent_ids),
1088
other_ie.parent_id, this_ie.parent_id),
1089
((base_ie.name, lca_names),
1090
other_ie.name, this_ie.name),
1091
((base_ie.executable, lca_executable),
1092
other_ie.executable, this_ie.executable)
1096
@deprecated_method(deprecated_in((2, 4, 0)))
1097
617
def fix_root(self):
1098
if self.tt.final_kind(self.tt.root) is None:
619
self.tt.final_kind(self.tt.root)
1099
621
self.tt.cancel_deletion(self.tt.root)
1100
622
if self.tt.final_file_id(self.tt.root) is None:
1101
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
623
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
625
if self.other_tree.inventory.root is None:
1103
627
other_root_file_id = self.other_tree.get_root_id()
1104
if other_root_file_id is None:
1106
628
other_root = self.tt.trans_id_file_id(other_root_file_id)
1107
629
if other_root == self.tt.root:
1109
if self.this_tree.inventory.has_id(
1110
self.other_tree.inventory.root.file_id):
1111
# the other tree's root is a non-root in the current tree (as
1112
# when a previously unrelated branch is merged into another)
632
self.tt.final_kind(other_root)
1114
if self.tt.final_kind(other_root) is not None:
1115
other_root_is_present = True
1117
# other_root doesn't have a physical representation. We still need
1118
# to move any references to the actual root of the tree.
1119
other_root_is_present = False
1120
# 'other_tree.inventory.root' is not present in this tree. We are
1121
# calling adjust_path for children which *want* to be present with a
1122
# correct place to go.
1123
for _, child in self.other_tree.inventory.root.children.iteritems():
635
self.reparent_children(self.other_tree.inventory.root, self.tt.root)
636
self.tt.cancel_creation(other_root)
637
self.tt.cancel_versioning(other_root)
639
def reparent_children(self, ie, target):
640
for thing, child in ie.children.iteritems():
1124
641
trans_id = self.tt.trans_id_file_id(child.file_id)
1125
if not other_root_is_present:
1126
if self.tt.final_kind(trans_id) is not None:
1127
# The item exist in the final tree and has a defined place
1130
# Move the item into the root
1132
final_name = self.tt.final_name(trans_id)
1133
except errors.NoFinalPath:
1134
# This file is not present anymore, ignore it.
1136
self.tt.adjust_path(final_name, self.tt.root, trans_id)
1137
if other_root_is_present:
1138
self.tt.cancel_creation(other_root)
1139
self.tt.cancel_versioning(other_root)
642
self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
1141
644
def write_modified(self, results):
1142
645
modified_hashes = {}
1184
687
def kind(tree, file_id):
1185
688
"""Determine the kind of a file-id (used as a key method)."""
1186
if not tree.has_id(file_id):
689
if file_id not in tree:
1188
691
return tree.kind(file_id)
1191
694
def _three_way(base, other, this):
695
#if base == other, either they all agree, or only THIS has changed.
1192
696
if base == other:
1193
# if 'base == other', either they all agree, or only 'this' has
1196
698
elif this not in (base, other):
1197
# 'this' is neither 'base' nor 'other', so both sides changed
1198
699
return 'conflict'
700
# "Ambiguous clean merge" -- both sides have made the same change.
1199
701
elif this == other:
1200
# "Ambiguous clean merge" -- both sides have made the same change.
703
# this == base: only other has changed.
1203
# this == base: only other has changed.
1207
def _lca_multi_way(bases, other, this, allow_overriding_lca=True):
1208
"""Consider LCAs when determining whether a change has occurred.
1210
If LCAS are all identical, this is the same as a _three_way comparison.
1212
:param bases: value in (BASE, [LCAS])
1213
:param other: value in OTHER
1214
:param this: value in THIS
1215
:param allow_overriding_lca: If there is more than one unique lca
1216
value, allow OTHER to override THIS if it has a new value, and
1217
THIS only has an lca value, or vice versa. This is appropriate for
1218
truly scalar values, not as much for non-scalars.
1219
:return: 'this', 'other', or 'conflict' depending on whether an entry
1222
# See doc/developers/lca_tree_merging.txt for details about this
1225
# Either Ambiguously clean, or nothing was actually changed. We
1228
base_val, lca_vals = bases
1229
# Remove 'base_val' from the lca_vals, because it is not interesting
1230
filtered_lca_vals = [lca_val for lca_val in lca_vals
1231
if lca_val != base_val]
1232
if len(filtered_lca_vals) == 0:
1233
return Merge3Merger._three_way(base_val, other, this)
1235
unique_lca_vals = set(filtered_lca_vals)
1236
if len(unique_lca_vals) == 1:
1237
return Merge3Merger._three_way(unique_lca_vals.pop(), other, this)
1239
if allow_overriding_lca:
1240
if other in unique_lca_vals:
1241
if this in unique_lca_vals:
1242
# Each side picked a different lca, conflict
1245
# This has a value which supersedes both lca values, and
1246
# other only has an lca value
1248
elif this in unique_lca_vals:
1249
# OTHER has a value which supersedes both lca values, and this
1250
# only has an lca value
1253
# At this point, the lcas disagree, and the tip disagree
1257
@deprecated_method(deprecated_in((2, 2, 0)))
1258
708
def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
1259
709
"""Do a three-way test on a scalar.
1260
710
Return "this", "other" or "conflict", depending whether a value wins.
1310
759
parent_id_winner = "other"
1311
760
if name_winner == "this" and parent_id_winner == "this":
1313
if name_winner == 'conflict' or parent_id_winner == 'conflict':
1314
# Creating helpers (.OTHER or .THIS) here cause problems down the
1315
# road if a ContentConflict needs to be created so we should not do
1317
trans_id = self.tt.trans_id_file_id(file_id)
1318
self._raw_conflicts.append(('path conflict', trans_id, file_id,
1319
this_parent, this_name,
1320
other_parent, other_name))
1321
if not self.other_tree.has_id(file_id):
1322
# it doesn't matter whether the result was 'other' or
1323
# 'conflict'-- if it has no file id, we leave it alone.
762
if name_winner == "conflict":
763
trans_id = self.tt.trans_id_file_id(file_id)
764
self._raw_conflicts.append(('name conflict', trans_id,
765
this_name, other_name))
766
if parent_id_winner == "conflict":
767
trans_id = self.tt.trans_id_file_id(file_id)
768
self._raw_conflicts.append(('parent conflict', trans_id,
769
this_parent, other_parent))
770
if other_name is None:
771
# it doesn't matter whether the result was 'other' or
772
# 'conflict'-- if there's no 'other', we leave it alone.
774
# if we get here, name_winner and parent_winner are set to safe values.
775
trans_id = self.tt.trans_id_file_id(file_id)
1325
776
parent_id = parents[self.winner_idx[parent_id_winner]]
1326
name = names[self.winner_idx[name_winner]]
1327
if parent_id is not None or name is not None:
1328
# if we get here, name_winner and parent_winner are set to safe
1330
if parent_id is None and name is not None:
1331
# if parent_id is None and name is non-None, current file is
1333
if names[self.winner_idx[parent_id_winner]] != '':
1334
raise AssertionError(
1335
'File looks like a root, but named %s' %
1336
names[self.winner_idx[parent_id_winner]])
1337
parent_trans_id = transform.ROOT_PARENT
1339
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1340
self.tt.adjust_path(name, parent_trans_id,
1341
self.tt.trans_id_file_id(file_id))
777
if parent_id is not None:
778
parent_trans_id = self.tt.trans_id_file_id(parent_id)
779
self.tt.adjust_path(names[self.winner_idx[name_winner]],
780
parent_trans_id, trans_id)
1343
def _do_merge_contents(self, file_id):
1344
"""Performs a merge on file_id contents."""
782
def merge_contents(self, file_id):
783
"""Performa a merge on file_id contents."""
1345
784
def contents_pair(tree):
1346
if not tree.has_id(file_id):
785
if file_id not in tree:
1347
786
return (None, None)
1348
787
kind = tree.kind(file_id)
1349
788
if kind == "file":
1355
794
return kind, contents
796
def contents_conflict():
797
trans_id = self.tt.trans_id_file_id(file_id)
798
name = self.tt.final_name(trans_id)
799
parent_id = self.tt.final_parent(trans_id)
800
if file_id in self.this_tree.inventory:
801
self.tt.unversion_file(trans_id)
802
if file_id in self.this_tree:
803
self.tt.delete_contents(trans_id)
804
file_group = self._dump_conflicts(name, parent_id, file_id,
806
self._raw_conflicts.append(('contents conflict', file_group))
1357
808
# See SPOT run. run, SPOT, run.
1358
809
# So we're not QUITE repeating ourselves; we do tricky things with
1360
811
base_pair = contents_pair(self.base_tree)
1361
812
other_pair = contents_pair(self.other_tree)
1363
this_pair = contents_pair(self.this_tree)
1364
lca_pairs = [contents_pair(tree) for tree in self._lca_trees]
1365
winner = self._lca_multi_way((base_pair, lca_pairs), other_pair,
1366
this_pair, allow_overriding_lca=False)
1368
if base_pair == other_pair:
1371
# We delayed evaluating this_pair as long as we can to avoid
1372
# unnecessary sha1 calculation
1373
this_pair = contents_pair(self.this_tree)
1374
winner = self._three_way(base_pair, other_pair, this_pair)
1375
if winner == 'this':
1376
# No interesting changes introduced by OTHER
1378
# We have a hypothetical conflict, but if we have files, then we
1379
# can try to merge the content
1380
trans_id = self.tt.trans_id_file_id(file_id)
1381
params = MergeHookParams(self, file_id, trans_id, this_pair[0],
1382
other_pair[0], winner)
1383
hooks = self.active_hooks
1384
hook_status = 'not_applicable'
1386
hook_status, lines = hook.merge_contents(params)
1387
if hook_status != 'not_applicable':
1388
# Don't try any more hooks, this one applies.
1391
if hook_status == 'not_applicable':
1392
# This is a contents conflict, because none of the available
1393
# functions could merge it.
1395
name = self.tt.final_name(trans_id)
1396
parent_id = self.tt.final_parent(trans_id)
1397
if self.this_tree.has_id(file_id):
1398
self.tt.unversion_file(trans_id)
1399
file_group = self._dump_conflicts(name, parent_id, file_id,
1401
self._raw_conflicts.append(('contents conflict', file_group))
1402
elif hook_status == 'success':
1403
self.tt.create_file(lines, trans_id)
1404
elif hook_status == 'conflicted':
1405
# XXX: perhaps the hook should be able to provide
1406
# the BASE/THIS/OTHER files?
1407
self.tt.create_file(lines, trans_id)
1408
self._raw_conflicts.append(('text conflict', trans_id))
1409
name = self.tt.final_name(trans_id)
1410
parent_id = self.tt.final_parent(trans_id)
1411
self._dump_conflicts(name, parent_id, file_id)
1412
elif hook_status == 'delete':
1413
self.tt.unversion_file(trans_id)
1415
elif hook_status == 'done':
1416
# The hook function did whatever it needs to do directly, no
1417
# further action needed here.
1420
raise AssertionError('unknown hook_status: %r' % (hook_status,))
1421
if not self.this_tree.has_id(file_id) and result == "modified":
1422
self.tt.version_file(file_id, trans_id)
1423
# The merge has been performed, so the old contents should not be
1425
self.tt.delete_contents(trans_id)
1428
def _default_other_winner_merge(self, merge_hook_params):
1429
"""Replace this contents with other."""
1430
file_id = merge_hook_params.file_id
1431
trans_id = merge_hook_params.trans_id
1432
file_in_this = self.this_tree.has_id(file_id)
1433
if self.other_tree.has_id(file_id):
1434
# OTHER changed the file
1436
if wt.supports_content_filtering():
1437
# We get the path from the working tree if it exists.
1438
# That fails though when OTHER is adding a file, so
1439
# we fall back to the other tree to find the path if
1440
# it doesn't exist locally.
1442
filter_tree_path = wt.id2path(file_id)
1443
except errors.NoSuchId:
1444
filter_tree_path = self.other_tree.id2path(file_id)
1446
# Skip the id2path lookup for older formats
1447
filter_tree_path = None
1448
transform.create_from_tree(self.tt, trans_id,
1449
self.other_tree, file_id,
1450
filter_tree_path=filter_tree_path)
1453
# OTHER deleted the file
1454
return 'delete', None
1456
raise AssertionError(
1457
'winner is OTHER, but file_id %r not in THIS or OTHER tree'
1460
def merge_contents(self, merge_hook_params):
1461
"""Fallback merge logic after user installed hooks."""
1462
# This function is used in merge hooks as the fallback instance.
1463
# Perhaps making this function and the functions it calls be a
1464
# a separate class would be better.
1465
if merge_hook_params.winner == 'other':
1466
# OTHER is a straight winner, so replace this contents with other
1467
return self._default_other_winner_merge(merge_hook_params)
1468
elif merge_hook_params.is_file_merge():
1469
# THIS and OTHER are both files, so text merge. Either
1470
# BASE is a file, or both converted to files, so at least we
1471
# have agreement that output should be a file.
1473
self.text_merge(merge_hook_params.file_id,
1474
merge_hook_params.trans_id)
1475
except errors.BinaryFile:
1476
return 'not_applicable', None
1479
return 'not_applicable', None
813
if base_pair == other_pair:
814
# OTHER introduced no changes
816
this_pair = contents_pair(self.this_tree)
817
if this_pair == other_pair:
818
# THIS and OTHER introduced the same changes
821
trans_id = self.tt.trans_id_file_id(file_id)
822
if this_pair == base_pair:
823
# only OTHER introduced changes
824
if file_id in self.this_tree:
825
# Remove any existing contents
826
self.tt.delete_contents(trans_id)
827
if file_id in self.other_tree:
828
# OTHER changed the file
829
create_by_entry(self.tt,
830
self.other_tree.inventory[file_id],
831
self.other_tree, trans_id)
832
if file_id not in self.this_tree.inventory:
833
self.tt.version_file(file_id, trans_id)
835
elif file_id in self.this_tree.inventory:
836
# OTHER deleted the file
837
self.tt.unversion_file(trans_id)
839
#BOTH THIS and OTHER introduced changes; scalar conflict
840
elif this_pair[0] == "file" and other_pair[0] == "file":
841
# THIS and OTHER are both files, so text merge. Either
842
# BASE is a file, or both converted to files, so at least we
843
# have agreement that output should be a file.
845
self.text_merge(file_id, trans_id)
847
return contents_conflict()
848
if file_id not in self.this_tree.inventory:
849
self.tt.version_file(file_id, trans_id)
851
self.tt.tree_kind(trans_id)
852
self.tt.delete_contents(trans_id)
857
# Scalar conflict, can't text merge. Dump conflicts
858
return contents_conflict()
1481
860
def get_lines(self, tree, file_id):
1482
861
"""Return the lines in a file, or an empty list."""
1483
if tree.has_id(file_id):
1484
return tree.get_file_lines(file_id)
863
return tree.get_file(file_id).readlines()
1537
916
determined automatically. If set_version is true, the .OTHER, .THIS
1538
917
or .BASE (in that order) will be created as versioned files.
1540
data = [('OTHER', self.other_tree, other_lines),
919
data = [('OTHER', self.other_tree, other_lines),
1541
920
('THIS', self.this_tree, this_lines)]
1543
922
data.append(('BASE', self.base_tree, base_lines))
1545
# We need to use the actual path in the working tree of the file here,
1546
# ignoring the conflict suffixes
1548
if wt.supports_content_filtering():
1550
filter_tree_path = wt.id2path(file_id)
1551
except errors.NoSuchId:
1552
# file has been deleted
1553
filter_tree_path = None
1555
# Skip the id2path lookup for older formats
1556
filter_tree_path = None
1558
923
versioned = False
1560
925
for suffix, tree, lines in data:
1561
if tree.has_id(file_id):
1562
927
trans_id = self._conflict_file(name, parent_id, tree, file_id,
1563
suffix, lines, filter_tree_path)
1564
929
file_group.append(trans_id)
1565
930
if set_version and not versioned:
1566
931
self.tt.version_file(file_id, trans_id)
1567
932
versioned = True
1568
933
return file_group
1570
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
1571
lines=None, filter_tree_path=None):
935
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
1572
937
"""Emit a single conflict file."""
1573
938
name = name + '.' + suffix
1574
939
trans_id = self.tt.create_path(name, parent_id)
1575
transform.create_from_tree(self.tt, trans_id, tree, file_id, lines,
940
entry = tree.inventory[file_id]
941
create_by_entry(self.tt, entry, tree, trans_id, lines)
1579
944
def merge_executable(self, file_id, file_status):
1580
945
"""Perform a merge on the execute bit."""
1581
946
executable = [self.executable(t, file_id) for t in (self.base_tree,
1582
947
self.other_tree, self.this_tree)]
1583
self._merge_executable(file_id, executable, file_status,
1584
resolver=self._three_way)
948
self._merge_executable(file_id, executable, file_status)
1586
def _merge_executable(self, file_id, executable, file_status,
950
def _merge_executable(self, file_id, executable, file_status):
1588
951
"""Perform a merge on the execute bit."""
1589
952
base_executable, other_executable, this_executable = executable
1590
953
if file_status == "deleted":
1592
winner = resolver(*executable)
955
winner = self._three_way(*executable)
1593
956
if winner == "conflict":
1594
957
# There must be a None in here, if we have a conflict, but we
1595
958
# need executability since file status was not deleted.
1618
984
def cook_conflicts(self, fs_conflicts):
1619
985
"""Convert all conflicts into a form that doesn't depend on trans_id"""
1620
content_conflict_file_ids = set()
1621
cooked_conflicts = transform.cook_conflicts(fs_conflicts, self.tt)
1622
fp = transform.FinalPaths(self.tt)
986
from conflicts import Conflict
988
self.cooked_conflicts.extend(cook_conflicts(fs_conflicts, self.tt))
989
fp = FinalPaths(self.tt)
1623
990
for conflict in self._raw_conflicts:
1624
991
conflict_type = conflict[0]
1625
if conflict_type == 'path conflict':
1627
this_parent, this_name,
1628
other_parent, other_name) = conflict[1:]
1629
if this_parent is None or this_name is None:
1630
this_path = '<deleted>'
1632
parent_path = fp.get_path(
1633
self.tt.trans_id_file_id(this_parent))
1634
this_path = osutils.pathjoin(parent_path, this_name)
1635
if other_parent is None or other_name is None:
1636
other_path = '<deleted>'
1638
if other_parent == self.other_tree.get_root_id():
1639
# The tree transform doesn't know about the other root,
1640
# so we special case here to avoid a NoFinalPath
1644
parent_path = fp.get_path(
1645
self.tt.trans_id_file_id(other_parent))
1646
other_path = osutils.pathjoin(parent_path, other_name)
1647
c = _mod_conflicts.Conflict.factory(
1648
'path conflict', path=this_path,
1649
conflict_path=other_path,
1651
elif conflict_type == 'contents conflict':
992
if conflict_type in ('name conflict', 'parent conflict'):
993
trans_id = conflict[1]
994
conflict_args = conflict[2:]
995
if trans_id not in name_conflicts:
996
name_conflicts[trans_id] = {}
997
unique_add(name_conflicts[trans_id], conflict_type,
999
if conflict_type == 'contents conflict':
1652
1000
for trans_id in conflict[1]:
1653
1001
file_id = self.tt.final_file_id(trans_id)
1654
1002
if file_id is not None:
1658
1006
if path.endswith(suffix):
1659
1007
path = path[:-len(suffix)]
1661
c = _mod_conflicts.Conflict.factory(conflict_type,
1662
path=path, file_id=file_id)
1663
content_conflict_file_ids.add(file_id)
1664
elif conflict_type == 'text conflict':
1009
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
1010
self.cooked_conflicts.append(c)
1011
if conflict_type == 'text conflict':
1665
1012
trans_id = conflict[1]
1666
1013
path = fp.get_path(trans_id)
1667
1014
file_id = self.tt.final_file_id(trans_id)
1668
c = _mod_conflicts.Conflict.factory(conflict_type,
1669
path=path, file_id=file_id)
1015
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
1016
self.cooked_conflicts.append(c)
1018
for trans_id, conflicts in name_conflicts.iteritems():
1020
this_parent, other_parent = conflicts['parent conflict']
1021
if this_parent == other_parent:
1022
raise AssertionError()
1024
this_parent = other_parent = \
1025
self.tt.final_file_id(self.tt.final_parent(trans_id))
1027
this_name, other_name = conflicts['name conflict']
1028
if this_name == other_name:
1029
raise AssertionError()
1031
this_name = other_name = self.tt.final_name(trans_id)
1032
other_path = fp.get_path(trans_id)
1033
if this_parent is not None and this_name is not None:
1034
this_parent_path = \
1035
fp.get_path(self.tt.trans_id_file_id(this_parent))
1036
this_path = pathjoin(this_parent_path, this_name)
1671
raise AssertionError('bad conflict type: %r' % (conflict,))
1672
cooked_conflicts.append(c)
1674
self.cooked_conflicts = []
1675
# We want to get rid of path conflicts when a corresponding contents
1676
# conflict exists. This can occur when one branch deletes a file while
1677
# the other renames *and* modifies it. In this case, the content
1678
# conflict is enough.
1679
for c in cooked_conflicts:
1680
if (c.typestring == 'path conflict'
1681
and c.file_id in content_conflict_file_ids):
1038
this_path = "<deleted>"
1039
file_id = self.tt.final_file_id(trans_id)
1040
c = Conflict.factory('path conflict', path=this_path,
1041
conflict_path=other_path, file_id=file_id)
1683
1042
self.cooked_conflicts.append(c)
1684
self.cooked_conflicts.sort(key=_mod_conflicts.Conflict.sort_key)
1043
self.cooked_conflicts.sort(key=Conflict.sort_key)
1687
1046
class WeaveMerger(Merge3Merger):
1691
1050
supports_reverse_cherrypick = False
1692
1051
history_based = True
1694
def _generate_merge_plan(self, file_id, base):
1695
return self.this_tree.plan_file_merge(file_id, self.other_tree,
1053
def _merged_lines(self, file_id):
1054
"""Generate the merged lines.
1055
There is no distinction between lines that are meant to contain <<<<<<<
1059
base = self.base_tree
1062
plan = self.this_tree.plan_file_merge(file_id, self.other_tree,
1698
def _merged_lines(self, file_id):
1699
"""Generate the merged lines.
1700
There is no distinction between lines that are meant to contain <<<<<<<
1704
base = self.base_tree
1707
plan = self._generate_merge_plan(file_id, base)
1708
1064
if 'merge' in debug.debug_flags:
1709
1065
plan = list(plan)
1710
1066
trans_id = self.tt.trans_id_file_id(file_id)
1711
1067
name = self.tt.final_name(trans_id) + '.plan'
1712
contents = ('%11s|%s' % l for l in plan)
1068
contents = ('%10s|%s' % l for l in plan)
1713
1069
self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
1714
textmerge = versionedfile.PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1715
'>>>>>>> MERGE-SOURCE\n')
1716
lines, conflicts = textmerge.merge_lines(self.reprocess)
1718
base_lines = textmerge.base_from_plan()
1721
return lines, base_lines
1070
textmerge = PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1071
'>>>>>>> MERGE-SOURCE\n')
1072
return textmerge.merge_lines(self.reprocess)
1723
1074
def text_merge(self, file_id, trans_id):
1724
1075
"""Perform a (weave) text merge for a given file and file-id.
1725
1076
If conflicts are encountered, .THIS and .OTHER files will be emitted,
1726
1077
and a conflict will be noted.
1728
lines, base_lines = self._merged_lines(file_id)
1079
lines, conflicts = self._merged_lines(file_id)
1729
1080
lines = list(lines)
1730
# Note we're checking whether the OUTPUT is binary in this case,
1081
# Note we're checking whether the OUTPUT is binary in this case,
1731
1082
# because we don't want to get into weave merge guts.
1732
textfile.check_text_lines(lines)
1083
check_text_lines(lines)
1733
1084
self.tt.create_file(lines, trans_id)
1734
if base_lines is not None:
1736
1086
self._raw_conflicts.append(('text conflict', trans_id))
1737
1087
name = self.tt.final_name(trans_id)
1738
1088
parent_id = self.tt.final_parent(trans_id)
1739
file_group = self._dump_conflicts(name, parent_id, file_id,
1741
base_lines=base_lines)
1089
file_group = self._dump_conflicts(name, parent_id, file_id,
1742
1091
file_group.append(trans_id)
1745
1094
class LCAMerger(WeaveMerger):
1747
def _generate_merge_plan(self, file_id, base):
1748
return self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
1096
def _merged_lines(self, file_id):
1097
"""Generate the merged lines.
1098
There is no distinction between lines that are meant to contain <<<<<<<
1102
base = self.base_tree
1105
plan = self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
1107
if 'merge' in debug.debug_flags:
1109
trans_id = self.tt.trans_id_file_id(file_id)
1110
name = self.tt.final_name(trans_id) + '.plan'
1111
contents = ('%10s|%s' % l for l in plan)
1112
self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
1113
textmerge = PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1114
'>>>>>>> MERGE-SOURCE\n')
1115
return textmerge.merge_lines(self.reprocess)
1751
1118
class Diff3Merger(Merge3Merger):
1752
1119
"""Three-way merger using external diff3 for text merging"""
1754
1121
def dump_file(self, temp_dir, name, tree, file_id):
1755
out_path = osutils.pathjoin(temp_dir, name)
1122
out_path = pathjoin(temp_dir, name)
1756
1123
out_file = open(out_path, "wb")
1758
1125
in_file = tree.get_file(file_id)
1791
1158
osutils.rmtree(temp_dir)
1794
class PathNotInTree(errors.BzrError):
1796
_fmt = """Merge-into failed because %(tree)s does not contain %(path)s."""
1798
def __init__(self, path, tree):
1799
errors.BzrError.__init__(self, path=path, tree=tree)
1802
class MergeIntoMerger(Merger):
1803
"""Merger that understands other_tree will be merged into a subdir.
1805
This also changes the Merger api so that it uses real Branch, revision_id,
1806
and RevisonTree objects, rather than using revision specs.
1809
def __init__(self, this_tree, other_branch, other_tree, target_subdir,
1810
source_subpath, other_rev_id=None):
1811
"""Create a new MergeIntoMerger object.
1813
source_subpath in other_tree will be effectively copied to
1814
target_subdir in this_tree.
1816
:param this_tree: The tree that we will be merging into.
1817
:param other_branch: The Branch we will be merging from.
1818
:param other_tree: The RevisionTree object we want to merge.
1819
:param target_subdir: The relative path where we want to merge
1820
other_tree into this_tree
1821
:param source_subpath: The relative path specifying the subtree of
1822
other_tree to merge into this_tree.
1824
# It is assumed that we are merging a tree that is not in our current
1825
# ancestry, which means we are using the "EmptyTree" as our basis.
1826
null_ancestor_tree = this_tree.branch.repository.revision_tree(
1827
_mod_revision.NULL_REVISION)
1828
super(MergeIntoMerger, self).__init__(
1829
this_branch=this_tree.branch,
1830
this_tree=this_tree,
1831
other_tree=other_tree,
1832
base_tree=null_ancestor_tree,
1834
self._target_subdir = target_subdir
1835
self._source_subpath = source_subpath
1836
self.other_branch = other_branch
1837
if other_rev_id is None:
1838
other_rev_id = other_tree.get_revision_id()
1839
self.other_rev_id = self.other_basis = other_rev_id
1840
self.base_is_ancestor = True
1841
self.backup_files = True
1842
self.merge_type = Merge3Merger
1843
self.show_base = False
1844
self.reprocess = False
1845
self.interesting_ids = None
1846
self.merge_type = _MergeTypeParameterizer(MergeIntoMergeType,
1847
target_subdir=self._target_subdir,
1848
source_subpath=self._source_subpath)
1849
if self._source_subpath != '':
1850
# If this isn't a partial merge make sure the revisions will be
1852
self._maybe_fetch(self.other_branch, self.this_branch,
1855
def set_pending(self):
1856
if self._source_subpath != '':
1858
Merger.set_pending(self)
1861
class _MergeTypeParameterizer(object):
1862
"""Wrap a merge-type class to provide extra parameters.
1864
This is hack used by MergeIntoMerger to pass some extra parameters to its
1865
merge_type. Merger.do_merge() sets up its own set of parameters to pass to
1866
the 'merge_type' member. It is difficult override do_merge without
1867
re-writing the whole thing, so instead we create a wrapper which will pass
1868
the extra parameters.
1871
def __init__(self, merge_type, **kwargs):
1872
self._extra_kwargs = kwargs
1873
self._merge_type = merge_type
1875
def __call__(self, *args, **kwargs):
1876
kwargs.update(self._extra_kwargs)
1877
return self._merge_type(*args, **kwargs)
1879
def __getattr__(self, name):
1880
return getattr(self._merge_type, name)
1883
class MergeIntoMergeType(Merge3Merger):
1884
"""Merger that incorporates a tree (or part of a tree) into another."""
1886
def __init__(self, *args, **kwargs):
1887
"""Initialize the merger object.
1889
:param args: See Merge3Merger.__init__'s args.
1890
:param kwargs: See Merge3Merger.__init__'s keyword args, except for
1891
source_subpath and target_subdir.
1892
:keyword source_subpath: The relative path specifying the subtree of
1893
other_tree to merge into this_tree.
1894
:keyword target_subdir: The relative path where we want to merge
1895
other_tree into this_tree
1897
# All of the interesting work happens during Merge3Merger.__init__(),
1898
# so we have have to hack in to get our extra parameters set.
1899
self._source_subpath = kwargs.pop('source_subpath')
1900
self._target_subdir = kwargs.pop('target_subdir')
1901
super(MergeIntoMergeType, self).__init__(*args, **kwargs)
1903
def _compute_transform(self):
1904
child_pb = ui.ui_factory.nested_progress_bar()
1906
entries = self._entries_to_incorporate()
1907
entries = list(entries)
1908
for num, (entry, parent_id) in enumerate(entries):
1909
child_pb.update('Preparing file merge', num, len(entries))
1910
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1911
trans_id = transform.new_by_entry(self.tt, entry,
1912
parent_trans_id, self.other_tree)
1915
self._finish_computing_transform()
1917
def _entries_to_incorporate(self):
1918
"""Yields pairs of (inventory_entry, new_parent)."""
1919
other_inv = self.other_tree.inventory
1920
subdir_id = other_inv.path2id(self._source_subpath)
1921
if subdir_id is None:
1922
# XXX: The error would be clearer if it gave the URL of the source
1923
# branch, but we don't have a reference to that here.
1924
raise PathNotInTree(self._source_subpath, "Source tree")
1925
subdir = other_inv[subdir_id]
1926
parent_in_target = osutils.dirname(self._target_subdir)
1927
target_id = self.this_tree.inventory.path2id(parent_in_target)
1928
if target_id is None:
1929
raise PathNotInTree(self._target_subdir, "Target tree")
1930
name_in_target = osutils.basename(self._target_subdir)
1931
merge_into_root = subdir.copy()
1932
merge_into_root.name = name_in_target
1933
if self.this_tree.inventory.has_id(merge_into_root.file_id):
1934
# Give the root a new file-id.
1935
# This can happen fairly easily if the directory we are
1936
# incorporating is the root, and both trees have 'TREE_ROOT' as
1937
# their root_id. Users will expect this to Just Work, so we
1938
# change the file-id here.
1939
# Non-root file-ids could potentially conflict too. That's really
1940
# an edge case, so we don't do anything special for those. We let
1941
# them cause conflicts.
1942
merge_into_root.file_id = generate_ids.gen_file_id(name_in_target)
1943
yield (merge_into_root, target_id)
1944
if subdir.kind != 'directory':
1945
# No children, so we are done.
1947
for ignored_path, entry in other_inv.iter_entries_by_dir(subdir_id):
1948
parent_id = entry.parent_id
1949
if parent_id == subdir.file_id:
1950
# The root's parent ID has changed, so make sure children of
1951
# the root refer to the new ID.
1952
parent_id = merge_into_root.file_id
1953
yield (entry, parent_id)
1956
1161
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1957
1162
backup_files=False,
1958
1163
merge_type=Merge3Merger,
added
removed
bzrlib/merge.py
