~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

Deprecate compare_trees and move its body to InterTree.changes_from.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005, 2006 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
 
 
18
import os
 
19
import errno
 
20
from tempfile import mkdtemp
 
21
import warnings
 
22
 
 
23
from bzrlib.branch import Branch
 
24
from bzrlib.conflicts import ConflictList, Conflict
 
25
from bzrlib.errors import (BzrCommandError,
 
26
                           BzrError,
 
27
                           NoCommonAncestor,
 
28
                           NoCommits,
 
29
                           NoSuchRevision,
 
30
                           NoSuchFile,
 
31
                           NotBranchError,
 
32
                           NotVersionedError,
 
33
                           UnrelatedBranches,
 
34
                           UnsupportedOperation,
 
35
                           WorkingTreeNotRevision,
 
36
                           BinaryFile,
 
37
                           )
 
38
from bzrlib.merge3 import Merge3
 
39
import bzrlib.osutils
 
40
from bzrlib.osutils import rename, pathjoin, rmtree
 
41
from progress import DummyProgress, ProgressPhase
 
42
from bzrlib.revision import common_ancestor, is_ancestor, NULL_REVISION
 
43
from bzrlib.textfile import check_text_lines
 
44
from bzrlib.trace import mutter, warning, note
 
45
from bzrlib.transform import (TreeTransform, resolve_conflicts, cook_conflicts,
 
46
                              FinalPaths, create_by_entry, unique_add)
 
47
from bzrlib.versionedfile import WeaveMerge
 
48
from bzrlib import ui
 
49
 
 
50
# TODO: Report back as changes are merged in
 
51
 
 
52
def _get_tree(treespec, local_branch=None):
 
53
    location, revno = treespec
 
54
    branch = Branch.open_containing(location)[0]
 
55
    if revno is None:
 
56
        revision = None
 
57
    elif revno == -1:
 
58
        revision = branch.last_revision()
 
59
    else:
 
60
        revision = branch.get_rev_id(revno)
 
61
        if revision is None:
 
62
            revision = NULL_REVISION
 
63
    return branch, _get_revid_tree(branch, revision, local_branch)
 
64
 
 
65
 
 
66
def _get_revid_tree(branch, revision, local_branch):
 
67
    if revision is None:
 
68
        base_tree = branch.bzrdir.open_workingtree()
 
69
    else:
 
70
        if local_branch is not None:
 
71
            if local_branch.base != branch.base:
 
72
                local_branch.fetch(branch, revision)
 
73
            base_tree = local_branch.repository.revision_tree(revision)
 
74
        else:
 
75
            base_tree = branch.repository.revision_tree(revision)
 
76
    return base_tree
 
77
 
 
78
 
 
79
def transform_tree(from_tree, to_tree, interesting_ids=None):
 
80
    merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
 
81
                interesting_ids=interesting_ids, this_tree=from_tree)
 
82
 
 
83
 
 
84
class Merger(object):
 
85
    def __init__(self, this_branch, other_tree=None, base_tree=None, 
 
86
                 this_tree=None, pb=DummyProgress()):
 
87
        object.__init__(self)
 
88
        assert this_tree is not None, "this_tree is required"
 
89
        self.this_branch = this_branch
 
90
        self.this_basis = this_branch.last_revision()
 
91
        self.this_rev_id = None
 
92
        self.this_tree = this_tree
 
93
        self.this_revision_tree = None
 
94
        self.this_basis_tree = None
 
95
        self.other_tree = other_tree
 
96
        self.base_tree = base_tree
 
97
        self.ignore_zero = False
 
98
        self.backup_files = False
 
99
        self.interesting_ids = None
 
100
        self.show_base = False
 
101
        self.reprocess = False
 
102
        self._pb = pb 
 
103
        self.pp = None
 
104
 
 
105
 
 
106
    def revision_tree(self, revision_id):
 
107
        return self.this_branch.repository.revision_tree(revision_id)
 
108
 
 
109
    def ensure_revision_trees(self):
 
110
        if self.this_revision_tree is None:
 
111
            self.this_basis_tree = self.this_branch.repository.revision_tree(
 
112
                self.this_basis)
 
113
            if self.this_basis == self.this_rev_id:
 
114
                self.this_revision_tree = self.this_basis_tree
 
115
 
 
116
        if self.other_rev_id is None:
 
117
            other_basis_tree = self.revision_tree(self.other_basis)
 
118
            changes = other_basis_tree.changes_from(self.other_tree)
 
119
            if changes.has_changed():
 
120
                raise WorkingTreeNotRevision(self.this_tree)
 
121
            other_rev_id = self.other_basis
 
122
            self.other_tree = other_basis_tree
 
123
 
 
124
    def file_revisions(self, file_id):
 
125
        self.ensure_revision_trees()
 
126
        def get_id(tree, file_id):
 
127
            revision_id = tree.inventory[file_id].revision
 
128
            assert revision_id is not None
 
129
            return revision_id
 
130
        if self.this_rev_id is None:
 
131
            if self.this_basis_tree.get_file_sha1(file_id) != \
 
132
                self.this_tree.get_file_sha1(file_id):
 
133
                raise WorkingTreeNotRevision(self.this_tree)
 
