~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: Sidnei da Silva
  • Date: 2009-07-03 15:06:42 UTC
  • mto: (4531.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4532.
  • Revision ID: sidnei.da.silva@canonical.com-20090703150642-hjfra5waj5879cae
- Add top-level make target to build all installers using buildout and another to cleanup

Show diffs side-by-side

added added

removed removed

Lines of Context:
14
14
#
15
15
# You should have received a copy of the GNU General Public License
16
16
# along with this program; if not, write to the Free Software
17
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
17
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
18
 
19
19
# Author: Martin Pool <mbp@canonical.com>
20
20
 
61
61
# where the basis and destination are unchanged.
62
62
 
63
63
# FIXME: Sometimes we will be given a parents list for a revision
64
 
# that includes some redundant parents (i.e. already a parent of 
65
 
# 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
66
66
# be done fairly efficiently because the sequence numbers constrain
67
67
# the possible relationships.
68
68
 
71
71
from copy import copy
72
72
from cStringIO import StringIO
73
73
import os
74
 
import sha
75
74
import time
76
75
import warnings
77
76
 
 
77
from bzrlib.lazy_import import lazy_import
 
78
lazy_import(globals(), """
 
79
from bzrlib import tsort
 
80
""")
78
81
from bzrlib import (
 
82
    errors,
 
83
    osutils,
79
84
    progress,
80
85
    )
81
 
from bzrlib.trace import mutter
82
86
from bzrlib.errors import (WeaveError, WeaveFormatError, WeaveParentMismatch,
83
87
        RevisionAlreadyPresent,
84
88
        RevisionNotPresent,
 
89
        UnavailableRepresentation,
85
90
        WeaveRevisionAlreadyPresent,
86
91
        WeaveRevisionNotPresent,
87
92
        )
88
 
import bzrlib.errors as errors
89
 
from bzrlib.osutils import sha_strings
 
93
from bzrlib.osutils import dirname, sha, sha_strings, split_lines
90
94
import bzrlib.patiencediff
91
 
from bzrlib.symbol_versioning import (deprecated_method,
92
 
        deprecated_function,
93
 
        zero_eight,
94
 
        )
95
 
from bzrlib.tsort import topo_sort
96
 
from bzrlib.versionedfile import VersionedFile, InterVersionedFile
 
95
from bzrlib.revision import NULL_REVISION
 
96
from bzrlib.symbol_versioning import *
 
97
from bzrlib.trace import mutter
 
98
from bzrlib.versionedfile import (
 
99
    AbsentContentFactory,
 
100
    adapter_registry,
 
101
    ContentFactory,
 
102
    sort_groupcompress,
 
103
    VersionedFile,
 
104
    )
97
105
from bzrlib.weavefile import _read_weave_v5, write_weave_v5
98
106
 
99
107
 
 
108
class WeaveContentFactory(ContentFactory):
 
109
    """Content factory for streaming from weaves.
 
110
 
 
111
    :seealso ContentFactory:
 
112
    """
 
113
 
 
114
    def __init__(self, version, weave):
 
115
        """Create a WeaveContentFactory for version from weave."""
 
116
        ContentFactory.__init__(self)
 
117
        self.sha1 = weave.get_sha1s([version])[version]
 
118
        self.key = (version,)
 
119
        parents = weave.get_parent_map([version])[version]
 
120
        self.parents = tuple((parent,) for parent in parents)
 
121
        self.storage_kind = 'fulltext'
 
122
        self._weave = weave
 
123
 
 
124
    def get_bytes_as(self, storage_kind):
 
125
        if storage_kind == 'fulltext':
 
126
            return self._weave.get_text(self.key[-1])
 
127
        elif storage_kind == 'chunked':
 
128
            return self._weave.get_lines(self.key[-1])
 
129
        else:
 
130
            raise UnavailableRepresentation(self.key, storage_kind, 'fulltext')
 
131
 
 
132
 
100
133
class Weave(VersionedFile):
101
134
    """weave - versioned text file storage.
102
 
    
 
135
 
103
136
    A Weave manages versions of line-based text files, keeping track
104
137
    of the originating version for each line.
105
138
 
151
184
 
152
185
    * It doesn't seem very useful to have an active insertion
153
186
      inside an inactive insertion, but it might happen.
154
 
      
 
187
 
155
188
    * Therefore, all instructions are always"considered"; that
156
189
      is passed onto and off the stack.  An outer inactive block
157
190
      doesn't disable an inner block.
187
220
    """
188
221
 
189
222
    __slots__ = ['_weave', '_parents', '_sha1s', '_names', '_name_map',
190
 
                 '_weave_name', '_matcher']
191
 
    
192
 
    def __init__(self, weave_name=None, access_mode='w', matcher=None):
193
 
        super(Weave, self).__init__(access_mode)
 
223
                 '_weave_name', '_matcher', '_allow_reserved']
 
224
 
 
225
    def __init__(self, weave_name=None, access_mode='w', matcher=None,
 
226
                 get_scope=None, allow_reserved=False):
 
227
        """Create a weave.
 
228
 
 
229
        :param get_scope: A callable that returns an opaque object to be used
 
230
            for detecting when this weave goes out of scope (should stop
 
231
            answering requests or allowing mutation).
 
232
        """
 
233
        super(Weave, self).__init__()
194
234
        self._weave = []
195
235
        self._parents = []
196
236
        self._sha1s = []
201
241
            self._matcher = bzrlib.patiencediff.PatienceSequenceMatcher
202
242
        else:
203
243
            self._matcher = matcher
 
244
        if get_scope is None:
 
245
            get_scope = lambda:None
 
246
        self._get_scope = get_scope
 
247
        self._scope = get_scope()
 
248
        self._access_mode = access_mode
 
249
        self._allow_reserved = allow_reserved
204
250
 
205
251
    def __repr__(self):
206
252
        return "Weave(%r)" % self._weave_name
207
253
 
 
254
    def _check_write_ok(self):
 
255
        """Is the versioned file marked as 'finished' ? Raise if it is."""
 
256
        if self._get_scope() != self._scope:
 
257
            raise errors.OutSideTransaction()
 
