/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/repofmt/pack_repo.py

  • Committer: Aaron Bentley
  • Date: 2008-10-16 21:47:05 UTC
  • mfrom: (3782 +trunk)
  • mto: (0.14.25 prepare-shelf)
  • mto: This revision was merged to the branch mainline in revision 3820.
  • Revision ID: aaron@aaronbentley.com-20081016214705-9y3mj4era3zw3skh
Merge with bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
from bzrlib.lazy_import import lazy_import
 
18
lazy_import(globals(), """
 
19
from itertools import izip
 
20
import time
 
21
 
 
22
from bzrlib import (
 
23
    debug,
 
24
    graph,
 
25
    osutils,
 
26
    pack,
 
27
    transactions,
 
28
    ui,
 
29
    xml5,
 
30
    xml6,
 
31
    xml7,
 
32
    )
 
33
from bzrlib.index import (
 
34
    CombinedGraphIndex,
 
35
    GraphIndex,
 
36
    GraphIndexBuilder,
 
37
    GraphIndexPrefixAdapter,
 
38
    InMemoryGraphIndex,
 
39
    )
 
40
from bzrlib.knit import (
 
41
    KnitPlainFactory,
 
42
    KnitVersionedFiles,
 
43
    _KnitGraphIndex,
 
44
    _DirectPackAccess,
 
45
    )
 
46
from bzrlib import tsort
 
47
""")
 
48
from bzrlib import (
 
49
    bzrdir,
 
50
    errors,
 
51
    lockable_files,
 
52
    lockdir,
 
53
    symbol_versioning,
 
54
    )
 
55
 
 
56
from bzrlib.decorators import needs_write_lock
 
57
from bzrlib.btree_index import (
 
58
    BTreeGraphIndex,
 
59
    BTreeBuilder,
 
60
    )
 
61
from bzrlib.index import (
 
62
    GraphIndex,
 
63
    InMemoryGraphIndex,
 
64
    )
 
65
from bzrlib.repofmt.knitrepo import KnitRepository
 
66
from bzrlib.repository import (
 
67
    CommitBuilder,
 
68
    MetaDirRepositoryFormat,
 
69
    RepositoryFormat,
 
70
    RootCommitBuilder,
 
71
    )
 
72
import bzrlib.revision as _mod_revision
 
73
from bzrlib.trace import (
 
74
    mutter,
 
75
    warning,
 
76
    )
 
77
 
 
78
 
 
79
class PackCommitBuilder(CommitBuilder):
 
80
    """A subclass of CommitBuilder to add texts with pack semantics.
 
81
    
 
82
    Specifically this uses one knit object rather than one knit object per
 
83
    added text, reducing memory and object pressure.
 
84
    """
 
85
 
 
86
    def __init__(self, repository, parents, config, timestamp=None,
 
87
                 timezone=None, committer=None, revprops=None,
 
88
                 revision_id=None):
 
89
        CommitBuilder.__init__(self, repository, parents, config,
 
90
            timestamp=timestamp, timezone=timezone, committer=committer,
 
91
            revprops=revprops, revision_id=revision_id)
 
92
        self._file_graph = graph.Graph(
 
93
            repository._pack_collection.text_index.combined_index)
 
94
 
 
95
    def _heads(self, file_id, revision_ids):
 
96
        keys = [(file_id, revision_id) for revision_id in revision_ids]
 
97
        return set([key[1] for key in self._file_graph.heads(keys)])
 
98
 
 
99
 
 
100
class PackRootCommitBuilder(RootCommitBuilder):
 
101
    """A subclass of RootCommitBuilder to add texts with pack semantics.
 
102
    
 
103
    Specifically this uses one knit object rather than one knit object per
 
104
    added text, reducing memory and object pressure.
 
105
    """
 
106
 
 
107
    def __init__(self, repository, parents, config, timestamp=None,
 
108
                 timezone=None, committer=None, revprops=None,
 
109
                 revision_id=None):
 
110
        CommitBuilder.__init__(self, repository, parents, config,
 
111
            timestamp=timestamp, timezone=timezone, committer=committer,
 
112
            revprops=revprops, revision_id=revision_id)
 
113
        self._file_graph = graph.Graph(
 
114
            repository._pack_collection.text_index.combined_index)
 
115
 
 
116
    def _heads(self, file_id, revision_ids):
 
117
        keys = [(file_id, revision_id) for revision_id in revision_ids]
 
118
        return set([key[1] for key in self._file_graph.heads(keys)])
 
119
 
 
120
 
 
121
class Pack(object):
 
122
    """An in memory proxy for a pack and its indices.
 
123
 
 
124
    This is a base class that is not directly used, instead the classes
 
125
    ExistingPack and NewPack are used.
 
126
    """
 
127
 
 
128
    def __init__(self, revision_index, inventory_index, text_index,
 
129
        signature_index):
 
130
        """Create a pack instance.
 
131
 
 
132
        :param revision_index: A GraphIndex for determining what revisions are
 
133
            present in the Pack and accessing the locations of their texts.
 
134
        :param inventory_index: A GraphIndex for determining what inventories are
 
135
            present in the Pack and accessing the locations of their
 
136
            texts/deltas.
 
137
        :param text_index: A GraphIndex for determining what file texts
 
138
            are present in the pack and accessing the locations of their
 
139
            texts/deltas (via (fileid, revisionid) tuples).
 
140
        :param signature_index: A GraphIndex for determining what signatures are
 
141
            present in the Pack and accessing the locations of their texts.
 
142
        """
 
143
        self.revision_index = revision_index
 
144
        self.inventory_index = inventory_index
 
145
        self.text_index = text_index
 
146
        self.signature_index = signature_index
 
147
 
 
148
    def access_tuple(self):
 
149
        """Return a tuple (transport, name) for the pack content."""
 
150
        return self.pack_transport, self.file_name()
 
151
 
 
152
    def file_name(self):
 
153
        """Get the file name for the pack on disk."""
 
154
        return self.name + '.pack'
 
155
 
 
156
    def get_revision_count(self):
 
157
        return self.revision_index.key_count()
 
158
 
 
159
    def inventory_index_name(self, name):
 
160
        """The inv index is the name + .iix."""
 
161
        return self.index_name('inventory', name)
 
162
 
 
163
    def revision_index_name(self, name):
 
164
        """The revision index is the name + .rix."""
 
165
        return self.index_name('revision', name)
 
166
 
 
167
    def signature_index_name(self, name):
 
168
        """The signature index is the name + .six."""
 
169
        return self.index_name('signature', name)
 
170
 
 
171
    def text_index_name(self, name):
 
172
        """The text index is the name + .tix."""
 
173
        return self.index_name('text', name)
 
174
 
 
175
    def _external_compression_parents_of_texts(self):
 
176
        keys = set()
 
177
        refs = set()
 
178
        for node in self.text_index.iter_all_entries():
 
179
            keys.add(node[1])
 
180
            refs.update(node[3][1])
 
181
        return refs - keys
 
182
 
 
183
 
 
184
class ExistingPack(Pack):
 
185
    """An in memory proxy for an existing .pack and its disk indices."""
 
186
 
 
187
    def __init__(self, pack_transport, name, revision_index, inventory_index,
 
188
        text_index, signature_index):
 
189
        """Create an ExistingPack object.
 
190
 
 
191
        :param pack_transport: The transport where the pack file resides.
 
192
        :param name: The name of the pack on disk in the pack_transport.
 
193
        """
 
194
        Pack.__init__(self, revision_index, inventory_index, text_index,
 
195
            signature_index)
 
196
        self.name = name
 
197
        self.pack_transport = pack_transport
 
198
        if None in (revision_index, inventory_index, text_index,
 
199
                signature_index, name, pack_transport):
 
200
            raise AssertionError()
 
201
 
 
202
    def __eq__(self, other):
 
203
        return self.__dict__ == other.__dict__
 
204
 
 
205
    def __ne__(self, other):
 
206
        return not self.__eq__(other)
 
207
 
 
208
    def __repr__(self):
 
209
        return "<bzrlib.repofmt.pack_repo.Pack object at 0x%x, %s, %s" % (
 
210
            id(self), self.pack_transport, self.name)
 
211
 
 
212
 
 
213
class NewPack(Pack):
 
214
    """An in memory proxy for a pack which is being created."""
 
215
 
 
216
    # A map of index 'type' to the file extension and position in the
 
217
    # index_sizes array.
 
218
    index_definitions = {
 
219
        'revision': ('.rix', 0),
 
220
        'inventory': ('.iix', 1),
 
221
        'text': ('.tix', 2),
 
222
        'signature': ('.six', 3),
 
223
        }
 
224
 
 
225
    def __init__(self, upload_transport, index_transport, pack_transport,
 
226
        upload_suffix='', file_mode=None, index_builder_class=None,
 
227
        index_class=None):
 
228
        """Create a NewPack instance.
 
229
 
 
230
        :param upload_transport: A writable transport for the pack to be
 
231
            incrementally uploaded to.
 
232
        :param index_transport: A writable transport for the pack's indices to
 
233
            be written to when the pack is finished.
 
234
        :param pack_transport: A writable transport for the pack to be renamed
 
235
            to when the upload is complete. This *must* be the same as
 
236
            upload_transport.clone('../packs').
 
237
        :param upload_suffix: An optional suffix to be given to any temporary
 
238
            files created during the pack creation. e.g '.autopack'
 
239
        :param file_mode: An optional file mode to create the new files with.
 
240
        :param index_builder_class: Required keyword parameter - the class of
 
241
            index builder to use.
 
242
        :param index_class: Required keyword parameter - the class of index
 
243
            object to use.
 
244
        """
 
245
        # The relative locations of the packs are constrained, but all are
 
246
        # passed in because the caller has them, so as to avoid object churn.
 
247
        Pack.__init__(self,
 
248
            # Revisions: parents list, no text compression.
 
249
            index_builder_class(reference_lists=1),
 
250
            # Inventory: We want to map compression only, but currently the
 
251
            # knit code hasn't been updated enough to understand that, so we
 
252
            # have a regular 2-list index giving parents and compression
 
253
            # source.
 
254
            index_builder_class(reference_lists=2),
 
255
            # Texts: compression and per file graph, for all fileids - so two
 
256
            # reference lists and two elements in the key tuple.
 
257
            index_builder_class(reference_lists=2, key_elements=2),
 
258
            # Signatures: Just blobs to store, no compression, no parents
 
259
            # listing.
 
260
            index_builder_class(reference_lists=0),
 
261
            )
 
262
        # When we make readonly indices, we need this.
 
263
        self.index_class = index_class
 
264
        # where should the new pack be opened
 
265
        self.upload_transport = upload_transport
 
266
        # where are indices written out to
 
267
        self.index_transport = index_transport
 
268
        # where is the pack renamed to when it is finished?
 
269
        self.pack_transport = pack_transport
 
270
        # What file mode to upload the pack and indices with.
 
271
        self._file_mode = file_mode
 
272
        # tracks the content written to the .pack file.
 
273
        self._hash = osutils.md5()
 
274
        # a four-tuple with the length in bytes of the indices, once the pack
 
275
        # is finalised. (rev, inv, text, sigs)
 
276
        self.index_sizes = None
 
277
        # How much data to cache when writing packs. Note that this is not
 
278
        # synchronised with reads, because it's not in the transport layer, so
 
279
        # is not safe unless the client knows it won't be reading from the pack
 
280
        # under creation.
 
281
        self._cache_limit = 0
 
282
        # the temporary pack file name.
 
283
        self.random_name = osutils.rand_chars(20) + upload_suffix
 
284
        # when was this pack started ?
 
285
        self.start_time = time.time()
 
286
        # open an output stream for the data added to the pack.
 
287
        self.write_stream = self.upload_transport.open_write_stream(
 
288
            self.random_name, mode=self._file_mode)
 
289
        if 'pack' in debug.debug_flags:
 
290
            mutter('%s: create_pack: pack stream open: %s%s t+%6.3fs',
 
291
                time.ctime(), self.upload_transport.base, self.random_name,
 
292
                time.time() - self.start_time)
 
293
        # A list of byte sequences to be written to the new pack, and the 
 
294
        # aggregate size of them.  Stored as a list rather than separate 
 
295
        # variables so that the _write_data closure below can update them.
 
296
        self._buffer = [[], 0]
 
297
        # create a callable for adding data 
 
298
        #
 
299
        # robertc says- this is a closure rather than a method on the object
 
300
        # so that the variables are locals, and faster than accessing object
 
301
        # members.
 
302
        def _write_data(bytes, flush=False, _buffer=self._buffer,
 
303
            _write=self.write_stream.write, _update=self._hash.update):
 
304
            _buffer[0].append(bytes)
 
305
            _buffer[1] += len(bytes)
 
306
            # buffer cap
 
307
            if _buffer[1] > self._cache_limit or flush:
 
308
                bytes = ''.join(_buffer[0])
 
309
                _write(bytes)
 
310
                _update(bytes)
 
311
                _buffer[:] = [[], 0]
 
312
        # expose this on self, for the occasion when clients want to add data.
 
313
        self._write_data = _write_data
 
314
        # a pack writer object to serialise pack records.
 
315
        self._writer = pack.ContainerWriter(self._write_data)
 
316
        self._writer.begin()
 
317
        # what state is the pack in? (open, finished, aborted)
 
318
        self._state = 'open'
 
319
 
 
320
    def abort(self):
 
321
        """Cancel creating this pack."""
 
