~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

  • Committer: aaron.bentley at utoronto
  • Date: 2005-09-04 02:59:56 UTC
  • mfrom: (1172)
  • mto: (1185.3.4)
  • mto: This revision was merged to the branch mainline in revision 1178.
  • Revision ID: aaron.bentley@utoronto.ca-20050904025956-776ba4f07de97700
Merged mpool's latest changes (~0.0.7)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
from merge_core import merge_flex
2
 
from changeset import generate_changeset, ExceptionConflictHandler
3
 
from changeset import Inventory
4
 
from bzrlib import find_branch
5
 
import bzrlib.osutils
6
 
from bzrlib.errors import BzrCommandError
7
 
from bzrlib.diff import compare_trees
8
 
from trace import mutter, warning
 
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
 
9
18
import os.path
10
19
import tempfile
11
20
import shutil
12
21
import errno
13
 
 
14
 
class UnrelatedBranches(BzrCommandError):
15
 
    def __init__(self):
16
 
        msg = "Branches have no common ancestor, and no base revision"\
17
 
            " specified."
18
 
        BzrCommandError.__init__(self, msg)
19
 
 
 
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
20
41
 
21
42
class MergeConflictHandler(ExceptionConflictHandler):
22
 
    """Handle conflicts encountered while merging"""
 
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
    """
23
49
    def __init__(self, dir, ignore_zero=False):
24
50
        ExceptionConflictHandler.__init__(self, dir)
25
51
        self.conflicts = 0
36
62
            d_file.write(line)
37
63
        os.chmod(dest, 0777 & os.stat(source).st_mode)
38
64
 
 
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
 
39
74
    def add_suffix(self, name, suffix, last_new_name=None):
40
75
        """Rename a file to append a suffix.  If the new name exists, the
41
76
        suffix is added repeatedly until a non-existant name is found
60
95
        self.conflicts += 1
61
96
        
62
97
 
63
 
    def merge_conflict(self, new_file, this_path, base_path, other_path):
 
98
    def merge_conflict(self, new_file, this_path, base_lines, other_lines):
64
99
        """
65
100
        Handle diff3 conflicts by producing a .THIS, .BASE and .OTHER.  The
66
101
        main file will be a version with diff3 conflicts.
70
105
        :param other_path: Path to the file text for the OTHER tree
71
106
        """
72
107
        self.add_suffix(this_path, ".THIS")
73
 
        self.copy(base_path, this_path+".BASE")
74
 
        self.copy(other_path, this_path+".OTHER")
 
108
        self.dump(base_lines, this_path+".BASE")
 
109
        self.dump(other_lines, this_path+".OTHER")
75
110
        os.rename(new_file, this_path)
76
111
        self.conflict("Diff3 conflict encountered in %s" % this_path)
77
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
 
78
119
    def target_exists(self, entry, target, old_path):
79
120
        """Handle the case when the target file or dir exists"""
80
121
        moved_path = self.add_suffix(target, ".moved")
81
122
        self.conflict("Moved existing %s to %s" % (target, moved_path))
82
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
 
83
130
    def finalize(self):
84
131
        if not self.ignore_zero:
85
132
            print "%d conflicts encountered.\n" % self.conflicts
86
133
            
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):
 
134
def get_tree(treespec, temp_root, label, local_branch=None):
99
135
    location, revno = treespec
100
136
    branch = find_branch(location)
101
137
    if revno is None:
 
138
        revision = None
 
139
    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:
102
148
        base_tree = branch.working_tree()
103
 
    elif revno == -1:
104
 
        base_tree = branch.basis_tree()
105
149
    else:
106
 
        base_tree = branch.revision_tree(branch.lookup_revision(revno))
 
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)
107
155
    temp_path = os.path.join(temp_root, label)
108
156
    os.mkdir(temp_path)
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
 
157
    return MergeTree(base_tree, temp_path)
 
158
 
117
159
 
118
160
def file_exists(tree, file_id):
119
161
    return tree.has_filename(tree.id2path(file_id))
120
162
    
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
 
 
130
163
 
131
164
class MergeTree(object):
132
165
    def __init__(self, tree, tempdir):
135
168
            self.root = tree.basedir
136
169
        else:
137
170
            self.root = None
138
 
        self.inventory = inventory_map(tree)
139
171
        self.tree = tree
140
172
        self.tempdir = tempdir
141
173
        os.mkdir(os.path.join(self.tempdir, "texts"))
142
174
        self.cached = {}
143
175
 
 
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
 
144
204
    def readonly_path(self, id):
 
205
        if id not in self.tree:
 
206
            return None
145
207
        if self.root is not None:
146
208
            return self.tree.abspath(self.tree.id2path(id))
147
209
        else:
159
221
 
160
222
def merge(other_revision, base_revision,
161
223
          check_clean=True, ignore_zero=False,
162
 
          this_dir=None):
 
224
          this_dir=None, backup_files=False, merge_type=ApplyMerge3,
 
225
          file_list=None):
163
226
    """Merge changes into a tree.
164
227
 
165
228
    base_revision
166
 
        Base for three-way merge.
 
229
        tuple(path, revision) Base for three-way merge.
167
230
    other_revision
168
 
        Other revision for three-way merge.
 
231
        tuple(path, revision) Other revision for three-way merge.
169
232
    this_dir
170
233
        Directory to merge changes into; '.' by default.
171
234
    check_clean
172
235
        If true, this_dir must have no uncommitted changes before the
173
236
        merge begins.
 
237
    all available ancestors of other_revision and base_revision are
 
238
    automatically pulled into the branch.
174
239
    """
 
