~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

  • Committer: Alexander Belchenko
  • Date: 2006-07-30 06:52:39 UTC
  • mto: (1711.2.111 jam-integration)
  • mto: This revision was merged to the branch mainline in revision 1906.
  • Revision ID: bialix@ukr.net-20060730065239-03b4ac02d9f56202
branding: change Bazaar-NG to Bazaar

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