93
100
return ('not applicable', None)
96
class ConfigurableFileMerger(AbstractPerFileMerger):
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):
97
157
"""Merge individual files when configured via a .conf file.
99
159
This is a base class for concrete custom file merging logic. Concrete
1043
1096
other_root = self.tt.trans_id_file_id(other_root_file_id)
1044
1097
if other_root == self.tt.root:
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():
1099
if self.other_tree.inventory.root.file_id in self.this_tree.inventory:
1100
# the other tree's root is a non-root in the current tree (as when
1101
# a previously unrelated branch is merged into another)
1103
if self.tt.final_kind(other_root) is not None:
1104
other_root_is_present = True
1106
# other_root doesn't have a physical representation. We still need
1107
# to move any references to the actual root of the tree.
1108
other_root_is_present = False
1109
# 'other_tree.inventory.root' is not present in this tree. We are
1110
# calling adjust_path for children which *want* to be present with a
1111
# correct place to go.
1112
for thing, child in self.other_tree.inventory.root.children.iteritems():
1059
1113
trans_id = self.tt.trans_id_file_id(child.file_id)
1060
self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
1114
if not other_root_is_present:
1115
if self.tt.final_kind(trans_id) is not None:
1116
# The item exist in the final tree and has a defined place
1119
# Move the item into the root
1120
self.tt.adjust_path(self.tt.final_name(trans_id),
1121
self.tt.root, trans_id)
1122
if other_root_is_present:
1123
self.tt.cancel_creation(other_root)
1124
self.tt.cancel_versioning(other_root)
1062
1126
def write_modified(self, results):
1063
1127
modified_hashes = {}
1228
1295
parent_id_winner = "other"
1229
1296
if name_winner == "this" and parent_id_winner == "this":
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))
1298
if name_winner == 'conflict' or parent_id_winner == 'conflict':
1299
# Creating helpers (.OTHER or .THIS) here cause problems down the
1300
# road if a ContentConflict needs to be created so we should not do
1302
trans_id = self.tt.trans_id_file_id(file_id)
1303
self._raw_conflicts.append(('path conflict', trans_id, file_id,
1304
this_parent, this_name,
1305
other_parent, other_name))
1239
1306
if other_name is None:
1240
1307
# it doesn't matter whether the result was 'other' or
1241
1308
# '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)
1245
1310
parent_id = parents[self.winner_idx[parent_id_winner]]
1246
1311
if parent_id is not None:
1247
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1312
# if we get here, name_winner and parent_winner are set to safe
1248
1314
self.tt.adjust_path(names[self.winner_idx[name_winner]],
1249
parent_trans_id, trans_id)
1315
self.tt.trans_id_file_id(parent_id),
1316
self.tt.trans_id_file_id(file_id))
1251
1318
def _do_merge_contents(self, file_id):
1252
1319
"""Performs a merge on file_id contents."""
1532
1593
def cook_conflicts(self, fs_conflicts):
1533
1594
"""Convert all conflicts into a form that doesn't depend on trans_id"""
1535
1595
self.cooked_conflicts.extend(transform.cook_conflicts(
1536
1596
fs_conflicts, self.tt))
1537
1597
fp = transform.FinalPaths(self.tt)
1538
1598
for conflict in self._raw_conflicts:
1539
1599
conflict_type = conflict[0]
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':
1600
if conflict_type == 'path conflict':
1602
this_parent, this_name,
1603
other_parent, other_name) = conflict[1:]
1604
if this_parent is None or this_name is None:
1605
this_path = '<deleted>'
1607
parent_path = fp.get_path(
1608
self.tt.trans_id_file_id(this_parent))
1609
this_path = osutils.pathjoin(parent_path, this_name)
1610
if other_parent is None or other_name is None:
1611
other_path = '<deleted>'
1613
parent_path = fp.get_path(
1614
self.tt.trans_id_file_id(other_parent))
1615
other_path = osutils.pathjoin(parent_path, other_name)
1616
c = _mod_conflicts.Conflict.factory(
1617
'path conflict', path=this_path,
1618
conflict_path=other_path,
1620
elif conflict_type == 'contents conflict':
1548
1621
for trans_id in conflict[1]:
1549
1622
file_id = self.tt.final_file_id(trans_id)
1550
1623
if file_id is not None:
1557
1630
c = _mod_conflicts.Conflict.factory(conflict_type,
1558
1631
path=path, file_id=file_id)
1559
self.cooked_conflicts.append(c)
1560
if conflict_type == 'text conflict':
1632
elif conflict_type == 'text conflict':
1561
1633
trans_id = conflict[1]
1562
1634
path = fp.get_path(trans_id)
1563
1635
file_id = self.tt.final_file_id(trans_id)
1564
1636
c = _mod_conflicts.Conflict.factory(conflict_type,
1565
1637
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)
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,
1639
raise AssertionError('bad conflict type: %r' % (conflict,))
1593
1640
self.cooked_conflicts.append(c)
1594
1641
self.cooked_conflicts.sort(key=_mod_conflicts.Conflict.sort_key)
1701
1748
osutils.rmtree(temp_dir)
1751
class PathNotInTree(errors.BzrError):
1753
_fmt = """Merge-into failed because %(tree)s does not contain %(path)s."""
1755
def __init__(self, path, tree):
1756
errors.BzrError.__init__(self, path=path, tree=tree)
1759
class MergeIntoMerger(Merger):
1760
"""Merger that understands other_tree will be merged into a subdir.
1762
This also changes the Merger api so that it uses real Branch, revision_id,
1763
and RevisonTree objects, rather than using revision specs.
1766
def __init__(self, this_tree, other_branch, other_tree, target_subdir,
1767
source_subpath, other_rev_id=None):
1768
"""Create a new MergeIntoMerger object.
1770
source_subpath in other_tree will be effectively copied to
1771
target_subdir in this_tree.
1773
:param this_tree: The tree that we will be merging into.
1774
:param other_branch: The Branch we will be merging from.
1775
:param other_tree: The RevisionTree object we want to merge.
1776
:param target_subdir: The relative path where we want to merge
1777
other_tree into this_tree
1778
:param source_subpath: The relative path specifying the subtree of
1779
other_tree to merge into this_tree.
1781
# It is assumed that we are merging a tree that is not in our current
1782
# ancestry, which means we are using the "EmptyTree" as our basis.
1783
null_ancestor_tree = this_tree.branch.repository.revision_tree(
1784
_mod_revision.NULL_REVISION)
1785
super(MergeIntoMerger, self).__init__(
1786
this_branch=this_tree.branch,
1787
this_tree=this_tree,
1788
other_tree=other_tree,
1789
base_tree=null_ancestor_tree,
1791
self._target_subdir = target_subdir
1792
self._source_subpath = source_subpath
1793
self.other_branch = other_branch
1794
if other_rev_id is None:
1795
other_rev_id = other_tree.get_revision_id()
1796
self.other_rev_id = self.other_basis = other_rev_id
1797
self.base_is_ancestor = True
1798
self.backup_files = True
1799
self.merge_type = Merge3Merger
1800
self.show_base = False
1801
self.reprocess = False
1802
self.interesting_ids = None
1803
self.merge_type = _MergeTypeParameterizer(MergeIntoMergeType,
1804
target_subdir=self._target_subdir,
1805
source_subpath=self._source_subpath)
1806
if self._source_subpath != '':
1807
# If this isn't a partial merge make sure the revisions will be
1809
self._maybe_fetch(self.other_branch, self.this_branch,
1812
def set_pending(self):
1813
if self._source_subpath != '':
1815
Merger.set_pending(self)
1818
class _MergeTypeParameterizer(object):
1819
"""Wrap a merge-type class to provide extra parameters.
1821
This is hack used by MergeIntoMerger to pass some extra parameters to its
1822
merge_type. Merger.do_merge() sets up its own set of parameters to pass to
1823
the 'merge_type' member. It is difficult override do_merge without
1824
re-writing the whole thing, so instead we create a wrapper which will pass
1825
the extra parameters.
1828
def __init__(self, merge_type, **kwargs):
1829
self._extra_kwargs = kwargs
1830
self._merge_type = merge_type
1832
def __call__(self, *args, **kwargs):
1833
kwargs.update(self._extra_kwargs)
1834
return self._merge_type(*args, **kwargs)
1836
def __getattr__(self, name):
1837
return getattr(self._merge_type, name)
1840
class MergeIntoMergeType(Merge3Merger):
1841
"""Merger that incorporates a tree (or part of a tree) into another."""
1843
def __init__(self, *args, **kwargs):
1844
"""Initialize the merger object.
1846
:param args: See Merge3Merger.__init__'s args.
1847
:param kwargs: See Merge3Merger.__init__'s keyword args, except for
1848
source_subpath and target_subdir.
1849
:keyword source_subpath: The relative path specifying the subtree of
1850
other_tree to merge into this_tree.
1851
:keyword target_subdir: The relative path where we want to merge
1852
other_tree into this_tree
1854
# All of the interesting work happens during Merge3Merger.__init__(),
1855
# so we have have to hack in to get our extra parameters set.
1856
self._source_subpath = kwargs.pop('source_subpath')
1857
self._target_subdir = kwargs.pop('target_subdir')
1858
super(MergeIntoMergeType, self).__init__(*args, **kwargs)
1860
def _compute_transform(self):
1861
child_pb = ui.ui_factory.nested_progress_bar()
1863
entries = self._entries_to_incorporate()
1864
entries = list(entries)
1865
for num, (entry, parent_id) in enumerate(entries):
1866
child_pb.update('Preparing file merge', num, len(entries))
1867
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1868
trans_id = transform.new_by_entry(self.tt, entry,
1869
parent_trans_id, self.other_tree)
1872
self._finish_computing_transform()
1874
def _entries_to_incorporate(self):
1875
"""Yields pairs of (inventory_entry, new_parent)."""
1876
other_inv = self.other_tree.inventory
1877
subdir_id = other_inv.path2id(self._source_subpath)
1878
if subdir_id is None:
1879
# XXX: The error would be clearer if it gave the URL of the source
1880
# branch, but we don't have a reference to that here.
1881
raise PathNotInTree(self._source_subpath, "Source tree")
1882
subdir = other_inv[subdir_id]
1883
parent_in_target = osutils.dirname(self._target_subdir)
1884
target_id = self.this_tree.inventory.path2id(parent_in_target)
1885
if target_id is None:
1886
raise PathNotInTree(self._target_subdir, "Target tree")
1887
name_in_target = osutils.basename(self._target_subdir)
1888
merge_into_root = subdir.copy()
1889
merge_into_root.name = name_in_target
1890
if merge_into_root.file_id in self.this_tree.inventory:
1891
# Give the root a new file-id.
1892
# This can happen fairly easily if the directory we are
1893
# incorporating is the root, and both trees have 'TREE_ROOT' as
1894
# their root_id. Users will expect this to Just Work, so we
1895
# change the file-id here.
1896
# Non-root file-ids could potentially conflict too. That's really
1897
# an edge case, so we don't do anything special for those. We let
1898
# them cause conflicts.
1899
merge_into_root.file_id = generate_ids.gen_file_id(name_in_target)
1900
yield (merge_into_root, target_id)
1901
if subdir.kind != 'directory':
1902
# No children, so we are done.
1904
for ignored_path, entry in other_inv.iter_entries_by_dir(subdir_id):
1905
parent_id = entry.parent_id
1906
if parent_id == subdir.file_id:
1907
# The root's parent ID has changed, so make sure children of
1908
# the root refer to the new ID.
1909
parent_id = merge_into_root.file_id
1910
yield (entry, parent_id)
1704
1913
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1705
1914
backup_files=False,
1706
1915
merge_type=Merge3Merger,
added
removed
bzrlib/merge.py
