/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: Aaron Bentley
  • Date: 2006-02-24 19:00:42 UTC
  • mto: (2027.1.2 revert-subpath-56549)
  • mto: This revision was merged to the branch mainline in revision 1595.
  • Revision ID: abentley@panoramicfeedback.com-20060224190042-7131c3fb7b75cc24
Record hashes produced by merges

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