~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

  • Committer: Martin Pool
  • Date: 2005-07-29 19:54:01 UTC
  • Revision ID: mbp@sourcefrog.net-20050729195401-d5191bc202f55b27
- import a version of luke's emacs hooks

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 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):
 
169
    """Merge changes into a tree.
 
170
 
 
171
    base_revision
 
172
        Base for three-way merge.
 
173
    other_revision
 
174
        Other revision for three-way merge.
 
175
    this_dir
 
176
        Directory to merge changes into; '.' by default.
 
177
    check_clean
 
178
        If true, this_dir must have no uncommitted changes before the
 
179
        merge begins.
 
180
    """
 
181
    tempdir = tempfile.mkdtemp(prefix="bzr-")
 
182
    try:
 
183
        if this_dir is None:
 
184
            this_dir = '.'
 
185
        this_branch = find_branch(this_dir)
 
186
        if check_clean:
 
187
            changes = compare_trees(this_branch.working_tree(), 
 
188
                                    this_branch.basis_tree(), False)
 
189
            if changes.has_changed():
 
190
                raise BzrCommandError("Working tree has uncommitted changes.")
 
191
        other_branch, other_tree = get_tree(other_revision, tempdir, "other")
 
192
        if base_revision == [None, None]:
 
193
            if other_revision[1] == -1:
 
194
                o_revno = None
 
195
            else:
 
196
                o_revno = other_revision[1]
 
197
            base_revno = this_branch.common_ancestor(other_branch, 
 
198
                                                     other_revno=o_revno)[0]
 
199
            if base_revno is None:
 
200
                raise UnrelatedBranches()
 
201
            base_revision = ['.', base_revno]
 
202
        base_branch, base_tree = get_tree(base_revision, tempdir, "base")
 
203
        merge_inner(this_branch, other_tree, base_tree, tempdir, 
 
204
                    ignore_zero=ignore_zero)
 
205
    finally:
 
206
        shutil.rmtree(tempdir)
 
207
 
 
208
 
 
209
def generate_cset_optimized(tree_a, tree_b, inventory_a, inventory_b):
 
210
    """Generate a changeset, using the text_id to mark really-changed files.
 
211
    This permits blazing comparisons when text_ids are present.  It also
 
212
    disables metadata comparison for files with identical texts.
 
213
    """ 
 
214
    for file_id in tree_a.tree.inventory:
 
215
        if file_id not in tree_b.tree.inventory:
 
216
            continue
 
217
        entry_a = tree_a.tree.inventory[file_id]
 
218
        entry_b = tree_b.tree.inventory[file_id]
 
219
        if (entry_a.kind, entry_b.kind) != ("file", "file"):
 
220
            continue
 
221
        if None in (entry_a.text_id, entry_b.text_id):
 
222
            continue
 
223
        if entry_a.text_id != entry_b.text_id:
 
224
            continue
 
225
        inventory_a[abspath(tree_a.tree, file_id)].interesting = False
 
226
        inventory_b[abspath(tree_b.tree, file_id)].interesting = False
 
227
    cset =  generate_changeset(tree_a, tree_b, inventory_a, inventory_b)
 
228
    for entry in cset.entries.itervalues():
 
229
        entry.metadata_change = None
 
230
    return cset
 
231
 
 
232
 
 
233
def merge_inner(this_branch, other_tree, base_tree, tempdir, 
 
234
                ignore_zero=False):
 
235
    this_tree = get_tree((this_branch.base, None), tempdir, "this")[1]
 
236
 
 
237
    def get_inventory(tree):
 
238
        return tree.inventory
 
239
 
 
240
    inv_changes = merge_flex(this_tree, base_tree, other_tree,
 
241
                             generate_cset_optimized, get_inventory,
 
242
                             MergeConflictHandler(base_tree.root,
 
243
                                                  ignore_zero=ignore_zero))
 
244
 
 
245
    adjust_ids = []
 
246
    for id, path in inv_changes.iteritems():
 
247
        if path is not None:
 
248
            if path == '.':
 
249
                path = ''
 
250
            else:
 
251
                assert path.startswith('./')
 
252
            path = path[2:]
 
253
        adjust_ids.append((path, id))
 
254
    this_branch.set_inventory(regen_inventory(this_branch, this_tree.root, adjust_ids))
 
255
 
 
256
 
 
257
def regen_inventory(this_branch, root, new_entries):
 
258
    old_entries = this_branch.read_working_inventory()
 
259
    new_inventory = {}
 
260
    by_path = {}
 
261
    for file_id in old_entries:
 
262
        entry = old_entries[file_id]
 
263
        path = old_entries.id2path(file_id)
 
264
        new_inventory[file_id] = (path, file_id, entry.parent_id, entry.kind)
 
265
        by_path[path] = file_id
 
266
    
 
267
    deletions = 0
 
268
    insertions = 0
 
269
    new_path_list = []
 
270
    for path, file_id in new_entries:
 
271
        if path is None:
 
272
            del new_inventory[file_id]
 
273
            deletions += 1
 
274
        else:
 
275
            new_path_list.append((path, file_id))
 
276
            if file_id not in old_entries:
 
277
                insertions += 1
 
278
    # Ensure no file is added before its parent
 
279
    new_path_list.sort()
 
280
    for path, file_id in new_path_list:
 
281
        if path == '':
 
282
            parent = None
 
283
        else:
 
284
            parent = by_path[os.path.dirname(path)]
 
285
        kind = bzrlib.osutils.file_kind(os.path.join(root, path))
 
286
        new_inventory[file_id] = (path, file_id, parent, kind)
 
287
        by_path[path] = file_id 
 
288
 
 
289
    # Get a list in insertion order
 
290
    new_inventory_list = new_inventory.values()
 
291
    mutter ("""Inventory regeneration:
 
292
old length: %i insertions: %i deletions: %i new_length: %i"""\
 
293
        % (len(old_entries), insertions, deletions, len(new_inventory_list)))
 
294
    assert len(new_inventory_list) == len(old_entries) + insertions - deletions
 
295
    new_inventory_list.sort()
 
296
    return new_inventory_list