← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/conflicts.py

  • Committer: Patch Queue Manager
  • Date: 2011-09-22 14:12:18 UTC
  • mfrom: (6155.3.1 jam)
  • Revision ID: pqm@pqm.ubuntu.com-20110922141218-86s4uu6nqvourw4f
(jameinel) Cleanup comments bzrlib/smart/__init__.py (John A Meinel)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/conflicts.py
1
 
# Copyright (C) 2005 by Aaron Bentley
 
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
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., 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 
 
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
20
18
# point down
21
19
 
22
20
import os
 
21
 
 
22
from bzrlib.lazy_import import lazy_import
 
23
lazy_import(globals(), """
23
24
import errno
24
25
 
25
 
import bzrlib
26
 
from bzrlib.commands import register_command
27
 
from bzrlib.errors import BzrCommandError, NotConflicted, UnsupportedOperation
28
 
from bzrlib.option import Option
29
 
from bzrlib.osutils import rename, delete_any
30
 
from bzrlib.rio import Stanza
 
26
from bzrlib import (
 
27
    cleanup,
 
28
    errors,
 
29
    osutils,
 
30
    rio,
 
31
    trace,
 
32
    transform,
 
33
    workingtree,
 
34
    )
 
35
from bzrlib.i18n import gettext, ngettext
 
36
""")
 
37
from bzrlib import (
 
38
    commands,
 
39
    option,
 
40
    registry,
 
41
    )
31
42
 
32
43
 
33
44
CONFLICT_SUFFIXES = ('.THIS', '.BASE', '.OTHER')
34
45
 
35
46
 
36
 
class cmd_conflicts(bzrlib.commands.Command):
37
 
    """List files with conflicts.
 
47
class cmd_conflicts(commands.Command):
 
48
    __doc__ = """List files with conflicts.
38
49
 
39
50
    Merge will do its best to combine the changes in two branches, but there
40
51
    are some kinds of problems only a human can fix.  When it encounters those,
41
52
    it will mark a conflict.  A conflict means that you need to fix something,
42
53
    before you should commit.
43
54
 
 
55
    Conflicts normally are listed as short, human-readable messages.  If --text
 
56
    is supplied, the pathnames of files with text conflicts are listed,
 
57
    instead.  (This is useful for editing all files with text conflicts.)
 
58
 
44
59
    Use bzr resolve when you have fixed a problem.
45
 
 
46
 
    (conflicts are determined by the presence of .BASE .TREE, and .OTHER 
47
 
    files.)
48
 
 
49
 
    See also bzr resolve.
50
60
    """
51
 
    def run(self):
52
 
        from bzrlib.workingtree import WorkingTree
53
 
        wt = WorkingTree.open_containing(u'.')[0]
 
61
    takes_options = [
 
62
            'directory',
 
63
            option.Option('text',
 
64
                          help='List paths of files with text conflicts.'),
 
65
        ]
 
66
    _see_also = ['resolve', 'conflict-types']
 
67
 
 
68
    def run(self, text=False, directory=u'.'):
 
69
        wt = workingtree.WorkingTree.open_containing(directory)[0]
54
70
        for conflict in wt.conflicts():
55
 
            print conflict
56
 
 
57
 
 
58
 
class cmd_resolve(bzrlib.commands.Command):
59
 
    """Mark a conflict as resolved.
 
71
            if text:
 
72
                if conflict.typestring != 'text conflict':
 
73
                    continue
 
74
                self.outf.write(conflict.path + '\n')
 
75
            else:
 
76
                self.outf.write(unicode(conflict) + '\n')
 
77
 
 
78
 
 
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
class cmd_resolve(commands.Command):
 
102
    __doc__ = """Mark a conflict as resolved.
60
103
 
61
104
    Merge will do its best to combine the changes in two branches, but there
62
105
    are some kinds of problems only a human can fix.  When it encounters those,
63
106
    it will mark a conflict.  A conflict means that you need to fix something,
64
107
    before you should commit.
65
108
 
66
 
    Once you have fixed a problem, use "bzr resolve FILE.." to mark
67
 
    individual files as fixed, or "bzr resolve --all" to mark all conflicts as
68
 
    resolved.
69
 
 
70
 
    See also bzr conflicts.
 
109
    Once you have fixed a problem, use "bzr resolve" to automatically mark
 
110
    text conflicts as fixed, "bzr resolve FILE" to mark a specific conflict as
 
111
    resolved, or "bzr resolve --all" to mark all conflicts as resolved.
71
112
    """
