~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

  • Committer: Aaron Bentley
  • Date: 2005-10-20 02:57:55 UTC
  • mto: (1185.25.1)
  • mto: This revision was merged to the branch mainline in revision 1474.
  • Revision ID: aaron.bentley@utoronto.ca-20051020025755-e03df41c52aa3156
tweaked spacing

Show diffs side-by-side

added added

removed removed

Lines of Context:
19
19
import tempfile
20
20
import shutil
21
21
import errno
22
 
from fetch import greedy_fetch
23
22
 
24
23
import bzrlib.osutils
25
24
import bzrlib.revision
26
25
from bzrlib.merge_core import merge_flex, ApplyMerge3, BackupBeforeChange
27
26
from bzrlib.changeset import generate_changeset, ExceptionConflictHandler
28
 
from bzrlib.changeset import Inventory, Diff3Merge
 
27
from bzrlib.changeset import Inventory, Diff3Merge, ReplaceContents
29
28
from bzrlib.branch import Branch
30
29
from bzrlib.errors import BzrCommandError, UnrelatedBranches, NoCommonAncestor
31
30
from bzrlib.errors import NoCommits
32
31
from bzrlib.delta import compare_trees
33
 
from bzrlib.trace import mutter, warning
34
 
from bzrlib.fetch import greedy_fetch
 
32
from bzrlib.trace import mutter, warning, note
 
33
from bzrlib.fetch import greedy_fetch, fetch
35
34
from bzrlib.revision import is_ancestor
 
35
from bzrlib.osutils import rename
 
36
from bzrlib.revision import common_ancestor, MultipleRevisionSources
 
37
from bzrlib.errors import NoSuchRevision
 
38
 
 
39
# TODO: build_working_dir can be built on something simpler than merge()
 
40
 
 
41
# FIXME: merge() parameters seem oriented towards the command line
 
42
# NOTABUG: merge is a helper for commandline functions.  merge_inner is the
 
43
#          the core functionality.
36
44
 
37
45
# comments from abentley on irc: merge happens in two stages, each
38
46
# of which generates a changeset object
47
55
    conflict that are not explicitly handled cause an exception and
48
56
    terminate the merge.
49
57
    """
50
 
    def __init__(self, ignore_zero=False):
 
58
    def __init__(self, this_tree, base_tree, other_tree, ignore_zero=False):
51
59
        ExceptionConflictHandler.__init__(self)
52
60
        self.conflicts = 0
53
61
        self.ignore_zero = ignore_zero
 
62
        self.this_tree = this_tree
 
63
        self.base_tree = base_tree
 
64
        self.other_tree = other_tree
54
65
 
55
66
    def copy(self, source, dest):
56
67
        """Copy the text and mode of a file
84
95
            last_new_name = name
85
96
        new_name = last_new_name+suffix
86
97
        try:
87
 
            os.rename(name, new_name)
 
98
            rename(name, new_name)
88
99
            return new_name
89
100
        except OSError, e:
90
101
            if e.errno != errno.EEXIST and e.errno != errno.ENOTEMPTY:
108
119
        self.add_suffix(this_path, ".THIS")
109
120
        self.dump(base_lines, this_path+".BASE")
110
121
        self.dump(other_lines, this_path+".OTHER")
111
 
        os.rename(new_file, this_path)
 
122
        rename(new_file, this_path)
112
123
        self.conflict("Diff3 conflict encountered in %s" % this_path)
113
124
 
114
125
    def new_contents_conflict(self, filename, other_contents):
115
126
        """Conflicting contents for newly added file."""
116
 
        self.copy(other_contents, filename + ".OTHER")
 
127
        other_contents(filename + ".OTHER", self, False)
117
128
        self.conflict("Conflict in newly added file %s" % filename)
118
129
    
119
130
 
128
139
            % filename)
129
140
        return "skip"
130
141
 
 
142
    def rem_contents_conflict(self, filename, this_contents, base_contents):
 
143
        base_contents(filename+".BASE", self, False)
 
144
        this_contents(filename+".THIS", self, False)
 
145
        return ReplaceContents(this_contents, None)
 
146
 
 
147
    def rem_contents_conflict(self, filename, this_contents, base_contents):
 
148
        base_contents(filename+".BASE", self, False)
 
149
        this_contents(filename+".THIS", self, False)
 
150
        self.conflict("Other branch deleted locally modified file %s" %
 
151
                      filename)
 
152
        return ReplaceContents(this_contents, None)
 
153
 
 
154
    def abs_this_path(self, file_id):
 
155
        """Return the absolute path for a file_id in the this tree."""
 
