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.'
609
interesting_revision_ids = set(lcas)
610
interesting_revision_ids.add(self.base_rev_id)
555
interesting_revision_ids = [self.base_rev_id]
556
interesting_revision_ids.extend(lcas)
611
557
interesting_trees = dict((t.get_revision_id(), t)
612
558
for t in self.this_branch.repository.revision_trees(
613
559
interesting_revision_ids))
614
560
self._cached_trees.update(interesting_trees)
615
if self.base_rev_id in lcas:
616
self.base_tree = interesting_trees[self.base_rev_id]
618
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(
619
564
self._lca_trees = [interesting_trees[key]
620
565
for key in sorted_lca_keys]
935
869
it then compares with THIS and BASE.
937
871
For the multi-valued entries, the format will be (BASE, [lca1, lca2])
939
:return: [(file_id, changed, parents, names, executable)], where:
941
* file_id: Simple file_id of the entry
942
* changed: Boolean, True if the kind or contents changed else False
943
* parents: ((base, [parent_id, in, lcas]), parent_id_other,
945
* names: ((base, [name, in, lcas]), name_in_other, name_in_this)
946
* 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)
949
881
if self.interesting_files is not None:
950
882
lookup_trees = [self.this_tree, self.base_tree]
1108
1042
other_root = self.tt.trans_id_file_id(other_root_file_id)
1109
1043
if other_root == self.tt.root:
1111
if self.this_tree.inventory.has_id(
1112
self.other_tree.inventory.root.file_id):
1113
# the other tree's root is a non-root in the current tree (as
1114
# when a previously unrelated branch is merged into another)
1116
if self.tt.final_kind(other_root) is not None:
1117
other_root_is_present = True
1119
# other_root doesn't have a physical representation. We still need
1120
# to move any references to the actual root of the tree.
1121
other_root_is_present = False
1122
# 'other_tree.inventory.root' is not present in this tree. We are
1123
# calling adjust_path for children which *want* to be present with a
1124
# correct place to go.
1125
for _, child in self.other_tree.inventory.root.children.iteritems():
1046
self.tt.final_kind(other_root)
1047
except errors.NoSuchFile:
1049
if self.this_tree.has_id(self.other_tree.inventory.root.file_id):
1050
# the other tree's root is a non-root in the current tree
1052
self.reparent_children(self.other_tree.inventory.root, self.tt.root)
1053
self.tt.cancel_creation(other_root)
1054
self.tt.cancel_versioning(other_root)
1056
def reparent_children(self, ie, target):
1057
for thing, child in ie.children.iteritems():
1126
1058
trans_id = self.tt.trans_id_file_id(child.file_id)
1127
if not other_root_is_present:
1128
if self.tt.final_kind(trans_id) is not None:
1129
# The item exist in the final tree and has a defined place
1132
# Move the item into the root
1134
final_name = self.tt.final_name(trans_id)
1135
except errors.NoFinalPath:
1136
# This file is not present anymore, ignore it.
1138
self.tt.adjust_path(final_name, self.tt.root, trans_id)
1139
if other_root_is_present:
1140
self.tt.cancel_creation(other_root)
1141
self.tt.cancel_versioning(other_root)
1059
self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
1143
1061
def write_modified(self, results):
1144
1062
modified_hashes = {}
1320
1238
self._raw_conflicts.append(('path conflict', trans_id, file_id,
1321
1239
this_parent, this_name,
1322
1240
other_parent, other_name))
1323
if not self.other_tree.has_id(file_id):
1241
if other_name is None:
1324
1242
# it doesn't matter whether the result was 'other' or
1325
# 'conflict'-- if it has no file id, we leave it alone.
1243
# 'conflict'-- if there's no 'other', we leave it alone.
1327
1245
parent_id = parents[self.winner_idx[parent_id_winner]]
1328
name = names[self.winner_idx[name_winner]]
1329
if parent_id is not None or name is not None:
1246
if parent_id is not None:
1330
1247
# if we get here, name_winner and parent_winner are set to safe
1332
if parent_id is None and name is not None:
1333
# if parent_id is None and name is non-None, current file is
1335
if names[self.winner_idx[parent_id_winner]] != '':
1336
raise AssertionError(
1337
'File looks like a root, but named %s' %
1338
names[self.winner_idx[parent_id_winner]])
1339
parent_trans_id = transform.ROOT_PARENT
1341
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1342
self.tt.adjust_path(name, parent_trans_id,
1249
self.tt.adjust_path(names[self.winner_idx[name_winner]],
1250
self.tt.trans_id_file_id(parent_id),
1343
1251
self.tt.trans_id_file_id(file_id))
1345
1253
def _do_merge_contents(self, file_id):
1346
1254
"""Performs a merge on file_id contents."""
1347
1255
def contents_pair(tree):
1348
if not tree.has_id(file_id):
1256
if file_id not in tree:
1349
1257
return (None, None)
1350
1258
kind = tree.kind(file_id)
1351
1259
if kind == "file":
1389
1297
if hook_status != 'not_applicable':
1390
1298
# Don't try any more hooks, this one applies.
1392
# If the merge ends up replacing the content of the file, we get rid of
1393
# it at the end of this method (this variable is used to track the
1394
# exceptions to this rule).
1396
1300
result = "modified"
1397
1301
if hook_status == 'not_applicable':
1398
# No merge hook was able to resolve the situation. Two cases exist:
1399
# a content conflict or a duplicate one.
1302
# This is a contents conflict, because none of the available
1303
# functions could merge it.
1401
1305
name = self.tt.final_name(trans_id)
1402
1306
parent_id = self.tt.final_parent(trans_id)
1404
inhibit_content_conflict = False
1405
if params.this_kind is None: # file_id is not in THIS
1406
# Is the name used for a different file_id ?
1407
dupe_path = self.other_tree.id2path(file_id)
1408
this_id = self.this_tree.path2id(dupe_path)
1409
if this_id is not None:
1410
# Two entries for the same path
1412
# versioning the merged file will trigger a duplicate
1414
self.tt.version_file(file_id, trans_id)
1415
transform.create_from_tree(
1416
self.tt, trans_id, self.other_tree, file_id,
1417
filter_tree_path=self._get_filter_tree_path(file_id))
1418
inhibit_content_conflict = True
1419
elif params.other_kind is None: # file_id is not in OTHER
1420
# Is the name used for a different file_id ?
1421
dupe_path = self.this_tree.id2path(file_id)
1422
other_id = self.other_tree.path2id(dupe_path)
1423
if other_id is not None:
1424
# Two entries for the same path again, but here, the other
1425
# entry will also be merged. We simply inhibit the
1426
# 'content' conflict creation because we know OTHER will
1427
# create (or has already created depending on ordering) an
1428
# entry at the same path. This will trigger a 'duplicate'
1431
inhibit_content_conflict = True
1432
if not inhibit_content_conflict:
1433
if params.this_kind is not None:
1434
self.tt.unversion_file(trans_id)
1435
# This is a contents conflict, because none of the available
1436
# functions could merge it.
1437
file_group = self._dump_conflicts(name, parent_id, file_id,
1439
self._raw_conflicts.append(('contents conflict', file_group))
1307
if self.this_tree.has_id(file_id):
1308
self.tt.unversion_file(trans_id)
1309
file_group = self._dump_conflicts(name, parent_id, file_id,
1311
self._raw_conflicts.append(('contents conflict', file_group))
1440
1312
elif hook_status == 'success':
1441
1313
self.tt.create_file(lines, trans_id)
1442
1314
elif hook_status == 'conflicted':
1458
1330
raise AssertionError('unknown hook_status: %r' % (hook_status,))
1459
1331
if not self.this_tree.has_id(file_id) and result == "modified":
1460
1332
self.tt.version_file(file_id, trans_id)
1462
# The merge has been performed and produced a new content, so the
1463
# old contents should not be retained.
1333
# The merge has been performed, so the old contents should not be
1464
1336
self.tt.delete_contents(trans_id)
1337
except errors.NoSuchFile:
1467
1341
def _default_other_winner_merge(self, merge_hook_params):
1468
1342
"""Replace this contents with other."""
1469
1343
file_id = merge_hook_params.file_id
1470
1344
trans_id = merge_hook_params.trans_id
1345
file_in_this = self.this_tree.has_id(file_id)
1471
1346
if self.other_tree.has_id(file_id):
1472
1347
# OTHER changed the file
1473
transform.create_from_tree(
1474
self.tt, trans_id, self.other_tree, file_id,
1475
filter_tree_path=self._get_filter_tree_path(file_id))
1349
if wt.supports_content_filtering():
1350
# We get the path from the working tree if it exists.
1351
# That fails though when OTHER is adding a file, so
1352
# we fall back to the other tree to find the path if
1353
# it doesn't exist locally.
1355
filter_tree_path = wt.id2path(file_id)
1356
except errors.NoSuchId:
1357
filter_tree_path = self.other_tree.id2path(file_id)
1359
# Skip the id2path lookup for older formats
1360
filter_tree_path = None
1361
transform.create_from_tree(self.tt, trans_id,
1362
self.other_tree, file_id,
1363
filter_tree_path=filter_tree_path)
1476
1364
return 'done', None
1477
elif self.this_tree.has_id(file_id):
1478
1366
# OTHER deleted the file
1479
1367
return 'delete', None
1832
1689
osutils.rmtree(temp_dir)
1835
class PathNotInTree(errors.BzrError):
1837
_fmt = """Merge-into failed because %(tree)s does not contain %(path)s."""
1839
def __init__(self, path, tree):
1840
errors.BzrError.__init__(self, path=path, tree=tree)
1843
class MergeIntoMerger(Merger):
1844
"""Merger that understands other_tree will be merged into a subdir.
1846
This also changes the Merger api so that it uses real Branch, revision_id,
1847
and RevisonTree objects, rather than using revision specs.
1850
def __init__(self, this_tree, other_branch, other_tree, target_subdir,
1851
source_subpath, other_rev_id=None):
1852
"""Create a new MergeIntoMerger object.
1854
source_subpath in other_tree will be effectively copied to
1855
target_subdir in this_tree.
1857
:param this_tree: The tree that we will be merging into.
1858
:param other_branch: The Branch we will be merging from.
1859
:param other_tree: The RevisionTree object we want to merge.
1860
:param target_subdir: The relative path where we want to merge
1861
other_tree into this_tree
1862
:param source_subpath: The relative path specifying the subtree of
1863
other_tree to merge into this_tree.
1865
# It is assumed that we are merging a tree that is not in our current
1866
# ancestry, which means we are using the "EmptyTree" as our basis.
1867
null_ancestor_tree = this_tree.branch.repository.revision_tree(
1868
_mod_revision.NULL_REVISION)
1869
super(MergeIntoMerger, self).__init__(
1870
this_branch=this_tree.branch,
1871
this_tree=this_tree,
1872
other_tree=other_tree,
1873
base_tree=null_ancestor_tree,
1875
self._target_subdir = target_subdir
1876
self._source_subpath = source_subpath
1877
self.other_branch = other_branch
1878
if other_rev_id is None:
1879
other_rev_id = other_tree.get_revision_id()
1880
self.other_rev_id = self.other_basis = other_rev_id
1881
self.base_is_ancestor = True
1882
self.backup_files = True
1883
self.merge_type = Merge3Merger
1884
self.show_base = False
1885
self.reprocess = False
1886
self.interesting_ids = None
1887
self.merge_type = _MergeTypeParameterizer(MergeIntoMergeType,
1888
target_subdir=self._target_subdir,
1889
source_subpath=self._source_subpath)
1890
if self._source_subpath != '':
1891
# If this isn't a partial merge make sure the revisions will be
1893
self._maybe_fetch(self.other_branch, self.this_branch,
1896
def set_pending(self):
1897
if self._source_subpath != '':
1899
Merger.set_pending(self)
1902
class _MergeTypeParameterizer(object):
1903
"""Wrap a merge-type class to provide extra parameters.
1905
This is hack used by MergeIntoMerger to pass some extra parameters to its
1906
merge_type. Merger.do_merge() sets up its own set of parameters to pass to
1907
the 'merge_type' member. It is difficult override do_merge without
1908
re-writing the whole thing, so instead we create a wrapper which will pass
1909
the extra parameters.
1912
def __init__(self, merge_type, **kwargs):
1913
self._extra_kwargs = kwargs
1914
self._merge_type = merge_type
1916
def __call__(self, *args, **kwargs):
1917
kwargs.update(self._extra_kwargs)
1918
return self._merge_type(*args, **kwargs)
1920
def __getattr__(self, name):
1921
return getattr(self._merge_type, name)
1924
class MergeIntoMergeType(Merge3Merger):
1925
"""Merger that incorporates a tree (or part of a tree) into another."""
1927
def __init__(self, *args, **kwargs):
1928
"""Initialize the merger object.
1930
:param args: See Merge3Merger.__init__'s args.
1931
:param kwargs: See Merge3Merger.__init__'s keyword args, except for
1932
source_subpath and target_subdir.
1933
:keyword source_subpath: The relative path specifying the subtree of
1934
other_tree to merge into this_tree.
1935
:keyword target_subdir: The relative path where we want to merge
1936
other_tree into this_tree
1938
# All of the interesting work happens during Merge3Merger.__init__(),
1939
# so we have have to hack in to get our extra parameters set.
1940
self._source_subpath = kwargs.pop('source_subpath')
1941
self._target_subdir = kwargs.pop('target_subdir')
1942
super(MergeIntoMergeType, self).__init__(*args, **kwargs)
1944
def _compute_transform(self):
1945
child_pb = ui.ui_factory.nested_progress_bar()
1947
entries = self._entries_to_incorporate()
1948
entries = list(entries)
1949
for num, (entry, parent_id) in enumerate(entries):
1950
child_pb.update('Preparing file merge', num, len(entries))
1951
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1952
trans_id = transform.new_by_entry(self.tt, entry,
1953
parent_trans_id, self.other_tree)
1956
self._finish_computing_transform()
1958
def _entries_to_incorporate(self):
1959
"""Yields pairs of (inventory_entry, new_parent)."""
1960
other_inv = self.other_tree.inventory
1961
subdir_id = other_inv.path2id(self._source_subpath)
1962
if subdir_id is None:
1963
# XXX: The error would be clearer if it gave the URL of the source
1964
# branch, but we don't have a reference to that here.
1965
raise PathNotInTree(self._source_subpath, "Source tree")
1966
subdir = other_inv[subdir_id]
1967
parent_in_target = osutils.dirname(self._target_subdir)
1968
target_id = self.this_tree.inventory.path2id(parent_in_target)
1969
if target_id is None:
1970
raise PathNotInTree(self._target_subdir, "Target tree")
1971
name_in_target = osutils.basename(self._target_subdir)
1972
merge_into_root = subdir.copy()
1973
merge_into_root.name = name_in_target
1974
if self.this_tree.inventory.has_id(merge_into_root.file_id):
1975
# Give the root a new file-id.
1976
# This can happen fairly easily if the directory we are
1977
# incorporating is the root, and both trees have 'TREE_ROOT' as
1978
# their root_id. Users will expect this to Just Work, so we
1979
# change the file-id here.
1980
# Non-root file-ids could potentially conflict too. That's really
1981
# an edge case, so we don't do anything special for those. We let
1982
# them cause conflicts.
1983
merge_into_root.file_id = generate_ids.gen_file_id(name_in_target)
1984
yield (merge_into_root, target_id)
1985
if subdir.kind != 'directory':
1986
# No children, so we are done.
1988
for ignored_path, entry in other_inv.iter_entries_by_dir(subdir_id):
1989
parent_id = entry.parent_id
1990
if parent_id == subdir.file_id:
1991
# The root's parent ID has changed, so make sure children of
1992
# the root refer to the new ID.
1993
parent_id = merge_into_root.file_id
1994
yield (entry, parent_id)
1997
1692
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1998
1693
backup_files=False,
1999
1694
merge_type=Merge3Merger,
added
removed
bzrlib/merge.py
