/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

  • Committer: Aaron Bentley
  • Date: 2005-10-01 06:48:01 UTC
  • mto: (1185.12.13)
  • mto: This revision was merged to the branch mainline in revision 1419.
  • Revision ID: aaron.bentley@utoronto.ca-20051001064801-7400c2ed0fe26080
Made iter_conflicts a WorkingTree method

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
from merge_core import merge_flex, ApplyMerge3, BackupBeforeChange
2
 
from changeset import generate_changeset, ExceptionConflictHandler
3
 
from 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
 
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
10
19
import tempfile
11
20
import shutil
12
21
import errno
13
22
 
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
 
 
 
23
import bzrlib.osutils
 
24
import bzrlib.revision
 
25
from bzrlib.merge_core import merge_flex, ApplyMerge3, BackupBeforeChange
 
26
from bzrlib.changeset import generate_changeset, ExceptionConflictHandler
 
27
from bzrlib.changeset import Inventory, Diff3Merge, ReplaceContents
 
28
from bzrlib.branch import Branch
 
29
from bzrlib.errors import BzrCommandError, UnrelatedBranches, NoCommonAncestor
 
30
from bzrlib.errors import NoCommits
 
31
from bzrlib.delta import compare_trees
 
32
from bzrlib.trace import mutter, warning
 
33
from bzrlib.fetch import greedy_fetch, fetch
 
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
 
 
43
# comments from abentley on irc: merge happens in two stages, each
 
44
# of which generates a changeset object
 
45
 
 
46
# stage 1: generate OLD->OTHER,
 
47
# stage 2: use MINE and OLD->OTHER to generate MINE -> RESULT
20
48
 
21
49
class MergeConflictHandler(ExceptionConflictHandler):
22
 
    """Handle conflicts encountered while merging"""
23
 
    def __init__(self, dir, ignore_zero=False):
24
 
        ExceptionConflictHandler.__init__(self, dir)
 
50
    """Handle conflicts encountered while merging.
 
51
 
 
52
    This subclasses ExceptionConflictHandler, so that any types of
 
53
    conflict that are not explicitly handled cause an exception and
 
54
    terminate the merge.
 
55
    """
 
56
    def __init__(self, this_tree, base_tree, other_tree, ignore_zero=False):
 
57
        ExceptionConflictHandler.__init__(self)
25
58
        self.conflicts = 0
26
59
        self.ignore_zero = ignore_zero
 
60
        self.this_tree = this_tree
 
61
        self.base_tree = base_tree
 
62
        self.other_tree = other_tree
27
63
 
28
64
    def copy(self, source, dest):
29
65
        """Copy the text and mode of a file
36
72
            d_file.write(line)
37
73
        os.chmod(dest, 0777 & os.stat(source).st_mode)
38
74
 
 
75
    def dump(self, lines, dest):
 
76
        """Copy the text and mode of a file
 
77
        :param source: The path of the file to copy
 
78
        :param dest: The distination file to create
 
79
        """
 
80
        d_file = file(dest, "wb")
 
81
        for line in lines:
 
82
            d_file.write(line)
 
83
 
39
84
    def add_suffix(self, name, suffix, last_new_name=None):
40
85
        """Rename a file to append a suffix.  If the new name exists, the
41
86
        suffix is added repeatedly until a non-existant name is found
48
93
            last_new_name = name
49
94
        new_name = last_new_name+suffix
50
95
        try:
51
 
            os.rename(name, new_name)
 
96
            rename(name, new_name)
52
97
            return new_name
53
98
        except OSError, e:
54
99
            if e.errno != errno.EEXIST and e.errno != errno.ENOTEMPTY:
60
105
        self.conflicts += 1
61
106
        
62
107
 
63
 
    def merge_conflict(self, new_file, this_path, base_path, other_path):
 
108
    def merge_conflict(self, new_file, this_path, base_lines, other_lines):
64
109
        """
65
110
        Handle diff3 conflicts by producing a .THIS, .BASE and .OTHER.  The
66
111
        main file will be a version with diff3 conflicts.
70
115
        :param other_path: Path to the file text for the OTHER tree
71
116
        """
72
117
        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)
 
118
        self.dump(base_lines, this_path+".BASE")
 
119
        self.dump(other_lines, this_path+".OTHER")
 
