/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-11-18 06:18:14 UTC
  • mfrom: (4634.97.5 doc-2.0)
  • Revision ID: pqm@pqm.ubuntu.com-20091118061814-695imx80olc79o7l
(mbp, trivial) additional doc building fix

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
from merge_core import merge_flex, ApplyMerge3, BackupBeforeChange
2
 
from changeset import generate_changeset, ExceptionConflictHandler
3
 
from changeset import Inventory, Diff3Merge
4
 
from bzrlib import find_branch
5
 
import bzrlib.osutils
6
 
from bzrlib.errors import BzrCommandError
7
 
from bzrlib.delta import compare_trees
8
 
from trace import mutter, warning
9
 
import os.path
10
 
import tempfile
11
 
import shutil
12
 
import errno
13
 
 
14
 
class UnrelatedBranches(BzrCommandError):
15
 
    def __init__(self):
16
 
        msg = "Branches have no common ancestor, and no base revision"\
17
 
            " specified."
18
 
        BzrCommandError.__init__(self, msg)
19
 
 
20
 
 
21
 
class MergeConflictHandler(ExceptionConflictHandler):
22
 
    """Handle conflicts encountered while merging"""
23
 
    def __init__(self, dir, ignore_zero=False):
24
 
        ExceptionConflictHandler.__init__(self, dir)
25
 
        self.conflicts = 0
26
 
        self.ignore_zero = ignore_zero
27
 
 
28
 
    def copy(self, source, dest):
29
 
        """Copy the text and mode of a file
30
 
        :param source: The path of the file to copy
31
 
        :param dest: The distination file to create
32
 
        """
33
 
        s_file = file(source, "rb")
34
 
        d_file = file(dest, "wb")
35
 
        for line in s_file:
36
 
            d_file.write(line)
37
 
        os.chmod(dest, 0777 & os.stat(source).st_mode)
38
 
 
39
 
    def add_suffix(self, name, suffix, last_new_name=None):
40
 
        """Rename a file to append a suffix.  If the new name exists, the
41
 
        suffix is added repeatedly until a non-existant name is found
42
 
 
43
 
        :param name: The path of the file
44
 
        :param suffix: The suffix to append
45
 
        :param last_new_name: (used for recursive calls) the last name tried
46
 
        """
47
 
        if last_new_name is None:
48
 
            last_new_name = name
49
 
        new_name = last_new_name+suffix
50
 
        try:
51
 
            os.rename(name, new_name)
52
 
            return new_name
53
 
        except OSError, e:
54
 
            if e.errno != errno.EEXIST and e.errno != errno.ENOTEMPTY:
55
 
                raise
56
 
            return self.add_suffix(name, suffix, last_new_name=new_name)
57
 
 
58
 
    def conflict(self, text):
59
 
        warning(text)
60
 
        self.conflicts += 1
61
 
        
62
 
 
63
 
    def merge_conflict(self, new_file, this_path, base_path, other_path):
64
 
        """
65
 
        Handle diff3 conflicts by producing a .THIS, .BASE and .OTHER.  The
66
 
        main file will be a version with diff3 conflicts.
67
 
        :param new_file: Path to the output file with diff3 markers
68
 
        :param this_path: Path to the file text for the THIS tree
69
 
        :param base_path: Path to the file text for the BASE tree
70
 
        :param other_path: Path to the file text for the OTHER tree
71
 
        """
72
 
        self.add_suffix(this_path, ".THIS")
73
 
        self.copy(base_path, this_path+".BASE")
74
 
        self.copy(other_path, this_path+".OTHER")
75
 
        os.rename(new_file, this_path)
76
 
        self.conflict("Diff3 conflict encountered in %s" % this_path)
77
 
 
78
 
    def target_exists(self, entry, target, old_path):
79
 
        """Handle the case when the target file or dir exists"""
80
 
        moved_path = self.add_suffix(target, ".moved")
81
 
        self.conflict("Moved existing %s to %s" % (target, moved_path))
82
 
 
83
 
    def rmdir_non_empty(self, filename):
84
 
        """Handle the case where the dir to be removed still has contents"""
85
 
        self.conflict("Directory %s not removed because it is not empty"\
86
 
            % filename)
87
 
        return "skip"
88
 
 
89
 
    def finalize(self):
90
 
        if not self.ignore_zero:
91
 
            print "%d conflicts encountered.\n" % self.conflicts
92
 
            
93
 
class SourceFile(object):
94
 
    def __init__(self, path, id, present=None, isdir=None):
95
 
        self.path = path
96
 
        self.id = id
97
 
        self.present = present
98
 
        self.isdir = isdir
99
 
        self.interesting = True
100
 
 
101
 
    def __repr__(self):
102
 
        return "SourceFile(%s, %s)" % (self.path, self.id)
103
 
 
104
 
def get_tree(treespec, temp_root, label):
105
 
    location, revno = treespec
106
 
    branch = find_branch(location)
107
 
    if revno is None:
108
 
        base_tree = branch.working_tree()
109
 
    elif revno == -1:
110
 
        base_tree = branch.basis_tree()
111
 
    else:
112
 
        base_tree = branch.revision_tree(branch.lookup_revision(revno))
113
 
    temp_path = os.path.join(temp_root, label)
114
 
    os.mkdir(temp_path)
115
 
    return branch, MergeTree(base_tree, temp_path)
116
 
 
117
 
 
118
 
def abspath(tree, file_id):
119
 
    path = tree.inventory.id2path(file_id)
120
 
    if path == "":
121
 
        return "./."
122
 
    return "./" + path
123
 
 
124
 
def file_exists(tree, file_id):
125
 
    return tree.has_filename(tree.id2path(file_id))
126
 
    
127
 
def inventory_map(tree):
128
 
    inventory = {}
129
 
    for file_id in tree.inventory:
130
 
        path = abspath(tree, file_id)
131
 
        inventory[path] = SourceFile(path, file_id)
132
 
    return inventory
133
 
 
134
 
 
135
 
class MergeTree(object):
136
 
    def __init__(self, tree, tempdir):
137
 
        object.__init__(self)
138
 
        if hasattr(tree, "basedir"):
139
 
            self.root = tree.basedir
140
 
        else:
141
 
            self.root = None
142
 
        self.inventory = inventory_map(tree)
143
 
        self.tree = tree
144
 
        self.tempdir = tempdir
145
 
        os.mkdir(os.path.join(self.tempdir, "texts"))
146
 
        self.cached = {}
147
 
 
148
 
    def readonly_path(self, id):
149
 
        if id not in self.tree:
150
 
            return None
151
 
        if self.root is not None:
152
 
            return self.tree.abspath(self.tree.id2path(id))
153
 
        else:
154
 
            if self.tree.inventory[id].kind in ("directory", "root_directory"):
155
 
                return self.tempdir
156
 
            if not self.cached.has_key(id):
157
 
                path = os.path.join(self.tempdir, "texts", id)
158
 
                outfile = file(path, "wb")
159
 
                outfile.write(self.tree.get_file(id).read())
160
 
                assert(os.path.exists(path))
161
 
                self.cached[id] = path
162
 
            return self.cached[id]
163
 
 
164
 
 
165
 
 
166
 
def merge(other_revision, base_revision,
167
 
          check_clean=True, ignore_zero=False,
168
 
          this_dir=None, backup_files=False, merge_type=ApplyMerge3,
169
 
          file_list=None):
170
 
    """Merge changes into a tree.
171
 
 
172
 
    base_revision
173
 
        Base for three-way merge.
174
 
    other_revision
175
 
        Other revision for three-way merge.
176
 
    this_dir
177
 
        Directory to merge changes into; '.' by default.
178
 
    check_clean
179
 
        If true, this_dir must have no uncommitted changes before the
180
 
        merge begins.
181
 
    """
182
 
    tempdir = tempfile.mkdtemp(prefix="bzr-")
 
1
# Copyright (C) 2005, 2006, 2008 Canonical Ltd
 
2
#
 
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.
 
7
#
 
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.
 
12
#
 
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
 
 
18
from bzrlib import (
 
19
    branch as _mod_branch,
 
20
    conflicts as _mod_conflicts,
 
21
    debug,
 
22
    errors,
 
23
    graph as _mod_graph,
 
24
    merge3,
 
25
    osutils,
 
26
    patiencediff,
 
27
    progress,
 
28
    registry,
 
29
    revision as _mod_revision,
 
30
    textfile,
 
31
    trace,
 
32
    transform,
 
33
    tree as _mod_tree,
 
34
    tsort,
 
35
    ui,
 
36
    versionedfile
 
37
    )
 
38
from bzrlib.symbol_versioning import (
 
39
    deprecated_in,
 
40
    deprecated_method,
 
41
    )
 
42
# TODO: Report back as changes are merged in
 
43
 
 
44
 
 
45
def transform_tree(from_tree, to_tree, interesting_ids=None):
 
46
    from_tree.lock_tree_write()
183
47
    try:
184
 
        if this_dir is None:
185
 
            this_dir = '.'
186
 
        this_branch = find_branch(this_dir)
 
48
        merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
 
49
                    interesting_ids=interesting_ids, this_tree=from_tree)
 
50
    finally:
 
51
        from_tree.unlock()
 
52
 
 
53
 
 
54
class Merger(object):
 
55
    def __init__(self, this_branch, other_tree=None, base_tree=None,
 
56
                 this_tree=None, pb=None, change_reporter=None,
 
57
                 recurse='down', revision_graph=None):
 
58
        object.__init__(self)
 
59
        self.this_branch = this_branch
 
60
        self.this_basis = _mod_revision.ensure_null(
 
61
            this_branch.last_revision())
 
62
        self.this_rev_id = None
 
63
        self.this_tree = this_tree
 
64
        self.this_revision_tree = None
 
65
        self.this_basis_tree = None
 
66
        self.other_tree = other_tree
 
67
        self.other_branch = None
 
68
        self.base_tree = base_tree
 
69
        self.ignore_zero = False
 
70
        self.backup_files = False
 
71
        self.interesting_ids = None
 
72
        self.interesting_files = None
 
73
        self.show_base = False
 
74
        self.reprocess = False
 
75
        if pb is None:
 
76
            pb = progress.DummyProgress()
 
77
        self._pb = pb
 
78
        self.pp = None
 
79
        self.recurse = recurse
 
80
        self.change_reporter = change_reporter
 
81
        self._cached_trees = {}
 
82
        self._revision_graph = revision_graph
 
83
        self._base_is_ancestor = None
 
84
        self._base_is_other_ancestor = None
 
85
        self._is_criss_cross = None
 
86
        self._lca_trees = None
 
87
 
 
88
    def cache_trees_with_revision_ids(self, trees):
 
89
        """Cache any tree in trees if it has a revision_id."""
 
90
        for maybe_tree in trees:
 
91
            if maybe_tree is None:
 
92
                continue
 
93
            try:
 
94
                rev_id = maybe_tree.get_revision_id()
 
95
            except AttributeError:
 
96
                continue
 
97
            self._cached_trees[rev_id] = maybe_tree
 
98
 
 
99
    @property
 
100
    def revision_graph(self):
 
101
        if self._revision_graph is None:
 
102
            self._revision_graph = self.this_branch.repository.get_graph()
 
103
        return self._revision_graph
 
104
 
 
105
    def _set_base_is_ancestor(self, value):
 
106
        self._base_is_ancestor = value
 
107
 
 
108
    def _get_base_is_ancestor(self):
 
109
        if self._base_is_ancestor is None:
 
110
            self._base_is_ancestor = self.revision_graph.is_ancestor(
 
111
                self.base_rev_id, self.this_basis)
 
112
        return self._base_is_ancestor
 
113
 
 
114
    base_is_ancestor = property(_get_base_is_ancestor, _set_base_is_ancestor)
 
115
 
 
116
    def _set_base_is_other_ancestor(self, value):
 
117
        self._base_is_other_ancestor = value
 
118
 
 
119
    def _get_base_is_other_ancestor(self):
 
120
        if self._base_is_other_ancestor is None:
 
121
            if self.other_basis is None:
 
122
                return True
 
123
            self._base_is_other_ancestor = self.revision_graph.is_ancestor(
 
124
                self.base_rev_id, self.other_basis)
 
125
        return self._base_is_other_ancestor
 
126
 
 
127
    base_is_other_ancestor = property(_get_base_is_other_ancestor,
 
128
                                      _set_base_is_other_ancestor)
 
129
 
 
130
    @staticmethod
 
131
    def from_uncommitted(tree, other_tree, pb=None, base_tree=None):
 
132
        """Return a Merger for uncommitted changes in other_tree.
 
133
 
 
134
        :param tree: The tree to merge into
 
135
        :param other_tree: The tree to get uncommitted changes from
 
136
        :param pb: A progress indicator
 
137
        :param base_tree: The basis to use for the merge.  If unspecified,
 
138
            other_tree.basis_tree() will be used.
 
139
        """
 
140
        if base_tree is None:
 
141
            base_tree = other_tree.basis_tree()
 
142
        merger = Merger(tree.branch, other_tree, base_tree, tree, pb)
 
143
        merger.base_rev_id = merger.base_tree.get_revision_id()
 
144
        merger.other_rev_id = None
 
145
        merger.other_basis = merger.base_rev_id
 
146
        return merger
 
147
 
 
148
    @classmethod
 
149
    def from_mergeable(klass, tree, mergeable, pb):
 
150
        """Return a Merger for a bundle or merge directive.
 
151
 
 
152
        :param tree: The tree to merge changes into
 
153
        :param mergeable: A merge directive or bundle
 
154
        :param pb: A progress indicator
 
155
        """
 
156
        mergeable.install_revisions(tree.branch.repository)
 
157
        base_revision_id, other_revision_id, verified =\
 
