~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/store/text.py

  • Committer: John Arbash Meinel
  • Date: 2005-09-29 20:54:18 UTC
  • mto: (1393.1.12)
  • mto: This revision was merged to the branch mainline in revision 1396.
  • Revision ID: john@arbash-meinel.com-20050929205418-009b4b02254baf64
Updated stores to use Transport

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005 by Canonical Development Ltd
 
2
 
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
 
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
 
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
"""
 
18
A store that keeps the full text of every version.
 
19
 
 
20
This store keeps uncompressed versions of the full text. It does not
 
21
do any sort of delta compression.
 
22
"""
 
23
 
 
24
import os, tempfile
 
25
 
 
26
import bzrlib.store
 
27
from bzrlib.trace import mutter
 
28
from bzrlib.errors import BzrError
 
29
 
 
30
from cStringIO import StringIO
 
31
from stat import ST_SIZE
 
32
 
 
33
class TextStore(bzrlib.store.Store):
 
34
    """Store that holds files indexed by unique names.
 
35
 
 
36
    Files can be added, but not modified once they are in.  Typically
 
37
    the hash is used as the name, or something else known to be unique,
 
38
    such as a UUID.
 
39
 
 
40
    Files are stored gzip compressed, with no delta compression.
 
41
 
 
42
    """
 
43
 
 
44
    def __init__(self, basedir):
 
45
        super(TextStore, self).__init__(basedir)
 
46
 
 
47
    def _check_fileid(self, fileid):
 
48
        if not isinstance(fileid, basestring):
 
49
            raise TypeError('Fileids should be a string type: %s %r' % (type(fileid), fileid))
 
50
        if '\\' in fileid or '/' in fileid:
 
51
            raise ValueError("invalid store id %r" % fileid)
 
52
 
 
53
    def _relpath(self, fileid):
 
54
        self._check_fileid(fileid)
 
55
        return fileid
 
56
 
 
57
    def add(self, f, fileid):
 
58
        """Add contents of a file into the store.
 
59
 
 
60
        f -- A file-like object, or string
 
61
        """
 
62
        mutter("add store entry %r" % (fileid))
 
63
            
 
64
        fn = self._relpath(fileid)
 
65
        if self._transport.has(fn):
 
66
            raise BzrError("store %r already contains id %r" % (self._transport.base, fileid))
 
67
 
 
68
        self._transport.put(fn, f)
 
69
 
 
70
    def _do_copy(self, other, to_copy, pb, permit_failure=False):
 
71
        if isinstance(other, TextStore):
 
72
            return self._copy_multi_text(other, to_copy, pb,
 
73
                    permit_failure=permit_failure)
 
74
        return super(TextStore, self)._do_copy(other, to_copy,
 
75
                pb, permit_failure=permit_failure)
 
76
 
 
77
    def _copy_multi_text(self, other, to_copy, pb,
 
78
            permit_failure=False):
 
79
        # Because of _transport, we can no longer assume
 
80
        # that they are on the same filesystem, we can, however
 
81
        # assume that we only need to copy the exact bytes,
 
82
        # we don't need to process the files.
 
83
 
 
84
        failed = set()
 
85
        if permit_failure:
 
86
            new_to_copy = set()
 
87
            for fileid, has in zip(to_copy, other.has(to_copy)):
 
88
                if has:
 
89
                    new_to_copy.add(fileid)
 
90
                else:
 
91
                    failed.add(fileid)
 
92
            to_copy = new_to_copy
 
93
            #mutter('_copy_multi_text copying %s, failed %s' % (to_copy, failed))
 
94
 
 
95
        paths = [self._relpath(fileid) for fileid in to_copy]
 
96
        count = other._transport.copy_to(paths, self._transport, pb=pb)
 
97
        assert count == len(to_copy)
 
98
        return count, failed
 
99
 
 
100
    def __contains__(self, fileid):
 
101
        """"""
 
102
        fn = self._relpath(fileid)
 
103
        return self._transport.has(fn)
 
104
 
 
105
    def has(self, fileids, pb=None):
 
106
        """Return True/False for each entry in fileids.
 
107
 
 
108
        :param fileids: A List or generator yielding file ids.
 
109
        :return: A generator or list returning True/False for each entry.
 
110
        """
 
