~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

  • Committer: Vincent Ladeuil
  • Date: 2008-09-11 19:36:38 UTC
  • mfrom: (3703 +trunk)
  • mto: (3705.1.1 trunk2)
  • mto: This revision was merged to the branch mainline in revision 3708.
  • Revision ID: v.ladeuil+lp@free.fr-20080911193638-wtjyc1kcmacc6t1f
merge bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
 
 
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
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
 
    tree as _mod_tree,
35
31
    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
 
    )
 
32
    )
 
33
from bzrlib.branch import Branch
 
34
from bzrlib.conflicts import ConflictList, Conflict
 
35
from bzrlib.errors import (BzrCommandError,
 
36
                           BzrError,
 
37
                           NoCommonAncestor,
 
38
                           NoCommits,
 
39
                           NoSuchRevision,
 
40
                           NoSuchFile,
 
41
                           NotBranchError,
 
42
                           NotVersionedError,
 
43
                           UnrelatedBranches,
 
44
                           UnsupportedOperation,
 
45
                           WorkingTreeNotRevision,
 
46
                           BinaryFile,
 
47
                           )
 
48
from bzrlib.graph import Graph
 
49
from bzrlib.merge3 import Merge3
 
50
from bzrlib.osutils import rename, pathjoin
 
51
from progress import DummyProgress, ProgressPhase
 
52
from bzrlib.revision import (NULL_REVISION, ensure_null)
 
53
from bzrlib.textfile import check_text_lines
 
54
from bzrlib.trace import mutter, warning, note, is_quiet
 
55
from bzrlib.transform import (TransformPreview, TreeTransform,
 
56
                              resolve_conflicts, cook_conflicts,
 
57
                              conflict_pass, FinalPaths, create_by_entry,
 
58
                              unique_add, ROOT_PARENT)
 
59
from bzrlib.versionedfile import PlanWeaveMerge
 
60
from bzrlib import ui
 
61
 
44
62
# TODO: Report back as changes are merged in
45
63
 
46
64
 
47
65
def transform_tree(from_tree, to_tree, interesting_ids=None):
48
 
    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)
 
66
    merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
 
67
                interesting_ids=interesting_ids, this_tree=from_tree)
255
68
 
256
69
 
257
70
class Merger(object):
258
 
 
259
 
    hooks = MergeHooks()
260
 
 
261
71
    def __init__(self, this_branch, other_tree=None, base_tree=None,
262
 
                 this_tree=None, pb=None, change_reporter=None,
 
72
                 this_tree=None, pb=DummyProgress(), change_reporter=None,
263
73
                 recurse='down', revision_graph=None):
264
74
        object.__init__(self)
265
75
        self.this_branch = this_branch
278
88
        self.interesting_files = None
279
89
        self.show_base = False
280
90
        self.reprocess = False
281
 
        if pb is not None:
282
 
            warnings.warn("pb parameter to Merger() is deprecated and ignored")
 
91
        self._pb = pb
283
92
        self.pp = None
284
93
        self.recurse = recurse
285
94
        self.change_reporter = change_reporter
287
96
        self._revision_graph = revision_graph
288
97
        self._base_is_ancestor = None
289
98
        self._base_is_other_ancestor = None
290
 
        self._is_criss_cross = None
291
 
        self._lca_trees = None
292
 
 
293
 
    def cache_trees_with_revision_ids(self, trees):
294
 
        """Cache any tree in trees if it has a revision_id."""
295
 
        for maybe_tree in trees:
296
 
            if maybe_tree is None:
297
 
                continue
298
 
            try:
299
 
                rev_id = maybe_tree.get_revision_id()
300
 
            except AttributeError:
301
 
                continue
302
 
            self._cached_trees[rev_id] = maybe_tree
303
99
 
304
100
    @property
305
101
    def revision_graph(self):
333
129
                                      _set_base_is_other_ancestor)
334
130
 
335
131
    @staticmethod
336
 
    def from_uncommitted(tree, other_tree, pb=None, base_tree=None):
 
132
    def from_uncommitted(tree, other_tree, pb):
337
133
        """Return a Merger for uncommitted changes in other_tree.
338
134
 
339
135
        :param tree: The tree to merge into
340
136
        :param other_tree: The tree to get uncommitted changes from
341
137
        :param pb: A progress indicator
342
 
        :param base_tree: The basis to use for the merge.  If unspecified,
343
 
            other_tree.basis_tree() will be used.
344
138
        """
345
 
        if base_tree is None:
346
 
            base_tree = other_tree.basis_tree()
347
 
        merger = Merger(tree.branch, other_tree, base_tree, tree, pb)
 
139
        merger = Merger(tree.branch, other_tree, other_tree.basis_tree(), tree,
 
140
                        pb)
348
141
        merger.base_rev_id = merger.base_tree.get_revision_id()
349
142
        merger.other_rev_id = None
350
143
        merger.other_basis = merger.base_rev_id
368
161
                base_revision_id, tree.branch.last_revision())):
369
162
                base_revision_id = None
370
163
            else:
371
 
                trace.warning('Performing cherrypick')
 
164
                warning('Performing cherrypick')
372
165
        merger = klass.from_revision_ids(pb, tree, other_revision_id,
373
166
                                         base_revision_id, revision_graph=
374
167
                                         revision_graph)
376
169
 
377
170
    @staticmethod
378
171
    def from_revision_ids(pb, tree, other, base=None, other_branch=None,
379
 
                          base_branch=None, revision_graph=None,
380
 
                          tree_branch=None):
 
172
                          base_branch=None, revision_graph=None):
381
173
        """Return a Merger for revision-ids.
382
174
 
383
 
        :param pb: A progress indicator
384
175
        :param tree: The tree to merge changes into
385
176
        :param other: The revision-id to use as OTHER
386
177
        :param base: The revision-id to use as BASE.  If not specified, will
391
182
            not supplied, other_branch or tree.branch will be used.
392
183
        :param revision_graph: If you have a revision_graph precomputed, pass
393
184
            it in, otherwise it will be created for you.
394
 
        :param tree_branch: The branch associated with tree.  If not supplied,
395
 
            tree.branch will be used.
 
185
        :param pb: A progress indicator
396
186
        """
397
 
        if tree_branch is None:
398
 
            tree_branch = tree.branch
399
 
        merger = Merger(tree_branch, this_tree=tree, pb=pb,
 
187
        merger = Merger(tree.branch, this_tree=tree, pb=pb,
400
188
                        revision_graph=revision_graph)
401
189
        if other_branch is None:
402
190
            other_branch = tree.branch
426
214
        if revno is None:
427
215
            tree = workingtree.WorkingTree.open_containing(location)[0]
428
216
            return tree.branch, tree
429
 
        branch = _mod_branch.Branch.open_containing(
430
 
            location, possible_transports)[0]
 
217
        branch = Branch.open_containing(location, possible_transports)[0]
431
218
        if revno == -1:
432
219
            revision_id = branch.last_revision()
433
220
        else:
434
221
            revision_id = branch.get_rev_id(revno)
435
 
        revision_id = _mod_revision.ensure_null(revision_id)
 
222
        revision_id = ensure_null(revision_id)
436
223
        return branch, self.revision_tree(revision_id, branch)
437
224
 
438
 
    @deprecated_method(deprecated_in((2, 1, 0)))
439
225
    def ensure_revision_trees(self):
440
226
        if self.this_revision_tree is None:
441
227
            self.this_basis_tree = self.revision_tree(self.this_basis)
444
230
 
445
231
        if self.other_rev_id is None:
446
232
            other_basis_tree = self.revision_tree(self.other_basis)
447
 
            if other_basis_tree.has_changes(self.other_tree):
448
 
                raise errors.WorkingTreeNotRevision(self.this_tree)
 
233
            changes = other_basis_tree.changes_from(self.other_tree)
 
234
            if changes.has_changed():
 
235
                raise WorkingTreeNotRevision(self.this_tree)
449
236
            other_rev_id = self.other_basis
450
237
            self.other_tree = other_basis_tree
451
238
 
452
 
    @deprecated_method(deprecated_in((2, 1, 0)))
453
239
    def file_revisions(self, file_id):
454
240
        self.ensure_revision_trees()
455
241
        def get_id(tree, file_id):
458
244
        if self.this_rev_id is None:
459
245
            if self.this_basis_tree.get_file_sha1(file_id) != \
460
246
                self.this_tree.get_file_sha1(file_id):
461
 
                raise errors.WorkingTreeNotRevision(self.this_tree)
 
247
                raise WorkingTreeNotRevision(self.this_tree)
462
248
 
463
249
        trees = (self.this_basis_tree, self.other_tree)
464
250
        return [get_id(tree, file_id) for tree in trees]
465
251
 
466
 
    @deprecated_method(deprecated_in((2, 1, 0)))
467
252
    def check_basis(self, check_clean, require_commits=True):
468
253
        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')")
 
254
            raise BzrCommandError("This branch has no commits."
 
255
                                  " (perhaps you would prefer 'bzr pull')")
472
256
        if check_clean:
473
257
            self.compare_basis()
474
258
            if self.this_basis != self.this_rev_id:
475
259
                raise errors.UncommittedChanges(self.this_tree)
476
260
 
477
 
    @deprecated_method(deprecated_in((2, 1, 0)))
478
261
    def compare_basis(self):
479
262
        try:
480
263
            basis_tree = self.revision_tree(self.this_tree.last_revision())
481
264
        except errors.NoSuchRevision:
482
265
            basis_tree = self.this_tree.basis_tree()
483
 
        if not self.this_tree.has_changes(basis_tree):
 
266
        changes = self.this_tree.changes_from(basis_tree)
 
267
        if not changes.has_changed():
484
268
            self.this_rev_id = self.this_basis
485
269
 
486
270
    def set_interesting_files(self, file_list):
487
271
        self.interesting_files = file_list
488
272
 
489
273
    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):
 