258
        if self._access_mode != 'w':
 
259
            raise errors.ReadOnlyObjectDirtiedError(self)
 
260
 
208
261
    def copy(self):
209
262
        """Return a deep copy of self.
210
 
        
 
263
 
211
264
        The copy can be modified without affecting the original weave."""
212
265
        other = Weave()
213
266
        other._weave = self._weave[:]
223
276
            return False
224
277
        return self._parents == other._parents \
225
278
               and self._weave == other._weave \
226
 
               and self._sha1s == other._sha1s 
227
 
    
 
279
               and self._sha1s == other._sha1s
 
280
 
228
281
    def __ne__(self, other):
229
282
        return not self.__eq__(other)
230
283
 
231
 
    @deprecated_method(zero_eight)
232
 
    def idx_to_name(self, index):
233
 
        """Old public interface, the public interface is all names now."""
234
 
        return index
235
 
 
236
284
    def _idx_to_name(self, version):
237
285
        return self._names[version]
238
286
 
239
 
    @deprecated_method(zero_eight)
240
 
    def lookup(self, name):
241
 
        """Backwards compatibility thunk:
242
 
 
243
 
        Return name, as name is valid in the api now, and spew deprecation
244
 
        warnings everywhere.
245
 
        """
246
 
        return name
247
 
 
248
287
    def _lookup(self, name):
249
288
        """Convert symbolic version name to index."""
250
 
        self.check_not_reserved_id(name)
 
289
        if not self._allow_reserved:
 
290
            self.check_not_reserved_id(name)
251
291
        try:
252
292
            return self._name_map[name]
253
293
        except KeyError:
254
294
            raise RevisionNotPresent(name, self._weave_name)
255
295
 
256
 
    @deprecated_method(zero_eight)
257
 
    def iter_names(self):
258
 
        """Deprecated convenience function, please see VersionedFile.names()."""
259
 
        return iter(self.names())
260
 
 
261
 
    @deprecated_method(zero_eight)
262
 
    def names(self):
263
 
        """See Weave.versions for the current api."""
264
 
        return self.versions()
265
 
 
266
296
    def versions(self):
267
297
        """See VersionedFile.versions."""
268
298
        return self._names[:]
273
303
 
274
304
    __contains__ = has_version
275
305
 
276
 
    def get_delta(self, version_id):
277
 
        """See VersionedFile.get_delta."""
278
 
        return self.get_deltas([version_id])[version_id]
279
 
 
280
 
    def get_deltas(self, version_ids):
281
 
        """See VersionedFile.get_deltas."""
282
 
        version_ids = self.get_ancestry(version_ids)
 
306
    def get_record_stream(self, versions, ordering, include_delta_closure):
 
307
        """Get a stream of records for versions.
 
308
 
 
309
        :param versions: The versions to include. Each version is a tuple
 
310
            (version,).
 
311
        :param ordering: Either 'unordered' or 'topological'. A topologically
 
312
            sorted stream has compression parents strictly before their
 
313
            children.
 
314
        :param include_delta_closure: If True then the closure across any
 
315
            compression parents will be included (in the opaque data).
 
316
        :return: An iterator of ContentFactory objects, each of which is only
 
317
            valid until the iterator is advanced.
 
318
        """
 
319
        versions = [version[-1] for version in versions]
 
320
        if ordering == 'topological':
 
321
            parents = self.get_parent_map(versions)
 
322
            new_versions = tsort.topo_sort(parents)
 
323
            new_versions.extend(set(versions).difference(set(parents)))
 
324
            versions = new_versions
 
325
        elif ordering == 'groupcompress':
 
326
            parents = self.get_parent_map(versions)
 
327
            new_versions = sort_groupcompress(parents)
 
328
            new_versions.extend(set(versions).difference(set(parents)))
 
329
            versions = new_versions
 
330
        for version in versions:
 
331
            if version in self:
 
332
                yield WeaveContentFactory(version, self)
 
333
            else:
 
334
                yield AbsentContentFactory((version,))
 
335
 
 
336
    def get_parent_map(self, version_ids):
 
337
        """See VersionedFile.get_parent_map."""
 
338
        result = {}
283
339
        for version_id in version_ids:
284
 
            if not self.has_version(version_id):
285
 
                raise RevisionNotPresent(version_id, self)
286
 
        # try extracting all versions; parallel extraction is used
287
 
        nv = self.num_versions()
288
 
        sha1s = {}
289
 
        deltas = {}
290
 
        texts = {}
291
 
        inclusions = {}
292
 
        noeols = {}
293
 
        last_parent_lines = {}
294
 
        parents = {}
295
 
        parent_inclusions = {}
296
 
        parent_linenums = {}
297
 
        parent_noeols = {}
298
 
        current_hunks = {}
299
 
        diff_hunks = {}
300
 
        # its simplest to generate a full set of prepared variables.
301
 
        for i in range(nv):
302
 
            name = self._names[i]
303
 
            sha1s[name] = self.get_sha1(name)
304
 
            parents_list = self.get_parents(name)
305
 
            try:
306
 
                parent = parents_list[0]
307
 
                parents[name] = parent
308
 
                parent_inclusions[name] = inclusions[parent]
309
 
            except IndexError:
310
 
                parents[name] = None
311
 
                parent_inclusions[name] = set()
312
 
            # we want to emit start, finish, replacement_length, replacement_lines tuples.
313
 
            diff_hunks[name] = []
314
 
            current_hunks[name] = [0, 0, 0, []] # #start, finish, repl_length, repl_tuples
315
 
            parent_linenums[name] = 0
316
 
            noeols[name] = False
317
 
            parent_noeols[name] = False
318
 
            last_parent_lines[name] = None
319
 
            new_inc = set([name])
320
 
            for p in self._parents[i]:
321
 
                new_inc.update(inclusions[self._idx_to_name(p)])
322
 
            # debug only, known good so far.
323
 
            #assert set(new_inc) == set(self.get_ancestry(name)), \
324
 
            #    'failed %s != %s' % (set(new_inc), set(self.get_ancestry(name)))
325
 
            inclusions[name] = new_inc
