← 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-09-16 09:14:54 UTC
  • Revision ID: mbp@sourcefrog.net-20050916091454-092fc433a3d9cc31
- cosmetic

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.errors import BzrError
 
28
from bzrlib.trace import mutter
 
29
import bzrlib.ui
30
30
 
31
31
######################################################################
32
32
# stores
35
35
    pass
36
36
 
37
37
 
38
 
class ImmutableStore:
 
38
class ImmutableStore(object):
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
 
    :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
 
 
 
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.
71
66
    """
72
67
 
73
68
    def __init__(self, basedir):
74
 
        """ImmutableStore constructor."""
75
69
        self._basedir = basedir
76
70
 
77
 
    def _path(self, id):
78
 
        return os.path.join(self._basedir, id)
 
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)
79
77
 
80
78
    def __repr__(self):
81
79
        return "%s(%r)" % (self.__class__.__name__, self._basedir)
82
80
 
83
 
    def add(self, f, fileid):
 
81
    def add(self, f, fileid, compressed=True):
84
82
        """Add contents of a file into the store.
85
83
 
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.
 
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
        
90
89
        mutter("add store entry %r" % (fileid))
91
90
        if isinstance(f, types.StringTypes):
92
91
            content = f
93
92
        else:
94
93
            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
 
 
 
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
        count = 0
 
131
        failed = set()
 
132
        for id in to_copy:
 
133
            count += 1
 
134
            pb.update('copy', count, len(to_copy))
 
135
            if not permit_failure:
 
136
                self.add(other[id], id)
 
137
            else:
 
138
                try:
 
139
                    entry = other[id]
 
140
                except IndexError:
 
141
                    failed.add(id)
 
142
                    continue
 
143
                self.add(entry, id)
 
144
                
 
145
        if not permit_failure:
 
146
            assert count == len(to_copy)
 
147
        pb.clear()
 
148
        return count, failed
 
149
 
 
150
    def copy_multi_immutable(self, other, to_copy, pb, permit_failure=False):
 
151
        from shutil import copyfile
 
152
        count = 0
 
153
        failed = set()
 
154
        for id in to_copy:
 
155
            p = self._path(id)
 
156
            other_p = other._path(id)
 
157
            try:
 
158
                copyfile(other_p, p)
 
159
            except IOError, e:
 
160
                if e.errno == errno.ENOENT:
 
161
                    if not permit_failure:
 
162
                        copyfile(other_p+".gz", p+".gz")
 
163
                    else:
 
164
                        try:
 
165
                            copyfile(other_p+".gz", p+".gz")
 
166
                        except IOError, e:
 
167
                            if e.errno == errno.ENOENT:
 
168
                                failed.add(id)
 
169
                            else:
 
170
                                raise
 
171
                else:
 
172
                    raise
 
173
            
 
174
            count += 1
 
175
            pb.update('copy', count, len(to_copy))
 
176
        assert count == len(to_copy)
 
177
        pb.clear()
 
178
        return count, failed
 
179
    
104
180
 
105
181
    def __contains__(self, fileid):
106
182
        """"""
107
 
        return os.access(self._path(fileid), os.R_OK)
 
183
        p = self._path(fileid)
 
184
        return (os.access(p, os.R_OK)
 
185
                or os.access(p + '.gz', os.R_OK))
108
186
 
 
187
    # TODO: Guard against the same thing being stored twice,
 
188
    # compressed and uncompressed
109
189
 
110
190
    def __iter__(self):
111
 
        return iter(os.listdir(self._basedir))
 
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
 
112
201
 
113
202
    def __getitem__(self, fileid):
114
203
        """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)
 
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 IndexError(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
 
133
237
 
134
238
 
135
239
 
137
241
    """Self-destructing test subclass of ImmutableStore.
138
242
 
139
243
    The Store only exists for the lifetime of the Python object.
140
 
    Obviously you should not put anything precious in it.
 
244
 Obviously you should not put anything precious in it.
141
245
    """
142
246
    def __init__(self):
143
247
        ImmutableStore.__init__(self, tempfile.mkdtemp())
144
248
 
145
249
    def __del__(self):
146
 
        self.delete_all()
147
 
        self.destroy()
 
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)