← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

  • Committer: Martin Pool
  • Date: 2005-09-05 09:27:11 UTC
  • Revision ID: mbp@sourcefrog.net-20050905092711-f9f5bded3fd82605
- more disentangling of xml storage format from objects

- remove pack_xml and unpack_xml function in favor of 
  serializer object

- test unpacking canned revision xml

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/merge.py
 
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
 
 
18
import os.path
 
19
import tempfile
 
20
import shutil
 
21
import errno
 
22
from fetch import greedy_fetch
 
23
 
 
24
import bzrlib.osutils
 
25
import bzrlib.revision
1
26
from bzrlib.merge_core import merge_flex, ApplyMerge3, BackupBeforeChange
2
27
from bzrlib.changeset import generate_changeset, ExceptionConflictHandler
3
28
from bzrlib.changeset import Inventory, Diff3Merge
4
 
from bzrlib import find_branch
5
 
import bzrlib.osutils
6
 
from bzrlib.errors import BzrCommandError
 
29
from bzrlib.branch import find_branch
 
30
from bzrlib.errors import BzrCommandError, UnrelatedBranches
7
31
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
 
 
 
32
from bzrlib.trace import mutter, warning
 
33
from bzrlib.fetch import greedy_fetch
 
34
from bzrlib.revision import is_ancestor
14
35
 
15
36
# comments from abentley on irc: merge happens in two stages, each
16
37
# of which generates a changeset object
18
39
# stage 1: generate OLD->OTHER,
19
40
# stage 2: use MINE and OLD->OTHER to generate MINE -> RESULT
20
41
 
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
42
class MergeConflictHandler(ExceptionConflictHandler):
29
43
    """Handle conflicts encountered while merging.
30
44
 
48
62
            d_file.write(line)
49
63
        os.chmod(dest, 0777 & os.stat(source).st_mode)
50
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
 
51
74
    def add_suffix(self, name, suffix, last_new_name=None):
52
75
        """Rename a file to append a suffix.  If the new name exists, the
53
76
        suffix is added repeatedly until a non-existant name is found
72
95
        self.conflicts += 1
73
96
        
74
97
 
75
 
    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):
76
99
        """
77
100
        Handle diff3 conflicts by producing a .THIS, .BASE and .OTHER.  The
78
101
        main file will be a version with diff3 conflicts.
82
105
        :param other_path: Path to the file text for the OTHER tree
83
106
        """
84
107
        self.add_suffix(this_path, ".THIS")
85
 
        self.copy(base_path, this_path+".BASE")
86
 
        self.copy(other_path, this_path+".OTHER")
 
108
        self.dump(base_lines, this_path+".BASE")
 
109
        self.dump(other_lines, this_path+".OTHER")
87
110
        os.rename(new_file, this_path)
88
111
        self.conflict("Diff3 conflict encountered in %s" % this_path)
89
112
 
108
131
        if not self.ignore_zero:
109
132
            print "%d conflicts encountered.\n" % self.conflicts
110
133
            
111
 
class SourceFile(object):
112
 
    def __init__(self, path, id, present=None, isdir=None):
113
 
        self.path = path
114
 
        self.id = id
115
 
        self.present = present
116
 
        self.isdir = isdir
117
 
        self.interesting = True
118
 
 
119
 
    def __repr__(self):
120
 
        return "SourceFile(%s, %s)" % (self.path, self.id)
121
 
 
122
 
def get_tree(treespec, temp_root, label):
 
134
def get_tree(treespec, temp_root, label, local_branch=None):
123
135
    location, revno = treespec
124
136
    branch = find_branch(location)
125
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:
126
148
        base_tree = branch.working_tree()
127
 
    elif revno == -1:
128
 
        base_tree = branch.basis_tree()
129
149
    else:
130
 
        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)
131
155
    temp_path = os.path.join(temp_root, label)
132
156
    os.mkdir(temp_path)
