/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

(broken) merge aaron's workingtree format changes

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