~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/conflicts.py

  • Committer: John Arbash Meinel
  • Date: 2009-12-15 19:59:00 UTC
  • mfrom: (4634.108.2 2.0)
  • mto: This revision was merged to the branch mainline in revision 4900.
  • Revision ID: john@arbash-meinel.com-20091215195900-fvgxdv9ycbrnzp1o
merge the 2.0.4 branch into 2.1.0b5

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007, 2009, 2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2007 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
# TODO: Move this into builtins
 
18
 
17
19
# TODO: 'bzr resolve' should accept a directory name and work from that
18
20
# point down
19
21
 
25
27
 
26
28
from bzrlib import (
27
29
    builtins,
28
 
    cleanup,
29
30
    commands,
30
31
    errors,
31
32
    osutils,
32
33
    rio,
33
34
    trace,
34
 
    transform,
35
 
    workingtree,
36
35
    )
37
36
""")
38
 
from bzrlib import (
39
 
    option,
40
 
    registry,
41
 
    )
 
37
from bzrlib.option import Option
42
38
 
43
39
 
44
40
CONFLICT_SUFFIXES = ('.THIS', '.BASE', '.OTHER')
45
41
 
46
42
 
47
43
class cmd_conflicts(commands.Command):
48
 
    __doc__ = """List files with conflicts.
 
44
    """List files with conflicts.
49
45
 
50
46
    Merge will do its best to combine the changes in two branches, but there
51
47
    are some kinds of problems only a human can fix.  When it encounters those,
59
55
    Use bzr resolve when you have fixed a problem.
60
56
    """
61
57
    takes_options = [
62
 
            option.Option('text',
63
 
                          help='List paths of files with text conflicts.'),
 
58
            Option('text',
 
59
                   help='List paths of files with text conflicts.'),
64
60
        ]
65
 
    _see_also = ['resolve', 'conflict-types']
 
61
    _see_also = ['resolve']
66
62
 
67
63
    def run(self, text=False):
68
 
        wt = workingtree.WorkingTree.open_containing(u'.')[0]
 
64
        from bzrlib.workingtree import WorkingTree
 
65
        wt = WorkingTree.open_containing(u'.')[0]
69
66
        for conflict in wt.conflicts():
70
67
            if text:
71
68
                if conflict.typestring != 'text conflict':
75
72
                self.outf.write(str(conflict) + '\n')
76
73
 
77
74
 
78
 
resolve_action_registry = registry.Registry()
79
 
 
80
 
 
81
 
resolve_action_registry.register(
82
 
    'done', 'done', 'Marks the conflict as resolved' )
83
 
resolve_action_registry.register(
84
 
    'take-this', 'take_this',
85
 
    'Resolve the conflict preserving the version in the working tree' )
86
 
resolve_action_registry.register(
87
 
    'take-other', 'take_other',
88
 
    'Resolve the conflict taking the merged version into account' )
89
 
resolve_action_registry.default_key = 'done'
90
 
 
91
 
class ResolveActionOption(option.RegistryOption):
92
 
 
93
 
    def __init__(self):
94
 
        super(ResolveActionOption, self).__init__(
95
 
            'action', 'How to resolve the conflict.',
96
 
            value_switches=True,
97
 
            registry=resolve_action_registry)
98
 
 
99
 
 
100
75
class cmd_resolve(commands.Command):
101
 
    __doc__ = """Mark a conflict as resolved.
 
76
    """Mark a conflict as resolved.
102
77
 
103
78
    Merge will do its best to combine the changes in two branches, but there
104
79
    are some kinds of problems only a human can fix.  When it encounters those,
112
87
    aliases = ['resolved']
113
88
    takes_args = ['file*']
114
89
    takes_options = [
115
 
            option.Option('all', help='Resolve all conflicts in this tree.'),
116
 
            ResolveActionOption(),
 
90
            Option('all', help='Resolve all conflicts in this tree.'),
117
91
            ]
118
92
    _see_also = ['conflicts']
119
 
    def run(self, file_list=None, all=False, action=None):
 
93
    def run(self, file_list=None, all=False):
 
94
        from bzrlib.workingtree import WorkingTree
120
95
        if all:
121
96
            if file_list:
122
97
                raise errors.BzrCommandError("If --all is specified,"
123
98
                                             " no FILE may be provided")
124
 
            tree = workingtree.WorkingTree.open_containing('.')[0]
125
 
            if action is None:
126
 
                action = 'done'
 
99
            tree = WorkingTree.open_containing('.')[0]
 
100
            resolve(tree)
127
101
        else:
128
102
            tree, file_list = builtins.tree_files(file_list)
129
103
            if file_list is None:
130
 
                if action is None:
131
 
                    # FIXME: There is a special case here related to the option
132
 
                    # handling that could be clearer and easier to discover by
133
 
                    # providing an --auto action (bug #344013 and #383396) and
134
 
                    # make it mandatory instead of implicit and active only
135
 
                    # when no file_list is provided -- vila 091229
136
 
                    action = 'auto'
137
 
            else:
138
 
                if action is None:
139
 
                    action = 'done'
140
 
        if action == 'auto':
141
 
            if file_list is None:
142
104
                un_resolved, resolved = tree.auto_resolve()
143
105
                if len(un_resolved) > 0:
144
106
                    trace.note('%d conflict(s) auto-resolved.', len(resolved))
150
112
                    trace.note('All conflicts resolved.')
151
113
                    return 0
152
114
            else:
153
 
                # FIXME: This can never occur but the block above needs some
154
 
                # refactoring to transfer tree.auto_resolve() to
155
 
                # conflict.auto(tree) --vila 091242
156
 
                pass
157
 
        else:
158
 
            resolve(tree, file_list, action=action)
159
 
 
160
 
 
161
 
def resolve(tree, paths=None, ignore_misses=False, recursive=False,
162
 
            action='done'):
 
115
                resolve(tree, file_list)
 
116
 
 
117
 
 
118
def resolve(tree, paths=None, ignore_misses=False, recursive=False):
163
119
    """Resolve some or all of the conflicts in a working tree.
164
120
 
165
121
    :param paths: If None, resolve all conflicts.  Otherwise, select only
169
125
        recursive commands like revert, this should be True.  For commands
170
126
        or applications wishing finer-grained control, like the resolve
171
127
        command, this should be False.
172
 
    :param ignore_misses: If False, warnings will be printed if the supplied
173
 
        paths do not have conflicts.
174
 
    :param action: How the conflict should be resolved,
 
128
    :ignore_misses: If False, warnings will be printed if the supplied paths
 
129
        do not have conflicts.
175
130
    """
176
131
    tree.lock_tree_write()
177
132
    try:
178
133
        tree_conflicts = tree.conflicts()
179
134
        if paths is None:
180
135
            new_conflicts = ConflictList()
181
 
            to_process = tree_conflicts
 
136
            selected_conflicts = tree_conflicts
182
137
        else:
183
 
            new_conflicts, to_process = tree_conflicts.select_conflicts(
184
 
                tree, paths, ignore_misses, recursive)
185
 
        for conflict in to_process:
186
 
            try:
187
 
                conflict._do(action, tree)
188
 
                conflict.cleanup(tree)
189
 
            except NotImplementedError:
190
 
                new_conflicts.append(conflict)
 
138
            new_conflicts, selected_conflicts = \
 
139
                tree_conflicts.select_conflicts(tree, paths, ignore_misses,
 
140
                    recursive)
191
141
        try:
192
142
            tree.set_conflicts(new_conflicts)
193
143
        except errors.UnsupportedOperation:
194
144
            pass
 
145
        selected_conflicts.remove_files(tree)
195
146
    finally:
196
147
        tree.unlock()
197
148
 
198
149
 
199
150
def restore(filename):
200
 
    """Restore a conflicted file to the state it was in before merging.
201
 
 
202
 
    Only text restoration is supported at present.
 
151
    """\
 
152
    Restore a conflicted file to the state it was in before merging.
 
153
    Only text restoration supported at present.