134
 
 
135
        trees = (self.this_basis_tree, self.other_tree)
 
136
        return [get_id(tree, file_id) for tree in trees]
 
137
 
 
138
    def check_basis(self, check_clean, require_commits=True):
 
139
        if self.this_basis is None and require_commits is True:
 
140
            raise BzrCommandError("This branch has no commits")
 
141
        if check_clean:
 
142
            self.compare_basis()
 
143
            if self.this_basis != self.this_rev_id:
 
144
                raise BzrCommandError("Working tree has uncommitted changes.")
 
145
 
 
146
    def compare_basis(self):
 
147
        changes = self.this_tree.changes_from(self.this_tree.basis_tree())
 
148
        if not changes.has_changed():
 
149
            self.this_rev_id = self.this_basis
 
150
 
 
151
    def set_interesting_files(self, file_list):
 
152
        try:
 
153
            self._set_interesting_files(file_list)
 
154
        except NotVersionedError, e:
 
155
            raise BzrCommandError("%s is not a source file in any"
 
156
                                      " tree." % e.path)
 
157
 
 
158
    def _set_interesting_files(self, file_list):
 
159
        """Set the list of interesting ids from a list of files."""
 
160
        if file_list is None:
 
161
            self.interesting_ids = None
 
162
            return
 
163
 
 
164
        interesting_ids = set()
 
165
        for path in file_list:
 
166
            found_id = False
 
167
            for tree in (self.this_tree, self.base_tree, self.other_tree):
 
168
                file_id = tree.inventory.path2id(path)
 
169
                if file_id is not None:
 
170
                    interesting_ids.add(file_id)
 
171
                    found_id = True
 
172
            if not found_id:
 
173
                raise NotVersionedError(path=path)
 
174
        self.interesting_ids = interesting_ids
 
175
 
 
176
    def set_pending(self):
 
177
        if not self.base_is_ancestor:
 
178
            return
 
179
        if self.other_rev_id is None:
 
180
            return
 
181
        ancestry = self.this_branch.repository.get_ancestry(self.this_basis)
 
182
        if self.other_rev_id in ancestry:
 
183
            return
 
184
        self.this_tree.add_pending_merge(self.other_rev_id)
 
185
 
 
186
    def set_other(self, other_revision):
 
187
        other_branch, self.other_tree = _get_tree(other_revision, 
 
188
                                                  self.this_branch)
 
189
        if other_revision[1] == -1:
 
190
            self.other_rev_id = other_branch.last_revision()
 
191
            if self.other_rev_id is None:
 
192
                raise NoCommits(other_branch)
 
193
            self.other_basis = self.other_rev_id
 
194
        elif other_revision[1] is not None:
 
195
            self.other_rev_id = other_branch.get_rev_id(other_revision[1])
 
196
            self.other_basis = self.other_rev_id
 
197
        else:
 
198
            self.other_rev_id = None
 
199
            self.other_basis = other_branch.last_revision()
 
200
            if self.other_basis is None:
 
201
                raise NoCommits(other_branch)
 
202
        if other_branch.base != self.this_branch.base:
 
203
            self.this_branch.fetch(other_branch, last_revision=self.other_basis)
 
204
 
 
205
    def find_base(self):
 
206
        self.set_base([None, None])
 
207
 
 
208
    def set_base(self, base_revision):
 
209
        mutter("doing merge() with no base_revision specified")
 
210
        if base_revision == [None, None]:
 
211
            try:
 
212
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
213
                try:
 
214
                    this_repo = self.this_branch.repository
 
215
                    self.base_rev_id = common_ancestor(self.this_basis, 
 
216
                                                       self.other_basis, 
 
217
                                                       this_repo, pb)
 
218
                finally:
 
219
                    pb.finished()
 
220
            except NoCommonAncestor:
 
221
                raise UnrelatedBranches()
 
222
            self.base_tree = _get_revid_tree(self.this_branch, self.base_rev_id,
 
223
                                            None)
 
224
            self.base_is_ancestor = True
 
225
        else:
 
226
            base_branch, self.base_tree = _get_tree(base_revision)
 
227
            if base_revision[1] == -1:
 
228
                self.base_rev_id = base_branch.last_revision()
 
229
            elif base_revision[1] is None:
 
230
                self.base_rev_id = None
 
231
            else:
 
232
                self.base_rev_id = base_branch.get_rev_id(base_revision[1])
 
233
            if self.this_branch.base != base_branch.base:
 
234
                self.this_branch.fetch(base_branch)
 
235
            self.base_is_ancestor = is_ancestor(self.this_basis, 
 
236
                                                self.base_rev_id,
 
237
                                                self.this_branch)
 
238
 
 
239
    def do_merge(self):
 
240
        kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree, 
 
241
                  'other_tree': self.other_tree, 
 
242
                  'interesting_ids': self.interesting_ids,
 
243
                  'pp': self.pp}
 
244
        if self.merge_type.requires_base:
 
245
            kwargs['base_tree'] = self.base_tree
 
246
        if self.merge_type.supports_reprocess:
 
247
            kwargs['reprocess'] = self.reprocess
 
248
        elif self.reprocess:
 
249
            raise BzrError("Conflict reduction is not supported for merge"
 
250
                                  " type %s." % self.merge_type)
 
