~bzr-pqm/bzr/bzr.dev

1110 by Martin Pool
- merge aaron's merge improvements:
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
1113 by Martin Pool
- fix is_ancestor import problem in merge
18
import os.path
19
import tempfile
20
import shutil
21
import errno
1092.1.39 by Robert Collins
merge from mpool
22
from fetch import greedy_fetch
1113 by Martin Pool
- fix is_ancestor import problem in merge
23
24
import bzrlib.osutils
25
import bzrlib.revision
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
26
from bzrlib.merge_core import merge_flex, ApplyMerge3, BackupBeforeChange
27
from bzrlib.changeset import generate_changeset, ExceptionConflictHandler
28
from bzrlib.changeset import Inventory, Diff3Merge
1110 by Martin Pool
- merge aaron's merge improvements:
29
from bzrlib.branch import find_branch
1105 by Martin Pool
- expose 'find-merge-base' as a new expert command,
30
from bzrlib.errors import BzrCommandError, UnrelatedBranches
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
31
from bzrlib.delta import compare_trees
1113 by Martin Pool
- fix is_ancestor import problem in merge
32
from bzrlib.trace import mutter, warning
33
from bzrlib.fetch import greedy_fetch
1116 by Martin Pool
- fix a few errors in new merge code
34
from bzrlib.revision import is_ancestor
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
35
36
# comments from abentley on irc: merge happens in two stages, each
37
# of which generates a changeset object
38
39
# stage 1: generate OLD->OTHER,
40
# stage 2: use MINE and OLD->OTHER to generate MINE -> RESULT
41
493 by Martin Pool
- Merge aaron's merge command
42
class MergeConflictHandler(ExceptionConflictHandler):
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
43
    """Handle conflicts encountered while merging.
44
45
    This subclasses ExceptionConflictHandler, so that any types of
46
    conflict that are not explicitly handled cause an exception and
47
    terminate the merge.
48
    """
622 by Martin Pool
Updated merge patch from Aaron
49
    def __init__(self, dir, ignore_zero=False):
50
        ExceptionConflictHandler.__init__(self, dir)
51
        self.conflicts = 0
52
        self.ignore_zero = ignore_zero
53
493 by Martin Pool
- Merge aaron's merge command
54
    def copy(self, source, dest):
55
        """Copy the text and mode of a file
56
        :param source: The path of the file to copy
57
        :param dest: The distination file to create
58
        """
59
        s_file = file(source, "rb")
60
        d_file = file(dest, "wb")
61
        for line in s_file:
62
            d_file.write(line)
63
        os.chmod(dest, 0777 & os.stat(source).st_mode)
64
974.1.23 by Aaron Bentley
Avoided unnecessary temp files
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
493 by Martin Pool
- Merge aaron's merge command
74
    def add_suffix(self, name, suffix, last_new_name=None):
75
        """Rename a file to append a suffix.  If the new name exists, the
76
        suffix is added repeatedly until a non-existant name is found
77
78
        :param name: The path of the file
79
        :param suffix: The suffix to append
80
        :param last_new_name: (used for recursive calls) the last name tried
81
        """
82
        if last_new_name is None:
83
            last_new_name = name
84
        new_name = last_new_name+suffix
85
        try:
86
            os.rename(name, new_name)
622 by Martin Pool
Updated merge patch from Aaron
87
            return new_name
493 by Martin Pool
- Merge aaron's merge command
88
        except OSError, e:
89
            if e.errno != errno.EEXIST and e.errno != errno.ENOTEMPTY:
90
                raise
622 by Martin Pool
Updated merge patch from Aaron
91
            return self.add_suffix(name, suffix, last_new_name=new_name)
92
93
    def conflict(self, text):
94
        warning(text)
95
        self.conflicts += 1
96
        
493 by Martin Pool
- Merge aaron's merge command
97
974.1.23 by Aaron Bentley
Avoided unnecessary temp files
98
    def merge_conflict(self, new_file, this_path, base_lines, other_lines):
493 by Martin Pool
- Merge aaron's merge command
99
        """
100
        Handle diff3 conflicts by producing a .THIS, .BASE and .OTHER.  The
101
        main file will be a version with diff3 conflicts.
102
        :param new_file: Path to the output file with diff3 markers
103
        :param this_path: Path to the file text for the THIS tree
104
        :param base_path: Path to the file text for the BASE tree
105
        :param other_path: Path to the file text for the OTHER tree
106
        """
107
        self.add_suffix(this_path, ".THIS")