203
154
    """
204
155
    conflicted = False
205
156
    try:
286
237
        for conflict in self:
287
238
            if not conflict.has_files:
288
239
                continue
289
 
            conflict.cleanup(tree)
 
240
            for suffix in CONFLICT_SUFFIXES:
 
241
                try:
 
242
                    osutils.delete_any(tree.abspath(conflict.path+suffix))
 
243
                except OSError, e:
 
244
                    if e.errno != errno.ENOENT:
 
245
                        raise
290
246
 
291
247
    def select_conflicts(self, tree, paths, ignore_misses=False,
292
248
                         recurse=False):
345
301
class Conflict(object):
346
302
    """Base class for all types of conflict"""
347
303
 
348
 
    # FIXME: cleanup should take care of that ? -- vila 091229
349
304
    has_files = False
350
305
 
351
306
    def __init__(self, path, file_id=None):
400
355
        else:
401
356
            return None, conflict.typestring
402
357
 
403
 
    def _do(self, action, tree):
404
 
        """Apply the specified action to the conflict.
405
 
 
406
 
        :param action: The method name to call.
407
 
 
408
 
        :param tree: The tree passed as a parameter to the method.
409
 
        """
410
 
        meth = getattr(self, 'action_%s' % action, None)
411
 
        if meth is None:
412
 
            raise NotImplementedError(self.__class__.__name__ + '.' + action)
413
 
        meth(tree)
414
 
 
415
 
    def associated_filenames(self):
416
 
        """The names of the files generated to help resolve the conflict."""
417
 
        raise NotImplementedError(self.associated_filenames)
418
 
 
419
 
    def cleanup(self, tree):
420
 
        for fname in self.associated_filenames():
421
 
            try:
422
 
                osutils.delete_any(tree.abspath(fname))
423
 
            except OSError, e:
424
 
                if e.errno != errno.ENOENT:
425
 
                    raise
426
 
 
427
 
    def action_done(self, tree):
428
 
        """Mark the conflict as solved once it has been handled."""
429
 
        # This method does nothing but simplifies the design of upper levels.
430
 
        pass
431
 
 
432
 
    def action_take_this(self, tree):
433
 
        raise NotImplementedError(self.action_take_this)
434
 
 
435
 
    def action_take_other(self, tree):
436
 
        raise NotImplementedError(self.action_take_other)
437
 
 
438
 
    def _resolve_with_cleanups(self, tree, *args, **kwargs):
439
 
        tt = transform.TreeTransform(tree)
440
 
        op = cleanup.OperationWithCleanups(self._resolve)
441
 
        op.add_cleanup(tt.finalize)
442
 
        op.run_simple(tt, *args, **kwargs)
443
 
 
444
358
 
445
359
class PathConflict(Conflict):
446
360
    """A conflict was encountered merging file paths"""
450
364
    format = 'Path conflict: %(path)s / %(conflict_path)s'
451
365
 
452
366
    rformat = '%(class)s(%(path)r, %(conflict_path)r, %(file_id)r)'
453
 
 
454
367
    def __init__(self, path, conflict_path=None, file_id=None):
455
368
        Conflict.__init__(self, path, file_id)
456
369
        self.conflict_path = conflict_path
461
374
            s.add('conflict_path', self.conflict_path)
462
375
        return s
463
376
 
464
 
    def associated_filenames(self):
465
 
        # No additional files have been generated here
466
 
        return []
467
 
 
468
 
    def _resolve(self, tt, file_id, path, winner):
469
 
        """Resolve the conflict.
470
 
 
471
 
        :param tt: The TreeTransform where the conflict is resolved.
472
 
        :param file_id: The retained file id.
473
 
        :param path: The retained path.
474
 
        :param winner: 'this' or 'other' indicates which side is the winner.