274
        if not self.base_is_ancestor or not self.base_is_other_ancestor or self.other_rev_id is None:
492
275
            return
493
276
        self._add_parent()
494
277
 
495
278
    def _add_parent(self):
496
279
        new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
497
280
        new_parent_trees = []
498
 
        operation = OperationWithCleanups(self.this_tree.set_parent_trees)
499
281
        for revision_id in new_parents:
500
282
            try:
501
283
                tree = self.revision_tree(revision_id)
503
285
                tree = None
504
286
            else:
505
287
                tree.lock_read()
506
 
                operation.add_cleanup(tree.unlock)
507
288
            new_parent_trees.append((revision_id, tree))
508
 
        operation.run_simple(new_parent_trees, allow_leftmost_as_ghost=True)
 
289
        try:
 
290
            self.this_tree.set_parent_trees(new_parent_trees,
 
291
                                            allow_leftmost_as_ghost=True)
 
292
        finally:
 
293
            for _revision_id, tree in new_parent_trees:
 
294
                if tree is not None:
 
295
                    tree.unlock()
509
296
 
510
297
    def set_other(self, other_revision, possible_transports=None):
511
298
        """Set the revision and tree to merge from.
520
307
            self.other_rev_id = _mod_revision.ensure_null(
521
308
                self.other_branch.last_revision())
522
309
            if _mod_revision.is_null(self.other_rev_id):
523
 
                raise errors.NoCommits(self.other_branch)
 
310
                raise NoCommits(self.other_branch)
524
311
            self.other_basis = self.other_rev_id
525
312
        elif other_revision[1] is not None:
526
313
            self.other_rev_id = self.other_branch.get_rev_id(other_revision[1])
529
316
            self.other_rev_id = None
530
317
            self.other_basis = self.other_branch.last_revision()
531
318
            if self.other_basis is None:
532
 
                raise errors.NoCommits(self.other_branch)
 
319
                raise NoCommits(self.other_branch)
533
320
        if self.other_rev_id is not None:
534
321
            self._cached_trees[self.other_rev_id] = self.other_tree
535
322
        self._maybe_fetch(self.other_branch,self.this_branch, self.other_basis)
562
349
            target.fetch(source, revision_id)
563
350
 
564
351
    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
569
 
            self.base_tree = self.revision_tree(self.base_rev_id)
570
 
            self._is_criss_cross = False
 
352
        revisions = [ensure_null(self.this_basis),
 
353
                     ensure_null(self.other_basis)]
 
354
        if NULL_REVISION in revisions:
 
355
            self.base_rev_id = NULL_REVISION
571
356
        else:
572
 
            lcas = self.revision_graph.find_lca(revisions[0], revisions[1])
573
 
            self._is_criss_cross = False
574
 
            if len(lcas) == 0:
575
 
                self.base_rev_id = _mod_revision.NULL_REVISION
576
 
            elif len(lcas) == 1:
577
 
                self.base_rev_id = list(lcas)[0]
578
 
            else: # len(lcas) > 1
579
 
                if len(lcas) > 2:
580
 
                    # find_unique_lca can only handle 2 nodes, so we have to
581
 
                    # start back at the beginning. It is a shame to traverse
582
 
                    # the graph again, but better than re-implementing
583
 
                    # find_unique_lca.
584
 
                    self.base_rev_id = self.revision_graph.find_unique_lca(
585
 
                                            revisions[0], revisions[1])
586
 
                else:
587
 
                    self.base_rev_id = self.revision_graph.find_unique_lca(
588
 
                                            *lcas)
589
 
                self._is_criss_cross = True
590
 
            if self.base_rev_id == _mod_revision.NULL_REVISION:
591
 
                raise errors.UnrelatedBranches()
592
 
            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)
596
 
                interesting_revision_ids = [self.base_rev_id]
597
 
                interesting_revision_ids.extend(lcas)
598
 
                interesting_trees = dict((t.get_revision_id(), t)
599
 
                    for t in self.this_branch.repository.revision_trees(
600
 
                        interesting_revision_ids))
601
 
                self._cached_trees.update(interesting_trees)
602
 
                self.base_tree = interesting_trees.pop(self.base_rev_id)
603
 
                sorted_lca_keys = self.revision_graph.find_merge_order(
604
 
                    revisions[0], lcas)
605
 
                self._lca_trees = [interesting_trees[key]
606
 
                                   for key in sorted_lca_keys]
607
 
            else:
608
 
                self.base_tree = self.revision_tree(self.base_rev_id)
 
357
            self.base_rev_id, steps = self.revision_graph.find_unique_lca(
 
358
                revisions[0], revisions[1], count_steps=True)
 
359
            if self.base_rev_id == NULL_REVISION:
 
360
                raise UnrelatedBranches()
 
361
            if steps > 1:
 
362
                warning('Warning: criss-cross merge encountered.  See bzr'
 
363
                        ' help criss-cross.')
 
364
        self.base_tree = self.revision_tree(self.base_rev_id)
609
365
        self.base_is_ancestor = True
610
366
        self.base_is_other_ancestor = True
611
 
        trace.mutter('Base revid: %r' % self.base_rev_id)
612
367
 
613
368
    def set_base(self, base_revision):
614
369
        """Set the base revision to use for the merge.
615
370
 
616
371
        :param base_revision: A 2-list containing a path and revision number.
617
372
        """
618
 
        trace.mutter("doing merge() with no base_revision specified")
 
373
        mutter("doing merge() with no base_revision specified")
619
374
        if base_revision == [None, None]:
620
375
            self.find_base()
621
376
        else:
634
389
                  'other_tree': self.other_tree,
635
390
                  'interesting_ids': self.interesting_ids,
636
391
                  'interesting_files': self.interesting_files,
637
 
                  'this_branch': self.this_branch,
 
392
                  'pp': self.pp,
638
393
                  'do_merge': False}
639
394
        if self.merge_type.requires_base:
640
395
            kwargs['base_tree'] = self.base_tree
641
396
        if self.merge_type.supports_reprocess:
642
397
            kwargs['reprocess'] = self.reprocess
643
398
        elif self.reprocess:
644
 
            raise errors.BzrError(
645
 
                "Conflict reduction is not supported for merge"
646
 
                " type %s." % self.merge_type)
 
399
            raise BzrError("Conflict reduction is not supported for merge"
 
400
                                  " type %s." % self.merge_type)
647
401
        if self.merge_type.supports_show_base:
648
402
            kwargs['show_base'] = self.show_base
649
403
        elif self.show_base:
650
 
            raise errors.BzrError("Showing base is not supported for this"
651
 
                                  " merge type. %s" % self.merge_type)
 
404
            raise BzrError("Showing base is not supported for this"
 
405
                           " merge type. %s" % self.merge_type)
652
406
        if (not getattr(self.merge_type, 'supports_reverse_cherrypick', True)
653
407
            and not self.base_is_other_ancestor):
654
408
            raise errors.CannotReverseCherrypick()
655
409
        if self.merge_type.supports_cherrypick:
656
410
            kwargs['cherrypick'] = (not self.base_is_ancestor or
657
411
                                    not self.base_is_other_ancestor)
658
 
        if self._is_criss_cross and getattr(self.merge_type,
659
 
                                            'supports_lca_trees', False):
660
 
            kwargs['lca_trees'] = self._lca_trees
661
 
        return self.merge_type(pb=None,
 
412
        return self.merge_type(pb=self._pb,
662
413
                               change_reporter=self.change_reporter,
663
414
                               **kwargs)
664
415
 
665
 
    def _do_merge_to(self):
666
 
        merge = self.make_merger()
667
 
        if self.other_branch is not None:
668
 
            self.other_branch.update_references(self.this_branch)
 
416
    def _do_merge_to(self, merge):
669
417
        merge.do_merge()
670
418
        if self.recurse == 'down':
671
419
            for relpath, file_id in self.this_tree.iter_references():
683
431
                    sub_tree.branch.repository.revision_tree(base_revision)
684
432
                sub_merge.base_rev_id = base_revision
685
433
                sub_merge.do_merge()
686
 
        return merge
687
 
 
 
434
        
688
435
    def do_merge(self):
689
 
        operation = OperationWithCleanups(self._do_merge_to)
690
436
        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()
 
437
        try:
 
438
            if self.base_tree is not None:
 
439
                self.base_tree.lock_read()
 
440
            try:
 
441
                if self.other_tree is not None:
 
442
                    self.other_tree.lock_read()
 
443
                try:
 
444
                    merge = self.make_merger()
 
445
                    self._do_merge_to(merge)
 
446
                finally:
 
447
                    if self.other_tree is not None:
 
448
                        self.other_tree.unlock()
 
449
            finally:
 
450
                if self.base_tree is not None:
 
451
                    self.base_tree.unlock()
 
452
        finally:
 
453
            self.this_tree.unlock()
699
454
        if len(merge.cooked_conflicts) == 0:
700
 
            if not self.ignore_zero and not trace.is_quiet():
701
 
                trace.note("All changes applied successfully.")
 
455
            if not self.ignore_zero and not is_quiet():
 
456
                note("All changes applied successfully.")
702
457
        else:
703
 
            trace.note("%d conflicts encountered."
704
 
                       % len(merge.cooked_conflicts))
 
458
            note("%d conflicts encountered." % len(merge.cooked_conflicts))
705
459
 
706
460
        return len(merge.cooked_conflicts)
707
461
 
708
462
 
709
 
class _InventoryNoneEntry(object):
710
 
    """This represents an inventory entry which *isn't there*.
