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
Stores are the main data-storage mechanism for Bazaar-NG.
20
A store is a simple write-once container indexed by a universally
24
import os, tempfile, types, osutils, gzip, errno
25
from stat import ST_SIZE
26
from StringIO import StringIO
27
from bzrlib.errors import BzrError
28
from bzrlib.trace import mutter
31
######################################################################
34
class StoreError(Exception):
39
"""An abstract store that holds files indexed by unique names.
41
Files can be added, but not modified once they are in. Typically
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()
63
"""Return (count, bytes)
65
This is the (compressed) size stored on disk, not the size of
71
total += self._item_size(fid)
75
class ImmutableStore(Store):
76
"""Store that stores files on disk.
78
TODO: Atomic add by writing to a temporary file and renaming.
79
TODO: Guard against the same thing being stored twice, compressed and
80
uncompressed during copy_multi_immutable - the window is for a
81
matching store with some crack code that lets it offer a
82
non gz FOO and then a fz FOO.
84
In bzr 0.0.5 and earlier, files within the store were marked
85
readonly on disk. This is no longer done but existing stores need
89
def __init__(self, basedir):
90
super(ImmutableStore, self).__init__()
91
self._basedir = basedir
94
if '\\' in id or '/' in id:
95
raise ValueError("invalid store id %r" % id)
96
return os.path.join(self._basedir, id)
99
return "%s(%r)" % (self.__class__.__name__, self._basedir)
101
def add(self, f, fileid, compressed=True):
102
"""Add contents of a file into the store.
104
f -- An open file, or file-like object."""
105
# FIXME: Only works on files that will fit in memory
107
from bzrlib.atomicfile import AtomicFile
109
mutter("add store entry %r" % (fileid))
110
if isinstance(f, types.StringTypes):
115
p = self._path(fileid)
116
if os.access(p, os.F_OK) or os.access(p + '.gz', os.F_OK):
117
raise BzrError("store %r already contains id %r" % (self._basedir, fileid))
123
af = AtomicFile(fn, 'wb')
126
gf = gzip.GzipFile(mode='wb', fileobj=af)
136
def copy_multi(self, other, ids, permit_failure=False):
137
"""Copy texts for ids from other into self.
139
If an id is present in self, it is skipped.
141
Returns (count_copied, failed), where failed is a collection of ids
142
that could not be copied.
144
pb = bzrlib.ui.ui_factory.progress_bar()
146
pb.update('preparing to copy')
147
to_copy = [id for id in ids if id not in self]
148
if isinstance(other, ImmutableStore):
149
return self.copy_multi_immutable(other, to_copy, pb)
154
pb.update('copy', count, len(to_copy))
155
if not permit_failure:
156
self.add(other[id], id)
165
if not permit_failure:
166
assert count == len(to_copy)
170
def copy_multi_immutable(self, other, to_copy, pb, permit_failure=False):
171
from shutil import copyfile
176
other_p = other._path(id)
180
if e.errno == errno.ENOENT:
181
if not permit_failure:
182
copyfile(other_p+".gz", p+".gz")
185
copyfile(other_p+".gz", p+".gz")
187
if e.errno == errno.ENOENT:
195
pb.update('copy', count, len(to_copy))
196
assert count == len(to_copy)
200
def __contains__(self, fileid):
202
p = self._path(fileid)
203
return (os.access(p, os.R_OK)
204
or os.access(p + '.gz', os.R_OK))
206
def _item_size(self, fid):
209
return os.stat(p)[ST_SIZE]
211
return os.stat(p + '.gz')[ST_SIZE]
214
for f in os.listdir(self._basedir):
216
# TODO: case-insensitive?
222
return len(os.listdir(self._basedir))
224
def __getitem__(self, fileid):
225
"""Returns a file reading from a particular entry."""
226
p = self._path(fileid)
228
return gzip.GzipFile(p + '.gz', 'rb')
230
if e.errno != errno.ENOENT:
236
if e.errno != errno.ENOENT:
239
raise IndexError(fileid)
242
class ImmutableScratchStore(ImmutableStore):
243
"""Self-destructing test subclass of ImmutableStore.
245
The Store only exists for the lifetime of the Python object.
246
Obviously you should not put anything precious in it.
249
super(ImmutableScratchStore, self).__init__(tempfile.mkdtemp())
252
for f in os.listdir(self._basedir):
253
fpath = os.path.join(self._basedir, f)
254
# needed on windows, and maybe some other filesystems
255
os.chmod(fpath, 0600)
257
os.rmdir(self._basedir)
258
mutter("%r destroyed" % self)
261
class ImmutableMemoryStore(Store):
262
"""A memory only store."""
265
super(ImmutableMemoryStore, self).__init__()
268
def add(self, stream, fileid, compressed=True):
269
if self._contents.has_key(fileid):
270
raise StoreError("fileid %s already in the store" % fileid)
271
self._contents[fileid] = stream.read()
273
def __getitem__(self, fileid):
274
"""Returns a file reading from a particular entry."""
275
if not self._contents.has_key(fileid):
277
return StringIO(self._contents[fileid])
279
def _item_size(self, fileid):
280
return len(self._contents[fileid])
283
return iter(self._contents.keys())
added
removed
bzrlib/store.py