251
        if self.merge_type.supports_show_base:
 
252
            kwargs['show_base'] = self.show_base
 
253
        elif self.show_base:
 
254
            raise BzrError("Showing base is not supported for this"
 
255
                                  " merge type. %s" % self.merge_type)
 
256
        merge = self.merge_type(pb=self._pb, **kwargs)
 
257
        if len(merge.cooked_conflicts) == 0:
 
258
            if not self.ignore_zero:
 
259
                note("All changes applied successfully.")
 
260
        else:
 
261
            note("%d conflicts encountered." % len(merge.cooked_conflicts))
 
262
 
 
263
        return len(merge.cooked_conflicts)
 
264
 
 
265
    def regen_inventory(self, new_entries):
 
266
        old_entries = self.this_tree.read_working_inventory()
 
267
        new_inventory = {}
 
268
        by_path = {}
 
269
        new_entries_map = {} 
 
270
        for path, file_id in new_entries:
 
271
            if path is None:
 
272
                continue
 
273
            new_entries_map[file_id] = path
 
274
 
 
275
        def id2path(file_id):
 
276
            path = new_entries_map.get(file_id)
 
277
            if path is not None:
 
278
                return path
 
279
            entry = old_entries[file_id]
 
280
            if entry.parent_id is None:
 
281
                return entry.name
 
282
            return pathjoin(id2path(entry.parent_id), entry.name)
 
283
            
 
284
        for file_id in old_entries:
 
285
            entry = old_entries[file_id]
 
286
            path = id2path(file_id)
 
287
            if file_id in self.base_tree.inventory:
 
288
                executable = getattr(self.base_tree.inventory[file_id], 'executable', False)
 
289
            else:
 
290
                executable = getattr(entry, 'executable', False)
 
291
            new_inventory[file_id] = (path, file_id, entry.parent_id, 
 
292
                                      entry.kind, executable)
 
293
                                      
 
294
            by_path[path] = file_id
 
295
        
 
296
        deletions = 0
 
297
        insertions = 0
 
298
        new_path_list = []
 
299
        for path, file_id in new_entries:
 
300
            if path is None:
 
301
                del new_inventory[file_id]
 
302
                deletions += 1
 
303
            else:
 
304
                new_path_list.append((path, file_id))
 
305
                if file_id not in old_entries:
 
306
                    insertions += 1
 
307
        # Ensure no file is added before its parent
 
308
        new_path_list.sort()
 
309
        for path, file_id in new_path_list:
 
310
            if path == '':
 
311
                parent = None
 
312
            else:
 
313
                parent = by_path[os.path.dirname(path)]
 
314
            abspath = pathjoin(self.this_tree.basedir, path)
 
315
            kind = bzrlib.osutils.file_kind(abspath)
 
316
            if file_id in self.base_tree.inventory:
 
317
                executable = getattr(self.base_tree.inventory[file_id], 'executable', False)
 
318
            else:
 
319
                executable = False
 
320
            new_inventory[file_id] = (path, file_id, parent, kind, executable)
 
321
            by_path[path] = file_id 
 
322
 
 
323
        # Get a list in insertion order
 
324
        new_inventory_list = new_inventory.values()
 
325
        mutter ("""Inventory regeneration:
 
326
    old length: %i insertions: %i deletions: %i new_length: %i"""\
 
327
            % (len(old_entries), insertions, deletions, 
 
328
               len(new_inventory_list)))
 
329
        assert len(new_inventory_list) == len(old_entries) + insertions\
 
330
            - deletions
 
331
        new_inventory_list.sort()
 
332
        return new_inventory_list
 
333
 
 
334
 
 
335
class Merge3Merger(object):
 
336
    """Three-way merger that uses the merge3 text merger"""
 
337
    requires_base = True
 
338
    supports_reprocess = True
 
339
    supports_show_base = True
 
340
    history_based = False
 
341
 
 
342
    def __init__(self, working_tree, this_tree, base_tree, other_tree, 
 
343
                 interesting_ids=None, reprocess=False, show_base=False,
 
344
                 pb=DummyProgress(), pp=None):
 
345
        """Initialize the merger object and perform the merge."""
 
346
        object.__init__(self)
 
347
        self.this_tree = working_tree
 
348
        self.base_tree = base_tree
 
349
        self.other_tree = other_tree
 
350
        self._raw_conflicts = []
 
351
        self.cooked_conflicts = []
 
352
        self.reprocess = reprocess
 
353
        self.show_base = show_base
 
354
        self.pb = pb
 
355
        self.pp = pp
 
356
        if self.pp is None:
 
357
            self.pp = ProgressPhase("Merge phase", 3, self.pb)
 
358
 
 
359
        if interesting_ids is not None:
 
360
            all_ids = interesting_ids
 
361
        else:
 
362
            all_ids = set(base_tree)
 
363
            all_ids.update(other_tree)
 
364
        working_tree.lock_write()
 
365
        self.tt = TreeTransform(working_tree, self.pb)
 
366
        try:
 
367
            self.pp.next_phase()
 
368
            child_pb = ui.ui_factory.nested_progress_bar()
 
369
            try:
 
370
                for num, file_id in enumerate(all_ids):
 
