~bzr-pqm/bzr/bzr.dev

4988.1.1 by John Arbash Meinel
Merge the per-file-hook updates.
1
# Copyright (C) 2005-2010 Canonical Ltd
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
2
#
1110 by Martin Pool
- merge aaron's merge improvements:
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
7
#
1110 by Martin Pool
- merge aaron's merge improvements:
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
# GNU General Public License for more details.
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
12
#
1110 by Martin Pool
- merge aaron's merge improvements:
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
4183.7.1 by Sabin Iacob
update FSF mailing address
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
1110 by Martin Pool
- merge aaron's merge improvements:
16
4961.2.11 by Martin Pool
Pull out pbs and ProgressPhases stored in object state; just use them in single functions
17
import warnings
1545.2.3 by Aaron Bentley
Updated following j-a-meinel's comments
18
5246.2.15 by Andrew Bennetts
Lazy import most things in merge.py, to minimise the impact of plugins that need to import bzrlib.merge to install a hook.
19
from bzrlib.lazy_import import lazy_import
20
lazy_import(globals(), """
1996.3.18 by John Arbash Meinel
Now that mkdtemp and rmtree are lazy, they should not be directly improted.
21
from bzrlib import (
4721.3.1 by Vincent Ladeuil
Cleanup imports.
22
    branch as _mod_branch,
23
    conflicts as _mod_conflicts,
1551.19.17 by Aaron Bentley
Add debugging flag for merges
24
    debug,
5246.2.9 by Andrew Bennetts
Make all the existing tests pass.
25
    generate_ids,
3514.2.14 by John Arbash Meinel
Bring in the code to collapse linear portions of the graph.
26
    graph as _mod_graph,
4721.3.1 by Vincent Ladeuil
Cleanup imports.
27
    merge3,
1996.3.18 by John Arbash Meinel
Now that mkdtemp and rmtree are lazy, they should not be directly improted.
28
    osutils,
1551.15.46 by Aaron Bentley
Move plan merge to tree
29
    patiencediff,
2598.5.1 by Aaron Bentley
Start eliminating the use of None to indicate null revision
30
    revision as _mod_revision,
4721.3.1 by Vincent Ladeuil
Cleanup imports.
31
    textfile,
32
    trace,
33
    transform,
3514.4.5 by John Arbash Meinel
Initial work on _entries_lca.
34
    tree as _mod_tree,
3514.2.5 by John Arbash Meinel
Switch to the get_parent_map design I had settled on.
35
    tsort,
4721.3.1 by Vincent Ladeuil
Cleanup imports.
36
    ui,
5246.2.15 by Andrew Bennetts
Lazy import most things in merge.py, to minimise the impact of plugins that need to import bzrlib.merge to install a hook.
37
    versionedfile,
5246.2.27 by Andrew Bennetts
Remove merge_into_helper for now, as it currently has no callers.
38
    workingtree,
1996.3.18 by John Arbash Meinel
Now that mkdtemp and rmtree are lazy, they should not be directly improted.
39
    )
4797.16.1 by Andrew Bennetts
Replace many try/finally blocks in merge.py with more robust OperationWithCleanups.
40
from bzrlib.cleanup import OperationWithCleanups
5246.2.15 by Andrew Bennetts
Lazy import most things in merge.py, to minimise the impact of plugins that need to import bzrlib.merge to install a hook.
41
""")
42
from bzrlib import (
43
    decorators,
5246.2.18 by Andrew Bennetts
Fix traceback if source path does not exist.
44
    errors,
5246.2.15 by Andrew Bennetts
Lazy import most things in merge.py, to minimise the impact of plugins that need to import bzrlib.merge to install a hook.
45
    hooks,
46
    )
4721.3.2 by Vincent Ladeuil
Simplify mutable_tree.has_changes() and update call sites.
47
from bzrlib.symbol_versioning import (
48
    deprecated_in,
49
    deprecated_method,
50
    )
1545.2.6 by Aaron Bentley
Removed _merge, renamed MergeConflictHandler to _MergeConflictHandler
51
# TODO: Report back as changes are merged in
52
2325.3.1 by John Arbash Meinel
New helper function for merge, which allows us to re-use the existing workingtree, rather than opening it again.
53
1185.35.4 by Aaron Bentley
Implemented remerge
54
def transform_tree(from_tree, to_tree, interesting_ids=None):
4595.13.1 by Alexander Belchenko
[cherrypick revno.4635 from bzr.dev] (robertc) Fix many locking errors on windows due to a small bug in merge.transform_tree. (Robert Collins)
55
    from_tree.lock_tree_write()
4797.16.1 by Andrew Bennetts
Replace many try/finally blocks in merge.py with more robust OperationWithCleanups.
56
    operation = OperationWithCleanups(merge_inner)
57
    operation.add_cleanup(from_tree.unlock)
58
    operation.run_simple(from_tree.branch, to_tree, from_tree,
59
        ignore_zero=True, interesting_ids=interesting_ids, this_tree=from_tree)
1185.12.76 by Aaron Bentley
Refactored merge and merge_inner to use Merger
60
1457.1.12 by Robert Collins
Update comment to reflect author.
61
4869.3.1 by Andrew Bennetts
Basic per-file merge hook.
62
class MergeHooks(hooks.Hooks):
63
64
    def __init__(self):
65
        hooks.Hooks.__init__(self)
66
        self.create_hook(hooks.HookPoint('merge_file_content',
4797.5.1 by Robert Collins
Support state on per-file merging to permit more efficient use of configuration data.
67
            "Called with a bzrlib.merge.Merger object to create a per file "
68
            "merge object when starting a merge. "
69
            "Should return either None or a subclass of "
70
            "``bzrlib.merge.AbstractPerFileMerger``. "
71
            "Such objects will then be called per file "
72
            "that needs to be merged (including when one "
73
            "side has deleted the file and the other has changed it). "
74
            "See the AbstractPerFileMerger API docs for details on how it is "
75
            "used by merge.",
4869.3.9 by Andrew Bennetts
Document hook point better
76
            (2, 1), None))
4869.3.1 by Andrew Bennetts
Basic per-file merge hook.
77
78
4797.5.1 by Robert Collins
Support state on per-file merging to permit more efficient use of configuration data.
79
class AbstractPerFileMerger(object):
80
    """PerFileMerger objects are used by plugins extending merge for bzrlib.
81
82
    See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
83
    
84
    :ivar merger: The Merge3Merger performing the merge.
85
    """
86
87
    def __init__(self, merger):
88
        """Create a PerFileMerger for use with merger."""
89
        self.merger = merger
90
91
    def merge_contents(self, merge_params):
92
        """Attempt to merge the contents of a single file.
93
        
94
        :param merge_params: A bzrlib.merge.MergeHookParams
95
        :return : A tuple of (status, chunks), where status is one of
96
            'not_applicable', 'success', 'conflicted', or 'delete'.  If status
97
            is 'success' or 'conflicted', then chunks should be an iterable of
98
            strings for the new file contents.
99
        """
100
        return ('not applicable', None)
101
102
5168.2.2 by Andrew Bennetts
Create a PerFileMerger helper class that is midway between AbstractPerFileMerger and ConfigurableFileMerger. It allows the example merge plugin in the docs (the always conflict *.xml files) to be much, much simpler.
103
class PerFileMerger(AbstractPerFileMerger):
104
    """Merge individual files when self.file_matches returns True.
105
106
    This class is intended to be subclassed.  The file_matches and
107
    merge_matching methods should be overridden with concrete implementations.
108
    """
109
110
    def file_matches(self, params):
111
        """Return True if merge_matching should be called on this file.
112
113
        Only called with merges of plain files with no clear winner.
114
115
        Subclasses must override this.
116
        """
117
        raise NotImplementedError(self.file_matches)
118
119
    def get_filename(self, params, tree):
120
        """Lookup the filename (i.e. basename, not path), given a Tree (e.g.
121
        self.merger.this_tree) and a MergeHookParams.
122
        """
5168.2.3 by Andrew Bennetts
Change implementation of get_filename as suggested by John.
123
        return osutils.basename(tree.id2path(params.file_id))
5168.2.2 by Andrew Bennetts
Create a PerFileMerger helper class that is midway between AbstractPerFileMerger and ConfigurableFileMerger. It allows the example merge plugin in the docs (the always conflict *.xml files) to be much, much simpler.
124
125
    def get_filepath(self, params, tree):
126
        """Calculate the path to the file in a tree.
127
128
        :param params: A MergeHookParams describing the file to merge
129
        :param tree: a Tree, e.g. self.merger.this_tree.
130
        """
131
        return tree.id2path(params.file_id)
132
133
    def merge_contents(self, params):
134
        """Merge the contents of a single file."""
135
        # Check whether this custom merge logic should be used.
136
        if (
137
            # OTHER is a straight winner, rely on default merge.
138
            params.winner == 'other' or
139
            # THIS and OTHER aren't both files.
140
            not params.is_file_merge() or
141
            # The filename doesn't match *.xml
142
            not self.file_matches(params)):
143
            return 'not_applicable', None
5168.2.3 by Andrew Bennetts
Change implementation of get_filename as suggested by John.
144
        return self.merge_matching(params)
5168.2.2 by Andrew Bennetts
Create a PerFileMerger helper class that is midway between AbstractPerFileMerger and ConfigurableFileMerger. It allows the example merge plugin in the docs (the always conflict *.xml files) to be much, much simpler.
145
146
    def merge_matching(self, params):
147
        """Merge the contents of a single file that has matched the criteria
148
        in PerFileMerger.merge_contents (is a conflict, is a file,
149
        self.file_matches is True).
150
151
        Subclasses must override this.
152
        """
153
        raise NotImplementedError(self.merge_matching)
154
155
156
class ConfigurableFileMerger(PerFileMerger):
4797.5.2 by Robert Collins
Refactor NewsMerger into a reusable base class merge.ConfigurableFileMerger.
157
    """Merge individual files when configured via a .conf file.
158
159
    This is a base class for concrete custom file merging logic. Concrete
160
    classes should implement ``merge_text``.
161
4797.9.1 by Vincent Ladeuil
No test was exercising the faulty code path.
162
    See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
163
    
4797.5.2 by Robert Collins
Refactor NewsMerger into a reusable base class merge.ConfigurableFileMerger.
164
    :ivar affected_files: The configured file paths to merge.
4797.9.1 by Vincent Ladeuil
No test was exercising the faulty code path.
165
4797.5.3 by Robert Collins
Tweak ConfigurableFileMerger to use class variables rather than requiring __init__ wrapping as future proofing for helper functions.
166
    :cvar name_prefix: The prefix to use when looking up configuration
4797.9.1 by Vincent Ladeuil
No test was exercising the faulty code path.
167
        details. <name_prefix>_merge_files describes the files targeted by the
168
        hook for example.
169
        
4797.5.3 by Robert Collins
Tweak ConfigurableFileMerger to use class variables rather than requiring __init__ wrapping as future proofing for helper functions.
170
    :cvar default_files: The default file paths to merge when no configuration
4797.5.2 by Robert Collins
Refactor NewsMerger into a reusable base class merge.ConfigurableFileMerger.
171
        is present.
172
    """
173
4797.5.3 by Robert Collins
Tweak ConfigurableFileMerger to use class variables rather than requiring __init__ wrapping as future proofing for helper functions.
174
    name_prefix = None
175
    default_files = None
176
177
    def __init__(self, merger):
4797.5.2 by Robert Collins
Refactor NewsMerger into a reusable base class merge.ConfigurableFileMerger.
178
        super(ConfigurableFileMerger, self).__init__(merger)
179
        self.affected_files = None
4797.5.3 by Robert Collins
Tweak ConfigurableFileMerger to use class variables rather than requiring __init__ wrapping as future proofing for helper functions.
180
        self.default_files = self.__class__.default_files or []
181
        self.name_prefix = self.__class__.name_prefix
182
        if self.name_prefix is None:
183
            raise ValueError("name_prefix must be set.")
4797.5.2 by Robert Collins
Refactor NewsMerger into a reusable base class merge.ConfigurableFileMerger.
184
5168.2.2 by Andrew Bennetts
Create a PerFileMerger helper class that is midway between AbstractPerFileMerger and ConfigurableFileMerger. It allows the example merge plugin in the docs (the always conflict *.xml files) to be much, much simpler.
185
    def file_matches(self, params):
4797.9.1 by Vincent Ladeuil
No test was exercising the faulty code path.
186
        """Check whether the file should call the merge hook.
187
188
        <name_prefix>_merge_files configuration variable is a list of files
189
        that should use the hook.
190
        """
4797.5.2 by Robert Collins
Refactor NewsMerger into a reusable base class merge.ConfigurableFileMerger.
191
        affected_files = self.affected_files
192
        if affected_files is None:
4797.21.1 by Aaron Bentley
Fix merge when this_tree is not a WorkingTree.
193
            config = self.merger.this_branch.get_config()
4797.5.2 by Robert Collins
Refactor NewsMerger into a reusable base class merge.ConfigurableFileMerger.
194
            # Until bzr provides a better policy for caching the config, we
195
            # just add the part we're interested in to the params to avoid
196
            # reading the config files repeatedly (bazaar.conf, location.conf,
197
            # branch.conf).
198
            config_key = self.name_prefix + '_merge_files'
199
            affected_files = config.get_user_option_as_list(config_key)
200
            if affected_files is None:
201
                # If nothing was specified in the config, use the default.
202
                affected_files = self.default_files
203
            self.affected_files = affected_files
204
        if affected_files:
5168.2.2 by Andrew Bennetts
Create a PerFileMerger helper class that is midway between AbstractPerFileMerger and ConfigurableFileMerger. It allows the example merge plugin in the docs (the always conflict *.xml files) to be much, much simpler.
205
            filepath = self.get_filepath(params, self.merger.this_tree)
206
            if filepath in affected_files:
4797.5.2 by Robert Collins
Refactor NewsMerger into a reusable base class merge.ConfigurableFileMerger.
207
                return True
208
        return False
209
5168.2.2 by Andrew Bennetts
Create a PerFileMerger helper class that is midway between AbstractPerFileMerger and ConfigurableFileMerger. It allows the example merge plugin in the docs (the always conflict *.xml files) to be much, much simpler.
210
    def merge_matching(self, params):
4797.9.1 by Vincent Ladeuil
No test was exercising the faulty code path.
211
        return self.merge_text(params)
4797.5.2 by Robert Collins
Refactor NewsMerger into a reusable base class merge.ConfigurableFileMerger.
212
213
    def merge_text(self, params):
214
        """Merge the byte contents of a single file.
215
216
        This is called after checking that the merge should be performed in
217
        merge_contents, and it should behave as per
218
        ``bzrlib.merge.AbstractPerFileMerger.merge_contents``.
219
        """
220
        raise NotImplementedError(self.merge_text)
221
222
4869.3.1 by Andrew Bennetts
Basic per-file merge hook.
223
class MergeHookParams(object):
4869.3.11 by Andrew Bennetts
More docs.
224
    """Object holding parameters passed to merge_file_content hooks.
225
4797.5.1 by Robert Collins
Support state on per-file merging to permit more efficient use of configuration data.
226
    There are some fields hooks can access:
4869.3.11 by Andrew Bennetts
More docs.
227
228
    :ivar file_id: the file ID of the file being merged
4869.3.24 by Andrew Bennetts
Mention 'winner' attribute in MergeHookParams' docstring.
229
    :ivar trans_id: the transform ID for the merge of this file
4869.3.21 by Andrew Bennetts
Pass kinds (not pairs) to MergeHookParams.
230
    :ivar this_kind: kind of file_id in 'this' tree
231
    :ivar other_kind: kind of file_id in 'other' tree
4869.3.24 by Andrew Bennetts
Mention 'winner' attribute in MergeHookParams' docstring.
232
    :ivar winner: one of 'this', 'other', 'conflict'
4869.3.11 by Andrew Bennetts
More docs.
233
    """
4869.3.1 by Andrew Bennetts
Basic per-file merge hook.
234
4869.3.21 by Andrew Bennetts
Pass kinds (not pairs) to MergeHookParams.
235
    def __init__(self, merger, file_id, trans_id, this_kind, other_kind,
4869.3.16 by Andrew Bennetts
Move handling of winner==OTHER case into generic hook path too.
236
            winner):
4797.5.1 by Robert Collins
Support state on per-file merging to permit more efficient use of configuration data.
237
        self._merger = merger
4869.3.1 by Andrew Bennetts
Basic per-file merge hook.
238
        self.file_id = file_id
239
        self.trans_id = trans_id
4869.3.21 by Andrew Bennetts
Pass kinds (not pairs) to MergeHookParams.
240
        self.this_kind = this_kind
241
        self.other_kind = other_kind
4869.3.16 by Andrew Bennetts
Move handling of winner==OTHER case into generic hook path too.
242
        self.winner = winner
4869.3.34 by Vincent Ladeuil
Finish the patch based on reviews.
243
4869.3.15 by Andrew Bennetts
Refactor so that the default text merge is the final hook tried. Other hooks can now invoke it directly via merger.default_text_merge if they wish.
244
    def is_file_merge(self):
4869.3.21 by Andrew Bennetts
Pass kinds (not pairs) to MergeHookParams.
245
        """True if this_kind and other_kind are both 'file'."""
246
        return self.this_kind == 'file' and self.other_kind == 'file'
4869.3.34 by Vincent Ladeuil
Finish the patch based on reviews.
247
4869.3.13 by Andrew Bennetts
Add simple cachedproperty decorator, and add {this,other,base}_lines cachedproperties to MergeHookParams.
248
    @decorators.cachedproperty
249
    def base_lines(self):
250
        """The lines of the 'base' version of the file."""
4797.5.1 by Robert Collins
Support state on per-file merging to permit more efficient use of configuration data.
251
        return self._merger.get_lines(self._merger.base_tree, self.file_id)
4869.3.13 by Andrew Bennetts
Add simple cachedproperty decorator, and add {this,other,base}_lines cachedproperties to MergeHookParams.
252
253
    @decorators.cachedproperty
254
    def this_lines(self):
255
        """The lines of the 'this' version of the file."""
4797.5.1 by Robert Collins
Support state on per-file merging to permit more efficient use of configuration data.
256
        return self._merger.get_lines(self._merger.this_tree, self.file_id)
4869.3.13 by Andrew Bennetts
Add simple cachedproperty decorator, and add {this,other,base}_lines cachedproperties to MergeHookParams.
257
258
    @decorators.cachedproperty
259
    def other_lines(self):
260
        """The lines of the 'other' version of the file."""
4797.5.1 by Robert Collins
Support state on per-file merging to permit more efficient use of configuration data.
261
        return self._merger.get_lines(self._merger.other_tree, self.file_id)
4869.3.13 by Andrew Bennetts
Add simple cachedproperty decorator, and add {this,other,base}_lines cachedproperties to MergeHookParams.
262
4869.3.1 by Andrew Bennetts
Basic per-file merge hook.
263
1185.12.76 by Aaron Bentley
Refactored merge and merge_inner to use Merger
264
class Merger(object):
4869.3.1 by Andrew Bennetts
Basic per-file merge hook.
265
266
    hooks = MergeHooks()
267
2255.2.31 by Robert Collins
Work in progress to make merge_inner work with dirstate trees.
268
    def __init__(self, this_branch, other_tree=None, base_tree=None,
1551.21.8 by Aaron Bentley
Remove now-redundant DummyProgress from Merger.__init__
269
                 this_tree=None, pb=None, change_reporter=None,
3146.5.3 by Aaron Bentley
Avoid retrieving revision graph twice
270
                 recurse='down', revision_graph=None):
1185.12.76 by Aaron Bentley
Refactored merge and merge_inner to use Merger
271
        object.__init__(self)
272
        self.this_branch = this_branch
2598.5.4 by Aaron Bentley
Restore original Branch.last_revision behavior, fix bits that care
273
        self.this_basis = _mod_revision.ensure_null(
274
            this_branch.last_revision())
1185.12.76 by Aaron Bentley
Refactored merge and merge_inner to use Merger
275
        self.this_rev_id = None
1534.4.26 by Robert Collins
Move working tree initialisation out from Branch.initialize, deprecated Branch.initialize to Branch.create.
276
        self.this_tree = this_tree
1185.12.83 by Aaron Bentley
Preliminary weave merge support
277
        self.this_revision_tree = None
1185.35.5 by Aaron Bentley
Made weave merge succeed if interesting files match history
278
        self.this_basis_tree = None
1185.12.76 by Aaron Bentley
Refactored merge and merge_inner to use Merger
279
        self.other_tree = other_tree
2100.3.29 by Aaron Bentley
Get merge working initially
280
        self.other_branch = None
1185.12.76 by Aaron Bentley
Refactored merge and merge_inner to use Merger
281
        self.base_tree = base_tree
282
        self.ignore_zero = False
283
        self.backup_files = False
284
        self.interesting_ids = None
2590.2.5 by Aaron Bentley
Allow selected files to be specified instead of selected ids
285
        self.interesting_files = None
1185.12.76 by Aaron Bentley
Refactored merge and merge_inner to use Merger
286
        self.show_base = False
1185.24.3 by Aaron Bentley
Integrated reprocessing into the rest of the merge stuff
287
        self.reprocess = False
4961.2.11 by Martin Pool
Pull out pbs and ProgressPhases stored in object state; just use them in single functions
288
        if pb is not None:
289
            warnings.warn("pb parameter to Merger() is deprecated and ignored")
1551.2.32 by Aaron Bentley
Handle progress phases more nicely in merge
290
        self.pp = None
2100.3.29 by Aaron Bentley
Get merge working initially
291
        self.recurse = recurse
1551.11.9 by Aaron Bentley
Apply change reporting to merge
292
        self.change_reporter = change_reporter
2590.2.11 by Aaron Bentley
Aggressively cache trees, use dirstate. re-mplement _add_parent.
293
        self._cached_trees = {}
3146.5.3 by Aaron Bentley
Avoid retrieving revision graph twice
294
        self._revision_graph = revision_graph
3146.5.1 by Aaron Bentley
Make merge --uncommitted work with merge-type weave
295
        self._base_is_ancestor = None
296
        self._base_is_other_ancestor = None
3514.4.39 by John Arbash Meinel
Use self._lca_multi_way rather than Merge3Merger._lca_multi_way by Aaron's request.
297
        self._is_criss_cross = None
3514.4.2 by John Arbash Meinel
Extract the lca trees and the base tree when we find a criss-cross
298
        self._lca_trees = None
