~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/conflicts.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-10-22 20:45:28 UTC
  • mfrom: (2921.1.4 dirstate.cache)
  • Revision ID: pqm@pqm.ubuntu.com-20071022204528-m4i3ievs46d19324
(robertc) Add a last-lookup cache to DirState reducing the cost of serial access to paths. (Robert Collins)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2007, 2009, 2010 Canonical Ltd
 
1
# Copyright (C) 2005 Aaron Bentley, 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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
 
 
17
 
# TODO: 'bzr resolve' should accept a directory name and work from that
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
# TODO: Move this into builtins
 
18
 
 
19
# TODO: 'bzr resolve' should accept a directory name and work from that 
18
20
# point down
19
21
 
20
22
import os
21
 
import re
22
23
 
23
24
from bzrlib.lazy_import import lazy_import
24
25
lazy_import(globals(), """
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')
57
53
    instead.  (This is useful for editing all files with text conflicts.)
58
54
 
59
55
    Use bzr resolve when you have fixed a problem.
 
56
 
 
57
    See also bzr resolve.
60
58
    """
61
59
    takes_options = [
62
 
            option.Option('text',
63
 
                          help='List paths of files with text conflicts.'),
 
60
            Option('text',
 
61
                   help='List paths of files with text conflicts.'),
64
62
        ]
65
 
    _see_also = ['resolve', 'conflict-types']
66
63
 
67
64
    def run(self, text=False):
68
 
        wt = workingtree.WorkingTree.open_containing(u'.')[0]
 
65
        from bzrlib.workingtree import WorkingTree
 
66
        wt = WorkingTree.open_containing(u'.')[0]
69
67
        for conflict in wt.conflicts():
70
68
            if text:
71
69
                if conflict.typestring != 'text conflict':
75
73
                self.outf.write(str(conflict) + '\n')
76
74
 
77
75
 
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
76
class cmd_resolve(commands.Command):
101
77
    """Mark a conflict as resolved.
102
78
 
106
82
    before you should commit.
107
83
 
108
84
    Once you have fixed a problem, use "bzr resolve" to automatically mark
109
 
    text conflicts as fixed, "bzr resolve FILE" to mark a specific conflict as
 
85
    text conflicts as fixed, resolve FILE to mark a specific conflict as
110
86
    resolved, or "bzr resolve --all" to mark all conflicts as resolved.
 
87
 
 
88
    See also bzr conflicts.
111
89
    """
112
90
    aliases = ['resolved']
113
91
    takes_args = ['file*']
114
92
    takes_options = [
115
 
            option.Option('all', help='Resolve all conflicts in this tree.'),
116
 
            ResolveActionOption(),
 
93
            Option('all', help='Resolve all conflicts in this tree.'),
117
94
            ]
118
 
    _see_also = ['conflicts']
119
 
    def run(self, file_list=None, all=False, action=None):
 
95
    def run(self, file_list=None, all=False):
 
96
        from bzrlib.workingtree import WorkingTree
120
97
        if all:
121
98
            if file_list:
122
99
                raise errors.BzrCommandError("If --all is specified,"
123
100
                                             " no FILE may be provided")
124
 
            tree = workingtree.WorkingTree.open_containing('.')[0]
125
 
            if action is None:
126
 
                action = 'done'
 
101
            tree = WorkingTree.open_containing('.')[0]
 
102
            resolve(tree)
127
103
        else:
128
104
            tree, file_list = builtins.tree_files(file_list)
129
105
            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
106
                un_resolved, resolved = tree.auto_resolve()
143
107
                if len(un_resolved) > 0:
144
108
                    trace.note('%d conflict(s) auto-resolved.', len(resolved))
150
114
                    trace.note('All conflicts resolved.')
151
115
                    return 0
152
116
            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'):
163
 
    """Resolve some or all of the conflicts in a working tree.
164
 
 
165
 
    :param paths: If None, resolve all conflicts.  Otherwise, select only
166
 
        specified conflicts.
167
 
    :param recursive: If True, then elements of paths which are directories
168
 
        have all their children resolved, etc.  When invoked as part of
169
 
        recursive commands like revert, this should be True.  For commands
170
 
        or applications wishing finer-grained control, like the resolve
171
 
        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,
175
 
    """
 
117
                resolve(tree, file_list)
 
118
 
 
119
 
 
120
def resolve(tree, paths=None, ignore_misses=False):
176
121
    tree.lock_tree_write()
177
122
    try:
178
123
        tree_conflicts = tree.conflicts()
179
124
        if paths is None:
180
125
            new_conflicts = ConflictList()
181
 
            to_process = tree_conflicts
 
126
            selected_conflicts = tree_conflicts
182
127
        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)
 
