/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

  • Committer: Aaron Bentley
  • Date: 2006-04-16 17:49:14 UTC
  • mto: This revision was merged to the branch mainline in revision 1673.
  • Revision ID: aaron.bentley@utoronto.ca-20060416174914-99d5dec4eafbb923
Whitespace fixes

Show diffs side-by-side

added added

removed removed

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