56
"""This class represents the abstract storage layout for saving information.
39
"""Store that holds files indexed by unique names.
58
41
Files can be added, but not modified once they are in. Typically
59
42
the hash is used as the name, or something else known to be unique,
45
>>> st = ImmutableScratchStore()
47
>>> st.add(StringIO('hello'), 'aa')
53
You are not allowed to add an id that is already present.
55
Entries can be retrieved as files, which may then be read.
57
>>> st.add(StringIO('goodbye'), '123123')
58
>>> st['123123'].read()
61
:todo: Atomic add by writing to a temporary file and renaming.
63
:todo: Perhaps automatically transform to/from XML in a method?
64
Would just need to tell the constructor what class to
67
:todo: Even within a simple disk store like this, we could
68
gzip the files. But since many are less than one disk
69
block, that might not help a lot.
64
raise NotImplementedError('Children should define their length')
66
def get(self, fileid, suffix=None):
67
"""Returns a file reading from a particular entry.
69
If suffix is present, retrieve the named suffix for fileid.
71
raise NotImplementedError
73
def __getitem__(self, fileid):
74
"""DEPRECATED. Please use .get(fileid) instead."""
75
raise NotImplementedError
77
#def __contains__(self, fileid):
78
# """Deprecated, please use has_id"""
79
# raise NotImplementedError
82
raise NotImplementedError
73
def __init__(self, basedir):
74
"""ImmutableStore constructor."""
75
self._basedir = basedir
78
return os.path.join(self._basedir, id)
81
return "%s(%r)" % (self.__class__.__name__, self._basedir)
84
83
def add(self, f, fileid):
85
"""Add a file object f to the store accessible from the given fileid"""
86
raise NotImplementedError('Children of Store must define their method of adding entries.')
88
def has_id(self, fileid, suffix=None):
89
"""Return True or false for the presence of fileid in the store.
91
suffix, if present, is a per file suffix, i.e. for digital signature
93
raise NotImplementedError
96
"""Return True if this store is able to be listed."""
97
return (getattr(self, "__iter__", None) is not None)
99
def copy_all_ids(self, store_from, pb=None):
100
"""Copy all the file ids from store_from into self."""
101
if not store_from.listable():
102
raise UnlistableStore(store_from)
104
for count, file_id in enumerate(store_from):
106
pb.update('listing files', count, count)
110
mutter('copy_all ids: %r', ids)
111
self.copy_multi(store_from, ids, pb=pb)
113
def copy_multi(self, other, ids, pb=None, permit_failure=False):
114
"""Copy texts for ids from other into self.
116
If an id is present in self, it is skipped. A count of copied
117
ids is returned, which may be less than len(ids).
119
:param other: Another Store object
120
:param ids: A list of entry ids to be copied
121
:param pb: A ProgressBar object, if none is given, the default will be created.
122
:param permit_failure: Allow missing entries to be ignored
123
:return: (n_copied, [failed]) The number of entries copied successfully,
124
followed by a list of entries which could not be copied (because they
128
pb.update('preparing to copy')
131
ids = list(ids) # get the list for showing a length.
134
if self.has_id(fileid):
137
self._copy_one(fileid, None, other, pb)
138
for suffix in self._suffixes:
140
self._copy_one(fileid, suffix, other, pb)
144
pb.update('copy', count, len(ids))
150
assert count == len(ids)
155
def _copy_one(self, fileid, suffix, other, pb):
156
"""Most generic copy-one object routine.
158
Subclasses can override this to provide an optimised
159
copy between their own instances. Such overriden routines
160
should call this if they have no optimised facility for a
163
mutter('Store._copy_one: %r', fileid)
164
f = other.get(fileid, suffix)
165
self.add(f, fileid, suffix)
168
class TransportStore(Store):
169
"""A TransportStore is a Store superclass for Stores that use Transports."""
171
def add(self, f, fileid, suffix=None):
172
84
"""Add contents of a file into the store.
174
f -- A file-like object
176
mutter("add store entry %r", fileid)
177
if isinstance(f, str):
178
symbol_versioning.warn(zero_eleven % 'Passing a string to Store.add',
179
DeprecationWarning, stacklevel=2)
182
names = self._id_to_names(fileid, suffix)
183
if self._transport.has_any(names):
184
raise BzrError("store %r already contains id %r"
185
% (self._transport.base, fileid))
187
# Most of the time, just adding the file will work
188
# if we find a time where it fails, (because the dir
189
# doesn't exist), then create the dir, and try again
190
self._add(names[0], f)
192
def _add(self, relpath, f):
193
"""Actually add the file to the given location.
194
This should be overridden by children.
196
raise NotImplementedError('children need to implement this function.')
198
def _check_fileid(self, fileid):
199
if not isinstance(fileid, basestring):
200
raise TypeError('Fileids should be a string type: %s %r' % (type(fileid), fileid))
201
if '\\' in fileid or '/' in fileid:
202
raise ValueError("invalid store id %r" % fileid)
204
def _id_to_names(self, fileid, suffix):
205
"""Return the names in the expected order"""
206
if suffix is not None:
207
fn = self._relpath(fileid, [suffix])
209
fn = self._relpath(fileid)
211
# FIXME RBC 20051128 this belongs in TextStore.
218
def has_id(self, fileid, suffix=None):
219
"""See Store.has_id."""
220
return self._transport.has_any(self._id_to_names(fileid, suffix))
222
def _get_name(self, fileid, suffix=None):
223
"""A special check, which returns the name of an existing file.
225
This is similar in spirit to 'has_id', but it is designed
226
to return information about which file the store has.
228
for name in self._id_to_names(fileid, suffix=suffix):
229
if self._transport.has(name):
233
def _get(self, filename):
234
"""Return an vanilla file stream for clients to read from.
236
This is the body of a template method on 'get', and should be
237
implemented by subclasses.
239
raise NotImplementedError
241
def get(self, fileid, suffix=None):
242
"""See Store.get()."""
243
names = self._id_to_names(fileid, suffix)
246
return self._get(name)
247
except errors.NoSuchFile:
249
raise KeyError(fileid)
251
def __init__(self, a_transport, prefixed=False, compressed=False,
252
dir_mode=None, file_mode=None,
254
assert isinstance(a_transport, Transport)
255
super(TransportStore, self).__init__()
256
self._transport = a_transport
257
self._prefixed = prefixed
258
# FIXME RBC 20051128 this belongs in TextStore.
259
self._compressed = compressed
260
self._suffixes = set()
261
self._escaped = escaped
263
# It is okay for these to be None, it just means they
264
# will just use the filesystem defaults
265
self._dir_mode = dir_mode
266
self._file_mode = file_mode
268
def _unescape(self, file_id):
269
"""If filename escaping is enabled for this store, unescape and return the filename."""
271
return urllib.unquote(file_id)
275
def _iter_files_recursive(self):
276
"""Iterate through the files in the transport."""
277
for quoted_relpath in self._transport.iter_files_recursive():
278
# transport iterator always returns quoted paths, regardless of
280
yield urllib.unquote(quoted_relpath)
86
:param f: An open file, or file-like object."""
87
# FIXME: Only works on smallish files
88
# TODO: Can be optimized by copying at the same time as
90
mutter("add store entry %r" % (fileid))
91
if isinstance(f, types.StringTypes):
95
if fileid not in self:
96
filename = self._path(fileid)
97
f = file(filename, 'wb')
102
osutils.make_readonly(filename)
105
def __contains__(self, fileid):
107
return os.access(self._path(fileid), os.R_OK)
282
110
def __iter__(self):
283
for relpath in self._iter_files_recursive():
284
# worst case is one of each suffix.
285
name = os.path.basename(relpath)
286
if name.endswith('.gz'):
289
for count in range(len(self._suffixes)):
290
for suffix in self._suffixes:
291
if name.endswith('.' + suffix):
294
yield self._unescape(name)
297
return len(list(self.__iter__()))
299
def _relpath(self, fileid, suffixes=None):
300
self._check_fileid(fileid)
302
for suffix in suffixes:
303
if not suffix in self._suffixes:
304
raise ValueError("Unregistered suffix %r" % suffix)
305
self._check_fileid(suffix)
308
fileid = self._escape_file_id(fileid)
310
# hash_prefix adds the '/' separator
311
prefix = self.hash_prefix(fileid, escaped=True)
314
path = prefix + fileid
315
full_path = u'.'.join([path] + suffixes)
316
return urlutils.escape(full_path)
318
def _escape_file_id(self, file_id):
319
"""Turn a file id into a filesystem safe string.
321
This is similar to a plain urllib.quote, except
322
it uses specific safe characters, so that it doesn't
323
have to translate a lot of valid file ids.
325
if not self._escaped:
327
if isinstance(file_id, unicode):
328
file_id = file_id.encode('utf-8')
329
# @ does not get escaped. This is because it is a valid
330
# filesystem character we use all the time, and it looks
331
# a lot better than seeing %40 all the time.
332
safe = "abcdefghijklmnopqrstuvwxyz0123456789-_@,."
333
r = [((c in safe) and c or ('%%%02x' % ord(c)))
337
def hash_prefix(self, fileid, escaped=False):
338
# fileid should be unescaped
339
if not escaped and self._escaped:
340
fileid = self._escape_file_id(fileid)
341
return "%02x/" % (adler32(fileid) & 0xff)
344
if self._transport is None:
345
return "%s(None)" % (self.__class__.__name__)
347
return "%s(%r)" % (self.__class__.__name__, self._transport.base)
352
"""Return True if this store is able to be listed."""
353
return self._transport.listable()
355
def register_suffix(self, suffix):
356
"""Register a suffix as being expected in this store."""
357
self._check_fileid(suffix)
359
raise ValueError('You cannot register the "gz" suffix.')
360
self._suffixes.add(suffix)
362
def total_size(self):
363
"""Return (count, bytes)
365
This is the (compressed) size stored on disk, not the size of
369
for relpath in self._transport.iter_files_recursive():
371
total += self._transport.stat(relpath).st_size
376
@deprecated_function(zero_eight)
377
def copy_all(store_from, store_to, pb=None):
378
"""Copy all ids from one store to another."""
379
store_to.copy_all_ids(store_from, pb)
111
return iter(os.listdir(self._basedir))
113
def __getitem__(self, fileid):
114
"""Returns a file reading from a particular entry."""
115
return file(self._path(fileid), 'rb')
117
def delete_all(self):
121
def delete(self, fileid):
122
"""Remove nominated store entry.
124
Most stores will be add-only."""
125
filename = self._path(fileid)
126
## osutils.make_writable(filename)
130
"""Remove store; only allowed if it is empty."""
131
os.rmdir(self._basedir)
132
mutter("%r destroyed" % self)
136
class ImmutableScratchStore(ImmutableStore):
137
"""Self-destructing test subclass of ImmutableStore.
139
The Store only exists for the lifetime of the Python object.
140
Obviously you should not put anything precious in it.
143
ImmutableStore.__init__(self, tempfile.mkdtemp())
added
removed
bzrlib/store.py
