← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/store.py

  • Committer: Martin Pool
  • Date: 2005-06-24 09:18:43 UTC
  • Revision ID: mbp@sourcefrog.net-20050624091843-3918fa12930fdc04
- remove done TODO items

Show diffs side-by-side

added added

removed removed

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