240
    from bzrlib.revision import common_ancestor, MultipleRevisionSources
 
241
    from bzrlib.errors import NoSuchRevision
175
242
    tempdir = tempfile.mkdtemp(prefix="bzr-")
176
243
    try:
177
244
        if this_dir is None:
178
245
            this_dir = '.'
179
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")
180
250
        if check_clean:
181
251
            changes = compare_trees(this_branch.working_tree(), 
182
252
                                    this_branch.basis_tree(), False)
183
253
            if changes.has_changed():
184
254
                raise BzrCommandError("Working tree has uncommitted changes.")
185
 
        other_branch, other_tree = get_tree(other_revision, tempdir, "other")
 
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()
186
266
        if base_revision == [None, 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:
 
267
            base_rev_id = common_ancestor(this_rev_id, other_basis, 
 
268
                                          this_branch)
 
269
            if base_rev_id is None:
194
270
                raise UnrelatedBranches()
195
 
            base_revision = ['.', base_revno]
196
 
        base_branch, base_tree = get_tree(base_revision, tempdir, "base")
 
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)
197
304
        merge_inner(this_branch, other_tree, base_tree, tempdir, 
198
 
                    ignore_zero=ignore_zero)
 
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
            this_branch.add_pending_merge(other_rev_id)
199
309
    finally:
200
310
        shutil.rmtree(tempdir)
201
311
 
202
312
 
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.
 
313
def set_interesting(inventory_a, inventory_b, interesting_ids):
 
314
    """Mark files whose ids are in interesting_ids as interesting
 
315
    """
 
316
    for inventory in (inventory_a, inventory_b):
 
317
        for path, source_file in inventory.iteritems():
 
318
             source_file.interesting = source_file.id in interesting_ids
 
319
 
 
320
 
 
321
def generate_cset_optimized(tree_a, tree_b, interesting_ids=None):
 
322
    """Generate a changeset.  If interesting_ids is supplied, only changes
 
323
    to those files will be shown.  Metadata changes are stripped.
207
324
    """ 
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)
 
325
    cset =  generate_changeset(tree_a, tree_b, interesting_ids)
222
326
    for entry in cset.entries.itervalues():
223
327
        entry.metadata_change = None
224
328
    return cset
225
329
 
226
330
 
227
331
def merge_inner(this_branch, other_tree, base_tree, tempdir, 
228
 
                ignore_zero=False):
 
332
                ignore_zero=False, merge_type=ApplyMerge3, backup_files=False,
 
333
                interesting_ids=None):
 
334
 
 
335
    def merge_factory(file_id, base, other):
 
336
        contents_change = merge_type(file_id, base, other)
 
337
        if backup_files:
 
338
            contents_change = BackupBeforeChange(contents_change)
 
339
        return contents_change
 
340
 
229
341
    this_tree = get_tree((this_branch.base, None), tempdir, "this")[1]
230
342
 
231
343
    def get_inventory(tree):
232
 
        return tree.inventory
 
344
        return tree.tree.inventory
233
345
 
234
346
    inv_changes = merge_flex(this_tree, base_tree, other_tree,
235
347
                             generate_cset_optimized, get_inventory,
236
348
                             MergeConflictHandler(base_tree.root,
237
 
                                                  ignore_zero=ignore_zero))
 
349
                                                  ignore_zero=ignore_zero),
 
350
                             merge_factory=merge_factory, 
 
351
                             interesting_ids=interesting_ids)
238
352
 
239
353
    adjust_ids = []
240
354
    for id, path in inv_changes.iteritems():
242
356
            if path == '.':
243
357
                path = ''
244
358
            else:
245
 
                assert path.startswith('./')
 
359
                assert path.startswith('./'), "path is %s" % path
246
360
            path = path[2:]
247
361
        adjust_ids.append((path, id))
248
 
    this_branch.set_inventory(regen_inventory(this_branch, this_tree.root, adjust_ids))
 
362
    if len(adjust_ids) > 0:
 
363
        this_branch.set_inventory(regen_inventory(this_branch, this_tree.root,
 
364
                                                  adjust_ids))
249
365
 
250
366
 
251
367
def regen_inventory(this_branch, root, new_entries):
252
368
    old_entries = this_branch.read_working_inventory()
253
369
    new_inventory = {}
254
370
    by_path = {}
 
371
    new_entries_map = {} 
 
372
    for path, file_id in new_entries:
 
373
        if path is None:
 
374
            continue
 
375
        new_entries_map[file_id] = path
 
376
 
 
377
    def id2path(file_id):
 
378
        path = new_entries_map.get(file_id)
 
379
        if path is not None:
 
380
            return path
 
381
        entry = old_entries[file_id]
 
382
        if entry.parent_id is None:
 
383
            return entry.name
 
384
        return os.path.join(id2path(entry.parent_id), entry.name)
 
385
        
255
386
    for file_id in old_entries:
256
387
        entry = old_entries[file_id]
257
 
        path = old_entries.id2path(file_id)
 
388
        path = id2path(file_id)
258
389
        new_inventory[file_id] = (path, file_id, entry.parent_id, entry.kind)
259
390
        by_path[path] = file_id
260
391
    
288
419
    assert len(new_inventory_list) == len(old_entries) + insertions - deletions
289
420
    new_inventory_list.sort()
290
421
    return new_inventory_list
 
422
 
 
423
merge_types = {     "merge3": (ApplyMerge3, "Native diff3-style merge"), 
 
424
                     "diff3": (Diff3Merge,  "Merge using external diff3")
 
425
              }
 
426