← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

merge merge tweaks from aaron, which includes latest .dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/merge.py
 
1
# Copyright (C) 2005 Canonical Ltd
 
2
 
 
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.
 
7
 
 
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.
 
12
 
 
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
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
 
 
18
import os
 
19
import tempfile
 
20
import shutil
 
21
import errno
 
22
from fetch import greedy_fetch
 
23
 
 
24
import bzrlib.osutils
 
25
import bzrlib.revision
 
26
from bzrlib.merge_core import merge_flex, ApplyMerge3, BackupBeforeChange
 
27
from bzrlib.changeset import generate_changeset, ExceptionConflictHandler
 
28
from bzrlib.changeset import Inventory, Diff3Merge
 
29
from bzrlib.branch import Branch
 
30
from bzrlib.errors import BzrCommandError, UnrelatedBranches, NoCommonAncestor
 
31
from bzrlib.errors import NoCommits
 
32
from bzrlib.delta import compare_trees
 
33
from bzrlib.trace import mutter, warning
 
34
from bzrlib.fetch import greedy_fetch
 
35
from bzrlib.revision import is_ancestor
 
36
 
 
37
# comments from abentley on irc: merge happens in two stages, each
 
38
# of which generates a changeset object
 
39
 
 
40
# stage 1: generate OLD->OTHER,
 
41
# stage 2: use MINE and OLD->OTHER to generate MINE -> RESULT
 
42
 
 
43
class MergeConflictHandler(ExceptionConflictHandler):
 
44
    """Handle conflicts encountered while merging.
 
45
 
 
46
    This subclasses ExceptionConflictHandler, so that any types of
 
47
    conflict that are not explicitly handled cause an exception and
 
48
    terminate the merge.
 
49
    """
 
50
    def __init__(self, ignore_zero=False):
 
51
        ExceptionConflictHandler.__init__(self)
 
52
        self.conflicts = 0
 
53
        self.ignore_zero = ignore_zero
 
54
 
 
55
    def copy(self, source, dest):
 
56
        """Copy the text and mode of a file
 
57
        :param source: The path of the file to copy
 
58
        :param dest: The distination file to create
 
59
        """
 
60
        s_file = file(source, "rb")
 
61
        d_file = file(dest, "wb")
 
62
        for line in s_file:
 
63
            d_file.write(line)
 
64
        os.chmod(dest, 0777 & os.stat(source).st_mode)
 
65
 
 
66
    def dump(self, lines, dest):
 
67
        """Copy the text and mode of a file
 
68
        :param source: The path of the file to copy
 
69
        :param dest: The distination file to create
 
70
        """
 
71
        d_file = file(dest, "wb")
 
72
        for line in lines:
 
73
            d_file.write(line)
 
74
 
 
75
    def add_suffix(self, name, suffix, last_new_name=None):
 
76
        """Rename a file to append a suffix.  If the new name exists, the
 
77
        suffix is added repeatedly until a non-existant name is found
 
78
 
 
79
        :param name: The path of the file
 
80
        :param suffix: The suffix to append
 
81
        :param last_new_name: (used for recursive calls) the last name tried
 
82
        """
 
83
        if last_new_name is None:
 
84
            last_new_name = name
 
85
        new_name = last_new_name+suffix
 
86
        try:
 
87
            os.rename(name, new_name)
 
88
            return new_name
 
89
        except OSError, e:
 
90
            if e.errno != errno.EEXIST and e.errno != errno.ENOTEMPTY:
 
91
                raise
 
92
            return self.add_suffix(name, suffix, last_new_name=new_name)
 
93
 
 
94
    def conflict(self, text):
 
95
        warning(text)
 
96
        self.conflicts += 1
 
97
        
 
98
 
 
99
    def merge_conflict(self, new_file, this_path, base_lines, other_lines):
 
100
        """
 
101
        Handle diff3 conflicts by producing a .THIS, .BASE and .OTHER.  The
 
102
        main file will be a version with diff3 conflicts.
 
103
        :param new_file: Path to the output file with diff3 markers
 
104
        :param this_path: Path to the file text for the THIS tree
 
105
        :param base_path: Path to the file text for the BASE tree
 
106
        :param other_path: Path to the file text for the OTHER tree
 
107
        """
 
108
        self.add_suffix(this_path, ".THIS")
 
109
        self.dump(base_lines, this_path+".BASE")
 
110
        self.dump(other_lines, this_path+".OTHER")
 
111
        os.rename(new_file, this_path)
 
112
        self.conflict("Diff3 conflict encountered in %s" % this_path)
 
113
 
 
114
    def new_contents_conflict(self, filename, other_contents):
 