475
 
        """
476
 
        path_to_create = None
477
 
        if winner == 'this':
478
 
            if self.path == '<deleted>':
479
 
                return # Nothing to do
480
 
            if self.conflict_path == '<deleted>':
481
 
                path_to_create = self.path
482
 
                revid = tt._tree.get_parent_ids()[0]
483
 
        elif winner == 'other':
484
 
            if self.conflict_path == '<deleted>':
485
 
                return  # Nothing to do
486
 
            if self.path == '<deleted>':
487
 
                path_to_create = self.conflict_path
488
 
                # FIXME: If there are more than two parents we may need to
489
 
                # iterate. Taking the last parent is the safer bet in the mean
490
 
                # time. -- vila 20100309
491
 
                revid = tt._tree.get_parent_ids()[-1]
492
 
        else:
493
 
            # Programmer error
494
 
            raise AssertionError('bad winner: %r' % (winner,))
495
 
        if path_to_create is not None:
496
 
            tid = tt.trans_id_tree_path(path_to_create)
497
 
            transform.create_from_tree(
498
 
                tt, tt.trans_id_tree_path(path_to_create),
499
 
                self._revision_tree(tt._tree, revid), file_id)
500
 
            tt.version_file(file_id, tid)
501
 
 
502
 
        # Adjust the path for the retained file id
503
 
        tid = tt.trans_id_file_id(file_id)
504
 
        parent_tid = tt.get_tree_parent(tid)
505
 
        tt.adjust_path(path, parent_tid, tid)
506
 
        tt.apply()
507
 
 
508
 
    def _revision_tree(self, tree, revid):
509
 
        return tree.branch.repository.revision_tree(revid)
510
 
 
511
 
    def _infer_file_id(self, tree):
512
 
        # Prior to bug #531967, file_id wasn't always set, there may still be
513
 
        # conflict files in the wild so we need to cope with them
514
 
        # Establish which path we should use to find back the file-id
515
 
        possible_paths = []
516
 
        for p in (self.path, self.conflict_path):
517
 
            if p == '<deleted>':
518
 
                # special hard-coded path 
519
 
                continue
520
 
            if p is not None:
521
 
                possible_paths.append(p)
522
 
        # Search the file-id in the parents with any path available
523
 
        file_id = None
524
 
        for revid in tree.get_parent_ids():
525
 
            revtree = self._revision_tree(tree, revid)
526
 
            for p in possible_paths:
527
 
                file_id = revtree.path2id(p)
528
 
                if file_id is not None:
529
 
                    return revtree, file_id
530
 
        return None, None
531
 
 
532
 
    def action_take_this(self, tree):
533
 
        if self.file_id is not None:
534
 
            self._resolve_with_cleanups(tree, self.file_id, self.path,
535
 
                                        winner='this')
536
 
        else:
537
 
            # Prior to bug #531967 we need to find back the file_id and restore
538
 
            # the content from there
539
 
            revtree, file_id = self._infer_file_id(tree)
540
 
            tree.revert([revtree.id2path(file_id)],
541
 
                        old_tree=revtree, backups=False)
542
 
 
543
 
    def action_take_other(self, tree):
544
 
        if self.file_id is not None:
545
 
            self._resolve_with_cleanups(tree, self.file_id,
546
 
                                        self.conflict_path,
547
 
                                        winner='other')
548
 
        else:
549
 
            # Prior to bug #531967 we need to find back the file_id and restore
550
 
            # the content from there
551
 
            revtree, file_id = self._infer_file_id(tree)
552
 
            tree.revert([revtree.id2path(file_id)],
553
 
                        old_tree=revtree, backups=False)
554
 
 
555
377
 
556
378
class ContentsConflict(PathConflict):
557
 
    """The files are of different types (or both binary), or not present"""
 
379
    """The files are of different types, or not present"""
558
380
 
559
381
    has_files = True
560
382
 
562
384
 
563
385
    format = 'Contents conflict in %(path)s'
564
386
 
565
 
    def associated_filenames(self):
566
 
        return [self.path + suffix for suffix in ('.BASE', '.OTHER')]
567
 
 
568
 
    def _resolve(self, tt, suffix_to_remove):
569
 
        """Resolve the conflict.
570
 
 
571
 
        :param tt: The TreeTransform where the conflict is resolved.
572
 
        :param suffix_to_remove: Either 'THIS' or 'OTHER'
573
 
 
574
 
        The resolution is symmetric, when taking THIS, OTHER is deleted and
575
 
        item.THIS is renamed into item and vice-versa.