158
            mergeable.get_merge_request(tree.branch.repository)
 
159
        revision_graph = tree.branch.repository.get_graph()
 
160
        if base_revision_id is not None:
 
161
            if (base_revision_id != _mod_revision.NULL_REVISION and
 
162
                revision_graph.is_ancestor(
 
163
                base_revision_id, tree.branch.last_revision())):
 
164
                base_revision_id = None
 
165
            else:
 
166
                trace.warning('Performing cherrypick')
 
167
        merger = klass.from_revision_ids(pb, tree, other_revision_id,
 
168
                                         base_revision_id, revision_graph=
 
169
                                         revision_graph)
 
170
        return merger, verified
 
171
 
 
172
    @staticmethod
 
173
    def from_revision_ids(pb, tree, other, base=None, other_branch=None,
 
174
                          base_branch=None, revision_graph=None,
 
175
                          tree_branch=None):
 
176
        """Return a Merger for revision-ids.
 
177
 
 
178
        :param pb: A progress indicator
 
179
        :param tree: The tree to merge changes into
 
180
        :param other: The revision-id to use as OTHER
 
181
        :param base: The revision-id to use as BASE.  If not specified, will
 
182
            be auto-selected.
 
183
        :param other_branch: A branch containing the other revision-id.  If
 
184
            not supplied, tree.branch is used.
 
185
        :param base_branch: A branch containing the base revision-id.  If
 
186
            not supplied, other_branch or tree.branch will be used.
 
187
        :param revision_graph: If you have a revision_graph precomputed, pass
 
188
            it in, otherwise it will be created for you.
 
189
        :param tree_branch: The branch associated with tree.  If not supplied,
 
190
            tree.branch will be used.
 
191
        """
 
192
        if tree_branch is None:
 
193
            tree_branch = tree.branch
 
194
        merger = Merger(tree_branch, this_tree=tree, pb=pb,
 
195
                        revision_graph=revision_graph)
 
196
        if other_branch is None:
 
197
            other_branch = tree.branch
 
198
        merger.set_other_revision(other, other_branch)
 
199
        if base is None:
 
200
            merger.find_base()
 
201
        else:
 
202
            if base_branch is None:
 
203
                base_branch = other_branch
 
204
            merger.set_base_revision(base, base_branch)
 
205
        return merger
 
206
 
 
207
    def revision_tree(self, revision_id, branch=None):
 
208
        if revision_id not in self._cached_trees:
 
209
            if branch is None:
 
210
                branch = self.this_branch
 
211
            try:
 
212
                tree = self.this_tree.revision_tree(revision_id)
 
213
            except errors.NoSuchRevisionInTree:
 
214
                tree = branch.repository.revision_tree(revision_id)
 
215
            self._cached_trees[revision_id] = tree
 
216
        return self._cached_trees[revision_id]
 
217
 
 
218
    def _get_tree(self, treespec, possible_transports=None):
 
219
        from bzrlib import workingtree
 
220
        location, revno = treespec
 
221
        if revno is None:
 
222
            tree = workingtree.WorkingTree.open_containing(location)[0]
 
223
            return tree.branch, tree
 
224
        branch = _mod_branch.Branch.open_containing(
 
225
            location, possible_transports)[0]
 
226
        if revno == -1:
 
227
            revision_id = branch.last_revision()
 
228
        else:
 
229
            revision_id = branch.get_rev_id(revno)
 
230
        revision_id = _mod_revision.ensure_null(revision_id)
 
231
        return branch, self.revision_tree(revision_id, branch)
 
232
 
 
233
    @deprecated_method(deprecated_in((2, 1, 0)))
 
234
    def ensure_revision_trees(self):
 
235
        if self.this_revision_tree is None:
 
236
            self.this_basis_tree = self.revision_tree(self.this_basis)
 
237
            if self.this_basis == self.this_rev_id:
 
238
                self.this_revision_tree = self.this_basis_tree
 
239
 
 
240
        if self.other_rev_id is None:
 
241
            other_basis_tree = self.revision_tree(self.other_basis)
 
242
            if other_basis_tree.has_changes(self.other_tree):
 
243
                raise WorkingTreeNotRevision(self.this_tree)
 
244
            other_rev_id = self.other_basis
 
245
            self.other_tree = other_basis_tree
 
246
 
 
247
    @deprecated_method(deprecated_in((2, 1, 0)))
 
248
    def file_revisions(self, file_id):
 
249
        self.ensure_revision_trees()
 
250
        def get_id(tree, file_id):
 
251
            revision_id = tree.inventory[file_id].revision
 
252
            return revision_id
 
253
        if self.this_rev_id is None:
 
254
            if self.this_basis_tree.get_file_sha1(file_id) != \
 
255
                self.this_tree.get_file_sha1(file_id):
 
256
                raise errors.WorkingTreeNotRevision(self.this_tree)
 
257
 
 
258
        trees = (self.this_basis_tree, self.other_tree)
 
259
        return [get_id(tree, file_id) for tree in trees]
 
260
 
 
261
    @deprecated_method(deprecated_in((2, 1, 0)))
 
262
    def check_basis(self, check_clean, require_commits=True):
 
263
        if self.this_basis is None and require_commits is True:
 
264
            raise errors.BzrCommandError(
 
265
                "This branch has no commits."
 
266
                " (perhaps you would prefer 'bzr pull')")
187
267
        if check_clean:
188
 
            changes = compare_trees(this_branch.working_tree(), 
189
 
                                    this_branch.basis_tree(), False)
190
 
            if changes.has_changed():
191
 
                raise BzrCommandError("Working tree has uncommitted changes.")
192
 
        other_branch, other_tree = get_tree(other_revision, tempdir, "other")
 
268
            self.compare_basis()
 
269
            if self.this_basis != self.this_rev_id:
 
270
                raise errors.UncommittedChanges(self.this_tree)
 
271
 
 
272
    @deprecated_method(deprecated_in((2, 1, 0)))
 
273
    def compare_basis(self):
 
274
        try:
 
275
            basis_tree = self.revision_tree(self.this_tree.last_revision())
 
276
        except errors.NoSuchRevision:
 
277
            basis_tree = self.this_tree.basis_tree()
 
278
        if not self.this_tree.has_changes(basis_tree):
 
279
            self.this_rev_id = self.this_basis
 
280
 
 
281
    def set_interesting_files(self, file_list):
 
282
        self.interesting_files = file_list
 
283
 
 
284
    def set_pending(self):
 
285
        if (not self.base_is_ancestor or not self.base_is_other_ancestor
 
286
            or self.other_rev_id is None):
 
287
            return
 
288
        self._add_parent()
 
289
 
 
290
    def _add_parent(self):
 
291
        new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
 
292
        new_parent_trees = []
 
293
        for revision_id in new_parents:
 
294
            try:
 
295
                tree = self.revision_tree(revision_id)
 
296
            except errors.NoSuchRevision:
 
297
                tree = None
 
298
            else:
 
299
                tree.lock_read()
 
300
            new_parent_trees.append((revision_id, tree))
 
301
        try:
 
302
            self.this_tree.set_parent_trees(new_parent_trees,
 
303
                                            allow_leftmost_as_ghost=True)
 
304
        finally:
 
305
            for _revision_id, tree in new_parent_trees:
 
306
                if tree is not None:
 
307
                    tree.unlock()
 
308
 
 
309
    def set_other(self, other_revision, possible_transports=None):
 
310
        """Set the revision and tree to merge from.
 
311
 
 
312
        This sets the other_tree, other_rev_id, other_basis attributes.
 
313
 
 
314
        :param other_revision: The [path, revision] list to merge from.
 
315
        """
 
316
        self.other_branch, self.other_tree = self._get_tree(other_revision,
 
317
                                                            possible_transports)
 
318
        if other_revision[1] == -1:
 
319
            self.other_rev_id = _mod_revision.ensure_null(
 
320
                self.other_branch.last_revision())
 
321
            if _mod_revision.is_null(self.other_rev_id):
 
322
                raise errors.NoCommits(self.other_branch)
 
323
            self.other_basis = self.other_rev_id
 
324
        elif other_revision[1] is not None:
 
325
            self.other_rev_id = self.other_branch.get_rev_id(other_revision[1])
 
326
            self.other_basis = self.other_rev_id
 
327
        else:
 
328
            self.other_rev_id = None
 
329
            self.other_basis = self.other_branch.last_revision()
 
330
            if self.other_basis is None:
 
331
                raise errors.NoCommits(self.other_branch)
 
332
        if self.other_rev_id is not None:
 
333
            self._cached_trees[self.other_rev_id] = self.other_tree
 
334
        self._maybe_fetch(self.other_branch,self.this_branch, self.other_basis)
 
335
 
 
336
    def set_other_revision(self, revision_id, other_branch):
 
337
        """Set 'other' based on a branch and revision id
 
338
 
 
339
        :param revision_id: The revision to use for a tree
 
340
        :param other_branch: The branch containing this tree
 
341
        """
 
342
        self.other_rev_id = revision_id
 
343
        self.other_branch = other_branch
 
344
        self._maybe_fetch(other_branch, self.this_branch, self.other_rev_id)
 
345
        self.other_tree = self.revision_tree(revision_id)
 
346
        self.other_basis = revision_id
 
347
 
 
348
    def set_base_revision(self, revision_id, branch):
 
349
        """Set 'base' based on a branch and revision id
 
350
 
 
351
        :param revision_id: The revision to use for a tree
 
352
        :param branch: The branch containing this tree
 
353
        """
 
354
        self.base_rev_id = revision_id
 
355
        self.base_branch = branch
 
356
        self._maybe_fetch(branch, self.this_branch, revision_id)
 
357
        self.base_tree = self.revision_tree(revision_id)
 
358
 
 
359
    def _maybe_fetch(self, source, target, revision_id):
 
360
        if not source.repository.has_same_location(target.repository):
 
361
            target.fetch(source, revision_id)
 
362
 
 
363
    def find_base(self):
 
364
        revisions = [_mod_revision.ensure_null(self.this_basis),
 
365
                     _mod_revision.ensure_null(self.other_basis)]
 
366
        if _mod_revision.NULL_REVISION in revisions:
 
367
            self.base_rev_id = _mod_revision.NULL_REVISION
 
368
            self.base_tree = self.revision_tree(self.base_rev_id)
 
369
            self._is_criss_cross = False
 
370
        else:
 
371
            lcas = self.revision_graph.find_lca(revisions[0], revisions[1])
 
372
            self._is_criss_cross = False
 
373
            if len(lcas) == 0:
 
374
                self.base_rev_id = _mod_revision.NULL_REVISION
 
375
            elif len(lcas) == 1:
 
376
                self.base_rev_id = list(lcas)[0]
 
377
            else: # len(lcas) > 1
 
378
                if len(lcas) > 2:
 
379
                    # find_unique_lca can only handle 2 nodes, so we have to
 
380
                    # start back at the beginning. It is a shame to traverse
 
381
                    # the graph again, but better than re-implementing
 
382
                    # find_unique_lca.
 
383
                    self.base_rev_id = self.revision_graph.find_unique_lca(
 
384
                                            revisions[0], revisions[1])
 
385
                else:
 
386
                    self.base_rev_id = self.revision_graph.find_unique_lca(
 
387
                                            *lcas)
 
388
                self._is_criss_cross = True
 
389
            if self.base_rev_id == _mod_revision.NULL_REVISION:
 
390
                raise errors.UnrelatedBranches()
 
391
            if self._is_criss_cross:
 
392
                trace.warning('Warning: criss-cross merge encountered.  See bzr'
 
393
                              ' help criss-cross.')
 
394
                trace.mutter('Criss-cross lcas: %r' % lcas)
 
395
                interesting_revision_ids = [self.base_rev_id]
 
396
                interesting_revision_ids.extend(lcas)
 
397
                interesting_trees = dict((t.get_revision_id(), t)
 
398
                    for t in self.this_branch.repository.revision_trees(
 
399
                        interesting_revision_ids))
 
400
                self._cached_trees.update(interesting_trees)
 
401
                self.base_tree = interesting_trees.pop(self.base_rev_id)
 
402
                sorted_lca_keys = self.revision_graph.find_merge_order(
 
403
                    revisions[0], lcas)
 
404
                self._lca_trees = [interesting_trees[key]
 
405
                                   for key in sorted_lca_keys]
 
406
            else:
 
407
                self.base_tree = self.revision_tree(self.base_rev_id)
 
408
        self.base_is_ancestor = True
 
409
        self.base_is_other_ancestor = True
 
410
        trace.mutter('Base revid: %r' % self.base_rev_id)
 
411
 
 
412
    def set_base(self, base_revision):
 
413
        """Set the base revision to use for the merge.
 
414
 
 
415
        :param base_revision: A 2-list containing a path and revision number.
 
416
        """
 
417
        trace.mutter("doing merge() with no base_revision specified")
193
418
        if base_revision == [None, None]:
194
 
            if other_revision[1] == -1:
195
 
                o_revno = None
196
 
            else:
197
 
                o_revno = other_revision[1]
198
 
            base_revno = this_branch.common_ancestor(other_branch, 
199
 
                                                     other_revno=o_revno)[0]
200
 
            if base_revno is None:
201
 
                raise UnrelatedBranches()
202
 
            base_revision = ['.', base_revno]
203
 
        base_branch, base_tree = get_tree(base_revision, tempdir, "base")
204
 
        if file_list is None:
205
 
            interesting_ids = None
206
 
        else:
207
 
            interesting_ids = set()
208
 
            this_tree = this_branch.working_tree()
209
 
            for fname in file_list:
210
 
                path = this_branch.relpath(fname)
211
 
                found_id = False
212
 
                for tree in (this_tree, base_tree.tree, other_tree.tree):
213
 
                    file_id = tree.inventory.path2id(path)
 