128
            new_conflicts, selected_conflicts = \
 
129
                tree_conflicts.select_conflicts(tree, paths, ignore_misses)
191
130
        try:
192
131
            tree.set_conflicts(new_conflicts)
193
132
        except errors.UnsupportedOperation:
194
133
            pass
 
134
        selected_conflicts.remove_files(tree)
195
135
    finally:
196
136
        tree.unlock()
197
137
 
198
138
 
199
139
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.
 
140
    """\
 
141
    Restore a conflicted file to the state it was in before merging.
 
142
    Only text restoration supported at present.
203
143
    """
204
144
    conflicted = False
205
145
    try:
275
215
        """Generator of stanzas"""
276
216
        for conflict in self:
277
217
            yield conflict.as_stanza()
278
 
 
 
218
            
279
219
    def to_strings(self):
280
220
        """Generate strings for the provided conflicts"""
281
221
        for conflict in self:
286
226
        for conflict in self:
287
227
            if not conflict.has_files:
288
228
                continue
289
 
            conflict.cleanup(tree)
 
229
            for suffix in CONFLICT_SUFFIXES:
 
230
                try:
 
231
                    osutils.delete_any(tree.abspath(conflict.path+suffix))
 
232
                except OSError, e:
 
233
                    if e.errno != errno.ENOENT:
 
234
                        raise
290
235
 
291
236
    def select_conflicts(self, tree, paths, ignore_misses=False,
292
237
                         recurse=False):
293
238
        """Select the conflicts associated with paths in a tree.
294
 
 
 
239
        
295
240
        File-ids are also used for this.
296
241
        :return: a pair of ConflictLists: (not_selected, selected)
297
242
        """
341
286
                    print "%s is not conflicted" % path
342
287
        return new_conflicts, selected_conflicts
343
288
 
344
 
 
 
289
 
345
290
class Conflict(object):
346
291
    """Base class for all types of conflict"""
347
292
 
348
 
    # FIXME: cleanup should take care of that ? -- vila 091229
349
293
    has_files = False
350
294
 
351
295
    def __init__(self, path, file_id=None):
400
344
        else:
401
345
            return None, conflict.typestring
402
346
 
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 cleanup(self, tree):
416
 
        raise NotImplementedError(self.cleanup)
417
 
 
418
 
    def action_done(self, tree):
419
 
        """Mark the conflict as solved once it has been handled."""
420
 
        # This method does nothing but simplifies the design of upper levels.
421
 
        pass
422
 
 
423
 
    def action_take_this(self, tree):
424
 
        raise NotImplementedError(self.action_take_this)
425
 
 
426
 
    def action_take_other(self, tree):
427
 
        raise NotImplementedError(self.action_take_other)
428
 
 
429
347
 
430
348
class PathConflict(Conflict):
431
349
    """A conflict was encountered merging file paths"""
435
353
    format = 'Path conflict: %(path)s / %(conflict_path)s'
436
354
 
437
355
    rformat = '%(class)s(%(path)r, %(conflict_path)r, %(file_id)r)'
438
 
 
439
356
    def __init__(self, path, conflict_path=None, file_id=None):
440
357
        Conflict.__init__(self, path, file_id)
441
358
        self.conflict_path = conflict_path
446
363
            s.add('conflict_path', self.conflict_path)
447
364
        return s
448
365
 
449
 
    def cleanup(self, tree):
450
 
        # No additional files have been generated here
451
 
        pass
452
 
 
453
 
    def action_take_this(self, tree):
454
 
        tree.rename_one(self.conflict_path, self.path)
455
 
 
456
 
    def action_take_other(self, tree):
457
 
        # just acccept bzr proposal
458
 
        pass
459
 
 
460
366
 
461
367
class ContentsConflict(PathConflict):
462
368
    """The files are of different types, or not present"""
467
373
 
468
374
    format = 'Contents conflict in %(path)s'
469
375
 
470
 
    def cleanup(self, tree):
471
 
        for suffix in ('.BASE', '.OTHER'):
472
 
            try:
473
 
                osutils.delete_any(tree.abspath(self.path + suffix))
474
 
            except OSError, e:
475
 
                if e.errno != errno.ENOENT:
476
 
                    raise
477
 
 
478
 
    # FIXME: I smell something weird here and it seems we should be able to be
479
 
    # more coherent with some other conflict ? bzr *did* a choice there but
480
 
    # neither action_take_this nor action_take_other reflect that...
481
 
    # -- vila 20091224
482
 
    def action_take_this(self, tree):
