/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-02-16 18:52:17 UTC
  • mto: (1558.1.4 Aaron's integration)
  • mto: This revision was merged to the branch mainline in revision 1565.
  • Revision ID: abentley@panoramicfeedback.com-20060216185217-c766d147d91191d8
Added progress bars to merge

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