322
        self._state = 'aborted'
 
323
        self.write_stream.close()
 
324
        # Remove the temporary pack file.
 
325
        self.upload_transport.delete(self.random_name)
 
326
        # The indices have no state on disk.
 
327
 
 
328
    def access_tuple(self):
 
329
        """Return a tuple (transport, name) for the pack content."""
 
330
        if self._state == 'finished':
 
331
            return Pack.access_tuple(self)
 
332
        elif self._state == 'open':
 
333
            return self.upload_transport, self.random_name
 
334
        else:
 
335
            raise AssertionError(self._state)
 
336
 
 
337
    def data_inserted(self):
 
338
        """True if data has been added to this pack."""
 
339
        return bool(self.get_revision_count() or
 
340
            self.inventory_index.key_count() or
 
341
            self.text_index.key_count() or
 
342
            self.signature_index.key_count())
 
343
 
 
344
    def finish(self):
 
345
        """Finish the new pack.
 
346
 
 
347
        This:
 
348
         - finalises the content
 
349
         - assigns a name (the md5 of the content, currently)
 
350
         - writes out the associated indices
 
351
         - renames the pack into place.
 
352
         - stores the index size tuple for the pack in the index_sizes
 
353
           attribute.
 
354
        """
 
355
        self._writer.end()
 
356
        if self._buffer[1]:
 
357
            self._write_data('', flush=True)
 
358
        self.name = self._hash.hexdigest()
 
359
        # write indices
 
360
        # XXX: It'd be better to write them all to temporary names, then
 
361
        # rename them all into place, so that the window when only some are
 
362
        # visible is smaller.  On the other hand none will be seen until
 
363
        # they're in the names list.
 
364
        self.index_sizes = [None, None, None, None]
 
365
        self._write_index('revision', self.revision_index, 'revision')
 
366
        self._write_index('inventory', self.inventory_index, 'inventory')
 
367
        self._write_index('text', self.text_index, 'file texts')
 
368
        self._write_index('signature', self.signature_index,
 
369
            'revision signatures')
 
370
        self.write_stream.close()
 
371
        # Note that this will clobber an existing pack with the same name,
 
372
        # without checking for hash collisions. While this is undesirable this
 
373
        # is something that can be rectified in a subsequent release. One way
 
374
        # to rectify it may be to leave the pack at the original name, writing
 
375
        # its pack-names entry as something like 'HASH: index-sizes
 
376
        # temporary-name'. Allocate that and check for collisions, if it is
 
377
        # collision free then rename it into place. If clients know this scheme
 
378
        # they can handle missing-file errors by:
 
379
        #  - try for HASH.pack
 
380
        #  - try for temporary-name
 
381
        #  - refresh the pack-list to see if the pack is now absent
 
382
        self.upload_transport.rename(self.random_name,
 
383
                '../packs/' + self.name + '.pack')
 
384
        self._state = 'finished'
 
385
        if 'pack' in debug.debug_flags:
 
386
            # XXX: size might be interesting?
 
387
            mutter('%s: create_pack: pack renamed into place: %s%s->%s%s t+%6.3fs',
 
388
                time.ctime(), self.upload_transport.base, self.random_name,
 
389
                self.pack_transport, self.name,
 
390
                time.time() - self.start_time)
 
391
 
 
392
    def flush(self):
 
393
        """Flush any current data."""
 
394
        if self._buffer[1]:
 
395
            bytes = ''.join(self._buffer[0])
 
396
            self.write_stream.write(bytes)
 
397
            self._hash.update(bytes)
 
398
            self._buffer[:] = [[], 0]
 
399
 
 
400
    def index_name(self, index_type, name):
 
401
        """Get the disk name of an index type for pack name 'name'."""
 
402
        return name + NewPack.index_definitions[index_type][0]
 
403
 
 
404
    def index_offset(self, index_type):
 
405
        """Get the position in a index_size array for a given index type."""
 
406
        return NewPack.index_definitions[index_type][1]
 
407
 
 
408
    def _replace_index_with_readonly(self, index_type):
 
409
        setattr(self, index_type + '_index',
 
410
            self.index_class(self.index_transport,
 
411
                self.index_name(index_type, self.name),
 
412
                self.index_sizes[self.index_offset(index_type)]))
 
413
 
 
414
    def set_write_cache_size(self, size):
 
415
        self._cache_limit = size
 
416
 
 
417
    def _write_index(self, index_type, index, label):
 
418
        """Write out an index.
 
419
 
 
420
        :param index_type: The type of index to write - e.g. 'revision'.
 
421
        :param index: The index object to serialise.
 
422
        :param label: What label to give the index e.g. 'revision'.
 
423
        """
 
424
        index_name = self.index_name(index_type, self.name)
 
425
        self.index_sizes[self.index_offset(index_type)] = \
 
426
            self.index_transport.put_file(index_name, index.finish(),
 
427
            mode=self._file_mode)
 
428
        if 'pack' in debug.debug_flags:
 
429
            # XXX: size might be interesting?
 
430
            mutter('%s: create_pack: wrote %s index: %s%s t+%6.3fs',
 
431
                time.ctime(), label, self.upload_transport.base,
 
432
                self.random_name, time.time() - self.start_time)
 
433
        # Replace the writable index on this object with a readonly, 
 
434
        # presently unloaded index. We should alter
 
435
        # the index layer to make its finish() error if add_node is
 
436
        # subsequently used. RBC
 
437
        self._replace_index_with_readonly(index_type)
 
438
 
 
439
 
 
440
class AggregateIndex(object):
 
441
    """An aggregated index for the RepositoryPackCollection.
 
442
 
 
443
    AggregateIndex is reponsible for managing the PackAccess object,
 
444
    Index-To-Pack mapping, and all indices list for a specific type of index
 
445
    such as 'revision index'.
 
446
 
 
447
    A CombinedIndex provides an index on a single key space built up
 
448
    from several on-disk indices.  The AggregateIndex builds on this 
 
449
    to provide a knit access layer, and allows having up to one writable
 
450
    index within the collection.
 
451
    """
 
452
    # XXX: Probably 'can be written to' could/should be separated from 'acts
 
453
    # like a knit index' -- mbp 20071024
 
454
 
 
455
    def __init__(self):
 
456
        """Create an AggregateIndex."""
 
457
        self.index_to_pack = {}
 
458
        self.combined_index = CombinedGraphIndex([])
 
459
        self.data_access = _DirectPackAccess(self.index_to_pack)
 
460
        self.add_callback = None
 
461
 
 
462
    def replace_indices(self, index_to_pack, indices):
 
463
        """Replace the current mappings with fresh ones.
 
464
 
 
465
        This should probably not be used eventually, rather incremental add and
 
466
        removal of indices. It has been added during refactoring of existing
 
467
        code.
 
468
 
 
469
        :param index_to_pack: A mapping from index objects to
 
470
            (transport, name) tuples for the pack file data.
 
471
        :param indices: A list of indices.
 
472
        """
 
473
        # refresh the revision pack map dict without replacing the instance.
 
474
        self.index_to_pack.clear()
 
475
        self.index_to_pack.update(index_to_pack)
 
476
        # XXX: API break - clearly a 'replace' method would be good?
 
477
        self.combined_index._indices[:] = indices
 
478
        # the current add nodes callback for the current writable index if
 
479
        # there is one.
 
480
        self.add_callback = None
 
481
 
 
482
    def add_index(self, index, pack):
 
483
        """Add index to the aggregate, which is an index for Pack pack.
 
484
 
 
485
        Future searches on the aggregate index will seach this new index
 
486
        before all previously inserted indices.
 
487
        
 
488
        :param index: An Index for the pack.
 
489
        :param pack: A Pack instance.
 
490
        """
 
491
        # expose it to the index map
 
492
        self.index_to_pack[index] = pack.access_tuple()
 
493
        # put it at the front of the linear index list
 
494
        self.combined_index.insert_index(0, index)
 
495
 
 
496
    def add_writable_index(self, index, pack):
 
497
        """Add an index which is able to have data added to it.
 
498
 
 
499
        There can be at most one writable index at any time.  Any
 
500
        modifications made to the knit are put into this index.
 
501
        
 
502
        :param index: An index from the pack parameter.
 
503
        :param pack: A Pack instance.
 
504
        """
 
505
        if self.add_callback is not None:
 
506
            raise AssertionError(
 
507
                "%s already has a writable index through %s" % \
 
508
                (self, self.add_callback))
 
509
        # allow writing: queue writes to a new index
 
510
        self.add_index(index, pack)
 
511
        # Updates the index to packs mapping as a side effect,
 
512
        self.data_access.set_writer(pack._writer, index, pack.access_tuple())
 
513
        self.add_callback = index.add_nodes
 
514
 
 
515
    def clear(self):
 
516
        """Reset all the aggregate data to nothing."""
 
517
        self.data_access.set_writer(None, None, (None, None))
 
518
        self.index_to_pack.clear()
 
519
        del self.combined_index._indices[:]
 
520
        self.add_callback = None
 
521
 
 
522
    def remove_index(self, index, pack):
 
523
        """Remove index from the indices used to answer queries.
 
524
        
 
525
        :param index: An index from the pack parameter.
 
526
        :param pack: A Pack instance.
 
527
        """
 
528
        del self.index_to_pack[index]
 
529
        self.combined_index._indices.remove(index)
 
530
        if (self.add_callback is not None and
 
531
            getattr(index, 'add_nodes', None) == self.add_callback):
 
532
            self.add_callback = None
 
533
            self.data_access.set_writer(None, None, (None, None))
 
534
 
 
535
 
 
536
class Packer(object):
 
537
    """Create a pack from packs."""
 
538
 
 
539
    def __init__(self, pack_collection, packs, suffix, revision_ids=None):
 
540
        """Create a Packer.
 
541
 
 
542
        :param pack_collection: A RepositoryPackCollection object where the
 
543
            new pack is being written to.
 
544
        :param packs: The packs to combine.
 
545
        :param suffix: The suffix to use on the temporary files for the pack.
 
546
        :param revision_ids: Revision ids to limit the pack to.
 
547
        """
 
548
        self.packs = packs
 
549
        self.suffix = suffix
 
550
        self.revision_ids = revision_ids
 
551
        # The pack object we are creating.
 
552
        self.new_pack = None
 
553
        self._pack_collection = pack_collection
 
554
        # The index layer keys for the revisions being copied. None for 'all
 
555
        # objects'.
 
556
        self._revision_keys = None
 
557
        # What text keys to copy. None for 'all texts'. This is set by
 
558
        # _copy_inventory_texts
 
559
        self._text_filter = None
 
560
        self._extra_init()
 
561
 
 
562
    def _extra_init(self):
 
563
        """A template hook to allow extending the constructor trivially."""
 
564
 
 
565
    def pack(self, pb=None):
 
566
        """Create a new pack by reading data from other packs.
 
567
 
 
568
        This does little more than a bulk copy of data. One key difference
 
569
        is that data with the same item key across multiple packs is elided
 
570
        from the output. The new pack is written into the current pack store
 
571
        along with its indices, and the name added to the pack names. The 
 
572
        source packs are not altered and are not required to be in the current
 
573
        pack collection.
 
574
 
 
575
        :param pb: An optional progress bar to use. A nested bar is created if
 
576
            this is None.
 
577
        :return: A Pack object, or None if nothing was copied.
 
578
        """
 
579
        # open a pack - using the same name as the last temporary file
 
580
        # - which has already been flushed, so its safe.
 
581
        # XXX: - duplicate code warning with start_write_group; fix before
 
582
        #      considering 'done'.
 
583
        if self._pack_collection._new_pack is not None:
 
584
            raise errors.BzrError('call to create_pack_from_packs while '
 
585
                'another pack is being written.')
 
586
        if self.revision_ids is not None:
 
587
            if len(self.revision_ids) == 0:
 
588
                # silly fetch request.
 
589
                return None
 
590
            else:
 
591
                self.revision_ids = frozenset(self.revision_ids)
 
592
                self.revision_keys = frozenset((revid,) for revid in
 
593
                    self.revision_ids)
 
594
        if pb is None:
 
595
            self.pb = ui.ui_factory.nested_progress_bar()
 
596
        else:
 
597
            self.pb = pb
 
598
        try:
 
599
            return self._create_pack_from_packs()
 
600
        finally:
 
601
            if pb is None:
 
602
                self.pb.finished()
 
603
 
 
604
    def open_pack(self):
 
605
        """Open a pack for the pack we are creating."""
 
606
        return NewPack(self._pack_collection._upload_transport,
 
607
            self._pack_collection._index_transport,
 
608
            self._pack_collection._pack_transport, upload_suffix=self.suffix,
 
609
            file_mode=self._pack_collection.repo.bzrdir._get_file_mode(),
 
610
            index_builder_class=self._pack_collection._index_builder_class,
 
611
            index_class=self._pack_collection._index_class)
 
612
 
 
613
    def _copy_revision_texts(self):
 
614
        """Copy revision data to the new pack."""
 
615
        # select revisions
 
616
        if self.revision_ids:
 
617
            revision_keys = [(revision_id,) for revision_id in self.revision_ids]
 
618
        else:
 
619
            revision_keys = None
 
620
        # select revision keys
 
621
        revision_index_map = self._pack_collection._packs_list_to_pack_map_and_index_list(
 
622
            self.packs, 'revision_index')[0]
 
