~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/store.py

  • Committer: Martin Pool
  • Date: 2005-04-26 23:44:41 UTC
  • Revision ID: mbp@sourcefrog.net-20050426234441-0e9b3825bdaaa5c2
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
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
76
    def _path(self, id):
72
 
        if '\\' in id or '/' in id:
73
 
            raise ValueError("invalid store id %r" % id)
74
77
        return os.path.join(self._basedir, id)
75
78
 
76
79
    def __repr__(self):
80
83
        """Add contents of a file into the store.
81
84
 
82
85
        f -- An open file, or file-like object."""
83
 
        # FIXME: Only works on files that will fit in memory
84
 
        
85
 
        from bzrlib.atomicfile import AtomicFile
86
 
        
 
86
        # FIXME: Only works on smallish files
 
87
        # TODO: Can be optimized by copying at the same time as
 
88
        # computing the sum.
87
89
        mutter("add store entry %r" % (fileid))
88
90
        if isinstance(f, types.StringTypes):
89
91
            content = f
90
92
        else:
91
93
            content = f.read()
92
 
            
 
94
 
93
95
        p = self._path(fileid)
94
96
        if os.access(p, os.F_OK) or os.access(p + '.gz', os.F_OK):
95
 
            raise BzrError("store %r already contains id %r" % (self._basedir, fileid))
 
97
            bailout("store %r already contains id %r" % (self._basedir, fileid))
96
98
 
97
 
        fn = p
98
99
        if compressed:
99
 
            fn = fn + '.gz'
100
 
            
101
 
        af = AtomicFile(fn, 'wb')
102
 
        try:
103
 
            if compressed:
104
 
                gf = gzip.GzipFile(mode='wb', fileobj=af)
105
 
                gf.write(content)
106
 
                gf.close()
107
 
            else:
108
 
                af.write(content)
109
 
            af.commit()
110
 
        finally:
111
 
            af.close()
112
 
 
113
 
 
114
 
    def copy_multi(self, other, ids, permit_failure=False):
115
 
        """Copy texts for ids from other into self.
116
 
 
117
 
        If an id is present in self, it is skipped.
118
 
 
119
 
        Returns (count_copied, failed), where failed is a collection of ids
120
 
        that could not be copied.
121
 
        """
122
 
        pb = bzrlib.ui.ui_factory.progress_bar()
123
 
        
124
 
        pb.update('preparing to copy')
125
 
        to_copy = [id for id in ids if id not in self]
126
 
        if isinstance(other, ImmutableStore):
127
 
            return self.copy_multi_immutable(other, to_copy, pb)
128
 
        count = 0
129
 
        failed = set()
130
 
        for id in to_copy:
131
 
            count += 1
132
 
            pb.update('copy', count, len(to_copy))
133
 
            if not permit_failure:
134
 
                self.add(other[id], id)
135
 
            else:
136
 
                try:
137
 
                    entry = other[id]
138
 
                except IndexError:
139
 
                    failed.add(id)
140
 
                    continue
141
 
                self.add(entry, id)
142
 
                
143
 
        if not permit_failure:
144
 
            assert count == len(to_copy)
145
 
        pb.clear()
146
 
        return count, failed
147
 
 
148
 
    def copy_multi_immutable(self, other, to_copy, pb, permit_failure=False):
149
 
        from shutil import copyfile
150
 
        count = 0
151
 
        failed = set()
152
 
        for id in to_copy:
153
 
            p = self._path(id)
154
 
            other_p = other._path(id)
155
 
            try:
156
 
                copyfile(other_p, p)
157
 
            except IOError, e:
158
 
                if e.errno == errno.ENOENT:
159
 
                    if not permit_failure:
160
 
                        copyfile(other_p+".gz", p+".gz")
161
 
                    else:
162
 
                        try:
163
 
                            copyfile(other_p+".gz", p+".gz")
164
 
                        except IOError, e:
165
 
                            if e.errno == errno.ENOENT:
166
 
                                failed.add(id)
167
 
                            else:
168
 
                                raise
169
 
                else:
170
 
                    raise
171
 
            
172
 
            count += 1
173
 
            pb.update('copy', count, len(to_copy))
174
 
        assert count == len(to_copy)
175
 
        pb.clear()
176
 
        return count, failed
177
 
    
 
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
 
178
109
 
179
110
    def __contains__(self, fileid):
180
111
        """"""
195
126
    def __len__(self):
196
127
        return len(os.listdir(self._basedir))
197
128
 
198
 
 
199
129
    def __getitem__(self, fileid):
200
130
        """Returns a file reading from a particular entry."""
201
131
        p = self._path(fileid)
202
132
        try:
203
133
            return gzip.GzipFile(p + '.gz', 'rb')
204
134
        except IOError, e:
205
 
            if e.errno != errno.ENOENT:
206
 
                raise
207
 
 
208
 
        try:
209
 
            return file(p, 'rb')
210
 
        except IOError, e:
211
 
            if e.errno != errno.ENOENT:
212
 
                raise
213
 
 
214
 
        raise IndexError(fileid)
215
 
 
 
135
            if e.errno == errno.ENOENT:
 
136
                return file(p, 'rb')
 
137
            else:
 
138
                raise e
216
139
 
217
140
    def total_size(self):
218
141
        """Return (count, bytes)
238
161
    """Self-destructing test subclass of ImmutableStore.
239
162
 
240
163
    The Store only exists for the lifetime of the Python object.
241
 
 Obviously you should not put anything precious in it.
 
164
    Obviously you should not put anything precious in it.
242
165
    """
243
166
    def __init__(self):
244
167
        ImmutableStore.__init__(self, tempfile.mkdtemp())