~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

Introduce a api specifically for looking at lines in some versions of the inventory, for fileid_involved.

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