~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

  • Committer: mbp at sourcefrog
  • Date: 2005-03-23 06:25:55 UTC
  • Revision ID: mbp@sourcefrog.net-20050323062555-5489339018d0c043
- import a subset of elementtree for easier installation

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
from merge_core import merge_flex, ApplyMerge3, BackupBeforeChange
2
 
from changeset import generate_changeset, ExceptionConflictHandler
3
 
from changeset import Inventory, Diff3Merge
4
 
from bzrlib import find_branch
5
 
import bzrlib.osutils
6
 
from bzrlib.errors import BzrCommandError
7
 
from bzrlib.delta import compare_trees
8
 
from trace import mutter, warning
9
 
import os.path
10
 
import tempfile
11
 
import shutil
12
 
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
 
 
20
 
 
21
 
class MergeConflictHandler(ExceptionConflictHandler):
22
 
    """Handle conflicts encountered while merging"""
23
 
    def __init__(self, dir, ignore_zero=False):
24
 
        ExceptionConflictHandler.__init__(self, dir)
25
 
        self.conflicts = 0
26
 
        self.ignore_zero = ignore_zero
27
 
 
28
 
    def copy(self, source, dest):
29
 
        """Copy the text and mode of a file
30
 
        :param source: The path of the file to copy
31
 
        :param dest: The distination file to create
32
 
        """
33
 
        s_file = file(source, "rb")
34
 
        d_file = file(dest, "wb")
35
 
        for line in s_file:
36
 
            d_file.write(line)
37
 
        os.chmod(dest, 0777 & os.stat(source).st_mode)
38
 
 
39
 
    def add_suffix(self, name, suffix, last_new_name=None):
40
 
        """Rename a file to append a suffix.  If the new name exists, the
41
 
        suffix is added repeatedly until a non-existant name is found
42
 
 
43
 
        :param name: The path of the file
44
 
        :param suffix: The suffix to append
45
 
        :param last_new_name: (used for recursive calls) the last name tried
46
 
        """
47
 
        if last_new_name is None:
48
 
            last_new_name = name
49
 
        new_name = last_new_name+suffix
50
 
        try:
51
 
            os.rename(name, new_name)
52
 
            return new_name
53
 
        except OSError, e:
54
 
            if e.errno != errno.EEXIST and e.errno != errno.ENOTEMPTY:
55
 
                raise
56
 
            return self.add_suffix(name, suffix, last_new_name=new_name)
57
 
 
58
 
    def conflict(self, text):
59
 
        warning(text)
60
 
        self.conflicts += 1
61
 
        
62
 
 
63
 
    def merge_conflict(self, new_file, this_path, base_path, other_path):
64
 
        """
65
 
        Handle diff3 conflicts by producing a .THIS, .BASE and .OTHER.  The
66
 
        main file will be a version with diff3 conflicts.
67
 
        :param new_file: Path to the output file with diff3 markers
68
 
        :param this_path: Path to the file text for the THIS tree
69
 
        :param base_path: Path to the file text for the BASE tree
70
 
        :param other_path: Path to the file text for the OTHER tree
71
 
        """
72
 
        self.add_suffix(this_path, ".THIS")
73
 
        self.copy(base_path, this_path+".BASE")
74
 
        self.copy(other_path, this_path+".OTHER")
75
 
        os.rename(new_file, this_path)
76
 
        self.conflict("Diff3 conflict encountered in %s" % this_path)
77
 
 
78
 
    def target_exists(self, entry, target, old_path):
79
 
        """Handle the case when the target file or dir exists"""
80
 
        moved_path = self.add_suffix(target, ".moved")
81
 
        self.conflict("Moved existing %s to %s" % (target, moved_path))
82
 
 
83
 
    def rmdir_non_empty(self, filename):
84
 
        """Handle the case where the dir to be removed still has contents"""
85
 
        self.conflict("Directory %s not removed because it is not empty"\
86
 
            % filename)