133
 
    return branch, MergeTree(base_tree, temp_path)
134
 
 
135
 
 
136
 
def abspath(tree, file_id):
137
 
    path = tree.inventory.id2path(file_id)
138
 
    if path == "":
139
 
        return "./."
140
 
    return "./" + path
 
157
    return MergeTree(base_tree, temp_path)
 
158
 
141
159
 
142
160
def file_exists(tree, file_id):
143
161
    return tree.has_filename(tree.id2path(file_id))
144
162
    
145
 
def inventory_map(tree):
146
 
    inventory = {}
147
 
    for file_id in tree.inventory:
148
 
        path = abspath(tree, file_id)
149
 
        inventory[path] = SourceFile(path, file_id)
150
 
    return inventory
151
 
 
152
163
 
153
164
class MergeTree(object):
154
165
    def __init__(self, tree, tempdir):
157
168
            self.root = tree.basedir
158
169
        else:
159
170
            self.root = None
160
 
        self.inventory = inventory_map(tree)
161
171
        self.tree = tree
162
172
        self.tempdir = tempdir
163
173
        os.mkdir(os.path.join(self.tempdir, "texts"))
164
174
        self.cached = {}
165
175
 
 
176
    def __iter__(self):
 
177
        return self.tree.__iter__()
 
178
 
166
179
    def __contains__(self, file_id):
167
 
        return id in self.tree
 
180
        return file_id in self.tree
 
181
 
 
182
    def get_file(self, file_id):
 
183
        return self.tree.get_file(file_id)
168
184
 
169
185
    def get_file_sha1(self, id):
170
186
        return self.tree.get_file_sha1(id)
171
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
 
172
204
    def readonly_path(self, id):
173
205
        if id not in self.tree:
174
206
            return None
194
226
    """Merge changes into a tree.
195
227
 
196
228
    base_revision
197
 
        Base for three-way merge.
 
229
        tuple(path, revision) Base for three-way merge.
198
230
    other_revision
199
 
        Other revision for three-way merge.
 
231
        tuple(path, revision) Other revision for three-way merge.
200
232
    this_dir
201
233
        Directory to merge changes into; '.' by default.
202
234
    check_clean
203
235
        If true, this_dir must have no uncommitted changes before the
204
236
        merge begins.
 
237
    all available ancestors of other_revision and base_revision are
 
238
    automatically pulled into the branch.
205
239
    """
 
240
    from bzrlib.revision import common_ancestor, MultipleRevisionSources
 
241
    from bzrlib.errors import NoSuchRevision
206
242
    tempdir = tempfile.mkdtemp(prefix="bzr-")
207
243
    try:
208
244
        if this_dir is None:
209
245
            this_dir = '.'
210
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")
211
250
        if check_clean:
212
251
            changes = compare_trees(this_branch.working_tree(), 
213
252
                                    this_branch.basis_tree(), False)
214
253
            if changes.has_changed():
215
254
                raise BzrCommandError("Working tree has uncommitted changes.")
216
 
        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()
217
266
        if base_revision == [None, None]:
218
 
            if other_revision[1] == -1:
219
 
                o_revno = None
220
 
            else:
221
 
                o_revno = other_revision[1]
222
 
            base_revno = this_branch.common_ancestor(other_branch, 
223
 
                                                     other_revno=o_revno)[0]
224
 
            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:
225
270
                raise UnrelatedBranches()
226
 
            base_revision = ['.', base_revno]
227
 
        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
228
288
        if file_list is None:
229
289
            interesting_ids = None
230
290
        else:
244
304
        merge_inner(this_branch, other_tree, base_tree, tempdir, 
245
305
                    ignore_zero=ignore_zero, backup_files=backup_files, 
246
306
                    merge_type=merge_type, interesting_ids=interesting_ids)
 
307
        if base_is_ancestor and other_rev_id is not None\
 
308
            and other_rev_id not in this_branch.revision_history():
 
