← 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-21 22:29:49 UTC
  • Revision ID: mbp@sourcefrog.net-20050321222949-232c2093a6eadd80
fixup doctest for new module structure

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.errors import BzrError
28
 
from bzrlib.trace import mutter
29
 
import bzrlib.ui
 
28
from trace import mutter
 
29
 
30
30
 
31
31
######################################################################
32
32
# stores
35
35
    pass
36
36
 
37
37
 
38
 
class ImmutableStore(object):
 
38
class ImmutableStore:
39
39
    """Store that holds files indexed by unique names.
40
40
 
41
41
    Files can be added, but not modified once they are in.  Typically
58
58
    >>> st['123123'].read()
59
59
    'goodbye'
60
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.
 
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
 
66
71
    """
67
72
 
68
73
    def __init__(self, basedir):
 
74
        """ImmutableStore constructor."""
69
75
        self._basedir = basedir
70
76
 
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
    def _path(self, id):
 
78
        return os.path.join(self._basedir, id)
77
79
 
78
80
    def __repr__(self):
79
81
        return "%s(%r)" % (self.__class__.__name__, self._basedir)
80
82
 
81
 
    def add(self, f, fileid, compressed=True):
 
83
    def add(self, f, fileid):
82
84
        """Add contents of a file into the store.
83
85
 
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
 
        
 
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.
89
90
        mutter("add store entry %r" % (fileid))
90
91
        if isinstance(f, types.StringTypes):
91
92
            content = f
92
93
        else:
93
94
            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
 
    
 
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
 
181
104
 
182
105
    def __contains__(self, fileid):
183
106
        """"""
184
 
        p = self._path(fileid)
185
 
        return (os.access(p, os.R_OK)
186
 
                or os.access(p + '.gz', os.R_OK))
 
107
        return os.access(self._path(fileid), os.R_OK)
187
108
 
188
 
    # TODO: Guard against the same thing being stored twice, compressed and uncompresse
189
109
 
190
110
    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
 
 
 
111
        return iter(os.listdir(self._basedir))
201
112
 
202
113
    def __getitem__(self, fileid):
203
114
        """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
 
 
 
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)
237
133
 
238
134
 
239
135
 
241
137
    """Self-destructing test subclass of ImmutableStore.
242
138
 
243
139
    The Store only exists for the lifetime of the Python object.
244
 
 Obviously you should not put anything precious in it.
 
140
    Obviously you should not put anything precious in it.
245
141
    """
246
142
    def __init__(self):
247
143
        ImmutableStore.__init__(self, tempfile.mkdtemp())
248
144
 
249
145
    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)
 
146
        self.delete_all()
 
147
        self.destroy()