371
                    child_pb.update('Preparing file merge', num, len(all_ids))
 
372
                    self.merge_names(file_id)
 
373
                    file_status = self.merge_contents(file_id)
 
374
                    self.merge_executable(file_id, file_status)
 
375
            finally:
 
376
                child_pb.finished()
 
377
                
 
378
            self.pp.next_phase()
 
379
            child_pb = ui.ui_factory.nested_progress_bar()
 
380
            try:
 
381
                fs_conflicts = resolve_conflicts(self.tt, child_pb)
 
382
            finally:
 
383
                child_pb.finished()
 
384
            self.cook_conflicts(fs_conflicts)
 
385
            for conflict in self.cooked_conflicts:
 
386
                warning(conflict)
 
387
            self.pp.next_phase()
 
388
            results = self.tt.apply()
 
389
            self.write_modified(results)
 
390
            try:
 
391
                working_tree.add_conflicts(self.cooked_conflicts)
 
392
            except UnsupportedOperation:
 
393
                pass
 
394
        finally:
 
395
            self.tt.finalize()
 
396
            working_tree.unlock()
 
397
            self.pb.clear()
 
398
 
 
399
    def write_modified(self, results):
 
400
        modified_hashes = {}
 
401
        for path in results.modified_paths:
 
402
            file_id = self.this_tree.path2id(self.this_tree.relpath(path))
 
403
            if file_id is None:
 
404
                continue
 
405
            hash = self.this_tree.get_file_sha1(file_id)
 
406
            if hash is None:
 
407
                continue
 
408
            modified_hashes[file_id] = hash
 
409
        self.this_tree.set_merge_modified(modified_hashes)
 
410
 
 
411
    @staticmethod
 
412
    def parent(entry, file_id):
 
413
        """Determine the parent for a file_id (used as a key method)"""
 
414
        if entry is None:
 
415
            return None
 
416
        return entry.parent_id
 
417
 
 
418
    @staticmethod
 
419
    def name(entry, file_id):
 
420
        """Determine the name for a file_id (used as a key method)"""
 
421
        if entry is None:
 
422
            return None
 
423
        return entry.name
 
424
    
 
425
    @staticmethod
 
426
    def contents_sha1(tree, file_id):
 
427
        """Determine the sha1 of the file contents (used as a key method)."""
 
428
        if file_id not in tree:
 
429
            return None
 
430
        return tree.get_file_sha1(file_id)
 
431
 
 
432
    @staticmethod
 
433
    def executable(tree, file_id):
 
434
        """Determine the executability of a file-id (used as a key method)."""
 
435
        if file_id not in tree:
 
436
            return None
 
437
        if tree.kind(file_id) != "file":
 
438
            return False
 
439
        return tree.is_executable(file_id)
 
440
 
 
441
    @staticmethod
 
442
    def kind(tree, file_id):
 
443
        """Determine the kind of a file-id (used as a key method)."""
 
444
        if file_id not in tree:
 
445
            return None
 
446
        return tree.kind(file_id)
 
447
 
 
448
    @staticmethod
 
449
    def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
 
450
        """Do a three-way test on a scalar.
 
451
        Return "this", "other" or "conflict", depending whether a value wins.
 
452
        """
 
453
        key_base = key(base_tree, file_id)
 
454
        key_other = key(other_tree, file_id)
 
455
        #if base == other, either they all agree, or only THIS has changed.
 
456
        if key_base == key_other:
 
457
            return "this"
 
458
        key_this = key(this_tree, file_id)
 
459
        if key_this not in (key_base, key_other):
 
460
            return "conflict"
 
461
        # "Ambiguous clean merge"
 
462
        elif key_this == key_other:
 
463
            return "this"
 
464
        else:
 
465
            assert key_this == key_base
 
466
            return "other"
 
467
 
 
468
    def merge_names(self, file_id):
 
469
        """Perform a merge on file_id names and parents"""
 
470
        def get_entry(tree):
 
471
            if file_id in tree.inventory:
 
472
                return tree.inventory[file_id]
 
473
            else:
 
474
                return None
 
475
        this_entry = get_entry(self.this_tree)
 
476
        other_entry = get_entry(self.other_tree)
 
477
        base_entry = get_entry(self.base_tree)
 
478
        name_winner = self.scalar_three_way(this_entry, base_entry, 
 
479
                                            other_entry, file_id, self.name)
 
480
        parent_id_winner = self.scalar_three_way(this_entry, base_entry, 
 
481
                                                 other_entry, file_id, 
 
482
                                                 self.parent)
 
483
        if this_entry is None:
 
484
            if name_winner == "this":
 
485
                name_winner = "other"
 
486
            if parent_id_winner == "this":
 
487
                parent_id_winner = "other"
 
488
        if name_winner == "this" and parent_id_winner == "this":
 
489
            return
 
490
        if name_winner == "conflict":
 
491
            trans_id = self.tt.trans_id_file_id(file_id)
 
492
            self._raw_conflicts.append(('name conflict', trans_id, 
 
493
                                        self.name(this_entry, file_id), 
 
494
                                        self.name(other_entry, file_id)))
 
495
        if parent_id_winner == "conflict":
 
496
            trans_id = self.tt.trans_id_file_id(file_id)
 
