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.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
In bzr 0.0.5 and earlier, files within the store were marked
63
readonly on disk. This is no longer done but existing stores need
67
def __init__(self, basedir):
68
self._basedir = basedir
71
if '\\' in id or '/' in id:
72
raise ValueError("invalid store id %r" % id)
73
return os.path.join(self._basedir, id)
76
return "%s(%r)" % (self.__class__.__name__, self._basedir)
78
def add(self, f, fileid, compressed=True):
79
"""Add contents of a file into the store.
81
f -- An open file, or file-like object."""
82
# FIXME: Only works on files that will fit in memory
84
from bzrlib.atomicfile import AtomicFile
86
mutter("add store entry %r" % (fileid))
87
if isinstance(f, types.StringTypes):
92
p = self._path(fileid)
93
if os.access(p, os.F_OK) or os.access(p + '.gz', os.F_OK):
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, permit_failure=False):
114
"""Copy texts for ids from other into self.
116
If an id is present in self, it is skipped.
118
Returns (count_copied, failed), where failed is a collection of ids
119
that could not be copied.
121
pb = bzrlib.ui.ui_factory.progress_bar()
123
pb.update('preparing to copy')
124
to_copy = [id for id in ids if id not in self]
125
if isinstance(other, ImmutableStore):
126
return self.copy_multi_immutable(other, to_copy, pb)
130
pb.update('copy', count, len(to_copy))
131
if not permit_failure:
132
self.add(other[id], id)
141
assert count == len(to_copy)
145
def copy_multi_immutable(self, other, to_copy, pb, permit_failure=False):
146
from shutil import copyfile
151
other_p = other._path(id)
155
if e.errno == errno.ENOENT:
156
if not permit_failure:
157
copyfile(other_p+".gz", p+".gz")
160
copyfile(other_p+".gz", p+".gz")
162
if e.errno == errno.ENOENT:
170
pb.update('copy', count, len(to_copy))
171
assert count == len(to_copy)
176
def __contains__(self, fileid):
178
p = self._path(fileid)
179
return (os.access(p, os.R_OK)
180
or os.access(p + '.gz', os.R_OK))
182
# TODO: Guard against the same thing being stored twice, compressed and uncompresse
185
for f in os.listdir(self._basedir):
187
# TODO: case-insensitive?
193
return len(os.listdir(self._basedir))
196
def __getitem__(self, fileid):
197
"""Returns a file reading from a particular entry."""
198
p = self._path(fileid)
200
return gzip.GzipFile(p + '.gz', 'rb')
202
if e.errno != errno.ENOENT:
208
if e.errno != errno.ENOENT:
211
raise IndexError(fileid)
214
def total_size(self):
215
"""Return (count, bytes)
217
This is the (compressed) size stored on disk, not the size of
225
total += os.stat(p)[ST_SIZE]
227
total += os.stat(p + '.gz')[ST_SIZE]
234
class ImmutableScratchStore(ImmutableStore):
235
"""Self-destructing test subclass of ImmutableStore.
237
The Store only exists for the lifetime of the Python object.
238
Obviously you should not put anything precious in it.
241
ImmutableStore.__init__(self, tempfile.mkdtemp())
244
for f in os.listdir(self._basedir):
245
fpath = os.path.join(self._basedir, f)
246
# needed on windows, and maybe some other filesystems
247
os.chmod(fpath, 0600)
249
os.rmdir(self._basedir)
250
mutter("%r destroyed" % self)
added
removed
bzrlib/store.py
