~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

  • Committer: Marien Zwart
  • Date: 2006-02-12 22:40:24 UTC
  • mto: (1185.50.78 bzr-jam-integration)
  • mto: This revision was merged to the branch mainline in revision 1554.
  • Revision ID: marienz@gentoo.org-20060212224024-782d3bcc922d980c
Remove a useless local function.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
2
 
#
 
1
# Copyright (C) 2005 Canonical Ltd
 
2
 
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
#
 
7
 
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
#
 
12
 
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
 
17
# TODO: build_working_dir can be built on something simpler than merge()
17
18
 
18
19
import os
19
20
import errno
20
 
import warnings
21
21
 
22
 
from bzrlib import (
23
 
    errors,
24
 
    osutils,
25
 
    patiencediff,
26
 
    registry,
27
 
    revision as _mod_revision,
28
 
    )
 
22
import bzrlib
 
23
from bzrlib._changeset import generate_changeset, ExceptionConflictHandler
 
24
from bzrlib._changeset import Inventory, Diff3Merge, ReplaceContents
 
25
from bzrlib._merge_core import WeaveMerge
 
26
from bzrlib._merge_core import merge_flex, ApplyMerge3, BackupBeforeChange
29
27
from bzrlib.branch import Branch
30
 
from bzrlib.conflicts import ConflictList, Conflict
 
28
from bzrlib.delta import compare_trees
31
29
from bzrlib.errors import (BzrCommandError,
32
30
                           BzrError,
33
31
                           NoCommonAncestor,
34
32
                           NoCommits,
35
33
                           NoSuchRevision,
36
 
                           NoSuchFile,
37
34
                           NotBranchError,
38
35
                           NotVersionedError,
39
36
                           UnrelatedBranches,
40
 
                           UnsupportedOperation,
41
37
                           WorkingTreeNotRevision,
42
 
                           BinaryFile,
43
38
                           )
44
 
from bzrlib.merge3 import Merge3
 
39
from bzrlib.fetch import greedy_fetch, fetch
 
40
import bzrlib.osutils
45
41
from bzrlib.osutils import rename, pathjoin
46
 
from progress import DummyProgress, ProgressPhase
47
 
from bzrlib.revision import (is_ancestor, NULL_REVISION, ensure_null)
48
 
from bzrlib.textfile import check_text_lines
 
42
from bzrlib.revision import common_ancestor, is_ancestor, NULL_REVISION
49
43
from bzrlib.trace import mutter, warning, note
50
 
from bzrlib.transform import (TreeTransform, resolve_conflicts, cook_conflicts,
51
 
                              conflict_pass, FinalPaths, create_by_entry,
52
 
                              unique_add, ROOT_PARENT)
53
 
from bzrlib.versionedfile import PlanWeaveMerge
54
 
from bzrlib import ui
 
44
from bzrlib.workingtree import WorkingTree
55
45
 
56
46
# TODO: Report back as changes are merged in
57
47
 
 
48
# comments from abentley on irc: merge happens in two stages, each
 
49
# of which generates a changeset object
 
50
 
 
51
# stage 1: generate OLD->OTHER,
 
52
# stage 2: use MINE and OLD->OTHER to generate MINE -> RESULT
 
53
 
 
54
class _MergeConflictHandler(ExceptionConflictHandler):
 
55
    """Handle conflicts encountered while merging.
 
56
 
 
57
    This subclasses ExceptionConflictHandler, so that any types of
 
58
    conflict that are not explicitly handled cause an exception and
 
59
    terminate the merge.
 
60
    """
 
61
    def __init__(self, this_tree, base_tree, other_tree, ignore_zero=False):
 
62
        ExceptionConflictHandler.__init__(self)
 
63
        self.conflicts = 0
 
64
        self.ignore_zero = ignore_zero
 
65
        self.this_tree = this_tree
 
66
        self.base_tree = base_tree
 
67
        self.other_tree = other_tree
 
68
 
 
69
    def copy(self, source, dest):
 
70
        """Copy the text and mode of a file
 
71
        :param source: The path of the file to copy
 
72
        :param dest: The distination file to create
 
73
        """
 
74
        s_file = file(source, "rb")
 
75
        d_file = file(dest, "wb")
 
76
        for line in s_file:
 
77
            d_file.write(line)
 
78
        os.chmod(dest, 0777 & os.stat(source).st_mode)
 
79
 
 
80
    def dump(self, lines, dest):
 
81
        """Copy the text and mode of a file
 
82
        :param source: The path of the file to copy
 
83
        :param dest: The distination file to create
 
84
        """
 
85
        d_file = file(dest, "wb")
 
86
        for line in lines:
 
87
            d_file.write(line)
 
88
 
 
89
    def add_suffix(self, name, suffix, last_new_name=None, fix_inventory=True):
 
90
        """Rename a file to append a suffix.  If the new name exists, the
 
91
        suffix is added repeatedly until a non-existant name is found
 
92
 
 
93
        :param name: The path of the file
 
94
        :param suffix: The suffix to append
 
95
        :param last_new_name: (used for recursive calls) the last name tried
 
96
        """
 
97
        if last_new_name is None:
 
98
            last_new_name = name
 
99
        new_name = last_new_name+suffix
 
100
        try:
 
101
            rename(name, new_name)
 
102
            if fix_inventory is True:
 
103
                try:
 
104
                    relpath = self.this_tree.relpath(name)
 
105
                except NotBranchError:
 
106
                    relpath = None
 
107
                if relpath is not None:
 
108
                    file_id = self.this_tree.path2id(relpath)
 
109
                    if file_id is not None:
 
110
                        new_path = self.this_tree.relpath(new_name)
 
111
                        rename(new_name, name)
 
112
                        self.this_tree.rename_one(relpath, new_path)
 
113
                        assert self.this_tree.id2path(file_id) == new_path
 
114
        except OSError, e:
 
115
            if e.errno != errno.EEXIST and e.errno != errno.ENOTEMPTY:
 
116
                raise
 
117
            return self.add_suffix(name, suffix, last_new_name=new_name, 
 
118
                                   fix_inventory=fix_inventory)
 
119
        return new_name
 
120
 
 
121
    def conflict(self, text):
 
122
        warning(text)
 
123
        self.conflicts += 1
 
124
        
 
125
 
 
126
    def merge_conflict(self, new_file, this_path, base_lines, other_lines):
 
127
        """
 
128
        Handle diff3 conflicts by producing a .THIS, .BASE and .OTHER.  The
 
129
        main file will be a version with diff3 conflicts.
 
130
        :param new_file: Path to the output file with diff3 markers
 
131
        :param this_path: Path to the file text for the THIS tree
 
132
        :param base_path: Path to the file text for the BASE tree
 
133
        :param other_path: Path to the file text for the OTHER tree
 
134
        """
 
135
        self.add_suffix(this_path, ".THIS", fix_inventory=False)
 
136
        self.dump(base_lines, this_path+".BASE")
 
137
        self.dump(other_lines, this_path+".OTHER")
 
138
        rename(new_file, this_path)
 
139
        self.conflict("Diff3 conflict encountered in %s" % this_path)
 
140
 
 
141
    def weave_merge_conflict(self, filename, weave, other_i, out_file):
 
142
        """
 
143
        Handle weave conflicts by producing a .THIS, and .OTHER.  The
 
144
        main file will be a version with diff3-style conflicts.
 
145
        """
 
146
        self.add_suffix(filename, ".THIS", fix_inventory=False)
 
147
        out_file.commit()
 
148
        self.dump(weave.get_iter(other_i), filename+".OTHER")
 
149
        self.conflict("Text conflict encountered in %s" % filename)
 
150
 
 
151
    def new_contents_conflict(self, filename, other_contents):
 
152
        """Conflicting contents for newly added file."""
 
153
        other_contents(filename + ".OTHER", self, False)
 
154
        self.conflict("Conflict in newly added file %s" % filename)
 
155
    
 
156
 
 
157
    def target_exists(self, entry, target, old_path):
 
158
        """Handle the case when the target file or dir exists"""
 
159
        moved_path = self.add_suffix(target, ".moved")
 
160
        self.conflict("Moved existing %s to %s" % (target, moved_path))
 
161
 
 
162
    def rmdir_non_empty(self, filename):
 
163
        """Handle the case where the dir to be removed still has contents"""
 
164
        self.conflict("Directory %s not removed because it is not empty"\
 
165
            % filename)
 
166
        return "skip"
 
167
 
 
168
    def rem_contents_conflict(self, filename, this_contents, base_contents):
 
169
        base_contents(filename+".BASE", self)
 
170
        this_contents(filename+".THIS", self)
 
171
        self.conflict("Other branch deleted locally modified file %s" %
 
172
                      filename)
 
173
        return ReplaceContents(this_contents, None)
 
174
 
 
175
    def abs_this_path(self, file_id):
 
176
        """Return the absolute path for a file_id in the this tree."""
 
177
        return self.this_tree.id2abspath(file_id)
 
178
 
 
179
    def add_missing_parents(self, file_id, tree):
 