576
 
        """
577
 
        try:
578
 
            # Delete 'item.THIS' or 'item.OTHER' depending on
579
 
            # suffix_to_remove
580
 
            tt.delete_contents(
581
 
                tt.trans_id_tree_path(self.path + '.' + suffix_to_remove))
582
 
        except errors.NoSuchFile:
583
 
            # There are valid cases where 'item.suffix_to_remove' either
584
 
            # never existed or was already deleted (including the case
585
 
            # where the user deleted it)
586
 
            pass
587
 
        # Rename 'item.suffix_to_remove' (note that if
588
 
        # 'item.suffix_to_remove' has been deleted, this is a no-op)
589
 
        this_tid = tt.trans_id_file_id(self.file_id)
590
 
        parent_tid = tt.get_tree_parent(this_tid)
591
 
        tt.adjust_path(self.path, parent_tid, this_tid)
592
 
        tt.apply()
593
 
 
594
 
    def action_take_this(self, tree):
595
 
        self._resolve_with_cleanups(tree, 'OTHER')
596
 
 
597
 
    def action_take_other(self, tree):
598
 
        self._resolve_with_cleanups(tree, 'THIS')
599
 
 
600
 
 
601
 
# FIXME: TextConflict is about a single file-id, there never is a conflict_path
602
 
# attribute so we shouldn't inherit from PathConflict but simply from Conflict
603
 
 
604
 
# TODO: There should be a base revid attribute to better inform the user about
605
 
# how the conflicts were generated.
 
387
 
606
388
class TextConflict(PathConflict):
607
389
    """The merge algorithm could not resolve all differences encountered."""
608
390
 
612
394
 
613
395
    format = 'Text conflict in %(path)s'
614
396
 
615
 
    def associated_filenames(self):
616
 
        return [self.path + suffix for suffix in CONFLICT_SUFFIXES]
617
 
 
618
397
 
619
398
class HandledConflict(Conflict):
620
399
    """A path problem that has been provisionally resolved.
635
414
        s.add('action', self.action)
636
415
        return s
637
416
 
638
 
    def associated_filenames(self):
639
 
        # Nothing has been generated here
640
 
        return []
641
 
 
642
417
 
643
418
class HandledPathConflict(HandledConflict):
644
419
    """A provisionally-resolved path problem involving two paths.
685
460
 
686
461
    format = 'Conflict adding file %(conflict_path)s.  %(action)s %(path)s.'
687
462
 
688
 
    def action_take_this(self, tree):
689
 
        tree.remove([self.conflict_path], force=True, keep_files=False)
690
 
        tree.rename_one(self.path, self.conflict_path)
691
 
 
692
 
    def action_take_other(self, tree):
693
 
        tree.remove([self.path], force=True, keep_files=False)
694
 
 
695
463
 
696
464
class ParentLoop(HandledPathConflict):
697
465
    """An attempt to create an infinitely-looping directory structure.
698
466
    This is rare, but can be produced like so:
699
467
 
700
468
    tree A:
701
 
      mv foo bar
 
469
      mv foo/bar
702
470
    tree B:
703
 
      mv bar foo
 
471
      mv bar/foo
704
472
    merge A and B
705
473
    """
706
474
 
707
475
    typestring = 'parent loop'
708
476
 
709
 
    format = 'Conflict moving %(path)s into %(conflict_path)s. %(action)s.'
710
 
 
711
 
    def action_take_this(self, tree):
712
 
        # just acccept bzr proposal
713
 
        pass
714
 
 
715
 
    def action_take_other(self, tree):
716
 
        # FIXME: We shouldn't have to manipulate so many paths here (and there
717
 
        # is probably a bug or two...)
718
 
        base_path = osutils.basename(self.path)
719
 
        conflict_base_path = osutils.basename(self.conflict_path)
720
 
        tt = transform.TreeTransform(tree)
721
 
        try:
722
 
            p_tid = tt.trans_id_file_id(self.file_id)
723
 
            parent_tid = tt.get_tree_parent(p_tid)
724
 
            cp_tid = tt.trans_id_file_id(self.conflict_file_id)
725
 
            cparent_tid = tt.get_tree_parent(cp_tid)
726
 
            tt.adjust_path(base_path, cparent_tid, cp_tid)
727
 
            tt.adjust_path(conflict_base_path, parent_tid, p_tid)
728
 
            tt.apply()
729
 
        finally:
730
 
            tt.finalize()
 
477
    format = 'Conflict moving %(conflict_path)s into %(path)s.  %(action)s.'
731
478
 
732
479
 
733
480
class UnversionedParent(HandledConflict):
734
 
    """An attempt to version a file whose parent directory is not versioned.
 
