/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 from abently, take his fixes for merge in preference

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