/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/conflicts.py

  • Committer: Gustav Hartvigsson
  • Date: 2021-01-09 21:36:27 UTC
  • Revision ID: gustav.hartvigsson@gmail.com-20210109213627-h1xwcutzy9m7a99b
Added 'Case Preserving Working Tree Use Cases' from Canonical Wiki

* Addod a page from the Canonical Bazaar wiki
  with information on the scmeatics of case
  perserving filesystems an a case insensitive
  filesystem works.
  
  * Needs re-work, but this will do as it is the
    same inforamoton as what was on the linked
    page in the currint documentation.

Show diffs side-by-side

added added

removed removed

Lines of Context:
17
17
# TODO: 'brz resolve' should accept a directory name and work from that
18
18
# point down
19
19
 
20
 
from __future__ import absolute_import
21
 
 
 
20
import errno
22
21
import os
 
22
import re
23
23
 
24
24
from .lazy_import import lazy_import
25
25
lazy_import(globals(), """
26
 
import errno
27
26
 
28
27
from breezy import (
29
 
    cleanup,
30
 
    errors,
31
 
    osutils,
32
 
    rio,
33
 
    trace,
34
 
    transform,
35
28
    workingtree,
36
29
    )
37
30
from breezy.i18n import gettext, ngettext
38
31
""")
39
32
from . import (
40
33
    cache_utf8,
 
34
    errors,
41
35
    commands,
42
36
    option,
 
37
    osutils,
43
38
    registry,
 
39
    trace,
44
40
    )
45
 
from .sixish import text_type
46
 
 
47
 
 
48
 
CONFLICT_SUFFIXES = ('.THIS', '.BASE', '.OTHER')
49
41
 
50
42
 
51
43
class cmd_conflicts(commands.Command):
77
69
                    continue
78
70
                self.outf.write(conflict.path + '\n')
79
71
            else:
80
 
                self.outf.write(text_type(conflict) + '\n')
 
72
                self.outf.write(str(conflict) + '\n')
81
73
 
82
74
 
83
75
resolve_action_registry = registry.Registry()
84
76
 
85
77
 
86
78
resolve_action_registry.register(
 
79
    'auto', 'auto', 'Detect whether conflict has been resolved by user.')
 
80
resolve_action_registry.register(
87
81
    'done', 'done', 'Marks the conflict as resolved.')
