/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: 2007-02-09 15:56:49 UTC
  • mto: This revision was merged to the branch mainline in revision 2288.
  • Revision ID: abentley@panoramicfeedback.com-20070209155649-qxg6cqptrwyd4xof
Apply change reporting to merge

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