309
            this_branch.add_pending_merge(other_rev_id)
247
310
    finally:
248
311
        shutil.rmtree(tempdir)
249
312
 
256
319
             source_file.interesting = source_file.id in interesting_ids
257
320
 
258
321
 
259
 
def generate_cset_optimized(tree_a, tree_b, inventory_a, inventory_b,
260
 
                            interesting_ids=None):
 
322
def generate_cset_optimized(tree_a, tree_b, interesting_ids=None):
261
323
    """Generate a changeset.  If interesting_ids is supplied, only changes
262
324
    to those files will be shown.  Metadata changes are stripped.
263
325
    """ 
264
 
    if interesting_ids is not None:
265
 
        set_interesting(inventory_a, inventory_b, interesting_ids)
266
 
    cset =  generate_changeset(tree_a, tree_b, inventory_a, inventory_b)
 
326
    cset =  generate_changeset(tree_a, tree_b, interesting_ids)
267
327
    for entry in cset.entries.itervalues():
268
328
        entry.metadata_change = None
269
329
    return cset
273
333
                ignore_zero=False, merge_type=ApplyMerge3, backup_files=False,
274
334
                interesting_ids=None):
275
335
 
276
 
    def merge_factory(base_file, other_file):
277
 
        contents_change = merge_type(base_file, other_file)
 
336
    def merge_factory(file_id, base, other):
 
337
        contents_change = merge_type(file_id, base, other)
278
338
        if backup_files:
279
339
            contents_change = BackupBeforeChange(contents_change)
280
340
        return contents_change
281
 
    
282
 
    def generate_cset(tree_a, tree_b, inventory_a, inventory_b):
283
 
        return generate_cset_optimized(tree_a, tree_b, inventory_a, inventory_b,
284
 
                                       interesting_ids)
285
341
 
286
342
    this_tree = get_tree((this_branch.base, None), tempdir, "this")[1]
287
343
 
288
344
    def get_inventory(tree):
289
 
        return tree.inventory
 
345
        return tree.tree.inventory
290
346
 
291
347
    inv_changes = merge_flex(this_tree, base_tree, other_tree,
292
 
                             generate_cset, get_inventory,
 
348
                             generate_cset_optimized, get_inventory,
293
349
                             MergeConflictHandler(base_tree.root,
294
350
                                                  ignore_zero=ignore_zero),
295
 
                             merge_factory=merge_factory)
 
351
                             merge_factory=merge_factory, 
 
352
                             interesting_ids=interesting_ids)
296
353
 
297
354
    adjust_ids = []
298
355
    for id, path in inv_changes.iteritems():
300
357
            if path == '.':
301
358
                path = ''
302
359
            else:
303
 
                assert path.startswith('./')
 
360
                assert path.startswith('./'), "path is %s" % path
304
361
            path = path[2:]
305
362
        adjust_ids.append((path, id))
306
363
    if len(adjust_ids) > 0:
312
369
    old_entries = this_branch.read_working_inventory()
313
370
    new_inventory = {}
314
371
    by_path = {}
 
372
    new_entries_map = {} 
 
373
    for path, file_id in new_entries:
 
374
        if path is None:
 
375
            continue
 
376
        new_entries_map[file_id] = path
 
377
 
 
378
    def id2path(file_id):
 
379
        path = new_entries_map.get(file_id)
 
380
        if path is not None:
 
381
            return path
 
382
        entry = old_entries[file_id]
 
383
        if entry.parent_id is None:
 
384
            return entry.name
 
385
        return os.path.join(id2path(entry.parent_id), entry.name)
 
386
        
315
387
    for file_id in old_entries:
316
388
        entry = old_entries[file_id]
317
 
        path = old_entries.id2path(file_id)
 
389
        path = id2path(file_id)
318
390
        new_inventory[file_id] = (path, file_id, entry.parent_id, entry.kind)
319
391
        by_path[path] = file_id
320
392