497
            self._raw_conflicts.append(('parent conflict', trans_id, 
 
498
                                        self.parent(this_entry, file_id), 
 
499
                                        self.parent(other_entry, file_id)))
 
500
        if other_entry is None:
 
501
            # it doesn't matter whether the result was 'other' or 
 
502
            # 'conflict'-- if there's no 'other', we leave it alone.
 
503
            return
 
504
        # if we get here, name_winner and parent_winner are set to safe values.
 
505
        winner_entry = {"this": this_entry, "other": other_entry, 
 
506
                        "conflict": other_entry}
 
507
        trans_id = self.tt.trans_id_file_id(file_id)
 
508
        parent_id = winner_entry[parent_id_winner].parent_id
 
509
        parent_trans_id = self.tt.trans_id_file_id(parent_id)
 
510
        self.tt.adjust_path(winner_entry[name_winner].name, parent_trans_id,
 
511
                            trans_id)
 
512
 
 
513
    def merge_contents(self, file_id):
 
514
        """Performa a merge on file_id contents."""
 
515
        def contents_pair(tree):
 
516
            if file_id not in tree:
 
517
                return (None, None)
 
518
            kind = tree.kind(file_id)
 
519
            if kind == "root_directory":
 
520
                kind = "directory"
 
521
            if kind == "file":
 
522
                contents = tree.get_file_sha1(file_id)
 
523
            elif kind == "symlink":
 
524
                contents = tree.get_symlink_target(file_id)
 
525
            else:
 
526
                contents = None
 
527
            return kind, contents
 
528
 
 
529
        def contents_conflict():
 
530
            trans_id = self.tt.trans_id_file_id(file_id)
 
531
            name = self.tt.final_name(trans_id)
 
532
            parent_id = self.tt.final_parent(trans_id)
 
533
            if file_id in self.this_tree.inventory:
 
534
                self.tt.unversion_file(trans_id)
 
535
                self.tt.delete_contents(trans_id)
 
536
            file_group = self._dump_conflicts(name, parent_id, file_id, 
 
537
                                              set_version=True)
 
538
            self._raw_conflicts.append(('contents conflict', file_group))
 
539
 
 
540
        # See SPOT run.  run, SPOT, run.
 
541
        # So we're not QUITE repeating ourselves; we do tricky things with
 
542
        # file kind...
 
543
        base_pair = contents_pair(self.base_tree)
 
544
        other_pair = contents_pair(self.other_tree)
 
545
        if base_pair == other_pair:
 
546
            # OTHER introduced no changes
 
547
            return "unmodified"
 
548
        this_pair = contents_pair(self.this_tree)
 
549
        if this_pair == other_pair:
 
550
            # THIS and OTHER introduced the same changes
 
551
            return "unmodified"
 
552
        else:
 
553
            trans_id = self.tt.trans_id_file_id(file_id)
 
554
            if this_pair == base_pair:
 
555
                # only OTHER introduced changes
 
556
                if file_id in self.this_tree:
 
557
                    # Remove any existing contents
 
558
                    self.tt.delete_contents(trans_id)
 
559
                if file_id in self.other_tree:
 
560
                    # OTHER changed the file
 
561
                    create_by_entry(self.tt, 
 
562
                                    self.other_tree.inventory[file_id], 
 
563
                                    self.other_tree, trans_id)
 
564
                    if file_id not in self.this_tree.inventory:
 
565
                        self.tt.version_file(file_id, trans_id)
 
566
                    return "modified"
 
567
                elif file_id in self.this_tree.inventory:
 
568
                    # OTHER deleted the file
 
569
                    self.tt.unversion_file(trans_id)
 
570
                    return "deleted"
 
571
            #BOTH THIS and OTHER introduced changes; scalar conflict
 
572
            elif this_pair[0] == "file" and other_pair[0] == "file":
 
573
                # THIS and OTHER are both files, so text merge.  Either
 
574
                # BASE is a file, or both converted to files, so at least we
 
575
                # have agreement that output should be a file.
 
576
                try:
 
577
                    self.text_merge(file_id, trans_id)
 
578
                except BinaryFile:
 
579
                    return contents_conflict()
 
580
                if file_id not in self.this_tree.inventory:
 
581
                    self.tt.version_file(file_id, trans_id)
 
582
                try:
 
583
                    self.tt.tree_kind(trans_id)
 
584
                    self.tt.delete_contents(trans_id)
 
585
                except NoSuchFile:
 
586
                    pass
 
587
                return "modified"
 
588
            else:
 
589
                # Scalar conflict, can't text merge.  Dump conflicts
 
590
                return contents_conflict()
 
591
 
 
592
    def get_lines(self, tree, file_id):
 
593
        """Return the lines in a file, or an empty list."""
 
594
        if file_id in tree:
 
595
            return tree.get_file(file_id).readlines()
 
596
        else:
 
597
            return []
 
598
 
 
599
    def text_merge(self, file_id, trans_id):
 
600
        """Perform a three-way text merge on a file_id"""
 
601
        # it's possible that we got here with base as a different type.
 
602
        # if so, we just want two-way text conflicts.
 
603
        if file_id in self.base_tree and \
 
