← 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-09-13 08:21:32 UTC
  • Revision ID: mbp@sourcefrog.net-20050913082132-66279763a02e695c
- allow the same version to be repeatedly added to a weave

  (silently absorb them into a single version)

- tests for this

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/store.py
1
 
 
 
1
# Copyright (C) 2005 by Canonical Development Ltd
2
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
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
 
"""Stores are the main data-storage mechanism for Bazaar-NG.
 
17
"""
 
18
Stores are the main data-storage mechanism for Bazaar-NG.
18
19
 
19
20
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>"
 
21
unique ID.
 
22
"""
24
23
 
25
24
import os, tempfile, types, osutils, gzip, errno
26
25
from stat import ST_SIZE
27
26
from StringIO import StringIO
28
 
from trace import mutter
 
27
from bzrlib.errors import BzrError
 
28
from bzrlib.trace import mutter
 
29
import bzrlib.ui
29
30
 
30
31
######################################################################
31
32
# stores
34
35
    pass
35
36
 
36
37
 
37
 
class ImmutableStore:
 
38
class ImmutableStore(object):
38
39
    """Store that holds files indexed by unique names.
39
40
 
40
41
    Files can be added, but not modified once they are in.  Typically
59
60
 
60
61
    TODO: Atomic add by writing to a temporary file and renaming.
61
62
 
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
 
 
 
63
    In bzr 0.0.5 and earlier, files within the store were marked
 
64
    readonly on disk.  This is no longer done but existing stores need
 
65
    to be accomodated.
70
66
    """
71
67
 
72
68
    def __init__(self, basedir):
73
 
        """ImmutableStore constructor."""
74
69
        self._basedir = basedir
75
70
 
76
 
    def _path(self, id):
77
 
        return os.path.join(self._basedir, id)
 
71
    def _path(self, entry_id):
 
72
        if not isinstance(entry_id, basestring):
 
73
            raise TypeError(type(entry_id))
 
74
        if '\\' in entry_id or '/' in entry_id:
 
75
            raise ValueError("invalid store id %r" % entry_id)
 
76
        return os.path.join(self._basedir, entry_id)
78
77
 
79
78
    def __repr__(self):
80
79
        return "%s(%r)" % (self.__class__.__name__, self._basedir)
83
82
        """Add contents of a file into the store.
84
83
 
85
84
        f -- An open file, or file-like object."""
86
 
        # FIXME: Only works on smallish files
87
 
        # TODO: Can be optimized by copying at the same time as
88
 
        # computing the sum.
 
85
        # FIXME: Only works on files that will fit in memory
 
86
        
 
87
        from bzrlib.atomicfile import AtomicFile
 
88
        
89
89
        mutter("add store entry %r" % (fileid))
90
90
        if isinstance(f, types.StringTypes):
91
91
            content = f
92
92
        else:
93
93
            content = f.read()
94
 
 
 
94
            
95
95
        p = self._path(fileid)
96
96
        if os.access(p, os.F_OK) or os.access(p + '.gz', os.F_OK):
97
 
            bailout("store %r already contains id %r" % (self._basedir, fileid))
 
97
            raise BzrError("store %r already contains id %r" % (self._basedir, fileid))
98
98
 
 
99
        fn = p
99
100
        if compressed:
100
 
            f = gzip.GzipFile(p + '.gz', 'wb')
101
 
            os.chmod(p + '.gz', 0444)
102
 
        else:
103
 
            f = file(p, 'wb')
104
 
            os.chmod(p, 0444)
105
 
            
106
 
        f.write(content)
107
 
        f.close()
108
 
 
 
101
            fn = fn + '.gz'
 
102
            
 
103
        af = AtomicFile(fn, 'wb')
 
104
        try:
 
105
            if compressed:
 
106
                gf = gzip.GzipFile(mode='wb', fileobj=af)
 
107
                gf.write(content)
 
108
                gf.close()
 
109
            else:
 
110
                af.write(content)
 
111
            af.commit()
 
112
        finally:
 
113
            af.close()
 
114
 
 
115
 
 
116
    def copy_multi(self, other, ids, permit_failure=False):
 
117
        """Copy texts for ids from other into self.
 