120
        rename(new_file, this_path)
76
121
        self.conflict("Diff3 conflict encountered in %s" % this_path)
77
122
 
 
123
    def new_contents_conflict(self, filename, other_contents):
 
124
        """Conflicting contents for newly added file."""
 
125
        self.copy(other_contents, filename + ".OTHER")
 
126
        self.conflict("Conflict in newly added file %s" % filename)
 
127
    
 
128
 
78
129
    def target_exists(self, entry, target, old_path):
79
130
        """Handle the case when the target file or dir exists"""
80
131
        moved_path = self.add_suffix(target, ".moved")
86
137
            % filename)
87
138
        return "skip"
88
139
 
 
140
    def rem_contents_conflict(self, filename, this_contents, base_contents):
 
141
        base_contents(filename+".BASE", self, False)
 
142
        this_contents(filename+".THIS", self, False)
 
143
        self.conflict("Other branch deleted locally modified file %s" %
 
144
                      filename)
 
145
        return ReplaceContents(this_contents, None)
 
146
 
 
147
    def abs_this_path(self, file_id):
 
148
        """Return the absolute path for a file_id in the this tree."""
 
149
        relpath = self.this_tree.id2path(file_id)
 
150
        return self.this_tree.tree.abspath(relpath)
 
151
 
 
152
    def add_missing_parents(self, file_id, tree):
 
153
        """If some of the parents for file_id are missing, add them."""
 
154
        entry = tree.tree.inventory[file_id]
 
155
        if entry.parent_id not in self.this_tree:
 
156
            return self.create_all_missing(entry.parent_id, tree)
 
157
        else:
 
158
            return self.abs_this_path(entry.parent_id)
 
159
 
 
160
    def create_all_missing(self, file_id, tree):
 
161
        """Add contents for a file_id and all its parents to a tree."""
 
162
        entry = tree.tree.inventory[file_id]
 
163
        if entry.parent_id is not None and entry.parent_id not in self.this_tree:
 
164
            abspath = self.create_all_missing(entry.parent_id, tree)
 
165
        else:
 
166
            abspath = self.abs_this_path(entry.parent_id)
 
167
        entry_path = os.path.join(abspath, entry.name)
 
168
        if not os.path.isdir(entry_path):
 
169
            self.create(file_id, entry_path, tree)
 
170
        return entry_path
 
171
 
 
172
    def create(self, file_id, path, tree, reverse=False):
 
173
        """Uses tree data to create a filesystem object for the file_id"""
 
174
        from merge_core import get_id_contents
 
175
        get_id_contents(file_id, tree)(path, self, reverse)
 
176
 
 
177
    def missing_for_merge(self, file_id, other_path):
 
178
        """The file_id doesn't exist in THIS, but does in OTHER and BASE"""
 
179
        self.conflict("Other branch modified locally deleted file %s" %
 
180
                      other_path)
 
181
        parent_dir = self.add_missing_parents(file_id, self.other_tree)
 
182
        stem = os.path.join(parent_dir, os.path.basename(other_path))
 
183
        self.create(file_id, stem+".OTHER", self.other_tree)
 
184
        self.create(file_id, stem+".BASE", self.base_tree)
 
185
 
89
186
    def finalize(self):
90
187
        if not self.ignore_zero:
91
188
            print "%d conflicts encountered.\n" % self.conflicts
92
189
            
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):
 
190
def get_tree(treespec, temp_root, label, local_branch=None):
105
191
    location, revno = treespec
106
 
    branch = find_branch(location)
 
192
    branch = Branch.open_containing(location)
107
193
    if revno is None:
 
194
        revision = None
 
195
    elif revno == -1:
 
196
        revision = branch.last_revision()
 
197
    else:
 
198
        revision = branch.get_rev_id(revno)
 
199
    return branch, get_revid_tree(branch, revision, temp_root, label,
 
200
                                  local_branch)
 
201
 
 
202
def get_revid_tree(branch, revision, temp_root, label, local_branch):
 
203
    if revision is None:
108
204
        base_tree = branch.working_tree()
109
 
    elif revno == -1:
110
 
        base_tree = branch.basis_tree()
111
205
    else:
112
 
        base_tree = branch.revision_tree(branch.lookup_revision(revno))
 
206
        if local_branch is not None:
 