419
            self.find_base()
 
420
        else:
 
421
            base_branch, self.base_tree = self._get_tree(base_revision)
 
422
            if base_revision[1] == -1:
 
423
                self.base_rev_id = base_branch.last_revision()
 
424
            elif base_revision[1] is None:
 
425
                self.base_rev_id = _mod_revision.NULL_REVISION
 
426
            else:
 
427
                self.base_rev_id = _mod_revision.ensure_null(
 
428
                    base_branch.get_rev_id(base_revision[1]))
 
429
            self._maybe_fetch(base_branch, self.this_branch, self.base_rev_id)
 
430
 
 
431
    def make_merger(self):
 
432
        kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
 
433
                  'other_tree': self.other_tree,
 
434
                  'interesting_ids': self.interesting_ids,
 
435
                  'interesting_files': self.interesting_files,
 
436
                  'pp': self.pp,
 
437
                  'do_merge': False}
 
438
        if self.merge_type.requires_base:
 
439
            kwargs['base_tree'] = self.base_tree
 
440
        if self.merge_type.supports_reprocess:
 
441
            kwargs['reprocess'] = self.reprocess
 
442
        elif self.reprocess:
 
443
            raise errors.BzrError(
 
444
                "Conflict reduction is not supported for merge"
 
445
                " type %s." % self.merge_type)
 
446
        if self.merge_type.supports_show_base:
 
447
            kwargs['show_base'] = self.show_base
 
448
        elif self.show_base:
 
449
            raise errors.BzrError("Showing base is not supported for this"
 
450
                                  " merge type. %s" % self.merge_type)
 
451
        if (not getattr(self.merge_type, 'supports_reverse_cherrypick', True)
 
452
            and not self.base_is_other_ancestor):
 
453
            raise errors.CannotReverseCherrypick()
 
454
        if self.merge_type.supports_cherrypick:
 
455
            kwargs['cherrypick'] = (not self.base_is_ancestor or
 
456
                                    not self.base_is_other_ancestor)
 
457
        if self._is_criss_cross and getattr(self.merge_type,
 
458
                                            'supports_lca_trees', False):
 
459
            kwargs['lca_trees'] = self._lca_trees
 
460
        return self.merge_type(pb=self._pb,
 
461
                               change_reporter=self.change_reporter,
 
462
                               **kwargs)
 
463
 
 
464
    def _do_merge_to(self, merge):
 
465
        if self.other_branch is not None:
 
466
            self.other_branch.update_references(self.this_branch)
 
467
        merge.do_merge()
 
468
        if self.recurse == 'down':
 
469
            for relpath, file_id in self.this_tree.iter_references():
 
470
                sub_tree = self.this_tree.get_nested_tree(file_id, relpath)
 
471
                other_revision = self.other_tree.get_reference_revision(
 
472
                    file_id, relpath)
 
473
                if  other_revision == sub_tree.last_revision():
 
474
                    continue
 
475
                sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
 
476
                sub_merge.merge_type = self.merge_type
 
477
                other_branch = self.other_branch.reference_parent(file_id, relpath)
 
478
                sub_merge.set_other_revision(other_revision, other_branch)
 
479
                base_revision = self.base_tree.get_reference_revision(file_id)
 
480
                sub_merge.base_tree = \
 
481
                    sub_tree.branch.repository.revision_tree(base_revision)
 
482
                sub_merge.base_rev_id = base_revision
 
483
                sub_merge.do_merge()
 
484
 
 
485
    def do_merge(self):
 
486
        self.this_tree.lock_tree_write()
 
487
        try:
 
488
            if self.base_tree is not None:
 
489
                self.base_tree.lock_read()
 
490
            try:
 
491
                if self.other_tree is not None:
 
492
                    self.other_tree.lock_read()
 
493
                try:
 
494
                    merge = self.make_merger()
 
495
                    self._do_merge_to(merge)
 
496
                finally:
 
497
                    if self.other_tree is not None:
 
498
                        self.other_tree.unlock()
 
499
            finally:
 
500
                if self.base_tree is not None:
 
501
                    self.base_tree.unlock()
 
502
        finally:
 
503
            self.this_tree.unlock()
 
504
        if len(merge.cooked_conflicts) == 0:
 
505
            if not self.ignore_zero and not trace.is_quiet():
 
506
                trace.note("All changes applied successfully.")
 
507
        else:
 
508
            trace.note("%d conflicts encountered."
 
509
                       % len(merge.cooked_conflicts))
 
510
 
 
511
        return len(merge.cooked_conflicts)
 
512
 
 
513
 
 
514
class _InventoryNoneEntry(object):
 
515
    """This represents an inventory entry which *isn't there*.
 
516
 
 
517
    It simplifies the merging logic if we always have an InventoryEntry, even
 
518
    if it isn't actually present
 
519
    """
 
520
    executable = None
 
521
    kind = None
 
522
    name = None
 
523
    parent_id = None
 
524
    revision = None
 
525
    symlink_target = None
 
526
    text_sha1 = None
 
527
 
 
528
_none_entry = _InventoryNoneEntry()
 
529
 
 
530
 
 
531
class Merge3Merger(object):
 
532
    """Three-way merger that uses the merge3 text merger"""
 
533
    requires_base = True
 
534
    supports_reprocess = True
 
535
    supports_show_base = True
 
536
    history_based = False
 
537
    supports_cherrypick = True
 
538
    supports_reverse_cherrypick = True
 
539
    winner_idx = {"this": 2, "other": 1, "conflict": 1}
 
540
    supports_lca_trees = True
 
541
 
 
542
    def __init__(self, working_tree, this_tree, base_tree, other_tree,
 
543
                 interesting_ids=None, reprocess=False, show_base=False,
 
544
                 pb=progress.DummyProgress(), pp=None, change_reporter=None,
 
545
                 interesting_files=None, do_merge=True,
 
546
                 cherrypick=False, lca_trees=None):
 
547
        """Initialize the merger object and perform the merge.
 
548
 
 
549
        :param working_tree: The working tree to apply the merge to
 
550
        :param this_tree: The local tree in the merge operation
 
551
        :param base_tree: The common tree in the merge operation
 
552
        :param other_tree: The other tree to merge changes from
 
553
        :param interesting_ids: The file_ids of files that should be
 
554
            participate in the merge.  May not be combined with
 
555
            interesting_files.
 
556
        :param: reprocess If True, perform conflict-reduction processing.
 
557
        :param show_base: If True, show the base revision in text conflicts.
 
558
            (incompatible with reprocess)
 
559
        :param pb: A Progress bar
 
560
        :param pp: A ProgressPhase object
 
561
        :param change_reporter: An object that should report changes made
 
562
        :param interesting_files: The tree-relative paths of files that should
 
563
            participate in the merge.  If these paths refer to directories,
 
564
            the contents of those directories will also be included.  May not
 
565
            be combined with interesting_ids.  If neither interesting_files nor
 
566
            interesting_ids is specified, all files may participate in the
 
567
            merge.
 
568
        :param lca_trees: Can be set to a dictionary of {revision_id:rev_tree}
 
569
            if the ancestry was found to include a criss-cross merge.
 
570
            Otherwise should be None.
 
571
        """
 
572
        object.__init__(self)
 
573
        if interesting_files is not None and interesting_ids is not None:
 
574
            raise ValueError(
 
575
                'specify either interesting_ids or interesting_files')
 
576
        self.interesting_ids = interesting_ids
 
577
        self.interesting_files = interesting_files
 
578
        self.this_tree = working_tree
 
579
        self.base_tree = base_tree
 
580
        self.other_tree = other_tree
 
581
        self._raw_conflicts = []
 
582
        self.cooked_conflicts = []
 
583
        self.reprocess = reprocess
 
584
        self.show_base = show_base
 
585
        self._lca_trees = lca_trees
 
586
        # Uncommenting this will change the default algorithm to always use
 
587
        # _entries_lca. This can be useful for running the test suite and
 
588
        # making sure we haven't missed any corner cases.
 
589
        # if lca_trees is None:
 
590
        #     self._lca_trees = [self.base_tree]
 
591
        self.pb = pb
 
592
        self.pp = pp
 
593
        self.change_reporter = change_reporter
 
594
        self.cherrypick = cherrypick
 
595
        if self.pp is None:
 
596
            self.pp = progress.ProgressPhase("Merge phase", 3, self.pb)
 
597
        if do_merge:
 
598
            self.do_merge()
 
599
 
 
600
    def do_merge(self):
 
601
        self.this_tree.lock_tree_write()
 
602
        self.base_tree.lock_read()
 
603
        self.other_tree.lock_read()
 
604
        try:
 
605
            self.tt = transform.TreeTransform(self.this_tree, self.pb)
 
606
            try:
 
607
                self.pp.next_phase()
 
608
                self._compute_transform()
 
609
                self.pp.next_phase()
 
610
                results = self.tt.apply(no_conflicts=True)
 
611
                self.write_modified(results)
 
612
                try:
 
613
                    self.this_tree.add_conflicts(self.cooked_conflicts)
 
614
                except errors.UnsupportedOperation:
 
615
                    pass
 
616
            finally:
 
617
                self.tt.finalize()
 
618
        finally:
 
619
            self.other_tree.unlock()
 
620
            self.base_tree.unlock()
 
621
            self.this_tree.unlock()
 
622
            self.pb.clear()
 
623
 
 
624
    def make_preview_transform(self):
 
625
        self.base_tree.lock_read()
 
626
        self.other_tree.lock_read()
 
627
        self.tt = transform.TransformPreview(self.this_tree)
 
628
        try:
 
629
            self.pp.next_phase()
 
630
            self._compute_transform()
 
631
            self.pp.next_phase()
 
632
        finally:
 
633
            self.other_tree.unlock()
 
634
            self.base_tree.unlock()
 
635
            self.pb.clear()
 
636
        return self.tt
 
637
 
 
638
    def _compute_transform(self):
 
639
        if self._lca_trees is None:
 
640
            entries = self._entries3()
 
641
            resolver = self._three_way
 
642
        else:
 
643
            entries = self._entries_lca()
 
644
            resolver = self._lca_multi_way
 
645
        child_pb = ui.ui_factory.nested_progress_bar()
 
646
        try:
 
647
            for num, (file_id, changed, parents3, names3,
 
648
                      executable3) in enumerate(entries):
 
649
                child_pb.update('Preparing file merge', num, len(entries))
 
650
                self._merge_names(file_id, parents3, names3, resolver=resolver)
 
651
                if changed:
 
652
                    file_status = self.merge_contents(file_id)
 
653
                else:
 
654
                    file_status = 'unmodified'
 
655
                self._merge_executable(file_id,
 
656
                    executable3, file_status, resolver=resolver)
 
657
        finally:
 
658
            child_pb.finished()
 
659
        self.fix_root()
 
660
        self.pp.next_phase()
 
661
        child_pb = ui.ui_factory.nested_progress_bar()
 
662
        try:
 
663
            fs_conflicts = transform.resolve_conflicts(self.tt, child_pb,
 
664
                lambda t, c: transform.conflict_pass(t, c, self.other_tree))
 
665
        finally:
 
666
            child_pb.finished()
 
667
        if self.change_reporter is not None:
 
668
            from bzrlib import delta
 
669
            delta.report_changes(
 
670
                self.tt.iter_changes(), self.change_reporter)
 
671
        self.cook_conflicts(fs_conflicts)
 
672
        for conflict in self.cooked_conflicts:
 
673
            trace.warning(conflict)
 
674
 
 
675
    def _entries3(self):
 
676
        """Gather data about files modified between three trees.
 
677
 
 
678
        Return a list of tuples of file_id, changed, parents3, names3,
 
679
        executable3.  changed is a boolean indicating whether the file contents
 
680
        or kind were changed.  parents3 is a tuple of parent ids for base,
 
681
        other and this.  names3 is a tuple of names for base, other and this.
 
682
        executable3 is a tuple of execute-bit values for base, other and this.
 
683
        """
 
684
        result = []
 
685
        iterator = self.other_tree.iter_changes(self.base_tree,
 
686
                include_unchanged=True, specific_files=self.interesting_files,
 
687
                extra_trees=[self.this_tree])
 
688
        this_entries = dict((e.file_id, e) for p, e in
 
689
                            self.this_tree.iter_entries_by_dir(
 
690
                            self.interesting_ids))
 
691
        for (file_id, paths, changed, versioned, parents, names, kind,
 
692
             executable) in iterator:
 
693
            if (self.interesting_ids is not None and
 
694
                file_id not in self.interesting_ids):
 
695
                continue
 
696
            entry = this_entries.get(file_id)
 
697
            if entry is not None:
 
698
                this_name = entry.name
 
699
                this_parent = entry.parent_id
 
700
                this_executable = entry.executable
 
701
            else:
 
702
                this_name = None
 
703
                this_parent = None
 
704
                this_executable = None
 
705
            parents3 = parents + (this_parent,)
 
706
            names3 = names + (this_name,)
 
707
            executable3 = executable + (this_executable,)
 
708
            result.append((file_id, changed, parents3, names3, executable3))
 
709
        return result
 
710
 
 
711
    def _entries_lca(self):
 
712
        """Gather data about files modified between multiple trees.
 
713
 
 
714
        This compares OTHER versus all LCA trees, and for interesting entries,
 
715
        it then compares with THIS and BASE.
 
716
 
 
717
        For the multi-valued entries, the format will be (BASE, [lca1, lca2])
 
718
        :return: [(file_id, changed, parents, names, executable)]
 
719
            file_id     Simple file_id of the entry
 
720
            changed     Boolean, True if the kind or contents changed
 
721
                        else False
 
722
            parents     ((base, [parent_id, in, lcas]), parent_id_other,
 
723
                         parent_id_this)
 
724
            names       ((base, [name, in, lcas]), name_in_other, name_in_this)
 
725
            executable  ((base, [exec, in, lcas]), exec_in_other, exec_in_this)
 
726
        """
 