180
        """If some of the parents for file_id are missing, add them."""
 
181
        entry = tree.inventory[file_id]
 
182
        if entry.parent_id not in self.this_tree:
 
183
            return self.create_all_missing(entry.parent_id, tree)
 
184
        else:
 
185
            return self.abs_this_path(entry.parent_id)
 
186
 
 
187
    def create_all_missing(self, file_id, tree):
 
188
        """Add contents for a file_id and all its parents to a tree."""
 
189
        entry = tree.inventory[file_id]
 
190
        if entry.parent_id is not None and entry.parent_id not in self.this_tree:
 
191
            abspath = self.create_all_missing(entry.parent_id, tree)
 
192
        else:
 
193
            abspath = self.abs_this_path(entry.parent_id)
 
194
        entry_path = pathjoin(abspath, entry.name)
 
195
        if not os.path.isdir(entry_path):
 
196
            self.create(file_id, entry_path, tree)
 
197
        return entry_path
 
198
 
 
199
    def create(self, file_id, path, tree):
 
200
        """Uses tree data to create a filesystem object for the file_id"""
 
201
        from bzrlib._changeset import get_contents
 
202
        get_contents(tree, file_id)(path, self)
 
203
 
 
204
    def missing_for_merge(self, file_id, other_path):
 
205
        """The file_id doesn't exist in THIS, but does in OTHER and BASE"""
 
206
        self.conflict("Other branch modified locally deleted file %s" %
 
207
                      other_path)
 
208
        parent_dir = self.add_missing_parents(file_id, self.other_tree)
 
209
        stem = pathjoin(parent_dir, os.path.basename(other_path))
 
210
        self.create(file_id, stem+".OTHER", self.other_tree)
 
211
        self.create(file_id, stem+".BASE", self.base_tree)
 
212
 
 
213
    def threeway_contents_conflict(filename, this_contents, base_contents,
 
214
                                   other_contents):
 
215
        self.conflict("Three-way conflict merging %s" % filename)
 
216
 
 
217
    def finalize(self):
 
218
        if self.conflicts == 0:
 
219
            if not self.ignore_zero:
 
220
                note("All changes applied successfully.")
 
221
        else:
 
222
            note("%d conflicts encountered." % self.conflicts)
 
223
 
 
224
def _get_tree(treespec, local_branch=None):
 
225
    location, revno = treespec
 
226
    branch = Branch.open_containing(location)[0]
 
227
    if revno is None:
 
228
        revision = None
 
229
    elif revno == -1:
 
230
        revision = branch.last_revision()
 
231
    else:
 
232
        revision = branch.get_rev_id(revno)
 
233
        if revision is None:
 
234
            revision = NULL_REVISION
 
235
    return branch, _get_revid_tree(branch, revision, local_branch)
 
236
 
 
237
 
 
238
def _get_revid_tree(branch, revision, local_branch):
 
239
    if revision is None:
 
240
        base_tree = branch.working_tree()
 
241
    else:
 
242
        if local_branch is not None:
 
243
            if local_branch.base != branch.base:
 
244
                greedy_fetch(local_branch, branch, revision)
 
245
            base_tree = local_branch.repository.revision_tree(revision)
 
246
        else:
 
247
            base_tree = branch.repository.revision_tree(revision)
 
248
    return base_tree
 
249
 
 
250
 
 
251
def build_working_dir(to_dir):
 
252
    """Build a working directory in an empty directory.
 
253
 
 
254
    to_dir is a directory containing branch metadata but no working files,
 
255
    typically constructed by cloning an existing branch. 
 
256
 
 
257
    This is split out as a special idiomatic case of merge.  It could
 
258
    eventually be done by just building the tree directly calling into 
 
259
    lower-level code (e.g. constructing a changeset).
 
260
    """
 
261
    # RBC 20051019 is this not just 'export' ?
 
262
    # AB Well, export doesn't take care of inventory...
 
263
    this_branch = Branch.open_containing(to_dir)[0]
 
264
    transform_tree(this_branch.working_tree(), this_branch.basis_tree())
 
265
 
58
266
 
59
267
def transform_tree(from_tree, to_tree, interesting_ids=None):
60
268
    merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
61
 
                interesting_ids=interesting_ids, this_tree=from_tree)
 
269
                interesting_ids=interesting_ids)
 
270
 
 
271
 
 
272
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
 
273
                backup_files=False, 
 
274
                merge_type=ApplyMerge3, 
 
275
                interesting_ids=None, 
 
276
                show_base=False, 
 
277
                reprocess=False, 
 
278
                other_rev_id=None,
 
279
                interesting_files=None,
 
280
                this_tree=None):
 
281
    """Primary interface for merging. 
 
282
 
 
283
        typical use is probably 
 
284
        'merge_inner(branch, branch.get_revision_tree(other_revision),
 
285
                     branch.get_revision_tree(base_revision))'
 
286
        """
 
287
    if this_tree is None:
 
288
        this_tree = this_branch.working_tree()
 
289
    merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree)
 
290
    merger.backup_files = backup_files
 
291
    merger.merge_type = merge_type
 
292
    merger.interesting_ids = interesting_ids
 
293
    if interesting_files:
 
294
        assert not interesting_ids, ('Only supply interesting_ids'
 
295
                                     ' or interesting_files')
 
296
        merger._set_interesting_files(interesting_files)
 
297
    merger.show_base = show_base 
 
298
    merger.reprocess = reprocess
 
299
    merger.conflict_handler = _MergeConflictHandler(merger.this_tree, 
 
300
                                                    base_tree, other_tree,
 
301
                                                    ignore_zero=ignore_zero)
 
302
    merger.other_rev_id = other_rev_id
 
303
    merger.other_basis = other_rev_id
 
304
    return merger.do_merge()
62
305
 
63
306
 
64
307
class Merger(object):
65
 
    def __init__(self, this_branch, other_tree=None, base_tree=None,
66
 
                 this_tree=None, pb=DummyProgress(), change_reporter=None,
67
 
                 recurse='down'):
 
308
    def __init__(self, this_branch, other_tree=None, base_tree=None, this_tree=None):
68
309
        object.__init__(self)
69
310
        assert this_tree is not None, "this_tree is required"
70
311
        self.this_branch = this_branch
71
 
        self.this_basis = _mod_revision.ensure_null(
72
 
            this_branch.last_revision())
 
312
        self.this_basis = this_branch.last_revision()
73
313
        self.this_rev_id = None
74
314
        self.this_tree = this_tree
75
315
        self.this_revision_tree = None
76
316
        self.this_basis_tree = None
77
317
        self.other_tree = other_tree
78
 
        self.other_branch = None
79
318
        self.base_tree = base_tree
80
319
        self.ignore_zero = False
81
320
        self.backup_files = False
82
321
        self.interesting_ids = None
83
 
        self.interesting_files = None
84
322
        self.show_base = False
85
323
        self.reprocess = False
86
 
        self._pb = pb
87
 
        self.pp = None
88
 
        self.recurse = recurse
89
 
        self.change_reporter = change_reporter
90
 
        self._cached_trees = {}
91
 
 
92
 
    @staticmethod
93
 
    def from_uncommitted(tree, other_tree, pb):
94
 
        """Return a Merger for uncommitted changes in other_tree.
95
 
 
96
 
        :param tree: The tree to merge into
97
 
        :param other_tree: The tree to get uncommitted changes from
98
 
        :param pb: A progress indicator
99
 
        """
100
 
        merger = Merger(tree.branch, other_tree, other_tree.basis_tree(), tree,
101
 
                        pb)
102
 
        merger.base_rev_id = merger.base_tree.get_revision_id()
103
 
        merger.other_rev_id = None
104
 
        return merger
105
 
 
106
 
    @classmethod
107
 
    def from_mergeable(klass, tree, mergeable, pb):
108
 
        """Return a Merger for a bundle or merge directive.
109
 
 
110
 
        :param tree: The tree to merge changes into
111
 
        :param mergeable: A merge directive or bundle
112
 
        :param pb: A progress indicator
113
 
        """
114
 
        mergeable.install_revisions(tree.branch.repository)
115
 
        base_revision_id, other_revision_id, verified =\
116
 
            mergeable.get_merge_request(tree.branch.repository)
117
 
        if (base_revision_id != _mod_revision.NULL_REVISION and
118
 
            tree.branch.repository.get_graph().is_ancestor(
119
 
            base_revision_id, tree.branch.last_revision())):
120
 
            base_revision_id = None
121
 
        merger = klass.from_revision_ids(pb, tree, other_revision_id,
122
 
                                         base_revision_id)
123
 
        return merger, verified
124
 
 
125
 
    @staticmethod
126
 
    def from_revision_ids(pb, this, other, base=None, other_branch=None,
127
 
                          base_branch=None):