3146.5.1 by Aaron Bentley
Make merge --uncommitted work with merge-type weave
299
4595.13.2 by Alexander Belchenko
[cherrypick revno 4650 from bzr.dev] Fix shelve on windows. (Robert Collins, #305006)
300
    def cache_trees_with_revision_ids(self, trees):
301
        """Cache any tree in trees if it has a revision_id."""
302
        for maybe_tree in trees:
303
            if maybe_tree is None:
304
                continue
305
            try:
306
                rev_id = maybe_tree.get_revision_id()
307
            except AttributeError:
308
                continue
309
            self._cached_trees[rev_id] = maybe_tree
310
3146.5.1 by Aaron Bentley
Make merge --uncommitted work with merge-type weave
311
    @property
312
    def revision_graph(self):
313
        if self._revision_graph is None:
3146.5.3 by Aaron Bentley
Avoid retrieving revision graph twice
314
            self._revision_graph = self.this_branch.repository.get_graph()
3146.5.1 by Aaron Bentley
Make merge --uncommitted work with merge-type weave
315
        return self._revision_graph
316
317
    def _set_base_is_ancestor(self, value):
318
        self._base_is_ancestor = value
319
320
    def _get_base_is_ancestor(self):
321
        if self._base_is_ancestor is None:
322
            self._base_is_ancestor = self.revision_graph.is_ancestor(
323
                self.base_rev_id, self.this_basis)
324
        return self._base_is_ancestor
325
326
    base_is_ancestor = property(_get_base_is_ancestor, _set_base_is_ancestor)
327
328
    def _set_base_is_other_ancestor(self, value):
329
        self._base_is_other_ancestor = value
330
331
    def _get_base_is_other_ancestor(self):
332
        if self._base_is_other_ancestor is None:
3249.3.1 by John Arbash Meinel
Implement cherrypick support for Merge3
333
            if self.other_basis is None:
334
                return True
335
            self._base_is_other_ancestor = self.revision_graph.is_ancestor(
3146.5.3 by Aaron Bentley
Avoid retrieving revision graph twice
336
                self.base_rev_id, self.other_basis)
3146.5.1 by Aaron Bentley
Make merge --uncommitted work with merge-type weave
337
        return self._base_is_other_ancestor
338
339
    base_is_other_ancestor = property(_get_base_is_other_ancestor,
340
                                      _set_base_is_other_ancestor)
2590.2.11 by Aaron Bentley
Aggressively cache trees, use dirstate. re-mplement _add_parent.
341
1551.15.67 by Aaron Bentley
Stop using _merge_helper for merging
342
    @staticmethod
1551.21.7 by Aaron Bentley
Fix progress warning
343
    def from_uncommitted(tree, other_tree, pb=None, base_tree=None):
1551.15.74 by Aaron Bentley
Textual updates from review
344
        """Return a Merger for uncommitted changes in other_tree.
345
346
        :param tree: The tree to merge into
347
        :param other_tree: The tree to get uncommitted changes from
348
        :param pb: A progress indicator
3363.17.17 by Aaron Bentley
Start testing merging PreviewTree as OTHER
349
        :param base_tree: The basis to use for the merge.  If unspecified,
350
            other_tree.basis_tree() will be used.
1551.15.74 by Aaron Bentley
Textual updates from review
351
        """
3363.17.17 by Aaron Bentley
Start testing merging PreviewTree as OTHER
352
        if base_tree is None:
353
            base_tree = other_tree.basis_tree()
354
        merger = Merger(tree.branch, other_tree, base_tree, tree, pb)
1551.15.67 by Aaron Bentley
Stop using _merge_helper for merging
355
        merger.base_rev_id = merger.base_tree.get_revision_id()
356
        merger.other_rev_id = None
3146.5.1 by Aaron Bentley
Make merge --uncommitted work with merge-type weave
357
        merger.other_basis = merger.base_rev_id
1551.15.67 by Aaron Bentley
Stop using _merge_helper for merging
358
        return merger
359
360
    @classmethod
361
    def from_mergeable(klass, tree, mergeable, pb):
1551.15.74 by Aaron Bentley
Textual updates from review
362
        """Return a Merger for a bundle or merge directive.
363
364
        :param tree: The tree to merge changes into
365
        :param mergeable: A merge directive or bundle
366
        :param pb: A progress indicator
367
        """
1551.15.67 by Aaron Bentley
Stop using _merge_helper for merging
368
        mergeable.install_revisions(tree.branch.repository)
369
        base_revision_id, other_revision_id, verified =\
370
            mergeable.get_merge_request(tree.branch.repository)
3146.5.3 by Aaron Bentley
Avoid retrieving revision graph twice
371
        revision_graph = tree.branch.repository.get_graph()
1551.19.44 by Aaron Bentley
Fix handling of old merge directives with stricter get_parent_map
372
        if base_revision_id is not None:
373
            if (base_revision_id != _mod_revision.NULL_REVISION and
374
                revision_graph.is_ancestor(
375
                base_revision_id, tree.branch.last_revision())):
376
                base_revision_id = None
377
            else:
4721.3.1 by Vincent Ladeuil
Cleanup imports.
378
                trace.warning('Performing cherrypick')
1551.15.67 by Aaron Bentley
Stop using _merge_helper for merging
379
        merger = klass.from_revision_ids(pb, tree, other_revision_id,
3146.5.3 by Aaron Bentley
Avoid retrieving revision graph twice
380
                                         base_revision_id, revision_graph=
381
                                         revision_graph)
1551.15.67 by Aaron Bentley
Stop using _merge_helper for merging
382
        return merger, verified
383
384
    @staticmethod
3249.3.1 by John Arbash Meinel
Implement cherrypick support for Merge3
385
    def from_revision_ids(pb, tree, other, base=None, other_branch=None,
3363.17.1 by Aaron Bentley
Avoid inventory for merge and transform code
386
                          base_branch=None, revision_graph=None,
387
                          tree_branch=None):
1551.15.74 by Aaron Bentley
Textual updates from review
388
        """Return a Merger for revision-ids.
389
3363.17.15 by Aaron Bentley
Update docs
390
        :param pb: A progress indicator
1551.15.74 by Aaron Bentley
Textual updates from review
391
        :param tree: The tree to merge changes into
392
        :param other: The revision-id to use as OTHER
393
        :param base: The revision-id to use as BASE.  If not specified, will
394
            be auto-selected.
395
        :param other_branch: A branch containing the other revision-id.  If
3249.3.1 by John Arbash Meinel
Implement cherrypick support for Merge3
396
            not supplied, tree.branch is used.
1551.15.74 by Aaron Bentley
Textual updates from review
397
        :param base_branch: A branch containing the base revision-id.  If
3249.3.1 by John Arbash Meinel
Implement cherrypick support for Merge3
398
            not supplied, other_branch or tree.branch will be used.
399
        :param revision_graph: If you have a revision_graph precomputed, pass
400
            it in, otherwise it will be created for you.
3363.17.15 by Aaron Bentley
Update docs
401
        :param tree_branch: The branch associated with tree.  If not supplied,
402
            tree.branch will be used.
1551.15.74 by Aaron Bentley
Textual updates from review
403
        """
3363.17.1 by Aaron Bentley
Avoid inventory for merge and transform code
404
        if tree_branch is None:
405
            tree_branch = tree.branch
406
        merger = Merger(tree_branch, this_tree=tree, pb=pb,
3146.5.3 by Aaron Bentley
Avoid retrieving revision graph twice
407
                        revision_graph=revision_graph)
1551.15.67 by Aaron Bentley
Stop using _merge_helper for merging
408
        if other_branch is None:
3249.3.1 by John Arbash Meinel
Implement cherrypick support for Merge3
409
            other_branch = tree.branch
1551.15.67 by Aaron Bentley
Stop using _merge_helper for merging
410
        merger.set_other_revision(other, other_branch)
411
        if base is None:
412
            merger.find_base()
413
        else:
414
            if base_branch is None:
415
                base_branch = other_branch
416
            merger.set_base_revision(base, base_branch)
417
        return merger
418
2590.2.11 by Aaron Bentley
Aggressively cache trees, use dirstate. re-mplement _add_parent.
419
    def revision_tree(self, revision_id, branch=None):
420
        if revision_id not in self._cached_trees:
421
            if branch is None:
422
                branch = self.this_branch
423
            try:
424
                tree = self.this_tree.revision_tree(revision_id)
425
            except errors.NoSuchRevisionInTree:
426
                tree = branch.repository.revision_tree(revision_id)
427
            self._cached_trees[revision_id] = tree
428
        return self._cached_trees[revision_id]
429
2485.8.58 by Vincent Ladeuil
merge bzr.dev@1617
430
    def _get_tree(self, treespec, possible_transports=None):
2590.2.11 by Aaron Bentley
Aggressively cache trees, use dirstate. re-mplement _add_parent.
431
        location, revno = treespec
432
        if revno is None:
433
            tree = workingtree.WorkingTree.open_containing(location)[0]
434
            return tree.branch, tree
4721.3.1 by Vincent Ladeuil
Cleanup imports.
435
        branch = _mod_branch.Branch.open_containing(
436
            location, possible_transports)[0]
2590.2.11 by Aaron Bentley
Aggressively cache trees, use dirstate. re-mplement _add_parent.
437
        if revno == -1:
438
            revision_id = branch.last_revision()
439
        else:
440
            revision_id = branch.get_rev_id(revno)
4721.3.1 by Vincent Ladeuil
Cleanup imports.
441
        revision_id = _mod_revision.ensure_null(revision_id)
2590.2.11 by Aaron Bentley
Aggressively cache trees, use dirstate. re-mplement _add_parent.
442
        return branch, self.revision_tree(revision_id, branch)
1185.12.83 by Aaron Bentley
Preliminary weave merge support
443
4721.3.2 by Vincent Ladeuil
Simplify mutable_tree.has_changes() and update call sites.
444
    @deprecated_method(deprecated_in((2, 1, 0)))
1185.12.83 by Aaron Bentley
Preliminary weave merge support
445
    def ensure_revision_trees(self):
446
        if self.this_revision_tree is None:
2590.2.11 by Aaron Bentley
Aggressively cache trees, use dirstate. re-mplement _add_parent.
447
            self.this_basis_tree = self.revision_tree(self.this_basis)
1185.35.5 by Aaron Bentley
Made weave merge succeed if interesting files match history
448
            if self.this_basis == self.this_rev_id:
449
                self.this_revision_tree = self.this_basis_tree
450
1185.12.83 by Aaron Bentley
Preliminary weave merge support
451
        if self.other_rev_id is None:
452
            other_basis_tree = self.revision_tree(self.other_basis)
4503.1.2 by Vincent Ladeuil
Use tree.has_changes() where appropriate (the test suite caught a
453
            if other_basis_tree.has_changes(self.other_tree):
4869.2.1 by Andrew Bennetts
Trivial improvements to bzrlib/merge.py suggested by pyflakes.
454
                raise errors.WorkingTreeNotRevision(self.this_tree)
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
455
            other_rev_id = self.other_basis
1185.12.83 by Aaron Bentley
Preliminary weave merge support
456
            self.other_tree = other_basis_tree
457
4721.3.2 by Vincent Ladeuil
Simplify mutable_tree.has_changes() and update call sites.
458
    @deprecated_method(deprecated_in((2, 1, 0)))
1185.12.83 by Aaron Bentley
Preliminary weave merge support
459
    def file_revisions(self, file_id):
460
        self.ensure_revision_trees()
461
        def get_id(tree, file_id):
462
            revision_id = tree.inventory[file_id].revision
463
            return revision_id
1185.35.5 by Aaron Bentley
Made weave merge succeed if interesting files match history
464
        if self.this_rev_id is None:
465
            if self.this_basis_tree.get_file_sha1(file_id) != \
466
                self.this_tree.get_file_sha1(file_id):
4721.3.1 by Vincent Ladeuil
Cleanup imports.
467
                raise errors.WorkingTreeNotRevision(self.this_tree)
1185.35.5 by Aaron Bentley
Made weave merge succeed if interesting files match history
468
469
        trees = (self.this_basis_tree, self.other_tree)
1185.12.83 by Aaron Bentley
Preliminary weave merge support
470
        return [get_id(tree, file_id) for tree in trees]
471
4721.3.2 by Vincent Ladeuil
Simplify mutable_tree.has_changes() and update call sites.
472
    @deprecated_method(deprecated_in((2, 1, 0)))
1185.82.44 by Aaron Bentley
Switch to merge_changeset in test suite
473
    def check_basis(self, check_clean, require_commits=True):
474
        if self.this_basis is None and require_commits is True:
4721.3.1 by Vincent Ladeuil
Cleanup imports.
475
            raise errors.BzrCommandError(
476
                "This branch has no commits."
477
                " (perhaps you would prefer 'bzr pull')")
1185.12.76 by Aaron Bentley
Refactored merge and merge_inner to use Merger
478
        if check_clean:
479
            self.compare_basis()
480
            if self.this_basis != self.this_rev_id:
2796.2.1 by Aaron Bentley
Begin work on reconfigure command
481
                raise errors.UncommittedChanges(self.this_tree)
1185.12.76 by Aaron Bentley
Refactored merge and merge_inner to use Merger
482
4721.3.2 by Vincent Ladeuil
Simplify mutable_tree.has_changes() and update call sites.
483
    @deprecated_method(deprecated_in((2, 1, 0)))
1185.12.76 by Aaron Bentley
Refactored merge and merge_inner to use Merger
484
    def compare_basis(self):
2590.2.20 by Aaron Bentley
Fix handling of ghost base trees
485
        try:
486
            basis_tree = self.revision_tree(self.this_tree.last_revision())
3350.6.4 by Robert Collins
First cut at pluralised VersionedFiles. Some rather massive API incompatabilities, primarily because of the difficulty of coherence among competing stores.
487
        except errors.NoSuchRevision:
2590.2.20 by Aaron Bentley
Fix handling of ghost base trees
488
            basis_tree = self.this_tree.basis_tree()
4503.1.2 by Vincent Ladeuil
Use tree.has_changes() where appropriate (the test suite caught a
489
        if not self.this_tree.has_changes(basis_tree):
1185.12.76 by Aaron Bentley
Refactored merge and merge_inner to use Merger
490
            self.this_rev_id = self.this_basis
491
492
    def set_interesting_files(self, file_list):
2590.2.7 by Aaron Bentley
Misc cleanup
493
        self.interesting_files = file_list
1457.1.8 by Robert Collins
Replace the WorkingTree.revert method algorithm with a call to merge_inner.
494
1185.12.76 by Aaron Bentley
Refactored merge and merge_inner to use Merger
495
    def set_pending(self):
4721.3.2 by Vincent Ladeuil
Simplify mutable_tree.has_changes() and update call sites.
496
        if (not self.base_is_ancestor or not self.base_is_other_ancestor
497
            or self.other_rev_id is None):
1185.12.77 by Aaron Bentley
Prevented all ancestors from being marked as pending merges
498
            return
2590.2.11 by Aaron Bentley
Aggressively cache trees, use dirstate. re-mplement _add_parent.
499
        self._add_parent()
500
501
    def _add_parent(self):
502
        new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
2590.2.20 by Aaron Bentley
Fix handling of ghost base trees
503
        new_parent_trees = []
4797.16.1 by Andrew Bennetts
Replace many try/finally blocks in merge.py with more robust OperationWithCleanups.
504
        operation = OperationWithCleanups(self.this_tree.set_parent_trees)
2590.2.20 by Aaron Bentley
Fix handling of ghost base trees
505
        for revision_id in new_parents:
506
            try:
507
                tree = self.revision_tree(revision_id)
3350.6.4 by Robert Collins
First cut at pluralised VersionedFiles. Some rather massive API incompatabilities, primarily because of the difficulty of coherence among competing stores.
508
            except errors.NoSuchRevision:
2590.2.20 by Aaron Bentley
Fix handling of ghost base trees
509
                tree = None
510
            else:
511
                tree.lock_read()
4797.16.1 by Andrew Bennetts
Replace many try/finally blocks in merge.py with more robust OperationWithCleanups.
512
                operation.add_cleanup(tree.unlock)
2590.2.20 by Aaron Bentley
Fix handling of ghost base trees
513
            new_parent_trees.append((revision_id, tree))
4797.16.1 by Andrew Bennetts
Replace many try/finally blocks in merge.py with more robust OperationWithCleanups.
514
        operation.run_simple(new_parent_trees, allow_leftmost_as_ghost=True)
1185.12.76 by Aaron Bentley
Refactored merge and merge_inner to use Merger
515
2485.8.37 by Vincent Ladeuil
Fix merge multiple connections. Test suite *not* passing (sftp
516
    def set_other(self, other_revision, possible_transports=None):
1979.2.1 by Robert Collins
(robertc) adds a convenience method "merge_from_branch" to WorkingTree.
517
        """Set the revision and tree to merge from.
518
519
        This sets the other_tree, other_rev_id, other_basis attributes.
520
521
        :param other_revision: The [path, revision] list to merge from.
522
        """
2485.8.58 by Vincent Ladeuil
merge bzr.dev@1617
523
        self.other_branch, self.other_tree = self._get_tree(other_revision,
524
                                                            possible_transports)
1185.12.76 by Aaron Bentley
Refactored merge and merge_inner to use Merger
525
        if other_revision[1] == -1:
2598.5.4 by Aaron Bentley
Restore original Branch.last_revision behavior, fix bits that care
526
            self.other_rev_id = _mod_revision.ensure_null(
527
                self.other_branch.last_revision())
2598.5.1 by Aaron Bentley
Start eliminating the use of None to indicate null revision
528
            if _mod_revision.is_null(self.other_rev_id):
4721.3.1 by Vincent Ladeuil
Cleanup imports.
529
                raise errors.NoCommits(self.other_branch)
1185.12.76 by Aaron Bentley
Refactored merge and merge_inner to use Merger
530
            self.other_basis = self.other_rev_id
531
        elif other_revision[1] is not None:
2100.3.31 by Aaron Bentley
Merged bzr.dev (17 tests failing)
532
            self.other_rev_id = self.other_branch.get_rev_id(other_revision[1])
1185.12.76 by Aaron Bentley
Refactored merge and merge_inner to use Merger
533
            self.other_basis = self.other_rev_id
534
        else:
535
            self.other_rev_id = None
2100.3.31 by Aaron Bentley
Merged bzr.dev (17 tests failing)
536
            self.other_basis = self.other_branch.last_revision()
1185.12.76 by Aaron Bentley
Refactored merge and merge_inner to use Merger
537
            if self.other_basis is None:
4721.3.1 by Vincent Ladeuil
Cleanup imports.
538
                raise errors.NoCommits(self.other_branch)
2590.2.11 by Aaron Bentley
Aggressively cache trees, use dirstate. re-mplement _add_parent.
539
        if self.other_rev_id is not None:
540
            self._cached_trees[self.other_rev_id] = self.other_tree
2590.2.19 by Aaron Bentley
Avoid fetch within a repository
541
        self._maybe_fetch(self.other_branch,self.this_branch, self.other_basis)
1185.12.76 by Aaron Bentley
Refactored merge and merge_inner to use Merger
542
2100.3.29 by Aaron Bentley
Get merge working initially
543
    def set_other_revision(self, revision_id, other_branch):
544
        """Set 'other' based on a branch and revision id
545
546
        :param revision_id: The revision to use for a tree
547
        :param other_branch: The branch containing this tree
548
        """
549
        self.other_rev_id = revision_id
550
        self.other_branch = other_branch
2590.2.19 by Aaron Bentley
Avoid fetch within a repository
551
        self._maybe_fetch(other_branch, self.this_branch, self.other_rev_id)
2100.3.29 by Aaron Bentley
Get merge working initially
552
        self.other_tree = self.revision_tree(revision_id)
553
        self.other_basis = revision_id
554
2520.4.110 by Aaron Bentley
Implement cherrypick support for merge directives
555
    def set_base_revision(self, revision_id, branch):
556
        """Set 'base' based on a branch and revision id
557
558
        :param revision_id: The revision to use for a tree
559
        :param branch: The branch containing this tree
560
        """
561
        self.base_rev_id = revision_id
562
        self.base_branch = branch
2520.4.132 by Aaron Bentley
Merge from bzr.dev
563
        self._maybe_fetch(branch, self.this_branch, revision_id)
2520.4.110 by Aaron Bentley
Implement cherrypick support for merge directives
564
        self.base_tree = self.revision_tree(revision_id)
2520.4.132 by Aaron Bentley
Merge from bzr.dev
565
2590.2.19 by Aaron Bentley
Avoid fetch within a repository
566
    def _maybe_fetch(self, source, target, revision_id):
2665.5.2 by Aaron Bentley
Switch commit and merge to Repository.has_same_location
567
        if not source.repository.has_same_location(target.repository):
2590.2.19 by Aaron Bentley
Avoid fetch within a repository
568
            target.fetch(source, revision_id)
2520.4.110 by Aaron Bentley
Implement cherrypick support for merge directives
569
1185.82.25 by Aaron Bentley
Added changeset-merging functionality
570
    def find_base(self):
4721.3.1 by Vincent Ladeuil
Cleanup imports.
571
        revisions = [_mod_revision.ensure_null(self.this_basis),
572
                     _mod_revision.ensure_null(self.other_basis)]
573
        if _mod_revision.NULL_REVISION in revisions:
574
            self.base_rev_id = _mod_revision.NULL_REVISION
3514.4.36 by John Arbash Meinel
Optimizing how we extracted multiple trees left a path that didn't create a base_tree.
575
            self.base_tree = self.revision_tree(self.base_rev_id)
3514.4.39 by John Arbash Meinel
Use self._lca_multi_way rather than Merge3Merger._lca_multi_way by Aaron's request.
576
            self._is_criss_cross = False
2590.2.22 by Aaron Bentley
Remove cruft
577
        else:
3514.4.2 by John Arbash Meinel
Extract the lca trees and the base tree when we find a criss-cross
578
            lcas = self.revision_graph.find_lca(revisions[0], revisions[1])
3514.4.39 by John Arbash Meinel
Use self._lca_multi_way rather than Merge3Merger._lca_multi_way by Aaron's request.
579
            self._is_criss_cross = False
3514.4.2 by John Arbash Meinel
Extract the lca trees and the base tree when we find a criss-cross
580
            if len(lcas) == 0:
4721.3.1 by Vincent Ladeuil
Cleanup imports.
581
                self.base_rev_id = _mod_revision.NULL_REVISION
3514.4.2 by John Arbash Meinel
Extract the lca trees and the base tree when we find a criss-cross
582
            elif len(lcas) == 1:
583
                self.base_rev_id = list(lcas)[0]
584
            else: # len(lcas) > 1
5540.1.3 by Gary van der Merwe
Make merge correctly locate a lca where there is a criss-cross merge of a new root.
585
                self._is_criss_cross = True
3514.4.23 by John Arbash Meinel
Handle when there are more than 2 LCAs while searching for the unique lca.
586
                if len(lcas) > 2:
587
                    # find_unique_lca can only handle 2 nodes, so we have to
588
                    # start back at the beginning. It is a shame to traverse
589
                    # the graph again, but better than re-implementing
590
                    # find_unique_lca.
591
                    self.base_rev_id = self.revision_graph.find_unique_lca(
592
                                            revisions[0], revisions[1])
593
                else:
594
                    self.base_rev_id = self.revision_graph.find_unique_lca(
595
                                            *lcas)
5540.1.3 by Gary van der Merwe
Make merge correctly locate a lca where there is a criss-cross merge of a new root.
596
                sorted_lca_keys = self.revision_graph.find_merge_order(                
597
                    revisions[0], lcas)
598
                if self.base_rev_id == _mod_revision.NULL_REVISION:
599
                    self.base_rev_id = sorted_lca_keys[0]
600
                
4721.3.1 by Vincent Ladeuil
Cleanup imports.
601
            if self.base_rev_id == _mod_revision.NULL_REVISION:
602
                raise errors.UnrelatedBranches()
3514.4.2 by John Arbash Meinel
Extract the lca trees and the base tree when we find a criss-cross
603
            if self._is_criss_cross:
4721.3.1 by Vincent Ladeuil
Cleanup imports.
604
                trace.warning('Warning: criss-cross merge encountered.  See bzr'
605
                              ' help criss-cross.')
606
                trace.mutter('Criss-cross lcas: %r' % lcas)
5540.1.7 by Gary van der Merwe
Add mutter for when we cant find a unique lca, and what revision we used as a base_rev_id.
607
                if self.base_rev_id in lcas:
608
                    trace.mutter('Unable to find unique lca. '
609
                                 'Fallback %r as best option.' % self.base_rev_id)
5540.1.6 by Gary van der Merwe
We just need a set for this.
610
                interesting_revision_ids = set(lcas)
611
                interesting_revision_ids.add(self.base_rev_id)
3514.4.2 by John Arbash Meinel
Extract the lca trees and the base tree when we find a criss-cross
612
                interesting_trees = dict((t.get_revision_id(), t)
613
                    for t in self.this_branch.repository.revision_trees(
614
                        interesting_revision_ids))
615
                self._cached_trees.update(interesting_trees)
5540.1.3 by Gary van der Merwe
Make merge correctly locate a lca where there is a criss-cross merge of a new root.
616
                if self.base_rev_id in lcas:
617
                    self.base_tree = interesting_trees[self.base_rev_id]
618
                else:
619
                    self.base_tree = interesting_trees.pop(self.base_rev_id)
3514.4.13 by John Arbash Meinel
Switch the lca_trees to be in 'find_merge_order'.
620
                self._lca_trees = [interesting_trees[key]
621
                                   for key in sorted_lca_keys]
3514.4.2 by John Arbash Meinel
Extract the lca trees and the base tree when we find a criss-cross
622
            else:
623
                self.base_tree = self.revision_tree(self.base_rev_id)
2590.2.13 by Aaron Bentley
Make find_base implement the base_finding code
624
        self.base_is_ancestor = True
2590.2.18 by Aaron Bentley
Merge is_ancestor fix
625
        self.base_is_other_ancestor = True
4721.3.1 by Vincent Ladeuil
Cleanup imports.
626
        trace.mutter('Base revid: %r' % self.base_rev_id)
1185.82.25 by Aaron Bentley
Added changeset-merging functionality
627
1185.12.76 by Aaron Bentley
Refactored merge and merge_inner to use Merger
628
    def set_base(self, base_revision):
1979.2.1 by Robert Collins
(robertc) adds a convenience method "merge_from_branch" to WorkingTree.
629
        """Set the base revision to use for the merge.
630
631
        :param base_revision: A 2-list containing a path and revision number.
632
        """
4721.3.1 by Vincent Ladeuil
Cleanup imports.
633
        trace.mutter("doing merge() with no base_revision specified")
1185.12.76 by Aaron Bentley
Refactored merge and merge_inner to use Merger
634
        if base_revision == [None, None]:
2590.2.13 by Aaron Bentley
Make find_base implement the base_finding code
635
            self.find_base()
1185.12.76 by Aaron Bentley
Refactored merge and merge_inner to use Merger
636
        else:
2590.2.11 by Aaron Bentley
Aggressively cache trees, use dirstate. re-mplement _add_parent.
637
            base_branch, self.base_tree = self._get_tree(base_revision)
1185.12.76 by Aaron Bentley
Refactored merge and merge_inner to use Merger
638
            if base_revision[1] == -1:
639
                self.base_rev_id = base_branch.last_revision()
640
            elif base_revision[1] is None:
2598.5.3 by Aaron Bentley
Push NULL_REVISION deeper
641
                self.base_rev_id = _mod_revision.NULL_REVISION
493 by Martin Pool
- Merge aaron's merge command
642
            else:
2598.5.3 by Aaron Bentley
Push NULL_REVISION deeper
643
                self.base_rev_id = _mod_revision.ensure_null(
644
                    base_branch.get_rev_id(base_revision[1]))
2590.2.19 by Aaron Bentley
Avoid fetch within a repository
645
            self._maybe_fetch(base_branch, self.this_branch, self.base_rev_id)
1185.12.76 by Aaron Bentley
Refactored merge and merge_inner to use Merger
646
3008.1.8 by Michael Hudson
extract merger creation into a method
647
    def make_merger(self):
2255.2.31 by Robert Collins
Work in progress to make merge_inner work with dirstate trees.
648
        kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
649
                  'other_tree': self.other_tree,
1551.2.32 by Aaron Bentley
Handle progress phases more nicely in merge
650
                  'interesting_ids': self.interesting_ids,
2590.2.5 by Aaron Bentley
Allow selected files to be specified instead of selected ids
651
                  'interesting_files': self.interesting_files,
4961.2.20 by Martin Pool
Resolve conflicts with trunk
652
                  'this_branch': self.this_branch,
3008.1.11 by Michael Hudson
restore the default behaviour of Merge3Merger.__init__().
653
                  'do_merge': False}
1534.7.84 by Aaron Bentley
Added reprocess support, support for varying merge types
654
        if self.merge_type.requires_base:
655
            kwargs['base_tree'] = self.base_tree
1534.7.137 by Aaron Bentley
Avoided generating a new tree for every weave merge
656
        if self.merge_type.supports_reprocess:
657
            kwargs['reprocess'] = self.reprocess
658
        elif self.reprocess:
4721.3.1 by Vincent Ladeuil
Cleanup imports.
659
            raise errors.BzrError(
660
                "Conflict reduction is not supported for merge"
661
                " type %s." % self.merge_type)
1534.7.137 by Aaron Bentley
Avoided generating a new tree for every weave merge
662
        if self.merge_type.supports_show_base:
663
            kwargs['show_base'] = self.show_base
664
        elif self.show_base:
4721.3.1 by Vincent Ladeuil
Cleanup imports.
665
            raise errors.BzrError("Showing base is not supported for this"
666
                                  " merge type. %s" % self.merge_type)
3062.2.7 by Aaron Bentley
Prevent reverse cherry-picking with weave
667
        if (not getattr(self.merge_type, 'supports_reverse_cherrypick', True)
668
            and not self.base_is_other_ancestor):
669
            raise errors.CannotReverseCherrypick()
3249.3.1 by John Arbash Meinel
Implement cherrypick support for Merge3
670
        if self.merge_type.supports_cherrypick:
3062.2.9 by Aaron Bentley
Don't use the base if not cherrypicking
671
            kwargs['cherrypick'] = (not self.base_is_ancestor or
672
                                    not self.base_is_other_ancestor)
3514.4.4 by John Arbash Meinel
Test that the lca_trees are passed down to the Merger object when appropriate.
673
        if self._is_criss_cross and getattr(self.merge_type,
674
                                            'supports_lca_trees', False):
675
            kwargs['lca_trees'] = self._lca_trees
4961.2.11 by Martin Pool
Pull out pbs and ProgressPhases stored in object state; just use them in single functions
676
        return self.merge_type(pb=None,
3008.1.8 by Michael Hudson
extract merger creation into a method
677
                               change_reporter=self.change_reporter,
678
                               **kwargs)
679
4797.16.1 by Andrew Bennetts
Replace many try/finally blocks in merge.py with more robust OperationWithCleanups.
680
    def _do_merge_to(self):
681
        merge = self.make_merger()
4273.1.9 by Aaron Bentley
Cleanup
682
        if self.other_branch is not None:
683
            self.other_branch.update_references(self.this_branch)
3619.6.4 by Mark Hammond
do_merge gets one 'finally' per lock so locks always released on failure.
684
        merge.do_merge()
685
        if self.recurse == 'down':
686
            for relpath, file_id in self.this_tree.iter_references():
687
                sub_tree = self.this_tree.get_nested_tree(file_id, relpath)
688
                other_revision = self.other_tree.get_reference_revision(
689
                    file_id, relpath)
690
                if  other_revision == sub_tree.last_revision():
691
                    continue
692
                sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
693
                sub_merge.merge_type = self.merge_type
694
                other_branch = self.other_branch.reference_parent(file_id, relpath)
695
                sub_merge.set_other_revision(other_revision, other_branch)
696
                base_revision = self.base_tree.get_reference_revision(file_id)
697
                sub_merge.base_tree = \
698
                    sub_tree.branch.repository.revision_tree(base_revision)
699
                sub_merge.base_rev_id = base_revision
700
                sub_merge.do_merge()
4797.16.1 by Andrew Bennetts
Replace many try/finally blocks in merge.py with more robust OperationWithCleanups.
701
        return merge
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
702
3008.1.8 by Michael Hudson
extract merger creation into a method
703
    def do_merge(self):
4797.16.1 by Andrew Bennetts
Replace many try/finally blocks in merge.py with more robust OperationWithCleanups.
704
        operation = OperationWithCleanups(self._do_merge_to)
2255.2.50 by John Arbash Meinel
merge only needs a lock_tree_write() on the working tree, not a full lock_write()
705
        self.this_tree.lock_tree_write()
4797.16.1 by Andrew Bennetts
Replace many try/finally blocks in merge.py with more robust OperationWithCleanups.
706
        operation.add_cleanup(self.this_tree.unlock)
707
        if self.base_tree is not None:
708
            self.base_tree.lock_read()
709
            operation.add_cleanup(self.base_tree.unlock)
710
        if self.other_tree is not None:
711
            self.other_tree.lock_read()
712
            operation.add_cleanup(self.other_tree.unlock)
713
        merge = operation.run_simple()
1534.7.151 by Aaron Bentley
Fixed all changes applied successfully
714
        if len(merge.cooked_conflicts) == 0:
4721.3.1 by Vincent Ladeuil
Cleanup imports.
715
            if not self.ignore_zero and not trace.is_quiet():
716
                trace.note("All changes applied successfully.")
1534.7.141 by Aaron Bentley
Added conflict reporting
717
        else:
4721.3.1 by Vincent Ladeuil
Cleanup imports.
718
            trace.note("%d conflicts encountered."
719
                       % len(merge.cooked_conflicts))
1534.7.141 by Aaron Bentley
Added conflict reporting
720
1534.7.134 by Aaron Bentley
Hid raw conflicts
721
        return len(merge.cooked_conflicts)
1185.12.76 by Aaron Bentley
Refactored merge and merge_inner to use Merger
722
1545.2.4 by Aaron Bentley
PEP8 fixes
723
3514.4.20 by John Arbash Meinel
Use the _lca_multi_way to work out if there is actually a kind/parent/name/content change.
724
class _InventoryNoneEntry(object):
725
    """This represents an inventory entry which *isn't there*.
726
727
    It simplifies the merging logic if we always have an InventoryEntry, even
728
    if it isn't actually present
729
    """
730
    executable = None
731
    kind = None
732
    name = None
733
    parent_id = None
734
    revision = None
735
    symlink_target = None
736
    text_sha1 = None
737
738
_none_entry = _InventoryNoneEntry()
739
740
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
741
class Merge3Merger(object):
1534.7.167 by Aaron Bentley
PEP8 and comment cleanups
742
    """Three-way merger that uses the merge3 text merger"""
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
743
    requires_base = True
744
    supports_reprocess = True
745
    supports_show_base = True
746
    history_based = False
3249.3.1 by John Arbash Meinel
Implement cherrypick support for Merge3
747
    supports_cherrypick = True
3062.2.7 by Aaron Bentley
Prevent reverse cherry-picking with weave
748
    supports_reverse_cherrypick = True
2590.2.7 by Aaron Bentley
Misc cleanup
749
    winner_idx = {"this": 2, "other": 1, "conflict": 1}
3514.4.4 by John Arbash Meinel
Test that the lca_trees are passed down to the Merger object when appropriate.
750
    supports_lca_trees = True
1534.7.167 by Aaron Bentley
PEP8 and comment cleanups
751
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
752
    def __init__(self, working_tree, this_tree, base_tree, other_tree,
1558.2.2 by Aaron Bentley
Make remerge honour interesting-ids
753
                 interesting_ids=None, reprocess=False, show_base=False,
4961.2.9 by Martin Pool
Rip out most remaining uses of DummyProgressBar
754
                 pb=None, pp=None, change_reporter=None,
3249.3.1 by John Arbash Meinel
Implement cherrypick support for Merge3
755
                 interesting_files=None, do_merge=True,
4869.3.27 by Andrew Bennetts
Move news_merge plugin from contrib to bzrlib/plugins, change it to be enabled via a 'news_merge_files' config option, move more code out of the __init__ to minimise overhead, and add lots of docstrings, add NEWS entry.
756
                 cherrypick=False, lca_trees=None, this_branch=None):
2590.2.10 by Aaron Bentley
Updates from review
757
        """Initialize the merger object and perform the merge.
758
759
        :param working_tree: The working tree to apply the merge to
760
        :param this_tree: The local tree in the merge operation
761
        :param base_tree: The common tree in the merge operation
4031.3.1 by Frank Aspell
Fixing various typos
762
        :param other_tree: The other tree to merge changes from
5162.3.1 by Aaron Bentley
Fix switch/merge when a ConfigurableFileMerger is used.
763
        :param this_branch: The branch associated with this_tree.  Defaults to
764
            this_tree.branch if not supplied.
2590.2.10 by Aaron Bentley
Updates from review
765
        :param interesting_ids: The file_ids of files that should be
766
            participate in the merge.  May not be combined with
767
            interesting_files.
768
        :param: reprocess If True, perform conflict-reduction processing.
769
        :param show_base: If True, show the base revision in text conflicts.
770
            (incompatible with reprocess)
4961.2.9 by Martin Pool
Rip out most remaining uses of DummyProgressBar
771
        :param pb: ignored
2590.2.10 by Aaron Bentley
Updates from review
772
        :param pp: A ProgressPhase object
773
        :param change_reporter: An object that should report changes made
774
        :param interesting_files: The tree-relative paths of files that should
775
            participate in the merge.  If these paths refer to directories,
776
            the contents of those directories will also be included.  May not
777
            be combined with interesting_ids.  If neither interesting_files nor
778
            interesting_ids is specified, all files may participate in the
779
            merge.
3514.4.4 by John Arbash Meinel
Test that the lca_trees are passed down to the Merger object when appropriate.
780
        :param lca_trees: Can be set to a dictionary of {revision_id:rev_tree}
781
            if the ancestry was found to include a criss-cross merge.
782
            Otherwise should be None.
2590.2.10 by Aaron Bentley
Updates from review
783
        """
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
784
        object.__init__(self)
3376.2.4 by Martin Pool
Remove every assert statement from bzrlib!
785
        if interesting_files is not None and interesting_ids is not None:
786
            raise ValueError(
787
                'specify either interesting_ids or interesting_files')
5162.3.1 by Aaron Bentley
Fix switch/merge when a ConfigurableFileMerger is used.
788
        if this_branch is None:
789
            this_branch = this_tree.branch
2590.2.4 by Aaron Bentley
Move entry generation to a helper
790
        self.interesting_ids = interesting_ids
2590.2.5 by Aaron Bentley
Allow selected files to be specified instead of selected ids
791
        self.interesting_files = interesting_files
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
792
        self.this_tree = working_tree
793
        self.base_tree = base_tree
794
        self.other_tree = other_tree
4869.3.27 by Andrew Bennetts
Move news_merge plugin from contrib to bzrlib/plugins, change it to be enabled via a 'news_merge_files' config option, move more code out of the __init__ to minimise overhead, and add lots of docstrings, add NEWS entry.
795
        self.this_branch = this_branch
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
796
        self._raw_conflicts = []
797
        self.cooked_conflicts = []
798
        self.reprocess = reprocess
799
        self.show_base = show_base
3514.4.4 by John Arbash Meinel
Test that the lca_trees are passed down to the Merger object when appropriate.
800
        self._lca_trees = lca_trees
3514.4.37 by John Arbash Meinel
Tests pass when using _entries_lca as the default algorithm.
801
        # Uncommenting this will change the default algorithm to always use
802
        # _entries_lca. This can be useful for running the test suite and
803
        # making sure we haven't missed any corner cases.
3514.4.34 by John Arbash Meinel
Handle symlinks properly when objects are not RevisionTrees
804
        # if lca_trees is None:
805
        #     self._lca_trees = [self.base_tree]
1551.11.9 by Aaron Bentley
Apply change reporting to merge
806
        self.change_reporter = change_reporter
3249.3.1 by John Arbash Meinel
Implement cherrypick support for Merge3
807
        self.cherrypick = cherrypick
3008.1.11 by Michael Hudson
restore the default behaviour of Merge3Merger.__init__().
808
        if do_merge:
809
            self.do_merge()
4961.2.12 by Martin Pool
Further pb/pp removals
810
        if pp is not None:
811
            warnings.warn("pp argument to Merge3Merger is deprecated")
812
        if pb is not None:
813
            warnings.warn("pb argument to Merge3Merger is deprecated")
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
814
3008.1.6 by Michael Hudson
chop up Merge3Merger.__init__ into pieces
815
    def do_merge(self):
4797.16.1 by Andrew Bennetts
Replace many try/finally blocks in merge.py with more robust OperationWithCleanups.
816
        operation = OperationWithCleanups(self._do_merge)
3008.1.6 by Michael Hudson
chop up Merge3Merger.__init__ into pieces
817
        self.this_tree.lock_tree_write()
4797.16.1 by Andrew Bennetts
Replace many try/finally blocks in merge.py with more robust OperationWithCleanups.
818
        operation.add_cleanup(self.this_tree.unlock)
3008.1.6 by Michael Hudson
chop up Merge3Merger.__init__ into pieces
819
        self.base_tree.lock_read()
4797.16.1 by Andrew Bennetts
Replace many try/finally blocks in merge.py with more robust OperationWithCleanups.
820
        operation.add_cleanup(self.base_tree.unlock)
3008.1.6 by Michael Hudson
chop up Merge3Merger.__init__ into pieces
821
        self.other_tree.lock_read()
4797.16.1 by Andrew Bennetts
Replace many try/finally blocks in merge.py with more robust OperationWithCleanups.
822
        operation.add_cleanup(self.other_tree.unlock)
823
        operation.run()
824
825
    def _do_merge(self, operation):
5031.1.2 by Andrew Bennetts
Merge lp:bzr/2.1
826
        self.tt = transform.TreeTransform(self.this_tree, None)
4797.16.1 by Andrew Bennetts
Replace many try/finally blocks in merge.py with more robust OperationWithCleanups.
827
        operation.add_cleanup(self.tt.finalize)
828
        self._compute_transform()
829
        results = self.tt.apply(no_conflicts=True)
830
        self.write_modified(results)
5031.1.3 by Andrew Bennetts
Fix syntax error from bad conflict resolution.
831
        try:
4797.16.1 by Andrew Bennetts
Replace many try/finally blocks in merge.py with more robust OperationWithCleanups.
832
            self.this_tree.add_conflicts(self.cooked_conflicts)
833
        except errors.UnsupportedOperation:
834
            pass
1534.7.192 by Aaron Bentley
Record hashes produced by merges
835
3008.1.9 by Michael Hudson
wanton hacking that lets me write an efficient version of get_diff_as_merged
836
    def make_preview_transform(self):
4797.16.1 by Andrew Bennetts
Replace many try/finally blocks in merge.py with more robust OperationWithCleanups.
837
        operation = OperationWithCleanups(self._make_preview_transform)
3008.1.9 by Michael Hudson
wanton hacking that lets me write an efficient version of get_diff_as_merged
838
        self.base_tree.lock_read()
4797.16.1 by Andrew Bennetts
Replace many try/finally blocks in merge.py with more robust OperationWithCleanups.
839
        operation.add_cleanup(self.base_tree.unlock)
3008.1.9 by Michael Hudson
wanton hacking that lets me write an efficient version of get_diff_as_merged
840
        self.other_tree.lock_read()
4797.16.1 by Andrew Bennetts
Replace many try/finally blocks in merge.py with more robust OperationWithCleanups.
841
        operation.add_cleanup(self.other_tree.unlock)
842
        return operation.run_simple()
843
844
    def _make_preview_transform(self):
4721.3.1 by Vincent Ladeuil
Cleanup imports.
845
        self.tt = transform.TransformPreview(self.this_tree)
4797.16.1 by Andrew Bennetts
Replace many try/finally blocks in merge.py with more robust OperationWithCleanups.
846
        self._compute_transform()
3008.1.9 by Michael Hudson
wanton hacking that lets me write an efficient version of get_diff_as_merged
847
        return self.tt
848
3008.1.21 by Aaron Bentley
Make compute_transform private, test make_preview_transform
849
    def _compute_transform(self):
3514.4.21 by John Arbash Meinel
Hook up the lca-way logic into the path handlers.
850
        if self._lca_trees is None:
851
            entries = self._entries3()
852
            resolver = self._three_way
853
        else:
854
            entries = self._entries_lca()
855
            resolver = self._lca_multi_way
3008.1.6 by Michael Hudson
chop up Merge3Merger.__init__ into pieces
856
        child_pb = ui.ui_factory.nested_progress_bar()
857
        try:
4797.5.1 by Robert Collins
Support state on per-file merging to permit more efficient use of configuration data.
858
            factories = Merger.hooks['merge_file_content']
859
            hooks = [factory(self) for factory in factories] + [self]
860
            self.active_hooks = [hook for hook in hooks if hook is not None]
3008.1.6 by Michael Hudson
chop up Merge3Merger.__init__ into pieces
861
            for num, (file_id, changed, parents3, names3,
862
                      executable3) in enumerate(entries):
863
                child_pb.update('Preparing file merge', num, len(entries))
3514.4.21 by John Arbash Meinel
Hook up the lca-way logic into the path handlers.
864
                self._merge_names(file_id, parents3, names3, resolver=resolver)
3008.1.6 by Michael Hudson
chop up Merge3Merger.__init__ into pieces
865
                if changed:
4797.5.1 by Robert Collins
Support state on per-file merging to permit more efficient use of configuration data.
866
                    file_status = self._do_merge_contents(file_id)
3008.1.6 by Michael Hudson
chop up Merge3Merger.__init__ into pieces
867
                else:
868
                    file_status = 'unmodified'
869
                self._merge_executable(file_id,
3514.4.21 by John Arbash Meinel
Hook up the lca-way logic into the path handlers.
870
                    executable3, file_status, resolver=resolver)
3008.1.6 by Michael Hudson
chop up Merge3Merger.__init__ into pieces
871
        finally:
872
            child_pb.finished()
873
        self.fix_root()
5246.2.33 by Andrew Bennetts
Rename _finish_transform to _finish_computing_transform.
874
        self._finish_computing_transform()
5246.2.4 by Andrew Bennetts
Remove a little bit of duplication.
875
5246.2.33 by Andrew Bennetts
Rename _finish_transform to _finish_computing_transform.
876
    def _finish_computing_transform(self):
5246.2.4 by Andrew Bennetts
Remove a little bit of duplication.
877
        """Finalize the transform and report the changes.
878
879
        This is the second half of _compute_transform.
880
        """
3008.1.6 by Michael Hudson
chop up Merge3Merger.__init__ into pieces
881
        child_pb = ui.ui_factory.nested_progress_bar()
882
        try:
4721.3.1 by Vincent Ladeuil
Cleanup imports.
883
            fs_conflicts = transform.resolve_conflicts(self.tt, child_pb,
884
                lambda t, c: transform.conflict_pass(t, c, self.other_tree))
3008.1.6 by Michael Hudson
chop up Merge3Merger.__init__ into pieces
885
        finally:
886
            child_pb.finished()
887
        if self.change_reporter is not None:
888
            from bzrlib import delta
889
            delta.report_changes(
3254.1.1 by Aaron Bentley
Make Tree.iter_changes a public method
890
                self.tt.iter_changes(), self.change_reporter)
3008.1.6 by Michael Hudson
chop up Merge3Merger.__init__ into pieces
891
        self.cook_conflicts(fs_conflicts)
892
        for conflict in self.cooked_conflicts:
4721.3.1 by Vincent Ladeuil
Cleanup imports.
893
            trace.warning(conflict)
3008.1.6 by Michael Hudson
chop up Merge3Merger.__init__ into pieces
894
2590.2.4 by Aaron Bentley
Move entry generation to a helper
895
    def _entries3(self):
2590.2.7 by Aaron Bentley
Misc cleanup
896
        """Gather data about files modified between three trees.
897
898
        Return a list of tuples of file_id, changed, parents3, names3,
899
        executable3.  changed is a boolean indicating whether the file contents
900
        or kind were changed.  parents3 is a tuple of parent ids for base,
901
        other and this.  names3 is a tuple of names for base, other and this.
902
        executable3 is a tuple of execute-bit values for base, other and this.
903
        """
2590.2.4 by Aaron Bentley
Move entry generation to a helper
904
        result = []
3254.1.1 by Aaron Bentley
Make Tree.iter_changes a public method
905
        iterator = self.other_tree.iter_changes(self.base_tree,
3514.2.16 by John Arbash Meinel
Review feedback from Ian.
906
                include_unchanged=True, specific_files=self.interesting_files,
2590.2.5 by Aaron Bentley
Allow selected files to be specified instead of selected ids
907
                extra_trees=[self.this_tree])
3363.17.1 by Aaron Bentley
Avoid inventory for merge and transform code
908
        this_entries = dict((e.file_id, e) for p, e in
909
                            self.this_tree.iter_entries_by_dir(
910
                            self.interesting_ids))
2590.2.4 by Aaron Bentley
Move entry generation to a helper
911
        for (file_id, paths, changed, versioned, parents, names, kind,
2590.2.5 by Aaron Bentley
Allow selected files to be specified instead of selected ids
912
             executable) in iterator:
2590.2.4 by Aaron Bentley
Move entry generation to a helper
913
            if (self.interesting_ids is not None and
914
                file_id not in self.interesting_ids):
915
                continue
3363.17.1 by Aaron Bentley
Avoid inventory for merge and transform code
916
            entry = this_entries.get(file_id)
917
            if entry is not None:
2590.2.4 by Aaron Bentley
Move entry generation to a helper
918
                this_name = entry.name
919
                this_parent = entry.parent_id
920
                this_executable = entry.executable
921
            else:
922
                this_name = None
923
                this_parent = None
924
                this_executable = None
925
            parents3 = parents + (this_parent,)
926
            names3 = names + (this_name,)
927
            executable3 = executable + (this_executable,)
928
            result.append((file_id, changed, parents3, names3, executable3))
929
        return result
930
3514.4.5 by John Arbash Meinel
Initial work on _entries_lca.
931
    def _entries_lca(self):
932
        """Gather data about files modified between multiple trees.
933
934
        This compares OTHER versus all LCA trees, and for interesting entries,
935
        it then compares with THIS and BASE.
936
937
        For the multi-valued entries, the format will be (BASE, [lca1, lca2])
938
        :return: [(file_id, changed, parents, names, executable)]
939
            file_id     Simple file_id of the entry
940
            changed     Boolean, True if the kind or contents changed
941
                        else False
942
            parents     ((base, [parent_id, in, lcas]), parent_id_other,
943
                         parent_id_this)
944
            names       ((base, [name, in, lcas]), name_in_other, name_in_this)
945
            executable  ((base, [exec, in, lcas]), exec_in_other, exec_in_this)
946
        """
3514.4.24 by John Arbash Meinel
Implement support for 'interesting_files' and 'interesting_ids' for _entries_lca
947
        if self.interesting_files is not None:
948
            lookup_trees = [self.this_tree, self.base_tree]
949
            lookup_trees.extend(self._lca_trees)
950
            # I think we should include the lca trees as well
951
            interesting_ids = self.other_tree.paths2ids(self.interesting_files,
952
                                                        lookup_trees)
953
        else:
954
            interesting_ids = self.interesting_ids
3514.4.5 by John Arbash Meinel
Initial work on _entries_lca.
955
        result = []
3514.4.13 by John Arbash Meinel
Switch the lca_trees to be in 'find_merge_order'.
956
        walker = _mod_tree.MultiWalker(self.other_tree, self._lca_trees)
3514.4.5 by John Arbash Meinel
Initial work on _entries_lca.
957
3514.4.10 by John Arbash Meinel
Test the case where BASE is missing a file that is present in THIS, OTHER and all LCAs.
958
        base_inventory = self.base_tree.inventory
959
        this_inventory = self.this_tree.inventory
3514.4.5 by John Arbash Meinel
Initial work on _entries_lca.
960
        for path, file_id, other_ie, lca_values in walker.iter_all():
961
            # Is this modified at all from any of the other trees?
3514.4.15 by John Arbash Meinel
Handle when OTHER doesn't have the entry.
962
            if other_ie is None:
3514.4.20 by John Arbash Meinel
Use the _lca_multi_way to work out if there is actually a kind/parent/name/content change.
963
                other_ie = _none_entry
3514.4.24 by John Arbash Meinel
Implement support for 'interesting_files' and 'interesting_ids' for _entries_lca
964
            if interesting_ids is not None and file_id not in interesting_ids:
965
                continue
3514.4.15 by John Arbash Meinel
Handle when OTHER doesn't have the entry.
966
3514.4.30 by John Arbash Meinel
Several updates.
967
            # If other_revision is found in any of the lcas, that means this
968
            # node is uninteresting. This is because when merging, if there are
969
            # multiple heads(), we have to create a new node. So if we didn't,
970
            # we know that the ancestry is linear, and that OTHER did not
971
            # modify anything
972
            # See doc/developers/lca_merge_resolution.txt for details
3514.4.20 by John Arbash Meinel
Use the _lca_multi_way to work out if there is actually a kind/parent/name/content change.
973
            other_revision = other_ie.revision
3514.4.32 by John Arbash Meinel
Add a test for proper behavior when *everything* is a WT.
974
            if other_revision is not None:
975
                # We can't use this shortcut when other_revision is None,
976
                # because it may be None because things are WorkingTrees, and
977
                # not because it is *actually* None.
978
                is_unmodified = False
979
                for lca_path, ie in lca_values:
980
                    if ie is not None and ie.revision == other_revision:
981
                        is_unmodified = True
982
                        break
983
                if is_unmodified:
984
                    continue
3514.4.20 by John Arbash Meinel
Use the _lca_multi_way to work out if there is actually a kind/parent/name/content change.
985
986
            lca_entries = []
987
            for lca_path, lca_ie in lca_values:
988
                if lca_ie is None:
989
                    lca_entries.append(_none_entry)
990
                else:
991
                    lca_entries.append(lca_ie)
3514.4.19 by John Arbash Meinel
Add the _lca_multi_way function, and explicit tests.
992
3514.4.10 by John Arbash Meinel
Test the case where BASE is missing a file that is present in THIS, OTHER and all LCAs.
993
            if file_id in base_inventory:
3514.4.20 by John Arbash Meinel
Use the _lca_multi_way to work out if there is actually a kind/parent/name/content change.
994
                base_ie = base_inventory[file_id]
3514.4.10 by John Arbash Meinel
Test the case where BASE is missing a file that is present in THIS, OTHER and all LCAs.
995
            else:
3514.4.20 by John Arbash Meinel
Use the _lca_multi_way to work out if there is actually a kind/parent/name/content change.
996
                base_ie = _none_entry
997
3514.4.11 by John Arbash Meinel
Handle when an entry is missing in THIS
998
            if file_id in this_inventory:
999
                this_ie = this_inventory[file_id]
1000
            else:
3514.4.20 by John Arbash Meinel
Use the _lca_multi_way to work out if there is actually a kind/parent/name/content change.
1001
                this_ie = _none_entry
3514.4.11 by John Arbash Meinel
Handle when an entry is missing in THIS
1002
3514.4.21 by John Arbash Meinel
Hook up the lca-way logic into the path handlers.
1003
            lca_kinds = []
1004
            lca_parent_ids = []
1005
            lca_names = []
1006
            lca_executable = []
1007
            for lca_ie in lca_entries:
1008
                lca_kinds.append(lca_ie.kind)
1009
                lca_parent_ids.append(lca_ie.parent_id)
1010
                lca_names.append(lca_ie.name)
1011
                lca_executable.append(lca_ie.executable)
1012
3514.4.39 by John Arbash Meinel
Use self._lca_multi_way rather than Merge3Merger._lca_multi_way by Aaron's request.
1013
            kind_winner = self._lca_multi_way(
3514.4.21 by John Arbash Meinel
Hook up the lca-way logic into the path handlers.
1014
                (base_ie.kind, lca_kinds),
3514.4.20 by John Arbash Meinel
Use the _lca_multi_way to work out if there is actually a kind/parent/name/content change.
1015
                other_ie.kind, this_ie.kind)
3514.4.39 by John Arbash Meinel
Use self._lca_multi_way rather than Merge3Merger._lca_multi_way by Aaron's request.
1016
            parent_id_winner = self._lca_multi_way(
3514.4.21 by John Arbash Meinel
Hook up the lca-way logic into the path handlers.
1017
                (base_ie.parent_id, lca_parent_ids),
3514.4.20 by John Arbash Meinel
Use the _lca_multi_way to work out if there is actually a kind/parent/name/content change.
1018
                other_ie.parent_id, this_ie.parent_id)
3514.4.39 by John Arbash Meinel
Use self._lca_multi_way rather than Merge3Merger._lca_multi_way by Aaron's request.
1019
            name_winner = self._lca_multi_way(
3514.4.21 by John Arbash Meinel
Hook up the lca-way logic into the path handlers.
1020
                (base_ie.name, lca_names),
3514.4.20 by John Arbash Meinel
Use the _lca_multi_way to work out if there is actually a kind/parent/name/content change.
1021
                other_ie.name, this_ie.name)
3514.4.21 by John Arbash Meinel
Hook up the lca-way logic into the path handlers.
1022
3514.4.20 by John Arbash Meinel
Use the _lca_multi_way to work out if there is actually a kind/parent/name/content change.
1023
            content_changed = True
1024
            if kind_winner == 'this':
1025
                # No kind change in OTHER, see if there are *any* changes
3948.1.1 by John Arbash Meinel
Fix an edge case with deleted files and criss-cross merges.
1026
                if other_ie.kind == 'directory':
3514.4.20 by John Arbash Meinel
Use the _lca_multi_way to work out if there is actually a kind/parent/name/content change.
1027
                    if parent_id_winner == 'this' and name_winner == 'this':
1028
                        # No change for this directory in OTHER, skip
1029
                        continue
1030
                    content_changed = False
3948.1.1 by John Arbash Meinel
Fix an edge case with deleted files and criss-cross merges.
1031
                elif other_ie.kind is None or other_ie.kind == 'file':
3514.4.30 by John Arbash Meinel
Several updates.
1032
                    def get_sha1(ie, tree):
3514.4.35 by John Arbash Meinel
Add a test that we only call get_symlink_target if the object should be a symlink.
1033
                        if ie.kind != 'file':
3514.4.30 by John Arbash Meinel
Several updates.
1034
                            return None
1035
                        return tree.get_file_sha1(file_id)
1036
                    base_sha1 = get_sha1(base_ie, self.base_tree)
1037
                    lca_sha1s = [get_sha1(ie, tree) for ie, tree
1038
                                 in zip(lca_entries, self._lca_trees)]
1039
                    this_sha1 = get_sha1(this_ie, self.this_tree)
1040
                    other_sha1 = get_sha1(other_ie, self.other_tree)
3514.4.39 by John Arbash Meinel
Use self._lca_multi_way rather than Merge3Merger._lca_multi_way by Aaron's request.
1041
                    sha1_winner = self._lca_multi_way(
3514.4.30 by John Arbash Meinel
Several updates.
1042
                        (base_sha1, lca_sha1s), other_sha1, this_sha1,
1043
                        allow_overriding_lca=False)
3514.4.39 by John Arbash Meinel
Use self._lca_multi_way rather than Merge3Merger._lca_multi_way by Aaron's request.
1044
                    exec_winner = self._lca_multi_way(
3514.4.22 by John Arbash Meinel
Handle executable bit changes as well.
1045
                        (base_ie.executable, lca_executable),
1046
                        other_ie.executable, this_ie.executable)
3514.4.20 by John Arbash Meinel
Use the _lca_multi_way to work out if there is actually a kind/parent/name/content change.
1047
                    if (parent_id_winner == 'this' and name_winner == 'this'
3514.4.22 by John Arbash Meinel
Handle executable bit changes as well.
1048
                        and sha1_winner == 'this' and exec_winner == 'this'):
1049
                        # No kind, parent, name, exec, or content change for
1050
                        # OTHER, so this node is not considered interesting
3514.4.20 by John Arbash Meinel
Use the _lca_multi_way to work out if there is actually a kind/parent/name/content change.
1051
                        continue
1052
                    if sha1_winner == 'this':
1053
                        content_changed = False
3514.4.27 by John Arbash Meinel
A couple of symlink tests, we need to do more.
1054
                elif other_ie.kind == 'symlink':
3514.4.34 by John Arbash Meinel
Handle symlinks properly when objects are not RevisionTrees
1055
                    def get_target(ie, tree):
3514.4.35 by John Arbash Meinel
Add a test that we only call get_symlink_target if the object should be a symlink.
1056
                        if ie.kind != 'symlink':
3514.4.34 by John Arbash Meinel
Handle symlinks properly when objects are not RevisionTrees
1057
                            return None
1058
                        return tree.get_symlink_target(file_id)
1059
                    base_target = get_target(base_ie, self.base_tree)
1060
                    lca_targets = [get_target(ie, tree) for ie, tree
1061
                                   in zip(lca_entries, self._lca_trees)]
1062
                    this_target = get_target(this_ie, self.this_tree)
1063
                    other_target = get_target(other_ie, self.other_tree)
3514.4.39 by John Arbash Meinel
Use self._lca_multi_way rather than Merge3Merger._lca_multi_way by Aaron's request.
1064
                    target_winner = self._lca_multi_way(
3514.4.34 by John Arbash Meinel
Handle symlinks properly when objects are not RevisionTrees
1065
                        (base_target, lca_targets),
1066
                        other_target, this_target)
3514.4.28 by John Arbash Meinel
More symlink tests.
1067
                    if (parent_id_winner == 'this' and name_winner == 'this'
1068
                        and target_winner == 'this'):
1069
                        # No kind, parent, name, or symlink target change
1070
                        # not interesting
1071
                        continue
1072
                    if target_winner == 'this':
1073
                        content_changed = False
3514.4.33 by John Arbash Meinel
Implement support for 'tree-reference'.
1074
                elif other_ie.kind == 'tree-reference':
1075
                    # The 'changed' information seems to be handled at a higher
1076
                    # level. At least, _entries3 returns False for content
1077
                    # changed, even when at a new revision_id.
1078
                    content_changed = False
1079
                    if (parent_id_winner == 'this' and name_winner == 'this'):
1080
                        # Nothing interesting
1081
                        continue
3514.4.21 by John Arbash Meinel
Hook up the lca-way logic into the path handlers.
1082
                else:
1083
                    raise AssertionError('unhandled kind: %s' % other_ie.kind)
3514.4.13 by John Arbash Meinel
Switch the lca_trees to be in 'find_merge_order'.
1084
1085
            # If we have gotten this far, that means something has changed
3514.4.20 by John Arbash Meinel
Use the _lca_multi_way to work out if there is actually a kind/parent/name/content change.
1086
            result.append((file_id, content_changed,
1087
                           ((base_ie.parent_id, lca_parent_ids),
1088
                            other_ie.parent_id, this_ie.parent_id),
1089
                           ((base_ie.name, lca_names),
1090
                            other_ie.name, this_ie.name),
1091
                           ((base_ie.executable, lca_executable),
1092
                            other_ie.executable, this_ie.executable)
3514.4.5 by John Arbash Meinel
Initial work on _entries_lca.
1093
                          ))
1094
        return result
1095
1731.1.33 by Aaron Bentley
Revert no-special-root changes
1096
    def fix_root(self):
4597.9.7 by Vincent Ladeuil
transform.final_kind() now returns None instead of raising NoSuchFile.
1097
        if self.tt.final_kind(self.tt.root) is None:
1731.1.33 by Aaron Bentley
Revert no-special-root changes
1098
            self.tt.cancel_deletion(self.tt.root)
1099
        if self.tt.final_file_id(self.tt.root) is None:
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1100
            self.tt.version_file(self.tt.tree_file_id(self.tt.root),
1731.1.33 by Aaron Bentley
Revert no-special-root changes
1101
                                 self.tt.root)
2946.3.3 by John Arbash Meinel
Prefer tree.get_root_id() as more explicit than tree.path2id('')
1102
        other_root_file_id = self.other_tree.get_root_id()
3363.17.17 by Aaron Bentley
Start testing merging PreviewTree as OTHER
1103
        if other_root_file_id is None:
1104
            return
1731.1.33 by Aaron Bentley
Revert no-special-root changes
1105
        other_root = self.tt.trans_id_file_id(other_root_file_id)
1106
        if other_root == self.tt.root:
1107
            return
3649.3.1 by Jelmer Vernooij
Merging from a previously joined branch will no longer cause a traceback.
1108
        if self.other_tree.inventory.root.file_id in self.this_tree.inventory:
4634.149.3 by Vincent Ladeuil
Fix bug #3735898 by filtering out garbage paths.
1109
            # the other tree's root is a non-root in the current tree (as when
4634.149.6 by Vincent Ladeuil
Fix typo.
1110
            # a previously unrelated branch is merged into another)
3649.3.1 by Jelmer Vernooij
Merging from a previously joined branch will no longer cause a traceback.
1111
            return
4597.9.9 by Vincent Ladeuil
Fix wrong conflict resolution (thanks to test coverage...).
1112
        if self.tt.final_kind(other_root) is not None:
4634.149.5 by Vincent Ladeuil
Fixed as per John's review comments.
1113
            other_root_is_present = True
4597.9.8 by Vincent Ladeuil
Merge bzr.dev into cleanup
1114
        else:
4634.149.5 by Vincent Ladeuil
Fixed as per John's review comments.
1115
            # other_root doesn't have a physical representation. We still need
1116
            # to move any references to the actual root of the tree.
1117
            other_root_is_present = False
1118
        # 'other_tree.inventory.root' is not present in this tree. We are
1119
        # calling adjust_path for children which *want* to be present with a
1120
        # correct place to go.
1121
        for thing, child in self.other_tree.inventory.root.children.iteritems():
1122
            trans_id = self.tt.trans_id_file_id(child.file_id)
1123
            if not other_root_is_present:
4597.9.8 by Vincent Ladeuil
Merge bzr.dev into cleanup
1124
                if self.tt.final_kind(trans_id) is not None:
4634.149.5 by Vincent Ladeuil
Fixed as per John's review comments.
1125
                    # The item exist in the final tree and has a defined place
1126
                    # to go already.
1127
                    continue
1128
            # Move the item into the root
1129
            self.tt.adjust_path(self.tt.final_name(trans_id),
1130
                                self.tt.root, trans_id)
1131
        if other_root_is_present:
4634.149.3 by Vincent Ladeuil
Fix bug #3735898 by filtering out garbage paths.
1132
            self.tt.cancel_creation(other_root)
1133
            self.tt.cancel_versioning(other_root)
1731.1.33 by Aaron Bentley
Revert no-special-root changes
1134
1534.7.192 by Aaron Bentley
Record hashes produced by merges
1135
    def write_modified(self, results):
1136
        modified_hashes = {}
1137
        for path in results.modified_paths:
1138
            file_id = self.this_tree.path2id(self.this_tree.relpath(path))
1139
            if file_id is None:
1140
                continue
1141
            hash = self.this_tree.get_file_sha1(file_id)
1142
            if hash is None:
1143
                continue
1144
            modified_hashes[file_id] = hash
1145
        self.this_tree.set_merge_modified(modified_hashes)
1146
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1147
    @staticmethod
1148
    def parent(entry, file_id):
1534.7.157 by Aaron Bentley
Added more docs
1149
        """Determine the parent for a file_id (used as a key method)"""
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1150
        if entry is None:
1151
            return None
1152
        return entry.parent_id
1153
1154
    @staticmethod
1155
    def name(entry, file_id):
1534.7.157 by Aaron Bentley
Added more docs
1156
        """Determine the name for a file_id (used as a key method)"""
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1157
        if entry is None:
1158
            return None
1159
        return entry.name
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1160
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1161
    @staticmethod
1162
    def contents_sha1(tree, file_id):
1534.7.157 by Aaron Bentley
Added more docs
1163
        """Determine the sha1 of the file contents (used as a key method)."""
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1164
        if file_id not in tree:
1165
            return None
1166
        return tree.get_file_sha1(file_id)
1167
1168
    @staticmethod
1169
    def executable(tree, file_id):
1534.7.157 by Aaron Bentley
Added more docs
1170
        """Determine the executability of a file-id (used as a key method)."""
4869.3.22 by Andrew Bennetts
Use 'tree.has_id(file_id)' rather than using 'file_id in tree' or using tree.inventory.
1171
        if not tree.has_id(file_id):
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1172
            return None
1173
        if tree.kind(file_id) != "file":
1174
            return False
1175
        return tree.is_executable(file_id)
1176
1177
    @staticmethod
1178
    def kind(tree, file_id):
1534.7.157 by Aaron Bentley
Added more docs
1179
        """Determine the kind of a file-id (used as a key method)."""
4869.3.22 by Andrew Bennetts
Use 'tree.has_id(file_id)' rather than using 'file_id in tree' or using tree.inventory.
1180
        if not tree.has_id(file_id):
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1181
            return None
1182
        return tree.kind(file_id)
1183
1184
    @staticmethod
2590.2.8 by Aaron Bentley
Restore conflict handling changes
1185
    def _three_way(base, other, this):
1186
        if base == other:
5128.1.1 by Vincent Ladeuil
Uncontroversial cleanups, mostly comments
1187
            # if 'base == other', either they all agree, or only 'this' has
1188
            # changed.
2590.2.8 by Aaron Bentley
Restore conflict handling changes
1189
            return 'this'
2590.2.10 by Aaron Bentley
Updates from review
1190
        elif this not in (base, other):
5128.1.1 by Vincent Ladeuil
Uncontroversial cleanups, mostly comments
1191
            # 'this' is neither 'base' nor 'other', so both sides changed
2590.2.8 by Aaron Bentley
Restore conflict handling changes
1192
            return 'conflict'
1193
        elif this == other:
5128.1.1 by Vincent Ladeuil
Uncontroversial cleanups, mostly comments
1194
            # "Ambiguous clean merge" -- both sides have made the same change.
2590.2.8 by Aaron Bentley
Restore conflict handling changes
1195
            return "this"
1196
        else:
5128.1.1 by Vincent Ladeuil
Uncontroversial cleanups, mostly comments
1197
            # this == base: only other has changed.
2590.2.8 by Aaron Bentley
Restore conflict handling changes
1198
            return "other"
1199
1200
    @staticmethod
3514.4.30 by John Arbash Meinel
Several updates.
1201
    def _lca_multi_way(bases, other, this, allow_overriding_lca=True):
3514.4.19 by John Arbash Meinel
Add the _lca_multi_way function, and explicit tests.
1202
        """Consider LCAs when determining whether a change has occurred.
1203
1204
        If LCAS are all identical, this is the same as a _three_way comparison.
1205
1206
        :param bases: value in (BASE, [LCAS])
1207
        :param other: value in OTHER
1208
        :param this: value in THIS
3514.4.30 by John Arbash Meinel
Several updates.
1209
        :param allow_overriding_lca: If there is more than one unique lca
1210
            value, allow OTHER to override THIS if it has a new value, and
1211
            THIS only has an lca value, or vice versa. This is appropriate for
1212
            truly scalar values, not as much for non-scalars.
3514.4.19 by John Arbash Meinel
Add the _lca_multi_way function, and explicit tests.
1213
        :return: 'this', 'other', or 'conflict' depending on whether an entry
1214
            changed or not.
1215
        """
3948.1.7 by Vincent Ladeuil
Slight refactoring and test fixing.
1216
        # See doc/developers/lca_tree_merging.txt for details about this
3514.4.30 by John Arbash Meinel
Several updates.
1217
        # algorithm.
3514.4.19 by John Arbash Meinel
Add the _lca_multi_way function, and explicit tests.
1218
        if other == this:
1219
            # Either Ambiguously clean, or nothing was actually changed. We
1220
            # don't really care
1221
            return 'this'
1222
        base_val, lca_vals = bases
1223
        # Remove 'base_val' from the lca_vals, because it is not interesting
1224
        filtered_lca_vals = [lca_val for lca_val in lca_vals
1225
                                      if lca_val != base_val]
1226
        if len(filtered_lca_vals) == 0:
1227
            return Merge3Merger._three_way(base_val, other, this)
3514.4.30 by John Arbash Meinel
Several updates.
1228
1229
        unique_lca_vals = set(filtered_lca_vals)
1230
        if len(unique_lca_vals) == 1:
1231
            return Merge3Merger._three_way(unique_lca_vals.pop(), other, this)
1232
1233
        if allow_overriding_lca:
1234
            if other in unique_lca_vals:
1235
                if this in unique_lca_vals:
1236
                    # Each side picked a different lca, conflict
1237
                    return 'conflict'
1238
                else:
1239
                    # This has a value which supersedes both lca values, and
1240
                    # other only has an lca value
1241
                    return 'this'
1242
            elif this in unique_lca_vals:
1243
                # OTHER has a value which supersedes both lca values, and this
3514.4.19 by John Arbash Meinel
Add the _lca_multi_way function, and explicit tests.
1244
                # only has an lca value
3514.4.30 by John Arbash Meinel
Several updates.
1245
                return 'other'
3514.4.19 by John Arbash Meinel
Add the _lca_multi_way function, and explicit tests.
1246
5128.1.1 by Vincent Ladeuil
Uncontroversial cleanups, mostly comments
1247
        # At this point, the lcas disagree, and the tip disagree
3514.4.19 by John Arbash Meinel
Add the _lca_multi_way function, and explicit tests.
1248
        return 'conflict'
1249
1250
    @staticmethod
5077.2.1 by Vincent Ladeuil
Deprecate Merge3Merger.scalar_three_way.
1251
    @deprecated_method(deprecated_in((2, 2, 0)))
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1252
    def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
1253
        """Do a three-way test on a scalar.
1254
        Return "this", "other" or "conflict", depending whether a value wins.
1255
        """
1256
        key_base = key(base_tree, file_id)
1257
        key_other = key(other_tree, file_id)
1258
        #if base == other, either they all agree, or only THIS has changed.
1259
        if key_base == key_other:
1260
            return "this"
1261
        key_this = key(this_tree, file_id)
3376.2.4 by Martin Pool
Remove every assert statement from bzrlib!
1262
        # "Ambiguous clean merge"
1263
        if key_this == key_other:
1264
            return "this"
1265
        elif key_this == key_base:
1266
            return "other"
1267
        else:
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1268
            return "conflict"
1269
1270
    def merge_names(self, file_id):
1271
        def get_entry(tree):
4869.3.22 by Andrew Bennetts
Use 'tree.has_id(file_id)' rather than using 'file_id in tree' or using tree.inventory.
1272
            if tree.has_id(file_id):
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1273
                return tree.inventory[file_id]
1274
            else:
1275
                return None
1276
        this_entry = get_entry(self.this_tree)
1277
        other_entry = get_entry(self.other_tree)
1278
        base_entry = get_entry(self.base_tree)
2590.2.1 by Aaron Bentley
Start work on merging names based on iter_changes
1279
        entries = (base_entry, other_entry, this_entry)
1280
        names = []
1281
        parents = []
1282
        for entry in entries:
1283
            if entry is None:
1284
                names.append(None)
1285
                parents.append(None)
1286
            else:
1287
                names.append(entry.name)
1288
                parents.append(entry.parent_id)
3514.4.40 by John Arbash Meinel
Make 'resolver' a required parameter.
1289
        return self._merge_names(file_id, parents, names,
1290
                                 resolver=self._three_way)
2590.2.1 by Aaron Bentley
Start work on merging names based on iter_changes
1291
3514.4.40 by John Arbash Meinel
Make 'resolver' a required parameter.
1292
    def _merge_names(self, file_id, parents, names, resolver):
2590.2.7 by Aaron Bentley
Misc cleanup
1293
        """Perform a merge on file_id names and parents"""
2590.2.1 by Aaron Bentley
Start work on merging names based on iter_changes
1294
        base_name, other_name, this_name = names
1295
        base_parent, other_parent, this_parent = parents
2590.2.2 by Aaron Bentley
Do most name merging from iter_changes output
1296
3514.4.21 by John Arbash Meinel
Hook up the lca-way logic into the path handlers.
1297
        name_winner = resolver(*names)
2590.2.1 by Aaron Bentley
Start work on merging names based on iter_changes
1298
3514.4.21 by John Arbash Meinel
Hook up the lca-way logic into the path handlers.
1299
        parent_id_winner = resolver(*parents)
2590.2.2 by Aaron Bentley
Do most name merging from iter_changes output
1300
        if this_name is None:
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1301
            if name_winner == "this":
1302
                name_winner = "other"
1303
            if parent_id_winner == "this":
1304
                parent_id_winner = "other"
1305
        if name_winner == "this" and parent_id_winner == "this":
1306
            return
4597.7.11 by Vincent Ladeuil
Fix #531967 by creating helpers for PathConflicts when a deletion
1307
        if name_winner == 'conflict' or parent_id_winner == 'conflict':
4597.7.18 by Vincent Ladeuil
Start addressing Andrew's concerns.
1308
            # Creating helpers (.OTHER or .THIS) here cause problems down the
1309
            # road if a ContentConflict needs to be created so we should not do
1310
            # that
4597.7.11 by Vincent Ladeuil
Fix #531967 by creating helpers for PathConflicts when a deletion
1311
            trans_id = self.tt.trans_id_file_id(file_id)
1312
            self._raw_conflicts.append(('path conflict', trans_id, file_id,
1313
                                        this_parent, this_name,
1314
                                        other_parent, other_name))
2590.2.2 by Aaron Bentley
Do most name merging from iter_changes output
1315
        if other_name is None:
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1316
            # it doesn't matter whether the result was 'other' or
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1317
            # 'conflict'-- if there's no 'other', we leave it alone.
1318
            return
2590.2.7 by Aaron Bentley
Misc cleanup
1319
        parent_id = parents[self.winner_idx[parent_id_winner]]
1731.1.33 by Aaron Bentley
Revert no-special-root changes
1320
        if parent_id is not None:
4597.7.11 by Vincent Ladeuil
Fix #531967 by creating helpers for PathConflicts when a deletion
1321
            # if we get here, name_winner and parent_winner are set to safe
1322
            # values.
2590.2.7 by Aaron Bentley
Misc cleanup
1323
            self.tt.adjust_path(names[self.winner_idx[name_winner]],
4597.7.11 by Vincent Ladeuil
Fix #531967 by creating helpers for PathConflicts when a deletion
1324
                                self.tt.trans_id_file_id(parent_id),
1325
                                self.tt.trans_id_file_id(file_id))
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1326
4797.5.1 by Robert Collins
Support state on per-file merging to permit more efficient use of configuration data.
1327
    def _do_merge_contents(self, file_id):
3874.2.10 by Vincent Ladeuil
Fix typo.
1328
        """Performs a merge on file_id contents."""
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1329
        def contents_pair(tree):
1330
            if file_id not in tree:
1331
                return (None, None)
1332
            kind = tree.kind(file_id)
1333
            if kind == "file":
1334
                contents = tree.get_file_sha1(file_id)
1335
            elif kind == "symlink":
1336
                contents = tree.get_symlink_target(file_id)
1337
            else:
1338
                contents = None
1339
            return kind, contents
1558.15.3 by Aaron Bentley
Handle binary files for diff3 merges
1340
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1341
        # See SPOT run.  run, SPOT, run.
1342
        # So we're not QUITE repeating ourselves; we do tricky things with
1343
        # file kind...
1344
        base_pair = contents_pair(self.base_tree)
1345
        other_pair = contents_pair(self.other_tree)
3955.2.1 by John Arbash Meinel
Change the workings of merge_content to be lca aware.
1346
        if self._lca_trees:
3948.1.7 by Vincent Ladeuil
Slight refactoring and test fixing.
1347
            this_pair = contents_pair(self.this_tree)
3955.2.1 by John Arbash Meinel
Change the workings of merge_content to be lca aware.
1348
            lca_pairs = [contents_pair(tree) for tree in self._lca_trees]
1349
            winner = self._lca_multi_way((base_pair, lca_pairs), other_pair,
1350
                                         this_pair, allow_overriding_lca=False)
1351
        else:
3948.1.7 by Vincent Ladeuil
Slight refactoring and test fixing.
1352
            if base_pair == other_pair:
1353
                winner = 'this'
1354
            else:
1355
                # We delayed evaluating this_pair as long as we can to avoid
1356
                # unnecessary sha1 calculation
1357
                this_pair = contents_pair(self.this_tree)
1358
                winner = self._three_way(base_pair, other_pair, this_pair)
3955.2.1 by John Arbash Meinel
Change the workings of merge_content to be lca aware.
1359
        if winner == 'this':
1360
            # No interesting changes introduced by OTHER
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1361
            return "unmodified"
4869.3.15 by Andrew Bennetts
Refactor so that the default text merge is the final hook tried. Other hooks can now invoke it directly via merger.default_text_merge if they wish.
1362
        # We have a hypothetical conflict, but if we have files, then we
1363
        # can try to merge the content
4869.3.16 by Andrew Bennetts
Move handling of winner==OTHER case into generic hook path too.
1364
        trans_id = self.tt.trans_id_file_id(file_id)
4869.3.21 by Andrew Bennetts
Pass kinds (not pairs) to MergeHookParams.
1365
        params = MergeHookParams(self, file_id, trans_id, this_pair[0],
1366
            other_pair[0], winner)
4797.5.1 by Robert Collins
Support state on per-file merging to permit more efficient use of configuration data.
1367
        hooks = self.active_hooks
4869.3.15 by Andrew Bennetts
Refactor so that the default text merge is the final hook tried. Other hooks can now invoke it directly via merger.default_text_merge if they wish.
1368
        hook_status = 'not_applicable'
1369
        for hook in hooks:
4797.5.1 by Robert Collins
Support state on per-file merging to permit more efficient use of configuration data.
1370
            hook_status, lines = hook.merge_contents(params)
4869.3.15 by Andrew Bennetts
Refactor so that the default text merge is the final hook tried. Other hooks can now invoke it directly via merger.default_text_merge if they wish.
1371
            if hook_status != 'not_applicable':
1372
                # Don't try any more hooks, this one applies.
4869.3.5 by Andrew Bennetts
Hook is invoked for delete vs. change conflicts, and may choose to result in deleting the file.
1373
                break
4869.3.18 by Andrew Bennetts
Simplify slightly more.
1374
        result = "modified"
4869.3.15 by Andrew Bennetts
Refactor so that the default text merge is the final hook tried. Other hooks can now invoke it directly via merger.default_text_merge if they wish.
1375
        if hook_status == 'not_applicable':
4869.3.17 by Andrew Bennetts
Remove contents_conflict nested function, replace last callsite with simpler form.
1376
            # This is a contents conflict, because none of the available
1377
            # functions could merge it.
4869.3.18 by Andrew Bennetts
Simplify slightly more.
1378
            result = None
4869.3.17 by Andrew Bennetts
Remove contents_conflict nested function, replace last callsite with simpler form.
1379
            name = self.tt.final_name(trans_id)
1380
            parent_id = self.tt.final_parent(trans_id)
4869.3.22 by Andrew Bennetts
Use 'tree.has_id(file_id)' rather than using 'file_id in tree' or using tree.inventory.
1381
            if self.this_tree.has_id(file_id):
4869.3.17 by Andrew Bennetts
Remove contents_conflict nested function, replace last callsite with simpler form.
1382
                self.tt.unversion_file(trans_id)
1383
            file_group = self._dump_conflicts(name, parent_id, file_id,
1384
                                              set_version=True)
1385
            self._raw_conflicts.append(('contents conflict', file_group))
4869.3.15 by Andrew Bennetts
Refactor so that the default text merge is the final hook tried. Other hooks can now invoke it directly via merger.default_text_merge if they wish.
1386
        elif hook_status == 'success':
1387
            self.tt.create_file(lines, trans_id)
1388
        elif hook_status == 'conflicted':
1389
            # XXX: perhaps the hook should be able to provide
1390
            # the BASE/THIS/OTHER files?
1391
            self.tt.create_file(lines, trans_id)
1392
            self._raw_conflicts.append(('text conflict', trans_id))
1393
            name = self.tt.final_name(trans_id)
1394
            parent_id = self.tt.final_parent(trans_id)
4869.3.23 by Andrew Bennetts
Remove some confusing code that has no effect.
1395
            self._dump_conflicts(name, parent_id, file_id)
4869.3.15 by Andrew Bennetts
Refactor so that the default text merge is the final hook tried. Other hooks can now invoke it directly via merger.default_text_merge if they wish.
1396
        elif hook_status == 'delete':
1397
            self.tt.unversion_file(trans_id)
4869.3.18 by Andrew Bennetts
Simplify slightly more.
1398
            result = "deleted"
4869.3.15 by Andrew Bennetts
Refactor so that the default text merge is the final hook tried. Other hooks can now invoke it directly via merger.default_text_merge if they wish.
1399
        elif hook_status == 'done':
1400
            # The hook function did whatever it needs to do directly, no
1401
            # further action needed here.
1402
            pass
1403
        else:
4869.3.18 by Andrew Bennetts
Simplify slightly more.
1404
            raise AssertionError('unknown hook_status: %r' % (hook_status,))
4869.3.22 by Andrew Bennetts
Use 'tree.has_id(file_id)' rather than using 'file_id in tree' or using tree.inventory.
1405
        if not self.this_tree.has_id(file_id) and result == "modified":
4869.3.15 by Andrew Bennetts
Refactor so that the default text merge is the final hook tried. Other hooks can now invoke it directly via merger.default_text_merge if they wish.
1406
            self.tt.version_file(file_id, trans_id)
4869.3.31 by Andrew Bennetts
Add comment, improve doc string, remove redundant line.
1407
        # The merge has been performed, so the old contents should not be
1408
        # retained.
4597.9.13 by Vincent Ladeuil
bzrlib.transform.TreeTransform.tree_kind and
1409
        self.tt.delete_contents(trans_id)
4869.3.18 by Andrew Bennetts
Simplify slightly more.
1410
        return result
4869.3.15 by Andrew Bennetts
Refactor so that the default text merge is the final hook tried. Other hooks can now invoke it directly via merger.default_text_merge if they wish.
1411
4869.3.16 by Andrew Bennetts
Move handling of winner==OTHER case into generic hook path too.
1412
    def _default_other_winner_merge(self, merge_hook_params):
1413
        """Replace this contents with other."""
1414
        file_id = merge_hook_params.file_id
1415
        trans_id = merge_hook_params.trans_id
4869.3.22 by Andrew Bennetts
Use 'tree.has_id(file_id)' rather than using 'file_id in tree' or using tree.inventory.
1416
        file_in_this = self.this_tree.has_id(file_id)
1417
        if self.other_tree.has_id(file_id):
4869.3.16 by Andrew Bennetts
Move handling of winner==OTHER case into generic hook path too.
1418
            # OTHER changed the file
1419
            wt = self.this_tree
1420
            if wt.supports_content_filtering():
1421
                # We get the path from the working tree if it exists.
1422
                # That fails though when OTHER is adding a file, so
1423
                # we fall back to the other tree to find the path if
1424
                # it doesn't exist locally.
1425
                try:
1426
                    filter_tree_path = wt.id2path(file_id)
1427
                except errors.NoSuchId:
1428
                    filter_tree_path = self.other_tree.id2path(file_id)
1429
            else:
1430
                # Skip the id2path lookup for older formats
1431
                filter_tree_path = None
1432
            transform.create_from_tree(self.tt, trans_id,
1433
                             self.other_tree, file_id,
1434
                             filter_tree_path=filter_tree_path)
1435
            return 'done', None
1436
        elif file_in_this:
1437
            # OTHER deleted the file
1438
            return 'delete', None
1439
        else:
1440
            raise AssertionError(
1441
                'winner is OTHER, but file_id %r not in THIS or OTHER tree'
1442
                % (file_id,))
1443
4797.5.1 by Robert Collins
Support state on per-file merging to permit more efficient use of configuration data.
1444
    def merge_contents(self, merge_hook_params):
1445
        """Fallback merge logic after user installed hooks."""
1446
        # This function is used in merge hooks as the fallback instance.
1447
        # Perhaps making this function and the functions it calls be a 
1448
        # a separate class would be better.
4869.3.16 by Andrew Bennetts
Move handling of winner==OTHER case into generic hook path too.
1449
        if merge_hook_params.winner == 'other':
1450
            # OTHER is a straight winner, so replace this contents with other
1451
            return self._default_other_winner_merge(merge_hook_params)
1452
        elif merge_hook_params.is_file_merge():
4869.3.15 by Andrew Bennetts
Refactor so that the default text merge is the final hook tried. Other hooks can now invoke it directly via merger.default_text_merge if they wish.
1453
            # THIS and OTHER are both files, so text merge.  Either
1454
            # BASE is a file, or both converted to files, so at least we
1455
            # have agreement that output should be a file.
1456
            try:
1457
                self.text_merge(merge_hook_params.file_id,
1458
                    merge_hook_params.trans_id)
1459
            except errors.BinaryFile:
1460
                return 'not_applicable', None
4869.3.16 by Andrew Bennetts
Move handling of winner==OTHER case into generic hook path too.
1461
            return 'done', None
4869.3.15 by Andrew Bennetts
Refactor so that the default text merge is the final hook tried. Other hooks can now invoke it directly via merger.default_text_merge if they wish.
1462
        else:
1463
            return 'not_applicable', None
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1464
1465
    def get_lines(self, tree, file_id):
1534.7.157 by Aaron Bentley
Added more docs
1466
        """Return the lines in a file, or an empty list."""
4869.3.22 by Andrew Bennetts
Use 'tree.has_id(file_id)' rather than using 'file_id in tree' or using tree.inventory.
1467
        if tree.has_id(file_id):
4708.2.1 by Martin
Ensure all files opened by bazaar proper are explicitly closed
1468
            return tree.get_file_lines(file_id)
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1469
        else:
1470
            return []
1471
1472
    def text_merge(self, file_id, trans_id):
1473
        """Perform a three-way text merge on a file_id"""
1474
        # it's possible that we got here with base as a different type.
1475
        # if so, we just want two-way text conflicts.
4869.3.22 by Andrew Bennetts
Use 'tree.has_id(file_id)' rather than using 'file_id in tree' or using tree.inventory.
1476
        if self.base_tree.has_id(file_id) and \
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1477
            self.base_tree.kind(file_id) == "file":
1478
            base_lines = self.get_lines(self.base_tree, file_id)
1479
        else:
1480
            base_lines = []
1481
        other_lines = self.get_lines(self.other_tree, file_id)
1482
        this_lines = self.get_lines(self.this_tree, file_id)
4721.3.1 by Vincent Ladeuil
Cleanup imports.
1483
        m3 = merge3.Merge3(base_lines, this_lines, other_lines,
1484
                           is_cherrypick=self.cherrypick)
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1485
        start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
1486
        if self.show_base is True:
1487
            base_marker = '|' * 7
1488
        else:
1489
            base_marker = None
1490
1491
        def iter_merge3(retval):
1492
            retval["text_conflicts"] = False
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1493
            for line in m3.merge_lines(name_a = "TREE",
1494
                                       name_b = "MERGE-SOURCE",
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1495
                                       name_base = "BASE-REVISION",
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1496
                                       start_marker=start_marker,
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1497
                                       base_marker=base_marker,
1498
                                       reprocess=self.reprocess):
1499
                if line.startswith(start_marker):
1500
                    retval["text_conflicts"] = True
1501
                    yield line.replace(start_marker, '<' * 7)
1502
                else:
1503
                    yield line
1504
        retval = {}
1505
        merge3_iterator = iter_merge3(retval)
1506
        self.tt.create_file(merge3_iterator, trans_id)
1507
        if retval["text_conflicts"] is True:
1508
            self._raw_conflicts.append(('text conflict', trans_id))
1509
            name = self.tt.final_name(trans_id)
1510
            parent_id = self.tt.final_parent(trans_id)
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1511
            file_group = self._dump_conflicts(name, parent_id, file_id,
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1512
                                              this_lines, base_lines,
1513
                                              other_lines)
1514
            file_group.append(trans_id)
1515
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1516
    def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1517
                        base_lines=None, other_lines=None, set_version=False,
1518
                        no_base=False):
1534.7.157 by Aaron Bentley
Added more docs
1519
        """Emit conflict files.
1520
        If this_lines, base_lines, or other_lines are omitted, they will be
1521
        determined automatically.  If set_version is true, the .OTHER, .THIS
1522
        or .BASE (in that order) will be created as versioned files.
1523
        """
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1524
        data = [('OTHER', self.other_tree, other_lines),
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1525
                ('THIS', self.this_tree, this_lines)]
1526
        if not no_base:
1527
            data.append(('BASE', self.base_tree, base_lines))
4443.2.1 by Ian Clatworthy
apply content filters when merging new files
1528
1529
        # We need to use the actual path in the working tree of the file here,
1530
        # ignoring the conflict suffixes
1531
        wt = self.this_tree
1532
        if wt.supports_content_filtering():
1533
            try:
1534
                filter_tree_path = wt.id2path(file_id)
1535
            except errors.NoSuchId:
1536
                # file has been deleted
1537
                filter_tree_path = None
1538
        else:
1539
            # Skip the id2path lookup for older formats
1540
            filter_tree_path = None
1541
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1542
        versioned = False
1543
        file_group = []
1544
        for suffix, tree, lines in data:
4869.3.22 by Andrew Bennetts
Use 'tree.has_id(file_id)' rather than using 'file_id in tree' or using tree.inventory.
1545
            if tree.has_id(file_id):
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1546
                trans_id = self._conflict_file(name, parent_id, tree, file_id,
4443.2.1 by Ian Clatworthy
apply content filters when merging new files
1547
                                               suffix, lines, filter_tree_path)
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1548
                file_group.append(trans_id)
1549
                if set_version and not versioned:
1550
                    self.tt.version_file(file_id, trans_id)
1551
                    versioned = True
1552
        return file_group
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1553
3363.17.21 by Aaron Bentley
Conflicts are handled when merging from preview trees
1554
    def _conflict_file(self, name, parent_id, tree, file_id, suffix,
4443.2.1 by Ian Clatworthy
apply content filters when merging new files
1555
                       lines=None, filter_tree_path=None):
1534.7.157 by Aaron Bentley
Added more docs
1556
        """Emit a single conflict file."""
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1557
        name = name + '.' + suffix
1558
        trans_id = self.tt.create_path(name, parent_id)
4854.1.1 by Andrew Bennetts
Merge lp:bzr/2.0 into lp:bzr.
1559
        transform.create_from_tree(self.tt, trans_id, tree, file_id, lines,
4443.2.1 by Ian Clatworthy
apply content filters when merging new files
1560
            filter_tree_path)
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1561
        return trans_id
1562
1563
    def merge_executable(self, file_id, file_status):
1534.7.157 by Aaron Bentley
Added more docs
1564
        """Perform a merge on the execute bit."""
2590.2.3 by Aaron Bentley
Merge the execute bit based on iter_changes
1565
        executable = [self.executable(t, file_id) for t in (self.base_tree,
1566
                      self.other_tree, self.this_tree)]
3514.4.40 by John Arbash Meinel
Make 'resolver' a required parameter.
1567
        self._merge_executable(file_id, executable, file_status,
1568
                               resolver=self._three_way)
2590.2.3 by Aaron Bentley
Merge the execute bit based on iter_changes
1569
3514.4.21 by John Arbash Meinel
Hook up the lca-way logic into the path handlers.
1570
    def _merge_executable(self, file_id, executable, file_status,
3514.4.40 by John Arbash Meinel
Make 'resolver' a required parameter.
1571
                          resolver):
2590.2.3 by Aaron Bentley
Merge the execute bit based on iter_changes
1572
        """Perform a merge on the execute bit."""
1573
        base_executable, other_executable, this_executable = executable
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1574
        if file_status == "deleted":
1575
            return
3514.4.21 by John Arbash Meinel
Hook up the lca-way logic into the path handlers.
1576
        winner = resolver(*executable)
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1577
        if winner == "conflict":
1578
        # There must be a None in here, if we have a conflict, but we
1579
        # need executability since file status was not deleted.
1534.10.35 by Aaron Bentley
Merge handles contents + executable + deletion conflict
1580
            if self.executable(self.other_tree, file_id) is None:
1534.7.142 by Aaron Bentley
Fixed executability conflicts
1581
                winner = "this"
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1582
            else:
1534.7.142 by Aaron Bentley
Fixed executability conflicts
1583
                winner = "other"
1551.19.30 by Aaron Bentley
Accelerate merge by skipping file existence check when merging execute bit
1584
        if winner == 'this' and file_status != "modified":
1585
            return
1586
        trans_id = self.tt.trans_id_file_id(file_id)
4597.9.7 by Vincent Ladeuil
transform.final_kind() now returns None instead of raising NoSuchFile.
1587
        if self.tt.final_kind(trans_id) != "file":
1551.19.30 by Aaron Bentley
Accelerate merge by skipping file existence check when merging execute bit
1588
            return
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1589
        if winner == "this":
1551.19.30 by Aaron Bentley
Accelerate merge by skipping file existence check when merging execute bit
1590
            executability = this_executable
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1591
        else:
4869.3.22 by Andrew Bennetts
Use 'tree.has_id(file_id)' rather than using 'file_id in tree' or using tree.inventory.
1592
            if self.other_tree.has_id(file_id):
2590.2.3 by Aaron Bentley
Merge the execute bit based on iter_changes
1593
                executability = other_executable
4869.3.22 by Andrew Bennetts
Use 'tree.has_id(file_id)' rather than using 'file_id in tree' or using tree.inventory.
1594
            elif self.this_tree.has_id(file_id):
2590.2.3 by Aaron Bentley
Merge the execute bit based on iter_changes
1595
                executability = this_executable
4869.3.22 by Andrew Bennetts
Use 'tree.has_id(file_id)' rather than using 'file_id in tree' or using tree.inventory.
1596
            elif self.base_tree_has_id(file_id):
2590.2.3 by Aaron Bentley
Merge the execute bit based on iter_changes
1597
                executability = base_executable
1551.19.30 by Aaron Bentley
Accelerate merge by skipping file existence check when merging execute bit
1598
        if executability is not None:
1599
            trans_id = self.tt.trans_id_file_id(file_id)
1600
            self.tt.set_executability(executability, trans_id)
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1601
1534.7.172 by Aaron Bentley
Integrated fs conflicts with merge conflicts.
1602
    def cook_conflicts(self, fs_conflicts):
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1603
        """Convert all conflicts into a form that doesn't depend on trans_id"""
4721.3.1 by Vincent Ladeuil
Cleanup imports.
1604
        self.cooked_conflicts.extend(transform.cook_conflicts(
1605
                fs_conflicts, self.tt))
1606
        fp = transform.FinalPaths(self.tt)
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1607
        for conflict in self._raw_conflicts:
1608
            conflict_type = conflict[0]
4597.7.11 by Vincent Ladeuil
Fix #531967 by creating helpers for PathConflicts when a deletion
1609
            if conflict_type == 'path conflict':
1610
                (trans_id, file_id,
1611
                this_parent, this_name,
1612
                other_parent, other_name) = conflict[1:]
1613
                if this_parent is None or this_name is None:
1614
                    this_path = '<deleted>'
1615
                else:
1616
                    parent_path =  fp.get_path(
1617
                        self.tt.trans_id_file_id(this_parent))
1618
                    this_path = osutils.pathjoin(parent_path, this_name)
1619
                if other_parent is None or other_name is None:
1620
                    other_path = '<deleted>'
1621
                else:
1622
                    parent_path =  fp.get_path(
1623
                        self.tt.trans_id_file_id(other_parent))
1624
                    other_path = osutils.pathjoin(parent_path, other_name)
1625
                c = _mod_conflicts.Conflict.factory(
1626
                    'path conflict', path=this_path,
1627
                    conflict_path=other_path,
1628
                    file_id=file_id)
1629
            elif conflict_type == 'contents conflict':
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1630
                for trans_id in conflict[1]:
1631
                    file_id = self.tt.final_file_id(trans_id)
1632
                    if file_id is not None:
1633
                        break
1634
                path = fp.get_path(trans_id)
1635
                for suffix in ('.BASE', '.THIS', '.OTHER'):
1636
                    if path.endswith(suffix):
1637
                        path = path[:-len(suffix)]
1638
                        break
4721.3.1 by Vincent Ladeuil
Cleanup imports.
1639
                c = _mod_conflicts.Conflict.factory(conflict_type,
1640
                                                    path=path, file_id=file_id)
4597.7.11 by Vincent Ladeuil
Fix #531967 by creating helpers for PathConflicts when a deletion
1641
            elif conflict_type == 'text conflict':
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1642
                trans_id = conflict[1]
1643
                path = fp.get_path(trans_id)
1644
                file_id = self.tt.final_file_id(trans_id)
4721.3.1 by Vincent Ladeuil
Cleanup imports.
1645
                c = _mod_conflicts.Conflict.factory(conflict_type,
1646
                                                    path=path, file_id=file_id)
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1647
            else:
4597.7.18 by Vincent Ladeuil
Start addressing Andrew's concerns.
1648
                raise AssertionError('bad conflict type: %r' % (conflict,))
1534.10.19 by Aaron Bentley
Stanza conversion, cooking
1649
            self.cooked_conflicts.append(c)
4721.3.1 by Vincent Ladeuil
Cleanup imports.
1650
        self.cooked_conflicts.sort(key=_mod_conflicts.Conflict.sort_key)
1534.7.141 by Aaron Bentley
Added conflict reporting
1651
1652
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1653
class WeaveMerger(Merge3Merger):
1534.7.167 by Aaron Bentley
PEP8 and comment cleanups
1654
    """Three-way tree merger, text weave merger."""
1551.6.8 by Aaron Bentley
Implemented reprocess for weave
1655
    supports_reprocess = True
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1656
    supports_show_base = False
3062.2.7 by Aaron Bentley
Prevent reverse cherry-picking with weave
1657
    supports_reverse_cherrypick = False
3062.2.9 by Aaron Bentley
Don't use the base if not cherrypicking
1658
    history_based = True
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1659
4634.101.7 by John Arbash Meinel
Start working on the ability to drop a .BASE file for --weave and --lca merge.
1660
    def _generate_merge_plan(self, file_id, base):
1661
        return self.this_tree.plan_file_merge(file_id, self.other_tree,
3062.2.9 by Aaron Bentley
Don't use the base if not cherrypicking
1662
                                              base=base)
4634.101.7 by John Arbash Meinel
Start working on the ability to drop a .BASE file for --weave and --lca merge.
1663
1664
    def _merged_lines(self, file_id):
1665
        """Generate the merged lines.
1666
        There is no distinction between lines that are meant to contain <<<<<<<
1667
        and conflicts.
1668
        """
1669
        if self.cherrypick:
1670
            base = self.base_tree
1671
        else:
1672
            base = None
1673
        plan = self._generate_merge_plan(file_id, base)
1551.19.17 by Aaron Bentley
Add debugging flag for merges
1674
        if 'merge' in debug.debug_flags:
1675
            plan = list(plan)
1676
            trans_id = self.tt.trans_id_file_id(file_id)
1677
            name = self.tt.final_name(trans_id) + '.plan'
4634.101.6 by John Arbash Meinel
killed-both and killed-base is 11 chars long.
1678
            contents = ('%11s|%s' % l for l in plan)
1551.19.17 by Aaron Bentley
Add debugging flag for merges
1679
            self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
4721.3.1 by Vincent Ladeuil
Cleanup imports.
1680
        textmerge = versionedfile.PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1681
                                                 '>>>>>>> MERGE-SOURCE\n')
4634.101.7 by John Arbash Meinel
Start working on the ability to drop a .BASE file for --weave and --lca merge.
1682
        lines, conflicts = textmerge.merge_lines(self.reprocess)
1683
        if conflicts:
1684
            base_lines = textmerge.base_from_plan()
1685
        else:
1686
            base_lines = None
1687
        return lines, base_lines
4869.2.2 by Andrew Bennetts
Remove some duplication.
1688
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1689
    def text_merge(self, file_id, trans_id):
1534.7.157 by Aaron Bentley
Added more docs
1690
        """Perform a (weave) text merge for a given file and file-id.
1691
        If conflicts are encountered, .THIS and .OTHER files will be emitted,
1692
        and a conflict will be noted.
1693
        """
4634.101.7 by John Arbash Meinel
Start working on the ability to drop a .BASE file for --weave and --lca merge.
1694
        lines, base_lines = self._merged_lines(file_id)
1558.15.10 by Aaron Bentley
Merge bzr.dev
1695
        lines = list(lines)
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1696
        # Note we're checking whether the OUTPUT is binary in this case,
1558.15.5 by Aaron Bentley
Fixed binary handling in weave merge
1697
        # because we don't want to get into weave merge guts.
4721.3.1 by Vincent Ladeuil
Cleanup imports.
1698
        textfile.check_text_lines(lines)
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1699
        self.tt.create_file(lines, trans_id)
4634.101.7 by John Arbash Meinel
Start working on the ability to drop a .BASE file for --weave and --lca merge.
1700
        if base_lines is not None:
1701
            # Conflict
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1702
            self._raw_conflicts.append(('text conflict', trans_id))
1703
            name = self.tt.final_name(trans_id)
1704
            parent_id = self.tt.final_parent(trans_id)
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1705
            file_group = self._dump_conflicts(name, parent_id, file_id,
4634.101.7 by John Arbash Meinel
Start working on the ability to drop a .BASE file for --weave and --lca merge.
1706
                                              no_base=False,
1707
                                              base_lines=base_lines)
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1708
            file_group.append(trans_id)
1709
1710
3144.3.1 by Aaron Bentley
Implement LCA merge, with problematic conflict markers
1711
class LCAMerger(WeaveMerger):
1712
4634.101.7 by John Arbash Meinel
Start working on the ability to drop a .BASE file for --weave and --lca merge.
1713
    def _generate_merge_plan(self, file_id, base):
1714
        return self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
3144.3.1 by Aaron Bentley
Implement LCA merge, with problematic conflict markers
1715
                                                  base=base)
