/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

[merge] Storage filename escaping

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