← 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-05-03 08:00:27 UTC
  • Revision ID: mbp@sourcefrog.net-20050503080027-908edb5b39982198
doc

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/store.py
1
 
# Copyright (C) 2005 by Canonical Development Ltd
 
1
 
2
2
 
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
 
"""
18
 
Stores are the main data-storage mechanism for Bazaar-NG.
 
17
"""Stores are the main data-storage mechanism for Bazaar-NG.
19
18
 
20
19
A store is a simple write-once container indexed by a universally
21
 
unique ID.
22
 
"""
 
20
unique ID, which is typically the SHA-1 of the content."""
 
21
 
 
22
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
 
23
__author__ = "Martin Pool <mbp@canonical.com>"
23
24
 
24
25
import os, tempfile, types, osutils, gzip, errno
25
26
from stat import ST_SIZE
26
27
from StringIO import StringIO
27
 
from bzrlib.errors import BzrError
28
 
from bzrlib.trace import mutter
29
 
import bzrlib.ui
 
28
from trace import mutter
30
29
 
31
30
######################################################################
32
31
# stores
35
34
    pass
36
35
 
37
36
 
38
 
class ImmutableStore(object):
 
37
class ImmutableStore:
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
60
59
 
61
60
    TODO: Atomic add by writing to a temporary file and renaming.
62
61
 
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.
 
62
    TODO: Perhaps automatically transform to/from XML in a method?
 
63
           Would just need to tell the constructor what class to
 
64
           use...
 
65
 
 
66
    TODO: Even within a simple disk store like this, we could
 
67
           gzip the files.  But since many are less than one disk
 
68
           block, that might not help a lot.
 
69
 
66
70
    """
67
71
 
68
72
    def __init__(self, basedir):
 
73
        """ImmutableStore constructor."""
69
74
        self._basedir = basedir
70
75
 
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)
 
76
    def _path(self, id):
 
77
        return os.path.join(self._basedir, id)
77
78
 
78
79
    def __repr__(self):
79
80
        return "%s(%r)" % (self.__class__.__name__, self._basedir)
82
83
        """Add contents of a file into the store.
83
84
 
84
85
        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
 
        
 
86
        # FIXME: Only works on smallish files
 
87
        # TODO: Can be optimized by copying at the same time as
 
88
        # computing the sum.
89
89
        mutter("add store entry %r" % (fileid))
90
90
        if isinstance(f, types.StringTypes):
91
91
            content = f
92
92
        else:
93
93
            content = f.read()
94
 
            
 
94
 
95
95
        p = self._path(fileid)
96
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))
 
97
            bailout("store %r already contains id %r" % (self._basedir, fileid))
98
98
 
99
 
        fn = p
100
99
        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
 
                                             permit_failure=permit_failure)
131
 
        count = 0
132
 
        failed = set()
133
 
        for id in to_copy:
134
 
            count += 1
135
 
            pb.update('copy', count, len(to_copy))
136
 
            if not permit_failure:
137
 
                self.add(other[id], id)
138
 
            else:
139
 
                try:
140
 
                    entry = other[id]
141
 
                except KeyError:
142
 
                    failed.add(id)
143
 
                    continue
144
 
                self.add(entry, id)
145
 
                
146
 
        if not permit_failure:
147
 
            assert count == len(to_copy)
148
 
        pb.clear()
149
 
        return count, failed
150
 
 
151
 
    def copy_multi_immutable(self, other, to_copy, pb, permit_failure=False):
152
 
        from shutil import copyfile
153
 
        count = 0
154
 
        failed = set()
155
 
        for id in to_copy:
156
 
            p = self._path(id)
157
 
            other_p = other._path(id)
158
 
            try:
159
 
                copyfile(other_p, p)
160
 
            except IOError, e:
161
 
                if e.errno == errno.ENOENT:
162
 
                    if not permit_failure:
163
 
                        copyfile(other_p+".gz", p+".gz")
164
 
                    else:
165
 
                        try:
166
 
                            copyfile(other_p+".gz", p+".gz")
167
 
                        except IOError, e:
168
 
                            if e.errno == errno.ENOENT:
169
 
                                failed.add(id)
170
 
                            else:
171
 
                                raise
172
 
                else:
173
 
                    raise
174
 
            
175
 
            count += 1
176
 
            pb.update('copy', count, len(to_copy))
177
 
        assert count == len(to_copy)
178
 
        pb.clear()
179
 
        return count, failed
180
 
    
 
100
            f = gzip.GzipFile(p + '.gz', 'wb')
 
101
            os.chmod(p + '.gz', 0444)
 
102
        else:
 
103
            f = file(p, 'wb')
 
104
            os.chmod(p, 0444)
 
105
            
 
106
        f.write(content)
 
107
        f.close()
 
108
 
181
109
 
182
110
    def __contains__(self, fileid):
183
111
        """"""
198
126
    def __len__(self):
199
127
        return len(os.listdir(self._basedir))
200
128
 
201
 
 
202
129
    def __getitem__(self, fileid):
203
130
        """Returns a file reading from a particular entry."""
204
131
        p = self._path(fileid)
205
132
        try:
206
133
            return gzip.GzipFile(p + '.gz', 'rb')
207
134
        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 KeyError(fileid)
218
 
 
 
135
            if e.errno == errno.ENOENT:
 
136
                return file(p, 'rb')
 
137
            else:
 
138
                raise e
219
139
 
220
140
    def total_size(self):
221
141
        """Return (count, bytes)
241
161
    """Self-destructing test subclass of ImmutableStore.
242
162
 
243
163
    The Store only exists for the lifetime of the Python object.
244
 
 Obviously you should not put anything precious in it.
 
164
    Obviously you should not put anything precious in it.
245
165
    """
246
166
    def __init__(self):
247
167
        ImmutableStore.__init__(self, tempfile.mkdtemp())