~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

  • Committer: John Arbash Meinel
  • Date: 2006-03-08 14:31:23 UTC
  • mfrom: (1598 +trunk)
  • mto: (1685.1.1 bzr-encoding)
  • mto: This revision was merged to the branch mainline in revision 1752.
  • Revision ID: john@arbash-meinel.com-20060308143123-448308b0db4de410
[merge] bzr.dev 1573, lots of updates

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