~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
3514.4.23 by John Arbash Meinel
Handle when there are more than 2 LCAs while searching for the unique lca.
585
                if len(lcas) > 2:
586
                    # find_unique_lca can only handle 2 nodes, so we have to
587
                    # start back at the beginning. It is a shame to traverse
588
                    # the graph again, but better than re-implementing
589
                    # find_unique_lca.
590
                    self.base_rev_id = self.revision_graph.find_unique_lca(
591
                                            revisions[0], revisions[1])
592
                else:
593
                    self.base_rev_id = self.revision_graph.find_unique_lca(
594
                                            *lcas)
3514.4.2 by John Arbash Meinel
Extract the lca trees and the base tree when we find a criss-cross
595
                self._is_criss_cross = True
4721.3.1 by Vincent Ladeuil
Cleanup imports.
596
            if self.base_rev_id == _mod_revision.NULL_REVISION:
597
                raise errors.UnrelatedBranches()
3514.4.2 by John Arbash Meinel
Extract the lca trees and the base tree when we find a criss-cross
598
            if self._is_criss_cross:
4721.3.1 by Vincent Ladeuil
Cleanup imports.
599
                trace.warning('Warning: criss-cross merge encountered.  See bzr'
600
                              ' help criss-cross.')
601
                trace.mutter('Criss-cross lcas: %r' % lcas)
3514.4.2 by John Arbash Meinel
Extract the lca trees and the base tree when we find a criss-cross
602
                interesting_revision_ids = [self.base_rev_id]
603
                interesting_revision_ids.extend(lcas)
604
                interesting_trees = dict((t.get_revision_id(), t)
605
                    for t in self.this_branch.repository.revision_trees(
606
                        interesting_revision_ids))
607
                self._cached_trees.update(interesting_trees)
608
                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'.
609
                sorted_lca_keys = self.revision_graph.find_merge_order(
610
                    revisions[0], lcas)
611
                self._lca_trees = [interesting_trees[key]
612
                                   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
613
            else:
614
                self.base_tree = self.revision_tree(self.base_rev_id)
2590.2.13 by Aaron Bentley
Make find_base implement the base_finding code
615
        self.base_is_ancestor = True
2590.2.18 by Aaron Bentley
Merge is_ancestor fix
616
        self.base_is_other_ancestor = True
4721.3.1 by Vincent Ladeuil
Cleanup imports.
617
        trace.mutter('Base revid: %r' % self.base_rev_id)
1185.82.25 by Aaron Bentley
Added changeset-merging functionality
618
1185.12.76 by Aaron Bentley
Refactored merge and merge_inner to use Merger
619
    def set_base(self, base_revision):
1979.2.1 by Robert Collins
(robertc) adds a convenience method "merge_from_branch" to WorkingTree.
620
        """Set the base revision to use for the merge.
621
622
        :param base_revision: A 2-list containing a path and revision number.
623
        """
4721.3.1 by Vincent Ladeuil
Cleanup imports.
624
        trace.mutter("doing merge() with no base_revision specified")
1185.12.76 by Aaron Bentley
Refactored merge and merge_inner to use Merger
625
        if base_revision == [None, None]:
2590.2.13 by Aaron Bentley
Make find_base implement the base_finding code
626
            self.find_base()
1185.12.76 by Aaron Bentley
Refactored merge and merge_inner to use Merger
627
        else:
2590.2.11 by Aaron Bentley
Aggressively cache trees, use dirstate. re-mplement _add_parent.
628
            base_branch, self.base_tree = self._get_tree(base_revision)
1185.12.76 by Aaron Bentley
Refactored merge and merge_inner to use Merger
629
            if base_revision[1] == -1:
630
                self.base_rev_id = base_branch.last_revision()
631
            elif base_revision[1] is None:
2598.5.3 by Aaron Bentley
Push NULL_REVISION deeper
632
                self.base_rev_id = _mod_revision.NULL_REVISION
493 by Martin Pool
- Merge aaron's merge command
633
            else:
2598.5.3 by Aaron Bentley
Push NULL_REVISION deeper
634
                self.base_rev_id = _mod_revision.ensure_null(
635
                    base_branch.get_rev_id(base_revision[1]))
2590.2.19 by Aaron Bentley
Avoid fetch within a repository
636
            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
637
3008.1.8 by Michael Hudson
extract merger creation into a method
638
    def make_merger(self):
2255.2.31 by Robert Collins
Work in progress to make merge_inner work with dirstate trees.
639
        kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
640
                  'other_tree': self.other_tree,
1551.2.32 by Aaron Bentley
Handle progress phases more nicely in merge
641
                  'interesting_ids': self.interesting_ids,
2590.2.5 by Aaron Bentley
Allow selected files to be specified instead of selected ids
642
                  'interesting_files': self.interesting_files,
4961.2.20 by Martin Pool
Resolve conflicts with trunk
643
                  'this_branch': self.this_branch,
3008.1.11 by Michael Hudson
restore the default behaviour of Merge3Merger.__init__().
644
                  'do_merge': False}
1534.7.84 by Aaron Bentley
Added reprocess support, support for varying merge types
645
        if self.merge_type.requires_base:
646
            kwargs['base_tree'] = self.base_tree
1534.7.137 by Aaron Bentley
Avoided generating a new tree for every weave merge
647
        if self.merge_type.supports_reprocess:
648
            kwargs['reprocess'] = self.reprocess
649
        elif self.reprocess:
4721.3.1 by Vincent Ladeuil
Cleanup imports.
650
            raise errors.BzrError(
651
                "Conflict reduction is not supported for merge"
652
                " type %s." % self.merge_type)
1534.7.137 by Aaron Bentley
Avoided generating a new tree for every weave merge
653
        if self.merge_type.supports_show_base:
654
            kwargs['show_base'] = self.show_base
655
        elif self.show_base:
4721.3.1 by Vincent Ladeuil
Cleanup imports.
656
            raise errors.BzrError("Showing base is not supported for this"
657
                                  " merge type. %s" % self.merge_type)
3062.2.7 by Aaron Bentley
Prevent reverse cherry-picking with weave
658
        if (not getattr(self.merge_type, 'supports_reverse_cherrypick', True)
659
            and not self.base_is_other_ancestor):
660
            raise errors.CannotReverseCherrypick()
3249.3.1 by John Arbash Meinel
Implement cherrypick support for Merge3
661
        if self.merge_type.supports_cherrypick:
3062.2.9 by Aaron Bentley
Don't use the base if not cherrypicking
662
            kwargs['cherrypick'] = (not self.base_is_ancestor or
663
                                    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.
664
        if self._is_criss_cross and getattr(self.merge_type,
665
                                            'supports_lca_trees', False):
666
            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
667
        return self.merge_type(pb=None,
3008.1.8 by Michael Hudson
extract merger creation into a method
668
                               change_reporter=self.change_reporter,
669
                               **kwargs)
670
4797.16.1 by Andrew Bennetts
Replace many try/finally blocks in merge.py with more robust OperationWithCleanups.
671
    def _do_merge_to(self):
672
        merge = self.make_merger()
4273.1.9 by Aaron Bentley
Cleanup
673
        if self.other_branch is not None:
674
            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.
675
        merge.do_merge()
676
        if self.recurse == 'down':
677
            for relpath, file_id in self.this_tree.iter_references():
678
                sub_tree = self.this_tree.get_nested_tree(file_id, relpath)
679
                other_revision = self.other_tree.get_reference_revision(
680
                    file_id, relpath)
681
                if  other_revision == sub_tree.last_revision():
682
                    continue
683
                sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
684
                sub_merge.merge_type = self.merge_type
685
                other_branch = self.other_branch.reference_parent(file_id, relpath)
686
                sub_merge.set_other_revision(other_revision, other_branch)
687
                base_revision = self.base_tree.get_reference_revision(file_id)
688
                sub_merge.base_tree = \
689
                    sub_tree.branch.repository.revision_tree(base_revision)
690
                sub_merge.base_rev_id = base_revision
691
                sub_merge.do_merge()
4797.16.1 by Andrew Bennetts
Replace many try/finally blocks in merge.py with more robust OperationWithCleanups.
692
        return merge
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
693
3008.1.8 by Michael Hudson
extract merger creation into a method
694
    def do_merge(self):
4797.16.1 by Andrew Bennetts
Replace many try/finally blocks in merge.py with more robust OperationWithCleanups.
695
        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()
696
        self.this_tree.lock_tree_write()
4797.16.1 by Andrew Bennetts
Replace many try/finally blocks in merge.py with more robust OperationWithCleanups.
697
        operation.add_cleanup(self.this_tree.unlock)
698
        if self.base_tree is not None:
699
            self.base_tree.lock_read()
700
            operation.add_cleanup(self.base_tree.unlock)
701
        if self.other_tree is not None:
702
            self.other_tree.lock_read()
703
            operation.add_cleanup(self.other_tree.unlock)
704
        merge = operation.run_simple()
1534.7.151 by Aaron Bentley
Fixed all changes applied successfully
705
        if len(merge.cooked_conflicts) == 0:
4721.3.1 by Vincent Ladeuil
Cleanup imports.
706
            if not self.ignore_zero and not trace.is_quiet():
707
                trace.note("All changes applied successfully.")
1534.7.141 by Aaron Bentley
Added conflict reporting
708
        else:
4721.3.1 by Vincent Ladeuil
Cleanup imports.
709
            trace.note("%d conflicts encountered."
710
                       % len(merge.cooked_conflicts))
1534.7.141 by Aaron Bentley
Added conflict reporting
711
1534.7.134 by Aaron Bentley
Hid raw conflicts
712
        return len(merge.cooked_conflicts)
1185.12.76 by Aaron Bentley
Refactored merge and merge_inner to use Merger
713
1545.2.4 by Aaron Bentley
PEP8 fixes
714
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.
715
class _InventoryNoneEntry(object):
716
    """This represents an inventory entry which *isn't there*.
717
718
    It simplifies the merging logic if we always have an InventoryEntry, even
719
    if it isn't actually present
720
    """
721
    executable = None
722
    kind = None
723
    name = None
724
    parent_id = None
725
    revision = None
726
    symlink_target = None
727
    text_sha1 = None
728
729
_none_entry = _InventoryNoneEntry()
730
731
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
732
class Merge3Merger(object):
1534.7.167 by Aaron Bentley
PEP8 and comment cleanups
733
    """Three-way merger that uses the merge3 text merger"""
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
734
    requires_base = True
735
    supports_reprocess = True
736
    supports_show_base = True
737
    history_based = False
3249.3.1 by John Arbash Meinel
Implement cherrypick support for Merge3
738
    supports_cherrypick = True
3062.2.7 by Aaron Bentley
Prevent reverse cherry-picking with weave
739
    supports_reverse_cherrypick = True
2590.2.7 by Aaron Bentley
Misc cleanup
740
    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.
741
    supports_lca_trees = True
1534.7.167 by Aaron Bentley
PEP8 and comment cleanups
742
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
743
    def __init__(self, working_tree, this_tree, base_tree, other_tree,
1558.2.2 by Aaron Bentley
Make remerge honour interesting-ids
744
                 interesting_ids=None, reprocess=False, show_base=False,
4961.2.9 by Martin Pool
Rip out most remaining uses of DummyProgressBar
745
                 pb=None, pp=None, change_reporter=None,
3249.3.1 by John Arbash Meinel
Implement cherrypick support for Merge3
746
                 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.
747
                 cherrypick=False, lca_trees=None, this_branch=None):
2590.2.10 by Aaron Bentley
Updates from review
748
        """Initialize the merger object and perform the merge.
749
750
        :param working_tree: The working tree to apply the merge to
751
        :param this_tree: The local tree in the merge operation
752
        :param base_tree: The common tree in the merge operation
4031.3.1 by Frank Aspell
Fixing various typos
753
        :param other_tree: The other tree to merge changes from
5162.3.1 by Aaron Bentley
Fix switch/merge when a ConfigurableFileMerger is used.
754
        :param this_branch: The branch associated with this_tree.  Defaults to
755
            this_tree.branch if not supplied.
2590.2.10 by Aaron Bentley
Updates from review
756
        :param interesting_ids: The file_ids of files that should be
757
            participate in the merge.  May not be combined with
758
            interesting_files.
759
        :param: reprocess If True, perform conflict-reduction processing.
760
        :param show_base: If True, show the base revision in text conflicts.
761
            (incompatible with reprocess)
4961.2.9 by Martin Pool
Rip out most remaining uses of DummyProgressBar
762
        :param pb: ignored
2590.2.10 by Aaron Bentley
Updates from review
763
        :param pp: A ProgressPhase object
764
        :param change_reporter: An object that should report changes made
765
        :param interesting_files: The tree-relative paths of files that should
766
            participate in the merge.  If these paths refer to directories,
767
            the contents of those directories will also be included.  May not
768
            be combined with interesting_ids.  If neither interesting_files nor
769
            interesting_ids is specified, all files may participate in the
770
            merge.
3514.4.4 by John Arbash Meinel
Test that the lca_trees are passed down to the Merger object when appropriate.
771
        :param lca_trees: Can be set to a dictionary of {revision_id:rev_tree}
772
            if the ancestry was found to include a criss-cross merge.
773
            Otherwise should be None.
2590.2.10 by Aaron Bentley
Updates from review
774
        """
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
775
        object.__init__(self)
3376.2.4 by Martin Pool
Remove every assert statement from bzrlib!
776
        if interesting_files is not None and interesting_ids is not None:
777
            raise ValueError(
778
                'specify either interesting_ids or interesting_files')
5162.3.1 by Aaron Bentley
Fix switch/merge when a ConfigurableFileMerger is used.
779
        if this_branch is None:
780
            this_branch = this_tree.branch
2590.2.4 by Aaron Bentley
Move entry generation to a helper
781
        self.interesting_ids = interesting_ids
2590.2.5 by Aaron Bentley
Allow selected files to be specified instead of selected ids
782
        self.interesting_files = interesting_files
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
783
        self.this_tree = working_tree
784
        self.base_tree = base_tree
785
        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.
786
        self.this_branch = this_branch
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
787
        self._raw_conflicts = []
788
        self.cooked_conflicts = []
789
        self.reprocess = reprocess
790
        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.
791
        self._lca_trees = lca_trees
3514.4.37 by John Arbash Meinel
Tests pass when using _entries_lca as the default algorithm.
792
        # Uncommenting this will change the default algorithm to always use
793
        # _entries_lca. This can be useful for running the test suite and
794
        # making sure we haven't missed any corner cases.
3514.4.34 by John Arbash Meinel
Handle symlinks properly when objects are not RevisionTrees
795
        # if lca_trees is None:
796
        #     self._lca_trees = [self.base_tree]
1551.11.9 by Aaron Bentley
Apply change reporting to merge
797
        self.change_reporter = change_reporter
3249.3.1 by John Arbash Meinel
Implement cherrypick support for Merge3
798
        self.cherrypick = cherrypick
3008.1.11 by Michael Hudson
restore the default behaviour of Merge3Merger.__init__().
799
        if do_merge:
800
            self.do_merge()
4961.2.12 by Martin Pool
Further pb/pp removals
801
        if pp is not None:
802
            warnings.warn("pp argument to Merge3Merger is deprecated")
803
        if pb is not None:
804
            warnings.warn("pb argument to Merge3Merger is deprecated")
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
805
3008.1.6 by Michael Hudson
chop up Merge3Merger.__init__ into pieces
806
    def do_merge(self):
4797.16.1 by Andrew Bennetts
Replace many try/finally blocks in merge.py with more robust OperationWithCleanups.
807
        operation = OperationWithCleanups(self._do_merge)
3008.1.6 by Michael Hudson
chop up Merge3Merger.__init__ into pieces
808
        self.this_tree.lock_tree_write()
4797.16.1 by Andrew Bennetts
Replace many try/finally blocks in merge.py with more robust OperationWithCleanups.
809
        operation.add_cleanup(self.this_tree.unlock)
3008.1.6 by Michael Hudson
chop up Merge3Merger.__init__ into pieces
810
        self.base_tree.lock_read()
4797.16.1 by Andrew Bennetts
Replace many try/finally blocks in merge.py with more robust OperationWithCleanups.
811
        operation.add_cleanup(self.base_tree.unlock)
3008.1.6 by Michael Hudson
chop up Merge3Merger.__init__ into pieces
812
        self.other_tree.lock_read()
4797.16.1 by Andrew Bennetts
Replace many try/finally blocks in merge.py with more robust OperationWithCleanups.
813
        operation.add_cleanup(self.other_tree.unlock)
814
        operation.run()
815
816
    def _do_merge(self, operation):
5031.1.2 by Andrew Bennetts
Merge lp:bzr/2.1
817
        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.
818
        operation.add_cleanup(self.tt.finalize)
819
        self._compute_transform()
820
        results = self.tt.apply(no_conflicts=True)
821
        self.write_modified(results)
5031.1.3 by Andrew Bennetts
Fix syntax error from bad conflict resolution.
822
        try:
4797.16.1 by Andrew Bennetts
Replace many try/finally blocks in merge.py with more robust OperationWithCleanups.
823
            self.this_tree.add_conflicts(self.cooked_conflicts)
824
        except errors.UnsupportedOperation:
825
            pass
1534.7.192 by Aaron Bentley
Record hashes produced by merges
826
3008.1.9 by Michael Hudson
wanton hacking that lets me write an efficient version of get_diff_as_merged
827
    def make_preview_transform(self):
4797.16.1 by Andrew Bennetts
Replace many try/finally blocks in merge.py with more robust OperationWithCleanups.
828
        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
829
        self.base_tree.lock_read()
4797.16.1 by Andrew Bennetts
Replace many try/finally blocks in merge.py with more robust OperationWithCleanups.
830
        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
831
        self.other_tree.lock_read()
4797.16.1 by Andrew Bennetts
Replace many try/finally blocks in merge.py with more robust OperationWithCleanups.
832
        operation.add_cleanup(self.other_tree.unlock)
833
        return operation.run_simple()
834
835
    def _make_preview_transform(self):
4721.3.1 by Vincent Ladeuil
Cleanup imports.
836
        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.
837
        self._compute_transform()
3008.1.9 by Michael Hudson
wanton hacking that lets me write an efficient version of get_diff_as_merged
838
        return self.tt
839
3008.1.21 by Aaron Bentley
Make compute_transform private, test make_preview_transform
840
    def _compute_transform(self):
3514.4.21 by John Arbash Meinel
Hook up the lca-way logic into the path handlers.
841
        if self._lca_trees is None:
842
            entries = self._entries3()
843
            resolver = self._three_way
844
        else:
845
            entries = self._entries_lca()
846
            resolver = self._lca_multi_way
3008.1.6 by Michael Hudson
chop up Merge3Merger.__init__ into pieces
847
        child_pb = ui.ui_factory.nested_progress_bar()
848
        try:
4797.5.1 by Robert Collins
Support state on per-file merging to permit more efficient use of configuration data.
849
            factories = Merger.hooks['merge_file_content']
850
            hooks = [factory(self) for factory in factories] + [self]
851
            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
852
            for num, (file_id, changed, parents3, names3,
853
                      executable3) in enumerate(entries):
854
                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.
855
                self._merge_names(file_id, parents3, names3, resolver=resolver)
3008.1.6 by Michael Hudson
chop up Merge3Merger.__init__ into pieces
856
                if changed:
4797.5.1 by Robert Collins
Support state on per-file merging to permit more efficient use of configuration data.
857
                    file_status = self._do_merge_contents(file_id)
3008.1.6 by Michael Hudson
chop up Merge3Merger.__init__ into pieces
858
                else:
859
                    file_status = 'unmodified'
860
                self._merge_executable(file_id,
3514.4.21 by John Arbash Meinel
Hook up the lca-way logic into the path handlers.
861
                    executable3, file_status, resolver=resolver)
3008.1.6 by Michael Hudson
chop up Merge3Merger.__init__ into pieces
862
        finally:
863
            child_pb.finished()
864
        self.fix_root()
5246.2.33 by Andrew Bennetts
Rename _finish_transform to _finish_computing_transform.
865
        self._finish_computing_transform()
5246.2.4 by Andrew Bennetts
Remove a little bit of duplication.
866
5246.2.33 by Andrew Bennetts
Rename _finish_transform to _finish_computing_transform.
867
    def _finish_computing_transform(self):
5246.2.4 by Andrew Bennetts
Remove a little bit of duplication.
868
        """Finalize the transform and report the changes.
869
870
        This is the second half of _compute_transform.
871
        """
3008.1.6 by Michael Hudson
chop up Merge3Merger.__init__ into pieces
872
        child_pb = ui.ui_factory.nested_progress_bar()
873
        try:
4721.3.1 by Vincent Ladeuil
Cleanup imports.
874
            fs_conflicts = transform.resolve_conflicts(self.tt, child_pb,
875
                lambda t, c: transform.conflict_pass(t, c, self.other_tree))
3008.1.6 by Michael Hudson
chop up Merge3Merger.__init__ into pieces
876
        finally:
877
            child_pb.finished()
878
        if self.change_reporter is not None:
879
            from bzrlib import delta
880
            delta.report_changes(
3254.1.1 by Aaron Bentley
Make Tree.iter_changes a public method
881
                self.tt.iter_changes(), self.change_reporter)
3008.1.6 by Michael Hudson
chop up Merge3Merger.__init__ into pieces
882
        self.cook_conflicts(fs_conflicts)
883
        for conflict in self.cooked_conflicts:
4721.3.1 by Vincent Ladeuil
Cleanup imports.
884
            trace.warning(conflict)
3008.1.6 by Michael Hudson
chop up Merge3Merger.__init__ into pieces
885
2590.2.4 by Aaron Bentley
Move entry generation to a helper
886
    def _entries3(self):
2590.2.7 by Aaron Bentley
Misc cleanup
887
        """Gather data about files modified between three trees.
888
889
        Return a list of tuples of file_id, changed, parents3, names3,
890
        executable3.  changed is a boolean indicating whether the file contents
891
        or kind were changed.  parents3 is a tuple of parent ids for base,
892
        other and this.  names3 is a tuple of names for base, other and this.
893
        executable3 is a tuple of execute-bit values for base, other and this.
894
        """
2590.2.4 by Aaron Bentley
Move entry generation to a helper
895
        result = []
3254.1.1 by Aaron Bentley
Make Tree.iter_changes a public method
896
        iterator = self.other_tree.iter_changes(self.base_tree,
3514.2.16 by John Arbash Meinel
Review feedback from Ian.
897
                include_unchanged=True, specific_files=self.interesting_files,
2590.2.5 by Aaron Bentley
Allow selected files to be specified instead of selected ids
898
                extra_trees=[self.this_tree])
3363.17.1 by Aaron Bentley
Avoid inventory for merge and transform code
899
        this_entries = dict((e.file_id, e) for p, e in
900
                            self.this_tree.iter_entries_by_dir(
901
                            self.interesting_ids))
2590.2.4 by Aaron Bentley
Move entry generation to a helper
902
        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
903
             executable) in iterator:
2590.2.4 by Aaron Bentley
Move entry generation to a helper
904
            if (self.interesting_ids is not None and
905
                file_id not in self.interesting_ids):
906
                continue
3363.17.1 by Aaron Bentley
Avoid inventory for merge and transform code
907
            entry = this_entries.get(file_id)
908
            if entry is not None:
2590.2.4 by Aaron Bentley
Move entry generation to a helper
909
                this_name = entry.name
910
                this_parent = entry.parent_id
911
                this_executable = entry.executable
912
            else:
913
                this_name = None
914
                this_parent = None
915
                this_executable = None
916
            parents3 = parents + (this_parent,)
917
            names3 = names + (this_name,)
918
            executable3 = executable + (this_executable,)
919
            result.append((file_id, changed, parents3, names3, executable3))
920
        return result
921
3514.4.5 by John Arbash Meinel
Initial work on _entries_lca.
922
    def _entries_lca(self):
923
        """Gather data about files modified between multiple trees.
924
925
        This compares OTHER versus all LCA trees, and for interesting entries,
926
        it then compares with THIS and BASE.
927
928
        For the multi-valued entries, the format will be (BASE, [lca1, lca2])
929
        :return: [(file_id, changed, parents, names, executable)]
930
            file_id     Simple file_id of the entry
931
            changed     Boolean, True if the kind or contents changed
932
                        else False
933
            parents     ((base, [parent_id, in, lcas]), parent_id_other,
934
                         parent_id_this)
935
            names       ((base, [name, in, lcas]), name_in_other, name_in_this)
936
            executable  ((base, [exec, in, lcas]), exec_in_other, exec_in_this)
937
        """
3514.4.24 by John Arbash Meinel
Implement support for 'interesting_files' and 'interesting_ids' for _entries_lca
938
        if self.interesting_files is not None:
939
            lookup_trees = [self.this_tree, self.base_tree]
940
            lookup_trees.extend(self._lca_trees)
941
            # I think we should include the lca trees as well
942
            interesting_ids = self.other_tree.paths2ids(self.interesting_files,
943
                                                        lookup_trees)
944
        else:
945
            interesting_ids = self.interesting_ids
3514.4.5 by John Arbash Meinel
Initial work on _entries_lca.
946
        result = []
3514.4.13 by John Arbash Meinel
Switch the lca_trees to be in 'find_merge_order'.
947
        walker = _mod_tree.MultiWalker(self.other_tree, self._lca_trees)
3514.4.5 by John Arbash Meinel
Initial work on _entries_lca.
948
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.
949
        base_inventory = self.base_tree.inventory
950
        this_inventory = self.this_tree.inventory
3514.4.5 by John Arbash Meinel
Initial work on _entries_lca.
951
        for path, file_id, other_ie, lca_values in walker.iter_all():
952
            # 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.
953
            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.
954
                other_ie = _none_entry
3514.4.24 by John Arbash Meinel
Implement support for 'interesting_files' and 'interesting_ids' for _entries_lca
955
            if interesting_ids is not None and file_id not in interesting_ids:
956
                continue
3514.4.15 by John Arbash Meinel
Handle when OTHER doesn't have the entry.
957
3514.4.30 by John Arbash Meinel
Several updates.
958
            # If other_revision is found in any of the lcas, that means this
959
            # node is uninteresting. This is because when merging, if there are
960
            # multiple heads(), we have to create a new node. So if we didn't,
961
            # we know that the ancestry is linear, and that OTHER did not
962
            # modify anything
963
            # 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.
964
            other_revision = other_ie.revision
3514.4.32 by John Arbash Meinel
Add a test for proper behavior when *everything* is a WT.
965
            if other_revision is not None:
966
                # We can't use this shortcut when other_revision is None,
967
                # because it may be None because things are WorkingTrees, and
968
                # not because it is *actually* None.
969
                is_unmodified = False
970
                for lca_path, ie in lca_values:
971
                    if ie is not None and ie.revision == other_revision:
972
                        is_unmodified = True
973
                        break
974
                if is_unmodified:
975
                    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.
976
977
            lca_entries = []
978
            for lca_path, lca_ie in lca_values:
979
                if lca_ie is None:
980
                    lca_entries.append(_none_entry)
981
                else:
982
                    lca_entries.append(lca_ie)
3514.4.19 by John Arbash Meinel
Add the _lca_multi_way function, and explicit tests.
983
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.
984
            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.
985
                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.
986
            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.
987
                base_ie = _none_entry
988
3514.4.11 by John Arbash Meinel
Handle when an entry is missing in THIS
989
            if file_id in this_inventory:
990
                this_ie = this_inventory[file_id]
991
            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.
992
                this_ie = _none_entry
3514.4.11 by John Arbash Meinel
Handle when an entry is missing in THIS
993
3514.4.21 by John Arbash Meinel
Hook up the lca-way logic into the path handlers.
994
            lca_kinds = []
995
            lca_parent_ids = []
996
            lca_names = []
997
            lca_executable = []
998
            for lca_ie in lca_entries:
999
                lca_kinds.append(lca_ie.kind)
1000
                lca_parent_ids.append(lca_ie.parent_id)
1001
                lca_names.append(lca_ie.name)
1002
                lca_executable.append(lca_ie.executable)