88
82
resolve_action_registry.register(
89
83
    'take-this', 'take_this',
127
121
    def run(self, file_list=None, all=False, action=None, directory=None):
128
122
        if all:
129
123
            if file_list:
130
 
                raise errors.BzrCommandError(gettext("If --all is specified,"
131
 
                                                     " no FILE may be provided"))
 
124
                raise errors.CommandError(gettext("If --all is specified,"
 
125
                                                  " no FILE may be provided"))
132
126
            if directory is None:
133
127
                directory = u'.'
134
128
            tree = workingtree.WorkingTree.open_containing(directory)[0]
137
131
        else:
138
132
            tree, file_list = workingtree.WorkingTree.open_containing_paths(
139
133
                file_list, directory)
140
 
            if file_list is None:
141
 
                if action is None:
142
 
                    # FIXME: There is a special case here related to the option
143
 
                    # handling that could be clearer and easier to discover by
144
 
                    # providing an --auto action (bug #344013 and #383396) and
145
 
                    # make it mandatory instead of implicit and active only
146
 
                    # when no file_list is provided -- vila 091229
 
134
            if action is None:
 
135
                if file_list is None:
147
136
                    action = 'auto'
148
 
            else:
149
 
                if action is None:
 
137
                else:
150
138
                    action = 'done'
151
 
        if action == 'auto':
152
 
            if file_list is None:
153
 
                un_resolved, resolved = tree.auto_resolve()
154
 
                if len(un_resolved) > 0:
155
 
                    trace.note(ngettext('%d conflict auto-resolved.',
156
 
                                        '%d conflicts auto-resolved.', len(resolved)),
157
 
                               len(resolved))
158
 
                    trace.note(gettext('Remaining conflicts:'))
159
 
                    for conflict in un_resolved:
160
 
                        trace.note(text_type(conflict))
161
 
                    return 1
162
 
                else:
163
 
                    trace.note(gettext('All conflicts resolved.'))
164
 
                    return 0
 
139
        before, after = resolve(tree, file_list, action=action)
 
140
        # GZ 2012-07-27: Should unify UI below now that auto is less magical.
 
141
        if action == 'auto' and file_list is None:
 
142
            if after > 0:
 
143
                trace.note(
 
144
                    ngettext('%d conflict auto-resolved.',
 
145
                             '%d conflicts auto-resolved.', before - after),
 
146
                    before - after)
 
147
                trace.note(gettext('Remaining conflicts:'))
 
148
                for conflict in tree.conflicts():
 
149
                    trace.note(str(conflict))
 
150
                return 1
165
151
            else:
166
 
                # FIXME: This can never occur but the block above needs some
167
 
                # refactoring to transfer tree.auto_resolve() to
168
 
                # conflict.auto(tree) --vila 091242
169
 
                pass
 
152
                trace.note(gettext('All conflicts resolved.'))
 
153
                return 0
170
154
        else:
171
 
            before, after = resolve(tree, file_list, action=action)
172
155
            trace.note(ngettext('{0} conflict resolved, {1} remaining',
173
156
                                '{0} conflicts resolved, {1} remaining',
174
157
                                before - after).format(before - after, after))
194
177
        tree_conflicts = tree.conflicts()
195
178
        nb_conflicts_before = len(tree_conflicts)
196
179
        if paths is None:
197
 
            new_conflicts = ConflictList()
 
180
            new_conflicts = []
198
181
            to_process = tree_conflicts
199
182
        else:
200
183
            new_conflicts, to_process = tree_conflicts.select_conflicts(
201
184
                tree, paths, ignore_misses, recursive)
202
185
        for conflict in to_process:
203
186
            try:
204
 
                conflict._do(action, tree)
 
187
                conflict.do(action, tree)
205
188
                conflict.cleanup(tree)
206
189
            except NotImplementedError:
207
190
                new_conflicts.append(conflict)
247
230
    """List of conflicts.
248
231
 
249
232
    Typically obtained from WorkingTree.conflicts()
250
 
 
251
 
    Can be instantiated from stanzas or from Conflict subclasses.
252
233
    """
253
234
 
254
235
    def __init__(self, conflicts=None):
282
263
    def __repr__(self):
283
264
        return "ConflictList(%r)" % self.__list
284
265
 
285
 
    @staticmethod
286
 
    def from_stanzas(stanzas):
287
 
        """Produce a new ConflictList from an iterable of stanzas"""
288
 
        conflicts = ConflictList()
289
 
        for stanza in stanzas:
290
 
            conflicts.append(Conflict.factory(**stanza.as_dict()))
291
 
        return conflicts
292
 
 
293
 
    def to_stanzas(self):
294
 
        """Generator of stanzas"""
295
 
        for conflict in self:
296
 
            yield conflict.as_stanza()
297
 
 
298
266
    def to_strings(self):
299
267
        """Generate strings for the provided conflicts"""
300
268
        for conflict in self:
301
 
            yield text_type(conflict)
 
269
            yield str(conflict)
302
270
 
303
271
    def remove_files(self, tree):
304
272
        """Remove the THIS, BASE and OTHER files for listed conflicts"""
311
279
                         recurse=False):
312
280
        """Select the conflicts associated with paths in a tree.
313
281
 
314
 
        File-ids are also used for this.
315
282
        :return: a pair of ConflictLists: (not_selected, selected)
316
283
        """
317
284
        path_set = set(paths)
318
 
        ids = {}
319
285
        selected_paths = set()
320
286
        new_conflicts = ConflictList()
321
287
        selected_conflicts = ConflictList()
322
 
        for path in paths:
323
 
            file_id = tree.path2id(path)
324
 
            if file_id is not None:
325
 
                ids[file_id] = path
326
288
 
327
289
        for conflict in self:
328
290
            selected = False
329
 
            for key in ('path', 'conflict_path'):
330
 
                cpath = getattr(conflict, key, None)