1716
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1717
class Diff3Merger(Merge3Merger):
1534.7.167 by Aaron Bentley
PEP8 and comment cleanups
1718
    """Three-way merger using external diff3 for text merging"""
1711.7.20 by John Arbash Meinel
always close files, minor PEP8 cleanup
1719
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1720
    def dump_file(self, temp_dir, name, tree, file_id):
4721.3.1 by Vincent Ladeuil
Cleanup imports.
1721
        out_path = osutils.pathjoin(temp_dir, name)
1711.7.20 by John Arbash Meinel
always close files, minor PEP8 cleanup
1722
        out_file = open(out_path, "wb")
1723
        try:
1724
            in_file = tree.get_file(file_id)
1725
            for line in in_file:
1726
                out_file.write(line)
1727
        finally:
1728
            out_file.close()
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1729
        return out_path
1730
1731
    def text_merge(self, file_id, trans_id):
1534.7.157 by Aaron Bentley
Added more docs
1732
        """Perform a diff3 merge using a specified file-id and trans-id.
1733
        If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
1734
        will be dumped, and a will be conflict noted.
1735
        """
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1736
        import bzrlib.patch
1996.3.18 by John Arbash Meinel
Now that mkdtemp and rmtree are lazy, they should not be directly improted.
1737
        temp_dir = osutils.mkdtemp(prefix="bzr-")
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1738
        try:
4721.3.1 by Vincent Ladeuil
Cleanup imports.
1739
            new_file = osutils.pathjoin(temp_dir, "new")
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1740
            this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
1741
            base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
1742
            other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
1743
            status = bzrlib.patch.diff3(new_file, this, base, other)
1744
            if status not in (0, 1):
4721.3.1 by Vincent Ladeuil
Cleanup imports.
1745
                raise errors.BzrError("Unhandled diff3 exit code")
1711.7.20 by John Arbash Meinel
always close files, minor PEP8 cleanup
1746
            f = open(new_file, 'rb')
1747
            try:
1748
                self.tt.create_file(f, trans_id)
1749
            finally:
1750
                f.close()
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1751
            if status == 1:
1752
                name = self.tt.final_name(trans_id)
1753
                parent_id = self.tt.final_parent(trans_id)
1754
                self._dump_conflicts(name, parent_id, file_id)
1551.8.39 by Aaron Bentley
Fix diff3 conflict-reporting bug
1755
                self._raw_conflicts.append(('text conflict', trans_id))
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1756
        finally:
1996.3.18 by John Arbash Meinel
Now that mkdtemp and rmtree are lazy, they should not be directly improted.
1757
            osutils.rmtree(temp_dir)
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1758
1759
5246.2.18 by Andrew Bennetts
Fix traceback if source path does not exist.
1760
class PathNotInTree(errors.BzrError):
1761
5246.2.28 by Andrew Bennetts
Improve some docstrings.
1762
    _fmt = """Merge-into failed because %(tree)s does not contain %(path)s."""
