← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

  • Committer: Martin Pool
  • Date: 2009-08-28 05:00:33 UTC
  • mfrom: (4659 +trunk)
  • mto: This revision was merged to the branch mainline in revision 4660.
  • Revision ID: mbp@sourcefrog.net-20090828050033-blwvnig3gdzbr1iw
merge trunk

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/merge.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2008 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
 
 
18
import errno
 
19
from itertools import chain
 
20
import os
17
21
import warnings
18
22
 
19
23
from bzrlib import (
20
 
    branch as _mod_branch,
21
 
    conflicts as _mod_conflicts,
22
24
    debug,
23
 
    decorators,
24
25
    errors,
25
26
    graph as _mod_graph,
26
 
    hooks,
27
 
    merge3,
28
27
    osutils,
29
28
    patiencediff,
 
29
    registry,
30
30
    revision as _mod_revision,
31
 
    textfile,
32
 
    trace,
33
 
    transform,
34
31
    tree as _mod_tree,
35
32
    tsort,
36
 
    ui,
37
 
    versionedfile
38
 
    )
39
 
from bzrlib.cleanup import OperationWithCleanups
40
 
from bzrlib.symbol_versioning import (
41
 
    deprecated_in,
42
 
    deprecated_method,
43
 
    )
 
33
    )
 
34
from bzrlib.branch import Branch
 
35
from bzrlib.conflicts import ConflictList, Conflict
 
36
from bzrlib.errors import (BzrCommandError,
 
37
                           BzrError,
 
38
                           NoCommonAncestor,
 
39
                           NoCommits,
 
40
                           NoSuchRevision,
 
41
                           NoSuchFile,
 
42
                           NotBranchError,
 
43
                           NotVersionedError,
 
44
                           UnrelatedBranches,
 
45
                           UnsupportedOperation,
 
46
                           WorkingTreeNotRevision,
 
47
                           BinaryFile,
 
48
                           )
 
49
from bzrlib.graph import Graph
 
50
from bzrlib.merge3 import Merge3
 
51
from bzrlib.osutils import rename, pathjoin
 
52
from progress import DummyProgress, ProgressPhase
 
53
from bzrlib.revision import (NULL_REVISION, ensure_null)
 
54
from bzrlib.textfile import check_text_lines
 
55
from bzrlib.trace import mutter, warning, note, is_quiet
 
56
from bzrlib.transform import (TransformPreview, TreeTransform,
 
57
                              resolve_conflicts, cook_conflicts,
 
58
                              conflict_pass, FinalPaths, create_from_tree,
 
59
                              unique_add, ROOT_PARENT)
 
60
from bzrlib.versionedfile import PlanWeaveMerge
 
61
from bzrlib import ui
 
62
 
44
63
# TODO: Report back as changes are merged in
45
64
 
46
65
 
47
66
def transform_tree(from_tree, to_tree, interesting_ids=None):
48
67
    from_tree.lock_tree_write()
49
 
    operation = OperationWithCleanups(merge_inner)
50
 
    operation.add_cleanup(from_tree.unlock)
51
 
    operation.run_simple(from_tree.branch, to_tree, from_tree,
52
 
        ignore_zero=True, interesting_ids=interesting_ids, this_tree=from_tree)
53
 
 
54
 
 
55
 
class MergeHooks(hooks.Hooks):
56
 
 
57
 
    def __init__(self):
58
 
        hooks.Hooks.__init__(self)
59
 
        self.create_hook(hooks.HookPoint('merge_file_content',
60
 
            "Called with a bzrlib.merge.Merger object to create a per file "
61
 
            "merge object when starting a merge. "
62
 
            "Should return either None or a subclass of "
63
 
            "``bzrlib.merge.AbstractPerFileMerger``. "
64
 
            "Such objects will then be called per file "
65
 
            "that needs to be merged (including when one "
66
 
            "side has deleted the file and the other has changed it). "
67
 
            "See the AbstractPerFileMerger API docs for details on how it is "
68
 
            "used by merge.",
69
 
            (2, 1), None))
70
 
 
71
 
 
72
 
class AbstractPerFileMerger(object):
73
 
    """PerFileMerger objects are used by plugins extending merge for bzrlib.
74
 
 
75
 
    See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
76
 
    
77
 
    :ivar merger: The Merge3Merger performing the merge.
78
 
    """
79
 
 
80
 
    def __init__(self, merger):
81
 
        """Create a PerFileMerger for use with merger."""
82
 
        self.merger = merger
83
 
 
84
 
    def merge_contents(self, merge_params):
85
 
        """Attempt to merge the contents of a single file.
86
 
        
87
 
        :param merge_params: A bzrlib.merge.MergeHookParams
88
 
        :return : A tuple of (status, chunks), where status is one of
89
 
            'not_applicable', 'success', 'conflicted', or 'delete'.  If status
90
 
            is 'success' or 'conflicted', then chunks should be an iterable of
91
 
            strings for the new file contents.
92
 
        """
93
 
        return ('not applicable', None)
94
 
 
95
 
 
96
 
class PerFileMerger(AbstractPerFileMerger):
97
 
    """Merge individual files when self.file_matches returns True.
98
 
 
99
 
    This class is intended to be subclassed.  The file_matches and
100
 
    merge_matching methods should be overridden with concrete implementations.
101
 
    """
102
 
 
103
 
    def file_matches(self, params):
104
 
        """Return True if merge_matching should be called on this file.
105
 
 
106
 
        Only called with merges of plain files with no clear winner.
107
 
 
108
 
        Subclasses must override this.
109
 
        """
110
 
        raise NotImplementedError(self.file_matches)
111
 
 
112
 
    def get_filename(self, params, tree):
113
 
        """Lookup the filename (i.e. basename, not path), given a Tree (e.g.
114
 
        self.merger.this_tree) and a MergeHookParams.
115
 
        """
116
 
        return osutils.basename(tree.id2path(params.file_id))
117
 
 
118
 
    def get_filepath(self, params, tree):
119
 
        """Calculate the path to the file in a tree.
120
 
 
121
 
        :param params: A MergeHookParams describing the file to merge
122
 
        :param tree: a Tree, e.g. self.merger.this_tree.
123
 
        """
124
 
        return tree.id2path(params.file_id)
125
 
 
126
 
    def merge_contents(self, params):
127
 
        """Merge the contents of a single file."""
128
 
        # Check whether this custom merge logic should be used.
129
 
        if (
130
 
            # OTHER is a straight winner, rely on default merge.
131
 
            params.winner == 'other' or
132
 
            # THIS and OTHER aren't both files.
133
 
            not params.is_file_merge() or
134
 
            # The filename doesn't match *.xml
135
 
            not self.file_matches(params)):
136
 
            return 'not_applicable', None
137
 
        return self.merge_matching(params)
138
 
 
139
 
    def merge_matching(self, params):
140
 
        """Merge the contents of a single file that has matched the criteria
141
 
        in PerFileMerger.merge_contents (is a conflict, is a file,
142
 
        self.file_matches is True).
143
 
 
144
 
        Subclasses must override this.
145
 
        """
146
 
        raise NotImplementedError(self.merge_matching)
147
 
 
148
 
 
149
 
class ConfigurableFileMerger(PerFileMerger):
150
 
    """Merge individual files when configured via a .conf file.
151
 
 
152
 
    This is a base class for concrete custom file merging logic. Concrete
153
 
    classes should implement ``merge_text``.
154
 
 
155
 
    See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
156
 
    
157
 
    :ivar affected_files: The configured file paths to merge.
158
 
 
159
 
    :cvar name_prefix: The prefix to use when looking up configuration
160
 
        details. <name_prefix>_merge_files describes the files targeted by the
161
 
        hook for example.
162
 
        
163
 
    :cvar default_files: The default file paths to merge when no configuration
164
 
        is present.
165
 
    """
166
 
 
167
 
    name_prefix = None
168
 
    default_files = None
169
 
 
170
 
    def __init__(self, merger):
171
 
        super(ConfigurableFileMerger, self).__init__(merger)
172
 
        self.affected_files = None
173
 
        self.default_files = self.__class__.default_files or []
174
 
        self.name_prefix = self.__class__.name_prefix
175
 
        if self.name_prefix is None:
176
 
            raise ValueError("name_prefix must be set.")
177
 
 
178
 
    def file_matches(self, params):
179
 
        """Check whether the file should call the merge hook.
180
 
 
181
 
        <name_prefix>_merge_files configuration variable is a list of files
182
 
        that should use the hook.
183
 
        """
184
 
        affected_files = self.affected_files
