~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/store.py

  • Committer: Martin Pool
  • Date: 2005-06-10 06:34:26 UTC
  • Revision ID: mbp@sourcefrog.net-20050610063426-cfcf5c0f96c271ec
- split out updated progress indicator

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
58
59
 
59
60
    TODO: Atomic add by writing to a temporary file and renaming.
60
61
 
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: 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
 
64
70
    """
65
71
 
66
72
    def __init__(self, basedir):
 
73
        """ImmutableStore constructor."""
67
74
        self._basedir = basedir
68
75
 
69
76
    def _path(self, id):
70
 
        if '\\' in id or '/' in id:
71
 
            raise ValueError("invalid store id %r" % id)
 
77
        assert '/' not in id
72
78
        return os.path.join(self._basedir, id)
73
79
 
74
80
    def __repr__(self):
78
84
        """Add contents of a file into the store.
79
85
 
80
86
        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
        # FIXME: Only works on smallish files
 
88
        # TODO: Can be optimized by copying at the same time as
 
89
        # computing the sum.
85
90
        mutter("add store entry %r" % (fileid))
86
91
        if isinstance(f, types.StringTypes):
87
92
            content = f
88
93
        else:
89
94
            content = f.read()
90
 
            
 
95
 
91
96
        p = self._path(fileid)
92
97
        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))
 
98
            bailout("store %r already contains id %r" % (self._basedir, fileid))
95
99
 
96
 
        fn = p
97
100
        if compressed:
98
 
            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)
99
106
            
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):
 
107
        f.write(content)
 
108
        f.close()
 
109
 
 
110
    def copy_multi(self, other, ids):
114
111
        """Copy texts for ids from other into self.
115
112
 
116
113
        If an id is present in self, it is skipped.  A count of copied
117
114
        ids is returned, which may be less than len(ids).
118
115
        """
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
 
        failed = set()
127
 
        for id in to_copy:
128
 
            count += 1
129
 
            pb.update('copy', count, len(to_copy))
130
 
            if not permit_failure:
131
 
                self.add(other[id], id)
132
 
            else:
133
 
                try:
134
 
                    entry = other[id]
135
 
                except IndexError:
136
 
                    failed.add(id)
137
 
                    continue
138
 
                self.add(entry, id)
139
 
                
140
 
        if not permit_failure:
141
 
            assert count == len(to_copy)
142
 
        pb.clear()
143
 
        return count, failed
144
 
 
145
 
 
146
 
    def copy_multi_immutable(self, other, to_copy, pb, permit_failure=False):
147
 
        from shutil import copyfile
148
 
        count = 0
149
 
        failed = set()
150
 
        for id in to_copy:
151
 
            p = self._path(id)
152
 
            other_p = other._path(id)
153
 
            try:
154
 
                copyfile(other_p, p)
155
 
            except IOError, e:
156
 
                if e.errno == errno.ENOENT:
157
 
                    if not permit_failure:
158
 
                        copyfile(other_p+".gz", p+".gz")
159
 
                    else:
160
 
                        try:
161
 
                            copyfile(other_p+".gz", p+".gz")
162
 
                        except IOError, e:
163
 
                            if e.errno == errno.ENOENT:
164
 
                                failed.add(id)
165
 
                            else:
166
 
                                raise
167
 
                else:
168
 
                    raise
169
 
            
170
 
            count += 1
171
 
            pb.update('copy', count, len(to_copy))
172
 
        assert count == len(to_copy)
173
 
        pb.clear()
174
 
        return count, failed
175
 
    
 
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
176
123
 
177
124
    def __contains__(self, fileid):
178
125
        """"""
193
140
    def __len__(self):
194
141
        return len(os.listdir(self._basedir))
195
142
 
196
 
 
197
143
    def __getitem__(self, fileid):
198
144
        """Returns a file reading from a particular entry."""
199
145
        p = self._path(fileid)
200
146
        try:
201
147
            return gzip.GzipFile(p + '.gz', 'rb')
202
148
        except IOError, e:
203
 
            if e.errno != errno.ENOENT:
204
 
                raise
205
 
 
206
 
        try:
207
 
            return file(p, 'rb')
208
 
        except IOError, e:
209
 
            if e.errno != errno.ENOENT:
210
 
                raise
211
 
 
212
 
        raise IndexError(fileid)
213
 
 
 
149
            if e.errno == errno.ENOENT:
 
150
                return file(p, 'rb')
 
151
            else:
 
152
                raise e
214
153
 
215
154
    def total_size(self):
216
155
        """Return (count, bytes)
236
175
    """Self-destructing test subclass of ImmutableStore.
237
176
 
238
177
    The Store only exists for the lifetime of the Python object.
239
 
 Obviously you should not put anything precious in it.
 
178
    Obviously you should not put anything precious in it.
240
179
    """
241
180
    def __init__(self):
242
181
        ImmutableStore.__init__(self, tempfile.mkdtemp())