13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""Represent and apply a changeset.
19
Conflicts in applying a changeset are represented as exceptions.
21
This only handles the in-memory objects representing changesets, which are
22
primarily used by the merge code.
20
from bzrlib.trace import mutter
22
Represent and apply a changeset
28
from tempfile import mkdtemp
29
from shutil import rmtree
30
from itertools import izip
32
from bzrlib.trace import mutter, warning
33
from bzrlib.osutils import rename, sha_file
24
36
__docformat__ = "restructuredtext"
35
47
newdict[value] = key
39
class PatchApply(object):
40
"""Patch application as a kind of content change"""
41
def __init__(self, contents):
44
:param contents: The text of the patch to apply
45
:type contents: str"""
46
self.contents = contents
48
def __eq__(self, other):
49
if not isinstance(other, PatchApply):
51
elif self.contents != other.contents:
56
def __ne__(self, other):
57
return not (self == other)
59
def apply(self, filename, conflict_handler, reverse=False):
60
"""Applies the patch to the specified file.
62
:param filename: the file to apply the patch to
64
:param reverse: If true, apply the patch in reverse
67
input_name = filename+".orig"
69
os.rename(filename, input_name)
71
if e.errno != errno.ENOENT:
73
if conflict_handler.patch_target_missing(filename, self.contents)\
76
os.rename(filename, input_name)
79
status = patch.patch(self.contents, input_name, filename,
81
os.chmod(filename, os.stat(input_name).st_mode)
85
conflict_handler.failed_hunks(filename)
88
class ChangeUnixPermissions(object):
51
class ChangeExecFlag(object):
89
52
"""This is two-way change, suitable for file modification, creation,
91
def __init__(self, old_mode, new_mode):
92
self.old_mode = old_mode
93
self.new_mode = new_mode
54
def __init__(self, old_exec_flag, new_exec_flag):
55
self.old_exec_flag = old_exec_flag
56
self.new_exec_flag = new_exec_flag
95
58
def apply(self, filename, conflict_handler, reverse=False):
97
from_mode = self.old_mode
98
to_mode = self.new_mode
60
from_exec_flag = self.old_exec_flag
61
to_exec_flag = self.new_exec_flag
100
from_mode = self.new_mode
101
to_mode = self.old_mode
63
from_exec_flag = self.new_exec_flag
64
to_exec_flag = self.old_exec_flag
103
current_mode = os.stat(filename).st_mode &0777
66
current_exec_flag = bool(os.stat(filename).st_mode & 0111)
104
67
except OSError, e:
105
68
if e.errno == errno.ENOENT:
106
if conflict_handler.missing_for_chmod(filename) == "skip":
69
if conflict_handler.missing_for_exec_flag(filename) == "skip":
109
current_mode = from_mode
72
current_exec_flag = from_exec_flag
111
if from_mode is not None and current_mode != from_mode:
112
if conflict_handler.wrong_old_perms(filename, from_mode,
113
current_mode) != "continue":
74
if from_exec_flag is not None and current_exec_flag != from_exec_flag:
75
if conflict_handler.wrong_old_exec_flag(filename,
76
from_exec_flag, current_exec_flag) != "continue":
116
if to_mode is not None:
79
if to_exec_flag is not None:
80
current_mode = os.stat(filename).st_mode
84
to_mode = current_mode | (0100 & ~umask)
85
# Enable x-bit for others only if they can read it.
86
if current_mode & 0004:
87
to_mode |= 0001 & ~umask
88
if current_mode & 0040:
89
to_mode |= 0010 & ~umask
91
to_mode = current_mode & ~0111
118
93
os.chmod(filename, to_mode)
119
94
except IOError, e:
120
95
if e.errno == errno.ENOENT:
121
conflict_handler.missing_for_chmod(filename)
96
conflict_handler.missing_for_exec_flag(filename)
123
98
def __eq__(self, other):
124
if not isinstance(other, ChangeUnixPermissions):
126
elif self.old_mode != other.old_mode:
128
elif self.new_mode != other.new_mode:
99
return (isinstance(other, ChangeExecFlag) and
100
self.old_exec_flag == other.old_exec_flag and
101
self.new_exec_flag == other.new_exec_flag)
133
103
def __ne__(self, other):
134
104
return not (self == other)
136
107
def dir_create(filename, conflict_handler, reverse):
137
108
"""Creates the directory, or deletes it if reverse is true. Intended to be
138
109
used with ReplaceContents.
239
class TreeFileCreate(object):
240
"""Create or delete a file (for use with ReplaceContents)"""
241
def __init__(self, tree, file_id):
244
:param contents: The contents of the file to write
248
self.file_id = file_id
251
return "TreeFileCreate(%s)" % self.file_id
253
def __eq__(self, other):
254
if not isinstance(other, TreeFileCreate):
256
return self.tree.get_file_sha1(self.file_id) == \
257
other.tree.get_file_sha1(other.file_id)
259
def __ne__(self, other):
260
return not (self == other)
262
def write_file(self, filename):
263
outfile = file(filename, "wb")
264
for line in self.tree.get_file(self.file_id):
267
def same_text(self, filename):
268
in_file = file(filename, "rb")
269
return sha_file(in_file) == self.tree.get_file_sha1(self.file_id)
271
def __call__(self, filename, conflict_handler, reverse):
272
"""Create or delete a file
274
:param filename: The name of the file to create
276
:param reverse: Delete the file instead of creating it
281
self.write_file(filename)
283
if e.errno == errno.ENOENT:
284
if conflict_handler.missing_parent(filename)=="continue":
285
self.write_file(filename)
291
if not self.same_text(filename):
292
direction = conflict_handler.wrong_old_contents(filename,
293
self.tree.get_file(self.file_id).read())
294
if direction != "continue":
298
if e.errno != errno.ENOENT:
300
if conflict_handler.missing_for_rm(filename, undo) == "skip":
267
305
def reversed(sequence):
268
306
max = len(sequence) - 1
269
307
for i in range(len(sequence)):
369
413
class Diff3Merge(object):
370
def __init__(self, base_file, other_file):
371
self.base_file = base_file
372
self.other_file = other_file
414
history_based = False
415
def __init__(self, file_id, base, other):
416
self.file_id = file_id
420
def is_creation(self):
423
def is_deletion(self):
374
426
def __eq__(self, other):
375
427
if not isinstance(other, Diff3Merge):
377
return (self.base_file == other.base_file and
378
self.other_file == other.other_file)
429
return (self.base == other.base and
430
self.other == other.other and self.file_id == other.file_id)
380
432
def __ne__(self, other):
381
433
return not (self == other)
435
def dump_file(self, temp_dir, name, tree):
436
out_path = os.path.join(temp_dir, name)
437
out_file = file(out_path, "wb")
438
in_file = tree.get_file(self.file_id)
383
443
def apply(self, filename, conflict_handler, reverse=False):
384
new_file = filename+".new"
386
base = self.base_file
387
other = self.other_file
389
base = self.other_file
390
other = self.base_file
391
status = patch.diff3(new_file, filename, base, other)
393
os.chmod(new_file, os.stat(filename).st_mode)
394
os.rename(new_file, filename)
398
conflict_handler.merge_conflict(new_file, filename, base, other)
445
temp_dir = mkdtemp(prefix="bzr-")
447
new_file = filename+".new"
448
base_file = self.dump_file(temp_dir, "base", self.base)
449
other_file = self.dump_file(temp_dir, "other", self.other)
456
status = bzrlib.patch.diff3(new_file, filename, base, other)
458
os.chmod(new_file, os.stat(filename).st_mode)
459
rename(new_file, filename)
463
def get_lines(filename):
464
my_file = file(filename, "rb")
465
lines = my_file.readlines()
468
base_lines = get_lines(base)
469
other_lines = get_lines(other)
470
conflict_handler.merge_conflict(new_file, filename, base_lines,
895
975
new_path = os.path.join(dir, new_tree_path)
896
976
old_path = changed_inventory.get(entry.id)
897
if os.path.exists(new_path):
977
if bzrlib.osutils.lexists(new_path):
898
978
if conflict_handler.target_exists(entry, new_path, old_path) == \
901
981
if entry.is_creation(reverse):
902
982
entry.apply(new_path, conflict_handler, reverse)
903
983
changed_inventory[entry.id] = new_tree_path
984
elif entry.needs_rename():
905
985
if old_path is None:
908
os.rename(old_path, new_path)
988
rename(old_path, new_path)
909
989
changed_inventory[entry.id] = new_tree_path
910
990
except OSError, e:
911
991
raise Exception ("%s is missing" % new_path)
946
1026
Exception.__init__(self, "Conflict applying changes to %s" % this_path)
947
1027
self.this_path = this_path
949
class MergePermissionConflict(Exception):
950
def __init__(self, this_path, base_path, other_path):
951
this_perms = os.stat(this_path).st_mode & 0755
952
base_perms = os.stat(base_path).st_mode & 0755
953
other_perms = os.stat(other_path).st_mode & 0755
954
msg = """Conflicting permission for %s
958
""" % (this_path, this_perms, base_perms, other_perms)
959
self.this_path = this_path
960
self.base_path = base_path
961
self.other_path = other_path
962
Exception.__init__(self, msg)
964
1029
class WrongOldContents(Exception):
965
1030
def __init__(self, filename):
966
1031
msg = "Contents mismatch deleting %s" % filename
967
1032
self.filename = filename
968
1033
Exception.__init__(self, msg)
970
class WrongOldPermissions(Exception):
971
def __init__(self, filename, old_perms, new_perms):
972
msg = "Permission missmatch on %s:\n" \
973
"Expected 0%o, got 0%o." % (filename, old_perms, new_perms)
1035
class WrongOldExecFlag(Exception):
1036
def __init__(self, filename, old_exec_flag, new_exec_flag):
1037
msg = "Executable flag missmatch on %s:\n" \
1038
"Expected %s, got %s." % (filename, old_exec_flag, new_exec_flag)
974
1039
self.filename = filename
975
1040
Exception.__init__(self, msg)
1047
1125
def rename_conflict(self, id, this_name, base_name, other_name):
1048
1126
raise RenameConflict(id, this_name, base_name, other_name)
1050
def move_conflict(self, id, inventory):
1051
this_dir = inventory.this.get_dir(id)
1052
base_dir = inventory.base.get_dir(id)
1053
other_dir = inventory.other.get_dir(id)
1128
def move_conflict(self, id, this_dir, base_dir, other_dir):
1054
1129
raise MoveConflict(id, this_dir, base_dir, other_dir)
1056
def merge_conflict(self, new_file, this_path, base_path, other_path):
1131
def merge_conflict(self, new_file, this_path, base_lines, other_lines):
1057
1132
os.unlink(new_file)
1058
1133
raise MergeConflict(this_path)
1060
def permission_conflict(self, this_path, base_path, other_path):
1061
raise MergePermissionConflict(this_path, base_path, other_path)
1063
1135
def wrong_old_contents(self, filename, expected_contents):
1064
1136
raise WrongOldContents(filename)
1066
1138
def rem_contents_conflict(self, filename, this_contents, base_contents):
1067
1139
raise RemoveContentsConflict(filename)
1069
def wrong_old_perms(self, filename, old_perms, new_perms):
1070
raise WrongOldPermissions(filename, old_perms, new_perms)
1141
def wrong_old_exec_flag(self, filename, old_exec_flag, new_exec_flag):
1142
raise WrongOldExecFlag(filename, old_exec_flag, new_exec_flag)
1072
1144
def rmdir_non_empty(self, filename):
1073
1145
raise DeletingNonEmptyDirectory(filename)
1078
1150
def patch_target_missing(self, filename, contents):
1079
1151
raise PatchTargetMissing(filename)
1081
def missing_for_chmod(self, filename):
1082
raise MissingPermsFile(filename)
1153
def missing_for_exec_flag(self, filename):
1154
raise MissingForExecFlag(filename)
1084
1156
def missing_for_rm(self, filename, change):
1085
1157
raise MissingForRm(filename)
1087
def missing_for_rename(self, filename):
1088
raise MissingForRename(filename)
1159
def missing_for_rename(self, filename, to_path):
1160
raise MissingForRename(filename, to_path)
1090
def missing_for_merge(self, file_id, inventory):
1091
raise MissingForMerge(inventory.other.get_path(file_id))
1162
def missing_for_merge(self, file_id, other_path):
1163
raise MissingForMerge(other_path)
1093
1165
def new_contents_conflict(self, filename, other_contents):
1094
1166
raise NewContentsConflict(filename)
1168
def weave_merge_conflict(self, filename, weave, other_i, out_file):
1169
raise WeaveMergeConflict(filename)
1171
def threeway_contents_conflict(self, filename, this_contents,
1172
base_contents, other_contents):
1173
raise ThreewayContentsConflict(filename)
1099
1178
def apply_changeset(changeset, inventory, dir, conflict_handler=None,
1311
class UnsuppportedFiletype(Exception):
1312
def __init__(self, full_path, stat_result):
1313
msg = "The file \"%s\" is not a supported filetype." % full_path
1394
class UnsupportedFiletype(Exception):
1395
def __init__(self, kind, full_path):
1396
msg = "The file \"%s\" is a %s, which is not a supported filetype." \
1314
1398
Exception.__init__(self, msg)
1315
1399
self.full_path = full_path
1316
self.stat_result = stat_result
1318
def generate_changeset(tree_a, tree_b, inventory_a=None, inventory_b=None):
1319
return ChangesetGenerator(tree_a, tree_b, inventory_a, inventory_b)()
1402
def generate_changeset(tree_a, tree_b, interesting_ids=None):
1403
return ChangesetGenerator(tree_a, tree_b, interesting_ids)()
1321
1406
class ChangesetGenerator(object):
1322
def __init__(self, tree_a, tree_b, inventory_a=None, inventory_b=None):
1407
def __init__(self, tree_a, tree_b, interesting_ids=None):
1323
1408
object.__init__(self)
1324
1409
self.tree_a = tree_a
1325
1410
self.tree_b = tree_b
1326
if inventory_a is not None:
1327
self.inventory_a = inventory_a
1329
self.inventory_a = tree_a.inventory()
1330
if inventory_b is not None:
1331
self.inventory_b = inventory_b
1333
self.inventory_b = tree_b.inventory()
1334
self.r_inventory_a = self.reverse_inventory(self.inventory_a)
1335
self.r_inventory_b = self.reverse_inventory(self.inventory_b)
1411
self._interesting_ids = interesting_ids
1337
def reverse_inventory(self, inventory):
1339
for entry in inventory.itervalues():
1340
if entry.id is None:
1342
r_inventory[entry.id] = entry
1413
def iter_both_tree_ids(self):
1414
for file_id in self.tree_a:
1416
for file_id in self.tree_b:
1417
if file_id not in self.tree_a:
1345
1420
def __call__(self):
1346
1421
cset = Changeset()
1347
for entry in self.inventory_a.itervalues():
1348
if entry.id is None:
1350
cs_entry = self.make_entry(entry.id)
1422
for file_id in self.iter_both_tree_ids():
1423
cs_entry = self.make_entry(file_id)
1351
1424
if cs_entry is not None and not cs_entry.is_boring():
1352
1425
cset.add_entry(cs_entry)
1354
for entry in self.inventory_b.itervalues():
1355
if entry.id is None:
1357
if not self.r_inventory_a.has_key(entry.id):
1358
cs_entry = self.make_entry(entry.id)
1359
if cs_entry is not None and not cs_entry.is_boring():
1360
cset.add_entry(cs_entry)
1361
1427
for entry in list(cset.entries.itervalues()):
1362
1428
if entry.parent != entry.new_parent:
1363
1429
if not cset.entries.has_key(entry.parent) and\
1371
1437
cset.add_entry(parent_entry)
1374
def get_entry_parent(self, entry, inventory):
1377
if entry.path == "./.":
1379
dirname = os.path.dirname(entry.path)
1382
parent = inventory[dirname]
1385
def get_paths(self, entry, tree):
1388
full_path = tree.readonly_path(entry.id)
1389
if entry.path == ".":
1390
return ("", full_path)
1391
return (entry.path, full_path)
1393
def make_basic_entry(self, id, only_interesting):
1394
entry_a = self.r_inventory_a.get(id)
1395
entry_b = self.r_inventory_b.get(id)
1440
def iter_inventory(self, tree):
1441
for file_id in tree:
1442
yield self.get_entry(file_id, tree)
1444
def get_entry(self, file_id, tree):
1445
if not tree.has_or_had_id(file_id):
1447
return tree.inventory[file_id]
1449
def get_entry_parent(self, entry):
1452
return entry.parent_id
1454
def get_path(self, file_id, tree):
1455
if not tree.has_or_had_id(file_id):
1457
path = tree.id2path(file_id)
1463
def make_basic_entry(self, file_id, only_interesting):
1464
entry_a = self.get_entry(file_id, self.tree_a)
1465
entry_b = self.get_entry(file_id, self.tree_b)
1396
1466
if only_interesting and not self.is_interesting(entry_a, entry_b):
1397
return (None, None, None)
1398
parent = self.get_entry_parent(entry_a, self.inventory_a)
1399
(path, full_path_a) = self.get_paths(entry_a, self.tree_a)
1400
cs_entry = ChangesetEntry(id, parent, path)
1401
new_parent = self.get_entry_parent(entry_b, self.inventory_b)
1404
(new_path, full_path_b) = self.get_paths(entry_b, self.tree_b)
1468
parent = self.get_entry_parent(entry_a)
1469
path = self.get_path(file_id, self.tree_a)
1470
cs_entry = ChangesetEntry(file_id, parent, path)
1471
new_parent = self.get_entry_parent(entry_b)
1473
new_path = self.get_path(file_id, self.tree_b)
1406
1475
cs_entry.new_path = new_path
1407
1476
cs_entry.new_parent = new_parent
1408
return (cs_entry, full_path_a, full_path_b)
1410
1479
def is_interesting(self, entry_a, entry_b):
1480
if self._interesting_ids is None:
1411
1482
if entry_a is not None:
1412
if entry_a.interesting:
1414
if entry_b is not None:
1415
if entry_b.interesting:
1483
file_id = entry_a.file_id
1484
elif entry_b is not None:
1485
file_id = entry_b.file_id
1488
return file_id in self._interesting_ids
1419
1490
def make_boring_entry(self, id):
1420
(cs_entry, full_path_a, full_path_b) = \
1421
self.make_basic_entry(id, only_interesting=False)
1491
cs_entry = self.make_basic_entry(id, only_interesting=False)
1422
1492
if cs_entry.is_creation_or_deletion():
1423
1493
return self.make_entry(id, only_interesting=False)
1428
1498
def make_entry(self, id, only_interesting=True):
1429
(cs_entry, full_path_a, full_path_b) = \
1430
self.make_basic_entry(id, only_interesting)
1499
cs_entry = self.make_basic_entry(id, only_interesting)
1432
1501
if cs_entry is None:
1435
stat_a = self.lstat(full_path_a)
1436
stat_b = self.lstat(full_path_b)
1438
cs_entry.new_parent = None
1439
cs_entry.new_path = None
1441
cs_entry.metadata_change = self.make_mode_change(stat_a, stat_b)
1442
cs_entry.contents_change = self.make_contents_change(full_path_a,
1504
cs_entry.metadata_change = self.make_exec_flag_change(id)
1506
if id in self.tree_a and id in self.tree_b:
1507
a_sha1 = self.tree_a.get_file_sha1(id)
1508
b_sha1 = self.tree_b.get_file_sha1(id)
1509
if None not in (a_sha1, b_sha1) and a_sha1 == b_sha1:
1512
cs_entry.contents_change = self.make_contents_change(id)
1446
1513
return cs_entry
1448
def make_mode_change(self, stat_a, stat_b):
1450
if stat_a is not None and not stat.S_ISLNK(stat_a.st_mode):
1451
mode_a = stat_a.st_mode & 0777
1453
if stat_b is not None and not stat.S_ISLNK(stat_b.st_mode):
1454
mode_b = stat_b.st_mode & 0777
1455
if mode_a == mode_b:
1457
return ChangeUnixPermissions(mode_a, mode_b)
1459
def make_contents_change(self, full_path_a, stat_a, full_path_b, stat_b):
1460
if stat_a is None and stat_b is None:
1462
if None not in (stat_a, stat_b) and stat.S_ISDIR(stat_a.st_mode) and\
1463
stat.S_ISDIR(stat_b.st_mode):
1465
if None not in (stat_a, stat_b) and stat.S_ISREG(stat_a.st_mode) and\
1466
stat.S_ISREG(stat_b.st_mode):
1467
if stat_a.st_ino == stat_b.st_ino and \
1468
stat_a.st_dev == stat_b.st_dev:
1470
if file(full_path_a, "rb").read() == \
1471
file(full_path_b, "rb").read():
1474
patch_contents = patch.diff(full_path_a,
1475
file(full_path_b, "rb").read())
1476
if patch_contents is None:
1478
return PatchApply(patch_contents)
1480
a_contents = self.get_contents(stat_a, full_path_a)
1481
b_contents = self.get_contents(stat_b, full_path_b)
1515
def make_exec_flag_change(self, file_id):
1516
exec_flag_a = exec_flag_b = None
1517
if file_id in self.tree_a and self.tree_a.kind(file_id) == "file":
1518
exec_flag_a = self.tree_a.is_executable(file_id)
1520
if file_id in self.tree_b and self.tree_b.kind(file_id) == "file":
1521
exec_flag_b = self.tree_b.is_executable(file_id)
1523
if exec_flag_a == exec_flag_b:
1525
return ChangeExecFlag(exec_flag_a, exec_flag_b)
1527
def make_contents_change(self, file_id):
1528
a_contents = get_contents(self.tree_a, file_id)
1529
b_contents = get_contents(self.tree_b, file_id)
1482
1530
if a_contents == b_contents:
1484
1532
return ReplaceContents(a_contents, b_contents)
1486
def get_contents(self, stat_result, full_path):
1487
if stat_result is None:
1489
elif stat.S_ISREG(stat_result.st_mode):
1490
return FileCreate(file(full_path, "rb").read())
1491
elif stat.S_ISDIR(stat_result.st_mode):
1493
elif stat.S_ISLNK(stat_result.st_mode):
1494
return SymlinkCreate(os.readlink(full_path))
1496
raise UnsupportedFiletype(full_path, stat_result)
1498
def lstat(self, full_path):
1500
if full_path is not None:
1502
stat_result = os.lstat(full_path)
1504
if e.errno != errno.ENOENT:
1535
def get_contents(tree, file_id):
1536
"""Return the appropriate contents to create a copy of file_id from tree"""
1537
if file_id not in tree:
1539
kind = tree.kind(file_id)
1541
return TreeFileCreate(tree, file_id)
1542
elif kind in ("directory", "root_directory"):
1544
elif kind == "symlink":
1545
return SymlinkCreate(tree.get_symlink_target(file_id))
1547
raise UnsupportedFiletype(kind, tree.id2path(file_id))
1509
1550
def full_path(entry, tree):
1510
return os.path.join(tree.root, entry.path)
1551
return os.path.join(tree.basedir, entry.path)
1512
1553
def new_delete_entry(entry, tree, inventory, delete):
1513
1554
if entry.path == "":