← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/store.py

  • Committer: Robert Collins
  • Date: 2005-08-23 06:52:09 UTC
  • mto: (974.1.50) (1185.1.10) (1092.3.1)
  • mto: This revision was merged to the branch mainline in revision 1139.
  • Revision ID: robertc@robertcollins.net-20050823065209-81cd5962c401751b
move io redirection into each test case from the global runner

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