/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-03-09 18:47:40 UTC
  • mto: (2027.1.2 revert-subpath-56549)
  • mto: This revision was merged to the branch mainline in revision 1647.
  • Revision ID: abentley@panoramicfeedback.com-20060309184740-1bbba4a768e7628c
Implemented rio_file to produce a light file object from stanzas

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