115
        """Conflicting contents for newly added file."""
 
116
        self.copy(other_contents, filename + ".OTHER")
 
117
        self.conflict("Conflict in newly added file %s" % filename)
 
118
    
 
119
 
 
120
    def target_exists(self, entry, target, old_path):
 
121
        """Handle the case when the target file or dir exists"""
 
122
        moved_path = self.add_suffix(target, ".moved")
 
123
        self.conflict("Moved existing %s to %s" % (target, moved_path))
 
124
 
 
125
    def rmdir_non_empty(self, filename):
 
126
        """Handle the case where the dir to be removed still has contents"""
 
127
        self.conflict("Directory %s not removed because it is not empty"\
 
128
            % filename)
 
129
        return "skip"
 
130
 
 
131
    def finalize(self):
 
132
        if not self.ignore_zero:
 
133
            print "%d conflicts encountered.\n" % self.conflicts
 
134
            
 
135
def get_tree(treespec, temp_root, label, local_branch=None):
 
136
    location, revno = treespec
 
137
    branch = Branch.open(location)
 
138
    if revno is None:
 
139
        revision = None
 
140
    elif revno == -1:
 
141
        revision = branch.last_patch()
 
142
    else:
 
143
        revision = branch.get_rev_id(revno)
 
144
    return branch, get_revid_tree(branch, revision, temp_root, label,
 
145
                                  local_branch)
 
146
 
 
147
def get_revid_tree(branch, revision, temp_root, label, local_branch):
 
148
    if revision is None:
 
149
        base_tree = branch.working_tree()
 
150
    else:
 
151
        if local_branch is not None:
 
152
            greedy_fetch(local_branch, branch, revision)
 
153
            base_tree = local_branch.revision_tree(revision)
 
154
        else:
 
155
            base_tree = branch.revision_tree(revision)
 
156
    temp_path = os.path.join(temp_root, label)
 
157
    os.mkdir(temp_path)
 
158
    return MergeTree(base_tree, temp_path)
 
159
 
 
160
 
 
161
def file_exists(tree, file_id):
 
162
    return tree.has_filename(tree.id2path(file_id))
 
163
    
 
164
 
 
165
class MergeTree(object):
 
166
    def __init__(self, tree, tempdir):
 
167
        object.__init__(self)
 
168
        if hasattr(tree, "basedir"):
 
169
            self.root = tree.basedir
 
170
        else:
 
171
            self.root = None
 
172
        self.tree = tree
 
173
        self.tempdir = tempdir
 
174
        os.mkdir(os.path.join(self.tempdir, "texts"))
 
175
        self.cached = {}
 
176
 
 
177
    def __iter__(self):
 
178
        return self.tree.__iter__()
 
179
 
 
180
    def __contains__(self, file_id):
 
181
        return file_id in self.tree
 
182
 
 
183
    def get_file(self, file_id):
 
184
        return self.tree.get_file(file_id)
 
185
 
 
186
    def get_file_sha1(self, id):
 
187
        return self.tree.get_file_sha1(id)
 
188
 
 
189
    def id2path(self, file_id):
 
190
        return self.tree.id2path(file_id)
 
191
 
 
192
    def has_id(self, file_id):
 
193
        return self.tree.has_id(file_id)
 
194
 
 
195
    def has_or_had_id(self, file_id):
 
196
        if file_id == self.tree.inventory.root.file_id:
 
197
            return True
 
198
        return self.tree.inventory.has_id(file_id)
 
199
 
 
200
    def has_or_had_id(self, file_id):
 
201
        if file_id == self.tree.inventory.root.file_id:
 
202
            return True
 
203
        return self.tree.inventory.has_id(file_id)
 
204
 
 
205
    def readonly_path(self, id):
 
206
        if id not in self.tree:
 
207
            return None
 
208
        if self.root is not None:
 
209
            return self.tree.abspath(self.tree.id2path(id))
 
210
        else:
 
211
            if self.tree.inventory[id].kind in ("directory", "root_directory"):
 
212
                return self.tempdir
 
213
            if not self.cached.has_key(id):
 
214
                path = os.path.join(self.tempdir, "texts", id)
 
215
                outfile = file(path, "wb")
 
216
                outfile.write(self.tree.get_file(id).read())
 
217
                assert(os.path.exists(path))
 
218
                self.cached[id] = path
 
219
            return self.cached[id]
 
220
 
 
221
 
 
222
 
 
223
def merge(other_revision, base_revision,
 
224
          check_clean=True, ignore_zero=False,
 
225
          this_dir=None, backup_files=False, merge_type=ApplyMerge3,
 
226
          file_list=None):
 
