/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: Robert Collins
  • Date: 2006-02-21 11:42:36 UTC
  • mfrom: (1534.1.36 inter-repo-api)
  • mto: This revision was merged to the branch mainline in revision 1560.
  • Revision ID: robertc@robertcollins.net-20060221114236-0deb1948f0c8c956
Merge in InterRepository API support.

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