72
113
    aliases = ['resolved']
73
114
    takes_args = ['file*']
74
 
    takes_options = [Option('all', help='Resolve all conflicts in this tree')]
75
 
    def run(self, file_list=None, all=False):
76
 
        from bzrlib.workingtree import WorkingTree
 
115
    takes_options = [
 
116
            'directory',
 
117
            option.Option('all', help='Resolve all conflicts in this tree.'),
 
118
            ResolveActionOption(),
 
119
            ]
 
120
    _see_also = ['conflicts']
 
121
    def run(self, file_list=None, all=False, action=None, directory=None):
77
122
        if all:
78
123
            if file_list:
79
 
                raise BzrCommandError("If --all is specified, no FILE may be provided")
80
 
            tree = WorkingTree.open_containing('.')[0]
81
 
            resolve(tree)
82
 
        else:
83
 
            if file_list is None:
84
 
                raise BzrCommandError("command 'resolve' needs one or more FILE, or --all")
85
 
            tree = WorkingTree.open_containing(file_list[0])[0]
86
 
            to_resolve = [tree.relpath(p) for p in file_list]
87
 
            resolve(tree, to_resolve)
88
 
 
89
 
 
90
 
def resolve(tree, paths=None, ignore_misses=False):
91
 
    tree.lock_write()
 
124
                raise errors.BzrCommandError(gettext("If --all is specified,"
 
125
                                             " no FILE may be provided"))
 
126
            if directory is None:
 
127
                directory = u'.'
 
128
            tree = workingtree.WorkingTree.open_containing(directory)[0]
 
129
            if action is None:
 
130
                action = 'done'
 
131
        else:
 
132
            tree, file_list = workingtree.WorkingTree.open_containing_paths(
 
133
                file_list, directory)
 
134
            if file_list is None:
 
135
                if action is None:
 
136
                    # FIXME: There is a special case here related to the option
 
137
                    # handling that could be clearer and easier to discover by
 
138
                    # providing an --auto action (bug #344013 and #383396) and
 
139
                    # make it mandatory instead of implicit and active only
 
140
                    # when no file_list is provided -- vila 091229
 
141
                    action = 'auto'
 
142
            else:
 
143
                if action is None:
 
144
                    action = 'done'
 
145
        if action == 'auto':
 
146
            if file_list is None:
 
147
                un_resolved, resolved = tree.auto_resolve()
 
148
                if len(un_resolved) > 0:
 
149
                    trace.note(ngettext('%d conflict auto-resolved.',
 
150
                        '%d conflicts auto-resolved.', len(resolved)),
 
151
                        len(resolved))
 
152
                    trace.note(gettext('Remaining conflicts:'))
 
153
                    for conflict in un_resolved:
 
154
                        trace.note(unicode(conflict))
 
155
                    return 1
 
156
                else:
 
157
                    trace.note(gettext('All conflicts resolved.'))
 
158
                    return 0
 
159
            else:
 
160
                # FIXME: This can never occur but the block above needs some
 
161
                # refactoring to transfer tree.auto_resolve() to
 
162
                # conflict.auto(tree) --vila 091242
 
163
                pass
 
164
        else:
 
165
            before, after = resolve(tree, file_list, action=action)
 
166
            trace.note(ngettext('{0} conflict resolved, {1} remaining',
 
167
                                '{0} conflicts resolved, {1} remaining',
 
168
                                before-after).format(before - after, after))
 
169
 
 
170
 
 
171
def resolve(tree, paths=None, ignore_misses=False, recursive=False,
 
172
            action='done'):
 
173
    """Resolve some or all of the conflicts in a working tree.
 
174
 
 
175
    :param paths: If None, resolve all conflicts.  Otherwise, select only
 
176
        specified conflicts.
 
177
    :param recursive: If True, then elements of paths which are directories
 
178
        have all their children resolved, etc.  When invoked as part of
 
179
        recursive commands like revert, this should be True.  For commands
 
180
        or applications wishing finer-grained control, like the resolve
 
181
        command, this should be False.
 
182
    :param ignore_misses: If False, warnings will be printed if the supplied
 
183
        paths do not have conflicts.
 
184
    :param action: How the conflict should be resolved,
 
185
    """
 