111
        relpaths = (self._relpath(fid) for fid in fileids)
 
112
        return self._transport.has_multi(relpaths, pb=pb)
 
113
 
 
114
    def get(self, fileids, permit_failure=False, pb=None):
 
115
        """Return a set of files, one for each requested entry.
 
116
        
 
117
        TODO: Write some tests to make sure that permit_failure is
 
118
              handled correctly.
 
119
 
 
120
        TODO: What should the exception be for a missing file?
 
121
              KeyError, or NoSuchFile?
 
122
        """
 
123
 
 
124
        # This next code gets a bit hairy because it can allow
 
125
        # to not request a file which doesn't seem to exist.
 
126
        # Also, the same fileid may be requested twice, so we
 
127
        # can't just build up a map.
 
128
        rel_paths = [self._relpath(fid) for fid in fileids]
 
129
        is_requested = []
 
130
 
 
131
        #mutter('CompressedTextStore.get(permit_failure=%s)' % permit_failure)
 
132
        if permit_failure:
 
133
            existing_paths = []
 
134
            for path, has in zip(rel_paths,
 
135
                    self._transport.has_multi(rel_paths)):
 
136
                if has:
 
137
                    existing_paths.append(path)
 
138
                    is_requested.append(True)
 
139
                else:
 
140
                    is_requested.append(False)
 
141
            #mutter('Retrieving %s out of %s' % (existing_paths, rel_paths))
 
142
        else:
 
143
            #mutter('Retrieving all %s' % (rel_paths, ))
 
144
            existing_paths = rel_paths
 
145
            is_requested = [True for x in rel_paths]
 
146
 
 
147
        count = 0
 
148
        for f in self._transport.get_multi(existing_paths, pb=pb):
 
149
            assert count < len(is_requested)
 
150
            while not is_requested[count]:
 
151
                yield None
 
152
                count += 1
 
153
            if hasattr(f, 'tell'):
 
154
                yield gzip.GzipFile(mode='rb', fileobj=f)
 
155
            else:
 
156
                sio = StringIO(f.read())
 
157
                yield gzip.GzipFile(mode='rb', fileobj=sio)
 
158
            count += 1
 
159
 
 
160
        while count < len(is_requested):
 
161
            yield None
 
162
            count += 1
 
163
 
 
164
    def __iter__(self):
 
165
        # TODO: case-insensitive?
 
166
        for f in self._transport.list_dir('.'):
 
167
            yield f
 
168
 
 
169
    def __len__(self):
 
170
        return len([f for f in self._transport.list_dir('.')])
 
171
 
 
172
 
 
173
    def __getitem__(self, fileid):
 
174
        """Returns a file reading from a particular entry."""
 
175
        fn = self._relpath(fileid)
 
176
        # This will throw if the file doesn't exist.
 
177
        try:
 
178
            f = self._transport.get(fn)
 
179
        except:
 
180
            raise KeyError('This store (%s) does not contain %s' % (self, fileid))
 
181
 
 
182
        return f
 
183
            
 
184
 
 
185
    def total_size(self):
 
186
        """Return (count, bytes)
 
187
 
 
188
        This is the (compressed) size stored on disk, not the size of
 
189
        the content."""
 
190
        total = 0
 
191
        count = 0
 
192
        relpaths = [self._relpath(fid) for fid in self]
 
193
        for st in self._transport.stat_multi(relpaths):
 
194
            count += 1
 
195
            total += st[ST_SIZE]
 
196
                
 
197
        return count, total
 
198
 
 
199
class ScratchTextStore(TextStore):
 
200
    """Self-destructing test subclass of TextStore.
 
201
 
 
202
    The Store only exists for the lifetime of the Python object.
 
203
    Obviously you should not put anything precious in it.
 
204
    """
 
205
    def __init__(self):
 
206
        from transport import transport
 
207
        super(ScratchTextStore, self).__init__(transport(tempfile.mkdtemp()))
 
208
 
 
209
    def __del__(self):
 
210
        self._transport.delete_multi(self._transport.list_dir('.'))
 
211
        os.rmdir(self._transport.base)
 
212
        mutter("%r destroyed" % self)
 
213