128
 
        """Return a Merger for revision-ids.
129
 
 
130
 
        :param tree: The tree to merge changes into
131
 
        :param other: The revision-id to use as OTHER
132
 
        :param base: The revision-id to use as BASE.  If not specified, will
133
 
            be auto-selected.
134
 
        :param other_branch: A branch containing the other revision-id.  If
135
 
            not supplied, this.branch is used.
136
 
        :param base_branch: A branch containing the base revision-id.  If
137
 
            not supplied, other_branch or this.branch will be used.
138
 
        :param pb: A progress indicator
139
 
        """
140
 
        merger = Merger(this.branch, this_tree=this, pb=pb)
141
 
        if other_branch is None:
142
 
            other_branch = this.branch
143
 
        merger.set_other_revision(other, other_branch)
144
 
        if base is None:
145
 
            merger.find_base()
146
 
        else:
147
 
            if base_branch is None:
148
 
                base_branch = other_branch
149
 
            merger.set_base_revision(base, base_branch)
150
 
        return merger
151
 
 
152
 
    def revision_tree(self, revision_id, branch=None):
153
 
        if revision_id not in self._cached_trees:
154
 
            if branch is None:
155
 
                branch = self.this_branch
156
 
            try:
157
 
                tree = self.this_tree.revision_tree(revision_id)
158
 
            except errors.NoSuchRevisionInTree:
159
 
                tree = branch.repository.revision_tree(revision_id)
160
 
            self._cached_trees[revision_id] = tree
161
 
        return self._cached_trees[revision_id]
162
 
 
163
 
    def _get_tree(self, treespec, possible_transports=None):
164
 
        from bzrlib import workingtree
165
 
        location, revno = treespec
166
 
        if revno is None:
167
 
            tree = workingtree.WorkingTree.open_containing(location)[0]
168
 
            return tree.branch, tree
169
 
        branch = Branch.open_containing(location, possible_transports)[0]
170
 
        if revno == -1:
171
 
            revision_id = branch.last_revision()
172
 
        else:
173
 
            revision_id = branch.get_rev_id(revno)
174
 
        revision_id = ensure_null(revision_id)
175
 
        return branch, self.revision_tree(revision_id, branch)
 
324
        self.conflict_handler = _MergeConflictHandler(self.this_tree, 
 
325
                                                      base_tree, other_tree)
 
326
 
 
327
    def revision_tree(self, revision_id):
 
328
        return self.this_branch.repository.revision_tree(revision_id)
176
329
 
177
330
    def ensure_revision_trees(self):
178
331
        if self.this_revision_tree is None:
179
 
            self.this_basis_tree = self.revision_tree(self.this_basis)
 
332
            self.this_basis_tree = self.this_branch.repository.revision_tree(
 
333
                self.this_basis)
180
334
            if self.this_basis == self.this_rev_id:
181
335
                self.this_revision_tree = self.this_basis_tree
182
336
 
183
337
        if self.other_rev_id is None:
184
338
            other_basis_tree = self.revision_tree(self.other_basis)
185
 
            changes = other_basis_tree.changes_from(self.other_tree)
 
339
            changes = compare_trees(self.other_tree, other_basis_tree)
186
340
            if changes.has_changed():
187
341
                raise WorkingTreeNotRevision(self.this_tree)
188
 
            other_rev_id = self.other_basis
 
342
            other_rev_id = other_basis
189
343
            self.other_tree = other_basis_tree
190
344
 
191
345
    def file_revisions(self, file_id):
202
356
        trees = (self.this_basis_tree, self.other_tree)
203
357
        return [get_id(tree, file_id) for tree in trees]
204
358
 
205
 
    def check_basis(self, check_clean, require_commits=True):
206
 
        if self.this_basis is None and require_commits is True:
207
 
            raise BzrCommandError("This branch has no commits."
208
 
                                  " (perhaps you would prefer 'bzr pull')")
 
359
    def merge_factory(self, file_id, base, other):
 
360
        if self.merge_type.history_based:
 
361
            if self.show_base is True:
 
362
                raise BzrError("Cannot show base for hisory-based merges")
 
363
            if self.reprocess is True:
 
364
                raise BzrError("Cannot reprocess history-based merges")
 
365
                
 
366
            t_revid, o_revid = self.file_revisions(file_id)
 
367
            weave = self.this_basis_tree.get_weave(file_id)
 
368
            contents_change = self.merge_type(weave, t_revid, o_revid)
 
369
        else:
 
370
            if self.show_base is True or self.reprocess is True:
 
371
                contents_change = self.merge_type(file_id, base, other, 
 
372
                                                  show_base=self.show_base, 
 
373
                                                  reprocess=self.reprocess)
 
374
            else:
 
375
                contents_change = self.merge_type(file_id, base, other)
 
376
        if self.backup_files:
 
377
            contents_change = BackupBeforeChange(contents_change)
 
378
        return contents_change
 
379
 
 
380
    def check_basis(self, check_clean):
 
381
        if self.this_basis is None:
 
382
            raise BzrCommandError("This branch has no commits")
209
383
        if check_clean:
210
384
            self.compare_basis()
211
385
            if self.this_basis != self.this_rev_id:
212
386
                raise BzrCommandError("Working tree has uncommitted changes.")
213
387
 
214
388
    def compare_basis(self):
215
 
        try:
216
 
            basis_tree = self.revision_tree(self.this_tree.last_revision())
217
 
        except errors.RevisionNotPresent:
218
 
            basis_tree = self.this_tree.basis_tree()
219
 
        changes = self.this_tree.changes_from(basis_tree)
 
389
        changes = compare_trees(self.this_tree, 
 
390
                                self.this_branch.basis_tree(), False)
220
391
        if not changes.has_changed():
221
392
            self.this_rev_id = self.this_basis
222
393
 
223
394
    def set_interesting_files(self, file_list):
224
 
        self.interesting_files = file_list
 
395
        try:
 
396
            self._set_interesting_files(file_list)
 
397
        except NotVersionedError, e:
 
398
            raise BzrCommandError("%s is not a source file in any"
 
399
                                      " tree." % e.path)
 
400
 
 
401
    def _set_interesting_files(self, file_list):
 
402
        """Set the list of interesting ids from a list of files."""
 
403
        if file_list is None:
 
404
            self.interesting_ids = None
 
405
            return
 
406
 
 
407
        interesting_ids = set()
 
408
        for path in file_list:
 
409
            found_id = False
 
410
            for tree in (self.this_tree, self.base_tree, self.other_tree):
 
411
                file_id = tree.inventory.path2id(path)
 
412
                if file_id is not None:
 
413
                    interesting_ids.add(file_id)
 
414
                    found_id = True
 
415
            if not found_id:
 
416
                raise NotVersionedError(path=path)
 
417
        self.interesting_ids = interesting_ids
225
418
 
226
419
    def set_pending(self):
227
 
        if not self.base_is_ancestor or not self.base_is_other_ancestor or self.other_rev_id is None:
228
 
            return
229
 
        self._add_parent()
230
 
 
231
 
    def _add_parent(self):
232
 
        new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
233
 
        new_parent_trees = []
234
 
        for revision_id in new_parents:
235
 
            try:
236
 
                tree = self.revision_tree(revision_id)
237
 
            except errors.RevisionNotPresent:
238
 
                tree = None
239
 
            else:
240
 
                tree.lock_read()
241
 
            new_parent_trees.append((revision_id, tree))
242
 
        try:
243
 
            self.this_tree.set_parent_trees(new_parent_trees,
244
 
                                            allow_leftmost_as_ghost=True)
245
 
        finally:
246
 
            for _revision_id, tree in new_parent_trees:
247
 
                if tree is not None:
248
 
                    tree.unlock()
249
 
 
250
 
    def set_other(self, other_revision, possible_transports=None):
251
 
        """Set the revision and tree to merge from.
252
 
 
253
 
        This sets the other_tree, other_rev_id, other_basis attributes.
254
 
 
255
 
        :param other_revision: The [path, revision] list to merge from.
256
 
        """
257
 
        self.other_branch, self.other_tree = self._get_tree(other_revision,
258
 
                                                            possible_transports)
 
420
        if not self.base_is_ancestor:
 
421
            return
 
422
        if self.other_rev_id is None:
 
423
            return
 
424
        ancestry = self.this_branch.repository.get_ancestry(self.this_basis)
 
425
        if self.other_rev_id in ancestry:
 
426
            return
 
427
        self.this_tree.add_pending_merge(self.other_rev_id)
 
428
 
 
429
    def set_other(self, other_revision):
 
430
        other_branch, self.other_tree = _get_tree(other_revision, 
 
431
                                                  self.this_branch)
259
432
        if other_revision[1] == -1:
260
 
            self.other_rev_id = _mod_revision.ensure_null(
261
 
                self.other_branch.last_revision())
262
 
            if _mod_revision.is_null(self.other_rev_id):
263
 
                raise NoCommits(self.other_branch)
 
433
            self.other_rev_id = other_branch.last_revision()
 
434
            if self.other_rev_id is None:
 
435
                raise NoCommits(other_branch)
264
436
            self.other_basis = self.other_rev_id
265
437
        elif other_revision[1] is not None:
266
 
            self.other_rev_id = self.other_branch.get_rev_id(other_revision[1])
 