186
    tree.lock_tree_write()
 
187
    nb_conflicts_after = None
92
188
    try:
93
189
        tree_conflicts = tree.conflicts()
 
190
        nb_conflicts_before = len(tree_conflicts)
94
191
        if paths is None:
95
192
            new_conflicts = ConflictList()
96
 
            selected_conflicts = tree_conflicts
 
193
            to_process = tree_conflicts
97
194
        else:
98
 
            new_conflicts, selected_conflicts = \
99
 
                tree_conflicts.select_conflicts(tree, paths, ignore_misses)
 
195
            new_conflicts, to_process = tree_conflicts.select_conflicts(
 
196
                tree, paths, ignore_misses, recursive)
 
197
        for conflict in to_process:
 
198
            try:
 
199
                conflict._do(action, tree)
 
200
                conflict.cleanup(tree)
 
201
            except NotImplementedError:
 
202
                new_conflicts.append(conflict)
100
203
        try:
 
204
            nb_conflicts_after = len(new_conflicts)
101
205
            tree.set_conflicts(new_conflicts)
102
 
        except UnsupportedOperation:
 
206
        except errors.UnsupportedOperation:
103
207
            pass
104
 
        selected_conflicts.remove_files(tree)
105
208
    finally:
106
209
        tree.unlock()
 
210
    if nb_conflicts_after is None:
 
211
        nb_conflicts_after = nb_conflicts_before
 
212
    return nb_conflicts_before, nb_conflicts_after
107
213
 
108
214
 
109
215
def restore(filename):
110
 
    """\
111
 
    Restore a conflicted file to the state it was in before merging.
112
 
    Only text restoration supported at present.
 
216
    """Restore a conflicted file to the state it was in before merging.
 
217
 
 
218
    Only text restoration is supported at present.
113
219
    """
114
220
    conflicted = False
115
221
    try:
116
 
        rename(filename + ".THIS", filename)
 
222
        osutils.rename(filename + ".THIS", filename)
117
223
        conflicted = True
118
224
    except OSError, e:
119
225
        if e.errno != errno.ENOENT:
131
237
        if e.errno != errno.ENOENT:
132
238
            raise
133
239
    if not conflicted:
134
 
        raise NotConflicted(filename)
 
240
        raise errors.NotConflicted(filename)
135
241
 
136
242
 
137
243
class ConflictList(object):
185
291
        """Generator of stanzas"""
186
292
        for conflict in self:
187
293
            yield conflict.as_stanza()
188
 
            
 
294
 
189
295
    def to_strings(self):
190
296
        """Generate strings for the provided conflicts"""
191
297
        for conflict in self:
192
 
            yield str(conflict)
 
298
            yield unicode(conflict)
193
299
 
194
300
    def remove_files(self, tree):
195
301
        """Remove the THIS, BASE and OTHER files for listed conflicts"""
196
302
        for conflict in self:
197
303
            if not conflict.has_files:
198
304
                continue
199
 
            for suffix in CONFLICT_SUFFIXES:
200
 
                try:
201
 
                    delete_any(tree.abspath(conflict.path+suffix))
202
 
                except OSError, e:
203
 
                    if e.errno != errno.ENOENT:
204
 
                        raise
 
305
            conflict.cleanup(tree)
205
306
 
206
 
    def select_conflicts(self, tree, paths, ignore_misses=False):
 
307
    def select_conflicts(self, tree, paths, ignore_misses=False,
 
308
                         recurse=False):
207
309
        """Select the conflicts associated with paths in a tree.
208
 
        
 
310
 
209
311
        File-ids are also used for this.
210
312
        :return: a pair of ConflictLists: (not_selected, selected)
