15
14
# along with this program; if not, write to the Free Software
16
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
"""Stores are the main data-storage mechanism for Bazaar-NG.
18
Stores are the main data-storage mechanism for Bazaar-NG.
20
20
A store is a simple write-once container indexed by a universally
21
unique ID, which is typically the SHA-1 of the content."""
23
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
24
__author__ = "Martin Pool <mbp@canonical.com>"
26
import os, tempfile, types, osutils
24
import os, tempfile, types, osutils, gzip, errno
25
from stat import ST_SIZE
27
26
from StringIO import StringIO
28
27
from trace import mutter
31
29
######################################################################
58
56
>>> 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.
59
TODO: Atomic add by writing to a temporary file and renaming.
61
In bzr 0.0.5 and earlier, files within the store were marked
62
readonly on disk. This is no longer done but existing stores need
73
66
def __init__(self, basedir):
74
"""ImmutableStore constructor."""
75
67
self._basedir = basedir
77
69
def _path(self, id):
70
if '\\' in id or '/' in id:
71
raise ValueError("invalid store id %r" % id)
78
72
return os.path.join(self._basedir, id)
80
74
def __repr__(self):
81
75
return "%s(%r)" % (self.__class__.__name__, self._basedir)
83
def add(self, f, fileid):
77
def add(self, f, fileid, compressed=True):
84
78
"""Add contents of a file into the store.
86
:param f: An open file, or file-like object."""
80
f -- An open file, or file-like object."""
87
81
# FIXME: Only works on smallish files
88
82
# TODO: Can be optimized by copying at the same time as
89
83
# computing the sum.
95
if fileid not in self:
96
filename = self._path(fileid)
97
f = file(filename, 'wb')
102
osutils.make_readonly(filename)
90
p = self._path(fileid)
91
if os.access(p, os.F_OK) or os.access(p + '.gz', os.F_OK):
92
raise BzrError("store %r already contains id %r" % (self._basedir, fileid))
95
f = gzip.GzipFile(p + '.gz', 'wb')
103
def copy_multi(self, other, ids):
104
"""Copy texts for ids from other into self.
106
If an id is present in self, it is skipped. A count of copied
107
ids is returned, which may be less than len(ids).
109
from bzrlib.progress import ProgressBar
111
pb.update('preparing to copy')
112
to_copy = [id for id in ids if id not in self]
116
pb.update('copy', count, len(to_copy))
117
self.add(other[id], id)
118
assert count == len(to_copy)
105
123
def __contains__(self, fileid):
107
return os.access(self._path(fileid), os.R_OK)
125
p = self._path(fileid)
126
return (os.access(p, os.R_OK)
127
or os.access(p + '.gz', os.R_OK))
129
# TODO: Guard against the same thing being stored twice, compressed and uncompresse
110
131
def __iter__(self):
111
return iter(os.listdir(self._basedir))
132
for f in os.listdir(self._basedir):
134
# TODO: case-insensitive?
140
return len(os.listdir(self._basedir))
113
142
def __getitem__(self, fileid):
114
143
"""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)
144
p = self._path(fileid)
146
return gzip.GzipFile(p + '.gz', 'rb')
148
if e.errno == errno.ENOENT:
153
def total_size(self):
154
"""Return (count, bytes)
156
This is the (compressed) size stored on disk, not the size of
164
total += os.stat(p)[ST_SIZE]
166
total += os.stat(p + '.gz')[ST_SIZE]
137
174
"""Self-destructing test subclass of ImmutableStore.
139
176
The Store only exists for the lifetime of the Python object.
140
Obviously you should not put anything precious in it.
177
Obviously you should not put anything precious in it.
142
179
def __init__(self):
143
180
ImmutableStore.__init__(self, tempfile.mkdtemp())
145
182
def __del__(self):
183
for f in os.listdir(self._basedir):
184
fpath = os.path.join(self._basedir, f)
185
# needed on windows, and maybe some other filesystems
186
os.chmod(fpath, 0600)
188
os.rmdir(self._basedir)
189
mutter("%r destroyed" % self)
added
removed
bzrlib/store.py