185
 
        if affected_files is None:
186
 
            config = self.merger.this_branch.get_config()
187
 
            # Until bzr provides a better policy for caching the config, we
188
 
            # just add the part we're interested in to the params to avoid
189
 
            # reading the config files repeatedly (bazaar.conf, location.conf,
190
 
            # branch.conf).
191
 
            config_key = self.name_prefix + '_merge_files'
192
 
            affected_files = config.get_user_option_as_list(config_key)
193
 
            if affected_files is None:
194
 
                # If nothing was specified in the config, use the default.
195
 
                affected_files = self.default_files
196
 
            self.affected_files = affected_files
197
 
        if affected_files:
198
 
            filepath = self.get_filepath(params, self.merger.this_tree)
199
 
            if filepath in affected_files:
200
 
                return True
201
 
        return False
202
 
 
203
 
    def merge_matching(self, params):
204
 
        return self.merge_text(params)
205
 
 
206
 
    def merge_text(self, params):
207
 
        """Merge the byte contents of a single file.
208
 
 
209
 
        This is called after checking that the merge should be performed in
210
 
        merge_contents, and it should behave as per
211
 
        ``bzrlib.merge.AbstractPerFileMerger.merge_contents``.
212
 
        """
213
 
        raise NotImplementedError(self.merge_text)
214
 
 
215
 
 
216
 
class MergeHookParams(object):
217
 
    """Object holding parameters passed to merge_file_content hooks.
218
 
 
219
 
    There are some fields hooks can access:
220
 
 
221
 
    :ivar file_id: the file ID of the file being merged
222
 
    :ivar trans_id: the transform ID for the merge of this file
223
 
    :ivar this_kind: kind of file_id in 'this' tree
224
 
    :ivar other_kind: kind of file_id in 'other' tree
225
 
    :ivar winner: one of 'this', 'other', 'conflict'
226
 
    """
227
 
 
228
 
    def __init__(self, merger, file_id, trans_id, this_kind, other_kind,
229
 
            winner):
230
 
        self._merger = merger
231
 
        self.file_id = file_id
232
 
        self.trans_id = trans_id
233
 
        self.this_kind = this_kind
234
 
        self.other_kind = other_kind
235
 
        self.winner = winner
236
 
 
237
 
    def is_file_merge(self):
238
 
        """True if this_kind and other_kind are both 'file'."""
239
 
        return self.this_kind == 'file' and self.other_kind == 'file'
240
 
 
241
 
    @decorators.cachedproperty
242
 
    def base_lines(self):
243
 
        """The lines of the 'base' version of the file."""
244
 
        return self._merger.get_lines(self._merger.base_tree, self.file_id)
245
 
 
246
 
    @decorators.cachedproperty
247
 
    def this_lines(self):
248
 
        """The lines of the 'this' version of the file."""
249
 
        return self._merger.get_lines(self._merger.this_tree, self.file_id)
250
 
 
251
 
    @decorators.cachedproperty
252
 
    def other_lines(self):
253
 
        """The lines of the 'other' version of the file."""
254
 
        return self._merger.get_lines(self._merger.other_tree, self.file_id)
 
68
    try:
 
69
        merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
 
70
                    interesting_ids=interesting_ids, this_tree=from_tree)
 
71
    finally:
 
72
        from_tree.unlock()
255
73
 
256
74
 
257
75
class Merger(object):
258
 
 
259
 
    hooks = MergeHooks()
260
 
 
261
76
    def __init__(self, this_branch, other_tree=None, base_tree=None,
262
77
                 this_tree=None, pb=None, change_reporter=None,
263
78
                 recurse='down', revision_graph=None):
278
93
        self.interesting_files = None
279
94
        self.show_base = False
280
95
        self.reprocess = False
281
 
        if pb is not None:
282
 
            warnings.warn("pb parameter to Merger() is deprecated and ignored")
 
96
        if pb is None:
 
97
            pb = DummyProgress()
 
98
        self._pb = pb
283
99
        self.pp = None
284
100
        self.recurse = recurse
285
101
        self.change_reporter = change_reporter
368
184
                base_revision_id, tree.branch.last_revision())):
369
185
                base_revision_id = None
370
186
            else:
371
 
                trace.warning('Performing cherrypick')
 
187
                warning('Performing cherrypick')
372
188
        merger = klass.from_revision_ids(pb, tree, other_revision_id,
373
189
                                         base_revision_id, revision_graph=
374
190
                                         revision_graph)
426
242
        if revno is None:
427
243
            tree = workingtree.WorkingTree.open_containing(location)[0]
428
244
            return tree.branch, tree
429
 
        branch = _mod_branch.Branch.open_containing(
430
 
            location, possible_transports)[0]
 
245
        branch = Branch.open_containing(location, possible_transports)[0]
431
246
        if revno == -1:
432
247
            revision_id = branch.last_revision()
433
248
        else:
434
249
            revision_id = branch.get_rev_id(revno)
435
 
        revision_id = _mod_revision.ensure_null(revision_id)
 
250
        revision_id = ensure_null(revision_id)
436
251
        return branch, self.revision_tree(revision_id, branch)
437
252
 
438
 
    @deprecated_method(deprecated_in((2, 1, 0)))
439
253
    def ensure_revision_trees(self):
440
254
        if self.this_revision_tree is None:
441
255
            self.this_basis_tree = self.revision_tree(self.this_basis)
445
259
        if self.other_rev_id is None:
446
260
            other_basis_tree = self.revision_tree(self.other_basis)
447
261
            if other_basis_tree.has_changes(self.other_tree):
448
 
                raise errors.WorkingTreeNotRevision(self.this_tree)
 
262
                raise WorkingTreeNotRevision(self.this_tree)
449
263
            other_rev_id = self.other_basis
450
264
            self.other_tree = other_basis_tree
451
265
 
452
 
    @deprecated_method(deprecated_in((2, 1, 0)))
453
266
    def file_revisions(self, file_id):
454
267
        self.ensure_revision_trees()
455
268
        def get_id(tree, file_id):
458
271
        if self.this_rev_id is None:
459
272
            if self.this_basis_tree.get_file_sha1(file_id) != \
460
273
                self.this_tree.get_file_sha1(file_id):
461
 
                raise errors.WorkingTreeNotRevision(self.this_tree)
 
274
                raise WorkingTreeNotRevision(self.this_tree)
462
275
 
463
276
        trees = (self.this_basis_tree, self.other_tree)
464
277
        return [get_id(tree, file_id) for tree in trees]
465
278
 
466
 
    @deprecated_method(deprecated_in((2, 1, 0)))
467
279
    def check_basis(self, check_clean, require_commits=True):
468
280
        if self.this_basis is None and require_commits is True:
469
 
            raise errors.BzrCommandError(
470
 
                "This branch has no commits."
471
 
                " (perhaps you would prefer 'bzr pull')")
 
281
            raise BzrCommandError("This branch has no commits."
 
282
                                  " (perhaps you would prefer 'bzr pull')")
472
283
        if check_clean:
473
284
            self.compare_basis()
474
285
            if self.this_basis != self.this_rev_id:
475
286
                raise errors.UncommittedChanges(self.this_tree)
476
287
 
477
 
    @deprecated_method(deprecated_in((2, 1, 0)))
478
288
    def compare_basis(self):
479
289
        try:
480
290
            basis_tree = self.revision_tree(self.this_tree.last_revision())
487
297
        self.interesting_files = file_list
488
298
 
489
299
    def set_pending(self):
490
 
        if (not self.base_is_ancestor or not self.base_is_other_ancestor
491
 
            or self.other_rev_id is None):
 
300
        if not self.base_is_ancestor or not self.base_is_other_ancestor or self.other_rev_id is None:
492
301
            return
493
302
        self._add_parent()
494
303
 
495
304
    def _add_parent(self):
496
305
        new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
497
306
        new_parent_trees = []
498
 
        operation = OperationWithCleanups(self.this_tree.set_parent_trees)
499
307
        for revision_id in new_parents:
500
308
            try:
501
309
                tree = self.revision_tree(revision_id)
503
311
                tree = None
504
312
            else:
505
313
                tree.lock_read()
506
 
                operation.add_cleanup(tree.unlock)
507
314
            new_parent_trees.append((revision_id, tree))
508
 
        operation.run_simple(new_parent_trees, allow_leftmost_as_ghost=True)
 
315
        try:
 
316
            self.this_tree.set_parent_trees(new_parent_trees,
 
317
                                            allow_leftmost_as_ghost=True)
 
318
        finally:
 
319
            for _revision_id, tree in new_parent_trees:
 