331
 
                if cpath is None:
332
 
                    continue
333
 
                if cpath in path_set:
 
291
            if conflict.path in path_set:
 
292
                selected = True
 
293
                selected_paths.add(conflict.path)
 
294
            if recurse:
 
295
                if osutils.is_inside_any(path_set, conflict.path):
334
296
                    selected = True
335
 
                    selected_paths.add(cpath)
336
 
                if recurse:
337
 
                    if osutils.is_inside_any(path_set, cpath):
338
 
                        selected = True
339
 
                        selected_paths.add(cpath)
 
297
                    selected_paths.add(conflict.path)
340
298
 
341
 
            for key in ('file_id', 'conflict_file_id'):
342
 
                cfile_id = getattr(conflict, key, None)
343
 
                if cfile_id is None:
344
 
                    continue
345
 
                try:
346
 
                    cpath = ids[cfile_id]
347
 
                except KeyError:
348
 
                    continue
349
 
                selected = True
350
 
                selected_paths.add(cpath)
351
299
            if selected:
352
300
                selected_conflicts.append(conflict)
353
301
            else:
362
310
 
363
311
 
364
312
class Conflict(object):
365
 
    """Base class for all types of conflict"""
366
 
 
367
 
    # FIXME: cleanup should take care of that ? -- vila 091229
368
 
    has_files = False
369
 
 
370
 
    def __init__(self, path, file_id=None):
 
313
    """Base class for conflicts."""
 
314
 
 
315
    typestring = None
 
316
 
 
317
    def __init__(self, path):
371
318
        self.path = path
372
 
        # the factory blindly transfers the Stanza values to __init__ and
373
 
        # Stanza is purely a Unicode api.
374
 
        if isinstance(file_id, text_type):
375
 
            file_id = cache_utf8.encode(file_id)
376
 
        self.file_id = osutils.safe_file_id(file_id)
377
 
 
378
 
    def as_stanza(self):
379
 
        s = rio.Stanza(type=self.typestring, path=self.path)
380
 
        if self.file_id is not None:
381
 
            # Stanza requires Unicode apis
382
 
            s.add('file_id', self.file_id.decode('utf8'))
383
 
        return s
384
 
 
385
 
    def _cmp_list(self):
386
 
        return [type(self), self.path, self.file_id]
387
 
 
388
 
    def __cmp__(self, other):
389
 
        if getattr(other, "_cmp_list", None) is None:
390
 
            return -1
391
 
        x = self._cmp_list()
392
 
        y = other._cmp_list()
393
 
        return (x > y) - (x < y)
394
 
 
395
 
    def __hash__(self):
396
 
        return hash((type(self), self.path, self.file_id))
397
 
 
398
 
    def __eq__(self, other):
399
 
        return self.__cmp__(other) == 0
400
 
 
401
 
    def __ne__(self, other):
402
 
        return not self.__eq__(other)
403
 
 
404
 
    def __unicode__(self):
405
 
        return self.describe()
406
 
 
407
 
    def __str__(self):
408
 
        return self.describe()
409
 
 
410
 
    def describe(self):
411
 
        return self.format % self.__dict__
412
 
 
413
 
    def __repr__(self):
414
 
        rdict = dict(self.__dict__)
415
 
        rdict['class'] = self.__class__.__name__
416
 
        return self.rformat % rdict
417
 
 
418
 
    @staticmethod
419
 
    def factory(type, **kwargs):
420
 
        global ctype
421
 
        return ctype[type](**kwargs)
422
 
 
423
 
    @staticmethod
424
 
    def sort_key(conflict):
425
 
        if conflict.path is not None:
426
 
            return conflict.path, conflict.typestring
427
 
        elif getattr(conflict, "conflict_path", None) is not None:
428
 
            return conflict.conflict_path, conflict.typestring
429
 
        else:
430
 
            return None, conflict.typestring
431
 
 
432
 
    def _do(self, action, tree):
433
 
        """Apply the specified action to the conflict.
434
 
 
435
 
        :param action: The method name to call.
436
 
 
437
 
        :param tree: The tree passed as a parameter to the method.
438
 
        """
