← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/store/text.py

  • Committer: Patch Queue Manager
  • Date: 2012-09-19 07:12:28 UTC
  • mfrom: (6561.1.1 996401-doc-config)
  • Revision ID: pqm@pqm.ubuntu.com-20120919071228-yd09pv4quo9hxtf2
(vila) Clarify option references expansion for `bzr config`. (Vincent
 Ladeuil)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/store/text.py
 
1
# Copyright (C) 2005, 2006, 2008, 2009, 2010 Canonical 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
"""A store that keeps the full text of every version.
 
18
 
 
19
This store keeps uncompressed versions of the full text. It does not
 
20
do any sort of delta compression.
 
21
"""
 
22
 
 
23
from __future__ import absolute_import
 
24
 
 
25
import gzip
 
26
import os
 
27
 
 
28
from bzrlib import osutils
 
29
from bzrlib.errors import BzrError, NoSuchFile, FileExists
 
30
import bzrlib.store
 
31
from bzrlib.trace import mutter
 
32
 
 
33
 
 
34
 
 
35
class TextStore(bzrlib.store.TransportStore):
 
36
    """Store that holds files indexed by unique names.
 
37
 
 
38
    Files can be added, but not modified once they are in.  Typically
 
39
    the hash is used as the name, or something else known to be unique,
 
40
    such as a UUID.
 
41
 
 
42
    Files are stored uncompressed, with no delta compression.
 
43
    """
 
44
 
 
45
    def _add_compressed(self, fn, f):
 
46
        from cStringIO import StringIO
 
47
        from bzrlib.osutils import pumpfile
 
48
 
 
49
        if isinstance(f, basestring):
 
50
            f = StringIO(f)
 
51
 
 
52
        sio = StringIO()
 
53
        gf = gzip.GzipFile(mode='wb', fileobj=sio)
 
54
        # if pumpfile handles files that don't fit in ram,
 
55
        # so will this function
 
56
        pumpfile(f, gf)
 
57
        gf.close()
 
58
        sio.seek(0)
 
59
        self._try_put(fn, sio)
 
60
 
 
61
    def _add(self, fn, f):
 
62
        if self._compressed:
 
63
            self._add_compressed(fn, f)
 
64
        else:
 
65
            self._try_put(fn, f)
 
66
 
 
67
    def _try_put(self, fn, f):
 
68
        try:
 
69
            self._transport.put_file(fn, f, mode=self._file_mode)
 
70
        except NoSuchFile:
 
71
            if not self._prefixed:
 
72
                raise
 
73
            try:
 
74
                self._transport.mkdir(os.path.dirname(fn), mode=self._dir_mode)
 
75
            except FileExists:
 
76
                pass
 
77
            self._transport.put_file(fn, f, mode=self._file_mode)
 
78
 
 
79
    def _get(self, fn):
 
80
        if fn.endswith('.gz'):
 
81
            return self._get_compressed(fn)
 
82
        else:
 
83
            return self._transport.get(fn)
 
84
 
 
85
    def _copy_one(self, fileid, suffix, other, pb):
 
86
        # TODO: Once the copy_to interface is improved to allow a source
 
87
        #       and destination targets, then we can always do the copy
 
88
        #       as long as other is a TextStore
 
89
        if not (isinstance(other, TextStore)
 
90
            and other._prefixed == self._prefixed):
 
91
            return super(TextStore, self)._copy_one(fileid, suffix, other, pb)
 
92
 
 
93
        mutter('_copy_one: %r, %r', fileid, suffix)
 
94
        path = other._get_name(fileid, suffix)
 
95
        if path is None:
 
96
            raise KeyError(fileid + '-' + str(suffix))
 
97
 
 
98
        try:
 
99
            result = other._transport.copy_to([path], self._transport,
 
100
                                              mode=self._file_mode)
 
101
        except NoSuchFile:
 
102
            if not self._prefixed:
 
103
                raise
 
104
            try:
 
105
                self._transport.mkdir(osutils.dirname(path), mode=self._dir_mode)
 
106
            except FileExists:
 
107
                pass
 
108
            result = other._transport.copy_to([path], self._transport,
 
109
                                              mode=self._file_mode)
 
110
 
 
111
        if result != 1:
 
112
            raise BzrError('Unable to copy file: %r' % (path,))
 
113
 
 
114
    def _get_compressed(self, filename):
 
115
        """Returns a file reading from a particular entry."""
 
116
        f = self._transport.get(filename)
 
117
        # gzip.GzipFile.read() requires a tell() function
 
118
        # but some transports return objects that cannot seek
 
119
        # so buffer them in a StringIO instead
 
120
        if getattr(f, 'tell', None) is not None:
 
121
            return gzip.GzipFile(mode='rb', fileobj=f)
 
122
        try:
 
123
            from cStringIO import StringIO
 
124
            sio = StringIO(f.read())
 
125
            return gzip.GzipFile(mode='rb', fileobj=sio)
 
126
        finally:
 
127
            f.close()