1
# Copyright (C) 2005, 2006 Canonical Ltd
 
 
4
#   Johan Rydberg <jrydberg@gnu.org>
 
 
6
# This program is free software; you can redistribute it and/or modify
 
 
7
# it under the terms of the GNU General Public License as published by
 
 
8
# the Free Software Foundation; either version 2 of the License, or
 
 
9
# (at your option) any later version.
 
 
11
# This program is distributed in the hope that it will be useful,
 
 
12
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
 
13
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
 
14
# GNU General Public License for more details.
 
 
16
# You should have received a copy of the GNU General Public License
 
 
17
# along with this program; if not, write to the Free Software
 
 
18
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 
20
"""Versioned text file storage api."""
 
 
22
from bzrlib.lazy_import import lazy_import
 
 
23
lazy_import(globals(), """
 
 
33
from bzrlib.graph import Graph
 
 
34
from bzrlib.transport.memory import MemoryTransport
 
 
37
from cStringIO import StringIO
 
 
39
from bzrlib.inter import InterObject
 
 
40
from bzrlib.symbol_versioning import *
 
 
41
from bzrlib.textmerge import TextMerge
 
 
44
class VersionedFile(object):
 
 
45
    """Versioned text file storage.
 
 
47
    A versioned file manages versions of line-based text files,
 
 
48
    keeping track of the originating version for each line.
 
 
50
    To clients the "lines" of the file are represented as a list of
 
 
51
    strings. These strings will typically have terminal newline
 
 
52
    characters, but this is not required.  In particular files commonly
 
 
53
    do not have a newline at the end of the file.
 
 
55
    Texts are identified by a version-id string.
 
 
59
    def check_not_reserved_id(version_id):
 
 
60
        revision.check_not_reserved_id(version_id)
 
 
62
    def copy_to(self, name, transport):
 
 
63
        """Copy this versioned file to name on transport."""
 
 
64
        raise NotImplementedError(self.copy_to)
 
 
67
        """Return a unsorted list of versions."""
 
 
68
        raise NotImplementedError(self.versions)
 
 
70
    @deprecated_method(one_four)
 
 
71
    def has_ghost(self, version_id):
 
 
72
        """Returns whether version is present as a ghost."""
 
 
73
        raise NotImplementedError(self.has_ghost)
 
 
75
    def has_version(self, version_id):
 
 
76
        """Returns whether version is present."""
 
 
77
        raise NotImplementedError(self.has_version)
 
 
79
    def add_lines(self, version_id, parents, lines, parent_texts=None,
 
 
80
        left_matching_blocks=None, nostore_sha=None, random_id=False,
 
 
82
        """Add a single text on top of the versioned file.
 
 
84
        Must raise RevisionAlreadyPresent if the new version is
 
 
85
        already present in file history.
 
 
87
        Must raise RevisionNotPresent if any of the given parents are
 
 
88
        not present in file history.
 
 
90
        :param lines: A list of lines. Each line must be a bytestring. And all
 
 
91
            of them except the last must be terminated with \n and contain no
 
 
92
            other \n's. The last line may either contain no \n's or a single
 
 
93
            terminated \n. If the lines list does meet this constraint the add
 
 
94
            routine may error or may succeed - but you will be unable to read
 
 
95
            the data back accurately. (Checking the lines have been split
 
 
96
            correctly is expensive and extremely unlikely to catch bugs so it
 
 
97
            is not done at runtime unless check_content is True.)
 
 
98
        :param parent_texts: An optional dictionary containing the opaque 
 
 
99
            representations of some or all of the parents of version_id to
 
 
100
            allow delta optimisations.  VERY IMPORTANT: the texts must be those
 
 
101
            returned by add_lines or data corruption can be caused.
 
 
102
        :param left_matching_blocks: a hint about which areas are common
 
 
103
            between the text and its left-hand-parent.  The format is
 
 
104
            the SequenceMatcher.get_matching_blocks format.
 
 
105
        :param nostore_sha: Raise ExistingContent and do not add the lines to
 
 
106
            the versioned file if the digest of the lines matches this.
 
 
107
        :param random_id: If True a random id has been selected rather than
 
 
108
            an id determined by some deterministic process such as a converter
 
 
109
            from a foreign VCS. When True the backend may choose not to check
 
 
110
            for uniqueness of the resulting key within the versioned file, so
 
 
111
            this should only be done when the result is expected to be unique
 
 
113
        :param check_content: If True, the lines supplied are verified to be
 
 
114
            bytestrings that are correctly formed lines.
 
 
115
        :return: The text sha1, the number of bytes in the text, and an opaque
 
 
116
                 representation of the inserted version which can be provided
 
 
117
                 back to future add_lines calls in the parent_texts dictionary.
 
 
119
        self._check_write_ok()
 
 
120
        return self._add_lines(version_id, parents, lines, parent_texts,
 
 
121
            left_matching_blocks, nostore_sha, random_id, check_content)
 
 
123
    def _add_lines(self, version_id, parents, lines, parent_texts,
 
 
124
        left_matching_blocks, nostore_sha, random_id, check_content):
 
 
125
        """Helper to do the class specific add_lines."""
 
 
126
        raise NotImplementedError(self.add_lines)
 
 
128
    def add_lines_with_ghosts(self, version_id, parents, lines,
 
 
129
        parent_texts=None, nostore_sha=None, random_id=False,
 
 
130
        check_content=True, left_matching_blocks=None):
 
 
131
        """Add lines to the versioned file, allowing ghosts to be present.
 
 
133
        This takes the same parameters as add_lines and returns the same.
 
 
135
        self._check_write_ok()
 
 
136
        return self._add_lines_with_ghosts(version_id, parents, lines,
 
 
137
            parent_texts, nostore_sha, random_id, check_content, left_matching_blocks)
 
 
139
    def _add_lines_with_ghosts(self, version_id, parents, lines, parent_texts,
 
 
140
        nostore_sha, random_id, check_content, left_matching_blocks):
 
 
141
        """Helper to do class specific add_lines_with_ghosts."""
 
 
142
        raise NotImplementedError(self.add_lines_with_ghosts)
 
 
144
    def check(self, progress_bar=None):
 
 
145
        """Check the versioned file for integrity."""
 
 
146
        raise NotImplementedError(self.check)
 
 
148
    def _check_lines_not_unicode(self, lines):
 
 
149
        """Check that lines being added to a versioned file are not unicode."""
 
 
151
            if line.__class__ is not str:
 
 
152
                raise errors.BzrBadParameterUnicode("lines")
 
 
154
    def _check_lines_are_lines(self, lines):
 
 
155
        """Check that the lines really are full lines without inline EOL."""
 
 
157
            if '\n' in line[:-1]:
 
 
158
                raise errors.BzrBadParameterContainsNewline("lines")
 
 
160
    @deprecated_method(one_four)
 
 
161
    def enable_cache(self):
 
 
162
        """Tell this versioned file that it should cache any data it reads.
 
 
164
        This is advisory, implementations do not have to support caching.
 
 
168
    @deprecated_method(one_four)
 
 
169
    def clear_cache(self):
 
 
170
        """Remove any data cached in the versioned file object.
 
 
172
        This only needs to be supported if caches are supported
 
 
176
    @deprecated_method(one_four)
 
 
177
    def clone_text(self, new_version_id, old_version_id, parents):
 
 
178
        """Add an identical text to old_version_id as new_version_id.
 
 
180
        Must raise RevisionNotPresent if the old version or any of the
 
 
181
        parents are not present in file history.
 
 
183
        Must raise RevisionAlreadyPresent if the new version is
 
 
184
        already present in file history."""
 
 
185
        self._check_write_ok()
 
 
186
        return self.add_lines(new_version_id, parents,
 
 
187
            self.get_lines(old_version_id))
 
 
189
    def get_format_signature(self):
 
 
190
        """Get a text description of the data encoding in this file.
 
 
194
        raise NotImplementedError(self.get_format_signature)
 
 
196
    def make_mpdiffs(self, version_ids):
 
 
197
        """Create multiparent diffs for specified versions."""
 
 
198
        knit_versions = set()
 
 
199
        knit_versions.update(version_ids)
 
 
200
        parent_map = self.get_parent_map(version_ids)
 
 
201
        for version_id in version_ids:
 
 
203
                knit_versions.update(parent_map[version_id])
 
 
205
                raise RevisionNotPresent(version_id, self)
 
 
206
        # We need to filter out ghosts, because we can't diff against them.
 
 
207
        knit_versions = set(self.get_parent_map(knit_versions).keys())
 
 
208
        lines = dict(zip(knit_versions,
 
 
209
            self._get_lf_split_line_list(knit_versions)))
 
 
211
        for version_id in version_ids:
 
 
212
            target = lines[version_id]
 
 
214
                parents = [lines[p] for p in parent_map[version_id] if p in
 
 
217
                raise RevisionNotPresent(version_id, self)
 
 
219
                left_parent_blocks = self._extract_blocks(version_id,
 
 
222
                left_parent_blocks = None
 
 
223
            diffs.append(multiparent.MultiParent.from_lines(target, parents,
 
 
227
    def _extract_blocks(self, version_id, source, target):
 
 
230
    def add_mpdiffs(self, records):
 
 
231
        """Add mpdiffs to this VersionedFile.
 
 
233
        Records should be iterables of version, parents, expected_sha1,
 
 
234
        mpdiff. mpdiff should be a MultiParent instance.
 
 
236
        # Does this need to call self._check_write_ok()? (IanC 20070919)
 
 
238
        mpvf = multiparent.MultiMemoryVersionedFile()
 
 
240
        for version, parent_ids, expected_sha1, mpdiff in records:
 
 
241
            versions.append(version)
 
 
242
            mpvf.add_diff(mpdiff, version, parent_ids)
 
 
243
        needed_parents = set()
 
 
244
        for version, parent_ids, expected_sha1, mpdiff in records:
 
 
245
            needed_parents.update(p for p in parent_ids
 
 
246
                                  if not mpvf.has_version(p))
 
 
247
        present_parents = set(self.get_parent_map(needed_parents).keys())
 
 
248
        for parent_id, lines in zip(present_parents,
 
 
249
                                 self._get_lf_split_line_list(present_parents)):
 
 
250
            mpvf.add_version(lines, parent_id, [])
 
 
251
        for (version, parent_ids, expected_sha1, mpdiff), lines in\
 
 
252
            zip(records, mpvf.get_line_list(versions)):
 
 
253
            if len(parent_ids) == 1:
 
 
254
                left_matching_blocks = list(mpdiff.get_matching_blocks(0,
 
 
255
                    mpvf.get_diff(parent_ids[0]).num_lines()))
 
 
257
                left_matching_blocks = None
 
 
259
                _, _, version_text = self.add_lines_with_ghosts(version,
 
 
260
                    parent_ids, lines, vf_parents,
 
 
261
                    left_matching_blocks=left_matching_blocks)
 
 
262
            except NotImplementedError:
 
 
263
                # The vf can't handle ghosts, so add lines normally, which will
 
 
264
                # (reasonably) fail if there are ghosts in the data.
 
 
265
                _, _, version_text = self.add_lines(version,
 
 
266
                    parent_ids, lines, vf_parents,
 
 
267
                    left_matching_blocks=left_matching_blocks)
 
 
268
            vf_parents[version] = version_text
 
 
269
        for (version, parent_ids, expected_sha1, mpdiff), sha1 in\
 
 
270
             zip(records, self.get_sha1s(versions)):
 
 
271
            if expected_sha1 != sha1:
 
 
272
                raise errors.VersionedFileInvalidChecksum(version)
 
 
274
    @deprecated_method(one_four)
 
 
275
    def get_sha1(self, version_id):
 
 
276
        """Get the stored sha1 sum for the given revision.
 
 
278
        :param version_id: The name of the version to lookup
 
 
280
        return self.get_sha1s([version_id])[0]
 
 
282
    def get_sha1s(self, version_ids):
 
 
283
        """Get the stored sha1 sums for the given revisions.
 
 
285
        :param version_ids: The names of the versions to lookup
 
 
286
        :return: a list of sha1s in order according to the version_ids
 
 
288
        raise NotImplementedError(self.get_sha1s)
 
 
290
    def get_text(self, version_id):
 
 
291
        """Return version contents as a text string.
 
 
293
        Raises RevisionNotPresent if version is not present in
 
 
296
        return ''.join(self.get_lines(version_id))
 
 
297
    get_string = get_text
 
 
299
    def get_texts(self, version_ids):
 
 
300
        """Return the texts of listed versions as a list of strings.
 
 
302
        Raises RevisionNotPresent if version is not present in
 
 
305
        return [''.join(self.get_lines(v)) for v in version_ids]
 
 
307
    def get_lines(self, version_id):
 
 
308
        """Return version contents as a sequence of lines.
 
 
310
        Raises RevisionNotPresent if version is not present in
 
 
313
        raise NotImplementedError(self.get_lines)
 
 
315
    def _get_lf_split_line_list(self, version_ids):
 
 
316
        return [StringIO(t).readlines() for t in self.get_texts(version_ids)]
 
 
318
    def get_ancestry(self, version_ids, topo_sorted=True):
 
 
319
        """Return a list of all ancestors of given version(s). This
 
 
320
        will not include the null revision.
 
 
322
        This list will not be topologically sorted if topo_sorted=False is
 
 
325
        Must raise RevisionNotPresent if any of the given versions are
 
 
326
        not present in file history."""
 
 
327
        if isinstance(version_ids, basestring):
 
 
328
            version_ids = [version_ids]
 
 
329
        raise NotImplementedError(self.get_ancestry)
 
 
331
    def get_ancestry_with_ghosts(self, version_ids):
 
 
332
        """Return a list of all ancestors of given version(s). This
 
 
333
        will not include the null revision.
 
 
335
        Must raise RevisionNotPresent if any of the given versions are
 
 
336
        not present in file history.
 
 
338
        Ghosts that are known about will be included in ancestry list,
 
 
339
        but are not explicitly marked.
 
 
341
        raise NotImplementedError(self.get_ancestry_with_ghosts)
 
 
343
    @deprecated_method(one_four)
 
 
344
    def get_graph(self, version_ids=None):
 
 
345
        """Return a graph from the versioned file. 
 
 
347
        Ghosts are not listed or referenced in the graph.
 
 
348
        :param version_ids: Versions to select.
 
 
349
                            None means retrieve all versions.
 
 
351
        if version_ids is None:
 
 
352
            result = self.get_parent_map(self.versions())
 
 
355
            pending = set(version_ids)
 
 
357
                this_iteration = pending
 
 
359
                parents = self.get_parent_map(this_iteration)
 
 
360
                for version, parents in parents.iteritems():
 
 
361
                    result[version] = parents
 
 
362
                    for parent in parents:
 
 
367
        for parents in result.itervalues():
 
 
368
            references.update(parents)
 
 
369
        existing_parents = self.get_parent_map(references)
 
 
370
        for key, parents in result.iteritems():
 
 
371
            present_parents = [parent for parent in parents if parent in
 
 
373
            result[key] = tuple(present_parents)
 
 
376
    @deprecated_method(one_four)
 
 
377
    def get_graph_with_ghosts(self):
 
 
378
        """Return a graph for the entire versioned file.
 
 
380
        Ghosts are referenced in parents list but are not
 
 
383
        raise NotImplementedError(self.get_graph_with_ghosts)
 
 
385
    def get_parent_map(self, version_ids):
 
 
386
        """Get a map of the parents of version_ids.
 
 
388
        :param version_ids: The version ids to look up parents for.
 
 
389
        :return: A mapping from version id to parents.
 
 
391
        raise NotImplementedError(self.get_parent_map)
 
 
393
    @deprecated_method(one_four)
 
 
394
    def get_parents(self, version_id):
 
 
395
        """Return version names for parents of a version.
 
 
397
        Must raise RevisionNotPresent if version is not present in
 
 
401
            all = self.get_parent_map([version_id])[version_id]
 
 
403
            raise errors.RevisionNotPresent(version_id, self)
 
 
405
        parent_parents = self.get_parent_map(all)
 
 
406
        for version_id in all:
 
 
407
            if version_id in parent_parents:
 
 
408
                result.append(version_id)
 
 
411
    def get_parents_with_ghosts(self, version_id):
 
 
412
        """Return version names for parents of version_id.
 
 
414
        Will raise RevisionNotPresent if version_id is not present
 
 
417
        Ghosts that are known about will be included in the parent list,
 
 
418
        but are not explicitly marked.
 
 
421
            return list(self.get_parent_map([version_id])[version_id])
 
 
423
            raise errors.RevisionNotPresent(version_id, self)
 
 
425
    @deprecated_method(one_four)
 
 
426
    def annotate_iter(self, version_id):
 
 
427
        """Yield list of (version-id, line) pairs for the specified
 
 
430
        Must raise RevisionNotPresent if the given version is
 
 
431
        not present in file history.
 
 
433
        return iter(self.annotate(version_id))
 
 
435
    def annotate(self, version_id):
 
 
436
        """Return a list of (version-id, line) tuples for version_id.
 
 
438
        :raise RevisionNotPresent: If the given version is
 
 
439
        not present in file history.
 
 
441
        raise NotImplementedError(self.annotate)
 
 
443
    def join(self, other, pb=None, msg=None, version_ids=None,
 
 
444
             ignore_missing=False):
 
 
445
        """Integrate versions from other into this versioned file.
 
 
447
        If version_ids is None all versions from other should be
 
 
448
        incorporated into this versioned file.
 
 
450
        Must raise RevisionNotPresent if any of the specified versions
 
 
451
        are not present in the other file's history unless ignore_missing
 
 
452
        is supplied in which case they are silently skipped.
 
 
454
        self._check_write_ok()
 
 
455
        return InterVersionedFile.get(other, self).join(
 
 
461
    def iter_lines_added_or_present_in_versions(self, version_ids=None,
 
 
463
        """Iterate over the lines in the versioned file from version_ids.
 
 
465
        This may return lines from other versions. Each item the returned
 
 
466
        iterator yields is a tuple of a line and a text version that that line
 
 
467
        is present in (not introduced in).
 
 
469
        Ordering of results is in whatever order is most suitable for the
 
 
470
        underlying storage format.
 
 
472
        If a progress bar is supplied, it may be used to indicate progress.
 
 
473
        The caller is responsible for cleaning up progress bars (because this
 
 
476
        NOTES: Lines are normalised: they will all have \n terminators.
 
 
477
               Lines are returned in arbitrary order.
 
 
479
        :return: An iterator over (line, version_id).
 
 
481
        raise NotImplementedError(self.iter_lines_added_or_present_in_versions)
 
 
483
    @deprecated_method(one_four)
 
 
484
    def iter_parents(self, version_ids):
 
 
485
        """Iterate through the parents for many version ids.
 
 
487
        :param version_ids: An iterable yielding version_ids.
 
 
488
        :return: An iterator that yields (version_id, parents). Requested 
 
 
489
            version_ids not present in the versioned file are simply skipped.
 
 
490
            The order is undefined, allowing for different optimisations in
 
 
491
            the underlying implementation.
 
 
493
        return self.get_parent_map(version_ids).iteritems()
 
 
495
    def plan_merge(self, ver_a, ver_b):
 
 
496
        """Return pseudo-annotation indicating how the two versions merge.
 
 
498
        This is computed between versions a and b and their common
 
 
501
        Weave lines present in none of them are skipped entirely.
 
 
504
        killed-base Dead in base revision
 
 
505
        killed-both Killed in each revision
 
 
508
        unchanged   Alive in both a and b (possibly created in both)
 
 
511
        ghost-a     Killed in a, unborn in b    
 
 
512
        ghost-b     Killed in b, unborn in a
 
 
513
        irrelevant  Not in either revision
 
 
515
        raise NotImplementedError(VersionedFile.plan_merge)
 
 
517
    def weave_merge(self, plan, a_marker=TextMerge.A_MARKER,
 
 
518
                    b_marker=TextMerge.B_MARKER):
 
 
519
        return PlanWeaveMerge(plan, a_marker, b_marker).merge_lines()[0]
 
 
522
class _PlanMergeVersionedFile(object):
 
 
523
    """A VersionedFile for uncommitted and committed texts.
 
 
525
    It is intended to allow merges to be planned with working tree texts.
 
 
526
    It implements only the small part of the VersionedFile interface used by
 
 
527
    PlanMerge.  It falls back to multiple versionedfiles for data not stored in
 
 
528
    _PlanMergeVersionedFile itself.
 
 
531
    def __init__(self, file_id, fallback_versionedfiles=None):
 
 
534
        :param file_id: Used when raising exceptions.
 
 
535
        :param fallback_versionedfiles: If supplied, the set of fallbacks to
 
 
536
            use.  Otherwise, _PlanMergeVersionedFile.fallback_versionedfiles
 
 
537
            can be appended to later.
 
 
539
        self._file_id = file_id
 
 
540
        if fallback_versionedfiles is None:
 
 
541
            self.fallback_versionedfiles = []
 
 
543
            self.fallback_versionedfiles = fallback_versionedfiles
 
 
547
    def plan_merge(self, ver_a, ver_b, base=None):
 
 
548
        """See VersionedFile.plan_merge"""
 
 
549
        from bzrlib.merge import _PlanMerge
 
 
551
            return _PlanMerge(ver_a, ver_b, self).plan_merge()
 
 
552
        old_plan = list(_PlanMerge(ver_a, base, self).plan_merge())
 
 
553
        new_plan = list(_PlanMerge(ver_a, ver_b, self).plan_merge())
 
 
554
        return _PlanMerge._subtract_plans(old_plan, new_plan)
 
 
556
    def plan_lca_merge(self, ver_a, ver_b, base=None):
 
 
557
        from bzrlib.merge import _PlanLCAMerge
 
 
558
        graph = self._get_graph()
 
 
559
        new_plan = _PlanLCAMerge(ver_a, ver_b, self, graph).plan_merge()
 
 
562
        old_plan = _PlanLCAMerge(ver_a, base, self, graph).plan_merge()
 
 
563
        return _PlanLCAMerge._subtract_plans(list(old_plan), list(new_plan))
 
 
565
    def add_lines(self, version_id, parents, lines):
 
 
566
        """See VersionedFile.add_lines
 
 
568
        Lines are added locally, not fallback versionedfiles.  Also, ghosts are
 
 
569
        permitted.  Only reserved ids are permitted.
 
 
571
        if not revision.is_reserved_id(version_id):
 
 
572
            raise ValueError('Only reserved ids may be used')
 
 
574
            raise ValueError('Parents may not be None')
 
 
576
            raise ValueError('Lines may not be None')
 
 
577
        self._parents[version_id] = tuple(parents)
 
 
578
        self._lines[version_id] = lines
 
 
580
    def get_lines(self, version_id):
 
 
581
        """See VersionedFile.get_ancestry"""
 
 
582
        lines = self._lines.get(version_id)
 
 
583
        if lines is not None:
 
 
585
        for versionedfile in self.fallback_versionedfiles:
 
 
587
                return versionedfile.get_lines(version_id)
 
 
588
            except errors.RevisionNotPresent:
 
 
591
            raise errors.RevisionNotPresent(version_id, self._file_id)
 
 
593
    def get_ancestry(self, version_id, topo_sorted=False):
 
 
594
        """See VersionedFile.get_ancestry.
 
 
596
        Note that this implementation assumes that if a VersionedFile can
 
 
597
        answer get_ancestry at all, it can give an authoritative answer.  In
 
 
598
        fact, ghosts can invalidate this assumption.  But it's good enough
 
 
599
        99% of the time, and far cheaper/simpler.
 
 
601
        Also note that the results of this version are never topologically
 
 
602
        sorted, and are a set.
 
 
605
            raise ValueError('This implementation does not provide sorting')
 
 
606
        parents = self._parents.get(version_id)
 
 
608
            for vf in self.fallback_versionedfiles:
 
 
610
                    return vf.get_ancestry(version_id, topo_sorted=False)
 
 
611
                except errors.RevisionNotPresent:
 
 
614
                raise errors.RevisionNotPresent(version_id, self._file_id)
 
 
615
        ancestry = set([version_id])
 
 
616
        for parent in parents:
 
 
617
            ancestry.update(self.get_ancestry(parent, topo_sorted=False))
 
 
620
    def get_parent_map(self, version_ids):
 
 
621
        """See VersionedFile.get_parent_map"""
 
 
623
        pending = set(version_ids)
 
 
624
        for key in version_ids:
 
 
626
                result[key] = self._parents[key]
 
 
629
        pending = pending - set(result.keys())
 
 
630
        for versionedfile in self.fallback_versionedfiles:
 
 
631
            parents = versionedfile.get_parent_map(pending)
 
 
632
            result.update(parents)
 
 
633
            pending = pending - set(parents.keys())
 
 
638
    def _get_graph(self):
 
 
639
        from bzrlib.graph import (
 
 
642
            _StackedParentsProvider,
 
 
644
        from bzrlib.repofmt.knitrepo import _KnitParentsProvider
 
 
645
        parent_providers = [DictParentsProvider(self._parents)]
 
 
646
        for vf in self.fallback_versionedfiles:
 
 
647
            parent_providers.append(_KnitParentsProvider(vf))
 
 
648
        return Graph(_StackedParentsProvider(parent_providers))
 
 
651
class PlanWeaveMerge(TextMerge):
 
 
652
    """Weave merge that takes a plan as its input.
 
 
654
    This exists so that VersionedFile.plan_merge is implementable.
 
 
655
    Most callers will want to use WeaveMerge instead.
 
 
658
    def __init__(self, plan, a_marker=TextMerge.A_MARKER,
 
 
659
                 b_marker=TextMerge.B_MARKER):
 
 
660
        TextMerge.__init__(self, a_marker, b_marker)
 
 
663
    def _merge_struct(self):
 
 
668
        def outstanding_struct():
 
 
669
            if not lines_a and not lines_b:
 
 
671
            elif ch_a and not ch_b:
 
 
674
            elif ch_b and not ch_a:
 
 
676
            elif lines_a == lines_b:
 
 
679
                yield (lines_a, lines_b)
 
 
681
        # We previously considered either 'unchanged' or 'killed-both' lines
 
 
682
        # to be possible places to resynchronize.  However, assuming agreement
 
 
683
        # on killed-both lines may be too aggressive. -- mbp 20060324
 
 
684
        for state, line in self.plan:
 
 
685
            if state == 'unchanged':
 
 
686
                # resync and flush queued conflicts changes if any
 
 
687
                for struct in outstanding_struct():
 
 
693
            if state == 'unchanged':
 
 
696
            elif state == 'killed-a':
 
 
699
            elif state == 'killed-b':
 
 
702
            elif state == 'new-a':
 
 
705
            elif state == 'new-b':
 
 
708
            elif state == 'conflicted-a':
 
 
711
            elif state == 'conflicted-b':
 
 
715
                if state not in ('irrelevant', 'ghost-a', 'ghost-b',
 
 
716
                        'killed-base', 'killed-both'):
 
 
717
                    raise AssertionError(state)
 
 
718
        for struct in outstanding_struct():
 
 
722
class WeaveMerge(PlanWeaveMerge):
 
 
723
    """Weave merge that takes a VersionedFile and two versions as its input."""
 
 
725
    def __init__(self, versionedfile, ver_a, ver_b, 
 
 
726
        a_marker=PlanWeaveMerge.A_MARKER, b_marker=PlanWeaveMerge.B_MARKER):
 
 
727
        plan = versionedfile.plan_merge(ver_a, ver_b)
 
 
728
        PlanWeaveMerge.__init__(self, plan, a_marker, b_marker)
 
 
731
class InterVersionedFile(InterObject):
 
 
732
    """This class represents operations taking place between two VersionedFiles.
 
 
734
    Its instances have methods like join, and contain
 
 
735
    references to the source and target versionedfiles these operations can be 
 
 
738
    Often we will provide convenience methods on 'versionedfile' which carry out
 
 
739
    operations with another versionedfile - they will always forward to
 
 
740
    InterVersionedFile.get(other).method_name(parameters).
 
 
744
    """The available optimised InterVersionedFile types."""
 
 
746
    def join(self, pb=None, msg=None, version_ids=None, ignore_missing=False):
 
 
747
        """Integrate versions from self.source into self.target.
 
 
749
        If version_ids is None all versions from source should be
 
 
750
        incorporated into this versioned file.
 
 
752
        Must raise RevisionNotPresent if any of the specified versions
 
 
753
        are not present in the other file's history unless ignore_missing is 
 
 
754
        supplied in which case they are silently skipped.
 
 
757
        version_ids = self._get_source_version_ids(version_ids, ignore_missing)
 
 
758
        graph = Graph(self.source)
 
 
759
        search = graph._make_breadth_first_searcher(version_ids)
 
 
760
        transitive_ids = set()
 
 
761
        map(transitive_ids.update, list(search))
 
 
762
        parent_map = self.source.get_parent_map(transitive_ids)
 
 
763
        order = tsort.topo_sort(parent_map.items())
 
 
764
        pb = ui.ui_factory.nested_progress_bar()
 
 
767
            # TODO for incremental cross-format work:
 
 
768
            # make a versioned file with the following content:
 
 
769
            # all revisions we have been asked to join
 
 
770
            # all their ancestors that are *not* in target already.
 
 
771
            # the immediate parents of the above two sets, with 
 
 
772
            # empty parent lists - these versions are in target already
 
 
773
            # and the incorrect version data will be ignored.
 
 
774
            # TODO: for all ancestors that are present in target already,
 
 
775
            # check them for consistent data, this requires moving sha1 from
 
 
777
            # TODO: remove parent texts when they are not relevant any more for 
 
 
778
            # memory pressure reduction. RBC 20060313
 
 
779
            # pb.update('Converting versioned data', 0, len(order))
 
 
781
            for index, version in enumerate(order):
 
 
782
                pb.update('Converting versioned data', index, total)
 
 
783
                if version in target:
 
 
785
                _, _, parent_text = target.add_lines(version,
 
 
787
                                               self.source.get_lines(version),
 
 
788
                                               parent_texts=parent_texts)
 
 
789
                parent_texts[version] = parent_text
 
 
794
    def _get_source_version_ids(self, version_ids, ignore_missing):
 
 
795
        """Determine the version ids to be used from self.source.
 
 
797
        :param version_ids: The caller-supplied version ids to check. (None 
 
 
798
                            for all). If None is in version_ids, it is stripped.
 
 
799
        :param ignore_missing: if True, remove missing ids from the version 
 
 
800
                               list. If False, raise RevisionNotPresent on
 
 
801
                               a missing version id.
 
 
802
        :return: A set of version ids.
 
 
804
        if version_ids is None:
 
 
805
            # None cannot be in source.versions
 
 
806
            return set(self.source.versions())
 
 
809
                return set(self.source.versions()).intersection(set(version_ids))
 
 
811
                new_version_ids = set()
 
 
812
                for version in version_ids:
 
 
815
                    if not self.source.has_version(version):
 
 
816
                        raise errors.RevisionNotPresent(version, str(self.source))
 
 
818
                        new_version_ids.add(version)
 
 
819
                return new_version_ids