/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: Canonical.com Patch Queue Manager
  • Date: 2006-03-09 21:04:59 UTC
  • mfrom: (1551.2.34 Aaron's small fixes)
  • Revision ID: pqm@pqm.ubuntu.com-20060309210459-a48571e310db5c23
Progress bar shows overall progress

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