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
19
from .lazy_import import lazy_import
20
lazy_import(globals(), """
24
branch as _mod_branch,
25
conflicts as _mod_conflicts,
19
from itertools import chain
27
26
graph as _mod_graph,
30
30
revision as _mod_revision,
38
from breezy.bzr import (
42
from breezy.i18n import gettext
34
from bzrlib.branch import Branch
35
from bzrlib.conflicts import ConflictList, Conflict
36
from bzrlib.errors import (BzrCommandError,
46
WorkingTreeNotRevision,
49
from bzrlib.graph import Graph
50
from bzrlib.merge3 import Merge3
51
from bzrlib.osutils import rename, pathjoin
52
from progress import DummyProgress, ProgressPhase
53
from bzrlib.revision import (NULL_REVISION, ensure_null)
54
from bzrlib.textfile import check_text_lines
55
from bzrlib.trace import mutter, warning, note, is_quiet
56
from bzrlib.transform import (TransformPreview, TreeTransform,
57
resolve_conflicts, cook_conflicts,
58
conflict_pass, FinalPaths, create_from_tree,
59
unique_add, ROOT_PARENT)
60
from bzrlib.versionedfile import PlanWeaveMerge
51
63
# TODO: Report back as changes are merged in
54
def transform_tree(from_tree, to_tree, interesting_files=None):
55
with from_tree.lock_tree_write():
56
merge_inner(from_tree.branch, to_tree, from_tree,
57
ignore_zero=True, this_tree=from_tree,
58
interesting_files=interesting_files)
61
class MergeHooks(hooks.Hooks):
64
hooks.Hooks.__init__(self, "breezy.merge", "Merger.hooks")
65
self.add_hook('merge_file_content',
66
"Called with a breezy.merge.Merger object to create a per file "
67
"merge object when starting a merge. "
68
"Should return either None or a subclass of "
69
"``breezy.merge.AbstractPerFileMerger``. "
70
"Such objects will then be called per file "
71
"that needs to be merged (including when one "
72
"side has deleted the file and the other has changed it). "
73
"See the AbstractPerFileMerger API docs for details on how it is "
76
self.add_hook('pre_merge',
77
'Called before a merge. '
78
'Receives a Merger object as the single argument.',
80
self.add_hook('post_merge',
81
'Called after a merge. '
82
'Receives a Merger object as the single argument. '
83
'The return value is ignored.',
87
class AbstractPerFileMerger(object):
88
"""PerFileMerger objects are used by plugins extending merge for breezy.
90
See ``breezy.plugins.news_merge.news_merge`` for an example concrete class.
92
:ivar merger: The Merge3Merger performing the merge.
95
def __init__(self, merger):
96
"""Create a PerFileMerger for use with merger."""
99
def merge_contents(self, merge_params):
100
"""Attempt to merge the contents of a single file.
102
:param merge_params: A breezy.merge.MergeFileHookParams
103
:return: A tuple of (status, chunks), where status is one of
104
'not_applicable', 'success', 'conflicted', or 'delete'. If status
105
is 'success' or 'conflicted', then chunks should be an iterable of
106
strings for the new file contents.
108
return ('not applicable', None)
111
class PerFileMerger(AbstractPerFileMerger):
112
"""Merge individual files when self.file_matches returns True.
114
This class is intended to be subclassed. The file_matches and
115
merge_matching methods should be overridden with concrete implementations.
118
def file_matches(self, params):
119
"""Return True if merge_matching should be called on this file.
121
Only called with merges of plain files with no clear winner.
123
Subclasses must override this.
125
raise NotImplementedError(self.file_matches)
127
def merge_contents(self, params):
128
"""Merge the contents of a single file."""
129
# Check whether this custom merge logic should be used.
131
# OTHER is a straight winner, rely on default merge.
132
params.winner == 'other' or
133
# THIS and OTHER aren't both files.
134
not params.is_file_merge() or
135
# The filename doesn't match
136
not self.file_matches(params)):
137
return 'not_applicable', None
138
return self.merge_matching(params)
140
def merge_matching(self, params):
141
"""Merge the contents of a single file that has matched the criteria
142
in PerFileMerger.merge_contents (is a conflict, is a file,
143
self.file_matches is True).
145
Subclasses must override this.
147
raise NotImplementedError(self.merge_matching)
150
class ConfigurableFileMerger(PerFileMerger):
151
"""Merge individual files when configured via a .conf file.
153
This is a base class for concrete custom file merging logic. Concrete
154
classes should implement ``merge_text``.
156
See ``breezy.plugins.news_merge.news_merge`` for an example concrete class.
158
:ivar affected_files: The configured file paths to merge.
160
:cvar name_prefix: The prefix to use when looking up configuration
161
details. <name_prefix>_merge_files describes the files targeted by the
164
:cvar default_files: The default file paths to merge when no configuration
171
def __init__(self, merger):
172
super(ConfigurableFileMerger, self).__init__(merger)
173
self.affected_files = None
174
self.default_files = self.__class__.default_files or []
175
self.name_prefix = self.__class__.name_prefix
176
if self.name_prefix is None:
177
raise ValueError("name_prefix must be set.")
179
def file_matches(self, params):
180
"""Check whether the file should call the merge hook.
182
<name_prefix>_merge_files configuration variable is a list of files
183
that should use the hook.
185
affected_files = self.affected_files
186
if affected_files is None:
187
config = self.merger.this_branch.get_config()
188
# Until bzr provides a better policy for caching the config, we
189
# just add the part we're interested in to the params to avoid
190
# reading the config files repeatedly (breezy.conf, location.conf,
192
config_key = self.name_prefix + '_merge_files'
193
affected_files = config.get_user_option_as_list(config_key)
194
if affected_files is None:
195
# If nothing was specified in the config, use the default.
196
affected_files = self.default_files
197
self.affected_files = affected_files
199
filepath = params.this_path
200
if filepath in affected_files:
204
def merge_matching(self, params):
205
return self.merge_text(params)
207
def merge_text(self, params):
208
"""Merge the byte contents of a single file.
210
This is called after checking that the merge should be performed in
211
merge_contents, and it should behave as per
212
``breezy.merge.AbstractPerFileMerger.merge_contents``.
214
raise NotImplementedError(self.merge_text)
217
class MergeFileHookParams(object):
218
"""Object holding parameters passed to merge_file_content hooks.
220
There are some fields hooks can access:
222
:ivar base_path: Path in base tree
223
:ivar other_path: Path in other tree
224
:ivar this_path: Path in this tree
225
:ivar trans_id: the transform ID for the merge of this file
226
:ivar this_kind: kind of file in 'this' tree
227
:ivar other_kind: kind of file in 'other' tree
228
:ivar winner: one of 'this', 'other', 'conflict'
231
def __init__(self, merger, paths, trans_id, this_kind, other_kind,
233
self._merger = merger
235
self.base_path, self.other_path, self.this_path = paths
236
self.trans_id = trans_id
237
self.this_kind = this_kind
238
self.other_kind = other_kind
241
def is_file_merge(self):
242
"""True if this_kind and other_kind are both 'file'."""
243
return self.this_kind == 'file' and self.other_kind == 'file'
245
@decorators.cachedproperty
246
def base_lines(self):
247
"""The lines of the 'base' version of the file."""
248
return self._merger.get_lines(self._merger.base_tree, self.base_path)
250
@decorators.cachedproperty
251
def this_lines(self):
252
"""The lines of the 'this' version of the file."""
253
return self._merger.get_lines(self._merger.this_tree, self.this_path)
255
@decorators.cachedproperty
256
def other_lines(self):
257
"""The lines of the 'other' version of the file."""
258
return self._merger.get_lines(self._merger.other_tree, self.other_path)
66
def transform_tree(from_tree, to_tree, interesting_ids=None):
67
from_tree.lock_tree_write()
69
merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
70
interesting_ids=interesting_ids, this_tree=from_tree)
261
75
class Merger(object):
265
76
def __init__(self, this_branch, other_tree=None, base_tree=None,
266
this_tree=None, change_reporter=None,
77
this_tree=None, pb=None, change_reporter=None,
267
78
recurse='down', revision_graph=None):
268
79
object.__init__(self)
269
80
self.this_branch = this_branch
418
237
return self._cached_trees[revision_id]
420
239
def _get_tree(self, treespec, possible_transports=None):
240
from bzrlib import workingtree
421
241
location, revno = treespec
422
242
if revno is None:
423
243
tree = workingtree.WorkingTree.open_containing(location)[0]
424
244
return tree.branch, tree
425
branch = _mod_branch.Branch.open_containing(
426
location, possible_transports)[0]
245
branch = Branch.open_containing(location, possible_transports)[0]
428
247
revision_id = branch.last_revision()
430
249
revision_id = branch.get_rev_id(revno)
431
revision_id = _mod_revision.ensure_null(revision_id)
250
revision_id = ensure_null(revision_id)
432
251
return branch, self.revision_tree(revision_id, branch)
253
def ensure_revision_trees(self):
254
if self.this_revision_tree is None:
255
self.this_basis_tree = self.revision_tree(self.this_basis)
256
if self.this_basis == self.this_rev_id:
257
self.this_revision_tree = self.this_basis_tree
259
if self.other_rev_id is None:
260
other_basis_tree = self.revision_tree(self.other_basis)
261
if other_basis_tree.has_changes(self.other_tree):
262
raise WorkingTreeNotRevision(self.this_tree)
263
other_rev_id = self.other_basis
264
self.other_tree = other_basis_tree
266
def file_revisions(self, file_id):
267
self.ensure_revision_trees()
268
def get_id(tree, file_id):
269
revision_id = tree.inventory[file_id].revision
271
if self.this_rev_id is None:
272
if self.this_basis_tree.get_file_sha1(file_id) != \
273
self.this_tree.get_file_sha1(file_id):
274
raise WorkingTreeNotRevision(self.this_tree)
276
trees = (self.this_basis_tree, self.other_tree)
277
return [get_id(tree, file_id) for tree in trees]
279
def check_basis(self, check_clean, require_commits=True):
280
if self.this_basis is None and require_commits is True:
281
raise BzrCommandError("This branch has no commits."
282
" (perhaps you would prefer 'bzr pull')")
285
if self.this_basis != self.this_rev_id:
286
raise errors.UncommittedChanges(self.this_tree)
288
def compare_basis(self):
290
basis_tree = self.revision_tree(self.this_tree.last_revision())
291
except errors.NoSuchRevision:
292
basis_tree = self.this_tree.basis_tree()
293
if not self.this_tree.has_changes(basis_tree):
294
self.this_rev_id = self.this_basis
434
296
def set_interesting_files(self, file_list):
435
297
self.interesting_files = file_list
437
299
def set_pending(self):
438
if (not self.base_is_ancestor or not self.base_is_other_ancestor
439
or self.other_rev_id is None):
300
if not self.base_is_ancestor or not self.base_is_other_ancestor or self.other_rev_id is None:
441
302
self._add_parent()
443
304
def _add_parent(self):
444
305
new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
445
306
new_parent_trees = []
446
with contextlib.ExitStack() as stack:
447
for revision_id in new_parents:
449
tree = self.revision_tree(revision_id)
450
except errors.NoSuchRevision:
453
stack.enter_context(tree.lock_read())
454
new_parent_trees.append((revision_id, tree))
455
self.this_tree.set_parent_trees(new_parent_trees, allow_leftmost_as_ghost=True)
307
for revision_id in new_parents:
309
tree = self.revision_tree(revision_id)
310
except errors.NoSuchRevision:
314
new_parent_trees.append((revision_id, tree))
316
self.this_tree.set_parent_trees(new_parent_trees,
317
allow_leftmost_as_ghost=True)
319
for _revision_id, tree in new_parent_trees:
457
323
def set_other(self, other_revision, possible_transports=None):
458
324
"""Set the revision and tree to merge from.
510
375
target.fetch(source, revision_id)
512
377
def find_base(self):
513
revisions = [_mod_revision.ensure_null(self.this_basis),
514
_mod_revision.ensure_null(self.other_basis)]
515
if _mod_revision.NULL_REVISION in revisions:
516
self.base_rev_id = _mod_revision.NULL_REVISION
378
revisions = [ensure_null(self.this_basis),
379
ensure_null(self.other_basis)]
380
if NULL_REVISION in revisions:
381
self.base_rev_id = NULL_REVISION
517
382
self.base_tree = self.revision_tree(self.base_rev_id)
518
383
self._is_criss_cross = False
520
385
lcas = self.revision_graph.find_lca(revisions[0], revisions[1])
521
386
self._is_criss_cross = False
522
387
if len(lcas) == 0:
523
self.base_rev_id = _mod_revision.NULL_REVISION
388
self.base_rev_id = NULL_REVISION
524
389
elif len(lcas) == 1:
525
390
self.base_rev_id = list(lcas)[0]
526
else: # len(lcas) > 1
527
self._is_criss_cross = True
391
else: # len(lcas) > 1
528
392
if len(lcas) > 2:
529
393
# find_unique_lca can only handle 2 nodes, so we have to
530
394
# start back at the beginning. It is a shame to traverse
531
395
# the graph again, but better than re-implementing
532
396
# find_unique_lca.
533
397
self.base_rev_id = self.revision_graph.find_unique_lca(
534
revisions[0], revisions[1])
398
revisions[0], revisions[1])
536
400
self.base_rev_id = self.revision_graph.find_unique_lca(
538
sorted_lca_keys = self.revision_graph.find_merge_order(
540
if self.base_rev_id == _mod_revision.NULL_REVISION:
541
self.base_rev_id = sorted_lca_keys[0]
543
if self.base_rev_id == _mod_revision.NULL_REVISION:
544
raise errors.UnrelatedBranches()
402
self._is_criss_cross = True
403
if self.base_rev_id == NULL_REVISION:
404
raise UnrelatedBranches()
545
405
if self._is_criss_cross:
546
trace.warning('Warning: criss-cross merge encountered. See bzr'
547
' help criss-cross.')
548
trace.mutter('Criss-cross lcas: %r' % lcas)
549
if self.base_rev_id in lcas:
550
trace.mutter('Unable to find unique lca. '
551
'Fallback %r as best option.'
553
interesting_revision_ids = set(lcas)
554
interesting_revision_ids.add(self.base_rev_id)
406
warning('Warning: criss-cross merge encountered. See bzr'
407
' help criss-cross.')
408
mutter('Criss-cross lcas: %r' % lcas)
409
interesting_revision_ids = [self.base_rev_id]
410
interesting_revision_ids.extend(lcas)
555
411
interesting_trees = dict((t.get_revision_id(), t)
556
for t in self.this_branch.repository.revision_trees(
557
interesting_revision_ids))
412
for t in self.this_branch.repository.revision_trees(
413
interesting_revision_ids))
558
414
self._cached_trees.update(interesting_trees)
559
if self.base_rev_id in lcas:
560
self.base_tree = interesting_trees[self.base_rev_id]
562
self.base_tree = interesting_trees.pop(self.base_rev_id)
415
self.base_tree = interesting_trees.pop(self.base_rev_id)
416
sorted_lca_keys = self.revision_graph.find_merge_order(
563
418
self._lca_trees = [interesting_trees[key]
564
419
for key in sorted_lca_keys]
566
421
self.base_tree = self.revision_tree(self.base_rev_id)
567
422
self.base_is_ancestor = True
568
423
self.base_is_other_ancestor = True
569
trace.mutter('Base revid: %r' % self.base_rev_id)
424
mutter('Base revid: %r' % self.base_rev_id)
571
426
def set_base(self, base_revision):
572
427
"""Set the base revision to use for the merge.
574
429
:param base_revision: A 2-list containing a path and revision number.
576
trace.mutter("doing merge() with no base_revision specified")
431
mutter("doing merge() with no base_revision specified")
577
432
if base_revision == [None, None]:
616
470
if self._is_criss_cross and getattr(self.merge_type,
617
471
'supports_lca_trees', False):
618
472
kwargs['lca_trees'] = self._lca_trees
619
return self.merge_type(change_reporter=self.change_reporter,
473
return self.merge_type(pb=self._pb,
474
change_reporter=self.change_reporter,
622
def _do_merge_to(self):
623
merge = self.make_merger()
477
def _do_merge_to(self, merge):
624
478
if self.other_branch is not None:
625
479
self.other_branch.update_references(self.this_branch)
626
for hook in Merger.hooks['pre_merge']:
629
for hook in Merger.hooks['post_merge']:
631
481
if self.recurse == 'down':
632
for relpath in self.this_tree.iter_references():
633
sub_tree = self.this_tree.get_nested_tree(relpath)
482
for relpath, file_id in self.this_tree.iter_references():
483
sub_tree = self.this_tree.get_nested_tree(file_id, relpath)
634
484
other_revision = self.other_tree.get_reference_revision(
636
if other_revision == sub_tree.last_revision():
486
if other_revision == sub_tree.last_revision():
638
488
sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
639
489
sub_merge.merge_type = self.merge_type
640
other_branch = self.other_tree.reference_parent(relpath)
490
other_branch = self.other_branch.reference_parent(file_id, relpath)
641
491
sub_merge.set_other_revision(other_revision, other_branch)
642
base_tree_path = _mod_tree.find_previous_path(
643
self.this_tree, self.base_tree, relpath)
644
base_revision = self.base_tree.get_reference_revision(
492
base_revision = self.base_tree.get_reference_revision(file_id)
646
493
sub_merge.base_tree = \
647
494
sub_tree.branch.repository.revision_tree(base_revision)
648
495
sub_merge.base_rev_id = base_revision
649
496
sub_merge.do_merge()
652
498
def do_merge(self):
653
with contextlib.ExitStack() as stack:
654
stack.enter_context(self.this_tree.lock_tree_write())
499
self.this_tree.lock_tree_write()
655
501
if self.base_tree is not None:
656
stack.enter_context(self.base_tree.lock_read())
657
if self.other_tree is not None:
658
stack.enter_context(self.other_tree.lock_read())
659
merge = self._do_merge_to()
502
self.base_tree.lock_read()
504
if self.other_tree is not None:
505
self.other_tree.lock_read()
507
merge = self.make_merger()
508
self._do_merge_to(merge)
510
if self.other_tree is not None:
511
self.other_tree.unlock()
513
if self.base_tree is not None:
514
self.base_tree.unlock()
516
self.this_tree.unlock()
660
517
if len(merge.cooked_conflicts) == 0:
661
if not self.ignore_zero and not trace.is_quiet():
662
trace.note(gettext("All changes applied successfully."))
518
if not self.ignore_zero and not is_quiet():
519
note("All changes applied successfully.")
664
trace.note(gettext("%d conflicts encountered.")
665
% len(merge.cooked_conflicts))
521
note("%d conflicts encountered." % len(merge.cooked_conflicts))
667
523
return len(merge.cooked_conflicts)
698
550
supports_reverse_cherrypick = True
699
551
winner_idx = {"this": 2, "other": 1, "conflict": 1}
700
552
supports_lca_trees = True
701
requires_file_merge_plan = False
703
554
def __init__(self, working_tree, this_tree, base_tree, other_tree,
704
reprocess=False, show_base=False,
705
change_reporter=None, interesting_files=None, do_merge=True,
706
cherrypick=False, lca_trees=None, this_branch=None,
555
interesting_ids=None, reprocess=False, show_base=False,
556
pb=DummyProgress(), pp=None, change_reporter=None,
557
interesting_files=None, do_merge=True,
558
cherrypick=False, lca_trees=None):
708
559
"""Initialize the merger object and perform the merge.
710
561
:param working_tree: The working tree to apply the merge to
711
562
:param this_tree: The local tree in the merge operation
712
563
:param base_tree: The common tree in the merge operation
713
564
:param other_tree: The other tree to merge changes from
714
:param this_branch: The branch associated with this_tree. Defaults to
715
this_tree.branch if not supplied.
716
:param other_branch: The branch associated with other_tree, if any.
565
:param interesting_ids: The file_ids of files that should be
566
participate in the merge. May not be combined with
717
568
:param: reprocess If True, perform conflict-reduction processing.
718
569
:param show_base: If True, show the base revision in text conflicts.
719
570
(incompatible with reprocess)
571
:param pb: A Progress bar
572
:param pp: A ProgressPhase object
720
573
:param change_reporter: An object that should report changes made
721
574
:param interesting_files: The tree-relative paths of files that should
722
575
participate in the merge. If these paths refer to directories,
723
the contents of those directories will also be included. If not
724
specified, all files may participate in the
576
the contents of those directories will also be included. May not
577
be combined with interesting_ids. If neither interesting_files nor
578
interesting_ids is specified, all files may participate in the
726
580
:param lca_trees: Can be set to a dictionary of {revision_id:rev_tree}
727
581
if the ancestry was found to include a criss-cross merge.
728
582
Otherwise should be None.
730
584
object.__init__(self)
731
if this_branch is None:
732
this_branch = this_tree.branch
585
if interesting_files is not None and interesting_ids is not None:
587
'specify either interesting_ids or interesting_files')
588
self.interesting_ids = interesting_ids
733
589
self.interesting_files = interesting_files
734
self.working_tree = working_tree
735
self.this_tree = this_tree
590
self.this_tree = working_tree
736
591
self.base_tree = base_tree
737
592
self.other_tree = other_tree
738
self.this_branch = this_branch
739
self.other_branch = other_branch
740
593
self._raw_conflicts = []
741
594
self.cooked_conflicts = []
742
595
self.reprocess = reprocess
747
600
# making sure we haven't missed any corner cases.
748
601
# if lca_trees is None:
749
602
# self._lca_trees = [self.base_tree]
750
605
self.change_reporter = change_reporter
751
606
self.cherrypick = cherrypick
608
self.pp = ProgressPhase("Merge phase", 3, self.pb)
755
612
def do_merge(self):
756
with contextlib.ExitStack() as stack:
757
stack.enter_context(self.working_tree.lock_tree_write())
758
stack.enter_context(self.this_tree.lock_read())
759
stack.enter_context(self.base_tree.lock_read())
760
stack.enter_context(self.other_tree.lock_read())
761
self.tt = self.working_tree.transform()
762
stack.enter_context(self.tt)
613
self.this_tree.lock_tree_write()
614
self.base_tree.lock_read()
615
self.other_tree.lock_read()
616
self.tt = TreeTransform(self.this_tree, self.pb)
763
619
self._compute_transform()
764
621
results = self.tt.apply(no_conflicts=True)
765
622
self.write_modified(results)
767
self.working_tree.add_conflicts(self.cooked_conflicts)
768
except errors.UnsupportedOperation:
624
self.this_tree.add_conflicts(self.cooked_conflicts)
625
except UnsupportedOperation:
629
self.other_tree.unlock()
630
self.base_tree.unlock()
631
self.this_tree.unlock()
771
634
def make_preview_transform(self):
772
with self.base_tree.lock_read(), self.other_tree.lock_read():
773
self.tt = self.working_tree.preview_transform()
635
self.base_tree.lock_read()
636
self.other_tree.lock_read()
637
self.tt = TransformPreview(self.this_tree)
774
640
self._compute_transform()
643
self.other_tree.unlock()
644
self.base_tree.unlock()
777
648
def _compute_transform(self):
778
649
if self._lca_trees is None:
779
entries = list(self._entries3())
650
entries = self._entries3()
780
651
resolver = self._three_way
782
entries = list(self._entries_lca())
653
entries = self._entries_lca()
783
654
resolver = self._lca_multi_way
784
# Prepare merge hooks
785
factories = Merger.hooks['merge_file_content']
786
# One hook for each registered one plus our default merger
787
hooks = [factory(self) for factory in factories] + [self]
788
self.active_hooks = [hook for hook in hooks if hook is not None]
789
with ui.ui_factory.nested_progress_bar() as child_pb:
790
for num, (file_id, changed, paths3, parents3, names3,
655
child_pb = ui.ui_factory.nested_progress_bar()
657
for num, (file_id, changed, parents3, names3,
791
658
executable3) in enumerate(entries):
792
trans_id = self.tt.trans_id_file_id(file_id)
793
# Try merging each entry
794
child_pb.update(gettext('Preparing file merge'),
796
self._merge_names(trans_id, file_id, paths3, parents3,
797
names3, resolver=resolver)
659
child_pb.update('Preparing file merge', num, len(entries))
660
self._merge_names(file_id, parents3, names3, resolver=resolver)
799
file_status = self._do_merge_contents(paths3, trans_id, file_id)
662
file_status = self.merge_contents(file_id)
801
664
file_status = 'unmodified'
802
self._merge_executable(paths3, trans_id, executable3,
803
file_status, resolver=resolver)
804
self.tt.fixup_new_roots()
805
self._finish_computing_transform()
807
def _finish_computing_transform(self):
808
"""Finalize the transform and report the changes.
810
This is the second half of _compute_transform.
812
with ui.ui_factory.nested_progress_bar() as child_pb:
813
fs_conflicts = transform.resolve_conflicts(
815
lambda t, c: transform.conflict_pass(t, c, self.other_tree))
665
self._merge_executable(file_id,
666
executable3, file_status, resolver=resolver)
671
child_pb = ui.ui_factory.nested_progress_bar()
673
fs_conflicts = resolve_conflicts(self.tt, child_pb,
674
lambda t, c: conflict_pass(t, c, self.other_tree))
816
677
if self.change_reporter is not None:
817
from breezy import delta
678
from bzrlib import delta
818
679
delta.report_changes(
819
680
self.tt.iter_changes(), self.change_reporter)
820
681
self.cook_conflicts(fs_conflicts)
821
682
for conflict in self.cooked_conflicts:
822
trace.warning('%s', conflict.describe())
824
685
def _entries3(self):
825
686
"""Gather data about files modified between three trees.
868
725
it then compares with THIS and BASE.
870
727
For the multi-valued entries, the format will be (BASE, [lca1, lca2])
872
:return: [(file_id, changed, paths, parents, names, executable)], where:
874
* file_id: Simple file_id of the entry
875
* changed: Boolean, True if the kind or contents changed else False
876
* paths: ((base, [path, in, lcas]), path_other, path_this)
877
* parents: ((base, [parent_id, in, lcas]), parent_id_other,
879
* names: ((base, [name, in, lcas]), name_in_other, name_in_this)
880
* executable: ((base, [exec, in, lcas]), exec_in_other,
728
:return: [(file_id, changed, parents, names, executable)]
729
file_id Simple file_id of the entry
730
changed Boolean, True if the kind or contents changed
732
parents ((base, [parent_id, in, lcas]), parent_id_other,
734
names ((base, [name, in, lcas]), name_in_other, name_in_this)
735
executable ((base, [exec, in, lcas]), exec_in_other, exec_in_this)
883
737
if self.interesting_files is not None:
884
738
lookup_trees = [self.this_tree, self.base_tree]
885
739
lookup_trees.extend(self._lca_trees)
886
740
# I think we should include the lca trees as well
887
interesting_files = self.other_tree.find_related_paths_across_trees(
888
self.interesting_files, lookup_trees)
741
interesting_ids = self.other_tree.paths2ids(self.interesting_files,
890
interesting_files = None
891
from .multiwalker import MultiWalker
892
walker = MultiWalker(self.other_tree, self._lca_trees)
744
interesting_ids = self.interesting_ids
746
walker = _mod_tree.MultiWalker(self.other_tree, self._lca_trees)
894
for other_path, file_id, other_ie, lca_values in walker.iter_all():
748
base_inventory = self.base_tree.inventory
749
this_inventory = self.this_tree.inventory
750
for path, file_id, other_ie, lca_values in walker.iter_all():
895
751
# Is this modified at all from any of the other trees?
896
752
if other_ie is None:
897
753
other_ie = _none_entry
899
if interesting_files is not None and other_path not in interesting_files:
754
if interesting_ids is not None and file_id not in interesting_ids:
902
757
# If other_revision is found in any of the lcas, that means this
1031
873
raise AssertionError('unhandled kind: %s' % other_ie.kind)
874
# XXX: We need to handle kind == 'symlink'
1033
876
# If we have gotten this far, that means something has changed
1034
yield (file_id, content_changed,
1035
((base_path, lca_paths),
1036
other_path, this_path),
877
result.append((file_id, content_changed,
1037
878
((base_ie.parent_id, lca_parent_ids),
1038
879
other_ie.parent_id, this_ie.parent_id),
1039
880
((base_ie.name, lca_names),
1040
881
other_ie.name, this_ie.name),
1041
882
((base_ie.executable, lca_executable),
1042
883
other_ie.executable, this_ie.executable)
890
self.tt.final_kind(self.tt.root)
892
self.tt.cancel_deletion(self.tt.root)
893
if self.tt.final_file_id(self.tt.root) is None:
894
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
896
other_root_file_id = self.other_tree.get_root_id()
897
if other_root_file_id is None:
899
other_root = self.tt.trans_id_file_id(other_root_file_id)
900
if other_root == self.tt.root:
903
self.tt.final_kind(other_root)
906
if self.other_tree.inventory.root.file_id in self.this_tree.inventory:
907
# the other tree's root is a non-root in the current tree
909
self.reparent_children(self.other_tree.inventory.root, self.tt.root)
910
self.tt.cancel_creation(other_root)
911
self.tt.cancel_versioning(other_root)
913
def reparent_children(self, ie, target):
914
for thing, child in ie.children.iteritems():
915
trans_id = self.tt.trans_id_file_id(child.file_id)
916
self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
1045
918
def write_modified(self, results):
1046
if not self.working_tree.supports_merge_modified():
1048
919
modified_hashes = {}
1049
920
for path in results.modified_paths:
1050
wt_relpath = self.working_tree.relpath(path)
1051
if not self.working_tree.is_versioned(wt_relpath):
921
file_id = self.this_tree.path2id(self.this_tree.relpath(path))
1053
hash = self.working_tree.get_file_sha1(wt_relpath)
924
hash = self.this_tree.get_file_sha1(file_id)
1054
925
if hash is None:
1056
modified_hashes[wt_relpath] = hash
1057
self.working_tree.set_merge_modified(modified_hashes)
927
modified_hashes[file_id] = hash
928
self.this_tree.set_merge_modified(modified_hashes)
931
def parent(entry, file_id):
1061
932
"""Determine the parent for a file_id (used as a key method)"""
1062
933
if entry is None:
1064
935
return entry.parent_id
938
def name(entry, file_id):
1068
939
"""Determine the name for a file_id (used as a key method)"""
1069
940
if entry is None:
1071
942
return entry.name
1074
def contents_sha1(tree, path):
945
def contents_sha1(tree, file_id):
1075
946
"""Determine the sha1 of the file contents (used as a key method)."""
1077
return tree.get_file_sha1(path)
1078
except errors.NoSuchFile:
947
if file_id not in tree:
949
return tree.get_file_sha1(file_id)
1082
def executable(tree, path):
952
def executable(tree, file_id):
1083
953
"""Determine the executability of a file-id (used as a key method)."""
1085
if tree.kind(path) != "file":
1087
except errors.NoSuchFile:
954
if file_id not in tree:
1089
return tree.is_executable(path)
956
if tree.kind(file_id) != "file":
958
return tree.is_executable(file_id)
1092
def kind(tree, path):
961
def kind(tree, file_id):
1093
962
"""Determine the kind of a file-id (used as a key method)."""
1095
return tree.kind(path)
1096
except errors.NoSuchFile:
963
if file_id not in tree:
965
return tree.kind(file_id)
1100
968
def _three_way(base, other, this):
969
#if base == other, either they all agree, or only THIS has changed.
1101
970
if base == other:
1102
# if 'base == other', either they all agree, or only 'this' has
1105
972
elif this not in (base, other):
1106
# 'this' is neither 'base' nor 'other', so both sides changed
1107
973
return 'conflict'
974
# "Ambiguous clean merge" -- both sides have made the same change.
1108
975
elif this == other:
1109
# "Ambiguous clean merge" -- both sides have made the same change.
977
# this == base: only other has changed.
1112
# this == base: only other has changed.
1178
1084
parent_id_winner = "other"
1179
1085
if name_winner == "this" and parent_id_winner == "this":
1181
if name_winner == 'conflict' or parent_id_winner == 'conflict':
1182
# Creating helpers (.OTHER or .THIS) here cause problems down the
1183
# road if a ContentConflict needs to be created so we should not do
1185
self._raw_conflicts.append(('path conflict', trans_id, file_id,
1186
this_parent, this_name,
1187
other_parent, other_name))
1188
if other_path is None:
1087
if name_winner == "conflict":
1088
trans_id = self.tt.trans_id_file_id(file_id)
1089
self._raw_conflicts.append(('name conflict', trans_id,
1090
this_name, other_name))
1091
if parent_id_winner == "conflict":
1092
trans_id = self.tt.trans_id_file_id(file_id)
1093
self._raw_conflicts.append(('parent conflict', trans_id,
1094
this_parent, other_parent))
1095
if other_name is None:
1189
1096
# it doesn't matter whether the result was 'other' or
1190
# 'conflict'-- if it has no file id, we leave it alone.
1097
# 'conflict'-- if there's no 'other', we leave it alone.
1099
# if we get here, name_winner and parent_winner are set to safe values.
1100
trans_id = self.tt.trans_id_file_id(file_id)
1192
1101
parent_id = parents[self.winner_idx[parent_id_winner]]
1193
name = names[self.winner_idx[name_winner]]
1194
if parent_id is not None or name is not None:
1195
# if we get here, name_winner and parent_winner are set to safe
1197
if parent_id is None and name is not None:
1198
# if parent_id is None and name is non-None, current file is
1200
if names[self.winner_idx[parent_id_winner]] != '':
1201
raise AssertionError(
1202
'File looks like a root, but named %s' %
1203
names[self.winner_idx[parent_id_winner]])
1204
parent_trans_id = transform.ROOT_PARENT
1206
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1207
self.tt.adjust_path(name, parent_trans_id, trans_id)
1102
if parent_id is not None:
1103
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1104
self.tt.adjust_path(names[self.winner_idx[name_winner]],
1105
parent_trans_id, trans_id)
1209
def _do_merge_contents(self, paths, trans_id, file_id):
1107
def merge_contents(self, file_id):
1210
1108
"""Performs a merge on file_id contents."""
1211
def contents_pair(tree, path):
1215
kind = tree.kind(path)
1216
except errors.NoSuchFile:
1109
def contents_pair(tree):
1110
if file_id not in tree:
1112
kind = tree.kind(file_id)
1218
1113
if kind == "file":
1219
contents = tree.get_file_sha1(path)
1114
contents = tree.get_file_sha1(file_id)
1220
1115
elif kind == "symlink":
1221
contents = tree.get_symlink_target(path)
1116
contents = tree.get_symlink_target(file_id)
1223
1118
contents = None
1224
1119
return kind, contents
1226
base_path, other_path, this_path = paths
1121
def contents_conflict():
1122
trans_id = self.tt.trans_id_file_id(file_id)
1123
name = self.tt.final_name(trans_id)
1124
parent_id = self.tt.final_parent(trans_id)
1125
if file_id in self.this_tree.inventory:
1126
self.tt.unversion_file(trans_id)
1127
if file_id in self.this_tree:
1128
self.tt.delete_contents(trans_id)
1129
file_group = self._dump_conflicts(name, parent_id, file_id,
1131
self._raw_conflicts.append(('contents conflict', file_group))
1227
1133
# See SPOT run. run, SPOT, run.
1228
1134
# So we're not QUITE repeating ourselves; we do tricky things with
1230
other_pair = contents_pair(self.other_tree, other_path)
1231
this_pair = contents_pair(self.this_tree, this_path)
1136
base_pair = contents_pair(self.base_tree)
1137
other_pair = contents_pair(self.other_tree)
1232
1138
if self._lca_trees:
1233
(base_path, lca_paths) = base_path
1234
base_pair = contents_pair(self.base_tree, base_path)
1235
lca_pairs = [contents_pair(tree, path)
1236
for tree, path in zip(self._lca_trees, lca_paths)]
1139
this_pair = contents_pair(self.this_tree)
1140
lca_pairs = [contents_pair(tree) for tree in self._lca_trees]
1237
1141
winner = self._lca_multi_way((base_pair, lca_pairs), other_pair,
1238
1142
this_pair, allow_overriding_lca=False)
1240
base_pair = contents_pair(self.base_tree, base_path)
1241
1144
if base_pair == other_pair:
1242
1145
winner = 'this'
1244
1147
# We delayed evaluating this_pair as long as we can to avoid
1245
1148
# unnecessary sha1 calculation
1246
this_pair = contents_pair(self.this_tree, this_path)
1149
this_pair = contents_pair(self.this_tree)
1247
1150
winner = self._three_way(base_pair, other_pair, this_pair)
1248
1151
if winner == 'this':
1249
1152
# No interesting changes introduced by OTHER
1250
1153
return "unmodified"
1251
# We have a hypothetical conflict, but if we have files, then we
1252
# can try to merge the content
1253
params = MergeFileHookParams(
1254
self, (base_path, other_path, this_path), trans_id, this_pair[0],
1255
other_pair[0], winner)
1256
hooks = self.active_hooks
1257
hook_status = 'not_applicable'
1259
hook_status, lines = hook.merge_contents(params)
1260
if hook_status != 'not_applicable':
1261
# Don't try any more hooks, this one applies.
1263
# If the merge ends up replacing the content of the file, we get rid of
1264
# it at the end of this method (this variable is used to track the
1265
# exceptions to this rule).
1268
if hook_status == 'not_applicable':
1269
# No merge hook was able to resolve the situation. Two cases exist:
1270
# a content conflict or a duplicate one.
1272
name = self.tt.final_name(trans_id)
1273
parent_id = self.tt.final_parent(trans_id)
1274
inhibit_content_conflict = False
1275
if params.this_kind is None: # file_id is not in THIS
1276
# Is the name used for a different file_id ?
1277
if self.this_tree.is_versioned(other_path):
1278
# Two entries for the same path
1280
# versioning the merged file will trigger a duplicate
1282
self.tt.version_file(trans_id, file_id=file_id)
1283
transform.create_from_tree(
1284
self.tt, trans_id, self.other_tree,
1286
filter_tree_path=self._get_filter_tree_path(other_path))
1287
inhibit_content_conflict = True
1288
elif params.other_kind is None: # file_id is not in OTHER
1289
# Is the name used for a different file_id ?
1290
if self.other_tree.is_versioned(this_path):
1291
# Two entries for the same path again, but here, the other
1292
# entry will also be merged. We simply inhibit the
1293
# 'content' conflict creation because we know OTHER will
1294
# create (or has already created depending on ordering) an
1295
# entry at the same path. This will trigger a 'duplicate'
1298
inhibit_content_conflict = True
1299
if not inhibit_content_conflict:
1300
if params.this_kind is not None:
1301
self.tt.unversion_file(trans_id)
1302
# This is a contents conflict, because none of the available
1303
# functions could merge it.
1304
file_group = self._dump_conflicts(
1305
name, (base_path, other_path, this_path), parent_id,
1306
file_id, set_version=True)
1307
self._raw_conflicts.append(('contents conflict', file_group))
1308
elif hook_status == 'success':
1309
self.tt.create_file(lines, trans_id)
1310
elif hook_status == 'conflicted':
1311
# XXX: perhaps the hook should be able to provide
1312
# the BASE/THIS/OTHER files?
1313
self.tt.create_file(lines, trans_id)
1314
self._raw_conflicts.append(('text conflict', trans_id))
1315
name = self.tt.final_name(trans_id)
1316
parent_id = self.tt.final_parent(trans_id)
1317
self._dump_conflicts(
1318
name, (base_path, other_path, this_path), parent_id, file_id)
1319
elif hook_status == 'delete':
1320
self.tt.unversion_file(trans_id)
1322
elif hook_status == 'done':
1323
# The hook function did whatever it needs to do directly, no
1324
# further action needed here.
1327
raise AssertionError('unknown hook_status: %r' % (hook_status,))
1328
if not this_path and result == "modified":
1329
self.tt.version_file(trans_id, file_id=file_id)
1331
# The merge has been performed and produced a new content, so the
1332
# old contents should not be retained.
1333
self.tt.delete_contents(trans_id)
1336
def _default_other_winner_merge(self, merge_hook_params):
1337
"""Replace this contents with other."""
1338
trans_id = merge_hook_params.trans_id
1339
if merge_hook_params.other_path is not None:
1340
# OTHER changed the file
1341
transform.create_from_tree(
1342
self.tt, trans_id, self.other_tree,
1343
merge_hook_params.other_path,
1344
filter_tree_path=self._get_filter_tree_path(merge_hook_params.other_path))
1346
elif merge_hook_params.this_path is not None:
1347
# OTHER deleted the file
1348
return 'delete', None
1350
raise AssertionError(
1351
'winner is OTHER, but file %r not in THIS or OTHER tree'
1352
% (merge_hook_params.base_path,))
1354
def merge_contents(self, merge_hook_params):
1355
"""Fallback merge logic after user installed hooks."""
1356
# This function is used in merge hooks as the fallback instance.
1357
# Perhaps making this function and the functions it calls be a
1358
# a separate class would be better.
1359
if merge_hook_params.winner == 'other':
1154
trans_id = self.tt.trans_id_file_id(file_id)
1155
if winner == 'other':
1360
1156
# OTHER is a straight winner, so replace this contents with other
1361
return self._default_other_winner_merge(merge_hook_params)
1362
elif merge_hook_params.is_file_merge():
1363
# THIS and OTHER are both files, so text merge. Either
1364
# BASE is a file, or both converted to files, so at least we
1365
# have agreement that output should be a file.
1367
self.text_merge(merge_hook_params.trans_id,
1368
merge_hook_params.paths)
1369
except errors.BinaryFile:
1370
return 'not_applicable', None
1157
file_in_this = file_id in self.this_tree
1159
# Remove any existing contents
1160
self.tt.delete_contents(trans_id)
1161
if file_id in self.other_tree:
1162
# OTHER changed the file
1163
create_from_tree(self.tt, trans_id,
1164
self.other_tree, file_id)
1165
if not file_in_this:
1166
self.tt.version_file(file_id, trans_id)
1169
# OTHER deleted the file
1170
self.tt.unversion_file(trans_id)
1373
return 'not_applicable', None
1173
# We have a hypothetical conflict, but if we have files, then we
1174
# can try to merge the content
1175
if this_pair[0] == 'file' and other_pair[0] == 'file':
1176
# THIS and OTHER are both files, so text merge. Either
1177
# BASE is a file, or both converted to files, so at least we
1178
# have agreement that output should be a file.
1180
self.text_merge(file_id, trans_id)
1182
return contents_conflict()
1183
if file_id not in self.this_tree:
1184
self.tt.version_file(file_id, trans_id)
1186
self.tt.tree_kind(trans_id)
1187
self.tt.delete_contents(trans_id)
1192
return contents_conflict()
1375
def get_lines(self, tree, path):
1194
def get_lines(self, tree, file_id):
1376
1195
"""Return the lines in a file, or an empty list."""
1380
kind = tree.kind(path)
1381
except errors.NoSuchFile:
1197
return tree.get_file(file_id).readlines()
1386
return tree.get_file_lines(path)
1388
def text_merge(self, trans_id, paths):
1389
"""Perform a three-way text merge on a file"""
1201
def text_merge(self, file_id, trans_id):
1202
"""Perform a three-way text merge on a file_id"""
1390
1203
# it's possible that we got here with base as a different type.
1391
1204
# if so, we just want two-way text conflicts.
1392
base_path, other_path, this_path = paths
1393
base_lines = self.get_lines(self.base_tree, base_path)
1394
other_lines = self.get_lines(self.other_tree, other_path)
1395
this_lines = self.get_lines(self.this_tree, this_path)
1396
m3 = merge3.Merge3(base_lines, this_lines, other_lines,
1397
is_cherrypick=self.cherrypick)
1398
start_marker = b"!START OF MERGE CONFLICT!" + b"I HOPE THIS IS UNIQUE"
1205
if file_id in self.base_tree and \
1206
self.base_tree.kind(file_id) == "file":
1207
base_lines = self.get_lines(self.base_tree, file_id)
1210
other_lines = self.get_lines(self.other_tree, file_id)
1211
this_lines = self.get_lines(self.this_tree, file_id)
1212
m3 = Merge3(base_lines, this_lines, other_lines,
1213
is_cherrypick=self.cherrypick)
1214
start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
1399
1215
if self.show_base is True:
1400
base_marker = b'|' * 7
1216
base_marker = '|' * 7
1402
1218
base_marker = None
1404
1220
def iter_merge3(retval):
1405
1221
retval["text_conflicts"] = False
1406
for line in m3.merge_lines(name_a=b"TREE",
1407
name_b=b"MERGE-SOURCE",
1408
name_base=b"BASE-REVISION",
1222
for line in m3.merge_lines(name_a = "TREE",
1223
name_b = "MERGE-SOURCE",
1224
name_base = "BASE-REVISION",
1409
1225
start_marker=start_marker,
1410
1226
base_marker=base_marker,
1411
1227
reprocess=self.reprocess):
1412
1228
if line.startswith(start_marker):
1413
1229
retval["text_conflicts"] = True
1414
yield line.replace(start_marker, b'<' * 7)
1230
yield line.replace(start_marker, '<' * 7)
1449
1250
determined automatically. If set_version is true, the .OTHER, .THIS
1450
1251
or .BASE (in that order) will be created as versioned files.
1452
base_path, other_path, this_path = paths
1453
data = [('OTHER', self.other_tree, other_path, other_lines),
1454
('THIS', self.this_tree, this_path, this_lines)]
1253
data = [('OTHER', self.other_tree, other_lines),
1254
('THIS', self.this_tree, this_lines)]
1455
1255
if not no_base:
1456
data.append(('BASE', self.base_tree, base_path, base_lines))
1458
# We need to use the actual path in the working tree of the file here,
1459
if self.this_tree.supports_content_filtering():
1460
filter_tree_path = this_path
1462
# Skip the id2path lookup for older formats
1463
filter_tree_path = None
1256
data.append(('BASE', self.base_tree, base_lines))
1465
1257
versioned = False
1466
1258
file_group = []
1467
for suffix, tree, path, lines in data:
1468
if path is not None:
1469
trans_id = self._conflict_file(
1470
name, parent_id, path, tree, suffix, lines,
1259
for suffix, tree, lines in data:
1261
trans_id = self._conflict_file(name, parent_id, tree, file_id,
1472
1263
file_group.append(trans_id)
1473
1264
if set_version and not versioned:
1474
self.tt.version_file(trans_id, file_id=file_id)
1265
self.tt.version_file(file_id, trans_id)
1475
1266
versioned = True
1476
1267
return file_group
1478
def _conflict_file(self, name, parent_id, path, tree, suffix,
1479
lines=None, filter_tree_path=None):
1269
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
1480
1271
"""Emit a single conflict file."""
1481
1272
name = name + '.' + suffix
1482
1273
trans_id = self.tt.create_path(name, parent_id)
1483
transform.create_from_tree(
1484
self.tt, trans_id, tree, path,
1486
filter_tree_path=filter_tree_path)
1274
create_from_tree(self.tt, trans_id, tree, file_id, lines)
1487
1275
return trans_id
1489
def _merge_executable(self, paths, trans_id, executable, file_status,
1277
def merge_executable(self, file_id, file_status):
1278
"""Perform a merge on the execute bit."""
1279
executable = [self.executable(t, file_id) for t in (self.base_tree,
1280
self.other_tree, self.this_tree)]
1281
self._merge_executable(file_id, executable, file_status,
1282
resolver=self._three_way)
1284
def _merge_executable(self, file_id, executable, file_status,
1491
1286
"""Perform a merge on the execute bit."""
1492
1287
base_executable, other_executable, this_executable = executable
1493
base_path, other_path, this_path = paths
1494
1288
if file_status == "deleted":
1496
1290
winner = resolver(*executable)
1497
1291
if winner == "conflict":
1498
# There must be a None in here, if we have a conflict, but we
1499
# need executability since file status was not deleted.
1500
if other_path is None:
1292
# There must be a None in here, if we have a conflict, but we
1293
# need executability since file status was not deleted.
1294
if self.executable(self.other_tree, file_id) is None:
1501
1295
winner = "this"
1503
1297
winner = "other"
1504
1298
if winner == 'this' and file_status != "modified":
1506
if self.tt.final_kind(trans_id) != "file":
1300
trans_id = self.tt.trans_id_file_id(file_id)
1302
if self.tt.final_kind(trans_id) != "file":
1508
1306
if winner == "this":
1509
1307
executability = this_executable
1511
if other_path is not None:
1309
if file_id in self.other_tree:
1512
1310
executability = other_executable
1513
elif this_path is not None:
1311
elif file_id in self.this_tree:
1514
1312
executability = this_executable
1515
elif base_path is not None:
1313
elif file_id in self.base_tree:
1516
1314
executability = base_executable
1517
1315
if executability is not None:
1316
trans_id = self.tt.trans_id_file_id(file_id)
1518
1317
self.tt.set_executability(executability, trans_id)
1520
1319
def cook_conflicts(self, fs_conflicts):
1521
1320
"""Convert all conflicts into a form that doesn't depend on trans_id"""
1522
content_conflict_file_ids = set()
1523
cooked_conflicts = transform.cook_conflicts(fs_conflicts, self.tt)
1524
fp = transform.FinalPaths(self.tt)
1321
from conflicts import Conflict
1323
self.cooked_conflicts.extend(cook_conflicts(fs_conflicts, self.tt))
1324
fp = FinalPaths(self.tt)
1525
1325
for conflict in self._raw_conflicts:
1526
1326
conflict_type = conflict[0]
1527
if conflict_type == 'path conflict':
1529
this_parent, this_name,
1530
other_parent, other_name) = conflict[1:]
1531
if this_parent is None or this_name is None:
1532
this_path = '<deleted>'
1534
parent_path = fp.get_path(
1535
self.tt.trans_id_file_id(this_parent))
1536
this_path = osutils.pathjoin(parent_path, this_name)
1537
if other_parent is None or other_name is None:
1538
other_path = '<deleted>'
1540
if other_parent == self.other_tree.path2id(''):
1541
# The tree transform doesn't know about the other root,
1542
# so we special case here to avoid a NoFinalPath
1546
parent_path = fp.get_path(
1547
self.tt.trans_id_file_id(other_parent))
1548
other_path = osutils.pathjoin(parent_path, other_name)
1549
c = _mod_conflicts.Conflict.factory(
1550
'path conflict', path=this_path,
1551
conflict_path=other_path,
1553
elif conflict_type == 'contents conflict':
1327
if conflict_type in ('name conflict', 'parent conflict'):
1328
trans_id = conflict[1]
1329
conflict_args = conflict[2:]
1330
if trans_id not in name_conflicts:
1331
name_conflicts[trans_id] = {}
1332
unique_add(name_conflicts[trans_id], conflict_type,
1334
if conflict_type == 'contents conflict':
1554
1335
for trans_id in conflict[1]:
1555
1336
file_id = self.tt.final_file_id(trans_id)
1556
1337
if file_id is not None:
1557
# Ok we found the relevant file-id
1559
1339
path = fp.get_path(trans_id)
1560
1340
for suffix in ('.BASE', '.THIS', '.OTHER'):
1561
1341
if path.endswith(suffix):
1562
# Here is the raw path
1563
1342
path = path[:-len(suffix)]
1565
c = _mod_conflicts.Conflict.factory(conflict_type,
1566
path=path, file_id=file_id)
1567
content_conflict_file_ids.add(file_id)
1568
elif conflict_type == 'text conflict':
1344
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
1345
self.cooked_conflicts.append(c)
1346
if conflict_type == 'text conflict':
1569
1347
trans_id = conflict[1]
1570
1348
path = fp.get_path(trans_id)
1571
1349
file_id = self.tt.final_file_id(trans_id)
1572
c = _mod_conflicts.Conflict.factory(conflict_type,
1573
path=path, file_id=file_id)
1350
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
1351
self.cooked_conflicts.append(c)
1353
for trans_id, conflicts in name_conflicts.iteritems():
1355
this_parent, other_parent = conflicts['parent conflict']
1356
if this_parent == other_parent:
1357
raise AssertionError()
1359
this_parent = other_parent = \
1360
self.tt.final_file_id(self.tt.final_parent(trans_id))
1362
this_name, other_name = conflicts['name conflict']
1363
if this_name == other_name:
1364
raise AssertionError()
1366
this_name = other_name = self.tt.final_name(trans_id)
1367
other_path = fp.get_path(trans_id)
1368
if this_parent is not None and this_name is not None:
1369
this_parent_path = \
1370
fp.get_path(self.tt.trans_id_file_id(this_parent))
1371
this_path = pathjoin(this_parent_path, this_name)
1575
raise AssertionError('bad conflict type: %r' % (conflict,))
1576
cooked_conflicts.append(c)
1578
self.cooked_conflicts = []
1579
# We want to get rid of path conflicts when a corresponding contents
1580
# conflict exists. This can occur when one branch deletes a file while
1581
# the other renames *and* modifies it. In this case, the content
1582
# conflict is enough.
1583
for c in cooked_conflicts:
1584
if (c.typestring == 'path conflict'
1585
and c.file_id in content_conflict_file_ids):
1373
this_path = "<deleted>"
1374
file_id = self.tt.final_file_id(trans_id)
1375
c = Conflict.factory('path conflict', path=this_path,
1376
conflict_path=other_path, file_id=file_id)
1587
1377
self.cooked_conflicts.append(c)
1588
self.cooked_conflicts.sort(key=_mod_conflicts.Conflict.sort_key)
1378
self.cooked_conflicts.sort(key=Conflict.sort_key)
1591
1381
class WeaveMerger(Merge3Merger):
1594
1384
supports_show_base = False
1595
1385
supports_reverse_cherrypick = False
1596
1386
history_based = True
1597
requires_file_merge_plan = True
1599
def _generate_merge_plan(self, this_path, base):
1600
return self.this_tree.plan_file_merge(this_path, self.other_tree,
1388
def _merged_lines(self, file_id):
1389
"""Generate the merged lines.
1390
There is no distinction between lines that are meant to contain <<<<<<<
1394
base = self.base_tree
1397
plan = self.this_tree.plan_file_merge(file_id, self.other_tree,
1603
def _merged_lines(self, this_path):
1604
"""Generate the merged lines.
1605
There is no distinction between lines that are meant to contain <<<<<<<
1609
base = self.base_tree
1612
plan = self._generate_merge_plan(this_path, base)
1613
1399
if 'merge' in debug.debug_flags:
1614
1400
plan = list(plan)
1615
1401
trans_id = self.tt.trans_id_file_id(file_id)
1616
1402
name = self.tt.final_name(trans_id) + '.plan'
1617
contents = (b'%11s|%s' % l for l in plan)
1403
contents = ('%10s|%s' % l for l in plan)
1618
1404
self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
1619
textmerge = versionedfile.PlanWeaveMerge(plan, b'<<<<<<< TREE\n',
1620
b'>>>>>>> MERGE-SOURCE\n')
1621
lines, conflicts = textmerge.merge_lines(self.reprocess)
1623
base_lines = textmerge.base_from_plan()
1626
return lines, base_lines
1405
textmerge = PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1406
'>>>>>>> MERGE-SOURCE\n')
1407
return textmerge.merge_lines(self.reprocess)
1628
def text_merge(self, trans_id, paths):
1409
def text_merge(self, file_id, trans_id):
1629
1410
"""Perform a (weave) text merge for a given file and file-id.
1630
1411
If conflicts are encountered, .THIS and .OTHER files will be emitted,
1631
1412
and a conflict will be noted.
1633
base_path, other_path, this_path = paths
1634
lines, base_lines = self._merged_lines(this_path)
1414
lines, conflicts = self._merged_lines(file_id)
1635
1415
lines = list(lines)
1636
1416
# Note we're checking whether the OUTPUT is binary in this case,
1637
1417
# because we don't want to get into weave merge guts.
1638
textfile.check_text_lines(lines)
1418
check_text_lines(lines)
1639
1419
self.tt.create_file(lines, trans_id)
1640
if base_lines is not None:
1642
1421
self._raw_conflicts.append(('text conflict', trans_id))
1643
1422
name = self.tt.final_name(trans_id)
1644
1423
parent_id = self.tt.final_parent(trans_id)
1645
file_id = self.tt.final_file_id(trans_id)
1646
file_group = self._dump_conflicts(name, paths, parent_id, file_id,
1648
base_lines=base_lines)
1424
file_group = self._dump_conflicts(name, parent_id, file_id,
1649
1426
file_group.append(trans_id)
1652
1429
class LCAMerger(WeaveMerger):
1654
requires_file_merge_plan = True
1656
def _generate_merge_plan(self, this_path, base):
1657
return self.this_tree.plan_file_lca_merge(this_path, self.other_tree,
1431
def _merged_lines(self, file_id):
1432
"""Generate the merged lines.
1433
There is no distinction between lines that are meant to contain <<<<<<<
1437
base = self.base_tree
1440
plan = self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
1442
if 'merge' in debug.debug_flags:
1444
trans_id = self.tt.trans_id_file_id(file_id)
1445
name = self.tt.final_name(trans_id) + '.plan'
1446
contents = ('%10s|%s' % l for l in plan)
1447
self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
1448
textmerge = PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1449
'>>>>>>> MERGE-SOURCE\n')
1450
return textmerge.merge_lines(self.reprocess)
1661
1453
class Diff3Merger(Merge3Merger):
1662
1454
"""Three-way merger using external diff3 for text merging"""
1664
requires_file_merge_plan = False
1666
def dump_file(self, temp_dir, name, tree, path):
1667
out_path = osutils.pathjoin(temp_dir, name)
1668
with open(out_path, "wb") as out_file:
1669
in_file = tree.get_file(path)
1456
def dump_file(self, temp_dir, name, tree, file_id):
1457
out_path = pathjoin(temp_dir, name)
1458
out_file = open(out_path, "wb")
1460
in_file = tree.get_file(file_id)
1670
1461
for line in in_file:
1671
1462
out_file.write(line)
1672
1465
return out_path
1674
def text_merge(self, trans_id, paths):
1467
def text_merge(self, file_id, trans_id):
1675
1468
"""Perform a diff3 merge using a specified file-id and trans-id.
1676
1469
If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
1677
1470
will be dumped, and a will be conflict noted.
1680
base_path, other_path, this_path = paths
1681
1473
temp_dir = osutils.mkdtemp(prefix="bzr-")
1683
new_file = osutils.pathjoin(temp_dir, "new")
1684
this = self.dump_file(
1685
temp_dir, "this", self.this_tree, this_path)
1686
base = self.dump_file(
1687
temp_dir, "base", self.base_tree, base_path)
1688
other = self.dump_file(
1689
temp_dir, "other", self.other_tree, other_path)
1690
status = breezy.patch.diff3(new_file, this, base, other)
1475
new_file = pathjoin(temp_dir, "new")
1476
this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
1477
base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
1478
other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
1479
status = bzrlib.patch.diff3(new_file, this, base, other)
1691
1480
if status not in (0, 1):
1692
raise errors.BzrError("Unhandled diff3 exit code")
1693
with open(new_file, 'rb') as f:
1481
raise BzrError("Unhandled diff3 exit code")
1482
f = open(new_file, 'rb')
1694
1484
self.tt.create_file(f, trans_id)
1695
1487
if status == 1:
1696
1488
name = self.tt.final_name(trans_id)
1697
1489
parent_id = self.tt.final_parent(trans_id)
1698
file_id = self.tt.final_file_id(trans_id)
1699
self._dump_conflicts(name, paths, parent_id, file_id)
1490
self._dump_conflicts(name, parent_id, file_id)
1700
1491
self._raw_conflicts.append(('text conflict', trans_id))
1702
1493
osutils.rmtree(temp_dir)
1705
class PathNotInTree(errors.BzrError):
1707
_fmt = """Merge-into failed because %(tree)s does not contain %(path)s."""
1709
def __init__(self, path, tree):
1710
errors.BzrError.__init__(self, path=path, tree=tree)
1713
class MergeIntoMerger(Merger):
1714
"""Merger that understands other_tree will be merged into a subdir.
1716
This also changes the Merger api so that it uses real Branch, revision_id,
1717
and RevisonTree objects, rather than using revision specs.
1720
def __init__(self, this_tree, other_branch, other_tree, target_subdir,
1721
source_subpath, other_rev_id=None):
1722
"""Create a new MergeIntoMerger object.
1724
source_subpath in other_tree will be effectively copied to
1725
target_subdir in this_tree.
1727
:param this_tree: The tree that we will be merging into.
1728
:param other_branch: The Branch we will be merging from.
1729
:param other_tree: The RevisionTree object we want to merge.
1730
:param target_subdir: The relative path where we want to merge
1731
other_tree into this_tree
1732
:param source_subpath: The relative path specifying the subtree of
1733
other_tree to merge into this_tree.
1735
# It is assumed that we are merging a tree that is not in our current
1736
# ancestry, which means we are using the "EmptyTree" as our basis.
1737
null_ancestor_tree = this_tree.branch.repository.revision_tree(
1738
_mod_revision.NULL_REVISION)
1739
super(MergeIntoMerger, self).__init__(
1740
this_branch=this_tree.branch,
1741
this_tree=this_tree,
1742
other_tree=other_tree,
1743
base_tree=null_ancestor_tree,
1745
self._target_subdir = target_subdir
1746
self._source_subpath = source_subpath
1747
self.other_branch = other_branch
1748
if other_rev_id is None:
1749
other_rev_id = other_tree.get_revision_id()
1750
self.other_rev_id = self.other_basis = other_rev_id
1751
self.base_is_ancestor = True
1752
self.backup_files = True
1753
self.merge_type = Merge3Merger
1754
self.show_base = False
1755
self.reprocess = False
1756
self.interesting_files = None
1757
self.merge_type = _MergeTypeParameterizer(MergeIntoMergeType,
1758
target_subdir=self._target_subdir,
1759
source_subpath=self._source_subpath)
1760
if self._source_subpath != '':
1761
# If this isn't a partial merge make sure the revisions will be
1763
self._maybe_fetch(self.other_branch, self.this_branch,
1766
def set_pending(self):
1767
if self._source_subpath != '':
1769
Merger.set_pending(self)
1772
class _MergeTypeParameterizer(object):
1773
"""Wrap a merge-type class to provide extra parameters.
1775
This is hack used by MergeIntoMerger to pass some extra parameters to its
1776
merge_type. Merger.do_merge() sets up its own set of parameters to pass to
1777
the 'merge_type' member. It is difficult override do_merge without
1778
re-writing the whole thing, so instead we create a wrapper which will pass
1779
the extra parameters.
1782
def __init__(self, merge_type, **kwargs):
1783
self._extra_kwargs = kwargs
1784
self._merge_type = merge_type
1786
def __call__(self, *args, **kwargs):
1787
kwargs.update(self._extra_kwargs)
1788
return self._merge_type(*args, **kwargs)
1790
def __getattr__(self, name):
1791
return getattr(self._merge_type, name)
1794
class MergeIntoMergeType(Merge3Merger):
1795
"""Merger that incorporates a tree (or part of a tree) into another."""
1797
def __init__(self, *args, **kwargs):
1798
"""Initialize the merger object.
1800
:param args: See Merge3Merger.__init__'s args.
1801
:param kwargs: See Merge3Merger.__init__'s keyword args, except for
1802
source_subpath and target_subdir.
1803
:keyword source_subpath: The relative path specifying the subtree of
1804
other_tree to merge into this_tree.
1805
:keyword target_subdir: The relative path where we want to merge
1806
other_tree into this_tree
1808
# All of the interesting work happens during Merge3Merger.__init__(),
1809
# so we have have to hack in to get our extra parameters set.
1810
self._source_subpath = kwargs.pop('source_subpath')
1811
self._target_subdir = kwargs.pop('target_subdir')
1812
super(MergeIntoMergeType, self).__init__(*args, **kwargs)
1814
def _compute_transform(self):
1815
with ui.ui_factory.nested_progress_bar() as child_pb:
1816
entries = self._entries_to_incorporate()
1817
entries = list(entries)
1818
for num, (entry, parent_id, relpath) in enumerate(entries):
1819
child_pb.update(gettext('Preparing file merge'),
1821
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1822
path = osutils.pathjoin(self._source_subpath, relpath)
1823
trans_id = transform.new_by_entry(path, self.tt, entry,
1824
parent_trans_id, self.other_tree)
1825
self._finish_computing_transform()
1827
def _entries_to_incorporate(self):
1828
"""Yields pairs of (inventory_entry, new_parent)."""
1829
subdir_id = self.other_tree.path2id(self._source_subpath)
1830
if subdir_id is None:
1831
# XXX: The error would be clearer if it gave the URL of the source
1832
# branch, but we don't have a reference to that here.
1833
raise PathNotInTree(self._source_subpath, "Source tree")
1834
subdir = next(self.other_tree.iter_entries_by_dir(
1835
specific_files=[self._source_subpath]))[1]
1836
parent_in_target = osutils.dirname(self._target_subdir)
1837
target_id = self.this_tree.path2id(parent_in_target)
1838
if target_id is None:
1839
raise PathNotInTree(self._target_subdir, "Target tree")
1840
name_in_target = osutils.basename(self._target_subdir)
1841
merge_into_root = subdir.copy()
1842
merge_into_root.name = name_in_target
1844
self.this_tree.id2path(merge_into_root.file_id)
1845
except errors.NoSuchId:
1848
# Give the root a new file-id.
1849
# This can happen fairly easily if the directory we are
1850
# incorporating is the root, and both trees have 'TREE_ROOT' as
1851
# their root_id. Users will expect this to Just Work, so we
1852
# change the file-id here.
1853
# Non-root file-ids could potentially conflict too. That's really
1854
# an edge case, so we don't do anything special for those. We let
1855
# them cause conflicts.
1856
merge_into_root.file_id = generate_ids.gen_file_id(name_in_target)
1857
yield (merge_into_root, target_id, '')
1858
if subdir.kind != 'directory':
1859
# No children, so we are done.
1861
for path, entry in self.other_tree.root_inventory.iter_entries_by_dir(subdir_id):
1862
parent_id = entry.parent_id
1863
if parent_id == subdir.file_id:
1864
# The root's parent ID has changed, so make sure children of
1865
# the root refer to the new ID.
1866
parent_id = merge_into_root.file_id
1867
yield (entry, parent_id, path)
1870
1496
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1871
1497
backup_files=False,
1872
1498
merge_type=Merge3Merger,
1499
interesting_ids=None,
1873
1500
show_base=False,
1874
1501
reprocess=False,
1875
1502
other_rev_id=None,
1876
1503
interesting_files=None,
1877
1504
this_tree=None,
1878
1506
change_reporter=None):
1879
1507
"""Primary interface for merging.
1881
Typical use is probably::
1883
merge_inner(branch, branch.get_revision_tree(other_revision),
1884
branch.get_revision_tree(base_revision))
1509
typical use is probably
1510
'merge_inner(branch, branch.get_revision_tree(other_revision),
1511
branch.get_revision_tree(base_revision))'
1886
1513
if this_tree is None:
1887
raise errors.BzrError("breezy.merge.merge_inner requires a this_tree "
1514
raise BzrError("bzrlib.merge.merge_inner requires a this_tree "
1515
"parameter as of bzrlib version 0.8.")
1889
1516
merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1890
change_reporter=change_reporter)
1517
pb=pb, change_reporter=change_reporter)
1891
1518
merger.backup_files = backup_files
1892
1519
merger.merge_type = merge_type
1520
merger.interesting_ids = interesting_ids
1893
1521
merger.ignore_zero = ignore_zero
1894
merger.interesting_files = interesting_files
1522
if interesting_files:
1524
raise ValueError('Only supply interesting_ids'
1525
' or interesting_files')
1526
merger.interesting_files = interesting_files
1895
1527
merger.show_base = show_base
1896
1528
merger.reprocess = reprocess
1897
1529
merger.other_rev_id = other_rev_id
added
removed
bzrlib/merge.py