481
    """An attempt to version an file whose parent directory is not versioned.
735
482
    Typically, the result of a merge where one tree unversioned the directory
736
483
    and the other added a versioned file to it.
737
484
    """
741
488
    format = 'Conflict because %(path)s is not versioned, but has versioned'\
742
489
             ' children.  %(action)s.'
743
490
 
744
 
    # FIXME: We silently do nothing to make tests pass, but most probably the
745
 
    # conflict shouldn't exist (the long story is that the conflict is
746
 
    # generated with another one that can be resolved properly) -- vila 091224
747
 
    def action_take_this(self, tree):
748
 
        pass
749
 
 
750
 
    def action_take_other(self, tree):
751
 
        pass
752
 
 
753
491
 
754
492
class MissingParent(HandledConflict):
755
493
    """An attempt to add files to a directory that is not present.
756
494
    Typically, the result of a merge where THIS deleted the directory and
757
495
    the OTHER added a file to it.
758
 
    See also: DeletingParent (same situation, THIS and OTHER reversed)
 
496
    See also: DeletingParent (same situation, reversed THIS and OTHER)
759
497
    """
760
498
 
761
499
    typestring = 'missing parent'
762
500
 
763
501
    format = 'Conflict adding files to %(path)s.  %(action)s.'
764
502
 
765
 
    def action_take_this(self, tree):
766
 
        tree.remove([self.path], force=True, keep_files=False)
767
 
 
768
 
    def action_take_other(self, tree):
769
 
        # just acccept bzr proposal
770
 
        pass
771
 
 
772
503
 
773
504
class DeletingParent(HandledConflict):
774
505
    """An attempt to add files to a directory that is not present.
781
512
    format = "Conflict: can't delete %(path)s because it is not empty.  "\
782
513
             "%(action)s."
783
514
 
784
 
    # FIXME: It's a bit strange that the default action is not coherent with
785
 
    # MissingParent from the *user* pov.
786
 
 
787
 
    def action_take_this(self, tree):
788
 
        # just acccept bzr proposal
789
 
        pass
790
 
 
791
 
    def action_take_other(self, tree):
792
 
        tree.remove([self.path], force=True, keep_files=False)
793
 
 
794
515
 
795
516
class NonDirectoryParent(HandledConflict):
796
 
    """An attempt to add files to a directory that is not a directory or
 
517
    """An attempt to add files to a directory that is not a director or
797
518
    an attempt to change the kind of a directory with files.
798
519
    """
799
520
 
802
523
    format = "Conflict: %(path)s is not a directory, but has files in it."\
803
524
             "  %(action)s."
804
525
 
805
 
    # FIXME: .OTHER should be used instead of .new when the conflict is created
806
 
 
807
 
    def action_take_this(self, tree):
808
 
        # FIXME: we should preserve that path when the conflict is generated !
809
 
        if self.path.endswith('.new'):
810
 
            conflict_path = self.path[:-(len('.new'))]
811
 
            tree.remove([self.path], force=True, keep_files=False)
812
 
            tree.add(conflict_path)
813
 
        else:
814
 
            raise NotImplementedError(self.action_take_this)
815
 
 
816
 
    def action_take_other(self, tree):
817
 
        # FIXME: we should preserve that path when the conflict is generated !
818
 
        if self.path.endswith('.new'):
819
 
            conflict_path = self.path[:-(len('.new'))]
820
 
            tree.remove([conflict_path], force=True, keep_files=False)
821
 
            tree.rename_one(self.path, conflict_path)
822
 
        else:
823
 
            raise NotImplementedError(self.action_take_other)
824
 
 
825
 
 
826
526
ctype = {}
827
527
 
828
528
 
832
532
    for conflict_type in conflict_types:
833
533
        ctype[conflict_type.typestring] = conflict_type
834
534
 
 
535
 
835
536
register_types(ContentsConflict, TextConflict, PathConflict, DuplicateID,
836
537
               DuplicateEntry, ParentLoop, UnversionedParent, MissingParent,
837
538
               DeletingParent, NonDirectoryParent)