227
    """Merge changes into a tree.
 
228
 
 
229
    base_revision
 
230
        tuple(path, revision) Base for three-way merge.
 
231
    other_revision
 
232
        tuple(path, revision) Other revision for three-way merge.
 
233
    this_dir
 
234
        Directory to merge changes into; '.' by default.
 
235
    check_clean
 
236
        If true, this_dir must have no uncommitted changes before the
 
237
        merge begins.
 
238
    all available ancestors of other_revision and base_revision are
 
239
    automatically pulled into the branch.
 
240
    """
 
241
    from bzrlib.revision import common_ancestor, MultipleRevisionSources
 
242
    from bzrlib.errors import NoSuchRevision
 
243
    tempdir = tempfile.mkdtemp(prefix="bzr-")
 
244
    try:
 
245
        if this_dir is None:
 
246
            this_dir = '.'
 
247
        this_branch = Branch.open_containing(this_dir)
 
248
        this_rev_id = this_branch.last_patch()
 
249
        if this_rev_id is None:
 
250
            raise BzrCommandError("This branch has no commits")
 
251
        if check_clean:
 
252
            changes = compare_trees(this_branch.working_tree(), 
 
253
                                    this_branch.basis_tree(), False)
 
254
            if changes.has_changed():
 
255
                raise BzrCommandError("Working tree has uncommitted changes.")
 
256
        other_branch, other_tree = get_tree(other_revision, tempdir, "other",
 
257
                                            this_branch)
 
258
        if other_revision[1] == -1:
 
259
            other_rev_id = other_branch.last_patch()
 
260
            if other_rev_id is None:
 
261
                raise NoCommits(other_branch)
 
262
            other_basis = other_rev_id
 
263
        elif other_revision[1] is not None:
 
264
            other_rev_id = other_branch.get_rev_id(other_revision[1])
 
265
            other_basis = other_rev_id
 
266
        else:
 
267
            other_rev_id = None
 
268
            other_basis = other_branch.last_patch()
 
269
            if other_basis is None:
 
270
                raise NoCommits(other_branch)
 
271
        if base_revision == [None, None]:
 
272
            try:
 
273
                base_rev_id = common_ancestor(this_rev_id, other_basis, 
 
274
                                              this_branch)
 
275
            except NoCommonAncestor:
 
276
                raise UnrelatedBranches()
 
277
            base_tree = get_revid_tree(this_branch, base_rev_id, tempdir, 
 
278
                                       "base", None)
 
279
            base_is_ancestor = True
 
280
        else:
 
281
            base_branch, base_tree = get_tree(base_revision, tempdir, "base")
 
282
            if base_revision[1] == -1:
 
283
                base_rev_id = base_branch.last_patch()
 
284
            elif base_revision[1] is None:
 
285
                base_rev_id = None
 
286
            else:
 
287
                base_rev_id = base_branch.get_rev_id(base_revision[1])
 
288
            multi_source = MultipleRevisionSources(this_branch, base_branch)
 
289
            base_is_ancestor = is_ancestor(this_rev_id, base_rev_id,
 
290
                                           multi_source)
 
291
        if file_list is None:
 
292
            interesting_ids = None
 
293
        else:
 
294
            interesting_ids = set()
 
295
            this_tree = this_branch.working_tree()
 
296
            for fname in file_list:
 
297
                path = this_branch.relpath(fname)
 
298
                found_id = False
 
299
                for tree in (this_tree, base_tree.tree, other_tree.tree):
 
300
                    file_id = tree.inventory.path2id(path)
 
301
                    if file_id is not None:
 
302
                        interesting_ids.add(file_id)
 
303
                        found_id = True
 
304
                if not found_id:
 
305
                    raise BzrCommandError("%s is not a source file in any"
 
306
                                          " tree." % fname)
 
307
        merge_inner(this_branch, other_tree, base_tree, tempdir, 
 
308
                    ignore_zero=ignore_zero, backup_files=backup_files, 
 
309
                    merge_type=merge_type, interesting_ids=interesting_ids)
 
310
        if base_is_ancestor and other_rev_id is not None\
 
311
            and other_rev_id not in this_branch.revision_history():
 
312
            this_branch.add_pending_merge(other_rev_id)
 
313
    finally:
 
314
        shutil.rmtree(tempdir)
 
315
 
 
316
 
 
317
def set_interesting(inventory_a, inventory_b, interesting_ids):
 
318
    """Mark files whose ids are in interesting_ids as interesting
 
319
    """
 
320
    for inventory in (inventory_a, inventory_b):
 
321
        for path, source_file in inventory.iteritems():
 
322
             source_file.interesting = source_file.id in interesting_ids
 