438
            self.other_rev_id = other_branch.get_rev_id(other_revision[1])
267
439
            self.other_basis = self.other_rev_id
268
440
        else:
269
441
            self.other_rev_id = None
270
 
            self.other_basis = self.other_branch.last_revision()
 
442
            self.other_basis = other_branch.last_revision()
271
443
            if self.other_basis is None:
272
 
                raise NoCommits(self.other_branch)
273
 
        if self.other_rev_id is not None:
274
 
            self._cached_trees[self.other_rev_id] = self.other_tree
275
 
        self._maybe_fetch(self.other_branch,self.this_branch, self.other_basis)
276
 
 
277
 
    def set_other_revision(self, revision_id, other_branch):
278
 
        """Set 'other' based on a branch and revision id
279
 
 
280
 
        :param revision_id: The revision to use for a tree
281
 
        :param other_branch: The branch containing this tree
282
 
        """
283
 
        self.other_rev_id = revision_id
284
 
        self.other_branch = other_branch
285
 
        self._maybe_fetch(other_branch, self.this_branch, self.other_rev_id)
286
 
        self.other_tree = self.revision_tree(revision_id)
287
 
        self.other_basis = revision_id
288
 
 
289
 
    def set_base_revision(self, revision_id, branch):
290
 
        """Set 'base' based on a branch and revision id
291
 
 
292
 
        :param revision_id: The revision to use for a tree
293
 
        :param branch: The branch containing this tree
294
 
        """
295
 
        self.base_rev_id = revision_id
296
 
        self.base_branch = branch
297
 
        self._maybe_fetch(branch, self.this_branch, revision_id)
298
 
        self.base_tree = self.revision_tree(revision_id)
299
 
        self.base_is_ancestor = is_ancestor(self.this_basis,
300
 
                                            self.base_rev_id,
301
 
                                            self.this_branch)
302
 
        self.base_is_other_ancestor = is_ancestor(self.other_basis,
303
 
                                                  self.base_rev_id,
304
 
                                                  self.this_branch)
305
 
 
306
 
    def _maybe_fetch(self, source, target, revision_id):
307
 
        if (source.repository.bzrdir.root_transport.base !=
308
 
            target.repository.bzrdir.root_transport.base):
309
 
            target.fetch(source, revision_id)
310
 
 
311
 
    def find_base(self):
312
 
        this_repo = self.this_branch.repository
313
 
        graph = this_repo.get_graph()
314
 
        revisions = [ensure_null(self.this_basis),
315
 
                     ensure_null(self.other_basis)]
316
 
        if NULL_REVISION in revisions:
317
 
            self.base_rev_id = NULL_REVISION
318
 
        else:
319
 
            self.base_rev_id = graph.find_unique_lca(*revisions)
320
 
            if self.base_rev_id == NULL_REVISION:
321
 
                raise UnrelatedBranches()
322
 
        self.base_tree = self.revision_tree(self.base_rev_id)
323
 
        self.base_is_ancestor = True
324
 
        self.base_is_other_ancestor = True
 
444
                raise NoCommits(other_branch)
 
445
        if other_branch.base != self.this_branch.base:
 
446
            fetch(from_branch=other_branch, to_branch=self.this_branch, 
 
447
                  last_revision=self.other_basis)
325
448
 
326
449
    def set_base(self, base_revision):
327
 
        """Set the base revision to use for the merge.
328
 
 
329
 
        :param base_revision: A 2-list containing a path and revision number.
330
 
        """
331
450
        mutter("doing merge() with no base_revision specified")
332
451
        if base_revision == [None, None]:
333
 
            self.find_base()
 
452
            try:
 
453
                self.base_rev_id = common_ancestor(self.this_basis, 
 
454
                                                   self.other_basis, 
 
455
                                                   self.this_branch.repository)
 
456
            except NoCommonAncestor:
 
457
                raise UnrelatedBranches()
 
458
            self.base_tree = _get_revid_tree(self.this_branch, self.base_rev_id,
 
459
                                            None)
 
460
            self.base_is_ancestor = True
334
461
        else:
335
 
            base_branch, self.base_tree = self._get_tree(base_revision)
 
462
            base_branch, self.base_tree = _get_tree(base_revision)
336
463
            if base_revision[1] == -1:
337
464
                self.base_rev_id = base_branch.last_revision()
338
465
            elif base_revision[1] is None:
339
 
                self.base_rev_id = _mod_revision.NULL_REVISION
 
466
                self.base_rev_id = None
340
467
            else:
341
 
                self.base_rev_id = _mod_revision.ensure_null(
342
 
                    base_branch.get_rev_id(base_revision[1]))
343
 
            self._maybe_fetch(base_branch, self.this_branch, self.base_rev_id)
 
468
                self.base_rev_id = base_branch.get_rev_id(base_revision[1])
 
469
            fetch(from_branch=base_branch, to_branch=self.this_branch)
344
470
            self.base_is_ancestor = is_ancestor(self.this_basis, 
345
471
                                                self.base_rev_id,
346
472
                                                self.this_branch)
347
 
            self.base_is_other_ancestor = is_ancestor(self.other_basis,
348
 
                                                      self.base_rev_id,
349
 
                                                      self.this_branch)
350
473
 
351
474
    def do_merge(self):
352
 
        kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
353
 
                  'other_tree': self.other_tree,
354
 
                  'interesting_ids': self.interesting_ids,
355
 
                  'interesting_files': self.interesting_files,
356
 
                  'pp': self.pp}
357
 
        if self.merge_type.requires_base:
358
 
            kwargs['base_tree'] = self.base_tree
359
 
        if self.merge_type.supports_reprocess:
360
 
            kwargs['reprocess'] = self.reprocess
361
 
        elif self.reprocess:
362
 
            raise BzrError("Conflict reduction is not supported for merge"
363
 
                                  " type %s." % self.merge_type)
364
 
        if self.merge_type.supports_show_base:
365
 
            kwargs['show_base'] = self.show_base
366
 
        elif self.show_base:
367
 
            raise BzrError("Showing base is not supported for this"
368
 
                                  " merge type. %s" % self.merge_type)
369
 
        self.this_tree.lock_tree_write()
370
 
        if self.base_tree is not None:
371
 
            self.base_tree.lock_read()
372
 
        if self.other_tree is not None:
373
 
            self.other_tree.lock_read()
374
 
        try:
375
 
            merge = self.merge_type(pb=self._pb,
376
 
                                    change_reporter=self.change_reporter,
377
 
                                    **kwargs)
378
 
            if self.recurse == 'down':
379
 
                for path, file_id in self.this_tree.iter_references():
380
 
                    sub_tree = self.this_tree.get_nested_tree(file_id, path)
381
 
                    other_revision = self.other_tree.get_reference_revision(
382
 
                        file_id, path)
383
 
                    if  other_revision == sub_tree.last_revision():
384
 
                        continue
385
 
                    sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
386
 
                    sub_merge.merge_type = self.merge_type
387
 
                    relpath = self.this_tree.relpath(path)
388
 
                    other_branch = self.other_branch.reference_parent(file_id, relpath)
389
 
                    sub_merge.set_other_revision(other_revision, other_branch)
390
 
                    base_revision = self.base_tree.get_reference_revision(file_id)
391
 
                    sub_merge.base_tree = \
392
 
                        sub_tree.branch.repository.revision_tree(base_revision)
393
 
                    sub_merge.do_merge()
394
 
 
395
 
        finally:
396
 
            if self.other_tree is not None:
397
 
                self.other_tree.unlock()
398
 
            if self.base_tree is not None:
399
 
                self.base_tree.unlock()
400
 
            self.this_tree.unlock()
401
 
        if len(merge.cooked_conflicts) == 0:
402
 
            if not self.ignore_zero:
403
 
                note("All changes applied successfully.")
404
 
        else:
405
 
            note("%d conflicts encountered." % len(merge.cooked_conflicts))
406
 
 
407
 
        return len(merge.cooked_conflicts)
408
 
 
409
 
 
410
 
class Merge3Merger(object):
411
 
    """Three-way merger that uses the merge3 text merger"""
412
 
    requires_base = True
413
 
    supports_reprocess = True
414
 
    supports_show_base = True
415
 
    history_based = False
416
 
    winner_idx = {"this": 2, "other": 1, "conflict": 1}
417
 
 
418
 
    def __init__(self, working_tree, this_tree, base_tree, other_tree, 
419
 
                 interesting_ids=None, reprocess=False, show_base=False,
420
 
                 pb=DummyProgress(), pp=None, change_reporter=None,
421
 
                 interesting_files=None):