320
                if tree is not None:
 
321
                    tree.unlock()
509
322
 
510
323
    def set_other(self, other_revision, possible_transports=None):
511
324
        """Set the revision and tree to merge from.
520
333
            self.other_rev_id = _mod_revision.ensure_null(
521
334
                self.other_branch.last_revision())
522
335
            if _mod_revision.is_null(self.other_rev_id):
523
 
                raise errors.NoCommits(self.other_branch)
 
336
                raise NoCommits(self.other_branch)
524
337
            self.other_basis = self.other_rev_id
525
338
        elif other_revision[1] is not None:
526
339
            self.other_rev_id = self.other_branch.get_rev_id(other_revision[1])
529
342
            self.other_rev_id = None
530
343
            self.other_basis = self.other_branch.last_revision()
531
344
            if self.other_basis is None:
532
 
                raise errors.NoCommits(self.other_branch)
 
345
                raise NoCommits(self.other_branch)
533
346
        if self.other_rev_id is not None:
534
347
            self._cached_trees[self.other_rev_id] = self.other_tree
535
348
        self._maybe_fetch(self.other_branch,self.this_branch, self.other_basis)
562
375
            target.fetch(source, revision_id)
563
376
 
564
377
    def find_base(self):
565
 
        revisions = [_mod_revision.ensure_null(self.this_basis),
566
 
                     _mod_revision.ensure_null(self.other_basis)]
567
 
        if _mod_revision.NULL_REVISION in revisions:
568
 
            self.base_rev_id = _mod_revision.NULL_REVISION
 
378
        revisions = [ensure_null(self.this_basis),
 
379
                     ensure_null(self.other_basis)]
 
380
        if NULL_REVISION in revisions:
 
381
            self.base_rev_id = NULL_REVISION
569
382
            self.base_tree = self.revision_tree(self.base_rev_id)
570
383
            self._is_criss_cross = False
571
384
        else:
572
385
            lcas = self.revision_graph.find_lca(revisions[0], revisions[1])
573
386
            self._is_criss_cross = False
574
387
            if len(lcas) == 0:
575
 
                self.base_rev_id = _mod_revision.NULL_REVISION
 
388
                self.base_rev_id = NULL_REVISION
576
389
            elif len(lcas) == 1:
577
390
                self.base_rev_id = list(lcas)[0]
578
391
            else: # len(lcas) > 1
587
400
                    self.base_rev_id = self.revision_graph.find_unique_lca(
588
401
                                            *lcas)
589
402
                self._is_criss_cross = True
590
 
            if self.base_rev_id == _mod_revision.NULL_REVISION:
591
 
                raise errors.UnrelatedBranches()
 
403
            if self.base_rev_id == NULL_REVISION:
 
404
                raise UnrelatedBranches()
592
405
            if self._is_criss_cross:
593
 
                trace.warning('Warning: criss-cross merge encountered.  See bzr'
594
 
                              ' help criss-cross.')
595
 
                trace.mutter('Criss-cross lcas: %r' % lcas)
 
406
                warning('Warning: criss-cross merge encountered.  See bzr'
 
407
                        ' help criss-cross.')
 
408
                mutter('Criss-cross lcas: %r' % lcas)
596
409
                interesting_revision_ids = [self.base_rev_id]
597
410
                interesting_revision_ids.extend(lcas)
598
411
                interesting_trees = dict((t.get_revision_id(), t)
608
421
                self.base_tree = self.revision_tree(self.base_rev_id)
609
422
        self.base_is_ancestor = True
610
423
        self.base_is_other_ancestor = True
611
 
        trace.mutter('Base revid: %r' % self.base_rev_id)
 
424
        mutter('Base revid: %r' % self.base_rev_id)
612
425
 
613
426
    def set_base(self, base_revision):
614
427
        """Set the base revision to use for the merge.
615
428
 
616
429
        :param base_revision: A 2-list containing a path and revision number.
617
430
        """
618
 
        trace.mutter("doing merge() with no base_revision specified")
 
431
        mutter("doing merge() with no base_revision specified")
619
432
        if base_revision == [None, None]:
620
433
            self.find_base()
621
434
        else:
634
447
                  'other_tree': self.other_tree,
635
448
                  'interesting_ids': self.interesting_ids,
636
449
                  'interesting_files': self.interesting_files,
637
 
                  'this_branch': self.this_branch,
 
450
                  'pp': self.pp,
638
451
                  'do_merge': False}
639
452
        if self.merge_type.requires_base:
640
453
            kwargs['base_tree'] = self.base_tree
641
454
        if self.merge_type.supports_reprocess:
642
455
            kwargs['reprocess'] = self.reprocess
643
456
        elif self.reprocess:
644
 
            raise errors.BzrError(
645
 
                "Conflict reduction is not supported for merge"
646
 
                " type %s." % self.merge_type)
 
457
            raise BzrError("Conflict reduction is not supported for merge"
 
458
                                  " type %s." % self.merge_type)
647
459
        if self.merge_type.supports_show_base:
648
460
            kwargs['show_base'] = self.show_base
649
461
        elif self.show_base:
650
 
            raise errors.BzrError("Showing base is not supported for this"
651
 
                                  " merge type. %s" % self.merge_type)
 
462
            raise BzrError("Showing base is not supported for this"
 
463
                           " merge type. %s" % self.merge_type)
652
464
        if (not getattr(self.merge_type, 'supports_reverse_cherrypick', True)
653
465
            and not self.base_is_other_ancestor):
654
466
            raise errors.CannotReverseCherrypick()
658
470
        if self._is_criss_cross and getattr(self.merge_type,
659
471
                                            'supports_lca_trees', False):
660
472
            kwargs['lca_trees'] = self._lca_trees
661
 
        return self.merge_type(pb=None,
 
473
        return self.merge_type(pb=self._pb,
662
474
                               change_reporter=self.change_reporter,
663
475
                               **kwargs)
664
476
 
665
 
    def _do_merge_to(self):
666
 
        merge = self.make_merger()
 
477
    def _do_merge_to(self, merge):
667
478
        if self.other_branch is not None:
668
479
            self.other_branch.update_references(self.this_branch)
669
480
        merge.do_merge()
683
494
                    sub_tree.branch.repository.revision_tree(base_revision)
684
495
                sub_merge.base_rev_id = base_revision
685
496
                sub_merge.do_merge()
686
 
        return merge
687
497
 
688
498
    def do_merge(self):
689
 
        operation = OperationWithCleanups(self._do_merge_to)
690
499
        self.this_tree.lock_tree_write()
691
 
        operation.add_cleanup(self.this_tree.unlock)
692
 
        if self.base_tree is not None:
693
 
            self.base_tree.lock_read()
694
 
            operation.add_cleanup(self.base_tree.unlock)
695
 
        if self.other_tree is not None:
696
 
            self.other_tree.lock_read()
697
 
            operation.add_cleanup(self.other_tree.unlock)
698
 
        merge = operation.run_simple()
 
500
        try:
 
501
            if self.base_tree is not None:
 
502
                self.base_tree.lock_read()
 
503
            try:
 
504
                if self.other_tree is not None:
 
505
                    self.other_tree.lock_read()
 
506
                try:
 
507
                    merge = self.make_merger()
 
508
                    self._do_merge_to(merge)
 
509
                finally:
 
510
                    if self.other_tree is not None:
 
511
                        self.other_tree.unlock()
 
512
            finally:
 
513
                if self.base_tree is not None:
 
514
                    self.base_tree.unlock()
 
515
        finally:
 
516
            self.this_tree.unlock()
699
517
        if len(merge.cooked_conflicts) == 0:
700
 
            if not self.ignore_zero and not trace.is_quiet():
701
 
                trace.note("All changes applied successfully.")
 
518
            if not self.ignore_zero and not is_quiet():
 
519
                note("All changes applied successfully.")
702
520
        else:
703
 
            trace.note("%d conflicts encountered."
704
 
                       % len(merge.cooked_conflicts))
 
521
            note("%d conflicts encountered." % len(merge.cooked_conflicts))
705
522
 
706
523
        return len(merge.cooked_conflicts)
707
524
 
736
553
 
737
554
    def __init__(self, working_tree, this_tree, base_tree, other_tree,
738
555
                 interesting_ids=None, reprocess=False, show_base=False,
739
 
                 pb=None, pp=None, change_reporter=None,
 
556
                 pb=DummyProgress(), pp=None, change_reporter=None,
740
557
                 interesting_files=None, do_merge=True,
741
 
                 cherrypick=False, lca_trees=None, this_branch=None):
 
558
                 cherrypick=False, lca_trees=None):
742
559
        """Initialize the merger object and perform the merge.
