← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/store.py

  • Committer: mbp at sourcefrog
  • Date: 2005-03-09 04:08:15 UTC
  • Revision ID: mbp@sourcefrog.net-20050309040815-13242001617e4a06
import from baz patch-364

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/store.py
1
 
# Copyright (C) 2005 by Canonical Development Ltd
 
1
#! /usr/bin/env python
 
2
# -*- coding: UTF-8 -*-
2
3
 
3
4
# This program is free software; you can redistribute it and/or modify
4
5
# it under the terms of the GNU General Public License as published by
14
15
# along with this program; if not, write to the Free Software
15
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
17
 
17
 
"""
18
 
Stores are the main data-storage mechanism for Bazaar-NG.
 
18
"""Stores are the main data-storage mechanism for Bazaar-NG.
19
19
 
20
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
 
21
unique ID, which is typically the SHA-1 of the content."""
 
22
 
 
23
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
 
24
__author__ = "Martin Pool <mbp@canonical.com>"
 
25
 
 
26
import os, tempfile, types, osutils
26
27
from StringIO import StringIO
27
 
from bzrlib.trace import mutter
28
 
import bzrlib.ui
 
28
from trace import mutter
 
29
 
29
30
 
30
31
######################################################################
31
32
# stores
34
35
    pass
35
36
 
36
37
 
37
 
class ImmutableStore(object):
 
38
class ImmutableStore:
38
39
    """Store that holds files indexed by unique names.
39
40
 
40
41
    Files can be added, but not modified once they are in.  Typically
57
58
    >>> st['123123'].read()
58
59
    'goodbye'
59
60
 
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.
 
61
    :todo: Atomic add by writing to a temporary file and renaming.
 
62
 
 
63
    :todo: Perhaps automatically transform to/from XML in a method?
 
64
           Would just need to tell the constructor what class to
 
65
           use...
 
66
 
 
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.
 
70
 
65
71
    """
66
72
 
67
73
    def __init__(self, basedir):
 
74
        """ImmutableStore constructor."""
68
75
        self._basedir = basedir
69
76
 
70
77
    def _path(self, id):
71
 
        if '\\' in id or '/' in id:
72
 
            raise ValueError("invalid store id %r" % id)
73
78
        return os.path.join(self._basedir, id)
74
79
 
75
80
    def __repr__(self):
76
81
        return "%s(%r)" % (self.__class__.__name__, self._basedir)
77
82
 
78
 
    def add(self, f, fileid, compressed=True):
 
83
    def add(self, f, fileid):
79
84
        """Add contents of a file into the store.
80
85
 
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
        :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
 
89
        # computing the sum.
86
90
        mutter("add store entry %r" % (fileid))
87
91
        if isinstance(f, types.StringTypes):
88
92
            content = f
89
93
        else:
90
94
            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
 
            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, permit_failure=False):
114
 
        """Copy texts for ids from other into self.
115
 
 
116
 
        If an id is present in self, it is skipped.
117
 
 
118
 
        Returns (count_copied, failed), where failed is a collection of ids
119
 
        that could not be copied.
120
 
        """
121
 
        pb = bzrlib.ui.ui_factory.progress_bar()
122
 
        
123
 
        pb.update('preparing to copy')
124
 
        to_copy = [id for id in ids if id not in self]
125
 
        if isinstance(other, ImmutableStore):
126
 
            return self.copy_multi_immutable(other, to_copy, pb)
127
 
        count = 0
128
 
        for id in to_copy:
129
 
            count += 1
130
 
            pb.update('copy', count, len(to_copy))
131
 
            if not permit_failure:
132
 
                self.add(other[id], id)
133
 
            else:
134
 
                try:
135
 
                    entry = other[id]
136
 
                except IndexError:
137
 
                    failures.add(id)
138
 
                    continue
139
 
                self.add(entry, id)
140
 
                
141
 
        assert count == len(to_copy)
142
 
        pb.clear()
143
 
        return count, []
144
 
 
145
 
    def copy_multi_immutable(self, other, to_copy, pb, permit_failure=False):
146
 
        from shutil import copyfile
147
 
        count = 0
148
 
        failed = set()
149
 
        for id in to_copy:
150
 
            p = self._path(id)
151
 
            other_p = other._path(id)
152
 
            try:
153
 
                copyfile(other_p, p)
154
 
            except IOError, e:
155
 
                if e.errno == errno.ENOENT:
156
 
                    if not permit_failure:
157
 
                        copyfile(other_p+".gz", p+".gz")