87
 
        return "skip"
88
 
 
89
 
    def finalize(self):
90
 
        if not self.ignore_zero:
91
 
            print "%d conflicts encountered.\n" % self.conflicts
92
 
            
93
 
class SourceFile(object):
94
 
    def __init__(self, path, id, present=None, isdir=None):
95
 
        self.path = path
96
 
        self.id = id
97
 
        self.present = present
98
 
        self.isdir = isdir
99
 
        self.interesting = True
100
 
 
101
 
    def __repr__(self):
102
 
        return "SourceFile(%s, %s)" % (self.path, self.id)
103
 
 
104
 
def get_tree(treespec, temp_root, label):
105
 
    location, revno = treespec
106
 
    branch = find_branch(location)
107
 
    if revno is None:
108
 
        base_tree = branch.working_tree()
109
 
    elif revno == -1:
110
 
        base_tree = branch.basis_tree()
111
 
    else:
112
 
        base_tree = branch.revision_tree(branch.lookup_revision(revno))
113
 
    temp_path = os.path.join(temp_root, label)
114
 
    os.mkdir(temp_path)
115
 
    return branch, MergeTree(base_tree, temp_path)
116
 
 
117
 
 
118
 
def abspath(tree, file_id):
119
 
    path = tree.inventory.id2path(file_id)
120
 
    if path == "":
121
 
        return "./."
122
 
    return "./" + path
123
 
 
124
 
def file_exists(tree, file_id):
125
 
    return tree.has_filename(tree.id2path(file_id))
126
 
    
127
 
def inventory_map(tree):
128
 
    inventory = {}
129
 
    for file_id in tree.inventory:
130
 
        path = abspath(tree, file_id)
131
 
        inventory[path] = SourceFile(path, file_id)
132
 
    return inventory
133
 
 
134
 
 
135
 
class MergeTree(object):
136
 
    def __init__(self, tree, tempdir):
137
 
        object.__init__(self)
138
 
        if hasattr(tree, "basedir"):
139
 
            self.root = tree.basedir
140
 
        else:
141
 
            self.root = None
142
 
        self.inventory = inventory_map(tree)
143
 
        self.tree = tree
144
 
        self.tempdir = tempdir
145
 
        os.mkdir(os.path.join(self.tempdir, "texts"))
146
 
        self.cached = {}
147
 
 
148
 
    def readonly_path(self, id):
149
 
        if id not in self.tree:
150
 
            return None
151
 
        if self.root is not None:
152
 
            return self.tree.abspath(self.tree.id2path(id))
153
 
        else:
154
 
            if self.tree.inventory[id].kind in ("directory", "root_directory"):
155
 
                return self.tempdir
156
 
            if not self.cached.has_key(id):
157
 
                path = os.path.join(self.tempdir, "texts", id)
158
 
                outfile = file(path, "wb")
159
 
                outfile.write(self.tree.get_file(id).read())
160
 
                assert(os.path.exists(path))
161
 
                self.cached[id] = path
162
 
            return self.cached[id]
163
 
 
164
 
 
165
 
 
166
 
def merge(other_revision, base_revision,
167
 
          check_clean=True, ignore_zero=False,
168
 
          this_dir=None, backup_files=False, merge_type=ApplyMerge3,
169
 
          file_list=None):
170
 
    """Merge changes into a tree.
171
 
 
172
 
    base_revision
173
 
        Base for three-way merge.
174
 
    other_revision
175
 
        Other revision for three-way merge.
176
 
    this_dir
177
 
        Directory to merge changes into; '.' by default.
178
 
    check_clean
179
 
        If true, this_dir must have no uncommitted changes before the
180
 
        merge begins.
181
 
    """
182
 
    tempdir = tempfile.mkdtemp(prefix="bzr-")
183
 
    try:
184
 
        if this_dir is None:
185
 
            this_dir = '.'
186
 
        this_branch = find_branch(this_dir)
