/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/weave.py

  • Committer: Alexander Belchenko
  • Date: 2006-06-29 08:41:31 UTC
  • mto: (1860.1.1 win32.installer)
  • mto: This revision was merged to the branch mainline in revision 1906.
  • Revision ID: bialix@ukr.net-20060629084131-3ea4d44e3204e36f
win32 installer for bzr.dev.0.9

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2009 Canonical Ltd
2
 
#
 
1
#! /usr/bin/python
 
2
 
 
3
# Copyright (C) 2005 Canonical Ltd
 
4
 
3
5
# This program is free software; you can redistribute it and/or modify
4
6
# it under the terms of the GNU General Public License as published by
5
7
# the Free Software Foundation; either version 2 of the License, or
6
8
# (at your option) any later version.
7
 
#
 
9
 
8
10
# This program is distributed in the hope that it will be useful,
9
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
13
# GNU General Public License for more details.
12
 
#
 
14
 
13
15
# You should have received a copy of the GNU General Public License
14
16
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
18
 
17
19
# Author: Martin Pool <mbp@canonical.com>
18
20
 
 
21
 
19
22
"""Weave - storage of related text file versions"""
20
23
 
21
 
from __future__ import absolute_import
22
24
 
23
25
# XXX: If we do weaves this way, will a merge still behave the same
24
26
# way if it's done in a different order?  That's a pretty desirable
59
61
# where the basis and destination are unchanged.
60
62
 
61
63
# FIXME: Sometimes we will be given a parents list for a revision
62
 
# that includes some redundant parents (i.e. already a parent of
63
 
# something in the list.)  We should eliminate them.  This can
 
64
# that includes some redundant parents (i.e. already a parent of 
 
65
# something in the list.)  We should eliminate them.  This can 
64
66
# be done fairly efficiently because the sequence numbers constrain
65
67
# the possible relationships.
66
68
 
67
69
# FIXME: the conflict markers should be *7* characters
68
70
 
69
71
from copy import copy
 
72
from cStringIO import StringIO
70
73
import os
71
 
import patiencediff
72
 
 
73
 
from ..lazy_import import lazy_import
74
 
lazy_import(globals(), """
75
 
from breezy import tsort
76
 
""")
77
 
from .. import (
78
 
    errors,
79
 
    osutils,
80
 
    )
81
 
from ..errors import (
82
 
    RevisionAlreadyPresent,
83
 
    RevisionNotPresent,
84
 
    UnavailableRepresentation,
85
 
    )
86
 
from ..osutils import dirname, sha, sha_strings, split_lines
87
 
from ..revision import NULL_REVISION
88
 
from ..sixish import (
89
 
    BytesIO,
90
 
    )
91
 
from ..trace import mutter
92
 
from .versionedfile import (
93
 
    AbsentContentFactory,
94
 
    adapter_registry,
95
 
    ContentFactory,
96
 
    sort_groupcompress,
97
 
    VersionedFile,
98
 
    )
99
 
from .weavefile import _read_weave_v5, write_weave_v5
100
 
 
101
 
 
102
 
class WeaveError(errors.BzrError):
103
 
 
104
 
    _fmt = "Error in processing weave: %(msg)s"
105
 
 
106
 
    def __init__(self, msg=None):
107
 
        errors.BzrError.__init__(self)
108
 
        self.msg = msg
109
 
 
110
 
 
111
 
class WeaveRevisionAlreadyPresent(WeaveError):
112
 
 
113
 
    _fmt = "Revision {%(revision_id)s} already present in %(weave)s"
114
 
 
115
 
    def __init__(self, revision_id, weave):
116
 
 
117
 
        WeaveError.__init__(self)
118
 
        self.revision_id = revision_id
119
 
        self.weave = weave
120
 
 
121
 
 
122
 
class WeaveRevisionNotPresent(WeaveError):
123
 
 
124
 
    _fmt = "Revision {%(revision_id)s} not present in %(weave)s"
125
 
 
126
 
    def __init__(self, revision_id, weave):
127
 
        WeaveError.__init__(self)
128
 
        self.revision_id = revision_id
129
 
        self.weave = weave
130
 
 
131
 
 
132
 
class WeaveFormatError(WeaveError):
133
 
 
134
 
    _fmt = "Weave invariant violated: %(what)s"
135
 
 
136
 
    def __init__(self, what):
137
 
        WeaveError.__init__(self)
138
 
        self.what = what
139
 
 
140
 
 
141
 
class WeaveParentMismatch(WeaveError):
142
 
 
143
 
    _fmt = "Parents are mismatched between two revisions. %(msg)s"
144
 
 
145
 
 
146
 
class WeaveInvalidChecksum(WeaveError):
147
 
 
148
 
    _fmt = "Text did not match its checksum: %(msg)s"
149
 
 
150
 
 
151
 
class WeaveTextDiffers(WeaveError):
152
 
 
153
 
    _fmt = ("Weaves differ on text content. Revision:"
154
 
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
155
 
 
156
 
    def __init__(self, revision_id, weave_a, weave_b):
157
 
        WeaveError.__init__(self)
158
 
        self.revision_id = revision_id
159
 
        self.weave_a = weave_a
160
 
        self.weave_b = weave_b
161
 
 
162
 
 
163
 
class WeaveContentFactory(ContentFactory):
164
 
    """Content factory for streaming from weaves.
165
 
 
166
 
    :seealso ContentFactory:
167
 
    """
168
 
 
169
 
    def __init__(self, version, weave):
170
 
        """Create a WeaveContentFactory for version from weave."""
171
 
        ContentFactory.__init__(self)
172
 
        self.sha1 = weave.get_sha1s([version])[version]
173
 
        self.key = (version,)
174
 
        parents = weave.get_parent_map([version])[version]
175
 
        self.parents = tuple((parent,) for parent in parents)
176
 
        self.storage_kind = 'fulltext'
177
 
        self._weave = weave
178
 
 
179
 
    def get_bytes_as(self, storage_kind):
180
 
        if storage_kind == 'fulltext':
181
 
            return self._weave.get_text(self.key[-1])
182
 
        elif storage_kind in ('chunked', 'lines'):
183
 
            return self._weave.get_lines(self.key[-1])
184
 
        else:
185
 
            raise UnavailableRepresentation(self.key, storage_kind, 'fulltext')
186
 
 
187
 
    def iter_bytes_as(self, storage_kind):
188
 
        if storage_kind in ('chunked', 'lines'):
189
 
            return iter(self._weave.get_lines(self.key[-1]))
190
 
        else:
191
 
            raise UnavailableRepresentation(self.key, storage_kind, 'fulltext')
 
74
import sha
 
75
import time
 
76
import warnings
 
77
 
 
78
from bzrlib.trace import mutter
 
79
from bzrlib.errors import (WeaveError, WeaveFormatError, WeaveParentMismatch,
 
80
        RevisionAlreadyPresent,
 
81
        RevisionNotPresent,
 
82
        WeaveRevisionAlreadyPresent,
 
83
        WeaveRevisionNotPresent,
 
84
        )
 
85
import bzrlib.errors as errors
 
86
from bzrlib.osutils import sha_strings
 
87
import bzrlib.patiencediff
 
88
from bzrlib.symbol_versioning import (deprecated_method,
 
89
        deprecated_function,
 
90
        zero_eight,
 
91
        )
 
92
from bzrlib.tsort import topo_sort
 
93
from bzrlib.versionedfile import VersionedFile, InterVersionedFile
 
94
from bzrlib.weavefile import _read_weave_v5, write_weave_v5
192
95
 
193
96
 
194
97
class Weave(VersionedFile):
195
98
    """weave - versioned text file storage.
196
 
 
 
99
    
197
100
    A Weave manages versions of line-based text files, keeping track
198
101
    of the originating version for each line.
199
102
 
245
148
 
246
149
    * It doesn't seem very useful to have an active insertion
247
150
      inside an inactive insertion, but it might happen.
248
 
 
 
151
      
249
152
    * Therefore, all instructions are always"considered"; that
250
153
      is passed onto and off the stack.  An outer inactive block
251
154
      doesn't disable an inner block.
281
184
    """
282
185
 
283
186
    __slots__ = ['_weave', '_parents', '_sha1s', '_names', '_name_map',
284
 
                 '_weave_name', '_matcher', '_allow_reserved']
285
 
 
286
 
    def __init__(self, weave_name=None, access_mode='w', matcher=None,
287
 
                 get_scope=None, allow_reserved=False):
288
 
        """Create a weave.
289
 
 
290
 
        :param get_scope: A callable that returns an opaque object to be used
291
 
            for detecting when this weave goes out of scope (should stop
292
 
            answering requests or allowing mutation).
293
 
        """
294
 
        super(Weave, self).__init__()
 
187
                 '_weave_name', '_matcher']
 
188
    
 
189
    def __init__(self, weave_name=None, access_mode='w', matcher=None):
 