156
        return self.this_tree.id2abspath(file_id)
 
157
 
 
158
    def add_missing_parents(self, file_id, tree):
 
159
        """If some of the parents for file_id are missing, add them."""
 
160
        entry = tree.inventory[file_id]
 
161
        if entry.parent_id not in self.this_tree:
 
162
            return self.create_all_missing(entry.parent_id, tree)
 
163
        else:
 
164
            return self.abs_this_path(entry.parent_id)
 
165
 
 
166
    def create_all_missing(self, file_id, tree):
 
167
        """Add contents for a file_id and all its parents to a tree."""
 
168
        entry = tree.inventory[file_id]
 
169
        if entry.parent_id is not None and entry.parent_id not in self.this_tree:
 
170
            abspath = self.create_all_missing(entry.parent_id, tree)
 
171
        else:
 
172
            abspath = self.abs_this_path(entry.parent_id)
 
173
        entry_path = os.path.join(abspath, entry.name)
 
174
        if not os.path.isdir(entry_path):
 
175
            self.create(file_id, entry_path, tree)
 
176
        return entry_path
 
177
 
 
178
    def create(self, file_id, path, tree, reverse=False):
 
179
        """Uses tree data to create a filesystem object for the file_id"""
 
180
        from changeset import get_contents
 
181
        get_contents(tree, file_id)(path, self, reverse)
 
182
 
 
183
    def missing_for_merge(self, file_id, other_path):
 
184
        """The file_id doesn't exist in THIS, but does in OTHER and BASE"""
 
185
        self.conflict("Other branch modified locally deleted file %s" %
 
186
                      other_path)
 
187
        parent_dir = self.add_missing_parents(file_id, self.other_tree)
 
188
        stem = os.path.join(parent_dir, os.path.basename(other_path))
 
189
        self.create(file_id, stem+".OTHER", self.other_tree)
 
190
        self.create(file_id, stem+".BASE", self.base_tree)
 
191
 
 
192
    def threeway_contents_conflict(filename, this_contents, base_contents,
 
193
                                   other_contents):
 
194
        self.conflict("Three-way conflict merging %s" % filename)
 
195
 
131
196
    def finalize(self):
132
197
        if not self.ignore_zero:
133
 
            print "%d conflicts encountered.\n" % self.conflicts
 
198
            note("%d conflicts encountered.\n" % self.conflicts)
134
199
            
135
 
def get_tree(treespec, temp_root, label, local_branch=None):
 
200
def get_tree(treespec, local_branch=None):
136
201
    location, revno = treespec
137
 
    branch = Branch.open(location)
 
202
    branch = Branch.open_containing(location)[0]
138
203
    if revno is None:
139
204
        revision = None
140
205
    elif revno == -1:
141
 
        revision = branch.last_patch()
 
206
        revision = branch.last_revision()
142
207
    else:
143
208
        revision = branch.get_rev_id(revno)
144
 
    return branch, get_revid_tree(branch, revision, temp_root, label,
145
 
                                  local_branch)
 
209
    return branch, get_revid_tree(branch, revision, local_branch)
146
210
 
147
 
def get_revid_tree(branch, revision, temp_root, label, local_branch):
 
211
def get_revid_tree(branch, revision, local_branch):
148
212
    if revision is None:
149
213
        base_tree = branch.working_tree()
150
214
    else:
153
217
            base_tree = local_branch.revision_tree(revision)
154
218
        else:
155
219
            base_tree = branch.revision_tree(revision)
156
 
    temp_path = os.path.join(temp_root, label)
157
 
    os.mkdir(temp_path)
158
 
    return MergeTree(base_tree, temp_path)
 
220
    return base_tree
159
221
 
160
222
 
161
223
def file_exists(tree, file_id):
162
224
    return tree.has_filename(tree.id2path(file_id))
163
225
    
164
226
 
165
 
class MergeTree(object):
166
 
    def __init__(self, tree, tempdir):
167
 
        object.__init__(self)
168
 
        if hasattr(tree, "basedir"):
169
 
            self.root = tree.basedir
170
 
        else:
171
 
            self.root = None
172
 
        self.tree = tree
173
 
        self.tempdir = tempdir
174
 
        os.mkdir(os.path.join(self.tempdir, "texts"))
175
 
        self.cached = {}
176
 
 
177
 
    def __iter__(self):
178
 
        return self.tree.__iter__()
179
 
 
180
 
    def __contains__(self, file_id):
181
 
        return file_id in self.tree
182
 
 
183
 
    def get_file(self, file_id):
184
 
        return self.tree.get_file(file_id)
185
 
 
186
 
    def get_file_sha1(self, id):
