13
13
# You should have received a copy of the GNU General Public License
14
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
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from bzrlib.lazy_import import lazy_import
18
lazy_import(globals(), """
17
19
from bzrlib import (
26
revision as _mod_revision,
30
37
from bzrlib.decorators import needs_read_lock, needs_write_lock
31
38
from bzrlib.repository import (
33
41
MetaDirRepositoryFormat,
37
import bzrlib.revision as _mod_revision
38
from bzrlib.store.versioned import VersionedFileStore
39
from bzrlib.trace import mutter, note, warning
45
from bzrlib.trace import mutter, mutter_callsite
42
48
class _KnitParentsProvider(object):
47
53
def __repr__(self):
48
54
return 'KnitParentsProvider(%r)' % self._knit
50
def get_parents(self, revision_ids):
52
for revision_id in revision_ids:
56
def get_parent_map(self, keys):
57
"""See graph.StackedParentsProvider.get_parent_map"""
59
for revision_id in keys:
60
if revision_id is None:
61
raise ValueError('get_parent_map(None) is not valid')
53
62
if revision_id == _mod_revision.NULL_REVISION:
63
parent_map[revision_id] = ()
57
parents = self._knit.get_parents_with_ghosts(revision_id)
67
self._knit.get_parents_with_ghosts(revision_id))
58
68
except errors.RevisionNotPresent:
61
71
if len(parents) == 0:
62
parents = [_mod_revision.NULL_REVISION]
63
parents_list.append(parents)
72
parents = (_mod_revision.NULL_REVISION,)
73
parent_map[revision_id] = parents
77
class _KnitsParentsProvider(object):
79
def __init__(self, knit, prefix=()):
80
"""Create a parent provider for string keys mapped to tuple keys."""
85
return 'KnitsParentsProvider(%r)' % self._knit
87
def get_parent_map(self, keys):
88
"""See graph.StackedParentsProvider.get_parent_map"""
89
parent_map = self._knit.get_parent_map(
90
[self._prefix + (key,) for key in keys])
92
for key, parents in parent_map.items():
95
parents = (_mod_revision.NULL_REVISION,)
97
parents = tuple(parent[-1] for parent in parents)
98
result[revid] = parents
99
for revision_id in keys:
100
if revision_id == _mod_revision.NULL_REVISION:
101
result[revision_id] = ()
67
105
class KnitRepository(MetaDirRepository):
68
106
"""Knit format repository."""
70
_serializer = xml5.serializer_v5
72
def _warn_if_deprecated(self):
73
# This class isn't deprecated
76
def _inventory_add_lines(self, inv_vf, revid, parents, lines):
77
inv_vf.add_lines_with_ghosts(revid, parents, lines)
108
# These attributes are inherited from the Repository base class. Setting
109
# them to None ensures that if the constructor is changed to not initialize
110
# them, or a subclass fails to call the constructor, that an error will
111
# occur rather than the system working but generating incorrect data.
112
_commit_builder_class = None
115
def __init__(self, _format, a_bzrdir, control_files, _commit_builder_class,
117
MetaDirRepository.__init__(self, _format, a_bzrdir, control_files)
118
self._commit_builder_class = _commit_builder_class
119
self._serializer = _serializer
120
self._reconcile_fixes_text_parents = True
80
123
def _all_revision_ids(self):
81
124
"""See Repository.all_revision_ids()."""
82
# Knits get the revision graph from the index of the revision knit, so
83
# it's always possible even if they're on an unlistable transport.
84
return self._revision_store.all_revision_ids(self.get_transaction())
125
return [key[0] for key in self.revisions.keys()]
127
def _activate_new_inventory(self):
128
"""Put a replacement inventory.new into use as inventories."""
129
# Copy the content across
131
t.copy('inventory.new.kndx', 'inventory.kndx')
133
t.copy('inventory.new.knit', 'inventory.knit')
134
except errors.NoSuchFile:
135
# empty inventories knit
136
t.delete('inventory.knit')
137
# delete the temp inventory
138
t.delete('inventory.new.kndx')
140
t.delete('inventory.new.knit')
141
except errors.NoSuchFile:
142
# empty inventories knit
144
# Force index reload (sanity check)
145
self.inventories._index._reset_cache()
146
self.inventories.keys()
148
def _backup_inventory(self):
150
t.copy('inventory.kndx', 'inventory.backup.kndx')
151
t.copy('inventory.knit', 'inventory.backup.knit')
153
def _move_file_id(self, from_id, to_id):
154
t = self._transport.clone('knits')
155
from_rel_url = self.texts._index._mapper.map((from_id, None))
156
to_rel_url = self.texts._index._mapper.map((to_id, None))
157
# We expect both files to always exist in this case.
158
for suffix in ('.knit', '.kndx'):
159
t.rename(from_rel_url + suffix, to_rel_url + suffix)
161
def _remove_file_id(self, file_id):
162
t = self._transport.clone('knits')
163
rel_url = self.texts._index._mapper.map((file_id, None))
164
for suffix in ('.kndx', '.knit'):
166
t.delete(rel_url + suffix)
167
except errors.NoSuchFile:
170
def _temp_inventories(self):
171
result = self._format._get_inventories(self._transport, self,
173
# Reconciling when the output has no revisions would result in no
174
# writes - but we want to ensure there is an inventory for
175
# compatibility with older clients that don't lazy-load.
176
result.get_parent_map([('A',)])
86
179
def fileid_involved_between_revs(self, from_revid, to_revid):
87
180
"""Find file_id(s) which are involved in the changes between revisions.
111
202
return self._fileid_involved_by_set(changed)
114
def get_ancestry(self, revision_id, topo_sorted=True):
115
"""Return a list of revision-ids integrated by a revision.
117
This is topologically sorted, unless 'topo_sorted' is specified as
120
if _mod_revision.is_null(revision_id):
122
revision_id = osutils.safe_revision_id(revision_id)
123
vf = self._get_revision_vf()
125
return [None] + vf.get_ancestry(revision_id, topo_sorted)
126
except errors.RevisionNotPresent:
127
raise errors.NoSuchRevision(self, revision_id)
130
205
def get_revision(self, revision_id):
131
206
"""Return the Revision object for a named revision"""
132
207
revision_id = osutils.safe_revision_id(revision_id)
133
208
return self.get_revision_reconcile(revision_id)
136
def get_revision_graph(self, revision_id=None):
137
"""Return a dictionary containing the revision graph.
139
:param revision_id: The revision_id to get a graph from. If None, then
140
the entire revision graph is returned. This is a deprecated mode of
141
operation and will be removed in the future.
142
:return: a dictionary of revision_id->revision_parents_list.
144
# special case NULL_REVISION
145
if revision_id == _mod_revision.NULL_REVISION:
147
revision_id = osutils.safe_revision_id(revision_id)
148
a_weave = self._get_revision_vf()
149
entire_graph = a_weave.get_graph()
150
if revision_id is None:
151
return a_weave.get_graph()
152
elif revision_id not in a_weave:
153
raise errors.NoSuchRevision(self, revision_id)
155
# add what can be reached from revision_id
157
pending = set([revision_id])
158
while len(pending) > 0:
160
result[node] = a_weave.get_parents(node)
161
for revision_id in result[node]:
162
if revision_id not in result:
163
pending.add(revision_id)
167
def get_revision_graph_with_ghosts(self, revision_ids=None):
168
"""Return a graph of the revisions with ghosts marked as applicable.
170
:param revision_ids: an iterable of revisions to graph or None for all.
171
:return: a Graph object with the graph reachable from revision_ids.
173
result = deprecated_graph.Graph()
174
vf = self._get_revision_vf()
175
versions = set(vf.versions())
177
pending = set(self.all_revision_ids())
180
pending = set(osutils.safe_revision_id(r) for r in revision_ids)
181
# special case NULL_REVISION
182
if _mod_revision.NULL_REVISION in pending:
183
pending.remove(_mod_revision.NULL_REVISION)
184
required = set(pending)
187
revision_id = pending.pop()
188
if not revision_id in versions:
189
if revision_id in required:
190
raise errors.NoSuchRevision(self, revision_id)
192
result.add_ghost(revision_id)
193
# mark it as done so we don't try for it again.
194
done.add(revision_id)
196
parent_ids = vf.get_parents_with_ghosts(revision_id)
197
for parent_id in parent_ids:
198
# is this queued or done ?
199
if (parent_id not in pending and
200
parent_id not in done):
202
pending.add(parent_id)
203
result.add_node(revision_id, parent_ids)
204
done.add(revision_id)
207
def _get_revision_vf(self):
208
""":return: a versioned file containing the revisions."""
209
vf = self._revision_store.get_revision_file(self.get_transaction())
212
def _get_history_vf(self):
213
"""Get a versionedfile whose history graph reflects all revisions.
215
For knit repositories, this is the revision knit.
217
return self._get_revision_vf()
210
def _refresh_data(self):
211
if not self.is_locked():
213
# Create a new transaction to force all knits to see the scope change.
214
# This is safe because we're outside a write group.
215
self.control_files._finish_transaction()
216
if self.is_write_locked():
217
self.control_files._set_write_transaction()
219
self.control_files._set_read_transaction()
219
221
@needs_write_lock
220
222
def reconcile(self, other=None, thorough=False):
223
225
reconciler = KnitReconciler(self, thorough=thorough)
224
226
reconciler.reconcile()
225
227
return reconciler
227
def revision_parents(self, revision_id):
228
revision_id = osutils.safe_revision_id(revision_id)
229
return self._get_revision_vf().get_parents(revision_id)
231
229
def _make_parents_provider(self):
232
return _KnitParentsProvider(self._get_revision_vf())
235
class KnitRepository3(KnitRepository):
237
def __init__(self, _format, a_bzrdir, control_files, _revision_store,
238
control_store, text_store):
239
KnitRepository.__init__(self, _format, a_bzrdir, control_files,
240
_revision_store, control_store, text_store)
241
self._serializer = xml7.serializer_v7
243
def deserialise_inventory(self, revision_id, xml):
244
"""Transform the xml into an inventory object.
246
:param revision_id: The expected revision id of the inventory.
247
:param xml: A serialised inventory.
249
result = self._serializer.read_inventory_from_string(xml)
250
assert result.root.revision is not None
253
def serialise_inventory(self, inv):
254
"""Transform the inventory object into XML text.
256
:param revision_id: The expected revision id of the inventory.
257
:param xml: A serialised inventory.
259
assert inv.revision_id is not None
260
assert inv.root.revision is not None
261
return KnitRepository.serialise_inventory(self, inv)
263
def get_commit_builder(self, branch, parents, config, timestamp=None,
264
timezone=None, committer=None, revprops=None,
266
"""Obtain a CommitBuilder for this repository.
268
:param branch: Branch to commit to.
269
:param parents: Revision ids of the parents of the new revision.
270
:param config: Configuration to use.
271
:param timestamp: Optional timestamp recorded for commit.
272
:param timezone: Optional timezone for timestamp.
273
:param committer: Optional committer to set for commit.
274
:param revprops: Optional dictionary of revision properties.
275
:param revision_id: Optional revision id.
277
revision_id = osutils.safe_revision_id(revision_id)
278
return RootCommitBuilder(self, parents, config, timestamp, timezone,
279
committer, revprops, revision_id)
230
return _KnitsParentsProvider(self.revisions)
232
def _find_inconsistent_revision_parents(self):
233
"""Find revisions with different parent lists in the revision object
234
and in the index graph.
236
:returns: an iterator yielding tuples of (revison-id, parents-in-index,
237
parents-in-revision).
239
if not self.is_locked():
240
raise AssertionError()
242
for index_version in vf.keys():
243
parent_map = vf.get_parent_map([index_version])
244
parents_according_to_index = tuple(parent[-1] for parent in
245
parent_map[index_version])
246
revision = self.get_revision(index_version[-1])
247
parents_according_to_revision = tuple(revision.parent_ids)
248
if parents_according_to_index != parents_according_to_revision:
249
yield (index_version[-1], parents_according_to_index,
250
parents_according_to_revision)
252
def _check_for_inconsistent_revision_parents(self):
253
inconsistencies = list(self._find_inconsistent_revision_parents())
255
raise errors.BzrCheckError(
256
"Revision knit has inconsistent parents.")
258
def revision_graph_can_have_wrong_parents(self):
259
# The revision.kndx could potentially claim a revision has a different
260
# parent to the revision text.
282
264
class RepositoryFormatKnit(MetaDirRepositoryFormat):
283
"""Bzr repository knit format (generalized).
265
"""Bzr repository knit format (generalized).
285
267
This repository format has:
286
268
- knits for file texts and inventory
296
def _get_control_store(self, repo_transport, control_files):
297
"""Return the control store for this repository."""
298
return VersionedFileStore(
301
file_mode=control_files._file_mode,
302
versionedfile_class=knit.KnitVersionedFile,
303
versionedfile_kwargs={'factory':knit.KnitPlainFactory()},
306
def _get_revision_store(self, repo_transport, control_files):
307
"""See RepositoryFormat._get_revision_store()."""
308
from bzrlib.store.revision.knit import KnitRevisionStore
309
versioned_file_store = VersionedFileStore(
311
file_mode=control_files._file_mode,
314
versionedfile_class=knit.KnitVersionedFile,
315
versionedfile_kwargs={'delta':False,
316
'factory':knit.KnitPlainFactory(),
320
return KnitRevisionStore(versioned_file_store)
322
def _get_text_store(self, transport, control_files):
323
"""See RepositoryFormat._get_text_store()."""
324
return self._get_versioned_file_store('knits',
327
versionedfile_class=knit.KnitVersionedFile,
328
versionedfile_kwargs={
329
'create_parent_dir':True,
331
'dir_mode':control_files._dir_mode,
278
# Set this attribute in derived classes to control the repository class
279
# created by open and initialize.
280
repository_class = None
281
# Set this attribute in derived classes to control the
282
# _commit_builder_class that the repository objects will have passed to
284
_commit_builder_class = None
285
# Set this attribute in derived clases to control the _serializer that the
286
# repository objects will have passed to their constructor.
288
def _serializer(self):
289
return xml5.serializer_v5
290
# Knit based repositories handle ghosts reasonably well.
291
supports_ghosts = True
292
# External lookups are not supported in this format.
293
supports_external_lookups = False
295
supports_chks = False
296
_fetch_order = 'topological'
297
_fetch_uses_deltas = True
300
def _get_inventories(self, repo_transport, repo, name='inventory'):
301
mapper = versionedfile.ConstantMapper(name)
302
index = _mod_knit._KndxIndex(repo_transport, mapper,
303
repo.get_transaction, repo.is_write_locked, repo.is_locked)
304
access = _mod_knit._KnitKeyAccess(repo_transport, mapper)
305
return _mod_knit.KnitVersionedFiles(index, access, annotated=False)
307
def _get_revisions(self, repo_transport, repo):
308
mapper = versionedfile.ConstantMapper('revisions')
309
index = _mod_knit._KndxIndex(repo_transport, mapper,
310
repo.get_transaction, repo.is_write_locked, repo.is_locked)
311
access = _mod_knit._KnitKeyAccess(repo_transport, mapper)
312
return _mod_knit.KnitVersionedFiles(index, access, max_delta_chain=0,
315
def _get_signatures(self, repo_transport, repo):
316
mapper = versionedfile.ConstantMapper('signatures')
317
index = _mod_knit._KndxIndex(repo_transport, mapper,
318
repo.get_transaction, repo.is_write_locked, repo.is_locked)
319
access = _mod_knit._KnitKeyAccess(repo_transport, mapper)
320
return _mod_knit.KnitVersionedFiles(index, access, max_delta_chain=0,
323
def _get_texts(self, repo_transport, repo):
324
mapper = versionedfile.HashEscapedPrefixMapper()
325
base_transport = repo_transport.clone('knits')
326
index = _mod_knit._KndxIndex(base_transport, mapper,
327
repo.get_transaction, repo.is_write_locked, repo.is_locked)
328
access = _mod_knit._KnitKeyAccess(base_transport, mapper)
329
return _mod_knit.KnitVersionedFiles(index, access, max_delta_chain=200,
335
332
def initialize(self, a_bzrdir, shared=False):
336
333
"""Create a knit format 1 repository.
343
340
mutter('creating repository in %s.', a_bzrdir.transport.base)
344
dirs = ['revision-store', 'knits']
346
343
utf8_files = [('format', self.get_format_string())]
348
345
self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
349
346
repo_transport = a_bzrdir.get_repository_transport(None)
350
347
control_files = lockable_files.LockableFiles(repo_transport,
351
348
'lock', lockdir.LockDir)
352
control_store = self._get_control_store(repo_transport, control_files)
353
349
transaction = transactions.WriteTransaction()
354
# trigger a write of the inventory store.
355
control_store.get_weave_or_empty('inventory', transaction)
356
_revision_store = self._get_revision_store(repo_transport, control_files)
350
result = self.open(a_bzrdir=a_bzrdir, _found=True)
357
352
# the revision id here is irrelevant: it will not be stored, and cannot
359
_revision_store.has_revision_id('A', transaction)
360
_revision_store.get_signature_file(transaction)
361
return self.open(a_bzrdir=a_bzrdir, _found=True)
353
# already exist, we do this to create files on disk for older clients.
354
result.inventories.get_parent_map([('A',)])
355
result.revisions.get_parent_map([('A',)])
356
result.signatures.get_parent_map([('A',)])
363
360
def open(self, a_bzrdir, _found=False, _override_transport=None):
364
361
"""See RepositoryFormat.open().
366
363
:param _override_transport: INTERNAL USE ONLY. Allows opening the
367
364
repository at a slightly different url
368
365
than normal. I.e. during 'upgrade'.
371
368
format = RepositoryFormat.find_format(a_bzrdir)
372
assert format.__class__ == self.__class__
373
369
if _override_transport is not None:
374
370
repo_transport = _override_transport
376
372
repo_transport = a_bzrdir.get_repository_transport(None)
377
373
control_files = lockable_files.LockableFiles(repo_transport,
378
374
'lock', lockdir.LockDir)
379
text_store = self._get_text_store(repo_transport, control_files)
380
control_store = self._get_control_store(repo_transport, control_files)
381
_revision_store = self._get_revision_store(repo_transport, control_files)
382
return KnitRepository(_format=self,
375
repo = self.repository_class(_format=self,
383
376
a_bzrdir=a_bzrdir,
384
377
control_files=control_files,
385
_revision_store=_revision_store,
386
control_store=control_store,
387
text_store=text_store)
378
_commit_builder_class=self._commit_builder_class,
379
_serializer=self._serializer)
380
repo.revisions = self._get_revisions(repo_transport, repo)
381
repo.signatures = self._get_signatures(repo_transport, repo)
382
repo.inventories = self._get_inventories(repo_transport, repo)
383
repo.texts = self._get_texts(repo_transport, repo)
384
repo.chk_bytes = None
385
repo._transport = repo_transport
390
389
class RepositoryFormatKnit1(RepositoryFormatKnit):
462
471
"""See RepositoryFormat.get_format_description()."""
463
472
return "Knit repository format 3"
465
def open(self, a_bzrdir, _found=False, _override_transport=None):
466
"""See RepositoryFormat.open().
468
:param _override_transport: INTERNAL USE ONLY. Allows opening the
469
repository at a slightly different url
470
than normal. I.e. during 'upgrade'.
473
format = RepositoryFormat.find_format(a_bzrdir)
474
assert format.__class__ == self.__class__
475
if _override_transport is not None:
476
repo_transport = _override_transport
478
repo_transport = a_bzrdir.get_repository_transport(None)
479
control_files = lockable_files.LockableFiles(repo_transport, 'lock',
481
text_store = self._get_text_store(repo_transport, control_files)
482
control_store = self._get_control_store(repo_transport, control_files)
483
_revision_store = self._get_revision_store(repo_transport, control_files)
484
return self.repository_class(_format=self,
486
control_files=control_files,
487
_revision_store=_revision_store,
488
control_store=control_store,
489
text_store=text_store)
475
class RepositoryFormatKnit4(RepositoryFormatKnit):
476
"""Bzr repository knit format 4.
478
This repository format has everything in format 3, except for
480
- knits for file texts and inventory
481
- hash subdirectory based stores.
482
- knits for revisions and signatures
483
- TextStores for revisions and signatures.
484
- a format marker of its own
485
- an optional 'shared-storage' flag
486
- an optional 'no-working-trees' flag
488
- support for recording full info about the tree root
491
repository_class = KnitRepository
492
_commit_builder_class = RootCommitBuilder
493
rich_root_data = True
494
supports_tree_reference = False
496
def _serializer(self):
497
return xml6.serializer_v6
499
def _get_matching_bzrdir(self):
500
return bzrdir.format_registry.make_bzrdir('rich-root')
502
def _ignore_setting_bzrdir(self, format):
505
_matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
507
def check_conversion_target(self, target_format):
508
if not target_format.rich_root_data:
509
raise errors.BadConversionTarget(
510
'Does not support rich root data.', target_format)
512
def get_format_string(self):
513
"""See RepositoryFormat.get_format_string()."""
514
return 'Bazaar Knit Repository Format 4 (bzr 1.0)\n'
516
def get_format_description(self):
517
"""See RepositoryFormat.get_format_description()."""
518
return "Knit repository format 4"
added
removed
bzrlib/repofmt/knitrepo.py