190
        super(Weave, self).__init__(access_mode)
295
191
        self._weave = []
296
192
        self._parents = []
297
193
        self._sha1s = []
299
195
        self._name_map = {}
300
196
        self._weave_name = weave_name
301
197
        if matcher is None:
302
 
            self._matcher = patiencediff.PatienceSequenceMatcher
 
198
            self._matcher = bzrlib.patiencediff.PatienceSequenceMatcher
303
199
        else:
304
200
            self._matcher = matcher
305
 
        if get_scope is None:
306
 
            def get_scope():
307
 
                return None
308
 
        self._get_scope = get_scope
309
 
        self._scope = get_scope()
310
 
        self._access_mode = access_mode
311
 
        self._allow_reserved = allow_reserved
312
201
 
313
202
    def __repr__(self):
314
203
        return "Weave(%r)" % self._weave_name
315
204
 
316
 
    def _check_write_ok(self):
317
 
        """Is the versioned file marked as 'finished' ? Raise if it is."""
318
 
        if self._get_scope() != self._scope:
319
 
            raise errors.OutSideTransaction()
320
 
        if self._access_mode != 'w':
321
 
            raise errors.ReadOnlyObjectDirtiedError(self)
322
 
 
323
205
    def copy(self):
324
206
        """Return a deep copy of self.
325
 
 
 
207
        
326
208
        The copy can be modified without affecting the original weave."""
327
209
        other = Weave()
328
210
        other._weave = self._weave[:]
337
219
        if not isinstance(other, Weave):
338
220
            return False
339
221
        return self._parents == other._parents \
340
 
            and self._weave == other._weave \
341
 
            and self._sha1s == other._sha1s
342
 
 
 
222
               and self._weave == other._weave \
 
223
               and self._sha1s == other._sha1s 
 
224
    
343
225
    def __ne__(self, other):
344
226
        return not self.__eq__(other)
345
227
 
 
228
    @deprecated_method(zero_eight)
 
229
    def idx_to_name(self, index):
 
230
        """Old public interface, the public interface is all names now."""
 
231
        return index
 
232
 
346
233
    def _idx_to_name(self, version):
347
234
        return self._names[version]
348
235
 
 
236
    @deprecated_method(zero_eight)
 
237
    def lookup(self, name):
 
238
        """Backwards compatibility thunk:
 
239
 
 
240
        Return name, as name is valid in the api now, and spew deprecation
 
241
        warnings everywhere.
 
242
        """
 
243
        return name
 
244
 
349
245
    def _lookup(self, name):
350
246
        """Convert symbolic version name to index."""
351
 
        if not self._allow_reserved:
352
 
            self.check_not_reserved_id(name)
353
247
        try:
354
248
            return self._name_map[name]
355
249
        except KeyError:
356
250
            raise RevisionNotPresent(name, self._weave_name)
357
251
 
 
252
    @deprecated_method(zero_eight)
 
253
    def iter_names(self):
 
254
        """Deprecated convenience function, please see VersionedFile.names()."""
 
255
        return iter(self.names())
 
256
 
 
257
    @deprecated_method(zero_eight)
 
258
    def names(self):
 
259
        """See Weave.versions for the current api."""
 
260
        return self.versions()
 
261
 
358
262
    def versions(self):
359
263
        """See VersionedFile.versions."""
360
264
        return self._names[:]
361
265
 
362
266
    def has_version(self, version_id):
363
267
        """See VersionedFile.has_version."""
364
 
        return (version_id in self._name_map)
 
268
        return self._name_map.has_key(version_id)
365
269
 
366
270
    __contains__ = has_version
367
271
 
368
 
    def get_record_stream(self, versions, ordering, include_delta_closure):
369
 
        """Get a stream of records for versions.
370
 
 
371
 
        :param versions: The versions to include. Each version is a tuple
372
 
            (version,).
373
 
        :param ordering: Either 'unordered' or 'topological'. A topologically
374
 
            sorted stream has compression parents strictly before their
375
 
            children.
376
 
        :param include_delta_closure: If True then the closure across any
377
 
            compression parents will be included (in the opaque data).
378
 
        :return: An iterator of ContentFactory objects, each of which is only
379
 
            valid until the iterator is advanced.
380
 
        """
381
 
        versions = [version[-1] for version in versions]
382
 
        if ordering == 'topological':
383
 
            parents = self.get_parent_map(versions)
384
 
            new_versions = tsort.topo_sort(parents)
385
 
            new_versions.extend(set(versions).difference(set(parents)))
386
 
            versions = new_versions
387
 
        elif ordering == 'groupcompress':
388
 
            parents = self.get_parent_map(versions)
389
 
            new_versions = sort_groupcompress(parents)
390
 
            new_versions.extend(set(versions).difference(set(parents)))
391
 
            versions = new_versions
392
 
        for version in versions:
393
 
            if version in self:
394
 
                yield WeaveContentFactory(version, self)
395
 
            else:
396
 
                yield AbsentContentFactory((version,))
397
 
 
398
 
    def get_parent_map(self, version_ids):
399
 
        """See VersionedFile.get_parent_map."""
400
 
        result = {}
 
272
    def get_delta(self, version_id):
 
273
        """See VersionedFile.get_delta."""
 
274
        return self.get_deltas([version_id])[version_id]
 
275
 
 
276
    def get_deltas(self, version_ids):
 
277
        """See VersionedFile.get_deltas."""
 
278
        version_ids = self.get_ancestry(version_ids)
401
279
        for version_id in version_ids:
402
 
            if version_id == NULL_REVISION:
403
 
                parents = ()
404
 
            else:
405
 
                try:
406
 
                    parents = tuple(
407
 
                        map(self._idx_to_name,
408
 
                            self._parents[self._lookup(version_id)]))
409
 
                except RevisionNotPresent:
 
280
            if not self.has_version(version_id):
 
281
                raise RevisionNotPresent(version_id, self)
 
282
        # try extracting all versions; parallel extraction is used
 
283
        nv = self.num_versions()
 
284
        sha1s = {}
 
285
        deltas = {}
 
286
        texts = {}
 
287
        inclusions = {}
 
288
        noeols = {}
 
289
        last_parent_lines = {}
 
290
        parents = {}
 
291
        parent_inclusions = {}
 
292
        parent_linenums = {}
 
293
        parent_noeols = {}
 
294
        current_hunks = {}
 
295
        diff_hunks = {}
 
296
        # its simplest to generate a full set of prepared variables.
 
297
        for i in range(nv):
 
298
            name = self._names[i]
 
299
            sha1s[name] = self.get_sha1(name)
 
300
            parents_list = self.get_parents(name)
 
301
            try:
 
302
                parent = parents_list[0]
 
303
                parents[name] = parent
 
304
                parent_inclusions[name] = inclusions[parent]
 
305
            except IndexError:
 
306
                parents[name] = None
 
307
                parent_inclusions[name] = set()
 
308
            # we want to emit start, finish, replacement_length, replacement_lines tuples.
 
309
            diff_hunks[name] = []
 
310
            current_hunks[name] = [0, 0, 0, []] # #start, finish, repl_length, repl_tuples
 
311
            parent_linenums[name] = 0
 
312
            noeols[name] = False
 
313
            parent_noeols[name] = False
 
314
            last_parent_lines[name] = None
 
315
            new_inc = set([name])
 
316
            for p in self._parents[i]:
 
317
                new_inc.update(inclusions[self._idx_to_name(p)])
 
318
            # debug only, known good so far.
 
319
            #assert set(new_inc) == set(self.get_ancestry(name)), \
 
320
            #    'failed %s != %s' % (set(new_inc), set(self.get_ancestry(name)))
 
321
            inclusions[name] = new_inc
 
322
 
 
323
        nlines = len(self._weave)
 
324
 
 
325
        for lineno, inserted, deletes, line in self._walk_internal():
 
326
            # a line is active in a version if:
 
327
            # insert is in the versions inclusions
 
328
            # and
 
329
            # deleteset & the versions inclusions is an empty set.
 
330
            # so - if we have a included by mapping - version is included by
 
331
            # children, we get a list of children to examine for deletes affect
 
332
            # ing them, which is less than the entire set of children.
 
333
            for version_id in version_ids:  
 
334
                # The active inclusion must be an ancestor,
 
335
                # and no ancestors must have deleted this line,
 
336
                # because we don't support resurrection.
 
337
                parent_inclusion = parent_inclusions[version_id]
 
338
                inclusion = inclusions[version_id]
 
339
                parent_active = inserted in parent_inclusion and not (deletes & parent_inclusion)
 
340
                version_active = inserted in inclusion and not (deletes & inclusion)
 
341
                if not parent_active and not version_active:
 
342
                    # unrelated line of ancestry
410
343
                    continue
411
 
            result[version_id] = parents
 
