~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

- ignore .swp files from upload

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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
 
19
import tempfile
 
20
import shutil
 
21
import errno
 
22
 
 
23
import bzrlib.osutils
 
24
import bzrlib.revision
1
25
from bzrlib.merge_core import merge_flex, ApplyMerge3, BackupBeforeChange
2
26
from bzrlib.changeset import generate_changeset, ExceptionConflictHandler
3
 
from bzrlib.changeset import Inventory, Diff3Merge
4
 
from bzrlib import find_branch
5
 
import bzrlib.osutils
6
 
from bzrlib.errors import BzrCommandError
 
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
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, note
 
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
# NOTABUG: merge is a helper for commandline functions.  merge_inner is the
 
43
#          the core functionality.
14
44
 
15
45
# comments from abentley on irc: merge happens in two stages, each
16
46
# of which generates a changeset object
18
48
# stage 1: generate OLD->OTHER,
19
49
# stage 2: use MINE and OLD->OTHER to generate MINE -> RESULT
20
50
 
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
51
class MergeConflictHandler(ExceptionConflictHandler):
29
52
    """Handle conflicts encountered while merging.
30
53
 
32
55
    conflict that are not explicitly handled cause an exception and
33
56
    terminate the merge.
34
57
    """
35
 
    def __init__(self, dir, ignore_zero=False):
36
 
        ExceptionConflictHandler.__init__(self, dir)
 
58
    def __init__(self, this_tree, base_tree, other_tree, ignore_zero=False):
 
59
        ExceptionConflictHandler.__init__(self)
37
60
        self.conflicts = 0
38
61
        self.ignore_zero = ignore_zero
 
62
        self.this_tree = this_tree
 
63
        self.base_tree = base_tree
 
64
        self.other_tree = other_tree
39
65
 
40
66
    def copy(self, source, dest):
41
67
        """Copy the text and mode of a file
69
95
            last_new_name = name
70
96
        new_name = last_new_name+suffix
71
97
        try:
72
 
            os.rename(name, new_name)
 
98
            rename(name, new_name)
73
99
            return new_name
74
100
        except OSError, e:
75
101
            if e.errno != errno.EEXIST and e.errno != errno.ENOTEMPTY:
93
119
        self.add_suffix(this_path, ".THIS")
94
120
        self.dump(base_lines, this_path+".BASE")
95
121
        self.dump(other_lines, this_path+".OTHER")
96
 
        os.rename(new_file, this_path)
 
122
        rename(new_file, this_path)
97
123
        self.conflict("Diff3 conflict encountered in %s" % this_path)
98
124
 
99
125
    def new_contents_conflict(self, filename, other_contents):
113
139
            % filename)
114
140
        return "skip"
115
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
        relpath = self.this_tree.id2path(file_id)
 
157
        return self.this_tree.tree.abspath(relpath)
 
158
 
 
159
    def add_missing_parents(self, file_id, tree):
 
160
        """If some of the parents for file_id are missing, add them."""
 
161
        entry = tree.tree.inventory[file_id]
 
162
        if entry.parent_id not in self.this_tree:
 
163
            return self.create_all_missing(entry.parent_id, tree)
 
164
        else:
 
165
            return self.abs_this_path(entry.parent_id)
 
166
 
 
167
    def create_all_missing(self, file_id, tree):
 
168
        """Add contents for a file_id and all its parents to a tree."""
 
169
        entry = tree.tree.inventory[file_id]
 
170
        if entry.parent_id is not None and entry.parent_id not in self.this_tree:
 
171
            abspath = self.create_all_missing(entry.parent_id, tree)
 
172
        else:
 
173
            abspath = self.abs_this_path(entry.parent_id)
 
174
        entry_path = os.path.join(abspath, entry.name)
 
175
        if not os.path.isdir(entry_path):
 
176
            self.create(file_id, entry_path, tree)
 
177
        return entry_path
 
178
 
 
179
    def create(self, file_id, path, tree, reverse=False):
 
180
        """Uses tree data to create a filesystem object for the file_id"""
 
181
        from merge_core import get_id_contents
 
182
        get_id_contents(file_id, tree)(path, self, reverse)
 
183
 
 
184
    def missing_for_merge(self, file_id, other_path):
 
185
        """The file_id doesn't exist in THIS, but does in OTHER and BASE"""
 