326
 
 
327
 
        nlines = len(self._weave)
328
 
 
329
 
        for lineno, inserted, deletes, line in self._walk_internal():
330
 
            # a line is active in a version if:
331
 
            # insert is in the versions inclusions
332
 
            # and
333
 
            # deleteset & the versions inclusions is an empty set.
334
 
            # so - if we have a included by mapping - version is included by
335
 
            # children, we get a list of children to examine for deletes affect
336
 
            # ing them, which is less than the entire set of children.
337
 
            for version_id in version_ids:  
338
 
                # The active inclusion must be an ancestor,
339
 
                # and no ancestors must have deleted this line,
340
 
                # because we don't support resurrection.
341
 
                parent_inclusion = parent_inclusions[version_id]
342
 
                inclusion = inclusions[version_id]
343
 
                parent_active = inserted in parent_inclusion and not (deletes & parent_inclusion)
344
 
                version_active = inserted in inclusion and not (deletes & inclusion)
345
 
                if not parent_active and not version_active:
346
 
                    # unrelated line of ancestry
 
340
            if version_id == NULL_REVISION:
 
341
                parents = ()
 
342
            else:
 
343
                try:
 
344
                    parents = tuple(
 
345
                        map(self._idx_to_name,
 
346
                            self._parents[self._lookup(version_id)]))
 
347
                except RevisionNotPresent:
347
348
                    continue
348
 
                elif parent_active and version_active:
349
 
                    # shared line
350
 
                    parent_linenum = parent_linenums[version_id]
351
 
                    if current_hunks[version_id] != [parent_linenum, parent_linenum, 0, []]:
352
 
                        diff_hunks[version_id].append(tuple(current_hunks[version_id]))
353
 
                    parent_linenum += 1
354
 
                    current_hunks[version_id] = [parent_linenum, parent_linenum, 0, []]
355
 
                    parent_linenums[version_id] = parent_linenum
356
 
                    try:
357
 
                        if line[-1] != '\n':
358
 
                            noeols[version_id] = True
359
 
                    except IndexError:
360
 
                        pass
361
 
                elif parent_active and not version_active:
362
 
                    # deleted line
363
 
                    current_hunks[version_id][1] += 1
364
 
                    parent_linenums[version_id] += 1
365
 
                    last_parent_lines[version_id] = line
366
 
                elif not parent_active and version_active:
367
 
                    # replacement line
368
 
                    # noeol only occurs at the end of a file because we 
369
 
                    # diff linewise. We want to show noeol changes as a
370
 
                    # empty diff unless the actual eol-less content changed.
371
 
                    theline = line
372
 
                    try:
373
 
                        if last_parent_lines[version_id][-1] != '\n':
374
 
                            parent_noeols[version_id] = True
375
 
                    except (TypeError, IndexError):
376
 
                        pass
377
 
                    try:
378
 
                        if theline[-1] != '\n':
379
 
                            noeols[version_id] = True
380
 
                    except IndexError:
381
 
                        pass
382
 
                    new_line = False
383
 
                    parent_should_go = False
384
 
 
385
 
                    if parent_noeols[version_id] == noeols[version_id]:
386
 
                        # no noeol toggle, so trust the weaves statement
387
 
                        # that this line is changed.
388
 
                        new_line = True
389
 
                        if parent_noeols[version_id]:
390
 
                            theline = theline + '\n'
391
 
                    elif parent_noeols[version_id]:
392
 
                        # parent has no eol, we do:
393
 
                        # our line is new, report as such..
394
 
                        new_line = True
395
 
                    elif noeols[version_id]:
396
 
                        # append a eol so that it looks like
397
 
                        # a normalised delta
398
 
                        theline = theline + '\n'
399
 
                        if parents[version_id] is not None:
400
 
                        #if last_parent_lines[version_id] is not None:
401
 
                            parent_should_go = True
402
 
                        if last_parent_lines[version_id] != theline:
403
 
                            # but changed anyway
404
 
                            new_line = True
405
 
                            #parent_should_go = False
406
 
                    if new_line:
407
 
                        current_hunks[version_id][2] += 1
408
 
                        current_hunks[version_id][3].append((inserted, theline))
409
 
                    if parent_should_go:
410
 
                        # last hunk last parent line is not eaten
411
 
                        current_hunks[version_id][1] -= 1
412
 
                    if current_hunks[version_id][1] < 0:
413
 
                        current_hunks[version_id][1] = 0
414
 
                        # import pdb;pdb.set_trace()
415
 
                    # assert current_hunks[version_id][1] >= 0
416
 
 
417
 
        # flush last hunk
418
 
        for i in range(nv):
419
 
            version = self._idx_to_name(i)
420
 
            if current_hunks[version] != [0, 0, 0, []]:
421
 
                diff_hunks[version].append(tuple(current_hunks[version]))
422
 
        result = {}
423
 
        for version_id in version_ids:
424
 
            result[version_id] = (
425
 
                                  parents[version_id],
426
 
                                  sha1s[version_id],
427
 
                                  noeols[version_id],
428
 
                                  diff_hunks[version_id],
429
 
                                  )
 
349
            result[version_id] = parents
430
350
        return result
431
351
 
432
 
    def get_parents(self, version_id):
433
 
        """See VersionedFile.get_parent."""
434
 
        return map(self._idx_to_name, self._parents[self._lookup(version_id)])
 
352
    def get_parents_with_ghosts(self, version_id):
 
353
        raise NotImplementedError(self.get_parents_with_ghosts)
 
354
 
 
355
    def insert_record_stream(self, stream):
 
356
        """Insert a record stream into this versioned file.
 
357
 
 
358
        :param stream: A stream of records to insert.
 
359
        :return: None
 
360
        :seealso VersionedFile.get_record_stream:
 
361
        """
 
362
        adapters = {}
 
363
        for record in stream:
 
364
            # Raise an error when a record is missing.
 
365
            if record.storage_kind == 'absent':
 
366
                raise RevisionNotPresent([record.key[0]], self)
 
367
            # adapt to non-tuple interface
 
368
            parents = [parent[0] for parent in record.parents]
 