158
 
                    else:
159
 
                        try:
160
 
                            copyfile(other_p+".gz", p+".gz")
161
 
                        except IOError, e:
162
 
                            if e.errno == errno.ENOENT:
163
 
                                failed.add(id)
164
 
                            else:
165
 
                                raise
166
 
                else:
167
 
                    raise
168
 
            
169
 
            count += 1
170
 
            pb.update('copy', count, len(to_copy))
171
 
        assert count == len(to_copy)
172
 
        pb.clear()
173
 
        return count, failed
174
 
    
 
95
        if fileid not in self:
 
96
            filename = self._path(fileid)
 
97
            f = file(filename, 'wb')
 
98
            f.write(content)
 
99
            f.flush()
 
100
            os.fsync(f.fileno())
 
101
            f.close()
 
102
            osutils.make_readonly(filename)
 
103
 
175
104
 
176
105
    def __contains__(self, fileid):
177
106
        """"""
178
 
        p = self._path(fileid)
179
 
        return (os.access(p, os.R_OK)
180
 
                or os.access(p + '.gz', os.R_OK))
 
107
        return os.access(self._path(fileid), os.R_OK)
181
108
 
182
 
    # TODO: Guard against the same thing being stored twice, compressed and uncompresse
183
109
 
184
110
    def __iter__(self):
185
 
        for f in os.listdir(self._basedir):
186
 
            if f[-3:] == '.gz':
187
 
                # TODO: case-insensitive?
188
 
                yield f[:-3]
189
 
            else:
190
 
                yield f
191
 
 
192
 
    def __len__(self):
193
 
        return len(os.listdir(self._basedir))
194
 
 
 
111
        return iter(os.listdir(self._basedir))
195
112
 
196
113
    def __getitem__(self, fileid):
197
114
        """Returns a file reading from a particular entry."""
198
 
        p = self._path(fileid)
199
 
        try:
200
 
            return gzip.GzipFile(p + '.gz', 'rb')
201
 
        except IOError, e:
202
 
            if e.errno != errno.ENOENT:
203
 
                raise
204
 
 
205
 
        try:
206
 
            return file(p, 'rb')
207
 
        except IOError, e:
208
 
            if e.errno != errno.ENOENT:
209
 
                raise
210
 
 
211
 
        raise IndexError(fileid)
212
 
 
213
 
 
214
 
    def total_size(self):
215
 
        """Return (count, bytes)
216
 
 
217
 
        This is the (compressed) size stored on disk, not the size of
218
 
        the content."""
219
 
        total = 0
220
 
        count = 0
221
 
        for fid in self:
222
 
            count += 1
223
 
            p = self._path(fid)
224
 
            try:
225
 
                total += os.stat(p)[ST_SIZE]
226
 
            except OSError:
227
 
                total += os.stat(p + '.gz')[ST_SIZE]
228
 
                
229
 
        return count, total
230
 
 
 
115
        return file(self._path(fileid), 'rb')
 
116
 
 
117
    def delete_all(self):
 
118
        for fileid in self:
 
119
            self.delete(fileid)
 
120
 
 
121
    def delete(self, fileid):
 
122
        """Remove nominated store entry.
 
123
 
 
124
        Most stores will be add-only."""
 
125
        filename = self._path(fileid)
 
126
        ## osutils.make_writable(filename)
 
127
        os.remove(filename)
 
128
 
 
129
    def destroy(self):
 
130
        """Remove store; only allowed if it is empty."""
 
131
        os.rmdir(self._basedir)
 
132
        mutter("%r destroyed" % self)
231
133
 
232
134
 
233
135
 
235
137
    """Self-destructing test subclass of ImmutableStore.
236
138
 
237
139
    The Store only exists for the lifetime of the Python object.
238
 
 Obviously you should not put anything precious in it.
 
140
    Obviously you should not put anything precious in it.
239
141
    """
240
142
    def __init__(self):
241
143
        ImmutableStore.__init__(self, tempfile.mkdtemp())
242
144
 
243
145
    def __del__(self):
244
 
        for f in os.listdir(self._basedir):
245
 
            fpath = os.path.join(self._basedir, f)
246
 
            # needed on windows, and maybe some other filesystems
247
 
            os.chmod(fpath, 0600)
248
 
            os.remove(fpath)
249
 
        os.rmdir(self._basedir)
250
 
        mutter("%r destroyed" % self)
 
146
        self.delete_all()
 
147
        self.destroy()