422
 
        """Initialize the merger object and perform the merge.
423
 
 
424
 
        :param working_tree: The working tree to apply the merge to
425
 
        :param this_tree: The local tree in the merge operation
426
 
        :param base_tree: The common tree in the merge operation
427
 
        :param other_tree: The other other tree to merge changes from
428
 
        :param interesting_ids: The file_ids of files that should be
429
 
            participate in the merge.  May not be combined with
430
 
            interesting_files.
431
 
        :param: reprocess If True, perform conflict-reduction processing.
432
 
        :param show_base: If True, show the base revision in text conflicts.
433
 
            (incompatible with reprocess)
434
 
        :param pb: A Progress bar
435
 
        :param pp: A ProgressPhase object
436
 
        :param change_reporter: An object that should report changes made
437
 
        :param interesting_files: The tree-relative paths of files that should
438
 
            participate in the merge.  If these paths refer to directories,
439
 
            the contents of those directories will also be included.  May not
440
 
            be combined with interesting_ids.  If neither interesting_files nor
441
 
            interesting_ids is specified, all files may participate in the
442
 
            merge.
443
 
        """
444
 
        object.__init__(self)
445
 
        if interesting_files is not None:
446
 
            assert interesting_ids is None
447
 
        self.interesting_ids = interesting_ids
448
 
        self.interesting_files = interesting_files
449
 
        self.this_tree = working_tree
450
 
        self.this_tree.lock_tree_write()
451
 
        self.base_tree = base_tree
452
 
        self.base_tree.lock_read()
453
 
        self.other_tree = other_tree
454
 
        self.other_tree.lock_read()
455
 
        self._raw_conflicts = []
456
 
        self.cooked_conflicts = []
457
 
        self.reprocess = reprocess
458
 
        self.show_base = show_base
459
 
        self.pb = pb
460
 
        self.pp = pp
461
 
        self.change_reporter = change_reporter
462
 
        if self.pp is None:
463
 
            self.pp = ProgressPhase("Merge phase", 3, self.pb)
464
 
 
465
 
        self.tt = TreeTransform(working_tree, self.pb)
466
 
        try:
467
 
            self.pp.next_phase()
468
 
            entries = self._entries3()
469
 
            child_pb = ui.ui_factory.nested_progress_bar()
470
 
            try:
471
 
                for num, (file_id, changed, parents3, names3,
472
 
                          executable3) in enumerate(entries):
473
 
                    child_pb.update('Preparing file merge', num, len(entries))
474
 
                    self._merge_names(file_id, parents3, names3)
475
 
                    if changed:
476
 
                        file_status = self.merge_contents(file_id)
477
 
                    else:
478
 
                        file_status = 'unmodified'
479
 
                    self._merge_executable(file_id,
480
 
                        executable3, file_status)
481
 
            finally:
482
 
                child_pb.finished()
483
 
            self.fix_root()
484
 
            self.pp.next_phase()
485
 
            child_pb = ui.ui_factory.nested_progress_bar()
486
 
            try:
487
 
                fs_conflicts = resolve_conflicts(self.tt, child_pb,
488
 
                    lambda t, c: conflict_pass(t, c, self.other_tree))
489
 
            finally:
490
 
                child_pb.finished()
491
 
            if change_reporter is not None:
492
 
                from bzrlib import delta
493
 
                delta.report_changes(self.tt._iter_changes(), change_reporter)
494
 
            self.cook_conflicts(fs_conflicts)
495
 
            for conflict in self.cooked_conflicts:
496
 
                warning(conflict)
497
 
            self.pp.next_phase()
498
 
            results = self.tt.apply(no_conflicts=True)
499
 
            self.write_modified(results)
500
 
            try:
501
 
                working_tree.add_conflicts(self.cooked_conflicts)
502
 
            except UnsupportedOperation:
503
 
                pass
504
 
        finally:
505
 
            self.tt.finalize()
506
 
            self.other_tree.unlock()
507
 
            self.base_tree.unlock()
508
 
            self.this_tree.unlock()
509
 
            self.pb.clear()
510
 
 
511
 
    def _entries3(self):
512
 
        """Gather data about files modified between three trees.
513
 
 
514
 
        Return a list of tuples of file_id, changed, parents3, names3,
515
 
        executable3.  changed is a boolean indicating whether the file contents
516
 
        or kind were changed.  parents3 is a tuple of parent ids for base,
517
 
        other and this.  names3 is a tuple of names for base, other and this.
518
 
        executable3 is a tuple of execute-bit values for base, other and this.
519
 
        """
520
 
        result = []
521
 
        iterator = self.other_tree._iter_changes(self.base_tree,
522
 
                include_unchanged=True, specific_files=self.interesting_files,
523
 
                extra_trees=[self.this_tree])
524
 
        for (file_id, paths, changed, versioned, parents, names, kind,
525
 
             executable) in iterator:
526
 
            if (self.interesting_ids is not None and
527
 
                file_id not in self.interesting_ids):
528
 
                continue
529
 
            if file_id in self.this_tree.inventory:
530
 
                entry = self.this_tree.inventory[file_id]
531
 
                this_name = entry.name
532
 
                this_parent = entry.parent_id
533
 
                this_executable = entry.executable
534
 
            else:
535
 
                this_name = None
536
 
                this_parent = None
537
 
                this_executable = None
538
 
            parents3 = parents + (this_parent,)
539
 
            names3 = names + (this_name,)
540
 
            executable3 = executable + (this_executable,)
541
 
            result.append((file_id, changed, parents3, names3, executable3))
542
 
        return result
543
 
 
544
 
    def fix_root(self):
545
 
        try:
546
 
            self.tt.final_kind(self.tt.root)
547
 
        except NoSuchFile:
548
 
            self.tt.cancel_deletion(self.tt.root)
549
 
        if self.tt.final_file_id(self.tt.root) is None:
550
 
            self.tt.version_file(self.tt.tree_file_id(self.tt.root), 
551
 
                                 self.tt.root)
552
 
        if self.other_tree.inventory.root is None:
553
 
            return
554
 
        other_root_file_id = self.other_tree.inventory.root.file_id
555
 
        other_root = self.tt.trans_id_file_id(other_root_file_id)
556
 
        if other_root == self.tt.root:
557
 
            return
558
 
        try:
559
 
            self.tt.final_kind(other_root)
560
 
        except NoSuchFile:
561
 
            return
562
 
        self.reparent_children(self.other_tree.inventory.root, self.tt.root)
563
 
        self.tt.cancel_creation(other_root)
564
 
        self.tt.cancel_versioning(other_root)
565
 
 
566
 
    def reparent_children(self, ie, target):
567
 
        for thing, child in ie.children.iteritems():
568
 
            trans_id = self.tt.trans_id_file_id(child.file_id)
569
 
            self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
570
 
 
571
 
    def write_modified(self, results):
572
 
        modified_hashes = {}
573
 
        for path in results.modified_paths:
574
 
            file_id = self.this_tree.path2id(self.this_tree.relpath(path))
575
 
            if file_id is None:
576
 
                continue
577
 
            hash = self.this_tree.get_file_sha1(file_id)
578
 
            if hash is None:
579
 
                continue
580
 
            modified_hashes[file_id] = hash
581
 
        self.this_tree.set_merge_modified(modified_hashes)
582
 
 
583
 
    @staticmethod
584
 
    def parent(entry, file_id):
585
 
        """Determine the parent for a file_id (used as a key method)"""
586
 
        if entry is None:
587
 
            return None
588
 
        return entry.parent_id
589
 
 
590
 
    @staticmethod
591
 
    def name(entry, file_id):
592
 
        """Determine the name for a file_id (used as a key method)"""
593
 
        if entry is None:
594
 
            return None
595
 
        return entry.name
596
 
    
597
 
    @staticmethod
598
 
    def contents_sha1(tree, file_id):
599
 
        """Determine the sha1 of the file contents (used as a key method)."""
600
 
        if file_id not in tree:
601
 
            return None
602
 
        return tree.get_file_sha1(file_id)
603
 
 
604
 
    @staticmethod
605
 
    def executable(tree, file_id):
606
 
        """Determine the executability of a file-id (used as a key method)."""
607
 
        if file_id not in tree:
608
 
            return None
609
 
        if tree.kind(file_id) != "file":
610
 
            return False
611
 
        return tree.is_executable(file_id)
612
 
 
613
 
    @staticmethod
614
 
    def kind(tree, file_id):
615
 
        """Determine the kind of a file-id (used as a key method)."""
616
 
        if file_id not in tree:
617
 
            return None
618
 
        return tree.kind(file_id)
619
 
 
620
 
    @staticmethod
621
 
    def _three_way(base, other, this):
622
 
        #if base == other, either they all agree, or only THIS has changed.
623
 
        if base == other:
624
 
            return 'this'
625
 
        elif this not in (base, other):
626
 
            return 'conflict'
627
 
        # "Ambiguous clean merge" -- both sides have made the same change.
628
 
        elif this == other:
629
 
            return "this"
630
 
        # this == base: only other has changed.
631
 
        else:
632
 
            return "other"
633
 
 
634
 
    @staticmethod
635
 
    def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
636
 
        """Do a three-way test on a scalar.
637
 
        Return "this", "other" or "conflict", depending whether a value wins.
638
 
        """
639
 
        key_base = key(base_tree, file_id)
640
 
        key_other = key(other_tree, file_id)
641
 
        #if base == other, either they all agree, or only THIS has changed.
