← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/store/text.py

- stub for revision properties

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/store/text.py
1
 
# Copyright (C) 2005 Canonical Ltd
2
 
#
 
1
# Copyright (C) 2005 by Canonical Development Ltd
 
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
#
 
7
 
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
#
 
12
 
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
 
"""A store that keeps the full text of every version.
 
17
"""
 
18
A store that keeps the full text of every version.
18
19
 
19
20
This store keeps uncompressed versions of the full text. It does not
20
21
do any sort of delta compression.
21
22
"""
22
23
 
23
 
import gzip
24
 
import os
25
 
from cStringIO import StringIO
 
24
import os, tempfile
26
25
 
27
 
from bzrlib import osutils
28
 
from bzrlib.errors import BzrError, NoSuchFile, FileExists
29
26
import bzrlib.store
 
27
from bzrlib.store import hash_prefix
30
28
from bzrlib.trace import mutter
 
29
from bzrlib.errors import BzrError, FileExists
31
30
 
 
31
from cStringIO import StringIO
 
32
from stat import ST_SIZE
32
33
 
33
34
 
34
35
class TextStore(bzrlib.store.TransportStore):
41
42
    Files are stored uncompressed, with no delta compression.
42
43
    """
43
44
 
44
 
    def _add_compressed(self, fn, f):
45
 
        from cStringIO import StringIO
46
 
        from bzrlib.osutils import pumpfile
47
 
 
48
 
        if isinstance(f, basestring):
49
 
            f = StringIO(f)
50
 
 
51
 
        sio = StringIO()
52
 
        gf = gzip.GzipFile(mode='wb', fileobj=sio)
53
 
        # if pumpfile handles files that don't fit in ram,
54
 
        # so will this function
55
 
        pumpfile(f, gf)
56
 
        gf.close()
57
 
        sio.seek(0)
58
 
        self._try_put(fn, sio)
59
 
 
60
 
    def _add(self, fn, f):
61
 
        if self._compressed:
62
 
            self._add_compressed(fn, f)
63
 
        else:
64
 
            self._try_put(fn, f)
65
 
 
66
 
    def _try_put(self, fn, f):
67
 
        try:
68
 
            self._transport.put_file(fn, f, mode=self._file_mode)
69
 
        except NoSuchFile:
70
 
            if not self._prefixed:
71
 
                raise
72
 
            try:
73
 
                self._transport.mkdir(os.path.dirname(fn), mode=self._dir_mode)
74
 
            except FileExists:
75
 
                pass
76
 
            self._transport.put_file(fn, f, mode=self._file_mode)
77
 
 
78
 
    def _get(self, fn):
79
 
        if fn.endswith('.gz'):
80
 
            return self._get_compressed(fn)
81
 
        else:
82
 
            return self._transport.get(fn)
83
 
 
84
 
    def _copy_one(self, fileid, suffix, other, pb):
85
 
        # TODO: Once the copy_to interface is improved to allow a source
86
 
        #       and destination targets, then we can always do the copy
87
 
        #       as long as other is a TextStore
88
 
        if not (isinstance(other, TextStore)
89
 
            and other._prefixed == self._prefixed):
90
 
            return super(TextStore, self)._copy_one(fileid, suffix, other, pb)
91
 
 
92
 
        mutter('_copy_one: %r, %r', fileid, suffix)
93
 
        path = other._get_name(fileid, suffix)
94
 
        if path is None:
95
 
            raise KeyError(fileid + '-' + str(suffix))
96
 
 
97
 
        try:
98
 
            result = other._transport.copy_to([path], self._transport,
99
 
                                              mode=self._file_mode)
100
 
        except NoSuchFile:
101
 
            if not self._prefixed:
102
 
                raise
103
 
            try:
104
 
                self._transport.mkdir(osutils.dirname(path), mode=self._dir_mode)
105
 
            except FileExists:
106
 
                pass
107
 
            result = other._transport.copy_to([path], self._transport,
108
 
                                              mode=self._file_mode)
109
 
 
110
 
        if result != 1:
111
 
            raise BzrError('Unable to copy file: %r' % (path,))
112
 
 
113
 
    def _get_compressed(self, filename):
114
 
        """Returns a file reading from a particular entry."""
115
 
        f = self._transport.get(filename)
116
 
        # gzip.GzipFile.read() requires a tell() function
117
 
        # but some transports return objects that cannot seek
118
 
        # so buffer them in a StringIO instead
119
 
        if getattr(f, 'tell', None) is not None:
120
 
            return gzip.GzipFile(mode='rb', fileobj=f)
121
 
        else:
122
 
            from cStringIO import StringIO
123
 
            sio = StringIO(f.read())
124
 
            return gzip.GzipFile(mode='rb', fileobj=sio)
 
45
    def __init__(self, transport, prefixed=False):
 
46
        super(TextStore, self).__init__(transport)
 
47
        self._prefixed = prefixed
 
