/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/store.py

  • Committer: Martin Pool
  • Date: 2005-05-03 02:39:45 UTC
  • Revision ID: mbp@sourcefrog.net-20050503023945-542829ff748301e8
- more documentation of revfile+annotation

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/store.py
 
1
 
 
2
 
 
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.
 
7
 
 
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.
 
12
 
 
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
 
16
 
 
17
"""Stores are the main data-storage mechanism for Bazaar-NG.
 
18
 
 
19
A store is a simple write-once container indexed by a universally
 
20
unique ID, which is typically the SHA-1 of the content."""
 
21
 
 
22
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
 
23
__author__ = "Martin Pool <mbp@canonical.com>"
 
24
 
 
25
import os, tempfile, types, osutils, gzip, errno
 
26
from stat import ST_SIZE
 
27
from StringIO import StringIO
 
28
from trace import mutter
 
29
 
 
30
######################################################################
 
31
# stores
 
32
 
 
33
class StoreError(Exception):
 
34
    pass
 
35
 
 
36
 
 
37
class ImmutableStore:
 
38
    """Store that holds files indexed by unique names.
 
39
 
 
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,
 
42
    such as a UUID.
 
43
 
 
44
    >>> st = ImmutableScratchStore()
 
45
 
 
46
    >>> st.add(StringIO('hello'), 'aa')
 
47
    >>> 'aa' in st
 
48
    True
 
49
    >>> 'foo' in st
 
50
    False
 
51
 
 
52
    You are not allowed to add an id that is already present.
 
53
 
 
54
    Entries can be retrieved as files, which may then be read.
 
55
 
 
56
    >>> st.add(StringIO('goodbye'), '123123')
 
57
    >>> st['123123'].read()
 
58
    'goodbye'
 
59
 
 
60
    TODO: Atomic add by writing to a temporary file and renaming.
 
61
 
 
62
    TODO: Perhaps automatically transform to/from XML in a method?
 
63
           Would just need to tell the constructor what class to
 
64
           use...
 
65
 
 
66
    TODO: Even within a simple disk store like this, we could
 
67
           gzip the files.  But since many are less than one disk
 
68
           block, that might not help a lot.
 
69
 
 
70
    """
 
71
 
 
72
    def __init__(self, basedir):
 
73
        """ImmutableStore constructor."""
 
74
        self._basedir = basedir
 
75
 
 
76
    def _path(self, id):
 
77
        return os.path.join(self._basedir, id)
 
78
 
 
79
    def __repr__(self):
 
80
        return "%s(%r)" % (self.__class__.__name__, self._basedir)
 
81
 
 
82
    def add(self, f, fileid, compressed=True):
 
83
        """Add contents of a file into the store.
 
84
 
 
85
        f -- An open file, or file-like object."""
 
86
        # FIXME: Only works on smallish files
 
87
        # TODO: Can be optimized by copying at the same time as
 
88
        # computing the sum.
 
89
        mutter("add store entry %r" % (fileid))
 
90
        if isinstance(f, types.StringTypes):
 
91
            content = f
 
92
        else:
 
93
            content = f.read()
 
94
 
 
95
        p = self._path(fileid)
 
96
        if os.access(p, os.F_OK) or os.access(p + '.gz', os.F_OK):
 
97
            bailout("store %r already contains id %r" % (self._basedir, fileid))
 
98
 
 
99
        if compressed:
 
100
            f = gzip.GzipFile(p + '.gz', 'wb')
 
101
            os.chmod(p + '.gz', 0444)
 
102
        else:
 
103
            f = file(p, 'wb')
 
104
            os.chmod(p, 0444)
 
105
            
 
106
        f.write(content)
 
107
        f.close()
 
108
 
 
109
 
 
110
    def __contains__(self, fileid):
 
111
        """"""
 
112
        p = self._path(fileid)
 
113
        return (os.access(p, os.R_OK)
 
114
                or os.access(p + '.gz', os.R_OK))
 
115
 
 
116
    # TODO: Guard against the same thing being stored twice, compressed and uncompresse
 
117
 
 
118
    def __iter__(self):
 
119
        for f in os.listdir(self._basedir):
 
120
            if f[-3:] == '.gz':
 
121
                # TODO: case-insensitive?
 
122
                yield f[:-3]
 
123
            else:
 
124
                yield f
 
125
 
 
126
    def __len__(self):
 
127
        return len(os.listdir(self._basedir))
 
128
 
 
129
    def __getitem__(self, fileid):
 
130
        """Returns a file reading from a particular entry."""
 
131
        p = self._path(fileid)
 
132
        try:
 
133
            return gzip.GzipFile(p + '.gz', 'rb')
 
134
        except IOError, e:
 
135
            if e.errno == errno.ENOENT:
 
136
                return file(p, 'rb')
 
137
            else:
 
138
                raise e
 
139
 
 
140
    def total_size(self):
 
141
        """Return (count, bytes)
 
142
 
 
143
        This is the (compressed) size stored on disk, not the size of
 
144
        the content."""
 
145
        total = 0
 
146
        count = 0
 
147
        for fid in self:
 
148
            count += 1
 
149
            p = self._path(fid)
 
150
            try:
 
151
                total += os.stat(p)[ST_SIZE]
 
152
            except OSError:
 
153
                total += os.stat(p + '.gz')[ST_SIZE]
 
154
                
 
155
        return count, total
 
156
 
 
157
 
 
158
 
 
159
 
 
160
class ImmutableScratchStore(ImmutableStore):
 
161
    """Self-destructing test subclass of ImmutableStore.
 
162
 
 
163
    The Store only exists for the lifetime of the Python object.
 
164
    Obviously you should not put anything precious in it.
 
165
    """
 
166
    def __init__(self):
 
167
        ImmutableStore.__init__(self, tempfile.mkdtemp())
 
168
 
 
169
    def __del__(self):
 
170
        for f in os.listdir(self._basedir):
 
171
            fpath = os.path.join(self._basedir, f)
 
172
            # needed on windows, and maybe some other filesystems
 
173
            os.chmod(fpath, 0600)
 
174
            os.remove(fpath)
 
175
        os.rmdir(self._basedir)
 
176
        mutter("%r destroyed" % self)