207
            greedy_fetch(local_branch, branch, revision)
 
208
            base_tree = local_branch.revision_tree(revision)
 
209
        else:
 
210
            base_tree = branch.revision_tree(revision)
113
211
    temp_path = os.path.join(temp_root, label)
114
212
    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
 
213
    return MergeTree(base_tree, temp_path)
 
214
 
123
215
 
124
216
def file_exists(tree, file_id):
125
217
    return tree.has_filename(tree.id2path(file_id))
126
218
    
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
219
 
135
220
class MergeTree(object):
136
221
    def __init__(self, tree, tempdir):
139
224
            self.root = tree.basedir
140
225
        else:
141
226
            self.root = None
142
 
        self.inventory = inventory_map(tree)
143
227
        self.tree = tree
144
228
        self.tempdir = tempdir
145
229
        os.mkdir(os.path.join(self.tempdir, "texts"))
146
230
        self.cached = {}
147
231
 
 
232
    def __iter__(self):
 
233
        return self.tree.__iter__()
 
234
 
 
235
    def __contains__(self, file_id):
 
236
        return file_id in self.tree
 
237
 
 
238
    def get_file(self, file_id):
 
239
        return self.tree.get_file(file_id)
 
240
 
 
241
    def get_file_sha1(self, id):
 
242
        return self.tree.get_file_sha1(id)
 
243
 
 
244
    def id2path(self, file_id):
 
245
        return self.tree.id2path(file_id)
 
246
 
 
247
    def has_id(self, file_id):
 
248
        return self.tree.has_id(file_id)
 
249
 
 
250
    def has_or_had_id(self, file_id):
 
251
        if file_id == self.tree.inventory.root.file_id:
 
252
            return True
 
253
        return self.tree.inventory.has_id(file_id)
 
254
 
 
255
    def has_or_had_id(self, file_id):
 
256
        if file_id == self.tree.inventory.root.file_id:
 
257
            return True
 
258
        return self.tree.inventory.has_id(file_id)
 
259
 
148
260
    def readonly_path(self, id):
149
261
        if id not in self.tree:
150
262
            return None
162
274
            return self.cached[id]
163
275
 
164
276
 
 
277
def build_working_dir(to_dir):
 
278
    """Build a working directory in an empty directory.
 
279
 
 
280
    to_dir is a directory containing branch metadata but no working files,
 
281
    typically constructed by cloning an existing branch. 
 
282
 
 
283
    This is split out as a special idiomatic case of merge.  It could
 
284
    eventually be done by just building the tree directly calling into 
 
285
    lower-level code (e.g. constructing a changeset).
 
286
    """
 
287
    merge((to_dir, -1), (to_dir, 0), this_dir=to_dir,
 
288
          check_clean=False, ignore_zero=True)
 
289
 
165
290
 
