← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/store.py

  • Committer: Martin Pool
  • Date: 2005-08-29 05:13:54 UTC
  • Revision ID: mbp@sourcefrog.net-20050829051353-656edb4fe57910a6
- better debug log for loading of plugins

Show diffs side-by-side

added added

removed removed

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