← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/conflicts.py

  • Committer: Tarmac
  • Author(s): Vincent Ladeuil
  • Date: 2017-01-30 14:42:05 UTC
  • mfrom: (6620.1.1 trunk)
  • Revision ID: tarmac-20170130144205-r8fh2xpmiuxyozpv
Merge  2.7 into trunk including fix for bug #1657238 [r=vila]

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/conflicts.py
1
 
# Copyright (C) 2005, 2006, 2007, 2009, 2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2009, 2010, 2011 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
17
17
# TODO: 'bzr resolve' should accept a directory name and work from that
18
18
# point down
19
19
 
 
20
from __future__ import absolute_import
 
21
 
20
22
import os
21
 
import re
22
23
 
23
24
from bzrlib.lazy_import import lazy_import
24
25
lazy_import(globals(), """
25
26
import errno
26
27
 
27
28
from bzrlib import (
28
 
    builtins,
29
 
    commands,
 
29
    cleanup,
30
30
    errors,
31
31
    osutils,
32
32
    rio,
34
34
    transform,
35
35
    workingtree,
36
36
    )
 
37
from bzrlib.i18n import gettext, ngettext
37
38
""")
38
39
from bzrlib import (
 
40
    commands,
39
41
    option,
40
42
    registry,
41
43
    )
45
47
 
46
48
 
47
49
class cmd_conflicts(commands.Command):
48
 
    """List files with conflicts.
 
50
    __doc__ = """List files with conflicts.
49
51
 
50
52
    Merge will do its best to combine the changes in two branches, but there
51
53
    are some kinds of problems only a human can fix.  When it encounters those,
52
54
    it will mark a conflict.  A conflict means that you need to fix something,
53
 
    before you should commit.
 
55
    before you can commit.
54
56
 
55
57
    Conflicts normally are listed as short, human-readable messages.  If --text
56
58
    is supplied, the pathnames of files with text conflicts are listed,
59
61
    Use bzr resolve when you have fixed a problem.
60
62
    """
61
63
    takes_options = [
 
64
            'directory',
62
65
            option.Option('text',
63
66
                          help='List paths of files with text conflicts.'),
64
67
        ]
65
68
    _see_also = ['resolve', 'conflict-types']
66
69
 
67
 
    def run(self, text=False):
68
 
        wt = workingtree.WorkingTree.open_containing(u'.')[0]
 
70
    def run(self, text=False, directory=u'.'):
 
71
        wt = workingtree.WorkingTree.open_containing(directory)[0]
69
72
        for conflict in wt.conflicts():
70
73
            if text:
71
74
                if conflict.typestring != 'text conflict':
72
75
                    continue
73
76
                self.outf.write(conflict.path + '\n')
74
77
            else:
75
 
                self.outf.write(str(conflict) + '\n')
 
78
                self.outf.write(unicode(conflict) + '\n')
76
79
 
77
80
 
78
81
resolve_action_registry = registry.Registry()
79
82
 
80
83
 
81
84
resolve_action_registry.register(
82
 
    'done', 'done', 'Marks the conflict as resolved' )
 
85
    'done', 'done', 'Marks the conflict as resolved.')
83
86
resolve_action_registry.register(
84
87
    'take-this', 'take_this',
85
 
    'Resolve the conflict preserving the version in the working tree' )
 
88
    'Resolve the conflict preserving the version in the working tree.')
86
89
resolve_action_registry.register(
87
90
    'take-other', 'take_other',
88
 
    'Resolve the conflict taking the merged version into account' )
 
91
    'Resolve the conflict taking the merged version into account.')
89
92
resolve_action_registry.default_key = 'done'
90
93
 
91
94
class ResolveActionOption(option.RegistryOption):
98
101
 
99
102
 
100
103
class cmd_resolve(commands.Command):
101
 
    """Mark a conflict as resolved.
 