642
 
        if key_base == key_other:
643
 
            return "this"
644
 
        key_this = key(this_tree, file_id)
645
 
        if key_this not in (key_base, key_other):
646
 
            return "conflict"
647
 
        # "Ambiguous clean merge"
648
 
        elif key_this == key_other:
649
 
            return "this"
650
 
        else:
651
 
            assert key_this == key_base
652
 
            return "other"
653
 
 
654
 
    def merge_names(self, file_id):
655
 
        def get_entry(tree):
656
 
            if file_id in tree.inventory:
657
 
                return tree.inventory[file_id]
658
 
            else:
659
 
                return None
660
 
        this_entry = get_entry(self.this_tree)
661
 
        other_entry = get_entry(self.other_tree)
662
 
        base_entry = get_entry(self.base_tree)
663
 
        entries = (base_entry, other_entry, this_entry)
664
 
        names = []
665
 
        parents = []
666
 
        for entry in entries:
667
 
            if entry is None:
668
 
                names.append(None)
669
 
                parents.append(None)
670
 
            else:
671
 
                names.append(entry.name)
672
 
                parents.append(entry.parent_id)
673
 
        return self._merge_names(file_id, parents, names)
674
 
 
675
 
    def _merge_names(self, file_id, parents, names):
676
 
        """Perform a merge on file_id names and parents"""
677
 
        base_name, other_name, this_name = names
678
 
        base_parent, other_parent, this_parent = parents
679
 
 
680
 
        name_winner = self._three_way(*names)
681
 
 
682
 
        parent_id_winner = self._three_way(*parents)
683
 
        if this_name is None:
684
 
            if name_winner == "this":
685
 
                name_winner = "other"
686
 
            if parent_id_winner == "this":
687
 
                parent_id_winner = "other"
688
 
        if name_winner == "this" and parent_id_winner == "this":
689
 
            return
690
 
        if name_winner == "conflict":
691
 
            trans_id = self.tt.trans_id_file_id(file_id)
692
 
            self._raw_conflicts.append(('name conflict', trans_id, 
693
 
                                        this_name, other_name))
694
 
        if parent_id_winner == "conflict":
695
 
            trans_id = self.tt.trans_id_file_id(file_id)
696
 
            self._raw_conflicts.append(('parent conflict', trans_id, 
697
 
                                        this_parent, other_parent))
698
 
        if other_name is None:
699
 
            # it doesn't matter whether the result was 'other' or 
700
 
            # 'conflict'-- if there's no 'other', we leave it alone.
701
 
            return
702
 
        # if we get here, name_winner and parent_winner are set to safe values.
703
 
        trans_id = self.tt.trans_id_file_id(file_id)
704
 
        parent_id = parents[self.winner_idx[parent_id_winner]]
705
 
        if parent_id is not None:
706
 
            parent_trans_id = self.tt.trans_id_file_id(parent_id)
707
 
            self.tt.adjust_path(names[self.winner_idx[name_winner]],
708
 
                                parent_trans_id, trans_id)
709
 
 
710
 
    def merge_contents(self, file_id):
711
 
        """Performa a merge on file_id contents."""
712
 
        def contents_pair(tree):
713
 
            if file_id not in tree:
714
 
                return (None, None)
715
 
            kind = tree.kind(file_id)
716
 
            if kind == "file":
717
 
                contents = tree.get_file_sha1(file_id)
718
 
            elif kind == "symlink":
719
 
                contents = tree.get_symlink_target(file_id)
720
 
            else:
721
 
                contents = None
722
 
            return kind, contents
723
 
 
724
 
        def contents_conflict():
725
 
            trans_id = self.tt.trans_id_file_id(file_id)
726
 
            name = self.tt.final_name(trans_id)
727
 
            parent_id = self.tt.final_parent(trans_id)
728
 
            if file_id in self.this_tree.inventory:
729
 
                self.tt.unversion_file(trans_id)
730
 
                if file_id in self.this_tree:
731
 
                    self.tt.delete_contents(trans_id)
732
 
            file_group = self._dump_conflicts(name, parent_id, file_id, 
733
 
                                              set_version=True)
734
 
            self._raw_conflicts.append(('contents conflict', file_group))
735
 
 
736
 
        # See SPOT run.  run, SPOT, run.
737
 
        # So we're not QUITE repeating ourselves; we do tricky things with
738
 
        # file kind...
739
 
        base_pair = contents_pair(self.base_tree)
740
 
        other_pair = contents_pair(self.other_tree)
741
 
        if base_pair == other_pair:
742
 
            # OTHER introduced no changes
743
 
            return "unmodified"
744
 
        this_pair = contents_pair(self.this_tree)
745
 
        if this_pair == other_pair:
746
 
            # THIS and OTHER introduced the same changes
747
 
            return "unmodified"
748
 
        else:
749
 
            trans_id = self.tt.trans_id_file_id(file_id)
750
 
            if this_pair == base_pair:
751
 
                # only OTHER introduced changes
752
 
                if file_id in self.this_tree:
753
 
                    # Remove any existing contents
754
 
                    self.tt.delete_contents(trans_id)
755
 
                if file_id in self.other_tree:
756
 
                    # OTHER changed the file
757
 
                    create_by_entry(self.tt, 
758
 
                                    self.other_tree.inventory[file_id], 
759
 
                                    self.other_tree, trans_id)
760
 
                    if file_id not in self.this_tree.inventory:
761
 
                        self.tt.version_file(file_id, trans_id)
762
 
                    return "modified"
763
 
                elif file_id in self.this_tree.inventory:
764
 
                    # OTHER deleted the file
765
 
                    self.tt.unversion_file(trans_id)
766
 
                    return "deleted"
767
 
            #BOTH THIS and OTHER introduced changes; scalar conflict
768
 
            elif this_pair[0] == "file" and other_pair[0] == "file":
769
 
                # THIS and OTHER are both files, so text merge.  Either
770
 
                # BASE is a file, or both converted to files, so at least we
771
 
                # have agreement that output should be a file.
772
 
                try:
773
 
                    self.text_merge(file_id, trans_id)
774
 
                except BinaryFile:
775
 
                    return contents_conflict()
776
 
                if file_id not in self.this_tree.inventory:
777
 
                    self.tt.version_file(file_id, trans_id)
778
 
                try:
779
 
                    self.tt.tree_kind(trans_id)
780
 
                    self.tt.delete_contents(trans_id)
781
 
                except NoSuchFile:
782
 
                    pass
783
 
                return "modified"
784
 
            else:
785
 
                # Scalar conflict, can't text merge.  Dump conflicts
786
 
                return contents_conflict()
787
 
 
788
 
    def get_lines(self, tree, file_id):
789
 
        """Return the lines in a file, or an empty list."""
790
 
        if file_id in tree:
791
 
            return tree.get_file(file_id).readlines()
792
 
        else:
793
 
            return []
794
 
 
795
 
    def text_merge(self, file_id, trans_id):
796
 
        """Perform a three-way text merge on a file_id"""
797
 
        # it's possible that we got here with base as a different type.
798
 
        # if so, we just want two-way text conflicts.
799
 
        if file_id in self.base_tree and \
800
 
            self.base_tree.kind(file_id) == "file":
801
 
            base_lines = self.get_lines(self.base_tree, file_id)
802
 
        else:
803
 
            base_lines = []
804
 
        other_lines = self.get_lines(self.other_tree, file_id)
805
 
        this_lines = self.get_lines(self.this_tree, file_id)
806
 
        m3 = Merge3(base_lines, this_lines, other_lines)
807
 
        start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
808
 
        if self.show_base is True:
809
 
            base_marker = '|' * 7
810
 
        else:
811
 
            base_marker = None
812
 
 
813
 
        def iter_merge3(retval):
814
 
            retval["text_conflicts"] = False
815
 
            for line in m3.merge_lines(name_a = "TREE", 
816
 
                                       name_b = "MERGE-SOURCE", 
817
 
                                       name_base = "BASE-REVISION",
818
 
                                       start_marker=start_marker, 
819
 
                                       base_marker=base_marker,
820
 
                                       reprocess=self.reprocess):
821
 
                if line.startswith(start_marker):
822
 
                    retval["text_conflicts"] = True
823
 
                    yield line.replace(start_marker, '<' * 7)
 
475
        def get_inventory(tree):
 
476
            return tree.inventory
 
477
        
 
478
        inv_changes = merge_flex(self.this_tree, self.base_tree, 
 
479
                                 self.other_tree,
 
480
                                 generate_changeset, get_inventory,
 
481
                                 self.conflict_handler,
 
482
                                 merge_factory=self.merge_factory, 
 
483
                                 interesting_ids=self.interesting_ids)
 
484
 
 
485
        adjust_ids = []
 
486
        for id, path in inv_changes.iteritems():
 
487
            if path is not None:
 
488
                if path == u'.':
 
489
                    path = u''
824
490
                else:
825
 
                    yield line
826
 
        retval = {}
827
 
        merge3_iterator = iter_merge3(retval)
