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
38
from bzrlib.decorators import needs_read_lock, needs_write_lock
31
39
from bzrlib.repository import (
33
43
MetaDirRepositoryFormat,
37
import bzrlib.revision as _mod_revision
38
from bzrlib.store.versioned import VersionedFileStore
39
from bzrlib.trace import mutter, note, warning
42
49
class _KnitParentsProvider(object):
47
54
def __repr__(self):
48
55
return 'KnitParentsProvider(%r)' % self._knit
50
def get_parents(self, revision_ids):
52
for revision_id in revision_ids:
57
def get_parent_map(self, keys):
58
"""See graph.StackedParentsProvider.get_parent_map"""
60
for revision_id in keys:
61
if revision_id is None:
62
raise ValueError('get_parent_map(None) is not valid')
53
63
if revision_id == _mod_revision.NULL_REVISION:
64
parent_map[revision_id] = ()
57
parents = self._knit.get_parents_with_ghosts(revision_id)
68
self._knit.get_parents_with_ghosts(revision_id))
58
69
except errors.RevisionNotPresent:
61
72
if len(parents) == 0:
62
parents = [_mod_revision.NULL_REVISION]
63
parents_list.append(parents)
73
parents = (_mod_revision.NULL_REVISION,)
74
parent_map[revision_id] = parents
78
class _KnitsParentsProvider(object):
80
def __init__(self, knit, prefix=()):
81
"""Create a parent provider for string keys mapped to tuple keys."""
86
return 'KnitsParentsProvider(%r)' % self._knit
88
def get_parent_map(self, keys):
89
"""See graph.StackedParentsProvider.get_parent_map"""
90
parent_map = self._knit.get_parent_map(
91
[self._prefix + (key,) for key in keys])
93
for key, parents in parent_map.items():
96
parents = (_mod_revision.NULL_REVISION,)
98
parents = tuple(parent[-1] for parent in parents)
99
result[revid] = parents
100
for revision_id in keys:
101
if revision_id == _mod_revision.NULL_REVISION:
102
result[revision_id] = ()
67
106
class KnitRepository(MetaDirRepository):
68
107
"""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)
109
# These attributes are inherited from the Repository base class. Setting
110
# them to None ensures that if the constructor is changed to not initialize
111
# them, or a subclass fails to call the constructor, that an error will
112
# occur rather than the system working but generating incorrect data.
113
_commit_builder_class = None
116
def __init__(self, _format, a_bzrdir, control_files, _commit_builder_class,
118
MetaDirRepository.__init__(self, _format, a_bzrdir, control_files)
119
self._commit_builder_class = _commit_builder_class
120
self._serializer = _serializer
121
self._reconcile_fixes_text_parents = True
80
124
def _all_revision_ids(self):
81
125
"""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())
126
return [key[0] for key in self.revisions.keys()]
128
def _activate_new_inventory(self):
129
"""Put a replacement inventory.new into use as inventories."""
130
# Copy the content across
132
t.copy('inventory.new.kndx', 'inventory.kndx')
134
t.copy('inventory.new.knit', 'inventory.knit')
135
except errors.NoSuchFile:
136
# empty inventories knit
137
t.delete('inventory.knit')
138
# delete the temp inventory
139
t.delete('inventory.new.kndx')
141
t.delete('inventory.new.knit')
142
except errors.NoSuchFile:
143
# empty inventories knit
145
# Force index reload (sanity check)
146
self.inventories._index._reset_cache()
147
self.inventories.keys()
149
def _backup_inventory(self):
151
t.copy('inventory.kndx', 'inventory.backup.kndx')
152
t.copy('inventory.knit', 'inventory.backup.knit')
154
def _move_file_id(self, from_id, to_id):
155
t = self._transport.clone('knits')
156
from_rel_url = self.texts._index._mapper.map((from_id, None))
157
to_rel_url = self.texts._index._mapper.map((to_id, None))
158
# We expect both files to always exist in this case.
159
for suffix in ('.knit', '.kndx'):
160
t.rename(from_rel_url + suffix, to_rel_url + suffix)
162
def _remove_file_id(self, file_id):
163
t = self._transport.clone('knits')
164
rel_url = self.texts._index._mapper.map((file_id, None))
165
for suffix in ('.kndx', '.knit'):
167
t.delete(rel_url + suffix)
168
except errors.NoSuchFile:
171
def _temp_inventories(self):
172
result = self._format._get_inventories(self._transport, self,
174
# Reconciling when the output has no revisions would result in no
175
# writes - but we want to ensure there is an inventory for
176
# compatibility with older clients that don't lazy-load.
177
result.get_parent_map([('A',)])
86
180
def fileid_involved_between_revs(self, from_revid, to_revid):
87
181
"""Find file_id(s) which are involved in the changes between revisions.
111
203
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 revision_id is None:
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
206
def get_revision(self, revision_id):
131
207
"""Return the Revision object for a named revision"""
132
208
revision_id = osutils.safe_revision_id(revision_id)
133
209
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()
211
def _refresh_data(self):
212
if not self.is_locked():
214
if self.is_in_write_group():
215
raise IsInWriteGroupError(self)
216
# Create a new transaction to force all knits to see the scope change.
217
# This is safe because we're outside a write group.
218
self.control_files._finish_transaction()
219
if self.is_write_locked():
220
self.control_files._set_write_transaction()
222
self.control_files._set_read_transaction()
219
224
@needs_write_lock
220
225
def reconcile(self, other=None, thorough=False):
223
228
reconciler = KnitReconciler(self, thorough=thorough)
224
229
reconciler.reconcile()
225
230
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
232
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)
233
return _KnitsParentsProvider(self.revisions)
235
def _find_inconsistent_revision_parents(self, revisions_iterator=None):
236
"""Find revisions with different parent lists in the revision object
237
and in the index graph.
239
:param revisions_iterator: None, or an iterator of (revid,
240
Revision-or-None). This iterator controls the revisions checked.
241
:returns: an iterator yielding tuples of (revison-id, parents-in-index,
242
parents-in-revision).
244
if not self.is_locked():
245
raise AssertionError()
247
if revisions_iterator is None:
248
revisions_iterator = self._iter_revisions(None)
249
for revid, revision in revisions_iterator:
252
parent_map = vf.get_parent_map([(revid,)])
253
parents_according_to_index = tuple(parent[-1] for parent in
254
parent_map[(revid,)])
255
parents_according_to_revision = tuple(revision.parent_ids)
256
if parents_according_to_index != parents_according_to_revision:
257
yield (revid, parents_according_to_index,
258
parents_according_to_revision)
260
def _check_for_inconsistent_revision_parents(self):
261
inconsistencies = list(self._find_inconsistent_revision_parents())
263
raise errors.BzrCheckError(
264
"Revision knit has inconsistent parents.")
266
def revision_graph_can_have_wrong_parents(self):
267
# The revision.kndx could potentially claim a revision has a different
268
# parent to the revision text.
282
272
class RepositoryFormatKnit(MetaDirRepositoryFormat):
283
"""Bzr repository knit format (generalized).
273
"""Bzr repository knit format (generalized).
285
275
This repository format has:
286
276
- 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,
286
# Set this attribute in derived classes to control the repository class
287
# created by open and initialize.
288
repository_class = None
289
# Set this attribute in derived classes to control the
290
# _commit_builder_class that the repository objects will have passed to
292
_commit_builder_class = None
293
# Set this attribute in derived clases to control the _serializer that the
294
# repository objects will have passed to their constructor.
296
def _serializer(self):
297
return xml5.serializer_v5
298
# Knit based repositories handle ghosts reasonably well.
299
supports_ghosts = True
300
# External lookups are not supported in this format.
301
supports_external_lookups = False
303
supports_chks = False
304
_fetch_order = 'topological'
305
_fetch_uses_deltas = True
308
def _get_inventories(self, repo_transport, repo, name='inventory'):
309
mapper = versionedfile.ConstantMapper(name)
310
index = _mod_knit._KndxIndex(repo_transport, mapper,
311
repo.get_transaction, repo.is_write_locked, repo.is_locked)
312
access = _mod_knit._KnitKeyAccess(repo_transport, mapper)
313
return _mod_knit.KnitVersionedFiles(index, access, annotated=False)
315
def _get_revisions(self, repo_transport, repo):
316
mapper = versionedfile.ConstantMapper('revisions')
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_signatures(self, repo_transport, repo):
324
mapper = versionedfile.ConstantMapper('signatures')
325
index = _mod_knit._KndxIndex(repo_transport, mapper,
326
repo.get_transaction, repo.is_write_locked, repo.is_locked)
327
access = _mod_knit._KnitKeyAccess(repo_transport, mapper)
328
return _mod_knit.KnitVersionedFiles(index, access, max_delta_chain=0,
331
def _get_texts(self, repo_transport, repo):
332
mapper = versionedfile.HashEscapedPrefixMapper()
333
base_transport = repo_transport.clone('knits')
334
index = _mod_knit._KndxIndex(base_transport, mapper,
335
repo.get_transaction, repo.is_write_locked, repo.is_locked)
336
access = _mod_knit._KnitKeyAccess(base_transport, mapper)
337
return _mod_knit.KnitVersionedFiles(index, access, max_delta_chain=200,
335
340
def initialize(self, a_bzrdir, shared=False):
336
341
"""Create a knit format 1 repository.
340
345
:param shared: If true the repository will be initialized as a shared
343
mutter('creating repository in %s.', a_bzrdir.transport.base)
344
dirs = ['revision-store', 'knits']
348
trace.mutter('creating repository in %s.', a_bzrdir.transport.base)
346
351
utf8_files = [('format', self.get_format_string())]
348
353
self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
349
354
repo_transport = a_bzrdir.get_repository_transport(None)
350
355
control_files = lockable_files.LockableFiles(repo_transport,
351
356
'lock', lockdir.LockDir)
352
control_store = self._get_control_store(repo_transport, control_files)
353
357
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)
358
result = self.open(a_bzrdir=a_bzrdir, _found=True)
357
360
# 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)
361
# already exist, we do this to create files on disk for older clients.
362
result.inventories.get_parent_map([('A',)])
363
result.revisions.get_parent_map([('A',)])
364
result.signatures.get_parent_map([('A',)])
366
self._run_post_repo_init_hooks(result, a_bzrdir, shared)
363
369
def open(self, a_bzrdir, _found=False, _override_transport=None):
364
370
"""See RepositoryFormat.open().
366
372
:param _override_transport: INTERNAL USE ONLY. Allows opening the
367
373
repository at a slightly different url
368
374
than normal. I.e. during 'upgrade'.
371
377
format = RepositoryFormat.find_format(a_bzrdir)
372
assert format.__class__ == self.__class__
373
378
if _override_transport is not None:
374
379
repo_transport = _override_transport
376
381
repo_transport = a_bzrdir.get_repository_transport(None)
377
382
control_files = lockable_files.LockableFiles(repo_transport,
378
383
'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,
384
repo = self.repository_class(_format=self,
383
385
a_bzrdir=a_bzrdir,
384
386
control_files=control_files,
385
_revision_store=_revision_store,
386
control_store=control_store,
387
text_store=text_store)
387
_commit_builder_class=self._commit_builder_class,
388
_serializer=self._serializer)
389
repo.revisions = self._get_revisions(repo_transport, repo)
390
repo.signatures = self._get_signatures(repo_transport, repo)
391
repo.inventories = self._get_inventories(repo_transport, repo)
392
repo.texts = self._get_texts(repo_transport, repo)
393
repo.chk_bytes = None
394
repo._transport = repo_transport
390
398
class RepositoryFormatKnit1(RepositoryFormatKnit):
462
470
"""See RepositoryFormat.get_format_description()."""
463
471
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)
474
class RepositoryFormatKnit4(RepositoryFormatKnit):
475
"""Bzr repository knit format 4.
477
This repository format has everything in format 3, except for
479
- knits for file texts and inventory
480
- hash subdirectory based stores.
481
- knits for revisions and signatures
482
- TextStores for revisions and signatures.
483
- a format marker of its own
484
- an optional 'shared-storage' flag
485
- an optional 'no-working-trees' flag
487
- support for recording full info about the tree root
490
repository_class = KnitRepository
491
_commit_builder_class = RootCommitBuilder
492
rich_root_data = True
493
supports_tree_reference = False
495
def _serializer(self):
496
return xml6.serializer_v6
498
def _get_matching_bzrdir(self):
499
return bzrdir.format_registry.make_bzrdir('rich-root')
501
def _ignore_setting_bzrdir(self, format):
504
_matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
506
def get_format_string(self):
507
"""See RepositoryFormat.get_format_string()."""
508
return 'Bazaar Knit Repository Format 4 (bzr 1.0)\n'
510
def get_format_description(self):
511
"""See RepositoryFormat.get_format_description()."""
512
return "Knit repository format 4"