1
# Copyright (C) 2005, 2006 Canonical Ltd
1
# Copyright (C) 2005 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24
import bzrlib.revision
25
from bzrlib.merge_core import merge_flex, ApplyMerge3, BackupBeforeChange
26
from bzrlib.changeset import generate_changeset, ExceptionConflictHandler
27
from bzrlib.changeset import Inventory, Diff3Merge
26
28
from bzrlib.branch import Branch
27
from bzrlib.conflicts import ConflictList, Conflict
28
from bzrlib.errors import (BzrCommandError,
38
WorkingTreeNotRevision,
41
from bzrlib.merge3 import Merge3
42
from bzrlib.osutils import rename, pathjoin
43
from progress import DummyProgress, ProgressPhase
44
from bzrlib.revision import common_ancestor, is_ancestor, NULL_REVISION
45
from bzrlib.textfile import check_text_lines
46
from bzrlib.trace import mutter, warning, note
47
from bzrlib.transform import (TreeTransform, resolve_conflicts, cook_conflicts,
48
FinalPaths, create_by_entry, unique_add,
50
from bzrlib.versionedfile import WeaveMerge
53
# TODO: Report back as changes are merged in
55
def _get_tree(treespec, local_branch=None):
56
from bzrlib import workingtree
29
from bzrlib.errors import BzrCommandError, UnrelatedBranches, NoCommonAncestor
30
from bzrlib.errors import NoCommits
31
from bzrlib.delta import compare_trees
32
from bzrlib.trace import mutter, warning
33
from bzrlib.fetch import greedy_fetch, fetch
34
from bzrlib.revision import is_ancestor
35
from bzrlib.osutils import rename
36
from bzrlib.revision import common_ancestor, MultipleRevisionSources
37
from bzrlib.errors import NoSuchRevision
39
# TODO: build_working_dir can be built on something simpler than merge()
41
# FIXME: merge() parameters seem oriented towards the command line
43
# comments from abentley on irc: merge happens in two stages, each
44
# of which generates a changeset object
46
# stage 1: generate OLD->OTHER,
47
# stage 2: use MINE and OLD->OTHER to generate MINE -> RESULT
49
class MergeConflictHandler(ExceptionConflictHandler):
50
"""Handle conflicts encountered while merging.
52
This subclasses ExceptionConflictHandler, so that any types of
53
conflict that are not explicitly handled cause an exception and
56
def __init__(self, ignore_zero=False):
57
ExceptionConflictHandler.__init__(self)
59
self.ignore_zero = ignore_zero
61
def copy(self, source, dest):
62
"""Copy the text and mode of a file
63
:param source: The path of the file to copy
64
:param dest: The distination file to create
66
s_file = file(source, "rb")
67
d_file = file(dest, "wb")
70
os.chmod(dest, 0777 & os.stat(source).st_mode)
72
def dump(self, lines, dest):
73
"""Copy the text and mode of a file
74
:param source: The path of the file to copy
75
:param dest: The distination file to create
77
d_file = file(dest, "wb")
81
def add_suffix(self, name, suffix, last_new_name=None):
82
"""Rename a file to append a suffix. If the new name exists, the
83
suffix is added repeatedly until a non-existant name is found
85
:param name: The path of the file
86
:param suffix: The suffix to append
87
:param last_new_name: (used for recursive calls) the last name tried
89
if last_new_name is None:
91
new_name = last_new_name+suffix
93
rename(name, new_name)
96
if e.errno != errno.EEXIST and e.errno != errno.ENOTEMPTY:
98
return self.add_suffix(name, suffix, last_new_name=new_name)
100
def conflict(self, text):
105
def merge_conflict(self, new_file, this_path, base_lines, other_lines):
107
Handle diff3 conflicts by producing a .THIS, .BASE and .OTHER. The
108
main file will be a version with diff3 conflicts.
109
:param new_file: Path to the output file with diff3 markers
110
:param this_path: Path to the file text for the THIS tree
111
:param base_path: Path to the file text for the BASE tree
112
:param other_path: Path to the file text for the OTHER tree
114
self.add_suffix(this_path, ".THIS")
115
self.dump(base_lines, this_path+".BASE")
116
self.dump(other_lines, this_path+".OTHER")
117
rename(new_file, this_path)
118
self.conflict("Diff3 conflict encountered in %s" % this_path)
120
def new_contents_conflict(self, filename, other_contents):
121
"""Conflicting contents for newly added file."""
122
self.copy(other_contents, filename + ".OTHER")
123
self.conflict("Conflict in newly added file %s" % filename)
126
def target_exists(self, entry, target, old_path):
127
"""Handle the case when the target file or dir exists"""
128
moved_path = self.add_suffix(target, ".moved")
129
self.conflict("Moved existing %s to %s" % (target, moved_path))
131
def rmdir_non_empty(self, filename):
132
"""Handle the case where the dir to be removed still has contents"""
133
self.conflict("Directory %s not removed because it is not empty"\
138
if not self.ignore_zero:
139
print "%d conflicts encountered.\n" % self.conflicts
141
def get_tree(treespec, temp_root, label, local_branch=None):
57
142
location, revno = treespec
143
branch = Branch.open_containing(location)
59
tree = workingtree.WorkingTree.open_containing(location)[0]
60
return tree.branch, tree
61
branch = Branch.open_containing(location)[0]
63
147
revision = branch.last_revision()
65
149
revision = branch.get_rev_id(revno)
67
revision = NULL_REVISION
68
return branch, _get_revid_tree(branch, revision, local_branch)
71
def _get_revid_tree(branch, revision, local_branch):
150
return branch, get_revid_tree(branch, revision, temp_root, label,
153
def get_revid_tree(branch, revision, temp_root, label, local_branch):
72
154
if revision is None:
73
base_tree = branch.bzrdir.open_workingtree()
155
base_tree = branch.working_tree()
75
157
if local_branch is not None:
76
if local_branch.base != branch.base:
77
local_branch.fetch(branch, revision)
78
base_tree = local_branch.repository.revision_tree(revision)
158
greedy_fetch(local_branch, branch, revision)
159
base_tree = local_branch.revision_tree(revision)
80
base_tree = branch.repository.revision_tree(revision)
84
def transform_tree(from_tree, to_tree, interesting_ids=None):
85
merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
86
interesting_ids=interesting_ids, this_tree=from_tree)
90
def __init__(self, this_branch, other_tree=None, base_tree=None,
91
this_tree=None, pb=DummyProgress(), change_reporter=None):
161
base_tree = branch.revision_tree(revision)
162
temp_path = os.path.join(temp_root, label)
164
return MergeTree(base_tree, temp_path)
167
def file_exists(tree, file_id):
168
return tree.has_filename(tree.id2path(file_id))
171
class MergeTree(object):
172
def __init__(self, tree, tempdir):
92
173
object.__init__(self)
93
assert this_tree is not None, "this_tree is required"
94
self.this_branch = this_branch
95
self.this_basis = this_branch.last_revision()
96
self.this_rev_id = None
97
self.this_tree = this_tree
98
self.this_revision_tree = None
99
self.this_basis_tree = None
100
self.other_tree = other_tree
101
self.base_tree = base_tree
102
self.ignore_zero = False
103
self.backup_files = False
104
self.interesting_ids = None
105
self.show_base = False
106
self.reprocess = False
109
self.change_reporter = change_reporter
111
def revision_tree(self, revision_id):
112
return self.this_branch.repository.revision_tree(revision_id)
114
def ensure_revision_trees(self):
115
if self.this_revision_tree is None:
116
self.this_basis_tree = self.this_branch.repository.revision_tree(
118
if self.this_basis == self.this_rev_id:
119
self.this_revision_tree = self.this_basis_tree
121
if self.other_rev_id is None:
122
other_basis_tree = self.revision_tree(self.other_basis)
123
changes = other_basis_tree.changes_from(self.other_tree)
174
if hasattr(tree, "basedir"):
175
self.root = tree.basedir
179
self.tempdir = tempdir
180
os.mkdir(os.path.join(self.tempdir, "texts"))
184
return self.tree.__iter__()
186
def __contains__(self, file_id):
187
return file_id in self.tree
189
def get_file(self, file_id):
190
return self.tree.get_file(file_id)
192
def get_file_sha1(self, id):
193
return self.tree.get_file_sha1(id)
195
def id2path(self, file_id):
196
return self.tree.id2path(file_id)
198
def has_id(self, file_id):
199
return self.tree.has_id(file_id)
201
def has_or_had_id(self, file_id):
202
if file_id == self.tree.inventory.root.file_id:
204
return self.tree.inventory.has_id(file_id)
206
def has_or_had_id(self, file_id):
207
if file_id == self.tree.inventory.root.file_id:
209
return self.tree.inventory.has_id(file_id)
211
def readonly_path(self, id):
212
if id not in self.tree:
214
if self.root is not None:
215
return self.tree.abspath(self.tree.id2path(id))
217
if self.tree.inventory[id].kind in ("directory", "root_directory"):
219
if not self.cached.has_key(id):
220
path = os.path.join(self.tempdir, "texts", id)
221
outfile = file(path, "wb")
222
outfile.write(self.tree.get_file(id).read())
223
assert(os.path.exists(path))
224
self.cached[id] = path
225
return self.cached[id]
228
def build_working_dir(to_dir):
229
"""Build a working directory in an empty directory.
231
to_dir is a directory containing branch metadata but no working files,
232
typically constructed by cloning an existing branch.
234
This is split out as a special idiomatic case of merge. It could
235
eventually be done by just building the tree directly calling into
236
lower-level code (e.g. constructing a changeset).
238
merge((to_dir, -1), (to_dir, 0), this_dir=to_dir,
239
check_clean=False, ignore_zero=True)
242
def merge(other_revision, base_revision,
243
check_clean=True, ignore_zero=False,
244
this_dir=None, backup_files=False, merge_type=ApplyMerge3,
246
"""Merge changes into a tree.
249
tuple(path, revision) Base for three-way merge.
251
tuple(path, revision) Other revision for three-way merge.
253
Directory to merge changes into; '.' by default.
255
If true, this_dir must have no uncommitted changes before the
257
ignore_zero - If true, suppress the "zero conflicts" message when
258
there are no conflicts; should be set when doing something we expect
259
to complete perfectly.
261
All available ancestors of other_revision and base_revision are
262
automatically pulled into the branch.
264
tempdir = tempfile.mkdtemp(prefix="bzr-")
268
this_branch = Branch.open_containing(this_dir)
269
this_rev_id = this_branch.last_revision()
270
if this_rev_id is None:
271
raise BzrCommandError("This branch has no commits")
273
changes = compare_trees(this_branch.working_tree(),
274
this_branch.basis_tree(), False)
124
275
if changes.has_changed():
125
raise WorkingTreeNotRevision(self.this_tree)
126
other_rev_id = self.other_basis
127
self.other_tree = other_basis_tree
129
def file_revisions(self, file_id):
130
self.ensure_revision_trees()
131
def get_id(tree, file_id):
132
revision_id = tree.inventory[file_id].revision
133
assert revision_id is not None
135
if self.this_rev_id is None:
136
if self.this_basis_tree.get_file_sha1(file_id) != \
137
self.this_tree.get_file_sha1(file_id):
138
raise WorkingTreeNotRevision(self.this_tree)
140
trees = (self.this_basis_tree, self.other_tree)
141
return [get_id(tree, file_id) for tree in trees]
143
def check_basis(self, check_clean, require_commits=True):
144
if self.this_basis is None and require_commits is True:
145
raise BzrCommandError("This branch has no commits."
146
" (perhaps you would prefer 'bzr pull')")
149
if self.this_basis != self.this_rev_id:
150
276
raise BzrCommandError("Working tree has uncommitted changes.")
152
def compare_basis(self):
153
changes = self.this_tree.changes_from(self.this_tree.basis_tree())
154
if not changes.has_changed():
155
self.this_rev_id = self.this_basis
157
def set_interesting_files(self, file_list):
159
self._set_interesting_files(file_list)
160
except NotVersionedError, e:
161
raise BzrCommandError("%s is not a source file in any"
164
def _set_interesting_files(self, file_list):
165
"""Set the list of interesting ids from a list of files."""
166
if file_list is None:
167
self.interesting_ids = None
170
interesting_ids = set()
171
for path in file_list:
173
for tree in (self.this_tree, self.base_tree, self.other_tree):
174
file_id = tree.inventory.path2id(path)
175
if file_id is not None:
176
interesting_ids.add(file_id)
179
raise NotVersionedError(path=path)
180
self.interesting_ids = interesting_ids
182
def set_pending(self):
183
if not self.base_is_ancestor:
185
if self.other_rev_id is None:
187
ancestry = self.this_branch.repository.get_ancestry(self.this_basis)
188
if self.other_rev_id in ancestry:
190
self.this_tree.add_parent_tree((self.other_rev_id, self.other_tree))
192
def set_other(self, other_revision):
193
"""Set the revision and tree to merge from.
195
This sets the other_tree, other_rev_id, other_basis attributes.
197
:param other_revision: The [path, revision] list to merge from.
199
other_branch, self.other_tree = _get_tree(other_revision,
277
other_branch, other_tree = get_tree(other_revision, tempdir, "other",
201
279
if other_revision[1] == -1:
202
self.other_rev_id = other_branch.last_revision()
203
if self.other_rev_id is None:
280
other_rev_id = other_branch.last_revision()
281
if other_rev_id is None:
204
282
raise NoCommits(other_branch)
205
self.other_basis = self.other_rev_id
283
other_basis = other_rev_id
206
284
elif other_revision[1] is not None:
207
self.other_rev_id = other_branch.get_rev_id(other_revision[1])
208
self.other_basis = self.other_rev_id
285
other_rev_id = other_branch.get_rev_id(other_revision[1])
286
other_basis = other_rev_id
210
self.other_rev_id = None
211
self.other_basis = other_branch.last_revision()
212
if self.other_basis is None:
289
other_basis = other_branch.last_revision()
290
if other_basis is None:
213
291
raise NoCommits(other_branch)
214
if other_branch.base != self.this_branch.base:
215
self.this_branch.fetch(other_branch, last_revision=self.other_basis)
218
self.set_base([None, None])
220
def set_base(self, base_revision):
221
"""Set the base revision to use for the merge.
223
:param base_revision: A 2-list containing a path and revision number.
225
mutter("doing merge() with no base_revision specified")
226
292
if base_revision == [None, None]:
228
pb = ui.ui_factory.nested_progress_bar()
230
this_repo = self.this_branch.repository
231
self.base_rev_id = common_ancestor(self.this_basis,
294
base_rev_id = common_ancestor(this_rev_id, other_basis,
236
296
except NoCommonAncestor:
237
297
raise UnrelatedBranches()
238
self.base_tree = _get_revid_tree(self.this_branch, self.base_rev_id,
240
self.base_is_ancestor = True
298
base_tree = get_revid_tree(this_branch, base_rev_id, tempdir,
300
base_is_ancestor = True
242
base_branch, self.base_tree = _get_tree(base_revision)
302
base_branch, base_tree = get_tree(base_revision, tempdir, "base")
243
303
if base_revision[1] == -1:
244
self.base_rev_id = base_branch.last_revision()
304
base_rev_id = base_branch.last_revision()
245
305
elif base_revision[1] is None:
246
self.base_rev_id = None
248
self.base_rev_id = base_branch.get_rev_id(base_revision[1])
249
if self.this_branch.base != base_branch.base:
250
self.this_branch.fetch(base_branch)
251
self.base_is_ancestor = is_ancestor(self.this_basis,
256
kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
257
'other_tree': self.other_tree,
258
'interesting_ids': self.interesting_ids,
260
if self.merge_type.requires_base:
261
kwargs['base_tree'] = self.base_tree
262
if self.merge_type.supports_reprocess:
263
kwargs['reprocess'] = self.reprocess
265
raise BzrError("Conflict reduction is not supported for merge"
266
" type %s." % self.merge_type)
267
if self.merge_type.supports_show_base:
268
kwargs['show_base'] = self.show_base
270
raise BzrError("Showing base is not supported for this"
271
" merge type. %s" % self.merge_type)
272
self.this_tree.lock_tree_write()
273
if self.base_tree is not None:
274
self.base_tree.lock_read()
275
if self.other_tree is not None:
276
self.other_tree.lock_read()
278
merge = self.merge_type(pb=self._pb,
279
change_reporter=self.change_reporter,
282
if self.other_tree is not None:
283
self.other_tree.unlock()
284
if self.base_tree is not None:
285
self.base_tree.unlock()
286
self.this_tree.unlock()
287
if len(merge.cooked_conflicts) == 0:
288
if not self.ignore_zero:
289
note("All changes applied successfully.")
291
note("%d conflicts encountered." % len(merge.cooked_conflicts))
293
return len(merge.cooked_conflicts)
295
def regen_inventory(self, new_entries):
296
old_entries = self.this_tree.read_working_inventory()
300
for path, file_id in new_entries:
303
new_entries_map[file_id] = path
305
def id2path(file_id):
306
path = new_entries_map.get(file_id)
309
entry = old_entries[file_id]
310
if entry.parent_id is None:
312
return pathjoin(id2path(entry.parent_id), entry.name)
314
for file_id in old_entries:
315
entry = old_entries[file_id]
316
path = id2path(file_id)
317
if file_id in self.base_tree.inventory:
318
executable = getattr(self.base_tree.inventory[file_id], 'executable', False)
320
executable = getattr(entry, 'executable', False)
321
new_inventory[file_id] = (path, file_id, entry.parent_id,
322
entry.kind, executable)
324
by_path[path] = file_id
329
for path, file_id in new_entries:
331
del new_inventory[file_id]
334
new_path_list.append((path, file_id))
335
if file_id not in old_entries:
337
# Ensure no file is added before its parent
339
for path, file_id in new_path_list:
343
parent = by_path[os.path.dirname(path)]
344
abspath = pathjoin(self.this_tree.basedir, path)
345
kind = osutils.file_kind(abspath)
346
if file_id in self.base_tree.inventory:
347
executable = getattr(self.base_tree.inventory[file_id], 'executable', False)
350
new_inventory[file_id] = (path, file_id, parent, kind, executable)
351
by_path[path] = file_id
353
# Get a list in insertion order
354
new_inventory_list = new_inventory.values()
355
mutter ("""Inventory regeneration:
356
old length: %i insertions: %i deletions: %i new_length: %i"""\
357
% (len(old_entries), insertions, deletions,
358
len(new_inventory_list)))
359
assert len(new_inventory_list) == len(old_entries) + insertions\
361
new_inventory_list.sort()
362
return new_inventory_list
365
class Merge3Merger(object):
366
"""Three-way merger that uses the merge3 text merger"""
368
supports_reprocess = True
369
supports_show_base = True
370
history_based = False
372
def __init__(self, working_tree, this_tree, base_tree, other_tree,
373
interesting_ids=None, reprocess=False, show_base=False,
374
pb=DummyProgress(), pp=None, change_reporter=None):
375
"""Initialize the merger object and perform the merge."""
376
object.__init__(self)
377
self.this_tree = working_tree
378
self.base_tree = base_tree
379
self.other_tree = other_tree
380
self._raw_conflicts = []
381
self.cooked_conflicts = []
382
self.reprocess = reprocess
383
self.show_base = show_base
386
self.change_reporter = change_reporter
388
self.pp = ProgressPhase("Merge phase", 3, self.pb)
390
if interesting_ids is not None:
391
all_ids = interesting_ids
393
all_ids = set(base_tree)
394
all_ids.update(other_tree)
395
working_tree.lock_tree_write()
396
self.tt = TreeTransform(working_tree, self.pb)
399
child_pb = ui.ui_factory.nested_progress_bar()
401
for num, file_id in enumerate(all_ids):
402
child_pb.update('Preparing file merge', num, len(all_ids))
403
self.merge_names(file_id)
404
file_status = self.merge_contents(file_id)
405
self.merge_executable(file_id, file_status)
410
child_pb = ui.ui_factory.nested_progress_bar()
412
fs_conflicts = resolve_conflicts(self.tt, child_pb)
415
if change_reporter is not None:
416
from bzrlib import delta
417
delta.report_changes(self.tt._iter_changes(), change_reporter)
418
self.cook_conflicts(fs_conflicts)
419
for conflict in self.cooked_conflicts:
422
results = self.tt.apply()
423
self.write_modified(results)
425
working_tree.add_conflicts(self.cooked_conflicts)
426
except UnsupportedOperation:
430
working_tree.unlock()
435
self.tt.final_kind(self.tt.root)
437
self.tt.cancel_deletion(self.tt.root)
438
if self.tt.final_file_id(self.tt.root) is None:
439
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
441
if self.other_tree.inventory.root is None:
443
other_root_file_id = self.other_tree.inventory.root.file_id
444
other_root = self.tt.trans_id_file_id(other_root_file_id)
445
if other_root == self.tt.root:
448
self.tt.final_kind(other_root)
451
self.reparent_children(self.other_tree.inventory.root, self.tt.root)
452
self.tt.cancel_creation(other_root)
453
self.tt.cancel_versioning(other_root)
455
def reparent_children(self, ie, target):
456
for thing, child in ie.children.iteritems():
457
trans_id = self.tt.trans_id_file_id(child.file_id)
458
self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
460
def write_modified(self, results):
462
for path in results.modified_paths:
463
file_id = self.this_tree.path2id(self.this_tree.relpath(path))
466
hash = self.this_tree.get_file_sha1(file_id)
469
modified_hashes[file_id] = hash
470
self.this_tree.set_merge_modified(modified_hashes)
473
def parent(entry, file_id):
474
"""Determine the parent for a file_id (used as a key method)"""
477
return entry.parent_id
480
def name(entry, file_id):
481
"""Determine the name for a file_id (used as a key method)"""
487
def contents_sha1(tree, file_id):
488
"""Determine the sha1 of the file contents (used as a key method)."""
489
if file_id not in tree:
491
return tree.get_file_sha1(file_id)
494
def executable(tree, file_id):
495
"""Determine the executability of a file-id (used as a key method)."""
496
if file_id not in tree:
498
if tree.kind(file_id) != "file":
500
return tree.is_executable(file_id)
503
def kind(tree, file_id):
504
"""Determine the kind of a file-id (used as a key method)."""
505
if file_id not in tree:
507
return tree.kind(file_id)
510
def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
511
"""Do a three-way test on a scalar.
512
Return "this", "other" or "conflict", depending whether a value wins.
514
key_base = key(base_tree, file_id)
515
key_other = key(other_tree, file_id)
516
#if base == other, either they all agree, or only THIS has changed.
517
if key_base == key_other:
519
key_this = key(this_tree, file_id)
520
if key_this not in (key_base, key_other):
522
# "Ambiguous clean merge"
523
elif key_this == key_other:
526
assert key_this == key_base
529
def merge_names(self, file_id):
530
"""Perform a merge on file_id names and parents"""
532
if file_id in tree.inventory:
533
return tree.inventory[file_id]
536
this_entry = get_entry(self.this_tree)
537
other_entry = get_entry(self.other_tree)
538
base_entry = get_entry(self.base_tree)
539
name_winner = self.scalar_three_way(this_entry, base_entry,
540
other_entry, file_id, self.name)
541
parent_id_winner = self.scalar_three_way(this_entry, base_entry,
542
other_entry, file_id,
544
if this_entry is None:
545
if name_winner == "this":
546
name_winner = "other"
547
if parent_id_winner == "this":
548
parent_id_winner = "other"
549
if name_winner == "this" and parent_id_winner == "this":
551
if name_winner == "conflict":
552
trans_id = self.tt.trans_id_file_id(file_id)
553
self._raw_conflicts.append(('name conflict', trans_id,
554
self.name(this_entry, file_id),
555
self.name(other_entry, file_id)))
556
if parent_id_winner == "conflict":
557
trans_id = self.tt.trans_id_file_id(file_id)
558
self._raw_conflicts.append(('parent conflict', trans_id,
559
self.parent(this_entry, file_id),
560
self.parent(other_entry, file_id)))
561
if other_entry is None:
562
# it doesn't matter whether the result was 'other' or
563
# 'conflict'-- if there's no 'other', we leave it alone.
565
# if we get here, name_winner and parent_winner are set to safe values.
566
winner_entry = {"this": this_entry, "other": other_entry,
567
"conflict": other_entry}
568
trans_id = self.tt.trans_id_file_id(file_id)
569
parent_id = winner_entry[parent_id_winner].parent_id
570
if parent_id is not None:
571
parent_trans_id = self.tt.trans_id_file_id(parent_id)
572
self.tt.adjust_path(winner_entry[name_winner].name,
573
parent_trans_id, trans_id)
575
def merge_contents(self, file_id):
576
"""Performa a merge on file_id contents."""
577
def contents_pair(tree):
578
if file_id not in tree:
580
kind = tree.kind(file_id)
582
contents = tree.get_file_sha1(file_id)
583
elif kind == "symlink":
584
contents = tree.get_symlink_target(file_id)
587
return kind, contents
589
def contents_conflict():
590
trans_id = self.tt.trans_id_file_id(file_id)
591
name = self.tt.final_name(trans_id)
592
parent_id = self.tt.final_parent(trans_id)
593
if file_id in self.this_tree.inventory:
594
self.tt.unversion_file(trans_id)
595
if file_id in self.this_tree:
596
self.tt.delete_contents(trans_id)
597
file_group = self._dump_conflicts(name, parent_id, file_id,
599
self._raw_conflicts.append(('contents conflict', file_group))
601
# See SPOT run. run, SPOT, run.
602
# So we're not QUITE repeating ourselves; we do tricky things with
604
base_pair = contents_pair(self.base_tree)
605
other_pair = contents_pair(self.other_tree)
606
if base_pair == other_pair:
607
# OTHER introduced no changes
609
this_pair = contents_pair(self.this_tree)
610
if this_pair == other_pair:
611
# THIS and OTHER introduced the same changes
614
trans_id = self.tt.trans_id_file_id(file_id)
615
if this_pair == base_pair:
616
# only OTHER introduced changes
617
if file_id in self.this_tree:
618
# Remove any existing contents
619
self.tt.delete_contents(trans_id)
620
if file_id in self.other_tree:
621
# OTHER changed the file
622
create_by_entry(self.tt,
623
self.other_tree.inventory[file_id],
624
self.other_tree, trans_id)
625
if file_id not in self.this_tree.inventory:
626
self.tt.version_file(file_id, trans_id)
628
elif file_id in self.this_tree.inventory:
629
# OTHER deleted the file
630
self.tt.unversion_file(trans_id)
632
#BOTH THIS and OTHER introduced changes; scalar conflict
633
elif this_pair[0] == "file" and other_pair[0] == "file":
634
# THIS and OTHER are both files, so text merge. Either
635
# BASE is a file, or both converted to files, so at least we
636
# have agreement that output should be a file.
638
self.text_merge(file_id, trans_id)
640
return contents_conflict()
641
if file_id not in self.this_tree.inventory:
642
self.tt.version_file(file_id, trans_id)
644
self.tt.tree_kind(trans_id)
645
self.tt.delete_contents(trans_id)
650
# Scalar conflict, can't text merge. Dump conflicts
651
return contents_conflict()
653
def get_lines(self, tree, file_id):
654
"""Return the lines in a file, or an empty list."""
656
return tree.get_file(file_id).readlines()
660
def text_merge(self, file_id, trans_id):
661
"""Perform a three-way text merge on a file_id"""
662
# it's possible that we got here with base as a different type.
663
# if so, we just want two-way text conflicts.
664
if file_id in self.base_tree and \
665
self.base_tree.kind(file_id) == "file":
666
base_lines = self.get_lines(self.base_tree, file_id)
669
other_lines = self.get_lines(self.other_tree, file_id)
670
this_lines = self.get_lines(self.this_tree, file_id)
671
m3 = Merge3(base_lines, this_lines, other_lines)
672
start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
673
if self.show_base is True:
674
base_marker = '|' * 7
678
def iter_merge3(retval):
679
retval["text_conflicts"] = False
680
for line in m3.merge_lines(name_a = "TREE",
681
name_b = "MERGE-SOURCE",
682
name_base = "BASE-REVISION",
683
start_marker=start_marker,
684
base_marker=base_marker,
685
reprocess=self.reprocess):
686
if line.startswith(start_marker):
687
retval["text_conflicts"] = True
688
yield line.replace(start_marker, '<' * 7)
692
merge3_iterator = iter_merge3(retval)
693
self.tt.create_file(merge3_iterator, trans_id)
694
if retval["text_conflicts"] is True:
695
self._raw_conflicts.append(('text conflict', trans_id))
696
name = self.tt.final_name(trans_id)
697
parent_id = self.tt.final_parent(trans_id)
698
file_group = self._dump_conflicts(name, parent_id, file_id,
699
this_lines, base_lines,
701
file_group.append(trans_id)
703
def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
704
base_lines=None, other_lines=None, set_version=False,
706
"""Emit conflict files.
707
If this_lines, base_lines, or other_lines are omitted, they will be
708
determined automatically. If set_version is true, the .OTHER, .THIS
709
or .BASE (in that order) will be created as versioned files.
711
data = [('OTHER', self.other_tree, other_lines),
712
('THIS', self.this_tree, this_lines)]
714
data.append(('BASE', self.base_tree, base_lines))
717
for suffix, tree, lines in data:
719
trans_id = self._conflict_file(name, parent_id, tree, file_id,
721
file_group.append(trans_id)
722
if set_version and not versioned:
723
self.tt.version_file(file_id, trans_id)
727
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
729
"""Emit a single conflict file."""
730
name = name + '.' + suffix
731
trans_id = self.tt.create_path(name, parent_id)
732
entry = tree.inventory[file_id]
733
create_by_entry(self.tt, entry, tree, trans_id, lines)
736
def merge_executable(self, file_id, file_status):
737
"""Perform a merge on the execute bit."""
738
if file_status == "deleted":
740
trans_id = self.tt.trans_id_file_id(file_id)
742
if self.tt.final_kind(trans_id) != "file":
746
winner = self.scalar_three_way(self.this_tree, self.base_tree,
747
self.other_tree, file_id,
749
if winner == "conflict":
750
# There must be a None in here, if we have a conflict, but we
751
# need executability since file status was not deleted.
752
if self.executable(self.other_tree, file_id) is None:
757
if file_status == "modified":
758
executability = self.this_tree.is_executable(file_id)
759
if executability is not None:
760
trans_id = self.tt.trans_id_file_id(file_id)
761
self.tt.set_executability(executability, trans_id)
763
assert winner == "other"
764
if file_id in self.other_tree:
765
executability = self.other_tree.is_executable(file_id)
766
elif file_id in self.this_tree:
767
executability = self.this_tree.is_executable(file_id)
768
elif file_id in self.base_tree:
769
executability = self.base_tree.is_executable(file_id)
770
if executability is not None:
771
trans_id = self.tt.trans_id_file_id(file_id)
772
self.tt.set_executability(executability, trans_id)
774
def cook_conflicts(self, fs_conflicts):
775
"""Convert all conflicts into a form that doesn't depend on trans_id"""
776
from conflicts import Conflict
778
self.cooked_conflicts.extend(cook_conflicts(fs_conflicts, self.tt))
779
fp = FinalPaths(self.tt)
780
for conflict in self._raw_conflicts:
781
conflict_type = conflict[0]
782
if conflict_type in ('name conflict', 'parent conflict'):
783
trans_id = conflict[1]
784
conflict_args = conflict[2:]
785
if trans_id not in name_conflicts:
786
name_conflicts[trans_id] = {}
787
unique_add(name_conflicts[trans_id], conflict_type,
789
if conflict_type == 'contents conflict':
790
for trans_id in conflict[1]:
791
file_id = self.tt.final_file_id(trans_id)
308
base_rev_id = base_branch.get_rev_id(base_revision[1])
309
fetch(from_branch=base_branch, to_branch=this_branch)
310
base_is_ancestor = is_ancestor(this_rev_id, base_rev_id,
312
if file_list is None:
313
interesting_ids = None
315
interesting_ids = set()
316
this_tree = this_branch.working_tree()
317
for fname in file_list:
318
path = this_branch.relpath(fname)
320
for tree in (this_tree, base_tree.tree, other_tree.tree):
321
file_id = tree.inventory.path2id(path)
792
322
if file_id is not None:
794
path = fp.get_path(trans_id)
795
for suffix in ('.BASE', '.THIS', '.OTHER'):
796
if path.endswith(suffix):
797
path = path[:-len(suffix)]
799
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
800
self.cooked_conflicts.append(c)
801
if conflict_type == 'text conflict':
802
trans_id = conflict[1]
803
path = fp.get_path(trans_id)
804
file_id = self.tt.final_file_id(trans_id)
805
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
806
self.cooked_conflicts.append(c)
808
for trans_id, conflicts in name_conflicts.iteritems():
810
this_parent, other_parent = conflicts['parent conflict']
811
assert this_parent != other_parent
813
this_parent = other_parent = \
814
self.tt.final_file_id(self.tt.final_parent(trans_id))
816
this_name, other_name = conflicts['name conflict']
817
assert this_name != other_name
819
this_name = other_name = self.tt.final_name(trans_id)
820
other_path = fp.get_path(trans_id)
821
if this_parent is not None:
823
fp.get_path(self.tt.trans_id_file_id(this_parent))
824
this_path = pathjoin(this_parent_path, this_name)
323
interesting_ids.add(file_id)
326
raise BzrCommandError("%s is not a source file in any"
328
merge_inner(this_branch, other_tree, base_tree, tempdir,
329
ignore_zero=ignore_zero, backup_files=backup_files,
330
merge_type=merge_type, interesting_ids=interesting_ids)
331
if base_is_ancestor and other_rev_id is not None\
332
and other_rev_id not in this_branch.revision_history():
333
this_branch.add_pending_merge(other_rev_id)
335
shutil.rmtree(tempdir)
338
def set_interesting(inventory_a, inventory_b, interesting_ids):
339
"""Mark files whose ids are in interesting_ids as interesting
341
for inventory in (inventory_a, inventory_b):
342
for path, source_file in inventory.iteritems():
343
source_file.interesting = source_file.id in interesting_ids
346
def generate_cset_optimized(tree_a, tree_b, interesting_ids=None):
347
"""Generate a changeset. If interesting_ids is supplied, only changes
348
to those files will be shown. Metadata changes are stripped.
350
cset = generate_changeset(tree_a, tree_b, interesting_ids)
351
for entry in cset.entries.itervalues():
352
entry.metadata_change = None
356
def merge_inner(this_branch, other_tree, base_tree, tempdir,
357
ignore_zero=False, merge_type=ApplyMerge3, backup_files=False,
358
interesting_ids=None):
360
def merge_factory(file_id, base, other):
361
contents_change = merge_type(file_id, base, other)
363
contents_change = BackupBeforeChange(contents_change)
364
return contents_change
366
this_tree = get_tree((this_branch.base, None), tempdir, "this")[1]
368
def get_inventory(tree):
369
return tree.tree.inventory
371
inv_changes = merge_flex(this_tree, base_tree, other_tree,
372
generate_cset_optimized, get_inventory,
373
MergeConflictHandler(ignore_zero=ignore_zero),
374
merge_factory=merge_factory,
375
interesting_ids=interesting_ids)
378
for id, path in inv_changes.iteritems():
826
this_path = "<deleted>"
827
file_id = self.tt.final_file_id(trans_id)
828
c = Conflict.factory('path conflict', path=this_path,
829
conflict_path=other_path, file_id=file_id)
830
self.cooked_conflicts.append(c)
831
self.cooked_conflicts.sort(key=Conflict.sort_key)
834
class WeaveMerger(Merge3Merger):
835
"""Three-way tree merger, text weave merger."""
836
supports_reprocess = True
837
supports_show_base = False
839
def __init__(self, working_tree, this_tree, base_tree, other_tree,
840
interesting_ids=None, pb=DummyProgress(), pp=None,
841
reprocess=False, change_reporter=None):
842
self.this_revision_tree = self._get_revision_tree(this_tree)
843
self.other_revision_tree = self._get_revision_tree(other_tree)
844
super(WeaveMerger, self).__init__(working_tree, this_tree,
845
base_tree, other_tree,
846
interesting_ids=interesting_ids,
847
pb=pb, pp=pp, reprocess=reprocess,
848
change_reporter=change_reporter)
850
def _get_revision_tree(self, tree):
851
"""Return a revision tree related to this tree.
852
If the tree is a WorkingTree, the basis will be returned.
854
if getattr(tree, 'get_weave', False) is False:
855
# If we have a WorkingTree, try using the basis
856
return tree.branch.basis_tree()
860
def _check_file(self, file_id):
861
"""Check that the revision tree's version of the file matches."""
862
for tree, rt in ((self.this_tree, self.this_revision_tree),
863
(self.other_tree, self.other_revision_tree)):
866
if tree.get_file_sha1(file_id) != rt.get_file_sha1(file_id):
867
raise WorkingTreeNotRevision(self.this_tree)
869
def _merged_lines(self, file_id):
870
"""Generate the merged lines.
871
There is no distinction between lines that are meant to contain <<<<<<<
874
weave = self.this_revision_tree.get_weave(file_id)
875
this_revision_id = self.this_revision_tree.inventory[file_id].revision
876
other_revision_id = \
877
self.other_revision_tree.inventory[file_id].revision
878
wm = WeaveMerge(weave, this_revision_id, other_revision_id,
879
'<<<<<<< TREE\n', '>>>>>>> MERGE-SOURCE\n')
880
return wm.merge_lines(self.reprocess)
882
def text_merge(self, file_id, trans_id):
883
"""Perform a (weave) text merge for a given file and file-id.
884
If conflicts are encountered, .THIS and .OTHER files will be emitted,
885
and a conflict will be noted.
887
self._check_file(file_id)
888
lines, conflicts = self._merged_lines(file_id)
890
# Note we're checking whether the OUTPUT is binary in this case,
891
# because we don't want to get into weave merge guts.
892
check_text_lines(lines)
893
self.tt.create_file(lines, trans_id)
895
self._raw_conflicts.append(('text conflict', trans_id))
896
name = self.tt.final_name(trans_id)
897
parent_id = self.tt.final_parent(trans_id)
898
file_group = self._dump_conflicts(name, parent_id, file_id,
900
file_group.append(trans_id)
903
class Diff3Merger(Merge3Merger):
904
"""Three-way merger using external diff3 for text merging"""
906
def dump_file(self, temp_dir, name, tree, file_id):
907
out_path = pathjoin(temp_dir, name)
908
out_file = open(out_path, "wb")
910
in_file = tree.get_file(file_id)
917
def text_merge(self, file_id, trans_id):
918
"""Perform a diff3 merge using a specified file-id and trans-id.
919
If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
920
will be dumped, and a will be conflict noted.
923
temp_dir = osutils.mkdtemp(prefix="bzr-")
925
new_file = pathjoin(temp_dir, "new")
926
this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
927
base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
928
other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
929
status = bzrlib.patch.diff3(new_file, this, base, other)
930
if status not in (0, 1):
931
raise BzrError("Unhandled diff3 exit code")
932
f = open(new_file, 'rb')
934
self.tt.create_file(f, trans_id)
938
name = self.tt.final_name(trans_id)
939
parent_id = self.tt.final_parent(trans_id)
940
self._dump_conflicts(name, parent_id, file_id)
941
self._raw_conflicts.append(('text conflict', trans_id))
943
osutils.rmtree(temp_dir)
946
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
948
merge_type=Merge3Merger,
949
interesting_ids=None,
953
interesting_files=None,
956
change_reporter=None):
957
"""Primary interface for merging.
959
typical use is probably
960
'merge_inner(branch, branch.get_revision_tree(other_revision),
961
branch.get_revision_tree(base_revision))'
963
if this_tree is None:
964
warnings.warn("bzrlib.merge.merge_inner requires a this_tree parameter as of "
965
"bzrlib version 0.8.",
968
this_tree = this_branch.bzrdir.open_workingtree()
969
merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
970
pb=pb, change_reporter=change_reporter)
971
merger.backup_files = backup_files
972
merger.merge_type = merge_type
973
merger.interesting_ids = interesting_ids
974
merger.ignore_zero = ignore_zero
975
if interesting_files:
976
assert not interesting_ids, ('Only supply interesting_ids'
977
' or interesting_files')
978
merger._set_interesting_files(interesting_files)
979
merger.show_base = show_base
980
merger.reprocess = reprocess
981
merger.other_rev_id = other_rev_id
982
merger.other_basis = other_rev_id
983
return merger.do_merge()
985
def get_merge_type_registry():
986
"""Merge type registry is in bzrlib.option to avoid circular imports.
988
This method provides a sanctioned way to retrieve it.
990
from bzrlib import option
991
return option._merge_type_registry
383
assert path.startswith('.' + os.sep), "path is %s" % path
385
adjust_ids.append((path, id))
386
if len(adjust_ids) > 0:
387
this_branch.set_inventory(regen_inventory(this_branch, this_tree.root,
391
def regen_inventory(this_branch, root, new_entries):
392
old_entries = this_branch.read_working_inventory()
396
for path, file_id in new_entries:
399
new_entries_map[file_id] = path
401
def id2path(file_id):
402
path = new_entries_map.get(file_id)
405
entry = old_entries[file_id]
406
if entry.parent_id is None:
408
return os.path.join(id2path(entry.parent_id), entry.name)
410
for file_id in old_entries:
411
entry = old_entries[file_id]
412
path = id2path(file_id)
413
new_inventory[file_id] = (path, file_id, entry.parent_id, entry.kind)
414
by_path[path] = file_id
419
for path, file_id in new_entries:
421
del new_inventory[file_id]
424
new_path_list.append((path, file_id))
425
if file_id not in old_entries:
427
# Ensure no file is added before its parent
429
for path, file_id in new_path_list:
433
parent = by_path[os.path.dirname(path)]
434
kind = bzrlib.osutils.file_kind(os.path.join(root, path))
435
new_inventory[file_id] = (path, file_id, parent, kind)
436
by_path[path] = file_id
438
# Get a list in insertion order
439
new_inventory_list = new_inventory.values()
440
mutter ("""Inventory regeneration:
441
old length: %i insertions: %i deletions: %i new_length: %i"""\
442
% (len(old_entries), insertions, deletions, len(new_inventory_list)))
443
assert len(new_inventory_list) == len(old_entries) + insertions - deletions
444
new_inventory_list.sort()
445
return new_inventory_list
447
merge_types = { "merge3": (ApplyMerge3, "Native diff3-style merge"),
448
"diff3": (Diff3Merge, "Merge using external diff3")
added
removed
bzrlib/merge.py
