/brz/remove-bazaar

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