22
23
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
23
24
__author__ = "Martin Pool <mbp@canonical.com>"
25
import os, tempfile, types, osutils, gzip, errno
26
from stat import ST_SIZE
26
import os, tempfile, types, osutils
27
27
from StringIO import StringIO
28
28
from trace import mutter
30
31
######################################################################
57
58
>>> st['123123'].read()
60
TODO: Atomic add by writing to a temporary file and renaming.
61
:todo: Atomic add by writing to a temporary file and renaming.
62
TODO: Perhaps automatically transform to/from XML in a method?
63
:todo: Perhaps automatically transform to/from XML in a method?
63
64
Would just need to tell the constructor what class to
66
TODO: Even within a simple disk store like this, we could
67
:todo: Even within a simple disk store like this, we could
67
68
gzip the files. But since many are less than one disk
68
69
block, that might not help a lot.
74
75
self._basedir = basedir
76
77
def _path(self, id):
78
78
return os.path.join(self._basedir, id)
80
80
def __repr__(self):
81
81
return "%s(%r)" % (self.__class__.__name__, self._basedir)
83
def add(self, f, fileid, compressed=True):
83
def add(self, f, fileid):
84
84
"""Add contents of a file into the store.
86
f -- An open file, or file-like object."""
86
:param f: An open file, or file-like object."""
87
87
# FIXME: Only works on smallish files
88
88
# TODO: Can be optimized by copying at the same time as
89
89
# computing the sum.
96
p = self._path(fileid)
97
if os.access(p, os.F_OK) or os.access(p + '.gz', os.F_OK):
98
bailout("store %r already contains id %r" % (self._basedir, fileid))
101
f = gzip.GzipFile(p + '.gz', 'wb')
102
os.chmod(p + '.gz', 0444)
95
if fileid not in self:
96
filename = self._path(fileid)
97
f = file(filename, 'wb')
102
osutils.make_readonly(filename)
111
105
def __contains__(self, fileid):
113
p = self._path(fileid)
114
return (os.access(p, os.R_OK)
115
or os.access(p + '.gz', os.R_OK))
107
return os.access(self._path(fileid), os.R_OK)
117
# TODO: Guard against the same thing being stored twice, compressed and uncompresse
119
110
def __iter__(self):
120
for f in os.listdir(self._basedir):
122
# TODO: case-insensitive?
128
return len(os.listdir(self._basedir))
111
return iter(os.listdir(self._basedir))
130
113
def __getitem__(self, fileid):
131
114
"""Returns a file reading from a particular entry."""
132
p = self._path(fileid)
134
return gzip.GzipFile(p + '.gz', 'rb')
136
if e.errno == errno.ENOENT:
141
def total_size(self):
142
"""Return (count, bytes)
144
This is the (compressed) size stored on disk, not the size of
152
total += os.stat(p)[ST_SIZE]
154
total += os.stat(p + '.gz')[ST_SIZE]
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)
168
143
ImmutableStore.__init__(self, tempfile.mkdtemp())
170
145
def __del__(self):
171
for f in os.listdir(self._basedir):
172
fpath = os.path.join(self._basedir, f)
173
# needed on windows, and maybe some other filesystems
174
os.chmod(fpath, 0600)
176
os.rmdir(self._basedir)
177
mutter("%r destroyed" % self)