211
313
        """
228
330
                if cpath in path_set:
229
331
                    selected = True
230
332
                    selected_paths.add(cpath)
 
333
                if recurse:
 
334
                    if osutils.is_inside_any(path_set, cpath):
 
335
                        selected = True
 
336
                        selected_paths.add(cpath)
 
337
 
231
338
            for key in ('file_id', 'conflict_file_id'):
232
339
                cfile_id = getattr(conflict, key, None)
233
340
                if cfile_id is None:
250
357
                    print "%s is not conflicted" % path
251
358
        return new_conflicts, selected_conflicts
252
359
 
253
 
 
 
360
 
254
361
class Conflict(object):
255
362
    """Base class for all types of conflict"""
256
363
 
 
364
    # FIXME: cleanup should take care of that ? -- vila 091229
257
365
    has_files = False
258
366
 
259
367
    def __init__(self, path, file_id=None):
260
368
        self.path = path
261
 
        self.file_id = file_id
 
369
        # warn turned off, because the factory blindly transfers the Stanza
 
370
        # values to __init__ and Stanza is purely a Unicode api.
 
371
        self.file_id = osutils.safe_file_id(file_id, warn=False)
262
372
 
263
373
    def as_stanza(self):
264
 
        s = Stanza(type=self.typestring, path=self.path)
 
374
        s = rio.Stanza(type=self.typestring, path=self.path)
265
375
        if self.file_id is not None:
266
 
            s.add('file_id', self.file_id)
 
376
            # Stanza requires Unicode apis
 
377
            s.add('file_id', self.file_id.decode('utf8'))
267
378
        return s
268
379
 
269
380
    def _cmp_list(self):
283
394
    def __ne__(self, other):
284
395
        return not self.__eq__(other)
285
396
 
286
 
    def __str__(self):
 
397
    def __unicode__(self):
287
398
        return self.format % self.__dict__
288
399
 
289
400
    def __repr__(self):
305
416
        else:
306
417
            return None, conflict.typestring
307
418
 
 
419
    def _do(self, action, tree):
 
420
        """Apply the specified action to the conflict.
 
421
 
 
422
        :param action: The method name to call.
 
423
 
 
424
        :param tree: The tree passed as a parameter to the method.
 
425
        """
 
426
        meth = getattr(self, 'action_%s' % action, None)
 
427
        if meth is None:
 
428
            raise NotImplementedError(self.__class__.__name__ + '.' + action)
 
429
        meth(tree)
 
430
 
 
431
    def associated_filenames(self):
 
432
        """The names of the files generated to help resolve the conflict."""
 
433
        raise NotImplementedError(self.associated_filenames)
 
434
 
 
435
    def cleanup(self, tree):
 
436
        for fname in self.associated_filenames():
 
437
            try:
 
438
                osutils.delete_any(tree.abspath(fname))
 
439
            except OSError, e:
 
440
                if e.errno != errno.ENOENT:
 
441
                    raise
 
442
 
 
443
    def action_done(self, tree):
 
444
        """Mark the conflict as solved once it has been handled."""
 
445
        # This method does nothing but simplifies the design of upper levels.
 
446
        pass
 
447
 
 
448
    def action_take_this(self, tree):
 
449
        raise NotImplementedError(self.action_take_this)
 
450
 
 
451
    def action_take_other(self, tree):
 
452
        raise NotImplementedError(self.action_take_other)
 
453
 
 
454
    def _resolve_with_cleanups(self, tree, *args, **kwargs):
 
455
        tt = transform.TreeTransform(tree)
 
456
        op = cleanup.OperationWithCleanups(self._resolve)
 
457
        op.add_cleanup(tt.finalize)
 
458
        op.run_simple(tt, *args, **kwargs)
 
459
 
308
460
 
309
461
class PathConflict(Conflict):
310
462
    """A conflict was encountered merging file paths"""
314
466
    format = 'Path conflict: %(path)s / %(conflict_path)s'
315
467
 
316
468
    rformat = '%(class)s(%(path)r, %(conflict_path)r, %(file_id)r)'
 
469
 
317
470
    def __init__(self, path, conflict_path=None, file_id=None):
318
471
        Conflict.__init__(self, path, file_id)
319
472
        self.conflict_path = conflict_path
324
477
            s.add('conflict_path', self.conflict_path)
325
478
        return s
326
479
 
 
480
    def associated_filenames(self):
 
481
        # No additional files have been generated here
 
482
        return []
 
483
 
 
484
    def _resolve(self, tt, file_id, path, winner):
 
485
        """Resolve the conflict.
 
486
 
 
487
        :param tt: The TreeTransform where the conflict is resolved.
 
488
        :param file_id: The retained file id.
 
489
        :param path: The retained path.
 
490
        :param winner: 'this' or 'other' indicates which side is the winner.
 