5246.2.18 by Andrew Bennetts
Fix traceback if source path does not exist.
1763
5246.2.23 by Andrew Bennetts
Fix XXX by adding a test for that case, and don't use AssertionError for a legitimate user error.
1764
    def __init__(self, path, tree):
1765
        errors.BzrError.__init__(self, path=path, tree=tree)
5246.2.18 by Andrew Bennetts
Fix traceback if source path does not exist.
1766
1767
5246.2.1 by Andrew Bennetts
Very rough first draft of cmd_merge_into from bzr-merge-into. Passes its blackbox tests.
1768
class MergeIntoMerger(Merger):
1769
    """Merger that understands other_tree will be merged into a subdir.
1770
1771
    This also changes the Merger api so that it uses real Branch, revision_id,
1772
    and RevisonTree objects, rather than using revision specs.
1773
    """
1774
1775
    def __init__(self, this_tree, other_branch, other_tree, target_subdir,
5246.2.22 by Andrew Bennetts
Minor tweaks.
1776
            source_subpath, other_rev_id=None):
5246.2.1 by Andrew Bennetts
Very rough first draft of cmd_merge_into from bzr-merge-into. Passes its blackbox tests.
1777
        """Create a new MergeIntoMerger object.
1778
5246.2.6 by Andrew Bennetts
Improve some docstrings. Simplify code slightly.
1779
        source_subpath in other_tree will be effectively copied to
1780
        target_subdir in this_tree.
1781
5246.2.1 by Andrew Bennetts
Very rough first draft of cmd_merge_into from bzr-merge-into. Passes its blackbox tests.
1782
        :param this_tree: The tree that we will be merging into.
1783
        :param other_branch: The Branch we will be merging from.
1784
        :param other_tree: The RevisionTree object we want to merge.
1785
        :param target_subdir: The relative path where we want to merge
1786
            other_tree into this_tree
5246.2.6 by Andrew Bennetts
Improve some docstrings. Simplify code slightly.
1787
        :param source_subpath: The relative path specifying the subtree of
1788
            other_tree to merge into this_tree.
5246.2.1 by Andrew Bennetts
Very rough first draft of cmd_merge_into from bzr-merge-into. Passes its blackbox tests.
1789
        """