974.1.23 by Aaron Bentley
Avoided unnecessary temp files
108
        self.dump(base_lines, this_path+".BASE")
109
        self.dump(other_lines, this_path+".OTHER")
493 by Martin Pool
- Merge aaron's merge command
110
        os.rename(new_file, this_path)
622 by Martin Pool
Updated merge patch from Aaron
111
        self.conflict("Diff3 conflict encountered in %s" % this_path)
493 by Martin Pool
- Merge aaron's merge command
112
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
113
    def new_contents_conflict(self, filename, other_contents):
114
        """Conflicting contents for newly added file."""
115
        self.copy(other_contents, filename + ".OTHER")
116
        self.conflict("Conflict in newly added file %s" % filename)
117
    
118
493 by Martin Pool
- Merge aaron's merge command
119
    def target_exists(self, entry, target, old_path):
120
        """Handle the case when the target file or dir exists"""
622 by Martin Pool
Updated merge patch from Aaron
121
        moved_path = self.add_suffix(target, ".moved")
122
        self.conflict("Moved existing %s to %s" % (target, moved_path))
123
850 by Martin Pool
- Merge merge updates from aaron
124
    def rmdir_non_empty(self, filename):
125
        """Handle the case where the dir to be removed still has contents"""
126
        self.conflict("Directory %s not removed because it is not empty"\
127
            % filename)
128
        return "skip"
129
622 by Martin Pool
Updated merge patch from Aaron
130
    def finalize(self):
131
        if not self.ignore_zero:
132
            print "%d conflicts encountered.\n" % self.conflicts
493 by Martin Pool
- Merge aaron's merge command
133
            
974.1.32 by aaron.bentley at utoronto
Made merge do greedy fetching.
134
def get_tree(treespec, temp_root, label, local_branch=None):
622 by Martin Pool
Updated merge patch from Aaron
135
    location, revno = treespec
136
    branch = find_branch(location)
493 by Martin Pool
- Merge aaron's merge command
137
    if revno is None:
974.1.36 by aaron.bentley at utoronto
Committed it even though the test case doesn't work
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:
493 by Martin Pool
- Merge aaron's merge command
148
        base_tree = branch.working_tree()
149
    else:
974.1.32 by aaron.bentley at utoronto
Made merge do greedy fetching.
150
        if local_branch is not None:
974.1.36 by aaron.bentley at utoronto
Committed it even though the test case doesn't work
151
            greedy_fetch(local_branch, branch, revision)
974.1.32 by aaron.bentley at utoronto
Made merge do greedy fetching.
152
            base_tree = local_branch.revision_tree(revision)
153
        else:
154
            base_tree = branch.revision_tree(revision)
493 by Martin Pool
- Merge aaron's merge command
155
    temp_path = os.path.join(temp_root, label)
156
    os.mkdir(temp_path)
974.1.36 by aaron.bentley at utoronto
Committed it even though the test case doesn't work
157
    return MergeTree(base_tree, temp_path)
493 by Martin Pool
- Merge aaron's merge command
158
159
160
def file_exists(tree, file_id):
161
    return tree.has_filename(tree.id2path(file_id))
162
    
163
164
class MergeTree(object):
165
    def __init__(self, tree, tempdir):
166
        object.__init__(self)
167
        if hasattr(tree, "basedir"):
168
            self.root = tree.basedir
169
        else:
170
            self.root = None
171
        self.tree = tree
172
        self.tempdir = tempdir
173
        os.mkdir(os.path.join(self.tempdir, "texts"))
174
        self.cached = {}
175
974.1.19 by Aaron Bentley
Removed MergeTree.inventory
176
    def __iter__(self):
177
        return self.tree.__iter__()
178
974.1.12 by aaron.bentley at utoronto
Switched from text-id to hashcache for merge optimization
179
    def __contains__(self, file_id):
974.1.14 by aaron.bentley at utoronto
Fixed bugs in merge optimization
180
        return file_id in self.tree
974.1.12 by aaron.bentley at utoronto
Switched from text-id to hashcache for merge optimization
181
974.1.23 by Aaron Bentley
Avoided unnecessary temp files
182
    def get_file(self, file_id):
183
        return self.tree.get_file(file_id)
184
974.1.12 by aaron.bentley at utoronto
Switched from text-id to hashcache for merge optimization
185
    def get_file_sha1(self, id):
186
        return self.tree.get_file_sha1(id)
187
974.1.18 by Aaron Bentley
Stopped using SourceFile in inventory
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
1094 by Martin Pool
- merge aaron's merge improvements 999..1008
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
493 by Martin Pool
- Merge aaron's merge command
199
    def readonly_path(self, id):