344
                elif parent_active and version_active:
 
345
                    # shared line
 
346
                    parent_linenum = parent_linenums[version_id]
 
347
                    if current_hunks[version_id] != [parent_linenum, parent_linenum, 0, []]:
 
348
                        diff_hunks[version_id].append(tuple(current_hunks[version_id]))
 
349
                    parent_linenum += 1
 
350
                    current_hunks[version_id] = [parent_linenum, parent_linenum, 0, []]
 
351
                    parent_linenums[version_id] = parent_linenum
 
352
                    try:
 
353
                        if line[-1] != '\n':
 
354
                            noeols[version_id] = True
 
355
                    except IndexError:
 
356
                        pass
 
357
                elif parent_active and not version_active:
 
358
                    # deleted line
 
359
                    current_hunks[version_id][1] += 1
 
360
                    parent_linenums[version_id] += 1
 
361
                    last_parent_lines[version_id] = line
 
362
                elif not parent_active and version_active:
 
363
                    # replacement line
 
364
                    # noeol only occurs at the end of a file because we 
 
365
                    # diff linewise. We want to show noeol changes as a
 
366
                    # empty diff unless the actual eol-less content changed.
 
367
                    theline = line
 
368
                    try:
 
369
                        if last_parent_lines[version_id][-1] != '\n':
 
370
                            parent_noeols[version_id] = True
 
371
                    except (TypeError, IndexError):
 
372
                        pass
 
373
                    try:
 
374
                        if theline[-1] != '\n':
 
375
                            noeols[version_id] = True
 
376
                    except IndexError:
 
377
                        pass
 
378
                    new_line = False
 
379
                    parent_should_go = False
 
380
 
 
381
                    if parent_noeols[version_id] == noeols[version_id]:
 
382
                        # no noeol toggle, so trust the weaves statement
 
383
                        # that this line is changed.
 
384
                        new_line = True
 
385
                        if parent_noeols[version_id]:
 
386
                            theline = theline + '\n'
 
387
                    elif parent_noeols[version_id]:
 
388
                        # parent has no eol, we do:
 
389
                        # our line is new, report as such..
 
390
                        new_line = True
 
391
                    elif noeols[version_id]:
 
392
                        # append a eol so that it looks like
 
393
                        # a normalised delta
 
394
                        theline = theline + '\n'
 
395
                        if parents[version_id] is not None:
 
396
                        #if last_parent_lines[version_id] is not None:
 
397
                            parent_should_go = True
 
398
                        if last_parent_lines[version_id] != theline:
 
399
                            # but changed anyway
 
400
                            new_line = True
 
401
                            #parent_should_go = False
 
402
                    if new_line:
 
403
                        current_hunks[version_id][2] += 1
 
404
                        current_hunks[version_id][3].append((inserted, theline))
 
405
                    if parent_should_go:
 
406
                        # last hunk last parent line is not eaten
 
407
                        current_hunks[version_id][1] -= 1
 
408
                    if current_hunks[version_id][1] < 0:
 
409
                        current_hunks[version_id][1] = 0
 
410
                        # import pdb;pdb.set_trace()
 
411
                    # assert current_hunks[version_id][1] >= 0
 
412
 
 
413
        # flush last hunk
 
414
        for i in range(nv):
 
415
            version = self._idx_to_name(i)
 
416
            if current_hunks[version] != [0, 0, 0, []]:
 
417
                diff_hunks[version].append(tuple(current_hunks[version]))
 
418
        result = {}
 
419
        for version_id in version_ids:
 
420
            result[version_id] = (
 
421
                                  parents[version_id],
 
422
                                  sha1s[version_id],
 
423
                                  noeols[version_id],
 
424
                                  diff_hunks[version_id],
 
425
                                  )
412
426
        return result
413
427
 
414
 
    def get_parents_with_ghosts(self, version_id):
415
 
        raise NotImplementedError(self.get_parents_with_ghosts)
416
 
 
417
 
    def insert_record_stream(self, stream):
418
 
        """Insert a record stream into this versioned file.
419
 
 
420
 
        :param stream: A stream of records to insert.
421
 
        :return: None
422
 
        :seealso VersionedFile.get_record_stream:
423
 
        """
424
 
        adapters = {}
425
 
        for record in stream:
426
 
            # Raise an error when a record is missing.
427
 
            if record.storage_kind == 'absent':
428
 
                raise RevisionNotPresent([record.key[0]], self)
429
 
            # adapt to non-tuple interface
430
 
            parents = [parent[0] for parent in record.parents]
431
 
            if record.storage_kind in ('fulltext', 'chunked', 'lines'):
432
 
                self.add_lines(
433
 
                    record.key[0], parents,
434
 
                    record.get_bytes_as('lines'))
435
 
            else:
436
 
                adapter_key = record.storage_kind, 'lines'
437
 
                try:
438
 
                    adapter = adapters[adapter_key]
439
 
                except KeyError:
440
 
                    adapter_factory = adapter_registry.get(adapter_key)
441
 
                    adapter = adapter_factory(self)
442
 
                    adapters[adapter_key] = adapter
443
 
                lines = adapter.get_bytes(record, 'lines')
444
 
                try:
445
 
                    self.add_lines(record.key[0], parents, lines)
446
 
                except RevisionAlreadyPresent:
447
 
                    pass
 
428
    def get_parents(self, version_id):
 
429
        """See VersionedFile.get_parent."""
 
430
        return map(self._idx_to_name, self._parents[self._lookup(version_id)])
448
431
 
449
432
    def _check_repeated_add(self, name, parents, text, sha1):
450
433
        """Check that a duplicated add is OK.
453
436
        """
454
437
        idx = self._lookup(name)
455
438
        if sorted(self._parents[idx]) != sorted(parents) \
456
 
                or sha1 != self._sha1s[idx]:
 
439
            or sha1 != self._sha1s[idx]:
457
440
            raise RevisionAlreadyPresent(name, self._weave_name)
458
441
        return idx
459
442
 
460
 
    def _add_lines(self, version_id, parents, lines, parent_texts,
461
 
                   left_matching_blocks, nostore_sha, random_id,
462
 
                   check_content):
 
443
    @deprecated_method(zero_eight)
 
444
    def add_identical(self, old_rev_id, new_rev_id, parents):
 
445
        """Please use Weave.clone_text now."""
 
446
        return self.clone_text(new_rev_id, old_rev_id, parents)
 
447
 
 
448
    def _add_lines(self, version_id, parents, lines, parent_texts):
463
449
        """See VersionedFile.add_lines."""
464
 
        idx = self._add(version_id, lines, list(map(self._lookup, parents)),
465
 
                        nostore_sha=nostore_sha)
466
 
        return sha_strings(lines), sum(map(len, lines)), idx
467
 
 
468
 
    def _add(self, version_id, lines, parents, sha1=None, nostore_sha=None):
 
450
        return self._add(version_id, lines, map(self._lookup, parents))
 
451
 
 
452
    @deprecated_method(zero_eight)
 
453
    def add(self, name, parents, text, sha1=None):
 
454
        """See VersionedFile.add_lines for the non deprecated api."""
 
455
        return self._add(name, text, map(self._maybe_lookup, parents), sha1)
 
456
 
 
457
    def _add(self, version_id, lines, parents, sha1=None):
469
458
        """Add a single text on top of the weave.
470
 
 
 
459
  
471
460
        Returns the index number of the newly added version.
472
461
 
473
462
        version_id
474
463
            Symbolic name for this version.
475
464
            (Typically the revision-id of the revision that added it.)
476
 
            If None, a name will be allocated based on the hash. (sha1:SHAHASH)
477
465
 
478
466
        parents
479
467
            List or set of direct parent version numbers.
480
 
 
 
468
            
481
469
        lines
482
470
            Sequence of lines to be added in the new version.
 
471
        """
483
472
 
484
 
        :param nostore_sha: See VersionedFile.add_lines.