1790
        # It is assumed that we are merging a tree that is not in our current
1791
        # ancestry, which means we are using the "EmptyTree" as our basis.
1792
        null_ancestor_tree = this_tree.branch.repository.revision_tree(
1793
                                _mod_revision.NULL_REVISION)
1794
        super(MergeIntoMerger, self).__init__(
1795
            this_branch=this_tree.branch,
1796
            this_tree=this_tree,
1797
            other_tree=other_tree,
1798
            base_tree=null_ancestor_tree,
1799
            )
1800
        self._target_subdir = target_subdir
1801
        self._source_subpath = source_subpath
1802
        self.other_branch = other_branch
5246.2.22 by Andrew Bennetts
Minor tweaks.
1803
        if other_rev_id is None:
1804
            other_rev_id = other_tree.get_revision_id()
1805
        self.other_rev_id = self.other_basis = other_rev_id
5246.2.1 by Andrew Bennetts
Very rough first draft of cmd_merge_into from bzr-merge-into. Passes its blackbox tests.
1806
        self.base_is_ancestor = True
1807
        self.backup_files = True
1808
        self.merge_type = Merge3Merger
1809
        self.show_base = False
1810
        self.reprocess = False
1811
        self.interesting_ids = None
5246.2.32 by Andrew Bennetts
Rename _Wrapper to _MergeTypeParameterizer.
1812
        self.merge_type = _MergeTypeParameterizer(MergeIntoMergeType,
1813
              target_subdir=self._target_subdir,
1814
              source_subpath=self._source_subpath)