439
 
        meth = getattr(self, 'action_%s' % action, None)
440
 
        if meth is None:
441
 
            raise NotImplementedError(self.__class__.__name__ + '.' + action)
442
 
        meth(tree)
443
319
 
444
320
    def associated_filenames(self):
445
321
        """The names of the files generated to help resolve the conflict."""
453
329
                if e.errno != errno.ENOENT:
454
330
                    raise
455
331
 
456
 
    def action_done(self, tree):
457
 
        """Mark the conflict as solved once it has been handled."""
458
 
        # This method does nothing but simplifies the design of upper levels.
459
 
        pass
460
 
 
461
 
    def action_take_this(self, tree):
462
 
        raise NotImplementedError(self.action_take_this)
463
 
 
464
 
    def action_take_other(self, tree):
465
 
        raise NotImplementedError(self.action_take_other)
466
 
 
467
 
    def _resolve_with_cleanups(self, tree, *args, **kwargs):
468
 
        tt = transform.TreeTransform(tree)
469
 
        op = cleanup.OperationWithCleanups(self._resolve)
470
 
        op.add_cleanup(tt.finalize)
471
 
        op.run_simple(tt, *args, **kwargs)
472
 
 
473
 
 
474
 
class PathConflict(Conflict):
475
 
    """A conflict was encountered merging file paths"""
476
 
 
477
 
    typestring = 'path conflict'
478
 
 
479
 
    format = 'Path conflict: %(path)s / %(conflict_path)s'
480
 
 
481
 
    rformat = '%(class)s(%(path)r, %(conflict_path)r, %(file_id)r)'
482
 
 
483
 
    def __init__(self, path, conflict_path=None, file_id=None):
484
 
        Conflict.__init__(self, path, file_id)
485
 
        self.conflict_path = conflict_path
486
 
 
487
 
    def as_stanza(self):
488
 
        s = Conflict.as_stanza(self)
489
 
        if self.conflict_path is not None:
490
 
            s.add('conflict_path', self.conflict_path)
491
 
        return s
492
 
 
493
 
    def associated_filenames(self):
494
 
        # No additional files have been generated here
495
 
        return []
496
 
 
497
 
    def _resolve(self, tt, file_id, path, winner):
498
 
        """Resolve the conflict.
499
 
 
500
 
        :param tt: The TreeTransform where the conflict is resolved.
501
 
        :param file_id: The retained file id.
502
 
        :param path: The retained path.
503
 
        :param winner: 'this' or 'other' indicates which side is the winner.
504
 
        """
505
 
        path_to_create = None
506
 
        if winner == 'this':
507
 
            if self.path == '<deleted>':
508
 
                return  # Nothing to do
509
 
            if self.conflict_path == '<deleted>':
510
 
                path_to_create = self.path
511
 
                revid = tt._tree.get_parent_ids()[0]
512
 
        elif winner == 'other':
513
 
            if self.conflict_path == '<deleted>':
514
 
                return  # Nothing to do
515
 
            if self.path == '<deleted>':
516
 
                path_to_create = self.conflict_path
517
 
                # FIXME: If there are more than two parents we may need to
518
 
                # iterate. Taking the last parent is the safer bet in the mean
519
 
                # time. -- vila 20100309
520
 
                revid = tt._tree.get_parent_ids()[-1]
521
 
        else:
522
 
            # Programmer error
523
 
            raise AssertionError('bad winner: %r' % (winner,))
524
 
        if path_to_create is not None:
525
 
            tid = tt.trans_id_tree_path(path_to_create)
526
 
            tree = self._revision_tree(tt._tree, revid)
527
 
            transform.create_from_tree(
528
 
                tt, tid, tree, tree.id2path(file_id), file_id=file_id)
529
 
            tt.version_file(file_id, tid)
530
 
        else:
531
 
            tid = tt.trans_id_file_id(file_id)
532
 
        # Adjust the path for the retained file id
533
 
        parent_tid = tt.get_tree_parent(tid)
534
 
        tt.adjust_path(osutils.basename(path), parent_tid, tid)
535
 
        tt.apply()
536
 
 
537
 
    def _revision_tree(self, tree, revid):