623
        revision_nodes = self._pack_collection._index_contents(revision_index_map, revision_keys)
 
624
        # copy revision keys and adjust values
 
625
        self.pb.update("Copying revision texts", 1)
 
626
        total_items, readv_group_iter = self._revision_node_readv(revision_nodes)
 
627
        list(self._copy_nodes_graph(revision_index_map, self.new_pack._writer,
 
628
            self.new_pack.revision_index, readv_group_iter, total_items))
 
629
        if 'pack' in debug.debug_flags:
 
630
            mutter('%s: create_pack: revisions copied: %s%s %d items t+%6.3fs',
 
631
                time.ctime(), self._pack_collection._upload_transport.base,
 
632
                self.new_pack.random_name,
 
633
                self.new_pack.revision_index.key_count(),
 
634
                time.time() - self.new_pack.start_time)
 
635
        self._revision_keys = revision_keys
 
636
 
 
637
    def _copy_inventory_texts(self):
 
638
        """Copy the inventory texts to the new pack.
 
639
 
 
640
        self._revision_keys is used to determine what inventories to copy.
 
641
 
 
642
        Sets self._text_filter appropriately.
 
643
        """
 
644
        # select inventory keys
 
645
        inv_keys = self._revision_keys # currently the same keyspace, and note that
 
646
        # querying for keys here could introduce a bug where an inventory item
 
647
        # is missed, so do not change it to query separately without cross
 
648
        # checking like the text key check below.
 
649
        inventory_index_map = self._pack_collection._packs_list_to_pack_map_and_index_list(
 
650
            self.packs, 'inventory_index')[0]
 
651
        inv_nodes = self._pack_collection._index_contents(inventory_index_map, inv_keys)
 
652
        # copy inventory keys and adjust values
 
653
        # XXX: Should be a helper function to allow different inv representation
 
654
        # at this point.
 
655
        self.pb.update("Copying inventory texts", 2)
 
656
        total_items, readv_group_iter = self._least_readv_node_readv(inv_nodes)
 
657
        # Only grab the output lines if we will be processing them
 
658
        output_lines = bool(self.revision_ids)
 
659
        inv_lines = self._copy_nodes_graph(inventory_index_map,
 
660
            self.new_pack._writer, self.new_pack.inventory_index,
 
661
            readv_group_iter, total_items, output_lines=output_lines)
 
662
        if self.revision_ids:
 
663
            self._process_inventory_lines(inv_lines)
 
664
        else:
 
665
            # eat the iterator to cause it to execute.
 
666
            list(inv_lines)
 
667
            self._text_filter = None
 
668
        if 'pack' in debug.debug_flags:
 
669
            mutter('%s: create_pack: inventories copied: %s%s %d items t+%6.3fs',
 
670
                time.ctime(), self._pack_collection._upload_transport.base,
 
671
                self.new_pack.random_name,
 
672
                self.new_pack.inventory_index.key_count(),
 
673
                time.time() - self.new_pack.start_time)
 
674
 
 
675
    def _copy_text_texts(self):
 
676
        # select text keys
 
677
        text_index_map, text_nodes = self._get_text_nodes()
 
678
        if self._text_filter is not None:
 
679
            # We could return the keys copied as part of the return value from
 
680
            # _copy_nodes_graph but this doesn't work all that well with the
 
681
            # need to get line output too, so we check separately, and as we're
 
682
            # going to buffer everything anyway, we check beforehand, which
 
683
            # saves reading knit data over the wire when we know there are
 
684
            # mising records.
 
685
            text_nodes = set(text_nodes)
 
686
            present_text_keys = set(_node[1] for _node in text_nodes)
 
687
            missing_text_keys = set(self._text_filter) - present_text_keys
 
688
            if missing_text_keys:
 
689
                # TODO: raise a specific error that can handle many missing
 
690
                # keys.
 
691
                a_missing_key = missing_text_keys.pop()
 
692
                raise errors.RevisionNotPresent(a_missing_key[1],
 
693
                    a_missing_key[0])
 
694
        # copy text keys and adjust values
 
695
        self.pb.update("Copying content texts", 3)
 
696
        total_items, readv_group_iter = self._least_readv_node_readv(text_nodes)
 
697
        list(self._copy_nodes_graph(text_index_map, self.new_pack._writer,
 
698
            self.new_pack.text_index, readv_group_iter, total_items))
 
699
        self._log_copied_texts()
 
700
 
 
701
    def _check_references(self):
 
702
        """Make sure our external refereneces are present."""
 
703
        external_refs = self.new_pack._external_compression_parents_of_texts()
 
704
        if external_refs:
 
705
            index = self._pack_collection.text_index.combined_index
 
706
            found_items = list(index.iter_entries(external_refs))
 
707
            if len(found_items) != len(external_refs):
 
708
                found_keys = set(k for idx, k, refs, value in found_items)
 
709
                missing_items = external_refs - found_keys
 
710
                missing_file_id, missing_revision_id = missing_items.pop()
 
711
                raise errors.RevisionNotPresent(missing_revision_id,
 
712
                                                missing_file_id)
 
713
 
 
714
    def _create_pack_from_packs(self):
 
715
        self.pb.update("Opening pack", 0, 5)
 
716
        self.new_pack = self.open_pack()
 
717
        new_pack = self.new_pack
 
718
        # buffer data - we won't be reading-back during the pack creation and
 
719
        # this makes a significant difference on sftp pushes.
 
720
        new_pack.set_write_cache_size(1024*1024)
 
721
        if 'pack' in debug.debug_flags:
 
722
            plain_pack_list = ['%s%s' % (a_pack.pack_transport.base, a_pack.name)
 
723
                for a_pack in self.packs]
 
724
            if self.revision_ids is not None:
 
725
                rev_count = len(self.revision_ids)
 
726
            else:
 
727
                rev_count = 'all'
 
728
            mutter('%s: create_pack: creating pack from source packs: '
 
729
                '%s%s %s revisions wanted %s t=0',
 
730
                time.ctime(), self._pack_collection._upload_transport.base, new_pack.random_name,
 
731
                plain_pack_list, rev_count)
 
732
        self._copy_revision_texts()
 
733
        self._copy_inventory_texts()
 
734
        self._copy_text_texts()
 
735
        # select signature keys
 
736
        signature_filter = self._revision_keys # same keyspace
 
737
        signature_index_map = self._pack_collection._packs_list_to_pack_map_and_index_list(
 
738
            self.packs, 'signature_index')[0]
 
739
        signature_nodes = self._pack_collection._index_contents(signature_index_map,
 
740
            signature_filter)
 
741
        # copy signature keys and adjust values
 
742
        self.pb.update("Copying signature texts", 4)
 
743
        self._copy_nodes(signature_nodes, signature_index_map, new_pack._writer,
 
744
            new_pack.signature_index)
 
745
        if 'pack' in debug.debug_flags:
 
746
            mutter('%s: create_pack: revision signatures copied: %s%s %d items t+%6.3fs',
 
747
                time.ctime(), self._pack_collection._upload_transport.base, new_pack.random_name,
 
748
                new_pack.signature_index.key_count(),
 
749
                time.time() - new_pack.start_time)
 
750
        self._check_references()
 
751
        if not self._use_pack(new_pack):
 
752
            new_pack.abort()
 
753
            return None
 
754
        self.pb.update("Finishing pack", 5)
 
755
        new_pack.finish()
 
756
        self._pack_collection.allocate(new_pack)
 
757
        return new_pack
 
758
 
 
759
    def _copy_nodes(self, nodes, index_map, writer, write_index):
 
760
        """Copy knit nodes between packs with no graph references."""
 
761
        pb = ui.ui_factory.nested_progress_bar()
 
762
        try:
 
763
            return self._do_copy_nodes(nodes, index_map, writer,
 
764
                write_index, pb)
 
765
        finally:
 
766
            pb.finished()
 
767
 
 
768
    def _do_copy_nodes(self, nodes, index_map, writer, write_index, pb):
 
769
        # for record verification
 
770
        knit = KnitVersionedFiles(None, None)
 
771
        # plan a readv on each source pack:
 
772
        # group by pack
 
773
        nodes = sorted(nodes)
 
774
        # how to map this into knit.py - or knit.py into this?
 
775
        # we don't want the typical knit logic, we want grouping by pack
 
776
        # at this point - perhaps a helper library for the following code 
 
777
        # duplication points?
 
778
        request_groups = {}
 
779
        for index, key, value in nodes:
 
780
            if index not in request_groups:
 
781
                request_groups[index] = []
 
782
            request_groups[index].append((key, value))
 
783
        record_index = 0
 
784
        pb.update("Copied record", record_index, len(nodes))
 
785
        for index, items in request_groups.iteritems():
 
786
            pack_readv_requests = []
 
787
            for key, value in items:
 
788
                # ---- KnitGraphIndex.get_position
 
789
                bits = value[1:].split(' ')
 
790
                offset, length = int(bits[0]), int(bits[1])
 
791
                pack_readv_requests.append((offset, length, (key, value[0])))
 
792
            # linear scan up the pack
 
793
            pack_readv_requests.sort()
 
794
            # copy the data
 
795
            transport, path = index_map[index]
 
796
            reader = pack.make_readv_reader(transport, path,
 
797
                [offset[0:2] for offset in pack_readv_requests])
 
798
            for (names, read_func), (_1, _2, (key, eol_flag)) in \
 
799
                izip(reader.iter_records(), pack_readv_requests):
 
800
                raw_data = read_func(None)
 
801
                # check the header only
 
802
                df, _ = knit._parse_record_header(key, raw_data)
 
803
                df.close()
 
804
                pos, size = writer.add_bytes_record(raw_data, names)
 
805
                write_index.add_node(key, eol_flag + "%d %d" % (pos, size))
 
806
                pb.update("Copied record", record_index)
 
807
                record_index += 1
 
808
 
 
809
    def _copy_nodes_graph(self, index_map, writer, write_index,
 
810
        readv_group_iter, total_items, output_lines=False):
 
811
        """Copy knit nodes between packs.
 
812
 
 
813
        :param output_lines: Return lines present in the copied data as
 
814
            an iterator of line,version_id.
 
815
        """
 
816
        pb = ui.ui_factory.nested_progress_bar()
 
817
        try:
 
818
            for result in self._do_copy_nodes_graph(index_map, writer,
 
819
                write_index, output_lines, pb, readv_group_iter, total_items):
 
820
                yield result
 
821
        except Exception:
 
822
            # Python 2.4 does not permit try:finally: in a generator.
 
823
            pb.finished()
 
824
            raise
 
825
        else:
 
826
            pb.finished()
 
827
 
 
828
    def _do_copy_nodes_graph(self, index_map, writer, write_index,
 
829
        output_lines, pb, readv_group_iter, total_items):
 
830
        # for record verification
 
831
        knit = KnitVersionedFiles(None, None)
 
832
        # for line extraction when requested (inventories only)
 
833
        if output_lines:
 
834
            factory = KnitPlainFactory()
 
835
        record_index = 0
 
836
        pb.update("Copied record", record_index, total_items)
 
837
        for index, readv_vector, node_vector in readv_group_iter:
 
838
            # copy the data
 
839
            transport, path = index_map[index]
 
840
            reader = pack.make_readv_reader(transport, path, readv_vector)
 
841
            for (names, read_func), (key, eol_flag, references) in \
 
842
                izip(reader.iter_records(), node_vector):
 
843
                raw_data = read_func(None)
 
844
                if output_lines:
 
845
                    # read the entire thing
 
846
                    content, _ = knit._parse_record(key[-1], raw_data)
 
847
                    if len(references[-1]) == 0:
 
848
                        line_iterator = factory.get_fulltext_content(content)
 
849
                    else:
 
850
                        line_iterator = factory.get_linedelta_content(content)
 
851
                    for line in line_iterator:
 
852
                        yield line, key
 
853
                else:
 
854
                    # check the header only
 
855
                    df, _ = knit._parse_record_header(key, raw_data)
 
856
                    df.close()
 
857
                pos, size = writer.add_bytes_record(raw_data, names)
 
858
                write_index.add_node(key, eol_flag + "%d %d" % (pos, size), references)
 
859
                pb.update("Copied record", record_index)
 
860
                record_index += 1
 
861
 
 
862
    def _get_text_nodes(self):
 
863
        text_index_map = self._pack_collection._packs_list_to_pack_map_and_index_list(
 
864
            self.packs, 'text_index')[0]
 
865
        return text_index_map, self._pack_collection._index_contents(text_index_map,
 
866
            self._text_filter)
 
867
 
 
868
    def _least_readv_node_readv(self, nodes):
 
869
        """Generate request groups for nodes using the least readv's.
 
870
        
 
871
        :param nodes: An iterable of graph index nodes.
 
872
        :return: Total node count and an iterator of the data needed to perform
 
873
            readvs to obtain the data for nodes. Each item yielded by the
 
874
            iterator is a tuple with:
 
875
            index, readv_vector, node_vector. readv_vector is a list ready to
 
876
            hand to the transport readv method, and node_vector is a list of
 
877
            (key, eol_flag, references) for the the node retrieved by the
 
878
            matching readv_vector.
 
879
        """
 
880
        # group by pack so we do one readv per pack
 
881
        nodes = sorted(nodes)
 
882
        total = len(nodes)
 
883
        request_groups = {}
 
884
        for index, key, value, references in nodes:
 
885
            if index not in request_groups:
 
886
                request_groups[index] = []
 