187
 
        return self.tree.get_file_sha1(id)
188
 
 
189
 
    def id2path(self, file_id):
190
 
        return self.tree.id2path(file_id)
191
 
 
192
 
    def has_id(self, file_id):
193
 
        return self.tree.has_id(file_id)
194
 
 
195
 
    def has_or_had_id(self, file_id):
196
 
        if file_id == self.tree.inventory.root.file_id:
197
 
            return True
198
 
        return self.tree.inventory.has_id(file_id)
199
 
 
200
 
    def has_or_had_id(self, file_id):
201
 
        if file_id == self.tree.inventory.root.file_id:
202
 
            return True
203
 
        return self.tree.inventory.has_id(file_id)
204
 
 
205
 
    def readonly_path(self, id):
206
 
        if id not in self.tree:
207
 
            return None
208
 
        if self.root is not None:
209
 
            return self.tree.abspath(self.tree.id2path(id))
210
 
        else:
211
 
            if self.tree.inventory[id].kind in ("directory", "root_directory"):
212
 
                return self.tempdir
213
 
            if not self.cached.has_key(id):
214
 
                path = os.path.join(self.tempdir, "texts", id)
215
 
                outfile = file(path, "wb")
216
 
                outfile.write(self.tree.get_file(id).read())
217
 
                assert(os.path.exists(path))
218
 
                self.cached[id] = path
219
 
            return self.cached[id]
220
 
 
 
227
def build_working_dir(to_dir):
 
228
    """Build a working directory in an empty directory.
 
229
 
 
230
    to_dir is a directory containing branch metadata but no working files,
 
231
    typically constructed by cloning an existing branch. 
 
232
 
 
233
    This is split out as a special idiomatic case of merge.  It could
 
234
    eventually be done by just building the tree directly calling into 
 
235
    lower-level code (e.g. constructing a changeset).
 
236
    """
 
237
    # RBC 20051019 is this not just 'export' ?
 
238
    merge((to_dir, -1), (to_dir, 0), this_dir=to_dir,
 
239
          check_clean=False, ignore_zero=True)
221
240
 
222
241
 
223
242
def merge(other_revision, base_revision,
224
243
          check_clean=True, ignore_zero=False,
225
244
          this_dir=None, backup_files=False, merge_type=ApplyMerge3,
226
 
          file_list=None):
 
245
          file_list=None, show_base=False):
227
246
    """Merge changes into a tree.
228
247
 
229
248
    base_revision
235
254
    check_clean
236
255
        If true, this_dir must have no uncommitted changes before the
237
256
        merge begins.
238
 
    all available ancestors of other_revision and base_revision are
 
257
    ignore_zero - If true, suppress the "zero conflicts" message when 
 
258
        there are no conflicts; should be set when doing something we expect
 
259
        to complete perfectly.
 
260
 
 
261
    All available ancestors of other_revision and base_revision are
239
262
    automatically pulled into the branch.
240
263
    """
241
 
    from bzrlib.revision import common_ancestor, MultipleRevisionSources
242
 
    from bzrlib.errors import NoSuchRevision
243
 
    tempdir = tempfile.mkdtemp(prefix="bzr-")
244
 
    try:
245
 
        if this_dir is None:
246
 
            this_dir = '.'
247
 
        this_branch = Branch.open_containing(this_dir)
248
 
        this_rev_id = this_branch.last_patch()
249
 
        if this_rev_id is None:
250
 
            raise BzrCommandError("This branch has no commits")
251
 
        if check_clean:
252
 
            changes = compare_trees(this_branch.working_tree(), 
253
 
                                    this_branch.basis_tree(), False)
254
 
            if changes.has_changed():
255
 
                raise BzrCommandError("Working tree has uncommitted changes.")
256
 
        other_branch, other_tree = get_tree(other_revision, tempdir, "other",
257
 
                                            this_branch)
258
 
        if other_revision[1] == -1:
259
 
            other_rev_id = other_branch.last_patch()
260
 
            if other_rev_id is None:
261
 
                raise NoCommits(other_branch)
262
 
            other_basis = other_rev_id
263
 
        elif other_revision[1] is not None:
264
 
            other_rev_id = other_branch.get_rev_id(other_revision[1])
265
 
            other_basis = other_rev_id
266
 
        else:
267
 
            other_rev_id = None
268
 
            other_basis = other_branch.last_patch()
269
 
            if other_basis is None:
270
 
                raise NoCommits(other_branch)
271
 
        if base_revision == [None, None]:
272
 
            try:
273
 
                base_rev_id = common_ancestor(this_rev_id, other_basis, 
274
 
                                              this_branch)