1003
3514.4.39 by John Arbash Meinel
Use self._lca_multi_way rather than Merge3Merger._lca_multi_way by Aaron's request.
1004
            kind_winner = self._lca_multi_way(
3514.4.21 by John Arbash Meinel
Hook up the lca-way logic into the path handlers.
1005
                (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.
1006
                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.
1007
            parent_id_winner = self._lca_multi_way(
3514.4.21 by John Arbash Meinel
Hook up the lca-way logic into the path handlers.
1008
                (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.
1009
                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.
1010
            name_winner = self._lca_multi_way(
3514.4.21 by John Arbash Meinel
Hook up the lca-way logic into the path handlers.
1011
                (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.
1012
                other_ie.name, this_ie.name)
3514.4.21 by John Arbash Meinel
Hook up the lca-way logic into the path handlers.
1013
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.
1014
            content_changed = True
1015
            if kind_winner == 'this':
1016
                # 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.
1017
                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.
1018
                    if parent_id_winner == 'this' and name_winner == 'this':
1019
                        # No change for this directory in OTHER, skip
1020
                        continue
1021
                    content_changed = False
3948.1.1 by John Arbash Meinel
Fix an edge case with deleted files and criss-cross merges.
1022
                elif other_ie.kind is None or other_ie.kind == 'file':
3514.4.30 by John Arbash Meinel
Several updates.
1023
                    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.
1024
                        if ie.kind != 'file':
3514.4.30 by John Arbash Meinel
Several updates.
1025
                            return None
1026
                        return tree.get_file_sha1(file_id)
1027
                    base_sha1 = get_sha1(base_ie, self.base_tree)
1028
                    lca_sha1s = [get_sha1(ie, tree) for ie, tree
1029
                                 in zip(lca_entries, self._lca_trees)]
1030
                    this_sha1 = get_sha1(this_ie, self.this_tree)
1031
                    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.
1032
                    sha1_winner = self._lca_multi_way(
3514.4.30 by John Arbash Meinel
Several updates.
1033
                        (base_sha1, lca_sha1s), other_sha1, this_sha1,
1034
                        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.
1035
                    exec_winner = self._lca_multi_way(
3514.4.22 by John Arbash Meinel
Handle executable bit changes as well.
1036
                        (base_ie.executable, lca_executable),
1037
                        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.
1038
                    if (parent_id_winner == 'this' and name_winner == 'this'
3514.4.22 by John Arbash Meinel
Handle executable bit changes as well.
1039
                        and sha1_winner == 'this' and exec_winner == 'this'):
1040
                        # No kind, parent, name, exec, or content change for
1041
                        # 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.
1042
                        continue
1043
                    if sha1_winner == 'this':
1044
                        content_changed = False
3514.4.27 by John Arbash Meinel
A couple of symlink tests, we need to do more.
1045
                elif other_ie.kind == 'symlink':
3514.4.34 by John Arbash Meinel
Handle symlinks properly when objects are not RevisionTrees
1046
                    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.
1047
                        if ie.kind != 'symlink':
3514.4.34 by John Arbash Meinel
Handle symlinks properly when objects are not RevisionTrees
1048
                            return None
1049
                        return tree.get_symlink_target(file_id)
1050
                    base_target = get_target(base_ie, self.base_tree)
1051
                    lca_targets = [get_target(ie, tree) for ie, tree
1052
                                   in zip(lca_entries, self._lca_trees)]
1053
                    this_target = get_target(this_ie, self.this_tree)
1054
                    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.
1055
                    target_winner = self._lca_multi_way(
3514.4.34 by John Arbash Meinel
Handle symlinks properly when objects are not RevisionTrees
1056
                        (base_target, lca_targets),
1057
                        other_target, this_target)
3514.4.28 by John Arbash Meinel
More symlink tests.
1058
                    if (parent_id_winner == 'this' and name_winner == 'this'
1059
                        and target_winner == 'this'):
1060
                        # No kind, parent, name, or symlink target change
1061
                        # not interesting
1062
                        continue
1063
                    if target_winner == 'this':
1064
                        content_changed = False
3514.4.33 by John Arbash Meinel
Implement support for 'tree-reference'.
1065
                elif other_ie.kind == 'tree-reference':
1066
                    # The 'changed' information seems to be handled at a higher
1067
                    # level. At least, _entries3 returns False for content
1068
                    # changed, even when at a new revision_id.
1069
                    content_changed = False
1070
                    if (parent_id_winner == 'this' and name_winner == 'this'):
1071
                        # Nothing interesting
1072
                        continue
3514.4.21 by John Arbash Meinel
Hook up the lca-way logic into the path handlers.
1073
                else:
1074
                    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'.
1075
1076
            # 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.
1077
            result.append((file_id, content_changed,
1078
                           ((base_ie.parent_id, lca_parent_ids),
1079
                            other_ie.parent_id, this_ie.parent_id),
1080
                           ((base_ie.name, lca_names),
1081
                            other_ie.name, this_ie.name),
1082
                           ((base_ie.executable, lca_executable),
1083
                            other_ie.executable, this_ie.executable)
3514.4.5 by John Arbash Meinel
Initial work on _entries_lca.
1084
                          ))
1085
        return result
1086
1731.1.33 by Aaron Bentley
Revert no-special-root changes
1087
    def fix_root(self):
1088
        try:
1089
            self.tt.final_kind(self.tt.root)
4721.3.1 by Vincent Ladeuil
Cleanup imports.
1090
        except errors.NoSuchFile:
1731.1.33 by Aaron Bentley
Revert no-special-root changes
1091
            self.tt.cancel_deletion(self.tt.root)
1092
        if self.tt.final_file_id(self.tt.root) is None:
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1093
            self.tt.version_file(self.tt.tree_file_id(self.tt.root),
1731.1.33 by Aaron Bentley
Revert no-special-root changes
1094
                                 self.tt.root)
2946.3.3 by John Arbash Meinel
Prefer tree.get_root_id() as more explicit than tree.path2id('')
1095
        other_root_file_id = self.other_tree.get_root_id()
3363.17.17 by Aaron Bentley
Start testing merging PreviewTree as OTHER
1096
        if other_root_file_id is None:
1097
            return
1731.1.33 by Aaron Bentley
Revert no-special-root changes
1098
        other_root = self.tt.trans_id_file_id(other_root_file_id)
1099
        if other_root == self.tt.root:
1100
            return
3649.3.1 by Jelmer Vernooij
Merging from a previously joined branch will no longer cause a traceback.
1101
        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.
1102
            # the other tree's root is a non-root in the current tree (as when
4634.149.6 by Vincent Ladeuil
Fix typo.
1103
            # 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.
1104
            return
4634.149.5 by Vincent Ladeuil
Fixed as per John's review comments.
1105
        try:
1106
            self.tt.final_kind(other_root)
1107
            other_root_is_present = True
4797.42.2 by Vincent Ladeuil
Fix pqm failures
1108
        except errors.NoSuchFile:
4634.149.5 by Vincent Ladeuil
Fixed as per John's review comments.
1109
            # other_root doesn't have a physical representation. We still need
1110
            # to move any references to the actual root of the tree.
1111
            other_root_is_present = False
1112
        # 'other_tree.inventory.root' is not present in this tree. We are
1113
        # calling adjust_path for children which *want* to be present with a
1114
        # correct place to go.
1115
        for thing, child in self.other_tree.inventory.root.children.iteritems():
1116
            trans_id = self.tt.trans_id_file_id(child.file_id)
1117
            if not other_root_is_present:
1118
                # FIXME: Make final_kind returns None instead of raising
1119
                # NoSuchFile to avoid the ugly construct below -- vila 20100402
1120
                try:
1121
                    self.tt.final_kind(trans_id)
1122
                    # The item exist in the final tree and has a defined place
1123
                    # to go already.
1124
                    continue
1125
                except errors.NoSuchFile, e:
1126
                    pass
1127
            # Move the item into the root
1128
            self.tt.adjust_path(self.tt.final_name(trans_id),
1129
                                self.tt.root, trans_id)
1130
        if other_root_is_present:
4634.149.3 by Vincent Ladeuil
Fix bug #3735898 by filtering out garbage paths.
1131
            self.tt.cancel_creation(other_root)
1132
            self.tt.cancel_versioning(other_root)
1731.1.33 by Aaron Bentley
Revert no-special-root changes
1133
1534.7.192 by Aaron Bentley
Record hashes produced by merges
1134
    def write_modified(self, results):
1135
        modified_hashes = {}
1136
        for path in results.modified_paths:
1137
            file_id = self.this_tree.path2id(self.this_tree.relpath(path))
1138
            if file_id is None:
1139
                continue
1140
            hash = self.this_tree.get_file_sha1(file_id)
1141
            if hash is None:
1142
                continue
1143
            modified_hashes[file_id] = hash
1144
        self.this_tree.set_merge_modified(modified_hashes)
1145
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1146
    @staticmethod
1147
    def parent(entry, file_id):
1534.7.157 by Aaron Bentley
Added more docs
1148
        """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
1149
        if entry is None:
1150
            return None
1151
        return entry.parent_id
1152
1153
    @staticmethod
1154
    def name(entry, file_id):
1534.7.157 by Aaron Bentley
Added more docs
1155
        """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
1156
        if entry is None:
1157
            return None
1158
        return entry.name
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1159
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1160
    @staticmethod
1161
    def contents_sha1(tree, file_id):
1534.7.157 by Aaron Bentley
Added more docs
1162
        """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
1163
        if file_id not in tree:
1164
            return None
1165
        return tree.get_file_sha1(file_id)
1166
1167
    @staticmethod
1168
    def executable(tree, file_id):
1534.7.157 by Aaron Bentley
Added more docs
1169
        """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.
1170
        if not tree.has_id(file_id):
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1171
            return None
1172
        if tree.kind(file_id) != "file":
1173
            return False
1174
        return tree.is_executable(file_id)
1175
1176
    @staticmethod
1177
    def kind(tree, file_id):
1534.7.157 by Aaron Bentley
Added more docs
1178
        """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.
1179
        if not tree.has_id(file_id):
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1180
            return None
1181
        return tree.kind(file_id)
1182
1183
    @staticmethod
2590.2.8 by Aaron Bentley
Restore conflict handling changes
1184
    def _three_way(base, other, this):
1185
        if base == other:
5128.1.1 by Vincent Ladeuil
Uncontroversial cleanups, mostly comments
1186
            # if 'base == other', either they all agree, or only 'this' has
1187
            # changed.
2590.2.8 by Aaron Bentley
Restore conflict handling changes
1188
            return 'this'
2590.2.10 by Aaron Bentley
Updates from review
1189
        elif this not in (base, other):
5128.1.1 by Vincent Ladeuil
Uncontroversial cleanups, mostly comments
1190
            # 'this' is neither 'base' nor 'other', so both sides changed
2590.2.8 by Aaron Bentley
Restore conflict handling changes
1191
            return 'conflict'
1192
        elif this == other:
5128.1.1 by Vincent Ladeuil
Uncontroversial cleanups, mostly comments
1193
            # "Ambiguous clean merge" -- both sides have made the same change.
2590.2.8 by Aaron Bentley
Restore conflict handling changes
1194
            return "this"
1195
        else:
5128.1.1 by Vincent Ladeuil
Uncontroversial cleanups, mostly comments
1196
            # this == base: only other has changed.
2590.2.8 by Aaron Bentley
Restore conflict handling changes
1197
            return "other"
1198
1199
    @staticmethod
3514.4.30 by John Arbash Meinel
Several updates.
1200
    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.
1201
        """Consider LCAs when determining whether a change has occurred.
1202
1203
        If LCAS are all identical, this is the same as a _three_way comparison.
1204
1205
        :param bases: value in (BASE, [LCAS])
1206
        :param other: value in OTHER
1207
        :param this: value in THIS
3514.4.30 by John Arbash Meinel
Several updates.
1208
        :param allow_overriding_lca: If there is more than one unique lca
1209
            value, allow OTHER to override THIS if it has a new value, and
1210
            THIS only has an lca value, or vice versa. This is appropriate for
1211
            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.
1212
        :return: 'this', 'other', or 'conflict' depending on whether an entry
1213
            changed or not.
1214
        """
3948.1.7 by Vincent Ladeuil
Slight refactoring and test fixing.
1215
        # See doc/developers/lca_tree_merging.txt for details about this
3514.4.30 by John Arbash Meinel
Several updates.
1216
        # algorithm.
3514.4.19 by John Arbash Meinel
Add the _lca_multi_way function, and explicit tests.
1217
        if other == this:
1218
            # Either Ambiguously clean, or nothing was actually changed. We
1219
            # don't really care
1220
            return 'this'
1221
        base_val, lca_vals = bases
1222
        # Remove 'base_val' from the lca_vals, because it is not interesting
1223
        filtered_lca_vals = [lca_val for lca_val in lca_vals
1224
                                      if lca_val != base_val]
1225
        if len(filtered_lca_vals) == 0:
1226
            return Merge3Merger._three_way(base_val, other, this)
3514.4.30 by John Arbash Meinel
Several updates.
1227
1228
        unique_lca_vals = set(filtered_lca_vals)
1229
        if len(unique_lca_vals) == 1:
1230
            return Merge3Merger._three_way(unique_lca_vals.pop(), other, this)
1231
1232
        if allow_overriding_lca:
1233
            if other in unique_lca_vals:
1234
                if this in unique_lca_vals:
1235
                    # Each side picked a different lca, conflict
1236
                    return 'conflict'
1237
                else:
1238
                    # This has a value which supersedes both lca values, and
1239
                    # other only has an lca value
1240
                    return 'this'
1241
            elif this in unique_lca_vals:
1242
                # 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.
1243
                # only has an lca value
3514.4.30 by John Arbash Meinel
Several updates.
1244
                return 'other'
3514.4.19 by John Arbash Meinel
Add the _lca_multi_way function, and explicit tests.
1245
5128.1.1 by Vincent Ladeuil
Uncontroversial cleanups, mostly comments
1246
        # 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.
1247
        return 'conflict'
1248
1249
    @staticmethod
5077.2.1 by Vincent Ladeuil
Deprecate Merge3Merger.scalar_three_way.
1250
    @deprecated_method(deprecated_in((2, 2, 0)))
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1251
    def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
1252
        """Do a three-way test on a scalar.
1253
        Return "this", "other" or "conflict", depending whether a value wins.
1254
        """
1255
        key_base = key(base_tree, file_id)
1256
        key_other = key(other_tree, file_id)
1257
        #if base == other, either they all agree, or only THIS has changed.
1258
        if key_base == key_other:
1259
            return "this"
1260
        key_this = key(this_tree, file_id)
3376.2.4 by Martin Pool
Remove every assert statement from bzrlib!
1261
        # "Ambiguous clean merge"
1262
        if key_this == key_other:
1263
            return "this"
1264
        elif key_this == key_base:
1265
            return "other"
1266
        else:
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1267
            return "conflict"
1268
1269
    def merge_names(self, file_id):
1270
        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.
1271
            if tree.has_id(file_id):
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1272
                return tree.inventory[file_id]
1273
            else:
1274
                return None
1275
        this_entry = get_entry(self.this_tree)
1276
        other_entry = get_entry(self.other_tree)
1277
        base_entry = get_entry(self.base_tree)
2590.2.1 by Aaron Bentley
Start work on merging names based on iter_changes
1278
        entries = (base_entry, other_entry, this_entry)
1279
        names = []
1280
        parents = []
1281
        for entry in entries:
1282
            if entry is None:
1283
                names.append(None)
1284
                parents.append(None)
1285
            else:
1286
                names.append(entry.name)
1287
                parents.append(entry.parent_id)
3514.4.40 by John Arbash Meinel
Make 'resolver' a required parameter.
1288
        return self._merge_names(file_id, parents, names,
1289
                                 resolver=self._three_way)
2590.2.1 by Aaron Bentley
Start work on merging names based on iter_changes
1290
3514.4.40 by John Arbash Meinel
Make 'resolver' a required parameter.
1291
    def _merge_names(self, file_id, parents, names, resolver):
2590.2.7 by Aaron Bentley
Misc cleanup
1292
        """Perform a merge on file_id names and parents"""
2590.2.1 by Aaron Bentley
Start work on merging names based on iter_changes
1293
        base_name, other_name, this_name = names
1294
        base_parent, other_parent, this_parent = parents
2590.2.2 by Aaron Bentley
Do most name merging from iter_changes output
1295
3514.4.21 by John Arbash Meinel
Hook up the lca-way logic into the path handlers.
1296
        name_winner = resolver(*names)
2590.2.1 by Aaron Bentley
Start work on merging names based on iter_changes
1297
3514.4.21 by John Arbash Meinel
Hook up the lca-way logic into the path handlers.
1298
        parent_id_winner = resolver(*parents)
2590.2.2 by Aaron Bentley
Do most name merging from iter_changes output
1299
        if this_name is None:
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1300
            if name_winner == "this":
1301
                name_winner = "other"
1302
            if parent_id_winner == "this":
1303
                parent_id_winner = "other"
1304
        if name_winner == "this" and parent_id_winner == "this":
1305
            return
4597.7.11 by Vincent Ladeuil
Fix #531967 by creating helpers for PathConflicts when a deletion
1306
        if name_winner == 'conflict' or parent_id_winner == 'conflict':
4597.7.18 by Vincent Ladeuil
Start addressing Andrew's concerns.
1307
            # Creating helpers (.OTHER or .THIS) here cause problems down the
1308
            # road if a ContentConflict needs to be created so we should not do
1309
            # that
4597.7.11 by Vincent Ladeuil
Fix #531967 by creating helpers for PathConflicts when a deletion
1310
            trans_id = self.tt.trans_id_file_id(file_id)
1311
            self._raw_conflicts.append(('path conflict', trans_id, file_id,
1312
                                        this_parent, this_name,
1313
                                        other_parent, other_name))
2590.2.2 by Aaron Bentley
Do most name merging from iter_changes output
1314
        if other_name is None:
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1315
            # it doesn't matter whether the result was 'other' or
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1316
            # 'conflict'-- if there's no 'other', we leave it alone.
1317
            return
2590.2.7 by Aaron Bentley
Misc cleanup
1318
        parent_id = parents[self.winner_idx[parent_id_winner]]
1731.1.33 by Aaron Bentley
Revert no-special-root changes
1319
        if parent_id is not None:
4597.7.11 by Vincent Ladeuil
Fix #531967 by creating helpers for PathConflicts when a deletion
1320
            # if we get here, name_winner and parent_winner are set to safe
1321
            # values.
2590.2.7 by Aaron Bentley
Misc cleanup
1322
            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
1323
                                self.tt.trans_id_file_id(parent_id),
1324
                                self.tt.trans_id_file_id(file_id))
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1325
4797.5.1 by Robert Collins
Support state on per-file merging to permit more efficient use of configuration data.
1326
    def _do_merge_contents(self, file_id):
3874.2.10 by Vincent Ladeuil
Fix typo.
1327
        """Performs a merge on file_id contents."""
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1328
        def contents_pair(tree):
1329
            if file_id not in tree:
1330
                return (None, None)
1331
            kind = tree.kind(file_id)
1332
            if kind == "file":
1333
                contents = tree.get_file_sha1(file_id)
1334
            elif kind == "symlink":
1335
                contents = tree.get_symlink_target(file_id)
1336
            else:
1337
                contents = None
1338
            return kind, contents
1558.15.3 by Aaron Bentley
Handle binary files for diff3 merges
1339
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1340
        # See SPOT run.  run, SPOT, run.
1341
        # So we're not QUITE repeating ourselves; we do tricky things with
1342
        # file kind...
1343
        base_pair = contents_pair(self.base_tree)
1344
        other_pair = contents_pair(self.other_tree)
3955.2.1 by John Arbash Meinel
Change the workings of merge_content to be lca aware.
1345
        if self._lca_trees:
3948.1.7 by Vincent Ladeuil
Slight refactoring and test fixing.
1346
            this_pair = contents_pair(self.this_tree)
3955.2.1 by John Arbash Meinel
Change the workings of merge_content to be lca aware.
1347
            lca_pairs = [contents_pair(tree) for tree in self._lca_trees]
1348
            winner = self._lca_multi_way((base_pair, lca_pairs), other_pair,
1349
                                         this_pair, allow_overriding_lca=False)
1350
        else:
3948.1.7 by Vincent Ladeuil
Slight refactoring and test fixing.
1351
            if base_pair == other_pair:
1352
                winner = 'this'
1353
            else:
1354
                # We delayed evaluating this_pair as long as we can to avoid
1355
                # unnecessary sha1 calculation
1356
                this_pair = contents_pair(self.this_tree)
1357
                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.
1358
        if winner == 'this':
1359
            # No interesting changes introduced by OTHER
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1360
            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.
1361
        # We have a hypothetical conflict, but if we have files, then we
1362
        # can try to merge the content
4869.3.16 by Andrew Bennetts
Move handling of winner==OTHER case into generic hook path too.
1363
        trans_id = self.tt.trans_id_file_id(file_id)
4869.3.21 by Andrew Bennetts
Pass kinds (not pairs) to MergeHookParams.
1364
        params = MergeHookParams(self, file_id, trans_id, this_pair[0],
1365
            other_pair[0], winner)
4797.5.1 by Robert Collins
Support state on per-file merging to permit more efficient use of configuration data.
1366
        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.
1367
        hook_status = 'not_applicable'
1368
        for hook in hooks:
4797.5.1 by Robert Collins
Support state on per-file merging to permit more efficient use of configuration data.
1369
            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.
1370
            if hook_status != 'not_applicable':
1371
                # 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.
1372
                break
4869.3.18 by Andrew Bennetts
Simplify slightly more.
1373
        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.
1374
        if hook_status == 'not_applicable':
4869.3.17 by Andrew Bennetts
Remove contents_conflict nested function, replace last callsite with simpler form.
1375
            # This is a contents conflict, because none of the available
1376
            # functions could merge it.
4869.3.18 by Andrew Bennetts
Simplify slightly more.
1377
            result = None
4869.3.17 by Andrew Bennetts
Remove contents_conflict nested function, replace last callsite with simpler form.
1378
            name = self.tt.final_name(trans_id)
1379
            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.
1380
            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.
1381
                self.tt.unversion_file(trans_id)
1382
            file_group = self._dump_conflicts(name, parent_id, file_id,
1383
                                              set_version=True)
1384
            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.
1385
        elif hook_status == 'success':
1386
            self.tt.create_file(lines, trans_id)
1387
        elif hook_status == 'conflicted':
1388
            # XXX: perhaps the hook should be able to provide
1389
            # the BASE/THIS/OTHER files?
1390
            self.tt.create_file(lines, trans_id)
1391
            self._raw_conflicts.append(('text conflict', trans_id))
1392
            name = self.tt.final_name(trans_id)
1393
            parent_id = self.tt.final_parent(trans_id)
4869.3.23 by Andrew Bennetts
Remove some confusing code that has no effect.
1394
            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.
1395
        elif hook_status == 'delete':
1396
            self.tt.unversion_file(trans_id)
4869.3.18 by Andrew Bennetts
Simplify slightly more.
1397
            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.
1398
        elif hook_status == 'done':
1399
            # The hook function did whatever it needs to do directly, no
1400
            # further action needed here.
1401
            pass
1402
        else:
4869.3.18 by Andrew Bennetts
Simplify slightly more.
1403
            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.
1404
        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.
1405
            self.tt.version_file(file_id, trans_id)
4869.3.31 by Andrew Bennetts
Add comment, improve doc string, remove redundant line.
1406
        # The merge has been performed, so the old contents should not be
1407
        # retained.
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.
1408
        try:
1409
            self.tt.delete_contents(trans_id)
1410
        except errors.NoSuchFile:
1411
            pass
4869.3.18 by Andrew Bennetts
Simplify slightly more.
1412
        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.
1413
4869.3.16 by Andrew Bennetts
Move handling of winner==OTHER case into generic hook path too.
1414
    def _default_other_winner_merge(self, merge_hook_params):
1415
        """Replace this contents with other."""
1416
        file_id = merge_hook_params.file_id
1417
        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.
1418
        file_in_this = self.this_tree.has_id(file_id)
1419
        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.
1420
            # OTHER changed the file
1421
            wt = self.this_tree
1422
            if wt.supports_content_filtering():
1423
                # We get the path from the working tree if it exists.
1424
                # That fails though when OTHER is adding a file, so
1425
                # we fall back to the other tree to find the path if
1426
                # it doesn't exist locally.
1427
                try:
1428
                    filter_tree_path = wt.id2path(file_id)
1429
                except errors.NoSuchId:
1430
                    filter_tree_path = self.other_tree.id2path(file_id)
1431
            else:
1432
                # Skip the id2path lookup for older formats
1433
                filter_tree_path = None
1434
            transform.create_from_tree(self.tt, trans_id,
1435
                             self.other_tree, file_id,
1436
                             filter_tree_path=filter_tree_path)
1437
            return 'done', None
1438
        elif file_in_this:
1439
            # OTHER deleted the file
1440
            return 'delete', None
1441
        else:
1442
            raise AssertionError(
1443
                'winner is OTHER, but file_id %r not in THIS or OTHER tree'
1444
                % (file_id,))
1445
4797.5.1 by Robert Collins
Support state on per-file merging to permit more efficient use of configuration data.
1446
    def merge_contents(self, merge_hook_params):
1447
        """Fallback merge logic after user installed hooks."""
1448
        # This function is used in merge hooks as the fallback instance.
1449
        # Perhaps making this function and the functions it calls be a 
1450
        # a separate class would be better.
4869.3.16 by Andrew Bennetts
Move handling of winner==OTHER case into generic hook path too.
1451
        if merge_hook_params.winner == 'other':
1452
            # OTHER is a straight winner, so replace this contents with other
1453
            return self._default_other_winner_merge(merge_hook_params)
1454
        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.
1455
            # THIS and OTHER are both files, so text merge.  Either
1456
            # BASE is a file, or both converted to files, so at least we
1457
            # have agreement that output should be a file.
1458
            try:
1459
                self.text_merge(merge_hook_params.file_id,
1460
                    merge_hook_params.trans_id)
1461
            except errors.BinaryFile:
1462
                return 'not_applicable', None
4869.3.16 by Andrew Bennetts
Move handling of winner==OTHER case into generic hook path too.
1463
            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.
1464
        else:
1465
            return 'not_applicable', None
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1466
1467
    def get_lines(self, tree, file_id):
1534.7.157 by Aaron Bentley
Added more docs
1468
        """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.
1469
        if tree.has_id(file_id):
4708.2.1 by Martin
Ensure all files opened by bazaar proper are explicitly closed
1470
            return tree.get_file_lines(file_id)
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1471
        else:
1472
            return []
1473
1474
    def text_merge(self, file_id, trans_id):
1475
        """Perform a three-way text merge on a file_id"""
1476
        # it's possible that we got here with base as a different type.
1477
        # 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.
1478
        if self.base_tree.has_id(file_id) and \
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1479
            self.base_tree.kind(file_id) == "file":
1480
            base_lines = self.get_lines(self.base_tree, file_id)
1481
        else:
1482
            base_lines = []
1483
        other_lines = self.get_lines(self.other_tree, file_id)
1484
        this_lines = self.get_lines(self.this_tree, file_id)
4721.3.1 by Vincent Ladeuil
Cleanup imports.
1485
        m3 = merge3.Merge3(base_lines, this_lines, other_lines,
1486
                           is_cherrypick=self.cherrypick)
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1487
        start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
1488
        if self.show_base is True:
1489
            base_marker = '|' * 7
1490
        else:
1491
            base_marker = None
1492
1493
        def iter_merge3(retval):
1494
            retval["text_conflicts"] = False
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1495
            for line in m3.merge_lines(name_a = "TREE",
1496
                                       name_b = "MERGE-SOURCE",
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1497
                                       name_base = "BASE-REVISION",
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1498
                                       start_marker=start_marker,
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1499
                                       base_marker=base_marker,
1500
                                       reprocess=self.reprocess):
1501
                if line.startswith(start_marker):
1502
                    retval["text_conflicts"] = True
1503
                    yield line.replace(start_marker, '<' * 7)
1504
                else:
1505
                    yield line
1506
        retval = {}
1507
        merge3_iterator = iter_merge3(retval)
1508
        self.tt.create_file(merge3_iterator, trans_id)
1509
        if retval["text_conflicts"] is True:
1510
            self._raw_conflicts.append(('text conflict', trans_id))
1511
            name = self.tt.final_name(trans_id)
1512
            parent_id = self.tt.final_parent(trans_id)
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1513
            file_group = self._dump_conflicts(name, parent_id, file_id,
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1514
                                              this_lines, base_lines,
1515
                                              other_lines)
1516
            file_group.append(trans_id)
1517
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1518
    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
1519
                        base_lines=None, other_lines=None, set_version=False,
1520
                        no_base=False):
1534.7.157 by Aaron Bentley
Added more docs
1521
        """Emit conflict files.
1522
        If this_lines, base_lines, or other_lines are omitted, they will be
1523
        determined automatically.  If set_version is true, the .OTHER, .THIS
1524
        or .BASE (in that order) will be created as versioned files.
1525
        """
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1526
        data = [('OTHER', self.other_tree, other_lines),
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1527
                ('THIS', self.this_tree, this_lines)]
1528
        if not no_base:
1529
            data.append(('BASE', self.base_tree, base_lines))
4443.2.1 by Ian Clatworthy
apply content filters when merging new files
1530
1531
        # We need to use the actual path in the working tree of the file here,
1532
        # ignoring the conflict suffixes
1533
        wt = self.this_tree
1534
        if wt.supports_content_filtering():
1535
            try:
1536
                filter_tree_path = wt.id2path(file_id)
1537
            except errors.NoSuchId:
1538
                # file has been deleted
1539
                filter_tree_path = None
1540
        else:
1541
            # Skip the id2path lookup for older formats
1542
            filter_tree_path = None
1543
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1544
        versioned = False
1545
        file_group = []
1546
        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.
1547
            if tree.has_id(file_id):
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1548
                trans_id = self._conflict_file(name, parent_id, tree, file_id,
4443.2.1 by Ian Clatworthy
apply content filters when merging new files
1549
                                               suffix, lines, filter_tree_path)
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1550
                file_group.append(trans_id)
1551
                if set_version and not versioned:
1552
                    self.tt.version_file(file_id, trans_id)
1553
                    versioned = True
1554
        return file_group
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1555
3363.17.21 by Aaron Bentley
Conflicts are handled when merging from preview trees
1556
    def _conflict_file(self, name, parent_id, tree, file_id, suffix,
4443.2.1 by Ian Clatworthy
apply content filters when merging new files
1557
                       lines=None, filter_tree_path=None):
1534.7.157 by Aaron Bentley
Added more docs
1558
        """Emit a single conflict file."""
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1559
        name = name + '.' + suffix
1560
        trans_id = self.tt.create_path(name, parent_id)
4854.1.1 by Andrew Bennetts
Merge lp:bzr/2.0 into lp:bzr.
1561
        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
1562
            filter_tree_path)
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1563
        return trans_id
1564
1565
    def merge_executable(self, file_id, file_status):
1534.7.157 by Aaron Bentley
Added more docs
1566
        """Perform a merge on the execute bit."""
2590.2.3 by Aaron Bentley
Merge the execute bit based on iter_changes
1567
        executable = [self.executable(t, file_id) for t in (self.base_tree,
1568
                      self.other_tree, self.this_tree)]
3514.4.40 by John Arbash Meinel
Make 'resolver' a required parameter.
1569
        self._merge_executable(file_id, executable, file_status,
1570
                               resolver=self._three_way)
2590.2.3 by Aaron Bentley
Merge the execute bit based on iter_changes
1571
3514.4.21 by John Arbash Meinel
Hook up the lca-way logic into the path handlers.
1572
    def _merge_executable(self, file_id, executable, file_status,
3514.4.40 by John Arbash Meinel
Make 'resolver' a required parameter.
1573
                          resolver):
2590.2.3 by Aaron Bentley
Merge the execute bit based on iter_changes
1574
        """Perform a merge on the execute bit."""
1575
        base_executable, other_executable, this_executable = executable
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1576
        if file_status == "deleted":
1577
            return
3514.4.21 by John Arbash Meinel
Hook up the lca-way logic into the path handlers.
1578
        winner = resolver(*executable)
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1579
        if winner == "conflict":
1580
        # There must be a None in here, if we have a conflict, but we
1581
        # need executability since file status was not deleted.
1534.10.35 by Aaron Bentley
Merge handles contents + executable + deletion conflict
1582
            if self.executable(self.other_tree, file_id) is None:
1534.7.142 by Aaron Bentley
Fixed executability conflicts
1583
                winner = "this"
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1584
            else:
1534.7.142 by Aaron Bentley
Fixed executability conflicts
1585
                winner = "other"
1551.19.30 by Aaron Bentley
Accelerate merge by skipping file existence check when merging execute bit
1586
        if winner == 'this' and file_status != "modified":
1587
            return
1588
        trans_id = self.tt.trans_id_file_id(file_id)
1589
        try:
1590
            if self.tt.final_kind(trans_id) != "file":
1591
                return
4721.3.1 by Vincent Ladeuil
Cleanup imports.
1592
        except errors.NoSuchFile:
1551.19.30 by Aaron Bentley
Accelerate merge by skipping file existence check when merging execute bit
1593
            return
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1594
        if winner == "this":
1551.19.30 by Aaron Bentley
Accelerate merge by skipping file existence check when merging execute bit
1595
            executability = this_executable
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1596
        else:
4869.3.22 by Andrew Bennetts
Use 'tree.has_id(file_id)' rather than using 'file_id in tree' or using tree.inventory.
1597
            if self.other_tree.has_id(file_id):
2590.2.3 by Aaron Bentley
Merge the execute bit based on iter_changes
1598
                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.
1599
            elif self.this_tree.has_id(file_id):
2590.2.3 by Aaron Bentley
Merge the execute bit based on iter_changes
1600
                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.
1601
            elif self.base_tree_has_id(file_id):
2590.2.3 by Aaron Bentley
Merge the execute bit based on iter_changes
1602
                executability = base_executable
1551.19.30 by Aaron Bentley
Accelerate merge by skipping file existence check when merging execute bit
1603
        if executability is not None:
1604
            trans_id = self.tt.trans_id_file_id(file_id)
1605
            self.tt.set_executability(executability, trans_id)
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1606
1534.7.172 by Aaron Bentley
Integrated fs conflicts with merge conflicts.
1607
    def cook_conflicts(self, fs_conflicts):
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1608
        """Convert all conflicts into a form that doesn't depend on trans_id"""
4721.3.1 by Vincent Ladeuil
Cleanup imports.
1609
        self.cooked_conflicts.extend(transform.cook_conflicts(
1610
                fs_conflicts, self.tt))
1611
        fp = transform.FinalPaths(self.tt)
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1612
        for conflict in self._raw_conflicts:
1613
            conflict_type = conflict[0]
4597.7.11 by Vincent Ladeuil
Fix #531967 by creating helpers for PathConflicts when a deletion
1614
            if conflict_type == 'path conflict':
1615
                (trans_id, file_id,
1616
                this_parent, this_name,
1617
                other_parent, other_name) = conflict[1:]
1618
                if this_parent is None or this_name is None:
1619
                    this_path = '<deleted>'
1620
                else:
1621
                    parent_path =  fp.get_path(
1622
                        self.tt.trans_id_file_id(this_parent))
1623
                    this_path = osutils.pathjoin(parent_path, this_name)
1624
                if other_parent is None or other_name is None:
1625
                    other_path = '<deleted>'
1626
                else:
1627
                    parent_path =  fp.get_path(
1628
                        self.tt.trans_id_file_id(other_parent))
1629
                    other_path = osutils.pathjoin(parent_path, other_name)
1630
                c = _mod_conflicts.Conflict.factory(
1631
                    'path conflict', path=this_path,
1632
                    conflict_path=other_path,
1633
                    file_id=file_id)
1634
            elif conflict_type == 'contents conflict':
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1635
                for trans_id in conflict[1]:
1636
                    file_id = self.tt.final_file_id(trans_id)
1637
                    if file_id is not None:
1638
                        break
1639
                path = fp.get_path(trans_id)
1640
                for suffix in ('.BASE', '.THIS', '.OTHER'):
1641
                    if path.endswith(suffix):
1642
                        path = path[:-len(suffix)]
1643
                        break
4721.3.1 by Vincent Ladeuil
Cleanup imports.
1644
                c = _mod_conflicts.Conflict.factory(conflict_type,
1645
                                                    path=path, file_id=file_id)
4597.7.11 by Vincent Ladeuil
Fix #531967 by creating helpers for PathConflicts when a deletion
1646
            elif conflict_type == 'text conflict':
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1647
                trans_id = conflict[1]
1648
                path = fp.get_path(trans_id)
1649
                file_id = self.tt.final_file_id(trans_id)
4721.3.1 by Vincent Ladeuil
Cleanup imports.
1650
                c = _mod_conflicts.Conflict.factory(conflict_type,
1651
                                                    path=path, file_id=file_id)
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1652
            else:
4597.7.18 by Vincent Ladeuil
Start addressing Andrew's concerns.
1653
                raise AssertionError('bad conflict type: %r' % (conflict,))
1534.10.19 by Aaron Bentley
Stanza conversion, cooking
1654
            self.cooked_conflicts.append(c)
4721.3.1 by Vincent Ladeuil
Cleanup imports.
1655
        self.cooked_conflicts.sort(key=_mod_conflicts.Conflict.sort_key)
1534.7.141 by Aaron Bentley
Added conflict reporting
1656
1657
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1658
class WeaveMerger(Merge3Merger):
1534.7.167 by Aaron Bentley
PEP8 and comment cleanups
1659
    """Three-way tree merger, text weave merger."""
1551.6.8 by Aaron Bentley
Implemented reprocess for weave
1660
    supports_reprocess = True
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1661
    supports_show_base = False
3062.2.7 by Aaron Bentley
Prevent reverse cherry-picking with weave
1662
    supports_reverse_cherrypick = False
3062.2.9 by Aaron Bentley
Don't use the base if not cherrypicking
1663
    history_based = True
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1664
4634.101.7 by John Arbash Meinel
Start working on the ability to drop a .BASE file for --weave and --lca merge.
1665
    def _generate_merge_plan(self, file_id, base):
1666
        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
1667
                                              base=base)
4634.101.7 by John Arbash Meinel
Start working on the ability to drop a .BASE file for --weave and --lca merge.
1668
1669
    def _merged_lines(self, file_id):
1670
        """Generate the merged lines.
1671
        There is no distinction between lines that are meant to contain <<<<<<<
1672
        and conflicts.
1673
        """
1674
        if self.cherrypick:
1675
            base = self.base_tree
1676
        else:
1677
            base = None
1678
        plan = self._generate_merge_plan(file_id, base)
1551.19.17 by Aaron Bentley
Add debugging flag for merges
1679
        if 'merge' in debug.debug_flags:
1680
            plan = list(plan)
1681
            trans_id = self.tt.trans_id_file_id(file_id)
1682
            name = self.tt.final_name(trans_id) + '.plan'
4634.101.6 by John Arbash Meinel
killed-both and killed-base is 11 chars long.
1683
            contents = ('%11s|%s' % l for l in plan)
1551.19.17 by Aaron Bentley
Add debugging flag for merges
1684
            self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
4721.3.1 by Vincent Ladeuil
Cleanup imports.
1685
        textmerge = versionedfile.PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1686
                                                 '>>>>>>> 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.
1687
        lines, conflicts = textmerge.merge_lines(self.reprocess)
1688
        if conflicts:
1689
            base_lines = textmerge.base_from_plan()
1690
        else:
1691
            base_lines = None
1692
        return lines, base_lines
4869.2.2 by Andrew Bennetts
Remove some duplication.
1693
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1694
    def text_merge(self, file_id, trans_id):
1534.7.157 by Aaron Bentley
Added more docs
1695
        """Perform a (weave) text merge for a given file and file-id.
1696
        If conflicts are encountered, .THIS and .OTHER files will be emitted,
1697
        and a conflict will be noted.
1698
        """
4634.101.7 by John Arbash Meinel
Start working on the ability to drop a .BASE file for --weave and --lca merge.
1699
        lines, base_lines = self._merged_lines(file_id)
1558.15.10 by Aaron Bentley
Merge bzr.dev
1700
        lines = list(lines)
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1701
        # Note we're checking whether the OUTPUT is binary in this case,
1558.15.5 by Aaron Bentley
Fixed binary handling in weave merge
1702
        # because we don't want to get into weave merge guts.
4721.3.1 by Vincent Ladeuil
Cleanup imports.
1703
        textfile.check_text_lines(lines)
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1704
        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.
1705
        if base_lines is not None:
1706
            # Conflict
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1707
            self._raw_conflicts.append(('text conflict', trans_id))
1708
            name = self.tt.final_name(trans_id)
1709
            parent_id = self.tt.final_parent(trans_id)
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1710
            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.
1711
                                              no_base=False,
1712
                                              base_lines=base_lines)
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1713
            file_group.append(trans_id)
1714
1715
3144.3.1 by Aaron Bentley
Implement LCA merge, with problematic conflict markers
1716
class LCAMerger(WeaveMerger):
1717
4634.101.7 by John Arbash Meinel
Start working on the ability to drop a .BASE file for --weave and --lca merge.
1718
    def _generate_merge_plan(self, file_id, base):
1719
        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
1720
                                                  base=base)
1721
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1722
class Diff3Merger(Merge3Merger):
1534.7.167 by Aaron Bentley
PEP8 and comment cleanups
1723
    """Three-way merger using external diff3 for text merging"""
1711.7.20 by John Arbash Meinel
always close files, minor PEP8 cleanup
1724
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1725
    def dump_file(self, temp_dir, name, tree, file_id):
4721.3.1 by Vincent Ladeuil
Cleanup imports.
1726
        out_path = osutils.pathjoin(temp_dir, name)
1711.7.20 by John Arbash Meinel
always close files, minor PEP8 cleanup
1727
        out_file = open(out_path, "wb")
1728
        try:
1729
            in_file = tree.get_file(file_id)
1730
            for line in in_file:
1731
                out_file.write(line)
1732
        finally:
1733
            out_file.close()
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1734
        return out_path
1735
1736
    def text_merge(self, file_id, trans_id):
1534.7.157 by Aaron Bentley
Added more docs
1737
        """Perform a diff3 merge using a specified file-id and trans-id.
1738
        If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
1739
        will be dumped, and a will be conflict noted.
1740
        """
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1741
        import bzrlib.patch
1996.3.18 by John Arbash Meinel
Now that mkdtemp and rmtree are lazy, they should not be directly improted.
1742
        temp_dir = osutils.mkdtemp(prefix="bzr-")
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1743
        try:
4721.3.1 by Vincent Ladeuil
Cleanup imports.
1744
            new_file = osutils.pathjoin(temp_dir, "new")
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1745
            this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
1746
            base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
1747
            other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
1748
            status = bzrlib.patch.diff3(new_file, this, base, other)
1749
            if status not in (0, 1):
4721.3.1 by Vincent Ladeuil
Cleanup imports.
1750
                raise errors.BzrError("Unhandled diff3 exit code")
1711.7.20 by John Arbash Meinel
always close files, minor PEP8 cleanup
1751
            f = open(new_file, 'rb')
1752
            try:
1753
                self.tt.create_file(f, trans_id)
1754
            finally:
1755
                f.close()
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1756
            if status == 1:
1757
                name = self.tt.final_name(trans_id)
1758
                parent_id = self.tt.final_parent(trans_id)
1759
                self._dump_conflicts(name, parent_id, file_id)
1551.8.39 by Aaron Bentley
Fix diff3 conflict-reporting bug
1760
                self._raw_conflicts.append(('text conflict', trans_id))
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1761
        finally:
1996.3.18 by John Arbash Meinel
Now that mkdtemp and rmtree are lazy, they should not be directly improted.
1762
            osutils.rmtree(temp_dir)
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1763
1764
5246.2.18 by Andrew Bennetts
Fix traceback if source path does not exist.
1765
class PathNotInTree(errors.BzrError):
1766
5246.2.28 by Andrew Bennetts
Improve some docstrings.
1767
    _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.
1768
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.
1769
    def __init__(self, path, tree):
1770
        errors.BzrError.__init__(self, path=path, tree=tree)
5246.2.18 by Andrew Bennetts
Fix traceback if source path does not exist.
1771
1772
5246.2.1 by Andrew Bennetts
Very rough first draft of cmd_merge_into from bzr-merge-into. Passes its blackbox tests.
1773
class MergeIntoMerger(Merger):
1774
    """Merger that understands other_tree will be merged into a subdir.
1775
1776
    This also changes the Merger api so that it uses real Branch, revision_id,
1777
    and RevisonTree objects, rather than using revision specs.
1778
    """
1779
1780
    def __init__(self, this_tree, other_branch, other_tree, target_subdir,
5246.2.22 by Andrew Bennetts
Minor tweaks.
1781
            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.
1782
        """Create a new MergeIntoMerger object.
1783
5246.2.6 by Andrew Bennetts
Improve some docstrings. Simplify code slightly.
1784
        source_subpath in other_tree will be effectively copied to
1785
        target_subdir in this_tree.
1786
5246.2.1 by Andrew Bennetts
Very rough first draft of cmd_merge_into from bzr-merge-into. Passes its blackbox tests.
1787
        :param this_tree: The tree that we will be merging into.
1788
        :param other_branch: The Branch we will be merging from.
1789
        :param other_tree: The RevisionTree object we want to merge.
1790
        :param target_subdir: The relative path where we want to merge
1791
            other_tree into this_tree
5246.2.6 by Andrew Bennetts
Improve some docstrings. Simplify code slightly.
1792
        :param source_subpath: The relative path specifying the subtree of
1793
            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.
1794
        """
1795
        # It is assumed that we are merging a tree that is not in our current
1796
        # ancestry, which means we are using the "EmptyTree" as our basis.
1797
        null_ancestor_tree = this_tree.branch.repository.revision_tree(
1798
                                _mod_revision.NULL_REVISION)
1799
        super(MergeIntoMerger, self).__init__(
1800
            this_branch=this_tree.branch,
1801
            this_tree=this_tree,
1802
            other_tree=other_tree,
1803
            base_tree=null_ancestor_tree,
1804
            )
1805
        self._target_subdir = target_subdir
1806
        self._source_subpath = source_subpath
1807
        self.other_branch = other_branch
5246.2.22 by Andrew Bennetts
Minor tweaks.
1808
        if other_rev_id is None:
1809
            other_rev_id = other_tree.get_revision_id()
1810
        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.
1811
        self.base_is_ancestor = True
1812
        self.backup_files = True
1813
        self.merge_type = Merge3Merger
1814
        self.show_base = False
1815
        self.reprocess = False
1816
        self.interesting_ids = None
5246.2.32 by Andrew Bennetts
Rename _Wrapper to _MergeTypeParameterizer.
1817
        self.merge_type = _MergeTypeParameterizer(MergeIntoMergeType,
1818
              target_subdir=self._target_subdir,
1819
              source_subpath=self._source_subpath)
5246.2.11 by Andrew Bennetts
Handle partial tree merges, add more tests, refactor tests a little.
1820
        if self._source_subpath != '':
1821
            # If this isn't a partial merge make sure the revisions will be
1822
            # present.
1823
            self._maybe_fetch(self.other_branch, self.this_branch,
1824
                self.other_basis)
1825
1826
    def set_pending(self):
1827
        if self._source_subpath != '':
1828
            return
1829
        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.
1830
1831
5246.2.32 by Andrew Bennetts
Rename _Wrapper to _MergeTypeParameterizer.
1832
class _MergeTypeParameterizer(object):
5246.2.29 by Andrew Bennetts
Improve some docstrings.
1833
    """Wrap a merge-type class to provide extra parameters.
1834
    
1835
    This is hack used by MergeIntoMerger to pass some extra parameters to its
1836
    merge_type.  Merger.do_merge() sets up its own set of parameters to pass to
1837
    the 'merge_type' member.  It is difficult override do_merge without
1838
    re-writing the whole thing, so instead we create a wrapper which will pass
1839
    the extra parameters.
1840
    """
5246.2.1 by Andrew Bennetts
Very rough first draft of cmd_merge_into from bzr-merge-into. Passes its blackbox tests.
1841
1842
    def __init__(self, merge_type, **kwargs):
1843
        self._extra_kwargs = kwargs
1844
        self._merge_type = merge_type
1845
1846
    def __call__(self, *args, **kwargs):
1847
        kwargs.update(self._extra_kwargs)
1848
        return self._merge_type(*args, **kwargs)
1849
1850
    def __getattr__(self, name):
1851
        return getattr(self._merge_type, name)
1852
1853
5246.2.30 by Andrew Bennetts
Rename Merge3MergeIntoMerger to MergeIntoMergeType.
1854
class MergeIntoMergeType(Merge3Merger):
5246.2.18 by Andrew Bennetts
Fix traceback if source path does not exist.
1855
    """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.
1856
1857
    def __init__(self, *args, **kwargs):
5246.2.28 by Andrew Bennetts
Improve some docstrings.
1858
        """Initialize the merger object.
1859
1860
        :param args: See Merge3Merger.__init__'s args.
1861
        :param kwargs: See Merge3Merger.__init__'s keyword args, except for
1862
            source_subpath and target_subdir.
1863
        :keyword source_subpath: The relative path specifying the subtree of
1864
            other_tree to merge into this_tree.
1865
        :keyword target_subdir: The relative path where we want to merge
1866
            other_tree into this_tree
1867
        """
5246.2.1 by Andrew Bennetts
Very rough first draft of cmd_merge_into from bzr-merge-into. Passes its blackbox tests.
1868
        # All of the interesting work happens during Merge3Merger.__init__(),
1869
        # so we have have to hack in to get our extra parameters set.
1870
        self._source_subpath = kwargs.pop('source_subpath')
1871
        self._target_subdir = kwargs.pop('target_subdir')
5246.2.30 by Andrew Bennetts
Rename Merge3MergeIntoMerger to MergeIntoMergeType.
1872
        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.
1873
1874
    def _compute_transform(self):
1875
        child_pb = ui.ui_factory.nested_progress_bar()
1876
        try:
1877
            entries = self._entries_to_incorporate()
1878
            entries = list(entries)
1879
            for num, (entry, parent_id) in enumerate(entries):
1880
                child_pb.update('Preparing file merge', num, len(entries))
1881
                parent_trans_id = self.tt.trans_id_file_id(parent_id)
1882
                trans_id = transform.new_by_entry(self.tt, entry,
1883
                    parent_trans_id, self.other_tree)
1884
        finally:
1885
            child_pb.finished()
5246.2.33 by Andrew Bennetts
Rename _finish_transform to _finish_computing_transform.
1886
        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.
1887
1888
    def _entries_to_incorporate(self):
5246.2.18 by Andrew Bennetts
Fix traceback if source path does not exist.
1889
        """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.
1890
        other_inv = self.other_tree.inventory
1891
        subdir_id = other_inv.path2id(self._source_subpath)
5246.2.18 by Andrew Bennetts
Fix traceback if source path does not exist.
1892
        if subdir_id is None:
5246.2.20 by Andrew Bennetts
Tweak comments, add NEWS entry.
1893
            # XXX: The error would be clearer if it gave the URL of the source
1894
            # 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.
1895
            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.
1896
        subdir = other_inv[subdir_id]
1897
        parent_in_target = osutils.dirname(self._target_subdir)
1898
        target_id = self.this_tree.inventory.path2id(parent_in_target)
1899
        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.
1900
            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.
1901
        name_in_target = osutils.basename(self._target_subdir)
1902
        merge_into_root = subdir.copy()
1903
        merge_into_root.name = name_in_target
5246.2.9 by Andrew Bennetts
Make all the existing tests pass.
1904
        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.
1905
            # 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.
1906
            # This can happen fairly easily if the directory we are
1907
            # incorporating is the root, and both trees have 'TREE_ROOT' as
1908
            # their root_id.  Users will expect this to Just Work, so we
1909
            # change the file-id here.
1910
            # Non-root file-ids could potentially conflict too.  That's really
1911
            # an edge case, so we don't do anything special for those.  We let
1912
            # them cause conflicts.
5246.2.9 by Andrew Bennetts
Make all the existing tests pass.
1913
            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.
1914
        yield (merge_into_root, target_id)
5246.2.10 by Andrew Bennetts
Add more tests.
1915
        if subdir.kind != 'directory':
1916
            # No children, so we are done.
1917
            return
5246.2.1 by Andrew Bennetts
Very rough first draft of cmd_merge_into from bzr-merge-into. Passes its blackbox tests.
1918
        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.
1919
            parent_id = entry.parent_id
1920
            if parent_id == subdir.file_id:
1921
                # The root's parent ID has changed, so make sure children of
1922
                # the root refer to the new ID.
1923
                parent_id = merge_into_root.file_id
1924
            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.
1925
1926
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1927
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.
1928
                backup_files=False,
1929
                merge_type=Merge3Merger,
1930
                interesting_ids=None,
1931
                show_base=False,
1932
                reprocess=False,
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1933
                other_rev_id=None,
1934
                interesting_files=None,
1534.9.9 by Aaron Bentley
Added progress bar to pull
1935
                this_tree=None,
4961.2.9 by Martin Pool
Rip out most remaining uses of DummyProgressBar
1936
                pb=None,
1551.11.10 by Aaron Bentley
Add change reporting to pull
1937
                change_reporter=None):
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1938
    """Primary interface for merging.
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1939
5246.2.1 by Andrew Bennetts
Very rough first draft of cmd_merge_into from bzr-merge-into. Passes its blackbox tests.
1940
    Typical use is probably::
1941
1942
        merge_inner(branch, branch.get_revision_tree(other_revision),
1943
                    branch.get_revision_tree(base_revision))
1944
    """
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1945
    if this_tree is None:
4721.3.1 by Vincent Ladeuil
Cleanup imports.
1946
        raise errors.BzrError("bzrlib.merge.merge_inner requires a this_tree "
1947
                              "parameter as of bzrlib version 0.8.")
2255.2.31 by Robert Collins
Work in progress to make merge_inner work with dirstate trees.
1948
    merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1551.11.10 by Aaron Bentley
Add change reporting to pull
1949
                    pb=pb, change_reporter=change_reporter)
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1950
    merger.backup_files = backup_files
1951
    merger.merge_type = merge_type
1952
    merger.interesting_ids = interesting_ids
1551.2.23 by Aaron Bentley
Got merge_inner's ignore_zero parameter working
1953
    merger.ignore_zero = ignore_zero
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1954
    if interesting_files:
3376.2.4 by Martin Pool
Remove every assert statement from bzrlib!
1955
        if interesting_ids:
1956
            raise ValueError('Only supply interesting_ids'
1957
                             ' or interesting_files')
2590.2.5 by Aaron Bentley
Allow selected files to be specified instead of selected ids
1958
        merger.interesting_files = interesting_files
1979.2.1 by Robert Collins
(robertc) adds a convenience method "merge_from_branch" to WorkingTree.
1959
    merger.show_base = show_base
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1960
    merger.reprocess = reprocess
1961
    merger.other_rev_id = other_rev_id
1962
    merger.other_basis = other_rev_id
3249.3.1 by John Arbash Meinel
Implement cherrypick support for Merge3
1963
    get_revision_id = getattr(base_tree, 'get_revision_id', None)
1964
    if get_revision_id is None:
1965
        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)