186
        self.conflict("Other branch modified locally deleted file %s" %
 
187
                      other_path)
 
188
        parent_dir = self.add_missing_parents(file_id, self.other_tree)
 
189
        stem = os.path.join(parent_dir, os.path.basename(other_path))
 
190
        self.create(file_id, stem+".OTHER", self.other_tree)
 
191
        self.create(file_id, stem+".BASE", self.base_tree)
 
192
 
116
193
    def finalize(self):
117
194
        if not self.ignore_zero:
118
 
            print "%d conflicts encountered.\n" % self.conflicts
 
195
            note("%d conflicts encountered.\n" % self.conflicts)
119
196
            
120
 
def get_tree(treespec, temp_root, label):
 
197
def get_tree(treespec, temp_root, label, local_branch=None):
121
198
    location, revno = treespec
122
 
    branch = find_branch(location)
 
199
    branch = Branch.open_containing(location)
123
200
    if revno is None:
 
201
        revision = None
 
202
    elif revno == -1:
 
203
        revision = branch.last_revision()
 
204
    else:
 
205
        revision = branch.get_rev_id(revno)
 
206
    return branch, get_revid_tree(branch, revision, temp_root, label,
 
207
                                  local_branch)
 
208
 
 
209
def get_revid_tree(branch, revision, temp_root, label, local_branch):
 
210
    if revision is None:
124
211
        base_tree = branch.working_tree()
125
 
    elif revno == -1:
126
 
        base_tree = branch.basis_tree()
127
212
    else:
128
 
        base_tree = branch.revision_tree(branch.lookup_revision(revno))
 
213
        if local_branch is not None:
 
214
            greedy_fetch(local_branch, branch, revision)
 
215
            base_tree = local_branch.revision_tree(revision)
 
216
        else:
 
217
            base_tree = branch.revision_tree(revision)
129
218
    temp_path = os.path.join(temp_root, label)
130
219
    os.mkdir(temp_path)
131
 
    return branch, MergeTree(base_tree, temp_path)
 
220
    return MergeTree(base_tree, temp_path)
132
221
 
133
222
 
134
223
def file_exists(tree, file_id):
145
234
        self.tree = tree
146
235
        self.tempdir = tempdir
147
236
        os.mkdir(os.path.join(self.tempdir, "texts"))
 
237
        os.mkdir(os.path.join(self.tempdir, "symlinks"))
148
238
        self.cached = {}
149
239
 
150
240
    def __iter__(self):
159
249
    def get_file_sha1(self, id):
160
250
        return self.tree.get_file_sha1(id)
161
251
 
 
252
    def is_executable(self, id):
 
253
        return self.tree.is_executable(id)
 
254
 
162
255
    def id2path(self, file_id):
163
256
        return self.tree.id2path(file_id)
164
257
 
165
258
    def has_id(self, file_id):
166
259
        return self.tree.has_id(file_id)
167
260
 
 
261
    def has_or_had_id(self, file_id):
 
262
        if file_id == self.tree.inventory.root.file_id:
 
263
            return True
 
264
        return self.tree.inventory.has_id(file_id)
 
265
 
 
266
    def has_or_had_id(self, file_id):
 
267
        if file_id == self.tree.inventory.root.file_id:
 
268
            return True
 
269
        return self.tree.inventory.has_id(file_id)
 
270
 
168
271
    def readonly_path(self, id):
169
272
        if id not in self.tree:
170
273
            return None
171
274
        if self.root is not None:
172
275
            return self.tree.abspath(self.tree.id2path(id))
173
276
        else:
174
 
            if self.tree.inventory[id].kind in ("directory", "root_directory"):
 
277
            kind = self.tree.inventory[id].kind
 