711
 
 
712
 
    It simplifies the merging logic if we always have an InventoryEntry, even
713
 
    if it isn't actually present
714
 
    """
715
 
    executable = None
716
 
    kind = None
717
 
    name = None
718
 
    parent_id = None
719
 
    revision = None
720
 
    symlink_target = None
721
 
    text_sha1 = None
722
 
 
723
 
_none_entry = _InventoryNoneEntry()
724
 
 
725
 
 
726
463
class Merge3Merger(object):
727
464
    """Three-way merger that uses the merge3 text merger"""
728
465
    requires_base = True
732
469
    supports_cherrypick = True
733
470
    supports_reverse_cherrypick = True
734
471
    winner_idx = {"this": 2, "other": 1, "conflict": 1}
735
 
    supports_lca_trees = True
736
472
 
737
 
    def __init__(self, working_tree, this_tree, base_tree, other_tree,
 
473
    def __init__(self, working_tree, this_tree, base_tree, other_tree, 
738
474
                 interesting_ids=None, reprocess=False, show_base=False,
739
 
                 pb=None, pp=None, change_reporter=None,
 
475
                 pb=DummyProgress(), pp=None, change_reporter=None,
740
476
                 interesting_files=None, do_merge=True,
741
 
                 cherrypick=False, lca_trees=None, this_branch=None):
 
477
                 cherrypick=False):
742
478
        """Initialize the merger object and perform the merge.
743
479
 
744
480
        :param working_tree: The working tree to apply the merge to
745
481
        :param this_tree: The local tree in the merge operation
746
482
        :param base_tree: The common tree in the merge operation
747
 
        :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.
 
483
        :param other_tree: The other other tree to merge changes from
750
484
        :param interesting_ids: The file_ids of files that should be
751
485
            participate in the merge.  May not be combined with
752
486
            interesting_files.
753
487
        :param: reprocess If True, perform conflict-reduction processing.
754
488
        :param show_base: If True, show the base revision in text conflicts.
755
489
            (incompatible with reprocess)
756
 
        :param pb: ignored
 
490
        :param pb: A Progress bar
757
491
        :param pp: A ProgressPhase object
758
492
        :param change_reporter: An object that should report changes made
759
493
        :param interesting_files: The tree-relative paths of files that should
762
496
            be combined with interesting_ids.  If neither interesting_files nor
763
497
            interesting_ids is specified, all files may participate in the
764
498
            merge.
765
 
        :param lca_trees: Can be set to a dictionary of {revision_id:rev_tree}
766
 
            if the ancestry was found to include a criss-cross merge.
767
 
            Otherwise should be None.
768
499
        """
769
500
        object.__init__(self)
770
501
        if interesting_files is not None and interesting_ids is not None:
771
502
            raise ValueError(
772
503
                'specify either interesting_ids or interesting_files')
773
 
        if this_branch is None:
774
 
            this_branch = this_tree.branch
775
504
        self.interesting_ids = interesting_ids
776
505
        self.interesting_files = interesting_files
777
506
        self.this_tree = working_tree
778
507
        self.base_tree = base_tree
779
508
        self.other_tree = other_tree
780
 
        self.this_branch = this_branch
781
509
        self._raw_conflicts = []
782
510
        self.cooked_conflicts = []
783
511
        self.reprocess = reprocess
784
512
        self.show_base = show_base
785
 
        self._lca_trees = lca_trees
786
 
        # Uncommenting this will change the default algorithm to always use
787
 
        # _entries_lca. This can be useful for running the test suite and
788
 
        # making sure we haven't missed any corner cases.
789
 
        # if lca_trees is None:
790
 
        #     self._lca_trees = [self.base_tree]
 
513
        self.pb = pb
 
514
        self.pp = pp
791
515
        self.change_reporter = change_reporter
792
516
        self.cherrypick = cherrypick
 
517
        if self.pp is None:
 
518
            self.pp = ProgressPhase("Merge phase", 3, self.pb)
793
519
        if do_merge:
794
520
            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
521
 
800
522
    def do_merge(self):
801
 
        operation = OperationWithCleanups(self._do_merge)
802
523
        self.this_tree.lock_tree_write()
803
 
        operation.add_cleanup(self.this_tree.unlock)
804
524
        self.base_tree.lock_read()
805
 
        operation.add_cleanup(self.base_tree.unlock)
806
525
        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)
 
526
        self.tt = TreeTransform(self.this_tree, self.pb)
816
527
        try:
817
 
            self.this_tree.add_conflicts(self.cooked_conflicts)
818
 
        except errors.UnsupportedOperation:
819
 
            pass
 
528
            self.pp.next_phase()
 
529
            self._compute_transform()
 
530
            self.pp.next_phase()
 
531
            results = self.tt.apply(no_conflicts=True)
 
532
            self.write_modified(results)
 
533
            try:
 
534
                self.this_tree.add_conflicts(self.cooked_conflicts)
 
535
            except UnsupportedOperation:
 
536
                pass
 
537
        finally:
 
538
            self.tt.finalize()
 
539
            self.other_tree.unlock()
 
540
            self.base_tree.unlock()
 
541
            self.this_tree.unlock()
 
542
            self.pb.clear()
820
543
 
821
544
    def make_preview_transform(self):
822
 
        operation = OperationWithCleanups(self._make_preview_transform)
823
545
        self.base_tree.lock_read()
824
 
        operation.add_cleanup(self.base_tree.unlock)
825
546
        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()
 
547
        self.tt = TransformPreview(self.this_tree)
 
548
        try:
 
549
            self.pp.next_phase()
 
550
            self._compute_transform()
 
551
            self.pp.next_phase()
 
552
        finally:
 
553
            self.other_tree.unlock()
 
554
            self.base_tree.unlock()
 
555
            self.pb.clear()
832
556
        return self.tt
833
557
 
834
558
    def _compute_transform(self):
835
 
        if self._lca_trees is None:
836
 
            entries = self._entries3()
837
 
            resolver = self._three_way
838
 
        else:
839
 
            entries = self._entries_lca()
840
 
            resolver = self._lca_multi_way
 
559
        entries = self._entries3()
841
560
        child_pb = ui.ui_factory.nested_progress_bar()
842
561
        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
562
            for num, (file_id, changed, parents3, names3,
847
563
                      executable3) in enumerate(entries):
848
564
                child_pb.update('Preparing file merge', num, len(entries))
849
 
                self._merge_names(file_id, parents3, names3, resolver=resolver)
 
565
                self._merge_names(file_id, parents3, names3)
850
566
                if changed:
851
 
                    file_status = self._do_merge_contents(file_id)
 
567
                    file_status = self.merge_contents(file_id)
852
568
                else:
853
569
                    file_status = 'unmodified'
854
570
                self._merge_executable(file_id,
855
 
                    executable3, file_status, resolver=resolver)
 
571
                    executable3, file_status)
856
572
        finally:
857
573
            child_pb.finished()
858
574
        self.fix_root()
 
575
        self.pp.next_phase()
859
576
        child_pb = ui.ui_factory.nested_progress_bar()
860
577
        try:
861
 
            fs_conflicts = transform.resolve_conflicts(self.tt, child_pb,
862
 
                lambda t, c: transform.conflict_pass(t, c, self.other_tree))
 
578
            fs_conflicts = resolve_conflicts(self.tt, child_pb,
 
579
                lambda t, c: conflict_pass(t, c, self.other_tree))
863
580
        finally:
864
581
            child_pb.finished()
865
582
        if self.change_reporter is not None:
868
585
                self.tt.iter_changes(), self.change_reporter)
869
586
        self.cook_conflicts(fs_conflicts)
870
587
        for conflict in self.cooked_conflicts:
871
 
            trace.warning(conflict)
 
588
            warning(conflict)
872
589
 
873
590
    def _entries3(self):
874
591
        """Gather data about files modified between three trees.