743
560
 
744
561
        :param working_tree: The working tree to apply the merge to
745
562
        :param this_tree: The local tree in the merge operation
746
563
        :param base_tree: The common tree in the merge operation
747
564
        :param other_tree: The other tree to merge changes from
748
 
        :param this_branch: The branch associated with this_tree.  Defaults to
749
 
            this_tree.branch if not supplied.
750
565
        :param interesting_ids: The file_ids of files that should be
751
566
            participate in the merge.  May not be combined with
752
567
            interesting_files.
753
568
        :param: reprocess If True, perform conflict-reduction processing.
754
569
        :param show_base: If True, show the base revision in text conflicts.
755
570
            (incompatible with reprocess)
756
 
        :param pb: ignored
 
571
        :param pb: A Progress bar
757
572
        :param pp: A ProgressPhase object
758
573
        :param change_reporter: An object that should report changes made
759
574
        :param interesting_files: The tree-relative paths of files that should
770
585
        if interesting_files is not None and interesting_ids is not None:
771
586
            raise ValueError(
772
587
                'specify either interesting_ids or interesting_files')
773
 
        if this_branch is None:
774
 
            this_branch = this_tree.branch
775
588
        self.interesting_ids = interesting_ids
776
589
        self.interesting_files = interesting_files
777
590
        self.this_tree = working_tree
778
591
        self.base_tree = base_tree
779
592
        self.other_tree = other_tree
780
 
        self.this_branch = this_branch
781
593
        self._raw_conflicts = []
782
594
        self.cooked_conflicts = []
783
595
        self.reprocess = reprocess
788
600
        # making sure we haven't missed any corner cases.
789
601
        # if lca_trees is None:
790
602
        #     self._lca_trees = [self.base_tree]
 
603
        self.pb = pb
 
604
        self.pp = pp
791
605
        self.change_reporter = change_reporter
792
606
        self.cherrypick = cherrypick
 
607
        if self.pp is None:
 
608
            self.pp = ProgressPhase("Merge phase", 3, self.pb)
793
609
        if do_merge:
794
610
            self.do_merge()
795
 
        if pp is not None:
796
 
            warnings.warn("pp argument to Merge3Merger is deprecated")
797
 
        if pb is not None:
798
 
            warnings.warn("pb argument to Merge3Merger is deprecated")
799
611
 
800
612
    def do_merge(self):
801
 
        operation = OperationWithCleanups(self._do_merge)
802
613
        self.this_tree.lock_tree_write()
803
 
        operation.add_cleanup(self.this_tree.unlock)
804
614
        self.base_tree.lock_read()
805
 
        operation.add_cleanup(self.base_tree.unlock)
806
615
        self.other_tree.lock_read()
807
 
        operation.add_cleanup(self.other_tree.unlock)
808
 
        operation.run()
809
 
 
810
 
    def _do_merge(self, operation):
811
 
        self.tt = transform.TreeTransform(self.this_tree, None)
812
 
        operation.add_cleanup(self.tt.finalize)
813
 
        self._compute_transform()
814
 
        results = self.tt.apply(no_conflicts=True)
815
 
        self.write_modified(results)
 
616
        self.tt = TreeTransform(self.this_tree, self.pb)
816
617
        try:
817
 
            self.this_tree.add_conflicts(self.cooked_conflicts)
818
 
        except errors.UnsupportedOperation:
819
 
            pass
 
618
            self.pp.next_phase()
 
619
            self._compute_transform()
 
620
            self.pp.next_phase()
 
621
            results = self.tt.apply(no_conflicts=True)
 
622
            self.write_modified(results)
 
623
            try:
 
624
                self.this_tree.add_conflicts(self.cooked_conflicts)
 
625
            except UnsupportedOperation:
 
626
                pass
 
627
        finally:
 
628
            self.tt.finalize()
 
629
            self.other_tree.unlock()
 
630
            self.base_tree.unlock()
 
631
            self.this_tree.unlock()
 
632
            self.pb.clear()
820
633
 
821
634
    def make_preview_transform(self):
822
 
        operation = OperationWithCleanups(self._make_preview_transform)
823
635
        self.base_tree.lock_read()
824
 
        operation.add_cleanup(self.base_tree.unlock)
825
636
        self.other_tree.lock_read()
826
 
        operation.add_cleanup(self.other_tree.unlock)
827
 
        return operation.run_simple()
828
 
 
829
 
    def _make_preview_transform(self):
830
 
        self.tt = transform.TransformPreview(self.this_tree)
831
 
        self._compute_transform()
 
637
        self.tt = TransformPreview(self.this_tree)
 
638
        try:
 
639
            self.pp.next_phase()
 
640
            self._compute_transform()
 
641
            self.pp.next_phase()
 
642
        finally:
 
643
            self.other_tree.unlock()
 
644
            self.base_tree.unlock()
 
645
            self.pb.clear()
832
646
        return self.tt
833
647
 
834
648
    def _compute_transform(self):
840
654
            resolver = self._lca_multi_way
841
655
        child_pb = ui.ui_factory.nested_progress_bar()
842
656
        try:
843
 
            factories = Merger.hooks['merge_file_content']
844
 
            hooks = [factory(self) for factory in factories] + [self]
845
 
            self.active_hooks = [hook for hook in hooks if hook is not None]
846
657
            for num, (file_id, changed, parents3, names3,
847
658
                      executable3) in enumerate(entries):
848
659
                child_pb.update('Preparing file merge', num, len(entries))
849
660
                self._merge_names(file_id, parents3, names3, resolver=resolver)
850
661
                if changed:
851
 
                    file_status = self._do_merge_contents(file_id)
 
662
                    file_status = self.merge_contents(file_id)
852
663
                else:
853
664
                    file_status = 'unmodified'
854
665
                self._merge_executable(file_id,
856
667
        finally:
857
668
            child_pb.finished()
858
669
        self.fix_root()
 
670
        self.pp.next_phase()
859
671
        child_pb = ui.ui_factory.nested_progress_bar()
860
672
        try:
861
 
            fs_conflicts = transform.resolve_conflicts(self.tt, child_pb,
862
 
                lambda t, c: transform.conflict_pass(t, c, self.other_tree))
 
673
            fs_conflicts = resolve_conflicts(self.tt, child_pb,
 
674
                lambda t, c: conflict_pass(t, c, self.other_tree))
863
675
        finally:
864
676
            child_pb.finished()
865
677
        if self.change_reporter is not None:
868
680
                self.tt.iter_changes(), self.change_reporter)
869
681
        self.cook_conflicts(fs_conflicts)
870
682
        for conflict in self.cooked_conflicts:
871
 
            trace.warning(conflict)
 
683
            warning(conflict)
872
684
 
873
685
    def _entries3(self):
