~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-09-19 04:17:47 UTC
  • mfrom: (2018.1.12 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20060919041747-9f0e1130a3a78022
Trivially cleanup BRANCH.TODO

Show diffs side-by-side

added added

removed removed

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