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
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
17
# TODO: Move this into builtins
19
# TODO: 'bzr resolve' should accept a directory name and work from that
23
24
from bzrlib.lazy_import import lazy_import
24
25
lazy_import(globals(), """
57
53
instead. (This is useful for editing all files with text conflicts.)
59
55
Use bzr resolve when you have fixed a problem.
63
help='List paths of files with text conflicts.'),
61
help='List paths of files with text conflicts.'),
65
_see_also = ['resolve', 'conflict-types']
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():
71
69
if conflict.typestring != 'text conflict':
75
73
self.outf.write(str(conflict) + '\n')
78
resolve_action_registry = registry.Registry()
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'
91
class ResolveActionOption(option.RegistryOption):
94
super(ResolveActionOption, self).__init__(
95
'action', 'How to resolve the conflict.',
97
registry=resolve_action_registry)
100
76
class cmd_resolve(commands.Command):
101
77
"""Mark a conflict as resolved.
106
82
before you should commit.
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.
88
See also bzr conflicts.
112
90
aliases = ['resolved']
113
91
takes_args = ['file*']
115
option.Option('all', help='Resolve all conflicts in this tree.'),
116
ResolveActionOption(),
93
Option('all', help='Resolve all conflicts in this tree.'),
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
122
99
raise errors.BzrCommandError("If --all is specified,"
123
100
" no FILE may be provided")
124
tree = workingtree.WorkingTree.open_containing('.')[0]
101
tree = WorkingTree.open_containing('.')[0]
128
104
tree, file_list = builtins.tree_files(file_list)
129
105
if file_list 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
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.')
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
158
resolve(tree, file_list, action=action)
161
def resolve(tree, paths=None, ignore_misses=False, recursive=False,
163
"""Resolve some or all of the conflicts in a working tree.
165
:param paths: If None, resolve all conflicts. Otherwise, select only
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,
117
resolve(tree, file_list)
120
def resolve(tree, paths=None, ignore_misses=False):
176
121
tree.lock_tree_write()
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
183
new_conflicts, to_process = tree_conflicts.select_conflicts(
184
tree, paths, ignore_misses, recursive)
185
for conflict in to_process:
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)
192
131
tree.set_conflicts(new_conflicts)
193
132
except errors.UnsupportedOperation:
134
selected_conflicts.remove_files(tree)
199
139
def restore(filename):
200
"""Restore a conflicted file to the state it was in before merging.
202
Only text restoration is supported at present.
141
Restore a conflicted file to the state it was in before merging.
142
Only text restoration supported at present.
204
144
conflicted = False
286
226
for conflict in self:
287
227
if not conflict.has_files:
289
conflict.cleanup(tree)
229
for suffix in CONFLICT_SUFFIXES:
231
osutils.delete_any(tree.abspath(conflict.path+suffix))
233
if e.errno != errno.ENOENT:
291
236
def select_conflicts(self, tree, paths, ignore_misses=False,
293
238
"""Select the conflicts associated with paths in a tree.
295
240
File-ids are also used for this.
296
241
:return: a pair of ConflictLists: (not_selected, selected)
341
286
print "%s is not conflicted" % path
342
287
return new_conflicts, selected_conflicts
345
290
class Conflict(object):
346
291
"""Base class for all types of conflict"""
348
# FIXME: cleanup should take care of that ? -- vila 091229
349
293
has_files = False
351
295
def __init__(self, path, file_id=None):
401
345
return None, conflict.typestring
403
def _do(self, action, tree):
404
"""Apply the specified action to the conflict.
406
:param action: The method name to call.
408
:param tree: The tree passed as a parameter to the method.
410
meth = getattr(self, 'action_%s' % action, None)
412
raise NotImplementedError(self.__class__.__name__ + '.' + action)
415
def cleanup(self, tree):
416
raise NotImplementedError(self.cleanup)
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.
423
def action_take_this(self, tree):
424
raise NotImplementedError(self.action_take_this)
426
def action_take_other(self, tree):
427
raise NotImplementedError(self.action_take_other)
430
348
class PathConflict(Conflict):
431
349
"""A conflict was encountered merging file paths"""
435
353
format = 'Path conflict: %(path)s / %(conflict_path)s'
437
355
rformat = '%(class)s(%(path)r, %(conflict_path)r, %(file_id)r)'
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)
449
def cleanup(self, tree):
450
# No additional files have been generated here
453
def action_take_this(self, tree):
454
tree.rename_one(self.conflict_path, self.path)
456
def action_take_other(self, tree):
457
# just acccept bzr proposal
461
367
class ContentsConflict(PathConflict):
462
368
"""The files are of different types, or not present"""
468
374
format = 'Contents conflict in %(path)s'
470
def cleanup(self, tree):
471
for suffix in ('.BASE', '.OTHER'):
473
osutils.delete_any(tree.abspath(self.path + suffix))
475
if e.errno != errno.ENOENT:
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...
482
def action_take_this(self, tree):
483
tree.remove([self.path + '.OTHER'], force=True, keep_files=False)
485
def action_take_other(self, tree):
486
tree.remove([self.path], force=True, keep_files=False)
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
493
# TODO: There should be a base revid attribute to better inform the user about
494
# how the conflicts were generated.
495
377
class TextConflict(PathConflict):
496
378
"""The merge algorithm could not resolve all differences encountered."""
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,
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]
558
428
def as_stanza(self):
580
450
format = 'Conflict adding file %(conflict_path)s. %(action)s %(path)s.'
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)
586
def action_take_other(self, tree):
587
tree.remove([self.path], force=True, keep_files=False)
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:
603
466
format = 'Conflict moving %(conflict_path)s into %(path)s. %(action)s.'
605
def action_take_this(self, tree):
606
# just acccept bzr proposal
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)
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)
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.
635
477
format = 'Conflict because %(path)s is not versioned, but has versioned'\
636
478
' children. %(action)s.'
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):
644
def action_take_other(self, tree):
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)
655
488
typestring = 'missing parent'
657
490
format = 'Conflict adding files to %(path)s. %(action)s.'
659
def action_take_this(self, tree):
660
tree.remove([self.path], force=True, keep_files=False)
662
def action_take_other(self, tree):
663
# just acccept bzr proposal
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. "\
678
# FIXME: It's a bit strange that the default action is not coherent with
679
# MissingParent from the *user* pov.
681
def action_take_this(self, tree):
682
# just acccept bzr proposal
685
def action_take_other(self, tree):
686
tree.remove([self.path], force=True, keep_files=False)
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.
694
typestring = 'non-directory parent'
696
format = "Conflict: %(path)s is not a directory, but has files in it."\
699
# FIXME: .OTHER should be used instead of .new when the conflict is created
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)
708
raise NotImplementedError(self.action_take_this)
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)
717
raise NotImplementedError(self.action_take_other)
726
511
for conflict_type in conflict_types:
727
512
ctype[conflict_type.typestring] = conflict_type
729
515
register_types(ContentsConflict, TextConflict, PathConflict, DuplicateID,
730
516
DuplicateEntry, ParentLoop, UnversionedParent, MissingParent,
731
DeletingParent, NonDirectoryParent)