~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

  • Committer: Martin Pool
  • Date: 2005-08-22 16:31:16 UTC
  • Revision ID: mbp@sourcefrog.net-20050822163116-935a433f338e7d5b
- new shell-complete command to help zsh completion

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