887
            request_groups[index].append((key, value, references))
 
888
        result = []
 
889
        for index, items in request_groups.iteritems():
 
890
            pack_readv_requests = []
 
891
            for key, value, references in items:
 
892
                # ---- KnitGraphIndex.get_position
 
893
                bits = value[1:].split(' ')
 
894
                offset, length = int(bits[0]), int(bits[1])
 
895
                pack_readv_requests.append(
 
896
                    ((offset, length), (key, value[0], references)))
 
897
            # linear scan up the pack to maximum range combining.
 
898
            pack_readv_requests.sort()
 
899
            # split out the readv and the node data.
 
900
            pack_readv = [readv for readv, node in pack_readv_requests]
 
901
            node_vector = [node for readv, node in pack_readv_requests]
 
902
            result.append((index, pack_readv, node_vector))
 
903
        return total, result
 
904
 
 
905
    def _log_copied_texts(self):
 
906
        if 'pack' in debug.debug_flags:
 
907
            mutter('%s: create_pack: file texts copied: %s%s %d items t+%6.3fs',
 
908
                time.ctime(), self._pack_collection._upload_transport.base,
 
909
                self.new_pack.random_name,
 
910
                self.new_pack.text_index.key_count(),
 
911
                time.time() - self.new_pack.start_time)
 
912
 
 
913
    def _process_inventory_lines(self, inv_lines):
 
914
        """Use up the inv_lines generator and setup a text key filter."""
 
915
        repo = self._pack_collection.repo
 
916
        fileid_revisions = repo._find_file_ids_from_xml_inventory_lines(
 
917
            inv_lines, self.revision_keys)
 
918
        text_filter = []
 
919
        for fileid, file_revids in fileid_revisions.iteritems():
 
920
            text_filter.extend([(fileid, file_revid) for file_revid in file_revids])
 
921
        self._text_filter = text_filter
 
922
 
 
923
    def _revision_node_readv(self, revision_nodes):
 
924
        """Return the total revisions and the readv's to issue.
 
925
 
 
926
        :param revision_nodes: The revision index contents for the packs being
 
927
            incorporated into the new pack.
 
928
        :return: As per _least_readv_node_readv.
 
929
        """
 
930
        return self._least_readv_node_readv(revision_nodes)
 
931
 
 
932
    def _use_pack(self, new_pack):
 
933
        """Return True if new_pack should be used.
 
934
 
 
935
        :param new_pack: The pack that has just been created.
 
936
        :return: True if the pack should be used.
 
937
        """
 
938
        return new_pack.data_inserted()
 
939
 
 
940
 
 
941
class OptimisingPacker(Packer):
 
942
    """A packer which spends more time to create better disk layouts."""
 
943
 
 
944
    def _revision_node_readv(self, revision_nodes):
 
945
        """Return the total revisions and the readv's to issue.
 
946
 
 
947
        This sort places revisions in topological order with the ancestors
 
948
        after the children.
 
949
 
 
950
        :param revision_nodes: The revision index contents for the packs being
 
951
            incorporated into the new pack.
 
952
        :return: As per _least_readv_node_readv.
 
953
        """
 
954
        # build an ancestors dict
 
955
        ancestors = {}
 
956
        by_key = {}
 
957
        for index, key, value, references in revision_nodes:
 
958
            ancestors[key] = references[0]
 
959
            by_key[key] = (index, value, references)
 
960
        order = tsort.topo_sort(ancestors)
 
961
        total = len(order)
 
962
        # Single IO is pathological, but it will work as a starting point.
 
963
        requests = []
 
964
        for key in reversed(order):
 
965
            index, value, references = by_key[key]
 
966
            # ---- KnitGraphIndex.get_position
 
967
            bits = value[1:].split(' ')
 
968
            offset, length = int(bits[0]), int(bits[1])
 
969
            requests.append(
 
970
                (index, [(offset, length)], [(key, value[0], references)]))
 
971
        # TODO: combine requests in the same index that are in ascending order.
 
972
        return total, requests
 
973
 
 
974
 
 
975
class ReconcilePacker(Packer):
 
976
    """A packer which regenerates indices etc as it copies.
 
977
    
 
978
    This is used by ``bzr reconcile`` to cause parent text pointers to be
 
979
    regenerated.
 
980
    """
 
981
 
 
982
    def _extra_init(self):
 
983
        self._data_changed = False
 
984
 
 
985
    def _process_inventory_lines(self, inv_lines):
 
986
        """Generate a text key reference map rather for reconciling with."""
 
987
        repo = self._pack_collection.repo
 
988
        refs = repo._find_text_key_references_from_xml_inventory_lines(
 
989
            inv_lines)
 
990
        self._text_refs = refs
 
991
        # during reconcile we:
 
992
        #  - convert unreferenced texts to full texts
 
993
        #  - correct texts which reference a text not copied to be full texts
 
994
        #  - copy all others as-is but with corrected parents.
 
995
        #  - so at this point we don't know enough to decide what becomes a full
 
996
        #    text.
 
997
        self._text_filter = None
 
998
 
 
999
    def _copy_text_texts(self):
 
1000
        """generate what texts we should have and then copy."""
 
1001
        self.pb.update("Copying content texts", 3)
 
1002
        # we have three major tasks here:
 
1003
        # 1) generate the ideal index
 
1004
        repo = self._pack_collection.repo
 
1005
        ancestors = dict([(key[0], tuple(ref[0] for ref in refs[0])) for
 
1006
            _1, key, _2, refs in 
 
1007
            self.new_pack.revision_index.iter_all_entries()])
 
1008
        ideal_index = repo._generate_text_key_index(self._text_refs, ancestors)
 
1009
        # 2) generate a text_nodes list that contains all the deltas that can
 
1010
        #    be used as-is, with corrected parents.
 
1011
        ok_nodes = []
 
1012
        bad_texts = []
 
1013
        discarded_nodes = []
 
1014
        NULL_REVISION = _mod_revision.NULL_REVISION
 
1015
        text_index_map, text_nodes = self._get_text_nodes()
 
1016
        for node in text_nodes:
 
1017
            # 0 - index
 
1018
            # 1 - key 
 
1019
            # 2 - value
 
1020
            # 3 - refs
 
1021
            try:
 
1022
                ideal_parents = tuple(ideal_index[node[1]])
 
1023
            except KeyError:
 
1024
                discarded_nodes.append(node)
 
1025
                self._data_changed = True
 
1026
            else:
 
1027
                if ideal_parents == (NULL_REVISION,):
 
1028
                    ideal_parents = ()
 
1029
                if ideal_parents == node[3][0]:
 
1030
                    # no change needed.
 
1031
                    ok_nodes.append(node)
 
1032
                elif ideal_parents[0:1] == node[3][0][0:1]:
 
1033
                    # the left most parent is the same, or there are no parents
 
1034
                    # today. Either way, we can preserve the representation as
 
1035
                    # long as we change the refs to be inserted.
 
1036
                    self._data_changed = True
 
1037
                    ok_nodes.append((node[0], node[1], node[2],
 
1038
                        (ideal_parents, node[3][1])))
 
1039
                    self._data_changed = True
 
1040
                else:
 
1041
                    # Reinsert this text completely
 
1042
                    bad_texts.append((node[1], ideal_parents))
 
1043
                    self._data_changed = True
 
1044
        # we're finished with some data.
 
1045
        del ideal_index
 
1046
        del text_nodes
 
1047
        # 3) bulk copy the ok data
 
1048
        total_items, readv_group_iter = self._least_readv_node_readv(ok_nodes)
 
1049
        list(self._copy_nodes_graph(text_index_map, self.new_pack._writer,
 
1050
            self.new_pack.text_index, readv_group_iter, total_items))
 
1051
        # 4) adhoc copy all the other texts.
 
1052
        # We have to topologically insert all texts otherwise we can fail to
 
1053
        # reconcile when parts of a single delta chain are preserved intact,
 
1054
        # and other parts are not. E.g. Discarded->d1->d2->d3. d1 will be
 
1055
        # reinserted, and if d3 has incorrect parents it will also be
 
1056
        # reinserted. If we insert d3 first, d2 is present (as it was bulk
 
1057
        # copied), so we will try to delta, but d2 is not currently able to be
 
1058
        # extracted because it's basis d1 is not present. Topologically sorting
 
1059
        # addresses this. The following generates a sort for all the texts that
 
1060
        # are being inserted without having to reference the entire text key
 
1061
        # space (we only topo sort the revisions, which is smaller).
 
1062
        topo_order = tsort.topo_sort(ancestors)
 
1063
        rev_order = dict(zip(topo_order, range(len(topo_order))))
 
1064
        bad_texts.sort(key=lambda key:rev_order[key[0][1]])
 
1065
        transaction = repo.get_transaction()
 
1066
        file_id_index = GraphIndexPrefixAdapter(
 
1067
            self.new_pack.text_index,
 
1068
            ('blank', ), 1,
 
1069
            add_nodes_callback=self.new_pack.text_index.add_nodes)
 
1070
        data_access = _DirectPackAccess(
 
1071
                {self.new_pack.text_index:self.new_pack.access_tuple()})
 
1072
        data_access.set_writer(self.new_pack._writer, self.new_pack.text_index,
 
1073
            self.new_pack.access_tuple())
 
1074
        output_texts = KnitVersionedFiles(
 
1075
            _KnitGraphIndex(self.new_pack.text_index,
 
1076
                add_callback=self.new_pack.text_index.add_nodes,
 
1077
                deltas=True, parents=True, is_locked=repo.is_locked),
 
1078
            data_access=data_access, max_delta_chain=200)
 
1079
        for key, parent_keys in bad_texts:
 
1080
            # We refer to the new pack to delta data being output.
 
1081
            # A possible improvement would be to catch errors on short reads
 
1082
            # and only flush then.
 
1083
            self.new_pack.flush()
 
1084
            parents = []
 
1085
            for parent_key in parent_keys:
 
1086
                if parent_key[0] != key[0]:
 
1087
                    # Graph parents must match the fileid
 
1088
                    raise errors.BzrError('Mismatched key parent %r:%r' %
 
1089
                        (key, parent_keys))
 
1090
                parents.append(parent_key[1])
 
1091
            text_lines = osutils.split_lines(repo.texts.get_record_stream(
 
1092
                [key], 'unordered', True).next().get_bytes_as('fulltext'))
 
1093
            output_texts.add_lines(key, parent_keys, text_lines,
 
1094
                random_id=True, check_content=False)
 
1095
        # 5) check that nothing inserted has a reference outside the keyspace.
 
1096
        missing_text_keys = self.new_pack._external_compression_parents_of_texts()
 
1097
        if missing_text_keys:
 
1098
            raise errors.BzrError('Reference to missing compression parents %r'
 
1099
                % (missing_text_keys,))
 
1100
        self._log_copied_texts()
 
1101
 
 
1102
    def _use_pack(self, new_pack):
 
1103
        """Override _use_pack to check for reconcile having changed content."""
 
1104
        # XXX: we might be better checking this at the copy time.
 
1105
        original_inventory_keys = set()
 
1106
        inv_index = self._pack_collection.inventory_index.combined_index
 
1107
        for entry in inv_index.iter_all_entries():
 
1108
            original_inventory_keys.add(entry[1])
 
1109
        new_inventory_keys = set()
 
1110
        for entry in new_pack.inventory_index.iter_all_entries():
 
1111
            new_inventory_keys.add(entry[1])
 
1112
        if new_inventory_keys != original_inventory_keys:
 
1113
            self._data_changed = True
 
1114
        return new_pack.data_inserted() and self._data_changed
 
1115
 
 
1116
 
 
1117
class RepositoryPackCollection(object):
 
1118
    """Management of packs within a repository.
 
1119
    
 
1120
    :ivar _names: map of {pack_name: (index_size,)}
 
1121
    """
 
1122
 
 
1123
    def __init__(self, repo, transport, index_transport, upload_transport,
 
1124
                 pack_transport, index_builder_class, index_class):
 
1125
        """Create a new RepositoryPackCollection.
 
1126
 
 
1127
        :param transport: Addresses the repository base directory 
 
1128
            (typically .bzr/repository/).
 
1129
        :param index_transport: Addresses the directory containing indices.
 
1130
        :param upload_transport: Addresses the directory into which packs are written
 
1131
            while they're being created.
 
1132
        :param pack_transport: Addresses the directory of existing complete packs.
 
1133
        :param index_builder_class: The index builder class to use.
 
1134
        :param index_class: The index class to use.
 
1135
        """
 
1136
        self.repo = repo
 
1137
        self.transport = transport
 
1138
        self._index_transport = index_transport
 
1139
        self._upload_transport = upload_transport
 
1140
        self._pack_transport = pack_transport
 
1141
        self._index_builder_class = index_builder_class
 
1142
        self._index_class = index_class
 
1143
        self._suffix_offsets = {'.rix': 0, '.iix': 1, '.tix': 2, '.six': 3}
 
1144
        self.packs = []
 
1145
        # name:Pack mapping
 
1146
        self._packs_by_name = {}
 
1147
        # the previous pack-names content
 
1148
        self._packs_at_load = None
 
1149
        # when a pack is being created by this object, the state of that pack.
 
1150
        self._new_pack = None
 
1151
        # aggregated revision index data
 
1152
        self.revision_index = AggregateIndex()
 
1153
        self.inventory_index = AggregateIndex()
 
1154
        self.text_index = AggregateIndex()
 
