/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: Jelmer Vernooij
  • Date: 2008-12-11 07:30:52 UTC
  • mto: (0.215.1 trunk)
  • mto: This revision was merged to the branch mainline in revision 6960.
  • Revision ID: jelmer@samba.org-20081211073052-lq0ypg5h3vvyzp3j
Change project name to dulwich everywhere, add assertion.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/store.py
1
 
# Copyright (C) 2005 by Canonical Development Ltd
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
 
"""
18
 
Stores are the main data-storage mechanism for Bazaar-NG.
19
 
 
20
 
A store is a simple write-once container indexed by a universally
21
 
unique ID.
22
 
"""
23
 
 
24
 
import os, tempfile, types, osutils, gzip, errno
25
 
from stat import ST_SIZE
26
 
from StringIO import StringIO
27
 
from trace import mutter
28
 
 
29
 
######################################################################
30
 
# stores
31
 
 
32
 
class StoreError(Exception):
33
 
    pass
34
 
 
35
 
 
36
 
class ImmutableStore(object):
37
 
    """Store that holds files indexed by unique names.
38
 
 
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,
41
 
    such as a UUID.
42
 
 
43
 
    >>> st = ImmutableScratchStore()
44
 
 
45
 
    >>> st.add(StringIO('hello'), 'aa')
46
 
    >>> 'aa' in st
47
 
    True
48
 
    >>> 'foo' in st
49
 
    False
50
 
 
51
 
    You are not allowed to add an id that is already present.
52
 
 
53
 
    Entries can be retrieved as files, which may then be read.
54
 
 
55
 
    >>> st.add(StringIO('goodbye'), '123123')
56
 
    >>> st['123123'].read()
57
 
    'goodbye'
58
 
 
59
 
    TODO: Atomic add by writing to a temporary file and renaming.
60
 
 
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
63
 
    to be accomodated.
64
 
    """
65
 
 
66
 
    def __init__(self, basedir):
67
 
        self._basedir = basedir
68
 
 
69
 
    def _path(self, id):
70
 
        if '\\' in id or '/' in id:
71
 
            raise ValueError("invalid store id %r" % id)
72
 
        return os.path.join(self._basedir, id)
73
 
 
74
 
    def __repr__(self):
75
 
        return "%s(%r)" % (self.__class__.__name__, self._basedir)
76
 
 
77
 
    def add(self, f, fileid, compressed=True):
78
 
        """Add contents of a file into the store.
79
 
 
80
 
        f -- An open file, or file-like object."""
81
 
        # FIXME: Only works on files that will fit in memory
82
 
        
83
 
        from bzrlib.atomicfile import AtomicFile
84
 
        
85
 
        mutter("add store entry %r" % (fileid))
86
 
        if isinstance(f, types.StringTypes):
87
 
            content = f
88
 
        else:
89
 
            content = f.read()
90
 
            
91
 
        p = self._path(fileid)
92
 
        if os.access(p, os.F_OK) or os.access(p + '.gz', os.F_OK):
93
 
            from bzrlib.errors import bailout
94
 
            raise BzrError("store %r already contains id %r" % (self._basedir, fileid))
95
 
 
96
 
        fn = p
97
 
        if compressed:
98
 
            fn = fn + '.gz'
99
 
            
100
 
        af = AtomicFile(fn, 'wb')
101
 
        try:
102
 
            if compressed:
103
 
                gf = gzip.GzipFile(mode='wb', fileobj=af)
104
 
                gf.write(content)
105
 
                gf.close()
106
 
            else:
107
 
                af.write(content)
108
 
            af.commit()
109
 
        finally:
110
 
            af.close()
111
 
 
112
 
 
113
 
    def copy_multi(self, other, ids):
114
 
        """Copy texts for ids from other into self.
115
 
 
116
 
        If an id is present in self, it is skipped.  A count of copied
117
 
        ids is returned, which may be less than len(ids).
118
 
        """
119
 
        from bzrlib.progress import ProgressBar
120
 
        pb = ProgressBar()