1966
    merger.cache_trees_with_revision_ids([other_tree, base_tree, this_tree])
3249.3.1 by John Arbash Meinel
Implement cherrypick support for Merge3
1967
    merger.set_base_revision(get_revision_id(), this_branch)
1534.7.140 by Aaron Bentley
Moved the merge stuff into merge.py
1968
    return merger.do_merge()
1969
2221.4.15 by Aaron Bentley
Use RegistryOption for merge type
1970
def get_merge_type_registry():
2221.4.17 by Aaron Bentley
PEP8-ness
1971
    """Merge type registry is in bzrlib.option to avoid circular imports.
2221.4.15 by Aaron Bentley
Use RegistryOption for merge type
1972
1973
    This method provides a sanctioned way to retrieve it.
1974
    """
1975
    from bzrlib import option
2221.4.16 by Aaron Bentley
Add tests for get_merge_type_registry
1976
    return option._merge_type_registry
1551.15.46 by Aaron Bentley
Move plan merge to tree
1977
1978
1979
def _plan_annotate_merge(annotated_a, annotated_b, ancestors_a, ancestors_b):
1980
    def status_a(revision, text):
1981
        if revision in ancestors_b:
1982
            return 'killed-b', text
1983
        else:
1984
            return 'new-a', text
1985
1986
    def status_b(revision, text):