538
 
        return tree.branch.repository.revision_tree(revid)
539
 
 
540
 
    def _infer_file_id(self, tree):
541
 
        # Prior to bug #531967, file_id wasn't always set, there may still be
542
 
        # conflict files in the wild so we need to cope with them
543
 
        # Establish which path we should use to find back the file-id
544
 
        possible_paths = []
545
 
        for p in (self.path, self.conflict_path):
546
 
            if p == '<deleted>':
547
 
                # special hard-coded path
548
 
                continue
549
 
            if p is not None:
550
 
                possible_paths.append(p)
551
 
        # Search the file-id in the parents with any path available
552
 
        file_id = None
553
 
        for revid in tree.get_parent_ids():
554
 
            revtree = self._revision_tree(tree, revid)
555
 
            for p in possible_paths:
556
 
                file_id = revtree.path2id(p)
557
 
                if file_id is not None:
558
 
                    return revtree, file_id
559
 
        return None, None
560
 
 
561
 
    def action_take_this(self, tree):
562
 
        if self.file_id is not None:
563
 
            self._resolve_with_cleanups(tree, self.file_id, self.path,
564
 
                                        winner='this')
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)
571
 
 
572
 
    def action_take_other(self, tree):
573
 
        if self.file_id is not None:
574
 
            self._resolve_with_cleanups(tree, self.file_id,
575
 
                                        self.conflict_path,
576
 
                                        winner='other')
577
 
        else:
578
 
            # Prior to bug #531967 we need to find back the file_id and restore
579
 
            # the content from there
580
 
            revtree, file_id = self._infer_file_id(tree)
581
 
            tree.revert([revtree.id2path(file_id)],
582
 
                        old_tree=revtree, backups=False)
583
 
 
584
 
 
585
 
class ContentsConflict(PathConflict):
586
 
    """The files are of different types (or both binary), or not present"""
587
 
 
588
 
    has_files = True
589
 
 
590
 
    typestring = 'contents conflict'
591
 
 
592
 
    format = 'Contents conflict in %(path)s'
593
 
 
594
 
    def associated_filenames(self):
595
 
        return [self.path + suffix for suffix in ('.BASE', '.OTHER')]
596
 
 
597
 
    def _resolve(self, tt, suffix_to_remove):
598
 
        """Resolve the conflict.
599
 
 
600
 
        :param tt: The TreeTransform where the conflict is resolved.
601
 
        :param suffix_to_remove: Either 'THIS' or 'OTHER'
602
 
 
603
 
        The resolution is symmetric: when taking THIS, OTHER is deleted and
604
 
        item.THIS is renamed into item and vice-versa.
605
 
        """
606
 
        try:
607
 
            # Delete 'item.THIS' or 'item.OTHER' depending on
608
 
            # suffix_to_remove
609
 
            tt.delete_contents(
610
 
                tt.trans_id_tree_path(self.path + '.' + suffix_to_remove))
611
 
        except errors.NoSuchFile:
612
 
            # There are valid cases where 'item.suffix_to_remove' either
613
 
            # never existed or was already deleted (including the case
614
 
            # where the user deleted it)
615
 
            pass
616
 
        try:
617
 
            this_path = tt._tree.id2path(self.file_id)
618
 
        except errors.NoSuchId:
619
 
            # The file is not present anymore. This may happen if the user
620
 
            # deleted the file either manually or when resolving a conflict on
621
 
            # the parent.  We may raise some exception to indicate that the
622
 
            # conflict doesn't exist anymore and as such doesn't need to be
623
 
            # resolved ? -- vila 20110615
624
 
            this_tid = None
625
 
        else:
626
 
            this_tid = tt.trans_id_tree_path(this_path)
627
 
        if this_tid is not None:
628
 
            # Rename 'item.suffix_to_remove' (note that if
629
 
            # 'item.suffix_to_remove' has been deleted, this is a no-op)
630
 
            parent_tid = tt.get_tree_parent(this_tid)
631
 
            tt.adjust_path(osutils.basename(self.path), parent_tid, this_tid)
632
 
            tt.apply()
633
 
 
634
 
    def action_take_this(self, tree):
635
 
        self._resolve_with_cleanups(tree, 'OTHER')
636
 
 
637
 
    def action_take_other(self, tree):
638
 
        self._resolve_with_cleanups(tree, 'THIS')
639
 
 
640
 
 
641
 
# TODO: There should be a base revid attribute to better inform the user about
642
 
# how the conflicts were generated.
643
 
class TextConflict(Conflict):
644
 
    """The merge algorithm could not resolve all differences encountered."""
645
 
 
646
 
    has_files = True
647
 
 
648
 
    typestring = 'text conflict'
649
 
 
650
 
    format = 'Text conflict in %(path)s'
651
 
 
652
 
    rformat = '%(class)s(%(path)r, %(file_id)r)'
653
 
 
654
 
    def associated_filenames(self):
655
 
        return [self.path + suffix for suffix in CONFLICT_SUFFIXES]
656
 
 
657
 
    def _resolve(self, tt, winner_suffix):
658
 
        """Resolve the conflict by copying one of .THIS or .OTHER into file.
659
 
 
660
 
        :param tt: The TreeTransform where the conflict is resolved.
661
 
        :param winner_suffix: Either 'THIS' or 'OTHER'
662
 
 
663
 
        The resolution is symmetric, when taking THIS, item.THIS is renamed
664
 
        into item and vice-versa. This takes one of the files as a whole
665
 
        ignoring every difference that could have been merged cleanly.
666
 
        """
667
 
        # To avoid useless copies, we switch item and item.winner_suffix, only
668
 
        # item will exist after the conflict has been resolved anyway.
669
 
        item_tid = tt.trans_id_file_id(self.file_id)
670
 
        item_parent_tid = tt.get_tree_parent(item_tid)
671
 
        winner_path = self.path + '.' + winner_suffix
672
 
        winner_tid = tt.trans_id_tree_path(winner_path)
673
 
        winner_parent_tid = tt.get_tree_parent(winner_tid)
674
 
        # Switch the paths to preserve the content
675
 
        tt.adjust_path(osutils.basename(self.path),
676
 
                       winner_parent_tid, winner_tid)
677
 
        tt.adjust_path(osutils.basename(winner_path),
678
 
                       item_parent_tid, item_tid)
679
 
        # Associate the file_id to the right content
680
 
        tt.unversion_file(item_tid)
681
 
        tt.version_file(self.file_id, winner_tid)
682
 
        tt.apply()
683
 
 
684
 
    def action_take_this(self, tree):
685
 
        self._resolve_with_cleanups(tree, 'THIS')
686
 
 
687
 
    def action_take_other(self, tree):
688
 
        self._resolve_with_cleanups(tree, 'OTHER')
689
 
 
690
 
 
691
 
class HandledConflict(Conflict):
692
 
    """A path problem that has been provisionally resolved.
693
 
    This is intended to be a base class.
694
 
    """
695
 
 
696
 
    rformat = "%(class)s(%(action)r, %(path)r, %(file_id)r)"
697
 
 
698
 
    def __init__(self, action, path, file_id=None):
699
 
        Conflict.__init__(self, path, file_id)
700
 
        self.action = action
701
 
 
702
 
    def _cmp_list(self):
703
 
        return Conflict._cmp_list(self) + [self.action]
704
 
 
705
 
    def as_stanza(self):
706
 
        s = Conflict.as_stanza(self)
707
 
        s.add('action', self.action)
708
 
        return s
709
 
 
710
 
    def associated_filenames(self):
711
 
        # Nothing has been generated here
712
 
        return []
713
 
 
714
 
 
715
 
class HandledPathConflict(HandledConflict):
716
 
    """A provisionally-resolved path problem involving two paths.
717
 
    This is intended to be a base class.
718
 
    """
719
 
 
720
 
    rformat = "%(class)s(%(action)r, %(path)r, %(conflict_path)r,"\
721
 
        " %(file_id)r, %(conflict_file_id)r)"
722
 
 
723
 
    def __init__(self, action, path, conflict_path, file_id=None,
724
 
                 conflict_file_id=None):
725
 
        HandledConflict.__init__(self, action, path, file_id)
726
 
        self.conflict_path = conflict_path
727
 
        # the factory blindly transfers the Stanza values to __init__,
728
 
        # so they can be unicode.
729
 
        if isinstance(conflict_file_id, text_type):
730
 
            conflict_file_id = cache_utf8.encode(conflict_file_id)
731
 
        self.conflict_file_id = osutils.safe_file_id(conflict_file_id)
732
 
 
733
 
    def _cmp_list(self):
734
 
        return HandledConflict._cmp_list(self) + [self.conflict_path,
735
 
                                                  self.conflict_file_id]
736
 
 
737
 
    def as_stanza(self):
738
 
        s = HandledConflict.as_stanza(self)
739
 
        s.add('conflict_path', self.conflict_path)
740
 
        if self.conflict_file_id is not None:
741
 
            s.add('conflict_file_id', self.conflict_file_id.decode('utf8'))
742
 
 
743
 
        return s
744
 
 
745
 
 
746
 
class DuplicateID(HandledPathConflict):
747
 
    """Two files want the same file_id."""
748
 
 
749
 
    typestring = 'duplicate id'
750
 
 
751
 
    format = 'Conflict adding id to %(conflict_path)s.  %(action)s %(path)s.'
752
 
 
753
 
 
754
 
class DuplicateEntry(HandledPathConflict):
755
 
    """Two directory entries want to have the same name."""
756
 
 
757
 
    typestring = 'duplicate'
758
 
 
759
 
    format = 'Conflict adding file %(conflict_path)s.  %(action)s %(path)s.'
760
 
 
761
 
    def action_take_this(self, tree):
762
 
        tree.remove([self.conflict_path], force=True, keep_files=False)
763
 
        tree.rename_one(self.path, self.conflict_path)
764
 
 
765
 
    def action_take_other(self, tree):
766
 
        tree.remove([self.path], force=True, keep_files=False)
767
 
 
768
 
 
769
 
class ParentLoop(HandledPathConflict):
770
 
    """An attempt to create an infinitely-looping directory structure.
771
 
    This is rare, but can be produced like so:
772
 
 
773
 
    tree A:
774
 
      mv foo bar
775
 
    tree B:
776
 
      mv bar foo
777
 
    merge A and B
778
 
    """
779
 
 
780
 
    typestring = 'parent loop'
781
 
 
782
 
    format = 'Conflict moving %(path)s into %(conflict_path)s. %(action)s.'
783
 
 
784
 
    def action_take_this(self, tree):
785
 
        # just acccept brz proposal
786
 
        pass
787
 
 
788
 
    def action_take_other(self, tree):
789
 
        tt = transform.TreeTransform(tree)
790
 
        try:
791
 
            p_tid = tt.trans_id_file_id(self.file_id)
792
 
            parent_tid = tt.get_tree_parent(p_tid)
793
 
            cp_tid = tt.trans_id_file_id(self.conflict_file_id)
794
 
            cparent_tid = tt.get_tree_parent(cp_tid)
795
 
            tt.adjust_path(osutils.basename(self.path), cparent_tid, cp_tid)
796
 
            tt.adjust_path(osutils.basename(self.conflict_path),
797
 
                           parent_tid, p_tid)
798
 
            tt.apply()
799
 
        finally:
800
 
            tt.finalize()
801
 
 
802
 
 
803
 
class UnversionedParent(HandledConflict):
804
 
    """An attempt to version a file whose parent directory is not versioned.
805
 
    Typically, the result of a merge where one tree unversioned the directory
806
 
    and the other added a versioned file to it.
807
 
    """
808
 
 
809
 
    typestring = 'unversioned parent'
810
 
 
811
 
    format = 'Conflict because %(path)s is not versioned, but has versioned'\
812
 
             ' children.  %(action)s.'
813
 
 
814
 
    # FIXME: We silently do nothing to make tests pass, but most probably the
815
 
    # conflict shouldn't exist (the long story is that the conflict is
816
 
    # generated with another one that can be resolved properly) -- vila 091224
817
 
    def action_take_this(self, tree):
818
 
        pass