187
 
        if check_clean:
188
 
            changes = compare_trees(this_branch.working_tree(), 
189
 
                                    this_branch.basis_tree(), False)
190
 
            if changes.has_changed():
191
 
                raise BzrCommandError("Working tree has uncommitted changes.")
192
 
        other_branch, other_tree = get_tree(other_revision, tempdir, "other")
193
 
        if base_revision == [None, None]:
194
 
            if other_revision[1] == -1:
195
 
                o_revno = None
196
 
            else:
197
 
                o_revno = other_revision[1]
198
 
            base_revno = this_branch.common_ancestor(other_branch, 
199
 
                                                     other_revno=o_revno)[0]
200
 
            if base_revno is None:
201
 
                raise UnrelatedBranches()
202
 
            base_revision = ['.', base_revno]
203
 
        base_branch, base_tree = get_tree(base_revision, tempdir, "base")
204
 
        if file_list is None:
205
 
            interesting_ids = None
206
 
        else:
207
 
            interesting_ids = set()
208
 
            this_tree = this_branch.working_tree()
209
 
            for fname in file_list:
210
 
                path = this_branch.relpath(fname)
211
 
                found_id = False
212
 
                for tree in (this_tree, base_tree.tree, other_tree.tree):
213
 
                    file_id = tree.inventory.path2id(path)
214
 
                    if file_id is not None:
215
 
                        interesting_ids.add(file_id)
216
 
                        found_id = True
217
 
                if not found_id:
218
 
                    raise BzrCommandError("%s is not a source file in any"
219
 
                                          " tree." % fname)
220
 
        merge_inner(this_branch, other_tree, base_tree, tempdir, 
221
 
                    ignore_zero=ignore_zero, backup_files=backup_files, 
222
 
                    merge_type=merge_type, interesting_ids=interesting_ids)
223
 
    finally:
224
 
        shutil.rmtree(tempdir)
225
 
 
226
 
 
227
 
def set_interesting(inventory_a, inventory_b, interesting_ids):
228
 
    """Mark files whose ids are in interesting_ids as interesting
229
 
    """
230
 
    for inventory in (inventory_a, inventory_b):
231
 
        for path, source_file in inventory.iteritems():
232
 
             source_file.interesting = source_file.id in interesting_ids
233
 
 
234
 
 
235
 
def set_optimized(tree_a, tree_b, inventory_a, inventory_b):
236
 
    """Mark files that have changed texts as interesting
237
 
    """
238
 
    for file_id in tree_a.tree.inventory:
239
 
        if file_id not in tree_b.tree.inventory:
240
 
            continue
241
 
        entry_a = tree_a.tree.inventory[file_id]
242
 
        entry_b = tree_b.tree.inventory[file_id]
243
 
        if (entry_a.kind, entry_b.kind) != ("file", "file"):
244
 
            continue
245
 
        if None in (entry_a.text_id, entry_b.text_id):
246
 
            continue
247
 
        if entry_a.text_id != entry_b.text_id:
248
 
            continue
249
 
        inventory_a[abspath(tree_a.tree, file_id)].interesting = False
250
 
        inventory_b[abspath(tree_b.tree, file_id)].interesting = False
251
 
 
252
 
 
253
 
def generate_cset_optimized(tree_a, tree_b, inventory_a, inventory_b,
254
 
                            interesting_ids=None):
255
 
    """Generate a changeset, with preprocessing to select interesting files.
256
 
    using the text_id to mark really-changed files.
257
 
    This permits blazing comparisons when text_ids are present.  It also
258
 
    disables metadata comparison for files with identical texts.
259
 
    """ 
260
 
    if interesting_ids is None:
261
 
        set_optimized(tree_a, tree_b, inventory_a, inventory_b)
262
 
    else:
263
 
        set_interesting(inventory_a, inventory_b, interesting_ids)
264
 
    cset =  generate_changeset(tree_a, tree_b, inventory_a, inventory_b)
