← 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-01 11:19:08 UTC
  • Revision ID: mbp@sourcefrog.net-20050901111907-ff5ac13ee6fedc85
- split commit message editor functions out into own file

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
            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.
 
117
 
 
118
        Returns (count_copied, failed), where failed is a collection of ids
 
119
        that could not be copied.
 
120
        """
 
121
        pb = bzrlib.ui.ui_factory.progress_bar()
 
122
        
 
123
        pb.update('preparing to copy')
 
124
        to_copy = [id for id in ids if id not in self]
 
125
        if isinstance(other, ImmutableStore):
 
126
            return self.copy_multi_immutable(other, to_copy, pb)
 
127
        count = 0
 
128
        for id in to_copy:
 
129
            count += 1
 
130
            pb.update('copy', count, len(to_copy))
 
131
            if not permit_failure:
 
132
                self.add(other[id], id)
 
133
            else:
 
134
                try:
 
135
                    entry = other[id]
 
136
                except IndexError:
 
137
                    failures.add(id)
 
138
                    continue
 
139
                self.add(entry, id)
 
140
                
 
141
        assert count == len(to_copy)
 
142
        pb.clear()
 
143
        return count, []
 
144
 
 
145
    def copy_multi_immutable(self, other, to_copy, pb, permit_failure=False):
 
146
        from shutil import copyfile
 
147
        count = 0
 
148
        failed = set()
 
149
        for id in to_copy:
 
150
            p = self._path(id)
 
151
            other_p = other._path(id)
 
152
            try:
 
153
                copyfile(other_p, p)
 
154
            except IOError, e:
 
155
                if e.errno == errno.ENOENT:
 
156
                    if not permit_failure:
 
157
                        copyfile(other_p+".gz", p+".gz")
 
158
                    else:
 
159
                        try:
 
160
                            copyfile(other_p+".gz", p+".gz")
 
161
                        except IOError, e:
 
162
                            if e.errno == errno.ENOENT:
 
163
                                failed.add(id)
 
164
                            else:
 
165
                                raise
 
166
                else:
 
167
                    raise
 
168
            
 
169
            count += 1
 
170
            pb.update('copy', count, len(to_copy))
 
171
        assert count == len(to_copy)
 
172
        pb.clear()
 
173
        return count, failed
 
174
    
104
175
 
105
176
    def __contains__(self, fileid):
106
177
        """"""
107
 
        return os.access(self._path(fileid), os.R_OK)
 
178
        p = self._path(fileid)
 
179
        return (os.access(p, os.R_OK)
 
180
                or os.access(p + '.gz', os.R_OK))
108
181
 
 
182
    # TODO: Guard against the same thing being stored twice, compressed and uncompresse
109
183
 
110
184
    def __iter__(self):
111
 
        return iter(os.listdir(self._basedir))
 
185
        for f in os.listdir(self._basedir):
 
186
            if f[-3:] == '.gz':
 
187
                # TODO: case-insensitive?
 
188
                yield f[:-3]
 
189
            else:
 
190
                yield f
 
191
 
 
192
    def __len__(self):
 
193
        return len(os.listdir(self._basedir))
 
194
 
112
195
 
113
196
    def __getitem__(self, fileid):
114
197
        """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)
 
198
        p = self._path(fileid)
 
199
        try:
 
200
            return gzip.GzipFile(p + '.gz', 'rb')
 
201
        except IOError, e:
 
202
            if e.errno != errno.ENOENT:
 
203
                raise
 
204
 
 
205
        try:
 
206
            return file(p, 'rb')
 
207
        except IOError, e:
 
208
            if e.errno != errno.ENOENT:
 
209
                raise
 
210
 
 
211
        raise IndexError(fileid)
 
212
 
 
213
 
 
214
    def total_size(self):
 
215
        """Return (count, bytes)
 
216
 
 
217
        This is the (compressed) size stored on disk, not the size of
 
218
        the content."""
 
219
        total = 0
 
220
        count = 0
 
221
        for fid in self:
 
222
            count += 1
 
223
            p = self._path(fid)
 
224
            try:
 
225
                total += os.stat(p)[ST_SIZE]
 
226
            except OSError:
 
227
                total += os.stat(p + '.gz')[ST_SIZE]
 
228
                
 
229
        return count, total
 
230
 
133
231
 
134
232
 
135
233
 
137
235
    """Self-destructing test subclass of ImmutableStore.
138
236
 
139
237
    The Store only exists for the lifetime of the Python object.
140
 
    Obviously you should not put anything precious in it.
 
238
 Obviously you should not put anything precious in it.
141
239
    """
142
240
    def __init__(self):
143
241
        ImmutableStore.__init__(self, tempfile.mkdtemp())
144
242
 
145
243
    def __del__(self):
146
 
        self.delete_all()
147
 
        self.destroy()
 
244
        for f in os.listdir(self._basedir):
 
245
            fpath = os.path.join(self._basedir, f)
 
246
            # needed on windows, and maybe some other filesystems
 
247
            os.chmod(fpath, 0600)
 
248
            os.remove(fpath)
 
249
        os.rmdir(self._basedir)
 
250
        mutter("%r destroyed" % self)