/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/store.py

More work on roundtrip push support.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/store.py
1
 
 
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
 
"""Stores are the main data-storage mechanism for Bazaar-NG.
18
 
 
19
 
A store is a simple write-once container indexed by a universally
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>"
24
 
 
25
 
import os, tempfile, types, osutils, gzip, errno
26
 
from stat import ST_SIZE
27
 
from StringIO import StringIO
28
 
from trace import mutter
29
 
 
30
 
######################################################################
31
 
# stores
32
 
 
33
 
class StoreError(Exception):
34
 
    pass
35
 
 
36
 
 
37
 
class ImmutableStore(object):
38
 
    """Store that holds files indexed by unique names.
39
 
 
40
 
    Files can be added, but not modified once they are in.  Typically
41
 
    the hash is used as the name, or something else known to be unique,
42
 
    such as a UUID.
43
 
 
44
 
    >>> st = ImmutableScratchStore()
45
 
 
46
 
    >>> st.add(StringIO('hello'), 'aa')
47
 
    >>> 'aa' in st
48
 
    True
49
 
    >>> 'foo' in st
50
 
    False
51
 
 
52
 
    You are not allowed to add an id that is already present.
53
 
 
54
 
    Entries can be retrieved as files, which may then be read.
55
 
 
56
 
    >>> st.add(StringIO('goodbye'), '123123')
57
 
    >>> st['123123'].read()
58
 
    'goodbye'
59
 
 
60
 
    TODO: Atomic add by writing to a temporary file and renaming.
61
 
 
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
 
 
70
 
    """
71
 
 
72
 
    def __init__(self, basedir):
73
 
        """ImmutableStore constructor."""
74
 
        self._basedir = basedir
75
 
 
76
 
    def _path(self, id):
77
 
        assert '/' not in id
78
 
        return os.path.join(self._basedir, id)
79
 
 
80
 
    def __repr__(self):
81
 
        return "%s(%r)" % (self.__class__.__name__, self._basedir)
82
 
 
83
 
    def add(self, f, fileid, compressed=True):
84
 
        """Add contents of a file into the store.
85
 
 
86
 
        f -- An open file, or file-like object."""
87
 
        # FIXME: Only works on smallish files
88
 
        # TODO: Can be optimized by copying at the same time as
89
 
        # computing the sum.
90
 
        mutter("add store entry %r" % (fileid))
91
 
        if isinstance(f, types.StringTypes):
92
 
            content = f
93
 
        else:
94
 
            content = f.read()
95
 
 
96
 
        p = self._path(fileid)
97
 
        if os.access(p, os.F_OK) or os.access(p + '.gz', os.F_OK):
98
 
            bailout("store %r already contains id %r" % (self._basedir, fileid))
99
 
 
100
 
        if compressed:
101
 
            f = gzip.GzipFile(p + '.gz', 'wb')
102
 
            os.chmod(p + '.gz', 0444)
103
 
        else:
104
 
            f = file(p, 'wb')
105
 
            os.chmod(p, 0444)
106
 
            
107
 
        f.write(content)
108
 
        f.close()
109
 
 
110
 
    def copy_multi(self, other, ids):
111
 
        """Copy texts for ids from other into self.
112
 
 
113
 
        If an id is present in self, it is skipped.  A count of copied
114
 
        ids is returned, which may be less than len(ids).
115
 
        """
116
 
        count = 0
117
 
        for id in ids:
118
 
            if id in self:
119
 
                continue
120
 
            self.add(other[id], id)
121
 
            count += 1
122
 
        return count
123
 
 
124
 
    def __contains__(self, fileid):
125
 
        """"""
126
 
        p = self._path(fileid)
127
 
        return (os.access(p, os.R_OK)
128
 
                or os.access(p + '.gz', os.R_OK))
129
 
 
130
 
    # TODO: Guard against the same thing being stored twice, compressed and uncompresse
131
 
 
132
 
    def __iter__(self):
133
 
        for f in os.listdir(self._basedir):
134
 
            if f[-3:] == '.gz':
135
 
                # TODO: case-insensitive?
136
 
                yield f[:-3]
137
 
            else:
138
 
                yield f
139
 
 
140
 
    def __len__(self):
141
 
        return len(os.listdir(self._basedir))
142
 
 
143
 
    def __getitem__(self, fileid):
144
 
        """Returns a file reading from a particular entry."""
145
 
        p = self._path(fileid)
146
 
        try:
147
 
            return gzip.GzipFile(p + '.gz', 'rb')
148
 
        except IOError, e:
149
 
            if e.errno == errno.ENOENT:
150
 
                return file(p, 'rb')
151
 
            else:
152
 
                raise e
153
 
 
154
 
    def total_size(self):
155
 
        """Return (count, bytes)
156
 
 
157
 
        This is the (compressed) size stored on disk, not the size of
158
 
        the content."""
159
 
        total = 0
160
 
        count = 0
161
 
        for fid in self:
162
 
            count += 1
163
 
            p = self._path(fid)
164
 
            try:
165
 
                total += os.stat(p)[ST_SIZE]
166
 
            except OSError:
167
 
                total += os.stat(p + '.gz')[ST_SIZE]
168
 
                
169
 
        return count, total
170
 
 
171
 
 
172
 
 
173
 
 
174
 
class ImmutableScratchStore(ImmutableStore):
175
 
    """Self-destructing test subclass of ImmutableStore.
176
 
 
177
 
    The Store only exists for the lifetime of the Python object.
178
 
    Obviously you should not put anything precious in it.
179
 
    """
180
 
    def __init__(self):
181
 
        ImmutableStore.__init__(self, tempfile.mkdtemp())
182
 
 
183
 
    def __del__(self):
184
 
        for f in os.listdir(self._basedir):
185
 
            fpath = os.path.join(self._basedir, f)
186
 
            # needed on windows, and maybe some other filesystems
187
 
            os.chmod(fpath, 0600)
188
 
            os.remove(fpath)
189
 
        os.rmdir(self._basedir)
190
 
        mutter("%r destroyed" % self)