883
600
        iterator = self.other_tree.iter_changes(self.base_tree,
884
601
                include_unchanged=True, specific_files=self.interesting_files,
885
602
                extra_trees=[self.this_tree])
886
 
        this_entries = dict((e.file_id, e) for p, e in
887
 
                            self.this_tree.iter_entries_by_dir(
888
 
                            self.interesting_ids))
889
603
        for (file_id, paths, changed, versioned, parents, names, kind,
890
604
             executable) in iterator:
891
605
            if (self.interesting_ids is not None and
892
606
                file_id not in self.interesting_ids):
893
607
                continue
894
 
            entry = this_entries.get(file_id)
895
 
            if entry is not None:
 
608
            if file_id in self.this_tree.inventory:
 
609
                entry = self.this_tree.inventory[file_id]
896
610
                this_name = entry.name
897
611
                this_parent = entry.parent_id
898
612
                this_executable = entry.executable
906
620
            result.append((file_id, changed, parents3, names3, executable3))
907
621
        return result
908
622
 
909
 
    def _entries_lca(self):
910
 
        """Gather data about files modified between multiple trees.
911
 
 
912
 
        This compares OTHER versus all LCA trees, and for interesting entries,
913
 
        it then compares with THIS and BASE.
914
 
 
915
 
        For the multi-valued entries, the format will be (BASE, [lca1, lca2])
916
 
        :return: [(file_id, changed, parents, names, executable)]
917
 
            file_id     Simple file_id of the entry
918
 
            changed     Boolean, True if the kind or contents changed
919
 
                        else False
920
 
            parents     ((base, [parent_id, in, lcas]), parent_id_other,
921
 
                         parent_id_this)
922
 
            names       ((base, [name, in, lcas]), name_in_other, name_in_this)
923
 
            executable  ((base, [exec, in, lcas]), exec_in_other, exec_in_this)
924
 
        """
925
 
        if self.interesting_files is not None:
926
 
            lookup_trees = [self.this_tree, self.base_tree]
927
 
            lookup_trees.extend(self._lca_trees)
928
 
            # I think we should include the lca trees as well
929
 
            interesting_ids = self.other_tree.paths2ids(self.interesting_files,
930
 
                                                        lookup_trees)
931
 
        else:
932
 
            interesting_ids = self.interesting_ids
933
 
        result = []
934
 
        walker = _mod_tree.MultiWalker(self.other_tree, self._lca_trees)
935
 
 
936
 
        base_inventory = self.base_tree.inventory
937
 
        this_inventory = self.this_tree.inventory
938
 
        for path, file_id, other_ie, lca_values in walker.iter_all():
939
 
            # Is this modified at all from any of the other trees?
940
 
            if other_ie is None:
941
 
                other_ie = _none_entry
942
 
            if interesting_ids is not None and file_id not in interesting_ids:
943
 
                continue
944
 
 
945
 
            # If other_revision is found in any of the lcas, that means this
946
 
            # node is uninteresting. This is because when merging, if there are
947
 
            # multiple heads(), we have to create a new node. So if we didn't,
948
 
            # we know that the ancestry is linear, and that OTHER did not
949
 
            # modify anything
950
 
            # See doc/developers/lca_merge_resolution.txt for details
951
 
            other_revision = other_ie.revision
952
 
            if other_revision is not None:
953
 
                # We can't use this shortcut when other_revision is None,
954
 
                # because it may be None because things are WorkingTrees, and
955
 
                # not because it is *actually* None.
956
 
                is_unmodified = False
957
 
                for lca_path, ie in lca_values:
958
 
                    if ie is not None and ie.revision == other_revision:
959
 
                        is_unmodified = True
960
 
                        break
961
 
                if is_unmodified:
962
 
                    continue
963
 
 
964
 
            lca_entries = []
965
 
            for lca_path, lca_ie in lca_values:
966
 
                if lca_ie is None:
967
 
                    lca_entries.append(_none_entry)
968
 
                else:
969
 
                    lca_entries.append(lca_ie)
970
 
 
971
 
            if file_id in base_inventory:
972
 
                base_ie = base_inventory[file_id]
973
 
            else:
974
 
                base_ie = _none_entry
975
 
 
976
 
            if file_id in this_inventory:
977
 
                this_ie = this_inventory[file_id]
978
 
            else:
979
 
                this_ie = _none_entry
980
 
 
981
 
            lca_kinds = []
982
 
            lca_parent_ids = []
983
 
            lca_names = []
984
 
            lca_executable = []
985
 
            for lca_ie in lca_entries:
986
 
                lca_kinds.append(lca_ie.kind)
987
 
                lca_parent_ids.append(lca_ie.parent_id)
988
 
                lca_names.append(lca_ie.name)
989
 
                lca_executable.append(lca_ie.executable)
990
 
 
991
 
            kind_winner = self._lca_multi_way(
992
 
                (base_ie.kind, lca_kinds),
993
 
                other_ie.kind, this_ie.kind)
994
 
            parent_id_winner = self._lca_multi_way(
995
 
                (base_ie.parent_id, lca_parent_ids),
996
 
                other_ie.parent_id, this_ie.parent_id)
997
 
            name_winner = self._lca_multi_way(
998
 
                (base_ie.name, lca_names),
999
 
                other_ie.name, this_ie.name)
1000
 
 
1001
 
            content_changed = True
1002
 
            if kind_winner == 'this':
1003
 
                # No kind change in OTHER, see if there are *any* changes
1004
 
                if other_ie.kind == 'directory':
1005
 
                    if parent_id_winner == 'this' and name_winner == 'this':
1006
 
                        # No change for this directory in OTHER, skip
1007
 
                        continue
1008
 
                    content_changed = False
1009
 
                elif other_ie.kind is None or other_ie.kind == 'file':
1010
 
                    def get_sha1(ie, tree):
1011
 
                        if ie.kind != 'file':
1012
 
                            return None
1013
 
                        return tree.get_file_sha1(file_id)
1014
 
                    base_sha1 = get_sha1(base_ie, self.base_tree)
1015
 
                    lca_sha1s = [get_sha1(ie, tree) for ie, tree
1016
 
                                 in zip(lca_entries, self._lca_trees)]
1017
 
                    this_sha1 = get_sha1(this_ie, self.this_tree)
1018
 
                    other_sha1 = get_sha1(other_ie, self.other_tree)
1019
 
                    sha1_winner = self._lca_multi_way(
1020
 
                        (base_sha1, lca_sha1s), other_sha1, this_sha1,
1021
 
                        allow_overriding_lca=False)
1022
 
                    exec_winner = self._lca_multi_way(
1023
 
                        (base_ie.executable, lca_executable),
1024
 
                        other_ie.executable, this_ie.executable)
1025
 
                    if (parent_id_winner == 'this' and name_winner == 'this'
1026
 
                        and sha1_winner == 'this' and exec_winner == 'this'):
1027
 
                        # No kind, parent, name, exec, or content change for
1028
 
                        # OTHER, so this node is not considered interesting
1029
 
                        continue
1030
 
                    if sha1_winner == 'this':
1031
 
                        content_changed = False
1032
 
                elif other_ie.kind == 'symlink':
1033
 
                    def get_target(ie, tree):
1034
 
                        if ie.kind != 'symlink':
1035
 
                            return None
1036
 
                        return tree.get_symlink_target(file_id)
1037
 
                    base_target = get_target(base_ie, self.base_tree)
1038
 
                    lca_targets = [get_target(ie, tree) for ie, tree
1039
 
                                   in zip(lca_entries, self._lca_trees)]
1040
 
                    this_target = get_target(this_ie, self.this_tree)
1041
 
                    other_target = get_target(other_ie, self.other_tree)
1042
 
                    target_winner = self._lca_multi_way(
1043
 
                        (base_target, lca_targets),
1044
 
                        other_target, this_target)
1045
 
                    if (parent_id_winner == 'this' and name_winner == 'this'
1046
 
                        and target_winner == 'this'):
1047
 
                        # No kind, parent, name, or symlink target change
1048
 
                        # not interesting
1049
 
                        continue
1050
 
                    if target_winner == 'this':
1051
 
                        content_changed = False
1052
 
                elif other_ie.kind == 'tree-reference':
1053
 
                    # The 'changed' information seems to be handled at a higher