5246.2.11 by Andrew Bennetts
Handle partial tree merges, add more tests, refactor tests a little.
1815
        if self._source_subpath != '':
1816
            # If this isn't a partial merge make sure the revisions will be
1817
            # present.
1818
            self._maybe_fetch(self.other_branch, self.this_branch,
1819
                self.other_basis)
1820
1821
    def set_pending(self):
1822
        if self._source_subpath != '':
1823
            return
1824
        Merger.set_pending(self)
5246.2.1 by Andrew Bennetts
Very rough first draft of cmd_merge_into from bzr-merge-into. Passes its blackbox tests.
1825
1826
5246.2.32 by Andrew Bennetts
Rename _Wrapper to _MergeTypeParameterizer.
1827
class _MergeTypeParameterizer(object):
5246.2.29 by Andrew Bennetts
Improve some docstrings.
1828
    """Wrap a merge-type class to provide extra parameters.
1829
    
1830
    This is hack used by MergeIntoMerger to pass some extra parameters to its
1831
    merge_type.  Merger.do_merge() sets up its own set of parameters to pass to
1832
    the 'merge_type' member.  It is difficult override do_merge without
1833
    re-writing the whole thing, so instead we create a wrapper which will pass
1834
    the extra parameters.
1835
    """
5246.2.1 by Andrew Bennetts
Very rough first draft of cmd_merge_into from bzr-merge-into. Passes its blackbox tests.
1836
1837
    def __init__(self, merge_type, **kwargs):
1838
        self._extra_kwargs = kwargs
1839
        self._merge_type = merge_type
1840
1841
    def __call__(self, *args, **kwargs):
1842
        kwargs.update(self._extra_kwargs)
1843
        return self._merge_type(*args, **kwargs)
1844
1845
    def __getattr__(self, name):
1846
        return getattr(self._merge_type, name)
1847
1848
5246.2.30 by Andrew Bennetts
Rename Merge3MergeIntoMerger to MergeIntoMergeType.
1849
class MergeIntoMergeType(Merge3Merger):
5246.2.18 by Andrew Bennetts
Fix traceback if source path does not exist.
1850
    """Merger that incorporates a tree (or part of a tree) into another."""
5246.2.1 by Andrew Bennetts
Very rough first draft of cmd_merge_into from bzr-merge-into. Passes its blackbox tests.
1851
1852
    def __init__(self, *args, **kwargs):
5246.2.28 by Andrew Bennetts
Improve some docstrings.
1853
        """Initialize the merger object.
1854
1855
        :param args: See Merge3Merger.__init__'s args.
1856
        :param kwargs: See Merge3Merger.__init__'s keyword args, except for
1857
            source_subpath and target_subdir.
1858
        :keyword source_subpath: The relative path specifying the subtree of
1859
            other_tree to merge into this_tree.
1860
        :keyword target_subdir: The relative path where we want to merge
1861
            other_tree into this_tree
1862
        """
5246.2.1 by Andrew Bennetts
Very rough first draft of cmd_merge_into from bzr-merge-into. Passes its blackbox tests.
1863
        # All of the interesting work happens during Merge3Merger.__init__(),
1864
        # so we have have to hack in to get our extra parameters set.
1865
        self._source_subpath = kwargs.pop('source_subpath')
1866
        self._target_subdir = kwargs.pop('target_subdir')
5246.2.30 by Andrew Bennetts
Rename Merge3MergeIntoMerger to MergeIntoMergeType.
1867
        super(MergeIntoMergeType, self).__init__(*args, **kwargs)
5246.2.1 by Andrew Bennetts
Very rough first draft of cmd_merge_into from bzr-merge-into. Passes its blackbox tests.
1868
1869
    def _compute_transform(self):
1870
        child_pb = ui.ui_factory.nested_progress_bar()
1871
        try:
1872
            entries = self._entries_to_incorporate()
1873
            entries = list(entries)
1874
            for num, (entry, parent_id) in enumerate(entries):
1875
                child_pb.update('Preparing file merge', num, len(entries))
1876
                parent_trans_id = self.tt.trans_id_file_id(parent_id)
1877
                trans_id = transform.new_by_entry(self.tt, entry,
1878
                    parent_trans_id, self.other_tree)
1879
        finally:
1880
            child_pb.finished()
5246.2.33 by Andrew Bennetts
Rename _finish_transform to _finish_computing_transform.
1881
        self._finish_computing_transform()
5246.2.1 by Andrew Bennetts
Very rough first draft of cmd_merge_into from bzr-merge-into. Passes its blackbox tests.
1882
1883
    def _entries_to_incorporate(self):
5246.2.18 by Andrew Bennetts
Fix traceback if source path does not exist.
1884
        """Yields pairs of (inventory_entry, new_parent)."""
5246.2.1 by Andrew Bennetts
Very rough first draft of cmd_merge_into from bzr-merge-into. Passes its blackbox tests.
1885
        other_inv = self.other_tree.inventory
1886
        subdir_id = other_inv.path2id(self._source_subpath)
5246.2.18 by Andrew Bennetts
Fix traceback if source path does not exist.
1887
        if subdir_id is None:
5246.2.20 by Andrew Bennetts
Tweak comments, add NEWS entry.
1888
            # XXX: The error would be clearer if it gave the URL of the source
1889
            # branch, but we don't have a reference to that here.
5246.2.23 by Andrew Bennetts
Fix XXX by adding a test for that case, and don't use AssertionError for a legitimate user error.
1890
            raise PathNotInTree(self._source_subpath, "Source tree")
5246.2.1 by Andrew Bennetts
Very rough first draft of cmd_merge_into from bzr-merge-into. Passes its blackbox tests.
1891
        subdir = other_inv[subdir_id]
1892
        parent_in_target = osutils.dirname(self._target_subdir)
1893
        target_id = self.this_tree.inventory.path2id(parent_in_target)
1894
        if target_id is None:
5246.2.23 by Andrew Bennetts
Fix XXX by adding a test for that case, and don't use AssertionError for a legitimate user error.
1895
            raise PathNotInTree(self._target_subdir, "Target tree")
5246.2.1 by Andrew Bennetts
Very rough first draft of cmd_merge_into from bzr-merge-into. Passes its blackbox tests.
1896
        name_in_target = osutils.basename(self._target_subdir)
1897
        merge_into_root = subdir.copy()
1898
        merge_into_root.name = name_in_target
5246.2.9 by Andrew Bennetts
Make all the existing tests pass.
1899
        if merge_into_root.file_id in self.this_tree.inventory:
5246.2.18 by Andrew Bennetts
Fix traceback if source path does not exist.
1900
            # Give the root a new file-id.
5246.2.23 by Andrew Bennetts
Fix XXX by adding a test for that case, and don't use AssertionError for a legitimate user error.
1901
            # This can happen fairly easily if the directory we are
1902
            # incorporating is the root, and both trees have 'TREE_ROOT' as
1903
            # their root_id.  Users will expect this to Just Work, so we
1904
            # change the file-id here.
1905
            # Non-root file-ids could potentially conflict too.  That's really
1906
            # an edge case, so we don't do anything special for those.  We let
1907
            # them cause conflicts.
5246.2.9 by Andrew Bennetts
Make all the existing tests pass.
1908
            merge_into_root.file_id = generate_ids.gen_file_id(name_in_target)
5246.2.1 by Andrew Bennetts
Very rough first draft of cmd_merge_into from bzr-merge-into. Passes its blackbox tests.
1909
        yield (merge_into_root, target_id)
5246.2.10 by Andrew Bennetts
Add more tests.
1910
        if subdir.kind != 'directory':
1911
            # No children, so we are done.
1912
            return
5246.2.1 by Andrew Bennetts
Very rough first draft of cmd_merge_into from bzr-merge-into. Passes its blackbox tests.
1913
        for ignored_path, entry in other_inv.iter_entries_by_dir(subdir_id):
5246.2.9 by Andrew Bennetts
Make all the existing tests pass.
1914
            parent_id = entry.parent_id
1915
            if parent_id == subdir.file_id:
1916
                # The root's parent ID has changed, so make sure children of
1917
                # the root refer to the new ID.
1918
                parent_id = merge_into_root.file_id
1919
            yield (entry, parent_id)
5246.2.1 by Andrew Bennetts
Very rough first draft of cmd_merge_into from bzr-merge-into. Passes its blackbox tests.
1920
1921
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1922
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
2255.2.31 by Robert Collins
Work in progress to make merge_inner work with dirstate trees.
1923
                backup_files=False,
1924
                merge_type=Merge3Merger,
1925
                interesting_ids=None,
1926
                show_base=False,
1927
                reprocess=False,
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1928
                other_rev_id=None,
1929
                interesting_files=None,
1534.9.9 by Aaron Bentley
Added progress bar to pull
1930
                this_tree=None,
4961.2.9 by Martin Pool
Rip out most remaining uses of DummyProgressBar
1931
                pb=None,
1551.11.10 by Aaron Bentley
Add change reporting to pull
1932
                change_reporter=None):
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1933
    """Primary interface for merging.
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1934
5246.2.1 by Andrew Bennetts
Very rough first draft of cmd_merge_into from bzr-merge-into. Passes its blackbox tests.
1935
    Typical use is probably::
1936
1937
        merge_inner(branch, branch.get_revision_tree(other_revision),
1938
                    branch.get_revision_tree(base_revision))
1939
    """
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1940
    if this_tree is None:
4721.3.1 by Vincent Ladeuil
Cleanup imports.
1941
        raise errors.BzrError("bzrlib.merge.merge_inner requires a this_tree "
1942
                              "parameter as of bzrlib version 0.8.")
2255.2.31 by Robert Collins
Work in progress to make merge_inner work with dirstate trees.
1943
    merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1551.11.10 by Aaron Bentley
Add change reporting to pull
1944
                    pb=pb, change_reporter=change_reporter)
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1945
    merger.backup_files = backup_files
1946
    merger.merge_type = merge_type
1947
    merger.interesting_ids = interesting_ids
1551.2.23 by Aaron Bentley
Got merge_inner's ignore_zero parameter working
1948
    merger.ignore_zero = ignore_zero
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1949
    if interesting_files:
3376.2.4 by Martin Pool
Remove every assert statement from bzrlib!
1950
        if interesting_ids:
1951
            raise ValueError('Only supply interesting_ids'
1952
                             ' or interesting_files')
2590.2.5 by Aaron Bentley
Allow selected files to be specified instead of selected ids
1953
        merger.interesting_files = interesting_files
1979.2.1 by Robert Collins
(robertc) adds a convenience method "merge_from_branch" to WorkingTree.
1954
    merger.show_base = show_base
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1955
    merger.reprocess = reprocess
1956
    merger.other_rev_id = other_rev_id
1957
    merger.other_basis = other_rev_id
3249.3.1 by John Arbash Meinel
Implement cherrypick support for Merge3
1958
    get_revision_id = getattr(base_tree, 'get_revision_id', None)
1959
    if get_revision_id is None:
1960
        get_revision_id = base_tree.last_revision
