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
17
"""Stores are the main data-storage mechanism for Bazaar-NG.
19
A store is a simple write-once container indexed by a universally
20
unique ID, which is typically the SHA-1 of the content."""
22
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
23
__author__ = "Martin Pool <mbp@canonical.com>"
25
import os, tempfile, types, osutils, gzip, errno
26
from stat import ST_SIZE
27
from StringIO import StringIO
28
from trace import mutter
30
######################################################################
33
class StoreError(Exception):
37
class ImmutableStore(object):
38
"""Store that holds files indexed by unique names.
40
Files can be added, but not modified once they are in. Typically
41
the hash is used as the name, or something else known to be unique,
44
>>> st = ImmutableScratchStore()
46
>>> st.add(StringIO('hello'), 'aa')
52
You are not allowed to add an id that is already present.
54
Entries can be retrieved as files, which may then be read.
56
>>> st.add(StringIO('goodbye'), '123123')
57
>>> st['123123'].read()
60
TODO: Atomic add by writing to a temporary file and renaming.
62
TODO: Perhaps automatically transform to/from XML in a method?
63
Would just need to tell the constructor what class to
66
TODO: Even within a simple disk store like this, we could
67
gzip the files. But since many are less than one disk
68
block, that might not help a lot.
72
def __init__(self, basedir):
73
"""ImmutableStore constructor."""
74
self._basedir = basedir
78
return os.path.join(self._basedir, id)
81
return "%s(%r)" % (self.__class__.__name__, self._basedir)
83
def add(self, f, fileid, compressed=True):
84
"""Add contents of a file into the store.
86
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):
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)
111
def copy_multi(self, other, ids):
112
"""Copy texts for ids from other into self.
114
If an id is present in self, it is skipped. A count of copied
115
ids is returned, which may be less than len(ids).
117
from bzrlib.progress import ProgressBar
119
pb.update('preparing to copy')
120
to_copy = [id for id in ids if id not in self]
124
pb.update('copy', count, len(to_copy))
125
self.add(other[id], id)
126
assert count == len(to_copy)
131
def __contains__(self, fileid):
133
p = self._path(fileid)
134
return (os.access(p, os.R_OK)
135
or os.access(p + '.gz', os.R_OK))
137
# TODO: Guard against the same thing being stored twice, compressed and uncompresse
140
for f in os.listdir(self._basedir):
142
# TODO: case-insensitive?
148
return len(os.listdir(self._basedir))
150
def __getitem__(self, fileid):
151
"""Returns a file reading from a particular entry."""
152
p = self._path(fileid)
154
return gzip.GzipFile(p + '.gz', 'rb')
156
if e.errno == errno.ENOENT:
161
def total_size(self):
162
"""Return (count, bytes)
164
This is the (compressed) size stored on disk, not the size of
172
total += os.stat(p)[ST_SIZE]
174
total += os.stat(p + '.gz')[ST_SIZE]
181
class ImmutableScratchStore(ImmutableStore):
182
"""Self-destructing test subclass of ImmutableStore.
184
The Store only exists for the lifetime of the Python object.
185
Obviously you should not put anything precious in it.
188
ImmutableStore.__init__(self, tempfile.mkdtemp())
191
for f in os.listdir(self._basedir):
192
fpath = os.path.join(self._basedir, f)
193
# needed on windows, and maybe some other filesystems
194
os.chmod(fpath, 0600)
196
os.rmdir(self._basedir)
197
mutter("%r destroyed" % self)
added
removed
bzrlib/store.py
