← 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-23 06:25:55 UTC
  • Revision ID: mbp@sourcefrog.net-20050323062555-5489339018d0c043
- import a subset of elementtree for easier installation

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
28
from trace import mutter
28
29
 
 
30
 
29
31
######################################################################
30
32
# stores
31
33
 
33
35
    pass
34
36
 
35
37
 
36
 
class ImmutableStore(object):
 
38
class ImmutableStore:
37
39
    """Store that holds files indexed by unique names.
38
40
 
39
41
    Files can be added, but not modified once they are in.  Typically
56
58
    >>> st['123123'].read()
57
59
    'goodbye'
58
60
 
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.
 
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
 
64
71
    """
65
72
 
66
73
    def __init__(self, basedir):
 
74
        """ImmutableStore constructor."""
67
75
        self._basedir = basedir
68
76
 
69
77
    def _path(self, id):
70
 
        if '\\' in id or '/' in id:
71
 
            raise ValueError("invalid store id %r" % id)
72
78
        return os.path.join(self._basedir, id)
73
79
 
74
80
    def __repr__(self):
75
81
        return "%s(%r)" % (self.__class__.__name__, self._basedir)
76
82
 
77
 
    def add(self, f, fileid, compressed=True):
 
83
    def add(self, f, fileid):
78
84
        """Add contents of a file into the store.
79
85
 
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
 
        
 
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.
85
90
        mutter("add store entry %r" % (fileid))
86
91
        if isinstance(f, types.StringTypes):
87
92
            content = f
88
93
        else:
89
94
            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, permit_failure=False):
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
 
            if not permit_failure:
130
 
                self.add(other[id], id)
131
 
            else:
132
 
                try:
133
 
                    entry = other[id]
134
 
                except IndexError:
135
 
                    failures.add(id)
136
 
                    continue
137
 
                self.add(entry, id)
138
 
                
139
 
        assert count == len(to_copy)
140
 
        pb.clear()
141
 
        return count
142
 
 
143
 
 
144
 
    def copy_multi_immutable(self, other, to_copy, pb, permit_failure=False):
145
 
        from shutil import copyfile
146
 
        count = 0
147
 
        failed = set()
148
 
        for id in to_copy:
149
 
            p = self._path(id)
150
 
            other_p = other._path(id)
151
 
            try:
152
 
                copyfile(other_p, p)
153
 
            except IOError, e:
154
 
                if e.errno == errno.ENOENT:
155
 
                    if not permit_failure:
156
 
                        copyfile(other_p+".gz", p+".gz")
157
 
                    else:
158
 
                        try:
159
 
                            copyfile(other_p+".gz", p+".gz")
160
 
                        except IOError, e:
161
 
                            if e.errno == errno.ENOENT:
162
 
                                failed.add(id)
163
 
                            else:
164
 
                                raise
165
 
                else:
166
 
                    raise
167
 
            
168
 
            count += 1
169
 
            pb.update('copy', count, len(to_copy))
170
 
        assert count == len(to_copy)
171
 
        pb.clear()
172
 
        return count, failed
173
 
    
 
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
 
174
104
 
175
105
    def __contains__(self, fileid):
176
106
        """"""
177
 
        p = self._path(fileid)
178
 
        return (os.access(p, os.R_OK)
179
 
                or os.access(p + '.gz', os.R_OK))
 
107
        return os.access(self._path(fileid), os.R_OK)
180
108
 
181
 
    # TODO: Guard against the same thing being stored twice, compressed and uncompresse
182
109
 
183
110
    def __iter__(self):
184
 
        for f in os.listdir(self._basedir):
185
 
            if f[-3:] == '.gz':
186
 
                # TODO: case-insensitive?
187
 
                yield f[:-3]
188
 
            else:
189
 
                yield f
190
 
 
191
 
    def __len__(self):
192
 
        return len(os.listdir(self._basedir))
193
 
 
 
111
        return iter(os.listdir(self._basedir))
194
112
 
195
113
    def __getitem__(self, fileid):
196
114
        """Returns a file reading from a particular entry."""
197
 
        p = self._path(fileid)
198
 
        try:
199
 
            return gzip.GzipFile(p + '.gz', 'rb')
200
 
        except IOError, e:
201
 
            if e.errno != errno.ENOENT:
202
 
                raise
203
 
 
204
 
        try:
205
 
            return file(p, 'rb')
206
 
        except IOError, e:
207
 
            if e.errno != errno.ENOENT:
208
 
                raise
209
 
 
210
 
        raise IndexError(fileid)
211
 
 
212
 
 
213
 
    def total_size(self):
214
 
        """Return (count, bytes)
215
 
 
216
 
        This is the (compressed) size stored on disk, not the size of
217
 
        the content."""
218
 
        total = 0
219
 
        count = 0
220
 
        for fid in self:
221
 
            count += 1
222
 
            p = self._path(fid)
223
 
            try:
224
 
                total += os.stat(p)[ST_SIZE]
225
 
            except OSError:
226
 
                total += os.stat(p + '.gz')[ST_SIZE]
227
 
                
228
 
        return count, total
229
 
 
 
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)
230
133
 
231
134
 
232
135
 
234
137
    """Self-destructing test subclass of ImmutableStore.
235
138
 
236
139
    The Store only exists for the lifetime of the Python object.
237
 
 Obviously you should not put anything precious in it.
 
140
    Obviously you should not put anything precious in it.
238
141
    """
239
142
    def __init__(self):
240
143
        ImmutableStore.__init__(self, tempfile.mkdtemp())
241
144
 
242
145
    def __del__(self):
243
 
        for f in os.listdir(self._basedir):
244
 
            fpath = os.path.join(self._basedir, f)
245
 
            # needed on windows, and maybe some other filesystems
246
 
            os.chmod(fpath, 0600)
247
 
            os.remove(fpath)
248
 
        os.rmdir(self._basedir)
249
 
        mutter("%r destroyed" % self)
 
146
        self.delete_all()
 
147
        self.destroy()