850 by Martin Pool
- Merge merge updates from aaron
200
        if id not in self.tree:
201
            return None
493 by Martin Pool
- Merge aaron's merge command
202
        if self.root is not None:
203
            return self.tree.abspath(self.tree.id2path(id))
204
        else:
205
            if self.tree.inventory[id].kind in ("directory", "root_directory"):
206
                return self.tempdir
207
            if not self.cached.has_key(id):
208
                path = os.path.join(self.tempdir, "texts", id)
209
                outfile = file(path, "wb")
210
                outfile.write(self.tree.get_file(id).read())
211
                assert(os.path.exists(path))
212
                self.cached[id] = path
213
            return self.cached[id]
214
628 by Martin Pool
- merge aaron's updated merge/pull code
215
216
217
def merge(other_revision, base_revision,
218
          check_clean=True, ignore_zero=False,
974.1.10 by aaron.bentley at utoronto
Added file-selection to merge-revert
219
          this_dir=None, backup_files=False, merge_type=ApplyMerge3,
220
          file_list=None):
628 by Martin Pool
- merge aaron's updated merge/pull code
221
    """Merge changes into a tree.
222
223
    base_revision
1092.1.38 by Robert Collins
make a default merge choose a sane base with branch.common_ancestor
224
        tuple(path, revision) Base for three-way merge.
628 by Martin Pool
- merge aaron's updated merge/pull code
225
    other_revision
1092.1.38 by Robert Collins
make a default merge choose a sane base with branch.common_ancestor
226
        tuple(path, revision) Other revision for three-way merge.
628 by Martin Pool
- merge aaron's updated merge/pull code
227
    this_dir
228
        Directory to merge changes into; '.' by default.
229
    check_clean
230
        If true, this_dir must have no uncommitted changes before the
231
        merge begins.
974.1.32 by aaron.bentley at utoronto
Made merge do greedy fetching.
232
    all available ancestors of other_revision and base_revision are
233
    automatically pulled into the branch.
628 by Martin Pool
- merge aaron's updated merge/pull code
234
    """
974.1.36 by aaron.bentley at utoronto
Committed it even though the test case doesn't work
235
    from bzrlib.revision import common_ancestor, MultipleRevisionSources
236
    from bzrlib.errors import NoSuchRevision
493 by Martin Pool
- Merge aaron's merge command
237
    tempdir = tempfile.mkdtemp(prefix="bzr-")
238
    try:
628 by Martin Pool
- merge aaron's updated merge/pull code
239
        if this_dir is None:
240
            this_dir = '.'
241
        this_branch = find_branch(this_dir)
974.1.36 by aaron.bentley at utoronto
Committed it even though the test case doesn't work
242
        this_rev_id = this_branch.last_patch()
243
        if this_rev_id is None:
244
            raise BzrCommandError("This branch has no commits")
628 by Martin Pool
- merge aaron's updated merge/pull code
245
        if check_clean:
622 by Martin Pool
Updated merge patch from Aaron
246
            changes = compare_trees(this_branch.working_tree(), 
247
                                    this_branch.basis_tree(), False)
248
            if changes.has_changed():
249
                raise BzrCommandError("Working tree has uncommitted changes.")
974.1.32 by aaron.bentley at utoronto
Made merge do greedy fetching.
250
        other_branch, other_tree = get_tree(other_revision, tempdir, "other",
251
                                            this_branch)
974.1.36 by aaron.bentley at utoronto
Committed it even though the test case doesn't work
252
        if other_revision[1] == -1:
253
            other_rev_id = other_branch.last_patch()
254
            other_basis = other_rev_id
255
        elif other_revision[1] is not None:
256
            other_rev_id = other_branch.lookup_revision(other_revision[1])
257
            other_basis = other_rev_id
258
        else:
259
            other_rev_id = None
260
            other_basis = other_branch.last_patch()
622 by Martin Pool
Updated merge patch from Aaron
261
        if base_revision == [None, None]:
262
            if other_revision[1] == -1:
263
                o_revno = None
264
            else:
265
                o_revno = other_revision[1]
266
                raise UnrelatedBranches()
974.1.36 by aaron.bentley at utoronto
Committed it even though the test case doesn't work
267
            try:
268
                base_revision = this_branch.get_revision(base_rev_id)
269
                base_branch = this_branch
270
            except NoSuchRevision:
271
                base_branch = other_branch
272
            base_tree = get_revid_tree(base_branch, base_rev_id, tempdir, 
273
                                       "base")
