~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

  • Committer: Martin Pool
  • Date: 2005-05-16 02:19:13 UTC
  • Revision ID: mbp@sourcefrog.net-20050516021913-3a933f871079e3fe
- patch from ddaa to create api/ directory 
  before building API docs

Show diffs side-by-side

added added

removed removed

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