874
686
        """Gather data about files modified between three trees.
1059
871
                        continue
1060
872
                else:
1061
873
                    raise AssertionError('unhandled kind: %s' % other_ie.kind)
 
874
                # XXX: We need to handle kind == 'symlink'
1062
875
 
1063
876
            # If we have gotten this far, that means something has changed
1064
877
            result.append((file_id, content_changed,
1075
888
    def fix_root(self):
1076
889
        try:
1077
890
            self.tt.final_kind(self.tt.root)
1078
 
        except errors.NoSuchFile:
 
891
        except NoSuchFile:
1079
892
            self.tt.cancel_deletion(self.tt.root)
1080
893
        if self.tt.final_file_id(self.tt.root) is None:
1081
894
            self.tt.version_file(self.tt.tree_file_id(self.tt.root),
1086
899
        other_root = self.tt.trans_id_file_id(other_root_file_id)
1087
900
        if other_root == self.tt.root:
1088
901
            return
 
902
        try:
 
903
            self.tt.final_kind(other_root)
 
904
        except NoSuchFile:
 
905
            return
1089
906
        if self.other_tree.inventory.root.file_id in self.this_tree.inventory:
1090
 
            # the other tree's root is a non-root in the current tree (as when
1091
 
            # a previously unrelated branch is merged into another)
 
907
            # the other tree's root is a non-root in the current tree
1092
908
            return
1093
 
        try:
1094
 
            self.tt.final_kind(other_root)
1095
 
            other_root_is_present = True
1096
 
        except errors.NoSuchFile:
1097
 
            # other_root doesn't have a physical representation. We still need
1098
 
            # to move any references to the actual root of the tree.
1099
 
            other_root_is_present = False
1100
 
        # 'other_tree.inventory.root' is not present in this tree. We are
1101
 
        # calling adjust_path for children which *want* to be present with a
1102
 
        # correct place to go.
1103
 
        for thing, child in self.other_tree.inventory.root.children.iteritems():
 
909
        self.reparent_children(self.other_tree.inventory.root, self.tt.root)
 
910
        self.tt.cancel_creation(other_root)
 
911
        self.tt.cancel_versioning(other_root)
 
912
 
 
913
    def reparent_children(self, ie, target):
 
914
        for thing, child in ie.children.iteritems():
1104
915
            trans_id = self.tt.trans_id_file_id(child.file_id)
1105
 
            if not other_root_is_present:
1106
 
                # FIXME: Make final_kind returns None instead of raising
1107
 
                # NoSuchFile to avoid the ugly construct below -- vila 20100402
1108
 
                try:
1109
 
                    self.tt.final_kind(trans_id)
1110
 
                    # The item exist in the final tree and has a defined place
1111
 
                    # to go already.
1112
 
                    continue
1113
 
                except errors.NoSuchFile, e:
1114
 
                    pass
1115
 
            # Move the item into the root
1116
 
            self.tt.adjust_path(self.tt.final_name(trans_id),
1117
 
                                self.tt.root, trans_id)
1118
 
        if other_root_is_present:
1119
 
            self.tt.cancel_creation(other_root)
1120
 
            self.tt.cancel_versioning(other_root)
 
916
            self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
1121
917
 
1122
918
    def write_modified(self, results):
1123
919
        modified_hashes = {}
1155
951
    @staticmethod
1156
952
    def executable(tree, file_id):
1157
953
        """Determine the executability of a file-id (used as a key method)."""
1158
 
        if not tree.has_id(file_id):
 
954
        if file_id not in tree:
1159
955
            return None
1160
956
        if tree.kind(file_id) != "file":
1161
957
            return False
1164
960
    @staticmethod
1165
961
    def kind(tree, file_id):
1166
962
        """Determine the kind of a file-id (used as a key method)."""
1167
 
        if not tree.has_id(file_id):
 
963
        if file_id not in tree:
1168
964
            return None
1169
965
        return tree.kind(file_id)
1170
966
 
1171
967
    @staticmethod
1172
968
    def _three_way(base, other, this):
 
969
        #if base == other, either they all agree, or only THIS has changed.
1173
970
        if base == other:
1174
 
            # if 'base == other', either they all agree, or only 'this' has
1175
 
            # changed.
1176
971
            return 'this'
1177
972
        elif this not in (base, other):
1178
 
            # 'this' is neither 'base' nor 'other', so both sides changed
1179
973
            return 'conflict'
 
974
        # "Ambiguous clean merge" -- both sides have made the same change.
1180
975
        elif this == other:
1181
 
            # "Ambiguous clean merge" -- both sides have made the same change.
1182
976
            return "this"
 
977
        # this == base: only other has changed.
1183
978
        else:
1184
 
            # this == base: only other has changed.
1185
979
            return "other"
1186
980
 
1187
981
    @staticmethod
1231
1025
                # only has an lca value
1232
1026
                return 'other'
1233
1027
 
1234
 
        # At this point, the lcas disagree, and the tip disagree
 
1028
        # At this point, the lcas disagree, and the tips disagree
1235
1029
        return 'conflict'
1236
1030
 
1237
1031
    @staticmethod
1238
 
    @deprecated_method(deprecated_in((2, 2, 0)))
1239
1032
    def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
1240
1033
        """Do a three-way test on a scalar.
1241
1034
        Return "this", "other" or "conflict", depending whether a value wins.
1256
1049
 
1257
1050
    def merge_names(self, file_id):
1258
1051
        def get_entry(tree):
1259
 
            if tree.has_id(file_id):
 
1052
            if file_id in tree.inventory:
1260
1053
                return tree.inventory[file_id]
1261
1054
            else:
1262
1055
                return None
1291
1084
                parent_id_winner = "other"
1292
1085
        if name_winner == "this" and parent_id_winner == "this":
1293
1086
            return
1294
 
        if name_winner == 'conflict' or parent_id_winner == 'conflict':
1295
 
            # Creating helpers (.OTHER or .THIS) here cause problems down the
1296
 
            # road if a ContentConflict needs to be created so we should not do
1297
 
            # that
1298
 
            trans_id = self.tt.trans_id_file_id(file_id)
1299
 
            self._raw_conflicts.append(('path conflict', trans_id, file_id,
1300
 
                                        this_parent, this_name,
1301
 
                                        other_parent, other_name))
 
1087
        if name_winner == "conflict":
 
1088
            trans_id = self.tt.trans_id_file_id(file_id)
 
1089
            self._raw_conflicts.append(('name conflict', trans_id,
 
1090
                                        this_name, other_name))
 
1091
        if parent_id_winner == "conflict":
 
1092
            trans_id = self.tt.trans_id_file_id(file_id)
 
1093
            self._raw_conflicts.append(('parent conflict', trans_id,
 
1094
                                        this_parent, other_parent))
1302
1095
        if other_name is None:
1303
1096
            # it doesn't matter whether the result was 'other' or
1304
1097
            # 'conflict'-- if there's no 'other', we leave it alone.
1305
1098
            return
 
1099
        # if we get here, name_winner and parent_winner are set to safe values.
 
1100
        trans_id = self.tt.trans_id_file_id(file_id)
1306
1101
        parent_id = parents[self.winner_idx[parent_id_winner]]
1307
1102
        if parent_id is not None:
1308
 
            # if we get here, name_winner and parent_winner are set to safe
1309
 
            # values.
 
1103
            parent_trans_id = self.tt.trans_id_file_id(parent_id)
1310
1104
            self.tt.adjust_path(names[self.winner_idx[name_winner]],
1311
 
                                self.tt.trans_id_file_id(parent_id),
1312
 
                                self.tt.trans_id_file_id(file_id))
 
1105
                                parent_trans_id, trans_id)
1313
1106
 
1314
 
    def _do_merge_contents(self, file_id):
 
1107
    def merge_contents(self, file_id):
1315
1108
        """Performs a merge on file_id contents."""
1316
1109
        def contents_pair(tree):
1317
1110
            if file_id not in tree:
1325
1118
                contents = None
1326
1119
            return kind, contents
1327
1120
 
 
1121
        def contents_conflict():
 
1122
            trans_id = self.tt.trans_id_file_id(file_id)
 
1123
            name = self.tt.final_name(trans_id)
 
1124
            parent_id = self.tt.final_parent(trans_id)
 
1125
            if file_id in self.this_tree.inventory:
 
1126
                self.tt.unversion_file(trans_id)
 
1127
                if file_id in self.this_tree:
 
1128
                    self.tt.delete_contents(trans_id)
 
1129
            file_group = self._dump_conflicts(name, parent_id, file_id,
 
1130
                                              set_version=True)
 
1131
            self._raw_conflicts.append(('contents conflict', file_group))
 
1132
 
1328
1133
        # See SPOT run.  run, SPOT, run.
1329
1134
        # So we're not QUITE repeating ourselves; we do tricky things with
1330
1135
        # file kind...
1346
1151
        if winner == 'this':
1347
1152
            # No interesting changes introduced by OTHER
1348
1153
            return "unmodified"
1349
 
        # We have a hypothetical conflict, but if we have files, then we
1350
 
        # can try to merge the content
1351
1154
        trans_id = self.tt.trans_id_file_id(file_id)
1352
 
        params = MergeHookParams(self, file_id, trans_id, this_pair[0],
1353
 
            other_pair[0], winner)
1354
 
        hooks = self.active_hooks
1355
 
        hook_status = 'not_applicable'
1356
 
        for hook in hooks:
1357
 
            hook_status, lines = hook.merge_contents(params)
1358
 
            if hook_status != 'not_applicable':
1359
 
                # Don't try any more hooks, this one applies.
1360
 
                break
1361
 
        result = "modified"
1362
 
        if hook_status == 'not_applicable':
1363
 
            # This is a contents conflict, because none of the available
1364
 
            # functions could merge it.
1365
 
            result = None
1366
 
            name = self.tt.final_name(trans_id)
1367
 
            parent_id = self.tt.final_parent(trans_id)
1368
 
            if self.this_tree.has_id(file_id):
1369
 
                self.tt.unversion_file(trans_id)
1370
 
            file_group = self._dump_conflicts(name, parent_id, file_id,
1371
 
                                              set_version=True)
1372
 
            self._raw_conflicts.append(('contents conflict', file_group))
