← 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-28 13:20:38 UTC
  • Revision ID: mbp@sourcefrog.net-20050328132038-3a8a5fb9f1023ee1
more check functions

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
 
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
25
27
from stat import ST_SIZE
26
28
from StringIO import StringIO
27
29
from trace import mutter
28
30
 
 
31
 
29
32
######################################################################
30
33
# stores
31
34
 
33
36
    pass
34
37
 
35
38
 
36
 
class ImmutableStore(object):
 
39
class ImmutableStore:
37
40
    """Store that holds files indexed by unique names.
38
41
 
39
42
    Files can be added, but not modified once they are in.  Typically
56
59
    >>> st['123123'].read()
57
60
    'goodbye'
58
61
 
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.
 
62
    :todo: Atomic add by writing to a temporary file and renaming.
 
63
 
 
64
    :todo: Perhaps automatically transform to/from XML in a method?
 
65
           Would just need to tell the constructor what class to
 
66
           use...
 
67
 
 
68
    :todo: Even within a simple disk store like this, we could
 
69
           gzip the files.  But since many are less than one disk
 
70
           block, that might not help a lot.
 
71
 
64
72
    """
65
73
 
66
74
    def __init__(self, basedir):
 
75
        """ImmutableStore constructor."""
67
76
        self._basedir = basedir
68
77
 
69
78
    def _path(self, id):
70
 
        if '\\' in id or '/' in id:
71
 
            raise ValueError("invalid store id %r" % id)
72
79
        return os.path.join(self._basedir, id)
73
80
 
74
81
    def __repr__(self):
75
82
        return "%s(%r)" % (self.__class__.__name__, self._basedir)
76
83
 
77
 
    def add(self, f, fileid, compressed=True):
 
84
    def add(self, f, fileid):
78
85
        """Add contents of a file into the store.
79
86
 
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
 
        
 
87
        :param f: An open file, or file-like object."""
 
88
        # FIXME: Only works on smallish files
 
89
        # TODO: Can be optimized by copying at the same time as
 
90
        # computing the sum.
85
91
        mutter("add store entry %r" % (fileid))
86
92
        if isinstance(f, types.StringTypes):
87
93
            content = f
88
94
        else:
89
95
            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
 
            raise BzrError("store %r already contains id %r" % (self._basedir, fileid))
94
 
 
95
 
        fn = p
96
 
        if compressed:
97
 
            fn = fn + '.gz'
98
 
            
99
 
        af = AtomicFile(fn, 'wb')
100
 
        try:
101
 
            if compressed:
102
 
                gf = gzip.GzipFile(mode='wb', fileobj=af)
103
 
                gf.write(content)
104
 
                gf.close()
105
 
            else:
106
 
                af.write(content)
107
 
            af.commit()
108
 
        finally:
109
 
            af.close()
110
 
 
111
 
 
112
 
    def copy_multi(self, other, ids):
113
 
        """Copy texts for ids from other into self.
114
 
 
115
 
        If an id is present in self, it is skipped.  A count of copied
116
 
        ids is returned, which may be less than len(ids).
117
 
        """
118
 
        from bzrlib.progress import ProgressBar
119
 
        pb = ProgressBar()
120
 
        pb.update('preparing to copy')
121
 
        to_copy = [id for id in ids if id not in self]
122
 
        if isinstance(other, ImmutableStore):
123
 
            return self.copy_multi_immutable(other, to_copy, pb)
124
 
        count = 0
125
 
        for id in to_copy:
126
 
            count += 1
127
 
            pb.update('copy', count, len(to_copy))
128
 
            self.add(other[id], id)
129
 
        assert count == len(to_copy)
130
 
        pb.clear()
131
 
        return count
132
 
 
133
 
 
134
 
    def copy_multi_immutable(self, other, to_copy, pb):
135
 
        from shutil import copyfile
136
 
        count = 0
137
 
        for id in to_copy:
138
 
            p = self._path(id)
139
 
            other_p = other._path(id)
140
 
            try:
141
 
                copyfile(other_p, p)
142
 
            except IOError, e:
143
 
                if e.errno == errno.ENOENT:
144
 
                    copyfile(other_p+".gz", p+".gz")
145
 
                else:
146
 
                    raise
147
 
            
148
 
            count += 1
149
 
            pb.update('copy', count, len(to_copy))
150
 
        assert count == len(to_copy)
151
 
        pb.clear()
152
 
        return count
153
 
    
 
96
        if fileid not in self:
 
97
            filename = self._path(fileid)
 
98
            f = file(filename, 'wb')
 
99
            f.write(content)
 
100
            ## f.flush()
 
101
            ## os.fsync(f.fileno())
 
102
            f.close()
 
103
            osutils.make_readonly(filename)
 
104
 
154
105
 
155
106
    def __contains__(self, fileid):
156
107
        """"""
157
 
        p = self._path(fileid)
158
 
        return (os.access(p, os.R_OK)
159
 
                or os.access(p + '.gz', os.R_OK))
 
108
        return os.access(self._path(fileid), os.R_OK)
160
109
 
161
 
    # TODO: Guard against the same thing being stored twice, compressed and uncompresse
162
110
 
163
111
    def __iter__(self):
164
 
        for f in os.listdir(self._basedir):
165
 
            if f[-3:] == '.gz':
166
 
                # TODO: case-insensitive?
167
 
                yield f[:-3]
168
 
            else:
169
 
                yield f
 
112
        return iter(os.listdir(self._basedir))
170
113
 
171
114
    def __len__(self):
172
115
        return len(os.listdir(self._basedir))
173
116
 
174
117
    def __getitem__(self, fileid):
175
118
        """Returns a file reading from a particular entry."""
176
 
        p = self._path(fileid)
177
 
        try:
178
 
            return gzip.GzipFile(p + '.gz', 'rb')
179
 
        except IOError, e:
180
 
            if e.errno == errno.ENOENT:
181
 
                return file(p, 'rb')
182
 
            else:
183
 
                raise e
 
119
        return file(self._path(fileid), 'rb')
184
120
 
185
121
    def total_size(self):
186
 
        """Return (count, bytes)
187
 
 
188
 
        This is the (compressed) size stored on disk, not the size of
189
 
        the content."""
 
122
        """Return (count, bytes)"""
190
123
        total = 0
191
124
        count = 0
192
125
        for fid in self:
193
126
            count += 1
194
 
            p = self._path(fid)
195
 
            try:
196
 
                total += os.stat(p)[ST_SIZE]
197
 
            except OSError:
198
 
                total += os.stat(p + '.gz')[ST_SIZE]
199
 
                
 
127
            total += os.stat(self._path(fid))[ST_SIZE]
200
128
        return count, total
201
129
 
 
130
    def delete_all(self):
 
131
        for fileid in self:
 
132
            self.delete(fileid)
 
133
 
 
134
    def delete(self, fileid):
 
135
        """Remove nominated store entry.
 
136
 
 
137
        Most stores will be add-only."""
 
138
        filename = self._path(fileid)
 
139
        ## osutils.make_writable(filename)
 
140
        os.remove(filename)
 
141
 
 
142
    def destroy(self):
 
143
        """Remove store; only allowed if it is empty."""
 
144
        os.rmdir(self._basedir)
 
145
        mutter("%r destroyed" % self)
202
146
 
203
147
 
204
148
 
206
150
    """Self-destructing test subclass of ImmutableStore.
207
151
 
208
152
    The Store only exists for the lifetime of the Python object.
209
 
 Obviously you should not put anything precious in it.
 
153
    Obviously you should not put anything precious in it.
210
154
    """
211
155
    def __init__(self):
212
156
        ImmutableStore.__init__(self, tempfile.mkdtemp())
213
157
 
214
158
    def __del__(self):
215
 
        for f in os.listdir(self._basedir):
216
 
            fpath = os.path.join(self._basedir, f)
217
 
            # needed on windows, and maybe some other filesystems
218
 
            os.chmod(fpath, 0600)
219
 
            os.remove(fpath)
220
 
        os.rmdir(self._basedir)
221
 
        mutter("%r destroyed" % self)
 
159
        self.delete_all()
 
160
        self.destroy()