604
            self.base_tree.kind(file_id) == "file":
 
605
            base_lines = self.get_lines(self.base_tree, file_id)
 
606
        else:
 
607
            base_lines = []
 
608
        other_lines = self.get_lines(self.other_tree, file_id)
 
609
        this_lines = self.get_lines(self.this_tree, file_id)
 
610
        m3 = Merge3(base_lines, this_lines, other_lines)
 
611
        start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
 
612
        if self.show_base is True:
 
613
            base_marker = '|' * 7
 
614
        else:
 
615
            base_marker = None
 
616
 
 
617
        def iter_merge3(retval):
 
618
            retval["text_conflicts"] = False
 
619
            for line in m3.merge_lines(name_a = "TREE", 
 
620
                                       name_b = "MERGE-SOURCE", 
 
621
                                       name_base = "BASE-REVISION",
 
622
                                       start_marker=start_marker, 
 
623
                                       base_marker=base_marker,
 
624
                                       reprocess=self.reprocess):
 
625
                if line.startswith(start_marker):
 
626
                    retval["text_conflicts"] = True
 
627
                    yield line.replace(start_marker, '<' * 7)
 
628
                else:
 
629
                    yield line
 
630
        retval = {}
 
631
        merge3_iterator = iter_merge3(retval)
 
632
        self.tt.create_file(merge3_iterator, trans_id)
 
633
        if retval["text_conflicts"] is True:
 
634
            self._raw_conflicts.append(('text conflict', trans_id))
 
635
            name = self.tt.final_name(trans_id)
 
636
            parent_id = self.tt.final_parent(trans_id)
 
637
            file_group = self._dump_conflicts(name, parent_id, file_id, 
 
638
                                              this_lines, base_lines,
 
639
                                              other_lines)
 
640
            file_group.append(trans_id)
 
641
 
 
642
    def _dump_conflicts(self, name, parent_id, file_id, this_lines=None, 
 
643
                        base_lines=None, other_lines=None, set_version=False,
 
644
                        no_base=False):
 
645
        """Emit conflict files.
 
646
        If this_lines, base_lines, or other_lines are omitted, they will be
 
647
        determined automatically.  If set_version is true, the .OTHER, .THIS
 
648
        or .BASE (in that order) will be created as versioned files.
 
649
        """
 
650
        data = [('OTHER', self.other_tree, other_lines), 
 
651
                ('THIS', self.this_tree, this_lines)]
 
652
        if not no_base:
 
653
            data.append(('BASE', self.base_tree, base_lines))
 
654
        versioned = False
 
655
        file_group = []
 
656
        for suffix, tree, lines in data:
 
657
            if file_id in tree:
 
658
                trans_id = self._conflict_file(name, parent_id, tree, file_id,
 
659
                                               suffix, lines)
 
660
                file_group.append(trans_id)
 
661
                if set_version and not versioned:
 
662
                    self.tt.version_file(file_id, trans_id)
 
663
                    versioned = True
 
664
        return file_group
 
665
           
 
666
    def _conflict_file(self, name, parent_id, tree, file_id, suffix, 
 
667
                       lines=None):
 
668
        """Emit a single conflict file."""
 
669
        name = name + '.' + suffix
 
670
        trans_id = self.tt.create_path(name, parent_id)
 
671
        entry = tree.inventory[file_id]
 
672
        create_by_entry(self.tt, entry, tree, trans_id, lines)
 
673
        return trans_id
 
674
 
 
675
    def merge_executable(self, file_id, file_status):
 
676
        """Perform a merge on the execute bit."""
 
677
        if file_status == "deleted":
 
678
            return
 
679
        trans_id = self.tt.trans_id_file_id(file_id)
 
680
        try:
 
681
            if self.tt.final_kind(trans_id) != "file":
 
682
                return
 
683
        except NoSuchFile:
 
684
            return
 
685
        winner = self.scalar_three_way(self.this_tree, self.base_tree, 
 
686
                                       self.other_tree, file_id, 
 
687
                                       self.executable)
 
688
        if winner == "conflict":
 
689
        # There must be a None in here, if we have a conflict, but we
 
690
        # need executability since file status was not deleted.
 
691
            if self.executable(self.other_tree, file_id) is None:
 
692
                winner = "this"
 
693
            else:
 
694
                winner = "other"
 
695
        if winner == "this":
 
696
            if file_status == "modified":
 
697
                executability = self.this_tree.is_executable(file_id)
 
698
                if executability is not None:
 
699
                    trans_id = self.tt.trans_id_file_id(file_id)
 
700
                    self.tt.set_executability(executability, trans_id)
 
701
        else:
 
702
            assert winner == "other"
 
703
            if file_id in self.other_tree:
 
704
                executability = self.other_tree.is_executable(file_id)
 
705
            elif file_id in self.this_tree:
 
706
                executability = self.this_tree.is_executable(file_id)
 
707
            elif file_id in self.base_tree:
 
708
                executability = self.base_tree.is_executable(file_id)
 
709
            if executability is not None:
 
710
                trans_id = self.tt.trans_id_file_id(file_id)
 
711
                self.tt.set_executability(executability, trans_id)
 
712
 
 
713
    def cook_conflicts(self, fs_conflicts):
 