1155
        self.signature_index = AggregateIndex()
 
1156
 
 
1157
    def add_pack_to_memory(self, pack):
 
1158
        """Make a Pack object available to the repository to satisfy queries.
 
1159
        
 
1160
        :param pack: A Pack object.
 
1161
        """
 
1162
        if pack.name in self._packs_by_name:
 
1163
            raise AssertionError()
 
1164
        self.packs.append(pack)
 
1165
        self._packs_by_name[pack.name] = pack
 
1166
        self.revision_index.add_index(pack.revision_index, pack)
 
1167
        self.inventory_index.add_index(pack.inventory_index, pack)
 
1168
        self.text_index.add_index(pack.text_index, pack)
 
1169
        self.signature_index.add_index(pack.signature_index, pack)
 
1170
        
 
1171
    def all_packs(self):
 
1172
        """Return a list of all the Pack objects this repository has.
 
1173
 
 
1174
        Note that an in-progress pack being created is not returned.
 
1175
 
 
1176
        :return: A list of Pack objects for all the packs in the repository.
 
1177
        """
 
1178
        result = []
 
1179
        for name in self.names():
 
1180
            result.append(self.get_pack_by_name(name))
 
1181
        return result
 
1182
 
 
1183
    def autopack(self):
 
1184
        """Pack the pack collection incrementally.
 
1185
        
 
1186
        This will not attempt global reorganisation or recompression,
 
1187
        rather it will just ensure that the total number of packs does
 
1188
        not grow without bound. It uses the _max_pack_count method to
 
1189
        determine if autopacking is needed, and the pack_distribution
 
1190
        method to determine the number of revisions in each pack.
 
1191
 
 
1192
        If autopacking takes place then the packs name collection will have
 
1193
        been flushed to disk - packing requires updating the name collection
 
1194
        in synchronisation with certain steps. Otherwise the names collection
 
1195
        is not flushed.
 
1196
 
 
1197
        :return: True if packing took place.
 
1198
        """
 
1199
        # XXX: Should not be needed when the management of indices is sane.
 
1200
        total_revisions = self.revision_index.combined_index.key_count()
 
1201
        total_packs = len(self._names)
 
1202
        if self._max_pack_count(total_revisions) >= total_packs:
 
1203
            return False
 
1204
        # XXX: the following may want to be a class, to pack with a given
 
1205
        # policy.
 
1206
        mutter('Auto-packing repository %s, which has %d pack files, '
 
1207
            'containing %d revisions into %d packs.', self, total_packs,
 
1208
            total_revisions, self._max_pack_count(total_revisions))
 
1209
        # determine which packs need changing
 
1210
        pack_distribution = self.pack_distribution(total_revisions)
 
1211
        existing_packs = []
 
1212
        for pack in self.all_packs():
 
1213
            revision_count = pack.get_revision_count()
 
1214
            if revision_count == 0:
 
1215
                # revision less packs are not generated by normal operation,
 
1216
                # only by operations like sign-my-commits, and thus will not
 
1217
                # tend to grow rapdily or without bound like commit containing
 
1218
                # packs do - leave them alone as packing them really should
 
1219
                # group their data with the relevant commit, and that may
 
1220
                # involve rewriting ancient history - which autopack tries to
 
1221
                # avoid. Alternatively we could not group the data but treat
 
1222
                # each of these as having a single revision, and thus add 
 
1223
                # one revision for each to the total revision count, to get
 
1224
                # a matching distribution.
 
1225
                continue
 
1226
            existing_packs.append((revision_count, pack))
 
1227
        pack_operations = self.plan_autopack_combinations(
 
1228
            existing_packs, pack_distribution)
 
1229
        self._execute_pack_operations(pack_operations)
 
1230
        return True
 
1231
 
 
1232
    def _execute_pack_operations(self, pack_operations, _packer_class=Packer):
 
1233
        """Execute a series of pack operations.
 
1234
 
 
1235
        :param pack_operations: A list of [revision_count, packs_to_combine].
 
1236
        :param _packer_class: The class of packer to use (default: Packer).
 
1237
        :return: None.
 
1238
        """
 
1239
        for revision_count, packs in pack_operations:
 
1240
            # we may have no-ops from the setup logic
 
1241
            if len(packs) == 0:
 
1242
                continue
 
1243
            _packer_class(self, packs, '.autopack').pack()
 
1244
            for pack in packs:
 
1245
                self._remove_pack_from_memory(pack)
 
1246
        # record the newly available packs and stop advertising the old
 
1247
        # packs
 
1248
        self._save_pack_names(clear_obsolete_packs=True)
 
1249
        # Move the old packs out of the way now they are no longer referenced.
 
1250
        for revision_count, packs in pack_operations:
 
1251
            self._obsolete_packs(packs)
 
1252
 
 
1253
    def lock_names(self):
 
1254
        """Acquire the mutex around the pack-names index.
 
1255
        
 
1256
        This cannot be used in the middle of a read-only transaction on the
 
1257
        repository.
 
1258
        """
 
1259
        self.repo.control_files.lock_write()
 
1260
 
 
1261
    def pack(self):
 
1262
        """Pack the pack collection totally."""
 
1263
        self.ensure_loaded()
 
1264
        total_packs = len(self._names)
 
1265
        if total_packs < 2:
 
1266
            # This is arguably wrong because we might not be optimal, but for
 
1267
            # now lets leave it in. (e.g. reconcile -> one pack. But not
 
1268
            # optimal.
 
1269
            return
 
1270
        total_revisions = self.revision_index.combined_index.key_count()
 
1271
        # XXX: the following may want to be a class, to pack with a given
 
1272
        # policy.
 
1273
        mutter('Packing repository %s, which has %d pack files, '
 
1274
            'containing %d revisions into 1 packs.', self, total_packs,
 
1275
            total_revisions)
 
1276
        # determine which packs need changing
 
1277
        pack_distribution = [1]
 
1278
        pack_operations = [[0, []]]
 
1279
        for pack in self.all_packs():
 
1280
            pack_operations[-1][0] += pack.get_revision_count()
 
1281
            pack_operations[-1][1].append(pack)
 
1282
        self._execute_pack_operations(pack_operations, OptimisingPacker)
 
1283
 
 
1284
    def plan_autopack_combinations(self, existing_packs, pack_distribution):
 
1285
        """Plan a pack operation.
 
1286
 
 
1287
        :param existing_packs: The packs to pack. (A list of (revcount, Pack)
 
1288
            tuples).
 
1289
        :param pack_distribution: A list with the number of revisions desired
 
1290
            in each pack.
 
1291
        """
 
1292
        if len(existing_packs) <= len(pack_distribution):
 
1293
            return []
 
1294
        existing_packs.sort(reverse=True)
 
1295
        pack_operations = [[0, []]]
 
1296
        # plan out what packs to keep, and what to reorganise
 
1297
        while len(existing_packs):
 
1298
            # take the largest pack, and if its less than the head of the
 
1299
            # distribution chart we will include its contents in the new pack
 
1300
            # for that position. If its larger, we remove its size from the
 
1301
            # distribution chart
 
1302
            next_pack_rev_count, next_pack = existing_packs.pop(0)
 
1303
            if next_pack_rev_count >= pack_distribution[0]:
 
1304
                # this is already packed 'better' than this, so we can
 
1305
                # not waste time packing it.
 
1306
                while next_pack_rev_count > 0:
 
1307
                    next_pack_rev_count -= pack_distribution[0]
 
1308
                    if next_pack_rev_count >= 0:
 
1309
                        # more to go
 
1310
                        del pack_distribution[0]
 
1311
                    else:
 
1312
                        # didn't use that entire bucket up
 
1313
                        pack_distribution[0] = -next_pack_rev_count
 
1314
            else:
 
1315
                # add the revisions we're going to add to the next output pack
 
1316
                pack_operations[-1][0] += next_pack_rev_count
 
1317
                # allocate this pack to the next pack sub operation
 
1318
                pack_operations[-1][1].append(next_pack)
 
1319
                if pack_operations[-1][0] >= pack_distribution[0]:
 
1320
                    # this pack is used up, shift left.
 
1321
                    del pack_distribution[0]
 
1322
                    pack_operations.append([0, []])
 
1323
        # Now that we know which pack files we want to move, shove them all
 
1324
        # into a single pack file.
 
1325
        final_rev_count = 0
 
1326
        final_pack_list = []
 
1327
        for num_revs, pack_files in pack_operations:
 
1328
            final_rev_count += num_revs
 
1329
            final_pack_list.extend(pack_files)
 
1330
        if len(final_pack_list) == 1:
 
1331
            raise AssertionError('We somehow generated an autopack with a'
 
1332
                ' single pack file being moved.')
 
1333
            return []
 
1334
        return [[final_rev_count, final_pack_list]]
 
1335
 
 
1336
    def ensure_loaded(self):
 
1337
        # NB: if you see an assertion error here, its probably access against
 
1338
        # an unlocked repo. Naughty.
 
1339
        if not self.repo.is_locked():
 
1340
            raise errors.ObjectNotLocked(self.repo)
 
1341
        if self._names is None:
 
1342
            self._names = {}
 
1343
            self._packs_at_load = set()
 
1344
            for index, key, value in self._iter_disk_pack_index():
 
1345
                name = key[0]
 
1346
                self._names[name] = self._parse_index_sizes(value)
 
1347
                self._packs_at_load.add((key, value))
 
1348
        # populate all the metadata.
 
1349
        self.all_packs()
 
1350
 
 
1351
    def _parse_index_sizes(self, value):
 
1352
        """Parse a string of index sizes."""
 
1353
        return tuple([int(digits) for digits in value.split(' ')])
 
1354
 
 
1355
    def get_pack_by_name(self, name):
 
1356
        """Get a Pack object by name.
 
1357
 
 
1358
        :param name: The name of the pack - e.g. '123456'
 
1359
        :return: A Pack object.
 
1360
        """
 
1361
        try:
 
1362
            return self._packs_by_name[name]
 
1363
        except KeyError:
 
1364
            rev_index = self._make_index(name, '.rix')
 
1365
            inv_index = self._make_index(name, '.iix')
 
1366
            txt_index = self._make_index(name, '.tix')
 
1367
            sig_index = self._make_index(name, '.six')
 
1368
            result = ExistingPack(self._pack_transport, name, rev_index,
 
1369
                inv_index, txt_index, sig_index)
 
1370
            self.add_pack_to_memory(result)
 
1371
            return result
 
1372
 
 
1373
    def allocate(self, a_new_pack):
 
1374
        """Allocate name in the list of packs.
 
1375
 
 
1376
        :param a_new_pack: A NewPack instance to be added to the collection of
 
1377
            packs for this repository.
 
1378
        """
 
1379
        self.ensure_loaded()
 
1380
        if a_new_pack.name in self._names:
 
1381
            raise errors.BzrError(
 
1382
                'Pack %r already exists in %s' % (a_new_pack.name, self))
 
1383
        self._names[a_new_pack.name] = tuple(a_new_pack.index_sizes)
 
1384
        self.add_pack_to_memory(a_new_pack)
 
1385
 
 
1386
    def _iter_disk_pack_index(self):
 
1387
        """Iterate over the contents of the pack-names index.
 
1388
        
 
1389
        This is used when loading the list from disk, and before writing to
 
1390
        detect updates from others during our write operation.
 
1391
        :return: An iterator of the index contents.
 
1392
        """
 
1393
        return self._index_class(self.transport, 'pack-names', None
 
1394
                ).iter_all_entries()
 
1395
 
 
1396
    def _make_index(self, name, suffix):
 
1397
        size_offset = self._suffix_offsets[suffix]
 
1398
        index_name = name + suffix
 
1399
        index_size = self._names[name][size_offset]
 
1400
        return self._index_class(
 
1401
            self._index_transport, index_name, index_size)
 
1402
 
 
1403
    def _max_pack_count(self, total_revisions):
 
1404
        """Return the maximum number of packs to use for total revisions.
 
1405
        
 
1406
        :param total_revisions: The total number of revisions in the
 
1407
            repository.
 
1408
        """
 
1409
        if not total_revisions:
 
1410
            return 1
 
1411
        digits = str(total_revisions)
 
1412
        result = 0
 
1413
        for digit in digits:
 
1414
            result += int(digit)
 
1415
        return result
 
1416
 
 
1417
    def names(self):
 
1418
        """Provide an order to the underlying names."""
 
1419
        return sorted(self._names.keys())
 
1420
 
 
1421
    def _obsolete_packs(self, packs):
 
1422
        """Move a number of packs which have been obsoleted out of the way.
 
1423
 
 
1424
        Each pack and its associated indices are moved out of the way.
 
1425
 
 
1426
        Note: for correctness this function should only be called after a new
 
1427
        pack names index has been written without these pack names, and with
 
1428
        the names of packs that contain the data previously available via these
 
1429
        packs.
 
1430
 
 
1431
        :param packs: The packs to obsolete.
 
1432
        :param return: None.
 
1433
        """
 
1434
        for pack in packs:
 
1435
            pack.pack_transport.rename(pack.file_name(),
 
1436
                '../obsolete_packs/' + pack.file_name())
 
1437
            # TODO: Probably needs to know all possible indices for this pack
 
1438
            # - or maybe list the directory and move all indices matching this
 
1439
            # name whether we recognize it or not?
 
1440
            for suffix in ('.iix', '.six', '.tix', '.rix'):
 