274
            base_is_ancestor = True
275
        else:
276
            if base_revision[1] == -1:
1092.1.38 by Robert Collins
make a default merge choose a sane base with branch.common_ancestor
277
                base_branch, base_tree = get_tree(base_revision, tempdir, "base")
974.1.36 by aaron.bentley at utoronto
Committed it even though the test case doesn't work
278
                base_rev_id = base_branch.last_patch()
279
            elif base_revision[1] is None:
1092.1.38 by Robert Collins
make a default merge choose a sane base with branch.common_ancestor
280
                base_revno, base_rev_id = this_branch.common_ancestor(other_branch)
281
                base_branch, base_tree = get_tree((base_revision[0], "revid:%s" % base_rev_id), tempdir, "base")
974.1.36 by aaron.bentley at utoronto
Committed it even though the test case doesn't work
282
            else:
1092.1.38 by Robert Collins
make a default merge choose a sane base with branch.common_ancestor
283
                base_branch, base_tree = get_tree(base_revision, tempdir, "base")
974.1.36 by aaron.bentley at utoronto
Committed it even though the test case doesn't work
284
                base_rev_id = base_branch.lookup_revision(base_revision[1])
285
            if base_rev_id is not None:
286
                base_is_ancestor = is_ancestor(this_rev_id, base_rev_id, 
1113 by Martin Pool
- fix is_ancestor import problem in merge
287
                                               MultipleRevisionSources(this_branch, 
288
                                                                       base_branch))
974.1.36 by aaron.bentley at utoronto
Committed it even though the test case doesn't work
289
            else:
290
                base_is_ancestor = False
974.1.10 by aaron.bentley at utoronto
Added file-selection to merge-revert
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)
622 by Martin Pool
Updated merge patch from Aaron
307
        merge_inner(this_branch, other_tree, base_tree, tempdir, 
974.1.9 by Aaron Bentley
Added merge-type parameter to merge.
308
                    ignore_zero=ignore_zero, backup_files=backup_files, 
974.1.10 by aaron.bentley at utoronto
Added file-selection to merge-revert
309
                    merge_type=merge_type, interesting_ids=interesting_ids)
974.1.36 by aaron.bentley at utoronto
Committed it even though the test case doesn't work
310
        if base_is_ancestor and other_rev_id is not None:
311
            this_branch.add_pending_merge(other_rev_id)
493 by Martin Pool
- Merge aaron's merge command
312
    finally:
313
        shutil.rmtree(tempdir)
314
315
974.1.10 by aaron.bentley at utoronto
Added file-selection to merge-revert
316
def set_interesting(inventory_a, inventory_b, interesting_ids):
317
    """Mark files whose ids are in interesting_ids as interesting
318
    """
319
    for inventory in (inventory_a, inventory_b):
320
        for path, source_file in inventory.iteritems():
321
             source_file.interesting = source_file.id in interesting_ids
322
323
974.1.19 by Aaron Bentley
Removed MergeTree.inventory
324
def generate_cset_optimized(tree_a, tree_b, interesting_ids=None):
974.1.12 by aaron.bentley at utoronto
Switched from text-id to hashcache for merge optimization
325
    """Generate a changeset.  If interesting_ids is supplied, only changes
326
    to those files will be shown.  Metadata changes are stripped.
974.1.10 by aaron.bentley at utoronto
Added file-selection to merge-revert
327
    """ 
974.1.19 by Aaron Bentley
Removed MergeTree.inventory
328
    cset =  generate_changeset(tree_a, tree_b, interesting_ids)
493 by Martin Pool
- Merge aaron's merge command
329
    for entry in cset.entries.itervalues():
330
        entry.metadata_change = None
331
    return cset
332
333
622 by Martin Pool
Updated merge patch from Aaron
334
def merge_inner(this_branch, other_tree, base_tree, tempdir, 
974.1.10 by aaron.bentley at utoronto
Added file-selection to merge-revert
335
                ignore_zero=False, merge_type=ApplyMerge3, backup_files=False,
336
                interesting_ids=None):
974.1.4 by Aaron Bentley
Implemented merge3 as the default text merge
337
974.1.23 by Aaron Bentley
Avoided unnecessary temp files
338
    def merge_factory(file_id, base, other):
339
        contents_change = merge_type(file_id, base, other)
974.1.8 by Aaron Bentley
Added default backups for merge-revert
340
        if backup_files:
341
            contents_change = BackupBeforeChange(contents_change)
342
        return contents_change