275
 
            except NoCommonAncestor:
276
 
                raise UnrelatedBranches()
277
 
            base_tree = get_revid_tree(this_branch, base_rev_id, tempdir, 
278
 
                                       "base", None)
279
 
            base_is_ancestor = True
280
 
        else:
281
 
            base_branch, base_tree = get_tree(base_revision, tempdir, "base")
282
 
            if base_revision[1] == -1:
283
 
                base_rev_id = base_branch.last_patch()
284
 
            elif base_revision[1] is None:
285
 
                base_rev_id = None
286
 
            else:
287
 
                base_rev_id = base_branch.get_rev_id(base_revision[1])
288
 
            multi_source = MultipleRevisionSources(this_branch, base_branch)
289
 
            base_is_ancestor = is_ancestor(this_rev_id, base_rev_id,
290
 
                                           multi_source)
291
 
        if file_list is None:
292
 
            interesting_ids = None
293
 
        else:
294
 
            interesting_ids = set()
295
 
            this_tree = this_branch.working_tree()
296
 
            for fname in file_list:
297
 
                path = this_branch.relpath(fname)
298
 
                found_id = False
299
 
                for tree in (this_tree, base_tree.tree, other_tree.tree):
300
 
                    file_id = tree.inventory.path2id(path)
301
 
                    if file_id is not None:
302
 
                        interesting_ids.add(file_id)
303
 
                        found_id = True
304
 
                if not found_id:
305
 
                    raise BzrCommandError("%s is not a source file in any"
306
 
                                          " tree." % fname)
307
 
        merge_inner(this_branch, other_tree, base_tree, tempdir, 
308
 
                    ignore_zero=ignore_zero, backup_files=backup_files, 
309
 
                    merge_type=merge_type, interesting_ids=interesting_ids)
310
 
        if base_is_ancestor and other_rev_id is not None\
311
 
            and other_rev_id not in this_branch.revision_history():
312
 
            this_branch.add_pending_merge(other_rev_id)
313
 
    finally:
314
 
        shutil.rmtree(tempdir)
 
264
    if this_dir is None:
 
265
        this_dir = '.'
 
266
    this_branch = Branch.open_containing(this_dir)[0]
 
267
    this_rev_id = this_branch.last_revision()
 
268
    if this_rev_id is None:
 
269
        raise BzrCommandError("This branch has no commits")
 
270
    if check_clean:
 
271
        changes = compare_trees(this_branch.working_tree(), 
 
272
                                this_branch.basis_tree(), False)
 
273
        if changes.has_changed():
 
274
            raise BzrCommandError("Working tree has uncommitted changes.")
 
275
    other_branch, other_tree = get_tree(other_revision, this_branch)
 
276
    if other_revision[1] == -1:
 
277
        other_rev_id = other_branch.last_revision()
 
278
        if other_rev_id is None:
 
279
            raise NoCommits(other_branch)
 
280
        other_basis = other_rev_id
 
281
    elif other_revision[1] is not None:
 
282
        other_rev_id = other_branch.get_rev_id(other_revision[1])
 
283
        other_basis = other_rev_id
 
284
    else:
 
285
        other_rev_id = None
 
286
        other_basis = other_branch.last_revision()
 
287
        if other_basis is None:
 
288
            raise NoCommits(other_branch)
 
289
    if base_revision == [None, None]:
 
290
        try:
 
291
            base_rev_id = common_ancestor(this_rev_id, other_basis, 
 
292
                                          this_branch)
 
293
        except NoCommonAncestor:
 
294
            raise UnrelatedBranches()
 
295
        base_tree = get_revid_tree(this_branch, base_rev_id, None)
 
296
        base_is_ancestor = True
 
297
    else:
 
298
        base_branch, base_tree = get_tree(base_revision)
 
299
        if base_revision[1] == -1:
 
300
            base_rev_id = base_branch.last_revision()
 
301
        elif base_revision[1] is None:
 
302
            base_rev_id = None
 
303
        else:
 
304
            base_rev_id = base_branch.get_rev_id(base_revision[1])
 
305
        fetch(from_branch=base_branch, to_branch=this_branch)
 
306
        base_is_ancestor = is_ancestor(this_rev_id, base_rev_id,
 
307
                                       this_branch)
 
308
    if file_list is None:
 
309
        interesting_ids = None
 
310
    else:
 
311
        interesting_ids = set()
 
312
        this_tree = this_branch.working_tree()
 
313
        for fname in file_list:
 
314
            path = this_tree.relpath(fname)
 
315
            found_id = False
 
316
            for tree in (this_tree, base_tree, other_tree):
 
