~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

  • Committer: Martin Pool
  • Date: 2005-06-22 06:38:18 UTC
  • Revision ID: mbp@sourcefrog.net-20050622063818-cd8d21b14bd4b636
- add plugin patch, still being integrated

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
 
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 finalize(self):
 
84
        if not self.ignore_zero:
 
85
            print "%d conflicts encountered.\n" % self.conflicts
 
86
            
 
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):
 
99
    location, revno = treespec
 
100
    branch = find_branch(location)
 
101
    if revno is None:
 
102
        base_tree = branch.working_tree()
 
103
    elif revno == -1:
 
104
        base_tree = branch.basis_tree()
 
105
    else:
 
106
        base_tree = branch.revision_tree(branch.lookup_revision(revno))
 
107
    temp_path = os.path.join(temp_root, label)
 
108
    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
 
117
 
 
118
def file_exists(tree, file_id):
 
119
    return tree.has_filename(tree.id2path(file_id))
 
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
 
 
130
 
 
131
class MergeTree(object):
 
132
    def __init__(self, tree, tempdir):
 
133
        object.__init__(self)
 
134
        if hasattr(tree, "basedir"):
 
135
            self.root = tree.basedir
 
136
        else:
 
137
            self.root = None
 
138
        self.inventory = inventory_map(tree)
 
139
        self.tree = tree
 
140
        self.tempdir = tempdir
 
141
        os.mkdir(os.path.join(self.tempdir, "texts"))
 
142
        self.cached = {}
 
143
 
 
144
    def readonly_path(self, id):
 
145
        if self.root is not None:
 
146
            return self.tree.abspath(self.tree.id2path(id))
 
147
        else:
 
148
            if self.tree.inventory[id].kind in ("directory", "root_directory"):
 
149
                return self.tempdir
 
150
            if not self.cached.has_key(id):
 
151
                path = os.path.join(self.tempdir, "texts", id)
 
152
                outfile = file(path, "wb")
 
153
                outfile.write(self.tree.get_file(id).read())
 
154
                assert(os.path.exists(path))
 
155
                self.cached[id] = path
 
156
            return self.cached[id]
 
157
 
 
158
 
 
159
 
 
160
def merge(other_revision, base_revision,
 
161
          check_clean=True, ignore_zero=False,
 
162
          this_dir=None):
 
163
    """Merge changes into a tree.
 
164
 
 
165
    base_revision
 
166
        Base for three-way merge.
 
167
    other_revision
 
168
        Other revision for three-way merge.
 
169
    this_dir
 
170
        Directory to merge changes into; '.' by default.
 
171
    check_clean
 
172
        If true, this_dir must have no uncommitted changes before the
 
173
        merge begins.
 
174
    """
 
175
    tempdir = tempfile.mkdtemp(prefix="bzr-")
 
176
    try:
 
177
        if this_dir is None:
 
178
            this_dir = '.'
 
179
        this_branch = find_branch(this_dir)
 
180
        if check_clean:
 
181
            changes = compare_trees(this_branch.working_tree(), 
 
182
                                    this_branch.basis_tree(), False)
 
183
            if changes.has_changed():
 
184
                raise BzrCommandError("Working tree has uncommitted changes.")
 
185
        other_branch, other_tree = get_tree(other_revision, tempdir, "other")
 
186
        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:
 
194
                raise UnrelatedBranches()
 
195
            base_revision = ['.', base_revno]
 
196
        base_branch, base_tree = get_tree(base_revision, tempdir, "base")
 
197
        merge_inner(this_branch, other_tree, base_tree, tempdir, 
 
198
                    ignore_zero=ignore_zero)
 
199
    finally:
 
200
        shutil.rmtree(tempdir)
 
201
 
 
202
 
 
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.
 
207
    """ 
 
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)
 
222
    for entry in cset.entries.itervalues():
 
223
        entry.metadata_change = None
 
224
    return cset
 
225
 
 
226
 
 
227
def merge_inner(this_branch, other_tree, base_tree, tempdir, 
 
228
                ignore_zero=False):
 
229
    this_tree = get_tree((this_branch.base, None), tempdir, "this")[1]
 
230
 
 
231
    def get_inventory(tree):
 
232
        return tree.inventory
 
233
 
 
234
    inv_changes = merge_flex(this_tree, base_tree, other_tree,
 
235
                             generate_cset_optimized, get_inventory,
 
236
                             MergeConflictHandler(base_tree.root,
 
237
                                                  ignore_zero=ignore_zero))
 
238
 
 
239
    adjust_ids = []
 
240
    for id, path in inv_changes.iteritems():
 
241
        if path is not None:
 
242
            if path == '.':
 
243
                path = ''
 
244
            else:
 
245
                assert path.startswith('./')
 
246
            path = path[2:]
 
247
        adjust_ids.append((path, id))
 
248
    this_branch.set_inventory(regen_inventory(this_branch, this_tree.root, adjust_ids))
 
249
 
 
250
 
 
251
def regen_inventory(this_branch, root, new_entries):
 
252
    old_entries = this_branch.read_working_inventory()
 
253
    new_inventory = {}
 
254
    by_path = {}
 
255
    for file_id in old_entries:
 
256
        entry = old_entries[file_id]
 
257
        path = old_entries.id2path(file_id)
 
258
        new_inventory[file_id] = (path, file_id, entry.parent_id, entry.kind)
 
259
        by_path[path] = file_id
 
260
    
 
261
    deletions = 0
 
262
    insertions = 0
 
263
    new_path_list = []
 
264
    for path, file_id in new_entries:
 
265
        if path is None:
 
266
            del new_inventory[file_id]
 
267
            deletions += 1
 
268
        else:
 
269
            new_path_list.append((path, file_id))
 
270
            if file_id not in old_entries:
 
271
                insertions += 1
 
272
    # Ensure no file is added before its parent
 
273
    new_path_list.sort()
 
274
    for path, file_id in new_path_list:
 
275
        if path == '':
 
276
            parent = None
 
277
        else:
 
278
            parent = by_path[os.path.dirname(path)]
 
279
        kind = bzrlib.osutils.file_kind(os.path.join(root, path))
 
280
        new_inventory[file_id] = (path, file_id, parent, kind)
 
281
        by_path[path] = file_id 
 
282
 
 
283
    # Get a list in insertion order
 
284
    new_inventory_list = new_inventory.values()
 
285
    mutter ("""Inventory regeneration:
 
286
old length: %i insertions: %i deletions: %i new_length: %i"""\
 
287
        % (len(old_entries), insertions, deletions, len(new_inventory_list)))
 
288
    assert len(new_inventory_list) == len(old_entries) + insertions - deletions
 
289
    new_inventory_list.sort()
 
290
    return new_inventory_list