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.errors import BzrError
28
from bzrlib.trace import mutter
31
######################################################################
34
class StoreError(Exception):
38
class ImmutableStore(object):
39
"""Store that holds files indexed by unique names.
41
Files can be added, but not modified once they are in. Typically
42
the hash is used as the name, or something else known to be unique,
45
>>> st = ImmutableScratchStore()
47
>>> st.add(StringIO('hello'), 'aa')
53
You are not allowed to add an id that is already present.
55
Entries can be retrieved as files, which may then be read.
57
>>> st.add(StringIO('goodbye'), '123123')
58
>>> st['123123'].read()
61
TODO: Atomic add by writing to a temporary file and renaming.
63
In bzr 0.0.5 and earlier, files within the store were marked
64
readonly on disk. This is no longer done but existing stores need
68
def __init__(self, basedir):
69
self._basedir = basedir
72
if '\\' in id or '/' in id:
73
raise ValueError("invalid store id %r" % id)
74
return os.path.join(self._basedir, id)
77
return "%s(%r)" % (self.__class__.__name__, self._basedir)
79
def add(self, f, fileid, compressed=True):
80
"""Add contents of a file into the store.
82
f -- An open file, or file-like object."""
83
# FIXME: Only works on files that will fit in memory
85
from bzrlib.atomicfile import AtomicFile
87
mutter("add store entry %r" % (fileid))
88
if isinstance(f, types.StringTypes):
93
p = self._path(fileid)
94
if os.access(p, os.F_OK) or os.access(p + '.gz', os.F_OK):
95
raise BzrError("store %r already contains id %r" % (self._basedir, fileid))
101
af = AtomicFile(fn, 'wb')
104
gf = gzip.GzipFile(mode='wb', fileobj=af)
114
def copy_multi(self, other, ids, permit_failure=False):
115
"""Copy texts for ids from other into self.
117
If an id is present in self, it is skipped.
119
Returns (count_copied, failed), where failed is a collection of ids
120
that could not be copied.
122
pb = bzrlib.ui.ui_factory.progress_bar()
124
pb.update('preparing to copy')
125
to_copy = [id for id in ids if id not in self]
126
if isinstance(other, ImmutableStore):
127
return self.copy_multi_immutable(other, to_copy, pb)
132
pb.update('copy', count, len(to_copy))
133
if not permit_failure:
134
self.add(other[id], id)
143
if not permit_failure:
144
assert count == len(to_copy)
148
def copy_multi_immutable(self, other, to_copy, pb, permit_failure=False):
149
from shutil import copyfile
154
other_p = other._path(id)
158
if e.errno == errno.ENOENT:
159
if not permit_failure:
160
copyfile(other_p+".gz", p+".gz")
163
copyfile(other_p+".gz", p+".gz")
165
if e.errno == errno.ENOENT:
173
pb.update('copy', count, len(to_copy))
174
assert count == len(to_copy)
179
def __contains__(self, fileid):
181
p = self._path(fileid)
182
return (os.access(p, os.R_OK)
183
or os.access(p + '.gz', os.R_OK))
185
# TODO: Guard against the same thing being stored twice, compressed and uncompresse
188
for f in os.listdir(self._basedir):
190
# TODO: case-insensitive?
196
return len(os.listdir(self._basedir))
199
def __getitem__(self, fileid):
200
"""Returns a file reading from a particular entry."""
201
p = self._path(fileid)
203
return gzip.GzipFile(p + '.gz', 'rb')
205
if e.errno != errno.ENOENT:
211
if e.errno != errno.ENOENT:
214
raise IndexError(fileid)
217
def total_size(self):
218
"""Return (count, bytes)
220
This is the (compressed) size stored on disk, not the size of
228
total += os.stat(p)[ST_SIZE]
230
total += os.stat(p + '.gz')[ST_SIZE]
237
class ImmutableScratchStore(ImmutableStore):
238
"""Self-destructing test subclass of ImmutableStore.
240
The Store only exists for the lifetime of the Python object.
241
Obviously you should not put anything precious in it.
244
ImmutableStore.__init__(self, tempfile.mkdtemp())
247
for f in os.listdir(self._basedir):
248
fpath = os.path.join(self._basedir, f)
249
# needed on windows, and maybe some other filesystems
250
os.chmod(fpath, 0600)
252
os.rmdir(self._basedir)
253
mutter("%r destroyed" % self)
added
removed
bzrlib/store.py