1441
                self._index_transport.rename(pack.name + suffix,
 
1442
                    '../obsolete_packs/' + pack.name + suffix)
 
1443
 
 
1444
    def pack_distribution(self, total_revisions):
 
1445
        """Generate a list of the number of revisions to put in each pack.
 
1446
 
 
1447
        :param total_revisions: The total number of revisions in the
 
1448
            repository.
 
1449
        """
 
1450
        if total_revisions == 0:
 
1451
            return [0]
 
1452
        digits = reversed(str(total_revisions))
 
1453
        result = []
 
1454
        for exponent, count in enumerate(digits):
 
1455
            size = 10 ** exponent
 
1456
            for pos in range(int(count)):
 
1457
                result.append(size)
 
1458
        return list(reversed(result))
 
1459
 
 
1460
    def _pack_tuple(self, name):
 
1461
        """Return a tuple with the transport and file name for a pack name."""
 
1462
        return self._pack_transport, name + '.pack'
 
1463
 
 
1464
    def _remove_pack_from_memory(self, pack):
 
1465
        """Remove pack from the packs accessed by this repository.
 
1466
        
 
1467
        Only affects memory state, until self._save_pack_names() is invoked.
 
1468
        """
 
1469
        self._names.pop(pack.name)
 
1470
        self._packs_by_name.pop(pack.name)
 
1471
        self._remove_pack_indices(pack)
 
1472
 
 
1473
    def _remove_pack_indices(self, pack):
 
1474
        """Remove the indices for pack from the aggregated indices."""
 
1475
        self.revision_index.remove_index(pack.revision_index, pack)
 
1476
        self.inventory_index.remove_index(pack.inventory_index, pack)
 
1477
        self.text_index.remove_index(pack.text_index, pack)
 
1478
        self.signature_index.remove_index(pack.signature_index, pack)
 
1479
 
 
1480
    def reset(self):
 
1481
        """Clear all cached data."""
 
1482
        # cached revision data
 
1483
        self.repo._revision_knit = None
 
1484
        self.revision_index.clear()
 
1485
        # cached signature data
 
1486
        self.repo._signature_knit = None
 
1487
        self.signature_index.clear()
 
1488
        # cached file text data
 
1489
        self.text_index.clear()
 
1490
        self.repo._text_knit = None
 
1491
        # cached inventory data
 
1492
        self.inventory_index.clear()
 
1493
        # remove the open pack
 
1494
        self._new_pack = None
 
1495
        # information about packs.
 
1496
        self._names = None
 
1497
        self.packs = []
 
1498
        self._packs_by_name = {}
 
1499
        self._packs_at_load = None
 
1500
 
 
1501
    def _make_index_map(self, index_suffix):
 
1502
        """Return information on existing indices.
 
1503
 
 
1504
        :param suffix: Index suffix added to pack name.
 
1505
 
 
1506
        :returns: (pack_map, indices) where indices is a list of GraphIndex 
 
1507
        objects, and pack_map is a mapping from those objects to the 
 
1508
        pack tuple they describe.
 
1509
        """
 
1510
        # TODO: stop using this; it creates new indices unnecessarily.
 
1511
        self.ensure_loaded()
 
1512
        suffix_map = {'.rix': 'revision_index',
 
1513
            '.six': 'signature_index',
 
1514
            '.iix': 'inventory_index',
 
1515
            '.tix': 'text_index',
 
1516
        }
 
1517
        return self._packs_list_to_pack_map_and_index_list(self.all_packs(),
 
1518
            suffix_map[index_suffix])
 
1519
 
 
1520
    def _packs_list_to_pack_map_and_index_list(self, packs, index_attribute):
 
1521
        """Convert a list of packs to an index pack map and index list.
 
1522
 
 
1523
        :param packs: The packs list to process.
 
1524
        :param index_attribute: The attribute that the desired index is found
 
1525
            on.
 
1526
        :return: A tuple (map, list) where map contains the dict from
 
1527
            index:pack_tuple, and lsit contains the indices in the same order
 
1528
            as the packs list.
 
1529
        """
 
1530
        indices = []
 
1531
        pack_map = {}
 
1532
        for pack in packs:
 
1533
            index = getattr(pack, index_attribute)
 
1534
            indices.append(index)
 
1535
            pack_map[index] = (pack.pack_transport, pack.file_name())
 
1536
        return pack_map, indices
 
1537
 
 
1538
    def _index_contents(self, pack_map, key_filter=None):
 
1539
        """Get an iterable of the index contents from a pack_map.
 
1540
 
 
1541
        :param pack_map: A map from indices to pack details.
 
1542
        :param key_filter: An optional filter to limit the
 
1543
            keys returned.
 
1544
        """
 
1545
        indices = [index for index in pack_map.iterkeys()]
 
1546
        all_index = CombinedGraphIndex(indices)
 
1547
        if key_filter is None:
 
1548
            return all_index.iter_all_entries()
 
1549
        else:
 
1550
            return all_index.iter_entries(key_filter)
 
1551
 
 
1552
    def _unlock_names(self):
 
1553
        """Release the mutex around the pack-names index."""
 
1554
        self.repo.control_files.unlock()
 
1555
 
 
1556
    def _save_pack_names(self, clear_obsolete_packs=False):
 
1557
        """Save the list of packs.
 
1558
 
 
1559
        This will take out the mutex around the pack names list for the
 
1560
        duration of the method call. If concurrent updates have been made, a
 
1561
        three-way merge between the current list and the current in memory list
 
1562
        is performed.
 
1563
 
 
1564
        :param clear_obsolete_packs: If True, clear out the contents of the
 
1565
            obsolete_packs directory.
 
1566
        """
 
1567
        self.lock_names()
 
1568
        try:
 
1569
            builder = self._index_builder_class()
 
1570
            # load the disk nodes across
 
1571
            disk_nodes = set()
 
1572
            for index, key, value in self._iter_disk_pack_index():
 
1573
                disk_nodes.add((key, value))
 
1574
            # do a two-way diff against our original content
 
1575
            current_nodes = set()
 
1576
            for name, sizes in self._names.iteritems():
 
1577
                current_nodes.add(
 
1578
                    ((name, ), ' '.join(str(size) for size in sizes)))
 
1579
            deleted_nodes = self._packs_at_load - current_nodes
 
1580
            new_nodes = current_nodes - self._packs_at_load
 
1581
            disk_nodes.difference_update(deleted_nodes)
 
1582
            disk_nodes.update(new_nodes)
 
1583
            # TODO: handle same-name, index-size-changes here - 
 
1584
            # e.g. use the value from disk, not ours, *unless* we're the one
 
1585
            # changing it.
 
1586
            for key, value in disk_nodes:
 
1587
                builder.add_node(key, value)
 
1588
            self.transport.put_file('pack-names', builder.finish(),
 
1589
                mode=self.repo.bzrdir._get_file_mode())
 
1590
            # move the baseline forward
 
1591
            self._packs_at_load = disk_nodes
 
1592
            if clear_obsolete_packs:
 
1593
                self._clear_obsolete_packs()
 
1594
        finally:
 
1595
            self._unlock_names()
 
1596
        # synchronise the memory packs list with what we just wrote:
 
1597
        new_names = dict(disk_nodes)
 
1598
        # drop no longer present nodes
 
1599
        for pack in self.all_packs():
 
1600
            if (pack.name,) not in new_names:
 
1601
                self._remove_pack_from_memory(pack)
 
1602
        # add new nodes/refresh existing ones
 
1603
        for key, value in disk_nodes:
 
1604
            name = key[0]
 
1605
            sizes = self._parse_index_sizes(value)
 
1606
            if name in self._names:
 
1607
                # existing
 
1608
                if sizes != self._names[name]:
 
1609
                    # the pack for name has had its indices replaced - rare but
 
1610
                    # important to handle. XXX: probably can never happen today
 
1611
                    # because the three-way merge code above does not handle it
 
1612
                    # - you may end up adding the same key twice to the new
 
1613
                    # disk index because the set values are the same, unless
 
1614
                    # the only index shows up as deleted by the set difference
 
1615
                    # - which it may. Until there is a specific test for this,
 
1616
                    # assume its broken. RBC 20071017.
 
1617
                    self._remove_pack_from_memory(self.get_pack_by_name(name))
 
1618
                    self._names[name] = sizes
 
1619
                    self.get_pack_by_name(name)
 
1620
            else:
 
1621
                # new
 
1622
                self._names[name] = sizes
 
1623
                self.get_pack_by_name(name)
 
1624
 
 
1625
    def _clear_obsolete_packs(self):
 
1626
        """Delete everything from the obsolete-packs directory.
 
1627
        """
 
1628
        obsolete_pack_transport = self.transport.clone('obsolete_packs')
 
1629
        for filename in obsolete_pack_transport.list_dir('.'):
 
1630
            try:
 
1631
                obsolete_pack_transport.delete(filename)
 
1632
            except (errors.PathError, errors.TransportError), e:
 
1633
                warning("couldn't delete obsolete pack, skipping it:\n%s" % (e,))
 
1634
 
 
1635
    def _start_write_group(self):
 
1636
        # Do not permit preparation for writing if we're not in a 'write lock'.
 
1637
        if not self.repo.is_write_locked():
 
1638
            raise errors.NotWriteLocked(self)
 
1639
        self._new_pack = NewPack(self._upload_transport, self._index_transport,
 
1640
            self._pack_transport, upload_suffix='.pack',
 
1641
            file_mode=self.repo.bzrdir._get_file_mode(),
 
1642
            index_builder_class=self._index_builder_class,
 
1643
            index_class=self._index_class)
 
1644
        # allow writing: queue writes to a new index
 
1645
        self.revision_index.add_writable_index(self._new_pack.revision_index,
 
1646
            self._new_pack)
 
1647
        self.inventory_index.add_writable_index(self._new_pack.inventory_index,
 
1648
            self._new_pack)
 
1649
        self.text_index.add_writable_index(self._new_pack.text_index,
 
1650
            self._new_pack)
 
1651
        self.signature_index.add_writable_index(self._new_pack.signature_index,
 
1652
            self._new_pack)
 
1653
 
 
1654
        self.repo.inventories._index._add_callback = self.inventory_index.add_callback
 
1655
        self.repo.revisions._index._add_callback = self.revision_index.add_callback
 
1656
        self.repo.signatures._index._add_callback = self.signature_index.add_callback
 
1657
        self.repo.texts._index._add_callback = self.text_index.add_callback
 
1658
 
 
1659
    def _abort_write_group(self):
 
1660
        # FIXME: just drop the transient index.
 
1661
        # forget what names there are
 
1662
        if self._new_pack is not None:
 
1663
            self._new_pack.abort()
 
1664
            self._remove_pack_indices(self._new_pack)
 
1665
            self._new_pack = None
 
1666
        self.repo._text_knit = None
 
1667
 
 
1668
    def _commit_write_group(self):
 
1669
        self._remove_pack_indices(self._new_pack)
 
1670
        if self._new_pack.data_inserted():
 
1671
            # get all the data to disk and read to use
 
1672
            self._new_pack.finish()
 
1673
            self.allocate(self._new_pack)
 
1674
            self._new_pack = None
 
1675
            if not self.autopack():
 
1676
                # when autopack takes no steps, the names list is still
 
1677
                # unsaved.
 
1678
                self._save_pack_names()
 
1679
        else:
 
1680
            self._new_pack.abort()
 
1681
            self._new_pack = None
 
1682
        self.repo._text_knit = None
 
1683
 
 
1684
 
 
1685
class KnitPackRepository(KnitRepository):
 
1686
    """Repository with knit objects stored inside pack containers.
 
1687
    
 
1688
    The layering for a KnitPackRepository is:
 
1689
 
 
1690
    Graph        |  HPSS    | Repository public layer |
 
1691
    ===================================================
 
1692
    Tuple based apis below, string based, and key based apis above
 
1693
    ---------------------------------------------------
 
1694
    KnitVersionedFiles
 
1695
      Provides .texts, .revisions etc
 
1696
      This adapts the N-tuple keys to physical knit records which only have a
 
1697
      single string identifier (for historical reasons), which in older formats
 
1698
      was always the revision_id, and in the mapped code for packs is always
 
1699
      the last element of key tuples.
 
1700
    ---------------------------------------------------
 
1701
    GraphIndex
 
1702
      A separate GraphIndex is used for each of the
 
1703
      texts/inventories/revisions/signatures contained within each individual
 
1704
      pack file. The GraphIndex layer works in N-tuples and is unaware of any
 
1705
      semantic value.
 
1706
    ===================================================
 
1707
    
 
1708
    """
 
1709
 
 
1710
    def __init__(self, _format, a_bzrdir, control_files, _commit_builder_class,
 
1711
        _serializer):
 
1712
        KnitRepository.__init__(self, _format, a_bzrdir, control_files,
 
1713
            _commit_builder_class, _serializer)
 
1714
        index_transport = self._transport.clone('indices')
 
1715
        self._pack_collection = RepositoryPackCollection(self, self._transport,
 
1716
            index_transport,
 
1717
            self._transport.clone('upload'),
 
1718
            self._transport.clone('packs'),
 
1719
            _format.index_builder_class,
 
1720
            _format.index_class)
 
1721
        self.inventories = KnitVersionedFiles(
 
1722
            _KnitGraphIndex(self._pack_collection.inventory_index.combined_index,
 
1723
                add_callback=self._pack_collection.inventory_index.add_callback,
 
1724
                deltas=True, parents=True, is_locked=self.is_locked),
 
1725
            data_access=self._pack_collection.inventory_index.data_access,
 
1726
            max_delta_chain=200)
 
