/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: Martin Pool
  • Date: 2006-04-19 07:16:05 UTC
  • mto: This revision was merged to the branch mainline in revision 1675.
  • Revision ID: mbp@sourcefrog.net-20060419071605-51207e739c997442
Give a clear error for bzr status of an unversioned, nonexistent file. (Malone #3619)

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