1054
 
                    # level. At least, _entries3 returns False for content
1055
 
                    # changed, even when at a new revision_id.
1056
 
                    content_changed = False
1057
 
                    if (parent_id_winner == 'this' and name_winner == 'this'):
1058
 
                        # Nothing interesting
1059
 
                        continue
1060
 
                else:
1061
 
                    raise AssertionError('unhandled kind: %s' % other_ie.kind)
1062
 
 
1063
 
            # If we have gotten this far, that means something has changed
1064
 
            result.append((file_id, content_changed,
1065
 
                           ((base_ie.parent_id, lca_parent_ids),
1066
 
                            other_ie.parent_id, this_ie.parent_id),
1067
 
                           ((base_ie.name, lca_names),
1068
 
                            other_ie.name, this_ie.name),
1069
 
                           ((base_ie.executable, lca_executable),
1070
 
                            other_ie.executable, this_ie.executable)
1071
 
                          ))
1072
 
        return result
1073
 
 
1074
 
 
1075
623
    def fix_root(self):
1076
624
        try:
1077
625
            self.tt.final_kind(self.tt.root)
1078
 
        except errors.NoSuchFile:
 
626
        except NoSuchFile:
1079
627
            self.tt.cancel_deletion(self.tt.root)
1080
628
        if self.tt.final_file_id(self.tt.root) is None:
1081
 
            self.tt.version_file(self.tt.tree_file_id(self.tt.root),
 
629
            self.tt.version_file(self.tt.tree_file_id(self.tt.root), 
1082
630
                                 self.tt.root)
 
631
        if self.other_tree.inventory.root is None:
 
632
            return
1083
633
        other_root_file_id = self.other_tree.get_root_id()
1084
 
        if other_root_file_id is None:
1085
 
            return
1086
634
        other_root = self.tt.trans_id_file_id(other_root_file_id)
1087
635
        if other_root == self.tt.root:
1088
636
            return
 
637
        try:
 
638
            self.tt.final_kind(other_root)
 
639
        except NoSuchFile:
 
640
            return
1089
641
        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)
 
642
            # the other tree's root is a non-root in the current tree
1092
643
            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():
 
644
        self.reparent_children(self.other_tree.inventory.root, self.tt.root)
 
645
        self.tt.cancel_creation(other_root)
 
646
        self.tt.cancel_versioning(other_root)
 
647
 
 
648
    def reparent_children(self, ie, target):
 
649
        for thing, child in ie.children.iteritems():
1104
650
            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)
 
651
            self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
1121
652
 
1122
653
    def write_modified(self, results):
1123
654
        modified_hashes = {}
1144
675
        if entry is None:
1145
676
            return None
1146
677
        return entry.name
1147
 
 
 
678
    
1148
679
    @staticmethod
1149
680
    def contents_sha1(tree, file_id):
1150
681
        """Determine the sha1 of the file contents (used as a key method)."""
1155
686
    @staticmethod
1156
687
    def executable(tree, file_id):
1157
688
        """Determine the executability of a file-id (used as a key method)."""
1158
 
        if not tree.has_id(file_id):
 
689
        if file_id not in tree:
1159
690
            return None
1160
691
        if tree.kind(file_id) != "file":
1161
692
            return False
1164
695
    @staticmethod
1165
696
    def kind(tree, file_id):
1166
697
        """Determine the kind of a file-id (used as a key method)."""
1167
 
        if not tree.has_id(file_id):
 
698
        if file_id not in tree:
1168
699
            return None
1169
700
        return tree.kind(file_id)
1170
701
 
1171
702
    @staticmethod
1172
703
    def _three_way(base, other, this):
 
704
        #if base == other, either they all agree, or only THIS has changed.
1173
705
        if base == other:
1174
 
            # if 'base == other', either they all agree, or only 'this' has
1175
 
            # changed.
1176
706
            return 'this'
1177
707
        elif this not in (base, other):
1178
 
            # 'this' is neither 'base' nor 'other', so both sides changed
1179
708
            return 'conflict'
 
709
        # "Ambiguous clean merge" -- both sides have made the same change.
1180
710
        elif this == other:
1181
 
            # "Ambiguous clean merge" -- both sides have made the same change.
1182
711
            return "this"
 
712
        # this == base: only other has changed.
1183
713
        else:
1184
 
            # this == base: only other has changed.
1185
714
            return "other"
1186
715
 
1187
716
    @staticmethod
1188
 
    def _lca_multi_way(bases, other, this, allow_overriding_lca=True):
1189
 
        """Consider LCAs when determining whether a change has occurred.
1190
 
 
1191
 
        If LCAS are all identical, this is the same as a _three_way comparison.
1192
 
 
1193
 
        :param bases: value in (BASE, [LCAS])
1194
 
        :param other: value in OTHER
1195
 
        :param this: value in THIS
1196
 
        :param allow_overriding_lca: If there is more than one unique lca
1197
 
            value, allow OTHER to override THIS if it has a new value, and
1198
 
            THIS only has an lca value, or vice versa. This is appropriate for
1199
 
            truly scalar values, not as much for non-scalars.
1200
 
        :return: 'this', 'other', or 'conflict' depending on whether an entry
1201
 
            changed or not.
1202
 
        """
1203
 
        # See doc/developers/lca_tree_merging.txt for details about this
1204
 
        # algorithm.
1205
 
        if other == this:
1206
 
            # Either Ambiguously clean, or nothing was actually changed. We
1207
 
            # don't really care
1208
 
            return 'this'
1209
 
        base_val, lca_vals = bases
1210
 
        # Remove 'base_val' from the lca_vals, because it is not interesting
1211
 
        filtered_lca_vals = [lca_val for lca_val in lca_vals
1212
 
                                      if lca_val != base_val]
1213
 
        if len(filtered_lca_vals) == 0:
1214
 
            return Merge3Merger._three_way(base_val, other, this)
1215
 
 
1216
 
        unique_lca_vals = set(filtered_lca_vals)
1217
 
        if len(unique_lca_vals) == 1:
1218
 
            return Merge3Merger._three_way(unique_lca_vals.pop(), other, this)
1219
 
 
1220
 
        if allow_overriding_lca:
1221
 
            if other in unique_lca_vals:
1222
 
                if this in unique_lca_vals:
1223
 
                    # Each side picked a different lca, conflict
1224
 
                    return 'conflict'
1225
 
                else:
1226
 
                    # This has a value which supersedes both lca values, and
1227
 
                    # other only has an lca value
1228
 
                    return 'this'
1229
 
            elif this in unique_lca_vals:
1230
 
                # OTHER has a value which supersedes both lca values, and this
1231
 
                # only has an lca value
1232
 
                return 'other'
1233
 
 
1234
 
        # At this point, the lcas disagree, and the tip disagree
1235
 
        return 'conflict'
1236
 
 
1237
 
    @staticmethod
1238
 
    @deprecated_method(deprecated_in((2, 2, 0)))
1239
717
    def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