485
 
        """
 
473
        assert isinstance(version_id, basestring)
486
474
        self._check_lines_not_unicode(lines)
487
475
        self._check_lines_are_lines(lines)
488
476
        if not sha1:
489
477
            sha1 = sha_strings(lines)
490
 
        if sha1 == nostore_sha:
491
 
            raise errors.ExistingContent
492
 
        if version_id is None:
493
 
            version_id = b"sha1:" + sha1
494
478
        if version_id in self._name_map:
495
479
            return self._check_repeated_add(version_id, parents, lines, sha1)
496
480
 
497
481
        self._check_versions(parents)
 
482
        ## self._check_lines(lines)
498
483
        new_version = len(self._parents)
499
484
 
500
 
        # if we abort after here the (in-memory) weave will be corrupt because
501
 
        # only some fields are updated
 
485
        # if we abort after here the (in-memory) weave will be corrupt because only
 
486
        # some fields are updated
502
487
        # XXX: FIXME implement a succeed-or-fail of the rest of this routine.
503
488
        #      - Robert Collins 20060226
504
489
        self._parents.append(parents[:])
506
491
        self._names.append(version_id)
507
492
        self._name_map[version_id] = new_version
508
493
 
 
494
            
509
495
        if not parents:
510
496
            # special case; adding with no parents revision; can do
511
497
            # this more quickly by just appending unconditionally.
512
498
            # even more specially, if we're adding an empty text we
513
499
            # need do nothing at all.
514
500
            if lines:
515
 
                self._weave.append((b'{', new_version))
 
501
                self._weave.append(('{', new_version))
516
502
                self._weave.extend(lines)
517
 
                self._weave.append((b'}', None))
 
503
                self._weave.append(('}', None))
518
504
            return new_version
519
505
 
520
506
        if len(parents) == 1:
522
508
            if sha1 == self._sha1s[pv]:
523
509
                # special case: same as the single parent
524
510
                return new_version
 
511
            
525
512
 
526
513
        ancestors = self._inclusions(parents)
527
514
 
537
524
        # another small special case: a merge, producing the same text
538
525
        # as auto-merge
539
526
        if lines == basis_lines:
540
 
            return new_version
 
527
            return new_version            
541
528
 
542
529
        # add a sentinel, because we can also match against the final line
543
530
        basis_lineno.append(len(self._weave))
546
533
        # matches the end of the file?  the current code says it's the
547
534
        # last line of the weave?
548
535
 
549
 
        # print 'basis_lines:', basis_lines
550
 
        # print 'new_lines:  ', lines
 
536
        #print 'basis_lines:', basis_lines
 
537
        #print 'new_lines:  ', lines
551
538
 
552
539
        s = self._matcher(None, basis_lines, lines)
553
540
 
554
541
        # offset gives the number of lines that have been inserted
555
 
        # into the weave up to the current point; if the original edit
556
 
        # instruction says to change line A then we actually change (A+offset)
 
542
        # into the weave up to the current point; if the original edit instruction
 
543
        # says to change line A then we actually change (A+offset)
557
544
        offset = 0
558
545
 
559
546
        for tag, i1, i2, j1, j2 in s.get_opcodes():
560
 
            # i1,i2 are given in offsets within basis_lines; we need to map
561
 
            # them back to offsets within the entire weave print 'raw match',
562
 
            # tag, i1, i2, j1, j2
 
547
            # i1,i2 are given in offsets within basis_lines; we need to map them
 
548
            # back to offsets within the entire weave
 
549
            #print 'raw match', tag, i1, i2, j1, j2
563
550
            if tag == 'equal':
564
551
                continue
 
552
 
565
553
            i1 = basis_lineno[i1]
566
554
            i2 = basis_lineno[i2]
 
555
 
 
556
            assert 0 <= j1 <= j2 <= len(lines)
 
557
 
 
558
            #print tag, i1, i2, j1, j2
 
559
 
567
560
            # the deletion and insertion are handled separately.
568
561
            # first delete the region.
569
562
            if i1 != i2:
570
 
                self._weave.insert(i1 + offset, (b'[', new_version))
571
 
                self._weave.insert(i2 + offset + 1, (b']', new_version))
 
563
                self._weave.insert(i1+offset, ('[', new_version))
 
564
                self._weave.insert(i2+offset+1, (']', new_version))
572
565
                offset += 2
573
566
 
574
567
            if j1 != j2:
576
569
                # i2; we want to insert after this region to make sure
577
570
                # we don't destroy ourselves
578
571
                i = i2 + offset
579
 
                self._weave[i:i] = ([(b'{', new_version)] +
580
 
                                    lines[j1:j2] +
581
 
                                    [(b'}', None)])
 
572
                self._weave[i:i] = ([('{', new_version)] 
 
573
                                    + lines[j1:j2] 
 
574
                                    + [('}', None)])
582
575
                offset += 2 + (j2 - j1)
583
576
        return new_version
584
577
 
 
578
    def _clone_text(self, new_version_id, old_version_id, parents):
 
579
        """See VersionedFile.clone_text."""
 
580
        old_lines = self.get_text(old_version_id)
 
581
        self.add_lines(new_version_id, parents, old_lines)
 
582
 
585
583
    def _inclusions(self, versions):
586
584
        """Return set of all ancestors of given version(s)."""
587
585
        if not len(versions):
588
586
            return []
589
587
        i = set(versions)
590
 
        for v in range(max(versions), 0, -1):
 
588
        for v in xrange(max(versions), 0, -1):
591
589
            if v in i:
592
590
                # include all its parents
593
591
                i.update(self._parents[v])
594
592
        return i
595
 
 
596
 
    def get_ancestry(self, version_ids, topo_sorted=True):
 
593
        ## except IndexError:
 
594
        ##     raise ValueError("version %d not present in weave" % v)
 
595
 
 
596
    @deprecated_method(zero_eight)
 
597
    def inclusions(self, version_ids):
 
598
        """Deprecated - see VersionedFile.get_ancestry for the replacement."""
 
599
        if not version_ids:
 
600
            return []
 
601
        if isinstance(version_ids[0], int):
 
602
            return [self._idx_to_name(v) for v in self._inclusions(version_ids)]
 
603
        else:
 
604
            return self.get_ancestry(version_ids)
 
605
 
 
606
    def get_ancestry(self, version_ids):
597
607
        """See VersionedFile.get_ancestry."""
598
 
        if isinstance(version_ids, bytes):
 
608
        if isinstance(version_ids, basestring):
599
609
            version_ids = [version_ids]
600
610
        i = self._inclusions([self._lookup(v) for v in version_ids])
601
611
        return [self._idx_to_name(v) for v in i]
602
612
 
 
613
    def _check_lines(self, text):
 
614
        if not isinstance(text, list):
 
615
            raise ValueError("text should be a list, not %s" % type(text))
 
616
 
 
617
        for l in text:
 
618
            if not isinstance(l, basestring):
 
619
                raise ValueError("text line should be a string or unicode, not %s"
 
620
                                 % type(l))
 
621
        
 
622
 
 
623
 
603
624
    def _check_versions(self, indexes):
604
625
        """Check everything in the sequence of indexes is valid"""
605
626
        for i in indexes:
611
632
    def _compatible_parents(self, my_parents, other_parents):
612
633
        """During join check that other_parents are joinable with my_parents.
613
634
 
614
 
        Joinable is defined as 'is a subset of' - supersets may require
 
635
        Joinable is defined as 'is a subset of' - supersets may require 
615
636
        regeneration of diffs, but subsets do not.
616
637
        """
617
638
        return len(other_parents.difference(my_parents)) == 0
618
639
 
619
640
    def annotate(self, version_id):
620
 
        """Return a list of (version-id, line) tuples for version_id.
 
641
        if isinstance(version_id, int):
 
642
            warnings.warn('Weave.annotate(int) is deprecated. Please use version names'
 
643
                 ' in all circumstances as of 0.8',
 
644
                 DeprecationWarning,
 
645
                 stacklevel=2
 
646
                 )
 
647
            result = []
 
648
            for origin, lineno, text in self._extract([version_id]):
 
649
                result.append((origin, text))
 
650
            return result
 
651
        else:
 
652
            return super(Weave, self).annotate(version_id)
 
653
    
 
654
    def annotate_iter(self, version_id):
 
655
        """Yield list of (version-id, line) pairs for the specified version.
621
656
 
622
657
        The index indicates when the line originated in the weave."""
623
658
        incls = [self._lookup(version_id)]
624
 
        return [(self._idx_to_name(origin), text) for origin, lineno, text in
625
 
                self._extract(incls)]
626
 
 
627
 
    def iter_lines_added_or_present_in_versions(self, version_ids=None,
628
 
                                                pb=None):
 
659
        for origin, lineno, text in self._extract(incls):
 
660
            yield self._idx_to_name(origin), text
 
661
 
 
662
    @deprecated_method(zero_eight)
 
663
    def _walk(self):
 
664
        """_walk has become visit, a supported api."""
 
665
        return self._walk_internal()
 
666
 
 
667
    def iter_lines_added_or_present_in_versions(self, version_ids=None):
629
668
        """See VersionedFile.iter_lines_added_or_present_in_versions()."""
630
669
        if version_ids is None:
631
670
            version_ids = self.versions()
632
671
        version_ids = set(version_ids)
633
 
        for lineno, inserted, deletes, line in self._walk_internal(
634
 
                version_ids):
635
 
            if inserted not in version_ids:
636
 
                continue
637
 
            if not line.endswith(b'\n'):
638
 
                yield line + b'\n', inserted
 
672
        for lineno, inserted, deletes, line in self._walk_internal(version_ids):
 
673
            # if inserted not in version_ids then it was inserted before the
 
674
            # versions we care about, but because weaves cannot represent ghosts
 