483
 
        tree.remove([self.path + '.OTHER'], force=True, keep_files=False)
484
 
 
485
 
    def action_take_other(self, tree):
486
 
        tree.remove([self.path], force=True, keep_files=False)
487
 
 
488
 
 
489
 
 
490
 
# FIXME: TextConflict is about a single file-id, there never is a conflict_path
491
 
# attribute so we shouldn't inherit from PathConflict but simply from Conflict
492
 
 
493
 
# TODO: There should be a base revid attribute to better inform the user about
494
 
# how the conflicts were generated.
 
376
 
495
377
class TextConflict(PathConflict):
496
378
    """The merge algorithm could not resolve all differences encountered."""
497
379
 
501
383
 
502
384
    format = 'Text conflict in %(path)s'
503
385
 
504
 
    def cleanup(self, tree):
505
 
        for suffix in CONFLICT_SUFFIXES:
506
 
            try:
507
 
                osutils.delete_any(tree.abspath(self.path+suffix))
508
 
            except OSError, e:
509
 
                if e.errno != errno.ENOENT:
510
 
                    raise
511
 
 
512
386
 
513
387
class HandledConflict(Conflict):
514
388
    """A path problem that has been provisionally resolved.
516
390
    """
517
391
 
518
392
    rformat = "%(class)s(%(action)r, %(path)r, %(file_id)r)"
519
 
 
 
393
    
520
394
    def __init__(self, action, path, file_id=None):
521
395
        Conflict.__init__(self, path, file_id)
522
396
        self.action = action
529
403
        s.add('action', self.action)
530
404
        return s
531
405
 
532
 
    def cleanup(self, tree):
533
 
        """Nothing to cleanup."""
534
 
        pass
535
 
 
536
406
 
537
407
class HandledPathConflict(HandledConflict):
538
408
    """A provisionally-resolved path problem involving two paths.
545
415
    def __init__(self, action, path, conflict_path, file_id=None,
546
416
                 conflict_file_id=None):
547
417
        HandledConflict.__init__(self, action, path, file_id)
548
 
        self.conflict_path = conflict_path
 
418
        self.conflict_path = conflict_path 
549
419
        # warn turned off, because the factory blindly transfers the Stanza
550
420
        # values to __init__.
551
421
        self.conflict_file_id = osutils.safe_file_id(conflict_file_id,
552
422
                                                     warn=False)
553
 
 
 
423
        
554
424
    def _cmp_list(self):
555
 
        return HandledConflict._cmp_list(self) + [self.conflict_path,
 
425
        return HandledConflict._cmp_list(self) + [self.conflict_path, 
556
426
                                                  self.conflict_file_id]
557
427
 
558
428
    def as_stanza(self):
560
430
        s.add('conflict_path', self.conflict_path)
561
431
        if self.conflict_file_id is not None:
562
432
            s.add('conflict_file_id', self.conflict_file_id.decode('utf8'))
563
 
 
 
433
            
564
434
        return s
565
435
 
566
436
 
579
449
 
580
450
    format = 'Conflict adding file %(conflict_path)s.  %(action)s %(path)s.'
581
451
 
582
 
    def action_take_this(self, tree):
583
 
        tree.remove([self.conflict_path], force=True, keep_files=False)
584
 
        tree.rename_one(self.path, self.conflict_path)
585
 
 
586
 
    def action_take_other(self, tree):
587
 
        tree.remove([self.path], force=True, keep_files=False)
588
 
 
589
452
 
590
453
class ParentLoop(HandledPathConflict):
591
454
    """An attempt to create an infinitely-looping directory structure.
592
455
    This is rare, but can be produced like so:
593
456
 
594
457
    tree A:
595
 
      mv foo bar
 
458
      mv foo/bar
596
459
    tree B:
597
 
      mv bar foo
 
460
      mv bar/foo
598
461
    merge A and B
599
462
    """
600
463
 
602
465
 
603
466
    format = 'Conflict moving %(conflict_path)s into %(path)s.  %(action)s.'
604
467
 
605
 
    def action_take_this(self, tree):
606
 
        # just acccept bzr proposal
607
 
        pass
608
 
 
609
 
    def action_take_other(self, tree):
610
 
        # FIXME: We shouldn't have to manipulate so many paths here (and there
611
 
        # is probably a bug or two...)
612
 
        base_path = osutils.basename(self.path)
613
 
        conflict_base_path = osutils.basename(self.conflict_path)
614
 
        tt = transform.TreeTransform(tree)
615
 
        try:
616
 
            p_tid = tt.trans_id_file_id(self.file_id)
617
 
            parent_tid = tt.get_tree_parent(p_tid)
618
 
            cp_tid = tt.trans_id_file_id(self.conflict_file_id)
619
 
            cparent_tid = tt.get_tree_parent(cp_tid)
620
 
            tt.adjust_path(base_path, cparent_tid, cp_tid)
621
 
            tt.adjust_path(conflict_base_path, parent_tid, p_tid)
622
 
            tt.apply()
623
 
        finally:
624
 
            tt.finalize()
625
 
 
626
468
 
627
469
class UnversionedParent(HandledConflict):
628
 
    """An attempt to version a file whose parent directory is not versioned.
 