491
        """
 
492
        path_to_create = None
 
493
        if winner == 'this':
 
494
            if self.path == '<deleted>':
 
495
                return # Nothing to do
 
496
            if self.conflict_path == '<deleted>':
 
497
                path_to_create = self.path
 
498
                revid = tt._tree.get_parent_ids()[0]
 
499
        elif winner == 'other':
 
500
            if self.conflict_path == '<deleted>':
 
501
                return  # Nothing to do
 
502
            if self.path == '<deleted>':
 
503
                path_to_create = self.conflict_path
 
504
                # FIXME: If there are more than two parents we may need to
 
505
                # iterate. Taking the last parent is the safer bet in the mean
 
506
                # time. -- vila 20100309
 
507
                revid = tt._tree.get_parent_ids()[-1]
 
508
        else:
 
509
            # Programmer error
 
510
            raise AssertionError('bad winner: %r' % (winner,))
 
511
        if path_to_create is not None:
 
512
            tid = tt.trans_id_tree_path(path_to_create)
 
513
            transform.create_from_tree(
 
514
                tt, tid, self._revision_tree(tt._tree, revid), file_id)
 
515
            tt.version_file(file_id, tid)
 
516
        else:
 
517
            tid = tt.trans_id_file_id(file_id)
 
518
        # Adjust the path for the retained file id
 
519
        parent_tid = tt.get_tree_parent(tid)
 
520
        tt.adjust_path(osutils.basename(path), parent_tid, tid)
 
521
        tt.apply()
 
522
 
 
523
    def _revision_tree(self, tree, revid):
 
524
        return tree.branch.repository.revision_tree(revid)
 
525
 
 
526
    def _infer_file_id(self, tree):
 
527
        # Prior to bug #531967, file_id wasn't always set, there may still be
 
528
        # conflict files in the wild so we need to cope with them
 
529
        # Establish which path we should use to find back the file-id
 
530
        possible_paths = []
 
531
        for p in (self.path, self.conflict_path):
 
532
            if p == '<deleted>':
 
533
                # special hard-coded path 
 
534
                continue
 
535
            if p is not None:
 
536
                possible_paths.append(p)
 
537
        # Search the file-id in the parents with any path available
 
538
        file_id = None
 
539
        for revid in tree.get_parent_ids():
 
540
            revtree = self._revision_tree(tree, revid)
 
541
            for p in possible_paths:
 
542
                file_id = revtree.path2id(p)
 
543
                if file_id is not None:
 
544
                    return revtree, file_id
 
545
        return None, None
 
546
 
 
547
    def action_take_this(self, tree):
 
548
        if self.file_id is not None:
 
549
            self._resolve_with_cleanups(tree, self.file_id, self.path,
 
550
                                        winner='this')
 
551
        else:
 
552
            # Prior to bug #531967 we need to find back the file_id and restore
 
553
            # the content from there
 
554
            revtree, file_id = self._infer_file_id(tree)
 
555
            tree.revert([revtree.id2path(file_id)],
 
556
                        old_tree=revtree, backups=False)
 
557
 
 
558
    def action_take_other(self, tree):
 
559
        if self.file_id is not None:
 
560
            self._resolve_with_cleanups(tree, self.file_id,
 
561
                                        self.conflict_path,
 
562
                                        winner='other')
 
563
        else:
 
564
            # Prior to bug #531967 we need to find back the file_id and restore
 
565
            # the content from there
 
566
            revtree, file_id = self._infer_file_id(tree)
 
567
            tree.revert([revtree.id2path(file_id)],
 
568
                        old_tree=revtree, backups=False)
 
569
 
327
570
 
328
571
class ContentsConflict(PathConflict):
329
 
    """The files are of different types, or not present"""
 
572
    """The files are of different types (or both binary), or not present"""
330
573
 
331
574
    has_files = True
332
575
 
334
577
 
335
578
    format = 'Contents conflict in %(path)s'
336
579
 
337
 
 
338
 
class TextConflict(PathConflict):
 
580
    def associated_filenames(self):
 
581
        return [self.path + suffix for suffix in ('.BASE', '.OTHER')]
 
582
 
 
583
    def _resolve(self, tt, suffix_to_remove):
 
584
        """Resolve the conflict.
 
585
 
 
586
        :param tt: The TreeTransform where the conflict is resolved.
 
587
        :param suffix_to_remove: Either 'THIS' or 'OTHER'
 
