1
# Copyright (C) 2006 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
"""VersionedFile based revision store.
19
This stores revisions as individual entries in a knit, and signatures in a
24
from bzrlib import errors, osutils
25
from bzrlib.knit import KnitVersionedFile, KnitPlainFactory
26
from bzrlib.store.revision import RevisionStore
27
from bzrlib.store.versioned import VersionedFileStore
28
from bzrlib.transport import get_transport
31
class KnitRevisionStoreFactory(object):
32
"""Factory to create a KnitRevisionStore for testing."""
34
def create(self, url):
35
"""Create a revision store at url."""
36
t = get_transport(url)
37
t.mkdir('revision-store')
38
versioned_file_store = VersionedFileStore(
39
t.clone('revision-store'),
41
versionedfile_class=KnitVersionedFile,
42
versionedfile_kwargs={'delta':False, 'factory':KnitPlainFactory()})
43
return KnitRevisionStore(versioned_file_store)
46
return "KnitRevisionStore"
49
class KnitRevisionStore(RevisionStore):
50
"""A RevisionStore layering on a VersionedFileStore."""
52
def __init__(self, versioned_file_store):
53
"""Create a KnitRevisionStore object.
55
:param versioned_file_store: the text store to use for storing
56
revisions and signatures.
58
super(KnitRevisionStore, self).__init__()
59
self.versioned_file_store = versioned_file_store
61
def _add_revision(self, revision, revision_as_file, transaction):
62
"""Template method helper to store revision in this store."""
63
# FIXME: make this ghost aware at the knit level
64
rf = self.get_revision_file(transaction)
65
self.get_revision_file(transaction).add_lines_with_ghosts(
68
osutils.split_lines(revision_as_file.read()))
70
def add_revision_signature_text(self, revision_id, signature_text, transaction):
71
"""See RevisionStore.add_revision_signature_text()."""
72
revision_id = osutils.safe_revision_id(revision_id)
73
self.get_signature_file(transaction).add_lines(
74
revision_id, [], osutils.split_lines(signature_text))
76
def all_revision_ids(self, transaction):
77
"""See RevisionStore.all_revision_ids()."""
78
rev_file = self.get_revision_file(transaction)
79
return rev_file.get_ancestry(rev_file.versions())
81
def get_revisions(self, revision_ids, transaction):
82
"""See RevisionStore.get_revisions()."""
83
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
84
texts = self._get_serialized_revisions(revision_ids, transaction)
87
for text, revision_id in zip(texts, revision_ids):
88
r = self._serializer.read_revision_from_string(text)
89
assert r.revision_id == revision_id
91
except SyntaxError, e:
92
raise errors.BzrError('failed to unpack revision_xml for %s: %s' %
93
(revision_id, str(e)))
96
def _get_serialized_revisions(self, revision_ids, transaction):
98
vf = self.get_revision_file(transaction)
100
return vf.get_texts(revision_ids)
101
except (errors.RevisionNotPresent), e:
102
raise errors.NoSuchRevision(self, e.revision_id)
104
def _get_revision_xml(self, revision_id, transaction):
106
return self.get_revision_file(transaction).get_text(revision_id)
107
except (errors.RevisionNotPresent):
108
raise errors.NoSuchRevision(self, revision_id)
110
def get_revision_file(self, transaction):
111
"""Get the revision versioned file object."""
112
return self.versioned_file_store.get_weave_or_empty('revisions', transaction)
114
def get_signature_file(self, transaction):
115
"""Get the signature text versioned file object."""
116
return self.versioned_file_store.get_weave_or_empty('signatures', transaction)
118
def _get_signature_text(self, revision_id, transaction):
119
"""See RevisionStore._get_signature_text()."""
121
return self.get_signature_file(transaction).get_text(revision_id)
122
except errors.RevisionNotPresent:
123
raise errors.NoSuchRevision(self, revision_id)
125
def has_revision_id(self, revision_id, transaction):
126
"""True if the store contains revision_id."""
127
revision_id = osutils.safe_revision_id(revision_id)
128
return (revision_id is None
129
or self.get_revision_file(transaction).has_version(revision_id))
131
def _has_signature(self, revision_id, transaction):
132
"""See RevisionStore._has_signature()."""
133
return self.get_signature_file(transaction).has_version(revision_id)
135
def total_size(self, transaction):
136
""" See RevisionStore.total_size()."""
137
return (len(self.all_revision_ids(transaction)),
138
self.versioned_file_store.total_size()[1])