1240
718
        """Do a three-way test on a scalar.
1241
719
        Return "this", "other" or "conflict", depending whether a value wins.
1256
734
 
1257
735
    def merge_names(self, file_id):
1258
736
        def get_entry(tree):
1259
 
            if tree.has_id(file_id):
 
737
            if file_id in tree.inventory:
1260
738
                return tree.inventory[file_id]
1261
739
            else:
1262
740
                return None
1273
751
            else:
1274
752
                names.append(entry.name)
1275
753
                parents.append(entry.parent_id)
1276
 
        return self._merge_names(file_id, parents, names,
1277
 
                                 resolver=self._three_way)
 
754
        return self._merge_names(file_id, parents, names)
1278
755
 
1279
 
    def _merge_names(self, file_id, parents, names, resolver):
 
756
    def _merge_names(self, file_id, parents, names):
1280
757
        """Perform a merge on file_id names and parents"""
1281
758
        base_name, other_name, this_name = names
1282
759
        base_parent, other_parent, this_parent = parents
1283
760
 
1284
 
        name_winner = resolver(*names)
 
761
        name_winner = self._three_way(*names)
1285
762
 
1286
 
        parent_id_winner = resolver(*parents)
 
763
        parent_id_winner = self._three_way(*parents)
1287
764
        if this_name is None:
1288
765
            if name_winner == "this":
1289
766
                name_winner = "other"
1291
768
                parent_id_winner = "other"
1292
769
        if name_winner == "this" and parent_id_winner == "this":
1293
770
            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))
 
771
        if name_winner == "conflict":
 
772
            trans_id = self.tt.trans_id_file_id(file_id)
 
773
            self._raw_conflicts.append(('name conflict', trans_id, 
 
774
                                        this_name, other_name))
 
775
        if parent_id_winner == "conflict":
 
776
            trans_id = self.tt.trans_id_file_id(file_id)
 
777
            self._raw_conflicts.append(('parent conflict', trans_id, 
 
778
                                        this_parent, other_parent))
1302
779
        if other_name is None:
1303
 
            # it doesn't matter whether the result was 'other' or
 
780
            # it doesn't matter whether the result was 'other' or 
1304
781
            # 'conflict'-- if there's no 'other', we leave it alone.
1305
782
            return
 
783
        # if we get here, name_winner and parent_winner are set to safe values.
 
784
        trans_id = self.tt.trans_id_file_id(file_id)
1306
785
        parent_id = parents[self.winner_idx[parent_id_winner]]
1307
786
        if parent_id is not None:
1308
 
            # if we get here, name_winner and parent_winner are set to safe
1309
 
            # values.
 
787
            parent_trans_id = self.tt.trans_id_file_id(parent_id)
1310
788
            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))
 
789
                                parent_trans_id, trans_id)
1313
790
 
1314
 
    def _do_merge_contents(self, file_id):
1315
 
        """Performs a merge on file_id contents."""
 
791
    def merge_contents(self, file_id):
 
792
        """Performa a merge on file_id contents."""
1316
793
        def contents_pair(tree):
1317
794
            if file_id not in tree:
1318
795
                return (None, None)
1325
802
                contents = None
1326
803
            return kind, contents
1327
804
 
 
805
        def contents_conflict():
 
806
            trans_id = self.tt.trans_id_file_id(file_id)
 
807
            name = self.tt.final_name(trans_id)
 
808
            parent_id = self.tt.final_parent(trans_id)
 
809
            if file_id in self.this_tree.inventory:
 
810
                self.tt.unversion_file(trans_id)
 
811
                if file_id in self.this_tree:
 
812
                    self.tt.delete_contents(trans_id)
 
813
            file_group = self._dump_conflicts(name, parent_id, file_id, 
 
814
                                              set_version=True)
 
815
            self._raw_conflicts.append(('contents conflict', file_group))
 
816
 
1328
817
        # See SPOT run.  run, SPOT, run.
1329
818
        # So we're not QUITE repeating ourselves; we do tricky things with
1330
819
        # file kind...
1331
820
        base_pair = contents_pair(self.base_tree)
1332
821
        other_pair = contents_pair(self.other_tree)
1333
 
        if self._lca_trees:
1334
 
            this_pair = contents_pair(self.this_tree)
1335
 
            lca_pairs = [contents_pair(tree) for tree in self._lca_trees]
1336
 
            winner = self._lca_multi_way((base_pair, lca_pairs), other_pair,
1337
 
                                         this_pair, allow_overriding_lca=False)
1338
 
        else:
1339
 
            if base_pair == other_pair:
1340
 
                winner = 'this'
1341
 
            else:
1342
 
                # We delayed evaluating this_pair as long as we can to avoid
1343
 
                # unnecessary sha1 calculation
1344
 
                this_pair = contents_pair(self.this_tree)
1345
 
                winner = self._three_way(base_pair, other_pair, this_pair)
1346
 
        if winner == 'this':
1347
 
            # No interesting changes introduced by OTHER
1348
 
            return "unmodified"
1349
 
        # We have a hypothetical conflict, but if we have files, then we
1350
 
        # can try to merge the content
1351
 
        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':
1440
 
            # 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
1452
 
        else:
1453
 
            return 'not_applicable', None
 
822
        if base_pair == other_pair:
 
823
            # OTHER introduced no changes
 
824
            return "unmodified"
 
825
        this_pair = contents_pair(self.this_tree)
 
826
        if this_pair == other_pair:
 
827
            # THIS and OTHER introduced the same changes
 
828
            return "unmodified"
 
829
        else:
 
830
            trans_id = self.tt.trans_id_file_id(file_id)
 
831
            if this_pair == base_pair:
 
832
                # only OTHER introduced changes
 
833
                if file_id in self.this_tree:
 
834
                    # Remove any existing contents
 
835
                    self.tt.delete_contents(trans_id)
 
836
                if file_id in self.other_tree:
 
837
                    # OTHER changed the file
 
838
                    create_by_entry(self.tt, 
 
839
                                    self.other_tree.inventory[file_id], 
 
840
                                    self.other_tree, trans_id)
 
841
                    if file_id not in self.this_tree.inventory:
 
842
                        self.tt.version_file(file_id, trans_id)
 
843
                    return "modified"
 
844
                elif file_id in self.this_tree.inventory:
 
845
                    # OTHER deleted the file
 
846
                    self.tt.unversion_file(trans_id)
 
847
                    return "deleted"
 
848
            #BOTH THIS and OTHER introduced changes; scalar conflict
 
849
            elif this_pair[0] == "file" and other_pair[0] == "file":
 
850
                # THIS and OTHER are both files, so text merge.  Either
 
851
                # BASE is a file, or both converted to files, so at least we
 
852
                # have agreement that output should be a file.
 
853
                try:
 
854
                    self.text_merge(file_id, trans_id)
 
855
                except BinaryFile:
 
856
                    return contents_conflict()
 
857
                if file_id not in self.this_tree.inventory:
 
858
                    self.tt.version_file(file_id, trans_id)
 
859
                try:
 
860
                    self.tt.tree_kind(trans_id)
 
861
                    self.tt.delete_contents(trans_id)
 
862
                except NoSuchFile:
 
863
                    pass
 
864
                return "modified"
 
865
            else:
 
866
                # Scalar conflict, can't text merge.  Dump conflicts
 
867
                return contents_conflict()
1454
868
 
1455
869
    def get_lines(self, tree, file_id):
1456
870
        """Return the lines in a file, or an empty list."""
1457
 
        if tree.has_id(file_id):
 
871
        if file_id in tree:
1458
872
            return tree.get_file(file_id).readlines()
1459
873
        else:
1460
874
            return []
1463
877
        """Perform a three-way text merge on a file_id"""
1464
878
        # it's possible that we got here with base as a different type.
1465
879
        # if so, we just want two-way text conflicts.
1466
 
        if self.base_tree.has_id(file_id) and \
 
880
        if file_id in self.base_tree and \
1467
881
            self.base_tree.kind(file_id) == "file":
1468
882
            base_lines = self.get_lines(self.base_tree, file_id)
1469
883
        else:
1470
884
            base_lines = []
1471
885
        other_lines = self.get_lines(self.other_tree, file_id)
1472
886
        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)
 
887
        m3 = Merge3(base_lines, this_lines, other_lines,
 
888
                    is_cherrypick=self.cherrypick)
1475
889
        start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
1476
890
        if self.show_base is True:
1477
891
            base_marker = '|' * 7
1480
894
 
1481
895
        def iter_merge3(retval):
1482
896
            retval["text_conflicts"] = False
1483
 
            for line in m3.merge_lines(name_a = "TREE",
1484
 
                                       name_b = "MERGE-SOURCE",
 
897
            for line in m3.merge_lines(name_a = "TREE", 
 
898
                                       name_b = "MERGE-SOURCE", 
1485
899
                                       name_base = "BASE-REVISION",
1486
 
                                       start_marker=start_marker,
 
900
                                       start_marker=start_marker, 
1487
901
                                       base_marker=base_marker,
1488
902
                                       reprocess=self.reprocess):
1489
903
                if line.startswith(start_marker):
1498
912
            self._raw_conflicts.append(('text conflict', trans_id))
1499
913
            name = self.tt.final_name(trans_id)
1500
914
            parent_id = self.tt.final_parent(trans_id)
1501
 
            file_group = self._dump_conflicts(name, parent_id, file_id,
 
915
            file_group = self._dump_conflicts(name, parent_id, file_id, 
1502
916
                                              this_lines, base_lines,
1503
917
                                              other_lines)
1504
918
            file_group.append(trans_id)
1505
919
 
1506
 
    def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
 
920
    def _dump_conflicts(self, name, parent_id, file_id, this_lines=None, 
1507
921
                        base_lines=None, other_lines=None, set_version=False,
1508
922
                        no_base=False):
1509
923
        """Emit conflict files.
1511
925
        determined automatically.  If set_version is true, the .OTHER, .THIS
1512
926
        or .BASE (in that order) will be created as versioned files.
