/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

  • Committer: Martin Pool
  • Date: 2006-03-16 20:20:32 UTC
  • mto: (1615.1.1 bzr.mbp.integration)
  • mto: This revision was merged to the branch mainline in revision 1616.
  • Revision ID: mbp@sourcefrog.net-20060316202032-d044f29e7d81b333
Update version numbers

Show diffs side-by-side

added added

removed removed

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