588
 
 
589
        The resolution is symmetric: when taking THIS, OTHER is deleted and
 
590
        item.THIS is renamed into item and vice-versa.
 
591
        """
 
592
        try:
 
593
            # Delete 'item.THIS' or 'item.OTHER' depending on
 
594
            # suffix_to_remove
 
595
            tt.delete_contents(
 
596
                tt.trans_id_tree_path(self.path + '.' + suffix_to_remove))
 
597
        except errors.NoSuchFile:
 
598
            # There are valid cases where 'item.suffix_to_remove' either
 
599
            # never existed or was already deleted (including the case
 
600
            # where the user deleted it)
 
601
            pass
 
602
        try:
 
603
            this_path = tt._tree.id2path(self.file_id)
 
604
        except errors.NoSuchId:
 
605
            # The file is not present anymore. This may happen if the user
 
606
            # deleted the file either manually or when resolving a conflict on
 
607
            # the parent.  We may raise some exception to indicate that the
 
608
            # conflict doesn't exist anymore and as such doesn't need to be
 
609
            # resolved ? -- vila 20110615 
 
610
            this_tid = None
 
611
        else:
 
612
            this_tid = tt.trans_id_tree_path(this_path)
 
613
        if this_tid is not None:
 
614
            # Rename 'item.suffix_to_remove' (note that if
 
615
            # 'item.suffix_to_remove' has been deleted, this is a no-op)
 
616
            parent_tid = tt.get_tree_parent(this_tid)
 
617
            tt.adjust_path(osutils.basename(self.path), parent_tid, this_tid)
 
618
            tt.apply()
 
619
 
 
620
    def action_take_this(self, tree):
 
621
        self._resolve_with_cleanups(tree, 'OTHER')
 
622
 
 
623
    def action_take_other(self, tree):
 
624
        self._resolve_with_cleanups(tree, 'THIS')
 
625
 
 
626
 
 
627
# TODO: There should be a base revid attribute to better inform the user about
 
628
# how the conflicts were generated.
 
629
class TextConflict(Conflict):
339
630
    """The merge algorithm could not resolve all differences encountered."""
340
631
 
341
632
    has_files = True
344
635
 
345
636
    format = 'Text conflict in %(path)s'
346
637
 
 
638
    rformat = '%(class)s(%(path)r, %(file_id)r)'
 
639
 
 
640
    def associated_filenames(self):
 
641
        return [self.path + suffix for suffix in CONFLICT_SUFFIXES]
 
642
 
 
643
    def _resolve(self, tt, winner_suffix):
 
644
        """Resolve the conflict by copying one of .THIS or .OTHER into file.
 
645
 
 
646
        :param tt: The TreeTransform where the conflict is resolved.
 
647
        :param winner_suffix: Either 'THIS' or 'OTHER'
 
648
 
 
649
        The resolution is symmetric, when taking THIS, item.THIS is renamed
 
650
        into item and vice-versa. This takes one of the files as a whole
 
651
        ignoring every difference that could have been merged cleanly.
 
652
        """
 
653
        # To avoid useless copies, we switch item and item.winner_suffix, only
 
654
        # item will exist after the conflict has been resolved anyway.
 
655
        item_tid = tt.trans_id_file_id(self.file_id)
 
656
        item_parent_tid = tt.get_tree_parent(item_tid)
 
657
        winner_path = self.path + '.' + winner_suffix
 
658
        winner_tid = tt.trans_id_tree_path(winner_path)
 
659
        winner_parent_tid = tt.get_tree_parent(winner_tid)
 
660
        # Switch the paths to preserve the content
 
661
        tt.adjust_path(osutils.basename(self.path),
 
662
                       winner_parent_tid, winner_tid)
 
663
        tt.adjust_path(osutils.basename(winner_path), item_parent_tid, item_tid)
 
664
        # Associate the file_id to the right content
 
665
        tt.unversion_file(item_tid)
 
666
        tt.version_file(self.file_id, winner_tid)
 
667
        tt.apply()
 
668
 
 
669
    def action_take_this(self, tree):
 
670
        self._resolve_with_cleanups(tree, 'THIS')
 
671
 
 
672
    def action_take_other(self, tree):
 
673
        self._resolve_with_cleanups(tree, 'OTHER')
 
674
 
347
675
 
348
676
class HandledConflict(Conflict):
349
677
    """A path problem that has been provisionally resolved.