714
        """Convert all conflicts into a form that doesn't depend on trans_id"""
 
715
        from conflicts import Conflict
 
716
        name_conflicts = {}
 
717
        self.cooked_conflicts.extend(cook_conflicts(fs_conflicts, self.tt))
 
718
        fp = FinalPaths(self.tt)
 
719
        for conflict in self._raw_conflicts:
 
720
            conflict_type = conflict[0]
 
721
            if conflict_type in ('name conflict', 'parent conflict'):
 
722
                trans_id = conflict[1]
 
723
                conflict_args = conflict[2:]
 
724
                if trans_id not in name_conflicts:
 
725
                    name_conflicts[trans_id] = {}
 
726
                unique_add(name_conflicts[trans_id], conflict_type, 
 
727
                           conflict_args)
 
728
            if conflict_type == 'contents conflict':
 
729
                for trans_id in conflict[1]:
 
730
                    file_id = self.tt.final_file_id(trans_id)
 
731
                    if file_id is not None:
 
732
                        break
 
733
                path = fp.get_path(trans_id)
 
734
                for suffix in ('.BASE', '.THIS', '.OTHER'):
 
735
                    if path.endswith(suffix):
 
736
                        path = path[:-len(suffix)]
 
737
                        break
 
738
                c = Conflict.factory(conflict_type, path=path, file_id=file_id)
 
739
                self.cooked_conflicts.append(c)
 
740
            if conflict_type == 'text conflict':
 
741
                trans_id = conflict[1]
 
742
                path = fp.get_path(trans_id)
 
743
                file_id = self.tt.final_file_id(trans_id)
 
744
                c = Conflict.factory(conflict_type, path=path, file_id=file_id)
 
745
                self.cooked_conflicts.append(c)
 
746
 
 
747
        for trans_id, conflicts in name_conflicts.iteritems():
 
748
            try:
 
749
                this_parent, other_parent = conflicts['parent conflict']
 
750
                assert this_parent != other_parent
 
751
            except KeyError:
 
752
                this_parent = other_parent = \
 
753
                    self.tt.final_file_id(self.tt.final_parent(trans_id))
 
754
            try:
 
755
                this_name, other_name = conflicts['name conflict']
 
756
                assert this_name != other_name
 
757
            except KeyError:
 
758
                this_name = other_name = self.tt.final_name(trans_id)
 
759
            other_path = fp.get_path(trans_id)
 
760
            if this_parent is not None:
 
761
                this_parent_path = \
 
762
                    fp.get_path(self.tt.trans_id_file_id(this_parent))
 
763
                this_path = pathjoin(this_parent_path, this_name)
 
764
            else:
 
765
                this_path = "<deleted>"
 
766
            file_id = self.tt.final_file_id(trans_id)
 
767
            c = Conflict.factory('path conflict', path=this_path,
 
768
                                 conflict_path=other_path, file_id=file_id)
 
769
            self.cooked_conflicts.append(c)
 
770
        self.cooked_conflicts.sort(key=Conflict.sort_key)
 
771
 
 
772
 
 
773
class WeaveMerger(Merge3Merger):
 
774
    """Three-way tree merger, text weave merger."""
 
775
    supports_reprocess = True
 
776
    supports_show_base = False
 
777
 
 
778
    def __init__(self, working_tree, this_tree, base_tree, other_tree, 
 
779
                 interesting_ids=None, pb=DummyProgress(), pp=None,
 
780
                 reprocess=False):
 
781
        self.this_revision_tree = self._get_revision_tree(this_tree)
 
782
        self.other_revision_tree = self._get_revision_tree(other_tree)
 
783
        super(WeaveMerger, self).__init__(working_tree, this_tree, 
 
784
                                          base_tree, other_tree, 
 
785
                                          interesting_ids=interesting_ids, 
 
786
                                          pb=pb, pp=pp, reprocess=reprocess)
 
787
 
 
788
    def _get_revision_tree(self, tree):
 
789
        """Return a revision tree related to this tree.
 
790
        If the tree is a WorkingTree, the basis will be returned.
 
791
        """
 
792
        if getattr(tree, 'get_weave', False) is False:
 
793
            # If we have a WorkingTree, try using the basis
 
794
            return tree.branch.basis_tree()
 
795
        else:
 
796
            return tree
 
797
 
 
798
    def _check_file(self, file_id):
 
799
        """Check that the revision tree's version of the file matches."""
 
800
        for tree, rt in ((self.this_tree, self.this_revision_tree), 
 
801
                         (self.other_tree, self.other_revision_tree)):
 
802
            if rt is tree:
 
803
                continue
 
804
            if tree.get_file_sha1(file_id) != rt.get_file_sha1(file_id):
 
805
                raise WorkingTreeNotRevision(self.this_tree)
 
806
 
 
807
    def _merged_lines(self, file_id):
 
808
        """Generate the merged lines.
 
809
        There is no distinction between lines that are meant to contain <<<<<<<
 
810
        and conflicts.
 
811
        """
 
812
        weave = self.this_revision_tree.get_weave(file_id)
 
813
        this_revision_id = self.this_revision_tree.inventory[file_id].revision
 
814
        other_revision_id = \
 
815
            self.other_revision_tree.inventory[file_id].revision
 