265
 
    for entry in cset.entries.itervalues():
266
 
        entry.metadata_change = None
267
 
    return cset
268
 
 
269
 
 
270
 
def merge_inner(this_branch, other_tree, base_tree, tempdir, 
271
 
                ignore_zero=False, merge_type=ApplyMerge3, backup_files=False,
272
 
                interesting_ids=None):
273
 
 
274
 
    def merge_factory(base_file, other_file):
275
 
        contents_change = merge_type(base_file, other_file)
276
 
        if backup_files:
277
 
            contents_change = BackupBeforeChange(contents_change)
278
 
        return contents_change
279
 
    
280
 
    def generate_cset(tree_a, tree_b, inventory_a, inventory_b):
281
 
        return generate_cset_optimized(tree_a, tree_b, inventory_a, inventory_b,
282
 
                                       interesting_ids)
283
 
 
284
 
    this_tree = get_tree((this_branch.base, None), tempdir, "this")[1]
285
 
 
286
 
    def get_inventory(tree):
287
 
        return tree.inventory
288
 
 
289
 
    inv_changes = merge_flex(this_tree, base_tree, other_tree,
290
 
                             generate_cset, get_inventory,
291
 
                             MergeConflictHandler(base_tree.root,
292
 
                                                  ignore_zero=ignore_zero),
293
 
                             merge_factory=merge_factory)
294
 
 
295
 
    adjust_ids = []
296
 
    for id, path in inv_changes.iteritems():
297
 
        if path is not None:
298
 
            if path == '.':
299
 
                path = ''
300
 
            else:
301
 
                assert path.startswith('./')
302
 
            path = path[2:]
303
 
        adjust_ids.append((path, id))
304
 
    this_branch.set_inventory(regen_inventory(this_branch, this_tree.root, adjust_ids))
305
 
 
306
 
 
307
 
def regen_inventory(this_branch, root, new_entries):
308
 
    old_entries = this_branch.read_working_inventory()
309
 
    new_inventory = {}
310
 
    by_path = {}
311
 
    for file_id in old_entries:
312
 
        entry = old_entries[file_id]
313
 
        path = old_entries.id2path(file_id)
314
 
        new_inventory[file_id] = (path, file_id, entry.parent_id, entry.kind)
315
 
        by_path[path] = file_id
316
 
    
317
 
    deletions = 0
318
 
    insertions = 0
319
 
    new_path_list = []
320
 
    for path, file_id in new_entries:
321
 
        if path is None:
322
 
            del new_inventory[file_id]
323
 
            deletions += 1
324
 
        else:
325
 
            new_path_list.append((path, file_id))
326
 
            if file_id not in old_entries:
327
 
                insertions += 1
328
 
    # Ensure no file is added before its parent
329
 
    new_path_list.sort()
330
 
    for path, file_id in new_path_list:
331
 
        if path == '':
332
 
            parent = None
333
 
        else:
334
 
            parent = by_path[os.path.dirname(path)]
335
 
        kind = bzrlib.osutils.file_kind(os.path.join(root, path))
336
 
        new_inventory[file_id] = (path, file_id, parent, kind)
337
 
        by_path[path] = file_id 
338
 
 
339
 
    # Get a list in insertion order
340
 
    new_inventory_list = new_inventory.values()
341
 
    mutter ("""Inventory regeneration:
342
 
old length: %i insertions: %i deletions: %i new_length: %i"""\
343
 
        % (len(old_entries), insertions, deletions, len(new_inventory_list)))
344
 
    assert len(new_inventory_list) == len(old_entries) + insertions - deletions
345
 
    new_inventory_list.sort()
346
 
    return new_inventory_list
347
 
 
348
 
merge_types = {     "merge3": (ApplyMerge3, "Native diff3-style merge"), 
349
 
                     "diff3": (Diff3Merge,  "Merge using external diff3")
350
 
              }
351