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
raise BzrError("store %r already contains id %r" % (self._basedir, fileid))
99
af = AtomicFile(fn, 'wb')
102
gf = gzip.GzipFile(mode='wb', fileobj=af)
112
def copy_multi(self, other, ids):
113
"""Copy texts for ids from other into self.
115
If an id is present in self, it is skipped. A count of copied
116
ids is returned, which may be less than len(ids).
118
from bzrlib.progress import ProgressBar
120
pb.update('preparing to copy')
121
to_copy = [id for id in ids if id not in self]
122
if isinstance(other, ImmutableStore):
123
return self.copy_multi_immutable(other, to_copy, pb)
127
pb.update('copy', count, len(to_copy))
128
self.add(other[id], id)
129
assert count == len(to_copy)
134
def copy_multi_immutable(self, other, to_copy, pb):
135
from shutil import copyfile
139
other_p = other._path(id)
143
if e.errno == errno.ENOENT:
144
copyfile(other_p+".gz", p+".gz")
149
pb.update('copy', count, len(to_copy))
150
assert count == len(to_copy)
155
def __contains__(self, fileid):
157
p = self._path(fileid)
158
return (os.access(p, os.R_OK)
159
or os.access(p + '.gz', os.R_OK))
161
# TODO: Guard against the same thing being stored twice, compressed and uncompresse
164
for f in os.listdir(self._basedir):
166
# TODO: case-insensitive?
172
return len(os.listdir(self._basedir))
174
def __getitem__(self, fileid):
175
"""Returns a file reading from a particular entry."""
176
p = self._path(fileid)
178
return gzip.GzipFile(p + '.gz', 'rb')
180
if e.errno == errno.ENOENT:
185
def total_size(self):
186
"""Return (count, bytes)
188
This is the (compressed) size stored on disk, not the size of
196
total += os.stat(p)[ST_SIZE]
198
total += os.stat(p + '.gz')[ST_SIZE]
205
class ImmutableScratchStore(ImmutableStore):
206
"""Self-destructing test subclass of ImmutableStore.
208
The Store only exists for the lifetime of the Python object.
209
Obviously you should not put anything precious in it.
212
ImmutableStore.__init__(self, tempfile.mkdtemp())
215
for f in os.listdir(self._basedir):
216
fpath = os.path.join(self._basedir, f)
217
# needed on windows, and maybe some other filesystems
218
os.chmod(fpath, 0600)
220
os.rmdir(self._basedir)
221
mutter("%r destroyed" % self)
added
removed
bzrlib/store.py