1373
 
        elif hook_status == 'success':
1374
 
            self.tt.create_file(lines, trans_id)
1375
 
        elif hook_status == 'conflicted':
1376
 
            # XXX: perhaps the hook should be able to provide
1377
 
            # the BASE/THIS/OTHER files?
1378
 
            self.tt.create_file(lines, trans_id)
1379
 
            self._raw_conflicts.append(('text conflict', trans_id))
1380
 
            name = self.tt.final_name(trans_id)
1381
 
            parent_id = self.tt.final_parent(trans_id)
1382
 
            self._dump_conflicts(name, parent_id, file_id)
1383
 
        elif hook_status == 'delete':
1384
 
            self.tt.unversion_file(trans_id)
1385
 
            result = "deleted"
1386
 
        elif hook_status == 'done':
1387
 
            # The hook function did whatever it needs to do directly, no
1388
 
            # further action needed here.
1389
 
            pass
1390
 
        else:
1391
 
            raise AssertionError('unknown hook_status: %r' % (hook_status,))
1392
 
        if not self.this_tree.has_id(file_id) and result == "modified":
1393
 
            self.tt.version_file(file_id, trans_id)
1394
 
        # The merge has been performed, so the old contents should not be
1395
 
        # retained.
1396
 
        try:
1397
 
            self.tt.delete_contents(trans_id)
1398
 
        except errors.NoSuchFile:
1399
 
            pass
1400
 
        return result
1401
 
 
1402
 
    def _default_other_winner_merge(self, merge_hook_params):
1403
 
        """Replace this contents with other."""
1404
 
        file_id = merge_hook_params.file_id
1405
 
        trans_id = merge_hook_params.trans_id
1406
 
        file_in_this = self.this_tree.has_id(file_id)
1407
 
        if self.other_tree.has_id(file_id):
1408
 
            # OTHER changed the file
1409
 
            wt = self.this_tree
1410
 
            if wt.supports_content_filtering():
1411
 
                # We get the path from the working tree if it exists.
1412
 
                # That fails though when OTHER is adding a file, so
1413
 
                # we fall back to the other tree to find the path if
1414
 
                # it doesn't exist locally.
1415
 
                try:
1416
 
                    filter_tree_path = wt.id2path(file_id)
1417
 
                except errors.NoSuchId:
1418
 
                    filter_tree_path = self.other_tree.id2path(file_id)
1419
 
            else:
1420
 
                # Skip the id2path lookup for older formats
1421
 
                filter_tree_path = None
1422
 
            transform.create_from_tree(self.tt, trans_id,
1423
 
                             self.other_tree, file_id,
1424
 
                             filter_tree_path=filter_tree_path)
1425
 
            return 'done', None
1426
 
        elif file_in_this:
1427
 
            # OTHER deleted the file
1428
 
            return 'delete', None
1429
 
        else:
1430
 
            raise AssertionError(
1431
 
                'winner is OTHER, but file_id %r not in THIS or OTHER tree'
1432
 
                % (file_id,))
1433
 
 
1434
 
    def merge_contents(self, merge_hook_params):
1435
 
        """Fallback merge logic after user installed hooks."""
1436
 
        # This function is used in merge hooks as the fallback instance.
1437
 
        # Perhaps making this function and the functions it calls be a 
1438
 
        # a separate class would be better.
1439
 
        if merge_hook_params.winner == 'other':
 
1155
        if winner == 'other':
1440
1156
            # OTHER is a straight winner, so replace this contents with other
1441
 
            return self._default_other_winner_merge(merge_hook_params)
1442
 
        elif merge_hook_params.is_file_merge():
1443
 
            # THIS and OTHER are both files, so text merge.  Either
1444
 
            # BASE is a file, or both converted to files, so at least we
1445
 
            # have agreement that output should be a file.
1446
 
            try:
1447
 
                self.text_merge(merge_hook_params.file_id,
1448
 
                    merge_hook_params.trans_id)
1449
 
            except errors.BinaryFile:
1450
 
                return 'not_applicable', None
1451
 
            return 'done', None
 
1157
            file_in_this = file_id in self.this_tree
 
1158
            if file_in_this:
 
1159
                # Remove any existing contents
 
1160
                self.tt.delete_contents(trans_id)
 
1161
            if file_id in self.other_tree:
 
1162
                # OTHER changed the file
 
1163
                create_from_tree(self.tt, trans_id,
 
1164
                                 self.other_tree, file_id)
 
1165
                if not file_in_this:
 
1166
                    self.tt.version_file(file_id, trans_id)
 
1167
                return "modified"
 
1168
            elif file_in_this:
 
1169
                # OTHER deleted the file
 
1170
                self.tt.unversion_file(trans_id)
 
1171
                return "deleted"
1452
1172
        else:
1453
 
            return 'not_applicable', None
 
1173
            # We have a hypothetical conflict, but if we have files, then we
 
1174
            # can try to merge the content
 
1175
            if this_pair[0] == 'file' and other_pair[0] == 'file':
 
1176
                # THIS and OTHER are both files, so text merge.  Either
 
1177
                # BASE is a file, or both converted to files, so at least we
 
1178
                # have agreement that output should be a file.
 
1179
                try:
 
1180
                    self.text_merge(file_id, trans_id)
 
1181
                except BinaryFile:
 
1182
                    return contents_conflict()
 
1183
                if file_id not in self.this_tree:
 
1184
                    self.tt.version_file(file_id, trans_id)
 
1185
                try:
 
1186
                    self.tt.tree_kind(trans_id)
 
1187
                    self.tt.delete_contents(trans_id)
 
1188
                except NoSuchFile:
 
1189
                    pass
 
1190
                return "modified"
 
1191
            else:
 
1192
                return contents_conflict()
1454
1193
 
1455
1194
    def get_lines(self, tree, file_id):
1456
1195
        """Return the lines in a file, or an empty list."""
1457
 
        if tree.has_id(file_id):
 
1196
        if file_id in tree:
1458
1197
            return tree.get_file(file_id).readlines()
1459
1198
        else:
1460
1199
            return []
1463
1202
        """Perform a three-way text merge on a file_id"""
1464
1203
        # it's possible that we got here with base as a different type.
1465
1204
        # if so, we just want two-way text conflicts.
1466
 
        if self.base_tree.has_id(file_id) and \
 
1205
        if file_id in self.base_tree and \
1467
1206
            self.base_tree.kind(file_id) == "file":
1468
1207
            base_lines = self.get_lines(self.base_tree, file_id)
1469
1208
        else:
1470
1209
            base_lines = []
1471
1210
        other_lines = self.get_lines(self.other_tree, file_id)
1472
1211
        this_lines = self.get_lines(self.this_tree, file_id)
1473
 
        m3 = merge3.Merge3(base_lines, this_lines, other_lines,
1474
 
                           is_cherrypick=self.cherrypick)
 
1212
        m3 = Merge3(base_lines, this_lines, other_lines,
 
1213
                    is_cherrypick=self.cherrypick)
1475
1214
        start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
1476
1215
        if self.show_base is True:
1477
1216
            base_marker = '|' * 7
1515
1254
                ('THIS', self.this_tree, this_lines)]
1516
1255
        if not no_base:
1517
1256
            data.append(('BASE', self.base_tree, base_lines))
1518
 
 
1519
 
        # We need to use the actual path in the working tree of the file here,
1520
 
        # ignoring the conflict suffixes
1521
 
        wt = self.this_tree
1522
 
        if wt.supports_content_filtering():
1523
 
            try:
1524
 
                filter_tree_path = wt.id2path(file_id)
1525
 
            except errors.NoSuchId:
1526
 
                # file has been deleted
1527
 
                filter_tree_path = None
1528
 
        else:
1529
 
            # Skip the id2path lookup for older formats
1530
 
            filter_tree_path = None
1531
 
 
1532
1257
        versioned = False
1533
1258
        file_group = []
1534
1259
        for suffix, tree, lines in data:
1535
 
            if tree.has_id(file_id):
 
1260
            if file_id in tree:
1536
1261
                trans_id = self._conflict_file(name, parent_id, tree, file_id,
1537
 
                                               suffix, lines, filter_tree_path)
 
1262
                                               suffix, lines)
1538
1263
                file_group.append(trans_id)
1539
1264
                if set_version and not versioned:
1540
1265
                    self.tt.version_file(file_id, trans_id)
1542
1267
        return file_group
1543
1268
 
1544
1269
    def _conflict_file(self, name, parent_id, tree, file_id, suffix,
1545
 
                       lines=None, filter_tree_path=None):
 
1270
                       lines=None):