727
        if self.interesting_files is not None:
 
728
            lookup_trees = [self.this_tree, self.base_tree]
 
729
            lookup_trees.extend(self._lca_trees)
 
730
            # I think we should include the lca trees as well
 
731
            interesting_ids = self.other_tree.paths2ids(self.interesting_files,
 
732
                                                        lookup_trees)
 
733
        else:
 
734
            interesting_ids = self.interesting_ids
 
735
        result = []
 
736
        walker = _mod_tree.MultiWalker(self.other_tree, self._lca_trees)
 
737
 
 
738
        base_inventory = self.base_tree.inventory
 
739
        this_inventory = self.this_tree.inventory
 
740
        for path, file_id, other_ie, lca_values in walker.iter_all():
 
741
            # Is this modified at all from any of the other trees?
 
742
            if other_ie is None:
 
743
                other_ie = _none_entry
 
744
            if interesting_ids is not None and file_id not in interesting_ids:
 
745
                continue
 
746
 
 
747
            # If other_revision is found in any of the lcas, that means this
 
748
            # node is uninteresting. This is because when merging, if there are
 
749
            # multiple heads(), we have to create a new node. So if we didn't,
 
750
            # we know that the ancestry is linear, and that OTHER did not
 
751
            # modify anything
 
752
            # See doc/developers/lca_merge_resolution.txt for details
 
753
            other_revision = other_ie.revision
 
754
            if other_revision is not None:
 
755
                # We can't use this shortcut when other_revision is None,
 
756
                # because it may be None because things are WorkingTrees, and
 
757
                # not because it is *actually* None.
 
758
                is_unmodified = False
 
759
                for lca_path, ie in lca_values:
 
760
                    if ie is not None and ie.revision == other_revision:
 
761
                        is_unmodified = True
 
762
                        break
 
763
                if is_unmodified:
 
764
                    continue
 
765
 
 
766
            lca_entries = []
 
767
            for lca_path, lca_ie in lca_values:
 
768
                if lca_ie is None:
 
769
                    lca_entries.append(_none_entry)
 
770
                else:
 
771
                    lca_entries.append(lca_ie)
 
772
 
 
773
            if file_id in base_inventory:
 
774
                base_ie = base_inventory[file_id]
 
775
            else:
 
776
                base_ie = _none_entry
 
777
 
 
778
            if file_id in this_inventory:
 
779
                this_ie = this_inventory[file_id]
 
780
            else:
 
781
                this_ie = _none_entry
 
782
 
 
783
            lca_kinds = []
 
784
            lca_parent_ids = []
 
785
            lca_names = []
 
786
            lca_executable = []
 
787
            for lca_ie in lca_entries:
 
788
                lca_kinds.append(lca_ie.kind)
 
789
                lca_parent_ids.append(lca_ie.parent_id)
 
790
                lca_names.append(lca_ie.name)
 
791
                lca_executable.append(lca_ie.executable)
 
792
 
 
793
            kind_winner = self._lca_multi_way(
 
794
                (base_ie.kind, lca_kinds),
 
795
                other_ie.kind, this_ie.kind)
 
796
            parent_id_winner = self._lca_multi_way(
 
797
                (base_ie.parent_id, lca_parent_ids),
 
798
                other_ie.parent_id, this_ie.parent_id)
 
799
            name_winner = self._lca_multi_way(
 
800
                (base_ie.name, lca_names),
 
801
                other_ie.name, this_ie.name)
 
802
 
 
803
            content_changed = True
 
804
            if kind_winner == 'this':
 
805
                # No kind change in OTHER, see if there are *any* changes
 
806
                if other_ie.kind == 'directory':
 
807
                    if parent_id_winner == 'this' and name_winner == 'this':
 
808
                        # No change for this directory in OTHER, skip
 
809
                        continue
 
810
                    content_changed = False
 
811
                elif other_ie.kind is None or other_ie.kind == 'file':
 
812
                    def get_sha1(ie, tree):
 
813
                        if ie.kind != 'file':
 
814
                            return None
 
815
                        return tree.get_file_sha1(file_id)
 
816
                    base_sha1 = get_sha1(base_ie, self.base_tree)
 
817
                    lca_sha1s = [get_sha1(ie, tree) for ie, tree
 
818
                                 in zip(lca_entries, self._lca_trees)]
 
819
                    this_sha1 = get_sha1(this_ie, self.this_tree)
 
820
                    other_sha1 = get_sha1(other_ie, self.other_tree)
 
821
                    sha1_winner = self._lca_multi_way(
 
822
                        (base_sha1, lca_sha1s), other_sha1, this_sha1,
 
823
                        allow_overriding_lca=False)
 
824
                    exec_winner = self._lca_multi_way(
 
825
                        (base_ie.executable, lca_executable),
 
826
                        other_ie.executable, this_ie.executable)
 
827
                    if (parent_id_winner == 'this' and name_winner == 'this'
 
828
                        and sha1_winner == 'this' and exec_winner == 'this'):
 
829
                        # No kind, parent, name, exec, or content change for
 
830
                        # OTHER, so this node is not considered interesting
 
831
                        continue
 
832
                    if sha1_winner == 'this':
 
833
                        content_changed = False
 
834
                elif other_ie.kind == 'symlink':
 
835
                    def get_target(ie, tree):
 
836
                        if ie.kind != 'symlink':
 
837
                            return None
 
838
                        return tree.get_symlink_target(file_id)
 
839
                    base_target = get_target(base_ie, self.base_tree)
 
840
                    lca_targets = [get_target(ie, tree) for ie, tree
 
841
                                   in zip(lca_entries, self._lca_trees)]
 
842
                    this_target = get_target(this_ie, self.this_tree)
 
843
                    other_target = get_target(other_ie, self.other_tree)
 
844
                    target_winner = self._lca_multi_way(
 
845
                        (base_target, lca_targets),
 
846
                        other_target, this_target)
 
847
                    if (parent_id_winner == 'this' and name_winner == 'this'
 
848
                        and target_winner == 'this'):
 
849
                        # No kind, parent, name, or symlink target change
 
850
                        # not interesting
 
851
                        continue
 
852
                    if target_winner == 'this':
 
853
                        content_changed = False
 
854
                elif other_ie.kind == 'tree-reference':
 
855
                    # The 'changed' information seems to be handled at a higher
 
856
                    # level. At least, _entries3 returns False for content
 
857
                    # changed, even when at a new revision_id.
 
858
                    content_changed = False
 
859
                    if (parent_id_winner == 'this' and name_winner == 'this'):
 
860
                        # Nothing interesting
 
861
                        continue
 
862
                else:
 
863
                    raise AssertionError('unhandled kind: %s' % other_ie.kind)
 
864
                # XXX: We need to handle kind == 'symlink'
 
865
 
 
866
            # If we have gotten this far, that means something has changed
 
867
            result.append((file_id, content_changed,
 
868
                           ((base_ie.parent_id, lca_parent_ids),
 
869
                            other_ie.parent_id, this_ie.parent_id),
 
870
                           ((base_ie.name, lca_names),
 
871
                            other_ie.name, this_ie.name),
 
872
                           ((base_ie.executable, lca_executable),
 
873
                            other_ie.executable, this_ie.executable)
 
874
                          ))
 
875
        return result
 
876
 
 
877
 
 
878
    def fix_root(self):
 
879
        try:
 
880
            self.tt.final_kind(self.tt.root)
 
881
        except errors.NoSuchFile:
 
882
            self.tt.cancel_deletion(self.tt.root)
 
883
        if self.tt.final_file_id(self.tt.root) is None:
 
884
            self.tt.version_file(self.tt.tree_file_id(self.tt.root),
 
885
                                 self.tt.root)
 
886
        other_root_file_id = self.other_tree.get_root_id()
 
887
        if other_root_file_id is None:
 
888
            return
 
889
        other_root = self.tt.trans_id_file_id(other_root_file_id)
 
890
        if other_root == self.tt.root:
 
891
            return
 
892
        try:
 
893
            self.tt.final_kind(other_root)
 
894
        except errors.NoSuchFile:
 
895
            return
 
896
        if self.other_tree.inventory.root.file_id in self.this_tree.inventory:
 
897
            # the other tree's root is a non-root in the current tree
 
898
            return
 
899
        self.reparent_children(self.other_tree.inventory.root, self.tt.root)
 
900
        self.tt.cancel_creation(other_root)
 
901
        self.tt.cancel_versioning(other_root)
 
902
 
 
903
    def reparent_children(self, ie, target):
 
904
        for thing, child in ie.children.iteritems():
 
905
            trans_id = self.tt.trans_id_file_id(child.file_id)
 
906
            self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
 
907
 
 
908
    def write_modified(self, results):
 
909
        modified_hashes = {}
 
910
        for path in results.modified_paths:
 
911
            file_id = self.this_tree.path2id(self.this_tree.relpath(path))
 
912
            if file_id is None:
 
913
                continue
 
914
            hash = self.this_tree.get_file_sha1(file_id)
 
915
            if hash is None:
 
916
                continue
 
917
            modified_hashes[file_id] = hash
 
918
        self.this_tree.set_merge_modified(modified_hashes)
 
919
 
 
920
    @staticmethod
 
921
    def parent(entry, file_id):
 
922
        """Determine the parent for a file_id (used as a key method)"""
 
923
        if entry is None:
 
924
            return None
 
925
        return entry.parent_id
 
926
 
 
927
    @staticmethod
 
928
    def name(entry, file_id):
 
929
        """Determine the name for a file_id (used as a key method)"""
 
930
        if entry is None:
 
931
            return None
 
932
        return entry.name
 
933
 
 
934
    @staticmethod
 
935
    def contents_sha1(tree, file_id):
 
936
        """Determine the sha1 of the file contents (used as a key method)."""
 
937
        if file_id not in tree:
 
938
            return None
 
939
        return tree.get_file_sha1(file_id)
 
940
 
 
941
    @staticmethod
 
942
    def executable(tree, file_id):
 
943
        """Determine the executability of a file-id (used as a key method)."""
 
944
        if file_id not in tree:
 
945
            return None
 
946
        if tree.kind(file_id) != "file":
 
947
            return False
 
948
        return tree.is_executable(file_id)
 
949
 
 
950
    @staticmethod
 
951
    def kind(tree, file_id):
 
952
        """Determine the kind of a file-id (used as a key method)."""
 
953
        if file_id not in tree:
 
954
            return None
 
955
        return tree.kind(file_id)
 
956
 
 
957
    @staticmethod
 
958
    def _three_way(base, other, this):
 
959
        #if base == other, either they all agree, or only THIS has changed.
 
960
        if base == other:
 
961
            return 'this'
 
962
        elif this not in (base, other):
 
963
            return 'conflict'
 
964
        # "Ambiguous clean merge" -- both sides have made the same change.
 
965
        elif this == other:
 
966
            return "this"
 
967
        # this == base: only other has changed.
 
968
        else:
 
969
            return "other"
 
970
 
 
971
    @staticmethod
 
972
    def _lca_multi_way(bases, other, this, allow_overriding_lca=True):
 
973
        """Consider LCAs when determining whether a change has occurred.
 
974
 
 
975
        If LCAS are all identical, this is the same as a _three_way comparison.
 
976
 
 
977
        :param bases: value in (BASE, [LCAS])
 
978
        :param other: value in OTHER
 
979
        :param this: value in THIS
 
980
        :param allow_overriding_lca: If there is more than one unique lca
 
981
            value, allow OTHER to override THIS if it has a new value, and
 
982
            THIS only has an lca value, or vice versa. This is appropriate for
 
983
            truly scalar values, not as much for non-scalars.
 
984
        :return: 'this', 'other', or 'conflict' depending on whether an entry
 
985
            changed or not.
 
986
        """
 
987
        # See doc/developers/lca_tree_merging.txt for details about this
 
988
        # algorithm.
 
989
        if other == this:
 
990
            # Either Ambiguously clean, or nothing was actually changed. We
 
991
            # don't really care
 
992
            return 'this'
 
993
        base_val, lca_vals = bases
 
994
        # Remove 'base_val' from the lca_vals, because it is not interesting
 
995
        filtered_lca_vals = [lca_val for lca_val in lca_vals
 
996
                                      if lca_val != base_val]
 
997
        if len(filtered_lca_vals) == 0:
 
998
            return Merge3Merger._three_way(base_val, other, this)
 
999
 
 
1000
        unique_lca_vals = set(filtered_lca_vals)
 
1001
        if len(unique_lca_vals) == 1:
 
1002
            return Merge3Merger._three_way(unique_lca_vals.pop(), other, this)
 
1003
 
 
1004
        if allow_overriding_lca:
 
1005
            if other in unique_lca_vals:
 
1006
                if this in unique_lca_vals:
 
1007
                    # Each side picked a different lca, conflict
 
1008
                    return 'conflict'
 
1009
                else:
 
1010
                    # This has a value which supersedes both lca values, and
 
1011
                    # other only has an lca value
 
1012
                    return 'this'
 
1013
            elif this in unique_lca_vals:
 
1014
                # OTHER has a value which supersedes both lca values, and this
 
1015
                # only has an lca value
 
1016
                return 'other'
 
1017
 
 
1018
        # At this point, the lcas disagree, and the tips disagree
 
1019
        return 'conflict'
 
1020
 
 
1021
    @staticmethod
 
1022
    def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
 
1023
        """Do a three-way test on a scalar.
 
1024
        Return "this", "other" or "conflict", depending whether a value wins.
 
1025
        """
 
1026
        key_base = key(base_tree, file_id)
 
1027
        key_other = key(other_tree, file_id)
 
