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,
23
conflicts as _mod_conflicts,
26
26
graph as _mod_graph,
30
30
revision as _mod_revision,
40
from bzrlib.cleanup import OperationWithCleanups
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 = 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)
66
self.create_hook(hooks.HookPoint('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
464
244
if self.this_rev_id is None:
465
245
if self.this_basis_tree.get_file_sha1(file_id) != \
466
246
self.this_tree.get_file_sha1(file_id):
467
raise errors.WorkingTreeNotRevision(self.this_tree)
247
raise WorkingTreeNotRevision(self.this_tree)
469
249
trees = (self.this_basis_tree, self.other_tree)
470
250
return [get_id(tree, file_id) for tree in trees]
472
@deprecated_method(deprecated_in((2, 1, 0)))
473
252
def check_basis(self, check_clean, require_commits=True):
474
253
if self.this_basis is None and require_commits is True:
475
raise errors.BzrCommandError(
476
"This branch has no commits."
477
" (perhaps you would prefer 'bzr pull')")
254
raise BzrCommandError("This branch has no commits."
255
" (perhaps you would prefer 'bzr pull')")
479
257
self.compare_basis()
480
258
if self.this_basis != self.this_rev_id:
481
259
raise errors.UncommittedChanges(self.this_tree)
483
@deprecated_method(deprecated_in((2, 1, 0)))
484
261
def compare_basis(self):
486
263
basis_tree = self.revision_tree(self.this_tree.last_revision())
487
264
except errors.NoSuchRevision:
488
265
basis_tree = self.this_tree.basis_tree()
489
if not self.this_tree.has_changes(basis_tree):
266
changes = self.this_tree.changes_from(basis_tree)
267
if not changes.has_changed():
490
268
self.this_rev_id = self.this_basis
492
270
def set_interesting_files(self, file_list):
493
271
self.interesting_files = file_list
495
273
def set_pending(self):
496
if (not self.base_is_ancestor or not self.base_is_other_ancestor
497
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:
499
276
self._add_parent()
501
278
def _add_parent(self):
502
279
new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
503
280
new_parent_trees = []
504
operation = OperationWithCleanups(self.this_tree.set_parent_trees)
505
281
for revision_id in new_parents:
507
283
tree = self.revision_tree(revision_id)
568
349
target.fetch(source, revision_id)
570
351
def find_base(self):
571
revisions = [_mod_revision.ensure_null(self.this_basis),
572
_mod_revision.ensure_null(self.other_basis)]
573
if _mod_revision.NULL_REVISION in revisions:
574
self.base_rev_id = _mod_revision.NULL_REVISION
575
self.base_tree = self.revision_tree(self.base_rev_id)
576
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
578
lcas = self.revision_graph.find_lca(revisions[0], revisions[1])
579
self._is_criss_cross = False
581
self.base_rev_id = _mod_revision.NULL_REVISION
583
self.base_rev_id = list(lcas)[0]
584
else: # len(lcas) > 1
586
# find_unique_lca can only handle 2 nodes, so we have to
587
# start back at the beginning. It is a shame to traverse
588
# the graph again, but better than re-implementing
590
self.base_rev_id = self.revision_graph.find_unique_lca(
591
revisions[0], revisions[1])
593
self.base_rev_id = self.revision_graph.find_unique_lca(
595
self._is_criss_cross = True
596
if self.base_rev_id == _mod_revision.NULL_REVISION:
597
raise errors.UnrelatedBranches()
598
if self._is_criss_cross:
599
trace.warning('Warning: criss-cross merge encountered. See bzr'
600
' help criss-cross.')
601
trace.mutter('Criss-cross lcas: %r' % lcas)
602
interesting_revision_ids = [self.base_rev_id]
603
interesting_revision_ids.extend(lcas)
604
interesting_trees = dict((t.get_revision_id(), t)
605
for t in self.this_branch.repository.revision_trees(
606
interesting_revision_ids))
607
self._cached_trees.update(interesting_trees)
608
self.base_tree = interesting_trees.pop(self.base_rev_id)
609
sorted_lca_keys = self.revision_graph.find_merge_order(
611
self._lca_trees = [interesting_trees[key]
612
for key in sorted_lca_keys]
614
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)
615
365
self.base_is_ancestor = True
616
366
self.base_is_other_ancestor = True
617
trace.mutter('Base revid: %r' % self.base_rev_id)
619
368
def set_base(self, base_revision):
620
369
"""Set the base revision to use for the merge.
622
371
:param base_revision: A 2-list containing a path and revision number.
624
trace.mutter("doing merge() with no base_revision specified")
373
mutter("doing merge() with no base_revision specified")
625
374
if base_revision == [None, None]:
640
389
'other_tree': self.other_tree,
641
390
'interesting_ids': self.interesting_ids,
642
391
'interesting_files': self.interesting_files,
643
'this_branch': self.this_branch,
644
393
'do_merge': False}
645
394
if self.merge_type.requires_base:
646
395
kwargs['base_tree'] = self.base_tree
647
396
if self.merge_type.supports_reprocess:
648
397
kwargs['reprocess'] = self.reprocess
649
398
elif self.reprocess:
650
raise errors.BzrError(
651
"Conflict reduction is not supported for merge"
652
" type %s." % self.merge_type)
399
raise BzrError("Conflict reduction is not supported for merge"
400
" type %s." % self.merge_type)
653
401
if self.merge_type.supports_show_base:
654
402
kwargs['show_base'] = self.show_base
655
403
elif self.show_base:
656
raise errors.BzrError("Showing base is not supported for this"
657
" merge type. %s" % self.merge_type)
404
raise BzrError("Showing base is not supported for this"
405
" merge type. %s" % self.merge_type)
658
406
if (not getattr(self.merge_type, 'supports_reverse_cherrypick', True)
659
407
and not self.base_is_other_ancestor):
660
408
raise errors.CannotReverseCherrypick()
661
409
if self.merge_type.supports_cherrypick:
662
410
kwargs['cherrypick'] = (not self.base_is_ancestor or
663
411
not self.base_is_other_ancestor)
664
if self._is_criss_cross and getattr(self.merge_type,
665
'supports_lca_trees', False):
666
kwargs['lca_trees'] = self._lca_trees
667
return self.merge_type(pb=None,
412
return self.merge_type(pb=self._pb,
668
413
change_reporter=self.change_reporter,
671
def _do_merge_to(self):
672
merge = self.make_merger()
673
if self.other_branch is not None:
674
self.other_branch.update_references(self.this_branch)
676
if self.recurse == 'down':
677
for relpath, file_id in self.this_tree.iter_references():
678
sub_tree = self.this_tree.get_nested_tree(file_id, relpath)
679
other_revision = self.other_tree.get_reference_revision(
681
if other_revision == sub_tree.last_revision():
683
sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
684
sub_merge.merge_type = self.merge_type
685
other_branch = self.other_branch.reference_parent(file_id, relpath)
686
sub_merge.set_other_revision(other_revision, other_branch)
687
base_revision = self.base_tree.get_reference_revision(file_id)
688
sub_merge.base_tree = \
689
sub_tree.branch.repository.revision_tree(base_revision)
690
sub_merge.base_rev_id = base_revision
694
416
def do_merge(self):
695
operation = OperationWithCleanups(self._do_merge_to)
696
417
self.this_tree.lock_tree_write()
697
operation.add_cleanup(self.this_tree.unlock)
698
418
if self.base_tree is not None:
699
419
self.base_tree.lock_read()
700
operation.add_cleanup(self.base_tree.unlock)
701
420
if self.other_tree is not None:
702
421
self.other_tree.lock_read()
703
operation.add_cleanup(self.other_tree.unlock)
704
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()
705
448
if len(merge.cooked_conflicts) == 0:
706
if not self.ignore_zero and not trace.is_quiet():
707
trace.note("All changes applied successfully.")
449
if not self.ignore_zero and not is_quiet():
450
note("All changes applied successfully.")
709
trace.note("%d conflicts encountered."
710
% len(merge.cooked_conflicts))
452
note("%d conflicts encountered." % len(merge.cooked_conflicts))
712
454
return len(merge.cooked_conflicts)
715
class _InventoryNoneEntry(object):
716
"""This represents an inventory entry which *isn't there*.
718
It simplifies the merging logic if we always have an InventoryEntry, even
719
if it isn't actually present
726
symlink_target = None
729
_none_entry = _InventoryNoneEntry()
732
457
class Merge3Merger(object):
733
458
"""Three-way merger that uses the merge3 text merger"""
734
459
requires_base = True
738
463
supports_cherrypick = True
739
464
supports_reverse_cherrypick = True
740
465
winner_idx = {"this": 2, "other": 1, "conflict": 1}
741
supports_lca_trees = True
743
def __init__(self, working_tree, this_tree, base_tree, other_tree,
467
def __init__(self, working_tree, this_tree, base_tree, other_tree,
744
468
interesting_ids=None, reprocess=False, show_base=False,
745
pb=None, pp=None, change_reporter=None,
469
pb=DummyProgress(), pp=None, change_reporter=None,
746
470
interesting_files=None, do_merge=True,
747
cherrypick=False, lca_trees=None, this_branch=None):
748
472
"""Initialize the merger object and perform the merge.
750
474
:param working_tree: The working tree to apply the merge to
751
475
:param this_tree: The local tree in the merge operation
752
476
:param base_tree: The common tree in the merge operation
753
:param other_tree: The other tree to merge changes from
754
:param this_branch: The branch associated with this_tree. Defaults to
755
this_tree.branch if not supplied.
477
:param other_tree: The other other tree to merge changes from
756
478
:param interesting_ids: The file_ids of files that should be
757
479
participate in the merge. May not be combined with
758
480
interesting_files.
759
481
:param: reprocess If True, perform conflict-reduction processing.
760
482
:param show_base: If True, show the base revision in text conflicts.
761
483
(incompatible with reprocess)
484
:param pb: A Progress bar
763
485
:param pp: A ProgressPhase object
764
486
:param change_reporter: An object that should report changes made
765
487
:param interesting_files: The tree-relative paths of files that should
768
490
be combined with interesting_ids. If neither interesting_files nor
769
491
interesting_ids is specified, all files may participate in the
771
:param lca_trees: Can be set to a dictionary of {revision_id:rev_tree}
772
if the ancestry was found to include a criss-cross merge.
773
Otherwise should be None.
775
494
object.__init__(self)
776
495
if interesting_files is not None and interesting_ids is not None:
777
496
raise ValueError(
778
497
'specify either interesting_ids or interesting_files')
779
if this_branch is None:
780
this_branch = this_tree.branch
781
498
self.interesting_ids = interesting_ids
782
499
self.interesting_files = interesting_files
783
500
self.this_tree = working_tree
784
501
self.base_tree = base_tree
785
502
self.other_tree = other_tree
786
self.this_branch = this_branch
787
503
self._raw_conflicts = []
788
504
self.cooked_conflicts = []
789
505
self.reprocess = reprocess
790
506
self.show_base = show_base
791
self._lca_trees = lca_trees
792
# Uncommenting this will change the default algorithm to always use
793
# _entries_lca. This can be useful for running the test suite and
794
# making sure we haven't missed any corner cases.
795
# if lca_trees is None:
796
# self._lca_trees = [self.base_tree]
797
509
self.change_reporter = change_reporter
798
510
self.cherrypick = cherrypick
512
self.pp = ProgressPhase("Merge phase", 3, self.pb)
802
warnings.warn("pp argument to Merge3Merger is deprecated")
804
warnings.warn("pb argument to Merge3Merger is deprecated")
806
516
def do_merge(self):
807
operation = OperationWithCleanups(self._do_merge)
808
517
self.this_tree.lock_tree_write()
809
operation.add_cleanup(self.this_tree.unlock)
810
518
self.base_tree.lock_read()
811
operation.add_cleanup(self.base_tree.unlock)
812
519
self.other_tree.lock_read()
813
operation.add_cleanup(self.other_tree.unlock)
816
def _do_merge(self, operation):
817
self.tt = transform.TreeTransform(self.this_tree, None)
818
operation.add_cleanup(self.tt.finalize)
819
self._compute_transform()
820
results = self.tt.apply(no_conflicts=True)
821
self.write_modified(results)
520
self.tt = TreeTransform(self.this_tree, self.pb)
823
self.this_tree.add_conflicts(self.cooked_conflicts)
824
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()
827
538
def make_preview_transform(self):
828
operation = OperationWithCleanups(self._make_preview_transform)
829
539
self.base_tree.lock_read()
830
operation.add_cleanup(self.base_tree.unlock)
831
540
self.other_tree.lock_read()
832
operation.add_cleanup(self.other_tree.unlock)
833
return operation.run_simple()
835
def _make_preview_transform(self):
836
self.tt = transform.TransformPreview(self.this_tree)
837
self._compute_transform()
541
self.tt = TransformPreview(self.this_tree)
544
self._compute_transform()
547
self.other_tree.unlock()
548
self.base_tree.unlock()
840
552
def _compute_transform(self):
841
if self._lca_trees is None:
842
entries = self._entries3()
843
resolver = self._three_way
845
entries = self._entries_lca()
846
resolver = self._lca_multi_way
553
entries = self._entries3()
847
554
child_pb = ui.ui_factory.nested_progress_bar()
849
factories = Merger.hooks['merge_file_content']
850
hooks = [factory(self) for factory in factories] + [self]
851
self.active_hooks = [hook for hook in hooks if hook is not None]
852
556
for num, (file_id, changed, parents3, names3,
853
557
executable3) in enumerate(entries):
854
558
child_pb.update('Preparing file merge', num, len(entries))
855
self._merge_names(file_id, parents3, names3, resolver=resolver)
559
self._merge_names(file_id, parents3, names3)
857
file_status = self._do_merge_contents(file_id)
561
file_status = self.merge_contents(file_id)
859
563
file_status = 'unmodified'
860
564
self._merge_executable(file_id,
861
executable3, file_status, resolver=resolver)
565
executable3, file_status)
863
567
child_pb.finished()
865
self._finish_computing_transform()
867
def _finish_computing_transform(self):
868
"""Finalize the transform and report the changes.
870
This is the second half of _compute_transform.
872
570
child_pb = ui.ui_factory.nested_progress_bar()
874
fs_conflicts = transform.resolve_conflicts(self.tt, child_pb,
875
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))
877
575
child_pb.finished()
878
576
if self.change_reporter is not None:
919
614
result.append((file_id, changed, parents3, names3, executable3))
922
def _entries_lca(self):
923
"""Gather data about files modified between multiple trees.
925
This compares OTHER versus all LCA trees, and for interesting entries,
926
it then compares with THIS and BASE.
928
For the multi-valued entries, the format will be (BASE, [lca1, lca2])
929
:return: [(file_id, changed, parents, names, executable)]
930
file_id Simple file_id of the entry
931
changed Boolean, True if the kind or contents changed
933
parents ((base, [parent_id, in, lcas]), parent_id_other,
935
names ((base, [name, in, lcas]), name_in_other, name_in_this)
936
executable ((base, [exec, in, lcas]), exec_in_other, exec_in_this)
938
if self.interesting_files is not None:
939
lookup_trees = [self.this_tree, self.base_tree]
940
lookup_trees.extend(self._lca_trees)
941
# I think we should include the lca trees as well
942
interesting_ids = self.other_tree.paths2ids(self.interesting_files,
945
interesting_ids = self.interesting_ids
947
walker = _mod_tree.MultiWalker(self.other_tree, self._lca_trees)
949
base_inventory = self.base_tree.inventory
950
this_inventory = self.this_tree.inventory
951
for path, file_id, other_ie, lca_values in walker.iter_all():
952
# Is this modified at all from any of the other trees?
954
other_ie = _none_entry
955
if interesting_ids is not None and file_id not in interesting_ids:
958
# If other_revision is found in any of the lcas, that means this
959
# node is uninteresting. This is because when merging, if there are
960
# multiple heads(), we have to create a new node. So if we didn't,
961
# we know that the ancestry is linear, and that OTHER did not
963
# See doc/developers/lca_merge_resolution.txt for details
964
other_revision = other_ie.revision
965
if other_revision is not None:
966
# We can't use this shortcut when other_revision is None,
967
# because it may be None because things are WorkingTrees, and
968
# not because it is *actually* None.
969
is_unmodified = False
970
for lca_path, ie in lca_values:
971
if ie is not None and ie.revision == other_revision:
978
for lca_path, lca_ie in lca_values:
980
lca_entries.append(_none_entry)
982
lca_entries.append(lca_ie)
984
if file_id in base_inventory:
985
base_ie = base_inventory[file_id]
987
base_ie = _none_entry
989
if file_id in this_inventory:
990
this_ie = this_inventory[file_id]
992
this_ie = _none_entry
998
for lca_ie in lca_entries:
999
lca_kinds.append(lca_ie.kind)
1000
lca_parent_ids.append(lca_ie.parent_id)
1001
lca_names.append(lca_ie.name)
1002
lca_executable.append(lca_ie.executable)
1004
kind_winner = self._lca_multi_way(
1005
(base_ie.kind, lca_kinds),
1006
other_ie.kind, this_ie.kind)
1007
parent_id_winner = self._lca_multi_way(
1008
(base_ie.parent_id, lca_parent_ids),
1009
other_ie.parent_id, this_ie.parent_id)
1010
name_winner = self._lca_multi_way(
1011
(base_ie.name, lca_names),
1012
other_ie.name, this_ie.name)
1014
content_changed = True
1015
if kind_winner == 'this':
1016
# No kind change in OTHER, see if there are *any* changes
1017
if other_ie.kind == 'directory':
1018
if parent_id_winner == 'this' and name_winner == 'this':
1019
# No change for this directory in OTHER, skip
1021
content_changed = False
1022
elif other_ie.kind is None or other_ie.kind == 'file':
1023
def get_sha1(ie, tree):
1024
if ie.kind != 'file':
1026
return tree.get_file_sha1(file_id)
1027
base_sha1 = get_sha1(base_ie, self.base_tree)
1028
lca_sha1s = [get_sha1(ie, tree) for ie, tree
1029
in zip(lca_entries, self._lca_trees)]
1030
this_sha1 = get_sha1(this_ie, self.this_tree)
1031
other_sha1 = get_sha1(other_ie, self.other_tree)
1032
sha1_winner = self._lca_multi_way(
1033
(base_sha1, lca_sha1s), other_sha1, this_sha1,
1034
allow_overriding_lca=False)
1035
exec_winner = self._lca_multi_way(
1036
(base_ie.executable, lca_executable),
1037
other_ie.executable, this_ie.executable)
1038
if (parent_id_winner == 'this' and name_winner == 'this'
1039
and sha1_winner == 'this' and exec_winner == 'this'):
1040
# No kind, parent, name, exec, or content change for
1041
# OTHER, so this node is not considered interesting
1043
if sha1_winner == 'this':
1044
content_changed = False
1045
elif other_ie.kind == 'symlink':
1046
def get_target(ie, tree):
1047
if ie.kind != 'symlink':
1049
return tree.get_symlink_target(file_id)
1050
base_target = get_target(base_ie, self.base_tree)
1051
lca_targets = [get_target(ie, tree) for ie, tree
1052
in zip(lca_entries, self._lca_trees)]
1053
this_target = get_target(this_ie, self.this_tree)
1054
other_target = get_target(other_ie, self.other_tree)
1055
target_winner = self._lca_multi_way(
1056
(base_target, lca_targets),
1057
other_target, this_target)
1058
if (parent_id_winner == 'this' and name_winner == 'this'
1059
and target_winner == 'this'):
1060
# No kind, parent, name, or symlink target change
1063
if target_winner == 'this':
1064
content_changed = False
1065
elif other_ie.kind == 'tree-reference':
1066
# The 'changed' information seems to be handled at a higher
1067
# level. At least, _entries3 returns False for content
1068
# changed, even when at a new revision_id.
1069
content_changed = False
1070
if (parent_id_winner == 'this' and name_winner == 'this'):
1071
# Nothing interesting
1074
raise AssertionError('unhandled kind: %s' % other_ie.kind)
1076
# If we have gotten this far, that means something has changed
1077
result.append((file_id, content_changed,
1078
((base_ie.parent_id, lca_parent_ids),
1079
other_ie.parent_id, this_ie.parent_id),
1080
((base_ie.name, lca_names),
1081
other_ie.name, this_ie.name),
1082
((base_ie.executable, lca_executable),
1083
other_ie.executable, this_ie.executable)
1087
617
def fix_root(self):
1089
619
self.tt.final_kind(self.tt.root)
1090
except errors.NoSuchFile:
1091
621
self.tt.cancel_deletion(self.tt.root)
1092
622
if self.tt.final_file_id(self.tt.root) is None:
1093
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:
1095
627
other_root_file_id = self.other_tree.get_root_id()
1096
if other_root_file_id is None:
1098
628
other_root = self.tt.trans_id_file_id(other_root_file_id)
1099
629
if other_root == self.tt.root:
1101
if self.other_tree.inventory.root.file_id in self.this_tree.inventory:
1102
# the other tree's root is a non-root in the current tree (as when
1103
# a previously unrelated branch is merged into another)
1106
632
self.tt.final_kind(other_root)
1107
other_root_is_present = True
1108
except errors.NoSuchFile:
1109
# other_root doesn't have a physical representation. We still need
1110
# to move any references to the actual root of the tree.
1111
other_root_is_present = False
1112
# 'other_tree.inventory.root' is not present in this tree. We are
1113
# calling adjust_path for children which *want* to be present with a
1114
# correct place to go.
1115
for thing, 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():
1116
641
trans_id = self.tt.trans_id_file_id(child.file_id)
1117
if not other_root_is_present:
1118
# FIXME: Make final_kind returns None instead of raising
1119
# NoSuchFile to avoid the ugly construct below -- vila 20100402
1121
self.tt.final_kind(trans_id)
1122
# The item exist in the final tree and has a defined place
1125
except errors.NoSuchFile, e:
1127
# Move the item into the root
1128
self.tt.adjust_path(self.tt.final_name(trans_id),
1129
self.tt.root, trans_id)
1130
if other_root_is_present:
1131
self.tt.cancel_creation(other_root)
1132
self.tt.cancel_versioning(other_root)
642
self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
1134
644
def write_modified(self, results):
1135
645
modified_hashes = {}
1177
687
def kind(tree, file_id):
1178
688
"""Determine the kind of a file-id (used as a key method)."""
1179
if not tree.has_id(file_id):
689
if file_id not in tree:
1181
691
return tree.kind(file_id)
1184
694
def _three_way(base, other, this):
695
#if base == other, either they all agree, or only THIS has changed.
1185
696
if base == other:
1186
# if 'base == other', either they all agree, or only 'this' has
1189
698
elif this not in (base, other):
1190
# 'this' is neither 'base' nor 'other', so both sides changed
1191
699
return 'conflict'
700
# "Ambiguous clean merge" -- both sides have made the same change.
1192
701
elif this == other:
1193
# "Ambiguous clean merge" -- both sides have made the same change.
703
# this == base: only other has changed.
1196
# this == base: only other has changed.
1200
def _lca_multi_way(bases, other, this, allow_overriding_lca=True):
1201
"""Consider LCAs when determining whether a change has occurred.
1203
If LCAS are all identical, this is the same as a _three_way comparison.
1205
:param bases: value in (BASE, [LCAS])
1206
:param other: value in OTHER
1207
:param this: value in THIS
1208
:param allow_overriding_lca: If there is more than one unique lca
1209
value, allow OTHER to override THIS if it has a new value, and
1210
THIS only has an lca value, or vice versa. This is appropriate for
1211
truly scalar values, not as much for non-scalars.
1212
:return: 'this', 'other', or 'conflict' depending on whether an entry
1215
# See doc/developers/lca_tree_merging.txt for details about this
1218
# Either Ambiguously clean, or nothing was actually changed. We
1221
base_val, lca_vals = bases
1222
# Remove 'base_val' from the lca_vals, because it is not interesting
1223
filtered_lca_vals = [lca_val for lca_val in lca_vals
1224
if lca_val != base_val]
1225
if len(filtered_lca_vals) == 0:
1226
return Merge3Merger._three_way(base_val, other, this)
1228
unique_lca_vals = set(filtered_lca_vals)
1229
if len(unique_lca_vals) == 1:
1230
return Merge3Merger._three_way(unique_lca_vals.pop(), other, this)
1232
if allow_overriding_lca:
1233
if other in unique_lca_vals:
1234
if this in unique_lca_vals:
1235
# Each side picked a different lca, conflict
1238
# This has a value which supersedes both lca values, and
1239
# other only has an lca value
1241
elif this in unique_lca_vals:
1242
# OTHER has a value which supersedes both lca values, and this
1243
# only has an lca value
1246
# At this point, the lcas disagree, and the tip disagree
1250
@deprecated_method(deprecated_in((2, 2, 0)))
1251
708
def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
1252
709
"""Do a three-way test on a scalar.
1253
710
Return "this", "other" or "conflict", depending whether a value wins.
1303
759
parent_id_winner = "other"
1304
760
if name_winner == "this" and parent_id_winner == "this":
1306
if name_winner == 'conflict' or parent_id_winner == 'conflict':
1307
# Creating helpers (.OTHER or .THIS) here cause problems down the
1308
# road if a ContentConflict needs to be created so we should not do
1310
trans_id = self.tt.trans_id_file_id(file_id)
1311
self._raw_conflicts.append(('path conflict', trans_id, file_id,
1312
this_parent, this_name,
1313
other_parent, other_name))
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))
1314
770
if other_name is None:
1315
# it doesn't matter whether the result was 'other' or
771
# it doesn't matter whether the result was 'other' or
1316
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)
1318
776
parent_id = parents[self.winner_idx[parent_id_winner]]
1319
777
if parent_id is not None:
1320
# if we get here, name_winner and parent_winner are set to safe
778
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1322
779
self.tt.adjust_path(names[self.winner_idx[name_winner]],
1323
self.tt.trans_id_file_id(parent_id),
1324
self.tt.trans_id_file_id(file_id))
780
parent_trans_id, trans_id)
1326
def _do_merge_contents(self, file_id):
1327
"""Performs a merge on file_id contents."""
782
def merge_contents(self, file_id):
783
"""Performa a merge on file_id contents."""
1328
784
def contents_pair(tree):
1329
785
if file_id not in tree:
1330
786
return (None, None)
1338
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))
1340
808
# See SPOT run. run, SPOT, run.
1341
809
# So we're not QUITE repeating ourselves; we do tricky things with
1343
811
base_pair = contents_pair(self.base_tree)
1344
812
other_pair = contents_pair(self.other_tree)
1346
this_pair = contents_pair(self.this_tree)
1347
lca_pairs = [contents_pair(tree) for tree in self._lca_trees]
1348
winner = self._lca_multi_way((base_pair, lca_pairs), other_pair,
1349
this_pair, allow_overriding_lca=False)
1351
if base_pair == other_pair:
1354
# We delayed evaluating this_pair as long as we can to avoid
1355
# unnecessary sha1 calculation
1356
this_pair = contents_pair(self.this_tree)
1357
winner = self._three_way(base_pair, other_pair, this_pair)
1358
if winner == 'this':
1359
# No interesting changes introduced by OTHER
1361
# We have a hypothetical conflict, but if we have files, then we
1362
# can try to merge the content
1363
trans_id = self.tt.trans_id_file_id(file_id)
1364
params = MergeHookParams(self, file_id, trans_id, this_pair[0],
1365
other_pair[0], winner)
1366
hooks = self.active_hooks
1367
hook_status = 'not_applicable'
1369
hook_status, lines = hook.merge_contents(params)
1370
if hook_status != 'not_applicable':
1371
# Don't try any more hooks, this one applies.
1374
if hook_status == 'not_applicable':
1375
# This is a contents conflict, because none of the available
1376
# functions could merge it.
1378
name = self.tt.final_name(trans_id)
1379
parent_id = self.tt.final_parent(trans_id)
1380
if self.this_tree.has_id(file_id):
1381
self.tt.unversion_file(trans_id)
1382
file_group = self._dump_conflicts(name, parent_id, file_id,
1384
self._raw_conflicts.append(('contents conflict', file_group))
1385
elif hook_status == 'success':
1386
self.tt.create_file(lines, trans_id)
1387
elif hook_status == 'conflicted':
1388
# XXX: perhaps the hook should be able to provide
1389
# the BASE/THIS/OTHER files?
1390
self.tt.create_file(lines, trans_id)
1391
self._raw_conflicts.append(('text conflict', trans_id))
1392
name = self.tt.final_name(trans_id)
1393
parent_id = self.tt.final_parent(trans_id)
1394
self._dump_conflicts(name, parent_id, file_id)
1395
elif hook_status == 'delete':
1396
self.tt.unversion_file(trans_id)
1398
elif hook_status == 'done':
1399
# The hook function did whatever it needs to do directly, no
1400
# further action needed here.
1403
raise AssertionError('unknown hook_status: %r' % (hook_status,))
1404
if not self.this_tree.has_id(file_id) and result == "modified":
1405
self.tt.version_file(file_id, trans_id)
1406
# The merge has been performed, so the old contents should not be
1409
self.tt.delete_contents(trans_id)
1410
except errors.NoSuchFile:
1414
def _default_other_winner_merge(self, merge_hook_params):
1415
"""Replace this contents with other."""
1416
file_id = merge_hook_params.file_id
1417
trans_id = merge_hook_params.trans_id
1418
file_in_this = self.this_tree.has_id(file_id)
1419
if self.other_tree.has_id(file_id):
1420
# OTHER changed the file
1422
if wt.supports_content_filtering():
1423
# We get the path from the working tree if it exists.
1424
# That fails though when OTHER is adding a file, so
1425
# we fall back to the other tree to find the path if
1426
# it doesn't exist locally.
1428
filter_tree_path = wt.id2path(file_id)
1429
except errors.NoSuchId:
1430
filter_tree_path = self.other_tree.id2path(file_id)
1432
# Skip the id2path lookup for older formats
1433
filter_tree_path = None
1434
transform.create_from_tree(self.tt, trans_id,
1435
self.other_tree, file_id,
1436
filter_tree_path=filter_tree_path)
1439
# OTHER deleted the file
1440
return 'delete', None
1442
raise AssertionError(
1443
'winner is OTHER, but file_id %r not in THIS or OTHER tree'
1446
def merge_contents(self, merge_hook_params):
1447
"""Fallback merge logic after user installed hooks."""
1448
# This function is used in merge hooks as the fallback instance.
1449
# Perhaps making this function and the functions it calls be a
1450
# a separate class would be better.
1451
if merge_hook_params.winner == 'other':
1452
# OTHER is a straight winner, so replace this contents with other
1453
return self._default_other_winner_merge(merge_hook_params)
1454
elif merge_hook_params.is_file_merge():
1455
# THIS and OTHER are both files, so text merge. Either
1456
# BASE is a file, or both converted to files, so at least we
1457
# have agreement that output should be a file.
1459
self.text_merge(merge_hook_params.file_id,
1460
merge_hook_params.trans_id)
1461
except errors.BinaryFile:
1462
return 'not_applicable', None
1465
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()
1467
860
def get_lines(self, tree, file_id):
1468
861
"""Return the lines in a file, or an empty list."""
1469
if tree.has_id(file_id):
1470
return tree.get_file_lines(file_id)
863
return tree.get_file(file_id).readlines()
1523
916
determined automatically. If set_version is true, the .OTHER, .THIS
1524
917
or .BASE (in that order) will be created as versioned files.
1526
data = [('OTHER', self.other_tree, other_lines),
919
data = [('OTHER', self.other_tree, other_lines),
1527
920
('THIS', self.this_tree, this_lines)]
1529
922
data.append(('BASE', self.base_tree, base_lines))
1531
# We need to use the actual path in the working tree of the file here,
1532
# ignoring the conflict suffixes
1534
if wt.supports_content_filtering():
1536
filter_tree_path = wt.id2path(file_id)
1537
except errors.NoSuchId:
1538
# file has been deleted
1539
filter_tree_path = None
1541
# Skip the id2path lookup for older formats
1542
filter_tree_path = None
1544
923
versioned = False
1546
925
for suffix, tree, lines in data:
1547
if tree.has_id(file_id):
1548
927
trans_id = self._conflict_file(name, parent_id, tree, file_id,
1549
suffix, lines, filter_tree_path)
1550
929
file_group.append(trans_id)
1551
930
if set_version and not versioned:
1552
931
self.tt.version_file(file_id, trans_id)
1553
932
versioned = True
1554
933
return file_group
1556
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
1557
lines=None, filter_tree_path=None):
935
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
1558
937
"""Emit a single conflict file."""
1559
938
name = name + '.' + suffix
1560
939
trans_id = self.tt.create_path(name, parent_id)
1561
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)
1565
944
def merge_executable(self, file_id, file_status):
1566
945
"""Perform a merge on the execute bit."""
1567
946
executable = [self.executable(t, file_id) for t in (self.base_tree,
1568
947
self.other_tree, self.this_tree)]
1569
self._merge_executable(file_id, executable, file_status,
1570
resolver=self._three_way)
948
self._merge_executable(file_id, executable, file_status)
1572
def _merge_executable(self, file_id, executable, file_status,
950
def _merge_executable(self, file_id, executable, file_status):
1574
951
"""Perform a merge on the execute bit."""
1575
952
base_executable, other_executable, this_executable = executable
1576
953
if file_status == "deleted":
1578
winner = resolver(*executable)
955
winner = self._three_way(*executable)
1579
956
if winner == "conflict":
1580
957
# There must be a None in here, if we have a conflict, but we
1581
958
# need executability since file status was not deleted.
1641
1006
if path.endswith(suffix):
1642
1007
path = path[:-len(suffix)]
1644
c = _mod_conflicts.Conflict.factory(conflict_type,
1645
path=path, file_id=file_id)
1646
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':
1647
1012
trans_id = conflict[1]
1648
1013
path = fp.get_path(trans_id)
1649
1014
file_id = self.tt.final_file_id(trans_id)
1650
c = _mod_conflicts.Conflict.factory(conflict_type,
1651
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)
1653
raise AssertionError('bad conflict type: %r' % (conflict,))
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)
1654
1042
self.cooked_conflicts.append(c)
1655
self.cooked_conflicts.sort(key=_mod_conflicts.Conflict.sort_key)
1043
self.cooked_conflicts.sort(key=Conflict.sort_key)
1658
1046
class WeaveMerger(Merge3Merger):
1662
1050
supports_reverse_cherrypick = False
1663
1051
history_based = True
1665
def _generate_merge_plan(self, file_id, base):
1666
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,
1669
def _merged_lines(self, file_id):
1670
"""Generate the merged lines.
1671
There is no distinction between lines that are meant to contain <<<<<<<
1675
base = self.base_tree
1678
plan = self._generate_merge_plan(file_id, base)
1679
1064
if 'merge' in debug.debug_flags:
1680
1065
plan = list(plan)
1681
1066
trans_id = self.tt.trans_id_file_id(file_id)
1682
1067
name = self.tt.final_name(trans_id) + '.plan'
1683
contents = ('%11s|%s' % l for l in plan)
1068
contents = ('%10s|%s' % l for l in plan)
1684
1069
self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
1685
textmerge = versionedfile.PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1686
'>>>>>>> MERGE-SOURCE\n')
1687
lines, conflicts = textmerge.merge_lines(self.reprocess)
1689
base_lines = textmerge.base_from_plan()
1692
return lines, base_lines
1070
textmerge = PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1071
'>>>>>>> MERGE-SOURCE\n')
1072
return textmerge.merge_lines(self.reprocess)
1694
1074
def text_merge(self, file_id, trans_id):
1695
1075
"""Perform a (weave) text merge for a given file and file-id.
1696
1076
If conflicts are encountered, .THIS and .OTHER files will be emitted,
1697
1077
and a conflict will be noted.
1699
lines, base_lines = self._merged_lines(file_id)
1079
lines, conflicts = self._merged_lines(file_id)
1700
1080
lines = list(lines)
1701
# 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,
1702
1082
# because we don't want to get into weave merge guts.
1703
textfile.check_text_lines(lines)
1083
check_text_lines(lines)
1704
1084
self.tt.create_file(lines, trans_id)
1705
if base_lines is not None:
1707
1086
self._raw_conflicts.append(('text conflict', trans_id))
1708
1087
name = self.tt.final_name(trans_id)
1709
1088
parent_id = self.tt.final_parent(trans_id)
1710
file_group = self._dump_conflicts(name, parent_id, file_id,
1712
base_lines=base_lines)
1089
file_group = self._dump_conflicts(name, parent_id, file_id,
1713
1091
file_group.append(trans_id)
1716
1094
class LCAMerger(WeaveMerger):
1718
def _generate_merge_plan(self, file_id, base):
1719
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)
1722
1118
class Diff3Merger(Merge3Merger):
1723
1119
"""Three-way merger using external diff3 for text merging"""
1725
1121
def dump_file(self, temp_dir, name, tree, file_id):
1726
out_path = osutils.pathjoin(temp_dir, name)
1122
out_path = pathjoin(temp_dir, name)
1727
1123
out_file = open(out_path, "wb")
1729
1125
in_file = tree.get_file(file_id)
1762
1158
osutils.rmtree(temp_dir)
1765
class PathNotInTree(errors.BzrError):
1767
_fmt = """Merge-into failed because %(tree)s does not contain %(path)s."""
1769
def __init__(self, path, tree):
1770
errors.BzrError.__init__(self, path=path, tree=tree)
1773
class MergeIntoMerger(Merger):
1774
"""Merger that understands other_tree will be merged into a subdir.
1776
This also changes the Merger api so that it uses real Branch, revision_id,
1777
and RevisonTree objects, rather than using revision specs.
1780
def __init__(self, this_tree, other_branch, other_tree, target_subdir,
1781
source_subpath, other_rev_id=None):
1782
"""Create a new MergeIntoMerger object.
1784
source_subpath in other_tree will be effectively copied to
1785
target_subdir in this_tree.
1787
:param this_tree: The tree that we will be merging into.
1788
:param other_branch: The Branch we will be merging from.
1789
:param other_tree: The RevisionTree object we want to merge.
1790
:param target_subdir: The relative path where we want to merge
1791
other_tree into this_tree
1792
:param source_subpath: The relative path specifying the subtree of
1793
other_tree to merge into this_tree.
1795
# It is assumed that we are merging a tree that is not in our current
1796
# ancestry, which means we are using the "EmptyTree" as our basis.
1797
null_ancestor_tree = this_tree.branch.repository.revision_tree(
1798
_mod_revision.NULL_REVISION)
1799
super(MergeIntoMerger, self).__init__(
1800
this_branch=this_tree.branch,
1801
this_tree=this_tree,
1802
other_tree=other_tree,
1803
base_tree=null_ancestor_tree,
1805
self._target_subdir = target_subdir
1806
self._source_subpath = source_subpath
1807
self.other_branch = other_branch
1808
if other_rev_id is None:
1809
other_rev_id = other_tree.get_revision_id()
1810
self.other_rev_id = self.other_basis = other_rev_id
1811
self.base_is_ancestor = True
1812
self.backup_files = True
1813
self.merge_type = Merge3Merger
1814
self.show_base = False
1815
self.reprocess = False
1816
self.interesting_ids = None
1817
self.merge_type = _MergeTypeParameterizer(MergeIntoMergeType,
1818
target_subdir=self._target_subdir,
1819
source_subpath=self._source_subpath)
1820
if self._source_subpath != '':
1821
# If this isn't a partial merge make sure the revisions will be
1823
self._maybe_fetch(self.other_branch, self.this_branch,
1826
def set_pending(self):
1827
if self._source_subpath != '':
1829
Merger.set_pending(self)
1832
class _MergeTypeParameterizer(object):
1833
"""Wrap a merge-type class to provide extra parameters.
1835
This is hack used by MergeIntoMerger to pass some extra parameters to its
1836
merge_type. Merger.do_merge() sets up its own set of parameters to pass to
1837
the 'merge_type' member. It is difficult override do_merge without
1838
re-writing the whole thing, so instead we create a wrapper which will pass
1839
the extra parameters.
1842
def __init__(self, merge_type, **kwargs):
1843
self._extra_kwargs = kwargs
1844
self._merge_type = merge_type
1846
def __call__(self, *args, **kwargs):
1847
kwargs.update(self._extra_kwargs)
1848
return self._merge_type(*args, **kwargs)
1850
def __getattr__(self, name):
1851
return getattr(self._merge_type, name)
1854
class MergeIntoMergeType(Merge3Merger):
1855
"""Merger that incorporates a tree (or part of a tree) into another."""
1857
def __init__(self, *args, **kwargs):
1858
"""Initialize the merger object.
1860
:param args: See Merge3Merger.__init__'s args.
1861
:param kwargs: See Merge3Merger.__init__'s keyword args, except for
1862
source_subpath and target_subdir.
1863
:keyword source_subpath: The relative path specifying the subtree of
1864
other_tree to merge into this_tree.
1865
:keyword target_subdir: The relative path where we want to merge
1866
other_tree into this_tree
1868
# All of the interesting work happens during Merge3Merger.__init__(),
1869
# so we have have to hack in to get our extra parameters set.
1870
self._source_subpath = kwargs.pop('source_subpath')
1871
self._target_subdir = kwargs.pop('target_subdir')
1872
super(MergeIntoMergeType, self).__init__(*args, **kwargs)
1874
def _compute_transform(self):
1875
child_pb = ui.ui_factory.nested_progress_bar()
1877
entries = self._entries_to_incorporate()
1878
entries = list(entries)
1879
for num, (entry, parent_id) in enumerate(entries):
1880
child_pb.update('Preparing file merge', num, len(entries))
1881
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1882
trans_id = transform.new_by_entry(self.tt, entry,
1883
parent_trans_id, self.other_tree)
1886
self._finish_computing_transform()
1888
def _entries_to_incorporate(self):
1889
"""Yields pairs of (inventory_entry, new_parent)."""
1890
other_inv = self.other_tree.inventory
1891
subdir_id = other_inv.path2id(self._source_subpath)
1892
if subdir_id is None:
1893
# XXX: The error would be clearer if it gave the URL of the source
1894
# branch, but we don't have a reference to that here.
1895
raise PathNotInTree(self._source_subpath, "Source tree")
1896
subdir = other_inv[subdir_id]
1897
parent_in_target = osutils.dirname(self._target_subdir)
1898
target_id = self.this_tree.inventory.path2id(parent_in_target)
1899
if target_id is None:
1900
raise PathNotInTree(self._target_subdir, "Target tree")
1901
name_in_target = osutils.basename(self._target_subdir)
1902
merge_into_root = subdir.copy()
1903
merge_into_root.name = name_in_target
1904
if merge_into_root.file_id in self.this_tree.inventory:
1905
# Give the root a new file-id.
1906
# This can happen fairly easily if the directory we are
1907
# incorporating is the root, and both trees have 'TREE_ROOT' as
1908
# their root_id. Users will expect this to Just Work, so we
1909
# change the file-id here.
1910
# Non-root file-ids could potentially conflict too. That's really
1911
# an edge case, so we don't do anything special for those. We let
1912
# them cause conflicts.
1913
merge_into_root.file_id = generate_ids.gen_file_id(name_in_target)
1914
yield (merge_into_root, target_id)
1915
if subdir.kind != 'directory':
1916
# No children, so we are done.
1918
for ignored_path, entry in other_inv.iter_entries_by_dir(subdir_id):
1919
parent_id = entry.parent_id
1920
if parent_id == subdir.file_id:
1921
# The root's parent ID has changed, so make sure children of
1922
# the root refer to the new ID.
1923
parent_id = merge_into_root.file_id
1924
yield (entry, parent_id)
1927
1161
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1928
1162
backup_files=False,
1929
1163
merge_type=Merge3Merger,
added
removed
bzrlib/merge.py
