~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/store.py

  • Committer: Martin Pool
  • Date: 2005-05-17 06:56:16 UTC
  • Revision ID: mbp@sourcefrog.net-20050517065616-6f23381d6184a8aa
- add space for un-merged patches

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
33
34
    pass
34
35
 
35
36
 
36
 
class ImmutableStore(object):
 
37
class ImmutableStore:
37
38
    """Store that holds files indexed by unique names.
38
39
 
39
40
    Files can be added, but not modified once they are in.  Typically
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'
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.  A count of copied
117
 
        ids is returned, which may be less than len(ids).
118
 
        """
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
 
        for id in to_copy:
127
 
            count += 1
128
 
            pb.update('copy', count, len(to_copy))
129
 
            if not permit_failure:
130
 
                self.add(other[id], id)
131
 
            else:
132
 
                try:
133
 
                    entry = other[id]
134
 
                except IndexError:
135
 
                    failures.add(id)
136
 
                    continue
137
 
                self.add(entry, id)
138
 
                
139
 
        assert count == len(to_copy)
140
 
        pb.clear()
141
 
        return count
142
 
 
143
 
 
144
 
    def copy_multi_immutable(self, other, to_copy, pb, permit_failure=False):
145
 
        from shutil import copyfile
146
 
        count = 0
147
 
        failed = set()
148
 
        for id in to_copy:
149
 
            p = self._path(id)
150
 
            other_p = other._path(id)
151
 
            try:
152
 
                copyfile(other_p, p)
153
 
            except IOError, e:
154
 
                if e.errno == errno.ENOENT:
155
 
                    if not permit_failure:
156
 
                        copyfile(other_p+".gz", p+".gz")
157
 
                    else:
158
 
                        try:
159
 
                            copyfile(other_p+".gz", p+".gz")
160
 
                        except IOError, e:
161
 
                            if e.errno == errno.ENOENT:
162
 
                                failed.add(id)
163
 
                            else:
164
 
                                raise
165
 
                else:
166
 
                    raise
167
 
            
168
 
            count += 1
169
 
            pb.update('copy', count, len(to_copy))
170
 
        assert count == len(to_copy)
171
 
        pb.clear()
172
 
        return count, failed
173
 
    
 
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)
 
106
            
 
107
        f.write(content)
 
108
        f.close()
 
109
 
174
110
 
175
111
    def __contains__(self, fileid):
176
112
        """"""
191
127
    def __len__(self):
192
128
        return len(os.listdir(self._basedir))
193
129
 
194
 
 
195
130
    def __getitem__(self, fileid):
196
131
        """Returns a file reading from a particular entry."""
197
132
        p = self._path(fileid)
198
133
        try:
199
134
            return gzip.GzipFile(p + '.gz', 'rb')
200
135
        except IOError, e:
201
 
            if e.errno != errno.ENOENT:
202
 
                raise
203
 
 
204
 
        try:
205
 
            return file(p, 'rb')
206
 
        except IOError, e:
207
 
            if e.errno != errno.ENOENT:
208
 
                raise
209
 
 
210
 
        raise IndexError(fileid)
211
 
 
 
136
            if e.errno == errno.ENOENT:
 
137
                return file(p, 'rb')
 
138
            else:
 
139
                raise e
212
140
 
213
141
    def total_size(self):
214
142
        """Return (count, bytes)
234
162
    """Self-destructing test subclass of ImmutableStore.
235
163
 
236
164
    The Store only exists for the lifetime of the Python object.
237
 
 Obviously you should not put anything precious in it.
 
165
    Obviously you should not put anything precious in it.
238
166
    """
239
167
    def __init__(self):
240
168
        ImmutableStore.__init__(self, tempfile.mkdtemp())