1028
        #if base == other, either they all agree, or only THIS has changed.
 
1029
        if key_base == key_other:
 
1030
            return "this"
 
1031
        key_this = key(this_tree, file_id)
 
1032
        # "Ambiguous clean merge"
 
1033
        if key_this == key_other:
 
1034
            return "this"
 
1035
        elif key_this == key_base:
 
1036
            return "other"
 
1037
        else:
 
1038
            return "conflict"
 
1039
 
 
1040
    def merge_names(self, file_id):
 
1041
        def get_entry(tree):
 
1042
            if file_id in tree.inventory:
 
1043
                return tree.inventory[file_id]
 
1044
            else:
 
1045
                return None
 
1046
        this_entry = get_entry(self.this_tree)
 
1047
        other_entry = get_entry(self.other_tree)
 
1048
        base_entry = get_entry(self.base_tree)
 
1049
        entries = (base_entry, other_entry, this_entry)
 
1050
        names = []
 
1051
        parents = []
 
1052
        for entry in entries:
 
1053
            if entry is None:
 
1054
                names.append(None)
 
1055
                parents.append(None)
 
1056
            else:
 
1057
                names.append(entry.name)
 
1058
                parents.append(entry.parent_id)
 
1059
        return self._merge_names(file_id, parents, names,
 
1060
                                 resolver=self._three_way)
 
1061
 
 
1062
    def _merge_names(self, file_id, parents, names, resolver):
 
1063
        """Perform a merge on file_id names and parents"""
 
1064
        base_name, other_name, this_name = names
 
1065
        base_parent, other_parent, this_parent = parents
 
1066
 
 
1067
        name_winner = resolver(*names)
 
1068
 
 
1069
        parent_id_winner = resolver(*parents)
 
1070
        if this_name is None:
 
1071
            if name_winner == "this":
 
1072
                name_winner = "other"
 
1073
            if parent_id_winner == "this":
 
1074
                parent_id_winner = "other"
 
1075
        if name_winner == "this" and parent_id_winner == "this":
 
1076
            return
 
1077
        if name_winner == "conflict":
 
1078
            trans_id = self.tt.trans_id_file_id(file_id)
 
1079
            self._raw_conflicts.append(('name conflict', trans_id,
 
1080
                                        this_name, other_name))
 
1081
        if parent_id_winner == "conflict":
 
1082
            trans_id = self.tt.trans_id_file_id(file_id)
 
1083
            self._raw_conflicts.append(('parent conflict', trans_id,
 
1084
                                        this_parent, other_parent))
 
1085
        if other_name is None:
 
1086
            # it doesn't matter whether the result was 'other' or
 
1087
            # 'conflict'-- if there's no 'other', we leave it alone.
 
1088
            return
 
1089
        # if we get here, name_winner and parent_winner are set to safe values.
 
1090
        trans_id = self.tt.trans_id_file_id(file_id)
 
1091
        parent_id = parents[self.winner_idx[parent_id_winner]]
 
1092
        if parent_id is not None:
 
1093
            parent_trans_id = self.tt.trans_id_file_id(parent_id)
 
1094
            self.tt.adjust_path(names[self.winner_idx[name_winner]],
 
1095
                                parent_trans_id, trans_id)
 
1096
 
 
1097
    def merge_contents(self, file_id):
 
1098
        """Performs a merge on file_id contents."""
 
1099
        def contents_pair(tree):
 
1100
            if file_id not in tree:
 
1101
                return (None, None)
 
1102
            kind = tree.kind(file_id)
 
1103
            if kind == "file":
 
1104
                contents = tree.get_file_sha1(file_id)
 
1105
            elif kind == "symlink":
 
1106
                contents = tree.get_symlink_target(file_id)
 
1107
            else:
 
1108
                contents = None
 
1109
            return kind, contents
 
1110
 
 
1111
        def contents_conflict():
 
1112
            trans_id = self.tt.trans_id_file_id(file_id)
 
1113
            name = self.tt.final_name(trans_id)
 
1114
            parent_id = self.tt.final_parent(trans_id)
 
1115
            if file_id in self.this_tree.inventory:
 
1116
                self.tt.unversion_file(trans_id)
 
1117
                if file_id in self.this_tree:
 
1118
                    self.tt.delete_contents(trans_id)
 
1119
            file_group = self._dump_conflicts(name, parent_id, file_id,
 
1120
                                              set_version=True)
 
1121
            self._raw_conflicts.append(('contents conflict', file_group))
 
1122
 
 
1123
        # See SPOT run.  run, SPOT, run.
 
1124
        # So we're not QUITE repeating ourselves; we do tricky things with
 
1125
        # file kind...
 
1126
        base_pair = contents_pair(self.base_tree)
 
1127
        other_pair = contents_pair(self.other_tree)
 
1128
        if self._lca_trees:
 
1129
            this_pair = contents_pair(self.this_tree)
 
1130
            lca_pairs = [contents_pair(tree) for tree in self._lca_trees]
 
1131
            winner = self._lca_multi_way((base_pair, lca_pairs), other_pair,
 
1132
                                         this_pair, allow_overriding_lca=False)
 
1133
        else:
 
1134
            if base_pair == other_pair:
 
1135
                winner = 'this'
 
1136
            else:
 
1137
                # We delayed evaluating this_pair as long as we can to avoid
 
1138
                # unnecessary sha1 calculation
 
1139
                this_pair = contents_pair(self.this_tree)
 
1140
                winner = self._three_way(base_pair, other_pair, this_pair)
 
1141
        if winner == 'this':
 
1142
            # No interesting changes introduced by OTHER
 
1143
            return "unmodified"
 
1144
        trans_id = self.tt.trans_id_file_id(file_id)
 
1145
        if winner == 'other':
 
1146
            # OTHER is a straight winner, so replace this contents with other
 
1147
            file_in_this = file_id in self.this_tree
 
1148
            if file_in_this:
 
1149
                # Remove any existing contents
 
1150
                self.tt.delete_contents(trans_id)
 
1151
            if file_id in self.other_tree:
 
1152
                # OTHER changed the file
 
1153
                transform.create_from_tree(self.tt, trans_id,
 
1154
                                           self.other_tree, file_id)
 
1155
                if not file_in_this:
 
1156
                    self.tt.version_file(file_id, trans_id)
 
1157
                return "modified"
 
1158
            elif file_in_this:
 
1159
                # OTHER deleted the file
 
1160
                self.tt.unversion_file(trans_id)
 
1161
                return "deleted"
 
1162
        else:
 
1163
            # We have a hypothetical conflict, but if we have files, then we
 
1164
            # can try to merge the content
 
1165
            if this_pair[0] == 'file' and other_pair[0] == 'file':
 
1166
                # THIS and OTHER are both files, so text merge.  Either
 
1167
                # BASE is a file, or both converted to files, so at least we
 
1168
                # have agreement that output should be a file.
 
1169
                try:
 
1170
                    self.text_merge(file_id, trans_id)
 
1171
                except errors.BinaryFile:
 
1172
                    return contents_conflict()
 
1173
                if file_id not in self.this_tree:
 
1174
                    self.tt.version_file(file_id, trans_id)
 
1175
                try:
 
1176
                    self.tt.tree_kind(trans_id)
 
1177
                    self.tt.delete_contents(trans_id)
 
1178
                except errors.NoSuchFile:
 
1179
                    pass
 
1180
                return "modified"
 
1181
            else:
 
1182
                return contents_conflict()
 
1183
 
 
1184
    def get_lines(self, tree, file_id):
 
1185
        """Return the lines in a file, or an empty list."""
 
1186
        if file_id in tree:
 
1187
            return tree.get_file(file_id).readlines()
 
1188
        else:
 
1189
            return []
 
1190
 
 
1191
    def text_merge(self, file_id, trans_id):
 
1192
        """Perform a three-way text merge on a file_id"""
 
1193
        # it's possible that we got here with base as a different type.
 
1194
        # if so, we just want two-way text conflicts.
 
1195
        if file_id in self.base_tree and \
 
1196
            self.base_tree.kind(file_id) == "file":
 
1197
            base_lines = self.get_lines(self.base_tree, file_id)
 
1198
        else:
 
1199
            base_lines = []
 
1200
        other_lines = self.get_lines(self.other_tree, file_id)
 
1201
        this_lines = self.get_lines(self.this_tree, file_id)
 
1202
        m3 = merge3.Merge3(base_lines, this_lines, other_lines,
 
1203
                           is_cherrypick=self.cherrypick)
 
1204
        start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
 
1205
        if self.show_base is True:
 
1206
            base_marker = '|' * 7
 
1207
        else:
 
1208
            base_marker = None
 
1209
 
 
1210
        def iter_merge3(retval):
 
1211
            retval["text_conflicts"] = False
 
1212
            for line in m3.merge_lines(name_a = "TREE",
 
1213
                                       name_b = "MERGE-SOURCE",
 
1214
                                       name_base = "BASE-REVISION",
 
1215
                                       start_marker=start_marker,
 
1216
                                       base_marker=base_marker,
 
1217
                                       reprocess=self.reprocess):
 
1218
                if line.startswith(start_marker):
 
1219
                    retval["text_conflicts"] = True
 
1220
                    yield line.replace(start_marker, '<' * 7)
 
1221
                else:
 
1222
                    yield line
 
1223
        retval = {}
 
1224
        merge3_iterator = iter_merge3(retval)
 
1225
        self.tt.create_file(merge3_iterator, trans_id)
 
1226
        if retval["text_conflicts"] is True:
 
1227
            self._raw_conflicts.append(('text conflict', trans_id))
 
1228
            name = self.tt.final_name(trans_id)
 
1229
            parent_id = self.tt.final_parent(trans_id)
 
1230
            file_group = self._dump_conflicts(name, parent_id, file_id,
 
1231
                                              this_lines, base_lines,
 
1232
                                              other_lines)
 
1233
            file_group.append(trans_id)
 
1234
 
 
1235
    def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
 
1236
                        base_lines=None, other_lines=None, set_version=False,
 
1237
                        no_base=False):
 
1238
        """Emit conflict files.
 
1239
        If this_lines, base_lines, or other_lines are omitted, they will be
 
1240
        determined automatically.  If set_version is true, the .OTHER, .THIS
 
1241
        or .BASE (in that order) will be created as versioned files.
 
1242
        """
 
1243
        data = [('OTHER', self.other_tree, other_lines),
 
1244
                ('THIS', self.this_tree, this_lines)]
 
1245
        if not no_base:
 
1246
            data.append(('BASE', self.base_tree, base_lines))
 
1247
        versioned = False
 
1248
        file_group = []
 
1249
        for suffix, tree, lines in data:
 
1250
            if file_id in tree:
 
1251
                trans_id = self._conflict_file(name, parent_id, tree, file_id,
 
1252
                                               suffix, lines)
 
1253
                file_group.append(trans_id)
 
1254
                if set_version and not versioned:
 
1255
                    self.tt.version_file(file_id, trans_id)
 
1256
                    versioned = True
 
1257
        return file_group
 
1258
 
 
1259
    def _conflict_file(self, name, parent_id, tree, file_id, suffix,
 
1260
                       lines=None):
 
1261
        """Emit a single conflict file."""
 
1262
        name = name + '.' + suffix
 
1263
        trans_id = self.tt.create_path(name, parent_id)
 
1264
        transform.create_from_tree(self.tt, trans_id, tree, file_id, lines)
 
1265
        return trans_id
 
1266
 
 
1267
    def merge_executable(self, file_id, file_status):
 
1268
        """Perform a merge on the execute bit."""
 
1269
        executable = [self.executable(t, file_id) for t in (self.base_tree,
 
1270
                      self.other_tree, self.this_tree)]
 
1271
        self._merge_executable(file_id, executable, file_status,
 
1272
                               resolver=self._three_way)
 
1273
 
 
1274
    def _merge_executable(self, file_id, executable, file_status,
 
1275
                          resolver):
 
1276
        """Perform a merge on the execute bit."""
 
1277
        base_executable, other_executable, this_executable = executable
 
1278
        if file_status == "deleted":
 
1279
            return
 
1280
        winner = resolver(*executable)
 
1281
        if winner == "conflict":
 
1282
        # There must be a None in here, if we have a conflict, but we
 
1283
        # need executability since file status was not deleted.
 
1284
            if self.executable(self.other_tree, file_id) is None:
 
1285
                winner = "this"
 
1286
            else:
 
1287
                winner = "other"
 
1288
        if winner == 'this' and file_status != "modified":
 
1289
            return
 
1290
        trans_id = self.tt.trans_id_file_id(file_id)
 
1291
        try:
 
1292
            if self.tt.final_kind(trans_id) != "file":
 
1293
                return
 
1294
        except errors.NoSuchFile:
 
1295
            return
 
1296
        if winner == "this":
 
1297
            executability = this_executable
 
1298
        else:
 
1299
            if file_id in self.other_tree:
 
1300
                executability = other_executable
 
1301
            elif file_id in self.this_tree:
 
1302
                executability = this_executable
 
1303
            elif file_id in self.base_tree:
 
1304
                executability = base_executable
 
1305
        if executability is not None:
 
1306
            trans_id = self.tt.trans_id_file_id(file_id)
 
1307
            self.tt.set_executability(executability, trans_id)
 
1308
 
 
1309
    def cook_conflicts(self, fs_conflicts):
 
1310
        """Convert all conflicts into a form that doesn't depend on trans_id"""
 
1311
        name_conflicts = {}
 
1312
        self.cooked_conflicts.extend(transform.cook_conflicts(
 
1313
                fs_conflicts, self.tt))
 
1314
        fp = transform.FinalPaths(self.tt)
 
1315
        for conflict in self._raw_conflicts:
 
1316
            conflict_type = conflict[0]
 
