~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/store.py

  • Committer: Martin Pool
  • Date: 2005-06-06 11:49:47 UTC
  • Revision ID: mbp@sourcefrog.net-20050606114947-0ad5aa9f61ce6f59
todo

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
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
        assert '/' not in id
 
78
        return os.path.join(self._basedir, id)
77
79
 
78
80
    def __repr__(self):
79
81
        return "%s(%r)" % (self.__class__.__name__, self._basedir)
82
84
        """Add contents of a file into the store.
83
85
 
84
86
        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
 
        
 
87
        # FIXME: Only works on smallish files
 
88
        # TODO: Can be optimized by copying at the same time as
 
89
        # computing the sum.
89
90
        mutter("add store entry %r" % (fileid))
90
91
        if isinstance(f, types.StringTypes):
91
92
            content = f
92
93
        else:
93
94
            content = f.read()
94
 
            
 
95
 
95
96
        p = self._path(fileid)
96
97
        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
            bailout("store %r already contains id %r" % (self._basedir, fileid))
98
99
 
99
 
        fn = p
100
100
        if compressed:
101
 
            fn = fn + '.gz'
 
101
            f = gzip.GzipFile(p + '.gz', 'wb')
 
102
            os.chmod(p + '.gz', 0444)
 
103
        else:
 
104
            f = file(p, 'wb')
 
105
            os.chmod(p, 0444)
102
106
            
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):
 
107
        f.write(content)
 
108
        f.close()
 
109
 
 
110
    def copy_multi(self, other, ids):
117
111
        """Copy texts for ids from other into self.
118
112
 
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.
 
113
        If an id is present in self, it is skipped.  A count of copied
 
114
        ids is returned, which may be less than len(ids).
123
115
        """
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
 
    
 
116
        count = 0
 
117
        for id in ids:
 
118
            if id in self:
 
119
                continue
 
120
            self.add(other[id], id)
 
121
            count += 1
 
122
        return count
180
123
 
181
124
    def __contains__(self, fileid):
182
125
        """"""
197
140
    def __len__(self):
198
141
        return len(os.listdir(self._basedir))
199
142
 
200
 
 
201
143
    def __getitem__(self, fileid):
202
144
        """Returns a file reading from a particular entry."""
203
145
        p = self._path(fileid)
204
146
        try:
205
147
            return gzip.GzipFile(p + '.gz', 'rb')
206
148
        except IOError, e:
207
 
            if e.errno != errno.ENOENT:
208
 
                raise
209
 
 
210
 
        try:
211
 
            return file(p, 'rb')
212
 
        except IOError, e:
213
 
            if e.errno != errno.ENOENT:
214
 
                raise
215
 
 
216
 
        raise IndexError(fileid)
217
 
 
 
149
            if e.errno == errno.ENOENT:
 
150
                return file(p, 'rb')
 
151
            else:
 
152
                raise e
218
153
 
219
154
    def total_size(self):
220
155
        """Return (count, bytes)
240
175
    """Self-destructing test subclass of ImmutableStore.
241
176
 
242
177
    The Store only exists for the lifetime of the Python object.
243
 
 Obviously you should not put anything precious in it.
 
178
    Obviously you should not put anything precious in it.
244
179
    """
245
180
    def __init__(self):
246
181
        ImmutableStore.__init__(self, tempfile.mkdtemp())