1546
1271
        """Emit a single conflict file."""
1547
1272
        name = name + '.' + suffix
1548
1273
        trans_id = self.tt.create_path(name, parent_id)
1549
 
        transform.create_from_tree(self.tt, trans_id, tree, file_id, lines,
1550
 
            filter_tree_path)
 
1274
        create_from_tree(self.tt, trans_id, tree, file_id, lines)
1551
1275
        return trans_id
1552
1276
 
1553
1277
    def merge_executable(self, file_id, file_status):
1577
1301
        try:
1578
1302
            if self.tt.final_kind(trans_id) != "file":
1579
1303
                return
1580
 
        except errors.NoSuchFile:
 
1304
        except NoSuchFile:
1581
1305
            return
1582
1306
        if winner == "this":
1583
1307
            executability = this_executable
1584
1308
        else:
1585
 
            if self.other_tree.has_id(file_id):
 
1309
            if file_id in self.other_tree:
1586
1310
                executability = other_executable
1587
 
            elif self.this_tree.has_id(file_id):
 
1311
            elif file_id in self.this_tree:
1588
1312
                executability = this_executable
1589
 
            elif self.base_tree_has_id(file_id):
 
1313
            elif file_id in self.base_tree:
1590
1314
                executability = base_executable
1591
1315
        if executability is not None:
1592
1316
            trans_id = self.tt.trans_id_file_id(file_id)
1594
1318
 
1595
1319
    def cook_conflicts(self, fs_conflicts):
1596
1320
        """Convert all conflicts into a form that doesn't depend on trans_id"""
1597
 
        self.cooked_conflicts.extend(transform.cook_conflicts(
1598
 
                fs_conflicts, self.tt))
1599
 
        fp = transform.FinalPaths(self.tt)
 
1321
        from conflicts import Conflict
 
1322
        name_conflicts = {}
 
1323
        self.cooked_conflicts.extend(cook_conflicts(fs_conflicts, self.tt))
 
1324
        fp = FinalPaths(self.tt)
1600
1325
        for conflict in self._raw_conflicts:
1601
1326
            conflict_type = conflict[0]
1602
 
            if conflict_type == 'path conflict':
1603
 
                (trans_id, file_id,
1604
 
                this_parent, this_name,
1605
 
                other_parent, other_name) = conflict[1:]
1606
 
                if this_parent is None or this_name is None:
1607
 
                    this_path = '<deleted>'
1608
 
                else:
1609
 
                    parent_path =  fp.get_path(
1610
 
                        self.tt.trans_id_file_id(this_parent))
1611
 
                    this_path = osutils.pathjoin(parent_path, this_name)
1612
 
                if other_parent is None or other_name is None:
1613
 
                    other_path = '<deleted>'
1614
 
                else:
1615
 
                    parent_path =  fp.get_path(
1616
 
                        self.tt.trans_id_file_id(other_parent))
1617
 
                    other_path = osutils.pathjoin(parent_path, other_name)
1618
 
                c = _mod_conflicts.Conflict.factory(
1619
 
                    'path conflict', path=this_path,
1620
 
                    conflict_path=other_path,
1621
 
                    file_id=file_id)
1622
 
            elif conflict_type == 'contents conflict':
 
1327
            if conflict_type in ('name conflict', 'parent conflict'):
 
1328
                trans_id = conflict[1]
 
1329
                conflict_args = conflict[2:]
 
1330
                if trans_id not in name_conflicts:
 
1331
                    name_conflicts[trans_id] = {}
 
1332
                unique_add(name_conflicts[trans_id], conflict_type,
 
1333
                           conflict_args)
 
1334
            if conflict_type == 'contents conflict':
1623
1335
                for trans_id in conflict[1]:
1624
1336
                    file_id = self.tt.final_file_id(trans_id)
1625
1337
                    if file_id is not None:
1629
1341
                    if path.endswith(suffix):
1630
1342
                        path = path[:-len(suffix)]
1631
1343
                        break
1632
 
                c = _mod_conflicts.Conflict.factory(conflict_type,
1633
 
                                                    path=path, file_id=file_id)
1634
 
            elif conflict_type == 'text conflict':
 
1344
                c = Conflict.factory(conflict_type, path=path, file_id=file_id)
 
1345
                self.cooked_conflicts.append(c)
 
1346
            if conflict_type == 'text conflict':
1635
1347
                trans_id = conflict[1]
1636
1348
                path = fp.get_path(trans_id)
1637
1349
                file_id = self.tt.final_file_id(trans_id)
1638
 
                c = _mod_conflicts.Conflict.factory(conflict_type,
1639
 
                                                    path=path, file_id=file_id)
 
1350
                c = Conflict.factory(conflict_type, path=path, file_id=file_id)
 
1351
                self.cooked_conflicts.append(c)
 
1352
 
 
1353
        for trans_id, conflicts in name_conflicts.iteritems():
 
1354
            try:
 
1355
                this_parent, other_parent = conflicts['parent conflict']
 
1356
                if this_parent == other_parent:
 
1357
                    raise AssertionError()
 
1358
            except KeyError:
 
1359
                this_parent = other_parent = \
 
1360
                    self.tt.final_file_id(self.tt.final_parent(trans_id))
 
1361
            try:
 
1362
                this_name, other_name = conflicts['name conflict']
 
1363
                if this_name == other_name:
 
1364
                    raise AssertionError()
 
1365
            except KeyError:
 
1366
                this_name = other_name = self.tt.final_name(trans_id)
 
1367
            other_path = fp.get_path(trans_id)
 
1368
            if this_parent is not None and this_name is not None:
 
1369
                this_parent_path = \
 
1370
                    fp.get_path(self.tt.trans_id_file_id(this_parent))
 
1371
                this_path = pathjoin(this_parent_path, this_name)
1640
1372
            else:
1641
 
                raise AssertionError('bad conflict type: %r' % (conflict,))
 
1373
                this_path = "<deleted>"
 
1374
            file_id = self.tt.final_file_id(trans_id)
 
1375
            c = Conflict.factory('path conflict', path=this_path,
 
1376
                                 conflict_path=other_path, file_id=file_id)
1642
1377
            self.cooked_conflicts.append(c)
1643
 
        self.cooked_conflicts.sort(key=_mod_conflicts.Conflict.sort_key)
 
1378
        self.cooked_conflicts.sort(key=Conflict.sort_key)
1644
1379
 
1645
1380
 
1646
1381
class WeaveMerger(Merge3Merger):
1650
1385
    supports_reverse_cherrypick = False
1651
1386
    history_based = True
1652
1387
 
1653
 
    def _generate_merge_plan(self, file_id, base):
1654
 
        return self.this_tree.plan_file_merge(file_id, self.other_tree,
 
1388
    def _merged_lines(self, file_id):
 
1389
        """Generate the merged lines.
 
1390
        There is no distinction between lines that are meant to contain <<<<<<<
 
1391
        and conflicts.
 
1392
        """
 
1393
        if self.cherrypick:
 
1394
            base = self.base_tree
 
1395
        else:
 
1396
            base = None
 
1397
        plan = self.this_tree.plan_file_merge(file_id, self.other_tree,
1655
1398
                                              base=base)
1656
 
 
1657
 
    def _merged_lines(self, file_id):
1658
 
        """Generate the merged lines.
1659
 
        There is no distinction between lines that are meant to contain <<<<<<<
1660
 
        and conflicts.
1661
 
        """
1662
 
        if self.cherrypick:
1663
 
            base = self.base_tree
1664
 
        else:
1665
 
            base = None
1666
 
        plan = self._generate_merge_plan(file_id, base)
1667
1399
        if 'merge' in debug.debug_flags:
1668
1400
            plan = list(plan)
1669
1401
            trans_id = self.tt.trans_id_file_id(file_id)
1670
1402
            name = self.tt.final_name(trans_id) + '.plan'
1671
 
            contents = ('%11s|%s' % l for l in plan)
 
1403
            contents = ('%10s|%s' % l for l in plan)
1672
1404
            self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
1673
 
        textmerge = versionedfile.PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1674
 
                                                 '>>>>>>> MERGE-SOURCE\n')
1675
 
        lines, conflicts = textmerge.merge_lines(self.reprocess)
1676
 
        if conflicts:
1677
 
            base_lines = textmerge.base_from_plan()
1678
 
        else:
1679
 
            base_lines = None
1680
 
        return lines, base_lines
 
1405
        textmerge = PlanWeaveMerge(plan, '<<<<<<< TREE\n',
 
1406
            '>>>>>>> MERGE-SOURCE\n')
 