1317
            if conflict_type in ('name conflict', 'parent conflict'):
 
1318
                trans_id = conflict[1]
 
1319
                conflict_args = conflict[2:]
 
1320
                if trans_id not in name_conflicts:
 
1321
                    name_conflicts[trans_id] = {}
 
1322
                transform.unique_add(name_conflicts[trans_id], conflict_type,
 
1323
                                     conflict_args)
 
1324
            if conflict_type == 'contents conflict':
 
1325
                for trans_id in conflict[1]:
 
1326
                    file_id = self.tt.final_file_id(trans_id)
214
1327
                    if file_id is not None:
215
 
                        interesting_ids.add(file_id)
216
 
                        found_id = True
217
 
                if not found_id:
218
 
                    raise BzrCommandError("%s is not a source file in any"
219
 
                                          " tree." % fname)
220
 
        merge_inner(this_branch, other_tree, base_tree, tempdir, 
221
 
                    ignore_zero=ignore_zero, backup_files=backup_files, 
222
 
                    merge_type=merge_type, interesting_ids=interesting_ids)
223
 
    finally:
224
 
        shutil.rmtree(tempdir)
225
 
 
226
 
 
227
 
def set_interesting(inventory_a, inventory_b, interesting_ids):
228
 
    """Mark files whose ids are in interesting_ids as interesting
229
 
    """
230
 
    for inventory in (inventory_a, inventory_b):
231
 
        for path, source_file in inventory.iteritems():
232
 
             source_file.interesting = source_file.id in interesting_ids
233
 
 
234
 
 
235
 
def set_optimized(tree_a, tree_b, inventory_a, inventory_b):
236
 
    """Mark files that have changed texts as interesting
237
 
    """
238
 
    for file_id in tree_a.tree.inventory:
239
 
        if file_id not in tree_b.tree.inventory:
240
 
            continue
241
 
        entry_a = tree_a.tree.inventory[file_id]
242
 
        entry_b = tree_b.tree.inventory[file_id]
243
 
        if (entry_a.kind, entry_b.kind) != ("file", "file"):
244
 
            continue
245
 
        if None in (entry_a.text_id, entry_b.text_id):
246
 
            continue
247
 
        if entry_a.text_id != entry_b.text_id:
248
 
            continue
249
 
        inventory_a[abspath(tree_a.tree, file_id)].interesting = False
250
 
        inventory_b[abspath(tree_b.tree, file_id)].interesting = False
251
 
 
252
 
 
253
 
def generate_cset_optimized(tree_a, tree_b, inventory_a, inventory_b,
254
 
                            interesting_ids=None):
255
 
    """Generate a changeset, with preprocessing to select interesting files.
256
 
    using the text_id to mark really-changed files.
257
 
    This permits blazing comparisons when text_ids are present.  It also
258
 
    disables metadata comparison for files with identical texts.
259
 
    """ 
260
 
    if interesting_ids is None:
261
 
        set_optimized(tree_a, tree_b, inventory_a, inventory_b)
262
 
    else:
263
 
        set_interesting(inventory_a, inventory_b, interesting_ids)
264
 
    cset =  generate_changeset(tree_a, tree_b, inventory_a, inventory_b)
265
 
    for entry in cset.entries.itervalues():
266
 
        entry.metadata_change = None
267
 
    return cset
268
 
 
269
 
 
270
 
def merge_inner(this_branch, other_tree, base_tree, tempdir, 
271
 
                ignore_zero=False, merge_type=ApplyMerge3, backup_files=False,
272
 
                interesting_ids=None):
273
 
 
274
 
    def merge_factory(base_file, other_file):
275
 
        contents_change = merge_type(base_file, other_file)
276
 
        if backup_files:
277
 
            contents_change = BackupBeforeChange(contents_change)
278
 
        return contents_change
279
 
    
280
 
    def generate_cset(tree_a, tree_b, inventory_a, inventory_b):
281
 
        return generate_cset_optimized(tree_a, tree_b, inventory_a, inventory_b,
282
 
                                       interesting_ids)
283
 
 
284
 
    this_tree = get_tree((this_branch.base, None), tempdir, "this")[1]
285
 
 
286
 
    def get_inventory(tree):
287
 
        return tree.inventory
288
 
 
289
 
    inv_changes = merge_flex(this_tree, base_tree, other_tree,
290
 
                             generate_cset, get_inventory,
291
 
                             MergeConflictHandler(base_tree.root,
292
 
                                                  ignore_zero=ignore_zero),
293
 
                             merge_factory=merge_factory)
294
 
 
295
 
    adjust_ids = []
296
 
    for id, path in inv_changes.iteritems():
297
 
        if path is not None:
298
 
            if path == '.':
299
 
                path = ''
300
 
            else:
301
 
                assert path.startswith('./')
302
 
            path = path[2:]
303
 
        adjust_ids.append((path, id))
304
 
    this_branch.set_inventory(regen_inventory(this_branch, this_tree.root, adjust_ids))
305
 
 
306
 
 
307
 
def regen_inventory(this_branch, root, new_entries):
308
 
    old_entries = this_branch.read_working_inventory()
309
 
    new_inventory = {}
310
 
    by_path = {}
311
 
    for file_id in old_entries:
312
 
        entry = old_entries[file_id]
313
 
        path = old_entries.id2path(file_id)
314
 
        new_inventory[file_id] = (path, file_id, entry.parent_id, entry.kind)
315
 
        by_path[path] = file_id
316
 
    
317
 
    deletions = 0
318
 
    insertions = 0
319
 
    new_path_list = []
320
 
    for path, file_id in new_entries:
321
 
        if path is None:
322
 
            del new_inventory[file_id]
323
 
            deletions += 1
324
 
        else:
325
 
            new_path_list.append((path, file_id))
326
 
            if file_id not in old_entries:
327
 
                insertions += 1
328
 
    # Ensure no file is added before its parent
329
 
    new_path_list.sort()
330
 
    for path, file_id in new_path_list:
331
 
        if path == '':
332
 
            parent = None
333
 
        else:
334
 
            parent = by_path[os.path.dirname(path)]
335
 
        kind = bzrlib.osutils.file_kind(os.path.join(root, path))
336
 
        new_inventory[file_id] = (path, file_id, parent, kind)
337
 
        by_path[path] = file_id 
338
 
 
339
 
    # Get a list in insertion order
340
 
    new_inventory_list = new_inventory.values()
341
 
    mutter ("""Inventory regeneration:
342
 
old length: %i insertions: %i deletions: %i new_length: %i"""\
343
 
        % (len(old_entries), insertions, deletions, len(new_inventory_list)))
344
 
    assert len(new_inventory_list) == len(old_entries) + insertions - deletions
345
 
    new_inventory_list.sort()
346
 
    return new_inventory_list
347
 
 
348
 
merge_types = {     "merge3": (ApplyMerge3, "Native diff3-style merge"), 
349
 
                     "diff3": (Diff3Merge,  "Merge using external diff3")
350
 
              }
351
 
 
 
1328
                        break
 
1329
                path = fp.get_path(trans_id)
 
1330
                for suffix in ('.BASE', '.THIS', '.OTHER'):
 
1331
                    if path.endswith(suffix):
 
1332
                        path = path[:-len(suffix)]
 
1333
                        break
 
1334
                c = _mod_conflicts.Conflict.factory(conflict_type,
 
1335
                                                    path=path, file_id=file_id)
 
1336
                self.cooked_conflicts.append(c)
 
1337
            if conflict_type == 'text conflict':
 
1338
                trans_id = conflict[1]
 
1339
                path = fp.get_path(trans_id)
 
1340
                file_id = self.tt.final_file_id(trans_id)
 
1341
                c = _mod_conflicts.Conflict.factory(conflict_type,
 
1342
                                                    path=path, file_id=file_id)
 
1343
                self.cooked_conflicts.append(c)
 
1344
 
 
1345
        for trans_id, conflicts in name_conflicts.iteritems():
 
1346
            try:
 
1347
                this_parent, other_parent = conflicts['parent conflict']
 
1348
                if this_parent == other_parent:
 
1349
                    raise AssertionError()
 
1350
            except KeyError:
 
1351
                this_parent = other_parent = \
 
1352
                    self.tt.final_file_id(self.tt.final_parent(trans_id))
 
1353
            try:
 
1354
                this_name, other_name = conflicts['name conflict']
 
1355
                if this_name == other_name:
 
1356
                    raise AssertionError()
 
1357
            except KeyError:
 
1358
                this_name = other_name = self.tt.final_name(trans_id)
 
1359
            other_path = fp.get_path(trans_id)
 
1360
            if this_parent is not None and this_name is not None:
 
1361
                this_parent_path = \
 
1362
                    fp.get_path(self.tt.trans_id_file_id(this_parent))
 
1363
                this_path = osutils.pathjoin(this_parent_path, this_name)
 
1364
            else:
 
1365
                this_path = "<deleted>"
 
1366
            file_id = self.tt.final_file_id(trans_id)
 
1367
            c = _mod_conflicts.Conflict.factory('path conflict', path=this_path,
 
1368
                                                conflict_path=other_path,
 
1369
                                                file_id=file_id)
 
1370
            self.cooked_conflicts.append(c)
 
1371
        self.cooked_conflicts.sort(key=_mod_conflicts.Conflict.sort_key)
 
1372
 
 
1373
 
 
1374
class WeaveMerger(Merge3Merger):
 
1375
    """Three-way tree merger, text weave merger."""
 
1376
    supports_reprocess = True
 
1377
    supports_show_base = False
 
1378
    supports_reverse_cherrypick = False
 
1379
    history_based = True
 
1380
 
 
1381
    def _merged_lines(self, file_id):
 
1382
        """Generate the merged lines.
 
1383
        There is no distinction between lines that are meant to contain <<<<<<<
 
1384
        and conflicts.
 
1385
        """
 
1386
        if self.cherrypick:
 
1387
            base = self.base_tree
 
1388
        else:
 
1389
            base = None
 
1390
        plan = self.this_tree.plan_file_merge(file_id, self.other_tree,
 
1391
                                              base=base)
 
1392
        if 'merge' in debug.debug_flags:
 
1393
            plan = list(plan)
 
1394
            trans_id = self.tt.trans_id_file_id(file_id)
 
1395
            name = self.tt.final_name(trans_id) + '.plan'
 
1396
            contents = ('%10s|%s' % l for l in plan)
 
1397
            self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
 
1398
        textmerge = versionedfile.PlanWeaveMerge(plan, '<<<<<<< TREE\n',
 
1399
                                                 '>>>>>>> MERGE-SOURCE\n')
 
1400
        return textmerge.merge_lines(self.reprocess)
 
1401
 
 
1402
    def text_merge(self, file_id, trans_id):
 
1403
        """Perform a (weave) text merge for a given file and file-id.
 
1404
        If conflicts are encountered, .THIS and .OTHER files will be emitted,
 
1405
        and a conflict will be noted.
 
1406
        """
 
1407
        lines, conflicts = self._merged_lines(file_id)
 
1408
        lines = list(lines)
 
1409
        # Note we're checking whether the OUTPUT is binary in this case,
 
1410
        # because we don't want to get into weave merge guts.
 
1411
        textfile.check_text_lines(lines)
 
1412
        self.tt.create_file(lines, trans_id)
 
1413
        if conflicts:
 
1414
            self._raw_conflicts.append(('text conflict', trans_id))
 
1415
            name = self.tt.final_name(trans_id)
 
1416
            parent_id = self.tt.final_parent(trans_id)
 
1417
            file_group = self._dump_conflicts(name, parent_id, file_id,
 
1418
                                              no_base=True)
 
1419
            file_group.append(trans_id)
 
1420
 
 
1421
 
 
1422
class LCAMerger(WeaveMerger):
 
1423
 
 
1424
    def _merged_lines(self, file_id):
 
1425
        """Generate the merged lines.
 
1426
        There is no distinction between lines that are meant to contain <<<<<<<
 
1427
        and conflicts.
 
1428
        """
 
1429
        if self.cherrypick:
 
1430
            base = self.base_tree
 
1431
        else:
 
1432
            base = None
 
1433
        plan = self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
 
1434
                                                  base=base)
 
1435
        if 'merge' in debug.debug_flags:
 
1436
            plan = list(plan)
 
1437
            trans_id = self.tt.trans_id_file_id(file_id)
 
1438
            name = self.tt.final_name(trans_id) + '.plan'
 
1439
            contents = ('%10s|%s' % l for l in plan)
 
1440
            self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
 
1441
        textmerge = versionedfile.PlanWeaveMerge(plan, '<<<<<<< TREE\n',
 
1442
                                                 '>>>>>>> MERGE-SOURCE\n')
 
1443
        return textmerge.merge_lines(self.reprocess)
 
1444
 
 
1445
 
 
1446
class Diff3Merger(Merge3Merger):
 
1447
    """Three-way merger using external diff3 for text merging"""
 
1448
 
 
1449
    def dump_file(self, temp_dir, name, tree, file_id):
 
1450
        out_path = osutils.pathjoin(temp_dir, name)
 
1451
        out_file = open(out_path, "wb")
 
1452
        try:
 
1453
            in_file = tree.get_file(file_id)
 
1454
            for line in in_file:
 
1455
                out_file.write(line)
 
1456
        finally:
 
1457
            out_file.close()
 
1458
        return out_path
 
1459
 
 
1460
    def text_merge(self, file_id, trans_id):
 
1461
        """Perform a diff3 merge using a specified file-id and trans-id.
 
1462
        If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
 
1463
        will be dumped, and a will be conflict noted.
 
1464
        """
 
1465
        import bzrlib.patch
 
1466
        temp_dir = osutils.mkdtemp(prefix="bzr-")
 
1467
        try:
 
