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 trace import mutter
29
######################################################################
32
class StoreError(Exception):
36
class ImmutableStore(object):
37
"""Store that holds files indexed by unique names.
39
Files can be added, but not modified once they are in. Typically
40
the hash is used as the name, or something else known to be unique,
43
>>> st = ImmutableScratchStore()
45
>>> st.add(StringIO('hello'), 'aa')
51
You are not allowed to add an id that is already present.
53
Entries can be retrieved as files, which may then be read.
55
>>> st.add(StringIO('goodbye'), '123123')
56
>>> st['123123'].read()
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
66
def __init__(self, basedir):
67
self._basedir = basedir
70
if '\\' in id or '/' in id:
71
raise ValueError("invalid store id %r" % id)
72
return os.path.join(self._basedir, id)
75
return "%s(%r)" % (self.__class__.__name__, self._basedir)
77
def add(self, f, fileid, compressed=True):
78
"""Add contents of a file into the store.
80
f -- An open file, or file-like object."""
81
# FIXME: Only works on files that will fit in memory
83
from bzrlib.atomicfile import AtomicFile
85
mutter("add store entry %r" % (fileid))
86
if isinstance(f, types.StringTypes):
91
p = self._path(fileid)
92
if os.access(p, os.F_OK) or os.access(p + '.gz', os.F_OK):
93
from bzrlib.errors import bailout
94
raise BzrError("store %r already contains id %r" % (self._basedir, fileid))
100
af = AtomicFile(fn, 'wb')
103
gf = gzip.GzipFile(mode='wb', fileobj=af)
113
def copy_multi(self, other, ids):
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
from bzrlib.progress import ProgressBar
121
pb.update('preparing to copy')
122
to_copy = [id for id in ids if id not in self]
123
if isinstance(other, ImmutableStore):
124
return self.copy_multi_immutable(other, to_copy, pb)
128
pb.update('copy', count, len(to_copy))
129
self.add(other[id], id)
130
assert count == len(to_copy)
135
def copy_multi_immutable(self, other, to_copy, pb):
136
from shutil import copyfile
140
other_p = other._path(id)
144
if e.errno == errno.ENOENT:
145
copyfile(other_p+".gz", p+".gz")
150
pb.update('copy', count, len(to_copy))
151
assert count == len(to_copy)
156
def __contains__(self, fileid):
158
p = self._path(fileid)
159
return (os.access(p, os.R_OK)
160
or os.access(p + '.gz', os.R_OK))
162
# TODO: Guard against the same thing being stored twice, compressed and uncompresse
165
for f in os.listdir(self._basedir):
167
# TODO: case-insensitive?
173
return len(os.listdir(self._basedir))
176
def __getitem__(self, fileid):
177
"""Returns a file reading from a particular entry."""
178
p = self._path(fileid)
180
return gzip.GzipFile(p + '.gz', 'rb')
182
if e.errno != errno.ENOENT:
188
if e.errno != errno.ENOENT:
191
raise IndexError(fileid)
194
def total_size(self):
195
"""Return (count, bytes)
197
This is the (compressed) size stored on disk, not the size of
205
total += os.stat(p)[ST_SIZE]
207
total += os.stat(p + '.gz')[ST_SIZE]
214
class ImmutableScratchStore(ImmutableStore):
215
"""Self-destructing test subclass of ImmutableStore.
217
The Store only exists for the lifetime of the Python object.
218
Obviously you should not put anything precious in it.
221
ImmutableStore.__init__(self, tempfile.mkdtemp())
224
for f in os.listdir(self._basedir):
225
fpath = os.path.join(self._basedir, f)
226
# needed on windows, and maybe some other filesystems
227
os.chmod(fpath, 0600)
229
os.rmdir(self._basedir)
230
mutter("%r destroyed" % self)
added
removed
bzrlib/store.py
