55
67
class MergeHooks(hooks.Hooks):
57
69
def __init__(self):
58
hooks.Hooks.__init__(self)
59
self.create_hook(hooks.HookPoint('merge_file_content',
60
"Called with a bzrlib.merge.Merger object to create a per file "
70
hooks.Hooks.__init__(self, "breezy.merge", "Merger.hooks")
71
self.add_hook('merge_file_content',
72
"Called with a breezy.merge.Merger object to create a per file "
61
73
"merge object when starting a merge. "
62
74
"Should return either None or a subclass of "
63
"``bzrlib.merge.AbstractPerFileMerger``. "
75
"``breezy.merge.AbstractPerFileMerger``. "
64
76
"Such objects will then be called per file "
65
77
"that needs to be merged (including when one "
66
78
"side has deleted the file and the other has changed it). "
67
79
"See the AbstractPerFileMerger API docs for details on how it is "
82
self.add_hook('pre_merge',
83
'Called before a merge. '
84
'Receives a Merger object as the single argument.',
86
self.add_hook('post_merge',
87
'Called after a merge. '
88
'Receives a Merger object as the single argument. '
89
'The return value is ignored.',
72
93
class AbstractPerFileMerger(object):
73
"""PerFileMerger objects are used by plugins extending merge for bzrlib.
94
"""PerFileMerger objects are used by plugins extending merge for breezy.
75
See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
96
See ``breezy.plugins.news_merge.news_merge`` for an example concrete class.
77
98
:ivar merger: The Merge3Merger performing the merge.
435
455
revision_id = _mod_revision.ensure_null(revision_id)
436
456
return branch, self.revision_tree(revision_id, branch)
438
@deprecated_method(deprecated_in((2, 1, 0)))
439
def ensure_revision_trees(self):
440
if self.this_revision_tree is None:
441
self.this_basis_tree = self.revision_tree(self.this_basis)
442
if self.this_basis == self.this_rev_id:
443
self.this_revision_tree = self.this_basis_tree
445
if self.other_rev_id is None:
446
other_basis_tree = self.revision_tree(self.other_basis)
447
if other_basis_tree.has_changes(self.other_tree):
448
raise errors.WorkingTreeNotRevision(self.this_tree)
449
other_rev_id = self.other_basis
450
self.other_tree = other_basis_tree
452
@deprecated_method(deprecated_in((2, 1, 0)))
453
def file_revisions(self, file_id):
454
self.ensure_revision_trees()
455
def get_id(tree, file_id):
456
revision_id = tree.inventory[file_id].revision
458
if self.this_rev_id is None:
459
if self.this_basis_tree.get_file_sha1(file_id) != \
460
self.this_tree.get_file_sha1(file_id):
461
raise errors.WorkingTreeNotRevision(self.this_tree)
463
trees = (self.this_basis_tree, self.other_tree)
464
return [get_id(tree, file_id) for tree in trees]
466
@deprecated_method(deprecated_in((2, 1, 0)))
467
def check_basis(self, check_clean, require_commits=True):
468
if self.this_basis is None and require_commits is True:
469
raise errors.BzrCommandError(
470
"This branch has no commits."
471
" (perhaps you would prefer 'bzr pull')")
474
if self.this_basis != self.this_rev_id:
475
raise errors.UncommittedChanges(self.this_tree)
477
@deprecated_method(deprecated_in((2, 1, 0)))
478
def compare_basis(self):
480
basis_tree = self.revision_tree(self.this_tree.last_revision())
481
except errors.NoSuchRevision:
482
basis_tree = self.this_tree.basis_tree()
483
if not self.this_tree.has_changes(basis_tree):
484
self.this_rev_id = self.this_basis
486
458
def set_interesting_files(self, file_list):
487
459
self.interesting_files = file_list
587
561
self.base_rev_id = self.revision_graph.find_unique_lca(
589
self._is_criss_cross = True
563
sorted_lca_keys = self.revision_graph.find_merge_order(
565
if self.base_rev_id == _mod_revision.NULL_REVISION:
566
self.base_rev_id = sorted_lca_keys[0]
590
568
if self.base_rev_id == _mod_revision.NULL_REVISION:
591
569
raise errors.UnrelatedBranches()
592
570
if self._is_criss_cross:
593
571
trace.warning('Warning: criss-cross merge encountered. See bzr'
594
572
' help criss-cross.')
595
573
trace.mutter('Criss-cross lcas: %r' % lcas)
596
interesting_revision_ids = [self.base_rev_id]
597
interesting_revision_ids.extend(lcas)
574
if self.base_rev_id in lcas:
575
trace.mutter('Unable to find unique lca. '
576
'Fallback %r as best option.'
578
interesting_revision_ids = set(lcas)
579
interesting_revision_ids.add(self.base_rev_id)
598
580
interesting_trees = dict((t.get_revision_id(), t)
599
581
for t in self.this_branch.repository.revision_trees(
600
582
interesting_revision_ids))
601
583
self._cached_trees.update(interesting_trees)
602
self.base_tree = interesting_trees.pop(self.base_rev_id)
603
sorted_lca_keys = self.revision_graph.find_merge_order(
584
if self.base_rev_id in lcas:
585
self.base_tree = interesting_trees[self.base_rev_id]
587
self.base_tree = interesting_trees.pop(self.base_rev_id)
605
588
self._lca_trees = [interesting_trees[key]
606
589
for key in sorted_lca_keys]
913
919
it then compares with THIS and BASE.
915
921
For the multi-valued entries, the format will be (BASE, [lca1, lca2])
916
:return: [(file_id, changed, parents, names, executable)]
917
file_id Simple file_id of the entry
918
changed Boolean, True if the kind or contents changed
920
parents ((base, [parent_id, in, lcas]), parent_id_other,
922
names ((base, [name, in, lcas]), name_in_other, name_in_this)
923
executable ((base, [exec, in, lcas]), exec_in_other, exec_in_this)
923
:return: [(file_id, changed, parents, names, executable)], where:
925
* file_id: Simple file_id of the entry
926
* changed: Boolean, True if the kind or contents changed else False
927
* parents: ((base, [parent_id, in, lcas]), parent_id_other,
929
* names: ((base, [name, in, lcas]), name_in_other, name_in_this)
930
* executable: ((base, [exec, in, lcas]), exec_in_other,
925
933
if self.interesting_files is not None:
926
934
lookup_trees = [self.this_tree, self.base_tree]
1077
self.tt.final_kind(self.tt.root)
1078
except errors.NoSuchFile:
1079
self.tt.cancel_deletion(self.tt.root)
1080
if self.tt.final_file_id(self.tt.root) is None:
1081
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
1083
other_root_file_id = self.other_tree.get_root_id()
1084
if other_root_file_id is None:
1086
other_root = self.tt.trans_id_file_id(other_root_file_id)
1087
if other_root == self.tt.root:
1089
if self.other_tree.inventory.root.file_id in self.this_tree.inventory:
1090
# the other tree's root is a non-root in the current tree (as when
1091
# a previously unrelated branch is merged into another)
1094
self.tt.final_kind(other_root)
1095
other_root_is_present = True
1096
except errors.NoSuchFile:
1097
# other_root doesn't have a physical representation. We still need
1098
# to move any references to the actual root of the tree.
1099
other_root_is_present = False
1100
# 'other_tree.inventory.root' is not present in this tree. We are
1101
# calling adjust_path for children which *want* to be present with a
1102
# correct place to go.
1103
for thing, child in self.other_tree.inventory.root.children.iteritems():
1104
trans_id = self.tt.trans_id_file_id(child.file_id)
1105
if not other_root_is_present:
1106
# FIXME: Make final_kind returns None instead of raising
1107
# NoSuchFile to avoid the ugly construct below -- vila 20100402
1109
self.tt.final_kind(trans_id)
1110
# The item exist in the final tree and has a defined place
1113
except errors.NoSuchFile, e:
1115
# Move the item into the root
1116
self.tt.adjust_path(self.tt.final_name(trans_id),
1117
self.tt.root, trans_id)
1118
if other_root_is_present:
1119
self.tt.cancel_creation(other_root)
1120
self.tt.cancel_versioning(other_root)
1122
1082
def write_modified(self, results):
1123
1083
modified_hashes = {}
1124
1084
for path in results.modified_paths:
1125
file_id = self.this_tree.path2id(self.this_tree.relpath(path))
1085
file_id = self.working_tree.path2id(self.working_tree.relpath(path))
1126
1086
if file_id is None:
1128
hash = self.this_tree.get_file_sha1(file_id)
1088
hash = self.working_tree.get_file_sha1(file_id)
1129
1089
if hash is None:
1131
1091
modified_hashes[file_id] = hash
1132
self.this_tree.set_merge_modified(modified_hashes)
1092
self.working_tree.set_merge_modified(modified_hashes)
1135
1095
def parent(entry, file_id):
1299
1239
self._raw_conflicts.append(('path conflict', trans_id, file_id,
1300
1240
this_parent, this_name,
1301
1241
other_parent, other_name))
1302
if other_name is None:
1242
if not self.other_tree.has_id(file_id):
1303
1243
# it doesn't matter whether the result was 'other' or
1304
# 'conflict'-- if there's no 'other', we leave it alone.
1244
# 'conflict'-- if it has no file id, we leave it alone.
1306
1246
parent_id = parents[self.winner_idx[parent_id_winner]]
1307
if parent_id is not None:
1247
name = names[self.winner_idx[name_winner]]
1248
if parent_id is not None or name is not None:
1308
1249
# if we get here, name_winner and parent_winner are set to safe
1310
self.tt.adjust_path(names[self.winner_idx[name_winner]],
1311
self.tt.trans_id_file_id(parent_id),
1251
if parent_id is None and name is not None:
1252
# if parent_id is None and name is non-None, current file is
1254
if names[self.winner_idx[parent_id_winner]] != '':
1255
raise AssertionError(
1256
'File looks like a root, but named %s' %
1257
names[self.winner_idx[parent_id_winner]])
1258
parent_trans_id = transform.ROOT_PARENT
1260
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1261
self.tt.adjust_path(name, parent_trans_id,
1312
1262
self.tt.trans_id_file_id(file_id))
1314
1264
def _do_merge_contents(self, file_id):
1315
1265
"""Performs a merge on file_id contents."""
1316
1266
def contents_pair(tree):
1317
if file_id not in tree:
1267
if not tree.has_id(file_id):
1318
1268
return (None, None)
1319
1269
kind = tree.kind(file_id)
1320
1270
if kind == "file":
1358
1308
if hook_status != 'not_applicable':
1359
1309
# Don't try any more hooks, this one applies.
1311
# If the merge ends up replacing the content of the file, we get rid of
1312
# it at the end of this method (this variable is used to track the
1313
# exceptions to this rule).
1361
1315
result = "modified"
1362
1316
if hook_status == 'not_applicable':
1363
# This is a contents conflict, because none of the available
1364
# functions could merge it.
1317
# No merge hook was able to resolve the situation. Two cases exist:
1318
# a content conflict or a duplicate one.
1366
1320
name = self.tt.final_name(trans_id)
1367
1321
parent_id = self.tt.final_parent(trans_id)
1368
if self.this_tree.has_id(file_id):
1369
self.tt.unversion_file(trans_id)
1370
file_group = self._dump_conflicts(name, parent_id, file_id,
1372
self._raw_conflicts.append(('contents conflict', file_group))
1323
inhibit_content_conflict = False
1324
if params.this_kind is None: # file_id is not in THIS
1325
# Is the name used for a different file_id ?
1326
dupe_path = self.other_tree.id2path(file_id)
1327
this_id = self.this_tree.path2id(dupe_path)
1328
if this_id is not None:
1329
# Two entries for the same path
1331
# versioning the merged file will trigger a duplicate
1333
self.tt.version_file(file_id, trans_id)
1334
transform.create_from_tree(
1335
self.tt, trans_id, self.other_tree, file_id,
1336
filter_tree_path=self._get_filter_tree_path(file_id))
1337
inhibit_content_conflict = True
1338
elif params.other_kind is None: # file_id is not in OTHER
1339
# Is the name used for a different file_id ?
1340
dupe_path = self.this_tree.id2path(file_id)
1341
other_id = self.other_tree.path2id(dupe_path)
1342
if other_id is not None:
1343
# Two entries for the same path again, but here, the other
1344
# entry will also be merged. We simply inhibit the
1345
# 'content' conflict creation because we know OTHER will
1346
# create (or has already created depending on ordering) an
1347
# entry at the same path. This will trigger a 'duplicate'
1350
inhibit_content_conflict = True
1351
if not inhibit_content_conflict:
1352
if params.this_kind is not None:
1353
self.tt.unversion_file(trans_id)
1354
# This is a contents conflict, because none of the available
1355
# functions could merge it.
1356
file_group = self._dump_conflicts(name, parent_id, file_id,
1358
self._raw_conflicts.append(('contents conflict', file_group))
1373
1359
elif hook_status == 'success':
1374
1360
self.tt.create_file(lines, trans_id)
1375
1361
elif hook_status == 'conflicted':
1391
1377
raise AssertionError('unknown hook_status: %r' % (hook_status,))
1392
1378
if not self.this_tree.has_id(file_id) and result == "modified":
1393
1379
self.tt.version_file(file_id, trans_id)
1394
# The merge has been performed, so the old contents should not be
1381
# The merge has been performed and produced a new content, so the
1382
# old contents should not be retained.
1397
1383
self.tt.delete_contents(trans_id)
1398
except errors.NoSuchFile:
1402
1386
def _default_other_winner_merge(self, merge_hook_params):
1403
1387
"""Replace this contents with other."""
1404
1388
file_id = merge_hook_params.file_id
1405
1389
trans_id = merge_hook_params.trans_id
1406
file_in_this = self.this_tree.has_id(file_id)
1407
1390
if self.other_tree.has_id(file_id):
1408
1391
# OTHER changed the file
1410
if wt.supports_content_filtering():
1411
# We get the path from the working tree if it exists.
1412
# That fails though when OTHER is adding a file, so
1413
# we fall back to the other tree to find the path if
1414
# it doesn't exist locally.
1416
filter_tree_path = wt.id2path(file_id)
1417
except errors.NoSuchId:
1418
filter_tree_path = self.other_tree.id2path(file_id)
1420
# Skip the id2path lookup for older formats
1421
filter_tree_path = None
1422
transform.create_from_tree(self.tt, trans_id,
1423
self.other_tree, file_id,
1424
filter_tree_path=filter_tree_path)
1392
transform.create_from_tree(
1393
self.tt, trans_id, self.other_tree, file_id,
1394
filter_tree_path=self._get_filter_tree_path(file_id))
1425
1395
return 'done', None
1396
elif self.this_tree.has_id(file_id):
1427
1397
# OTHER deleted the file
1428
1398
return 'delete', None
1750
1751
osutils.rmtree(temp_dir)
1754
class PathNotInTree(errors.BzrError):
1756
_fmt = """Merge-into failed because %(tree)s does not contain %(path)s."""
1758
def __init__(self, path, tree):
1759
errors.BzrError.__init__(self, path=path, tree=tree)
1762
class MergeIntoMerger(Merger):
1763
"""Merger that understands other_tree will be merged into a subdir.
1765
This also changes the Merger api so that it uses real Branch, revision_id,
1766
and RevisonTree objects, rather than using revision specs.
1769
def __init__(self, this_tree, other_branch, other_tree, target_subdir,
1770
source_subpath, other_rev_id=None):
1771
"""Create a new MergeIntoMerger object.
1773
source_subpath in other_tree will be effectively copied to
1774
target_subdir in this_tree.
1776
:param this_tree: The tree that we will be merging into.
1777
:param other_branch: The Branch we will be merging from.
1778
:param other_tree: The RevisionTree object we want to merge.
1779
:param target_subdir: The relative path where we want to merge
1780
other_tree into this_tree
1781
:param source_subpath: The relative path specifying the subtree of
1782
other_tree to merge into this_tree.
1784
# It is assumed that we are merging a tree that is not in our current
1785
# ancestry, which means we are using the "EmptyTree" as our basis.
1786
null_ancestor_tree = this_tree.branch.repository.revision_tree(
1787
_mod_revision.NULL_REVISION)
1788
super(MergeIntoMerger, self).__init__(
1789
this_branch=this_tree.branch,
1790
this_tree=this_tree,
1791
other_tree=other_tree,
1792
base_tree=null_ancestor_tree,
1794
self._target_subdir = target_subdir
1795
self._source_subpath = source_subpath
1796
self.other_branch = other_branch
1797
if other_rev_id is None:
1798
other_rev_id = other_tree.get_revision_id()
1799
self.other_rev_id = self.other_basis = other_rev_id
1800
self.base_is_ancestor = True
1801
self.backup_files = True
1802
self.merge_type = Merge3Merger
1803
self.show_base = False
1804
self.reprocess = False
1805
self.interesting_ids = None
1806
self.merge_type = _MergeTypeParameterizer(MergeIntoMergeType,
1807
target_subdir=self._target_subdir,
1808
source_subpath=self._source_subpath)
1809
if self._source_subpath != '':
1810
# If this isn't a partial merge make sure the revisions will be
1812
self._maybe_fetch(self.other_branch, self.this_branch,
1815
def set_pending(self):
1816
if self._source_subpath != '':
1818
Merger.set_pending(self)
1821
class _MergeTypeParameterizer(object):
1822
"""Wrap a merge-type class to provide extra parameters.
1824
This is hack used by MergeIntoMerger to pass some extra parameters to its
1825
merge_type. Merger.do_merge() sets up its own set of parameters to pass to
1826
the 'merge_type' member. It is difficult override do_merge without
1827
re-writing the whole thing, so instead we create a wrapper which will pass
1828
the extra parameters.
1831
def __init__(self, merge_type, **kwargs):
1832
self._extra_kwargs = kwargs
1833
self._merge_type = merge_type
1835
def __call__(self, *args, **kwargs):
1836
kwargs.update(self._extra_kwargs)
1837
return self._merge_type(*args, **kwargs)
1839
def __getattr__(self, name):
1840
return getattr(self._merge_type, name)
1843
class MergeIntoMergeType(Merge3Merger):
1844
"""Merger that incorporates a tree (or part of a tree) into another."""
1846
def __init__(self, *args, **kwargs):
1847
"""Initialize the merger object.
1849
:param args: See Merge3Merger.__init__'s args.
1850
:param kwargs: See Merge3Merger.__init__'s keyword args, except for
1851
source_subpath and target_subdir.
1852
:keyword source_subpath: The relative path specifying the subtree of
1853
other_tree to merge into this_tree.
1854
:keyword target_subdir: The relative path where we want to merge
1855
other_tree into this_tree
1857
# All of the interesting work happens during Merge3Merger.__init__(),
1858
# so we have have to hack in to get our extra parameters set.
1859
self._source_subpath = kwargs.pop('source_subpath')
1860
self._target_subdir = kwargs.pop('target_subdir')
1861
super(MergeIntoMergeType, self).__init__(*args, **kwargs)
1863
def _compute_transform(self):
1864
child_pb = ui.ui_factory.nested_progress_bar()
1866
entries = self._entries_to_incorporate()
1867
entries = list(entries)
1868
for num, (entry, parent_id) in enumerate(entries):
1869
child_pb.update(gettext('Preparing file merge'), num, len(entries))
1870
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1871
trans_id = transform.new_by_entry(self.tt, entry,
1872
parent_trans_id, self.other_tree)
1875
self._finish_computing_transform()
1877
def _entries_to_incorporate(self):
1878
"""Yields pairs of (inventory_entry, new_parent)."""
1879
other_inv = self.other_tree.root_inventory
1880
subdir_id = other_inv.path2id(self._source_subpath)
1881
if subdir_id is None:
1882
# XXX: The error would be clearer if it gave the URL of the source
1883
# branch, but we don't have a reference to that here.
1884
raise PathNotInTree(self._source_subpath, "Source tree")
1885
subdir = other_inv[subdir_id]
1886
parent_in_target = osutils.dirname(self._target_subdir)
1887
target_id = self.this_tree.path2id(parent_in_target)
1888
if target_id is None:
1889
raise PathNotInTree(self._target_subdir, "Target tree")
1890
name_in_target = osutils.basename(self._target_subdir)
1891
merge_into_root = subdir.copy()
1892
merge_into_root.name = name_in_target
1893
if self.this_tree.has_id(merge_into_root.file_id):
1894
# Give the root a new file-id.
1895
# This can happen fairly easily if the directory we are
1896
# incorporating is the root, and both trees have 'TREE_ROOT' as
1897
# their root_id. Users will expect this to Just Work, so we
1898
# change the file-id here.
1899
# Non-root file-ids could potentially conflict too. That's really
1900
# an edge case, so we don't do anything special for those. We let
1901
# them cause conflicts.
1902
merge_into_root.file_id = generate_ids.gen_file_id(name_in_target)
1903
yield (merge_into_root, target_id)
1904
if subdir.kind != 'directory':
1905
# No children, so we are done.
1907
for ignored_path, entry in other_inv.iter_entries_by_dir(subdir_id):
1908
parent_id = entry.parent_id
1909
if parent_id == subdir.file_id:
1910
# The root's parent ID has changed, so make sure children of
1911
# the root refer to the new ID.
1912
parent_id = merge_into_root.file_id
1913
yield (entry, parent_id)
1753
1916
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1754
1917
backup_files=False,
1755
1918
merge_type=Merge3Merger,