1727
        self.revisions = KnitVersionedFiles(
 
1728
            _KnitGraphIndex(self._pack_collection.revision_index.combined_index,
 
1729
                add_callback=self._pack_collection.revision_index.add_callback,
 
1730
                deltas=False, parents=True, is_locked=self.is_locked),
 
1731
            data_access=self._pack_collection.revision_index.data_access,
 
1732
            max_delta_chain=0)
 
1733
        self.signatures = KnitVersionedFiles(
 
1734
            _KnitGraphIndex(self._pack_collection.signature_index.combined_index,
 
1735
                add_callback=self._pack_collection.signature_index.add_callback,
 
1736
                deltas=False, parents=False, is_locked=self.is_locked),
 
1737
            data_access=self._pack_collection.signature_index.data_access,
 
1738
            max_delta_chain=0)
 
1739
        self.texts = KnitVersionedFiles(
 
1740
            _KnitGraphIndex(self._pack_collection.text_index.combined_index,
 
1741
                add_callback=self._pack_collection.text_index.add_callback,
 
1742
                deltas=True, parents=True, is_locked=self.is_locked),
 
1743
            data_access=self._pack_collection.text_index.data_access,
 
1744
            max_delta_chain=200)
 
1745
        # True when the repository object is 'write locked' (as opposed to the
 
1746
        # physical lock only taken out around changes to the pack-names list.) 
 
1747
        # Another way to represent this would be a decorator around the control
 
1748
        # files object that presents logical locks as physical ones - if this
 
1749
        # gets ugly consider that alternative design. RBC 20071011
 
1750
        self._write_lock_count = 0
 
1751
        self._transaction = None
 
1752
        # for tests
 
1753
        self._reconcile_does_inventory_gc = True
 
1754
        self._reconcile_fixes_text_parents = True
 
1755
        self._reconcile_backsup_inventory = False
 
1756
        self._fetch_order = 'unordered'
 
1757
 
 
1758
    def _warn_if_deprecated(self):
 
1759
        # This class isn't deprecated, but one sub-format is
 
1760
        if isinstance(self._format, RepositoryFormatKnitPack5RichRootBroken):
 
1761
            from bzrlib import repository
 
1762
            if repository._deprecation_warning_done:
 
1763
                return
 
1764
            repository._deprecation_warning_done = True
 
1765
            warning("Format %s for %s is deprecated - please use"
 
1766
                    " 'bzr upgrade --1.6.1-rich-root'"
 
1767
                    % (self._format, self.bzrdir.transport.base))
 
1768
 
 
1769
    def _abort_write_group(self):
 
1770
        self._pack_collection._abort_write_group()
 
1771
 
 
1772
    def _find_inconsistent_revision_parents(self):
 
1773
        """Find revisions with incorrectly cached parents.
 
1774
 
 
1775
        :returns: an iterator yielding tuples of (revison-id, parents-in-index,
 
1776
            parents-in-revision).
 
1777
        """
 
1778
        if not self.is_locked():
 
1779
            raise errors.ObjectNotLocked(self)
 
1780
        pb = ui.ui_factory.nested_progress_bar()
 
1781
        result = []
 
1782
        try:
 
1783
            revision_nodes = self._pack_collection.revision_index \
 
1784
                .combined_index.iter_all_entries()
 
1785
            index_positions = []
 
1786
            # Get the cached index values for all revisions, and also the location
 
1787
            # in each index of the revision text so we can perform linear IO.
 
1788
            for index, key, value, refs in revision_nodes:
 
1789
                pos, length = value[1:].split(' ')
 
1790
                index_positions.append((index, int(pos), key[0],
 
1791
                    tuple(parent[0] for parent in refs[0])))
 
1792
                pb.update("Reading revision index.", 0, 0)
 
1793
            index_positions.sort()
 
1794
            batch_count = len(index_positions) / 1000 + 1
 
1795
            pb.update("Checking cached revision graph.", 0, batch_count)
 
1796
            for offset in xrange(batch_count):
 
1797
                pb.update("Checking cached revision graph.", offset)
 
1798
                to_query = index_positions[offset * 1000:(offset + 1) * 1000]
 
1799
                if not to_query:
 
1800
                    break
 
1801
                rev_ids = [item[2] for item in to_query]
 
1802
                revs = self.get_revisions(rev_ids)
 
1803
                for revision, item in zip(revs, to_query):
 
1804
                    index_parents = item[3]
 
1805
                    rev_parents = tuple(revision.parent_ids)
 
1806
                    if index_parents != rev_parents:
 
1807
                        result.append((revision.revision_id, index_parents, rev_parents))
 
1808
        finally:
 
1809
            pb.finished()
 
1810
        return result
 
1811
 
 
1812
    @symbol_versioning.deprecated_method(symbol_versioning.one_one)
 
1813
    def get_parents(self, revision_ids):
 
1814
        """See graph._StackedParentsProvider.get_parents."""
 
1815
        parent_map = self.get_parent_map(revision_ids)
 
1816
        return [parent_map.get(r, None) for r in revision_ids]
 
1817
 
 
1818
    def _make_parents_provider(self):
 
1819
        return graph.CachingParentsProvider(self)
 
1820
 
 
1821
    def _refresh_data(self):
 
1822
        if self._write_lock_count == 1 or (
 
1823
            self.control_files._lock_count == 1 and
 
1824
            self.control_files._lock_mode == 'r'):
 
1825
            # forget what names there are
 
1826
            self._pack_collection.reset()
 
1827
            # XXX: Better to do an in-memory merge when acquiring a new lock -
 
1828
            # factor out code from _save_pack_names.
 
1829
            self._pack_collection.ensure_loaded()
 
1830
 
 
1831
    def _start_write_group(self):
 
1832
        self._pack_collection._start_write_group()
 
1833
 
 
1834
    def _commit_write_group(self):
 
1835
        return self._pack_collection._commit_write_group()
 
1836
 
 
1837
    def get_transaction(self):
 
1838
        if self._write_lock_count:
 
1839
            return self._transaction
 
1840
        else:
 
1841
            return self.control_files.get_transaction()
 
1842
 
 
1843
    def is_locked(self):
 
1844
        return self._write_lock_count or self.control_files.is_locked()
 
1845
 
 
1846
    def is_write_locked(self):
 
1847
        return self._write_lock_count
 
1848
 
 
1849
    def lock_write(self, token=None):
 
1850
        if not self._write_lock_count and self.is_locked():
 
1851
            raise errors.ReadOnlyError(self)
 
1852
        self._write_lock_count += 1
 
1853
        if self._write_lock_count == 1:
 
1854
            self._transaction = transactions.WriteTransaction()
 
1855
            for repo in self._fallback_repositories:
 
1856
                # Writes don't affect fallback repos
 
1857
                repo.lock_read()
 
1858
        self._refresh_data()
 
1859
 
 
1860
    def lock_read(self):
 
1861
        if self._write_lock_count:
 
1862
            self._write_lock_count += 1
 
1863
        else:
 
1864
            self.control_files.lock_read()
 
1865
            for repo in self._fallback_repositories:
 
1866
                # Writes don't affect fallback repos
 
1867
                repo.lock_read()
 
1868
        self._refresh_data()
 
1869
 
 
1870
    def leave_lock_in_place(self):
 
1871
        # not supported - raise an error
 
1872
        raise NotImplementedError(self.leave_lock_in_place)
 
1873
 
 
1874
    def dont_leave_lock_in_place(self):
 
1875
        # not supported - raise an error
 
1876
        raise NotImplementedError(self.dont_leave_lock_in_place)
 
1877
 
 
1878
    @needs_write_lock
 
1879
    def pack(self):
 
1880
        """Compress the data within the repository.
 
1881
 
 
1882
        This will pack all the data to a single pack. In future it may
 
1883
        recompress deltas or do other such expensive operations.
 
1884
        """
 
1885
        self._pack_collection.pack()
 
1886
 
 
1887
    @needs_write_lock
 
1888
    def reconcile(self, other=None, thorough=False):
 
1889
        """Reconcile this repository."""
 
1890
        from bzrlib.reconcile import PackReconciler
 
1891
        reconciler = PackReconciler(self, thorough=thorough)
 
1892
        reconciler.reconcile()
 
1893
        return reconciler
 
1894
 
 
1895
    def unlock(self):
 
1896
        if self._write_lock_count == 1 and self._write_group is not None:
 
1897
            self.abort_write_group()
 
1898
            self._transaction = None
 
1899
            self._write_lock_count = 0
 
1900
            raise errors.BzrError(
 
1901
                'Must end write group before releasing write lock on %s'
 
1902
                % self)
 
1903
        if self._write_lock_count:
 
1904
            self._write_lock_count -= 1
 
1905
            if not self._write_lock_count:
 
1906
                transaction = self._transaction
 
1907
                self._transaction = None
 
1908
                transaction.finish()
 
1909
                for repo in self._fallback_repositories:
 
1910
                    repo.unlock()
 
1911
        else:
 
1912
            self.control_files.unlock()
 
1913
            for repo in self._fallback_repositories:
 
1914
                repo.unlock()
 
1915
 
 
1916
 
 
1917
class RepositoryFormatPack(MetaDirRepositoryFormat):
 
1918
    """Format logic for pack structured repositories.
 
1919
 
 
1920
    This repository format has:
 
1921
     - a list of packs in pack-names
 
1922
     - packs in packs/NAME.pack
 
1923
     - indices in indices/NAME.{iix,six,tix,rix}
 
1924
     - knit deltas in the packs, knit indices mapped to the indices.
 
1925
     - thunk objects to support the knits programming API.
 
1926
     - a format marker of its own
 
1927
     - an optional 'shared-storage' flag
 
1928
     - an optional 'no-working-trees' flag
 
1929
     - a LockDir lock
 
1930
    """
 
1931
 
 
1932
    # Set this attribute in derived classes to control the repository class
 
1933
    # created by open and initialize.
 
1934
    repository_class = None
 
1935
    # Set this attribute in derived classes to control the
 
1936
    # _commit_builder_class that the repository objects will have passed to
 
1937
    # their constructor.
 
1938
    _commit_builder_class = None
 
1939
    # Set this attribute in derived clases to control the _serializer that the
 
1940
    # repository objects will have passed to their constructor.
 
1941
    _serializer = None
 
1942
    # External references are not supported in pack repositories yet.
 
1943
    supports_external_lookups = False
 
1944
    # What index classes to use
 
1945
    index_builder_class = None
 
1946
    index_class = None
 
1947
 
 
1948
    def initialize(self, a_bzrdir, shared=False):
 
1949
        """Create a pack based repository.
 
1950
 
 
1951
        :param a_bzrdir: bzrdir to contain the new repository; must already
 
1952
            be initialized.
 
1953
        :param shared: If true the repository will be initialized as a shared
 
1954
                       repository.
 
1955
        """
 
1956
        mutter('creating repository in %s.', a_bzrdir.transport.base)
 
1957
        dirs = ['indices', 'obsolete_packs', 'packs', 'upload']
 
1958
        builder = self.index_builder_class()
 
1959
        files = [('pack-names', builder.finish())]
 
1960
        utf8_files = [('format', self.get_format_string())]
 
1961
        
 
1962
        self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
 
1963
        return self.open(a_bzrdir=a_bzrdir, _found=True)
 
1964
 
 
1965
    def open(self, a_bzrdir, _found=False, _override_transport=None):
 
1966
        """See RepositoryFormat.open().
 
1967
        
 
1968
        :param _override_transport: INTERNAL USE ONLY. Allows opening the
 
1969
                                    repository at a slightly different url
 
1970
                                    than normal. I.e. during 'upgrade'.
 
1971
        """
 
1972
        if not _found:
 
1973
            format = RepositoryFormat.find_format(a_bzrdir)
 
1974
        if _override_transport is not None:
 
1975
            repo_transport = _override_transport
 
1976
        else:
 
1977
            repo_transport = a_bzrdir.get_repository_transport(None)
 
1978
        control_files = lockable_files.LockableFiles(repo_transport,
 
1979
                                'lock', lockdir.LockDir)
 
1980
        return self.repository_class(_format=self,
 
1981
                              a_bzrdir=a_bzrdir,
 
1982
                              control_files=control_files,
 
1983
                              _commit_builder_class=self._commit_builder_class,
 
1984
                              _serializer=self._serializer)
 
1985
 
 
1986
 
 
1987
class RepositoryFormatKnitPack1(RepositoryFormatPack):
 
1988
    """A no-subtrees parameterized Pack repository.
 
1989
 
 
1990
    This format was introduced in 0.92.
 
1991
    """
 
1992
 
 
1993
    repository_class = KnitPackRepository
 
1994
    _commit_builder_class = PackCommitBuilder
 
1995
    @property
 
1996
    def _serializer(self):
 
1997
        return xml5.serializer_v5
 
1998
    # What index classes to use
 
1999
    index_builder_class = InMemoryGraphIndex
 
2000
    index_class = GraphIndex
 
2001
 
 
2002
    def _get_matching_bzrdir(self):
 
2003
        return bzrdir.format_registry.make_bzrdir('pack-0.92')
 
2004
 
 
2005
    def _ignore_setting_bzrdir(self, format):
 
2006
        pass
 
2007
 
 
2008
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
 
