64
57
def __init__(self):
65
58
hooks.Hooks.__init__(self)
66
59
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 "
60
"Called when file content needs to be merged (including when one "
61
"side has deleted the file and the other has changed it)."
62
"merge_file_content is called with a "
63
"bzrlib.merge.MergeHookParams. The function should return a tuple "
64
"of (status, lines), where status is one of 'not_applicable', "
65
"'success', 'conflicted', or 'delete'. If status is success or "
66
"conflicted, then lines should be an iterable of strings of the "
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
71
class MergeHookParams(object):
224
72
"""Object holding parameters passed to merge_file_content hooks.
226
There are some fields hooks can access:
74
There are 3 fields hooks can access:
76
:ivar merger: the Merger object
228
77
:ivar file_id: the file ID of the file being merged
229
78
:ivar trans_id: the transform ID for the merge of this file
230
79
:ivar this_kind: kind of file_id in 'this' tree
794
652
# making sure we haven't missed any corner cases.
795
653
# if lca_trees is None:
796
654
# self._lca_trees = [self.base_tree]
797
657
self.change_reporter = change_reporter
798
658
self.cherrypick = cherrypick
660
self.pp = progress.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
664
def do_merge(self):
807
operation = OperationWithCleanups(self._do_merge)
808
665
self.this_tree.lock_tree_write()
809
operation.add_cleanup(self.this_tree.unlock)
810
666
self.base_tree.lock_read()
811
operation.add_cleanup(self.base_tree.unlock)
812
667
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)
823
self.this_tree.add_conflicts(self.cooked_conflicts)
824
except errors.UnsupportedOperation:
669
self.tt = transform.TreeTransform(self.this_tree, self.pb)
672
self._compute_transform()
674
results = self.tt.apply(no_conflicts=True)
675
self.write_modified(results)
677
self.this_tree.add_conflicts(self.cooked_conflicts)
678
except errors.UnsupportedOperation:
683
self.other_tree.unlock()
684
self.base_tree.unlock()
685
self.this_tree.unlock()
827
688
def make_preview_transform(self):
828
operation = OperationWithCleanups(self._make_preview_transform)
829
689
self.base_tree.lock_read()
830
operation.add_cleanup(self.base_tree.unlock)
831
690
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
691
self.tt = transform.TransformPreview(self.this_tree)
837
self._compute_transform()
694
self._compute_transform()
697
self.other_tree.unlock()
698
self.base_tree.unlock()
840
702
def _compute_transform(self):
1098
953
other_root = self.tt.trans_id_file_id(other_root_file_id)
1099
954
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
957
self.tt.final_kind(other_root)
1107
other_root_is_present = True
1108
958
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():
960
if self.this_tree.has_id(self.other_tree.inventory.root.file_id):
961
# the other tree's root is a non-root in the current tree
963
self.reparent_children(self.other_tree.inventory.root, self.tt.root)
964
self.tt.cancel_creation(other_root)
965
self.tt.cancel_versioning(other_root)
967
def reparent_children(self, ie, target):
968
for thing, child in ie.children.iteritems():
1116
969
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)
970
self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
1134
972
def write_modified(self, results):
1135
973
modified_hashes = {}
1303
1138
parent_id_winner = "other"
1304
1139
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))
1141
if name_winner == "conflict":
1142
trans_id = self.tt.trans_id_file_id(file_id)
1143
self._raw_conflicts.append(('name conflict', trans_id,
1144
this_name, other_name))
1145
if parent_id_winner == "conflict":
1146
trans_id = self.tt.trans_id_file_id(file_id)
1147
self._raw_conflicts.append(('parent conflict', trans_id,
1148
this_parent, other_parent))
1314
1149
if other_name is None:
1315
1150
# it doesn't matter whether the result was 'other' or
1316
1151
# 'conflict'-- if there's no 'other', we leave it alone.
1153
# if we get here, name_winner and parent_winner are set to safe values.
1154
trans_id = self.tt.trans_id_file_id(file_id)
1318
1155
parent_id = parents[self.winner_idx[parent_id_winner]]
1319
1156
if parent_id is not None:
1320
# if we get here, name_winner and parent_winner are set to safe
1157
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1322
1158
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))
1159
parent_trans_id, trans_id)
1326
def _do_merge_contents(self, file_id):
1161
def merge_contents(self, file_id):
1327
1162
"""Performs a merge on file_id contents."""
1328
1163
def contents_pair(tree):
1329
1164
if file_id not in tree:
1607
1439
def cook_conflicts(self, fs_conflicts):
1608
1440
"""Convert all conflicts into a form that doesn't depend on trans_id"""
1609
1442
self.cooked_conflicts.extend(transform.cook_conflicts(
1610
1443
fs_conflicts, self.tt))
1611
1444
fp = transform.FinalPaths(self.tt)
1612
1445
for conflict in self._raw_conflicts:
1613
1446
conflict_type = conflict[0]
1614
if conflict_type == 'path conflict':
1616
this_parent, this_name,
1617
other_parent, other_name) = conflict[1:]
1618
if this_parent is None or this_name is None:
1619
this_path = '<deleted>'
1621
parent_path = fp.get_path(
1622
self.tt.trans_id_file_id(this_parent))
1623
this_path = osutils.pathjoin(parent_path, this_name)
1624
if other_parent is None or other_name is None:
1625
other_path = '<deleted>'
1627
parent_path = fp.get_path(
1628
self.tt.trans_id_file_id(other_parent))
1629
other_path = osutils.pathjoin(parent_path, other_name)
1630
c = _mod_conflicts.Conflict.factory(
1631
'path conflict', path=this_path,
1632
conflict_path=other_path,
1634
elif conflict_type == 'contents conflict':
1447
if conflict_type in ('name conflict', 'parent conflict'):
1448
trans_id = conflict[1]
1449
conflict_args = conflict[2:]
1450
if trans_id not in name_conflicts:
1451
name_conflicts[trans_id] = {}
1452
transform.unique_add(name_conflicts[trans_id], conflict_type,
1454
if conflict_type == 'contents conflict':
1635
1455
for trans_id in conflict[1]:
1636
1456
file_id = self.tt.final_file_id(trans_id)
1637
1457
if file_id is not None:
1644
1464
c = _mod_conflicts.Conflict.factory(conflict_type,
1645
1465
path=path, file_id=file_id)
1646
elif conflict_type == 'text conflict':
1466
self.cooked_conflicts.append(c)
1467
if conflict_type == 'text conflict':
1647
1468
trans_id = conflict[1]
1648
1469
path = fp.get_path(trans_id)
1649
1470
file_id = self.tt.final_file_id(trans_id)
1650
1471
c = _mod_conflicts.Conflict.factory(conflict_type,
1651
1472
path=path, file_id=file_id)
1473
self.cooked_conflicts.append(c)
1475
for trans_id, conflicts in name_conflicts.iteritems():
1477
this_parent, other_parent = conflicts['parent conflict']
1478
if this_parent == other_parent:
1479
raise AssertionError()
1481
this_parent = other_parent = \
1482
self.tt.final_file_id(self.tt.final_parent(trans_id))
1484
this_name, other_name = conflicts['name conflict']
1485
if this_name == other_name:
1486
raise AssertionError()
1488
this_name = other_name = self.tt.final_name(trans_id)
1489
other_path = fp.get_path(trans_id)
1490
if this_parent is not None and this_name is not None:
1491
this_parent_path = \
1492
fp.get_path(self.tt.trans_id_file_id(this_parent))
1493
this_path = osutils.pathjoin(this_parent_path, this_name)
1653
raise AssertionError('bad conflict type: %r' % (conflict,))
1495
this_path = "<deleted>"
1496
file_id = self.tt.final_file_id(trans_id)
1497
c = _mod_conflicts.Conflict.factory('path conflict', path=this_path,
1498
conflict_path=other_path,
1654
1500
self.cooked_conflicts.append(c)
1655
1501
self.cooked_conflicts.sort(key=_mod_conflicts.Conflict.sort_key)
1762
1608
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
1611
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1928
1612
backup_files=False,
1929
1613
merge_type=Merge3Merger,
added
removed
bzrlib/merge.py