675
            # properly, we do not filter down to that
 
676
            # if inserted not in version_ids: continue
 
677
            if line[-1] != '\n':
 
678
                yield line + '\n'
639
679
            else:
640
 
                yield line, inserted
 
680
                yield line
 
681
 
 
682
    #@deprecated_method(zero_eight)
 
683
    def walk(self, version_ids=None):
 
684
        """See VersionedFile.walk."""
 
685
        return self._walk_internal(version_ids)
641
686
 
642
687
    def _walk_internal(self, version_ids=None):
643
688
        """Helper method for weave actions."""
644
 
 
 
689
        
645
690
        istack = []
646
691
        dset = set()
647
692
 
650
695
        for l in self._weave:
651
696
            if l.__class__ == tuple:
652
697
                c, v = l
653
 
                if c == b'{':
 
698
                isactive = None
 
699
                if c == '{':
654
700
                    istack.append(self._names[v])
655
 
                elif c == b'}':
 
701
                elif c == '}':
656
702
                    istack.pop()
657
 
                elif c == b'[':
 
703
                elif c == '[':
 
704
                    assert self._names[v] not in dset
658
705
                    dset.add(self._names[v])
659
 
                elif c == b']':
 
706
                elif c == ']':
660
707
                    dset.remove(self._names[v])
661
708
                else:
662
709
                    raise WeaveFormatError('unexpected instruction %r' % v)
663
710
            else:
 
711
                assert l.__class__ in (str, unicode)
 
712
                assert istack
664
713
                yield lineno, istack[-1], frozenset(dset), l
665
714
            lineno += 1
666
715
 
667
716
        if istack:
668
717
            raise WeaveFormatError("unclosed insertion blocks "
669
 
                                   "at end of weave: %s" % istack)
 
718
                    "at end of weave: %s" % istack)
670
719
        if dset:
671
 
            raise WeaveFormatError(
672
 
                "unclosed deletion blocks at end of weave: %s" % dset)
 
720
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
 
721
                                   % dset)
673
722
 
674
723
    def plan_merge(self, ver_a, ver_b):
675
724
        """Return pseudo-annotation indicating how the two versions merge.
683
732
        inc_b = set(self.get_ancestry([ver_b]))
684
733
        inc_c = inc_a & inc_b
685
734
 
686
 
        for lineno, insert, deleteset, line in self._walk_internal(
687
 
                [ver_a, ver_b]):
 
735
        for lineno, insert, deleteset, line in\
 
736
            self.walk([ver_a, ver_b]):
688
737
            if deleteset & inc_c:
689
738
                # killed in parent; can't be in either a or b
690
739
                # not relevant to our work
716
765
                # not in either revision
717
766
                yield 'irrelevant', line
718
767
 
 
768
        yield 'unchanged', ''           # terminator
 
769
 
719
770
    def _extract(self, versions):
720
771
        """Yield annotation of lines in included set.
721
772
 
728
779
        for i in versions:
729
780
            if not isinstance(i, int):
730
781
                raise ValueError(i)
731
 
 
 
782
            
732
783
        included = self._inclusions(versions)
733
784
 
734
785
        istack = []
741
792
 
742
793
        result = []
743
794
 
744
 
        # wow.
745
 
        #  449       0   4474.6820   2356.5590   breezy.weave:556(_extract)
 
795
        WFE = WeaveFormatError
 
796
 
 
797
        # wow. 
 
798
        #  449       0   4474.6820   2356.5590   bzrlib.weave:556(_extract)
746
799
        #  +285282   0   1676.8040   1676.8040   +<isinstance>
747
800
        # 1.6 seconds in 'isinstance'.
748
801
        # changing the first isinstance:
749
 
        #  449       0   2814.2660   1577.1760   breezy.weave:556(_extract)
 
802
        #  449       0   2814.2660   1577.1760   bzrlib.weave:556(_extract)
750
803
        #  +140414   0    762.8050    762.8050   +<isinstance>
751
804
        # note that the inline time actually dropped (less function calls)
752
805
        # and total processing time was halved.
753
806
        # we're still spending ~1/4 of the method in isinstance though.
754
807
        # so lets hard code the acceptable string classes we expect:
755
 
        #  449       0   1202.9420    786.2930   breezy.weave:556(_extract)
756
 
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list'
 
808
        #  449       0   1202.9420    786.2930   bzrlib.weave:556(_extract)
 
809
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list' 
757
810
        #                                          objects>
758
811
        # yay, down to ~1/4 the initial extract time, and our inline time
759
812
        # has shrunk again, with isinstance no longer dominating.
760
813
        # tweaking the stack inclusion test to use a set gives:
761
 
        #  449       0   1122.8030    713.0080   breezy.weave:556(_extract)
762
 
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list'
 
814
        #  449       0   1122.8030    713.0080   bzrlib.weave:556(_extract)
 
815
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list' 
763
816
        #                                          objects>
764
817
        # - a 5% win, or possibly just noise. However with large istacks that
765
 
        # 'in' test could dominate, so I'm leaving this change in place - when
766
 
        # its fast enough to consider profiling big datasets we can review.
 
818
        # 'in' test could dominate, so I'm leaving this change in place -
 
819
        # when its fast enough to consider profiling big datasets we can review.
 
820
 
 
821
              
 
822
             
767
823
 
768
824
        for l in self._weave:
769
825
            if l.__class__ == tuple:
770
826
                c, v = l
771
827
                isactive = None
772
 
                if c == b'{':
 
828
                if c == '{':
 
829
                    assert v not in iset
773
830
                    istack.append(v)
774
831
                    iset.add(v)
775
 
                elif c == b'}':
 
832
                elif c == '}':
776
833
                    iset.remove(istack.pop())
777
 
                elif c == b'[':
 
834
                elif c == '[':
778
835
                    if v in included:
 
836
                        assert v not in dset
779
837
                        dset.add(v)
780
 
                elif c == b']':
 
838
                else:
 
839
                    assert c == ']'
781
840
                    if v in included:
 
841
                        assert v in dset
782
842
                        dset.remove(v)
783
 
                else:
784
 
                    raise AssertionError()
785
843
            else:
 
844
                assert l.__class__ in (str, unicode)
786
845
                if isactive is None:
787
 
                    isactive = (not dset) and istack and (
788
 
                        istack[-1] in included)
 
846
                    isactive = (not dset) and istack and (istack[-1] in included)
789
847
                if isactive:
790
848
                    result.append((istack[-1], lineno, l))
791
849
            lineno += 1
792
850
        if istack:
793
851
            raise WeaveFormatError("unclosed insertion blocks "
794
 
                                   "at end of weave: %s" % istack)
 
852
                    "at end of weave: %s" % istack)
795
853
        if dset:
796
 
            raise WeaveFormatError(
797
 
                "unclosed deletion blocks at end of weave: %s" % dset)
 
854
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
 
855
                                   % dset)
798
856
        return result
799
857
 
 
858
    @deprecated_method(zero_eight)
 
859
    def get_iter(self, name_or_index):
 
860
        """Deprecated, please do not use. Lookups are not not needed.
 
861
        
 
862
        Please use get_lines now.
 
863
        """
 
864
        return iter(self.get_lines(self._maybe_lookup(name_or_index)))
 
865
 
 
866
    @deprecated_method(zero_eight)
 
867
    def maybe_lookup(self, name_or_index):
 
868
        """Deprecated, please do not use. Lookups are not not needed."""
 
869
        return self._maybe_lookup(name_or_index)
 
870
 
800
871
    def _maybe_lookup(self, name_or_index):
801
872
        """Convert possible symbolic name to index, or pass through indexes.
802
 
 
 
873
        
803
874
        NOT FOR PUBLIC USE.
804
875
        """
805
 
        # GZ 2017-04-01: This used to check for long as well, but I don't think
806
 
        # there are python implementations with sys.maxsize > sys.maxint
807
 
        if isinstance(name_or_index, int):
 
876
        if isinstance(name_or_index, (int, long)):
808
877
            return name_or_index
809
878
        else:
810
879
            return self._lookup(name_or_index)
811
880
 
 
881
    @deprecated_method(zero_eight)
 
882
    def get(self, version_id):
 
883
        """Please use either Weave.get_text or Weave.get_lines as desired."""
 
884
        return self.get_lines(version_id)
 
885
 
812
886
    def get_lines(self, version_id):
813
887
        """See VersionedFile.get_lines()."""
814
888
        int_index = self._maybe_lookup(version_id)
815
 
        result = [line for (origin, lineno, line)
816
 
                  in self._extract([int_index])]
 
889
        result = [line for (origin, lineno, line) in self._extract([int_index])]
817
890
        expected_sha1 = self._sha1s[int_index]
818
891
        measured_sha1 = sha_strings(result)
819
892
        if measured_sha1 != expected_sha1:
820
 
            raise WeaveInvalidChecksum(
821
 
                'file %s, revision %s, expected: %s, measured %s'
822
 
                % (self._weave_name, version_id,
823
 
                   expected_sha1, measured_sha1))
824
 
        return result
825
 
 
826
 
    def get_sha1s(self, version_ids):
827
 
        """See VersionedFile.get_sha1s()."""
828
 
        result = {}
829
 
        for v in version_ids:
830
 
            result[v] = self._sha1s[self._lookup(v)]
831
 
        return result
 
893
            raise errors.WeaveInvalidChecksum(
 
894
                    'file %s, revision %s, expected: %s, measured %s' 
 
895
                    % (self._weave_name, version_id,
 
896
                       expected_sha1, measured_sha1))
 
897
        return result
 
898
 
 
899
    def get_sha1(self, version_id):
 
900
        """See VersionedFile.get_sha1()."""
 
901
        return self._sha1s[self._lookup(version_id)]
 
902
 
 
903
    @deprecated_method(zero_eight)
 
904
    def numversions(self):
 
905
        """How many versions are in this weave?
 
906
 
 
907
        Deprecated in favour of num_versions.
 
908
        """
 
909
        return self.num_versions()
832
910
 
833
911
    def num_versions(self):
834
912
        """How many versions are in this weave?"""
835
 
        return len(self._parents)
 
913
        l = len(self._parents)
 
914
        assert l == len(self._sha1s)
 
915
        return l
836
916
 
837
917
    __len__ = num_versions
838
918
 
845
925
            if inclusions:
846
926
                inclusions.sort()
847
927
                if inclusions[-1] >= version:
848
 
                    raise WeaveFormatError(
849
 
                        "invalid included version %d for index %d"
850
 
                        % (inclusions[-1], version))
 
928
                    raise WeaveFormatError("invalid included version %d for index %d"
 
929
                                           % (inclusions[-1], version))
851
930
 
852
931
        # try extracting all versions; parallel extraction is used
853
932
        nv = self.num_versions()
858
937
            # For creating the ancestry, IntSet is much faster (3.7s vs 0.17s)
859
938
            # The problem is that set membership is much more expensive
860
939
            name = self._idx_to_name(i)
861
 
            sha1s[name] = sha()
 
940
            sha1s[name] = sha.new()
862
941
            texts[name] = []
863
 
            new_inc = {name}
 
942
            new_inc = set([name])
864
943
            for p in self._parents[i]:
865
944
                new_inc.update(inclusions[self._idx_to_name(p)])
866
945
 
867
 
            if set(new_inc) != set(self.get_ancestry(name)):
868
 
                raise AssertionError(
869
 
                    'failed %s != %s'
870
 
                    % (set(new_inc), set(self.get_ancestry(name))))
 
946
            assert set(new_inc) == set(self.get_ancestry(name)), \
 
947
                'failed %s != %s' % (set(new_inc), set(self.get_ancestry(name)))
871
948
            inclusions[name] = new_inc
872
949
 
873
950
        nlines = len(self._weave)
886
963
                # The active inclusion must be an ancestor,
887
964
                # and no ancestors must have deleted this line,
888
965
                # because we don't support resurrection.
889
 
                if ((insert in name_inclusions) and
890
 
                        not (deleteset & name_inclusions)):
 
966
                if (insert in name_inclusions) and not (deleteset & name_inclusions):
891
967
                    sha1s[name].update(line)
892
968
 
893
969
        for i in range(nv):
894
970
            version = self._idx_to_name(i)
895
 
            hd = sha1s[version].hexdigest().encode()
 
971
            hd = sha1s[version].hexdigest()
896
972
            expected = self._sha1s[i]
897
973
            if hd != expected:
898
 
                raise WeaveInvalidChecksum(
899
 
                    "mismatched sha1 for version %s: "
900
 
                    "got %s, expected %s"
901
 
                    % (version, hd, expected))
 
974
                raise errors.WeaveInvalidChecksum(
 
975
                        "mismatched sha1 for version %s: "
 
976
                        "got %s, expected %s"
 
977
                        % (version, hd, expected))
902
978
 
903
979
        # TODO: check insertions are properly nested, that there are
904
980
        # no lines outside of insertion blocks, that deletions are
905
981
        # properly paired, etc.
906
982
 
 
983
    def _join(self, other, pb, msg, version_ids, ignore_missing):
 
984
        """Worker routine for join()."""
 
985
        if not other.versions():
 
986
            return          # nothing to update, easy
 
987
 
 
988
        if not version_ids:
 
989
            # versions is never none, InterWeave checks this.
 
990
            return 0
 
991
 
 
992
        # two loops so that we do not change ourselves before verifying it
 
993
        # will be ok
 
994
        # work through in index order to make sure we get all dependencies
 
995
        names_to_join = []
 
996
        processed = 0
 
997
        # get the selected versions only that are in other.versions.
 
998
        version_ids = set(other.versions()).intersection(set(version_ids))
 
999
        # pull in the referenced graph.
 
1000
        version_ids = other.get_ancestry(version_ids)
 
1001
        pending_graph = [(version, other.get_parents(version)) for
 
1002
                         version in version_ids]
 
1003
        for name in topo_sort(pending_graph):
 
1004
            other_idx = other._name_map[name]
 
1005
            # returns True if we have it, False if we need it.
 
1006
            if not self._check_version_consistent(other, other_idx, name):
 
1007
                names_to_join.append((other_idx, name))
 
1008
            processed += 1
 
1009
 
 
1010
 
 
1011
        if pb and not msg:
 
1012
            msg = 'weave join'
 
1013
 
 
1014
        merged = 0
 
1015
        time0 = time.time()
 
1016
        for other_idx, name in names_to_join:
 
1017
            # TODO: If all the parents of the other version are already
 
1018
            # present then we can avoid some work by just taking the delta
 
1019
            # and adjusting the offsets.
 
1020
            new_parents = self._imported_parents(other, other_idx)
 
1021
            sha1 = other._sha1s[other_idx]
 
1022
 
 
1023
            merged += 1
 
1024
 
 
1025
            if pb:
 
1026
                pb.update(msg, merged, len(names_to_join))
 
1027
           
 
1028
            lines = other.get_lines(other_idx)
 
1029
            self._add(name, lines, new_parents, sha1)
 
1030
 
 
1031
        mutter("merged = %d, processed = %d, file_id=%s; deltat=%d"%(
 
1032
                merged, processed, self._weave_name, time.time()-time0))
 
1033
 
907
1034
    def _imported_parents(self, other, other_idx):
908
1035
        """Return list of parents in self corresponding to indexes in other."""
909
1036
        new_parents = []
911
1038
            parent_name = other._names[parent_idx]
912
1039
            if parent_name not in self._name_map:
913
1040
                # should not be possible