1468
            new_file = osutils.pathjoin(temp_dir, "new")
 
1469
            this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
 
1470
            base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
 
1471
            other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
 
1472
            status = bzrlib.patch.diff3(new_file, this, base, other)
 
1473
            if status not in (0, 1):
 
1474
                raise errors.BzrError("Unhandled diff3 exit code")
 
1475
            f = open(new_file, 'rb')
 
1476
            try:
 
1477
                self.tt.create_file(f, trans_id)
 
1478
            finally:
 
1479
                f.close()
 
1480
            if status == 1:
 
1481
                name = self.tt.final_name(trans_id)
 
1482
                parent_id = self.tt.final_parent(trans_id)
 
1483
                self._dump_conflicts(name, parent_id, file_id)
 
1484
                self._raw_conflicts.append(('text conflict', trans_id))
 
1485
        finally:
 
1486
            osutils.rmtree(temp_dir)
 
1487
 
 
1488
 
 
1489
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
 
1490
                backup_files=False,
 
1491
                merge_type=Merge3Merger,
 
1492
                interesting_ids=None,
 
1493
                show_base=False,
 
1494
                reprocess=False,
 
1495
                other_rev_id=None,
 
1496
                interesting_files=None,
 
1497
                this_tree=None,
 
1498
                pb=progress.DummyProgress(),
 
1499
                change_reporter=None):
 
1500
    """Primary interface for merging.
 
1501
 
 
1502
        typical use is probably
 
1503
        'merge_inner(branch, branch.get_revision_tree(other_revision),
 
1504
                     branch.get_revision_tree(base_revision))'
 
1505
        """
 
1506
    if this_tree is None:
 
1507
        raise errors.BzrError("bzrlib.merge.merge_inner requires a this_tree "
 
1508
                              "parameter as of bzrlib version 0.8.")
 
1509
    merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
 
1510
                    pb=pb, change_reporter=change_reporter)
 
1511
    merger.backup_files = backup_files
 
1512
    merger.merge_type = merge_type
 
1513
    merger.interesting_ids = interesting_ids
 
1514
    merger.ignore_zero = ignore_zero
 
1515
    if interesting_files:
 
1516
        if interesting_ids:
 
1517
            raise ValueError('Only supply interesting_ids'
 
1518
                             ' or interesting_files')
 
1519
        merger.interesting_files = interesting_files
 
1520
    merger.show_base = show_base
 
1521
    merger.reprocess = reprocess
 
1522
    merger.other_rev_id = other_rev_id
 
1523
    merger.other_basis = other_rev_id
 
1524
    get_revision_id = getattr(base_tree, 'get_revision_id', None)
 
1525
    if get_revision_id is None:
 
1526
        get_revision_id = base_tree.last_revision
 
1527
    merger.cache_trees_with_revision_ids([other_tree, base_tree, this_tree])
 
1528
    merger.set_base_revision(get_revision_id(), this_branch)
 
1529
    return merger.do_merge()
 
1530
 
 
1531
def get_merge_type_registry():
 
1532
    """Merge type registry is in bzrlib.option to avoid circular imports.
 
1533
 
 
1534
    This method provides a sanctioned way to retrieve it.
 
1535
    """
 
1536
    from bzrlib import option
 
1537
    return option._merge_type_registry
 
1538
 
 
1539
 
 
1540
def _plan_annotate_merge(annotated_a, annotated_b, ancestors_a, ancestors_b):
 
1541
    def status_a(revision, text):
 
1542
        if revision in ancestors_b:
 
1543
            return 'killed-b', text
 
1544
        else:
 
1545
            return 'new-a', text
 
1546
 
 
1547
    def status_b(revision, text):
 
1548
        if revision in ancestors_a:
 
1549
            return 'killed-a', text
 
1550
        else:
 
1551
            return 'new-b', text
 
1552
 
 
1553
    plain_a = [t for (a, t) in annotated_a]
 
1554
    plain_b = [t for (a, t) in annotated_b]
 
1555
    matcher = patiencediff.PatienceSequenceMatcher(None, plain_a, plain_b)
 
1556
    blocks = matcher.get_matching_blocks()
 
1557
    a_cur = 0
 
1558
    b_cur = 0
 
1559
    for ai, bi, l in blocks:
 
1560
        # process all mismatched sections
 
1561
        # (last mismatched section is handled because blocks always
 
1562
        # includes a 0-length last block)
 
1563
        for revision, text in annotated_a[a_cur:ai]:
 
1564
            yield status_a(revision, text)
 
1565
        for revision, text in annotated_b[b_cur:bi]:
 
1566
            yield status_b(revision, text)
 
1567
        # and now the matched section
 
1568
        a_cur = ai + l
 
1569
        b_cur = bi + l
 
1570
        for text_a in plain_a[ai:a_cur]:
 
1571
            yield "unchanged", text_a
 
1572
 
 
1573
 
 
1574
class _PlanMergeBase(object):
 
1575
 
 
1576
    def __init__(self, a_rev, b_rev, vf, key_prefix):
 
1577
        """Contructor.
 
1578
 
 
1579
        :param a_rev: Revision-id of one revision to merge
 
1580
        :param b_rev: Revision-id of the other revision to merge
 
1581
        :param vf: A VersionedFiles containing both revisions
 
1582
        :param key_prefix: A prefix for accessing keys in vf, typically
 
1583
            (file_id,).
 
1584
        """
 
1585
        self.a_rev = a_rev
 
1586
        self.b_rev = b_rev
 
1587
        self.vf = vf
 
1588
        self._last_lines = None
 
1589
        self._last_lines_revision_id = None
 
1590
        self._cached_matching_blocks = {}
 
1591
        self._key_prefix = key_prefix
 
1592
        self._precache_tip_lines()
 
1593
 
 
1594
    def _precache_tip_lines(self):
 
1595
        lines = self.get_lines([self.a_rev, self.b_rev])
 
1596
        self.lines_a = lines[self.a_rev]
 
1597
        self.lines_b = lines[self.b_rev]
 
1598
 
 
1599
    def get_lines(self, revisions):
 
1600
        """Get lines for revisions from the backing VersionedFiles.
 
1601
 
 
1602
        :raises RevisionNotPresent: on absent texts.
 
1603
        """
 
1604
        keys = [(self._key_prefix + (rev,)) for rev in revisions]
 
1605
        result = {}
 
1606
        for record in self.vf.get_record_stream(keys, 'unordered', True):
 
1607
            if record.storage_kind == 'absent':
 
1608
                raise errors.RevisionNotPresent(record.key, self.vf)
 
1609
            result[record.key[-1]] = osutils.chunks_to_lines(
 
1610
                record.get_bytes_as('chunked'))
 
1611
        return result
 
1612
 
 
1613
    def plan_merge(self):
 
1614
        """Generate a 'plan' for merging the two revisions.
 
1615
 
 
1616
        This involves comparing their texts and determining the cause of
 
1617
        differences.  If text A has a line and text B does not, then either the
 
1618
        line was added to text A, or it was deleted from B.  Once the causes
 
1619
        are combined, they are written out in the format described in
 
1620
        VersionedFile.plan_merge
 
1621
        """
 
1622
        blocks = self._get_matching_blocks(self.a_rev, self.b_rev)
 
1623
        unique_a, unique_b = self._unique_lines(blocks)
 
1624
        new_a, killed_b = self._determine_status(self.a_rev, unique_a)
 
1625
        new_b, killed_a = self._determine_status(self.b_rev, unique_b)
 
1626
        return self._iter_plan(blocks, new_a, killed_b, new_b, killed_a)
 
1627
 
 
1628
    def _iter_plan(self, blocks, new_a, killed_b, new_b, killed_a):
 
1629
        last_i = 0
 
1630
        last_j = 0
 
1631
        for i, j, n in blocks:
 
1632
            for a_index in range(last_i, i):
 
1633
                if a_index in new_a:
 
1634
                    if a_index in killed_b:
 
1635
                        yield 'conflicted-a', self.lines_a[a_index]
 
1636
                    else:
 
1637
                        yield 'new-a', self.lines_a[a_index]
 
1638
                else:
 
1639
                    yield 'killed-b', self.lines_a[a_index]
 
1640
            for b_index in range(last_j, j):
 
1641
                if b_index in new_b:
 
1642
                    if b_index in killed_a:
 
1643
                        yield 'conflicted-b', self.lines_b[b_index]
 
1644
                    else:
 
1645
                        yield 'new-b', self.lines_b[b_index]
 
1646
                else:
 
1647
                    yield 'killed-a', self.lines_b[b_index]
 
1648
            # handle common lines
 
1649
            for a_index in range(i, i+n):
 
1650
                yield 'unchanged', self.lines_a[a_index]
 
1651
            last_i = i+n
 
1652
            last_j = j+n
 
1653
 
 
1654
    def _get_matching_blocks(self, left_revision, right_revision):
 
1655
        """Return a description of which sections of two revisions match.
 
1656
 
 
1657
        See SequenceMatcher.get_matching_blocks
 
1658
        """
 
1659
        cached = self._cached_matching_blocks.get((left_revision,
 
1660
                                                   right_revision))
 
1661
        if cached is not None:
 
1662
            return cached
 
1663
        if self._last_lines_revision_id == left_revision:
 
1664
            left_lines = self._last_lines
 
1665
            right_lines = self.get_lines([right_revision])[right_revision]
 
1666
        else:
 
1667
            lines = self.get_lines([left_revision, right_revision])
 
1668
            left_lines = lines[left_revision]
 
1669
            right_lines = lines[right_revision]
 
1670
        self._last_lines = right_lines
 
1671
        self._last_lines_revision_id = right_revision
 
1672
        matcher = patiencediff.PatienceSequenceMatcher(None, left_lines,
 
1673
                                                       right_lines)
 
1674
        return matcher.get_matching_blocks()
 
1675
 
 
1676
    def _unique_lines(self, matching_blocks):
 
1677
        """Analyse matching_blocks to determine which lines are unique
 
1678
 
 
1679
        :return: a tuple of (unique_left, unique_right), where the values are
 
1680
            sets of line numbers of unique lines.
 
1681
        """
 
1682
        last_i = 0
 
1683
        last_j = 0
 
1684
        unique_left = []
 
1685
        unique_right = []
 
1686
        for i, j, n in matching_blocks:
 
1687
            unique_left.extend(range(last_i, i))
 
1688
            unique_right.extend(range(last_j, j))
 
1689
            last_i = i + n
 
1690
            last_j = j + n
 
1691
        return unique_left, unique_right
 
1692
 
 
1693
    @staticmethod
 
1694
    def _subtract_plans(old_plan, new_plan):
 
1695
        """Remove changes from new_plan that came from old_plan.
 
1696
 
 
1697
        It is assumed that the difference between the old_plan and new_plan
 
1698
        is their choice of 'b' text.
 
1699
 
 
1700
        All lines from new_plan that differ from old_plan are emitted
 
1701
        verbatim.  All lines from new_plan that match old_plan but are
 
1702
        not about the 'b' revision are emitted verbatim.
 
1703
 
 
1704
        Lines that match and are about the 'b' revision are the lines we
 
1705
        don't want, so we convert 'killed-b' -> 'unchanged', and 'new-b'
 
1706
        is skipped entirely.
 
1707
        """
 
1708
        matcher = patiencediff.PatienceSequenceMatcher(None, old_plan,
 
1709
                                                       new_plan)
 
1710
        last_j = 0
 
1711
        for i, j, n in matcher.get_matching_blocks():
 
1712
            for jj in range(last_j, j):
 
1713
                yield new_plan[jj]
 
1714
            for jj in range(j, j+n):
 
1715
                plan_line = new_plan[jj]
 
1716
                if plan_line[0] == 'new-b':
 
1717
                    pass
 
1718
                elif plan_line[0] == 'killed-b':
 
1719
                    yield 'unchanged', plan_line[1]
 
1720
                else:
 
1721
                    yield plan_line
 
1722
            last_j = j + n
 
1723
 
 
1724
 
 
1725
class _PlanMerge(_PlanMergeBase):
 
1726
    """Plan an annotate merge using on-the-fly annotation"""
 
1727
 
 
1728
    def __init__(self, a_rev, b_rev, vf, key_prefix):
 
1729
        super(_PlanMerge, self).__init__(a_rev, b_rev, vf, key_prefix)
 
1730
        self.a_key = self._key_prefix + (self.a_rev,)
 
1731
        self.b_key = self._key_prefix + (self.b_rev,)
 
1732
        self.graph = _mod_graph.Graph(self.vf)
 
1733
        heads = self.graph.heads((self.a_key, self.b_key))
 
1734
        if len(heads) == 1:
 
1735
            # one side dominates, so we can just return its values, yay for
 
1736
            # per-file graphs
 
1737
            # Ideally we would know that before we get this far
 
1738
            self._head_key = heads.pop()
 
1739
            if self._head_key == self.a_key:
 
1740
                other = b_rev
 
1741
            else:
 
1742
                other = a_rev
 
1743
            trace.mutter('found dominating revision for %s\n%s > %s', self.vf,
 
1744
                         self._head_key[-1], other)
 
1745
            self._weave = None
 
1746
        else:
 
1747
            self._head_key = None
 
1748
            self._build_weave()
 
1749
 
 
1750
    def _precache_tip_lines(self):
 
1751
        # Turn this into a no-op, because we will do this later
 
1752
        pass
 
1753
 
 
1754
    def _find_recursive_lcas(self):
 
1755
        """Find all the ancestors back to a unique lca"""
 
1756
        cur_ancestors = (self.a_key, self.b_key)
 
1757
        # graph.find_lca(uncommon, keys) now returns plain NULL_REVISION,
 
1758
        # rather than a key tuple. We will just map that directly to no common
 
1759
        # ancestors.
 
1760
        parent_map = {}
 
1761
        while True:
 
1762
            next_lcas = self.graph.find_lca(*cur_ancestors)
 
1763
            # Map a plain NULL_REVISION to a simple no-ancestors
 
1764
            if next_lcas == set([_mod_revision.NULL_REVISION]):
 
1765
                next_lcas = ()
 
1766
            # Order the lca's based on when they were merged into the tip
 
1767
            # While the actual merge portion of weave merge uses a set() of
 
1768
            # active revisions, the order of insertion *does* effect the
 
1769
            # implicit ordering of the texts.
 
1770
            for rev_key in cur_ancestors:
 
1771
                ordered_parents = tuple(self.graph.find_merge_order(rev_key,
 
1772
                                                                    next_lcas))
 
1773
                parent_map[rev_key] = ordered_parents
 
1774
            if len(next_lcas) == 0:
 
1775
                break
 
1776
            elif len(next_lcas) == 1:
 
1777
                parent_map[list(next_lcas)[0]] = ()
 
1778
                break
 
1779
            elif len(next_lcas) > 2:
 
1780
                # More than 2 lca's, fall back to grabbing all nodes between
 
1781
                # this and the unique lca.
 
1782
                trace.mutter('More than 2 LCAs, falling back to all nodes for:'
 
1783
                             ' %s, %s\n=> %s',
 
1784
                             self.a_key, self.b_key, cur_ancestors)
 
1785
                cur_lcas = next_lcas
 
1786
                while len(cur_lcas) > 1:
 
1787
                    cur_lcas = self.graph.find_lca(*cur_lcas)
 
1788
                if len(cur_lcas) == 0:
 
1789
                    # No common base to find, use the full ancestry
 
1790
                    unique_lca = None
 
1791
                else:
 
1792
                    unique_lca = list(cur_lcas)[0]
 
1793
                    if unique_lca == _mod_revision.NULL_REVISION:
 
1794
                        # find_lca will return a plain 'NULL_REVISION' rather
 
1795
                        # than a key tuple when there is no common ancestor, we
 
1796
                        # prefer to just use None, because it doesn't confuse
 
1797
                        # _get_interesting_texts()
 
1798
                        unique_lca = None
 
1799
                parent_map.update(self._find_unique_parents(next_lcas,
 
1800
                                                            unique_lca))
 
1801
                break
 
1802
            cur_ancestors = next_lcas
 
1803
        return parent_map
 
1804
 
 
1805
    def _find_unique_parents(self, tip_keys, base_key):
 
1806
        """Find ancestors of tip that aren't ancestors of base.
 
1807
 
 
1808
        :param tip_keys: Nodes that are interesting
 
1809
        :param base_key: Cull all ancestors of this node
 
1810
        :return: The parent map for all revisions between tip_keys and
 
1811
            base_key. base_key will be included. References to nodes outside of
 
1812
            the ancestor set will also be removed.
 
1813
        """
 
1814
        # TODO: this would be simpler if find_unique_ancestors took a list
 
1815
        #       instead of a single tip, internally it supports it, but it
 
1816
        #       isn't a "backwards compatible" api change.
 
1817
        if base_key is None:
 
1818
            parent_map = dict(self.graph.iter_ancestry(tip_keys))
 
1819
            # We remove NULL_REVISION because it isn't a proper tuple key, and
 
1820
            # thus confuses things like _get_interesting_texts, and our logic
 
1821
            # to add the texts into the memory weave.
 
1822
            if _mod_revision.NULL_REVISION in parent_map:
 
1823
                parent_map.pop(_mod_revision.NULL_REVISION)
 
1824
        else:
 
1825
            interesting = set()
 
1826
            for tip in tip_keys:
 
1827
                interesting.update(
 
1828
                    self.graph.find_unique_ancestors(tip, [base_key]))
 
1829
            parent_map = self.graph.get_parent_map(interesting)
 
1830
            parent_map[base_key] = ()
 
1831
        culled_parent_map, child_map, tails = self._remove_external_references(
 
1832
            parent_map)
 
1833
        # Remove all the tails but base_key
 
1834
        if base_key is not None:
 
1835
            tails.remove(base_key)
 
1836
            self._prune_tails(culled_parent_map, child_map, tails)
 
1837
        # Now remove all the uninteresting 'linear' regions
 
1838
        simple_map = _mod_graph.collapse_linear_regions(culled_parent_map)
 
1839
        return simple_map
 
1840
 
 
1841
    @staticmethod
 
1842
    def _remove_external_references(parent_map):
 
1843
        """Remove references that go outside of the parent map.
 
1844
 
 
1845
        :param parent_map: Something returned from Graph.get_parent_map(keys)
 
1846
        :return: (filtered_parent_map, child_map, tails)
 
1847
            filtered_parent_map is parent_map without external references
 
1848
            child_map is the {parent_key: [child_keys]} mapping
 
1849
            tails is a list of nodes that do not have any parents in the map
 
1850
        """
 
1851
        # TODO: The basic effect of this function seems more generic than
 
1852
        #       _PlanMerge. But the specific details of building a child_map,
 
1853
        #       and computing tails seems very specific to _PlanMerge.
 
1854
        #       Still, should this be in Graph land?
 
1855
        filtered_parent_map = {}
 
1856
        child_map = {}
 
1857
        tails = []
 
1858
        for key, parent_keys in parent_map.iteritems():
 
1859
            culled_parent_keys = [p for p in parent_keys if p in parent_map]
 
1860
            if not culled_parent_keys:
 
1861
                tails.append(key)
 
1862
            for parent_key in culled_parent_keys:
 
1863
                child_map.setdefault(parent_key, []).append(key)
 
1864
            # TODO: Do we want to do this, it adds overhead for every node,
 
1865
            #       just to say that the node has no children
 
1866
            child_map.setdefault(key, [])
 
1867
            filtered_parent_map[key] = culled_parent_keys
 
1868
        return filtered_parent_map, child_map, tails
 
1869
 
 
1870
    @staticmethod
 
1871
    def _prune_tails(parent_map, child_map, tails_to_remove):
 
1872
        """Remove tails from the parent map.
 
1873
 
 
1874
        This will remove the supplied revisions until no more children have 0
 
1875
        parents.
 
1876
 
 
1877
        :param parent_map: A dict of {child: [parents]}, this dictionary will
 
1878
            be modified in place.
 
1879
        :param tails_to_remove: A list of tips that should be removed,
 
1880
            this list will be consumed
 
1881
        :param child_map: The reverse dict of parent_map ({parent: [children]})
 
1882
            this dict will be modified
 
1883
        :return: None, parent_map will be modified in place.
 
1884
        """
 
1885
        while tails_to_remove:
 
1886
            next = tails_to_remove.pop()
 
1887
            parent_map.pop(next)
 
1888
            children = child_map.pop(next)
 
1889
            for child in children:
 
1890
                child_parents = parent_map[child]
 
1891
                child_parents.remove(next)
 
1892
                if len(child_parents) == 0:
 
1893
                    tails_to_remove.append(child)
 
1894
 
 
1895
    def _get_interesting_texts(self, parent_map):
 
1896
        """Return a dict of texts we are interested in.
 
1897
 
 
1898
        Note that the input is in key tuples, but the output is in plain
 
1899
        revision ids.
 
1900
 
 
1901
        :param parent_map: The output from _find_recursive_lcas
 
1902
        :return: A dict of {'revision_id':lines} as returned by
 
1903
            _PlanMergeBase.get_lines()
 
1904
        """
 
1905
        all_revision_keys = set(parent_map)
 
1906
        all_revision_keys.add(self.a_key)
 
1907
        all_revision_keys.add(self.b_key)
 
1908
 
 
1909
        # Everything else is in 'keys' but get_lines is in 'revision_ids'
 
1910
        all_texts = self.get_lines([k[-1] for k in all_revision_keys])
 
1911
        return all_texts
 
1912
 
 
1913
    def _build_weave(self):
 
1914
        from bzrlib import weave
 
1915
        self._weave = weave.Weave(weave_name='in_memory_weave',
 
1916
                                  allow_reserved=True)
 
1917
        parent_map = self._find_recursive_lcas()
 
1918
 
 
1919
        all_texts = self._get_interesting_texts(parent_map)
 
1920
 
 
1921
        # Note: Unfortunately, the order given by topo_sort will effect the
 
1922
        # ordering resolution in the output. Specifically, if you add A then B,
 
1923
        # then in the output text A lines will show up before B lines. And, of
 
1924
        # course, topo_sort doesn't guarantee any real ordering.
 
1925
        # So we use merge_sort, and add a fake node on the tip.
 
1926
        # This ensures that left-hand parents will always be inserted into the
 
1927
        # weave before right-hand parents.
 
1928
        tip_key = self._key_prefix + (_mod_revision.CURRENT_REVISION,)
 
1929
        parent_map[tip_key] = (self.a_key, self.b_key)
 
1930
 
 
1931
        for seq_num, key, depth, eom in reversed(tsort.merge_sort(parent_map,
 
1932
                                                                  tip_key)):
 
1933
            if key == tip_key:
 
1934
                continue
 
1935
        # for key in tsort.topo_sort(parent_map):
 
1936
            parent_keys = parent_map[key]
 
1937
            revision_id = key[-1]
 
1938
            parent_ids = [k[-1] for k in parent_keys]
 
1939
            self._weave.add_lines(revision_id, parent_ids,
 
1940
                                  all_texts[revision_id])
 
1941
 
 
1942
    def plan_merge(self):
 
1943
        """Generate a 'plan' for merging the two revisions.
 
1944
 
 
1945
        This involves comparing their texts and determining the cause of
 
1946
        differences.  If text A has a line and text B does not, then either the
 
1947
        line was added to text A, or it was deleted from B.  Once the causes
 
1948
        are combined, they are written out in the format described in
 
1949
        VersionedFile.plan_merge
 
1950
        """
 
1951
        if self._head_key is not None: # There was a single head
 
1952
            if self._head_key == self.a_key:
 
1953
                plan = 'new-a'
 
1954
            else:
 
1955
                if self._head_key != self.b_key:
 
1956
                    raise AssertionError('There was an invalid head: %s != %s'
 
1957
                                         % (self.b_key, self._head_key))
 
1958
                plan = 'new-b'
 
1959
            head_rev = self._head_key[-1]
 
1960
            lines = self.get_lines([head_rev])[head_rev]
 
1961
            return ((plan, line) for line in lines)
 
1962
        return self._weave.plan_merge(self.a_rev, self.b_rev)
 
1963
 
 
1964
 
 
1965
class _PlanLCAMerge(_PlanMergeBase):
 
1966
    """
 
1967
    This merge algorithm differs from _PlanMerge in that:
 
1968
    1. comparisons are done against LCAs only
 
1969
    2. cases where a contested line is new versus one LCA but old versus
 
1970
       another are marked as conflicts, by emitting the line as conflicted-a
 
1971
       or conflicted-b.
 
1972
 
 
1973
    This is faster, and hopefully produces more useful output.
 
1974
    """
 
1975
 
 
1976
    def __init__(self, a_rev, b_rev, vf, key_prefix, graph):
 
1977
        _PlanMergeBase.__init__(self, a_rev, b_rev, vf, key_prefix)
 
1978
        lcas = graph.find_lca(key_prefix + (a_rev,), key_prefix + (b_rev,))
 
1979
        self.lcas = set()
 
1980
        for lca in lcas:
 
1981
            if lca == _mod_revision.NULL_REVISION:
 
1982
                self.lcas.add(lca)
 
1983
            else:
 
1984
                self.lcas.add(lca[-1])
 
1985
        for lca in self.lcas:
 
1986
            if _mod_revision.is_null(lca):
 
1987
                lca_lines = []
 
1988
            else:
 
1989
                lca_lines = self.get_lines([lca])[lca]
 
1990
            matcher = patiencediff.PatienceSequenceMatcher(None, self.lines_a,
 
1991
                                                           lca_lines)
 
1992
            blocks = list(matcher.get_matching_blocks())
 
1993
            self._cached_matching_blocks[(a_rev, lca)] = blocks
 
1994
            matcher = patiencediff.PatienceSequenceMatcher(None, self.lines_b,
 
1995
                                                           lca_lines)
 
1996
            blocks = list(matcher.get_matching_blocks())
 
1997
            self._cached_matching_blocks[(b_rev, lca)] = blocks
 
1998
 
 
1999
    def _determine_status(self, revision_id, unique_line_numbers):
 
2000
        """Determines the status unique lines versus all lcas.
 
2001
 
 
2002
        Basically, determines why the line is unique to this revision.
 
2003
 
 
2004
        A line may be determined new, killed, or both.
 
2005
 
 
2006
        If a line is determined new, that means it was not present in at least
 
2007
        one LCA, and is not present in the other merge revision.
 
2008
 
 
2009
        If a line is determined killed, that means the line was present in
 
2010
        at least one LCA.
 
2011
 
 
2012
        If a line is killed and new, this indicates that the two merge
 
2013
        revisions contain differing conflict resolutions.
 
2014
        :param revision_id: The id of the revision in which the lines are
 
2015
            unique
 
2016
        :param unique_line_numbers: The line numbers of unique lines.
 
2017
        :return a tuple of (new_this, killed_other):
 
2018
        """
 
2019
        new = set()
 
2020
        killed = set()
 
2021
        unique_line_numbers = set(unique_line_numbers)
 
2022
        for lca in self.lcas:
 
2023
            blocks = self._get_matching_blocks(revision_id, lca)
 
2024
            unique_vs_lca, _ignored = self._unique_lines(blocks)
 
2025
            new.update(unique_line_numbers.intersection(unique_vs_lca))
 
2026
            killed.update(unique_line_numbers.difference(unique_vs_lca))
 
2027
        return new, killed