1987
        if revision in ancestors_a:
1988
            return 'killed-a', text
1989
        else:
1990
            return 'new-b', text
1991
1992
    plain_a = [t for (a, t) in annotated_a]
1993
    plain_b = [t for (a, t) in annotated_b]
1994
    matcher = patiencediff.PatienceSequenceMatcher(None, plain_a, plain_b)
1995
    blocks = matcher.get_matching_blocks()
1996
    a_cur = 0
1997
    b_cur = 0
1998
    for ai, bi, l in blocks:
1999
        # process all mismatched sections
2000
        # (last mismatched section is handled because blocks always
2001
        # includes a 0-length last block)
2002
        for revision, text in annotated_a[a_cur:ai]:
2003
            yield status_a(revision, text)
2004
        for revision, text in annotated_b[b_cur:bi]:
2005
            yield status_b(revision, text)
2006
        # and now the matched section
2007
        a_cur = ai + l
2008
        b_cur = bi + l
3376.2.8 by Martin Pool
Some review cleanups for assertion removal
2009
        for text_a in plain_a[ai:a_cur]:
1551.15.46 by Aaron Bentley
Move plan merge to tree
2010
            yield "unchanged", text_a
3062.1.9 by Aaron Bentley
Move PlanMerge into merge and _PlanMergeVersionedFile into versionedfile
2011
2012
3144.3.1 by Aaron Bentley
Implement LCA merge, with problematic conflict markers
2013
class _PlanMergeBase(object):
3062.1.9 by Aaron Bentley
Move PlanMerge into merge and _PlanMergeVersionedFile into versionedfile
2014
3350.6.10 by Martin Pool
VersionedFiles review cleanups
2015
    def __init__(self, a_rev, b_rev, vf, key_prefix):
