1
# Copyright (C) 2007-2010 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from __future__ import absolute_import
19
from bzrlib.lazy_import import lazy_import
20
lazy_import(globals(), """
30
revision as _mod_revision,
39
from bzrlib.decorators import needs_read_lock, needs_write_lock
40
from bzrlib.repository import (
43
RepositoryFormatMetaDir,
45
from bzrlib.vf_repository import (
46
InterSameDataRepository,
47
MetaDirVersionedFileRepository,
48
MetaDirVersionedFileRepositoryFormat,
49
VersionedFileCommitBuilder,
50
VersionedFileRootCommitBuilder,
52
from bzrlib import symbol_versioning
55
class _KnitParentsProvider(object):
57
def __init__(self, knit):
61
return 'KnitParentsProvider(%r)' % self._knit
63
def get_parent_map(self, keys):
64
"""See graph.StackedParentsProvider.get_parent_map"""
66
for revision_id in keys:
67
if revision_id is None:
68
raise ValueError('get_parent_map(None) is not valid')
69
if revision_id == _mod_revision.NULL_REVISION:
70
parent_map[revision_id] = ()
74
self._knit.get_parents_with_ghosts(revision_id))
75
except errors.RevisionNotPresent:
79
parents = (_mod_revision.NULL_REVISION,)
80
parent_map[revision_id] = parents
84
class _KnitsParentsProvider(object):
86
def __init__(self, knit, prefix=()):
87
"""Create a parent provider for string keys mapped to tuple keys."""
92
return 'KnitsParentsProvider(%r)' % self._knit
94
def get_parent_map(self, keys):
95
"""See graph.StackedParentsProvider.get_parent_map"""
96
parent_map = self._knit.get_parent_map(
97
[self._prefix + (key,) for key in keys])
99
for key, parents in parent_map.items():
101
if len(parents) == 0:
102
parents = (_mod_revision.NULL_REVISION,)
104
parents = tuple(parent[-1] for parent in parents)
105
result[revid] = parents
106
for revision_id in keys:
107
if revision_id == _mod_revision.NULL_REVISION:
108
result[revision_id] = ()
112
class KnitRepository(MetaDirVersionedFileRepository):
113
"""Knit format repository."""
115
# These attributes are inherited from the Repository base class. Setting
116
# them to None ensures that if the constructor is changed to not initialize
117
# them, or a subclass fails to call the constructor, that an error will
118
# occur rather than the system working but generating incorrect data.
119
_commit_builder_class = None
122
def __init__(self, _format, a_bzrdir, control_files, _commit_builder_class,
124
super(KnitRepository, self).__init__(_format, a_bzrdir, control_files)
125
self._commit_builder_class = _commit_builder_class
126
self._serializer = _serializer
127
self._reconcile_fixes_text_parents = True
130
def _all_revision_ids(self):
131
"""See Repository.all_revision_ids()."""
132
return [key[0] for key in self.revisions.keys()]
134
def _activate_new_inventory(self):
135
"""Put a replacement inventory.new into use as inventories."""
136
# Copy the content across
138
t.copy('inventory.new.kndx', 'inventory.kndx')
140
t.copy('inventory.new.knit', 'inventory.knit')
141
except errors.NoSuchFile:
142
# empty inventories knit
143
t.delete('inventory.knit')
144
# delete the temp inventory
145
t.delete('inventory.new.kndx')
147
t.delete('inventory.new.knit')
148
except errors.NoSuchFile:
149
# empty inventories knit
151
# Force index reload (sanity check)
152
self.inventories._index._reset_cache()
153
self.inventories.keys()
155
def _backup_inventory(self):
157
t.copy('inventory.kndx', 'inventory.backup.kndx')
158
t.copy('inventory.knit', 'inventory.backup.knit')
160
def _move_file_id(self, from_id, to_id):
161
t = self._transport.clone('knits')
162
from_rel_url = self.texts._index._mapper.map((from_id, None))
163
to_rel_url = self.texts._index._mapper.map((to_id, None))
164
# We expect both files to always exist in this case.
165
for suffix in ('.knit', '.kndx'):
166
t.rename(from_rel_url + suffix, to_rel_url + suffix)
168
def _remove_file_id(self, file_id):
169
t = self._transport.clone('knits')
170
rel_url = self.texts._index._mapper.map((file_id, None))
171
for suffix in ('.kndx', '.knit'):
173
t.delete(rel_url + suffix)
174
except errors.NoSuchFile:
177
def _temp_inventories(self):
178
result = self._format._get_inventories(self._transport, self,
180
# Reconciling when the output has no revisions would result in no
181
# writes - but we want to ensure there is an inventory for
182
# compatibility with older clients that don't lazy-load.
183
result.get_parent_map([('A',)])
187
def get_revision(self, revision_id):
188
"""Return the Revision object for a named revision"""
189
revision_id = osutils.safe_revision_id(revision_id)
190
return self.get_revision_reconcile(revision_id)
192
def _refresh_data(self):
193
if not self.is_locked():
195
if self.is_in_write_group():
196
raise IsInWriteGroupError(self)
197
# Create a new transaction to force all knits to see the scope change.
198
# This is safe because we're outside a write group.
199
self.control_files._finish_transaction()
200
if self.is_write_locked():
201
self.control_files._set_write_transaction()
203
self.control_files._set_read_transaction()
206
def reconcile(self, other=None, thorough=False):
207
"""Reconcile this repository."""
208
from bzrlib.reconcile import KnitReconciler
209
reconciler = KnitReconciler(self, thorough=thorough)
210
reconciler.reconcile()
213
def _make_parents_provider(self):
214
return _KnitsParentsProvider(self.revisions)
217
class RepositoryFormatKnit(MetaDirVersionedFileRepositoryFormat):
218
"""Bzr repository knit format (generalized).
220
This repository format has:
221
- knits for file texts and inventory
222
- hash subdirectory based stores.
223
- knits for revisions and signatures
224
- TextStores for revisions and signatures.
225
- a format marker of its own
226
- an optional 'shared-storage' flag
227
- an optional 'no-working-trees' flag
231
# Set this attribute in derived classes to control the repository class
232
# created by open and initialize.
233
repository_class = None
234
# Set this attribute in derived classes to control the
235
# _commit_builder_class that the repository objects will have passed to
237
_commit_builder_class = None
238
# Set this attribute in derived clases to control the _serializer that the
239
# repository objects will have passed to their constructor.
241
def _serializer(self):
242
return xml5.serializer_v5
243
# Knit based repositories handle ghosts reasonably well.
244
supports_ghosts = True
245
# External lookups are not supported in this format.
246
supports_external_lookups = False
248
supports_chks = False
249
_fetch_order = 'topological'
250
_fetch_uses_deltas = True
252
supports_funky_characters = True
253
# The revision.kndx could potentially claim a revision has a different
254
# parent to the revision text.
255
revision_graph_can_have_wrong_parents = True
257
def _get_inventories(self, repo_transport, repo, name='inventory'):
258
mapper = versionedfile.ConstantMapper(name)
259
index = _mod_knit._KndxIndex(repo_transport, mapper,
260
repo.get_transaction, repo.is_write_locked, repo.is_locked)
261
access = _mod_knit._KnitKeyAccess(repo_transport, mapper)
262
return _mod_knit.KnitVersionedFiles(index, access, annotated=False)
264
def _get_revisions(self, repo_transport, repo):
265
mapper = versionedfile.ConstantMapper('revisions')
266
index = _mod_knit._KndxIndex(repo_transport, mapper,
267
repo.get_transaction, repo.is_write_locked, repo.is_locked)
268
access = _mod_knit._KnitKeyAccess(repo_transport, mapper)
269
return _mod_knit.KnitVersionedFiles(index, access, max_delta_chain=0,
272
def _get_signatures(self, repo_transport, repo):
273
mapper = versionedfile.ConstantMapper('signatures')
274
index = _mod_knit._KndxIndex(repo_transport, mapper,
275
repo.get_transaction, repo.is_write_locked, repo.is_locked)
276
access = _mod_knit._KnitKeyAccess(repo_transport, mapper)
277
return _mod_knit.KnitVersionedFiles(index, access, max_delta_chain=0,
280
def _get_texts(self, repo_transport, repo):
281
mapper = versionedfile.HashEscapedPrefixMapper()
282
base_transport = repo_transport.clone('knits')
283
index = _mod_knit._KndxIndex(base_transport, mapper,
284
repo.get_transaction, repo.is_write_locked, repo.is_locked)
285
access = _mod_knit._KnitKeyAccess(base_transport, mapper)
286
return _mod_knit.KnitVersionedFiles(index, access, max_delta_chain=200,
289
def initialize(self, a_bzrdir, shared=False):
290
"""Create a knit format 1 repository.
292
:param a_bzrdir: bzrdir to contain the new repository; must already
294
:param shared: If true the repository will be initialized as a shared
297
trace.mutter('creating repository in %s.', a_bzrdir.transport.base)
300
utf8_files = [('format', self.get_format_string())]
302
self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
303
repo_transport = a_bzrdir.get_repository_transport(None)
304
control_files = lockable_files.LockableFiles(repo_transport,
305
'lock', lockdir.LockDir)
306
transaction = transactions.WriteTransaction()
307
result = self.open(a_bzrdir=a_bzrdir, _found=True)
309
# the revision id here is irrelevant: it will not be stored, and cannot
310
# already exist, we do this to create files on disk for older clients.
311
result.inventories.get_parent_map([('A',)])
312
result.revisions.get_parent_map([('A',)])
313
result.signatures.get_parent_map([('A',)])
315
self._run_post_repo_init_hooks(result, a_bzrdir, shared)
318
def open(self, a_bzrdir, _found=False, _override_transport=None):
319
"""See RepositoryFormat.open().
321
:param _override_transport: INTERNAL USE ONLY. Allows opening the
322
repository at a slightly different url
323
than normal. I.e. during 'upgrade'.
326
format = RepositoryFormatMetaDir.find_format(a_bzrdir)
327
if _override_transport is not None:
328
repo_transport = _override_transport
330
repo_transport = a_bzrdir.get_repository_transport(None)
331
control_files = lockable_files.LockableFiles(repo_transport,
332
'lock', lockdir.LockDir)
333
repo = self.repository_class(_format=self,
335
control_files=control_files,
336
_commit_builder_class=self._commit_builder_class,
337
_serializer=self._serializer)
338
repo.revisions = self._get_revisions(repo_transport, repo)
339
repo.signatures = self._get_signatures(repo_transport, repo)
340
repo.inventories = self._get_inventories(repo_transport, repo)
341
repo.texts = self._get_texts(repo_transport, repo)
342
repo.chk_bytes = None
343
repo._transport = repo_transport
347
class RepositoryFormatKnit1(RepositoryFormatKnit):
348
"""Bzr repository knit format 1.
350
This repository format has:
351
- knits for file texts and inventory
352
- hash subdirectory based stores.
353
- knits for revisions and signatures
354
- TextStores for revisions and signatures.
355
- a format marker of its own
356
- an optional 'shared-storage' flag
357
- an optional 'no-working-trees' flag
360
This format was introduced in bzr 0.8.
363
repository_class = KnitRepository
364
_commit_builder_class = VersionedFileCommitBuilder
366
def _serializer(self):
367
return xml5.serializer_v5
369
def __ne__(self, other):
370
return self.__class__ is not other.__class__
373
def get_format_string(cls):
374
"""See RepositoryFormat.get_format_string()."""
375
return "Bazaar-NG Knit Repository Format 1"
377
def get_format_description(self):
378
"""See RepositoryFormat.get_format_description()."""
379
return "Knit repository format 1"
382
class RepositoryFormatKnit3(RepositoryFormatKnit):
383
"""Bzr repository knit format 3.
385
This repository format has:
386
- knits for file texts and inventory
387
- hash subdirectory based stores.
388
- knits for revisions and signatures
389
- TextStores for revisions and signatures.
390
- a format marker of its own
391
- an optional 'shared-storage' flag
392
- an optional 'no-working-trees' flag
394
- support for recording full info about the tree root
395
- support for recording tree-references
398
repository_class = KnitRepository
399
_commit_builder_class = VersionedFileRootCommitBuilder
400
rich_root_data = True
402
supports_tree_reference = True
404
def _serializer(self):
405
return xml7.serializer_v7
407
def _get_matching_bzrdir(self):
408
return controldir.format_registry.make_bzrdir('dirstate-with-subtree')
410
def _ignore_setting_bzrdir(self, format):
413
_matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
416
def get_format_string(cls):
417
"""See RepositoryFormat.get_format_string()."""
418
return "Bazaar Knit Repository Format 3 (bzr 0.15)\n"
420
def get_format_description(self):
421
"""See RepositoryFormat.get_format_description()."""
422
return "Knit repository format 3"
425
class RepositoryFormatKnit4(RepositoryFormatKnit):
426
"""Bzr repository knit format 4.
428
This repository format has everything in format 3, except for
430
- knits for file texts and inventory
431
- hash subdirectory based stores.
432
- knits for revisions and signatures
433
- TextStores for revisions and signatures.
434
- a format marker of its own
435
- an optional 'shared-storage' flag
436
- an optional 'no-working-trees' flag
438
- support for recording full info about the tree root
441
repository_class = KnitRepository
442
_commit_builder_class = VersionedFileRootCommitBuilder
443
rich_root_data = True
444
supports_tree_reference = False
446
def _serializer(self):
447
return xml6.serializer_v6
449
def _get_matching_bzrdir(self):
450
return controldir.format_registry.make_bzrdir('rich-root')
452
def _ignore_setting_bzrdir(self, format):
455
_matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
458
def get_format_string(cls):
459
"""See RepositoryFormat.get_format_string()."""
460
return 'Bazaar Knit Repository Format 4 (bzr 1.0)\n'
462
def get_format_description(self):
463
"""See RepositoryFormat.get_format_description()."""
464
return "Knit repository format 4"
467
class InterKnitRepo(InterSameDataRepository):
468
"""Optimised code paths between Knit based repositories."""
471
def _get_repo_format_to_test(self):
472
return RepositoryFormatKnit1()
475
def is_compatible(source, target):
476
"""Be compatible with known Knit formats.
478
We don't test for the stores being of specific types because that
479
could lead to confusing results, and there is no need to be
483
are_knits = (isinstance(source._format, RepositoryFormatKnit) and
484
isinstance(target._format, RepositoryFormatKnit))
485
except AttributeError:
487
return are_knits and InterRepository._same_model(source, target)
490
def search_missing_revision_ids(self,
491
find_ghosts=True, revision_ids=None, if_present_ids=None,
493
"""See InterRepository.search_missing_revision_ids()."""
494
source_ids_set = self._present_source_revisions_for(
495
revision_ids, if_present_ids)
496
# source_ids is the worst possible case we may need to pull.
497
# now we want to filter source_ids against what we actually
498
# have in target, but don't try to check for existence where we know
499
# we do not have a revision as that would be pointless.
500
target_ids = set(self.target.all_revision_ids())
501
possibly_present_revisions = target_ids.intersection(source_ids_set)
502
actually_present_revisions = set(
503
self.target._eliminate_revisions_not_present(possibly_present_revisions))
504
required_revisions = source_ids_set.difference(actually_present_revisions)
505
if revision_ids is not None:
506
# we used get_ancestry to determine source_ids then we are assured all
507
# revisions referenced are present as they are installed in topological order.
508
# and the tip revision was validated by get_ancestry.
509
result_set = required_revisions
511
# if we just grabbed the possibly available ids, then
512
# we only have an estimate of whats available and need to validate
513
# that against the revision records.
515
self.source._eliminate_revisions_not_present(required_revisions))
516
if limit is not None:
517
topo_ordered = self.source.get_graph().iter_topo_order(result_set)
518
result_set = set(itertools.islice(topo_ordered, limit))
519
return self.source.revision_ids_to_search_result(result_set)
522
InterRepository.register_optimiser(InterKnitRepo)
added
removed
bzrlib/repofmt/knitrepo.py