974.1.4 by Aaron Bentley
Implemented merge3 as the default text merge
343
628 by Martin Pool
- merge aaron's updated merge/pull code
344
    this_tree = get_tree((this_branch.base, None), tempdir, "this")[1]
493 by Martin Pool
- Merge aaron's merge command
345
346
    def get_inventory(tree):
974.1.19 by Aaron Bentley
Removed MergeTree.inventory
347
        return tree.tree.inventory
493 by Martin Pool
- Merge aaron's merge command
348
349
    inv_changes = merge_flex(this_tree, base_tree, other_tree,
974.1.17 by Aaron Bentley
Switched to using a set of interesting file_ids instead of SourceFile attribute
350
                             generate_cset_optimized, get_inventory,
622 by Martin Pool
Updated merge patch from Aaron
351
                             MergeConflictHandler(base_tree.root,
974.1.3 by Aaron Bentley
Added merge_factory parameter to merge_flex
352
                                                  ignore_zero=ignore_zero),
974.1.17 by Aaron Bentley
Switched to using a set of interesting file_ids instead of SourceFile attribute
353
                             merge_factory=merge_factory, 
354
                             interesting_ids=interesting_ids)
493 by Martin Pool
- Merge aaron's merge command
355
356
    adjust_ids = []
357
    for id, path in inv_changes.iteritems():
358
        if path is not None:
359
            if path == '.':
360
                path = ''
361
            else:
974.1.19 by Aaron Bentley
Removed MergeTree.inventory
362
                assert path.startswith('./'), "path is %s" % path
493 by Martin Pool
- Merge aaron's merge command
363
            path = path[2:]
364
        adjust_ids.append((path, id))
974.1.13 by aaron.bentley at utoronto
Avoid rewriting inventory when not necessary
365
    if len(adjust_ids) > 0:
366
        this_branch.set_inventory(regen_inventory(this_branch, this_tree.root,
367
                                                  adjust_ids))
493 by Martin Pool
- Merge aaron's merge command
368
369
370
def regen_inventory(this_branch, root, new_entries):
371
    old_entries = this_branch.read_working_inventory()
372
    new_inventory = {}
373
    by_path = {}
974.1.21 by aaron.bentley at utoronto
Handled path generation properly
374
    new_entries_map = {} 
375
    for path, file_id in new_entries:
376
        if path is None:
377
            continue
378
        new_entries_map[file_id] = path
379
380
    def id2path(file_id):
381
        path = new_entries_map.get(file_id)
382
        if path is not None:
383
            return path
384
        entry = old_entries[file_id]
385
        if entry.parent_id is None:
386
            return entry.name
387
        return os.path.join(id2path(entry.parent_id), entry.name)
388
        
493 by Martin Pool
- Merge aaron's merge command
389
    for file_id in old_entries:
390
        entry = old_entries[file_id]
974.1.21 by aaron.bentley at utoronto
Handled path generation properly
391
        path = id2path(file_id)
493 by Martin Pool
- Merge aaron's merge command
392
        new_inventory[file_id] = (path, file_id, entry.parent_id, entry.kind)
393
        by_path[path] = file_id
394
    
395
    deletions = 0
396
    insertions = 0
397
    new_path_list = []
398
    for path, file_id in new_entries:
399
        if path is None:
400
            del new_inventory[file_id]
401
            deletions += 1
402
        else:
403
            new_path_list.append((path, file_id))
404
            if file_id not in old_entries:
405
                insertions += 1
406
    # Ensure no file is added before its parent
407
    new_path_list.sort()
408
    for path, file_id in new_path_list:
409
        if path == '':
410
            parent = None
411
        else:
412
            parent = by_path[os.path.dirname(path)]
413
        kind = bzrlib.osutils.file_kind(os.path.join(root, path))
414
        new_inventory[file_id] = (path, file_id, parent, kind)
415
        by_path[path] = file_id 
416
417
    # Get a list in insertion order
418
    new_inventory_list = new_inventory.values()
419
    mutter ("""Inventory regeneration:
420
old length: %i insertions: %i deletions: %i new_length: %i"""\
421
        % (len(old_entries), insertions, deletions, len(new_inventory_list)))
422
    assert len(new_inventory_list) == len(old_entries) + insertions - deletions
423
    new_inventory_list.sort()
424
    return new_inventory_list
974.1.9 by Aaron Bentley
Added merge-type parameter to merge.
425
426
merge_types = {     "merge3": (ApplyMerge3, "Native diff3-style merge"), 
427
                     "diff3": (Diff3Merge,  "Merge using external diff3")
428
              }
429