369
            if (record.storage_kind == 'fulltext'
 
370
                or record.storage_kind == 'chunked'):
 
371
                self.add_lines(record.key[0], parents,
 
372
                    osutils.chunks_to_lines(record.get_bytes_as('chunked')))
 
373
            else:
 
374
                adapter_key = record.storage_kind, 'fulltext'
 
375
                try:
 
376
                    adapter = adapters[adapter_key]
 
377
                except KeyError:
 
378
                    adapter_factory = adapter_registry.get(adapter_key)
 
379
                    adapter = adapter_factory(self)
 
380
                    adapters[adapter_key] = adapter
 
381
                lines = split_lines(adapter.get_bytes(record))
 
382
                try:
 
383
                    self.add_lines(record.key[0], parents, lines)
 
384
                except RevisionAlreadyPresent:
 
385
                    pass
435
386
 
436
387
    def _check_repeated_add(self, name, parents, text, sha1):
437
388
        """Check that a duplicated add is OK.
444
395
            raise RevisionAlreadyPresent(name, self._weave_name)
445
396
        return idx
446
397
 
447
 
    @deprecated_method(zero_eight)
448
 
    def add_identical(self, old_rev_id, new_rev_id, parents):
449
 
        """Please use Weave.clone_text now."""
450
 
        return self.clone_text(new_rev_id, old_rev_id, parents)
451
 
 
452
 
    def _add_lines(self, version_id, parents, lines, parent_texts):
 
398
    def _add_lines(self, version_id, parents, lines, parent_texts,
 
399
       left_matching_blocks, nostore_sha, random_id, check_content):
453
400
        """See VersionedFile.add_lines."""
454
 
        return self._add(version_id, lines, map(self._lookup, parents))
455
 
 
456
 
    @deprecated_method(zero_eight)
457
 
    def add(self, name, parents, text, sha1=None):
458
 
        """See VersionedFile.add_lines for the non deprecated api."""
459
 
        return self._add(name, text, map(self._maybe_lookup, parents), sha1)
460
 
 
461
 
    def _add(self, version_id, lines, parents, sha1=None):
 
401
        idx = self._add(version_id, lines, map(self._lookup, parents),
 
402
            nostore_sha=nostore_sha)
 
403
        return sha_strings(lines), sum(map(len, lines)), idx
 
404
 
 
405
    def _add(self, version_id, lines, parents, sha1=None, nostore_sha=None):
462
406
        """Add a single text on top of the weave.
463
 
  
 
407
 
464
408
        Returns the index number of the newly added version.
465
409
 
466
410
        version_id
467
411
            Symbolic name for this version.
468
412
            (Typically the revision-id of the revision that added it.)
 
413
            If None, a name will be allocated based on the hash. (sha1:SHAHASH)
469
414
 
470
415
        parents
471
416
            List or set of direct parent version numbers.
472
 
            
 
417
 
473
418
        lines
474
419
            Sequence of lines to be added in the new version.
 
420
 
 
421
        :param nostore_sha: See VersionedFile.add_lines.
475
422
        """
476
 
 
477
 
        assert isinstance(version_id, basestring)
478
423
        self._check_lines_not_unicode(lines)
479
424
        self._check_lines_are_lines(lines)
480
425
        if not sha1:
481
426
            sha1 = sha_strings(lines)
 
427
        if sha1 == nostore_sha:
 
428
            raise errors.ExistingContent
 
429
        if version_id is None:
 
430
            version_id = "sha1:" + sha1
482
431
        if version_id in self._name_map:
483
432
            return self._check_repeated_add(version_id, parents, lines, sha1)
484
433
 
495
444
        self._names.append(version_id)
496
445
        self._name_map[version_id] = new_version
497
446
 
498
 
            
 
447
 
499
448
        if not parents:
500
449
            # special case; adding with no parents revision; can do
501
450
            # this more quickly by just appending unconditionally.
512
461
            if sha1 == self._sha1s[pv]:
513
462
                # special case: same as the single parent
514
463
                return new_version
515
 
            
 
464
 
516
465
 
517
466
        ancestors = self._inclusions(parents)
518
467
 
528
477
        # another small special case: a merge, producing the same text
529
478
        # as auto-merge
530
479
        if lines == basis_lines:
531
 
            return new_version            
 
480
            return new_version
532
481
 
533
482
        # add a sentinel, because we can also match against the final line
534
483
        basis_lineno.append(len(self._weave))
553
502
            #print 'raw match', tag, i1, i2, j1, j2
554
503
            if tag == 'equal':
555
504
                continue
556
 
 
557
505
            i1 = basis_lineno[i1]
558
506
            i2 = basis_lineno[i2]
559
 
 
560
 
            assert 0 <= j1 <= j2 <= len(lines)
561
 
 
562
 
            #print tag, i1, i2, j1, j2
563
 
 
564
507
            # the deletion and insertion are handled separately.
565
508
            # first delete the region.
566
509
            if i1 != i2:
573
516
                # i2; we want to insert after this region to make sure
574
517
                # we don't destroy ourselves
575
518
                i = i2 + offset
576
 
                self._weave[i:i] = ([('{', new_version)] 
577
 
                                    + lines[j1:j2] 
 
519
                self._weave[i:i] = ([('{', new_version)]
 
520
                                    + lines[j1:j2]
578
521
                                    + [('}', None)])
579
522
                offset += 2 + (j2 - j1)
580
523
        return new_version
581
524
 
582
 
    def _clone_text(self, new_version_id, old_version_id, parents):
583
 
        """See VersionedFile.clone_text."""
584
 
        old_lines = self.get_text(old_version_id)
585
 
        self.add_lines(new_version_id, parents, old_lines)
586
 
 
587
525
    def _inclusions(self, versions):
588
526
        """Return set of all ancestors of given version(s)."""
589
527
        if not len(versions):
597
535
        ## except IndexError:
598
536
        ##     raise ValueError("version %d not present in weave" % v)
599
537
 
600
 
    @deprecated_method(zero_eight)
601
 
    def inclusions(self, version_ids):
602
 
        """Deprecated - see VersionedFile.get_ancestry for the replacement."""
603
 
        if not version_ids:
604
 
            return []
605
 
        if isinstance(version_ids[0], int):
606
 
            return [self._idx_to_name(v) for v in self._inclusions(version_ids)]
607
 
        else:
608
 
            return self.get_ancestry(version_ids)
609
 
 
610
538
    def get_ancestry(self, version_ids, topo_sorted=True):
611
539
        """See VersionedFile.get_ancestry."""
612
540
        if isinstance(version_ids, basestring):
622
550
            if not isinstance(l, basestring):
623
551
                raise ValueError("text line should be a string or unicode, not %s"
624
552
                                 % type(l))
625
 
        
 
553
 
626
554
 
627
555
 
628
556
    def _check_versions(self, indexes):
636
564
    def _compatible_parents(self, my_parents, other_parents):
637
565
        """During join check that other_parents are joinable with my_parents.