914
 
                raise WeaveError("missing parent {%s} of {%s} in %r"
 
1041
                raise WeaveError("missing parent {%s} of {%s} in %r" 
915
1042
                                 % (parent_name, other._name_map[other_idx], self))
916
1043
            new_parents.append(self._name_map[parent_name])
917
1044
        return new_parents
924
1051
         * the same text
925
1052
         * the same direct parents (by name, not index, and disregarding
926
1053
           order)
927
 
 
 
1054
        
928
1055
        If present & correct return True;
929
 
        if not present in self return False;
 
1056
        if not present in self return False; 
930
1057
        if inconsistent raise error."""
931
1058
        this_idx = self._name_map.get(name, -1)
932
1059
        if this_idx != -1:
933
1060
            if self._sha1s[this_idx] != other._sha1s[other_idx]:
934
 
                raise WeaveTextDiffers(name, self, other)
 
1061
                raise errors.WeaveTextDiffers(name, self, other)
935
1062
            self_parents = self._parents[this_idx]
936
1063
            other_parents = other._parents[other_idx]
937
 
            n1 = {self._names[i] for i in self_parents}
938
 
            n2 = {other._names[i] for i in other_parents}
 
1064
            n1 = set([self._names[i] for i in self_parents])
 
1065
            n2 = set([other._names[i] for i in other_parents])
939
1066
            if not self._compatible_parents(n1, n2):
940
 
                raise WeaveParentMismatch(
941
 
                    "inconsistent parents "
 
1067
                raise WeaveParentMismatch("inconsistent parents "
942
1068
                    "for version {%s}: %s vs %s" % (name, n1, n2))
943
1069
            else:
944
1070
                return True         # ok!
945
1071
        else:
946
1072
            return False
947
1073
 
 
1074
    @deprecated_method(zero_eight)
 
1075
    def reweave(self, other, pb=None, msg=None):
 
1076
        """reweave has been superseded by plain use of join."""
 
1077
        return self.join(other, pb, msg)
 
1078
 
948
1079
    def _reweave(self, other, pb, msg):
949
1080
        """Reweave self with other - internal helper for join().
950
1081
 
966
1097
    """A WeaveFile represents a Weave on disk and writes on change."""
967
1098
 
968
1099
    WEAVE_SUFFIX = '.weave'
969
 
 
970
 
    def __init__(self, name, transport, filemode=None, create=False,
971
 
                 access_mode='w', get_scope=None):
 
1100
    
 
1101
    def __init__(self, name, transport, filemode=None, create=False, access_mode='w'):
972
1102
        """Create a WeaveFile.
973
 
 
 
1103
        
974
1104
        :param create: If not True, only open an existing knit.
975
1105
        """
976
 
        super(WeaveFile, self).__init__(name, access_mode, get_scope=get_scope,
977
 
                                        allow_reserved=False)
 
1106
        super(WeaveFile, self).__init__(name, access_mode)
978
1107
        self._transport = transport
979
1108
        self._filemode = filemode
980
1109
        try:
981
 
            f = self._transport.get(name + WeaveFile.WEAVE_SUFFIX)
982
 
            _read_weave_v5(BytesIO(f.read()), self)
 
1110
            _read_weave_v5(self._transport.get(name + WeaveFile.WEAVE_SUFFIX), self)
983
1111
        except errors.NoSuchFile:
984
1112
            if not create:
985
1113
                raise
986
1114
            # new file, save it
987
1115
            self._save()
988
1116
 
989
 
    def _add_lines(self, version_id, parents, lines, parent_texts,
990
 
                   left_matching_blocks, nostore_sha, random_id,
991
 
                   check_content):
 
1117
    def _add_lines(self, version_id, parents, lines, parent_texts):
992
1118
        """Add a version and save the weave."""
993
 
        self.check_not_reserved_id(version_id)
994
 
        result = super(WeaveFile, self)._add_lines(
995
 
            version_id, parents, lines, parent_texts, left_matching_blocks,
996
 
            nostore_sha, random_id, check_content)
 
1119
        result = super(WeaveFile, self)._add_lines(version_id, parents, lines,
 
1120
                                                   parent_texts)
997
1121
        self._save()
998
1122
        return result
999
1123
 
 
1124
    def _clone_text(self, new_version_id, old_version_id, parents):
 
1125
        """See VersionedFile.clone_text."""
 
1126
        super(WeaveFile, self)._clone_text(new_version_id, old_version_id, parents)
 
1127
        self._save
 
1128
 
1000
1129
    def copy_to(self, name, transport):
1001
1130
        """See VersionedFile.copy_to()."""
1002
1131
        # as we are all in memory always, just serialise to the new place.
1003
 
        sio = BytesIO()
 
1132
        sio = StringIO()
1004
1133
        write_weave_v5(self, sio)
1005
1134
        sio.seek(0)
1006
 
        transport.put_file(name + WeaveFile.WEAVE_SUFFIX, sio, self._filemode)
 
1135
        transport.put(name + WeaveFile.WEAVE_SUFFIX, sio, self._filemode)
 
1136
 
 
1137
    def create_empty(self, name, transport, filemode=None):
 
1138
        return WeaveFile(name, transport, filemode, create=True)
1007
1139
 
1008
1140
    def _save(self):
1009
1141
        """Save the weave."""
1010
1142
        self._check_write_ok()
1011
 
        sio = BytesIO()
 
1143
        sio = StringIO()
1012
1144
        write_weave_v5(self, sio)
1013
1145
        sio.seek(0)
1014
 
        bytes = sio.getvalue()
1015
 
        path = self._weave_name + WeaveFile.WEAVE_SUFFIX
1016
 
        try:
1017
 
            self._transport.put_bytes(path, bytes, self._filemode)
1018
 
        except errors.NoSuchFile:
1019
 
            self._transport.mkdir(dirname(path))
1020
 
            self._transport.put_bytes(path, bytes, self._filemode)
 
1146
        self._transport.put(self._weave_name + WeaveFile.WEAVE_SUFFIX,
 
1147
                            sio,
 
1148
                            self._filemode)
1021
1149
 
1022
1150
    @staticmethod
1023
1151
    def get_suffixes():
1024
1152
        """See VersionedFile.get_suffixes()."""
1025
1153
        return [WeaveFile.WEAVE_SUFFIX]
1026
1154
 
1027
 
    def insert_record_stream(self, stream):
1028
 
        super(WeaveFile, self).insert_record_stream(stream)
 
1155
    def join(self, other, pb=None, msg=None, version_ids=None,
 
1156
             ignore_missing=False):
 
1157
        """Join other into self and save."""
 
1158
        super(WeaveFile, self).join(other, pb, msg, version_ids, ignore_missing)
1029
1159
        self._save()
1030
1160
 
1031
1161
 
 
1162
@deprecated_function(zero_eight)
 
1163
def reweave(wa, wb, pb=None, msg=None):
 
1164
    """reweaving is deprecation, please just use weave.join()."""
 
1165
    _reweave(wa, wb, pb, msg)
 
1166
 
1032
1167
def _reweave(wa, wb, pb=None, msg=None):
1033
1168
    """Combine two weaves and return the result.
1034
1169
 
1035
 
    This works even if a revision R has different parents in
 
1170
    This works even if a revision R has different parents in 
1036
1171
    wa and wb.  In the resulting weave all the parents are given.
1037
1172
 
1038
 
    This is done by just building up a new weave, maintaining ordering
 
1173
    This is done by just building up a new weave, maintaining ordering 
1039
1174
    of the versions in the two inputs.  More efficient approaches
1040
 
    might be possible but it should only be necessary to do
1041
 
    this operation rarely, when a new previously ghost version is
 
1175
    might be possible but it should only be necessary to do 
 
1176
    this operation rarely, when a new previously ghost version is 
1042
1177
    inserted.
1043
1178
 
1044
1179
    :param pb: An optional progress bar, indicating how far done we are
1045
1180
    :param msg: An optional message for the progress
1046
1181
    """
1047
1182
    wr = Weave()
 
1183
    ia = ib = 0
 
1184
    queue_a = range(wa.num_versions())
 
1185
    queue_b = range(wb.num_versions())
1048
1186
    # first determine combined parents of all versions
1049
1187
    # map from version name -> all parent names
1050
1188
    combined_parents = _reweave_parent_graphs(wa, wb)
1051
1189
    mutter("combined parents: %r", combined_parents)
1052
 
    order = tsort.topo_sort(combined_parents.items())
 
1190
    order = topo_sort(combined_parents.iteritems())
1053
1191
    mutter("order to reweave: %r", order)
1054
1192
 
1055
1193
    if pb and not msg:
1067
1205
                    mutter('weaves: %s, %s', wa._weave_name, wb._weave_name)
1068
1206
                    import difflib
1069
1207
                    lines = list(difflib.unified_diff(lines, lines_b,
1070
 
                                                      wa._weave_name, wb._weave_name))
 
1208
                            wa._weave_name, wb._weave_name))
1071
1209
                    mutter('lines:\n%s', ''.join(lines))
1072
 
                    raise WeaveTextDiffers(name, wa, wb)
 
1210
                    raise errors.WeaveTextDiffers(name, wa, wb)
1073
1211
        else:
1074
1212
            lines = wb.get_lines(name)
1075
1213
        wr._add(name, lines, [wr._lookup(i) for i in combined_parents[name]])
1076
1214
    return wr
1077
1215
 
1078
 
 
1079
1216
def _reweave_parent_graphs(wa, wb):
1080
1217
    """Return combined parent ancestry for two weaves.
1081
 
 
 
1218
    
1082
1219
    Returned as a list of (version_name, set(parent_names))"""
1083
1220
    combined = {}
1084
1221
    for weave in [wa, wb]:
1086
1223
            p = combined.setdefault(name, set())
1087
1224
            p.update(map(weave._idx_to_name, weave._parents[idx]))
1088
1225
    return combined
 
1226
 
 
1227
 
 
1228
def weave_toc(w):
 
1229
    """Show the weave's table-of-contents"""
 
1230
    print '%6s %50s %10s %10s' % ('ver', 'name', 'sha1', 'parents')
 
1231
    for i in (6, 50, 10, 10):
 
1232
        print '-' * i,
 
1233
    print
 
1234
    for i in range(w.num_versions()):
 
1235
        sha1 = w._sha1s[i]
 
1236
        name = w._names[i]
 
1237
        parent_str = ' '.join(map(str, w._parents[i]))
 
1238
        print '%6d %-50.50s %10.10s %s' % (i, name, sha1, parent_str)
 
1239
 
 
1240
 
 
1241
 
 
1242
def weave_stats(weave_file, pb):
 
1243
    from bzrlib.weavefile import read_weave
 
1244
 
 
1245
    wf = file(weave_file, 'rb')
 
1246
    w = read_weave(wf)
 
1247
    # FIXME: doesn't work on pipes
 
1248
    weave_size = wf.tell()
 
1249
 
 
1250
    total = 0
 
