~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

  • Committer: Martin Pool
  • Date: 2005-06-10 06:34:26 UTC
  • Revision ID: mbp@sourcefrog.net-20050610063426-cfcf5c0f96c271ec
- split out updated progress indicator

Show diffs side-by-side

added added

removed removed

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