819
 
 
820
 
    def action_take_other(self, tree):
821
 
        pass
822
 
 
823
 
 
824
 
class MissingParent(HandledConflict):
825
 
    """An attempt to add files to a directory that is not present.
826
 
    Typically, the result of a merge where THIS deleted the directory and
827
 
    the OTHER added a file to it.
828
 
    See also: DeletingParent (same situation, THIS and OTHER reversed)
829
 
    """
830
 
 
831
 
    typestring = 'missing parent'
832
 
 
833
 
    format = 'Conflict adding files to %(path)s.  %(action)s.'
834
 
 
835
 
    def action_take_this(self, tree):
836
 
        tree.remove([self.path], force=True, keep_files=False)
837
 
 
838
 
    def action_take_other(self, tree):
839
 
        # just acccept brz proposal
840
 
        pass
841
 
 
842
 
 
843
 
class DeletingParent(HandledConflict):
844
 
    """An attempt to add files to a directory that is not present.
845
 
    Typically, the result of a merge where one OTHER deleted the directory and
846
 
    the THIS added a file to it.
847
 
    """
848
 
 
849
 
    typestring = 'deleting parent'
850
 
 
851
 
    format = "Conflict: can't delete %(path)s because it is not empty.  "\
852
 
             "%(action)s."
853
 
 
854
 
    # FIXME: It's a bit strange that the default action is not coherent with
855
 
    # MissingParent from the *user* pov.
856
 
 
857
 
    def action_take_this(self, tree):
858
 
        # just acccept brz proposal
859
 
        pass
860
 
 
861
 
    def action_take_other(self, tree):
862
 
        tree.remove([self.path], force=True, keep_files=False)
863
 
 
864
 
 
865
 
class NonDirectoryParent(HandledConflict):
866
 
    """An attempt to add files to a directory that is not a directory or
867
 
    an attempt to change the kind of a directory with files.
868
 
    """
869
 
 
870
 
    typestring = 'non-directory parent'
871
 
 
872
 
    format = "Conflict: %(path)s is not a directory, but has files in it."\
873
 
             "  %(action)s."
874
 
 
875
 
    # FIXME: .OTHER should be used instead of .new when the conflict is created
876
 
 
877
 
    def action_take_this(self, tree):
878
 
        # FIXME: we should preserve that path when the conflict is generated !
879
 
        if self.path.endswith('.new'):
880
 
            conflict_path = self.path[:-(len('.new'))]
881
 
            tree.remove([self.path], force=True, keep_files=False)
882
 
            tree.add(conflict_path)
883
 
        else:
884
 
            raise NotImplementedError(self.action_take_this)
885
 
 
886
 
    def action_take_other(self, tree):
887
 
        # FIXME: we should preserve that path when the conflict is generated !
888
 
        if self.path.endswith('.new'):
889
 
            conflict_path = self.path[:-(len('.new'))]
890
 
            tree.remove([conflict_path], force=True, keep_files=False)
891
 
            tree.rename_one(self.path, conflict_path)
892
 
        else:
893
 
            raise NotImplementedError(self.action_take_other)
894
 
 
895
 
 
896
 
ctype = {}
897
 
 
898
 
 
899
 
def register_types(*conflict_types):
900
 
    """Register a Conflict subclass for serialization purposes"""
901
 
    global ctype
902
 
    for conflict_type in conflict_types:
903
 
        ctype[conflict_type.typestring] = conflict_type
904
 
 
905
 
 
906
 
register_types(ContentsConflict, TextConflict, PathConflict, DuplicateID,
907
 
               DuplicateEntry, ParentLoop, UnversionedParent, MissingParent,
908
 
               DeletingParent, NonDirectoryParent)
 
332
    def do(self, action, tree):
 
333
        """Apply the specified action to the conflict.
 
334
 
 
335
        :param action: The method name to call.
 
336
 
 
337
        :param tree: The tree passed as a parameter to the method.
 
338
        """
 
339
        raise NotImplementedError(self.do)
 
340
 
 
341
    def describe(self):
 
342
        """Return a string description of this conflict."""
 
343
        raise NotImplementedError(self.describe)