278
            if kind in ("directory", "root_directory"):
175
279
                return self.tempdir
176
280
            if not self.cached.has_key(id):
177
 
                path = os.path.join(self.tempdir, "texts", id)
178
 
                outfile = file(path, "wb")
179
 
                outfile.write(self.tree.get_file(id).read())
180
 
                assert(os.path.exists(path))
 
281
                if kind == "file":
 
282
                    path = os.path.join(self.tempdir, "texts", id)
 
283
                    outfile = file(path, "wb")
 
284
                    outfile.write(self.tree.get_file(id).read())
 
285
                    assert(bzrlib.osutils.lexists(path))
 
286
                    if self.tree.is_executable(id):
 
287
                        os.chmod(path, 0755)
 
288
                else:
 
289
                    assert kind == "symlink"
 
290
                    path = os.path.join(self.tempdir, "symlinks", id)
 
291
                    target = self.tree.get_symlink_target(id)
 
292
                    os.symlink(target, path)
181
293
                self.cached[id] = path
182
294
            return self.cached[id]
183
295
 
184
296
 
 
297
def build_working_dir(to_dir):
 
298
    """Build a working directory in an empty directory.
 
299
 
 
300
    to_dir is a directory containing branch metadata but no working files,
 
301
    typically constructed by cloning an existing branch. 
 
302
 
 
303
    This is split out as a special idiomatic case of merge.  It could
 
304
    eventually be done by just building the tree directly calling into 
 
305
    lower-level code (e.g. constructing a changeset).
 
306
    """
 
307
    merge((to_dir, -1), (to_dir, 0), this_dir=to_dir,
 
308
          check_clean=False, ignore_zero=True)
 
309
 
185
310
 