118
 
 
119
        If an id is present in self, it is skipped.
 
120
 
 
121
        Returns (count_copied, failed), where failed is a collection of ids
 
122
        that could not be copied.
 
123
        """
 
124
        pb = bzrlib.ui.ui_factory.progress_bar()
 
125
        
 
126
        pb.update('preparing to copy')
 
127
        to_copy = [id for id in ids if id not in self]
 
128
        if isinstance(other, ImmutableStore):
 
129
            return self.copy_multi_immutable(other, to_copy, pb)
 
130
        count = 0
 
131
        failed = set()
 
132
        for id in to_copy:
 
133
            count += 1
 
134
            pb.update('copy', count, len(to_copy))
 
135
            if not permit_failure:
 
136
                self.add(other[id], id)
 
137
            else:
 
138
                try:
 
139
                    entry = other[id]
 
140
                except IndexError:
 
141
                    failed.add(id)
 
142
                    continue
 
143
                self.add(entry, id)
 
144
                
 
145
        if not permit_failure:
 
146
            assert count == len(to_copy)
 
147
        pb.clear()
 
148
        return count, failed
 
149
 
 
150
    def copy_multi_immutable(self, other, to_copy, pb, permit_failure=False):
 
151
        from shutil import copyfile
 
152
        count = 0
 
153
        failed = set()
 
154
        for id in to_copy:
 
155
            p = self._path(id)
 
156
            other_p = other._path(id)
 
157
            try:
 
158
                copyfile(other_p, p)
 
159
            except IOError, e:
 
160
                if e.errno == errno.ENOENT:
 
161
                    if not permit_failure:
 
162
                        copyfile(other_p+".gz", p+".gz")
 
163
                    else:
 
164
                        try:
 
165
                            copyfile(other_p+".gz", p+".gz")
 
166
                        except IOError, e:
 
167
                            if e.errno == errno.ENOENT:
 
168
                                failed.add(id)
 
169
                            else:
 
170
                                raise
 
171
                else:
 
172
                    raise
 
173
            
 
174
            count += 1
 
175
            pb.update('copy', count, len(to_copy))
 
176
        assert count == len(to_copy)
 
177
        pb.clear()
 
178
        return count, failed
 
179
    
109
180
 
110
181
    def __contains__(self, fileid):
111
182
        """"""
126
197
    def __len__(self):
127
198
        return len(os.listdir(self._basedir))
128
199
 
 
200
 
129
201
    def __getitem__(self, fileid):
130
202
        """Returns a file reading from a particular entry."""
131
203
        p = self._path(fileid)
132
204
        try:
133
205
            return gzip.GzipFile(p + '.gz', 'rb')
134
206
        except IOError, e:
135
 
            if e.errno == errno.ENOENT:
136
 
                return file(p, 'rb')
137
 
            else:
138
 
                raise e
 
207
            if e.errno != errno.ENOENT:
 
208
                raise
 
209
 
 
210
        try:
 
211
            return file(p, 'rb')
 
212
        except IOError, e:
 
213
            if e.errno != errno.ENOENT:
 
214
                raise
 
215
 
 
216
        raise IndexError(fileid)
 
217
 
139
218
 
140
219
    def total_size(self):
141
220
        """Return (count, bytes)
161
240
    """Self-destructing test subclass of ImmutableStore.
162
241
 
163
242
    The Store only exists for the lifetime of the Python object.
164
 
    Obviously you should not put anything precious in it.
 
243
 Obviously you should not put anything precious in it.
165
244
    """
166
245
    def __init__(self):
167
246
        ImmutableStore.__init__(self, tempfile.mkdtemp())