1
# Copyright (C) 2005 by Canonical Development 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
18
A store that keeps the full text of every version.
20
This store keeps uncompressed versions of the full text. It does not
21
do any sort of delta compression.
27
from bzrlib.store import hash_prefix
28
from bzrlib.trace import mutter
29
from bzrlib.errors import BzrError, FileExists
31
from cStringIO import StringIO
32
from stat import ST_SIZE, ST_MODE, S_ISDIR
35
class TextStore(bzrlib.store.TransportStore):
36
"""Store that holds files indexed by unique names.
38
Files can be added, but not modified once they are in. Typically
39
the hash is used as the name, or something else known to be unique,
42
Files are stored uncompressed, with no delta compression.
45
def __init__(self, transport, prefixed=False):
46
super(TextStore, self).__init__(transport)
47
self._prefixed = prefixed
49
def _check_fileid(self, fileid):
50
if not isinstance(fileid, basestring):
51
raise TypeError('Fileids should be a string type: %s %r' % (type(fileid), fileid))
52
if '\\' in fileid or '/' in fileid:
53
raise ValueError("invalid store id %r" % fileid)
55
def _relpath(self, fileid):
56
self._check_fileid(fileid)
58
return hash_prefix(fileid) + fileid
62
def add(self, f, fileid):
63
"""Add contents of a file into the store.
65
f -- A file-like object, or string
67
mutter("add store entry %r" % (fileid))
69
fn = self._relpath(fileid)
70
if self._transport.has(fn):
71
raise BzrError("store %r already contains id %r" % (self._transport.base, fileid))
75
self._transport.mkdir(hash_prefix(fileid))
79
self._transport.put(fn, f)
81
def __contains__(self, fileid):
83
fn = self._relpath(fileid)
84
return self._transport.has(fn)
86
def has(self, fileids, pb=None):
87
"""Return True/False for each entry in fileids.
89
:param fileids: A List or generator yielding file ids.
90
:return: A generator or list returning True/False for each entry.
92
relpaths = (self._relpath(fid) for fid in fileids)
93
return self._transport.has_multi(relpaths, pb=pb)
95
def get(self, fileids, permit_failure=False, pb=None):
96
"""Return a set of files, one for each requested entry.
98
TODO: Write some tests to make sure that permit_failure is
101
TODO: What should the exception be for a missing file?
102
KeyError, or NoSuchFile?
105
# This next code gets a bit hairy because it can allow
106
# to not request a file which doesn't seem to exist.
107
# Also, the same fileid may be requested twice, so we
108
# can't just build up a map.
109
rel_paths = [self._relpath(fid) for fid in fileids]
114
for path, has in zip(rel_paths,
115
self._transport.has_multi(rel_paths)):
117
existing_paths.append(path)
118
is_requested.append(True)
120
is_requested.append(False)
121
#mutter('Retrieving %s out of %s' % (existing_paths, rel_paths))
123
#mutter('Retrieving all %s' % (rel_paths, ))
124
existing_paths = rel_paths
125
is_requested = [True for x in rel_paths]
128
for f in self._transport.get_multi(existing_paths, pb=pb):
129
assert count < len(is_requested)
130
while not is_requested[count]:
136
while count < len(is_requested):
140
def _iter_relpaths(self):
141
transport = self._transport
142
queue = list(transport.list_dir('.'))
144
relpath = queue.pop(0)
145
st = transport.stat(relpath)
146
if S_ISDIR(st[ST_MODE]):
147
for i, basename in enumerate(transport.list_dir(relpath)):
148
queue.insert(i, relpath+'/'+basename)
153
for relpath, st in self._iter_relpaths():
154
yield os.path.basename(relpath)
157
return len(list(self._iter_relpath()))
159
def __getitem__(self, fileid):
160
"""Returns a file reading from a particular entry."""
161
fn = self._relpath(fileid)
162
# This will throw if the file doesn't exist.
164
f = self._transport.get(fn)
166
raise KeyError('This store (%s) does not contain %s' % (self, fileid))
171
def total_size(self):
172
"""Return (count, bytes)
174
This is the (compressed) size stored on disk, not the size of
178
for relpath, st in self._iter_relpaths():
185
class ScratchTextStore(TextStore):
186
"""Self-destructing test subclass of TextStore.
188
The Store only exists for the lifetime of the Python object.
189
Obviously you should not put anything precious in it.
192
from transport import transport
193
super(ScratchTextStore, self).__init__(transport(tempfile.mkdtemp()))
196
self._transport.delete_multi(self._transport.list_dir('.'))
197
os.rmdir(self._transport.base)
198
mutter("%r destroyed" % self)
added
removed
bzrlib/store/text.py