317
                file_id = tree.inventory.path2id(path)
 
318
                if file_id is not None:
 
319
                    interesting_ids.add(file_id)
 
320
                    found_id = True
 
321
            if not found_id:
 
322
                raise BzrCommandError("%s is not a source file in any"
 
323
                                      " tree." % fname)
 
324
    merge_inner(this_branch, other_tree, base_tree, tempdir=None, 
 
325
                ignore_zero=ignore_zero, backup_files=backup_files, 
 
326
                merge_type=merge_type, interesting_ids=interesting_ids,
 
327
                show_base=show_base)
 
328
    if base_is_ancestor and other_rev_id is not None\
 
329
        and other_rev_id not in this_branch.revision_history():
 
330
        this_branch.add_pending_merge(other_rev_id)
315
331
 
316
332
 
317
333
def set_interesting(inventory_a, inventory_b, interesting_ids):
322
338
             source_file.interesting = source_file.id in interesting_ids
323
339
 
324
340
 
325
 
def generate_cset_optimized(tree_a, tree_b, interesting_ids=None):
326
 
    """Generate a changeset.  If interesting_ids is supplied, only changes
327
 
    to those files will be shown.  Metadata changes are stripped.
328
 
    """ 
329
 
    cset =  generate_changeset(tree_a, tree_b, interesting_ids)
330
 
    for entry in cset.entries.itervalues():
331
 
        entry.metadata_change = None
332
 
    return cset
333
 
 
334
 
 
335
 
def merge_inner(this_branch, other_tree, base_tree, tempdir, 
336
 
                ignore_zero=False, merge_type=ApplyMerge3, backup_files=False,
337
 
                interesting_ids=None):
338
 
 
 
341
def merge_inner(this_branch, other_tree, base_tree, tempdir=None, 
 
342
                ignore_zero=False, merge_type=ApplyMerge3, backup_files=False,
 
343
                interesting_ids=None, show_base=False):
 
344
    """Primary interface for merging. 
 
345
 
 
346
    typical use is probably 
 
347
    'merge_inner(branch, branch.get_revision_tree(other_revision),
 
348
                 branch.get_revision_tree(base_revision))'
 
349
    """
 
350
    if tempdir is None:
 
351
        _tempdir = tempfile.mkdtemp(prefix="bzr-")
 
352
    else:
 
353
        _tempdir = tempdir
 
354
    try:
 
355
        _merge_inner(this_branch, other_tree, base_tree, _tempdir,
 
356
                     ignore_zero, merge_type, backup_files, interesting_ids,
 
357
                     show_base=show_base)
 
358
    finally:
 
359
        if tempdir is None:
 
360
            shutil.rmtree(_tempdir)
 
361
 
 
362
 
 
363
def _merge_inner(this_branch, other_tree, base_tree, user_tempdir, 
 
364
                ignore_zero=False, merge_type=ApplyMerge3, backup_files=False,
 
365
                interesting_ids=None, show_base=False):
339
366
    def merge_factory(file_id, base, other):
340
 
        contents_change = merge_type(file_id, base, other)
 
367
        if show_base is True:
 
368
            contents_change = merge_type(file_id, base, other, show_base=True)
 
369
        else:
 
370
            contents_change = merge_type(file_id, base, other)
341
371
        if backup_files:
342
372
            contents_change = BackupBeforeChange(contents_change)
343
373
        return contents_change
344
374
 
345
 
    this_tree = get_tree((this_branch.base, None), tempdir, "this")[1]
 
375
    this_tree = get_tree((this_branch.base, None))[1]
346
376
 
347
377
    def get_inventory(tree):
348
 
        return tree.tree.inventory
 
378
        return tree.inventory
349
379
 
350
380
    inv_changes = merge_flex(this_tree, base_tree, other_tree,
351
 
                             generate_cset_optimized, get_inventory,
352
 
                             MergeConflictHandler(ignore_zero=ignore_zero),
 
381
                             generate_changeset, get_inventory,
 
382
                             MergeConflictHandler(this_tree, base_tree,
 
383
                             other_tree, ignore_zero=ignore_zero),
353
384
                             merge_factory=merge_factory, 
354
385
                             interesting_ids=interesting_ids)
355
386
 
363
394
            path = path[2:]
364
395
        adjust_ids.append((path, id))
365
396
    if len(adjust_ids) > 0:
366
 
        this_branch.set_inventory(regen_inventory(this_branch, this_tree.root,
 
397
        this_branch.set_inventory(regen_inventory(this_branch, 
 
398
                                                  this_tree.basedir,
367
399
                                                  adjust_ids))
368
400
 
369
401