828
 
        self.tt.create_file(merge3_iterator, trans_id)
829
 
        if retval["text_conflicts"] is True:
830
 
            self._raw_conflicts.append(('text conflict', trans_id))
831
 
            name = self.tt.final_name(trans_id)
832
 
            parent_id = self.tt.final_parent(trans_id)
833
 
            file_group = self._dump_conflicts(name, parent_id, file_id, 
834
 
                                              this_lines, base_lines,
835
 
                                              other_lines)
836
 
            file_group.append(trans_id)
837
 
 
838
 
    def _dump_conflicts(self, name, parent_id, file_id, this_lines=None, 
839
 
                        base_lines=None, other_lines=None, set_version=False,
840
 
                        no_base=False):
841
 
        """Emit conflict files.
842
 
        If this_lines, base_lines, or other_lines are omitted, they will be
843
 
        determined automatically.  If set_version is true, the .OTHER, .THIS
844
 
        or .BASE (in that order) will be created as versioned files.
845
 
        """
846
 
        data = [('OTHER', self.other_tree, other_lines), 
847
 
                ('THIS', self.this_tree, this_lines)]
848
 
        if not no_base:
849
 
            data.append(('BASE', self.base_tree, base_lines))
850
 
        versioned = False
851
 
        file_group = []
852
 
        for suffix, tree, lines in data:
853
 
            if file_id in tree:
854
 
                trans_id = self._conflict_file(name, parent_id, tree, file_id,
855
 
                                               suffix, lines)
856
 
                file_group.append(trans_id)
857
 
                if set_version and not versioned:
858
 
                    self.tt.version_file(file_id, trans_id)
859
 
                    versioned = True
860
 
        return file_group
861
 
           
862
 
    def _conflict_file(self, name, parent_id, tree, file_id, suffix, 
863
 
                       lines=None):
864
 
        """Emit a single conflict file."""
865
 
        name = name + '.' + suffix
866
 
        trans_id = self.tt.create_path(name, parent_id)
867
 
        entry = tree.inventory[file_id]
868
 
        create_by_entry(self.tt, entry, tree, trans_id, lines)
869
 
        return trans_id
870
 
 
871
 
    def merge_executable(self, file_id, file_status):
872
 
        """Perform a merge on the execute bit."""
873
 
        executable = [self.executable(t, file_id) for t in (self.base_tree,
874
 
                      self.other_tree, self.this_tree)]
875
 
        self._merge_executable(file_id, executable, file_status)
876
 
 
877
 
    def _merge_executable(self, file_id, executable, file_status):
878
 
        """Perform a merge on the execute bit."""
879
 
        base_executable, other_executable, this_executable = executable
880
 
        if file_status == "deleted":
881
 
            return
882
 
        trans_id = self.tt.trans_id_file_id(file_id)
883
 
        try:
884
 
            if self.tt.final_kind(trans_id) != "file":
885
 
                return
886
 
        except NoSuchFile:
887
 
            return
888
 
        winner = self._three_way(*executable)
889
 
        if winner == "conflict":
890
 
        # There must be a None in here, if we have a conflict, but we
891
 
        # need executability since file status was not deleted.
892
 
            if self.executable(self.other_tree, file_id) is None:
893
 
                winner = "this"
894
 
            else:
895
 
                winner = "other"
896
 
        if winner == "this":
897
 
            if file_status == "modified":
898
 
                executability = this_executable
899
 
                if executability is not None:
900
 
                    trans_id = self.tt.trans_id_file_id(file_id)
901
 
                    self.tt.set_executability(executability, trans_id)
902
 
        else:
903
 
            assert winner == "other"
904
 
            if file_id in self.other_tree:
905
 
                executability = other_executable
906
 
            elif file_id in self.this_tree:
907
 
                executability = this_executable
908
 
            elif file_id in self.base_tree:
909
 
                executability = base_executable
910
 
            if executability is not None:
911
 
                trans_id = self.tt.trans_id_file_id(file_id)
912
 
                self.tt.set_executability(executability, trans_id)
913
 
 
914
 
    def cook_conflicts(self, fs_conflicts):
915
 
        """Convert all conflicts into a form that doesn't depend on trans_id"""
916
 
        from conflicts import Conflict
917
 
        name_conflicts = {}
918
 
        self.cooked_conflicts.extend(cook_conflicts(fs_conflicts, self.tt))
919
 
        fp = FinalPaths(self.tt)
920
 
        for conflict in self._raw_conflicts:
921
 
            conflict_type = conflict[0]
922
 
            if conflict_type in ('name conflict', 'parent conflict'):
923
 
                trans_id = conflict[1]
924
 
                conflict_args = conflict[2:]
925
 
                if trans_id not in name_conflicts:
926
 
                    name_conflicts[trans_id] = {}
927
 
                unique_add(name_conflicts[trans_id], conflict_type, 
928
 
                           conflict_args)
929
 
            if conflict_type == 'contents conflict':
930
 
                for trans_id in conflict[1]:
931
 
                    file_id = self.tt.final_file_id(trans_id)
932
 
                    if file_id is not None:
933
 
                        break
934
 
                path = fp.get_path(trans_id)
935
 
                for suffix in ('.BASE', '.THIS', '.OTHER'):
936
 
                    if path.endswith(suffix):
937
 
                        path = path[:-len(suffix)]
938
 
                        break
939
 
                c = Conflict.factory(conflict_type, path=path, file_id=file_id)
940
 
                self.cooked_conflicts.append(c)
941
 
            if conflict_type == 'text conflict':
942
 
                trans_id = conflict[1]
943
 
                path = fp.get_path(trans_id)
944
 
                file_id = self.tt.final_file_id(trans_id)
945
 
                c = Conflict.factory(conflict_type, path=path, file_id=file_id)
946
 
                self.cooked_conflicts.append(c)
947
 
 
948
 
        for trans_id, conflicts in name_conflicts.iteritems():
949
 
            try:
950
 
                this_parent, other_parent = conflicts['parent conflict']
951
 
                assert this_parent != other_parent
952
 
            except KeyError:
953
 
                this_parent = other_parent = \
954
 
                    self.tt.final_file_id(self.tt.final_parent(trans_id))
955
 
            try:
956
 
                this_name, other_name = conflicts['name conflict']
957
 
                assert this_name != other_name
958
 
            except KeyError:
959
 
                this_name = other_name = self.tt.final_name(trans_id)
960
 
            other_path = fp.get_path(trans_id)
961
 
            if this_parent is not None and this_name is not None:
962
 
                this_parent_path = \
963
 
                    fp.get_path(self.tt.trans_id_file_id(this_parent))
964
 
                this_path = pathjoin(this_parent_path, this_name)
965
 
            else:
966
 
                this_path = "<deleted>"
967
 
            file_id = self.tt.final_file_id(trans_id)
968
 
            c = Conflict.factory('path conflict', path=this_path,
969
 
                                 conflict_path=other_path, file_id=file_id)
970
 
            self.cooked_conflicts.append(c)
971
 
        self.cooked_conflicts.sort(key=Conflict.sort_key)
972
 
 
973
 
 
974
 
class WeaveMerger(Merge3Merger):
975
 
    """Three-way tree merger, text weave merger."""
976
 
    supports_reprocess = True
977
 
    supports_show_base = False
978
 
 
979
 
    def __init__(self, working_tree, this_tree, base_tree, other_tree, 
980
 
                 interesting_ids=None, pb=DummyProgress(), pp=None,
981
 
                 reprocess=False, change_reporter=None,
982
 
                 interesting_files=None):
983
 
        super(WeaveMerger, self).__init__(working_tree, this_tree, 
984
 
                                          base_tree, other_tree, 
985
 
                                          interesting_ids=interesting_ids, 
986
 
                                          pb=pb, pp=pp, reprocess=reprocess,
987
 
                                          change_reporter=change_reporter)
988
 
 
989
 
    def _merged_lines(self, file_id):
990
 
        """Generate the merged lines.
991
 
        There is no distinction between lines that are meant to contain <<<<<<<
992
 
        and conflicts.
993
 
        """
994
 
        plan = self.this_tree.plan_file_merge(file_id, self.other_tree)
995
 
        textmerge = PlanWeaveMerge(plan, '<<<<<<< TREE\n',
996
 
            '>>>>>>> MERGE-SOURCE\n')
997
 
        return textmerge.merge_lines(self.reprocess)
998
 
 
999
 
    def text_merge(self, file_id, trans_id):
1000
 
        """Perform a (weave) text merge for a given file and file-id.
1001
 
        If conflicts are encountered, .THIS and .OTHER files will be emitted,
1002
 
        and a conflict will be noted.
1003
 
        """
1004
 
        lines, conflicts = self._merged_lines(file_id)
1005
 
        lines = list(lines)
1006
 
        # Note we're checking whether the OUTPUT is binary in this case, 
1007
 
        # because we don't want to get into weave merge guts.
1008
 
        check_text_lines(lines)
1009
 
        self.tt.create_file(lines, trans_id)
1010
 
        if conflicts:
