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
17
# TODO: Could remember a bias towards whether a particular store is typically
21
Stores are the main data-storage mechanism for Bazaar-NG.
23
A store is a simple write-once container indexed by a universally
27
import os, tempfile, types, osutils, gzip, errno
28
from stat import ST_SIZE
29
from StringIO import StringIO
30
from bzrlib.errors import BzrError
31
from bzrlib.trace import mutter
34
######################################################################
37
class StoreError(Exception):
41
class ImmutableStore(object):
42
"""Store that holds files indexed by unique names.
44
Files can be added, but not modified once they are in. Typically
45
the hash is used as the name, or something else known to be unique,
48
>>> st = ImmutableScratchStore()
50
>>> st.add(StringIO('hello'), 'aa')
56
You are not allowed to add an id that is already present.
58
Entries can be retrieved as files, which may then be read.
60
>>> st.add(StringIO('goodbye'), '123123')
61
>>> st['123123'].read()
64
TODO: Atomic add by writing to a temporary file and renaming.
66
In bzr 0.0.5 and earlier, files within the store were marked
67
readonly on disk. This is no longer done but existing stores need
71
def __init__(self, basedir):
72
self._basedir = basedir
74
def _path(self, entry_id):
75
if not isinstance(entry_id, basestring):
76
raise TypeError(type(entry_id))
77
if '\\' in entry_id or '/' in entry_id:
78
raise ValueError("invalid store id %r" % entry_id)
79
return os.path.join(self._basedir, entry_id)
82
return "%s(%r)" % (self.__class__.__name__, self._basedir)
84
def add(self, f, fileid, compressed=True):
85
"""Add contents of a file into the store.
87
f -- An open file, or file-like object."""
88
# FIXME: Only works on files that will fit in memory
90
from bzrlib.atomicfile import AtomicFile
92
mutter("add store entry %r" % (fileid))
93
if isinstance(f, types.StringTypes):
98
p = self._path(fileid)
99
if os.access(p, os.F_OK) or os.access(p + '.gz', os.F_OK):
100
raise BzrError("store %r already contains id %r" % (self._basedir, fileid))
106
af = AtomicFile(fn, 'wb')
109
gf = gzip.GzipFile(mode='wb', fileobj=af)
119
def copy_multi(self, other, ids, permit_failure=False):
120
"""Copy texts for ids from other into self.
122
If an id is present in self, it is skipped.
124
Returns (count_copied, failed), where failed is a collection of ids
125
that could not be copied.
127
pb = bzrlib.ui.ui_factory.progress_bar()
129
pb.update('preparing to copy')
130
to_copy = [id for id in ids if id not in self]
131
if isinstance(other, ImmutableStore):
132
return self.copy_multi_immutable(other, to_copy, pb)
137
pb.update('copy', count, len(to_copy))
138
if not permit_failure:
139
self.add(other[id], id)
148
if not permit_failure:
149
assert count == len(to_copy)
153
def copy_multi_immutable(self, other, to_copy, pb, permit_failure=False):
154
from shutil import copyfile
159
other_p = other._path(id)
163
if e.errno == errno.ENOENT:
164
if not permit_failure:
165
copyfile(other_p+".gz", p+".gz")
168
copyfile(other_p+".gz", p+".gz")
170
if e.errno == errno.ENOENT:
178
pb.update('copy', count, len(to_copy))
179
assert count == len(to_copy)
184
def __contains__(self, fileid):
186
p = self._path(fileid)
187
return (os.access(p, os.R_OK)
188
or os.access(p + '.gz', os.R_OK))
190
# TODO: Guard against the same thing being stored twice,
191
# compressed and uncompressed
194
for f in os.listdir(self._basedir):
196
# TODO: case-insensitive?
202
return len(os.listdir(self._basedir))
205
def __getitem__(self, fileid):
206
"""Returns a file reading from a particular entry."""
207
p = self._path(fileid)
209
return gzip.GzipFile(p + '.gz', 'rb')
211
if e.errno != errno.ENOENT:
217
if e.errno != errno.ENOENT:
220
raise IndexError(fileid)
223
def total_size(self):
224
"""Return (count, bytes)
226
This is the (compressed) size stored on disk, not the size of
234
total += os.stat(p)[ST_SIZE]
236
total += os.stat(p + '.gz')[ST_SIZE]
243
class ImmutableScratchStore(ImmutableStore):
244
"""Self-destructing test subclass of ImmutableStore.
246
The Store only exists for the lifetime of the Python object.
247
Obviously you should not put anything precious in it.
250
ImmutableStore.__init__(self, tempfile.mkdtemp())
253
for f in os.listdir(self._basedir):
254
fpath = os.path.join(self._basedir, f)
255
# needed on windows, and maybe some other filesystems
256
os.chmod(fpath, 0600)
258
os.rmdir(self._basedir)
259
mutter("%r destroyed" % self)
added
removed
bzrlib/store.py