4595.13.2 by Alexander Belchenko
[cherrypick revno 4650 from bzr.dev] Fix shelve on windows. (Robert Collins, #305006)
1961
    merger.cache_trees_with_revision_ids([other_tree, base_tree, this_tree])
3249.3.1 by John Arbash Meinel
Implement cherrypick support for Merge3
1962
    merger.set_base_revision(get_revision_id(), this_branch)
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1963
    return merger.do_merge()
1964
2221.4.15 by Aaron Bentley
Use RegistryOption for merge type
1965
def get_merge_type_registry():
2221.4.17 by Aaron Bentley
PEP8-ness
1966
    """Merge type registry is in bzrlib.option to avoid circular imports.
2221.4.15 by Aaron Bentley
Use RegistryOption for merge type
1967
1968
    This method provides a sanctioned way to retrieve it.
1969
    """
1970
    from bzrlib import option
2221.4.16 by Aaron Bentley
Add tests for get_merge_type_registry
1971
    return option._merge_type_registry
1551.15.46 by Aaron Bentley
Move plan merge to tree
1972
1973
1974
def _plan_annotate_merge(annotated_a, annotated_b, ancestors_a, ancestors_b):
1975
    def status_a(revision, text):
1976
        if revision in ancestors_b:
1977
            return 'killed-b', text
1978
        else:
1979
            return 'new-a', text
1980
1981
    def status_b(revision, text):
1982
        if revision in ancestors_a:
1983
            return 'killed-a', text
1984
        else:
1985
            return 'new-b', text
1986
1987
    plain_a = [t for (a, t) in annotated_a]
1988
    plain_b = [t for (a, t) in annotated_b]
1989
    matcher = patiencediff.PatienceSequenceMatcher(None, plain_a, plain_b)
1990
    blocks = matcher.get_matching_blocks()
1991
    a_cur = 0
1992
    b_cur = 0
1993
    for ai, bi, l in blocks:
1994
        # process all mismatched sections
1995
        # (last mismatched section is handled because blocks always
1996
        # includes a 0-length last block)
1997
        for revision, text in annotated_a[a_cur:ai]:
1998
            yield status_a(revision, text)
1999
        for revision, text in annotated_b[b_cur:bi]:
2000
            yield status_b(revision, text)
2001
        # and now the matched section
2002
        a_cur = ai + l
2003
        b_cur = bi + l
3376.2.8 by Martin Pool
Some review cleanups for assertion removal
2004
        for text_a in plain_a[ai:a_cur]:
1551.15.46 by Aaron Bentley
Move plan merge to tree
2005
            yield "unchanged", text_a
3062.1.9 by Aaron Bentley
Move PlanMerge into merge and _PlanMergeVersionedFile into versionedfile
2006
2007
3144.3.1 by Aaron Bentley
Implement LCA merge, with problematic conflict markers
2008
class _PlanMergeBase(object):
3062.1.9 by Aaron Bentley
Move PlanMerge into merge and _PlanMergeVersionedFile into versionedfile
2009
3350.6.10 by Martin Pool
VersionedFiles review cleanups
2010
    def __init__(self, a_rev, b_rev, vf, key_prefix):
3062.1.9 by Aaron Bentley
Move PlanMerge into merge and _PlanMergeVersionedFile into versionedfile
2011
        """Contructor.
2012
2013
        :param a_rev: Revision-id of one revision to merge
2014
        :param b_rev: Revision-id of the other revision to merge
3350.6.4 by Robert Collins
First cut at pluralised VersionedFiles. Some rather massive API incompatabilities, primarily because of the difficulty of coherence among competing stores.
2015
        :param vf: A VersionedFiles containing both revisions
3350.6.10 by Martin Pool
VersionedFiles review cleanups
2016
        :param key_prefix: A prefix for accessing keys in vf, typically
2017
            (file_id,).
3062.1.9 by Aaron Bentley
Move PlanMerge into merge and _PlanMergeVersionedFile into versionedfile
2018
        """
2019
        self.a_rev = a_rev
2020
        self.b_rev = b_rev
2021
        self.vf = vf
3062.1.12 by Aaron Bentley
Implement simple text cache
2022
        self._last_lines = None
2023
        self._last_lines_revision_id = None
3144.3.7 by Aaron Bentley
Update from review
2024
        self._cached_matching_blocks = {}
3350.6.10 by Martin Pool
VersionedFiles review cleanups
2025
        self._key_prefix = key_prefix
3514.2.2 by John Arbash Meinel
Restore a real weave merge to 'bzr merge --weave'.
2026
        self._precache_tip_lines()
2027
2028
    def _precache_tip_lines(self):
2029
        lines = self.get_lines([self.a_rev, self.b_rev])
2030
        self.lines_a = lines[self.a_rev]
2031
        self.lines_b = lines[self.b_rev]
3350.6.4 by Robert Collins
First cut at pluralised VersionedFiles. Some rather massive API incompatabilities, primarily because of the difficulty of coherence among competing stores.
2032
2033
    def get_lines(self, revisions):
2034
        """Get lines for revisions from the backing VersionedFiles.
3890.2.9 by John Arbash Meinel
Start using osutils.chunks_as_lines rather than osutils.split_lines.
2035
3350.6.10 by Martin Pool
VersionedFiles review cleanups
2036
        :raises RevisionNotPresent: on absent texts.
3350.6.4 by Robert Collins
First cut at pluralised VersionedFiles. Some rather massive API incompatabilities, primarily because of the difficulty of coherence among competing stores.
2037
        """
3350.6.10 by Martin Pool
VersionedFiles review cleanups
2038
        keys = [(self._key_prefix + (rev,)) for rev in revisions]
3350.6.4 by Robert Collins
First cut at pluralised VersionedFiles. Some rather massive API incompatabilities, primarily because of the difficulty of coherence among competing stores.
2039
        result = {}
2040
        for record in self.vf.get_record_stream(keys, 'unordered', True):
2041
            if record.storage_kind == 'absent':
2042
                raise errors.RevisionNotPresent(record.key, self.vf)
3890.2.9 by John Arbash Meinel
Start using osutils.chunks_as_lines rather than osutils.split_lines.
2043
            result[record.key[-1]] = osutils.chunks_to_lines(
2044
                record.get_bytes_as('chunked'))
3350.6.4 by Robert Collins
First cut at pluralised VersionedFiles. Some rather massive API incompatabilities, primarily because of the difficulty of coherence among competing stores.
2045
        return result
3062.1.9 by Aaron Bentley
Move PlanMerge into merge and _PlanMergeVersionedFile into versionedfile
2046
2047
    def plan_merge(self):
2048
        """Generate a 'plan' for merging the two revisions.
2049
2050
        This involves comparing their texts and determining the cause of
2051
        differences.  If text A has a line and text B does not, then either the
2052
        line was added to text A, or it was deleted from B.  Once the causes
2053
        are combined, they are written out in the format described in
2054
        VersionedFile.plan_merge
2055
        """
2056
        blocks = self._get_matching_blocks(self.a_rev, self.b_rev)
3144.3.1 by Aaron Bentley
Implement LCA merge, with problematic conflict markers
2057
        unique_a, unique_b = self._unique_lines(blocks)
2058
        new_a, killed_b = self._determine_status(self.a_rev, unique_a)
2059
        new_b, killed_a = self._determine_status(self.b_rev, unique_b)
2060
        return self._iter_plan(blocks, new_a, killed_b, new_b, killed_a)
2061
2062
    def _iter_plan(self, blocks, new_a, killed_b, new_b, killed_a):
3062.1.9 by Aaron Bentley
Move PlanMerge into merge and _PlanMergeVersionedFile into versionedfile
2063
        last_i = 0
2064
        last_j = 0
2065
        for i, j, n in blocks:
2066
            for a_index in range(last_i, i):
2067
                if a_index in new_a:
3144.3.2 by Aaron Bentley
Get conflict handling working
2068
                    if a_index in killed_b:
2069
                        yield 'conflicted-a', self.lines_a[a_index]
2070
                    else:
2071
                        yield 'new-a', self.lines_a[a_index]
2072
                else:
3144.3.1 by Aaron Bentley
Implement LCA merge, with problematic conflict markers
2073
                    yield 'killed-b', self.lines_a[a_index]
3062.1.9 by Aaron Bentley
Move PlanMerge into merge and _PlanMergeVersionedFile into versionedfile
2074
            for b_index in range(last_j, j):
2075
                if b_index in new_b:
3144.3.2 by Aaron Bentley
Get conflict handling working
2076
                    if b_index in killed_a:
3144.3.10 by Aaron Bentley
Use correct index when emitting conflicted-b
2077
                        yield 'conflicted-b', self.lines_b[b_index]
3144.3.2 by Aaron Bentley
Get conflict handling working
2078
                    else:
2079
                        yield 'new-b', self.lines_b[b_index]
2080
                else:
3144.3.1 by Aaron Bentley
Implement LCA merge, with problematic conflict markers
2081
                    yield 'killed-a', self.lines_b[b_index]
3062.1.9 by Aaron Bentley
Move PlanMerge into merge and _PlanMergeVersionedFile into versionedfile
2082
            # handle common lines
2083
            for a_index in range(i, i+n):
3144.3.1 by Aaron Bentley
Implement LCA merge, with problematic conflict markers
2084
                yield 'unchanged', self.lines_a[a_index]
3062.1.9 by Aaron Bentley
Move PlanMerge into merge and _PlanMergeVersionedFile into versionedfile
2085
            last_i = i+n
2086
            last_j = j+n
2087
2088
    def _get_matching_blocks(self, left_revision, right_revision):
2089
        """Return a description of which sections of two revisions match.
2090
2091
        See SequenceMatcher.get_matching_blocks
2092
        """
3144.3.7 by Aaron Bentley
Update from review
2093
        cached = self._cached_matching_blocks.get((left_revision,
2094
                                                   right_revision))
2095
        if cached is not None:
2096
            return cached
3062.1.12 by Aaron Bentley
Implement simple text cache
2097
        if self._last_lines_revision_id == left_revision:
2098
            left_lines = self._last_lines
3350.6.4 by Robert Collins
First cut at pluralised VersionedFiles. Some rather massive API incompatabilities, primarily because of the difficulty of coherence among competing stores.
2099
            right_lines = self.get_lines([right_revision])[right_revision]
3062.1.12 by Aaron Bentley
Implement simple text cache
2100
        else:
3350.6.4 by Robert Collins
First cut at pluralised VersionedFiles. Some rather massive API incompatabilities, primarily because of the difficulty of coherence among competing stores.
2101
            lines = self.get_lines([left_revision, right_revision])
2102
            left_lines = lines[left_revision]
2103
            right_lines = lines[right_revision]
3062.1.12 by Aaron Bentley
Implement simple text cache
2104
        self._last_lines = right_lines
2105
        self._last_lines_revision_id = right_revision
3062.1.9 by Aaron Bentley
Move PlanMerge into merge and _PlanMergeVersionedFile into versionedfile
2106
        matcher = patiencediff.PatienceSequenceMatcher(None, left_lines,
2107
                                                       right_lines)
2108
        return matcher.get_matching_blocks()
2109
2110
    def _unique_lines(self, matching_blocks):
2111
        """Analyse matching_blocks to determine which lines are unique
2112
2113
        :return: a tuple of (unique_left, unique_right), where the values are
2114
            sets of line numbers of unique lines.
2115
        """
2116
        last_i = 0
2117
        last_j = 0
2118
        unique_left = []
2119
        unique_right = []
2120
        for i, j, n in matching_blocks:
2121
            unique_left.extend(range(last_i, i))
2122
            unique_right.extend(range(last_j, j))
2123
            last_i = i + n
2124
            last_j = j + n
2125
        return unique_left, unique_right
2126
3144.3.1 by Aaron Bentley
Implement LCA merge, with problematic conflict markers
2127
    @staticmethod
2128
    def _subtract_plans(old_plan, new_plan):
3144.3.7 by Aaron Bentley
Update from review
2129
        """Remove changes from new_plan that came from old_plan.
2130
2131
        It is assumed that the difference between the old_plan and new_plan
2132
        is their choice of 'b' text.
2133
2134
        All lines from new_plan that differ from old_plan are emitted
2135
        verbatim.  All lines from new_plan that match old_plan but are
2136
        not about the 'b' revision are emitted verbatim.
2137
2138
        Lines that match and are about the 'b' revision are the lines we
2139
        don't want, so we convert 'killed-b' -> 'unchanged', and 'new-b'
2140
        is skipped entirely.
2141
        """
3144.3.1 by Aaron Bentley
Implement LCA merge, with problematic conflict markers
2142
        matcher = patiencediff.PatienceSequenceMatcher(None, old_plan,
2143
                                                       new_plan)
2144
        last_j = 0
2145
        for i, j, n in matcher.get_matching_blocks():
2146
            for jj in range(last_j, j):
2147
                yield new_plan[jj]
2148
            for jj in range(j, j+n):
2149
                plan_line = new_plan[jj]
2150
                if plan_line[0] == 'new-b':
2151
                    pass
2152
                elif plan_line[0] == 'killed-b':
2153
                    yield 'unchanged', plan_line[1]
2154
                else:
2155
                    yield plan_line
2156
            last_j = j + n
2157
2158
2159
class _PlanMerge(_PlanMergeBase):
2160
    """Plan an annotate merge using on-the-fly annotation"""
2161
3350.6.10 by Martin Pool
VersionedFiles review cleanups
2162
    def __init__(self, a_rev, b_rev, vf, key_prefix):
3514.2.2 by John Arbash Meinel
Restore a real weave merge to 'bzr merge --weave'.
2163
        super(_PlanMerge, self).__init__(a_rev, b_rev, vf, key_prefix)
2164
        self.a_key = self._key_prefix + (self.a_rev,)
2165
        self.b_key = self._key_prefix + (self.b_rev,)
4721.3.1 by Vincent Ladeuil
Cleanup imports.
2166
        self.graph = _mod_graph.Graph(self.vf)
3514.2.11 by John Arbash Meinel
Shortcut the case when one revision is in the ancestry of the other.
2167
        heads = self.graph.heads((self.a_key, self.b_key))
2168
        if len(heads) == 1:
2169
            # one side dominates, so we can just return its values, yay for
2170
            # per-file graphs
2171
            # Ideally we would know that before we get this far
2172
            self._head_key = heads.pop()
2173
            if self._head_key == self.a_key:
2174
                other = b_rev
2175
            else:
2176
                other = a_rev
4721.3.1 by Vincent Ladeuil
Cleanup imports.
2177
            trace.mutter('found dominating revision for %s\n%s > %s', self.vf,
2178
                         self._head_key[-1], other)
3514.2.11 by John Arbash Meinel
Shortcut the case when one revision is in the ancestry of the other.
2179
            self._weave = None
2180
        else:
2181
            self._head_key = None
2182
            self._build_weave()
3514.2.2 by John Arbash Meinel
Restore a real weave merge to 'bzr merge --weave'.
2183
2184
    def _precache_tip_lines(self):
2185
        # Turn this into a no-op, because we will do this later
2186
        pass
2187
2188
    def _find_recursive_lcas(self):
2189
        """Find all the ancestors back to a unique lca"""
2190
        cur_ancestors = (self.a_key, self.b_key)
2191
        # graph.find_lca(uncommon, keys) now returns plain NULL_REVISION,
3514.2.5 by John Arbash Meinel
Switch to the get_parent_map design I had settled on.
2192
        # rather than a key tuple. We will just map that directly to no common
2193
        # ancestors.
2194
        parent_map = {}
3514.2.2 by John Arbash Meinel
Restore a real weave merge to 'bzr merge --weave'.
2195
        while True:
2196
            next_lcas = self.graph.find_lca(*cur_ancestors)
3514.2.5 by John Arbash Meinel
Switch to the get_parent_map design I had settled on.
2197
            # Map a plain NULL_REVISION to a simple no-ancestors
4721.3.1 by Vincent Ladeuil
Cleanup imports.
2198
            if next_lcas == set([_mod_revision.NULL_REVISION]):
3514.2.5 by John Arbash Meinel
Switch to the get_parent_map design I had settled on.
2199
                next_lcas = ()
3514.2.9 by John Arbash Meinel
Add some debugging, and work on getting the graph right so we get the weave insertion order correct.
2200
            # Order the lca's based on when they were merged into the tip
2201
            # While the actual merge portion of weave merge uses a set() of
2202
            # active revisions, the order of insertion *does* effect the
2203
            # implicit ordering of the texts.
3514.2.5 by John Arbash Meinel
Switch to the get_parent_map design I had settled on.
2204
            for rev_key in cur_ancestors:
3514.2.9 by John Arbash Meinel
Add some debugging, and work on getting the graph right so we get the weave insertion order correct.
2205
                ordered_parents = tuple(self.graph.find_merge_order(rev_key,
2206
                                                                    next_lcas))
2207
                parent_map[rev_key] = ordered_parents
3514.2.2 by John Arbash Meinel
Restore a real weave merge to 'bzr merge --weave'.
2208
            if len(next_lcas) == 0:
2209
                break
2210
            elif len(next_lcas) == 1:
3514.2.9 by John Arbash Meinel
Add some debugging, and work on getting the graph right so we get the weave insertion order correct.
2211
                parent_map[list(next_lcas)[0]] = ()
3514.2.2 by John Arbash Meinel
Restore a real weave merge to 'bzr merge --weave'.
2212
                break
3514.2.10 by John Arbash Meinel
Handle more edge cases.
2213
            elif len(next_lcas) > 2:
3514.2.7 by John Arbash Meinel
Fix the failing test by implementing the fallback logic.
2214
                # More than 2 lca's, fall back to grabbing all nodes between
2215
                # this and the unique lca.
4721.3.1 by Vincent Ladeuil
Cleanup imports.
2216
                trace.mutter('More than 2 LCAs, falling back to all nodes for:'
2217
                             ' %s, %s\n=> %s',
2218
                             self.a_key, self.b_key, cur_ancestors)
3514.2.7 by John Arbash Meinel
Fix the failing test by implementing the fallback logic.
2219
                cur_lcas = next_lcas
2220
                while len(cur_lcas) > 1:
2221
                    cur_lcas = self.graph.find_lca(*cur_lcas)
2222
                if len(cur_lcas) == 0:
2223
                    # No common base to find, use the full ancestry
2224
                    unique_lca = None
2225
                else:
3514.2.8 by John Arbash Meinel
The insertion ordering into the weave has an impact on conflicts.
2226
                    unique_lca = list(cur_lcas)[0]
4721.3.1 by Vincent Ladeuil
Cleanup imports.
2227
                    if unique_lca == _mod_revision.NULL_REVISION:
3514.2.14 by John Arbash Meinel
Bring in the code to collapse linear portions of the graph.
2228
                        # find_lca will return a plain 'NULL_REVISION' rather
2229
                        # than a key tuple when there is no common ancestor, we
2230
                        # prefer to just use None, because it doesn't confuse
2231
                        # _get_interesting_texts()
2232
                        unique_lca = None
3514.2.7 by John Arbash Meinel
Fix the failing test by implementing the fallback logic.
2233
                parent_map.update(self._find_unique_parents(next_lcas,
2234
                                                            unique_lca))
2235
                break
3514.2.2 by John Arbash Meinel
Restore a real weave merge to 'bzr merge --weave'.
2236
            cur_ancestors = next_lcas
3514.2.5 by John Arbash Meinel
Switch to the get_parent_map design I had settled on.
2237
        return parent_map
3514.2.2 by John Arbash Meinel
Restore a real weave merge to 'bzr merge --weave'.
2238
3514.2.7 by John Arbash Meinel
Fix the failing test by implementing the fallback logic.
2239
    def _find_unique_parents(self, tip_keys, base_key):
2240
        """Find ancestors of tip that aren't ancestors of base.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2241
3514.2.7 by John Arbash Meinel
Fix the failing test by implementing the fallback logic.
2242
        :param tip_keys: Nodes that are interesting
2243
        :param base_key: Cull all ancestors of this node
2244
        :return: The parent map for all revisions between tip_keys and
2245
            base_key. base_key will be included. References to nodes outside of
2246
            the ancestor set will also be removed.
2247
        """
2248
        # TODO: this would be simpler if find_unique_ancestors took a list
2249
        #       instead of a single tip, internally it supports it, but it
2250
        #       isn't a "backwards compatible" api change.
2251
        if base_key is None:
2252
            parent_map = dict(self.graph.iter_ancestry(tip_keys))
3514.2.14 by John Arbash Meinel
Bring in the code to collapse linear portions of the graph.
2253
            # We remove NULL_REVISION because it isn't a proper tuple key, and
2254
            # thus confuses things like _get_interesting_texts, and our logic
2255
            # to add the texts into the memory weave.
4721.3.1 by Vincent Ladeuil
Cleanup imports.
2256
            if _mod_revision.NULL_REVISION in parent_map:
2257
                parent_map.pop(_mod_revision.NULL_REVISION)
3514.2.7 by John Arbash Meinel
Fix the failing test by implementing the fallback logic.
2258
        else:
2259
            interesting = set()
2260
            for tip in tip_keys:
2261
                interesting.update(
2262
                    self.graph.find_unique_ancestors(tip, [base_key]))
2263
            parent_map = self.graph.get_parent_map(interesting)
2264
            parent_map[base_key] = ()
3514.2.12 by John Arbash Meinel
Start refactoring into helper functions
2265
        culled_parent_map, child_map, tails = self._remove_external_references(
2266
            parent_map)
3514.2.13 by John Arbash Meinel
Add the ability to prune extra tails from the parent_map.
2267
        # Remove all the tails but base_key
3514.2.14 by John Arbash Meinel
Bring in the code to collapse linear portions of the graph.
2268
        if base_key is not None:
2269
            tails.remove(base_key)
2270
            self._prune_tails(culled_parent_map, child_map, tails)
2271
        # Now remove all the uninteresting 'linear' regions
3514.2.15 by John Arbash Meinel
Enable collapsing linear regions.
2272
        simple_map = _mod_graph.collapse_linear_regions(culled_parent_map)
2273
        return simple_map
3514.2.12 by John Arbash Meinel
Start refactoring into helper functions
2274
2275
    @staticmethod
2276
    def _remove_external_references(parent_map):
2277
        """Remove references that go outside of the parent map.
2278
2279
        :param parent_map: Something returned from Graph.get_parent_map(keys)
2280
        :return: (filtered_parent_map, child_map, tails)
2281
            filtered_parent_map is parent_map without external references
2282
            child_map is the {parent_key: [child_keys]} mapping
2283
            tails is a list of nodes that do not have any parents in the map
2284
        """
2285
        # TODO: The basic effect of this function seems more generic than
2286
        #       _PlanMerge. But the specific details of building a child_map,
2287
        #       and computing tails seems very specific to _PlanMerge.
2288
        #       Still, should this be in Graph land?
2289
        filtered_parent_map = {}
2290
        child_map = {}
2291
        tails = []
3514.2.7 by John Arbash Meinel
Fix the failing test by implementing the fallback logic.
2292
        for key, parent_keys in parent_map.iteritems():
3514.2.12 by John Arbash Meinel
Start refactoring into helper functions
2293
            culled_parent_keys = [p for p in parent_keys if p in parent_map]
2294
            if not culled_parent_keys:
2295
                tails.append(key)
2296
            for parent_key in culled_parent_keys:
2297
                child_map.setdefault(parent_key, []).append(key)
2298
            # TODO: Do we want to do this, it adds overhead for every node,
2299
            #       just to say that the node has no children
2300
            child_map.setdefault(key, [])
2301
            filtered_parent_map[key] = culled_parent_keys
2302
        return filtered_parent_map, child_map, tails
2303
3514.2.13 by John Arbash Meinel
Add the ability to prune extra tails from the parent_map.
2304
    @staticmethod
2305
    def _prune_tails(parent_map, child_map, tails_to_remove):
2306
        """Remove tails from the parent map.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2307
3514.2.13 by John Arbash Meinel
Add the ability to prune extra tails from the parent_map.
2308
        This will remove the supplied revisions until no more children have 0
2309
        parents.
2310
2311
        :param parent_map: A dict of {child: [parents]}, this dictionary will
2312
            be modified in place.
2313
        :param tails_to_remove: A list of tips that should be removed,
2314
            this list will be consumed
2315
        :param child_map: The reverse dict of parent_map ({parent: [children]})
2316
            this dict will be modified
2317
        :return: None, parent_map will be modified in place.
2318
        """
2319
        while tails_to_remove:
2320
            next = tails_to_remove.pop()
2321
            parent_map.pop(next)
2322
            children = child_map.pop(next)
2323
            for child in children:
2324
                child_parents = parent_map[child]
2325
                child_parents.remove(next)
2326
                if len(child_parents) == 0:
2327
                    tails_to_remove.append(child)
3514.2.7 by John Arbash Meinel
Fix the failing test by implementing the fallback logic.
2328
3514.2.5 by John Arbash Meinel
Switch to the get_parent_map design I had settled on.
2329
    def _get_interesting_texts(self, parent_map):
3514.2.2 by John Arbash Meinel
Restore a real weave merge to 'bzr merge --weave'.
2330
        """Return a dict of texts we are interested in.
2331
2332
        Note that the input is in key tuples, but the output is in plain
2333
        revision ids.
2334
3514.2.5 by John Arbash Meinel
Switch to the get_parent_map design I had settled on.
2335
        :param parent_map: The output from _find_recursive_lcas
3514.2.2 by John Arbash Meinel
Restore a real weave merge to 'bzr merge --weave'.
2336
        :return: A dict of {'revision_id':lines} as returned by
2337
            _PlanMergeBase.get_lines()
2338
        """
3514.2.5 by John Arbash Meinel
Switch to the get_parent_map design I had settled on.
2339
        all_revision_keys = set(parent_map)
2340
        all_revision_keys.add(self.a_key)
2341
        all_revision_keys.add(self.b_key)
3514.2.2 by John Arbash Meinel
Restore a real weave merge to 'bzr merge --weave'.
2342
3514.2.5 by John Arbash Meinel
Switch to the get_parent_map design I had settled on.
2343
        # Everything else is in 'keys' but get_lines is in 'revision_ids'
2344
        all_texts = self.get_lines([k[-1] for k in all_revision_keys])
3514.2.2 by John Arbash Meinel
Restore a real weave merge to 'bzr merge --weave'.
2345
        return all_texts
2346
2347
    def _build_weave(self):
2348
        from bzrlib import weave
2349
        self._weave = weave.Weave(weave_name='in_memory_weave',
2350
                                  allow_reserved=True)
3514.2.5 by John Arbash Meinel
Switch to the get_parent_map design I had settled on.
2351
        parent_map = self._find_recursive_lcas()
2352
2353
        all_texts = self._get_interesting_texts(parent_map)
2354
2355
        # Note: Unfortunately, the order given by topo_sort will effect the
2356
        # ordering resolution in the output. Specifically, if you add A then B,
2357
        # then in the output text A lines will show up before B lines. And, of
2358
        # course, topo_sort doesn't guarantee any real ordering.
3514.2.8 by John Arbash Meinel
The insertion ordering into the weave has an impact on conflicts.
2359
        # So we use merge_sort, and add a fake node on the tip.
2360
        # This ensures that left-hand parents will always be inserted into the
2361
        # weave before right-hand parents.
2362
        tip_key = self._key_prefix + (_mod_revision.CURRENT_REVISION,)
2363
        parent_map[tip_key] = (self.a_key, self.b_key)
2364
2365
        for seq_num, key, depth, eom in reversed(tsort.merge_sort(parent_map,
2366
                                                                  tip_key)):
2367
            if key == tip_key:
2368
                continue
3514.2.9 by John Arbash Meinel
Add some debugging, and work on getting the graph right so we get the weave insertion order correct.
2369
        # for key in tsort.topo_sort(parent_map):
3514.2.5 by John Arbash Meinel
Switch to the get_parent_map design I had settled on.
2370
            parent_keys = parent_map[key]
2371
            revision_id = key[-1]
2372
            parent_ids = [k[-1] for k in parent_keys]
2373
            self._weave.add_lines(revision_id, parent_ids,
2374
                                  all_texts[revision_id])
3514.2.2 by John Arbash Meinel
Restore a real weave merge to 'bzr merge --weave'.
2375
2376
    def plan_merge(self):
2377
        """Generate a 'plan' for merging the two revisions.
2378
2379
        This involves comparing their texts and determining the cause of
2380
        differences.  If text A has a line and text B does not, then either the
2381
        line was added to text A, or it was deleted from B.  Once the causes
2382
        are combined, they are written out in the format described in
2383
        VersionedFile.plan_merge
2384
        """
2385
        if self._head_key is not None: # There was a single head
2386
            if self._head_key == self.a_key:
2387
                plan = 'new-a'
3062.1.9 by Aaron Bentley
Move PlanMerge into merge and _PlanMergeVersionedFile into versionedfile
2388
            else:
3514.2.2 by John Arbash Meinel
Restore a real weave merge to 'bzr merge --weave'.
2389
                if self._head_key != self.b_key:
2390
                    raise AssertionError('There was an invalid head: %s != %s'
2391
                                         % (self.b_key, self._head_key))
2392
                plan = 'new-b'
3514.2.16 by John Arbash Meinel
Review feedback from Ian.
2393
            head_rev = self._head_key[-1]
2394
            lines = self.get_lines([head_rev])[head_rev]
3514.2.2 by John Arbash Meinel
Restore a real weave merge to 'bzr merge --weave'.
2395
            return ((plan, line) for line in lines)
2396
        return self._weave.plan_merge(self.a_rev, self.b_rev)
3062.2.1 by Aaron Bentley
Add support for plan-merge with a base
2397
3144.3.1 by Aaron Bentley
Implement LCA merge, with problematic conflict markers
2398
2399
class _PlanLCAMerge(_PlanMergeBase):
2400
    """
3144.3.7 by Aaron Bentley
Update from review
2401
    This merge algorithm differs from _PlanMerge in that:
3144.3.1 by Aaron Bentley
Implement LCA merge, with problematic conflict markers
2402
    1. comparisons are done against LCAs only
2403
    2. cases where a contested line is new versus one LCA but old versus
3144.3.7 by Aaron Bentley
Update from review
2404
       another are marked as conflicts, by emitting the line as conflicted-a
2405
       or conflicted-b.
3144.3.1 by Aaron Bentley
Implement LCA merge, with problematic conflict markers
2406
2407
    This is faster, and hopefully produces more useful output.
2408
    """
2409
3350.6.10 by Martin Pool
VersionedFiles review cleanups
2410
    def __init__(self, a_rev, b_rev, vf, key_prefix, graph):
2411
        _PlanMergeBase.__init__(self, a_rev, b_rev, vf, key_prefix)
2412
        lcas = graph.find_lca(key_prefix + (a_rev,), key_prefix + (b_rev,))
3350.6.5 by Robert Collins
Update to bzr.dev.
2413
        self.lcas = set()
2414
        for lca in lcas:
4721.3.1 by Vincent Ladeuil
Cleanup imports.
2415
            if lca == _mod_revision.NULL_REVISION:
3350.6.5 by Robert Collins
Update to bzr.dev.
2416
                self.lcas.add(lca)
2417
            else:
2418
                self.lcas.add(lca[-1])
3144.3.7 by Aaron Bentley
Update from review
2419
        for lca in self.lcas:
3287.17.1 by John Arbash Meinel
Fix bug #235715 by using the empty list as the text for a base of NULL_REVISION.
2420
            if _mod_revision.is_null(lca):
2421
                lca_lines = []
2422
            else:
3350.6.5 by Robert Collins
Update to bzr.dev.
2423
                lca_lines = self.get_lines([lca])[lca]
3144.3.7 by Aaron Bentley
Update from review
2424
            matcher = patiencediff.PatienceSequenceMatcher(None, self.lines_a,
2425
                                                           lca_lines)
2426
            blocks = list(matcher.get_matching_blocks())
2427
            self._cached_matching_blocks[(a_rev, lca)] = blocks
2428
            matcher = patiencediff.PatienceSequenceMatcher(None, self.lines_b,
2429
                                                           lca_lines)
2430
            blocks = list(matcher.get_matching_blocks())
2431
            self._cached_matching_blocks[(b_rev, lca)] = blocks
3144.3.1 by Aaron Bentley
Implement LCA merge, with problematic conflict markers
2432
3144.3.7 by Aaron Bentley
Update from review
2433
    def _determine_status(self, revision_id, unique_line_numbers):
3144.3.1 by Aaron Bentley
Implement LCA merge, with problematic conflict markers
2434
        """Determines the status unique lines versus all lcas.
2435
2436
        Basically, determines why the line is unique to this revision.
2437
2438
        A line may be determined new, killed, or both.
2439
3144.3.7 by Aaron Bentley
Update from review
2440
        If a line is determined new, that means it was not present in at least
2441
        one LCA, and is not present in the other merge revision.
3144.3.1 by Aaron Bentley
Implement LCA merge, with problematic conflict markers
2442
2443
        If a line is determined killed, that means the line was present in
2444
        at least one LCA.
2445
2446
        If a line is killed and new, this indicates that the two merge
2447
        revisions contain differing conflict resolutions.
3144.3.7 by Aaron Bentley
Update from review
2448
        :param revision_id: The id of the revision in which the lines are
2449
            unique
2450
        :param unique_line_numbers: The line numbers of unique lines.
3144.3.1 by Aaron Bentley
Implement LCA merge, with problematic conflict markers
2451
        :return a tuple of (new_this, killed_other):
2452
        """
2453
        new = set()
2454
        killed = set()
3144.3.7 by Aaron Bentley
Update from review
2455
        unique_line_numbers = set(unique_line_numbers)
3144.3.1 by Aaron Bentley
Implement LCA merge, with problematic conflict markers
2456
        for lca in self.lcas:
2457
            blocks = self._get_matching_blocks(revision_id, lca)
2458
            unique_vs_lca, _ignored = self._unique_lines(blocks)
3144.3.7 by Aaron Bentley
Update from review
2459
            new.update(unique_line_numbers.intersection(unique_vs_lca))
2460
            killed.update(unique_line_numbers.difference(unique_vs_lca))
3144.3.1 by Aaron Bentley
Implement LCA merge, with problematic conflict markers
2461
        return new, killed