104
    __doc__ = """Mark a conflict as resolved.
102
105
 
103
106
    Merge will do its best to combine the changes in two branches, but there
104
107
    are some kinds of problems only a human can fix.  When it encounters those,
105
108
    it will mark a conflict.  A conflict means that you need to fix something,
106
 
    before you should commit.
 
109
    before you can commit.
107
110
 
108
111
    Once you have fixed a problem, use "bzr resolve" to automatically mark
109
112
    text conflicts as fixed, "bzr resolve FILE" to mark a specific conflict as
112
115
    aliases = ['resolved']
113
116
    takes_args = ['file*']
114
117
    takes_options = [
 
118
            'directory',
115
119
            option.Option('all', help='Resolve all conflicts in this tree.'),
116
120
            ResolveActionOption(),
117
121
            ]
118
122
    _see_also = ['conflicts']
119
 
    def run(self, file_list=None, all=False, action=None):
 
123
    def run(self, file_list=None, all=False, action=None, directory=None):
120
124
        if all:
121
125
            if file_list:
122
 
                raise errors.BzrCommandError("If --all is specified,"
123
 
                                             " no FILE may be provided")
124
 
            tree = workingtree.WorkingTree.open_containing('.')[0]
 
126
                raise errors.BzrCommandError(gettext("If --all is specified,"
 
127
                                             " no FILE may be provided"))
 
128
            if directory is None:
 
129
                directory = u'.'
 
130
            tree = workingtree.WorkingTree.open_containing(directory)[0]
125
131
            if action is None:
126
132
                action = 'done'
127
133
        else:
128
 
            tree, file_list = builtins.tree_files(file_list)
 
134
            tree, file_list = workingtree.WorkingTree.open_containing_paths(
 
135
                file_list, directory)
129
136
            if file_list is None:
130
137
                if action is None:
131
138
                    # FIXME: There is a special case here related to the option
141
148
            if file_list is None:
142
149
                un_resolved, resolved = tree.auto_resolve()
143
150
                if len(un_resolved) > 0:
144
 
                    trace.note('%d conflict(s) auto-resolved.', len(resolved))
145
 
                    trace.note('Remaining conflicts:')
 
151
                    trace.note(ngettext('%d conflict auto-resolved.',
 
152
                        '%d conflicts auto-resolved.', len(resolved)),
 
153
                        len(resolved))
 
154
                    trace.note(gettext('Remaining conflicts:'))
146
155
                    for conflict in un_resolved:
147
 
                        trace.note(conflict)
 
156
                        trace.note(unicode(conflict))
148
157
                    return 1
149
158
                else:
150
 
                    trace.note('All conflicts resolved.')
 
159
                    trace.note(gettext('All conflicts resolved.'))
151
160
                    return 0
152
161
            else:
153
162
                # FIXME: This can never occur but the block above needs some
155
164
                # conflict.auto(tree) --vila 091242
156
165
                pass
157
166
        else:
158
 
            resolve(tree, file_list, action=action)
 
167
            before, after = resolve(tree, file_list, action=action)
 
168
            trace.note(ngettext('{0} conflict resolved, {1} remaining',
 
169
                                '{0} conflicts resolved, {1} remaining',
 
170
                                before-after).format(before - after, after))
159
171
 
160
172
 
161
173
def resolve(tree, paths=None, ignore_misses=False, recursive=False,
174
186
    :param action: How the conflict should be resolved,
175
187
    """
176
188
    tree.lock_tree_write()
 
189
    nb_conflicts_after = None
177
190
    try:
178
191
        tree_conflicts = tree.conflicts()
 
192
        nb_conflicts_before = len(tree_conflicts)
179
193
        if paths is None:
180
194
            new_conflicts = ConflictList()
181
195
            to_process = tree_conflicts
189
203
            except NotImplementedError:
190
204
                new_conflicts.append(conflict)
191
205
        try:
 
206
            nb_conflicts_after = len(new_conflicts)
192
207
            tree.set_conflicts(new_conflicts)
193
208
        except errors.UnsupportedOperation:
194
209
            pass
195
210
    finally:
196
211
        tree.unlock()
 
212
    if nb_conflicts_after is None:
 
213
        nb_conflicts_after = nb_conflicts_before
 
214
    return nb_conflicts_before, nb_conflicts_after
197
215
 
198
216
 
199
217
def restore(filename):
279
297
    def to_strings(self):
280
298
        """Generate strings for the provided conflicts"""
281
299
        for conflict in self:
282
 
            yield str(conflict)
 
300
            yield unicode(conflict)
283
301
 
284
302
    def remove_files(self, tree):
285
303
        """Remove the THIS, BASE and OTHER files for listed conflicts"""
378
396
    def __ne__(self, other):
379
397
        return not self.__eq__(other)
380
398
 
381
 
    def __str__(self):
 
399
    def __unicode__(self):
382
400
        return self.format % self.__dict__
383
401
 
384
402
    def __repr__(self):
435
453
    def action_take_other(self, tree):
436
454
        raise NotImplementedError(self.action_take_other)
437
455
 
 
456
    def _resolve_with_cleanups(self, tree, *args, **kwargs):
 
457
        tt = transform.TreeTransform(tree)
 
458
        op = cleanup.OperationWithCleanups(self._resolve)
 
459
        op.add_cleanup(tt.finalize)
 
460
        op.run_simple(tt, *args, **kwargs)
 
461
 
438
462
 
439
463
class PathConflict(Conflict):
440
464
    """A conflict was encountered merging file paths"""
459
483
        # No additional files have been generated here
460
484
        return []
461
485
 
 
486
    def _resolve(self, tt, file_id, path, winner):
 
487
        """Resolve the conflict.
 
488
 
 
489
        :param tt: The TreeTransform where the conflict is resolved.
 
490
        :param file_id: The retained file id.
 
491
        :param path: The retained path.
 
492
        :param winner: 'this' or 'other' indicates which side is the winner.
 
493
        """
 
494
        path_to_create = None
 
495
        if winner == 'this':
 
496
            if self.path == '<deleted>':
 
497
                return # Nothing to do
 
498
            if self.conflict_path == '<deleted>':
 
499
                path_to_create = self.path
 
500
                revid = tt._tree.get_parent_ids()[0]
 
501
        elif winner == 'other':
 
502
            if self.conflict_path == '<deleted>':
 
503
                return  # Nothing to do
 
504
            if self.path == '<deleted>':
 
505
                path_to_create = self.conflict_path
 
506
                # FIXME: If there are more than two parents we may need to
 
507
                # iterate. Taking the last parent is the safer bet in the mean
 
508
                # time. -- vila 20100309
 
509
                revid = tt._tree.get_parent_ids()[-1]
 
510
        else:
 
511
            # Programmer error
 
512
            raise AssertionError('bad winner: %r' % (winner,))
 
513
        if path_to_create is not None:
 
514
            tid = tt.trans_id_tree_path(path_to_create)
 
515
            transform.create_from_tree(
 
516
                tt, tid, self._revision_tree(tt._tree, revid), file_id)
 
517
            tt.version_file(file_id, tid)
 
518
        else:
 
519
            tid = tt.trans_id_file_id(file_id)
 
520
        # Adjust the path for the retained file id
 
521
        parent_tid = tt.get_tree_parent(tid)
 
522
        tt.adjust_path(osutils.basename(path), parent_tid, tid)
 
523
        tt.apply()
 
524
 
 
525
    def _revision_tree(self, tree, revid):
 
526
        return tree.branch.repository.revision_tree(revid)
 
527
 
 
528
    def _infer_file_id(self, tree):
 
529
        # Prior to bug #531967, file_id wasn't always set, there may still be
 
530
        # conflict files in the wild so we need to cope with them
 
531
        # Establish which path we should use to find back the file-id
 
532
        possible_paths = []
 
533
        for p in (self.path, self.conflict_path):
 
534
            if p == '<deleted>':
 
535
                # special hard-coded path 
 
536
                continue
 
537
            if p is not None:
 
538
                possible_paths.append(p)
 
539
        # Search the file-id in the parents with any path available
 
540
        file_id = None
 
541
        for revid in tree.get_parent_ids():
 
542
            revtree = self._revision_tree(tree, revid)
 
543
            for p in possible_paths:
 
544
                file_id = revtree.path2id(p)
 
545
                if file_id is not None:
 
546
                    return revtree, file_id
 
547
        return None, None
 
548
 
462
549
    def action_take_this(self, tree):
463
 
        tree.rename_one(self.conflict_path, self.path)
 