1251
    vers = len(w)
 
1252
    for i in range(vers):
 
1253
        pb.update('checking sizes', i, vers)
 
1254
        for origin, lineno, line in w._extract([i]):
 
1255
            total += len(line)
 
1256
 
 
1257
    pb.clear()
 
1258
 
 
1259
    print 'versions          %9d' % vers
 
1260
    print 'weave file        %9d bytes' % weave_size
 
1261
    print 'total contents    %9d bytes' % total
 
1262
    print 'compression ratio %9.2fx' % (float(total) / float(weave_size))
 
1263
    if vers:
 
1264
        avg = total/vers
 
1265
        print 'average size      %9d bytes' % avg
 
1266
        print 'relative size     %9.2fx' % (float(weave_size) / float(avg))
 
1267
 
 
1268
 
 
1269
def usage():
 
1270
    print """bzr weave tool
 
1271
 
 
1272
Experimental tool for weave algorithm.
 
1273
 
 
1274
usage:
 
1275
    weave init WEAVEFILE
 
1276
        Create an empty weave file
 
1277
    weave get WEAVEFILE VERSION
 
1278
        Write out specified version.
 
1279
    weave check WEAVEFILE
 
1280
        Check consistency of all versions.
 
1281
    weave toc WEAVEFILE
 
1282
        Display table of contents.
 
1283
    weave add WEAVEFILE NAME [BASE...] < NEWTEXT
 
1284
        Add NEWTEXT, with specified parent versions.
 
1285
    weave annotate WEAVEFILE VERSION
 
1286
        Display origin of each line.
 
1287
    weave merge WEAVEFILE VERSION1 VERSION2 > OUT
 
1288
        Auto-merge two versions and display conflicts.
 
1289
    weave diff WEAVEFILE VERSION1 VERSION2 
 
1290
        Show differences between two versions.
 
1291
 
 
1292
example:
 
1293
 
 
1294
    % weave init foo.weave
 
1295
    % vi foo.txt
 
1296
    % weave add foo.weave ver0 < foo.txt
 
1297
    added version 0
 
1298
 
 
1299
    (create updated version)
 
1300
    % vi foo.txt
 
1301
    % weave get foo.weave 0 | diff -u - foo.txt
 
1302
    % weave add foo.weave ver1 0 < foo.txt
 
1303
    added version 1
 
1304
 
 
1305
    % weave get foo.weave 0 > foo.txt       (create forked version)
 
1306
    % vi foo.txt
 
1307
    % weave add foo.weave ver2 0 < foo.txt
 
1308
    added version 2
 
1309
 
 
1310
    % weave merge foo.weave 1 2 > foo.txt   (merge them)
 
1311
    % vi foo.txt                            (resolve conflicts)
 
1312
    % weave add foo.weave merged 1 2 < foo.txt     (commit merged version)     
 
1313
    
 
1314
"""
 
1315
    
 
1316
 
 
1317
 
 
1318
def main(argv):
 
1319
    import sys
 
1320
    import os
 
1321
    try:
 
1322
        import bzrlib
 
1323
    except ImportError:
 
1324
        # in case we're run directly from the subdirectory
 
1325
        sys.path.append('..')
 
1326
        import bzrlib
 
1327
    from bzrlib.weavefile import write_weave, read_weave
 
1328
    from bzrlib.progress import ProgressBar
 
1329
 
 
1330
    try:
 
1331
        import psyco
 
1332
        psyco.full()
 
1333
    except ImportError:
 
1334
        pass
 
1335
 
 
1336
    if len(argv) < 2:
 
1337
        usage()
 
1338
        return 0
 
1339
 
 
1340
    cmd = argv[1]
 
1341
 
 
1342
    def readit():
 
1343
        return read_weave(file(argv[2], 'rb'))
 
1344
    
 
1345
    if cmd == 'help':
 
1346
        usage()
 
1347
    elif cmd == 'add':
 
1348
        w = readit()
 
1349
        # at the moment, based on everything in the file
 
1350
        name = argv[3]
 
1351
        parents = map(int, argv[4:])
 
1352
        lines = sys.stdin.readlines()
 
1353
        ver = w.add(name, parents, lines)
 
1354
        write_weave(w, file(argv[2], 'wb'))
 
1355
        print 'added version %r %d' % (name, ver)
 
1356
    elif cmd == 'init':
 
1357
        fn = argv[2]
 
1358
        if os.path.exists(fn):
 
1359
            raise IOError("file exists")
 
1360
        w = Weave()
 
1361
        write_weave(w, file(fn, 'wb'))
 
1362
    elif cmd == 'get': # get one version
 
1363
        w = readit()
 
1364
        sys.stdout.writelines(w.get_iter(int(argv[3])))
 
1365
        
 
1366
    elif cmd == 'diff':
 
1367
        w = readit()
 
1368
        fn = argv[2]
 
1369
        v1, v2 = map(int, argv[3:5])
 
1370
        lines1 = w.get(v1)
 
1371
        lines2 = w.get(v2)
 
1372
        diff_gen = bzrlib.patiencediff.unified_diff(lines1, lines2,
 
1373
                                '%s version %d' % (fn, v1),
 
1374
                                '%s version %d' % (fn, v2))
 
1375
        sys.stdout.writelines(diff_gen)
 
1376
            
 
1377
    elif cmd == 'annotate':
 
1378
        w = readit()
 
1379
        # newline is added to all lines regardless; too hard to get
 
1380
        # reasonable formatting otherwise
 
1381
        lasto = None
 
1382
        for origin, text in w.annotate(int(argv[3])):
 
1383
            text = text.rstrip('\r\n')
 
1384
            if origin == lasto:
 
1385
                print '      | %s' % (text)
 
1386
            else:
 
1387
                print '%5d | %s' % (origin, text)
 
1388
                lasto = origin
 
1389
                
 
1390
    elif cmd == 'toc':
 
1391
        weave_toc(readit())
 
1392
 
 
1393
    elif cmd == 'stats':
 
1394
        weave_stats(argv[2], ProgressBar())
 
1395
        
 
1396
    elif cmd == 'check':
 
1397
        w = readit()
 
1398
        pb = ProgressBar()
 
1399
        w.check(pb)
 
1400
        pb.clear()
 
1401
        print '%d versions ok' % w.num_versions()
 
1402
 
 
1403
    elif cmd == 'inclusions':
 
1404
        w = readit()
 
1405
        print ' '.join(map(str, w.inclusions([int(argv[3])])))
 
1406
 
 
1407
    elif cmd == 'parents':
 
1408
        w = readit()
 
1409
        print ' '.join(map(str, w._parents[int(argv[3])]))
 
1410
 
 
1411
    elif cmd == 'plan-merge':
 
1412
        # replaced by 'bzr weave-plan-merge'
 
1413
        w = readit()
 
1414
        for state, line in w.plan_merge(int(argv[3]), int(argv[4])):
 
1415
            if line:
 
1416
                print '%14s | %s' % (state, line),
 
1417
    elif cmd == 'merge':
 
1418
        # replaced by 'bzr weave-merge-text'
 
1419
        w = readit()
 
1420
        p = w.plan_merge(int(argv[3]), int(argv[4]))
 
1421
        sys.stdout.writelines(w.weave_merge(p))
 
1422
    else:
 
1423
        raise ValueError('unknown command %r' % cmd)
 
1424
    
 
1425
 
 
1426
if __name__ == '__main__':
 
1427
    import sys
 
1428
    sys.exit(main(sys.argv))
 
1429
 
 
1430
 
 
1431
class InterWeave(InterVersionedFile):
 
1432
    """Optimised code paths for weave to weave operations."""
 
1433
    
 
1434
    _matching_file_from_factory = staticmethod(WeaveFile)
 
1435
    _matching_file_to_factory = staticmethod(WeaveFile)
 
1436
    
 
1437
    @staticmethod
 
1438
    def is_compatible(source, target):
 
1439
        """Be compatible with weaves."""
 
1440
        try:
 
1441
            return (isinstance(source, Weave) and
 
1442
                    isinstance(target, Weave))
 
1443
        except AttributeError:
 
1444
            return False
 
1445
 
 
1446
    def join(self, pb=None, msg=None, version_ids=None, ignore_missing=False):
 
1447
        """See InterVersionedFile.join."""
 
1448
        version_ids = self._get_source_version_ids(version_ids, ignore_missing)
 
1449
        if self.target.versions() == [] and version_ids is None:
 
1450
            self.target._copy_weave_content(self.source)
 
1451
            return
 
1452
        try:
 
1453
            self.target._join(self.source, pb, msg, version_ids, ignore_missing)
 
1454
        except errors.WeaveParentMismatch:
 
1455
            self.target._reweave(self.source, pb, msg)
 
1456
 
 
1457
 
 
1458
InterVersionedFile.register_optimiser(InterWeave)