470
    """An attempt to version an file whose parent directory is not versioned.
629
471
    Typically, the result of a merge where one tree unversioned the directory
630
472
    and the other added a versioned file to it.
631
473
    """
635
477
    format = 'Conflict because %(path)s is not versioned, but has versioned'\
636
478
             ' children.  %(action)s.'
637
479
 
638
 
    # FIXME: We silently do nothing to make tests pass, but most probably the
639
 
    # conflict shouldn't exist (the long story is that the conflict is
640
 
    # generated with another one that can be resolved properly) -- vila 091224
641
 
    def action_take_this(self, tree):
642
 
        pass
643
 
 
644
 
    def action_take_other(self, tree):
645
 
        pass
646
 
 
647
480
 
648
481
class MissingParent(HandledConflict):
649
482
    """An attempt to add files to a directory that is not present.
650
483
    Typically, the result of a merge where THIS deleted the directory and
651
484
    the OTHER added a file to it.
652
 
    See also: DeletingParent (same situation, THIS and OTHER reversed)
 
485
    See also: DeletingParent (same situation, reversed THIS and OTHER)
653
486
    """
654
487
 
655
488
    typestring = 'missing parent'
656
489
 
657
490
    format = 'Conflict adding files to %(path)s.  %(action)s.'
658
491
 
659
 
    def action_take_this(self, tree):
660
 
        tree.remove([self.path], force=True, keep_files=False)
661
 
 
662
 
    def action_take_other(self, tree):
663
 
        # just acccept bzr proposal
664
 
        pass
665
 
 
666
492
 
667
493
class DeletingParent(HandledConflict):
668
494
    """An attempt to add files to a directory that is not present.
675
501
    format = "Conflict: can't delete %(path)s because it is not empty.  "\
676
502
             "%(action)s."
677
503
 
678
 
    # FIXME: It's a bit strange that the default action is not coherent with
679
 
    # MissingParent from the *user* pov.
680
 
 
681
 
    def action_take_this(self, tree):
682
 
        # just acccept bzr proposal
683
 
        pass
684
 
 
685
 
    def action_take_other(self, tree):
686
 
        tree.remove([self.path], force=True, keep_files=False)
687
 
 
688
 
 
689
 
class NonDirectoryParent(HandledConflict):
690
 
    """An attempt to add files to a directory that is not a directory or
691
 
    an attempt to change the kind of a directory with files.
692
 
    """
693
 
 
694
 
    typestring = 'non-directory parent'
695
 
 
696
 
    format = "Conflict: %(path)s is not a directory, but has files in it."\
697
 
             "  %(action)s."
698
 
 
699
 
    # FIXME: .OTHER should be used instead of .new when the conflict is created
700
 
 
701
 
    def action_take_this(self, tree):
702
 
        # FIXME: we should preserve that path when the conflict is generated !
703
 
        if self.path.endswith('.new'):
704
 
            conflict_path = self.path[:-(len('.new'))]
705
 
            tree.remove([self.path], force=True, keep_files=False)
706
 
            tree.add(conflict_path)
707
 
        else:
708
 
            raise NotImplementedError(self.action_take_this)
709
 
 
710
 
    def action_take_other(self, tree):
711
 
        # FIXME: we should preserve that path when the conflict is generated !
712
 
        if self.path.endswith('.new'):
713
 
            conflict_path = self.path[:-(len('.new'))]
714
 
            tree.remove([conflict_path], force=True, keep_files=False)
715
 
            tree.rename_one(self.path, conflict_path)
716
 
        else:
717
 
            raise NotImplementedError(self.action_take_other)
718
 
 
719
504
 
720
505
ctype = {}
721
506
 
726
511
    for conflict_type in conflict_types:
727
512
        ctype[conflict_type.typestring] = conflict_type
728
513
 
 
514
 
729
515
register_types(ContentsConflict, TextConflict, PathConflict, DuplicateID,
730
516
               DuplicateEntry, ParentLoop, UnversionedParent, MissingParent,
731
 
               DeletingParent, NonDirectoryParent)
 
517
               DeletingParent,)