1
# Copyright (C) 2005, 2006, 2007, 2009, 2010 Canonical Ltd
1
# Copyright (C) 2005, 2007 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
17
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,
117
resolve(tree, file_list)
120
def resolve(tree, paths=None, ignore_misses=False, recursive=False):
163
121
"""Resolve some or all of the conflicts in a working tree.
165
123
:param paths: If None, resolve all conflicts. Otherwise, select only
169
127
recursive commands like revert, this should be True. For commands
170
128
or applications wishing finer-grained control, like the resolve
171
129
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,
130
:ignore_misses: If False, warnings will be printed if the supplied paths
131
do not have conflicts.
176
133
tree.lock_tree_write()
178
135
tree_conflicts = tree.conflicts()
179
136
if paths is None:
180
137
new_conflicts = ConflictList()
181
to_process = tree_conflicts
138
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)
140
new_conflicts, selected_conflicts = \
141
tree_conflicts.select_conflicts(tree, paths, ignore_misses,
192
144
tree.set_conflicts(new_conflicts)
193
145
except errors.UnsupportedOperation:
147
selected_conflicts.remove_files(tree)
199
152
def restore(filename):
200
"""Restore a conflicted file to the state it was in before merging.
202
Only text restoration is supported at present.
154
Restore a conflicted file to the state it was in before merging.
155
Only text restoration supported at present.
204
157
conflicted = False
286
239
for conflict in self:
287
240
if not conflict.has_files:
289
conflict.cleanup(tree)
242
for suffix in CONFLICT_SUFFIXES:
244
osutils.delete_any(tree.abspath(conflict.path+suffix))
246
if e.errno != errno.ENOENT:
291
249
def select_conflicts(self, tree, paths, ignore_misses=False,
401
358
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 associated_filenames(self):
416
"""The names of the files generated to help resolve the conflict."""
417
raise NotImplementedError(self.associated_filenames)
419
def cleanup(self, tree):
420
for fname in self.associated_filenames():
422
osutils.delete_any(tree.abspath(fname))
424
if e.errno != errno.ENOENT:
427
def action_done(self, tree):
428
"""Mark the conflict as solved once it has been handled."""
429
# This method does nothing but simplifies the design of upper levels.
432
def action_take_this(self, tree):
433
raise NotImplementedError(self.action_take_this)
435
def action_take_other(self, tree):
436
raise NotImplementedError(self.action_take_other)
439
361
class PathConflict(Conflict):
440
362
"""A conflict was encountered merging file paths"""
444
366
format = 'Path conflict: %(path)s / %(conflict_path)s'
446
368
rformat = '%(class)s(%(path)r, %(conflict_path)r, %(file_id)r)'
448
369
def __init__(self, path, conflict_path=None, file_id=None):
449
370
Conflict.__init__(self, path, file_id)
450
371
self.conflict_path = conflict_path
455
376
s.add('conflict_path', self.conflict_path)
458
def associated_filenames(self):
459
# No additional files have been generated here
462
def action_take_this(self, tree):
463
tree.rename_one(self.conflict_path, self.path)
465
def action_take_other(self, tree):
466
# just acccept bzr proposal
470
380
class ContentsConflict(PathConflict):
471
381
"""The files are of different types, or not present"""
477
387
format = 'Contents conflict in %(path)s'
479
def associated_filenames(self):
480
return [self.path + suffix for suffix in ('.BASE', '.OTHER')]
482
# FIXME: I smell something weird here and it seems we should be able to be
483
# more coherent with some other conflict ? bzr *did* a choice there but
484
# neither action_take_this nor action_take_other reflect that...
486
def action_take_this(self, tree):
487
tree.remove([self.path + '.OTHER'], force=True, keep_files=False)
489
def action_take_other(self, tree):
490
tree.remove([self.path], force=True, keep_files=False)
494
# FIXME: TextConflict is about a single file-id, there never is a conflict_path
495
# attribute so we shouldn't inherit from PathConflict but simply from Conflict
497
# TODO: There should be a base revid attribute to better inform the user about
498
# how the conflicts were generated.
499
390
class TextConflict(PathConflict):
500
391
"""The merge algorithm could not resolve all differences encountered."""
506
397
format = 'Text conflict in %(path)s'
508
def associated_filenames(self):
509
return [self.path + suffix for suffix in CONFLICT_SUFFIXES]
512
400
class HandledConflict(Conflict):
513
401
"""A path problem that has been provisionally resolved.
528
416
s.add('action', self.action)
531
def associated_filenames(self):
532
# Nothing has been generated here
536
420
class HandledPathConflict(HandledConflict):
537
421
"""A provisionally-resolved path problem involving two paths.
579
463
format = 'Conflict adding file %(conflict_path)s. %(action)s %(path)s.'
581
def action_take_this(self, tree):
582
tree.remove([self.conflict_path], force=True, keep_files=False)
583
tree.rename_one(self.path, self.conflict_path)
585
def action_take_other(self, tree):
586
tree.remove([self.path], force=True, keep_files=False)
589
466
class ParentLoop(HandledPathConflict):
590
467
"""An attempt to create an infinitely-looping directory structure.
591
468
This is rare, but can be produced like so:
602
479
format = 'Conflict moving %(conflict_path)s into %(path)s. %(action)s.'
604
def action_take_this(self, tree):
605
# just acccept bzr proposal
608
def action_take_other(self, tree):
609
# FIXME: We shouldn't have to manipulate so many paths here (and there
610
# is probably a bug or two...)
611
base_path = osutils.basename(self.path)
612
conflict_base_path = osutils.basename(self.conflict_path)
613
tt = transform.TreeTransform(tree)
615
p_tid = tt.trans_id_file_id(self.file_id)
616
parent_tid = tt.get_tree_parent(p_tid)
617
cp_tid = tt.trans_id_file_id(self.conflict_file_id)
618
cparent_tid = tt.get_tree_parent(cp_tid)
619
tt.adjust_path(base_path, cparent_tid, cp_tid)
620
tt.adjust_path(conflict_base_path, parent_tid, p_tid)
626
482
class UnversionedParent(HandledConflict):
627
"""An attempt to version a file whose parent directory is not versioned.
483
"""An attempt to version an file whose parent directory is not versioned.
628
484
Typically, the result of a merge where one tree unversioned the directory
629
485
and the other added a versioned file to it.
634
490
format = 'Conflict because %(path)s is not versioned, but has versioned'\
635
491
' children. %(action)s.'
637
# FIXME: We silently do nothing to make tests pass, but most probably the
638
# conflict shouldn't exist (the long story is that the conflict is
639
# generated with another one that can be resolved properly) -- vila 091224
640
def action_take_this(self, tree):
643
def action_take_other(self, tree):
647
494
class MissingParent(HandledConflict):
648
495
"""An attempt to add files to a directory that is not present.
649
496
Typically, the result of a merge where THIS deleted the directory and
650
497
the OTHER added a file to it.
651
See also: DeletingParent (same situation, THIS and OTHER reversed)
498
See also: DeletingParent (same situation, reversed THIS and OTHER)
654
501
typestring = 'missing parent'
656
503
format = 'Conflict adding files to %(path)s. %(action)s.'
658
def action_take_this(self, tree):
659
tree.remove([self.path], force=True, keep_files=False)
661
def action_take_other(self, tree):
662
# just acccept bzr proposal
666
506
class DeletingParent(HandledConflict):
667
507
"""An attempt to add files to a directory that is not present.
674
514
format = "Conflict: can't delete %(path)s because it is not empty. "\
677
# FIXME: It's a bit strange that the default action is not coherent with
678
# MissingParent from the *user* pov.
680
def action_take_this(self, tree):
681
# just acccept bzr proposal
684
def action_take_other(self, tree):
685
tree.remove([self.path], force=True, keep_files=False)
688
518
class NonDirectoryParent(HandledConflict):
689
"""An attempt to add files to a directory that is not a directory or
519
"""An attempt to add files to a directory that is not a director or
690
520
an attempt to change the kind of a directory with files.
695
525
format = "Conflict: %(path)s is not a directory, but has files in it."\
698
# FIXME: .OTHER should be used instead of .new when the conflict is created
700
def action_take_this(self, tree):
701
# FIXME: we should preserve that path when the conflict is generated !
702
if self.path.endswith('.new'):
703
conflict_path = self.path[:-(len('.new'))]
704
tree.remove([self.path], force=True, keep_files=False)
705
tree.add(conflict_path)
707
raise NotImplementedError(self.action_take_this)
709
def action_take_other(self, tree):
710
# FIXME: we should preserve that path when the conflict is generated !
711
if self.path.endswith('.new'):
712
conflict_path = self.path[:-(len('.new'))]
713
tree.remove([conflict_path], force=True, keep_files=False)
714
tree.rename_one(self.path, conflict_path)
716
raise NotImplementedError(self.action_take_other)
725
534
for conflict_type in conflict_types:
726
535
ctype[conflict_type.typestring] = conflict_type
728
538
register_types(ContentsConflict, TextConflict, PathConflict, DuplicateID,
729
539
DuplicateEntry, ParentLoop, UnversionedParent, MissingParent,
730
540
DeletingParent, NonDirectoryParent)
added
removed
bzrlib/conflicts.py