638
566
 
639
 
        Joinable is defined as 'is a subset of' - supersets may require 
 
567
        Joinable is defined as 'is a subset of' - supersets may require
640
568
        regeneration of diffs, but subsets do not.
641
569
        """
642
570
        return len(other_parents.difference(my_parents)) == 0
643
571
 
644
 
    def annotate_iter(self, version_id):
645
 
        """Yield list of (version-id, line) pairs for the specified version.
 
572
    def annotate(self, version_id):
 
573
        """Return a list of (version-id, line) tuples for version_id.
646
574
 
647
575
        The index indicates when the line originated in the weave."""
648
576
        incls = [self._lookup(version_id)]
649
 
        for origin, lineno, text in self._extract(incls):
650
 
            yield self._idx_to_name(origin), text
651
 
 
652
 
    @deprecated_method(zero_eight)
653
 
    def _walk(self):
654
 
        """_walk has become visit, a supported api."""
655
 
        return self._walk_internal()
 
577
        return [(self._idx_to_name(origin), text) for origin, lineno, text in
 
578
            self._extract(incls)]
656
579
 
657
580
    def iter_lines_added_or_present_in_versions(self, version_ids=None,
658
581
                                                pb=None):
661
584
            version_ids = self.versions()
662
585
        version_ids = set(version_ids)
663
586
        for lineno, inserted, deletes, line in self._walk_internal(version_ids):
664
 
            # if inserted not in version_ids then it was inserted before the
665
 
            # versions we care about, but because weaves cannot represent ghosts
666
 
            # properly, we do not filter down to that
667
 
            # if inserted not in version_ids: continue
 
587
            if inserted not in version_ids: continue
668
588
            if line[-1] != '\n':
669
 
                yield line + '\n'
 
589
                yield line + '\n', inserted
670
590
            else:
671
 
                yield line
672
 
 
673
 
    #@deprecated_method(zero_eight)
674
 
    def walk(self, version_ids=None):
675
 
        """See VersionedFile.walk."""
676
 
        return self._walk_internal(version_ids)
 
591
                yield line, inserted
677
592
 
678
593
    def _walk_internal(self, version_ids=None):
679
594
        """Helper method for weave actions."""
680
 
        
 
595
 
681
596
        istack = []
682
597
        dset = set()
683
598
 
692
607
                elif c == '}':
693
608
                    istack.pop()
694
609
                elif c == '[':
695
 
                    assert self._names[v] not in dset
696
610
                    dset.add(self._names[v])
697
611
                elif c == ']':
698
612
                    dset.remove(self._names[v])
699
613
                else:
700
614
                    raise WeaveFormatError('unexpected instruction %r' % v)
701
615
            else:
702
 
                assert l.__class__ in (str, unicode)
703
 
                assert istack
704
616
                yield lineno, istack[-1], frozenset(dset), l
705
617
            lineno += 1
706
618
 
723
635
        inc_b = set(self.get_ancestry([ver_b]))
724
636
        inc_c = inc_a & inc_b
725
637
 
726
 
        for lineno, insert, deleteset, line in\
727
 
            self.walk([ver_a, ver_b]):
 
638
        for lineno, insert, deleteset, line in self._walk_internal([ver_a, ver_b]):
728
639
            if deleteset & inc_c:
729
640
                # killed in parent; can't be in either a or b
730
641
                # not relevant to our work
756
667
                # not in either revision
757
668
                yield 'irrelevant', line
758
669
 
759
 
        yield 'unchanged', ''           # terminator
760
 
 
761
670
    def _extract(self, versions):
762
671
        """Yield annotation of lines in included set.
763
672
 
770
679
        for i in versions:
771
680
            if not isinstance(i, int):
772
681
                raise ValueError(i)
773
 
            
 
682
 
774
683
        included = self._inclusions(versions)
775
684
 
776
685
        istack = []
785
694
 
786
695
        WFE = WeaveFormatError
787
696
 
788
 
        # wow. 
 
697
        # wow.
789
698
        #  449       0   4474.6820   2356.5590   bzrlib.weave:556(_extract)
790
699
        #  +285282   0   1676.8040   1676.8040   +<isinstance>
791
700
        # 1.6 seconds in 'isinstance'.
797
706
        # we're still spending ~1/4 of the method in isinstance though.
798
707
        # so lets hard code the acceptable string classes we expect:
799
708
        #  449       0   1202.9420    786.2930   bzrlib.weave:556(_extract)
800
 
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list' 
 
709
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list'
801
710
        #                                          objects>
802
711
        # yay, down to ~1/4 the initial extract time, and our inline time
803
712
        # has shrunk again, with isinstance no longer dominating.
804
713
        # tweaking the stack inclusion test to use a set gives:
805
714
        #  449       0   1122.8030    713.0080   bzrlib.weave:556(_extract)
806
 
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list' 
 
715
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list'
807
716
        #                                          objects>
808
717
        # - a 5% win, or possibly just noise. However with large istacks that
809
718
        # 'in' test could dominate, so I'm leaving this change in place -
810
719
        # when its fast enough to consider profiling big datasets we can review.
811
720
 
812
 
              
813
 
             
 
721
 
 
722
 
814
723
 
815
724
        for l in self._weave:
816
725
            if l.__class__ == tuple:
817
726
                c, v = l
818
727
                isactive = None
819
728
                if c == '{':
820
 
                    assert v not in iset
821
729
                    istack.append(v)
822
730
                    iset.add(v)
823
731
                elif c == '}':
824
732
                    iset.remove(istack.pop())
825
733
                elif c == '[':
826
734
                    if v in included:
827
 
                        assert v not in dset
828
735
                        dset.add(v)
829
 
                else:
830
 
                    assert c == ']'
 
736
                elif c == ']':
831
737
                    if v in included:
832
 
                        assert v in dset
833
738
                        dset.remove(v)
 
739
                else:
 
740
                    raise AssertionError()
834
741
            else:
835
 
                assert l.__class__ in (str, unicode)
836
742
                if isactive is None:
837
743
                    isactive = (not dset) and istack and (istack[-1] in included)
838
744
                if isactive:
846
752
                                   % dset)
847
753
        return result
848
754
 
849
 
    @deprecated_method(zero_eight)
850
 
    def get_iter(self, name_or_index):
851
 
        """Deprecated, please do not use. Lookups are not not needed.