1513
927
        """
1514
 
        data = [('OTHER', self.other_tree, other_lines),
 
928
        data = [('OTHER', self.other_tree, other_lines), 
1515
929
                ('THIS', self.this_tree, this_lines)]
1516
930
        if not no_base:
1517
931
            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
932
        versioned = False
1533
933
        file_group = []
1534
934
        for suffix, tree, lines in data:
1535
 
            if tree.has_id(file_id):
 
935
            if file_id in tree:
1536
936
                trans_id = self._conflict_file(name, parent_id, tree, file_id,
1537
 
                                               suffix, lines, filter_tree_path)
 
937
                                               suffix, lines)
1538
938
                file_group.append(trans_id)
1539
939
                if set_version and not versioned:
1540
940
                    self.tt.version_file(file_id, trans_id)
1541
941
                    versioned = True
1542
942
        return file_group
1543
 
 
1544
 
    def _conflict_file(self, name, parent_id, tree, file_id, suffix,
1545
 
                       lines=None, filter_tree_path=None):
 
943
           
 
944
    def _conflict_file(self, name, parent_id, tree, file_id, suffix, 
 
945
                       lines=None):
1546
946
        """Emit a single conflict file."""
1547
947
        name = name + '.' + suffix
1548
948
        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)
 
949
        entry = tree.inventory[file_id]
 
950
        create_by_entry(self.tt, entry, tree, trans_id, lines)
1551
951
        return trans_id
1552
952
 
1553
953
    def merge_executable(self, file_id, file_status):
1554
954
        """Perform a merge on the execute bit."""
1555
955
        executable = [self.executable(t, file_id) for t in (self.base_tree,
1556
956
                      self.other_tree, self.this_tree)]
1557
 
        self._merge_executable(file_id, executable, file_status,
1558
 
                               resolver=self._three_way)
 
957
        self._merge_executable(file_id, executable, file_status)
1559
958
 
1560
 
    def _merge_executable(self, file_id, executable, file_status,
1561
 
                          resolver):
 
959
    def _merge_executable(self, file_id, executable, file_status):
1562
960
        """Perform a merge on the execute bit."""
1563
961
        base_executable, other_executable, this_executable = executable
1564
962
        if file_status == "deleted":
1565
963
            return
1566
 
        winner = resolver(*executable)
 
964
        winner = self._three_way(*executable)
1567
965
        if winner == "conflict":
1568
966
        # There must be a None in here, if we have a conflict, but we
1569
967
        # need executability since file status was not deleted.
1577
975
        try:
1578
976
            if self.tt.final_kind(trans_id) != "file":
1579
977
                return
1580
 
        except errors.NoSuchFile:
 
978
        except NoSuchFile:
1581
979
            return
1582
980
        if winner == "this":
1583
981
            executability = this_executable
1584
982
        else:
1585
 
            if self.other_tree.has_id(file_id):
 
983
            if file_id in self.other_tree:
1586
984
                executability = other_executable
1587
 
            elif self.this_tree.has_id(file_id):
 
985
            elif file_id in self.this_tree:
1588
986
                executability = this_executable
1589
 
            elif self.base_tree_has_id(file_id):
 
987
            elif file_id in self.base_tree:
1590
988
                executability = base_executable
1591
989
        if executability is not None:
1592
990
            trans_id = self.tt.trans_id_file_id(file_id)
1594
992
 
1595
993
    def cook_conflicts(self, fs_conflicts):
1596
994
        """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)
 
995
        from conflicts import Conflict
 
996
        name_conflicts = {}
 
997
        self.cooked_conflicts.extend(cook_conflicts(fs_conflicts, self.tt))
 
998
        fp = FinalPaths(self.tt)
1600
999
        for conflict in self._raw_conflicts:
1601
1000
            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':
 
1001
            if conflict_type in ('name conflict', 'parent conflict'):
 
1002
                trans_id = conflict[1]
 
1003
                conflict_args = conflict[2:]
 
1004
                if trans_id not in name_conflicts:
 
1005
                    name_conflicts[trans_id] = {}
 
1006
                unique_add(name_conflicts[trans_id], conflict_type, 
 
1007
                           conflict_args)
 
1008
            if conflict_type == 'contents conflict':
1623
1009
                for trans_id in conflict[1]:
1624
1010
                    file_id = self.tt.final_file_id(trans_id)
1625
1011
                    if file_id is not None:
1629
1015
                    if path.endswith(suffix):
1630
1016
                        path = path[:-len(suffix)]
1631
1017
                        break
1632
 
                c = _mod_conflicts.Conflict.factory(conflict_type,
1633
 
                                                    path=path, file_id=file_id)
1634
 
            elif conflict_type == 'text conflict':
 
1018
                c = Conflict.factory(conflict_type, path=path, file_id=file_id)
 
1019
                self.cooked_conflicts.append(c)
 
1020
            if conflict_type == 'text conflict':
1635
1021
                trans_id = conflict[1]
1636
1022
                path = fp.get_path(trans_id)
1637
1023
                file_id = self.tt.final_file_id(trans_id)
1638
 
                c = _mod_conflicts.Conflict.factory(conflict_type,
1639
 
                                                    path=path, file_id=file_id)
 
1024
                c = Conflict.factory(conflict_type, path=path, file_id=file_id)
 
1025
                self.cooked_conflicts.append(c)
 
1026
 
 
1027
        for trans_id, conflicts in name_conflicts.iteritems():
 
1028
            try:
 
1029
                this_parent, other_parent = conflicts['parent conflict']
 
1030
                if this_parent == other_parent:
 
1031
                    raise AssertionError()
 
1032
            except KeyError:
 
1033
                this_parent = other_parent = \
 
1034
                    self.tt.final_file_id(self.tt.final_parent(trans_id))
 
1035
            try:
 
1036
                this_name, other_name = conflicts['name conflict']
 
1037
                if this_name == other_name:
 
1038
                    raise AssertionError()
 
1039
            except KeyError:
 
1040
                this_name = other_name = self.tt.final_name(trans_id)
 
1041
            other_path = fp.get_path(trans_id)
 
1042
            if this_parent is not None and this_name is not None:
 
1043
                this_parent_path = \
 
1044
                    fp.get_path(self.tt.trans_id_file_id(this_parent))
 
1045
                this_path = pathjoin(this_parent_path, this_name)
1640
1046
            else:
1641
 
                raise AssertionError('bad conflict type: %r' % (conflict,))
 
1047
                this_path = "<deleted>"
 
1048
            file_id = self.tt.final_file_id(trans_id)
 
1049
            c = Conflict.factory('path conflict', path=this_path,
 
1050
                                 conflict_path=other_path, file_id=file_id)
1642
1051
            self.cooked_conflicts.append(c)
1643
 
        self.cooked_conflicts.sort(key=_mod_conflicts.Conflict.sort_key)
 
1052
        self.cooked_conflicts.sort(key=Conflict.sort_key)
1644
1053
 
1645
1054
 
1646
1055
class WeaveMerger(Merge3Merger):
1650
1059
    supports_reverse_cherrypick = False
1651
1060
    history_based = True
1652
1061
 
1653
 
    def _generate_merge_plan(self, file_id, base):
