1
# Copyright (C) 2005, 2007 Canonical Ltd
1
# Copyright (C) 2005, 2006, 2007, 2009, 2010 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
# TODO: Move this into builtins
19
17
# TODO: 'bzr resolve' should accept a directory name and work from that
24
23
from bzrlib.lazy_import import lazy_import
25
24
lazy_import(globals(), """
55
60
Use bzr resolve when you have fixed a problem.
59
help='List paths of files with text conflicts.'),
64
help='List paths of files with text conflicts.'),
61
_see_also = ['resolve']
66
_see_also = ['resolve', 'conflict-types']
63
68
def run(self, text=False):
64
from bzrlib.workingtree import WorkingTree
65
wt = WorkingTree.open_containing(u'.')[0]
69
wt = workingtree.WorkingTree.open_containing(u'.')[0]
66
70
for conflict in wt.conflicts():
68
72
if conflict.typestring != 'text conflict':
72
76
self.outf.write(str(conflict) + '\n')
79
resolve_action_registry = registry.Registry()
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'
92
class ResolveActionOption(option.RegistryOption):
95
super(ResolveActionOption, self).__init__(
96
'action', 'How to resolve the conflict.',
98
registry=resolve_action_registry)
75
101
class cmd_resolve(commands.Command):
76
102
"""Mark a conflict as resolved.
87
113
aliases = ['resolved']
88
114
takes_args = ['file*']
90
Option('all', help='Resolve all conflicts in this tree.'),
116
option.Option('all', help='Resolve all conflicts in this tree.'),
117
ResolveActionOption(),
92
119
_see_also = ['conflicts']
93
def run(self, file_list=None, all=False):
94
from bzrlib.workingtree import WorkingTree
120
def run(self, file_list=None, all=False, action=None):
97
123
raise errors.BzrCommandError("If --all is specified,"
98
124
" no FILE may be provided")
99
tree = WorkingTree.open_containing('.')[0]
125
tree = workingtree.WorkingTree.open_containing('.')[0]
102
129
tree, file_list = builtins.tree_files(file_list)
103
130
if file_list is None:
132
# FIXME: There is a special case here related to the option
133
# handling that could be clearer and easier to discover by
134
# providing an --auto action (bug #344013 and #383396) and
135
# make it mandatory instead of implicit and active only
136
# when no file_list is provided -- vila 091229
142
if file_list is None:
104
143
un_resolved, resolved = tree.auto_resolve()
105
144
if len(un_resolved) > 0:
106
145
trace.note('%d conflict(s) auto-resolved.', len(resolved))
112
151
trace.note('All conflicts resolved.')
115
resolve(tree, file_list)
118
def resolve(tree, paths=None, ignore_misses=False, recursive=False):
154
# FIXME: This can never occur but the block above needs some
155
# refactoring to transfer tree.auto_resolve() to
156
# conflict.auto(tree) --vila 091242
159
resolve(tree, file_list, action=action)
162
def resolve(tree, paths=None, ignore_misses=False, recursive=False,
119
164
"""Resolve some or all of the conflicts in a working tree.
121
166
:param paths: If None, resolve all conflicts. Otherwise, select only
125
170
recursive commands like revert, this should be True. For commands
126
171
or applications wishing finer-grained control, like the resolve
127
172
command, this should be False.
128
:ignore_misses: If False, warnings will be printed if the supplied paths
129
do not have conflicts.
173
:param ignore_misses: If False, warnings will be printed if the supplied
174
paths do not have conflicts.
175
:param action: How the conflict should be resolved,
131
177
tree.lock_tree_write()
133
179
tree_conflicts = tree.conflicts()
134
180
if paths is None:
135
181
new_conflicts = ConflictList()
136
selected_conflicts = tree_conflicts
182
to_process = tree_conflicts
138
new_conflicts, selected_conflicts = \
139
tree_conflicts.select_conflicts(tree, paths, ignore_misses,
184
new_conflicts, to_process = tree_conflicts.select_conflicts(
185
tree, paths, ignore_misses, recursive)
186
for conflict in to_process:
188
conflict._do(action, tree)
189
conflict.cleanup(tree)
190
except NotImplementedError:
191
new_conflicts.append(conflict)
142
193
tree.set_conflicts(new_conflicts)
143
194
except errors.UnsupportedOperation:
145
selected_conflicts.remove_files(tree)
150
200
def restore(filename):
152
Restore a conflicted file to the state it was in before merging.
153
Only text restoration supported at present.
201
"""Restore a conflicted file to the state it was in before merging.
203
Only text restoration is supported at present.
155
205
conflicted = False
237
287
for conflict in self:
238
288
if not conflict.has_files:
240
for suffix in CONFLICT_SUFFIXES:
242
osutils.delete_any(tree.abspath(conflict.path+suffix))
244
if e.errno != errno.ENOENT:
290
conflict.cleanup(tree)
247
292
def select_conflicts(self, tree, paths, ignore_misses=False,
356
402
return None, conflict.typestring
404
def _do(self, action, tree):
405
"""Apply the specified action to the conflict.
407
:param action: The method name to call.
409
:param tree: The tree passed as a parameter to the method.
411
meth = getattr(self, 'action_%s' % action, None)
413
raise NotImplementedError(self.__class__.__name__ + '.' + action)
416
def associated_filenames(self):
417
"""The names of the files generated to help resolve the conflict."""
418
raise NotImplementedError(self.associated_filenames)
420
def cleanup(self, tree):
421
for fname in self.associated_filenames():
423
osutils.delete_any(tree.abspath(fname))
425
if e.errno != errno.ENOENT:
428
def action_done(self, tree):
429
"""Mark the conflict as solved once it has been handled."""
430
# This method does nothing but simplifies the design of upper levels.
433
def action_take_this(self, tree):
434
raise NotImplementedError(self.action_take_this)
436
def action_take_other(self, tree):
437
raise NotImplementedError(self.action_take_other)
359
440
class PathConflict(Conflict):
360
441
"""A conflict was encountered merging file paths"""
364
445
format = 'Path conflict: %(path)s / %(conflict_path)s'
366
447
rformat = '%(class)s(%(path)r, %(conflict_path)r, %(file_id)r)'
367
449
def __init__(self, path, conflict_path=None, file_id=None):
368
450
Conflict.__init__(self, path, file_id)
369
451
self.conflict_path = conflict_path
374
456
s.add('conflict_path', self.conflict_path)
459
def associated_filenames(self):
460
# No additional files have been generated here
463
def action_take_this(self, tree):
464
tree.rename_one(self.conflict_path, self.path)
466
def action_take_other(self, tree):
467
# just acccept bzr proposal
378
471
class ContentsConflict(PathConflict):
379
472
"""The files are of different types, or not present"""
385
478
format = 'Contents conflict in %(path)s'
480
def associated_filenames(self):
481
return [self.path + suffix for suffix in ('.BASE', '.OTHER')]
483
def _take_it(self, tt, suffix_to_remove):
484
"""Resolve the conflict.
486
:param tt: The TreeTransform where the conflict is resolved.
487
:param suffix_to_remove: Either 'THIS' or 'OTHER'
489
The resolution is symmetric, when taking THIS, OTHER is deleted and
490
item.THIS is renamed into item and vice-versa.
493
# Delete 'item.THIS' or 'item.OTHER' depending on
496
tt.trans_id_tree_path(self.path + '.' + suffix_to_remove))
497
except errors.NoSuchFile:
498
# There are valid cases where 'item.suffix_to_remove' either
499
# never existed or was already deleted (including the case
500
# where the user deleted it)
502
# Rename 'item.suffix_to_remove' (note that if
503
# 'item.suffix_to_remove' has been deleted, this is a no-op)
504
this_tid = tt.trans_id_file_id(self.file_id)
505
parent_tid = tt.get_tree_parent(this_tid)
506
tt.adjust_path(self.path, parent_tid, this_tid)
509
def _take_it_with_cleanups(self, tree, suffix_to_remove):
510
tt = transform.TreeTransform(tree)
511
op = cleanup.OperationWithCleanups(self._take_it)
512
op.add_cleanup(tt.finalize)
513
op.run_simple(tt, suffix_to_remove)
515
def action_take_this(self, tree):
516
self._take_it_with_cleanups(tree, 'OTHER')
518
def action_take_other(self, tree):
519
self._take_it_with_cleanups(tree, 'THIS')
522
# FIXME: TextConflict is about a single file-id, there never is a conflict_path
523
# attribute so we shouldn't inherit from PathConflict but simply from Conflict
525
# TODO: There should be a base revid attribute to better inform the user about
526
# how the conflicts were generated.
388
527
class TextConflict(PathConflict):
389
528
"""The merge algorithm could not resolve all differences encountered."""
395
534
format = 'Text conflict in %(path)s'
536
def associated_filenames(self):
537
return [self.path + suffix for suffix in CONFLICT_SUFFIXES]
398
540
class HandledConflict(Conflict):
399
541
"""A path problem that has been provisionally resolved.
414
556
s.add('action', self.action)
559
def associated_filenames(self):
560
# Nothing has been generated here
418
564
class HandledPathConflict(HandledConflict):
419
565
"""A provisionally-resolved path problem involving two paths.
461
607
format = 'Conflict adding file %(conflict_path)s. %(action)s %(path)s.'
609
def action_take_this(self, tree):
610
tree.remove([self.conflict_path], force=True, keep_files=False)
611
tree.rename_one(self.path, self.conflict_path)
613
def action_take_other(self, tree):
614
tree.remove([self.path], force=True, keep_files=False)
464
617
class ParentLoop(HandledPathConflict):
465
618
"""An attempt to create an infinitely-looping directory structure.
466
619
This is rare, but can be produced like so:
477
630
format = 'Conflict moving %(conflict_path)s into %(path)s. %(action)s.'
632
def action_take_this(self, tree):
633
# just acccept bzr proposal
636
def action_take_other(self, tree):
637
# FIXME: We shouldn't have to manipulate so many paths here (and there
638
# is probably a bug or two...)
639
base_path = osutils.basename(self.path)
640
conflict_base_path = osutils.basename(self.conflict_path)
641
tt = transform.TreeTransform(tree)
643
p_tid = tt.trans_id_file_id(self.file_id)
644
parent_tid = tt.get_tree_parent(p_tid)
645
cp_tid = tt.trans_id_file_id(self.conflict_file_id)
646
cparent_tid = tt.get_tree_parent(cp_tid)
647
tt.adjust_path(base_path, cparent_tid, cp_tid)
648
tt.adjust_path(conflict_base_path, parent_tid, p_tid)
480
654
class UnversionedParent(HandledConflict):
481
"""An attempt to version an file whose parent directory is not versioned.
655
"""An attempt to version a file whose parent directory is not versioned.
482
656
Typically, the result of a merge where one tree unversioned the directory
483
657
and the other added a versioned file to it.
488
662
format = 'Conflict because %(path)s is not versioned, but has versioned'\
489
663
' children. %(action)s.'
665
# FIXME: We silently do nothing to make tests pass, but most probably the
666
# conflict shouldn't exist (the long story is that the conflict is
667
# generated with another one that can be resolved properly) -- vila 091224
668
def action_take_this(self, tree):
671
def action_take_other(self, tree):
492
675
class MissingParent(HandledConflict):
493
676
"""An attempt to add files to a directory that is not present.
494
677
Typically, the result of a merge where THIS deleted the directory and
495
678
the OTHER added a file to it.
496
See also: DeletingParent (same situation, reversed THIS and OTHER)
679
See also: DeletingParent (same situation, THIS and OTHER reversed)
499
682
typestring = 'missing parent'
501
684
format = 'Conflict adding files to %(path)s. %(action)s.'
686
def action_take_this(self, tree):
687
tree.remove([self.path], force=True, keep_files=False)
689
def action_take_other(self, tree):
690
# just acccept bzr proposal
504
694
class DeletingParent(HandledConflict):
505
695
"""An attempt to add files to a directory that is not present.
512
702
format = "Conflict: can't delete %(path)s because it is not empty. "\
705
# FIXME: It's a bit strange that the default action is not coherent with
706
# MissingParent from the *user* pov.
708
def action_take_this(self, tree):
709
# just acccept bzr proposal
712
def action_take_other(self, tree):
713
tree.remove([self.path], force=True, keep_files=False)
516
716
class NonDirectoryParent(HandledConflict):
517
"""An attempt to add files to a directory that is not a director or
717
"""An attempt to add files to a directory that is not a directory or
518
718
an attempt to change the kind of a directory with files.
523
723
format = "Conflict: %(path)s is not a directory, but has files in it."\
726
# FIXME: .OTHER should be used instead of .new when the conflict is created
728
def action_take_this(self, tree):
729
# FIXME: we should preserve that path when the conflict is generated !
730
if self.path.endswith('.new'):
731
conflict_path = self.path[:-(len('.new'))]
732
tree.remove([self.path], force=True, keep_files=False)
733
tree.add(conflict_path)
735
raise NotImplementedError(self.action_take_this)
737
def action_take_other(self, tree):
738
# FIXME: we should preserve that path when the conflict is generated !
739
if self.path.endswith('.new'):
740
conflict_path = self.path[:-(len('.new'))]
741
tree.remove([conflict_path], force=True, keep_files=False)
742
tree.rename_one(self.path, conflict_path)
744
raise NotImplementedError(self.action_take_other)
532
753
for conflict_type in conflict_types:
533
754
ctype[conflict_type.typestring] = conflict_type
536
756
register_types(ContentsConflict, TextConflict, PathConflict, DuplicateID,
537
757
DuplicateEntry, ParentLoop, UnversionedParent, MissingParent,
538
758
DeletingParent, NonDirectoryParent)
added
removed
bzrlib/conflicts.py
