/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

merge merge tweaks from aaron, which includes latest .dev

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 bzrlib.errors import BzrError
 
28
from bzrlib.trace import mutter
 
29
import bzrlib.ui
 
30
 
 
31
######################################################################
 
32
# stores
 
33
 
 
34
class StoreError(Exception):
 
35
    pass
 
36
 
 
37
 
 
38
class ImmutableStore(object):
 
39
    """Store that holds files indexed by unique names.
 
40
 
 
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,
 
43
    such as a UUID.
 
44
 
 
45
    >>> st = ImmutableScratchStore()
 
46
 
 
47
    >>> st.add(StringIO('hello'), 'aa')
 
48
    >>> 'aa' in st
 
49
    True
 
50
    >>> 'foo' in st
 
51
    False
 
52
 
 
53
    You are not allowed to add an id that is already present.
 
54
 
 
55
    Entries can be retrieved as files, which may then be read.
 
56
 
 
57
    >>> st.add(StringIO('goodbye'), '123123')
 
58
    >>> st['123123'].read()
 
59
    'goodbye'
 
60
 
 
61
    TODO: Atomic add by writing to a temporary file and renaming.
 
62
 
 
63
    In bzr 0.0.5 and earlier, files within the store were marked
 
64
    readonly on disk.  This is no longer done but existing stores need
 
65
    to be accomodated.
 
66
    """
 
67
 
 
68
    def __init__(self, basedir):
 
69
        self._basedir = basedir
 
70
 
 
71
    def _path(self, entry_id):
 
72
        if not isinstance(entry_id, basestring):
 
73
            raise TypeError(type(entry_id))
 
74
        if '\\' in entry_id or '/' in entry_id:
 
75
            raise ValueError("invalid store id %r" % entry_id)
 
76
        return os.path.join(self._basedir, entry_id)
 
77
 
 
78
    def __repr__(self):
 
79
        return "%s(%r)" % (self.__class__.__name__, self._basedir)
 
80
 
 
81
    def add(self, f, fileid, compressed=True):
 
82
        """Add contents of a file into the store.
 
83
 
 
84
        f -- An open file, or file-like object."""
 
85
        # FIXME: Only works on files that will fit in memory
 
86
        
 
87
        from bzrlib.atomicfile import AtomicFile
 
88
        
 
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
            raise BzrError("store %r already contains id %r" % (self._basedir, fileid))
 
98
 
 
99
        fn = p
 
100
        if compressed:
 
101
            fn = fn + '.gz'
 
102
            
 
103
        af = AtomicFile(fn, 'wb')
 
104
        try:
 
105
            if compressed:
 
106
                gf = gzip.GzipFile(mode='wb', fileobj=af)
 
107
                gf.write(content)
 
108
                gf.close()
 
109
            else:
 
110
                af.write(content)
 
111
            af.commit()
 
112
        finally:
 
113
            af.close()
 
114
 
 
115
 
 
116
    def copy_multi(self, other, ids, permit_failure=False):
 
117
        """Copy texts for ids from other into self.
 
118
 
 
119
        If an id is present in self, it is skipped.
 
120
 
 
121
        Returns (count_copied, failed), where failed is a collection of ids
 
122
        that could not be copied.
 
123
        """
 
124
        pb = bzrlib.ui.ui_factory.progress_bar()
 
125
        
 
126
        pb.update('preparing to copy')
 
127
        to_copy = [id for id in ids if id not in self]
 
128
        if isinstance(other, ImmutableStore):
 
129
            return self.copy_multi_immutable(other, to_copy, pb, 
 
130
                                             permit_failure=permit_failure)
 
131
        count = 0
 
132
        failed = set()
 
133
        for id in to_copy:
 
134
            count += 1
 
135
            pb.update('copy', count, len(to_copy))
 
136
            if not permit_failure:
 
137
                self.add(other[id], id)
 
138
            else:
 
139
                try:
 
140
                    entry = other[id]
 
141
                except KeyError:
 
142
                    failed.add(id)
 
143
                    continue
 
