39
from bzrlib.cleanup import OperationWithCleanups
40
from bzrlib.symbol_versioning import (
42
from breezy.bzr import (
45
from breezy.i18n import gettext
44
57
# TODO: Report back as changes are merged in
47
def transform_tree(from_tree, to_tree, interesting_ids=None):
60
def transform_tree(from_tree, to_tree, interesting_files=None):
48
61
from_tree.lock_tree_write()
49
operation = OperationWithCleanups(merge_inner)
62
operation = cleanup.OperationWithCleanups(merge_inner)
50
63
operation.add_cleanup(from_tree.unlock)
51
64
operation.run_simple(from_tree.branch, to_tree, from_tree,
52
ignore_zero=True, interesting_ids=interesting_ids, this_tree=from_tree)
65
ignore_zero=True, this_tree=from_tree,
66
interesting_files=interesting_files)
55
69
class MergeHooks(hooks.Hooks):
57
71
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 "
72
hooks.Hooks.__init__(self, "breezy.merge", "Merger.hooks")
73
self.add_hook('merge_file_content',
74
"Called with a breezy.merge.Merger object to create a per file "
61
75
"merge object when starting a merge. "
62
76
"Should return either None or a subclass of "
63
"``bzrlib.merge.AbstractPerFileMerger``. "
77
"``breezy.merge.AbstractPerFileMerger``. "
64
78
"Such objects will then be called per file "
65
79
"that needs to be merged (including when one "
66
80
"side has deleted the file and the other has changed it). "
67
81
"See the AbstractPerFileMerger API docs for details on how it is "
84
self.add_hook('pre_merge',
85
'Called before a merge. '
86
'Receives a Merger object as the single argument.',
88
self.add_hook('post_merge',
89
'Called after a merge. '
90
'Receives a Merger object as the single argument. '
91
'The return value is ignored.',
72
95
class AbstractPerFileMerger(object):
73
"""PerFileMerger objects are used by plugins extending merge for bzrlib.
75
See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
96
"""PerFileMerger objects are used by plugins extending merge for breezy.
98
See ``breezy.plugins.news_merge.news_merge`` for an example concrete class.
77
100
:ivar merger: The Merge3Merger performing the merge.
435
442
revision_id = _mod_revision.ensure_null(revision_id)
436
443
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
445
def set_interesting_files(self, file_list):
487
446
self.interesting_files = file_list
839
808
entries = self._entries_lca()
840
809
resolver = self._lca_multi_way
841
child_pb = ui.ui_factory.nested_progress_bar()
843
factories = Merger.hooks['merge_file_content']
844
hooks = [factory(self) for factory in factories] + [self]
845
self.active_hooks = [hook for hook in hooks if hook is not None]
846
for num, (file_id, changed, parents3, names3,
810
# Prepare merge hooks
811
factories = Merger.hooks['merge_file_content']
812
# One hook for each registered one plus our default merger
813
hooks = [factory(self) for factory in factories] + [self]
814
self.active_hooks = [hook for hook in hooks if hook is not None]
815
with ui.ui_factory.nested_progress_bar() as child_pb:
816
for num, (file_id, changed, paths3, parents3, names3,
847
817
executable3) in enumerate(entries):
848
child_pb.update('Preparing file merge', num, len(entries))
849
self._merge_names(file_id, parents3, names3, resolver=resolver)
818
# Try merging each entry
819
child_pb.update(gettext('Preparing file merge'),
821
self._merge_names(file_id, paths3, parents3, names3, resolver=resolver)
851
file_status = self._do_merge_contents(file_id)
823
file_status = self._do_merge_contents(paths3, file_id)
853
825
file_status = 'unmodified'
854
self._merge_executable(file_id,
855
executable3, file_status, resolver=resolver)
859
child_pb = ui.ui_factory.nested_progress_bar()
826
self._merge_executable(paths3, file_id, executable3,
827
file_status, resolver=resolver)
828
self.tt.fixup_new_roots()
829
self._finish_computing_transform()
831
def _finish_computing_transform(self):
832
"""Finalize the transform and report the changes.
834
This is the second half of _compute_transform.
836
with ui.ui_factory.nested_progress_bar() as child_pb:
861
837
fs_conflicts = transform.resolve_conflicts(self.tt, child_pb,
862
838
lambda t, c: transform.conflict_pass(t, c, self.other_tree))
865
839
if self.change_reporter is not None:
866
from bzrlib import delta
840
from breezy import delta
867
841
delta.report_changes(
868
842
self.tt.iter_changes(), self.change_reporter)
869
843
self.cook_conflicts(fs_conflicts)
870
844
for conflict in self.cooked_conflicts:
871
trace.warning(conflict)
845
trace.warning('%s', conflict.describe())
873
847
def _entries3(self):
874
848
"""Gather data about files modified between three trees.
883
857
iterator = self.other_tree.iter_changes(self.base_tree,
884
include_unchanged=True, specific_files=self.interesting_files,
858
specific_files=self.interesting_files,
885
859
extra_trees=[self.this_tree])
886
this_entries = dict((e.file_id, e) for p, e in
887
self.this_tree.iter_entries_by_dir(
888
self.interesting_ids))
860
this_interesting_files = self.this_tree.find_related_paths_across_trees(
861
self.interesting_files, trees=[self.other_tree])
862
this_entries = dict(self.this_tree.iter_entries_by_dir(
863
specific_files=this_interesting_files))
889
864
for (file_id, paths, changed, versioned, parents, names, kind,
890
865
executable) in iterator:
891
if (self.interesting_ids is not None and
892
file_id not in self.interesting_ids):
894
entry = this_entries.get(file_id)
895
if entry is not None:
896
this_name = entry.name
897
this_parent = entry.parent_id
898
this_executable = entry.executable
866
if paths[0] is not None:
867
this_path = _mod_tree.find_previous_path(
868
self.base_tree, self.this_tree, paths[0])
870
this_path = _mod_tree.find_previous_path(
871
self.other_tree, self.this_tree, paths[1])
872
this_entry = this_entries.get(this_path)
873
if this_entry is not None:
874
this_name = this_entry.name
875
this_parent = this_entry.parent_id
876
this_executable = this_entry.executable
901
879
this_parent = None
902
880
this_executable = None
903
881
parents3 = parents + (this_parent,)
904
882
names3 = names + (this_name,)
883
paths3 = paths + (this_path, )
905
884
executable3 = executable + (this_executable,)
906
result.append((file_id, changed, parents3, names3, executable3))
885
result.append((file_id, changed, paths3, parents3, names3, executable3))
909
888
def _entries_lca(self):
913
892
it then compares with THIS and BASE.
915
894
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)
896
:return: [(file_id, changed, paths, parents, names, executable)], where:
898
* file_id: Simple file_id of the entry
899
* changed: Boolean, True if the kind or contents changed else False
900
* paths: ((base, [path, in, lcas]), path_other, path_this)
901
* parents: ((base, [parent_id, in, lcas]), parent_id_other,
903
* names: ((base, [name, in, lcas]), name_in_other, name_in_this)
904
* executable: ((base, [exec, in, lcas]), exec_in_other,
925
907
if self.interesting_files is not None:
926
908
lookup_trees = [self.this_tree, self.base_tree]
927
909
lookup_trees.extend(self._lca_trees)
928
910
# I think we should include the lca trees as well
929
interesting_ids = self.other_tree.paths2ids(self.interesting_files,
911
interesting_files = self.other_tree.find_related_paths_across_trees(
912
self.interesting_files, lookup_trees)
932
interesting_ids = self.interesting_ids
914
interesting_files = None
934
916
walker = _mod_tree.MultiWalker(self.other_tree, self._lca_trees)
936
base_inventory = self.base_tree.inventory
937
this_inventory = self.this_tree.inventory
918
base_inventory = self.base_tree.root_inventory
919
this_inventory = self.this_tree.root_inventory
938
920
for path, file_id, other_ie, lca_values in walker.iter_all():
939
921
# Is this modified at all from any of the other trees?
940
922
if other_ie is None:
941
923
other_ie = _none_entry
942
if interesting_ids is not None and file_id not in interesting_ids:
926
other_path = self.other_tree.id2path(file_id)
927
if interesting_files is not None and other_path not in interesting_files:
945
930
# If other_revision is found in any of the lcas, that means this
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
1074
def write_modified(self, results):
1075
if not self.working_tree.supports_merge_modified():
1123
1077
modified_hashes = {}
1124
1078
for path in results.modified_paths:
1125
file_id = self.this_tree.path2id(self.this_tree.relpath(path))
1079
wt_relpath = self.working_tree.relpath(path)
1080
file_id = self.working_tree.path2id(wt_relpath)
1126
1081
if file_id is None:
1128
hash = self.this_tree.get_file_sha1(file_id)
1083
hash = self.working_tree.get_file_sha1(wt_relpath, file_id)
1129
1084
if hash is None:
1131
1086
modified_hashes[file_id] = hash
1132
self.this_tree.set_merge_modified(modified_hashes)
1087
self.working_tree.set_merge_modified(modified_hashes)
1135
1090
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 other_path is None:
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
def _do_merge_contents(self, file_id):
1264
def _do_merge_contents(self, paths, file_id):
1315
1265
"""Performs a merge on file_id contents."""
1316
def contents_pair(tree):
1317
if file_id not in tree:
1319
kind = tree.kind(file_id)
1266
def contents_pair(tree, path):
1270
kind = tree.kind(path, file_id)
1271
except errors.NoSuchFile:
1320
1273
if kind == "file":
1321
contents = tree.get_file_sha1(file_id)
1274
contents = tree.get_file_sha1(path, file_id)
1322
1275
elif kind == "symlink":
1323
contents = tree.get_symlink_target(file_id)
1276
contents = tree.get_symlink_target(path, file_id)
1325
1278
contents = None
1326
1279
return kind, contents
1281
base_path, other_path, this_path = paths
1328
1282
# See SPOT run. run, SPOT, run.
1329
1283
# So we're not QUITE repeating ourselves; we do tricky things with
1331
base_pair = contents_pair(self.base_tree)
1332
other_pair = contents_pair(self.other_tree)
1285
other_pair = contents_pair(self.other_tree, other_path)
1286
this_pair = contents_pair(self.this_tree, this_path)
1333
1287
if self._lca_trees:
1334
this_pair = contents_pair(self.this_tree)
1335
lca_pairs = [contents_pair(tree) for tree in self._lca_trees]
1288
(base_path, lca_paths) = base_path
1289
base_pair = contents_pair(self.base_tree, base_path)
1290
lca_pairs = [contents_pair(tree, path)
1291
for tree, path in zip(self._lca_trees, lca_paths)]
1336
1292
winner = self._lca_multi_way((base_pair, lca_pairs), other_pair,
1337
1293
this_pair, allow_overriding_lca=False)
1295
base_pair = contents_pair(self.base_tree, base_path)
1339
1296
if base_pair == other_pair:
1340
1297
winner = 'this'
1342
1299
# We delayed evaluating this_pair as long as we can to avoid
1343
1300
# unnecessary sha1 calculation
1344
this_pair = contents_pair(self.this_tree)
1301
this_pair = contents_pair(self.this_tree, this_path)
1345
1302
winner = self._three_way(base_pair, other_pair, this_pair)
1346
1303
if winner == 'this':
1347
1304
# No interesting changes introduced by OTHER
1358
1317
if hook_status != 'not_applicable':
1359
1318
# Don't try any more hooks, this one applies.
1320
# If the merge ends up replacing the content of the file, we get rid of
1321
# it at the end of this method (this variable is used to track the
1322
# exceptions to this rule).
1361
1324
result = "modified"
1362
1325
if hook_status == 'not_applicable':
1363
# This is a contents conflict, because none of the available
1364
# functions could merge it.
1326
# No merge hook was able to resolve the situation. Two cases exist:
1327
# a content conflict or a duplicate one.
1366
1329
name = self.tt.final_name(trans_id)
1367
1330
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))
1332
inhibit_content_conflict = False
1333
if params.this_kind is None: # file_id is not in THIS
1334
# Is the name used for a different file_id ?
1335
if self.this_tree.is_versioned(other_path):
1336
# Two entries for the same path
1338
# versioning the merged file will trigger a duplicate
1340
self.tt.version_file(file_id, trans_id)
1341
transform.create_from_tree(
1342
self.tt, trans_id, self.other_tree,
1343
other_path, file_id=file_id,
1344
filter_tree_path=self._get_filter_tree_path(file_id))
1345
inhibit_content_conflict = True
1346
elif params.other_kind is None: # file_id is not in OTHER
1347
# Is the name used for a different file_id ?
1348
if self.other_tree.is_versioned(this_path):
1349
# Two entries for the same path again, but here, the other
1350
# entry will also be merged. We simply inhibit the
1351
# 'content' conflict creation because we know OTHER will
1352
# create (or has already created depending on ordering) an
1353
# entry at the same path. This will trigger a 'duplicate'
1356
inhibit_content_conflict = True
1357
if not inhibit_content_conflict:
1358
if params.this_kind is not None:
1359
self.tt.unversion_file(trans_id)
1360
# This is a contents conflict, because none of the available
1361
# functions could merge it.
1362
file_group = self._dump_conflicts(
1363
name, (base_path, other_path, this_path), parent_id,
1364
file_id, set_version=True)
1365
self._raw_conflicts.append(('contents conflict', file_group))
1373
1366
elif hook_status == 'success':
1374
1367
self.tt.create_file(lines, trans_id)
1375
1368
elif hook_status == 'conflicted':
1444
1423
# BASE is a file, or both converted to files, so at least we
1445
1424
# have agreement that output should be a file.
1447
self.text_merge(merge_hook_params.file_id,
1448
merge_hook_params.trans_id)
1426
self.text_merge(merge_hook_params.trans_id,
1427
merge_hook_params.paths, merge_hook_params.file_id)
1449
1428
except errors.BinaryFile:
1450
1429
return 'not_applicable', None
1451
1430
return 'done', None
1453
1432
return 'not_applicable', None
1455
def get_lines(self, tree, file_id):
1434
def get_lines(self, tree, path, file_id=None):
1456
1435
"""Return the lines in a file, or an empty list."""
1457
if tree.has_id(file_id):
1458
return tree.get_file(file_id).readlines()
1439
kind = tree.kind(path, file_id)
1440
except errors.NoSuchFile:
1445
return tree.get_file_lines(path, file_id)
1462
def text_merge(self, file_id, trans_id):
1447
def text_merge(self, trans_id, paths, file_id):
1463
1448
"""Perform a three-way text merge on a file_id"""
1464
1449
# it's possible that we got here with base as a different type.
1465
1450
# if so, we just want two-way text conflicts.
1466
if self.base_tree.has_id(file_id) and \
1467
self.base_tree.kind(file_id) == "file":
1468
base_lines = self.get_lines(self.base_tree, file_id)
1471
other_lines = self.get_lines(self.other_tree, file_id)
1472
this_lines = self.get_lines(self.this_tree, file_id)
1451
base_path, other_path, this_path = paths
1452
base_lines = self.get_lines(self.base_tree, base_path, file_id)
1453
other_lines = self.get_lines(self.other_tree, other_path, file_id)
1454
this_lines = self.get_lines(self.this_tree, this_path, file_id)
1473
1455
m3 = merge3.Merge3(base_lines, this_lines, other_lines,
1474
1456
is_cherrypick=self.cherrypick)
1475
start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
1457
start_marker = b"!START OF MERGE CONFLICT!" + b"I HOPE THIS IS UNIQUE"
1476
1458
if self.show_base is True:
1477
1459
base_marker = '|' * 7
1532
1528
versioned = False
1533
1529
file_group = []
1534
for suffix, tree, lines in data:
1535
if tree.has_id(file_id):
1536
trans_id = self._conflict_file(name, parent_id, tree, file_id,
1537
suffix, lines, filter_tree_path)
1530
for suffix, tree, path, lines in data:
1531
if path is not None:
1532
trans_id = self._conflict_file(
1533
name, parent_id, path, tree, file_id, suffix, lines,
1538
1535
file_group.append(trans_id)
1539
1536
if set_version and not versioned:
1540
1537
self.tt.version_file(file_id, trans_id)
1541
1538
versioned = True
1542
1539
return file_group
1544
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
1541
def _conflict_file(self, name, parent_id, path, tree, file_id, suffix,
1545
1542
lines=None, filter_tree_path=None):
1546
1543
"""Emit a single conflict file."""
1547
1544
name = name + '.' + suffix
1548
1545
trans_id = self.tt.create_path(name, parent_id)
1549
transform.create_from_tree(self.tt, trans_id, tree, file_id, lines,
1546
transform.create_from_tree(
1547
self.tt, trans_id, tree, path,
1548
file_id=file_id, chunks=lines,
1549
filter_tree_path=filter_tree_path)
1551
1550
return trans_id
1553
def merge_executable(self, file_id, file_status):
1552
def merge_executable(self, paths, file_id, file_status):
1554
1553
"""Perform a merge on the execute bit."""
1555
executable = [self.executable(t, file_id) for t in (self.base_tree,
1556
self.other_tree, self.this_tree)]
1557
self._merge_executable(file_id, executable, file_status,
1554
executable = [self.executable(t, p, file_id) for t, p in zip([self.base_tree,
1555
self.other_tree, self.this_tree], paths)]
1556
self._merge_executable(paths, file_id, executable, file_status,
1558
1557
resolver=self._three_way)
1560
def _merge_executable(self, file_id, executable, file_status,
1559
def _merge_executable(self, paths, file_id, executable, file_status,
1562
1561
"""Perform a merge on the execute bit."""
1563
1562
base_executable, other_executable, this_executable = executable
1563
base_path, other_path, this_path = paths
1564
1564
if file_status == "deleted":
1566
1566
winner = resolver(*executable)
1567
1567
if winner == "conflict":
1568
1568
# There must be a None in here, if we have a conflict, but we
1569
1569
# need executability since file status was not deleted.
1570
if self.executable(self.other_tree, file_id) is None:
1570
if other_path is None:
1571
1571
winner = "this"
1573
1573
winner = "other"
1574
1574
if winner == 'this' and file_status != "modified":
1576
1576
trans_id = self.tt.trans_id_file_id(file_id)
1578
if self.tt.final_kind(trans_id) != "file":
1580
except errors.NoSuchFile:
1577
if self.tt.final_kind(trans_id) != "file":
1582
1579
if winner == "this":
1583
1580
executability = this_executable
1585
if self.other_tree.has_id(file_id):
1582
if other_path is not None:
1586
1583
executability = other_executable
1587
elif self.this_tree.has_id(file_id):
1584
elif this_path is not None:
1588
1585
executability = this_executable
1589
elif self.base_tree_has_id(file_id):
1586
elif base_path is not None:
1590
1587
executability = base_executable
1591
1588
if executability is not None:
1592
1589
trans_id = self.tt.trans_id_file_id(file_id)
1710
1731
class Diff3Merger(Merge3Merger):
1711
1732
"""Three-way merger using external diff3 for text merging"""
1713
def dump_file(self, temp_dir, name, tree, file_id):
1734
requires_file_merge_plan = False
1736
def dump_file(self, temp_dir, name, tree, path, file_id=None):
1714
1737
out_path = osutils.pathjoin(temp_dir, name)
1715
out_file = open(out_path, "wb")
1717
in_file = tree.get_file(file_id)
1738
with open(out_path, "wb") as out_file:
1739
in_file = tree.get_file(path, file_id=None)
1718
1740
for line in in_file:
1719
1741
out_file.write(line)
1722
1742
return out_path
1724
def text_merge(self, file_id, trans_id):
1744
def text_merge(self, trans_id, paths, file_id):
1725
1745
"""Perform a diff3 merge using a specified file-id and trans-id.
1726
1746
If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
1727
1747
will be dumped, and a will be conflict noted.
1750
base_path, other_path, this_path = paths
1730
1751
temp_dir = osutils.mkdtemp(prefix="bzr-")
1732
1753
new_file = osutils.pathjoin(temp_dir, "new")
1733
this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
1734
base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
1735
other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
1736
status = bzrlib.patch.diff3(new_file, this, base, other)
1754
this = self.dump_file(temp_dir, "this", self.this_tree, this_path, file_id)
1755
base = self.dump_file(temp_dir, "base", self.base_tree, base_path, file_id)
1756
other = self.dump_file(temp_dir, "other", self.other_tree, other_path, file_id)
1757
status = breezy.patch.diff3(new_file, this, base, other)
1737
1758
if status not in (0, 1):
1738
1759
raise errors.BzrError("Unhandled diff3 exit code")
1739
f = open(new_file, 'rb')
1760
with open(new_file, 'rb') as f:
1741
1761
self.tt.create_file(f, trans_id)
1744
1762
if status == 1:
1745
1763
name = self.tt.final_name(trans_id)
1746
1764
parent_id = self.tt.final_parent(trans_id)
1747
self._dump_conflicts(name, parent_id, file_id)
1765
self._dump_conflicts(name, paths, parent_id, file_id)
1748
1766
self._raw_conflicts.append(('text conflict', trans_id))
1750
1768
osutils.rmtree(temp_dir)
1771
class PathNotInTree(errors.BzrError):
1773
_fmt = """Merge-into failed because %(tree)s does not contain %(path)s."""
1775
def __init__(self, path, tree):
1776
errors.BzrError.__init__(self, path=path, tree=tree)
1779
class MergeIntoMerger(Merger):
1780
"""Merger that understands other_tree will be merged into a subdir.
1782
This also changes the Merger api so that it uses real Branch, revision_id,
1783
and RevisonTree objects, rather than using revision specs.
1786
def __init__(self, this_tree, other_branch, other_tree, target_subdir,
1787
source_subpath, other_rev_id=None):
1788
"""Create a new MergeIntoMerger object.
1790
source_subpath in other_tree will be effectively copied to
1791
target_subdir in this_tree.
1793
:param this_tree: The tree that we will be merging into.
1794
:param other_branch: The Branch we will be merging from.
1795
:param other_tree: The RevisionTree object we want to merge.
1796
:param target_subdir: The relative path where we want to merge
1797
other_tree into this_tree
1798
:param source_subpath: The relative path specifying the subtree of
1799
other_tree to merge into this_tree.
1801
# It is assumed that we are merging a tree that is not in our current
1802
# ancestry, which means we are using the "EmptyTree" as our basis.
1803
null_ancestor_tree = this_tree.branch.repository.revision_tree(
1804
_mod_revision.NULL_REVISION)
1805
super(MergeIntoMerger, self).__init__(
1806
this_branch=this_tree.branch,
1807
this_tree=this_tree,
1808
other_tree=other_tree,
1809
base_tree=null_ancestor_tree,
1811
self._target_subdir = target_subdir
1812
self._source_subpath = source_subpath
1813
self.other_branch = other_branch
1814
if other_rev_id is None:
1815
other_rev_id = other_tree.get_revision_id()
1816
self.other_rev_id = self.other_basis = other_rev_id
1817
self.base_is_ancestor = True
1818
self.backup_files = True
1819
self.merge_type = Merge3Merger
1820
self.show_base = False
1821
self.reprocess = False
1822
self.interesting_files = None
1823
self.merge_type = _MergeTypeParameterizer(MergeIntoMergeType,
1824
target_subdir=self._target_subdir,
1825
source_subpath=self._source_subpath)
1826
if self._source_subpath != '':
1827
# If this isn't a partial merge make sure the revisions will be
1829
self._maybe_fetch(self.other_branch, self.this_branch,
1832
def set_pending(self):
1833
if self._source_subpath != '':
1835
Merger.set_pending(self)
1838
class _MergeTypeParameterizer(object):
1839
"""Wrap a merge-type class to provide extra parameters.
1841
This is hack used by MergeIntoMerger to pass some extra parameters to its
1842
merge_type. Merger.do_merge() sets up its own set of parameters to pass to
1843
the 'merge_type' member. It is difficult override do_merge without
1844
re-writing the whole thing, so instead we create a wrapper which will pass
1845
the extra parameters.
1848
def __init__(self, merge_type, **kwargs):
1849
self._extra_kwargs = kwargs
1850
self._merge_type = merge_type
1852
def __call__(self, *args, **kwargs):
1853
kwargs.update(self._extra_kwargs)
1854
return self._merge_type(*args, **kwargs)
1856
def __getattr__(self, name):
1857
return getattr(self._merge_type, name)
1860
class MergeIntoMergeType(Merge3Merger):
1861
"""Merger that incorporates a tree (or part of a tree) into another."""
1863
def __init__(self, *args, **kwargs):
1864
"""Initialize the merger object.
1866
:param args: See Merge3Merger.__init__'s args.
1867
:param kwargs: See Merge3Merger.__init__'s keyword args, except for
1868
source_subpath and target_subdir.
1869
:keyword source_subpath: The relative path specifying the subtree of
1870
other_tree to merge into this_tree.
1871
:keyword target_subdir: The relative path where we want to merge
1872
other_tree into this_tree
1874
# All of the interesting work happens during Merge3Merger.__init__(),
1875
# so we have have to hack in to get our extra parameters set.
1876
self._source_subpath = kwargs.pop('source_subpath')
1877
self._target_subdir = kwargs.pop('target_subdir')
1878
super(MergeIntoMergeType, self).__init__(*args, **kwargs)
1880
def _compute_transform(self):
1881
with ui.ui_factory.nested_progress_bar() as child_pb:
1882
entries = self._entries_to_incorporate()
1883
entries = list(entries)
1884
for num, (entry, parent_id, relpath) in enumerate(entries):
1885
child_pb.update(gettext('Preparing file merge'), num, len(entries))
1886
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1887
path = osutils.pathjoin(self._source_subpath, relpath)
1888
trans_id = transform.new_by_entry(path, self.tt, entry,
1889
parent_trans_id, self.other_tree)
1890
self._finish_computing_transform()
1892
def _entries_to_incorporate(self):
1893
"""Yields pairs of (inventory_entry, new_parent)."""
1894
other_inv = self.other_tree.root_inventory
1895
subdir_id = other_inv.path2id(self._source_subpath)
1896
if subdir_id is None:
1897
# XXX: The error would be clearer if it gave the URL of the source
1898
# branch, but we don't have a reference to that here.
1899
raise PathNotInTree(self._source_subpath, "Source tree")
1900
subdir = other_inv.get_entry(subdir_id)
1901
parent_in_target = osutils.dirname(self._target_subdir)
1902
target_id = self.this_tree.path2id(parent_in_target)
1903
if target_id is None:
1904
raise PathNotInTree(self._target_subdir, "Target tree")
1905
name_in_target = osutils.basename(self._target_subdir)
1906
merge_into_root = subdir.copy()
1907
merge_into_root.name = name_in_target
1908
if self.this_tree.has_id(merge_into_root.file_id):
1909
# Give the root a new file-id.
1910
# This can happen fairly easily if the directory we are
1911
# incorporating is the root, and both trees have 'TREE_ROOT' as
1912
# their root_id. Users will expect this to Just Work, so we
1913
# change the file-id here.
1914
# Non-root file-ids could potentially conflict too. That's really
1915
# an edge case, so we don't do anything special for those. We let
1916
# them cause conflicts.
1917
merge_into_root.file_id = generate_ids.gen_file_id(name_in_target)
1918
yield (merge_into_root, target_id, '')
1919
if subdir.kind != 'directory':
1920
# No children, so we are done.
1922
for path, entry in other_inv.iter_entries_by_dir(subdir_id):
1923
parent_id = entry.parent_id
1924
if parent_id == subdir.file_id:
1925
# The root's parent ID has changed, so make sure children of
1926
# the root refer to the new ID.
1927
parent_id = merge_into_root.file_id
1928
yield (entry, parent_id, path)
1753
1931
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1754
1932
backup_files=False,
1755
1933
merge_type=Merge3Merger,
1756
interesting_ids=None,
1757
1934
show_base=False,
1758
1935
reprocess=False,
1759
1936
other_rev_id=None,
1760
1937
interesting_files=None,
1761
1938
this_tree=None,
1763
1939
change_reporter=None):
1764
1940
"""Primary interface for merging.
1766
typical use is probably
1767
'merge_inner(branch, branch.get_revision_tree(other_revision),
1768
branch.get_revision_tree(base_revision))'
1942
Typical use is probably::
1944
merge_inner(branch, branch.get_revision_tree(other_revision),
1945
branch.get_revision_tree(base_revision))
1770
1947
if this_tree is None:
1771
raise errors.BzrError("bzrlib.merge.merge_inner requires a this_tree "
1772
"parameter as of bzrlib version 0.8.")
1948
raise errors.BzrError("breezy.merge.merge_inner requires a this_tree "
1773
1950
merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1774
pb=pb, change_reporter=change_reporter)
1951
change_reporter=change_reporter)
1775
1952
merger.backup_files = backup_files
1776
1953
merger.merge_type = merge_type
1777
merger.interesting_ids = interesting_ids
1778
1954
merger.ignore_zero = ignore_zero
1779
if interesting_files:
1781
raise ValueError('Only supply interesting_ids'
1782
' or interesting_files')
1783
merger.interesting_files = interesting_files
1955
merger.interesting_files = interesting_files
1784
1956
merger.show_base = show_base
1785
1957
merger.reprocess = reprocess
1786
1958
merger.other_rev_id = other_rev_id