166
291
def merge(other_revision, base_revision,
167
292
          check_clean=True, ignore_zero=False,
170
295
    """Merge changes into a tree.
171
296
 
172
297
    base_revision
173
 
        Base for three-way merge.
 
298
        tuple(path, revision) Base for three-way merge.
174
299
    other_revision
175
 
        Other revision for three-way merge.
 
300
        tuple(path, revision) Other revision for three-way merge.
176
301
    this_dir
177
302
        Directory to merge changes into; '.' by default.
178
303
    check_clean
179
304
        If true, this_dir must have no uncommitted changes before the
180
305
        merge begins.
 
306
    ignore_zero - If true, suppress the "zero conflicts" message when 
 
307
        there are no conflicts; should be set when doing something we expect
 
308
        to complete perfectly.
 
309
 
 
310
    All available ancestors of other_revision and base_revision are
 
311
    automatically pulled into the branch.
181
312
    """
182
313
    tempdir = tempfile.mkdtemp(prefix="bzr-")
183
314
    try:
184
315
        if this_dir is None:
185
316
            this_dir = '.'
186
 
        this_branch = find_branch(this_dir)
 
317
        this_branch = Branch.open_containing(this_dir)
 
318
        this_rev_id = this_branch.last_revision()
 
319
        if this_rev_id is None:
 
320
            raise BzrCommandError("This branch has no commits")
187
321
        if check_clean:
188
322
            changes = compare_trees(this_branch.working_tree(), 
189
323
                                    this_branch.basis_tree(), False)
190
324
            if changes.has_changed():
191
325
                raise BzrCommandError("Working tree has uncommitted changes.")
192
 
        other_branch, other_tree = get_tree(other_revision, tempdir, "other")
 
326
        other_branch, other_tree = get_tree(other_revision, tempdir, "other",
 
327
                                            this_branch)
 
328
        if other_revision[1] == -1:
 
329
            other_rev_id = other_branch.last_revision()
 
330
            if other_rev_id is None:
 
331
                raise NoCommits(other_branch)
 
332
            other_basis = other_rev_id
 
333
        elif other_revision[1] is not None:
 
334
            other_rev_id = other_branch.get_rev_id(other_revision[1])
 
335
            other_basis = other_rev_id
 
336
        else:
 
337
            other_rev_id = None
 
338
            other_basis = other_branch.last_revision()
 
339
            if other_basis is None:
 
340
                raise NoCommits(other_branch)
193
341
        if base_revision == [None, None]:
194
 
            if other_revision[1] == -1:
195
 
                o_revno = None
196
 
            else:
197
 
                o_revno = other_revision[1]
198
 
            base_revno = this_branch.common_ancestor(other_branch, 
199
 
                                                     other_revno=o_revno)[0]
200
 
            if base_revno is None:
 
342
            try:
 
343
                base_rev_id = common_ancestor(this_rev_id, other_basis, 
 
344
                                              this_branch)
 
345
            except NoCommonAncestor:
201
346
                raise UnrelatedBranches()
202
 
            base_revision = ['.', base_revno]
203
 
        base_branch, base_tree = get_tree(base_revision, tempdir, "base")
 
347
            base_tree = get_revid_tree(this_branch, base_rev_id, tempdir, 
 
348
                                       "base", None)
 
349
            base_is_ancestor = True
 
350
        else:
 
351
            base_branch, base_tree = get_tree(base_revision, tempdir, "base")
 
352
            if base_revision[1] == -1:
 
353
                base_rev_id = base_branch.last_revision()
 
354
            elif base_revision[1] is None:
 
355
                base_rev_id = None
 
356
            else:
 
357
                base_rev_id = base_branch.get_rev_id(base_revision[1])
 
358
            fetch(from_branch=base_branch, to_branch=this_branch)
 
359
            base_is_ancestor = is_ancestor(this_rev_id, base_rev_id,
 
360
                                           this_branch)
204
361
        if file_list is None:
205
362
            interesting_ids = None
206
363
        else:
220
377
        merge_inner(this_branch, other_tree, base_tree, tempdir, 
221
378
                    ignore_zero=ignore_zero, backup_files=backup_files, 
222
379
                    merge_type=merge_type, interesting_ids=interesting_ids)
 
380
        if base_is_ancestor and other_rev_id is not None\
 
381
            and other_rev_id not in this_branch.revision_history():
 
382
            this_branch.add_pending_merge(other_rev_id)
223
383
    finally:
224
384
        shutil.rmtree(tempdir)
225
385
 
232
392
             source_file.interesting = source_file.id in interesting_ids
233
393
 
234
394
 
235
 
def set_optimized(tree_a, tree_b, inventory_a, inventory_b):
236
 
    """Mark files that have changed texts as interesting
237
 
    """
238
 
    for file_id in tree_a.tree.inventory:
239
 
        if file_id not in tree_b.tree.inventory:
240
 
            continue
241
 
        entry_a = tree_a.tree.inventory[file_id]
242
 
        entry_b = tree_b.tree.inventory[file_id]
243
 
        if (entry_a.kind, entry_b.kind) != ("file", "file"):
244
 
            continue
245
 
        if None in (entry_a.text_id, entry_b.text_id):
246
 
            continue
247
 
        if entry_a.text_id != entry_b.text_id:
248
 
            continue
249
 
        inventory_a[abspath(tree_a.tree, file_id)].interesting = False
250
 
        inventory_b[abspath(tree_b.tree, file_id)].interesting = False
251
 
 
252
 
 
253
 
def generate_cset_optimized(tree_a, tree_b, inventory_a, inventory_b,
254
 
                            interesting_ids=None):
255
 
    """Generate a changeset, with preprocessing to select interesting files.
256
 
    using the text_id to mark really-changed files.
257
 
    This permits blazing comparisons when text_ids are present.  It also
258
 
    disables metadata comparison for files with identical texts.
 
395
def generate_cset_optimized(tree_a, tree_b, interesting_ids=None):
 
396
    """Generate a changeset.  If interesting_ids is supplied, only changes
 
397
    to those files will be shown.  Metadata changes are stripped.
259
398
    """ 
260
 
    if interesting_ids is None:
261
 
        set_optimized(tree_a, tree_b, inventory_a, inventory_b)
262
 
    else:
263
 
        set_interesting(inventory_a, inventory_b, interesting_ids)
264
 
    cset =  generate_changeset(tree_a, tree_b, inventory_a, inventory_b)
 
399
    cset =  generate_changeset(tree_a, tree_b, interesting_ids)
265
400
    for entry in cset.entries.itervalues():
266
401
        entry.metadata_change = None
267
402
    return cset
271
406
                ignore_zero=False, merge_type=ApplyMerge3, backup_files=False,
272
407
                interesting_ids=None):
273
408
 
274
 
    def merge_factory(base_file, other_file):
275
 
        contents_change = merge_type(base_file, other_file)
 
409
    def merge_factory(file_id, base, other):
 
410
        contents_change = merge_type(file_id, base, other)
276
411
        if backup_files:
277
412
            contents_change = BackupBeforeChange(contents_change)
278
413
        return contents_change
279
 
    
280
 
    def generate_cset(tree_a, tree_b, inventory_a, inventory_b):
281
 
        return generate_cset_optimized(tree_a, tree_b, inventory_a, inventory_b,
282
 
                                       interesting_ids)
283
414
 
284
415
    this_tree = get_tree((this_branch.base, None), tempdir, "this")[1]
285
416
 
286
417
    def get_inventory(tree):
287
 
        return tree.inventory
 
418
        return tree.tree.inventory
288
419
 
289
420
    inv_changes = merge_flex(this_tree, base_tree, other_tree,
290
 
                             generate_cset, get_inventory,
291
 
                             MergeConflictHandler(base_tree.root,
292
 
                                                  ignore_zero=ignore_zero),
293
 
                             merge_factory=merge_factory)
 
421
                             generate_cset_optimized, get_inventory,
 
422
                             MergeConflictHandler(this_tree, base_tree,
 
423
                             other_tree, ignore_zero=ignore_zero),
 
424
                             merge_factory=merge_factory, 
 
425
                             interesting_ids=interesting_ids)
294
426
 
295
427
    adjust_ids = []
296
428
    for id, path in inv_changes.iteritems():
298
430
            if path == '.':
299
431
                path = ''
300
432
            else:
301
 
                assert path.startswith('./')
 
433
                assert path.startswith('.' + os.sep), "path is %s" % path
302
434
            path = path[2:]
303
435
        adjust_ids.append((path, id))
304
 
    this_branch.set_inventory(regen_inventory(this_branch, this_tree.root, adjust_ids))
 
436
    if len(adjust_ids) > 0:
 
437
        this_branch.set_inventory(regen_inventory(this_branch, this_tree.root,
 
438
                                                  adjust_ids))
305
439
 
306
440
 
307
441
def regen_inventory(this_branch, root, new_entries):
308
442
    old_entries = this_branch.read_working_inventory()
309
443
    new_inventory = {}
310
444
    by_path = {}
 
445
    new_entries_map = {} 
 
446
    for path, file_id in new_entries:
 
447
        if path is None:
 
448
            continue
 
449
        new_entries_map[file_id] = path
 
450
 
 
451
    def id2path(file_id):
 
452
        path = new_entries_map.get(file_id)
 
453
        if path is not None:
 
454
            return path
 
455
        entry = old_entries[file_id]
 
456
        if entry.parent_id is None:
 
457
            return entry.name
 
458
        return os.path.join(id2path(entry.parent_id), entry.name)
 
459
        
311
460
    for file_id in old_entries:
312
461
        entry = old_entries[file_id]
313
 
        path = old_entries.id2path(file_id)
 
462
        path = id2path(file_id)
314
463
        new_inventory[file_id] = (path, file_id, entry.parent_id, entry.kind)
315
464
        by_path[path] = file_id
316
465