144
                self.add(entry, id)
 
145
                
 
146
        if not permit_failure:
 
147
            assert count == len(to_copy)
 
148
        pb.clear()
 
149
        return count, failed
 
150
 
 
151
    def copy_multi_immutable(self, other, to_copy, pb, permit_failure=False):
 
152
        from shutil import copyfile
 
153
        count = 0
 
154
        failed = set()
 
155
        for id in to_copy:
 
156
            p = self._path(id)
 
157
            other_p = other._path(id)
 
158
            try:
 
159
                copyfile(other_p, p)
 
160
            except IOError, e:
 
161
                if e.errno == errno.ENOENT:
 
162
                    if not permit_failure:
 
163
                        copyfile(other_p+".gz", p+".gz")
 
164
                    else:
 
165
                        try:
 
166
                            copyfile(other_p+".gz", p+".gz")
 
167
                        except IOError, e:
 
168
                            if e.errno == errno.ENOENT:
 
169
                                failed.add(id)
 
170
                            else:
 
171
                                raise
 
172
                else:
 
173
                    raise
 
174
            
 
175
            count += 1
 
176
            pb.update('copy', count, len(to_copy))
 
177
        assert count == len(to_copy)
 
178
        pb.clear()
 
179
        return count, failed
 
180
    
 
181
 
 
182
    def __contains__(self, fileid):
 
183
        """"""
 
184
        p = self._path(fileid)
 
185
        return (os.access(p, os.R_OK)
 
186
                or os.access(p + '.gz', os.R_OK))
 
187
 
 
188
    # TODO: Guard against the same thing being stored twice, compressed and uncompresse
 
189
 
 
190
    def __iter__(self):
 
191
        for f in os.listdir(self._basedir):
 
192
            if f[-3:] == '.gz':
 
193
                # TODO: case-insensitive?
 
194
                yield f[:-3]
 
195
            else:
 
196
                yield f
 
197
 
 
198
    def __len__(self):
 
199
        return len(os.listdir(self._basedir))
 
200
 
 
201
 
 
202
    def __getitem__(self, fileid):
 
203
        """Returns a file reading from a particular entry."""
 
204
        p = self._path(fileid)
 
205
        try:
 
206
            return gzip.GzipFile(p + '.gz', 'rb')
 
207
        except IOError, e:
 
208
            if e.errno != errno.ENOENT:
 
209
                raise
 
210
 
 
211
        try:
 
212
            return file(p, 'rb')
 
213
        except IOError, e:
 
214
            if e.errno != errno.ENOENT:
 
215
                raise
 
216
 
 
217
        raise KeyError(fileid)
 
218
 
 
219
 
 
220
    def total_size(self):
 
221
        """Return (count, bytes)
 
222
 
 
223
        This is the (compressed) size stored on disk, not the size of
 
224
        the content."""
 
225
        total = 0
 
226
        count = 0
 
227
        for fid in self:
 
228
            count += 1
 
229
            p = self._path(fid)
 
230
            try:
 
231
                total += os.stat(p)[ST_SIZE]
 
232
            except OSError:
 
233
                total += os.stat(p + '.gz')[ST_SIZE]
 
234
                
 
235
        return count, total
 
236
 
 
237
 
 
238
 
 
239
 
 
240
class ImmutableScratchStore(ImmutableStore):
 
241
    """Self-destructing test subclass of ImmutableStore.
 
242
 
 
243
    The Store only exists for the lifetime of the Python object.
 
244
 Obviously you should not put anything precious in it.
 
245
    """
 
246
    def __init__(self):
 
247
        ImmutableStore.__init__(self, tempfile.mkdtemp())
 
248
 
 
249
    def __del__(self):
 
250
        for f in os.listdir(self._basedir):
 
251
            fpath = os.path.join(self._basedir, f)
 
252
            # needed on windows, and maybe some other filesystems
 
253
            os.chmod(fpath, 0600)
 
254
            os.remove(fpath)
 
255
        os.rmdir(self._basedir)
 
256
        mutter("%r destroyed" % self)