2
# -*- coding: UTF-8 -*-
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# 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
21
unique ID, which is typically the SHA-1 of the content."""
23
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
24
__author__ = "Martin Pool <mbp@canonical.com>"
26
import os, tempfile, types, osutils, gzip, errno
27
from stat import ST_SIZE
28
from StringIO import StringIO
29
from trace import mutter
31
######################################################################
34
class StoreError(Exception):
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
:todo: Perhaps automatically transform to/from XML in a method?
64
Would just need to tell the constructor what class to
67
:todo: Even within a simple disk store like this, we could
68
gzip the files. But since many are less than one disk
69
block, that might not help a lot.
73
def __init__(self, basedir):
74
"""ImmutableStore constructor."""
75
self._basedir = basedir
78
return os.path.join(self._basedir, id)
81
return "%s(%r)" % (self.__class__.__name__, self._basedir)
83
def add(self, f, fileid, compressed=True):
84
"""Add contents of a file into the store.
86
:param f: An open file, or file-like object."""
87
# FIXME: Only works on smallish files
88
# TODO: Can be optimized by copying at the same time as
90
mutter("add store entry %r" % (fileid))
91
if isinstance(f, types.StringTypes):
96
p = self._path(fileid)
97
if os.access(p, os.F_OK) or os.access(p + '.gz', os.F_OK):
98
bailout("store %r already contains id %r" % (self._basedir, fileid))
101
f = gzip.GzipFile(p + '.gz', 'wb')
102
os.chmod(p + '.gz', 0444)
111
def __contains__(self, fileid):
113
p = self._path(fileid)
114
return (os.access(p, os.R_OK)
115
or os.access(p + '.gz', os.R_OK))
117
# TODO: Guard against the same thing being stored twice, compressed and uncompresse
120
for f in os.listdir(self._basedir):
122
# TODO: case-insensitive?
128
return len(os.listdir(self._basedir))
130
def __getitem__(self, fileid):
131
"""Returns a file reading from a particular entry."""
132
p = self._path(fileid)
134
return gzip.GzipFile(p + '.gz', 'rb')
136
if e.errno == errno.ENOENT:
141
def total_size(self):
142
"""Return (count, bytes)
144
This is the (compressed) size stored on disk, not the size of
152
total += os.stat(p)[ST_SIZE]
154
total += os.stat(p + '.gz')[ST_SIZE]
161
class ImmutableScratchStore(ImmutableStore):
162
"""Self-destructing test subclass of ImmutableStore.
164
The Store only exists for the lifetime of the Python object.
165
Obviously you should not put anything precious in it.
168
ImmutableStore.__init__(self, tempfile.mkdtemp())
171
for f in os.listdir(self._basedir):
172
os.remove(os.path.join(self._basedir, f))
173
os.rmdir(self._basedir)
174
mutter("%r destroyed" % self)
added
removed
bzrlib/store.py
