1
# Copyright (C) 2005, 2006 Canonical Ltd
 
 
3
# This program is free software; you can redistribute it and/or modify
 
 
4
# it under the terms of the GNU General Public License as published by
 
 
5
# the Free Software Foundation; either version 2 of the License, or
 
 
6
# (at your option) any later version.
 
 
8
# This program is distributed in the hope that it will be useful,
 
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
 
11
# GNU General Public License for more details.
 
 
13
# You should have received a copy of the GNU General Public License
 
 
14
# along with this program; if not, write to the Free Software
 
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 
27
    revision as _mod_revision,
 
 
29
from bzrlib.branch import Branch
 
 
30
from bzrlib.conflicts import ConflictList, Conflict
 
 
31
from bzrlib.errors import (BzrCommandError,
 
 
41
                           WorkingTreeNotRevision,
 
 
44
from bzrlib.merge3 import Merge3
 
 
45
from bzrlib.osutils import rename, pathjoin
 
 
46
from progress import DummyProgress, ProgressPhase
 
 
47
from bzrlib.revision import (is_ancestor, NULL_REVISION, ensure_null)
 
 
48
from bzrlib.textfile import check_text_lines
 
 
49
from bzrlib.trace import mutter, warning, note
 
 
50
from bzrlib.transform import (TreeTransform, resolve_conflicts, cook_conflicts,
 
 
51
                              conflict_pass, FinalPaths, create_by_entry,
 
 
52
                              unique_add, ROOT_PARENT)
 
 
53
from bzrlib.versionedfile import PlanWeaveMerge
 
 
56
# TODO: Report back as changes are merged in
 
 
59
def transform_tree(from_tree, to_tree, interesting_ids=None):
 
 
60
    merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
 
 
61
                interesting_ids=interesting_ids, this_tree=from_tree)
 
 