323
 
 
324
 
 
325
def generate_cset_optimized(tree_a, tree_b, interesting_ids=None):
 
326
    """Generate a changeset.  If interesting_ids is supplied, only changes
 
327
    to those files will be shown.  Metadata changes are stripped.
 
328
    """ 
 
329
    cset =  generate_changeset(tree_a, tree_b, interesting_ids)
 
330
    for entry in cset.entries.itervalues():
 
331
        entry.metadata_change = None
 
332
    return cset
 
333
 
 
334
 
 
335
def merge_inner(this_branch, other_tree, base_tree, tempdir, 
 
336
                ignore_zero=False, merge_type=ApplyMerge3, backup_files=False,
 
337
                interesting_ids=None):
 
338
 
 
339
    def merge_factory(file_id, base, other):
 
340
        contents_change = merge_type(file_id, base, other)
 
341
        if backup_files:
 
342
            contents_change = BackupBeforeChange(contents_change)
 
343
        return contents_change
 
344
 
 
345
    this_tree = get_tree((this_branch.base, None), tempdir, "this")[1]
 
346
 
 
347
    def get_inventory(tree):
 
348
        return tree.tree.inventory
 
349
 
 
350
    inv_changes = merge_flex(this_tree, base_tree, other_tree,
 
351
                             generate_cset_optimized, get_inventory,
 
352
                             MergeConflictHandler(ignore_zero=ignore_zero),
 
353
                             merge_factory=merge_factory, 
 
354
                             interesting_ids=interesting_ids)
 
355
 
 
356
    adjust_ids = []
 
357
    for id, path in inv_changes.iteritems():
 
358
        if path is not None:
 
359
            if path == '.':
 
360
                path = ''
 
361
            else:
 
362
                assert path.startswith('.' + os.sep), "path is %s" % path
 
363
            path = path[2:]
 
364
        adjust_ids.append((path, id))
 
365
    if len(adjust_ids) > 0:
 
366
        this_branch.set_inventory(regen_inventory(this_branch, this_tree.root,
 
367
                                                  adjust_ids))
 
368
 
 
369
 
 
370
def regen_inventory(this_branch, root, new_entries):
 
371
    old_entries = this_branch.read_working_inventory()
 
372
    new_inventory = {}
 
373
    by_path = {}
 
374
    new_entries_map = {} 
 
375
    for path, file_id in new_entries:
 
376
        if path is None:
 
377
            continue
 
378
        new_entries_map[file_id] = path
 
379
 
 
380
    def id2path(file_id):
 
381
        path = new_entries_map.get(file_id)
 
382
        if path is not None:
 
383
            return path
 
384
        entry = old_entries[file_id]
 
385
        if entry.parent_id is None:
 
386
            return entry.name
 
387
        return os.path.join(id2path(entry.parent_id), entry.name)
 
388
        
 
389
    for file_id in old_entries:
 
390
        entry = old_entries[file_id]
 
391
        path = id2path(file_id)
 
392
        new_inventory[file_id] = (path, file_id, entry.parent_id, entry.kind)
 
393
        by_path[path] = file_id
 
394
    
 
395
    deletions = 0
 
396
    insertions = 0
 
397
    new_path_list = []
 
398
    for path, file_id in new_entries:
 
399
        if path is None:
 
400
            del new_inventory[file_id]
 
401
            deletions += 1
 
402
        else:
 
403
            new_path_list.append((path, file_id))
 
404
            if file_id not in old_entries:
 
405
                insertions += 1
 
406
    # Ensure no file is added before its parent
 
407
    new_path_list.sort()
 
408
    for path, file_id in new_path_list:
 
409
        if path == '':
 
410
            parent = None
 
411
        else:
 
412
            parent = by_path[os.path.dirname(path)]
 
413
        kind = bzrlib.osutils.file_kind(os.path.join(root, path))
 
414
        new_inventory[file_id] = (path, file_id, parent, kind)
 
415
        by_path[path] = file_id 
 
416
 
 
417
    # Get a list in insertion order
 
418
    new_inventory_list = new_inventory.values()
 
419
    mutter ("""Inventory regeneration:
 
420
old length: %i insertions: %i deletions: %i new_length: %i"""\
 
421
        % (len(old_entries), insertions, deletions, len(new_inventory_list)))
 
422
    assert len(new_inventory_list) == len(old_entries) + insertions - deletions
 
423
    new_inventory_list.sort()
 
424
    return new_inventory_list
 
425
 
 
426
merge_types = {     "merge3": (ApplyMerge3, "Native diff3-style merge"), 
 
427
                     "diff3": (Diff3Merge,  "Merge using external diff3")
 
428
              }
 
429