1407
        return textmerge.merge_lines(self.reprocess)
1681
1408
 
1682
1409
    def text_merge(self, file_id, trans_id):
1683
1410
        """Perform a (weave) text merge for a given file and file-id.
1684
1411
        If conflicts are encountered, .THIS and .OTHER files will be emitted,
1685
1412
        and a conflict will be noted.
1686
1413
        """
1687
 
        lines, base_lines = self._merged_lines(file_id)
 
1414
        lines, conflicts = self._merged_lines(file_id)
1688
1415
        lines = list(lines)
1689
1416
        # Note we're checking whether the OUTPUT is binary in this case,
1690
1417
        # because we don't want to get into weave merge guts.
1691
 
        textfile.check_text_lines(lines)
 
1418
        check_text_lines(lines)
1692
1419
        self.tt.create_file(lines, trans_id)
1693
 
        if base_lines is not None:
1694
 
            # Conflict
 
1420
        if conflicts:
1695
1421
            self._raw_conflicts.append(('text conflict', trans_id))
1696
1422
            name = self.tt.final_name(trans_id)
1697
1423
            parent_id = self.tt.final_parent(trans_id)
1698
1424
            file_group = self._dump_conflicts(name, parent_id, file_id,
1699
 
                                              no_base=False,
1700
 
                                              base_lines=base_lines)
 
1425
                                              no_base=True)
1701
1426
            file_group.append(trans_id)
1702
1427
 
1703
1428
 
1704
1429
class LCAMerger(WeaveMerger):
1705
1430
 
1706
 
    def _generate_merge_plan(self, file_id, base):
1707
 
        return self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
 
1431
    def _merged_lines(self, file_id):
 
1432
        """Generate the merged lines.
 
1433
        There is no distinction between lines that are meant to contain <<<<<<<
 
1434
        and conflicts.
 
1435
        """
 
1436
        if self.cherrypick:
 
1437
            base = self.base_tree
 
1438
        else:
 
1439
            base = None
 
1440
        plan = self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
1708
1441
                                                  base=base)
 
1442
        if 'merge' in debug.debug_flags:
 
1443
            plan = list(plan)
 
1444
            trans_id = self.tt.trans_id_file_id(file_id)
 
1445
            name = self.tt.final_name(trans_id) + '.plan'
 
1446
            contents = ('%10s|%s' % l for l in plan)
 
1447
            self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
 
1448
        textmerge = PlanWeaveMerge(plan, '<<<<<<< TREE\n',
 
1449
            '>>>>>>> MERGE-SOURCE\n')
 
1450
        return textmerge.merge_lines(self.reprocess)
 
1451
 
1709
1452
 
1710
1453
class Diff3Merger(Merge3Merger):
1711
1454
    """Three-way merger using external diff3 for text merging"""
1712
1455
 
1713
1456
    def dump_file(self, temp_dir, name, tree, file_id):
1714
 
        out_path = osutils.pathjoin(temp_dir, name)
 
1457
        out_path = pathjoin(temp_dir, name)
1715
1458
        out_file = open(out_path, "wb")
1716
1459
        try:
1717
1460
            in_file = tree.get_file(file_id)
1729
1472
        import bzrlib.patch
1730
1473
        temp_dir = osutils.mkdtemp(prefix="bzr-")
1731
1474
        try:
1732
 
            new_file = osutils.pathjoin(temp_dir, "new")
 
1475
            new_file = pathjoin(temp_dir, "new")
1733
1476
            this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
1734
1477
            base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
1735
1478
            other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
1736
1479
            status = bzrlib.patch.diff3(new_file, this, base, other)
1737
1480
            if status not in (0, 1):
1738
 
                raise errors.BzrError("Unhandled diff3 exit code")
 
1481
                raise BzrError("Unhandled diff3 exit code")
1739
1482
            f = open(new_file, 'rb')
1740
1483
            try:
1741
1484
                self.tt.create_file(f, trans_id)
1759
1502
                other_rev_id=None,
1760
1503
                interesting_files=None,
1761
1504
                this_tree=None,
1762
 
                pb=None,
 
1505
                pb=DummyProgress(),
1763
1506
                change_reporter=None):
1764
1507
    """Primary interface for merging.
1765
1508
 
1768
1511
                     branch.get_revision_tree(base_revision))'
1769
1512
        """
1770
1513
    if this_tree is None:
1771
 
        raise errors.BzrError("bzrlib.merge.merge_inner requires a this_tree "
1772
 
                              "parameter as of bzrlib version 0.8.")
 
1514
        raise BzrError("bzrlib.merge.merge_inner requires a this_tree "
 
1515
            "parameter as of bzrlib version 0.8.")
1773
1516
    merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1774
1517
                    pb=pb, change_reporter=change_reporter)
1775
1518
    merger.backup_files = backup_files
1993
1736
        super(_PlanMerge, self).__init__(a_rev, b_rev, vf, key_prefix)
1994
1737
        self.a_key = self._key_prefix + (self.a_rev,)
1995
1738
        self.b_key = self._key_prefix + (self.b_rev,)
1996
 
        self.graph = _mod_graph.Graph(self.vf)
 
1739
        self.graph = Graph(self.vf)
1997
1740
        heads = self.graph.heads((self.a_key, self.b_key))
1998
1741
        if len(heads) == 1:
1999
1742
            # one side dominates, so we can just return its values, yay for
2004
1747
                other = b_rev
2005
1748
            else:
2006
1749
                other = a_rev
2007
 
            trace.mutter('found dominating revision for %s\n%s > %s', self.vf,
2008
 
                         self._head_key[-1], other)
 
1750
            mutter('found dominating revision for %s\n%s > %s', self.vf,
 
1751
                   self._head_key[-1], other)
2009
1752
            self._weave = None
2010
1753
        else:
2011
1754
            self._head_key = None
2025
1768
        while True:
2026
1769
            next_lcas = self.graph.find_lca(*cur_ancestors)
2027
1770
            # Map a plain NULL_REVISION to a simple no-ancestors
2028
 
            if next_lcas == set([_mod_revision.NULL_REVISION]):
 
1771
            if next_lcas == set([NULL_REVISION]):
2029
1772
                next_lcas = ()
2030
1773
            # Order the lca's based on when they were merged into the tip
2031
1774
            # While the actual merge portion of weave merge uses a set() of
2043
1786
            elif len(next_lcas) > 2:
2044
1787
                # More than 2 lca's, fall back to grabbing all nodes between
2045
1788
                # this and the unique lca.
2046
 
                trace.mutter('More than 2 LCAs, falling back to all nodes for:'
2047
 
                             ' %s, %s\n=> %s',
2048
 
                             self.a_key, self.b_key, cur_ancestors)
 
1789
                mutter('More than 2 LCAs, falling back to all nodes for:'
 
1790
                       ' %s, %s\n=> %s', self.a_key, self.b_key, cur_ancestors)
2049
1791
                cur_lcas = next_lcas
2050
1792
                while len(cur_lcas) > 1:
2051
1793
                    cur_lcas = self.graph.find_lca(*cur_lcas)
2054
1796
                    unique_lca = None
2055
1797
                else:
2056
1798
                    unique_lca = list(cur_lcas)[0]
2057
 
                    if unique_lca == _mod_revision.NULL_REVISION:
 
1799
                    if unique_lca == NULL_REVISION:
2058
1800
                        # find_lca will return a plain 'NULL_REVISION' rather
2059
1801
                        # than a key tuple when there is no common ancestor, we
2060
1802
                        # prefer to just use None, because it doesn't confuse
2083
1825
            # We remove NULL_REVISION because it isn't a proper tuple key, and
2084
1826
            # thus confuses things like _get_interesting_texts, and our logic
2085
1827
            # to add the texts into the memory weave.
2086
 
            if _mod_revision.NULL_REVISION in parent_map:
2087
 
                parent_map.pop(_mod_revision.NULL_REVISION)
 
1828
            if NULL_REVISION in parent_map:
 
1829
                parent_map.pop(NULL_REVISION)
2088
1830
        else:
2089
1831
            interesting = set()
2090
1832
            for tip in tip_keys:
2242
1984
        lcas = graph.find_lca(key_prefix + (a_rev,), key_prefix + (b_rev,))
2243
1985
        self.lcas = set()
2244
1986
        for lca in lcas:
2245
 
            if lca == _mod_revision.NULL_REVISION:
 
1987
            if lca == NULL_REVISION:
2246
1988
                self.lcas.add(lca)
2247
1989
            else:
2248
1990
                self.lcas.add(lca[-1])