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)
160
@symbol_versioning.deprecated_method(symbol_versioning.one_two)
162
def get_data_stream(self, revision_ids):
163
"""See Repository.get_data_stream.
165
Deprecated in 1.2 for get_data_stream_for_search.
167
search_result = self.revision_ids_to_search_result(set(revision_ids))
168
return self.get_data_stream_for_search(search_result)
171
def get_data_stream_for_search(self, search):
172
"""See Repository.get_data_stream_for_search."""
173
item_keys = self.item_keys_introduced_by(search.get_keys())
174
for knit_kind, file_id, versions in item_keys:
176
if knit_kind == 'file':
177
name = ('file', file_id)
178
knit = self.weave_store.get_weave_or_empty(
179
file_id, self.get_transaction())
180
elif knit_kind == 'inventory':
181
knit = self.get_inventory_weave()
182
elif knit_kind == 'revisions':
183
knit = self._revision_store.get_revision_file(
184
self.get_transaction())
185
elif knit_kind == 'signatures':
186
knit = self._revision_store.get_signature_file(
187
self.get_transaction())
189
raise AssertionError('Unknown knit kind %r' % (knit_kind,))
190
yield name, _get_stream_as_bytes(knit, versions)
193
def get_revision(self, revision_id):
194
"""Return the Revision object for a named revision"""
195
revision_id = osutils.safe_revision_id(revision_id)
196
return self.get_revision_reconcile(revision_id)
199
def get_revision_graph(self, revision_id=None):
200
"""Return a dictionary containing the revision graph.
202
:param revision_id: The revision_id to get a graph from. If None, then
203
the entire revision graph is returned. This is a deprecated mode of
204
operation and will be removed in the future.
205
:return: a dictionary of revision_id->revision_parents_list.
207
if 'evil' in debug.debug_flags:
209
"get_revision_graph scales with size of history.")
210
# special case NULL_REVISION
211
if revision_id == _mod_revision.NULL_REVISION:
213
a_weave = self._get_revision_vf()
214
if revision_id is None:
215
return a_weave.get_graph()
216
if revision_id not in a_weave:
217
raise errors.NoSuchRevision(self, revision_id)
219
# add what can be reached from revision_id
220
return a_weave.get_graph([revision_id])
223
@symbol_versioning.deprecated_method(symbol_versioning.one_three)
224
def get_revision_graph_with_ghosts(self, revision_ids=None):
225
"""Return a graph of the revisions with ghosts marked as applicable.
227
:param revision_ids: an iterable of revisions to graph or None for all.
228
:return: a Graph object with the graph reachable from revision_ids.
230
if 'evil' in debug.debug_flags:
232
"get_revision_graph_with_ghosts scales with size of history.")
233
result = deprecated_graph.Graph()
234
vf = self._get_revision_vf()
235
versions = set(vf.versions())
237
pending = set(self.all_revision_ids())
240
pending = set(revision_ids)
241
# special case NULL_REVISION
242
if _mod_revision.NULL_REVISION in pending:
243
pending.remove(_mod_revision.NULL_REVISION)
244
required = set(pending)
247
revision_id = pending.pop()
248
if not revision_id in versions:
249
if revision_id in required:
250
raise errors.NoSuchRevision(self, revision_id)
252
result.add_ghost(revision_id)
253
# mark it as done so we don't try for it again.
254
done.add(revision_id)
256
parent_ids = vf.get_parents_with_ghosts(revision_id)
257
for parent_id in parent_ids:
258
# is this queued or done ?
259
if (parent_id not in pending and
260
parent_id not in done):
262
pending.add(parent_id)
263
result.add_node(revision_id, parent_ids)
264
done.add(revision_id)
267
def _get_revision_vf(self):
268
""":return: a versioned file containing the revisions."""
269
vf = self._revision_store.get_revision_file(self.get_transaction())
272
def has_revisions(self, revision_ids):
273
"""See Repository.has_revisions()."""
275
transaction = self.get_transaction()
276
for revision_id in revision_ids:
277
if self._revision_store.has_revision_id(revision_id, transaction):
278
result.add(revision_id)
282
def reconcile(self, other=None, thorough=False):
283
"""Reconcile this repository."""
284
from bzrlib.reconcile import KnitReconciler
285
reconciler = KnitReconciler(self, thorough=thorough)
286
reconciler.reconcile()
289
def revision_parents(self, revision_id):
290
return self._get_revision_vf().get_parents(revision_id)
292
def _make_parents_provider(self):
293
return _KnitParentsProvider(self._get_revision_vf())
295
def _find_inconsistent_revision_parents(self):
296
"""Find revisions with different parent lists in the revision object
297
and in the index graph.
299
:returns: an iterator yielding tuples of (revison-id, parents-in-index,
300
parents-in-revision).
302
assert self.is_locked()
303
vf = self._get_revision_vf()
304
for index_version in vf.versions():
305
parents_according_to_index = tuple(vf.get_parents_with_ghosts(
307
revision = self.get_revision(index_version)
308
parents_according_to_revision = tuple(revision.parent_ids)
309
if parents_according_to_index != parents_according_to_revision:
310
yield (index_version, parents_according_to_index,
311
parents_according_to_revision)
313
def _check_for_inconsistent_revision_parents(self):
314
inconsistencies = list(self._find_inconsistent_revision_parents())
316
raise errors.BzrCheckError(
317
"Revision knit has inconsistent parents.")
319
def revision_graph_can_have_wrong_parents(self):
320
# The revision.kndx could potentially claim a revision has a different
321
# parent to the revision text.
325
class RepositoryFormatKnit(MetaDirRepositoryFormat):
326
"""Bzr repository knit format (generalized).
328
This repository format has:
329
- knits for file texts and inventory
330
- hash subdirectory based stores.
331
- knits for revisions and signatures
332
- TextStores for revisions and signatures.
333
- a format marker of its own
334
- an optional 'shared-storage' flag
335
- an optional 'no-working-trees' flag
339
# Set this attribute in derived classes to control the repository class
340
# created by open and initialize.
341
repository_class = None
342
# Set this attribute in derived classes to control the
343
# _commit_builder_class that the repository objects will have passed to
345
_commit_builder_class = None
346
# Set this attribute in derived clases to control the _serializer that the
347
# repository objects will have passed to their constructor.
348
_serializer = xml5.serializer_v5
349
# Knit based repositories handle ghosts reasonably well.
350
supports_ghosts = True
351
# External lookups are not supported in this format.
352
supports_external_lookups = False
354
def _get_control_store(self, repo_transport, control_files):
355
"""Return the control store for this repository."""
356
return VersionedFileStore(
359
file_mode=control_files._file_mode,
360
versionedfile_class=knit.KnitVersionedFile,
361
versionedfile_kwargs={'factory':knit.KnitPlainFactory()},
364
def _get_revision_store(self, repo_transport, control_files):
365
"""See RepositoryFormat._get_revision_store()."""
366
versioned_file_store = VersionedFileStore(
368
file_mode=control_files._file_mode,
371
versionedfile_class=knit.KnitVersionedFile,
372
versionedfile_kwargs={'delta':False,
373
'factory':knit.KnitPlainFactory(),
377
return KnitRevisionStore(versioned_file_store)
379
def _get_text_store(self, transport, control_files):
380
"""See RepositoryFormat._get_text_store()."""
381
return self._get_versioned_file_store('knits',
384
versionedfile_class=knit.KnitVersionedFile,
385
versionedfile_kwargs={
386
'create_parent_dir':True,
388
'dir_mode':control_files._dir_mode,
392
def initialize(self, a_bzrdir, shared=False):
393
"""Create a knit format 1 repository.
395
:param a_bzrdir: bzrdir to contain the new repository; must already
397
:param shared: If true the repository will be initialized as a shared
400
mutter('creating repository in %s.', a_bzrdir.transport.base)
403
utf8_files = [('format', self.get_format_string())]
405
self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
406
repo_transport = a_bzrdir.get_repository_transport(None)
407
control_files = lockable_files.LockableFiles(repo_transport,
408
'lock', lockdir.LockDir)
409
control_store = self._get_control_store(repo_transport, control_files)
410
transaction = transactions.WriteTransaction()
411
# trigger a write of the inventory store.
412
control_store.get_weave_or_empty('inventory', transaction)
413
_revision_store = self._get_revision_store(repo_transport, control_files)
414
# the revision id here is irrelevant: it will not be stored, and cannot
416
_revision_store.has_revision_id('A', transaction)
417
_revision_store.get_signature_file(transaction)
418
return self.open(a_bzrdir=a_bzrdir, _found=True)
420
def open(self, a_bzrdir, _found=False, _override_transport=None):
421
"""See RepositoryFormat.open().
423
:param _override_transport: INTERNAL USE ONLY. Allows opening the
424
repository at a slightly different url
425
than normal. I.e. during 'upgrade'.
428
format = RepositoryFormat.find_format(a_bzrdir)
429
assert format.__class__ == self.__class__
430
if _override_transport is not None:
431
repo_transport = _override_transport
433
repo_transport = a_bzrdir.get_repository_transport(None)
434
control_files = lockable_files.LockableFiles(repo_transport,
435
'lock', lockdir.LockDir)
436
text_store = self._get_text_store(repo_transport, control_files)
437
control_store = self._get_control_store(repo_transport, control_files)
438
_revision_store = self._get_revision_store(repo_transport, control_files)
439
return self.repository_class(_format=self,
441
control_files=control_files,
442
_revision_store=_revision_store,
443
control_store=control_store,
444
text_store=text_store,
445
_commit_builder_class=self._commit_builder_class,
446
_serializer=self._serializer)
449
class RepositoryFormatKnit1(RepositoryFormatKnit):
450
"""Bzr repository knit format 1.
452
This repository format has:
453
- knits for file texts and inventory
454
- hash subdirectory based stores.
455
- knits for revisions and signatures
456
- TextStores for revisions and signatures.
457
- a format marker of its own
458
- an optional 'shared-storage' flag
459
- an optional 'no-working-trees' flag
462
This format was introduced in bzr 0.8.
465
repository_class = KnitRepository
466
_commit_builder_class = CommitBuilder
467
_serializer = xml5.serializer_v5
469
def __ne__(self, other):
470
return self.__class__ is not other.__class__
472
def get_format_string(self):
473
"""See RepositoryFormat.get_format_string()."""
474
return "Bazaar-NG Knit Repository Format 1"
476
def get_format_description(self):
477
"""See RepositoryFormat.get_format_description()."""
478
return "Knit repository format 1"
480
def check_conversion_target(self, target_format):
484
class RepositoryFormatKnit3(RepositoryFormatKnit):
485
"""Bzr repository knit format 3.
487
This repository format has:
488
- knits for file texts and inventory
489
- hash subdirectory based stores.
490
- knits for revisions and signatures
491
- TextStores for revisions and signatures.
492
- a format marker of its own
493
- an optional 'shared-storage' flag
494
- an optional 'no-working-trees' flag
496
- support for recording full info about the tree root
497
- support for recording tree-references
500
repository_class = KnitRepository
501
_commit_builder_class = RootCommitBuilder
502
rich_root_data = True
503
supports_tree_reference = True
504
_serializer = xml7.serializer_v7
506
def _get_matching_bzrdir(self):
507
return bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
509
def _ignore_setting_bzrdir(self, format):
512
_matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
514
def check_conversion_target(self, target_format):
515
if not target_format.rich_root_data:
516
raise errors.BadConversionTarget(
517
'Does not support rich root data.', target_format)
518
if not getattr(target_format, 'supports_tree_reference', False):
519
raise errors.BadConversionTarget(
520
'Does not support nested trees', target_format)
522
def get_format_string(self):
523
"""See RepositoryFormat.get_format_string()."""
524
return "Bazaar Knit Repository Format 3 (bzr 0.15)\n"
526
def get_format_description(self):
527
"""See RepositoryFormat.get_format_description()."""
528
return "Knit repository format 3"
531
class RepositoryFormatKnit4(RepositoryFormatKnit):
532
"""Bzr repository knit format 4.
534
This repository format has everything in format 3, except for
536
- knits for file texts and inventory
537
- hash subdirectory based stores.
538
- knits for revisions and signatures
539
- TextStores for revisions and signatures.
540
- a format marker of its own
541
- an optional 'shared-storage' flag
542
- an optional 'no-working-trees' flag
544
- support for recording full info about the tree root
547
repository_class = KnitRepository
548
_commit_builder_class = RootCommitBuilder
549
rich_root_data = True
550
supports_tree_reference = False
551
_serializer = xml6.serializer_v6
553
def _get_matching_bzrdir(self):
554
return bzrdir.format_registry.make_bzrdir('rich-root')
556
def _ignore_setting_bzrdir(self, format):
559
_matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
561
def check_conversion_target(self, target_format):
562
if not target_format.rich_root_data:
563
raise errors.BadConversionTarget(
564
'Does not support rich root data.', target_format)
566
def get_format_string(self):
567
"""See RepositoryFormat.get_format_string()."""
568
return 'Bazaar Knit Repository Format 4 (bzr 1.0)\n'
570
def get_format_description(self):
571
"""See RepositoryFormat.get_format_description()."""
572
return "Knit repository format 4"
575
def _get_stream_as_bytes(knit, required_versions):
576
"""Generate a serialised data stream.
578
The format is a bencoding of a list. The first element of the list is a
579
string of the format signature, then each subsequent element is a list
580
corresponding to a record. Those lists contain:
587
:returns: a bencoded list.
589
knit_stream = knit.get_data_stream(required_versions)
590
format_signature, data_list, callable = knit_stream
592
data.append(format_signature)
593
for version, options, length, parents in data_list:
594
data.append([version, options, parents, callable(length)])
595
return bencode.bencode(data)
added
removed
bzrlib/repofmt/knitrepo.py