121
 
        pb.update('preparing to copy')
122
 
        to_copy = [id for id in ids if id not in self]
123
 
        if isinstance(other, ImmutableStore):
124
 
            return self.copy_multi_immutable(other, to_copy, pb)
125
 
        count = 0
126
 
        for id in to_copy:
127
 
            count += 1
128
 
            pb.update('copy', count, len(to_copy))
129
 
            self.add(other[id], id)
130
 
        assert count == len(to_copy)
131
 
        pb.clear()
132
 
        return count
133
 
 
134
 
 
135
 
    def copy_multi_immutable(self, other, to_copy, pb):
136
 
        from shutil import copyfile
137
 
        count = 0
138
 
        for id in to_copy:
139
 
            p = self._path(id)
140
 
            other_p = other._path(id)
141
 
            try:
142
 
                copyfile(other_p, p)
143
 
            except IOError, e:
144
 
                if e.errno == errno.ENOENT:
145
 
                    copyfile(other_p+".gz", p+".gz")
146
 
                else:
147
 
                    raise
148
 
            
149
 
            count += 1
150
 
            pb.update('copy', count, len(to_copy))
151
 
        assert count == len(to_copy)
152
 
        pb.clear()
153
 
        return count
154
 
    
155
 
 
156
 
    def __contains__(self, fileid):
157
 
        """"""
158
 
        p = self._path(fileid)
159
 
        return (os.access(p, os.R_OK)
160
 
                or os.access(p + '.gz', os.R_OK))
161
 
 
162
 
    # TODO: Guard against the same thing being stored twice, compressed and uncompresse
163
 
 
164
 
    def __iter__(self):
165
 
        for f in os.listdir(self._basedir):
166
 
            if f[-3:] == '.gz':
167
 
                # TODO: case-insensitive?
168
 
                yield f[:-3]
169
 
            else:
170
 
                yield f
171
 
 
172
 
    def __len__(self):
173
 
        return len(os.listdir(self._basedir))
174
 
 
175
 
 
176
 
    def __getitem__(self, fileid):
177
 
        """Returns a file reading from a particular entry."""
178
 
        p = self._path(fileid)
179
 
        try:
180
 
            return gzip.GzipFile(p + '.gz', 'rb')
181
 
        except IOError, e:
182
 
            if e.errno != errno.ENOENT:
183
 
                raise
184
 
 
185
 
        try:
186
 
            return file(p, 'rb')
187
 
        except IOError, e:
188
 
            if e.errno != errno.ENOENT:
189
 
                raise
190
 
 
191
 
        raise IndexError(fileid)
192
 
 
193
 
 
194
 
    def total_size(self):
195
 
        """Return (count, bytes)
196
 
 
197
 
        This is the (compressed) size stored on disk, not the size of
198
 
        the content."""
199
 
        total = 0
200
 
        count = 0
201
 
        for fid in self:
202
 
            count += 1
203
 
            p = self._path(fid)
204
 
            try:
205
 
                total += os.stat(p)[ST_SIZE]
206
 
            except OSError:
207
 
                total += os.stat(p + '.gz')[ST_SIZE]
208
 
                
209
 
        return count, total
210
 
 
211
 
 
212
 
 
213
 
 
214
 
class ImmutableScratchStore(ImmutableStore):
215
 
    """Self-destructing test subclass of ImmutableStore.
216
 
 
217
 
    The Store only exists for the lifetime of the Python object.
218
 
 Obviously you should not put anything precious in it.
219
 
    """
220
 
    def __init__(self):
221
 
        ImmutableStore.__init__(self, tempfile.mkdtemp())
222
 
 
223
 
    def __del__(self):
224
 
        for f in os.listdir(self._basedir):
225
 
            fpath = os.path.join(self._basedir, f)
226
 
            # needed on windows, and maybe some other filesystems
227
 
            os.chmod(fpath, 0600)
228
 
            os.remove(fpath)
229
 
        os.rmdir(self._basedir)
230
 
        mutter("%r destroyed" % self)