444
329
if e.errno != errno.ENOENT:
447
def action_auto(self, tree):
448
raise NotImplementedError(self.action_auto)
450
def action_done(self, tree):
451
"""Mark the conflict as solved once it has been handled."""
452
# This method does nothing but simplifies the design of upper levels.
455
def action_take_this(self, tree):
456
raise NotImplementedError(self.action_take_this)
458
def action_take_other(self, tree):
459
raise NotImplementedError(self.action_take_other)
461
def _resolve_with_cleanups(self, tree, *args, **kwargs):
462
with tree.transform() as tt:
463
self._resolve(tt, *args, **kwargs)
466
class PathConflict(Conflict):
467
"""A conflict was encountered merging file paths"""
469
typestring = 'path conflict'
471
format = 'Path conflict: %(path)s / %(conflict_path)s'
473
rformat = '%(class)s(%(path)r, %(conflict_path)r, %(file_id)r)'
475
def __init__(self, path, conflict_path=None, file_id=None):
476
Conflict.__init__(self, path, file_id)
477
self.conflict_path = conflict_path
480
s = Conflict.as_stanza(self)
481
if self.conflict_path is not None:
482
s.add('conflict_path', self.conflict_path)
485
def associated_filenames(self):
486
# No additional files have been generated here
489
def _resolve(self, tt, file_id, path, winner):
490
"""Resolve the conflict.
492
:param tt: The TreeTransform where the conflict is resolved.
493
:param file_id: The retained file id.
494
:param path: The retained path.
495
:param winner: 'this' or 'other' indicates which side is the winner.
497
path_to_create = None
499
if self.path == '<deleted>':
500
return # Nothing to do
501
if self.conflict_path == '<deleted>':
502
path_to_create = self.path
503
revid = tt._tree.get_parent_ids()[0]
504
elif winner == 'other':
505
if self.conflict_path == '<deleted>':
506
return # Nothing to do
507
if self.path == '<deleted>':
508
path_to_create = self.conflict_path
509
# FIXME: If there are more than two parents we may need to
510
# iterate. Taking the last parent is the safer bet in the mean
511
# time. -- vila 20100309
512
revid = tt._tree.get_parent_ids()[-1]
515
raise AssertionError('bad winner: %r' % (winner,))
516
if path_to_create is not None:
517
tid = tt.trans_id_tree_path(path_to_create)
518
tree = self._revision_tree(tt._tree, revid)
519
transform.create_from_tree(
520
tt, tid, tree, tree.id2path(file_id))
521
tt.version_file(tid, file_id=file_id)
523
tid = tt.trans_id_file_id(file_id)
524
# Adjust the path for the retained file id
525
parent_tid = tt.get_tree_parent(tid)
526
tt.adjust_path(osutils.basename(path), parent_tid, tid)
529
def _revision_tree(self, tree, revid):
530
return tree.branch.repository.revision_tree(revid)
532
def _infer_file_id(self, tree):
533
# Prior to bug #531967, file_id wasn't always set, there may still be
534
# conflict files in the wild so we need to cope with them
535
# Establish which path we should use to find back the file-id
537
for p in (self.path, self.conflict_path):
539
# special hard-coded path
542
possible_paths.append(p)
543
# Search the file-id in the parents with any path available
545
for revid in tree.get_parent_ids():
546
revtree = self._revision_tree(tree, revid)
547
for p in possible_paths:
548
file_id = revtree.path2id(p)
549
if file_id is not None:
550
return revtree, file_id
553
def action_take_this(self, tree):
554
if self.file_id is not None:
555
self._resolve_with_cleanups(tree, self.file_id, self.path,
558
# Prior to bug #531967 we need to find back the file_id and restore
559
# the content from there
560
revtree, file_id = self._infer_file_id(tree)
561
tree.revert([revtree.id2path(file_id)],
562
old_tree=revtree, backups=False)
564
def action_take_other(self, tree):
565
if self.file_id is not None:
566
self._resolve_with_cleanups(tree, self.file_id,
570
# Prior to bug #531967 we need to find back the file_id and restore
571
# the content from there
572
revtree, file_id = self._infer_file_id(tree)
573
tree.revert([revtree.id2path(file_id)],
574
old_tree=revtree, backups=False)
577
class ContentsConflict(PathConflict):
578
"""The files are of different types (or both binary), or not present"""
582
typestring = 'contents conflict'
584
format = 'Contents conflict in %(path)s'
586
def associated_filenames(self):
587
return [self.path + suffix for suffix in ('.BASE', '.OTHER')]
589
def _resolve(self, tt, suffix_to_remove):
590
"""Resolve the conflict.
592
:param tt: The TreeTransform where the conflict is resolved.
593
:param suffix_to_remove: Either 'THIS' or 'OTHER'
595
The resolution is symmetric: when taking THIS, OTHER is deleted and
596
item.THIS is renamed into item and vice-versa.
599
# Delete 'item.THIS' or 'item.OTHER' depending on
602
tt.trans_id_tree_path(self.path + '.' + suffix_to_remove))
603
except errors.NoSuchFile:
604
# There are valid cases where 'item.suffix_to_remove' either
605
# never existed or was already deleted (including the case
606
# where the user deleted it)
609
this_path = tt._tree.id2path(self.file_id)
610
except errors.NoSuchId:
611
# The file is not present anymore. This may happen if the user
612
# deleted the file either manually or when resolving a conflict on
613
# the parent. We may raise some exception to indicate that the
614
# conflict doesn't exist anymore and as such doesn't need to be
615
# resolved ? -- vila 20110615
618
this_tid = tt.trans_id_tree_path(this_path)
619
if this_tid is not None:
620
# Rename 'item.suffix_to_remove' (note that if
621
# 'item.suffix_to_remove' has been deleted, this is a no-op)
622
parent_tid = tt.get_tree_parent(this_tid)
623
tt.adjust_path(osutils.basename(self.path), parent_tid, this_tid)
626
def action_take_this(self, tree):
627
self._resolve_with_cleanups(tree, 'OTHER')
629
def action_take_other(self, tree):
630
self._resolve_with_cleanups(tree, 'THIS')
633
# TODO: There should be a base revid attribute to better inform the user about
634
# how the conflicts were generated.
635
class TextConflict(Conflict):
636
"""The merge algorithm could not resolve all differences encountered."""
640
typestring = 'text conflict'
642
format = 'Text conflict in %(path)s'
644
rformat = '%(class)s(%(path)r, %(file_id)r)'
646
_conflict_re = re.compile(b'^(<{7}|={7}|>{7})')
648
def associated_filenames(self):
649
return [self.path + suffix for suffix in CONFLICT_SUFFIXES]
651
def _resolve(self, tt, winner_suffix):
652
"""Resolve the conflict by copying one of .THIS or .OTHER into file.
654
:param tt: The TreeTransform where the conflict is resolved.
655
:param winner_suffix: Either 'THIS' or 'OTHER'
657
The resolution is symmetric, when taking THIS, item.THIS is renamed
658
into item and vice-versa. This takes one of the files as a whole
659
ignoring every difference that could have been merged cleanly.
661
# To avoid useless copies, we switch item and item.winner_suffix, only
662
# item will exist after the conflict has been resolved anyway.
663
item_tid = tt.trans_id_file_id(self.file_id)
664
item_parent_tid = tt.get_tree_parent(item_tid)
665
winner_path = self.path + '.' + winner_suffix
666
winner_tid = tt.trans_id_tree_path(winner_path)
667
winner_parent_tid = tt.get_tree_parent(winner_tid)
668
# Switch the paths to preserve the content
669
tt.adjust_path(osutils.basename(self.path),
670
winner_parent_tid, winner_tid)
671
tt.adjust_path(osutils.basename(winner_path),
672
item_parent_tid, item_tid)
673
# Associate the file_id to the right content
674
tt.unversion_file(item_tid)
675
tt.version_file(winner_tid, file_id=self.file_id)
678
def action_auto(self, tree):
679
# GZ 2012-07-27: Using NotImplementedError to signal that a conflict
680
# can't be auto resolved does not seem ideal.
682
kind = tree.kind(self.path)
683
except errors.NoSuchFile:
686
raise NotImplementedError("Conflict is not a file")
687
conflict_markers_in_line = self._conflict_re.search
688
# GZ 2012-07-27: What if not tree.has_id(self.file_id) due to removal?
689
with tree.get_file(self.path) as f:
691
if conflict_markers_in_line(line):
692
raise NotImplementedError("Conflict markers present")
694
def action_take_this(self, tree):
695
self._resolve_with_cleanups(tree, 'THIS')
697
def action_take_other(self, tree):
698
self._resolve_with_cleanups(tree, 'OTHER')
701
class HandledConflict(Conflict):
702
"""A path problem that has been provisionally resolved.
703
This is intended to be a base class.
706
rformat = "%(class)s(%(action)r, %(path)r, %(file_id)r)"
708
def __init__(self, action, path, file_id=None):
709
Conflict.__init__(self, path, file_id)
713
return Conflict._cmp_list(self) + [self.action]
716
s = Conflict.as_stanza(self)
717
s.add('action', self.action)
720
def associated_filenames(self):
721
# Nothing has been generated here
725
class HandledPathConflict(HandledConflict):
726
"""A provisionally-resolved path problem involving two paths.
727
This is intended to be a base class.
730
rformat = "%(class)s(%(action)r, %(path)r, %(conflict_path)r,"\
731
" %(file_id)r, %(conflict_file_id)r)"
733
def __init__(self, action, path, conflict_path, file_id=None,
734
conflict_file_id=None):
735
HandledConflict.__init__(self, action, path, file_id)
736
self.conflict_path = conflict_path
737
# the factory blindly transfers the Stanza values to __init__,
738
# so they can be unicode.
739
if isinstance(conflict_file_id, text_type):
740
conflict_file_id = cache_utf8.encode(conflict_file_id)
741
self.conflict_file_id = conflict_file_id
744
return HandledConflict._cmp_list(self) + [self.conflict_path,
745
self.conflict_file_id]
748
s = HandledConflict.as_stanza(self)
749
s.add('conflict_path', self.conflict_path)
750
if self.conflict_file_id is not None:
751
s.add('conflict_file_id', self.conflict_file_id.decode('utf8'))
756
class DuplicateID(HandledPathConflict):
757
"""Two files want the same file_id."""
759
typestring = 'duplicate id'
761
format = 'Conflict adding id to %(conflict_path)s. %(action)s %(path)s.'
764
class DuplicateEntry(HandledPathConflict):
765
"""Two directory entries want to have the same name."""
767
typestring = 'duplicate'
769
format = 'Conflict adding file %(conflict_path)s. %(action)s %(path)s.'
771
def action_take_this(self, tree):
772
tree.remove([self.conflict_path], force=True, keep_files=False)
773
tree.rename_one(self.path, self.conflict_path)
775
def action_take_other(self, tree):
776
tree.remove([self.path], force=True, keep_files=False)
779
class ParentLoop(HandledPathConflict):
780
"""An attempt to create an infinitely-looping directory structure.
781
This is rare, but can be produced like so:
790
typestring = 'parent loop'
792
format = 'Conflict moving %(path)s into %(conflict_path)s. %(action)s.'
794
def action_take_this(self, tree):
795
# just acccept brz proposal
798
def action_take_other(self, tree):
799
with tree.transform() as tt:
800
p_tid = tt.trans_id_file_id(self.file_id)
801
parent_tid = tt.get_tree_parent(p_tid)
802
cp_tid = tt.trans_id_file_id(self.conflict_file_id)
803
cparent_tid = tt.get_tree_parent(cp_tid)
804
tt.adjust_path(osutils.basename(self.path), cparent_tid, cp_tid)
805
tt.adjust_path(osutils.basename(self.conflict_path),
810
class UnversionedParent(HandledConflict):
811
"""An attempt to version a file whose parent directory is not versioned.
812
Typically, the result of a merge where one tree unversioned the directory
813
and the other added a versioned file to it.
816
typestring = 'unversioned parent'
818
format = 'Conflict because %(path)s is not versioned, but has versioned'\
819
' children. %(action)s.'
821
# FIXME: We silently do nothing to make tests pass, but most probably the
822
# conflict shouldn't exist (the long story is that the conflict is
823
# generated with another one that can be resolved properly) -- vila 091224
824
def action_take_this(self, tree):
827
def action_take_other(self, tree):
831
class MissingParent(HandledConflict):
832
"""An attempt to add files to a directory that is not present.
833
Typically, the result of a merge where THIS deleted the directory and
834
the OTHER added a file to it.
835
See also: DeletingParent (same situation, THIS and OTHER reversed)
838
typestring = 'missing parent'
840
format = 'Conflict adding files to %(path)s. %(action)s.'
842
def action_take_this(self, tree):
843
tree.remove([self.path], force=True, keep_files=False)
845
def action_take_other(self, tree):
846
# just acccept brz proposal
850
class DeletingParent(HandledConflict):
851
"""An attempt to add files to a directory that is not present.
852
Typically, the result of a merge where one OTHER deleted the directory and
853
the THIS added a file to it.
856
typestring = 'deleting parent'
858
format = "Conflict: can't delete %(path)s because it is not empty. "\
861
# FIXME: It's a bit strange that the default action is not coherent with
862
# MissingParent from the *user* pov.
864
def action_take_this(self, tree):
865
# just acccept brz proposal
868
def action_take_other(self, tree):
869
tree.remove([self.path], force=True, keep_files=False)
872
class NonDirectoryParent(HandledConflict):
873
"""An attempt to add files to a directory that is not a directory or
874
an attempt to change the kind of a directory with files.
877
typestring = 'non-directory parent'
879
format = "Conflict: %(path)s is not a directory, but has files in it."\
882
# FIXME: .OTHER should be used instead of .new when the conflict is created
884
def action_take_this(self, tree):
885
# FIXME: we should preserve that path when the conflict is generated !
886
if self.path.endswith('.new'):
887
conflict_path = self.path[:-(len('.new'))]
888
tree.remove([self.path], force=True, keep_files=False)
889
tree.add(conflict_path)
891
raise NotImplementedError(self.action_take_this)
893
def action_take_other(self, tree):
894
# FIXME: we should preserve that path when the conflict is generated !
895
if self.path.endswith('.new'):
896
conflict_path = self.path[:-(len('.new'))]
897
tree.remove([conflict_path], force=True, keep_files=False)
898
tree.rename_one(self.path, conflict_path)
900
raise NotImplementedError(self.action_take_other)
906
def register_types(*conflict_types):
907
"""Register a Conflict subclass for serialization purposes"""
909
for conflict_type in conflict_types:
910
ctype[conflict_type.typestring] = conflict_type
913
register_types(ContentsConflict, TextConflict, PathConflict, DuplicateID,
914
DuplicateEntry, ParentLoop, UnversionedParent, MissingParent,
915
DeletingParent, NonDirectoryParent)
332
def do(self, action, tree):
333
"""Apply the specified action to the conflict.
335
:param action: The method name to call.
337
:param tree: The tree passed as a parameter to the method.
339
raise NotImplementedError(self.do)
342
raise NotImplementedError(self.describe)