~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/store.py

  • Committer: Martin Pool
  • Date: 2005-05-05 06:38:18 UTC
  • Revision ID: mbp@sourcefrog.net-20050505063818-3eb3260343878325
- do upload CHANGELOG to web server, even though it's autogenerated

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.trace import mutter
28
 
import bzrlib.ui
 
28
from trace import mutter
29
29
 
30
30
######################################################################
31
31
# stores
34
34
    pass
35
35
 
36
36
 
37
 
class ImmutableStore(object):
 
37
class ImmutableStore:
38
38
    """Store that holds files indexed by unique names.
39
39
 
40
40
    Files can be added, but not modified once they are in.  Typically
59
59
 
60
60
    TODO: Atomic add by writing to a temporary file and renaming.
61
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.
 
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
 
65
70
    """
66
71
 
67
72
    def __init__(self, basedir):
 
73
        """ImmutableStore constructor."""
68
74
        self._basedir = basedir
69
75
 
70
76
    def _path(self, id):
71
 
        if '\\' in id or '/' in id:
72
 
            raise ValueError("invalid store id %r" % id)
73
77
        return os.path.join(self._basedir, id)
74
78
 
75
79
    def __repr__(self):
79
83
        """Add contents of a file into the store.
80
84
 
81
85
        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
 
        
 
86
        # FIXME: Only works on smallish files
 
87
        # TODO: Can be optimized by copying at the same time as
 
88
        # computing the sum.
86
89
        mutter("add store entry %r" % (fileid))
87
90
        if isinstance(f, types.StringTypes):
88
91
            content = f
89
92
        else:
90
93
            content = f.read()
91
 
            
 
94
 
92
95
        p = self._path(fileid)
93
96
        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))
 
97
            bailout("store %r already contains id %r" % (self._basedir, fileid))
95
98
 
96
 
        fn = p
97
99
        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
 
    
 
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
 
175
109
 
176
110
    def __contains__(self, fileid):
177
111
        """"""
192
126
    def __len__(self):
193
127
        return len(os.listdir(self._basedir))
194
128
 
195
 
 
196
129
    def __getitem__(self, fileid):
197
130
        """Returns a file reading from a particular entry."""
198
131
        p = self._path(fileid)
199
132
        try:
200
133
            return gzip.GzipFile(p + '.gz', 'rb')
201
134
        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
 
 
 
135
            if e.errno == errno.ENOENT:
 
136
                return file(p, 'rb')
 
137
            else:
 
138
                raise e
213
139
 
214
140
    def total_size(self):
215
141
        """Return (count, bytes)
235
161
    """Self-destructing test subclass of ImmutableStore.
236
162
 
237
163
    The Store only exists for the lifetime of the Python object.
238
 
 Obviously you should not put anything precious in it.
 
164
    Obviously you should not put anything precious in it.
239
165
    """
240
166
    def __init__(self):
241
167
        ImmutableStore.__init__(self, tempfile.mkdtemp())