100
93
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):
96
class ConfigurableFileMerger(AbstractPerFileMerger):
157
97
"""Merge individual files when configured via a .conf file.
159
99
This is a base class for concrete custom file merging logic. Concrete
592
546
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]
548
self._is_criss_cross = True
599
549
if self.base_rev_id == _mod_revision.NULL_REVISION:
600
550
raise errors.UnrelatedBranches()
601
551
if self._is_criss_cross:
602
552
trace.warning('Warning: criss-cross merge encountered. See bzr'
603
553
' help criss-cross.')
604
554
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)
555
interesting_revision_ids = [self.base_rev_id]
556
interesting_revision_ids.extend(lcas)
610
557
interesting_trees = dict((t.get_revision_id(), t)
611
558
for t in self.this_branch.repository.revision_trees(
612
559
interesting_revision_ids))
613
560
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)
561
self.base_tree = interesting_trees.pop(self.base_rev_id)
562
sorted_lca_keys = self.revision_graph.find_merge_order(
618
564
self._lca_trees = [interesting_trees[key]
619
565
for key in sorted_lca_keys]
933
869
it then compares with THIS and BASE.
935
871
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,
872
:return: [(file_id, changed, parents, names, executable)]
873
file_id Simple file_id of the entry
874
changed Boolean, True if the kind or contents changed
876
parents ((base, [parent_id, in, lcas]), parent_id_other,
878
names ((base, [name, in, lcas]), name_in_other, name_in_this)
879
executable ((base, [exec, in, lcas]), exec_in_other, exec_in_this)
947
881
if self.interesting_files is not None:
948
882
lookup_trees = [self.this_tree, self.base_tree]
1106
1043
other_root = self.tt.trans_id_file_id(other_root_file_id)
1107
1044
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)
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():
1047
self.tt.final_kind(other_root)
1048
except errors.NoSuchFile:
1050
if self.this_tree.has_id(self.other_tree.inventory.root.file_id):
1051
# the other tree's root is a non-root in the current tree
1053
self.reparent_children(self.other_tree.inventory.root, self.tt.root)
1054
self.tt.cancel_creation(other_root)
1055
self.tt.cancel_versioning(other_root)
1057
def reparent_children(self, ie, target):
1058
for thing, child in ie.children.iteritems():
1124
1059
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)
1060
self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
1141
1062
def write_modified(self, results):
1142
1063
modified_hashes = {}
1310
1228
parent_id_winner = "other"
1311
1229
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):
1231
if name_winner == "conflict":
1232
trans_id = self.tt.trans_id_file_id(file_id)
1233
self._raw_conflicts.append(('name conflict', trans_id,
1234
this_name, other_name))
1235
if parent_id_winner == "conflict":
1236
trans_id = self.tt.trans_id_file_id(file_id)
1237
self._raw_conflicts.append(('parent conflict', trans_id,
1238
this_parent, other_parent))
1239
if other_name is None:
1322
1240
# it doesn't matter whether the result was 'other' or
1323
# 'conflict'-- if it has no file id, we leave it alone.
1241
# 'conflict'-- if there's no 'other', we leave it alone.
1243
# if we get here, name_winner and parent_winner are set to safe values.
1244
trans_id = self.tt.trans_id_file_id(file_id)
1325
1245
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))
1246
if parent_id is not None:
1247
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1248
self.tt.adjust_path(names[self.winner_idx[name_winner]],
1249
parent_trans_id, trans_id)
1343
1251
def _do_merge_contents(self, file_id):
1344
1252
"""Performs a merge on file_id contents."""
1345
1253
def contents_pair(tree):
1346
if not tree.has_id(file_id):
1254
if file_id not in tree:
1347
1255
return (None, None)
1348
1256
kind = tree.kind(file_id)
1349
1257
if kind == "file":
1618
1532
def cook_conflicts(self, fs_conflicts):
1619
1533
"""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)
1535
self.cooked_conflicts.extend(transform.cook_conflicts(
1536
fs_conflicts, self.tt))
1622
1537
fp = transform.FinalPaths(self.tt)
1623
1538
for conflict in self._raw_conflicts:
1624
1539
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
parent_path = fp.get_path(
1639
self.tt.trans_id_file_id(other_parent))
1640
other_path = osutils.pathjoin(parent_path, other_name)
1641
c = _mod_conflicts.Conflict.factory(
1642
'path conflict', path=this_path,
1643
conflict_path=other_path,
1645
elif conflict_type == 'contents conflict':
1540
if conflict_type in ('name conflict', 'parent conflict'):
1541
trans_id = conflict[1]
1542
conflict_args = conflict[2:]
1543
if trans_id not in name_conflicts:
1544
name_conflicts[trans_id] = {}
1545
transform.unique_add(name_conflicts[trans_id], conflict_type,
1547
if conflict_type == 'contents conflict':
1646
1548
for trans_id in conflict[1]:
1647
1549
file_id = self.tt.final_file_id(trans_id)
1648
1550
if file_id is not None:
1655
1557
c = _mod_conflicts.Conflict.factory(conflict_type,
1656
1558
path=path, file_id=file_id)
1657
content_conflict_file_ids.add(file_id)
1658
elif conflict_type == 'text conflict':
1559
self.cooked_conflicts.append(c)
1560
if conflict_type == 'text conflict':
1659
1561
trans_id = conflict[1]
1660
1562
path = fp.get_path(trans_id)
1661
1563
file_id = self.tt.final_file_id(trans_id)
1662
1564
c = _mod_conflicts.Conflict.factory(conflict_type,
1663
1565
path=path, file_id=file_id)
1566
self.cooked_conflicts.append(c)
1568
for trans_id, conflicts in name_conflicts.iteritems():
1570
this_parent, other_parent = conflicts['parent conflict']
1571
if this_parent == other_parent:
1572
raise AssertionError()
1574
this_parent = other_parent = \
1575
self.tt.final_file_id(self.tt.final_parent(trans_id))
1577
this_name, other_name = conflicts['name conflict']
1578
if this_name == other_name:
1579
raise AssertionError()
1581
this_name = other_name = self.tt.final_name(trans_id)
1582
other_path = fp.get_path(trans_id)
1583
if this_parent is not None and this_name is not None:
1584
this_parent_path = \
1585
fp.get_path(self.tt.trans_id_file_id(this_parent))
1586
this_path = osutils.pathjoin(this_parent_path, this_name)
1665
raise AssertionError('bad conflict type: %r' % (conflict,))
1666
cooked_conflicts.append(c)
1668
self.cooked_conflicts = []
1669
# We want to get rid of path conflicts when a corresponding contents
1670
# conflict exists. This can occur when one branch deletes a file while
1671
# the other renames *and* modifies it. In this case, the content
1672
# conflict is enough.
1673
for c in cooked_conflicts:
1674
if (c.typestring == 'path conflict'
1675
and c.file_id in content_conflict_file_ids):
1588
this_path = "<deleted>"
1589
file_id = self.tt.final_file_id(trans_id)
1590
c = _mod_conflicts.Conflict.factory('path conflict', path=this_path,
1591
conflict_path=other_path,
1677
1593
self.cooked_conflicts.append(c)
1678
1594
self.cooked_conflicts.sort(key=_mod_conflicts.Conflict.sort_key)
1785
1701
osutils.rmtree(temp_dir)
1788
class PathNotInTree(errors.BzrError):
1790
_fmt = """Merge-into failed because %(tree)s does not contain %(path)s."""
1792
def __init__(self, path, tree):
1793
errors.BzrError.__init__(self, path=path, tree=tree)
1796
class MergeIntoMerger(Merger):
1797
"""Merger that understands other_tree will be merged into a subdir.
1799
This also changes the Merger api so that it uses real Branch, revision_id,
1800
and RevisonTree objects, rather than using revision specs.
1803
def __init__(self, this_tree, other_branch, other_tree, target_subdir,
1804
source_subpath, other_rev_id=None):
1805
"""Create a new MergeIntoMerger object.
1807
source_subpath in other_tree will be effectively copied to
1808
target_subdir in this_tree.
1810
:param this_tree: The tree that we will be merging into.
1811
:param other_branch: The Branch we will be merging from.
1812
:param other_tree: The RevisionTree object we want to merge.
1813
:param target_subdir: The relative path where we want to merge
1814
other_tree into this_tree
1815
:param source_subpath: The relative path specifying the subtree of
1816
other_tree to merge into this_tree.
1818
# It is assumed that we are merging a tree that is not in our current
1819
# ancestry, which means we are using the "EmptyTree" as our basis.
1820
null_ancestor_tree = this_tree.branch.repository.revision_tree(
1821
_mod_revision.NULL_REVISION)
1822
super(MergeIntoMerger, self).__init__(
1823
this_branch=this_tree.branch,
1824
this_tree=this_tree,
1825
other_tree=other_tree,
1826
base_tree=null_ancestor_tree,
1828
self._target_subdir = target_subdir
1829
self._source_subpath = source_subpath
1830
self.other_branch = other_branch
1831
if other_rev_id is None:
1832
other_rev_id = other_tree.get_revision_id()
1833
self.other_rev_id = self.other_basis = other_rev_id
1834
self.base_is_ancestor = True
1835
self.backup_files = True
1836
self.merge_type = Merge3Merger
1837
self.show_base = False
1838
self.reprocess = False
1839
self.interesting_ids = None
1840
self.merge_type = _MergeTypeParameterizer(MergeIntoMergeType,
1841
target_subdir=self._target_subdir,
1842
source_subpath=self._source_subpath)
1843
if self._source_subpath != '':
1844
# If this isn't a partial merge make sure the revisions will be
1846
self._maybe_fetch(self.other_branch, self.this_branch,
1849
def set_pending(self):
1850
if self._source_subpath != '':
1852
Merger.set_pending(self)
1855
class _MergeTypeParameterizer(object):
1856
"""Wrap a merge-type class to provide extra parameters.
1858
This is hack used by MergeIntoMerger to pass some extra parameters to its
1859
merge_type. Merger.do_merge() sets up its own set of parameters to pass to
1860
the 'merge_type' member. It is difficult override do_merge without
1861
re-writing the whole thing, so instead we create a wrapper which will pass
1862
the extra parameters.
1865
def __init__(self, merge_type, **kwargs):
1866
self._extra_kwargs = kwargs
1867
self._merge_type = merge_type
1869
def __call__(self, *args, **kwargs):
1870
kwargs.update(self._extra_kwargs)
1871
return self._merge_type(*args, **kwargs)
1873
def __getattr__(self, name):
1874
return getattr(self._merge_type, name)
1877
class MergeIntoMergeType(Merge3Merger):
1878
"""Merger that incorporates a tree (or part of a tree) into another."""
1880
def __init__(self, *args, **kwargs):
1881
"""Initialize the merger object.
1883
:param args: See Merge3Merger.__init__'s args.
1884
:param kwargs: See Merge3Merger.__init__'s keyword args, except for
1885
source_subpath and target_subdir.
1886
:keyword source_subpath: The relative path specifying the subtree of
1887
other_tree to merge into this_tree.
1888
:keyword target_subdir: The relative path where we want to merge
1889
other_tree into this_tree
1891
# All of the interesting work happens during Merge3Merger.__init__(),
1892
# so we have have to hack in to get our extra parameters set.
1893
self._source_subpath = kwargs.pop('source_subpath')
1894
self._target_subdir = kwargs.pop('target_subdir')
1895
super(MergeIntoMergeType, self).__init__(*args, **kwargs)
1897
def _compute_transform(self):
1898
child_pb = ui.ui_factory.nested_progress_bar()
1900
entries = self._entries_to_incorporate()
1901
entries = list(entries)
1902
for num, (entry, parent_id) in enumerate(entries):
1903
child_pb.update('Preparing file merge', num, len(entries))
1904
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1905
trans_id = transform.new_by_entry(self.tt, entry,
1906
parent_trans_id, self.other_tree)
1909
self._finish_computing_transform()
1911
def _entries_to_incorporate(self):
1912
"""Yields pairs of (inventory_entry, new_parent)."""
1913
other_inv = self.other_tree.inventory
1914
subdir_id = other_inv.path2id(self._source_subpath)
1915
if subdir_id is None:
1916
# XXX: The error would be clearer if it gave the URL of the source
1917
# branch, but we don't have a reference to that here.
1918
raise PathNotInTree(self._source_subpath, "Source tree")
1919
subdir = other_inv[subdir_id]
1920
parent_in_target = osutils.dirname(self._target_subdir)
1921
target_id = self.this_tree.inventory.path2id(parent_in_target)
1922
if target_id is None:
1923
raise PathNotInTree(self._target_subdir, "Target tree")
1924
name_in_target = osutils.basename(self._target_subdir)
1925
merge_into_root = subdir.copy()
1926
merge_into_root.name = name_in_target
1927
if self.this_tree.inventory.has_id(merge_into_root.file_id):
1928
# Give the root a new file-id.
1929
# This can happen fairly easily if the directory we are
1930
# incorporating is the root, and both trees have 'TREE_ROOT' as
1931
# their root_id. Users will expect this to Just Work, so we
1932
# change the file-id here.
1933
# Non-root file-ids could potentially conflict too. That's really
1934
# an edge case, so we don't do anything special for those. We let
1935
# them cause conflicts.
1936
merge_into_root.file_id = generate_ids.gen_file_id(name_in_target)
1937
yield (merge_into_root, target_id)
1938
if subdir.kind != 'directory':
1939
# No children, so we are done.
1941
for ignored_path, entry in other_inv.iter_entries_by_dir(subdir_id):
1942
parent_id = entry.parent_id
1943
if parent_id == subdir.file_id:
1944
# The root's parent ID has changed, so make sure children of
1945
# the root refer to the new ID.
1946
parent_id = merge_into_root.file_id
1947
yield (entry, parent_id)
1950
1704
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1951
1705
backup_files=False,
1952
1706
merge_type=Merge3Merger,