852
 
        
853
 
        Please use get_lines now.
854
 
        """
855
 
        return iter(self.get_lines(self._maybe_lookup(name_or_index)))
856
 
 
857
 
    @deprecated_method(zero_eight)
858
 
    def maybe_lookup(self, name_or_index):
859
 
        """Deprecated, please do not use. Lookups are not not needed."""
860
 
        return self._maybe_lookup(name_or_index)
861
 
 
862
755
    def _maybe_lookup(self, name_or_index):
863
756
        """Convert possible symbolic name to index, or pass through indexes.
864
 
        
 
757
 
865
758
        NOT FOR PUBLIC USE.
866
759
        """
867
760
        if isinstance(name_or_index, (int, long)):
869
762
        else:
870
763
            return self._lookup(name_or_index)
871
764
 
872
 
    @deprecated_method(zero_eight)
873
 
    def get(self, version_id):
874
 
        """Please use either Weave.get_text or Weave.get_lines as desired."""
875
 
        return self.get_lines(version_id)
876
 
 
877
765
    def get_lines(self, version_id):
878
766
        """See VersionedFile.get_lines()."""
879
767
        int_index = self._maybe_lookup(version_id)
882
770
        measured_sha1 = sha_strings(result)
883
771
        if measured_sha1 != expected_sha1:
884
772
            raise errors.WeaveInvalidChecksum(
885
 
                    'file %s, revision %s, expected: %s, measured %s' 
 
773
                    'file %s, revision %s, expected: %s, measured %s'
886
774
                    % (self._weave_name, version_id,
887
775
                       expected_sha1, measured_sha1))
888
776
        return result
889
777
 
890
 
    def get_sha1(self, version_id):
891
 
        """See VersionedFile.get_sha1()."""
892
 
        return self._sha1s[self._lookup(version_id)]
893
 
 
894
 
    @deprecated_method(zero_eight)
895
 
    def numversions(self):
896
 
        """How many versions are in this weave?
897
 
 
898
 
        Deprecated in favour of num_versions.
899
 
        """
900
 
        return self.num_versions()
 
778
    def get_sha1s(self, version_ids):
 
779
        """See VersionedFile.get_sha1s()."""
 
780
        result = {}
 
781
        for v in version_ids:
 
782
            result[v] = self._sha1s[self._lookup(v)]
 
783
        return result
901
784
 
902
785
    def num_versions(self):
903
786
        """How many versions are in this weave?"""
904
787
        l = len(self._parents)
905
 
        assert l == len(self._sha1s)
906
788
        return l
907
789
 
908
790
    __len__ = num_versions
928
810
            # For creating the ancestry, IntSet is much faster (3.7s vs 0.17s)
929
811
            # The problem is that set membership is much more expensive
930
812
            name = self._idx_to_name(i)
931
 
            sha1s[name] = sha.new()
 
813
            sha1s[name] = sha()
932
814
            texts[name] = []
933
815
            new_inc = set([name])
934
816
            for p in self._parents[i]:
935
817
                new_inc.update(inclusions[self._idx_to_name(p)])
936
818
 
937
 
            assert set(new_inc) == set(self.get_ancestry(name)), \
938
 
                'failed %s != %s' % (set(new_inc), set(self.get_ancestry(name)))
 
819
            if set(new_inc) != set(self.get_ancestry(name)):
 
820
                raise AssertionError(
 
821
                    'failed %s != %s'
 
822
                    % (set(new_inc), set(self.get_ancestry(name))))
939
823
            inclusions[name] = new_inc
940
824
 
941
825
        nlines = len(self._weave)
971
855
        # no lines outside of insertion blocks, that deletions are
972
856
        # properly paired, etc.
973
857
 
974
 
    def _join(self, other, pb, msg, version_ids, ignore_missing):
975
 
        """Worker routine for join()."""
976
 
        if not other.versions():
977
 
            return          # nothing to update, easy
978
 
 
979
 
        if not version_ids:
980
 
            # versions is never none, InterWeave checks this.
981
 
            return 0
982
 
 
983
 
        # two loops so that we do not change ourselves before verifying it
984
 
        # will be ok
985
 
        # work through in index order to make sure we get all dependencies
986
 
        names_to_join = []
987
 
        processed = 0
988
 
        # get the selected versions only that are in other.versions.
989
 
        version_ids = set(other.versions()).intersection(set(version_ids))
990
 
        # pull in the referenced graph.
991
 
        version_ids = other.get_ancestry(version_ids)
992
 
        pending_graph = [(version, other.get_parents(version)) for
993
 
                         version in version_ids]
994
 
        for name in topo_sort(pending_graph):
995
 
            other_idx = other._name_map[name]
996
 
            # returns True if we have it, False if we need it.
997
 
            if not self._check_version_consistent(other, other_idx, name):
998
 
                names_to_join.append((other_idx, name))
999
 
            processed += 1
1000
 
 
1001
 
 
1002
 
        if pb and not msg:
1003
 
            msg = 'weave join'
1004
 
 
1005
 
        merged = 0
1006
 
        time0 = time.time()
1007
 
        for other_idx, name in names_to_join:
1008
 
            # TODO: If all the parents of the other version are already
1009
 
            # present then we can avoid some work by just taking the delta
1010
 
            # and adjusting the offsets.
1011
 
            new_parents = self._imported_parents(other, other_idx)
1012
 
            sha1 = other._sha1s[other_idx]
1013
 
 
1014
 
            merged += 1
1015
 
 
1016
 
            if pb:
1017
 
                pb.update(msg, merged, len(names_to_join))
1018
 
           
1019
 
            lines = other.get_lines(other_idx)
1020
 
            self._add(name, lines, new_parents, sha1)
1021
 
 
1022
 
        mutter("merged = %d, processed = %d, file_id=%s; deltat=%d"%(
1023
 
                merged, processed, self._weave_name, time.time()-time0))
1024
 
 
1025
858
    def _imported_parents(self, other, other_idx):
1026
859
        """Return list of parents in self corresponding to indexes in other."""
1027
860
        new_parents = []
1029
862
            parent_name = other._names[parent_idx]
1030
863
            if parent_name not in self._name_map:
1031
864
                # should not be possible
1032
 
                raise WeaveError("missing parent {%s} of {%s} in %r" 
 
865
                raise WeaveError("missing parent {%s} of {%s} in %r"
1033
866
                                 % (parent_name, other._name_map[other_idx], self))
1034
867
            new_parents.append(self._name_map[parent_name])
1035
868
        return new_parents
1042
875
         * the same text
1043
876
         * the same direct parents (by name, not index, and disregarding
1044
877
           order)
1045
 
        
 
878
 
1046
879
        If present & correct return True;
1047
 
        if not present in self return False; 
 
880
        if not present in self return False;
1048
881
        if inconsistent raise error."""