3062.1.9 by Aaron Bentley
Move PlanMerge into merge and _PlanMergeVersionedFile into versionedfile
2016
        """Contructor.
2017
2018
        :param a_rev: Revision-id of one revision to merge
2019
        :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.
2020
        :param vf: A VersionedFiles containing both revisions
3350.6.10 by Martin Pool
VersionedFiles review cleanups
2021
        :param key_prefix: A prefix for accessing keys in vf, typically
2022
            (file_id,).
3062.1.9 by Aaron Bentley
Move PlanMerge into merge and _PlanMergeVersionedFile into versionedfile
2023
        """
2024
        self.a_rev = a_rev
2025
        self.b_rev = b_rev
2026
        self.vf = vf
3062.1.12 by Aaron Bentley
Implement simple text cache
2027
        self._last_lines = None
2028
        self._last_lines_revision_id = None
3144.3.7 by Aaron Bentley
Update from review
2029
        self._cached_matching_blocks = {}
3350.6.10 by Martin Pool
VersionedFiles review cleanups
2030
        self._key_prefix = key_prefix
3514.2.2 by John Arbash Meinel
Restore a real weave merge to 'bzr merge --weave'.
2031
        self._precache_tip_lines()
2032
2033
    def _precache_tip_lines(self):
2034
        lines = self.get_lines([self.a_rev, self.b_rev])