816
        wm = WeaveMerge(weave, this_revision_id, other_revision_id, 
 
817
                        '<<<<<<< TREE\n', '>>>>>>> MERGE-SOURCE\n')
 
818
        return wm.merge_lines(self.reprocess)
 
819
 
 
820
    def text_merge(self, file_id, trans_id):
 
821
        """Perform a (weave) text merge for a given file and file-id.
 
822
        If conflicts are encountered, .THIS and .OTHER files will be emitted,
 
823
        and a conflict will be noted.
 
824
        """
 
825
        self._check_file(file_id)
 
826
        lines, conflicts = self._merged_lines(file_id)
 
827
        lines = list(lines)
 
828
        # Note we're checking whether the OUTPUT is binary in this case, 
 
829
        # because we don't want to get into weave merge guts.
 
830
        check_text_lines(lines)
 
831
        self.tt.create_file(lines, trans_id)
 
832
        if conflicts:
 
833
            self._raw_conflicts.append(('text conflict', trans_id))
 
834
            name = self.tt.final_name(trans_id)
 
835
            parent_id = self.tt.final_parent(trans_id)
 
836
            file_group = self._dump_conflicts(name, parent_id, file_id, 
 
837
                                              no_base=True)
 
838
            file_group.append(trans_id)
 
839
 
 
840
 
 
841
class Diff3Merger(Merge3Merger):
 
842
    """Three-way merger using external diff3 for text merging"""
 
843
 
 
844
    def dump_file(self, temp_dir, name, tree, file_id):
 
845
        out_path = pathjoin(temp_dir, name)
 
846
        out_file = open(out_path, "wb")
 
847
        try:
 
848
            in_file = tree.get_file(file_id)
 
849
            for line in in_file:
 
850
                out_file.write(line)
 
851
        finally:
 
852
            out_file.close()
 
853
        return out_path
 
854
 
 
855
    def text_merge(self, file_id, trans_id):
 
856
        """Perform a diff3 merge using a specified file-id and trans-id.
 
857
        If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
 
858
        will be dumped, and a will be conflict noted.
 
859
        """
 
860
        import bzrlib.patch
 
861
        temp_dir = mkdtemp(prefix="bzr-")
 
862
        try:
 
863
            new_file = pathjoin(temp_dir, "new")
 
864
            this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
 
865
            base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
 
866
            other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
 
867
            status = bzrlib.patch.diff3(new_file, this, base, other)
 
868
            if status not in (0, 1):
 
869
                raise BzrError("Unhandled diff3 exit code")
 
870
            f = open(new_file, 'rb')
 
871
            try:
 
872
                self.tt.create_file(f, trans_id)
 
873
            finally:
 
874
                f.close()
 
875
            if status == 1:
 
876
                name = self.tt.final_name(trans_id)
 
877
                parent_id = self.tt.final_parent(trans_id)
 
878
                self._dump_conflicts(name, parent_id, file_id)
 
879
            self._raw_conflicts.append(('text conflict', trans_id))
 
880
        finally:
 
881
            rmtree(temp_dir)
 
882
 
 
883
 
 
884
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
 
885
                backup_files=False, 
 
886
                merge_type=Merge3Merger, 
 
887
                interesting_ids=None, 
 
888
                show_base=False, 
 
889
                reprocess=False, 
 
890
                other_rev_id=None,
 
891
                interesting_files=None,
 
892
                this_tree=None,
 
893
                pb=DummyProgress()):
 
894
    """Primary interface for merging. 
 
895
 
 
896
        typical use is probably 
 
897
        'merge_inner(branch, branch.get_revision_tree(other_revision),
 
898
                     branch.get_revision_tree(base_revision))'
 
899
        """
 
900
    if this_tree is None:
 
901
        warnings.warn("bzrlib.merge.merge_inner requires a this_tree parameter as of "
 
902
             "bzrlib version 0.8.",
 
903
             DeprecationWarning,
 
904
             stacklevel=2)
 
905
        this_tree = this_branch.bzrdir.open_workingtree()
 
906
    merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree, 
 
907
                    pb=pb)
 
908
    merger.backup_files = backup_files
 
909
    merger.merge_type = merge_type
 
910
    merger.interesting_ids = interesting_ids
 
911
    merger.ignore_zero = ignore_zero
 
912
    if interesting_files:
 
913
        assert not interesting_ids, ('Only supply interesting_ids'
 
914
                                     ' or interesting_files')
 
915
        merger._set_interesting_files(interesting_files)
 
916
    merger.show_base = show_base 
 
917
    merger.reprocess = reprocess
 
918
    merger.other_rev_id = other_rev_id
 
919
    merger.other_basis = other_rev_id
 
920
    return merger.do_merge()
 
921
 
 
922
 
 
923
merge_types = {     "merge3": (Merge3Merger, "Native diff3-style merge"), 
 
924
                     "diff3": (Diff3Merger,  "Merge using external diff3"),
 
925
                     'weave': (WeaveMerger, "Weave-based merge")
 
926
              }
 
927
 
 
928
 
 
929
def merge_type_help():
 
930
    templ = '%s%%7s: %%s' % (' '*12)
 
931
    lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
 
932
    return '\n'.join(lines)