351
679
    """
352
680
 
353
681
    rformat = "%(class)s(%(action)r, %(path)r, %(file_id)r)"
354
 
    
 
682
 
355
683
    def __init__(self, action, path, file_id=None):
356
684
        Conflict.__init__(self, path, file_id)
357
685
        self.action = action
364
692
        s.add('action', self.action)
365
693
        return s
366
694
 
 
695
    def associated_filenames(self):
 
696
        # Nothing has been generated here
 
697
        return []
 
698
 
367
699
 
368
700
class HandledPathConflict(HandledConflict):
369
701
    """A provisionally-resolved path problem involving two paths.
376
708
    def __init__(self, action, path, conflict_path, file_id=None,
377
709
                 conflict_file_id=None):
378
710
        HandledConflict.__init__(self, action, path, file_id)
379
 
        self.conflict_path = conflict_path 
380
 
        self.conflict_file_id = conflict_file_id
381
 
        
 
711
        self.conflict_path = conflict_path
 
712
        # warn turned off, because the factory blindly transfers the Stanza
 
713
        # values to __init__.
 
714
        self.conflict_file_id = osutils.safe_file_id(conflict_file_id,
 
715
                                                     warn=False)
 
716
 
382
717
    def _cmp_list(self):
383
 
        return HandledConflict._cmp_list(self) + [self.conflict_path, 
 
718
        return HandledConflict._cmp_list(self) + [self.conflict_path,
384
719
                                                  self.conflict_file_id]
385
720
 
386
721
    def as_stanza(self):
387
722
        s = HandledConflict.as_stanza(self)
388
723
        s.add('conflict_path', self.conflict_path)
389
724
        if self.conflict_file_id is not None:
390
 
            s.add('conflict_file_id', self.conflict_file_id)
391
 
            
 
725
            s.add('conflict_file_id', self.conflict_file_id.decode('utf8'))
 
726
 
392
727
        return s
393
728
 
394
729
 
407
742
 
408
743
    format = 'Conflict adding file %(conflict_path)s.  %(action)s %(path)s.'
409
744
 
 
745
    def action_take_this(self, tree):
 
746
        tree.remove([self.conflict_path], force=True, keep_files=False)
 
747
        tree.rename_one(self.path, self.conflict_path)
 
748
 
 
749
    def action_take_other(self, tree):
 
750
        tree.remove([self.path], force=True, keep_files=False)
 
751
 
410
752
 
411
753
class ParentLoop(HandledPathConflict):
412
754
    """An attempt to create an infinitely-looping directory structure.
413
755
    This is rare, but can be produced like so:
414
756
 
415
757
    tree A:
416
 
      mv foo/bar
 
758
      mv foo bar
417
759
    tree B:
418
 
      mv bar/foo
 
760
      mv bar foo
419
761
    merge A and B
420
762
    """
421
763
 
422
764
    typestring = 'parent loop'
423
765
 
424
 
    format = 'Conflict moving %(conflict_path)s into %(path)s.  %(action)s.'
 
766
    format = 'Conflict moving %(path)s into %(conflict_path)s. %(action)s.'
 
767
 
 
768
    def action_take_this(self, tree):
 
769
        # just acccept bzr proposal
 
770
        pass
 
771
 
 
772
    def action_take_other(self, tree):
 
773
        tt = transform.TreeTransform(tree)
 
774
        try:
 
775
            p_tid = tt.trans_id_file_id(self.file_id)
 
776
            parent_tid = tt.get_tree_parent(p_tid)
 
777
            cp_tid = tt.trans_id_file_id(self.conflict_file_id)
 
778
            cparent_tid = tt.get_tree_parent(cp_tid)
 
779
            tt.adjust_path(osutils.basename(self.path), cparent_tid, cp_tid)
 
780
            tt.adjust_path(osutils.basename(self.conflict_path),
 
781
                           parent_tid, p_tid)
 
782
            tt.apply()
 
783
        finally:
 
784
            tt.finalize()
425
785
 
426
786
 
427
787
class UnversionedParent(HandledConflict):
428
 
    """An attempt to version an file whose parent directory is not versioned.
 
788
    """An attempt to version a file whose parent directory is not versioned.
429
789
    Typically, the result of a merge where one tree unversioned the directory
430
790
    and the other added a versioned file to it.
431
791
    """
432
792
 
433
793
    typestring = 'unversioned parent'
434
794
 
435
 
    format = 'Conflict adding versioned files to %(path)s.  %(action)s.'
 
795
    format = 'Conflict because %(path)s is not versioned, but has versioned'\
 
796
             ' children.  %(action)s.'
 
797
 
 
798
    # FIXME: We silently do nothing to make tests pass, but most probably the
 
799
    # conflict shouldn't exist (the long story is that the conflict is
 
800
    # generated with another one that can be resolved properly) -- vila 091224
 
801
    def action_take_this(self, tree):
 
802
        pass
 
803
 
 
804
    def action_take_other(self, tree):
 
805
        pass
436
806
 
437
807
 
438
808
class MissingParent(HandledConflict):
439
809
    """An attempt to add files to a directory that is not present.
440
 
    Typically, the result of a merge where one tree deleted the directory and
441
 
    the other added a file to it.
 
810
    Typically, the result of a merge where THIS deleted the directory and
 
811
    the OTHER added a file to it.
 
812
    See also: DeletingParent (same situation, THIS and OTHER reversed)
442
813
    """
443
814
 
444
815
    typestring = 'missing parent'
445
816
 
446
817
    format = 'Conflict adding files to %(path)s.  %(action)s.'
447
818
 
 
819
    def action_take_this(self, tree):
 
820
        tree.remove([self.path], force=True, keep_files=False)
 
821
 
 
822
    def action_take_other(self, tree):
 
823
        # just acccept bzr proposal
 
824
        pass
 
825
 
 
826
 
 
827
class DeletingParent(HandledConflict):
 
828
    """An attempt to add files to a directory that is not present.
 
829
    Typically, the result of a merge where one OTHER deleted the directory and
 
830
    the THIS added a file to it.
 
831
    """
 
832
 
 
833
    typestring = 'deleting parent'
 
834
 
 
835
    format = "Conflict: can't delete %(path)s because it is not empty.  "\
 
836
             "%(action)s."
 
837
 
 
838
    # FIXME: It's a bit strange that the default action is not coherent with
 
839
    # MissingParent from the *user* pov.
 
840
 
 
841
    def action_take_this(self, tree):
 
842
        # just acccept bzr proposal
 
843
        pass
 
844
 
 
845
    def action_take_other(self, tree):
 
846
        tree.remove([self.path], force=True, keep_files=False)
 
847
 
 
848
 
 
849
class NonDirectoryParent(HandledConflict):
 
850
    """An attempt to add files to a directory that is not a directory or
 
851
    an attempt to change the kind of a directory with files.
 
852
    """
 
853
 
 
854
    typestring = 'non-directory parent'
 
855
 
 
856
    format = "Conflict: %(path)s is not a directory, but has files in it."\
 
857
             "  %(action)s."
 
858
 
 
859
    # FIXME: .OTHER should be used instead of .new when the conflict is created
 
860
 
 
861
    def action_take_this(self, tree):
 
862
        # FIXME: we should preserve that path when the conflict is generated !
 
863
        if self.path.endswith('.new'):
 
864
            conflict_path = self.path[:-(len('.new'))]
 
865
            tree.remove([self.path], force=True, keep_files=False)
 
866
            tree.add(conflict_path)
 
867
        else:
 
868
            raise NotImplementedError(self.action_take_this)
 
869
 
 
870
    def action_take_other(self, tree):
 
871
        # FIXME: we should preserve that path when the conflict is generated !
 
872
        if self.path.endswith('.new'):
 
873
            conflict_path = self.path[:-(len('.new'))]
 
874
            tree.remove([conflict_path], force=True, keep_files=False)
 
875
            tree.rename_one(self.path, conflict_path)
 
876
        else:
 
877
            raise NotImplementedError(self.action_take_other)
448
878
 
449
879
 
450
880
ctype = {}
456
886
    for conflict_type in conflict_types:
457
887
        ctype[conflict_type.typestring] = conflict_type
458
888
 
459
 
 
460
889
register_types(ContentsConflict, TextConflict, PathConflict, DuplicateID,
461
 
               DuplicateEntry, ParentLoop, UnversionedParent, MissingParent,)
 
890
               DuplicateEntry, ParentLoop, UnversionedParent, MissingParent,
 
891
               DeletingParent, NonDirectoryParent)