1011
 
            self._raw_conflicts.append(('text conflict', trans_id))
1012
 
            name = self.tt.final_name(trans_id)
1013
 
            parent_id = self.tt.final_parent(trans_id)
1014
 
            file_group = self._dump_conflicts(name, parent_id, file_id, 
1015
 
                                              no_base=True)
1016
 
            file_group.append(trans_id)
1017
 
 
1018
 
 
1019
 
class Diff3Merger(Merge3Merger):
1020
 
    """Three-way merger using external diff3 for text merging"""
1021
 
 
1022
 
    def dump_file(self, temp_dir, name, tree, file_id):
1023
 
        out_path = pathjoin(temp_dir, name)
1024
 
        out_file = open(out_path, "wb")
1025
 
        try:
1026
 
            in_file = tree.get_file(file_id)
1027
 
            for line in in_file:
1028
 
                out_file.write(line)
1029
 
        finally:
1030
 
            out_file.close()
1031
 
        return out_path
1032
 
 
1033
 
    def text_merge(self, file_id, trans_id):
1034
 
        """Perform a diff3 merge using a specified file-id and trans-id.
1035
 
        If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
1036
 
        will be dumped, and a will be conflict noted.
1037
 
        """
1038
 
        import bzrlib.patch
1039
 
        temp_dir = osutils.mkdtemp(prefix="bzr-")
1040
 
        try:
1041
 
            new_file = pathjoin(temp_dir, "new")
1042
 
            this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
1043
 
            base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
1044
 
            other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
1045
 
            status = bzrlib.patch.diff3(new_file, this, base, other)
1046
 
            if status not in (0, 1):
1047
 
                raise BzrError("Unhandled diff3 exit code")
1048
 
            f = open(new_file, 'rb')
1049
 
            try:
1050
 
                self.tt.create_file(f, trans_id)
1051
 
            finally:
1052
 
                f.close()
1053
 
            if status == 1:
1054
 
                name = self.tt.final_name(trans_id)
1055
 
                parent_id = self.tt.final_parent(trans_id)
1056
 
                self._dump_conflicts(name, parent_id, file_id)
1057
 
                self._raw_conflicts.append(('text conflict', trans_id))
1058
 
        finally:
1059
 
            osutils.rmtree(temp_dir)
1060
 
 
1061
 
 
1062
 
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1063
 
                backup_files=False,
1064
 
                merge_type=Merge3Merger,
1065
 
                interesting_ids=None,
1066
 
                show_base=False,
1067
 
                reprocess=False,
1068
 
                other_rev_id=None,
1069
 
                interesting_files=None,
1070
 
                this_tree=None,
1071
 
                pb=DummyProgress(),
1072
 
                change_reporter=None):
1073
 
    """Primary interface for merging. 
1074
 
 
1075
 
        typical use is probably 
1076
 
        'merge_inner(branch, branch.get_revision_tree(other_revision),
1077
 
                     branch.get_revision_tree(base_revision))'
1078
 
        """
1079
 
    if this_tree is None:
1080
 
        raise BzrError("bzrlib.merge.merge_inner requires a this_tree "
1081
 
            "parameter as of bzrlib version 0.8.")
1082
 
    merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1083
 
                    pb=pb, change_reporter=change_reporter)
1084
 
    merger.backup_files = backup_files
1085
 
    merger.merge_type = merge_type
1086
 
    merger.interesting_ids = interesting_ids
1087
 
    merger.ignore_zero = ignore_zero
1088
 
    if interesting_files:
1089
 
        assert not interesting_ids, ('Only supply interesting_ids'
1090
 
                                     ' or interesting_files')
1091
 
        merger.interesting_files = interesting_files
1092
 
    merger.show_base = show_base
1093
 
    merger.reprocess = reprocess
1094
 
    merger.other_rev_id = other_rev_id
1095
 
    merger.other_basis = other_rev_id
1096
 
    return merger.do_merge()
1097
 
 
1098
 
def get_merge_type_registry():
1099
 
    """Merge type registry is in bzrlib.option to avoid circular imports.
1100
 
 
1101
 
    This method provides a sanctioned way to retrieve it.
1102
 
    """
1103
 
    from bzrlib import option
1104
 
    return option._merge_type_registry
1105
 
 
1106
 
 
1107
 
def _plan_annotate_merge(annotated_a, annotated_b, ancestors_a, ancestors_b):
1108
 
    def status_a(revision, text):
1109
 
        if revision in ancestors_b:
1110
 
            return 'killed-b', text
1111
 
        else:
1112
 
            return 'new-a', text
1113
 
 
1114
 
    def status_b(revision, text):
1115
 
        if revision in ancestors_a:
1116
 
            return 'killed-a', text
1117
 
        else:
1118
 
            return 'new-b', text
1119
 
 
1120
 
    plain_a = [t for (a, t) in annotated_a]
1121
 
    plain_b = [t for (a, t) in annotated_b]
1122
 
    matcher = patiencediff.PatienceSequenceMatcher(None, plain_a, plain_b)
1123
 
    blocks = matcher.get_matching_blocks()
1124
 
    a_cur = 0
1125
 
    b_cur = 0
1126
 
    for ai, bi, l in blocks:
1127
 
        # process all mismatched sections
1128
 
        # (last mismatched section is handled because blocks always
1129
 
        # includes a 0-length last block)
1130
 
        for revision, text in annotated_a[a_cur:ai]:
1131
 
            yield status_a(revision, text)
1132
 
        for revision, text in annotated_b[b_cur:bi]:
1133
 
            yield status_b(revision, text)
1134
 
 
1135
 
        # and now the matched section
1136
 
        a_cur = ai + l
1137
 
        b_cur = bi + l
1138
 
        for text_a, text_b in zip(plain_a[ai:a_cur], plain_b[bi:b_cur]):
1139
 
            assert text_a == text_b
1140
 
            yield "unchanged", text_a
 
491
                    assert path.startswith('.' + '/') or path.startswith('.' + '\\'), "path is %s" % path
 
492
                path = path[2:]
 
493
            adjust_ids.append((path, id))
 
494
        if len(adjust_ids) > 0:
 
495
            self.this_tree.set_inventory(self.regen_inventory(adjust_ids))
 
496
        conflicts = self.conflict_handler.conflicts
 
497
        self.conflict_handler.finalize()
 
498
        return conflicts
 
499
 
 
500
    def regen_inventory(self, new_entries):
 
501
        old_entries = self.this_tree.read_working_inventory()
 
502
        new_inventory = {}
 
503
        by_path = {}
 
504
        new_entries_map = {} 
 
505
        for path, file_id in new_entries:
 
506
            if path is None:
 
507
                continue
 
508
            new_entries_map[file_id] = path
 
509
 
 
510
        def id2path(file_id):
 
511
            path = new_entries_map.get(file_id)
 
512
            if path is not None:
 
513
                return path
 
514
            entry = old_entries[file_id]
 
515
            if entry.parent_id is None:
 
516
                return entry.name
 
517
            return pathjoin(id2path(entry.parent_id), entry.name)
 
518
            
 
519
        for file_id in old_entries:
 
520
            entry = old_entries[file_id]
 
521
            path = id2path(file_id)
 
522
            new_inventory[file_id] = (path, file_id, entry.parent_id, 
 
523
                                      entry.kind)
 
524
            by_path[path] = file_id
 
525
        
 
526
        deletions = 0
 
527
        insertions = 0
 
528
        new_path_list = []
 
529
        for path, file_id in new_entries:
 
530
            if path is None:
 
531
                del new_inventory[file_id]
 
532
                deletions += 1
 
533
            else:
 
534
                new_path_list.append((path, file_id))
 
535
                if file_id not in old_entries:
 
536
                    insertions += 1
 
537
        # Ensure no file is added before its parent
 
538
        new_path_list.sort()
 
539
        for path, file_id in new_path_list:
 
540
            if path == '':
 
541
                parent = None
 
542
            else:
 
543
                parent = by_path[os.path.dirname(path)]
 
544
            abspath = pathjoin(self.this_tree.basedir, path)
 
545
            kind = bzrlib.osutils.file_kind(abspath)
 
546
            new_inventory[file_id] = (path, file_id, parent, kind)
 
547
            by_path[path] = file_id 
 
548
 
 
549
        # Get a list in insertion order
 
550
        new_inventory_list = new_inventory.values()
 
551
        mutter ("""Inventory regeneration:
 
552
    old length: %i insertions: %i deletions: %i new_length: %i"""\
 
553
            % (len(old_entries), insertions, deletions, 
 
554
               len(new_inventory_list)))
 
555
        assert len(new_inventory_list) == len(old_entries) + insertions\
 
556
            - deletions
 
557
        new_inventory_list.sort()
 
558
        return new_inventory_list
 
559
 
 
560
 
 
561
merge_types = {     "merge3": (ApplyMerge3, "Native diff3-style merge"), 
 
562
                     "diff3": (Diff3Merge,  "Merge using external diff3"),
 
563
                     'weave': (WeaveMerge, "Weave-based merge")
 
564
              }