1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
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.
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.
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
17
from bzrlib.lazy_import import lazy_import
18
lazy_import(globals(), """
22
from bzrlib.store import revision
23
from bzrlib.store.revision.knit import KnitRevisionStore
40
from bzrlib.decorators import needs_read_lock, needs_write_lock
41
from bzrlib.repository import (
44
MetaDirRepositoryFormat,
48
import bzrlib.revision as _mod_revision
49
from bzrlib.store.versioned import VersionedFileStore
50
from bzrlib.trace import mutter, mutter_callsite
51
from bzrlib.util import bencode
54
class _KnitParentsProvider(object):
56
def __init__(self, knit):
60
return 'KnitParentsProvider(%r)' % self._knit
62
@symbol_versioning.deprecated_method(symbol_versioning.one_one)
63
def get_parents(self, revision_ids):
64
"""See graph._StackedParentsProvider.get_parents"""
65
parent_map = self.get_parent_map(revision_ids)
66
return [parent_map.get(r, None) for r in revision_ids]
68
def get_parent_map(self, keys):
69
"""See graph._StackedParentsProvider.get_parent_map"""
71
for revision_id in keys:
72
if revision_id == _mod_revision.NULL_REVISION:
73
parent_map[revision_id] = ()
77
self._knit.get_parents_with_ghosts(revision_id))
78
except errors.RevisionNotPresent:
82
parents = (_mod_revision.NULL_REVISION,)
83
parent_map[revision_id] = parents
87
class KnitRepository(MetaDirRepository):
88
"""Knit format repository."""
90
# These attributes are inherited from the Repository base class. Setting
91
# them to None ensures that if the constructor is changed to not initialize
92
# them, or a subclass fails to call the constructor, that an error will
93
# occur rather than the system working but generating incorrect data.
94
_commit_builder_class = None
97
def __init__(self, _format, a_bzrdir, control_files, _revision_store,
98
control_store, text_store, _commit_builder_class, _serializer):
99
MetaDirRepository.__init__(self, _format, a_bzrdir, control_files,
100
_revision_store, control_store, text_store)
101
self._commit_builder_class = _commit_builder_class
102
self._serializer = _serializer
103
self._reconcile_fixes_text_parents = True
105
def _warn_if_deprecated(self):
106
# This class isn't deprecated
109
def _inventory_add_lines(self, inv_vf, revid, parents, lines, check_content):
110
return inv_vf.add_lines_with_ghosts(revid, parents, lines,
111
check_content=check_content)[0]
114
def _all_revision_ids(self):
115
"""See Repository.all_revision_ids()."""
116
# Knits get the revision graph from the index of the revision knit, so
117
# it's always possible even if they're on an unlistable transport.
118
return self._revision_store.all_revision_ids(self.get_transaction())
120
def fileid_involved_between_revs(self, from_revid, to_revid):
121
"""Find file_id(s) which are involved in the changes between revisions.
123
This determines the set of revisions which are involved, and then
124
finds all file ids affected by those revisions.
126
vf = self._get_revision_vf()
127
from_set = set(vf.get_ancestry(from_revid))
128
to_set = set(vf.get_ancestry(to_revid))
129
changed = to_set.difference(from_set)
130
return self._fileid_involved_by_set(changed)
132
def fileid_involved(self, last_revid=None):
133
"""Find all file_ids modified in the ancestry of last_revid.
135
:param last_revid: If None, last_revision() will be used.
138
changed = set(self.all_revision_ids())
140
changed = set(self.get_ancestry(last_revid))
143
return self._fileid_involved_by_set(changed)
146
def get_ancestry(self, revision_id, topo_sorted=True):
147
"""Return a list of revision-ids integrated by a revision.
149
This is topologically sorted, unless 'topo_sorted' is specified as
152
if _mod_revision.is_null(revision_id):
154
vf = self._get_revision_vf()
156
return [None] + vf.get_ancestry(revision_id, topo_sorted)
157
except errors.RevisionNotPresent:
158
raise errors.NoSuchRevision(self, revision_id)
161
def get_data_stream(self, revision_ids):
162
"""See Repository.get_data_stream."""
163
item_keys = self.item_keys_introduced_by(revision_ids)
164
for knit_kind, file_id, versions in item_keys:
166
if knit_kind == 'file':
167
name = ('file', file_id)
168
knit = self.weave_store.get_weave_or_empty(
169
file_id, self.get_transaction())
170
elif knit_kind == 'inventory':
171
knit = self.get_inventory_weave()
172
elif knit_kind == 'revisions':
173
knit = self._revision_store.get_revision_file(
174
self.get_transaction())
175
elif knit_kind == 'signatures':
176
knit = self._revision_store.get_signature_file(
177
self.get_transaction())
179
raise AssertionError('Unknown knit kind %r' % (knit_kind,))
180
yield name, _get_stream_as_bytes(knit, versions)
183
def get_revision(self, revision_id):
184
"""Return the Revision object for a named revision"""
185
revision_id = osutils.safe_revision_id(revision_id)
186
return self.get_revision_reconcile(revision_id)
189
def get_revision_graph(self, revision_id=None):
190
"""Return a dictionary containing the revision graph.
192
:param revision_id: The revision_id to get a graph from. If None, then
193
the entire revision graph is returned. This is a deprecated mode of
194
operation and will be removed in the future.
195
:return: a dictionary of revision_id->revision_parents_list.
197
if 'evil' in debug.debug_flags:
199
"get_revision_graph scales with size of history.")
200
# special case NULL_REVISION
201
if revision_id == _mod_revision.NULL_REVISION:
203
a_weave = self._get_revision_vf()
204
if revision_id is None:
205
return a_weave.get_graph()
206
if revision_id not in a_weave:
207
raise errors.NoSuchRevision(self, revision_id)
209
# add what can be reached from revision_id
210
return a_weave.get_graph([revision_id])
213
def get_revision_graph_with_ghosts(self, revision_ids=None):
214
"""Return a graph of the revisions with ghosts marked as applicable.
216
:param revision_ids: an iterable of revisions to graph or None for all.
217
:return: a Graph object with the graph reachable from revision_ids.
219
if 'evil' in debug.debug_flags:
221
"get_revision_graph_with_ghosts scales with size of history.")
222
result = deprecated_graph.Graph()
223
vf = self._get_revision_vf()
224
versions = set(vf.versions())
226
pending = set(self.all_revision_ids())
229
pending = set(revision_ids)
230
# special case NULL_REVISION
231
if _mod_revision.NULL_REVISION in pending:
232
pending.remove(_mod_revision.NULL_REVISION)
233
required = set(pending)
236
revision_id = pending.pop()
237
if not revision_id in versions:
238
if revision_id in required:
239
raise errors.NoSuchRevision(self, revision_id)
241
result.add_ghost(revision_id)
242
# mark it as done so we don't try for it again.
243
done.add(revision_id)
245
parent_ids = vf.get_parents_with_ghosts(revision_id)
246
for parent_id in parent_ids:
247
# is this queued or done ?
248
if (parent_id not in pending and
249
parent_id not in done):
251
pending.add(parent_id)
252
result.add_node(revision_id, parent_ids)
253
done.add(revision_id)
256
def _get_revision_vf(self):
257
""":return: a versioned file containing the revisions."""
258
vf = self._revision_store.get_revision_file(self.get_transaction())
261
def _get_history_vf(self):
262
"""Get a versionedfile whose history graph reflects all revisions.
264
For knit repositories, this is the revision knit.
266
return self._get_revision_vf()
269
def reconcile(self, other=None, thorough=False):
270
"""Reconcile this repository."""
271
from bzrlib.reconcile import KnitReconciler
272
reconciler = KnitReconciler(self, thorough=thorough)
273
reconciler.reconcile()
276
def revision_parents(self, revision_id):
277
return self._get_revision_vf().get_parents(revision_id)
279
def _make_parents_provider(self):
280
return _KnitParentsProvider(self._get_revision_vf())
282
def _find_inconsistent_revision_parents(self):
283
"""Find revisions with different parent lists in the revision object
284
and in the index graph.
286
:returns: an iterator yielding tuples of (revison-id, parents-in-index,
287
parents-in-revision).
289
assert self.is_locked()
290
vf = self._get_revision_vf()
291
for index_version in vf.versions():
292
parents_according_to_index = tuple(vf.get_parents_with_ghosts(
294
revision = self.get_revision(index_version)
295
parents_according_to_revision = tuple(revision.parent_ids)
296
if parents_according_to_index != parents_according_to_revision:
297
yield (index_version, parents_according_to_index,
298
parents_according_to_revision)
300
def _check_for_inconsistent_revision_parents(self):
301
inconsistencies = list(self._find_inconsistent_revision_parents())
303
raise errors.BzrCheckError(
304
"Revision knit has inconsistent parents.")
306
def revision_graph_can_have_wrong_parents(self):
307
# The revision.kndx could potentially claim a revision has a different
308
# parent to the revision text.
312
class RepositoryFormatKnit(MetaDirRepositoryFormat):
313
"""Bzr repository knit format (generalized).
315
This repository format has:
316
- knits for file texts and inventory
317
- hash subdirectory based stores.
318
- knits for revisions and signatures
319
- TextStores for revisions and signatures.
320
- a format marker of its own
321
- an optional 'shared-storage' flag
322
- an optional 'no-working-trees' flag
326
# Set this attribute in derived classes to control the repository class
327
# created by open and initialize.
328
repository_class = None
329
# Set this attribute in derived classes to control the
330
# _commit_builder_class that the repository objects will have passed to
332
_commit_builder_class = None
333
# Set this attribute in derived clases to control the _serializer that the
334
# repository objects will have passed to their constructor.
335
_serializer = xml5.serializer_v5
336
# Knit based repositories handle ghosts reasonably well.
337
supports_ghosts = True
339
def _get_control_store(self, repo_transport, control_files):
340
"""Return the control store for this repository."""
341
return VersionedFileStore(
344
file_mode=control_files._file_mode,
345
versionedfile_class=knit.KnitVersionedFile,
346
versionedfile_kwargs={'factory':knit.KnitPlainFactory()},
349
def _get_revision_store(self, repo_transport, control_files):
350
"""See RepositoryFormat._get_revision_store()."""
351
versioned_file_store = VersionedFileStore(
353
file_mode=control_files._file_mode,
356
versionedfile_class=knit.KnitVersionedFile,
357
versionedfile_kwargs={'delta':False,
358
'factory':knit.KnitPlainFactory(),
362
return KnitRevisionStore(versioned_file_store)
364
def _get_text_store(self, transport, control_files):
365
"""See RepositoryFormat._get_text_store()."""
366
return self._get_versioned_file_store('knits',
369
versionedfile_class=knit.KnitVersionedFile,
370
versionedfile_kwargs={
371
'create_parent_dir':True,
373
'dir_mode':control_files._dir_mode,
377
def initialize(self, a_bzrdir, shared=False):
378
"""Create a knit format 1 repository.
380
:param a_bzrdir: bzrdir to contain the new repository; must already
382
:param shared: If true the repository will be initialized as a shared
385
mutter('creating repository in %s.', a_bzrdir.transport.base)
388
utf8_files = [('format', self.get_format_string())]
390
self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
391
repo_transport = a_bzrdir.get_repository_transport(None)
392
control_files = lockable_files.LockableFiles(repo_transport,
393
'lock', lockdir.LockDir)
394
control_store = self._get_control_store(repo_transport, control_files)
395
transaction = transactions.WriteTransaction()
396
# trigger a write of the inventory store.
397
control_store.get_weave_or_empty('inventory', transaction)
398
_revision_store = self._get_revision_store(repo_transport, control_files)
399
# the revision id here is irrelevant: it will not be stored, and cannot
401
_revision_store.has_revision_id('A', transaction)
402
_revision_store.get_signature_file(transaction)
403
return self.open(a_bzrdir=a_bzrdir, _found=True)
405
def open(self, a_bzrdir, _found=False, _override_transport=None):
406
"""See RepositoryFormat.open().
408
:param _override_transport: INTERNAL USE ONLY. Allows opening the
409
repository at a slightly different url
410
than normal. I.e. during 'upgrade'.
413
format = RepositoryFormat.find_format(a_bzrdir)
414
assert format.__class__ == self.__class__
415
if _override_transport is not None:
416
repo_transport = _override_transport
418
repo_transport = a_bzrdir.get_repository_transport(None)
419
control_files = lockable_files.LockableFiles(repo_transport,
420
'lock', lockdir.LockDir)
421
text_store = self._get_text_store(repo_transport, control_files)
422
control_store = self._get_control_store(repo_transport, control_files)
423
_revision_store = self._get_revision_store(repo_transport, control_files)
424
return self.repository_class(_format=self,
426
control_files=control_files,
427
_revision_store=_revision_store,
428
control_store=control_store,
429
text_store=text_store,
430
_commit_builder_class=self._commit_builder_class,
431
_serializer=self._serializer)
434
class RepositoryFormatKnit1(RepositoryFormatKnit):
435
"""Bzr repository knit format 1.
437
This repository format has:
438
- knits for file texts and inventory
439
- hash subdirectory based stores.
440
- knits for revisions and signatures
441
- TextStores for revisions and signatures.
442
- a format marker of its own
443
- an optional 'shared-storage' flag
444
- an optional 'no-working-trees' flag
447
This format was introduced in bzr 0.8.
450
repository_class = KnitRepository
451
_commit_builder_class = CommitBuilder
452
_serializer = xml5.serializer_v5
454
def __ne__(self, other):
455
return self.__class__ is not other.__class__
457
def get_format_string(self):
458
"""See RepositoryFormat.get_format_string()."""
459
return "Bazaar-NG Knit Repository Format 1"
461
def get_format_description(self):
462
"""See RepositoryFormat.get_format_description()."""
463
return "Knit repository format 1"
465
def check_conversion_target(self, target_format):
469
class RepositoryFormatKnit3(RepositoryFormatKnit):
470
"""Bzr repository knit format 3.
472
This repository format has:
473
- knits for file texts and inventory
474
- hash subdirectory based stores.
475
- knits for revisions and signatures
476
- TextStores for revisions and signatures.
477
- a format marker of its own
478
- an optional 'shared-storage' flag
479
- an optional 'no-working-trees' flag
481
- support for recording full info about the tree root
482
- support for recording tree-references
485
repository_class = KnitRepository
486
_commit_builder_class = RootCommitBuilder
487
rich_root_data = True
488
supports_tree_reference = True
489
_serializer = xml7.serializer_v7
491
def _get_matching_bzrdir(self):
492
return bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
494
def _ignore_setting_bzrdir(self, format):
497
_matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
499
def check_conversion_target(self, target_format):
500
if not target_format.rich_root_data:
501
raise errors.BadConversionTarget(
502
'Does not support rich root data.', target_format)
503
if not getattr(target_format, 'supports_tree_reference', False):
504
raise errors.BadConversionTarget(
505
'Does not support nested trees', target_format)
507
def get_format_string(self):
508
"""See RepositoryFormat.get_format_string()."""
509
return "Bazaar Knit Repository Format 3 (bzr 0.15)\n"
511
def get_format_description(self):
512
"""See RepositoryFormat.get_format_description()."""
513
return "Knit repository format 3"
516
class RepositoryFormatKnit4(RepositoryFormatKnit):
517
"""Bzr repository knit format 4.
519
This repository format has everything in format 3, except for
521
- knits for file texts and inventory
522
- hash subdirectory based stores.
523
- knits for revisions and signatures
524
- TextStores for revisions and signatures.
525
- a format marker of its own
526
- an optional 'shared-storage' flag
527
- an optional 'no-working-trees' flag
529
- support for recording full info about the tree root
532
repository_class = KnitRepository
533
_commit_builder_class = RootCommitBuilder
534
rich_root_data = True
535
supports_tree_reference = False
536
_serializer = xml6.serializer_v6
538
def _get_matching_bzrdir(self):
539
return bzrdir.format_registry.make_bzrdir('rich-root')
541
def _ignore_setting_bzrdir(self, format):
544
_matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
546
def check_conversion_target(self, target_format):
547
if not target_format.rich_root_data:
548
raise errors.BadConversionTarget(
549
'Does not support rich root data.', target_format)
551
def get_format_string(self):
552
"""See RepositoryFormat.get_format_string()."""
553
return 'Bazaar Knit Repository Format 4 (bzr 1.0)\n'
555
def get_format_description(self):
556
"""See RepositoryFormat.get_format_description()."""
557
return "Knit repository format 4"
560
def _get_stream_as_bytes(knit, required_versions):
561
"""Generate a serialised data stream.
563
The format is a bencoding of a list. The first element of the list is a
564
string of the format signature, then each subsequent element is a list
565
corresponding to a record. Those lists contain:
572
:returns: a bencoded list.
574
knit_stream = knit.get_data_stream(required_versions)
575
format_signature, data_list, callable = knit_stream
577
data.append(format_signature)
578
for version, options, length, parents in data_list:
579
data.append([version, options, parents, callable(length)])
580
return bencode.bencode(data)
added
removed
bzrlib/repofmt/knitrepo.py
