← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/store/text.py

[merge] basic_io metaformat (mbp)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/store/text.py
 
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
 
25
import bzrlib.store
 
26
from bzrlib.store import hash_prefix
 
27
from bzrlib.trace import mutter
 
28
from bzrlib.errors import BzrError, NoSuchFile, FileExists
 
29
 
 
30
import gzip
 
31
from cStringIO import StringIO
 
32
 
 
33
 
 
34
class TextStore(bzrlib.store.TransportStore):
 
35
    """Store that holds files indexed by unique names.
 
36
 
 
37
    Files can be added, but not modified once they are in.  Typically
 
38
    the hash is used as the name, or something else known to be unique,
 
39
    such as a UUID.
 
40
 
 
41
    Files are stored uncompressed, with no delta compression.
 
42
    """
 
43
 
 
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(fn, f)
 
69
        except NoSuchFile:
 
70
            if not self._prefixed:
 
71
                raise
 
72
            try:
 
73
                self._transport.mkdir(os.path.dirname(fn))
 
74
            except FileExists:
 
75
                pass
 
76
            self._transport.put(fn, f)
 
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, pb=pb)
 
99
        except NoSuchFile:
 
100
            if not self._prefixed:
 
101
                raise
 
102
            try:
 
103
                self._transport.mkdir(hash_prefix(fileid)[:-1])
 
104
            except FileExists:
 
105
                pass
 
106
            result = other._transport.copy_to([path], self._transport, pb=pb)
 
107
 
 
108
        if result != 1:
 
109
            raise BzrError('Unable to copy file: %r' % (path,))
 
110
 
 
111
    def _get_compressed(self, filename):
 
112
        """Returns a file reading from a particular entry."""
 
113
        f = self._transport.get(filename)
 
114
        # gzip.GzipFile.read() requires a tell() function
 
115
        # but some transports return objects that cannot seek
 
116
        # so buffer them in a StringIO instead
 
117
        if hasattr(f, 'tell'):
 
118
            return gzip.GzipFile(mode='rb', fileobj=f)
 
119
        else:
 
120
            from cStringIO import StringIO
 
121
            sio = StringIO(f.read())
 
122
            return gzip.GzipFile(mode='rb', fileobj=sio)
 
123
 
 
124
 
 
125
def ScratchTextStore():
 
126
    return TextStore(ScratchTransport())