/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

Tweaks from merge review

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