186
311
def merge(other_revision, base_revision,
187
312
          check_clean=True, ignore_zero=False,
190
315
    """Merge changes into a tree.
191
316
 
192
317
    base_revision
193
 
        Base for three-way merge.
 
318
        tuple(path, revision) Base for three-way merge.
194
319
    other_revision
195
 
        Other revision for three-way merge.
 
320
        tuple(path, revision) Other revision for three-way merge.
196
321
    this_dir
197
322
        Directory to merge changes into; '.' by default.
198
323
    check_clean
199
324
        If true, this_dir must have no uncommitted changes before the
200
325
        merge begins.
 
326
    ignore_zero - If true, suppress the "zero conflicts" message when 
 
327
        there are no conflicts; should be set when doing something we expect
 
328
        to complete perfectly.
 
329
 
 
330
    All available ancestors of other_revision and base_revision are
 
331
    automatically pulled into the branch.
201
332
    """
202
333
    tempdir = tempfile.mkdtemp(prefix="bzr-")
203
334
    try:
204
335
        if this_dir is None:
205
336
            this_dir = '.'
206
 
        this_branch = find_branch(this_dir)
 
337
        this_branch = Branch.open_containing(this_dir)
 
338
        this_rev_id = this_branch.last_revision()
 
339
        if this_rev_id is None:
 
340
            raise BzrCommandError("This branch has no commits")
207
341
        if check_clean:
208
342
            changes = compare_trees(this_branch.working_tree(), 
209
343
                                    this_branch.basis_tree(), False)
210
344
            if changes.has_changed():
211
345
                raise BzrCommandError("Working tree has uncommitted changes.")
212
 
        other_branch, other_tree = get_tree(other_revision, tempdir, "other")
 
346
        other_branch, other_tree = get_tree(other_revision, tempdir, "other",
 
347
                                            this_branch)
 
348
        if other_revision[1] == -1:
 
349
            other_rev_id = other_branch.last_revision()
 
350
            if other_rev_id is None:
 
351
                raise NoCommits(other_branch)
 
352
            other_basis = other_rev_id
 
353
        elif other_revision[1] is not None:
 
354
            other_rev_id = other_branch.get_rev_id(other_revision[1])
 
355
            other_basis = other_rev_id
 
356
        else:
 
357
            other_rev_id = None
 
358
            other_basis = other_branch.last_revision()
 
359
            if other_basis is None:
 
360
                raise NoCommits(other_branch)
213
361
        if base_revision == [None, None]:
214
 
            if other_revision[1] == -1:
215
 
                o_revno = None
216
 
            else:
217
 
                o_revno = other_revision[1]
218
 
            base_revno = this_branch.common_ancestor(other_branch, 
219
 
                                                     other_revno=o_revno)[0]
220
 
            if base_revno is None:
 
362
            try:
 
363
                base_rev_id = common_ancestor(this_rev_id, other_basis, 
 
364
                                              this_branch)
 
365
            except NoCommonAncestor:
221
366
                raise UnrelatedBranches()
222
 
            base_revision = ['.', base_revno]
223
 
        base_branch, base_tree = get_tree(base_revision, tempdir, "base")
 
367
            base_tree = get_revid_tree(this_branch, base_rev_id, tempdir, 
 
368
                                       "base", None)
 
369
            base_is_ancestor = True
 
370
        else:
 
371
            base_branch, base_tree = get_tree(base_revision, tempdir, "base")
 
372
            if base_revision[1] == -1:
 
373
                base_rev_id = base_branch.last_revision()
 
374
            elif base_revision[1] is None:
 
375
                base_rev_id = None
 
376
            else:
 
377
                base_rev_id = base_branch.get_rev_id(base_revision[1])
 
378
            fetch(from_branch=base_branch, to_branch=this_branch)
 
379
            base_is_ancestor = is_ancestor(this_rev_id, base_rev_id,
 
380
                                           this_branch)
224
381
        if file_list is None:
225
382
            interesting_ids = None
226
383
        else:
240
397
        merge_inner(this_branch, other_tree, base_tree, tempdir, 
241
398
                    ignore_zero=ignore_zero, backup_files=backup_files, 
242
399
                    merge_type=merge_type, interesting_ids=interesting_ids)
 
400
        if base_is_ancestor and other_rev_id is not None\
 
401
            and other_rev_id not in this_branch.revision_history():
 
402
            this_branch.add_pending_merge(other_rev_id)
243
403
    finally:
244
404
        shutil.rmtree(tempdir)
245
405
 
252
412
             source_file.interesting = source_file.id in interesting_ids
253
413
 
254
414
 
255
 
def generate_cset_optimized(tree_a, tree_b, interesting_ids=None):
256
 
    """Generate a changeset.  If interesting_ids is supplied, only changes
257
 
    to those files will be shown.  Metadata changes are stripped.
258
 
    """ 
259
 
    cset =  generate_changeset(tree_a, tree_b, interesting_ids)
260
 
    for entry in cset.entries.itervalues():
261
 
        entry.metadata_change = None
262
 
    return cset
263
 
 
264
 
 
265
415
def merge_inner(this_branch, other_tree, base_tree, tempdir, 
266
416
                ignore_zero=False, merge_type=ApplyMerge3, backup_files=False,
267
417
                interesting_ids=None):
278
428
        return tree.tree.inventory
279
429
 
280
430
    inv_changes = merge_flex(this_tree, base_tree, other_tree,
281
 
                             generate_cset_optimized, get_inventory,
282
 
                             MergeConflictHandler(base_tree.root,
283
 
                                                  ignore_zero=ignore_zero),
 
431
                             generate_changeset, get_inventory,
 
432
                             MergeConflictHandler(this_tree, base_tree,
 
433
                             other_tree, ignore_zero=ignore_zero),
284
434
                             merge_factory=merge_factory, 
285
435
                             interesting_ids=interesting_ids)
286
436
 
290
440
            if path == '.':
291
441
                path = ''
292
442
            else:
293
 
                assert path.startswith('./'), "path is %s" % path
 
443
                assert path.startswith('.' + os.sep), "path is %s" % path
294
444
            path = path[2:]
295
445
        adjust_ids.append((path, id))
296
446
    if len(adjust_ids) > 0: