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
30
from bzrlib.decorators import needs_read_lock, needs_write_lock
31
from bzrlib.repository import (
33
MetaDirRepositoryFormat,
37
import bzrlib.revision as _mod_revision
38
from bzrlib.store.versioned import VersionedFileStore
39
from bzrlib.trace import mutter, note, warning
40
from bzrlib.util import bencode
43
class _KnitParentsProvider(object):
45
def __init__(self, knit):
49
return 'KnitParentsProvider(%r)' % self._knit
51
def get_parents(self, revision_ids):
53
for revision_id in revision_ids:
54
if revision_id == _mod_revision.NULL_REVISION:
58
parents = self._knit.get_parents_with_ghosts(revision_id)
59
except errors.RevisionNotPresent:
63
parents = [_mod_revision.NULL_REVISION]
64
parents_list.append(parents)
68
class KnitRepository(MetaDirRepository):
69
"""Knit format repository."""
71
_serializer = xml5.serializer_v5
73
def _warn_if_deprecated(self):
74
# This class isn't deprecated
77
def _inventory_add_lines(self, inv_vf, revid, parents, lines, check_content):
78
return inv_vf.add_lines_with_ghosts(revid, parents, lines,
79
check_content=check_content)[0]
82
def _all_revision_ids(self):
83
"""See Repository.all_revision_ids()."""
84
# Knits get the revision graph from the index of the revision knit, so
85
# it's always possible even if they're on an unlistable transport.
86
return self._revision_store.all_revision_ids(self.get_transaction())
88
def fileid_involved_between_revs(self, from_revid, to_revid):
89
"""Find file_id(s) which are involved in the changes between revisions.
91
This determines the set of revisions which are involved, and then
92
finds all file ids affected by those revisions.
94
from_revid = osutils.safe_revision_id(from_revid)
95
to_revid = osutils.safe_revision_id(to_revid)
96
vf = self._get_revision_vf()
97
from_set = set(vf.get_ancestry(from_revid))
98
to_set = set(vf.get_ancestry(to_revid))
99
changed = to_set.difference(from_set)
100
return self._fileid_involved_by_set(changed)
102
def fileid_involved(self, last_revid=None):
103
"""Find all file_ids modified in the ancestry of last_revid.
105
:param last_revid: If None, last_revision() will be used.
108
changed = set(self.all_revision_ids())
110
changed = set(self.get_ancestry(last_revid))
113
return self._fileid_involved_by_set(changed)
116
def get_ancestry(self, revision_id, topo_sorted=True):
117
"""Return a list of revision-ids integrated by a revision.
119
This is topologically sorted, unless 'topo_sorted' is specified as
122
if _mod_revision.is_null(revision_id):
124
revision_id = osutils.safe_revision_id(revision_id)
125
vf = self._get_revision_vf()
127
return [None] + vf.get_ancestry(revision_id, topo_sorted)
128
except errors.RevisionNotPresent:
129
raise errors.NoSuchRevision(self, revision_id)
132
def get_revision_graph(self, revision_id=None):
133
"""Return a dictionary containing the revision graph.
135
:param revision_id: The revision_id to get a graph from. If None, then
136
the entire revision graph is returned. This is a deprecated mode of
137
operation and will be removed in the future.
138
:return: a dictionary of revision_id->revision_parents_list.
140
# special case NULL_REVISION
141
if revision_id == _mod_revision.NULL_REVISION:
143
revision_id = osutils.safe_revision_id(revision_id)
144
a_weave = self._get_revision_vf()
145
if revision_id is None:
146
return a_weave.get_graph()
147
elif revision_id not in a_weave:
148
raise errors.NoSuchRevision(self, revision_id)
150
# add what can be reached from revision_id
151
return a_weave.get_graph([revision_id])
154
def get_revision_graph_with_ghosts(self, revision_ids=None):
155
"""Return a graph of the revisions with ghosts marked as applicable.
157
:param revision_ids: an iterable of revisions to graph or None for all.
158
:return: a Graph object with the graph reachable from revision_ids.
160
result = deprecated_graph.Graph()
161
vf = self._get_revision_vf()
162
versions = set(vf.versions())
164
pending = set(self.all_revision_ids())
167
pending = set(osutils.safe_revision_id(r) for r in revision_ids)
168
# special case NULL_REVISION
169
if _mod_revision.NULL_REVISION in pending:
170
pending.remove(_mod_revision.NULL_REVISION)
171
required = set(pending)
174
revision_id = pending.pop()
175
if not revision_id in versions:
176
if revision_id in required:
177
raise errors.NoSuchRevision(self, revision_id)
179
result.add_ghost(revision_id)
180
# mark it as done so we don't try for it again.
181
done.add(revision_id)
183
parent_ids = vf.get_parents_with_ghosts(revision_id)
184
for parent_id in parent_ids:
185
# is this queued or done ?
186
if (parent_id not in pending and
187
parent_id not in done):
189
pending.add(parent_id)
190
result.add_node(revision_id, parent_ids)
191
done.add(revision_id)
194
def _get_revision_vf(self):
195
""":return: a versioned file containing the revisions."""
196
vf = self._revision_store.get_revision_file(self.get_transaction())
199
def _get_history_vf(self):
200
"""Get a versionedfile whose history graph reflects all revisions.
202
For knit repositories, this is the revision knit.
204
return self._get_revision_vf()
207
def reconcile(self, other=None, thorough=False):
208
"""Reconcile this repository."""
209
from bzrlib.reconcile import KnitReconciler
210
reconciler = KnitReconciler(self, thorough=thorough)
211
reconciler.reconcile()
214
def revision_parents(self, revision_id):
215
revision_id = osutils.safe_revision_id(revision_id)
216
return self._get_revision_vf().get_parents(revision_id)
218
def _make_parents_provider(self):
219
return _KnitParentsProvider(self._get_revision_vf())
222
class KnitRepository3(KnitRepository):
224
_commit_builder_class = RootCommitBuilder
226
def __init__(self, _format, a_bzrdir, control_files, _revision_store,
227
control_store, text_store):
228
KnitRepository.__init__(self, _format, a_bzrdir, control_files,
229
_revision_store, control_store, text_store)
230
self._serializer = xml7.serializer_v7
232
def deserialise_inventory(self, revision_id, xml):
233
"""Transform the xml into an inventory object.
235
:param revision_id: The expected revision id of the inventory.
236
:param xml: A serialised inventory.
238
result = self._serializer.read_inventory_from_string(xml)
239
assert result.root.revision is not None
242
def serialise_inventory(self, inv):
243
"""Transform the inventory object into XML text.
245
:param revision_id: The expected revision id of the inventory.
246
:param xml: A serialised inventory.
248
assert inv.revision_id is not None
249
assert inv.root.revision is not None
250
return KnitRepository.serialise_inventory(self, inv)
253
class RepositoryFormatKnit(MetaDirRepositoryFormat):
254
"""Bzr repository knit format (generalized).
256
This repository format has:
257
- knits for file texts and inventory
258
- hash subdirectory based stores.
259
- knits for revisions and signatures
260
- TextStores for revisions and signatures.
261
- a format marker of its own
262
- an optional 'shared-storage' flag
263
- an optional 'no-working-trees' flag
267
def _get_control_store(self, repo_transport, control_files):
268
"""Return the control store for this repository."""
269
return VersionedFileStore(
272
file_mode=control_files._file_mode,
273
versionedfile_class=knit.KnitVersionedFile,
274
versionedfile_kwargs={'factory':knit.KnitPlainFactory()},
277
def _get_revision_store(self, repo_transport, control_files):
278
"""See RepositoryFormat._get_revision_store()."""
279
from bzrlib.store.revision.knit import KnitRevisionStore
280
versioned_file_store = VersionedFileStore(
282
file_mode=control_files._file_mode,
285
versionedfile_class=knit.KnitVersionedFile,
286
versionedfile_kwargs={'delta':False,
287
'factory':knit.KnitPlainFactory(),
291
return KnitRevisionStore(versioned_file_store)
293
def _get_text_store(self, transport, control_files):
294
"""See RepositoryFormat._get_text_store()."""
295
return self._get_versioned_file_store('knits',
298
versionedfile_class=knit.KnitVersionedFile,
299
versionedfile_kwargs={
300
'create_parent_dir':True,
302
'dir_mode':control_files._dir_mode,
306
def initialize(self, a_bzrdir, shared=False):
307
"""Create a knit format 1 repository.
309
:param a_bzrdir: bzrdir to contain the new repository; must already
311
:param shared: If true the repository will be initialized as a shared
314
mutter('creating repository in %s.', a_bzrdir.transport.base)
315
dirs = ['revision-store', 'knits']
317
utf8_files = [('format', self.get_format_string())]
319
self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
320
repo_transport = a_bzrdir.get_repository_transport(None)
321
control_files = lockable_files.LockableFiles(repo_transport,
322
'lock', lockdir.LockDir)
323
control_store = self._get_control_store(repo_transport, control_files)
324
transaction = transactions.WriteTransaction()
325
# trigger a write of the inventory store.
326
control_store.get_weave_or_empty('inventory', transaction)
327
_revision_store = self._get_revision_store(repo_transport, control_files)
328
# the revision id here is irrelevant: it will not be stored, and cannot
330
_revision_store.has_revision_id('A', transaction)
331
_revision_store.get_signature_file(transaction)
332
return self.open(a_bzrdir=a_bzrdir, _found=True)
334
def open(self, a_bzrdir, _found=False, _override_transport=None):
335
"""See RepositoryFormat.open().
337
:param _override_transport: INTERNAL USE ONLY. Allows opening the
338
repository at a slightly different url
339
than normal. I.e. during 'upgrade'.
342
format = RepositoryFormat.find_format(a_bzrdir)
343
assert format.__class__ == self.__class__
344
if _override_transport is not None:
345
repo_transport = _override_transport
347
repo_transport = a_bzrdir.get_repository_transport(None)
348
control_files = lockable_files.LockableFiles(repo_transport,
349
'lock', lockdir.LockDir)
350
text_store = self._get_text_store(repo_transport, control_files)
351
control_store = self._get_control_store(repo_transport, control_files)
352
_revision_store = self._get_revision_store(repo_transport, control_files)
353
return KnitRepository(_format=self,
355
control_files=control_files,
356
_revision_store=_revision_store,
357
control_store=control_store,
358
text_store=text_store)
361
class RepositoryFormatKnit1(RepositoryFormatKnit):
362
"""Bzr repository knit format 1.
364
This repository format has:
365
- knits for file texts and inventory
366
- hash subdirectory based stores.
367
- knits for revisions and signatures
368
- TextStores for revisions and signatures.
369
- a format marker of its own
370
- an optional 'shared-storage' flag
371
- an optional 'no-working-trees' flag
374
This format was introduced in bzr 0.8.
377
def __ne__(self, other):
378
return self.__class__ is not other.__class__
380
def get_format_string(self):
381
"""See RepositoryFormat.get_format_string()."""
382
return "Bazaar-NG Knit Repository Format 1"
384
def get_format_description(self):
385
"""See RepositoryFormat.get_format_description()."""
386
return "Knit repository format 1"
388
def check_conversion_target(self, target_format):
392
class RepositoryFormatKnit3(RepositoryFormatKnit):
393
"""Bzr repository knit format 2.
395
This repository format has:
396
- knits for file texts and inventory
397
- hash subdirectory based stores.
398
- knits for revisions and signatures
399
- TextStores for revisions and signatures.
400
- a format marker of its own
401
- an optional 'shared-storage' flag
402
- an optional 'no-working-trees' flag
404
- support for recording full info about the tree root
405
- support for recording tree-references
408
repository_class = KnitRepository3
409
rich_root_data = True
410
supports_tree_reference = True
412
def _get_matching_bzrdir(self):
413
return bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
415
def _ignore_setting_bzrdir(self, format):
418
_matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
420
def check_conversion_target(self, target_format):
421
if not target_format.rich_root_data:
422
raise errors.BadConversionTarget(
423
'Does not support rich root data.', target_format)
424
if not getattr(target_format, 'supports_tree_reference', False):
425
raise errors.BadConversionTarget(
426
'Does not support nested trees', target_format)
428
def get_format_string(self):
429
"""See RepositoryFormat.get_format_string()."""
430
return "Bazaar Knit Repository Format 3 (bzr 0.15)\n"
432
def get_format_description(self):
433
"""See RepositoryFormat.get_format_description()."""
434
return "Knit repository format 3"
436
def open(self, a_bzrdir, _found=False, _override_transport=None):
437
"""See RepositoryFormat.open().
439
:param _override_transport: INTERNAL USE ONLY. Allows opening the
440
repository at a slightly different url
441
than normal. I.e. during 'upgrade'.
444
format = RepositoryFormat.find_format(a_bzrdir)
445
assert format.__class__ == self.__class__
446
if _override_transport is not None:
447
repo_transport = _override_transport
449
repo_transport = a_bzrdir.get_repository_transport(None)
450
control_files = lockable_files.LockableFiles(repo_transport, 'lock',
452
text_store = self._get_text_store(repo_transport, control_files)
453
control_store = self._get_control_store(repo_transport, control_files)
454
_revision_store = self._get_revision_store(repo_transport, control_files)
455
return self.repository_class(_format=self,
457
control_files=control_files,
458
_revision_store=_revision_store,
459
control_store=control_store,
460
text_store=text_store)
463
def _get_stream_as_bytes(knit, required_versions):
464
"""Generate a serialised data stream.
466
The format is a bencoding of a list. The first element of the list is a
467
string of the format signature, then each subsequent element is a list
468
corresponding to a record. Those lists contain:
475
:returns: a bencoded list.
477
knit_stream = knit.get_data_stream(required_versions)
478
format_signature, data_list, callable = knit_stream
480
data.append(format_signature)
481
for version, options, length, parents in data_list:
482
data.append([version, options, parents, callable(length)])
483
return bencode.bencode(data)
added
removed
bzrlib/repofmt/knitrepo.py
