21
Represent and apply a changeset
20
from bzrlib.trace import mutter
22
# XXX: mbp: I'm not totally convinced that we should handle conflicts
23
# as part of changeset application, rather than only in the merge
26
"""Represent and apply a changeset
28
Conflicts in applying a changeset are represented as exceptions.
23
31
__docformat__ = "restructuredtext"
35
class OldFailedTreeOp(Exception):
37
Exception.__init__(self, "bzr-tree-change contains files from a"
38
" previous failed merge operation.")
28
39
def invert_dict(dict):
30
41
for (key,value) in dict.iteritems():
35
class PatchApply(object):
36
"""Patch application as a kind of content change"""
37
def __init__(self, contents):
40
:param contents: The text of the patch to apply
41
:type contents: str"""
42
self.contents = contents
44
def __eq__(self, other):
45
if not isinstance(other, PatchApply):
47
elif self.contents != other.contents:
52
def __ne__(self, other):
53
return not (self == other)
55
def apply(self, filename, conflict_handler, reverse=False):
56
"""Applies the patch to the specified file.
58
:param filename: the file to apply the patch to
60
:param reverse: If true, apply the patch in reverse
63
input_name = filename+".orig"
65
os.rename(filename, input_name)
67
if e.errno != errno.ENOENT:
69
if conflict_handler.patch_target_missing(filename, self.contents)\
72
os.rename(filename, input_name)
75
status = patch.patch(self.contents, input_name, filename,
77
os.chmod(filename, os.stat(input_name).st_mode)
81
conflict_handler.failed_hunks(filename)
84
47
class ChangeUnixPermissions(object):
85
48
"""This is two-way change, suitable for file modification, creation,
365
328
class Diff3Merge(object):
366
def __init__(self, base_file, other_file):
367
self.base_file = base_file
368
self.other_file = other_file
329
def __init__(self, file_id, base, other):
330
self.file_id = file_id
370
334
def __eq__(self, other):
371
335
if not isinstance(other, Diff3Merge):
373
return (self.base_file == other.base_file and
374
self.other_file == other.other_file)
337
return (self.base == other.base and
338
self.other == other.other and self.file_id == other.file_id)
376
340
def __ne__(self, other):
377
341
return not (self == other)
379
343
def apply(self, filename, conflict_handler, reverse=False):
380
new_file = filename+".new"
344
new_file = filename+".new"
345
base_file = self.base.readonly_path(self.file_id)
346
other_file = self.other.readonly_path(self.file_id)
382
base = self.base_file
383
other = self.other_file
385
base = self.other_file
386
other = self.base_file
387
353
status = patch.diff3(new_file, filename, base, other)
389
355
os.chmod(new_file, os.stat(filename).st_mode)
826
801
my_sort(target_entries, shortest_to_longest)
827
802
return (source_entries, target_entries)
829
def rename_to_temp_delete(source_entries, inventory, dir, conflict_handler,
804
def rename_to_temp_delete(source_entries, inventory, dir, temp_dir,
805
conflict_handler, reverse):
831
806
"""Delete and rename entries as appropriate. Entries are renamed to temp
832
names. A map of id -> temp name is returned.
807
names. A map of id -> temp name (or None, for deletions) is returned.
834
809
:param source_entries: The entries to rename and delete
835
810
:type source_entries: List of `ChangesetEntry`
842
817
:return: a mapping of id to temporary name
843
818
:rtype: Dictionary
845
temp_dir = os.path.join(dir, "temp")
847
821
for i in range(len(source_entries)):
848
822
entry = source_entries[i]
849
823
if entry.is_deletion(reverse):
850
824
path = os.path.join(dir, inventory[entry.id])
851
825
entry.apply(path, conflict_handler, reverse)
826
temp_name[entry.id] = None
854
to_name = temp_dir+"/"+str(i)
829
to_name = os.path.join(temp_dir, str(i))
855
830
src_path = inventory.get(entry.id)
856
831
if src_path is not None:
857
832
src_path = os.path.join(dir, src_path)
870
def rename_to_new_create(temp_name, target_entries, inventory, changeset, dir,
871
conflict_handler, reverse):
845
def rename_to_new_create(changed_inventory, target_entries, inventory,
846
changeset, dir, conflict_handler, reverse):
872
847
"""Rename entries with temp names to their final names, create new files.
874
:param temp_name: A mapping of id to temporary name
875
:type temp_name: Dictionary
849
:param changed_inventory: A mapping of id to temporary name
850
:type changed_inventory: Dictionary
876
851
:param target_entries: The entries to apply changes to
877
852
:type target_entries: List of `ChangesetEntry`
878
853
:param changeset: The changeset to apply
883
858
:type reverse: bool
885
860
for entry in target_entries:
886
new_path = entry.get_new_path(inventory, changeset, reverse)
861
new_tree_path = entry.get_new_path(inventory, changeset, reverse)
862
if new_tree_path is None:
889
new_path = os.path.join(dir, new_path)
890
old_path = temp_name.get(entry.id)
864
new_path = os.path.join(dir, new_tree_path)
865
old_path = changed_inventory.get(entry.id)
891
866
if os.path.exists(new_path):
892
867
if conflict_handler.target_exists(entry, new_path, old_path) == \
895
870
if entry.is_creation(reverse):
896
871
entry.apply(new_path, conflict_handler, reverse)
872
changed_inventory[entry.id] = new_tree_path
898
874
if old_path is None:
901
877
os.rename(old_path, new_path)
878
changed_inventory[entry.id] = new_tree_path
902
879
except OSError, e:
903
880
raise Exception ("%s is missing" % new_path)
1006
983
Exception.__init__(self, msg)
1007
984
self.filename = filename
986
class NewContentsConflict(Exception):
987
def __init__(self, filename):
988
msg = "Conflicting contents for new file %s" % (filename)
989
Exception.__init__(self, msg)
992
class MissingForMerge(Exception):
993
def __init__(self, filename):
994
msg = "The file %s was modified, but does not exist in this tree"\
996
Exception.__init__(self, msg)
1009
999
class ExceptionConflictHandler(object):
1000
"""Default handler for merge exceptions.
1002
This throws an error on any kind of conflict. Conflict handlers can
1003
descend from this class if they have a better way to handle some or
1004
all types of conflict.
1010
1006
def __init__(self, dir):
1026
1022
def rename_conflict(self, id, this_name, base_name, other_name):
1027
1023
raise RenameConflict(id, this_name, base_name, other_name)
1029
def move_conflict(self, id, inventory):
1030
this_dir = inventory.this.get_dir(id)
1031
base_dir = inventory.base.get_dir(id)
1032
other_dir = inventory.other.get_dir(id)
1025
def move_conflict(self, id, this_dir, base_dir, other_dir):
1033
1026
raise MoveConflict(id, this_dir, base_dir, other_dir)
1035
def merge_conflict(self, new_file, this_path, base_path, other_path):
1028
def merge_conflict(self, new_file, this_path, base_lines, other_lines):
1036
1029
os.unlink(new_file)
1037
1030
raise MergeConflict(this_path)
1066
1059
def missing_for_rename(self, filename):
1067
1060
raise MissingForRename(filename)
1062
def missing_for_merge(self, file_id, other_path):
1063
raise MissingForMerge(other_path)
1065
def new_contents_conflict(self, filename, other_contents):
1066
raise NewContentsConflict(filename)
1069
1071
def apply_changeset(changeset, inventory, dir, conflict_handler=None,
1070
1072
reverse=False):
1071
1073
"""Apply a changeset to a directory.
1099
1112
(source_entries, target_entries) = get_rename_entries(changeset, inventory,
1102
temp_name = rename_to_temp_delete(source_entries, inventory, dir,
1103
conflict_handler, reverse)
1115
changed_inventory = rename_to_temp_delete(source_entries, inventory, dir,
1116
temp_dir, conflict_handler,
1105
rename_to_new_create(temp_name, target_entries, inventory, changeset, dir,
1106
conflict_handler, reverse)
1119
rename_to_new_create(changed_inventory, target_entries, inventory,
1120
changeset, dir, conflict_handler, reverse)
1107
1121
os.rmdir(temp_dir)
1108
r_inventory = invert_dict(inventory)
1109
new_entries, removed_entries = get_inventory_change(inventory,
1110
r_inventory, changeset, reverse)
1112
for path, file_id in new_entries.iteritems():
1113
new_inventory[file_id] = path
1114
for file_id in removed_entries:
1115
new_inventory[file_id] = None
1116
return new_inventory
1122
return changed_inventory
1119
1125
def apply_changeset_tree(cset, tree, reverse=False):
1130
1136
def get_inventory_change(inventory, new_inventory, cset, reverse=False):
1131
1137
new_entries = {}
1132
1138
remove_entries = []
1133
r_inventory = invert_dict(inventory)
1134
r_new_inventory = invert_dict(new_inventory)
1135
1139
for entry in cset.entries.itervalues():
1136
1140
if entry.needs_rename():
1137
old_path = r_inventory.get(entry.id)
1138
if old_path is not None:
1139
remove_entries.append(old_path)
1141
new_path = entry.get_new_path(inventory, cset)
1142
if new_path is None:
1143
remove_entries.append(entry.id)
1141
new_path = entry.get_new_path(inventory, cset)
1142
if new_path is not None:
1143
new_entries[new_path] = entry.id
1145
new_entries[new_path] = entry.id
1144
1146
return new_entries, remove_entries
1285
1287
self.full_path = full_path
1286
1288
self.stat_result = stat_result
1288
def generate_changeset(tree_a, tree_b, inventory_a=None, inventory_b=None):
1289
return ChangesetGenerator(tree_a, tree_b, inventory_a, inventory_b)()
1290
def generate_changeset(tree_a, tree_b, interesting_ids=None):
1291
return ChangesetGenerator(tree_a, tree_b, interesting_ids)()
1291
1293
class ChangesetGenerator(object):
1292
def __init__(self, tree_a, tree_b, inventory_a=None, inventory_b=None):
1294
def __init__(self, tree_a, tree_b, interesting_ids=None):
1293
1295
object.__init__(self)
1294
1296
self.tree_a = tree_a
1295
1297
self.tree_b = tree_b
1296
if inventory_a is not None:
1297
self.inventory_a = inventory_a
1299
self.inventory_a = tree_a.inventory()
1300
if inventory_b is not None:
1301
self.inventory_b = inventory_b
1303
self.inventory_b = tree_b.inventory()
1304
self.r_inventory_a = self.reverse_inventory(self.inventory_a)
1305
self.r_inventory_b = self.reverse_inventory(self.inventory_b)
1298
self._interesting_ids = interesting_ids
1307
def reverse_inventory(self, inventory):
1309
for entry in inventory.itervalues():
1310
if entry.id is None:
1312
r_inventory[entry.id] = entry
1300
def iter_both_tree_ids(self):
1301
for file_id in self.tree_a:
1303
for file_id in self.tree_b:
1304
if file_id not in self.tree_a:
1315
1307
def __call__(self):
1316
1308
cset = Changeset()
1317
for entry in self.inventory_a.itervalues():
1318
if entry.id is None:
1320
cs_entry = self.make_entry(entry.id)
1309
for file_id in self.iter_both_tree_ids():
1310
cs_entry = self.make_entry(file_id)
1321
1311
if cs_entry is not None and not cs_entry.is_boring():
1322
1312
cset.add_entry(cs_entry)
1324
for entry in self.inventory_b.itervalues():
1325
if entry.id is None:
1327
if not self.r_inventory_a.has_key(entry.id):
1328
cs_entry = self.make_entry(entry.id)
1329
if cs_entry is not None and not cs_entry.is_boring():
1330
cset.add_entry(cs_entry)
1331
1314
for entry in list(cset.entries.itervalues()):
1332
1315
if entry.parent != entry.new_parent:
1333
1316
if not cset.entries.has_key(entry.parent) and\
1341
1324
cset.add_entry(parent_entry)
1344
def get_entry_parent(self, entry, inventory):
1347
if entry.path == "./.":
1349
dirname = os.path.dirname(entry.path)
1352
parent = inventory[dirname]
1355
def get_paths(self, entry, tree):
1358
full_path = tree.readonly_path(entry.id)
1359
if entry.path == ".":
1360
return ("", full_path)
1361
return (entry.path, full_path)
1363
def make_basic_entry(self, id, only_interesting):
1364
entry_a = self.r_inventory_a.get(id)
1365
entry_b = self.r_inventory_b.get(id)
1327
def iter_inventory(self, tree):
1328
for file_id in tree:
1329
yield self.get_entry(file_id, tree)
1331
def get_entry(self, file_id, tree):
1332
if not tree.has_or_had_id(file_id):
1334
return tree.tree.inventory[file_id]
1336
def get_entry_parent(self, entry):
1339
return entry.parent_id
1341
def get_path(self, file_id, tree):
1342
if not tree.has_or_had_id(file_id):
1344
path = tree.id2path(file_id)
1350
def make_basic_entry(self, file_id, only_interesting):
1351
entry_a = self.get_entry(file_id, self.tree_a)
1352
entry_b = self.get_entry(file_id, self.tree_b)
1366
1353
if only_interesting and not self.is_interesting(entry_a, entry_b):
1367
return (None, None, None)
1368
parent = self.get_entry_parent(entry_a, self.inventory_a)
1369
(path, full_path_a) = self.get_paths(entry_a, self.tree_a)
1370
cs_entry = ChangesetEntry(id, parent, path)
1371
new_parent = self.get_entry_parent(entry_b, self.inventory_b)
1374
(new_path, full_path_b) = self.get_paths(entry_b, self.tree_b)
1355
parent = self.get_entry_parent(entry_a)
1356
path = self.get_path(file_id, self.tree_a)
1357
cs_entry = ChangesetEntry(file_id, parent, path)
1358
new_parent = self.get_entry_parent(entry_b)
1360
new_path = self.get_path(file_id, self.tree_b)
1376
1362
cs_entry.new_path = new_path
1377
1363
cs_entry.new_parent = new_parent
1378
return (cs_entry, full_path_a, full_path_b)
1380
1366
def is_interesting(self, entry_a, entry_b):
1367
if self._interesting_ids is None:
1381
1369
if entry_a is not None:
1382
if entry_a.interesting:
1384
if entry_b is not None:
1385
if entry_b.interesting:
1370
file_id = entry_a.file_id
1371
elif entry_b is not None:
1372
file_id = entry_b.file_id
1375
return file_id in self._interesting_ids
1389
1377
def make_boring_entry(self, id):
1390
(cs_entry, full_path_a, full_path_b) = \
1391
self.make_basic_entry(id, only_interesting=False)
1378
cs_entry = self.make_basic_entry(id, only_interesting=False)
1392
1379
if cs_entry.is_creation_or_deletion():
1393
1380
return self.make_entry(id, only_interesting=False)
1398
1385
def make_entry(self, id, only_interesting=True):
1399
(cs_entry, full_path_a, full_path_b) = \
1400
self.make_basic_entry(id, only_interesting)
1386
cs_entry = self.make_basic_entry(id, only_interesting)
1402
1388
if cs_entry is None:
1390
if id in self.tree_a and id in self.tree_b:
1391
a_sha1 = self.tree_a.get_file_sha1(id)
1392
b_sha1 = self.tree_b.get_file_sha1(id)
1393
if None not in (a_sha1, b_sha1) and a_sha1 == b_sha1:
1396
full_path_a = self.tree_a.readonly_path(id)
1397
full_path_b = self.tree_b.readonly_path(id)
1405
1398
stat_a = self.lstat(full_path_a)
1406
1399
stat_b = self.lstat(full_path_b)
1408
cs_entry.new_parent = None
1409
cs_entry.new_path = None
1411
1401
cs_entry.metadata_change = self.make_mode_change(stat_a, stat_b)
1412
1402
cs_entry.contents_change = self.make_contents_change(full_path_a,
1437
1427
if stat_a.st_ino == stat_b.st_ino and \
1438
1428
stat_a.st_dev == stat_b.st_dev:
1440
if file(full_path_a, "rb").read() == \
1441
file(full_path_b, "rb").read():
1444
patch_contents = patch.diff(full_path_a,
1445
file(full_path_b, "rb").read())
1446
if patch_contents is None:
1448
return PatchApply(patch_contents)
1450
1431
a_contents = self.get_contents(stat_a, full_path_a)
1451
1432
b_contents = self.get_contents(stat_b, full_path_b)