1049
882
        this_idx = self._name_map.get(name, -1)
1050
883
        if this_idx != -1:
1062
895
        else:
1063
896
            return False
1064
897
 
1065
 
    @deprecated_method(zero_eight)
1066
 
    def reweave(self, other, pb=None, msg=None):
1067
 
        """reweave has been superseded by plain use of join."""
1068
 
        return self.join(other, pb, msg)
1069
 
 
1070
898
    def _reweave(self, other, pb, msg):
1071
899
        """Reweave self with other - internal helper for join().
1072
900
 
1088
916
    """A WeaveFile represents a Weave on disk and writes on change."""
1089
917
 
1090
918
    WEAVE_SUFFIX = '.weave'
1091
 
    
1092
 
    def __init__(self, name, transport, filemode=None, create=False, access_mode='w'):
 
919
 
 
920
    def __init__(self, name, transport, filemode=None, create=False, access_mode='w', get_scope=None):
1093
921
        """Create a WeaveFile.
1094
 
        
 
922
 
1095
923
        :param create: If not True, only open an existing knit.
1096
924
        """
1097
 
        super(WeaveFile, self).__init__(name, access_mode)
 
925
        super(WeaveFile, self).__init__(name, access_mode, get_scope=get_scope,
 
926
            allow_reserved=False)
1098
927
        self._transport = transport
1099
928
        self._filemode = filemode
1100
929
        try:
1105
934
            # new file, save it
1106
935
            self._save()
1107
936
 
1108
 
    def _add_lines(self, version_id, parents, lines, parent_texts):
 
937
    def _add_lines(self, version_id, parents, lines, parent_texts,
 
938
        left_matching_blocks, nostore_sha, random_id, check_content):
1109
939
        """Add a version and save the weave."""
1110
940
        self.check_not_reserved_id(version_id)
1111
941
        result = super(WeaveFile, self)._add_lines(version_id, parents, lines,
1112
 
                                                   parent_texts)
 
942
            parent_texts, left_matching_blocks, nostore_sha, random_id,
 
943
            check_content)
1113
944
        self._save()
1114
945
        return result
1115
946
 
1116
 
    def _clone_text(self, new_version_id, old_version_id, parents):
1117
 
        """See VersionedFile.clone_text."""
1118
 
        super(WeaveFile, self)._clone_text(new_version_id, old_version_id, parents)
1119
 
        self._save
1120
 
 
1121
947
    def copy_to(self, name, transport):
1122
948
        """See VersionedFile.copy_to()."""
1123
949
        # as we are all in memory always, just serialise to the new place.
1126
952
        sio.seek(0)
1127
953
        transport.put_file(name + WeaveFile.WEAVE_SUFFIX, sio, self._filemode)
1128
954
 
1129
 
    def create_empty(self, name, transport, filemode=None):
1130
 
        return WeaveFile(name, transport, filemode, create=True)
1131
 
 
1132
955
    def _save(self):
1133
956
        """Save the weave."""
1134
957
        self._check_write_ok()
1135
958
        sio = StringIO()
1136
959
        write_weave_v5(self, sio)
1137
960
        sio.seek(0)
1138
 
        self._transport.put_file(self._weave_name + WeaveFile.WEAVE_SUFFIX,
1139
 
                                 sio,
1140
 
                                 self._filemode)
 
961
        bytes = sio.getvalue()
 
962
        path = self._weave_name + WeaveFile.WEAVE_SUFFIX
 
963
        try:
 
964
            self._transport.put_bytes(path, bytes, self._filemode)
 
965
        except errors.NoSuchFile:
 
966
            self._transport.mkdir(dirname(path))
 
967
            self._transport.put_bytes(path, bytes, self._filemode)
1141
968
 
1142
969
    @staticmethod
1143
970
    def get_suffixes():
1144
971
        """See VersionedFile.get_suffixes()."""
1145
972
        return [WeaveFile.WEAVE_SUFFIX]
1146
973
 
1147
 
    def join(self, other, pb=None, msg=None, version_ids=None,
1148
 
             ignore_missing=False):
1149
 
        """Join other into self and save."""
1150
 
        super(WeaveFile, self).join(other, pb, msg, version_ids, ignore_missing)
 
974
    def insert_record_stream(self, stream):
 
975
        super(WeaveFile, self).insert_record_stream(stream)
1151
976
        self._save()
1152
977
 
1153
978
 
1154
 
@deprecated_function(zero_eight)
1155
 
def reweave(wa, wb, pb=None, msg=None):
1156
 
    """reweaving is deprecation, please just use weave.join()."""
1157
 
    _reweave(wa, wb, pb, msg)
1158
 
 
1159
979
def _reweave(wa, wb, pb=None, msg=None):
1160
980
    """Combine two weaves and return the result.
