1
# Copyright (C) 2004 Aaron Bentley <aaron.bentley@utoronto.ca>
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20
from bzrlib.trace import mutter
22
Represent and apply a changeset
24
__docformat__ = "restructuredtext"
28
class OldFailedTreeOp(Exception):
30
Exception.__init__(self, "bzr-tree-change contains files from a"
31
" previous failed merge operation.")
32
def invert_dict(dict):
34
for (key,value) in dict.iteritems():
40
class ChangeUnixPermissions(object):
41
"""This is two-way change, suitable for file modification, creation,
43
def __init__(self, old_mode, new_mode):
44
self.old_mode = old_mode
45
self.new_mode = new_mode
47
def apply(self, filename, conflict_handler, reverse=False):
49
from_mode = self.old_mode
50
to_mode = self.new_mode
52
from_mode = self.new_mode
53
to_mode = self.old_mode
55
current_mode = os.stat(filename).st_mode &0777
57
if e.errno == errno.ENOENT:
58
if conflict_handler.missing_for_chmod(filename) == "skip":
61
current_mode = from_mode
63
if from_mode is not None and current_mode != from_mode:
64
if conflict_handler.wrong_old_perms(filename, from_mode,
65
current_mode) != "continue":
68
if to_mode is not None:
70
os.chmod(filename, to_mode)
72
if e.errno == errno.ENOENT:
73
conflict_handler.missing_for_chmod(filename)
75
def __eq__(self, other):
76
if not isinstance(other, ChangeUnixPermissions):
78
elif self.old_mode != other.old_mode:
80
elif self.new_mode != other.new_mode:
85
def __ne__(self, other):
86
return not (self == other)
88
def dir_create(filename, conflict_handler, reverse):
89
"""Creates the directory, or deletes it if reverse is true. Intended to be
90
used with ReplaceContents.
92
:param filename: The name of the directory to create
94
:param reverse: If true, delete the directory, instead
101
if e.errno != errno.EEXIST:
103
if conflict_handler.dir_exists(filename) == "continue":
106
if e.errno == errno.ENOENT:
107
if conflict_handler.missing_parent(filename)=="continue":
108
file(filename, "wb").write(self.contents)
115
if conflict_handler.rmdir_non_empty(filename) == "skip":
122
class SymlinkCreate(object):
123
"""Creates or deletes a symlink (for use with ReplaceContents)"""
124
def __init__(self, contents):
127
:param contents: The filename of the target the symlink should point to
130
self.target = contents
132
def __call__(self, filename, conflict_handler, reverse):
133
"""Creates or destroys the symlink.
135
:param filename: The name of the symlink to create
139
assert(os.readlink(filename) == self.target)
143
os.symlink(self.target, filename)
145
if e.errno != errno.EEXIST:
147
if conflict_handler.link_name_exists(filename) == "continue":
148
os.symlink(self.target, filename)
150
def __eq__(self, other):
151
if not isinstance(other, SymlinkCreate):
153
elif self.target != other.target:
158
def __ne__(self, other):
159
return not (self == other)
161
class FileCreate(object):
162
"""Create or delete a file (for use with ReplaceContents)"""
163
def __init__(self, contents):
166
:param contents: The contents of the file to write
169
self.contents = contents
172
return "FileCreate(%i b)" % len(self.contents)
174
def __eq__(self, other):
175
if not isinstance(other, FileCreate):
177
elif self.contents != other.contents:
182
def __ne__(self, other):
183
return not (self == other)
185
def __call__(self, filename, conflict_handler, reverse):
186
"""Create or delete a file
188
:param filename: The name of the file to create
190
:param reverse: Delete the file instead of creating it
195
file(filename, "wb").write(self.contents)
197
if e.errno == errno.ENOENT:
198
if conflict_handler.missing_parent(filename)=="continue":
199
file(filename, "wb").write(self.contents)
205
if (file(filename, "rb").read() != self.contents):
206
direction = conflict_handler.wrong_old_contents(filename,
208
if direction != "continue":
212
if e.errno != errno.ENOENT:
214
if conflict_handler.missing_for_rm(filename, undo) == "skip":
219
def reversed(sequence):
220
max = len(sequence) - 1
221
for i in range(len(sequence)):
222
yield sequence[max - i]
224
class ReplaceContents(object):
225
"""A contents-replacement framework. It allows a file/directory/symlink to
226
be created, deleted, or replaced with another file/directory/symlink.
227
Arguments must be callable with (filename, reverse).
229
def __init__(self, old_contents, new_contents):
232
:param old_contents: The change to reverse apply (e.g. a deletion), \
234
:type old_contents: `dir_create`, `SymlinkCreate`, `FileCreate`, \
236
:param new_contents: The second change to apply (e.g. a creation), \
238
:type new_contents: `dir_create`, `SymlinkCreate`, `FileCreate`, \
241
self.old_contents=old_contents
242
self.new_contents=new_contents
245
return "ReplaceContents(%r -> %r)" % (self.old_contents,
248
def __eq__(self, other):
249
if not isinstance(other, ReplaceContents):
251
elif self.old_contents != other.old_contents:
253
elif self.new_contents != other.new_contents:
257
def __ne__(self, other):
258
return not (self == other)
260
def apply(self, filename, conflict_handler, reverse=False):
261
"""Applies the FileReplacement to the specified filename
263
:param filename: The name of the file to apply changes to
265
:param reverse: If true, apply the change in reverse
269
undo = self.old_contents
270
perform = self.new_contents
272
undo = self.new_contents
273
perform = self.old_contents
277
mode = os.lstat(filename).st_mode
278
if stat.S_ISLNK(mode):
281
if e.errno != errno.ENOENT:
283
if conflict_handler.missing_for_rm(filename, undo) == "skip":
285
undo(filename, conflict_handler, reverse=True)
286
if perform is not None:
287
perform(filename, conflict_handler, reverse=False)
289
os.chmod(filename, mode)
291
class ApplySequence(object):
292
def __init__(self, changes=None):
294
if changes is not None:
295
self.changes.extend(changes)
297
def __eq__(self, other):
298
if not isinstance(other, ApplySequence):
300
elif len(other.changes) != len(self.changes):
303
for i in range(len(self.changes)):
304
if self.changes[i] != other.changes[i]:
308
def __ne__(self, other):
309
return not (self == other)
312
def apply(self, filename, conflict_handler, reverse=False):
316
iter = reversed(self.changes)
318
change.apply(filename, conflict_handler, reverse)
321
class Diff3Merge(object):
322
def __init__(self, base_file, other_file):
323
self.base_file = base_file
324
self.other_file = other_file
326
def __eq__(self, other):
327
if not isinstance(other, Diff3Merge):
329
return (self.base_file == other.base_file and
330
self.other_file == other.other_file)
332
def __ne__(self, other):
333
return not (self == other)
335
def apply(self, filename, conflict_handler, reverse=False):
336
new_file = filename+".new"
338
base = self.base_file
339
other = self.other_file
341
base = self.other_file
342
other = self.base_file
343
status = patch.diff3(new_file, filename, base, other)
345
os.chmod(new_file, os.stat(filename).st_mode)
346
os.rename(new_file, filename)
350
conflict_handler.merge_conflict(new_file, filename, base, other)
354
"""Convenience function to create a directory.
356
:return: A ReplaceContents that will create a directory
357
:rtype: `ReplaceContents`
359
return ReplaceContents(None, dir_create)
362
"""Convenience function to delete a directory.
364
:return: A ReplaceContents that will delete a directory
365
:rtype: `ReplaceContents`
367
return ReplaceContents(dir_create, None)
369
def CreateFile(contents):
370
"""Convenience fucntion to create a file.
372
:param contents: The contents of the file to create
374
:return: A ReplaceContents that will create a file
375
:rtype: `ReplaceContents`
377
return ReplaceContents(None, FileCreate(contents))
379
def DeleteFile(contents):
380
"""Convenience fucntion to delete a file.
382
:param contents: The contents of the file to delete
384
:return: A ReplaceContents that will delete a file
385
:rtype: `ReplaceContents`
387
return ReplaceContents(FileCreate(contents), None)
389
def ReplaceFileContents(old_contents, new_contents):
390
"""Convenience fucntion to replace the contents of a file.
392
:param old_contents: The contents of the file to replace
393
:type old_contents: str
394
:param new_contents: The contents to replace the file with
395
:type new_contents: str
396
:return: A ReplaceContents that will replace the contents of a file a file
397
:rtype: `ReplaceContents`
399
return ReplaceContents(FileCreate(old_contents), FileCreate(new_contents))
401
def CreateSymlink(target):
402
"""Convenience fucntion to create a symlink.
404
:param target: The path the link should point to
406
:return: A ReplaceContents that will delete a file
407
:rtype: `ReplaceContents`
409
return ReplaceContents(None, SymlinkCreate(target))
411
def DeleteSymlink(target):
412
"""Convenience fucntion to delete a symlink.
414
:param target: The path the link should point to
416
:return: A ReplaceContents that will delete a file
417
:rtype: `ReplaceContents`
419
return ReplaceContents(SymlinkCreate(target), None)
421
def ChangeTarget(old_target, new_target):
422
"""Convenience fucntion to change the target of a symlink.
424
:param old_target: The current link target
425
:type old_target: str
426
:param new_target: The new link target to use
427
:type new_target: str
428
:return: A ReplaceContents that will delete a file
429
:rtype: `ReplaceContents`
431
return ReplaceContents(SymlinkCreate(old_target), SymlinkCreate(new_target))
434
class InvalidEntry(Exception):
435
"""Raise when a ChangesetEntry is invalid in some way"""
436
def __init__(self, entry, problem):
439
:param entry: The invalid ChangesetEntry
440
:type entry: `ChangesetEntry`
441
:param problem: The problem with the entry
444
msg = "Changeset entry for %s (%s) is invalid.\n%s" % (entry.id,
447
Exception.__init__(self, msg)
451
class SourceRootHasName(InvalidEntry):
452
"""This changeset entry has a name other than "", but its parent is !NULL"""
453
def __init__(self, entry, name):
456
:param entry: The invalid ChangesetEntry
457
:type entry: `ChangesetEntry`
458
:param name: The name of the entry
461
msg = 'Child of !NULL is named "%s", not "./.".' % name
462
InvalidEntry.__init__(self, entry, msg)
464
class NullIDAssigned(InvalidEntry):
465
"""The id !NULL was assigned to a real entry"""
466
def __init__(self, entry):
469
:param entry: The invalid ChangesetEntry
470
:type entry: `ChangesetEntry`
472
msg = '"!NULL" id assigned to a file "%s".' % entry.path
473
InvalidEntry.__init__(self, entry, msg)
475
class ParentIDIsSelf(InvalidEntry):
476
"""An entry is marked as its own parent"""
477
def __init__(self, entry):
480
:param entry: The invalid ChangesetEntry
481
:type entry: `ChangesetEntry`
483
msg = 'file %s has "%s" id for both self id and parent id.' % \
484
(entry.path, entry.id)
485
InvalidEntry.__init__(self, entry, msg)
487
class ChangesetEntry(object):
488
"""An entry the changeset"""
489
def __init__(self, id, parent, path):
490
"""Constructor. Sets parent and name assuming it was not
491
renamed/created/deleted.
492
:param id: The id associated with the entry
493
:param parent: The id of the parent of this entry (or !NULL if no
495
:param path: The file path relative to the tree root of this entry
501
self.new_parent = parent
502
self.contents_change = None
503
self.metadata_change = None
504
if parent == NULL_ID and path !='./.':
505
raise SourceRootHasName(self, path)
506
if self.id == NULL_ID:
507
raise NullIDAssigned(self)
508
if self.id == self.parent:
509
raise ParentIDIsSelf(self)
512
return "ChangesetEntry(%s)" % self.id
515
if self.path is None:
517
return os.path.dirname(self.path)
519
def __set_dir(self, dir):
520
self.path = os.path.join(dir, os.path.basename(self.path))
522
dir = property(__get_dir, __set_dir)
524
def __get_name(self):
525
if self.path is None:
527
return os.path.basename(self.path)
529
def __set_name(self, name):
530
self.path = os.path.join(os.path.dirname(self.path), name)
532
name = property(__get_name, __set_name)
534
def __get_new_dir(self):
535
if self.new_path is None:
537
return os.path.dirname(self.new_path)
539
def __set_new_dir(self, dir):
540
self.new_path = os.path.join(dir, os.path.basename(self.new_path))
542
new_dir = property(__get_new_dir, __set_new_dir)
544
def __get_new_name(self):
545
if self.new_path is None:
547
return os.path.basename(self.new_path)
549
def __set_new_name(self, name):
550
self.new_path = os.path.join(os.path.dirname(self.new_path), name)
552
new_name = property(__get_new_name, __set_new_name)
554
def needs_rename(self):
555
"""Determines whether the entry requires renaming.
560
return (self.parent != self.new_parent or self.name != self.new_name)
562
def is_deletion(self, reverse):
563
"""Return true if applying the entry would delete a file/directory.
565
:param reverse: if true, the changeset is being applied in reverse
568
return ((self.new_parent is None and not reverse) or
569
(self.parent is None and reverse))
571
def is_creation(self, reverse):
572
"""Return true if applying the entry would create a file/directory.
574
:param reverse: if true, the changeset is being applied in reverse
577
return ((self.parent is None and not reverse) or
578
(self.new_parent is None and reverse))
580
def is_creation_or_deletion(self):
581
"""Return true if applying the entry would create or delete a
586
return self.parent is None or self.new_parent is None
588
def get_cset_path(self, mod=False):
589
"""Determine the path of the entry according to the changeset.
591
:param changeset: The changeset to derive the path from
592
:type changeset: `Changeset`
593
:param mod: If true, generate the MOD path. Otherwise, generate the \
595
:return: the path of the entry, or None if it did not exist in the \
597
:rtype: str or NoneType
600
if self.new_parent == NULL_ID:
602
elif self.new_parent is None:
606
if self.parent == NULL_ID:
608
elif self.parent is None:
612
def summarize_name(self, changeset, reverse=False):
613
"""Produce a one-line summary of the filename. Indicates renames as
614
old => new, indicates creation as None => new, indicates deletion as
617
:param changeset: The changeset to get paths from
618
:type changeset: `Changeset`
619
:param reverse: If true, reverse the names in the output
623
orig_path = self.get_cset_path(False)
624
mod_path = self.get_cset_path(True)
625
if orig_path is not None:
626
orig_path = orig_path[2:]
627
if mod_path is not None:
628
mod_path = mod_path[2:]
629
if orig_path == mod_path:
633
return "%s => %s" % (orig_path, mod_path)
635
return "%s => %s" % (mod_path, orig_path)
638
def get_new_path(self, id_map, changeset, reverse=False):
639
"""Determine the full pathname to rename to
641
:param id_map: The map of ids to filenames for the tree
642
:type id_map: Dictionary
643
:param changeset: The changeset to get data from
644
:type changeset: `Changeset`
645
:param reverse: If true, we're applying the changeset in reverse
649
mutter("Finding new path for %s" % self.summarize_name(changeset))
653
from_dir = self.new_dir
655
from_name = self.new_name
657
parent = self.new_parent
658
to_dir = self.new_dir
660
to_name = self.new_name
661
from_name = self.name
666
if parent == NULL_ID or parent is None:
668
raise SourceRootHasName(self, to_name)
671
if from_dir == to_dir:
672
dir = os.path.dirname(id_map[self.id])
674
mutter("path, new_path: %r %r" % (self.path, self.new_path))
675
parent_entry = changeset.entries[parent]
676
dir = parent_entry.get_new_path(id_map, changeset, reverse)
677
if from_name == to_name:
678
name = os.path.basename(id_map[self.id])
681
assert(from_name is None or from_name == os.path.basename(id_map[self.id]))
682
return os.path.join(dir, name)
685
"""Determines whether the entry does nothing
687
:return: True if the entry does no renames or content changes
690
if self.contents_change is not None:
692
elif self.metadata_change is not None:
694
elif self.parent != self.new_parent:
696
elif self.name != self.new_name:
701
def apply(self, filename, conflict_handler, reverse=False):
702
"""Applies the file content and/or metadata changes.
704
:param filename: the filename of the entry
706
:param reverse: If true, apply the changes in reverse
709
if self.is_deletion(reverse) and self.metadata_change is not None:
710
self.metadata_change.apply(filename, conflict_handler, reverse)
711
if self.contents_change is not None:
712
self.contents_change.apply(filename, conflict_handler, reverse)
713
if not self.is_deletion(reverse) and self.metadata_change is not None:
714
self.metadata_change.apply(filename, conflict_handler, reverse)
716
class IDPresent(Exception):
717
def __init__(self, id):
718
msg = "Cannot add entry because that id has already been used:\n%s" %\
720
Exception.__init__(self, msg)
723
class Changeset(object):
724
"""A set of changes to apply"""
728
def add_entry(self, entry):
729
"""Add an entry to the list of entries"""
730
if self.entries.has_key(entry.id):
731
raise IDPresent(entry.id)
732
self.entries[entry.id] = entry
734
def my_sort(sequence, key, reverse=False):
735
"""A sort function that supports supplying a key for comparison
737
:param sequence: The sequence to sort
738
:param key: A callable object that returns the values to be compared
739
:param reverse: If true, sort in reverse order
742
def cmp_by_key(entry_a, entry_b):
747
return cmp(key(entry_a), key(entry_b))
748
sequence.sort(cmp_by_key)
750
def get_rename_entries(changeset, inventory, reverse):
751
"""Return a list of entries that will be renamed. Entries are sorted from
752
longest to shortest source path and from shortest to longest target path.
754
:param changeset: The changeset to look in
755
:type changeset: `Changeset`
756
:param inventory: The source of current tree paths for the given ids
757
:type inventory: Dictionary
758
:param reverse: If true, the changeset is being applied in reverse
760
:return: source entries and target entries as a tuple
763
source_entries = [x for x in changeset.entries.itervalues()
765
# these are done from longest path to shortest, to avoid deleting a
766
# parent before its children are deleted/renamed
767
def longest_to_shortest(entry):
768
path = inventory.get(entry.id)
773
my_sort(source_entries, longest_to_shortest, reverse=True)
775
target_entries = source_entries[:]
776
# These are done from shortest to longest path, to avoid creating a
777
# child before its parent has been created/renamed
778
def shortest_to_longest(entry):
779
path = entry.get_new_path(inventory, changeset, reverse)
784
my_sort(target_entries, shortest_to_longest)
785
return (source_entries, target_entries)
787
def rename_to_temp_delete(source_entries, inventory, dir, temp_dir,
788
conflict_handler, reverse):
789
"""Delete and rename entries as appropriate. Entries are renamed to temp
790
names. A map of id -> temp name (or None, for deletions) is returned.
792
:param source_entries: The entries to rename and delete
793
:type source_entries: List of `ChangesetEntry`
794
:param inventory: The map of id -> filename in the current tree
795
:type inventory: Dictionary
796
:param dir: The directory to apply changes to
798
:param reverse: Apply changes in reverse
800
:return: a mapping of id to temporary name
804
for i in range(len(source_entries)):
805
entry = source_entries[i]
806
if entry.is_deletion(reverse):
807
path = os.path.join(dir, inventory[entry.id])
808
entry.apply(path, conflict_handler, reverse)
809
temp_name[entry.id] = None
812
to_name = os.path.join(temp_dir, str(i))
813
src_path = inventory.get(entry.id)
814
if src_path is not None:
815
src_path = os.path.join(dir, src_path)
817
os.rename(src_path, to_name)
818
temp_name[entry.id] = to_name
820
if e.errno != errno.ENOENT:
822
if conflict_handler.missing_for_rename(src_path) == "skip":
828
def rename_to_new_create(changed_inventory, target_entries, inventory,
829
changeset, dir, conflict_handler, reverse):
830
"""Rename entries with temp names to their final names, create new files.
832
:param changed_inventory: A mapping of id to temporary name
833
:type changed_inventory: Dictionary
834
:param target_entries: The entries to apply changes to
835
:type target_entries: List of `ChangesetEntry`
836
:param changeset: The changeset to apply
837
:type changeset: `Changeset`
838
:param dir: The directory to apply changes to
840
:param reverse: If true, apply changes in reverse
843
for entry in target_entries:
844
new_tree_path = entry.get_new_path(inventory, changeset, reverse)
845
if new_tree_path is None:
847
new_path = os.path.join(dir, new_tree_path)
848
old_path = changed_inventory.get(entry.id)
849
if os.path.exists(new_path):
850
if conflict_handler.target_exists(entry, new_path, old_path) == \
853
if entry.is_creation(reverse):
854
entry.apply(new_path, conflict_handler, reverse)
855
changed_inventory[entry.id] = new_tree_path
860
os.rename(old_path, new_path)
861
changed_inventory[entry.id] = new_tree_path
863
raise Exception ("%s is missing" % new_path)
865
class TargetExists(Exception):
866
def __init__(self, entry, target):
867
msg = "The path %s already exists" % target
868
Exception.__init__(self, msg)
872
class RenameConflict(Exception):
873
def __init__(self, id, this_name, base_name, other_name):
874
msg = """Trees all have different names for a file
878
id: %s""" % (this_name, base_name, other_name, id)
879
Exception.__init__(self, msg)
880
self.this_name = this_name
881
self.base_name = base_name
882
self_other_name = other_name
884
class MoveConflict(Exception):
885
def __init__(self, id, this_parent, base_parent, other_parent):
886
msg = """The file is in different directories in every tree
890
id: %s""" % (this_parent, base_parent, other_parent, id)
891
Exception.__init__(self, msg)
892
self.this_parent = this_parent
893
self.base_parent = base_parent
894
self_other_parent = other_parent
896
class MergeConflict(Exception):
897
def __init__(self, this_path):
898
Exception.__init__(self, "Conflict applying changes to %s" % this_path)
899
self.this_path = this_path
901
class MergePermissionConflict(Exception):
902
def __init__(self, this_path, base_path, other_path):
903
this_perms = os.stat(this_path).st_mode & 0755
904
base_perms = os.stat(base_path).st_mode & 0755
905
other_perms = os.stat(other_path).st_mode & 0755
906
msg = """Conflicting permission for %s
910
""" % (this_path, this_perms, base_perms, other_perms)
911
self.this_path = this_path
912
self.base_path = base_path
913
self.other_path = other_path
914
Exception.__init__(self, msg)
916
class WrongOldContents(Exception):
917
def __init__(self, filename):
918
msg = "Contents mismatch deleting %s" % filename
919
self.filename = filename
920
Exception.__init__(self, msg)
922
class WrongOldPermissions(Exception):
923
def __init__(self, filename, old_perms, new_perms):
924
msg = "Permission missmatch on %s:\n" \
925
"Expected 0%o, got 0%o." % (filename, old_perms, new_perms)
926
self.filename = filename
927
Exception.__init__(self, msg)
929
class RemoveContentsConflict(Exception):
930
def __init__(self, filename):
931
msg = "Conflict deleting %s, which has different contents in BASE"\
932
" and THIS" % filename
933
self.filename = filename
934
Exception.__init__(self, msg)
936
class DeletingNonEmptyDirectory(Exception):
937
def __init__(self, filename):
938
msg = "Trying to remove dir %s while it still had files" % filename
939
self.filename = filename
940
Exception.__init__(self, msg)
943
class PatchTargetMissing(Exception):
944
def __init__(self, filename):
945
msg = "Attempt to patch %s, which does not exist" % filename
946
Exception.__init__(self, msg)
947
self.filename = filename
949
class MissingPermsFile(Exception):
950
def __init__(self, filename):
951
msg = "Attempt to change permissions on %s, which does not exist" %\
953
Exception.__init__(self, msg)
954
self.filename = filename
956
class MissingForRm(Exception):
957
def __init__(self, filename):
958
msg = "Attempt to remove missing path %s" % filename
959
Exception.__init__(self, msg)
960
self.filename = filename
963
class MissingForRename(Exception):
964
def __init__(self, filename):
965
msg = "Attempt to move missing path %s" % (filename)
966
Exception.__init__(self, msg)
967
self.filename = filename
969
class NewContentsConflict(Exception):
970
def __init__(self, filename):
971
msg = "Conflicting contents for new file %s" % (filename)
972
Exception.__init__(self, msg)
975
class MissingForMerge(Exception):
976
def __init__(self, filename):
977
msg = "The file %s was modified, but does not exist in this tree"\
979
Exception.__init__(self, msg)
982
class ExceptionConflictHandler(object):
983
def __init__(self, dir):
986
def missing_parent(self, pathname):
987
parent = os.path.dirname(pathname)
988
raise Exception("Parent directory missing for %s" % pathname)
990
def dir_exists(self, pathname):
991
raise Exception("Directory already exists for %s" % pathname)
993
def failed_hunks(self, pathname):
994
raise Exception("Failed to apply some hunks for %s" % pathname)
996
def target_exists(self, entry, target, old_path):
997
raise TargetExists(entry, target)
999
def rename_conflict(self, id, this_name, base_name, other_name):
1000
raise RenameConflict(id, this_name, base_name, other_name)
1002
def move_conflict(self, id, inventory):
1003
this_dir = inventory.this.get_dir(id)
1004
base_dir = inventory.base.get_dir(id)
1005
other_dir = inventory.other.get_dir(id)
1006
raise MoveConflict(id, this_dir, base_dir, other_dir)
1008
def merge_conflict(self, new_file, this_path, base_path, other_path):
1010
raise MergeConflict(this_path)
1012
def permission_conflict(self, this_path, base_path, other_path):
1013
raise MergePermissionConflict(this_path, base_path, other_path)
1015
def wrong_old_contents(self, filename, expected_contents):
1016
raise WrongOldContents(filename)
1018
def rem_contents_conflict(self, filename, this_contents, base_contents):
1019
raise RemoveContentsConflict(filename)
1021
def wrong_old_perms(self, filename, old_perms, new_perms):
1022
raise WrongOldPermissions(filename, old_perms, new_perms)
1024
def rmdir_non_empty(self, filename):
1025
raise DeletingNonEmptyDirectory(filename)
1027
def link_name_exists(self, filename):
1028
raise TargetExists(filename)
1030
def patch_target_missing(self, filename, contents):
1031
raise PatchTargetMissing(filename)
1033
def missing_for_chmod(self, filename):
1034
raise MissingPermsFile(filename)
1036
def missing_for_rm(self, filename, change):
1037
raise MissingForRm(filename)
1039
def missing_for_rename(self, filename):
1040
raise MissingForRename(filename)
1042
def missing_for_merge(self, file_id, inventory):
1043
raise MissingForMerge(inventory.other.get_path(file_id))
1045
def new_contents_conflict(self, filename, other_contents):
1046
raise NewContentsConflict(filename)
1051
def apply_changeset(changeset, inventory, dir, conflict_handler=None,
1053
"""Apply a changeset to a directory.
1055
:param changeset: The changes to perform
1056
:type changeset: `Changeset`
1057
:param inventory: The mapping of id to filename for the directory
1058
:type inventory: Dictionary
1059
:param dir: The path of the directory to apply the changes to
1061
:param reverse: If true, apply the changes in reverse
1063
:return: The mapping of the changed entries
1066
if conflict_handler is None:
1067
conflict_handler = ExceptionConflictHandler(dir)
1068
temp_dir = os.path.join(dir, "bzr-tree-change")
1072
if e.errno == errno.EEXIST:
1076
if e.errno == errno.ENOTEMPTY:
1077
raise OldFailedTreeOp()
1082
#apply changes that don't affect filenames
1083
for entry in changeset.entries.itervalues():
1084
if not entry.is_creation_or_deletion():
1085
path = os.path.join(dir, inventory[entry.id])
1086
entry.apply(path, conflict_handler, reverse)
1088
# Apply renames in stages, to minimize conflicts:
1089
# Only files whose name or parent change are interesting, because their
1090
# target name may exist in the source tree. If a directory's name changes,
1091
# that doesn't make its children interesting.
1092
(source_entries, target_entries) = get_rename_entries(changeset, inventory,
1095
changed_inventory = rename_to_temp_delete(source_entries, inventory, dir,
1096
temp_dir, conflict_handler,
1099
rename_to_new_create(changed_inventory, target_entries, inventory,
1100
changeset, dir, conflict_handler, reverse)
1102
return changed_inventory
1105
def apply_changeset_tree(cset, tree, reverse=False):
1107
for entry in tree.source_inventory().itervalues():
1108
inventory[entry.id] = entry.path
1109
new_inventory = apply_changeset(cset, r_inventory, tree.root,
1111
new_entries, remove_entries = \
1112
get_inventory_change(inventory, new_inventory, cset, reverse)
1113
tree.update_source_inventory(new_entries, remove_entries)
1116
def get_inventory_change(inventory, new_inventory, cset, reverse=False):
1119
for entry in cset.entries.itervalues():
1120
if entry.needs_rename():
1121
new_path = entry.get_new_path(inventory, cset)
1122
if new_path is None:
1123
remove_entries.append(entry.id)
1125
new_entries[new_path] = entry.id
1126
return new_entries, remove_entries
1129
def print_changeset(cset):
1130
"""Print all non-boring changeset entries
1132
:param cset: The changeset to print
1133
:type cset: `Changeset`
1135
for entry in cset.entries.itervalues():
1136
if entry.is_boring():
1139
print entry.summarize_name(cset)
1141
class CompositionFailure(Exception):
1142
def __init__(self, old_entry, new_entry, problem):
1143
msg = "Unable to conpose entries.\n %s" % problem
1144
Exception.__init__(self, msg)
1146
class IDMismatch(CompositionFailure):
1147
def __init__(self, old_entry, new_entry):
1148
problem = "Attempt to compose entries with different ids: %s and %s" %\
1149
(old_entry.id, new_entry.id)
1150
CompositionFailure.__init__(self, old_entry, new_entry, problem)
1152
def compose_changesets(old_cset, new_cset):
1153
"""Combine two changesets into one. This works well for exact patching.
1154
Otherwise, not so well.
1156
:param old_cset: The first changeset that would be applied
1157
:type old_cset: `Changeset`
1158
:param new_cset: The second changeset that would be applied
1159
:type new_cset: `Changeset`
1160
:return: A changeset that combines the changes in both changesets
1163
composed = Changeset()
1164
for old_entry in old_cset.entries.itervalues():
1165
new_entry = new_cset.entries.get(old_entry.id)
1166
if new_entry is None:
1167
composed.add_entry(old_entry)
1169
composed_entry = compose_entries(old_entry, new_entry)
1170
if composed_entry.parent is not None or\
1171
composed_entry.new_parent is not None:
1172
composed.add_entry(composed_entry)
1173
for new_entry in new_cset.entries.itervalues():
1174
if not old_cset.entries.has_key(new_entry.id):
1175
composed.add_entry(new_entry)
1178
def compose_entries(old_entry, new_entry):
1179
"""Combine two entries into one.
1181
:param old_entry: The first entry that would be applied
1182
:type old_entry: ChangesetEntry
1183
:param old_entry: The second entry that would be applied
1184
:type old_entry: ChangesetEntry
1185
:return: A changeset entry combining both entries
1186
:rtype: `ChangesetEntry`
1188
if old_entry.id != new_entry.id:
1189
raise IDMismatch(old_entry, new_entry)
1190
output = ChangesetEntry(old_entry.id, old_entry.parent, old_entry.path)
1192
if (old_entry.parent != old_entry.new_parent or
1193
new_entry.parent != new_entry.new_parent):
1194
output.new_parent = new_entry.new_parent
1196
if (old_entry.path != old_entry.new_path or
1197
new_entry.path != new_entry.new_path):
1198
output.new_path = new_entry.new_path
1200
output.contents_change = compose_contents(old_entry, new_entry)
1201
output.metadata_change = compose_metadata(old_entry, new_entry)
1204
def compose_contents(old_entry, new_entry):
1205
"""Combine the contents of two changeset entries. Entries are combined
1206
intelligently where possible, but the fallback behavior returns an
1209
:param old_entry: The first entry that would be applied
1210
:type old_entry: `ChangesetEntry`
1211
:param new_entry: The second entry that would be applied
1212
:type new_entry: `ChangesetEntry`
1213
:return: A combined contents change
1214
:rtype: anything supporting the apply(reverse=False) method
1216
old_contents = old_entry.contents_change
1217
new_contents = new_entry.contents_change
1218
if old_entry.contents_change is None:
1219
return new_entry.contents_change
1220
elif new_entry.contents_change is None:
1221
return old_entry.contents_change
1222
elif isinstance(old_contents, ReplaceContents) and \
1223
isinstance(new_contents, ReplaceContents):
1224
if old_contents.old_contents == new_contents.new_contents:
1227
return ReplaceContents(old_contents.old_contents,
1228
new_contents.new_contents)
1229
elif isinstance(old_contents, ApplySequence):
1230
output = ApplySequence(old_contents.changes)
1231
if isinstance(new_contents, ApplySequence):
1232
output.changes.extend(new_contents.changes)
1234
output.changes.append(new_contents)
1236
elif isinstance(new_contents, ApplySequence):
1237
output = ApplySequence((old_contents.changes,))
1238
output.extend(new_contents.changes)
1241
return ApplySequence((old_contents, new_contents))
1243
def compose_metadata(old_entry, new_entry):
1244
old_meta = old_entry.metadata_change
1245
new_meta = new_entry.metadata_change
1246
if old_meta is None:
1248
elif new_meta is None:
1250
elif isinstance(old_meta, ChangeUnixPermissions) and \
1251
isinstance(new_meta, ChangeUnixPermissions):
1252
return ChangeUnixPermissions(old_meta.old_mode, new_meta.new_mode)
1254
return ApplySequence(old_meta, new_meta)
1257
def changeset_is_null(changeset):
1258
for entry in changeset.entries.itervalues():
1259
if not entry.is_boring():
1263
class UnsuppportedFiletype(Exception):
1264
def __init__(self, full_path, stat_result):
1265
msg = "The file \"%s\" is not a supported filetype." % full_path
1266
Exception.__init__(self, msg)
1267
self.full_path = full_path
1268
self.stat_result = stat_result
1270
def generate_changeset(tree_a, tree_b, inventory_a=None, inventory_b=None,
1271
interesting_ids=None):
1272
return ChangesetGenerator(tree_a, tree_b, inventory_a, inventory_b,
1275
class ChangesetGenerator(object):
1276
def __init__(self, tree_a, tree_b, inventory_a=None, inventory_b=None,
1277
interesting_ids=None):
1278
object.__init__(self)
1279
self.tree_a = tree_a
1280
self.tree_b = tree_b
1281
if inventory_a is not None:
1282
self.inventory_a = inventory_a
1284
self.inventory_a = tree_a.inventory()
1285
if inventory_b is not None:
1286
self.inventory_b = inventory_b
1288
self.inventory_b = tree_b.inventory()
1289
self.r_inventory_a = self.reverse_inventory(self.inventory_a)
1290
self.r_inventory_b = self.reverse_inventory(self.inventory_b)
1291
self._interesting_ids = interesting_ids
1293
def reverse_inventory(self, inventory):
1295
for entry in inventory.itervalues():
1296
if entry.id is None:
1298
r_inventory[entry.id] = entry
1303
for entry in self.inventory_a.itervalues():
1304
if entry.id is None:
1306
cs_entry = self.make_entry(entry.id)
1307
if cs_entry is not None and not cs_entry.is_boring():
1308
cset.add_entry(cs_entry)
1310
for entry in self.inventory_b.itervalues():
1311
if entry.id is None:
1313
if not self.r_inventory_a.has_key(entry.id):
1314
cs_entry = self.make_entry(entry.id)
1315
if cs_entry is not None and not cs_entry.is_boring():
1316
cset.add_entry(cs_entry)
1317
for entry in list(cset.entries.itervalues()):
1318
if entry.parent != entry.new_parent:
1319
if not cset.entries.has_key(entry.parent) and\
1320
entry.parent != NULL_ID and entry.parent is not None:
1321
parent_entry = self.make_boring_entry(entry.parent)
1322
cset.add_entry(parent_entry)
1323
if not cset.entries.has_key(entry.new_parent) and\
1324
entry.new_parent != NULL_ID and \
1325
entry.new_parent is not None:
1326
parent_entry = self.make_boring_entry(entry.new_parent)
1327
cset.add_entry(parent_entry)
1330
def get_entry_parent(self, entry, inventory):
1333
if entry.path == "./.":
1335
dirname = os.path.dirname(entry.path)
1338
parent = inventory[dirname]
1341
def get_path(self, entry, tree):
1344
if entry.path == ".":
1348
def make_basic_entry(self, id, only_interesting):
1349
entry_a = self.r_inventory_a.get(id)
1350
entry_b = self.r_inventory_b.get(id)
1351
if only_interesting and not self.is_interesting(entry_a, entry_b):
1353
parent = self.get_entry_parent(entry_a, self.inventory_a)
1354
path = self.get_path(entry_a, self.tree_a)
1355
cs_entry = ChangesetEntry(id, parent, path)
1356
new_parent = self.get_entry_parent(entry_b, self.inventory_b)
1359
new_path = self.get_path(entry_b, self.tree_b)
1361
cs_entry.new_path = new_path
1362
cs_entry.new_parent = new_parent
1365
def is_interesting(self, entry_a, entry_b):
1366
if self._interesting_ids is None:
1368
if entry_a is not None:
1369
file_id = entry_a.id
1370
elif entry_b is not None:
1371
file_id = entry_b.id
1374
return file_id in self._interesting_ids
1376
def make_boring_entry(self, id):
1377
cs_entry = self.make_basic_entry(id, only_interesting=False)
1378
if cs_entry.is_creation_or_deletion():
1379
return self.make_entry(id, only_interesting=False)
1384
def make_entry(self, id, only_interesting=True):
1385
cs_entry = self.make_basic_entry(id, only_interesting)
1387
if cs_entry is None:
1389
if id in self.tree_a and id in self.tree_b:
1390
a_sha1 = self.tree_a.get_file_sha1(id)
1391
b_sha1 = self.tree_b.get_file_sha1(id)
1392
if None not in (a_sha1, b_sha1) and a_sha1 == b_sha1:
1395
full_path_a = self.tree_a.readonly_path(id)
1396
full_path_b = self.tree_b.readonly_path(id)
1397
stat_a = self.lstat(full_path_a)
1398
stat_b = self.lstat(full_path_b)
1400
cs_entry.new_parent = None
1401
cs_entry.new_path = None
1403
cs_entry.metadata_change = self.make_mode_change(stat_a, stat_b)
1404
cs_entry.contents_change = self.make_contents_change(full_path_a,
1410
def make_mode_change(self, stat_a, stat_b):
1412
if stat_a is not None and not stat.S_ISLNK(stat_a.st_mode):
1413
mode_a = stat_a.st_mode & 0777
1415
if stat_b is not None and not stat.S_ISLNK(stat_b.st_mode):
1416
mode_b = stat_b.st_mode & 0777
1417
if mode_a == mode_b:
1419
return ChangeUnixPermissions(mode_a, mode_b)
1421
def make_contents_change(self, full_path_a, stat_a, full_path_b, stat_b):
1422
if stat_a is None and stat_b is None:
1424
if None not in (stat_a, stat_b) and stat.S_ISDIR(stat_a.st_mode) and\
1425
stat.S_ISDIR(stat_b.st_mode):
1427
if None not in (stat_a, stat_b) and stat.S_ISREG(stat_a.st_mode) and\
1428
stat.S_ISREG(stat_b.st_mode):
1429
if stat_a.st_ino == stat_b.st_ino and \
1430
stat_a.st_dev == stat_b.st_dev:
1433
a_contents = self.get_contents(stat_a, full_path_a)
1434
b_contents = self.get_contents(stat_b, full_path_b)
1435
if a_contents == b_contents:
1437
return ReplaceContents(a_contents, b_contents)
1439
def get_contents(self, stat_result, full_path):
1440
if stat_result is None:
1442
elif stat.S_ISREG(stat_result.st_mode):
1443
return FileCreate(file(full_path, "rb").read())
1444
elif stat.S_ISDIR(stat_result.st_mode):
1446
elif stat.S_ISLNK(stat_result.st_mode):
1447
return SymlinkCreate(os.readlink(full_path))
1449
raise UnsupportedFiletype(full_path, stat_result)
1451
def lstat(self, full_path):
1453
if full_path is not None:
1455
stat_result = os.lstat(full_path)
1457
if e.errno != errno.ENOENT:
1462
def full_path(entry, tree):
1463
return os.path.join(tree.root, entry.path)
1465
def new_delete_entry(entry, tree, inventory, delete):
1466
if entry.path == "":
1469
parent = inventory[dirname(entry.path)].id
1470
cs_entry = ChangesetEntry(parent, entry.path)
1472
cs_entry.new_path = None
1473
cs_entry.new_parent = None
1475
cs_entry.path = None
1476
cs_entry.parent = None
1477
full_path = full_path(entry, tree)
1478
status = os.lstat(full_path)
1479
if stat.S_ISDIR(file_stat.st_mode):
1485
# XXX: Can't we unify this with the regular inventory object
1486
class Inventory(object):
1487
def __init__(self, inventory):
1488
self.inventory = inventory
1489
self.rinventory = None
1491
def get_rinventory(self):
1492
if self.rinventory is None:
1493
self.rinventory = invert_dict(self.inventory)
1494
return self.rinventory
1496
def get_path(self, id):
1497
return self.inventory.get(id)
1499
def get_name(self, id):
1500
path = self.get_path(id)
1504
return os.path.basename(path)
1506
def get_dir(self, id):
1507
path = self.get_path(id)
1512
return os.path.dirname(path)
1514
def get_parent(self, id):
1515
if self.get_path(id) is None:
1517
directory = self.get_dir(id)
1518
if directory == '.':
1520
if directory is None:
1522
return self.get_rinventory().get(directory)