2035
        self.lines_a = lines[self.a_rev]
2036
        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.
2037
2038
    def get_lines(self, revisions):
2039
        """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.
2040
3350.6.10 by Martin Pool
VersionedFiles review cleanups
2041
        :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.
2042
        """
3350.6.10 by Martin Pool
VersionedFiles review cleanups
2043
        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.
2044
        result = {}
2045
        for record in self.vf.get_record_stream(keys, 'unordered', True):
2046
            if record.storage_kind == 'absent':
2047
                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.
2048
            result[record.key[-1]] = osutils.chunks_to_lines(
2049
                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.
2050
        return result
3062.1.9 by Aaron Bentley
Move PlanMerge into merge and _PlanMergeVersionedFile into versionedfile
2051
2052
    def plan_merge(self):
2053
        """Generate a 'plan' for merging the two revisions.
2054
2055
        This involves comparing their texts and determining the cause of
2056
        differences.  If text A has a line and text B does not, then either the
2057
        line was added to text A, or it was deleted from B.  Once the causes
2058
        are combined, they are written out in the format described in
2059
        VersionedFile.plan_merge
2060
        """
2061
        blocks = self._get_matching_blocks(self.a_rev, self.b_rev)
3144.3.1 by Aaron Bentley
Implement LCA merge, with problematic conflict markers
2062
        unique_a, unique_b = self._unique_lines(blocks)
2063
        new_a, killed_b = self._determine_status(self.a_rev, unique_a)
2064
        new_b, killed_a = self._determine_status(self.b_rev, unique_b)
2065
        return self._iter_plan(blocks, new_a, killed_b, new_b, killed_a)
2066
2067
    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
2068
        last_i = 0
2069
        last_j = 0
2070
        for i, j, n in blocks:
2071
            for a_index in range(last_i, i):
2072
                if a_index in new_a:
3144.3.2 by Aaron Bentley
Get conflict handling working
2073
                    if a_index in killed_b:
2074
                        yield 'conflicted-a', self.lines_a[a_index]
2075
                    else:
2076
                        yield 'new-a', self.lines_a[a_index]
2077
                else:
3144.3.1 by Aaron Bentley
Implement LCA merge, with problematic conflict markers
2078
                    yield 'killed-b', self.lines_a[a_index]
3062.1.9 by Aaron Bentley
Move PlanMerge into merge and _PlanMergeVersionedFile into versionedfile
2079
            for b_index in range(last_j, j):
2080
                if b_index in new_b:
3144.3.2 by Aaron Bentley
Get conflict handling working
2081
                    if b_index in killed_a:
3144.3.10 by Aaron Bentley
Use correct index when emitting conflicted-b
2082
                        yield 'conflicted-b', self.lines_b[b_index]
3144.3.2 by Aaron Bentley
Get conflict handling working
2083
                    else:
2084
                        yield 'new-b', self.lines_b[b_index]
2085
                else:
3144.3.1 by Aaron Bentley
Implement LCA merge, with problematic conflict markers
2086
                    yield 'killed-a', self.lines_b[b_index]
3062.1.9 by Aaron Bentley
Move PlanMerge into merge and _PlanMergeVersionedFile into versionedfile
2087
            # handle common lines
2088
            for a_index in range(i, i+n):
3144.3.1 by Aaron Bentley
Implement LCA merge, with problematic conflict markers
2089
                yield 'unchanged', self.lines_a[a_index]
3062.1.9 by Aaron Bentley
Move PlanMerge into merge and _PlanMergeVersionedFile into versionedfile
2090
            last_i = i+n
2091
            last_j = j+n
2092
2093
    def _get_matching_blocks(self, left_revision, right_revision):
2094
        """Return a description of which sections of two revisions match.
2095
2096
        See SequenceMatcher.get_matching_blocks
2097
        """
3144.3.7 by Aaron Bentley
Update from review
2098
        cached = self._cached_matching_blocks.get((left_revision,
2099
                                                   right_revision))
2100
        if cached is not None:
2101
            return cached
3062.1.12 by Aaron Bentley
Implement simple text cache
2102
        if self._last_lines_revision_id == left_revision:
2103
            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.
2104
            right_lines = self.get_lines([right_revision])[right_revision]
3062.1.12 by Aaron Bentley
Implement simple text cache
2105
        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.
2106
            lines = self.get_lines([left_revision, right_revision])
2107
            left_lines = lines[left_revision]
2108
            right_lines = lines[right_revision]
3062.1.12 by Aaron Bentley
Implement simple text cache
2109
        self._last_lines = right_lines
2110
        self._last_lines_revision_id = right_revision
3062.1.9 by Aaron Bentley
Move PlanMerge into merge and _PlanMergeVersionedFile into versionedfile
2111
        matcher = patiencediff.PatienceSequenceMatcher(None, left_lines,
2112
                                                       right_lines)
2113
        return matcher.get_matching_blocks()
2114
2115
    def _unique_lines(self, matching_blocks):
2116
        """Analyse matching_blocks to determine which lines are unique
2117
2118
        :return: a tuple of (unique_left, unique_right), where the values are
2119
            sets of line numbers of unique lines.
2120
        """
2121
        last_i = 0
2122
        last_j = 0
2123
        unique_left = []
2124
        unique_right = []
2125
        for i, j, n in matching_blocks:
2126
            unique_left.extend(range(last_i, i))
2127
            unique_right.extend(range(last_j, j))
2128
            last_i = i + n
2129
            last_j = j + n
2130
        return unique_left, unique_right
2131
3144.3.1 by Aaron Bentley
Implement LCA merge, with problematic conflict markers
2132
    @staticmethod
2133
    def _subtract_plans(old_plan, new_plan):
3144.3.7 by Aaron Bentley
Update from review
2134
        """Remove changes from new_plan that came from old_plan.
2135
2136
        It is assumed that the difference between the old_plan and new_plan
2137
        is their choice of 'b' text.
2138
2139
        All lines from new_plan that differ from old_plan are emitted
2140
        verbatim.  All lines from new_plan that match old_plan but are
2141
        not about the 'b' revision are emitted verbatim.
2142
2143
        Lines that match and are about the 'b' revision are the lines we
2144
        don't want, so we convert 'killed-b' -> 'unchanged', and 'new-b'
2145
        is skipped entirely.
2146
        """
3144.3.1 by Aaron Bentley
Implement LCA merge, with problematic conflict markers
2147
        matcher = patiencediff.PatienceSequenceMatcher(None, old_plan,
2148
                                                       new_plan)
2149
        last_j = 0
2150
        for i, j, n in matcher.get_matching_blocks():
2151
            for jj in range(last_j, j):
2152
                yield new_plan[jj]
2153
            for jj in range(j, j+n):
2154
                plan_line = new_plan[jj]
2155
                if plan_line[0] == 'new-b':
2156
                    pass
2157
                elif plan_line[0] == 'killed-b':
2158
                    yield 'unchanged', plan_line[1]
2159
                else:
2160
                    yield plan_line
2161
            last_j = j + n
2162
2163
2164
class _PlanMerge(_PlanMergeBase):
2165
    """Plan an annotate merge using on-the-fly annotation"""
2166
3350.6.10 by Martin Pool
VersionedFiles review cleanups
2167
    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'.
2168
        super(_PlanMerge, self).__init__(a_rev, b_rev, vf, key_prefix)
2169
        self.a_key = self._key_prefix + (self.a_rev,)
2170
        self.b_key = self._key_prefix + (self.b_rev,)
4721.3.1 by Vincent Ladeuil
Cleanup imports.
2171
        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.
2172
        heads = self.graph.heads((self.a_key, self.b_key))
2173
        if len(heads) == 1:
2174
            # one side dominates, so we can just return its values, yay for
2175
            # per-file graphs
2176
            # Ideally we would know that before we get this far
2177
            self._head_key = heads.pop()
2178
            if self._head_key == self.a_key:
2179
                other = b_rev
2180
            else:
2181
                other = a_rev
4721.3.1 by Vincent Ladeuil
Cleanup imports.
2182
            trace.mutter('found dominating revision for %s\n%s > %s', self.vf,
2183
                         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.
2184
            self._weave = None
2185
        else:
2186
            self._head_key = None
2187
            self._build_weave()
3514.2.2 by John Arbash Meinel
Restore a real weave merge to 'bzr merge --weave'.
2188
2189
    def _precache_tip_lines(self):
2190
        # Turn this into a no-op, because we will do this later
2191
        pass
2192
2193
    def _find_recursive_lcas(self):
2194
        """Find all the ancestors back to a unique lca"""
2195
        cur_ancestors = (self.a_key, self.b_key)
2196
        # 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.
2197
        # rather than a key tuple. We will just map that directly to no common
2198
        # ancestors.
2199
        parent_map = {}
3514.2.2 by John Arbash Meinel
Restore a real weave merge to 'bzr merge --weave'.
2200
        while True:
2201
            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.
2202
            # Map a plain NULL_REVISION to a simple no-ancestors
4721.3.1 by Vincent Ladeuil
Cleanup imports.
2203
            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.
2204
                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.
2205
            # Order the lca's based on when they were merged into the tip
2206
            # While the actual merge portion of weave merge uses a set() of
2207
            # active revisions, the order of insertion *does* effect the
2208
            # implicit ordering of the texts.
3514.2.5 by John Arbash Meinel
Switch to the get_parent_map design I had settled on.
2209
            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.
2210
                ordered_parents = tuple(self.graph.find_merge_order(rev_key,
2211
                                                                    next_lcas))
2212
                parent_map[rev_key] = ordered_parents
3514.2.2 by John Arbash Meinel
Restore a real weave merge to 'bzr merge --weave'.
2213
            if len(next_lcas) == 0:
2214
                break
2215
            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.
2216
                parent_map[list(next_lcas)[0]] = ()
3514.2.2 by John Arbash Meinel
Restore a real weave merge to 'bzr merge --weave'.
2217
                break
3514.2.10 by John Arbash Meinel
Handle more edge cases.
2218
            elif len(next_lcas) > 2:
3514.2.7 by John Arbash Meinel
Fix the failing test by implementing the fallback logic.
2219
                # More than 2 lca's, fall back to grabbing all nodes between
2220
                # this and the unique lca.
4721.3.1 by Vincent Ladeuil
Cleanup imports.
2221
                trace.mutter('More than 2 LCAs, falling back to all nodes for:'
2222
                             ' %s, %s\n=> %s',
2223
                             self.a_key, self.b_key, cur_ancestors)
3514.2.7 by John Arbash Meinel
Fix the failing test by implementing the fallback logic.
2224
                cur_lcas = next_lcas
2225
                while len(cur_lcas) > 1:
2226
                    cur_lcas = self.graph.find_lca(*cur_lcas)
2227
                if len(cur_lcas) == 0:
2228
                    # No common base to find, use the full ancestry
2229
                    unique_lca = None
2230
                else:
3514.2.8 by John Arbash Meinel
The insertion ordering into the weave has an impact on conflicts.
2231
                    unique_lca = list(cur_lcas)[0]
4721.3.1 by Vincent Ladeuil
Cleanup imports.
2232
                    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.
2233
                        # find_lca will return a plain 'NULL_REVISION' rather
2234
                        # than a key tuple when there is no common ancestor, we
2235
                        # prefer to just use None, because it doesn't confuse
2236
                        # _get_interesting_texts()
2237
                        unique_lca = None
3514.2.7 by John Arbash Meinel
Fix the failing test by implementing the fallback logic.
2238
                parent_map.update(self._find_unique_parents(next_lcas,
2239
                                                            unique_lca))
2240
                break
3514.2.2 by John Arbash Meinel
Restore a real weave merge to 'bzr merge --weave'.
2241
            cur_ancestors = next_lcas
3514.2.5 by John Arbash Meinel
Switch to the get_parent_map design I had settled on.
2242
        return parent_map
3514.2.2 by John Arbash Meinel
Restore a real weave merge to 'bzr merge --weave'.
2243
3514.2.7 by John Arbash Meinel
Fix the failing test by implementing the fallback logic.
2244
    def _find_unique_parents(self, tip_keys, base_key):
2245
        """Find ancestors of tip that aren't ancestors of base.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2246
3514.2.7 by John Arbash Meinel
Fix the failing test by implementing the fallback logic.
2247
        :param tip_keys: Nodes that are interesting
2248
        :param base_key: Cull all ancestors of this node
2249
        :return: The parent map for all revisions between tip_keys and
2250
            base_key. base_key will be included. References to nodes outside of
2251
            the ancestor set will also be removed.
2252
        """
2253
        # TODO: this would be simpler if find_unique_ancestors took a list
2254
        #       instead of a single tip, internally it supports it, but it
2255
        #       isn't a "backwards compatible" api change.
2256
        if base_key is None:
2257
            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.
2258
            # We remove NULL_REVISION because it isn't a proper tuple key, and
2259
            # thus confuses things like _get_interesting_texts, and our logic
2260
            # to add the texts into the memory weave.
4721.3.1 by Vincent Ladeuil
Cleanup imports.
2261
            if _mod_revision.NULL_REVISION in parent_map:
2262
                parent_map.pop(_mod_revision.NULL_REVISION)
3514.2.7 by John Arbash Meinel
Fix the failing test by implementing the fallback logic.
2263
        else:
2264
            interesting = set()
2265
            for tip in tip_keys:
2266
                interesting.update(
2267
                    self.graph.find_unique_ancestors(tip, [base_key]))
2268
            parent_map = self.graph.get_parent_map(interesting)
2269
            parent_map[base_key] = ()
3514.2.12 by John Arbash Meinel
Start refactoring into helper functions
2270
        culled_parent_map, child_map, tails = self._remove_external_references(
2271
            parent_map)
3514.2.13 by John Arbash Meinel
Add the ability to prune extra tails from the parent_map.
2272
        # 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.
2273
        if base_key is not None:
2274
            tails.remove(base_key)
2275
            self._prune_tails(culled_parent_map, child_map, tails)
2276
        # Now remove all the uninteresting 'linear' regions
3514.2.15 by John Arbash Meinel
Enable collapsing linear regions.
2277
        simple_map = _mod_graph.collapse_linear_regions(culled_parent_map)
2278
        return simple_map
3514.2.12 by John Arbash Meinel
Start refactoring into helper functions
2279
2280
    @staticmethod
2281
    def _remove_external_references(parent_map):
2282
        """Remove references that go outside of the parent map.
2283
2284
        :param parent_map: Something returned from Graph.get_parent_map(keys)
2285
        :return: (filtered_parent_map, child_map, tails)
2286
            filtered_parent_map is parent_map without external references
2287
            child_map is the {parent_key: [child_keys]} mapping
2288
            tails is a list of nodes that do not have any parents in the map
2289
        """
2290
        # TODO: The basic effect of this function seems more generic than
2291
        #       _PlanMerge. But the specific details of building a child_map,
2292
        #       and computing tails seems very specific to _PlanMerge.
2293
        #       Still, should this be in Graph land?
2294
        filtered_parent_map = {}
2295
        child_map = {}
2296
        tails = []
3514.2.7 by John Arbash Meinel
Fix the failing test by implementing the fallback logic.
2297
        for key, parent_keys in parent_map.iteritems():
3514.2.12 by John Arbash Meinel
Start refactoring into helper functions
2298
            culled_parent_keys = [p for p in parent_keys if p in parent_map]
2299
            if not culled_parent_keys:
2300
                tails.append(key)
2301
            for parent_key in culled_parent_keys:
2302
                child_map.setdefault(parent_key, []).append(key)
2303
            # TODO: Do we want to do this, it adds overhead for every node,
2304
            #       just to say that the node has no children
2305
            child_map.setdefault(key, [])
2306
            filtered_parent_map[key] = culled_parent_keys
2307
        return filtered_parent_map, child_map, tails
2308
3514.2.13 by John Arbash Meinel
Add the ability to prune extra tails from the parent_map.
2309
    @staticmethod
2310
    def _prune_tails(parent_map, child_map, tails_to_remove):
2311
        """Remove tails from the parent map.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2312
3514.2.13 by John Arbash Meinel
Add the ability to prune extra tails from the parent_map.
2313
        This will remove the supplied revisions until no more children have 0
2314
        parents.
2315
2316
        :param parent_map: A dict of {child: [parents]}, this dictionary will
2317
            be modified in place.
2318
        :param tails_to_remove: A list of tips that should be removed,
2319
            this list will be consumed
2320
        :param child_map: The reverse dict of parent_map ({parent: [children]})
2321
            this dict will be modified
2322
        :return: None, parent_map will be modified in place.
2323
        """
2324
        while tails_to_remove:
2325
            next = tails_to_remove.pop()
2326
            parent_map.pop(next)
2327
            children = child_map.pop(next)
2328
            for child in children:
2329
                child_parents = parent_map[child]
2330
                child_parents.remove(next)
2331
                if len(child_parents) == 0:
2332
                    tails_to_remove.append(child)
3514.2.7 by John Arbash Meinel
Fix the failing test by implementing the fallback logic.
2333
3514.2.5 by John Arbash Meinel
Switch to the get_parent_map design I had settled on.
2334
    def _get_interesting_texts(self, parent_map):
3514.2.2 by John Arbash Meinel
Restore a real weave merge to 'bzr merge --weave'.
2335
        """Return a dict of texts we are interested in.
2336
2337
        Note that the input is in key tuples, but the output is in plain
2338
        revision ids.
2339
3514.2.5 by John Arbash Meinel
Switch to the get_parent_map design I had settled on.
2340
        :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'.
2341
        :return: A dict of {'revision_id':lines} as returned by
2342
            _PlanMergeBase.get_lines()
2343
        """
3514.2.5 by John Arbash Meinel
Switch to the get_parent_map design I had settled on.
2344
        all_revision_keys = set(parent_map)
2345
        all_revision_keys.add(self.a_key)
2346
        all_revision_keys.add(self.b_key)
3514.2.2 by John Arbash Meinel
Restore a real weave merge to 'bzr merge --weave'.
2347
3514.2.5 by John Arbash Meinel
Switch to the get_parent_map design I had settled on.
2348
        # Everything else is in 'keys' but get_lines is in 'revision_ids'
2349
        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'.
2350
        return all_texts
2351
2352
    def _build_weave(self):
2353
        from bzrlib import weave
2354
        self._weave = weave.Weave(weave_name='in_memory_weave',
2355
                                  allow_reserved=True)
3514.2.5 by John Arbash Meinel
Switch to the get_parent_map design I had settled on.
2356
        parent_map = self._find_recursive_lcas()
2357
2358
        all_texts = self._get_interesting_texts(parent_map)
2359
2360
        # Note: Unfortunately, the order given by topo_sort will effect the
2361
        # ordering resolution in the output. Specifically, if you add A then B,
2362
        # then in the output text A lines will show up before B lines. And, of
2363
        # 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.
2364
        # So we use merge_sort, and add a fake node on the tip.
2365
        # This ensures that left-hand parents will always be inserted into the
2366
        # weave before right-hand parents.
2367
        tip_key = self._key_prefix + (_mod_revision.CURRENT_REVISION,)
2368
        parent_map[tip_key] = (self.a_key, self.b_key)
2369
2370
        for seq_num, key, depth, eom in reversed(tsort.merge_sort(parent_map,
2371
                                                                  tip_key)):
2372
            if key == tip_key:
2373
                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.
2374
        # 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.
2375
            parent_keys = parent_map[key]
2376
            revision_id = key[-1]
2377
            parent_ids = [k[-1] for k in parent_keys]
2378
            self._weave.add_lines(revision_id, parent_ids,
2379
                                  all_texts[revision_id])
3514.2.2 by John Arbash Meinel
Restore a real weave merge to 'bzr merge --weave'.
2380
2381
    def plan_merge(self):
2382
        """Generate a 'plan' for merging the two revisions.
2383
2384
        This involves comparing their texts and determining the cause of
2385
        differences.  If text A has a line and text B does not, then either the
2386
        line was added to text A, or it was deleted from B.  Once the causes
2387
        are combined, they are written out in the format described in
2388
        VersionedFile.plan_merge
2389
        """
2390
        if self._head_key is not None: # There was a single head
2391
            if self._head_key == self.a_key:
2392
                plan = 'new-a'
3062.1.9 by Aaron Bentley
Move PlanMerge into merge and _PlanMergeVersionedFile into versionedfile
2393
            else:
3514.2.2 by John Arbash Meinel
Restore a real weave merge to 'bzr merge --weave'.
2394
                if self._head_key != self.b_key:
2395
                    raise AssertionError('There was an invalid head: %s != %s'
2396
                                         % (self.b_key, self._head_key))
2397
                plan = 'new-b'
3514.2.16 by John Arbash Meinel
Review feedback from Ian.
2398
            head_rev = self._head_key[-1]
2399
            lines = self.get_lines([head_rev])[head_rev]
3514.2.2 by John Arbash Meinel
Restore a real weave merge to 'bzr merge --weave'.
2400
            return ((plan, line) for line in lines)
2401
        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
2402
3144.3.1 by Aaron Bentley
Implement LCA merge, with problematic conflict markers
2403
2404
class _PlanLCAMerge(_PlanMergeBase):
2405
    """
3144.3.7 by Aaron Bentley
Update from review
2406
    This merge algorithm differs from _PlanMerge in that:
3144.3.1 by Aaron Bentley
Implement LCA merge, with problematic conflict markers
2407
    1. comparisons are done against LCAs only
2408
    2. cases where a contested line is new versus one LCA but old versus
3144.3.7 by Aaron Bentley
Update from review
2409
       another are marked as conflicts, by emitting the line as conflicted-a
2410
       or conflicted-b.
3144.3.1 by Aaron Bentley
Implement LCA merge, with problematic conflict markers
2411
2412
    This is faster, and hopefully produces more useful output.
2413
    """
2414
3350.6.10 by Martin Pool
VersionedFiles review cleanups
2415
    def __init__(self, a_rev, b_rev, vf, key_prefix, graph):
2416
        _PlanMergeBase.__init__(self, a_rev, b_rev, vf, key_prefix)
2417
        lcas = graph.find_lca(key_prefix + (a_rev,), key_prefix + (b_rev,))
3350.6.5 by Robert Collins
Update to bzr.dev.
2418
        self.lcas = set()
2419
        for lca in lcas:
4721.3.1 by Vincent Ladeuil
Cleanup imports.
2420
            if lca == _mod_revision.NULL_REVISION:
3350.6.5 by Robert Collins
Update to bzr.dev.
2421
                self.lcas.add(lca)
2422
            else:
2423
                self.lcas.add(lca[-1])
3144.3.7 by Aaron Bentley
Update from review
2424
        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.
2425
            if _mod_revision.is_null(lca):
2426
                lca_lines = []
2427
            else:
3350.6.5 by Robert Collins
Update to bzr.dev.
2428
                lca_lines = self.get_lines([lca])[lca]
3144.3.7 by Aaron Bentley
Update from review
2429
            matcher = patiencediff.PatienceSequenceMatcher(None, self.lines_a,
2430
                                                           lca_lines)
2431
            blocks = list(matcher.get_matching_blocks())
2432
            self._cached_matching_blocks[(a_rev, lca)] = blocks
2433
            matcher = patiencediff.PatienceSequenceMatcher(None, self.lines_b,
2434
                                                           lca_lines)
2435
            blocks = list(matcher.get_matching_blocks())
2436
            self._cached_matching_blocks[(b_rev, lca)] = blocks
3144.3.1 by Aaron Bentley
Implement LCA merge, with problematic conflict markers
2437
3144.3.7 by Aaron Bentley
Update from review
2438
    def _determine_status(self, revision_id, unique_line_numbers):
3144.3.1 by Aaron Bentley
Implement LCA merge, with problematic conflict markers
2439
        """Determines the status unique lines versus all lcas.
2440
2441
        Basically, determines why the line is unique to this revision.
2442
2443
        A line may be determined new, killed, or both.
2444
3144.3.7 by Aaron Bentley
Update from review
2445
        If a line is determined new, that means it was not present in at least
2446
        one LCA, and is not present in the other merge revision.
3144.3.1 by Aaron Bentley
Implement LCA merge, with problematic conflict markers
2447
2448
        If a line is determined killed, that means the line was present in
2449
        at least one LCA.
2450
2451
        If a line is killed and new, this indicates that the two merge
2452
        revisions contain differing conflict resolutions.
3144.3.7 by Aaron Bentley
Update from review
2453
        :param revision_id: The id of the revision in which the lines are
2454
            unique
2455
        :param unique_line_numbers: The line numbers of unique lines.
3144.3.1 by Aaron Bentley
Implement LCA merge, with problematic conflict markers
2456
        :return a tuple of (new_this, killed_other):
2457
        """
2458
        new = set()
2459
        killed = set()
3144.3.7 by Aaron Bentley
Update from review
2460
        unique_line_numbers = set(unique_line_numbers)
3144.3.1 by Aaron Bentley
Implement LCA merge, with problematic conflict markers
2461
        for lca in self.lcas:
2462
            blocks = self._get_matching_blocks(revision_id, lca)
2463
            unique_vs_lca, _ignored = self._unique_lines(blocks)
3144.3.7 by Aaron Bentley
Update from review
2464
            new.update(unique_line_numbers.intersection(unique_vs_lca))
2465
            killed.update(unique_line_numbers.difference(unique_vs_lca))
3144.3.1 by Aaron Bentley
Implement LCA merge, with problematic conflict markers
2466
        return new, killed