2009
 
 
2010
    def get_format_string(self):
 
2011
        """See RepositoryFormat.get_format_string()."""
 
2012
        return "Bazaar pack repository format 1 (needs bzr 0.92)\n"
 
2013
 
 
2014
    def get_format_description(self):
 
2015
        """See RepositoryFormat.get_format_description()."""
 
2016
        return "Packs containing knits without subtree support"
 
2017
 
 
2018
    def check_conversion_target(self, target_format):
 
2019
        pass
 
2020
 
 
2021
 
 
2022
class RepositoryFormatKnitPack3(RepositoryFormatPack):
 
2023
    """A subtrees parameterized Pack repository.
 
2024
 
 
2025
    This repository format uses the xml7 serializer to get:
 
2026
     - support for recording full info about the tree root
 
2027
     - support for recording tree-references
 
2028
 
 
2029
    This format was introduced in 0.92.
 
2030
    """
 
2031
 
 
2032
    repository_class = KnitPackRepository
 
2033
    _commit_builder_class = PackRootCommitBuilder
 
2034
    rich_root_data = True
 
2035
    supports_tree_reference = True
 
2036
    @property
 
2037
    def _serializer(self):
 
2038
        return xml7.serializer_v7
 
2039
    # What index classes to use
 
2040
    index_builder_class = InMemoryGraphIndex
 
2041
    index_class = GraphIndex
 
2042
 
 
2043
    def _get_matching_bzrdir(self):
 
2044
        return bzrdir.format_registry.make_bzrdir(
 
2045
            'pack-0.92-subtree')
 
2046
 
 
2047
    def _ignore_setting_bzrdir(self, format):
 
2048
        pass
 
2049
 
 
2050
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
 
2051
 
 
2052
    def check_conversion_target(self, target_format):
 
2053
        if not target_format.rich_root_data:
 
2054
            raise errors.BadConversionTarget(
 
2055
                'Does not support rich root data.', target_format)
 
2056
        if not getattr(target_format, 'supports_tree_reference', False):
 
2057
            raise errors.BadConversionTarget(
 
2058
                'Does not support nested trees', target_format)
 
2059
            
 
2060
    def get_format_string(self):
 
2061
        """See RepositoryFormat.get_format_string()."""
 
2062
        return "Bazaar pack repository format 1 with subtree support (needs bzr 0.92)\n"
 
2063
 
 
2064
    def get_format_description(self):
 
2065
        """See RepositoryFormat.get_format_description()."""
 
2066
        return "Packs containing knits with subtree support\n"
 
2067
 
 
2068
 
 
2069
class RepositoryFormatKnitPack4(RepositoryFormatPack):
 
2070
    """A rich-root, no subtrees parameterized Pack repository.
 
2071
 
 
2072
    This repository format uses the xml6 serializer to get:
 
2073
     - support for recording full info about the tree root
 
2074
 
 
2075
    This format was introduced in 1.0.
 
2076
    """
 
2077
 
 
2078
    repository_class = KnitPackRepository
 
2079
    _commit_builder_class = PackRootCommitBuilder
 
2080
    rich_root_data = True
 
2081
    supports_tree_reference = False
 
2082
    @property
 
2083
    def _serializer(self):
 
2084
        return xml6.serializer_v6
 
2085
    # What index classes to use
 
2086
    index_builder_class = InMemoryGraphIndex
 
2087
    index_class = GraphIndex
 
2088
 
 
2089
    def _get_matching_bzrdir(self):
 
2090
        return bzrdir.format_registry.make_bzrdir(
 
2091
            'rich-root-pack')
 
2092
 
 
2093
    def _ignore_setting_bzrdir(self, format):
 
2094
        pass
 
2095
 
 
2096
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
 
2097
 
 
2098
    def check_conversion_target(self, target_format):
 
2099
        if not target_format.rich_root_data:
 
2100
            raise errors.BadConversionTarget(
 
2101
                'Does not support rich root data.', target_format)
 
2102
 
 
2103
    def get_format_string(self):
 
2104
        """See RepositoryFormat.get_format_string()."""
 
2105
        return ("Bazaar pack repository format 1 with rich root"
 
2106
                " (needs bzr 1.0)\n")
 
2107
 
 
2108
    def get_format_description(self):
 
2109
        """See RepositoryFormat.get_format_description()."""
 
2110
        return "Packs containing knits with rich root support\n"
 
2111
 
 
2112
 
 
2113
class RepositoryFormatKnitPack5(RepositoryFormatPack):
 
2114
    """Repository that supports external references to allow stacking.
 
2115
 
 
2116
    New in release 1.6.
 
2117
 
 
2118
    Supports external lookups, which results in non-truncated ghosts after
 
2119
    reconcile compared to pack-0.92 formats.
 
2120
    """
 
2121
 
 
2122
    repository_class = KnitPackRepository
 
2123
    _commit_builder_class = PackCommitBuilder
 
2124
    supports_external_lookups = True
 
2125
    # What index classes to use
 
2126
    index_builder_class = InMemoryGraphIndex
 
2127
    index_class = GraphIndex
 
2128
 
 
2129
    @property
 
2130
    def _serializer(self):
 
2131
        return xml5.serializer_v5
 
2132
 
 
2133
    def _get_matching_bzrdir(self):
 
2134
        return bzrdir.format_registry.make_bzrdir('1.6')
 
2135
 
 
2136
    def _ignore_setting_bzrdir(self, format):
 
2137
        pass
 
2138
 
 
2139
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
 
2140
 
 
2141
    def get_format_string(self):
 
2142
        """See RepositoryFormat.get_format_string()."""
 
2143
        return "Bazaar RepositoryFormatKnitPack5 (bzr 1.6)\n"
 
2144
 
 
2145
    def get_format_description(self):
 
2146
        """See RepositoryFormat.get_format_description()."""
 
2147
        return "Packs 5 (adds stacking support, requires bzr 1.6)"
 
2148
 
 
2149
    def check_conversion_target(self, target_format):
 
2150
        pass
 
2151
 
 
2152
 
 
2153
class RepositoryFormatKnitPack5RichRoot(RepositoryFormatPack):
 
2154
    """A repository with rich roots and stacking.
 
2155
 
 
2156
    New in release 1.6.1.
 
2157
 
 
2158
    Supports stacking on other repositories, allowing data to be accessed
 
2159
    without being stored locally.
 
2160
    """
 
2161
 
 
2162
    repository_class = KnitPackRepository
 
2163
    _commit_builder_class = PackRootCommitBuilder
 
2164
    rich_root_data = True
 
2165
    supports_tree_reference = False # no subtrees
 
2166
    supports_external_lookups = True
 
2167
    # What index classes to use
 
2168
    index_builder_class = InMemoryGraphIndex
 
2169
    index_class = GraphIndex
 
2170
 
 
2171
    @property
 
2172
    def _serializer(self):
 
2173
        return xml6.serializer_v6
 
2174
 
 
2175
    def _get_matching_bzrdir(self):
 
2176
        return bzrdir.format_registry.make_bzrdir(
 
2177
            '1.6.1-rich-root')
 
2178
 
 
2179
    def _ignore_setting_bzrdir(self, format):
 
2180
        pass
 
2181
 
 
2182
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
 
2183
 
 
2184
    def check_conversion_target(self, target_format):
 
2185
        if not target_format.rich_root_data:
 
2186
            raise errors.BadConversionTarget(
 
2187
                'Does not support rich root data.', target_format)
 
2188
 
 
2189
    def get_format_string(self):
 
2190
        """See RepositoryFormat.get_format_string()."""
 
2191
        return "Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6.1)\n"
 
2192
 
 
2193
    def get_format_description(self):
 
2194
        return "Packs 5 rich-root (adds stacking support, requires bzr 1.6.1)"
 
2195
 
 
2196
 
 
2197
class RepositoryFormatKnitPack5RichRootBroken(RepositoryFormatPack):
 
2198
    """A repository with rich roots and external references.
 
2199
 
 
2200
    New in release 1.6.
 
2201
 
 
2202
    Supports external lookups, which results in non-truncated ghosts after
 
2203
    reconcile compared to pack-0.92 formats.
 
2204
 
 
2205
    This format was deprecated because the serializer it uses accidentally
 
2206
    supported subtrees, when the format was not intended to. This meant that
 
2207
    someone could accidentally fetch from an incorrect repository.
 
2208
    """
 
2209
 
 
2210
    repository_class = KnitPackRepository
 
2211
    _commit_builder_class = PackRootCommitBuilder
 
2212
    rich_root_data = True
 
2213
    supports_tree_reference = False # no subtrees
 
2214
 
 
2215
    supports_external_lookups = True
 
2216
    # What index classes to use
 
2217
    index_builder_class = InMemoryGraphIndex
 
2218
    index_class = GraphIndex
 
2219
 
 
2220
    @property
 
2221
    def _serializer(self):
 
2222
        return xml7.serializer_v7
 
2223
 
 
2224
    def _get_matching_bzrdir(self):
 
2225
        return bzrdir.format_registry.make_bzrdir(
 
2226
            '1.6.1-rich-root')
 
2227
 
 
2228
    def _ignore_setting_bzrdir(self, format):
 
2229
        pass
 
2230
 
 
2231
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
 
2232
 
 
2233
    def check_conversion_target(self, target_format):
 
2234
        if not target_format.rich_root_data:
 
2235
            raise errors.BadConversionTarget(
 
2236
                'Does not support rich root data.', target_format)
 
2237
 
 
2238
    def get_format_string(self):
 
2239
        """See RepositoryFormat.get_format_string()."""
 
2240
        return "Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6)\n"
 
2241
 
 
2242
    def get_format_description(self):
 
2243
        return ("Packs 5 rich-root (adds stacking support, requires bzr 1.6)"
 
2244
                " (deprecated)")
 
2245
 
 
2246
 
 
2247
class RepositoryFormatPackDevelopment2(RepositoryFormatPack):
 
2248
    """A no-subtrees development repository.
 
2249
 
 
2250
    This format should be retained until the second release after bzr 1.7.
 
2251
 
 
2252
    This is pack-1.6.1 with B+Tree indices.
 
2253
    """
 
2254
 
 
2255
    repository_class = KnitPackRepository
 
2256
    _commit_builder_class = PackCommitBuilder
 
2257
    supports_external_lookups = True
 
2258
    # What index classes to use
 
2259
    index_builder_class = BTreeBuilder
 
2260
    index_class = BTreeGraphIndex
 
2261
 
 
2262
    @property
 
2263
    def _serializer(self):
 
2264
        return xml5.serializer_v5
 
2265
 
 
2266
    def _get_matching_bzrdir(self):
 
2267
        return bzrdir.format_registry.make_bzrdir('development2')
 
2268
 
 
2269
    def _ignore_setting_bzrdir(self, format):
 
2270
        pass
 
2271
 
 
2272
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
 
2273
 
 
2274
    def get_format_string(self):
 
2275
        """See RepositoryFormat.get_format_string()."""
 
2276
        return "Bazaar development format 2 (needs bzr.dev from before 1.8)\n"
 
2277
 
 
2278
    def get_format_description(self):
 
2279
        """See RepositoryFormat.get_format_description()."""
 
2280
        return ("Development repository format, currently the same as "
 
2281
            "1.6.1 with B+Trees.\n")
 
2282
 
 
2283
    def check_conversion_target(self, target_format):
 
2284
        pass
 
2285
 
 
2286
 
 
2287
class RepositoryFormatPackDevelopment2Subtree(RepositoryFormatPack):
 
2288
    """A subtrees development repository.
 
2289
 
 
2290
    This format should be retained until the second release after bzr 1.7.
 
2291
 
 
2292
    1.6.1-subtree[as it might have been] with B+Tree indices.
 
2293
    """
 
2294
 
 
2295
    repository_class = KnitPackRepository
 
2296
    _commit_builder_class = PackRootCommitBuilder
 
2297
    rich_root_data = True
 
2298
    supports_tree_reference = True
 
2299
    supports_external_lookups = True
 
2300
    # What index classes to use
 
2301
    index_builder_class = BTreeBuilder
 
2302
    index_class = BTreeGraphIndex
 
2303
 
 
2304
    @property
 
2305
    def _serializer(self):
 
2306
        return xml7.serializer_v7
 
2307
 
 
2308
    def _get_matching_bzrdir(self):
 
2309
        return bzrdir.format_registry.make_bzrdir(
 
2310
            'development2-subtree')
 
2311
 
 
2312
    def _ignore_setting_bzrdir(self, format):
 
2313
        pass
 
2314
 
 
2315
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
 
2316
 
 
2317
    def check_conversion_target(self, target_format):
 
2318
        if not target_format.rich_root_data:
 
2319
            raise errors.BadConversionTarget(
 
2320
                'Does not support rich root data.', target_format)
 
2321
        if not getattr(target_format, 'supports_tree_reference', False):
 
2322
            raise errors.BadConversionTarget(
 
2323
                'Does not support nested trees', target_format)
 
2324
            
 
2325
    def get_format_string(self):
 
2326
        """See RepositoryFormat.get_format_string()."""
 
2327
        return ("Bazaar development format 2 with subtree support "
 
2328
            "(needs bzr.dev from before 1.8)\n")
 
2329
 
 
2330
    def get_format_description(self):
 
2331
        """See RepositoryFormat.get_format_description()."""
 
2332
        return ("Development repository format, currently the same as "
 
2333
            "1.6.1-subtree with B+Tree indices.\n")