1654
 
        return self.this_tree.plan_file_merge(file_id, self.other_tree,
 
1062
    def _merged_lines(self, file_id):
 
1063
        """Generate the merged lines.
 
1064
        There is no distinction between lines that are meant to contain <<<<<<<
 
1065
        and conflicts.
 
1066
        """
 
1067
        if self.cherrypick:
 
1068
            base = self.base_tree
 
1069
        else:
 
1070
            base = None
 
1071
        plan = self.this_tree.plan_file_merge(file_id, self.other_tree,
1655
1072
                                              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
1073
        if 'merge' in debug.debug_flags:
1668
1074
            plan = list(plan)
1669
1075
            trans_id = self.tt.trans_id_file_id(file_id)
1670
1076
            name = self.tt.final_name(trans_id) + '.plan'
1671
 
            contents = ('%11s|%s' % l for l in plan)
 
1077
            contents = ('%10s|%s' % l for l in plan)
1672
1078
            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
 
1079
        textmerge = PlanWeaveMerge(plan, '<<<<<<< TREE\n',
 
1080
            '>>>>>>> MERGE-SOURCE\n')
 
1081
        return textmerge.merge_lines(self.reprocess)
1681
1082
 
1682
1083
    def text_merge(self, file_id, trans_id):
1683
1084
        """Perform a (weave) text merge for a given file and file-id.
1684
1085
        If conflicts are encountered, .THIS and .OTHER files will be emitted,
1685
1086
        and a conflict will be noted.
1686
1087
        """
1687
 
        lines, base_lines = self._merged_lines(file_id)
 
1088
        lines, conflicts = self._merged_lines(file_id)
1688
1089
        lines = list(lines)
1689
 
        # Note we're checking whether the OUTPUT is binary in this case,
 
1090
        # Note we're checking whether the OUTPUT is binary in this case, 
1690
1091
        # because we don't want to get into weave merge guts.
1691
 
        textfile.check_text_lines(lines)
 
1092
        check_text_lines(lines)
1692
1093
        self.tt.create_file(lines, trans_id)
1693
 
        if base_lines is not None:
1694
 
            # Conflict
 
1094
        if conflicts:
1695
1095
            self._raw_conflicts.append(('text conflict', trans_id))
1696
1096
            name = self.tt.final_name(trans_id)
1697
1097
            parent_id = self.tt.final_parent(trans_id)
1698
 
            file_group = self._dump_conflicts(name, parent_id, file_id,
1699
 
                                              no_base=False,
1700
 
                                              base_lines=base_lines)
 
1098
            file_group = self._dump_conflicts(name, parent_id, file_id, 
 
1099
                                              no_base=True)
1701
1100
            file_group.append(trans_id)
1702
1101
 
1703
1102
 
1704
1103
class LCAMerger(WeaveMerger):
1705
1104
 
1706
 
    def _generate_merge_plan(self, file_id, base):
1707
 
        return self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
 
1105
    def _merged_lines(self, file_id):
 
1106
        """Generate the merged lines.
 
1107
        There is no distinction between lines that are meant to contain <<<<<<<
 
1108
        and conflicts.
 
1109
        """
 
1110
        if self.cherrypick:
 
1111
            base = self.base_tree
 
1112
        else:
 
1113
            base = None
 
1114
        plan = self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
1708
1115
                                                  base=base)
 
1116
        if 'merge' in debug.debug_flags:
 
1117
            plan = list(plan)
 
1118
            trans_id = self.tt.trans_id_file_id(file_id)
 
1119
            name = self.tt.final_name(trans_id) + '.plan'
 
1120
            contents = ('%10s|%s' % l for l in plan)
 
1121
            self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
 
1122
        textmerge = PlanWeaveMerge(plan, '<<<<<<< TREE\n',
 
1123
            '>>>>>>> MERGE-SOURCE\n')
 
1124
        return textmerge.merge_lines(self.reprocess)
 
1125
 
1709
1126
 
1710
1127
class Diff3Merger(Merge3Merger):
1711
1128
    """Three-way merger using external diff3 for text merging"""
1712
1129
 
1713
1130
    def dump_file(self, temp_dir, name, tree, file_id):
1714
 
        out_path = osutils.pathjoin(temp_dir, name)
 
1131
        out_path = pathjoin(temp_dir, name)
1715
1132
        out_file = open(out_path, "wb")
1716
1133
        try:
1717
1134
            in_file = tree.get_file(file_id)
1729
1146
        import bzrlib.patch
1730
1147
        temp_dir = osutils.mkdtemp(prefix="bzr-")
1731
1148
        try:
1732
 
            new_file = osutils.pathjoin(temp_dir, "new")
 
1149
            new_file = pathjoin(temp_dir, "new")
1733
1150
            this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
1734
1151
            base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
1735
1152
            other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
1736
1153
            status = bzrlib.patch.diff3(new_file, this, base, other)
1737
1154
            if status not in (0, 1):
1738
 
                raise errors.BzrError("Unhandled diff3 exit code")
 
1155
                raise BzrError("Unhandled diff3 exit code")
1739
1156
            f = open(new_file, 'rb')
1740
1157
            try:
1741
1158
                self.tt.create_file(f, trans_id)
1759
1176
                other_rev_id=None,
1760
1177
                interesting_files=None,
1761
1178
                this_tree=None,
1762
 
                pb=None,
 
1179
                pb=DummyProgress(),
1763
1180
                change_reporter=None):
1764
 
    """Primary interface for merging.
 
1181
    """Primary interface for merging. 
1765
1182
 
1766
 
        typical use is probably
 
1183
        typical use is probably 
1767
1184
        'merge_inner(branch, branch.get_revision_tree(other_revision),
1768
1185
                     branch.get_revision_tree(base_revision))'
1769
1186
        """
1770
1187
    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.")
 
1188
        raise BzrError("bzrlib.merge.merge_inner requires a this_tree "
 
1189
            "parameter as of bzrlib version 0.8.")
1773
1190
    merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1774
1191
                    pb=pb, change_reporter=change_reporter)
1775
1192
    merger.backup_files = backup_files
1788
1205
    get_revision_id = getattr(base_tree, 'get_revision_id', None)
1789
1206
    if get_revision_id is None:
1790
1207
        get_revision_id = base_tree.last_revision
1791
 
    merger.cache_trees_with_revision_ids([other_tree, base_tree, this_tree])
1792
1208
    merger.set_base_revision(get_revision_id(), this_branch)
1793
1209
    return merger.do_merge()
1794
1210
 
1862
1278
 
1863
1279
    def get_lines(self, revisions):
1864
1280
        """Get lines for revisions from the backing VersionedFiles.
1865
 
 
 
1281
        
1866
1282
        :raises RevisionNotPresent: on absent texts.
1867
1283
        """
1868
1284
        keys = [(self._key_prefix + (rev,)) for rev in revisions]
1870
1286
        for record in self.vf.get_record_stream(keys, 'unordered', True):
1871
1287
            if record.storage_kind == 'absent':
1872
1288
                raise errors.RevisionNotPresent(record.key, self.vf)
1873
 
            result[record.key[-1]] = osutils.chunks_to_lines(
1874
 
                record.get_bytes_as('chunked'))
 
1289
            result[record.key[-1]] = osutils.split_lines(
 
1290
                record.get_bytes_as('fulltext'))
1875
1291
        return result
1876
1292
 
1877
1293
    def plan_merge(self):
1993
1409
        super(_PlanMerge, self).__init__(a_rev, b_rev, vf, key_prefix)
1994
1410
        self.a_key = self._key_prefix + (self.a_rev,)
1995
1411
        self.b_key = self._key_prefix + (self.b_rev,)
1996
 
        self.graph = _mod_graph.Graph(self.vf)
 
1412
        self.graph = Graph(self.vf)
1997
1413
        heads = self.graph.heads((self.a_key, self.b_key))
1998
1414
        if len(heads) == 1:
1999
1415
            # one side dominates, so we can just return its values, yay for
2004
1420
                other = b_rev
2005
1421
            else:
2006
1422
                other = a_rev
2007
 
            trace.mutter('found dominating revision for %s\n%s > %s', self.vf,
2008
 
                         self._head_key[-1], other)
 
1423
            mutter('found dominating revision for %s\n%s > %s', self.vf,
 
1424
                   self._head_key[-1], other)
2009
1425
            self._weave = None
2010
1426
        else:
2011
1427
            self._head_key = None
2025
1441
        while True:
2026
1442
            next_lcas = self.graph.find_lca(*cur_ancestors)
2027
1443
            # Map a plain NULL_REVISION to a simple no-ancestors
2028
 
            if next_lcas == set([_mod_revision.NULL_REVISION]):
 
1444
            if next_lcas == set([NULL_REVISION]):
2029
1445
                next_lcas = ()
2030
1446
            # Order the lca's based on when they were merged into the tip
2031
1447
            # While the actual merge portion of weave merge uses a set() of
2043
1459
            elif len(next_lcas) > 2:
2044
1460
                # More than 2 lca's, fall back to grabbing all nodes between
2045
1461
                # 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)
 
1462
                mutter('More than 2 LCAs, falling back to all nodes for:'
 
1463
                       ' %s, %s\n=> %s', self.a_key, self.b_key, cur_ancestors)
2049
1464
                cur_lcas = next_lcas
2050
1465
                while len(cur_lcas) > 1:
2051
1466
                    cur_lcas = self.graph.find_lca(*cur_lcas)
2054
1469
                    unique_lca = None
2055
1470
                else:
2056
1471
                    unique_lca = list(cur_lcas)[0]
2057
 
                    if unique_lca == _mod_revision.NULL_REVISION:
 
1472
                    if unique_lca == NULL_REVISION:
2058
1473
                        # find_lca will return a plain 'NULL_REVISION' rather
2059
1474
                        # than a key tuple when there is no common ancestor, we
2060
1475
                        # prefer to just use None, because it doesn't confuse
2068
1483
 
2069
1484
    def _find_unique_parents(self, tip_keys, base_key):
2070
1485
        """Find ancestors of tip that aren't ancestors of base.
2071
 
 
 
1486
        
2072
1487
        :param tip_keys: Nodes that are interesting
2073
1488
        :param base_key: Cull all ancestors of this node
2074
1489
        :return: The parent map for all revisions between tip_keys and
2083
1498
            # We remove NULL_REVISION because it isn't a proper tuple key, and
2084
1499
            # thus confuses things like _get_interesting_texts, and our logic
2085
1500
            # 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)
 
1501
            if NULL_REVISION in parent_map:
 
1502
                parent_map.pop(NULL_REVISION)
2088
1503
        else:
2089
1504
            interesting = set()
2090
1505
            for tip in tip_keys:
2134
1549
    @staticmethod
2135
1550
    def _prune_tails(parent_map, child_map, tails_to_remove):
2136
1551
        """Remove tails from the parent map.
2137
 
 
 
1552
        
2138
1553
        This will remove the supplied revisions until no more children have 0
2139
1554
        parents.
2140
1555
 
2242
1657
        lcas = graph.find_lca(key_prefix + (a_rev,), key_prefix + (b_rev,))
2243
1658
        self.lcas = set()
2244
1659
        for lca in lcas:
2245
 
            if lca == _mod_revision.NULL_REVISION:
 
1660
            if lca == NULL_REVISION:
2246
1661
                self.lcas.add(lca)
2247
1662
            else:
2248
1663
                self.lcas.add(lca[-1])