48
 
 
49
    def _check_fileid(self, fileid):
 
50
        if not isinstance(fileid, basestring):
 
51
            raise TypeError('Fileids should be a string type: %s %r' % (type(fileid), fileid))
 
52
        if '\\' in fileid or '/' in fileid:
 
53
            raise ValueError("invalid store id %r" % fileid)
 
54
 
 
55
    def _relpath(self, fileid):
 
56
        self._check_fileid(fileid)
 
57
        if self._prefixed:
 
58
            return hash_prefix(fileid) + fileid
 
59
        else:
 
60
            return fileid
 
61
 
 
62
    def add(self, f, fileid):
 
63
        """Add contents of a file into the store.
 
64
 
 
65
        f -- A file-like object, or string
 
66
        """
 
67
        mutter("add store entry %r" % (fileid))
 
68
            
 
69
        fn = self._relpath(fileid)
 
70
        if self._transport.has(fn):
 
71
            raise BzrError("store %r already contains id %r" % (self._transport.base, fileid))
 
72
 
 
73
        if self._prefixed:
 
74
            try:
 
75
                self._transport.mkdir(hash_prefix(fileid))
 
76
            except FileExists:
 
77
                pass
 
78
 
 
79
        self._transport.put(fn, f)
 
80
 
 
81
    def __contains__(self, fileid):
 
82
        """"""
 
83
        fn = self._relpath(fileid)
 
84
        return self._transport.has(fn)
 
85
 
 
86
    def has(self, fileids, pb=None):
 
87
        """Return True/False for each entry in fileids.
 
88
 
 
89
        :param fileids: A List or generator yielding file ids.
 
90
        :return: A generator or list returning True/False for each entry.
 
91
        """
 
92
        relpaths = (self._relpath(fid) for fid in fileids)
 
93
        return self._transport.has_multi(relpaths, pb=pb)
 
94
 
 
95
    def get(self, fileids, permit_failure=False, pb=None):
 
96
        """Return a set of files, one for each requested entry.
 
97
        
 
98
        TODO: Write some tests to make sure that permit_failure is
 
99
              handled correctly.
 
100
 
 
101
        TODO: What should the exception be for a missing file?
 
102
              KeyError, or NoSuchFile?
 
103
        """
 
104
 
 
105
        # This next code gets a bit hairy because it can allow
 
106
        # to not request a file which doesn't seem to exist.
 
107
        # Also, the same fileid may be requested twice, so we
 
108
        # can't just build up a map.
 
109
        rel_paths = [self._relpath(fid) for fid in fileids]
 
110
        is_requested = []
 
111
 
 
112
        if permit_failure:
 
113
            existing_paths = []
 
114
            for path, has in zip(rel_paths,
 
115
                    self._transport.has_multi(rel_paths)):
 
116
                if has:
 
117
                    existing_paths.append(path)
 
118
                    is_requested.append(True)
 
119
                else:
 
120
                    is_requested.append(False)
 
121
            #mutter('Retrieving %s out of %s' % (existing_paths, rel_paths))
 
122
        else:
 
123
            #mutter('Retrieving all %s' % (rel_paths, ))
 
124
            existing_paths = rel_paths
 
125
            is_requested = [True for x in rel_paths]
 
126
 
 
127
        count = 0
 
128
        for f in self._transport.get_multi(existing_paths, pb=pb):
 
129
            assert count < len(is_requested)
 
130
            while not is_requested[count]:
 
131
                yield None
 
132
                count += 1
 
133
            yield f
 
134
            count += 1
 
135
 
 
136
        while count < len(is_requested):
 
137
            yield None
 
138
            count += 1
 
139
 
 
140
    def __iter__(self):
 
141
        for relpath, st in self._iter_relpaths():
 
142
            yield os.path.basename(relpath)
 
143
 
 
144
    def __len__(self):
 
145
        return len(list(self._iter_relpath()))
 
146
 
 
147
    def total_size(self):
 
148
        """Return (count, bytes)
 
149
 
 
150
        This is the (compressed) size stored on disk, not the size of
 
151
        the content."""
 
152
        total = 0
 
153
        count = 0
 
154
        for relpath, st in self._iter_relpaths():
 
155
            count += 1
 
156
            total += st[ST_SIZE]
 
157
                
 
158
        return count, total
 
159
 
 
160
 
 
161
class ScratchTextStore(TextStore):
 
162
    """Self-destructing test subclass of TextStore.
 
163
 
 
164
    The Store only exists for the lifetime of the Python object.
 
165
    Obviously you should not put anything precious in it.
 
166
    """
 
167
    def __init__(self):
 
168
        from transport import transport
 
169
        super(ScratchTextStore, self).__init__(transport(tempfile.mkdtemp()))
 
170
 
 
171
    def __del__(self):
 
172
        self._transport.delete_multi(self._transport.list_dir('.'))
 
173
        os.rmdir(self._transport.base)
 
174
        mutter("%r destroyed" % self)
 
175