1161
981
 
1162
 
    This works even if a revision R has different parents in 
 
982
    This works even if a revision R has different parents in
1163
983
    wa and wb.  In the resulting weave all the parents are given.
1164
984
 
1165
 
    This is done by just building up a new weave, maintaining ordering 
 
985
    This is done by just building up a new weave, maintaining ordering
1166
986
    of the versions in the two inputs.  More efficient approaches
1167
 
    might be possible but it should only be necessary to do 
1168
 
    this operation rarely, when a new previously ghost version is 
 
987
    might be possible but it should only be necessary to do
 
988
    this operation rarely, when a new previously ghost version is
1169
989
    inserted.
1170
990
 
1171
991
    :param pb: An optional progress bar, indicating how far done we are
1179
999
    # map from version name -> all parent names
1180
1000
    combined_parents = _reweave_parent_graphs(wa, wb)
1181
1001
    mutter("combined parents: %r", combined_parents)
1182
 
    order = topo_sort(combined_parents.iteritems())
 
1002
    order = tsort.topo_sort(combined_parents.iteritems())
1183
1003
    mutter("order to reweave: %r", order)
1184
1004
 
1185
1005
    if pb and not msg:
1207
1027
 
1208
1028
def _reweave_parent_graphs(wa, wb):
1209
1029
    """Return combined parent ancestry for two weaves.
1210
 
    
 
1030
 
1211
1031
    Returned as a list of (version_name, set(parent_names))"""
1212
1032
    combined = {}
1213
1033
    for weave in [wa, wb]:
1278
1098
        Display origin of each line.
1279
1099
    weave merge WEAVEFILE VERSION1 VERSION2 > OUT
1280
1100
        Auto-merge two versions and display conflicts.
1281
 
    weave diff WEAVEFILE VERSION1 VERSION2 
 
1101
    weave diff WEAVEFILE VERSION1 VERSION2
1282
1102
        Show differences between two versions.
1283
1103
 
1284
1104
example:
1301
1121
 
1302
1122
    % weave merge foo.weave 1 2 > foo.txt   (merge them)
1303
1123
    % vi foo.txt                            (resolve conflicts)
1304
 
    % weave add foo.weave merged 1 2 < foo.txt     (commit merged version)     
1305
 
    
 
1124
    % weave add foo.weave merged 1 2 < foo.txt     (commit merged version)
 
1125
 
1306
1126
"""
1307
 
    
 
1127
 
1308
1128
 
1309
1129
 
1310
1130
def main(argv):
1333
1153
 
1334
1154
    def readit():
1335
1155
        return read_weave(file(argv[2], 'rb'))
1336
 
    
 
1156
 
1337
1157
    if cmd == 'help':
1338
1158
        usage()
1339
1159
    elif cmd == 'add':
1354
1174
    elif cmd == 'get': # get one version
1355
1175
        w = readit()
1356
1176
        sys.stdout.writelines(w.get_iter(int(argv[3])))
1357
 
        
 
1177
 
1358
1178
    elif cmd == 'diff':
1359
1179
        w = readit()
1360
1180
        fn = argv[2]
1365
1185
                                '%s version %d' % (fn, v1),
1366
1186
                                '%s version %d' % (fn, v2))
1367
1187
        sys.stdout.writelines(diff_gen)
1368
 
            
 
1188
 
1369
1189
    elif cmd == 'annotate':
1370
1190
        w = readit()
1371
1191
        # newline is added to all lines regardless; too hard to get
1378
1198
            else:
1379
1199
                print '%5d | %s' % (origin, text)
1380
1200
                lasto = origin
1381
 
                
 
1201
 
1382
1202
    elif cmd == 'toc':
1383
1203
        weave_toc(readit())
1384
1204
 
1385
1205
    elif cmd == 'stats':
1386
1206
        weave_stats(argv[2], ProgressBar())
1387
 
        
 
1207
 
1388
1208
    elif cmd == 'check':
1389
1209
        w = readit()
1390
1210
        pb = ProgressBar()
1413
1233
        sys.stdout.writelines(w.weave_merge(p))
1414
1234
    else:
1415
1235
        raise ValueError('unknown command %r' % cmd)
1416
 
    
 
1236
 
1417
1237
 
1418
1238
if __name__ == '__main__':
1419
1239
    import sys
1420
1240
    sys.exit(main(sys.argv))
1421
 
 
1422
 
 
1423
 
class InterWeave(InterVersionedFile):
1424
 
    """Optimised code paths for weave to weave operations."""
1425
 
    
1426
 
    _matching_file_from_factory = staticmethod(WeaveFile)
1427
 
    _matching_file_to_factory = staticmethod(WeaveFile)
1428
 
    
1429
 
    @staticmethod
1430
 
    def is_compatible(source, target):
1431
 
        """Be compatible with weaves."""
1432
 
        try:
1433
 
            return (isinstance(source, Weave) and
1434
 
                    isinstance(target, Weave))
1435
 
        except AttributeError:
1436
 
            return False
1437
 
 
1438
 
    def join(self, pb=None, msg=None, version_ids=None, ignore_missing=False):
1439
 
        """See InterVersionedFile.join."""
1440
 
        version_ids = self._get_source_version_ids(version_ids, ignore_missing)
1441
 
        if self.target.versions() == [] and version_ids is None:
1442
 
            self.target._copy_weave_content(self.source)
1443
 
            return
1444
 
        try:
1445
 
            self.target._join(self.source, pb, msg, version_ids, ignore_missing)
1446
 
        except errors.WeaveParentMismatch:
1447
 
            self.target._reweave(self.source, pb, msg)
1448
 
 
1449
 
 
1450
 
InterVersionedFile.register_optimiser(InterWeave)