550
        if self.file_id is not None:
 
551
            self._resolve_with_cleanups(tree, self.file_id, self.path,
 
552
                                        winner='this')
 
553
        else:
 
554
            # Prior to bug #531967 we need to find back the file_id and restore
 
555
            # the content from there
 
556
            revtree, file_id = self._infer_file_id(tree)
 
557
            tree.revert([revtree.id2path(file_id)],
 
558
                        old_tree=revtree, backups=False)
464
559
 
465
560
    def action_take_other(self, tree):
466
 
        # just acccept bzr proposal
467
 
        pass
 
561
        if self.file_id is not None:
 
562
            self._resolve_with_cleanups(tree, self.file_id,
 
563
                                        self.conflict_path,
 
564
                                        winner='other')
 
565
        else:
 
566
            # Prior to bug #531967 we need to find back the file_id and restore
 
567
            # the content from there
 
568
            revtree, file_id = self._infer_file_id(tree)
 
569
            tree.revert([revtree.id2path(file_id)],
 
570
                        old_tree=revtree, backups=False)
468
571
 
469
572
 
470
573
class ContentsConflict(PathConflict):
471
 
    """The files are of different types, or not present"""
 
574
    """The files are of different types (or both binary), or not present"""
472
575
 
473
576
    has_files = True
474
577
 
479
582
    def associated_filenames(self):
480
583
        return [self.path + suffix for suffix in ('.BASE', '.OTHER')]
481
584
 
482
 
    # FIXME: I smell something weird here and it seems we should be able to be
483
 
    # more coherent with some other conflict ? bzr *did* a choice there but
484
 
    # neither action_take_this nor action_take_other reflect that...
485
 
    # -- vila 20091224
 
585
    def _resolve(self, tt, suffix_to_remove):
 
586
        """Resolve the conflict.
 
587
 
 
588
        :param tt: The TreeTransform where the conflict is resolved.
 
589
        :param suffix_to_remove: Either 'THIS' or 'OTHER'
 
590
 
 
591
        The resolution is symmetric: when taking THIS, OTHER is deleted and
 
592
        item.THIS is renamed into item and vice-versa.
 
593
        """
 
594
        try:
 
595
            # Delete 'item.THIS' or 'item.OTHER' depending on
 
596
            # suffix_to_remove
 
597
            tt.delete_contents(
 
598
                tt.trans_id_tree_path(self.path + '.' + suffix_to_remove))
 
599
        except errors.NoSuchFile:
 
600
            # There are valid cases where 'item.suffix_to_remove' either
 
601
            # never existed or was already deleted (including the case
 
602
            # where the user deleted it)
 
603
            pass
 
604
        try:
 
605
            this_path = tt._tree.id2path(self.file_id)
 
606
        except errors.NoSuchId:
 
607
            # The file is not present anymore. This may happen if the user
 
608
            # deleted the file either manually or when resolving a conflict on
 
609
            # the parent.  We may raise some exception to indicate that the
 
610
            # conflict doesn't exist anymore and as such doesn't need to be
 
611
            # resolved ? -- vila 20110615 
 
612
            this_tid = None
 
613
        else:
 
614
            this_tid = tt.trans_id_tree_path(this_path)
 
615
        if this_tid is not None:
 
616
            # Rename 'item.suffix_to_remove' (note that if
 
617
            # 'item.suffix_to_remove' has been deleted, this is a no-op)
 
618
            parent_tid = tt.get_tree_parent(this_tid)
 
619
            tt.adjust_path(osutils.basename(self.path), parent_tid, this_tid)
 
620
            tt.apply()
 
621
 
486
622
    def action_take_this(self, tree):
487
 
        tree.remove([self.path + '.OTHER'], force=True, keep_files=False)
 
623
        self._resolve_with_cleanups(tree, 'OTHER')
488
624
 
489
625
    def action_take_other(self, tree):
490
 
        tree.remove([self.path], force=True, keep_files=False)
491
 
 
492
 
 
493
 
 
494
 
# FIXME: TextConflict is about a single file-id, there never is a conflict_path
495
 
# attribute so we shouldn't inherit from PathConflict but simply from Conflict
 