65
    def __init__(self, this_branch, other_tree=None, base_tree=None,
 
 
66
                 this_tree=None, pb=DummyProgress(), change_reporter=None,
 
 
69
        assert this_tree is not None, "this_tree is required"
 
 
70
        self.this_branch = this_branch
 
 
71
        self.this_basis = _mod_revision.ensure_null(
 
 
72
            this_branch.last_revision())
 
 
73
        self.this_rev_id = None
 
 
74
        self.this_tree = this_tree
 
 
75
        self.this_revision_tree = None
 
 
76
        self.this_basis_tree = None
 
 
77
        self.other_tree = other_tree
 
 
78
        self.other_branch = None
 
 
79
        self.base_tree = base_tree
 
 
80
        self.ignore_zero = False
 
 
81
        self.backup_files = False
 
 
82
        self.interesting_ids = None
 
 
83
        self.interesting_files = None
 
 
84
        self.show_base = False
 
 
85
        self.reprocess = False
 
 
88
        self.recurse = recurse
 
 
89
        self.change_reporter = change_reporter
 
 
90
        self._cached_trees = {}
 
 
93
    def from_uncommitted(tree, other_tree, pb):
 
 
94
        """Return a Merger for uncommitted changes in other_tree.
 
 
96
        :param tree: The tree to merge into
 
 
97
        :param other_tree: The tree to get uncommitted changes from
 
 
98
        :param pb: A progress indicator
 
 
100
        merger = Merger(tree.branch, other_tree, other_tree.basis_tree(), tree,
 
 
102
        merger.base_rev_id = merger.base_tree.get_revision_id()
 
 
103
        merger.other_rev_id = None
 
 
107
    def from_mergeable(klass, tree, mergeable, pb):
 
 
108
        """Return a Merger for a bundle or merge directive.
 
 
110
        :param tree: The tree to merge changes into
 
 
111
        :param mergeable: A merge directive or bundle
 
 
112
        :param pb: A progress indicator
 
 
114
        mergeable.install_revisions(tree.branch.repository)
 
 
115
        base_revision_id, other_revision_id, verified =\
 
 
116
            mergeable.get_merge_request(tree.branch.repository)
 
 
117
        if (base_revision_id != _mod_revision.NULL_REVISION and
 
 
118
            tree.branch.repository.get_graph().is_ancestor(
 
 
119
            base_revision_id, tree.branch.last_revision())):
 
 
120
            base_revision_id = None
 
 
121
        merger = klass.from_revision_ids(pb, tree, other_revision_id,
 
 
123
        return merger, verified
 
 
126
    def from_revision_ids(pb, this, other, base=None, other_branch=None,
 
 
128
        """Return a Merger for revision-ids.
 
 
130
        :param tree: The tree to merge changes into
 
 
131
        :param other: The revision-id to use as OTHER
 
 
132
        :param base: The revision-id to use as BASE.  If not specified, will
 
 
134
        :param other_branch: A branch containing the other revision-id.  If
 
 
135
            not supplied, this.branch is used.
 
 
136
        :param base_branch: A branch containing the base revision-id.  If
 
 
137
            not supplied, other_branch or this.branch will be used.
 
 
138
        :param pb: A progress indicator
 
 
140
        merger = Merger(this.branch, this_tree=this, pb=pb)
 
 
141
        if other_branch is None:
 
 
142
            other_branch = this.branch
 
 
143
        merger.set_other_revision(other, other_branch)
 
 
147
            if base_branch is None:
 
 
148
                base_branch = other_branch
 
 
149
            merger.set_base_revision(base, base_branch)
 
 
152
    def revision_tree(self, revision_id, branch=None):
 
 
153
        if revision_id not in self._cached_trees:
 
 
155
                branch = self.this_branch
 
 
157
                tree = self.this_tree.revision_tree(revision_id)
 
 
158
            except errors.NoSuchRevisionInTree:
 
 
159
                tree = branch.repository.revision_tree(revision_id)
 
 
160
            self._cached_trees[revision_id] = tree
 
 
161
        return self._cached_trees[revision_id]
 
 
163
    def _get_tree(self, treespec, possible_transports=None):
 
 
164
        from bzrlib import workingtree
 
 
165
        location, revno = treespec
 
 
167
            tree = workingtree.WorkingTree.open_containing(location)[0]
 
 
168
            return tree.branch, tree
 
 
169
        branch = Branch.open_containing(location, possible_transports)[0]
 
 
171
            revision_id = branch.last_revision()
 
 
173
            revision_id = branch.get_rev_id(revno)
 
 
174
        revision_id = ensure_null(revision_id)
 
 
175
        return branch, self.revision_tree(revision_id, branch)
 
 
177
    def ensure_revision_trees(self):
 
 
178
        if self.this_revision_tree is None:
 
 
179
            self.this_basis_tree = self.revision_tree(self.this_basis)
 
 
180
            if self.this_basis == self.this_rev_id:
 
 
181
                self.this_revision_tree = self.this_basis_tree
 
 
183
        if self.other_rev_id is None:
 
 
184
            other_basis_tree = self.revision_tree(self.other_basis)
 
 
185
            changes = other_basis_tree.changes_from(self.other_tree)
 
 
186
            if changes.has_changed():
 
 
187
                raise WorkingTreeNotRevision(self.this_tree)
 
 
188
            other_rev_id = self.other_basis
 
 
189
            self.other_tree = other_basis_tree
 
 
191
    def file_revisions(self, file_id):
 
 
192
        self.ensure_revision_trees()
 
 
193
        def get_id(tree, file_id):
 
 
194
            revision_id = tree.inventory[file_id].revision
 
 
195
            assert revision_id is not None
 
 
197
        if self.this_rev_id is None:
 
 
198
            if self.this_basis_tree.get_file_sha1(file_id) != \
 
 
199
                self.this_tree.get_file_sha1(file_id):
 
 
200
                raise WorkingTreeNotRevision(self.this_tree)
 
 
202
        trees = (self.this_basis_tree, self.other_tree)
 
 
203
        return [get_id(tree, file_id) for tree in trees]
 
 
205
    def check_basis(self, check_clean, require_commits=True):
 
 
206
        if self.this_basis is None and require_commits is True:
 
 
207
            raise BzrCommandError("This branch has no commits."
 
 
208
                                  " (perhaps you would prefer 'bzr pull')")
 
 
211
            if self.this_basis != self.this_rev_id:
 
 
212
                raise BzrCommandError("Working tree has uncommitted changes.")
 
 
214
    def compare_basis(self):
 
 
216
            basis_tree = self.revision_tree(self.this_tree.last_revision())
 
 
217
        except errors.RevisionNotPresent:
 
 
218
            basis_tree = self.this_tree.basis_tree()
 
 
219
        changes = self.this_tree.changes_from(basis_tree)
 
 
220
        if not changes.has_changed():
 
 
221
            self.this_rev_id = self.this_basis
 
 
223
    def set_interesting_files(self, file_list):
 
 
224
        self.interesting_files = file_list
 
 
226
    def set_pending(self):
 
 
227
        if not self.base_is_ancestor or not self.base_is_other_ancestor or self.other_rev_id is None:
 
 
231
    def _add_parent(self):
 
 
232
        new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
 
 
233
        new_parent_trees = []
 
 
234
        for revision_id in new_parents:
 
 
236
                tree = self.revision_tree(revision_id)
 
 
237
            except errors.RevisionNotPresent:
 
 
241
            new_parent_trees.append((revision_id, tree))
 
 
243
            self.this_tree.set_parent_trees(new_parent_trees,
 
 
244
                                            allow_leftmost_as_ghost=True)
 
 
246
            for _revision_id, tree in new_parent_trees:
 
 
250
    def set_other(self, other_revision, possible_transports=None):
 
 
251
        """Set the revision and tree to merge from.
 
 
253
        This sets the other_tree, other_rev_id, other_basis attributes.
 
 
255
        :param other_revision: The [path, revision] list to merge from.
 
 
257
        self.other_branch, self.other_tree = self._get_tree(other_revision,
 
 
259
        if other_revision[1] == -1:
 
 
260
            self.other_rev_id = _mod_revision.ensure_null(
 
 
261
                self.other_branch.last_revision())
 
 
262
            if _mod_revision.is_null(self.other_rev_id):
 
 
263
                raise NoCommits(self.other_branch)
 
 
264
            self.other_basis = self.other_rev_id
 
 
265
        elif other_revision[1] is not None:
 
 
266
            self.other_rev_id = self.other_branch.get_rev_id(other_revision[1])
 
 
267
            self.other_basis = self.other_rev_id
 
 
269
            self.other_rev_id = None
 
 
270
            self.other_basis = self.other_branch.last_revision()
 
 
271
            if self.other_basis is None:
 
 
272
                raise NoCommits(self.other_branch)
 
 
273
        if self.other_rev_id is not None:
 
 
274
            self._cached_trees[self.other_rev_id] = self.other_tree
 
 
275
        self._maybe_fetch(self.other_branch,self.this_branch, self.other_basis)
 
 
277
    def set_other_revision(self, revision_id, other_branch):
 
 
278
        """Set 'other' based on a branch and revision id
 
 
280
        :param revision_id: The revision to use for a tree
 
 
281
        :param other_branch: The branch containing this tree
 
 
283
        self.other_rev_id = revision_id
 
 
284
        self.other_branch = other_branch
 
 
285
        self._maybe_fetch(other_branch, self.this_branch, self.other_rev_id)
 
 
286
        self.other_tree = self.revision_tree(revision_id)
 
 
287
        self.other_basis = revision_id
 
 
289
    def set_base_revision(self, revision_id, branch):
 
 
290
        """Set 'base' based on a branch and revision id
 
 
292
        :param revision_id: The revision to use for a tree
 
 
293
        :param branch: The branch containing this tree
 
 
295
        self.base_rev_id = revision_id
 
 
296
        self.base_branch = branch
 
 
297
        self._maybe_fetch(branch, self.this_branch, revision_id)
 
 
298
        self.base_tree = self.revision_tree(revision_id)
 
 
299
        self.base_is_ancestor = is_ancestor(self.this_basis,
 
 
302
        self.base_is_other_ancestor = is_ancestor(self.other_basis,
 
 
306
    def _maybe_fetch(self, source, target, revision_id):
 
 
307
        if (source.repository.bzrdir.root_transport.base !=
 
 
308
            target.repository.bzrdir.root_transport.base):
 
 
309
            target.fetch(source, revision_id)
 
 
312
        this_repo = self.this_branch.repository
 
 
313
        graph = this_repo.get_graph()
 
 
314
        revisions = [ensure_null(self.this_basis),
 
 
315
                     ensure_null(self.other_basis)]
 
 
316
        if NULL_REVISION in revisions:
 
 
317
            self.base_rev_id = NULL_REVISION
 
 
319
            self.base_rev_id = graph.find_unique_lca(*revisions)
 
 
320
            if self.base_rev_id == NULL_REVISION:
 
 
321
                raise UnrelatedBranches()
 
 
322
        self.base_tree = self.revision_tree(self.base_rev_id)
 
 
323
        self.base_is_ancestor = True
 
 
324
        self.base_is_other_ancestor = True
 
 
326
    def set_base(self, base_revision):
 
 
327
        """Set the base revision to use for the merge.
 
 
329
        :param base_revision: A 2-list containing a path and revision number.
 
 
331
        mutter("doing merge() with no base_revision specified")
 
 
332
        if base_revision == [None, None]:
 
 
335
            base_branch, self.base_tree = self._get_tree(base_revision)
 
 
336
            if base_revision[1] == -1:
 
 
337
                self.base_rev_id = base_branch.last_revision()
 
 
338
            elif base_revision[1] is None:
 
 
339
                self.base_rev_id = _mod_revision.NULL_REVISION
 
 
341
                self.base_rev_id = _mod_revision.ensure_null(
 
 
342
                    base_branch.get_rev_id(base_revision[1]))
 
 
343
            self._maybe_fetch(base_branch, self.this_branch, self.base_rev_id)
 
 
344
            self.base_is_ancestor = is_ancestor(self.this_basis, 
 
 
347
            self.base_is_other_ancestor = is_ancestor(self.other_basis,
 
 
352
        kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
 
 
353
                  'other_tree': self.other_tree,
 
 
354
                  'interesting_ids': self.interesting_ids,
 
 
355
                  'interesting_files': self.interesting_files,
 
 
357
        if self.merge_type.requires_base:
 
 
358
            kwargs['base_tree'] = self.base_tree
 
 
359
        if self.merge_type.supports_reprocess:
 
 
360
            kwargs['reprocess'] = self.reprocess
 
 
362
            raise BzrError("Conflict reduction is not supported for merge"
 
 
363
                                  " type %s." % self.merge_type)
 
 
364
        if self.merge_type.supports_show_base:
 
 
365
            kwargs['show_base'] = self.show_base
 
 
367
            raise BzrError("Showing base is not supported for this"
 
 
368
                                  " merge type. %s" % self.merge_type)
 
 
369
        self.this_tree.lock_tree_write()
 
 
370
        if self.base_tree is not None:
 
 
371
            self.base_tree.lock_read()
 
 
372
        if self.other_tree is not None:
 
 
373
            self.other_tree.lock_read()
 
 
375
            merge = self.merge_type(pb=self._pb,
 
 
376
                                    change_reporter=self.change_reporter,
 
 
378
            if self.recurse == 'down':
 
 
379
                for path, file_id in self.this_tree.iter_references():
 
 
380
                    sub_tree = self.this_tree.get_nested_tree(file_id, path)
 
 
381
                    other_revision = self.other_tree.get_reference_revision(
 
 
383
                    if  other_revision == sub_tree.last_revision():
 
 
385
                    sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
 
 
386
                    sub_merge.merge_type = self.merge_type
 
 
387
                    relpath = self.this_tree.relpath(path)
 
 
388
                    other_branch = self.other_branch.reference_parent(file_id, relpath)
 
 
389
                    sub_merge.set_other_revision(other_revision, other_branch)
 
 
390
                    base_revision = self.base_tree.get_reference_revision(file_id)
 
 
391
                    sub_merge.base_tree = \
 
 
392
                        sub_tree.branch.repository.revision_tree(base_revision)
 
 
396
            if self.other_tree is not None:
 
 
397
                self.other_tree.unlock()
 
 
398
            if self.base_tree is not None:
 
 
399
                self.base_tree.unlock()
 
 
400
            self.this_tree.unlock()
 
 
401
        if len(merge.cooked_conflicts) == 0:
 
 
402
            if not self.ignore_zero:
 
 
403
                note("All changes applied successfully.")
 
 
405
            note("%d conflicts encountered." % len(merge.cooked_conflicts))
 
 
407
        return len(merge.cooked_conflicts)
 
 
410
class Merge3Merger(object):
 
 
411
    """Three-way merger that uses the merge3 text merger"""
 
 
413
    supports_reprocess = True
 
 
414
    supports_show_base = True
 
 
415
    history_based = False
 
 
416
    winner_idx = {"this": 2, "other": 1, "conflict": 1}
 
 
418
    def __init__(self, working_tree, this_tree, base_tree, other_tree, 
 
 
419
                 interesting_ids=None, reprocess=False, show_base=False,
 
 
420
                 pb=DummyProgress(), pp=None, change_reporter=None,
 
 
421
                 interesting_files=None):
 
 
422
        """Initialize the merger object and perform the merge.
 
 
424
        :param working_tree: The working tree to apply the merge to
 
 
425
        :param this_tree: The local tree in the merge operation
 
 
426
        :param base_tree: The common tree in the merge operation
 
 
427
        :param other_tree: The other other tree to merge changes from
 
 
428
        :param interesting_ids: The file_ids of files that should be
 
 
429
            participate in the merge.  May not be combined with
 
 
431
        :param: reprocess If True, perform conflict-reduction processing.
 
 
432
        :param show_base: If True, show the base revision in text conflicts.
 
 
433
            (incompatible with reprocess)
 
 
434
        :param pb: A Progress bar
 
 
435
        :param pp: A ProgressPhase object
 
 
436
        :param change_reporter: An object that should report changes made
 
 
437
        :param interesting_files: The tree-relative paths of files that should
 
 
438
            participate in the merge.  If these paths refer to directories,
 
 
439
            the contents of those directories will also be included.  May not
 
 
440
            be combined with interesting_ids.  If neither interesting_files nor
 
 
441
            interesting_ids is specified, all files may participate in the
 
 
444
        object.__init__(self)
 
 
445
        if interesting_files is not None:
 
 
446
            assert interesting_ids is None
 
 
447
        self.interesting_ids = interesting_ids
 
 
448
        self.interesting_files = interesting_files
 
 
449
        self.this_tree = working_tree
 
 
450
        self.this_tree.lock_tree_write()
 
 
451
        self.base_tree = base_tree
 
 
452
        self.base_tree.lock_read()
 
 
453
        self.other_tree = other_tree
 
 
454
        self.other_tree.lock_read()
 
 
455
        self._raw_conflicts = []
 
 
456
        self.cooked_conflicts = []
 
 
457
        self.reprocess = reprocess
 
 
458
        self.show_base = show_base
 
 
461
        self.change_reporter = change_reporter
 
 
463
            self.pp = ProgressPhase("Merge phase", 3, self.pb)
 
 
465
        self.tt = TreeTransform(working_tree, self.pb)
 
 
468
            entries = self._entries3()
 
 
469
            child_pb = ui.ui_factory.nested_progress_bar()
 
 
471
                for num, (file_id, changed, parents3, names3,
 
 
472
                          executable3) in enumerate(entries):
 
 
473
                    child_pb.update('Preparing file merge', num, len(entries))
 
 
474
                    self._merge_names(file_id, parents3, names3)
 
 
476
                        file_status = self.merge_contents(file_id)
 
 
478
                        file_status = 'unmodified'
 
 
479
                    self._merge_executable(file_id,
 
 
480
                        executable3, file_status)
 
 
485
            child_pb = ui.ui_factory.nested_progress_bar()
 
 
487
                fs_conflicts = resolve_conflicts(self.tt, child_pb,
 
 
488
                    lambda t, c: conflict_pass(t, c, self.other_tree))
 
 
491
            if change_reporter is not None:
 
 
492
                from bzrlib import delta
 
 
493
                delta.report_changes(self.tt._iter_changes(), change_reporter)
 
 
494
            self.cook_conflicts(fs_conflicts)
 
 
495
            for conflict in self.cooked_conflicts:
 
 
498
            results = self.tt.apply(no_conflicts=True)
 
 
499
            self.write_modified(results)
 
 
501
                working_tree.add_conflicts(self.cooked_conflicts)
 
 
502
            except UnsupportedOperation:
 
 
506
            self.other_tree.unlock()
 
 
507
            self.base_tree.unlock()
 
 
508
            self.this_tree.unlock()
 
 
512
        """Gather data about files modified between three trees.
 
 
514
        Return a list of tuples of file_id, changed, parents3, names3,
 
 
515
        executable3.  changed is a boolean indicating whether the file contents
 
 
516
        or kind were changed.  parents3 is a tuple of parent ids for base,
 
 
517
        other and this.  names3 is a tuple of names for base, other and this.
 
 
518
        executable3 is a tuple of execute-bit values for base, other and this.
 
 
521
        iterator = self.other_tree._iter_changes(self.base_tree,
 
 
522
                include_unchanged=True, specific_files=self.interesting_files,
 
 
523
                extra_trees=[self.this_tree])
 
 
524
        for (file_id, paths, changed, versioned, parents, names, kind,
 
 
525
             executable) in iterator:
 
 
526
            if (self.interesting_ids is not None and
 
 
527
                file_id not in self.interesting_ids):
 
 
529
            if file_id in self.this_tree.inventory:
 
 
530
                entry = self.this_tree.inventory[file_id]
 
 
531
                this_name = entry.name
 
 
532
                this_parent = entry.parent_id
 
 
533
                this_executable = entry.executable
 
 
537
                this_executable = None
 
 
538
            parents3 = parents + (this_parent,)
 
 
539
            names3 = names + (this_name,)
 
 
540
            executable3 = executable + (this_executable,)
 
 
541
            result.append((file_id, changed, parents3, names3, executable3))
 
 
546
            self.tt.final_kind(self.tt.root)
 
 
548
            self.tt.cancel_deletion(self.tt.root)
 
 
549
        if self.tt.final_file_id(self.tt.root) is None:
 
 
550
            self.tt.version_file(self.tt.tree_file_id(self.tt.root), 
 
 
552
        if self.other_tree.inventory.root is None:
 
 
554
        other_root_file_id = self.other_tree.inventory.root.file_id
 
 
555
        other_root = self.tt.trans_id_file_id(other_root_file_id)
 
 
556
        if other_root == self.tt.root:
 
 
559
            self.tt.final_kind(other_root)
 
 
562
        self.reparent_children(self.other_tree.inventory.root, self.tt.root)
 
 
563
        self.tt.cancel_creation(other_root)
 
 
564
        self.tt.cancel_versioning(other_root)
 
 
566
    def reparent_children(self, ie, target):
 
 
567
        for thing, child in ie.children.iteritems():
 
 
568
            trans_id = self.tt.trans_id_file_id(child.file_id)
 
 
569
            self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
 
 
571
    def write_modified(self, results):
 
 
573
        for path in results.modified_paths:
 
 
574
            file_id = self.this_tree.path2id(self.this_tree.relpath(path))
 
 
577
            hash = self.this_tree.get_file_sha1(file_id)
 
 
580
            modified_hashes[file_id] = hash
 
 
581
        self.this_tree.set_merge_modified(modified_hashes)
 
 
584
    def parent(entry, file_id):
 
 
585
        """Determine the parent for a file_id (used as a key method)"""
 
 
588
        return entry.parent_id
 
 
591
    def name(entry, file_id):
 
 
592
        """Determine the name for a file_id (used as a key method)"""
 
 
598
    def contents_sha1(tree, file_id):
 
 
599
        """Determine the sha1 of the file contents (used as a key method)."""
 
 
600
        if file_id not in tree:
 
 
602
        return tree.get_file_sha1(file_id)
 
 
605
    def executable(tree, file_id):
 
 
606
        """Determine the executability of a file-id (used as a key method)."""
 
 
607
        if file_id not in tree:
 
 
609
        if tree.kind(file_id) != "file":
 
 
611
        return tree.is_executable(file_id)
 
 
614
    def kind(tree, file_id):
 
 
615
        """Determine the kind of a file-id (used as a key method)."""
 
 
616
        if file_id not in tree:
 
 
618
        return tree.kind(file_id)
 
 
621
    def _three_way(base, other, this):
 
 
622
        #if base == other, either they all agree, or only THIS has changed.
 
 
625
        elif this not in (base, other):
 
 
627
        # "Ambiguous clean merge" -- both sides have made the same change.
 
 
630
        # this == base: only other has changed.
 
 
635
    def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
 
 
636
        """Do a three-way test on a scalar.
 
 
637
        Return "this", "other" or "conflict", depending whether a value wins.
 
 
639
        key_base = key(base_tree, file_id)
 
 
640
        key_other = key(other_tree, file_id)
 
 
641
        #if base == other, either they all agree, or only THIS has changed.
 
 
642
        if key_base == key_other:
 
 
644
        key_this = key(this_tree, file_id)
 
 
645
        if key_this not in (key_base, key_other):
 
 
647
        # "Ambiguous clean merge"
 
 
648
        elif key_this == key_other:
 
 
651
            assert key_this == key_base
 
 
654
    def merge_names(self, file_id):
 
 
656
            if file_id in tree.inventory:
 
 
657
                return tree.inventory[file_id]
 
 
660
        this_entry = get_entry(self.this_tree)
 
 
661
        other_entry = get_entry(self.other_tree)
 
 
662
        base_entry = get_entry(self.base_tree)
 
 
663
        entries = (base_entry, other_entry, this_entry)
 
 
666
        for entry in entries:
 
 
671
                names.append(entry.name)
 
 
672
                parents.append(entry.parent_id)
 
 
673
        return self._merge_names(file_id, parents, names)
 
 
675
    def _merge_names(self, file_id, parents, names):
 
 
676
        """Perform a merge on file_id names and parents"""
 
 
677
        base_name, other_name, this_name = names
 
 
678
        base_parent, other_parent, this_parent = parents
 
 
680
        name_winner = self._three_way(*names)
 
 
682
        parent_id_winner = self._three_way(*parents)
 
 
683
        if this_name is None:
 
 
684
            if name_winner == "this":
 
 
685
                name_winner = "other"
 
 
686
            if parent_id_winner == "this":
 
 
687
                parent_id_winner = "other"
 
 
688
        if name_winner == "this" and parent_id_winner == "this":
 
 
690
        if name_winner == "conflict":
 
 
691
            trans_id = self.tt.trans_id_file_id(file_id)
 
 
692
            self._raw_conflicts.append(('name conflict', trans_id, 
 
 
693
                                        this_name, other_name))
 
 
694
        if parent_id_winner == "conflict":
 
 
695
            trans_id = self.tt.trans_id_file_id(file_id)
 
 
696
            self._raw_conflicts.append(('parent conflict', trans_id, 
 
 
697
                                        this_parent, other_parent))
 
 
698
        if other_name is None:
 
 
699
            # it doesn't matter whether the result was 'other' or 
 
 
700
            # 'conflict'-- if there's no 'other', we leave it alone.
 
 
702
        # if we get here, name_winner and parent_winner are set to safe values.
 
 
703
        trans_id = self.tt.trans_id_file_id(file_id)
 
 
704
        parent_id = parents[self.winner_idx[parent_id_winner]]
 
 
705
        if parent_id is not None:
 
 
706
            parent_trans_id = self.tt.trans_id_file_id(parent_id)
 
 
707
            self.tt.adjust_path(names[self.winner_idx[name_winner]],
 
 
708
                                parent_trans_id, trans_id)
 
 
710
    def merge_contents(self, file_id):
 
 
711
        """Performa a merge on file_id contents."""
 
 
712
        def contents_pair(tree):
 
 
713
            if file_id not in tree:
 
 
715
            kind = tree.kind(file_id)
 
 
717
                contents = tree.get_file_sha1(file_id)
 
 
718
            elif kind == "symlink":
 
 
719
                contents = tree.get_symlink_target(file_id)
 
 
722
            return kind, contents
 
 
724
        def contents_conflict():
 
 
725
            trans_id = self.tt.trans_id_file_id(file_id)
 
 
726
            name = self.tt.final_name(trans_id)
 
 
727
            parent_id = self.tt.final_parent(trans_id)
 
 
728
            if file_id in self.this_tree.inventory:
 
 
729
                self.tt.unversion_file(trans_id)
 
 
730
                if file_id in self.this_tree:
 
 
731
                    self.tt.delete_contents(trans_id)
 
 
732
            file_group = self._dump_conflicts(name, parent_id, file_id, 
 
 
734
            self._raw_conflicts.append(('contents conflict', file_group))
 
 
736
        # See SPOT run.  run, SPOT, run.
 
 
737
        # So we're not QUITE repeating ourselves; we do tricky things with
 
 
739
        base_pair = contents_pair(self.base_tree)
 
 
740
        other_pair = contents_pair(self.other_tree)
 
 
741
        if base_pair == other_pair:
 
 
742
            # OTHER introduced no changes
 
 
744
        this_pair = contents_pair(self.this_tree)
 
 
745
        if this_pair == other_pair:
 
 
746
            # THIS and OTHER introduced the same changes
 
 
749
            trans_id = self.tt.trans_id_file_id(file_id)
 
 
750
            if this_pair == base_pair:
 
 
751
                # only OTHER introduced changes
 
 
752
                if file_id in self.this_tree:
 
 
753
                    # Remove any existing contents
 
 
754
                    self.tt.delete_contents(trans_id)
 
 
755
                if file_id in self.other_tree:
 
 
756
                    # OTHER changed the file
 
 
757
                    create_by_entry(self.tt, 
 
 
758
                                    self.other_tree.inventory[file_id], 
 
 
759
                                    self.other_tree, trans_id)
 
 
760
                    if file_id not in self.this_tree.inventory:
 
 
761
                        self.tt.version_file(file_id, trans_id)
 
 
763
                elif file_id in self.this_tree.inventory:
 
 
764
                    # OTHER deleted the file
 
 
765
                    self.tt.unversion_file(trans_id)
 
 
767
            #BOTH THIS and OTHER introduced changes; scalar conflict
 
 
768
            elif this_pair[0] == "file" and other_pair[0] == "file":
 
 
769
                # THIS and OTHER are both files, so text merge.  Either
 
 
770
                # BASE is a file, or both converted to files, so at least we
 
 
771
                # have agreement that output should be a file.
 
 
773
                    self.text_merge(file_id, trans_id)
 
 
775
                    return contents_conflict()
 
 
776
                if file_id not in self.this_tree.inventory:
 
 
777
                    self.tt.version_file(file_id, trans_id)
 
 
779
                    self.tt.tree_kind(trans_id)
 
 
780
                    self.tt.delete_contents(trans_id)
 
 
785
                # Scalar conflict, can't text merge.  Dump conflicts
 
 
786
                return contents_conflict()
 
 
788
    def get_lines(self, tree, file_id):
 
 
789
        """Return the lines in a file, or an empty list."""
 
 
791
            return tree.get_file(file_id).readlines()
 
 
795
    def text_merge(self, file_id, trans_id):
 
 
796
        """Perform a three-way text merge on a file_id"""
 
 
797
        # it's possible that we got here with base as a different type.
 
 
798
        # if so, we just want two-way text conflicts.
 
 
799
        if file_id in self.base_tree and \
 
 
800
            self.base_tree.kind(file_id) == "file":
 
 
801
            base_lines = self.get_lines(self.base_tree, file_id)
 
 
804
        other_lines = self.get_lines(self.other_tree, file_id)
 
 
805
        this_lines = self.get_lines(self.this_tree, file_id)
 
 
806
        m3 = Merge3(base_lines, this_lines, other_lines)
 
 
807
        start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
 
 
808
        if self.show_base is True:
 
 
809
            base_marker = '|' * 7
 
 
813
        def iter_merge3(retval):
 
 
814
            retval["text_conflicts"] = False
 
 
815
            for line in m3.merge_lines(name_a = "TREE", 
 
 
816
                                       name_b = "MERGE-SOURCE", 
 
 
817
                                       name_base = "BASE-REVISION",
 
 
818
                                       start_marker=start_marker, 
 
 
819
                                       base_marker=base_marker,
 
 
820
                                       reprocess=self.reprocess):
 
 
821
                if line.startswith(start_marker):
 
 
822
                    retval["text_conflicts"] = True
 
 
823
                    yield line.replace(start_marker, '<' * 7)
 
 
827
        merge3_iterator = iter_merge3(retval)
 
 
828
        self.tt.create_file(merge3_iterator, trans_id)
 
 
829
        if retval["text_conflicts"] is True:
 
 
830
            self._raw_conflicts.append(('text conflict', trans_id))
 
 
831
            name = self.tt.final_name(trans_id)
 
 
832
            parent_id = self.tt.final_parent(trans_id)
 
 
833
            file_group = self._dump_conflicts(name, parent_id, file_id, 
 
 
834
                                              this_lines, base_lines,
 
 
836
            file_group.append(trans_id)
 
 
838
    def _dump_conflicts(self, name, parent_id, file_id, this_lines=None, 
 
 
839
                        base_lines=None, other_lines=None, set_version=False,
 
 
841
        """Emit conflict files.
 
 
842
        If this_lines, base_lines, or other_lines are omitted, they will be
 
 
843
        determined automatically.  If set_version is true, the .OTHER, .THIS
 
 
844
        or .BASE (in that order) will be created as versioned files.
 
 
846
        data = [('OTHER', self.other_tree, other_lines), 
 
 
847
                ('THIS', self.this_tree, this_lines)]
 
 
849
            data.append(('BASE', self.base_tree, base_lines))
 
 
852
        for suffix, tree, lines in data:
 
 
854
                trans_id = self._conflict_file(name, parent_id, tree, file_id,
 
 
856
                file_group.append(trans_id)
 
 
857
                if set_version and not versioned:
 
 
858
                    self.tt.version_file(file_id, trans_id)
 
 
862
    def _conflict_file(self, name, parent_id, tree, file_id, suffix, 
 
 
864
        """Emit a single conflict file."""
 
 
865
        name = name + '.' + suffix
 
 
866
        trans_id = self.tt.create_path(name, parent_id)
 
 
867
        entry = tree.inventory[file_id]
 
 
868
        create_by_entry(self.tt, entry, tree, trans_id, lines)
 
 
871
    def merge_executable(self, file_id, file_status):
 
 
872
        """Perform a merge on the execute bit."""
 
 
873
        executable = [self.executable(t, file_id) for t in (self.base_tree,
 
 
874
                      self.other_tree, self.this_tree)]
 
 
875
        self._merge_executable(file_id, executable, file_status)
 
 
877
    def _merge_executable(self, file_id, executable, file_status):
 
 
878
        """Perform a merge on the execute bit."""
 
 
879
        base_executable, other_executable, this_executable = executable
 
 
880
        if file_status == "deleted":
 
 
882
        trans_id = self.tt.trans_id_file_id(file_id)
 
 
884
            if self.tt.final_kind(trans_id) != "file":
 
 
888
        winner = self._three_way(*executable)
 
 
889
        if winner == "conflict":
 
 
890
        # There must be a None in here, if we have a conflict, but we
 
 
891
        # need executability since file status was not deleted.
 
 
892
            if self.executable(self.other_tree, file_id) is None:
 
 
897
            if file_status == "modified":
 
 
898
                executability = this_executable
 
 
899
                if executability is not None:
 
 
900
                    trans_id = self.tt.trans_id_file_id(file_id)
 
 
901
                    self.tt.set_executability(executability, trans_id)
 
 
903
            assert winner == "other"
 
 
904
            if file_id in self.other_tree:
 
 
905
                executability = other_executable
 
 
906
            elif file_id in self.this_tree:
 
 
907
                executability = this_executable
 
 
908
            elif file_id in self.base_tree:
 
 
909
                executability = base_executable
 
 
910
            if executability is not None:
 
 
911
                trans_id = self.tt.trans_id_file_id(file_id)
 
 
912
                self.tt.set_executability(executability, trans_id)
 
 
914
    def cook_conflicts(self, fs_conflicts):
 
 
915
        """Convert all conflicts into a form that doesn't depend on trans_id"""
 
 
916
        from conflicts import Conflict
 
 
918
        self.cooked_conflicts.extend(cook_conflicts(fs_conflicts, self.tt))
 
 
919
        fp = FinalPaths(self.tt)
 
 
920
        for conflict in self._raw_conflicts:
 
 
921
            conflict_type = conflict[0]
 
 
922
            if conflict_type in ('name conflict', 'parent conflict'):
 
 
923
                trans_id = conflict[1]
 
 
924
                conflict_args = conflict[2:]
 
 
925
                if trans_id not in name_conflicts:
 
 
926
                    name_conflicts[trans_id] = {}
 
 
927
                unique_add(name_conflicts[trans_id], conflict_type, 
 
 
929
            if conflict_type == 'contents conflict':
 
 
930
                for trans_id in conflict[1]:
 
 
931
                    file_id = self.tt.final_file_id(trans_id)
 
 
932
                    if file_id is not None:
 
 
934
                path = fp.get_path(trans_id)
 
 
935
                for suffix in ('.BASE', '.THIS', '.OTHER'):
 
 
936
                    if path.endswith(suffix):
 
 
937
                        path = path[:-len(suffix)]
 
 
939
                c = Conflict.factory(conflict_type, path=path, file_id=file_id)
 
 
940
                self.cooked_conflicts.append(c)
 
 
941
            if conflict_type == 'text conflict':
 
 
942
                trans_id = conflict[1]
 
 
943
                path = fp.get_path(trans_id)
 
 
944
                file_id = self.tt.final_file_id(trans_id)
 
 
945
                c = Conflict.factory(conflict_type, path=path, file_id=file_id)
 
 
946
                self.cooked_conflicts.append(c)
 
 
948
        for trans_id, conflicts in name_conflicts.iteritems():
 
 
950
                this_parent, other_parent = conflicts['parent conflict']
 
 
951
                assert this_parent != other_parent
 
 
953
                this_parent = other_parent = \
 
 
954
                    self.tt.final_file_id(self.tt.final_parent(trans_id))
 
 
956
                this_name, other_name = conflicts['name conflict']
 
 
957
                assert this_name != other_name
 
 
959
                this_name = other_name = self.tt.final_name(trans_id)
 
 
960
            other_path = fp.get_path(trans_id)
 
 
961
            if this_parent is not None and this_name is not None:
 
 
963
                    fp.get_path(self.tt.trans_id_file_id(this_parent))
 
 
964
                this_path = pathjoin(this_parent_path, this_name)
 
 
966
                this_path = "<deleted>"
 
 
967
            file_id = self.tt.final_file_id(trans_id)
 
 
968
            c = Conflict.factory('path conflict', path=this_path,
 
 
969
                                 conflict_path=other_path, file_id=file_id)
 
 
970
            self.cooked_conflicts.append(c)
 
 
971
        self.cooked_conflicts.sort(key=Conflict.sort_key)
 
 
974
class WeaveMerger(Merge3Merger):
 
 
975
    """Three-way tree merger, text weave merger."""
 
 
976
    supports_reprocess = True
 
 
977
    supports_show_base = False
 
 
979
    def __init__(self, working_tree, this_tree, base_tree, other_tree, 
 
 
980
                 interesting_ids=None, pb=DummyProgress(), pp=None,
 
 
981
                 reprocess=False, change_reporter=None,
 
 
982
                 interesting_files=None):
 
 
983
        super(WeaveMerger, self).__init__(working_tree, this_tree, 
 
 
984
                                          base_tree, other_tree, 
 
 
985
                                          interesting_ids=interesting_ids, 
 
 
986
                                          pb=pb, pp=pp, reprocess=reprocess,
 
 
987
                                          change_reporter=change_reporter)
 
 
989
    def _merged_lines(self, file_id):
 
 
990
        """Generate the merged lines.
 
 
991
        There is no distinction between lines that are meant to contain <<<<<<<
 
 
994
        plan = self.this_tree.plan_file_merge(file_id, self.other_tree)
 
 
995
        textmerge = PlanWeaveMerge(plan, '<<<<<<< TREE\n',
 
 
996
            '>>>>>>> MERGE-SOURCE\n')
 
 
997
        return textmerge.merge_lines(self.reprocess)
 
 
999
    def text_merge(self, file_id, trans_id):
 
 
1000
        """Perform a (weave) text merge for a given file and file-id.
 
 
1001
        If conflicts are encountered, .THIS and .OTHER files will be emitted,
 
 
1002
        and a conflict will be noted.
 
 
1004
        lines, conflicts = self._merged_lines(file_id)
 
 
1006
        # Note we're checking whether the OUTPUT is binary in this case, 
 
 
1007
        # because we don't want to get into weave merge guts.
 
 
1008
        check_text_lines(lines)
 
 
1009
        self.tt.create_file(lines, trans_id)
 
 
1011
            self._raw_conflicts.append(('text conflict', trans_id))
 
 
1012
            name = self.tt.final_name(trans_id)
 
 
1013
            parent_id = self.tt.final_parent(trans_id)
 
 
1014
            file_group = self._dump_conflicts(name, parent_id, file_id, 
 
 
1016
            file_group.append(trans_id)
 
 
1019
class Diff3Merger(Merge3Merger):
 
 
1020
    """Three-way merger using external diff3 for text merging"""
 
 
1022
    def dump_file(self, temp_dir, name, tree, file_id):
 
 
1023
        out_path = pathjoin(temp_dir, name)
 
 
1024
        out_file = open(out_path, "wb")
 
 
1026
            in_file = tree.get_file(file_id)
 
 
1027
            for line in in_file:
 
 
1028
                out_file.write(line)
 
 
1033
    def text_merge(self, file_id, trans_id):
 
 
1034
        """Perform a diff3 merge using a specified file-id and trans-id.
 
 
1035
        If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
 
 
1036
        will be dumped, and a will be conflict noted.
 
 
1039
        temp_dir = osutils.mkdtemp(prefix="bzr-")
 
 
1041
            new_file = pathjoin(temp_dir, "new")
 
 
1042
            this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
 
 
1043
            base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
 
 
1044
            other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
 
 
1045
            status = bzrlib.patch.diff3(new_file, this, base, other)
 
 
1046
            if status not in (0, 1):
 
 
1047
                raise BzrError("Unhandled diff3 exit code")
 
 
1048
            f = open(new_file, 'rb')
 
 
1050
                self.tt.create_file(f, trans_id)
 
 
1054
                name = self.tt.final_name(trans_id)
 
 
1055
                parent_id = self.tt.final_parent(trans_id)
 
 
1056
                self._dump_conflicts(name, parent_id, file_id)
 
 
1057
                self._raw_conflicts.append(('text conflict', trans_id))
 
 
1059
            osutils.rmtree(temp_dir)
 
 
1062
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
 
 
1064
                merge_type=Merge3Merger,
 
 
1065
                interesting_ids=None,
 
 
1069
                interesting_files=None,
 
 
1072
                change_reporter=None):
 
 
1073
    """Primary interface for merging. 
 
 
1075
        typical use is probably 
 
 
1076
        'merge_inner(branch, branch.get_revision_tree(other_revision),
 
 
1077
                     branch.get_revision_tree(base_revision))'
 
 
1079
    if this_tree is None:
 
 
1080
        raise BzrError("bzrlib.merge.merge_inner requires a this_tree "
 
 
1081
            "parameter as of bzrlib version 0.8.")
 
 
1082
    merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
 
 
1083
                    pb=pb, change_reporter=change_reporter)
 
 
1084
    merger.backup_files = backup_files
 
 
1085
    merger.merge_type = merge_type
 
 
1086
    merger.interesting_ids = interesting_ids
 
 
1087
    merger.ignore_zero = ignore_zero
 
 
1088
    if interesting_files:
 
 
1089
        assert not interesting_ids, ('Only supply interesting_ids'
 
 
1090
                                     ' or interesting_files')
 
 
1091
        merger.interesting_files = interesting_files
 
 
1092
    merger.show_base = show_base
 
 
1093
    merger.reprocess = reprocess
 
 
1094
    merger.other_rev_id = other_rev_id
 
 
1095
    merger.other_basis = other_rev_id
 
 
1096
    return merger.do_merge()
 
 
1098
def get_merge_type_registry():
 
 
1099
    """Merge type registry is in bzrlib.option to avoid circular imports.
 
 
1101
    This method provides a sanctioned way to retrieve it.
 
 
1103
    from bzrlib import option
 
 
1104
    return option._merge_type_registry
 
 
1107
def _plan_annotate_merge(annotated_a, annotated_b, ancestors_a, ancestors_b):
 
 
1108
    def status_a(revision, text):
 
 
1109
        if revision in ancestors_b:
 
 
1110
            return 'killed-b', text
 
 
1112
            return 'new-a', text
 
 
1114
    def status_b(revision, text):
 
 
1115
        if revision in ancestors_a:
 
 
1116
            return 'killed-a', text
 
 
1118
            return 'new-b', text
 
 
1120
    plain_a = [t for (a, t) in annotated_a]
 
 
1121
    plain_b = [t for (a, t) in annotated_b]
 
 
1122
    matcher = patiencediff.PatienceSequenceMatcher(None, plain_a, plain_b)
 
 
1123
    blocks = matcher.get_matching_blocks()
 
 
1126
    for ai, bi, l in blocks:
 
 
1127
        # process all mismatched sections
 
 
1128
        # (last mismatched section is handled because blocks always
 
 
1129
        # includes a 0-length last block)
 
 
1130
        for revision, text in annotated_a[a_cur:ai]:
 
 
1131
            yield status_a(revision, text)
 
 
1132
        for revision, text in annotated_b[b_cur:bi]:
 
 
1133
            yield status_b(revision, text)
 
 
1135
        # and now the matched section
 
 
1138
        for text_a, text_b in zip(plain_a[ai:a_cur], plain_b[bi:b_cur]):
 
 
1139
            assert text_a == text_b
 
 
1140
            yield "unchanged", text_a