~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/conflicts.py

  • Committer: Martin Pool
  • Date: 2010-01-29 14:09:05 UTC
  • mto: This revision was merged to the branch mainline in revision 4992.
  • Revision ID: mbp@sourcefrog.net-20100129140905-2uiarb6p8di1ywsr
Correction to url

from review: https://code.edge.launchpad.net/~mbp/bzr/doc/+merge/18250

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