626
        self._resolve_with_cleanups(tree, 'THIS')
 
627
 
496
628
 
497
629
# TODO: There should be a base revid attribute to better inform the user about
498
630
# how the conflicts were generated.
499
 
class TextConflict(PathConflict):
 
631
class TextConflict(Conflict):
500
632
    """The merge algorithm could not resolve all differences encountered."""
501
633
 
502
634
    has_files = True
505
637
 
506
638
    format = 'Text conflict in %(path)s'
507
639
 
 
640
    rformat = '%(class)s(%(path)r, %(file_id)r)'
 
641
 
508
642
    def associated_filenames(self):
509
643
        return [self.path + suffix for suffix in CONFLICT_SUFFIXES]
510
644
 
 
645
    def _resolve(self, tt, winner_suffix):
 
646
        """Resolve the conflict by copying one of .THIS or .OTHER into file.
 
647
 
 
648
        :param tt: The TreeTransform where the conflict is resolved.
 
649
        :param winner_suffix: Either 'THIS' or 'OTHER'
 
650
 
 
651
        The resolution is symmetric, when taking THIS, item.THIS is renamed
 
652
        into item and vice-versa. This takes one of the files as a whole
 
653
        ignoring every difference that could have been merged cleanly.
 
654
        """
 
655
        # To avoid useless copies, we switch item and item.winner_suffix, only
 
656
        # item will exist after the conflict has been resolved anyway.
 
657
        item_tid = tt.trans_id_file_id(self.file_id)
 
658
        item_parent_tid = tt.get_tree_parent(item_tid)
 
659
        winner_path = self.path + '.' + winner_suffix
 
660
        winner_tid = tt.trans_id_tree_path(winner_path)
 
661
        winner_parent_tid = tt.get_tree_parent(winner_tid)
 
662
        # Switch the paths to preserve the content
 
663
        tt.adjust_path(osutils.basename(self.path),
 
664
                       winner_parent_tid, winner_tid)
 
665
        tt.adjust_path(osutils.basename(winner_path), item_parent_tid, item_tid)
 
666
        # Associate the file_id to the right content
 
667
        tt.unversion_file(item_tid)
 
668
        tt.version_file(self.file_id, winner_tid)
 
669
        tt.apply()
 
670
 
 
671
    def action_take_this(self, tree):
 
672
        self._resolve_with_cleanups(tree, 'THIS')
 
673
 
 
674
    def action_take_other(self, tree):
 
675
        self._resolve_with_cleanups(tree, 'OTHER')
 
676
 
511
677
 
512
678
class HandledConflict(Conflict):
513
679
    """A path problem that has been provisionally resolved.
599
765
 
600
766
    typestring = 'parent loop'
601
767
 
602
 
    format = 'Conflict moving %(conflict_path)s into %(path)s.  %(action)s.'
 
768
    format = 'Conflict moving %(path)s into %(conflict_path)s. %(action)s.'
603
769
 
604
770
    def action_take_this(self, tree):
605
771
        # just acccept bzr proposal
606
772
        pass
607
773
 
608
774
    def action_take_other(self, tree):
609
 
        # FIXME: We shouldn't have to manipulate so many paths here (and there
610
 
        # is probably a bug or two...)
611
 
        base_path = osutils.basename(self.path)
612
 
        conflict_base_path = osutils.basename(self.conflict_path)
613
775
        tt = transform.TreeTransform(tree)
614
776
        try:
615
777
            p_tid = tt.trans_id_file_id(self.file_id)
616
778
            parent_tid = tt.get_tree_parent(p_tid)
617
779
            cp_tid = tt.trans_id_file_id(self.conflict_file_id)
618
780
            cparent_tid = tt.get_tree_parent(cp_tid)
619
 
            tt.adjust_path(base_path, cparent_tid, cp_tid)
620
 
            tt.adjust_path(conflict_base_path, parent_tid, p_tid)
 
781
            tt.adjust_path(osutils.basename(self.path), cparent_tid, cp_tid)
 
782
            tt.adjust_path(osutils.basename(self.conflict_path),
 
783
                           parent_tid, p_tid)
621
784
            tt.apply()
622
785
        finally:
623
786
            tt.finalize()